foldkit-cms 0.1.0 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +17 -8
  2. package/package.json +8 -8
package/README.md CHANGED
@@ -7,13 +7,10 @@ What a CMS adds to a domain that is already declared. The domain is a
7
7
  are: **audience** (a visitor sees what is published, an author sees everything),
8
8
  **time** (drafts, revisions, a schedule), and **address** (a slug).
9
9
 
10
- > **Status: built, unpublished.** Roles, content types, the three Entities, the
11
- > operations, the lifecycle, the kinds, and the authoring editor's state. Its
12
- > server is [`foldkit-cms-drizzle`](../cms-drizzle/README.md), which runs every
13
- > operation and enforces the audience boundary, and
14
- > [`examples/cms`](../../examples/cms) runs the two together. What
15
- > [the design](../../docs/design/cms-DESIGN.md#13-build-order) set out is built
16
- > but for a browser mode of the example. Neither package is on npm.
10
+ The client contract and editor live here. The
11
+ [server adapter](../cms-drizzle/README.md) persists drafts and enforces the
12
+ audience boundary. [The CMS example](../../examples/cms/README.md) runs both
13
+ as a transcript or in a browser.
17
14
 
18
15
  ## What it owns
19
16
 
@@ -47,6 +44,12 @@ does not validate can be saved, which a row with a `not null` title cannot hold.
47
44
  An **Entry** is a piece of content from its first keystroke to its archive. It
48
45
  exists before the row does, and after the row is hidden.
49
46
 
47
+ ## Run the local example
48
+
49
+ From a checkout, run `pnpm install`, `pnpm build`, then
50
+ `pnpm --filter foldkit-example-cms demo`. This is the reproducible path for the
51
+ workspace version; use the package install below for a published version.
52
+
50
53
  ## Install
51
54
 
52
55
  ```sh
@@ -55,6 +58,12 @@ pnpm add effect foldkit foldkit-entity foldkit-form foldkit-crud foldkit-remote
55
58
 
56
59
  ## Example
57
60
 
61
+ This integration extends an existing Entity, form, and pair of Remote mutations.
62
+ `Blog.Post`, `PostForm`, `CreatePostMutation`, and `UpdatePostMutation` come from
63
+ your domain module; [the example domain](../../examples/cms/src/domain.ts) shows
64
+ those definitions together. Start with [Form](../form/README.md) if you have not
65
+ yet defined the operation's input.
66
+
58
67
  ```ts
59
68
  import { Cms } from 'foldkit-cms'
60
69
 
@@ -257,7 +266,7 @@ nobody has makes the entry, so an editor need not wait to learn what it edits.
257
266
  | `Cms.bySlug(content)` | The query `<name>BySlug`: the content at an address, a connection of one or none. Throws with no `slug` role. |
258
267
  | `Cms.slugTaken.key(message)` | The form key a server's `CmsSlugTaken: ...` error names, or `undefined`. |
259
268
 
260
- ## Example
269
+ ## End-to-end example
261
270
 
262
271
  [`examples/cms`](../../examples/cms) takes a post from its first keystroke to being
263
272
  taken off show, from a writer's, an editor's and a visitor's chair, over SQLite,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "foldkit-cms",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "What a CMS adds to a Foldkit Plus domain: audience, time, and address. A draft is an unsent form kept beside the content row; state is derived, never stored. Headless.",
5
5
  "keywords": [
6
6
  "foldkit",
@@ -39,12 +39,12 @@
39
39
  ],
40
40
  "dependencies": {
41
41
  "foldkit-bundle": "0.2.0",
42
- "foldkit-entity": "0.2.0",
43
- "foldkit-form": "0.1.1",
42
+ "foldkit-crud": "0.3.0",
43
+ "foldkit-entity": "0.3.0",
44
44
  "foldkit-metadata": "0.1.0",
45
- "foldkit-surface": "0.3.0",
46
- "foldkit-crud": "0.1.1",
47
- "foldkit-remote": "0.5.0"
45
+ "foldkit-remote": "0.7.0",
46
+ "foldkit-surface": "0.4.1",
47
+ "foldkit-form": "0.1.2"
48
48
  },
49
49
  "peerDependencies": {
50
50
  "effect": "^4.0.0-rc.112",
@@ -55,9 +55,9 @@
55
55
  "foldkit": "0.158.2",
56
56
  "tsdown": "^0.23.0",
57
57
  "typescript": "5.9.3",
58
+ "foldkit-mixins-crud": "0.3.0",
58
59
  "foldkit-mixins": "0.3.0",
59
- "foldkit-mixins-crud": "0.1.0",
60
- "foldkit-mixins-form": "0.1.1"
60
+ "foldkit-mixins-form": "0.1.2"
61
61
  },
62
62
  "scripts": {
63
63
  "build": "tsdown",