@leapdev/app-platform 0.1.0-beta.20 → 0.1.0-beta.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leapdev/app-platform",
-  "version": "0.1.0-beta.20",
+  "version": "0.1.0-beta.22",
   "dependencies": {
     "tslib": "^2.3.0",
     "vkbeautify": "^0.99.3",

package/src/index.d.ts

@@ -1,11 +1,12 @@
 import { EvaluatePathsRequest } from './lib/models';
-import { LeapDocumentData } from './lib/models/leap.model';
+import { HostApplicationType, LeapDocumentData } from './lib/models/leap.model';
 export * from './types';
-export declare const initAppPlatform: (skipLeapEventsSetup?: boolean) => Promise<{
+export declare const initAppPlatform: (hostApplicationType: HostApplicationType, skipLeapEventsSetup?: boolean) => Promise<{
     done: boolean;
     openViaLEAP: boolean;
 }>;
 export declare const getHostInfo: (params: {
+    hostApplicationType: HostApplicationType;
     clientId: string;
 }) => Promise<{
     hostType: string | null;

package/src/index.js

@@ -5,8 +5,8 @@ const tslib_1 = require("tslib");
 const app_platform_1 = require("./lib/app-platform");
 tslib_1.__exportStar(require("./types"), exports);
 const appPlatform = new app_platform_1.AppPlatform();
-const initAppPlatform = (skipLeapEventsSetup = false) => {
-    return appPlatform.init(skipLeapEventsSetup);
+const initAppPlatform = (hostApplicationType, skipLeapEventsSetup = false) => {
+    return appPlatform.init(hostApplicationType, skipLeapEventsSetup);
 };
 exports.initAppPlatform = initAppPlatform;
 const getHostInfo = (params) => {

package/src/lib/app-platform.d.ts

@@ -1,5 +1,5 @@
 import { EvaluatePathsRequest, EvaluatePathsResponse } from './models';
-import { LeapDocumentData, LEAPUser } from './models/leap.model';
+import { HostApplicationType, LeapDocumentData, LEAPUser } from './models/leap.model';
 import { SignalRInitData } from './models/signalr.model';
 export declare class AppPlatform {
     #private;
@@ -10,7 +10,7 @@ export declare class AppPlatform {
     private signalRService;
     private _openViaLEAP;
     constructor();
-    init(skipLeapEventsSetup: boolean, force?: boolean): Promise<{
+    init(hostApplicationType: HostApplicationType, skipLeapEventsSetup: boolean, force?: boolean): Promise<{
         done: boolean;
         openViaLEAP: boolean;
     }>;
@@ -18,6 +18,7 @@ export declare class AppPlatform {
         clientId: string;
     }): Promise<boolean>;
     getHostInfo(params: {
+        hostApplicationType: HostApplicationType;
         clientId: string;
     }): Promise<{
         hostType: string | null;
@@ -31,6 +32,7 @@ export declare class AppPlatform {
         documentId: string;
     }): Promise<boolean>;
     getDocumentData(): Promise<LeapDocumentData | null>;
+    getExcelDocumentData(): Promise<LeapDocumentData | null>;
     setDocumentData(params: {
         documentData: LeapDocumentData;
     }): Promise<boolean>;
@@ -52,4 +54,5 @@ export declare class AppPlatform {
     private setupLeapEvents;
     private setTokenInCustomXml;
     private getWordCustomPart;
+    private isLeapWorkbook;
 }

package/src/lib/app-platform.js

@@ -6,10 +6,12 @@ const tslib_1 = require("tslib");
 const helpers_1 = require("./functions/helpers");
 const constants_1 = require("./models/constants");
 const leap_events_model_1 = require("./models/leap-events.model");
+const leap_model_1 = require("./models/leap.model");
 const services_1 = require("./services");
 const auth_service_1 = require("./services/auth/auth.service");
 const promise_helper_function_1 = require("./services/calc-api/promise-helper.function");
 const custom_xml_part_service_1 = require("./services/custom-xml-part.service");
+const excel_custom_xml_part_service_1 = require("./services/excel-custom-xml-part.service");
 const leap_events_service_1 = require("./services/leap-events.service");
 const signalr_service_1 = require("./services/signalr/signalr.service");
 class AppPlatform {
@@ -25,22 +27,39 @@ class AppPlatform {
         this.documentService = new services_1.DocumentService(this.leapEventsService, this.loggerService);
         this.signalRService = new signalr_service_1.SignalRService();
     }
-    init(skipLeapEventsSetup, force = false) {
+    init(hostApplicationType, skipLeapEventsSetup, force = false) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {
                 if (tslib_1.__classPrivateFieldGet(this, _AppPlatform_initialized, "f") && !force) {
                     return { done: true, openViaLEAP: this._openViaLEAP };
                 }
-                const data = yield this.getWordCustomPart();
-                if (data) {
+                let openViaLEAP = false;
+                switch (hostApplicationType) {
+                    case leap_model_1.HostApplicationType.MicrosoftWord:
+                        this.loggerService.log(`[INIT] Microsoft Word`);
+                        openViaLEAP = !!(yield this.getWordCustomPart());
+                        break;
+                    case leap_model_1.HostApplicationType.MicrosoftExcel:
+                        this.loggerService.log(`[INIT] Microsoft Excel`);
+                        openViaLEAP = yield this.isLeapWorkbook();
+                        break;
+                }
+                if (openViaLEAP) {
                     this._openViaLEAP = true;
                     this.loggerService.log(`[INIT] Setup LEAP Events and set token in custom xml part`);
-                    if (!skipLeapEventsSetup) {
-                        yield this.setupLeapEvents();
-                        yield this.setTokenInCustomXml();
+                    try {
+                        if (hostApplicationType === leap_model_1.HostApplicationType.MicrosoftWord &&
+                            !skipLeapEventsSetup) {
+                            yield this.setupLeapEvents();
+                            yield this.setTokenInCustomXml();
+                        }
+                        tslib_1.__classPrivateFieldSet(this, _AppPlatform_initialized, true, "f");
+                        return { done: true, openViaLEAP: true };
+                    }
+                    catch (_) {
+                        tslib_1.__classPrivateFieldSet(this, _AppPlatform_initialized, true, "f");
+                        return { done: true, openViaLEAP: true };
                     }
-                    tslib_1.__classPrivateFieldSet(this, _AppPlatform_initialized, true, "f");
-                    return { done: true, openViaLEAP: true };
                 }
                 else {
                     this.loggerService.log(`[INIT] Document not open via LEAP`);
@@ -88,14 +107,24 @@ class AppPlatform {
     getHostInfo(params) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {
-                //* check host type in document data custom xml part
-                const documentData = yield this.getDocumentData();
+                let documentData = null;
+                switch (params.hostApplicationType) {
+                    case leap_model_1.HostApplicationType.MicrosoftWord: {
+                        documentData = yield this.getDocumentData();
+                        break;
+                    }
+                    case leap_model_1.HostApplicationType.MicrosoftExcel: {
+                        documentData = yield this.getExcelDocumentData();
+                        break;
+                    }
+                }
                 if (documentData && documentData.hostType) {
                     return {
                         hostType: documentData.hostType,
                         hostVersion: null,
                     };
                 }
+                //* check host type in document data custom xml part
                 //* we connect signalr with client id and try to get init data like host type and version
                 //* when we provide client id, LD would try to issue an code and code challenge for auth
                 //* if it fails, it means client doesn't have a proper redirect uri (fourd)
@@ -210,6 +239,18 @@ class AppPlatform {
             }
         });
     }
+    getExcelDocumentData() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield (0, excel_custom_xml_part_service_1.getDataByNamespace)(constants_1.constants.LeapDocumentDataNamespace);
+                return data;
+            }
+            catch (error) {
+                this.loggerService.error(`[ERROR] Get Excel Document Data: ${error}`);
+                return null;
+            }
+        });
+    }
     setDocumentData(params) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {
@@ -385,6 +426,15 @@ class AppPlatform {
             }
         });
     }
+    isLeapWorkbook() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return yield Excel.run((context) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                const leapUniqueCode = context.workbook.names.getItemOrNullObject('LEAPUniqueCode');
+                yield context.sync();
+                return !leapUniqueCode.isNullObject;
+            }));
+        });
+    }
 }
 exports.AppPlatform = AppPlatform;
 _AppPlatform_authService = new WeakMap(), _AppPlatform_signalRInitData = new WeakMap(), _AppPlatform_initialized = new WeakMap(), _AppPlatform_connectedToSignalR = new WeakMap();

