@globalfishingwatch/api-types - npm Package Compare versions

Comparing version 8.0.0 to 8.0.1

index.cjs.js

 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 const DRAW_DATASET_SOURCE = 'drawn_on_gfw_map';
@@ -11,2 +9,3 @@ exports.EndpointId = void 0;
     EndpointId["ClusterTiles"] = "events-cluster-tiles";
+    EndpointId["ClusterTilesInteraction"] = "events-cluster-interaction";
     EndpointId["ContextGeojson"] = "temporal-context-geojson";
@@ -67,2 +66,26 @@ EndpointId["Events"] = "events";
 const EXCLUDE_FILTER_ID = 'exclude';
+exports.DataviewType = void 0;
+(function(DataviewType) {
+    DataviewType["Annotation"] = "ANNOTATION";
+    DataviewType["Background"] = "BACKGROUND";
+    DataviewType["Basemap"] = "BASEMAP";
+    DataviewType["BasemapLabels"] = "BASEMAP_LABELS";
+    DataviewType["CartoPolygons"] = "CARTO_POLYGONS";
+    DataviewType["Context"] = "CONTEXT";
+    DataviewType["GL"] = "GL";
+    DataviewType["Graticules"] = "GRATICULES";
+    DataviewType["Heatmap"] = "HEATMAP";
+    DataviewType["HeatmapStatic"] = "HEATMAP_STATIC";
+    DataviewType["HeatmapAnimated"] = "HEATMAP_ANIMATED";
+    DataviewType["Polygons"] = "POLYGONS";
+    DataviewType["Rulers"] = "RULERS";
+    DataviewType["TileCluster"] = "TILE_CLUSTER";
+    DataviewType["FourwingsTileCluster"] = "FOURWINGS_TILE_CLUSTER";
+    DataviewType["Track"] = "TRACK";
+    DataviewType["UserContext"] = "USER_CONTEXT";
+    DataviewType["UserPoints"] = "USER_POINTS";
+    DataviewType["VesselEvents"] = "VESSEL_EVENTS";
+    DataviewType["VesselEventsShapes"] = "VESSEL_EVENTS_SHAPES";
+    DataviewType["Workspaces"] = "WORKSPACES";
+})(exports.DataviewType || (exports.DataviewType = {}));
 exports.DataviewCategory = void 0;
@@ -78,2 +101,5 @@ (function(DataviewCategory) {
     DataviewCategory["Vessels"] = "vessels";
+    DataviewCategory["VesselGroups"] = "vesselGroups";
+    DataviewCategory["Workspaces"] = "workspaces";
+    DataviewCategory["Buffer"] = "buffer";
 })(exports.DataviewCategory || (exports.DataviewCategory = {}));
@@ -95,2 +121,4 @@
     RegionType["fao"] = "fao";
+    RegionType["majorFao"] = "majorFao";
+    RegionType["highSeas"] = "highSeas";
 })(exports.RegionType || (exports.RegionType = {}));
@@ -126,29 +154,2 @@ exports.EventTypes = void 0;
 
-exports.Field = void 0;
-(function(Field) {
-    Field["lonlat"] = "lonlat";
-    Field["longitude"] = "longitude";
-    Field["latitude"] = "latitude";
-    Field["timestamp"] = "timestamp";
-    Field["fishing"] = "fishing";
-    Field["speed"] = "speed";
-    Field["course"] = "course";
-    Field["night"] = "night";
-    Field["distanceFromPort"] = "distance_from_port";
-    Field["elevation"] = "elevation";
-    Field["id"] = "id";
-    Field["color"] = "color";
-})(exports.Field || (exports.Field = {}));
-exports.ResourceStatus = void 0;
-(function(ResourceStatus) {
-    ResourceStatus["Idle"] = "idle";
-    ResourceStatus["Aborted"] = "aborted";
-    ResourceStatus["Loading"] = "loading";
-    ResourceStatus["Finished"] = "finished";
-    ResourceStatus["Error"] = "error";
-})(exports.ResourceStatus || (exports.ResourceStatus = {}));
-
-const tuple = (...args)=>args;
-const USER_APPLICATION_INTENDED_USES = tuple('commercial', 'non-commercial');
-
 exports.VesselIdentitySourceEnum = void 0;
