@promptbook/markdown-utils 0.89.0-3 → 0.89.0-5

package/esm/index.es.js

@@ -25,7 +25,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.89.0-3';
+const PROMPTBOOK_ENGINE_VERSION = '0.89.0-5';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/_packages/types.index.d.ts

@@ -112,6 +112,7 @@ import type { components } from '../playground/brjapp-api-schema';
 import type { $defs } from '../playground/brjapp-api-schema';
 import type { operations } from '../playground/brjapp-api-schema';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { RemoteServer } from '../remote-server/RemoteServer';
 import type { PromptbookServer_Identification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
 import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
 import type { PromptbookServer_AnonymousIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
@@ -401,6 +402,7 @@ export type { components };
 export type { $defs };
 export type { operations };
 export type { PrepareAndScrapeOptions };
+export type { RemoteServer };
 export type { PromptbookServer_Identification };
 export type { PromptbookServer_ApplicationIdentification };
 export type { PromptbookServer_AnonymousIdentification };

package/esm/typings/src/remote-server/RemoteServer.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import type { IDestroyable } from 'destroyable';
+import express from 'express';
+import http from 'http';
+import { DefaultEventsMap, Server } from 'socket.io';
+import type { TODO_any } from '../utils/organization/TODO_any';
+import type { TODO_narrow } from '../utils/organization/TODO_narrow';
+export type RemoteServer = IDestroyable & {
+    /**
+     * HTTP server instance
+     */
+    readonly httpServer: http.Server<TODO_any>;
+    /**
+     * Express application instance
+     *
+     * Note: This is useful for adding custom routes
+     */
+    readonly expressApp: express.Express;
+    /**
+     * Socket.io server instance
+     */
+    readonly socketIoServer: Server<TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_any>;
+};

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -1,4 +1,4 @@
-import type { IDestroyable } from 'destroyable';
+import type { RemoteServer } from './RemoteServer';
 import type { RemoteServerOptions } from './types/RemoteServerOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
@@ -9,7 +9,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  * @see https://github.com/webgptorg/promptbook#remote-server
  * @public exported from `@promptbook/remote-server`
  */
-export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
+export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
 /**
  * TODO: !! Add CORS and security - probbably via `helmet`
  * TODO: [👩🏾‍🤝‍🧑🏾] Allow to pass custom fetch function here - PromptbookFetch

package/esm/typings/src/utils/organization/TODO_narrow.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the more specific type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_narrow<T> = T;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.89.0-3",
+    "version": "0.89.0-5",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-3';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-5';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name