wyvrnpm 1.2.1 → 2.0.1

package/src/providers/base.js

@@ -1,56 +1,133 @@
-'use strict';
-
-/**
- * Base provider class. All publish providers must extend this.
- *
- * To add a new provider:
- *   1. Create src/providers/<name>.js that extends BaseProvider
- *   2. Register it in src/providers/index.js
- */
-class BaseProvider {
-  /**
-   * Returns true if this provider can handle the given source string.
-   * Checked in registration order; first match wins.
-   * @param {string} _source
-   * @returns {boolean}
-   */
-  static canHandle(_source) {
-    return false;
-  }
-
-  /**
-   * Publish package files to the destination.
-   *
-   * @param {{ manifest: string, zip: string }} files
-   *   Absolute paths to the local wyvrn.json and wyvrn.zip to upload.
-   * @param {{ source: string, platform: string, name: string, version: string, profile?: string, token?: string }} options
-   *   `source`   – the raw --source value (URL / URI)
-   *   `platform` – target platform string (e.g. win_x64)
-   *   `name`     – package name from manifest
-   *   `version`  – package version from manifest
-   *   `profile`  – AWS SSO profile (S3 provider)
-   *   `token`    – Bearer token (HTTP provider)
-   * @returns {Promise<void>}
-   */
-  async publish(_files, _options) {
-    throw new Error(`publish() is not implemented in ${this.constructor.name}`);
-  }
-
-  /**
-   * Returns true if the given package version already exists at the destination.
-   * Providers should override this; the default assumes it does not exist.
-   *
-   * @param {{ source: string, platform: string, name: string, version: string, profile?: string, token?: string }} _options
-   * @returns {Promise<boolean>}
-   */
-  async exists(_options) {
-    return false;
-  }
-
-  /** Human-readable provider name shown in log output. */
-  static get providerName() {
-    return 'BaseProvider';
-  }
-}
-
-module.exports = BaseProvider;
+'use strict';
+
+/**
+ * Base provider class. All publish providers must extend this.
+ *
+ * To add a new provider:
+ *   1. Create src/providers/<name>.js that extends BaseProvider
+ *   2. Register it in src/providers/index.js
+ *
+ * ─── Schema versions ────────────────────────────────────────────────────────
+ *
+ *  v1 (legacy):  {source}/{platform}/{name}/{version}/wyvrn.{json,zip}
+ *                {source}/{platform}/{name}/latest.json
+ *
+ *  v2:           {source}/v2/{name}/{version}/{profileHash}/wyvrn.{json,zip}
+ *                {source}/v2/{name}/{version}/source.json
+ *                {source}/v2/{name}/versions.json
+ *                {source}/v2/{name}/latest.json
+ *
+ * Publishing with v2 tooling writes both v2 AND v1 paths by default so that
+ * v1 clients can still consume the packages.
+ */
+class BaseProvider {
+  /**
+   * Returns true if this provider can handle the given source string.
+   * Checked in registration order; first match wins.
+   * @param {string} _source
+   * @returns {boolean}
+   */
+  static canHandle(_source) {
+    return false;
+  }
+
+  // ── v1 (legacy) API ────────────────────────────────────────────────────────
+
+  /**
+   * Publish package files to the v1 destination path.
+   *
+   * @param {{ manifest: string, zip: string }} files
+   * @param {{ source: string, platform: string, name: string, version: string, awsProfile?: string, token?: string }} options
+   * @returns {Promise<void>}
+   */
+  async publish(_files, _options) {
+    throw new Error(`publish() is not implemented in ${this.constructor.name}`);
+  }
+
+  /**
+   * Returns true if the given package version already exists at the v1 destination.
+   *
+   * @param {{ source: string, platform: string, name: string, version: string, awsProfile?: string, token?: string }} _options
+   * @returns {Promise<boolean>}
+   */
+  async exists(_options) {
+    return false;
+  }
+
+  // ── v2 API ─────────────────────────────────────────────────────────────────
+
+  /**
+   * Returns true if a prebuilt binary matching the given profile hash already
+   * exists at the v2 destination.
+   *
+   * @param {{ source: string, name: string, version: string, profileHash: string, awsProfile?: string, token?: string }} _options
+   * @returns {Promise<boolean>}
+   */
+  async v2Exists(_options) {
+    return false;
+  }
+
+  /**
+   * Publish to the v2 path.
+   * Writes wyvrn.json + wyvrn.zip under profileHash, updates versions.json and latest.json.
+   *
+   * @param {{ manifest: string, zip: string }} files  - local file paths
+   * @param {{
+   *   source:        string,
+   *   name:          string,
+   *   version:       string,
+   *   profileHash:   string,
+   *   buildSettings: import('../profile').WyvrnProfile,  // stored in metadata for debugging
+   *   contentSha256: string,
+   *   gitSha:        string|null,
+   *   gitRepo:       string|null,
+   *   awsProfile?:   string,
+   *   token?:        string,
+   * }} options
+   * @returns {Promise<void>}
+   */
+  async v2Publish(_files, _options) {
+    throw new Error(`v2Publish() is not implemented in ${this.constructor.name}`);
+  }
+
+  /**
+   * Fetch the wyvrn.json metadata object for a specific v2 build.
+   * Returns null if the build does not exist.
+   *
+   * @param {{ source: string, name: string, version: string, profileHash: string, awsProfile?: string, token?: string }} _options
+   * @returns {Promise<object|null>}
+   */
+  async v2GetMeta(_options) {
+    return null;
+  }
+
+  /**
+   * Fetch and return the parsed versions.json index for a package.
+   * Returns null if no index exists yet.
+   *
+   * @param {{ source: string, name: string, awsProfile?: string, token?: string }} _options
+   * @returns {Promise<object|null>}
+   */
+  async v2GetVersionsIndex(_options) {
+    return null;
+  }
+
+  /**
+   * Download the prebuilt binary zip for a specific v2 build to destPath.
+   *
+   * @param {{ source: string, name: string, version: string, profileHash: string, awsProfile?: string, token?: string }} options
+   * @param {string} destPath  - absolute path to write the zip to
+   * @param {number} timeoutMs
+   * @returns {Promise<boolean>}  true on success
+   */
+  async v2DownloadZip(_options, _destPath, _timeoutMs) {
+    return false;
+  }
+
+  /** Human-readable provider name shown in log output. */
+  static get providerName() {
+    return 'BaseProvider';
+  }
+}
+
+module.exports = BaseProvider;

