@fideus-labs/ngff-zarr 0.0.1

package/script/schemas/units.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unitValidator = exports.dimensionValidator = exports.UnitsSchema = exports.TimeUnitsSchema = exports.SpaceUnitsSchema = exports.AxesTypeSchema = exports.SpatialDimsSchema = exports.SupportedDimsSchema = void 0;
+const zod_1 = require("zod");
+const units_js_1 = require("../types/units.js");
+exports.SupportedDimsSchema = zod_1.z.enum([
+    "c",
+    "x",
+    "y",
+    "z",
+    "t",
+]);
+exports.SpatialDimsSchema = zod_1.z.enum(["x", "y", "z"]);
+exports.AxesTypeSchema = zod_1.z.enum([
+    "time",
+    "space",
+    "channel",
+]);
+exports.SpaceUnitsSchema = zod_1.z.enum([
+    "angstrom",
+    "attometer",
+    "centimeter",
+    "decimeter",
+    "exameter",
+    "femtometer",
+    "foot",
+    "gigameter",
+    "hectometer",
+    "inch",
+    "kilometer",
+    "megameter",
+    "meter",
+    "micrometer",
+    "mile",
+    "millimeter",
+    "nanometer",
+    "parsec",
+    "petameter",
+    "picometer",
+    "terameter",
+    "yard",
+    "yoctometer",
+    "yottameter",
+    "zeptometer",
+    "zettameter",
+]);
+exports.TimeUnitsSchema = zod_1.z.enum([
+    "attosecond",
+    "centisecond",
+    "day",
+    "decisecond",
+    "exasecond",
+    "femtosecond",
+    "gigasecond",
+    "hectosecond",
+    "hour",
+    "kilosecond",
+    "megasecond",
+    "microsecond",
+    "millisecond",
+    "minute",
+    "nanosecond",
+    "petasecond",
+    "picosecond",
+    "second",
+    "terasecond",
+    "yoctosecond",
+    "yottasecond",
+    "zeptosecond",
+    "zettasecond",
+]);
+exports.UnitsSchema = zod_1.z.union([exports.SpaceUnitsSchema, exports.TimeUnitsSchema]);
+exports.dimensionValidator = zod_1.z
+    .string()
+    .refine((dim) => units_js_1.supportedDims.includes(dim), { message: "Dimension must be one of: c, x, y, z, t" });
+exports.unitValidator = zod_1.z
+    .string()
+    .refine((unit) => [...units_js_1.timeUnits, ...units_js_1.spaceUnits].includes(unit), { message: "Unit must be a valid time or space unit" });

package/script/schemas/zarr_metadata.d.ts

@@ -0,0 +1,49 @@
+import { z } from "zod";
+import { AxesTypeSchema, SupportedDimsSchema, UnitsSchema } from "./units.js";
+export declare const AxisSchema: z.ZodObject<{
+    name: typeof SupportedDimsSchema;
+    type: typeof AxesTypeSchema;
+    unit: z.ZodOptional<typeof UnitsSchema>;
+}>;
+export declare const IdentitySchema: z.ZodObject<{
+    type: z.ZodLiteral<"identity">;
+}>;
+export declare const ScaleSchema: z.ZodObject<{
+    scale: z.ZodArray<z.ZodNumber>;
+    type: z.ZodLiteral<"scale">;
+}>;
+export declare const TranslationSchema: z.ZodObject<{
+    translation: z.ZodArray<z.ZodNumber>;
+    type: z.ZodLiteral<"translation">;
+}>;
+export declare const TransformSchema: z.ZodUnion<[
+    typeof ScaleSchema,
+    typeof TranslationSchema
+]>;
+export declare const DatasetSchema: z.ZodObject<{
+    path: z.ZodString;
+    coordinateTransformations: z.ZodArray<typeof TransformSchema>;
+}>;
+export declare const OmeroWindowSchema: z.ZodObject<{
+    min: z.ZodNumber;
+    max: z.ZodNumber;
+    start: z.ZodNumber;
+    end: z.ZodNumber;
+}>;
+export declare const OmeroChannelSchema: z.ZodObject<{
+    color: z.ZodString;
+    window: typeof OmeroWindowSchema;
+    label: z.ZodOptional<z.ZodString>;
+}>;
+export declare const OmeroSchema: z.ZodObject<{
+    channels: z.ZodArray<typeof OmeroChannelSchema>;
+}>;
+export declare const MetadataSchema: z.ZodObject<{
+    axes: z.ZodArray<typeof AxisSchema>;
+    datasets: z.ZodArray<typeof DatasetSchema>;
+    coordinateTransformations: z.ZodOptional<z.ZodArray<typeof TransformSchema>>;
+    omero: z.ZodOptional<typeof OmeroSchema>;
+    name: z.ZodDefault<z.ZodString>;
+    version: z.ZodDefault<z.ZodString>;
+}>;
+//# sourceMappingURL=zarr_metadata.d.ts.map

