dataverse-utils 2.5.2 → 2.5.3

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,15 @@ async function assemblyDeploy(creds, apiConfig) {
         }
         logger_1.logger.done(`deployed assembly ${config.name}\r\n`);
     }
+    if (config.customApis && config.customApis.length > 0 && assemblyId) {
+        try {
+            const promises = config.customApis.map(a => (0, customApi_1.deployApi)(a, apiConfig, creds.solution, assemblyId ?? ''));
+            await Promise.all(promises);
+        }
+        catch (error) {
+            logger_1.logger.error(error.message);
+            return;
+        }
+    }
 }
 exports.assemblyDeploy = assemblyDeploy;

package/lib/models/customApi.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deployApi = exports.ParameterType = exports.BindingType = exports.CustomProcessingStepType = void 0;
+const node_1 = require("dataverse-webapi/lib/node");
+const pluginType_1 = require("./pluginType");
+const logger_1 = require("../logger");
+var CustomProcessingStepType;
+(function (CustomProcessingStepType) {
+})(CustomProcessingStepType = exports.CustomProcessingStepType || (exports.CustomProcessingStepType = {}));
+var BindingType;
+(function (BindingType) {
+})(BindingType = exports.BindingType || (exports.BindingType = {}));
+var ParameterType;
+(function (ParameterType) {
+})(ParameterType = exports.ParameterType || (exports.ParameterType = {}));
+async function deployApi(config, apiConfig, solution, assemblyId) {
+    const apiId = await retrieveApi(config.name, apiConfig);
+    const pluginTypeId = await (0, pluginType_1.retrieveType)(config.pluginType ?? '', assemblyId, apiConfig);
+    if (pluginTypeId === '') {
+        logger_1.logger.error(`Unable to retrieve plugin type ${config.pluginType}`);
+        return;
+    }
+    delete config.pluginType;
+    config['PluginTypeId@odata.bind'] = `plugintypes(${pluginTypeId})`;
+    if (apiId != '') {
+        try {
+            await updateApi(apiId, config, apiConfig);
+        }
+        catch (error) {
+            throw new Error(`failed to update customa api: ${error.message}`);
+        }
+    }
+    else {
+        try {
+            await createApi(config, solution, apiConfig);
+        }
+        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 : '';
+}
+async function createApi(api, solution, apiConfig) {
+    logger_1.logger.info(`create custom api ${api.displayname}`);
+    const result = await (0, node_1.createWithReturnData)(apiConfig, 'customapis', api, '$select=customapiid');
+    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.displayname}`);
+    return (0, node_1.update)(apiConfig, 'customapis', id, api);
+}

package/lib/models/pluginAssembly.js

@@ -62,6 +62,7 @@ async function deployAssembly(config, apiConfig, solution) {
             return;
         }
     }
+    return assemblyId;
 }
 exports.deployAssembly = deployAssembly;
 async function retrieveAssembly(name, apiConfig) {
@@ -80,6 +81,9 @@ async function createAssembly(config, content, apiConfig) {
         sourcetype: 0,
         culture: ''
     };
+    if (config['packageid@odata.bind']) {
+        assembly['packageid@odata.bind'] = config['packageid@odata.bind'];
+    }
     const result = await (0, node_1.createWithReturnData)(apiConfig, 'pluginassemblies', assembly, '$select=pluginassemblyid');
     if (result.error) {
         throw new Error(result.error.message);

package/lib/models/pluginPackage.js

@@ -18,6 +18,7 @@ async function deployPluginPackage(config, apiConfig, solution) {
     }
     const content = (await fs_1.default.promises.readFile(files[0])).toString('base64');
     let packageId = '';
+    let assemblyId;
     try {
         packageId = await retrievePackage(config.prefix, config.name, apiConfig);
     }
@@ -52,13 +53,14 @@ async function deployPluginPackage(config, apiConfig, solution) {
     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) {

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,15 +23,15 @@ 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(async (step) => {
                 step['plugintypeid@odata.bind'] = `/plugintypes(${typeId})`;
                 await (0, pluginStep_1.deployStep)(step, typeId, apiConfig, solution);
             });
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dataverse-utils",
-  "version": "2.5.2",
+  "version": "2.5.3",
   "license": "MIT",
   "description": "Utilities for interacting with Dataverse environments",
   "main": "lib/index.js",
@@ -23,7 +23,7 @@
     "@azure/msal-node": "^1.12.0",
     "commander": "^8.3.0",
     "cryptr": "^6.0.3",
-    "dataverse-webapi": "^2.2.0",
+    "dataverse-webapi": "^2.2.1",
     "envinfo": "^7.8.1",
     "figures": "^3.2.0",
     "glob": "^7.2.0",