@@ -174,2 +175,35 @@ (function(VesselIdentitySourceEnum) {
 
+exports.ResourceStatus = void 0;
+(function(ResourceStatus) {
+    ResourceStatus["Idle"] = "idle";
+    ResourceStatus["Aborted"] = "aborted";
+    ResourceStatus["Loading"] = "loading";
+    ResourceStatus["Finished"] = "finished";
+    ResourceStatus["Error"] = "error";
+})(exports.ResourceStatus || (exports.ResourceStatus = {}));
+
+exports.TrackField = void 0;
+(function(TrackField) {
+    TrackField["lonlat"] = "lonlat";
+    TrackField["longitude"] = "longitude";
+    TrackField["latitude"] = "latitude";
+    TrackField["timestamp"] = "timestamp";
+    TrackField["fishing"] = "fishing";
+    TrackField["speed"] = "speed";
+    TrackField["depth"] = "depth";
+    TrackField["course"] = "course";
+    TrackField["night"] = "night";
+    TrackField["distanceFromPort"] = "distance_from_port";
+    TrackField["elevation"] = "elevation";
+    TrackField["id"] = "id";
+    TrackField["color"] = "color";
+})(exports.TrackField || (exports.TrackField = {}));
+
+const tuple = (...args)=>args;
+const USER_APPLICATION_INTENDED_USES = tuple('commercial', 'non-commercial');
+
+const WORKSPACE_PUBLIC_ACCESS = 'public';
+const WORKSPACE_PASSWORD_ACCESS = 'password';
+const WORKSPACE_PRIVATE_ACCESS = 'private';
+
 exports.API_LOGIN_REQUIRED = API_LOGIN_REQUIRED;
@@ -180,1 +214,4 @@ exports.DRAW_DATASET_SOURCE = DRAW_DATASET_SOURCE;
 exports.USER_APPLICATION_INTENDED_USES = USER_APPLICATION_INTENDED_USES;
+exports.WORKSPACE_PASSWORD_ACCESS = WORKSPACE_PASSWORD_ACCESS;
+exports.WORKSPACE_PRIVATE_ACCESS = WORKSPACE_PRIVATE_ACCESS;
+exports.WORKSPACE_PUBLIC_ACCESS = WORKSPACE_PUBLIC_ACCESS;

index.esm.js

@@ -7,2 +7,3 @@ const DRAW_DATASET_SOURCE = 'drawn_on_gfw_map';
     EndpointId["ClusterTiles"] = "events-cluster-tiles";
+    EndpointId["ClusterTilesInteraction"] = "events-cluster-interaction";
     EndpointId["ContextGeojson"] = "temporal-context-geojson";
@@ -63,2 +64,26 @@ EndpointId["Events"] = "events";
 const EXCLUDE_FILTER_ID = 'exclude';
+var DataviewType;
+(function(DataviewType) {
+    DataviewType["Annotation"] = "ANNOTATION";
+    DataviewType["Background"] = "BACKGROUND";
+    DataviewType["Basemap"] = "BASEMAP";
+    DataviewType["BasemapLabels"] = "BASEMAP_LABELS";
+    DataviewType["CartoPolygons"] = "CARTO_POLYGONS";
+    DataviewType["Context"] = "CONTEXT";
+    DataviewType["GL"] = "GL";
+    DataviewType["Graticules"] = "GRATICULES";
+    DataviewType["Heatmap"] = "HEATMAP";
+    DataviewType["HeatmapStatic"] = "HEATMAP_STATIC";
+    DataviewType["HeatmapAnimated"] = "HEATMAP_ANIMATED";
+    DataviewType["Polygons"] = "POLYGONS";
+    DataviewType["Rulers"] = "RULERS";
+    DataviewType["TileCluster"] = "TILE_CLUSTER";
+    DataviewType["FourwingsTileCluster"] = "FOURWINGS_TILE_CLUSTER";
+    DataviewType["Track"] = "TRACK";
+    DataviewType["UserContext"] = "USER_CONTEXT";
+    DataviewType["UserPoints"] = "USER_POINTS";
+    DataviewType["VesselEvents"] = "VESSEL_EVENTS";
+    DataviewType["VesselEventsShapes"] = "VESSEL_EVENTS_SHAPES";
+    DataviewType["Workspaces"] = "WORKSPACES";
+})(DataviewType || (DataviewType = {}));
 var DataviewCategory;
@@ -74,2 +99,5 @@ (function(DataviewCategory) {
     DataviewCategory["Vessels"] = "vessels";
+    DataviewCategory["VesselGroups"] = "vesselGroups";
+    DataviewCategory["Workspaces"] = "workspaces";
+    DataviewCategory["Buffer"] = "buffer";
 })(DataviewCategory || (DataviewCategory = {}));
@@ -91,2 +119,4 @@
     RegionType["fao"] = "fao";
+    RegionType["majorFao"] = "majorFao";
+    RegionType["highSeas"] = "highSeas";
 })(RegionType || (RegionType = {}));
