@virtonetwork/authenticators-webauthn 1.2.2 → 1.2.4

package/README.md

@@ -1,4 +1,6 @@
-# WebAuthn Authenticator for Virto Network
+# WebAuthn Authenticator
+
+[**📚 Documentation**](https://virtonetwork.github.io/papi-signers/guide/webauthn)
 
 A TypeScript helper that wires **passkeys** (WebAuthn resident credentials) to the [@virtonetwork/signer](https://github.com/virto-network/papi-signers) stack. It exposes a single class, `WebAuthn`, that fulfils the `Authenticator<number>` interface used by `PassSigner`.
 The implementation is **browser‑only** and keeps all credential mapping in the caller’s hands — perfect for SPAs or wallet extensions that already manage users.

package/dist/cjs/in-memory-credentials-handler.cjs

@@ -43,9 +43,9 @@ var InMemoryCredentialsHandler = /** @class */ (function () {
     InMemoryCredentialsHandler.tryMutate = function (userId, f) {
         var _a;
         try {
-            var map = (_a = this.userCredentials[userId]) !== null && _a !== void 0 ? _a : {};
+            var map = (_a = InMemoryCredentialsHandler.userCredentials[userId]) !== null && _a !== void 0 ? _a : {};
             f(map);
-            this.userCredentials[userId] = map;
+            InMemoryCredentialsHandler.userCredentials[userId] = map;
         }
         catch (_b) {
             /* on error, no-op */
@@ -53,7 +53,7 @@ var InMemoryCredentialsHandler = /** @class */ (function () {
     };
     InMemoryCredentialsHandler.credentialIds = function (userId) {
         var _a;
-        var credentials = (_a = this.userCredentials[userId]) !== null && _a !== void 0 ? _a : {};
+        var credentials = (_a = InMemoryCredentialsHandler.userCredentials[userId]) !== null && _a !== void 0 ? _a : {};
         return Object.entries(credentials).map(function (_a) {
             var credential = _a[1];
             return new Uint8Array(credential.rawId).buffer;

package/dist/cjs/index.cjs

@@ -37,11 +37,27 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebAuthn = exports.KREIVO_AUTHORITY_ID = exports.InMemoryCredentialsHandler = void 0;
-var signer_1 = require("@virtonetwork/signer");
 var substrate_bindings_1 = require("@polkadot-api/substrate-bindings");
-var types_ts_1 = require("./types.cjs");
+/**
+ * WebAuthn pass‑key authenticator for Virto Network.
+ *
+ * Exposes a browser‑side implementation of {@link Authenticator} that creates,
+ * stores, and uses WebAuthn resident credentials ("passkeys") while producing
+ * SCALE‑encoded data structures understood by the Kreivo signer pallet.
+ *
+ * Responsibilities
+ * ─────────────────────────────────────────────────────────
+ * • Derive a deterministic `deviceId` from the raw credential id
+ * • Emit `TAttestation<number>` during registration
+ * • Emit `TPassAuthenticate` during authentication
+ * • Never persist the credential mapping; that is delegated to the caller
+ *
+ * @module WebAuthn
+ */
+var signer_1 = require("@virtonetwork/signer");
 var in_memory_credentials_handler_ts_1 = require("./in-memory-credentials-handler.cjs");
 Object.defineProperty(exports, "InMemoryCredentialsHandler", { enumerable: true, get: function () { return in_memory_credentials_handler_ts_1.InMemoryCredentialsHandler; } });
+var types_ts_1 = require("./types.cjs");
 /** Fixed authority id for Kreivo pass‑key attestors. */
 exports.KREIVO_AUTHORITY_ID = substrate_bindings_1.Binary.fromText("kreivo_p".padEnd(32, "\0"));
 /**

package/dist/esm/in-memory-credentials-handler.d.ts

@@ -1,4 +1,4 @@
-import { CredentialsHandler } from "./types.ts";
+import type { CredentialsHandler } from "./types.ts";
 export declare class InMemoryCredentialsHandler implements CredentialsHandler {
     private static userCredentials;
     private static tryMutate;

package/dist/esm/in-memory-credentials-handler.js

@@ -2,16 +2,16 @@ export class InMemoryCredentialsHandler {
     static userCredentials = {};
     static tryMutate(userId, f) {
         try {
-            let map = this.userCredentials[userId] ?? {};
+            const map = InMemoryCredentialsHandler.userCredentials[userId] ?? {};
             f(map);
-            this.userCredentials[userId] = map;
+            InMemoryCredentialsHandler.userCredentials[userId] = map;
         }
         catch {
             /* on error, no-op */
         }
     }
     static credentialIds(userId) {
-        const credentials = this.userCredentials[userId] ?? {};
+        const credentials = InMemoryCredentialsHandler.userCredentials[userId] ?? {};
         return Object.entries(credentials).map(([, credential]) => new Uint8Array(credential.rawId).buffer);
     }
     async onCreatedCredentials(userId, credential) {

package/dist/esm/index.d.ts

@@ -1,4 +1,5 @@
-import { AddressGenerator } from "@virtonetwork/signer";
+import { Binary } from "@polkadot-api/substrate-bindings";
+import type { Challenger, TPassAuthenticate } from "@virtonetwork/signer";
 /**
  * WebAuthn pass‑key authenticator for Virto Network.
  *
@@ -15,12 +16,10 @@ import { AddressGenerator } from "@virtonetwork/signer";
  *
  * @module WebAuthn
  */
-import { Authenticator } from "@virtonetwork/signer";
-import { Binary } from "@polkadot-api/substrate-bindings";
-import type { Challenger, TPassAuthenticate } from "@virtonetwork/signer";
-import type { CredentialsHandler, TAttestation } from "./types.ts";
+import { type AddressGenerator, type Authenticator } from "@virtonetwork/signer";
 import { InMemoryCredentialsHandler } from "./in-memory-credentials-handler.ts";
-export { InMemoryCredentialsHandler, CredentialsHandler };
+import type { CredentialsHandler, TAttestation } from "./types.ts";
+export { InMemoryCredentialsHandler, type CredentialsHandler };
 /** Fixed authority id for Kreivo pass‑key attestors. */
 export declare const KREIVO_AUTHORITY_ID: Binary;
 /**

package/dist/esm/index.js

@@ -1,7 +1,23 @@
-import { kreivoPassDefaultAddressGenerator, } from "@virtonetwork/signer";
 import { Binary, Blake2256 } from "@polkadot-api/substrate-bindings";
-import { Assertion } from "./types.js";
+/**
+ * WebAuthn pass‑key authenticator for Virto Network.
+ *
+ * Exposes a browser‑side implementation of {@link Authenticator} that creates,
+ * stores, and uses WebAuthn resident credentials ("passkeys") while producing
+ * SCALE‑encoded data structures understood by the Kreivo signer pallet.
+ *
+ * Responsibilities
+ * ─────────────────────────────────────────────────────────
+ * • Derive a deterministic `deviceId` from the raw credential id
+ * • Emit `TAttestation<number>` during registration
+ * • Emit `TPassAuthenticate` during authentication
+ * • Never persist the credential mapping; that is delegated to the caller
+ *
+ * @module WebAuthn
+ */
+import { kreivoPassDefaultAddressGenerator, } from "@virtonetwork/signer";
 import { InMemoryCredentialsHandler } from "./in-memory-credentials-handler.js";
+import { Assertion } from "./types.js";
 export { InMemoryCredentialsHandler };
 /** Fixed authority id for Kreivo pass‑key attestors. */
 export const KREIVO_AUTHORITY_ID = Binary.fromText("kreivo_p".padEnd(32, "\0"));

package/dist/esm/types.d.ts

@@ -1,6 +1,6 @@
-import { AuthorityId, DeviceId, HashedUserId } from "@virtonetwork/signer";
-import { Binary, HexString } from "@polkadot-api/substrate-bindings";
-import { Codec } from "scale-ts";
+import { type Binary, type HexString } from "@polkadot-api/substrate-bindings";
+import type { AuthorityId, DeviceId, HashedUserId } from "@virtonetwork/signer";
+import { type Codec } from "scale-ts";
 export type BlockHash = HexString;
 export type hashedUserId = (userId: string) => Promise<Uint8Array>;
 export interface CredentialsHandler {

package/dist/esm/types.js

@@ -1,4 +1,4 @@
-import { Bin } from "@polkadot-api/substrate-bindings";
+import { Bin, } from "@polkadot-api/substrate-bindings";
 import { Struct, u32 } from "scale-ts";
 const AttestationMeta = Struct({
     authority_id: Bin(32),

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@virtonetwork/authenticators-webauthn",
   "description": "An Authenticator compatible with KreivoPassSigner that uses the WebAuthn standard",
-  "version": "1.2.2",
+  "homepage": "https://virtonetwork.github.io/papi-signers/guide/webauthn",
+  "version": "1.2.4",
   "type": "module",
   "files": [
     "dist"
@@ -20,7 +21,7 @@
   "browser": "./dist/esm/index.js",
   "types": "./dist/esm/index.d.ts",
   "scripts": {
-    "test": "node --loader ts-node/esm test/test.ts",
+    "test": "tsx test/test.ts",
     "build": "tsc && tsc -p tsconfig.cjs.json && node ../../scripts/fix-cjs.js dist/cjs",
     "prepack": "npm run build"
   },
@@ -36,13 +37,13 @@
   ],
   "dependencies": {
     "@simplewebauthn/server": "^13.1.1",
-    "@virtonetwork/signer": "^1.2.0",
+    "@virtonetwork/signer": "^1.3.0",
     "nid-webauthn-emulator": "^0.2.4"
   },
   "devDependencies": {
+    "@levischuck/tiny-cbor": "^0.2.11",
     "esmock": "^2.7.0",
-    "sinon": "^20.0.0",
-    "ts-node": "^10.9.2"
+    "sinon": "^20.0.0"
   },
   "repository": {
     "url": "https://github.com/virto-network/papi-signers",
@@ -50,6 +51,7 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "provenance": true
   }
-}
+}

package/dist/cjs/package.json

@@ -1 +0,0 @@
-{"type": "commonjs"}