package/script/schemas/zarr_metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zarr_metadata.d.ts","sourceRoot":"","sources":["../../src/schemas/zarr_metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9E,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC;IACnC,IAAI,EAAE,OAAO,mBAAmB,CAAC;IACjC,IAAI,EAAE,OAAO,cAAc,CAAC;IAC5B,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,OAAO,WAAW,CAAC,CAAC;CACzC,CAIC,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC;IACvC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;CAChC,CAEC,CAAC;AAEH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC;IACpC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;CAC7B,CAGC,CAAC;AAEH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,SAAS,CAAC;IAC1C,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;CACnC,CAGC,CAAC;AAEH,eAAO,MAAM,eAAe,EAAE,CAAC,CAAC,QAAQ,CACtC;IAAC,OAAO,WAAW;IAAE,OAAO,iBAAiB;CAAC,CACH,CAAC;AAE9C,eAAO,MAAM,aAAa,EAAE,CAAC,CAAC,SAAS,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC;IAClB,yBAAyB,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,eAAe,CAAC,CAAC;CAC/D,CAGC,CAAC;AAEH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,SAAS,CAAC;IAC1C,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC;IACjB,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC;IACjB,KAAK,EAAE,CAAC,CAAC,SAAS,CAAC;IACnB,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC;CAClB,CAKC,CAAC;AAEH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,SAAS,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,SAAS,CAAC;IACnB,MAAM,EAAE,OAAO,iBAAiB,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;CACnC,CAMC,CAAC;AAEH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC;IACpC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,kBAAkB,CAAC,CAAC;CACjD,CAEC,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC;IACvC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,UAAU,CAAC,CAAC;IACpC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,aAAa,CAAC,CAAC;IAC3C,yBAAyB,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC;IAC7E,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,OAAO,WAAW,CAAC,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;CACpC,CAOC,CAAC"}

package/script/schemas/zarr_metadata.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataSchema = exports.OmeroSchema = exports.OmeroChannelSchema = exports.OmeroWindowSchema = exports.DatasetSchema = exports.TransformSchema = exports.TranslationSchema = exports.ScaleSchema = exports.IdentitySchema = exports.AxisSchema = void 0;
+const zod_1 = require("zod");
+const units_js_1 = require("./units.js");
+exports.AxisSchema = zod_1.z.object({
+    name: units_js_1.SupportedDimsSchema,
+    type: units_js_1.AxesTypeSchema,
+    unit: units_js_1.UnitsSchema.optional(),
+});
+exports.IdentitySchema = zod_1.z.object({
+    type: zod_1.z.literal("identity"),
+});
+exports.ScaleSchema = zod_1.z.object({
+    scale: zod_1.z.array(zod_1.z.number()),
+    type: zod_1.z.literal("scale"),
+});
+exports.TranslationSchema = zod_1.z.object({
+    translation: zod_1.z.array(zod_1.z.number()),
+    type: zod_1.z.literal("translation"),
+});
+exports.TransformSchema = zod_1.z.union([exports.ScaleSchema, exports.TranslationSchema]);
+exports.DatasetSchema = zod_1.z.object({
+    path: zod_1.z.string(),
+    coordinateTransformations: zod_1.z.array(exports.TransformSchema),
+});
+exports.OmeroWindowSchema = zod_1.z.object({
+    min: zod_1.z.number(),
+    max: zod_1.z.number(),
+    start: zod_1.z.number(),
+    end: zod_1.z.number(),
+});
+exports.OmeroChannelSchema = zod_1.z.object({
+    color: zod_1.z.string().regex(/^[0-9A-Fa-f]{6}$/, {
+        message: "Color must be 6 hex digits",
+    }),
+    window: exports.OmeroWindowSchema,
+    label: zod_1.z.string().optional(),
+});
+exports.OmeroSchema = zod_1.z.object({
+    channels: zod_1.z.array(exports.OmeroChannelSchema),
+});
+exports.MetadataSchema = zod_1.z.object({
+    axes: zod_1.z.array(exports.AxisSchema),
+    datasets: zod_1.z.array(exports.DatasetSchema),
+    coordinateTransformations: zod_1.z.array(exports.TransformSchema).optional(),
+    omero: exports.OmeroSchema.optional(),
+    name: zod_1.z.string().default("image"),
+    version: zod_1.z.string().default("0.4"),
+});

