@k-int/bruno-shared-scripts 1.2.0 → 2.0.0

package/.gitlab-ci.yml

@@ -1,40 +1,51 @@
-default:
-  # image: docker.libsdev.k-int.com/knowledgeintegration/stripes-build-agent:latest
-  # See https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit-header
-  image:
-    name: node:20
-    pull_policy: always
+# Base templates for setting up the module in the various stages
+.npm_config_setup:
   before_script:
-    # - npm config set @folio:registry "https://nexus.libsdev.k-int.com/repository/libsdev-npm-group/"
-    # - npm config set @knowledge-integration:registry "https://nexus.libsdev.k-int.com/repository/libsdev-npm-hosted/"
+    - apt-get -qq update
+    - apt-get install -y jq # JQ is always needed, we will need to add curl for our publish module descriptor
+    - npm config set @folio:registry "https://nexus.libsdev.k-int.com/repository/libsdev-npm-group/"
+    - npm config set @knowledge-integration:registry "https://nexus.libsdev.k-int.com/repository/libsdev-npm-hosted/"
+    # Set auth tokens for nexus registries
     - npm config set -- //nexus.libsdev.k-int.com/repository/libsdev-npm-hosted/:_authToken $KI_NEXUS_NPM_TOKEN
     - npm config set -- //nexus.libsdev.k-int.com/repository/libsdev-npm-snapshots-hosted/:_authToken $KI_NEXUS_NPM_TOKEN
-    # - npm config set registry "https://nexus.libsdev.k-int.com/repository/libsdev-npm-group/"
-    # - npm config set @k-int:registry "https://nexus.libsdev.k-int.com/repository/libsdev-npm-hosted/"
-    # - npm --registry "https://nexus.libsdev.k-int.com/repository/libsdev-npm-hosted/" adduser
-    # - npm --registry "https://nexus.libsdev.k-int.com/repository/libsdev-npm-hosted/" whoami
-    # - export NPM_TOKEN="$KI_NEXUS_NPM_TOKEN"
-    - export NPM_TOKEN="$NPMJS_TOKEN"
-    - git config --global user.name "ethanfreestone"
-    - git config --global user.email "ethan.freestone@k-int.com"
-    - npm install
-    - echo "token $GITLAB_TOKEN $NPM_TOKEN $KI_NEXUS_NPM_TOKEN"
+
+.dependencies_install:
+  extends: .npm_config_setup
+  before_script:
+    ## Extending the npm configuration
+    - !reference [.npm_config_setup, before_script]
+    - yarn install
+
+default:
+  #image: docker.libsdev.k-int.com/knowledgeintegration/stripes-build-agent:2.1.0
+  image: node:22
   cache:
     key: ${CI_COMMIT_REF_SLUG}
     paths:
       - .npm/
+      - ./module-descriptor.json
   tags:
     - docker
-    #    - docker-18
+    #- docker-18
     - ki-onprem
+
 stages:
   - release
+
 publish:
   stage: release
+  extends: .dependencies_install
   only:
-    - main
+    - main # Only run on the 'release' branch or version n.x branches
     - /^[0-9]+.x/
+  id_tokens:
+    NPM_ID_TOKEN:
+      aud: "npm:registry.npmjs.org"
   script:
