@dxos/functions 0.8.4-main.dedc0f3 → 0.8.4-main.dfabb4ec29

package/src/errors.ts

@@ -1,21 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { BaseError } from '@dxos/errors';
-
-export class ServiceNotAvailableError extends BaseError.extend('SERVICE_NOT_AVAILABLE') {
-  constructor(serviceName: string) {
-    super(`Service not available: ${serviceName}`);
-  }
-}
-
-export class FunctionNotFoundError extends BaseError.extend('FUNCTION_NOT_FOUND') {
-  constructor(functionKey: string) {
-    super(`Function not found: ${functionKey}`);
-  }
-}
-
-export class FunctionError extends BaseError.extend('FUNCTION_ERROR') {}
-
-export class TriggerStateNotFoundError extends BaseError.extend('TRIGGER_STATE_NOT_FOUND') {}

package/src/examples/fib.ts

@@ -1,30 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Effect, Schema } from 'effect';
-
-import { defineFunction } from '../handler';
-
-export default defineFunction({
-  name: 'example.org/function/fib',
-  description: 'Function that calculates a Fibonacci number',
-  inputSchema: Schema.Struct({
-    iterations: Schema.optional(Schema.Number).annotations({
-      description: 'Number of iterations',
-      default: 100_000,
-    }),
-  }),
-  outputSchema: Schema.Struct({
-    result: Schema.String,
-  }),
-  handler: Effect.fn(function* ({ data: { iterations = 100_000 } }) {
-    let a = 0n;
-    let b = 1n;
-    for (let i = 0; i < iterations; i++) {
-      a += b;
-      b = a - b;
-    }
-    return { result: a.toString() };
-  }),
-});

package/src/examples/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export { default as fib } from './fib';
-export { default as reply } from './reply';
-export { default as sleep } from './sleep';

package/src/examples/reply.ts

@@ -1,18 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Console, Effect, Schema } from 'effect';
-
-import { defineFunction } from '../handler';
-
-export default defineFunction({
-  name: 'example.org/function/reply',
-  description: 'Function that echoes the input',
-  inputSchema: Schema.Any,
-  outputSchema: Schema.Any,
-  handler: Effect.fn(function* ({ data }) {
-    yield* Console.log('reply', { data });
-    return data;
-  }),
-});

package/src/examples/sleep.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Effect, Schema } from 'effect';
-
-import { defineFunction } from '../handler';
-
-export default defineFunction({
-  name: 'example.org/function/sleep',
-  description: 'Function that sleeps for a given amount of time',
-  inputSchema: Schema.Struct({
-    duration: Schema.optional(Schema.Number).annotations({
-      description: 'Milliseconds to sleep',
-      default: 100_000,
-    }),
-  }),
-  outputSchema: Schema.Void,
-  handler: Effect.fn(function* ({ data: { duration = 100_000 } }) {
-    yield* Effect.sleep(duration);
-  }),
-});

package/src/executor/executor.ts

@@ -1,54 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Effect, Schema } from 'effect';
-
-import { type SpaceId } from '@dxos/client/echo';
-import { runAndForwardErrors } from '@dxos/effect';
-
-import type { FunctionContext, FunctionDefinition } from '../handler';
-import type { ServiceContainer, Services } from '../services';
-
-export class FunctionExecutor {
-  constructor(private readonly _services: ServiceContainer) {}
-
-  /**
-   * Invoke function.
-   */
-  // TODO(dmaretskyi): Invocation context: queue, space, etc...
-  async invoke<F extends FunctionDefinition<any, any>>(
-    functionDef: F,
-    input: F extends FunctionDefinition<infer I, infer _O> ? I : never,
-  ): Promise<F extends FunctionDefinition<infer _I, infer O> ? O : never> {
-    // Assert input matches schema
-    const assertInput = functionDef.inputSchema.pipe(Schema.asserts);
-    (assertInput as any)(input);
-
-    const context: FunctionContext = {
-      space: undefined,
-      getService: this._services.getService.bind(this._services),
-      getSpace: async (_spaceId: SpaceId) => {
-        throw new Error('Not available. Use the database service instead.');
-      },
-    };
-
-    const result = functionDef.handler({ context, data: input });
-
-    let data: unknown;
-    if (Effect.isEffect(result)) {
-      data = await (result as Effect.Effect<unknown, unknown, Services>).pipe(
-        Effect.provide(this._services.createLayer()),
-        runAndForwardErrors,
-      );
-    } else {
-      data = await result;
-    }
-
-    // Assert output matches schema
-    const assertOutput = functionDef.outputSchema?.pipe(Schema.asserts);
-    (assertOutput as any)(data);
-
-    return data as any;
-  }
-}

