@basemaps/config-loader 7.1.0

package/build/json/parse.tile.set.d.ts

@@ -0,0 +1,252 @@
+import { TileSetType } from '@basemaps/config';
+import { z } from 'zod';
+export declare function validateColor(str: string): boolean;
+export declare const ImageryConfigDefaults: {
+    minZoom: number;
+    maxZoom: number;
+};
+declare const zLayerConfig: z.ZodEffects<z.ZodObject<{
+    name: z.ZodString;
+    title: z.ZodString;
+    category: z.ZodOptional<z.ZodString>;
+    2193: z.ZodOptional<z.ZodString>;
+    3857: z.ZodOptional<z.ZodString>;
+    minZoom: z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>;
+    maxZoom: z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    name: string;
+    category?: string | undefined;
+    2193?: string | undefined;
+    3857?: string | undefined;
+    minZoom?: number | undefined;
+    maxZoom?: number | undefined;
+}, {
+    title: string;
+    name: string;
+    category?: string | undefined;
+    2193?: string | undefined;
+    3857?: string | undefined;
+    minZoom?: number | undefined;
+    maxZoom?: number | undefined;
+}>, {
+    title: string;
+    name: string;
+    category?: string | undefined;
+    2193?: string | undefined;
+    3857?: string | undefined;
+    minZoom?: number | undefined;
+    maxZoom?: number | undefined;
+}, {
+    title: string;
+    name: string;
+    category?: string | undefined;
+    2193?: string | undefined;
+    3857?: string | undefined;
+    minZoom?: number | undefined;
+    maxZoom?: number | undefined;
+}>;
+export declare const zTileSetConfig: z.ZodObject<{
+    type: z.ZodNativeEnum<typeof TileSetType>;
+    id: z.ZodString;
+    title: z.ZodString;
+    category: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    background: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    layers: z.ZodArray<z.ZodEffects<z.ZodObject<{
+        name: z.ZodString;
+        title: z.ZodString;
+        category: z.ZodOptional<z.ZodString>;
+        2193: z.ZodOptional<z.ZodString>;
+        3857: z.ZodOptional<z.ZodString>;
+        minZoom: z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>;
+        maxZoom: z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        name: string;
+        category?: string | undefined;
+        2193?: string | undefined;
+        3857?: string | undefined;
+        minZoom?: number | undefined;
+        maxZoom?: number | undefined;
+    }, {
+        title: string;
+        name: string;
+        category?: string | undefined;
+        2193?: string | undefined;
+        3857?: string | undefined;
+        minZoom?: number | undefined;
+        maxZoom?: number | undefined;
+    }>, {
+        title: string;
+        name: string;
+        category?: string | undefined;
+        2193?: string | undefined;
+        3857?: string | undefined;
+        minZoom?: number | undefined;
+        maxZoom?: number | undefined;
+    }, {
+        title: string;
+        name: string;
+        category?: string | undefined;
+        2193?: string | undefined;
+        3857?: string | undefined;
+        minZoom?: number | undefined;
+        maxZoom?: number | undefined;
+    }>, "many">;
+    minZoom: z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>;
+    maxZoom: z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>;
+    format: z.ZodOptional<z.ZodString>;
+    outputs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        title: z.ZodString;
+        name: z.ZodString;
+        pipeline: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            type: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: string;
+        }, {
+            type: string;
+        }>, "many">>;
+        format: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodLiteral<"webp">, z.ZodLiteral<"png">, z.ZodLiteral<"jpeg">, z.ZodLiteral<"avif">]>, "many">>;
+        background: z.ZodOptional<z.ZodObject<{
+            r: z.ZodNumber;
+            g: z.ZodNumber;
+            b: z.ZodNumber;
+            alpha: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            r: number;
+            g: number;
+            b: number;
+            alpha: number;
+        }, {
+            r: number;
+            g: number;
+            b: number;
+            alpha: number;
+        }>>;
+        resizeKernel: z.ZodOptional<z.ZodObject<{
+            in: z.ZodUnion<[z.ZodLiteral<"nearest">, z.ZodLiteral<"lanczos3">, z.ZodLiteral<"lanczos2">]>;
+            out: z.ZodUnion<[z.ZodLiteral<"nearest">, z.ZodLiteral<"lanczos3">, z.ZodLiteral<"lanczos2">]>;
+        }, "strip", z.ZodTypeAny, {
+            in: "nearest" | "lanczos3" | "lanczos2";
+            out: "nearest" | "lanczos3" | "lanczos2";
+        }, {
+            in: "nearest" | "lanczos3" | "lanczos2";
+            out: "nearest" | "lanczos3" | "lanczos2";
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        title: string;
+        pipeline?: {
+            type: string;
+        }[] | undefined;
+        format?: ("webp" | "png" | "jpeg" | "avif")[] | undefined;
+        background?: {
+            r: number;
+            g: number;
+            b: number;
+            alpha: number;
+        } | undefined;
+        resizeKernel?: {
+            in: "nearest" | "lanczos3" | "lanczos2";
+            out: "nearest" | "lanczos3" | "lanczos2";
+        } | undefined;
+    }, {
+        name: string;
+        title: string;
+        pipeline?: {
+            type: string;
+        }[] | undefined;
+        format?: ("webp" | "png" | "jpeg" | "avif")[] | undefined;
+        background?: {
+            r: number;
+            g: number;
+            b: number;
+            alpha: number;
+        } | undefined;
+        resizeKernel?: {
+            in: "nearest" | "lanczos3" | "lanczos2";
+            out: "nearest" | "lanczos3" | "lanczos2";
+        } | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    type: TileSetType;
+    id: string;
+    layers: {
+        title: string;
+        name: string;
+        category?: string | undefined;
+        2193?: string | undefined;
+        3857?: string | undefined;
+        minZoom?: number | undefined;
+        maxZoom?: number | undefined;
+    }[];
+    category?: string | undefined;
+    description?: string | undefined;
+    background?: string | undefined;
+    minZoom?: number | undefined;
+    maxZoom?: number | undefined;
+    format?: string | undefined;
+    outputs?: {
+        name: string;
+        title: string;
+        pipeline?: {
+            type: string;
+        }[] | undefined;
+        format?: ("webp" | "png" | "jpeg" | "avif")[] | undefined;
+        background?: {
+            r: number;
+            g: number;
+            b: number;
+            alpha: number;
+        } | undefined;
+        resizeKernel?: {
+            in: "nearest" | "lanczos3" | "lanczos2";
+            out: "nearest" | "lanczos3" | "lanczos2";
+        } | undefined;
+    }[] | undefined;
+}, {
+    title: string;
+    type: TileSetType;
+    id: string;
+    layers: {
+        title: string;
+        name: string;
+        category?: string | undefined;
+        2193?: string | undefined;
+        3857?: string | undefined;
+        minZoom?: number | undefined;
+        maxZoom?: number | undefined;
+    }[];
+    category?: string | undefined;
+    description?: string | undefined;
+    background?: string | undefined;
+    minZoom?: number | undefined;
+    maxZoom?: number | undefined;
+    format?: string | undefined;
+    outputs?: {
+        name: string;
+        title: string;
+        pipeline?: {
+            type: string;
+        }[] | undefined;
+        format?: ("webp" | "png" | "jpeg" | "avif")[] | undefined;
+        background?: {
+            r: number;
+            g: number;
+            b: number;
+            alpha: number;
+        } | undefined;
+        resizeKernel?: {
+            in: "nearest" | "lanczos3" | "lanczos2";
+            out: "nearest" | "lanczos3" | "lanczos2";
+        } | undefined;
+    }[] | undefined;
+}>;
+export type TileSetConfigSchemaLayer = z.infer<typeof zLayerConfig>;
+/**
+ *  The Configuration for all the imagery in a TileSet
+ */
+export type TileSetConfigSchema = z.infer<typeof zTileSetConfig>;
+export {};

