@webiny/api-headless-cms-import-export 5.41.0-beta.0

package/types.d.ts

@@ -0,0 +1,119 @@
+import type { FileManagerContext } from "@webiny/api-file-manager/types";
+import type { Context as TasksContext, TaskDataStatus } from "@webiny/tasks/types";
+import type { ICmsImportExportRecord } from "./domain/abstractions/CmsImportExportRecord";
+import type { GenericRecord, NonEmptyArray } from "@webiny/api/types";
+import type { CmsEntryListSort, CmsEntryListWhere, CmsEntryMeta } from "@webiny/api-headless-cms/types";
+export * from "./domain/abstractions/CmsImportExportRecord";
+export declare enum CmsImportExportFileType {
+    ENTRIES = "entries",
+    ASSETS = "assets"
+}
+export interface ICmsImportExportObjectGetExportParams {
+    id: string;
+}
+export interface ICmsImportExportObjectStartExportParams {
+    modelId: string;
+    exportAssets: boolean;
+    limit?: number;
+    where?: CmsEntryListWhere;
+    sort?: CmsEntryListSort;
+}
+export interface ICmsImportExportObjectAbortExportParams {
+    id: string;
+}
+export interface ICmsImportExportObjectValidateImportFromUrlParams {
+    data: string | GenericRecord;
+}
+export interface ICmsImportExportFile {
+    get: string;
+    head: string;
+    checksum: string;
+    key: string;
+    type: CmsImportExportFileType;
+    error?: ICmsImportExportValidatedFileError;
+}
+export interface ICmsImportExportObjectValidateImportFromUrlResult {
+    files: NonEmptyArray<ICmsImportExportFile>;
+    modelId: string;
+    id: string;
+    status: TaskDataStatus;
+}
+export interface ICmsImportExportObjectGetValidateImportFromUrlParams {
+    id: string;
+}
+export interface ICmsImportExportValidatedFileError {
+    message: string;
+    code: string;
+    data?: GenericRecord;
+}
+export interface ICmsImportExportValidatedValidFile {
+    get: string;
+    head: string;
+    key: string;
+    checksum: string;
+    type: CmsImportExportFileType | undefined;
+    size: number;
+    checked: boolean;
+    error?: never;
+}
+export interface ICmsImportExportValidatedInvalidFile extends Partial<Omit<ICmsImportExportValidatedValidFile, "error">> {
+    checked: boolean;
+    error: ICmsImportExportValidatedFileError;
+}
+export type ICmsImportExportValidatedFile = ICmsImportExportValidatedValidFile | ICmsImportExportValidatedInvalidFile;
+export interface ICmsImportExportValidatedContentEntriesFile extends ICmsImportExportValidatedValidFile {
+    size: number;
+    type: CmsImportExportFileType.ENTRIES;
+}
+export interface ICmsImportExportValidatedAssetsFile extends ICmsImportExportValidatedValidFile {
+    size: number;
+    type: CmsImportExportFileType.ASSETS;
+}
+export interface ICmsImportExportObjectGetValidateImportFromUrlResult {
+    id: string;
+    files: NonEmptyArray<ICmsImportExportValidatedFile> | undefined;
+    status: TaskDataStatus;
+    error?: GenericRecord;
+}
+export interface ICmsImportExportObjectImportFromUrlParams {
+    id: string;
+    maxInsertErrors?: number;
+    overwrite?: boolean;
+}
+export interface ICmsImportExportObjectAbortImportFromUrlParams {
+    id: string;
+}
+export interface ICmsImportExportObjectGetImportFromUrlParams {
+    id: string;
+}
+export interface ICmsImportExportObjectImportFromUrlResult {
+    id: string;
+    done: string[];
+    failed: string[];
+    aborted: string[];
+    invalid: string[];
+    status: TaskDataStatus;
+    error?: GenericRecord;
+}
+export interface IListExportContentEntriesParams {
+    limit?: number;
+    after?: string;
+}
+export interface IListExportContentEntriesResult {
+    items: Omit<ICmsImportExportRecord, "files">[];
+    meta: CmsEntryMeta;
+}
+export interface CmsImportExportObject {
+    getExportContentEntries(params: ICmsImportExportObjectGetExportParams): Promise<ICmsImportExportRecord>;
+    listExportContentEntries(params?: IListExportContentEntriesParams): Promise<IListExportContentEntriesResult>;
+    exportContentEntries(params: ICmsImportExportObjectStartExportParams): Promise<ICmsImportExportRecord>;
+    abortExportContentEntries(params: ICmsImportExportObjectAbortExportParams): Promise<ICmsImportExportRecord>;
+    validateImportFromUrl(params: ICmsImportExportObjectValidateImportFromUrlParams): Promise<ICmsImportExportObjectValidateImportFromUrlResult>;
+    getValidateImportFromUrl(params: ICmsImportExportObjectGetValidateImportFromUrlParams): Promise<ICmsImportExportObjectGetValidateImportFromUrlResult>;
+    importFromUrl(params: ICmsImportExportObjectImportFromUrlParams): Promise<ICmsImportExportObjectImportFromUrlResult>;
+    abortImportFromUrl(params: ICmsImportExportObjectAbortImportFromUrlParams): Promise<ICmsImportExportObjectImportFromUrlResult>;
+    getImportFromUrl(params: ICmsImportExportObjectGetImportFromUrlParams): Promise<ICmsImportExportObjectImportFromUrlResult>;
+}
+export interface Context extends FileManagerContext, TasksContext {
+    cmsImportExport: CmsImportExportObject;
+}