package/script/types/lazy_array.d.ts

@@ -0,0 +1,18 @@
+export interface LazyArrayMetadata {
+    shape: number[];
+    dtype: string;
+    chunks: number[][];
+    name: string;
+}
+export declare class LazyArray {
+    readonly shape: number[];
+    readonly dtype: string;
+    readonly chunks: number[][];
+    readonly name: string;
+    constructor(metadata: LazyArrayMetadata);
+    get ndim(): number;
+    get size(): number;
+    get chunksize(): number[];
+    toString(): string;
+}
+//# sourceMappingURL=lazy_array.d.ts.map

package/script/types/lazy_array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lazy_array.d.ts","sourceRoot":"","sources":["../../src/types/lazy_array.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,qBAAa,SAAS;IACpB,SAAgB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;IACnC,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEjB,QAAQ,EAAE,iBAAiB;IAOvC,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;IAED,QAAQ,IAAI,MAAM;CAUnB"}

package/script/types/lazy_array.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LazyArray = void 0;
+class LazyArray {
+    shape;
+    dtype;
+    chunks;
+    name;
+    constructor(metadata) {
+        this.shape = [...metadata.shape];
+        this.dtype = metadata.dtype;
+        this.chunks = metadata.chunks.map((chunk) => [...chunk]);
+        this.name = metadata.name;
+    }
+    get ndim() {
+        return this.shape.length;
+    }
+    get size() {
+        return this.shape.reduce((acc, dim) => acc * dim, 1);
+    }
+    get chunksize() {
+        return this.chunks[0] || [];
+    }
+    toString() {
+        const chunkStr = this.chunksize.length > 0
+            ? `chunksize=(${this.chunksize.join(", ")})`
+            : "chunksize=()";
+        return `LazyArray(name=${this.name}, shape=(${this.shape.join(", ")}), dtype=${this.dtype}, ${chunkStr}, chunktype=TypedArray)`;
+    }
+}
+exports.LazyArray = LazyArray;

package/script/types/methods.d.ts

@@ -0,0 +1,7 @@
+export declare enum Methods {
+    ITKWASM_GAUSSIAN = "itkwasm_gaussian",
+    ITKWASM_BIN_SHRINK = "itkwasm_bin_shrink",
+    ITKWASM_LABEL_IMAGE = "itkwasm_label_image"
+}
+export declare const methodsValues: Methods[];
+//# sourceMappingURL=methods.d.ts.map

package/script/types/methods.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"methods.d.ts","sourceRoot":"","sources":["../../src/types/methods.ts"],"names":[],"mappings":"AAAA,oBAAY,OAAO;IACjB,gBAAgB,qBAAqB;IACrC,kBAAkB,uBAAuB;IACzC,mBAAmB,wBAAwB;CAC5C;AAED,eAAO,MAAM,aAAa,EAAE,OAAO,EAA2B,CAAC"}

package/script/types/methods.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.methodsValues = exports.Methods = void 0;
+var Methods;
+(function (Methods) {
+    Methods["ITKWASM_GAUSSIAN"] = "itkwasm_gaussian";
+    Methods["ITKWASM_BIN_SHRINK"] = "itkwasm_bin_shrink";
+    Methods["ITKWASM_LABEL_IMAGE"] = "itkwasm_label_image";
+})(Methods || (exports.Methods = Methods = {}));
+exports.methodsValues = Object.values(Methods);

package/script/types/multiscales.d.ts

