@concord-consortium/cloud-file-manager 2.0.0-pre.1

package/dist/esm/providers/local-file-provider.js

@@ -0,0 +1,60 @@
+import { createReactFactory } from "../create-react-factory";
+import tr from '../utils/translate';
+import { cloudContentFactory, ProviderInterface } from './provider-interface';
+import localFileTabListView from '../views/local-file-tab-list-view';
+import localFileTabSaveView from '../views/local-file-tab-save-view';
+const LocalFileListTab = createReactFactory(localFileTabListView);
+const LocalFileSaveTab = createReactFactory(localFileTabSaveView);
+class LocalFileProvider extends ProviderInterface {
+    constructor(options, client) {
+        super({
+            name: LocalFileProvider.Name,
+            displayName: options.displayName || (tr('~PROVIDER.LOCAL_FILE')),
+            urlDisplayName: options.urlDisplayName || LocalFileProvider.Name,
+            capabilities: {
+                save: true,
+                resave: false,
+                "export": true,
+                load: true,
+                list: true,
+                remove: false,
+                rename: false,
+                close: false
+            }
+        });
+        this.options = options;
+        this.client = client;
+    }
+    filterTabComponent(capability, defaultComponent) {
+        if (capability === 'list') {
+            return LocalFileListTab;
+        }
+        else if ((capability === 'save') || (capability === 'export')) {
+            return LocalFileSaveTab;
+        }
+        else {
+            return defaultComponent;
+        }
+    }
+    list(metadata, callback) { }
+    // not really implemented - we flag it as implemented so we show in the list dialog
+    save(content, metadata, callback) {
+        // not really implemented - we flag it as implemented so we can add the download button to the save dialog
+        return (typeof callback === 'function' ? callback(null) : undefined);
+    }
+    load(metadata, callback) {
+        const reader = new FileReader();
+        reader.onload = loaded => {
+            const content = cloudContentFactory.createEnvelopedCloudContent(loaded.target.result);
+            return callback(null, content);
+        };
+        return reader.readAsText(metadata.providerData.file);
+    }
+    canOpenSaved() {
+        // this prevents the hash to be updated
+        return false;
+    }
+}
+LocalFileProvider.Name = 'localFile';
+export default LocalFileProvider;
+//# sourceMappingURL=local-file-provider.js.map

package/dist/esm/providers/local-file-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-file-provider.js","sourceRoot":"","sources":["../../../src/code/providers/local-file-provider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,MAAO,oBAAoB,CAAA;AAEpC,OAAO,EACL,mBAAmB,EAAgC,iBAAiB,EAErE,MAAO,sBAAsB,CAAA;AAE9B,OAAO,oBAAoB,MAAM,mCAAmC,CAAA;AACpE,OAAO,oBAAoB,MAAM,mCAAmC,CAAA;AAEpE,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,oBAAoB,CAAC,CAAA;AACjE,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,oBAAoB,CAAC,CAAA;AAEjE,MAAM,iBAAkB,SAAQ,iBAAiB;IAI/C,YAAY,OAA+B,EAAE,MAA8B;QACzE,KAAK,CAAC;YACJ,IAAI,EAAE,iBAAiB,CAAC,IAAI;YAC5B,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,CAAC,EAAE,CAAC,sBAAsB,CAAC,CAAC;YAChE,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,iBAAiB,CAAC,IAAI;YAChE,YAAY,EAAE;gBACZ,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,KAAK;aACb;SACF,CAAC,CAAA;QACF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,kBAAkB,CAAC,UAAyB,EAAE,gBAAiC;QAC7E,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;YAC1B,OAAO,gBAAgB,CAAA;QACzB,CAAC;aAAM,IAAI,CAAC,UAAU,KAAK,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,QAAQ,CAAC,EAAE,CAAC;YAChE,OAAO,gBAAgB,CAAA;QACzB,CAAC;aAAM,CAAC;YACN,OAAO,gBAAgB,CAAA;QACzB,CAAC;IACH,CAAC;IAED,IAAI,CAAC,QAAuB,EAAE,QAA8B,IAAG,CAAC;IAC9D,mFAAmF;IAErF,IAAI,CAAC,OAAY,EAAE,QAAuB,EAAE,QAA8B;QACxE,0GAA0G;QAC1G,OAAO,CAAC,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IACtE,CAAC;IAED,IAAI,CAAC,QAAuB,EAAE,QAA8B;QAC1D,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAA;QAC/B,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE;YACvB,MAAM,OAAO,GAAG,mBAAmB,CAAC,2BAA2B,CAAC,MAAM,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAA;YAC/F,OAAO,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAChC,CAAC,CAAA;QACD,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACtD,CAAC;IAED,YAAY;QACV,uCAAuC;QACvC,OAAO,KAAK,CAAA;IACd,CAAC;;AArDa,sBAAI,GAAG,WAAW,CAAA;AAwDlC,eAAe,iBAAiB,CAAA"}

