@kubun/protocol 0.1.0

package/lib/models/document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../src/models/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAwB,MAAM,gBAAgB,CAAA;AAKtE,eAAO,MAAM,oBAAoB;;;CAA6D,CAAA;AAE9F,eAAO,MAAM,iBAAiB;;;;;;;;;;;;CAMH,CAAA;AAC3B,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAErE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;CAGJ,CAAA;AAC3B,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEtE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAQL,CAAA;AAC3B,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAExE,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWH,CAAA;AAE3B,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAQR,CAAA;AAE3B,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAQH,CAAA;AAE3B,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CASF,CAAA;AAE3B,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGO,CAAA;AACjC,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAA;AAE5D,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGP,CAAA;AAC3B,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAE5E,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGN,CAAA;AAC3B,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAE1E,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAcC,CAAA;AACjC,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAExE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAaF,CAAA;AACjC,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE9E,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGI,CAAA;AACjC,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAElE,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA"}

package/lib/models/document.js

@@ -0,0 +1,229 @@
+import { baseObjectModel, referencesRecordModel } from './json-schema.js';
+import { binaryStringValue, didStringValue } from './value.js';
+export const documentModelVersion = {
+    type: 'string',
+    const: '1.0'
+};
+export const documentFieldMeta = {
+    type: 'object',
+    properties: {
+        relationModel: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'null'
+                }
+            ]
+        }
+    },
+    additionalProperties: false
+};
+export const documentFieldsMeta = {
+    type: 'object',
+    additionalProperties: documentFieldMeta
+};
+export const documentModelSchema = {
+    type: 'object',
+    properties: {
+        ...baseObjectModel.properties,
+        $defs: referencesRecordModel
+    },
+    required: [
+        ...baseObjectModel.required,
+        '$defs'
+    ],
+    additionalProperties: false
+};
+export const documentModelBase = {
+    type: 'object',
+    properties: {
+        name: {
+            type: 'string'
+        },
+        version: documentModelVersion,
+        interfaces: {
+            type: 'array',
+            items: {
+                type: 'string'
+            }
+        },
+        schema: documentModelSchema,
+        fieldsMeta: documentFieldsMeta
+    },
+    required: [
+        'name',
+        'version',
+        'interfaces',
+        'schema',
+        'fieldsMeta'
+    ],
+    additionalProperties: false
+};
+export const documentModelInterface = {
+    type: 'object',
+    properties: {
+        ...documentModelBase.properties,
+        behavior: {
+            type: 'string',
+            const: 'interface'
+        }
+    },
+    required: [
+        ...documentModelBase.required,
+        'behavior'
+    ],
+    additionalProperties: false
+};
+export const documentModelList = {
+    type: 'object',
+    properties: {
+        ...documentModelBase.properties,
+        behavior: {
+            type: 'string',
+            const: 'list'
+        }
+    },
+    required: [
+        ...documentModelBase.required,
+        'behavior'
+    ],
+    additionalProperties: false
+};
+export const documentModelSet = {
+    type: 'object',
+    properties: {
+        ...documentModelBase.properties,
+        behavior: {
+            type: 'string',
+            const: 'set'
+        },
+        setFields: {
+            type: 'array',
+            items: {
+                type: 'string'
+            }
+        }
+    },
+    required: [
+        ...documentModelBase.required,
+        'behavior',
+        'setFields'
+    ],
+    additionalProperties: false
+};
+export const documentModel = {
+    $id: 'urn:kubun:protocol:model:document',
+    anyOf: [
+        documentModelInterface,
+        documentModelList,
+        documentModelSet
+    ]
+};
+export const documentModelsCluster = {
+    type: 'array',
+    items: documentModel
+};
+export const documentModelsRecord = {
+    type: 'object',
+    additionalProperties: documentModel
+};
+export const setDocumentMutation = {
+    $id: 'urn:kubun:protocol:mutation:set',
+    type: 'object',
+    properties: {
+        typ: {
+            type: 'string',
+            const: 'set'
+        },
+        iss: didStringValue,
+        aud: didStringValue,
+        sub: {
+            type: 'string'
+        },
+        data: {
+            anyOf: [
+                binaryStringValue,
+                {
+                    type: 'null'
+                }
+            ]
+        },
+        unq: binaryStringValue,
+        cap: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    }
+                }
+            ]
+        }
+    },
+    required: [
+        'iss',
+        'sub',
+        'typ',
+        'data',
+        'unq'
+    ],
+    additionalProperties: false
+};
+export const changeDocumentMutation = {
+    $id: 'urn:kubun:protocol:mutation:change',
+    type: 'object',
+    properties: {
+        typ: {
+            type: 'string',
+            const: 'change'
+        },
+        iss: didStringValue,
+        sub: {
+            type: 'string'
+        },
+        data: {
+            anyOf: [
+                binaryStringValue,
+                {
+                    type: 'null'
+                }
+            ]
+        },
+        inc: {
+            type: 'boolean'
+        },
+        cap: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    }
+                }
+            ]
+        }
+    },
+    required: [
+        'iss',
+        'sub',
+        'typ',
+        'data',
+        'inc'
+    ],
+    additionalProperties: false
+};
+export const documentMutation = {
+    $id: 'urn:kubun:protocol:mutation',
+    anyOf: [
+        setDocumentMutation,
+        changeDocumentMutation
+    ]
+};

