@idetik/core 0.2.3 → 0.4.0

package/dist/index.d.ts

@@ -1235,6 +1235,19 @@ declare const Image$1: z.ZodObject<{
 }>;
 type Image$1 = z.infer<typeof Image$1>;
 
+type AwsCredentials = {
+    accessKeyId: string;
+    secretAccessKey: string;
+    sessionToken?: string;
+};
+type S3FetchStoreProps = {
+    url: string;
+    region?: string;
+    credentials?: AwsCredentials;
+    overrides?: RequestInit;
+    useSuffixRequest?: boolean;
+};
+
 type Version$1 = "v2" | "v3";
 type ZarrArrayParams = {
     arrayPath: string;
@@ -1242,11 +1255,9 @@ type ZarrArrayParams = {
 } & ({
     type: "fetch";
     url: string;
-    fetchOptions?: {
-        overrides?: RequestInit;
-        useSuffixRequest?: boolean;
-    };
-} | {
+} | ({
+    type: "s3";
+} & S3FetchStoreProps) | {
     type: "filesystem";
     directoryHandle: FileSystemDirectoryHandle;
     path: string;
@@ -1581,22 +1592,52 @@ type OmeroChannel = OmeroMetadata["channels"][number];
 declare function loadOmeroChannels(source: OmeZarrImageSource): Promise<OmeroChannel[]>;
 declare function loadOmeroDefaults(source: OmeZarrImageSource): Promise<OmeroMetadata["rdefs"]>;
 
+type HttpOmeZarrImageSourceProps = {
+    url: string;
+    version?: Version;
+};
+type S3OmeZarrImageSourceProps = S3FetchStoreProps & {
+    version?: Version;
+};
+type FileSystemOmeZarrImageSourceProps = {
+    directory: FileSystemDirectoryHandle;
+    version?: Version;
+    path?: `/${string}`;
+};
 /** Opens an OME-Zarr multiscale image Zarr group from either a URL or local directory. */
 declare class OmeZarrImageSource {
     readonly location: Location<Readable>;
     readonly version?: Version;
+    private constructor();
+    open(): Promise<OmeZarrImageLoader>;
+    /**
+     * Creates an OmeZarrImageSource from an HTTP(S) URL.
+     *
+     * @param url URL of Zarr root
+     * @param version OME-Zarr version
+     */
+    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
      */
-    constructor(url: string, version?: Version);
+    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?: Version, path?: `/${string}`);
-    open(): Promise<OmeZarrImageLoader>;
+    static fromFileSystem(props: FileSystemOmeZarrImageSourceProps): OmeZarrImageSource;
 }
 
 declare class Plane {