package/dist/esm/providers/localstorage-provider.d.ts

@@ -0,0 +1,20 @@
+import { CFMBaseProviderOptions } from '../app-options';
+import { CloudFileManagerClient } from '../client';
+import { CloudMetadata, IListOptions, ProviderInterface, ProviderListCallback, ProviderLoadCallback, ProviderOpenCallback, ProviderRemoveCallback, ProviderRenameCallback, ProviderSaveCallback } from './provider-interface';
+declare class LocalStorageProvider extends ProviderInterface {
+    static Name: string;
+    client: CloudFileManagerClient;
+    options: CFMBaseProviderOptions;
+    constructor(options: CFMBaseProviderOptions | undefined, client: CloudFileManagerClient);
+    static Available(): boolean;
+    save(content: any, metadata: CloudMetadata, callback?: ProviderSaveCallback): void;
+    load(metadata: CloudMetadata, callback: ProviderLoadCallback): void;
+    list(metadata: CloudMetadata, callback: ProviderListCallback, options?: IListOptions): void;
+    remove(metadata: CloudMetadata, callback?: ProviderRemoveCallback): void;
+    rename(metadata: CloudMetadata, newName: string, callback?: ProviderRenameCallback): void;
+    canOpenSaved(): boolean;
+    openSaved(openSavedParams: any, callback: ProviderOpenCallback): void;
+    getOpenSavedParams(metadata: CloudMetadata): string;
+    _getKey(name?: string): string;
+}
+export default LocalStorageProvider;

package/dist/esm/providers/localstorage-provider.js

