@omega.js/desktop 0.1.0

package/dist/vendor/config/defaults.js

@@ -0,0 +1,173 @@
+/**
+ * Schema-derived defaults — the ONE home of every config default
+ * ([#478](https://github.com/Omega-JS-Stack/omega/issues/478)).
+ *
+ * Defaults used to be scattered: a per-framework `options.defaults` blob, the
+ * manager's DEFAULTS layer, read-site fallbacks, and prose in the schema
+ * descriptions. Now a schema entry declares its own `default:` and everything
+ * derives from that:
+ *
+ *   - `schemaDefaults(target)` builds the merge chain's LOWEST layer
+ *     (load.js). A framework still passes `options.defaults` on top, but only
+ *     where that framework genuinely differs from the schema answer.
+ *   - `missingDefaults(config)` names the blocks a brand's omega.json5 has yet
+ *     to materialize — the manage walk writes exactly those, with each block's
+ *     schema description as its guiding comment, and never touches a key the
+ *     brand already authored (a new subsystem simply appears on the next run).
+ *
+ * A key with no sane framework answer carries no `default:` and is never
+ * materialized: owner decisions, tri-states that mean "ask", ids the services
+ * provision, anything secret-shaped (secrets live in .env regardless).
+ *
+ * A rule may also carry `materialize: false`
+ * ([#793](https://github.com/Omega-JS-Stack/omega/issues/793)): its `default:`
+ * still RESOLVES (schemaDefaults, so every reader sees the value) but is never
+ * WRITTEN into a brand's file. That is for framework facts a brand may override
+ * and rarely does — presentation the framework owns — where a copy in every
+ * brand config is a copy that drifts from the thing it came from.
+ */
+
+const { SHARED_SCHEMA, TARGET_SCHEMAS } = require('./schema.js');
+const { isPlainObject } = require('./merge.js');
+
+function hasDefault(rule) {
+  return Object.prototype.hasOwnProperty.call(rule, 'default');
+}
+
+/**
+ * Whether a rule's default is WRITTEN into a brand's file, not merely resolved
+ * ([#793](https://github.com/Omega-JS-Stack/omega/issues/793)). `materialize:
+ * false` means resolution-only: the fact stays at the layer that owns it.
+ * @param {object} rule
+ * @returns {boolean}
+ */
+function isMaterialized(rule) {
+  return rule.materialize !== false;
+}
+
+/**
+ * The rules that carry a default: SHARED_SCHEMA always, plus that target's
+ * refinements (they overlay the same top-level namespace loadConfig resolves).
+ * @param {string} [target] - Canonical target name ('web', 'backend', ...).
+ * @returns {object[]}
+ */
+function defaultRules(target) {
+  const rules = target && TARGET_SCHEMAS[target]
+    ? [...SHARED_SCHEMA, ...TARGET_SCHEMAS[target]]
+    : SHARED_SCHEMA;
+
+  return rules.filter(hasDefault);
+}
+
+function setAtPath(target, dotted, value) {
+  const names = dotted.split('.');
+  const leaf = names.pop();
+  let node = target;
+
+  for (const name of names) {
+    if (!isPlainObject(node[name])) node[name] = {};
+    node = node[name];
+  }
+
+  node[leaf] = value;
+}
+
+/**
+ * The default config a brand that authors nothing gets — every schema
+ * `default:` at its own dot-path. A fresh deep copy per call: a caller that
+ * mutates the result can never reach back into the schema.
+ * @param {string} [target] - Canonical target name; adds that target's refinements.
+ * @returns {object}
+ */
+function schemaDefaults(target) {
+  return defaultsFrom(defaultRules(target));
+}
+
+/**
+ * The default config a given rule set describes — every `default:` at its own
+ * dot-path, deep-copied per call.
+ * @param {object[]} rules - Rules that carry a default.
+ * @returns {object}
+ */
+function defaultsFrom(rules) {
+  const defaults = {};
+
+  for (const rule of rules) {
+    setAtPath(defaults, rule.path, structuredClone(rule.default));
+  }
+
+  return defaults;
+}
+
+/**
+ * The guiding comments a materialized block travels with: dot-path →
+ * description, for every defaulted key and for the container entries above
+ * them (a `marketing` block insert is documented, and so is each key it
+ * carries). The editor writes a comment only where it INSERTS that path, so
+ * the map covers the whole default set and the file gets what it lacks.
+ *
+ * @param {string} [target] - Canonical target name; adds that target's refinements.
+ * @returns {Object<string, string>}
+ */
+function defaultComments(target) {
+  const rules = target && TARGET_SCHEMAS[target]
+    ? [...SHARED_SCHEMA, ...TARGET_SCHEMAS[target]]
+    : SHARED_SCHEMA;
+
+  const defaulted = rules.filter(hasDefault).filter(isMaterialized).map((rule) => rule.path);
+  const comments = {};
+
+  for (const rule of rules) {
+    const documents = defaulted.some((dotted) => dotted === rule.path || dotted.startsWith(`${rule.path}.`));
+    if (documents && rule.description) {
+      comments[rule.path] = rule.description;
+    }
+  }
+
+  return comments;
+}
+
+function collectMissing(defaults, present, prefix, target, found) {
+  for (const [key, value] of Object.entries(defaults)) {
+    const dotted = prefix ? `${prefix}.${key}` : key;
+    const authored = isPlainObject(present) && Object.prototype.hasOwnProperty.call(present, key);
+
+    if (!authored) {
+      found.push({ path: dotted, value });
+      continue;
+    }
+
+    // Present and still a container on both sides → look for holes inside it.
+    // A brand that authored anything else at this path (a scalar, false, null)
+    // made a decision: never dive in, never overwrite.
+    if (isPlainObject(value) && isPlainObject(present[key])) {
+      collectMissing(value, present[key], dotted, target, found);
+    }
+  }
+
+  return found;
+}
+
+/**
+ * The schema-defaulted blocks a config does not carry yet, each at the HIGHEST
+ * path that is missing (a brand with no `marketing` at all gets one
+ * `marketing` block, not one edit per key inside it).
+ *
+ * Run against the RAW file contents the heal is about to edit, never a
+ * resolved config — resolution already merged the defaults in, so every block
+ * would read as present.
+ *
+ * @param {object} config - Parsed omega.json5 contents.
+ * @param {string} [target] - Canonical target name; adds that target's refinements.
+ * @returns {Array<{ path: string, value: * }>}
+ */
+function missingDefaults(config, target) {
+  // Resolution-only defaults are skipped whole: a `materialize: false` rule's
+  // value belongs to the framework, and writing it here would hand a brand a
+  // copy to drift ([#793](https://github.com/Omega-JS-Stack/omega/issues/793))
+  const writable = defaultsFrom(defaultRules(target).filter(isMaterialized));
+
+  return collectMissing(writable, config || {}, '', target, []);
+}
+
+module.exports = { schemaDefaults, missingDefaults, defaultComments, defaultRules };

