@transitrix/diagrams 1.0.0 → 1.1.0

package/src/element-envelope.ts

@@ -1,76 +0,0 @@
-// Shared §3 envelope validator for standalone element primitives.
-//
-// Every standalone element file in the methodology canon carries the same
-// envelope: a fixed `notation` tag, a canonical `id` whose TYPE prefix matches
-// the element TYPE, `name`, an admission record (`zone`/`admitted_at`/
-// `admitted_by`/`gate_checks`), and a primitive lifecycle
-// (`valid_from`/`valid_to`). Per-TYPE fields (§7) sit between.
-//
-// Each per-TYPE validator delegates envelope checks here so the §3 rule lives
-// in one place; per-TYPE fields (subtype enums, cross-references) are checked
-// in the TYPE's own validator. The error `code` is parameterised so an
-// envelope failure surfaces under the TYPE's own code (e.g. `FACTOR-001`,
-// `CHANGE-001`), preserving per-TYPE attribution.
-
-import type { ValidationError } from './validation-types.js';
-import { isCanonicalIdOfType } from './typed-id.js';
-
-export interface EnvelopeOptions {
-  /** Fixed `notation:` tag — lowercased TYPE short name (e.g. `factor`). */
-  notation: string;
-  /** Required `id:` TYPE prefix (e.g. `FACTOR`). */
-  idType: string;
-  /** Error code used for every envelope failure (e.g. `FACTOR-001`). */
-  code: string;
-}
-
-export interface EnvelopeResult {
-  /** The input narrowed to a record on success; `null` when the input is not a mapping. */
-  record: Record<string, unknown> | null;
-  errors: ValidationError[];
-}
-
-export function validateElementEnvelope(input: unknown, opts: EnvelopeOptions): EnvelopeResult {
-  const errors: ValidationError[] = [];
-
-  if (input === null || typeof input !== 'object' || Array.isArray(input)) {
-    errors.push({ code: opts.code, message: `${opts.idType} must be a YAML mapping.` });
-    return { record: null, errors };
-  }
-  const r = input as Record<string, unknown>;
-
-  if (r.notation !== opts.notation) {
-    errors.push({
-      code: opts.code,
-      message: `notation must be the fixed value "${opts.notation}".`,
-      path: 'notation',
-    });
-  }
-  if (!isCanonicalIdOfType(r.id, opts.idType)) {
-    errors.push({
-      code: opts.code,
-      message: `id "${String(r.id)}" must match ${opts.idType}-[<middle>-]<INTEGER>.`,
-      path: 'id',
-    });
-  }
-  for (const f of ['name', 'admitted_at', 'admitted_by', 'valid_from'] as const) {
-    if (typeof r[f] !== 'string' || (r[f] as string).trim() === '') {
-      errors.push({ code: opts.code, message: `${f} is required.`, path: f });
-    }
-  }
-  if (r.zone !== 'canon') {
-    errors.push({ code: opts.code, message: 'zone is required and must be "canon".', path: 'zone' });
-  }
-  if (r.gate_checks === null || typeof r.gate_checks !== 'object' || Array.isArray(r.gate_checks)) {
-    errors.push({ code: opts.code, message: 'gate_checks is required and must be a mapping.', path: 'gate_checks' });
-  }
-  if (!('valid_to' in r) || !(typeof r.valid_to === 'string' || r.valid_to === null)) {
-    errors.push({
-      code: opts.code,
-      message: 'valid_to is required (an ISO date string or null).',
-      path: 'valid_to',
-    });
-  }
-
-  return { record: r, errors };
-}