@dxos/protocols 0.8.4-main.7ace549 → 0.8.4-main.937b3ca

package/src/buf/proto/gen/example/testing/rpc_pb.ts

@@ -2,7 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-// @generated by protoc-gen-es v2.9.0 with parameter "target=ts,import_extension=js"
+// @generated by protoc-gen-es v2.10.1 with parameter "target=ts,import_extension=js"
 // @generated from file example/testing/rpc.proto (package example.testing.rpc, syntax proto3)
 /* eslint-disable */
 

package/src/edge/EdgeFunctionEnv.ts

@@ -4,6 +4,7 @@
 
 import { type SpaceId } from '@dxos/keys';
 
+import { type CreateDocumentRequest, type CreateDocumentResponse } from '../proto/gen/dxos/echo/service';
 import { type QueryResult, type QueueQuery } from '../queue';
 
 /*
@@ -59,6 +60,7 @@ On Error returns `EdgeEnvelope` with error:
 export interface Env {
   QUEUE_SERVICE: QueueService;
   DATA_SERVICE: DataService;
+  FUNCTIONS_AI_SERVICE: FunctionsAiService;
 }
 
 /**
@@ -72,22 +74,34 @@ export interface ExecutionContext {}
  * Database API for other CF services like functions.
  */
 export interface DataService {
-  getSpaceMeta(ctx: ExecutionContext, spaceId: SpaceId): Promise<SpaceMeta | undefined>;
-  getDocument(ctx: ExecutionContext, spaceId: SpaceId, documentId: string): Promise<RawDocument | undefined>;
+  getSpaceMeta(ctx: ExecutionContext, spaceId: SpaceId): Promise<RpcResult<SpaceMeta | undefined>>;
+  getDocument(ctx: ExecutionContext, spaceId: SpaceId, documentId: string): Promise<RpcResult<RawDocument | undefined>>;
 
-  query(ctx: ExecutionContext, request: QueryRequest): Promise<QueryResponse>;
-  queryDocuments(ctx: ExecutionContext, request: QueryRequest): Promise<QueryDocumentsResponse>;
-  queryReferences(ctx: ExecutionContext, request: QueryReferencesRequest): Promise<QueryReferencesResponse>;
+  query(ctx: ExecutionContext, request: QueryRequest): Promise<RpcResult<QueryResponse>>;
+  queryDocuments(ctx: ExecutionContext, request: QueryRequest): Promise<RpcResult<QueryDocumentsResponse>>;
+  queryReferences(ctx: ExecutionContext, request: QueryReferencesRequest): Promise<RpcResult<QueryReferencesResponse>>;
+
+  createDocument(ctx: ExecutionContext, request: CreateDocumentRequest): Promise<RpcResult<CreateDocumentResponse>>;
 
   // TODO(burdon): Update? Return DocumentEntry?
   changeDocument(ctx: ExecutionContext, spaceId: SpaceId, documentId: string, changes: Uint8Array): Promise<void>;
 }
 
 export interface QueueService {
-  query(ctx: ExecutionContext, queueDXN: string, query: Omit<QueueQuery, 'queueId'>): Promise<QueryResult>;
+  query(ctx: ExecutionContext, queueDXN: string, query: Omit<QueueQuery, 'queueId'>): Promise<RpcResult<QueryResult>>;
   append(ctx: ExecutionContext, queueDXN: string, objects: unknown[]): Promise<void>;
 }
 
