@idetik/core 0.2.3 → 0.4.0

package/dist/types/src/data/ome_zarr/image_source.d.ts

@@ -2,21 +2,53 @@ import { Location } from "@zarrita/core";
 import { Readable } from "@zarrita/storage";
 import { OmeZarrImageLoader } from "./image_loader";
 import { Version as OmeZarrVersion } from "./metadata_loaders";
+import { type S3FetchStoreProps } from "../zarr/s3_fetch_store";
+type HttpOmeZarrImageSourceProps = {
+    url: string;
+    version?: OmeZarrVersion;
+};
+type S3OmeZarrImageSourceProps = S3FetchStoreProps & {
+    version?: OmeZarrVersion;
+};
+type FileSystemOmeZarrImageSourceProps = {
+    directory: FileSystemDirectoryHandle;
+    version?: OmeZarrVersion;
+    path?: `/${string}`;
+};
 /** Opens an OME-Zarr multiscale image Zarr group from either a URL or local directory. */
 export declare class OmeZarrImageSource {
     readonly location: Location<Readable>;
     readonly version?: OmeZarrVersion;
+    private constructor();
+    open(): Promise<OmeZarrImageLoader>;
     /**
+     * Creates an OmeZarrImageSource from an HTTP(S) URL.
+     *
      * @param url URL of Zarr root
+     * @param version OME-Zarr version
      */
-    constructor(url: string, version?: OmeZarrVersion);
+    static fromHttp(props: HttpOmeZarrImageSourceProps): OmeZarrImageSource;
     /**
+     * Creates an OmeZarrImageSource from an S3 HTTP(S) URL.
+     *
+     * @param url URL of Zarr root
+     * @param version OME-Zarr version
+     * @param credentials AWS credentials for S3 authentication (will generate signatures per-request)
+     * @param region AWS region for S3 bucket (e.g., 'us-east-1')
+     * @param overrides RequestInit overrides to customize fetch behavior (e.g., custom headers for S3 authentication)
+     * @param useSuffixRequest Whether to use suffix requests for range queries
+     */
+    static fromS3(props: S3OmeZarrImageSourceProps): OmeZarrImageSource;
+    /**
+     * Creates an OmeZarrImageSource from a local filesystem directory.
+     *
      * @param directory return value of `window.showDirectoryPicker()` which gives the browser
      *    permission to access a directory (only works in Chrome/Edge)
+     * @param version OME-Zarr version
      * @param path path to image, beginning with "/". This argument allows the application to only
      *    ask the user once for permission to the root directory
      */
-    constructor(directory: FileSystemDirectoryHandle, version?: OmeZarrVersion, path?: `/${string}`);
-    open(): Promise<OmeZarrImageLoader>;
+    static fromFileSystem(props: FileSystemOmeZarrImageSourceProps): OmeZarrImageSource;
 }
+export {};
 //# sourceMappingURL=image_source.d.ts.map

