dreaction-protocol 1.0.0

package/lib/command.d.ts

@@ -0,0 +1,84 @@
+import { DataWatchPayload } from './data';
+import type { LogPayload } from './log';
+import { NetworkPayload } from './network';
+import { EditorOpenPayload } from './openInEditor';
+import type { StateActionCompletePayload, StateActionDispatchPayload, StateBackupRequestPayload, StateBackupResponsePayload, StateKeysRequestPayload, StateKeysResponsePayload, StateRestoreRequestPayload, StateValuesChangePayload, StateValuesRequestPayload, StateValuesResponsePayload, StateValuesSubscribePayload } from './state';
+export declare const CommandType: {
+    readonly ApiResponse: "api.response";
+    readonly AsyncStorageMutation: "asyncStorage.mutation";
+    readonly Benchmark: "benchmark.report";
+    readonly ClientIntro: "client.intro";
+    readonly Display: "display";
+    readonly Image: "image";
+    readonly Log: "log";
+    readonly DataWatch: "dataWatch";
+    readonly SagaTaskComplete: "saga.task.complete";
+    readonly StateActionComplete: "state.action.complete";
+    readonly StateKeysResponse: "state.keys.response";
+    readonly StateValuesChange: "state.values.change";
+    readonly StateValuesResponse: "state.values.response";
+    readonly StateBackupResponse: "state.backup.response";
+    readonly StateBackupRequest: "state.backup.request";
+    readonly StateRestoreRequest: "state.restore.request";
+    readonly StateActionDispatch: "state.action.dispatch";
+    readonly StateValuesSubscribe: "state.values.subscribe";
+    readonly StateKeysRequest: "state.keys.request";
+    readonly StateValuesRequest: "state.values.request";
+    readonly CustomCommandRegister: "customCommand.register";
+    readonly CustomCommandUnregister: "customCommand.unregister";
+    readonly Clear: "clear";
+    readonly ReplLsResponse: "repl.ls.response";
+    readonly ReplExecuteResponse: "repl.execute.response";
+    readonly DevtoolsOpen: "devtools.open";
+    readonly DevtoolsReload: "devtools.reload";
+    readonly EditorOpen: "editor.open";
+    readonly Storybook: "storybook";
+    readonly Overlay: "overlay";
+};
+export type CommandTypeKey = (typeof CommandType)[keyof typeof CommandType];
+export interface CommandMap {
+    [CommandType.ApiResponse]: NetworkPayload;
+    [CommandType.AsyncStorageMutation]: any;
+    [CommandType.Benchmark]: any;
+    [CommandType.ClientIntro]: any;
+    [CommandType.Display]: any;
+    [CommandType.Image]: any;
+    [CommandType.Log]: LogPayload;
+    [CommandType.DataWatch]: DataWatchPayload;
+    [CommandType.SagaTaskComplete]: any;
+    [CommandType.StateActionComplete]: StateActionCompletePayload;
+    [CommandType.StateKeysResponse]: StateKeysResponsePayload;
+    [CommandType.StateValuesChange]: StateValuesChangePayload;
+    [CommandType.StateValuesResponse]: StateValuesResponsePayload;
+    [CommandType.StateBackupResponse]: StateBackupResponsePayload;
+    [CommandType.StateBackupRequest]: StateBackupRequestPayload;
+    [CommandType.StateRestoreRequest]: StateRestoreRequestPayload;
+    [CommandType.StateActionDispatch]: StateActionDispatchPayload;
+    [CommandType.StateValuesSubscribe]: StateValuesSubscribePayload;
+    [CommandType.StateKeysRequest]: StateKeysRequestPayload;
+    [CommandType.StateValuesRequest]: StateValuesRequestPayload;
+    [CommandType.CustomCommandRegister]: any;
+    [CommandType.CustomCommandUnregister]: any;
+    [CommandType.Clear]: undefined;
+    [CommandType.ReplLsResponse]: any;
+    [CommandType.ReplExecuteResponse]: any;
+    [CommandType.DevtoolsOpen]: undefined;
+    [CommandType.DevtoolsReload]: undefined;
+    [CommandType.EditorOpen]: EditorOpenPayload;
+    [CommandType.Storybook]: boolean;
+    [CommandType.Overlay]: boolean;
+}
+export type Command = {
+    [Type in keyof CommandMap]: {
+        type: Type;
+        connectionId: number;
+        clientId?: string;
+        date: Date;
+        deltaTime: number;
+        important: boolean;
+        messageId: number;
+        payload: CommandMap[Type];
+    };
+}[keyof CommandMap];
+export type CommandEvent = (command: Command) => void;
+//# sourceMappingURL=command.d.ts.map

