@favish/staffbase-utils 0.1.0

package/README.md

@@ -0,0 +1,21 @@
+# @favish/staffbase-utils
+
+Shared internal/host utilities for Staffbase widgets. Tree-shakeable subpath
+modules; import only what you use.
+
+## Modules
+
+- `@favish/staffbase-utils/log` — `logError`, `logWarn`, `logDebug`, `setLoggingEnabled`
+
+## Logging
+
+The library never reads env flags directly (webview-safe). Enable console output
+once at widget startup with your own flag:
+
+```ts
+import { setLoggingEnabled } from '@favish/staffbase-utils/log'
+
+setLoggingEnabled(import.meta.env.VITE_SHOW_CONSOLE_ERRORS === 'true')
+```
+
+Disabled by default, so production stays silent.

package/dist/log.cjs.js

@@ -0,0 +1,2 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e={enabled:!1},t=(...t)=>{e.enabled&&console.log(...t)},n=(...t)=>{e.enabled&&console.error(...t)},r=(...t)=>{e.enabled&&console.warn(...t)},i=t=>{e.enabled=t};exports.logDebug=t,exports.logError=n,exports.logWarn=r,exports.setLoggingEnabled=i;
+//# sourceMappingURL=log.cjs.js.map

package/dist/log.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.cjs.js","names":[],"sources":["../src/log/loggingState.ts","../src/log/logDebug.ts","../src/log/logError.ts","../src/log/logWarn.ts","../src/log/setLoggingEnabled.ts"],"sourcesContent":["/**\n * Module-private on/off switch for console diagnostics. Default false keeps\n * production silent. Consumers flip it via setLoggingEnabled at startup so the\n * library never reads the host environment flags directly (webview-safe).\n */\nexport const loggingState: { enabled: boolean } = { enabled: false }\n","import { loggingState } from './loggingState'\n\n/**\n * Logs a debug message only when logging is enabled. Silent by default.\n * @param {...unknown} args - Arguments forwarded to console.log.\n */\nexport const logDebug = (...args: unknown[]): void => {\n  // eslint-disable-next-line no-console\n  if (loggingState.enabled) console.log(...args)\n}\n","import { loggingState } from './loggingState'\n\n/**\n * Logs an error only when logging is enabled. Silent by default.\n * @param {...unknown} args - Arguments forwarded to console.error.\n */\nexport const logError = (...args: unknown[]): void => {\n  if (loggingState.enabled) console.error(...args)\n}\n","import { loggingState } from './loggingState'\n\n/**\n * Logs a warning only when logging is enabled. Silent by default.\n * @param {...unknown} args - Arguments forwarded to console.warn.\n */\nexport const logWarn = (...args: unknown[]): void => {\n  if (loggingState.enabled) console.warn(...args)\n}\n","import { loggingState } from './loggingState'\n\n/**\n * Enable or disable console diagnostics for all log helpers.\n * @param {boolean} enabled - True to print, false to silence.\n */\nexport const setLoggingEnabled = (enabled: boolean): void => {\n  loggingState.enabled = enabled\n}\n"],"mappings":"mEAKA,IAAa,EAAqC,CAAE,QAAS,EAAM,ECCtD,GAAY,GAAG,IAA0B,CAEhD,EAAa,SAAS,QAAQ,IAAI,GAAG,CAAI,CAC/C,ECHa,GAAY,GAAG,IAA0B,CAChD,EAAa,SAAS,QAAQ,MAAM,GAAG,CAAI,CACjD,ECFa,GAAW,GAAG,IAA0B,CAC/C,EAAa,SAAS,QAAQ,KAAK,GAAG,CAAI,CAChD,ECFa,EAAqB,GAA2B,CAC3D,EAAa,QAAU,CACzB"}

package/dist/log.es.mjs

@@ -0,0 +1,14 @@
+//#region src/log/loggingState.ts
+var e = { enabled: !1 }, t = (...t) => {
+	e.enabled && console.log(...t);
+}, n = (...t) => {
+	e.enabled && console.error(...t);
+}, r = (...t) => {
+	e.enabled && console.warn(...t);
+}, i = (t) => {
+	e.enabled = t;
+};
+//#endregion
+export { t as logDebug, n as logError, r as logWarn, i as setLoggingEnabled };
+
+//# sourceMappingURL=log.es.mjs.map

package/dist/log.es.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.es.mjs","names":[],"sources":["../src/log/loggingState.ts","../src/log/logDebug.ts","../src/log/logError.ts","../src/log/logWarn.ts","../src/log/setLoggingEnabled.ts"],"sourcesContent":["/**\n * Module-private on/off switch for console diagnostics. Default false keeps\n * production silent. Consumers flip it via setLoggingEnabled at startup so the\n * library never reads the host environment flags directly (webview-safe).\n */\nexport const loggingState: { enabled: boolean } = { enabled: false }\n","import { loggingState } from './loggingState'\n\n/**\n * Logs a debug message only when logging is enabled. Silent by default.\n * @param {...unknown} args - Arguments forwarded to console.log.\n */\nexport const logDebug = (...args: unknown[]): void => {\n  // eslint-disable-next-line no-console\n  if (loggingState.enabled) console.log(...args)\n}\n","import { loggingState } from './loggingState'\n\n/**\n * Logs an error only when logging is enabled. Silent by default.\n * @param {...unknown} args - Arguments forwarded to console.error.\n */\nexport const logError = (...args: unknown[]): void => {\n  if (loggingState.enabled) console.error(...args)\n}\n","import { loggingState } from './loggingState'\n\n/**\n * Logs a warning only when logging is enabled. Silent by default.\n * @param {...unknown} args - Arguments forwarded to console.warn.\n */\nexport const logWarn = (...args: unknown[]): void => {\n  if (loggingState.enabled) console.warn(...args)\n}\n","import { loggingState } from './loggingState'\n\n/**\n * Enable or disable console diagnostics for all log helpers.\n * @param {boolean} enabled - True to print, false to silence.\n */\nexport const setLoggingEnabled = (enabled: boolean): void => {\n  loggingState.enabled = enabled\n}\n"],"mappings":";AAKA,IAAa,IAAqC,EAAE,SAAS,GAAM,GCCtD,KAAY,GAAG,MAA0B;CAEpD,AAAI,EAAa,WAAS,QAAQ,IAAI,GAAG,CAAI;AAC/C,GCHa,KAAY,GAAG,MAA0B;CACpD,AAAI,EAAa,WAAS,QAAQ,MAAM,GAAG,CAAI;AACjD,GCFa,KAAW,GAAG,MAA0B;CACnD,AAAI,EAAa,WAAS,QAAQ,KAAK,GAAG,CAAI;AAChD,GCFa,KAAqB,MAA2B;CAC3D,EAAa,UAAU;AACzB"}

package/dist/src/log/index.d.ts

@@ -0,0 +1,5 @@
+export { logDebug } from './logDebug';
+export { logError } from './logError';
+export { logWarn } from './logWarn';
+export { setLoggingEnabled } from './setLoggingEnabled';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/log/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/log/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA"}

package/dist/src/log/logDebug.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Logs a debug message only when logging is enabled. Silent by default.
+ * @param {...unknown} args - Arguments forwarded to console.log.
+ */
+export declare const logDebug: (...args: unknown[]) => void;
+//# sourceMappingURL=logDebug.d.ts.map

package/dist/src/log/logDebug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logDebug.d.ts","sourceRoot":"","sources":["../../../src/log/logDebug.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,GAAG,MAAM,OAAO,EAAE,KAAG,IAG7C,CAAA"}

package/dist/src/log/logError.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Logs an error only when logging is enabled. Silent by default.
+ * @param {...unknown} args - Arguments forwarded to console.error.
+ */
+export declare const logError: (...args: unknown[]) => void;
+//# sourceMappingURL=logError.d.ts.map

package/dist/src/log/logError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logError.d.ts","sourceRoot":"","sources":["../../../src/log/logError.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,GAAG,MAAM,OAAO,EAAE,KAAG,IAE7C,CAAA"}

package/dist/src/log/logWarn.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Logs a warning only when logging is enabled. Silent by default.
+ * @param {...unknown} args - Arguments forwarded to console.warn.
+ */
+export declare const logWarn: (...args: unknown[]) => void;
+//# sourceMappingURL=logWarn.d.ts.map

package/dist/src/log/logWarn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logWarn.d.ts","sourceRoot":"","sources":["../../../src/log/logWarn.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,GAAG,MAAM,OAAO,EAAE,KAAG,IAE5C,CAAA"}

package/dist/src/log/loggingState.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Module-private on/off switch for console diagnostics. Default false keeps
+ * production silent. Consumers flip it via setLoggingEnabled at startup so the
+ * library never reads the host environment flags directly (webview-safe).
+ */
+export declare const loggingState: {
+    enabled: boolean;
+};
+//# sourceMappingURL=loggingState.d.ts.map

package/dist/src/log/loggingState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggingState.d.ts","sourceRoot":"","sources":["../../../src/log/loggingState.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAuB,CAAA"}

package/dist/src/log/setLoggingEnabled.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Enable or disable console diagnostics for all log helpers.
+ * @param {boolean} enabled - True to print, false to silence.
+ */
+export declare const setLoggingEnabled: (enabled: boolean) => void;
+//# sourceMappingURL=setLoggingEnabled.d.ts.map

package/dist/src/log/setLoggingEnabled.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setLoggingEnabled.d.ts","sourceRoot":"","sources":["../../../src/log/setLoggingEnabled.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,SAAS,OAAO,KAAG,IAEpD,CAAA"}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@favish/staffbase-utils",
+  "version": "0.1.0",
+  "description": "Shared internal/host utilities for Staffbase widgets",
+  "author": "Favish <dev@favish.com>",
+  "packageManager": "pnpm@11.5.0",
+  "license": "UNLICENSED",
+  "type": "module",
+  "files": ["dist"],
+  "exports": {
+    "./log": {
+      "types": "./dist/src/log/index.d.ts",
+      "import": "./dist/log.es.mjs",
+      "require": "./dist/log.cjs.js"
+    }
+  },
+  "scripts": {
+    "build": "vite build",
+    "check:all": "pnpm run format && pnpm run lint:fix && pnpm run type-check && pnpm run test",
+    "format": "prettier --write \"src/**/*\" --list-different",
+    "lint": "eslint ./src",
+    "lint:fix": "eslint ./src --fix",
+    "prepare": "pnpm run format && pnpm run type-check && pnpm run lint:fix && pnpm run build",
+    "prepublishOnly": "pnpm run test",
+    "publish:major": "pnpm run prepare && pnpm version major && pnpm publish",
+    "publish:minor": "pnpm run prepare && pnpm version minor && pnpm publish",
+    "publish:patch": "pnpm run prepare && pnpm version patch && pnpm publish",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "type-check": "tsc --pretty --noEmit",
+    "type-check:watch": "tsc --pretty --noEmit --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/favish/staffbase-utils"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": { "optional": true },
+    "react-dom": { "optional": true }
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.5",
+    "@eslint/js": "^10.0.1",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25",
+    "@typescript-eslint/eslint-plugin": "^8.60.0",
+    "@typescript-eslint/parser": "^8.60.0",
+    "eslint": "^10.4.0",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsdoc": "^63.0.0",
+    "eslint-plugin-react": "^7.37.5",
+    "jest": "^30.4.2",
+    "jest-environment-jsdom": "^30.4.1",
+    "prettier": "^3.8.3",
+    "prettier-plugin-organize-imports": "^4.3.0",
+    "ts-jest": "^29.4.11",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.60.0",
+    "vite": "^8.0.14",
+    "vite-plugin-dts": "^5.0.1"
+  }
+}