@mdbase-dev/connect 0.1.0-beta.100

package/dist/connection-types.d.ts

@@ -0,0 +1,38 @@
+import type { CollectionOperation, FileCapability, GrantScope, JsonObject, SyncChangesPage, SyncMutation, SyncMutationReceipt, SyncSession, SyncSnapshotPage } from "@mdbase-dev/connect-protocol";
+import type { ConnectRequestOptions } from "./operation-types.js";
+export type MdbaseConnectionRoute = "remote" | "direct" | "relay";
+export type DirectAccessStatus = "disabled" | "permission_required" | "checking" | "available" | "unavailable" | "denied";
+export interface MdbaseConnectionInfo {
+    collectionId: string;
+    displayName: string;
+    operations: CollectionOperation[];
+    scope: GrantScope;
+    fileCapability?: FileCapability;
+    authority: {
+        kind: "hosted";
+        durability: "provider";
+    } | {
+        kind: "connector";
+        durability: "computer";
+    };
+    route: MdbaseConnectionRoute;
+    directAccess: DirectAccessStatus;
+}
+export interface MdbaseAuthorizationCapabilities {
+    authorized: boolean;
+    sufficient: boolean;
+    collectionId?: string;
+    grantedOperations: CollectionOperation[];
+    missingOperations: CollectionOperation[];
+}
+export interface MdbaseSyncTransport<Frontmatter extends JsonObject = JsonObject> {
+    openSession(options?: ConnectRequestOptions): Promise<SyncSession>;
+    snapshot(snapshotId: string, page?: string, options?: ConnectRequestOptions): Promise<SyncSnapshotPage<Frontmatter>>;
+    changes(after: number, limit?: number, options?: ConnectRequestOptions): Promise<SyncChangesPage<Frontmatter>>;
+    mutate(mutation: SyncMutation, options?: ConnectRequestOptions): Promise<SyncMutationReceipt<Frontmatter>>;
+}
+export interface MdbaseSyncConnection<Frontmatter extends JsonObject = JsonObject> {
+    collectionId: string;
+    replicaId: string;
+    transport: MdbaseSyncTransport<Frontmatter>;
+}

package/dist/connection-types.js

@@ -0,0 +1 @@
+export {};

package/dist/connection.d.ts

