@openwallet-foundation/askar-nodejs 0.2.5

package/build/askar-shared/src/store/Store.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Store = void 0;
+const askar_1 = require("../askar");
+const OpenSession_1 = require("./OpenSession");
+const Scan_1 = require("./Scan");
+class Store {
+    constructor({ handle, uri }) {
+        this._handle = handle;
+        this._uri = uri;
+    }
+    get handle() {
+        return this._handle;
+    }
+    static generateRawKey(seed) {
+        return askar_1.askar.storeGenerateRawKey({ seed });
+    }
+    get uri() {
+        return this._uri;
+    }
+    async createProfile(name) {
+        return askar_1.askar.storeCreateProfile({ storeHandle: this.handle, profile: name });
+    }
+    async getDefaultProfile() {
+        return askar_1.askar.storeGetDefaultProfile({ storeHandle: this.handle });
+    }
+    async setDefaultProfile(name) {
+        return askar_1.askar.storeSetDefaultProfile({ storeHandle: this.handle, profile: name });
+    }
+    async listProfiles() {
+        return askar_1.askar.storeListProfiles({ storeHandle: this.handle });
+    }
+    async removeProfile(name) {
+        return await askar_1.askar.storeRemoveProfile({ profile: name, storeHandle: this.handle });
+    }
+    async rekey({ keyMethod, passKey }) {
+        return await askar_1.askar.storeRekey({ keyMethod: keyMethod === null || keyMethod === void 0 ? void 0 : keyMethod.toUri(), passKey, storeHandle: this.handle });
+    }
+    static async provision({ uri, recreate, keyMethod, passKey, profile, }) {
+        const handle = await askar_1.askar.storeProvision({
+            specUri: uri,
+            keyMethod: keyMethod === null || keyMethod === void 0 ? void 0 : keyMethod.toUri(),
+            profile,
+            passKey,
+            recreate,
+        });
+        return new Store({ handle, uri });
+    }
+    static async open({ uri, keyMethod, passKey, profile, }) {
+        const handle = await askar_1.askar.storeOpen({ profile, passKey, keyMethod: keyMethod === null || keyMethod === void 0 ? void 0 : keyMethod.toUri(), specUri: uri });
+        return new Store({ uri, handle });
+    }
+    async close(remove = false) {
+        this._opener = undefined;
+        if (this.handle)
+            await this.handle.close();
+        return remove ? await Store.remove(this.uri) : false;
+    }
+    static async remove(uri) {
+        return await askar_1.askar.storeRemove({ specUri: uri });
+    }
+    session(profile) {
+        return new OpenSession_1.OpenSession({ store: this.handle, profile, isTxn: false });
+    }
+    transaction(profile) {
+        return new OpenSession_1.OpenSession({ store: this.handle, profile, isTxn: true });
+    }
+    async openSession(isTransaction = false) {
+        var _a;
+        (_a = this._opener) !== null && _a !== void 0 ? _a : (this._opener = new OpenSession_1.OpenSession({ store: this.handle, isTxn: isTransaction }));
+        return await this._opener.open();
+    }
+    scan(options) {
+        return new Scan_1.Scan(Object.assign(Object.assign({}, options), { store: this }));
+    }
+    async copyTo({ uri, keyMethod, passKey, recreate, }) {
+        await askar_1.askar.storeCopyTo({
+            storeHandle: this.handle,
+            targetUri: uri,
+            keyMethod: keyMethod === null || keyMethod === void 0 ? void 0 : keyMethod.toUri(),
+            passKey,
+            recreate,
+        });
+    }
+}
+exports.Store = Store;
+//# sourceMappingURL=Store.js.map

