@promptbook/remote-client 0.88.0-9 → 0.89.0-1

package/esm/typings/src/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts

@@ -37,7 +37,8 @@ export type PromptbookServer_AnonymousIdentification = {
     /**
      * Identifier of the end user
      *
-     * Note: this is passed to the certain model providers to identify misuse
+     * Note: This can be either some id or email or any other identifier
+     * Note: In anonymous mode, this is passed to the certain model providers to identify misuse
      * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
      */
     readonly userId?: string_user_id;

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

@@ -58,15 +58,27 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
 };
 export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
     /**
-     * @@@
+     * Identifier of the application
+     *
+     * 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"
+     * Note: This can be some id or some semantic name like "email-agent"
      */
     readonly appId: string_app_id | null;
     /**
-     * @@@
+     * Identifier of the end user
+     *
+     * Note: This can be either some id or email or any other identifier
+     * Note: This is also passed to the certain model providers to identify misuse
      */
     readonly userId?: string_user_id;
     /**
-     * @@@
+     * Token of the user to verify its identity
+     *
+     * Note: This is passed for example to `createLlmExecutionTools`
+     */
+    readonly userToken?: string_user_id;
+    /**
+     * Additional arbitrary options to identify the client or to pass custom metadata
      */
     readonly customOptions?: TCustomOptions;
 };

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

@@ -433,13 +433,13 @@ export type string_uuid = string & {
  *
  * @@@
  */
-export type string_app_id = id;
+export type string_app_id = id | 'app';
 /**
  * End user identifier
  *
  * @@@
  */
-export type string_user_id = id;
+export type string_user_id = id | string_email;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts

@@ -5,3 +5,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countCharacters(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/esm/typings/src/utils/expectation-counters/countLines.d.ts

@@ -7,3 +7,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countLines(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/esm/typings/src/utils/expectation-counters/countPages.d.ts

@@ -7,3 +7,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countPages(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts

@@ -5,3 +5,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countParagraphs(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/esm/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -11,3 +11,6 @@ export declare function splitIntoSentences(text: string): ReadonlyArray<string>;
  * @public exported from `@promptbook/utils`
  */
 export declare function countSentences(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */

package/esm/typings/src/utils/expectation-counters/countWords.d.ts

@@ -5,3 +5,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countWords(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.88.0-9",
+    "version": "0.89.0-1",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -47,9 +47,10 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-client.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.88.0-9"
+        "@promptbook/core": "0.89.0-1"
     },
     "dependencies": {
+        "crypto": "^1.0.1",
         "crypto-js": "4.2.0",
         "papaparse": "5.4.1",
         "socket.io-client": "4.7.2",

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('socket.io-client'), require('crypto-js'), require('crypto-js/enc-hex'), require('papaparse'), require('path')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'socket.io-client', 'crypto-js', 'crypto-js/enc-hex', 'papaparse', 'path'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-remote-client"] = {}, global.spaceTrim, global.socket_ioClient, global.cryptoJs, global.hexEncoder, global.papaparse, global.path));
-})(this, (function (exports, spaceTrim, socket_ioClient, cryptoJs, hexEncoder, papaparse, path) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('crypto'), require('socket.io-client'), require('crypto-js'), require('crypto-js/enc-hex'), require('papaparse'), require('path')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'crypto', 'socket.io-client', 'crypto-js', 'crypto-js/enc-hex', 'papaparse', 'path'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-remote-client"] = {}, global.spaceTrim, global.crypto, global.socket_ioClient, global.cryptoJs, global.hexEncoder, global.papaparse, global.path));
+})(this, (function (exports, spaceTrim, crypto, socket_ioClient, cryptoJs, hexEncoder, papaparse, path) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.88.0-9';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -197,6 +197,21 @@
      * TODO: Maybe split `ParseError` and `ApplyError`
      */
 
+    /**
+     * Generates random token
+     *
+     * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
+     *
+     * @private internal helper function
+     * @returns secure random token
+     */
+    function $randomToken(randomness) {
+        return crypto.randomBytes(randomness).toString('hex');
+    }
+    /**
+     * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
+     */
+
     /**
      * This error indicates errors during the execution of the pipeline
      *
@@ -204,11 +219,17 @@
      */
     class PipelineExecutionError extends Error {
         constructor(message) {
+            // Added id parameter
             super(message);
             this.name = 'PipelineExecutionError';
+            // TODO: [🐙] DRY - Maybe $randomId
+            this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts   */)}`;
             Object.setPrototypeOf(this, PipelineExecutionError.prototype);
         }
     }
+    /**
+     * TODO: !!!!!! Add id to all errors
+     */
 
     /**
      * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
@@ -464,7 +485,7 @@
      * @public exported from `@promptbook/utils`
      */
     function deserializeError(error) {
-        const { name, stack } = error;
+        const { name, stack, id } = error; // Added id
         let { message } = error;
         let ErrorClass = ALL_ERRORS[error.name];
         if (ErrorClass === undefined) {
@@ -479,7 +500,9 @@
                 ${block(stack || '')}
             `);
         }
-        return new ErrorClass(message);
+        const deserializedError = new ErrorClass(message);
+        deserializedError.id = id; // Assign id to the error object
+        return deserializedError;
     }
 
     /**