dataverse-utils 2.1.1 → 2.2.0

package/CHANGELOG.json

@@ -2,7 +2,73 @@
   "name": "dataverse-utils",
   "entries": [
     {
-      "date": "Sun, 16 Jan 2022 22:41:36 GMT",
+      "date": "Mon, 07 Feb 2022 22:01:58 GMT",
+      "tag": "dataverse-utils_v2.2.0",
+      "version": "2.2.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "derek.finlinson@journeyteam.com",
+            "package": "dataverse-utils",
+            "commit": "55d633b2c3064bbdce48c5d314d8e7572a015882",
+            "comment": "Switch to combined logger"
+          },
+          {
+            "author": "beachball",
+            "package": "dataverse-utils",
+            "comment": "Bump dataverse-webapi to v2.0.4",
+            "commit": "83b50fd1a35a0645f279e60b8ca0eb2ace5c0ad3"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 28 Jan 2022 23:11:16 GMT",
+      "tag": "dataverse-utils_v2.1.4",
+      "version": "2.1.4",
+      "comments": {
+        "patch": [
+          {
+            "author": "derek.finlinson@journeyteam.com",
+            "package": "dataverse-utils",
+            "commit": "fb9365e3fcd8ada0b97dfc4e86661c67332734bf",
+            "comment": "Prompt to delete cache on error"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sun, 16 Jan 2022 23:22:22 GMT",
+      "tag": "dataverse-utils_v2.1.3",
+      "version": "2.1.3",
+      "comments": {
+        "patch": [
+          {
+            "author": "derek.finlinson@journeyteam.com",
+            "package": "dataverse-utils",
+            "commit": "928a436f3d6627765a329ee4cb31d83cab714b1d",
+            "comment": "Switch symbols"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sun, 16 Jan 2022 22:57:20 GMT",
+      "tag": "dataverse-utils_v2.1.2",
+      "version": "2.1.2",
+      "comments": {
+        "patch": [
+          {
+            "author": "derek.finlinson@journeyteam.com",
+            "package": "dataverse-utils",
+            "commit": "acf6ca4763a9d98fa7683fe517deb872f12f4c42",
+            "comment": "Fix logging for real"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sun, 16 Jan 2022 22:41:55 GMT",
       "tag": "dataverse-utils_v2.1.1",
       "version": "2.1.1",
       "comments": {

package/CHANGELOG.md

@@ -1,17 +1,50 @@
 # Change Log - dataverse-utils
 
-This log was last generated on Sun, 16 Jan 2022 22:41:36 GMT and should not be manually modified.
+This log was last generated on Mon, 07 Feb 2022 22:01:58 GMT and should not be manually modified.
 
 <!-- Start content -->
 
-## 2.1.1
+## 2.2.0
 
-Sun, 16 Jan 2022 22:41:36 GMT
+Mon, 07 Feb 2022 22:01:58 GMT
 
-### Patches
+### Minor changes
 
-- Fix logging (derek.finlinson@journeyteam.com)
+- Switch to combined logger (derek.finlinson@journeyteam.com)
+- Bump dataverse-webapi to v2.0.4
 
+## 2.1.4
+
+Fri, 28 Jan 2022 23:11:16 GMT
+
+### Patches
+
+- Prompt to delete cache on error (derek.finlinson@journeyteam.com)
+
+## 2.1.3
+
+Sun, 16 Jan 2022 23:22:22 GMT
+
+### Patches
+
+- Switch symbols (derek.finlinson@journeyteam.com)
+
+## 2.1.2
+
+Sun, 16 Jan 2022 22:57:20 GMT
+
+### Patches
+
+- Fix logging for real (derek.finlinson@journeyteam.com)
+
+## 2.1.1
+
+Sun, 16 Jan 2022 22:41:55 GMT
+
+### Patches
+
+- Fix logging (derek.finlinson@journeyteam.com)
+
 ## 2.1.0
 
 Sun, 16 Jan 2022 21:30:27 GMT

package/lib/logger.js

@@ -3,24 +3,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = void 0;
+exports.logger = exports.icons = void 0;
 const kleur_1 = __importDefault(require("kleur"));
-const square = '\u25a0';
-const triangle = '\u25b2';
-const emptySquare = '\u25a1';
-const log = (method, symbol, ...args) => {
-    const now = new Date();
-    const timestamp = kleur_1.default.gray(`[${now.toLocaleTimeString()}]`);
-    console[method](timestamp, symbol, ...args);
+const isTest = process.env.JEST_WORKER_ID !== undefined;
+exports.icons = {
+    done: kleur_1.default.green('▣'),
+    info: kleur_1.default.cyan('!'),
+    error: kleur_1.default.red('⨂'),
+    warn: kleur_1.default.yellow('‼')
 };
 exports.logger = {
     info(...args) {
-        log('info', kleur_1.default.green(square), args);
+        if (!isTest) {
+            console.info(exports.icons.info, ...args);
+        }
     },
     warn(...args) {
-        log('warn', kleur_1.default.yellow(triangle), args);
+        if (!isTest) {
+            console.warn(exports.icons.warn, ...args);
+        }
     },
     error(...args) {
-        log('error', kleur_1.default.red(emptySquare), args);
-    }
+        if (!isTest) {
+            console.error(exports.icons.error, ...args);
+        }
+    },
+    done(...args) {
+        if (!isTest) {
+            console.info(exports.icons.info, ...args);
+        }
+    },
 };

package/lib/{assemblyDeploy.js → packages/dataverse-utils/src/assemblyDeploy.js}

@@ -7,7 +7,7 @@ exports.deployAssembly = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const pluginAssembly_1 = require("./models/pluginAssembly");
-const logger_1 = require("./logger");
+const logger_1 = require("../../../logger");
 async function deployAssembly(creds, apiConfig) {
     const currentPath = '.';
     const configFile = fs_1.default.readFileSync(path_1.default.resolve(currentPath, 'dataverse.config.json'), 'utf8');
@@ -24,6 +24,6 @@ async function deployAssembly(creds, apiConfig) {
         logger_1.logger.error(error.message);
         return;
     }
-    logger_1.logger.info(`deployed assembly ${config.name}\r\n`);
+    logger_1.logger.done(`deployed assembly ${config.name}\r\n`);
 }
 exports.deployAssembly = deployAssembly;

package/lib/{auth.js → packages/dataverse-utils/src/auth.js}

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAccessToken = void 0;
 const cachePlugin_1 = require("./cachePlugin");
 const msal_node_1 = require("@azure/msal-node");
-const logger_1 = require("./logger");
+const logger_1 = require("../../../logger");
 const clientId = '51f81489-12ee-4a9e-aaae-a2591f45987d';
 const getAccessToken = async (tenant, url) => {
     const config = {
@@ -12,7 +12,7 @@ const getAccessToken = async (tenant, url) => {
             authority: `https://login.microsoftonline.com/${tenant}/`
         },
         cache: {
-            cachePlugin: (0, cachePlugin_1.cachePlugin)(url.replace('https://', '').split('.')[0])
+            cachePlugin: (0, cachePlugin_1.cachePlugin)(url)
         }
     };
     const pca = new msal_node_1.PublicClientApplication(config);

package/lib/{cachePlugin.js → packages/dataverse-utils/src/cachePlugin.js}

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cachePlugin = void 0;
+exports.cachePlugin = exports.deleteCache = exports.cacheExists = exports.getCachePath = void 0;
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
@@ -20,14 +20,32 @@ const decrypt = (text) => {
     const decrypted = cryptr.decrypt(text);
     return decrypted;
 };
-function cachePlugin(org) {
-    const getCachePath = () => {
-        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/'));
-        }
-        return path_1.default.join(os_1.default.homedir(), `./.dataverse-utils/${org}.json`);
-    };
-    const cacheLocation = getCachePath();
+const getCachePath = (url) => {
+    const org = url.replace('https://', '').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/'));
+    }
+    return path_1.default.join(os_1.default.homedir(), `./.dataverse-utils/${org}.json`);
+};
+exports.getCachePath = getCachePath;
+const cacheExists = (url) => {
+    const cacheLocation = (0, exports.getCachePath)(url);
+    return fs_1.default.existsSync(cacheLocation);
+};
+exports.cacheExists = cacheExists;
+const deleteCache = (url) => {
+    const cacheLocation = (0, exports.getCachePath)(url);
+    if (fs_1.default.existsSync(cacheLocation)) {
+        fs_1.default.unlinkSync(cacheLocation);
+        return true;
+    }
+    else {
+        return false;
+    }
+};
+exports.deleteCache = deleteCache;
+const cachePlugin = (url) => {
+    const cacheLocation = (0, exports.getCachePath)(url);
     const beforeCacheAccess = (tokenCacheContext) => {
         return new Promise((resolve, reject) => {
             if (fs_1.default.existsSync(cacheLocation)) {
@@ -75,5 +93,5 @@ function cachePlugin(org) {
         beforeCacheAccess,
         afterCacheAccess
     };
-}
+};
 exports.cachePlugin = cachePlugin;

package/lib/{deploy.js → packages/dataverse-utils/src/deploy.js}

@@ -6,11 +6,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const prompts_1 = __importDefault(require("prompts"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const logger_1 = require("./logger");
+const logger_1 = require("../../../logger");
 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';
@@ -38,11 +57,11 @@ async function deploy(type, files) {
         token = await (0, auth_1.getAccessToken)(creds.tenant, creds.server);
     }
     catch (error) {
-        logger_1.logger.error(`failed to acquire access token: ${error.message}`);
+        onTokenFailure(creds.server, error.message);
         return;
     }
     if (token == null || token.accessToken == null) {
-        logger_1.logger.error('failed to acquire access token');
+        onTokenFailure(creds.server);
         return;
     }
     const apiConfig = new node_1.WebApiConfig('8.2', token.accessToken, creds.server);

package/lib/{generate.js → packages/dataverse-utils/src/generate.js}

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const prompts_1 = __importDefault(require("prompts"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const logger_1 = require("./logger");
+const logger_1 = require("../../../logger");
 const dataverse_service_1 = require("./dataverse.service");
 const node_1 = require("dataverse-webapi/lib/node");
 const auth_1 = require("./auth");
@@ -94,6 +94,6 @@ async function generate(table) {
         fs_1.default.mkdirSync(path_1.default.resolve(currentPath, 'src', 'scripts', 'models'));
     }
     fs_1.default.writeFileSync(path_1.default.resolve(currentPath, 'src', 'scripts', 'models', `${metadata.schemaName}.ts`), codeFile);
-    logger_1.logger.info(`Table metadata output to models/${metadata.schemaName}.ts`);
+    logger_1.logger.done(`Table metadata output to models/${metadata.schemaName}.ts`);
 }
 exports.default = generate;

package/lib/{models → packages/dataverse-utils/src/models}/pluginAssembly.js

@@ -9,11 +9,11 @@ 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");
+const logger_1 = require("../../../../logger");
 async function deploy(config, apiConfig, solution) {
     const files = glob_1.default.sync(`**/${config.name}.dll`);
     if (files.length === 0) {
-        logger_1.logger.error(`assembly ${config.name}.dll not found`);
+        logger_1.logger.warn(`assembly ${config.name}.dll not found`);
         return;
     }
     const content = fs_1.default.readFileSync(files[0]).toString('base64');
@@ -53,7 +53,7 @@ async function deploy(config, apiConfig, solution) {
         try {
             const promises = config.types.map(async (type) => {
                 type['pluginassemblyid@odata.bind'] = `/pluginassemblies(${assemblyId})`;
-                await (0, pluginType_1.deployType)(type, apiConfig, solution);
+                await (0, pluginType_1.deployType)(type, assemblyId, apiConfig, solution);
             });
             await Promise.all(promises);
         }

package/lib/{models → packages/dataverse-utils/src/models}/pluginImage.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deployImage = void 0;
-const logger_1 = require("../logger");
+const logger_1 = require("../../../../logger");
 const node_1 = require("dataverse-webapi/lib/node");
 async function deployImage(stepId, image, message, apiConfig) {
     image['sdkmessageprocessingstepid@odata.bind'] = `/sdkmessageprocessingsteps(${stepId})`;

package/lib/{models → packages/dataverse-utils/src/models}/pluginStep.js

@@ -3,18 +3,18 @@ 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 logger_1 = require("../../../../logger");
 const pluginImage_1 = require("./pluginImage");
-async function deployStep(step, apiConfig, solution) {
-    let stepId = await retrieveStep(step.name, apiConfig);
+async function deployStep(step, typeId, apiConfig, solution) {
+    let stepId = await retrieveStep(step.name, typeId, apiConfig);
     const messageId = await getSdkMessageId(step.message ?? '', apiConfig);
     if (messageId == '') {
-        logger_1.logger.error(`sdk message ${step.message} not found`);
+        logger_1.logger.warn(`sdk message ${step.message} not found`);
         return;
     }
     const filterId = await getSdkMessageFilterId(messageId, step.entity ?? '', apiConfig);
     if (filterId == '') {
-        logger_1.logger.error(`sdk message ${step.message} for entity ${step.entity} not found`);
+        logger_1.logger.warn(`sdk message ${step.message} for entity ${step.entity} not found`);
         return;
     }
     step['sdkmessagefilterid@odata.bind'] = `/sdkmessagefilters(${filterId})`;
@@ -63,8 +63,8 @@ async function deployStep(step, apiConfig, solution) {
     return stepId;
 }
 exports.deployStep = deployStep;
-async function retrieveStep(name, apiConfig) {
-    const options = `$select=sdkmessageprocessingstepid&$filter=name eq '${name}'`;
+async function retrieveStep(name, typeId, apiConfig) {
+    const options = `$select=sdkmessageprocessingstepid&$filter=name eq '${name}' and _plugintypeid_value eq ${typeId}`;
     const result = await (0, node_1.retrieveMultiple)(apiConfig, 'sdkmessageprocessingsteps', options);
     return result.value.length > 0 ? result.value[0].sdkmessageprocessingstepid : '';
 }

package/lib/{models → packages/dataverse-utils/src/models}/pluginType.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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, apiConfig, solution) {
-    let typeId = await retrieveType(type.typename, apiConfig);
+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,
@@ -33,7 +33,7 @@ async function deployType(type, apiConfig, solution) {
         if (type.steps) {
             const promises = type.steps.map(async (step) => {
                 step['plugintypeid@odata.bind'] = `/plugintypes(${typeId})`;
-                await (0, pluginStep_1.deployStep)(step, apiConfig, solution);
+                await (0, pluginStep_1.deployStep)(step, typeId, apiConfig, solution);
             });
             await Promise.all(promises);
         }
@@ -44,8 +44,8 @@ async function deployType(type, apiConfig, solution) {
     return typeId;
 }
 exports.deployType = deployType;
-async function retrieveType(name, apiConfig) {
-    const options = `$select=plugintypeid&$filter=typename eq '${name}'`;
+async function retrieveType(name, assemblyId, apiConfig) {
+    const options = `$select=plugintypeid&$filter=typename eq '${name}' and _pluginassemblyid_value eq ${assemblyId}`;
     const result = await (0, node_1.retrieveMultiple)(apiConfig, 'plugintypes', options);
     return result.value.length > 0 ? result.value[0].plugintypeid : '';
 }

package/lib/{models → packages/dataverse-utils/src/models}/webResource.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deploy = void 0;
 const dataverse_service_1 = require("../dataverse.service");
 const node_1 = require("dataverse-webapi/lib/node");
-const logger_1 = require("../logger");
+const logger_1 = require("../../../../logger");
 const fs_1 = __importDefault(require("fs"));
 function getWebResourceType(type) {
     switch (type) {
@@ -47,7 +47,7 @@ async function deploy(webResources, apiConfig, solution, files) {
         for (const file of files.split(',')) {
             const resource = webResources.filter(r => r.path?.endsWith(file));
             if (resource.length === 0) {
-                logger_1.logger.error(`web resource ${file} not found in dataverse.config.json`);
+                logger_1.logger.warn(`web resource ${file} not found in dataverse.config.json`);
                 continue;
             }
             resources.push(resource[0]);

package/lib/{webResourceDeploy.js → packages/dataverse-utils/src/webResourceDeploy.js}

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deployWebResource = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
-const logger_1 = require("./logger");
+const logger_1 = require("../../../logger");
 const webResource_1 = require("./models/webResource");
 async function deployWebResource(creds, apiConfig, files) {
     const currentPath = '.';
@@ -24,6 +24,6 @@ async function deployWebResource(creds, apiConfig, files) {
         logger_1.logger.error(error.message);
         return;
     }
-    logger_1.logger.info('deployed web resources');
+    logger_1.logger.done('deployed web resources');
 }
 exports.deployWebResource = deployWebResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dataverse-utils",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "license": "MIT",
   "description": "Utilities for interacting with Dataverse environments",
   "main": "lib/index.js",
@@ -17,21 +17,22 @@
   "scripts": {
     "build": "tsc -p .",
     "lint": "eslint",
-    "prebuild": "rimraf lib"
+    "clean": "rimraf lib"
   },
   "dependencies": {
     "@azure/msal-node": "^1.3.1",
     "commander": "^8.3.0",
-    "glob": "^7.2.0",
     "cryptr": "^6.0.2",
-    "dataverse-webapi": "^2.0.3",
+    "dataverse-webapi": "^2.0.4",
     "envinfo": "^7.8.1",
+    "glob": "^7.2.0",
     "kleur": "^4.1.4",
     "prompts": "^2.4.2"
   },
   "devDependencies": {
-    "@types/node": "^16.9.1",
+    "@types/cryptr": "^4.0.1",
     "@types/glob": "^7.2.0",
+    "@types/node": "^16.9.1",
     "@types/prompts": "^2.0.14"
   }
 }