@dxos/functions 0.8.3 → 0.8.4-main.1068cf700f

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

@@ -0,0 +1,121 @@
+import * as Schema from 'effect/Schema';
+import { Obj, QueryAST, Type } from '@dxos/echo';
+/**
+ * Type discriminator for TriggerType.
+ * Every spec has a type field of type TriggerKind that we can use to understand which type we're working with.
+ * https://www.typescriptlang.org/docs/handbook/2/narrowing.html#discriminated-unions
+ */
+export declare const Kinds: readonly ["email", "queue", "subscription", "timer", "webhook"];
+export type Kind = (typeof Kinds)[number];
+export declare const EmailSpec: Schema.Struct<{
+    kind: Schema.Literal<["email"]>;
+}>;
+export type EmailSpec = Schema.Schema.Type<typeof EmailSpec>;
+export declare const QueueSpec: Schema.Struct<{
+    kind: Schema.Literal<["queue"]>;
+    queue: Schema.refine<string, typeof Schema.NonEmptyString>;
+}>;
+export type QueueSpec = Schema.Schema.Type<typeof QueueSpec>;
+/**
+ * Subscription.
+ */
+export declare const SubscriptionSpec: Schema.Struct<{
+    kind: Schema.Literal<["subscription"]>;
+    query: Schema.Struct<{
+        raw: Schema.optional<Schema.SchemaClass<string, string, never>>;
+        ast: Schema.Schema<QueryAST.QuerySelectClause | QueryAST.QueryFilterClause | QueryAST.QueryReferenceTraversalClause | QueryAST.QueryIncomingReferencesClause | QueryAST.QueryRelationClause | QueryAST.QueryRelationTraversalClause | QueryAST.QueryHierarchyTraversalClause | QueryAST.QueryUnionClause | QueryAST.QuerySetDifferenceClause | QueryAST.QueryOrderClause | QueryAST.QueryOptionsClause | QueryAST.QueryLimitClause, QueryAST.QuerySelectClause | QueryAST.QueryFilterClause | QueryAST.QueryReferenceTraversalClause | QueryAST.QueryIncomingReferencesClause | QueryAST.QueryRelationClause | QueryAST.QueryRelationTraversalClause | QueryAST.QueryHierarchyTraversalClause | QueryAST.QueryUnionClause | QueryAST.QuerySetDifferenceClause | QueryAST.QueryOrderClause | QueryAST.QueryOptionsClause | QueryAST.QueryLimitClause, never>;
+    }>;
+    options: Schema.optional<Schema.Struct<{
+        deep: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
+        delay: Schema.optional<Schema.SchemaClass<number, number, never>>;
+    }>>;
+}>;
+export type SubscriptionSpec = Schema.Schema.Type<typeof SubscriptionSpec>;
+/**
+ * Cron timer.
+ */
+export declare const TimerSpec: Schema.Struct<{
+    kind: Schema.Literal<["timer"]>;
+    cron: Schema.SchemaClass<string, string, never>;
+}>;
+export type TimerSpec = Schema.Schema.Type<typeof TimerSpec>;
+/**
+ * Webhook.
+ */
+export declare const WebhookSpec: Schema.Struct<{
+    kind: Schema.Literal<["webhook"]>;
+    method: Schema.optional<Schema.SchemaClass<string, string, never>>;
+    port: Schema.optional<Schema.SchemaClass<number, number, never>>;
+}>;
+export type WebhookSpec = Schema.Schema.Type<typeof WebhookSpec>;
+/**
+ * Trigger schema.
+ */
+export declare const Spec: Schema.Union<[Schema.Struct<{
+    kind: Schema.Literal<["email"]>;
+}>, Schema.Struct<{
+    kind: Schema.Literal<["queue"]>;
+    queue: Schema.refine<string, typeof Schema.NonEmptyString>;
+}>, Schema.Struct<{
+    kind: Schema.Literal<["subscription"]>;
+    query: Schema.Struct<{
+        raw: Schema.optional<Schema.SchemaClass<string, string, never>>;
+        ast: Schema.Schema<QueryAST.QuerySelectClause | QueryAST.QueryFilterClause | QueryAST.QueryReferenceTraversalClause | QueryAST.QueryIncomingReferencesClause | QueryAST.QueryRelationClause | QueryAST.QueryRelationTraversalClause | QueryAST.QueryHierarchyTraversalClause | QueryAST.QueryUnionClause | QueryAST.QuerySetDifferenceClause | QueryAST.QueryOrderClause | QueryAST.QueryOptionsClause | QueryAST.QueryLimitClause, QueryAST.QuerySelectClause | QueryAST.QueryFilterClause | QueryAST.QueryReferenceTraversalClause | QueryAST.QueryIncomingReferencesClause | QueryAST.QueryRelationClause | QueryAST.QueryRelationTraversalClause | QueryAST.QueryHierarchyTraversalClause | QueryAST.QueryUnionClause | QueryAST.QuerySetDifferenceClause | QueryAST.QueryOrderClause | QueryAST.QueryOptionsClause | QueryAST.QueryLimitClause, never>;
+    }>;
+    options: Schema.optional<Schema.Struct<{
+        deep: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
+        delay: Schema.optional<Schema.SchemaClass<number, number, never>>;
+    }>>;
+}>, Schema.Struct<{
+    kind: Schema.Literal<["timer"]>;
+    cron: Schema.SchemaClass<string, string, never>;
+}>, Schema.Struct<{
+    kind: Schema.Literal<["webhook"]>;
+    method: Schema.optional<Schema.SchemaClass<string, string, never>>;
+    port: Schema.optional<Schema.SchemaClass<number, number, never>>;
+}>]>;
+export type Spec = Schema.Schema.Type<typeof Spec>;
+/**
+ * Function trigger.
+ * Function is invoked with the `payload` passed as input data.
+ * The event that triggers the function is available in the function context.
+ */
+declare const TriggerSchema: Type.Obj<{
+    readonly function?: import("@dxos/echo/internal").Ref<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & {
+        readonly [x: string]: any;
+    }> | undefined;
+    readonly inputNodeId?: string | undefined;
+    readonly enabled?: boolean | undefined;
+    readonly spec?: {
+        readonly kind: "email";
+    } | {
+        readonly queue: string;
+        readonly kind: "queue";
+    } | {
+        readonly kind: "subscription";
+        readonly query: {
+            readonly raw?: string | undefined;
+            readonly ast: QueryAST.QuerySelectClause | QueryAST.QueryFilterClause | QueryAST.QueryReferenceTraversalClause | QueryAST.QueryIncomingReferencesClause | QueryAST.QueryRelationClause | QueryAST.QueryRelationTraversalClause | QueryAST.QueryHierarchyTraversalClause | QueryAST.QueryUnionClause | QueryAST.QuerySetDifferenceClause | QueryAST.QueryOrderClause | QueryAST.QueryOptionsClause | QueryAST.QueryLimitClause;
+        };
+        readonly options?: {
+            readonly deep?: boolean | undefined;
+            readonly delay?: number | undefined;
+        } | undefined;
+    } | {
+        readonly kind: "timer";
+        readonly cron: string;
+    } | {
+        readonly kind: "webhook";
+        readonly method?: string | undefined;
+        readonly port?: number | undefined;
+    } | undefined;
+    readonly input?: {
+        readonly [x: string]: any;
+    } | undefined;
+}, Schema.Struct.Fields>;
+export interface Trigger extends Schema.Schema.Type<typeof TriggerSchema> {
+}
+export declare const Trigger: Type.Obj<Trigger>;
+export declare const make: (props: Obj.MakeProps<typeof Trigger>) => Obj.Obj<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & Trigger>;
+export {};
+//# sourceMappingURL=Trigger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Trigger.d.ts","sourceRoot":"","sources":["../../../../src/types/Trigger.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAKjD;;;;GAIG;AACH,eAAO,MAAM,KAAK,iEAAkE,CAAC;AACrF,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;AAI1C,eAAO,MAAM,SAAS;;EAEpB,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,SAAS,CAAC,CAAC;AAE7D,eAAO,MAAM,SAAS;;;EAKpB,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,SAAS,CAAC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;EAc3B,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,SAAS;;;EAMpB,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,SAAS,CAAC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,WAAW;;;;EAatB,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,WAAW,CAAC,CAAC;AAEjE;;GAEG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;IAEf,CAAC;AACH,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;AAEnD;;;;GAIG;AACH,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAsClB,CAAC;AAEF,MAAM,WAAW,OAAQ,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,aAAa,CAAC;CAAG;AAC5E,eAAO,MAAM,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAwB,CAAC;AAE/D,eAAO,MAAM,IAAI,GAAI,OAAO,GAAG,CAAC,SAAS,CAAC,OAAO,OAAO,CAAC,2GAA6B,CAAC"}

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

