@studyportals/data-api-interface 0.0.0-stage → 0.1.0-0

package/README.md

@@ -1,3 +1,90 @@
-# Temporary Holding Version
+# @studyportals/data-api-interface
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Schema validation for Data API import records. Producers (SIA) validate records with it before pushing them into the Import Data Stream; the import pipeline runs the same code as its schema-level validation, so both sides apply identical rules.
+
+Pure functions only: no AWS SDK, no network, no I/O. Ships ES module and CommonJS builds with types. Node 24 or later.
+
+## Record
+
+```ts
+import type { ImportRecord } from "@studyportals/data-api-interface";
+
+const record: ImportRecord = {
+	entityType: "study",
+	entityId: 123,
+	eventId: "…",               // issued by the registration endpoint
+	eventTimestamp: 1790165122, // epoch seconds, set right before pushing
+	set: {
+		tuitionFees: [{ target: "international", amount: 18500, currency: "EUR", unit: "year", discount: { type: "percentage", value: 10 } }],
+		tuitionFeeDescription: "Tuition per academic year",
+	},
+	clear: {
+		tuitionFees: ["eea"],
+	},
+};
+```
+
+- `set` gives properties a new value; `clear` removes values. Every action is explicit: setting never removes anything. A record may clear and set the same thing: clear is applied first, then set, so it replaces.
+- What `clear` holds depends on the property: `true` for a single value (`tuitionFeeDescription: true`), the keys of the items to remove for a list (`tuitionFees: ["eea", "local"]`; removing every fee lists every target).
+- Only properties in the registry are writable; anything else is rejected.
+- Writable properties: `tuitionFees` and `tuitionFeeDescription` (1–160 characters).
+- `tuitionFees` holds `tuition_fees` rows to create or replace, matched by `target` (`eea`, `national`, `international`, `local`); fees of other targets stay. The list is not empty, has at most one fee per target, one currency and one unit for all fees, and no `eea` fee next to a `national` or `local` fee.
+- A fee has a `target`, an integer `amount` (≥ 0), an ISO 4217 `currency` code, a `unit` (`module`, `day`, `week`, `month`, `quarter`, `trimester`, `semester`, `year`, `credit`, `full`) and a `discount`, always given: `percentage` with 1 ≤ value ≤ 99.99, or `flat` with value 0 (no discount; the database has no null) or 1 ≤ value ≤ amount − 1. A percentage of 0 is not allowed.
+
+The JSON Schema of the issued record is published as `@studyportals/data-api-interface/import-record.schema.json`. It cannot express cross-field rules such as the flat-discount bound; the TypeScript validators are authoritative.
+
+## Producers
+
+```ts
+import { validateDraft, validateRecord } from "@studyportals/data-api-interface";
+
+const draft = validateDraft({ entityType: "study", entityId: 123, set, clear });   // before requesting eventIds
+if (!draft.valid) { … }
+
+const result = validateRecord({ ...draft.record, eventId, eventTimestamp });       // right before PutRecords
+if (!result.valid) {
+	// result.stage: "schema" | "property"; result.failures: every failure of that stage
+	for (const { code, property, path, reason } of result.failures) { … }
+}
+```
+
+Failure codes: `SCHEMA_INVALID` (wrong shape: envelope, unsupported or missing keys, wrong JSON types), `PROPERTY_NOT_WRITABLE`, `PROPERTY_VALUE_INVALID` (a well-shaped value that breaks a rule, e.g. currency format or one fee per target). Paths start at the record, e.g. `set.tuitionFees.0.amount`. Reasons name properties and expectations, never record values.
+
+A complete, runnable producer flow is in [`examples/producer.mts`](examples/producer.mts); `npm run test-consumers` type-checks and runs it against the packed package.
+
+Passing these checks does not guarantee the import succeeds: the pipeline also runs validators that need existing data, for example that `day` and `week` units are only allowed for short programmes.
+
+## Import pipeline
+
+```ts
+import { registry, resolveEntries, validateProperties, validateSchema, validateValue, type RegistryKey } from "@studyportals/data-api-interface";
+
+const schema = validateSchema(input);              // phase 1: envelope and shape of known properties
+// claim the identifier, drop stale properties
+const simple = validateProperties(currentRecord);  // phase 2: allowlist and record-only validators
+// enrichment and dependent validators for resolveEntries(currentRecord)
+const failures = validateValue("tuitionFees", mergedFees); // the record's rules, re-run on existing fees merged with the record's
+```
+
+Extend every registry entry by key with the pipeline's enrichment and dependent validators. The mapped type makes the pipeline fail to compile when a new package version adds an entry it does not handle:
+
+```ts
+const pipelineRegistry: { readonly [K in RegistryKey]: PipelineEntry } = {
+	tuitionFees: { ...registry.tuitionFees, enrich: [Enrichment.STUDY_LEVEL, Enrichment.TUITION_FEE_EXISTING], dependent: [mergedFeesValid, unitMatchesLevel] },
+	tuitionFeeDescription: { ...registry.tuitionFeeDescription, enrich: [], dependent: [] },
+};
+```
+
+## Development
+
+Develop on Node 26 (`.nvmrc`); tests must also pass on Node 24.
+
+```bash
+npm ci
+npm run lint
+npm run test-u          # tsc + Vitest, also pins schema/import-record.schema.json
+npm run build           # tsup → dist/ (CJS .js + ESM .mjs, .d.ts/.d.mts)
+npm run test-consumers  # packs, installs, then import/require and type checks under nodenext, bundler, node10
+```
+
+After an intended contract change, regenerate the JSON Schema with `npx vitest run -u` and review the diff.

package/dist/index.d.mts

@@ -0,0 +1,109 @@
+/** A record before the registration endpoint has issued its identifiers. */
+interface ImportRecordDraft {
+    readonly entityType: "study";
+    readonly entityId: number;
+    readonly set: Partial<PropertyValues>;
+    readonly clear: Partial<PropertyClears>;
+}
+interface ImportRecord extends ImportRecordDraft {
+    readonly eventId: string;
+    /** Epoch seconds, set by the producer right before the record is pushed. */
+    readonly eventTimestamp: number;
+}
+/** A record whose envelope is valid but whose properties are not checked yet. */
+type Unchecked<T extends ImportRecordDraft> = Omit<T, "set" | "clear"> & {
+    readonly set: Readonly<Record<string, unknown>>;
+    readonly clear: Readonly<Record<string, unknown>>;
+};
+type ErrorCode = "SCHEMA_INVALID" | "PROPERTY_NOT_WRITABLE" | "PROPERTY_VALUE_INVALID";
+interface Failure<Code extends string = ErrorCode> {
+    readonly code: Code;
+    readonly property?: string;
+    readonly path?: string;
+    /** Names properties and expectations, never record values. */
+    readonly reason: string;
+}
+type ValidationResult<T> = {
+    readonly valid: true;
+    readonly record: T;
+} | {
+    readonly valid: false;
+    readonly stage: "schema" | "property";
+    readonly failures: readonly Failure[];
+};
+
+declare const TUITION_FEE_TARGETS: readonly ["eea", "national", "international", "local"];
+type TuitionFeeTarget = (typeof TUITION_FEE_TARGETS)[number];
+declare const TUITION_FEE_UNITS: readonly ["module", "day", "week", "month", "quarter", "trimester", "semester", "year", "credit", "full"];
+type TuitionFeeUnit = (typeof TUITION_FEE_UNITS)[number];
+interface TuitionFeeDiscount {
+    readonly type: "flat" | "percentage";
+    readonly value: number;
+}
+/** One `tuition_fees` row. */
+interface TuitionFee {
+    readonly target: TuitionFeeTarget;
+    readonly amount: number;
+    readonly currency: string;
+    readonly unit: TuitionFeeUnit;
+    /** Always given: a flat discount of 0 means no discount, the database has no null for it. */
+    readonly discount: TuitionFeeDiscount;
+}
+
+interface PropertyValues {
+    /** Fees to create, matched by target. A record that also clears a target replaces that fee: clear is applied first. */
+    tuitionFees: readonly TuitionFee[];
+    tuitionFeeDescription: string;
+}
+interface PropertyClears {
+    /** Targets whose fees are removed. Removing every fee lists every target. */
+    tuitionFees: readonly TuitionFeeTarget[];
+    tuitionFeeDescription: true;
+}
+type PropertyName = keyof PropertyValues;
+type PropertyFailure = Failure<"PROPERTY_VALUE_INVALID">;
+/**
+ * Checks one property value; paths are relative to the value. Producers get it through the validate
+ * functions; the import pipeline also runs it on the enriched value, e.g. existing fees merged with the record's.
+ */
+declare const validateValue: <P extends PropertyName>(property: P, value: unknown) => PropertyFailure[];
+
+interface SimpleContext {
+    readonly record: Unchecked<ImportRecordDraft>;
+    /** The entry's properties that the record sets or clears. */
+    readonly touched: readonly PropertyName[];
+}
+/** Returns every failure it finds; an empty array means valid. */
+type Validator<Context = SimpleContext, Code extends string = Failure["code"]> = (context: Context) => Failure<Code>[];
+interface RegistryEntry {
+    readonly properties: readonly PropertyName[];
+    /** Record-only validators. Run as a chain that stops at the first validator reporting failures. */
+    readonly simple: readonly Validator[];
+}
+/**
+ * The writable-property allowlist. The import pipeline extends each entry by key with its
+ * enrichment and dependent validators, typed `{ [K in RegistryKey]: … }` so a new entry
+ * cannot be missed.
+ */
+declare const registry: {
+    readonly tuitionFees: RegistryEntry;
+    readonly tuitionFeeDescription: RegistryEntry;
+};
+type RegistryKey = keyof typeof registry;
+/** Keys of the registry entries covering the record's touched properties. Unknown properties are ignored. */
+declare const resolveEntries: (record: Unchecked<ImportRecordDraft>) => RegistryKey[];
+
+/** Phase 1 of the pipeline (and the first half of {@link validateRecord}): envelope and the shape of known properties. */
+declare const validateSchema: (input: unknown) => ValidationResult<Unchecked<ImportRecord>>;
+/**
+ * Phase 2, simple part: writable-property allowlist and record-only validators. The pipeline calls it after
+ * dropping stale properties and before enrichment.
+ */
+declare const validateProperties: (record: Unchecked<ImportRecord>) => ValidationResult<ImportRecord>;
+/** For producers, before the registration endpoint has issued `eventId`. */
+declare const validateDraft: (input: unknown) => ValidationResult<ImportRecordDraft>;
+/** For producers, right before the record is pushed into the Data Stream. */
+declare const validateRecord: (input: unknown) => ValidationResult<ImportRecord>;
+
+export { registry, resolveEntries, validateDraft, validateProperties, validateRecord, validateSchema, validateValue };
+export type { ErrorCode, Failure, ImportRecord, ImportRecordDraft, PropertyClears, PropertyName, PropertyValues, RegistryEntry, RegistryKey, SimpleContext, TuitionFee, TuitionFeeDiscount, TuitionFeeTarget, TuitionFeeUnit, Unchecked, ValidationResult, Validator };

package/dist/index.d.ts