@@ -0,0 +1,175 @@
+import type { CollectionOperation, CollectionTypeDocument, FileCapability, GrantScope, JsonObject } from "@mdbase-dev/connect-protocol";
+import { type MdbaseApplicationCapabilityId as ApplicationCapabilityId } from "./application-contract.js";
+import { type ConnectionTransportInternals } from "./connection-transport.js";
+import type { DirectAccessStatus, MdbaseAuthorizationCapabilities, MdbaseConnectionInfo, MdbaseConnectionRoute, MdbaseSyncConnection } from "./connection-types.js";
+import type { GrantKeyStore } from "./crypto.js";
+import { MdbaseFileClient } from "./files.js";
+import { type Application } from "./internal-types.js";
+import type { MdbaseNativeNotificationRegistration, MdbaseNativeNotificationRegistrationOptions, MdbaseNotificationRegistration, MdbaseNotificationRegistrationOptions } from "./notifications.js";
+import type { ChangesInput, CollectionChangesPage, CollectionDescription, CollectionSetupApplyResult, CollectionSetupAssessment, ApplyCollectionSetupInput, ApplyTypePackInput, AssessCollectionSetupInput, AssessTypePackInput, CreateInput, CreateTypeInput, CreateViewSourceInput, DeleteInput, DeletePreflightResult, DeleteProgressOptions, DeleteResult, DeleteViewSourceInput, DeleteViewSourceResult, ExecuteViewInput, MdbaseDesiredTimer, MdbaseTimer, MdbaseTimerList, MdbaseTimerReconciliation, ConnectRequestOptions, PendingMutation, QueryAllOptions, QueryInput, QueryPage, QueryPagesOptions, QueryResult, ReadInput, ReadTypeInput, ReadViewSourceInput, RenameInput, RenamePreflightResult, RenameProgressOptions, RenameResult, RecordDocument, SavedViewExecution, SavedViewPage, SavedViewPagesOptions, SavedViewList, SavedViewSourceDocument, TypePackApplyResult, TypePackAssessment, UpdateInput, UpdateTypeInput, UpdateViewSourceInput, MdbaseWatchSubscription, WatchInput } from "./operation-types.js";
+import { type AuthorizationProblemCode, type CollectionChangesProblemCode, type CollectionDescriptionProblemCode, type CollectionMutationProblemCode, type CollectionQueryProblemCode, type CollectionReadProblemCode, type CollectionTypeProblemCode, type ConnectOutcome, type DirectAccessProblemCode, type NotificationProblemCode, type RegistrationProblemCode } from "./outcomes.js";
+import type { MdbaseDeviceAuthorization } from "./authorization-types.js";
+import { type ResolvedConnectTimeouts } from "./request-budget.js";
+export type MdbaseAuthorizationTarget = {
+    kind: "choose";
+} | {
+    kind: "collection";
+    collectionId: string;
+};
+export interface MdbaseAuthorizeOptions extends ConnectRequestOptions {
+    /** Exact independent operations, for legacy v1 declarations only. Cannot be mixed with capabilities. */
+    operations?: CollectionOperation[];
+    /** Capability groups to request. Required groups are always included; optional groups default to all. */
+    capabilities?: ApplicationCapabilityId[];
+    /** Keep a web application loaded while Connect owns the approval ceremony. */
+    presentation?: "redirect" | "popup";
+    /** Choose any compatible collection, or require one exact collection. */
+    target?: MdbaseAuthorizationTarget;
+    /** App-local location to restore after the authorization callback. */
+    returnTo?: string;
+    /** Receives the short code even when the SDK also opens the approval page. */
+    onDeviceCode?: (authorization: MdbaseDeviceAuthorization) => void;
+    /** Replace the default popup for a downloaded application's approval page. */
+    openVerification?: (authorization: MdbaseDeviceAuthorization) => void | Promise<void>;
+}
+export interface MdbaseConnectionAuthorizeOptions extends ConnectRequestOptions {
+    /** Exact independent operations, for legacy v1 declarations only. */
+    operations?: CollectionOperation[];
+    /** Capability groups to request. Required groups are always included; optional groups default to all. */
+    capabilities?: ApplicationCapabilityId[];
+    presentation?: "redirect" | "popup";
+    returnTo?: string;
+    onDeviceCode?: (authorization: MdbaseDeviceAuthorization) => void;
+    openVerification?: (authorization: MdbaseDeviceAuthorization) => void | Promise<void>;
+}
+export interface MdbaseConnectEnvironment {
+    distribution: "web" | "portable";
+    applicationOrigin: string;
+    credentialStorage: "persistent" | "memory" | "custom";
+}
+export interface MdbaseAuthorizationResult<Frontmatter extends JsonObject = JsonObject> {
+    connection: MdbaseConnection<Frontmatter>;
+    returnTo?: string;
+}
+export type MdbaseAuthorizationOutcome<Frontmatter extends JsonObject = JsonObject> = {
+    kind: "redirecting";
+} | ({
+    kind: "connected";
+} & MdbaseAuthorizationResult<Frontmatter>);
+export interface MdbaseConnectionInternals<Frontmatter extends JsonObject> extends ConnectionTransportInternals {
+    readonly serverUrl: string;
+    readonly storage: Storage;
+    readonly keyStore: GrantKeyStore;
+    readonly directAccessMode: "auto" | "disabled";
+    readonly loopbackUrl: string;
+    readonly timeouts: ResolvedConnectTimeouts;
+    register(options?: ConnectRequestOptions): Promise<Application>;
+    authorize(options?: MdbaseAuthorizeOptions): Promise<MdbaseAuthorizationOutcome<Frontmatter>>;
+    notificationKey(collectionId: string, transport?: "web_push" | "fcm"): string;
+}
+export declare class MdbaseConnection<Frontmatter extends JsonObject = JsonObject> {
+    private readonly internals;
+    readonly collectionId: string;
+    private readonly collectionClient;
+    private readonly notifications;
+    private readonly transport;
+    readonly files: MdbaseFileClient;
+    private readonly connectionListeners;
+    constructor(internals: MdbaseConnectionInternals<Frontmatter>, collectionId: string);
+    get displayName(): string;
+    get operations(): CollectionOperation[];
+    get scope(): GrantScope | null;
+    get fileCapability(): FileCapability | null;
+    get directAccess(): DirectAccessStatus;
+    get route(): MdbaseConnectionRoute;
+    register(options?: ConnectRequestOptions): Promise<ConnectOutcome<Application, RegistrationProblemCode>>;
+    info(): MdbaseConnectionInfo | null;
+    authorizationCapabilities(requiredOperations?: CollectionOperation[]): MdbaseAuthorizationCapabilities;
+    hasOperations(requiredOperations: CollectionOperation[]): boolean;
+    authorize(options?: MdbaseConnectionAuthorizeOptions): Promise<ConnectOutcome<MdbaseAuthorizationOutcome<Frontmatter>, AuthorizationProblemCode>>;
+    requestCapabilities(capabilities: ApplicationCapabilityId[], options?: MdbaseConnectionAuthorizeOptions): Promise<ConnectOutcome<MdbaseAuthorizationOutcome<Frontmatter> | {
+        kind: "unchanged";
+        connection: MdbaseConnection<Frontmatter>;
+    }, AuthorizationProblemCode>>;
+    requestOperations(requiredOperations: CollectionOperation[], options?: Omit<MdbaseConnectionAuthorizeOptions, "operations">): Promise<ConnectOutcome<MdbaseAuthorizationOutcome<Frontmatter> | {
+        kind: "unchanged";
+        connection: MdbaseConnection<Frontmatter>;
+    }, AuthorizationProblemCode>>;
+    onConnectionChange(listener: (connection: MdbaseConnectionInfo | null) => void): () => void;
+    notifyStorageChanged(): void;
+    checkDirectAccess(options?: ConnectRequestOptions): Promise<ConnectOutcome<DirectAccessStatus, DirectAccessProblemCode>>;
+    /** Call from a user gesture to request browser permission for direct local access. */
+    requestDirectAccess(options?: ConnectRequestOptions): Promise<ConnectOutcome<DirectAccessStatus, DirectAccessProblemCode>>;
+    disableDirectAccess(): void;
+    /**
+     * Return one offline-replication transport regardless of whether the
+     * authority is remote, directly connected, or relay connected.
+     * Authority credentials and routing stay private inside the SDK.
+     */
+    sync(): MdbaseSyncConnection<Frontmatter> | null;
+    /**
+     * Register this browser installation for manifest-declared Web Push.
+     *
+     * Criteria are evaluated by the collection authority. Push payloads contain
+     * only an opaque cursor and static presentation copy.
+     */
+    registerNotifications(options: MdbaseNotificationRegistrationOptions): Promise<ConnectOutcome<MdbaseNotificationRegistration, NotificationProblemCode>>;
+    registerNativeNotifications(options: MdbaseNativeNotificationRegistrationOptions): Promise<ConnectOutcome<MdbaseNativeNotificationRegistration, NotificationProblemCode>>;
+    unregisterNativeNotifications(options?: ConnectRequestOptions): Promise<ConnectOutcome<void, NotificationProblemCode>>;
+    unregisterNotifications(serviceWorker?: ServiceWorkerRegistration, options?: ConnectRequestOptions): Promise<ConnectOutcome<void, NotificationProblemCode>>;
+    forget(): void;
+    describe(options?: ConnectRequestOptions): Promise<ConnectOutcome<CollectionDescription, CollectionDescriptionProblemCode>>;
+    changes(input?: ChangesInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<CollectionChangesPage, CollectionChangesProblemCode>>;
+    read(input: ReadInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<RecordDocument<Frontmatter>, CollectionReadProblemCode>>;
+    query(input?: QueryInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<QueryResult<Frontmatter>, CollectionQueryProblemCode>>;
+    queryPages(input?: QueryInput, options?: QueryPagesOptions<Frontmatter>): AsyncGenerator<ConnectOutcome<QueryPage<Frontmatter>, CollectionQueryProblemCode>>;
+    queryAll(input?: QueryInput, options?: QueryAllOptions<Frontmatter>): Promise<ConnectOutcome<QueryResult<Frontmatter>, CollectionQueryProblemCode>>;
+    listViews(options?: ConnectRequestOptions): Promise<ConnectOutcome<SavedViewList, CollectionReadProblemCode>>;
+    executeView(input: ExecuteViewInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<SavedViewExecution<Frontmatter>, CollectionReadProblemCode>>;
+    executeViewPages(input: ExecuteViewInput, options?: SavedViewPagesOptions<Frontmatter>): AsyncGenerator<ConnectOutcome<SavedViewPage<Frontmatter>, CollectionReadProblemCode>>;
+    readViewSource(input: ReadViewSourceInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<SavedViewSourceDocument, CollectionReadProblemCode>>;
+    createViewSource(input: CreateViewSourceInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<SavedViewSourceDocument, CollectionMutationProblemCode>>;
+    updateViewSource(input: UpdateViewSourceInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<SavedViewSourceDocument, CollectionMutationProblemCode>>;
+    deleteViewSource(input: DeleteViewSourceInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<DeleteViewSourceResult, CollectionMutationProblemCode>>;
+    create(input: CreateInput<Frontmatter>, options?: ConnectRequestOptions): Promise<ConnectOutcome<RecordDocument<Frontmatter>, CollectionMutationProblemCode>>;
+    update(input: UpdateInput<Frontmatter>, options?: ConnectRequestOptions): Promise<ConnectOutcome<RecordDocument<Frontmatter>, CollectionMutationProblemCode>>;
+    delete(input: DeleteInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<DeleteResult, CollectionMutationProblemCode>>;
+    preflightDelete(input: DeleteInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<DeletePreflightResult, CollectionMutationProblemCode>>;
+    rename(input: RenameInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<RenameResult, CollectionMutationProblemCode>>;
+    preflightRename(input: RenameInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<RenamePreflightResult, CollectionMutationProblemCode>>;
+    renameWithProgress(input: RenameInput, options?: RenameProgressOptions): Promise<ConnectOutcome<RenameResult, CollectionMutationProblemCode>>;
+    deleteWithProgress(input: DeleteInput, options?: DeleteProgressOptions): Promise<ConnectOutcome<DeleteResult, CollectionMutationProblemCode>>;
+    pendingMutations<Result = unknown>(): readonly PendingMutation<Result>[];
+    pendingMutation<Result = unknown>(requestId: string): PendingMutation<Result> | null;
+    private recoverPendingMutation;
+    validate(input?: JsonObject, options?: ConnectRequestOptions): Promise<ConnectOutcome<JsonObject, CollectionReadProblemCode>>;
+    readType(input: ReadTypeInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<CollectionTypeDocument, CollectionTypeProblemCode>>;
+    createType(input: CreateTypeInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<CollectionTypeDocument, CollectionTypeProblemCode>>;
+    updateType(input: UpdateTypeInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<CollectionTypeDocument, CollectionTypeProblemCode>>;
+    assessTypePack(input: AssessTypePackInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<TypePackAssessment, CollectionTypeProblemCode>>;
+    applyTypePack(input: ApplyTypePackInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<TypePackApplyResult, CollectionTypeProblemCode>>;
+    assessCollectionSetup(input: AssessCollectionSetupInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<CollectionSetupAssessment, CollectionTypeProblemCode>>;
+    applyCollectionSetup(input: ApplyCollectionSetupInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<CollectionSetupApplyResult, CollectionTypeProblemCode>>;
+    listTimers(namespace: string, options?: ConnectRequestOptions): Promise<ConnectOutcome<MdbaseTimerList, CollectionReadProblemCode>>;
+    putTimer(input: {
+        namespace: string;
+        criterionId: string;
+        timer: MdbaseDesiredTimer;
+    }, options?: ConnectRequestOptions): Promise<ConnectOutcome<MdbaseTimer, CollectionMutationProblemCode>>;
+    cancelTimer(input: {
+        namespace: string;
+        id: string;
+        generation?: number;
+    }, options?: ConnectRequestOptions): Promise<ConnectOutcome<{
+        namespace: string;
+        id: string;
+        cancelled: boolean;
+    }, CollectionMutationProblemCode>>;
+    reconcileTimers(input: {
+        namespace: string;
+        criterionId: string;
+        timers: MdbaseDesiredTimer[];
+    }, options?: ConnectRequestOptions): Promise<ConnectOutcome<MdbaseTimerReconciliation, CollectionMutationProblemCode>>;
+    watch(input?: WatchInput, options?: ConnectRequestOptions): Promise<ConnectOutcome<MdbaseWatchSubscription, CollectionChangesProblemCode>>;
+    private emitConnection;
+}