@@ -122,29 +152,2 @@ var EventTypes;
 
-var Field;
-(function(Field) {
-    Field["lonlat"] = "lonlat";
-    Field["longitude"] = "longitude";
-    Field["latitude"] = "latitude";
-    Field["timestamp"] = "timestamp";
-    Field["fishing"] = "fishing";
-    Field["speed"] = "speed";
-    Field["course"] = "course";
-    Field["night"] = "night";
-    Field["distanceFromPort"] = "distance_from_port";
-    Field["elevation"] = "elevation";
-    Field["id"] = "id";
-    Field["color"] = "color";
-})(Field || (Field = {}));
-var ResourceStatus;
-(function(ResourceStatus) {
-    ResourceStatus["Idle"] = "idle";
-    ResourceStatus["Aborted"] = "aborted";
-    ResourceStatus["Loading"] = "loading";
-    ResourceStatus["Finished"] = "finished";
-    ResourceStatus["Error"] = "error";
-})(ResourceStatus || (ResourceStatus = {}));
-
-const tuple = (...args)=>args;
-const USER_APPLICATION_INTENDED_USES = tuple('commercial', 'non-commercial');
-
 var VesselIdentitySourceEnum;
@@ -170,2 +173,35 @@ (function(VesselIdentitySourceEnum) {
 
-export { API_LOGIN_REQUIRED, AuthorizationOptions, DRAW_DATASET_SOURCE, DatasetCategory, DatasetStatus, DatasetSubCategory, DatasetTypes, DataviewCategory, DownloadActivityStatus, EXCLUDE_FILTER_ID, EndpointId, EventTypes, EventVesselTypeEnum, Field, INCLUDE_FILTER_ID, Locale, RegionType, ResourceStatus, SelfReportedSource, USER_APPLICATION_INTENDED_USES, VesselIdentitySourceEnum };
+var ResourceStatus;
+(function(ResourceStatus) {
+    ResourceStatus["Idle"] = "idle";
+    ResourceStatus["Aborted"] = "aborted";
+    ResourceStatus["Loading"] = "loading";
+    ResourceStatus["Finished"] = "finished";
+    ResourceStatus["Error"] = "error";
+})(ResourceStatus || (ResourceStatus = {}));
+
+var TrackField;
+(function(TrackField) {
+    TrackField["lonlat"] = "lonlat";
+    TrackField["longitude"] = "longitude";
+    TrackField["latitude"] = "latitude";
+    TrackField["timestamp"] = "timestamp";
+    TrackField["fishing"] = "fishing";
+    TrackField["speed"] = "speed";
+    TrackField["depth"] = "depth";
+    TrackField["course"] = "course";
+    TrackField["night"] = "night";
+    TrackField["distanceFromPort"] = "distance_from_port";
+    TrackField["elevation"] = "elevation";
+    TrackField["id"] = "id";
+    TrackField["color"] = "color";
+})(TrackField || (TrackField = {}));
+
+const tuple = (...args)=>args;
+const USER_APPLICATION_INTENDED_USES = tuple('commercial', 'non-commercial');
+
+const WORKSPACE_PUBLIC_ACCESS = 'public';
+const WORKSPACE_PASSWORD_ACCESS = 'password';
+const WORKSPACE_PRIVATE_ACCESS = 'private';
+
+export { API_LOGIN_REQUIRED, AuthorizationOptions, DRAW_DATASET_SOURCE, DatasetCategory, DatasetStatus, DatasetSubCategory, DatasetTypes, DataviewCategory, DataviewType, DownloadActivityStatus, EXCLUDE_FILTER_ID, EndpointId, EventTypes, EventVesselTypeEnum, INCLUDE_FILTER_ID, Locale, RegionType, ResourceStatus, SelfReportedSource, TrackField, USER_APPLICATION_INTENDED_USES, VesselIdentitySourceEnum, WORKSPACE_PASSWORD_ACCESS, WORKSPACE_PRIVATE_ACCESS, WORKSPACE_PUBLIC_ACCESS };

package.json

 {
   "name": "@globalfishingwatch/api-types",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "description": "Typescript definitions for API responses",
@@ -12,3 +12,4 @@ "author": "satellitestudio <[e-mail]>",
     "geojson": "0.x"
-  }
-}
+  },
+  "types": "./index.esm.d.ts"
+}

