@seedprotocol/arweave 0.6.7 → 0.6.9

package/dist/ArweaveClient/BaseArweaveClient.d.ts

@@ -21,6 +21,17 @@ export declare abstract class BaseArweaveClient {
      * Hostname (+ optional port) without a path prefix — safe for the `arweave` npm client's `init({ host })`.
      */
     static getArweaveSdkHost(): string;
+    /**
+     * `{ host, port, protocol }` for the `arweave` npm client's `init()`. The port is always set: the
+     * web build of `arweave` otherwise falls back to the page's own port (`https://arweave.net:5173`),
+     * and a `host:port` passed as `host` becomes `host:port:443`. Path prefixes are dropped — the
+     * `arweave` client cannot address a gateway mounted under a path.
+     */
+    static getArweaveJsApiConfig(): {
+        host: string;
+        port: number;
+        protocol: 'http' | 'https';
+    };
     /**
      * Path prefix on the gateway origin (e.g. `/api/seed-gateway`), or empty.
      */

package/dist/ArweaveClient/BaseArweaveClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseArweaveClient.d.ts","sourceRoot":"","sources":["../../src/ArweaveClient/BaseArweaveClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,wBAAwB,EACzB,MAAM,qBAAqB,CAAA;AAE5B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAoBzD,8BAAsB,iBAAiB;IACrC,OAAO,CAAC,MAAM,CAAC,KAAK,CAA8B;IAElD,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI;IAS5C,OAAO,CAAC,MAAM,CAAC,WAAW;IAS1B;;OAEG;IACH,MAAM,CAAC,cAAc,IAAI;QAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;IAYrE;;;OAGG;IACH,MAAM,CAAC,OAAO,IAAI,MAAM;IAIxB;;OAEG;IACH,MAAM,CAAC,iBAAiB,IAAI,MAAM;IAMlC;;OAEG;IACH,MAAM,CAAC,cAAc,IAAI,MAAM;IAO/B;;OAEG;IACH,MAAM,CAAC,WAAW,IAAI,MAAM,GAAG,OAAO;IAItC;;;OAGG;IACH,MAAM,CAAC,UAAU,IAAI,MAAM;IAK3B;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQlC;;OAEG;IACH,MAAM,CAAC,mBAAmB,IAAI,OAAO;IAIrC;;OAEG;IACH,MAAM,CAAC,sCAAsC,IAAI,IAAI;IAIrD;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAOlD;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQjD;;;OAGG;IACH,MAAM,CAAC,WAAW,IAAI,MAAM;IAI5B;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAI/C;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAQlD,MAAM,CAAC,gBAAgB,IAAI,aAAa;IAIxC,MAAM,CAAC,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9E,MAAM,CAAC,kBAAkB,CACvB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;IAI/B,MAAM,CAAC,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAI3E,MAAM,CAAC,iBAAiB,CACtB,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,GAAG,CAAC;IAIf,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;CAG7E"}
+{"version":3,"file":"BaseArweaveClient.d.ts","sourceRoot":"","sources":["../../src/ArweaveClient/BaseArweaveClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,wBAAwB,EACzB,MAAM,qBAAqB,CAAA;AAE5B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAoBzD,8BAAsB,iBAAiB;IACrC,OAAO,CAAC,MAAM,CAAC,KAAK,CAA8B;IAElD,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI;IAS5C,OAAO,CAAC,MAAM,CAAC,WAAW;IAS1B;;OAEG;IACH,MAAM,CAAC,cAAc,IAAI;QAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;IAYrE;;;OAGG;IACH,MAAM,CAAC,OAAO,IAAI,MAAM;IAIxB;;OAEG;IACH,MAAM,CAAC,iBAAiB,IAAI,MAAM;IAMlC;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE;IAW1F;;OAEG;IACH,MAAM,CAAC,cAAc,IAAI,MAAM;IAO/B;;OAEG;IACH,MAAM,CAAC,WAAW,IAAI,MAAM,GAAG,OAAO;IAItC;;;OAGG;IACH,MAAM,CAAC,UAAU,IAAI,MAAM;IAK3B;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQlC;;OAEG;IACH,MAAM,CAAC,mBAAmB,IAAI,OAAO;IAIrC;;OAEG;IACH,MAAM,CAAC,sCAAsC,IAAI,IAAI;IAIrD;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAOlD;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQjD;;;OAGG;IACH,MAAM,CAAC,WAAW,IAAI,MAAM;IAI5B;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAI/C;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAQlD,MAAM,CAAC,gBAAgB,IAAI,aAAa;IAIxC,MAAM,CAAC,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9E,MAAM,CAAC,kBAAkB,CACvB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;IAI/B,MAAM,CAAC,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAI3E,MAAM,CAAC,iBAAiB,CACtB,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,GAAG,CAAC;IAIf,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;CAG7E"}

package/dist/gateway/gatewayState.d.ts

@@ -2,4 +2,16 @@ import type { ResolvedSeedGatewayEndpoints } from '../types/gateway.js';
 /** Last endpoints applied during client init (for read-path helpers). */
 export declare function getResolvedSeedGatewayEndpoints(): ResolvedSeedGatewayEndpoints | null;
 export declare function setResolvedSeedGatewayEndpoints(value: ResolvedSeedGatewayEndpoints | null): void;
+/**
+ * Gateways tried before the resolved / public hosts for `/raw/{id}` reads — typically the gateway
+ * the app uploads through (Hyper sidecar or app-server proxy), which serves data items before they
+ * reach L1 or the public gateways. Does not affect upload, GraphQL or {@link BaseArweaveClient} host.
+ */
+export declare function getPreferredArweaveReadBaseUrls(): string[];
+/**
+ * Replace the preferred read gateways. Each entry is a base URL with scheme and any path prefix
+ * (`https://app.example.com/api/seed-gateway`); same-origin relative paths (`/api/seed-gateway`)
+ * resolve against `window.location.origin` and are dropped when there is no origin. Pass `[]` to clear.
+ */
+export declare function setPreferredArweaveReadBaseUrls(urls: readonly string[]): void;
 //# sourceMappingURL=gatewayState.d.ts.map

package/dist/gateway/gatewayState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gatewayState.d.ts","sourceRoot":"","sources":["../../src/gateway/gatewayState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAA;AAIvE,yEAAyE;AACzE,wBAAgB,+BAA+B,IAAI,4BAA4B,GAAG,IAAI,CAErF;AAED,wBAAgB,+BAA+B,CAC7C,KAAK,EAAE,4BAA4B,GAAG,IAAI,GACzC,IAAI,CAEN"}
+{"version":3,"file":"gatewayState.d.ts","sourceRoot":"","sources":["../../src/gateway/gatewayState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAA;AAKvE,yEAAyE;AACzE,wBAAgB,+BAA+B,IAAI,4BAA4B,GAAG,IAAI,CAErF;AAED,wBAAgB,+BAA+B,CAC7C,KAAK,EAAE,4BAA4B,GAAG,IAAI,GACzC,IAAI,CAEN;AAID;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,MAAM,EAAE,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAmB7E"}

package/dist/gateway/readBaseUrls.d.ts

@@ -0,0 +1,31 @@
+/** Per-gateway timeout for {@link fetchArweaveRawFromBaseUrl}; a hung gateway must not block the next one. */
+export declare const DEFAULT_ARWEAVE_RAW_READ_TIMEOUT_MS = 10000;
+export type ArweaveReadBaseUrlOptions = {
+    /** Hosts (no scheme) used when no gateway endpoints have been resolved, e.g. a feed's own list. */
+    fallbackHosts?: readonly string[];
+};
+/**
+ * Resolved / public read gateways as base URLs (scheme + host + any path prefix), without the
+ * preferred ones. Does not probe.
+ */
+export declare function getResolvedArweaveReadBaseUrls(options?: ArweaveReadBaseUrlOptions): string[];
+/**
+ * Ordered base URLs for `/raw/{id}` (and `/{id}`) reads: preferred gateways
+ * ({@link setPreferredArweaveReadBaseUrls}) first, then the resolved / public gateways. Does not probe.
+ */
+export declare function getArweaveReadBaseUrls(options?: ArweaveReadBaseUrlOptions): string[];
+/** Run the read-gateway probe unless a sidecar / proxy is already the active path. Never throws. */
+export declare function ensureArweaveReadGatewayForFallback(): Promise<void>;
+/** GET `{baseUrl}/raw/{id}`; `undefined` on network error, timeout or non-2xx. */
+export declare function fetchArweaveRawFromBaseUrl(baseUrl: string, transactionId: string, options?: {
+    timeoutMs?: number;
+}): Promise<Response | undefined>;
+/**
+ * GET `/raw/{id}` across read gateways and return the first non-empty body as text. Preferred
+ * gateways go first and are tried before any read-gateway probe; a just-published item is served
+ * by the gateway it was uploaded through well before it reaches L1 or the public hosts.
+ */
+export declare function fetchArweaveRawTextAcrossGateways(transactionId: string, options?: ArweaveReadBaseUrlOptions & {
+    timeoutMs?: number;
+}): Promise<string | undefined>;
+//# sourceMappingURL=readBaseUrls.d.ts.map

package/dist/gateway/readBaseUrls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readBaseUrls.d.ts","sourceRoot":"","sources":["../../src/gateway/readBaseUrls.ts"],"names":[],"mappings":"AAMA,8GAA8G;AAC9G,eAAO,MAAM,mCAAmC,QAAS,CAAA;AAEzD,MAAM,MAAM,yBAAyB,GAAG;IACtC,mGAAmG;IACnG,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAClC,CAAA;AASD;;;GAGG;AACH,wBAAgB,8BAA8B,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM,EAAE,CAiB5F;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,MAAM,EAAE,CAMpF;AAED,oGAAoG;AACpG,wBAAsB,mCAAmC,IAAI,OAAO,CAAC,IAAI,CAAC,CAUzE;AAED,kFAAkF;AAClF,wBAAsB,0BAA0B,CAC9C,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAC/B,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAkB/B;AAED;;;;GAIG;AACH,wBAAsB,iCAAiC,CACrD,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,yBAAyB,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAC3D,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAuB7B"}

package/dist/gateway/seedGatewayConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"seedGatewayConfig.d.ts","sourceRoot":"","sources":["../../src/gateway/seedGatewayConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,wBAAwB,CAAA;AAG/B,uEAAuE;AACvE,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,sBAAsB,GAC7B,iBAAiB,CAkBnB;AAED,wBAAgB,kCAAkC,CAChD,OAAO,EAAE,yBAAyB,GACjC,iBAAiB,CAanB"}
+{"version":3,"file":"seedGatewayConfig.d.ts","sourceRoot":"","sources":["../../src/gateway/seedGatewayConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,wBAAwB,CAAA;AAG/B,uEAAuE;AACvE,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,sBAAsB,GAC7B,iBAAiB,CAmBnB;AAED,wBAAgB,kCAAkC,CAChD,OAAO,EAAE,yBAAyB,GACjC,iBAAiB,CAanB"}

package/dist/index.d.ts

@@ -17,4 +17,5 @@ export * from './gateway/gatewayState.js';
 export * from './gateway/gatewayCircuitBreaker.js';
 export * from './gateway/resolveSeedGatewayEndpoints.js';
 export * from './gateway/seedGatewayConfig.js';
+export * from './gateway/readBaseUrls.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,wBAAwB,CAAA;AACtC,cAAc,eAAe,CAAA;AAC7B,cAAc,qCAAqC,CAAA;AACnD,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,YAAY,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAC9F,cAAc,4BAA4B,CAAA;AAC1C,cAAc,sCAAsC,CAAA;AACpD,OAAO,EAAE,iBAAiB,IAAI,aAAa,EAAE,MAAM,sCAAsC,CAAA;AACzF,YAAY,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvE,cAAc,sCAAsC,CAAA;AACpD,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,2BAA2B,CAAA;AACzC,cAAc,oCAAoC,CAAA;AAClD,cAAc,0CAA0C,CAAA;AACxD,cAAc,gCAAgC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,wBAAwB,CAAA;AACtC,cAAc,eAAe,CAAA;AAC7B,cAAc,qCAAqC,CAAA;AACnD,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,YAAY,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAC9F,cAAc,4BAA4B,CAAA;AAC1C,cAAc,sCAAsC,CAAA;AACpD,OAAO,EAAE,iBAAiB,IAAI,aAAa,EAAE,MAAM,sCAAsC,CAAA;AACzF,YAAY,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvE,cAAc,sCAAsC,CAAA;AACpD,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,2BAA2B,CAAA;AACzC,cAAc,oCAAoC,CAAA;AAClD,cAAc,0CAA0C,CAAA;AACxD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,2BAA2B,CAAA"}