@@ -0,0 +1,21 @@
+import type { NgffImage } from "./ngff_image.js";
+import type { Metadata } from "./zarr_metadata.js";
+import type { Methods } from "./methods.js";
+export type ChunkSpec = number | number[] | number[][] | Record<string, number | number[] | undefined>;
+export interface MultiscalesOptions {
+    images: NgffImage[];
+    metadata: Metadata;
+    scaleFactors: (Record<string, number> | number)[] | undefined;
+    method: Methods | undefined;
+    chunks: ChunkSpec | undefined;
+}
+export declare class Multiscales {
+    readonly images: NgffImage[];
+    readonly metadata: Metadata;
+    readonly scaleFactors: (Record<string, number> | number)[] | undefined;
+    readonly method: Methods | undefined;
+    readonly chunks: ChunkSpec | undefined;
+    constructor(options: MultiscalesOptions);
+    toString(): string;
+}
+//# sourceMappingURL=multiscales.d.ts.map

package/script/types/multiscales.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multiscales.d.ts","sourceRoot":"","sources":["../../src/types/multiscales.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,EAAE,GACR,MAAM,EAAE,EAAE,GACV,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;AAElD,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;IAC9D,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;CAC/B;AAED,qBAAa,WAAW;IACtB,SAAgB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,YAAY,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;IAC9E,SAAgB,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5C,SAAgB,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;gBAElC,OAAO,EAAE,kBAAkB;IAUvC,QAAQ,IAAI,MAAM;CAwBnB"}

package/script/types/multiscales.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Multiscales = void 0;
+class Multiscales {
+    images;
+    metadata;
+    scaleFactors;
+    method;
+    chunks;
+    constructor(options) {
+        this.images = [...options.images];
+        this.metadata = { ...options.metadata };
+        this.scaleFactors = options.scaleFactors
+            ? [...options.scaleFactors]
+            : undefined;
+        this.method = options.method;
+        this.chunks = options.chunks;
+    }
+    toString() {
+        const imagesStr = this.images
+            .map((img, _i) => `        ${img.toString().replace(/\n/g, "\n        ")}`)
+            .join(",\n");
+        const metadataStr = JSON.stringify(this.metadata, null, 4)
+            .split("\n")
+            .map((line) => `        ${line}`)
+            .join("\n");
+        return `Multiscales(
+    images=[
+${imagesStr}
+    ],
+    metadata=${metadataStr},
+    scale_factors=${JSON.stringify(this.scaleFactors)},
+    method=${this.method ? `Methods.${this.method.toUpperCase()}` : "undefined"},
+    chunks=${JSON.stringify(this.chunks)}
+)`;
+    }
+}
+exports.Multiscales = Multiscales;

package/script/types/ngff_image.d.ts

@@ -0,0 +1,24 @@
+import type { LazyArray } from "./lazy_array.js";
+import type { Units } from "./units.js";
+export type ComputedCallback = () => void;
+export interface NgffImageOptions {
+    data: LazyArray;
+    dims: string[];
+    scale: Record<string, number>;
+    translation: Record<string, number>;
+    name: string | undefined;
+    axesUnits: Record<string, Units> | undefined;
+    computedCallbacks: ComputedCallback[] | undefined;
+}
+export declare class NgffImage {
+    readonly data: LazyArray;
+    readonly dims: string[];
+    readonly scale: Record<string, number>;
+    readonly translation: Record<string, number>;
+    readonly name: string;
+    readonly axesUnits: Record<string, Units> | undefined;
+    readonly computedCallbacks: ComputedCallback[];
+    constructor(options: NgffImageOptions);
+    toString(): string;
+}
+//# sourceMappingURL=ngff_image.d.ts.map

package/script/types/ngff_image.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ngff_image.d.ts","sourceRoot":"","sources":["../../src/types/ngff_image.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,MAAM,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC;AAE1C,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;IAC7C,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAC;CACnD;AAED,qBAAa,SAAS;IACpB,SAAgB,IAAI,EAAE,SAAS,CAAC;IAChC,SAAgB,IAAI,EAAE,MAAM,EAAE,CAAC;IAC/B,SAAgB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9C,SAAgB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;IAC7D,SAAgB,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;gBAE1C,OAAO,EAAE,gBAAgB;IAUrC,QAAQ,IAAI,MAAM;CAcnB"}