@@ -0,0 +1,109 @@
+/** A record before the registration endpoint has issued its identifiers. */
+interface ImportRecordDraft {
+    readonly entityType: "study";
+    readonly entityId: number;
+    readonly set: Partial<PropertyValues>;
+    readonly clear: Partial<PropertyClears>;
+}
+interface ImportRecord extends ImportRecordDraft {
+    readonly eventId: string;
+    /** Epoch seconds, set by the producer right before the record is pushed. */
+    readonly eventTimestamp: number;
+}
+/** A record whose envelope is valid but whose properties are not checked yet. */
+type Unchecked<T extends ImportRecordDraft> = Omit<T, "set" | "clear"> & {
+    readonly set: Readonly<Record<string, unknown>>;
+    readonly clear: Readonly<Record<string, unknown>>;
+};
+type ErrorCode = "SCHEMA_INVALID" | "PROPERTY_NOT_WRITABLE" | "PROPERTY_VALUE_INVALID";
+interface Failure<Code extends string = ErrorCode> {
+    readonly code: Code;
+    readonly property?: string;
+    readonly path?: string;
+    /** Names properties and expectations, never record values. */
+    readonly reason: string;
+}
+type ValidationResult<T> = {
+    readonly valid: true;
+    readonly record: T;
+} | {
+    readonly valid: false;
+    readonly stage: "schema" | "property";
+    readonly failures: readonly Failure[];
+};
+
+declare const TUITION_FEE_TARGETS: readonly ["eea", "national", "international", "local"];
+type TuitionFeeTarget = (typeof TUITION_FEE_TARGETS)[number];
+declare const TUITION_FEE_UNITS: readonly ["module", "day", "week", "month", "quarter", "trimester", "semester", "year", "credit", "full"];
+type TuitionFeeUnit = (typeof TUITION_FEE_UNITS)[number];
+interface TuitionFeeDiscount {
+    readonly type: "flat" | "percentage";
+    readonly value: number;
+}
+/** One `tuition_fees` row. */
+interface TuitionFee {
+    readonly target: TuitionFeeTarget;
+    readonly amount: number;
+    readonly currency: string;
+    readonly unit: TuitionFeeUnit;
+    /** Always given: a flat discount of 0 means no discount, the database has no null for it. */
+    readonly discount: TuitionFeeDiscount;
+}
+
+interface PropertyValues {
+    /** Fees to create, matched by target. A record that also clears a target replaces that fee: clear is applied first. */
+    tuitionFees: readonly TuitionFee[];
+    tuitionFeeDescription: string;
+}
+interface PropertyClears {
+    /** Targets whose fees are removed. Removing every fee lists every target. */
+    tuitionFees: readonly TuitionFeeTarget[];
+    tuitionFeeDescription: true;
+}
+type PropertyName = keyof PropertyValues;
+type PropertyFailure = Failure<"PROPERTY_VALUE_INVALID">;
+/**
+ * Checks one property value; paths are relative to the value. Producers get it through the validate
+ * functions; the import pipeline also runs it on the enriched value, e.g. existing fees merged with the record's.
+ */
+declare const validateValue: <P extends PropertyName>(property: P, value: unknown) => PropertyFailure[];
+
+interface SimpleContext {
+    readonly record: Unchecked<ImportRecordDraft>;
+    /** The entry's properties that the record sets or clears. */
+    readonly touched: readonly PropertyName[];
+}
+/** Returns every failure it finds; an empty array means valid. */
+type Validator<Context = SimpleContext, Code extends string = Failure["code"]> = (context: Context) => Failure<Code>[];
+interface RegistryEntry {
+    readonly properties: readonly PropertyName[];
+    /** Record-only validators. Run as a chain that stops at the first validator reporting failures. */
+    readonly simple: readonly Validator[];
+}
+/**
+ * The writable-property allowlist. The import pipeline extends each entry by key with its
+ * enrichment and dependent validators, typed `{ [K in RegistryKey]: … }` so a new entry
+ * cannot be missed.
+ */
+declare const registry: {
+    readonly tuitionFees: RegistryEntry;
+    readonly tuitionFeeDescription: RegistryEntry;
+};
+type RegistryKey = keyof typeof registry;
+/** Keys of the registry entries covering the record's touched properties. Unknown properties are ignored. */
+declare const resolveEntries: (record: Unchecked<ImportRecordDraft>) => RegistryKey[];
+
+/** Phase 1 of the pipeline (and the first half of {@link validateRecord}): envelope and the shape of known properties. */
+declare const validateSchema: (input: unknown) => ValidationResult<Unchecked<ImportRecord>>;
+/**
+ * Phase 2, simple part: writable-property allowlist and record-only validators. The pipeline calls it after
+ * dropping stale properties and before enrichment.
+ */
+declare const validateProperties: (record: Unchecked<ImportRecord>) => ValidationResult<ImportRecord>;
+/** For producers, before the registration endpoint has issued `eventId`. */
+declare const validateDraft: (input: unknown) => ValidationResult<ImportRecordDraft>;
+/** For producers, right before the record is pushed into the Data Stream. */
+declare const validateRecord: (input: unknown) => ValidationResult<ImportRecord>;
+
+export { registry, resolveEntries, validateDraft, validateProperties, validateRecord, validateSchema, validateValue };
+export type { ErrorCode, Failure, ImportRecord, ImportRecordDraft, PropertyClears, PropertyName, PropertyValues, RegistryEntry, RegistryKey, SimpleContext, TuitionFee, TuitionFeeDiscount, TuitionFeeTarget, TuitionFeeUnit, Unchecked, ValidationResult, Validator };

package/dist/index.js

