@mnstry/atelier 0.2.0-alpha.6 → 0.2.0-alpha.8

package/contracts/atelier-obsidian-proposal-receipt.v1.schema.json

@@ -0,0 +1,110 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mnstry.ai/schemas/atelier/atelier-obsidian-proposal-receipt.v1.schema.json",
+  "title": "Obsidian proposal receipt",
+  "$comment": "contract revision 1.0.0; portable shape; repository-scoped store, stable adapter operation identity, proposal ID, dedupe and backpressure outcome.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "receiptId",
+    "repoId",
+    "storeId",
+    "adapterOperationId",
+    "editId",
+    "proposalId",
+    "dedupe",
+    "backpressure",
+    "recordedAt"
+  ],
+  "properties": {
+    "schema": {
+      "const": "atelier-obsidian-proposal-receipt/v1"
+    },
+    "receiptId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "repoId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "storeId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "adapterOperationId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "editId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "proposalId": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/identifier"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "dedupe": {
+      "enum": [
+        "new",
+        "duplicate",
+        "recovered"
+      ]
+    },
+    "backpressure": {
+      "enum": [
+        "accepted",
+        "deferred",
+        "refused"
+      ]
+    },
+    "recordedAt": {
+      "$ref": "#/$defs/timestamp"
+    },
+    "ext": {
+      "type": "object"
+    },
+    "contractVersion": {
+      "type": "string",
+      "pattern": "^1\\.[0-9]+\\.[0-9]+$"
+    }
+  },
+  "if": {
+    "required": [
+      "backpressure"
+    ],
+    "properties": {
+      "backpressure": {
+        "const": "accepted"
+      }
+    }
+  },
+  "then": {
+    "properties": {
+      "proposalId": {
+        "type": "string"
+      }
+    }
+  },
+  "else": {
+    "properties": {
+      "proposalId": {
+        "type": "null"
+      }
+    }
+  },
+  "$defs": {
+    "identifier": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time"
+    }
+  }
+}

package/contracts/atelier-obsidian-publication-journal.v1.schema.json

@@ -0,0 +1,167 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mnstry.ai/schemas/atelier/atelier-obsidian-publication-journal.v1.schema.json",
+  "title": "Obsidian publication journal",
+  "$comment": "contract revision 1.0.0; private state shape; durable capture, conditional operation, partial transition, verification and restart. The publication protocol ID is mandatory.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "journalId",
+    "workspaceId",
+    "scopeId",
+    "protocolId",
+    "expectedGeneration",
+    "targetGeneration",
+    "state",
+    "entries",
+    "restart"
+  ],
+  "properties": {
+    "schema": {
+      "const": "atelier-obsidian-publication-journal/v1"
+    },
+    "journalId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "workspaceId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "scopeId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "protocolId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[a-z0-9][a-z0-9./-]*$"
+    },
+    "expectedGeneration": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/identifier"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "targetGeneration": {
+      "$ref": "#/$defs/identifier"
+    },
+    "state": {
+      "enum": [
+        "prepared",
+        "captured",
+        "updating",
+        "verifying",
+        "committed",
+        "failed",
+        "recovering"
+      ]
+    },
+    "entries": {
+      "type": "array",
+      "maxItems": 1000000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "seq",
+          "at",
+          "step",
+          "outcome"
+        ],
+        "properties": {
+          "seq": {
+            "type": "integer",
+            "minimum": 0
+          },
+          "at": {
+            "$ref": "#/$defs/timestamp"
+          },
+          "step": {
+            "enum": [
+              "capture",
+              "conditional-update",
+              "verify",
+              "manifest-commit",
+              "restart"
+            ]
+          },
+          "outcome": {
+            "enum": [
+              "ok",
+              "conflict",
+              "failed",
+              "skipped"
+            ]
+          },
+          "notePath": {
+            "$ref": "#/$defs/relativePath"
+          },
+          "beforeDigest": {
+            "$ref": "#/$defs/digest"
+          },
+          "afterDigest": {
+            "$ref": "#/$defs/digest"
+          },
+          "recoveryRef": {
+            "$ref": "#/$defs/relativePath"
+          },
+          "ext": {
+            "type": "object"
+          }
+        }
+      }
+    },
+    "restart": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "count"
+      ],
+      "properties": {
+        "count": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "lastRecoveredAt": {
+          "$ref": "#/$defs/timestamp"
+        },
+        "ext": {
+          "type": "object"
+        }
+      }
+    },
+    "ext": {
+      "type": "object"
+    },
+    "contractVersion": {
+      "type": "string",
+      "pattern": "^1\\.[0-9]+\\.[0-9]+$"
+    }
+  },
+  "$defs": {
+    "identifier": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
+    },
+    "digest": {
+      "type": "string",
+      "pattern": "^sha256:[0-9a-f]{64}$"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "relativePath": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "pattern": "^(?![/~])(?![A-Za-z]:)(?!.*(?:^|/)\\.\\.(?:/|$))[^\\\\\\u0000]+$"
+    }
+  }
+}

package/contracts/atelier-obsidian-scope.v1.schema.json

