@concord-consortium/cloud-file-manager 2.1.0-pre.9 → 2.2.1

package/dist/esm/client.js

@@ -83,7 +83,6 @@ class CloudFileManagerClient {
         });
     }
     setAppOptions(appOptions) {
-        var _a, _b, _c, _d;
         let providerName;
         let Provider;
         if (appOptions == null) {
@@ -206,14 +205,14 @@ class CloudFileManagerClient {
         }
         // initialize the cloudContentFactory with all data we want in the envelope
         cloudContentFactory.setEnvelopeMetadata({
-            cfmVersion: '2.1.0-pre.9', // replaced by version number at build time
+            cfmVersion: '2.2.1', // replaced by version number at build time
             appName: this.appOptions.appName || "",
             appVersion: this.appOptions.appVersion || "",
             appBuildNum: this.appOptions.appBuildNum || ""
         });
-        this.newFileOpensInNewTab = (_b = (_a = this.appOptions.ui) === null || _a === void 0 ? void 0 : _a.newFileOpensInNewTab) !== null && _b !== void 0 ? _b : true;
-        this.newFileAddsNewToQuery = (_c = this.appOptions.ui) === null || _c === void 0 ? void 0 : _c.newFileAddsNewToQuery;
-        if ((_d = this.appOptions.ui) === null || _d === void 0 ? void 0 : _d.confirmCloseIfDirty) {
+        this.newFileOpensInNewTab = this.appOptions.ui?.newFileOpensInNewTab ?? true;
+        this.newFileAddsNewToQuery = this.appOptions.ui?.newFileAddsNewToQuery;
+        if (this.appOptions.ui?.confirmCloseIfDirty) {
             this._setupConfirmOnClose();
         }
         return this._startPostMessageListener();
@@ -230,8 +229,7 @@ class CloudFileManagerClient {
         }
     }
     connect() {
-        var _a;
-        (_a = this.connectedPromiseResolver) === null || _a === void 0 ? void 0 : _a.resolve();
+        this.connectedPromiseResolver?.resolve();
         return this._event('connected', { client: this });
     }
     //
@@ -243,7 +241,7 @@ class CloudFileManagerClient {
     //
     processUrlParams() {
         // process the hash params
-        let providerName;
+        let providerName, providerParams, folder;
         const { hashParams } = this.appOptions;
         if (hashParams.sharedContentId) {
             return this.openSharedContent(hashParams.sharedContentId);
@@ -253,7 +251,6 @@ class CloudFileManagerClient {
                 return this.openUrlFile(hashParams.fileParams);
             }
             else {
-                let providerParams;
                 [providerName, providerParams] = hashParams.fileParams.split(':');
                 return this.openProviderFile(providerName, providerParams);
             }
@@ -262,7 +259,6 @@ class CloudFileManagerClient {
             return this.openCopiedFile(hashParams.copyParams);
         }
         else if (hashParams.newInFolderParams) {
-            let folder;
             [providerName, folder] = hashParams.newInFolderParams.split(':');
             return this.createNewInFolder(providerName, folder);
         }
@@ -357,8 +353,7 @@ class CloudFileManagerClient {
         }
     }
     openFile(metadata, callback = null) {
-        var _a;
-        if ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.provider) === null || _a === void 0 ? void 0 : _a.can(ECapabilities.load, metadata)) {
+        if (metadata?.provider?.can(ECapabilities.load, metadata)) {
             this._event('willOpenFile', { op: "openFile" });
             return metadata.provider.load(metadata, (err, content) => {
                 if (err) {
@@ -464,8 +459,7 @@ class CloudFileManagerClient {
     }
     // must be called as a result of user action (e.g. click) to avoid popup blockers
     parseUrlAuthorizeAndOpen() {
-        var _a;
-        if (((_a = this.appOptions.hashParams) === null || _a === void 0 ? void 0 : _a.fileParams) != null) {
+        if (this.appOptions.hashParams?.fileParams != null) {
             const [providerName, providerParams] = this.appOptions.hashParams.fileParams.split(':');
             const provider = this.providers[providerName];
             if (provider) {
@@ -589,8 +583,7 @@ class CloudFileManagerClient {
         });
     }
     saveContent(stringContent, callback = null) {
-        var _a;
-        const provider = ((_a = this.state.metadata) === null || _a === void 0 ? void 0 : _a.provider) || this.autoProvider(ECapabilities.save);
+        const provider = this.state.metadata?.provider || this.autoProvider(ECapabilities.save);
         if (provider != null) {
             return provider.authorized((isAuthorized) => {
                 // we can save the document without authorization in some cases
@@ -607,9 +600,8 @@ class CloudFileManagerClient {
         }
     }
     saveFile(stringContent, metadata, callback = null) {
-        var _a;
         const readonly = metadata && !metadata.overwritable; // only check if metadata exists
-        const resaveable = (_a = metadata === null || metadata === void 0 ? void 0 : metadata.provider) === null || _a === void 0 ? void 0 : _a.can(ECapabilities.resave, metadata);
+        const resaveable = metadata?.provider?.can(ECapabilities.resave, metadata);
         // must be able to 'resave' to save silently, i.e. without save dialog
         if (!readonly && resaveable) {
             return this.saveFileNoDialog(stringContent, metadata, callback);
@@ -619,12 +611,11 @@ class CloudFileManagerClient {
         }
     }
     saveFileNoDialog(stringContent, metadata, callback = null) {
-        var _a, _b;
         this._setState({
             saving: metadata
         });
         let currentContent = this._createOrUpdateCurrentContent(stringContent, metadata);
-        currentContent = ((_b = (_a = this.appOptions).contentSaveFilter) === null || _b === void 0 ? void 0 : _b.call(_a, currentContent)) || currentContent;
+        currentContent = this.appOptions.contentSaveFilter?.(currentContent) || currentContent;
         return metadata.provider.save(currentContent, metadata, (err, statusCode, savedContent) => {
             let failures;
             if (err) {
@@ -687,8 +678,7 @@ class CloudFileManagerClient {
     }
     createCopy(stringContent = null, callback = null) {
         const saveAndOpenCopy = (stringContent) => {
-            var _a;
-            return this.saveCopiedFile(stringContent, (_a = this.state.metadata) === null || _a === void 0 ? void 0 : _a.name, (err, copyParams) => {
+            return this.saveCopiedFile(stringContent, this.state.metadata?.name, (err, copyParams) => {
                 if (err) {
                     return (typeof callback === 'function' ? callback(err) : undefined);
                 }
@@ -715,7 +705,7 @@ class CloudFileManagerClient {
             }
             maxCopyNumber++;
             const value = JSON.stringify({
-                name: (name === null || name === void 0 ? void 0 : name.length) ? `Copy of ${name}` : "Copy of Untitled Document",
+                name: name?.length ? `Copy of ${name}` : "Copy of Untitled Document",
                 stringContent
             });
             window.localStorage.setItem(`${prefix}${maxCopyNumber}`, value);
@@ -772,11 +762,10 @@ class CloudFileManagerClient {
     }
     saveTempFile(callback) {
         return this._event('getContent', { shared: this._sharedMetadata() }, (stringContent) => {
-            var _a;
             const currentContent = this._createOrUpdateCurrentContent(stringContent);
             try {
                 const key = "cfm-tempfile";
-                const name = (_a = this.state.metadata) === null || _a === void 0 ? void 0 : _a.name;
+                const name = this.state.metadata?.name;
                 const value = JSON.stringify({ name, stringContent });
                 window.localStorage.setItem(key, value);
                 const metadata = new CloudMetadata({
@@ -784,10 +773,10 @@ class CloudFileManagerClient {
                     type: CloudMetadata.File
                 });
                 this._fileChanged('savedFile', currentContent, metadata, { saved: true }, "");
-                return callback === null || callback === void 0 ? void 0 : callback(null);
+                return callback?.(null);
             }
             catch (e) {
-                return callback === null || callback === void 0 ? void 0 : callback("Unable to temporarily save copied file");
+                return callback?.("Unable to temporarily save copied file");
             }
         });
     }
@@ -810,8 +799,7 @@ class CloudFileManagerClient {
         }
     }
     _sharedMetadata() {
-        var _a;
-        return ((_a = this.state.currentContent) === null || _a === void 0 ? void 0 : _a.getSharedMetadata()) || {};
+        return this.state.currentContent?.getSharedMetadata() || {};
     }
     shareGetLink() {
         return this._ui.shareDialog(this);
@@ -828,8 +816,7 @@ class CloudFileManagerClient {
         }
     }
     isShared() {
-        var _a;
-        const currentContent = (_a = this.state) === null || _a === void 0 ? void 0 : _a.currentContent;
+        const currentContent = this.state?.currentContent;
         if (currentContent) {
             const unshared = currentContent.get("isUnshared");
             if (!unshared) {
@@ -871,7 +858,7 @@ class CloudFileManagerClient {
                     if (err) {
                         return this.alert(err);
                     }
-                    return callback === null || callback === void 0 ? void 0 : callback(null, sharedContentId, currentContent);
+                    return callback?.(null, sharedContentId, currentContent);
                 });
             });
         }
@@ -888,21 +875,20 @@ class CloudFileManagerClient {
         }
         return this.setShareState(true, (err, sharedContentId, currentContent) => {
             this._fileChanged('sharedFile', currentContent, this.state.metadata);
-            return callback === null || callback === void 0 ? void 0 : callback(null, sharedContentId);
+            return callback?.(null, sharedContentId);
         });
     }
     unshare(callback) {
         return this.setShareState(false, (err, sharedContentId, currentContent) => {
             this._fileChanged('unsharedFile', currentContent, this.state.metadata);
-            return callback === null || callback === void 0 ? void 0 : callback(null);
+            return callback?.(null);
         });
     }
     revertToShared(callback = null) {
-        var _a, _b, _c;
         // Look for sharedDocumentUrl or Url first:
-        const id = ((_a = this.state.currentContent) === null || _a === void 0 ? void 0 : _a.get("sharedDocumentUrl"))
-            || ((_b = this.state.currentContent) === null || _b === void 0 ? void 0 : _b.get("url"))
-            || ((_c = this.state.currentContent) === null || _c === void 0 ? void 0 : _c.get("sharedDocumentId"));
+        const id = this.state.currentContent?.get("sharedDocumentUrl")
+            || this.state.currentContent?.get("url")
+            || this.state.currentContent?.get("sharedDocumentId");
         if (id && (this.state.shareProvider != null)) {
             return this.state.shareProvider.loadSharedContent(id, (err, content, metadata) => {
                 let docName;
@@ -915,7 +901,7 @@ class CloudFileManagerClient {
                     metadata.name = docName;
                 }
                 this._fileOpened(content, metadata, { dirty: true, openedContent: content.clone() });
-                return callback === null || callback === void 0 ? void 0 : callback(null);
+                return callback?.(null);
             });
         }
     }
@@ -927,16 +913,14 @@ class CloudFileManagerClient {
     downloadDialog(callback = null) {
         // should share metadata be included in downloaded local files?
         return this._event('getContent', { shared: this._sharedMetadata() }, (content) => {
-            var _a;
             const envelopedContent = cloudContentFactory.createEnvelopedCloudContent(content);
             if (this.state.currentContent != null) {
                 this.state.currentContent.copyMetadataTo(envelopedContent);
             }
-            return this._ui.downloadDialog((_a = this.state.metadata) === null || _a === void 0 ? void 0 : _a.name, envelopedContent, callback);
+            return this._ui.downloadDialog(this.state.metadata?.name, envelopedContent, callback);
         });
     }
     getDownloadBlob(content, includeShareInfo, mimeType) {
-        var _a;
         let contentToSave;
         if (mimeType == null) {
             mimeType = 'text/plain';
@@ -961,7 +945,7 @@ class CloudFileManagerClient {
             delete json.isUnshared;
             delete json.accessKeys;
             // CODAP moves the keys into its own namespace
-            if (((_a = json.metadata) === null || _a === void 0 ? void 0 : _a.shared) != null) {
+            if (json.metadata?.shared != null) {
                 delete json.metadata.shared;
             }
             contentToSave = JSON.stringify(json);
@@ -978,17 +962,15 @@ class CloudFileManagerClient {
         }
     }
     rename(metadata, newName, callback) {
-        var _a;
         const { dirty } = this.state;
         const _rename = (metadata) => {
-            var _a;
             if (this.state.currentContent != null) {
                 this.state.currentContent.addMetadata({ docName: metadata.name });
             }
             this._fileChanged('renamedFile', this.state.currentContent, metadata, { dirty }, this._getHashParams(metadata));
             const done = () => typeof callback === 'function' ? callback(newName) : undefined;
-            const readOnlyProvider = ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.provider) === null || _a === void 0 ? void 0 : _a.name) === ReadOnlyProvider.Name;
-            if (!readOnlyProvider && ((metadata === null || metadata === void 0 ? void 0 : metadata.provider) || this.autoProvider(ECapabilities.save))) {
+            const readOnlyProvider = metadata?.provider?.name === ReadOnlyProvider.Name;
+            if (!readOnlyProvider && (metadata?.provider || this.autoProvider(ECapabilities.save))) {
                 // autosave renamed file if it has already been saved or can be autosaved
                 this.save(done);
             }
@@ -997,7 +979,7 @@ class CloudFileManagerClient {
             }
         };
         if (newName !== (this.state.metadata != null ? this.state.metadata.name : undefined)) {
-            if ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.provider) === null || _a === void 0 ? void 0 : _a.can(ECapabilities.rename, metadata)) {
+            if (metadata?.provider?.can(ECapabilities.rename, metadata)) {
                 return this.state.metadata.provider.rename(this.state.metadata, newName, (err, metadata) => {
                     if (err) {
                         return this.alert(err);
@@ -1066,10 +1048,9 @@ class CloudFileManagerClient {
     // Saves a file to backend, but does not update current metadata.
     // Used e.g. when exporting .csv files from CODAP
     saveSecondaryFile(stringContent, metadata, callback = null) {
-        var _a;
-        if ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.provider) === null || _a === void 0 ? void 0 : _a.can(ECapabilities["export"], metadata)) {
+        if (metadata?.provider?.can(ECapabilities["export"], metadata)) {
             return metadata.provider.saveAsExport(stringContent, metadata, (err, statusCode) => {
-                return err ? this.alert(err) : callback === null || callback === void 0 ? void 0 : callback(stringContent, metadata);
+                return err ? this.alert(err) : callback?.(stringContent, metadata);
             });
         }
     }
@@ -1084,12 +1065,11 @@ class CloudFileManagerClient {
         }
     }
     shouldAutoSave() {
-        var _a;
         const { metadata } = this.state;
         return (this.state.dirty
-            && !(metadata === null || metadata === void 0 ? void 0 : metadata.autoSaveDisabled)
+            && !metadata?.autoSaveDisabled
             && !this.isSaveInProgress()
-            && ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.provider) === null || _a === void 0 ? void 0 : _a.can(ECapabilities.resave, metadata)));
+            && metadata?.provider?.can(ECapabilities.resave, metadata));
     }
     autoSave(interval) {
         if (this._autoSaveInterval) {
@@ -1109,7 +1089,6 @@ class CloudFileManagerClient {
         return (this._autoSaveInterval != null);
     }
     changeLanguage(newLangCode, callback) {
-        var _a, _b;
         setCurrentLanguage(newLangCode);
         if (callback) {
             const postSave = (err) => {
@@ -1121,7 +1100,7 @@ class CloudFileManagerClient {
                     return callback(newLangCode);
                 }
             };
-            if ((_b = (_a = this.state.metadata) === null || _a === void 0 ? void 0 : _a.provider) === null || _b === void 0 ? void 0 : _b.can(ECapabilities.save)) {
+            if (this.state.metadata?.provider?.can(ECapabilities.save)) {
                 return this.save((err) => postSave(err));
             }
             else {
@@ -1160,6 +1139,7 @@ class CloudFileManagerClient {
         return this.confirmDialog({ message, callback, rejectCallback });
     }
     confirmDialog(params) {
+        this._event("requiresUserInteraction");
         return this._ui.confirmDialog(params);
     }
     alert(message, titleOrCallback, callback) {
@@ -1179,10 +1159,9 @@ class CloudFileManagerClient {
     async onUnload(options) {
         if (options.unloading) {
             return new Promise(resolve => {
-                var _a;
                 // only save if the provider is set - when using linked interactives the provider is not set when
                 // the linked interactive changed and the version choice dialog is showing
-                if ((_a = this.state.metadata) === null || _a === void 0 ? void 0 : _a.provider) {
+                if (this.state.metadata?.provider) {
                     this.save((content, metadata, savedContent) => {
                         // providers can save a different format for the content
                         // for example the interactiveApi provider can save attachments in which case the savedContent
@@ -1226,11 +1205,10 @@ class CloudFileManagerClient {
         return this._event(type, { content: (content != null ? content.getClientContent() : undefined), shared: this._sharedMetadata() });
     }
     _fileOpened(content, metadata, additionalState, hashParams = null) {
-        var _a, _b;
         if (additionalState == null) {
             additionalState = {};
         }
-        const eventData = { content: (_b = (_a = content === null || content === void 0 ? void 0 : content.getClientContent) === null || _a === void 0 ? void 0 : _a.call(content)) !== null && _b !== void 0 ? _b : content };
+        const eventData = { content: content?.getClientContent?.() ?? content };
         // update state before sending 'openedFile' events so that 'openedFile' listeners that
         // reference state have the updated state values
         this._updateState(content, metadata, additionalState, hashParams);
@@ -1256,17 +1234,16 @@ class CloudFileManagerClient {
             metadata,
             saving: null,
             saved: false,
-            dirty: !additionalState.saved && (content === null || content === void 0 ? void 0 : content.requiresConversion()),
+            dirty: !additionalState.saved && content?.requiresConversion(),
             ...additionalState
         };
-        this._setWindowTitle(metadata === null || metadata === void 0 ? void 0 : metadata.name);
+        this._setWindowTitle(metadata?.name);
         if (hashParams !== null) {
             window.location.hash = hashParams;
         }
         return this._setState(state);
     }
     _event(type, data, eventCallback = null) {
-        var _a;
         if (data == null) {
             data = {};
         }
@@ -1280,7 +1257,7 @@ class CloudFileManagerClient {
         // I tried sending the state but that causes CODAP to replace its state which breaks other things.
         // A permanent fix for this would be to send the new filename outside of the state metadata.
         const skipPostMessage = type === "renamedFile";
-        if (((_a = this.appOptions) === null || _a === void 0 ? void 0 : _a.sendPostMessageClientEvents) && this.iframe && !skipPostMessage) {
+        if (this.appOptions?.sendPostMessageClientEvents && this.iframe && !skipPostMessage) {
             return event.postMessage(this.iframe.contentWindow);
         }
     }
@@ -1300,9 +1277,8 @@ class CloudFileManagerClient {
         });
     }
     _closeCurrentFile() {
-        var _a;
         const { metadata } = this.state;
-        if ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.provider) === null || _a === void 0 ? void 0 : _a.can(ECapabilities.close, metadata)) {
+        if (metadata?.provider?.can(ECapabilities.close, metadata)) {
             return metadata.provider.close(metadata);
         }
     }
@@ -1321,8 +1297,7 @@ class CloudFileManagerClient {
         return currentContent;
     }
     _setWindowTitle(name) {
-        var _a;
-        if ((_a = this.appOptions) === null || _a === void 0 ? void 0 : _a.appSetsWindowTitle) {
+        if (this.appOptions?.appSetsWindowTitle) {
             return;
         }
         const { ui } = this.appOptions;
@@ -1337,13 +1312,12 @@ class CloudFileManagerClient {
         }
     }
     _getHashParams(metadata) {
-        var _a, _b;
-        const canOpenSaved = ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.provider) === null || _a === void 0 ? void 0 : _a.canOpenSaved()) || false;
-        let openSavedParams = canOpenSaved ? (_b = metadata === null || metadata === void 0 ? void 0 : metadata.provider) === null || _b === void 0 ? void 0 : _b.getOpenSavedParams(metadata) : null;
+        const canOpenSaved = metadata?.provider?.canOpenSaved() || false;
+        let openSavedParams = canOpenSaved ? metadata?.provider?.getOpenSavedParams(metadata) : null;
         if (canOpenSaved && (openSavedParams != null) && (typeof openSavedParams === "string")) {
             return `#file=${metadata.provider.urlDisplayName || metadata.provider.name}:${encodeURIComponent(openSavedParams)}`;
         }
-        else if ((metadata === null || metadata === void 0 ? void 0 : metadata.provider) instanceof URLProvider && (window.location.hash.indexOf("#file=http") === 0)) {
+        else if (metadata?.provider instanceof URLProvider && (window.location.hash.indexOf("#file=http") === 0)) {
             return window.location.hash; // leave it alone
         }
         else {
@@ -1352,7 +1326,6 @@ class CloudFileManagerClient {
     }
     _startPostMessageListener() {
         return $(window).on('message', e => {
-            var _a, _b;
             const oe = e.originalEvent;
             const data = oe.data || {};
             const reply = function (type, params) {
@@ -1362,7 +1335,7 @@ class CloudFileManagerClient {
                 const message = _.merge({}, params, { type });
                 return oe.source.postMessage(message, oe.origin);
             };
-            switch (data === null || data === void 0 ? void 0 : data.type) {
+            switch (data?.type) {
                 case 'cfm::getCommands':
                     return reply('cfm::commands', { commands: ['cfm::autosave', 'cfm::event', 'cfm::event:reply', 'cfm::setDirty', 'cfm::iframedClientConnected'] });
                 case 'cfm::autosave':
@@ -1379,13 +1352,13 @@ class CloudFileManagerClient {
                     });
                 case 'cfm::event:reply': {
                     const event = CLOUDFILEMANAGER_EVENTS[data.eventId];
-                    const callbackData = JSON.parse((data === null || data === void 0 ? void 0 : data.callbackArgs) || null);
-                    return (_a = event === null || event === void 0 ? void 0 : event.callback) === null || _a === void 0 ? void 0 : _a.apply(this, callbackData);
+                    const callbackData = JSON.parse(data?.callbackArgs || null);
+                    return event?.callback?.apply(this, callbackData);
                 }
                 case 'cfm::setDirty':
                     return this.dirty(data.isDirty);
                 case 'cfm::iframedClientConnected':
-                    (_b = this.connectedPromiseResolver) === null || _b === void 0 ? void 0 : _b.resolve();
+                    this.connectedPromiseResolver?.resolve();
                     return this.processUrlParams();
             }
         });
@@ -1400,8 +1373,7 @@ class CloudFileManagerClient {
         });
     }
     _filterLoadedContent(content) {
-        var _a, _b;
-        return ((_b = (_a = this.appOptions).contentLoadFilter) === null || _b === void 0 ? void 0 : _b.call(_a, content)) || content;
+        return this.appOptions.contentLoadFilter?.(content) || content;
     }
 }
 export { CloudFileManagerClientEvent, CloudFileManagerClient };