@dxos/protocols 0.8.4-main.f9ba587 → 0.8.4-main.fcfe5033a5

package/dist/src/edge/edge.d.ts

@@ -0,0 +1,511 @@
+import * as Schema from 'effect/Schema';
+import { SpaceId } from '@dxos/keys';
+/**
+ * HTTP header sent on every Edge request to classify traffic for metering.
+ */
+export declare const EDGE_CLIENT_TAG_HEADER = "X-DXOS-Client-Tag";
+export declare enum EdgeService {
+    AUTOMERGE_REPLICATOR = "automerge-replicator",
+    /**
+     * Control feed replicator (hypercore append only logs) for the space.
+     */
+    FEED_REPLICATOR = "feed-replicator",
+    /**
+     * Feed replicator (ordered data list) for the space.
+     */
+    QUEUE_REPLICATOR = "queue-replicator",
+    SWARM = "swarm",
+    SIGNAL = "signal",
+    STATUS = "status"
+}
+export type EdgeSuccess<T> = {
+    success: true;
+    data: T;
+};
+declare const _SerializedError: Schema.Struct<{
+    name: Schema.optional<typeof Schema.String>;
+    message: Schema.optional<typeof Schema.String>;
+    context: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Any>>;
+    stack: Schema.optional<typeof Schema.String>;
+    cause: Schema.optional<Schema.suspend<SerializedError, SerializedError, never>>;
+}>;
+export interface SerializedError extends Schema.Schema.Type<typeof _SerializedError> {
+}
+export declare const SerializedError: Schema.Schema<SerializedError, SerializedError, never>;
+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.
+ */
+export type EdgeFailure = {
+    /**
+     * Branded Type.
+     */
+    success: false;
+    /**
+     * An explanation of why the call failed. Used mostly for logging and monitoring.
+     */
+    message: string;
+    /**
+     * Cause Error captured on the EDGE service to aid debugging on the client.
+     */
+    error?: SerializedError;
+    /**
+     * Information that can be used to retry the request such that it will succeed, for example:
+     * 1. { type: 'auth_required', challenge: string }
+     *    Requires retrying the request with challenge signature included.
+     * 2. { type: 'user_confirmation_required', dialog: { title: string, message: string, confirmation_payload: string } }
+     *    Requires showing a confirmation dialog to a user and retrying the request with confirmation_payload included
+     *    if the user confirms.
+     * When data is returned simply retrying the request won't have any effect.
+     * EdgeHttpClient should parse well-known data into Error types and throw.
+     */
+    data?: EdgeErrorData;
+};
+/**
+ * Represents a body response from the Edge service.
+ */
+export type EdgeEnvelope<T> = EdgeSuccess<T> | EdgeFailure;
+/**
+ * Use this to create a response from the Edge service.
+ */
+export declare const EdgeResponse: Readonly<{
+    success: <T>(data: T, status?: number) => Response;
+    failure: ({ message, error, errorEncoded, data, shouldRetryAfter, status, }: {
+        /**
+         * An explanation of why the call failed. Used mostly for logging and monitoring.
+         */
+        message: string;
+        /**
+         * Error that caused the failure.
+         * Useful for debugging.
+         *
+         * Use only one of the fields `error` or `errorEncoded`.s
+         */
+        error?: Error;
+        /**
+         * Encoded Error that caused the failure.
+         * Useful for debugging.
+         *
+         * Use only one of the fields `error` or `errorEncoded`.
+         */
+        errorEncoded?: SerializedError;
+        /**
+         * Information that can be used to retry the request such that it will succeed, for example:
+         * 1. { type: 'auth_required', challenge: string }
+         *    Requires retrying the request with challenge signature included.
+         * 2. { type: 'user_confirmation_required', dialog: { title: string, message: string, confirmation_payload: string } }
+         *    Requires showing a confirmation dialog to a user and retrying the request with confirmation_payload included
+         *    if the user confirms.
+         * When data is returned simply retrying the request won't have any effect.
+         * EdgeHttpClient should parse well-known data into Error types and throw.
+         */
+        data?: EdgeErrorData;
+        /**
+         * If provided, this request will be marked as retryable and the client will wait for the specified number of milliseconds before retrying.
+         * If not provided, the client will not retry the request.
+         */
+        shouldRetryAfter?: number;
+        /**
+         * Status code of the response.
+         * @default 500
+         */
+        status?: number;
+    }) => Response;
+}>;
+export type GetNotarizationResponseBody = {
+    awaitingNotarization: {
+        credentials: string[];
+    };
+};
+export type ExecuteWorkflowResponseBody = {
+    success: boolean;
+    reason?: string;
+    output?: any;
+};
+export type PostNotarizationRequestBody = {
+    credentials: string[];
+};
+export type JoinSpaceRequest = {
+    invitationId: string;
+    identityKey: string;
+    /**
+     * Base64 encoded signed challenge.
+     * Used to verify the IdentityKey in case of `invitation.authMethod === Invitation.AuthMethod.KNOWN_PUBLIC_KEY`
+     */
+    signature?: string;
+};
+export type JoinSpaceResponseBody = {
+    spaceMemberCredential: string;
+    spaceGenesisFeedKey: string;
+};
+export type RecoverIdentitySignature = string | {
+    signature: string;
+    clientDataJson: string;
+    authenticatorData: string;
+};
+export type RecoverIdentityRequest = {
+    deviceKey: string;
+    controlFeedKey: string;
+    lookupKey?: string;
+    signature?: RecoverIdentitySignature;
+    token?: string;
+};
+export type RecoverIdentityResponseBody = {
+    identityKey: string;
+    haloSpaceKey: string;
+    genesisFeedKey: string;
+    deviceAuthCredential: string;
+};
+export type CreateAgentRequestBody = {
+    identityKey: string;
+    haloSpaceId: SpaceId;
+    haloSpaceKey: string;
+};
+export type CreateAgentResponseBody = {
+    deviceKey: string;
+    feedKey: string;
+};
+export type GetAgentStatusResponseBody = {
+    agent: {
+        deviceKey?: string;
+        status: EdgeAgentStatus;
+    };
+};
+export type UploadFunctionRequest = {
+    name?: string;
+    version: string;
+    ownerPublicKey: string;
+    entryPoint: string;
+    assets: Record<string, Uint8Array>;
+    /**
+     * Runtime in Edge that will be used to run the function.
+     * Runtime cannot be changed once the function was deployed.
+     * @default Runtime.WORKERS_FOR_PLATFORMS
+     */
+    runtime?: FunctionRuntimeKind;
+};
+/**
+ * Note: Do not change the values of these enums, this values are stored in the FunctionVersions database.
+ */
+export declare const FunctionRuntimeKind: Schema.Enums<{
+    WORKERS_FOR_PLATFORMS: string;
+    WORKER_LOADER: string;
+}>;
+export type FunctionRuntimeKind = Schema.Schema.Type<typeof FunctionRuntimeKind>;
+export type UploadFunctionResponseBody = {
+    functionId: string;
+    version: string;
+    meta: {
+        key?: string;
+        name?: string;
+        description?: string;
+        /**
+         * JSON Schema for the input of the function.
+         */
+        inputSchema?: object;
+        /**
+         * JSON Schema for the output of the function.
+         */
+        outputSchema?: object;
+    };
+};
+export type CreateSpaceRequest = {
+    /**
+     * HEX encoded public key of the agent.
+     */
+    agentKey: string;
+};
+export type CreateSpaceResponseBody = {
+    /**
+     * HEX encoded public key of the space.
+     */
+    spaceKey: string;
+    spaceId: SpaceId;
+    automergeRoot: string;
+};
+export declare enum EdgeAgentStatus {
+    ACTIVE = "active",
+    INACTIVE = "inactive",
+    NOT_FOUND = "not_found"
+}
+export type EdgeAuthChallenge = {
+    type: 'auth_challenge';
+    challenge: string;
+};
+export declare enum OAuthProvider {
+    GOOGLE = "google",
+    BLUESKY = "bluesky"
+}
+export declare const InitiateOAuthFlowRequestSchema: Schema.Struct<{
+    provider: Schema.Enums<typeof OAuthProvider>;
+    spaceId: Schema.refine<string & {
+        __SpaceId: true;
+    }, Schema.Schema<unknown, string, never>>;
+    accessTokenId: typeof Schema.String;
+    scopes: Schema.mutable<Schema.Array$<typeof Schema.String>>;
+    noRefresh: Schema.optional<typeof Schema.Boolean>;
+    loginHint: Schema.optional<typeof Schema.String>;
+}>;
+export type InitiateOAuthFlowRequest = Schema.Schema.Type<typeof InitiateOAuthFlowRequestSchema>;
+export type InitiateOAuthFlowResponse = {
+    authUrl: string;
+};
+export type OAuthFlowResult = {
+    success: true;
+    accessToken: string;
+    accessTokenId: string;
+} | {
+    success: false;
+    reason: string;
+};
+export declare enum EdgeWebsocketProtocol {
+    V0 = "edge-ws-v0",
+    /**
+     * Enables message framing and muxing by service-id.
+     */
+    V1 = "edge-ws-v1"
+}
+export type EdgeStatus = {
+    problems: string[];
+    agent: {
+        agentStatus?: string;
+        agentKey?: string;
+        haloSpaceId?: SpaceId;
+        fetchError?: string;
+    };
+    router: {
+        connectedDevices?: {
+            peerKey: string;
+            topics: string[];
+        }[];
+        metrics?: {
+            sentMessages: number;
+            receivedMessages: number;
+            sentBytes: number;
+            receivedBytes: number;
+            failedMessages: number;
+            failedBytes: number;
+        };
+        fetchError?: string;
+    };
+    spaces: {
+        data: Record<SpaceId, {
+            diagnostics?: any & {
+                redFlags: string[];
+            };
+            fetchError?: string;
+        }>;
+        fetchError?: string;
+    };
+};
+export type ImportBundleRequest = {
+    bundle: {
+        /**
+         * DocumentId.
+         */
+        documentId: string;
+        /**
+         * Encoded mutation.
+         */
+        mutation: string;
+        /**
+         * Heads of the document.
+         */
+        heads: string[];
+    }[];
+};
+export type ExportBundleRequest = {
+    /**
+     * DocumentId -> Heads (decoded heads since which we want to export).
+     */
+    docHeads: Record<string, string[]>;
+};
+export type ExportBundleResponse = {
+    bundle: {
+        /**
+         * DocumentId.
+         */
+        documentId: string;
+        /**
+         * Encoded mutation.
+         */
+        mutation: string;
+    }[];
+};
+export declare const DocumentCodec: Readonly<{
+    encode: (doc: Uint8Array) => string;
+    decode: (doc: string) => Uint8Array<ArrayBuffer>;
+}>;
+/**
+ * Codec for serializing and deserializing Edge Errors.
+ */
+export declare const ErrorCodec: Readonly<{
+    encode: (err: Error, depth?: number) => SerializedError;
+    decode: (serializedError: SerializedError, depth?: number) => Error;
+}>;
+/**
+ * Codec for serializing and deserializing Edge unhandled HTTP errors.
+ */
+export declare const EdgeHttpErrorCodec: Readonly<{
+    encode: (err: Error) => Response;
+    decode: (response: Response) => Promise<Error | undefined>;
+}>;
+export type ListSpacesRequest = {
+    limit?: number;
+    cursor?: string;
+    order?: 'asc' | 'desc';
+};
+export type ListSpacesResponse = {
+    spaces: SpaceActivityEntry[];
+    cursor?: string;
+    limit: number;
+};
+export type ListActiveIdentitiesRequest = {
+    cursor?: string;
+    limit?: number;
+};
+export type ListActiveIdentitiesResponse = {
+    identities: {
+        identityKey: string;
+        haloSpaceId: string | null;
+        createdAt: string | null;
+        agentKey: string | null;
+        hasRecovery: boolean;
+    }[];
+    cursor?: string;
+    complete: boolean;
+    totalCount: number;
+};
+export type InspectSpaceRequest = {
+    spaceId: string;
+};
+export type InspectSpaceResponse = {
+    spaceId: string;
+    metadata: {
+        createdAt: string;
+        identityKey?: string;
+        status?: 'active' | 'deleting';
+    } | null;
+    members: {
+        count: number;
+        list: {
+            identityKey: string;
+            role?: string;
+            agentKey?: string;
+        }[];
+    };
+    controlFeeds: {
+        replicationProgress: {
+            [feedKey: string]: {
+                replicated: number;
+                processed: number;
+            };
+        };
+    };
+    echo: {
+        dataFeeds: {
+            count: number;
+            totalBlocks: number;
+            byNamespace: {
+                namespace: string;
+                feeds: {
+                    feedId: string;
+                    blockCount: number;
+                }[];
+            }[];
+        };
+        documentCount: number;
+        objectCount: number;
+        deletedObjectCount: number;
+        indexedDocumentCount: number;
+        objectsByType: {
+            typeDxn: string;
+            count: number;
+        }[];
+        indexerStatus: {
+            indexingInProgress: boolean;
+            cursors: {
+                indexName: string;
+                sourceName: string;
+                resourceId: string | null;
+                cursor: string | number;
+            }[];
+            totalChanges: number;
+        };
+    };
+    usageInLast30Days: {
+        lastActivity: string | null;
+        wsEvents: number;
+        httpEvents: number;
+        totalEvents: number;
+    } | null;
+    durableObjects: {
+        type: string;
+        doId: string;
+    }[];
+};
+export type InspectIdentityRequest = {
+    identityKey: string;
+};
+export type InspectIdentityResponse = {
+    identityKey: string;
+    agentKey: string | null;
+    haloSpaceId: string | null;
+    hasRecovery: boolean;
+    routerDoId: string;
+    agentDoId: string | null;
+    ownedFunctions: {
+        id: string;
+        name: string;
+        versionCount: number;
+    }[];
+    spaces: InspectSpaceResponse[];
+};
+/** Matches the SerializedSpace format from @dxos/echo-db, extended with spaceId. */
+export type SpaceExportPayload = {
+    version: number;
+    timestamp: string;
+    spaceId: string;
+    objects: Record<string, unknown>[];
+};
+export type SpaceActivityEntry = {
+    spaceId: string;
+    lastActivity: string;
+    totalEvents: number;
+    metadata: {
+        createdAt: string;
+        identityKey?: string;
+        status?: 'active' | 'deleting';
+    } | null;
+};
+export type SpaceExportResult = {
+    spaceId: string;
+    downloadPath: string;
+    downloadUrl: string;
+    expiresAt: string;
+    objectCount: number;
+    sizeBytes: number;
+};
+export type ExportSpaceRequest = {
+    spaceId: string;
+    origin: string;
+};
+export type DeleteSpaceRequest = {
+    spaceId: string;
+};
+export type DeleteSpaceResponse = {
+    status: string;
+    spaceId: string;
+};
+export type DeleteIdentityRequest = {
+    identityKey: string;
+};
+export type DeleteIdentityResponse = {
+    status: string;
+    identityKey: string;
+};
+export {};
+//# sourceMappingURL=edge.d.ts.map

