@dreaminhex/hexdb 2.2.0 → 2.3.1

package/README.md

@@ -2,7 +2,7 @@
 
 The JavaScript and TypeScript client for [HexDB](https://github.com/dreaminhex/hexdb), a document database with REST, GraphQL and read-only SQL, encryption at rest and replication with automatic failover.
 
-It covers documents (insert, get, replace, patch, delete), queries with filters, sorting and paging, counts, aggregations, upserts, transactions, idempotency keys, the change feed, streams, functions and GraphQL. It retries `429` and `503` answers for reads, and for writes that carry an idempotency key. Runs on Node.js 18+, Deno, Bun and in browsers, with no dependencies.
+It covers documents (insert, get, replace, patch, delete), queries with filters, sorting and paging, counts, aggregations, upserts, detokenizing vault tokens, transactions, idempotency keys, the change feed, streams, functions and GraphQL. It retries `429` and `503` answers for reads, and for writes that carry an idempotency key. Runs on Node.js 18+, Deno, Bun and in browsers, with no dependencies.
 
 ```sh
 npm install @dreaminhex/hexdb

package/dist/index.d.ts

@@ -178,6 +178,11 @@ export declare class Tessellation {
         matched: number;
         modified: number;
     }>;
+    /**
+     * The values behind vault tokens of tokenized fields (up to 1,000; needs the
+     * `detokenize` permission; audited). One-way and unknown tokens map to null.
+     */
+    detokenize(tokens: string[]): Promise<Record<string, string | null>>;
 }
 export declare class Stream {
     private readonly db;

package/dist/index.js

@@ -276,6 +276,13 @@ export class Tessellation {
     updateWhere(filter, update) {
         return this.db.request("POST", `${this.path}/_update`, { filter, update });
     }
+    /**
+     * The values behind vault tokens of tokenized fields (up to 1,000; needs the
+     * `detokenize` permission; audited). One-way and unknown tokens map to null.
+     */
+    async detokenize(tokens) {
+        return (await this.db.request("POST", `/tessellations/${enc(this.name)}/detokenize`, { tokens })).values;
+    }
 }
 export class Stream {
     db;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreaminhex/hexdb",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "Client for HexDB, the hexagonal document database.",
   "license": "Apache-2.0",
   "author": "Dream In Hex",