+/**
+ * FunctionsAiService API for other CF services like functions.
+ */
+export interface FunctionsAiService {
+  /**
+   * Enables proxying HTTP requests to the AI service from other workers.
+   */
+  fetch(request: Request): Promise<RpcResult<Response>>;
+}
+
 export type ObjectDocumentJson = {
   type?: string;
   objectId: string;
@@ -159,7 +173,21 @@ export type QueryReferencesResponse = {
   references: ObjectReference[];
 };
 
-export type CreateDocumentResponse = {
-  /** Automerge document ID. */
-  documentId: string;
-};
+/**
+ * Cloudflare Workers RPC returns objects/arrays/stubs that may need to be explicitly disposed.
+ *
+ * See: https://developers.cloudflare.com/workers/runtime-apis/rpc/lifecycle/
+ */
+export interface RpcDisposable {
+  /**
+   * Disposes the RPC stub / returned value and releases any server-side resources it references.
+   */
+  [Symbol.dispose](): void;
+}
+
+/**
+ * Wraps a return type so that any non-primitive value is marked as disposable.
+ *
+ * This models Workers RPC behavior where any returned object (including arrays) gets a disposer added.
+ */
+export type RpcResult<T> = T extends object ? T & RpcDisposable : T;

package/src/edge/edge.ts

@@ -23,13 +23,15 @@ export type EdgeSuccess<T> = {
   data: T;
 };
 
-export type SerializedError = {
-  code?: string;
-  message?: string;
-  context?: Record<string, unknown>;
-  stack?: string;
-  cause?: SerializedError;
-};
+const _SerializedError = Schema.Struct({
+  name: Schema.optional(Schema.String),
+  message: Schema.optional(Schema.String),
+  context: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Any })),
+  stack: Schema.optional(Schema.String),
+  cause: Schema.optional(Schema.suspend(() => SerializedError)),
+});
+export interface SerializedError extends Schema.Schema.Type<typeof _SerializedError> {}
+export const SerializedError: Schema.Schema<SerializedError, SerializedError, never> = _SerializedError;
 
 export type EdgeErrorData = { type: string } & Record<string, any>;
 
@@ -37,11 +39,6 @@ export type EdgeErrorData = { type: string } & Record<string, any>;
  * This is the shape of the error response from the Edge service,
  * when the error is gracefully handled, the Response will be an object with this shape and have status code 200.
  */
-// TODO(dmaretskyi): Refactor this type to just be { success: false, error: SerializedError }
-// reason -> error.message
-// cause -> error.cause
-// data.type -> error.code
-// ...data -> error.context
 export type EdgeFailure = {
   /**
    * Branded Type.
@@ -243,20 +240,19 @@ export type UploadFunctionRequest = {
    * Runtime cannot be changed once the function was deployed.
    * @default Runtime.WORKERS_FOR_PLATFORMS
    */
-  runtime?: Runtime;
+  runtime?: FunctionRuntimeKind;
 };
 
 /**
  * Note: Do not change the values of these enums, this values are stored in the FunctionVersions database.
  */
