@dxos/functions 0.5.3-main.59db342 → 0.5.3-main.61bbff4

package/src/types.ts

@@ -0,0 +1,101 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { AST, S, TypedObject } from '@dxos/echo-schema';
+
+// TODO(burdon): Factor out.
+const omitEchoId = <T>(schema: S.Schema<T>): S.Schema<Omit<T, 'id'>> => S.make(AST.omit(schema.ast, ['id']));
+
+/**
+ * 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';
+
+const SubscriptionTriggerSchema = S.struct({
+  type: S.literal('subscription'),
+  // TODO(burdon): Define query DSL.
+  filter: S.array(
+    S.struct({
+      type: S.string,
+      props: S.optional(S.record(S.string, S.any)),
+    }),
+  ),
+  options: S.optional(
+    S.struct({
+      // Watch changes to object (not just creation).
+      deep: S.optional(S.boolean),
+      // Debounce changes (delay in ms).
+      delay: S.optional(S.number),
+    }),
+  ),
+});
+export type SubscriptionTrigger = S.Schema.Type<typeof SubscriptionTriggerSchema>;
+
+const TimerTriggerSchema = S.struct({
+  type: S.literal('timer'),
+  cron: S.string,
+});
+export type TimerTrigger = S.Schema.Type<typeof TimerTriggerSchema>;
+
+const WebhookTriggerSchema = S.mutable(
+  S.struct({
+    type: S.literal('webhook'),
+    method: S.string,
+    // Assigned port.
+    port: S.optional(S.number),
+  }),
+);
+export type WebhookTrigger = S.Schema.Type<typeof WebhookTriggerSchema>;
+
+const WebsocketTriggerSchema = S.struct({
+  type: S.literal('websocket'),
+  url: S.string,
+  init: S.optional(S.record(S.string, S.any)),
+});
+export type WebsocketTrigger = S.Schema.Type<typeof WebsocketTriggerSchema>;
+
+const TriggerSpecSchema = S.union(
+  TimerTriggerSchema,
+  WebhookTriggerSchema,
+  WebsocketTriggerSchema,
+  SubscriptionTriggerSchema,
+);
+export type TriggerSpec = TimerTrigger | WebhookTrigger | WebsocketTrigger | SubscriptionTrigger;
+
+/**
+ * Function definition.
+ */
+export class FunctionDef extends TypedObject({
+  typename: 'dxos.org/type/FunctionDef',
+  version: '0.1.0',
+})({
+  uri: S.string,
+  description: S.optional(S.string),
+  route: S.string,
+  // TODO(burdon): NPM/GitHub/Docker/CF URL?
+  handler: S.string,
+}) {}
+
+export class FunctionTrigger extends TypedObject({
+  typename: 'dxos.org/type/FunctionTrigger',
+  version: '0.1.0',
+})({
+  function: S.string.pipe(S.description('Function ID/URI.')),
+  // Context passed to a function.
+  meta: S.optional(S.record(S.string, S.any)),
+  spec: TriggerSpecSchema,
+}) {}
+
+/**
+ * Function manifest file.
+ */
+export const FunctionManifestSchema = S.struct({
+  functions: S.optional(S.mutable(S.array(omitEchoId(FunctionDef)))),
+  triggers: S.optional(S.mutable(S.array(omitEchoId(FunctionTrigger)))),
+});
+
+export type FunctionManifest = S.Schema.Type<typeof FunctionManifestSchema>;

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

@@ -1,26 +0,0 @@
-export type FunctionDef = {
-    id: string;
-    name: string;
-    handler: string;
-    description?: string;
-};
-export type TriggerSubscription = {
-    type: string;
-    spaceKey: string;
-    props?: Record<string, any>;
-    deep?: boolean;
-    delay?: number;
-};
-export type FunctionTrigger = {
-    function: string;
-    schedule?: string;
-    subscriptions?: TriggerSubscription[];
-};
-/**
- * Function manifest file.
- */
-export type FunctionManifest = {
-    functions: FunctionDef[];
-    triggers: FunctionTrigger[];
-};
-//# sourceMappingURL=manifest.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../../src/manifest.ts"],"names":[],"mappings":"AAOA,MAAM,MAAM,WAAW,GAAG;IAExB,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAKF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,WAAW,EAAE,CAAC;IACzB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B,CAAC"}

package/src/manifest.ts

@@ -1,42 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-// Lambda-like function definitions.
-// See: https://www.serverless.com/framework/docs/providers/aws/guide/serverless.yml/#functions
-
-export type FunctionDef = {
-  // FQ function name.
-  id: string;
-  // URL path.
-  name: string;
-  // File path of handler.
-  handler: string;
-  description?: string;
-};
-
-// TODO(burdon): Query DSL.
-export type TriggerSubscription = {
-  type: string;
-  spaceKey: string;
-  props?: Record<string, any>;
-  deep?: boolean; // Watch changes to object (not just creation).
-  delay?: number;
-};
-
-// TODO(burdon): Generalize binding.
-// https://www.npmjs.com/package/aws-lambda
-// https://docs.aws.amazon.com/lambda/latest/dg/typescript-handler.html
-export type FunctionTrigger = {
-  function: string;
-  schedule?: string;
-  subscriptions?: TriggerSubscription[];
-};
-
-/**
- * Function manifest file.
- */
-export type FunctionManifest = {
-  functions: FunctionDef[];
-  triggers: FunctionTrigger[];
-};