@researchdatabox/sails-hook-redbox-storage-mongo 5.0.4 → 5.1.0-beta.12568

package/dist/models/RecordSchemaArtifact.d.ts

@@ -0,0 +1,14 @@
+import 'reflect-metadata';
+import type { ContractJsonObject, RecordContractCompleteness, RecordContractFormat } from '@researchdatabox/redbox-core';
+export declare const RECORD_SCHEMA_DIGEST_PATTERN: RegExp;
+export declare class RecordSchemaArtifactClass {
+    digest: string;
+    document: ContractJsonObject;
+    contractFormat: RecordContractFormat;
+    completeness: RecordContractCompleteness;
+    byteLength: number;
+    createdAt: string;
+    updatedAt: string;
+    lastAccessedAt?: string;
+}
+export declare const RecordSchemaArtifactWLDef: import("@researchdatabox/redbox-core").WaterlineModelDefinition;

package/dist/models/RecordSchemaArtifact.js

@@ -0,0 +1,75 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecordSchemaArtifactWLDef = exports.RecordSchemaArtifactClass = exports.RECORD_SCHEMA_DIGEST_PATTERN = void 0;
+require("reflect-metadata");
+const redbox_core_1 = require("@researchdatabox/redbox-core");
+exports.RECORD_SCHEMA_DIGEST_PATTERN = /^[a-f0-9]{64}$/;
+let RecordSchemaArtifactClass = class RecordSchemaArtifactClass {
+    digest;
+    document;
+    contractFormat;
+    completeness;
+    byteLength;
+    createdAt;
+    updatedAt;
+    lastAccessedAt;
+};
+exports.RecordSchemaArtifactClass = RecordSchemaArtifactClass;
+__decorate([
+    (0, redbox_core_1.Attr)({
+        type: 'string',
+        required: true,
+        unique: true,
+        validations: { regex: exports.RECORD_SCHEMA_DIGEST_PATTERN },
+    }),
+    __metadata("design:type", String)
+], RecordSchemaArtifactClass.prototype, "digest", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'json', required: true }),
+    __metadata("design:type", Object)
+], RecordSchemaArtifactClass.prototype, "document", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({
+        type: 'string',
+        required: true,
+        isIn: [redbox_core_1.RECORD_CONTRACT_FORMAT_V1],
+    }),
+    __metadata("design:type", String)
+], RecordSchemaArtifactClass.prototype, "contractFormat", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', required: true, isIn: ['complete', 'partial'] }),
+    __metadata("design:type", String)
+], RecordSchemaArtifactClass.prototype, "completeness", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'number', required: true, min: 1 }),
+    __metadata("design:type", Number)
+], RecordSchemaArtifactClass.prototype, "byteLength", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', columnType: 'datetime', autoCreatedAt: true }),
+    __metadata("design:type", String)
+], RecordSchemaArtifactClass.prototype, "createdAt", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', columnType: 'datetime', autoUpdatedAt: true }),
+    __metadata("design:type", String)
+], RecordSchemaArtifactClass.prototype, "updatedAt", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', columnType: 'datetime' }),
+    __metadata("design:type", String)
+], RecordSchemaArtifactClass.prototype, "lastAccessedAt", void 0);
+exports.RecordSchemaArtifactClass = RecordSchemaArtifactClass = __decorate([
+    (0, redbox_core_1.Entity)('recordschemaartifact', {
+        datastore: 'redboxStorage',
+        indexes: [{ attributes: { digest: 1 }, unique: true }],
+    })
+], RecordSchemaArtifactClass);
+exports.RecordSchemaArtifactWLDef = (0, redbox_core_1.toWaterlineModelDef)(RecordSchemaArtifactClass);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVjb3JkU2NoZW1hQXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbW9kZWxzL1JlY29yZFNjaGVtYUFydGlmYWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7OztBQUFBLDRCQUEwQjtBQUUxQiw4REFBNEc7QUFPL0YsUUFBQSw0QkFBNEIsR0FBRyxnQkFBZ0IsQ0FBQztBQU10RCxJQUFNLHlCQUF5QixHQUEvQixNQUFNLHlCQUF5QjtJQU83QixNQUFNLENBQVU7SUFHaEIsUUFBUSxDQUFzQjtJQU85QixjQUFjLENBQXdCO0lBR3RDLFlBQVksQ0FBOEI7SUFHMUMsVUFBVSxDQUFVO0lBR3BCLFNBQVMsQ0FBVTtJQUduQixTQUFTLENBQVU7SUFHbkIsY0FBYyxDQUFVO0NBQ2hDLENBQUE7QUFqQ1ksOERBQXlCO0FBTzdCO0lBTk4sSUFBQSxrQkFBSSxFQUFDO1FBQ0osSUFBSSxFQUFFLFFBQVE7UUFDZCxRQUFRLEVBQUUsSUFBSTtRQUNkLE1BQU0sRUFBRSxJQUFJO1FBQ1osV0FBVyxFQUFFLEVBQUUsS0FBSyxFQUFFLG9DQUE0QixFQUFFO0tBQ3JELENBQUM7O3lEQUNxQjtBQUdoQjtJQUROLElBQUEsa0JBQUksRUFBQyxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsUUFBUSxFQUFFLElBQUksRUFBRSxDQUFDOzsyREFDRjtBQU85QjtJQUxOLElBQUEsa0JBQUksRUFBQztRQUNKLElBQUksRUFBRSxRQUFRO1FBQ2QsUUFBUSxFQUFFLElBQUk7UUFDZCxJQUFJLEVBQUUsQ0FBQyx1Q0FBeUIsQ0FBQztLQUNsQyxDQUFDOztpRUFDMkM7QUFHdEM7SUFETixJQUFBLGtCQUFJLEVBQUMsRUFBRSxJQUFJLEVBQUUsUUFBUSxFQUFFLFFBQVEsRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFFLENBQUMsVUFBVSxFQUFFLFNBQVMsQ0FBQyxFQUFFLENBQUM7OytEQUN2QjtBQUcxQztJQUROLElBQUEsa0JBQUksRUFBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsUUFBUSxFQUFFLElBQUksRUFBRSxHQUFHLEVBQUUsQ0FBQyxFQUFFLENBQUM7OzZEQUN0QjtBQUdwQjtJQUROLElBQUEsa0JBQUksRUFBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsVUFBVSxFQUFFLFVBQVUsRUFBRSxhQUFhLEVBQUUsSUFBSSxFQUFFLENBQUM7OzREQUM1QztBQUduQjtJQUROLElBQUEsa0JBQUksRUFBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsVUFBVSxFQUFFLFVBQVUsRUFBRSxhQUFhLEVBQUUsSUFBSSxFQUFFLENBQUM7OzREQUM1QztBQUduQjtJQUROLElBQUEsa0JBQUksRUFBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsVUFBVSxFQUFFLFVBQVUsRUFBRSxDQUFDOztpRUFDbEI7b0NBaENwQix5QkFBeUI7SUFKckMsSUFBQSxvQkFBTSxFQUFDLHNCQUFzQixFQUFFO1FBQzlCLFNBQVMsRUFBRSxlQUFlO1FBQzFCLE9BQU8sRUFBRSxDQUFDLEVBQUUsVUFBVSxFQUFFLEVBQUUsTUFBTSxFQUFFLENBQUMsRUFBRSxFQUFFLE1BQU0sRUFBRSxJQUFJLEVBQUUsQ0FBQztLQUN2RCxDQUFDO0dBQ1cseUJBQXlCLENBaUNyQztBQUVZLFFBQUEseUJBQXlCLEdBQUcsSUFBQSxpQ0FBbUIsRUFBQyx5QkFBeUIsQ0FBQyxDQUFDIn0=