package/dist/types/src/data/ome_zarr/image_source.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image_source.d.ts","sourceRoot":"","sources":["../../../../../src/data/ome_zarr/image_source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAQ5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAGL,OAAO,IAAI,cAAc,EAC1B,MAAM,oBAAoB,CAAC;AAE5B,0FAA0F;AAC1F,qBAAa,kBAAkB;IAC7B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAElC;;OAEG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IACjD;;;;;OAKG;gBAED,SAAS,EAAE,yBAAyB,EACpC,OAAO,CAAC,EAAE,cAAc,EACxB,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE;IAcR,IAAI,IAAI,OAAO,CAAC,kBAAkB,CAAC;CAqCjD"}
+{"version":3,"file":"image_source.d.ts","sourceRoot":"","sources":["../../../../../src/data/ome_zarr/image_source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAQ5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAGL,OAAO,IAAI,cAAc,EAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAgB,KAAK,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAO9E,KAAK,2BAA2B,GAAG;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAEF,KAAK,yBAAyB,GAAG,iBAAiB,GAAG;IACnD,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAEF,KAAK,iCAAiC,GAAG;IACvC,SAAS,EAAE,yBAAyB,CAAC;IACrC,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,CAAC;CACrB,CAAC;AAEF,0FAA0F;AAC1F,qBAAa,kBAAkB;IAC7B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAElC,OAAO;IAKM,IAAI,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAsChD;;;;;OAKG;WACW,QAAQ,CAAC,KAAK,EAAE,2BAA2B;IAQzD;;;;;;;;;OASG;WACW,MAAM,CAAC,KAAK,EAAE,yBAAyB;IAQrD;;;;;;;;OAQG;WACW,cAAc,CAAC,KAAK,EAAE,iCAAiC;CAOtE"}

package/dist/types/src/data/ome_zarr/metadata_loaders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metadata_loaders.d.ts","sourceRoot":"","sources":["../../../../../src/data/ome_zarr/metadata_loaders.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAa,MAAM,cAAc,CAAC;AAEjE,QAAA,MAAM,QAAQ,yBAA0B,CAAC;AAEzC,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhD,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG;IACvB,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAqBF,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,OAAO,GAAG,SAAS,GAC9B,WAAW,GAAG,SAAS,CAQzB;AAQD,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAWnC;AA4DD,wBAAsB,eAAe,CACnC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAWlC;AAED,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/D,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,YAAY,EAAE,CAAC,CAKzB;AAED,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAKjC;AA4BD,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAM1B"}
+{"version":3,"file":"metadata_loaders.d.ts","sourceRoot":"","sources":["../../../../../src/data/ome_zarr/metadata_loaders.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAa,MAAM,cAAc,CAAC;AAEjE,QAAA,MAAM,QAAQ,yBAA0B,CAAC;AAEzC,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhD,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG;IACvB,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAqBF,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,OAAO,GAAG,SAAS,GAC9B,WAAW,GAAG,SAAS,CAQzB;AAQD,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAYnC;AA4DD,wBAAsB,eAAe,CACnC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAalC;AAED,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/D,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,YAAY,EAAE,CAAC,CAKzB;AAED,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAKjC;AA4BD,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAM1B"}

package/dist/types/src/data/zarr/open.d.ts

@@ -1,6 +1,7 @@
 import * as zarr from "zarrita";
 import { Location } from "@zarrita/core";
 import { Readable } from "@zarrita/storage";
+import { type S3FetchStoreProps } from "./s3_fetch_store";
 export type Version = "v2" | "v3";
 export type ZarrArrayParams = {
     arrayPath: string;
@@ -8,11 +9,9 @@ export type ZarrArrayParams = {
 } & ({
     type: "fetch";
     url: string;
-    fetchOptions?: {
-        overrides?: RequestInit;
-        useSuffixRequest?: boolean;
-    };
-} | {
+} | ({
+    type: "s3";
+} & S3FetchStoreProps) | {
     type: "filesystem";
     directoryHandle: FileSystemDirectoryHandle;
     path: string;

package/dist/types/src/data/zarr/open.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"open.d.ts","sourceRoot":"","sources":["../../../../../src/data/zarr/open.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAI5C,MAAM,MAAM,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC;AAElC,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;CAClC,GAAG,CACA;IACE,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE;QACb,SAAS,CAAC,EAAE,WAAW,CAAC;QACxB,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B,CAAC;CACH,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,eAAe,EAAE,yBAAyB,CAAC;IAC3C,IAAI,EAAE,MAAM,CAAC;CACd,CACJ,CAAC;AAEF,wBAAsB,SAAS,CAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACjC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAoB/B;AAED,wBAAsB,SAAS,CAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACjC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAoB9C;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CA4B9C;AAED,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAC5B,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,OAAO,GAAG,SAAS,GAC/B,eAAe,CAqBjB"}
+{"version":3,"file":"open.d.ts","sourceRoot":"","sources":["../../../../../src/data/zarr/open.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAG5C,OAAO,EAAgB,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAExE,MAAM,MAAM,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC;AAElC,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;CAClC,GAAG,CACA;IACE,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb,GACD,CAAC;IACC,IAAI,EAAE,IAAI,CAAC;CACZ,GAAG,iBAAiB,CAAC,GACtB;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,eAAe,EAAE,yBAAyB,CAAC;IAC3C,IAAI,EAAE,MAAM,CAAC;CACd,CACJ,CAAC;AAEF,wBAAsB,SAAS,CAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACjC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAoB/B;AAED,wBAAsB,SAAS,CAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACjC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAoB9C;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAgC9C;AAED,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAC5B,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,OAAO,GAAG,SAAS,GAC/B,eAAe,CAgCjB"}

package/dist/types/src/data/zarr/s3_fetch_store.d.ts

@@ -0,0 +1,60 @@
+import FetchStore from "@zarrita/storage/fetch";
+type AwsCredentials = {
+    accessKeyId: string;
+    secretAccessKey: string;
+    sessionToken?: string;
+};
+export type S3FetchStoreProps = {
+    url: string;
+    region?: string;
+    credentials?: AwsCredentials;
+    overrides?: RequestInit;
+    useSuffixRequest?: boolean;
+};
+/**
+ * A FetchStore that generates AWS Signature V4 headers for each request.
+ * This is necessary because AWS signatures are path-specific and expire quickly.
+ *
+ * SECURITY WARNING: This class is only intended for local development.
+ * Credentials are passed to worker threads and stored in memory.
+ * Do not use in production - implement a secure backend proxy instead.
+ */
+export declare class S3FetchStore extends FetchStore {
+    readonly credentials?: AwsCredentials;
+    readonly region?: string;
+    private signingKeyCache_;
+    readonly overrides?: RequestInit;
+    readonly useSuffixRequest?: boolean;
+    constructor(props: S3FetchStoreProps);
+    /**
+     * Override get() to generate fresh auth headers for each request
+     */
+    get(key: `/${string}`, options?: RequestInit): Promise<Uint8Array | undefined>;
+    /**
+     * Override getRange() to generate fresh auth headers for range requests
+     * This handles HEAD requests made by fetch_suffix
+     */
+    getRange(key: `/${string}`, range: {
+        offset: number;
+        length: number;
+    } | {
+        suffixLength: number;
+    }, options?: RequestInit): Promise<Uint8Array | undefined>;
+    /**
+     * Generate AWS Signature V4 headers for a specific URL and HTTP method
+     * This uses the Web Crypto API for browser compatibility
+     */
+    private generateAuthHeaders;
+    private getAmzDate;
+    private sha256;
+    private hmacSha256;
+    private hmacSha256Bytes;
+    /**
+     * Get the signing key for a given date/region combination.
+     * Caches the key to avoid regenerating it for every request (key is valid for 24 hours).
+     */
+    private getSignatureKey;
+    private bufferToHex;
+}
+export {};
+//# sourceMappingURL=s3_fetch_store.d.ts.map

package/dist/types/src/data/zarr/s3_fetch_store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3_fetch_store.d.ts","sourceRoot":"","sources":["../../../../../src/data/zarr/s3_fetch_store.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,wBAAwB,CAAC;AAEhD,KAAK,cAAc,GAAG;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AA6BF;;;;;;;GAOG;AACH,qBAAa,YAAa,SAAQ,UAAU;IAC1C,SAAgB,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7C,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhC,OAAO,CAAC,gBAAgB,CAAiC;IACzD,SAAgB,SAAS,CAAC,EAAE,WAAW,CAAC;IACxC,SAAgB,gBAAgB,CAAC,EAAE,OAAO,CAAC;gBAE/B,KAAK,EAAE,iBAAiB;IAgBpC;;OAEG;IACG,GAAG,CACP,GAAG,EAAE,IAAI,MAAM,EAAE,EACjB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAuBlC;;;OAGG;IACG,QAAQ,CACZ,GAAG,EAAE,IAAI,MAAM,EAAE,EACjB,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,EACpE,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IA+ClC;;;OAGG;YACW,mBAAmB;IAoEjC,OAAO,CAAC,UAAU;YAIJ,MAAM;YAON,UAAU;YAgBV,eAAe;IAoB7B;;;OAGG;YACW,eAAe;IA2B7B,OAAO,CAAC,WAAW;CAKpB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idetik/core",
-  "version": "0.2.3",
+  "version": "0.4.0",
   "type": "module",
   "scripts": {
     "dev": "vite",