@giro3d/piero 1.0.0-beta.0

package/dist/src/types/IFCTypes.d.ts

@@ -0,0 +1,5 @@
+export interface IfcSpatialStructureElement {
+    children: never[];
+    expressID: number;
+    type: string;
+}

package/dist/src/types/LayerObject.d.ts

@@ -0,0 +1,20 @@
+import { EventDispatcher } from '../../../../node_modules/three';
+type LayerObjectEventMap = {
+    delete: {};
+    isLoading: {};
+    opacity: {};
+    visible: {};
+};
+export default abstract class LayerObject extends EventDispatcher<LayerObjectEventMap> {
+    readonly name: string;
+    readonly uuid: string;
+    get opacity(): number;
+    set opacity(v: number);
+    get visible(): boolean;
+    set visible(v: boolean);
+    private _opacity;
+    private _visible;
+    constructor(name: string);
+    delete(): void;
+}
+export {};

package/dist/src/types/Measure.d.ts

@@ -0,0 +1,20 @@
+import { EventDispatcher } from '../../../../node_modules/three';
+import { default as Measure3D } from '../giro3d/Measure3D';
+type MeasureEventMap = {
+    visible: {};
+};
+export default class Measure extends EventDispatcher<MeasureEventMap> {
+    properties: object;
+    readonly title: string;
+    readonly uuid: string;
+    get object(): Measure3D;
+    set object(obj: Measure3D);
+    get visible(): boolean;
+    set visible(v: boolean);
+    private _object;
+    private _visible;
+    constructor(title: string, object: Measure3D, properties?: object);
+    static toCollection(measures: Measure[]): GeoJSON.FeatureCollection;
+    toGeoJSON(): GeoJSON.Feature;
+}
+export {};

package/dist/src/types/MeasurementMode.d.ts

@@ -0,0 +1,7 @@
+import { default as Named } from './Named';
+type MeasurementMode = 'laser';
+type MeasurementNamed = Named & {
+    value: MeasurementMode;
+};
+export declare const measurementModes: MeasurementNamed[];
+export default MeasurementMode;

package/dist/src/types/Named.d.ts

@@ -0,0 +1,5 @@
+export default interface Named {
+    description?: string;
+    name: string;
+    value?: string;
+}

package/dist/src/types/NavigationMode.d.ts

@@ -0,0 +1,2 @@
+type NavigationMode = 'disabled' | 'first-person' | 'orbit' | 'position-on-map';
+export default NavigationMode;

package/dist/src/types/Notification.d.ts

@@ -0,0 +1,8 @@
+export type NotificationLevel = 'error' | 'info' | 'success' | 'warning';
+export default class Notification {
+    readonly level: NotificationLevel;
+    readonly text: string;
+    readonly title: string;
+    constructor(title: string, text: string, level?: NotificationLevel);
+    static empty(): Notification;
+}

package/dist/src/types/OLGeometry.d.ts

@@ -0,0 +1 @@
+export type OLGeometry = 'Circle' | 'GeometryCollection' | 'LinearRing' | 'LineString' | 'MultiLineString' | 'MultiPoint' | 'MultiPolygon' | 'Point' | 'Polygon';

package/dist/src/types/Overlay.d.ts

@@ -0,0 +1,24 @@
+import { EventDispatcher } from '../../../../node_modules/three';
+import { OverlayConfig, OverlaySourceConfig } from './configuration/layers';
+import { default as LayerObject } from './LayerObject';
+export interface Overlay extends EventDispatcher {
+    name: string;
+    options: OverlayOptions;
+    source: OverlaySourceConfig;
+    uuid: string;
+    get isLoading(): boolean;
+    set isLoading(v: boolean);
+    get opacity(): number;
+    set opacity(v: number);
+    get visible(): boolean;
+    set visible(v: boolean);
+}
+export type OverlayOptions = Omit<OverlayConfig, 'name' | 'source'>;
+export declare class OverlayObject extends LayerObject implements Overlay {
+    readonly options: OverlayOptions;
+    readonly source: OverlaySourceConfig;
+    get isLoading(): boolean;
+    set isLoading(v: boolean);
+    private _loading;
+    constructor({ name, source, ...options }: OverlayConfig);
+}

