@seasketch/geoprocessing/dist/src/types/sketch.d.ts

Geoprocessing and reporting framework for SeaSketch 2.0

import { ISO8601DateTime } from "./base.js";
import { Polygon, MultiPolygon, LineString, Point, Feature, BBox, FeatureCollection } from "./geojson.js";
export type SketchGeometryTypes = Polygon | MultiPolygon | LineString | Point;
/** Properties of a Sketch, defines known keys as well as unknown for extensiblity */
export type SketchProperties = Record<string, any> & {
    /** Unique sketch ID */
    id: string;
    /** Name specified by the author of the sketch */
    name: string;
    /** Last updated ISO 8601 timestamp */
    updatedAt: ISO8601DateTime;
    /** Last updated ISO 8601 timestamp */
    createdAt: ISO8601DateTime;
    /** Unique ID of class of sketch */
    sketchClassId: string;
    /** True if these are properties for a SketchCollection, false if Sketch */
    isCollection: boolean;
    /** User-defined attributes with values for Sketch.  Defines known keys as well as unknown for extensiblity */
    userAttributes: UserAttribute[];
    /** This is used on rare occasion to provide the sketch properties of a SketchCollections child sketches */
    childProperties?: SketchProperties[];
};
/** User-defined attributes with values for Sketch.  Defines known keys as well as unknown for extensiblity */
export type UserAttribute = Record<string, unknown> & {
    exportId: string;
    /** String to display for sketch attribute name */
    label: string;
    /** String to display for sketch attribute value */
    valueLabel?: string | string[] | null;
    /** Sketch attribute value */
    value: string | string[] | number | number[] | boolean | boolean[] | null;
    fieldType: string;
    /** Alternative strings to display for sketch attribute by language code */
    alternateLanguages?: Record<string, {
        label: string;
        valueLabel: string | string[] | null;
    }>;
};
export interface Sketch<G = SketchGeometryTypes> extends Omit<Feature, "geometry" | "properties"> {
    properties: SketchProperties;
    geometry: G;
    bbox?: BBox;
}
export interface SketchCollection<G = SketchGeometryTypes> extends Omit<FeatureCollection, "features"> {
    properties: SketchProperties;
    bbox: BBox;
    features: Sketch<G>[];
}
export interface NullSketch extends Omit<Sketch, "geometry"> {
    geometry?: null;
}
export interface NullSketchCollection extends Omit<SketchCollection, "features" | "bbox"> {
    bbox?: BBox;
    features: NullSketch[];
}
/**
 * A simple map of sketches and/or sketch collections keyed by their name
 */
export interface SketchMap {
    [name: string]: Sketch | SketchCollection;
}
/**
 * A simple map of features keyed by their name
 */
export interface FeatureMap {
    [name: string]: Feature;
}