@researchdatabox/redbox-core 0.0.1-beta.8936 → 0.0.1-beta.9018

package/dist/services/FigshareService.d.ts

@@ -1,75 +1,45 @@
 import { Services as services } from '../CoreService';
-import { RecordModel } from '../model/storage/RecordModel';
-type AnyRecord = Record<string, unknown>;
-type RecordLike = RecordModel | AnyRecord;
+import { resolveFigsharePublishingConfig } from './figshare-v2/config';
+import { FigshareClient } from './figshare-v2/http';
+import { RecordModel, UserModel, FigshareArticle, FigsharePublicationPlan, FigsharePublishResult, FigshareSyncState, FigshareJob, AssetSyncResult } from './figshare-v2/types';
 export declare namespace Services {
     class FigshareService extends services.Core.Service {
-        private datastreamService;
-        private queueService;
         protected _exportedMethods: string[];
-        constructor();
-        init(): void;
-        private getRuntimeConfig;
-        private isFigshareAPIEnabled;
-        private getAxiosConfig;
-        private logWithLevel;
-        private logVerbose;
-        private getRetryConfig;
-        private shouldRetryRequest;
-        private redactAxiosConfig;
-        private describeAxiosError;
-        protected sleep(delayMs: number): Promise<void>;
-        private requestWithRetry;
-        private getValueFromObject;
-        private getValueFromRecord;
-        private setFieldInRecord;
-        private setStandardFieldInRequestBody;
-        private setCustomFieldInRequestBody;
-        private setFieldByNameInRequestBody;
-        private getAuthorUserIDs;
-        private getContributorsFromRecord;
-        private isRecordEmbargoed;
-        private isClearEmbargoNeeded;
-        private checkEmbargoDetailsChanged;
-        private findCategoryIDs;
-        private getFigPrivateLicenses;
-        private getArticleDetails;
-        private isArticleApprovedAndPublished;
-        private getArticleFileList;
-        private isFileUploadInProgress;
-        private checkArticleHasURLsOrFilesAttached;
-        private getArticleUpdateRequestBody;
-        private getArticleCreateRequestBody;
-        private getEmbargoRequestBody;
-        private getPublishRequestBody;
-        private sendDataPublicationToFigshare;
-        private validateEmbargoRequestBody;
-        private checkCreateFields;
-        private validateFieldInRequestBody;
-        private validateCreateRequestBody;
-        private checkRequestUpdateFields;
-        private validateUpdateRequestBody;
-        private isFileAttachmentInDataLocations;
-        private isURLAttachmentInDataLocations;
-        private countFileAttachmentsInDataLocations;
-        private checkUploadFilesPending;
-        private formatBytes;
-        private processFileUploadToFigshare;
-        private deleteFilesAndUpdateDataLocationEntries;
-        private isArticleInExpectedState;
-        private transitionRecordWorkflowFromFigshareArticleProperties;
-        createUpdateFigshareArticle(oid: string, record: RecordLike, options: AnyRecord, user: AnyRecord): AnyRecord | Promise<AnyRecord>;
-        uploadFilesToFigshareArticle(oid: string, record: RecordLike, options: AnyRecord, user: AnyRecord): void;
-        deleteFilesFromRedboxTrigger(oid: string, record: RecordLike, options: AnyRecord, user: AnyRecord): AnyRecord | Promise<AnyRecord>;
-        publishAfterUploadFilesJob(job: AnyRecord): Promise<void>;
-        deleteFilesFromRedbox(job: AnyRecord): Promise<void>;
-        queuePublishAfterUploadFiles(oid: string, articleId: string, user: AnyRecord, brandId: string): void;
-        queueDeleteFiles(oid: string, user: AnyRecord, brandId: string, articleId: string): void;
-        transitionRecordWorkflowFromFigshareArticlePropertiesJob(_job: AnyRecord): Promise<void>;
+        private startIntegrationAudit;
+        private completeIntegrationAudit;
+        private failIntegrationAudit;
+        private assertConfig;
+        getConfig(record?: RecordModel): import("./figshare-v2/config").ResolvedFigsharePublishingConfigData | null;
+        getSyncState(config: NonNullable<ReturnType<typeof resolveFigsharePublishingConfig>>, record: RecordModel): FigshareSyncState;
+        setSyncState(config: NonNullable<ReturnType<typeof resolveFigsharePublishingConfig>>, record: RecordModel, syncState: FigshareSyncState): void;
+        validateHandlebarsTemplate(template: string): void;
+        buildMetadataPayload(config: NonNullable<ReturnType<typeof resolveFigsharePublishingConfig>>, record: RecordModel): Promise<Record<string, unknown>>;
+        makeClient(config: NonNullable<ReturnType<typeof resolveFigsharePublishingConfig>>, record: RecordModel, jobId?: string, triggerSource?: string): FigshareClient;
+        preparePublication(record: RecordModel, jobId?: string): FigsharePublicationPlan;
+        syncMetadata(record: RecordModel, plan?: FigsharePublicationPlan): Promise<FigshareArticle>;
+        syncAssets(record: RecordModel, article: FigshareArticle): Promise<AssetSyncResult & Record<string, unknown>>;
+        syncEmbargo(record: RecordModel, articleId: string): Promise<Record<string, unknown>>;
+        publishIfNeeded(record: RecordModel, articleId: string): Promise<FigsharePublishResult>;
+        writeBack(record: RecordModel, article: FigshareArticle, publishResult?: FigsharePublishResult, assetSyncResult?: Record<string, unknown>): RecordModel;
+        private getArticleFiles;
+        private isCurationLocked;
+        private ensureNoFileUploadInProgress;
+        private cleanupUploadedFiles;
+        private isArticleReadyForWorkflowTransition;
+        private transitionWorkflowForRecord;
+        syncRecordWithFigshare(record: RecordModel, jobId?: string, triggerSource?: string): Promise<RecordModel>;
+        persistSyncRecord(oid: string, record: RecordModel, user: UserModel): Promise<void>;
+        createUpdateFigshareArticle(oid: string, record: RecordModel, _options: Record<string, unknown>, _user: Record<string, unknown>): RecordModel | Promise<RecordModel>;
+        uploadFilesToFigshareArticle(oid: string, record: RecordModel, _options: Record<string, unknown>, user: UserModel): void;
+        deleteFilesFromRedboxTrigger(oid: string, record: RecordModel, options: Record<string, unknown>, user: Record<string, unknown>): RecordModel | Promise<RecordModel>;
+        publishAfterUploadFilesJob(job: FigshareJob): Promise<void>;
+        deleteFilesFromRedbox(job: FigshareJob): Promise<void>;
+        queuePublishAfterUploadFiles(oid: string, articleId: string, user: UserModel, brandId: string): void;
+        queueDeleteFiles(oid: string, user: UserModel, brandId: string, articleId: string): void;
+        transitionRecordWorkflowFromFigshareArticlePropertiesJob(_job: Record<string, unknown>): Promise<void>;
     }
 }
 declare global {
     let FigshareService: Services.FigshareService;
 }
