inibase 3.3.0 → 3.4.0

package/README.md

@@ -206,7 +206,7 @@ interface {
 
 ```ts
 interface Field {
-  id: number; // stored as a Number but displayed as a hashed ID
+  id: number; // position in the schema; 0 = the row id, -1 = createdAt, -2 = updatedAt
   key: string;
   required?: boolean;
   unique?: boolean | string; // boolean for simple uniqueness, string for grouped uniqueness
@@ -402,6 +402,30 @@ const userTableSchema = [
 await db.createTable("user", userTableSchema, userTableConfig);
 ```
 
+#### `decodeID`
+
+By default a row's `id` is stored as a number but only ever handed back as an
+encrypted (`aes-256-cbc`, hex) string, so ids can't be guessed by incrementing.
+Set `decodeID: true` and the id is exposed as the **plain number** everywhere —
+`get` rows, `get`/`put`/`delete` by id, relation lookups, and the id returned by
+`post`:
+
+```js
+const db = new Inibase("/databaseName");
+await db.createTable("item", [{ key: "name", type: "string" }], {
+  decodeID: true,
+});
+
+const id = await db.post("item", { name: "widget" }); // => 1  (a number)
+await db.get("item", 1); // works with the raw number
+```
+
+So `post` returns a `number` on a `decodeID` table and an encrypted `string` on
+every other table — in TypeScript its return type is `string | number`
+(`(string | number)[]` for a bulk post). Encrypted ids stay valid inputs on a
+`decodeID` table too, so existing clients that round-trip an id keep working
+either way. `decodeID` can be toggled later with `updateTable`.
+
 </blockquote>
 </details>
 

package/dist/index.d.ts

@@ -384,9 +384,13 @@ export default class Inibase {
      * @param {Options} [options] Pagination options, useful when the returnPostedData param is true
      * @param {boolean} [returnPostedData] By default function returns void, if you want to get the posted data, set this param to true
      * @return {*}  {Promise<Data | Data[] | null | void>}
+     *
+     * @remarks Without `returnPostedData` the return value is the new id: a
+     * `number` on a table created with `decodeID: true`, an encrypted
+     * `string` on every other table.
      */
-    post<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: Data & TData, options?: Options, returnPostedData?: boolean): Promise<string>;
-    post<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData)[], options?: Options, returnPostedData?: boolean): Promise<string[]>;
+    post<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: Data & TData, options?: Options, returnPostedData?: boolean): Promise<string | number>;
+    post<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData)[], options?: Options, returnPostedData?: boolean): Promise<(string | number)[]>;
     post<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: Data & TData, options: Options | undefined, returnPostedData: true): Promise<(Data & TData) | null>;
     post<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData)[], options: Options | undefined, returnPostedData: true): Promise<(Data & TData)[] | null>;
     private _post;

package/dist/index.js

@@ -2902,12 +2902,18 @@ export default class Inibase {
                         : this.totalItems.get(`${tableName}-*`), options, !Utils.isArrayOfObjects(clonedData), // return only one item if data is not array of objects
                 undefined, true);
             }
+            // On a decodeID table the id *is* the plain number — that is the
+            // whole point of the config: get(), put(), delete() and the
+            // returnPostedData read all hand back raw numbers, so post() must
+            // not encode it here. Every other table keeps returning the
+            // encrypted id.
+            const tableConfig = globalConfig[this.databasePath].tables?.get(tableName)?.config;
+            const postedID = (id) => tableConfig?.decodeID === true
+                ? Number(id)
+                : UtilsServer.encodeID(id);
             return Array.isArray(clonedData)
-                ? (globalConfig[this.databasePath].tables?.get(tableName)?.config
-                    .prepend
-                    ? clonedData.toReversed()
-                    : clonedData).map(({ id }) => UtilsServer.encodeID(id))
-                : UtilsServer.encodeID(clonedData.id);
+                ? (tableConfig?.prepend ? clonedData.toReversed() : clonedData).map(({ id }) => postedID(id))
+                : postedID(clonedData.id);
         }
         finally {
             if (this.transaction) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inibase",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "type": "module",
   "author": {
     "name": "Karim Amahtil",