dataverse-utils 2.5.2 → 2.6.0

package/lib/assemblyDeploy.js

@@ -8,6 +8,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const pluginAssembly_1 = require("./models/pluginAssembly");
 const pluginPackage_1 = require("./models/pluginPackage");
+const customApi_1 = require("./models/customApi");
 const logger_1 = require("./logger");
 async function assemblyDeploy(creds, apiConfig) {
     const currentPath = '.';
@@ -17,10 +18,11 @@ async function assemblyDeploy(creds, apiConfig) {
         return;
     }
     const config = JSON.parse(configFile);
-    if (config.prefix) {
+    let assemblyId;
+    if (config.assembly) {
         logger_1.logger.info('deploy plugin package');
         try {
-            await (0, pluginPackage_1.deployPluginPackage)(config, apiConfig, creds.solution);
+            assemblyId = await (0, pluginPackage_1.deployPluginPackage)(config, apiConfig, creds.solution);
         }
         catch (error) {
             logger_1.logger.error(error.message);
@@ -31,7 +33,7 @@ async function assemblyDeploy(creds, apiConfig) {
     else {
         logger_1.logger.info('deploy assembly');
         try {
-            await (0, pluginAssembly_1.deployAssembly)(config, apiConfig, creds.solution);
+            assemblyId = await (0, pluginAssembly_1.deployAssembly)(config, apiConfig, creds.solution);
         }
         catch (error) {
             logger_1.logger.error(error.message);
@@ -39,5 +41,14 @@ async function assemblyDeploy(creds, apiConfig) {
         }
         logger_1.logger.done(`deployed assembly ${config.name}\r\n`);
     }
+    if (config.customapis != null && assemblyId) {
+        try {
+            const promises = config.customapis.map((a) => (0, customApi_1.deployApi)(a, assemblyId, apiConfig, creds.solution));
+            await Promise.all(promises);
+        }
+        catch (error) {
+            logger_1.logger.error(error.message);
+        }
+    }
 }
 exports.assemblyDeploy = assemblyDeploy;

package/lib/models/customApi.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retrieveApi = exports.deployApi = void 0;
+const node_1 = require("dataverse-webapi/lib/node");
+const pluginType_1 = require("./pluginType");
+const logger_1 = require("../logger");
+async function deployApi(api, assemblyId, apiConfig, solution) {
+    let apiId = await retrieveApi(api.name, apiConfig);
+    if (api.plugintype) {
+        const pluginTypeId = await (0, pluginType_1.retrieveType)(api.plugintype ?? '', assemblyId, apiConfig);
+        if (pluginTypeId === '') {
+            logger_1.logger.error(`unable to find plugin type ${api.plugintype}`);
+            return;
+        }
+        delete api.plugintype;
+        api['PluginTypeId@odata.bind'] = `plugintypes(${pluginTypeId})`;
+    }
+    if (apiId != '') {
+        try {
+            await updateApi(apiId, api, apiConfig);
+        }
+        catch (error) {
+            throw new Error(`failed to update custom api: ${error.message}`);
+        }
+    }
+    else {
+        try {
+            apiId = await createApi(api, apiConfig, solution);
+        }
+        catch (error) {
+            throw new Error(`failed to create custom api: ${error.message}`);
+        }
+    }
+}
+exports.deployApi = deployApi;
+async function retrieveApi(name, apiConfig) {
+    const options = `$select=customapiid&$filter=name eq '${name}'`;
+    const result = await (0, node_1.retrieveMultiple)(apiConfig, 'customapis', options);
+    return result.value.length > 0 ? result.value[0].customapiid : '';
+}
+exports.retrieveApi = retrieveApi;
+async function createApi(api, apiConfig, solution) {
+    logger_1.logger.info(`create custom api ${api.name}`);
+    const options = {};
+    if (solution) {
+        options.customHeaders = { 'MSCRM.SolutionUniqueName': solution };
+    }
+    const result = await (0, node_1.createWithReturnData)(apiConfig, 'plugintypes', api, '$select=plugintypeid', options);
+    if (result.error) {
+        throw new Error(result.error.message);
+    }
+    return result.customapiid;
+}
+async function updateApi(id, api, apiConfig) {
+    logger_1.logger.info(`update custom api ${api.name}`);
+    const record = {
+        displayname: api.displayname,
+        description: api.description,
+        name: api.name,
+        executeprivilegename: api.executeprivilegename
+    };
+    if (api['PluginTypeId@odata.bind']) {
+        record['PluginTypeId@odata.bind'] = api['PluginTypeId@odata.bind'];
+    }
+    else {
+        record['PluginTypeId@odata.bind'] = null;
+    }
+    return (0, node_1.update)(apiConfig, 'customapis', id, api);
+}

package/lib/models/pluginAssembly.js

@@ -8,7 +8,6 @@ const fs_1 = __importDefault(require("fs"));
 const glob_1 = __importDefault(require("glob"));
 const node_1 = require("dataverse-webapi/lib/node");
 const pluginType_1 = require("./pluginType");
-const dataverse_service_1 = require("../dataverse.service");
 const logger_1 = require("../logger");
 async function deployAssembly(config, apiConfig, solution) {
     const files = glob_1.default.sync(`**/${config.name}.dll`);
@@ -35,25 +34,17 @@ async function deployAssembly(config, apiConfig, solution) {
     }
     else {
         try {
-            assemblyId = await createAssembly(config, content, apiConfig);
+            assemblyId = await createAssembly(config, content, apiConfig, solution);
         }
         catch (error) {
             throw new Error(`failed to create assembly: ${error.message}`);
         }
-        if (solution != undefined) {
-            try {
-                await (0, dataverse_service_1.addToSolution)(assemblyId, solution, dataverse_service_1.ComponentType.PluginAssembly, apiConfig);
-            }
-            catch (error) {
-                logger_1.logger.error(`failed to add to solution: ${error.message}`);
-            }
-        }
     }
     if (config.types != null) {
         try {
-            const promises = config.types.map(async (type) => {
+            const promises = config.types.map((type) => {
                 type['pluginassemblyid@odata.bind'] = `/pluginassemblies(${assemblyId})`;
-                await (0, pluginType_1.deployType)(type, assemblyId, apiConfig, solution);
+                return (0, pluginType_1.deployType)(type, assemblyId, apiConfig, solution);
             });
             await Promise.all(promises);
         }
@@ -62,6 +53,7 @@ async function deployAssembly(config, apiConfig, solution) {
             return;
         }
     }
+    return assemblyId;
 }
 exports.deployAssembly = deployAssembly;
 async function retrieveAssembly(name, apiConfig) {
@@ -69,7 +61,7 @@ async function retrieveAssembly(name, apiConfig) {
     const result = await (0, node_1.retrieveMultiple)(apiConfig, 'pluginassemblies', options);
     return result.value.length > 0 ? result.value[0].pluginassemblyid : '';
 }
-async function createAssembly(config, content, apiConfig) {
+async function createAssembly(config, content, apiConfig, solution) {
     logger_1.logger.info(`create assembly ${config.name}`);
     const assembly = {
         name: config.name,
@@ -80,7 +72,11 @@ async function createAssembly(config, content, apiConfig) {
         sourcetype: 0,
         culture: ''
     };
-    const result = await (0, node_1.createWithReturnData)(apiConfig, 'pluginassemblies', assembly, '$select=pluginassemblyid');
+    const options = {};
+    if (solution) {
+        options.customHeaders = { 'MSCRM.SolutionUniqueName': solution };
+    }
+    const result = await (0, node_1.createWithReturnData)(apiConfig, 'pluginassemblies', assembly, '$select=pluginassemblyid', options);
     if (result.error) {
         throw new Error(result.error.message);
     }

package/lib/models/pluginPackage.js

@@ -8,7 +8,6 @@ const fs_1 = __importDefault(require("fs"));
 const glob_1 = __importDefault(require("glob"));
 const node_1 = require("dataverse-webapi/lib/node");
 const pluginAssembly_1 = require("./pluginAssembly");
-const dataverse_service_1 = require("../dataverse.service");
 const logger_1 = require("../logger");
 async function deployPluginPackage(config, apiConfig, solution) {
     const files = glob_1.default.sync(`**/${config.name}.*.nupkg`);
@@ -35,30 +34,24 @@ async function deployPluginPackage(config, apiConfig, solution) {
     }
     else {
         try {
-            packageId = await createPackage(config, content, apiConfig);
+            packageId = await createPackage(config, content, apiConfig, solution);
         }
         catch (error) {
             throw new Error(`failed to create package: ${error.message}`);
         }
-        if (solution != undefined) {
-            try {
-                await (0, dataverse_service_1.addToSolution)(packageId, solution, dataverse_service_1.ComponentType.PluginPackage, apiConfig);
-            }
-            catch (error) {
-                logger_1.logger.error(`failed to add package to solution: ${error.message}`);
-            }
-        }
     }
+    let assemblyId;
     if (config.assembly != null) {
         try {
             config.assembly['packageid@odata.bind'] = `/pluginpackages(${packageId})`;
-            await (0, pluginAssembly_1.deployAssembly)(config.assembly, apiConfig, solution);
+            assemblyId = await (0, pluginAssembly_1.deployAssembly)(config.assembly, apiConfig, solution);
         }
         catch (error) {
             logger_1.logger.error(error.message);
             return;
         }
     }
+    return assemblyId;
 }
 exports.deployPluginPackage = deployPluginPackage;
 async function retrievePackage(prefix, name, apiConfig) {
@@ -66,14 +59,18 @@ async function retrievePackage(prefix, name, apiConfig) {
     const result = await (0, node_1.retrieveMultiple)(apiConfig, 'pluginpackages', options);
     return result.value.length > 0 ? result.value[0].pluginassemblyid : '';
 }
-async function createPackage(config, content, apiConfig) {
+async function createPackage(config, content, apiConfig, solution) {
     logger_1.logger.info(`create package ${config.name}`);
     const pluginPackage = {
         name: `${config.prefix}_${config.name}`,
         version: config.version,
         content: content
     };
-    const result = await (0, node_1.createWithReturnData)(apiConfig, 'pluginpackages', pluginPackage, '$select=pluginpackageid');
+    const options = {};
+    if (solution) {
+        options.customHeaders = { 'MSCRM.SolutionUniqueName': solution };
+    }
+    const result = await (0, node_1.createWithReturnData)(apiConfig, 'pluginpackages', pluginPackage, '$select=pluginpackageid', options);
     if (result.error) {
         throw new Error(result.error.message);
     }

package/lib/models/pluginStep.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deployStep = void 0;
 const node_1 = require("dataverse-webapi/lib/node");
-const dataverse_service_1 = require("../dataverse.service");
 const logger_1 = require("../logger");
 const pluginImage_1 = require("./pluginImage");
 async function deployStep(step, typeId, apiConfig, solution) {
@@ -39,19 +38,11 @@ async function deployStep(step, typeId, apiConfig, solution) {
     }
     else {
         try {
-            stepId = await createStep(step, apiConfig);
+            stepId = await createStep(step, apiConfig, solution);
         }
         catch (error) {
             throw new Error(`failed to create plugin step: ${error.message}`);
         }
-        if (solution != undefined) {
-            try {
-                await (0, dataverse_service_1.addToSolution)(stepId, solution, dataverse_service_1.ComponentType.SDKMessageProcessingStep, apiConfig);
-            }
-            catch (error) {
-                throw new Error(`failed to add to solution: ${error.message}`);
-            }
-        }
     }
     if (images && images.length > 0) {
         try {
@@ -83,9 +74,13 @@ async function getSdkMessageId(name, apiConfig) {
     const message = await (0, node_1.retrieveMultiple)(apiConfig, 'sdkmessages', options);
     return message.value.length > 0 ? message.value[0].sdkmessageid : '';
 }
-async function createStep(step, apiConfig) {
+async function createStep(step, apiConfig, solution) {
     logger_1.logger.info(`create plugin step ${step.name}`);
-    const result = await (0, node_1.createWithReturnData)(apiConfig, 'sdkmessageprocessingsteps', step, '$select=sdkmessageprocessingstepid');
+    const options = {};
+    if (solution) {
+        options.customHeaders = { 'MSCRM.SolutionUniqueName': solution };
+    }
+    const result = await (0, node_1.createWithReturnData)(apiConfig, 'sdkmessageprocessingsteps', step, '$select=sdkmessageprocessingstepid', options);
     if (result.error) {
         throw new Error(result.error.message);
     }

package/lib/models/pluginType.js

@@ -1,21 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deployType = void 0;
+exports.retrieveType = exports.deployType = void 0;
 const node_1 = require("dataverse-webapi/lib/node");
 const pluginStep_1 = require("./pluginStep");
 const logger_1 = require("../logger");
-async function deployType(type, assemblyId, apiConfig, solution) {
-    let typeId = await retrieveType(type.typename, assemblyId, apiConfig);
-    const record = {
-        name: type.name,
-        friendlyname: type.friendlyname,
-        typename: type.typename,
-        'pluginassemblyid@odata.bind': type['pluginassemblyid@odata.bind'],
-        workflowactivitygroupname: type.workflowactivitygroupname
+async function deployType(config, assemblyId, apiConfig, solution) {
+    let typeId = await retrieveType(config.typename, assemblyId, apiConfig);
+    const type = {
+        name: config.name,
+        friendlyname: config.friendlyname,
+        typename: config.typename,
+        'pluginassemblyid@odata.bind': config['pluginassemblyid@odata.bind'],
+        workflowactivitygroupname: config.workflowactivitygroupname
     };
     if (typeId != '') {
         try {
-            await updateType(typeId, record, apiConfig);
+            await updateType(typeId, type, apiConfig);
         }
         catch (error) {
             throw new Error(`failed to update plugin type: ${error.message}`);
@@ -23,17 +23,17 @@ async function deployType(type, assemblyId, apiConfig, solution) {
     }
     else {
         try {
-            typeId = await createType(record, apiConfig);
+            typeId = await createType(type, apiConfig);
         }
         catch (error) {
             throw new Error(`failed to create plugin type: ${error.message}`);
         }
     }
     try {
-        if (type.steps) {
-            const promises = type.steps.map(async (step) => {
+        if (config.steps) {
+            const promises = config.steps.map((step) => {
                 step['plugintypeid@odata.bind'] = `/plugintypes(${typeId})`;
-                await (0, pluginStep_1.deployStep)(step, typeId, apiConfig, solution);
+                return (0, pluginStep_1.deployStep)(step, typeId, apiConfig, solution);
             });
             await Promise.all(promises);
         }
@@ -49,6 +49,7 @@ async function retrieveType(name, assemblyId, apiConfig) {
     const result = await (0, node_1.retrieveMultiple)(apiConfig, 'plugintypes', options);
     return result.value.length > 0 ? result.value[0].plugintypeid : '';
 }
+exports.retrieveType = retrieveType;
 async function createType(type, apiConfig) {
     logger_1.logger.info(`create assembly type ${type.name}`);
     const result = await (0, node_1.createWithReturnData)(apiConfig, 'plugintypes', type, '$select=plugintypeid');

package/lib/models/webResource.js

@@ -75,19 +75,11 @@ async function deploy(webResources, apiConfig, solution, files) {
         }
         else {
             try {
-                resourceId = await createResource(resource, content, apiConfig);
+                resourceId = await createResource(resource, content, apiConfig, solution);
             }
             catch (error) {
                 logger_1.logger.error(`failed to create resource: ${error.message}`);
             }
-            if (solution != undefined) {
-                try {
-                    await (0, dataverse_service_1.addToSolution)(resourceId, solution, dataverse_service_1.ComponentType.WebResource, apiConfig);
-                }
-                catch (error) {
-                    logger_1.logger.error(`failed to add to solution: ${error.message}`);
-                }
-            }
         }
     });
     await Promise.all(promises);
@@ -107,7 +99,7 @@ async function retrieveResource(name, apiConfig) {
     const result = await (0, node_1.retrieveMultiple)(apiConfig, 'webresourceset', options);
     return result.value.length > 0 ? result.value[0].webresourceid : '';
 }
-async function createResource(resource, content, apiConfig) {
+async function createResource(resource, content, apiConfig, solution) {
     logger_1.logger.info(`create web resource ${resource.name}`);
     const webResource = {
         webresourcetype: getWebResourceType(resource.type),
@@ -115,7 +107,11 @@ async function createResource(resource, content, apiConfig) {
         displayname: resource.displayname || resource.name,
         content: content
     };
-    const result = await (0, node_1.createWithReturnData)(apiConfig, 'webresourceset', webResource, '$select=webresourceid');
+    const options = {};
+    if (solution) {
+        options.customHeaders = { 'MSCRM.SolutionUniqueName': solution };
+    }
+    const result = await (0, node_1.createWithReturnData)(apiConfig, 'webresourceset', webResource, '$select=webresourceid', options);
     if (result.error) {
         throw new Error(result.error.message);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dataverse-utils",
-  "version": "2.5.2",
+  "version": "2.6.0",
   "license": "MIT",
   "description": "Utilities for interacting with Dataverse environments",
   "main": "lib/index.js",
@@ -20,10 +20,10 @@
     "clean": "rimraf lib"
   },
   "dependencies": {
-    "@azure/msal-node": "^1.12.0",
+    "@azure/msal-node": "^1.14.5",
     "commander": "^8.3.0",
     "cryptr": "^6.0.3",
-    "dataverse-webapi": "^2.2.0",
+    "dataverse-webapi": "^2.3.0",
     "envinfo": "^7.8.1",
     "figures": "^3.2.0",
     "glob": "^7.2.0",