package/lib/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EACV,0BAA0B,EAC1B,0BAA0B,EAC1B,yBAAyB,EACzB,0BAA0B,EAC1B,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC5B,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCd,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAE5E,MAAM,WAAW,UAAU;IACzB,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,cAAc,CAAC;IAC1C,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,GAAG,CAAC;IACxC,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC;IAC7B,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IAC/B,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC;IAC3B,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;IACzB,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC;IAC9B,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC1C,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC;IACpC,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IAC9D,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;IAC1D,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;IAC1D,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IAC9D,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IAC9D,CAAC,WAAW,CAAC,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;IAC5D,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IAC9D,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IAC9D,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,2BAA2B,CAAC;IAChE,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IACxD,CAAC,WAAW,CAAC,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;IAC5D,CAAC,WAAW,CAAC,qBAAqB,CAAC,EAAE,GAAG,CAAC;IACzC,CAAC,WAAW,CAAC,uBAAuB,CAAC,EAAE,GAAG,CAAC;IAC3C,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;IAC/B,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC;IAClC,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IACvC,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC;IACtC,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,SAAS,CAAC;IACxC,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC5C,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IACjC,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,MAAM,OAAO,GAAG;KACnB,IAAI,IAAI,MAAM,UAAU,GAAG;QAC1B,IAAI,EAAE,IAAI,CAAC;QACX,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,IAAI,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,OAAO,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;KAC3B;CACF,CAAC,MAAM,UAAU,CAAC,CAAC;AAEpB,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC"}

package/lib/command.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandType = void 0;
+exports.CommandType = {
+    ApiResponse: 'api.response',
+    AsyncStorageMutation: 'asyncStorage.mutation',
+    Benchmark: 'benchmark.report',
+    ClientIntro: 'client.intro',
+    Display: 'display',
+    Image: 'image',
+    Log: 'log',
+    DataWatch: 'dataWatch',
+    SagaTaskComplete: 'saga.task.complete',
+    StateActionComplete: 'state.action.complete',
+    StateKeysResponse: 'state.keys.response',
+    StateValuesChange: 'state.values.change',
+    StateValuesResponse: 'state.values.response',
+    StateBackupResponse: 'state.backup.response',
+    StateBackupRequest: 'state.backup.request',
+    StateRestoreRequest: 'state.restore.request',
+    StateActionDispatch: 'state.action.dispatch',
+    StateValuesSubscribe: 'state.values.subscribe',
+    StateKeysRequest: 'state.keys.request',
+    StateValuesRequest: 'state.values.request',
+    CustomCommandRegister: 'customCommand.register',
+    CustomCommandUnregister: 'customCommand.unregister',
+    Clear: 'clear',
+    ReplLsResponse: 'repl.ls.response',
+    ReplExecuteResponse: 'repl.execute.response',
+    // these technically are commands only in reactotron-react-native, but I felt lazy so they can live here
+    DevtoolsOpen: 'devtools.open',
+    DevtoolsReload: 'devtools.reload',
+    EditorOpen: 'editor.open',
+    Storybook: 'storybook',
+    Overlay: 'overlay',
+};

package/lib/data.d.ts

@@ -0,0 +1,6 @@
+export interface DataWatchPayload {
+    name: string;
+    type: 'text' | 'list' | 'json';
+    data: unknown;
+}
+//# sourceMappingURL=data.d.ts.map

package/lib/data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../src/data.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf"}

package/lib/data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+export * from './command';
+export * from './log';
+export * from './data';
+export * from './openInEditor';
+export * from './server-events';
+export * from './state';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}

package/lib/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./command"), exports);
+__exportStar(require("./log"), exports);
+__exportStar(require("./data"), exports);
+__exportStar(require("./openInEditor"), exports);
+__exportStar(require("./server-events"), exports);
+__exportStar(require("./state"), exports);

package/lib/log.d.ts