package/dist/vendor/config/demo.js

@@ -0,0 +1,18 @@
+/**
+ * @omega.js/config demo — the shared demo-project test. Firebase's own
+ * convention: `demo-*` project ids are emulator-only (no real GCP project
+ * exists or ever will). Cloud-touching services and commands short-circuit
+ * on it instead of aiming real Google APIs at a project that 403s.
+ */
+
+/**
+ * Whether a Firebase project id is a demo-* (emulator-only) project.
+ *
+ * @param {string} projectId - e.g. 'demo-omega'
+ * @returns {boolean}
+ */
+function isDemoProject(projectId) {
+  return String(projectId || '').startsWith('demo-');
+}
+
+module.exports = { isDemoProject };

package/dist/vendor/config/desktop-artifacts.js

@@ -0,0 +1,110 @@
+/**
+ * @omega.js/config desktop-artifacts — the SINGLE naming rule for a desktop
+ * target's release assets ([#620](https://github.com/Omega-JS-Stack/omega/issues/620)).
+ *
+ * Two readers, one rule: @omega.js/desktop's `gulp/build-config` writes these
+ * names into `dist/electron-builder.yml`'s artifactName templates, and
+ * [site-global.js](site-global.js) derives the website's direct-download URLs
+ * from them (`<releasesUrl>/download/<name>`). A second spelling anywhere is a
+ * dead download button on a live site, so the derivation lives here and both
+ * sides call it.
+ *
+ * Names carry NO version. That is the whole point: GitHub's
+ * `/releases/latest/download/<asset>` only resolves when the asset name is the
+ * same in every release, so releasing a desktop version never touches the
+ * website and the published URLs never change. electron-updater is unaffected —
+ * it reads the feed files (`latest-mac.yml`, `latest.yml`), which name whatever
+ * artifact the build produced.
+ *
+ * Nothing puts an arch back into a name that omits one: electron-builder's
+ * macro expander only REPLACES a `${arch}` token where it appears. So these
+ * names support exactly the default build — a UNIVERSAL mac, a SINGLE linux
+ * arch, and windows' multi-arch NSIS installer (which merges every arch into
+ * one file anyway). @omega.js/desktop's build-config refuses any other arch set
+ * rather than let two builds collide on one name; per-arch names are a future
+ * additive change.
+ */
+
+// Every artifact a release publishes as a user-facing download, per platform,
+// in the order the platform offers them — the FIRST is the platform's default
+// (`/download/<platform>` leads with it, legacy UJM parity). The artifact keys
+// ARE the website's URL vocabulary (`/download/<platform>/<artifact>`).
+//
+// Deliberately absent: the mac auto-update ZIP (electron-updater fetches it
+// from the feed; nobody links it) and the snap (the Snap Store publishes it,
+// so it is never a release asset).
+const DESKTOP_ARTIFACTS = {
+  mac:     { universal: { ext: 'dmg' } },
+  windows: { universal: { ext: 'exe' } },
+  linux:   { debian: { ext: 'deb' }, appimage: { ext: 'AppImage' } },
+};
+
+/**
+ * The product name a desktop target packages under — the same derivation
+ * @omega.js/desktop's `Manager.getConfig()` applies (`app.productName` ←
+ * `brand.name`), so the website reads the name the packager actually used.
+ *
+ * @param {object} config - Desktop-shaped config (`{ app, brand }`).
+ * @returns {string} Product name ('' when neither key resolves).
+ */
+function desktopProductName(config) {
+  return config?.app?.productName || config?.brand?.name || '';
+}
+
+/**
+ * A product name reduced to filename-safe characters. electron-builder's
+ * `${productName}` keeps spaces, which become dots in NSIS output and behave
+ * inconsistently across targets; hyphens are consistent everywhere.
+ *
+ * @param {string} productName - Raw product name ("Deployment Playground").
+ * @returns {string} Sanitized name ("Deployment-Playground"), '' when empty.
+ */
+function sanitizeProductName(productName) {
+  return String(productName || '')
+    .replace(/[^A-Za-z0-9._-]+/g, '-')
+    .replace(/-+/g, '-')
+    .replace(/^-|-$/g, '');
+}
+
+/**
+ * One artifact's versionless filename: `<Product>-<platform>-<artifact>.<ext>`.
+ *
+ * @param {string} productName - Raw product name (sanitized here).
+ * @param {string} platform - Platform key (mac, windows, linux).
+ * @param {string} artifact - Artifact key (universal, debian, appimage, …).
+ * @param {string} [ext] - Extension override — pass electron-builder's literal
+ *   `${ext}` to get a TEMPLATE that covers every target sharing the platform's
+ *   fallback (mac's dmg + auto-update zip).
+ * @returns {string} The filename ('' with no product name to build it from).
+ */
+function desktopArtifactName(productName, platform, artifact, ext) {
+  const product = sanitizeProductName(productName);
+  const extension = ext || DESKTOP_ARTIFACTS[platform]?.[artifact]?.ext;
+  if (!product || !extension) return '';
+
+  return `${product}-${platform}-${artifact}.${extension}`;
+}
+
+/**
+ * Every published artifact's filename, keyed platform → artifact, in offer
+ * order.
+ *
+ * @param {string} productName - Raw product name.
+ * @returns {object} `{ mac: { universal: 'App-mac-universal.dmg' }, … }`, or
+ *   `{}` when there is no product name to derive from.
+ */
+function desktopArtifactNames(productName) {
+  if (!sanitizeProductName(productName)) return {};
+
+  const names = {};
+  for (const [platform, artifacts] of Object.entries(DESKTOP_ARTIFACTS)) {
+    names[platform] = {};
+    for (const artifact of Object.keys(artifacts)) {
+      names[platform][artifact] = desktopArtifactName(productName, platform, artifact);
+    }
+  }
+
+  return names;
+}
+
+module.exports = { DESKTOP_ARTIFACTS, desktopProductName, sanitizeProductName, desktopArtifactName, desktopArtifactNames };