package/src/handler.ts

@@ -1,201 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Context, Effect, Schema, type Types } from 'effect';
-
-import { Obj, Type } from '@dxos/echo';
-import { type EchoDatabase } from '@dxos/echo-db';
-import { type HasId } from '@dxos/echo-schema';
-import { assertArgument } from '@dxos/invariant';
-import { type DXN, type SpaceId } from '@dxos/keys';
-import { type QueryResult } from '@dxos/protocols';
-
-import { FunctionType } from './schema';
-import { type Services } from './services';
-
-// TODO(burdon): Model after http request. Ref Lambda/OpenFaaS.
-// https://docs.aws.amazon.com/lambda/latest/dg/typescript-handler.html
-// https://www.serverless.com/framework/docs/providers/aws/guide/serverless.yml/#functions
-// https://www.npmjs.com/package/aws-lambda
-
-/**
- * Function handler.
- */
-export type FunctionHandler<TData = {}, TOutput = any> = (params: {
-  /**
-   * Services and context available to the function.
-   */
-  context: FunctionContext;
-
-  /**
-   * Data passed as the input to the function.
-   * Must match the function's input schema.
-   * This will be the payload from the trigger or other data passed into the function in a workflow.
-   */
-  data: TData;
-}) => TOutput | Promise<TOutput> | Effect.Effect<TOutput, any, Services>;
-
-/**
- * Function context.
- */
-export interface FunctionContext {
-  /**
-   * Space from which the function was invoked.
-   */
-  space: SpaceAPI | undefined;
-
-  /**
-   * Resolves a service available to the function.
-   * @throws if the service is not available.
-   */
-  getService: <T extends Context.Tag<any, any>>(tag: T) => Context.Tag.Service<T>;
-
-  getSpace: (spaceId: SpaceId) => Promise<SpaceAPI>;
-}
-
-export interface FunctionContextAi {
-  // TODO(dmaretskyi): Refer to cloudflare AI docs for more comprehensive typedefs.
-  run(model: string, inputs: any, options?: any): Promise<any>;
-}
-
-//
-// API.
-//
-
-// TODO(dmaretskyi): Temporary API to get the queues working.
-// TODO(dmaretskyi): To be replaced with integrating queues into echo.
-export interface QueuesAPI {
-  queryQueue(queue: DXN, options?: {}): Promise<QueryResult>;
-  insertIntoQueue(queue: DXN, objects: HasId[]): Promise<void>;
-}
-
-/**
- * Space interface available to functions.
- */
-export interface SpaceAPI {
-  get id(): SpaceId;
-  get db(): EchoDatabase;
-
-  // TODO(dmaretskyi): Align with echo api: queues.get(id).append(items);
-  get queues(): QueuesAPI;
-}
-
-// TODO(wittjosiah): Queues are incompatible.
-const __assertFunctionSpaceIsCompatibleWithTheClientSpace = () => {
-  // const _: SpaceAPI = {} as Space;
-};
-
-const typeId = Symbol.for('@dxos/functions/FunctionDefinition');
-
-export type FunctionDefinition<T = any, O = any> = {
-  [typeId]: true;
-  // TODO(dmaretskyi): Use `key` for FQN and `name` for human-readable-name.
-  key: string;
-  name: string;
-  description?: string;
-  inputSchema: Schema.Schema<T, any>;
-  outputSchema?: Schema.Schema<O, any>;
-  handler: FunctionHandler<T, O>;
-};
-
-export const defineFunction: {
-  <I, O>(params: {
-    // TODO(dmaretskyi): Make `key` required.
-    key?: string;
-    name: string;
-    description?: string;
-    inputSchema: Schema.Schema<I, any>;
-    outputSchema?: Schema.Schema<O, any>;
-    handler: Types.NoInfer<FunctionHandler<I, O>>;
-  }): FunctionDefinition<I, O>;
-} = ({ key, name, description, inputSchema, outputSchema = Schema.Any, handler }) => {
-  if (!Schema.isSchema(inputSchema)) {
-    throw new Error('Input schema must be a valid schema');
-  }
-  if (typeof handler !== 'function') {
-    throw new Error('Handler must be a function');
-  }
-
-  // Captures the function definition location.
-  const limit = Error.stackTraceLimit;
-  Error.stackTraceLimit = 2;
-  const traceError = new Error();
-  Error.stackTraceLimit = limit;
-  let cache: false | string = false;
-  const captureStackTrace = () => {
-    if (cache !== false) {
-      return cache;
-    }
-    if (traceError.stack !== undefined) {
-      const stack = traceError.stack.split('\n');
-      if (stack[2] !== undefined) {
-        cache = stack[2].trim();
-        return cache;
-      }
-    }
-  };
-
-  const handlerWithSpan = (...args: any[]) => {
-    const result = (handler as any)(...args);
-    if (Effect.isEffect(result)) {
-      return Effect.withSpan(result, `${key ?? name}`, {
-        captureStackTrace,
-      });
-    }
-    return result;
-  };
-
-  return {
-    [typeId]: true,
-    key: key ?? name,
-    name,
-    description,
-    inputSchema,
-    outputSchema,
-    handler: handlerWithSpan,
-  };
-};
-
-export const FunctionDefinition = {
-  make: defineFunction,
-  isFunction: (value: unknown): value is FunctionDefinition.Any => {
-    return typeof value === 'object' && value !== null && Symbol.for('@dxos/functions/FunctionDefinition') in value;
-  },
-  serialize: (functionDef: FunctionDefinition.Any): FunctionType => {
-    assertArgument(FunctionDefinition.isFunction(functionDef), 'functionDef');
-    return serializeFunction(functionDef);
-  },
-  deserialize: (functionObj: FunctionType): FunctionDefinition.Any => {
-    assertArgument(Obj.instanceOf(FunctionType, functionObj), 'functionObj');
-    return deserializeFunction(functionObj);
-  },
-};
-export declare namespace FunctionDefinition {
-  export type Any = FunctionDefinition<any, any>;
-  export type Input<T extends FunctionDefinition> = T extends FunctionDefinition<infer I, any> ? I : never;
-  export type Output<T extends FunctionDefinition> = T extends FunctionDefinition<any, infer O> ? O : never;
-}
-
-export const serializeFunction = (functionDef: FunctionDefinition<any, any>): FunctionType =>
-  Obj.make(FunctionType, {
-    key: functionDef.name,
-    name: functionDef.name,
-    version: '0.1.0',
-    description: functionDef.description,
-    inputSchema: Type.toJsonSchema(functionDef.inputSchema),
-    outputSchema: !functionDef.outputSchema ? undefined : Type.toJsonSchema(functionDef.outputSchema),
-  });
-
-export const deserializeFunction = (functionObj: FunctionType): FunctionDefinition<unknown, unknown> => {
-  return {
-    [typeId]: true,
-    // TODO(dmaretskyi): Fix key.
-    key: functionObj.key ?? functionObj.name,
-    name: functionObj.name,
-    description: functionObj.description,
-    inputSchema: !functionObj.inputSchema ? Schema.Unknown : Type.toEffectSchema(functionObj.inputSchema),
-    outputSchema: !functionObj.outputSchema ? undefined : Type.toEffectSchema(functionObj.outputSchema),
-    handler: () => {},
-  };
-};