package/dist/src/types/VectorStyle.d.ts

@@ -0,0 +1,31 @@
+import { Style } from 'ol/style';
+import { StyleFunction } from 'ol/style/Style';
+export type DynamicStyleCollection = Record<DynamicStyleId, Style | StyleFunction>;
+export type DynamicStyleId = string;
+export interface FillStyle {
+    color: string;
+}
+export interface PointStyle {
+    fill: FillStyle;
+    radius: number;
+    stroke: StrokeStyle;
+}
+/** Static vector style */
+export interface StaticVectorStyle {
+    /** Fill style (for polygons) */
+    fill?: FillStyle;
+    /** Point style (for points) */
+    point?: PointStyle;
+    /** Stroke style (for lines and polygons) */
+    stroke?: StrokeStyle;
+}
+export interface StrokeStyle {
+    color: string;
+    width: number;
+}
+/**
+ * Vector style.
+ *
+ * Either an entry of the [Style configuration](../style.ts), or a static configuration
+ */
+export type VectorStyle = 'default' | DynamicStyleId | StaticVectorStyle;

package/dist/src/types/Viewbox.d.ts

@@ -0,0 +1,7 @@
+import { Vector3, BufferGeometry, LineBasicMaterial, LineSegments } from '../../../../node_modules/three';
+export default class Viewbox {
+    geometry: BufferGeometry;
+    object3D: LineSegments<BufferGeometry, LineBasicMaterial>;
+    constructor();
+    setCorners(ul: Vector3, ur: Vector3, lr: Vector3, ll: Vector3): void;
+}

package/dist/src/types/configuration/analysis.d.ts

@@ -0,0 +1,26 @@
+import { GeoVec2, GeoVec3, Vec3 } from './geographic';
+export interface AnalysisConfig {
+    /** Clipping box configuration */
+    clipping_box: {
+        /** Default center of the clipping box */
+        center: GeoVec3;
+        /** Default settings for floor presets */
+        floor_preset: {
+            /** Altitude of the ground of floor 0 */
+            altitude: number;
+            /** Default floor number */
+            floor: number;
+            /** Height of a floor */
+            size: number;
+        };
+        /** Default size of the clipping box */
+        size: Vec3;
+    };
+    /** Cross section configuration */
+    cross_section: {
+        /** Default orientation in degrees of the cross section plane */
+        orientation: number;
+        /** Default pivot point */
+        pivot: GeoVec2;
+    };
+}

package/dist/src/types/configuration/bookmark.d.ts

@@ -0,0 +1,16 @@
+import { Vec3 } from './geographic';
+/**
+ * Bookmark configuration.
+ *
+ * The easiest way to define a bookmark is actually to set it in the app, export it and copy the values from the JSON file.
+ */
+export interface BookmarkConfig {
+    /** Focal offset of the camera */
+    focalOffset: Vec3;
+    /** 3D position of the camera, in `default_crs` */
+    position: Vec3;
+    /** 3D position of the camera target, in `default_crs` */
+    target: Vec3;
+    /** Name of the bookmark displayed in the UI */
+    title: string;
+}

package/dist/src/types/configuration/camera.d.ts

@@ -0,0 +1,19 @@
+import { GeoVec2, GeoVec3 } from './geographic';
+/** Camera configuration */
+export interface CameraConfig {
+    /** Initial camera target - if not provided, will use the center of the extent */
+    lookAt?: GeoVec3;
+    /** Initial camera position */
+    position: GeoVec3;
+}
+/**
+ * Deprecated camera configuration
+ *
+ * @deprecated - Use CameraConfig instead. Will be removed in release v24.7.
+ */
+export interface CameraConfigDeprecated {
+    /** Initial camera altitude */
+    altitude: number;
+    /** Initial camera position */
+    position: [number, number] | GeoVec2;
+}

package/dist/src/types/configuration/color.d.ts

