@arcanewizards/tcnet 0.1.1 → 0.1.2

package/README.md

@@ -0,0 +1,69 @@
+# `@arcanewizards/tcnet`
+
+[![](https://img.shields.io/npm/v/@arcanewizards/tcnet)](https://www.npmjs.com/package/@arcanewizards/tcnet)
+
+TCNet node and monitoring utilities for Node.js applications.
+
+This package can join a TCNet network, maintain node presence, emit packet and node lifecycle events, and derive higher-level timecode state from the underlying protocol traffic.
+
+## Installation
+
+```sh
+pnpm add @arcanewizards/tcnet
+```
+
+## Exports
+
+- `@arcanewizards/tcnet`
+  Exposes `createTCNetNode(...)`.
+- `@arcanewizards/tcnet/monitor`
+  Exposes `createTCNetTimecodeMonitor(...)` and monitor event types.
+- `@arcanewizards/tcnet/types`
+  Exposes `TCNetNode`, `TCNetNodeInfo`, `TCNetConnectedNodes`, `TCNetPortInformation`, `TCNetPortUsage`, `TCNetLogger`, and related runtime types.
+
+## Usage
+
+```ts
+import pino from 'pino';
+import { createTCNetNode } from '@arcanewizards/tcnet';
+import { createTCNetTimecodeMonitor } from '@arcanewizards/tcnet/monitor';
+
+const logger = pino();
+
+const node = createTCNetNode({
+  logger,
+  networkInterface: 'en0',
+  nodeName: 'TCNODE01',
+  vendorName: 'Arcane Wizards',
+  appName: 'Example App',
+  appVersion: '0.1.0',
+});
+
+node.on('ready', () => {
+  logger.info('TCNet node ready');
+});
+
+node.on('nodes-changed', (nodes) => {
+  logger.info(`Connected nodes: ${Object.keys(nodes).length}`);
+});
+
+const monitor = createTCNetTimecodeMonitor(node, logger);
+
+monitor.addListener('timecode-changed', (timecode) => {
+  logger.info(
+    `${timecode.layerName}: ${timecode.playState.state} ${timecode.layerId}`,
+  );
+});
+
+node.connect();
+```
+
+## Lifecycle
+
+- Call `connect()` to bind sockets and start TCNet presence announcements.
+- Listen for `ready`, `port-state-changed`, `nodes-changed`, `time`, `data`, and `node-status` events on the node.
+- Call `destroy()` during shutdown so the node can opt out cleanly and release sockets.
+
+## Logger Contract
+
+`createTCNetNode(...)` expects a logger with `error`, `warn`, `info`, and `debug` methods. `pino` works directly, and the package keeps `pino` as an optional peer dependency.

package/dist/index.cjs

@@ -24,9 +24,9 @@ var _chunkVRXVI5VAcjs = require('./chunk-VRXVI5VA.cjs');
 
 var _chunkVYNI4G3Kcjs = require('./chunk-VYNI4G3K.cjs');
 
-// ../../../node_modules/.pnpm/lodash@4.17.23/node_modules/lodash/lodash.js
+// ../../node_modules/.pnpm/lodash@4.17.23/node_modules/lodash/lodash.js
 var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
-  "../../../node_modules/.pnpm/lodash@4.17.23/node_modules/lodash/lodash.js"(exports, module) {
+  "../../node_modules/.pnpm/lodash@4.17.23/node_modules/lodash/lodash.js"(exports, module) {
     "use strict";
     (function() {
       var undefined;
@@ -359,7 +359,7 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
       var freeModule = freeExports && typeof module == "object" && module && !module.nodeType && module;
       var moduleExports = freeModule && freeModule.exports === freeExports;
       var freeProcess = moduleExports && freeGlobal.process;
-      var nodeUtil = function() {
+      var nodeUtil = (function() {
         try {
           var types = freeModule && freeModule.require && freeModule.require("util").types;
           if (types) {
@@ -368,7 +368,7 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
           return freeProcess && freeProcess.binding && freeProcess.binding("util");
         } catch (e) {
         }
-      }();
+      })();
       var nodeIsArrayBuffer = nodeUtil && nodeUtil.isArrayBuffer, nodeIsDate = nodeUtil && nodeUtil.isDate, nodeIsMap = nodeUtil && nodeUtil.isMap, nodeIsRegExp = nodeUtil && nodeUtil.isRegExp, nodeIsSet = nodeUtil && nodeUtil.isSet, nodeIsTypedArray = nodeUtil && nodeUtil.isTypedArray;
       function apply(func, thisArg, args) {
         switch (args.length) {
@@ -714,7 +714,7 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
       function unicodeWords(string) {
         return string.match(reUnicodeWord) || [];
       }
-      var runInContext = function runInContext2(context) {
+      var runInContext = (function runInContext2(context) {
         context = context == null ? root : _.defaults(root.Object(), context, _.pick(root, contextProps));
         var Array2 = context.Array, Date2 = context.Date, Error2 = context.Error, Function2 = context.Function, Math2 = context.Math, Object2 = context.Object, RegExp2 = context.RegExp, String2 = context.String, TypeError = context.TypeError;
         var arrayProto = Array2.prototype, funcProto = Function2.prototype, objectProto = Object2.prototype;
@@ -722,10 +722,10 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
         var funcToString = funcProto.toString;
         var hasOwnProperty = objectProto.hasOwnProperty;
         var idCounter = 0;
-        var maskSrcKey = function() {
+        var maskSrcKey = (function() {
           var uid = /[^.]+$/.exec(coreJsData && coreJsData.keys && coreJsData.keys.IE_PROTO || "");
           return uid ? "Symbol(src)_1." + uid : "";
-        }();
+        })();
         var nativeObjectToString = objectProto.toString;
         var objectCtorString = funcToString.call(Object2);
         var oldDash = root._;
@@ -733,14 +733,14 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
           "^" + funcToString.call(hasOwnProperty).replace(reRegExpChar, "\\$&").replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g, "$1.*?") + "$"
         );
         var Buffer = moduleExports ? context.Buffer : undefined, Symbol = context.Symbol, Uint8Array = context.Uint8Array, allocUnsafe = Buffer ? Buffer.allocUnsafe : undefined, getPrototype = overArg(Object2.getPrototypeOf, Object2), objectCreate = Object2.create, propertyIsEnumerable = objectProto.propertyIsEnumerable, splice = arrayProto.splice, spreadableSymbol = Symbol ? Symbol.isConcatSpreadable : undefined, symIterator = Symbol ? Symbol.iterator : undefined, symToStringTag = Symbol ? Symbol.toStringTag : undefined;
-        var defineProperty = function() {
+        var defineProperty = (function() {
           try {
             var func = getNative(Object2, "defineProperty");
             func({}, "", {});
             return func;
           } catch (e) {
           }
-        }();
+        })();
         var ctxClearTimeout = context.clearTimeout !== root.clearTimeout && context.clearTimeout, ctxNow = Date2 && Date2.now !== root.Date.now && Date2.now, ctxSetTimeout = context.setTimeout !== root.setTimeout && context.setTimeout;
         var nativeCeil = Math2.ceil, nativeFloor = Math2.floor, nativeGetSymbols = Object2.getOwnPropertySymbols, nativeIsBuffer = Buffer ? Buffer.isBuffer : undefined, nativeIsFinite = context.isFinite, nativeJoin = arrayProto.join, nativeKeys = overArg(Object2.keys, Object2), nativeMax = Math2.max, nativeMin = Math2.min, nativeNow = Date2.now, nativeParseInt = context.parseInt, nativeRandom = Math2.random, nativeReverse = arrayProto.reverse;
         var DataView = getNative(context, "DataView"), Map = getNative(context, "Map"), Promise2 = getNative(context, "Promise"), Set = getNative(context, "Set"), WeakMap = getNative(context, "WeakMap"), nativeCreate = getNative(Object2, "create");
@@ -759,7 +759,7 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
           }
           return new LodashWrapper(value);
         }
-        var baseCreate = /* @__PURE__ */ function() {
+        var baseCreate = /* @__PURE__ */ (function() {
           function object() {
           }
           return function(proto) {
@@ -774,7 +774,7 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
             object.prototype = undefined;
             return result2;
           };
-        }();
+        })();
         function baseLodash() {
         }
         function LodashWrapper(value, chainAll) {
@@ -4086,9 +4086,9 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
         var gte = createRelationalOperation(function(value, other) {
           return value >= other;
         });
-        var isArguments = baseIsArguments(/* @__PURE__ */ function() {
+        var isArguments = baseIsArguments(/* @__PURE__ */ (function() {
           return arguments;
-        }()) ? baseIsArguments : function(value) {
+        })()) ? baseIsArguments : function(value) {
           return isObjectLike(value) && hasOwnProperty.call(value, "callee") && !propertyIsEnumerable.call(value, "callee");
         };
         var isArray = Array2.isArray;
@@ -5340,7 +5340,7 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
         lodash.each = forEach;
         lodash.eachRight = forEachRight;
         lodash.first = head;
-        mixin(lodash, function() {
+        mixin(lodash, (function() {
           var source = {};
           baseForOwn(lodash, function(func, methodName) {
             if (!hasOwnProperty.call(lodash.prototype, methodName)) {
@@ -5348,7 +5348,7 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
             }
           });
           return source;
-        }(), { "chain": false });
+        })(), { "chain": false });
         lodash.VERSION = VERSION;
         arrayEach(["bind", "bindKey", "curry", "curryRight", "partial", "partialRight"], function(methodName) {
           lodash[methodName].placeholder = lodash;
@@ -5508,7 +5508,7 @@ var require_lodash = _chunkVYNI4G3Kcjs.__commonJS.call(void 0, {
           lodash.prototype[symIterator] = wrapperToIterator;
         }
         return lodash;
-      };
+      });
       var _ = runInContext();
       if (typeof define == "function" && typeof define.amd == "object" && define.amd) {
         root._ = _;

package/dist/index.js

@@ -24,9 +24,9 @@ import {
   __toESM
 } from "./chunk-VXAKTGOW.js";
 
-// ../../../node_modules/.pnpm/lodash@4.17.23/node_modules/lodash/lodash.js
+// ../../node_modules/.pnpm/lodash@4.17.23/node_modules/lodash/lodash.js
 var require_lodash = __commonJS({
-  "../../../node_modules/.pnpm/lodash@4.17.23/node_modules/lodash/lodash.js"(exports, module) {
+  "../../node_modules/.pnpm/lodash@4.17.23/node_modules/lodash/lodash.js"(exports, module) {
     "use strict";
     (function() {
       var undefined;
@@ -359,7 +359,7 @@ var require_lodash = __commonJS({
       var freeModule = freeExports && typeof module == "object" && module && !module.nodeType && module;
       var moduleExports = freeModule && freeModule.exports === freeExports;
       var freeProcess = moduleExports && freeGlobal.process;
-      var nodeUtil = function() {
+      var nodeUtil = (function() {
         try {
           var types = freeModule && freeModule.require && freeModule.require("util").types;
           if (types) {
@@ -368,7 +368,7 @@ var require_lodash = __commonJS({
           return freeProcess && freeProcess.binding && freeProcess.binding("util");
         } catch (e) {
         }
-      }();
+      })();
       var nodeIsArrayBuffer = nodeUtil && nodeUtil.isArrayBuffer, nodeIsDate = nodeUtil && nodeUtil.isDate, nodeIsMap = nodeUtil && nodeUtil.isMap, nodeIsRegExp = nodeUtil && nodeUtil.isRegExp, nodeIsSet = nodeUtil && nodeUtil.isSet, nodeIsTypedArray = nodeUtil && nodeUtil.isTypedArray;
       function apply(func, thisArg, args) {
         switch (args.length) {
@@ -714,7 +714,7 @@ var require_lodash = __commonJS({
       function unicodeWords(string) {
         return string.match(reUnicodeWord) || [];
       }
-      var runInContext = function runInContext2(context) {
+      var runInContext = (function runInContext2(context) {
         context = context == null ? root : _.defaults(root.Object(), context, _.pick(root, contextProps));
         var Array2 = context.Array, Date2 = context.Date, Error2 = context.Error, Function2 = context.Function, Math2 = context.Math, Object2 = context.Object, RegExp2 = context.RegExp, String2 = context.String, TypeError = context.TypeError;
         var arrayProto = Array2.prototype, funcProto = Function2.prototype, objectProto = Object2.prototype;
@@ -722,10 +722,10 @@ var require_lodash = __commonJS({
         var funcToString = funcProto.toString;
         var hasOwnProperty = objectProto.hasOwnProperty;
         var idCounter = 0;
-        var maskSrcKey = function() {
+        var maskSrcKey = (function() {
           var uid = /[^.]+$/.exec(coreJsData && coreJsData.keys && coreJsData.keys.IE_PROTO || "");
           return uid ? "Symbol(src)_1." + uid : "";
-        }();
+        })();
         var nativeObjectToString = objectProto.toString;
         var objectCtorString = funcToString.call(Object2);
         var oldDash = root._;
@@ -733,14 +733,14 @@ var require_lodash = __commonJS({
           "^" + funcToString.call(hasOwnProperty).replace(reRegExpChar, "\\$&").replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g, "$1.*?") + "$"
         );
         var Buffer = moduleExports ? context.Buffer : undefined, Symbol = context.Symbol, Uint8Array = context.Uint8Array, allocUnsafe = Buffer ? Buffer.allocUnsafe : undefined, getPrototype = overArg(Object2.getPrototypeOf, Object2), objectCreate = Object2.create, propertyIsEnumerable = objectProto.propertyIsEnumerable, splice = arrayProto.splice, spreadableSymbol = Symbol ? Symbol.isConcatSpreadable : undefined, symIterator = Symbol ? Symbol.iterator : undefined, symToStringTag = Symbol ? Symbol.toStringTag : undefined;
-        var defineProperty = function() {
+        var defineProperty = (function() {
           try {
             var func = getNative(Object2, "defineProperty");
             func({}, "", {});
             return func;
           } catch (e) {
           }
-        }();
+        })();
         var ctxClearTimeout = context.clearTimeout !== root.clearTimeout && context.clearTimeout, ctxNow = Date2 && Date2.now !== root.Date.now && Date2.now, ctxSetTimeout = context.setTimeout !== root.setTimeout && context.setTimeout;
         var nativeCeil = Math2.ceil, nativeFloor = Math2.floor, nativeGetSymbols = Object2.getOwnPropertySymbols, nativeIsBuffer = Buffer ? Buffer.isBuffer : undefined, nativeIsFinite = context.isFinite, nativeJoin = arrayProto.join, nativeKeys = overArg(Object2.keys, Object2), nativeMax = Math2.max, nativeMin = Math2.min, nativeNow = Date2.now, nativeParseInt = context.parseInt, nativeRandom = Math2.random, nativeReverse = arrayProto.reverse;
         var DataView = getNative(context, "DataView"), Map = getNative(context, "Map"), Promise2 = getNative(context, "Promise"), Set = getNative(context, "Set"), WeakMap = getNative(context, "WeakMap"), nativeCreate = getNative(Object2, "create");
@@ -759,7 +759,7 @@ var require_lodash = __commonJS({
           }
           return new LodashWrapper(value);
         }
-        var baseCreate = /* @__PURE__ */ function() {
+        var baseCreate = /* @__PURE__ */ (function() {
           function object() {
           }
           return function(proto) {
@@ -774,7 +774,7 @@ var require_lodash = __commonJS({
             object.prototype = undefined;
             return result2;
           };
-        }();
+        })();
         function baseLodash() {
         }
         function LodashWrapper(value, chainAll) {
@@ -4086,9 +4086,9 @@ var require_lodash = __commonJS({
         var gte = createRelationalOperation(function(value, other) {
           return value >= other;
         });
-        var isArguments = baseIsArguments(/* @__PURE__ */ function() {
+        var isArguments = baseIsArguments(/* @__PURE__ */ (function() {
           return arguments;
-        }()) ? baseIsArguments : function(value) {
+        })()) ? baseIsArguments : function(value) {
           return isObjectLike(value) && hasOwnProperty.call(value, "callee") && !propertyIsEnumerable.call(value, "callee");
         };
         var isArray = Array2.isArray;
@@ -5340,7 +5340,7 @@ var require_lodash = __commonJS({
         lodash.each = forEach;
         lodash.eachRight = forEachRight;
         lodash.first = head;
-        mixin(lodash, function() {
+        mixin(lodash, (function() {
           var source = {};
           baseForOwn(lodash, function(func, methodName) {
             if (!hasOwnProperty.call(lodash.prototype, methodName)) {
@@ -5348,7 +5348,7 @@ var require_lodash = __commonJS({
             }
           });
           return source;
-        }(), { "chain": false });
+        })(), { "chain": false });
         lodash.VERSION = VERSION;
         arrayEach(["bind", "bindKey", "curry", "curryRight", "partial", "partialRight"], function(methodName) {
           lodash[methodName].placeholder = lodash;
@@ -5508,7 +5508,7 @@ var require_lodash = __commonJS({
           lodash.prototype[symIterator] = wrapperToIterator;
         }
         return lodash;
-      };
+      });
       var _ = runInContext();
       if (typeof define == "function" && typeof define.amd == "object" && define.amd) {
         root._ = _;
@@ -5526,12 +5526,12 @@ var require_lodash = __commonJS({
 });
 
 // src/index.ts
-import { createSocket } from "node:dgram";
-import EventEmitter from "node:events";
+import { createSocket } from "dgram";
+import EventEmitter from "events";
 import {
   getNetworkInterfaces
 } from "@arcanewizards/net-utils";
-import { promisify } from "node:util";
+import { promisify } from "util";
 var import_lodash = __toESM(require_lodash(), 1);
 var OPT_IN_INTERVAL = 1e3;
 var PORT_BROADCAST = 6e4;

package/dist/monitor.js

@@ -10,7 +10,7 @@ import {
 } from "./chunk-VXAKTGOW.js";
 
 // src/monitor.ts
-import EventEmitter from "node:events";
+import EventEmitter from "events";
 var MAX_DELTA_MS = 10;
 var layerDataIdToIndex = (dataLayerId) => {
   return dataLayerId - 1;

package/dist/utils.d.cts

@@ -1,4 +1,4 @@
-import { TCNetNodeInfo, TCNetNodeIdentity } from './types.cjs';
+import { TCNetNodeIdentity, TCNetNodeInfo } from './types.cjs';
 import '@arcanewizards/net-utils';
 import './protocol.cjs';
 

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import { TCNetNodeInfo, TCNetNodeIdentity } from './types.js';
+import { TCNetNodeIdentity, TCNetNodeInfo } from './types.js';
 import '@arcanewizards/net-utils';
 import './protocol.js';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcanewizards/tcnet",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "private": false,
   "type": "module",
   "repository": {
@@ -32,14 +32,7 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "rm -rf dist && tsup && check-export-map",
-    "check:types": "tsc --noEmit",
-    "lint": "eslint . --max-warnings 0"
-  },
   "devDependencies": {
-    "@arcanewizards/eslint-config": "workspace:^",
-    "@arcanewizards/typescript-config": "workspace:^",
     "@types/lodash": "^4.17.13",
     "@types/node": "^22.19.3",
     "check-export-map": "^1.3.1",
@@ -47,7 +40,9 @@
     "lodash": "^4.17.21",
     "pino": "^9.5.0",
     "tsup": "^8.1.0",
-    "typescript": "^5.7.3"
+    "typescript": "^5.7.3",
+    "@arcanewizards/typescript-config": "^0.0.0",
+    "@arcanewizards/eslint-config": "^0.0.0"
   },
   "eslintConfig": {
     "extends": [
@@ -63,6 +58,11 @@
     }
   },
   "dependencies": {
-    "@arcanewizards/net-utils": "workspace:^"
+    "@arcanewizards/net-utils": "^0.1.2"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsup && check-export-map",
+    "check:types": "tsc --noEmit",
+    "lint": "eslint . --max-warnings 0"
   }
-}
+}