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

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,10 +9,9 @@ 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
+ * TODO: [🌡] Add CORS and security - probbably via `helmet`
  * TODO: Split this file into multiple functions - handler for each request
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`

package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts

@@ -1,7 +1,6 @@
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_base_url } from '../../types/typeAliases';
-import type { string_uri } from '../../types/typeAliases';
-import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
+import type { Identification } from '../socket-types/_subtypes/Identification';
 /**
  * Options for `RemoteLlmExecutionTools`
  *
@@ -12,21 +11,14 @@ export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
      * URL of the remote server
      * On this server will be connected to the socket.io server
      */
-    readonly remoteUrl: string_base_url;
-    /**
-     * Path for the Socket.io server to listen
-     *
-     * @default '/socket.io'
-     * @example '/promptbook/socket.io'
-     */
-    readonly path: string_uri;
+    readonly remoteServerUrl: string_base_url;
     /**
      * Identification of client for Socket.io remote server
      */
-    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    readonly identification: Identification<TCustomOptions>;
 };
 /**
  * TODO: Pass more options from Socket.io to `RemoteClientOptions` (like `transports`)
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
  */

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -1,10 +1,16 @@
+import type { Request, Response } from 'express';
 import type { Promisable } from 'type-fest';
 import type { PipelineCollection } from '../../collection/PipelineCollection';
+import { AuthenticationError } from '../../errors/AuthenticationError';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { string_app_id } from '../../types/typeAliases';
-import type { string_uri } from '../../types/typeAliases';
+import type { string_email } from '../../types/typeAliases';
+import type { string_password } from '../../types/typeAliases';
 import type { string_user_id } from '../../types/typeAliases';
+import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
+import type { Identification } from '../socket-types/_subtypes/Identification';
 /**
  * @@@
  *
@@ -16,7 +22,6 @@ import type { string_user_id } from '../../types/typeAliases';
  *
  * You can enable both modes at the same time.
  *
- * @public exported from `@promptbook/remote-client`
  * @public exported from `@promptbook/remote-server`
  */
 export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
@@ -25,15 +30,23 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      */
     readonly port: number;
     /**
-     * Root path of the server
+     * Creates execution tools the client
      *
-     * Note: This is useful when you reverse proxy the server without changing the path
+     * This is relevant also in anonymous mode in oposition to `createLlmExecutionTools`
      *
-     * @default '/'
-     * @example '/api/promptbook/'
+     * Note: You can provide only some tools and leave the rest to the default ones also llm tools are created by `createLlmExecutionTools`
+     * Note: This is useful when you want to provide some custom restrictions for example:
+     * - Limit access to certain websites for some users
+     * - Bind user-interface tools to email agent
+     * - Allow / block script execution
+     * - And many more
      */
-    readonly rootPath: string_uri;
-} & (AnonymousRemoteServerOptions | ApplicationRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
+    createExecutionTools?(options: Identification<TCustomOptions>): Promisable<Partial<Omit<ExecutionTools, 'llm'>>>;
+} & ((AnonymousRemoteServerOptions & {
+    readonly isApplicationModeAllowed?: false;
+}) | ({
+    readonly isAnonymousModeAllowed?: false;
+} & ApplicationRemoteServerOptions<TCustomOptions>) | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
 export type AnonymousRemoteServerOptions = {
     /**
      * Enable anonymous mode
@@ -51,10 +64,22 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
      * This is used to check validity of the prompt to prevent misuse
      */
     readonly collection: PipelineCollection;
+    /**
+     * User tries to login to the server, this function will be called verify the user and return the identification or throw an error
+     * This can be also doubled as a function to register the user
+     *
+     * Note: In most cases, you will return `PromptbookServer_ApplicationIdentification`
+     *       `PromptbookServer_AnonymousIdentification` is useful only in scenarios when user stores its own api keys on the application server and
+     *       server acts only as a api key provider
+     *
+     * Note: In most cases DO NOT THROW `AuthenticationError` but return `isSuccess: false` with message
+     * @throws `AuthenticationError`  if the user is not allowed to login for example because of invalid credentials
+     */
+    login(loginRequest: LoginRequest): Promise<LoginResponse<TCustomOptions>>;
     /**
      * Creates llm execution tools for each client
      */
-    createLlmExecutionTools(options: ApplicationRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
+    createLlmExecutionTools(options: ApplicationModeIdentification<TCustomOptions>): Promisable<LlmExecutionTools>;
 };
 export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
     /**
@@ -82,6 +107,56 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
      */
     readonly customOptions?: TCustomOptions;
 };
+/**
+ * Login request for the application mode
+ */
+export type LoginRequest = {
+    /**
+     * Identifier of the application you are using
+     *
+     * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+     */
+    readonly appId: string_app_id | null;
+    /**
+     * Username (for example email) of the user
+     */
+    readonly username: string_email | string;
+    /**
+     * Password of the user
+     */
+    readonly password: string_password;
+    /**
+     * Request object from express if you want to access some request data for example headers, IP address, etc.
+     */
+    readonly rawRequest: Request;
+    /**
+     * Response object from express if you want to add some custom headers.
+     *
+     * Note: It is not recommended to use this object to send body of the response because it can confuse the client
+     */
+    readonly rawResponse: Response;
+};
+/**
+ * Login response for the application mode
+ */
+export type LoginResponse<TCustomOptions> = {
+    /**
+     * Was the login successful
+     */
+    readonly isSuccess: boolean;
+    /**
+     * Message to display to the user, this message is always displayed
+     */
+    readonly message?: string;
+    /**
+     * Optional error if the login was not successful
+     */
+    readonly error?: AuthenticationError;
+    /**
+     * Identification of the user to be used in the future requests
+     */
+    readonly identification?: Identification<TCustomOptions>;
+};
 /**
  * TODO: Constrain anonymous mode for specific models / providers
  */

package/esm/typings/src/scrapers/_common/utils/{scraperFetch.d.ts → promptbookFetch.d.ts}

@@ -2,9 +2,9 @@ import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
 /**
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
  *
- * @private as default `fetch` function used in Promptbook scrapers
+ * @public exported from `@promptbook/core`
  */
-export declare const scraperFetch: PromptbookFetch;
+export declare const promptbookFetch: PromptbookFetch;
 /**
  * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
  */

package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts

@@ -0,0 +1,40 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Stores data in .env variables
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file and also writes to `process.env`
+ *
+ * @private within the repository - for CLI utils
+ */
+export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
+    private envFilename;
+    private $provideOrCreateEnvFile;
+    private transformKey;
+    /**
+     * Returns the number of key/value pairs currently present in the list associated with the object.
+     */
+    get length(): number;
+    /**
+     * Empties the list associated with the object of all key/value pairs, if there are any.
+     */
+    clear(): void;
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     */
+    getItem(key: string): Promise<TItem | null>;
+    /**
+     * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
+     */
+    key(index: number): string | null;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): Promise<void>;
+    /**
+     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     */
+    removeItem(key: string): void;
+}
+/**
+ * TODO: Write file more securely - ensure that there can be no accidental overwriting of existing variables and other content
+ */

package/esm/typings/src/types/typeAliases.d.ts

@@ -325,6 +325,12 @@ export type string_css_selector = string;
  * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
  */
 export type string_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://s1.ptbk.io/promptbook"`