package/build/json/parse.tile.set.js

@@ -0,0 +1,47 @@
+import { ConfigTileSetOutputParser, parseRgba, TileSetType } from '@basemaps/config';
+import { z } from 'zod';
+export function validateColor(str) {
+    try {
+        parseRgba(str);
+        return true;
+    }
+    catch (err) {
+        return false;
+    }
+}
+const zBackground = z.string().refine(validateColor, { message: 'Invalid hex color' });
+export const ImageryConfigDefaults = {
+    minZoom: 0,
+    maxZoom: 32,
+};
+const zZoom = z.number().refine((val) => val >= ImageryConfigDefaults.minZoom && val <= ImageryConfigDefaults.maxZoom, {
+    message: `must be between ${ImageryConfigDefaults.minZoom} and ${ImageryConfigDefaults.maxZoom}`,
+});
+const zLayerConfig = z
+    .object({
+    name: z.string(),
+    title: z.string(),
+    category: z.string().optional(),
+    2193: z.string().optional(),
+    3857: z.string().optional(),
+    minZoom: zZoom.optional(),
+    maxZoom: zZoom.optional(),
+})
+    .refine(({ minZoom, maxZoom }) => (minZoom ? minZoom : ImageryConfigDefaults.minZoom) <= (maxZoom ? maxZoom : ImageryConfigDefaults.maxZoom), {
+    message: 'minZoom may no be greater than maxZoom',
+    path: ['minZoom'],
+});
+export const zTileSetConfig = z.object({
+    type: z.nativeEnum(TileSetType),
+    id: z.string(),
+    title: z.string(),
+    category: z.string().optional(),
+    description: z.string().optional(),
+    background: zBackground.optional(),
+    layers: z.array(zLayerConfig),
+    minZoom: zZoom.optional(),
+    maxZoom: zZoom.optional(),
+    format: z.string().optional(),
+    outputs: z.array(ConfigTileSetOutputParser).optional(),
+});
+//# sourceMappingURL=parse.tile.set.js.map