-export {};
 //# sourceMappingURL=FigshareService.d.ts.map

package/dist/services/FigshareService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FigshareService.d.ts","sourceRoot":"","sources":["../../src/services/FigshareService.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAMtD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAU3D,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACzC,KAAK,UAAU,GAAG,WAAW,GAAG,SAAS,CAAC;AAgE1C,yBAAiB,QAAQ,CAAC;IAExB,MAAa,eAAgB,SAAQ,QAAQ,CAAC,IAAI,CAAC,OAAO;QAExD,OAAO,CAAC,iBAAiB,CAAqB;QAC9C,OAAO,CAAC,YAAY,CAAgB;QAEpC,UAAmB,gBAAgB,EAAE,MAAM,EAAE,CAU3C;;QAYc,IAAI,IAAI,IAAI;QA+B5B,OAAO,CAAC,gBAAgB;QA8CxB,OAAO,CAAC,oBAAoB;QAI5B,OAAO,CAAC,cAAc;QA2BtB,OAAO,CAAC,YAAY;QAKpB,OAAO,CAAC,UAAU;QAMlB,OAAO,CAAC,cAAc;QAyBtB,OAAO,CAAC,kBAAkB;QAY1B,OAAO,CAAC,iBAAiB;QAazB,OAAO,CAAC,kBAAkB;kBAQD,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;gBAIhD,gBAAgB;QA6B9B,OAAO,CAAC,kBAAkB;QAkB1B,OAAO,CAAC,kBAAkB;QAwB1B,OAAO,CAAC,gBAAgB;QA0DxB,OAAO,CAAC,6BAA6B;QA2CrC,OAAO,CAAC,2BAA2B;QAyBnC,OAAO,CAAC,2BAA2B;gBAsDrB,gBAAgB;QAwH9B,OAAO,CAAC,yBAAyB;QAoBjC,OAAO,CAAC,iBAAiB;gBAmBX,oBAAoB;gBA2BpB,0BAA0B;QAkCxC,OAAO,CAAC,eAAe;gBAsBT,qBAAqB;gBAkCrB,iBAAiB;gBAajB,6BAA6B;gBAc7B,kBAAkB;gBAqClB,sBAAsB;gBAetB,kCAAkC;QAyBhD,OAAO,CAAC,2BAA2B;QAiCnC,OAAO,CAAC,2BAA2B;QA8BnC,OAAO,CAAC,qBAAqB;QAkB7B,OAAO,CAAC,qBAAqB;gBAOf,6BAA6B;QA0S3C,OAAO,CAAC,0BAA0B;QAelC,OAAO,CAAC,iBAAiB;QA8BzB,OAAO,CAAC,0BAA0B;QA+HlC,OAAO,CAAC,yBAAyB;QAWjC,OAAO,CAAC,wBAAwB;QAoBhC,OAAO,CAAC,yBAAyB;QAWjC,OAAO,CAAC,+BAA+B;QAoBvC,OAAO,CAAC,8BAA8B;QAoBtC,OAAO,CAAC,mCAAmC;gBAkB7B,uBAAuB;QA6RrC,OAAO,CAAC,WAAW;gBAYL,2BAA2B;gBAiP3B,uCAAuC;gBAiEvC,wBAAwB;gBA4BxB,qDAAqD;QAuD5D,2BAA2B,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS;QAchG,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS;QAcjG,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS;QAc3F,0BAA0B,CAAC,GAAG,EAAE,SAAS;QAuCzC,qBAAqB,CAAC,GAAG,EAAE,SAAS;QA2C1C,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM;QAwB7F,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;QAsB3E,wDAAwD,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;KAsDtG;CACF;AAGD,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;CAC/C"}
+{"version":3,"file":"FigshareService.d.ts","sourceRoot":"","sources":["../../src/services/FigshareService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,+BAA+B,EAA4C,MAAM,sBAAsB,CAAC;AAWjH,OAAO,EAAE,cAAc,EAAqC,MAAM,oBAAoB,CAAC;AAKvF,OAAO,EACL,WAAW,EACX,SAAS,EACT,eAAe,EAEf,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,EACjB,WAAW,EAGX,eAAe,EAGhB,MAAM,qBAAqB,CAAC;AAS7B,yBAAiB,QAAQ,CAAC;IACxB,MAAa,eAAgB,SAAQ,QAAQ,CAAC,IAAI,CAAC,OAAO;QACxD,UAAmB,gBAAgB,EAAE,MAAM,EAAE,CAiB3C;QAEF,OAAO,CAAC,qBAAqB;QAa7B,OAAO,CAAC,wBAAwB;QAIhC,OAAO,CAAC,oBAAoB;QAI5B,OAAO,CAAC,YAAY;QAQb,SAAS,CAAC,MAAM,CAAC,EAAE,WAAW;QAI9B,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,GAAG,iBAAiB;QAI7H,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,iBAAiB,GAAG,IAAI;QAI9I,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;QAI5C,oBAAoB,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAI1J,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,aAAa,GAAE,MAAiB;QAKzJ,kBAAkB,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,uBAAuB;QAY1E,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,eAAe,CAAC;QAkB3F,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAS7G,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAQrF,eAAe,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;QAQ7F,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe,EAAE,aAAa,CAAC,EAAE,qBAAqB,EAAE,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,WAAW;gBAQhJ,eAAe;QAkB7B,OAAO,CAAC,gBAAgB;gBAWV,4BAA4B;gBAe5B,oBAAoB;gBA8DpB,mCAAmC;gBA8BnC,2BAA2B;QA+C5B,sBAAsB,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,aAAa,GAAE,MAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;QA+DnH,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;QAUzF,2BAA2B,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;QAO/H,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS;QA8BjH,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;QAgBxH,0BAA0B,CAAC,GAAG,EAAE,WAAW;QA8G3C,qBAAqB,CAAC,GAAG,EAAE,WAAW;QAqB5C,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM;QAe7F,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;QAe3E,wDAAwD,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;KAmDpH;CACF;AAID,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;CAC/C"}