@researchdatabox/sails-hook-redbox-storage-mongo 1.5.2 → 5.0.0-RC1

package/dist/services/MongoStorageService.d.ts

@@ -0,0 +1,83 @@
+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, BrandingModel, UserModel, RoleModel, RecordRelationshipExpandOptions, RecordRelationshipGraph } from '@researchdatabox/redbox-core';
+type JsonMap = Record<string, unknown>;
+type StorageRecord = RecordModel;
+type MongoRecordDocument = Document;
+type DatastreamContent = {
+    readstream?: NodeJS.ReadableStream;
+    body?: Buffer | string;
+} & Record<string, unknown>;
+export declare namespace Services {
+    class MongoStorageService extends services.Core.Service implements StorageService, DatastreamService {
+        gridFsBucket: mongodb.GridFSBucket;
+        db: Db;
+        recordCol: Collection<MongoRecordDocument>;
+        deletedRecordCol: Collection<MongoRecordDocument>;
+        private _readyHookRegistered;
+        protected _exportedMethods: string[];
+        constructor();
+        private getUuid;
+        private getErrorMessage;
+        init(): void;
+        private registerReadyHook;
+        private collectionExists;
+        private performInit;
+        private createIndices;
+        create(_brand: BrandingModel, record: JsonMap, _recordType: unknown, _user?: unknown): Promise<StorageServiceResponse>;
+        updateMeta(brand: BrandingModel, oid: string, record: JsonMap, user?: UserModel): Promise<StorageServiceResponse>;
+        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;
+        getRelatedRecords(oid: string, brand: BrandingModel, options?: RecordRelationshipExpandOptions): Promise<RecordRelationshipGraph>;
+        private walkRelatedRecords;
+        private addRelatedObject;
+        private extractRelationshipLocalValues;
+        private buildRelationshipCriteria;
+        private findRelatedRecords;
+        private buildRelationshipEdge;
+        delete(oid: string, permanentlyDelete?: boolean): Promise<StorageServiceResponse>;
+        updateNotificationLog(oid: string, record: JsonMap, options: JsonMap): Promise<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>[];
+            totalItems: number;
+        }>;
+        protected runDeletedRecordQuery(colName: any, query: any, options: any): Promise<{
+            items: mongodb.WithId<mongodb.BSON.Document>[];
+            totalItems: number;
+        }>;
+        private fetchAllRecords;
+        exportAllPlans(username: any, roles: any, brand: any, format: any, modBefore: any, modAfter: any, recType: any): stream.Readable;
+        private collectCsvFields;
+        protected getRoleNames(roles: any, brand: any): any[];
+        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>;
+        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>;
+        getDatastream(oid: string, fileId: string): Promise<DatastreamContent>;
+        private getDatastreamAsync;
+        listDatastreams(oid: string, fileId?: string | null): Promise<Record<string, unknown>[]>;
+        private toJsonSafe;
+        private sanitizeRecordAudit;
+        private sanitizeIntegrationAudit;
+        createRecordAudit(recordAudit: RecordAuditModel): Promise<StorageServiceResponse>;
+        getRecordAudit(params: RecordAuditParams): Promise<unknown>;
+        createIntegrationAudit(audit: IntegrationAuditModel): Promise<StorageServiceResponse>;
+        private buildIntegrationAuditStartedAtCriteria;
+        getIntegrationAudit(params: IntegrationAuditParams): Promise<unknown>;
+        countIntegrationAudit(params: IntegrationAuditParams): Promise<number>;
+        restoreRecord(oid: string): Promise<StorageServiceResponse>;
+        destroyDeletedRecord(oid: string): Promise<StorageServiceResponse>;
+        protected getFileWithName(fileName: string, options?: FindOptions): FindCursor<GridFSFile>;
+        exists(oid: string): Promise<boolean>;
+    }
+}
+export {};