@ixo/topic-protocol 1.0.0-rc.4 → 1.0.0-rc.6

package/dist/src/v2/validate.d.ts

@@ -0,0 +1,650 @@
+export declare const SCHEMAS_V2: Readonly<{
+    capsule: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            version: {
+                const: number;
+            };
+            topic: {
+                $ref: string;
+            };
+            messages: {
+                type: string;
+                maxItems: number;
+                items: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        eventId: {
+                            $ref: string;
+                        };
+                        sender: {
+                            $ref: string;
+                        };
+                        body: {
+                            type: string;
+                        };
+                        at: {
+                            $ref: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+            };
+            hint: {
+                type: string;
+                minLength: number;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    operation: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            version: {
+                const: number;
+            };
+            id: {
+                type: string;
+                pattern: string;
+                description: string;
+            };
+            topicId: {
+                $ref: string;
+            };
+            type: {
+                type: string;
+                enum: string[];
+            };
+            actor: {
+                $ref: string;
+            };
+            createdAt: {
+                $ref: string;
+            };
+            fields: {
+                type: string;
+                minProperties: number;
+                properties: {
+                    title: {
+                        $ref: string;
+                    };
+                    owner: {
+                        oneOf: ({
+                            $ref: string;
+                            type?: never;
+                        } | {
+                            type: string;
+                            $ref?: never;
+                        })[];
+                    };
+                    due: {
+                        oneOf: ({
+                            $ref: string;
+                            type?: never;
+                        } | {
+                            type: string;
+                            $ref?: never;
+                        })[];
+                    };
+                    intent: {
+                        oneOf: ({
+                            $ref: string;
+                            type?: never;
+                        } | {
+                            type: string;
+                            $ref?: never;
+                        })[];
+                    };
+                    outcome: {
+                        oneOf: ({
+                            $ref: string;
+                            type?: never;
+                        } | {
+                            type: string;
+                            $ref?: never;
+                        })[];
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            status: {
+                $ref: string;
+            };
+            reason: {
+                $ref: string;
+            };
+            on: {
+                type: string;
+                minLength: number;
+            };
+            ref: {
+                $ref: string;
+            };
+            file: {
+                $ref: string;
+            };
+            resource: {
+                type: string;
+                minLength: number;
+            };
+            fileId: {
+                type: string;
+                minLength: number;
+            };
+            relation: {
+                $ref: string;
+            };
+            targetTopicId: {
+                $ref: string;
+            };
+            flowUri: {
+                type: string;
+                minLength: number;
+            };
+        };
+        allOf: ({
+            if: {
+                properties: {
+                    type: {
+                        const: string;
+                        enum?: never;
+                    };
+                };
+                required: string[];
+            };
+            then: {
+                properties: {
+                    fields: boolean;
+                    status?: never;
+                    reason?: never;
+                    ref?: never;
+                    file?: never;
+                    resource?: never;
+                    fileId?: never;
+                    relation?: never;
+                    targetTopicId?: never;
+                    flowUri?: never;
+                };
+                required: string[];
+            };
+        } | {
+            if: {
+                properties: {
+                    type: {
+                        const: string;
+                        enum?: never;
+                    };
+                };
+                required: string[];
+            };
+            then: {
+                properties: {
+                    status: boolean;
+                    fields?: never;
+                    reason?: never;
+                    ref?: never;
+                    file?: never;
+                    resource?: never;
+                    fileId?: never;
+                    relation?: never;
+                    targetTopicId?: never;
+                    flowUri?: never;
+                };
+                required: string[];
+            };
+        } | {
+            if: {
+                properties: {
+                    type: {
+                        const: string;
+                        enum?: never;
+                    };
+                };
+                required: string[];
+            };
+            then: {
+                properties: {
+                    reason: boolean;
+                    fields?: never;
+                    status?: never;
+                    ref?: never;
+                    file?: never;
+                    resource?: never;
+                    fileId?: never;
+                    relation?: never;
+                    targetTopicId?: never;
+                    flowUri?: never;
+                };
+                required: string[];
+            };
+        } | {
+            if: {
+                properties: {
+                    type: {
+                        enum: string[];
+                        const?: never;
+                    };
+                };
+                required: string[];
+            };
+            then: {
+                properties: {
+                    ref: boolean;
+                    fields?: never;
+                    status?: never;
+                    reason?: never;
+                    file?: never;
+                    resource?: never;
+                    fileId?: never;
+                    relation?: never;
+                    targetTopicId?: never;
+                    flowUri?: never;
+                };
+                required: string[];
+            };
+        } | {
+            if: {
+                properties: {
+                    type: {
+                        const: string;
+                        enum?: never;
+                    };
+                };
+                required: string[];
+            };
+            then: {
+                properties: {
+                    file: boolean;
+                    fields?: never;
+                    status?: never;
+                    reason?: never;
+                    ref?: never;
+                    resource?: never;
+                    fileId?: never;
+                    relation?: never;
+                    targetTopicId?: never;
+                    flowUri?: never;
+                };
+                required: string[];
+            };
+        } | {
+            if: {
+                properties: {
+                    type: {
+                        const: string;
+                        enum?: never;
+                    };
+                };
+                required: string[];
+            };
+            then: {
+                properties: {
+                    resource: boolean;
+                    fileId: boolean;
+                    fields?: never;
+                    status?: never;
+                    reason?: never;
+                    ref?: never;
+                    file?: never;
+                    relation?: never;
+                    targetTopicId?: never;
+                    flowUri?: never;
+                };
+                required: string[];
+            };
+        } | {
+            if: {
+                properties: {
+                    type: {
+                        enum: string[];
+                        const?: never;
+                    };
+                };
+                required: string[];
+            };
+            then: {
+                properties: {
+                    relation: boolean;
+                    targetTopicId: boolean;
+                    fields?: never;
+                    status?: never;
+                    reason?: never;
+                    ref?: never;
+                    file?: never;
+                    resource?: never;
+                    fileId?: never;
+                    flowUri?: never;
+                };
+                required: string[];
+            };
+        } | {
+            if: {
+                properties: {
+                    type: {
+                        const: string;
+                        enum?: never;
+                    };
+                };
+                required: string[];
+            };
+            then: {
+                properties: {
+                    flowUri: boolean;
+                    fields?: never;
+                    status?: never;
+                    reason?: never;
+                    ref?: never;
+                    file?: never;
+                    resource?: never;
+                    fileId?: never;
+                    relation?: never;
+                    targetTopicId?: never;
+                };
+                required: string[];
+            };
+        })[];
+        additionalProperties: boolean;
+    };
+    projection: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            version: {
+                const: number;
+            };
+            id: {
+                $ref: string;
+            };
+            anchor: {
+                $ref: string;
+            };
+            title: {
+                $ref: string;
+            };
+            kind: {
+                $ref: string;
+            };
+            baseKind: {
+                $ref: string;
+            };
+            status: {
+                $ref: string;
+            };
+            owner: {
+                $ref: string;
+            };
+            due: {
+                $ref: string;
+            };
+            intent: {
+                $ref: string;
+            };
+            outcome: {
+                $ref: string;
+            };
+            blocked: {
+                $ref: string;
+            };
+            createdBy: {
+                $ref: string;
+            };
+            createdAt: {
+                $ref: string;
+            };
+            updatedBy: {
+                $ref: string;
+            };
+            updatedAt: {
+                $ref: string;
+            };
+            links: {
+                type: string;
+                items: {
+                    $ref: string;
+                };
+            };
+            files: {
+                type: string;
+                items: {
+                    $ref: string;
+                };
+            };
+            relations: {
+                type: string;
+                items: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        relation: {
+                            $ref: string;
+                        };
+                        topicId: {
+                            $ref: string;
+                        };
+                        by: {
+                            $ref: string;
+                        };
+                        at: {
+                            $ref: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+            };
+            flow: {
+                type: string;
+                required: string[];
+                properties: {
+                    flowUri: {
+                        type: string;
+                        minLength: number;
+                    };
+                    by: {
+                        $ref: string;
+                    };
+                    at: {
+                        $ref: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            records: {
+                type: string;
+                required: string[];
+                properties: {
+                    decisions: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    outcomes: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    artifacts: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    receipts: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            etag: {
+                type: string;
+                pattern: string;
+                description: string;
+            };
+            rejected: {
+                type: string;
+                items: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        id: {
+                            type: string;
+                            minLength: number;
+                        };
+                        reason: {
+                            type: string;
+                            enum: string[];
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+            };
+        };
+        additionalProperties: boolean;
+    };
+    record: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            version: {
+                const: number;
+            };
+            id: {
+                type: string;
+                pattern: string;
+                description: string;
+            };
+            topicId: {
+                $ref: string;
+            };
+            type: {
+                $ref: string;
+            };
+            text: {
+                $ref: string;
+            };
+            author: {
+                $ref: string;
+            };
+            createdAt: {
+                $ref: string;
+            };
+            refs: {
+                type: string;
+                items: {
+                    $ref: string;
+                };
+                maxItems: number;
+            };
+            data: {
+                type: string;
+            };
+            supersedes: {
+                type: string;
+                pattern: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    topic: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            version: {
+                const: number;
+            };
+            id: {
+                $ref: string;
+            };
+            title: {
+                $ref: string;
+            };
+            kind: {
+                $ref: string;
+            };
+            baseKind: {
+                $ref: string;
+            };
+            createdBy: {
+                $ref: string;
+            };
+            createdAt: {
+                $ref: string;
+            };
+            owner: {
+                $ref: string;
+            };
+            due: {
+                $ref: string;
+            };
+            intent: {
+                $ref: string;
+            };
+            outcome: {
+                $ref: string;
+            };
+        };
+        if: {
+            properties: {
+                kind: {
+                    enum: string[];
+                };
+            };
+            required: string[];
+        };
+        then: {
+            not: {
+                properties: {
+                    baseKind: boolean;
+                };
+                required: string[];
+            };
+        };
+        else: {
+            properties: {
+                baseKind: boolean;
+            };
+            required: string[];
+        };
+        additionalProperties: boolean;
+    };
+}>;
+export type SchemaNameV2 = keyof typeof SCHEMAS_V2;
+export interface ValidationIssueV2 {
+    readonly path: string;
+    readonly message: string;
+}
+export type ValidationResultV2 = {
+    readonly ok: true;
+} | {
+    readonly ok: false;
+    readonly issues: readonly ValidationIssueV2[];
+};
+export declare function validateV2(name: SchemaNameV2, value: unknown): ValidationResultV2;
+export declare function assertV2(name: SchemaNameV2, value: unknown): void;

package/dist/src/v2/validate.js

@@ -0,0 +1,45 @@
+import { Ajv2020 } from "ajv/dist/2020.js";
+import * as formatsModule from "ajv-formats";
+import capsule from "../../schemas/v2/capsule.schema.json" with { type: "json" };
+import common from "../../schemas/v2/common.schema.json" with { type: "json" };
+import operation from "../../schemas/v2/operation.schema.json" with { type: "json" };
+import projection from "../../schemas/v2/projection.schema.json" with { type: "json" };
+import record from "../../schemas/v2/record.schema.json" with { type: "json" };
+import topic from "../../schemas/v2/topic.schema.json" with { type: "json" };
+import { TopicProtocolError } from "../errors.js";
+export const SCHEMAS_V2 = Object.freeze({
+    capsule,
+    operation,
+    projection,
+    record,
+    topic,
+});
+const ajv = new Ajv2020({ allErrors: true, strict: true, schemas: [common, record, projection] });
+formatsModule.default(ajv);
+const compiled = new Map();
+function validatorFor(name) {
+    const existing = compiled.get(name);
+    if (existing !== undefined)
+        return existing;
+    const schema = SCHEMAS_V2[name];
+    const validator = ajv.getSchema(schema.$id) ?? ajv.compile(schema);
+    compiled.set(name, validator);
+    return validator;
+}
+export function validateV2(name, value) {
+    const validator = validatorFor(name);
+    if (validator(value))
+        return { ok: true };
+    const issues = (validator.errors ?? []).map((error) => ({
+        path: error.instancePath.length === 0 ? "/" : error.instancePath,
+        message: error.message ?? "is invalid",
+    }));
+    return { ok: false, issues };
+}
+export function assertV2(name, value) {
+    const result = validateV2(name, value);
+    if (result.ok)
+        return;
+    throw new TopicProtocolError("CONTRACT_VALIDATION_FAILED", `Protocol 2.0 ${name} failed validation`, { schema: name, issues: result.issues });
+}
+//# sourceMappingURL=validate.js.map

package/dist/src/v2/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../src/v2/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAyB,MAAM,kBAAkB,CAAC;AAClE,OAAO,KAAK,aAAa,MAAM,aAAa,CAAC;AAG7C,OAAO,OAAO,MAAM,sCAAsC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACjF,OAAO,MAAM,MAAM,qCAAqC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC/E,OAAO,SAAS,MAAM,wCAAwC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACrF,OAAO,UAAU,MAAM,yCAAyC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACvF,OAAO,MAAM,MAAM,qCAAqC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC/E,OAAO,KAAK,MAAM,oCAAoC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;IACtC,OAAO;IACP,SAAS;IACT,UAAU;IACV,MAAM;IACN,KAAK;CACN,CAAC,CAAC;AAaH,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC;AACjG,aAAa,CAAC,OAAoC,CAAC,GAAG,CAAC,CAAC;AACzD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkC,CAAC;AAE3D,SAAS,YAAY,CAAC,IAAkB;IACtC,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IAC5C,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnE,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC9B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,IAAkB,EAAE,KAAc;IAC3D,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;IAC1C,MAAM,MAAM,GAAG,CAAC,SAAS,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACtD,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY;QAChE,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,YAAY;KACvC,CAAC,CAAC,CAAC;IACJ,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,IAAkB,EAAE,KAAc;IACzD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACvC,IAAI,MAAM,CAAC,EAAE;QAAE,OAAO;IACtB,MAAM,IAAI,kBAAkB,CAC1B,4BAA4B,EAC5B,gBAAgB,IAAI,oBAAoB,EACxC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CACxC,CAAC;AACJ,CAAC"}