dataverse-utils 2.2.12 → 2.3.1

package/lib/assemblyDeploy.js

@@ -3,12 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deployAssembly = void 0;
+exports.assemblyDeploy = void 0;
 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 logger_1 = require("./logger");
-async function deployAssembly(creds, apiConfig) {
+async function assemblyDeploy(creds, apiConfig) {
     const currentPath = '.';
     const configFile = await fs_1.default.promises.readFile(path_1.default.resolve(currentPath, 'dataverse.config.json'), 'utf8');
     if (configFile == null) {
@@ -16,14 +17,27 @@ async function deployAssembly(creds, apiConfig) {
         return;
     }
     const config = JSON.parse(configFile);
-    logger_1.logger.info('deploy assembly');
-    try {
-        await (0, pluginAssembly_1.deploy)(config, apiConfig, creds.solution);
+    if (config.prefix) {
+        logger_1.logger.info('deploy plugin package');
+        try {
+            await (0, pluginPackage_1.deployPluginPackage)(config, apiConfig, creds.solution);
+        }
+        catch (error) {
+            logger_1.logger.error(error.message);
+            return;
+        }
+        logger_1.logger.done(`deployed plugin package ${config.prefix}_${config.name}\r\n`);
     }
-    catch (error) {
-        logger_1.logger.error(error.message);
-        return;
+    else {
+        logger_1.logger.info('deploy assembly');
+        try {
+            await (0, pluginAssembly_1.deployAssembly)(config, apiConfig, creds.solution);
+        }
+        catch (error) {
+            logger_1.logger.error(error.message);
+            return;
+        }
+        logger_1.logger.done(`deployed assembly ${config.name}\r\n`);
     }
-    logger_1.logger.done(`deployed assembly ${config.name}\r\n`);
 }
-exports.deployAssembly = deployAssembly;
+exports.assemblyDeploy = assemblyDeploy;

package/lib/auth.js

@@ -1,10 +1,33 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAccessToken = void 0;
+exports.getAccessToken = exports.onTokenFailure = void 0;
+const prompts_1 = __importDefault(require("prompts"));
 const cachePlugin_1 = require("./cachePlugin");
 const msal_node_1 = require("@azure/msal-node");
 const logger_1 = require("./logger");
 const clientId = '51f81489-12ee-4a9e-aaae-a2591f45987d';
+const onTokenFailure = async (url, error) => {
+    if (error) {
+        logger_1.logger.error(`failed to acquire access token: ${error}`);
+    }
+    else {
+        logger_1.logger.error('failed to acquire access token');
+    }
+    if ((0, cachePlugin_1.cacheExists)(url)) {
+        const { deleteToken } = await (0, prompts_1.default)({
+            type: 'confirm',
+            name: 'deleteToken',
+            message: `delete current token cache for ${url}?`
+        });
+        if (deleteToken) {
+            (0, cachePlugin_1.deleteCache)(url);
+        }
+    }
+};
+exports.onTokenFailure = onTokenFailure;
 const getAccessToken = async (tenant, url) => {
     const config = {
         auth: {

package/lib/cachePlugin.js

@@ -21,7 +21,7 @@ const decrypt = (text) => {
     return decrypted;
 };
 const getCachePath = (url) => {
-    const org = url.replace('https://', '').split('.')[0];
+    const org = new URL(url).hostname.split('.')[0];
     if (!fs_1.default.existsSync(path_1.default.join(os_1.default.homedir(), './.dataverse-utils/'))) {
         fs_1.default.mkdirSync(path_1.default.join(os_1.default.homedir(), './.dataverse-utils/'));
     }

package/lib/dataverse.service.js

@@ -9,6 +9,7 @@ var ComponentType;
     ComponentType[ComponentType["PluginAssembly"] = 91] = "PluginAssembly";
     ComponentType[ComponentType["SDKMessageProcessingStep"] = 92] = "SDKMessageProcessingStep";
     ComponentType[ComponentType["SDKMessageProcessingStepImage"] = 93] = "SDKMessageProcessingStepImage";
+    ComponentType[ComponentType["PluginPackage"] = 10865] = "PluginPackage";
 })(ComponentType = exports.ComponentType || (exports.ComponentType = {}));
 async function addToSolution(id, solution, type, apiConfig) {
     const data = {

package/lib/deploy.js

@@ -11,25 +11,6 @@ const assemblyDeploy_1 = require("./assemblyDeploy");
 const webResourceDeploy_1 = require("./webResourceDeploy");
 const node_1 = require("dataverse-webapi/lib/node");
 const auth_1 = require("./auth");
-const cachePlugin_1 = require("./cachePlugin");
-const onTokenFailure = async (url, error) => {
-    if (error) {
-        logger_1.logger.error(`failed to acquire access token: ${error}`);
-    }
-    else {
-        logger_1.logger.error('failed to acquire access token');
-    }
-    if ((0, cachePlugin_1.cacheExists)(url)) {
-        const { deleteToken } = await (0, prompts_1.default)({
-            type: 'confirm',
-            name: 'deleteToken',
-            message: `delete current token cache for ${url}?`
-        });
-        if (deleteToken) {
-            (0, cachePlugin_1.deleteCache)(url);
-        }
-    }
-};
 async function deploy(type, files) {
     if (!type || (type !== 'webresource' && type !== 'assembly')) {
         const invalid = type !== undefined && type !== 'webresource' && type !== 'assembly';
@@ -57,20 +38,20 @@ async function deploy(type, files) {
         token = await (0, auth_1.getAccessToken)(creds.tenant, creds.server);
     }
     catch (error) {
-        onTokenFailure(creds.server, error.message);
+        (0, auth_1.onTokenFailure)(creds.server, error.message);
         return;
     }
     if (token == null || token.accessToken == null) {
-        onTokenFailure(creds.server);
+        (0, auth_1.onTokenFailure)(creds.server);
         return;
     }
     const apiConfig = new node_1.WebApiConfig('8.2', token.accessToken, creds.server);
     switch (type) {
         case 'webresource':
-            await (0, webResourceDeploy_1.deployWebResource)(creds, apiConfig, files);
+            await (0, webResourceDeploy_1.webResourceDeploy)(creds, apiConfig, files);
             break;
         case 'assembly':
-            await (0, assemblyDeploy_1.deployAssembly)(creds, apiConfig);
+            await (0, assemblyDeploy_1.assemblyDeploy)(creds, apiConfig);
             break;
         default:
             break;

package/lib/generate.js

@@ -31,11 +31,11 @@ async function generate(table) {
         token = await (0, auth_1.getAccessToken)(creds.tenant, creds.server);
     }
     catch (error) {
-        logger_1.logger.error(`failed to acquire access token: ${error.message}`);
+        (0, auth_1.onTokenFailure)(creds.server, error.message);
         return;
     }
     if (token == null || token.accessToken == null) {
-        logger_1.logger.error('failed to acquire access token');
+        (0, auth_1.onTokenFailure)(creds.server);
         return;
     }
     const apiConfig = new node_1.WebApiConfig('8.2', token.accessToken, creds.server);

package/lib/models/pluginAssembly.js

@@ -3,14 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deploy = void 0;
+exports.deployAssembly = void 0;
 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 deploy(config, apiConfig, solution) {
+async function deployAssembly(config, apiConfig, solution) {
     const files = glob_1.default.sync(`**/${config.name}.dll`);
     if (files.length === 0) {
         logger_1.logger.warn(`assembly ${config.name}.dll not found`);
@@ -63,7 +63,7 @@ async function deploy(config, apiConfig, solution) {
         }
     }
 }
-exports.deploy = deploy;
+exports.deployAssembly = deployAssembly;
 async function retrieveAssembly(name, apiConfig) {
     const options = `$select=pluginassemblyid&$filter=name eq '${name}'`;
     const result = await (0, node_1.retrieveMultiple)(apiConfig, 'pluginassemblies', options);

package/lib/models/pluginPackage.js

@@ -0,0 +1,89 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deployPluginPackage = void 0;
+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`);
+    if (files.length === 0) {
+        logger_1.logger.warn(`package ${config.name}.nupkg not found`);
+        return;
+    }
+    const content = (await fs_1.default.promises.readFile(files[0])).toString('base64');
+    let packageId = '';
+    try {
+        packageId = await retrievePackage(config.prefix, config.name, apiConfig);
+    }
+    catch (error) {
+        logger_1.logger.error(`failed to retrieve package ${config.name}: ${error.message}`);
+        return;
+    }
+    if (packageId != '') {
+        try {
+            await updatePackage(packageId, config, content, apiConfig);
+        }
+        catch (error) {
+            throw new Error(`failed to update package: ${error.message}`);
+        }
+    }
+    else {
+        try {
+            packageId = await createPackage(config, content, apiConfig);
+        }
+        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}`);
+            }
+        }
+    }
+    if (config.assembly != null) {
+        try {
+            config.assembly['packageid@odata.bind'] = `/pluginpackages(${packageId})`;
+            await (0, pluginAssembly_1.deployAssembly)(config.assembly, apiConfig, solution);
+        }
+        catch (error) {
+            logger_1.logger.error(error.message);
+            return;
+        }
+    }
+}
+exports.deployPluginPackage = deployPluginPackage;
+async function retrievePackage(prefix, name, apiConfig) {
+    const options = `$select=pluginpackageid&$filter=contains(name, '${prefix}_${name}')`;
+    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) {
+    logger_1.logger.info(`create assembly ${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');
+    if (result.error) {
+        throw new Error(result.error.message);
+    }
+    return result.pluginpackageid;
+}
+async function updatePackage(id, config, content, apiConfig) {
+    logger_1.logger.info(`update assembly ${config.name}`);
+    const assembly = {
+        content: content,
+        version: config.version
+    };
+    return (0, node_1.update)(apiConfig, 'pluginpackages', id, assembly);
+}

package/lib/webResourceDeploy.js

@@ -3,12 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deployWebResource = void 0;
+exports.webResourceDeploy = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const logger_1 = require("./logger");
 const webResource_1 = require("./models/webResource");
-async function deployWebResource(creds, apiConfig, files) {
+async function webResourceDeploy(creds, apiConfig, files) {
     const currentPath = '.';
     const configFile = await fs_1.default.promises.readFile(path_1.default.resolve(currentPath, 'dataverse.config.json'), 'utf8');
     if (configFile == null) {
@@ -26,4 +26,4 @@ async function deployWebResource(creds, apiConfig, files) {
     }
     logger_1.logger.done('deployed web resources');
 }
-exports.deployWebResource = deployWebResource;
+exports.webResourceDeploy = webResourceDeploy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dataverse-utils",
-  "version": "2.2.12",
+  "version": "2.3.1",
   "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.0.8",
+    "dataverse-webapi": "^2.1.0",
     "envinfo": "^7.8.1",
     "figures": "^3.2.0",
     "glob": "^7.2.0",