@@ -0,0 +1,217 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  registry: () => registry,
+  resolveEntries: () => resolveEntries,
+  validateDraft: () => validateDraft,
+  validateProperties: () => validateProperties,
+  validateRecord: () => validateRecord,
+  validateSchema: () => validateSchema,
+  validateValue: () => validateValue
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/failures.ts
+var toFailures = (error, code, property, prefix = []) => error.issues.map((issue) => {
+  const path = [...prefix, ...issue.path].map(String);
+  return {
+    code,
+    ...property === void 0 ? {} : { property },
+    ...path.length === 0 ? {} : { path: path.join(".") },
+    reason: issue.message
+  };
+});
+
+// src/properties/tuition-fees.ts
+var import_zod2 = require("zod");
+
+// src/properties/definition.ts
+var import_zod = require("zod");
+var shapeFailures = (schema, slot2, property, side) => {
+  const result = slot2 && schema.safeParse(slot2.value);
+  return result?.success === false ? toFailures(result.error, "SCHEMA_INVALID", property, [side, property]) : [];
+};
+var defineProperty = (definition) => ({
+  value: definition.value,
+  set: definition.set.value,
+  clear: definition.clear.value,
+  checkShape: (property, set, clear) => [
+    ...shapeFailures(definition.set.shape, set, property, "set"),
+    ...shapeFailures(definition.clear.shape, clear, property, "clear")
+  ]
+});
+var scalarProperty = (set) => defineProperty({ value: set.value, set, clear: { shape: import_zod.z.literal(true), value: import_zod.z.literal(true) } });
+
+// src/properties/tuition-fees.ts
+var TUITION_FEE_TARGETS = ["eea", "national", "international", "local"];
+var TUITION_FEE_UNITS = ["module", "day", "week", "month", "quarter", "trimester", "semester", "year", "credit", "full"];
+var feeShape = import_zod2.z.strictObject({
+  target: import_zod2.z.string(),
+  amount: import_zod2.z.number(),
+  currency: import_zod2.z.string(),
+  unit: import_zod2.z.string(),
+  discount: import_zod2.z.strictObject({ type: import_zod2.z.string(), value: import_zod2.z.number() })
+});
+var INT32_MAX = 2147483647;
+var fee = import_zod2.z.strictObject({
+  target: import_zod2.z.enum(TUITION_FEE_TARGETS),
+  amount: import_zod2.z.int().min(0).max(INT32_MAX),
+  currency: import_zod2.z.currencyCode(),
+  unit: import_zod2.z.enum(TUITION_FEE_UNITS),
+  discount: import_zod2.z.discriminatedUnion("type", [
+    import_zod2.z.strictObject({ type: import_zod2.z.literal("percentage"), value: import_zod2.z.number().min(1).max(99.99) }),
+    // A flat discount of 0 means no discount.
+    import_zod2.z.strictObject({ type: import_zod2.z.literal("flat"), value: import_zod2.z.number().min(0) })
+  ])
+}).refine(
+  (row) => row.discount.type !== "flat" || row.discount.value === 0 || row.discount.value <= row.amount - 1,
+  { path: ["discount", "value"], message: "A flat discount must be 0 or at most amount - 1" }
+);
+var isDistinct = (values) => new Set(values).size === values.length;
+var isUniform = (values) => new Set(values).size <= 1;
+var hasTarget = (rows, target) => rows.some((row) => row.target === target);
+var fees = import_zod2.z.array(fee).refine((rows) => isDistinct(rows.map((row) => row.target)), "Each target may have at most one fee").refine((rows) => isUniform(rows.map((row) => row.currency)), "All fees must have the same currency").refine((rows) => isUniform(rows.map((row) => row.unit)), "All fees must have the same unit").refine(
+  (rows) => !hasTarget(rows, "eea") || !(hasTarget(rows, "national") || hasTarget(rows, "local")),
+  "An eea fee cannot be combined with a national or local fee"
+);
+var tuitionFees = defineProperty({
+  value: fees,
+  // A study may have no fees; an empty list in a record would say nothing, removing fees is done with clear.
+  set: { shape: import_zod2.z.array(feeShape), value: fees.min(1) },
+  clear: {
+    shape: import_zod2.z.array(import_zod2.z.string()),
+    value: import_zod2.z.array(import_zod2.z.enum(TUITION_FEE_TARGETS)).min(1).refine(isDistinct, "Each target may be cleared at most once")
+  }
+});
+var tuitionFeeDescription = scalarProperty({ shape: import_zod2.z.string(), value: import_zod2.z.string().min(1).max(160) });
+
+// src/properties/index.ts
+var properties = {
+  tuitionFees,
+  tuitionFeeDescription
+};
+var isPropertyName = (name) => Object.hasOwn(properties, name);
+var validateValue = (property, value) => {
+  const result = properties[property].value.safeParse(value);
+  return result.success ? [] : toFailures(result.error, "PROPERTY_VALUE_INVALID", property);
+};
+var touchedProperties = (record) => [.../* @__PURE__ */ new Set([...Object.keys(record.set), ...Object.keys(record.clear)])];
+var slot = (values, property) => Object.hasOwn(values, property) ? { value: values[property] } : void 0;
+var checkShapes = (record) => touchedProperties(record).filter(isPropertyName).flatMap((property) => properties[property].checkShape(property, slot(record.set, property), slot(record.clear, property)));
+var checkSlot = (schema, values, property, side) => {
+  if (!Object.hasOwn(values, property)) {
+    return [];
+  }
+  const result = schema.safeParse(values[property]);
+  return result.success ? [] : toFailures(result.error, "PROPERTY_VALUE_INVALID", property, [side, property]);
+};
+var checkProperty = (property, record) => [
+  ...checkSlot(properties[property].set, record.set, property, "set"),
+  ...checkSlot(properties[property].clear, record.clear, property, "clear")
+];
+
+// src/registry.ts
+var propertyEntry = (property) => ({
+  properties: [property],
+  simple: [({ record }) => checkProperty(property, record)]
+});
+var registry = {
+  tuitionFees: propertyEntry("tuitionFees"),
+  tuitionFeeDescription: propertyEntry("tuitionFeeDescription")
+};
+var REGISTRY_KEYS = Object.keys(registry);
+var resolveEntries = (record) => {
+  const touched = new Set(touchedProperties(record).filter(isPropertyName));
+  return REGISTRY_KEYS.filter((key) => registry[key].properties.some((property) => touched.has(property)));
+};
+
+// src/validate.ts
+var import_zod4 = require("zod");
+
+// src/envelope.ts
+var import_zod3 = require("zod");
+var MAX_EPOCH_SECONDS = 9999999999;
+var propertyMap = import_zod3.z.preprocess((value, context) => {
+  if (typeof value === "object" && value !== null && Object.hasOwn(value, "__proto__")) {
+    context.addIssue({ code: "custom", message: "Property name __proto__ is not allowed" });
+  }
+  return value;
+}, import_zod3.z.record(import_zod3.z.string(), import_zod3.z.unknown()));
+var propertyMaps = import_zod3.z.object({ set: propertyMap, clear: propertyMap });
+var draftEnvelope = import_zod3.z.strictObject({
+  entityType: import_zod3.z.literal("study"),
+  entityId: import_zod3.z.int().positive(),
+  set: propertyMap,
+  clear: propertyMap
+});
+var recordEnvelope = draftEnvelope.extend({
+  // import_event_log.event_id is VARCHAR(64).
+  eventId: import_zod3.z.string().min(1).max(64),
+  eventTimestamp: import_zod3.z.int().positive().max(MAX_EPOCH_SECONDS)
+});
+
+// src/validate.ts
+var invalid = (stage, failures) => ({ valid: false, stage, failures });
+var checkEnvelope = (envelope, input) => {
+  const result = envelope.safeParse(input);
+  const maps = propertyMaps.safeParse(input);
+  const failures = [
+    ...result.success ? [] : toFailures(result.error, "SCHEMA_INVALID"),
+    ...maps.success ? checkShapes(maps.data) : []
+  ];
+  return result.success && failures.length === 0 ? { valid: true, record: result.data } : invalid("schema", failures);
+};
+var checkProperties = (record) => {
+  const touched = touchedProperties(record);
+  const notWritable = touched.filter((property) => !isPropertyName(property)).map((property) => ({ code: "PROPERTY_NOT_WRITABLE", property, reason: "Property is not writable" }));
+  if (notWritable.length > 0) {
+    return invalid("property", notWritable);
+  }
+  const failures = resolveEntries(record).flatMap((key) => {
+    const entry = registry[key];
+    const context = { record, touched: entry.properties.filter((property) => touched.includes(property)) };
+    for (const validator of entry.simple) {
+      const found = validator(context);
+      if (found.length > 0) {
+        return found;
+      }
+    }
+    return [];
+  });
+  return failures.length > 0 ? invalid("property", failures) : { valid: true, record };
+};
+var chain = (schema) => schema.valid ? checkProperties(schema.record) : schema;
+var validateSchema = (input) => checkEnvelope(recordEnvelope, input);
+var validateProperties = (record) => checkProperties(record);
+var validateDraft = (input) => chain(checkEnvelope(draftEnvelope, input));
+var validateRecord = (input) => chain(checkEnvelope(recordEnvelope, input));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  registry,
+  resolveEntries,
+  validateDraft,
+  validateProperties,
+  validateRecord,
+  validateSchema,
+  validateValue
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/failures.ts","../src/properties/tuition-fees.ts","../src/properties/definition.ts","../src/properties/index.ts","../src/registry.ts","../src/validate.ts","../src/envelope.ts"],"sourcesContent":["export type { PropertyClears, PropertyName, PropertyValues } from \"./properties\";\nexport { validateValue } from \"./properties\";\nexport type { TuitionFee, TuitionFeeDiscount, TuitionFeeTarget, TuitionFeeUnit } from \"./properties/tuition-fees\";\nexport type { ErrorCode, Failure, ImportRecord, ImportRecordDraft, Unchecked, ValidationResult } from \"./record\";\nexport { registry, resolveEntries, type RegistryEntry, type RegistryKey, type SimpleContext, type Validator } from \"./registry\";\nexport { validateDraft, validateProperties, validateRecord, validateSchema } from \"./validate\";\n","import type { z } from \"zod\";\n\nimport type { ErrorCode, Failure } from \"./record\";\n\nexport type Path = readonly (string | number)[];\n\nexport const toFailures = <Code extends ErrorCode>(error: z.ZodError, code: Code, property?: string, prefix: Path = []): Failure<Code>[] =>\n\terror.issues.map((issue) => {\n\t\tconst path = [...prefix, ...issue.path].map(String);\n\t\treturn {\n\t\t\tcode,\n\t\t\t...(property === undefined ? {} : { property }),\n\t\t\t...(path.length === 0 ? {} : { path: path.join(\".\") }),\n\t\t\treason: issue.message,\n\t\t};\n\t});\n","import { z } from \"zod\";\n\nimport { defineProperty, scalarProperty, type PropertyDefinition } from \"./definition\";\n\nexport const TUITION_FEE_TARGETS = [\"eea\", \"national\", \"international\", \"local\"] as const;\n\nexport type TuitionFeeTarget = (typeof TUITION_FEE_TARGETS)[number];\n\nexport const TUITION_FEE_UNITS = [\"module\", \"day\", \"week\", \"month\", \"quarter\", \"trimester\", \"semester\", \"year\", \"credit\", \"full\"] as const;\n\nexport type TuitionFeeUnit = (typeof TUITION_FEE_UNITS)[number];\n\nexport interface TuitionFeeDiscount {\n\treadonly type: \"flat\" | \"percentage\";\n\treadonly value: number;\n}\n\n/** One `tuition_fees` row. */\nexport interface TuitionFee {\n\treadonly target: TuitionFeeTarget;\n\treadonly amount: number;\n\treadonly currency: string;\n\treadonly unit: TuitionFeeUnit;\n\t/** Always given: a flat discount of 0 means no discount, the database has no null for it. */\n\treadonly discount: TuitionFeeDiscount;\n}\n\nconst feeShape = z.strictObject({\n\ttarget: z.string(),\n\tamount: z.number(),\n\tcurrency: z.string(),\n\tunit: z.string(),\n\tdiscount: z.strictObject({ type: z.string(), value: z.number() }),\n});\n\n// tuition_fees.amount is a signed MySQL INT.\nconst INT32_MAX = 2_147_483_647;\n\nconst fee: z.ZodType<TuitionFee> = z.strictObject({\n\ttarget: z.enum(TUITION_FEE_TARGETS),\n\tamount: z.int().min(0).max(INT32_MAX),\n\tcurrency: z.currencyCode(),\n\tunit: z.enum(TUITION_FEE_UNITS),\n\tdiscount: z.discriminatedUnion(\"type\", [\n\t\tz.strictObject({ type: z.literal(\"percentage\"), value: z.number().min(1).max(99.99) }),\n\t\t// A flat discount of 0 means no discount.\n\t\tz.strictObject({ type: z.literal(\"flat\"), value: z.number().min(0) }),\n\t]),\n}).refine(\n\t(row) => row.discount.type !== \"flat\" || row.discount.value === 0 || row.discount.value <= row.amount - 1,\n\t{ path: [\"discount\", \"value\"], message: \"A flat discount must be 0 or at most amount - 1\" },\n);\n\nconst isDistinct = (values: readonly unknown[]): boolean => new Set(values).size === values.length;\nconst isUniform = (values: readonly unknown[]): boolean => new Set(values).size <= 1;\nconst hasTarget = (rows: readonly { readonly target: string }[], target: string): boolean => rows.some((row) => row.target === target);\n\n// The same rules hold for the record's fees and, in the pipeline, for the fees after enrichment.\nconst fees = z.array(fee)\n\t.refine((rows) => isDistinct(rows.map((row) => row.target)), \"Each target may have at most one fee\")\n\t.refine((rows) => isUniform(rows.map((row) => row.currency)), \"All fees must have the same currency\")\n\t.refine((rows) => isUniform(rows.map((row) => row.unit)), \"All fees must have the same unit\")\n\t.refine(\n\t\t(rows) => !hasTarget(rows, \"eea\") || !(hasTarget(rows, \"national\") || hasTarget(rows, \"local\")),\n\t\t\"An eea fee cannot be combined with a national or local fee\",\n\t);\n\nexport const tuitionFees: PropertyDefinition<readonly TuitionFee[], readonly TuitionFeeTarget[]> = defineProperty({\n\tvalue: fees,\n\t// A study may have no fees; an empty list in a record would say nothing, removing fees is done with clear.\n\tset: { shape: z.array(feeShape), value: fees.min(1) },\n\tclear: {\n\t\tshape: z.array(z.string()),\n\t\tvalue: z.array(z.enum(TUITION_FEE_TARGETS)).min(1).refine(isDistinct, \"Each target may be cleared at most once\"),\n\t},\n});\n\nexport const tuitionFeeDescription = scalarProperty({ shape: z.string(), value: z.string().min(1).max(160) });\n","import { z } from \"zod\";\n\nimport { toFailures } from \"../failures\";\nimport type { Failure } from \"../record\";\n\ninterface Schemas<Shape, Value extends Shape> {\n\t/** Keys and JSON types only; failures are SCHEMA_INVALID. */\n\treadonly shape: z.ZodType<Shape>;\n\t/** Shape and rules for what a record holds; failures are PROPERTY_VALUE_INVALID. Also the published JSON Schema. */\n\treadonly value: z.ZodType<Value>;\n}\n\n/** What a record holds for a property in `set` or `clear`; `undefined` when it holds nothing. */\nexport type Slot = { readonly value: unknown } | undefined;\n\nexport interface PropertyDefinition<Value, Clear> {\n\t/** A valid stored value, e.g. the fees after enrichment. */\n\treadonly value: z.ZodType<Value>;\n\t/** What a record may set: the stored-value rules plus record-only ones. */\n\treadonly set: z.ZodType<Value>;\n\t/** What `clear` holds: `true` for a single value, the keys of the items to remove for a list. */\n\treadonly clear: z.ZodType<Clear>;\n\t/** Shape of what the record sets and clears. */\n\treadonly checkShape: (property: string, set: Slot, clear: Slot) => Failure<\"SCHEMA_INVALID\">[];\n}\n\nconst shapeFailures = (schema: z.ZodType, slot: Slot, property: string, side: \"set\" | \"clear\"): Failure<\"SCHEMA_INVALID\">[] => {\n\tconst result = slot && schema.safeParse(slot.value);\n\treturn result?.success === false ? toFailures(result.error, \"SCHEMA_INVALID\", property, [side, property]) : [];\n};\n\nexport const defineProperty = <SetShape, Value extends SetShape, ClearShape, Clear extends ClearShape>(definition: {\n\treadonly value: z.ZodType<Value>;\n\treadonly set: Schemas<SetShape, Value>;\n\treadonly clear: Schemas<ClearShape, Clear>;\n}): PropertyDefinition<Value, Clear> => ({\n\tvalue: definition.value,\n\tset: definition.set.value,\n\tclear: definition.clear.value,\n\tcheckShape: (property, set, clear) => [\n\t\t...shapeFailures(definition.set.shape, set, property, \"set\"),\n\t\t...shapeFailures(definition.clear.shape, clear, property, \"clear\"),\n\t],\n});\n\nexport const scalarProperty = <Shape, Value extends Shape>(set: Schemas<Shape, Value>): PropertyDefinition<Value, true> =>\n\tdefineProperty({ value: set.value, set, clear: { shape: z.literal(true), value: z.literal(true) } });\n","import type { z } from \"zod\";\n\nimport { toFailures } from \"../failures\";\nimport type { Failure, ImportRecordDraft, Unchecked } from \"../record\";\nimport type { PropertyDefinition, Slot } from \"./definition\";\nimport { tuitionFeeDescription, tuitionFees, type TuitionFee, type TuitionFeeTarget } from \"./tuition-fees\";\n\nexport interface PropertyValues {\n\t/** Fees to create, matched by target. A record that also clears a target replaces that fee: clear is applied first. */\n\ttuitionFees: readonly TuitionFee[];\n\ttuitionFeeDescription: string;\n}\n\nexport interface PropertyClears {\n\t/** Targets whose fees are removed. Removing every fee lists every target. */\n\ttuitionFees: readonly TuitionFeeTarget[];\n\ttuitionFeeDescription: true;\n}\n\nexport type PropertyName = keyof PropertyValues;\n\nexport const properties: { readonly [P in PropertyName]: PropertyDefinition<PropertyValues[P], PropertyClears[P]> } = {\n\ttuitionFees,\n\ttuitionFeeDescription,\n};\n\nexport const isPropertyName = (name: string): name is PropertyName => Object.hasOwn(properties, name);\n\ntype PropertyFailure = Failure<\"PROPERTY_VALUE_INVALID\">;\n\n/**\n * Checks one property value; paths are relative to the value. Producers get it through the validate\n * functions; the import pipeline also runs it on the enriched value, e.g. existing fees merged with the record's.\n */\nexport const validateValue = <P extends PropertyName>(property: P, value: unknown): PropertyFailure[] => {\n\tconst result = properties[property].value.safeParse(value);\n\treturn result.success ? [] : toFailures(result.error, \"PROPERTY_VALUE_INVALID\", property);\n};\n\n/** Properties the record sets or clears, in record order, without duplicates. */\nexport const touchedProperties = (record: Pick<Unchecked<ImportRecordDraft>, \"set\" | \"clear\">): string[] =>\n\t[...new Set([...Object.keys(record.set), ...Object.keys(record.clear)])];\n\nconst slot = (values: Readonly<Record<string, unknown>>, property: PropertyName): Slot =>\n\t(Object.hasOwn(values, property) ? { value: values[property] } : undefined);\n\n/** Phase 1 part of properties: the shape of every writable property the record touches. Unknown properties are left to phase 2. */\nexport const checkShapes = (record: Pick<Unchecked<ImportRecordDraft>, \"set\" | \"clear\">): Failure<\"SCHEMA_INVALID\">[] =>\n\ttouchedProperties(record)\n\t\t.filter(isPropertyName)\n\t\t.flatMap((property) => properties[property].checkShape(property, slot(record.set, property), slot(record.clear, property)));\n\nconst checkSlot = (schema: z.ZodType, values: Readonly<Record<string, unknown>>, property: PropertyName, side: \"set\" | \"clear\"): PropertyFailure[] => {\n\tif (!Object.hasOwn(values, property)) {\n\t\treturn [];\n\t}\n\tconst result = schema.safeParse(values[property]);\n\treturn result.success ? [] : toFailures(result.error, \"PROPERTY_VALUE_INVALID\", property, [side, property]);\n};\n\n/** The rules for what the record clears and sets for one property; its shape passed phase 1. */\nexport const checkProperty = (property: PropertyName, record: Unchecked<ImportRecordDraft>): PropertyFailure[] => [\n\t...checkSlot(properties[property].set, record.set, property, \"set\"),\n\t...checkSlot(properties[property].clear, record.clear, property, \"clear\"),\n];\n","import { checkProperty, isPropertyName, touchedProperties, type PropertyName } from \"./properties\";\nimport type { Failure, ImportRecordDraft, Unchecked } from \"./record\";\n\nexport interface SimpleContext {\n\treadonly record: Unchecked<ImportRecordDraft>;\n\t/** The entry's properties that the record sets or clears. */\n\treadonly touched: readonly PropertyName[];\n}\n\n/** Returns every failure it finds; an empty array means valid. */\nexport type Validator<Context = SimpleContext, Code extends string = Failure[\"code\"]> = (context: Context) => Failure<Code>[];\n\nexport interface RegistryEntry {\n\treadonly properties: readonly PropertyName[];\n\t/** Record-only validators. Run as a chain that stops at the first validator reporting failures. */\n\treadonly simple: readonly Validator[];\n}\n\nconst propertyEntry = (property: PropertyName): RegistryEntry => ({\n\tproperties: [property],\n\tsimple: [({ record }): Failure[] => checkProperty(property, record)],\n});\n\n/**\n * The writable-property allowlist. The import pipeline extends each entry by key with its\n * enrichment and dependent validators, typed `{ [K in RegistryKey]: … }` so a new entry\n * cannot be missed.\n */\nexport const registry = {\n\ttuitionFees: propertyEntry(\"tuitionFees\"),\n\ttuitionFeeDescription: propertyEntry(\"tuitionFeeDescription\"),\n} as const satisfies { readonly [P in PropertyName]: RegistryEntry };\n\nexport type RegistryKey = keyof typeof registry;\n\nconst REGISTRY_KEYS = Object.keys(registry) as RegistryKey[];\n\n/** Keys of the registry entries covering the record's touched properties. Unknown properties are ignored. */\nexport const resolveEntries = (record: Unchecked<ImportRecordDraft>): RegistryKey[] => {\n\tconst touched = new Set(touchedProperties(record).filter(isPropertyName));\n\treturn REGISTRY_KEYS.filter((key) => registry[key].properties.some((property) => touched.has(property)));\n};\n","import { z } from \"zod\";\n\nimport { draftEnvelope, propertyMaps, recordEnvelope } from \"./envelope\";\nimport { toFailures } from \"./failures\";\nimport { checkShapes, isPropertyName, properties, touchedProperties } from \"./properties\";\nimport type { Failure, ImportRecord, ImportRecordDraft, Unchecked, ValidationResult } from \"./record\";\nimport { registry, resolveEntries } from \"./registry\";\n\nconst invalid = <T>(stage: \"schema\" | \"property\", failures: readonly Failure[]): ValidationResult<T> =>\n\t({ valid: false, stage, failures });\n\nconst checkEnvelope = <T extends ImportRecordDraft>(envelope: z.ZodType<Unchecked<T>>, input: unknown): ValidationResult<Unchecked<T>> => {\n\tconst result = envelope.safeParse(input);\n\tconst maps = propertyMaps.safeParse(input);\n\tconst failures = [\n\t\t...(result.success ? [] : toFailures(result.error, \"SCHEMA_INVALID\")),\n\t\t...(maps.success ? checkShapes(maps.data) : []),\n\t];\n\treturn result.success && failures.length === 0 ? { valid: true, record: result.data } : invalid(\"schema\", failures);\n};\n\nconst checkProperties = <T extends ImportRecordDraft>(record: Unchecked<T>): ValidationResult<T> => {\n\tconst touched = touchedProperties(record);\n\tconst notWritable = touched\n\t\t.filter((property) => !isPropertyName(property))\n\t\t.map((property): Failure => ({ code: \"PROPERTY_NOT_WRITABLE\", property, reason: \"Property is not writable\" }));\n\tif (notWritable.length > 0) {\n\t\treturn invalid(\"property\", notWritable);\n\t}\n\tconst failures = resolveEntries(record).flatMap((key) => {\n\t\tconst entry = registry[key];\n\t\tconst context = { record, touched: entry.properties.filter((property) => touched.includes(property)) };\n\t\tfor (const validator of entry.simple) {\n\t\t\tconst found = validator(context);\n\t\t\tif (found.length > 0) {\n\t\t\t\treturn found;\n\t\t\t}\n\t\t}\n\t\treturn [];\n\t});\n\t// Every touched property is writable and its set and clear values passed their rules, so the record has its checked type.\n\treturn failures.length > 0 ? invalid(\"property\", failures) : { valid: true, record: record as unknown as T };\n};\n\nconst chain = <T extends ImportRecordDraft>(schema: ValidationResult<Unchecked<T>>): ValidationResult<T> =>\n\tschema.valid ? checkProperties(schema.record) : schema;\n\n/** Phase 1 of the pipeline (and the first half of {@link validateRecord}): envelope and the shape of known properties. */\nexport const validateSchema = (input: unknown): ValidationResult<Unchecked<ImportRecord>> => checkEnvelope(recordEnvelope, input);\n\n/**\n * Phase 2, simple part: writable-property allowlist and record-only validators. The pipeline calls it after\n * dropping stale properties and before enrichment.\n */\nexport const validateProperties = (record: Unchecked<ImportRecord>): ValidationResult<ImportRecord> => checkProperties(record);\n\n/** For producers, before the registration endpoint has issued `eventId`. */\nexport const validateDraft = (input: unknown): ValidationResult<ImportRecordDraft> => chain(checkEnvelope(draftEnvelope, input));\n\n/** For producers, right before the record is pushed into the Data Stream. */\nexport const validateRecord = (input: unknown): ValidationResult<ImportRecord> => chain(checkEnvelope(recordEnvelope, input));\n\n/** The issued record as JSON Schema; cross-field rules such as discount bounds are not expressible there. */\nexport const importRecordJsonSchema = (): Record<string, unknown> => {\n\tconst definitions = Object.entries(properties);\n\tconst contract = recordEnvelope.extend({\n\t\tset: z.strictObject(Object.fromEntries(definitions.map(([property, { set }]) => [property, set.optional()]))),\n\t\tclear: z.strictObject(Object.fromEntries(definitions.map(([property, { clear }]) => [property, clear.optional()]))),\n\t});\n\t// A local registry: .meta() would write into Zod's global registry, which consumers may share.\n\tconst metadata = z.registry<{ title: string }>();\n\tmetadata.add(contract, { title: \"Data API import record\" });\n\treturn z.toJSONSchema(contract, { metadata });\n};\n","import { z } from \"zod\";\n\n// Ten digits: anything larger is almost certainly milliseconds.\nconst MAX_EPOCH_SECONDS = 9_999_999_999;\n\n// Zod's record parser drops a \"__proto__\" key without an issue; reject it rather than lose it.\nconst propertyMap = z.preprocess((value, context) => {\n\tif (typeof value === \"object\" && value !== null && Object.hasOwn(value, \"__proto__\")) {\n\t\tcontext.addIssue({ code: \"custom\", message: \"Property name __proto__ is not allowed\" });\n\t}\n\treturn value;\n}, z.record(z.string(), z.unknown()));\n\n/** Just the property maps, so their shapes can be checked even when other envelope fields are invalid. */\nexport const propertyMaps = z.object({ set: propertyMap, clear: propertyMap });\n\nexport const draftEnvelope = z.strictObject({\n\tentityType: z.literal(\"study\"),\n\tentityId: z.int().positive(),\n\tset: propertyMap,\n\tclear: propertyMap,\n});\n\nexport const recordEnvelope = draftEnvelope.extend({\n\t// import_event_log.event_id is VARCHAR(64).\n\teventId: z.string().min(1).max(64),\n\teventTimestamp: z.int().positive().max(MAX_EPOCH_SECONDS),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACMO,IAAM,aAAa,CAAyB,OAAmB,MAAY,UAAmB,SAAe,CAAC,MACpH,MAAM,OAAO,IAAI,CAAC,UAAU;AAC3B,QAAM,OAAO,CAAC,GAAG,QAAQ,GAAG,MAAM,IAAI,EAAE,IAAI,MAAM;AAClD,SAAO;AAAA,IACN;AAAA,IACA,GAAI,aAAa,SAAY,CAAC,IAAI,EAAE,SAAS;AAAA,IAC7C,GAAI,KAAK,WAAW,IAAI,CAAC,IAAI,EAAE,MAAM,KAAK,KAAK,GAAG,EAAE;AAAA,IACpD,QAAQ,MAAM;AAAA,EACf;AACD,CAAC;;;ACfF,IAAAA,cAAkB;;;ACAlB,iBAAkB;AA0BlB,IAAM,gBAAgB,CAAC,QAAmBC,OAAY,UAAkB,SAAuD;AAC9H,QAAM,SAASA,SAAQ,OAAO,UAAUA,MAAK,KAAK;AAClD,SAAO,QAAQ,YAAY,QAAQ,WAAW,OAAO,OAAO,kBAAkB,UAAU,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC;AAC9G;AAEO,IAAM,iBAAiB,CAAyE,gBAI9D;AAAA,EACxC,OAAO,WAAW;AAAA,EAClB,KAAK,WAAW,IAAI;AAAA,EACpB,OAAO,WAAW,MAAM;AAAA,EACxB,YAAY,CAAC,UAAU,KAAK,UAAU;AAAA,IACrC,GAAG,cAAc,WAAW,IAAI,OAAO,KAAK,UAAU,KAAK;AAAA,IAC3D,GAAG,cAAc,WAAW,MAAM,OAAO,OAAO,UAAU,OAAO;AAAA,EAClE;AACD;AAEO,IAAM,iBAAiB,CAA6B,QAC1D,eAAe,EAAE,OAAO,IAAI,OAAO,KAAK,OAAO,EAAE,OAAO,aAAE,QAAQ,IAAI,GAAG,OAAO,aAAE,QAAQ,IAAI,EAAE,EAAE,CAAC;;;AD1C7F,IAAM,sBAAsB,CAAC,OAAO,YAAY,iBAAiB,OAAO;AAIxE,IAAM,oBAAoB,CAAC,UAAU,OAAO,QAAQ,SAAS,WAAW,aAAa,YAAY,QAAQ,UAAU,MAAM;AAmBhI,IAAM,WAAW,cAAE,aAAa;AAAA,EAC/B,QAAQ,cAAE,OAAO;AAAA,EACjB,QAAQ,cAAE,OAAO;AAAA,EACjB,UAAU,cAAE,OAAO;AAAA,EACnB,MAAM,cAAE,OAAO;AAAA,EACf,UAAU,cAAE,aAAa,EAAE,MAAM,cAAE,OAAO,GAAG,OAAO,cAAE,OAAO,EAAE,CAAC;AACjE,CAAC;AAGD,IAAM,YAAY;AAElB,IAAM,MAA6B,cAAE,aAAa;AAAA,EACjD,QAAQ,cAAE,KAAK,mBAAmB;AAAA,EAClC,QAAQ,cAAE,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,SAAS;AAAA,EACpC,UAAU,cAAE,aAAa;AAAA,EACzB,MAAM,cAAE,KAAK,iBAAiB;AAAA,EAC9B,UAAU,cAAE,mBAAmB,QAAQ;AAAA,IACtC,cAAE,aAAa,EAAE,MAAM,cAAE,QAAQ,YAAY,GAAG,OAAO,cAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,KAAK,EAAE,CAAC;AAAA;AAAA,IAErF,cAAE,aAAa,EAAE,MAAM,cAAE,QAAQ,MAAM,GAAG,OAAO,cAAE,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;AAAA,EACrE,CAAC;AACF,CAAC,EAAE;AAAA,EACF,CAAC,QAAQ,IAAI,SAAS,SAAS,UAAU,IAAI,SAAS,UAAU,KAAK,IAAI,SAAS,SAAS,IAAI,SAAS;AAAA,EACxG,EAAE,MAAM,CAAC,YAAY,OAAO,GAAG,SAAS,kDAAkD;AAC3F;AAEA,IAAM,aAAa,CAAC,WAAwC,IAAI,IAAI,MAAM,EAAE,SAAS,OAAO;AAC5F,IAAM,YAAY,CAAC,WAAwC,IAAI,IAAI,MAAM,EAAE,QAAQ;AACnF,IAAM,YAAY,CAAC,MAA8C,WAA4B,KAAK,KAAK,CAAC,QAAQ,IAAI,WAAW,MAAM;AAGrI,IAAM,OAAO,cAAE,MAAM,GAAG,EACtB,OAAO,CAAC,SAAS,WAAW,KAAK,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,GAAG,sCAAsC,EAClG,OAAO,CAAC,SAAS,UAAU,KAAK,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAG,sCAAsC,EACnG,OAAO,CAAC,SAAS,UAAU,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,kCAAkC,EAC3F;AAAA,EACA,CAAC,SAAS,CAAC,UAAU,MAAM,KAAK,KAAK,EAAE,UAAU,MAAM,UAAU,KAAK,UAAU,MAAM,OAAO;AAAA,EAC7F;AACD;AAEM,IAAM,cAAsF,eAAe;AAAA,EACjH,OAAO;AAAA;AAAA,EAEP,KAAK,EAAE,OAAO,cAAE,MAAM,QAAQ,GAAG,OAAO,KAAK,IAAI,CAAC,EAAE;AAAA,EACpD,OAAO;AAAA,IACN,OAAO,cAAE,MAAM,cAAE,OAAO,CAAC;AAAA,IACzB,OAAO,cAAE,MAAM,cAAE,KAAK,mBAAmB,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,YAAY,yCAAyC;AAAA,EAChH;AACD,CAAC;AAEM,IAAM,wBAAwB,eAAe,EAAE,OAAO,cAAE,OAAO,GAAG,OAAO,cAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC;;;AExDrG,IAAM,aAAyG;AAAA,EACrH;AAAA,EACA;AACD;AAEO,IAAM,iBAAiB,CAAC,SAAuC,OAAO,OAAO,YAAY,IAAI;AAQ7F,IAAM,gBAAgB,CAAyB,UAAa,UAAsC;AACxG,QAAM,SAAS,WAAW,QAAQ,EAAE,MAAM,UAAU,KAAK;AACzD,SAAO,OAAO,UAAU,CAAC,IAAI,WAAW,OAAO,OAAO,0BAA0B,QAAQ;AACzF;AAGO,IAAM,oBAAoB,CAAC,WACjC,CAAC,GAAG,oBAAI,IAAI,CAAC,GAAG,OAAO,KAAK,OAAO,GAAG,GAAG,GAAG,OAAO,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;AAExE,IAAM,OAAO,CAAC,QAA2C,aACvD,OAAO,OAAO,QAAQ,QAAQ,IAAI,EAAE,OAAO,OAAO,QAAQ,EAAE,IAAI;AAG3D,IAAM,cAAc,CAAC,WAC3B,kBAAkB,MAAM,EACtB,OAAO,cAAc,EACrB,QAAQ,CAAC,aAAa,WAAW,QAAQ,EAAE,WAAW,UAAU,KAAK,OAAO,KAAK,QAAQ,GAAG,KAAK,OAAO,OAAO,QAAQ,CAAC,CAAC;AAE5H,IAAM,YAAY,CAAC,QAAmB,QAA2C,UAAwB,SAA6C;AACrJ,MAAI,CAAC,OAAO,OAAO,QAAQ,QAAQ,GAAG;AACrC,WAAO,CAAC;AAAA,EACT;AACA,QAAM,SAAS,OAAO,UAAU,OAAO,QAAQ,CAAC;AAChD,SAAO,OAAO,UAAU,CAAC,IAAI,WAAW,OAAO,OAAO,0BAA0B,UAAU,CAAC,MAAM,QAAQ,CAAC;AAC3G;AAGO,IAAM,gBAAgB,CAAC,UAAwB,WAA4D;AAAA,EACjH,GAAG,UAAU,WAAW,QAAQ,EAAE,KAAK,OAAO,KAAK,UAAU,KAAK;AAAA,EAClE,GAAG,UAAU,WAAW,QAAQ,EAAE,OAAO,OAAO,OAAO,UAAU,OAAO;AACzE;;;AC9CA,IAAM,gBAAgB,CAAC,cAA2C;AAAA,EACjE,YAAY,CAAC,QAAQ;AAAA,EACrB,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAiB,cAAc,UAAU,MAAM,CAAC;AACpE;AAOO,IAAM,WAAW;AAAA,EACvB,aAAa,cAAc,aAAa;AAAA,EACxC,uBAAuB,cAAc,uBAAuB;AAC7D;AAIA,IAAM,gBAAgB,OAAO,KAAK,QAAQ;AAGnC,IAAM,iBAAiB,CAAC,WAAwD;AACtF,QAAM,UAAU,IAAI,IAAI,kBAAkB,MAAM,EAAE,OAAO,cAAc,CAAC;AACxE,SAAO,cAAc,OAAO,CAAC,QAAQ,SAAS,GAAG,EAAE,WAAW,KAAK,CAAC,aAAa,QAAQ,IAAI,QAAQ,CAAC,CAAC;AACxG;;;ACzCA,IAAAC,cAAkB;;;ACAlB,IAAAC,cAAkB;AAGlB,IAAM,oBAAoB;AAG1B,IAAM,cAAc,cAAE,WAAW,CAAC,OAAO,YAAY;AACpD,MAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,OAAO,OAAO,OAAO,WAAW,GAAG;AACrF,YAAQ,SAAS,EAAE,MAAM,UAAU,SAAS,yCAAyC,CAAC;AAAA,EACvF;AACA,SAAO;AACR,GAAG,cAAE,OAAO,cAAE,OAAO,GAAG,cAAE,QAAQ,CAAC,CAAC;AAG7B,IAAM,eAAe,cAAE,OAAO,EAAE,KAAK,aAAa,OAAO,YAAY,CAAC;AAEtE,IAAM,gBAAgB,cAAE,aAAa;AAAA,EAC3C,YAAY,cAAE,QAAQ,OAAO;AAAA,EAC7B,UAAU,cAAE,IAAI,EAAE,SAAS;AAAA,EAC3B,KAAK;AAAA,EACL,OAAO;AACR,CAAC;AAEM,IAAM,iBAAiB,cAAc,OAAO;AAAA;AAAA,EAElD,SAAS,cAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE;AAAA,EACjC,gBAAgB,cAAE,IAAI,EAAE,SAAS,EAAE,IAAI,iBAAiB;AACzD,CAAC;;;ADnBD,IAAM,UAAU,CAAI,OAA8B,cAChD,EAAE,OAAO,OAAO,OAAO,SAAS;AAElC,IAAM,gBAAgB,CAA8B,UAAmC,UAAmD;AACzI,QAAM,SAAS,SAAS,UAAU,KAAK;AACvC,QAAM,OAAO,aAAa,UAAU,KAAK;AACzC,QAAM,WAAW;AAAA,IAChB,GAAI,OAAO,UAAU,CAAC,IAAI,WAAW,OAAO,OAAO,gBAAgB;AAAA,IACnE,GAAI,KAAK,UAAU,YAAY,KAAK,IAAI,IAAI,CAAC;AAAA,EAC9C;AACA,SAAO,OAAO,WAAW,SAAS,WAAW,IAAI,EAAE,OAAO,MAAM,QAAQ,OAAO,KAAK,IAAI,QAAQ,UAAU,QAAQ;AACnH;AAEA,IAAM,kBAAkB,CAA8B,WAA8C;AACnG,QAAM,UAAU,kBAAkB,MAAM;AACxC,QAAM,cAAc,QAClB,OAAO,CAAC,aAAa,CAAC,eAAe,QAAQ,CAAC,EAC9C,IAAI,CAAC,cAAuB,EAAE,MAAM,yBAAyB,UAAU,QAAQ,2BAA2B,EAAE;AAC9G,MAAI,YAAY,SAAS,GAAG;AAC3B,WAAO,QAAQ,YAAY,WAAW;AAAA,EACvC;AACA,QAAM,WAAW,eAAe,MAAM,EAAE,QAAQ,CAAC,QAAQ;AACxD,UAAM,QAAQ,SAAS,GAAG;AAC1B,UAAM,UAAU,EAAE,QAAQ,SAAS,MAAM,WAAW,OAAO,CAAC,aAAa,QAAQ,SAAS,QAAQ,CAAC,EAAE;AACrG,eAAW,aAAa,MAAM,QAAQ;AACrC,YAAM,QAAQ,UAAU,OAAO;AAC/B,UAAI,MAAM,SAAS,GAAG;AACrB,eAAO;AAAA,MACR;AAAA,IACD;AACA,WAAO,CAAC;AAAA,EACT,CAAC;AAED,SAAO,SAAS,SAAS,IAAI,QAAQ,YAAY,QAAQ,IAAI,EAAE,OAAO,MAAM,OAA+B;AAC5G;AAEA,IAAM,QAAQ,CAA8B,WAC3C,OAAO,QAAQ,gBAAgB,OAAO,MAAM,IAAI;AAG1C,IAAM,iBAAiB,CAAC,UAA8D,cAAc,gBAAgB,KAAK;AAMzH,IAAM,qBAAqB,CAAC,WAAoE,gBAAgB,MAAM;AAGtH,IAAM,gBAAgB,CAAC,UAAwD,MAAM,cAAc,eAAe,KAAK,CAAC;AAGxH,IAAM,iBAAiB,CAAC,UAAmD,MAAM,cAAc,gBAAgB,KAAK,CAAC;","names":["import_zod","slot","import_zod","import_zod"]}