+ */
+export type string_promptbook_server_url = string;
 /**
  * Semantic helper
  *
@@ -521,6 +527,13 @@ export type string_person_profile = string;
  * For example `"MIT"`
  */
 export type string_license = string;
+/**
+ * Semantic helper
+ *
+ * For example `"Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)"`
+ * For example `"AI Web, LLC <legal@ptbk.io> (https://www.ptbk.io/)"`
+ */
+export type string_legal_entity = string | string_person_profile | string_title;
 /**
  * Semantic helper for attributes
  *
@@ -570,6 +583,12 @@ export type string_postprocessing_function_name = string;
 export type id = string | number;
 export type task_id = string;
 export type string_token = string;
+/**
+ * Semantic helper
+ *
+ * Made by `identificationToPromptbookToken` exported from `@promptbook/core`
+ */
+export type string_promptbook_token = string_token;
 export type string_license_token = string_token;
 export type string_password = string;
 export type string_ssh_key = string;

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-31",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -43,15 +43,19 @@
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
     "homepage": "https://ptbk.io/",
+    "engines": {
+        "node": ">=16.0.0",
+        "npm": ">=8.0.0"
+    },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/markdown-utils.index.d.ts",
     "dependencies": {
-        "crypto": "^1.0.1",
+        "crypto": "1.0.1",
         "crypto-js": "4.2.0",
         "papaparse": "5.4.1",
         "prettier": "2.8.1",
-        "rxjs": "^7.8.1",
+        "rxjs": "7.8.1",
         "spacetrim": "0.11.59",
         "waitasecond": "1.11.83"
     }