@@ -0,0 +1,74 @@
+import * as Schema from 'effect/Schema';
+export declare const EmailEvent: Schema.Struct<{
+    from: typeof Schema.String;
+    to: typeof Schema.String;
+    subject: typeof Schema.String;
+    created: typeof Schema.String;
+    body: typeof Schema.String;
+}>;
+export type EmailEvent = Schema.Schema.Type<typeof EmailEvent>;
+export declare const QueueEvent: Schema.Struct<{
+    queue: Schema.refine<string, typeof Schema.NonEmptyString>;
+    item: typeof Schema.Any;
+    cursor: typeof Schema.String;
+}>;
+export type QueueEvent = Schema.Schema.Type<typeof QueueEvent>;
+export declare const SubscriptionEvent: Schema.Struct<{
+    /**
+     * Type of the mutation.
+     */
+    type: typeof Schema.String;
+    /**
+     * Reference to the object that was changed or created.
+     */
+    subject: import("@dxos/echo/internal").RefSchema<any>;
+    /**
+     * @deprecated
+     */
+    changedObjectId: Schema.optional<typeof Schema.String>;
+}>;
+export type SubscriptionEvent = Schema.Schema.Type<typeof SubscriptionEvent>;
+export declare const TimerEvent: Schema.Struct<{
+    tick: typeof Schema.Number;
+}>;
+export type TimerEvent = Schema.Schema.Type<typeof TimerEvent>;
+export declare const WebhookEvent: Schema.Struct<{
+    url: typeof Schema.String;
+    method: Schema.Literal<["GET", "POST"]>;
+    headers: Schema.Record$<typeof Schema.String, typeof Schema.String>;
+    bodyText: typeof Schema.String;
+}>;
+export type WebhookEvent = Schema.Schema.Type<typeof WebhookEvent>;
+export declare const TriggerEvent: Schema.Union<[Schema.Struct<{
+    from: typeof Schema.String;
+    to: typeof Schema.String;
+    subject: typeof Schema.String;
+    created: typeof Schema.String;
+    body: typeof Schema.String;
+}>, Schema.Struct<{
+    queue: Schema.refine<string, typeof Schema.NonEmptyString>;
+    item: typeof Schema.Any;
+    cursor: typeof Schema.String;
+}>, Schema.Struct<{
+    /**
+     * Type of the mutation.
+     */
+    type: typeof Schema.String;
+    /**
+     * Reference to the object that was changed or created.
+     */
+    subject: import("@dxos/echo/internal").RefSchema<any>;
+    /**
+     * @deprecated
+     */
+    changedObjectId: Schema.optional<typeof Schema.String>;
+}>, Schema.Struct<{
+    tick: typeof Schema.Number;
+}>, Schema.Struct<{
+    url: typeof Schema.String;
+    method: Schema.Literal<["GET", "POST"]>;
+    headers: Schema.Record$<typeof Schema.String, typeof Schema.String>;
+    bodyText: typeof Schema.String;
+}>]>;
+export type TriggerEvent = Schema.Schema.Type<typeof TriggerEvent>;
+//# sourceMappingURL=TriggerEvent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TriggerEvent.d.ts","sourceRoot":"","sources":["../../../../src/types/TriggerEvent.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAUxC,eAAO,MAAM,UAAU;;;;;;EAMrB,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,CAAC;AAE/D,eAAO,MAAM,UAAU;;;;EAIrB,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,CAAC;AAE/D,eAAO,MAAM,iBAAiB;IAC5B;;OAEG;;IAIH;;OAEG;;IAGH;;OAEG;;EAEH,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE7E,eAAO,MAAM,UAAU;;EAAyC,CAAC;AACjE,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,CAAC;AAE/D,eAAO,MAAM,YAAY;;;;;EAKvB,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,YAAY,CAAC,CAAC;AAEnE,eAAO,MAAM,YAAY;;;;;;;;;;;IA7BvB;;OAEG;;IAIH;;OAEG;;IAGH;;OAEG;;;;;;;;;IAgBwG,CAAC;AAC9G,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,YAAY,CAAC,CAAC"}

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