src/datasets.d.ts

@@ -22,2 +22,3 @@ import { EventTypes } from './events';
     ClusterTiles = "events-cluster-tiles",
+    ClusterTilesInteraction = "events-cluster-interaction",
     ContextGeojson = "temporal-context-geojson",
@@ -67,3 +68,3 @@ Events = "events",
 export type DatasetGeometryToGeoJSONGeometry = {
-    [Property in DatasetGeometryType]: string;
+    [Property in DatasetGeometryType]: string[];
 };
@@ -84,2 +85,3 @@ export type TimeFilterType = 'date' | 'dateRange';
     sourceFormat?: DatasetConfigurationSourceFormat;
+    includeWithoutEndDate?: boolean;
     pointName?: string;
@@ -103,12 +105,34 @@ pointSize?: string;
 export type DatasetConfigurationInterval = 'YEAR' | 'MONTH' | 'DAY' | 'HOUR';
-export interface DatasetConfiguration {
-    id?: string;
-    index?: string;
+interface DatasetBackendConfig {
+    table?: string;
+    dataset?: string;
+    project?: string;
+    version?: number;
+    tileScale?: number;
+    tileOffset?: number;
+    timestamp?: string;
+    translate?: boolean | null;
+    numBytes?: number | null;
+    indexBoost?: number | null;
+    insightSources?: string[];
+    interactionColumns?: string[];
+    interactionGroupColumns?: string[];
+    ttl?: number | null;
+    band?: string | null;
+    images?: string | null;
+    source?: string | null;
+    tableName?: string;
     filePath?: string;
     srid?: number;
     file?: string;
+}
+export interface DatasetConfiguration extends DatasetBackendConfig {
+    id?: string;
+    index?: string;
     type?: EventTypes;
+    source?: string;
+    function?: 'AVG' | 'SUM';
+    aggregationOperation?: 'avg' | 'sum';
     geometryType?: DatasetGeometryType;
     format?: 'geojson';
-    tableName?: string;
     documentation?: DatasetDocumentation;
@@ -123,2 +147,3 @@ fields?: string[];
     propertyToInclude?: string;
+    maxZoom?: number;
     min?: number;
@@ -141,2 +166,3 @@ max?: number;
     };
+    maxZoom?: number;
 }
@@ -153,2 +179,3 @@ export type AnyDatasetConfiguration = DatasetConfiguration | EnviromentalDatasetConfiguration;
     enum?: DatasetSchemaItemEnum;
+    format?: string;
     maxLength?: number;
@@ -260,1 +287,2 @@ minLength?: number;
 }
+export {};

src/dataviews.d.ts

@@ -0,3 +1,5 @@
+import { Locale } from './i18n';
 import { ApiAppName } from './workspaces';
 import { Dataset } from './datasets';
+import { VesselGroup } from './vesselGroups';
 export type ColorCyclingType = 'fill' | 'line';
@@ -11,12 +13,111 @@ export declare const INCLUDE_FILTER_ID = "include";
 }
