@vardum/shared 0.4.0 → 0.4.2

package/README.md

@@ -4,10 +4,12 @@ Wire types and accepted-format tables shared by the Vardum API, dashboard,
 CLI and MCP server. Published because `@vardum/cli` and `@vardum/mcp` depend on
 it at runtime; it carries no dependencies of its own.
 
-This README describes shared **0.4.0**, used by CLI **0.8.0** and MCP **0.4.0**.
-Check [release status and compatibility](https://github.com/f-tuma/vardum/blob/main/docs/npm-release.md)
-to confirm npm availability before installing this version. The historical
-server compatibility fixture continues to use shared 0.2.0.
+This README describes [shared **0.4.2**](https://www.npmjs.com/package/@vardum/shared/v/0.4.2),
+used by [CLI **0.8.3**](https://www.npmjs.com/package/@vardum/cli/v/0.8.3) and
+[MCP **0.4.2**](https://www.npmjs.com/package/@vardum/mcp/v/0.4.2).
+It publishes the optional `Transformation` fields `bg`, `pad`, `layer`,
+`darkLayer`, `darkColor`, `render: "v2"` and the `"svg"` output format.
+Client snapshot and manifest schemas are unchanged.
 
 Shared 0.4.0 adds the guarded-editor wire contract: `VardEditorDefinition`
 requires the opaque `revision` and each manual item's literal nullable
@@ -17,16 +19,43 @@ resolved delivery versions. It retains `mediaStem`, `mediaOutputPath`, format
 tables. This client batch keeps CLI schema 2 snapshots; the wire manifest remains
 schema 1. It does not introduce schema 3.
 
-CLI 0.8.0 and MCP 0.4.0 retain `workspace:^` dependencies in source; their release
-archives require `@vardum/shared: ^0.4.0`, which npm resolves transitively.
+CLI 0.8.3 and MCP 0.4.2 retain `workspace:^` dependencies in source; their release
+archives require `@vardum/shared: ^0.4.2`, which npm resolves transitively.
 
-For a direct consumer, **this installation targets shared 0.4.0** once the
-release-status page confirms it is available:
+For a direct consumer, pin **shared 0.4.2**:
 
 ```sh
-npm install --save-exact @vardum/shared@0.4.0
+npm install --save-exact @vardum/shared@0.4.2
 ```
 
 ```ts
-import { mimeForFilename, supportedMimeTypes, type VardEditorDefinition } from "@vardum/shared";
+import { mimeForFilename, supportedMimeTypes, type Transformation, type VardEditorDefinition } from "@vardum/shared";
+
+const raster: Transformation = {
+  w: 256, h: 256, fit: "contain", format: "png",
+  bg: "#f4f0e8", pad: 12.5, render: "v2",
+};
+const vector: Transformation = {
+  format: "svg", layer: "logo", darkLayer: "logo", darkColor: "#e8e4d9",
+};
 ```
+
+For a new SVG-to-raster output with `bg`, choose `render: "v2"` explicitly.
+Omission retains the legacy renderer identity. Positive `pad` requires `w`, `h`,
+an explicit format and `fit: "contain"`. SVG output and group/color selection
+require a supported passive geometric SVG; `darkLayer` and `darkColor` are paired,
+and SVG output does not accept `q`.
+
+Types alone do not enable backend features. These recipe fields need a matching
+API and renderer; `vardEditRevision: 1` does not advertise transformation support.
+Existing recipes and frozen snapshots are not automatically migrated.
+Editable Vard reads and mutations
+require a server advertising `vardEditRevision: 1` at `GET /api/capabilities`
+and implementing the guarded `/editor` endpoints. Folder-upload mutation requires
+`folderUploadResume: 1`; importing uploaded files into a Vard also requires
+`folderVardImport: 1`. The upload backend needs migrations through
+`0015_upload_request_checksum.sql` and ready-version checksum metadata.
+
+Private delivery still needs a workspace read key. Keep API keys out of source
+control and client-side applications; this package contains no authentication,
+credential storage or server upgrades.

package/dist/wire.d.ts

@@ -7,8 +7,21 @@ export type Transformation = {
     w?: number;
     h?: number;
     fit?: "cover" | "contain" | "fill" | "inside" | "outside";
-    format?: "avif" | "jpeg" | "png" | "webp";
+    format?: "avif" | "jpeg" | "png" | "webp" | "svg";
     q?: number;
+    /** Opaque output background, normalized to lowercase #rrggbb. Requires format. */
+    bg?: string;
+    /** Inset on each edge, as a percent (0–45, at most two decimal places) of the shorter final side.
+     * Positive padding requires w, h, format and fit: "contain". */
+    pad?: number;
+    /** Geometric SVG group ID; keeps the original canvas and ancestor transforms. */
+    layer?: string;
+    /** Filled shapes in this SVG group use darkColor for a dark color scheme. */
+    darkLayer?: string;
+    /** Lowercase #rrggbb, paired with darkLayer; requires format: "svg". */
+    darkColor?: string;
+    /** Opt-in SVG-to-raster background renderer; omission retains legacy rendering. */
+    render?: "v2";
 };
 export type VardItem = {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vardum/shared",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Shared Vardum wire types and accepted-format tables",
   "license": "MIT",
   "type": "module",
@@ -25,7 +25,7 @@
     "url": "git+https://github.com/f-tuma/vardum.git",
     "directory": "packages/shared"
   },
-  "homepage": "https://github.com/f-tuma/vardum/tree/main/packages/shared#readme",
+  "homepage": "https://vardum.com",
   "bugs": {
     "url": "https://github.com/f-tuma/vardum/issues"
   },