package/lib/models/graph.d.ts

@@ -0,0 +1,23 @@
+import type { DocumentModel, DocumentModelsCluster, DocumentModelsRecord } from './document.js';
+export type FromClustersParams = {
+    aliases?: Record<string, string>;
+    clusters: Array<DocumentModelsCluster>;
+};
+export type GraphModelParams = {
+    aliases?: Record<string, string>;
+    record: DocumentModelsRecord;
+};
+export type GraphModelJSON = {
+    aliases: Record<string, string>;
+    record: DocumentModelsRecord;
+};
+export declare class GraphModel {
+    #private;
+    static fromClusters(params: FromClustersParams): GraphModel;
+    constructor(params: GraphModelParams);
+    get aliases(): Record<string, string>;
+    get record(): DocumentModelsRecord;
+    getModel(aliasOrID: string): DocumentModel | null;
+    toJSON(): GraphModelJSON;
+}
+//# sourceMappingURL=graph.d.ts.map

package/lib/models/graph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph.d.ts","sourceRoot":"","sources":["../../src/models/graph.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAE/F,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,QAAQ,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,MAAM,EAAE,oBAAoB,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,MAAM,EAAE,oBAAoB,CAAA;CAC7B,CAAA;AAED,qBAAa,UAAU;;IACrB,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,UAAU;gBAe/C,MAAM,EAAE,gBAAgB;IAKpC,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAEpC;IAED,IAAI,MAAM,IAAI,oBAAoB,CAEjC;IAED,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI;IAKjD,MAAM,IAAI,cAAc;CAGzB"}

package/lib/models/graph.js

@@ -0,0 +1,39 @@
+import { GraphModelID, toDigestBytes } from '@kubun/id';
+export class GraphModel {
+    static fromClusters(params) {
+        const record = {};
+        for (const cluster of params.clusters){
+            const digestBytes = toDigestBytes(cluster);
+            for (const [index, model] of cluster.entries()){
+                const id = new GraphModelID(digestBytes, index);
+                record[id.toString()] = model;
+            }
+        }
+        return new GraphModel({
+            aliases: params.aliases,
+            record
+        });
+    }
+    #aliases;
+    #record;
+    constructor(params){
+        this.#aliases = params.aliases ?? {};
+        this.#record = params.record;
+    }
+    get aliases() {
+        return this.#aliases;
+    }
+    get record() {
+        return this.#record;
+    }
+    getModel(aliasOrID) {
+        const id = this.#aliases[aliasOrID] ?? aliasOrID;
+        return this.#record[id] ?? null;
+    }
+    toJSON() {
+        return {
+            aliases: this.#aliases,
+            record: this.#record
+        };
+    }
+}