-export interface DataviewConfig<Type = any> {
+export declare enum DataviewType {
+    Annotation = "ANNOTATION",
+    Background = "BACKGROUND",
+    Basemap = "BASEMAP",
+    BasemapLabels = "BASEMAP_LABELS",
+    CartoPolygons = "CARTO_POLYGONS",
+    Context = "CONTEXT",
+    GL = "GL",
+    Graticules = "GRATICULES",
+    Heatmap = "HEATMAP",
+    HeatmapStatic = "HEATMAP_STATIC",
+    HeatmapAnimated = "HEATMAP_ANIMATED",
+    Polygons = "POLYGONS",
+    Rulers = "RULERS",
+    TileCluster = "TILE_CLUSTER",
+    FourwingsTileCluster = "FOURWINGS_TILE_CLUSTER",
+    Track = "TRACK",
+    UserContext = "USER_CONTEXT",
+    UserPoints = "USER_POINTS",
+    VesselEvents = "VESSEL_EVENTS",
+    VesselEventsShapes = "VESSEL_EVENTS_SHAPES",
+    Workspaces = "WORKSPACES"
+}
+export type DataviewSublayerConfig = {
+    id: string;
+    datasets: Dataset[];
+    visible?: boolean;
+    color?: string;
+    colorRamp?: string;
+    filter?: DataviewConfig['filter'];
+    filters?: DataviewConfig['filters'];
+    vesselGroups?: DataviewConfig['vessel-groups'];
+    /** Needed to update the layer when the vessel group is edited */
+    vesselGroupsLength?: number;
+    maxZoom?: number;
+};
+export type FourwingsGeolocation = 'country' | 'port' | 'default';
+/** Used to define the max zoom level for each geolocation (all levels must be below 12) */
+export type ClusterMaxZoomLevelConfig = Partial<Record<FourwingsGeolocation, number>>;
+export interface DataviewConfig<Type = DataviewType> {
+    /** Type to define what kind of layer to render, ex: fourwings, context, draw... */
     type?: Type;
+    /** Used in buffers report to store the geometry, normally a FeatureCollection */
+    data?: any;
+    /** Used in activity or detections layers to define which layers are active in all the options available */
+    datasets?: string[];
     color?: string;
+    colorRamp?: string;
     colorCyclingType?: ColorCyclingType;
+    /** Fourwings modes: 'compare' | 'bivariate' */
+    comparisonMode?: string;
+    /** FourwingsVisualizationMode = 'heatmap' | 'heatmap-high-res' | 'positions' */
+    visualizationMode?: string;
+    /** Property used when a layer can use white as last step in its color ramp */
+    colorRampWhiteEnd?: boolean;
+    /** Property used when a track layer can use white as the color for its vessel events */
+    singleTrack?: boolean;
+    auxiliarLayerActive?: boolean;
+    debug?: boolean;
     visible?: boolean;
-    filters?: Record<string, any>;
+    /** Used to limit the available FourwingsIntervals */
+    interval?: string;
+    intervals?: string[];
+    /** Basemap for deck layers, see libs/deck-layers/src/layers/basemap/BasemapLayer.ts */
+    basemap?: string;
+    /** LayerGroup for deck layers z-index, see libs/deck-layers/src/utils/sort.ts */
+    group?: string;
+    /** String encoded for url from filters Record */
+    filter?: string;
+    /** Record with id filter as key and filters as values */
+    filters?: DataviewDatasetFilter;
+    'vessel-groups'?: string[];
     filterOperators?: Record<string, FilterOperator>;
+    /** Min value for filters in environmental layers to perform frontend data filtering */
+    minVisibleValue?: number;
+    /** Max value for filters in environmental layers to perform frontend data filtering */
+    maxVisibleValue?: number;
+    /** Fourwings dataset without temporal data */
+    static?: boolean;
+    /** Initial breaks for fourwings datasets */
+    breaks?: number[];
+    locale?: Locale;
     dynamicBreaks?: boolean;
     maxZoom?: number;
+    clusterMaxZoomLevels?: ClusterMaxZoomLevelConfig;
+    maxZoomCluster?: number;
     layers?: DataviewContexLayerConfig[];
+    /** Legacy for duplicated events in the API */
+    duplicatedEventsWorkaround?: boolean;
+    /** Stats calculated for environmental layers reports */
+    stats?: {
+        max: number;
+        min: number;
+        mean: number;
+    };
+    /** Used to store the vessel name */
+    name?: string;
+    event?: string | {
+        activeIconsSize?: number;
+        activeStrokeColor?: string;
+        strokeColor?: string;
+        iconsPrefix?: string;
+        inactiveIconsSize?: number;
+    };
+    pointsToSegmentsSwitchLevel?: number;
+    showIcons?: boolean;
+    showAuthorizationStatus?: boolean;
+    aggregationOperation?: string;
+    breaksMultiplier?: number;
     /** Vessel datasets */
@@ -26,4 +127,8 @@ info?: string;
     events?: string[];
-    /*****************/
-    [key: string]: any;
+    relatedVesselIds?: string[];
+    pickable?: boolean;
+    trackThinningZoomConfig?: Record<number, string>;
+    /** Fourwings layers merged, needed for Activity or Detections */
+    sublayers?: DataviewSublayerConfig[];
+    includeWithoutEndDate?: boolean;
 }
@@ -34,2 +139,4 @@ export interface DataviewDatasetConfigParam {
 }
+export type DataviewDatasetFilter = Record<string, any>;
+export type DatasetsMigration = Record<string, string>;
 export interface DataviewDatasetConfig {
@@ -40,2 +147,3 @@ datasetId: string;
     query?: DataviewDatasetConfigParam[];
+    filters?: DataviewDatasetFilter;
     metadata?: Record<string, any>;
@@ -81,3 +189,6 @@ }
     User = "user",
-    Vessels = "vessels"
+    Vessels = "vessels",
+    VesselGroups = "vesselGroups",
+    Workspaces = "workspaces",
+    Buffer = "buffer"
 }
