@tearleads/client-sdk 0.1.87 → 0.1.89

package/workflows/organizations/memberships/leaveRequest.d.ts

@@ -0,0 +1,31 @@
+import type { RequestResult } from "../../../internal/api-client/index.js";
+import { type SigningKeyPair } from "../../../internal/crypto/index.js";
+import type { OrganizationMembershipResponse } from "../../../internal/validators/response/index.js";
+import type { OrganizationLeaveRequest } from "../../../internal/validators/util/index.js";
+import type { OrganizationMembership } from "./organizationMemberships.js";
+export interface OrganizationLeaveRequestApi {
+    setOrganizationLeaveRequest(organizationId: string, request: OrganizationLeaveRequest | null): Promise<RequestResult<OrganizationMembershipResponse>>;
+}
+export type OrganizationLeaveRequestResult = {
+    readonly status: "updated";
+    readonly membership: OrganizationMembership;
+} | {
+    readonly status: "failed";
+    readonly httpStatus: number | null;
+    readonly message: string;
+};
+/**
+ * Files or withdraws the user's request to leave one organization. Filing
+ * signs the request with the user's identity key, so administrators can tell
+ * the member made it; it removes nothing until an administrator approves it.
+ */
+export declare function setOrganizationLeaveRequested(input: {
+    readonly apiClient: OrganizationLeaveRequestApi;
+    readonly organizationId: string;
+    readonly requested: boolean;
+    readonly signer: {
+        readonly signingKeyPair: Pick<SigningKeyPair, "signingPrivateKey">;
+        readonly userId: string;
+    };
+    readonly now?: () => Date;
+}): Promise<OrganizationLeaveRequestResult>;

package/workflows/organizations/memberships/leaveRequest.js

@@ -0,0 +1,20 @@
+import { signOrganizationLeaveRequest, } from "../../../internal/crypto/index.js";
+/**
+ * Files or withdraws the user's request to leave one organization. Filing
+ * signs the request with the user's identity key, so administrators can tell
+ * the member made it; it removes nothing until an administrator approves it.
+ */
+export async function setOrganizationLeaveRequested(input) {
+    const request = input.requested
+        ? signOrganizationLeaveRequest({
+            organizationId: input.organizationId,
+            requestedAt: (input.now?.() ?? new Date()).toISOString(),
+            userId: input.signer.userId,
+        }, input.signer.signingKeyPair)
+        : null;
+    const result = await input.apiClient.setOrganizationLeaveRequest(input.organizationId, request);
+    return result.ok
+        ? { membership: result.data, status: "updated" }
+        : { httpStatus: result.status, message: result.message, status: "failed" };
+}
+//# sourceMappingURL=leaveRequest.js.map

package/workflows/organizations/memberships/leaveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"leaveRequest.js","sourceRoot":"","sources":["leaveRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,4BAA4B,GAC7B,MAAM,mBAAmB,CAAC;AAoB3B;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAAC,KASnD;IACC,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS;QAC7B,CAAC,CAAC,4BAA4B,CAC1B;YACE,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE;YACxD,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;SAC5B,EACD,KAAK,CAAC,MAAM,CAAC,cAAc,CAC5B;QACH,CAAC,CAAC,IAAI,CAAC;IACT,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,2BAA2B,CAC9D,KAAK,CAAC,cAAc,EACpB,OAAO,CACR,CAAC;IACF,OAAO,MAAM,CAAC,EAAE;QACd,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE;QAChD,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC/E,CAAC","sourcesContent":["import type { RequestResult } from \"@tearleads/api-client\";\nimport {\n  type SigningKeyPair,\n  signOrganizationLeaveRequest,\n} from \"@tearleads/crypto\";\nimport type { OrganizationMembershipResponse } from \"@tearleads/validators/response\";\nimport type { OrganizationLeaveRequest } from \"@tearleads/validators/util\";\nimport type { OrganizationMembership } from \"./organizationMemberships\";\n\nexport interface OrganizationLeaveRequestApi {\n  setOrganizationLeaveRequest(\n    organizationId: string,\n    request: OrganizationLeaveRequest | null,\n  ): Promise<RequestResult<OrganizationMembershipResponse>>;\n}\n\nexport type OrganizationLeaveRequestResult =\n  | { readonly status: \"updated\"; readonly membership: OrganizationMembership }\n  | {\n      readonly status: \"failed\";\n      readonly httpStatus: number | null;\n      readonly message: string;\n    };\n\n/**\n * Files or withdraws the user's request to leave one organization. Filing\n * signs the request with the user's identity key, so administrators can tell\n * the member made it; it removes nothing until an administrator approves it.\n */\nexport async function setOrganizationLeaveRequested(input: {\n  readonly apiClient: OrganizationLeaveRequestApi;\n  readonly organizationId: string;\n  readonly requested: boolean;\n  readonly signer: {\n    readonly signingKeyPair: Pick<SigningKeyPair, \"signingPrivateKey\">;\n    readonly userId: string;\n  };\n  readonly now?: () => Date;\n}): Promise<OrganizationLeaveRequestResult> {\n  const request = input.requested\n    ? signOrganizationLeaveRequest(\n        {\n          organizationId: input.organizationId,\n          requestedAt: (input.now?.() ?? new Date()).toISOString(),\n          userId: input.signer.userId,\n        },\n        input.signer.signingKeyPair,\n      )\n    : null;\n  const result = await input.apiClient.setOrganizationLeaveRequest(\n    input.organizationId,\n    request,\n  );\n  return result.ok\n    ? { membership: result.data, status: \"updated\" }\n    : { httpStatus: result.status, message: result.message, status: \"failed\" };\n}\n"]}

