@omega.js/backend 0.1.0

package/dist/utils/scaffold-defaults.js

@@ -0,0 +1,71 @@
+// @omega.js/backend's defaults scaffolding — applies the framework's defaults tree
+// (src/defaults/ → dist/defaults/ at runtime) to the consumer project root via
+// the shared devkit engine. Exported standalone (rather than living inside the
+// setup command) so the framework self-test can exercise the REAL file map
+// against a temp dir — mirrors BXM's exported scaffoldDefaults.
+
+const path = require('path');
+const { applyDefaults } = require('../vendor/devkit/defaults-engine.js');
+
+// minimatch FILE_MAP (last-match-wins). @omega.js/backend's contract:
+//   - everything copies on first scaffold only (consumer files are never clobbered)
+//   - AGENTS.md / .gitignore live-sync their Default section on every run via
+//     the marker-section merge (the Custom section is the consumer's,
+//     preserved verbatim). Both live at the TARGET ROOT.
+//   - the target-root .env is NOT scaffolded ([#678](https://github.com/Omega-JS-Stack/omega/issues/678)):
+//     the brand root's .env is the one file humans and the manager edit, a
+//     target .env is an optional per-key override a HUMAN writes, and the
+//     machine's env file is the composed dist/.env. No machine writes a
+//     target .env, so the template is skipped.
+// Patterns match the RAW defaults-tree path (before the `_.` strip), so the
+// mergeLines rules name `_.gitignore`, not its output.
+const FILE_MAP = {
+  '**/*': { overwrite: false },
+  // The socket-free static test lane (#567). It lands under `_`-prefixed dirs —
+  // the framework's test discovery skips those, so the static suites never run
+  // inside the emulator lane — but the defaults ENGINE reads a leading-`_`
+  // directory as an archive dir and skips it, so the tree ships them unprefixed
+  // and they are re-destinationed here.
+  'test/helpers/**': { overwrite: false, path: () => 'test/_helpers' },
+  'test/unit/**': { overwrite: false, path: () => 'test/_unit' },
+  // The agent-docs chain (#63): AGENTS.md carries the content (marker-merged
+  // like .gitignore), CLAUDE.md is the one-line `@AGENTS.md` pointer — copied when
+  // missing by the `**/*` rule above, never clobbered.
+  'AGENTS.md': { mergeLines: true },
+  '_.gitignore': { mergeLines: true },
+};
+
+/**
+ * Scaffold @omega.js/backend's defaults into a consumer project.
+ *
+ * @param {object} options
+ * @param {string} options.outputDir - Consumer project root (firebaseProjectPath)
+ * @param {string} [options.defaultsDir] - Override the defaults tree root (tests)
+ * @param {object} [options.logger] - `{ log, warn, error }` passed to the engine
+ * @returns {{ written: string[], merged: string[], skipped: string[] }}
+ */
+function scaffoldDefaults(options) {
+  options = options || {};
+
+  // Brand doc unification (Ian 2026-07-20): inside a brand monorepo the BRAND
+  // ROOT is the one doc home — per-target AGENTS.md/CLAUDE.md/CHANGELOG.md/docs/
+  // never scaffold, and existing framework-owned-only copies are swept (retire
+  // rules; consumer content is never destroyed). Standalone projects keep them.
+  const fileMap = { ...FILE_MAP };
+  const { resolveSeedMode } = require('../vendor/config/index.js');
+  if (!resolveSeedMode(options.outputDir).standalone) {
+    fileMap['AGENTS.md'] = { retire: true };
+    fileMap['CLAUDE.md'] = { retire: true };
+    fileMap['CHANGELOG.md'] = { retire: true };
+    fileMap['docs/**/*'] = { retire: true };
+  }
+
+  return applyDefaults({
+    defaultsDir: options.defaultsDir || path.resolve(__dirname, '../defaults'),
+    outputDir: options.outputDir,
+    fileMap,
+    logger: options.logger,
+  });
+}
+
+module.exports = { scaffoldDefaults, FILE_MAP };