package/build/askar-shared/src/store/Store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Store.js","sourceRoot":"","sources":["../../../../../askar-shared/src/store/Store.ts"],"names":[],"mappings":";;;AAGA,oCAAgC;AAEhC,+CAA2C;AAC3C,iCAA6B;AAE7B,MAAa,KAAK;IAKhB,YAAmB,EAAE,MAAM,EAAE,GAAG,EAAwC;QACtE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAA;IACjB,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,IAAiB;QAC5C,OAAO,aAAK,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;IAC5C,CAAC;IAED,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAa;QACtC,OAAO,aAAK,CAAC,kBAAkB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IAC9E,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,OAAO,aAAK,CAAC,sBAAsB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IACnE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,IAAY;QACzC,OAAO,aAAK,CAAC,sBAAsB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IAClF,CAAC;IAEM,KAAK,CAAC,YAAY;QACvB,OAAO,aAAK,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IAC9D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAY;QACrC,OAAO,MAAM,aAAK,CAAC,kBAAkB,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IACpF,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,OAAO,EAAmD;QACxF,OAAO,MAAM,aAAK,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IACrG,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAC5B,GAAG,EACH,QAAQ,EACR,SAAS,EACT,OAAO,EACP,OAAO,GAOR;QACC,MAAM,MAAM,GAAG,MAAM,aAAK,CAAC,cAAc,CAAC;YACxC,OAAO,EAAE,GAAG;YACZ,SAAS,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK,EAAE;YAC7B,OAAO;YACP,OAAO;YACP,QAAQ;SACT,CAAC,CAAA;QACF,OAAO,IAAI,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;IACnC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EACvB,GAAG,EACH,SAAS,EACT,OAAO,EACP,OAAO,GAMR;QACC,MAAM,MAAM,GAAG,MAAM,aAAK,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAA;QACvG,OAAO,IAAI,KAAK,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAA;IACnC,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK;QAC/B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAA;QAExB,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QAE1C,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IACtD,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAW;QACpC,OAAO,MAAM,aAAK,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAA;IAClD,CAAC;IAEM,OAAO,CAAC,OAAgB;QAC7B,OAAO,IAAI,yBAAW,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;IACvE,CAAC;IAEM,WAAW,CAAC,OAAgB;QACjC,OAAO,IAAI,yBAAW,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACtE,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,aAAa,GAAG,KAAK;;QAC5C,MAAA,IAAI,CAAC,OAAO,oCAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,yBAAW,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,EAAA;QAC9E,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;IAClC,CAAC;IAEM,IAAI,CAAC,OAQX;QACC,OAAO,IAAI,WAAI,iCAAM,OAAO,KAAE,KAAK,EAAE,IAAI,IAAG,CAAA;IAC9C,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,EAClB,GAAG,EACH,SAAS,EACT,OAAO,EACP,QAAQ,GAMT;QACC,MAAM,aAAK,CAAC,WAAW,CAAC;YACtB,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,SAAS,EAAE,GAAG;YACd,SAAS,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK,EAAE;YAC7B,OAAO;YACP,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;CACF;AA5ID,sBA4IC"}

package/build/askar-shared/src/store/StoreKeyMethod.d.ts

@@ -0,0 +1,11 @@
+export declare enum KdfMethod {
+    Raw = "raw",
+    None = "none",
+    Argon2IMod = "kdf:argon2i:mod",
+    Argon2IInt = "kdf:argon2i:int"
+}
+export declare class StoreKeyMethod {
+    private method;
+    constructor(method: KdfMethod);
+    toUri(): string;
+}

package/build/askar-shared/src/store/StoreKeyMethod.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StoreKeyMethod = exports.KdfMethod = void 0;
+var KdfMethod;
+(function (KdfMethod) {
+    KdfMethod["Raw"] = "raw";
+    KdfMethod["None"] = "none";
+    KdfMethod["Argon2IMod"] = "kdf:argon2i:mod";
+    KdfMethod["Argon2IInt"] = "kdf:argon2i:int";
+})(KdfMethod || (exports.KdfMethod = KdfMethod = {}));
+class StoreKeyMethod {
+    constructor(method) {
+        this.method = method;
+    }
+    toUri() {
+        return this.method.toString();
+    }
+}
+exports.StoreKeyMethod = StoreKeyMethod;
+//# sourceMappingURL=StoreKeyMethod.js.map