@@ -0,0 +1,18 @@
+import { default as ColorMapMode } from '@giro3d/giro3d/core/ColorMapMode';
+/**
+ * Color map configuration for Elevation layer, used when it's the only layer displayed
+ */
+export interface ColorMapConfig {
+    /** Value mapped to the end of the color ramp */
+    max: number;
+    /** Value mapped to the start of the color ramp */
+    min: number;
+    /** Color map mode */
+    mode?: ColorMapMode;
+    /** Color ramp */
+    ramp: ColorRamp;
+}
+/**
+ * Color ramp name, as supported by [chroma.js](https://gka.github.io/chroma.js/#chroma-brewer)
+ */
+export type ColorRamp = string;

package/dist/src/types/configuration/datasets/cityjson.d.ts

@@ -0,0 +1,9 @@
+import { DataProjectionMixin, UrlOrDataMixin } from '../../../giro3d/sources/mixins';
+import { DatasetConfigBase, DatasetConfigMaskingMixin } from './core';
+/** CityJSON dataset configuration */
+export interface CityJSONDatasetConfig extends DatasetConfigBase<'cityjson'>, DatasetConfigMaskingMixin {
+    source: CityJSONDatasetSourceConfig;
+}
+/** CityJSON source configuration */
+export interface CityJSONDatasetSourceConfig extends DataProjectionMixin, UrlOrDataMixin {
+}

package/dist/src/types/configuration/datasets/core.d.ts

@@ -0,0 +1,49 @@
+import { default as Entity3D } from '@giro3d/giro3d/entities/Entity3D';
+import { LayerType } from '../layers';
+import { SourceConfigElevationMixin, SourceConfigLocationMixin, SourceConfigProjectionMixin } from '../sources/core/baseConfig';
+import { DatasetOrGroup } from '../../Dataset';
+/** Configuration that can be set on groups and cascade to children */
+export interface DatasetCascadingConfig extends SourceConfigElevationMixin, SourceConfigLocationMixin, SourceConfigProjectionMixin {
+}
+/** Base configuration for all datasets */
+export interface DatasetConfigBase<TDatasetType extends string> {
+    /** Name of the dataset, as displayed in the UI */
+    name: string;
+    /** Callback which is called when the dataset is preloaded into the app */
+    onObjectPreloaded?: OnObjectPreloaded;
+    /**
+     * Default opacity (between 0 and 1; 0: transparent, 1: opaque)
+     * @defaultValue 1
+     */
+    opacity?: number;
+    /** Type of dataset */
+    type: TDatasetType;
+    /**
+     * Loads the dataset by default when opening the app
+     * @defaultValue false
+     */
+    visible?: boolean;
+}
+/** Mixin configuration for datasets that support masking the basemap */
+export interface DatasetConfigMaskingMixin {
+    /** Indicates whether this dataset can mask the basemap */
+    canMaskBasemap?: boolean;
+    /** Indicates whether this dataset is by default masking the basemap when loaded */
+    isMaskingBasemap?: boolean;
+}
+/** Giro3D layer types support for datasets */
+export type DatasetLayerType = Exclude<LayerType, 'elevation'>;
+/** Base configuration for all dataset sources */
+export interface DatasetSourceConfigBase<TDatasetType extends string> {
+    /** Type of dataset */
+    type: TDatasetType;
+}
+/**
+ * Callback which is called when the dataset is preloaded into the app.
+ *
+ * This can be useful for post-processing your data (transformation, rotation, etc.).
+ *
+ * @param dataset - Dataset created
+ * @param entity - Giro3D entity created
+ */
+export type OnObjectPreloaded = (dataset: DatasetOrGroup, entity: Entity3D) => void;

package/dist/src/types/configuration/datasets/featureCollection.d.ts

@@ -0,0 +1,6 @@
+import { FeatureCollectionEntityOptions } from '../../../giro3d/entities/FeatureCollectionEntity';
+import { DatasetConfigBase } from './core';
+/** Buildings dataset configuration */
+export interface FeatureCollectionDatasetConfig extends DatasetConfigBase<'featureCollection'> {
+    source: FeatureCollectionEntityOptions['source'];
+}

package/dist/src/types/configuration/datasets/ifc.d.ts