package/dist/models/RecordSchemaReference.d.ts

@@ -0,0 +1,25 @@
+import 'reflect-metadata';
+import type { RecordContractSchemaKind } from '@researchdatabox/redbox-core';
+export declare const RECORD_SCHEMA_REFERENCE_KEY_PATTERN: RegExp;
+export declare class RecordSchemaReferenceClass {
+    referenceKey: string;
+    digest: string;
+    kind: 'grant' | 'save' | 'pin';
+    brand: string;
+    portal: string;
+    schemaKind: RecordContractSchemaKind;
+    recordType: string;
+    oid?: string;
+    operation: string;
+    owner?: string;
+    purpose?: string;
+    expiresAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Runtime persistence enforces the discriminated rules that Waterline cannot:
+ * create grants have no OID, update grants and saves require one, and only pins
+ * may carry owner, purpose, or expiry fields.
+ */
+export declare const RecordSchemaReferenceWLDef: import("@researchdatabox/redbox-core").WaterlineModelDefinition;

package/dist/models/RecordSchemaReference.js

@@ -0,0 +1,128 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecordSchemaReferenceWLDef = exports.RecordSchemaReferenceClass = exports.RECORD_SCHEMA_REFERENCE_KEY_PATTERN = void 0;
+require("reflect-metadata");
+const redbox_core_1 = require("@researchdatabox/redbox-core");
+const RecordSchemaArtifact_1 = require("./RecordSchemaArtifact");
+exports.RECORD_SCHEMA_REFERENCE_KEY_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._:-]{0,511}$/;
+let RecordSchemaReferenceClass = class RecordSchemaReferenceClass {
+    referenceKey;
+    digest;
+    kind;
+    brand;
+    portal;
+    schemaKind;
+    recordType;
+    oid;
+    operation;
+    owner;
+    purpose;
+    expiresAt;
+    createdAt;
+    updatedAt;
+};
+exports.RecordSchemaReferenceClass = RecordSchemaReferenceClass;
+__decorate([
+    (0, redbox_core_1.Attr)({
+        type: 'string',
+        required: true,
+        unique: true,
+        validations: { regex: exports.RECORD_SCHEMA_REFERENCE_KEY_PATTERN },
+    }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "referenceKey", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({
+        type: 'string',
+        required: true,
+        validations: { regex: RecordSchemaArtifact_1.RECORD_SCHEMA_DIGEST_PATTERN },
+    }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "digest", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', required: true, isIn: ['grant', 'save', 'pin'] }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "kind", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', required: true, validations: { maxLength: 512 } }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "brand", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', required: true, validations: { maxLength: 512 } }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "portal", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', required: true, isIn: ['create', 'update'] }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "schemaKind", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', required: true, validations: { maxLength: 512 } }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "recordType", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', validations: { maxLength: 512 } }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "oid", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', required: true, validations: { maxLength: 512 } }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "operation", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', validations: { maxLength: 512 } }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "owner", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', validations: { maxLength: 2_048 } }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "purpose", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', columnType: 'datetime' }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "expiresAt", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', columnType: 'datetime', autoCreatedAt: true }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "createdAt", void 0);
+__decorate([
+    (0, redbox_core_1.Attr)({ type: 'string', columnType: 'datetime', autoUpdatedAt: true }),
+    __metadata("design:type", String)
+], RecordSchemaReferenceClass.prototype, "updatedAt", void 0);
+exports.RecordSchemaReferenceClass = RecordSchemaReferenceClass = __decorate([
+    (0, redbox_core_1.Entity)('recordschemareference', {
+        datastore: 'redboxStorage',
+        indexes: [
+            { attributes: { referenceKey: 1 }, unique: true },
+            { attributes: { digest: 1, kind: 1 } },
+            {
+                attributes: {
+                    digest: 1,
+                    kind: 1,
+                    brand: 1,
+                    portal: 1,
+                    schemaKind: 1,
+                    recordType: 1,
+                    operation: 1,
+                    oid: 1,
+                },
+            },
+            { attributes: { oid: 1, kind: 1 } },
+            { attributes: { kind: 1, expiresAt: 1 } },
+        ],
+    })
+], RecordSchemaReferenceClass);
+/**
+ * Runtime persistence enforces the discriminated rules that Waterline cannot:
+ * create grants have no OID, update grants and saves require one, and only pins
+ * may carry owner, purpose, or expiry fields.
+ */
+exports.RecordSchemaReferenceWLDef = (0, redbox_core_1.toWaterlineModelDef)(RecordSchemaReferenceClass);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVjb3JkU2NoZW1hUmVmZXJlbmNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL21vZGVscy9SZWNvcmRTY2hlbWFSZWZlcmVuY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsNEJBQTBCO0FBRTFCLDhEQUFpRjtBQUVqRixpRUFBc0U7QUFFekQsUUFBQSxtQ0FBbUMsR0FBRyxxQ0FBcUMsQ0FBQztBQXVCbEYsSUFBTSwwQkFBMEIsR0FBaEMsTUFBTSwwQkFBMEI7SUFPOUIsWUFBWSxDQUFVO0lBT3RCLE1BQU0sQ0FBVTtJQUdoQixJQUFJLENBQTRCO0lBR2hDLEtBQUssQ0FBVTtJQUdmLE1BQU0sQ0FBVTtJQUdoQixVQUFVLENBQTRCO0lBR3RDLFVBQVUsQ0FBVTtJQUdwQixHQUFHLENBQVU7SUFHYixTQUFTLENBQVU7SUFHbkIsS0FBSyxDQUFVO0lBR2YsT0FBTyxDQUFVO0lBR2pCLFNBQVMsQ0FBVTtJQUduQixTQUFTLENBQVU7SUFHbkIsU0FBUyxDQUFVO0NBQzNCLENBQUE7QUFuRFksZ0VBQTBCO0FBTzlCO0lBTk4sSUFBQSxrQkFBSSxFQUFDO1FBQ0osSUFBSSxFQUFFLFFBQVE7UUFDZCxRQUFRLEVBQUUsSUFBSTtRQUNkLE1BQU0sRUFBRSxJQUFJO1FBQ1osV0FBVyxFQUFFLEVBQUUsS0FBSyxFQUFFLDJDQUFtQyxFQUFFO0tBQzVELENBQUM7O2dFQUMyQjtBQU90QjtJQUxOLElBQUEsa0JBQUksRUFBQztRQUNKLElBQUksRUFBRSxRQUFRO1FBQ2QsUUFBUSxFQUFFLElBQUk7UUFDZCxXQUFXLEVBQUUsRUFBRSxLQUFLLEVBQUUsbURBQTRCLEVBQUU7S0FDckQsQ0FBQzs7MERBQ3FCO0FBR2hCO0lBRE4sSUFBQSxrQkFBSSxFQUFDLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRSxRQUFRLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDLE9BQU8sRUFBRSxNQUFNLEVBQUUsS0FBSyxDQUFDLEVBQUUsQ0FBQzs7d0RBQ2xDO0FBR2hDO0lBRE4sSUFBQSxrQkFBSSxFQUFDLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRSxRQUFRLEVBQUUsSUFBSSxFQUFFLFdBQVcsRUFBRSxFQUFFLFNBQVMsRUFBRSxHQUFHLEVBQUUsRUFBRSxDQUFDOzt5REFDcEQ7QUFHZjtJQUROLElBQUEsa0JBQUksRUFBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsUUFBUSxFQUFFLElBQUksRUFBRSxXQUFXLEVBQUUsRUFBRSxTQUFTLEVBQUUsR0FBRyxFQUFFLEVBQUUsQ0FBQzs7MERBQ25EO0FBR2hCO0lBRE4sSUFBQSxrQkFBSSxFQUFDLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRSxRQUFRLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDLFFBQVEsRUFBRSxRQUFRLENBQUMsRUFBRSxDQUFDOzs4REFDeEI7QUFHdEM7SUFETixJQUFBLGtCQUFJLEVBQUMsRUFBRSxJQUFJLEVBQUUsUUFBUSxFQUFFLFFBQVEsRUFBRSxJQUFJLEVBQUUsV0FBVyxFQUFFLEVBQUUsU0FBUyxFQUFFLEdBQUcsRUFBRSxFQUFFLENBQUM7OzhEQUMvQztBQUdwQjtJQUROLElBQUEsa0JBQUksRUFBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsV0FBVyxFQUFFLEVBQUUsU0FBUyxFQUFFLEdBQUcsRUFBRSxFQUFFLENBQUM7O3VEQUN0QztBQUdiO0lBRE4sSUFBQSxrQkFBSSxFQUFDLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRSxRQUFRLEVBQUUsSUFBSSxFQUFFLFdBQVcsRUFBRSxFQUFFLFNBQVMsRUFBRSxHQUFHLEVBQUUsRUFBRSxDQUFDOzs2REFDaEQ7QUFHbkI7SUFETixJQUFBLGtCQUFJLEVBQUMsRUFBRSxJQUFJLEVBQUUsUUFBUSxFQUFFLFdBQVcsRUFBRSxFQUFFLFNBQVMsRUFBRSxHQUFHLEVBQUUsRUFBRSxDQUFDOzt5REFDcEM7QUFHZjtJQUROLElBQUEsa0JBQUksRUFBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsV0FBVyxFQUFFLEVBQUUsU0FBUyxFQUFFLEtBQUssRUFBRSxFQUFFLENBQUM7OzJEQUNwQztBQUdqQjtJQUROLElBQUEsa0JBQUksRUFBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsVUFBVSxFQUFFLFVBQVUsRUFBRSxDQUFDOzs2REFDdkI7QUFHbkI7SUFETixJQUFBLGtCQUFJLEVBQUMsRUFBRSxJQUFJLEVBQUUsUUFBUSxFQUFFLFVBQVUsRUFBRSxVQUFVLEVBQUUsYUFBYSxFQUFFLElBQUksRUFBRSxDQUFDOzs2REFDNUM7QUFHbkI7SUFETixJQUFBLGtCQUFJLEVBQUMsRUFBRSxJQUFJLEVBQUUsUUFBUSxFQUFFLFVBQVUsRUFBRSxVQUFVLEVBQUUsYUFBYSxFQUFFLElBQUksRUFBRSxDQUFDOzs2REFDNUM7cUNBbERmLDBCQUEwQjtJQXJCdEMsSUFBQSxvQkFBTSxFQUFDLHVCQUF1QixFQUFFO1FBQy9CLFNBQVMsRUFBRSxlQUFlO1FBQzFCLE9BQU8sRUFBRTtZQUNQLEVBQUUsVUFBVSxFQUFFLEVBQUUsWUFBWSxFQUFFLENBQUMsRUFBRSxFQUFFLE1BQU0sRUFBRSxJQUFJLEVBQUU7WUFDakQsRUFBRSxVQUFVLEVBQUUsRUFBRSxNQUFNLEVBQUUsQ0FBQyxFQUFFLElBQUksRUFBRSxDQUFDLEVBQUUsRUFBRTtZQUN0QztnQkFDRSxVQUFVLEVBQUU7b0JBQ1YsTUFBTSxFQUFFLENBQUM7b0JBQ1QsSUFBSSxFQUFFLENBQUM7b0JBQ1AsS0FBSyxFQUFFLENBQUM7b0JBQ1IsTUFBTSxFQUFFLENBQUM7b0JBQ1QsVUFBVSxFQUFFLENBQUM7b0JBQ2IsVUFBVSxFQUFFLENBQUM7b0JBQ2IsU0FBUyxFQUFFLENBQUM7b0JBQ1osR0FBRyxFQUFFLENBQUM7aUJBQ1A7YUFDRjtZQUNELEVBQUUsVUFBVSxFQUFFLEVBQUUsR0FBRyxFQUFFLENBQUMsRUFBRSxJQUFJLEVBQUUsQ0FBQyxFQUFFLEVBQUU7WUFDbkMsRUFBRSxVQUFVLEVBQUUsRUFBRSxJQUFJLEVBQUUsQ0FBQyxFQUFFLFNBQVMsRUFBRSxDQUFDLEVBQUUsRUFBRTtTQUMxQztLQUNGLENBQUM7R0FDVywwQkFBMEIsQ0FtRHRDO0FBRUQ7Ozs7R0FJRztBQUNVLFFBQUEsMEJBQTBCLEdBQUcsSUFBQSxpQ0FBbUIsRUFBQywwQkFBMEIsQ0FBQyxDQUFDIn0=

