wyvrnpm 2.12.3 → 2.13.11

package/src/v2-meta.js

@@ -0,0 +1,98 @@
+'use strict';
+
+/**
+ * Build the canonical v2 `wyvrn.json` body. Single source of truth for the
+ * shape so the publisher (publish.js / upload-built.js) and the providers
+ * (s3/http/file `v2Publish`) produce byte-identical bytes — required so
+ * the consumer's `manifestSha256` over the canonical form matches the
+ * value the publisher signed into the attestation (S1 plan §3.1).
+ *
+ * Inputs are spread on top of the publisher-provided manifest so any
+ * field already present on the source `wyvrn.json` survives unchanged.
+ * The well-known v2 fields always appear — `schemaVersion`, `profileHash`,
+ * `buildSettings`, `gitSha`, `gitRepo`, `publishedAt`.
+ *
+ * Artefact-shape fields:
+ *   - `contentSha256`   — SHA256 of the single `wyvrn.zip` (fat-zip publishes,
+ *                         the historical default).
+ *   - `artefactConfigs` — { config → { sha256, sizeBytes } } for per-config
+ *                         slice publishes (recipe `build.publishPerConfig: true`).
+ * At least one of the two must be supplied. Both may coexist — that's a
+ * future "slice-plus-fat-zip-fallback" option, not used today but the
+ * canonical-byte contract permits it.
+ *
+ * `publishedLock` / `uploadedBy` / `artefactConfigs` only appear when
+ * explicitly supplied non-empty; absent-vs-empty discipline matters
+ * because the canonical SHA includes them when present and omits them
+ * when absent — flipping that bit on or off changes the signed value.
+ */
+function buildV2Meta(rawManifest, opts) {
+  const {
+    profileHash, buildSettings, contentSha256,
+    gitSha = null, gitRepo = null,
+    publishedAt,
+    publishedLock,
+    uploadedBy,
+    artefactConfigs,
+  } = opts;
+
+  if (typeof profileHash !== 'string') throw new Error('buildV2Meta: profileHash required');
+  if (typeof publishedAt !== 'string') throw new Error('buildV2Meta: publishedAt required (ISO 8601 UTC)');
+  if (buildSettings === undefined)     throw new Error('buildV2Meta: buildSettings required');
+
+  // Validate artefactConfigs shape when supplied so the manifest never
+  // lands on the registry with malformed slice metadata.
+  let artefactConfigsNonEmpty = false;
+  if (artefactConfigs !== undefined && artefactConfigs !== null) {
+    if (typeof artefactConfigs !== 'object' || Array.isArray(artefactConfigs)) {
+      throw new Error('buildV2Meta: artefactConfigs must be an object keyed by config name');
+    }
+    const entries = Object.entries(artefactConfigs);
+    for (const [config, entry] of entries) {
+      if (typeof config !== 'string' || config.length === 0 || config.trim() !== config) {
+        throw new Error(
+          `buildV2Meta: artefactConfigs key ${JSON.stringify(config)} must be a non-empty trimmed string`,
+        );
+      }
+      if (entry === null || typeof entry !== 'object' || Array.isArray(entry)) {
+        throw new Error(
+          `buildV2Meta: artefactConfigs[${JSON.stringify(config)}] must be an object`,
+        );
+      }
+      if (typeof entry.sha256 !== 'string' || !/^[0-9a-f]{64}$/.test(entry.sha256)) {
+        throw new Error(
+          `buildV2Meta: artefactConfigs[${JSON.stringify(config)}].sha256 must be 64 lowercase hex chars`,
+        );
+      }
+      if (!Number.isInteger(entry.sizeBytes) || entry.sizeBytes < 0) {
+        throw new Error(
+          `buildV2Meta: artefactConfigs[${JSON.stringify(config)}].sizeBytes must be a non-negative integer`,
+        );
+      }
+    }
+    artefactConfigsNonEmpty = entries.length > 0;
+  }
+
+  // At least one artefact-shape field must be supplied. Both is allowed
+  // (slice + fat-zip-fallback). Neither is a hard error — without it the
+  // manifest doesn't tell consumers what to download.
+  if (typeof contentSha256 !== 'string' && !artefactConfigsNonEmpty) {
+    throw new Error('buildV2Meta: contentSha256 or non-empty artefactConfigs required');
+  }
+
+  return {
+    ...rawManifest,
+    schemaVersion: 2,
+    profileHash,
+    buildSettings,
+    ...(typeof contentSha256 === 'string' ? { contentSha256 } : {}),
+    gitSha,
+    gitRepo,
+    publishedAt,
+    ...(publishedLock && Object.keys(publishedLock).length > 0 ? { publishedLock } : {}),
+    ...(uploadedBy ? { uploadedBy } : {}),
+    ...(artefactConfigsNonEmpty ? { artefactConfigs } : {}),
+  };
+}
+
+module.exports = { buildV2Meta };