package/src/schema.ts

@@ -1,68 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Schema } from 'effect';
-
-import { Type } from '@dxos/echo';
-import { JsonSchemaType, LabelAnnotation, Ref } from '@dxos/echo-schema';
-import { DataType } from '@dxos/schema';
-
-/**
- * Source script.
- */
-export const ScriptType = Schema.Struct({
-  name: Schema.optional(Schema.String),
-  description: Schema.optional(Schema.String),
-  // TODO(burdon): Change to hash of deployed content.
-  // Whether source has changed since last deploy.
-  changed: Schema.optional(Schema.Boolean),
-  source: Ref(DataType.Text),
-}).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Script',
-    version: '0.1.0',
-  }),
-  LabelAnnotation.set(['name']),
-);
-
-export interface ScriptType extends Schema.Schema.Type<typeof ScriptType> {}
-
-/**
- * Function deployment.
- */
-export const FunctionType = Schema.Struct({
-  /**
-   * Global registry ID.
-   * NOTE: The `key` property refers to the original registry entry.
-   */
-  // TODO(burdon): Create Format type for DXN-like ids, such as this and schema type.
-  // TODO(dmaretskyi): Consider making it part of ECHO meta.
-  // TODO(dmaretskyi): Make required.
-  key: Schema.optional(Schema.String).annotations({
-    description: 'Unique registration key for the blueprint',
-  }),
-
-  // TODO(burdon): Rename to id/uri?
-  name: Schema.NonEmptyString,
-  version: Schema.String,
-
-  description: Schema.optional(Schema.String),
-
-  // Reference to a source script if it exists within ECHO.
-  // TODO(burdon): Don't ref ScriptType directly (core).
-  source: Schema.optional(Ref(ScriptType)),
-
-  inputSchema: Schema.optional(JsonSchemaType),
-  outputSchema: Schema.optional(JsonSchemaType),
-
-  // Local binding to a function name.
-  binding: Schema.optional(Schema.String),
-}).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Function',
-    version: '0.1.0',
-  }),
-  LabelAnnotation.set(['name']),
-);
-export interface FunctionType extends Schema.Schema.Type<typeof FunctionType> {}

