@passlock/client 2.0.1 → 2.0.3

package/dist/passkey/registration/registration.d.ts

@@ -0,0 +1,149 @@
+import * as Helper from "@simplewebauthn/browser";
+import { type PublicKeyCredentialCreationOptionsJSON, type RegistrationResponseJSON } from "@simplewebauthn/browser";
+import { Micro } from "effect";
+import type { Principal } from "src/principal";
+import { Endpoint, TenancyId } from "../../internal";
+import type { NetworkError } from "../../internal/network";
+import { Logger } from "../../logger";
+import type { PasslockOptions } from "../../options";
+import { DuplicatePasskeyError, OtherPasskeyError, PasskeyUnsupportedError } from "../errors";
+import type { Millis, UserVerification } from "../shared";
+/**
+ * Passkey registration options
+ *
+ * @see {@link registerPasskey}
+ *
+ * @category Passkeys (core)
+ */
+export interface RegistrationOptions extends PasslockOptions {
+    /**
+     * Username associated with passkey. Will be shown by the device during
+     * registration and subsequent authentication. The value used should be
+     * meaningful to the user e.g. jdoe or jdoe@gmail.com vs 5487546.
+     *
+     * You won't directly associate the username with an account in your
+     * backend. Instead, you'll associate the passkey ID with an account.
+     *
+     * @see {@link https://passlock.dev/passkeys/registration Register a passkey (main docs)}
+     */
+    username: string;
+    /**
+     * May be shown by devices in place of the username e.g. given a username
+     * of jdoe or jdoe@gmail.com a suitable display name might be "John Doe"
+     * or "John Doe (personal)". **note:** There's no guarantee browsers/devices
+     * will choose to display this property.
+     */
+    userDisplayName?: string | undefined;
+    /**
+     * Prevents the user registering a passkey if they already have one
+     * (associated with the same user account) registered on the current device.
+     *
+     * @see {@link https://passlock.dev/passkeys/exclude-credentials Excluding credentials (main docs)}
+     */
+    excludeCredentials?: Array<string> | undefined;
+    /**
+     * Whether the device should re-authenticate the user locally before registering the passkey.
+     *
+     * @see {@link https://passlock.dev/passkeys/user-verification User verification (main docs)}
+     */
+    userVerification?: UserVerification | undefined;
+    /**
+     * Receive notifications about key stages in the registration process.
+     * For example, you might use event notifications to toggle loading icons or
+     * to disable certain form fields.
+     */
+    onEvent?: OnRegistrationEvent;
+    /**
+     * Abort the operation after N milliseconds
+     */
+    timeout?: Millis | undefined;
+}
+/**
+ * Represents the outcome of a successful passkey registration.
+ * Submit the `code` and/or `id_token` to your backend, then either
+ * exchange the code with the Passlock REST API or decode and
+ * verify the id_token (JWT). **note:** The @passlock/node library
+ * includes utilities for this.
+ *
+ * @see {@link isRegistrationSuccess}
+ *
+ * @category Passkeys (core)
+ */
+export type RegistrationSuccess = {
+    /**
+     * Discriminator for use in a discriminated union.
+     */
+    _tag: "RegistrationSuccess";
+    principal: Principal;
+    /**
+     * A signed JWT representing the newly registered passkey.
+     * Decode and verify this in your backend or use one of the @passlock/node
+     * helper utilities.
+     *
+     * @see {@link https://passlock.dev/principal/idtoken-verification/|id_token}
+     */
+    id_token: string;
+    /**
+     * Call the Passlock API to exchange this code for details about the newly
+     * registered passkey.
+     *
+     * @see {@link https://passlock.dev/principal/code-exchange/|code exchange}
+     */
+    code: string;
+};
+/**
+ * Type guard to test for a {@link RegistrationSuccess}. Typically used to test the
+ * object returned from {@link registerPasskey}
+ *
+ * @param payload
+ * @returns `true` if the payload is a {@link RegistrationSuccess}.
+ *
+ * @category Passkeys (other)
+ */
+export declare const isRegistrationSuccess: (payload: unknown) => payload is RegistrationSuccess;
+export type OptionsResponse = {
+    sessionToken: string;
+    optionsJSON: PublicKeyCredentialCreationOptionsJSON;
+};
+export declare const isOptionsResponse: (payload: unknown) => payload is OptionsResponse;
+export declare const fetchOptions: (options: Omit<RegistrationOptions, keyof PasslockOptions>) => Micro.Micro<OptionsResponse, NetworkError, Endpoint | TenancyId | Logger>;
+export declare const startRegistration: (optionsJSON: PublicKeyCredentialCreationOptionsJSON, { onEvent }: {
+    onEvent?: OnRegistrationEvent | undefined;
+}) => Micro.Micro<Helper.RegistrationResponseJSON, PasskeyUnsupportedError | OtherPasskeyError | DuplicatePasskeyError, Logger | RegistrationHelper>;
+export declare const verifyCredential: (sessionToken: string, response: RegistrationResponseJSON, { onEvent }: {
+    onEvent?: OnRegistrationEvent | undefined;
+}) => Micro.Micro<RegistrationSuccess, NetworkError, Endpoint | TenancyId | Logger>;
+/**
+ * Potential errors associated with Passkey registration
+ *
+ * @category Passkeys (errors)
+ */
+export type RegistrationError = PasskeyUnsupportedError | DuplicatePasskeyError | OtherPasskeyError | NetworkError;
+/**
+ * Trigger local passkey registration then save the passkey in your Passlock vault.
+ * Returns a code and id_token that can be exchanged/decoded in your backend.
+ *
+ * @param options
+ * @returns A Micro effect that resolves with {@link RegistrationSuccess} or
+ * fails with {@link RegistrationError}.
+ */
+export declare const registerPasskey: (options: RegistrationOptions) => Micro.Micro<RegistrationSuccess, RegistrationError, Logger | RegistrationHelper>;
+/**
+ * Type of the registration event
+ *
+ * @category Passkeys (other)
+ */
+export declare const RegistrationEvents: readonly ["optionsRequest", "createCredential", "saveCredential"];
+/**
+ * Type of the registration event
+ *
+ * @category Passkeys (other)
+ */
+export type RegistrationEvent = "optionsRequest" | "createCredential" | "saveCredential";
+/**
+ * Callback to receive registration lifecycle events.
+ *
+ * @category Passkeys (other)
+ */
+export type OnRegistrationEvent = (event: RegistrationEvent) => void;
+//# sourceMappingURL=registration.d.ts.map

