CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file. See commit-and-tag-version for commit guidelines.

8.0.0 (2024-04-22)

⚠ BREAKING CHANGES

• upgrade to Capacitor 6
• don’t throw when using web-only methods

Features

• don’t throw when using web-only methods (c4c6092)
• upgrade to Capacitor 6 (7223f24)

Maintenance

• clean up eslint rules (dffed95)
• skip type assertion rule (35d3a61)

7.2.0 (2024-04-04)

Features

• allow authenticate() before checkBiometry() (7c4f9f9), closes #18

Maintenance

• lint & format (67ad6d3)
• update deps (764b06e)

Docs

• remove stray note (0d317df)

7.1.1 (2024-01-24)

Bug Fixes

• check for null value (e5ca3ec)

Maintenance

• update deps (b297e8a)

7.1.0 (2024-01-10)

Features

• add strong reason & code (31bf47a)

Maintenance

• update deps (1bf41e2)

7.0.2 (2024-01-04)

Docs

• document Android limitation (252a6df)

7.0.1 (2024-01-04)

Bug Fixes

• biometryTypes is empty if biometryType.none (445883c)

7.0.0 (2024-01-01)

⚠ BREAKING CHANGES

• present device credentials immediately

Features

• first pass at device security support (cdcabd2)
• present device credentials immediately (f1bbf83)
• setBiometryType() can take an array (39261cb)
• strongBiometryIsAvailable & deviceIsSecure (6cada04)

Bug Fixes

• biometryTypes is empty of no biometry (8b98a9c)

Maintenance

• remove unnecessary version check (beb7ded)
• update deps (f64b77d)
• update deps (119cb9d)
• use androidx.biometric.BiometricManager (e6049cb)
• various tweaks (30f87e7)

Docs

• various tweaks & clarifications (4d6d754)

6.0.1 (2023-12-28)

Bug Fixes

• throw code as BiometryError (94b4234)

Maintenance

• lint (678a3c0)
• reinstalled packages (becea9f)

6.0.0 (2023-11-13)

⚠ BREAKING CHANGES

• authenticate() now throws a BiometryError instance, and BiometryError.code is typed as BiometryErrorType.

Features

• throw BiometryError from authenticate (6ff0be0)

Maintenance

• update config (d1f0abe)
• update deps (60f20c0)
• update deps (dae6ac1)

Docs

• add examples, other improvements (5264666)
• add section on NSFaceIDUsageDescription (3620107)

5.2.1 (2023-10-11)

Bug Fixes

• check biometry before authenticating (41b125b)

Maintenance

• update deps (6d71d58)

5.2.0 (2023-10-05)

Features

• add androidConfirmationRequired option (95280d9)

Maintenance

• prettier (7efa43f)

5.1.0 (2023-09-30)

Features

• capacitor 5 support (ad65d2e)
• return all available biometry types (348fe01)

Bug Fixes

• prefer face if fingerprint is also available (8846fe8)
• return empty code on success (7573118)
• specify prettier glob (bae1b29)

Maintenance

• reformat (2199461)
• typo (15b6e1b)
• update deps (fc67631)
• update deps (fef77dd)

Docs

• document Android limitations (bdec858)

5.0.2 (2023-06-21)

Bug Fixes

• lint native code (f83bb76)

Maintenance

• remove unused file refs (3850666)
• update deps (09e32b8)

5.0.1 (2023-06-15)

Maintenance

• update README (ecacdd9)

5.0.0 (2023-06-15)

⚠ BREAKING CHANGES

• The plugin now requires Capacitor 5.

Features

• upgrade to Capacitor 5 (a410458)

Docs

• mention .code (b116d18)

Maintenance

• don’t log name + version at startup (ec2eb08)
• prettier format change (7e3c1f1)
• remove unused stuff (68ab6b1)
• update deps, upgrade to Capacitor 5 (584c966)
• updates to dev environment (ae163e4)

4.0.0 (2023-03-31)

⚠ BREAKING CHANGES

• BiometryErrorType has changed from a numeric enum to a string enum.

Features

• convert enum to string, add .none as a key (4f179a8)
• return error code from checkBiometry() (5e3c012)

Maintenance

• update deps (69819ae)

3.1.4 (2022-10-24)

Bug Fixes

• remove unused style, fixes #4 (81f0951)

Maintenance

• not sure how this got there (d6808ed)
• remove unused resources, fix typo (492bb22)

Docs

• clarify failed attempt limit (9ea721e)

3.1.3 (2022-08-12)

Bug Fixes

• remove test code (e98deff)

3.1.2 (2022-08-12)

Maintenance