package/dist/index.mjs

@@ -0,0 +1,184 @@
+// src/failures.ts
+var toFailures = (error, code, property, prefix = []) => error.issues.map((issue) => {
+  const path = [...prefix, ...issue.path].map(String);
+  return {
+    code,
+    ...property === void 0 ? {} : { property },
+    ...path.length === 0 ? {} : { path: path.join(".") },
+    reason: issue.message
+  };
+});
+
+// src/properties/tuition-fees.ts
+import { z as z2 } from "zod";
+
+// src/properties/definition.ts
+import { z } from "zod";
+var shapeFailures = (schema, slot2, property, side) => {
+  const result = slot2 && schema.safeParse(slot2.value);
+  return result?.success === false ? toFailures(result.error, "SCHEMA_INVALID", property, [side, property]) : [];
+};
+var defineProperty = (definition) => ({
+  value: definition.value,
+  set: definition.set.value,
+  clear: definition.clear.value,
+  checkShape: (property, set, clear) => [
+    ...shapeFailures(definition.set.shape, set, property, "set"),
+    ...shapeFailures(definition.clear.shape, clear, property, "clear")
+  ]
+});
+var scalarProperty = (set) => defineProperty({ value: set.value, set, clear: { shape: z.literal(true), value: z.literal(true) } });
+
+// src/properties/tuition-fees.ts
+var TUITION_FEE_TARGETS = ["eea", "national", "international", "local"];
+var TUITION_FEE_UNITS = ["module", "day", "week", "month", "quarter", "trimester", "semester", "year", "credit", "full"];
+var feeShape = z2.strictObject({
+  target: z2.string(),
+  amount: z2.number(),
+  currency: z2.string(),
+  unit: z2.string(),
+  discount: z2.strictObject({ type: z2.string(), value: z2.number() })
+});
+var INT32_MAX = 2147483647;
+var fee = z2.strictObject({
+  target: z2.enum(TUITION_FEE_TARGETS),
+  amount: z2.int().min(0).max(INT32_MAX),
+  currency: z2.currencyCode(),
+  unit: z2.enum(TUITION_FEE_UNITS),
+  discount: z2.discriminatedUnion("type", [
+    z2.strictObject({ type: z2.literal("percentage"), value: z2.number().min(1).max(99.99) }),
+    // A flat discount of 0 means no discount.
+    z2.strictObject({ type: z2.literal("flat"), value: z2.number().min(0) })
+  ])
+}).refine(
+  (row) => row.discount.type !== "flat" || row.discount.value === 0 || row.discount.value <= row.amount - 1,
+  { path: ["discount", "value"], message: "A flat discount must be 0 or at most amount - 1" }
+);
+var isDistinct = (values) => new Set(values).size === values.length;
+var isUniform = (values) => new Set(values).size <= 1;
+var hasTarget = (rows, target) => rows.some((row) => row.target === target);
+var fees = z2.array(fee).refine((rows) => isDistinct(rows.map((row) => row.target)), "Each target may have at most one fee").refine((rows) => isUniform(rows.map((row) => row.currency)), "All fees must have the same currency").refine((rows) => isUniform(rows.map((row) => row.unit)), "All fees must have the same unit").refine(
+  (rows) => !hasTarget(rows, "eea") || !(hasTarget(rows, "national") || hasTarget(rows, "local")),
+  "An eea fee cannot be combined with a national or local fee"
+);
+var tuitionFees = defineProperty({
+  value: fees,
+  // A study may have no fees; an empty list in a record would say nothing, removing fees is done with clear.
+  set: { shape: z2.array(feeShape), value: fees.min(1) },
+  clear: {
+    shape: z2.array(z2.string()),
+    value: z2.array(z2.enum(TUITION_FEE_TARGETS)).min(1).refine(isDistinct, "Each target may be cleared at most once")
+  }
+});
+var tuitionFeeDescription = scalarProperty({ shape: z2.string(), value: z2.string().min(1).max(160) });
+
+// src/properties/index.ts
+var properties = {
+  tuitionFees,
+  tuitionFeeDescription
+};
+var isPropertyName = (name) => Object.hasOwn(properties, name);
+var validateValue = (property, value) => {
+  const result = properties[property].value.safeParse(value);
+  return result.success ? [] : toFailures(result.error, "PROPERTY_VALUE_INVALID", property);
+};
+var touchedProperties = (record) => [.../* @__PURE__ */ new Set([...Object.keys(record.set), ...Object.keys(record.clear)])];
+var slot = (values, property) => Object.hasOwn(values, property) ? { value: values[property] } : void 0;
+var checkShapes = (record) => touchedProperties(record).filter(isPropertyName).flatMap((property) => properties[property].checkShape(property, slot(record.set, property), slot(record.clear, property)));
+var checkSlot = (schema, values, property, side) => {
+  if (!Object.hasOwn(values, property)) {
+    return [];
+  }
+  const result = schema.safeParse(values[property]);
+  return result.success ? [] : toFailures(result.error, "PROPERTY_VALUE_INVALID", property, [side, property]);
+};
+var checkProperty = (property, record) => [
+  ...checkSlot(properties[property].set, record.set, property, "set"),
+  ...checkSlot(properties[property].clear, record.clear, property, "clear")
+];
+
+// src/registry.ts
+var propertyEntry = (property) => ({
+  properties: [property],
+  simple: [({ record }) => checkProperty(property, record)]
+});
+var registry = {
+  tuitionFees: propertyEntry("tuitionFees"),
+  tuitionFeeDescription: propertyEntry("tuitionFeeDescription")
+};
+var REGISTRY_KEYS = Object.keys(registry);
+var resolveEntries = (record) => {
+  const touched = new Set(touchedProperties(record).filter(isPropertyName));
+  return REGISTRY_KEYS.filter((key) => registry[key].properties.some((property) => touched.has(property)));
+};
+
+// src/validate.ts
+import { z as z4 } from "zod";
+
+// src/envelope.ts
+import { z as z3 } from "zod";
+var MAX_EPOCH_SECONDS = 9999999999;
+var propertyMap = z3.preprocess((value, context) => {
+  if (typeof value === "object" && value !== null && Object.hasOwn(value, "__proto__")) {
+    context.addIssue({ code: "custom", message: "Property name __proto__ is not allowed" });
+  }
+  return value;
+}, z3.record(z3.string(), z3.unknown()));
+var propertyMaps = z3.object({ set: propertyMap, clear: propertyMap });
+var draftEnvelope = z3.strictObject({
+  entityType: z3.literal("study"),
+  entityId: z3.int().positive(),
+  set: propertyMap,
+  clear: propertyMap
+});
+var recordEnvelope = draftEnvelope.extend({
+  // import_event_log.event_id is VARCHAR(64).
+  eventId: z3.string().min(1).max(64),
+  eventTimestamp: z3.int().positive().max(MAX_EPOCH_SECONDS)
+});
+
+// src/validate.ts
+var invalid = (stage, failures) => ({ valid: false, stage, failures });
+var checkEnvelope = (envelope, input) => {
+  const result = envelope.safeParse(input);
+  const maps = propertyMaps.safeParse(input);
+  const failures = [
+    ...result.success ? [] : toFailures(result.error, "SCHEMA_INVALID"),
+    ...maps.success ? checkShapes(maps.data) : []
+  ];
+  return result.success && failures.length === 0 ? { valid: true, record: result.data } : invalid("schema", failures);
+};
+var checkProperties = (record) => {
+  const touched = touchedProperties(record);
+  const notWritable = touched.filter((property) => !isPropertyName(property)).map((property) => ({ code: "PROPERTY_NOT_WRITABLE", property, reason: "Property is not writable" }));
+  if (notWritable.length > 0) {
+    return invalid("property", notWritable);
+  }
+  const failures = resolveEntries(record).flatMap((key) => {
+    const entry = registry[key];
+    const context = { record, touched: entry.properties.filter((property) => touched.includes(property)) };
+    for (const validator of entry.simple) {
+      const found = validator(context);
+      if (found.length > 0) {
+        return found;
+      }
+    }
+    return [];
+  });
+  return failures.length > 0 ? invalid("property", failures) : { valid: true, record };
+};
+var chain = (schema) => schema.valid ? checkProperties(schema.record) : schema;
+var validateSchema = (input) => checkEnvelope(recordEnvelope, input);
+var validateProperties = (record) => checkProperties(record);
+var validateDraft = (input) => chain(checkEnvelope(draftEnvelope, input));
+var validateRecord = (input) => chain(checkEnvelope(recordEnvelope, input));
+export {
+  registry,
+  resolveEntries,
+  validateDraft,
+  validateProperties,
+  validateRecord,
+  validateSchema,
+  validateValue
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/failures.ts","../src/properties/tuition-fees.ts","../src/properties/definition.ts","../src/properties/index.ts","../src/registry.ts","../src/validate.ts","../src/envelope.ts"],"sourcesContent":["import type { z } from \"zod\";\n\nimport type { ErrorCode, Failure } from \"./record\";\n\nexport type Path = readonly (string | number)[];\n\nexport const toFailures = <Code extends ErrorCode>(error: z.ZodError, code: Code, property?: string, prefix: Path = []): Failure<Code>[] =>\n\terror.issues.map((issue) => {\n\t\tconst path = [...prefix, ...issue.path].map(String);\n\t\treturn {\n\t\t\tcode,\n\t\t\t...(property === undefined ? {} : { property }),\n\t\t\t...(path.length === 0 ? {} : { path: path.join(\".\") }),\n\t\t\treason: issue.message,\n\t\t};\n\t});\n","import { z } from \"zod\";\n\nimport { defineProperty, scalarProperty, type PropertyDefinition } from \"./definition\";\n\nexport const TUITION_FEE_TARGETS = [\"eea\", \"national\", \"international\", \"local\"] as const;\n\nexport type TuitionFeeTarget = (typeof TUITION_FEE_TARGETS)[number];\n\nexport const TUITION_FEE_UNITS = [\"module\", \"day\", \"week\", \"month\", \"quarter\", \"trimester\", \"semester\", \"year\", \"credit\", \"full\"] as const;\n\nexport type TuitionFeeUnit = (typeof TUITION_FEE_UNITS)[number];\n\nexport interface TuitionFeeDiscount {\n\treadonly type: \"flat\" | \"percentage\";\n\treadonly value: number;\n}\n\n/** One `tuition_fees` row. */\nexport interface TuitionFee {\n\treadonly target: TuitionFeeTarget;\n\treadonly amount: number;\n\treadonly currency: string;\n\treadonly unit: TuitionFeeUnit;\n\t/** Always given: a flat discount of 0 means no discount, the database has no null for it. */\n\treadonly discount: TuitionFeeDiscount;\n}\n\nconst feeShape = z.strictObject({\n\ttarget: z.string(),\n\tamount: z.number(),\n\tcurrency: z.string(),\n\tunit: z.string(),\n\tdiscount: z.strictObject({ type: z.string(), value: z.number() }),\n});\n\n// tuition_fees.amount is a signed MySQL INT.\nconst INT32_MAX = 2_147_483_647;\n\nconst fee: z.ZodType<TuitionFee> = z.strictObject({\n\ttarget: z.enum(TUITION_FEE_TARGETS),\n\tamount: z.int().min(0).max(INT32_MAX),\n\tcurrency: z.currencyCode(),\n\tunit: z.enum(TUITION_FEE_UNITS),\n\tdiscount: z.discriminatedUnion(\"type\", [\n\t\tz.strictObject({ type: z.literal(\"percentage\"), value: z.number().min(1).max(99.99) }),\n\t\t// A flat discount of 0 means no discount.\n\t\tz.strictObject({ type: z.literal(\"flat\"), value: z.number().min(0) }),\n\t]),\n}).refine(\n\t(row) => row.discount.type !== \"flat\" || row.discount.value === 0 || row.discount.value <= row.amount - 1,\n\t{ path: [\"discount\", \"value\"], message: \"A flat discount must be 0 or at most amount - 1\" },\n);\n\nconst isDistinct = (values: readonly unknown[]): boolean => new Set(values).size === values.length;\nconst isUniform = (values: readonly unknown[]): boolean => new Set(values).size <= 1;\nconst hasTarget = (rows: readonly { readonly target: string }[], target: string): boolean => rows.some((row) => row.target === target);\n\n// The same rules hold for the record's fees and, in the pipeline, for the fees after enrichment.\nconst fees = z.array(fee)\n\t.refine((rows) => isDistinct(rows.map((row) => row.target)), \"Each target may have at most one fee\")\n\t.refine((rows) => isUniform(rows.map((row) => row.currency)), \"All fees must have the same currency\")\n\t.refine((rows) => isUniform(rows.map((row) => row.unit)), \"All fees must have the same unit\")\n\t.refine(\n\t\t(rows) => !hasTarget(rows, \"eea\") || !(hasTarget(rows, \"national\") || hasTarget(rows, \"local\")),\n\t\t\"An eea fee cannot be combined with a national or local fee\",\n\t);\n\nexport const tuitionFees: PropertyDefinition<readonly TuitionFee[], readonly TuitionFeeTarget[]> = defineProperty({\n\tvalue: fees,\n\t// A study may have no fees; an empty list in a record would say nothing, removing fees is done with clear.\n\tset: { shape: z.array(feeShape), value: fees.min(1) },\n\tclear: {\n\t\tshape: z.array(z.string()),\n\t\tvalue: z.array(z.enum(TUITION_FEE_TARGETS)).min(1).refine(isDistinct, \"Each target may be cleared at most once\"),\n\t},\n});\n\nexport const tuitionFeeDescription = scalarProperty({ shape: z.string(), value: z.string().min(1).max(160) });\n","import { z } from \"zod\";\n\nimport { toFailures } from \"../failures\";\nimport type { Failure } from \"../record\";\n\ninterface Schemas<Shape, Value extends Shape> {\n\t/** Keys and JSON types only; failures are SCHEMA_INVALID. */\n\treadonly shape: z.ZodType<Shape>;\n\t/** Shape and rules for what a record holds; failures are PROPERTY_VALUE_INVALID. Also the published JSON Schema. */\n\treadonly value: z.ZodType<Value>;\n}\n\n/** What a record holds for a property in `set` or `clear`; `undefined` when it holds nothing. */\nexport type Slot = { readonly value: unknown } | undefined;\n\nexport interface PropertyDefinition<Value, Clear> {\n\t/** A valid stored value, e.g. the fees after enrichment. */\n\treadonly value: z.ZodType<Value>;\n\t/** What a record may set: the stored-value rules plus record-only ones. */\n\treadonly set: z.ZodType<Value>;\n\t/** What `clear` holds: `true` for a single value, the keys of the items to remove for a list. */\n\treadonly clear: z.ZodType<Clear>;\n\t/** Shape of what the record sets and clears. */\n\treadonly checkShape: (property: string, set: Slot, clear: Slot) => Failure<\"SCHEMA_INVALID\">[];\n}\n\nconst shapeFailures = (schema: z.ZodType, slot: Slot, property: string, side: \"set\" | \"clear\"): Failure<\"SCHEMA_INVALID\">[] => {\n\tconst result = slot && schema.safeParse(slot.value);\n\treturn result?.success === false ? toFailures(result.error, \"SCHEMA_INVALID\", property, [side, property]) : [];\n};\n\nexport const defineProperty = <SetShape, Value extends SetShape, ClearShape, Clear extends ClearShape>(definition: {\n\treadonly value: z.ZodType<Value>;\n\treadonly set: Schemas<SetShape, Value>;\n\treadonly clear: Schemas<ClearShape, Clear>;\n}): PropertyDefinition<Value, Clear> => ({\n\tvalue: definition.value,\n\tset: definition.set.value,\n\tclear: definition.clear.value,\n\tcheckShape: (property, set, clear) => [\n\t\t...shapeFailures(definition.set.shape, set, property, \"set\"),\n\t\t...shapeFailures(definition.clear.shape, clear, property, \"clear\"),\n\t],\n});\n\nexport const scalarProperty = <Shape, Value extends Shape>(set: Schemas<Shape, Value>): PropertyDefinition<Value, true> =>\n\tdefineProperty({ value: set.value, set, clear: { shape: z.literal(true), value: z.literal(true) } });\n","import type { z } from \"zod\";\n\nimport { toFailures } from \"../failures\";\nimport type { Failure, ImportRecordDraft, Unchecked } from \"../record\";\nimport type { PropertyDefinition, Slot } from \"./definition\";\nimport { tuitionFeeDescription, tuitionFees, type TuitionFee, type TuitionFeeTarget } from \"./tuition-fees\";\n\nexport interface PropertyValues {\n\t/** Fees to create, matched by target. A record that also clears a target replaces that fee: clear is applied first. */\n\ttuitionFees: readonly TuitionFee[];\n\ttuitionFeeDescription: string;\n}\n\nexport interface PropertyClears {\n\t/** Targets whose fees are removed. Removing every fee lists every target. */\n\ttuitionFees: readonly TuitionFeeTarget[];\n\ttuitionFeeDescription: true;\n}\n\nexport type PropertyName = keyof PropertyValues;\n\nexport const properties: { readonly [P in PropertyName]: PropertyDefinition<PropertyValues[P], PropertyClears[P]> } = {\n\ttuitionFees,\n\ttuitionFeeDescription,\n};\n\nexport const isPropertyName = (name: string): name is PropertyName => Object.hasOwn(properties, name);\n\ntype PropertyFailure = Failure<\"PROPERTY_VALUE_INVALID\">;\n\n/**\n * Checks one property value; paths are relative to the value. Producers get it through the validate\n * functions; the import pipeline also runs it on the enriched value, e.g. existing fees merged with the record's.\n */\nexport const validateValue = <P extends PropertyName>(property: P, value: unknown): PropertyFailure[] => {\n\tconst result = properties[property].value.safeParse(value);\n\treturn result.success ? [] : toFailures(result.error, \"PROPERTY_VALUE_INVALID\", property);\n};\n\n/** Properties the record sets or clears, in record order, without duplicates. */\nexport const touchedProperties = (record: Pick<Unchecked<ImportRecordDraft>, \"set\" | \"clear\">): string[] =>\n\t[...new Set([...Object.keys(record.set), ...Object.keys(record.clear)])];\n\nconst slot = (values: Readonly<Record<string, unknown>>, property: PropertyName): Slot =>\n\t(Object.hasOwn(values, property) ? { value: values[property] } : undefined);\n\n/** Phase 1 part of properties: the shape of every writable property the record touches. Unknown properties are left to phase 2. */\nexport const checkShapes = (record: Pick<Unchecked<ImportRecordDraft>, \"set\" | \"clear\">): Failure<\"SCHEMA_INVALID\">[] =>\n\ttouchedProperties(record)\n\t\t.filter(isPropertyName)\n\t\t.flatMap((property) => properties[property].checkShape(property, slot(record.set, property), slot(record.clear, property)));\n\nconst checkSlot = (schema: z.ZodType, values: Readonly<Record<string, unknown>>, property: PropertyName, side: \"set\" | \"clear\"): PropertyFailure[] => {\n\tif (!Object.hasOwn(values, property)) {\n\t\treturn [];\n\t}\n\tconst result = schema.safeParse(values[property]);\n\treturn result.success ? [] : toFailures(result.error, \"PROPERTY_VALUE_INVALID\", property, [side, property]);\n};\n\n/** The rules for what the record clears and sets for one property; its shape passed phase 1. */\nexport const checkProperty = (property: PropertyName, record: Unchecked<ImportRecordDraft>): PropertyFailure[] => [\n\t...checkSlot(properties[property].set, record.set, property, \"set\"),\n\t...checkSlot(properties[property].clear, record.clear, property, \"clear\"),\n];\n","import { checkProperty, isPropertyName, touchedProperties, type PropertyName } from \"./properties\";\nimport type { Failure, ImportRecordDraft, Unchecked } from \"./record\";\n\nexport interface SimpleContext {\n\treadonly record: Unchecked<ImportRecordDraft>;\n\t/** The entry's properties that the record sets or clears. */\n\treadonly touched: readonly PropertyName[];\n}\n\n/** Returns every failure it finds; an empty array means valid. */\nexport type Validator<Context = SimpleContext, Code extends string = Failure[\"code\"]> = (context: Context) => Failure<Code>[];\n\nexport interface RegistryEntry {\n\treadonly properties: readonly PropertyName[];\n\t/** Record-only validators. Run as a chain that stops at the first validator reporting failures. */\n\treadonly simple: readonly Validator[];\n}\n\nconst propertyEntry = (property: PropertyName): RegistryEntry => ({\n\tproperties: [property],\n\tsimple: [({ record }): Failure[] => checkProperty(property, record)],\n});\n\n/**\n * The writable-property allowlist. The import pipeline extends each entry by key with its\n * enrichment and dependent validators, typed `{ [K in RegistryKey]: … }` so a new entry\n * cannot be missed.\n */\nexport const registry = {\n\ttuitionFees: propertyEntry(\"tuitionFees\"),\n\ttuitionFeeDescription: propertyEntry(\"tuitionFeeDescription\"),\n} as const satisfies { readonly [P in PropertyName]: RegistryEntry };\n\nexport type RegistryKey = keyof typeof registry;\n\nconst REGISTRY_KEYS = Object.keys(registry) as RegistryKey[];\n\n/** Keys of the registry entries covering the record's touched properties. Unknown properties are ignored. */\nexport const resolveEntries = (record: Unchecked<ImportRecordDraft>): RegistryKey[] => {\n\tconst touched = new Set(touchedProperties(record).filter(isPropertyName));\n\treturn REGISTRY_KEYS.filter((key) => registry[key].properties.some((property) => touched.has(property)));\n};\n","import { z } from \"zod\";\n\nimport { draftEnvelope, propertyMaps, recordEnvelope } from \"./envelope\";\nimport { toFailures } from \"./failures\";\nimport { checkShapes, isPropertyName, properties, touchedProperties } from \"./properties\";\nimport type { Failure, ImportRecord, ImportRecordDraft, Unchecked, ValidationResult } from \"./record\";\nimport { registry, resolveEntries } from \"./registry\";\n\nconst invalid = <T>(stage: \"schema\" | \"property\", failures: readonly Failure[]): ValidationResult<T> =>\n\t({ valid: false, stage, failures });\n\nconst checkEnvelope = <T extends ImportRecordDraft>(envelope: z.ZodType<Unchecked<T>>, input: unknown): ValidationResult<Unchecked<T>> => {\n\tconst result = envelope.safeParse(input);\n\tconst maps = propertyMaps.safeParse(input);\n\tconst failures = [\n\t\t...(result.success ? [] : toFailures(result.error, \"SCHEMA_INVALID\")),\n\t\t...(maps.success ? checkShapes(maps.data) : []),\n\t];\n\treturn result.success && failures.length === 0 ? { valid: true, record: result.data } : invalid(\"schema\", failures);\n};\n\nconst checkProperties = <T extends ImportRecordDraft>(record: Unchecked<T>): ValidationResult<T> => {\n\tconst touched = touchedProperties(record);\n\tconst notWritable = touched\n\t\t.filter((property) => !isPropertyName(property))\n\t\t.map((property): Failure => ({ code: \"PROPERTY_NOT_WRITABLE\", property, reason: \"Property is not writable\" }));\n\tif (notWritable.length > 0) {\n\t\treturn invalid(\"property\", notWritable);\n\t}\n\tconst failures = resolveEntries(record).flatMap((key) => {\n\t\tconst entry = registry[key];\n\t\tconst context = { record, touched: entry.properties.filter((property) => touched.includes(property)) };\n\t\tfor (const validator of entry.simple) {\n\t\t\tconst found = validator(context);\n\t\t\tif (found.length > 0) {\n\t\t\t\treturn found;\n\t\t\t}\n\t\t}\n\t\treturn [];\n\t});\n\t// Every touched property is writable and its set and clear values passed their rules, so the record has its checked type.\n\treturn failures.length > 0 ? invalid(\"property\", failures) : { valid: true, record: record as unknown as T };\n};\n\nconst chain = <T extends ImportRecordDraft>(schema: ValidationResult<Unchecked<T>>): ValidationResult<T> =>\n\tschema.valid ? checkProperties(schema.record) : schema;\n\n/** Phase 1 of the pipeline (and the first half of {@link validateRecord}): envelope and the shape of known properties. */\nexport const validateSchema = (input: unknown): ValidationResult<Unchecked<ImportRecord>> => checkEnvelope(recordEnvelope, input);\n\n/**\n * Phase 2, simple part: writable-property allowlist and record-only validators. The pipeline calls it after\n * dropping stale properties and before enrichment.\n */\nexport const validateProperties = (record: Unchecked<ImportRecord>): ValidationResult<ImportRecord> => checkProperties(record);\n\n/** For producers, before the registration endpoint has issued `eventId`. */\nexport const validateDraft = (input: unknown): ValidationResult<ImportRecordDraft> => chain(checkEnvelope(draftEnvelope, input));\n\n/** For producers, right before the record is pushed into the Data Stream. */\nexport const validateRecord = (input: unknown): ValidationResult<ImportRecord> => chain(checkEnvelope(recordEnvelope, input));\n\n/** The issued record as JSON Schema; cross-field rules such as discount bounds are not expressible there. */\nexport const importRecordJsonSchema = (): Record<string, unknown> => {\n\tconst definitions = Object.entries(properties);\n\tconst contract = recordEnvelope.extend({\n\t\tset: z.strictObject(Object.fromEntries(definitions.map(([property, { set }]) => [property, set.optional()]))),\n\t\tclear: z.strictObject(Object.fromEntries(definitions.map(([property, { clear }]) => [property, clear.optional()]))),\n\t});\n\t// A local registry: .meta() would write into Zod's global registry, which consumers may share.\n\tconst metadata = z.registry<{ title: string }>();\n\tmetadata.add(contract, { title: \"Data API import record\" });\n\treturn z.toJSONSchema(contract, { metadata });\n};\n","import { z } from \"zod\";\n\n// Ten digits: anything larger is almost certainly milliseconds.\nconst MAX_EPOCH_SECONDS = 9_999_999_999;\n\n// Zod's record parser drops a \"__proto__\" key without an issue; reject it rather than lose it.\nconst propertyMap = z.preprocess((value, context) => {\n\tif (typeof value === \"object\" && value !== null && Object.hasOwn(value, \"__proto__\")) {\n\t\tcontext.addIssue({ code: \"custom\", message: \"Property name __proto__ is not allowed\" });\n\t}\n\treturn value;\n}, z.record(z.string(), z.unknown()));\n\n/** Just the property maps, so their shapes can be checked even when other envelope fields are invalid. */\nexport const propertyMaps = z.object({ set: propertyMap, clear: propertyMap });\n\nexport const draftEnvelope = z.strictObject({\n\tentityType: z.literal(\"study\"),\n\tentityId: z.int().positive(),\n\tset: propertyMap,\n\tclear: propertyMap,\n});\n\nexport const recordEnvelope = draftEnvelope.extend({\n\t// import_event_log.event_id is VARCHAR(64).\n\teventId: z.string().min(1).max(64),\n\teventTimestamp: z.int().positive().max(MAX_EPOCH_SECONDS),\n});\n"],"mappings":";AAMO,IAAM,aAAa,CAAyB,OAAmB,MAAY,UAAmB,SAAe,CAAC,MACpH,MAAM,OAAO,IAAI,CAAC,UAAU;AAC3B,QAAM,OAAO,CAAC,GAAG,QAAQ,GAAG,MAAM,IAAI,EAAE,IAAI,MAAM;AAClD,SAAO;AAAA,IACN;AAAA,IACA,GAAI,aAAa,SAAY,CAAC,IAAI,EAAE,SAAS;AAAA,IAC7C,GAAI,KAAK,WAAW,IAAI,CAAC,IAAI,EAAE,MAAM,KAAK,KAAK,GAAG,EAAE;AAAA,IACpD,QAAQ,MAAM;AAAA,EACf;AACD,CAAC;;;ACfF,SAAS,KAAAA,UAAS;;;ACAlB,SAAS,SAAS;AA0BlB,IAAM,gBAAgB,CAAC,QAAmBC,OAAY,UAAkB,SAAuD;AAC9H,QAAM,SAASA,SAAQ,OAAO,UAAUA,MAAK,KAAK;AAClD,SAAO,QAAQ,YAAY,QAAQ,WAAW,OAAO,OAAO,kBAAkB,UAAU,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC;AAC9G;AAEO,IAAM,iBAAiB,CAAyE,gBAI9D;AAAA,EACxC,OAAO,WAAW;AAAA,EAClB,KAAK,WAAW,IAAI;AAAA,EACpB,OAAO,WAAW,MAAM;AAAA,EACxB,YAAY,CAAC,UAAU,KAAK,UAAU;AAAA,IACrC,GAAG,cAAc,WAAW,IAAI,OAAO,KAAK,UAAU,KAAK;AAAA,IAC3D,GAAG,cAAc,WAAW,MAAM,OAAO,OAAO,UAAU,OAAO;AAAA,EAClE;AACD;AAEO,IAAM,iBAAiB,CAA6B,QAC1D,eAAe,EAAE,OAAO,IAAI,OAAO,KAAK,OAAO,EAAE,OAAO,EAAE,QAAQ,IAAI,GAAG,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,CAAC;;;AD1C7F,IAAM,sBAAsB,CAAC,OAAO,YAAY,iBAAiB,OAAO;AAIxE,IAAM,oBAAoB,CAAC,UAAU,OAAO,QAAQ,SAAS,WAAW,aAAa,YAAY,QAAQ,UAAU,MAAM;AAmBhI,IAAM,WAAWC,GAAE,aAAa;AAAA,EAC/B,QAAQA,GAAE,OAAO;AAAA,EACjB,QAAQA,GAAE,OAAO;AAAA,EACjB,UAAUA,GAAE,OAAO;AAAA,EACnB,MAAMA,GAAE,OAAO;AAAA,EACf,UAAUA,GAAE,aAAa,EAAE,MAAMA,GAAE,OAAO,GAAG,OAAOA,GAAE,OAAO,EAAE,CAAC;AACjE,CAAC;AAGD,IAAM,YAAY;AAElB,IAAM,MAA6BA,GAAE,aAAa;AAAA,EACjD,QAAQA,GAAE,KAAK,mBAAmB;AAAA,EAClC,QAAQA,GAAE,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,SAAS;AAAA,EACpC,UAAUA,GAAE,aAAa;AAAA,EACzB,MAAMA,GAAE,KAAK,iBAAiB;AAAA,EAC9B,UAAUA,GAAE,mBAAmB,QAAQ;AAAA,IACtCA,GAAE,aAAa,EAAE,MAAMA,GAAE,QAAQ,YAAY,GAAG,OAAOA,GAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,KAAK,EAAE,CAAC;AAAA;AAAA,IAErFA,GAAE,aAAa,EAAE,MAAMA,GAAE,QAAQ,MAAM,GAAG,OAAOA,GAAE,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;AAAA,EACrE,CAAC;AACF,CAAC,EAAE;AAAA,EACF,CAAC,QAAQ,IAAI,SAAS,SAAS,UAAU,IAAI,SAAS,UAAU,KAAK,IAAI,SAAS,SAAS,IAAI,SAAS;AAAA,EACxG,EAAE,MAAM,CAAC,YAAY,OAAO,GAAG,SAAS,kDAAkD;AAC3F;AAEA,IAAM,aAAa,CAAC,WAAwC,IAAI,IAAI,MAAM,EAAE,SAAS,OAAO;AAC5F,IAAM,YAAY,CAAC,WAAwC,IAAI,IAAI,MAAM,EAAE,QAAQ;AACnF,IAAM,YAAY,CAAC,MAA8C,WAA4B,KAAK,KAAK,CAAC,QAAQ,IAAI,WAAW,MAAM;AAGrI,IAAM,OAAOA,GAAE,MAAM,GAAG,EACtB,OAAO,CAAC,SAAS,WAAW,KAAK,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,GAAG,sCAAsC,EAClG,OAAO,CAAC,SAAS,UAAU,KAAK,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAG,sCAAsC,EACnG,OAAO,CAAC,SAAS,UAAU,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,kCAAkC,EAC3F;AAAA,EACA,CAAC,SAAS,CAAC,UAAU,MAAM,KAAK,KAAK,EAAE,UAAU,MAAM,UAAU,KAAK,UAAU,MAAM,OAAO;AAAA,EAC7F;AACD;AAEM,IAAM,cAAsF,eAAe;AAAA,EACjH,OAAO;AAAA;AAAA,EAEP,KAAK,EAAE,OAAOA,GAAE,MAAM,QAAQ,GAAG,OAAO,KAAK,IAAI,CAAC,EAAE;AAAA,EACpD,OAAO;AAAA,IACN,OAAOA,GAAE,MAAMA,GAAE,OAAO,CAAC;AAAA,IACzB,OAAOA,GAAE,MAAMA,GAAE,KAAK,mBAAmB,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,YAAY,yCAAyC;AAAA,EAChH;AACD,CAAC;AAEM,IAAM,wBAAwB,eAAe,EAAE,OAAOA,GAAE,OAAO,GAAG,OAAOA,GAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC;;;AExDrG,IAAM,aAAyG;AAAA,EACrH;AAAA,EACA;AACD;AAEO,IAAM,iBAAiB,CAAC,SAAuC,OAAO,OAAO,YAAY,IAAI;AAQ7F,IAAM,gBAAgB,CAAyB,UAAa,UAAsC;AACxG,QAAM,SAAS,WAAW,QAAQ,EAAE,MAAM,UAAU,KAAK;AACzD,SAAO,OAAO,UAAU,CAAC,IAAI,WAAW,OAAO,OAAO,0BAA0B,QAAQ;AACzF;AAGO,IAAM,oBAAoB,CAAC,WACjC,CAAC,GAAG,oBAAI,IAAI,CAAC,GAAG,OAAO,KAAK,OAAO,GAAG,GAAG,GAAG,OAAO,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;AAExE,IAAM,OAAO,CAAC,QAA2C,aACvD,OAAO,OAAO,QAAQ,QAAQ,IAAI,EAAE,OAAO,OAAO,QAAQ,EAAE,IAAI;AAG3D,IAAM,cAAc,CAAC,WAC3B,kBAAkB,MAAM,EACtB,OAAO,cAAc,EACrB,QAAQ,CAAC,aAAa,WAAW,QAAQ,EAAE,WAAW,UAAU,KAAK,OAAO,KAAK,QAAQ,GAAG,KAAK,OAAO,OAAO,QAAQ,CAAC,CAAC;AAE5H,IAAM,YAAY,CAAC,QAAmB,QAA2C,UAAwB,SAA6C;AACrJ,MAAI,CAAC,OAAO,OAAO,QAAQ,QAAQ,GAAG;AACrC,WAAO,CAAC;AAAA,EACT;AACA,QAAM,SAAS,OAAO,UAAU,OAAO,QAAQ,CAAC;AAChD,SAAO,OAAO,UAAU,CAAC,IAAI,WAAW,OAAO,OAAO,0BAA0B,UAAU,CAAC,MAAM,QAAQ,CAAC;AAC3G;AAGO,IAAM,gBAAgB,CAAC,UAAwB,WAA4D;AAAA,EACjH,GAAG,UAAU,WAAW,QAAQ,EAAE,KAAK,OAAO,KAAK,UAAU,KAAK;AAAA,EAClE,GAAG,UAAU,WAAW,QAAQ,EAAE,OAAO,OAAO,OAAO,UAAU,OAAO;AACzE;;;AC9CA,IAAM,gBAAgB,CAAC,cAA2C;AAAA,EACjE,YAAY,CAAC,QAAQ;AAAA,EACrB,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAiB,cAAc,UAAU,MAAM,CAAC;AACpE;AAOO,IAAM,WAAW;AAAA,EACvB,aAAa,cAAc,aAAa;AAAA,EACxC,uBAAuB,cAAc,uBAAuB;AAC7D;AAIA,IAAM,gBAAgB,OAAO,KAAK,QAAQ;AAGnC,IAAM,iBAAiB,CAAC,WAAwD;AACtF,QAAM,UAAU,IAAI,IAAI,kBAAkB,MAAM,EAAE,OAAO,cAAc,CAAC;AACxE,SAAO,cAAc,OAAO,CAAC,QAAQ,SAAS,GAAG,EAAE,WAAW,KAAK,CAAC,aAAa,QAAQ,IAAI,QAAQ,CAAC,CAAC;AACxG;;;ACzCA,SAAS,KAAAC,UAAS;;;ACAlB,SAAS,KAAAC,UAAS;AAGlB,IAAM,oBAAoB;AAG1B,IAAM,cAAcA,GAAE,WAAW,CAAC,OAAO,YAAY;AACpD,MAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,OAAO,OAAO,OAAO,WAAW,GAAG;AACrF,YAAQ,SAAS,EAAE,MAAM,UAAU,SAAS,yCAAyC,CAAC;AAAA,EACvF;AACA,SAAO;AACR,GAAGA,GAAE,OAAOA,GAAE,OAAO,GAAGA,GAAE,QAAQ,CAAC,CAAC;AAG7B,IAAM,eAAeA,GAAE,OAAO,EAAE,KAAK,aAAa,OAAO,YAAY,CAAC;AAEtE,IAAM,gBAAgBA,GAAE,aAAa;AAAA,EAC3C,YAAYA,GAAE,QAAQ,OAAO;AAAA,EAC7B,UAAUA,GAAE,IAAI,EAAE,SAAS;AAAA,EAC3B,KAAK;AAAA,EACL,OAAO;AACR,CAAC;AAEM,IAAM,iBAAiB,cAAc,OAAO;AAAA;AAAA,EAElD,SAASA,GAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE;AAAA,EACjC,gBAAgBA,GAAE,IAAI,EAAE,SAAS,EAAE,IAAI,iBAAiB;AACzD,CAAC;;;ADnBD,IAAM,UAAU,CAAI,OAA8B,cAChD,EAAE,OAAO,OAAO,OAAO,SAAS;AAElC,IAAM,gBAAgB,CAA8B,UAAmC,UAAmD;AACzI,QAAM,SAAS,SAAS,UAAU,KAAK;AACvC,QAAM,OAAO,aAAa,UAAU,KAAK;AACzC,QAAM,WAAW;AAAA,IAChB,GAAI,OAAO,UAAU,CAAC,IAAI,WAAW,OAAO,OAAO,gBAAgB;AAAA,IACnE,GAAI,KAAK,UAAU,YAAY,KAAK,IAAI,IAAI,CAAC;AAAA,EAC9C;AACA,SAAO,OAAO,WAAW,SAAS,WAAW,IAAI,EAAE,OAAO,MAAM,QAAQ,OAAO,KAAK,IAAI,QAAQ,UAAU,QAAQ;AACnH;AAEA,IAAM,kBAAkB,CAA8B,WAA8C;AACnG,QAAM,UAAU,kBAAkB,MAAM;AACxC,QAAM,cAAc,QAClB,OAAO,CAAC,aAAa,CAAC,eAAe,QAAQ,CAAC,EAC9C,IAAI,CAAC,cAAuB,EAAE,MAAM,yBAAyB,UAAU,QAAQ,2BAA2B,EAAE;AAC9G,MAAI,YAAY,SAAS,GAAG;AAC3B,WAAO,QAAQ,YAAY,WAAW;AAAA,EACvC;AACA,QAAM,WAAW,eAAe,MAAM,EAAE,QAAQ,CAAC,QAAQ;AACxD,UAAM,QAAQ,SAAS,GAAG;AAC1B,UAAM,UAAU,EAAE,QAAQ,SAAS,MAAM,WAAW,OAAO,CAAC,aAAa,QAAQ,SAAS,QAAQ,CAAC,EAAE;AACrG,eAAW,aAAa,MAAM,QAAQ;AACrC,YAAM,QAAQ,UAAU,OAAO;AAC/B,UAAI,MAAM,SAAS,GAAG;AACrB,eAAO;AAAA,MACR;AAAA,IACD;AACA,WAAO,CAAC;AAAA,EACT,CAAC;AAED,SAAO,SAAS,SAAS,IAAI,QAAQ,YAAY,QAAQ,IAAI,EAAE,OAAO,MAAM,OAA+B;AAC5G;AAEA,IAAM,QAAQ,CAA8B,WAC3C,OAAO,QAAQ,gBAAgB,OAAO,MAAM,IAAI;AAG1C,IAAM,iBAAiB,CAAC,UAA8D,cAAc,gBAAgB,KAAK;AAMzH,IAAM,qBAAqB,CAAC,WAAoE,gBAAgB,MAAM;AAGtH,IAAM,gBAAgB,CAAC,UAAwD,MAAM,cAAc,eAAe,KAAK,CAAC;AAGxH,IAAM,iBAAiB,CAAC,UAAmD,MAAM,cAAc,gBAAgB,KAAK,CAAC;","names":["z","slot","z","z","z"]}