@@ -0,0 +1,10 @@
+import { UrlOrDataMixin } from '../../../giro3d/sources/mixins';
+import { SourceConfigLocationMixin } from '../sources/core/baseConfig';
+import { DatasetConfigBase, DatasetConfigMaskingMixin } from './core';
+/** IFC dataset configuration */
+export interface IFCDatasetConfig extends DatasetConfigBase<'ifc'>, DatasetConfigMaskingMixin {
+    source: IFCDatasetSourceConfig;
+}
+/** IFC source configuration */
+export interface IFCDatasetSourceConfig extends SourceConfigLocationMixin, UrlOrDataMixin {
+}

package/dist/src/types/configuration/datasets/index.d.ts

@@ -0,0 +1,27 @@
+import { CityJSONDatasetConfig } from './cityjson';
+import { DatasetCascadingConfig, DatasetConfigBase, DatasetConfigMaskingMixin } from './core';
+import { FeatureCollectionDatasetConfig } from './featureCollection';
+import { IFCDatasetConfig } from './ifc';
+import { ColorLayerDatasetConfig, ElevationLayerDatasetConfig, MaskLayerDatasetConfig } from './layer';
+import { PLYDatasetConfig } from './ply';
+import { PointCloudDatasetConfig } from './pointCloud';
+import { PotreePointCloudDatasetConfig } from './potreePointCloud';
+import { TiledIfcDatasetConfig } from './tiledIfc';
+import { TiledPointCloudDatasetConfig } from './tiledPointCloud';
+import { VectorLabelsDatasetConfig, VectorMeshDatasetConfig, VectorShapeDatasetConfig } from './vector';
+/** Configuration for a group of datasets */
+export interface DatagroupConfig extends DatasetCascadingConfig, DatasetConfigBase<'group'>, DatasetConfigMaskingMixin {
+    /** Datasets contained in this group */
+    children: DatasetOrGroupConfig[];
+}
+export type DatasetAsLayerConfig = ColorLayerDatasetConfig | ElevationLayerDatasetConfig | MaskLayerDatasetConfig;
+export type DatasetAsMeshConfig = CityJSONDatasetConfig | FeatureCollectionDatasetConfig | IFCDatasetConfig | PLYDatasetConfig | PointCloudDatasetConfig | PotreePointCloudDatasetConfig | TiledIfcDatasetConfig | TiledPointCloudDatasetConfig | VectorLabelsDatasetConfig | VectorMeshDatasetConfig | VectorShapeDatasetConfig;
+/** All supported datasets */
+export type DatasetConfig = DatasetAsLayerConfig | DatasetAsMeshConfig;
+export type DatasetConfigImportable = Extract<DatasetConfig, CityJSONDatasetConfig | ColorLayerDatasetConfig | IFCDatasetConfig | PointCloudDatasetConfig | VectorLabelsDatasetConfig | VectorMeshDatasetConfig | VectorShapeDatasetConfig>;
+/** Configuration for dataset hierarchy */
+export type DatasetOrGroupConfig = DatagroupConfig | DatasetConfig;
+/** List of all dataset types */
+export type DatasetType = DatasetConfig['type'];
+/** List of dataset types that can be imported into the app */
+export type DatasetTypeImportable = DatasetConfigImportable['type'];

package/dist/src/types/configuration/datasets/layer.d.ts

