@kubun/protocol 0.8.1 → 0.10.0

package/lib/services/graph.d.ts

@@ -3638,6 +3638,22 @@ export declare const transactionResult: {
         readonly success: {
             readonly type: "boolean";
         };
+        readonly error: {
+            readonly type: "object";
+            readonly properties: {
+                readonly code: {
+                    readonly type: "string";
+                };
+                readonly message: {
+                    readonly type: "string";
+                };
+                readonly docID: {
+                    readonly type: "string";
+                };
+            };
+            readonly required: readonly ["code", "message"];
+            readonly additionalProperties: false;
+        };
     };
     readonly required: readonly ["success"];
     readonly additionalProperties: false;
@@ -7414,6 +7430,22 @@ export declare const graphProtocol: {
                 readonly success: {
                     readonly type: "boolean";
                 };
+                readonly error: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly code: {
+                            readonly type: "string";
+                        };
+                        readonly message: {
+                            readonly type: "string";
+                        };
+                        readonly docID: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly required: readonly ["code", "message"];
+                    readonly additionalProperties: false;
+                };
             };
             readonly required: readonly ["success"];
             readonly additionalProperties: false;
@@ -7437,6 +7469,22 @@ export declare const graphProtocol: {
                 readonly success: {
                     readonly type: "boolean";
                 };
+                readonly error: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly code: {
+                            readonly type: "string";
+                        };
+                        readonly message: {
+                            readonly type: "string";
+                        };
+                        readonly docID: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly required: readonly ["code", "message"];
+                    readonly additionalProperties: false;
+                };
             };
             readonly required: readonly ["success"];
             readonly additionalProperties: false;

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"},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"}},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 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}};

package/lib/types.d.ts

@@ -51,6 +51,76 @@ export type OrderByField = {
     [field: string]: OrderByDirection | OrderByField;
 };
 export type DocumentOrderBy = Array<OrderByField>;
+export type AggregateOp = 'sum' | 'average' | 'min' | 'max';
+export type AggregateSpec = {
+    op: AggregateOp;
+    keys: Array<string>;
+    numeric: boolean;
+};
+export type AccessLevel = 'only_owner' | 'anyone' | 'restricted';
+export type ViewerReadAccess = {
+    viewerDID: string;
+    groupIDs: Array<string>;
+    circleIDs: Array<string>;
+    serverDefault: AccessLevel;
+};
+export type AggregateDocumentsParams = {
+    modelIDs: Array<string>;
+    filter?: DocumentFilter;
+    owner?: string;
+    catalogID?: string;
+    readAccess?: ViewerReadAccess;
+    count: boolean;
+    aggregates: Array<AggregateSpec>;
+};
+export type AggregateValues = {
+    count?: number;
+    sum?: Record<string, number | null>;
+    average?: Record<string, number | null>;
+    min?: Record<string, unknown>;
+    max?: Record<string, unknown>;
+};
+export type AggregateHavingComparison = {
+    isNull?: boolean;
+    equalTo?: number | string;
+    notEqualTo?: number | string;
+    in?: Array<unknown>;
+    notIn?: Array<unknown>;
+    greaterThan?: number | string;
+    greaterThanOrEqualTo?: number | string;
+    lessThan?: number | string;
+    lessThanOrEqualTo?: number | string;
+};
+export type AggregateHaving = {
+    count?: AggregateHavingComparison;
+    sum?: Record<string, AggregateHavingComparison>;
+    average?: Record<string, AggregateHavingComparison>;
+    min?: Record<string, AggregateHavingComparison>;
+    max?: Record<string, AggregateHavingComparison>;
+};
+export type GroupedAggregateDocumentsParams = {
+    modelIDs: Array<string>;
+    filter?: DocumentFilter;
+    owner?: string;
+    catalogID?: string;
+    readAccess?: ViewerReadAccess;
+    count: boolean;
+    aggregates: Array<AggregateSpec>;
+    groupBy: Array<{
+        keys: Array<string>;
+    }>;
+    having?: AggregateHaving;
+    orderBy?: Array<GroupedAggregateOrderTerm>;
+    limit?: number;
+};
+export type GroupedAggregateOrderTerm = {
+    path: Array<string>;
+    direction: OrderByDirection;
+    numeric: boolean;
+};
+export type GroupedAggregateValue = {
+    keys: Record<string, unknown>;
+} & AggregateValues;
 export type DocumentData = Record<string, unknown>;
 export type DocumentNode = {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/protocol",
-  "version": "0.8.1",
+  "version": "0.10.0",
   "license": "see LICENSE.md",
   "keywords": [],
   "type": "module",
@@ -15,12 +15,12 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@enkaku/codec": "^0.14.0",
-    "@enkaku/protocol": "^0.14.0",
-    "@enkaku/schema": "^0.14.0",
+    "@enkaku/codec": "^0.16.0",
+    "@enkaku/protocol": "^0.16.0",
+    "@enkaku/schema": "^0.16.0",
     "change-case": "^5.4.4",
-    "@kubun/id": "^0.8.0",
-    "@kubun/logger": "^0.8.0"
+    "@kubun/id": "^0.10.0",
+    "@kubun/logger": "^0.10.0"
   },
   "devDependencies": {
     "graphql": "^16.13.2",