package/script/types/ngff_image.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NgffImage = void 0;
+class NgffImage {
+    data;
+    dims;
+    scale;
+    translation;
+    name;
+    axesUnits;
+    computedCallbacks;
+    constructor(options) {
+        this.data = options.data;
+        this.dims = [...options.dims];
+        this.scale = { ...options.scale };
+        this.translation = { ...options.translation };
+        this.name = options.name ?? "image";
+        this.axesUnits = options.axesUnits ? { ...options.axesUnits } : undefined;
+        this.computedCallbacks = [...(options.computedCallbacks ?? [])];
+    }
+    toString() {
+        const axesUnitsStr = this.axesUnits
+            ? JSON.stringify(this.axesUnits)
+            : "None";
+        return `NgffImage(
+    data=${this.data.toString()},
+    dims=[${this.dims.map((d) => `'${d}'`).join(", ")}],
+    scale=${JSON.stringify(this.scale)},
+    translation=${JSON.stringify(this.translation)},
+    name='${this.name}',
+    axes_units=${axesUnitsStr},
+    computed_callbacks=[${this.computedCallbacks.length} callbacks]
+)`;
+    }
+}
+exports.NgffImage = NgffImage;

package/script/types/units.d.ts

@@ -0,0 +1,12 @@
+export type SupportedDims = "c" | "x" | "y" | "z" | "t";
+export type SpatialDims = "x" | "y" | "z";
+export type AxesType = "time" | "space" | "channel";
+export type SpaceUnits = "angstrom" | "attometer" | "centimeter" | "decimeter" | "exameter" | "femtometer" | "foot" | "gigameter" | "hectometer" | "inch" | "kilometer" | "megameter" | "meter" | "micrometer" | "mile" | "millimeter" | "nanometer" | "parsec" | "petameter" | "picometer" | "terameter" | "yard" | "yoctometer" | "yottameter" | "zeptometer" | "zettameter";
+export type TimeUnits = "attosecond" | "centisecond" | "day" | "decisecond" | "exasecond" | "femtosecond" | "gigasecond" | "hectosecond" | "hour" | "kilosecond" | "megasecond" | "microsecond" | "millisecond" | "minute" | "nanosecond" | "petasecond" | "picosecond" | "second" | "terasecond" | "yoctosecond" | "yottasecond" | "zeptosecond" | "zettasecond";
+export type Units = SpaceUnits | TimeUnits;
+export declare const supportedDims: SupportedDims[];
+export declare const spaceUnits: SpaceUnits[];
+export declare const timeUnits: TimeUnits[];
+export declare function isDimensionSupported(dim: string): dim is SupportedDims;
+export declare function isUnitSupported(unit: string): unit is Units;
+//# sourceMappingURL=units.d.ts.map

package/script/types/units.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../src/types/units.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAExD,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAE1C,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpD,MAAM,MAAM,UAAU,GAClB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,YAAY,GACZ,MAAM,GACN,WAAW,GACX,YAAY,GACZ,MAAM,GACN,WAAW,GACX,WAAW,GACX,OAAO,GACP,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,WAAW,GACX,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,YAAY,CAAC;AAEjB,MAAM,MAAM,SAAS,GACjB,YAAY,GACZ,aAAa,GACb,KAAK,GACL,YAAY,GACZ,WAAW,GACX,aAAa,GACb,YAAY,GACZ,aAAa,GACb,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,aAAa,GACb,QAAQ,GACR,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,QAAQ,GACR,YAAY,GACZ,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,CAAC;AAElB,MAAM,MAAM,KAAK,GAAG,UAAU,GAAG,SAAS,CAAC;AAE3C,eAAO,MAAM,aAAa,EAAE,aAAa,EAA8B,CAAC;AAExE,eAAO,MAAM,UAAU,EAAE,UAAU,EA2BlC,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,SAAS,EAwBhC,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,aAAa,CAEtE;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,KAAK,CAK3D"}