package/workflows/organizations/memberships/leaveRequestVerification.d.ts

@@ -0,0 +1,15 @@
+import type { TrustedUserIdentityResolver } from "../../../data/trustedUserIdentity/index.js";
+import type { OrganizationDirectoryAndGroups, OrganizationDirectoryUser, OrganizationUserDetail } from "../readModel/index.js";
+/**
+ * The user as shown, with its leave request kept only when the member signed
+ * it. Every directory user a client presents passes through here, whether a
+ * read model or a mutation response carried it.
+ */
+export declare function withVerifiedDirectoryUser(organizationId: string, user: OrganizationDirectoryUser, resolveTrustedUserIdentity: TrustedUserIdentityResolver): Promise<OrganizationDirectoryUser>;
+/**
+ * Keeps only leave requests their member signed, checked against the member's
+ * trusted identity; any other is shown as no request at all.
+ */
+export declare function withVerifiedLeaveRequests<Result extends OrganizationDirectoryAndGroups | null | undefined>(result: Result, resolveTrustedUserIdentity: TrustedUserIdentityResolver): Promise<Result>;
+/** The user detail counterpart of withVerifiedLeaveRequests. */
+export declare function withVerifiedUserLeaveRequest(detail: OrganizationUserDetail | null, organizationId: string, resolveTrustedUserIdentity: TrustedUserIdentityResolver): Promise<OrganizationUserDetail | null>;

package/workflows/organizations/memberships/leaveRequestVerification.js

@@ -0,0 +1,46 @@
+import { isValidOrganizationLeaveRequest } from "../../../internal/crypto/index.js";
+/**
+ * The user as shown, with its leave request kept only when the member signed
+ * it. Every directory user a client presents passes through here, whether a
+ * read model or a mutation response carried it.
+ */
+export async function withVerifiedDirectoryUser(organizationId, user, resolveTrustedUserIdentity) {
+    const request = user.leaveRequest;
+    if (!request)
+        return user;
+    // The member's pinned identity, never the key the directory served beside
+    // the request: a server that could swap both could forge any member's ask.
+    const identity = await resolveTrustedUserIdentity(user.userId).catch(() => null);
+    const verified = identity !== null &&
+        request.organizationId === organizationId &&
+        request.userId === user.userId &&
+        isValidOrganizationLeaveRequest(request, identity.signingPublicKey);
+    return verified ? user : { ...user, leaveRequest: null };
+}
+/**
+ * Keeps only leave requests their member signed, checked against the member's
+ * trusted identity; any other is shown as no request at all.
+ */
+export async function withVerifiedLeaveRequests(result, resolveTrustedUserIdentity) {
+    if (!result?.directory.users.some((user) => user.leaveRequest)) {
+        return result;
+    }
+    const { organizationId } = result.directory;
+    return {
+        ...result,
+        directory: {
+            ...result.directory,
+            users: await Promise.all(result.directory.users.map((user) => withVerifiedDirectoryUser(organizationId, user, resolveTrustedUserIdentity))),
+        },
+    };
+}
+/** The user detail counterpart of withVerifiedLeaveRequests. */
+export async function withVerifiedUserLeaveRequest(detail, organizationId, resolveTrustedUserIdentity) {
+    if (!detail?.user.leaveRequest)
+        return detail;
+    return {
+        ...detail,
+        user: await withVerifiedDirectoryUser(organizationId, detail.user, resolveTrustedUserIdentity),
+    };
+}
+//# sourceMappingURL=leaveRequestVerification.js.map