@@ -0,0 +1,6 @@
+export * as Function from './Function';
+export * as Script from './Script';
+export * as Trigger from './Trigger';
+export * as TriggerEvent from './TriggerEvent';
+export * from './url';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAC/C,cAAc,OAAO,CAAC"}

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

@@ -0,0 +1,13 @@
+import { type Obj } from '@dxos/echo';
+export declare const FUNCTIONS_META_KEY = "dxos.org/service/function";
+export declare const FUNCTIONS_PRESET_META_KEY = "dxos.org/service/function-preset";
+/**
+ * NOTE: functionId is backend ID, not ECHO object id.
+ */
+export declare const getUserFunctionIdInMetadata: (meta: Obj.ReadonlyMeta) => string | undefined;
+/**
+ * NOTE: functionId is backend ID, not ECHO object id.
+ * Must be called inside Obj.changeMeta() since it mutates the meta.
+ */
+export declare const setUserFunctionIdInMetadata: (meta: Obj.Meta, functionId: string) => void;
+//# sourceMappingURL=url.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../../src/types/url.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAGtC,eAAO,MAAM,kBAAkB,8BAA8B,CAAC;AAE9D,eAAO,MAAM,yBAAyB,qCAAqC,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,2BAA2B,GAAI,MAAM,GAAG,CAAC,YAAY,uBAEjE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,GAAI,MAAM,GAAG,CAAC,IAAI,EAAE,YAAY,MAAM,SAS7E,CAAC"}