@webtwizz/cloud 0.5.0 → 0.5.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/CHANGELOG.md +6 -0
- package/README.md +3 -29
- package/package.json +2 -7
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -17,10 +17,12 @@ WebTwizz puts every setting in the site's environment, so each module works with
|
|
|
17
17
|
| `@webtwizz/cloud/emails` | `handleSignInEmails()` for sites that send their own sign-in emails, `signInEmailCopy()` for the wording |
|
|
18
18
|
| `@webtwizz/cloud/files` | `createFiles()` with `uploadUrl`, `publicUrl`, `privateUrl`, `remove` |
|
|
19
19
|
|
|
20
|
-
`server`, `db`, `files` and `emails` are server-only. [AI_GUIDE.md](AI_GUIDE.md) has the full walkthrough
|
|
20
|
+
`server`, `db`, `files` and `emails` are server-only. [AI_GUIDE.md](AI_GUIDE.md), included in the package, has the full walkthrough.
|
|
21
21
|
|
|
22
22
|
## Environment
|
|
23
23
|
|
|
24
|
+
WebTwizz sets these when a site uses WebTwizz Cloud.
|
|
25
|
+
|
|
24
26
|
| Variable | Used by |
|
|
25
27
|
| --- | --- |
|
|
26
28
|
| `WEBTWIZZ_AUTH_URL`, `WEBTWIZZ_AUTH_SECRET` | `server` |
|
|
@@ -28,31 +30,3 @@ WebTwizz puts every setting in the site's environment, so each module works with
|
|
|
28
30
|
| `WEBTWIZZ_STORAGE_ENDPOINT`, `WEBTWIZZ_STORAGE_REGION`, `WEBTWIZZ_STORAGE_KEY`, `WEBTWIZZ_STORAGE_SECRET` | `files` |
|
|
29
31
|
| `WEBTWIZZ_STORAGE_READ_KEY`, `WEBTWIZZ_STORAGE_READ_SECRET` | `files` private links |
|
|
30
32
|
| `WEBTWIZZ_FILES_URL`, `WEBTWIZZ_STORAGE_MAX_FILE_MB` | `files`, optional |
|
|
31
|
-
|
|
32
|
-
## Development
|
|
33
|
-
|
|
34
|
-
```sh
|
|
35
|
-
npm ci
|
|
36
|
-
npm test # unit tests
|
|
37
|
-
npm run test:integration # real throwaway project, needs NEON_API_KEY
|
|
38
|
-
npm run build
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
`test/fixture` is a small Next app built the way WebTwizz builds sites (the same Next and React versions, `bun install`, `next build --webpack`, the guide's code), which CI builds against the packed tarball.
|
|
42
|
-
|
|
43
|
-
To try a change in the local WebTwizz preview site without publishing: `npm run preview` builds the package, puts it in the preview container's `node_modules` under a unique dev version, and restarts its dev server (about 10 seconds). `npm run dev` does the same on every save.
|
|
44
|
-
|
|
45
|
-
## Releases
|
|
46
|
-
|
|
47
|
-
- Add a changeset (`npx changeset`) to any PR that changes what sites get.
|
|
48
|
-
- When CI passes on `main`, the Release workflow versions, tags and publishes to npm with provenance (trusted publishing, no token).
|
|
49
|
-
- Dependency updates merged by Renovate ship as a patch on their own.
|
|
50
|
-
- Run the Release workflow by hand to publish the current commit under the `next` tag and try it on a test site first.
|
|
51
|
-
|
|
52
|
-
Sites pin an exact version, so a release never changes a live site until WebTwizz upgrades it.
|
|
53
|
-
|
|
54
|
-
The WebTwizz AI builds from its own copy of AI_GUIDE.md. After a release, run `npm run cloud:sync <version>` in the ai-service so new sites get that version and its guide.
|
|
55
|
-
|
|
56
|
-
## License
|
|
57
|
-
|
|
58
|
-
MIT
|
package/package.json
CHANGED
|
@@ -1,13 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@webtwizz/cloud",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "Sign-ins, database and file storage for sites built on WebTwizz Cloud",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
|
-
"repository": {
|
|
8
|
-
"type": "git",
|
|
9
|
-
"url": "git+https://github.com/WebTwizz/webtwizz-cloud.git"
|
|
10
|
-
},
|
|
11
7
|
"homepage": "https://webtwizz.com",
|
|
12
8
|
"keywords": [
|
|
13
9
|
"webtwizz",
|
|
@@ -63,8 +59,7 @@
|
|
|
63
59
|
"node": ">=20"
|
|
64
60
|
},
|
|
65
61
|
"publishConfig": {
|
|
66
|
-
"access": "public"
|
|
67
|
-
"provenance": true
|
|
62
|
+
"access": "public"
|
|
68
63
|
},
|
|
69
64
|
"peerDependencies": {
|
|
70
65
|
"next": ">=16.0.0",
|