@corbado/observe 1.7.1 → 1.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -2974,7 +2974,7 @@ declare class EventStore<T = Event> {
2974
2974
  type WebAuthnIdentifierProjector = (value: string) => string | null | undefined;
2975
2975
  /**
2976
2976
  * Optional user identifier projection shared by native WebAuthn capture and network serializers.
2977
- * A missing callback preserves user identifiers. Callbacks should be deterministic across payloads.
2977
+ * A missing callback omits user identifiers. Callbacks should be deterministic across payloads.
2978
2978
  * Credential IDs and encoded attestation/authenticator data are retained unchanged.
2979
2979
  */
2980
2980
  type WebAuthnIdentifierProjectors = {
@@ -2983,10 +2983,10 @@ type WebAuthnIdentifierProjectors = {
2983
2983
  };
2984
2984
  /**
2985
2985
  * Serializes WebAuthn creation options, removing `user.name` and `user.displayName`.
2986
- * Binary values become base64url strings. User IDs are retained unless a projector is supplied.
2986
+ * Binary values become base64url strings. `user.id` is omitted unless a projector is supplied.
2987
2987
  *
2988
2988
  * @param value - Native publicKey options, a JSON object, or JSON text; not an application envelope.
2989
- * @param projectors - Optional synchronous user identifier projection; default identity.
2989
+ * @param projectors - Optional synchronous user identifier projection; default omits user identifiers.
2990
2990
  * @returns JSON text, or undefined for malformed or unserializable input.
2991
2991
  * @remarks Does not mutate input, read blacklisted getters, or call toJSON. No tracker initialization is required.
2992
2992
  * @example
@@ -2998,10 +2998,10 @@ type WebAuthnIdentifierProjectors = {
2998
2998
  declare function sanitizeCreationOptions(value: unknown, projectors?: WebAuthnIdentifierProjectors): string | undefined;
2999
2999
  /**
3000
3000
  * Serializes a registration credential, removing `clientExtensionResults.prf.results`.
3001
- * By default other fields remain, including attestation material and credential IDs. Binary values become base64url strings.
3001
+ * `response.userHandle` is omitted unless a projector is supplied. By default other fields remain, including attestation material and credential IDs. Binary values become base64url strings.
3002
3002
  *
3003
3003
  * @param value - A native registration credential, JSON object, or JSON text; not an application envelope.
3004
- * @param projectors - Optional synchronous user identifier projection; default identity.
3004
+ * @param projectors - Optional synchronous user identifier projection; default omits user identifiers.
3005
3005
  * @returns JSON text, or undefined for malformed or unserializable input.
3006
3006
  * @remarks Does not mutate input, read blacklisted getters, or call toJSON. Encoded attestation and client-data blobs are not decoded or redacted.
3007
3007
  */
@@ -3017,10 +3017,11 @@ declare function sanitizeCreationResponse(value: unknown, projectors?: WebAuthnI
3017
3017
  declare function sanitizeRequestOptions(value: unknown): string | undefined;
3018
3018
  /**
3019
3019
  * Serializes an authentication credential, removing `response.signature` and `clientExtensionResults.prf.results`.
3020
- * By default other fields remain, including credential IDs and user handles. Binary values become base64url strings.
3020
+ * `response.userHandle` is omitted unless a projector is supplied. Other fields remain, including credential IDs.
3021
+ * Binary values become base64url strings.
3021
3022
  *
3022
3023
  * @param value - A native authentication credential, JSON object, or JSON text; not an application envelope.
3023
- * @param projectors - Optional synchronous user identifier projection; default identity.
3024
+ * @param projectors - Optional synchronous user identifier projection; default omits user identifiers.
3024
3025
  * @returns JSON text, or undefined for malformed or unserializable input.
3025
3026
  * @remarks Does not mutate input, read blacklisted getters, or call toJSON. This is a path blacklist, not general-purpose secret detection; encoded client-data blobs are not decoded or redacted.
3026
3027
  */
package/dist/index.d.ts CHANGED
@@ -2974,7 +2974,7 @@ declare class EventStore<T = Event> {
2974
2974
  type WebAuthnIdentifierProjector = (value: string) => string | null | undefined;
2975
2975
  /**
2976
2976
  * Optional user identifier projection shared by native WebAuthn capture and network serializers.
2977
- * A missing callback preserves user identifiers. Callbacks should be deterministic across payloads.
2977
+ * A missing callback omits user identifiers. Callbacks should be deterministic across payloads.
2978
2978
  * Credential IDs and encoded attestation/authenticator data are retained unchanged.
2979
2979
  */
2980
2980
  type WebAuthnIdentifierProjectors = {
@@ -2983,10 +2983,10 @@ type WebAuthnIdentifierProjectors = {
2983
2983
  };
2984
2984
  /**
2985
2985
  * Serializes WebAuthn creation options, removing `user.name` and `user.displayName`.
2986
- * Binary values become base64url strings. User IDs are retained unless a projector is supplied.
2986
+ * Binary values become base64url strings. `user.id` is omitted unless a projector is supplied.
2987
2987
  *
2988
2988
  * @param value - Native publicKey options, a JSON object, or JSON text; not an application envelope.
2989
- * @param projectors - Optional synchronous user identifier projection; default identity.
2989
+ * @param projectors - Optional synchronous user identifier projection; default omits user identifiers.
2990
2990
  * @returns JSON text, or undefined for malformed or unserializable input.
2991
2991
  * @remarks Does not mutate input, read blacklisted getters, or call toJSON. No tracker initialization is required.
2992
2992
  * @example
@@ -2998,10 +2998,10 @@ type WebAuthnIdentifierProjectors = {
2998
2998
  declare function sanitizeCreationOptions(value: unknown, projectors?: WebAuthnIdentifierProjectors): string | undefined;
2999
2999
  /**
3000
3000
  * Serializes a registration credential, removing `clientExtensionResults.prf.results`.
3001
- * By default other fields remain, including attestation material and credential IDs. Binary values become base64url strings.
3001
+ * `response.userHandle` is omitted unless a projector is supplied. By default other fields remain, including attestation material and credential IDs. Binary values become base64url strings.
3002
3002
  *
3003
3003
  * @param value - A native registration credential, JSON object, or JSON text; not an application envelope.
3004
- * @param projectors - Optional synchronous user identifier projection; default identity.
3004
+ * @param projectors - Optional synchronous user identifier projection; default omits user identifiers.
3005
3005
  * @returns JSON text, or undefined for malformed or unserializable input.
3006
3006
  * @remarks Does not mutate input, read blacklisted getters, or call toJSON. Encoded attestation and client-data blobs are not decoded or redacted.
3007
3007
  */
@@ -3017,10 +3017,11 @@ declare function sanitizeCreationResponse(value: unknown, projectors?: WebAuthnI
3017
3017
  declare function sanitizeRequestOptions(value: unknown): string | undefined;
3018
3018
  /**
3019
3019
  * Serializes an authentication credential, removing `response.signature` and `clientExtensionResults.prf.results`.
3020
- * By default other fields remain, including credential IDs and user handles. Binary values become base64url strings.
3020
+ * `response.userHandle` is omitted unless a projector is supplied. Other fields remain, including credential IDs.
3021
+ * Binary values become base64url strings.
3021
3022
  *
3022
3023
  * @param value - A native authentication credential, JSON object, or JSON text; not an application envelope.
3023
- * @param projectors - Optional synchronous user identifier projection; default identity.
3024
+ * @param projectors - Optional synchronous user identifier projection; default omits user identifiers.
3024
3025
  * @returns JSON text, or undefined for malformed or unserializable input.
3025
3026
  * @remarks Does not mutate input, read blacklisted getters, or call toJSON. This is a path blacklist, not general-purpose secret detection; encoded client-data blobs are not decoded or redacted.
3026
3027
  */