@vardum/shared 0.4.0 → 0.4.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.
Files changed (2) hide show
  1. package/README.md +18 -9
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -4,10 +4,9 @@ Wire types and accepted-format tables shared by the Vardum API, dashboard,
4
4
  CLI and MCP server. Published because `@vardum/cli` and `@vardum/mcp` depend on
5
5
  it at runtime; it carries no dependencies of its own.
6
6
 
7
- This README describes shared **0.4.0**, used by CLI **0.8.0** and MCP **0.4.0**.
8
- Check [release status and compatibility](https://github.com/f-tuma/vardum/blob/main/docs/npm-release.md)
9
- to confirm npm availability before installing this version. The historical
10
- server compatibility fixture continues to use shared 0.2.0.
7
+ This README describes [shared **0.4.1**](https://www.npmjs.com/package/@vardum/shared/v/0.4.1),
8
+ used by CLI **0.8.1** and MCP **0.4.1**. This patch makes the package documentation
9
+ self-contained; it does not change the wire types or client snapshot schema.
11
10
 
12
11
  Shared 0.4.0 adds the guarded-editor wire contract: `VardEditorDefinition`
13
12
  requires the opaque `revision` and each manual item's literal nullable
@@ -17,16 +16,26 @@ resolved delivery versions. It retains `mediaStem`, `mediaOutputPath`, format
17
16
  tables. This client batch keeps CLI schema 2 snapshots; the wire manifest remains
18
17
  schema 1. It does not introduce schema 3.
19
18
 
20
- CLI 0.8.0 and MCP 0.4.0 retain `workspace:^` dependencies in source; their release
21
- archives require `@vardum/shared: ^0.4.0`, which npm resolves transitively.
19
+ CLI 0.8.1 and MCP 0.4.1 retain `workspace:^` dependencies in source; their release
20
+ archives require `@vardum/shared: ^0.4.1`, which npm resolves transitively.
22
21
 
23
- For a direct consumer, **this installation targets shared 0.4.0** once the
24
- release-status page confirms it is available:
22
+ For a direct consumer, pin **shared 0.4.1**:
25
23
 
26
24
  ```sh
27
- npm install --save-exact @vardum/shared@0.4.0
25
+ npm install --save-exact @vardum/shared@0.4.1
28
26
  ```
29
27
 
30
28
  ```ts
31
29
  import { mimeForFilename, supportedMimeTypes, type VardEditorDefinition } from "@vardum/shared";
32
30
  ```
31
+
32
+ Types alone do not enable backend features. Editable Vard reads and mutations
33
+ require a server advertising `vardEditRevision: 1` at `GET /api/capabilities`
34
+ and implementing the guarded `/editor` endpoints. Folder-upload mutation requires
35
+ `folderUploadResume: 1`; importing uploaded files into a Vard also requires
36
+ `folderVardImport: 1`. The upload backend needs migrations through
37
+ `0015_upload_request_checksum.sql` and ready-version checksum metadata.
38
+
39
+ Private delivery still needs a workspace read key. Keep API keys out of source
40
+ control and client-side applications; this package contains no authentication,
41
+ credential storage or server upgrades.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vardum/shared",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "description": "Shared Vardum wire types and accepted-format tables",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -25,7 +25,7 @@
25
25
  "url": "git+https://github.com/f-tuma/vardum.git",
26
26
  "directory": "packages/shared"
27
27
  },
28
- "homepage": "https://github.com/f-tuma/vardum/tree/main/packages/shared#readme",
28
+ "homepage": "https://vardum.com",
29
29
  "bugs": {
30
30
  "url": "https://github.com/f-tuma/vardum/issues"
31
31
  },