package/dist/utils/test-lanes.js

@@ -0,0 +1,62 @@
+/**
+ * The opt-in test lanes THIS framework serves.
+ *
+ * A lane is two halves that must agree: a gate module at
+ * `src/cli/commands/test-lanes/<name>.js`, and a suite directory `test/<name>/`
+ * the runner keeps unreachable until that gate opens it. The NAME binding them
+ * has one home, the framework's own package.json `omega.testLanes`, because a
+ * third party reads it too: the brand-root `omega test --lane=<name>` fan-out
+ * asks each target's framework which lanes it declares before forwarding the
+ * flag ([#775](https://github.com/Omega-JS-Stack/omega/issues/775)). Two
+ * hardcoded copies of the string is exactly how a lane goes silently
+ * unreachable, or worse, silently open.
+ *
+ * Plain `fs` and a resolve from this file: the manifest sits two levels up in
+ * both layouts, `src/utils/` in the monorepo and `dist/utils/` in an install.
+ */
+const fs = require('fs');
+const path = require('path');
+
+const MANIFEST = path.resolve(__dirname, '..', '..', 'package.json');
+
+let cached = null;
+
+/**
+ * Every lane this framework declares.
+ *
+ * @returns {string[]} The declared lane names (empty when none are declared)
+ */
+function declaredLanes() {
+  if (cached) return cached;
+
+  const manifest = JSON.parse(fs.readFileSync(MANIFEST, 'utf8'));
+  const lanes = manifest.omega && manifest.omega.testLanes;
+  cached = Array.isArray(lanes) ? [...lanes] : [];
+
+  return cached;
+}
+
+/**
+ * The lane's own name, proved against the declaration.
+ *
+ * A gate module names itself with this, so a module whose file name drifted
+ * from the manifest fails LOUDLY at load instead of gating a lane nothing can
+ * reach.
+ *
+ * @param {string} name - The lane name (a gate module passes its own basename)
+ * @returns {string} The same name
+ * @throws {Error} When the manifest does not declare it
+ */
+function assertDeclaredLane(name) {
+  const lanes = declaredLanes();
+  if (!lanes.includes(name)) {
+    throw new Error(
+      `test lane "${name}" is not declared in ${MANIFEST} (omega.testLanes: ${JSON.stringify(lanes)}) — `
+      + 'declare it there, or rename the lane module to a declared name.',
+    );
+  }
+
+  return name;
+}
+
+module.exports = { declaredLanes, assertDeclaredLane, MANIFEST };

package/dist/vendor/account/engine.js