@@ -0,0 +1,21 @@
+export interface ErrorStackFrame {
+    fileName: string;
+    functionName: string;
+    lineNumber: number;
+    columnNumber: number | null;
+}
+export declare const isErrorStackFrame: (value: unknown) => value is ErrorStackFrame;
+export declare const isErrorStackFrameArray: (value: unknown) => value is ErrorStackFrame[];
+export interface ErrorLogPayload {
+    level: 'error';
+    message: string;
+    stack: Error['stack'] | string[] | ErrorStackFrame[];
+}
+export type LogPayload = {
+    level: 'debug';
+    message: string;
+} | {
+    level: 'warn';
+    message: string;
+} | ErrorLogPayload;
+//# sourceMappingURL=log.d.ts.map

package/lib/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../src/log.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,eAAO,MAAM,iBAAiB,UAAW,OAAO,KAAG,KAAK,IAAI,eAazD,CAAC;AAEJ,eAAO,MAAM,sBAAsB,UAC1B,OAAO,KACb,KAAK,IAAI,eAAe,EAC6B,CAAC;AAEzD,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,EAAE,GAAG,eAAe,EAAE,CAAC;CACtD;AAED,MAAM,MAAM,UAAU,GAClB;IACE,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,GACD,eAAe,CAAC"}

package/lib/log.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isErrorStackFrameArray = exports.isErrorStackFrame = void 0;
+const isErrorStackFrame = (value) => Boolean(value &&
+    typeof value === 'object' &&
+    'fileName' in value &&
+    typeof value.fileName === 'string' &&
+    'functionName' in value &&
+    typeof value.functionName === 'string' &&
+    'lineNumber' in value &&
+    typeof value.lineNumber === 'number' &&
+    ('columnNumber' in value
+        ? value.columnNumber === null || typeof value.columnNumber === 'number'
+        : true));
+exports.isErrorStackFrame = isErrorStackFrame;
+const isErrorStackFrameArray = (value) => Array.isArray(value) && value.every(exports.isErrorStackFrame);
+exports.isErrorStackFrameArray = isErrorStackFrameArray;

package/lib/network.d.ts

@@ -0,0 +1,16 @@
+export interface NetworkPayload {
+    request: {
+        url: string;
+        method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS';
+        data: any;
+        headers: Record<string, string>;
+        params: any;
+    };
+    response: {
+        status: number;
+        headers: Record<string, string>;
+        body: any;
+    };
+    duration: number;
+}
+//# sourceMappingURL=network.d.ts.map

package/lib/network.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;QAChE,IAAI,EAAE,GAAG,CAAC;QACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,MAAM,EAAE,GAAG,CAAC;KACb,CAAC;IACF,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,IAAI,EAAE,GAAG,CAAC;KACX,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;CAClB"}

package/lib/network.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/openInEditor.d.ts

@@ -0,0 +1,5 @@
+export interface EditorOpenPayload {
+    file: string;
+    lineNumber: string;
+}
+//# sourceMappingURL=openInEditor.d.ts.map

package/lib/openInEditor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openInEditor.d.ts","sourceRoot":"","sources":["../src/openInEditor.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/lib/openInEditor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/reactotron-core-contract.d.ts

@@ -0,0 +1,6 @@
+export * from './command';
+export * from './log';
+export * from './openInEditor';
+export * from './server-events';
+export * from './state';
+//# sourceMappingURL=reactotron-core-contract.d.ts.map

package/lib/reactotron-core-contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reactotron-core-contract.d.ts","sourceRoot":"","sources":["../src/reactotron-core-contract.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}

package/lib/reactotron-core-contract.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./command"), exports);
+__exportStar(require("./log"), exports);
+__exportStar(require("./openInEditor"), exports);
+__exportStar(require("./server-events"), exports);
+__exportStar(require("./state"), exports);

package/lib/server-events.d.ts