-export enum Runtime {
+export const FunctionRuntimeKind = Schema.Enums({
   // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
-  WORKERS_FOR_PLATFORMS = 'WORKERS_FOR_PLATFORMS',
+  WORKERS_FOR_PLATFORMS: 'WORKERS_FOR_PLATFORMS',
   // https://developers.cloudflare.com/workers/runtime-apis/bindings/worker-loader/
-  WORKER_LOADER = 'WORKER_LOADER',
-  // Local worker dispatcher for testing.
-  TEST = 'TEST',
-}
+  WORKER_LOADER: 'WORKER_LOADER',
+});
+export type FunctionRuntimeKind = Schema.Schema.Type<typeof FunctionRuntimeKind>;
 
 export type UploadFunctionResponseBody = {
   functionId: string;
@@ -419,15 +415,15 @@ const MAX_ERROR_DEPTH = 3;
  */
 export const ErrorCodec = Object.freeze({
   encode: (err: Error, depth: number = 0): SerializedError => ({
-    code: 'code' in err ? (err as any).code : undefined,
+    name: 'name' in err ? err.name : (err as any).code || 'Error',
     message: err.message,
     stack: err.stack,
     cause: err.cause instanceof Error && depth < MAX_ERROR_DEPTH ? ErrorCodec.encode(err.cause, depth + 1) : undefined,
   }),
   decode: (serializedError: SerializedError, depth: number = 0): Error => {
     let err: Error;
-    if (typeof serializedError.code === 'string') {
-      err = new BaseError(serializedError.code, {
+    if (typeof serializedError.name === 'string') {
+      err = new BaseError(serializedError.name, {
         message: serializedError.message ?? 'Unknown error',
         cause:
           serializedError.cause && depth < MAX_ERROR_DEPTH

package/src/errors/base-errors.ts

@@ -12,15 +12,15 @@ import { BaseError } from '@dxos/errors';
  * User facing API Errors.
  * E.g., something was misconfigured.
  */
-export class ApiError extends BaseError.extend('API') {}
+export class ApiError extends BaseError.extend('ApiError') {}
 
 /**
  * Internal system errors.
  * E.g., unexpected/unrecoverable runtime error.
  */
-export class SystemError extends BaseError.extend('SYSTEM') {}
+export class SystemError extends BaseError.extend('SystemError') {}
 
 /**
  * Database errors.
  */
-export class DatabaseError extends BaseError.extend('DATABASE') {}
+export class DatabaseError extends BaseError.extend('DatabaseError') {}

package/src/errors/errors.ts

@@ -13,90 +13,90 @@ import { registerError, registerErrorMessageContext, registerErrorNoArgs } from
  * Thrown when request was terminated because the RPC endpoint has been closed.
  */
 export class RpcClosedError extends BaseError.extend(
-  'RPC_CLOSED',
+  'RpcClosedError',
   'Request was terminated because the RPC endpoint is closed.',
 ) {}
 
-registerErrorNoArgs('RPC_CLOSED', RpcClosedError);
+registerErrorNoArgs('RpcClosedError', RpcClosedError);
 
 /**
  * Thrown when `request` is called when RPC has not been opened.
  */
-export class RpcNotOpenError extends BaseError.extend('RPC_NOT_OPEN', 'RPC has not been opened.') {}
+export class RpcNotOpenError extends BaseError.extend('RpcNotOpenError', 'RPC has not been opened.') {}
 
-registerErrorNoArgs('RPC_NOT_OPEN', RpcNotOpenError);
+registerErrorNoArgs('RpcNotOpenError', RpcNotOpenError);
 
-export class CancelledError extends BaseError.extend('CANCELLED') {}
+export class CancelledError extends BaseError.extend('CancelledError') {}
 
-registerErrorMessageContext('CANCELLED', CancelledError);
+registerErrorMessageContext('CancelledError', CancelledError);
 
-export class InvalidConfigError extends BaseError.extend('INVALID_CONFIG') {}
+export class InvalidConfigError extends BaseError.extend('InvalidConfigError') {}
 
-registerErrorMessageContext('INVALID_CONFIG', InvalidConfigError);
+registerErrorMessageContext('InvalidConfigError', InvalidConfigError);
 
 /**
  * Explicit failure to connect with remote client services.
  */
-export class RemoteServiceConnectionError extends BaseError.extend('REMOTE_SERVICE_CONNECTION_ERROR') {}
+export class RemoteServiceConnectionError extends BaseError.extend('RemoteServiceConnectionError') {}
 
-registerErrorMessageContext('REMOTE_SERVICE_CONNECTION_ERROR', RemoteServiceConnectionError);
+registerErrorMessageContext('RemoteServiceConnectionError', RemoteServiceConnectionError);
 
 /**
  * Failed to open a connection to remote client services.
  */
-export class RemoteServiceConnectionTimeout extends BaseError.extend('REMOTE_SERVICE_CONNECTION_TIMEOUT') {}
+export class RemoteServiceConnectionTimeout extends BaseError.extend('RemoteServiceConnectionTimeout') {}
 
-registerErrorMessageContext('REMOTE_SERVICE_CONNECTION_TIMEOUT', RemoteServiceConnectionTimeout);
+registerErrorMessageContext('RemoteServiceConnectionTimeout', RemoteServiceConnectionTimeout);
 
-export class DataCorruptionError extends BaseError.extend('DATA_CORRUPTION') {}
+export class DataCorruptionError extends BaseError.extend('DataCorruptionError') {}
 
-registerErrorMessageContext('DATA_CORRUPTION', DataCorruptionError);
+registerErrorMessageContext('DataCorruptionError', DataCorruptionError);
 
-export class InvalidInvitationExtensionRoleError extends BaseError.extend('INVALID_INVITATION_EXTENSION_ROLE') {}
+export class InvalidInvitationExtensionRoleError extends BaseError.extend('InvalidInvitationExtensionRoleError') {}
 
-registerErrorMessageContext('INVALID_INVITATION_EXTENSION_ROLE', InvalidInvitationExtensionRoleError);
+registerErrorMessageContext('InvalidInvitationExtensionRoleError', InvalidInvitationExtensionRoleError);
 
-export class IdentityNotInitializedError extends BaseError.extend('IDENTITY_NOT_INITIALIZED') {}
+export class IdentityNotInitializedError extends BaseError.extend('IdentityNotInitializedError') {}
 
-registerErrorMessageContext('IDENTITY_NOT_INITIALIZED', IdentityNotInitializedError);
+registerErrorMessageContext('IdentityNotInitializedError', IdentityNotInitializedError);
 
-export class InvalidInvitationError extends BaseError.extend('INVALID_INVITATION') {}
+export class InvalidInvitationError extends BaseError.extend('InvalidInvitationError') {}
 
-registerErrorMessageContext('INVALID_INVITATION', InvalidInvitationError);
+registerErrorMessageContext('InvalidInvitationError', InvalidInvitationError);
 
-export class AlreadyJoinedError extends BaseError.extend('ALREADY_JOINED') {}
+export class AlreadyJoinedError extends BaseError.extend('AlreadyJoinedError') {}
 
-registerErrorMessageContext('ALREADY_JOINED', AlreadyJoinedError);
+registerErrorMessageContext('AlreadyJoinedError', AlreadyJoinedError);
 
-export class ConnectionResetError extends BaseError.extend('CONNECTION_RESET') {}
+export class ConnectionResetError extends BaseError.extend('ConnectionResetError') {}
 
-registerErrorMessageContext('CONNECTION_RESET', ConnectionResetError);
+registerErrorMessageContext('ConnectionResetError', ConnectionResetError);
 
-export class TimeoutError extends BaseError.extend('TIMEOUT') {}
+export class TimeoutError extends BaseError.extend('TimeoutError') {}
 
-registerErrorMessageContext('TIMEOUT', TimeoutError);
+registerErrorMessageContext('TimeoutError', TimeoutError);
 
 // General protocol error.
-export class ProtocolError extends BaseError.extend('PROTOCOL_ERROR') {}
+export class ProtocolError extends BaseError.extend('ProtocolError') {}
 
-registerErrorMessageContext(ProtocolError.code, ProtocolError);
+registerErrorMessageContext(ProtocolError.name, ProtocolError);
 
 // General connectivity errors.
-export class ConnectivityError extends BaseError.extend('CONNECTIVITY_ERROR') {}
+export class ConnectivityError extends BaseError.extend('ConnectivityError') {}
 
-registerErrorMessageContext('CONNECTIVITY_ERROR', ConnectivityError);
+registerErrorMessageContext('ConnectivityError', ConnectivityError);
 
-export class RateLimitExceededError extends BaseError.extend('RATE_LIMIT_EXCEEDED') {}
+export class RateLimitExceededError extends BaseError.extend('RateLimitExceededError') {}
 
-registerErrorMessageContext('RATE_LIMIT_EXCEEDED', RateLimitExceededError);
+registerErrorMessageContext('RateLimitExceededError', RateLimitExceededError);
 
 // TODO(nf): Rename? the protocol isn't what's unknown...
-export class UnknownProtocolError extends BaseError.extend('UNKNOWN_PROTOCOL_ERROR') {}
+export class UnknownProtocolError extends BaseError.extend('UnknownProtocolError') {}
 
-registerError(UnknownProtocolError.code, (message, context) => new UnknownProtocolError({ message, context }));
+registerError(UnknownProtocolError.name, (message, context) => new UnknownProtocolError({ message, context }));
 
 export class InvalidStorageVersionError extends BaseError.extend(
-  'INVALID_STORAGE_VERSION',
+  'InvalidStorageVersionError',
   'Invalid storage version.',
 ) {
   constructor(expected: number, actual: number) {
@@ -104,40 +104,40 @@ export class InvalidStorageVersionError extends BaseError.extend(
   }
 }
 
-registerError('INVALID_STORAGE_VERSION', (_, context) => {
+registerError('InvalidStorageVersionError', (_, context) => {
   return new InvalidStorageVersionError(context.expected ?? NaN, context.actual ?? NaN);
 });
 
-export class SpaceNotFoundError extends BaseError.extend('SPACE_NOT_FOUND', 'Space not found.') {
+export class SpaceNotFoundError extends BaseError.extend('SpaceNotFoundError', 'Space not found.') {
   constructor(spaceKey: PublicKey) {
     super({ context: { spaceKey } });
   }
 }
 
-registerError('SPACE_NOT_FOUND', (_, context) => {
+registerError('SpaceNotFoundError', (_, context) => {
   return new SpaceNotFoundError(PublicKey.safeFrom(context.spaceKey) ?? PublicKey.from('00'));
 });
 
-export class EntityNotFoundError extends BaseError.extend('ITEM_NOT_FOUND', 'Item not found.') {
+export class EntityNotFoundError extends BaseError.extend('EntityNotFoundError', 'Item not found.') {
   constructor(entityId: ObjectId) {
     super({ context: { entityId } });
   }
 }
 
-registerError('ITEM_NOT_FOUND', (_, context) => {
+registerError('EntityNotFoundError', (_, context) => {
   return new EntityNotFoundError(context.entityId);
 });
 
-export class UnknownModelError extends BaseError.extend('UNKNOWN_MODEL', 'Unknown model.') {
+export class UnknownModelError extends BaseError.extend('UnknownModelError', 'Unknown model.') {
   constructor(model: string) {
     super({ context: { model } });
   }
 }
 
-registerError('UNKNOWN_MODEL', (_, context) => {
+registerError('UnknownModelError', (_, context) => {
   return new UnknownModelError(context.model);
 });
 
-export class AuthorizationError extends BaseError.extend('AUTHORIZATION_ERROR') {}
+export class AuthorizationError extends BaseError.extend('AuthorizationError') {}
 
-registerErrorMessageContext('AUTHORIZATION_ERROR', AuthorizationError);
+registerErrorMessageContext('AuthorizationError', AuthorizationError);

package/src/index.ts

@@ -10,7 +10,6 @@ export * from './errors/index.js';
 export * from './indexing.js';
 export * from './messenger.js';
 export * from './profile-archive.js';
-export * from './query.js';
 export * from './queue.js';
 export * from './space-archive.js';
 export * from './storage.js';

package/src/proto/dxos/client/queue.proto

@@ -0,0 +1,67 @@
+syntax = "proto3";
+
+package dxos.client.services;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+
+
+message QueueQuery {
+  string space_id = 1;
+
+  optional string queues_namespace = 2;
+
+  /// Queries the whole space if missing.
+  repeated string queue_ids = 3;
+
+  /// Filter items after this cursor. Exclusive.
+  optional string after = 4;
+
+  /// Filter items before this cursor. Exclusive.
+  optional string before = 5;
+
+  /// Filter items after this position. Inclusive.
+  optional int64 begin_position = 6;
+
+  /// Filter items before this position. Exclusive.
+  optional int64 end_position = 7;
+
+  optional int32 limit = 8;
+  optional bool reverse = 9;
+
+  // TODO(dmaretskyi): Remove this field -- raw queues dont index object IDs anymore.
+  repeated string object_ids = 100;
+}
+
+message QueueQueryResult {
+  repeated google.protobuf.Struct objects = 1;
+
+  /// Cursor to query the next items. Can be passed to `after` in query to keep querying. 
+  string next_cursor = 2;
+
+  string prev_cursor = 3;
+}
+
+message QueryQueueRequest {
+  QueueQuery query = 1;
+}
+
+message InsertIntoQueueRequest {
+  string subspace_tag = 1;
+  string space_id = 2;
+  string queue_id = 3;
+  repeated google.protobuf.Struct objects = 4;
+}
+
+message DeleteFromQueueRequest {
+  string subspace_tag = 1;
+  string space_id = 2;
+  string queue_id = 3;
+  repeated string object_ids = 4;
+}
+
+service QueueService {
+  rpc QueryQueue(QueryQueueRequest) returns (QueueQueryResult);
+  rpc InsertIntoQueue(InsertIntoQueueRequest) returns (google.protobuf.Empty);
+  rpc DeleteFromQueue(DeleteFromQueueRequest) returns (google.protobuf.Empty);
+}

package/src/proto/dxos/config.proto

@@ -155,6 +155,8 @@ message Runtime {
     optional bool enable_vector_indexing = 12;
 
     optional EdgeFeatures edge_features = 11;
+
+    optional bool enable_local_queues = 13;
   }
 
   message App {

package/src/proto/dxos/echo/query.proto

@@ -36,9 +36,12 @@ message Heads {
 message QueryResult {
   string id = 1;
   string spaceId = 4;
-  string documentId = 5;
+  optional string documentId = 5;
+  optional string queueId = 6;
+  optional string queueNamespace = 7;
   float rank = 3;
 
+  /// In the ECHO Json object format.
   optional string document_json = 10;
   optional bytes document_automerge = 11;
   

package/src/proto/dxos/echo/service.proto

@@ -6,6 +6,7 @@ syntax = "proto3";
 
 import "dxos/keys.proto";
 import "google/protobuf/empty.proto";
+import "google/protobuf/struct.proto";
 
 package dxos.echo.service;
 
@@ -61,12 +62,6 @@ message DocumentUpdate {
    * Value returned by `Automerge.saveSince()`.
    */
   bytes mutation = 2;
-
-  /**
-   * Set to true for init mutation of document.
-   * default: undefined.
-   */
-   optional bool is_new = 3;
 }
 
 message DocHeadsList {
@@ -94,6 +89,26 @@ message ReIndexHeadsRequest {
   repeated string document_ids = 1;
 }
 
+message CreateDocumentRequest {
+  /**
+   * Space id where the document will be created.
+   */
+  string space_id = 1;
+
+  /**
+   * Automerge encoded initial document value.
+   * Optional - if not provided, an empty document will be created.
+   */
+  optional google.protobuf.Struct initial_value = 2;
+}
+
+message CreateDocumentResponse {
+  /**
+   * The generated document id.
+   */
+  string document_id = 1;
+}
+
 message GetSpaceSyncStateRequest {
   string space_id = 1;
 }
@@ -157,6 +172,12 @@ service DataService {
    */
   rpc UpdateSubscription(UpdateSubscriptionRequest) returns (google.protobuf.Empty);
 
+  /**
+   * Create a new automerge document.
+   * Returns the generated document id which is controlled by the host.
+   */
+   rpc CreateDocument(CreateDocumentRequest) returns (CreateDocumentResponse);
+
   /**
    * Write incremental updates to multiple automerge documents.
    * Used to propagate changes from client to services.

package/src/proto/dxos/iframe.proto

@@ -39,6 +39,7 @@ message AppContextRequest {
   /// The key of the joined space.
   optional dxos.keys.PublicKey space_key = 2;
 
+  // TODO(wittjosiah): Make the generated type be `SpaceId`.
   /// The id of the joined space.
   optional string space_id = 5;