package/dist/models/index.d.ts

@@ -2,9 +2,13 @@ export * from './Record';
 export * from './DeletedRecord';
 export * from './RecordAudit';
 export * from './IntegrationAudit';
+export * from './RecordSchemaArtifact';
+export * from './RecordSchemaReference';
 export declare const MongoModels: {
     Record: import("@researchdatabox/redbox-core").WaterlineModelDefinition;
     DeletedRecord: import("@researchdatabox/redbox-core").WaterlineModelDefinition;
     RecordAudit: import("@researchdatabox/redbox-core").WaterlineModelDefinition;
     IntegrationAudit: import("@researchdatabox/redbox-core").WaterlineModelDefinition;
+    RecordSchemaArtifact: import("@researchdatabox/redbox-core").WaterlineModelDefinition;
+    RecordSchemaReference: import("@researchdatabox/redbox-core").WaterlineModelDefinition;
 };

package/dist/models/index.js

@@ -19,14 +19,20 @@ const Record_1 = require("./Record");
 const DeletedRecord_1 = require("./DeletedRecord");
 const RecordAudit_1 = require("./RecordAudit");
 const IntegrationAudit_1 = require("./IntegrationAudit");
+const RecordSchemaArtifact_1 = require("./RecordSchemaArtifact");
+const RecordSchemaReference_1 = require("./RecordSchemaReference");
 __exportStar(require("./Record"), exports);
 __exportStar(require("./DeletedRecord"), exports);
 __exportStar(require("./RecordAudit"), exports);
 __exportStar(require("./IntegrationAudit"), exports);
