@internetdata/internetdata 1.4.0 → 2.0.0

package/dist/generated/index.d.ts

@@ -1,2 +1,2 @@
 export { databaseChecksum, databaseChecksumV2, databaseDownload, databaseMetadata, databaseMetadataV2, downloadDatabaseV2, listDatabases, listDownloads, type Options } from './sdk.gen.js';
-export type { ClientOptions, Database, DatabaseChecksumData, DatabaseChecksumError, DatabaseChecksumErrors, DatabaseChecksumResponse, DatabaseChecksumResponses, DatabaseChecksumV2Data, DatabaseChecksumV2Error, DatabaseChecksumV2Errors, DatabaseChecksumV2Response, DatabaseChecksumV2Responses, DatabaseDownloadData, DatabaseDownloadError, DatabaseDownloadErrors, DatabaseDownloadResponse, DatabaseDownloadResponses, DatabaseMetadata, DatabaseMetadataColumn, DatabaseMetadataData, DatabaseMetadataError, DatabaseMetadataErrors, DatabaseMetadataResponse, DatabaseMetadataResponses, DatabaseMetadataV2Data, DatabaseMetadataV2Error, DatabaseMetadataV2Errors, DatabaseMetadataV2Response, DatabaseMetadataV2Responses, DatabaseVersion, DbChecksums, DbChecksumSuccessResponse, DbFormat, DbId, DbInvalidApiKeyError, DbInvalidFormatError, DbInvalidIdError, DbMetadata, DbMetadataSuccessResponse, DbNotFoundError, DbUnauthorizedIdError, Download, DownloadDatabaseV2Data, DownloadDatabaseV2Error, DownloadDatabaseV2Errors, Error, ListDatabasesData, ListDatabasesError, ListDatabasesErrors, ListDatabasesResponse, ListDatabasesResponses, ListDownloadsData, ListDownloadsError, ListDownloadsErrors, ListDownloadsResponse, ListDownloadsResponses } from './types.gen.js';
+export type { ClientOptions, Database, DatabaseChecksumData, DatabaseChecksumError, DatabaseChecksumErrors, DatabaseChecksumResponse, DatabaseChecksumResponses, DatabaseChecksumV2Data, DatabaseChecksumV2Error, DatabaseChecksumV2Errors, DatabaseChecksumV2Response, DatabaseChecksumV2Responses, DatabaseDownloadData, DatabaseDownloadError, DatabaseDownloadErrors, DatabaseDownloadResponse, DatabaseDownloadResponses, DatabaseFormat, DatabaseMetadata, DatabaseMetadataColumn, DatabaseMetadataData, DatabaseMetadataError, DatabaseMetadataErrors, DatabaseMetadataResponse, DatabaseMetadataResponses, DatabaseMetadataV2Data, DatabaseMetadataV2Error, DatabaseMetadataV2Errors, DatabaseMetadataV2Response, DatabaseMetadataV2Responses, DatabaseVersion, DbChecksums, DbChecksumSuccessResponse, DbFormat, DbId, DbInvalidApiKeyError, DbInvalidFormatError, DbInvalidIdError, DbMetadata, DbMetadataSuccessResponse, DbNotFoundError, DbUnauthorizedIdError, Download, DownloadDatabaseV2Data, DownloadDatabaseV2Error, DownloadDatabaseV2Errors, Error, LicenseType, ListDatabasesData, ListDatabasesError, ListDatabasesErrors, ListDatabasesResponse, ListDatabasesResponses, ListDownloadsData, ListDownloadsError, ListDownloadsErrors, ListDownloadsResponse, ListDownloadsResponses, Standing } from './types.gen.js';

package/dist/generated/types.gen.d.ts

@@ -9,6 +9,23 @@ export type Error = {
      */
     rc: string;
 };