@@ -0,0 +1,43 @@
+import { ColorLayerOptions } from '@giro3d/giro3d/core/layer/ColorLayer';
+import { ElevationLayerOptions } from '@giro3d/giro3d/core/layer/ElevationLayer';
+import { Mode as InterpretationMode, InterpretationOptions } from '@giro3d/giro3d/core/layer/Interpretation';
+import { LayerOptions } from '@giro3d/giro3d/core/layer/Layer';
+import { MaskLayerOptions } from '@giro3d/giro3d/core/layer/MaskLayer';
+import { ColorMapConfig } from '../color';
+import { GeoExtent } from '../geographic';
+import { LayerSourceConfig } from '../layers';
+import { DatasetConfigBase } from './core';
+/** Mixin configuration for color layer options */
+export interface ColorLayerConfigMixin extends Pick<ColorLayerOptions, 'elevationRange' | 'magFilter' | 'minFilter' | 'opacity'> {
+}
+/** Color layer configuration */
+export interface ColorLayerDatasetConfig extends ColorLayerConfigMixin, LayerDatasetConfigBase<'colorLayer'> {
+}
+/** Mixin configuration for elevation layer options */
+export interface ElevationLayerConfigMixin extends Pick<ElevationLayerOptions, 'minmax'> {
+}
+/** Elevation layer configuration */
+export interface ElevationLayerDatasetConfig extends ElevationLayerConfigMixin, LayerDatasetConfigBase<'elevationLayer'> {
+}
+/** Mixin configuration for layer options */
+export interface LayerConfigMixin extends Pick<LayerOptions, 'noDataOptions' | 'preloadImages' | 'resolutionFactor' | 'showEmptyTextures' | 'showTileBorders'> {
+    /** Background color of the layer */
+    backgroundColor?: string;
+    /** Color map for displaying the layer */
+    colorMap?: ColorMapConfig;
+    /** Restrict the extent of the data */
+    extent?: GeoExtent;
+    /** Interpretation mode of the data */
+    interpretation?: InterpretationOptions & {
+        mode: InterpretationMode;
+    };
+}
+export interface LayerDatasetConfigBase<TDatasetType extends string> extends DatasetConfigBase<TDatasetType>, LayerConfigMixin {
+    source: LayerSourceConfig;
+}
+/** Mixin configuration for mask layer options */
+export interface MaskLayerConfigMixin extends Pick<MaskLayerOptions, 'maskMode'> {
+}
+/** Mask layer configuration */
+export interface MaskLayerDatasetConfig extends LayerDatasetConfigBase<'maskLayer'>, MaskLayerConfigMixin {
+}

package/dist/src/types/configuration/datasets/ply.d.ts

@@ -0,0 +1,10 @@
+import { UrlOrDataMixin } from '../../../giro3d/sources/mixins';
+import { SourceConfigLocationMixin } from '../sources/core/baseConfig';
+import { DatasetConfigBase } from './core';
+/** PLY dataset configuration */
+export interface PLYDatasetConfig extends DatasetConfigBase<'ply'> {
+    source: PLYDatasetSourceConfig;
+}
+/** PLY source configuration */
+export interface PLYDatasetSourceConfig extends Required<SourceConfigLocationMixin>, UrlOrDataMixin {
+}

package/dist/src/types/configuration/datasets/pointCloud.d.ts

@@ -0,0 +1,12 @@
+import { PointCloudSourceOptions } from '../../../giro3d/entities/PointCloudEntity';
+import { DatasetConfigBase, DatasetConfigMaskingMixin, DatasetSourceConfigBase } from './core';
+export interface COPCPointCloudSourceConfig extends DatasetSourceConfigBase<'copc'>, PointCloudSourceOptions {
+}
+export interface CSVPointCloudSourceConfig extends DatasetSourceConfigBase<'csv'>, PointCloudSourceOptions {
+}
+export interface LASPointCloudSourceConfig extends DatasetSourceConfigBase<'las'>, PointCloudSourceOptions {
+}
+export interface PointCloudDatasetConfig extends DatasetConfigBase<'flatPointcloud'>, DatasetConfigMaskingMixin {
+    source: PointCloudSourceConfig;
+}
+export type PointCloudSourceConfig = COPCPointCloudSourceConfig | CSVPointCloudSourceConfig | LASPointCloudSourceConfig;

package/dist/src/types/configuration/datasets/potreePointCloud.d.ts

@@ -0,0 +1,10 @@
+import { SourceConfigUrlMixin } from '../sources/core/baseConfig';
+import { DatasetConfigBase, DatasetSourceConfigBase } from './core';
+/** Potree PointCloud dataset configuration */
+export interface PotreePointCloudDatasetConfig extends DatasetConfigBase<'potree'> {
+    source: PotreePointCloudDatasetSourceConfig;
+}
+/** Potree PointCloud source configuration */
+export interface PotreePointCloudDatasetSourceConfig extends DatasetSourceConfigBase<'potree'>, SourceConfigUrlMixin {
+    filename?: string;
+}

package/dist/src/types/configuration/datasets/tiledIfc.d.ts