package/dist/src/edge/edge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"edge.d.ts","sourceRoot":"","sources":["../../../src/edge/edge.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAIxC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,sBAAsB,sBAAsB,CAAC;AAI1D,oBAAY,WAAW;IACrB,oBAAoB,yBAAyB;IAC7C;;OAEG;IAEH,eAAe,oBAAoB;IACnC;;OAEG;IAEH,gBAAgB,qBAAqB;IACrC,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,QAAA,MAAM,gBAAgB;;;;;;EAMpB,CAAC;AACH,MAAM,WAAW,eAAgB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC;CAAG;AACvF,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,eAAe,EAAE,KAAK,CAAoB,CAAC;AAExG,MAAM,MAAM,aAAa,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnE;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,YAAY;cACb,CAAC,QAAQ,CAAC,WAAU,MAAM,KAAS,QAAQ;iFAqBlD;QACD;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB;;;;;WAKG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC;QACd;;;;;WAKG;QACH,YAAY,CAAC,EAAE,eAAe,CAAC;QAE/B;;;;;;;;;WASG;QACH,IAAI,CAAC,EAAE,aAAa,CAAC;QACrB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,KAAG,QAAQ;EAmBZ,CAAC;AAEH,MAAM,MAAM,2BAA2B,GAAG;IACxC,oBAAoB,EAAE;QAAE,WAAW,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAChC,MAAM,GAEN;IACE,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEN,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,wBAAwB,CAAC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,eAAe,CAAC;KACzB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;EAK9B,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEjF,MAAM,MAAM,0BAA0B,GAAG;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,oBAAY,eAAe;IACzB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;CACxB;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,gBAAgB,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,8BAA8B;;;;;;;;;EASzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEjG,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,eAAe,GACvB;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,GAC7D;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvC,oBAAY,qBAAqB;IAC/B,EAAE,eAAe;IACjB;;OAEG;IACH,EAAE,eAAe;CAClB;AAGD,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,EAAE;QACL,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE;QACN,gBAAgB,CAAC,EAAE;YACjB,OAAO,EAAE,MAAM,CAAC;YAChB,MAAM,EAAE,MAAM,EAAE,CAAC;SAClB,EAAE,CAAC;QACJ,OAAO,CAAC,EAAE;YACR,YAAY,EAAE,MAAM,CAAC;YACrB,gBAAgB,EAAE,MAAM,CAAC;YACzB,SAAS,EAAE,MAAM,CAAC;YAClB,aAAa,EAAE,MAAM,CAAC;YACtB,cAAc,EAAE,MAAM,CAAC;YACvB,WAAW,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE;YAAE,WAAW,CAAC,EAAE,GAAG,GAAG;gBAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;aAAE,CAAC;YAAC,UAAU,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAC3F,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH,CAAC;AAMF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE;QACN;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE;QACN;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB,EAAE,CAAC;CACL,CAAC;AAEF,eAAO,MAAM,aAAa;kBACV,UAAU;kBACV,MAAM;EACpB,CAAC;AAIH;;GAEG;AACH,eAAO,MAAM,UAAU;kBACP,KAAK,UAAS,MAAM,KAAO,eAAe;8BAM9B,eAAe,UAAS,MAAM,KAAO,KAAK;EAkCpE,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,kBAAkB;kBACf,KAAK,KAAG,QAAQ;uBAQL,QAAQ,KAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;EAa9D,CAAC;AAMH,MAAM,MAAM,iBAAiB,GAAG;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;CAAE,CAAC;AAC5F,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,kBAAkB,EAAE,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAC9E,MAAM,MAAM,4BAA4B,GAAG;IACzC,UAAU,EAAE;QACV,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,WAAW,EAAE,OAAO,CAAC;KACtB,EAAE,CAAC;IACJ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AACtD,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAA;KAAE,GAAG,IAAI,CAAC;IAC7F,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE;YAAE,WAAW,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;KACnE,CAAC;IACF,YAAY,EAAE;QACZ,mBAAmB,EAAE;YAAE,CAAC,OAAO,EAAE,MAAM,GAAG;gBAAE,UAAU,EAAE,MAAM,CAAC;gBAAC,SAAS,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC;KACvF,CAAC;IACF,IAAI,EAAE;QACJ,SAAS,EAAE;YACT,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,EAAE,MAAM,CAAC;YACpB,WAAW,EAAE;gBAAE,SAAS,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE;oBAAE,MAAM,EAAE,MAAM,CAAC;oBAAC,UAAU,EAAE,MAAM,CAAA;iBAAE,EAAE,CAAA;aAAE,EAAE,CAAC;SACvF,CAAC;QACF,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;QACpB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,aAAa,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QACpD,aAAa,EAAE;YACb,kBAAkB,EAAE,OAAO,CAAC;YAC5B,OAAO,EAAE;gBAAE,SAAS,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;gBAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,EAAE,CAAC;YACzG,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;KACH,CAAC;IACF,iBAAiB,EAAE;QACjB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,IAAI,CAAC;IACT,cAAc,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAC7D,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,cAAc,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACrE,MAAM,EAAE,oBAAoB,EAAE,CAAC;CAChC,CAAC;AAEF,oFAAoF;AACpF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9F,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AACrD,MAAM,MAAM,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtE,MAAM,MAAM,qBAAqB,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAC5D,MAAM,MAAM,sBAAsB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/src/edge/edge.js

@@ -0,0 +1,173 @@
+//
+// Copyright 2024 DXOS.org
+//
+import * as Schema from 'effect/Schema';
+import { BaseError } from '@dxos/errors';
+import { invariant } from '@dxos/invariant';
+import { SpaceId } from '@dxos/keys';
+/**
+ * HTTP header sent on every Edge request to classify traffic for metering.
+ */
+export const EDGE_CLIENT_TAG_HEADER = 'X-DXOS-Client-Tag';
+// TODO(burdon): Rename EdgerRouterEndpoint.
+// If we would rename it, we need to be careful to not break composer production.
+export var EdgeService;
+(function (EdgeService) {
+    EdgeService["AUTOMERGE_REPLICATOR"] = "automerge-replicator";
+    /**
+     * Control feed replicator (hypercore append only logs) for the space.
+     */
+    // TODO(mykola): Remove once we migrate to keyhive for access control.
+    EdgeService["FEED_REPLICATOR"] = "feed-replicator";
+    /**
+     * Feed replicator (ordered data list) for the space.
+     */
+    // TODO(mykola): Rename to FEED_REPLICATOR when we migrate to keyhive for access control.
+    EdgeService["QUEUE_REPLICATOR"] = "queue-replicator";
+    EdgeService["SWARM"] = "swarm";
+    EdgeService["SIGNAL"] = "signal";
+    EdgeService["STATUS"] = "status";
+})(EdgeService || (EdgeService = {}));
+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 const SerializedError = _SerializedError;
+/**
+ * Use this to create a response from the Edge service.
+ */
+export const EdgeResponse = Object.freeze({
+    success: (data, status = 200) => {
+        invariant(status >= 200 && status < 300, 'Status code must be in the 2xx range');
+        const headers = new Headers({ 'Content-Type': 'application/json' });
+        return new Response(JSON.stringify({
+            success: true,
+            data,
+        }), {
+            status,
+            headers,
+        });
+    },
+    failure: ({ message, error, errorEncoded, data, shouldRetryAfter, status = 500, }) => {
+        const headers = new Headers({ 'Content-Type': 'application/json' });
+        if (shouldRetryAfter) {
+            headers.set('Retry-After', String(shouldRetryAfter));
+        }
+        return new Response(JSON.stringify({
+            success: false,
+            message,
+            data,
+            error: error ? ErrorCodec.encode(error) : errorEncoded,
+        }), {
+            status,
+            headers,
+        });
+    },
+});
+/**
+ * Note: Do not change the values of these enums, this values are stored in the FunctionVersions database.
+ */
+export const FunctionRuntimeKind = Schema.Enums({
+    // https://developers.cloudflare.com/cloudflare-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',
+});
+export var EdgeAgentStatus;
+(function (EdgeAgentStatus) {
+    EdgeAgentStatus["ACTIVE"] = "active";
+    EdgeAgentStatus["INACTIVE"] = "inactive";
+    EdgeAgentStatus["NOT_FOUND"] = "not_found";
+})(EdgeAgentStatus || (EdgeAgentStatus = {}));
+export var OAuthProvider;
+(function (OAuthProvider) {
+    OAuthProvider["GOOGLE"] = "google";
+    OAuthProvider["BLUESKY"] = "bluesky";
+})(OAuthProvider || (OAuthProvider = {}));
+export const InitiateOAuthFlowRequestSchema = Schema.Struct({
+    provider: Schema.Enums(OAuthProvider),
+    spaceId: Schema.String.pipe(Schema.filter(SpaceId.isValid)), // TODO(burdon): Use SpaceId.
+    accessTokenId: Schema.String,
+    scopes: Schema.mutable(Schema.Array(Schema.String)),
+    // Set to true if we don't want periodic token refreshes in background, for cases like account connect
+    noRefresh: Schema.optional(Schema.Boolean),
+    // Provider-specific (user handle or did for bluesky) hint for auth server resolution
+    loginHint: Schema.optional(Schema.String),
+});
+export var EdgeWebsocketProtocol;
+(function (EdgeWebsocketProtocol) {
+    EdgeWebsocketProtocol["V0"] = "edge-ws-v0";
+    /**
+     * Enables message framing and muxing by service-id.
+     */
+    EdgeWebsocketProtocol["V1"] = "edge-ws-v1";
+})(EdgeWebsocketProtocol || (EdgeWebsocketProtocol = {}));
+export const DocumentCodec = Object.freeze({
+    encode: (doc) => Buffer.from(doc).toString('base64'),
+    decode: (doc) => new Uint8Array(Buffer.from(doc, 'base64')),
+});
+const MAX_ERROR_DEPTH = 3;
+/**
+ * Codec for serializing and deserializing Edge Errors.
+ */
+export const ErrorCodec = Object.freeze({
+    encode: (err, depth = 0) => ({
+        name: 'name' in err ? err.name : err.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, depth = 0) => {
+        let err;
+        if (typeof serializedError.name === 'string') {
+            err = new BaseError(serializedError.name, {
+                message: serializedError.message ?? 'Unknown error',
+                cause: serializedError.cause && depth < MAX_ERROR_DEPTH
+                    ? ErrorCodec.decode(serializedError.cause, depth + 1)
+                    : undefined,
+                context: serializedError.context,
+            });
+            if (serializedError.stack) {
+                Object.defineProperty(err, 'stack', {
+                    value: serializedError.stack,
+                });
+            }
+        }
+        else {
+            err = new Error(serializedError.message ?? 'Unknown error', {
+                cause: serializedError.cause && depth < MAX_ERROR_DEPTH
+                    ? ErrorCodec.decode(serializedError.cause, depth + 1)
+                    : undefined,
+            });
+            if (serializedError.stack) {
+                Object.defineProperty(err, 'stack', {
+                    value: serializedError.stack,
+                });
+            }
+        }
+        return err;
+    },
+});
+/**
+ * Codec for serializing and deserializing Edge unhandled HTTP errors.
+ */
+export const EdgeHttpErrorCodec = Object.freeze({
+    encode: (err) => new Response(JSON.stringify({
+        error: ErrorCodec.encode(err),
+    }), { status: 500 }),
+    decode: async (response) => {
+        if (response.headers.get('Content-Type') !== 'application/json') {
+            const body = await response.clone().text();
+            return new Error(body.slice(0, 256));
+        }
+        const body = await response.clone().json();
+        if (!('error' in body)) {
+            return undefined;
+        }
+        return ErrorCodec.decode(body.error);
+    },
+});
+//# sourceMappingURL=edge.js.map