-    - npm run semantic-release
-    # We just need to npm-publish
-    # - npm --registry "$NPM_REGISTRY" publish --tag "${versionMajMin}-dev"
+    #- export NPM_TOKEN="$NPMJS_TOKEN" # This is deprecated in favour of Trusted Publishers
+    - echo $NODE_ENV
+    - export NODE_ENV=dev
+    - git config --global user.name "$GITLAB_USER_LOGIN" # Should be whoever triggered the pipeline
+    - git config --global user.email "$GITLAB_USER_EMAIL"
+    - npx semantic-release
+    #- echo "token $GITLAB_TOKEN $NPM_TOKEN $KI_NEXUS_NPM_TOKEN"

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [2.0.0](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/compare/v1.2.1...v2.0.0) (2026-01-12)
+
+
+* feat!: Bruno version 3 ([d028018](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/commit/d02801860cb1d230ea17575145c6787ab905c5bd))
+
+
+### BREAKING CHANGES
+
+* init function is now REQUIRED, setting up the global console, bru and req instances
+
+## [1.2.1](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/compare/v1.2.0...v1.2.1) (2025-10-30)
+
+
+### Bug Fixes
+
+* **deps:** Update "@semantic-release/gitlab" dependency ([770a6e2](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/commit/770a6e23445c44ef197357f4e9d20e8f0f0d3a90))
+* Release from `main` branch for bruno-shared-scripts ([3f03c3e](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/commit/3f03c3eccb5f0bde3acb091955ef7f840e6d6dc5))
+* Update release pipeline to use OIDC Trusted Publisher workflow ([7eafa63](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/commit/7eafa63a63d6630f4540125a02c57ef64ddf39a0))
+
 # [1.2.0](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/compare/v1.1.1...v1.2.0) (2025-09-12)
 
 

package/es/index.js

@@ -19,17 +19,57 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
+// src/bruno-globals-provider.js
+var bruInstance, logger, requestInstance, setGlobals, getBru, getConsole, getReq;
+var init_bruno_globals_provider = __esm({
+  "src/bruno-globals-provider.js"() {
+    bruInstance = null;
+    logger = console;
+    requestInstance = null;
+    setGlobals = ({
+      bruInstance: theBruInstance,
+      logger: theLogger,
+      requestInstance: theRequestInstance
+    }) => {
+      bruInstance = theBruInstance;
+      logger = theLogger;
+      requestInstance = theRequestInstance;
+    };
+    getBru = () => {
+      if (!bruInstance) {
+        throw new Error("Bruno instance not initialized. Call init({ bruInstance: <bruInstance> }) first.");
+      }
+      return bruInstance;
+    };
+    getConsole = () => {
+      if (!logger) {
+        throw new Error("Bruno logger not initialized. Call init({ logger: console }) first.");
+      }
+      return logger;
+    };
+    getReq = () => {
+      if (!requestInstance) {
+        throw new Error("Bruno logger not initialized. Call init({ requestInstance: <requestInstance> }) first.");
+      }
+      return requestInstance;
+    };
+  }
+});
+
 // src/utils/baseUrl.js