@@ -0,0 +1,9 @@
+import { Tiles3dSource } from '../../../giro3d/entities/Tiles3dEntity';
+import { DatasetConfigBase } from './core';
+/** 3DTiles IFC dataset configuration */
+export interface TiledIfcDatasetConfig extends DatasetConfigBase<'tiledIfc'> {
+    source: TiledIfcDatasetSourceConfig;
+}
+/** 3DTiles IFC source configuration */
+export interface TiledIfcDatasetSourceConfig extends Tiles3dSource {
+}

package/dist/src/types/configuration/datasets/tiledPointCloud.d.ts

@@ -0,0 +1,9 @@
+import { TiledPointCloudSource } from '../../../giro3d/entities/TiledPointCloudEntity';
+import { DatasetConfigBase, DatasetConfigMaskingMixin } from './core';
+/** 3D-Tiles PointCloud dataset configuration */
+export interface TiledPointCloudDatasetConfig extends DatasetConfigBase<'pointcloud'>, DatasetConfigMaskingMixin {
+    source: TiledPointCloudSourceConfig;
+}
+/** 3D-Tiles PointCloud source configuration */
+export interface TiledPointCloudSourceConfig extends Omit<TiledPointCloudSource, 'name'> {
+}

package/dist/src/types/configuration/datasets/vector.d.ts

@@ -0,0 +1,34 @@
+import { default as FeatureFormat } from 'ol/format/Feature';
+import { VectorLabelOptions } from '../../../giro3d/entities/VectorLabelsEntity';
+import { VectorMeshSourceOptions } from '../../../giro3d/entities/VectorMeshEntity';
+import { GeopackageSourceParameters } from '../../../giro3d/sources/GeopackageSource';
+import { ShapefileSourceParameters } from '../../../giro3d/sources/ShapefileSource';
+import { DatasetConfigBase, DatasetSourceConfigBase } from './core';
+export interface GeoJsonMeshSourceConfig extends DatasetSourceConfigBase<'geojson'>, Omit<VectorMeshSourceOptions, 'featureProjection'> {
+}
+export interface GeopackageMeshSourceConfig extends DatasetSourceConfigBase<'geopackage'>, Omit<GeopackageSourceParameters, 'featureProjection'> {
+}
+export interface GpxMeshSourceConfig extends DatasetSourceConfigBase<'gpx'>, Omit<VectorMeshSourceOptions, 'featureProjection'> {
+}
+export interface KmlMeshSourceConfig extends DatasetSourceConfigBase<'kml'>, Omit<VectorMeshSourceOptions, 'featureProjection'> {
+}
+export interface OlMeshSourceConfig extends DatasetSourceConfigBase<'ol'>, Omit<VectorMeshSourceOptions, 'featureProjection'> {
+    format: FeatureFormat;
+}
+export interface ShapefileMeshSourceConfig extends DatasetSourceConfigBase<'shapefile'>, Omit<ShapefileSourceParameters, 'featureProjection'> {
+}
+export type VectorDatasetConfig = VectorLabelsDatasetConfig | VectorMeshDatasetConfig | VectorShapeDatasetConfig;
+export type VectorDatasetRendering = NonNullable<VectorDatasetConfig['rendering']>;
+export interface VectorLabelsDatasetConfig extends DatasetConfigBase<'vector'>, VectorLabelOptions {
+    rendering: 'label';
+    source: VectorMeshDatasetSourceConfig | VectorMeshDatasetSourceConfig[];
+}
+export interface VectorMeshDatasetConfig extends DatasetConfigBase<'vector'> {
+    rendering?: 'mesh';
+    source: VectorMeshDatasetSourceConfig | VectorMeshDatasetSourceConfig[];
+}
+export type VectorMeshDatasetSourceConfig = GeoJsonMeshSourceConfig | GeopackageMeshSourceConfig | GpxMeshSourceConfig | KmlMeshSourceConfig | OlMeshSourceConfig | ShapefileMeshSourceConfig;
+export interface VectorShapeDatasetConfig extends DatasetConfigBase<'vector'> {
+    rendering: 'shape';
+    source: VectorMeshDatasetSourceConfig;
+}

