@kubun/protocol 0.10.0 → 0.12.0

package/lib/services/graph.d.ts

@@ -1,4 +1,4 @@
-import type { FromSchema } from '@enkaku/schema';
+import type { FromSchema } from '@sozai/schema';
 export declare const searchModelConfig: {
     readonly type: "object";
     readonly properties: {

package/lib/services/graph.js

@@ -1 +1,367 @@
-import{clusterModel as e}from"../models/cluster.js";import{documentModelsRecord as t}from"../models/document.js";import{binaryStringValue as r,signedJWTStringValue as a}from"../models/value.js";export const searchModelConfig={type:"object",properties:{fields:{type:"array",items:{type:"string"}}},additionalProperties:!1};export const searchConfig={type:"object",additionalProperties:searchModelConfig};export const deployGraphParams={type:"object",properties:{clusters:{type:"array",items:e},id:{type:"string"},name:{type:"string"},plugins:{type:"object",additionalProperties:{type:"object",additionalProperties:!0}},search:searchConfig},required:["clusters"],additionalProperties:!1};export const deployGraphResult={type:"object",properties:{id:{type:"string"},record:t,aliases:{type:"object",additionalProperties:{type:"string"}},search:searchConfig},required:["id","record","aliases"],additionalProperties:!1};export const listGraphResult={type:"object",properties:{graphs:{type:"array",items:{type:"object",properties:{id:{type:"string"},name:{type:"string"}},required:["id","name"],additionalProperties:!1}}},required:["graphs"],additionalProperties:!1};export const loadGraphParams={type:"object",properties:{id:{type:"string"}},required:["id"],additionalProperties:!1};export const loadGraphResult={type:"object",properties:{record:t,aliases:{type:"object",additionalProperties:{type:"string"}},extensionSDL:{type:"string"}},required:["record","aliases"],additionalProperties:!1};export const executeGraphParams={type:"object",properties:{id:{type:"string"},text:{type:"string"},variables:{type:"object"},catalogID:{type:"string"}},required:["id","text"],additionalProperties:!1};export const executeGraphError={type:"object",properties:{message:{type:"string"},locations:{type:"array",items:{type:"object",properties:{line:{type:"integer"},column:{type:"integer"}},required:["line","column"],additionalProperties:!1}},path:{type:"array",items:{type:"string"}},extensions:{type:"object"}},required:["message"],additionalProperties:!1};export const executeGraphResult={type:"object",properties:{data:{anyOf:[{type:"object"},{type:"null"}]},errors:{type:"array",items:executeGraphError},extensions:{type:"object"}},additionalProperties:!1};export const mutateGraphParams={type:"object",properties:{...executeGraphParams.properties,mutations:{anyOf:[{type:"object",additionalProperties:a},{type:"null"}]},attachments:{type:"object",additionalProperties:r},transactionID:{type:"string"}},required:[...executeGraphParams.required,"mutations"],additionalProperties:!1};export const beginTransactionParams={type:"object",properties:{id:{type:"string"}},required:["id"],additionalProperties:!1};export const beginTransactionResult={type:"object",properties:{transactionID:{type:"string"}},required:["transactionID"],additionalProperties:!1};export const transactionParams={type:"object",properties:{transactionID:{type:"string"}},required:["transactionID"],additionalProperties:!1};export const transactionResult={type:"object",properties:{success:{type:"boolean"},error:{type:"object",properties:{code:{type:"string"},message:{type:"string"},docID:{type:"string"}},required:["code","message"],additionalProperties:!1}},required:["success"],additionalProperties:!1};export const graphProtocol={"graph/deploy":{type:"request",param:deployGraphParams,result:deployGraphResult},"graph/list":{type:"request",result:listGraphResult},"graph/load":{type:"request",param:loadGraphParams,result:loadGraphResult},"graph/mutate":{type:"request",param:mutateGraphParams,result:executeGraphResult},"graph/query":{type:"request",param:executeGraphParams,result:executeGraphResult},"graph/subscribe":{type:"stream",param:executeGraphParams,receive:executeGraphResult,result:{anyOf:[executeGraphResult,{type:"null"}]}},"graph/beginTransaction":{type:"request",param:beginTransactionParams,result:beginTransactionResult},"graph/commitTransaction":{type:"request",param:transactionParams,result:transactionResult},"graph/rollbackTransaction":{type:"request",param:transactionParams,result:transactionResult}};
+import { clusterModel } from '../models/cluster.js';
+import { documentModelsRecord } from '../models/document.js';
+import { binaryStringValue, signedJWTStringValue } from '../models/value.js';
+export const searchModelConfig = {
+    type: 'object',
+    properties: {
+        fields: {
+            type: 'array',
+            items: {
+                type: 'string'
+            }
+        }
+    },
+    additionalProperties: false
+};
+export const searchConfig = {
+    type: 'object',
+    additionalProperties: searchModelConfig
+};
+export const deployGraphParams = {
+    type: 'object',
+    properties: {
+        clusters: {
+            type: 'array',
+            items: clusterModel
+        },
+        id: {
+            type: 'string'
+        },
+        name: {
+            type: 'string'
+        },
+        plugins: {
+            type: 'object',
+            additionalProperties: {
+                type: 'object',
+                additionalProperties: true
+            }
+        },
+        search: searchConfig
+    },
+    required: [
+        'clusters'
+    ],
+    additionalProperties: false
+};
+export const deployGraphResult = {
+    type: 'object',
+    properties: {
+        id: {
+            type: 'string'
+        },
+        record: documentModelsRecord,
+        aliases: {
+            type: 'object',
+            additionalProperties: {
+                type: 'string'
+            }
+        },
+        search: searchConfig
+    },
+    required: [
+        'id',
+        'record',
+        'aliases'
+    ],
+    additionalProperties: false
+};
+export const listGraphResult = {
+    type: 'object',
+    properties: {
+        graphs: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    id: {
+                        type: 'string'
+                    },
+                    name: {
+                        type: 'string'
+                    }
+                },
+                required: [
+                    'id',
+                    'name'
+                ],
+                additionalProperties: false
+            }
+        }
+    },
+    required: [
+        'graphs'
+    ],
+    additionalProperties: false
+};
+export const loadGraphParams = {
+    type: 'object',
+    properties: {
+        id: {
+            type: 'string'
+        }
+    },
+    required: [
+        'id'
+    ],
+    additionalProperties: false
+};
+export const loadGraphResult = {
+    type: 'object',
+    properties: {
+        record: documentModelsRecord,
+        aliases: {
+            type: 'object',
+            additionalProperties: {
+                type: 'string'
+            }
+        },
+        extensionSDL: {
+            type: 'string'
+        }
+    },
+    required: [
+        'record',
+        'aliases'
+    ],
+    additionalProperties: false
+};
+export const executeGraphParams = {
+    type: 'object',
+    properties: {
+        id: {
+            type: 'string'
+        },
+        text: {
+            type: 'string'
+        },
+        variables: {
+            type: 'object'
+        },
+        catalogID: {
+            type: 'string'
+        }
+    },
+    required: [
+        'id',
+        'text'
+    ],
+    additionalProperties: false
+};
+export const executeGraphError = {
+    type: 'object',
+    properties: {
+        message: {
+            type: 'string'
+        },
+        locations: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    line: {
+                        type: 'integer'
+                    },
+                    column: {
+                        type: 'integer'
+                    }
+                },
+                required: [
+                    'line',
+                    'column'
+                ],
+                additionalProperties: false
+            }
+        },
+        path: {
+            type: 'array',
+            items: {
+                type: 'string'
+            }
+        },
+        extensions: {
+            type: 'object'
+        }
+    },
+    required: [
+        'message'
+    ],
+    additionalProperties: false
+};
+export const executeGraphResult = {
+    type: 'object',
+    properties: {
+        data: {
+            anyOf: [
+                {
+                    type: 'object'
+                },
+                {
+                    type: 'null'
+                }
+            ]
+        },
+        errors: {
+            type: 'array',
+            items: executeGraphError
+        },
+        extensions: {
+            type: 'object'
+        }
+    },
+    additionalProperties: false
+};
+export const mutateGraphParams = {
+    type: 'object',
+    properties: {
+        ...executeGraphParams.properties,
+        mutations: {
+            anyOf: [
+                {
+                    type: 'object',
+                    additionalProperties: signedJWTStringValue
+                },
+                {
+                    type: 'null'
+                }
+            ]
+        },
+        attachments: {
+            type: 'object',
+            additionalProperties: binaryStringValue
+        },
+        transactionID: {
+            type: 'string'
+        }
+    },
+    required: [
+        ...executeGraphParams.required,
+        'mutations'
+    ],
+    additionalProperties: false
+};
+export const beginTransactionParams = {
+    type: 'object',
+    properties: {
+        id: {
+            type: 'string'
+        }
+    },
+    required: [
+        'id'
+    ],
+    additionalProperties: false
+};
+export const beginTransactionResult = {
+    type: 'object',
+    properties: {
+        transactionID: {
+            type: 'string'
+        }
+    },
+    required: [
+        'transactionID'
+    ],
+    additionalProperties: false
+};
+export const transactionParams = {
+    type: 'object',
+    properties: {
+        transactionID: {
+            type: 'string'
+        }
+    },
+    required: [
+        'transactionID'
+    ],
+    additionalProperties: false
+};
+export const transactionResult = {
+    type: 'object',
+    properties: {
+        success: {
+            type: 'boolean'
+        },
+        // Populated when `success` is false and the failure carries a recoverable
+        // reason the caller can act on — currently access-denied surfaces from the
+        // commit-time apply. Generic handler failures still come back via the
+        // enkaku error-reply path with code `EK01`.
+        error: {
+            type: 'object',
+            properties: {
+                code: {
+                    type: 'string'
+                },
+                message: {
+                    type: 'string'
+                },
+                docID: {
+                    type: 'string'
+                }
+            },
+            required: [
+                'code',
+                'message'
+            ],
+            additionalProperties: false
+        }
+    },
+    required: [
+        'success'
+    ],
+    additionalProperties: false
+};
+export const graphProtocol = {
+    'graph/deploy': {
+        type: 'request',
+        param: deployGraphParams,
+        result: deployGraphResult
+    },
+    'graph/list': {
+        type: 'request',
+        result: listGraphResult
+    },
+    'graph/load': {
+        type: 'request',
+        param: loadGraphParams,
+        result: loadGraphResult
+    },
+    'graph/mutate': {
+        type: 'request',
+        param: mutateGraphParams,
+        result: executeGraphResult
+    },
+    'graph/query': {
+        type: 'request',
+        param: executeGraphParams,
+        result: executeGraphResult
+    },
+    'graph/subscribe': {
+        type: 'stream',
+        param: executeGraphParams,
+        receive: executeGraphResult,
+        result: {
+            anyOf: [
+                executeGraphResult,
+                {
+                    type: 'null'
+                }
+            ]
+        }
+    },
+    'graph/beginTransaction': {
+        type: 'request',
+        param: beginTransactionParams,
+        result: beginTransactionResult
+    },
+    'graph/commitTransaction': {
+        type: 'request',
+        param: transactionParams,
+        result: transactionResult
+    },
+    'graph/rollbackTransaction': {
+        type: 'request',
+        param: transactionParams,
+        result: transactionResult
+    }
+};

