@internetdata/internetdata 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [<img src="https://s3.internetdata.io/internetdata-public/brand/mark.svg" alt="InternetData" width="24"/>](https://internetdata.io/) InternetData Node.js Client Library
1
+ # [<img src="https://s3.internetdata.io/internetdata-public/brand/mark.svg" alt="InternetData" height="28"/>](https://internetdata.io/) InternetData Node.js Client Library
2
2
 
3
3
  [![npm](https://img.shields.io/npm/v/@internetdata/internetdata.svg)](https://www.npmjs.com/package/@internetdata/internetdata)
4
4
  [![license](https://img.shields.io/npm/l/@internetdata/internetdata.svg)](LICENSE)
@@ -31,8 +31,6 @@ for (const db of await client.database.list()) {
31
31
 
32
32
  `list()` returns one entry per database FAMILY, because a licence is held against the family while a download names a specific version. `standing` is `licensed` if the family is yours today, `expired` if the term has ended, and `unlicensed` if it is published but has never been bought. `versions` carries the ids you pass everywhere else, oldest first, and the formats each one is actually built in.
33
33
 
34
- **This listing is not the same for every key.** A database commissioned for a single customer is absent from the catalog for every other organization, rather than being listed as unlicensed. So the listing is only ever an answer about the key that asked, this library never caches one, and you should not carry an answer from one key over to another or treat it as the published catalog.
35
-
36
34
  ### What is inside a database
37
35
 
38
36
  ```js
@@ -14,19 +14,16 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
14
14
  meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
15
15
  };
16
16
  /**
17
- * Every database your organization may see, and where each one stands
17
+ * List
18
18
  *
19
19
  * The whole published catalog, with your organization's licence beside
20
20
  * each entry, so `standing` says whether a database is yours today
21
21
  * (`licensed`), was (`expired`), or has never been bought (`unlicensed`).
22
22
  *
23
- * Databases commissioned for a single customer are not listed to anyone
24
- * else.
25
- *
26
23
  */
27
24
  export declare const listDatabases: <ThrowOnError extends boolean = false>(options?: Options<ListDatabasesData, ThrowOnError>) => RequestResult<ListDatabasesResponses, ListDatabasesErrors, ThrowOnError>;
28
25
  /**
29
- * Redirect to a time-limited download URL for one database
26
+ * Download
30
27
  *
31
28
  * Answers `302`; the bytes come straight from object storage rather than
32
29
  * through this API. Follow the redirect.
@@ -34,7 +31,7 @@ export declare const listDatabases: <ThrowOnError extends boolean = false>(optio
34
31
  */
35
32
  export declare const downloadDatabaseV2: <ThrowOnError extends boolean = false>(options: Options<DownloadDatabaseV2Data, ThrowOnError>) => RequestResult<unknown, DownloadDatabaseV2Errors, ThrowOnError>;
36
33
  /**
37
- * What is inside one database - schema, sample rows, row count, sizes
34
+ * Metadata
38
35
  *
39
36
  * Poll this to decide whether today's build is worth fetching: it carries
40
37
  * `updated` and `entries` without downloading anything.
@@ -45,11 +42,14 @@ export declare const downloadDatabaseV2: <ThrowOnError extends boolean = false>(
45
42
  */
46
43
  export declare const databaseMetadataV2: <ThrowOnError extends boolean = false>(options: Options<DatabaseMetadataV2Data, ThrowOnError>) => RequestResult<DatabaseMetadataV2Responses, DatabaseMetadataV2Errors, ThrowOnError>;
47
44
  /**
48
- * Checksums for one published file, to verify a download
45
+ * Checksums
46
+ *
47
+ * Checksums for one published file, so a download can be verified after it lands.
48
+ *
49
49
  */
50
50
  export declare const databaseChecksumV2: <ThrowOnError extends boolean = false>(options: Options<DatabaseChecksumV2Data, ThrowOnError>) => RequestResult<DatabaseChecksumV2Responses, DatabaseChecksumV2Errors, ThrowOnError>;
51
51
  /**
52
- * Your organization's recent download attempts, newest first
52
+ * History
53
53
  *
54
54
  * Refusals are listed too: a denial is what answers "it stopped working",
55
55
  * and its absence answers nothing.
@@ -57,7 +57,7 @@ export declare const databaseChecksumV2: <ThrowOnError extends boolean = false>(
57
57
  */
58
58
  export declare const listDownloads: <ThrowOnError extends boolean = false>(options?: Options<ListDownloadsData, ThrowOnError>) => RequestResult<ListDownloadsResponses, ListDownloadsErrors, ThrowOnError>;
59
59
  /**
60
- * Download a database file
60
+ * Download
61
61
  *
62
62
  * Returns the requested database file as a binary download.
63
63
  * The response's `Content-Type` depends on `format`:
@@ -66,7 +66,7 @@ export declare const listDownloads: <ThrowOnError extends boolean = false>(optio
66
66
  */
67
67
  export declare const databaseDownload: <ThrowOnError extends boolean = false>(options: Options<DatabaseDownloadData, ThrowOnError>) => RequestResult<DatabaseDownloadResponses, DatabaseDownloadErrors, ThrowOnError>;
68
68
  /**
69
- * Get checksums for a database file
69
+ * Checksums
70
70
  *
71
71
  * Returns MD5, SHA-1, SHA-256, and SHA-512 checksums for the currently
72
72
  * published version of the requested database.
@@ -74,7 +74,7 @@ export declare const databaseDownload: <ThrowOnError extends boolean = false>(op
74
74
  */
75
75
  export declare const databaseChecksum: <ThrowOnError extends boolean = false>(options: Options<DatabaseChecksumData, ThrowOnError>) => RequestResult<DatabaseChecksumResponses, DatabaseChecksumErrors, ThrowOnError>;
76
76
  /**
77
- * Get metadata for a database
77
+ * Metadata
78
78
  *
79
79
  * Returns publish freshness information for the currently published version
80
80
  * of the requested database: when it was last updated, how many entries
@@ -1,35 +1,50 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
  import { client } from './client.gen.js';
3
3
  /**
4
- * Every database your organization may see, and where each one stands
4
+ * List
5
5
  *
6
6
  * The whole published catalog, with your organization's licence beside
7
7
  * each entry, so `standing` says whether a database is yours today
8
8
  * (`licensed`), was (`expired`), or has never been bought (`unlicensed`).
9
9
  *
10
- * Databases commissioned for a single customer are not listed to anyone
11
- * else.
12
- *
13
10
  */
14
11
  export const listDatabases = (options) => (options?.client ?? client).get({
15
- security: [{ scheme: 'bearer', type: 'http' }],
12
+ security: [
13
+ {
14
+ key: 'ApiKeyQueryAuth',
15
+ in: 'query',
16
+ name: 'apikey',
17
+ type: 'apiKey'
18
+ },
19
+ { name: 'X-Api-Key', type: 'apiKey' },
20
+ { scheme: 'bearer', type: 'http' }
21
+ ],
16
22
  url: '/api/v2/database/list',
17
23
  ...options
18
24
  });
19
25
  /**
20
- * Redirect to a time-limited download URL for one database
26
+ * Download
21
27
  *
22
28
  * Answers `302`; the bytes come straight from object storage rather than
23
29
  * through this API. Follow the redirect.
24
30
  *
25
31
  */
26
32
  export const downloadDatabaseV2 = (options) => (options.client ?? client).get({
27
- security: [{ scheme: 'bearer', type: 'http' }],
33
+ security: [
34
+ {
35
+ key: 'ApiKeyQueryAuth',
36
+ in: 'query',
37
+ name: 'apikey',
38
+ type: 'apiKey'
39
+ },
40
+ { name: 'X-Api-Key', type: 'apiKey' },
41
+ { scheme: 'bearer', type: 'http' }
42
+ ],
28
43
  url: '/api/v2/database/download',
29
44
  ...options
30
45
  });
31
46
  /**
32
- * What is inside one database - schema, sample rows, row count, sizes
47
+ * Metadata
33
48
  *
34
49
  * Poll this to decide whether today's build is worth fetching: it carries
35
50
  * `updated` and `entries` without downloading anything.
@@ -39,32 +54,62 @@ export const downloadDatabaseV2 = (options) => (options.client ?? client).get({
39
54
  *
40
55
  */
41
56
  export const databaseMetadataV2 = (options) => (options.client ?? client).get({
42
- security: [{ scheme: 'bearer', type: 'http' }],
57
+ security: [
58
+ {
59
+ key: 'ApiKeyQueryAuth',
60
+ in: 'query',
61
+ name: 'apikey',
62
+ type: 'apiKey'
63
+ },
64
+ { name: 'X-Api-Key', type: 'apiKey' },
65
+ { scheme: 'bearer', type: 'http' }
66
+ ],
43
67
  url: '/api/v2/database/metadata',
44
68
  ...options
45
69
  });
46
70
  /**
47
- * Checksums for one published file, to verify a download
71
+ * Checksums
72
+ *
73
+ * Checksums for one published file, so a download can be verified after it lands.
74
+ *
48
75
  */
49
76
  export const databaseChecksumV2 = (options) => (options.client ?? client).get({
50
- security: [{ scheme: 'bearer', type: 'http' }],
77
+ security: [
78
+ {
79
+ key: 'ApiKeyQueryAuth',
80
+ in: 'query',
81
+ name: 'apikey',
82
+ type: 'apiKey'
83
+ },
84
+ { name: 'X-Api-Key', type: 'apiKey' },
85
+ { scheme: 'bearer', type: 'http' }
86
+ ],
51
87
  url: '/api/v2/database/checksum',
52
88
  ...options
53
89
  });
54
90
  /**
55
- * Your organization's recent download attempts, newest first
91
+ * History
56
92
  *
57
93
  * Refusals are listed too: a denial is what answers "it stopped working",
58
94
  * and its absence answers nothing.
59
95
  *
60
96
  */
61
97
  export const listDownloads = (options) => (options?.client ?? client).get({
62
- security: [{ scheme: 'bearer', type: 'http' }],
98
+ security: [
99
+ {
100
+ key: 'ApiKeyQueryAuth',
101
+ in: 'query',
102
+ name: 'apikey',
103
+ type: 'apiKey'
104
+ },
105
+ { name: 'X-Api-Key', type: 'apiKey' },
106
+ { scheme: 'bearer', type: 'http' }
107
+ ],
63
108
  url: '/api/v2/database/downloads',
64
109
  ...options
65
110
  });
66
111
  /**
67
- * Download a database file
112
+ * Download
68
113
  *
69
114
  * Returns the requested database file as a binary download.
70
115
  * The response's `Content-Type` depends on `format`:
@@ -73,6 +118,7 @@ export const listDownloads = (options) => (options?.client ?? client).get({
73
118
  */
74
119
  export const databaseDownload = (options) => (options.client ?? client).get({
75
120
  security: [{
121
+ key: 'ApiKeyAuth',
76
122
  in: 'query',
77
123
  name: 'apikey',
78
124
  type: 'apiKey'
@@ -81,7 +127,7 @@ export const databaseDownload = (options) => (options.client ?? client).get({
81
127
  ...options
82
128
  });
83
129
  /**
84
- * Get checksums for a database file
130
+ * Checksums
85
131
  *
86
132
  * Returns MD5, SHA-1, SHA-256, and SHA-512 checksums for the currently
87
133
  * published version of the requested database.
@@ -89,6 +135,7 @@ export const databaseDownload = (options) => (options.client ?? client).get({
89
135
  */
90
136
  export const databaseChecksum = (options) => (options.client ?? client).get({
91
137
  security: [{
138
+ key: 'ApiKeyAuth',
92
139
  in: 'query',
93
140
  name: 'apikey',
94
141
  type: 'apiKey'
@@ -97,7 +144,7 @@ export const databaseChecksum = (options) => (options.client ?? client).get({
97
144
  ...options
98
145
  });
99
146
  /**
100
- * Get metadata for a database
147
+ * Metadata
101
148
  *
102
149
  * Returns publish freshness information for the currently published version
103
150
  * of the requested database: when it was last updated, how many entries
@@ -106,6 +153,7 @@ export const databaseChecksum = (options) => (options.client ?? client).get({
106
153
  */
107
154
  export const databaseMetadata = (options) => (options.client ?? client).get({
108
155
  security: [{
156
+ key: 'ApiKeyAuth',
109
157
  in: 'query',
110
158
  name: 'apikey',
111
159
  type: 'apiKey'
@@ -1 +1 @@
1
- {"version":3,"file":"sdk.gen.js","sourceRoot":"","sources":["../../src/generated/sdk.gen.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAkBzC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAuC,OAAkD,EAA4E,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAA4D;IAC5R,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,uBAAuB;IAC5B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAuC,OAAsD,EAAkE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkD;IAChR,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAuC,OAAsD,EAAsF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsE;IACxT,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAuC,OAAsD,EAAsF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsE;IACxT,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAuC,OAAkD,EAA4E,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAA4D;IAC5R,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,4BAA4B;IACjC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE,CAAC;YACH,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB,CAAC;IACN,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE,CAAC;YACH,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB,CAAC;IACN,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE,CAAC;YACH,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB,CAAC;IACN,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC"}
1
+ {"version":3,"file":"sdk.gen.js","sourceRoot":"","sources":["../../src/generated/sdk.gen.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAkBzC;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAuC,OAAkD,EAA4E,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAA4D;IAC5R,QAAQ,EAAE;QACN;YACI,GAAG,EAAE,iBAAiB;YACtB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB;QACD,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;QACrC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE;KACrC;IACD,GAAG,EAAE,uBAAuB;IAC5B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAuC,OAAsD,EAAkE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkD;IAChR,QAAQ,EAAE;QACN;YACI,GAAG,EAAE,iBAAiB;YACtB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB;QACD,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;QACrC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE;KACrC;IACD,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAuC,OAAsD,EAAsF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsE;IACxT,QAAQ,EAAE;QACN;YACI,GAAG,EAAE,iBAAiB;YACtB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB;QACD,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;QACrC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE;KACrC;IACD,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAuC,OAAsD,EAAsF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsE;IACxT,QAAQ,EAAE;QACN;YACI,GAAG,EAAE,iBAAiB;YACtB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB;QACD,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;QACrC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE;KACrC;IACD,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAuC,OAAkD,EAA4E,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAA4D;IAC5R,QAAQ,EAAE;QACN;YACI,GAAG,EAAE,iBAAiB;YACtB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB;QACD,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;QACrC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE;KACrC;IACD,GAAG,EAAE,4BAA4B;IACjC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE,CAAC;YACH,GAAG,EAAE,YAAY;YACjB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB,CAAC;IACN,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE,CAAC;YACH,GAAG,EAAE,YAAY;YACjB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB,CAAC;IACN,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE,CAAC;YACH,GAAG,EAAE,YAAY;YACjB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACjB,CAAC;IACN,GAAG,EAAE,2BAA2B;IAChC,GAAG,OAAO;CACb,CAAC,CAAC"}
@@ -36,12 +36,20 @@ export type Database = {
36
36
  * is no licence.
37
37
  *
38
38
  */
39
- redistribution: 'evaluation' | 'internal' | 'redistribute' | null;
39
+ license_type: 'evaluation' | 'standard' | 'redistribute' | null;
40
40
  starts: string | null;
41
41
  /**
42
- * Null when the licence has no end date, or when there is none.
42
+ * 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.
43
43
  */
44
44
  expires: string | null;
45
+ /**
46
+ * When a rolling licence next renews. Null when the licence has no defined term, when expires sets a hard stop instead, and when there is no licence.
47
+ */
48
+ renews_at?: string | null;
49
+ /**
50
+ * The last day notice of non-renewal can be given for the term ending at renews_at. Null whenever renews_at is, and when the agreement records no notice period.
51
+ */
52
+ notice_due_at?: string | null;
45
53
  /**
46
54
  * Every published version of this family, oldest first. Old versions
47
55
  * are frozen rather than migrated, so both stay downloadable.
package/dist/index.d.ts CHANGED
@@ -2,5 +2,5 @@ export { InternetData, DatabaseApi, DEFAULT_BASE_URL } from './client.js';
2
2
  export type { DownloadDestination, DownloadsOptions, Options } from './client.js';
3
3
  export { InternetDataError } from './errors.js';
4
4
  export type { ErrorKind } from './errors.js';
5
- export { DATASET_FORMATS, REDISTRIBUTION_RIGHTS, STANDINGS } from './types.js';
6
- export type { Database, DatabaseMetadata, DatabaseMetadataColumn, DatabaseVersion, DatasetFormat, DbChecksums, Download, Redistribution, Standing, } from './types.js';
5
+ export { DATASET_FORMATS, LICENSE_TYPES, STANDINGS } from './types.js';
6
+ export type { Database, DatabaseMetadata, DatabaseMetadataColumn, DatabaseVersion, DatasetFormat, DbChecksums, Download, LicenseType, Standing, } from './types.js';
package/dist/index.js CHANGED
@@ -1,4 +1,4 @@
1
1
  export { InternetData, DatabaseApi, DEFAULT_BASE_URL } from './client.js';
2
2
  export { InternetDataError } from './errors.js';
3
- export { DATASET_FORMATS, REDISTRIBUTION_RIGHTS, STANDINGS } from './types.js';
3
+ export { DATASET_FORMATS, LICENSE_TYPES, STANDINGS } from './types.js';
4
4
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +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,qBAAqB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC"}
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"}
package/dist/types.d.ts CHANGED
@@ -5,7 +5,7 @@ export type DatasetFormat = DatabaseVersion['formats'][number];
5
5
  /** Where your organization's licence for a database family stands today. */
6
6
  export type Standing = Database['standing'];
7
7
  /** What a licence permits you to do with the data. Absent when there is no licence. */
8
- export type Redistribution = NonNullable<Database['redistribution']>;
8
+ export type LicenseType = NonNullable<Database['license_type']>;
9
9
  export declare const DATASET_FORMATS: readonly DatasetFormat[];
10
10
  export declare const STANDINGS: readonly Standing[];
11
- export declare const REDISTRIBUTION_RIGHTS: readonly Redistribution[];
11
+ export declare const LICENSE_TYPES: readonly LicenseType[];
package/dist/types.js CHANGED
@@ -4,7 +4,7 @@
4
4
  // value is MISSING is what the shared conformance corpus pins.
5
5
  export const DATASET_FORMATS = ['csvgz', 'mmdb'];
6
6
  export const STANDINGS = ['licensed', 'expired', 'unlicensed'];
7
- export const REDISTRIBUTION_RIGHTS = [
8
- 'evaluation', 'internal', 'redistribute',
7
+ export const LICENSE_TYPES = [
8
+ 'evaluation', 'standard', 'redistribute',
9
9
  ];
10
10
  //# sourceMappingURL=types.js.map
package/dist/types.js.map CHANGED
@@ -1 +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,qBAAqB,GAA8B;IAC5D,YAAY,EAAE,UAAU,EAAE,cAAc;CAC3C,CAAC"}
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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@internetdata/internetdata",
3
- "version": "1.0.0",
3
+ "version": "1.2.0",
4
4
  "description": "Official Node.js client library for the InternetData API. Download, verify and inspect licensed IP database files.",
5
5
  "type": "module",
6
6
  "license": "MIT",