@@ -0,0 +1,109 @@
+import WebSocket from 'ws';
+import { Command } from './command';
+export interface PfxServerOptions {
+    /**
+     * Path to a PFX file.
+     */
+    pathToPfx: string;
+    /**
+     * Passphrase, if required, of the PFX file.
+     */
+    passphrase?: string;
+}
+export interface CertServerOptions {
+    /**
+     * Path to a signing cert file.
+     */
+    pathToCert: string;
+    /**
+     * Path to a the corresponding key of the cert file.
+     */
+    pathToKey: string;
+    /**
+     * Passphrase, if required, of the key file.
+     */
+    passphrase?: string;
+}
+export type WssServerOptions = PfxServerOptions | CertServerOptions;
+/**
+ * Configuration options for the Reactotron server.
+ */
+export interface ServerOptions {
+    /**
+     * Which port to listen to.  Default: 9090.
+     */
+    port: number;
+    /**
+     * Web Socket Secure Configuration
+     */
+    wss?: WssServerOptions;
+}
+/**
+ * A client which is in the process of connecting.
+ */
+export interface PartialConnection {
+    /**
+     * The unique id of the client.
+     */
+    id: number;
+    /**
+     * The ip address.
+     */
+    address: string;
+    /**
+     * The connecting web socket.
+     */
+    socket: WebSocket;
+}
+/**
+ * One of the events which be subscribed to.
+ */
+export declare const ServerEvent: {
+    /**
+     * When a command arrives from a client.
+     */
+    readonly command: "command";
+    /**
+     * The server has started.
+     */
+    readonly start: "start";
+    /**
+     * The server has stopped.
+     */
+    readonly stop: "stop";
+    /**
+     * A client has connected.
+     */
+    readonly connect: "connect";
+    /**
+     * A client has connected and provided us the initial detail we want.
+     */
+    readonly connectionEstablished: "connectionEstablished";
+    /**
+     * A client has disconnected.
+     */
+    readonly disconnect: "disconnect";
+    /**
+     * Port is already in use
+     */
+    readonly portUnavailable: "portUnavailable";
+};
+export type ServerEventKey = keyof typeof ServerEvent;
+type StartPayload = any;
+type StopPayload = any;
+type ConnectPayload = PartialConnection;
+type ConnectionEstablishedPayload = any;
+type DisconnectPayload = any;
+type PortUnavailablePayload = any;
+export type ServerEventMap = {
+    [ServerEvent.command]: Command;
+    [ServerEvent.start]: StartPayload;
+    [ServerEvent.stop]: StopPayload;
+    [ServerEvent.connect]: ConnectPayload;
+    [ServerEvent.connectionEstablished]: ConnectionEstablishedPayload;
+    [ServerEvent.disconnect]: DisconnectPayload;
+    [ServerEvent.portUnavailable]: PortUnavailablePayload;
+};
+export type WebSocketEvent = (socket: WebSocket) => void;
+export {};
+//# sourceMappingURL=server-events.d.ts.map

package/lib/server-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-events.d.ts","sourceRoot":"","sources":["../src/server-events.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,IAAI,CAAC;AAC3B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED;;GAEG;AACH,eAAO,MAAM,WAAW;IACtB;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,WAAW,CAAC;AAEtD,KAAK,YAAY,GAAG,GAAG,CAAC;AACxB,KAAK,WAAW,GAAG,GAAG,CAAC;AACvB,KAAK,cAAc,GAAG,iBAAiB,CAAC;AACxC,KAAK,4BAA4B,GAAG,GAAG,CAAC;AACxC,KAAK,iBAAiB,GAAG,GAAG,CAAC;AAC7B,KAAK,sBAAsB,GAAG,GAAG,CAAC;AAElC,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC/B,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC;IAClC,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC;IAChC,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IACtC,CAAC,WAAW,CAAC,qBAAqB,CAAC,EAAE,4BAA4B,CAAC;IAClE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC5C,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,sBAAsB,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,CAAC"}

package/lib/server-events.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerEvent = void 0;
+/**
+ * One of the events which be subscribed to.
+ */
+exports.ServerEvent = {
+    /**
+     * When a command arrives from a client.
+     */
+    command: 'command',
+    /**
+     * The server has started.
+     */
+    start: 'start',
+    /**
+     * The server has stopped.
+     */
+    stop: 'stop',
+    /**
+     * A client has connected.
+     */
+    connect: 'connect',
+    /**
+     * A client has connected and provided us the initial detail we want.
+     */
+    connectionEstablished: 'connectionEstablished',
+    /**
+     * A client has disconnected.
+     */
+    disconnect: 'disconnect',
+    /**
+     * Port is already in use
+     */
+    portUnavailable: 'portUnavailable',
+};

package/lib/state.d.ts

