@dxos/functions 0.7.1-staging.8709ba7 → 0.7.2-main.f1adc9f

package/dist/lib/node-esm/chunk-YSKH6PBN.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { AST, RawObject, S, TypedObject } from '@dxos/echo-schema';\n\n/**\n * Type discriminator for TriggerType.\n * Every spec has a type field of type TriggerKind that we can use to understand which type we're working with.\n * https://www.typescriptlang.org/docs/handbook/2/narrowing.html#discriminated-unions\n */\nexport type TriggerKind = 'timer' | 'webhook' | 'websocket' | 'subscription';\n\n// TODO(burdon): Rename prop kind.\nconst typeLiteralAnnotations = { [AST.TitleAnnotationId]: 'Type' };\n\n/**\n * Cron timer.\n */\nconst TimerTriggerSchema = S.Struct({\n  type: S.Literal('timer').annotations(typeLiteralAnnotations),\n  cron: S.NonEmptyString.annotations({\n    [AST.TitleAnnotationId]: 'Cron',\n    [AST.ExamplesAnnotationId]: '0 0 * * *',\n  }),\n}).pipe(S.mutable);\n\nexport type TimerTrigger = S.Schema.Type<typeof TimerTriggerSchema>;\n\n/**\n * Webhook.\n */\nconst WebhookTriggerSchema = S.Struct({\n  type: S.Literal('webhook').annotations(typeLiteralAnnotations),\n  method: S.String,\n  // Assigned port.\n  port: S.optional(S.Number),\n}).pipe(S.mutable);\n\nexport type WebhookTrigger = S.Schema.Type<typeof WebhookTriggerSchema>;\n\n/**\n * Websocket.\n * @deprecated\n */\nconst WebsocketTriggerSchema = S.Struct({\n  type: S.Literal('websocket').annotations(typeLiteralAnnotations),\n  url: S.String,\n  init: S.optional(S.Record({ key: S.String, value: S.Any })),\n}).pipe(S.mutable);\n\nexport type WebsocketTrigger = S.Schema.Type<typeof WebsocketTriggerSchema>;\n\n// TODO(burdon): Use ECHO definition (from https://github.com/dxos/dxos/pull/8233).\nconst QuerySchema = S.Struct({\n  type: S.optional(S.String.annotations({ [AST.TitleAnnotationId]: 'Type' })),\n  props: S.optional(S.Record({ key: S.String, value: S.Any })),\n}).annotations({ [AST.TitleAnnotationId]: 'Query' });\n\n/**\n * Subscription.\n */\nconst SubscriptionTriggerSchema = S.Struct({\n  type: S.Literal('subscription').annotations(typeLiteralAnnotations),\n  // TODO(burdon): Define query DSL (from ECHO). Reconcile with Table.Query.\n  filter: QuerySchema,\n  options: S.optional(\n    S.Struct({\n      // Watch changes to object (not just creation).\n      deep: S.optional(S.Boolean.annotations({ [AST.TitleAnnotationId]: 'Nested' })),\n      // Debounce changes (delay in ms).\n      delay: S.optional(S.Number.annotations({ [AST.TitleAnnotationId]: 'Delay' })),\n    }).annotations({ [AST.TitleAnnotationId]: 'Options' }),\n  ),\n}).pipe(S.mutable);\n\nexport type SubscriptionTrigger = S.Schema.Type<typeof SubscriptionTriggerSchema>;\n\n/**\n * Trigger schema (discriminated union).\n */\nexport const TriggerSchema = S.Union(\n  TimerTriggerSchema,\n  WebhookTriggerSchema,\n  WebsocketTriggerSchema,\n  SubscriptionTriggerSchema,\n).annotations({ [AST.TitleAnnotationId]: 'Trigger' });\n\nexport type TriggerType = S.Schema.Type<typeof TriggerSchema>;\n\n/**\n * Function trigger.\n */\nexport const FunctionTriggerSchema = S.Struct({\n  // TODO(burdon): What type does this reference.\n  function: S.optional(S.String.annotations({ [AST.TitleAnnotationId]: 'Function' })),\n  enabled: S.optional(S.Boolean.annotations({ [AST.TitleAnnotationId]: 'Enabled' })),\n\n  // TODO(burdon): Flatten?\n  spec: S.optional(TriggerSchema),\n\n  // TODO(burdon): Get meta from function.\n  // The `meta` property is merged into the event data passed to the function.\n  meta: S.optional(S.mutable(S.Record({ key: S.String, value: S.Any }))),\n});\n\nexport type FunctionTriggerType = S.Schema.Type<typeof FunctionTriggerSchema>;\n\n/**\n * Function trigger.\n */\nexport class FunctionTrigger extends TypedObject({\n  typename: 'dxos.org/type/FunctionTrigger',\n  version: '0.1.0',\n})(FunctionTriggerSchema.fields) {}\n\n/**\n * Function definition.\n * @deprecated (Use dxos.org/type/Function)\n */\n// TODO(burdon): Reconcile with FunctionType.\nexport class FunctionDef extends TypedObject({\n  typename: 'dxos.org/type/FunctionDef',\n  version: '0.1.0',\n})({\n  uri: S.String,\n  description: S.optional(S.String),\n  route: S.String,\n  handler: S.String,\n}) {}\n\n/**\n * Function manifest file.\n */\nexport const FunctionManifestSchema = S.Struct({\n  functions: S.optional(S.mutable(S.Array(RawObject(FunctionDef)))),\n  triggers: S.optional(S.mutable(S.Array(RawObject(FunctionTrigger)))),\n});\n\nexport type FunctionManifest = S.Schema.Type<typeof FunctionManifestSchema>;\n\nexport const FUNCTION_TYPES = [FunctionDef, FunctionTrigger];\n"],
-  "mappings": ";;;;;;;;;AAIA,SAASA,KAAKC,WAAWC,GAAGC,mBAAmB;AAU/C,IAAMC,yBAAyB;EAAE,CAACC,IAAIC,iBAAiB,GAAG;AAAO;AAKjE,IAAMC,qBAAqBC,EAAEC,OAAO;EAClCC,MAAMF,EAAEG,QAAQ,OAAA,EAASC,YAAYR,sBAAAA;EACrCS,MAAML,EAAEM,eAAeF,YAAY;IACjC,CAACP,IAAIC,iBAAiB,GAAG;IACzB,CAACD,IAAIU,oBAAoB,GAAG;EAC9B,CAAA;AACF,CAAA,EAAGC,KAAKR,EAAES,OAAO;AAOjB,IAAMC,uBAAuBV,EAAEC,OAAO;EACpCC,MAAMF,EAAEG,QAAQ,SAAA,EAAWC,YAAYR,sBAAAA;EACvCe,QAAQX,EAAEY;;EAEVC,MAAMb,EAAEc,SAASd,EAAEe,MAAM;AAC3B,CAAA,EAAGP,KAAKR,EAAES,OAAO;AAQjB,IAAMO,yBAAyBhB,EAAEC,OAAO;EACtCC,MAAMF,EAAEG,QAAQ,WAAA,EAAaC,YAAYR,sBAAAA;EACzCqB,KAAKjB,EAAEY;EACPM,MAAMlB,EAAEc,SAASd,EAAEmB,OAAO;IAAEC,KAAKpB,EAAEY;IAAQS,OAAOrB,EAAEsB;EAAI,CAAA,CAAA;AAC1D,CAAA,EAAGd,KAAKR,EAAES,OAAO;AAKjB,IAAMc,cAAcvB,EAAEC,OAAO;EAC3BC,MAAMF,EAAEc,SAASd,EAAEY,OAAOR,YAAY;IAAE,CAACP,IAAIC,iBAAiB,GAAG;EAAO,CAAA,CAAA;EACxE0B,OAAOxB,EAAEc,SAASd,EAAEmB,OAAO;IAAEC,KAAKpB,EAAEY;IAAQS,OAAOrB,EAAEsB;EAAI,CAAA,CAAA;AAC3D,CAAA,EAAGlB,YAAY;EAAE,CAACP,IAAIC,iBAAiB,GAAG;AAAQ,CAAA;AAKlD,IAAM2B,4BAA4BzB,EAAEC,OAAO;EACzCC,MAAMF,EAAEG,QAAQ,cAAA,EAAgBC,YAAYR,sBAAAA;;EAE5C8B,QAAQH;EACRI,SAAS3B,EAAEc,SACTd,EAAEC,OAAO;;IAEP2B,MAAM5B,EAAEc,SAASd,EAAE6B,QAAQzB,YAAY;MAAE,CAACP,IAAIC,iBAAiB,GAAG;IAAS,CAAA,CAAA;;IAE3EgC,OAAO9B,EAAEc,SAASd,EAAEe,OAAOX,YAAY;MAAE,CAACP,IAAIC,iBAAiB,GAAG;IAAQ,CAAA,CAAA;EAC5E,CAAA,EAAGM,YAAY;IAAE,CAACP,IAAIC,iBAAiB,GAAG;EAAU,CAAA,CAAA;AAExD,CAAA,EAAGU,KAAKR,EAAES,OAAO;AAOV,IAAMsB,gBAAgB/B,EAAEgC,MAC7BjC,oBACAW,sBACAM,wBACAS,yBAAAA,EACArB,YAAY;EAAE,CAACP,IAAIC,iBAAiB,GAAG;AAAU,CAAA;AAO5C,IAAMmC,wBAAwBjC,EAAEC,OAAO;;EAE5CiC,UAAUlC,EAAEc,SAASd,EAAEY,OAAOR,YAAY;IAAE,CAACP,IAAIC,iBAAiB,GAAG;EAAW,CAAA,CAAA;EAChFqC,SAASnC,EAAEc,SAASd,EAAE6B,QAAQzB,YAAY;IAAE,CAACP,IAAIC,iBAAiB,GAAG;EAAU,CAAA,CAAA;;EAG/EsC,MAAMpC,EAAEc,SAASiB,aAAAA;;;EAIjBM,MAAMrC,EAAEc,SAASd,EAAES,QAAQT,EAAEmB,OAAO;IAAEC,KAAKpB,EAAEY;IAAQS,OAAOrB,EAAEsB;EAAI,CAAA,CAAA,CAAA;AACpE,CAAA;AAOO,IAAMgB,kBAAN,cAA8BC,YAAY;EAC/CC,UAAU;EACVC,SAAS;AACX,CAAA,EAAGR,sBAAsBS,MAAM,EAAA;AAAG;AAO3B,IAAMC,cAAN,cAA0BJ,YAAY;EAC3CC,UAAU;EACVC,SAAS;AACX,CAAA,EAAG;EACDG,KAAK5C,EAAEY;EACPiC,aAAa7C,EAAEc,SAASd,EAAEY,MAAM;EAChCkC,OAAO9C,EAAEY;EACTmC,SAAS/C,EAAEY;AACb,CAAA,EAAA;AAAI;AAKG,IAAMoC,yBAAyBhD,EAAEC,OAAO;EAC7CgD,WAAWjD,EAAEc,SAASd,EAAES,QAAQT,EAAEkD,MAAMC,UAAUR,WAAAA,CAAAA,CAAAA,CAAAA;EAClDS,UAAUpD,EAAEc,SAASd,EAAES,QAAQT,EAAEkD,MAAMC,UAAUb,eAAAA,CAAAA,CAAAA,CAAAA;AACnD,CAAA;AAIO,IAAMe,iBAAiB;EAACV;EAAaL;;",
-  "names": ["AST", "RawObject", "S", "TypedObject", "typeLiteralAnnotations", "AST", "TitleAnnotationId", "TimerTriggerSchema", "S", "Struct", "type", "Literal", "annotations", "cron", "NonEmptyString", "ExamplesAnnotationId", "pipe", "mutable", "WebhookTriggerSchema", "method", "String", "port", "optional", "Number", "WebsocketTriggerSchema", "url", "init", "Record", "key", "value", "Any", "QuerySchema", "props", "SubscriptionTriggerSchema", "filter", "options", "deep", "Boolean", "delay", "TriggerSchema", "Union", "FunctionTriggerSchema", "function", "enabled", "spec", "meta", "FunctionTrigger", "TypedObject", "typename", "version", "fields", "FunctionDef", "uri", "description", "route", "handler", "FunctionManifestSchema", "functions", "Array", "RawObject", "triggers", "FUNCTION_TYPES"]
-}