@@ -95,2 +206,3 @@ export interface Dataview<Type = any, Category = DataviewCategory> {
     datasets?: Dataset[];
+    vesselGroup?: VesselGroup;
     infoConfig?: DataviewInfoConfig;
@@ -106,2 +218,3 @@ eventsConfig?: DataviewEventsConfig;
     datasetsConfig?: DataviewDatasetConfig[];
+    datasetsConfigMigration?: DatasetsMigration;
 }

src/events.d.ts

@@ -10,3 +10,5 @@ import { JSX } from 'react';
     mpa = "mpa",
-    fao = "fao"
+    fao = "fao",
+    majorFao = "majorFao",
+    highSeas = "highSeas"
 }
@@ -18,2 +20,4 @@ export interface Regions {
     [RegionType.fao]?: string[];
+    [RegionType.majorFao]?: string[];
+    [RegionType.highSeas]?: string[];
 }
@@ -30,3 +34,3 @@ export interface GapPosition extends PointCoordinate {
 }
-export type EventType = 'encounter' | 'fishing' | 'gap' | 'port_visit' | 'loitering';
+export type EventType = `${EventTypes}`;
 export interface EventNextPort {
@@ -174,2 +178,3 @@ id: string;
     vessel: Vessel;
+    coordinates?: [number, number];
 }
@@ -176,0 +181,0 @@ export interface ApiEvents<T = ApiEvent> {

src/identity-vessel.d.ts

@@ -58,2 +58,23 @@ export type VesselType = 'SEISMIC_VESSEL' | 'CARRIER' | 'CARGO' | 'PASSENGER' | 'FISHING' | 'OTHER_NON_FISHING' | 'BUNKER_OR_TANKER' | 'SUPPORT' | 'OTHER';
 };
+export type RegistryImage = {
+    url: string;
+    copyright: string;
+};
+export type RegistryExtraFieldValue = {
+    dateFrom: string;
+    dateFromMask: string;
+    dateTo: string;
+    dateToMask: string;
+    value: number;
+};
+export type RegistryExtraFields = {
+    builtYear: RegistryExtraFieldValue;
+    depthM: RegistryExtraFieldValue;
+    hasArchiveInfo: boolean;
+    hasComplianceInfo: boolean;
+    iuuStatus: string | null;
+    operator: string | null;
+    registrySource: string;
+    images: RegistryImage[];
+};
 export type VesselRegistryInfo = VesselInfo & {
@@ -67,2 +88,3 @@ geartypes: GearType[] | RegistryLoginMessage;
     vesselInfoReference: string;
+    extraFields?: RegistryExtraFields[];
 };
@@ -80,2 +102,6 @@ export type VesselRegistryProperty = {
 };
+export type VesselRegistryOperator = Omit<RegistryExtraFieldValue, 'value'> & {
+    name: string;
+    flag: string;
+};
 export type VesselRegistryAuthorization = VesselRegistryProperty;
@@ -115,3 +141,4 @@ export type VesselIdentitySearchMatch = {
     registryOwners?: VesselRegistryOwner[];
+    operator?: VesselRegistryOperator;
     selfReportedInfo: SelfReportedInfo[];
 }

src/index.d.ts

@@ -6,14 +6,18 @@ export * from './datasets';
 export * from './events';
+export * from './fourwings';
 export * from './geometries';
 export * from './i18n';