@@ -0,0 +1,53 @@
+export interface StateBackupRequestPayload {
+    state: Record<string, any>;
+}
+export interface StateBackupResponsePayload {
+    state: Record<string, any>;
+}
+export interface StateRestoreRequestPayload {
+    state: Record<string, any>;
+}
+export interface StateActionDispatchPayload {
+    action: {
+        type: string;
+        payload: Record<string, any>;
+    } | {
+        name: string;
+        path?: string;
+        args?: any[];
+    };
+}
+type Path = string;
+type Value = any;
+export interface StateKeysRequestPayload {
+    path: Path;
+}
+export interface StateKeysResponsePayload {
+    path: Path;
+    keys: string[];
+    valid: boolean;
+}
+export interface StateValuesRequestPayload {
+    path: Path;
+}
+export interface StateValuesResponsePayload {
+    path: Path;
+    value: Value;
+    valid: boolean;
+}
+export interface StateValuesChangePayload {
+    changes: {
+        path: Path;
+        value: Value;
+    }[];
+}
+export interface StateValuesSubscribePayload {
+    paths: Path[];
+}
+export interface StateActionCompletePayload {
+    name: string;
+    action: Record<string, any>;
+    ms?: number;
+}
+export {};
+//# sourceMappingURL=state.d.ts.map

package/lib/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,yBAAyB;IACxC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,EACF;QACE,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC9B,GACD;QACE,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;KACd,CAAC;CACP;AAED,KAAK,IAAI,GAAG,MAAM,CAAC;AAEnB,KAAK,KAAK,GAAG,GAAG,CAAC;AAEjB,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,EAAE,CAAC;CACzC;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;CACb"}

package/lib/state.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "dreaction-protocol",
+  "version": "1.0.0",
+  "private": false,
+  "description": "",
+  "main": "lib/index.js",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "keywords": [
+    "dreaction"
+  ],
+  "author": "moonrailgun <moonrailgun@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "@types/ws": "^8.5.13",
+    "eventemitter-strict": "^1.0.1",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@testing-library/dom": "^10.0.0",
+    "happy-dom": "15.11.6",
+    "msw": "^2.2.13",
+    "typescript": "^5.4.5",
+    "vitest": "^1.2.1"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest"
+  }
+}

package/src/command.ts

