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

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.0.1](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/compare/v2.0.0...v2.0.1) (2026-01-16)
+
+
+### Bug Fixes
+
+* Improvements to login and folioAxios to allow for connecting to a DIFFERENT folio within the pre request scripts ([5acea6e](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/commit/5acea6ec44aefa3fce84f75454908974fdb23f42))
+
 # [2.0.0](https://gitlab.com/knowledge-integration/bruno/bruno-shared-scripts/compare/v1.2.1...v2.0.0) (2026-01-12)
 
 

package/README.md

@@ -0,0 +1,94 @@
+# Bruno shared scripts
+
+This is a public NPM module dedicated to any shared behaviour required across varying collections in Bruno. For now it
+focuses mostly on connecting to a
+remote FOLIO instance and managing FOLIO headers, but there is nothing tying this module to only serving those purposes.
+
+## Motivation
+
+Analogous to Postman's shared scripts cloud library, Bruno instead allows ANY NPM to be imported (In developer mode, via
+`require`) and used within pre/post
+request scripts. This is significantly more powerful and open, and allows us to publish the module onto the public NPM
+with strict versioning and be more in
+control.
+
+## Setup
+
+To use the shared scripts within a collection, simply import and initialise them.
+
+```javascript
+const {
+  init,
+} = require('@k-int/bruno-shared-scripts');
+
+init({
+  bruInstance: bru,
+  logger: console,
+  requestInstance: req
+})
+```
+
+This init is a new requirement for Bruno V3, as the virtual environment the scripts are running in have now been
+configured in such a way that third party modules do not get access to the globals previously available (bru, req), 
+and access to the console in Bruno's developer tools is ALSO siloed.
+
+To combat this, `init` at the collection level in the pre-request script will ensure that the module is able to 
+access the functionality.
+
+## How it works
+The module is developed as an ES module, but needs to be built for publishing. This happens via the `npm run build`. 
+This will overwrite the `es` directory, creating a single `index.js` file that can then be required by Bruno scripts.
+
+## Development
+
+Since this is an NPM, and Bruno collections can be built with NPM using a package.json, this _can_ be run in a 
+workspace for "easy" development. However developing this module is not completely straightforward, and can take a while
+
+### Working in a workspace
+If working in an NPM workspace, as per [bienenvolk-bruno-workspace](https://gitlab.com/knowledge-integration/bruno/bienenvolk-bruno-workspace),
+then the development process is:
+- Make changes to shared scripts
+- Run `build`
+- Restart Bruno GUI 
+  - IMPORTANT, Bruno caches the NPMs it's using per session, so any changes will NOT be visible until a restart
+- Run request
+- Go back to step 1
+
+### Working without a workspace
+The development process is largely the same as working in a workspace, with the only difference being that the 
+version will need to point at the newest version
+
+- Edit Bruno collection package.json to point the bruno-shared-scripts at `file:path/to/file`
+- Run `build` for shared scripts
+- clean `npm install` in the collection (Delete package lock and node_modules to be sure)
+- Restart Bruno GUI
+  - IMPORTANT, Bruno caches the NPMs it's using per session, so any changes will NOT be visible until a restart
+- Run request
+- Go back to step 2
+
+And finally remembering to revert the version pointer at the end when the fixed shared-scripts have been published.
+
+### Bruno globals
+As of Bruno V3, access to `bru`, `req` and `console` will no longer behave as expected within a shared NPM. The 
+solution to this is (for now) a file called `bruno-globals-provider`. This sets up a `setGlobals` method which in 
+turn is used by init (I wanted to keep the globals setter separate from the init in case we have side effects down 
+the road).
+
+Then in each helper method, the requisite getter(s) can be used:
+
+```javascript
+import { getBru, getConsole, getReq } from '../bruno-globals-provider.js';
+
+const helloWorld = () => {
+  const bru = getBru();
+  const logger = getConsole();
+  const req = getReq();
+  
+  logger.log("Hello world");
+  logger.log("Request: %o", req);
+  
+  logger.log("Access Bruno functionality: %o", bru.getEnv("FAKE_ENVIRONMENT_VARIABLE"));
+}
+```
+
+Should post-request script helpers be needed, this will need to be extended to include `res` as well.

package/es/index.js

@@ -91,7 +91,7 @@ var init_auth_utils = __esm({
     };
     getIgnoreCreds = () => {
       const bru = getBru();
-      return bru.getEnvVar("ignoreCreds");
+      return bru.getEnvVar("ignoreCredentials");
     };
     getUserName = () => {
       const bru = getBru();
@@ -131,53 +131,62 @@ var init_login = __esm({
     doALogin = async ({
       urlOverride = void 0,
       withExpiry = true,
-      suppressConsole = true
+      suppressConsole = true,
+      credsOverride = void 0,
+      tenantOverride = void 0
     } = {}) => {
       const logger2 = getConsole();
       const req = getReq();
+      const theTenant = tenantOverride ?? getTenant();
       !suppressConsole && logger2.log(`doALogin(${urlOverride}, ${withExpiry}, ${suppressConsole})`);
-      const ignoreCreds = getIgnoreCreds();
+      const ignoreCreds = !!credsOverride ? false : getIgnoreCreds();
       const preExistingHeaders = req.getHeaders();
       const preExistingTenant = preExistingHeaders[Object.keys(preExistingHeaders).find((key) => key.toLowerCase() === "X-Okapi-Tenant".toLowerCase())];
       if (!preExistingTenant) {
-        req.setHeader("x-okapi-tenant", getTenant());
+        req.setHeader("x-okapi-tenant", theTenant);
       }
       if (!ignoreCreds || ignoreCreds === false) {
         const url = urlOverride ?? (withExpiry ? getLoginWithExpiryUrl() : getLoginUrl());
-        const creds = getCreds();
-        const tenant = getTenant();
-        const config = getBaseRequestConfig();
-        !suppressConsole && logger2.log(`Sending login request to ${url} with creds ${JSON.stringify(creds)} for tenant: ${tenant}`);
+        const creds = credsOverride ?? getCreds();
+        const config = getBaseRequestConfig({ tenantOverride });
+        !suppressConsole && logger2.log(`Sending login request to ${url} with creds ${JSON.stringify(creds)} for tenant: ${theTenant}, and config: ${JSON.stringify(config)}`);
         return await axios.post(
           url,
           creds,
           config
         );
+      } else {
+        !suppressConsole && logger2.log(`Skipping login as ignoreCredentials is set to true`);
       }
     };
     loginFunc = async ({
       urlOverride = void 0,
       withExpiry = true,
-      suppressConsole = true
+      suppressConsole = true,
+      credsOverride = void 0,
+      tenantOverride = void 0
     } = {}) => {
       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);
-        if (!withExpiry) {
-          req.setHeader("x-okapi-token", getToken());
+      await doALogin({ req, urlOverride, withExpiry, suppressConsole, credsOverride, tenantOverride }).then((loginResp) => {
+        const ignoreCreds = !!credsOverride ? false : getIgnoreCreds();
+        if (!ignoreCreds || ignoreCreds === false) {
+          !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);
+          if (!withExpiry) {
+            req.setHeader("x-okapi-token", getToken());
+          }
         }
       }).catch((err) => {
         logger2.error("Failed to login to folio: %o", err);
       });
     };
-    login = (urlOverride, suppressConsole) => loginFunc({ urlOverride, withExpiry: false, suppressConsole });
-    loginWithExpiry = (urlOverride, suppressConsole) => loginFunc({ urlOverride, suppressConsole });
+    login = ({ urlOverride, suppressConsole, credsOverride, tenantOverride } = {}) => loginFunc({ urlOverride, withExpiry: false, suppressConsole, credsOverride, tenantOverride });
+    loginWithExpiry = ({ urlOverride, suppressConsole, credsOverride, tenantOverride } = {}) => loginFunc({ urlOverride, suppressConsole, credsOverride, tenantOverride });
   }
 });
 
@@ -208,8 +217,8 @@ var getBaseRequestConfig;
 var init_config = __esm({
   "src/utils/config.js"() {
     init_auth();
-    getBaseRequestConfig = () => {
-      const tenant = getTenant();
+    getBaseRequestConfig = ({ tenantOverride }) => {
+      const tenant = tenantOverride ?? getTenant();
       return {
         headers: {
           "Content-type": "application/json",
@@ -241,17 +250,26 @@ init_auth();
 
 // src/folioRequest.js
 init_bruno_globals_provider();
+init_auth();
 import axios2 from "axios";
 var { doALogin: doALogin2 } = (init_auth(), __toCommonJS(auth_exports));
 var { getBaseRequestConfig: getBaseRequestConfig2 } = (init_utils(), __toCommonJS(utils_exports));
 var getFolioAxios = async ({
   urlOverride = void 0,
   withExpiry = true,
-  suppressConsole = true
+  suppressConsole = true,
+  credsOverride = void 0,
+  tenantOverride = void 0
 } = {}) => {
   const logger2 = getConsole();
-  return doALogin2({ urlOverride, withExpiry, suppressConsole }).then((loginResp) => {
-    const config = getBaseRequestConfig2();
+  const config = getBaseRequestConfig2({ tenantOverride });
+  const ignoreCreds = !!credsOverride ? false : getIgnoreCreds();
+  if (ignoreCreds) {
+    !suppressConsole && logger2.log("Ignoring credentials so returning a folioAxios without logging in: %o", config);
+    return axios2.create(config);
+  }
+  return doALogin2({ urlOverride, withExpiry, suppressConsole, credsOverride, tenantOverride }).then((loginResp) => {
+    !suppressConsole && logger2.log("folio login succeeded with response: %o", loginResp);
     config.headers.Cookie = loginResp.headers["set-cookie"];
     if (!withExpiry) {
       config.headers["x-okapi-token"] = loginResp.headers["x-okapi-token"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k-int/bruno-shared-scripts",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "exports": "./es/index.js",
   "main": "src/index.js",
   "type": "module",

package/src/auth/auth-utils.js

@@ -15,7 +15,7 @@ const getToken = () => {
 const getIgnoreCreds = () => {
   const bru = getBru();
 
-  return bru.getEnvVar("ignoreCreds")
+  return bru.getEnvVar("ignoreCredentials")
 }
 
 const getUserName = () => {

package/src/auth/login.js

@@ -19,13 +19,17 @@ const getLoginUrl = () => {
 const doALogin = async ({
   urlOverride = undefined,
   withExpiry = true,
-  suppressConsole = true
+  suppressConsole = true,
+  credsOverride = undefined,
+  tenantOverride = undefined
 } = {}) => {
   const logger = getConsole();
   const req = getReq();
 
+  const theTenant = tenantOverride ?? getTenant();
+
   !suppressConsole && logger.log(`doALogin(${urlOverride}, ${withExpiry}, ${suppressConsole})`);
-  const ignoreCreds = getIgnoreCreds();
+  const ignoreCreds = !!credsOverride ? false : getIgnoreCreds();
   //console.log("URL OVERRIDE: %o", urlOverride)
 
   // Ensure that x-okapi-tenant is set if NOT set by request
@@ -35,46 +39,56 @@ const doALogin = async ({
     ] // Make sure this is case insensitive
 
   if (!preExistingTenant) {
-    req.setHeader('x-okapi-tenant', getTenant()) // Keep an eye on this in PM we needed some funky stuff for "disabled" headers
+    req.setHeader('x-okapi-tenant', theTenant) // 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 && logger.log(`Sending login request to ${url} with creds ${JSON.stringify(creds)} for tenant: ${tenant}`);
+    const creds = credsOverride ?? getCreds();
+    const config = getBaseRequestConfig({ tenantOverride });
+
+    !suppressConsole && logger.log(`Sending login request to ${url} with creds ${JSON.stringify(creds)} for tenant: ${theTenant}, and config: ${JSON.stringify(config)}`);
 
     return await axios.post(
       url,
       creds,
       config
-    )
+    );
+  } else {
+    !suppressConsole && logger.log(`Skipping login as ignoreCredentials is set to true`);
   }
 }
 
 const loginFunc = async ({
   urlOverride = undefined,
   withExpiry = true,
-  suppressConsole = true
+  suppressConsole = true,
+  credsOverride = undefined,
+  tenantOverride = undefined,
 } = {}) => {
   const logger = getConsole();
   const bru = getBru();
   const req = getReq();
 
   !suppressConsole && logger.log(`loginFunc(${urlOverride}, ${withExpiry}, ${suppressConsole})`);
-  await doALogin({ req, urlOverride, withExpiry, suppressConsole })
+
+  await doALogin({ req, urlOverride, withExpiry, suppressConsole, credsOverride, tenantOverride })
     .then((loginResp) => {
-      !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"])
+      const ignoreCreds = !!credsOverride ? false : getIgnoreCreds();
+
+      if (!ignoreCreds || ignoreCreds === false) {
+        !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"])
 
-      const token = loginResp.headers["x-okapi-token"]
-      bru.setVar("x-okapi-token-value", token)
+        const token = loginResp.headers["x-okapi-token"]
+        bru.setVar("x-okapi-token-value", token)
 
-      if (!withExpiry) {
-        // This is only populated on login, not login with expiry
-        req.setHeader('x-okapi-token', getToken())
+        if (!withExpiry) {
+          // This is only populated on login, not login with expiry
+          req.setHeader('x-okapi-token', getToken())
+        }
       }
     })
     .catch(err => {
@@ -82,8 +96,8 @@ const loginFunc = async ({
     });
 }
 
-const login = (urlOverride, suppressConsole) => loginFunc({ urlOverride, withExpiry: false, suppressConsole });
-const loginWithExpiry = (urlOverride, suppressConsole) => loginFunc({ urlOverride, suppressConsole });
+const login = ({ urlOverride, suppressConsole, credsOverride, tenantOverride } = {}) => loginFunc({ urlOverride, withExpiry: false, suppressConsole, credsOverride, tenantOverride });
+const loginWithExpiry = ({ urlOverride, suppressConsole, credsOverride, tenantOverride } = {}) => loginFunc({ urlOverride, suppressConsole, credsOverride, tenantOverride });
 
 export {
   doALogin,

package/src/folioRequest.js

@@ -1,5 +1,6 @@
 import axios from 'axios';
 import { getConsole } from './bruno-globals-provider.js';
+import { getIgnoreCreds } from './auth/index.js';
 const { doALogin } = require('./auth');
 
 const { getBaseRequestConfig } = require('./utils');
@@ -7,22 +8,36 @@ const { getBaseRequestConfig } = require('./utils');
 export const getFolioAxios = async ({
   urlOverride = undefined,
   withExpiry = true,
-  suppressConsole = true
+  suppressConsole = true,
+  credsOverride = undefined,
+  tenantOverride = undefined,
 } = {}) => {
   const logger = getConsole();
-  return doALogin({ urlOverride, withExpiry, suppressConsole }).then(loginResp => {
 
-    const config = getBaseRequestConfig()
-    config.headers.Cookie = loginResp.headers["set-cookie"]
+  const config = getBaseRequestConfig({ tenantOverride });
+  const ignoreCreds = !!credsOverride ? false : getIgnoreCreds();
 
-    if (!withExpiry) {
-      // This is only populated on login, not login with expiry
-      config.headers['x-okapi-token'] = loginResp.headers["x-okapi-token"]
-    }
+  // Bypass login/token stuff for ignored credentials
+  if (ignoreCreds) {
+    !suppressConsole && logger.log("Ignoring credentials so returning a folioAxios without logging in: %o", config);
 
-    !suppressConsole && logger.log("folioRequest ready with config: %o", config);
     return axios.create(config);
-  }).catch(err => {
-    logger.error("Failed to login to folio: %o", err)
-  })
+  }
+
+  return doALogin({ urlOverride, withExpiry, suppressConsole, credsOverride, tenantOverride })
+    .then(loginResp => {
+      !suppressConsole && logger.log("folio login succeeded with response: %o", loginResp);
+
+      config.headers.Cookie = loginResp.headers["set-cookie"]
+
+      if (!withExpiry) {
+        // This is only populated on login, not login with expiry
+        config.headers['x-okapi-token'] = loginResp.headers["x-okapi-token"]
+      }
+
+      !suppressConsole && logger.log("folioRequest ready with config: %o", config);
+      return axios.create(config);
+    }).catch(err => {
+      logger.error("Failed to login to folio: %o", err)
+    })
 }

package/src/utils/config.js

@@ -1,7 +1,7 @@
 import { getTenant } from '../auth';
 
-export const getBaseRequestConfig = () => {
-  const tenant = getTenant();
+export const getBaseRequestConfig = ({ tenantOverride }) => {
+  const tenant = tenantOverride ?? getTenant();
   return {
     headers: {
       "Content-type": "application/json",