package/workflows/organizations/memberships/leaveRequestVerification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"leaveRequestVerification.js","sourceRoot":"","sources":["leaveRequestVerification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,mBAAmB,CAAC;AAQpE;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,cAAsB,EACtB,IAA+B,EAC/B,0BAAuD;IAEvD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC;IAClC,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,0EAA0E;IAC1E,2EAA2E;IAC3E,MAAM,QAAQ,GAAG,MAAM,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAClE,GAAG,EAAE,CAAC,IAAI,CACX,CAAC;IACF,MAAM,QAAQ,GACZ,QAAQ,KAAK,IAAI;QACjB,OAAO,CAAC,cAAc,KAAK,cAAc;QACzC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;QAC9B,+BAA+B,CAAC,OAAO,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IACtE,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;AAC3D,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAG7C,MAAc,EACd,0BAAuD;IAEvD,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QAC/D,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC;IAC5C,OAAO;QACL,GAAG,MAAM;QACT,SAAS,EAAE;YACT,GAAG,MAAM,CAAC,SAAS;YACnB,KAAK,EAAE,MAAM,OAAO,CAAC,GAAG,CACtB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAClC,yBAAyB,CACvB,cAAc,EACd,IAAI,EACJ,0BAA0B,CAC3B,CACF,CACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,gEAAgE;AAChE,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,MAAqC,EACrC,cAAsB,EACtB,0BAAuD;IAEvD,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY;QAAE,OAAO,MAAM,CAAC;IAC9C,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,MAAM,yBAAyB,CACnC,cAAc,EACd,MAAM,CAAC,IAAI,EACX,0BAA0B,CAC3B;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { isValidOrganizationLeaveRequest } from \"@tearleads/crypto\";\nimport type { TrustedUserIdentityResolver } from \"../../../data/trustedUserIdentity\";\nimport type {\n  OrganizationDirectoryAndGroups,\n  OrganizationDirectoryUser,\n  OrganizationUserDetail,\n} from \"../readModel\";\n\n/**\n * The user as shown, with its leave request kept only when the member signed\n * it. Every directory user a client presents passes through here, whether a\n * read model or a mutation response carried it.\n */\nexport async function withVerifiedDirectoryUser(\n  organizationId: string,\n  user: OrganizationDirectoryUser,\n  resolveTrustedUserIdentity: TrustedUserIdentityResolver,\n): Promise<OrganizationDirectoryUser> {\n  const request = user.leaveRequest;\n  if (!request) return user;\n  // The member's pinned identity, never the key the directory served beside\n  // the request: a server that could swap both could forge any member's ask.\n  const identity = await resolveTrustedUserIdentity(user.userId).catch(\n    () => null,\n  );\n  const verified =\n    identity !== null &&\n    request.organizationId === organizationId &&\n    request.userId === user.userId &&\n    isValidOrganizationLeaveRequest(request, identity.signingPublicKey);\n  return verified ? user : { ...user, leaveRequest: null };\n}\n\n/**\n * Keeps only leave requests their member signed, checked against the member's\n * trusted identity; any other is shown as no request at all.\n */\nexport async function withVerifiedLeaveRequests<\n  Result extends OrganizationDirectoryAndGroups | null | undefined,\n>(\n  result: Result,\n  resolveTrustedUserIdentity: TrustedUserIdentityResolver,\n): Promise<Result> {\n  if (!result?.directory.users.some((user) => user.leaveRequest)) {\n    return result;\n  }\n  const { organizationId } = result.directory;\n  return {\n    ...result,\n    directory: {\n      ...result.directory,\n      users: await Promise.all(\n        result.directory.users.map((user) =>\n          withVerifiedDirectoryUser(\n            organizationId,\n            user,\n            resolveTrustedUserIdentity,\n          ),\n        ),\n      ),\n    },\n  };\n}\n\n/** The user detail counterpart of withVerifiedLeaveRequests. */\nexport async function withVerifiedUserLeaveRequest(\n  detail: OrganizationUserDetail | null,\n  organizationId: string,\n  resolveTrustedUserIdentity: TrustedUserIdentityResolver,\n): Promise<OrganizationUserDetail | null> {\n  if (!detail?.user.leaveRequest) return detail;\n  return {\n    ...detail,\n    user: await withVerifiedDirectoryUser(\n      organizationId,\n      detail.user,\n      resolveTrustedUserIdentity,\n    ),\n  };\n}\n"]}

package/workflows/organizations/memberships/organizationMemberships.d.ts