package/dist/src/types/configuration/features.d.ts

@@ -0,0 +1,2 @@
+/** Available experimental features */
+export type ExperimentalFeatures = 'measurements';

package/dist/src/types/configuration/geographic.d.ts

@@ -0,0 +1,51 @@
+/**
+ * CRS name.
+ *
+ * Requires the CRS to be registered in [`src/services/Giro3DManager.ts`](../services/Giro3DManager.ts)
+ * @example `EPSG:2154`
+ * @example `IGNF:WGS84G`
+ */
+export type CRS = string;
+/**
+ * Extent
+ *
+ * If the CRS is not provided, we use `default_crs`
+ *
+ * @example `{ crs: 'EPSG:2154', west: -111629.52, east: 1275028.84, south: 5976033.79, north: 7230161.64 }`
+ */
+export interface GeoExtent {
+    crs?: string;
+    east: number;
+    north: number;
+    south: number;
+    west: number;
+}
+/**
+ * 2D Position
+ *
+ * If the CRS is not provided, we use `default_crs`
+ *
+ * @example `{ crs: 'EPSG:2154', x: 842022, y: 6516602 }`
+ */
+export interface GeoVec2 extends Vec2 {
+    crs?: CRS;
+}
+/**
+ * 3D Position
+ *
+ * If the CRS is not provided, we use `default_crs`
+ *
+ * @example `{ crs: 'EPSG:2154', x: 842022, y: 6516602, z: 725 }`
+ */
+export interface GeoVec3 extends Vec3 {
+    crs?: CRS;
+}
+export interface Vec2 {
+    x: number;
+    y: number;
+}
+export interface Vec3 {
+    x: number;
+    y: number;
+    z: number;
+}

package/dist/src/types/configuration/layers/core.d.ts

@@ -0,0 +1,50 @@
+import { ColorLayerOptions } from '@giro3d/giro3d/core/layer/ColorLayer';
+import { ElevationLayerOptions } from '@giro3d/giro3d/core/layer/ElevationLayer';
+import { Mode as InterpretationMode, InterpretationOptions } from '@giro3d/giro3d/core/layer/Interpretation';
+import { LayerOptions } from '@giro3d/giro3d/core/layer/Layer';
+import { MaskLayerOptions } from '@giro3d/giro3d/core/layer/MaskLayer';
+import { ColorMapConfig } from '../color';
+import { GeoExtent } from '../geographic';
+import { LayerSourceConfig } from '.';
+/** Color layer configuration */
+export interface ColorLayerConfig extends ColorLayerConfigMixin, LayerConfigBase<'color'> {
+}
+/** Mixin configuration for color layer options */
+export interface ColorLayerConfigMixin extends Pick<ColorLayerOptions, 'elevationRange' | 'magFilter' | 'minFilter' | 'opacity'> {
+}
+/** Elevation layer configuration */
+export interface ElevationLayerConfig extends ElevationLayerConfigMixin, LayerConfigBase<'elevation'> {
+}
+/** Mixin configuration for elevation layer options */
+export interface ElevationLayerConfigMixin extends Pick<ElevationLayerOptions, 'minmax'> {
+}
+/** Basemap layer configuration */
+export interface LayerConfigBase<TLayerType extends string> extends LayerConfigMixin {
+    /** Name of the layer displayed in the UI */
+    name: string;
+    /** Source configuration */
+    source: LayerSourceConfig;
+    /** Type of layer */
+    type: TLayerType;
+    /** Indicates if the layer should be loaded by default */
+    visible: boolean;
+}
+/** Mixin configuration for layer options */
+export interface LayerConfigMixin extends Pick<LayerOptions, 'magFilter' | 'minFilter' | 'noDataOptions' | 'preloadImages' | 'resolutionFactor' | 'showEmptyTextures' | 'showTileBorders'> {
+    /** Background color of the layer */
+    backgroundColor?: string;
+    /** Color map for displaying the layer */
+    colorMap?: ColorMapConfig;
+    /** Restrict the extent of the data */
+    extent?: GeoExtent;
+    /** Interpretation mode of the data */
+    interpretation?: InterpretationOptions & {
+        mode: InterpretationMode;
+    };
+}
+/** Mask layer configuration */
+export interface MaskLayerConfig extends LayerConfigBase<'mask'>, MaskLayerConfigMixin {
+}
+/** Mixin configuration for mask layer options */
+export interface MaskLayerConfigMixin extends Pick<MaskLayerOptions, 'maskMode'> {
+}

