dreaction-client-core 1.0.0

package/lib/client-options.d.ts

@@ -0,0 +1,77 @@
+import type { LifeCycleMethods, PluginCreator } from './';
+import NodeWebSocket from 'ws';
+type BrowserWebSocket = WebSocket;
+/**
+ * Configuration options for the Reactotron Client.
+ */
+export interface ClientOptions<Client> extends Omit<LifeCycleMethods, 'onCommand'> {
+    /**
+     * A function which returns a websocket.
+     *
+     * This is over-engineered because we need the ability to create different
+     * types of websockets for React Native, React, and NodeJS.  :|
+     */
+    createSocket?: ((path: string) => BrowserWebSocket) | ((path: string) => NodeWebSocket) | null;
+    /**
+     * The hostname or ip address of the server.  Default: localhost.
+     */
+    host?: string | null;
+    /**
+     * The port to connect to the server on.  Default: 9090.
+     */
+    port?: number | null;
+    /**
+     * The name of this client. Usually the app name.
+     */
+    name?: string;
+    /**
+     * Will we be connecting via SSL?
+     */
+    secure?: boolean;
+    /**
+     * A list of plugins.
+     */
+    plugins?: PluginCreator<Client>[];
+    /**
+     * Performs safety checks when serializing.  Default: true.
+     *
+     * Will do things like:
+     * - remap falsy values to transport-friendly version
+     * - remove any circular dependencies
+     * - remap functions to something that shows their name
+     *
+     * Hooray for JavaScript!
+     */
+    safeRecursion?: boolean;
+    /**
+     * Fires when the server sends a command.
+     */
+    onCommand?: ((command: any) => void) | null;
+    /**
+     * Fires when we connect to the server.
+     */
+    onConnect?: () => void;
+    /**
+     * Fires when we disconnect from the server.
+     */
+    onDisconnect?: () => void;
+    /**
+     * The NODE_ENV environment, if any.
+     */
+    environment?: string;
+    /**
+     * A way for the client libraries to identify themselves.
+     */
+    client?: Record<string, string | number | boolean>;
+    /**
+     * Save the client id provided by the server
+     */
+    setClientId?: (clientId: string) => Promise<void>;
+    /**
+     * Get the client id provided by the server
+     */
+    getClientId?: (name: string) => Promise<string>;
+    proxyHack?: boolean;
+}
+export {};
+//# sourceMappingURL=client-options.d.ts.map

package/lib/client-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-options.d.ts","sourceRoot":"","sources":["../src/client-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AAC1D,OAAO,aAAa,MAAM,IAAI,CAAC;AAE/B,KAAK,gBAAgB,GAAG,SAAS,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,CACnC,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3C;;;;;OAKG;IACH,YAAY,CAAC,EACT,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,gBAAgB,CAAC,GACpC,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,aAAa,CAAC,GACjC,IAAI,CAAC;IAET;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;IAElC;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IAEnD;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEhD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB"}

package/lib/client-options.js

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

package/lib/index.d.ts