+export * from './identity-vessel';
 export * from './pagination';
-export * from './vessel-report';
 export * from './reports';
 export * from './resources';
+export * from './tracks';
 export * from './stats';
 export * from './user-applications';
 export * from './user';
+export * from './vessel-insights';
+export * from './vessel-groups-insights';
+export * from './vessel-report';
 export * from './vessel';
-export * from './identity-vessel';
 export * from './vesselGroups';
 export * from './workspaces';

src/reports.d.ts

@@ -9,3 +9,3 @@ import { OwnerType, Workspace } from './workspaces';
     datasetId: string;
-    workspace: Workspace;
+    workspace: Omit<Workspace, 'viewAccess' | 'editAccess'>;
     createdAt: string;
@@ -12,0 +12,0 @@ ownerId: number;

src/resources.d.ts

@@ -5,23 +5,2 @@ import { Dataset } from './datasets';
 export type ResourceRequestType = 'json' | 'formData';
-export declare enum Field {
-    lonlat = "lonlat",
-    longitude = "longitude",
-    latitude = "latitude",
-    timestamp = "timestamp",
-    fishing = "fishing",
-    speed = "speed",
-    course = "course",
-    night = "night",
-    distanceFromPort = "distance_from_port",
-    elevation = "elevation",
-    id = "id",
-    color = "color"
-}
-export type PointProperties = Record<string, any>;
-export type Point = Partial<Record<Field, number | null>> & {
-    properties?: PointProperties;
-    coordinateProperties?: PointProperties;
-};
-export type Segment = Point[];
-export type TrackResourceData = Segment[];
 export declare enum ResourceStatus {
@@ -34,3 +13,3 @@ Idle = "idle",
 }
-export interface Resource<T = unknown> {
+export interface Resource<T = any> {
     key?: string;
@@ -37,0 +16,0 @@ dataviewId: number | string;

src/vessel-report.d.ts

@@ -10,2 +10,3 @@ export type ReportVessel = {
     hours: number;
+    detections?: number;
     imo: string;
@@ -12,0 +13,0 @@ lastTransmissionDate: string;

src/vesselGroups.d.ts

 export interface VesselGroupVessel {
     dataset: string;
     vesselId: string;
+    relationId: string;
     flag?: string;
@@ -15,3 +16,4 @@ vesselType?: string;
     createdAt?: string;
+    updatedAt?: string;
 }
-export type VesselGroupUpsert = Omit<VesselGroup, 'id' | 'public' | 'ownerId' | 'ownerType'>;
+export type VesselGroupUpsert = Partial<Pick<VesselGroup, 'id' | 'name' | 'vessels' | 'public'>>;

src/workspaces.d.ts

 import { DataviewInstance } from './dataviews';
 export type ApiAppName = 'fishing-map' | 'marine-manager';
+export declare const WORKSPACE_PUBLIC_ACCESS = "public";
+export declare const WORKSPACE_PASSWORD_ACCESS = "password";
+export declare const WORKSPACE_PRIVATE_ACCESS = "private";
+export type WorkspaceViewAccessType = typeof WORKSPACE_PUBLIC_ACCESS | typeof WORKSPACE_PASSWORD_ACCESS | typeof WORKSPACE_PRIVATE_ACCESS;
+export type WorkspaceEditAccessType = typeof WORKSPACE_PASSWORD_ACCESS | typeof WORKSPACE_PRIVATE_ACCESS;
 export interface WorkspaceViewport {
@@ -15,2 +20,4 @@ zoom: number;
     category?: Category;
+    viewAccess: WorkspaceViewAccessType;
+    editAccess: WorkspaceEditAccessType;
     public?: boolean;
@@ -26,2 +33,2 @@ viewport: WorkspaceViewport;
 }
-export type WorkspaceUpsert<State = unknown, Category = string> = Omit<Workspace<State, Category>, 'id' | 'ownerId' | 'createdAt' | 'ownerType'>;
+export type WorkspaceUpsert<State = unknown, Category = string> = Omit<Workspace<State, Category>, 'id' | 'ownerId' | 'createdAt' | 'ownerType' | 'viewAccess' | 'editAccess'>;

No alert changes

Improved metrics

Total package byte prevSize

55593

increased by31.47%

Number of package files

28

increased by21.74%

Lines of code

1625

increased by26.85%

No dependency changes