@dxos/functions 0.8.1 → 0.8.2-main.10c050d

package/src/types/schema.ts

@@ -1,46 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { EchoObject, JsonSchemaType, LabelAnnotationId, Ref, S, TypedObject } from '@dxos/echo-schema';
-import { TextType } from '@dxos/schema';
-
-/**
- * Source script.
- */
-export const ScriptType = S.Struct({
-  name: S.optional(S.String),
-  description: S.optional(S.String),
-  // TODO(burdon): Change to hash of deployed content.
-  // Whether source has changed since last deploy.
-  changed: S.optional(S.Boolean),
-  source: Ref(TextType),
-})
-  .annotations({ [LabelAnnotationId]: 'name' })
-  .pipe(EchoObject({ typename: 'dxos.org/type/Script', version: '0.1.0' }));
-
-export type ScriptType = S.Schema.Type<typeof ScriptType>;
-
-/**
- * Function deployment.
- */
-export class FunctionType extends TypedObject({
-  typename: 'dxos.org/type/Function',
-  version: '0.1.0',
-})({
-  // TODO(burdon): Rename to id/uri?
-  name: S.NonEmptyString,
-  version: S.String,
-
-  description: S.optional(S.String),
-
-  // Reference to a source script if it exists within ECHO.
-  // TODO(burdon): Don't ref ScriptType directly (core).
-  source: S.optional(Ref(ScriptType)),
-
-  inputSchema: S.optional(JsonSchemaType),
-  outputSchema: S.optional(JsonSchemaType),
-
-  // Local binding to a function name.
-  binding: S.optional(S.String),
-}) {}

package/src/types/types.ts

@@ -1,163 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { AST, OptionsAnnotationId, RawObject, S, TypedObject, DXN } from '@dxos/echo-schema';
-
-/**
- * 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 enum TriggerKind {
-  Timer = 'timer',
-  Webhook = 'webhook',
-  Subscription = 'subscription',
-  Email = 'email',
-  Queue = 'queue',
-}
-
-// TODO(burdon): Rename prop kind.
-const typeLiteralAnnotations = { [AST.TitleAnnotationId]: 'Type' };
-
-/**
- * Cron timer.
- */
-const TimerTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Timer).annotations(typeLiteralAnnotations),
-  cron: S.String.annotations({
-    [AST.TitleAnnotationId]: 'Cron',
-    [AST.ExamplesAnnotationId]: ['0 0 * * *'],
-  }),
-}).pipe(S.mutable);
-
-export type TimerTrigger = S.Schema.Type<typeof TimerTriggerSchema>;
-
-const EmailTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Email).annotations(typeLiteralAnnotations),
-}).pipe(S.mutable);
-
-export type EmailTrigger = S.Schema.Type<typeof EmailTriggerSchema>;
-
-const QueueTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Queue).annotations(typeLiteralAnnotations),
-  queue: DXN,
-}).pipe(S.mutable);
-
-export type QueueTrigger = S.Schema.Type<typeof QueueTriggerSchema>;
-
-/**
- * Webhook.
- */
-const WebhookTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Webhook).annotations(typeLiteralAnnotations),
-  method: S.optional(
-    S.String.annotations({
-      [AST.TitleAnnotationId]: 'Method',
-      [OptionsAnnotationId]: ['GET', 'POST'],
-    }),
-  ),
-  port: S.optional(
-    S.Number.annotations({
-      [AST.TitleAnnotationId]: 'Port',
-    }),
-  ),
-}).pipe(S.mutable);
-
-export type WebhookTrigger = S.Schema.Type<typeof WebhookTriggerSchema>;
-
-// TODO(burdon): Use ECHO definition (from https://github.com/dxos/dxos/pull/8233).
-const QuerySchema = S.Struct({
-  type: S.optional(S.String.annotations({ [AST.TitleAnnotationId]: 'Type' })),
-  props: S.optional(S.Record({ key: S.String, value: S.Any })),
-}).annotations({ [AST.TitleAnnotationId]: 'Query' });
-
-/**
- * Subscription.
- */
-const SubscriptionTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Subscription).annotations(typeLiteralAnnotations),
-  // TODO(burdon): Define query DSL (from ECHO). Reconcile with Table.Query.
-  filter: QuerySchema,
-  options: S.optional(
-    S.Struct({
-      // Watch changes to object (not just creation).
-      deep: S.optional(S.Boolean.annotations({ [AST.TitleAnnotationId]: 'Nested' })),
-      // Debounce changes (delay in ms).
-      delay: S.optional(S.Number.annotations({ [AST.TitleAnnotationId]: 'Delay' })),
-    }).annotations({ [AST.TitleAnnotationId]: 'Options' }),
-  ),
-}).pipe(S.mutable);
-
-export type SubscriptionTrigger = S.Schema.Type<typeof SubscriptionTriggerSchema>;
-
-/**
- * Trigger schema (discriminated union).
- */
-export const TriggerSchema = S.Union(
-  TimerTriggerSchema,
-  WebhookTriggerSchema,
-  SubscriptionTriggerSchema,
-  EmailTriggerSchema,
-  QueueTriggerSchema,
-).annotations({
-  [AST.TitleAnnotationId]: 'Trigger',
-});
-
-export type TriggerType = S.Schema.Type<typeof TriggerSchema>;
-
-/**
- * Function trigger.
- */
-export const FunctionTriggerSchema = S.Struct({
-  // TODO(burdon): What type does this reference.
-  // TODO(wittjosiah): This should probably be a Ref?
-  function: S.optional(S.String.annotations({ [AST.TitleAnnotationId]: 'Function' })),
-
-  enabled: S.optional(S.Boolean.annotations({ [AST.TitleAnnotationId]: 'Enabled' })),
-
-  // TODO(burdon): Flatten entire schema.
-  spec: S.optional(TriggerSchema),
-
-  // TODO(burdon): Get schema as partial from function.
-  // TODO(wittjosiah): Rename to payload.
-  // The `meta` property is merged into the event data passed to the function.
-  meta: S.optional(S.mutable(S.Record({ key: S.String, value: S.Any }))),
-});
-
-export type FunctionTriggerType = S.Schema.Type<typeof FunctionTriggerSchema>;
-
-/**
- * Function trigger.
- */
-export class FunctionTrigger extends TypedObject({
-  typename: 'dxos.org/type/FunctionTrigger',
-  version: '0.1.0',
-})(FunctionTriggerSchema.fields) {}
-
-/**
- * Function definition.
- * @deprecated (Use dxos.org/type/Function)
- */
-// TODO(burdon): Reconcile with FunctionType.
-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,
-  handler: S.String,
-}) {}
-
-/**
- * Function manifest file.
- */
-export const FunctionManifestSchema = S.Struct({
-  functions: S.optional(S.mutable(S.Array(RawObject(FunctionDef)))),
-  triggers: S.optional(S.mutable(S.Array(RawObject(FunctionTrigger)))),
-});
-
-export type FunctionManifest = S.Schema.Type<typeof FunctionManifestSchema>;
-
-export const FUNCTION_TYPES = [FunctionDef, FunctionTrigger];