@@ -0,0 +1,264 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mnstry.ai/schemas/atelier/atelier-obsidian-scope.v1.schema.json",
+  "title": "Obsidian scope selection",
+  "$comment": "contract revision 1.0.0; portable shape; persisted set expression over stable IDs, repositories, paths, tags and types. An explicit empty selection is valid and means empty.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "scopeId",
+    "mode",
+    "selector"
+  ],
+  "properties": {
+    "schema": {
+      "const": "atelier-obsidian-scope/v1"
+    },
+    "scopeId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "mode": {
+      "$ref": "#/$defs/scopeMode"
+    },
+    "selector": {
+      "$ref": "#/$defs/selector"
+    },
+    "expansion": {
+      "$ref": "#/$defs/expansion"
+    },
+    "ext": {
+      "type": "object"
+    },
+    "contractVersion": {
+      "type": "string",
+      "pattern": "^1\\.[0-9]+\\.[0-9]+$"
+    }
+  },
+  "if": {
+    "required": [
+      "mode"
+    ],
+    "properties": {
+      "mode": {
+        "const": "full"
+      }
+    }
+  },
+  "then": {
+    "properties": {
+      "selector": {
+        "required": [
+          "all"
+        ]
+      }
+    }
+  },
+  "$defs": {
+    "identifier": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
+    },
+    "relativePath": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "pattern": "^(?![/~])(?![A-Za-z]:)(?!.*(?:^|/)\\.\\.(?:/|$))[^\\\\\\u0000]+$"
+    },
+    "selector": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "all"
+          ],
+          "properties": {
+            "all": {
+              "const": true
+            },
+            "ext": {
+              "type": "object"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "ids"
+          ],
+          "properties": {
+            "ids": {
+              "type": "array",
+              "maxItems": 100000,
+              "uniqueItems": true,
+              "items": {
+                "$ref": "#/$defs/identifier"
+              }
+            },
+            "ext": {
+              "type": "object"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "repo"
+          ],
+          "properties": {
+            "repo": {
+              "$ref": "#/$defs/identifier"
+            },
+            "pathPrefix": {
+              "$ref": "#/$defs/relativePath"
+            },
+            "ext": {
+              "type": "object"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "tag"
+          ],
+          "properties": {
+            "tag": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 128
+            },
+            "ext": {
+              "type": "object"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "type"
+          ],
+          "properties": {
+            "type": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 64
+            },
+            "ext": {
+              "type": "object"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "union"
+          ],
+          "properties": {
+            "union": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 256,
+              "items": {
+                "$ref": "#/$defs/selector"
+              }
+            },
+            "ext": {
+              "type": "object"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "intersection"
+          ],
+          "properties": {
+            "intersection": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 256,
+              "items": {
+                "$ref": "#/$defs/selector"
+              }
+            },
+            "ext": {
+              "type": "object"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "exclude"
+          ],
+          "properties": {
+            "exclude": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 256,
+              "items": {
+                "$ref": "#/$defs/selector"
+              }
+            },
+            "ext": {
+              "type": "object"
+            }
+          }
+        }
+      ]
+    },
+    "expansion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "depth",
+        "maxNodes",
+        "direction",
+        "order"
+      ],
+      "properties": {
+        "depth": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 8
+        },
+        "maxNodes": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100000
+        },
+        "direction": {
+          "enum": [
+            "outgoing",
+            "incoming",
+            "both"
+          ]
+        },
+        "order": {
+          "const": "canonical-id"
+        },
+        "ext": {
+          "type": "object"
+        }
+      }
+    },
+    "scopeMode": {
+      "enum": [
+        "full",
+        "focus",
+        "scoped"
+      ]
+    }
+  }
+}

package/contracts/atelier-obsidian-service-state.v1.schema.json

@@ -0,0 +1,149 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mnstry.ai/schemas/atelier/atelier-obsidian-service-state.v1.schema.json",
+  "title": "Obsidian maintenance service state",
+  "$comment": "contract revision 1.0.0; private state shape; workspace service identity, literal loopback, port, runtime ID, PID, executable, health and consent record. Machine-local values live here and never in a portable shape.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "workspaceId",
+    "serviceName",
+    "host",
+    "port",
+    "runtimeId",
+    "pid",
+    "executable",
+    "stateLocation",
+    "health",
+    "consent"
+  ],
+  "properties": {
+    "schema": {
+      "const": "atelier-obsidian-service-state/v1"
+    },
+    "workspaceId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "serviceName": {
+      "$ref": "#/$defs/identifier"
+    },
+    "host": {
+      "enum": [
+        "127.0.0.1",
+        "::1"
+      ]
+    },
+    "port": {
+      "type": "integer",
+      "minimum": 1024,
+      "maximum": 65535
+    },
+    "runtimeId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "pid": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "executable": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "digest"
+      ],
+      "properties": {
+        "path": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4096
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        },
+        "ext": {
+          "type": "object"
+        }
+      }
+    },
+    "stateLocation": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 4096
+    },
+    "health": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "status",
+        "checkedAt"
+      ],
+      "properties": {
+        "status": {
+          "enum": [
+            "starting",
+            "healthy",
+            "degraded",
+            "stopped"
+          ]
+        },
+        "checkedAt": {
+          "$ref": "#/$defs/timestamp"
+        },
+        "ext": {
+          "type": "object"
+        }
+      }
+    },
+    "consent": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "grantedAt",
+        "actor",
+        "coverage"
+      ],
+      "properties": {
+        "grantedAt": {
+          "$ref": "#/$defs/timestamp"
+        },
+        "actor": {
+          "$ref": "#/$defs/identifier"
+        },
+        "coverage": {
+          "enum": [
+            "service",
+            "service-and-startup"
+          ]
+        },
+        "ext": {
+          "type": "object"
+        }
+      }
+    },
+    "ext": {
+      "type": "object"
+    },
+    "contractVersion": {
+      "type": "string",
+      "pattern": "^1\\.[0-9]+\\.[0-9]+$"
+    }
+  },
+  "$defs": {
+    "identifier": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
+    },
+    "digest": {
+      "type": "string",
+      "pattern": "^sha256:[0-9a-f]{64}$"
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time"
+    }
+  }
+}