@seasketch/geoprocessing
Version:
Geoprocessing and reporting framework for SeaSketch 2.0
1,369 lines • 65.4 kB
TypeScript
import { z } from "zod";
import { Package } from "./package.js";
import { GeoprocessingJsonConfig } from "./project.js";
export declare const geoTypesSchema: z.ZodEnum<["vector", "raster"]>;
export declare const supportedFormatsSchema: z.ZodEnum<["fgb", "json", "tif", "subdivided"]>;
export declare const measurementTypesSchema: z.ZodEnum<["quantitative", "categorical"]>;
export declare const measurementScalesSchema: z.ZodEnum<["nominal", "ordinal", "interval", "ratio"]>;
export declare const statsSchema: z.ZodObject<{
count: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
sum: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
area: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
count?: number | null | undefined;
sum?: number | null | undefined;
area?: number | null | undefined;
}, {
count?: number | null | undefined;
sum?: number | null | undefined;
area?: number | null | undefined;
}>;
/** Pre-calculated stats by key by class */
export declare const classStatsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
count: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
sum: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
area: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
count?: number | null | undefined;
sum?: number | null | undefined;
area?: number | null | undefined;
}, {
count?: number | null | undefined;
sum?: number | null | undefined;
area?: number | null | undefined;
}>>;
export declare const baseDatasourceSchema: z.ZodObject<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
}>;
/** Properties for vector datasource */
export declare const vectorDatasourceSchema: z.ZodObject<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Optional, name of property containing unique ID value for each vector feature */
idProperty: z.ZodOptional<z.ZodString>;
/** Optional, name of property containing name for each vector feature */
nameProperty: z.ZodOptional<z.ZodString>;
/** Optional, constrain datasource features by property having one or more specific values */
propertyFilter: z.ZodOptional<z.ZodObject<{
property: z.ZodString;
values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
}, "strip", z.ZodTypeAny, {
values: (string | number)[];
property: string;
}, {
values: (string | number)[];
property: string;
}>>;
/** Optional, constrain datasource to smaller bbox */
bboxFilter: z.ZodOptional<z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>]>>;
/** Import - Name of layer within vector datasource to extract */
layerName: z.ZodOptional<z.ZodString>;
/** properties whose values define classes of data. */
classKeys: z.ZodArray<z.ZodString, "many">;
}>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}>;
/** Properties for raster datasource */
export declare const rasterDatasourceSchema: z.ZodObject<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Type of measurements that the raster values represent */
measurementType: z.ZodEnum<["quantitative", "categorical"]>;
/** Import - band within raster datasource to extract */
band: z.ZodNumber;
/** Nodata value */
noDataValue: z.ZodOptional<z.ZodNumber>;
}>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}>;
/** Properties for external datasource */
export declare const externalDatasourceSchema: z.ZodObject<{
/** Url if external datasource */
url: z.ZodString;
}, "strip", z.ZodTypeAny, {
url: string;
}, {
url: string;
}>;
/** Properties for importing an internal datasource */
export declare const internalImportSchema: z.ZodObject<{
/** Import - Path to source data, with filename */
src: z.ZodString;
}, "strip", z.ZodTypeAny, {
src: string;
}, {
src: string;
}>;
/** Timestamp properties to ease syncing with local/published datasource files */
export declare const internalDatasourceSchema: z.ZodObject<{
/** Datasource creation timestamp */
created: z.ZodString;
/** Datasource updated timestamp */
lastUpdated: z.ZodString;
}, "strip", z.ZodTypeAny, {
created: string;
lastUpdated: string;
}, {
created: string;
lastUpdated: string;
}>;
/** Properties for import of internal vector datasources */
export declare const internalVectorImportSchema: z.ZodObject<z.objectUtil.extendShape<{
/** Import - Path to source data, with filename */
src: z.ZodString;
}, {
/** Import - What to keep in final dataset. Vector - properties, all else removed */
propertiesToKeep: z.ZodArray<z.ZodString, "many">;
/** Import - Whether to explode multi-geometries into single e.g. MultiPolygon to Polygon. Defaults to true */
explodeMulti: z.ZodBoolean;
}>, "strip", z.ZodTypeAny, {
src: string;
propertiesToKeep: string[];
explodeMulti: boolean;
}, {
src: string;
propertiesToKeep: string[];
explodeMulti: boolean;
}>;
export declare const internalVectorDatasourceSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Optional, name of property containing unique ID value for each vector feature */
idProperty: z.ZodOptional<z.ZodString>;
/** Optional, name of property containing name for each vector feature */
nameProperty: z.ZodOptional<z.ZodString>;
/** Optional, constrain datasource features by property having one or more specific values */
propertyFilter: z.ZodOptional<z.ZodObject<{
property: z.ZodString;
values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
}, "strip", z.ZodTypeAny, {
values: (string | number)[];
property: string;
}, {
values: (string | number)[];
property: string;
}>>;
/** Optional, constrain datasource to smaller bbox */
bboxFilter: z.ZodOptional<z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>]>>;
/** Import - Name of layer within vector datasource to extract */
layerName: z.ZodOptional<z.ZodString>;
/** properties whose values define classes of data. */
classKeys: z.ZodArray<z.ZodString, "many">;
}>, {
/** Datasource creation timestamp */
created: z.ZodString;
/** Datasource updated timestamp */
lastUpdated: z.ZodString;
}>, z.objectUtil.extendShape<{
/** Import - Path to source data, with filename */
src: z.ZodString;
}, {
/** Import - What to keep in final dataset. Vector - properties, all else removed */
propertiesToKeep: z.ZodArray<z.ZodString, "many">;
/** Import - Whether to explode multi-geometries into single e.g. MultiPolygon to Polygon. Defaults to true */
explodeMulti: z.ZodBoolean;
}>>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
src: string;
created: string;
lastUpdated: string;
propertiesToKeep: string[];
explodeMulti: boolean;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
src: string;
created: string;
lastUpdated: string;
propertiesToKeep: string[];
explodeMulti: boolean;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}>;
export declare const externalVectorDatasourceSchema: z.ZodIntersection<z.ZodObject<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Optional, name of property containing unique ID value for each vector feature */
idProperty: z.ZodOptional<z.ZodString>;
/** Optional, name of property containing name for each vector feature */
nameProperty: z.ZodOptional<z.ZodString>;
/** Optional, constrain datasource features by property having one or more specific values */
propertyFilter: z.ZodOptional<z.ZodObject<{
property: z.ZodString;
values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
}, "strip", z.ZodTypeAny, {
values: (string | number)[];
property: string;
}, {
values: (string | number)[];
property: string;
}>>;
/** Optional, constrain datasource to smaller bbox */
bboxFilter: z.ZodOptional<z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>]>>;
/** Import - Name of layer within vector datasource to extract */
layerName: z.ZodOptional<z.ZodString>;
/** properties whose values define classes of data. */
classKeys: z.ZodArray<z.ZodString, "many">;
}>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}>, z.ZodObject<{
/** Url if external datasource */
url: z.ZodString;
}, "strip", z.ZodTypeAny, {
url: string;
}, {
url: string;
}>>;
export declare const internalRasterDatasourceSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Type of measurements that the raster values represent */
measurementType: z.ZodEnum<["quantitative", "categorical"]>;
/** Import - band within raster datasource to extract */
band: z.ZodNumber;
/** Nodata value */
noDataValue: z.ZodOptional<z.ZodNumber>;
}>, {
/** Datasource creation timestamp */
created: z.ZodString;
/** Datasource updated timestamp */
lastUpdated: z.ZodString;
}>, {
/** Import - Path to source data, with filename */
src: z.ZodString;
}>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
src: string;
created: string;
lastUpdated: string;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
src: string;
created: string;
lastUpdated: string;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}>;
export declare const externalRasterDatasourceSchema: z.ZodIntersection<z.ZodObject<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Type of measurements that the raster values represent */
measurementType: z.ZodEnum<["quantitative", "categorical"]>;
/** Import - band within raster datasource to extract */
band: z.ZodNumber;
/** Nodata value */
noDataValue: z.ZodOptional<z.ZodNumber>;
}>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}>, z.ZodObject<{
/** Url if external datasource */
url: z.ZodString;
}, "strip", z.ZodTypeAny, {
url: string;
}, {
url: string;
}>>;
export declare const datasourceSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Optional, name of property containing unique ID value for each vector feature */
idProperty: z.ZodOptional<z.ZodString>;
/** Optional, name of property containing name for each vector feature */
nameProperty: z.ZodOptional<z.ZodString>;
/** Optional, constrain datasource features by property having one or more specific values */
propertyFilter: z.ZodOptional<z.ZodObject<{
property: z.ZodString;
values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
}, "strip", z.ZodTypeAny, {
values: (string | number)[];
property: string;
}, {
values: (string | number)[];
property: string;
}>>;
/** Optional, constrain datasource to smaller bbox */
bboxFilter: z.ZodOptional<z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>]>>;
/** Import - Name of layer within vector datasource to extract */
layerName: z.ZodOptional<z.ZodString>;
/** properties whose values define classes of data. */
classKeys: z.ZodArray<z.ZodString, "many">;
}>, {
/** Datasource creation timestamp */
created: z.ZodString;
/** Datasource updated timestamp */
lastUpdated: z.ZodString;
}>, z.objectUtil.extendShape<{
/** Import - Path to source data, with filename */
src: z.ZodString;
}, {
/** Import - What to keep in final dataset. Vector - properties, all else removed */
propertiesToKeep: z.ZodArray<z.ZodString, "many">;
/** Import - Whether to explode multi-geometries into single e.g. MultiPolygon to Polygon. Defaults to true */
explodeMulti: z.ZodBoolean;
}>>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
src: string;
created: string;
lastUpdated: string;
propertiesToKeep: string[];
explodeMulti: boolean;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
src: string;
created: string;
lastUpdated: string;
propertiesToKeep: string[];
explodeMulti: boolean;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}>, z.ZodIntersection<z.ZodObject<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Optional, name of property containing unique ID value for each vector feature */
idProperty: z.ZodOptional<z.ZodString>;
/** Optional, name of property containing name for each vector feature */
nameProperty: z.ZodOptional<z.ZodString>;
/** Optional, constrain datasource features by property having one or more specific values */
propertyFilter: z.ZodOptional<z.ZodObject<{
property: z.ZodString;
values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
}, "strip", z.ZodTypeAny, {
values: (string | number)[];
property: string;
}, {
values: (string | number)[];
property: string;
}>>;
/** Optional, constrain datasource to smaller bbox */
bboxFilter: z.ZodOptional<z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>]>>;
/** Import - Name of layer within vector datasource to extract */
layerName: z.ZodOptional<z.ZodString>;
/** properties whose values define classes of data. */
classKeys: z.ZodArray<z.ZodString, "many">;
}>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}>, z.ZodObject<{
/** Url if external datasource */
url: z.ZodString;
}, "strip", z.ZodTypeAny, {
url: string;
}, {
url: string;
}>>]>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Type of measurements that the raster values represent */
measurementType: z.ZodEnum<["quantitative", "categorical"]>;
/** Import - band within raster datasource to extract */
band: z.ZodNumber;
/** Nodata value */
noDataValue: z.ZodOptional<z.ZodNumber>;
}>, {
/** Datasource creation timestamp */
created: z.ZodString;
/** Datasource updated timestamp */
lastUpdated: z.ZodString;
}>, {
/** Import - Path to source data, with filename */
src: z.ZodString;
}>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
src: string;
created: string;
lastUpdated: string;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
src: string;
created: string;
lastUpdated: string;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}>]>, z.ZodIntersection<z.ZodObject<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Type of measurements that the raster values represent */
measurementType: z.ZodEnum<["quantitative", "categorical"]>;
/** Import - band within raster datasource to extract */
band: z.ZodNumber;
/** Nodata value */
noDataValue: z.ZodOptional<z.ZodNumber>;
}>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
measurementType: "quantitative" | "categorical";
band: number;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
noDataValue?: number | undefined;
}>, z.ZodObject<{
/** Url if external datasource */
url: z.ZodString;
}, "strip", z.ZodTypeAny, {
url: string;
}, {
url: string;
}>>]>;
export declare const datasourcesSchema: z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Optional, name of property containing unique ID value for each vector feature */
idProperty: z.ZodOptional<z.ZodString>;
/** Optional, name of property containing name for each vector feature */
nameProperty: z.ZodOptional<z.ZodString>;
/** Optional, constrain datasource features by property having one or more specific values */
propertyFilter: z.ZodOptional<z.ZodObject<{
property: z.ZodString;
values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
}, "strip", z.ZodTypeAny, {
values: (string | number)[];
property: string;
}, {
values: (string | number)[];
property: string;
}>>;
/** Optional, constrain datasource to smaller bbox */
bboxFilter: z.ZodOptional<z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>]>>;
/** Import - Name of layer within vector datasource to extract */
layerName: z.ZodOptional<z.ZodString>;
/** properties whose values define classes of data. */
classKeys: z.ZodArray<z.ZodString, "many">;
}>, {
/** Datasource creation timestamp */
created: z.ZodString;
/** Datasource updated timestamp */
lastUpdated: z.ZodString;
}>, z.objectUtil.extendShape<{
/** Import - Path to source data, with filename */
src: z.ZodString;
}, {
/** Import - What to keep in final dataset. Vector - properties, all else removed */
propertiesToKeep: z.ZodArray<z.ZodString, "many">;
/** Import - Whether to explode multi-geometries into single e.g. MultiPolygon to Polygon. Defaults to true */
explodeMulti: z.ZodBoolean;
}>>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
src: string;
created: string;
lastUpdated: string;
propertiesToKeep: string[];
explodeMulti: boolean;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
src: string;
created: string;
lastUpdated: string;
propertiesToKeep: string[];
explodeMulti: boolean;
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}>, z.ZodIntersection<z.ZodObject<z.objectUtil.extendShape<{
/** Unique id of datasource in project */
datasourceId: z.ZodString;
/** basic geospatial type */
geo_type: z.ZodEnum<["vector", "raster"]>;
/** Available formats */
formats: z.ZodArray<z.ZodEnum<["fgb", "json", "tif", "subdivided"]>, "many">;
/** Optional, defines whether or not precalc should be run for this datasource */
precalc: z.ZodBoolean;
metadata: z.ZodOptional<z.ZodObject<{
/** Human-readable name of datasource */
name: z.ZodString;
/** Description of datasource */
description: z.ZodOptional<z.ZodString>;
/** Publisher-provided version number or ISO 8601 date */
version: z.ZodString;
/** Publisher name */
publisher: z.ZodString;
/** ISO 8601 publish date */
publishDate: z.ZodString;
/** Public URL to access published data */
publishLink: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}, {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
}>>;
}, {
/** Optional, name of property containing unique ID value for each vector feature */
idProperty: z.ZodOptional<z.ZodString>;
/** Optional, name of property containing name for each vector feature */
nameProperty: z.ZodOptional<z.ZodString>;
/** Optional, constrain datasource features by property having one or more specific values */
propertyFilter: z.ZodOptional<z.ZodObject<{
property: z.ZodString;
values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">;
}, "strip", z.ZodTypeAny, {
values: (string | number)[];
property: string;
}, {
values: (string | number)[];
property: string;
}>>;
/** Optional, constrain datasource to smaller bbox */
bboxFilter: z.ZodOptional<z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>]>>;
/** Import - Name of layer within vector datasource to extract */
layerName: z.ZodOptional<z.ZodString>;
/** properties whose values define classes of data. */
classKeys: z.ZodArray<z.ZodString, "many">;
}>, "strip", z.ZodTypeAny, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
metadata?: {
name: string;
version: string;
publisher: string;
publishDate: string;
publishLink: string;
description?: string | undefined;
} | undefined;
idProperty?: string | undefined;
nameProperty?: string | undefined;
propertyFilter?: {
values: (string | number)[];
property: string;
} | undefined;
bboxFilter?: [number, number, number, number] | [number, number, number, number, number, number] | undefined;
layerName?: string | undefined;
}, {
datasourceId: string;
geo_type: "vector" | "raster";
formats: ("fgb" | "json" | "tif" | "subdivided")[];
precalc: boolean;
classKeys: string[];
metadata?: {
name: string;
version: strin