@@ -0,0 +1,101 @@
+import { DataWatchPayload } from './data';
+import type { LogPayload } from './log';
+import { NetworkPayload } from './network';
+import { EditorOpenPayload } from './openInEditor';
+import type {
+  StateActionCompletePayload,
+  StateActionDispatchPayload,
+  StateBackupRequestPayload,
+  StateBackupResponsePayload,
+  StateKeysRequestPayload,
+  StateKeysResponsePayload,
+  StateRestoreRequestPayload,
+  StateValuesChangePayload,
+  StateValuesRequestPayload,
+  StateValuesResponsePayload,
+  StateValuesSubscribePayload,
+} from './state';
+
+export const CommandType = {
+  ApiResponse: 'api.response',
+  AsyncStorageMutation: 'asyncStorage.mutation',
+  Benchmark: 'benchmark.report',
+  ClientIntro: 'client.intro',
+  Display: 'display',
+  Image: 'image',
+  Log: 'log',
+  DataWatch: 'dataWatch',
+  SagaTaskComplete: 'saga.task.complete',
+  StateActionComplete: 'state.action.complete',
+  StateKeysResponse: 'state.keys.response',
+  StateValuesChange: 'state.values.change',
+  StateValuesResponse: 'state.values.response',
+  StateBackupResponse: 'state.backup.response',
+  StateBackupRequest: 'state.backup.request',
+  StateRestoreRequest: 'state.restore.request',
+  StateActionDispatch: 'state.action.dispatch',
+  StateValuesSubscribe: 'state.values.subscribe',
+  StateKeysRequest: 'state.keys.request',
+  StateValuesRequest: 'state.values.request',
+  CustomCommandRegister: 'customCommand.register',
+  CustomCommandUnregister: 'customCommand.unregister',
+  Clear: 'clear',
+  ReplLsResponse: 'repl.ls.response',
+  ReplExecuteResponse: 'repl.execute.response',
+  // these technically are commands only in reactotron-react-native, but I felt lazy so they can live here
+  DevtoolsOpen: 'devtools.open',
+  DevtoolsReload: 'devtools.reload',
+  EditorOpen: 'editor.open',
+  Storybook: 'storybook',
+  Overlay: 'overlay',
+} as const;
+
+export type CommandTypeKey = (typeof CommandType)[keyof typeof CommandType];
+
+export interface CommandMap {
+  [CommandType.ApiResponse]: NetworkPayload;
+  [CommandType.AsyncStorageMutation]: any;
+  [CommandType.Benchmark]: any;
+  [CommandType.ClientIntro]: any;
+  [CommandType.Display]: any;
+  [CommandType.Image]: any;
+  [CommandType.Log]: LogPayload;
+  [CommandType.DataWatch]: DataWatchPayload;
+  [CommandType.SagaTaskComplete]: any;
+  [CommandType.StateActionComplete]: StateActionCompletePayload;
+  [CommandType.StateKeysResponse]: StateKeysResponsePayload;
+  [CommandType.StateValuesChange]: StateValuesChangePayload;
+  [CommandType.StateValuesResponse]: StateValuesResponsePayload;
+  [CommandType.StateBackupResponse]: StateBackupResponsePayload;
+  [CommandType.StateBackupRequest]: StateBackupRequestPayload;
+  [CommandType.StateRestoreRequest]: StateRestoreRequestPayload;
+  [CommandType.StateActionDispatch]: StateActionDispatchPayload;
+  [CommandType.StateValuesSubscribe]: StateValuesSubscribePayload;
+  [CommandType.StateKeysRequest]: StateKeysRequestPayload;
+  [CommandType.StateValuesRequest]: StateValuesRequestPayload;
+  [CommandType.CustomCommandRegister]: any;
+  [CommandType.CustomCommandUnregister]: any;
+  [CommandType.Clear]: undefined;
+  [CommandType.ReplLsResponse]: any;
+  [CommandType.ReplExecuteResponse]: any;
+  [CommandType.DevtoolsOpen]: undefined;
+  [CommandType.DevtoolsReload]: undefined;
+  [CommandType.EditorOpen]: EditorOpenPayload;
+  [CommandType.Storybook]: boolean;
+  [CommandType.Overlay]: boolean;
+}
+
+export type Command = {
+  [Type in keyof CommandMap]: {
+    type: Type;
+    connectionId: number;
+    clientId?: string;
+    date: Date;
+    deltaTime: number;
+    important: boolean;
+    messageId: number;
+    payload: CommandMap[Type];
+  };
+}[keyof CommandMap];
+
+export type CommandEvent = (command: Command) => void;

package/src/data.ts