package/build/json/parse.tile.set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.tile.set.js","sourceRoot":"","sources":["../../src/json/parse.tile.set.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACrF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,IAAI,CAAC;QACH,SAAS,CAAC,GAAG,CAAC,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;AAEvF,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,EAAE;CACZ,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,qBAAqB,CAAC,OAAO,IAAI,GAAG,IAAI,qBAAqB,CAAC,OAAO,EAAE;IACrH,OAAO,EAAE,mBAAmB,qBAAqB,CAAC,OAAO,QAAQ,qBAAqB,CAAC,OAAO,EAAE;CACjG,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC;KACnB,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE;IACzB,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE;CAC1B,CAAC;KACD,MAAM,CACL,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CACvB,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAC5G;IACE,OAAO,EAAE,wCAAwC;IACjD,IAAI,EAAE,CAAC,SAAS,CAAC;CAClB,CACF,CAAC;AAEJ,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC;IAC/B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,WAAW,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;IAC7B,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE;IACzB,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE;IACzB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,QAAQ,EAAE;CACvD,CAAC,CAAC"}

package/build/json/tiff.config.d.ts

@@ -0,0 +1,113 @@
+/// <reference types="node" resolution-mode="require"/>
+import { ConfigImagery, ConfigProviderMemory, ConfigTileSetRaster, ImageryBandType } from '@basemaps/config';
+import { BoundingBox, NamedBounds } from '@basemaps/geo';
+import { Tiff } from '@basemaps/shared';
+import { LimitFunction } from 'p-limit';
+import { StacCollection } from 'stac-ts';
+import { LogType } from './log.js';
+/** Summary of a collection of tiffs */
+interface TiffSummary {
+    /** List of tiffs and their extents */
+    files: NamedBounds[];
+    /** Overall bounding box */
+    bounds: BoundingBox;
+    /** EpsgCode for the tiffs */
+    projection: number;
+    /** Ground sample distance, number of meters per pixel */
+    gsd: number;
+    /** no data value if present */
+    noData?: number;
+    /** STAC collection if it was found with the imagery */
+    collection?: StacCollection;
+    /** URL to the base of the imagery */
+    url: URL;
+    bands?: ImageryBandType[];
+}
+export type ConfigImageryTiff = ConfigImagery & TiffSummary;
+/**
+ * Attempt to read a stac collection.json from the target path if it exists or return null if anything goes wrong.
+ */
+export declare function loadStacFromURL(target: URL): Promise<StacCollection | null>;
+/**
+ * Guess a better imagery name from a target URL
+ *
+ * A lot of our source paths include the type of imagery eg "rgb", "rgbi" or "dem_1m",
+ * these names are not super helpful and often there are better names further up the pathname
+ *
+ * @example
+ * ```typescript
+ * getImageryName('s3://linz-imagery/auckland/auckland_sn5600_1979_0.375m/2193/rgb/')
+ * // auckland_sn5600_1979_0.375m
+ * ```
+ *
+ * The list of paths ignored are from
+ *
+ * @see {IgnoredTitles}
+ *
+ * For common imagery paths see:
+ *
+ * @see {@link https://github.com/linz/imagery}
+ * @see {@link https://github.com/linz/elevation}
+ */
+export declare function getImageryName(target: URL): string;
+export declare function loadTiffsFromPaths(sourceFiles: URL[], Q: LimitFunction): Promise<Tiff[]>;
+/**
+ * Attempt to load all imagery inside of a path and create a configuration from it
+ *
+ * @param target path that contains the imagery
+ * @param Q limit the number of requests per second to the imagery
+ * @param configCache optional location to cache the configuration objects
+ *
+ * @returns Imagery configuration generated from the path
+ */
+export declare function initImageryFromTiffUrl(target: URL, Q: LimitFunction, configCache?: URL, log?: LogType): Promise<ConfigImageryTiff>;
+/**
+ * Create configuration from a folder full of tiffs or a folder of folders of tiffs
+ *
+ * Given the following folder structure
+ *
+ * ```typescript
+ * "/imagery/invercargill_2022_0.05m/*.tiff"
+ * "/imagery/wellington_2022_0.05/*.tiff"
+ * ```
+ *
+ * A. A single imagery datasets
+ *
+ * ```typescript
+ * target = ["/imagery/invercargill_2022_0.05m/"]
+ * ```
+ *
+ * will load all tiffs from the resulting folder into a single tile set `aerial`
+ *
+ * B: A tree of imagery datasets
+ *
+ * ```typescript
+ * target = ["/imagery/invercargill_2022_0.05m/*.tiff", "/imagery/wellington_2022_0.05/*.tiff"]
+ * ```
+ *
+ * will load all tiffs from all folders targets into a single tile set "aerial",
+ * then load each folder into their own tile set.
+ *
+ * The rendering order will be the order of the target locations
+ *
+ * tile sets:  aerial, wellington_2022_0.05, invercargill_2022_0.05m
+ *
+ * @param provider where to store all the configuration generated
+ * @param targets the target location
+ * @param concurrency number of tiff files to load at a time
+ * @returns
+ */
+export declare function initConfigFromUrls(provider: ConfigProviderMemory, targets: URL[], concurrency?: number, configCache?: URL, log?: LogType): Promise<{
+    tileSet: ConfigTileSetRaster;
+    tileSets: ConfigTileSetRaster[];
+    imagery: ConfigImageryTiff[];
+}>;
+/**
+ * Attempt to guess if this configuration contains RGB or RGBA imagery
+ * by validating the image is either 3 or 4 band uint8
+ *
+ * @param img Imagery to check
+ * @returns true if imagery looks like rgb(a), false otherwise
+ */
+export declare function isRgbOrRgba(img: ConfigImagery): boolean;
+export {};