@@ -0,0 +1,182 @@
+/**
+ * Schema resolution engine — extracted verbatim from @omega.js/backend's
+ * src/manager/helpers/user.js, with ONE change: the '$uuid'/'$randomId'/'$apiKey'
+ * value generators are injected via ctx.generators instead of being required
+ * in-module. Hosts that can generate them (@omega.js/backend, Node) inject real generators;
+ * hosts that can't (@omega.js/client, browser) pass none and the fields resolve to
+ * null — the doc's real values always come from the backend.
+ *
+ * The engine is environment-agnostic: no dependencies, no Node APIs.
+ */
+
+/**
+ * Check if a schema node is a leaf field definition (has 'type' and 'default')
+ */
+function isLeaf(node) {
+  return node !== null
+    && typeof node === 'object'
+    && typeof node.type === 'string'
+    && 'default' in node;
+}
+
+/**
+ * Coerce a value to the expected type. Returns the coerced value or undefined if coercion fails.
+ */
+function coerce(value, type) {
+  if (typeof value === type) {
+    return value;
+  }
+
+  switch (type) {
+    case 'number': {
+      const n = Number(value);
+      return Number.isNaN(n) ? undefined : n;
+    }
+    case 'boolean': {
+      if (value === 'true' || value === 1) return true;
+      if (value === 'false' || value === 0) return false;
+      return Boolean(value);
+    }
+    case 'string': {
+      return String(value);
+    }
+    default: {
+      return undefined;
+    }
+  }
+}
+
+/**
+ * Resolve a single leaf field value
+ */
+function resolveLeaf(leaf, value, ctx) {
+  // Null handling
+  if (value === null) {
+    return leaf.nullable ? null : resolveDefault(leaf.default, ctx);
+  }
+
+  // Undefined → apply default
+  if (value === undefined) {
+    return resolveDefault(leaf.default, ctx);
+  }
+
+  // Array type — just check it's an array, don't coerce
+  if (leaf.type === 'array') {
+    return Array.isArray(value) ? value : resolveDefault(leaf.default, ctx);
+  }
+
+  // Type coercion
+  if (typeof value !== leaf.type) {
+    const coerced = coerce(value, leaf.type);
+    return coerced !== undefined ? coerced : resolveDefault(leaf.default, ctx);
+  }
+
+  return value;
+}
+
+/**
+ * Resolve a default value, handling special tokens
+ */
+function resolveDefault(def, ctx) {
+  if (typeof def !== 'string' || !def.startsWith('$')) {
+    // For arrays, return a fresh copy to avoid shared references
+    if (Array.isArray(def)) {
+      return [...def];
+    }
+    return def;
+  }
+
+  switch (def) {
+    case '$uuid':
+      return ctx.generators.uuid ? ctx.generators.uuid() : null;
+    case '$randomId':
+      return ctx.generators.randomId ? ctx.generators.randomId() : null;
+    case '$apiKey':
+      return ctx.generators.apiKey ? ctx.generators.apiKey() : null;
+    case '$oldDate':
+      return ctx.oldDate;
+    case '$oldDateUNIX':
+      return ctx.oldDateUNIX;
+    case '$now':
+      return ctx.now;
+    case '$nowUNIX':
+      return ctx.nowUNIX;
+    default:
+      return def;
+  }
+}
+
+/**
+ * Expand $timestamp shorthand into a schema branch
+ */
+function expandTimestamp(variant) {
+  const useNow = variant === '$timestamp:now';
+
+  return {
+    timestamp: { type: 'string', default: useNow ? '$now' : '$oldDate' },
+    timestampUNIX: { type: 'number', default: useNow ? '$nowUNIX' : 0 },
+  };
+}
+
+/**
+ * Recursively resolve a schema node against input data
+ */
+function resolve(schema, data, ctx) {
+  data = data || {};
+  const result = {};
+
+  // If $passthrough, start by copying all existing keys from data
+  const isPassthrough = schema.$passthrough === true;
+  const template = schema.$template || null;
+
+  if (isPassthrough) {
+    // Copy all data keys first (they'll be overwritten by defined schema fields below)
+    for (const key of Object.keys(data)) {
+      if (template && !key.startsWith('$') && !(key in schema)) {
+        // Dynamic key — resolve against template
+        result[key] = resolve(template, data[key], ctx);
+      } else if (!(key in schema) || key.startsWith('$')) {
+        // Unknown key not in schema — passthrough as-is
+        result[key] = data[key];
+      }
+    }
+  }
+
+  // Now resolve each defined schema field
+  for (const [key, node] of Object.entries(schema)) {
+    // Skip meta keys
+    if (key.startsWith('$')) {
+      continue;
+    }
+
+    // Handle string shorthands
+    if (typeof node === 'string') {
+      if (node === '$template') {
+        // Resolve against parent's $template
+        result[key] = resolve(template, data[key], ctx);
+        continue;
+      }
+      if (node.startsWith('$timestamp')) {
+        // Expand timestamp shorthand and recurse
+        result[key] = resolve(expandTimestamp(node), data[key], ctx);
+        continue;
+      }
+    }
+
+    // Leaf field
+    if (isLeaf(node)) {
+      result[key] = resolveLeaf(node, data[key], ctx);
+      continue;
+    }
+
+    // Nested branch (plain object)
+    if (node !== null && typeof node === 'object') {
+      result[key] = resolve(node, data[key], ctx);
+      continue;
+    }
+  }
+
+  return result;
+}
+
+module.exports = { resolve };

