@vardum/shared 0.2.0 → 0.4.0

package/README.md

@@ -1,9 +1,32 @@
 # @vardum/shared
 
-Wire types and the accepted-format tables shared by the Vardum API, dashboard,
+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.
+
+Shared 0.4.0 adds the guarded-editor wire contract: `VardEditorDefinition`
+requires the opaque `revision` and each manual item's literal nullable
+`pinnedVersionId`; `VardEditorItemInput` requires an existing mapping `id` or
+`null`, plus an explicit nullable `versionId`. Keep saved pins separate from
+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.
+
+For a direct consumer, **this installation targets shared 0.4.0** once the
+release-status page confirms it is available:
+
+```sh
+npm install --save-exact @vardum/shared@0.4.0
+```
+
 ```ts
-import { mimeForFilename, supportedMimeTypes, type VardManifest } from "@vardum/shared";
+import { mimeForFilename, supportedMimeTypes, type VardEditorDefinition } from "@vardum/shared";
 ```

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./mime.js";
+export * from "./naming.js";
 export * from "./wire.js";

package/dist/index.js

@@ -1,2 +1,3 @@
 export * from "./mime.js";
+export * from "./naming.js";
 export * from "./wire.js";

package/dist/mime.js

@@ -48,7 +48,9 @@ export const extensionMimeTypes = {
 };
 export function mimeForFilename(filename) {
     const extension = filename.toLowerCase().match(/\.([^.]+)$/)?.[1];
-    return (extension && extensionMimeTypes[extension]) || null;
+    return extension && Object.hasOwn(extensionMimeTypes, extension)
+        ? extensionMimeTypes[extension]
+        : null;
 }
 /** Value for a file input's accept attribute, e.g. ".avif,.gif,…". */
 export const uploadAccept = Object.keys(extensionMimeTypes)

package/dist/naming.d.ts

@@ -0,0 +1,4 @@
+/** Strip the final supported media suffix, never dots in a directory or stem. */
+export declare function mediaStem(path: string): string;
+/** Project files keep one suffix for their output format; library names do not. */
+export declare function mediaOutputPath(path: string, mimeType: string): string;

package/dist/naming.js

@@ -0,0 +1,22 @@
+import { mimeForFilename } from "./mime.js";
+/** Strip the final supported media suffix, never dots in a directory or stem. */
+export function mediaStem(path) {
+    const start = path.lastIndexOf("/") + 1;
+    const dot = path.lastIndexOf(".");
+    return dot > start && mimeForFilename(path.slice(start))
+        ? path.slice(0, dot)
+        : path;
+}
+const mimeExtensions = {
+    "image/avif": "avif", "image/gif": "gif", "image/jpeg": "jpg",
+    "image/png": "png", "image/svg+xml": "svg", "image/tiff": "tiff",
+    "image/webp": "webp", "video/mp4": "mp4", "video/webm": "webm",
+    "video/quicktime": "mov", "video/x-msvideo": "avi", "video/mpeg": "mpeg",
+};
+/** Project files keep one suffix for their output format; library names do not. */
+export function mediaOutputPath(path, mimeType) {
+    const extension = Object.hasOwn(mimeExtensions, mimeType)
+        ? mimeExtensions[mimeType]
+        : undefined;
+    return extension ? `${mediaStem(path)}.${extension}` : path;
+}

package/dist/wire.d.ts

@@ -17,9 +17,13 @@ export type VardItem = {
     outputPath: string;
     writable: boolean;
     pinned: boolean;
+    /** Literal saved pin, supplied by the guarded editor even when the version is unavailable. */
+    pinnedVersionId?: string | null;
     transformation: Transformation | null;
     versionId: string | null;
     sourceChecksum: string | null;
+    /** Original selected version's type, before any output transformation. */
+    sourceMimeType?: string | null;
     mimeType: string | null;
     size: number | null;
     fingerprint: string | null;
@@ -42,6 +46,24 @@ export type VardFolderRule = {
 /** Editable configuration: items are manual mappings only, never expanded outputs. */
 export type VardDefinition = VardManifest & {
     folderRules: VardFolderRule[];
+    /** Opaque state-equivalence token supplied by guarded editor endpoints. */
+    revision?: string;
+};
+/** The dedicated editor always supplies its revision and literal pin IDs. */
+export type VardEditorDefinition = VardDefinition & {
+    revision: string;
+    items: (VardItem & {
+        pinnedVersionId: string | null;
+    })[];
+};
+export type VardEditorItemInput = {
+    /** Existing manual mapping ID, or null to allocate a new mapping. */
+    id: string | null;
+    assetId: string;
+    versionId: string | null;
+    outputPath: string;
+    transformation: Transformation | null;
+    writable: boolean;
 };
 export type SyncAsset = {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vardum/shared",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Shared Vardum wire types and accepted-format tables",
   "license": "MIT",
   "type": "module",
@@ -22,12 +22,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/frgtn-dot-dev/vardum.git",
+    "url": "git+https://github.com/f-tuma/vardum.git",
     "directory": "packages/shared"
   },
-  "homepage": "https://github.com/frgtn-dot-dev/vardum/tree/main/packages/shared#readme",
+  "homepage": "https://github.com/f-tuma/vardum/tree/main/packages/shared#readme",
   "bugs": {
-    "url": "https://github.com/frgtn-dot-dev/vardum/issues"
+    "url": "https://github.com/f-tuma/vardum/issues"
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",