package/script/types/units.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timeUnits = exports.spaceUnits = exports.supportedDims = void 0;
+exports.isDimensionSupported = isDimensionSupported;
+exports.isUnitSupported = isUnitSupported;
+exports.supportedDims = ["x", "y", "z", "c", "t"];
+exports.spaceUnits = [
+    "angstrom",
+    "attometer",
+    "centimeter",
+    "decimeter",
+    "exameter",
+    "femtometer",
+    "foot",
+    "gigameter",
+    "hectometer",
+    "inch",
+    "kilometer",
+    "megameter",
+    "meter",
+    "micrometer",
+    "mile",
+    "millimeter",
+    "nanometer",
+    "parsec",
+    "petameter",
+    "picometer",
+    "terameter",
+    "yard",
+    "yoctometer",
+    "yottameter",
+    "zeptometer",
+    "zettameter",
+];
+exports.timeUnits = [
+    "attosecond",
+    "centisecond",
+    "day",
+    "decisecond",
+    "exasecond",
+    "femtosecond",
+    "gigasecond",
+    "hectosecond",
+    "hour",
+    "kilosecond",
+    "megasecond",
+    "microsecond",
+    "millisecond",
+    "minute",
+    "nanosecond",
+    "petasecond",
+    "picosecond",
+    "second",
+    "terasecond",
+    "yoctosecond",
+    "yottasecond",
+    "zeptosecond",
+    "zettasecond",
+];
+function isDimensionSupported(dim) {
+    return exports.supportedDims.includes(dim);
+}
+function isUnitSupported(unit) {
+    return (exports.timeUnits.includes(unit) ||
+        exports.spaceUnits.includes(unit));
+}

package/script/types/zarr_metadata.d.ts

@@ -0,0 +1,49 @@
+import type { AxesType, SupportedDims, Units } from "./units.js";
+export interface Axis {
+    name: SupportedDims;
+    type: AxesType;
+    unit: Units | undefined;
+}
+export interface Identity {
+    type: "identity";
+}
+export interface Scale {
+    scale: number[];
+    type: "scale";
+}
+export interface Translation {
+    translation: number[];
+    type: "translation";
+}
+export type Transform = Scale | Translation;
+export interface Dataset {
+    path: string;
+    coordinateTransformations: Transform[];
+}
+export interface OmeroWindow {
+    min: number;
+    max: number;
+    start: number;
+    end: number;
+}
+export interface OmeroChannel {
+    color: string;
+    window: OmeroWindow;
+    label: string | undefined;
+}
+export interface Omero {
+    channels: OmeroChannel[];
+}
+export interface Metadata {
+    axes: Axis[];
+    datasets: Dataset[];
+    coordinateTransformations: Transform[] | undefined;
+    omero: Omero | undefined;
+    name: string;
+    version: string;
+}
+export declare function validateColor(color: string): void;
+export declare function createScale(scale: number[]): Scale;
+export declare function createTranslation(translation: number[]): Translation;
+export declare function createIdentity(): Identity;
+//# sourceMappingURL=zarr_metadata.d.ts.map

package/script/types/zarr_metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zarr_metadata.d.ts","sourceRoot":"","sources":["../../src/types/zarr_metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjE,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,KAAK,GAAG,SAAS,CAAC;CACzB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,WAAW,CAAC;AAE5C,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB,EAAE,SAAS,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,WAAW,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,IAAI,EAAE,CAAC;IACb,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,yBAAyB,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IACnD,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAMjD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAElD;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,WAAW,CAEpE;AAED,wBAAgB,cAAc,IAAI,QAAQ,CAEzC"}

package/script/types/zarr_metadata.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateColor = validateColor;
+exports.createScale = createScale;
+exports.createTranslation = createTranslation;
+exports.createIdentity = createIdentity;
+function validateColor(color) {
+    if (!/^[0-9A-Fa-f]{6}$/.test(color)) {
+        throw new Error(`Invalid color '${color}'. Must be 6 hex digits.`);
+    }
+}
+function createScale(scale) {
+    return { scale: [...scale], type: "scale" };
+}
+function createTranslation(translation) {
+    return { translation: [...translation], type: "translation" };
+}
+function createIdentity() {
+    return { type: "identity" };
+}

package/script/utils/factory.d.ts

