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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -210,6 +210,7 @@ import type { string_uri_part } from '../types/typeAliases';
210
210
  import type { string_hostname } from '../types/typeAliases';
211
211
  import type { string_host } from '../types/typeAliases';
212
212
  import type { string_protocol } from '../types/typeAliases';
213
+ import type { string_ip_address } from '../types/typeAliases';
213
214
  import type { string_email } from '../types/typeAliases';
214
215
  import type { string_emails } from '../types/typeAliases';
215
216
  import type { string_uuid } from '../types/typeAliases';
@@ -505,6 +506,7 @@ export type { string_uri_part };
505
506
  export type { string_hostname };
506
507
  export type { string_host };
507
508
  export type { string_protocol };
509
+ export type { string_ip_address };
508
510
  export type { string_email };
509
511
  export type { string_emails };
510
512
  export type { string_uuid };
@@ -5,7 +5,9 @@ import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMe
5
5
  import { deserializeError } from '../errors/utils/deserializeError';
6
6
  import { serializeError } from '../errors/utils/serializeError';
7
7
  import { forEachAsync } from '../execution/utils/forEachAsync';
8
+ import { isValidCsvString } from '../formats/csv/utils/isValidCsvString';
8
9
  import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
10
+ import { isValidXmlString } from '../formats/xml/utils/isValidXmlString';
9
11
  import { prompt } from '../pipeline/prompt-notation';
10
12
  import { promptTemplate } from '../pipeline/prompt-notation';
11
13
  import { $getCurrentDate } from '../utils/$getCurrentDate';
@@ -87,7 +89,9 @@ export { renderPromptbookMermaid };
87
89
  export { deserializeError };
88
90
  export { serializeError };
89
91
  export { forEachAsync };
92
+ export { isValidCsvString };
90
93
  export { isValidJsonString };
94
+ export { isValidXmlString };
91
95
  export { prompt };
92
96
  export { promptTemplate };
93
97
  export { $getCurrentDate };
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Function to check if a string is valid CSV
3
+ *
4
+ * @param value The string to check
5
+ * @returns True if the string is a valid CSV string, false otherwise
6
+ *
7
+ * @public exported from `@promptbook/utils`
8
+ */
9
+ export declare function isValidCsvString(value: string): boolean;
@@ -1,6 +1,9 @@
1
1
  /**
2
2
  * Function isValidJsonString will tell you if the string is valid JSON or not
3
3
  *
4
+ * @param value The string to check
5
+ * @returns True if the string is a valid JSON string, false otherwise
6
+ *
4
7
  * @public exported from `@promptbook/utils`
5
8
  */
6
9
  export declare function isValidJsonString(value: string): boolean;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Function to check if a string is valid XML
3
+ *
4
+ * @param value
5
+ * @returns True if the string is a valid XML string, false otherwise
6
+ *
7
+ * @public exported from `@promptbook/utils`
8
+ */
9
+ export declare function isValidXmlString(value: string): boolean;
@@ -1,4 +1,5 @@
1
1
  import type { LlmToolsConfiguration } from '../../../llm-providers/_common/register/LlmToolsConfiguration';
2
+ import type { string_ip_address } from '../../../types/typeAliases';
2
3
  import type { string_user_id } from '../../../types/typeAliases';
3
4
  import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteServerOptions';
4
5
  /**
@@ -7,7 +8,12 @@ import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteSer
7
8
  * @public exported from `@promptbook/remote-server`
8
9
  * @public exported from `@promptbook/remote-client`
9
10
  */
10
- export type Identification<TCustomOptions> = ApplicationModeIdentification<TCustomOptions> | AnonymousModeIdentification;
11
+ export type Identification<TCustomOptions> = (ApplicationModeIdentification<TCustomOptions> | AnonymousModeIdentification) & {
12
+ /**
13
+ * Identifier of the IP address of the client
14
+ */
15
+ readonly ipAddress?: string_ip_address;
16
+ };
11
17
  /**
12
18
  * Application mode is situation when you run known and well-defined books with your own api keys
13
19
  *
@@ -8,6 +8,7 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
8
8
  import type { string_app_id } from '../../types/typeAliases';
9
9
  import type { string_email } from '../../types/typeAliases';
10
10
  import type { string_password } from '../../types/typeAliases';
11
+ import type { string_token } from '../../types/typeAliases';
11
12
  import type { string_user_id } from '../../types/typeAliases';
12
13
  import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
13
14
  import type { Identification } from '../socket-types/_subtypes/Identification';
@@ -101,7 +102,7 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
101
102
  *
102
103
  * Note: This is passed for example to `createLlmExecutionTools`
103
104
  */
