@solarpunkltd/swarm-id 0.0.0-stage → 0.8.0

package/dist/errors.d.ts

@@ -0,0 +1,35 @@
+import type { SwarmIdErrorCode, UploadUnavailableReason, WireError } from "./types";
+/** The optional fields of a `SwarmIdError`, by code */
+export interface SwarmIdErrorDetails {
+    /** With `upload-unavailable`: why the session refuses to stamp */
+    reason?: UploadUnavailableReason;
+    /** With `bee-rejected`: the HTTP status Bee or the gateway answered */
+    status?: number;
+    /** With `bee-rejected`: Bee's own message from the response body */
+    beeMessage?: string;
+    /** With `bee-rejected`: the path of the request that was refused (no host) */
+    url?: string;
+    cause?: unknown;
+}
+/**
+ * Every rejection a `SwarmIdClient` call produces (#761). `message` is the
+ * text a caller always got; `code` is the stable part to branch on, and the
+ * details are set for the codes that have them.
+ *
+ * Constructed on the client side from the wire fields: an `Error` posted
+ * through the iframe bridge arrives as a plain `Error` (structured clone keeps
+ * `name` and `message` only), so the instance never crosses it. Prefer
+ * `error.code` over `instanceof` in a dApp that may bundle two copies of the
+ * package.
+ */
+export declare class SwarmIdError extends Error {
+    readonly code: SwarmIdErrorCode;
+    readonly reason?: UploadUnavailableReason;
+    readonly status?: number;
+    readonly beeMessage?: string;
+    readonly url?: string;
+    constructor(code: SwarmIdErrorCode, message: string, details?: SwarmIdErrorDetails);
+    /** The fields that cross the bridge */
+    toWire(): WireError;
+    static fromWire(wire: WireError): SwarmIdError;
+}

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * `@solarpunkltd/swarm-id` — what a dApp imports.
+ *
+ * The identity UI's half (sync, key derivation, the account bus, the proxy)
+ * is `@solarpunkltd/swarm-id/internal`; see `internal.ts`. Nothing is exported here
+ * for the lib's own sake: the proxy and the client import their modules
+ * directly, and tests do the same.
+ */
+export { SwarmIdClient } from "./swarm-id-client";
+export type { ClientOptions, AuthStatus, ConnectionInfo, Avatar, AvatarSource, PostageBatch, AppMetadata, ButtonConfig, RequestOptions, UploadOptions, DownloadOptions, UploadResult, UploadUnavailableReason, FileData, SingleOwnerChunk, SocUploadResult, SocRawUploadResult, StampChunkInput, StampedChunk, SOCReader, SOCWriter, FeedReader, FeedWriter, SequentialFeedReader, SequentialFeedWriter, SequentialFeedPayloadResult, SequentialFeedReferenceResult, SequentialFeedUploadResult, ActUploadOptions, UploadFilesOptions, CollectionFileInput, CollectionEntry, } from "./types";
+export type { Reference } from "./schemas";
+export { DEFAULT_BEE_NODE_URL } from "./schemas";
+export { generatedAvatar, generatedAvatarSvg } from "./utils/avatar";
+export { buildBzzManifestNode, extractContentFromFlatManifest, extractEntryFromManifest, } from "./proxy/manifest-builder";
+export { saveMantarayTreeRecursively } from "./proxy/mantaray";
+export type { UploadCallback } from "./proxy/mantaray";
+export { collectionPath } from "./utils/collection";
+export { formatTTL } from "./utils/ttl";
+export { hexToUint8Array, uint8ArrayToHex } from "./utils/hex";
+export { SwarmIdError } from "./errors";
+export type { SwarmIdErrorDetails } from "./errors";
+export type { SwarmIdErrorCode } from "./types";
+export { withTimeout, TimeoutError } from "./utils/promise";
+export { jsonRpcCall, jsonRpcBatch } from "./utils/json-rpc";
+export type { JsonRpcOptions } from "./utils/json-rpc";
+export { CHAT_BINDING_TITLE, acceptedChatBinding, buildChatBindingMessage, isCleanSiteOrigin, parseChatBindingMessage, verifyChatBinding, } from "./utils/chat-binding";
+export type { ChatBinding, ChatBindingFields, ExpectedChatBinding, SiteOriginOptions, VerifiedChatBinding, } from "./utils/chat-binding";

package/dist/internal.d.ts

