@promptbook/documents 0.89.0-31 → 0.89.0-33

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

@@ -210,6 +210,7 @@ import type { string_uri_part } from '../types/typeAliases';
 import type { string_hostname } from '../types/typeAliases';
 import type { string_host } from '../types/typeAliases';
 import type { string_protocol } from '../types/typeAliases';
+import type { string_ip_address } from '../types/typeAliases';
 import type { string_email } from '../types/typeAliases';
 import type { string_emails } from '../types/typeAliases';
 import type { string_uuid } from '../types/typeAliases';
@@ -505,6 +506,7 @@ export type { string_uri_part };
 export type { string_hostname };
 export type { string_host };
 export type { string_protocol };
+export type { string_ip_address };
 export type { string_email };
 export type { string_emails };
 export type { string_uuid };

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

@@ -5,7 +5,9 @@ import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMe
 import { deserializeError } from '../errors/utils/deserializeError';
 import { serializeError } from '../errors/utils/serializeError';
 import { forEachAsync } from '../execution/utils/forEachAsync';
+import { isValidCsvString } from '../formats/csv/utils/isValidCsvString';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
+import { isValidXmlString } from '../formats/xml/utils/isValidXmlString';
 import { prompt } from '../pipeline/prompt-notation';
 import { promptTemplate } from '../pipeline/prompt-notation';
 import { $getCurrentDate } from '../utils/$getCurrentDate';
@@ -87,7 +89,9 @@ export { renderPromptbookMermaid };
 export { deserializeError };
 export { serializeError };
 export { forEachAsync };
+export { isValidCsvString };
 export { isValidJsonString };
+export { isValidXmlString };
 export { prompt };
 export { promptTemplate };
 export { $getCurrentDate };

package/esm/typings/src/formats/csv/utils/isValidCsvString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function to check if a string is valid CSV
+ *
+ * @param value The string to check
+ * @returns True if the string is a valid CSV string, false otherwise
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidCsvString(value: string): boolean;

package/esm/typings/src/formats/csv/utils/isValidCsvString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts

@@ -1,6 +1,9 @@
 /**
  * Function isValidJsonString will tell you if the string is valid JSON or not
  *
+ * @param value The string to check
+ * @returns True if the string is a valid JSON string, false otherwise
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidJsonString(value: string): boolean;

package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function to check if a string is valid XML
+ *
+ * @param value
+ * @returns True if the string is a valid XML string, false otherwise
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidXmlString(value: string): boolean;

package/esm/typings/src/formats/xml/utils/isValidXmlString.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,4 +1,5 @@
 import type { LlmToolsConfiguration } from '../../../llm-providers/_common/register/LlmToolsConfiguration';
+import type { string_ip_address } from '../../../types/typeAliases';
 import type { string_user_id } from '../../../types/typeAliases';
 import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteServerOptions';
 /**
@@ -7,7 +8,12 @@ import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteSer
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
  */
-export type Identification<TCustomOptions> = ApplicationModeIdentification<TCustomOptions> | AnonymousModeIdentification;
+export type Identification<TCustomOptions> = (ApplicationModeIdentification<TCustomOptions> | AnonymousModeIdentification) & {
+    /**
+     * Identifier of the IP address of the client
+     */
+    readonly ipAddress?: string_ip_address;
+};
 /**
  * Application mode is situation when you run known and well-defined books with your own api keys
  *

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

@@ -8,6 +8,7 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { string_app_id } from '../../types/typeAliases';
 import type { string_email } from '../../types/typeAliases';
 import type { string_password } from '../../types/typeAliases';
+import type { string_token } 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';
@@ -101,7 +102,7 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
      *
      * Note: This is passed for example to `createLlmExecutionTools`
      */
-    readonly userToken?: string_user_id;
+    readonly userToken?: string_token;
     /**
      * Additional arbitrary options to identify the client or to pass custom metadata
      */

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

@@ -414,6 +414,13 @@ export type string_host = string;
  * Semantic helper
  */
 export type string_protocol = 'http:' | 'https:';
+/**
+ * Semantic helper
+ *
+ * For example `"192.168.1.1"` (IPv4)
+ * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
+ */
+export type string_ip_address = string;
 /**
  * Semantic helper
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/documents",
-    "version": "0.89.0-31",
+    "version": "0.89.0-33",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.89.0-31"
+        "@promptbook/core": "0.89.0-33"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -26,7 +26,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-31';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-33';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1121,6 +1121,9 @@
     /**
      * Function isValidJsonString will tell you if the string is valid JSON or not
      *
+     * @param value The string to check
+     * @returns True if the string is a valid JSON string, false otherwise
+     *
      * @public exported from `@promptbook/utils`
      */
     function isValidJsonString(value /* <- [👨‍⚖️] */) {
@@ -4173,6 +4176,28 @@
         // encoding: 'utf-8',
     });
 
+    /**
+     * Function to check if a string is valid CSV
+     *
+     * @param value The string to check
+     * @returns True if the string is a valid CSV string, false otherwise
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function isValidCsvString(value) {
+        try {
+            // A simple check for CSV format: at least one comma and no invalid characters
+            if (value.includes(',') && /^[\w\s,"']+$/.test(value)) {
+                return true;
+            }
+            return false;
+        }
+        catch (error) {
+            assertsError(error);
+            return false;
+        }
+    }
+
     /**
      * Definition for CSV spreadsheet
      *
@@ -4183,7 +4208,7 @@
         formatName: 'CSV',
         aliases: ['SPREADSHEET', 'TABLE'],
         isValid(value, settings, schema) {
-            return true;
+            return isValidCsvString(value);
         },
         canBeValid(partialValue, settings, schema) {
             return true;
@@ -4337,6 +4362,30 @@
      * TODO: [🏢] Allow to expect something inside each item of list and other formats
      */
 
+    /**
+     * Function to check if a string is valid XML
+     *
+     * @param value
+     * @returns True if the string is a valid XML string, false otherwise
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function isValidXmlString(value) {
+        try {
+            const parser = new DOMParser();
+            const parsedDocument = parser.parseFromString(value, 'application/xml');
+            const parserError = parsedDocument.getElementsByTagName('parsererror');
+            if (parserError.length > 0) {
+                return false;
+            }
+            return true;
+        }
+        catch (error) {
+            assertsError(error);
+            return false;
+        }
+    }
+
     /**
      * Definition for XML format
      *
@@ -4346,7 +4395,7 @@
         formatName: 'XML',
         mimeType: 'application/xml',
         isValid(value, settings, schema) {
-            return true;
+            return isValidXmlString(value);
         },
         canBeValid(partialValue, settings, schema) {
             return true;