@solarpunkltd/swarm-id 0.8.0 → 0.8.1

package/dist/sync/batch-write-coordinator.d.ts

@@ -77,6 +77,7 @@ export interface WithWriteOptions {
     wait?: "block" | "skip";
 }
 export interface BatchWriteCoordinatorDeps {
+    /** Read on every use, so a getter here follows a change of node. */
     bee: Bee;
     /** Postage batch id (hex) — the `withBatchWriteLock` key. */
     batchId: string;

package/dist/types.d.ts

@@ -653,6 +653,7 @@ export declare const ConnectionInfoSchema: z.ZodObject<{
         message: z.ZodString;
         signature: z.ZodString;
     }, z.core.$strip>>;
+    beeApiUrl: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type ConnectionInfo = z.infer<typeof ConnectionInfoSchema>;
 export declare const AppMetadataSchema: z.ZodObject<{
@@ -762,6 +763,15 @@ export declare const DeriveAppSecretMessageSchema: z.ZodObject<{
     requestId: z.ZodString;
     label: z.ZodString;
 }, z.core.$strip>;
+/**
+ * The site's own Bee address for this frame from now on, replacing the one
+ * `parentIdentify` gave, for the site's session alone.
+ */
+export declare const SetBeeApiUrlMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"setBeeApiUrl">;
+    requestId: z.ZodString;
+    beeApiUrl: z.ZodString;
+}, z.core.$strip>;
 export declare const GetChatKeyMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"getChatKey">;
     requestId: z.ZodString;
@@ -1366,6 +1376,10 @@ export declare const ParentToIframeMessageSchema: z.ZodDiscriminatedUnion<[z.Zod
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"getChatKey">;
     requestId: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"setBeeApiUrl">;
+    requestId: z.ZodString;
+    beeApiUrl: z.ZodString;
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"stampChunk">;
     requestId: z.ZodString;
@@ -1833,6 +1847,7 @@ export type UploadDataMessage = z.infer<typeof UploadDataMessageSchema>;
 export type DownloadDataMessage = z.infer<typeof DownloadDataMessageSchema>;
 export type DeriveAppSecretMessage = z.infer<typeof DeriveAppSecretMessageSchema>;
 export type GetChatKeyMessage = z.infer<typeof GetChatKeyMessageSchema>;
+export type SetBeeApiUrlMessage = z.infer<typeof SetBeeApiUrlMessageSchema>;
 export type StampChunkSigner = z.infer<typeof StampChunkSignerSchema>;
 export type StampChunkRequest = z.infer<typeof StampChunkRequestSchema>;
 export type StampChunkMessage = z.infer<typeof StampChunkMessageSchema>;
@@ -1917,6 +1932,11 @@ export declare const GetChatKeyResponseMessageSchema: z.ZodObject<{
     requestId: z.ZodString;
     chatKey: z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>;
 }, z.core.$strip>;
+export declare const SetBeeApiUrlResponseMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"setBeeApiUrlResponse">;
+    requestId: z.ZodString;
+    beeApiUrl: z.ZodString;
+}, z.core.$strip>;
 export declare const StampChunkResponseMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"stampChunkResponse">;
     requestId: z.ZodString;
@@ -2122,6 +2142,7 @@ export declare const ConnectionInfoChangedMessageSchema: z.ZodObject<{
         message: z.ZodString;
         signature: z.ZodString;
     }, z.core.$strip>>;
+    beeApiUrl: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const ConnectResponseMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"connectResponse">;
@@ -2365,6 +2386,10 @@ export declare const IframeToParentMessageSchema: z.ZodDiscriminatedUnion<[z.Zod
     type: z.ZodLiteral<"getChatKeyResponse">;
     requestId: z.ZodString;
     chatKey: z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"setBeeApiUrlResponse">;
+    requestId: z.ZodString;
+    beeApiUrl: z.ZodString;
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"stampChunkResponse">;
     requestId: z.ZodString;
@@ -2485,6 +2510,7 @@ export declare const IframeToParentMessageSchema: z.ZodDiscriminatedUnion<[z.Zod
         message: z.ZodString;
         signature: z.ZodString;
     }, z.core.$strip>>;
+    beeApiUrl: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"connectResponse">;
     requestId: z.ZodString;
@@ -2671,6 +2697,7 @@ export type AuthSuccessMessage = z.infer<typeof AuthSuccessMessageSchema>;
 export type UploadDataResponseMessage = z.infer<typeof UploadDataResponseMessageSchema>;
 export type DownloadDataResponseMessage = z.infer<typeof DownloadDataResponseMessageSchema>;
 export type GetChatKeyResponseMessage = z.infer<typeof GetChatKeyResponseMessageSchema>;
+export type SetBeeApiUrlResponseMessage = z.infer<typeof SetBeeApiUrlResponseMessageSchema>;
 export type DeriveAppSecretResponseMessage = z.infer<typeof DeriveAppSecretResponseMessageSchema>;
 export type StampChunkResponseMessage = z.infer<typeof StampChunkResponseMessageSchema>;
 export type UploadFileResponseMessage = z.infer<typeof UploadFileResponseMessageSchema>;
@@ -2990,6 +3017,14 @@ export interface ClientOptions {
     containerId?: string;
     /** URL of a subsidised gateway for users without postage stamps. Gateway handles stamping server-side. */
     subsidisedGatewayUrl?: string;
+    /**
+     * The Bee node this site's content reads and stamped uploads go through, in
+     * place of the node the person set in Swarm ID, which keeps applying on
+     * every other site. The person's account and device coordination stay on
+     * their own node. An http(s) URL, optionally with a path. Change it later
+     * with `setBeeApiUrl`. Held by this site's frame alone and never stored.
+     */
+    beeApiUrl?: string;
 }
 export interface AuthOptions {
     masterKeyStorageKey?: string;

package/dist/utils/url.d.ts

@@ -11,6 +11,14 @@ export declare function normalizeUrl(url: string): string;
  * dialog so a broken Bee/RPC endpoint can't be saved or persisted.
  */
 export declare function isHttpUrl(value: string): boolean;
+/**
+ * True for an address a site may name as its Bee node: an `http:` or
+ * `https:` URL, optionally with a path, the way a gateway in front of Bee is
+ * often mounted. Refused besides what `isHttpUrl` refuses: credentials, which
+ * `fetch` will not send from a URL and throws on, and a query or fragment,
+ * which bee-js would put in the middle of every request path it appends.
+ */
+export declare function isBeeApiUrl(value: string): boolean;
 /**
  * Configuration options for building the authentication URL.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solarpunkltd/swarm-id",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "module",
   "description": "Swarm ID library for authentication and Bee API operations",
   "main": "dist/swarm-id.esm.js",