@bobfrankston/miscassists 1.0.46 → 1.0.48

package/README.md

@@ -0,0 +1,112 @@
+# @bobfrankston/miscassists
+
+Miscellaneous assists for various tasks including DNS utilities, port number definitions, and integration helpers for jserve and smart home systems.
+
+## Installation
+
+```bash
+npm install @bobfrankston/miscassists
+```
+
+## Features
+
+This package provides several utility modules:
+
+### DNS Assist (`dnsassist`)
+
+DNS resolution utilities with local IP address prioritization:
+
+- **`resolve4(name: string, local?: boolean)`** - Resolves hostname to IPv4, prioritizing local addresses
+- **`resolveLocal4(name: string)`** - Resolves hostname to local IPv4 addresses only
+- **`isLocalIP(ip: string)`** - Checks if an IP address is a local network address
+- **`isThisMachine(ip: string)`** - Checks if an IP address belongs to the current machine
+- **`default_fqdn`** - Default fully qualified domain name
+
+### Ports Configuration (`ports`)
+
+Centralized port number definitions for various services:
+
+```typescript
+import { ports } from '@bobfrankston/miscassists';
+
+console.log(ports.jserve2);  // 10080
+console.log(ports.rmfsite);  // 9081
+```
+
+Includes port definitions for:
+- jserve2 (HTTP/HTTPS)
+- Home automation listeners (Hubitat MakerAPI, Home Assistant)
+- RMF site variants (production, beta, alpha)
+- SQL services (TCP, HTTP, proxy)
+- Various application servers
+
+### jServe Support (`jserve`)
+
+Types and interfaces for jserve integration:
+
+- **`jSubSiteInfo`** - Interface for subsite configuration
+- **`jpriv`** - User privilege levels type
+- **`jprivs`** - Array of privilege levels: admin, user, guest, home, bbs
+
+### Maker API Support (`maker`)
+
+TypeScript interface for Hubitat MakerAPI payloads:
+
+- **`makerPayload`** - Type definition for smart home device events
+
+## Usage
+
+### Basic Import
+
+```typescript
+import { resolve4, ports, jprivs } from '@bobfrankston/miscassists';
+
+// Resolve hostname with local IP priority
+const ip = await resolve4('myserver');
+
+// Access port definitions
+const serverPort = ports.jserve2;
+
+// Check user privileges
+if (jprivs.includes('admin')) {
+  // Admin operations
+}
+```
+
+### Default Import
+
+```typescript
+import miscassists from '@bobfrankston/miscassists';
+
+const ip = await miscassists.resolve4('hostname');
+const port = miscassists.ports.jserve2;
+```
+
+## Development
+
+### Build
+
+```bash
+npm run build
+```
+
+### Release
+
+```bash
+npm run release
+```
+
+This will:
+1. Build the TypeScript sources
+2. Commit changes
+3. Increment patch version
+4. Push to git with tags
+5. Publish to npm
+
+## License
+
+ISC
+
+## Repository
+
+[https://github.com/BobFrankston/miscassists](https://github.com/BobFrankston/miscassists)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bobfrankston/miscassists",
-  "version": "1.0.46",
-  "description": "",
+  "version": "1.0.48",
+  "description": "Miscelleanous assists for various tasks including defining port numbers",
   "main": "index.js",
   "module": "main.js",
   "scripts": {