package/dist/src/types/configuration/layers/index.d.ts

@@ -0,0 +1,51 @@
+import { BingMapsSourceConfig } from '../sources/bingMaps';
+import { CustomVectorSourceConfig } from '../sources/customVector';
+import { CustomVectorTileSourceConfig } from '../sources/customVectorTile';
+import { GeoJSONAsLayerSourceConfig } from '../sources/geojson';
+import { GeoTIFFSourceConfig } from '../sources/geotiff';
+import { GPXAsLayerSourceConfig } from '../sources/gpx';
+import { KMLAsLayerSourceConfig } from '../sources/kml';
+import { MVTSourceConfig } from '../sources/mvt';
+import { OSMSourceConfig } from '../sources/osm';
+import { StadiaMapsSourceConfig } from '../sources/stadiaMaps';
+import { WMSSourceConfig } from '../sources/wms';
+import { WMTSSourceConfig } from '../sources/wmts';
+import { XYZSourceConfig } from '../sources/xyz';
+import { ColorLayerConfig, ElevationLayerConfig, MaskLayerConfig } from './core';
+type OverlayVectorSourceConfig = GeoJSONAsLayerSourceConfig | GPXAsLayerSourceConfig | KMLAsLayerSourceConfig;
+/** Available configuration for layer sources */
+export type BasemapLayerSourceConfig = LayerSourceConfig;
+/** Layer configuration */
+export type LayerConfig = ColorLayerConfig | ElevationLayerConfig | MaskLayerConfig;
+/** Supported layer sources */
+export type LayerSourceConfig = BingMapsSourceConfig | CustomVectorSourceConfig | CustomVectorTileSourceConfig | GeoJSONAsLayerSourceConfig | GeoTIFFSourceConfig | GPXAsLayerSourceConfig | KMLAsLayerSourceConfig | MVTSourceConfig | OSMSourceConfig | StadiaMapsSourceConfig | WMSSourceConfig | WMTSSourceConfig | XYZSourceConfig;
+/** Supported layer source types */
+export type LayerSourceType = LayerSourceConfig['type'];
+/** Supported Giro3D layer types */
+export type LayerType = LayerConfig['type'];
+/** Overlay configuration */
+export interface OverlayConfig extends Omit<ColorLayerConfig, 'type'> {
+    /** Source configuration */
+    source: OverlaySourceConfig;
+}
+/**
+ * Raster overlay configuration
+ *
+ * @deprecated Use 'source' field instead. Will be removed in release v24.7.
+ */
+export type OverlayRasterConfigDeprecated = OverlayConfig & (WMSSourceConfig | WMTSSourceConfig);
+/** Available configuration for overlay sources */
+export type OverlaySourceConfig = LayerSourceConfig;
+/**
+ * Vector overlay configuration
+ *
+ * @deprecated Use 'source' field instead. Will be removed in release v24.7.
+ */
+export type OverlayVectorConfigDeprecated = Omit<OverlayConfig, 'source'> & OverlayVectorSourceConfig;
+/**
+ * Vector tile overlay configuration
+ *
+ * @deprecated Use 'source' field instead. Will be removed in release v24.7.
+ */
+export type OverlayVectorTileConfigDeprecated = MVTSourceConfig & Omit<OverlayConfig, 'source'>;
+export {};

package/dist/src/types/configuration/sources/bingMaps.d.ts

@@ -0,0 +1,5 @@
+import { Options as BingMapsOptions } from 'ol/source/BingMaps';
+import { ImageSourceConfigMixin, SourceConfigBase } from './core/baseConfig';
+/** Bing maps source configuration */
+export interface BingMapsSourceConfig extends ImageSourceConfigMixin, Pick<BingMapsOptions, 'culture' | 'hidpi' | 'imagerySet' | 'key'>, SourceConfigBase<'bingmaps'> {
+}