@arcanejs/toolkit 0.2.1 → 0.3.0

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import * as _arcanejs_protocol_logging from '@arcanejs/protocol/logging';
+import { Logger } from '@arcanejs/protocol/logging';
 import _ from 'lodash';
 import * as http from 'http';
 import { Application } from 'express';
@@ -5,7 +7,7 @@ import { WebSocket } from 'ws';
 import { ClientMessage, ServerMessage } from '@arcanejs/protocol';
 import { Group } from './backend/components/group.mjs';
 export { GroupHeader } from './backend/components/group.mjs';
-import { Component } from './backend/components/base.mjs';
+import { Parent, Component } from './backend/components/base.mjs';
 export { Button } from './backend/components/button.mjs';
 export { Label } from './backend/components/label.mjs';
 export { Rect } from './backend/components/rect.mjs';
@@ -25,7 +27,8 @@ declare class Server {
     private readonly onNewConnection;
     private readonly onClosedConnection;
     private readonly onMessage;
-    constructor(options: LightDeskOptions, onNewConnection: (connection: Connection) => void, onClosedConnection: (connection: Connection) => void, onMessage: (connection: Connection, message: ClientMessage) => void);
+    private readonly log?;
+    constructor(options: LightDeskOptions, onNewConnection: (connection: Connection) => void, onClosedConnection: (connection: Connection) => void, onMessage: (connection: Connection, message: ClientMessage) => void, log?: Logger | undefined);
     handleHttpRequest: (req: http.IncomingMessage, res: http.ServerResponse) => Promise<void>;
     private sendStaticFile;
     handleWsConnection: <S extends WebSocket>(ws: S) => void;
@@ -38,12 +41,26 @@ interface LightDeskOptions {
      * This is important if a express server will be used that serves other paths.
      */
     path: string;
+    /**
+     * An optional object that can be used to output log events,
+     * we recommend using `pino` for this,
+     * as log levels etc... can be controlled.
+     *
+     * You can also always use `console` for logging,
+     * but this will be quite verbose.
+     */
+    log?: Logger;
 }
 type InitializationOptions = 
 /** automatically start a simple  */
 {
     mode: 'automatic';
     port: number;
+    /**
+     * Optional callback that is called when the server is ready,
+     * with the url that the server is running on.
+     */
+    onReady?: (url: string) => void;
 }
 /** Create a websocket server that attaches to an existing express and http server */
  | {
@@ -57,7 +74,7 @@ type InitializationOptions =
     setup: (server: Server) => void;
 };
 
-declare class Toolkit {
+declare class Toolkit implements Parent {
     private readonly options;
     /**
      * Mapping from components to unique IDs that identify them
@@ -68,6 +85,7 @@ declare class Toolkit {
     constructor(options?: Partial<LightDeskOptions>);
     start: (opts: InitializationOptions) => void;
     setRoot: (group: Group) => void;
+    log(): _arcanejs_protocol_logging.Logger | null;
     updateTree: _.DebouncedFuncLeading<() => void>;
     removeChild: (component: Component) => void;
     private onNewConnection;

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import * as _arcanejs_protocol_logging from '@arcanejs/protocol/logging';
+import { Logger } from '@arcanejs/protocol/logging';
 import _ from 'lodash';
 import * as http from 'http';
 import { Application } from 'express';
@@ -5,7 +7,7 @@ import { WebSocket } from 'ws';
 import { ClientMessage, ServerMessage } from '@arcanejs/protocol';
 import { Group } from './backend/components/group.js';
 export { GroupHeader } from './backend/components/group.js';
-import { Component } from './backend/components/base.js';
+import { Parent, Component } from './backend/components/base.js';
 export { Button } from './backend/components/button.js';
 export { Label } from './backend/components/label.js';
 export { Rect } from './backend/components/rect.js';
@@ -25,7 +27,8 @@ declare class Server {
     private readonly onNewConnection;
     private readonly onClosedConnection;
     private readonly onMessage;
-    constructor(options: LightDeskOptions, onNewConnection: (connection: Connection) => void, onClosedConnection: (connection: Connection) => void, onMessage: (connection: Connection, message: ClientMessage) => void);
+    private readonly log?;
+    constructor(options: LightDeskOptions, onNewConnection: (connection: Connection) => void, onClosedConnection: (connection: Connection) => void, onMessage: (connection: Connection, message: ClientMessage) => void, log?: Logger | undefined);
     handleHttpRequest: (req: http.IncomingMessage, res: http.ServerResponse) => Promise<void>;
     private sendStaticFile;
     handleWsConnection: <S extends WebSocket>(ws: S) => void;
@@ -38,12 +41,26 @@ interface LightDeskOptions {
      * This is important if a express server will be used that serves other paths.
      */
     path: string;
+    /**
+     * An optional object that can be used to output log events,
+     * we recommend using `pino` for this,
+     * as log levels etc... can be controlled.
+     *
+     * You can also always use `console` for logging,
+     * but this will be quite verbose.
+     */
+    log?: Logger;
 }
 type InitializationOptions = 
 /** automatically start a simple  */
 {
     mode: 'automatic';
     port: number;
+    /**
+     * Optional callback that is called when the server is ready,
+     * with the url that the server is running on.
+     */
+    onReady?: (url: string) => void;
 }
 /** Create a websocket server that attaches to an existing express and http server */
  | {
@@ -57,7 +74,7 @@ type InitializationOptions =
     setup: (server: Server) => void;
 };
 
-declare class Toolkit {
+declare class Toolkit implements Parent {
     private readonly options;
     /**
      * Mapping from components to unique IDs that identify them
@@ -68,6 +85,7 @@ declare class Toolkit {
     constructor(options?: Partial<LightDeskOptions>);
     start: (opts: InitializationOptions) => void;
     setRoot: (group: Group) => void;
+    log(): _arcanejs_protocol_logging.Logger | null;
     updateTree: _.DebouncedFuncLeading<() => void>;
     removeChild: (component: Component) => void;
     private onNewConnection;