@@ -0,0 +1,117 @@
+import tr from '../utils/translate';
+import { cloudContentFactory, CloudMetadata, ProviderInterface } from './provider-interface';
+class LocalStorageProvider extends ProviderInterface {
+    constructor(options, client) {
+        super({
+            name: LocalStorageProvider.Name,
+            displayName: (options === null || options === void 0 ? void 0 : options.displayName) || (tr('~PROVIDER.LOCAL_STORAGE')),
+            urlDisplayName: options === null || options === void 0 ? void 0 : options.urlDisplayName,
+            capabilities: {
+                save: true,
+                resave: true,
+                "export": true,
+                load: true,
+                list: true,
+                remove: true,
+                rename: true,
+                close: false
+            }
+        });
+        this.options = options;
+        this.client = client;
+    }
+    static Available() {
+        try {
+            const test = 'LocalStorageProvider::auth';
+            window.localStorage.setItem(test, test);
+            window.localStorage.removeItem(test);
+            return true;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+    save(content, metadata, callback) {
+        var _a;
+        try {
+            const fileKey = this._getKey(metadata.filename);
+            window.localStorage.setItem(fileKey, ((_a = content.getContentAsJSON) === null || _a === void 0 ? void 0 : _a.call(content)) || content);
+            return callback === null || callback === void 0 ? void 0 : callback(null);
+        }
+        catch (e) {
+            return callback === null || callback === void 0 ? void 0 : callback(`Unable to save: ${e.message}`);
+        }
+    }
+    load(metadata, callback) {
+        try {
+            const content = window.localStorage.getItem(this._getKey(metadata.filename));
+            return callback(null, cloudContentFactory.createEnvelopedCloudContent(content));
+        }
+        catch (e) {
+            return callback(`Unable to load '${metadata.name}': ${e.message}`);
+        }
+    }
+    list(metadata, callback, options) {
+        var _a;
+        const extension = options === null || options === void 0 ? void 0 : options.extension;
+        const readableExtensions = extension ? [extension] : CloudMetadata.ReadableExtensions;
+        const list = [];
+        const prefix = this._getKey((((_a = metadata === null || metadata === void 0 ? void 0 : metadata.path) === null || _a === void 0 ? void 0 : _a.call(metadata)) || []).join('/'));
+        for (let key of Object.keys(window.localStorage || {})) {
+            if (key.substr(0, prefix.length) === prefix) {
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                const [filename, ...remainder] = key.substr(prefix.length).split('/');
+                const name = key.substr(prefix.length);
+                if (this.matchesExtension(name, readableExtensions)) {
+                    list.push(new CloudMetadata({
+                        name,
+                        type: remainder.length > 0 ? CloudMetadata.Folder : CloudMetadata.File,
+                        parent: metadata,
+                        provider: this
+                    }));
+                }
+            }
+        }
+        return callback(null, list);
+    }
+    remove(metadata, callback) {
+        try {
+            window.localStorage.removeItem(this._getKey(metadata.filename));
+            return callback === null || callback === void 0 ? void 0 : callback(null);
+        }
+        catch (error) {
+            return callback === null || callback === void 0 ? void 0 : callback('Unable to delete');
+        }
+    }
+    rename(metadata, newName, callback) {
+        try {
+            const content = window.localStorage.getItem(this._getKey(metadata.filename));
+            window.localStorage.setItem(this._getKey(CloudMetadata.withExtension(newName)), content);
+            window.localStorage.removeItem(this._getKey(metadata.filename));
+            metadata.rename(newName);
+            return callback === null || callback === void 0 ? void 0 : callback(null, metadata);
+        }
+        catch (error) {
+            return callback === null || callback === void 0 ? void 0 : callback('Unable to rename');
+        }
+    }
+    canOpenSaved() { return true; }
+    openSaved(openSavedParams, callback) {
+        const metadata = new CloudMetadata({
+            name: openSavedParams,
+            type: CloudMetadata.File,
+            parent: null,
+            provider: this
+        });
+        return this.load(metadata, (err, content) => callback(err, content, metadata));
+    }
+    getOpenSavedParams(metadata) {
+        return metadata.name;
+    }
+    _getKey(name = '') {
+        return `cfm::${name.replace(/\t/g, ' ')}`;
+    }
+}
+LocalStorageProvider.Name = 'localStorage';
+export default LocalStorageProvider;
+//# sourceMappingURL=localstorage-provider.js.map

package/dist/esm/providers/localstorage-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localstorage-provider.js","sourceRoot":"","sources":["../../../src/code/providers/localstorage-provider.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAEnC,OAAO,EACL,mBAAmB,EAAE,aAAa,EAAgB,iBAAiB,EAEpE,MAAO,sBAAsB,CAAA;AAE9B,MAAM,oBAAqB,SAAQ,iBAAiB;IAKlD,YAAY,OAA2C,EAAE,MAA8B;QACrF,KAAK,CAAC;YACJ,IAAI,EAAE,oBAAoB,CAAC,IAAI;YAC/B,WAAW,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,KAAI,CAAC,EAAE,CAAC,yBAAyB,CAAC,CAAC;YACpE,cAAc,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc;YACvC,YAAY,EAAE;gBACZ,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,IAAI;gBACZ,KAAK,EAAE,KAAK;aACb;SACF,CAAC,CAAA;QACF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IACD,MAAM,CAAC,SAAS;QACd,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,4BAA4B,CAAA;YACzC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YACvC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YACpC,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,IAAI,CAAC,OAAY,EAAE,QAAuB,EAAE,QAA+B;;QACzE,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC/C,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA,MAAA,OAAO,CAAC,gBAAgB,uDAAI,KAAI,OAAO,CAAC,CAAA;YAC7E,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,IAAI,CAAC,CAAA;QACzB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;QACnD,CAAC;IACH,CAAC;IAED,IAAI,CAAC,QAAuB,EAAE,QAA8B;QAC1D,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;YAC5E,OAAO,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAAA;QACjF,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,QAAQ,CAAC,mBAAmB,QAAQ,CAAC,IAAI,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;QACpE,CAAC;IACH,CAAC;IAED,IAAI,CAAC,QAAuB,EAAE,QAA8B,EAAE,OAAsB;;QAClF,MAAM,SAAS,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAA;QACpC,MAAM,kBAAkB,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAAA;QAErF,MAAM,IAAI,GAAG,EAAE,CAAA;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,wDAAI,KAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QACjE,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC,EAAE,CAAC;YACvD,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,MAAM,EAAE,CAAC;gBAC5C,6DAA6D;gBAC7D,MAAM,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACrE,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;gBACtC,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,CAAC;oBACpD,IAAI,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC;wBAC1B,IAAI;wBACJ,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI;wBACtE,MAAM,EAAE,QAAQ;wBAChB,QAAQ,EAAE,IAAI;qBACf,CAAC,CACD,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC7B,CAAC;IAED,MAAM,CAAC,QAAuB,EAAE,QAAiC;QAC/D,IAAI,CAAC;YACH,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;YAC/D,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,IAAI,CAAC,CAAA;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,kBAAkB,CAAC,CAAA;QACvC,CAAC;IACH,CAAC;IAED,MAAM,CAAC,QAAuB,EAAE,OAAe,EAAE,QAAiC;QAChF,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;YAC5E,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;YACxF,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;YAC/D,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YACxB,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,IAAI,EAAE,QAAQ,CAAC,CAAA;QACnC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,kBAAkB,CAAC,CAAA;QACvC,CAAC;IACH,CAAC;IAED,YAAY,KAAK,OAAO,IAAI,CAAA,CAAC,CAAC;IAE9B,SAAS,CAAC,eAAoB,EAAE,QAA8B;QAC5D,MAAM,QAAQ,GAAG,IAAI,aAAa,CAAC;YACjC,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,MAAM,EAAE,IAAI;YACZ,QAAQ,EAAE,IAAI;SACf,CAAC,CAAA;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAkB,EAAE,OAAY,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAA;IACpG,CAAC;IAED,kBAAkB,CAAC,QAAuB;QACxC,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED,OAAO,CAAC,IAAI,GAAG,EAAE;QACf,OAAO,QAAQ,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAA;IAC3C,CAAC;;AArHM,yBAAI,GAAG,cAAc,CAAA;AAwH9B,eAAe,oBAAoB,CAAA"}

package/dist/esm/providers/patchable-content.d.ts

@@ -0,0 +1,16 @@
+import jiff from 'jiff';
+declare class PatchableContent {
+    patchObjectHash?: (obj: any) => string;
+    savedContent: any;
+    constructor(patchObjectHash: (obj: any) => string, savedContent?: any);
+    createPatch(content: any, canPatch: boolean): {
+        shouldPatch: boolean;
+        mimeType: string;
+        contentJson: string;
+        diffLength: number;
+        diffJson: string;
+    };
+    updateContent(content: any): any;
+    _createDiff(obj1: any, obj2: any): jiff.JSONPatch;
+}
+export default PatchableContent;

package/dist/esm/providers/patchable-content.js

@@ -0,0 +1,60 @@
+// TODO: This file was created by bulk-decaffeinate.
+// Sanity-check the conversion and remove this comment.
+/*
+ * decaffeinate suggestions:
+ * DS102: Remove unnecessary code created because of implicit returns
+ * DS207: Consider shorter variations of null checks
+ * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
+ */
+//
+// This utility class simplifies working with document store URLs
+//
+import jiff from 'jiff';
+class PatchableContent {
+    constructor(patchObjectHash, savedContent) {
+        this.patchObjectHash = patchObjectHash;
+        this.savedContent = savedContent;
+    }
+    createPatch(content, canPatch) {
+        const diff = canPatch && this.savedContent ? this._createDiff(this.savedContent, content) : undefined;
+        const result = {
+            shouldPatch: false,
+            mimeType: 'application/json',
+            contentJson: JSON.stringify(content),
+            diffLength: diff === null || diff === void 0 ? void 0 : diff.length,
+            diffJson: diff && JSON.stringify(diff)
+        };
+        // only patch if the diff is smaller than saving the entire file
+        // e.g. when large numbers of cases are deleted the diff can be larger
+        if (canPatch && (result.diffJson != null) && (result.diffJson.length < result.contentJson.length)) {
+            result.shouldPatch = true;
+            result.sendContent = result.diffJson;
+            result.mimeType = 'application/json-patch+json';
+        }
+        else {
+            result.sendContent = result.contentJson;
+        }
+        return result;
+    }
+    updateContent(content) {
+        return this.savedContent = content;
+    }
+    _createDiff(obj1, obj2) {
+        try {
+            const opts = {
+                hash: this.patchObjectHash,
+                invertible: false // smaller patches are worth more than invertibility
+            };
+            // clean objects before diffing
+            const cleanedObj1 = JSON.parse(JSON.stringify(obj1));
+            const cleanedObj2 = JSON.parse(JSON.stringify(obj2));
+            const diff = jiff.diff(cleanedObj1, cleanedObj2, opts);
+            return diff;
+        }
+        catch (error) {
+            return null;
+        }
+    }
+}
+export default PatchableContent;
+//# sourceMappingURL=patchable-content.js.map

package/dist/esm/providers/patchable-content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patchable-content.js","sourceRoot":"","sources":["../../../src/code/providers/patchable-content.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,uDAAuD;AACvD;;;;;GAKG;AACH,EAAE;AACF,iEAAiE;AACjE,EAAE;AACF,OAAO,IAAI,MAAM,MAAM,CAAA;AAEvB,MAAM,gBAAgB;IAIpB,YAAY,eAAqC,EAAE,YAAkB;QACnE,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QACtC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED,WAAW,CAAC,OAAY,EAAE,QAAiB;QACzC,MAAM,IAAI,GAAG,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACrG,MAAM,MAAM,GAAG;YACb,WAAW,EAAE,KAAK;YAClB,QAAQ,EAAE,kBAAkB;YAC5B,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YACpC,UAAU,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM;YACxB,QAAQ,EAAE,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SACvC,CAAA;QAED,gEAAgE;QAChE,sEAAsE;QACtE,IAAI,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YAClG,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;YACzB,MAAc,CAAC,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAA;YAC7C,MAAM,CAAC,QAAQ,GAAG,6BAA6B,CAAA;QACjD,CAAC;aAAM,CAAC;YACL,MAAc,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAA;QAClD,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,aAAa,CAAC,OAAY;QACxB,OAAO,IAAI,CAAC,YAAY,GAAG,OAAO,CAAA;IACpC,CAAC;IAED,WAAW,CAAC,IAAS,EAAE,IAAS;QAC9B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG;gBACX,IAAI,EAAE,IAAI,CAAC,eAAe;gBAC1B,UAAU,EAAE,KAAK,CAAC,oDAAoD;aACvE,CAAA;YACD,+BAA+B;YAC/B,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;YACpD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;YACpD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,CAAA;YACtD,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;CACF;AAED,eAAe,gBAAgB,CAAA"}

package/dist/esm/providers/post-message-provider.d.ts

@@ -0,0 +1,12 @@
+import { CFMBaseProviderOptions } from '../app-options';
+import { CloudFileManagerClient } from '../client';
+import { CloudMetadata, ProviderInterface } from './provider-interface';
+declare class PostMessageProvider extends ProviderInterface {
+    static Name: string;
+    client: CloudFileManagerClient;
+    options: CFMBaseProviderOptions;
+    constructor(options: CFMBaseProviderOptions | undefined, client: CloudFileManagerClient);
+    canOpenSaved(): boolean;
+    saveAsExport(content: any, metadata: CloudMetadata, callback?: (err: string | null) => void): void;
+}
+export default PostMessageProvider;

package/dist/esm/providers/post-message-provider.js

@@ -0,0 +1,34 @@
+import { ProviderInterface } from './provider-interface';
+import getQueryParam from '../utils/get-query-param';
+class PostMessageProvider extends ProviderInterface {
+    constructor(options, client) {
+        super({
+            name: PostMessageProvider.Name,
+            capabilities: {
+                save: false,
+                resave: false,
+                "export": getQueryParam("saveSecondaryFileViaPostMessage") ? 'auto' : false,
+                load: false,
+                list: false,
+                remove: false,
+                rename: false,
+                close: false
+            }
+        });
+        this.client = client;
+        this.options = options || {};
+    }
+    canOpenSaved() { return false; }
+    saveAsExport(content, metadata, callback) {
+        window.parent.postMessage({
+            action: "saveSecondaryFile",
+            extension: metadata.extension,
+            mimeType: metadata.mimeType,
+            content
+        }, "*");
+        callback === null || callback === void 0 ? void 0 : callback(null);
+    }
+}
+PostMessageProvider.Name = 'postMessage';
+export default PostMessageProvider;
+//# sourceMappingURL=post-message-provider.js.map

package/dist/esm/providers/post-message-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"post-message-provider.js","sourceRoot":"","sources":["../../../src/code/providers/post-message-provider.ts"],"names":[],"mappings":"AAYA,OAAO,EAAiB,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACvE,OAAO,aAAa,MAAM,0BAA0B,CAAA;AAEpD,MAAM,mBAAoB,SAAQ,iBAAiB;IAKjD,YAAY,OAA2C,EAAE,MAA8B;QACrF,KAAK,CAAC;YACJ,IAAI,EAAE,mBAAmB,CAAC,IAAI;YAC9B,YAAY,EAAE;gBACZ,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,aAAa,CAAC,iCAAiC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK;gBAC3E,IAAI,EAAE,KAAK;gBACX,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,KAAK;aACb;SACF,CAAC,CAAA;QACF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IAC9B,CAAC;IAED,YAAY,KAAK,OAAO,KAAK,CAAA,CAAC,CAAC;IAE/B,YAAY,CAAC,OAAY,EAAE,QAAuB,EAAE,QAAuC;QACzF,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC;YACxB,MAAM,EAAE,mBAAmB;YAC3B,SAAS,EAAE,QAAQ,CAAC,SAAS;YAC7B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,OAAO;SACR,EAAE,GAAG,CAAC,CAAA;QACP,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,IAAI,CAAC,CAAA;IAClB,CAAC;;AAhCM,wBAAI,GAAG,aAAa,CAAA;AAmC7B,eAAe,mBAAmB,CAAA"}

package/dist/esm/providers/provider-interface.d.ts

@@ -0,0 +1,168 @@
+import React from "react";
+export type ProviderSaveCallback = (err: string | null, statusCode?: number, savedContent?: any) => void;
+export type ProviderOpenCallback = (err: string | null, content?: CloudContent, metadata?: CloudMetadata) => void;
+export type ProviderLoadCallback = ProviderOpenCallback;
+export type ProviderListCallback = (err: string | null, list?: CloudMetadata[]) => void;
+export type ProviderRenameCallback = (err: string | null, metadata?: CloudMetadata) => void;
+export type ProviderRemoveCallback = (err: string) => void;
+export type ProviderCloseCallback = (err: string) => void;
+export type ProviderShareCallback = (err: string, data?: string) => void;
+export declare enum ICloudFileTypes {
+    File = "file",
+    Folder = "folder",
+    Label = "label",
+    Extension = "extension"
+}
+type CloudFileContentType = string;
+interface ICloudFileOpts {
+    content: CloudFileContentType;
+    metadata: CloudMetadata;
+}
+declare class CloudFile {
+    content: CloudFileContentType;
+    metadata: CloudMetadata;
+    constructor(options: ICloudFileOpts);
+}
+declare class CloudMetadata {
+    name: string;
+    docName?: string;
+    description: string;
+    content: CloudContent | string;
+    contentType?: string;
+    url: string;
+    type: ICloudFileTypes;
+    provider: ProviderInterface;
+    parent: CloudMetadata;
+    providerData: any;
+    overwritable: boolean;
+    sharedContentId: string;
+    sharedContentSecretKey: string;
+    mimeType: string;
+    filename: string | null;
+    extension?: string;
+    _permissions?: number;
+    shareEditKey?: string;
+    sharedDocumentId?: string;
+    sharedDocumentUrl?: string;
+    accessKeys?: {
+        readOnly?: string;
+        readWrite?: string;
+    };
+    autoSaveDisabled?: boolean;
+    static Folder: ICloudFileTypes;
+    static File: ICloudFileTypes;
+    static Label: ICloudFileTypes;
+    static Extension: string | null;
+    static ReadableExtensions: string[];
+    constructor(options: Partial<CloudMetadata>);
+    static mapTypeToCloudMetadataType(iType: ICloudFileTypes): ICloudFileTypes;
+    static nameIncludesExtension(name: string): boolean;
+    static withExtension(name: string, defaultExtension?: string, keepOriginalExtension?: boolean): string;
+    static newExtension(name: string, extension: string): string;
+    path(): CloudMetadata[];
+    rename(newName: string): string;
+    updateFilename(): string;
+}
+interface IEnvelopeMetaData {
+    cfmVersion: string;
+    appName: string;
+    appVersion: string;
+    appBuildNum: string;
+}
+declare class CloudContentFactory {
+    isClientContent: (content: unknown) => boolean;
+    envelopeMetadata: IEnvelopeMetaData;
+    constructor();
+    setEnvelopeMetadata(envelopeMetadata: IEnvelopeMetaData): void;
+    createEnvelopedCloudContent(content: any): CloudContent;
+    envelopContent(content: any): CloudContent;
+    _identifyContentFormat(content?: any): CloudContentFormat | undefined;
+    _wrapIfNeeded(content: any): any;
+}
+export interface CloudContentFormat {
+    isCfmWrapped: boolean;
+    isPreCfmFormat: boolean;
+}
+declare class CloudContent {
+    static wrapFileContent: boolean;
+    cfmVersion?: string;
+    metadata?: CloudMetadata;
+    content: any;
+    contentFormat: CloudContentFormat;
+    constructor(content: any, contentFormat: CloudContentFormat);
+    getContent(): any;
+    getContentAsJSON(): string;
+    getClientContent(): any;
+    requiresConversion(): boolean;
+    clone(): CloudContent;
+    setText(text: string): string;
+    getText(): any;
+    addMetadata(metadata: Partial<CloudMetadata>): any[];
+    get(prop: string): any;
+    set(prop: string, value: any): void;
+    remove(prop: string): void;
+    getSharedMetadata(): Partial<CloudMetadata>;
+    copyMetadataTo(to: CloudContent): any[];
+}
+export declare enum ECapabilities {
+    save = "save",
+    resave = "resave",
+    load = "load",
+    list = "list",
+    remove = "remove",
+    rename = "rename",
+    close = "close",
+    export = "export",
+    setFolder = "setFolder"
+}
+type IProviderCapabilities = {
+    [c in ECapabilities]?: boolean | 'auto';
+};
+export type AuthorizedOptions = {
+    forceAuthorization?: boolean;
+};
+export interface IProviderInterfaceOpts {
+    name: string;
+    displayName?: string;
+    urlDisplayName?: string;
+    capabilities: IProviderCapabilities;
+}
+export interface IListOptions {
+    extension?: string;
+}
+declare abstract class ProviderInterface implements IProviderInterfaceOpts {
+    name: string;
+    displayName?: string;
+    urlDisplayName?: string;
+    capabilities: IProviderCapabilities;
+    constructor(options: IProviderInterfaceOpts);
+    static Available(): boolean;
+    static hasValidOptions(options: any): boolean;
+    can(capability: ECapabilities, metadata?: CloudMetadata): boolean;
+    canAuto(capability: ECapabilities): boolean;
+    isAuthorizationRequired(): boolean;
+    authorized(callback: (resp: boolean) => void, options?: AuthorizedOptions): void;
+    authorize(...args: any): void;
+    renderAuthorizationDialog(): void;
+    renderUser(): void;
+    filterTabComponent(capability: ECapabilities, defaultComponent: React.Component): React.Component | null;
+    matchesExtension(name: string, extensions?: string[]): boolean;
+    handleUrlParams(): boolean;
+    dialog(callback: (opts: any) => any): void;
+    save(content: any, metadata: CloudMetadata, callback?: ProviderSaveCallback, disablePatch?: boolean): void;
+    saveAsExport(content: any, metadata: CloudMetadata, callback?: ProviderSaveCallback): void;
+    load(metadata: CloudMetadata, callback?: ProviderLoadCallback): void;
+    list(metadata: CloudMetadata, callback?: ProviderListCallback, options?: IListOptions): void;
+    remove(metadata: CloudMetadata, callback?: ProviderRemoveCallback): void;
+    rename(metadata: CloudMetadata, newName: string, callback?: ProviderRenameCallback): void;
+    close(metadata: CloudMetadata, callback?: ProviderCloseCallback): void;
+    setFolder(metadata: CloudMetadata): void;
+    canOpenSaved(): boolean;
+    openSaved(openSavedParams: any, callback?: ProviderOpenCallback): void;
+    getOpenSavedParams(metadata: CloudMetadata): string | Record<string, string> | void;
+    fileOpened(content: CloudContent, metadata: CloudMetadata): void;
+    _notImplemented(methodName: string): void;
+    fileDialogDisabled(folder: CloudMetadata): boolean;
+}
+declare const cloudContentFactory: CloudContentFactory;
+export { CloudFile, CloudMetadata, CloudContent, cloudContentFactory, ProviderInterface };