@@ -0,0 +1,49 @@
+/**
+ * `@solarpunkltd/swarm-id/internal` — the identity UI's half of the trusted domain.
+ *
+ * Everything here takes the account record, the master key or the
+ * `derivationKey`, none of which ever leaves the trusted domain, so a dApp has
+ * no use for any of it; a dApp holds a `SwarmIdClient` from the package root.
+ * The proxy iframe, which lives in the same lib, reaches these modules directly.
+ * A name is on this list because `ui/` (its tests included) imports it, or
+ * because the docs' "Storage layout" page names it for a host that writes the
+ * identity UI's `localStorage` itself (#815) — and for no other reason:
+ * nothing is re-exported for a caller that does not exist (#801).
+ */
+export { AccountBus } from "./bus/account-bus";
+export { accountDeltaSnapshot, restoreLocalSessionFields, } from "./bus/account-delta";
+export { deriveBusContext } from "./bus/bus-context";
+export { PRESENCE_INTERVAL_MS, PresenceTracker } from "./bus/presence";
+export { SignalingTransport } from "./bus/signaling-transport";
+export { downloadEncryptedSOC } from "./proxy/download-data";
+export { SocUploadError, uploadSOC } from "./proxy/upload";
+export type { UploadTarget } from "./proxy/upload";
+export { BatchIdSchema, DEFAULT_GNOSIS_RPC_URL, LocalAccountSchemaV1, NetworkSettingsSchemaV1, PostageStampSchemaV1, PrivateKeySchema, SyncedAccountSchemaV1, isSignedOutAccount, } from "./schemas";
+export type { AccessMethod, Account, ConnectedApp, Device, LocalVault, NetworkSettings, PostageStamp, SignedInAccount, SignedOutAccount, SyncedAccount, } from "./schemas";
+export { DebouncedUtilizationUploader } from "./storage/debounced-uploader";
+export { PASSWORD_KDF_ITERATIONS, decryptSeed, deriveKeyFromPassword, deriveKeyFromPrf, deriveKeyFromSecret, deriveKeyFromSignature, encryptSeed, randomSalt, } from "./utils/seed-encryption";
+export { UtilizationStoreDB } from "./storage/utilization-store";
+export { initProxy } from "./swarm-id-proxy";
+export { createSyncAccount, deriveAccountDerivationKey, derivePostageSignerKey, deriveSwarmEncryptionKey, foldAccountFromSwarm, foldedToSyncedAccount, mergeConnectedApps, mergeDevicesList, mergePostageStamps, } from "./sync";
+export type { SyncAccountFunction, SyncResult } from "./sync";
+export { PartitionLease } from "./sync/partition-lease";
+export type { PartitionLeaseStateSnapshot } from "./sync/partition-lease";
+export { AuthDataSchema, STORAGE_CHALLENGE_KEY, STORAGE_KEY_ACCOUNTS, STORAGE_KEY_NETWORK_SETTINGS, leaseCacheStorageKey, } from "./types";
+export type { AccountStateSnapshot } from "./utils/account-state-snapshot";
+export { BUCKET_DEPTH, MIN_USABLE_BATCH_DEPTH, PARTITION_COUNT, UtilizationAwareStamper, } from "./utils/batch-utilization";
+export { runCoalescedAcrossTabs } from "./utils/coalesced-task";
+export { DAY, appSessionDuration } from "./utils/constants";
+export { detectDeviceName, getOrCreateDeviceId, mergeDevices, } from "./utils/device-id";
+export { createChatBinding, onlySiteChatBinding, siteChatAddress, } from "./utils/chat-binding";
+export { DEFAULT_SITE_ALLOW_LIST_ENS_NAME, DEFAULT_SITE_ALLOW_LIST_RECORD_KEY, createSiteAllowList, } from "./utils/site-allow-list";
+export type { SiteAllowList, SiteAllowListSettings, SiteCheck, } from "./utils/site-allow-list";
+export { hexAddress } from "./utils/hex";
+export { deriveChatKey, derivePostageSignerKeySync, deriveSecret, deriveSecretSync, deriveSharingKey, } from "./utils/key-derivation";
+export { calculateContractTTLSeconds, fetchOnChainBatchStateResult, } from "./utils/postage-contract";
+export { stampsReachableByApp } from "./utils/postage-stamp-association";
+export { sleep, withIdleTimeout } from "./utils/promise";
+export { remainingLifespanSeconds } from "./utils/stamp-lifespan";
+export { createAccountsStorageManager, createNetworkSettingsStorageManager, serializePostageStamp, serializeSyncedAccount, } from "./utils/storage-managers";
+export { markFirstPartyStorage } from "./utils/storage-probe";
+export { GNOSIS_BLOCK_TIME, calculateStampAmountForDays } from "./utils/ttl";
+export { isHttpUrl } from "./utils/url";