barbican-reset 3.30.0 → 3.32.0

package/package.json

@@ -1,59 +1,45 @@
 {
-  "_args": [
-    [
-      "barbican-reset@2.7.0",
-      "/Users/pheading/Sites/eticketing-vue"
-    ]
-  ],
-  "_from": "barbican-reset@2.7.0",
-  "_id": "barbican-reset@2.7.0",
-  "_inBundle": false,
-  "_integrity": "sha512-9QMrzuoZ/NZfFlFagC6go3ofn5hBhU9rtSPEeGH0krwY5dBKOlfs8oGIvqUaEGFKI+jQ3spuDOQoeyYK5NRiQw==",
-  "_location": "/barbican-reset",
-  "_phantomChildren": {
-    "array-flatten": "1.1.1",
-    "content-type": "1.0.4",
-    "cookie-signature": "1.0.6",
-    "ee-first": "1.1.1",
-    "encodeurl": "1.0.2",
-    "escape-html": "1.0.3",
-    "etag": "1.8.1",
-    "fresh": "0.5.2",
-    "iconv-lite": "0.4.24",
-    "inherits": "2.0.4",
-    "merge-descriptors": "1.0.1",
-    "methods": "1.1.2",
-    "parseurl": "1.3.3",
-    "path-to-regexp": "0.1.7",
-    "range-parser": "1.2.1",
-    "side-channel": "1.0.4",
-    "type-is": "1.6.18",
-    "unpipe": "1.0.0",
-    "utils-merge": "1.0.1",
-    "vary": "1.1.2"
+  "name": "barbican-reset",
+  "version": "3.32.0",
+  "description": "Shared design system for Barbican projects, providing SCSS utilities, animations, icons, Vue components, and JS helpers for consistent styling and behaviour.",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./animations": "./animations/index.js",
+    "./lists": "./scss/lists.scss",
+    "./reset": "./scss/reset.scss",
+    "./supreme": "./scss/supreme.scss",
+    "./typography": "./scss/typography.scss",
+    "./focus-visible": "./focus-visible.min.js",
+    "./icons": "./icons/index.js",
+    "./icons/account": "./icons/account/index.js",
+    "./icons/confirm": "./icons/confirm/index.js",
+    "./icons/stream": "./icons/stream/index.js",
+    "./scss": "./scss/index.scss",
+    "./scss/functions": "./scss/functions/index.scss",
+    "./scss/mixins": "./scss/mixins/index.scss",
+    "./scss/helpers": "./scss/_helpers.scss",
+    "./scripts/helpers": "./scripts/helpers.js",
+    "./mixins": "./mixins/inputs.js"
   },
-  "_requested": {
-    "type": "version",
-    "registry": true,
-    "raw": "barbican-reset@2.7.0",
-    "name": "barbican-reset",
-    "escapedName": "barbican-reset",
-    "rawSpec": "2.7.0",
-    "saveSpec": null,
-    "fetchSpec": "2.7.0"
+  "imports": {
+    "#animations/*": "./animations/*.js",
+    "#components/*": "./components/*",
+    "#icons/*": "./icons/*",
+    "#mixins/*": "./mixins/*.js",
+    "#styles/*": "./scss/*.scss",
+    "#scripts/*": "./scripts/*.js",
+    "#helpers/*": "./scripts/helpers/*.js"
   },
-  "_requiredBy": [
-    "/"
-  ],
-  "_resolved": "https://registry.npmjs.org/barbican-reset/-/barbican-reset-2.7.0.tgz",
-  "_spec": "2.7.0",
-  "_where": "/Users/pheading/Sites/eticketing-vue",
-  "author": {
-    "name": "Paul Heading"
+  "scripts": {
+    "build:css": "gulp build:css",
+    "serve:patterns": "cd patterns && node index",
+    "watch:patterns": "cd patterns && gulp watch",
+    "style:patterns": "cd patterns && gulp build:css",
+    "build:patterns": "cd patterns && rm -rf html && pug views --out html"
   },
-  "dependencies": {
+  "devDependencies": {
     "express": "^4.19.2",
-    "focus-visible": "^5.2.0",
     "gsap": "^3.7.1",
     "gulp": "^4.0.2",
     "gulp-dart-sass": "^1.0.2",
@@ -61,10 +47,11 @@
     "luxon": "^3.2.1",
     "nodemon": "^3.1.0",
     "pug": "^3.0.2",
-    "serve-favicon": "^2.5.0",
+    "serve-favicon": "^2.5.0"
+  },
+  "peerDependencies": {
     "vue": "^3.5.18"
   },
-  "description": "A collection of useful scss imports and js scripts, that provide consistent styling and functionality across barbican projects.",
   "files": [
     "animations/**/*",
     "components/**/*",
@@ -79,63 +66,13 @@
     "focus-visible.min.js",
     "index.js"
   ],
-  "imports": {
-    "#animations/*": [
-      "./animations/*.js"
-    ],
-    "#components/*": [
-      "./components/*"
-    ],
-    "#icons/*": [
-      "./icons/*"
-    ],
-    "#mixins/*": [
-      "./mixins/*.js"
-    ],
-    "#styles/*": [
-      "./scss/*.scss"
-    ],
-    "#scripts/*": [
-      "./scripts/*.js"
-    ],
-    "#helpers/*": [
-      "./scripts/helpers/*.js"
-    ]
-  },
-  "exports": {
-    ".": "./index.js",
-    "./animations": "./animations/index.js",
-    "./css": "./scss/index.scss",
-    "./lists": "./scss/lists.scss",
-    "./reset": "./scss/reset.scss",
-    "./supreme": "./scss/supreme.scss",
-    "./typography": "./scss/typography.scss",
-    "./focus-visible": "./focus-visible.min.js",
-    "./icons": "./icons/index.js",
-    "./icons/account": "./icons/account/index.js",
-    "./icons/confirm": "./icons/confirm/index.js",
-    "./icons/stream": "./icons/stream/index.js",
-    "./scss": "./scss/index.scss",
-    "./scss/functions": "./scss/functions/index.scss",
-    "./scss/mixins": "./scss/mixins/index.scss",
-    "./scss/helpers": "./scss/_helpers.scss",
-    "./scripts/helpers": "./scripts/helpers.js",
-    "./mixins": "./mixins/inputs.js"
-  },
-  "main": "index.js",
   "homepage": "https://bitbucket.org/barbicandev/barbican-reset#readme",
   "license": "MIT",
-  "name": "barbican-reset",
   "repository": {
     "type": "git",
     "url": "git+https://bitbucket.org/barbicandev/barbican-reset.git"
   },
-  "scripts": {
-    "build:css": "gulp build:css",
-    "serve:patterns": "cd patterns && node index",
-    "watch:patterns": "cd patterns && gulp watch",
-    "style:patterns": "cd patterns && gulp build:css",
-    "build:patterns": "cd patterns && rm -rf html && pug views --out html"
-  },
-  "version": "3.30.0"
+  "author": {
+    "name": "Paul Heading"
+  }
 }

package/scripts/helpers/compareArrays.js

@@ -1,10 +1,14 @@
-// @name compareArrays
-// @description Compares two arrays by converting them into strings
-// @param {string} a - string a
-// @param {string} b - string b
-// @returns {boolean} - result of strict match
-
-// @example compareArrays([1,2,3],[1,2,3]) => true
+/**
+ * Compares two arrays for deep equality using JSON serialization.
+ *
+ * @param {Array} a - The first array to compare.
+ * @param {Array} b - The second array to compare.
+ * @returns {boolean} `true` if both arrays have the same elements in the same order, `false` otherwise.
+ *
+ * @example
+ * compareArrays([1, 2, 3], [1, 2, 3]); // => true
+ * compareArrays([1, 2, 3], [3, 2, 1]); // => false
+ */
 
 export default function (a, b) {
   return JSON.stringify(a) === JSON.stringify(b)

package/scripts/helpers/formatKebabCase.js

@@ -1,9 +1,15 @@
-// @name formatKebabCase
-// @description Formats a string value into kebab case
-// @param {string} value - usually a classname or attribute
-// @returns {string} - string formatted into kebab case
-
-// @example formatKebabCase('Attribute Name') => 'attribute-name'
+/**
+ * Formats a string into kebab-case by removing apostrophes, lowercasing,
+ * and replacing spaces with hyphens. Useful for generating CSS class names
+ * or HTML attributes from human-readable strings.
+ *
+ * @param {string} [value=''] - The string to format (e.g. a class name or attribute label).
+ * @returns {string} The kebab-cased string.
+ *
+ * @example
+ * formatKebabCase('Attribute Name'); // => 'attribute-name'
+ * formatKebabCase("It's A Title");   // => 'its-a-title'
+ */
 
 export default function (value = '') {
   value = String(value)

package/scripts/helpers/logObject.js

@@ -1,7 +1,13 @@
-// @name logObject
-// @description Logs an entire object (including children) to console
-// @param {object} target - target for console log
-// @returns console.log({ complicated: 'object', with : { child : 'values' }})
+/**
+ * Logs an entire object to the console, including deeply nested children.
+ * Uses `util.inspect` to avoid truncation of complex or deeply nested structures.
+ *
+ * @param {*} target - The value to inspect and log.
+ * @returns {void}
+ *
+ * @example
+ * logObject({ complicated: 'object', with: { child: 'values' } })
+ */
 
 import util from 'util'