package/src/providers/file.js

@@ -1,71 +1,181 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const BaseProvider = require('./base');
-
-/**
- * File system provider — handles local directories and SMB/UNC shares.
- *
- * Recognised source formats:
- *   /abs/unix/path
- *   ./relative/path   ../relative/path
- *   C:\Windows\path   C:/Windows/path   (drive-letter)
- *   \\server\share\path                 (SMB UNC — backslash)
- *   //server/share/path                 (SMB UNC — forward slash)
- *   file:///path                        (file URI)
- */
-class FileProvider extends BaseProvider {
-  static canHandle(source) {
-    return (
-      source.startsWith('file://') ||
-      source.startsWith('//') ||
-      source.startsWith('\\\\') ||
-      source.startsWith('/') ||
-      source.startsWith('./') ||
-      source.startsWith('../') ||
-      /^[a-zA-Z]:[/\\]/.test(source) // Windows drive letter
-    );
-  }
-
-  static get providerName() {
-    return 'File';
-  }
-
-  /** Normalise a source string to an absolute file system path. */
-  _resolvePath(source) {
-    if (source.startsWith('file://')) {
-      return path.resolve(new URL(source).pathname);
-    }
-    return path.resolve(source);
-  }
-
-  async exists(options) {
-    const { source, platform, name, version } = options;
-    const destDir = path.join(this._resolvePath(source), platform, name, version);
-    return fs.existsSync(path.join(destDir, 'wyvrn.json'));
-  }
-
-  async publish(files, options) {
-    const { source, platform, name, version } = options;
-
-    const packageDir = path.join(this._resolvePath(source), platform, name);
-    const destDir = path.join(packageDir, version);
-    fs.mkdirSync(destDir, { recursive: true });
-
-    this._copy(files.manifest, path.join(destDir, 'wyvrn.json'));
-    this._copy(files.zip, path.join(destDir, 'wyvrn.zip'));
-
-    // Write latest.json at the package root so consumers can resolve "latest"
-    const latestPath = path.join(packageDir, 'latest.json');
-    console.log(`[wyvrn]   → ${latestPath}`);
-    fs.writeFileSync(latestPath, JSON.stringify({ version }), 'utf8');
-  }
-
-  _copy(src, dest) {
-    console.log(`[wyvrn]   → ${dest}`);
-    fs.copyFileSync(src, dest);
-  }
-}
-
-module.exports = FileProvider;
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const BaseProvider = require('./base');
+
+/**
+ * File system provider — handles local directories and SMB/UNC shares.
+ *
+ * Recognised source formats:
+ *   /abs/unix/path
+ *   ./relative/path   ../relative/path
+ *   C:\Windows\path   C:/Windows/path   (drive-letter)
+ *   \\server\share\path                 (SMB UNC — backslash)
+ *   //server/share/path                 (SMB UNC — forward slash)
+ *   file:///path                        (file URI)
+ */
+function pinDependencies(rawDeps, lockedDeps) {
+  if (!rawDeps || !lockedDeps || Object.keys(lockedDeps).length === 0) return rawDeps;
+  const result = {};
+  for (const [pkgName, value] of Object.entries(rawDeps)) {
+    const locked = lockedDeps[pkgName];
+    if (locked) {
+      result[pkgName] = typeof value === 'object' && value !== null
+        ? { ...value, version: locked }
+        : locked;
+    } else {
+      result[pkgName] = value;
+    }
+  }
+  return result;
+}
+
+class FileProvider extends BaseProvider {
+  static canHandle(source) {
+    return (
+      source.startsWith('file://') ||
+      source.startsWith('//') ||
+      source.startsWith('\\\\') ||
+      source.startsWith('/') ||
+      source.startsWith('./') ||
+      source.startsWith('../') ||
+      /^[a-zA-Z]:[/\\]/.test(source)
+    );
+  }
+
+  static get providerName() {
+    return 'File';
+  }
+
+  _resolvePath(source) {
+    if (source.startsWith('file://')) {
+      return path.resolve(new URL(source).pathname);
+    }
+    return path.resolve(source);
+  }
+
+  _copy(src, dest) {
+    console.log(`[wyvrn]   → ${dest}`);
+    fs.copyFileSync(src, dest);
+  }
+
+  _writeJson(filePath, data) {
+    console.log(`[wyvrn]   → ${filePath}`);
+    fs.writeFileSync(filePath, JSON.stringify(data, null, 2) + '\n', 'utf8');
+  }
+
+  _readJson(filePath) {
+    if (!fs.existsSync(filePath)) return null;
+    try { return JSON.parse(fs.readFileSync(filePath, 'utf8')); }
+    catch { return null; }
+  }
+
+  // ── v1 (legacy) API ───────────────────────────────────────────────────────
+
+  async exists({ source, platform, name, version }) {
+    const destDir = path.join(this._resolvePath(source), platform, name, version);
+    return fs.existsSync(path.join(destDir, 'wyvrn.json'));
+  }
+
+  async publish(files, { source, platform, name, version }) {
+    const packageDir = path.join(this._resolvePath(source), platform, name);
+    const destDir    = path.join(packageDir, version);
+    fs.mkdirSync(destDir, { recursive: true });
+
+    this._copy(files.manifest, path.join(destDir, 'wyvrn.json'));
+    this._copy(files.zip,      path.join(destDir, 'wyvrn.zip'));
+
+    const latestPath = path.join(packageDir, 'latest.json');
+    console.log(`[wyvrn]   → ${latestPath}`);
+    fs.writeFileSync(latestPath, JSON.stringify({ version }), 'utf8');
+  }
+
+  // ── v2 API ────────────────────────────────────────────────────────────────
+
+  _v2Root(source, name) {
+    return path.join(this._resolvePath(source), 'v2', name);
+  }
+
+  async v2Exists({ source, name, version, profileHash }) {
+    const p = path.join(this._v2Root(source, name), version, profileHash, 'wyvrn.json');
+    return fs.existsSync(p);
+  }
+
+  async v2Publish(files, options) {
+    const {
+      source, name, version, profileHash, buildSettings,
+      contentSha256, gitSha, gitRepo, lockedDependencies,
+    } = options;
+
+    const v2root    = this._v2Root(source, name);
+    const buildDir  = path.join(v2root, version, profileHash);
+    fs.mkdirSync(buildDir, { recursive: true });
+
+    // 1) zip
+    this._copy(files.zip, path.join(buildDir, 'wyvrn.zip'));
+
+    // 2) enriched wyvrn.json (buildSettings stored for debugging only)
+    //    Dependencies are replaced with locked versions so the server never sees "latest".
+    const rawManifest = JSON.parse(fs.readFileSync(files.manifest, 'utf8'));
+    const pinnedDeps = pinDependencies(rawManifest.dependencies, lockedDependencies);
+    const v2Meta = {
+      ...rawManifest,
+      ...(pinnedDeps !== undefined ? { dependencies: pinnedDeps } : {}),
+      schemaVersion: 2,
+      profileHash,
+      buildSettings,
+      contentSha256,
+      gitSha:      gitSha  ?? null,
+      gitRepo:     gitRepo ?? null,
+      publishedAt: new Date().toISOString(),
+    };
+    this._writeJson(path.join(buildDir, 'wyvrn.json'), v2Meta);
+
+    // 3) source.json
+    if (gitSha || gitRepo) {
+      const versionDir = path.join(v2root, version);
+      fs.mkdirSync(versionDir, { recursive: true });
+      this._writeJson(path.join(versionDir, 'source.json'), {
+        gitRepo: gitRepo ?? null, gitSha: gitSha ?? null,
+      });
+    }
+
+    // 4) versions.json index
+    const versionsPath = path.join(v2root, 'versions.json');
+    let versionsIdx = this._readJson(versionsPath) ?? { name, latest: version, versions: {} };
+    if (!versionsIdx.versions) versionsIdx.versions = {};
+    if (!versionsIdx.versions[version]) versionsIdx.versions[version] = { profiles: {} };
+    versionsIdx.versions[version].profiles[profileHash] = {
+      contentSha256,
+      publishedAt: new Date().toISOString(),
+      buildSettings,
+    };
+    if (gitSha || gitRepo) {
+      versionsIdx.versions[version].source = { gitRepo: gitRepo ?? null, gitSha: gitSha ?? null };
+    }
+    versionsIdx.latest = version;
+    this._writeJson(versionsPath, versionsIdx);
+
+    // 5) v2 latest.json
+    this._writeJson(path.join(v2root, 'latest.json'), { version, profileHash, contentSha256 });
+  }
+
+  async v2GetMeta({ source, name, version, profileHash }) {
+    const p = path.join(this._v2Root(source, name), version, profileHash, 'wyvrn.json');
+    return this._readJson(p);
+  }
+
+  async v2GetVersionsIndex({ source, name }) {
+    return this._readJson(path.join(this._v2Root(source, name), 'versions.json'));
+  }
+
+  async v2DownloadZip({ source, name, version, profileHash }, destPath) {
+    const src = path.join(this._v2Root(source, name), version, profileHash, 'wyvrn.zip');
+    if (!fs.existsSync(src)) return false;
+    fs.copyFileSync(src, destPath);
+    return true;
+  }
+}
+
+module.exports = FileProvider;