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

package/dist/cjs/app-options.d.ts

@@ -105,6 +105,7 @@ export interface CFMAppOptions {
     appName?: string;
     appVersion?: string;
     appIcon?: string;
+    appFocusRingIcon?: string;
     appBuildNum?: string;
     appOrMenuElemId?: string;
     hideMenuBar?: boolean;
@@ -113,6 +114,7 @@ export interface CFMAppOptions {
     wrapFileContent?: boolean;
     isClientContent?: (content: unknown) => boolean;
     mimeType?: string;
+    localFileMimeType?: string;
     readableMimeTypes?: string[];
     extension?: string;
     readableExtensions?: string[];

package/dist/cjs/client.js

@@ -113,7 +113,6 @@ class CloudFileManagerClient {
         });
     }
     setAppOptions(appOptions) {
-        var _a, _b, _c, _d;
         let providerName;
         let Provider;
         if (appOptions == null) {
@@ -236,14 +235,14 @@ class CloudFileManagerClient {
         }
         // initialize the cloudContentFactory with all data we want in the envelope
         provider_interface_1.cloudContentFactory.setEnvelopeMetadata({
-            cfmVersion: '2.1.0-pre.9', // replaced by version number at build time
+            cfmVersion: '2.2.0', // 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();
@@ -260,8 +259,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 });
     }
     //
@@ -273,7 +271,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);
@@ -283,7 +281,6 @@ class CloudFileManagerClient {
                 return this.openUrlFile(hashParams.fileParams);
             }
             else {
-                let providerParams;
                 [providerName, providerParams] = hashParams.fileParams.split(':');
                 return this.openProviderFile(providerName, providerParams);
             }
@@ -292,7 +289,6 @@ class CloudFileManagerClient {
             return this.openCopiedFile(hashParams.copyParams);
         }
         else if (hashParams.newInFolderParams) {
-            let folder;
             [providerName, folder] = hashParams.newInFolderParams.split(':');
             return this.createNewInFolder(providerName, folder);
         }
@@ -387,8 +383,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(provider_interface_1.ECapabilities.load, metadata)) {
+        if (metadata?.provider?.can(provider_interface_1.ECapabilities.load, metadata)) {
             this._event('willOpenFile', { op: "openFile" });
             return metadata.provider.load(metadata, (err, content) => {
                 if (err) {
@@ -494,8 +489,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) {
@@ -619,8 +613,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(provider_interface_1.ECapabilities.save);
+        const provider = this.state.metadata?.provider || this.autoProvider(provider_interface_1.ECapabilities.save);
         if (provider != null) {
             return provider.authorized((isAuthorized) => {
                 // we can save the document without authorization in some cases
@@ -637,9 +630,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(provider_interface_1.ECapabilities.resave, metadata);
+        const resaveable = metadata?.provider?.can(provider_interface_1.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);
@@ -649,12 +641,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) {
@@ -717,8 +708,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);
                 }
@@ -745,7 +735,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);
@@ -802,11 +792,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 provider_interface_1.CloudMetadata({
@@ -814,10 +803,10 @@ class CloudFileManagerClient {
                     type: provider_interface_1.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");
             }
         });
     }
@@ -840,8 +829,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);
@@ -858,8 +846,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) {
@@ -901,7 +888,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);
                 });
             });
         }
@@ -918,21 +905,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;
@@ -945,7 +931,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);
             });
         }
     }
@@ -957,16 +943,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 = provider_interface_1.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';
@@ -991,7 +975,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);
@@ -1008,17 +992,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) === readonly_provider_1.default.Name;
-            if (!readOnlyProvider && ((metadata === null || metadata === void 0 ? void 0 : metadata.provider) || this.autoProvider(provider_interface_1.ECapabilities.save))) {
+            const readOnlyProvider = metadata?.provider?.name === readonly_provider_1.default.Name;
+            if (!readOnlyProvider && (metadata?.provider || this.autoProvider(provider_interface_1.ECapabilities.save))) {
                 // autosave renamed file if it has already been saved or can be autosaved
                 this.save(done);
             }
@@ -1027,7 +1009,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(provider_interface_1.ECapabilities.rename, metadata)) {
+            if (metadata?.provider?.can(provider_interface_1.ECapabilities.rename, metadata)) {
                 return this.state.metadata.provider.rename(this.state.metadata, newName, (err, metadata) => {
                     if (err) {
                         return this.alert(err);
@@ -1096,10 +1078,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(provider_interface_1.ECapabilities["export"], metadata)) {
+        if (metadata?.provider?.can(provider_interface_1.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);
             });
         }
     }
@@ -1114,12 +1095,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(provider_interface_1.ECapabilities.resave, metadata)));
+            && metadata?.provider?.can(provider_interface_1.ECapabilities.resave, metadata));
     }
     autoSave(interval) {
         if (this._autoSaveInterval) {
@@ -1139,7 +1119,6 @@ class CloudFileManagerClient {
         return (this._autoSaveInterval != null);
     }
     changeLanguage(newLangCode, callback) {
-        var _a, _b;
         (0, translate_1.setCurrentLanguage)(newLangCode);
         if (callback) {
             const postSave = (err) => {
@@ -1151,7 +1130,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(provider_interface_1.ECapabilities.save)) {
+            if (this.state.metadata?.provider?.can(provider_interface_1.ECapabilities.save)) {
                 return this.save((err) => postSave(err));
             }
             else {
@@ -1190,6 +1169,7 @@ class CloudFileManagerClient {
         return this.confirmDialog({ message, callback, rejectCallback });
     }
     confirmDialog(params) {
+        this._event("requiresUserInteraction");
         return this._ui.confirmDialog(params);
     }
     alert(message, titleOrCallback, callback) {
@@ -1209,10 +1189,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
@@ -1256,11 +1235,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);
@@ -1286,17 +1264,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 = {};
         }
@@ -1310,7 +1287,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);
         }
     }
@@ -1330,9 +1307,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(provider_interface_1.ECapabilities.close, metadata)) {
+        if (metadata?.provider?.can(provider_interface_1.ECapabilities.close, metadata)) {
             return metadata.provider.close(metadata);
         }
     }
@@ -1351,8 +1327,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;
@@ -1367,13 +1342,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 url_provider_1.default && (window.location.hash.indexOf("#file=http") === 0)) {
+        else if (metadata?.provider instanceof url_provider_1.default && (window.location.hash.indexOf("#file=http") === 0)) {
             return window.location.hash; // leave it alone
         }
         else {
@@ -1382,7 +1356,6 @@ class CloudFileManagerClient {
     }
     _startPostMessageListener() {
         return (0, jquery_1.default)(window).on('message', e => {
-            var _a, _b;
             const oe = e.originalEvent;
             const data = oe.data || {};
             const reply = function (type, params) {
@@ -1392,7 +1365,7 @@ class CloudFileManagerClient {
                 const message = lodash_1.default.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':
@@ -1409,13 +1382,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();
             }
         });
@@ -1430,8 +1403,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;
     }
 }
 exports.CloudFileManagerClient = CloudFileManagerClient;