package/lib/types.d.ts

@@ -122,6 +122,28 @@ export type GroupedAggregateValue = {
     keys: Record<string, unknown>;
 } & AggregateValues;
 export type DocumentData = Record<string, unknown>;
+/**
+ * Document fields carried in signed document data and synced, but excluded from
+ * model-schema validation. Model schemas are normalized with
+ * `additionalProperties: false` and never declare these, so the apply path
+ * validates only model-declared fields and preserves reserved fields through
+ * patches unchanged.
+ */
+export declare const RESERVED_DOCUMENT_FIELDS: readonly ["accessPermissions"];
+export declare function isAccessLevel(value: unknown): value is AccessLevel;
+export declare function isValidAccessRule(value: unknown): boolean;
+/**
+ * True when `value` is a well-formed `accessPermissions` object: an object whose
+ * present `read`/`write` entries each carry a known `level` and, when present,
+ * `allowedDIDs`/`allowedCircles`/`allowedGroups` that are string arrays (or
+ * null). Unknown keys are ignored, mirroring the engine's tolerant parser.
+ *
+ * This is the shape contract for the reserved `accessPermissions` document
+ * field. It is enforced strictly when a mutation is minted (authoring time), so
+ * a producer bug is caught at signing rather than persisted as garbage that
+ * unguarded consumers (e.g. the SQL read predicate) could mis-read.
+ */
+export declare function isValidAccessPermissions(value: unknown): boolean;
 export type DocumentNode = {
     id: string;
     model: string;

package/lib/types.js

@@ -1 +1,45 @@
-export{};
+/**
+ * Document fields carried in signed document data and synced, but excluded from
+ * model-schema validation. Model schemas are normalized with
+ * `additionalProperties: false` and never declare these, so the apply path
+ * validates only model-declared fields and preserves reserved fields through
+ * patches unchanged.
+ */ export const RESERVED_DOCUMENT_FIELDS = [
+    'accessPermissions'
+];
+export function isAccessLevel(value) {
+    return value === 'only_owner' || value === 'anyone' || value === 'restricted';
+}
+function isStringArrayOrNull(value) {
+    return value == null || Array.isArray(value) && value.every((item)=>typeof item === 'string');
+}
+export function isValidAccessRule(value) {
+    if (value == null || typeof value !== 'object') {
+        return false;
+    }
+    const rule = value;
+    return isAccessLevel(rule.level) && isStringArrayOrNull(rule.allowedDIDs) && isStringArrayOrNull(rule.allowedCircles) && isStringArrayOrNull(rule.allowedGroups);
+}
+/**
+ * True when `value` is a well-formed `accessPermissions` object: an object whose
+ * present `read`/`write` entries each carry a known `level` and, when present,
+ * `allowedDIDs`/`allowedCircles`/`allowedGroups` that are string arrays (or
+ * null). Unknown keys are ignored, mirroring the engine's tolerant parser.
+ *
+ * This is the shape contract for the reserved `accessPermissions` document
+ * field. It is enforced strictly when a mutation is minted (authoring time), so
+ * a producer bug is caught at signing rather than persisted as garbage that
+ * unguarded consumers (e.g. the SQL read predicate) could mis-read.
+ */ export function isValidAccessPermissions(value) {
+    if (value == null || typeof value !== 'object') {
+        return false;
+    }
+    const perms = value;
+    if (perms.read !== undefined && !isValidAccessRule(perms.read)) {
+        return false;
+    }
+    if (perms.write !== undefined && !isValidAccessRule(perms.write)) {
+        return false;
+    }
+    return true;
+}

package/package.json

@@ -1,39 +1,39 @@
 {
   "name": "@kubun/protocol",
-  "version": "0.10.0",
-  "license": "see LICENSE.md",
+  "version": "0.12.0",
   "keywords": [],
+  "license": "see LICENSE.md",
+  "sideEffects": false,
   "type": "module",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
   "exports": {
     ".": "./lib/index.js"
   },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "files": [
     "lib/*",
     "LICENSE.md"
   ],
-  "sideEffects": false,
   "dependencies": {
-    "@enkaku/codec": "^0.16.0",
-    "@enkaku/protocol": "^0.16.0",
-    "@enkaku/schema": "^0.16.0",
+    "@enkaku/protocol": "^0.20.0",
+    "@sozai/codec": "^0.4.0",
+    "@sozai/schema": "^0.1.1",
     "change-case": "^5.4.4",
-    "@kubun/id": "^0.10.0",
-    "@kubun/logger": "^0.10.0"
+    "@kubun/id": "^0.12.0",
+    "@kubun/logger": "^0.12.0"
   },
   "devDependencies": {
-    "graphql": "^16.13.2",
+    "graphql": "^16.14.2",
     "json-schema-typed": "^8.0.2"
   },
   "scripts": {
+    "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
     "build:clean": "del lib",
-    "build:js": "swc src -d ./lib --config-file ../../swc.json --strip-leading-paths",
+    "build:js": "swc src -d ./lib --config-file ../../node_modules/@kigu/dev/swc.json --strip-leading-paths",
     "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
     "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
-    "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
+    "test": "pnpm run test:types && pnpm run test:unit",
     "test:types": "tsc --noEmit -p tsconfig.test.json",
-    "test:unit": "vitest run",
-    "test": "pnpm run test:types && pnpm run test:unit"
+    "test:unit": "vitest run"
   }
 }