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

package/dist/services/MongoStorageService.d.ts

@@ -2,8 +2,7 @@ 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, StorageMutationResponse, DatastreamServiceResponse, Datastream, RecordAuditModel, RecordAuditParams, IntegrationAuditModel, IntegrationAuditParams, RecordModel, type DeletedRecordModel, 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';
+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';
 type JsonMap = Record<string, unknown>;
 type StorageRecord = RecordModel;
 type MongoRecordDocument = Document;
@@ -11,188 +10,36 @@ 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;
-        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>;
+        init(): void;
         private registerReadyHook;
         private collectionExists;
         private performInit;
         private createIndices;
-        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[]>;
+        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>;
+        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>;
+        readyFigshareIntent(oid: string, saveToken: string): Promise<boolean>;
+        pendingFigshareIntents(limit: number, afterOid?: string): Promise<RecordModel[]>;
+        abandonFigshareIntent(oid: string, saveToken: string): Promise<boolean>;
+        recoverStaleFigshareIntents(staleBefore: string): Promise<number>;
+        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<StorageMutationResponse>;
-        provideUserAccessAndRemovePendingAccess(oid: string, _userid: unknown, _pendingValue: unknown): Promise<StorageMutationResponse>;
+        createBatch(type: string, data: JsonMap[], harvestIdFldName: string): Promise<unknown>;
+        provideUserAccessAndRemovePendingAccess(oid: any, userid: any, pendingValue: any): void;
         getRelatedRecords(oid: string, brand: BrandingModel, options?: RecordRelationshipExpandOptions): Promise<RecordRelationshipGraph>;
         private walkRelatedRecords;
         private addRelatedObject;
@@ -200,12 +47,12 @@ export declare namespace Services {
         private buildRelationshipCriteria;
         private findRelatedRecords;
         private buildRelationshipEdge;
-        delete(oid: string, _permanentlyDelete?: boolean, options?: RecordStorageMutationOptions): Promise<StorageServiceResponse>;
+        delete(oid: string, permanentlyDelete?: boolean): 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<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>>;
+        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>;
         private escapeRegExp;
         protected runRecordQuery(colName: any, query: any, options: any): Promise<{
             items: mongodb.WithId<mongodb.BSON.Document>[];
@@ -222,7 +69,6 @@ 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>;
@@ -230,7 +76,6 @@ 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>;
@@ -239,8 +84,8 @@ export declare namespace Services {
         private buildIntegrationAuditStartedAtCriteria;
         getIntegrationAudit(params: IntegrationAuditParams): Promise<unknown>;
         countIntegrationAudit(params: IntegrationAuditParams): Promise<number>;
-        restoreRecord(oid: string, options?: RecordStorageMutationOptions): Promise<StorageServiceResponse>;
-        destroyDeletedRecord(oid: string, options?: RecordStorageMutationOptions): Promise<StorageServiceResponse>;
+        restoreRecord(oid: string): Promise<StorageServiceResponse>;
+        destroyDeletedRecord(oid: string): Promise<StorageServiceResponse>;
         protected getFileWithName(fileName: string, options?: FindOptions): FindCursor<GridFSFile>;
         exists(oid: string): Promise<boolean>;
     }