package/dist/types/src/trigger/type/websocket-trigger.d.ts

@@ -1,14 +0,0 @@
-import { type WebsocketTrigger } from '../../types';
-import { type TriggerFactory } from '../trigger-registry';
-interface WebsocketTriggerOptions {
-    retryDelay: number;
-    maxAttempts: number;
-}
-/**
- * Websocket.
- * NOTE: The port must be unique, so the same hook cannot be used for multiple spaces.
- */
-export declare const createWebsocketTrigger: TriggerFactory<WebsocketTrigger, WebsocketTriggerOptions>;
-export declare const createWebSocket: (url: string) => Promise<WebSocket>;
-export {};
-//# sourceMappingURL=websocket-trigger.d.ts.map

package/dist/types/src/trigger/type/websocket-trigger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"websocket-trigger.d.ts","sourceRoot":"","sources":["../../../../../src/trigger/type/websocket-trigger.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAwB,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAEhF,UAAU,uBAAuB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,cAAc,CAAC,gBAAgB,EAAE,uBAAuB,CA6E5F,CAAC;AAWF,eAAO,MAAM,eAAe,QAAe,MAAM,KAAG,OAAO,CAAC,SAAS,CAEpE,CAAC"}

package/src/trigger/type/websocket-trigger.ts

@@ -1,112 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { sleep, Trigger } from '@dxos/async';
-import { type Space } from '@dxos/client/echo';
-import { type Context } from '@dxos/context';
-import { log } from '@dxos/log';
-
-import { type WebsocketTrigger } from '../../types';
-import { type TriggerCallback, type TriggerFactory } from '../trigger-registry';
-
-interface WebsocketTriggerOptions {
-  retryDelay: number;
-  maxAttempts: number;
-}
-
-/**
- * Websocket.
- * NOTE: The port must be unique, so the same hook cannot be used for multiple spaces.
- */
-export const createWebsocketTrigger: TriggerFactory<WebsocketTrigger, WebsocketTriggerOptions> = async (
-  ctx: Context,
-  space: Space,
-  spec: WebsocketTrigger,
-  callback: TriggerCallback,
-  options: WebsocketTriggerOptions = { retryDelay: 2, maxAttempts: 5 },
-) => {
-  const { url, init } = spec;
-
-  let wasOpen = false;
-  let ws: WebSocket;
-  for (let attempt = 1; attempt <= options.maxAttempts; attempt++) {
-    const open = new Trigger<boolean>();
-
-    ws = await createWebSocket(url);
-    Object.assign(ws, {
-      onopen: () => {
-        log.info('opened', { url });
-        if (spec.init) {
-          ws.send(new TextEncoder().encode(JSON.stringify(init)));
-        }
-
-        open.wake(true);
-      },
-
-      onclose: (event) => {
-        log.info('closed', { url, code: event.code });
-        // Reconnect if server closes (e.g., CF restart).
-        // https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
-        if (event.code === 1006 && wasOpen && !ctx.disposed) {
-          setTimeout(async () => {
-            log.info(`reconnecting in ${options.retryDelay}s...`, { url });
-            await createWebsocketTrigger(ctx, space, spec, callback, options);
-          }, options.retryDelay * 1_000);
-        }
-        open.wake(false);
-      },
-
-      onerror: (event) => {
-        log.catch((event as any).error ?? new Error('Unspecified ws error.'), { url });
-        open.wake(false);
-      },
-
-      onmessage: async (event) => {
-        try {
-          log.info('message');
-          let data;
-          if (event.data && 'text' in event.data) {
-            data = JSON.parse(await (event.data as Blob).text());
-          } else {
-            data = JSON.parse(new TextDecoder().decode(event.data as Uint8Array));
-          }
-          await callback({ data });
-        } catch (err) {
-          log.catch(err, { url, data: event.data });
-        }
-      },
-    } satisfies Partial<WebSocket>);
-
-    const isOpen = await open.wait();
-    if (ctx.disposed) {
-      break;
-    }
-    if (isOpen) {
-      wasOpen = true;
-      break;
-    }
-    const wait = Math.pow(attempt, 2) * options.retryDelay;
-    if (attempt < options.maxAttempts) {
-      log.warn(`failed to connect; trying again in ${wait}s`, { attempt });
-      await sleep(wait * 1_000);
-    }
-  }
-
-  ctx.onDispose(() => {
-    ws?.close();
-  });
-};
-
-const createNodeWebSocket = async (url: string) => {
-  // eslint-disable-next-line no-new-func
-  const importESM = Function('path', 'return import(path)');
-  const {
-    default: { WebSocket },
-  } = await importESM('ws');
-  return new WebSocket(url);
-};
-
-export const createWebSocket = async (url: string): Promise<WebSocket> => {
-  return typeof (globalThis as any).WebSocket === 'undefined' ? await createNodeWebSocket(url) : new WebSocket(url);
-};