@@ -0,0 +1,190 @@
+import WebSocket from 'ws';
+import type { Command, CommandMap, CommandTypeKey } from 'dreaction-protocol';
+import { ClientOptions } from './client-options';
+export type { ClientOptions };
+export { assertHasLoggerPlugin } from './plugins/logger';
+export type { LoggerPlugin } from './plugins/logger';
+export { assertHasStateResponsePlugin, hasStateResponsePlugin, } from './plugins/state-responses';
+export type { StateResponsePlugin } from './plugins/state-responses';
+export declare enum ArgType {
+    String = "string"
+}
+export interface CustomCommandArg {
+    name: string;
+    type: ArgType;
+}
+export interface LifeCycleMethods {
+    onCommand?: (command: Command) => void;
+    onConnect?: () => void;
+    onDisconnect?: () => void;
+}
+type AnyFunction = (...args: any[]) => any;
+export interface Plugin<Client> extends LifeCycleMethods {
+    features?: {
+        [key: string]: AnyFunction;
+    };
+    onPlugin?: (client: Client) => void;
+}
+export type PluginCreator<Client> = (client: Client) => Plugin<Client>;
+interface DisplayConfig {
+    name: string;
+    value?: object | string | number | boolean | null | undefined;
+    preview?: string;
+    image?: string | {
+        uri: string;
+    };
+    important?: boolean;
+}
+interface ArgTypeMap {
+    [ArgType.String]: string;
+}
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export type CustomCommandArgs<Args extends CustomCommandArg[]> = UnionToIntersection<Args extends Array<infer U> ? U extends CustomCommandArg ? {
+    [K in U as U['name']]: ArgTypeMap[U['type']];
+} : never : never>;
+export interface CustomCommand<Args extends CustomCommandArg[] = CustomCommandArg[]> {
+    id?: number;
+    command: string;
+    handler: (args?: CustomCommandArgs<Args>) => void;
+    title?: string;
+    description?: string;
+    args?: Args;
+}
+type ExtractFeatures<T> = T extends {
+    features: infer U;
+} ? U : never;
+type PluginFeatures<Client, P extends PluginCreator<Client>> = ExtractFeatures<ReturnType<P>>;
+export type InferFeaturesFromPlugins<Client, Plugins extends PluginCreator<Client>[]> = UnionToIntersection<PluginFeatures<Client, Plugins[number]>>;
+type InferFeaturesFromPlugin<Client, P extends PluginCreator<Client>> = UnionToIntersection<PluginFeatures<Client, P>>;
+export interface DReactionCore {
+    options: ClientOptions<this>;
+    plugins: Plugin<this>[];
+    startTimer: () => () => number;
+    close: () => this;
+    send: <Type extends keyof CommandMap>(type: Type, payload?: CommandMap[Type], important?: boolean) => void;
+    display: (config: DisplayConfig) => void;
+    onCustomCommand: <Args extends CustomCommandArg[] = Exclude<CustomCommand['args'], undefined>>(config: CustomCommand<Args>) => () => void | ((config: string, optHandler?: () => void) => () => void);
+    /**
+     * Set the configuration options.
+     */
+    configure: (options: ClientOptions<this>) => ClientOptions<this>['plugins'] extends PluginCreator<this>[] ? this & InferFeaturesFromPlugins<this, ClientOptions<this>['plugins']> : this;
+    use: <P extends PluginCreator<this>>(pluginCreator: P) => this & InferFeaturesFromPlugin<this, P>;
+    connect: () => this;
+}
+export type InferFeatures<Client = DReactionCore, PC extends PluginCreator<Client> = PluginCreator<Client>> = PC extends (client: Client) => {
+    features: infer U;
+} ? U : never;
+export declare const corePlugins: (((dreaction: DReactionCore) => {
+    features: {
+        log: (...args: any[]) => void;
+        logImportant: (...args: any[]) => void;
+        debug: (message: any, important?: any) => void;
+        warn: (message: any) => void;
+        error: (message: any, stack: any) => void;
+    };
+}) | ((reactotron: DReactionCore) => {
+    features: {
+        image: (payload: import("./plugins/image").ImagePayload) => void;
+    };
+}) | ((reactotron: DReactionCore) => {
+    features: {
+        benchmark: (title: string) => {
+            step: (stepTitle: string) => void;
+            stop: (stopTitle: string) => void;
+            last: (stopTitle: string) => void;
+        };
+    };
+}) | ((reactotron: DReactionCore) => {
+    features: {
+        stateActionComplete: (name: import("dreaction-protocol").StateActionCompletePayload["name"], action: import("dreaction-protocol").StateActionCompletePayload["action"], important?: any) => void;
+        stateValuesResponse: (path: import("dreaction-protocol").StateValuesResponsePayload["path"], value: import("dreaction-protocol").StateValuesResponsePayload["value"], valid?: import("dreaction-protocol").StateValuesResponsePayload["value"]) => void;
+        stateKeysResponse: (path: import("dreaction-protocol").StateKeysResponsePayload["path"], keys: import("dreaction-protocol").StateKeysResponsePayload["keys"], valid?: import("dreaction-protocol").StateKeysResponsePayload["valid"]) => void;
+        stateValuesChange: (changes: import("dreaction-protocol").StateValuesChangePayload["changes"]) => false | void;
+        stateBackupResponse: (state: import("dreaction-protocol").StateBackupResponsePayload["state"]) => void;
+    };
+}) | ((reactotron: DReactionCore) => {
+    features: {
+        apiResponse: (request: {
+            status: number;
+        }, response: any, duration: number) => void;
+    };
+}) | ((reactotron: DReactionCore) => {
+    features: {
+        clear: () => void;
+    };
+}) | ((reactotron: DReactionCore) => {
+    onCommand: ({ type, payload }: Command) => void;
+    features: {
+        repl: (name: string, value: import("./plugins/repl").AcceptableRepls) => void;
+    };
+}))[];
+export type InferPluginsFromCreators<Client, PC extends PluginCreator<Client>[]> = PC extends Array<infer P extends PluginCreator<Client>> ? ReturnType<P>[] : never;
+export interface Reactotron extends DReactionCore {
+}
+export declare class ReactotronImpl implements Omit<DReactionCore, 'options' | 'plugins' | 'configure' | 'connect' | 'use' | 'close'> {
+    options: ClientOptions<DReactionCore>;
+    /**
+     * Are we connected to a server?
+     */
+    connected: boolean;
+    /**
+     * The socket we're using.
+     */
+    socket: WebSocket;
+    /**
+     * Available plugins.
+     */
+    plugins: Plugin<this>[];
+    /**
+     * Messages that need to be sent.
+     */
+    sendQueue: string[];
+    /**
+     * Are we ready to start communicating?
+     */
+    isReady: boolean;
+    /**
+     * The last time we sent a message.
+     */
+    lastMessageDate: Date;
+    /**
+     * The registered custom commands
+     */
+    customCommands: CustomCommand[];
+    /**
+     * The current ID for custom commands
+     */
+    customCommandLatestId: number;
+    /**
+     * Starts a timer and returns a function you can call to stop it and return the elapsed time.
+     */
+    startTimer: () => () => number;
+    /**
+     * Set the configuration options.
+     */
+    configure(options: ClientOptions<this>): ClientOptions<this>['plugins'] extends PluginCreator<this>[] ? this & InferFeaturesFromPlugins<this, ClientOptions<this>['plugins']> : this;
+    close(): this;
+    /**
+     * Connect to the Reactotron server.
+     */
+    connect(): this;
+    /**
+     * Sends a command to the server
+     */
+    send: <Type extends CommandTypeKey>(type: Type, payload?: CommandMap[Type]["payload"], important?: boolean) => void;
+    /**
+     * Sends a custom command to the server to displays nicely.
+     */
+    display(config: DisplayConfig): void;
+    /**
+     * Client libraries can hijack this to report errors.
+     */
+    reportError(this: any, error: Error): void;
+    /**
+     * Adds a plugin to the system
+     */
+    use(pluginCreator: PluginCreator<this>): this & PluginFeatures<this, typeof pluginCreator>;
+    onCustomCommand(config: CustomCommand | string, optHandler?: () => void): () => void;
+}
+export declare function createClient<Client extends DReactionCore = DReactionCore>(options?: ClientOptions<Client>): Client;
+//# 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,OAAO,SAAS,MAAM,IAAI,CAAC;AAC3B,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAW9E,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,YAAY,EAAE,aAAa,EAAE,CAAC;AAC9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAErE,oBAAY,OAAO;IACjB,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;CACf;AAGD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B;AAED,KAAK,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAC3C,MAAM,WAAW,MAAM,CAAC,MAAM,CAAE,SAAQ,gBAAgB;IACtD,QAAQ,CAAC,EAAE;QACT,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC;KAC5B,CAAC;IACF,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CACrC;AAED,MAAM,MAAM,aAAa,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;AAEvE,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACjC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,UAAU,UAAU;IAClB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAC7E,CAAC,EAAE,MAAM,CAAC,KACP,IAAI,GACL,CAAC,GACD,KAAK,CAAC;AAEV,MAAM,MAAM,iBAAiB,CAAC,IAAI,SAAS,gBAAgB,EAAE,IAC3D,mBAAmB,CACjB,IAAI,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACvB,CAAC,SAAS,gBAAgB,GACxB;KAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CAAE,GAChD,KAAK,GACP,KAAK,CACV,CAAC;AAEJ,MAAM,WAAW,aAAa,CAC5B,IAAI,SAAS,gBAAgB,EAAE,GAAG,gBAAgB,EAAE;IAEpD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;IAElD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,KAAK,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AACtE,KAAK,cAAc,CAAC,MAAM,EAAE,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,IAAI,eAAe,CAC5E,UAAU,CAAC,CAAC,CAAC,CACd,CAAC;AAEF,MAAM,MAAM,wBAAwB,CAClC,MAAM,EACN,OAAO,SAAS,aAAa,CAAC,MAAM,CAAC,EAAE,IACrC,mBAAmB,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEjE,KAAK,uBAAuB,CAC1B,MAAM,EACN,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,IAC7B,mBAAmB,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;AAEnD,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IACxB,UAAU,EAAE,MAAM,MAAM,MAAM,CAAC;IAC/B,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,IAAI,EAAE,CAAC,IAAI,SAAS,MAAM,UAAU,EAClC,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,EAC1B,SAAS,CAAC,EAAE,OAAO,KAChB,IAAI,CAAC;IACV,OAAO,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,CAAC;IACzC,eAAe,EAAE,CACf,IAAI,SAAS,gBAAgB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,EAE3E,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,KACxB,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC;IAC5E;;OAEG;IACH,SAAS,EAAE,CACT,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,KACzB,aAAa,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,aAAa,CAAC,IAAI,CAAC,EAAE,GAC7D,IAAI,GAAG,wBAAwB,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,GACrE,IAAI,CAAC;IAET,GAAG,EAAE,CAAC,CAAC,SAAS,aAAa,CAAC,IAAI,CAAC,EACjC,aAAa,EAAE,CAAC,KACb,IAAI,GAAG,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAE7C,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,MAAM,MAAM,aAAa,CACvB,MAAM,GAAG,aAAa,EACtB,EAAE,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,IACtD,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,KAAK;IAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAErE,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAQkB,CAAC;AAE3C,MAAM,MAAM,wBAAwB,CAClC,MAAM,EACN,EAAE,SAAS,aAAa,CAAC,MAAM,CAAC,EAAE,IAChC,EAAE,SAAS,KAAK,CAAC,MAAM,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GACvD,UAAU,CAAC,CAAC,CAAC,EAAE,GACf,KAAK,CAAC;AASV,MAAM,WAAW,UAAW,SAAQ,aAAa;CAAG;AAsBpD,qBAAa,cACX,YACE,IAAI,CACF,aAAa,EACb,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,KAAK,GAAG,OAAO,CAClE;IAGH,OAAO,EAAG,aAAa,CAAC,aAAa,CAAC,CAAC;IAEvC;;OAEG;IACH,SAAS,UAAS;IAElB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAiB;IAElC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAM;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAM;IAEzB;;OAEG;IACH,OAAO,UAAS;IAEhB;;OAEG;IACH,eAAe,OAAc;IAE7B;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAM;IAErC;;OAEG;IACH,qBAAqB,SAAK;IAE1B;;OAEG;IACH,UAAU,qBAAiB;IAE3B;;OAEG;IACH,SAAS,CACP,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,GAC3B,aAAa,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,aAAa,CAAC,IAAI,CAAC,EAAE,GAC3D,IAAI,GAAG,wBAAwB,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,GACrE,IAAI;IAiCR,KAAK;IAOL;;OAEG;IACH,OAAO;IA0HP;;OAEG;IACH,IAAI,GAAI,IAAI,SAAS,cAAc,QAC3B,IAAI,YACA,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,cACzB,OAAO,UAmCnB;IAEF;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,aAAa;IAW7B;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK;IAInC;;OAEG;IACH,GAAG,CACD,aAAa,EAAE,aAAa,CAAC,IAAI,CAAC,GACjC,IAAI,GAAG,cAAc,CAAC,IAAI,EAAE,OAAO,aAAa,CAAC;IA0DpD,eAAe,CACb,MAAM,EAAE,aAAa,GAAG,MAAM,EAC9B,UAAU,CAAC,EAAE,MAAM,IAAI,GACtB,MAAM,IAAI;CAsGd;AAGD,wBAAgB,YAAY,CAAC,MAAM,SAAS,aAAa,GAAG,aAAa,EACvE,OAAO,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAGyB,MAAM,CAC/D"}

