@dxos/functions 0.5.3-main.6e12b97 → 0.5.3-main.6f2dfea

package/dist/types/src/types.d.ts

@@ -1,13 +1,21 @@
-import { S } from '@dxos/echo-schema';
-/**
- * Type discriminator for TriggerSpec.
- * Every spec has a type field of type FunctionTriggerType that we can use to understand which
- * type we're working with.
- * https://www.typescriptlang.org/docs/handbook/2/narrowing.html#discriminated-unions
- */
-export type FunctionTriggerType = 'subscription' | 'timer' | 'webhook' | 'websocket';
+import * as S from '@effect/schema/Schema';
+declare const TimerTriggerSchema: S.struct<{
+    cron: S.$string;
+}>;
+declare const WebhookTriggerSchema: S.mutable<S.struct<{
+    method: S.$string;
+    port: S.PropertySignature<"?:", number | undefined, never, "?:", number | undefined, never>;
+}>>;
+declare const WebsocketTriggerSchema: S.struct<{
+    url: S.$string;
+    init: S.PropertySignature<"?:", {
+        readonly [x: string]: any;
+    } | undefined, never, "?:", {
+        readonly [x: string]: any;
+    } | undefined, never>;
+}>;
 declare const SubscriptionTriggerSchema: S.struct<{
-    type: S.literal<["subscription"]>;
+    spaceKey: S.PropertySignature<"?:", string | undefined, never, "?:", string | undefined, never>;
     filter: S.array<S.struct<{
         type: S.$string;
         props: S.PropertySignature<"?:", {
@@ -24,164 +32,150 @@ declare const SubscriptionTriggerSchema: S.struct<{
         readonly delay?: number | undefined;
     } | undefined, never>;
 }>;
-export type SubscriptionTrigger = S.Schema.Type<typeof SubscriptionTriggerSchema>;
-declare const TimerTriggerSchema: S.struct<{
-    type: S.literal<["timer"]>;
-    cron: S.$string;
-}>;
-export type TimerTrigger = S.Schema.Type<typeof TimerTriggerSchema>;
-declare const WebhookTriggerSchema: S.mutable<S.struct<{
-    type: S.literal<["webhook"]>;
-    method: S.$string;
-    port: S.PropertySignature<"?:", number | undefined, never, "?:", number | undefined, never>;
-}>>;
-export type WebhookTrigger = S.Schema.Type<typeof WebhookTriggerSchema>;
-declare const WebsocketTriggerSchema: S.struct<{
-    type: S.literal<["websocket"]>;
-    url: S.$string;
-    init: S.PropertySignature<"?:", {
+declare const FunctionTriggerSchema: S.struct<{
+    function: S.$string;
+    context: S.PropertySignature<"?:", {
         readonly [x: string]: any;
     } | undefined, never, "?:", {
         readonly [x: string]: any;
     } | undefined, never>;
-}>;
-export type WebsocketTrigger = S.Schema.Type<typeof WebsocketTriggerSchema>;
-export type TriggerSpec = TimerTrigger | WebhookTrigger | WebsocketTrigger | SubscriptionTrigger;
-declare const FunctionDef_base: import("@dxos/echo-schema").EchoSchemaClass<{
-    handler: string;
-    uri: string;
-    description?: string | undefined;
-    route: string;
-} & {
-    id: string;
-}>;
-/**
- * Function definition.
- */
-export declare class FunctionDef extends FunctionDef_base {
-}
-declare const FunctionTrigger_base: import("@dxos/echo-schema").EchoSchemaClass<{
-    function: string;
-    meta?: {
-        readonly [x: string]: any;
-    } | undefined;
-    spec: {
+    timer: S.PropertySignature<"?:", {
+        readonly cron: string;
+    } | undefined, never, "?:", {
+        readonly cron: string;
+    } | undefined, never>;
+    webhook: S.PropertySignature<"?:", {
+        port?: number | undefined;
+        method: string;
+    } | undefined, never, "?:", {
+        method: string;
+        port?: number | undefined;
+    } | undefined, never>;
+    websocket: S.PropertySignature<"?:", {
+        readonly url: string;
+        readonly init?: {
+            readonly [x: string]: any;
+        } | undefined;
+    } | undefined, never, "?:", {
+        readonly url: string;
+        readonly init?: {
+            readonly [x: string]: any;
+        } | undefined;
+    } | undefined, never>;
+    subscription: S.PropertySignature<"?:", {
         readonly filter: readonly {
             readonly type: string;
             readonly props?: {
                 readonly [x: string]: any;
             } | undefined;
         }[];
-        readonly type: "subscription";
+        readonly spaceKey?: string | undefined;
         readonly options?: {
             readonly deep?: boolean | undefined;
             readonly delay?: number | undefined;
         } | undefined;
-    } | {
-        readonly type: "timer";
-        readonly cron: string;
-    } | {
-        port?: number | undefined;
-        type: "webhook";
-        method: string;
-    } | {
-        readonly type: "websocket";
-        readonly url: string;
-        readonly init?: {
-            readonly [x: string]: any;
+    } | undefined, never, "?:", {
+        readonly filter: readonly {
+            readonly type: string;
+            readonly props?: {
+                readonly [x: string]: any;
+            } | undefined;
+        }[];
+        readonly spaceKey?: string | undefined;
+        readonly options?: {
+            readonly deep?: boolean | undefined;
+            readonly delay?: number | undefined;
         } | undefined;
-    };
-} & {
-    id: string;
+    } | undefined, never>;
+}>;
+export type TimerTrigger = S.Schema.Type<typeof TimerTriggerSchema>;
+export type WebhookTrigger = S.Schema.Type<typeof WebhookTriggerSchema>;
+export type WebsocketTrigger = S.Schema.Type<typeof WebsocketTriggerSchema>;
+export type SubscriptionTrigger = S.Schema.Type<typeof SubscriptionTriggerSchema>;
+export type FunctionTrigger = S.Schema.Type<typeof FunctionTriggerSchema>;
+/**
+ * Function definition.
+ */
+declare const FunctionDefSchema: S.struct<{
+    id: S.$string;
+    description: S.PropertySignature<"?:", string | undefined, never, "?:", string | undefined, never>;
+    path: S.$string;
+    handler: S.$string;
 }>;
-export declare class FunctionTrigger extends FunctionTrigger_base {
-}
+export type FunctionDef = S.Schema.Type<typeof FunctionDefSchema>;
 /**
  * Function manifest file.
  */
 export declare const FunctionManifestSchema: S.struct<{
-    functions: S.PropertySignature<"?:", Omit<{
-        handler: string;
-        uri: string;
-        description?: string | undefined;
-        route: string;
-    } & {
-        id: string;
-    }, "id">[] | undefined, never, "?:", Omit<{
-        handler: string;
-        uri: string;
-        description?: string | undefined;
-        route: string;
-    } & {
-        id: string;
-    }, "id">[] | undefined, never>;
-    triggers: S.PropertySignature<"?:", Omit<{
-        function: string;
-        meta?: {
+    functions: S.mutable<S.array<S.struct<{
+        id: S.$string;
+        description: S.PropertySignature<"?:", string | undefined, never, "?:", string | undefined, never>;
+        path: S.$string;
+        handler: S.$string;
+    }>>>;
+    triggers: S.PropertySignature<"?:", {
+        readonly function: string;
+        readonly context?: {
             readonly [x: string]: any;
         } | undefined;
-        spec: {
+        readonly timer?: {
+            readonly cron: string;
+        } | undefined;
+        readonly webhook?: {
+            port?: number | undefined;
+            method: string;
+        } | undefined;
+        readonly websocket?: {
+            readonly url: string;
+            readonly init?: {
+                readonly [x: string]: any;
+            } | undefined;
+        } | undefined;
+        readonly subscription?: {
             readonly filter: readonly {
                 readonly type: string;
                 readonly props?: {
                     readonly [x: string]: any;
                 } | undefined;
             }[];
-            readonly type: "subscription";
+            readonly spaceKey?: string | undefined;
             readonly options?: {
                 readonly deep?: boolean | undefined;
                 readonly delay?: number | undefined;
             } | undefined;
-        } | {
-            readonly type: "timer";
+        } | undefined;
+    }[] | undefined, never, "?:", {
+        readonly function: string;
+        readonly context?: {
+            readonly [x: string]: any;
+        } | undefined;
+        readonly timer?: {
             readonly cron: string;
-        } | {
-            port?: number | undefined;
-            type: "webhook";
+        } | undefined;
+        readonly webhook?: {
             method: string;
-        } | {
-            readonly type: "websocket";
+            port?: number | undefined;
+        } | undefined;
+        readonly websocket?: {
             readonly url: string;
             readonly init?: {
                 readonly [x: string]: any;
             } | undefined;
-        };
-    } & {
-        id: string;
-    }, "id">[] | undefined, never, "?:", Omit<{
-        function: string;
-        meta?: {
-            readonly [x: string]: any;
         } | undefined;
-        spec: {
+        readonly subscription?: {
             readonly filter: readonly {
                 readonly type: string;
                 readonly props?: {
                     readonly [x: string]: any;
                 } | undefined;
             }[];
-            readonly type: "subscription";
+            readonly spaceKey?: string | undefined;
             readonly options?: {
                 readonly deep?: boolean | undefined;
                 readonly delay?: number | undefined;
             } | undefined;
-        } | {
-            readonly type: "timer";
-            readonly cron: string;
-        } | {
-            port?: number | undefined;
-            type: "webhook";
-            method: string;
-        } | {
-            readonly type: "websocket";
-            readonly url: string;
-            readonly init?: {
-                readonly [x: string]: any;
-            } | undefined;
-        };
-    } & {
-        id: string;
-    }, "id">[] | undefined, never>;
+        } | undefined;
+    }[] | undefined, never>;
 }>;
 export type FunctionManifest = S.Schema.Type<typeof FunctionManifestSchema>;
 export {};

package/dist/types/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAO,CAAC,EAAe,MAAM,mBAAmB,CAAC;AAKxD;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;AAErF,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;EAiB7B,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAElF,QAAA,MAAM,kBAAkB;;;EAGtB,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEpE,QAAA,MAAM,oBAAoB;;;;GAOzB,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAExE,QAAA,MAAM,sBAAsB;;;;;;;;EAI1B,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAQ5E,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,gBAAgB,GAAG,mBAAmB,CAAC;;;;;;;;;AAEjG;;GAEG;AACH,qBAAa,WAAY,SAAQ,gBAS/B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL,qBAAa,eAAgB,SAAQ,oBAQnC;CAAG;AAEL;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,uBAAuB,CAAC;AAE3C,QAAA,MAAM,kBAAkB;;EAEtB,CAAC;AAEH,QAAA,MAAM,oBAAoB;;;GAMzB,CAAC;AAEF,QAAA,MAAM,sBAAsB;;;;;;;EAG1B,CAAC;AAEH,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;EAiB7B,CAAC;AAEH,QAAA,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWzB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAAC;AACpE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,oBAAoB,CAAC,CAAC;AACxE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAC5E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAClF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE1E;;GAEG;AAEH,QAAA,MAAM,iBAAiB;;;;;EAOrB,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAElE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/functions",
-  "version": "0.5.3-main.6e12b97",
+  "version": "0.5.3-main.6f2dfea",
   "description": "Functions SDK and runtime.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -20,35 +20,32 @@
     "src"
   ],
   "dependencies": {
+    "@effect/schema": "^0.64.20",
     "@preact/signals-core": "^1.6.0",
     "cron": "^3.1.6",
     "effect": "^2.4.19",
     "express": "^4.19.2",
     "get-port-please": "^3.1.1",
     "ws": "^8.14.2",
-    "@braneframe/types": "0.5.3-main.6e12b97",
-    "@dxos/async": "0.5.3-main.6e12b97",
-    "@dxos/client": "0.5.3-main.6e12b97",
-    "@dxos/context": "0.5.3-main.6e12b97",
-    "@dxos/echo-db": "0.5.3-main.6e12b97",
-    "@dxos/echo-schema": "0.5.3-main.6e12b97",
-    "@dxos/keys": "0.5.3-main.6e12b97",
-    "@dxos/invariant": "0.5.3-main.6e12b97",
-    "@dxos/node-std": "0.5.3-main.6e12b97",
-    "@dxos/log": "0.5.3-main.6e12b97",
-    "@dxos/protocols": "0.5.3-main.6e12b97",
-    "@dxos/util": "0.5.3-main.6e12b97"
+    "@braneframe/types": "0.5.3-main.6f2dfea",
+    "@dxos/context": "0.5.3-main.6f2dfea",
+    "@dxos/async": "0.5.3-main.6f2dfea",
+    "@dxos/client": "0.5.3-main.6f2dfea",
+    "@dxos/log": "0.5.3-main.6f2dfea",
+    "@dxos/node-std": "0.5.3-main.6f2dfea",
+    "@dxos/invariant": "0.5.3-main.6f2dfea",
+    "@dxos/echo-schema": "0.5.3-main.6f2dfea",
+    "@dxos/util": "0.5.3-main.6f2dfea"
   },
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/ws": "^7.4.0",
-    "@dxos/agent": "0.5.3-main.6e12b97"
+    "@dxos/agent": "0.5.3-main.6f2dfea"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "gen-schema": "ts-node ./tools/schema.ts",
-    "prebuild": "pnpm gen-schema"
+    "gen-schema": "ts-node ./tools/schema.ts"
   }
 }

package/schema/functions.json

@@ -1,24 +1,26 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [],
+  "required": [
+    "functions"
+  ],
   "properties": {
     "functions": {
       "type": "array",
       "items": {
         "type": "object",
         "required": [
-          "uri",
-          "route",
+          "id",
+          "path",
           "handler"
         ],
         "properties": {
-          "uri": {
+          "id": {
             "type": "string",
             "description": "a string",
             "title": "string"
           },
-          "route": {
+          "path": {
             "type": "string",
             "description": "a string",
             "title": "string"
@@ -42,8 +44,7 @@
       "items": {
         "type": "object",
         "required": [
-          "function",
-          "spec"
+          "function"
         ],
         "properties": {
           "function": {
@@ -51,7 +52,7 @@
             "description": "Function ID/URI.",
             "title": "string"
           },
-          "meta": {
+          "context": {
             "type": "object",
             "required": [],
             "properties": {},
@@ -60,133 +61,113 @@
               "title": "any"
             }
           },
-          "spec": {
-            "anyOf": [
-              {
+          "timer": {
+            "type": "object",
+            "required": [
+              "cron"
+            ],
+            "properties": {
+              "cron": {
+                "type": "string",
+                "description": "a string",
+                "title": "string"
+              }
+            },
+            "additionalProperties": false
+          },
+          "webhook": {
+            "type": "object",
+            "required": [
+              "port"
+            ],
+            "properties": {
+              "port": {
+                "type": "number",
+                "description": "a number",
+                "title": "number"
+              }
+            },
+            "additionalProperties": false
+          },
+          "websocket": {
+            "type": "object",
+            "required": [
+              "url"
+            ],
+            "properties": {
+              "url": {
+                "type": "string",
+                "description": "a string",
+                "title": "string"
+              },
+              "init": {
                 "type": "object",
-                "required": [
-                  "type",
-                  "cron"
-                ],
-                "properties": {
-                  "type": {
-                    "const": "timer"
+                "required": [],
+                "properties": {},
+                "additionalProperties": {
+                  "$id": "/schemas/any",
+                  "title": "any"
+                }
+              }
+            },
+            "additionalProperties": false
+          },
+          "subscription": {
+            "type": "object",
+            "required": [
+              "filter"
+            ],
+            "properties": {
+              "spaceKey": {
+                "type": "string",
+                "description": "a string",
+                "title": "string"
+              },
+              "filter": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "required": [
+                    "type"
+                  ],
+                  "properties": {
+                    "type": {
+                      "type": "string",
+                      "description": "a string",
+                      "title": "string"
+                    },
+                    "props": {
+                      "type": "object",
+                      "required": [],
+                      "properties": {},
+                      "additionalProperties": {
+                        "$id": "/schemas/any",
+                        "title": "any"
+                      }
+                    }
                   },
-                  "cron": {
-                    "type": "string",
-                    "description": "a string",
-                    "title": "string"
-                  }
-                },
-                "additionalProperties": false
+                  "additionalProperties": false
+                }
               },
-              {
+              "options": {
                 "type": "object",
-                "required": [
-                  "type",
-                  "method"
-                ],
+                "required": [],
                 "properties": {
-                  "type": {
-                    "const": "webhook"
-                  },
-                  "method": {
-                    "type": "string",
-                    "description": "a string",
-                    "title": "string"
+                  "deep": {
+                    "type": "boolean",
+                    "description": "a boolean",
+                    "title": "boolean"
                   },
-                  "port": {
+                  "delay": {
                     "type": "number",
                     "description": "a number",
                     "title": "number"
                   }
                 },
                 "additionalProperties": false
-              },
-              {
-                "type": "object",
-                "required": [
-                  "type",
-                  "url"
-                ],
-                "properties": {
-                  "type": {
-                    "const": "websocket"
-                  },
-                  "url": {
-                    "type": "string",
-                    "description": "a string",
-                    "title": "string"
-                  },
-                  "init": {
-                    "type": "object",
-                    "required": [],
-                    "properties": {},
-                    "additionalProperties": {
-                      "$id": "/schemas/any",
-                      "title": "any"
-                    }
-                  }
-                },
-                "additionalProperties": false
-              },
-              {
-                "type": "object",
-                "required": [
-                  "type",
-                  "filter"
-                ],
-                "properties": {
-                  "type": {
-                    "const": "subscription"
-                  },
-                  "filter": {
-                    "type": "array",
-                    "items": {
-                      "type": "object",
-                      "required": [
-                        "type"
-                      ],
-                      "properties": {
-                        "type": {
-                          "type": "string",
-                          "description": "a string",
-                          "title": "string"
-                        },
-                        "props": {
-                          "type": "object",
-                          "required": [],
-                          "properties": {},
-                          "additionalProperties": {
-                            "$id": "/schemas/any",
-                            "title": "any"
-                          }
-                        }
-                      },
-                      "additionalProperties": false
-                    }
-                  },
-                  "options": {
-                    "type": "object",
-                    "required": [],
-                    "properties": {
-                      "deep": {
-                        "type": "boolean",
-                        "description": "a boolean",
-                        "title": "boolean"
-                      },
-                      "delay": {
-                        "type": "number",
-                        "description": "a number",
-                        "title": "number"
-                      }
-                    },
-                    "additionalProperties": false
-                  }
-                },
-                "additionalProperties": false
               }
-            ]
+            },
+            "additionalProperties": false
           }
         },
         "additionalProperties": false