Skip to content

Commit 79983d8

Browse files
committed
Update CHANGELOG for v12.0.0
1 parent ced2f4e commit 79983d8

1 file changed

Lines changed: 88 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 88 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,94 @@
11
# Changelog
22

3-
## v11.0.0-alpha3
3+
## v12.0.0 - The one that claims a JSR scope
44

5-
This build is **functionally identical** as v11.0.0. This one just involves massive monorepo
6-
infrastructure changes that I'm putting through its paces.
5+
All SimpleWebAuthn packages are now available for installation from the
6+
[JavaScript Registry (JSR)](https://jsr.io/@simplewebauthn)! JSR is an "open-source package registry
7+
for modern JavaScript and TypeScript" - you can read more about this new package registry and its
8+
ESM-centric capabilities [here](https://jsr.io/docs/why).
9+
10+
**All packages in v12.0.0 are functionally identical to v11.0.0!** And JSR package hosting is **in
11+
addition to** existing package hosting on NPM. Nothing changes about package installation via
12+
`npm install`. Read on for more information.
13+
14+
### Packages
15+
16+
- @simplewebauthn/browser@12.0.0
17+
- @simplewebauthn/server@12.0.0
18+
- @simplewebauthn/types@12.0.0
19+
20+
### Changes
21+
22+
- **[browser]** **[server]** **[types]** All packages can now be installed from JSR wherever JSR
23+
imports are supported ([#634](https://github.com/MasterKale/SimpleWebAuthn/pull/634))
24+
- **[browser]** Deno projects using frameworks like Fresh can now import and use
25+
**@simplewebauthn/browser** ([#634](https://github.com/MasterKale/SimpleWebAuthn/pull/634))
26+
27+
To install from JSR, use `npx jsr add @simplewebauthn/...` or `deno add jsr:@simplewebauthn/...`
28+
depending on which package manager is available.
29+
30+
#### Projects using `npm` for package management:
31+
32+
```sh
33+
npx jsr add @simplewebauthn/browser
34+
```
35+
36+
```sh
37+
npx jsr add @simplewebauthn/server
38+
```
39+
40+
```sh
41+
npx jsr add @simplewebauthn/types
42+
```
43+
44+
#### Projects using `deno` for package management:
45+
46+
```sh
47+
deno add jsr:@simplewebauthn/browser
48+
```
49+
50+
```sh
51+
deno add jsr:@simplewebauthn/server
52+
```
53+
54+
```sh
55+
deno add jsr:@simplewebauthn/types
56+
```
57+
58+
#### Projects using HTTPS modules via deno.land/x:
59+
60+
v12.0.0 officially deprecates importing SimpleWebAuthn from deno.land/x. See **Breaking Changes**
61+
below for refactor guidance.
62+
63+
### Breaking Changes
64+
65+
Importing SimpleWebAuthn packages from `"https://deno.land/x/simplewebauthn/..."` URLs is no longer
66+
supported. Please use Deno's native support for JSR imports instead, available in projects running
67+
Deno v1.42 and higher.
68+
69+
**Before:**
70+
71+
```ts
72+
import { generateAuthenticationOptions } from 'https://deno.land/x/simplewebauthn/deno/server.ts';
73+
```
74+
75+
**After:**
76+
77+
```ts
78+
import { generateAuthenticationOptions } from 'jsr:@simplewebauthn/server';
79+
```
80+
81+
Alternatively, use `deno add` to install these packages from
82+
**[JSR](https://jsr.io/@simplewebauthn)**:
83+
84+
```sh
85+
# Deno v1.42 and higher
86+
deno add jsr:@simplewebauthn/server
87+
```
88+
89+
```ts
90+
import { generateAuthenticationOptions } from '@simplewebauthn/server';
91+
```
792

893
## v11.0.0 - The one that auto-registers
994

0 commit comments

Comments
 (0)