@dxos/functions 0.5.3-main.bc67fdb → 0.5.3-main.bfb5bca

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/dist/lib/browser/chunk-4D4I3YMJ.mjs +86 -0
  2. package/dist/lib/browser/chunk-4D4I3YMJ.mjs.map +7 -0
  3. package/dist/lib/browser/index.mjs +752 -480
  4. package/dist/lib/browser/index.mjs.map +4 -4
  5. package/dist/lib/browser/meta.json +1 -1
  6. package/dist/lib/browser/types.mjs +14 -0
  7. package/dist/lib/browser/types.mjs.map +7 -0
  8. package/dist/lib/node/chunk-3UYUR5N5.cjs +103 -0
  9. package/dist/lib/node/chunk-3UYUR5N5.cjs.map +7 -0
  10. package/dist/lib/node/index.cjs +739 -473
  11. package/dist/lib/node/index.cjs.map +4 -4
  12. package/dist/lib/node/meta.json +1 -1
  13. package/dist/lib/node/types.cjs +35 -0
  14. package/dist/lib/node/types.cjs.map +7 -0
  15. package/dist/types/src/browser/index.d.ts +2 -0
  16. package/dist/types/src/browser/index.d.ts.map +1 -0
  17. package/dist/types/src/function/function-registry.d.ts +24 -0
  18. package/dist/types/src/function/function-registry.d.ts.map +1 -0
  19. package/dist/types/src/function/function-registry.test.d.ts +2 -0
  20. package/dist/types/src/function/function-registry.test.d.ts.map +1 -0
  21. package/dist/types/src/function/index.d.ts +2 -0
  22. package/dist/types/src/function/index.d.ts.map +1 -0
  23. package/dist/types/src/handler.d.ts.map +1 -1
  24. package/dist/types/src/index.d.ts +2 -0
  25. package/dist/types/src/index.d.ts.map +1 -1
  26. package/dist/types/src/runtime/dev-server.d.ts +7 -10
  27. package/dist/types/src/runtime/dev-server.d.ts.map +1 -1
  28. package/dist/types/src/runtime/scheduler.d.ts +11 -59
  29. package/dist/types/src/runtime/scheduler.d.ts.map +1 -1
  30. package/dist/types/src/testing/functions-integration.test.d.ts +2 -0
  31. package/dist/types/src/testing/functions-integration.test.d.ts.map +1 -0
  32. package/dist/types/src/testing/index.d.ts +4 -0
  33. package/dist/types/src/testing/index.d.ts.map +1 -0
  34. package/dist/types/src/testing/setup.d.ts +5 -0
  35. package/dist/types/src/testing/setup.d.ts.map +1 -0
  36. package/dist/types/src/testing/test/handler.d.ts +1 -0
  37. package/dist/types/src/testing/test/handler.d.ts.map +1 -1
  38. package/dist/types/src/testing/types.d.ts +9 -0
  39. package/dist/types/src/testing/types.d.ts.map +1 -0
  40. package/dist/types/src/testing/util.d.ts +3 -0
  41. package/dist/types/src/testing/util.d.ts.map +1 -0
  42. package/dist/types/src/trigger/index.d.ts +2 -0
  43. package/dist/types/src/trigger/index.d.ts.map +1 -0
  44. package/dist/types/src/trigger/trigger-registry.d.ts +37 -0
  45. package/dist/types/src/trigger/trigger-registry.d.ts.map +1 -0
  46. package/dist/types/src/trigger/trigger-registry.test.d.ts +2 -0
  47. package/dist/types/src/trigger/trigger-registry.test.d.ts.map +1 -0
  48. package/dist/types/src/trigger/type/index.d.ts +5 -0
  49. package/dist/types/src/trigger/type/index.d.ts.map +1 -0
  50. package/dist/types/src/trigger/type/subscription-trigger.d.ts +4 -0
  51. package/dist/types/src/trigger/type/subscription-trigger.d.ts.map +1 -0
  52. package/dist/types/src/trigger/type/timer-trigger.d.ts +4 -0
  53. package/dist/types/src/trigger/type/timer-trigger.d.ts.map +1 -0
  54. package/dist/types/src/trigger/type/webhook-trigger.d.ts +4 -0
  55. package/dist/types/src/trigger/type/webhook-trigger.d.ts.map +1 -0
  56. package/dist/types/src/trigger/type/websocket-trigger.d.ts +13 -0
  57. package/dist/types/src/trigger/type/websocket-trigger.d.ts.map +1 -0
  58. package/dist/types/src/types.d.ts +152 -119
  59. package/dist/types/src/types.d.ts.map +1 -1
  60. package/package.json +30 -14
  61. package/schema/functions.json +144 -116
  62. package/src/browser/index.ts +5 -0
  63. package/src/function/function-registry.test.ts +105 -0
  64. package/src/function/function-registry.ts +90 -0
  65. package/src/function/index.ts +5 -0
  66. package/src/index.ts +2 -0
  67. package/src/runtime/dev-server.test.ts +15 -35
  68. package/src/runtime/dev-server.ts +38 -21
  69. package/src/runtime/scheduler.test.ts +59 -75
  70. package/src/runtime/scheduler.ts +70 -297
  71. package/src/testing/functions-integration.test.ts +100 -0
  72. package/src/testing/index.ts +7 -0
  73. package/src/testing/setup.ts +43 -0
  74. package/src/testing/test/handler.ts +8 -2
  75. package/src/testing/types.ts +9 -0
  76. package/src/testing/util.ts +16 -0
  77. package/src/trigger/index.ts +5 -0
  78. package/src/trigger/trigger-registry.test.ts +272 -0
  79. package/src/trigger/trigger-registry.ts +211 -0
  80. package/src/trigger/type/index.ts +8 -0
  81. package/src/trigger/type/subscription-trigger.ts +86 -0
  82. package/src/trigger/type/timer-trigger.ts +45 -0
  83. package/src/trigger/type/webhook-trigger.ts +48 -0
  84. package/src/trigger/type/websocket-trigger.ts +92 -0
  85. package/src/types.ts +82 -54