104
- readonly userToken?: string_user_id;
105
+ readonly userToken?: string_token;
105
106
  /**
106
107
  * Additional arbitrary options to identify the client or to pass custom metadata
107
108
  */
@@ -414,6 +414,13 @@ export type string_host = string;
414
414
  * Semantic helper
415
415
  */
416
416
  export type string_protocol = 'http:' | 'https:';
417
+ /**
418
+ * Semantic helper
419
+ *
420
+ * For example `"192.168.1.1"` (IPv4)
421
+ * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
422
+ */
423
+ export type string_ip_address = string;
417
424
  /**
418
425
  * Semantic helper
419
426
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/markdown-utils",
3
- "version": "0.89.0-31",
3
+ "version": "0.89.0-33",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "private": false,
6
6
  "sideEffects": false,
package/umd/index.umd.js CHANGED
@@ -25,7 +25,7 @@
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.89.0-31';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.89.0-33';
29
29
  /**
30
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
31
31
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -465,6 +465,9 @@
465
465
  /**
466
466
  * Function isValidJsonString will tell you if the string is valid JSON or not
467
467
  *
468
+ * @param value The string to check
469
+ * @returns True if the string is a valid JSON string, false otherwise
470
+ *
468
471
  * @public exported from `@promptbook/utils`
469
472
  */
470
473
  function isValidJsonString(value /* <- [👨‍⚖️] */) {
@@ -4096,6 +4099,28 @@
4096
4099
  // encoding: 'utf-8',
4097
4100
  });
4098
4101
 
4102
+ /**
4103
+ * Function to check if a string is valid CSV
4104
+ *
4105
+ * @param value The string to check
4106
+ * @returns True if the string is a valid CSV string, false otherwise
4107
+ *
4108
+ * @public exported from `@promptbook/utils`
4109
+ */
4110
+ function isValidCsvString(value) {
4111
+ try {
4112
+ // A simple check for CSV format: at least one comma and no invalid characters
4113
+ if (value.includes(',') && /^[\w\s,"']+$/.test(value)) {
4114
+ return true;
4115
+ }
4116
+ return false;
4117
+ }
4118
+ catch (error) {
4119
+ assertsError(error);
4120
+ return false;
4121
+ }
4122
+ }
4123
+
4099
4124
  /**
4100
4125
  * Definition for CSV spreadsheet
4101
4126
  *
@@ -4106,7 +4131,7 @@
4106
4131
  formatName: 'CSV',
4107
4132
  aliases: ['SPREADSHEET', 'TABLE'],
4108
4133
  isValid(value, settings, schema) {
4109
- return true;
4134
+ return isValidCsvString(value);
4110
4135
  },
4111
4136
  canBeValid(partialValue, settings, schema) {
4112
4137
  return true;
@@ -4260,6 +4285,30 @@
4260
4285
  * TODO: [🏢] Allow to expect something inside each item of list and other formats
4261
4286
  */
4262
4287
 
4288
+ /**
4289
+ * Function to check if a string is valid XML
4290
+ *
4291
+ * @param value
4292
+ * @returns True if the string is a valid XML string, false otherwise
4293
+ *
4294
+ * @public exported from `@promptbook/utils`
4295
+ */
4296
+ function isValidXmlString(value) {
4297
+ try {
4298
+ const parser = new DOMParser();
4299
+ const parsedDocument = parser.parseFromString(value, 'application/xml');
4300
+ const parserError = parsedDocument.getElementsByTagName('parsererror');
4301
+ if (parserError.length > 0) {
4302
+ return false;
4303
+ }
4304
+ return true;
4305
+ }
4306
+ catch (error) {
4307
+ assertsError(error);
4308
+ return false;
4309
+ }
4310
+ }
4311
+
4263
4312
  /**
4264
4313
  * Definition for XML format
4265
4314
  *
@@ -4269,7 +4318,7 @@
4269
4318
  formatName: 'XML',
4270
4319
  mimeType: 'application/xml',
4271
4320
  isValid(value, settings, schema) {
4272
- return true;
4321
+ return isValidXmlString(value);
4273
4322
  },
4274
4323
  canBeValid(partialValue, settings, schema) {
4275
4324
  return true;