package/dist/vendor/account/features.js

@@ -0,0 +1,220 @@
+/**
+ * features.js — the ONE reading of the features contract
+ * ([#647](https://github.com/Omega-JS-Stack/omega/issues/647)).
+ *
+ * A feature is DEFINED once, in the config's top-level `features` catalog:
+ *
+ *   features: {
+ *     saves:   { name: 'Saves', icon: 'feather', definition: '…',
+ *                usage: { pace: 'daily', mirror: ['teams'] } },
+ *     support: { name: 'Priority support', icon: 'headset' },
+ *   }
+ *
+ * A `usage` block makes the entry COUNTED (metered per user); an entry without
+ * one is a PERK, never counted. Each product then names only its VALUE:
+ * `features: { saves: 100, support: true }` — a number on a counted feature
+ * (the MONTHLY limit, -1 unlimited), true/false/a string on a perk.
+ *
+ * This module is the shared home of every derivation both sides make from
+ * those two halves plus a user's stored counters — the backend's `consume`
+ * gate and the browser's account page must never disagree about what a user's
+ * limit is:
+ *   - the EFFECTIVE limit, where an admin-written `usage.overrides.<feature>`
+ *     on the user doc wins over the plan's number;
+ *   - the DAY share, `ceil(limit / days in this month)`, so a monthly quota
+ *     cannot be burned on day one (pacing is the default; `pace: false` opts
+ *     out to a plain monthly counter);
+ *   - the two counters a counted feature carries per user, month and day.
+ *
+ * -1 is the unlimited sentinel everywhere it can appear: a limit, a day share,
+ * and a remaining count.
+ */
+
+// Where a user's counters and overrides live on the account document.
+const USAGE_KEY = 'usage';
+const OVERRIDES_KEY = 'overrides';
+
+/**
+ * Is this catalog entry COUNTED? A `usage` block is what meters a feature;
+ * everything else is a perk the plan either includes or does not.
+ * @param {object} entry - a top-level `features` catalog entry
+ * @returns {boolean}
+ */
+function isCountedFeature(entry) {
+  return !!(entry && typeof entry === 'object' && entry.usage && typeof entry.usage === 'object' && !Array.isArray(entry.usage));
+}
+
+/**
+ * Is this feature paced by day? Pacing is the DEFAULT on every counted
+ * feature; `usage: { pace: false }` opts out to a plain monthly counter.
+ * @param {object} entry - a catalog entry
+ * @returns {boolean}
+ */
+function isPacedFeature(entry) {
+  return isCountedFeature(entry) && entry.usage.pace !== false;
+}
+
+/**
+ * The document kinds a counted feature's counters mirror onto, declared in the
+ * catalog rather than at the call site.
+ * @param {object} entry - a catalog entry
+ * @returns {string[]} the declared kinds, or []
+ */
+function featureMirrors(entry) {
+  return isCountedFeature(entry) && Array.isArray(entry.usage.mirror) ? entry.usage.mirror : [];
+}
+
+/**
+ * Days in the month the given date falls in.
+ * @param {Date} [date] - defaults to now
+ * @returns {number}
+ */
+function daysInMonth(date) {
+  const d = date || new Date();
+  return new Date(d.getFullYear(), d.getMonth() + 1, 0).getDate();
+}
+
+/**
+ * A month limit's share of ONE day: ceil(limit / days in this month), so a
+ * quota of 100 in a 31-day month allows 4 a day and never 100 on the 1st.
+ * Unlimited stays unlimited; nothing stays nothing.
+ * @param {number} limit - the effective MONTHLY limit (-1 unlimited)
+ * @param {Date} [date] - the day being paced, defaults to now
+ * @returns {number} the day's share (-1 unlimited)
+ */
+function dayShare(limit, date) {
+  if (!Number.isFinite(limit) || limit === 0) return 0;
+  if (limit < 0) return -1;
+  return Math.ceil(limit / daysInMonth(date));
+}
+
+/**
+ * The per-user override for a feature, when the account carries one. Written
+ * by admins only (the user doc's `usage` key is a framework field the security
+ * rules deny a client), and it WINS over the plan's number — extra credits
+ * granted to one account, not a second pricing tier.
+ * @param {object} account - the user document
+ * @param {string} id - feature id
+ * @returns {number|null} the override, or null when there is none
+ */
+function featureOverride(account, id) {
+  const value = account && account[USAGE_KEY] && account[USAGE_KEY][OVERRIDES_KEY]
+    ? account[USAGE_KEY][OVERRIDES_KEY][id]
+    : undefined;
+
+  return typeof value === 'number' && Number.isFinite(value) ? value : null;
+}
+
+/**
+ * What a product promises for one feature: its raw value from the product's
+ * `features` map. A product that never names the feature promises nothing.
+ * @param {object} product - a `payment.products` entry
+ * @param {string} id - feature id
+ * @returns {*} the value, or undefined
+ */
+function productFeatureValue(product, id) {
+  const values = product && product.features;
+  return values && typeof values === 'object' && !Array.isArray(values) ? values[id] : undefined;
+}
+
+/**
+ * The counters a user carries for one feature. The stored shape is
+ * `usage.<id>.{ monthly, daily, total, last }` — monthly and daily are the two
+ * the gate reads, total never resets, last records when it moved.
+ * @param {object} account - the user document
+ * @param {string} id - feature id
+ * @returns {{ monthly: number, daily: number, total: number }}
+ */
+function featureCounters(account, id) {
+  const stored = (account && account[USAGE_KEY] && account[USAGE_KEY][id]) || {};
+  const read = (key) => (typeof stored[key] === 'number' && Number.isFinite(stored[key]) ? stored[key] : 0);
+
+  return { monthly: read('monthly'), daily: read('daily'), total: read('total') };
+}
+
+/**
+ * How many of a limit are left, given what is used. Unlimited stays unlimited.
+ * @param {number} limit - the limit (-1 unlimited)
+ * @param {number} used - the counter
+ * @returns {number} what remains (-1 unlimited), never below zero
+ */
+function remaining(limit, used) {
+  if (limit < 0) return -1;
+  return Math.max(0, limit - used);
+}
+
+/**
+ * Resolve ONE feature against a catalog, a product and an account: everything
+ * a gate or an account page needs to speak about it in one object.
+ *
+ * @param {string} id - feature id
+ * @param {object} options
+ * @param {object} [options.catalog] - the top-level `features` catalog
+ * @param {object} [options.product] - the account's resolved product
+ * @param {object} [options.account] - the user document (counters + overrides)
+ * @param {Date} [options.now] - the day being paced, defaults to now
+ * @returns {object} { id, name, icon, definition, counted, paced, mirror,
+ *   value, limit, planLimit, override, used, left, total,
+ *   day: { limit, used, left } }
+ */
+function resolveFeature(id, options) {
+  options = options || {};
+
+  const entry = (options.catalog || {})[id] || null;
+  const counted = isCountedFeature(entry);
+  const value = productFeatureValue(options.product, id);
+  const counters = featureCounters(options.account, id);
+  const override = featureOverride(options.account, id);
+
+  const planLimit = counted && typeof value === 'number' ? value : 0;
+  const limit = counted && override !== null ? override : planLimit;
+  const paced = isPacedFeature(entry);
+  const dayLimit = paced ? dayShare(limit, options.now) : -1;
+
+  return {
+    id: id,
+    name: (entry && entry.name) || id,
+    icon: (entry && entry.icon) || null,
+    definition: (entry && entry.definition) || null,
+    counted: counted,
+    paced: paced,
+    mirror: featureMirrors(entry),
+    value: counted ? limit : value,
+    limit: limit,
+    planLimit: planLimit,
+    override: override,
+    used: counters.monthly,
+    left: remaining(limit, counters.monthly),
+    total: counters.total,
+    day: {
+      limit: dayLimit,
+      used: counters.daily,
+      left: remaining(dayLimit, counters.daily),
+    },
+  };
+}
+
+/**
+ * Resolve every feature the catalog defines, in CATALOG order — the row order
+ * every surface renders (pricing rows, account bars).
+ * @param {object} options - same options as resolveFeature
+ * @returns {object[]} one resolved feature per catalog entry
+ */
+function resolveFeatures(options) {
+  options = options || {};
+
+  return Object.keys(options.catalog || {}).map((id) => resolveFeature(id, options));
+}
+
+module.exports = {
+  isCountedFeature,
+  isPacedFeature,
+  featureMirrors,
+  featureOverride,
+  featureCounters,
+  productFeatureValue,
+  daysInMonth,
+  dayShare,
+  resolveFeature,
+  resolveFeatures,
+};

