@kubun/protocol 0.6.0 → 0.7.1

package/lib/errors.d.ts

@@ -0,0 +1,10 @@
+export declare const KubunErrorCodes: {
+    readonly KB01: "Validation error";
+    readonly KB02: "Not found";
+    readonly KB03: "Unauthorized";
+    readonly KB04: "Invalid operation";
+    readonly KB05: "Transaction error";
+    readonly KB06: "Internal error";
+    readonly KB07: "Access denied";
+};
+export type KubunErrorCode = keyof typeof KubunErrorCodes;

package/lib/errors.js

@@ -0,0 +1 @@
+export const KubunErrorCodes={KB01:"Validation error",KB02:"Not found",KB03:"Unauthorized",KB04:"Invalid operation",KB05:"Transaction error",KB06:"Internal error",KB07:"Access denied"};

package/lib/index.d.ts

@@ -1,11 +1,13 @@
 import type { AnyClientMessageOf, AnyServerMessageOf, ClientTransportOf, ServerTransportOf } from '@enkaku/protocol';
 import type { GraphProtocol } from './services/graph.js';
 import type { SyncProtocol } from './services/sync.js';
+export { type KubunErrorCode, KubunErrorCodes } from './errors.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 { KubunAttributeKeys, KubunSpanNames } from './semantic.js';
 export * from './services/graph.js';
 export * from './services/sync.js';
 export * from './types.js';

package/lib/index.js

@@ -1 +1 @@
-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*from"./services/sync.js";export*from"./types.js";
+export{KubunErrorCodes}from"./errors.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{KubunAttributeKeys,KubunSpanNames}from"./semantic.js";export*from"./services/graph.js";export*from"./services/sync.js";export*from"./types.js";

package/lib/semantic.d.ts

@@ -0,0 +1,23 @@
+export declare const KubunSpanNames: {
+    readonly GRAPH_QUERY: "kubun.graph.query";
+    readonly GRAPH_MUTATE: "kubun.graph.mutate";
+    readonly GRAPH_SUBSCRIBE: "kubun.graph.subscribe";
+    readonly GRAPH_DEPLOY: "kubun.graph.deploy";
+    readonly GRAPHQL_EXECUTE: "kubun.graphql.execute";
+    readonly DATA_QUERY: "kubun.data.query";
+    readonly DATA_MUTATE: "kubun.data.mutate";
+    readonly DATA_TRANSACTION: "kubun.data.transaction";
+};
+export declare const KubunAttributeKeys: {
+    readonly GRAPH_ID: "kubun.graph.id";
+    readonly GRAPHQL_OPERATION_TYPE: "graphql.operation.type";
+    readonly GRAPHQL_DOCUMENT: "graphql.document";
+    readonly GRAPHQL_VARIABLES: "graphql.variables";
+    readonly MODEL_ID: "kubun.model.id";
+    readonly DOCUMENT_ID: "kubun.document.id";
+    readonly DOCUMENTS_COUNT: "kubun.documents.count";
+    readonly MUTATION_TYPE: "kubun.mutation.type";
+    readonly MUTATION_DATA: "kubun.mutation.data";
+    readonly QUERY_FILTER: "kubun.query.filter";
+    readonly ERROR_CODE: "kubun.error.code";
+};

package/lib/semantic.js

@@ -0,0 +1 @@
+export const KubunSpanNames={GRAPH_QUERY:"kubun.graph.query",GRAPH_MUTATE:"kubun.graph.mutate",GRAPH_SUBSCRIBE:"kubun.graph.subscribe",GRAPH_DEPLOY:"kubun.graph.deploy",GRAPHQL_EXECUTE:"kubun.graphql.execute",DATA_QUERY:"kubun.data.query",DATA_MUTATE:"kubun.data.mutate",DATA_TRANSACTION:"kubun.data.transaction"};export const KubunAttributeKeys={GRAPH_ID:"kubun.graph.id",GRAPHQL_OPERATION_TYPE:"graphql.operation.type",GRAPHQL_DOCUMENT:"graphql.document",GRAPHQL_VARIABLES:"graphql.variables",MODEL_ID:"kubun.model.id",DOCUMENT_ID:"kubun.document.id",DOCUMENTS_COUNT:"kubun.documents.count",MUTATION_TYPE:"kubun.mutation.type",MUTATION_DATA:"kubun.mutation.data",QUERY_FILTER:"kubun.query.filter",ERROR_CODE:"kubun.error.code"};

package/lib/services/graph.d.ts

@@ -3566,6 +3566,9 @@ export declare const mutateGraphParams: {
                 readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
             };
         };
+        readonly transactionID: {
+            readonly type: "string";
+        };
         readonly id: {
             readonly type: "string";
         };