package/types.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  CmsImportExportFileType: true
+};
+exports.CmsImportExportFileType = void 0;
+var _CmsImportExportRecord = require("./domain/abstractions/CmsImportExportRecord");
+Object.keys(_CmsImportExportRecord).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _CmsImportExportRecord[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _CmsImportExportRecord[key];
+    }
+  });
+});
+let CmsImportExportFileType = exports.CmsImportExportFileType = /*#__PURE__*/function (CmsImportExportFileType) {
+  CmsImportExportFileType["ENTRIES"] = "entries";
+  CmsImportExportFileType["ASSETS"] = "assets";
+  return CmsImportExportFileType;
+}({});
+
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_CmsImportExportRecord","require","Object","keys","forEach","key","prototype","hasOwnProperty","call","_exportNames","exports","defineProperty","enumerable","get","CmsImportExportFileType"],"sources":["types.ts"],"sourcesContent":["import type { FileManagerContext } from \"@webiny/api-file-manager/types\";\nimport type { Context as TasksContext, TaskDataStatus } from \"@webiny/tasks/types\";\nimport type { ICmsImportExportRecord } from \"./domain/abstractions/CmsImportExportRecord\";\nimport type { GenericRecord, NonEmptyArray } from \"@webiny/api/types\";\nimport type {\n    CmsEntryListSort,\n    CmsEntryListWhere,\n    CmsEntryMeta\n} from \"@webiny/api-headless-cms/types\";\n\nexport * from \"./domain/abstractions/CmsImportExportRecord\";\n\nexport enum CmsImportExportFileType {\n    ENTRIES = \"entries\",\n    ASSETS = \"assets\"\n}\n\nexport interface ICmsImportExportObjectGetExportParams {\n    id: string;\n}\n\nexport interface ICmsImportExportObjectStartExportParams {\n    modelId: string;\n    exportAssets: boolean;\n    limit?: number;\n    where?: CmsEntryListWhere;\n    sort?: CmsEntryListSort;\n}\n\nexport interface ICmsImportExportObjectAbortExportParams {\n    id: string;\n}\n\nexport interface ICmsImportExportObjectValidateImportFromUrlParams {\n    data: string | GenericRecord;\n}\n\nexport interface ICmsImportExportFile {\n    get: string;\n    head: string;\n    checksum: string;\n    key: string;\n    type: CmsImportExportFileType;\n    error?: ICmsImportExportValidatedFileError;\n}\n\nexport interface ICmsImportExportObjectValidateImportFromUrlResult {\n    files: NonEmptyArray<ICmsImportExportFile>;\n    modelId: string;\n    id: string;\n    status: TaskDataStatus;\n}\n\nexport interface ICmsImportExportObjectGetValidateImportFromUrlParams {\n    id: string;\n}\n\nexport interface ICmsImportExportValidatedFileError {\n    message: string;\n    code: string;\n    data?: GenericRecord;\n}\n\nexport interface ICmsImportExportValidatedValidFile {\n    get: string;\n    head: string;\n    key: string;\n    checksum: string;\n    type: CmsImportExportFileType | undefined;\n    size: number;\n    checked: boolean;\n    error?: never;\n}\n\nexport interface ICmsImportExportValidatedInvalidFile\n    extends Partial<Omit<ICmsImportExportValidatedValidFile, \"error\">> {\n    checked: boolean;\n    error: ICmsImportExportValidatedFileError;\n}\n\nexport type ICmsImportExportValidatedFile =\n    | ICmsImportExportValidatedValidFile\n    | ICmsImportExportValidatedInvalidFile;\n\nexport interface ICmsImportExportValidatedContentEntriesFile\n    extends ICmsImportExportValidatedValidFile {\n    size: number;\n    type: CmsImportExportFileType.ENTRIES;\n}\n\nexport interface ICmsImportExportValidatedAssetsFile extends ICmsImportExportValidatedValidFile {\n    size: number;\n    type: CmsImportExportFileType.ASSETS;\n}\n\nexport interface ICmsImportExportObjectGetValidateImportFromUrlResult {\n    id: string;\n    files: NonEmptyArray<ICmsImportExportValidatedFile> | undefined;\n    status: TaskDataStatus;\n    error?: GenericRecord;\n}\n\nexport interface ICmsImportExportObjectImportFromUrlParams {\n    id: string;\n    maxInsertErrors?: number;\n    overwrite?: boolean;\n}\n\nexport interface ICmsImportExportObjectAbortImportFromUrlParams {\n    id: string;\n}\n\nexport interface ICmsImportExportObjectGetImportFromUrlParams {\n    id: string;\n}\n\nexport interface ICmsImportExportObjectImportFromUrlResult {\n    id: string;\n    done: string[];\n    failed: string[];\n    aborted: string[];\n    invalid: string[];\n    status: TaskDataStatus;\n    error?: GenericRecord;\n}\n\nexport interface IListExportContentEntriesParams {\n    limit?: number;\n    after?: string;\n}\n\nexport interface IListExportContentEntriesResult {\n    items: Omit<ICmsImportExportRecord, \"files\">[];\n    meta: CmsEntryMeta;\n}\n\nexport interface CmsImportExportObject {\n    getExportContentEntries(\n        params: ICmsImportExportObjectGetExportParams\n    ): Promise<ICmsImportExportRecord>;\n    listExportContentEntries(\n        params?: IListExportContentEntriesParams\n    ): Promise<IListExportContentEntriesResult>;\n    exportContentEntries(\n        params: ICmsImportExportObjectStartExportParams\n    ): Promise<ICmsImportExportRecord>;\n    abortExportContentEntries(\n        params: ICmsImportExportObjectAbortExportParams\n    ): Promise<ICmsImportExportRecord>;\n    validateImportFromUrl(\n        params: ICmsImportExportObjectValidateImportFromUrlParams\n    ): Promise<ICmsImportExportObjectValidateImportFromUrlResult>;\n    getValidateImportFromUrl(\n        params: ICmsImportExportObjectGetValidateImportFromUrlParams\n    ): Promise<ICmsImportExportObjectGetValidateImportFromUrlResult>;\n    importFromUrl(\n        params: ICmsImportExportObjectImportFromUrlParams\n    ): Promise<ICmsImportExportObjectImportFromUrlResult>;\n    abortImportFromUrl(\n        params: ICmsImportExportObjectAbortImportFromUrlParams\n    ): Promise<ICmsImportExportObjectImportFromUrlResult>;\n    getImportFromUrl(\n        params: ICmsImportExportObjectGetImportFromUrlParams\n    ): Promise<ICmsImportExportObjectImportFromUrlResult>;\n}\n\nexport interface Context extends FileManagerContext, TasksContext {\n    cmsImportExport: CmsImportExportObject;\n}\n"],"mappings":";;;;;;;;;AAUA,IAAAA,sBAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,sBAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAC,YAAA,EAAAJ,GAAA;EAAA,IAAAA,GAAA,IAAAK,OAAA,IAAAA,OAAA,CAAAL,GAAA,MAAAL,sBAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAS,cAAA,CAAAD,OAAA,EAAAL,GAAA;IAAAO,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAb,sBAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AAA4D,IAEhDS,uBAAuB,GAAAJ,OAAA,CAAAI,uBAAA,0BAAvBA,uBAAuB;EAAvBA,uBAAuB;EAAvBA,uBAAuB;EAAA,OAAvBA,uBAAuB;AAAA","ignoreList":[]}