+__exportStar(require("./RecordSchemaArtifact"), exports);
+__exportStar(require("./RecordSchemaReference"), exports);
 exports.MongoModels = {
     Record: Record_1.RecordWLDef,
     DeletedRecord: DeletedRecord_1.DeletedRecordWLDef,
     RecordAudit: RecordAudit_1.RecordAuditWLDef,
     IntegrationAudit: IntegrationAudit_1.IntegrationAuditWLDef,
+    RecordSchemaArtifact: RecordSchemaArtifact_1.RecordSchemaArtifactWLDef,
+    RecordSchemaReference: RecordSchemaReference_1.RecordSchemaReferenceWLDef,
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbW9kZWxzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUEscUNBQXVDO0FBQ3ZDLG1EQUFxRDtBQUNyRCwrQ0FBaUQ7QUFDakQseURBQTJEO0FBRTNELDJDQUF5QjtBQUN6QixrREFBZ0M7QUFDaEMsZ0RBQThCO0FBQzlCLHFEQUFtQztBQUV0QixRQUFBLFdBQVcsR0FBRztJQUN6QixNQUFNLEVBQUUsb0JBQVc7SUFDbkIsYUFBYSxFQUFFLGtDQUFrQjtJQUNqQyxXQUFXLEVBQUUsOEJBQWdCO0lBQzdCLGdCQUFnQixFQUFFLHdDQUFxQjtDQUN4QyxDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbW9kZWxzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUEscUNBQXVDO0FBQ3ZDLG1EQUFxRDtBQUNyRCwrQ0FBaUQ7QUFDakQseURBQTJEO0FBQzNELGlFQUFtRTtBQUNuRSxtRUFBcUU7QUFFckUsMkNBQXlCO0FBQ3pCLGtEQUFnQztBQUNoQyxnREFBOEI7QUFDOUIscURBQW1DO0FBQ25DLHlEQUF1QztBQUN2QywwREFBd0M7QUFFM0IsUUFBQSxXQUFXLEdBQUc7SUFDekIsTUFBTSxFQUFFLG9CQUFXO0lBQ25CLGFBQWEsRUFBRSxrQ0FBa0I7SUFDakMsV0FBVyxFQUFFLDhCQUFnQjtJQUM3QixnQkFBZ0IsRUFBRSx3Q0FBcUI7SUFDdkMsb0JBQW9CLEVBQUUsZ0RBQXlCO0lBQy9DLHFCQUFxQixFQUFFLGtEQUEwQjtDQUNsRCxDQUFDIn0=

package/dist/services/MongoStorageService.d.ts

@@ -2,7 +2,8 @@ import { Observable } from 'rxjs';
 import mongodb = require('mongodb');
 import type { Collection, Db, Document, FindCursor, FindOptions, GridFSFile } from 'mongodb';
 import stream = require('node:stream');
-import { Services as services, StorageManagerService as StorageManagerServiceTypes, DatastreamService, StorageService, StorageServiceResponse, DatastreamServiceResponse, Datastream, RecordAuditModel, RecordAuditParams, IntegrationAuditModel, IntegrationAuditParams, RecordModel, RecordWriteOptions, RecordFieldWriteResult, BrandingModel, UserModel, RoleModel, RecordRelationshipExpandOptions, RecordRelationshipGraph } from '@researchdatabox/redbox-core';
+import { Services as services, StorageManagerService as StorageManagerServiceTypes, DatastreamService, StorageService, StorageServiceResponse, StorageMutationResponse, DatastreamServiceResponse, Datastream, RecordAuditModel, RecordAuditParams, IntegrationAuditModel, IntegrationAuditParams, RecordModel, type DeletedRecordModel, type RecordFieldWriteResult, BrandingModel, UserModel, RoleModel, RecordRelationshipExpandOptions, RecordRelationshipGraph, type RecordStorageMutationOptions, type StorageServiceCapabilities } from '@researchdatabox/redbox-core';
+import type { RecordSchemaArtifactInput, RecordSchemaArtifactModel, RecordSchemaArtifactQuery, RecordSchemaArtifactSummary, RecordSchemaAuthorizationGrantQuery, RecordSchemaReferenceInput, RecordSchemaReferenceModel, RecordSchemaReferenceQuery } from '@researchdatabox/redbox-core';
 type JsonMap = Record<string, unknown>;
 type StorageRecord = RecordModel;
 type MongoRecordDocument = Document;
@@ -10,24 +11,184 @@ type DatastreamContent = {
     readstream?: NodeJS.ReadableStream;
     body?: Buffer | string;
 } & Record<string, unknown>;
+export declare const RECORD_SCHEMA_ARTIFACT_INDEXES: mongodb.IndexDescription[];
+export declare const RECORD_SCHEMA_AUTHORIZATION_CURSOR_INDEX_NAME = "record_schema_reference_authorization_cursor_lookup";
+export declare const RECORD_SCHEMA_AUTHORIZATION_CURSOR_INDEX_KEY: {
+    readonly digest: 1;
+    readonly kind: 1;
+    readonly brand: 1;
+    readonly portal: 1;
+    readonly schemaKind: 1;
+    readonly recordType: 1;
+    readonly operation: 1;
+    readonly referenceKey: 1;
+};
+export declare const RECORD_SCHEMA_REFERENCE_INDEXES: mongodb.IndexDescription[];
+/**
+ * Authorization lookups fail as unavailable instead of consuming an
+ * unbounded database work budget. This is a time/availability boundary, not
+ * a result cap: a query that cannot complete is never reported as a denial.
+ */
+export declare const RECORD_SCHEMA_AUTHORIZATION_LOOKUP_MAX_TIME_MS = 1000;
 export declare namespace Services {
     class MongoStorageService extends services.Core.Service implements StorageService, DatastreamService {
         gridFsBucket: mongodb.GridFSBucket;
         db: Db;
         recordCol: Collection<MongoRecordDocument>;
         deletedRecordCol: Collection<MongoRecordDocument>;
+        recordIdentityCol: Collection<MongoRecordDocument>;
+        recordSchemaArtifactCol: Collection<MongoRecordDocument>;
+        recordSchemaReferenceCol: Collection<MongoRecordDocument>;
         private _readyHookRegistered;
+        private _requiredIndicesReady;
+        private _initializationPromise?;
         protected _exportedMethods: string[];
         constructor();
         private getUuid;
         private getErrorMessage;
-        init(): void;
+        private classifyStorageInitializationError;
+        /**
+         * Resolve the native driver collection behind a Waterline model. Strict
+         * concurrency needs `findOneAndUpdate`/`findOneAndDelete` facts that
+         * Waterline cannot certify, so the compare-and-set paths talk to the
+         * driver directly. Discovery never throws: an adapter that cannot supply a
+         * native collection is simply unsupported.
+         */
+        private getNativeCollection;
+        private getNativeRecordCollection;
+        private getNativeTombstoneCollection;
+        private getNativeRecordIdentityCollection;
+        private supportsAtomicMutation;
+        getCapabilities(): StorageServiceCapabilities;
+        private createMutationResponse;
+        private notApplied;
+        private unknownMutation;
+        /**
+         * Normalize the caller's precondition. Returning `null` means the response
+         * already carries a certified non-application: a malformed precondition is
+         * a caller defect, and answering it with a definite no-write is safer than
+         * guessing which revision was meant.
+         */
+        private expectedRevision;
+        /**
+         * The lazy compatibility clause matches only a genuinely absent revision.
+         * An explicit null is corrupt state: `$inc` cannot advance it and must not
+         * be made to look like a safe first revision.
+         */
+        private revisionSelector;
+        private mutationSelector;
+        private lifecycleMutationSelector;
+        private isDuplicateKeyError;
+        /**
+         * Whether the driver fact proves that `insertOne` did not commit. Local
+         * argument rejection and a server command error without retry/write-
+         * concern ambiguity are definitive. Network, selection, timeout, and
+         * write-concern failures retain the reservation for later reconciliation.
+         */
+        private isCertifiedCreateNonApplication;
+        private storedIncarnationId;
+        /**
+         * Establish the permanent OID owner for a state that already exists. The
+         * ledger outlives active records and tombstones, so purge cannot reopen a
+         * revision-zero alias. Duplicate insertion is an ordinary concurrent
+         * winner; its durable identity is re-read and adopted.
+         */
+        private ensureRecordIdentity;
+        /** Claim a never-before-used OID. Any durable owner or active/tombstone state is a collision. */
+        private claimNewRecordIdentity;
+        /**
+         * Compensate an ownership claim this call made but never used.
+         *
+         * The ledger is otherwise permanent, and deliberately so: a purge must not
+         * let an old revision-zero tag alias a recreated incarnation. Releasing is
+         * only safe — and only necessary — for a row that still carries the
+         * incarnation this call minted and that no active record or tombstone
+         * refers to. That is exactly the state a create leaves behind when its
+         * insert never reached the collection, and without this the caller-selected
+         * OID would be permanently unusable with no operator recovery path. While
+         * this row exists its unique index prevents another ordinary create from
+         * becoming owner; the exact incarnation selector also cannot remove a row
+         * replaced during an operator recovery race.
+         */
+        private releaseUnusedRecordIdentity;
+        /**
+         * Interpret a `findOneAndUpdate`/`findOneAndDelete` result issued with
+         * `includeResultMetadata: false`: `null` is a certified no-match and a
+         * document is the committed state. Anything else is an unrecognized driver
+         * fact that must stay `unknown` rather than being certified either way.
+         */
+        private mutationDocument;
+        private committed;
+        private brandIdOf;
+        private activeIdentity;
+        private tombstoneIdentity;
+        private static readonly BRAND_ID_PATHS;
+        private storedBrandId;
+        /**
+         * Reject candidate keys the driver would read as update operators or
+         * dotted paths. Waterline rejected them before the compare-and-set paths
+         * started building `$set` documents directly, and honouring them would let
+         * a candidate reach fields — such as the stored brand — that the explicit
+         * checks above deliberately guard.
+         */
+        private unsafeCandidateField;
+        /**
+         * Read the current state behind a certified no-match so the caller can be
+         * told why nothing was written. Cross-brand state is never returned: the
+         * reason alone is bounded, and callers outside the brand map it onto the
+         * same not-found answer an absent record produces.
+         */
+        private readCurrentState;
+        private isRequestedBrand;
+        private classifyActiveNoMatch;
+        private classifyLifecycleTombstoneNoMatch;
+        init(): Promise<void>;
         private registerReadyHook;
         private collectionExists;
         private performInit;
         private createIndices;
-        create(_brand: BrandingModel, record: JsonMap, _recordType: unknown, _user?: unknown, options?: RecordWriteOptions): Promise<StorageServiceResponse>;
-        updateMeta(brand: BrandingModel, oid: string, record: JsonMap, user?: UserModel, options?: RecordWriteOptions): Promise<StorageServiceResponse>;
+        private createRecordSchemaIndices;
+        private createRequiredIndexes;
+        private recordSchemaSuccess;
+        private recordSchemaFailure;
+        private recordSchemaFailureFromError;
+        private throwRecordSchemaReadFailure;
+        private artifactCollection;
+        private referenceCollection;
+        private recordSchemaReferenceDocument;
+        private existingArtifactMatches;
+        putRecordSchemaArtifact(artifact: RecordSchemaArtifactInput): Promise<StorageServiceResponse>;
+        getRecordSchemaArtifact(digest: string): Promise<RecordSchemaArtifactModel | null>;
+        listRecordSchemaArtifacts(query: RecordSchemaArtifactQuery): Promise<RecordSchemaArtifactSummary[]>;
+        touchRecordSchemaArtifact(digest: string): Promise<StorageServiceResponse>;
+        private storeRecordSchemaReference;
+        putRecordSchemaReference(reference: RecordSchemaReferenceInput): Promise<StorageServiceResponse>;
+        private recordSchemaQueryString;
+        private recordSchemaQueryLimit;
+        findRecordSchemaGrantForAuthorization(query: RecordSchemaAuthorizationGrantQuery): Promise<RecordSchemaReferenceModel | null>;
+        listRecordSchemaReferences(query: RecordSchemaReferenceQuery): Promise<RecordSchemaReferenceModel[]>;
+        private storedRecordSchemaDate;
+        create(_brand: BrandingModel, record: JsonMap, _recordType: unknown, _user?: unknown, options?: RecordStorageMutationOptions): Promise<StorageMutationResponse>;
+        updateMeta(brand: BrandingModel | null | undefined, oid: string, record: JsonMap, user?: UserModel, options?: RecordStorageMutationOptions): Promise<StorageMutationResponse>;
+        /**
+         * Dispatch one atomic conditional mutation and turn its single driver fact
+         * into a mutation response.
+         *
+         * The three outcomes are deliberately distinct: a returned document is an
+         * applied commit, `null` certifies that the selector matched nothing and
+         * therefore that no write happened, and anything else — including a throw
+         * after dispatch — stays `unknown`. A failed follow-up classification only
+         * costs the precise reason; it never turns a certified no-match into a
+         * write, and it never issues one.
+         */
+        private commitConditionalMutation;
+        removeActiveRecord(brand: BrandingModel | null | undefined, oid: string, options?: RecordStorageMutationOptions): Promise<StorageMutationResponse>;
+        createTombstone(brand: BrandingModel | null | undefined, oid: string, record: JsonMap, options?: RecordStorageMutationOptions): Promise<StorageMutationResponse>;
+        updateTombstone(brand: BrandingModel | null | undefined, oid: string, record: JsonMap, options?: RecordStorageMutationOptions): Promise<StorageMutationResponse>;
+        removeTombstone(brand: BrandingModel | null | undefined, oid: string, options?: RecordStorageMutationOptions): Promise<StorageMutationResponse>;
+        createActiveRecordFromTombstone(brand: BrandingModel | null | undefined, oid: string, record: JsonMap, options?: RecordStorageMutationOptions): Promise<StorageMutationResponse>;
+        getTombstone(brand: BrandingModel | null | undefined, oid: string): Promise<DeletedRecordModel | null>;
+        getLifecycleTombstones(states: readonly string[], limit?: number): Promise<DeletedRecordModel[]>;
         scanFigshareRecords(afterOid: string, limit: number): Promise<RecordModel[]>;
         findFigshareArticleRecords(path: string, articleId: string): Promise<RecordModel[]>;
         setRecordFields(oid: string, fields: JsonMap, expectedVersion: number, allowedPaths: string[]): Promise<RecordFieldWriteResult>;
@@ -38,8 +199,8 @@ export declare namespace Services {
         acknowledgeFigshareIntent(oid: string, generation: number): Promise<boolean>;
         getMeta(oid: string): Promise<RecordModel>;
         getDeletedRecordMeta(oid: string): Promise<RecordModel | null>;
-        createBatch(type: string, data: JsonMap[], harvestIdFldName: string): Promise<unknown>;
-        provideUserAccessAndRemovePendingAccess(oid: any, userid: any, pendingValue: any): void;
+        createBatch(type: string, data: JsonMap[], harvestIdFldName: string): Promise<StorageMutationResponse>;
+        provideUserAccessAndRemovePendingAccess(oid: string, _userid: unknown, _pendingValue: unknown): Promise<StorageMutationResponse>;
         getRelatedRecords(oid: string, brand: BrandingModel, options?: RecordRelationshipExpandOptions): Promise<RecordRelationshipGraph>;
         private walkRelatedRecords;
         private addRelatedObject;
@@ -47,12 +208,12 @@ export declare namespace Services {
         private buildRelationshipCriteria;
         private findRelatedRecords;
         private buildRelationshipEdge;
-        delete(oid: string, permanentlyDelete?: boolean): Promise<StorageServiceResponse>;
+        delete(oid: string, _permanentlyDelete?: boolean, options?: RecordStorageMutationOptions): Promise<StorageServiceResponse>;
         updateNotificationLog(oid: string, record: JsonMap, options: JsonMap): Promise<unknown>;
         private getSortDirection;
         private getRecordSort;
-        getDeletedRecords(workflowState: string, recordType: any, start: number, rows: number, username: string, roles: RoleModel[], brand: BrandingModel, _editAccessOnly?: any, packageType?: any, sort?: any, filterFields?: any, filterString?: any, filterMode?: string, secondarySort?: any): Promise<StorageServiceResponse>;
-        getRecords(workflowState: string, recordType: string, start: number, rows: number, username: string, roles: RoleModel[], brand: BrandingModel, _editAccessOnly?: any, packageType?: any, sort?: any, filterFields?: any, filterString?: any, filterMode?: any, secondarySort?: any): Promise<StorageServiceResponse>;
+        getDeletedRecords(workflowState: string, recordType: any, start: number, rows: number, username: string, roles: RoleModel[], brand: BrandingModel, _editAccessOnly?: any, packageType?: any, sort?: any, filterFields?: any, filterString?: any, filterMode?: string, secondarySort?: any): Promise<StorageServiceResponse<unknown>>;
+        getRecords(workflowState: string, recordType: string, start: number, rows: number, username: string, roles: RoleModel[], brand: BrandingModel, _editAccessOnly?: any, packageType?: any, sort?: any, filterFields?: any, filterString?: any, filterMode?: any, secondarySort?: any): Promise<StorageServiceResponse<unknown>>;
         private escapeRegExp;
         protected runRecordQuery(colName: any, query: any, options: any): Promise<{
             items: mongodb.WithId<mongodb.BSON.Document>[];
@@ -69,6 +230,7 @@ export declare namespace Services {
         addDatastreams(oid: string, fileIds: Datastream[]): Promise<DatastreamServiceResponse>;
         updateDatastream(oid: string, record: StorageRecord, newMetadata: JsonMap, fileRoot: string | StorageManagerServiceTypes.Services.IDisk | null, fileIdsAdded: Datastream[]): Observable<Promise<unknown>[]>;
         removeDatastream(oid: any, datastream: Datastream): Promise<void>;
+        removeStagedDatastream(fileId: string): Promise<void>;
         addDatastream(oid: any, datastream: Datastream, stagingDisk?: StorageManagerServiceTypes.Services.IDisk): Promise<void>;
         private streamFileToBucket;
         addAndRemoveDatastreams(oid: any, addIds: Datastream[], removeIds: Datastream[], stagingDisk?: StorageManagerServiceTypes.Services.IDisk): Promise<void>;
@@ -76,6 +238,7 @@ export declare namespace Services {
         private getDatastreamAsync;
         listDatastreams(oid: string, fileId?: string | null): Promise<Record<string, unknown>[]>;
         private toJsonSafe;
+        private sanitizeRecordHookExecutionSummary;
         private sanitizeRecordAudit;
         private sanitizeIntegrationAudit;
         createRecordAudit(recordAudit: RecordAuditModel): Promise<StorageServiceResponse>;
@@ -84,8 +247,8 @@ export declare namespace Services {
         private buildIntegrationAuditStartedAtCriteria;
         getIntegrationAudit(params: IntegrationAuditParams): Promise<unknown>;
         countIntegrationAudit(params: IntegrationAuditParams): Promise<number>;
-        restoreRecord(oid: string): Promise<StorageServiceResponse>;
-        destroyDeletedRecord(oid: string): Promise<StorageServiceResponse>;
+        restoreRecord(oid: string, options?: RecordStorageMutationOptions): Promise<StorageServiceResponse>;
+        destroyDeletedRecord(oid: string, options?: RecordStorageMutationOptions): Promise<StorageServiceResponse>;
         protected getFileWithName(fileName: string, options?: FindOptions): FindCursor<GridFSFile>;
         exists(oid: string): Promise<boolean>;
     }