@globalfishingwatch/api-types - npm Package Compare versions

Comparing version 2.9.0 to 2.10.0

CHANGELOG.md

 # @globalfishingwatch/api-types
 
+## 2.10.0
+
+### Minor Changes
+
+- 66e35ff4: Dataset and Dataviews category types
+
 ## 2.9.0
@@ -4,0 +10,0 @@

dist/datasets.d.ts

@@ -69,2 +69,6 @@ export interface UploadResponse {
 };
+export declare enum DatasetCategory {
+    Context = "context",
+    Environment = "environment"
+}
 export interface Dataset {
@@ -77,3 +81,3 @@ id: string;
     schema?: Record<string, DatasetSchema>;
-    category?: string;
+    category?: DatasetCategory;
     subcategory?: string;
@@ -80,0 +84,0 @@ source?: string;

dist/dataviews.d.ts

 import { ApiAppName, Dataset } from '.';
-export interface DataviewConfig<T = any> {
-    type?: T;
+export interface DataviewConfig<Type = any> {
+    type?: Type;
     color?: string;
@@ -33,3 +33,7 @@ visible?: boolean;
 }
-export interface Dataview<T = any> {
+export declare enum DataviewCategory {
+    Context = "context",
+    Environment = "environment"
+}
+export interface Dataview<Type = any, Category = DataviewCategory> {
     id: number;
@@ -39,5 +43,6 @@ name: string;
     description: string;
+    category?: Category;
     createdAt?: string;
     updatedAt?: string;
-    config: DataviewConfig<T>;
+    config: DataviewConfig<Type>;
     datasets?: Dataset[];
@@ -47,8 +52,8 @@ infoConfig?: DataviewInfoConfig;
 }
-export interface DataviewInstance<T = any> extends Partial<Omit<Dataview<T>, 'id' | 'config'>> {
+export interface DataviewInstance<Type = any> extends Partial<Omit<Dataview<Type>, 'id' | 'config'>> {
     id: string;
     dataviewId: number;
-    config?: DataviewConfig<T>;
+    config?: DataviewConfig<Type>;
     datasetsConfig?: DataviewDatasetConfig[];
 }
 //# sourceMappingURL=dataviews.d.ts.map

dist/index.js

@@ -1,2 +0,2 @@
-var r,e;!function(r){r.Vessels="carriers-vessels:v1",r.Events="carriers-events:v1",r.Ports="carriers-ports:v1",r.Tracks="carriers-tracks:v1",r.Fourwings="4wings:v1",r.Context="user-context-layer:v1",r.Download="data-download:v1"}(r||(r={})),function(r){r.Done="done",r.Importing="importing",r.Error="error"}(e||(e={}));export{e as DatasetStatus,r as DatasetTypes};
+var n,r,e,t;!function(n){n.Vessels="carriers-vessels:v1",n.Events="carriers-events:v1",n.Ports="carriers-ports:v1",n.Tracks="carriers-tracks:v1",n.Fourwings="4wings:v1",n.Context="user-context-layer:v1",n.Download="data-download:v1"}(n||(n={})),function(n){n.Done="done",n.Importing="importing",n.Error="error"}(r||(r={})),function(n){n.Context="context",n.Environment="environment"}(e||(e={})),function(n){n.Context="context",n.Environment="environment"}(t||(t={}));export{e as DatasetCategory,r as DatasetStatus,n as DatasetTypes,t as DataviewCategory};
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@globalfishingwatch/api-types",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "description": "Typescript definitions for API responses",
@@ -33,3 +33,3 @@ "author": "satellitestudio <[e-mail]>",
   },
-  "gitHead": "792cc5473e87ed36108e0031c45a81d1bf7d5267"
+  "gitHead": "262bf72735a316ad96bcaf9abc696b3344ce8565"
 }

No alert changes

Improved metrics

Total package byte prevSize

18815

increased by4.92%

Lines of code

254

increased by4.1%

No dependency changes