@@ -0,0 +1 @@
1
+ {"version":3,"file":"functions-integration.test.d.ts","sourceRoot":"","sources":["../../../../src/testing/functions-integration.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export * from './setup';
2
+ export * from './types';
3
+ export * from './util';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/testing/index.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC"}
@@ -0,0 +1,5 @@
1
+ import { Client, Config } from '@dxos/client';
2
+ import { type TestBuilder } from '@dxos/client/testing';
3
+ export declare const createInitializedClients: (testBuilder: TestBuilder, count?: number, config?: Config) => Promise<Client[]>;
4
+ export declare const createFunctionRuntime: (testBuilder: TestBuilder) => Promise<Client>;
5
+ //# sourceMappingURL=setup.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../../../../src/testing/setup.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAQxD,eAAO,MAAM,wBAAwB,gBAAuB,WAAW,UAAS,MAAM,WAAe,MAAM,sBAW1G,CAAC;AAEF,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,MAAM,CAepF,CAAC"}
@@ -1,3 +1,4 @@
1
1
  import { type FunctionHandler } from '../../handler';
2
+ export declare const setTestCallHandler: (handler: FunctionHandler<any>) => void;
2
3
  export declare const handler: FunctionHandler<any>;
3
4
  //# sourceMappingURL=handler.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../../../../src/testing/test/handler.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AAErD,eAAO,MAAM,OAAO,EAAE,eAAe,CAAC,GAAG,CAExC,CAAC"}
1
+ {"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../../../../src/testing/test/handler.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AAIrD,eAAO,MAAM,kBAAkB,YAAa,gBAAgB,GAAG,CAAC,SAE/D,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,eAAe,CAAC,GAAG,CAExC,CAAC"}
@@ -0,0 +1,9 @@
1
+ declare const TestType_base: import("@dxos/echo-schema").EchoSchemaClass<{
2
+ title: string;
3
+ } & {
4
+ id: string;
5
+ }>;
6
+ export declare class TestType extends TestType_base {
7
+ }
8
+ export {};
9
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/testing/types.ts"],"names":[],"mappings":";;;;;AAMA,qBAAa,QAAS,SAAQ,aAE5B;CAAG"}
@@ -0,0 +1,3 @@
1
+ import { type Space } from '@dxos/client/echo';
2
+ export declare const triggerWebhook: (space: Space, uri: string) => Promise<void>;
3
+ //# sourceMappingURL=util.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../src/testing/util.ts"],"names":[],"mappings":"AAIA,OAAO,EAAU,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAKvD,eAAO,MAAM,cAAc,UAAiB,KAAK,OAAO,MAAM,kBAM7D,CAAC"}
@@ -0,0 +1,2 @@
1
+ export * from './trigger-registry';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/trigger/index.ts"],"names":[],"mappings":"AAIA,cAAc,oBAAoB,CAAC"}
@@ -0,0 +1,37 @@
1
+ import { Event } from '@dxos/async';
2
+ import { type Client } from '@dxos/client';
3
+ import { type Space } from '@dxos/client/echo';
4
+ import { Context, Resource } from '@dxos/context';
5
+ import { type FunctionManifest, FunctionTrigger, type FunctionTriggerType, type TriggerSpec } from '../types';
6
+ type ResponseCode = number;
7
+ export type TriggerCallback = (args: object) => Promise<ResponseCode>;
8
+ export type TriggerFactory<Spec extends TriggerSpec, Options = any> = (ctx: Context, space: Space, spec: Spec, callback: TriggerCallback, options?: Options) => Promise<void>;
9
+ export type TriggerHandlerMap = {
10
+ [type in FunctionTriggerType]: TriggerFactory<any>;
11
+ };
12
+ export type TriggerEvent = {
13
+ space: Space;
14
+ triggers: FunctionTrigger[];
15
+ };
16
+ export declare class TriggerRegistry extends Resource {
17
+ private readonly _client;
18
+ private readonly _options?;
19
+ private readonly _triggersBySpaceKey;
20
+ readonly registered: Event<TriggerEvent>;
21
+ readonly removed: Event<TriggerEvent>;
22
+ constructor(_client: Client, _options?: TriggerHandlerMap | undefined);
23
+ getActiveTriggers(space: Space): FunctionTrigger[];
24
+ getInactiveTriggers(space: Space): FunctionTrigger[];
25
+ activate(space: Space, trigger: FunctionTrigger, callback: TriggerCallback): Promise<void>;
26
+ /**
27
+ * Loads triggers from the manifest into the space.
28
+ */
29
+ register(space: Space, manifest: FunctionManifest): Promise<void>;
30
+ protected _open(): Promise<void>;
31
+ protected _close(_: Context): Promise<void>;
32
+ private _handleNewTriggers;
33
+ private _handleRemovedTriggers;
34
+ private _getTriggers;
35
+ }
36
+ export {};
37
+ //# sourceMappingURL=trigger-registry.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"trigger-registry.d.ts","sourceRoot":"","sources":["../../../../src/trigger/trigger-registry.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAA2B,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAQlD,OAAO,EAAE,KAAK,gBAAgB,EAAE,eAAe,EAAE,KAAK,mBAAmB,EAAE,KAAK,WAAW,EAAE,MAAM,UAAU,CAAC;AAE9G,KAAK,YAAY,GAAG,MAAM,CAAC;AAE3B,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;AAGtE,MAAM,MAAM,cAAc,CAAC,IAAI,SAAS,WAAW,EAAE,OAAO,GAAG,GAAG,IAAI,CACpE,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,eAAe,EACzB,OAAO,CAAC,EAAE,OAAO,KACd,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,MAAM,iBAAiB,GAAG;KAAG,IAAI,IAAI,mBAAmB,GAAG,cAAc,CAAC,GAAG,CAAC;CAAE,CAAC;AASvF,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B,CAAC;AAOF,qBAAa,eAAgB,SAAQ,QAAQ;IAOzC,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAP5B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAkE;IAEtG,SAAgB,UAAU,sBAA6B;IACvD,SAAgB,OAAO,sBAA6B;gBAGjC,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,+BAAmB;IAKxC,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,EAAE;IAIlD,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,EAAE;IAIrD,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBhG;;OAEG;IACU,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;cAoCrD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;cA8BtB,MAAM,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1D,OAAO,CAAC,kBAAkB;YAiBZ,sBAAsB;IA0BpC,OAAO,CAAC,YAAY;CAIrB"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=trigger-registry.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"trigger-registry.test.d.ts","sourceRoot":"","sources":["../../../../src/trigger/trigger-registry.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ export * from './subscription-trigger';
2
+ export * from './timer-trigger';
3
+ export * from './webhook-trigger';
4
+ export * from './websocket-trigger';
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/trigger/type/index.ts"],"names":[],"mappings":"AAIA,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}
@@ -0,0 +1,4 @@
1
+ import type { SubscriptionTrigger } from '../../types';
2
+ import { type TriggerFactory } from '../trigger-registry';
3
+ export declare const createSubscriptionTrigger: TriggerFactory<SubscriptionTrigger>;
4
+ //# sourceMappingURL=subscription-trigger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"subscription-trigger.d.ts","sourceRoot":"","sources":["../../../../../src/trigger/type/subscription-trigger.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAwB,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAEhF,eAAO,MAAM,yBAAyB,EAAE,cAAc,CAAC,mBAAmB,CAuEzE,CAAC"}
@@ -0,0 +1,4 @@
1
+ import type { TimerTrigger } from '../../types';
2
+ import { type TriggerFactory } from '../trigger-registry';
3
+ export declare const createTimerTrigger: TriggerFactory<TimerTrigger>;
4
+ //# sourceMappingURL=timer-trigger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"timer-trigger.d.ts","sourceRoot":"","sources":["../../../../../src/trigger/type/timer-trigger.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAwB,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAEhF,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAAC,YAAY,CA8B3D,CAAC"}
@@ -0,0 +1,4 @@
1
+ import type { WebhookTrigger } from '../../types';
2
+ import { type TriggerFactory } from '../trigger-registry';
3
+ export declare const createWebhookTrigger: TriggerFactory<WebhookTrigger>;
4
+ //# sourceMappingURL=webhook-trigger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"webhook-trigger.d.ts","sourceRoot":"","sources":["../../../../../src/trigger/type/webhook-trigger.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAwB,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAEhF,eAAO,MAAM,oBAAoB,EAAE,cAAc,CAAC,cAAc,CAiC/D,CAAC"}
@@ -0,0 +1,13 @@
1
+ import { type WebsocketTrigger } from '../../types';
2
+ import { type TriggerFactory } from '../trigger-registry';
3
+ interface WebsocketTriggerOptions {
4
+ retryDelay: number;
5
+ maxAttempts: number;
6
+ }
7
+ /**
8
+ * Websocket.
9
+ * NOTE: The port must be unique, so the same hook cannot be used for multiple spaces.
10
+ */
11
+ export declare const createWebsocketTrigger: TriggerFactory<WebsocketTrigger, WebsocketTriggerOptions>;
12
+ export {};
13
+ //# sourceMappingURL=websocket-trigger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"websocket-trigger.d.ts","sourceRoot":"","sources":["../../../../../src/trigger/type/websocket-trigger.ts"],"names":[],"mappings":"AAWA,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,CAoE5F,CAAC"}
@@ -1,21 +1,13 @@
1
- import * as S from '@effect/schema/Schema';
2
- declare const TimerTriggerSchema: S.struct<{
3
- cron: S.$string;
4
- }>;
5
- declare const WebhookTriggerSchema: S.mutable<S.struct<{
6
- method: S.$string;
7
- port: S.PropertySignature<"?:", number | undefined, never, "?:", number | undefined, never>;
8
- }>>;
9
- declare const WebsocketTriggerSchema: S.struct<{
10
- url: S.$string;
11
- init: S.PropertySignature<"?:", {
12
- readonly [x: string]: any;
13
- } | undefined, never, "?:", {
14
- readonly [x: string]: any;
15
- } | undefined, never>;
16
- }>;
17
- declare const SubscriptionTriggerSchema: S.struct<{
18
- spaceKey: S.PropertySignature<"?:", string | undefined, never, "?:", string | undefined, never>;
1
+ import { S } from '@dxos/echo-schema';
2
+ /**
3
+ * Type discriminator for TriggerSpec.
4
+ * Every spec has a type field of type FunctionTriggerType that we can use to understand which
5
+ * type we're working with.
6
+ * https://www.typescriptlang.org/docs/handbook/2/narrowing.html#discriminated-unions
7
+ */
8
+ export type FunctionTriggerType = 'subscription' | 'timer' | 'webhook' | 'websocket';
9
+ declare const SubscriptionTriggerSchema: S.mutable<S.struct<{
10
+ type: S.literal<["subscription"]>;
19
11
  filter: S.array<S.struct<{
20
12
  type: S.$string;
21
13
  props: S.PropertySignature<"?:", {
@@ -31,152 +23,193 @@ declare const SubscriptionTriggerSchema: S.struct<{
31
23
  readonly deep?: boolean | undefined;
32
24
  readonly delay?: number | undefined;
33
25
  } | undefined, never>;
34
- }>;
35
- declare const FunctionTriggerSchema: S.struct<{
36
- function: S.$string;
37
- meta: S.PropertySignature<"?:", {
26
+ }>>;
27
+ export type SubscriptionTrigger = S.Schema.Type<typeof SubscriptionTriggerSchema>;
28
+ declare const TimerTriggerSchema: S.mutable<S.struct<{
29
+ type: S.literal<["timer"]>;
30
+ cron: S.$string;
31
+ }>>;
32
+ export type TimerTrigger = S.Schema.Type<typeof TimerTriggerSchema>;
33
+ declare const WebhookTriggerSchema: S.mutable<S.struct<{
34
+ type: S.literal<["webhook"]>;
35
+ method: S.$string;
36
+ port: S.PropertySignature<"?:", number | undefined, never, "?:", number | undefined, never>;
37
+ }>>;
38
+ export type WebhookTrigger = S.Schema.Type<typeof WebhookTriggerSchema>;
39
+ declare const WebsocketTriggerSchema: S.mutable<S.struct<{
40
+ type: S.literal<["websocket"]>;
41
+ url: S.$string;
42
+ init: S.PropertySignature<"?:", {
38
43
  readonly [x: string]: any;
39
44
  } | undefined, never, "?:", {
40
45
  readonly [x: string]: any;
41
46
  } | undefined, never>;
42
- timer: S.PropertySignature<"?:", {
43
- readonly cron: string;
44
- } | undefined, never, "?:", {
45
- readonly cron: string;
46
- } | undefined, never>;
47
- webhook: S.PropertySignature<"?:", {
48
- port?: number | undefined;
49
- method: string;
50
- } | undefined, never, "?:", {
51
- method: string;
52
- port?: number | undefined;
53
- } | undefined, never>;
54
- websocket: S.PropertySignature<"?:", {
55
- readonly url: string;
56
- readonly init?: {
57
- readonly [x: string]: any;
58
- } | undefined;
59
- } | undefined, never, "?:", {
60
- readonly url: string;
61
- readonly init?: {
62
- readonly [x: string]: any;
63
- } | undefined;
64
- } | undefined, never>;
65
- subscription: S.PropertySignature<"?:", {
66
- readonly filter: readonly {
47
+ }>>;
48
+ export type WebsocketTrigger = S.Schema.Type<typeof WebsocketTriggerSchema>;
49
+ export type TriggerSpec = TimerTrigger | WebhookTrigger | WebsocketTrigger | SubscriptionTrigger;
50
+ declare const FunctionDef_base: import("@dxos/echo-schema").EchoSchemaClass<{
51
+ handler: string;
52
+ uri: string;
53
+ description?: string | undefined;
54
+ route: string;
55
+ } & {
56
+ id: string;
57
+ }>;
58
+ /**
59
+ * Function definition.
60
+ */
61
+ export declare class FunctionDef extends FunctionDef_base {
62
+ }
63
+ declare const FunctionTrigger_base: import("@dxos/echo-schema").EchoSchemaClass<{
64
+ function: string;
65
+ enabled?: boolean | undefined;
66
+ meta?: {
67
+ [x: string]: any;
68
+ } | undefined;
69
+ spec: {
70
+ filter: readonly {
67
71
  readonly type: string;
68
72
  readonly props?: {
69
73
  readonly [x: string]: any;
70
74
  } | undefined;
71
75
  }[];
72
- readonly spaceKey?: string | undefined;
73
- readonly options?: {
76
+ type: "subscription";
77
+ options?: {
74
78
  readonly deep?: boolean | undefined;
75
79
  readonly delay?: number | undefined;
76
80
  } | undefined;
77
- } | undefined, never, "?:", {
78
- readonly filter: readonly {
79
- readonly type: string;
80
- readonly props?: {
81
- readonly [x: string]: any;
82
- } | undefined;
83
- }[];
84
- readonly spaceKey?: string | undefined;
85
- readonly options?: {
86
- readonly deep?: boolean | undefined;
87
- readonly delay?: number | undefined;
81
+ } | {
82
+ type: "timer";
83
+ cron: string;
84
+ } | {
85
+ port?: number | undefined;
86
+ type: "webhook";
87
+ method: string;
88
+ } | {
89
+ type: "websocket";
90
+ url: string;
91
+ init?: {
92
+ readonly [x: string]: any;
88
93
  } | undefined;
89
- } | undefined, never>;
94
+ };
95
+ } & {
96
+ id: string;
90
97
  }>;
91
- export type FunctionTrigger = S.Schema.Type<typeof FunctionTriggerSchema>;
92
- export type TimerTrigger = S.Schema.Type<typeof TimerTriggerSchema>;
93
- export type WebhookTrigger = S.Schema.Type<typeof WebhookTriggerSchema>;
94
- export type WebsocketTrigger = S.Schema.Type<typeof WebsocketTriggerSchema>;
95
- export type SubscriptionTrigger = S.Schema.Type<typeof SubscriptionTriggerSchema>;
96
98
  /**
97
- * Function definition.
99
+ * Function trigger.
98
100
  */
99
- declare const FunctionDefSchema: S.struct<{
100
- id: S.$string;
101
- description: S.PropertySignature<"?:", string | undefined, never, "?:", string | undefined, never>;
102
- path: S.$string;
103
- handler: S.$string;
104
- }>;
105
- export type FunctionDef = S.Schema.Type<typeof FunctionDefSchema>;
101
+ export declare class FunctionTrigger extends FunctionTrigger_base {
102
+ }
106
103
  /**
107
104
  * Function manifest file.
108
105
  */
109
106
  export declare const FunctionManifestSchema: S.struct<{
110
- functions: S.mutable<S.array<S.struct<{
111
- id: S.$string;
112
- description: S.PropertySignature<"?:", string | undefined, never, "?:", string | undefined, never>;
113
- path: S.$string;
114
- handler: S.$string;
115
- }>>>;
116
- triggers: S.PropertySignature<"?:", {
117
- readonly function: string;
118
- readonly meta?: {
119
- readonly [x: string]: any;
107
+ functions: S.PropertySignature<"?:", ({
108
+ handler: string;
109
+ uri: string;
110
+ description?: string | undefined;
111
+ route: string;
112
+ } & {
113
+ "@meta"?: {
114
+ readonly keys: {
115
+ readonly id: string;
116
+ readonly source: string;
117
+ }[];
120
118
  } | undefined;
121
- readonly timer?: {
122
- readonly cron: string;
119
+ })[] | undefined, never, "?:", ({
120
+ handler: string;
121
+ uri: string;
122
+ description?: string | undefined;
123
+ route: string;
124
+ } & {
125
+ "@meta"?: {
126
+ readonly keys: {
127
+ readonly id: string;
128
+ readonly source: string;
129
+ }[];
123
130
  } | undefined;
124
- readonly webhook?: {
125
- port?: number | undefined;
126
- method: string;
131
+ })[] | undefined, never>;
132
+ triggers: S.PropertySignature<"?:", ({
133
+ function: string;
134
+ enabled?: boolean | undefined;
135
+ meta?: {
136
+ [x: string]: any;
127
137
  } | undefined;
128
- readonly websocket?: {
129
- readonly url: string;
130
- readonly init?: {
131
- readonly [x: string]: any;
132
- } | undefined;
133
- } | undefined;
134
- readonly subscription?: {
135
- readonly filter: readonly {
138
+ spec: {
139
+ filter: readonly {
136
140
  readonly type: string;
137
141
  readonly props?: {
138
142
  readonly [x: string]: any;
139
143
  } | undefined;
140
144
  }[];
141
- readonly spaceKey?: string | undefined;
142
- readonly options?: {
145
+ type: "subscription";
146
+ options?: {
143
147
  readonly deep?: boolean | undefined;
144
148
  readonly delay?: number | undefined;
145
149
  } | undefined;
146
- } | undefined;
147
- }[] | undefined, never, "?:", {
148
- readonly function: string;
149
- readonly meta?: {
150
- readonly [x: string]: any;
151
- } | undefined;
152
- readonly timer?: {
153
- readonly cron: string;
154
- } | undefined;
155
- readonly webhook?: {
156
- method: string;
150
+ } | {
151
+ type: "timer";
152
+ cron: string;
153
+ } | {
157
154
  port?: number | undefined;
158
- } | undefined;
159
- readonly websocket?: {
160
- readonly url: string;
161
- readonly init?: {
155
+ type: "webhook";
156
+ method: string;
157
+ } | {
158
+ type: "websocket";
159
+ url: string;
160
+ init?: {
162
161
  readonly [x: string]: any;
163
162
  } | undefined;
163
+ };
164
+ } & {
165
+ "@meta"?: {
166
+ readonly keys: {
167
+ readonly id: string;
168
+ readonly source: string;
169
+ }[];
170
+ } | undefined;
171
+ })[] | undefined, never, "?:", ({
172
+ function: string;
173
+ enabled?: boolean | undefined;
174
+ meta?: {
175
+ [x: string]: any;
164
176
  } | undefined;
165
- readonly subscription?: {
166
- readonly filter: readonly {
177
+ spec: {
178
+ filter: readonly {
167
179
  readonly type: string;
168
180
  readonly props?: {
169
181
  readonly [x: string]: any;
170
182
  } | undefined;
171
183
  }[];
172
- readonly spaceKey?: string | undefined;
173
- readonly options?: {
184
+ type: "subscription";
185
+ options?: {
174
186
  readonly deep?: boolean | undefined;
175
187
  readonly delay?: number | undefined;
176
188
  } | undefined;
189
+ } | {
190
+ type: "timer";
191
+ cron: string;
192
+ } | {
193
+ port?: number | undefined;
194
+ type: "webhook";
195
+ method: string;
196
+ } | {
197
+ type: "websocket";
198
+ url: string;
199
+ init?: {
200
+ readonly [x: string]: any;
201
+ } | undefined;
202
+ };
203
+ } & {
204
+ "@meta"?: {
205
+ readonly keys: {
206
+ readonly id: string;
207
+ readonly source: string;
208
+ }[];
177
209
  } | undefined;
178
- }[] | undefined, never>;
210
+ })[] | undefined, never>;
179
211
  }>;
180
212
  export type FunctionManifest = S.Schema.Type<typeof FunctionManifestSchema>;
213
+ export declare const FUNCTION_SCHEMA: (typeof FunctionDef | typeof FunctionTrigger)[];
181
214
  export {};
182
215
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"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,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE1E,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;AAElF;;GAEG;AAEH,QAAA,MAAM,iBAAiB;;;;;EAQrB,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"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAa,CAAC,EAAe,MAAM,mBAAmB,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;AAErF,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;GAmB9B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAElF,QAAA,MAAM,kBAAkB;;;GAKvB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEpE,QAAA,MAAM,oBAAoB;;;;GAOzB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAExE,QAAA,MAAM,sBAAsB;;;;;;;;GAM3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAS5E,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,gBAAgB,GAAG,mBAAmB,CAAC;;;;;;;;;AAEjG;;GAEG;AACH,qBAAa,WAAY,SAAQ,gBAQ/B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;GAEG;AACH,qBAAa,eAAgB,SAAQ,oBASnC;CAAG;AAEL;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAG5E,eAAO,MAAM,eAAe,iDAAiC,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@dxos/functions",
3
- "version": "0.5.3-main.bc67fdb",
4
- "description": "Functions SDK and runtime.",
3
+ "version": "0.5.3-main.bfb5bca",
4
+ "description": "Functions API and runtime.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
7
7
  "license": "MIT",
@@ -10,37 +10,53 @@
10
10
  ".": {
11
11
  "browser": "./dist/lib/browser/index.mjs",
12
12
  "node": "./dist/lib/node/index.cjs",
13
- "default": "./dist/lib/node/index.cjs"
13
+ "default": "./dist/lib/node/index.cjs",
14
+ "types": "./dist/types/src/index.d.ts"
15
+ },
16
+ "./types": {
17
+ "browser": "./dist/lib/browser/types.mjs",
18
+ "node": "./dist/lib/node/types.cjs",
19
+ "default": "./dist/lib/node/types.cjs",
20
+ "types": "./dist/types/src/types.d.ts"
14
21
  }
15
22
  },
16
23
  "types": "dist/types/src/index.d.ts",
24
+ "typesVersions": {
25
+ "*": {
26
+ "types": [
27
+ "dist/types/src/types.d.ts"
28
+ ]
29
+ }
30
+ },
17
31
  "files": [
18
32
  "dist",
19
33
  "schema",
20
34
  "src"
21
35
  ],
22
36
  "dependencies": {
23
- "@effect/schema": "^0.64.20",
24
37
  "@preact/signals-core": "^1.6.0",
25
38
  "cron": "^3.1.6",
26
39
  "effect": "^2.4.19",
27
40
  "express": "^4.19.2",
28
41
  "get-port-please": "^3.1.1",
29
42
  "ws": "^8.14.2",
30
- "@braneframe/types": "0.5.3-main.bc67fdb",
31
- "@dxos/client": "0.5.3-main.bc67fdb",
32
- "@dxos/async": "0.5.3-main.bc67fdb",
33
- "@dxos/echo-schema": "0.5.3-main.bc67fdb",
34
- "@dxos/context": "0.5.3-main.bc67fdb",
35
- "@dxos/invariant": "0.5.3-main.bc67fdb",
36
- "@dxos/node-std": "0.5.3-main.bc67fdb",
37
- "@dxos/util": "0.5.3-main.bc67fdb",
38
- "@dxos/log": "0.5.3-main.bc67fdb"
43
+ "@dxos/async": "0.5.3-main.bfb5bca",
44
+ "@braneframe/types": "0.5.3-main.bfb5bca",
45
+ "@dxos/client": "0.5.3-main.bfb5bca",
46
+ "@dxos/context": "0.5.3-main.bfb5bca",
47
+ "@dxos/echo-db": "0.5.3-main.bfb5bca",
48
+ "@dxos/echo-schema": "0.5.3-main.bfb5bca",
49
+ "@dxos/invariant": "0.5.3-main.bfb5bca",
50
+ "@dxos/keys": "0.5.3-main.bfb5bca",
51
+ "@dxos/log": "0.5.3-main.bfb5bca",
52
+ "@dxos/node-std": "0.5.3-main.bfb5bca",
53
+ "@dxos/protocols": "0.5.3-main.bfb5bca",
54
+ "@dxos/util": "0.5.3-main.bfb5bca"
39
55
  },
40
56
  "devDependencies": {
41
57
  "@types/express": "^4.17.17",
42
58
  "@types/ws": "^7.4.0",
43
- "@dxos/agent": "0.5.3-main.bc67fdb"
59
+ "@dxos/agent": "0.5.3-main.bfb5bca"
44
60
  },
45
61
  "publishConfig": {
46
62
  "access": "public"