package/package.json

@@ -1,6 +1,53 @@
 {
-  "name": "@studyportals/data-api-interface",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@studyportals/data-api-interface",
+	"version": "0.1.0-0",
+	"description": "Schema validation for Data API import records, shared by producers (SIA) and the import pipeline.",
+	"author": "SPNightsWatch",
+	"license": "ISC",
+	"main": "./dist/index.js",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/index.d.mts",
+				"default": "./dist/index.mjs"
+			},
+			"require": {
+				"types": "./dist/index.d.ts",
+				"default": "./dist/index.js"
+			}
+		},
+		"./import-record.schema.json": "./schema/import-record.schema.json",
+		"./package.json": "./package.json"
+	},
+	"files": [
+		"dist",
+		"schema"
+	],
+	"sideEffects": false,
+	"engines": {
+		"node": ">=24"
+	},
+	"scripts": {
+		"build": "tsup",
+		"lint": "eslint .",
+		"test-u": "tsc --noEmit && vitest run",
+		"test-consumers": "bash scripts/check-consumers.sh",
+		"prepublishOnly": "npm run lint && npm run test-u && npm run build && npm run test-consumers",
+		"deploy-beta": "npm version prerelease && npm publish --tag beta",
+		"deploy-patch": "npm version patch && npm publish",
+		"deploy-minor": "npm version minor && npm publish",
+		"deploy-major": "npm version major && npm publish"
+	},
+	"dependencies": {
+		"zod": "^4.6.7"
+	},
+	"devDependencies": {
+		"@studyportals/code-style": "^3.0.0",
+		"@types/node": "^24.19.2",
+		"tsup": "^9.0.0",
+		"typescript": "^6.0.3",
+		"vitest": "^5.1.0"
+	}
+}