@@ -0,0 +1,5 @@
+export interface DataWatchPayload {
+  name: string;
+  type: 'text' | 'list' | 'json';
+  data: unknown;
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from './command';
+export * from './log';
+export * from './data';
+export * from './openInEditor';
+export * from './server-events';
+export * from './state';

package/src/log.ts

@@ -0,0 +1,43 @@
+export interface ErrorStackFrame {
+  fileName: string;
+  functionName: string;
+  lineNumber: number;
+  columnNumber: number | null;
+}
+
+export const isErrorStackFrame = (value: unknown): value is ErrorStackFrame =>
+  Boolean(
+    value &&
+      typeof value === 'object' &&
+      'fileName' in value &&
+      typeof value.fileName === 'string' &&
+      'functionName' in value &&
+      typeof value.functionName === 'string' &&
+      'lineNumber' in value &&
+      typeof value.lineNumber === 'number' &&
+      ('columnNumber' in value
+        ? value.columnNumber === null || typeof value.columnNumber === 'number'
+        : true)
+  );
+
+export const isErrorStackFrameArray = (
+  value: unknown
+): value is ErrorStackFrame[] =>
+  Array.isArray(value) && value.every(isErrorStackFrame);
+
+export interface ErrorLogPayload {
+  level: 'error';
+  message: string;
+  stack: Error['stack'] | string[] | ErrorStackFrame[];
+}
+
+export type LogPayload =
+  | {
+      level: 'debug';
+      message: string;
+    }
+  | {
+      level: 'warn';
+      message: string;
+    }
+  | ErrorLogPayload;

package/src/network.ts

@@ -0,0 +1,15 @@
+export interface NetworkPayload {
+  request: {
+    url: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS';
+    data: any;
+    headers: Record<string, string>;
+    params: any;
+  };
+  response: {
+    status: number;
+    headers: Record<string, string>;
+    body: any;
+  };
+  duration: number;
+}

package/src/openInEditor.ts

@@ -0,0 +1,4 @@
+export interface EditorOpenPayload {
+  file: string;
+  lineNumber: string;
+}

package/src/server-events.ts

@@ -0,0 +1,120 @@
+import WebSocket from 'ws';
+import { Command } from './command';
+
+export interface PfxServerOptions {
+  /**
+   * Path to a PFX file.
+   */
+  pathToPfx: string;
+  /**
+   * Passphrase, if required, of the PFX file.
+   */
+  passphrase?: string;
+}
+
+export interface CertServerOptions {
+  /**
+   * Path to a signing cert file.
+   */
+  pathToCert: string;
+  /**
+   * Path to a the corresponding key of the cert file.
+   */
+  pathToKey: string;
+  /**
+   * Passphrase, if required, of the key file.
+   */
+  passphrase?: string;
+}
+
+export type WssServerOptions = PfxServerOptions | CertServerOptions;
+
+/**
+ * Configuration options for the Reactotron server.
+ */
+export interface ServerOptions {
+  /**
+   * Which port to listen to.  Default: 9090.
+   */
+  port: number;
+
+  /**
+   * Web Socket Secure Configuration
+   */
+  wss?: WssServerOptions;
+}
+
+/**
+ * A client which is in the process of connecting.
+ */
+export interface PartialConnection {
+  /**
+   * The unique id of the client.
+   */
+  id: number;
+
+  /**
+   * The ip address.
+   */
+  address: string;
+
+  /**
+   * The connecting web socket.
+   */
+  socket: WebSocket;
+}
+
+/**
+ * One of the events which be subscribed to.
+ */
+export const ServerEvent = {
+  /**
+   * When a command arrives from a client.
+   */
+  command: 'command',
+  /**
+   * The server has started.
+   */
+  start: 'start',
+  /**
+   * The server has stopped.
+   */
+  stop: 'stop',
+  /**
+   * A client has connected.
+   */
+  connect: 'connect',
+  /**
+   * A client has connected and provided us the initial detail we want.
+   */
+  connectionEstablished: 'connectionEstablished',
+  /**
+   * A client has disconnected.
+   */
+  disconnect: 'disconnect',
+  /**
+   * Port is already in use
+   */
+  portUnavailable: 'portUnavailable',
+} as const;
+
+export type ServerEventKey = keyof typeof ServerEvent;
+
+type StartPayload = any;
+type StopPayload = any;
+type ConnectPayload = PartialConnection;
+type ConnectionEstablishedPayload = any;
+type DisconnectPayload = any;
+type PortUnavailablePayload = any;
+
+export type ServerEventMap = {
+  [ServerEvent.command]: Command;
+  [ServerEvent.start]: StartPayload;
+  [ServerEvent.stop]: StopPayload;
+  [ServerEvent.connect]: ConnectPayload;
+  [ServerEvent.connectionEstablished]: ConnectionEstablishedPayload;
+  [ServerEvent.disconnect]: DisconnectPayload;
+  [ServerEvent.portUnavailable]: PortUnavailablePayload;
+};
+
+export type WebSocketEvent = (socket: WebSocket) => void;

package/src/state.ts

@@ -0,0 +1,62 @@
+export interface StateBackupRequestPayload {
+  state: Record<string, any>;
+}
+
+export interface StateBackupResponsePayload {
+  state: Record<string, any>;
+}
+
+export interface StateRestoreRequestPayload {
+  state: Record<string, any>;
+}
+
+export interface StateActionDispatchPayload {
+  action:
+    | {
+        type: string;
+        payload: Record<string, any>;
+      }
+    | {
+        name: string;
+        path?: string;
+        args?: any[];
+      };
+}
+
+type Path = string;
+
+type Value = any;
+
+export interface StateKeysRequestPayload {
+  path: Path;
+}
+
+export interface StateKeysResponsePayload {
+  path: Path;
+  keys: string[];
+  valid: boolean;
+}
+
+export interface StateValuesRequestPayload {
+  path: Path;
+}
+
+export interface StateValuesResponsePayload {
+  path: Path;
+  value: Value;
+  valid: boolean;
+}
+
+export interface StateValuesChangePayload {
+  changes: { path: Path; value: Value }[];
+}
+
+export interface StateValuesSubscribePayload {
+  paths: Path[];
+}
+
+export interface StateActionCompletePayload {
+  name: string;
+  action: Record<string, any>;
+  ms?: number;
+}