structured-context 0.11.0 → 0.12.0

package/dist/schema/metadata-contract.d.ts

@@ -1,5 +1,12 @@
 import type { FromSchema } from 'json-schema-to-ts';
-export declare const SCHEMA_META_ID = "https://raw.githubusercontent.com/mindsocket/structured-context/main/schemas/generated/_structured_context_schema_meta.json";
+/** The JSON Schema dialect the structured-context dialect extends. */
+export declare const JSON_SCHEMA_DIALECT = "https://json-schema.org/draft/2020-12/schema";
+export declare const SCHEMA_META_BASE_URL = "https://raw.githubusercontent.com/mindsocket/structured-context/main/schemas/generated";
+export declare const SCHEMA_META_FILE = "_structured_context_schema_meta.json";
+/** Meta-schema `$id` for a dialect version folder, e.g. `.../generated/0.12.0/_structured_context_schema_meta.json`. */
+export declare function schemaMetaId(folder: string): string;
+/** The URL schemas set as `$schema` to follow the newest dialect. Resolves to the newest versioned meta-schema. */
+export declare const SCHEMA_META_ID: string;
 /** Schema objects wrapping each prop group for type derivation via FromSchema. */
 declare const EDGE_SCHEMA: {
     readonly type: "object";
@@ -97,6 +104,9 @@ declare const RULE_SCHEMA: {
         readonly category: {
             readonly enum: readonly ["validation", "coherence", "workflow", "best-practice"];
         };
+        readonly severity: {
+            readonly enum: readonly ["error", "warning", "info"];
+        };
         readonly description: {
             readonly type: "string";
             readonly minLength: 1;
@@ -119,7 +129,7 @@ declare const RULE_SCHEMA: {
     readonly required: readonly ["id", "category", "description", "check"];
     readonly additionalProperties: false;
 };
-declare const RULE_REF_SCHEMA: {
+declare const REF_SCHEMA: {
     readonly type: "object";
     readonly properties: {
         readonly $ref: {
@@ -130,9 +140,84 @@ declare const RULE_REF_SCHEMA: {
     readonly required: readonly ["$ref"];
     readonly additionalProperties: false;
 };
+declare const HIERARCHY_SCHEMA: {
+    readonly type: "object";
+    readonly properties: {
+        readonly name: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly override: {
+            readonly type: "boolean";
+        };
+        readonly levels: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly items: {
+                readonly oneOf: readonly [{
+                    readonly type: "string";
+                    readonly minLength: 1;
+                }, {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly selfRef: {
+                            readonly type: "boolean";
+                        };
+                        readonly selfRefField: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                        readonly templateFormat: {
+                            readonly enum: readonly ["heading", "list", "table", "page"];
+                        };
+                        readonly matchers: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly minItems: 1;
+                        };
+                        readonly embeddedTemplateFields: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                        readonly field: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                        readonly fieldOn: {
+                            readonly enum: readonly ["child", "parent"];
+                        };
+                        readonly multiple: {
+                            readonly type: "boolean";
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                    };
+                    readonly required: readonly ["type"];
+                    readonly additionalProperties: false;
+                }];
+            };
+        };
+        readonly allowSkipLevels: {
+            readonly type: "boolean";
+        };
+    };
+    readonly required: readonly ["levels"];
+    readonly additionalProperties: false;
+};
 declare const RELATIONSHIP_SCHEMA: {
     readonly type: "object";
     readonly properties: {
+        readonly override: {
+            readonly type: "boolean";
+        };
         readonly templateFormat: {
             readonly enum: readonly ["heading", "list", "table", "page"];
         };
@@ -176,76 +261,105 @@ declare const RELATIONSHIP_SCHEMA: {
 export declare const METADATA_SCHEMA: {
     readonly type: "object";
     readonly properties: {
+        readonly imports: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+                readonly minLength: 1;
+            };
+        };
         readonly hierarchy: {
-            readonly type: "object";
-            readonly properties: {
-                readonly levels: {
-                    readonly type: "array";
-                    readonly minItems: 1;
-                    readonly items: {
-                        readonly oneOf: readonly [{
-                            readonly type: "string";
-                            readonly minLength: 1;
-                        }, {
-                            readonly type: "object";
-                            readonly properties: {
-                                readonly selfRef: {
-                                    readonly type: "boolean";
-                                };
-                                readonly selfRefField: {
-                                    readonly type: "string";
-                                    readonly minLength: 1;
-                                };
-                                readonly templateFormat: {
-                                    readonly enum: readonly ["heading", "list", "table", "page"];
-                                };
-                                readonly matchers: {
-                                    readonly type: "array";
-                                    readonly items: {
+            readonly oneOf: readonly [{
+                readonly type: "object";
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly override: {
+                        readonly type: "boolean";
+                    };
+                    readonly levels: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly items: {
+                            readonly oneOf: readonly [{
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            }, {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly selfRef: {
+                                        readonly type: "boolean";
+                                    };
+                                    readonly selfRefField: {
                                         readonly type: "string";
                                         readonly minLength: 1;
                                     };
-                                    readonly minItems: 1;
-                                };
-                                readonly embeddedTemplateFields: {
-                                    readonly type: "array";
-                                    readonly items: {
+                                    readonly templateFormat: {
+                                        readonly enum: readonly ["heading", "list", "table", "page"];
+                                    };
+                                    readonly matchers: {
+                                        readonly type: "array";
+                                        readonly items: {
+                                            readonly type: "string";
+                                            readonly minLength: 1;
+                                        };
+                                        readonly minItems: 1;
+                                    };
+                                    readonly embeddedTemplateFields: {
+                                        readonly type: "array";
+                                        readonly items: {
+                                            readonly type: "string";
+                                            readonly minLength: 1;
+                                        };
+                                    };
+                                    readonly field: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                    readonly fieldOn: {
+                                        readonly enum: readonly ["child", "parent"];
+                                    };
+                                    readonly multiple: {
+                                        readonly type: "boolean";
+                                    };
+                                    readonly type: {
                                         readonly type: "string";
                                         readonly minLength: 1;
                                     };
                                 };
-                                readonly field: {
-                                    readonly type: "string";
-                                    readonly minLength: 1;
-                                };
-                                readonly fieldOn: {
-                                    readonly enum: readonly ["child", "parent"];
-                                };
-                                readonly multiple: {
-                                    readonly type: "boolean";
-                                };
-                                readonly type: {
-                                    readonly type: "string";
-                                    readonly minLength: 1;
-                                };
-                            };
-                            readonly required: readonly ["type"];
-                            readonly additionalProperties: false;
-                        }];
+                                readonly required: readonly ["type"];
+                                readonly additionalProperties: false;
+                            }];
+                        };
+                    };
+                    readonly allowSkipLevels: {
+                        readonly type: "boolean";
                     };
                 };
-                readonly allowSkipLevels: {
-                    readonly type: "boolean";
+                readonly required: readonly ["levels"];
+                readonly additionalProperties: false;
+            }, {
+                readonly type: "object";
+                readonly properties: {
+                    readonly $ref: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
                 };
-            };
-            readonly required: readonly ["levels"];
-            readonly additionalProperties: false;
+                readonly required: readonly ["$ref"];
+                readonly additionalProperties: false;
+            }];
         };
         readonly relationships: {
             readonly type: "array";
             readonly items: {
                 readonly type: "object";
                 readonly properties: {
+                    readonly override: {
+                        readonly type: "boolean";
+                    };
                     readonly templateFormat: {
                         readonly enum: readonly ["heading", "list", "table", "page"];
                     };
@@ -290,143 +404,179 @@ export declare const METADATA_SCHEMA: {
         readonly aliases: {
             readonly type: "object";
             readonly additionalProperties: {
-                readonly type: "string";
-                readonly minLength: 1;
-            };
-        };
-        readonly rules: {
-            readonly type: "array";
-            readonly items: {
                 readonly oneOf: readonly [{
+                    readonly type: "string";
+                    readonly minLength: 1;
+                }, {
                     readonly type: "object";
                     readonly properties: {
-                        readonly id: {
-                            readonly type: "string";
-                            readonly minLength: 1;
-                        };
-                        readonly category: {
-                            readonly enum: readonly ["validation", "coherence", "workflow", "best-practice"];
-                        };
-                        readonly description: {
-                            readonly type: "string";
-                            readonly minLength: 1;
-                        };
-                        readonly check: {
-                            readonly type: "string";
-                            readonly minLength: 1;
-                        };
                         readonly type: {
                             readonly type: "string";
                             readonly minLength: 1;
                         };
-                        readonly scope: {
-                            readonly enum: readonly ["global"];
-                        };
                         readonly override: {
                             readonly type: "boolean";
                         };
                     };
-                    readonly required: readonly ["id", "category", "description", "check"];
-                    readonly additionalProperties: false;
-                }, {
-                    readonly type: "object";
-                    readonly properties: {
-                        readonly $ref: {
-                            readonly type: "string";
-                            readonly minLength: 1;
-                        };
-                    };
-                    readonly required: readonly ["$ref"];
+                    readonly required: readonly ["type"];
                     readonly additionalProperties: false;
                 }];
             };
         };
+        readonly rules: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly category: {
+                        readonly enum: readonly ["validation", "coherence", "workflow", "best-practice"];
+                    };
+                    readonly severity: {
+                        readonly enum: readonly ["error", "warning", "info"];
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly check: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly type: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly scope: {
+                        readonly enum: readonly ["global"];
+                    };
+                    readonly override: {
+                        readonly type: "boolean";
+                    };
+                };
+                readonly required: readonly ["id", "category", "description", "check"];
+                readonly additionalProperties: false;
+            };
+        };
     };
     readonly additionalProperties: false;
 };
-export declare const DIALECT_META_SCHEMA: {
-    readonly $schema: "http://json-schema.org/draft-07/schema#";
-    readonly $id: "https://raw.githubusercontent.com/mindsocket/structured-context/main/schemas/generated/_structured_context_schema_meta.json";
+/** The dialect meta-schema, published under `$id`. */
+export declare function buildDialectMetaSchema(id: string): {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: string;
     readonly title: "structured-context schema dialect";
-    readonly description: "Extends JSON Schema Draft-07 with top-level $metadata for hierarchy and rule metadata.";
+    readonly description: "Extends JSON Schema 2020-12 with top-level $metadata for imports, hierarchy, relationships, aliases and rules.";
     readonly type: "object";
     readonly allOf: readonly [{
-        readonly $ref: "http://json-schema.org/draft-07/schema#";
+        readonly $ref: "https://json-schema.org/draft/2020-12/schema";
     }];
     readonly properties: {
         readonly $metadata: {
             readonly type: "object";
             readonly properties: {
+                readonly imports: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                };
                 readonly hierarchy: {
-                    readonly type: "object";
-                    readonly properties: {
-                        readonly levels: {
-                            readonly type: "array";
-                            readonly minItems: 1;
-                            readonly items: {
-                                readonly oneOf: readonly [{
-                                    readonly type: "string";
-                                    readonly minLength: 1;
-                                }, {
-                                    readonly type: "object";
-                                    readonly properties: {
-                                        readonly selfRef: {
-                                            readonly type: "boolean";
-                                        };
-                                        readonly selfRefField: {
-                                            readonly type: "string";
-                                            readonly minLength: 1;
-                                        };
-                                        readonly templateFormat: {
-                                            readonly enum: readonly ["heading", "list", "table", "page"];
-                                        };
-                                        readonly matchers: {
-                                            readonly type: "array";
-                                            readonly items: {
+                    readonly oneOf: readonly [{
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly name: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly override: {
+                                readonly type: "boolean";
+                            };
+                            readonly levels: {
+                                readonly type: "array";
+                                readonly minItems: 1;
+                                readonly items: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    }, {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly selfRef: {
+                                                readonly type: "boolean";
+                                            };
+                                            readonly selfRefField: {
                                                 readonly type: "string";
                                                 readonly minLength: 1;
                                             };
-                                            readonly minItems: 1;
-                                        };
-                                        readonly embeddedTemplateFields: {
-                                            readonly type: "array";
-                                            readonly items: {
+                                            readonly templateFormat: {
+                                                readonly enum: readonly ["heading", "list", "table", "page"];
+                                            };
+                                            readonly matchers: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                    readonly minLength: 1;
+                                                };
+                                                readonly minItems: 1;
+                                            };
+                                            readonly embeddedTemplateFields: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                    readonly minLength: 1;
+                                                };
+                                            };
+                                            readonly field: {
+                                                readonly type: "string";
+                                                readonly minLength: 1;
+                                            };
+                                            readonly fieldOn: {
+                                                readonly enum: readonly ["child", "parent"];
+                                            };
+                                            readonly multiple: {
+                                                readonly type: "boolean";
+                                            };
+                                            readonly type: {
                                                 readonly type: "string";
                                                 readonly minLength: 1;
                                             };
                                         };
-                                        readonly field: {
-                                            readonly type: "string";
-                                            readonly minLength: 1;
-                                        };
-                                        readonly fieldOn: {
-                                            readonly enum: readonly ["child", "parent"];
-                                        };
-                                        readonly multiple: {
-                                            readonly type: "boolean";
-                                        };
-                                        readonly type: {
-                                            readonly type: "string";
-                                            readonly minLength: 1;
-                                        };
-                                    };
-                                    readonly required: readonly ["type"];
-                                    readonly additionalProperties: false;
-                                }];
+                                        readonly required: readonly ["type"];
+                                        readonly additionalProperties: false;
+                                    }];
+                                };
+                            };
+                            readonly allowSkipLevels: {
+                                readonly type: "boolean";
                             };
                         };
-                        readonly allowSkipLevels: {
-                            readonly type: "boolean";
+                        readonly required: readonly ["levels"];
+                        readonly additionalProperties: false;
+                    }, {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly $ref: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
                         };
-                    };
-                    readonly required: readonly ["levels"];
-                    readonly additionalProperties: false;
+                        readonly required: readonly ["$ref"];
+                        readonly additionalProperties: false;
+                    }];
                 };
                 readonly relationships: {
                     readonly type: "array";
                     readonly items: {
                         readonly type: "object";
                         readonly properties: {
+                            readonly override: {
+                                readonly type: "boolean";
+                            };
                             readonly templateFormat: {
                                 readonly enum: readonly ["heading", "list", "table", "page"];
                             };
@@ -471,68 +621,74 @@ export declare const DIALECT_META_SCHEMA: {
                 readonly aliases: {
                     readonly type: "object";
                     readonly additionalProperties: {
-                        readonly type: "string";
-                        readonly minLength: 1;
-                    };
-                };
-                readonly rules: {
-                    readonly type: "array";
-                    readonly items: {
                         readonly oneOf: readonly [{
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        }, {
                             readonly type: "object";
                             readonly properties: {
-                                readonly id: {
-                                    readonly type: "string";
-                                    readonly minLength: 1;
-                                };
-                                readonly category: {
-                                    readonly enum: readonly ["validation", "coherence", "workflow", "best-practice"];
-                                };
-                                readonly description: {
-                                    readonly type: "string";
-                                    readonly minLength: 1;
-                                };
-                                readonly check: {
-                                    readonly type: "string";
-                                    readonly minLength: 1;
-                                };
                                 readonly type: {
                                     readonly type: "string";
                                     readonly minLength: 1;
                                 };
-                                readonly scope: {
-                                    readonly enum: readonly ["global"];
-                                };
                                 readonly override: {
                                     readonly type: "boolean";
                                 };
                             };
-                            readonly required: readonly ["id", "category", "description", "check"];
-                            readonly additionalProperties: false;
-                        }, {
-                            readonly type: "object";
-                            readonly properties: {
-                                readonly $ref: {
-                                    readonly type: "string";
-                                    readonly minLength: 1;
-                                };
-                            };
-                            readonly required: readonly ["$ref"];
+                            readonly required: readonly ["type"];
                             readonly additionalProperties: false;
                         }];
                     };
                 };
+                readonly rules: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly category: {
+                                readonly enum: readonly ["validation", "coherence", "workflow", "best-practice"];
+                            };
+                            readonly severity: {
+                                readonly enum: readonly ["error", "warning", "info"];
+                            };
+                            readonly description: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly check: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly type: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly scope: {
+                                readonly enum: readonly ["global"];
+                            };
+                            readonly override: {
+                                readonly type: "boolean";
+                            };
+                        };
+                        readonly required: readonly ["id", "category", "description", "check"];
+                        readonly additionalProperties: false;
+                    };
+                };
             };
             readonly additionalProperties: false;
         };
     };
 };
 export type MetadataContract = FromSchema<typeof METADATA_SCHEMA>;
+export type MetadataContractHierarchy = FromSchema<typeof HIERARCHY_SCHEMA>;
 export type MetadataContractHierarchyLevel = FromSchema<typeof HIERARCHY_LEVEL_SCHEMA>;
 export type MetadataContractRelationship = FromSchema<typeof RELATIONSHIP_SCHEMA>;
 export type SharedEdgeFields = FromSchema<typeof EDGE_SCHEMA>;
 export type SharedEmbeddingFields = FromSchema<typeof EMBEDDING_SCHEMA>;
 export type Rule = FromSchema<typeof RULE_SCHEMA>;
-export type RuleRef = FromSchema<typeof RULE_REF_SCHEMA>;
-export type RuleEntry = Rule | RuleRef;
+export type MetadataRef = FromSchema<typeof REF_SCHEMA>;
 export {};