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

package/contracts/atelier-obsidian-ext-settings.v1.schema.json

@@ -0,0 +1,287 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mnstry.ai/schemas/atelier/atelier-obsidian-ext-settings.v1.schema.json",
+  "title": "Obsidian project extension settings",
+  "$comment": "contract revision 1.0.0; portable shape stored under the project ext container key mnstry.atelier.obsidian; enablement and persisted selectors only. The project v1 schema is unchanged.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "enabled",
+    "scopes"
+  ],
+  "properties": {
+    "schema": {
+      "const": "atelier-obsidian-ext-settings/v1"
+    },
+    "enabled": {
+      "type": "boolean"
+    },
+    "defaultScopeId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "scopes": {
+      "type": "array",
+      "maxItems": 256,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "scopeId",
+          "mode",
+          "selector"
+        ],
+        "properties": {
+          "scopeId": {
+            "$ref": "#/$defs/identifier"
+          },
+          "mode": {
+            "$ref": "#/$defs/scopeMode"
+          },
+          "selector": {
+            "$ref": "#/$defs/selector"
+          },
+          "expansion": {
+            "$ref": "#/$defs/expansion"
+          },
+          "ext": {
+            "type": "object"
+          }
+        },
+        "if": {
+          "required": [
+            "mode"
+          ],
+          "properties": {
+            "mode": {
+              "const": "full"
+            }
+          }
+        },
+        "then": {
+          "properties": {
+            "selector": {
+              "required": [
+                "all"
+              ]
+            }
+          }
+        }
+      }
+    },
+    "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._:-]*$"
+    },
+    "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-generation-manifest.v1.schema.json

@@ -0,0 +1,353 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mnstry.ai/schemas/atelier/atelier-obsidian-generation-manifest.v1.schema.json",
+  "title": "Obsidian generation manifest",
+  "$comment": "contract revision 1.0.0; portable shape; stable readable path map, authored and generated byte regions, link inversion map, attachment hashes, completeness and freshness. Withheld endpoints never appear.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "generationId",
+    "scopeId",
+    "snapshotId",
+    "notes",
+    "links",
+    "attachments",
+    "completeness",
+    "freshness"
+  ],
+  "properties": {
+    "schema": {
+      "const": "atelier-obsidian-generation-manifest/v1"
+    },
+    "generationId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "scopeId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "snapshotId": {
+      "$ref": "#/$defs/identifier"
+    },
+    "notes": {
+      "type": "array",
+      "maxItems": 1000000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "repoId",
+          "nodeId",
+          "path",
+          "title",
+          "noteDigest",
+          "regions"
+        ],
+        "properties": {
+          "repoId": {
+            "$ref": "#/$defs/identifier"
+          },
+          "nodeId": {
+            "$ref": "#/$defs/identifier"
+          },
+          "path": {
+            "type": "string",
+            "maxLength": 1024,
+            "pattern": "^notes/[^/\\\\\\u0000]+--[0-9a-f]{12,64}\\.md$"
+          },
+          "title": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 512
+          },
+          "noteDigest": {
+            "$ref": "#/$defs/digest"
+          },
+          "regions": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "body",
+              "generated"
+            ],
+            "properties": {
+              "frontmatter": {
+                "$ref": "#/$defs/byteRange"
+              },
+              "body": {
+                "$ref": "#/$defs/byteRange"
+              },
+              "generated": {
+                "type": "array",
+                "maxItems": 64,
+                "items": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "required": [
+                    "kind",
+                    "range"
+                  ],
+                  "properties": {
+                    "kind": {
+                      "enum": [
+                        "relations",
+                        "outside-selection",
+                        "representation"
+                      ]
+                    },
+                    "range": {
+                      "$ref": "#/$defs/byteRange"
+                    },
+                    "ext": {
+                      "type": "object"
+                    }
+                  }
+                }
+              },
+              "ext": {
+                "type": "object"
+              }
+            }
+          },
+          "ext": {
+            "type": "object"
+          }
+        }
+      }
+    },
+    "links": {
+      "type": "array",
+      "maxItems": 5000000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "edgeId",
+          "sourceNodeId",
+          "targetNodeId",
+          "type",
+          "origin",
+          "targetState"
+        ],
+        "properties": {
+          "edgeId": {
+            "$ref": "#/$defs/identifier"
+          },
+          "sourceNodeId": {
+            "$ref": "#/$defs/identifier"
+          },
+          "targetNodeId": {
+            "$ref": "#/$defs/identifier"
+          },
+          "type": {
+            "$ref": "#/$defs/relationType"
+          },
+          "origin": {
+            "enum": [
+              "declared",
+              "markdown"
+            ]
+          },
+          "targetState": {
+            "enum": [
+              "in-scope",
+              "outside-selection"
+            ]
+          },
+          "inversions": {
+            "type": "array",
+            "maxItems": 4096,
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "source",
+                "note"
+              ],
+              "properties": {
+                "source": {
+                  "$ref": "#/$defs/byteRange"
+                },
+                "note": {
+                  "$ref": "#/$defs/byteRange"
+                },
+                "ext": {
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "ext": {
+            "type": "object"
+          }
+        },
+        "if": {
+          "required": [
+            "type"
+          ],
+          "properties": {
+            "type": {
+              "const": "links_to"
+            }
+          }
+        },
+        "then": {
+          "properties": {
+            "origin": {
+              "const": "markdown"
+            }
+          }
+        },
+        "else": {
+          "properties": {
+            "origin": {
+              "const": "declared"
+            }
+          }
+        }
+      }
+    },
+    "attachments": {
+      "type": "array",
+      "maxItems": 1000000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "path",
+          "digest",
+          "byteLength"
+        ],
+        "properties": {
+          "path": {
+            "$ref": "#/$defs/relativePath"
+          },
+          "digest": {
+            "$ref": "#/$defs/digest"
+          },
+          "byteLength": {
+            "type": "integer",
+            "minimum": 0
+          },
+          "ext": {
+            "type": "object"
+          }
+        }
+      }
+    },
+    "completeness": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "status",
+        "expectedNotes",
+        "writtenNotes"
+      ],
+      "properties": {
+        "status": {
+          "enum": [
+            "complete",
+            "partial"
+          ]
+        },
+        "expectedNotes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "writtenNotes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "ext": {
+          "type": "object"
+        }
+      }
+    },
+    "freshness": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "status",
+        "checkedAt"
+      ],
+      "properties": {
+        "status": {
+          "enum": [
+            "current",
+            "stale",
+            "unknown"
+          ]
+        },
+        "checkedAt": {
+          "$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]+$"
+    },
+    "byteRange": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "start",
+        "end"
+      ],
+      "properties": {
+        "start": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "end": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "ext": {
+          "type": "object"
+        }
+      }
+    },
+    "relationType": {
+      "enum": [
+        "related",
+        "supports",
+        "supersedes",
+        "implements",
+        "depends_on",
+        "evidences",
+        "contradicts",
+        "belongs_to",
+        "links_to"
+      ]
+    }
+  }
+}