+/**
+ * A file format a database version is published in.
+ */
+export type DatabaseFormat = 'csvgz' | 'mmdb';
+/**
+ * Where your licence for a database family stands today. `licensed` is a
+ * live grant, `expired` one whose term has ended, and `unlicensed` a
+ * database published but never bought.
+ *
+ */
+export type Standing = 'licensed' | 'expired' | 'unlicensed';
+/**
+ * What your licence permits you to do with the data. Null when there is
+ * no licence, which is every family with standing `unlicensed`.
+ *
+ */
+export type LicenseType = 'evaluation' | 'standard' | 'redistribute' | null;
 /**
  * One database FAMILY, with your organization's licence beside it. A
  * licence covers the family, while a download names a specific version,
@@ -25,18 +42,8 @@ export type Database = {
      * One line on what the newest version contains.
      */
     summary: string;
-    /**
-     * `licensed` is a live grant, `expired` one whose term has ended, and
-     * `unlicensed` a database published but never bought.
-     *
-     */
-    standing: 'licensed' | 'expired' | 'unlicensed';
-    /**
-     * What your licence permits you to do with the data. Null when there
-     * is no licence.
-     *
-     */
-    license_type: 'evaluation' | 'standard' | 'redistribute' | null;
+    standing: Standing;
+    license_type: LicenseType;
     starts: string | null;
     /**
      * A hard stop. Null when the licence has no end date, which is the normal case for a rolling agreement, and when there is no licence. A rolling licence reports its turnover date in renews_at instead.
@@ -70,7 +77,7 @@ export type DatabaseVersion = {
      * MMDB exists for them.
      *
      */
-    formats: Array<'csvgz' | 'mmdb'>;
+    formats: Array<DatabaseFormat>;
 };
 /**
  * One download ATTEMPT, refusals included.
@@ -209,7 +216,7 @@ export type DbId = string;
 /**
  * Database file format.
  */
-export type DbFormat = 'csvgz' | 'mmdb';
+export type DbFormat = DatabaseFormat;
 export type ListDatabasesData = {
     body?: never;
     path?: never;
@@ -246,7 +253,7 @@ export type DownloadDatabaseV2Data = {
         /**
          * Database file format.
          */
-        format: 'csvgz' | 'mmdb';
+        format: DatabaseFormat;
     };
     url: '/api/v2/database/download';
 };
@@ -341,7 +348,7 @@ export type DatabaseChecksumV2Data = {
         /**
          * Database file format.
          */
-        format: 'csvgz' | 'mmdb';
+        format: DatabaseFormat;
     };
     url: '/api/v2/database/checksum';
 };
@@ -384,7 +391,7 @@ export type DatabaseChecksumV2Responses = {
      */
     200: {
         id: string;
-        format: 'csvgz' | 'mmdb';
+        format: DatabaseFormat;
         checksums: DbChecksums;
     };
 };
@@ -430,7 +437,7 @@ export type DatabaseDownloadData = {
         /**
          * Database file format.
          */
-        format: 'csvgz' | 'mmdb';
+        format: DatabaseFormat;
     };
     url: '/api/v1/database/download';
 };
@@ -473,7 +480,7 @@ export type DatabaseChecksumData = {
         /**
          * Database file format.
          */
-        format: 'csvgz' | 'mmdb';
+        format: DatabaseFormat;
     };
     url: '/api/v1/database/checksum';
 };

package/dist/index.d.ts

@@ -2,5 +2,5 @@ export { InternetData, DatabaseApi, DEFAULT_BASE_URL } from './client.js';
 export type { DownloadDestination, DownloadsOptions, Options } from './client.js';
 export { InternetDataError } from './errors.js';
 export type { ErrorKind } from './errors.js';
-export { DATASET_FORMATS, LICENSE_TYPES, STANDINGS } from './types.js';
-export type { Database, DatabaseMetadata, DatabaseMetadataColumn, DatabaseVersion, DatasetFormat, DbChecksums, Download, LicenseType, Standing, } from './types.js';
+export { DATABASE_FORMATS, DATASET_FORMATS, LICENSE_TYPES, STANDINGS } from './types.js';
+export type { Database, DatabaseFormat, DatabaseMetadata, DatabaseMetadataColumn, DatabaseVersion, DatasetFormat, DbChecksums, Download, LicenseType, Standing, } from './types.js';

package/dist/index.js