@@ -0,0 +1,84 @@
+import type { RequestResult } from "../../../internal/api-client/index.js";
+import type { UpdateOrganizationMembershipRequest } from "../../../internal/validators/request/index.js";
+import type { OrganizationMembershipResponse, OrganizationMembershipsResponse } from "../../../internal/validators/response/index.js";
+import type { DomainScope } from "../../../data/shared/domainScope.js";
+import type { ExecSql } from "../../../data/sqlite/sqlSchema.js";
+import { type OrganizationSyncPauses } from "../../sync/index.js";
+/** One organization the user belongs to, with their own choices for it. */
+export type OrganizationMembership = OrganizationMembershipResponse;
+export interface OrganizationMembershipApi {
+    listOrganizationMemberships(): Promise<OrganizationMembershipsResponse | null>;
+    updateOrganizationMembership(organizationId: string, input: UpdateOrganizationMembershipRequest): Promise<RequestResult<OrganizationMembershipResponse>>;
+}
+/**
+ * What applying a pause needs from the device's content. Wired by the
+ * composition root to the container tree and the document sync lanes.
+ */
+export interface OrganizationContentHost {
+    /**
+     * Removes an organization's content, keeping its metadata root. Refuses,
+     * returning false, while any of its writes is unsynced or still queued in
+     * an open store.
+     */
+    forgetOrganizationContent(organizationId: string): Promise<boolean>;
+    /** Whether any local write for the organization has not uploaded yet. */
+    hasUnsyncedOrganizationWrites(organizationId: string): Promise<boolean>;
+    /** Asks every sync lane to upload now and waits briefly for them to idle. */
+    flushWrites(): Promise<void>;
+    /** Re-lists the whole tree so resumed organizations download again. */
+    refetchContent(): Promise<void>;
+    /**
+     * Runs `retry` each time the scope's sync lanes go idle until it resolves
+     * true. A later call replaces the pending retry.
+     */
+    retryWhenWritesSettle(retry: () => Promise<boolean>): void;
+}
+interface OrganizationMembershipInput {
+    readonly apiClient: OrganizationMembershipApi;
+    readonly domainScope: DomainScope;
+    readonly execSql: ExecSql;
+    readonly host: OrganizationContentHost;
+    /**
+     * Whether the session still uses `domainScope`. A membership list or pause
+     * that completes after an identity switch must not touch the new identity's
+     * device state.
+     */
+    readonly isCurrent: () => boolean;
+}
+export type OrganizationSyncPauseResult = {
+    readonly status: "updated";
+    readonly membership: OrganizationMembership;
+} | {
+    readonly status: "unsynced-writes";
+} | {
+    readonly status: "failed";
+    readonly httpStatus: number | null;
+    readonly message: string;
+};
+/**
+ * Removes the content of every paused organization that has nothing left to
+ * upload. An organization with pending or queued writes keeps syncing those
+ * out and is retried once the sync lanes go idle, so pausing never discards
+ * unsynced work and a removal does not wait for the next membership read.
+ */
+export declare function forgetPausedOrganizationContent(input: {
+    readonly host: OrganizationContentHost;
+    readonly pauses: OrganizationSyncPauses;
+}): Promise<void>;
+/**
+ * Reads the user's memberships and applies their pause choices, including
+ * ones made on another device: paused organizations leave this device, and
+ * resumed ones download again. Returns null when the list is unavailable, in
+ * which case the persisted pauses stay in force.
+ */
+export declare function refreshOrganizationMemberships(input: OrganizationMembershipInput): Promise<OrganizationMembership[] | null>;
+/**
+ * Pauses or resumes one organization for every device of this user. Pausing
+ * first uploads this device's pending writes and is refused while any remain,
+ * so the local copy it removes holds nothing the server lacks.
+ */
+export declare function setOrganizationSyncPaused(input: OrganizationMembershipInput & {
+    readonly organizationId: string;
+    readonly paused: boolean;
+}): Promise<OrganizationSyncPauseResult>;
+export {};

package/workflows/organizations/memberships/organizationMemberships.js