package/schema/import-record.schema.json

@@ -0,0 +1,161 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"type": "object",
+	"properties": {
+		"entityType": {
+			"type": "string",
+			"const": "study"
+		},
+		"entityId": {
+			"type": "integer",
+			"exclusiveMinimum": 0,
+			"maximum": 9007199254740991
+		},
+		"set": {
+			"type": "object",
+			"properties": {
+				"tuitionFees": {
+					"minItems": 1,
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"target": {
+								"type": "string",
+								"enum": [
+									"eea",
+									"national",
+									"international",
+									"local"
+								]
+							},
+							"amount": {
+								"type": "integer",
+								"minimum": 0,
+								"maximum": 2147483647
+							},
+							"currency": {
+								"type": "string",
+								"format": "currency_code",
+								"pattern": "^(?:AED|AFN|ALL|AMD|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLE|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|UYI|UYU|UYW|UZS|VED|VES|VND|VUV|WST|XAD|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XCG|XDR|XOF|XPD|XPF|XPT|XSU|XTS|XUA|XXX|YER|ZAR|ZMW|ZWG)$"
+							},
+							"unit": {
+								"type": "string",
+								"enum": [
+									"module",
+									"day",
+									"week",
+									"month",
+									"quarter",
+									"trimester",
+									"semester",
+									"year",
+									"credit",
+									"full"
+								]
+							},
+							"discount": {
+								"oneOf": [
+									{
+										"type": "object",
+										"properties": {
+											"type": {
+												"type": "string",
+												"const": "percentage"
+											},
+											"value": {
+												"type": "number",
+												"minimum": 1,
+												"maximum": 99.99
+											}
+										},
+										"required": [
+											"type",
+											"value"
+										],
+										"additionalProperties": false
+									},
+									{
+										"type": "object",
+										"properties": {
+											"type": {
+												"type": "string",
+												"const": "flat"
+											},
+											"value": {
+												"type": "number",
+												"minimum": 0
+											}
+										},
+										"required": [
+											"type",
+											"value"
+										],
+										"additionalProperties": false
+									}
+								]
+							}
+						},
+						"required": [
+							"target",
+							"amount",
+							"currency",
+							"unit",
+							"discount"
+						],
+						"additionalProperties": false
+					}
+				},
+				"tuitionFeeDescription": {
+					"type": "string",
+					"minLength": 1,
+					"maxLength": 160
+				}
+			},
+			"additionalProperties": false
+		},
+		"clear": {
+			"type": "object",
+			"properties": {
+				"tuitionFees": {
+					"minItems": 1,
+					"type": "array",
+					"items": {
+						"type": "string",
+						"enum": [
+							"eea",
+							"national",
+							"international",
+							"local"
+						]
+					}
+				},
+				"tuitionFeeDescription": {
+					"type": "boolean",
+					"const": true
+				}
+			},
+			"additionalProperties": false
+		},
+		"eventId": {
+			"type": "string",
+			"minLength": 1,
+			"maxLength": 64
+		},
+		"eventTimestamp": {
+			"type": "integer",
+			"exclusiveMinimum": 0,
+			"maximum": 9999999999
+		}
+	},
+	"required": [
+		"entityType",
+		"entityId",
+		"set",
+		"clear",
+		"eventId",
+		"eventTimestamp"
+	],
+	"additionalProperties": false,
+	"title": "Data API import record"
+}