@oino-ts/hashid 0.1.2 → 0.1.3

package/dist/types/OINOHashid.d.ts

@@ -0,0 +1,42 @@
+export declare const OINOHASHID_MIN_LENGTH: number;
+export declare const OINOHASHID_MAX_LENGTH: number;
+/**
+ * Hashid implementation for OINO API:s for the purpose of making it infeasible to scan
+ * through numeric autoinc keys. It's not a solution to keeping the id secret in insecure
+ * channels, just making it hard enough to not iterate through the entire key space. Half
+ * of the the hashid length is nonce and half cryptotext, i.e. 16 char hashid 8 chars of
+ * base64 encoded nonce ~ 6 bytes or 48 bits of entropy.
+ *
+ */
+export declare class OINOHashid {
+    private _key;
+    private _iv;
+    private _domainId;
+    private _minLength;
+    private _staticIds;
+    /**
+     * Hashid constructor
+     *
+     * @param key AES128 key (32 char hex-string)
+     * @param domainId a sufficiently unique domain ID in which row-Id's are unique
+     * @param minLength minimum length of nonce and crypto
+     * @param staticIds whether hash values should remain static per row or random values
+     *
+     */
+    constructor(key: string, domainId: string, minLength?: number, staticIds?: boolean);
+    /**
+     * Encode given id value as a hashid either using random data or given seed value for nonce.
+     *
+     * @param id numeric value
+     * @param cellSeed a sufficiently unique seed for the current cell to keep hashids unique but persistent (e.g. fieldname + primarykey values)
+     *
+     */
+    encode(id: string, cellSeed?: string): string;
+    /**
+     * Decode given hashid.
+     *
+     * @param hashid value
+     *
+     */
+    decode(hashid: string): string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export { OINOHashid } from "./OINOHashid.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/hashid",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "OINO TS package for hashid's.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -18,11 +18,11 @@
   "types": "./dist/types/index.d.ts",
   "dependencies": {
     "@types/node": "^20.12.7",
-    "@oino-ts/common": "0.1.2",
+    "@oino-ts/common": "0.1.3",
     "base-x": "^5.0.0"
   },
   "devDependencies": {
-    "@oino-ts/types": "0.1.2"
+    "@oino-ts/types": "0.1.3"
   },
   "files": [
     "src/*.ts",