@kubun/protocol 0.1.0

package/LICENSE.md

@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Paul Le Cam
+
+Source Code: https://github.com/PaulLeCam/kubun
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***

package/README.md

@@ -0,0 +1,11 @@
+# Kubun protocol
+
+## Installation
+
+```sh
+npm install @kubun/protocol
+```
+
+## License
+
+[Prosperity Public License 3.0.0](LICENSE.md)

package/lib/index.d.ts

@@ -0,0 +1,14 @@
+import type { AnyClientMessageOf, AnyServerMessageOf, ClientTransportOf, ServerTransportOf } from '@enkaku/protocol';
+import type { GraphCommands } from './services/graph.js';
+export * from './models/cluster.js';
+export * from './models/document.js';
+export * from './models/graph.js';
+export * from './models/json-schema.js';
+export * from './models/value.js';
+export * from './services/graph.js';
+export type Definitions = GraphCommands;
+export type ClientMessage = AnyClientMessageOf<Definitions>;
+export type ServerMessage = AnyServerMessageOf<Definitions>;
+export type ClientTransport = ClientTransportOf<Definitions>;
+export type ServerTransport = ServerTransportOf<Definitions>;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,kBAAkB,CAAA;AAEzB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAExD,cAAc,qBAAqB,CAAA;AACnC,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA;AAEnC,MAAM,MAAM,WAAW,GAAG,aAAa,CAAA;AAEvC,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAA;AAC3D,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAA;AAE3D,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAA;AAC5D,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAA"}

package/lib/index.js

@@ -0,0 +1,6 @@
+export * from './models/cluster.js';
+export * from './models/document.js';
+export * from './models/graph.js';
+export * from './models/json-schema.js';
+export * from './models/value.js';
+export * from './services/graph.js';

package/lib/models/cluster.d.ts

@@ -0,0 +1,17 @@
+import type { JSONSchema } from 'json-schema-typed';
+import type { DocumentModel, DocumentModelsCluster } from './document.js';
+type SetDocumentModel = Omit<DocumentModel, 'schema'> & {
+    schema: JSONSchema.Object;
+};
+type JSONSchemaScalar = JSONSchema.Boolean | JSONSchema.Integer | JSONSchema.Number | JSONSchema.String;
+type JSONSchemaShape = JSONSchema.Array | JSONSchema.Object;
+type JSONSchemaType = JSONSchemaScalar | JSONSchemaShape;
+export type JSONSchemaReferencesRecord = Record<string, JSONSchemaType>;
+export declare const REFERENCE_PREFIX = "#/$defs/";
+export declare class ClusterBuilder {
+    #private;
+    get cluster(): DocumentModelsCluster;
+    set(index: number, model: SetDocumentModel): void;
+}
+export {};
+//# sourceMappingURL=cluster.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cluster.d.ts","sourceRoot":"","sources":["../../src/models/cluster.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAEnD,OAAO,KAAK,EAAE,aAAa,EAAuB,qBAAqB,EAAE,MAAM,eAAe,CAAA;AAG9F,KAAK,gBAAgB,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG;IACtD,MAAM,EAAE,UAAU,CAAC,MAAM,CAAA;CAC1B,CAAA;AAED,KAAK,gBAAgB,GACjB,UAAU,CAAC,OAAO,GAClB,UAAU,CAAC,OAAO,GAClB,UAAU,CAAC,MAAM,GACjB,UAAU,CAAC,MAAM,CAAA;AACrB,KAAK,eAAe,GAAG,UAAU,CAAC,KAAK,GAAG,UAAU,CAAC,MAAM,CAAA;AAC3D,KAAK,cAAc,GAAG,gBAAgB,GAAG,eAAe,CAAA;AAExD,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;AAEvE,eAAO,MAAM,gBAAgB,aAAa,CAAA;AAuF1C,qBAAa,cAAc;;IAGzB,IAAI,OAAO,IAAI,qBAAqB,CAEnC;IAED,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB;CAO3C"}

package/lib/models/cluster.js

@@ -0,0 +1,102 @@
+import { ScalarModelID, ShapeModelID } from '@kubun/id';
+export const REFERENCE_PREFIX = '#/$defs/';
+function toReference(id) {
+    return `${REFERENCE_PREFIX}${id}`;
+}
+function addScalar(refs, schema) {
+    const id = ScalarModelID.create(schema);
+    refs[id.toString()] = schema;
+    return toReference(id);
+}
+function addShape(refs, schema) {
+    const id = ShapeModelID.create(schema);
+    refs[id.toString()] = schema;
+    return toReference(id);
+}
+function encodeSchema(refs, schema) {
+    if (schema.$ref != null) {
+        return schema.$ref;
+    }
+    const type = schema.type;
+    if (type == null) {
+        throw new Error('Invalid schema: missing type');
+    }
+    switch(type){
+        case 'array':
+            {
+                if (schema.title == null) {
+                    throw new Error('Invalid array schema: missing title');
+                }
+                if (schema.items == null) {
+                    throw new Error('Invalid array schema: missing items');
+                }
+                return addShape(refs, {
+                    ...schema,
+                    items: {
+                        $ref: encodeSchema(refs, schema.items)
+                    }
+                });
+            }
+        case 'object':
+            {
+                if (schema.title == null) {
+                    throw new Error('Invalid object schema: missing title');
+                }
+                const entries = Object.entries(schema.properties ?? {});
+                if (entries.length === 0) {
+                    throw new Error('Invalid object schema: must contain at least one property');
+                }
+                const properties = {};
+                for (const [key, value] of entries){
+                    properties[key] = {
+                        $ref: encodeSchema(refs, value)
+                    };
+                }
+                return addShape(refs, {
+                    type: 'object',
+                    title: schema.title,
+                    properties,
+                    required: schema.required ?? [],
+                    additionalProperties: false
+                });
+            }
+        default:
+            return addScalar(refs, schema);
+    }
+}
+function normalizeDocumentSchema(schema) {
+    const entries = Object.entries(schema.properties ?? {});
+    if (entries.length === 0) {
+        throw new Error('Document schema must contain at least one property');
+    }
+    const properties = {};
+    const refs = {};
+    for (const [key, value] of entries){
+        properties[key] = {
+            $ref: encodeSchema(refs, value)
+        };
+    }
+    return {
+        type: 'object',
+        properties,
+        additionalProperties: false,
+        required: schema.required ?? [],
+        $defs: refs
+    };
+}
+export class ClusterBuilder {
+    #cluster = [];
+    get cluster() {
+        return this.#cluster;
+    }
+    set(index, model) {
+        if (index !== this.#cluster.length) {
+            throw new Error(`Invalid document index: ${index}, expected: ${this.#cluster.length}`);
+        }
+        const schema = normalizeDocumentSchema(model.schema);
+        this.#cluster.push({
+            ...model,
+            schema
+        });
+    }
+}