Update bundling/packaging to have 2 entrypoints

Author: t2t2

.eslintrc.cjs

@@ -1,3 +1,6 @@
+/* eslint-disable @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call */
+const xoTypescript = require('eslint-config-xo-typescript');
+
 /** @type {import('eslint').Linter.Config} */
 module.exports = {
 extends: [
@@ -8,6 +11,24 @@ module.exports = {
 project: './tsconfig.eslint.json',
 extraFileExtensions: ['.cjs'],
 },
+rules: {
+'@typescript-eslint/naming-convention': [
+// Allow for OBS in class/interface name
+...xoTypescript.rules['@typescript-eslint/naming-convention'].map(
+options => {
+console.log({options});
+if (options.selector === 'typeLike' || options.selector === 'interface') {
+return {
+...options,
+format: ['PascalCase'],
+};
+}
+
+return options;
+},
+),
+],
+},
 overrides: [
 {
 files: ['test/**/*.{js,ts}'],

package-lock.json

@@ -14,31 +14,44 @@
  "node.js"
  ],
  "type": "module",
- "main": "dist/obs-ws.cjs",
- "module": "dist/obs-ws.module.js",
- "unpkg": "dist/obs-ws.min.js",
- "exports": "./dist/obs-ws.modern.js",
- "source": "src/index.ts",
- "types": "dist/index.d.ts",
+ "exports": {
+ ".": {
+ "require": "./dist/json.cjs",
+ "browser": "./dist/json.modern.js",
+ "default": "./dist/msgpack.modern.js"
+ },
+ "./json": {
+ "require": "./dist/json.cjs",
+ "default": "./dist/json.modern.js"
+ },
+ "./msgpack": {
+ "require": "./dist/msgpack.cjs",
+ "default": "./dist/msgpack.modern.js"
+ }
+ },
+ "main": "dist/json.cjs",
+ "module": "dist/json.module.js",
+ "amdName": "OBSWebSocket",
+ "unpkg": "dist/obs-ws.min.cjs",
+ "types": "dist/json.d.ts",
+ "engines": {
+ "node": ">12.0"
+ },
  "files": [
  "dist"
  ],
  "scripts": {
- "build": "npm-run-all clean build:bundle build:unpkg",
- "build:bundle": "microbundle -f modern,esm,cjs --no-compress",
- "build:unpkg": "microbundle -f iife src/JsonOBSWebSocket.ts -o dist/obs-ws.min.js --external none",
- "build:obs-types": "cross-env-shell TS_NODE_PROJECT=tsconfig.json \"node $NODE_DEBUG_OPTION -r ts-node/register scripts/build-types-v2.ts\"",
- "postbuild:obs-types": "npm run lint",
+ "build": "npm-run-all clean build:*",
+ "build:bundle": "microbundle -f modern,esm,cjs --no-compress src/{json,msgpack}.ts",
+ "build:unpkg": "microbundle -f iife src/json.ts -o dist/obs-ws.min.js --external none",
  "clean": "rimraf dist",
  "dev": "npm run build:bundle -- --watch",
  "lint": "eslint . --ext .cjs,.js,.ts",
- "test": "npm-run-all test:*",
- "test:static": "npm run lint",
- "test:ava": "npm run ava",
- "test:types": "dtslint types",
- "report": "nyc report --reporter=text-lcov",
- "node-coveralls": "npm run report | coveralls",
- "ava": "nyc ava --verbose"
+ "test": "nyc ava",
+ "test:watch": "ava --watch",
+ "obs-types": "cross-env-shell TS_NODE_PROJECT=tsconfig.json \"node $NODE_DEBUG_OPTION -r ts-node/register scripts/build-types-v2.ts\"",
+ "postobs-types": "npm run lint",
+ "report": "nyc report --reporter=text-lcov"
  },
  "dependencies": {
  "@msgpack/msgpack": "^2.7.1",
@@ -53,36 +66,37 @@
  "@types/crypto-js": "^4.0.1",
  "@types/debug": "^4.1.5",
  "@types/node-fetch": "^2.5.10",
- "@types/ws": "^7.4.4",
- "@typescript-eslint/eslint-plugin": "^4.28.0",
- "@typescript-eslint/parser": "^4.28.0",
- "ava": "^3.15.0",
+ "@types/ws": "^8.2.0",
+ "@typescript-eslint/eslint-plugin": "^5.4.0",
+ "@typescript-eslint/parser": "^5.4.0",
+ "ava": "^4.0.0-rc.1",
  "coveralls": "^3.1.0",
  "cross-env": "^7.0.3",
- "eslint": "^7.28.0",
- "eslint-config-xo": "^0.38.0",
- "eslint-config-xo-typescript": "^0.44.0",
- "eslint-plugin-ava": "^12.0.0",
+ "eslint": "^8.2.0",
+ "eslint-config-xo": "^0.39.0",
+ "eslint-config-xo-typescript": "^0.47.1",
+ "eslint-plugin-ava": "^13.1.0",
  "lodash.deburr": "^4.1.0",
- "microbundle": "^0.13.3",
+ "microbundle": "^0.14.2",
  "node-fetch": "^2.6.1",
  "npm-run-all": "^4.1.5",
  "nyc": "^15.1.0",
  "rimraf": "^3.0.2",
- "ts-node": "^10.2.1",
+ "ts-node": "^10.4.0",
  "typescript": "^4.4.3"
  },
  "bugs": {
  "url": "https://github.com/obs-websocket-community-projects/obs-websocket-js/issues"
  },
  "homepage": "https://github.com/obs-websocket-community-projects/obs-websocket-js#readme",
  "ava": {
- "files": [
- "test/*.spec.js",
- "!setup/environment.js"
+ "extensions": {
+ "ts": "module"
+ },
+ "nodeArguments": [
+ "--loader=ts-node/esm",
+ "--experimental-specifier-resolution=node"
  ],
- "concurrency": 1,
- "timeout": "10s",
  "verbose": true
  }
 }

package.json

@@ -37,15 +37,15 @@ IncomingMessageTypes[OpCode.Identified]
 export abstract class BaseOBSWebSocket extends EventEmitter<MapValueToArgsArray<EventTypes>> {
 protected static requestCounter = 0;
 
+protected static generateMessageId(): string {
+return String(BaseOBSWebSocket.requestCounter++);
+}
+
 protected _identified = false;
 protected internalListeners = new EventEmitter();
 protected socket?: WebSocket;
 protected abstract protocol: string;
 
-protected static generateMessageId(): string {
-return String(BaseOBSWebSocket.requestCounter++);
-}
-
 public get identified() {
 return this._identified;
 }
@@ -68,15 +68,15 @@ export abstract class BaseOBSWebSocket extends EventEmitter<MapValueToArgsArray<
 }
 
 try {
-const ConnectionClosedPromise = this.internalEventPromise<CloseEvent>('ConnectionClosed');
+const connectionClosedPromise = this.internalEventPromise<CloseEvent>('ConnectionClosed');
 
 return await Promise.race([
 (async () => {
 const hello = await this.createConnection(url);
 this.emit('Hello', hello);
 return this.identify(hello, password, identificationParams);
 })(),
-ConnectionClosedPromise.then(e => {
+connectionClosedPromise.then(e => {
 throw new OBSWebSocketError(e.code, e.reason);
 }),
 ]);
@@ -94,9 +94,9 @@ export abstract class BaseOBSWebSocket extends EventEmitter<MapValueToArgsArray<
 return;
 }
 
-const ConnectionClosedPromise = this.internalEventPromise('ConnectionClosed');
+const connectionClosedPromise = this.internalEventPromise('ConnectionClosed');
 this.socket.close();
-await ConnectionClosedPromise;
+await connectionClosedPromise;
 }
 
 /**
@@ -106,9 +106,9 @@ export abstract class BaseOBSWebSocket extends EventEmitter<MapValueToArgsArray<
  * @returns Identified message data
  */
 async reidentify(data: OutgoingMessageTypes[OpCode.Reidentify]) {
-const IdentifiedPromise = this.internalEventPromise<IncomingMessageTypes[OpCode.Identified]>(`op:${OpCode.Identified}`);
+const identifiedPromise = this.internalEventPromise<IncomingMessageTypes[OpCode.Identified]>(`op:${OpCode.Identified}`);
 await this.message(OpCode.Reidentify, data);
-return IdentifiedPromise;
+return identifiedPromise;
 }
 
 /**
@@ -119,13 +119,13 @@ export abstract class BaseOBSWebSocket extends EventEmitter<MapValueToArgsArray<
  */
 async call<Type extends keyof OBSRequestTypes>(requestType: Type, requestData: OBSRequestTypes[Type]): Promise<OBSResponseTypes[Type]> {
 const requestId = BaseOBSWebSocket.generateMessageId();
-const ResponsePromise = this.internalEventPromise<ResponseMessage<Type>>(`res:${requestId}`);
+const responsePromise = this.internalEventPromise<ResponseMessage<Type>>(`res:${requestId}`);
 await this.message(OpCode.Request, {
 requestId,
 requestType,
 requestData,
 } as RequestMessage<Type>);
-const {requestStatus, responseData} = await ResponsePromise;
+const {requestStatus, responseData} = await responsePromise;
 
 if (!requestStatus.result) {
 throw new OBSWebSocketError(requestStatus.code, requestStatus.comment);
@@ -159,16 +159,16 @@ export abstract class BaseOBSWebSocket extends EventEmitter<MapValueToArgsArray<
  * @param url Websocket address
  */
 protected async createConnection(url: string) {
-const ConnectionOpenedPromise = this.internalEventPromise('ConnectionOpened');
-const HelloPromise = this.internalEventPromise<IncomingMessageTypes[OpCode.Hello]>(`op:${OpCode.Hello}`);
+const connectionOpenedPromise = this.internalEventPromise('ConnectionOpened');
+const helloPromise = this.internalEventPromise<IncomingMessageTypes[OpCode.Hello]>(`op:${OpCode.Hello}`);
 
 this.socket = new WebSocketIpml(url, this.protocol) as unknown as WebSocket;
 this.socket.onopen = this.onOpen.bind(this);
 this.socket.onmessage = this.onMessage.bind(this);
 this.socket.onerror = this.onError.bind(this);
 this.socket.onclose = this.onClose.bind(this);
 
-await ConnectionOpenedPromise;
+await connectionOpenedPromise;
 const protocol = this.socket?.protocol;
 if (!protocol) {
 throw new OBSWebSocketError(-1, 'Missing socket protocol (server must be v5 or newer)');
@@ -178,7 +178,7 @@ export abstract class BaseOBSWebSocket extends EventEmitter<MapValueToArgsArray<
 throw new OBSWebSocketError(-2, `Unknown socket protocol (${protocol})`);
 }
 
-return HelloPromise;
+return helloPromise;
 }
 
 /**
@@ -208,9 +208,9 @@ export abstract class BaseOBSWebSocket extends EventEmitter<MapValueToArgsArray<
 data.authentication = authenticationHashing(authentication.salt, authentication.challenge, password);
 }
 
-const IdentifiedPromise = this.internalEventPromise<IncomingMessageTypes[OpCode.Identified]>(`op:${OpCode.Identified}`);
+const identifiedPromise = this.internalEventPromise<IncomingMessageTypes[OpCode.Identified]>(`op:${OpCode.Identified}`);
 await this.message(OpCode.Identify, data);
-const identified = await IdentifiedPromise;
+const identified = await identifiedPromise;
 this._identified = true;
 this.emit('Identified', identified);
 

src/BaseOBSWebSocket.ts renamed to src/base.ts

@@ -1,5 +1,7 @@
-import {BaseOBSWebSocket} from './BaseOBSWebSocket.js';
+import {BaseOBSWebSocket} from './base.js';
+export {OBSWebSocketError} from './base.js';
 import {IncomingMessage, OutgoingMessage} from './types.js';
+export * from './types.js';
 
 export default class JsonOBSWebSocket extends BaseOBSWebSocket {
 protocol = 'obswebsocket.json';

src/index.ts

@@ -1,6 +1,8 @@
 import {decode, encode} from '@msgpack/msgpack';
-import {BaseOBSWebSocket} from './BaseOBSWebSocket.js';
+import {BaseOBSWebSocket} from './base.js';
+export {OBSWebSocketError} from './base.js';
 import {IncomingMessage, OutgoingMessage} from './types.js';
+export * from './types.js';
 
 export default class MsgpackOBSWebSocket extends BaseOBSWebSocket {
 protocol = 'obswebsocket.msgpack';

src/JsonOBSWebSocket.ts renamed to src/json.ts

@@ -1,5 +1,5 @@
 // This file is manually updated while obs-websocket doesn't have
-// comments.json in 5.x branch.
+// docs/comments.json in 5.x branch.
 
 import {JsonObject, JsonPrimitive, JsonValue} from 'type-fest';