• more explicit naming (df00cbb)
• remove all traces of ultra-runner (af5a384)

Refactoring

• patch native methods in constructor (3a1184f)

3.1.1 (2022-08-10)

Bug Fixes

• tslib is no longer necessary (abb4cf0)

3.1.0 (2022-08-10)

Features

• don’t use native-decorator, lazy load (4a03a0d)

Maintenance

• ditch ultra-runner, use pre/post scripts (184ffe0)

3.0.2 (2022-08-06)

Bug Fixes

• export original instance, not registered (6c1298b)

Maintenance

• add missing ignore (729913a)
• build system tweaks (f5835c1)

3.0.1 (2022-08-04)

Bug Fixes

• oops, wrong name (77fb52e)

Maintenance

• be brave, just do it (4ab5082)
• prettify after docgen (f904eae)
• update screen recordings (63ad658)

3.0.0 (2022-08-04)

⚠ BREAKING CHANGES

• Capacitor 4 is now required.
• androidMaxAttempts is no longer supported, the plugin now relies on system limits.

Features

• rely only on system limits (b502005)

Refactoring

• new build system (c7677a1)
• rename (35d819d)
• upgrade to Capacitor 4 (684c987)

2.0.8 (2022-07-25)

Bug Fixes

• don’t import from package.json (7744424)

Maintenance

• fix bundle identifier (f347e8b)
• fix command (5673363)
• update deps (0f9b0f3)

Docs

• tweak (2cf0dc2)

2.0.7 (2022-07-19)

Maintenance

• let eslint handle this (8a7e90e)
• reorganize build scripts (b8ddacb)
• update release scripts (e25bb4b)
• updates deps (7805fe5)

2.0.6 (2022-07-14)

Docs

• remove unnecessary jsdoc (6be9e0a)
• update to describe change to androidMaxAttempts (e9aab77)
• update to describe change to androidMaxAttempts (3be919e)

Maintenance

• change java indent to 2 (9b819e4)
• might as well check code here (4cad0c4)
• never hurts to cache eslint (d0baa8b)
• remove unnecessary disable (82eac79)
• script updates (a63b7c7)
• update deps (12bdaab)
• update target version (a5f8067)

2.0.5 (2022-07-05)

Bug Fixes

• give up when maxAttempts is reached (09ee75b)

2.0.4 (2022-07-04)

Bug Fixes

• update to fixed native-decorator (9c1c5f7)

Docs

• add demo videos (11ba830)
• add demo videos (1e8c63e)

Maintenance

• add missing extension (7b83029)
• don't need .gitattributes (c076dc8)
• update deps (9ecffac)
• update deps (608028d)
• videos are stored on github (e688790)

2.0.3 (2022-07-02)

Maintenance

• update deps (045987a)

Docs

• add npm version badge (1a34357)

2.0.2 (2022-07-02)

Bug Fixes

• can’t get version statically (e7068cf)

Maintenance

• rework release scripts (ab4442d)
• update deps (c0a9921)

2.0.1 (2022-07-02)

Features

• log plugin name & version (db2e3f1)

Maintenance

• lint (3452ef7)
• rework scripts for conditional source maps (d9cab0a)
• update deps (d6d8728)

2.0.0 (2022-07-01)

⚠ BREAKING CHANGES

• upgrade to Capacitor 3, callback support

Features

• upgrade to Capacitor 3, callback support (4177317)

Maintenance

• add missing ignores (81da849)
• format with 2 space indent (google std) (ca1fba3)
• parserOptions not necessary with latest eslint (aeae681)
• renamed class (0c5c3b2)
• update config files (f75f0d3)
• upgrade dev environment (f675f29)

1.0.7 (2021-04-02)

Maintenance

• eliminate unnecessary stuff in the package (3aaa594)

1.0.6 (2021-04-01)

Maintenance

• fix license (9852042)

1.0.5 (2021-04-01)

Maintenance

• fix link (4609b1d)
• fix urls (19954c0)

1.0.4 (2021-03-31)

Maintenance

• add license (938b24f)
• add push script (6069525)

1.0.3 (2021-03-31)

Maintenance

• fix urls (eed2a14)

1.0.2 (2021-03-31)

Bug Fixes

• change target to transform optional chaining (f278127)
• deps in the wrong place (0746a21)

1.0.1 (2021-03-29)

Features

• add docs (dd96a67)

Bug Fixes

• options might be undefined (8e66f7e)

Maintenance

• always use strict mode (b8fa32a)
• clean up loose ends (876561c)
• lint (1780d90)
• rename package (b2cf9dd)
• update deps (9edbd18)
• update scripts (2f1f5be)
• deps: updated (c753fa3)