package/dist/vendor/account/index.js

@@ -0,0 +1,53 @@
+/**
+ * @omega.js/account — the single source of truth for the OMEGA user/account schema.
+ *
+ * Today the account shape lives in two drifted places: @omega.js/backend's
+ * src/manager/helpers/user.js (canonical — schema engine + tokens) and
+ * @omega.js/client's DEFAULT_ACCOUNT in modules/auth.js (hand-rolled deep-merge,
+ * missing flags/activity/personal branches and `everPaid`). This package
+ * unifies them; each framework becomes a thin wrapper (@omega.js/backend keeps its
+ * `new User(Manager, settings).properties` API, @omega.js/client keeps
+ * `resolveAccount(rawData, firebaseUser)`).
+ *
+ * resolveAccount(data, options):
+ *   options.generators — { uuid, randomId, apiKey } value generators for the
+ *     '$uuid'/'$randomId'/'$apiKey' schema tokens. @omega.js/backend injects real ones
+ *     (uuid v4, Utilities().randomId, uid-generator); the frontend passes none
+ *     and the fields resolve to null (real values always come from the backend).
+ *   options.user — optional auth-user overlay ({ uid, email }): fills
+ *     account.auth identity when the doc doesn't carry it (@omega.js/client's
+ *     resolveAccount(rawData, firebaseUser) semantic).
+ */
+const USER_SCHEMA = require('./schema.js');
+const { resolve } = require('./engine.js');
+const resolveSubscription = require('./subscription.js');
+const features = require('./features.js');
+
+function resolveAccount(data, options) {
+  options = options || {};
+
+  // Time context — byte-identical to @omega.js/backend's node-powertools timestamps:
+  // powertools.timestamp(d, { output: 'string' }) === d.toISOString(),
+  // powertools.timestamp(d, { output: 'unix' }) === floor(ms / 1000).
+  const now = new Date();
+  const ctx = {
+    generators: options.generators || {},
+    now: now.toISOString(),
+    nowUNIX: Math.floor(now.getTime() / 1000),
+    oldDate: new Date(0).toISOString(),
+    oldDateUNIX: 0,
+  };
+
+  const account = resolve(USER_SCHEMA, data || {}, ctx);
+
+  // Auth-user overlay (frontend semantic): identity from the signed-in Firebase
+  // user when the stored doc doesn't already carry it
+  if (options.user) {
+    account.auth.uid = account.auth.uid || options.user.uid || null;
+    account.auth.email = account.auth.email || options.user.email || null;
+  }
+
+  return account;
+}
+
+module.exports = { USER_SCHEMA, resolveAccount, resolveSubscription, ...features };