package/lib/index.js

@@ -0,0 +1,401 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReactotronImpl = exports.corePlugins = exports.ArgType = exports.hasStateResponsePlugin = exports.assertHasStateResponsePlugin = exports.assertHasLoggerPlugin = void 0;
+exports.createClient = createClient;
+const validate_1 = __importDefault(require("./validate"));
+const logger_1 = __importDefault(require("./plugins/logger"));
+const image_1 = __importDefault(require("./plugins/image"));
+const benchmark_1 = __importDefault(require("./plugins/benchmark"));
+const state_responses_1 = __importDefault(require("./plugins/state-responses"));
+const api_response_1 = __importDefault(require("./plugins/api-response"));
+const clear_1 = __importDefault(require("./plugins/clear"));
+const repl_1 = __importDefault(require("./plugins/repl"));
+const serialize_1 = __importDefault(require("./serialize"));
+const stopwatch_1 = require("./stopwatch");
+var logger_2 = require("./plugins/logger");
+Object.defineProperty(exports, "assertHasLoggerPlugin", { enumerable: true, get: function () { return logger_2.assertHasLoggerPlugin; } });
+var state_responses_2 = require("./plugins/state-responses");
+Object.defineProperty(exports, "assertHasStateResponsePlugin", { enumerable: true, get: function () { return state_responses_2.assertHasStateResponsePlugin; } });
+Object.defineProperty(exports, "hasStateResponsePlugin", { enumerable: true, get: function () { return state_responses_2.hasStateResponsePlugin; } });
+var ArgType;
+(function (ArgType) {
+    ArgType["String"] = "string";
+})(ArgType || (exports.ArgType = ArgType = {}));
+exports.corePlugins = [
+    (0, image_1.default)(),
+    (0, logger_1.default)(),
+    (0, benchmark_1.default)(),
+    (0, state_responses_1.default)(),
+    (0, api_response_1.default)(),
+    (0, clear_1.default)(),
+    (0, repl_1.default)(),
+];
+// these are not for you.
+const reservedFeatures = [
+    'configure',
+    'connect',
+    'connected',
+    'options',
+    'plugins',
+    'send',
+    'socket',
+    'startTimer',
+    'use',
+];
+const isReservedFeature = (value) => reservedFeatures.some((res) => res === value);
+function emptyPromise() {
+    return Promise.resolve('');
+}
+class ReactotronImpl {
+    // the configuration options
+    options;
+    /**
+     * Are we connected to a server?
+     */
+    connected = false;
+    /**
+     * The socket we're using.
+     */
+    socket = null;
+    /**
+     * Available plugins.
+     */
+    plugins = [];
+    /**
+     * Messages that need to be sent.
+     */
+    sendQueue = [];
+    /**
+     * Are we ready to start communicating?
+     */
+    isReady = false;
+    /**
+     * The last time we sent a message.
+     */
+    lastMessageDate = new Date();
+    /**
+     * The registered custom commands
+     */
+    customCommands = [];
+    /**
+     * The current ID for custom commands
+     */
+    customCommandLatestId = 1;
+    /**
+     * Starts a timer and returns a function you can call to stop it and return the elapsed time.
+     */
+    startTimer = () => (0, stopwatch_1.start)();
+    /**
+     * Set the configuration options.
+     */
+    configure(options) {
+        // options get merged & validated before getting set
+        const newOptions = Object.assign({
+            createSocket: null,
+            host: 'localhost',
+            port: 9600,
+            name: 'reactotron-core-client',
+            secure: false,
+            plugins: exports.corePlugins,
+            safeRecursion: true,
+            onCommand: () => null,
+            onConnect: () => null,
+            onDisconnect: () => null,
+        }, this.options, options);
+        (0, validate_1.default)(newOptions);
+        this.options = newOptions;
+        // if we have plugins, let's add them here
+        if (Array.isArray(this.options.plugins)) {
+            this.options.plugins.forEach((p) => this.use(p));
+        }
+        return this;
+    }
+    close() {
+        this.connected = false;
+        this.socket && this.socket.close && this.socket.close();
+        return this;
+    }
+    /**
+     * Connect to the Reactotron server.
+     */
+    connect() {
+        this.connected = true;
+        const { createSocket, secure, host, environment, port, name, client = {}, getClientId, } = this.options;
+        const { onCommand, onConnect, onDisconnect } = this.options;
+        // establish a connection to the server
+        const protocol = secure ? 'wss' : 'ws';
+        const socket = createSocket(`${protocol}://${host}:${port}`);
+        // fires when we talk to the server
+        const onOpen = () => {
+            // fire our optional onConnect handler
+            onConnect && onConnect();
+            // trigger our plugins onConnect
+            this.plugins.forEach((p) => p.onConnect && p.onConnect());
+            const getClientIdPromise = getClientId || emptyPromise;
+            getClientIdPromise(name).then((clientId) => {
+                this.isReady = true;
+                // introduce ourselves
+                this.send('client.intro', {
+                    environment,
+                    ...client,
+                    name,
+                    clientId,
+                    dreactionCoreClientVersion: 'DREACTION_CORE_CLIENT_VERSION',
+                });
+                // flush the send queue
+                while (this.sendQueue.length > 0) {
+                    const h = this.sendQueue[0];
+                    this.sendQueue = this.sendQueue.slice(1);
+                    this.socket.send(h);
+                }
+            });
+        };
+        // fires when we disconnect
+        const onClose = () => {
+            this.isReady = false;
+            // trigger our disconnect handler
+            onDisconnect && onDisconnect();
+            // as well as the plugin's onDisconnect
+            this.plugins.forEach((p) => p.onDisconnect && p.onDisconnect());
+        };
+        const decodeCommandData = (data) => {
+            if (typeof data === 'string') {
+                return JSON.parse(data);
+            }
+            if (Buffer.isBuffer(data)) {
+                return JSON.parse(data.toString());
+            }
+            return data;
+        };
+        // fires when we receive a command, just forward it off
+        const onMessage = (data) => {
+            const command = decodeCommandData(data);
+            // trigger our own command handler
+            onCommand && onCommand(command);
+            // trigger our plugins onCommand
+            this.plugins.forEach((p) => p.onCommand && p.onCommand(command));
+            // trigger our registered custom commands
+            if (command.type === 'custom') {
+                this.customCommands
+                    .filter((cc) => {
+                    if (typeof command.payload === 'string') {
+                        return cc.command === command.payload;
+                    }
+                    return cc.command === command.payload.command;
+                })
+                    .forEach((cc) => cc.handler(typeof command.payload === 'object'
+                    ? command.payload.args
+                    : undefined));
+            }
+            else if (command.type === 'setClientId') {
+                this.options.setClientId && this.options.setClientId(command.payload);
+            }
+        };
+        // this is ws style from require('ws') on node js
+        if ('on' in socket && socket.on) {
+            const nodeWebSocket = socket;
+            nodeWebSocket.on('open', onOpen);
+            nodeWebSocket.on('close', onClose);
+            nodeWebSocket.on('message', onMessage);
+            // assign the socket to the instance
+            this.socket = socket;
+        }
+        else {
+            // this is a browser
+            const browserWebSocket = socket;
+            socket.onopen = onOpen;
+            socket.onclose = onClose;
+            socket.onmessage = (evt) => onMessage(evt.data);
+            // assign the socket to the instance
+            this.socket = browserWebSocket;
+        }
+        return this;
+    }
+    /**
+     * Sends a command to the server
+     */
+    send = (type, payload, important) => {
+        // set the timing info
+        const date = new Date();
+        let deltaTime = date.getTime() - this.lastMessageDate.getTime();
+        // glitches in the matrix
+        if (deltaTime < 0) {
+            deltaTime = 0;
+        }
+        this.lastMessageDate = date;
+        const fullMessage = {
+            type,
+            payload,
+            important: !!important,
+            date: date.toISOString(),
+            deltaTime,
+        };
+        const serializedMessage = (0, serialize_1.default)(fullMessage, this.options.proxyHack);
+        if (this.isReady) {
+            // send this command
+            try {
+                this.socket.send(serializedMessage);
+            }
+            catch {
+                this.isReady = false;
+                console.log('An error occurred communicating with reactotron. Please reload your app');
+            }
+        }
+        else {
+            // queue it up until we can connect
+            this.sendQueue.push(serializedMessage);
+        }
+    };
+    /**
+     * Sends a custom command to the server to displays nicely.
+     */
+    display(config) {
+        const { name, value, preview, image: img, important = false } = config;
+        const payload = {
+            name,
+            value: value || null,
+            preview: preview || null,
+            image: img || null,
+        };
+        this.send('display', payload, important);
+    }
+    /**
+     * Client libraries can hijack this to report errors.
+     */
+    reportError(error) {
+        this.error(error);
+    }
+    /**
+     * Adds a plugin to the system
+     */
+    use(pluginCreator) {
+        // we're supposed to be given a function
+        if (typeof pluginCreator !== 'function') {
+            throw new Error('plugins must be a function');
+        }
+        // execute it immediately passing the send function
+        const plugin = pluginCreator.bind(this)(this);
+        // ensure we get an Object-like creature back
+        if (typeof plugin !== 'object') {
+            throw new Error('plugins must return an object');
+        }
+        // do we have features to mixin?
+        if (plugin.features) {
+            // validate
+            if (typeof plugin.features !== 'object') {
+                throw new Error('features must be an object');
+            }
+            // here's how we're going to inject these in
+            const inject = (key) => {
+                // grab the function
+                const featureFunction = plugin.features[key];
+                // only functions may pass
+                if (typeof featureFunction !== 'function') {
+                    throw new Error(`feature ${key} is not a function`);
+                }
+                // ditch reserved names
+                if (isReservedFeature(key)) {
+                    throw new Error(`feature ${key} is a reserved name`);
+                }
+                // ok, let's glue it up... and lose all respect from elite JS champions.
+                this[key] = featureFunction;
+            };
+            // let's inject
+            Object.keys(plugin.features).forEach((key) => inject(key));
+        }
+        // add it to the list
+        this.plugins.push(plugin);
+        // call the plugins onPlugin
+        plugin.onPlugin &&
+            typeof plugin.onPlugin === 'function' &&
+            plugin.onPlugin.bind(this)(this);
+        // chain-friendly
+        return this;
+    }
+    onCustomCommand(config, optHandler) {
+        let command;
+        let handler;
+        let title;
+        let description;
+        let args;
+        if (typeof config === 'string') {
+            command = config;
+            handler = optHandler;
+        }
+        else {
+            command = config.command;
+            handler = config.handler;
+            title = config.title;
+            description = config.description;
+            args = config.args;
+        }
+        // Validations
+        // Make sure there is a command
+        if (!command) {
+            throw new Error('A command is required');
+        }
+        // Make sure there is a handler
+        if (!handler) {
+            throw new Error(`A handler is required for command "${command}"`);
+        }
+        // Make sure the command doesn't already exist
+        const existingCommands = this.customCommands.filter((cc) => cc.command === command);
+        if (existingCommands.length > 0) {
+            existingCommands.forEach((command) => {
+                this.customCommands = this.customCommands.filter((cc) => cc.id !== command.id);
+                this.send('customCommand.unregister', {
+                    id: command.id,
+                    command: command.command,
+                });
+            });
+        }
+        if (args) {
+            const argNames = [];
+            args.forEach((arg) => {
+                if (!arg.name) {
+                    throw new Error(`A arg on the command "${command}" is missing a name`);
+                }
+                if (argNames.indexOf(arg.name) > -1) {
+                    throw new Error(`A arg with the name "${arg.name}" already exists in the command "${command}"`);
+                }
+                argNames.push(arg.name);
+            });
+        }
+        // Create this command handlers object
+        const customHandler = {
+            id: this.customCommandLatestId,
+            command,
+            handler,
+            title,
+            description,
+            args,
+        };
+        // Increment our id counter
+        this.customCommandLatestId += 1;
+        // Add it to our array
+        this.customCommands.push(customHandler);
+        this.send('customCommand.register', {
+            id: customHandler.id,
+            command: customHandler.command,
+            title: customHandler.title,
+            description: customHandler.description,
+            args: customHandler.args,
+        });
+        return () => {
+            this.customCommands = this.customCommands.filter((cc) => cc.id !== customHandler.id);
+            this.send('customCommand.unregister', {
+                id: customHandler.id,
+                command: customHandler.command,
+            });
+        };
+    }
+}
+exports.ReactotronImpl = ReactotronImpl;
+// convenience factory function
+function createClient(options) {
+    const client = new ReactotronImpl();
+    return client.configure(options);
+}