@tinycloud/node-sdk 3.2.0-beta.1 → 3.2.0-beta.3

package/dist/authority-mTQEgN56.d.ts

@@ -0,0 +1,97 @@
+import { PermissionEntry, ReplicationOptions as ReplicationOptions$1, TinyCloudSession } from '@tinycloud/sdk-core';
+import { ReplicationOptions, AuthorityRefusal, ReplicationAuthority } from '@tinycloud/sdk-services';
+
+/** Constructor-time validation; the space-dependent secrets check runs at sign-in and open. */
+declare function assertValidReplicationConfig(replication: (ReplicationOptions & {
+    storage?: unknown;
+}) | undefined): void;
+
+declare function hasUnrestrictedGetCoverage(entries: readonly PermissionEntry[], spaceId: string, prefix: string): boolean;
+declare function augmentSignInEntriesWithReplication(input: {
+    entries: readonly PermissionEntry[];
+    primarySpaceId: string;
+    replication?: Pick<ReplicationOptions$1, "prefixes" | "allowSecrets">;
+}): PermissionEntry[];
+
+/**
+ * Replication authority (TC-858, plan v3 §4).
+ *
+ * `ReplicationAuthority` answers, per configured prefix, whether this node's
+ * session can back a local replica: the session UCAN itself (delegate
+ * posture), a child UCAN minted through `delegateTo`, or nothing (the
+ * controller then reports `grant_missing` and reads from the network).
+ *
+ * The unrestricted-authority rule is enforced here, before any network work:
+ * a prefix covered only by a caveated `get`/`sync` refuses with
+ * `CAVEATED_AUTHORITY` — on the session path, the runtime-grant path, and on
+ * any reuse of an installed grant (the adapter marks every grant's
+ * `unconstrained` flag; the controller enforces it on reuse).
+ */
+
+/**
+ * Whether the signed `att` grants `ability` over the selected namespace, with
+ * each grant unrestricted (no caveats). A bare selector requires both its
+ * exact key and its slash descendants; a trailing-slash selector is one range.
+ */
+declare function ucanAttCovers(att: Record<string, Record<string, unknown>>, space: string, prefix: string, ability: string, options?: {
+    ignoreCaveats?: boolean;
+}): boolean;
+/** `unconstrained` for `ReplicaGrantInfo` (§2.1): get AND sync on the prefix carry no caveats. */
+declare function ucanAttUnconstrainedFor(att: Record<string, Record<string, unknown>>, space: string, prefix: string): boolean;
+interface DelegationPlanResult {
+    path: "session" | "runtime";
+    parentCid: string;
+    expiresAt: number;
+}
+/**
+ * The `TinyCloudNode` internals the authority needs. `planDelegation` is the
+ * pure extraction of `delegateTo`'s parent selection (§4.3), so `plan` and
+ * `mint` can never disagree about which parent or expiry a delegation gets.
+ */
+type ReplicationAuthoritySession = Pick<TinyCloudSession, "delegationHeader" | "delegationCid" | "spaceId" | "verificationMethod" | "jwk"> & Partial<Pick<TinyCloudSession, "siwe">>;
+interface ReplicationAuthorityHost {
+    replicationSession(): ReplicationAuthoritySession | undefined;
+    /** The SIWE "Expiration Time" of the session — the delegateTo delegation cap. */
+    siweExpiration(siwe: string): Date | undefined;
+    planDelegation(entries: PermissionEntry[], options?: {
+        expiry?: string | number;
+    }): ({
+        grant?: unknown;
+    } & DelegationPlanResult) | AuthorityRefusal;
+    mintDelegation(deviceDid: string, entries: PermissionEntry[]): Promise<{
+        ucan: string;
+        expiresAt: number;
+    }>;
+}
+/** Milliseconds of validity a session or parent must have left for authority reuse (delegateTo's margin). */
+declare const AUTHORITY_EXPIRY_MARGIN_MS = 60000;
+/** Verify a compact session delegation before using any persisted space metadata. */
+declare function replicationScopeFromSignedSession(input: {
+    delegationHeader: {
+        Authorization: string;
+    };
+    delegationCid: string;
+    verificationMethod: string;
+    persistedSpace: string;
+}): {
+    space: string;
+    principal: string;
+} | undefined;
+declare function createReplicationAuthority(host: ReplicationAuthorityHost): ReplicationAuthority;
+
+declare const __authority_AUTHORITY_EXPIRY_MARGIN_MS: typeof AUTHORITY_EXPIRY_MARGIN_MS;
+type __authority_DelegationPlanResult = DelegationPlanResult;
+type __authority_ReplicationAuthorityHost = ReplicationAuthorityHost;
+type __authority_ReplicationAuthoritySession = ReplicationAuthoritySession;
+declare const __authority_assertValidReplicationConfig: typeof assertValidReplicationConfig;
+declare const __authority_augmentSignInEntriesWithReplication: typeof augmentSignInEntriesWithReplication;
+declare const __authority_createReplicationAuthority: typeof createReplicationAuthority;
+declare const __authority_hasUnrestrictedGetCoverage: typeof hasUnrestrictedGetCoverage;
+declare const __authority_replicationScopeFromSignedSession: typeof replicationScopeFromSignedSession;
+declare const __authority_ucanAttCovers: typeof ucanAttCovers;
+declare const __authority_ucanAttUnconstrainedFor: typeof ucanAttUnconstrainedFor;
+declare namespace __authority {
+  export { __authority_AUTHORITY_EXPIRY_MARGIN_MS as AUTHORITY_EXPIRY_MARGIN_MS, type __authority_DelegationPlanResult as DelegationPlanResult, type __authority_ReplicationAuthorityHost as ReplicationAuthorityHost, type __authority_ReplicationAuthoritySession as ReplicationAuthoritySession, __authority_assertValidReplicationConfig as assertValidReplicationConfig, __authority_augmentSignInEntriesWithReplication as augmentSignInEntriesWithReplication, __authority_createReplicationAuthority as createReplicationAuthority, __authority_hasUnrestrictedGetCoverage as hasUnrestrictedGetCoverage, __authority_replicationScopeFromSignedSession as replicationScopeFromSignedSession, __authority_ucanAttCovers as ucanAttCovers, __authority_ucanAttUnconstrainedFor as ucanAttUnconstrainedFor };
+}
+
+export { AUTHORITY_EXPIRY_MARGIN_MS as A, type DelegationPlanResult as D, type ReplicationAuthorityHost as R, __authority as _, type ReplicationAuthoritySession as a, assertValidReplicationConfig as b, augmentSignInEntriesWithReplication as c, createReplicationAuthority as d, ucanAttUnconstrainedFor as e, hasUnrestrictedGetCoverage as h, replicationScopeFromSignedSession as r, ucanAttCovers as u };