package/dist/passkey/registration/registration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registration.d.ts","sourceRoot":"","sources":["../../../src/passkey/registration/registration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,yBAAyB,CAAA;AACjD,OAAO,EACL,KAAK,sCAAsC,EAC3C,KAAK,wBAAwB,EAE9B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAW,KAAK,EAAQ,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,QAAQ,EAA6B,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AACpD,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,WAAW,CAAA;AAClB,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAEzD;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEpC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAE9C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAA;IAE/C;;;;OAIG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC7B;AAmBD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAA;IAE3B,SAAS,EAAE,SAAS,CAAA;IAEpB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,SAAS,OAAO,KACf,OAAO,IAAI,mBAOb,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,sCAAsC,CAAA;CACpD,CAAA;AAED,eAAO,MAAM,iBAAiB,GAC5B,SAAS,OAAO,KACf,OAAO,IAAI,eAYb,CAAA;AAED,eAAO,MAAM,YAAY,GACvB,SAAS,IAAI,CAAC,mBAAmB,EAAE,MAAM,eAAe,CAAC,8EAmCvD,CAAA;AAEJ,eAAO,MAAM,iBAAiB,GAC5B,aAAa,sCAAsC,EACnD,aAAa;IAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAA;CAAE,mJAoCxD,CAAA;AAEJ,eAAO,MAAM,gBAAgB,GAC3B,cAAc,MAAM,EACpB,UAAU,wBAAwB,EAClC,aAAa;IAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAA;CAAE,kFAgCxD,CAAA;AAEJ;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,uBAAuB,GACvB,qBAAqB,GACrB,iBAAiB,GACjB,YAAY,CAAA;AAEhB;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,mBAAmB,KAC3B,KAAK,CAAC,KAAK,CACZ,mBAAmB,EACnB,iBAAiB,EACjB,MAAM,GAAG,kBAAkB,CAmB5B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,mEAIrB,CAAA;AAEV;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,CAAA;AAEpB;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAA"}