@@ -1,4 +1,4 @@
 export { InternetData, DatabaseApi, DEFAULT_BASE_URL } from './client.js';
 export { InternetDataError } from './errors.js';
-export { DATASET_FORMATS, LICENSE_TYPES, STANDINGS } from './types.js';
+export { DATABASE_FORMATS, DATASET_FORMATS, LICENSE_TYPES, STANDINGS } from './types.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC"}

package/dist/types.d.ts

@@ -1,11 +1,13 @@
-import type { Database, DatabaseMetadata, DatabaseMetadataColumn, DatabaseVersion, DbChecksums, Download } from './generated/types.gen.js';
-export type { Database, DatabaseMetadata, DatabaseMetadataColumn, DatabaseVersion, DbChecksums, Download, };
-/** A file format one version of a database is built in. */
-export type DatasetFormat = DatabaseVersion['formats'][number];
-/** Where your organization's licence for a database family stands today. */
-export type Standing = Database['standing'];
-/** What a licence permits you to do with the data. Absent when there is no licence. */
-export type LicenseType = NonNullable<Database['license_type']>;
-export declare const DATASET_FORMATS: readonly DatasetFormat[];
+import type { Database, DatabaseFormat, DatabaseMetadata, DatabaseMetadataColumn, DatabaseVersion, DbChecksums, Download, LicenseType, Standing } from './generated/types.gen.js';
+export type { Database, DatabaseFormat, DatabaseMetadata, DatabaseMetadataColumn, DatabaseVersion, DbChecksums, Download, LicenseType, Standing, };
+/**
+ * @deprecated Use {@link DatabaseFormat}. Kept so existing imports keep
+ * compiling; this brand's Java, .NET and Swift SDKs have always called it
+ * `DatabaseFormat`, and so does every VPNDetection SDK.
+ */
+export type DatasetFormat = DatabaseFormat;
+export declare const DATABASE_FORMATS: readonly DatabaseFormat[];
+/** @deprecated Use {@link DATABASE_FORMATS}. */
+export declare const DATASET_FORMATS: readonly DatabaseFormat[];
 export declare const STANDINGS: readonly Standing[];
-export declare const LICENSE_TYPES: readonly LicenseType[];
+export declare const LICENSE_TYPES: readonly NonNullable<LicenseType>[];

package/dist/types.js

@@ -2,7 +2,9 @@
 // wants to validate or enumerate rather than switch. Each is TYPED by the
 // generated union, so a value the spec does not define will not compile; that a
 // value is MISSING is what the shared conformance corpus pins.
-export const DATASET_FORMATS = ['csvgz', 'mmdb'];
+export const DATABASE_FORMATS = ['csvgz', 'mmdb'];
+/** @deprecated Use {@link DATABASE_FORMATS}. */
+export const DATASET_FORMATS = DATABASE_FORMATS;
 export const STANDINGS = ['licensed', 'expired', 'unlicensed'];
 export const LICENSE_TYPES = [
     'evaluation', 'standard', 'redistribute',

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAiBA,+EAA+E;AAC/E,0EAA0E;AAC1E,gFAAgF;AAChF,+DAA+D;AAC/D,MAAM,CAAC,MAAM,eAAe,GAA6B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3E,MAAM,CAAC,MAAM,SAAS,GAAwB,CAAC,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;AACpF,MAAM,CAAC,MAAM,aAAa,GAA2B;IACjD,YAAY,EAAE,UAAU,EAAE,cAAc;CAC3C,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAiBA,+EAA+E;AAC/E,0EAA0E;AAC1E,gFAAgF;AAChF,+DAA+D;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAA8B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAE7E,gDAAgD;AAChD,MAAM,CAAC,MAAM,eAAe,GAA8B,gBAAgB,CAAC;AAC3E,MAAM,CAAC,MAAM,SAAS,GAAwB,CAAC,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;AACpF,MAAM,CAAC,MAAM,aAAa,GAAwC;IAC9D,YAAY,EAAE,UAAU,EAAE,cAAc;CAC3C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetdata/internetdata",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "Official Node.js client library for the InternetData API. Download, verify and inspect licensed IP database files.",
   "type": "module",
   "license": "MIT",