@passlock/client 2.2.1 → 2.3.0
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.ts +29 -16
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +28 -15
- package/dist/index.js.map +1 -1
- package/dist/internal/result.js +1 -1
- package/dist/internal/result.js.map +1 -1
- package/dist/logger.d.ts +11 -5
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +11 -5
- package/dist/logger.js.map +1 -1
- package/dist/passkey/authentication/authentication.d.ts.map +1 -1
- package/dist/passkey/authentication/authentication.js +1 -1
- package/dist/passkey/authentication/authentication.js.map +1 -1
- package/dist/passkey/registration/registration.d.ts.map +1 -1
- package/dist/passkey/registration/registration.js +1 -1
- package/dist/passkey/registration/registration.js.map +1 -1
- package/dist/passkey/shared.d.ts +16 -4
- package/dist/passkey/shared.d.ts.map +1 -1
- package/dist/passkey/signals/signals.d.ts +44 -15
- package/dist/passkey/signals/signals.d.ts.map +1 -1
- package/dist/passkey/signals/signals.js +35 -13
- package/dist/passkey/signals/signals.js.map +1 -1
- package/dist/safe.d.ts +43 -28
- package/dist/safe.d.ts.map +1 -1
- package/dist/safe.js +35 -19
- package/dist/safe.js.map +1 -1
- package/package.json +1 -1
package/dist/safe.js
CHANGED
|
@@ -45,7 +45,7 @@ import { deletePasskey as deletePasskeyM, deleteUserPasskeys as deleteUserPasske
|
|
|
45
45
|
*
|
|
46
46
|
* @param options
|
|
47
47
|
*
|
|
48
|
-
* @returns A {@link
|
|
48
|
+
* @returns A {@link PasslockClient} whose success branch contains a {@link RegistrationSuccess}
|
|
49
49
|
* and whose error branch contains a {@link RegistrationError}. Existing
|
|
50
50
|
* {@link isRegistrationSuccess} checks and `_tag` discrimination still work.
|
|
51
51
|
*
|
|
@@ -88,7 +88,7 @@ logger = eventLogger) => pipe(registerPasskeyM(options), Micro.provideService(Re
|
|
|
88
88
|
*
|
|
89
89
|
* @param options
|
|
90
90
|
*
|
|
91
|
-
* @returns A {@link
|
|
91
|
+
* @returns A {@link PasslockClient} whose success branch contains an
|
|
92
92
|
* {@link AuthenticationSuccess} and whose error branch contains an
|
|
93
93
|
* {@link AuthenticationError}. Existing {@link isAuthenticationSuccess}
|
|
94
94
|
* checks and `_tag` discrimination still work.
|
|
@@ -131,14 +131,17 @@ logger = eventLogger) => pipe(authenticatePasskeyM(options), Micro.provideServic
|
|
|
131
131
|
*
|
|
132
132
|
* By calling this function and supplying a new username/display name, their local
|
|
133
133
|
* password manager will align with their updated account identifier.
|
|
134
|
+
* Support and metadata lookup failures populate the error branch as
|
|
135
|
+
* {@link UpdateError}. Browser-side signalling failures are logged as warnings
|
|
136
|
+
* and do not populate the error branch.
|
|
134
137
|
*
|
|
135
138
|
* @param options You will typically supply a target `passkeyId` via
|
|
136
139
|
* {@link UpdatePasskeyOptions}. {@link UpdateCredentialOptions} is intended
|
|
137
140
|
* for credential-scoped updates, for example when replaying data returned by
|
|
138
141
|
* `@passlock/server`.
|
|
139
|
-
* @returns A {@link
|
|
140
|
-
* {@link UpdateSuccess} after the
|
|
141
|
-
*
|
|
142
|
+
* @returns A {@link PasslockClient} whose success branch contains an
|
|
143
|
+
* {@link UpdateSuccess} after the local update workflow has been started, and
|
|
144
|
+
* whose error branch contains an {@link UpdateError}.
|
|
142
145
|
* Existing {@link isUpdateSuccess}, {@link isUpdateError}, and `_tag` checks
|
|
143
146
|
* still work.
|
|
144
147
|
*
|
|
@@ -155,7 +158,7 @@ logger = eventLogger) => pipe(authenticatePasskeyM(options), Micro.provideServic
|
|
|
155
158
|
* const result = await updatePasskey({ tenancyId, passkeyId, username, displayName });
|
|
156
159
|
*
|
|
157
160
|
* if (result.success) {
|
|
158
|
-
* console.log("passkey update
|
|
161
|
+
* console.log("passkey update requested");
|
|
159
162
|
* } else if (result.failure && isUpdateError(result.error)) {
|
|
160
163
|
* // narrowed to an UpdateError type
|
|
161
164
|
* console.log(result.error.code);
|
|
@@ -181,12 +184,15 @@ logger = eventLogger) => {
|
|
|
181
184
|
*
|
|
182
185
|
* By calling this function and supplying a new username/display name, their local
|
|
183
186
|
* password manager will align with their updated account identifier.
|
|
187
|
+
* Support failures populate the error branch as {@link UpdateError}.
|
|
188
|
+
* Browser-side signalling failures are logged as warnings and do not populate
|
|
189
|
+
* the error branch.
|
|
184
190
|
*
|
|
185
191
|
* @param options The `credentials` array returned by
|
|
186
192
|
* `@passlock/server/safe`'s `updatePasskeyUsernames` success branch.
|
|
187
|
-
* @returns A {@link
|
|
188
|
-
* {@link UpdateSuccess} after the
|
|
189
|
-
*
|
|
193
|
+
* @returns A {@link PasslockClient} whose success branch contains an
|
|
194
|
+
* {@link UpdateSuccess} after the local update workflows have been started,
|
|
195
|
+
* and whose error branch contains an {@link UpdateError}.
|
|
190
196
|
* Existing {@link isUpdateSuccess}, {@link isUpdateError}, and `_tag` checks
|
|
191
197
|
* still work.
|
|
192
198
|
*
|
|
@@ -226,11 +232,14 @@ logger = eventLogger) => {
|
|
|
226
232
|
* Use this after deleting the server-side passkeys. The `deleted` array returned
|
|
227
233
|
* by `@passlock/server/safe` already has the right shape, so you can pass it
|
|
228
234
|
* straight into this function.
|
|
235
|
+
* Support failures populate the error branch as {@link DeleteError}.
|
|
236
|
+
* Browser-side signalling failures are logged as warnings and do not populate
|
|
237
|
+
* the error branch.
|
|
229
238
|
*
|
|
230
239
|
* @param options Credentials derived from deleted backend passkeys.
|
|
231
|
-
* @returns A {@link
|
|
232
|
-
* {@link DeleteSuccess} once the
|
|
233
|
-
* whose error branch contains a {@link DeleteError}. Existing
|
|
240
|
+
* @returns A {@link PasslockClient} whose success branch contains a
|
|
241
|
+
* {@link DeleteSuccess} once the local removal workflows have been started,
|
|
242
|
+
* and whose error branch contains a {@link DeleteError}. Existing
|
|
234
243
|
* {@link isDeleteSuccess}, {@link isDeleteError}, and `_tag` checks still work.
|
|
235
244
|
* @see {@link isDeleteSuccess}
|
|
236
245
|
* @see {@link isDeleteError}
|
|
@@ -274,12 +283,15 @@ logger = eventLogger) => {
|
|
|
274
283
|
*
|
|
275
284
|
* See [deleting passkeys](https://passlock.dev/passkeys/passkey-removal/) and
|
|
276
285
|
* [handling missing passkeys](https://passlock.dev/handling-missing-passkeys/) in the documentation.
|
|
286
|
+
* Support and metadata lookup failures populate the error branch as
|
|
287
|
+
* {@link DeleteError}. Browser-side signalling failures are logged as warnings
|
|
288
|
+
* and do not populate the error branch.
|
|
277
289
|
*
|
|
278
290
|
* @param options You will typically pass {@link DeletePasskeyOptions}. Use
|
|
279
291
|
* {@link DeleteCredentialOptions} or {@link OrphanedPasskeyError} when you
|
|
280
292
|
* already have the credential metadata.
|
|
281
|
-
* @returns A {@link
|
|
282
|
-
* {@link DeleteSuccess} once the
|
|
293
|
+
* @returns A {@link PasslockClient} whose success branch contains a
|
|
294
|
+
* {@link DeleteSuccess} once the local removal workflow has been started, and
|
|
283
295
|
* whose error branch contains a {@link DeleteError}. Existing
|
|
284
296
|
* {@link isDeleteSuccess}, {@link isDeleteError}, and `_tag` checks still work.
|
|
285
297
|
* @see {@link isDeleteSuccess}
|
|
@@ -293,7 +305,7 @@ logger = eventLogger) => {
|
|
|
293
305
|
* const result = await deletePasskey({ tenancyId, passkeyId });
|
|
294
306
|
*
|
|
295
307
|
* if (result.success) {
|
|
296
|
-
* console.log("passkey removal
|
|
308
|
+
* console.log("passkey removal requested");
|
|
297
309
|
* } else if (result.failure && isDeleteError(result.error)) {
|
|
298
310
|
* // narrowed to a DeleteError type
|
|
299
311
|
* console.log(result.error.code);
|
|
@@ -314,11 +326,14 @@ logger = eventLogger) => {
|
|
|
314
326
|
*
|
|
315
327
|
* This is useful when your backend is the source of truth for which passkeys
|
|
316
328
|
* should still exist for a given account on this device.
|
|
329
|
+
* Support and metadata lookup failures populate the error branch as
|
|
330
|
+
* {@link PruningError}. Browser-side signalling failures are logged as
|
|
331
|
+
* warnings and do not populate the error branch.
|
|
317
332
|
*
|
|
318
333
|
* @param options Pass the passkeys you **want to retain**.
|
|
319
|
-
* @returns A {@link
|
|
320
|
-
* {@link PruningSuccess} once the
|
|
321
|
-
*
|
|
334
|
+
* @returns A {@link PasslockClient} whose success branch contains a
|
|
335
|
+
* {@link PruningSuccess} once the accepted-credentials signalling attempt has
|
|
336
|
+
* completed, and whose error branch contains a
|
|
322
337
|
* {@link PruningError}. Existing {@link isPruningSuccess},
|
|
323
338
|
* {@link isPruningError}, and `_tag` checks still work.
|
|
324
339
|
*
|
|
@@ -333,7 +348,7 @@ logger = eventLogger) => {
|
|
|
333
348
|
* const result = await prunePasskeys({ tenancyId, allowablePasskeyIds });
|
|
334
349
|
*
|
|
335
350
|
* if (result.success) {
|
|
336
|
-
* console.log("accepted credentials
|
|
351
|
+
* console.log("accepted credentials sync requested");
|
|
337
352
|
* } else if (result.failure && isPruningError(result.error)) {
|
|
338
353
|
* // narrowed to a PruningError type
|
|
339
354
|
* console.log(result.error.code);
|
|
@@ -374,6 +389,7 @@ export const isPasskeyPruningSupport = () => pipe(isPasskeyPruningSupportM, Micr
|
|
|
374
389
|
* @category Passkeys (other)
|
|
375
390
|
*/
|
|
376
391
|
export const isPasskeyUpdateSupport = () => pipe(isPasskeyUpdateSupportM, Micro.runSync);
|
|
392
|
+
/* Re-exports */
|
|
377
393
|
export { isNetworkError, NetworkError } from "./internal/network.js";
|
|
378
394
|
export { LogEvent, Logger, LogLevel, } from "./logger.js";
|
|
379
395
|
export { AuthenticationHelper, isAuthenticationSuccess, } from "./passkey/authentication/authentication.js";
|
package/dist/safe.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"safe.js","sourceRoot":"","sources":["../src/safe.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;
|
|
1
|
+
{"version":3,"file":"safe.js","sourceRoot":"","sources":["../src/safe.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAElD,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAMjD,OAAO,EACL,oBAAoB,EACpB,mBAAmB,IAAI,oBAAoB,GAC5C,MAAM,4CAA4C,CAAA;AAanD,OAAO,EACL,kBAAkB,EAClB,eAAe,IAAI,gBAAgB,GACpC,MAAM,wCAAwC,CAAA;AAa/C,OAAO,EACL,aAAa,IAAI,cAAc,EAC/B,kBAAkB,IAAI,mBAAmB,EACzC,eAAe,EACf,sBAAsB,IAAI,uBAAuB,EACjD,uBAAuB,IAAI,wBAAwB,EACnD,sBAAsB,IAAI,uBAAuB,EACjD,gBAAgB,EAChB,eAAe,EACf,aAAa,IAAI,cAAc,EAC/B,aAAa,IAAI,cAAc,EAC/B,sBAAsB,IAAI,uBAAuB,GAClD,MAAM,8BAA8B,CAAA;AAErC,kBAAkB;AAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAClC,OAA4B;AAC5B,cAAc;AACd,SAAgC,WAAW,EACsB,EAAE,CACnE,IAAI,CACF,gBAAgB,CAAC,OAAO,CAAC,EACzB,KAAK,CAAC,cAAc,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,OAAO,CAAC,EACpE,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EACpC,YAAY,CACb,CAAA;AAEH,oBAAoB;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,OAA8B;AAC9B,cAAc;AACd,SAAgC,WAAW,EAC0B,EAAE,CACvE,IAAI,CACF,oBAAoB,CAAC,OAAO,CAAC,EAC7B,KAAK,CAAC,cAAc,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,OAAO,CAAC,EACxE,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EACpC,YAAY,CACb,CAAA;AAEH,aAAa;AAEb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,OAAuD;AACvD,cAAc;AACd,SAAgC,WAAW,EACU,EAAE;IACvD,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IACrC,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAA;AACxE,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAA+C;AAC/C,cAAc;AACd,SAAgC,WAAW,EACU,EAAE;IACvD,MAAM,KAAK,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAA;IAC9C,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAA;AACxE,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,OAAkC;AAClC,cAAc;AACd,SAAgC,WAAW,EACU,EAAE;IACvD,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAA;IAC1C,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAA;AACxE,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,OAGwB;AACxB,cAAc;AACd,SAAgC,WAAW,EACU,EAAE;IACvD,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IACrC,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAA;AACxE,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,OAA4B;AAC5B,cAAc;AACd,SAAgC,WAAW,EACY,EAAE;IACzD,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IACrC,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAA;AACxE,CAAC,CAAA;AAED,aAAa;AAEb;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,EAAE,CACzC,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;AAE9C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE,CAC1C,IAAI,CAAC,wBAAwB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;AAE/C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,EAAE,CACzC,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;AAE9C,gBAAgB;AAEhB,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEpE,OAAO,EACL,QAAQ,EACR,MAAM,EACN,QAAQ,GACT,MAAM,aAAa,CAAA;AAUpB,OAAO,EACL,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,4CAA4C,CAAA;AAEnD,OAAO,EACL,WAAW,EACX,qBAAqB,EACrB,aAAa,EACb,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,EACnB,yBAAyB,EACzB,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,iBAAiB,EACjB,uBAAuB,EACvB,YAAY,EACZ,WAAW,GACZ,MAAM,qBAAqB,CAAA;AAQ5B,OAAO,EACL,qBAAqB,EACrB,kBAAkB,GACnB,MAAM,wCAAwC,CAAA;AAa/C,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,eAAe,GAChB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EACL,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,sBAAsB,CAAA"}
|