@globalfishingwatch/api-types - npm Package Compare versions

Comparing version 6.6.0 to 8.0.0

index.cjs.js

@@ -7,57 +7,57 @@ 'use strict';
 exports.EndpointId = void 0;
-(function (EndpointId) {
-  EndpointId["ContextTiles"] = "context-tiles";
-  EndpointId["ContextFeature"] = "context-feature";
-  EndpointId["ClusterTiles"] = "events-cluster-tiles";
-  EndpointId["ContextGeojson"] = "temporal-context-geojson";
-  EndpointId["Events"] = "events";
-  EndpointId["EventsDetail"] = "events-detail";
-  EndpointId["FourwingsBreaks"] = "4wings-bins";
-  EndpointId["FourwingsInteraction"] = "4wings-interaction";
-  EndpointId["FourwingsLegend"] = "4wings-legend";
-  EndpointId["FourwingsTiles"] = "4wings-tiles";
-  EndpointId["Tracks"] = "tracks";
-  EndpointId["UserTracks"] = "user-tracks-data";
-  EndpointId["Vessel"] = "vessel";
-  EndpointId["VesselAdvancedSearch"] = "advanced-search-vessels";
-  EndpointId["VesselList"] = "list-vessels";
-  EndpointId["VesselSearch"] = "search-vessels";
+(function(EndpointId) {
+    EndpointId["ContextTiles"] = "context-tiles";
+    EndpointId["ContextFeature"] = "context-feature";
+    EndpointId["ClusterTiles"] = "events-cluster-tiles";
+    EndpointId["ContextGeojson"] = "temporal-context-geojson";
+    EndpointId["Events"] = "events";
+    EndpointId["EventsDetail"] = "events-detail";
+    EndpointId["FourwingsBreaks"] = "4wings-bins";
+    EndpointId["FourwingsInteraction"] = "4wings-interaction";
+    EndpointId["FourwingsLegend"] = "4wings-legend";
+    EndpointId["FourwingsTiles"] = "4wings-tiles";
+    EndpointId["Tracks"] = "tracks";
+    EndpointId["UserTracks"] = "user-tracks-data";
+    EndpointId["Vessel"] = "vessel";
+    EndpointId["VesselAdvancedSearch"] = "advanced-search-vessels";
+    EndpointId["VesselList"] = "list-vessels";
+    EndpointId["VesselSearch"] = "search-vessels";
 })(exports.EndpointId || (exports.EndpointId = {}));
 exports.DatasetTypes = void 0;
-(function (DatasetTypes) {
-  DatasetTypes["Vessels"] = "vessels:v1";
-  DatasetTypes["Events"] = "events:v1";
-  DatasetTypes["Ports"] = "ports:v1";
-  DatasetTypes["Tracks"] = "tracks:v1";
-  DatasetTypes["Fourwings"] = "4wings:v1";
-  DatasetTypes["Context"] = "context-layer:v1";
-  DatasetTypes["UserContext"] = "user-context-layer:v1";
-  DatasetTypes["TemporalContext"] = "temporal-context-layer:v1";
-  DatasetTypes["Download"] = "data-download:v1";
-  DatasetTypes["UserTracks"] = "user-tracks:v1";
+(function(DatasetTypes) {
+    DatasetTypes["Vessels"] = "vessels:v1";
+    DatasetTypes["Events"] = "events:v1";
+    DatasetTypes["Ports"] = "ports:v1";
+    DatasetTypes["Tracks"] = "tracks:v1";
+    DatasetTypes["Fourwings"] = "4wings:v1";
+    DatasetTypes["Context"] = "context-layer:v1";
+    DatasetTypes["UserContext"] = "user-context-layer:v1";
+    DatasetTypes["TemporalContext"] = "temporal-context-layer:v1";
+    DatasetTypes["Download"] = "data-download:v1";
+    DatasetTypes["UserTracks"] = "user-tracks:v1";
 })(exports.DatasetTypes || (exports.DatasetTypes = {}));
 exports.DatasetStatus = void 0;
-(function (DatasetStatus) {
-  DatasetStatus["Error"] = "error";
-  DatasetStatus["Done"] = "done";
-  DatasetStatus["Deleted"] = "deleted";
-  DatasetStatus["Importing"] = "importing";
+(function(DatasetStatus) {
+    DatasetStatus["Error"] = "error";
+    DatasetStatus["Done"] = "done";
+    DatasetStatus["Deleted"] = "deleted";
+    DatasetStatus["Importing"] = "importing";
 })(exports.DatasetStatus || (exports.DatasetStatus = {}));
 exports.DatasetCategory = void 0;
-(function (DatasetCategory) {
-  DatasetCategory["Event"] = "event";
-  DatasetCategory["Detections"] = "detections";
-  DatasetCategory["Context"] = "context";
-  DatasetCategory["Environment"] = "environment";
-  DatasetCategory["Activity"] = "activity";
-  DatasetCategory["Vessel"] = "vessel";
+(function(DatasetCategory) {
+    DatasetCategory["Event"] = "event";
+    DatasetCategory["Detections"] = "detections";
+    DatasetCategory["Context"] = "context";
+    DatasetCategory["Environment"] = "environment";
+    DatasetCategory["Activity"] = "activity";
+    DatasetCategory["Vessel"] = "vessel";
 })(exports.DatasetCategory || (exports.DatasetCategory = {}));
 exports.DatasetSubCategory = void 0;
-(function (DatasetSubCategory) {
-  DatasetSubCategory["Info"] = "info";
-  DatasetSubCategory["Track"] = "track";
-  DatasetSubCategory["Fishing"] = "fishing";
-  DatasetSubCategory["Presence"] = "presence";
-  DatasetSubCategory["Viirs"] = "viirs";
-  DatasetSubCategory["Sar"] = "sar";
+(function(DatasetSubCategory) {
+    DatasetSubCategory["Info"] = "info";
+    DatasetSubCategory["Track"] = "track";
+    DatasetSubCategory["Fishing"] = "fishing";
+    DatasetSubCategory["Presence"] = "presence";
+    DatasetSubCategory["Viirs"] = "viirs";
+    DatasetSubCategory["Sar"] = "sar";
 })(exports.DatasetSubCategory || (exports.DatasetSubCategory = {}));
@@ -68,100 +68,101 @@
 exports.DataviewCategory = void 0;
-(function (DataviewCategory) {
-  DataviewCategory["Context"] = "context";
-  DataviewCategory["Events"] = "events";
-  DataviewCategory["Environment"] = "environment";
-  DataviewCategory["Activity"] = "activity";
-  DataviewCategory["Detections"] = "detections";
-  DataviewCategory["Vessels"] = "vessels";
-  DataviewCategory["Comparison"] = "comparison";
+(function(DataviewCategory) {
+    DataviewCategory["Activity"] = "activity";
+    DataviewCategory["Comparison"] = "comparison";
+    DataviewCategory["Context"] = "context";
+    DataviewCategory["Detections"] = "detections";
+    DataviewCategory["Environment"] = "environment";
+    DataviewCategory["Events"] = "events";
+    DataviewCategory["User"] = "user";
+    DataviewCategory["Vessels"] = "vessels";
 })(exports.DataviewCategory || (exports.DataviewCategory = {}));
 
 exports.DownloadActivityStatus = void 0;
-(function (DownloadActivityStatus) {
-  DownloadActivityStatus["NotStarted"] = "not-started";
-  DownloadActivityStatus["Generating"] = "generating";
-  DownloadActivityStatus["Done"] = "done";
-  DownloadActivityStatus["Failed"] = "failed";
+(function(DownloadActivityStatus) {
+    DownloadActivityStatus["NotStarted"] = "not-started";
+    DownloadActivityStatus["Generating"] = "generating";
+    DownloadActivityStatus["Done"] = "done";
+    DownloadActivityStatus["Failed"] = "failed";
 })(exports.DownloadActivityStatus || (exports.DownloadActivityStatus = {}));
 
 exports.RegionType = void 0;
-(function (RegionType) {
-  RegionType["eez"] = "eez";
-  RegionType["rfmo"] = "rfmo";
-  RegionType["mpa"] = "mpa";
-  RegionType["fao"] = "fao";
+(function(RegionType) {
+    RegionType["eez"] = "eez";
+    RegionType["rfmo"] = "rfmo";
+    RegionType["mpa"] = "mpa";
+    RegionType["fao"] = "fao";
 })(exports.RegionType || (exports.RegionType = {}));
 exports.EventTypes = void 0;
-(function (EventTypes) {
-  EventTypes["Encounter"] = "encounter";
-  EventTypes["Fishing"] = "fishing";
-  EventTypes["Gap"] = "gap";
-  EventTypes["Port"] = "port_visit";
-  EventTypes["Loitering"] = "loitering";
+(function(EventTypes) {
+    EventTypes["Encounter"] = "encounter";
+    EventTypes["Fishing"] = "fishing";
+    EventTypes["Gap"] = "gap";
+    EventTypes["Port"] = "port_visit";
+    EventTypes["Loitering"] = "loitering";
 })(exports.EventTypes || (exports.EventTypes = {}));
 exports.EventVesselTypeEnum = void 0;
-(function (EventVesselTypeEnum) {
-  EventVesselTypeEnum["Carrier"] = "carrier";
-  EventVesselTypeEnum["Fishing"] = "fishing";
+(function(EventVesselTypeEnum) {
+    EventVesselTypeEnum["Carrier"] = "carrier";
+    EventVesselTypeEnum["Fishing"] = "fishing";
 })(exports.EventVesselTypeEnum || (exports.EventVesselTypeEnum = {}));
 exports.AuthorizationOptions = void 0;
-(function (AuthorizationOptions) {
-  AuthorizationOptions["Authorized"] = "authorized";
-  AuthorizationOptions["Partially"] = "partially";
-  AuthorizationOptions["Unmatched"] = "unmatched";
+(function(AuthorizationOptions) {
+    AuthorizationOptions["Authorized"] = "authorized";
+    AuthorizationOptions["Partially"] = "partially";
+    AuthorizationOptions["Unmatched"] = "unmatched";
 })(exports.AuthorizationOptions || (exports.AuthorizationOptions = {}));
 
 exports.Locale = void 0;
-(function (Locale) {
-  Locale["en"] = "en";
-  Locale["es"] = "es";
-  Locale["fr"] = "fr";
-  Locale["id"] = "id";
-  Locale["pt"] = "pt";
+(function(Locale) {
+    Locale["en"] = "en";
+    Locale["es"] = "es";
+    Locale["fr"] = "fr";
+    Locale["id"] = "id";
+    Locale["pt"] = "pt";
 })(exports.Locale || (exports.Locale = {}));
 
 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";
+(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";
+(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 tuple = (...args)=>args;
 const USER_APPLICATION_INTENDED_USES = tuple('commercial', 'non-commercial');
 
 exports.VesselIdentitySourceEnum = void 0;
-(function (VesselIdentitySourceEnum) {
-  VesselIdentitySourceEnum["SelfReported"] = "selfReportedInfo";
-  VesselIdentitySourceEnum["Registry"] = "registryInfo";
+(function(VesselIdentitySourceEnum) {
+    VesselIdentitySourceEnum["SelfReported"] = "selfReportedInfo";
+    VesselIdentitySourceEnum["Registry"] = "registryInfo";
 })(exports.VesselIdentitySourceEnum || (exports.VesselIdentitySourceEnum = {}));
 exports.SelfReportedSource = void 0;
-(function (SelfReportedSource) {
-  SelfReportedSource["Ais"] = "AIS";
-  SelfReportedSource["Belize"] = "VMS Belize";
-  SelfReportedSource["Brazil"] = "VMS Brazil Onyxsat";
-  SelfReportedSource["Chile"] = "VMS Chile";
-  SelfReportedSource["CostaRica"] = "VMS Costa Rica";
-  SelfReportedSource["Ecuador"] = "VMS Ecuador";
-  SelfReportedSource["Indonesia"] = "VMS Indonesia";
-  SelfReportedSource["Norway"] = "VMS Norway";
-  SelfReportedSource["Papua"] = "VMS PNG";
-  SelfReportedSource["Peru"] = "VMS Peru";
+(function(SelfReportedSource) {
+    SelfReportedSource["Ais"] = "AIS";
+    SelfReportedSource["Belize"] = "VMS Belize";
+    SelfReportedSource["Brazil"] = "VMS Brazil Onyxsat";
+    SelfReportedSource["Chile"] = "VMS Chile";
+    SelfReportedSource["CostaRica"] = "VMS Costa Rica";
+    SelfReportedSource["Ecuador"] = "VMS Ecuador";
+    SelfReportedSource["Indonesia"] = "VMS Indonesia";
+    SelfReportedSource["Norway"] = "VMS Norway";
+    SelfReportedSource["Papua"] = "VMS PNG";
+    SelfReportedSource["Peru"] = "VMS Peru";
 })(exports.SelfReportedSource || (exports.SelfReportedSource = {}));
@@ -168,0 +169,0 @@ const API_LOGIN_REQUIRED = 'BEARER_TOKEN_REQUIRED';

package.json

 {
   "name": "@globalfishingwatch/api-types",
-  "version": "6.6.0",
+  "version": "8.0.0",
   "description": "Typescript definitions for API responses",
   "author": "satellitestudio <[e-mail]>",
   "homepage": "https://github.com/GlobalFishingWatch/frontend#readme",
-  "license": "ISC",
   "main": "./index.cjs.js",
-  "typings": "./src/index.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/GlobalFishingWatch/frontend.git"
-  },
-  "peerDependencies": {
-    "geojson": "0.5.0"
-  },
-  "type": "commonjs"
+  "module": "./index.esm.js",
+  "dependencies": {
+    "react": "18.x",
+    "geojson": "0.x"
+  }
 }

src/datasets.d.ts

@@ -65,2 +65,6 @@ import { EventTypes } from './events';
 export type DatasetGeometryType = 'polygons' | 'tracks' | 'points' | 'draw';
+export type DatasetGeometryToGeoJSONGeometry = {
+    [Property in DatasetGeometryType]: string;
+};
+export type TimeFilterType = 'date' | 'dateRange';
 export interface DatasetDocumentation {
@@ -73,3 +77,28 @@ type?: string;
 }
+export type DatasetConfigurationSourceFormat = 'GeoJSON' | 'Shapefile' | 'CSV' | 'KML';
+export interface DatasetConfigurationUI {
+    latitude?: string;
+    longitude?: string;
+    timestamp?: string;
+    sourceFormat?: DatasetConfigurationSourceFormat;
+    pointName?: string;
+    pointSize?: string;
+    maxPointSize?: number;
+    minPointSize?: number;
+    startTime?: string | number;
+    endTime?: string | number;
+    timeFilterType?: TimeFilterType;
+    polygonColor?: string;
+    /**
+     * Feature properties array to inform the API
+     * which data is to be be added to tiles features
+     */
+    valueProperties?: string[];
+    geometryType?: DatasetGeometryType;
+    lineId?: string | number;
+    segmentId?: string | number;
+}
+export type DatasetConfigurationInterval = 'YEAR' | 'MONTH' | 'DAY' | 'HOUR';
 export interface DatasetConfiguration {
+    id?: string;
     index?: string;
@@ -86,5 +115,14 @@ filePath?: string;
     idProperty?: string;
+    /**
+     * Feature properties array to inform the API
+     * which data is to be be added to tiles features
+     */
     valueProperties?: string[];
+    propertyToInclude?: string;
+    min?: number;
+    max?: number;
+    intervals?: DatasetConfigurationInterval[];
+    disableInteraction?: boolean;
     apiSupportedVersions?: ('v1' | 'v2' | 'v3')[];
-    [key: string]: unknown;
+    configurationUI?: DatasetConfigurationUI;
 }
@@ -107,10 +145,11 @@ export interface EnviromentalDatasetConfiguration extends DatasetConfiguration {
 };
-export type DatasetSchemaType = 'range' | 'number' | 'string' | 'boolean' | 'array';
+export type DatasetSchemaType = 'range' | 'number' | 'string' | 'boolean' | 'array' | 'coordinate' | 'timestamp';
+export type DatasetSchemaItemEnum = (string | number | boolean)[];
 export type DatasetSchemaItem = {
     type: DatasetSchemaType;
-    maxLength: number;
-    minLength: number;
-    enum: string[];
-    min: number;
-    max: number;
+    enum?: DatasetSchemaItemEnum;
+    maxLength?: number;
+    minLength?: number;
+    min?: number;
+    max?: number;
     stats?: boolean;
@@ -117,0 +156,0 @@ unit?: string;

src/dataviews.d.ts

@@ -70,9 +70,10 @@ import { ApiAppName } from './workspaces';
 export declare enum DataviewCategory {
+    Activity = "activity",
+    Comparison = "comparison",
     Context = "context",
+    Detections = "detections",
+    Environment = "environment",
     Events = "events",
-    Environment = "environment",
-    Activity = "activity",
-    Detections = "detections",
-    Vessels = "vessels",
-    Comparison = "comparison"
+    User = "user",
+    Vessels = "vessels"
 }
@@ -79,0 +80,0 @@ export interface Dataview<Type = any, Category = DataviewCategory> {

src/events.d.ts

@@ -1,2 +0,2 @@
-/// <reference types="react" />
+import { JSX } from 'react';
 export interface PointCoordinate {
@@ -3,0 +3,0 @@ lat: number;

src/resources.d.ts

@@ -19,3 +19,7 @@ import { Dataset } from './datasets';
 }
-export type Point = Partial<Record<Field, number | null>>;
+export type PointProperties = Record<string, any>;
+export type Point = Partial<Record<Field, number | null>> & {
+    properties?: PointProperties;
+    coordinateProperties?: PointProperties;
+};
 export type Segment = Point[];
@@ -22,0 +26,0 @@ export type TrackResourceData = Segment[];

New alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

42287

increased by24%

Lines of code

1281

increased by18.83%

Worsened metrics

Dependency count

2

increased by100%

Number of medium quality alerts

2

increased by100%

Number of lines in readme file

0

decreased by-100%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedgeojson@0.x

• + Addedreact@18.x

• + Addedjs-tokens@4.0.0(transitive)

• + Addedloose-envify@1.4.0(transitive)

• + Addedreact@18.3.1(transitive)