@researchdatabox/redbox-core 5.0.4 → 5.1.0-beta.12573

package/dist/RecordConcurrencyObservability.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recordConcurrencyMetricLabels = recordConcurrencyMetricLabels;
+exports.emitRecordConcurrencyEvent = emitRecordConcurrencyEvent;
+const api_1 = require("@opentelemetry/api");
+const sails_ng_common_1 = require("@researchdatabox/sails-ng-common");
+const conflictCodes = new Set(sails_ng_common_1.RECORD_CONCURRENCY_PROBLEM_CODES);
+const eventKinds = new Set(['save-outcome', 'internal-retry', 'lifecycle-recovery']);
+const routeFamilies = new Set(['browser', 'api', 'internal']);
+const writeKinds = new Set(['create', 'update', 'transition', 'delete', 'restore', 'purge']);
+const phases = new Set(['pre-save', 'persistence', 'attachments', 'post-save', 'response', 'transport']);
+const outcomes = new Set([
+    'saved',
+    'saved-with-warnings',
+    'not-saved',
+    'unknown',
+    'attempted',
+    'exhausted',
+    'completed',
+    'cancelled',
+    'retained',
+]);
+const preconditions = new Set(['not-applicable', 'missing', 'matching', 'stale']);
+const modes = new Set(sails_ng_common_1.RECORD_CONCURRENT_MODIFICATION_MODES);
+const resolutions = new Set(sails_ng_common_1.RECORD_CONCURRENCY_RESOLUTIONS);
+const problemKinds = new Set(['validation', 'processing', 'authorization', 'conflict', 'system', 'network']);
+const safeLogReferencePattern = /^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$/;
+function boundedMetricLabel(value, allowed, fallback) {
+    return typeof value === 'string' && allowed.has(value) ? value : fallback;
+}
+function boundedLogReference(value, fallback) {
+    return typeof value === 'string' && safeLogReferencePattern.test(value.trim()) ? value.trim() : fallback;
+}
+function boundedRevision(value) {
+    return Number.isSafeInteger(value) && Number(value) >= 0 ? Number(value) : undefined;
+}
+const meter = api_1.metrics.getMeter('redbox.record-concurrency');
+const preconditionCounter = meter.createCounter('record_concurrency_precondition_total', {
+    description: 'Record mutation preconditions by bounded policy and result.',
+    unit: '{precondition}',
+});
+const conflictCounter = meter.createCounter('record_concurrency_conflict_total', {
+    description: 'Certified record concurrency conflicts by safe code and write kind.',
+    unit: '{conflict}',
+});
+const resolutionCounter = meter.createCounter('record_concurrency_resolution_total', {
+    description: 'Record mutation results by normalized concurrency resolution.',
+    unit: '{resolution}',
+});
+const internalRetryCounter = meter.createCounter('record_concurrency_internal_retry_total', {
+    description: 'Bounded recomputable internal mutation retries.',
+    unit: '{retry}',
+});
+const lifecycleRecoveryCounter = meter.createCounter('record_concurrency_lifecycle_recovery_total', {
+    description: 'Lifecycle recovery results by operation and bounded outcome.',
+    unit: '{recovery}',
+});
+/** Low-cardinality metric labels. Identifiers and revisions are deliberately impossible to add here. */
+function recordConcurrencyMetricLabels(event) {
+    return {
+        event_kind: boundedMetricLabel(event.kind, eventKinds, 'other'),
+        route_family: boundedMetricLabel(event.routeFamily, routeFamilies, 'other'),
+        write_kind: boundedMetricLabel(event.writeKind, writeKinds, 'other'),
+        phase: boundedMetricLabel(event.phase, phases, 'other'),
+        outcome: boundedMetricLabel(event.outcome, outcomes, 'other'),
+        precondition: boundedMetricLabel(event.precondition, preconditions, 'other'),
+        mode: event.mode === undefined ? 'unavailable' : boundedMetricLabel(event.mode, modes, 'other'),
+        problem_code: event.problemCode ? (conflictCodes.has(event.problemCode) ? event.problemCode : 'other') : 'none',
+        resolution: event.resolution === undefined ? 'direct' : boundedMetricLabel(event.resolution, resolutions, 'other'),
+    };
+}
+/**
+ * Emit one value-free structured event and its bounded counters.
+ *
+ * Revision coordinates are bounded integers, and record type is log-only
+ * because deployments may have an unbounded extension set. Identifiers are
+ * deliberately absent, these values are never copied to metric labels, and
+ * this contract has no fields capable of carrying record values, headers,
+ * paths, or exceptions.
+ */
+function emitRecordConcurrencyEvent(event, logger = sails.log) {
+    const expectedRevision = boundedRevision(event.expectedRevision);
+    const currentRevision = boundedRevision(event.currentRevision);
+    const safeEvent = Object.freeze({
+        kind: boundedMetricLabel(event.kind, eventKinds, 'other'),
+        routeFamily: boundedMetricLabel(event.routeFamily, routeFamilies, 'other'),
+        writeKind: boundedMetricLabel(event.writeKind, writeKinds, 'other'),
+        ...(event.recordType === undefined ? {} : { recordType: boundedLogReference(event.recordType, 'unavailable') }),
+        phase: boundedMetricLabel(event.phase, phases, 'other'),
+        outcome: boundedMetricLabel(event.outcome, outcomes, 'other'),
+        ...(event.mode === undefined ? {} : { mode: boundedMetricLabel(event.mode, modes, 'other') }),
+        ...(expectedRevision === undefined ? {} : { expectedRevision }),
+        ...(currentRevision === undefined ? {} : { currentRevision }),
+        precondition: boundedMetricLabel(event.precondition, preconditions, 'other'),
+        ...(event.problemKind === undefined
+            ? {}
+            : { problemKind: boundedMetricLabel(event.problemKind, problemKinds, 'other') }),
+        ...(event.problemCode === undefined
+            ? {}
+            : { problemCode: conflictCodes.has(event.problemCode) ? event.problemCode : 'other' }),
+        ...(event.resolution === undefined
+            ? {}
+            : { resolution: boundedMetricLabel(event.resolution, resolutions, 'other') }),
+        ...(event.errorType === undefined ? {} : { errorType: boundedLogReference(event.errorType, 'other') }),
+    });
+    const logDetails = Object.freeze({ event: 'record_concurrency_event', ...safeEvent });
+    const isWarning = Boolean(safeEvent.errorType || safeEvent.problemKind || safeEvent.problemCode) ||
+        safeEvent.outcome === 'not-saved' ||
+        safeEvent.outcome === 'unknown' ||
+        safeEvent.outcome === 'saved-with-warnings' ||
+        safeEvent.outcome === 'exhausted' ||
+        safeEvent.outcome === 'retained';
+    if (isWarning) {
+        logger.warn('record_concurrency_event', logDetails);
+    }
+    else {
+        logger.info('record_concurrency_event', logDetails);
+    }
+    const labels = recordConcurrencyMetricLabels(event);
+    if (safeEvent.kind === 'save-outcome') {
+        if (safeEvent.writeKind !== 'create')
+            preconditionCounter.add(1, labels);
+        if (safeEvent.problemCode && conflictCodes.has(safeEvent.problemCode))
+            conflictCounter.add(1, labels);
+        if (safeEvent.resolution)
+            resolutionCounter.add(1, labels);
+    }
+    else if (safeEvent.kind === 'internal-retry') {
+        internalRetryCounter.add(1, labels);
+    }
+    else if (safeEvent.kind === 'lifecycle-recovery') {
+        lifecycleRecoveryCounter.add(1, labels);
+    }
+    return safeEvent;
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"RecordConcurrencyObservability.js","sourceRoot":"","sources":["../src/RecordConcurrencyObservability.ts"],"names":[],"mappings":";;AA4GA,sEAYC;AAWD,gEAoDC;AAvLD,4CAA8D;AAC9D,sEAS0C;AAyC1C,MAAM,aAAa,GAAG,IAAI,GAAG,CAAS,kDAAgC,CAAC,CAAC;AACxE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAS,CAAC,cAAc,EAAE,gBAAgB,EAAE,oBAAoB,CAAC,CAAC,CAAC;AAC7F,MAAM,aAAa,GAAG,IAAI,GAAG,CAAS,CAAC,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;AACtE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AACrG,MAAM,MAAM,GAAG,IAAI,GAAG,CAAS,CAAC,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;AACjH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS;IAC/B,OAAO;IACP,qBAAqB;IACrB,WAAW;IACX,SAAS;IACT,WAAW;IACX,WAAW;IACX,WAAW;IACX,WAAW;IACX,UAAU;CACX,CAAC,CAAC;AACH,MAAM,aAAa,GAAG,IAAI,GAAG,CAAS,CAAC,gBAAgB,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;AAC1F,MAAM,KAAK,GAAG,IAAI,GAAG,CAAS,sDAAoC,CAAC,CAAC;AACpE,MAAM,WAAW,GAAG,IAAI,GAAG,CAAS,gDAA8B,CAAC,CAAC;AACpE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAS,CAAC,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AACrH,MAAM,uBAAuB,GAAG,qCAAqC,CAAC;AAEtE,SAAS,kBAAkB,CAAC,KAAc,EAAE,OAA4B,EAAE,QAAgB;IACxF,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC5E,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAc,EAAE,QAAgB;IAC3D,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC3G,CAAC;AAED,SAAS,eAAe,CAAC,KAAc;IACrC,OAAO,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACvF,CAAC;AAED,MAAM,KAAK,GAAG,aAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC;AAC5D,MAAM,mBAAmB,GAAG,KAAK,CAAC,aAAa,CAAC,uCAAuC,EAAE;IACvF,WAAW,EAAE,6DAA6D;IAC1E,IAAI,EAAE,gBAAgB;CACvB,CAAC,CAAC;AACH,MAAM,eAAe,GAAG,KAAK,CAAC,aAAa,CAAC,mCAAmC,EAAE;IAC/E,WAAW,EAAE,qEAAqE;IAClF,IAAI,EAAE,YAAY;CACnB,CAAC,CAAC;AACH,MAAM,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAC,qCAAqC,EAAE;IACnF,WAAW,EAAE,+DAA+D;IAC5E,IAAI,EAAE,cAAc;CACrB,CAAC,CAAC;AACH,MAAM,oBAAoB,GAAG,KAAK,CAAC,aAAa,CAAC,yCAAyC,EAAE;IAC1F,WAAW,EAAE,iDAAiD;IAC9D,IAAI,EAAE,SAAS;CAChB,CAAC,CAAC;AACH,MAAM,wBAAwB,GAAG,KAAK,CAAC,aAAa,CAAC,6CAA6C,EAAE;IAClG,WAAW,EAAE,8DAA8D;IAC3E,IAAI,EAAE,YAAY;CACnB,CAAC,CAAC;AAEH,wGAAwG;AACxG,SAAgB,6BAA6B,CAAC,KAA6B;IACzE,OAAO;QACL,UAAU,EAAE,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC;QAC/D,YAAY,EAAE,kBAAkB,CAAC,KAAK,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC;QAC3E,UAAU,EAAE,kBAAkB,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC;QACpE,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC;QACvD,OAAO,EAAE,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC;QAC7D,YAAY,EAAE,kBAAkB,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,EAAE,OAAO,CAAC;QAC5E,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC;QAC/F,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM;QAC/G,UAAU,EAAE,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC;KACnH,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,0BAA0B,CACxC,KAA6B,EAC7B,SAAyC,KAAK,CAAC,GAAG;IAElD,MAAM,gBAAgB,GAAG,eAAe,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjE,MAAM,eAAe,GAAG,eAAe,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAC/D,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;QAC9B,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC;QACzD,WAAW,EAAE,kBAAkB,CAAC,KAAK,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC;QAC1E,SAAS,EAAE,kBAAkB,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC;QACnE,GAAG,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,mBAAmB,CAAC,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC;QAC/G,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC;QACvD,OAAO,EAAE,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC;QAC7D,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;QAC7F,GAAG,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,CAAC;QAC/D,GAAG,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC;QAC7D,YAAY,EAAE,kBAAkB,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,EAAE,OAAO,CAAC;QAC5E,GAAG,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS;YACjC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,WAAW,EAAE,kBAAkB,CAAC,KAAK,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,CAAC;QAClF,GAAG,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS;YACjC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACxF,GAAG,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS;YAChC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,UAAU,EAAE,kBAAkB,CAAC,KAAK,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC;QAC/E,GAAG,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,mBAAmB,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC;KACvG,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,0BAA0B,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;IACtF,MAAM,SAAS,GACb,OAAO,CAAC,SAAS,CAAC,SAAS,IAAI,SAAS,CAAC,WAAW,IAAI,SAAS,CAAC,WAAW,CAAC;QAC9E,SAAS,CAAC,OAAO,KAAK,WAAW;QACjC,SAAS,CAAC,OAAO,KAAK,SAAS;QAC/B,SAAS,CAAC,OAAO,KAAK,qBAAqB;QAC3C,SAAS,CAAC,OAAO,KAAK,WAAW;QACjC,SAAS,CAAC,OAAO,KAAK,UAAU,CAAC;IACnC,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,CAAC,IAAI,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;IACtD,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,IAAI,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,MAAM,GAAG,6BAA6B,CAAC,KAAK,CAAC,CAAC;IACpD,IAAI,SAAS,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QACtC,IAAI,SAAS,CAAC,SAAS,KAAK,QAAQ;YAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACzE,IAAI,SAAS,CAAC,WAAW,IAAI,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC;YAAE,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACtG,IAAI,SAAS,CAAC,UAAU;YAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;SAAM,IAAI,SAAS,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QAC/C,oBAAoB,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;SAAM,IAAI,SAAS,CAAC,IAAI,KAAK,oBAAoB,EAAE,CAAC;QACnD,wBAAwB,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/RecordEntityTag.d.ts

@@ -0,0 +1,31 @@
+import { type RecordEntityTag } from '@researchdatabox/sails-ng-common';
+export type { RecordEntityTag } from '@researchdatabox/sails-ng-common';
+export type RecordEntityTagParseFailureReason = 'missing' | 'malformed' | 'too-long' | 'multiple' | 'weak' | 'wildcard' | 'record-mismatch';
+export interface ParsedRecordEntityTag {
+    readonly entityTag: RecordEntityTag;
+    readonly expectedRevision: number;
+}
+export type RecordEntityTagParseResult = {
+    readonly valid: true;
+    readonly value: ParsedRecordEntityTag;
+} | {
+    readonly valid: false;
+    readonly reason: RecordEntityTagParseFailureReason;
+};
+/**
+ * Format the sole record entity-tag representation. Callers must treat the
+ * returned quoted value as opaque and must never derive it from the numeric
+ * revision on the client.
+ */
+export declare function formatRecordEntityTag(recordOid: string, revision: number): RecordEntityTag;
+/**
+ * Parse one exact `If-Match` tag for a known record. Arrays, comma-joined
+ * lists, weak validators, wildcards, malformed values, and tags bound to
+ * another OID are all rejected, and no raw header text is returned or logged.
+ *
+ * An old but well-formed tag for the same record parses successfully: deciding
+ * that it is stale belongs to the policy and compare-and-set boundary, not to
+ * request parsing.
+ */
+export declare function parseRecordEntityTag(value: unknown, recordOid: string): RecordEntityTagParseResult;
+//# sourceMappingURL=RecordEntityTag.d.ts.map

package/dist/RecordEntityTag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordEntityTag.d.ts","sourceRoot":"","sources":["../src/RecordEntityTag.ts"],"names":[],"mappings":"AACA,OAAO,EAOL,KAAK,eAAe,EACrB,MAAM,kCAAkC,CAAC;AAE1C,YAAY,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAExE,MAAM,MAAM,iCAAiC,GACzC,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,MAAM,GACN,UAAU,GACV,iBAAiB,CAAC;AAEtB,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;IACpC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,MAAM,0BAA0B,GAClC;IAAE,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,qBAAqB,CAAA;CAAE,GAC/D;IAAE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,iCAAiC,CAAA;CAAE,CAAC;AA8BlF;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,eAAe,CAU1F;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,0BAA0B,CA+ClG"}

package/dist/RecordEntityTag.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatRecordEntityTag = formatRecordEntityTag;
+exports.parseRecordEntityTag = parseRecordEntityTag;
+const node_crypto_1 = require("node:crypto");
+const sails_ng_common_1 = require("@researchdatabox/sails-ng-common");
+/**
+ * The record OID is server-supplied route context, not client input, so an
+ * unusable value is a programming error rather than a request-contract error.
+ */
+function assertRecordOid(recordOid) {
+    if (typeof recordOid !== 'string' ||
+        recordOid.length === 0 ||
+        recordOid.length > sails_ng_common_1.RECORD_ENTITY_TAG_RECORD_ID_MAX_LENGTH) {
+        throw new TypeError('Record OID must be a non-empty bounded string.');
+    }
+}
+/**
+ * Bind identity and revision into a fixed-width payload. The digest is an
+ * unkeyed hash: it makes a tag from another record fail to match and keeps the
+ * tag bounded regardless of OID length. It is not a signature and carries no
+ * authorization.
+ */
+function identityDigest(recordOid, revision) {
+    return (0, node_crypto_1.createHash)('sha256')
+        .update(`${sails_ng_common_1.RECORD_ENTITY_TAG_VERSION}\0${recordOid.length}\0`, 'utf8')
+        .update(recordOid, 'utf8')
+        .update(`\0${revision}`, 'utf8')
+        .digest('base64url');
+}
+/**
+ * Format the sole record entity-tag representation. Callers must treat the
+ * returned quoted value as opaque and must never derive it from the numeric
+ * revision on the client.
+ */
+function formatRecordEntityTag(recordOid, revision) {
+    assertRecordOid(recordOid);
+    if (!(0, sails_ng_common_1.isRecordRevision)(revision)) {
+        throw new TypeError('Record revision must be a non-negative safe integer.');
+    }
+    const entityTag = `"${sails_ng_common_1.RECORD_ENTITY_TAG_VERSION}.${revision}.${identityDigest(recordOid, revision)}"`;
+    if (!(0, sails_ng_common_1.isRecordEntityTag)(entityTag)) {
+        throw new Error('Generated record entity tag did not satisfy the shared contract.');
+    }
+    return entityTag;
+}
+/**
+ * Parse one exact `If-Match` tag for a known record. Arrays, comma-joined
+ * lists, weak validators, wildcards, malformed values, and tags bound to
+ * another OID are all rejected, and no raw header text is returned or logged.
+ *
+ * An old but well-formed tag for the same record parses successfully: deciding
+ * that it is stale belongs to the policy and compare-and-set boundary, not to
+ * request parsing.
+ */
+function parseRecordEntityTag(value, recordOid) {
+    assertRecordOid(recordOid);
+    if (value === undefined || value === null) {
+        return { valid: false, reason: 'missing' };
+    }
+    if (Array.isArray(value)) {
+        return { valid: false, reason: 'multiple' };
+    }
+    if (typeof value !== 'string') {
+        return { valid: false, reason: 'malformed' };
+    }
+    // Bound the untrusted header before any further work.
+    if (value.length > sails_ng_common_1.RECORD_ENTITY_TAG_MAX_LENGTH) {
+        return { valid: false, reason: 'too-long' };
+    }
+    const normalized = value.trim();
+    // Once a header field is present, an empty value is malformed. Only the
+    // absence of the field is a missing precondition.
+    if (normalized.length === 0) {
+        return { valid: false, reason: 'malformed' };
+    }
+    if (normalized === '*') {
+        return { valid: false, reason: 'wildcard' };
+    }
+    if (/^W\//i.test(normalized)) {
+        return { valid: false, reason: 'weak' };
+    }
+    if (normalized.includes(',')) {
+        return { valid: false, reason: 'multiple' };
+    }
+    const match = sails_ng_common_1.RECORD_ENTITY_TAG_PATTERN.exec(normalized);
+    if (!match) {
+        return { valid: false, reason: 'malformed' };
+    }
+    const expectedRevision = Number(match[1]);
+    if (!(0, sails_ng_common_1.isRecordRevision)(expectedRevision)) {
+        return { valid: false, reason: 'malformed' };
+    }
+    // Recomputing the whole tag proves the digest binds this OID and revision.
+    const expectedTag = formatRecordEntityTag(recordOid, expectedRevision);
+    if (normalized !== expectedTag) {
+        return { valid: false, reason: 'record-mismatch' };
+    }
+    return { valid: true, value: { entityTag: expectedTag, expectedRevision } };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVjb3JkRW50aXR5VGFnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL1JlY29yZEVudGl0eVRhZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQWdFQSxzREFVQztBQVdELG9EQStDQztBQXBJRCw2Q0FBeUM7QUFDekMsc0VBUTBDO0FBc0IxQzs7O0dBR0c7QUFDSCxTQUFTLGVBQWUsQ0FBQyxTQUFpQjtJQUN4QyxJQUNFLE9BQU8sU0FBUyxLQUFLLFFBQVE7UUFDN0IsU0FBUyxDQUFDLE1BQU0sS0FBSyxDQUFDO1FBQ3RCLFNBQVMsQ0FBQyxNQUFNLEdBQUcsd0RBQXNDLEVBQ3pELENBQUM7UUFDRCxNQUFNLElBQUksU0FBUyxDQUFDLGdEQUFnRCxDQUFDLENBQUM7SUFDeEUsQ0FBQztBQUNILENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILFNBQVMsY0FBYyxDQUFDLFNBQWlCLEVBQUUsUUFBZ0I7SUFDekQsT0FBTyxJQUFBLHdCQUFVLEVBQUMsUUFBUSxDQUFDO1NBQ3hCLE1BQU0sQ0FBQyxHQUFHLDJDQUF5QixLQUFLLFNBQVMsQ0FBQyxNQUFNLElBQUksRUFBRSxNQUFNLENBQUM7U0FDckUsTUFBTSxDQUFDLFNBQVMsRUFBRSxNQUFNLENBQUM7U0FDekIsTUFBTSxDQUFDLEtBQUssUUFBUSxFQUFFLEVBQUUsTUFBTSxDQUFDO1NBQy9CLE1BQU0sQ0FBQyxXQUFXLENBQUMsQ0FBQztBQUN6QixDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILFNBQWdCLHFCQUFxQixDQUFDLFNBQWlCLEVBQUUsUUFBZ0I7SUFDdkUsZUFBZSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzNCLElBQUksQ0FBQyxJQUFBLGtDQUFnQixFQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUM7UUFDaEMsTUFBTSxJQUFJLFNBQVMsQ0FBQyxzREFBc0QsQ0FBQyxDQUFDO0lBQzlFLENBQUM7SUFDRCxNQUFNLFNBQVMsR0FBRyxJQUFJLDJDQUF5QixJQUFJLFFBQVEsSUFBSSxjQUFjLENBQUMsU0FBUyxFQUFFLFFBQVEsQ0FBQyxHQUFHLENBQUM7SUFDdEcsSUFBSSxDQUFDLElBQUEsbUNBQWlCLEVBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQztRQUNsQyxNQUFNLElBQUksS0FBSyxDQUFDLGtFQUFrRSxDQUFDLENBQUM7SUFDdEYsQ0FBQztJQUNELE9BQU8sU0FBUyxDQUFDO0FBQ25CLENBQUM7QUFFRDs7Ozs7Ozs7R0FRRztBQUNILFNBQWdCLG9CQUFvQixDQUFDLEtBQWMsRUFBRSxTQUFpQjtJQUNwRSxlQUFlLENBQUMsU0FBUyxDQUFDLENBQUM7SUFDM0IsSUFBSSxLQUFLLEtBQUssU0FBUyxJQUFJLEtBQUssS0FBSyxJQUFJLEVBQUUsQ0FBQztRQUMxQyxPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsU0FBUyxFQUFFLENBQUM7SUFDN0MsQ0FBQztJQUNELElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDO1FBQ3pCLE9BQU8sRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxVQUFVLEVBQUUsQ0FBQztJQUM5QyxDQUFDO0lBQ0QsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLEVBQUUsQ0FBQztRQUM5QixPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsV0FBVyxFQUFFLENBQUM7SUFDL0MsQ0FBQztJQUNELHNEQUFzRDtJQUN0RCxJQUFJLEtBQUssQ0FBQyxNQUFNLEdBQUcsOENBQTRCLEVBQUUsQ0FBQztRQUNoRCxPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsVUFBVSxFQUFFLENBQUM7SUFDOUMsQ0FBQztJQUVELE1BQU0sVUFBVSxHQUFHLEtBQUssQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUNoQyx3RUFBd0U7SUFDeEUsa0RBQWtEO0lBQ2xELElBQUksVUFBVSxDQUFDLE1BQU0sS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUM1QixPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsV0FBVyxFQUFFLENBQUM7SUFDL0MsQ0FBQztJQUNELElBQUksVUFBVSxLQUFLLEdBQUcsRUFBRSxDQUFDO1FBQ3ZCLE9BQU8sRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxVQUFVLEVBQUUsQ0FBQztJQUM5QyxDQUFDO0lBQ0QsSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxFQUFFLENBQUM7UUFDN0IsT0FBTyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sRUFBRSxDQUFDO0lBQzFDLENBQUM7SUFDRCxJQUFJLFVBQVUsQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUM3QixPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsVUFBVSxFQUFFLENBQUM7SUFDOUMsQ0FBQztJQUVELE1BQU0sS0FBSyxHQUFHLDJDQUF5QixDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUN6RCxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDWCxPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsV0FBVyxFQUFFLENBQUM7SUFDL0MsQ0FBQztJQUNELE1BQU0sZ0JBQWdCLEdBQUcsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQzFDLElBQUksQ0FBQyxJQUFBLGtDQUFnQixFQUFDLGdCQUFnQixDQUFDLEVBQUUsQ0FBQztRQUN4QyxPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsV0FBVyxFQUFFLENBQUM7SUFDL0MsQ0FBQztJQUVELDJFQUEyRTtJQUMzRSxNQUFNLFdBQVcsR0FBRyxxQkFBcUIsQ0FBQyxTQUFTLEVBQUUsZ0JBQWdCLENBQUMsQ0FBQztJQUN2RSxJQUFJLFVBQVUsS0FBSyxXQUFXLEVBQUUsQ0FBQztRQUMvQixPQUFPLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsaUJBQWlCLEVBQUUsQ0FBQztJQUNyRCxDQUFDO0lBQ0QsT0FBTyxFQUFFLEtBQUssRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLEVBQUUsU0FBUyxFQUFFLFdBQVcsRUFBRSxnQkFBZ0IsRUFBRSxFQUFFLENBQUM7QUFDOUUsQ0FBQyJ9

package/dist/RecordFormFingerprint.d.ts

@@ -0,0 +1,7 @@
+import { type RecordFormFingerprint } from '@researchdatabox/sails-ng-common';
+/**
+ * Build a stable, bounded fingerprint for an authoritative form contract.
+ * Accessors are never invoked and the serialized contract is never retained.
+ */
+export declare function formatRecordFormFingerprint(value: unknown): RecordFormFingerprint | undefined;
+//# sourceMappingURL=RecordFormFingerprint.d.ts.map

package/dist/RecordFormFingerprint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordFormFingerprint.d.ts","sourceRoot":"","sources":["../src/RecordFormFingerprint.ts"],"names":[],"mappings":"AACA,OAAO,EAA2B,KAAK,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAKvG;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,qBAAqB,GAAG,SAAS,CAuF7F"}

package/dist/RecordFormFingerprint.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatRecordFormFingerprint = formatRecordFormFingerprint;
+const node_crypto_1 = require("node:crypto");
+const sails_ng_common_1 = require("@researchdatabox/sails-ng-common");
+const RECORD_FORM_FINGERPRINT_MAX_BYTES = 1_048_576;
+const RECORD_FORM_FINGERPRINT_MAX_NODES = 50_000;
+/**
+ * Build a stable, bounded fingerprint for an authoritative form contract.
+ * Accessors are never invoked and the serialized contract is never retained.
+ */
+function formatRecordFormFingerprint(value) {
+    const hash = (0, node_crypto_1.createHash)('sha256');
+    const seen = new WeakSet();
+    let bytes = 0;
+    let nodes = 0;
+    let bounded = true;
+    const append = (part) => {
+        if (!bounded)
+            return;
+        const size = Buffer.byteLength(part);
+        if (bytes + size > RECORD_FORM_FINGERPRINT_MAX_BYTES) {
+            bounded = false;
+            return;
+        }
+        bytes += size;
+        hash.update(part);
+    };
+    const walk = (item) => {
+        nodes += 1;
+        if (nodes > RECORD_FORM_FINGERPRINT_MAX_NODES) {
+            bounded = false;
+            return;
+        }
+        if (item === null || typeof item === 'boolean' || typeof item === 'string') {
+            append(JSON.stringify(item));
+            return;
+        }
+        if (typeof item === 'number') {
+            append(Number.isFinite(item) ? JSON.stringify(item) : JSON.stringify(String(item)));
+            return;
+        }
+        if (typeof item === 'undefined') {
+            append('"[undefined]"');
+            return;
+        }
+        if (typeof item === 'function') {
+            append(JSON.stringify(`[function:${Function.prototype.toString.call(item)}]`));
+            return;
+        }
+        if (typeof item !== 'object') {
+            append(JSON.stringify(String(item)));
+            return;
+        }
+        if (seen.has(item)) {
+            append('"[circular]"');
+            return;
+        }
+        seen.add(item);
+        try {
+            const descriptors = Object.getOwnPropertyDescriptors(item);
+            if (Array.isArray(item)) {
+                append('[');
+                for (let index = 0; index < item.length && bounded; index += 1) {
+                    if (index > 0)
+                        append(',');
+                    const descriptor = descriptors[String(index)];
+                    if (descriptor && 'value' in descriptor)
+                        walk(descriptor.value);
+                    else
+                        append('"[accessor-or-hole]"');
+                }
+                append(']');
+                return;
+            }
+            append('{');
+            let first = true;
+            for (const key of Object.keys(descriptors).sort()) {
+                const descriptor = descriptors[key];
+                if (!descriptor.enumerable)
+                    continue;
+                if (!first)
+                    append(',');
+                first = false;
+                append(JSON.stringify(key));
+                append(':');
+                if ('value' in descriptor)
+                    walk(descriptor.value);
+                else
+                    append('"[accessor]"');
+                if (!bounded)
+                    break;
+            }
+            append('}');
+        }
+        finally {
+            seen.delete(item);
+        }
+    };
+    walk(value);
+    if (!bounded)
+        return undefined;
+    const fingerprint = `sha256:${hash.digest('hex')}`;
+    return (0, sails_ng_common_1.isRecordFormFingerprint)(fingerprint) ? fingerprint : undefined;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVjb3JkRm9ybUZpbmdlcnByaW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL1JlY29yZEZvcm1GaW5nZXJwcmludC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQVVBLGtFQXVGQztBQWpHRCw2Q0FBeUM7QUFDekMsc0VBQXVHO0FBRXZHLE1BQU0saUNBQWlDLEdBQUcsU0FBUyxDQUFDO0FBQ3BELE1BQU0saUNBQWlDLEdBQUcsTUFBTSxDQUFDO0FBRWpEOzs7R0FHRztBQUNILFNBQWdCLDJCQUEyQixDQUFDLEtBQWM7SUFDeEQsTUFBTSxJQUFJLEdBQUcsSUFBQSx3QkFBVSxFQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ2xDLE1BQU0sSUFBSSxHQUFHLElBQUksT0FBTyxFQUFVLENBQUM7SUFDbkMsSUFBSSxLQUFLLEdBQUcsQ0FBQyxDQUFDO0lBQ2QsSUFBSSxLQUFLLEdBQUcsQ0FBQyxDQUFDO0lBQ2QsSUFBSSxPQUFPLEdBQUcsSUFBSSxDQUFDO0lBRW5CLE1BQU0sTUFBTSxHQUFHLENBQUMsSUFBWSxFQUFRLEVBQUU7UUFDcEMsSUFBSSxDQUFDLE9BQU87WUFBRSxPQUFPO1FBQ3JCLE1BQU0sSUFBSSxHQUFHLE1BQU0sQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDckMsSUFBSSxLQUFLLEdBQUcsSUFBSSxHQUFHLGlDQUFpQyxFQUFFLENBQUM7WUFDckQsT0FBTyxHQUFHLEtBQUssQ0FBQztZQUNoQixPQUFPO1FBQ1QsQ0FBQztRQUNELEtBQUssSUFBSSxJQUFJLENBQUM7UUFDZCxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3BCLENBQUMsQ0FBQztJQUVGLE1BQU0sSUFBSSxHQUFHLENBQUMsSUFBYSxFQUFRLEVBQUU7UUFDbkMsS0FBSyxJQUFJLENBQUMsQ0FBQztRQUNYLElBQUksS0FBSyxHQUFHLGlDQUFpQyxFQUFFLENBQUM7WUFDOUMsT0FBTyxHQUFHLEtBQUssQ0FBQztZQUNoQixPQUFPO1FBQ1QsQ0FBQztRQUNELElBQUksSUFBSSxLQUFLLElBQUksSUFBSSxPQUFPLElBQUksS0FBSyxTQUFTLElBQUksT0FBTyxJQUFJLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDM0UsTUFBTSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztZQUM3QixPQUFPO1FBQ1QsQ0FBQztRQUNELElBQUksT0FBTyxJQUFJLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDN0IsTUFBTSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNwRixPQUFPO1FBQ1QsQ0FBQztRQUNELElBQUksT0FBTyxJQUFJLEtBQUssV0FBVyxFQUFFLENBQUM7WUFDaEMsTUFBTSxDQUFDLGVBQWUsQ0FBQyxDQUFDO1lBQ3hCLE9BQU87UUFDVCxDQUFDO1FBQ0QsSUFBSSxPQUFPLElBQUksS0FBSyxVQUFVLEVBQUUsQ0FBQztZQUMvQixNQUFNLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxhQUFhLFFBQVEsQ0FBQyxTQUFTLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztZQUMvRSxPQUFPO1FBQ1QsQ0FBQztRQUNELElBQUksT0FBTyxJQUFJLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDN0IsTUFBTSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNyQyxPQUFPO1FBQ1QsQ0FBQztRQUNELElBQUksSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ25CLE1BQU0sQ0FBQyxjQUFjLENBQUMsQ0FBQztZQUN2QixPQUFPO1FBQ1QsQ0FBQztRQUVELElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDZixJQUFJLENBQUM7WUFDSCxNQUFNLFdBQVcsR0FBRyxNQUFNLENBQUMseUJBQXlCLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0QsSUFBSSxLQUFLLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7Z0JBQ3hCLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQztnQkFDWixLQUFLLElBQUksS0FBSyxHQUFHLENBQUMsRUFBRSxLQUFLLEdBQUcsSUFBSSxDQUFDLE1BQU0sSUFBSSxPQUFPLEVBQUUsS0FBSyxJQUFJLENBQUMsRUFBRSxDQUFDO29CQUMvRCxJQUFJLEtBQUssR0FBRyxDQUFDO3dCQUFFLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQztvQkFDM0IsTUFBTSxVQUFVLEdBQUcsV0FBVyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDO29CQUM5QyxJQUFJLFVBQVUsSUFBSSxPQUFPLElBQUksVUFBVTt3QkFBRSxJQUFJLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxDQUFDOzt3QkFDM0QsTUFBTSxDQUFDLHNCQUFzQixDQUFDLENBQUM7Z0JBQ3RDLENBQUM7Z0JBQ0QsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDO2dCQUNaLE9BQU87WUFDVCxDQUFDO1lBRUQsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1lBQ1osSUFBSSxLQUFLLEdBQUcsSUFBSSxDQUFDO1lBQ2pCLEtBQUssTUFBTSxHQUFHLElBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDO2dCQUNsRCxNQUFNLFVBQVUsR0FBRyxXQUFXLENBQUMsR0FBRyxDQUFDLENBQUM7Z0JBQ3BDLElBQUksQ0FBQyxVQUFVLENBQUMsVUFBVTtvQkFBRSxTQUFTO2dCQUNyQyxJQUFJLENBQUMsS0FBSztvQkFBRSxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUM7Z0JBQ3hCLEtBQUssR0FBRyxLQUFLLENBQUM7Z0JBQ2QsTUFBTSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztnQkFDNUIsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDO2dCQUNaLElBQUksT0FBTyxJQUFJLFVBQVU7b0JBQUUsSUFBSSxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsQ0FBQzs7b0JBQzdDLE1BQU0sQ0FBQyxjQUFjLENBQUMsQ0FBQztnQkFDNUIsSUFBSSxDQUFDLE9BQU87b0JBQUUsTUFBTTtZQUN0QixDQUFDO1lBQ0QsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ2QsQ0FBQztnQkFBUyxDQUFDO1lBQ1QsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNwQixDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBRUYsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ1osSUFBSSxDQUFDLE9BQU87UUFBRSxPQUFPLFNBQVMsQ0FBQztJQUMvQixNQUFNLFdBQVcsR0FBRyxVQUFVLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztJQUNuRCxPQUFPLElBQUEseUNBQXVCLEVBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDO0FBQ3hFLENBQUMifQ==

package/dist/RecordHttpConcurrency.d.ts

@@ -0,0 +1,60 @@
+import { type RecordConcurrencyMetadata, type RecordSaveResult } from '@researchdatabox/sails-ng-common';
+import type { RecordConcurrencyContext } from './RecordSaveResponse';
+export declare const RECORD_HTTP_HEADERS: Readonly<{
+    ifMatch: "If-Match";
+    entityTag: "ETag";
+    formFingerprint: "X-ReDBox-Form-Fingerprint";
+    resolution: "X-ReDBox-Concurrency-Resolution";
+    resolutionOfRequestId: "X-ReDBox-Resolution-Of-Request-Id";
+    saveRequestId: "X-ReDBox-Save-Request-Id";
+}>;
+export type PublicRecordConcurrencyRequestErrorCode = 'record-if-match-invalid' | 'record-form-fingerprint-invalid' | 'record-concurrency-resolution-invalid' | 'record-concurrency-request-linkage-invalid';
+export type PublicRecordConcurrencyRequestResult = {
+    readonly valid: true;
+    readonly context: RecordConcurrencyContext;
+} | {
+    readonly valid: false;
+    readonly code: PublicRecordConcurrencyRequestErrorCode;
+    readonly header: string;
+};
+export interface PublicRecordConcurrencyRequestOptions {
+    /** Only generated browser-form submissions bind to a form definition. */
+    readonly formBacked?: boolean;
+}
+/**
+ * Normalize public optimistic-concurrency headers once at the HTTP boundary.
+ * Staleness and policy remain RecordsService/storage decisions; malformed
+ * request contracts are rejected before candidate work begins.
+ */
+export declare function parsePublicRecordConcurrencyRequest(headers: Readonly<Record<string, unknown>> | undefined, recordOid: string | undefined, options?: PublicRecordConcurrencyRequestOptions): PublicRecordConcurrencyRequestResult;
+export declare function recordConcurrencyRequestFailureResponse(apiVersion: string, failure: {
+    readonly code: string;
+    readonly header: string;
+}): Record<string, unknown>;
+export interface RecordRepresentationConcurrency {
+    readonly headers: Readonly<Record<string, string>>;
+    readonly metadata: RecordConcurrencyMetadata;
+}
+/**
+ * Revision of one stored active or tombstone representation. A record written
+ * before the revision migration reads as the initial revision; anything else
+ * non-conforming is a storage fault rather than a value to guess at.
+ */
+export declare function recordRepresentationRevision(record: unknown): number;
+/**
+ * Build read-side revision metadata and the `ETag` header from server-owned
+ * record fields only. Collection rows carry the numeric revision alone: a row
+ * is not an individual representation, so it gets no entity tag.
+ */
+export declare function recordRepresentationConcurrency(record: unknown): RecordRepresentationConcurrency;
+/** Emit only the authoritative entity tag carried by a typed save result. */
+export declare function recordSaveResultHeaders(result: Pick<RecordSaveResult, 'concurrency'> | null | undefined): Readonly<Record<string, string>>;
+/**
+ * Spreadable response fragment. The `headers` key is omitted entirely when a
+ * result carries no authoritative tag, so responses that never had one keep
+ * their existing shape.
+ */
+export declare function recordSaveResultHeaderOption(result: Pick<RecordSaveResult, 'concurrency'> | null | undefined): {
+    headers?: Readonly<Record<string, string>>;
+};
+//# sourceMappingURL=RecordHttpConcurrency.d.ts.map

package/dist/RecordHttpConcurrency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordHttpConcurrency.d.ts","sourceRoot":"","sources":["../src/RecordHttpConcurrency.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,yBAAyB,EAE9B,KAAK,gBAAgB,EACtB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAGrE,eAAO,MAAM,mBAAmB;;;;;;;EAO9B,CAAC;AAEH,MAAM,MAAM,uCAAuC,GAC/C,yBAAyB,GACzB,iCAAiC,GACjC,uCAAuC,GACvC,4CAA4C,CAAC;AAEjD,MAAM,MAAM,oCAAoC,GAC5C;IAAE,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,wBAAwB,CAAA;CAAE,GACpE;IACE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,uCAAuC,CAAC;IACvD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB,CAAC;AAEN,MAAM,WAAW,qCAAqC;IACpD,yEAAyE;IACzE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CAC/B;AAqCD;;;;GAIG;AACH,wBAAgB,mCAAmC,CACjD,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,EACtD,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,OAAO,GAAE,qCAA0C,GAClD,oCAAoC,CA2EtC;AAED,wBAAgB,uCAAuC,CACrD,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC1D,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAIzB;AAED,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAC;CAC9C;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAUpE;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,MAAM,EAAE,OAAO,GAAG,+BAA+B,CAWhG;AAED,6EAA6E;AAC7E,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,GAAG,IAAI,GAAG,SAAS,GAC/D,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAGlC;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG;IAC9G,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC5C,CAGA"}