@@ -0,0 +1,95 @@
+import { getOrCreateOrganizationSyncPauses, } from "../../sync/index.js";
+async function forgetEveryPausedOrganization(input) {
+    let complete = true;
+    for (const organizationId of [...input.pauses.pausedOrganizationIds()]) {
+        if (!(await input.host.forgetOrganizationContent(organizationId))) {
+            complete = false;
+        }
+    }
+    return complete;
+}
+/**
+ * Removes the content of every paused organization that has nothing left to
+ * upload. An organization with pending or queued writes keeps syncing those
+ * out and is retried once the sync lanes go idle, so pausing never discards
+ * unsynced work and a removal does not wait for the next membership read.
+ */
+export async function forgetPausedOrganizationContent(input) {
+    if (await forgetEveryPausedOrganization(input))
+        return;
+    input.host.retryWhenWritesSettle(() => input.pauses.runExclusive(() => forgetEveryPausedOrganization(input)));
+}
+/**
+ * Reads the user's memberships and applies their pause choices, including
+ * ones made on another device: paused organizations leave this device, and
+ * resumed ones download again. Returns null when the list is unavailable, in
+ * which case the persisted pauses stay in force.
+ */
+export async function refreshOrganizationMemberships(input) {
+    const pauses = getOrCreateOrganizationSyncPauses(input.domainScope);
+    return pauses.runExclusive(() => applyMembershipList(input, pauses));
+}
+async function applyMembershipList(input, pauses) {
+    const response = await input.apiClient.listOrganizationMemberships();
+    if (!response || !input.isCurrent())
+        return null;
+    const change = await pauses.replace(input.execSql, response.memberships.flatMap((membership) => membership.syncPaused ? [membership.organizationId] : []));
+    await forgetPausedOrganizationContent({ host: input.host, pauses });
+    if (change.resumed.length > 0)
+        await input.host.refetchContent();
+    return [...response.memberships];
+}
+/**
+ * Pauses or resumes one organization for every device of this user. Pausing
+ * first uploads this device's pending writes and is refused while any remain,
+ * so the local copy it removes holds nothing the server lacks.
+ */
+export async function setOrganizationSyncPaused(input) {
+    const pauses = getOrCreateOrganizationSyncPauses(input.domainScope);
+    return pauses.runExclusive(() => applySyncPauseChoice(input, pauses));
+}
+async function applySyncPauseChoice(input, pauses) {
+    const { host, organizationId, paused } = input;
+    const scopeEnded = {
+        httpStatus: null,
+        message: "The session changed before sync could be changed.",
+        status: "failed",
+    };
+    // Queued behind other membership work, the session may have switched
+    // identity; the shared API client would then act for the new identity.
+    if (!input.isCurrent())
+        return scopeEnded;
+    if (paused) {
+        await host.flushWrites();
+        if (await host.hasUnsyncedOrganizationWrites(organizationId)) {
+            return { status: "unsynced-writes" };
+        }
+    }
+    if (!input.isCurrent())
+        return scopeEnded;
+    const result = await input.apiClient.updateOrganizationMembership(organizationId, { syncPaused: paused });
+    if (!result.ok) {
+        return {
+            httpStatus: result.status,
+            message: result.message,
+            status: "failed",
+        };
+    }
+    // The choice is recorded; a scope that ended meanwhile applies it on its
+    // next membership read instead.
+    if (!input.isCurrent())
+        return { membership: result.data, status: "updated" };
+    await pauses.load(input.execSql);
+    const next = new Set(pauses.pausedOrganizationIds());
+    if (paused)
+        next.add(organizationId);
+    else
+        next.delete(organizationId);
+    await pauses.replace(input.execSql, next);
+    if (paused)
+        await forgetPausedOrganizationContent({ host, pauses });
+    else
+        await host.refetchContent();
+    return { membership: result.data, status: "updated" };
+}
+//# sourceMappingURL=organizationMemberships.js.map