package/src/services/database.ts

@@ -1,170 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Context, Effect, Layer, Option, type Schema } from 'effect';
-
-import { type Filter, type Live, Obj, type Query, type Ref, type Relation, type Type } from '@dxos/echo';
-import type { EchoDatabase, FlushOptions, OneShotQueryResult, QueryResult, SchemaRegistryQuery } from '@dxos/echo-db';
-import type { SchemaRegistryPreparedQuery } from '@dxos/echo-db';
-import type { EchoSchema } from '@dxos/echo-schema';
-import { promiseWithCauseCapture } from '@dxos/effect';
-import { BaseError } from '@dxos/errors';
-import { invariant } from '@dxos/invariant';
-import type { DXN } from '@dxos/keys';
-
-export class DatabaseService extends Context.Tag('@dxos/functions/DatabaseService')<
-  DatabaseService,
-  {
-    readonly db: EchoDatabase;
-  }
->() {
-  static notAvailable = Layer.succeed(DatabaseService, {
-    get db(): EchoDatabase {
-      throw new Error('Database not available');
-    },
-  });
-
-  static make = (db: EchoDatabase): Context.Tag.Service<DatabaseService> => {
-    return {
-      get db() {
-        return db;
-      },
-    };
-  };
-
-  static layer = (db: EchoDatabase): Layer.Layer<DatabaseService> => {
-    return Layer.succeed(DatabaseService, DatabaseService.make(db));
-  };
-
-  /**
-   * Resolves an object by its DXN.
-   */
-  static resolve: {
-    // No type check.
-    (dxn: DXN): Effect.Effect<Obj.Any | Relation.Any, never, DatabaseService>;
-    // Check matches schema.
-    <S extends Type.Obj.Any | Type.Relation.Any>(
-      dxn: DXN,
-      schema: S,
-    ): Effect.Effect<Schema.Schema.Type<S>, ObjectNotFoundError, DatabaseService>;
-  } = (<S extends Type.Obj.Any | Type.Relation.Any>(
-    dxn: DXN,
-    schema?: S,
-  ): Effect.Effect<Schema.Schema.Type<S>, ObjectNotFoundError, DatabaseService> =>
-    Effect.gen(function* () {
-      const { db } = yield* DatabaseService;
-      const object = yield* promiseWithCauseCapture(() =>
-        db.graph
-          .createRefResolver({
-            context: {
-              space: db.spaceId,
-            },
-          })
-          .resolve(dxn),
-      );
-
-      if (!object) {
-        return yield* Effect.fail(new ObjectNotFoundError({ dxn }));
-      }
-      invariant(!schema || Obj.instanceOf(schema, object), 'Object type mismatch.');
-      return object as any;
-    })) as any;
-
-  /**
-   * Loads an object reference.
-   */
-  static load: <T>(ref: Ref.Ref<T>) => Effect.Effect<T, ObjectNotFoundError, never> = Effect.fn(function* (ref) {
-    const object = yield* promiseWithCauseCapture(() => ref.tryLoad());
-    if (!object) {
-      return yield* Effect.fail(new ObjectNotFoundError({ dxn: ref.dxn }));
-    }
-    return object;
-  });
-
-  /**
-   * Loads an object reference option.
-   */
-  // TODO(burdon): Option?
-  static loadOption: <T>(ref: Ref.Ref<T>) => Effect.Effect<Option.Option<T>, never, never> = Effect.fn(function* (ref) {
-    const object = yield* DatabaseService.load(ref).pipe(
-      Effect.catchTag('OBJECT_NOT_FOUND', () => Effect.succeed(undefined)),
-    );
-    return Option.fromNullable(object);
-  });
-
-  // TODO(burdon): Can we create a proxy for the following methods on EchoDatabase? Use @inheritDoc?
-  // TODO(burdon): Figure out how to chain query().run();
-
-  /**
-   * @link EchoDatabase.add
-   */
-  static add = <T extends Obj.Any | Relation.Any>(obj: T): Effect.Effect<T, never, DatabaseService> =>
-    DatabaseService.pipe(Effect.map(({ db }) => db.add(obj)));
-
-  /**
-   * @link EchoDatabase.remove
-   */
-  static remove = <T extends Obj.Any | Relation.Any>(obj: T): Effect.Effect<void, never, DatabaseService> =>
-    DatabaseService.pipe(Effect.map(({ db }) => db.remove(obj)));
-
-  /**
-   * @link EchoDatabase.flush
-   */
-  static flush = (opts?: FlushOptions) =>
-    DatabaseService.pipe(Effect.flatMap(({ db }) => promiseWithCauseCapture(() => db.flush(opts))));
-
-  /**
-   * @link EchoDatabase.getObjectById
-   */
-  static getObjectById = <T extends Obj.Any | Relation.Any>(
-    id: string,
-  ): Effect.Effect<Live<T> | undefined, never, DatabaseService> => {
-    return DatabaseService.pipe(Effect.map(({ db }) => db.getObjectById(id)));
-  };
-
-  /**
-   * Creates a `QueryResult` object that can be subscribed to.
-   */
-  static query: {
-    <Q extends Query.Any>(query: Q): Effect.Effect<QueryResult<Live<Query.Type<Q>>>, never, DatabaseService>;
-    <F extends Filter.Any>(filter: F): Effect.Effect<QueryResult<Live<Filter.Type<F>>>, never, DatabaseService>;
-  } = (queryOrFilter: Query.Any | Filter.Any) =>
-    DatabaseService.pipe(
-      Effect.map(({ db }) => db.query(queryOrFilter as any)),
-      Effect.withSpan('DatabaseService.query'),
-    );
-
-  /**
-   * Executes the query once and returns the results.
-   */
-  static runQuery: {
-    <Q extends Query.Any>(query: Q): Effect.Effect<OneShotQueryResult<Live<Query.Type<Q>>>, never, DatabaseService>;
-    <F extends Filter.Any>(filter: F): Effect.Effect<OneShotQueryResult<Live<Filter.Type<F>>>, never, DatabaseService>;
-  } = (queryOrFilter: Query.Any | Filter.Any) =>
-    DatabaseService.query(queryOrFilter as any).pipe(
-      Effect.flatMap((queryResult) => promiseWithCauseCapture(() => queryResult.run())),
-    );
-
-  static schemaQuery = <Q extends SchemaRegistryQuery>(
-    query: Q,
-  ): Effect.Effect<SchemaRegistryPreparedQuery<EchoSchema>, never, DatabaseService> =>
-    DatabaseService.pipe(
-      Effect.map(({ db }) => db.schemaRegistry.query(query)),
-      Effect.withSpan('DatabaseService.schemaQuery'),
-    );
-
-  static runSchemaQuery = <Q extends SchemaRegistryQuery>(
-    query: Q,
-  ): Effect.Effect<EchoSchema[], never, DatabaseService> =>
-    DatabaseService.schemaQuery(query).pipe(
-      Effect.flatMap((queryResult) => promiseWithCauseCapture(() => queryResult.run())),
-    );
-}
-
-// TODO(burdon): Move to echo/errors.
-class ObjectNotFoundError extends BaseError.extend('OBJECT_NOT_FOUND') {
-  constructor(context?: Record<string, unknown>) {
-    super('Object not found', { context });
-  }
-}