package/dist/passkey/{registration.js → registration/registration.js}

@@ -1,26 +1,40 @@
 import * as Helper from "@simplewebauthn/browser";
 import { WebAuthnError, } from "@simplewebauthn/browser";
 import { Context, Micro, pipe } from "effect";
-import { Logger } from "../logger";
-import { buildEndpoint, Endpoint, makeRequest } from "../shared/network";
-import { TenancyId } from "../shared/tenancy";
-import { OtherPasskeyError, PasskeyUnsupportedError } from "./errors";
+import { Endpoint, makeEndpoint, makeRequest, TenancyId } from "../../internal";
+import { Logger } from "../../logger";
+import { DuplicatePasskeyError, OtherPasskeyError, PasskeyUnsupportedError, } from "../errors";
+/**
+ * @internal
+ * @hidden
+ */
 export class RegistrationHelper extends Context.Tag("RegistrationHelper")() {
     static Default = {
         browserSupportsWebAuthn: Helper.browserSupportsWebAuthn,
         startRegistration: Helper.startRegistration,
     };
 }
-export const isDuplicatePasskey = (err) => err instanceof DuplicatePasskeyError;
 /**
- * Raised if excludeCredentials or userId was provided and the
- * device recognises one of the passkey ids i.e. the user currently
- * has a passkey registered on the current device for a given userId.
+ * Type guard to test for a {@link RegistrationSuccess}. Typically used to test the
+ * object returned from {@link registerPasskey}
+ *
+ * @param payload
+ * @returns `true` if the payload is a {@link RegistrationSuccess}.
+ *
+ * @category Passkeys (other)
  */