package/src/lib/models/leap.model.d.ts

@@ -23,7 +23,7 @@ export declare class LeapDocumentData {
     wordStyleId?: string | undefined;
     appliedWordStyleVersionId?: string | undefined;
     officeAddInUrl?: string | undefined;
-    hostType: "web" | undefined;
+    hostType: 'web' | undefined;
     isCoauthoringDocument: boolean | undefined;
     sessionId: string | undefined;
     transactionId?: string;
@@ -69,3 +69,9 @@ export type LEAPUser = {
     countryCode: number;
     region: string;
 };
+export declare enum HostApplicationType {
+    UnknownApplication = 0,
+    MicrosoftExcel = 1,
+    MicrosoftWord = 2,
+    MicrosoftOutlook = 3
+}

package/src/lib/models/leap.model.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LeapTemplateData = exports.LeapModelData = exports.LeapRegion = exports.PreviewMode = exports.LeapDocumentData = void 0;
+exports.HostApplicationType = exports.LeapTemplateData = exports.LeapModelData = exports.LeapRegion = exports.PreviewMode = exports.LeapDocumentData = void 0;
 class LeapDocumentData {
     constructor(init) {
         if (init) {
@@ -26,3 +26,10 @@ exports.LeapModelData = LeapModelData;
 class LeapTemplateData {
 }
 exports.LeapTemplateData = LeapTemplateData;
+var HostApplicationType;
+(function (HostApplicationType) {
+    HostApplicationType[HostApplicationType["UnknownApplication"] = 0] = "UnknownApplication";
+    HostApplicationType[HostApplicationType["MicrosoftExcel"] = 1] = "MicrosoftExcel";
+    HostApplicationType[HostApplicationType["MicrosoftWord"] = 2] = "MicrosoftWord";
+    HostApplicationType[HostApplicationType["MicrosoftOutlook"] = 3] = "MicrosoftOutlook";
+})(HostApplicationType || (exports.HostApplicationType = HostApplicationType = {}));

package/src/lib/services/excel-custom-xml-part.service.d.ts

@@ -0,0 +1,14 @@
+export declare const getDataByNamespace: (namespace: string, retries?: number) => Promise<unknown>;
+export declare const updateXmlDataByNamespace: (namespace: string, data: string, rootTagName: string) => Promise<boolean>;
+/**
+ * @remarks This function is not supported in Excel.
+ */
+export declare const addHandlerForCustomXmlPart: (namespace: string, eventType: Office.EventType, handler: unknown) => Promise<void | null>;
+/**
+ * @remarks This function is not supported in Excel.
+ */
+export declare const getChildNodes: (node: Office.CustomXmlNode, xPath?: string) => Promise<Array<Office.CustomXmlNode>>;
+/**
+ * @remarks This function is not supported in Excel.
+ */
+export declare const getNodeText: (node: Office.CustomXmlNode | null) => Promise<string>;

package/src/lib/services/excel-custom-xml-part.service.js

@@ -0,0 +1,193 @@
+"use strict";
+/// <reference types="office-js" />
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNodeText = exports.getChildNodes = exports.addHandlerForCustomXmlPart = exports.updateXmlDataByNamespace = exports.getDataByNamespace = void 0;
+const tslib_1 = require("tslib");
+const xml_1 = require("../functions/xml");
+const retryTimes = 5;
+const getCustomXmlPartsByNamespace = (context, namespace) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    if (context.workbook) {
+        const customXmlParts = context.workbook.customXmlParts;
+        const customXmlCollection = customXmlParts.getByNamespace(namespace);
+        customXmlCollection.load('items');
+        yield context.sync();
+        return customXmlCollection;
+    }
+    else {
+        return null;
+    }
+});
+const getCustomXmlPartByNamespace = (context, namespace) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const customXmlCollection = yield getCustomXmlPartsByNamespace(context, namespace);
+        if (customXmlCollection != null && customXmlCollection.items.length > 0) {
+            return customXmlCollection.items[0];
+        }
+        return null;
+    }
+    catch (error) {
+        console.error(error, `[CustomXmlPartService] (getCustomXmlPartByNamespace) Failed to get custom XML part by namespace`);
+        return null;
+    }
+});
+const getCustomXmlPartData = (context, partOrNamespace) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    try {
+        let customXmlPart;
+        if (typeof partOrNamespace === 'string' || partOrNamespace instanceof String) {
+            customXmlPart = yield getCustomXmlPartByNamespace(context, partOrNamespace);
+        }
+        else {
+            customXmlPart = partOrNamespace;
+        }
+        if (customXmlPart != null) {
+            const xmlResult = customXmlPart.getXml();
+            yield context.sync();
+            const xmlString = xmlResult.value;
+            return (0, xml_1.toObj)(xmlString);
+        }
+        else {
+            return null;
+        }
+    }
+    catch (error) {
+        console.error(error, `[CustomXmlPartService] (getCustomXmlPartData) Failed to get custom XML part data`);
+        throw error;
+    }
+});
+const updateCustomXmlPart = (context, customXmlPart, xml, rootTagName) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    rootTagName = rootTagName || '';
+    const xmlResult = customXmlPart.getXml();
+    yield context.sync();
+    const currentXml = xmlResult.value;
+    if (currentXml.includes(rootTagName)) {
+        try {
+            customXmlPart.setXml(xml);
+            yield context.sync();
+            console.log('[CustomXmlPartService] updateCustomXmlPart succeeded');
+        }
+        catch (error) {
+            console.error(error, '[CustomXmlPartService] updateCustomXmlPart failed');
+            throw error;
+        }
+    }
+    else {
+        console.log(`Could not find ${rootTagName} in the custom XML part`);
+    }
+});
+const addCustomXmlPart = (context, objOrXml, options = { rootTagName: '' }) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    if (context.workbook) {
+        const xml = typeof objOrXml === 'string' || objOrXml instanceof String
+            ? objOrXml
+            : (0, xml_1.toXml)(objOrXml, options.rootTagName, options);
+        const customXmlParts = context.workbook.customXmlParts;
+        customXmlParts.add(xml);
+        yield context.sync();
+    }
+});
+const updateCustomXmlPartData = (context, partOrNamespace, objOrXml, options = { rootTagName: '' }) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    try {
+        let customXmlPart;
+        if (typeof partOrNamespace === 'string' ||
+            partOrNamespace instanceof String) {
+            customXmlPart = yield getCustomXmlPartByNamespace(context, partOrNamespace);
+        }
+        else {
+            customXmlPart = partOrNamespace;
+        }
+        let xml;
+        if (typeof objOrXml === 'string' || objOrXml instanceof String) {
+            xml = objOrXml;
+        }
+        else {
+            xml = (0, xml_1.toXml)(objOrXml, options.rootTagName, options);
+        }
+        if (customXmlPart != null) {
+            yield updateCustomXmlPart(context, customXmlPart, xml, options.rootTagName);
+        }
+        else {
+            yield addCustomXmlPart(context, xml, options);
+        }
+        return true;
+    }
+    catch (error) {
+        console.error(error, `[CustomXmlPartService] (updateCustomXmlPartData) Failed to update ` +
+            `${typeof partOrNamespace === 'string' ? partOrNamespace : ''} custom XML part`);
+        throw error;
+    }
+});
+const retryUpdateCustomXmlPartData = (namespace, data, options, retries = retryTimes) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const { rootTagName } = options;
+    try {
+        console.log(`[CustomXmlPartService] Updating ${namespace} tag ${rootTagName}`);
+        yield Excel.run((context) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+            yield updateCustomXmlPartData(context, namespace, data, options);
+        }));
+    }
+    catch (error) {
+        if (retries > 0) {
+            console.log(`[CustomXmlPartService] Update ${namespace} tag ${rootTagName} failed - Retrying ${retryTimes - retries + 1}...`);
+            yield new Promise((resolve) => setTimeout(resolve, 2000));
+            yield retryUpdateCustomXmlPartData(namespace, data, options, retries - 1);
+        }
+        else {
+            throw error;
+        }
+    }
+});
+const getDataByNamespace = (namespace, retries = 6) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    try {
+        return yield Excel.run((context) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+            return yield getCustomXmlPartData(context, namespace);
+        }));
+    }
+    catch (error) {
+        if (retries > 0) {
+            console.log(`[CustomXmlPartService] Get data from ${namespace} failed - Retrying ${retryTimes - retries + 1}...`);
+            yield new Promise((resolve) => setTimeout(resolve, 2000));
+            return yield (0, exports.getDataByNamespace)(namespace, retries - 1);
+        }
+        else {
+            throw new Error(`Unable to get custom XML part using namespace ${namespace}`);
+        }
+    }
+});
+exports.getDataByNamespace = getDataByNamespace;
+const updateXmlDataByNamespace = (namespace, data, rootTagName) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const options = { rootTagName };
+    yield retryUpdateCustomXmlPartData(namespace, data, options);
+    return true;
+});
+exports.updateXmlDataByNamespace = updateXmlDataByNamespace;
+/**
+ * @remarks This function is not supported in Excel.
+ */
+const addHandlerForCustomXmlPart = (
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+namespace, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+eventType, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+handler) => {
+    throw new Error('addHandlerForCustomXmlPart is not supported in Excel.');
+};
+exports.addHandlerForCustomXmlPart = addHandlerForCustomXmlPart;
+/**
+ * @remarks This function is not supported in Excel.
+ */
+const getChildNodes = (
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+node, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+xPath = '*') => {
+    throw new Error('getChildNodes is not supported in Excel.');
+};
+exports.getChildNodes = getChildNodes;
+/**
+ * @remarks This function is not supported in Excel.
+ */
+const getNodeText = (
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+node) => {
+    throw new Error('getNodeText is not supported in Excel.');
+};
+exports.getNodeText = getNodeText;