@@ -3580,6 +3583,50 @@ export declare const mutateGraphParams: {
     readonly additionalProperties: false;
 };
 export type MutateGraphParams = FromSchema<typeof mutateGraphParams>;
+export declare const beginTransactionParams: {
+    readonly type: "object";
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+        };
+    };
+    readonly required: readonly ["id"];
+    readonly additionalProperties: false;
+};
+export type BeginTransactionParams = FromSchema<typeof beginTransactionParams>;
+export declare const beginTransactionResult: {
+    readonly type: "object";
+    readonly properties: {
+        readonly transactionID: {
+            readonly type: "string";
+        };
+    };
+    readonly required: readonly ["transactionID"];
+    readonly additionalProperties: false;
+};
+export type BeginTransactionResult = FromSchema<typeof beginTransactionResult>;
+export declare const transactionParams: {
+    readonly type: "object";
+    readonly properties: {
+        readonly transactionID: {
+            readonly type: "string";
+        };
+    };
+    readonly required: readonly ["transactionID"];
+    readonly additionalProperties: false;
+};
+export type TransactionParams = FromSchema<typeof transactionParams>;
+export declare const transactionResult: {
+    readonly type: "object";
+    readonly properties: {
+        readonly success: {
+            readonly type: "boolean";
+        };
+    };
+    readonly required: readonly ["success"];
+    readonly additionalProperties: false;
+};
+export type TransactionResult = FromSchema<typeof transactionResult>;
 export declare const graphProtocol: {
     readonly 'graph/deploy': {
         readonly type: "request";
@@ -7016,6 +7063,9 @@ export declare const graphProtocol: {
                         readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
                     };
                 };
+                readonly transactionID: {
+                    readonly type: "string";
+                };
                 readonly id: {
                     readonly type: "string";
                 };
@@ -7288,5 +7338,74 @@ export declare const graphProtocol: {
             }];
         };
     };
+    readonly 'graph/beginTransaction': {
+        readonly type: "request";
+        readonly param: {
+            readonly type: "object";
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+            };
+            readonly required: readonly ["id"];
+            readonly additionalProperties: false;
+        };
+        readonly result: {
+            readonly type: "object";
+            readonly properties: {
+                readonly transactionID: {
+                    readonly type: "string";
+                };
+            };
+            readonly required: readonly ["transactionID"];
+            readonly additionalProperties: false;
+        };
+    };
+    readonly 'graph/commitTransaction': {
+        readonly type: "request";
+        readonly param: {
+            readonly type: "object";
+            readonly properties: {
+                readonly transactionID: {
+                    readonly type: "string";
+                };
+            };
+            readonly required: readonly ["transactionID"];
+            readonly additionalProperties: false;
+        };
+        readonly result: {
+            readonly type: "object";
+            readonly properties: {
+                readonly success: {
+                    readonly type: "boolean";
+                };
+            };
+            readonly required: readonly ["success"];
+            readonly additionalProperties: false;
+        };
+    };
+    readonly 'graph/rollbackTransaction': {
+        readonly type: "request";
+        readonly param: {
+            readonly type: "object";
+            readonly properties: {
+                readonly transactionID: {
+                    readonly type: "string";
+                };
+            };
+            readonly required: readonly ["transactionID"];
+            readonly additionalProperties: false;
+        };
+        readonly result: {
+            readonly type: "object";
+            readonly properties: {
+                readonly success: {
+                    readonly type: "boolean";
+                };
+            };
+            readonly required: readonly ["success"];
+            readonly additionalProperties: false;
+        };
+    };
 };
 export type GraphProtocol = typeof graphProtocol;

package/lib/services/graph.js

@@ -1 +1 @@
-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"},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"}}},required:["record","aliases"],additionalProperties:!1};export const executeGraphParams={type:"object",properties:{id:{type:"string"},text:{type:"string"},variables:{type:"object"}},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}},required:[...executeGraphParams.required,"mutations"],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"}]}}};
+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"},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"}}},required:["record","aliases"],additionalProperties:!1};export const executeGraphParams={type:"object",properties:{id:{type:"string"},text:{type:"string"},variables:{type:"object"}},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"}},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}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/protocol",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "license": "see LICENSE.md",
   "keywords": [],
   "type": "module",
@@ -15,12 +15,12 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@enkaku/codec": "^0.13.0",
-    "@enkaku/protocol": "^0.13.0",
-    "@enkaku/schema": "^0.13.0",
+    "@enkaku/codec": "^0.14.0",
+    "@enkaku/protocol": "^0.14.0",
+    "@enkaku/schema": "^0.14.0",
     "change-case": "^5.4.4",
-    "@kubun/id": "^0.6.0",
-    "@kubun/logger": "^0.6.0"
+    "@kubun/id": "^0.7.0",
+    "@kubun/logger": "^0.7.0"
   },
   "devDependencies": {
     "json-schema-typed": "^8.0.2"