vpndetection 1.2.0 → 1.3.0

package/README.md

@@ -152,6 +152,15 @@ const bytes = await client.database.downloadBytes('cdn_ip_v1', 'csvgz');
 
 `downloadBytes` holds the whole file in memory, and the catalog runs from `cdn_ip_v1` at 10 KB to `resproxy_ip_90d_v1` at 1.79 GB, so use `download` for anything you have not measured.
 
+### Absent is not false
+
+Only `ip` and `isVpn` come back on every plan. A field your plan does not include is `undefined`, which means "not in your plan" rather than "checked, and no".
+
+```js
+result.isHosting ?? false        // when you only want the flag
+result.isHosting === undefined   // not in your plan
+```
+
 ## Other Libraries
 
 There are official VPNDetection client libraries available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails, and Laravel. See our GitHub at https://github.com/vpndetection-io for more.

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

@@ -235,11 +235,34 @@ export type LicensedVersion = {
      */
     sampleFormats?: Array<'csvgz' | 'mmdb'>;
 };
+/**
+ * One download ATTEMPT, refusals included - a denial is what answers "it
+ * stopped working", so they are listed rather than dropped.
+ *
+ */
 export type Download = {
     dataset_id: string;
     format: string;
     outcome: 'ok' | 'unauthorized' | 'denied' | 'expired' | 'unknown' | 'unavailable';
-    bytes?: number | null;
+    /**
+     * The evaluation sample rather than the database itself.
+     */
+    sample: boolean;
+    /**
+     * Object size at redirect time, NOT bytes delivered: the transfer is a
+     * presigned redirect straight to object storage, so we never observe it.
+     *
+     */
+    bytes: number | null;
+    http_status: number | null;
+    /**
+     * The key that made the request. Null when the org acted through the
+     * console rather than through a key.
+     *
+     */
+    apikey_id: string | null;
+    client_ip: string | null;
+    user_agent: string | null;
     created: string;
 };
 export type DatasetMetadataColumn = {
@@ -278,6 +301,16 @@ export type DatasetMetadata = {
     size?: {
         [key: string]: number;
     };
+    /**
+     * Bytes per format of the evaluation sample, where one is published
+     */
+    sample_size?: {
+        [key: string]: number;
+    };
+    /**
+     * Row count in the evaluation sample
+     */
+    sample_entries?: number;
 };
 export type LookupIpData = {
     body?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vpndetection",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Official Node.js client library for the VPNDetection API. Detect VPNs, proxies, Tor, hosting and CDN IPs.",
   "type": "module",
   "license": "MIT",