package/src/types.d.ts

@@ -1,3 +1,3 @@
 import { EvaluatePathsRequest, EvaluatePathsResponse } from './lib/models';
-import { LeapDocumentData } from './lib/models/leap.model';
-export { EvaluatePathsRequest, EvaluatePathsResponse, LeapDocumentData };
+import { LeapDocumentData, HostApplicationType } from './lib/models/leap.model';
+export { EvaluatePathsRequest, EvaluatePathsResponse, LeapDocumentData, HostApplicationType, };

package/src/types.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LeapDocumentData = exports.EvaluatePathsResponse = exports.EvaluatePathsRequest = void 0;
+exports.HostApplicationType = exports.LeapDocumentData = exports.EvaluatePathsResponse = exports.EvaluatePathsRequest = void 0;
 const models_1 = require("./lib/models");
 Object.defineProperty(exports, "EvaluatePathsRequest", { enumerable: true, get: function () { return models_1.EvaluatePathsRequest; } });
 Object.defineProperty(exports, "EvaluatePathsResponse", { enumerable: true, get: function () { return models_1.EvaluatePathsResponse; } });
 const leap_model_1 = require("./lib/models/leap.model");
 Object.defineProperty(exports, "LeapDocumentData", { enumerable: true, get: function () { return leap_model_1.LeapDocumentData; } });
+Object.defineProperty(exports, "HostApplicationType", { enumerable: true, get: function () { return leap_model_1.HostApplicationType; } });