package/workflows/organizations/memberships/organizationMemberships.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"organizationMemberships.js","sourceRoot":"","sources":["organizationMemberships.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,iCAAiC,GAElC,MAAM,YAAY,CAAC;AA2DpB,KAAK,UAAU,6BAA6B,CAAC,KAG5C;IACC,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,KAAK,MAAM,cAAc,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,EAAE,CAAC;QACvE,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;YAClE,QAAQ,GAAG,KAAK,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,+BAA+B,CAAC,KAGrD;IACC,IAAI,MAAM,6BAA6B,CAAC,KAAK,CAAC;QAAE,OAAO;IACvD,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,CACpC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,6BAA6B,CAAC,KAAK,CAAC,CAAC,CACtE,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,KAAkC;IAElC,MAAM,MAAM,GAAG,iCAAiC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,KAAK,UAAU,mBAAmB,CAChC,KAAkC,EAClC,MAA8B;IAE9B,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,2BAA2B,EAAE,CAAC;IACrE,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;QAAE,OAAO,IAAI,CAAC;IACjD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CACjC,KAAK,CAAC,OAAO,EACb,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAC1C,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CACzD,CACF,CAAC;IACF,MAAM,+BAA+B,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACpE,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;IACjE,OAAO,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,KAGC;IAED,MAAM,MAAM,GAAG,iCAAiC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,KAGC,EACD,MAA8B;IAE9B,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAC/C,MAAM,UAAU,GAAG;QACjB,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,mDAAmD;QAC5D,MAAM,EAAE,QAAQ;KACR,CAAC;IACX,qEAAqE;IACrE,uEAAuE;IACvE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;QAAE,OAAO,UAAU,CAAC;IAC1C,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QACzB,IAAI,MAAM,IAAI,CAAC,6BAA6B,CAAC,cAAc,CAAC,EAAE,CAAC;YAC7D,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;QACvC,CAAC;IACH,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;QAAE,OAAO,UAAU,CAAC;IAC1C,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,4BAA4B,CAC/D,cAAc,EACd,EAAE,UAAU,EAAE,MAAM,EAAE,CACvB,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO;YACL,UAAU,EAAE,MAAM,CAAC,MAAM;YACzB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IACD,yEAAyE;IACzE,gCAAgC;IAChC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;QAAE,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAC9E,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACrD,IAAI,MAAM;QAAE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;;QAChC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACjC,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC1C,IAAI,MAAM;QAAE,MAAM,+BAA+B,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;;QAC/D,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;IACjC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACxD,CAAC","sourcesContent":["import type { RequestResult } from \"@tearleads/api-client\";\nimport type { UpdateOrganizationMembershipRequest } from \"@tearleads/validators/request\";\nimport type {\n  OrganizationMembershipResponse,\n  OrganizationMembershipsResponse,\n} from \"@tearleads/validators/response\";\nimport type { DomainScope } from \"../../../data/shared/domainScope\";\nimport type { ExecSql } from \"../../../data/sqlite/sqlSchema\";\nimport {\n  getOrCreateOrganizationSyncPauses,\n  type OrganizationSyncPauses,\n} from \"../../sync\";\n\n/** One organization the user belongs to, with their own choices for it. */\nexport type OrganizationMembership = OrganizationMembershipResponse;\n\nexport interface OrganizationMembershipApi {\n  listOrganizationMemberships(): Promise<OrganizationMembershipsResponse | null>;\n  updateOrganizationMembership(\n    organizationId: string,\n    input: UpdateOrganizationMembershipRequest,\n  ): Promise<RequestResult<OrganizationMembershipResponse>>;\n}\n\n/**\n * What applying a pause needs from the device's content. Wired by the\n * composition root to the container tree and the document sync lanes.\n */\nexport interface OrganizationContentHost {\n  /**\n   * Removes an organization's content, keeping its metadata root. Refuses,\n   * returning false, while any of its writes is unsynced or still queued in\n   * an open store.\n   */\n  forgetOrganizationContent(organizationId: string): Promise<boolean>;\n  /** Whether any local write for the organization has not uploaded yet. */\n  hasUnsyncedOrganizationWrites(organizationId: string): Promise<boolean>;\n  /** Asks every sync lane to upload now and waits briefly for them to idle. */\n  flushWrites(): Promise<void>;\n  /** Re-lists the whole tree so resumed organizations download again. */\n  refetchContent(): Promise<void>;\n  /**\n   * Runs `retry` each time the scope's sync lanes go idle until it resolves\n   * true. A later call replaces the pending retry.\n   */\n  retryWhenWritesSettle(retry: () => Promise<boolean>): void;\n}\n\ninterface OrganizationMembershipInput {\n  readonly apiClient: OrganizationMembershipApi;\n  readonly domainScope: DomainScope;\n  readonly execSql: ExecSql;\n  readonly host: OrganizationContentHost;\n  /**\n   * Whether the session still uses `domainScope`. A membership list or pause\n   * that completes after an identity switch must not touch the new identity's\n   * device state.\n   */\n  readonly isCurrent: () => boolean;\n}\n\nexport type OrganizationSyncPauseResult =\n  | { readonly status: \"updated\"; readonly membership: OrganizationMembership }\n  | { readonly status: \"unsynced-writes\" }\n  | {\n      readonly status: \"failed\";\n      readonly httpStatus: number | null;\n      readonly message: string;\n    };\n\nasync function forgetEveryPausedOrganization(input: {\n  readonly host: OrganizationContentHost;\n  readonly pauses: OrganizationSyncPauses;\n}): Promise<boolean> {\n  let complete = true;\n  for (const organizationId of [...input.pauses.pausedOrganizationIds()]) {\n    if (!(await input.host.forgetOrganizationContent(organizationId))) {\n      complete = false;\n    }\n  }\n  return complete;\n}\n\n/**\n * Removes the content of every paused organization that has nothing left to\n * upload. An organization with pending or queued writes keeps syncing those\n * out and is retried once the sync lanes go idle, so pausing never discards\n * unsynced work and a removal does not wait for the next membership read.\n */\nexport async function forgetPausedOrganizationContent(input: {\n  readonly host: OrganizationContentHost;\n  readonly pauses: OrganizationSyncPauses;\n}): Promise<void> {\n  if (await forgetEveryPausedOrganization(input)) return;\n  input.host.retryWhenWritesSettle(() =>\n    input.pauses.runExclusive(() => forgetEveryPausedOrganization(input)),\n  );\n}\n\n/**\n * Reads the user's memberships and applies their pause choices, including\n * ones made on another device: paused organizations leave this device, and\n * resumed ones download again. Returns null when the list is unavailable, in\n * which case the persisted pauses stay in force.\n */\nexport async function refreshOrganizationMemberships(\n  input: OrganizationMembershipInput,\n): Promise<OrganizationMembership[] | null> {\n  const pauses = getOrCreateOrganizationSyncPauses(input.domainScope);\n  return pauses.runExclusive(() => applyMembershipList(input, pauses));\n}\n\nasync function applyMembershipList(\n  input: OrganizationMembershipInput,\n  pauses: OrganizationSyncPauses,\n): Promise<OrganizationMembership[] | null> {\n  const response = await input.apiClient.listOrganizationMemberships();\n  if (!response || !input.isCurrent()) return null;\n  const change = await pauses.replace(\n    input.execSql,\n    response.memberships.flatMap((membership) =>\n      membership.syncPaused ? [membership.organizationId] : [],\n    ),\n  );\n  await forgetPausedOrganizationContent({ host: input.host, pauses });\n  if (change.resumed.length > 0) await input.host.refetchContent();\n  return [...response.memberships];\n}\n\n/**\n * Pauses or resumes one organization for every device of this user. Pausing\n * first uploads this device's pending writes and is refused while any remain,\n * so the local copy it removes holds nothing the server lacks.\n */\nexport async function setOrganizationSyncPaused(\n  input: OrganizationMembershipInput & {\n    readonly organizationId: string;\n    readonly paused: boolean;\n  },\n): Promise<OrganizationSyncPauseResult> {\n  const pauses = getOrCreateOrganizationSyncPauses(input.domainScope);\n  return pauses.runExclusive(() => applySyncPauseChoice(input, pauses));\n}\n\nasync function applySyncPauseChoice(\n  input: OrganizationMembershipInput & {\n    readonly organizationId: string;\n    readonly paused: boolean;\n  },\n  pauses: OrganizationSyncPauses,\n): Promise<OrganizationSyncPauseResult> {\n  const { host, organizationId, paused } = input;\n  const scopeEnded = {\n    httpStatus: null,\n    message: \"The session changed before sync could be changed.\",\n    status: \"failed\",\n  } as const;\n  // Queued behind other membership work, the session may have switched\n  // identity; the shared API client would then act for the new identity.\n  if (!input.isCurrent()) return scopeEnded;\n  if (paused) {\n    await host.flushWrites();\n    if (await host.hasUnsyncedOrganizationWrites(organizationId)) {\n      return { status: \"unsynced-writes\" };\n    }\n  }\n  if (!input.isCurrent()) return scopeEnded;\n  const result = await input.apiClient.updateOrganizationMembership(\n    organizationId,\n    { syncPaused: paused },\n  );\n  if (!result.ok) {\n    return {\n      httpStatus: result.status,\n      message: result.message,\n      status: \"failed\",\n    };\n  }\n  // The choice is recorded; a scope that ended meanwhile applies it on its\n  // next membership read instead.\n  if (!input.isCurrent()) return { membership: result.data, status: \"updated\" };\n  await pauses.load(input.execSql);\n  const next = new Set(pauses.pausedOrganizationIds());\n  if (paused) next.add(organizationId);\n  else next.delete(organizationId);\n  await pauses.replace(input.execSql, next);\n  if (paused) await forgetPausedOrganizationContent({ host, pauses });\n  else await host.refetchContent();\n  return { membership: result.data, status: \"updated\" };\n}\n"]}