-var okapiProtocol, okapiUrl, okapiPort, getBaseUrl, setBaseUrl;
+var getBaseUrl, setBaseUrl;
 var init_baseUrl = __esm({
   "src/utils/baseUrl.js"() {
-    okapiProtocol = bru.getEnvVar("okapiProtocol");
-    okapiUrl = bru.getEnvVar("okapiUrl");
-    okapiPort = bru.getEnvVar("okapiPort");
+    init_bruno_globals_provider();
     getBaseUrl = () => {
+      const bru = getBru();
       return bru.getEnvVar("baseUrl");
     };
     setBaseUrl = () => {
+      const bru = getBru();
+      const okapiProtocol = bru.getEnvVar("okapiProtocol");
+      const okapiUrl = bru.getEnvVar("okapiUrl");
+      const okapiPort = bru.getEnvVar("okapiPort");
       const baseUrl = `${okapiProtocol}://${okapiUrl}${okapiPort ? ":" + okapiPort : ""}`;
       bru.setEnvVar("baseUrl", baseUrl);
     };
@@ -40,19 +80,25 @@ var init_baseUrl = __esm({
 var getTenant, getToken, getIgnoreCreds, getUserName, getPassword, getCreds;
 var init_auth_utils = __esm({
   "src/auth/auth-utils.js"() {
+    init_bruno_globals_provider();
     getTenant = () => {
+      const bru = getBru();
       return bru.getEnvVar("x-okapi-tenant-value");
     };
     getToken = () => {
+      const bru = getBru();
       return bru.getVar("x-okapi-token");
     };
     getIgnoreCreds = () => {
+      const bru = getBru();
       return bru.getEnvVar("ignoreCreds");
     };
     getUserName = () => {
+      const bru = getBru();
       return bru.getEnvVar("username");
     };
     getPassword = () => {
+      const bru = getBru();
       return bru.getEnvVar("password");
     };
     getCreds = () => {
@@ -67,12 +113,13 @@ var init_auth_utils = __esm({
 });
 
 // src/auth/login.js
-var axios, getLoginWithExpiryUrl, getLoginUrl, doALogin, loginFunc, login, loginWithExpiry;
+import axios from "axios";
+var getLoginWithExpiryUrl, getLoginUrl, doALogin, loginFunc, login, loginWithExpiry;
 var init_login = __esm({
   "src/auth/login.js"() {
     init_utils();
     init_auth_utils();
-    axios = require("axios");
+    init_bruno_globals_provider();
     getLoginWithExpiryUrl = () => {
       const baseUrl = getBaseUrl();
       return `${baseUrl}/bl-users/login-with-expiry`;
@@ -86,7 +133,9 @@ var init_login = __esm({
       withExpiry = true,
       suppressConsole = true
     } = {}) => {
-      !suppressConsole && console.log(`doALogin(${urlOverride}, ${withExpiry})`);
+      const logger2 = getConsole();
+      const req = getReq();
+      !suppressConsole && logger2.log(`doALogin(${urlOverride}, ${withExpiry}, ${suppressConsole})`);
       const ignoreCreds = getIgnoreCreds();
       const preExistingHeaders = req.getHeaders();
       const preExistingTenant = preExistingHeaders[Object.keys(preExistingHeaders).find((key) => key.toLowerCase() === "X-Okapi-Tenant".toLowerCase())];
@@ -98,7 +147,7 @@ var init_login = __esm({
         const creds = getCreds();
         const tenant = getTenant();
         const config = getBaseRequestConfig();
-        !suppressConsole && console.log(`Sending login request to ${url} with creds ${JSON.stringify(creds)} for tenant: ${tenant}`);
+        !suppressConsole && logger2.log(`Sending login request to ${url} with creds ${JSON.stringify(creds)} for tenant: ${tenant}`);
         return await axios.post(
           url,
           creds,
@@ -111,9 +160,12 @@ var init_login = __esm({
       withExpiry = true,
       suppressConsole = true
     } = {}) => {
-      !suppressConsole && console.log(`loginFunc(${urlOverride}, ${withExpiry})`);
-      await doALogin({ urlOverride, withExpiry, suppressConsole }).then((loginResp) => {
-        !suppressConsole && console.log("Setting request headers...");
+      const logger2 = getConsole();
+      const bru = getBru();
+      const req = getReq();
+      !suppressConsole && logger2.log(`loginFunc(${urlOverride}, ${withExpiry}, ${suppressConsole})`);
+      await doALogin({ req, urlOverride, withExpiry, suppressConsole }).then((loginResp) => {
+        !suppressConsole && logger2.log("Setting request headers...");
         req.setHeader("Cookie", loginResp.headers["set-cookie"]);
         const token = loginResp.headers["x-okapi-token"];
         bru.setVar("x-okapi-token-value", token);
@@ -121,11 +173,11 @@ var init_login = __esm({
           req.setHeader("x-okapi-token", getToken());
         }
       }).catch((err) => {
-        console.error("Failed to login to folio: %o", err);
+        logger2.error("Failed to login to folio: %o", err);
       });
     };
-    login = (urlOverride) => loginFunc({ urlOverride, withExpiry: false });
-    loginWithExpiry = (urlOverride) => loginFunc({ urlOverride });
+    login = (urlOverride, suppressConsole) => loginFunc({ urlOverride, withExpiry: false, suppressConsole });
+    loginWithExpiry = (urlOverride, suppressConsole) => loginFunc({ urlOverride, suppressConsole });
   }
 });
 
@@ -183,46 +235,61 @@ var init_utils = __esm({
 });
 
 // src/index.js
-var index_exports = {};
-__export(index_exports, {
-  doALogin: () => doALogin,
-  getBaseRequestConfig: () => getBaseRequestConfig,
-  getBaseUrl: () => getBaseUrl,
-  getCreds: () => getCreds,
-  getFolioAxios: () => getFolioAxios,
-  getIgnoreCreds: () => getIgnoreCreds,
-  getLoginUrl: () => getLoginUrl,
-  getLoginWithExpiryUrl: () => getLoginWithExpiryUrl,
-  getPassword: () => getPassword,
-  getTenant: () => getTenant,
-  getToken: () => getToken,
-  getUserName: () => getUserName,
-  login: () => login,
-  loginWithExpiry: () => loginWithExpiry,
-  setBaseUrl: () => setBaseUrl
-});
-module.exports = __toCommonJS(index_exports);
+init_bruno_globals_provider();
 init_utils();
 init_auth();
 
 // src/folioRequest.js
+init_bruno_globals_provider();
+import axios2 from "axios";
 var { doALogin: doALogin2 } = (init_auth(), __toCommonJS(auth_exports));
-var axios2 = require("axios");
 var { getBaseRequestConfig: getBaseRequestConfig2 } = (init_utils(), __toCommonJS(utils_exports));
 var getFolioAxios = async ({
   urlOverride = void 0,
   withExpiry = true,
   suppressConsole = true
 } = {}) => {
+  const logger2 = getConsole();
   return doALogin2({ urlOverride, withExpiry, suppressConsole }).then((loginResp) => {
     const config = getBaseRequestConfig2();
     config.headers.Cookie = loginResp.headers["set-cookie"];
     if (!withExpiry) {
       config.headers["x-okapi-token"] = loginResp.headers["x-okapi-token"];
     }
-    !suppressConsole && console.log("folioRequest ready with config: %o", config);
+    !suppressConsole && logger2.log("folioRequest ready with config: %o", config);
     return axios2.create(config);
   }).catch((err) => {
-    console.error("Failed to login to folio: %o", err);
+    logger2.error("Failed to login to folio: %o", err);
   });
 };
+
+// src/index.js
+var init = ({
+  bruInstance: bruInstance2,
+  logger: logger2,
+  requestInstance: requestInstance2
+}) => {
+  setGlobals({
+    bruInstance: bruInstance2,
+    logger: logger2,
+    requestInstance: requestInstance2
+  });
+};
+export {
+  doALogin,
+  getBaseRequestConfig,
+  getBaseUrl,
+  getCreds,
+  getFolioAxios,
+  getIgnoreCreds,
+  getLoginUrl,
+  getLoginWithExpiryUrl,
+  getPassword,
+  getTenant,
+  getToken,
+  getUserName,
+  init,
+  login,
+  loginWithExpiry,
+  setBaseUrl
+};

package/package.json

@@ -1,19 +1,24 @@
 {
   "name": "@k-int/bruno-shared-scripts",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "exports": "./es/index.js",
   "main": "src/index.js",
   "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "esbuild ./src/index.js --bundle --format=cjs --outdir=es --external:axios",
+    "build-es": "esbuild ./src/index.js --bundle --format=esm --outdir=es --external:axios --allow-overwrite",
+    "build-cjs": "esbuild ./src/index.js --bundle --format=cjs --outdir=cjs --external:axios --out-extension:.js=.cjs --allow-overwrite",
+    "__deprecated_build": "npm run build-es && npm run build-cjs",
+    "build": "npm run build-es",
     "semantic-release": "semantic-release"
   },
   "devDependencies": {
-    "esbuild": "^0.25.2",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/gitlab": "^12.0.6",
-    "@semantic-release/npm": "^11.0.0"
+    "@semantic-release/gitlab": "^13.2.9",
+    "esbuild": "^0.25.2"
+  },
+  "dependencies": {
+    "axios": "^1.13.2"
   }
 }

package/src/auth/auth-utils.js

@@ -1,20 +1,32 @@
+import { getBru } from '../bruno-globals-provider.js';
+
 const getTenant = () => {
+  const bru = getBru();
+
   return bru.getEnvVar("x-okapi-tenant-value")
 };
 
 const getToken = () => {
+  const bru = getBru();
+
   return bru.getVar("x-okapi-token")
 };
 
 const getIgnoreCreds = () => {
+  const bru = getBru();
+
   return bru.getEnvVar("ignoreCreds")
 }
 
 const getUserName = () => {
+  const bru = getBru();
+
   return bru.getEnvVar("username")
 }
 
 const getPassword = () => {
+  const bru = getBru();
+
   return bru.getEnvVar("password")
 }
 

package/src/auth/login.js

@@ -1,8 +1,9 @@
-//import axios from 'axios';
+import axios from 'axios';
 import { getBaseRequestConfig, getBaseUrl } from "../utils";
 import { getCreds, getIgnoreCreds, getTenant, getToken } from './auth-utils';
+import { getBru, getConsole, getReq } from '../bruno-globals-provider.js';
 
-const axios = require('axios'); // This comes from bruno context...
+// const axios = require('axios'); // This no longer comes from bruno context...
 
 // Right now login-with-expiry won't work against localhost
 const getLoginWithExpiryUrl = () => {
@@ -20,8 +21,10 @@ const doALogin = async ({
   withExpiry = true,
   suppressConsole = true
 } = {}) => {
-  !suppressConsole && console.log(`doALogin(${urlOverride}, ${withExpiry})`);
+  const logger = getConsole();
+  const req = getReq();
 
+  !suppressConsole && logger.log(`doALogin(${urlOverride}, ${withExpiry}, ${suppressConsole})`);
   const ignoreCreds = getIgnoreCreds();
   //console.log("URL OVERRIDE: %o", urlOverride)
 
@@ -34,14 +37,13 @@ const doALogin = async ({
   if (!preExistingTenant) {
     req.setHeader('x-okapi-tenant', getTenant()) // Keep an eye on this in PM we needed some funky stuff for "disabled" headers
   }
-
   // Way to ignore creds for local endpoints
   if (!ignoreCreds || ignoreCreds === false) {
     const url = urlOverride ?? (withExpiry ? getLoginWithExpiryUrl() : getLoginUrl());
     const creds = getCreds();
     const tenant = getTenant();
     const config = getBaseRequestConfig();
-    !suppressConsole && console.log(`Sending login request to ${url} with creds ${JSON.stringify(creds)} for tenant: ${tenant}`);
+    !suppressConsole && logger.log(`Sending login request to ${url} with creds ${JSON.stringify(creds)} for tenant: ${tenant}`);
 
     return await axios.post(
       url,
@@ -56,10 +58,14 @@ const loginFunc = async ({
   withExpiry = true,
   suppressConsole = true
 } = {}) => {
-  !suppressConsole && console.log(`loginFunc(${urlOverride}, ${withExpiry})`);
-  await doALogin({ urlOverride, withExpiry, suppressConsole })
+  const logger = getConsole();
+  const bru = getBru();
+  const req = getReq();
+
+  !suppressConsole && logger.log(`loginFunc(${urlOverride}, ${withExpiry}, ${suppressConsole})`);
+  await doALogin({ req, urlOverride, withExpiry, suppressConsole })
     .then((loginResp) => {
-      !suppressConsole && console.log("Setting request headers...")
+      !suppressConsole && logger.log("Setting request headers...")
       // We can't seem to set the cookie jar programatically, so directly set cookies on request instead
       req.setHeader('Cookie', loginResp.headers["set-cookie"])
 
@@ -72,12 +78,12 @@ const loginFunc = async ({
       }
     })
     .catch(err => {
-      console.error("Failed to login to folio: %o", err)
+      logger.error("Failed to login to folio: %o", err)
     });
 }
 
-const login = (urlOverride) => loginFunc({ urlOverride, withExpiry: false });
-const loginWithExpiry = (urlOverride) => loginFunc({ urlOverride });
+const login = (urlOverride, suppressConsole) => loginFunc({ urlOverride, withExpiry: false, suppressConsole });
+const loginWithExpiry = (urlOverride, suppressConsole) => loginFunc({ urlOverride, suppressConsole });
 
 export {
   doALogin,

package/src/bruno-globals-provider.js

@@ -0,0 +1,39 @@
+// Previously bruno globals were available to third party modules.
+// This is no longer the case, and instead must be initialised.
+// I don't love this model, but it will allow us to continue on as we have been working.
+
+let bruInstance = null;
+let logger = console; // Default to standard node console
+
+let requestInstance = null;
+
+export const setGlobals = ({
+  bruInstance: theBruInstance,
+  logger: theLogger,
+  requestInstance: theRequestInstance,
+}) => {
+  bruInstance = theBruInstance;
+  logger = theLogger;
+  requestInstance = theRequestInstance;
+};
+
+export const getBru = () => {
+  if (!bruInstance) {
+    throw new Error("Bruno instance not initialized. Call init({ bruInstance: <bruInstance> }) first.");
+  }
+  return bruInstance;
+};
+
+export const getConsole = () => {
+  if (!logger) {
+    throw new Error("Bruno logger not initialized. Call init({ logger: console }) first.");
+  }
+  return logger;
+};
+
+export const getReq = () => {
+  if (!requestInstance) {
+    throw new Error("Bruno logger not initialized. Call init({ requestInstance: <requestInstance> }) first.");
+  }
+  return requestInstance;
+};

package/src/folioRequest.js

@@ -1,6 +1,7 @@
+import axios from 'axios';
+import { getConsole } from './bruno-globals-provider.js';
 const { doALogin } = require('./auth');
 
-const axios = require('axios');
 const { getBaseRequestConfig } = require('./utils');
 
 export const getFolioAxios = async ({
@@ -8,6 +9,7 @@ export const getFolioAxios = async ({
   withExpiry = true,
   suppressConsole = true
 } = {}) => {
+  const logger = getConsole();
   return doALogin({ urlOverride, withExpiry, suppressConsole }).then(loginResp => {
 
     const config = getBaseRequestConfig()
@@ -18,9 +20,9 @@ export const getFolioAxios = async ({
       config.headers['x-okapi-token'] = loginResp.headers["x-okapi-token"]
     }
 
-    !suppressConsole && console.log("folioRequest ready with config: %o", config);
+    !suppressConsole && logger.log("folioRequest ready with config: %o", config);
     return axios.create(config);
   }).catch(err => {
-    console.error("Failed to login to folio: %o", err)
+    logger.error("Failed to login to folio: %o", err)
   })
 }

package/src/index.js

@@ -1,3 +1,18 @@
+import { setGlobals } from './bruno-globals-provider';
+
+// Initialising the bruno scope at the top of a request script
+export const init = ({
+  bruInstance,
+  logger,
+  requestInstance,
+}) => {
+  setGlobals({
+    bruInstance,
+    logger,
+    requestInstance
+  });
+};
+
 export * from './utils';
 export * from './auth';
 export * from './folioRequest';

package/src/utils/baseUrl.js

@@ -1,12 +1,18 @@
-const okapiProtocol = bru.getEnvVar('okapiProtocol');
-const okapiUrl = bru.getEnvVar('okapiUrl');
-const okapiPort = bru.getEnvVar('okapiPort');
+import { getBru } from '../bruno-globals-provider.js';
 
 const getBaseUrl = () => {
+  const bru = getBru();
+
   return bru.getEnvVar("baseUrl");
 }
 
 const setBaseUrl = () => {
+  const bru = getBru();
+
+  const okapiProtocol = bru.getEnvVar('okapiProtocol');
+  const okapiUrl = bru.getEnvVar('okapiUrl');
+  const okapiPort = bru.getEnvVar('okapiPort');
+
   const baseUrl = `${okapiProtocol}://${okapiUrl}${okapiPort ? ':' + okapiPort : ''}`;
   //console.log("WHAT IS BASEURL: %o", baseUrl)
   bru.setEnvVar("baseUrl", baseUrl);