@@ -0,0 +1,13 @@
+import { NgffImage } from "../types/ngff_image.js";
+import { Multiscales } from "../types/multiscales.js";
+import type { Axis, Dataset, Metadata, Scale, Translation } from "../types/zarr_metadata.js";
+import type { AxesType, SupportedDims, Units } from "../types/units.js";
+import type { Methods } from "../types/methods.js";
+export declare function createNgffImage(_data: ArrayBuffer | number[], shape: number[], dtype: string, dims: string[], scale: Record<string, number>, translation: Record<string, number>, name?: string): NgffImage;
+export declare function createAxis(name: SupportedDims, type: AxesType, unit?: Units): Axis;
+export declare function createScale(scale: number[]): Scale;
+export declare function createTranslation(translation: number[]): Translation;
+export declare function createDataset(path: string, scale: number[], translation: number[]): Dataset;
+export declare function createMetadata(axes: Axis[], datasets: Dataset[], name?: string, version?: string): Metadata;
+export declare function createMultiscales(images: NgffImage[], metadata: Metadata, scaleFactors?: (Record<string, number> | number)[], method?: Methods): Multiscales;
+//# sourceMappingURL=factory.d.ts.map

package/script/utils/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/utils/factory.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EACV,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,KAAK,EACL,WAAW,EACZ,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,wBAAgB,eAAe,CAC7B,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE,EAC7B,KAAK,EAAE,MAAM,EAAE,EACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EAAE,EACd,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC7B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,IAAI,SAAU,GACb,SAAS,CAiBX;AAED,wBAAgB,UAAU,CACxB,IAAI,EAAE,aAAa,EACnB,IAAI,EAAE,QAAQ,EACd,IAAI,CAAC,EAAE,KAAK,GACX,IAAI,CAMN;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAKlD;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,WAAW,CAKpE;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,EACf,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAQT;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EAAE,EACZ,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,SAAU,EACd,OAAO,SAAQ,GACd,QAAQ,CASV;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,SAAS,EAAE,EACnB,QAAQ,EAAE,QAAQ,EAClB,YAAY,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,EAClD,MAAM,CAAC,EAAE,OAAO,GACf,WAAW,CAQb"}

package/script/utils/factory.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNgffImage = createNgffImage;
+exports.createAxis = createAxis;
+exports.createScale = createScale;
+exports.createTranslation = createTranslation;
+exports.createDataset = createDataset;
+exports.createMetadata = createMetadata;
+exports.createMultiscales = createMultiscales;
+const lazy_array_js_1 = require("../types/lazy_array.js");
+const ngff_image_js_1 = require("../types/ngff_image.js");
+const multiscales_js_1 = require("../types/multiscales.js");
+function createNgffImage(_data, shape, dtype, dims, scale, translation, name = "image") {
+    const lazyArray = new lazy_array_js_1.LazyArray({
+        shape,
+        dtype,
+        chunks: [shape],
+        name,
+    });
+    return new ngff_image_js_1.NgffImage({
+        data: lazyArray,
+        dims,
+        scale,
+        translation,
+        name,
+        axesUnits: undefined,
+        computedCallbacks: undefined,
+    });
+}
+function createAxis(name, type, unit) {
+    return {
+        name,
+        type,
+        unit: unit || undefined,
+    };
+}
+function createScale(scale) {
+    return {
+        scale: [...scale],
+        type: "scale",
+    };
+}
+function createTranslation(translation) {
+    return {
+        translation: [...translation],
+        type: "translation",
+    };
+}
+function createDataset(path, scale, translation) {
+    return {
+        path,
+        coordinateTransformations: [
+            createScale(scale),
+            createTranslation(translation),
+        ],
+    };
+}
+function createMetadata(axes, datasets, name = "image", version = "0.4") {
+    return {
+        axes: [...axes],
+        datasets: [...datasets],
+        coordinateTransformations: undefined,
+        omero: undefined,
+        name,
+        version,
+    };
+}
+function createMultiscales(images, metadata, scaleFactors, method) {
+    return new multiscales_js_1.Multiscales({
+        images: [...images],
+        metadata,
+        scaleFactors: scaleFactors || undefined,
+        method: method || undefined,
+        chunks: undefined,
+    });
+}

package/script/utils/validation.d.ts

@@ -0,0 +1,6 @@
+import type { Metadata } from "../types/zarr_metadata.js";
+export declare function validateMetadata(metadata: unknown): Metadata;
+export declare function validateColor(color: string): void;
+export declare function isValidDimension(dim: string): boolean;
+export declare function isValidUnit(unit: string): boolean;
+//# sourceMappingURL=validation.d.ts.map