package/workflows/sync/index.d.ts

@@ -1,5 +1,6 @@
 export { createDomainScope, type DomainScope, } from "../../data/shared/domainScope.js";
 export { getRuntimePeerSeed } from "../../data/sync/crdtPeerSeed.js";
+export { getOrCreateOrganizationSyncPauses, isPauseRemovedDocument, isRetainedWhileSyncPaused, type OrganizationSyncPauseChange, type OrganizationSyncPauseSubject, type OrganizationSyncPauses, recordPauseRemovedDocument, } from "../../data/sync/organizationSyncPauses.js";
 export { markOriginatedDocuments } from "../../data/sync/originatedDocuments.js";
 export type { DomainSyncCoordinator, DomainSyncSnapshot, SyncIdleOptions, SyncLane, SyncLaneConfig, SyncLaneLastAction, SyncLanePhase, SyncLaneProgress, SyncLaneSnapshot, SyncLaneStatus, UploadSyncLane, UploadSyncLaneOptions, } from "../../data/sync/syncCoordinator.js";
 export { beginDomainSyncUploadLane, getDomainSyncCoordinatorSnapshot, getOrCreateDomainSyncCoordinator, hasDomainSyncCoordinatorPendingWork, requestAllDomainSyncLanes, subscribeToDomainSyncCoordinator, waitForDomainSyncCoordinatorToSettle, } from "../../data/sync/syncCoordinator.js";

package/workflows/sync/index.js

@@ -1,5 +1,6 @@
 export { createDomainScope, } from "../../data/shared/domainScope.js";
 export { getRuntimePeerSeed } from "../../data/sync/crdtPeerSeed.js";
