vpndetection 5.0.0 → 5.2.0

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

@@ -1,5 +1,5 @@
 import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from './client/index.js';
-import type { AccountCreateApikeyData, AccountCreateApikeyErrors, AccountCreateApikeyResponses, AccountIdentityData, AccountIdentityErrors, AccountIdentityResponses, AccountListApikeysData, AccountListApikeysErrors, AccountListApikeysResponses, AccountOrgData, AccountOrgErrors, AccountOrgMembersData, AccountOrgMembersErrors, AccountOrgMembersResponses, AccountOrgResponses, AccountRevealApikeyData, AccountRevealApikeyErrors, AccountRevealApikeyResponses, AccountRevokeApikeyData, AccountRevokeApikeyErrors, AccountRevokeApikeyResponses, AccountRotateApikeyData, AccountRotateApikeyErrors, AccountRotateApikeyResponses, DatabaseChecksumData, DatabaseChecksumErrors, DatabaseChecksumResponses, DatabaseMetadataData, DatabaseMetadataErrors, DatabaseMetadataResponses, DownloadDatabaseData, DownloadDatabaseErrors, ListDatabasesData, ListDatabasesErrors, ListDatabasesResponses, ListDownloadsData, ListDownloadsErrors, ListDownloadsResponses, LookupIpData, LookupIpErrors, LookupIpResponses, LookupMyIpData, LookupMyIpErrors, LookupMyIpResponses, MyEntitlementData, MyEntitlementErrors, MyEntitlementResponses, OauthAuthorizeData, OauthAuthorizeErrors, OauthDeviceAuthorizationData, OauthDeviceAuthorizationErrors, OauthDeviceAuthorizationResponses, OauthMetadataData, OauthMetadataResponses, OauthRevokeData, OauthRevokeResponses, OauthTokenData, OauthTokenErrors, OauthTokenResponses } from './types.gen.js';
+import type { AccountCreateApikeyData, AccountCreateApikeyErrors, AccountCreateApikeyResponses, AccountIdentityData, AccountIdentityErrors, AccountIdentityResponses, AccountListApikeysData, AccountListApikeysErrors, AccountListApikeysResponses, AccountOrgData, AccountOrgErrors, AccountOrgMembersData, AccountOrgMembersErrors, AccountOrgMembersResponses, AccountOrgResponses, AccountRevealApikeyData, AccountRevealApikeyErrors, AccountRevealApikeyResponses, AccountRevokeApikeyData, AccountRevokeApikeyErrors, AccountRevokeApikeyResponses, AccountRotateApikeyData, AccountRotateApikeyErrors, AccountRotateApikeyResponses, DatabaseChecksumData, DatabaseChecksumErrors, DatabaseChecksumResponses, DatabaseMetadataData, DatabaseMetadataErrors, DatabaseMetadataResponses, DownloadDatabaseData, DownloadDatabaseErrors, ListDatabasesData, ListDatabasesErrors, ListDatabasesResponses, ListDownloadsData, ListDownloadsErrors, ListDownloadsResponses, LookupBatchData, LookupBatchErrors, LookupBatchResponses, LookupIpData, LookupIpErrors, LookupIpResponses, LookupMyIpData, LookupMyIpErrors, LookupMyIpResponses, MyEntitlementData, MyEntitlementErrors, MyEntitlementResponses, OauthAuthorizeData, OauthAuthorizeErrors, OauthDeviceAuthorizationData, OauthDeviceAuthorizationErrors, OauthDeviceAuthorizationResponses, OauthMetadataData, OauthMetadataResponses, OauthRevokeData, OauthRevokeResponses, OauthTokenData, OauthTokenErrors, OauthTokenResponses } from './types.gen.js';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -36,6 +36,29 @@ export declare const lookupIp: <ThrowOnError extends boolean = false>(options: O
  *
  */
 export declare const lookupMyIp: <ThrowOnError extends boolean = false>(options?: Options<LookupMyIpData, ThrowOnError>) => RequestResult<LookupMyIpResponses, LookupMyIpErrors, ThrowOnError>;
+/**
+ * Batch
+ *
+ * Answers up to 1000 addresses in one call. Each distinct string in `ips`
+ * is one lookup: it costs exactly what `GET /{ip}` costs for that address
+ * and comes back with exactly the fields that call would carry for your
+ * plan. Exact duplicates collapse to one entry and one lookup.
+ *
+ * Both maps in the answer are keyed by the string you sent, so nothing has
+ * to be lined up by position; the `ip` inside each result is the
+ * normalized form. An address that could not be answered sits in `errors`
+ * with the status and message the single lookup would have given, and
+ * never disturbs the others: a string that is not an address is a `400`
+ * there, and an allowance that runs out part way through leaves the
+ * remaining entries as `429`s.
+ *
+ * The call itself fails only for the reasons below, and a `429` on the
+ * call always carries `Retry-After`: the batch is admitted or refused
+ * whole by the rate limit, so a per-entry `429` is always a spent
+ * allowance and never a throttle.
+ *
+ */
+export declare const lookupBatch: <ThrowOnError extends boolean = false>(options: Options<LookupBatchData, ThrowOnError>) => RequestResult<LookupBatchResponses, LookupBatchErrors, ThrowOnError>;
 /**
  * List
  *

package/dist/generated/sdk.gen.js

@@ -48,6 +48,45 @@ export const lookupMyIp = (options) => (options?.client ?? client).get({
     url: '/myip',
     ...options
 });
+/**
+ * Batch
+ *
+ * Answers up to 1000 addresses in one call. Each distinct string in `ips`
+ * is one lookup: it costs exactly what `GET /{ip}` costs for that address
+ * and comes back with exactly the fields that call would carry for your
+ * plan. Exact duplicates collapse to one entry and one lookup.
+ *
+ * Both maps in the answer are keyed by the string you sent, so nothing has
+ * to be lined up by position; the `ip` inside each result is the
+ * normalized form. An address that could not be answered sits in `errors`
+ * with the status and message the single lookup would have given, and
+ * never disturbs the others: a string that is not an address is a `400`
+ * there, and an allowance that runs out part way through leaves the
+ * remaining entries as `429`s.
+ *
+ * The call itself fails only for the reasons below, and a `429` on the
+ * call always carries `Retry-After`: the batch is admitted or refused
+ * whole by the rate limit, so a per-entry `429` is always a spent
+ * allowance and never a throttle.
+ *
+ */
+export const lookupBatch = (options) => (options.client ?? client).post({
+    security: [
+        {
+            in: 'query',
+            name: 'apikey',
+            type: 'apiKey'
+        },
+        { name: 'X-Api-Key', type: 'apiKey' },
+        { scheme: 'bearer', type: 'http' }
+    ],
+    url: '/batch',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
 /**
  * List
  *

package/dist/generated/sdk.gen.js.map

@@ -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;AACzC,OAAO,EAA+F,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAiB/J;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAuC,OAA4C,EAAkE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkD;IAC5P,QAAQ,EAAE;QACN;YACI,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,OAAO;IACZ,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAuC,OAA+C,EAAsE,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsD;IAC1Q,QAAQ,EAAE;QACN;YACI,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,OAAO;IACZ,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;GASG;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,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;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAuC,OAAoD,EAAgE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAgD;IACxQ,QAAQ,EAAE;QACN;YACI,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,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE;QACN;YACI,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,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE;QACN;YACI,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,aAAa,GAAG,CAAuC,OAAkD,EAA4E,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAA4D;IAC5R,QAAQ,EAAE;QACN;YACI,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;;;;;;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,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,qBAAqB;IAC1B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAuC,OAAoD,EAAgF,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAgE;IACxS,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,sBAAsB;IAC3B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAuC,OAA+C,EAAsE,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsD;IAC1Q,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,iBAAiB;IACtB,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAuC,OAAsD,EAAoF,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAoE;IACpT,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,yBAAyB;IAC9B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAuC,OAAuD,EAAsF,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsE;IAC1T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,qBAAqB;IAC1B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAuC,OAAuD,EAAwF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAwE;IAC/T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,qBAAqB;IAC1B,GAAG,OAAO;IACV,OAAO,EAAE;QACL,cAAc,EAAE,kBAAkB;QAClC,GAAG,OAAO,CAAC,OAAO;KACrB;CACJ,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAuC,OAAuD,EAAwF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAwE;IAC/T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,iCAAiC;IACtC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAuC,OAAuD,EAAwF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAwE;IAC/T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,iCAAiC;IACtC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAuC,OAAuD,EAAwF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAwE;IAC/T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,iCAAiC;IACtC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAuC,OAAkD,EAAgE,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAgD,EAAE,GAAG,EAAE,yCAAyC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAExU;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAuC,OAA4D,EAAkG,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAkF;IAC7V,GAAG,6BAA6B;IAChC,GAAG,EAAE,6BAA6B;IAClC,GAAG,OAAO;IACV,OAAO,EAAE;QACL,cAAc,EAAE,mCAAmC;QACnD,GAAG,OAAO,CAAC,OAAO;KACrB;CACJ,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAuC,OAAkD,EAA8D,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAA8C,EAAE,GAAG,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAE7S;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAuC,OAA8C,EAAsE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAsD;IACzQ,GAAG,6BAA6B;IAChC,GAAG,EAAE,cAAc;IACnB,GAAG,OAAO;IACV,OAAO,EAAE;QACL,cAAc,EAAE,mCAAmC;QACnD,GAAG,OAAO,CAAC,OAAO;KACrB;CACJ,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAuC,OAA+C,EAA8D,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAA8C;IAC3P,GAAG,6BAA6B;IAChC,GAAG,EAAE,eAAe;IACpB,GAAG,OAAO;IACV,OAAO,EAAE;QACL,cAAc,EAAE,mCAAmC;QACnD,GAAG,OAAO,CAAC,OAAO;KACrB;CACJ,CAAC,CAAC"}
+{"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;AACzC,OAAO,EAA+F,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAiB/J;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAuC,OAA4C,EAAkE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkD;IAC5P,QAAQ,EAAE;QACN;YACI,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,OAAO;IACZ,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAuC,OAA+C,EAAsE,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsD;IAC1Q,QAAQ,EAAE;QACN;YACI,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,OAAO;IACZ,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAuC,OAA+C,EAAwE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAwD;IAC/Q,QAAQ,EAAE;QACN;YACI,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,QAAQ;IACb,GAAG,OAAO;IACV,OAAO,EAAE;QACL,cAAc,EAAE,kBAAkB;QAClC,GAAG,OAAO,CAAC,OAAO;KACrB;CACJ,CAAC,CAAC;AAEH;;;;;;;;;GASG;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,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;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAuC,OAAoD,EAAgE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAgD;IACxQ,QAAQ,EAAE;QACN;YACI,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,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE;QACN;YACI,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,gBAAgB,GAAG,CAAuC,OAAoD,EAAkF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAkE;IAC5S,QAAQ,EAAE;QACN;YACI,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,aAAa,GAAG,CAAuC,OAAkD,EAA4E,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAA4D;IAC5R,QAAQ,EAAE;QACN;YACI,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;;;;;;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,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,qBAAqB;IAC1B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAuC,OAAoD,EAAgF,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAgE;IACxS,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,sBAAsB;IAC3B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAuC,OAA+C,EAAsE,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsD;IAC1Q,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,iBAAiB;IACtB,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAuC,OAAsD,EAAoF,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAoE;IACpT,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,yBAAyB;IAC9B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAuC,OAAuD,EAAsF,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAsE;IAC1T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,qBAAqB;IAC1B,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAuC,OAAuD,EAAwF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAwE;IAC/T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,qBAAqB;IAC1B,GAAG,OAAO;IACV,OAAO,EAAE;QACL,cAAc,EAAE,kBAAkB;QAClC,GAAG,OAAO,CAAC,OAAO;KACrB;CACJ,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAuC,OAAuD,EAAwF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAwE;IAC/T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,iCAAiC;IACtC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAuC,OAAuD,EAAwF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAwE;IAC/T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,iCAAiC;IACtC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAuC,OAAuD,EAAwF,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAwE;IAC/T,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9C,GAAG,EAAE,iCAAiC;IACtC,GAAG,OAAO;CACb,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAuC,OAAkD,EAAgE,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAgD,EAAE,GAAG,EAAE,yCAAyC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAExU;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAuC,OAA4D,EAAkG,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAkF;IAC7V,GAAG,6BAA6B;IAChC,GAAG,EAAE,6BAA6B;IAClC,GAAG,OAAO;IACV,OAAO,EAAE;QACL,cAAc,EAAE,mCAAmC;QACnD,GAAG,OAAO,CAAC,OAAO;KACrB;CACJ,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAuC,OAAkD,EAA8D,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAA8C,EAAE,GAAG,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAE7S;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAuC,OAA8C,EAAsE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAAsD;IACzQ,GAAG,6BAA6B;IAChC,GAAG,EAAE,cAAc;IACnB,GAAG,OAAO;IACV,OAAO,EAAE;QACL,cAAc,EAAE,mCAAmC;QACnD,GAAG,OAAO,CAAC,OAAO;KACrB;CACJ,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAuC,OAA+C,EAA8D,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,IAAI,CAA8C;IAC3P,GAAG,6BAA6B;IAChC,GAAG,EAAE,eAAe;IACpB,GAAG,OAAO;IACV,OAAO,EAAE;QACL,cAAc,EAAE,mCAAmC;QACnD,GAAG,OAAO,CAAC,OAAO;KACrB;CACJ,CAAC,CAAC"}

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

@@ -84,6 +84,50 @@ export type LookupResponse = {
      */
     mobproxy?: ProxyDetail;
 };
+export type BatchLookupRequest = {
+    /**
+     * The addresses to classify, 1 to 1000 per call, counted before
+     * duplicates collapse. Each distinct string is one lookup.
+     *
+     */
+    ips: Array<string>;
+};
+export type BatchLookupResponse = {
+    /**
+     * One answer per input string that was classified, keyed by the string
+     * as you sent it; the `ip` inside is the normalized form. Each value is
+     * exactly what `GET /{ip}` answers for your plan.
+     *
+     */
+    results: {
+        [key: string]: LookupResponse;
+    };
+    /**
+     * One entry per input string that could not be classified, keyed the
+     * same way. Empty when every entry was answered.
+     *
+     */
+    errors: {
+        [key: string]: BatchLookupError;
+    };
+};
+/**
+ * Why one entry of a batch was not answered, as the single lookup would have reported it.
+ */
+export type BatchLookupError = {
+    /**
+     * The HTTP status `GET /{ip}` would have answered for this entry: `400`
+     * for a string that is not an address, `429` for a spent allowance,
+     * `500` when the VPN dataset could not be consulted. A `429` here is
+     * never a throttle; the whole call is refused instead.
+     *
+     */
+    status: number;
+    /**
+     * The same message the single lookup carries for that status.
+     */
+    error: string;
+};
 /**
  * What is known about the VPN attribution. Every key is present when the
  * object is populated, empty values included; the object is `{}` when
@@ -523,9 +567,14 @@ export type OauthMetadata = {
     grant_types_supported?: Array<string>;
     code_challenge_methods_supported?: Array<string>;
     /**
-     * A client_id may be an https URL serving your client metadata.
+     * Always `none`. Every client is public and has no secret.
      */
-    client_id_metadata_document_supported?: boolean;
+    token_endpoint_auth_methods_supported?: Array<string>;
+    /**
+     * RFC 9207. A redirect back from the authorization endpoint carries `iss`.
+     */
+    authorization_response_iss_parameter_supported?: boolean;
+    service_documentation?: string;
 };
 export type DeviceAuthorizationRequest = {
     client_id: string;
@@ -552,6 +601,9 @@ export type DeviceAuthorization = {
      * The same page with the code already filled in.
      */
     verification_uri_complete?: string;
+    /**
+     * Seconds until both codes expire.
+     */
     expires_in: number;
     /**
      * Seconds between polls.
@@ -559,26 +611,77 @@ export type DeviceAuthorization = {
     interval: number;
 };
 export type TokenRequest = {
+    /**
+     * `urn:ietf:params:oauth:grant-type:device_code`, `authorization_code` or `refresh_token`.
+     */
     grant_type: string;
     client_id: string;
+    /**
+     * Required by the device code grant.
+     */
     device_code?: string;
+    /**
+     * Required by the authorization code grant.
+     */
     code?: string;
+    /**
+     * Required by the authorization code grant.
+     */
     code_verifier?: string;
+    /**
+     * Authorization code grant: the `redirect_uri` the code was issued against, exactly.
+     */
     redirect_uri?: string;
+    /**
+     * Required by the refresh token grant.
+     */
     refresh_token?: string;
 };
 export type TokenResponse = {
     access_token: string;
+    /**
+     * Always `Bearer`.
+     */
     token_type: string;
+    /**
+     * Seconds until the access token expires.
+     */
     expires_in: number;
+    /**
+     * Always returned. A refresh consumes the token it presents, so keep this one.
+     */
     refresh_token?: string;
     /**
      * What was actually granted, which may be narrower than what was asked for.
      */
     scope?: string;
+    /**
+     * Not part of OAuth. The ID of the API key the person picked when they
+     * approved, returned by every grant while this authorization may still
+     * read that key back. Absent when no key was picked, or when the
+     * person's role no longer allows reading keys back.
+     *
+     */
+    'mslm:apikey_id'?: string;
+    /**
+     * Not part of OAuth. The API key itself, so a device ends up holding an
+     * ordinary key. Returned by the device code and authorization code
+     * grants only, never by a refresh, and only alongside
+     * `mslm:apikey_id`. Absent when that key's secret cannot be read back,
+     * which is the case for a key created before keys could be shown again
+     * in the console; a rotated key can be.
+     *
+     */
+    'mslm:apikey'?: string;
 };
 export type RevokeRequest = {
+    /**
+     * An access token or a refresh token.
+     */
     token: string;
+    /**
+     * Accepted and not checked.
+     */
     client_id?: string;
 };
 export type OauthError = {
@@ -675,6 +778,50 @@ export type LookupMyIpResponses = {
     200: LookupResponse;
 };
 export type LookupMyIpResponse = LookupMyIpResponses[keyof LookupMyIpResponses];
+export type LookupBatchData = {
+    body: BatchLookupRequest;
+    path?: never;
+    query?: never;
+    url: '/batch';
+};
+export type LookupBatchErrors = {
+    /**
+     * The body is not a batch, or names too few or too many addresses.
+     */
+    400: LookupError;
+    /**
+     * The presented API key is unknown, revoked, or expired.
+     */
+    401: LookupError;
+    /**
+     * The key restricts which source addresses may use it, and this
+     * request did not come from one of them.
+     *
+     */
+    403: LookupError;
+    /**
+     * The body is larger than any batch of 1000 addresses can be.
+     */
+    413: LookupError;
+    /**
+     * The rate limit refused the whole call. Always transient and always
+     * with `Retry-After`; a spent allowance is reported per entry in a
+     * `200` instead.
+     *
+     */
+    429: LookupError;
+};
+export type LookupBatchError = LookupBatchErrors[keyof LookupBatchErrors];
+export type LookupBatchResponses = {
+    /**
+     * One entry per distinct input string, in `results` or in `errors`.
+     * Present fields within a result are those your plan includes; see the
+     * tier table in the API description.
+     *
+     */
+    200: BatchLookupResponse;
+};
+export type LookupBatchResponse = LookupBatchResponses[keyof LookupBatchResponses];
 export type ListDatabasesData = {
     body?: never;
     path?: never;
@@ -819,6 +966,9 @@ export type ListDownloadsData = {
     body?: never;
     path?: never;
     query?: {
+        /**
+         * How many attempts to return. Clamped to 1 through 200.
+         */
         limit?: number;
     };
     url: '/api/v1/database/downloads';
@@ -1134,11 +1284,16 @@ export type OauthDeviceAuthorizationData = {
 };
 export type OauthDeviceAuthorizationErrors = {
     /**
-     * `invalid_request`, `invalid_client`, `unauthorized_client`, or
-     * `slow_down` when this address has started too many authorizations.
+     * `invalid_request`, `unauthorized_client` when the client may not use
+     * the device flow, or `slow_down` when this address has started too
+     * many authorizations.
      *
      */
     400: OauthError;
+    /**
+     * `invalid_client`: the `client_id` is not registered.
+     */
+    401: OauthError;
 };
 export type OauthDeviceAuthorizationError = OauthDeviceAuthorizationErrors[keyof OauthDeviceAuthorizationErrors];
 export type OauthDeviceAuthorizationResponses = {
@@ -1188,9 +1343,18 @@ export type OauthTokenErrors = {
     /**
      * An RFC 6749 error. `authorization_pending` and `slow_down` are
      * normal answers while polling a device authorization, not failures.
+     * `access_denied` means the person refused, and `expired_token` that
+     * the device code is no longer valid: it expired, or it was already
+     * exchanged or refused. `invalid_grant` means the code, device code or
+     * refresh token is not valid for this `client_id`. `slow_down` also
+     * answers any grant when this address sends too many requests.
      *
      */
     400: OauthError;
+    /**
+     * `invalid_client`: the `client_id` is not registered.
+     */
+    401: OauthError;
 };
 export type OauthTokenError = OauthTokenErrors[keyof OauthTokenErrors];
 export type OauthTokenResponses = {

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 export { VPNDetection, DatabaseApi, DEFAULT_BASE_URL } from './client.js';
 export type { Options, CacheOptions, LookupOptions, BatchOptions, DownloadsOptions, DownloadDestination, } from './client.js';
+export { OauthApi } from './oauth.js';
+export type { OauthOptions, DeviceAuthorizationOptions, PollDeviceTokenOptions, OauthMetadata, DeviceAuthorization, TokenResponse, } from './oauth.js';
 export { isBogon } from './bogon.js';
-export { VPNDetectionError } from './errors.js';
+export { VPNDetectionError, OauthError, OauthAccessDeniedError, OauthExpiredTokenError, } from './errors.js';
 export type { ErrorKind } from './errors.js';
 export type { Result, VpnDetail, ClassDetail, ProxyDetail, LookupResponse, } from './types.js';
 export { DATABASE_FORMATS, STANDINGS, LICENSE_TYPES } from './types.js';

package/dist/index.js

@@ -1,5 +1,6 @@
 export { VPNDetection, DatabaseApi, DEFAULT_BASE_URL } from './client.js';
+export { OauthApi } from './oauth.js';
 export { isBogon } from './bogon.js';
-export { VPNDetectionError } from './errors.js';
+export { VPNDetectionError, OauthError, OauthAccessDeniedError, OauthExpiredTokenError, } from './errors.js';
 export { DATABASE_FORMATS, STANDINGS, LICENSE_TYPES } 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;AAK1E,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAKhD,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,aAAa,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;AAK1E,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKtC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EACH,iBAAiB,EAAE,UAAU,EAAE,sBAAsB,EAAE,sBAAsB,GAChF,MAAM,aAAa,CAAC;AAKrB,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC"}

package/dist/oauth.d.ts

@@ -0,0 +1,118 @@
+import type { Client } from './generated/client/index.js';
+/** Per-call overrides for one OAuth request. Anything omitted falls back to the client's setting. */
+export interface OauthOptions {
+    /** How long one attempt may take before it is abandoned, in milliseconds. */
+    timeoutMs?: number;
+}
+/** What a device sign-in asks for. A member left out is left out of the request, never sent empty. */
+export interface DeviceAuthorizationOptions extends OauthOptions {
+    /** Space-delimited scopes, sent as given. The server narrows them to what the client may ask for. */
+    scope?: string;
+    /** The API the tokens are meant for. */
+    resource?: string;
+}
+export interface PollDeviceTokenOptions {
+    /** How long EACH request of the poll may take, in milliseconds. Never bounds the poll as a whole. */
+    timeoutMs?: number;
+    /** Aborting it stops the wait and any request in flight, and the poll rejects with its reason. */
+    signal?: AbortSignal;
+}
+/** The authorization server's discovery document. No call here needs it: each builds on the base URL. */
+export interface OauthMetadata {
+    issuer: string;
+    authorization_endpoint: string;
+    token_endpoint: string;
+    device_authorization_endpoint?: string;
+    revocation_endpoint?: string;
+    scopes_supported?: string[];
+    response_types_supported?: string[];
+    grant_types_supported?: string[];
+    code_challenge_methods_supported?: string[];
+    token_endpoint_auth_methods_supported?: string[];
+    authorization_response_iss_parameter_supported?: boolean;
+    service_documentation?: string;
+}
+/** A started device sign-in. `expires_in` and `interval` are seconds. */
+export interface DeviceAuthorization {
+    device_code: string;
+    /** What the person types in at `verification_uri`. */
+    user_code: string;
+    verification_uri: string;
+    /** `verification_uri` with the code already in it, for a program that can open a browser. */
+    verification_uri_complete?: string;
+    expires_in: number;
+    interval: number;
+}
+/**
+ * What a completed sign-in or a refresh hands back.
+ *
+ * `apikey_id` is set when the person picked one of their API keys and may still
+ * read it back. `apikey`, the key itself, also needs a sign-in rather than a
+ * refresh and a key whose secret can be shown again, so `apikey_id` without
+ * `apikey` is normal. An empty `scope` is present.
+ */
+export interface TokenResponse {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+    /** Spent by the refresh that presents it, so keep the one each refresh returns. */
+    refresh_token?: string;
+    scope?: string;
+    apikey_id?: string;
+    apikey?: string;
+}
+/**
+ * Signs a person in on their own machine with the OAuth device flow, so a
+ * program can be handed one of their API keys instead of asking them to paste
+ * it. Reached through `client.oauth`.
+ *
+ * Every call takes a client ID, issued on request from support@vpndetection.io.
+ * None of these requests carries the client's API key, and none needs one.
+ */
+export declare class OauthApi {
+    private readonly client;
+    private readonly retries;
+    private readonly timeoutMs;
+    private clock;
+    constructor(client: Client, retries: number, timeoutMs: number);
+    metadata(options?: OauthOptions): Promise<OauthMetadata>;
+    /**
+     * Start a device sign-in: show the person `user_code` and `verification_uri`,
+     * then hand the answer to `pollDeviceToken`. It consumes nothing, so it is
+     * retried like a lookup; a refusal such as `slow_down` is an `OauthError`.
+     */
+    deviceAuthorization(clientId: string, options?: DeviceAuthorizationOptions): Promise<DeviceAuthorization>;
+    /**
+     * Ask once whether the person has approved a device sign-in. Until they do,
+     * it rejects with an `OauthError` coded `authorization_pending`;
+     * `pollDeviceToken` is the loop around it.
+     *
+     * Never retried: an approved code is spent by the answer carrying the tokens,
+     * so a retry after a lost response could only lose them.
+     */
+    exchangeDeviceCode(clientId: string, deviceCode: string, options?: OauthOptions): Promise<TokenResponse>;
+    /**
+     * Trade a refresh token for a new pair. The old one is spent whatever happens
+     * next, so this is never retried. A refresh names the key the person picked
+     * (`apikey_id`) but never reveals it again (`apikey`).
+     */
+    exchangeRefreshToken(clientId: string, refreshToken: string, options?: OauthOptions): Promise<TokenResponse>;
+    /**
+     * End a token. A refresh token ends the whole sign-in and every token it
+     * issued, which is how a program signs the machine out; an access token ends
+     * only itself. The server answers the same for any token, known or not.
+     */
+    revoke(clientId: string, token: string, options?: OauthOptions): Promise<void>;
+    /**
+     * Wait for the person to approve a device sign-in, and return its tokens.
+     *
+     * Waits `device.interval` seconds (5 when that is below 1) before EVERY
+     * request, the first included, and 5 more for the rest of the call each time
+     * the server answers `slow_down`. Ends at the first answer that is neither:
+     * a denial rejects with `OauthAccessDeniedError`, a code that ran out with
+     * `OauthExpiredTokenError` - as does outliving `device.expires_in`, counted
+     * from this call, with no `status` - and any other failure as it came.
+     */
+    pollDeviceToken(clientId: string, device: DeviceAuthorization, options?: PollDeviceTokenOptions): Promise<TokenResponse>;
+    private exchange;
+}