-export class DuplicatePasskeyError extends Micro.TaggedError("@error/DuplicatePasskey") {
-    static isDuplicatePasskey = isDuplicatePasskey;
-}
-const isOptionsResponse = (payload) => {
+export const isRegistrationSuccess = (payload) => {
+    if (typeof payload !== "object")
+        return false;
+    if (payload === null)
+        return false;
+    if (!("_tag" in payload))
+        return false;
+    if (typeof payload._tag !== "string")
+        return false;
+    return payload._tag === "RegistrationSuccess";
+};
+export const isOptionsResponse = (payload) => {
     if (typeof payload !== "object")
         return false;
     if (payload === null)
@@ -37,12 +51,11 @@ const isOptionsResponse = (payload) => {
         return false;
     return true;
 };
-export const registrationEvent = ["optionsRequest", "createCredential", "saveCredential"];
 export const fetchOptions = (options) => Micro.gen(function* () {
     const logger = yield* Micro.service(Logger);
     const { endpoint } = yield* Micro.service(Endpoint);
     const { tenancyId } = yield* Micro.service(TenancyId);
-    const { username, userDisplayName, userId, excludeCredentials, userVerification, timeout, onEvent, } = options;
+    const { username, userDisplayName, excludeCredentials, userVerification, timeout, onEvent, } = options;
     const url = new URL(`${tenancyId}/passkey/registration/options`, endpoint);
     onEvent?.("optionsRequest");
     yield* logger.logInfo("Fetching passkey registration options from Passlock");
@@ -50,7 +63,6 @@ export const fetchOptions = (options) => Micro.gen(function* () {
         excludeCredentials,
         timeout,
         userDisplayName,
-        userId,
         username,
         userVerification,
     };
@@ -61,20 +73,6 @@ export const fetchOptions = (options) => Micro.gen(function* () {
         url,
     });
 });
-const RegistrationSuccessTag = "RegistrationSuccess";
-export const isRegistrationSuccess = (payload) => {
-    if (typeof payload !== "object")
-        return false;
-    if (payload === null)
-        return false;
-    if (!("_tag" in payload))
-        return false;
-    if (typeof payload._tag !== "string")
-        return false;
-    if (payload._tag !== RegistrationSuccessTag)
-        return false;
-    return true;
-};
 export const startRegistration = (optionsJSON, { onEvent }) => Micro.gen(function* () {
     onEvent?.("createCredential");
     const logger = yield* Micro.service(Logger);
@@ -82,10 +80,11 @@ export const startRegistration = (optionsJSON, { onEvent }) => Micro.gen(functio
     const helper = yield* Micro.service(RegistrationHelper);
     const isSupport = helper.browserSupportsWebAuthn();
     if (!isSupport)
-        yield* new PasskeyUnsupportedError({
+        yield* Micro.fail(new PasskeyUnsupportedError({
             message: "Device does not support passkeys",
-        });
+        }));
     return yield* Micro.tryPromise({
+        try: () => helper.startRegistration({ optionsJSON }),
         catch: (error) => {
             if (error instanceof WebAuthnError &&
                 error.code === "ERROR_AUTHENTICATOR_PREVIOUSLY_REGISTERED") {
@@ -102,7 +101,6 @@ export const startRegistration = (optionsJSON, { onEvent }) => Micro.gen(functio
                 return new OtherPasskeyError({ error, message: "Unexpected error" });
             }
         },
-        try: () => helper.startRegistration({ optionsJSON }),
     });
 });
 export const verifyCredential = (sessionToken, response, { onEvent }) => Micro.gen(function* () {
@@ -126,13 +124,15 @@ export const verifyCredential = (sessionToken, response, { onEvent }) => Micro.g
     return registrationResponse;
 });
 /**
- * Register a passkey on the local device and store the
- * associated public key in the Passlock vault.
+ * Trigger local passkey registration then save the passkey in your Passlock vault.
+ * Returns a code and id_token that can be exchanged/decoded in your backend.
+ *
  * @param options
- * @returns
+ * @returns A Micro effect that resolves with {@link RegistrationSuccess} or
+ * fails with {@link RegistrationError}.
  */
 export const registerPasskey = (options) => {
-    const endpoint = buildEndpoint(options);
+    const endpoint = makeEndpoint(options);
     const effect = Micro.gen(function* () {
         const { sessionToken, optionsJSON } = yield* fetchOptions(options);
         const response = yield* startRegistration(optionsJSON, {
@@ -144,4 +144,14 @@ export const registerPasskey = (options) => {
     });
     return pipe(effect, Micro.provideService(TenancyId, options), Micro.provideService(Endpoint, endpoint));
 };
+/**
+ * Type of the registration event
+ *
+ * @category Passkeys (other)
+ */
+export const RegistrationEvents = [
+    "optionsRequest",
+    "createCredential",
+    "saveCredential",
+];
 //# sourceMappingURL=registration.js.map

package/dist/passkey/registration/registration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registration.js","sourceRoot":"","sources":["../../../src/passkey/registration/registration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAGL,aAAa,GACd,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7C,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/E,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAErC,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,WAAW,CAAA;AA2DlB;;;GAGG;AACH,MAAM,OAAO,kBAAmB,SAAQ,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,EAMtE;IACD,MAAM,CAAC,OAAO,GAAG;QACf,uBAAuB,EAAE,MAAM,CAAC,uBAAuB;QACvD,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;KACA,CAAA;;AAuC/C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,OAAgB,EACgB,EAAE;IAClC,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC7C,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,KAAK,CAAA;IAElC,IAAI,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACtC,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAClD,OAAO,OAAO,CAAC,IAAI,KAAK,qBAAqB,CAAA;AAC/C,CAAC,CAAA;AAOD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,OAAgB,EACY,EAAE;IAC9B,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC7C,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,KAAK,CAAA;IAElC,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IAC7C,IAAI,OAAO,OAAO,CAAC,WAAW,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IACzD,IAAI,OAAO,CAAC,WAAW,KAAK,IAAI;QAAE,OAAO,KAAK,CAAA;IAE9C,IAAI,CAAC,CAAC,cAAc,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IAC9C,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAE1D,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,OAAyD,EACzD,EAAE,CACF,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;IACjB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC3C,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IACnD,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAErD,MAAM,EACJ,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,OAAO,EACP,OAAO,GACR,GAAG,OAAO,CAAA;IAEX,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,SAAS,+BAA+B,EAAE,QAAQ,CAAC,CAAA;IAE1E,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAA;IAC3B,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,qDAAqD,CAAC,CAAA;IAE5E,MAAM,OAAO,GAAG;QACd,kBAAkB;QAClB,OAAO;QACP,eAAe;QACf,QAAQ;QACR,gBAAgB;KACjB,CAAA;IAED,OAAO,KAAK,CAAC,CAAC,WAAW,CAAC;QACxB,KAAK,EAAE,sBAAsB;QAC7B,OAAO;QACP,iBAAiB,EAAE,iBAAiB;QACpC,GAAG;KACJ,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,WAAmD,EACnD,EAAE,OAAO,EAAiD,EAC1D,EAAE,CACF,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;IACjB,OAAO,EAAE,CAAC,kBAAkB,CAAC,CAAA;IAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC3C,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAA;IAEtD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAEvD,MAAM,SAAS,GAAG,MAAM,CAAC,uBAAuB,EAAE,CAAA;IAClD,IAAI,CAAC,SAAS;QACZ,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CACf,IAAI,uBAAuB,CAAC;YAC1B,OAAO,EAAE,kCAAkC;SAC5C,CAAC,CACH,CAAA;IAEH,OAAO,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;QAC7B,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,CAAC;QACpD,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;YACf,IACE,KAAK,YAAY,aAAa;gBAC9B,KAAK,CAAC,IAAI,KAAK,2CAA2C,EAC1D,CAAC;gBACD,OAAO,IAAI,qBAAqB,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,KAAK,YAAY,aAAa,EAAE,CAAC;gBAC1C,OAAO,IAAI,iBAAiB,CAAC;oBAC3B,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,OAAO,EAAE,KAAK,CAAC,OAAO;iBACvB,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC,CAAA;YACtE,CAAC;QACH,CAAC;KACF,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,YAAoB,EACpB,QAAkC,EAClC,EAAE,OAAO,EAAiD,EAC1D,EAAE,CACF,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;IACjB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC3C,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IACnD,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAErD,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,GAAG,SAAS,oCAAoC,EAChD,QAAQ,CACT,CAAA;IAED,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAA;IAC3B,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,uCAAuC,CAAC,CAAA;IAE9D,MAAM,OAAO,GAAG;QACd,QAAQ;QACR,YAAY;KACb,CAAA;IAED,MAAM,oBAAoB,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC;QAC9C,KAAK,EAAE,2BAA2B;QAClC,OAAO;QACP,iBAAiB,EAAE,qBAAqB;QACxC,GAAG;KACJ,CAAC,CAAA;IAEF,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CACnB,8BAA8B,oBAAoB,CAAC,SAAS,CAAC,eAAe,EAAE,CAC/E,CAAA;IAED,OAAO,oBAAoB,CAAA;AAC7B,CAAC,CAAC,CAAA;AAaJ;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,OAA4B,EAK5B,EAAE;IACF,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;IAEtC,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;QAChC,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAClE,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,iBAAiB,CAAC,WAAW,EAAE;YACrD,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;QACF,OAAO,KAAK,CAAC,CAAC,gBAAgB,CAAC,YAAY,EAAE,QAAQ,EAAE;YACrD,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,OAAO,IAAI,CACT,MAAM,EACN,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,EACxC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CACzC,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,gBAAgB;IAChB,kBAAkB;IAClB,gBAAgB;CACR,CAAA"}

package/dist/passkey/shared.d.ts

@@ -1,3 +1,10 @@
+/**
+ * https://w3c.github.io/webauthn/#user-verification
+ *
+ * @see {@link https://passlock.dev/passkeys/user-verification/ User verification (main docs site)}
+ *
+ * @category Passkeys (core)
+ */
 export type UserVerification = "discouraged" | "preferred" | "required";
 /**
  * https://w3c.github.io/webauthn/#enumdef-publickeycredentialhint
@@ -10,7 +17,7 @@ export type AttestationFormat = "fido-u2f" | "packed" | "android-safetynet" | "a
 /**
  * https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptionsjson
  */
-export interface PublicKeyCredentialCreationOptionsJSON {
+export type PublicKeyCredentialCreationOptionsJSON = {
     rp: PublicKeyCredentialRpEntity;
     user: PublicKeyCredentialUserEntityJSON;
     challenge: Base64URLString;
@@ -22,5 +29,6 @@ export interface PublicKeyCredentialCreationOptionsJSON {
     attestation?: AttestationConveyancePreference;
     attestationFormats?: Array<AttestationFormat>;
     extensions?: AuthenticationExtensionsClientInputs;
-}
+};
+export type Millis = number;
 //# sourceMappingURL=shared.d.ts.map

package/dist/passkey/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/passkey/shared.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,CAAA;AAEvE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,QAAQ,GAAG,cAAc,GAAG,eAAe,CAAA;AAEjF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,aAAa,GACb,KAAK,GACL,OAAO,GACP,MAAM,CAAA;AAEV;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,EAAE,EAAE,2BAA2B,CAAA;IAC/B,IAAI,EAAE,iCAAiC,CAAA;IACvC,SAAS,EAAE,eAAe,CAAA;IAC1B,gBAAgB,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAA;IACtD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAA;IAC7D,sBAAsB,CAAC,EAAE,8BAA8B,CAAA;IACvD,KAAK,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAA;IACtC,WAAW,CAAC,EAAE,+BAA+B,CAAA;IAC7C,kBAAkB,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAC7C,UAAU,CAAC,EAAE,oCAAoC,CAAA;CAClD"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/passkey/shared.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,CAAA;AAEvE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B,QAAQ,GACR,cAAc,GACd,eAAe,CAAA;AAEnB;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,aAAa,GACb,KAAK,GACL,OAAO,GACP,MAAM,CAAA;AAEV;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,EAAE,EAAE,2BAA2B,CAAA;IAC/B,IAAI,EAAE,iCAAiC,CAAA;IACvC,SAAS,EAAE,eAAe,CAAA;IAC1B,gBAAgB,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAA;IACtD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAA;IAC7D,sBAAsB,CAAC,EAAE,8BAA8B,CAAA;IACvD,KAAK,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAA;IACtC,WAAW,CAAC,EAAE,+BAA+B,CAAA;IAC7C,kBAAkB,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAC7C,UAAU,CAAC,EAAE,oCAAoC,CAAA;CAClD,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA"}

package/dist/passkey/signals/signals.d.ts

@@ -0,0 +1,160 @@
+import { Micro } from "effect";
+import { Logger } from "../../logger";
+import type { PasslockOptions } from "../../options";
+import { DeleteError, type OrphanedPasskeyError, PruningError, UpdateError } from "../errors";
+/**
+ * Does the current device support local passkey removal
+ */
+export declare const isPasskeyDeleteSupport: Micro.Micro<boolean, never, never>;
+/**
+ * Does the current device support local passkey pruning
+ */
+export declare const isPasskeyPruningSupport: Micro.Micro<boolean, never, never>;
+/**
+ * Does the current device support local passkey updates
+ */
+export declare const isPasskeyUpdateSupport: Micro.Micro<boolean, never, never>;
+export interface DeletePasskeyOptions extends PasslockOptions {
+    passkeyId: string;
+}
+export interface DeleteCredentialOptions extends PasslockOptions {
+    credentialId: string;
+    userId: string;
+    rpId: string;
+}
+/**
+ * Instruct the device to remove a passkey. E.g. attempt to remove it from
+ * Apple Password Manager / iCloud.
+ *
+ * @param options Passkey identifier/credential details and Passlock tenancy options.
+ * @returns A Micro effect that resolves with a {@link DeleteSuccess} or fails with {@link DeleteError}.
+ */
+export declare const deletePasskey: (options: DeletePasskeyOptions | DeleteCredentialOptions | OrphanedPasskeyError) => Micro.Micro<DeleteSuccess, DeleteError, Logger>;
+export interface PrunePasskeyOptions extends PasslockOptions {
+    allowablePasskeyIds: Array<string>;
+}
+export type PruningSuccess = {
+    _tag: "PruningSuccess";
+};
+export declare const isPruningSuccess: (payload: unknown) => payload is PruningSuccess;
+/**
+ * Given a list of passkey IDs, instruct the device to remove any redundant passkeys.
+ *
+ * Note: this will only remove redundant passkeys (based on the userId).
+ *
+ * For example:
+ *
+ * The user has two passkeys registered against the jdoe@gmail.com account: passkey1
+ * and passkey2. The user has another passkey (passkey3) registered against the
+ * jdoe@work.com account.
+ *
+ * If you pass in the id for passkey1, the device will recognise it's assigned to the
+ * jdoe@gmail.com account and remove passkey2. However as passkey3 is registered to a
+ * different account, the device will retain it.
+ *
+ * @param options Passlock tenancy/endpoint options and the passkey IDs to keep.
+ * @returns A Micro effect that resolves with a {@link PruningSuccess} or fails with {@link PruningError}.
+ */
+export declare const prunePasskeys: (options: PrunePasskeyOptions) => Micro.Micro<PruningSuccess, PruningError, Logger>;
+/**
+ * Used when you want to update a local device passkey by Passkey ID aka authenticatorId.
+ *
+ * @see {@link updatePasskey}
+ *
+ * @category Passkeys (core)
+ */
+export interface UpdatePasskeyOptions extends PasslockOptions {
+    /**
+     * The Passlock passkey id
+     */
+    passkeyId: string;
+    /**
+     * New username
+     */
+    username: string;
+    /**
+     * New display name
+     */
+    displayName?: string | undefined;
+}
+/**
+ * Used when you want to update one or more passkeys by the Credential User ID i.e. the
+ * immutable Base64Url encoded binary ID.
+ *
+ * @see {@link updatePasskey}
+ * @see {@link https://passlock.dev/rest-api/credential/ The Credential property (main docs site)}
+ *
+ * @category Passkeys (core)
+ */
+export interface UpdateCredentialOptions extends PasslockOptions {
+    userId: string;
+    rpId: string;
+    /**
+     * New username
+     */
+    username: string;
+    /**
+     * New display name
+     */
+    displayName?: string | undefined;
+}
+export type UpdateSuccess = {
+    _tag: "UpdateSuccess";
+};
+export declare const isUpdateSuccess: (payload: unknown) => payload is UpdateSuccess;
+/**
+ * Update a passkey e.g. change the username and/or display name.
+ * Note: this is purely informational, it does not change any identifiers.
+ * The typical use case is when a user changes their account email, you would
+ * want to change the username in your backend system and also the user's
+ * device local passkey. Otherwise the passkey associated with your new-name@gmail.com
+ * account would still show up in their password manager as old-name@gmail.com.
+ *
+ * @param options Passkey update options.
+ * @returns A Micro effect that resolves with a {@link UpdateSuccess} or fails with {@link UpdateError}.
+ */
+export declare const updatePasskey: (options: UpdatePasskeyOptions | UpdateCredentialOptions) => Micro.Micro<{
+    readonly _tag: "UpdateSuccess";
+}, UpdateError, Logger>;
+export type CredentialMapping = {
+    credentialId: string;
+    userId: string;
+    rpId: string;
+};
+export type CredentialMappings = {
+    rpId: string;
+    userId: string;
+    allAcceptedCredentialIds: string[];
+};
+type IPasskeyNotFound = {
+    message: string;
+    credentialId: string;
+    rpId: string;
+};
+export type DeleteSuccess = {
+    _tag: "DeleteSuccess";
+};
+export declare const isDeleteSuccess: (payload: unknown) => payload is DeleteSuccess;
+/**
+ * Tell the client device to remove a given credential
+ *
+ * @param credential Credential mapping or missing-passkey payload.
+ * @returns A Micro effect that resolves with a {@link DeleteSuccess} or fails with {@link DeleteError}.
+ */
+export declare const signalCredentialRemoval: (credential: CredentialMapping | IPasskeyNotFound) => Micro.Micro<DeleteSuccess, DeleteError, Logger>;
+/**
+ * Tell the client device which credentials are still accepted for a user.
+ *
+ * @param credentials Accepted credential mapping for the user.
+ * @returns A Micro effect that resolves with a {@link PruningSuccess} or fails with {@link PruningError}.
+ */
+export declare const signalAcceptedCredentials: (credentials: CredentialMappings) => Micro.Micro<PruningSuccess, PruningError, Logger>;
+export type CredentialUserId = {
+    userId: string;
+    rpId: string;
+};
+export declare const signalCurrentUserDetails: (credential: CredentialUserId, updates: Pick<UpdatePasskeyOptions, "username" | "displayName">) => Micro.Micro<{
+    readonly _tag: "UpdateSuccess";
+}, UpdateError, Logger>;
+export {};
+//# sourceMappingURL=signals.d.ts.map

package/dist/passkey/signals/signals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signals.d.ts","sourceRoot":"","sources":["../../../src/passkey/signals/signals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAQ,MAAM,QAAQ,CAAA;AAGpC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AACpD,OAAO,EACL,WAAW,EACX,KAAK,oBAAoB,EACzB,YAAY,EACZ,WAAW,EACZ,MAAM,WAAW,CAAA;AAElB;;GAEG;AACH,eAAO,MAAM,sBAAsB,oCAKjC,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,oCAKlC,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,oCAKjC,CAAA;AAEF,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GACxB,SAAS,oBAAoB,GAAG,uBAAuB,GAAG,oBAAoB,oDAmB5E,CAAA;AAkCJ,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CACnC;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,gBAAgB,CAAA;CACvB,CAAA;AAED,eAAO,MAAM,gBAAgB,GAC3B,SAAS,OAAO,KACf,OAAO,IAAI,cAMb,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,aAAa,GAAI,SAAS,mBAAmB,sDA2CtD,CAAA;AAEJ;;;;;;GAMG;AACH,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACjC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACjC;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,eAAe,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,eAAe,GAAI,SAAS,OAAO,KAAG,OAAO,IAAI,aAM7D,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,GACxB,SAAS,oBAAoB,GAAG,uBAAuB;;uBAmBrD,CAAA;AAoCJ,MAAM,MAAM,iBAAiB,GAAG;IAC9B,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAoBD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,wBAAwB,EAAE,MAAM,EAAE,CAAA;CACnC,CAAA;AAoBD,KAAK,gBAAgB,GAAG;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,eAAe,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,eAAe,GAAI,SAAS,OAAO,KAAG,OAAO,IAAI,aAM7D,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAClC,YAAY,iBAAiB,GAAG,gBAAgB,KAC/C,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,WAAW,EAAE,MAAM,CAqC7C,CAAA;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GACpC,aAAa,kBAAkB,KAC9B,KAAK,CAAC,KAAK,CAAC,cAAc,EAAE,YAAY,EAAE,MAAM,CAqC/C,CAAA;AAEJ,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,eAAO,MAAM,wBAAwB,GACnC,YAAY,gBAAgB,EAC5B,SAAS,IAAI,CAAC,oBAAoB,EAAE,UAAU,GAAG,aAAa,CAAC;;uBAyC7D,CAAA"}