@promptbook/markdown-utils 0.89.0-7 → 0.89.0-8

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-7';
+const PROMPTBOOK_ENGINE_VERSION = '0.89.0-8';
 /**
  * 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

@@ -121,6 +121,7 @@ import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOpt
 import type { AnonymousRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 import type { ApplicationRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 import type { ApplicationRemoteServerClientOptions } from '../remote-server/types/RemoteServerOptions';
+import type { ApplicationRemoteServerOptionsLoginResponse } from '../remote-server/types/RemoteServerOptions';
 import type { Converter } from '../scrapers/_common/Converter';
 import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
 import type { ScraperConstructor } from '../scrapers/_common/register/ScraperConstructor';
@@ -411,6 +412,7 @@ export type { RemoteServerOptions };
 export type { AnonymousRemoteServerOptions };
 export type { ApplicationRemoteServerOptions };
 export type { ApplicationRemoteServerClientOptions };
+export type { ApplicationRemoteServerOptionsLoginResponse };
 export type { Converter };
 export type { ScraperAndConverterMetadata };
 export type { ScraperConstructor };

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

@@ -1,5 +1,7 @@
+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 { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { string_app_id } from '../../types/typeAliases';
@@ -35,7 +37,11 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      * @example '/api/promptbook/'
      */
     readonly rootPath?: string_uri;
-} & (AnonymousRemoteServerOptions | ApplicationRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
+} & ((AnonymousRemoteServerOptions & {
+    readonly isApplicationModeAllowed?: false;
+}) | ({
+    readonly isAnonymousModeAllowed?: false;
+} & ApplicationRemoteServerOptions<TCustomOptions>) | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
 export type AnonymousRemoteServerOptions = {
     /**
      * Enable anonymous mode
@@ -55,13 +61,14 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
     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
      *
-     * @throws `AuthenticationError` if the user is not allowed to login for example because of invalid credentials
+     * 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(credentials: {
         /**
@@ -78,7 +85,17 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
          * Password of the user
          */
         readonly password: string_password;
-    }): Promise<PromptbookServer_Identification<TCustomOptions>>;
+        /**
+         * 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;
+    }): Promise<ApplicationRemoteServerOptionsLoginResponse<TCustomOptions>>;
     /**
      * Creates llm execution tools for each client
      */
@@ -110,6 +127,18 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
      */
     readonly customOptions?: TCustomOptions;
 };
+export type ApplicationRemoteServerOptionsLoginResponse<TCustomOptions> = {
+    /**
+     * Was the login successful
+     */
+    readonly isSuccess: boolean;
+    /**
+     *
+     */
+    readonly message?: string;
+    readonly error?: AuthenticationError;
+    readonly identification?: PromptbookServer_Identification<TCustomOptions>;
+};
 /**
  * TODO: Constrain anonymous mode for specific models / providers
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.89.0-7",
+    "version": "0.89.0-8",
     "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-7';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-8';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name