@brendanbank/atrium-host-types 0.15.0 → 0.15.1
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/README.md +5 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,30 +21,15 @@ Bundlers strip it from the production output.
|
|
|
21
21
|
|
|
22
22
|
## Installation
|
|
23
23
|
|
|
24
|
-
The package is published on **GitHub Packages**, not the public npm
|
|
25
|
-
registry. Add an `.npmrc` to your host project that points the
|
|
26
|
-
`@brendanbank` scope at GitHub Packages:
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
# .npmrc
|
|
30
|
-
@brendanbank:registry=https://npm.pkg.github.com
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
GitHub Packages requires an authenticated install even for public
|
|
34
|
-
packages — give npm a token with at least the `read:packages` scope:
|
|
35
|
-
|
|
36
|
-
```
|
|
37
|
-
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
In CI, `GITHUB_TOKEN` is provided automatically by Actions; locally,
|
|
41
|
-
generate a [classic PAT](https://github.com/settings/tokens) with
|
|
42
|
-
`read:packages` and export it. Then:
|
|
43
|
-
|
|
44
24
|
```bash
|
|
45
25
|
pnpm add -D @brendanbank/atrium-host-types
|
|
46
26
|
```
|
|
47
27
|
|
|
28
|
+
The package is published on the public npm registry. No `.npmrc`,
|
|
29
|
+
no auth token, no PAT. If you adopted atrium before v0.15.1 and
|
|
30
|
+
have an `@brendanbank:registry=https://npm.pkg.github.com` line in
|
|
31
|
+
your `.npmrc`, delete it — npmjs.org is the default registry.
|
|
32
|
+
|
|
48
33
|
## Versioning
|
|
49
34
|
|
|
50
35
|
The package version tracks atrium's image version. Pin `^0.15` for
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brendanbank/atrium-host-types",
|
|
3
|
-
"version": "0.15.
|
|
3
|
+
"version": "0.15.1",
|
|
4
4
|
"description": "TypeScript declarations for the atrium host-extension contract: AtriumRegistry, UserContext, AdminUserRow, AtriumNotification, AtriumEvent. Source-of-truth shapes a host bundle types against, kept in sync with atrium's published image major.minor.",
|
|
5
5
|
"license": "BSD-2-Clause",
|
|
6
6
|
"type": "module",
|