+export { getOrCreateOrganizationSyncPauses, isPauseRemovedDocument, isRetainedWhileSyncPaused, recordPauseRemovedDocument, } from "../../data/sync/organizationSyncPauses.js";
 export { markOriginatedDocuments } from "../../data/sync/originatedDocuments.js";
 export { beginDomainSyncUploadLane, getDomainSyncCoordinatorSnapshot, getOrCreateDomainSyncCoordinator, hasDomainSyncCoordinatorPendingWork, requestAllDomainSyncLanes, subscribeToDomainSyncCoordinator, waitForDomainSyncCoordinatorToSettle, } from "../../data/sync/syncCoordinator.js";
 export { clearRemoteSyncState, } from "./remoteReset.js";

package/workflows/sync/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,GAElB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAe9E,OAAO,EACL,yBAAyB,EACzB,gCAAgC,EAChC,gCAAgC,EAChC,mCAAmC,EACnC,yBAAyB,EACzB,gCAAgC,EAChC,oCAAoC,GACrC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,oBAAoB,GAGrB,MAAM,eAAe,CAAC","sourcesContent":["export {\n  createDomainScope,\n  type DomainScope,\n} from \"../../data/shared/domainScope\";\nexport { getRuntimePeerSeed } from \"../../data/sync/crdtPeerSeed\";\nexport { markOriginatedDocuments } from \"../../data/sync/originatedDocuments\";\nexport type {\n  DomainSyncCoordinator,\n  DomainSyncSnapshot,\n  SyncIdleOptions,\n  SyncLane,\n  SyncLaneConfig,\n  SyncLaneLastAction,\n  SyncLanePhase,\n  SyncLaneProgress,\n  SyncLaneSnapshot,\n  SyncLaneStatus,\n  UploadSyncLane,\n  UploadSyncLaneOptions,\n} from \"../../data/sync/syncCoordinator\";\nexport {\n  beginDomainSyncUploadLane,\n  getDomainSyncCoordinatorSnapshot,\n  getOrCreateDomainSyncCoordinator,\n  hasDomainSyncCoordinatorPendingWork,\n  requestAllDomainSyncLanes,\n  subscribeToDomainSyncCoordinator,\n  waitForDomainSyncCoordinatorToSettle,\n} from \"../../data/sync/syncCoordinator\";\nexport {\n  type ClearRemoteSyncStateResult,\n  clearRemoteSyncState,\n  type RemoteResetInput,\n  type RemoteResetReplacement,\n} from \"./remoteReset\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,GAElB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EACL,iCAAiC,EACjC,sBAAsB,EACtB,yBAAyB,EAIzB,0BAA0B,GAC3B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAe9E,OAAO,EACL,yBAAyB,EACzB,gCAAgC,EAChC,gCAAgC,EAChC,mCAAmC,EACnC,yBAAyB,EACzB,gCAAgC,EAChC,oCAAoC,GACrC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,oBAAoB,GAGrB,MAAM,eAAe,CAAC","sourcesContent":["export {\n  createDomainScope,\n  type DomainScope,\n} from \"../../data/shared/domainScope\";\nexport { getRuntimePeerSeed } from \"../../data/sync/crdtPeerSeed\";\nexport {\n  getOrCreateOrganizationSyncPauses,\n  isPauseRemovedDocument,\n  isRetainedWhileSyncPaused,\n  type OrganizationSyncPauseChange,\n  type OrganizationSyncPauseSubject,\n  type OrganizationSyncPauses,\n  recordPauseRemovedDocument,\n} from \"../../data/sync/organizationSyncPauses\";\nexport { markOriginatedDocuments } from \"../../data/sync/originatedDocuments\";\nexport type {\n  DomainSyncCoordinator,\n  DomainSyncSnapshot,\n  SyncIdleOptions,\n  SyncLane,\n  SyncLaneConfig,\n  SyncLaneLastAction,\n  SyncLanePhase,\n  SyncLaneProgress,\n  SyncLaneSnapshot,\n  SyncLaneStatus,\n  UploadSyncLane,\n  UploadSyncLaneOptions,\n} from \"../../data/sync/syncCoordinator\";\nexport {\n  beginDomainSyncUploadLane,\n  getDomainSyncCoordinatorSnapshot,\n  getOrCreateDomainSyncCoordinator,\n  hasDomainSyncCoordinatorPendingWork,\n  requestAllDomainSyncLanes,\n  subscribeToDomainSyncCoordinator,\n  waitForDomainSyncCoordinatorToSettle,\n} from \"../../data/sync/syncCoordinator\";\nexport {\n  type ClearRemoteSyncStateResult,\n  clearRemoteSyncState,\n  type RemoteResetInput,\n  type RemoteResetReplacement,\n} from \"./remoteReset\";\n"]}