package/build/askar-shared/src/store/StoreKeyMethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StoreKeyMethod.js","sourceRoot":"","sources":["../../../../../askar-shared/src/store/StoreKeyMethod.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;IACb,2CAA8B,CAAA;IAC9B,2CAA8B,CAAA;AAChC,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAED,MAAa,cAAc;IAGzB,YAAmB,MAAiB;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAA;IAC/B,CAAC;CACF;AAVD,wCAUC"}

package/build/askar-shared/src/store/index.d.ts

@@ -0,0 +1,9 @@
+export * from './Entry';
+export * from './EntryList';
+export * from './KeyEntry';
+export * from './KeyEntryList';
+export * from './Scan';
+export * from './Store';
+export * from './OpenSession';
+export * from './Session';
+export * from './StoreKeyMethod';

package/build/askar-shared/src/store/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Entry"), exports);
+__exportStar(require("./EntryList"), exports);
+__exportStar(require("./KeyEntry"), exports);
+__exportStar(require("./KeyEntryList"), exports);
+__exportStar(require("./Scan"), exports);
+__exportStar(require("./Store"), exports);
+__exportStar(require("./OpenSession"), exports);
+__exportStar(require("./Session"), exports);
+__exportStar(require("./StoreKeyMethod"), exports);
+//# sourceMappingURL=index.js.map

package/build/askar-shared/src/store/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../askar-shared/src/store/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,8CAA2B;AAC3B,6CAA0B;AAC1B,iDAA8B;AAC9B,yCAAsB;AACtB,0CAAuB;AACvB,gDAA6B;AAC7B,4CAAyB;AACzB,mDAAgC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@openwallet-foundation/askar-nodejs",
+  "version": "0.2.5",
+  "license": "Apache-2.0",
+  "description": "Nodejs wrapper for Askar",
+  "main": "build/index",
+  "source": "src/index",
+  "homepage": "https://github.com/openwallet-foundation/askar-wrapper-javascript",
+  "author": "Openwallet Foundation (https://github.com/openwallet-foundation)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openwallet-foundation/askar-wrapper-javascript",
+    "directory": "packages/askar-nodejs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "build",
+    "scripts",
+    "../../LICENSE"
+  ],
+  "scripts": {
+    "types:check": "pnpm compile --noEmit",
+    "build": "pnpm clean && pnpm compile",
+    "clean": "rimraf -rf ./build",
+    "compile": "tsc -p ./tsconfig.build.json",
+    "install": "node scripts/install.js"
+  },
+  "dependencies": {
+    "@2060.io/ffi-napi": "^4.0.9",
+    "@2060.io/ref-napi": "^3.0.6",
+    "@mapbox/node-pre-gyp": "^1.0.11",
+    "@openwallet-foundation/askar-shared": "0.2.5",
+    "ref-array-di": "^1.2.2",
+    "ref-struct-di": "^1.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.11",
+    "@types/ref-array-di": "^1.2.3",
+    "@types/ref-struct-di": "^1.1.6",
+    "typescript": "~5.4.5"
+  },
+  "binary": {
+    "module_name": "aries_askar",
+    "module_path": "native",
+    "remote_path": "v0.4.1",
+    "host": "https://github.com/openwallet-foundation/askar/releases/download/",
+    "package_name": "library-{platform}-{arch}.tar.gz"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "gitHead": "1d606bf90f8c5fc2a87ded183d519a5bcd670f8e"
+}

package/scripts/install.js

@@ -0,0 +1,15 @@
+const { execSync } = require('node:child_process')
+const { arch, platform: osPlatform } = require('os')
+
+const archTable = {
+  x64: 'x86_64',
+  arm64: 'aarch64',
+}
+
+const platform = osPlatform()
+const targetPlatform = platform === 'win32' ? 'windows' : platform
+const targetArchitecture = platform === 'darwin' ? 'universal' : archTable[arch]
+
+const command = `node-pre-gyp install --target_arch=${targetArchitecture} --target_platform=${targetPlatform}`
+
+execSync(command)