@companion-surface/base 0.1.5 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.2.0](https://github.com/bitfocus/companion-surface-api/compare/companion-surface-base-v0.1.5...companion-surface-base-v0.2.0) (2025-10-23)
+
+
+### Features
+
+* expose logging utils ([1b12ae0](https://github.com/bitfocus/companion-surface-api/commit/1b12ae0dcd9f70da47d643c7881b3c02d4e5a5d6))
+
 ## [0.1.5](https://github.com/bitfocus/companion-surface-api/compare/companion-surface-base-v0.1.4...companion-surface-base-v0.1.5) (2025-10-21)
 
 

package/dist/logging.d.ts

@@ -0,0 +1,21 @@
+declare global {
+    /**
+     * INTERNAL USE ONLY
+     */
+    var SURFACE_LOGGER: LoggingSink | undefined;
+}
+export type LogLevel = 'info' | 'warn' | 'error' | 'debug';
+export interface ModuleLogger {
+    debug: (message: string) => void;
+    info: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+}
+export type LoggingSink = (source: string | undefined, level: LogLevel, message: string) => void;
+/**
+ * Create a logger instance
+ * @param source The source path to use for the logger
+ * @returns A logger instance
+ */
+export declare function createModuleLogger(source?: string): ModuleLogger;
+//# sourceMappingURL=logging.d.ts.map

package/dist/logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.ts","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,cAAc,EAAE,WAAW,GAAG,SAAS,CAAA;CAC3C;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA;AAE1D,MAAM,WAAW,YAAY;IAC5B,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IAChC,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/B,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/B,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;CAChC;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;AAYhG;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,YAAY,CAOhE"}

package/dist/logging.js

@@ -0,0 +1,22 @@
+const defaultLoggingSink = (source, level, message) => {
+    // Default logging implementation for unit testing purposes, this should be replaced by the host application
+    console.log(`[${level.toUpperCase()}]${source ? ` [${source}]` : ''} ${message}`);
+};
+function logToSink(source, level, message) {
+    const sink = typeof global.SURFACE_LOGGER === 'function' ? global.SURFACE_LOGGER : defaultLoggingSink;
+    sink(source, level, message);
+}
+/**
+ * Create a logger instance
+ * @param source The source path to use for the logger
+ * @returns A logger instance
+ */
+export function createModuleLogger(source) {
+    return {
+        debug: (message) => logToSink(source, 'debug', message),
+        info: (message) => logToSink(source, 'info', message),
+        warn: (message) => logToSink(source, 'warn', message),
+        error: (message) => logToSink(source, 'error', message),
+    };
+}
+//# sourceMappingURL=logging.js.map

package/dist/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":"AAkBA,MAAM,kBAAkB,GAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;IAClE,4GAA4G;IAC5G,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC,CAAA;AAClF,CAAC,CAAA;AAED,SAAS,SAAS,CAAC,MAA0B,EAAE,KAAe,EAAE,OAAe;IAC9E,MAAM,IAAI,GAAG,OAAO,MAAM,CAAC,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,kBAAkB,CAAA;IACrG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAC7B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAe;IACjD,OAAO;QACN,KAAK,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;QAC/D,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;QAC7D,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;QAC7D,KAAK,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;KAC/D,CAAA;AACF,CAAC"}

package/dist/main.d.ts

@@ -1,3 +1,4 @@
+export * from './logging.js';
 export * from './manifest.js';
 export * from './surface-api/index.js';
 export * from './util.js';

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA;AAEzB,mBAAmB,kCAAkC,CAAA"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA;AAEzB,mBAAmB,kCAAkC,CAAA"}

package/dist/main.js

@@ -1,3 +1,4 @@
+export * from './logging.js';
 export * from './manifest.js';
 export * from './surface-api/index.js';
 export * from './util.js';

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA"}

package/dist/surface-api/index.d.ts

@@ -1,6 +1,5 @@
 export * from './cards.js';
 export * from './context.js';
-export * from './enums.js';
 export * from './instance.js';
 export * from './pincode.js';
 export * from './plugin.js';

package/dist/surface-api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/surface-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/surface-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}

package/dist/surface-api/index.js

@@ -1,6 +1,5 @@
 export * from './cards.js';
 export * from './context.js';
-export * from './enums.js';
 export * from './instance.js';
 export * from './pincode.js';
 export * from './plugin.js';

package/dist/surface-api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/surface-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/surface-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@companion-surface/base",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "type": "module",
   "license": "MIT",
   "repository": "https://github.com/bitfocus/companion-surface-api",

package/dist/surface-api/enums.d.ts

@@ -1,2 +0,0 @@
-export type LogLevel = 'info' | 'warn' | 'error' | 'debug';
-//# sourceMappingURL=enums.d.ts.map

package/dist/surface-api/enums.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/surface-api/enums.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA"}

package/dist/surface-api/enums.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=enums.js.map

package/dist/surface-api/enums.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/surface-api/enums.ts"],"names":[],"mappings":""}