@promptbook/utils 0.61.0-13 → 0.61.0-14

package/umd/typings/src/types/Prompt.d.ts

@@ -1,5 +1,8 @@
 import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { ChatModelRequirements } from './ModelRequirements';
+import type { CompletionModelRequirements } from './ModelRequirements';
+import type { EmbeddingModelRequirements } from './ModelRequirements';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PipelineJson/Expectations';
 import type { string_parameter_name } from './typeAliases';
@@ -13,7 +16,46 @@ import type { string_title } from './typeAliases';
  * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
  * @see https://github.com/webgptorg/promptbook#prompt
  */
-export type Prompt = {
+export type Prompt = CompletionPrompt | ChatPrompt | EmbeddingPrompt;
+/**
+ * Completion prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type CompletionPrompt = CommonPrompt & {
+    /**
+     * Requirements for completion model
+     */
+    modelRequirements: CompletionModelRequirements;
+};
+/**
+ * Chat prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type ChatPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: ChatModelRequirements;
+};
+/**
+ * Embedding prompt
+ *
+ * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ */
+export type EmbeddingPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: EmbeddingModelRequirements;
+};
+/**
+ * Common properties for all prompt results
+ *
+ * Note: This is fully serializable as JSON
+ */
+export type CommonPrompt = {
     /**
      * The title of the prompt
      *
@@ -63,6 +105,8 @@ export type Prompt = {
     readonly parameters: Record<string_parameter_name, string_parameter_value>;
 };
 /**
+ * TODO: [🔼] !!!! Export all from `@promptbook/types`
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
  * TODO: [✔] Check ModelRequirements in runtime
  * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
  */

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

@@ -196,6 +196,17 @@ export type string_script = string;
  * For example `console.info("Hello World!")`
  */
 export type string_javascript = string;
+/**
+ * Semantic helper for JSON strings
+ *
+ * Note: TType is a type of the JSON object inside the string
+ *
+ * For example `{"foo": "bar"}`
+ */
+export type string_json<TType> = string & {
+    _type: 'string_json';
+    scheme: TType;
+};
 /**
  * Semantic helper
  *

package/umd/typings/src/utils/normalization/parseKeywords.d.ts

@@ -1,3 +1,4 @@
+import type { really_unknown } from '../organization/really_unknown';
 import type { IKeywords } from './IKeywords';
 /**
  * Parses keywords from any object and recursively walks through
@@ -7,7 +8,7 @@ import type { IKeywords } from './IKeywords';
  * @param input of any kind
  * @returns {Set} of keywords without diacritics in lowercase
  */
-export declare function parseKeywords(input: unknown): IKeywords;
+export declare function parseKeywords(input: really_unknown): IKeywords;
 /**
  * Note: Not using spread in input param because of keeping second parameter for options
  * TODO: [🌺] Use some intermediate util splitWords

package/umd/typings/src/utils/organization/{TODO.d.ts → TODO_any.d.ts}

@@ -3,4 +3,4 @@
  *
  * @private within the repository
  */
-export type TODO = any;
+export type TODO_any = any;

package/umd/typings/src/utils/organization/TODO_object.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_object = object;

package/umd/typings/src/utils/organization/TODO_unknown.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_unknown = unknown;

package/umd/typings/src/utils/organization/really_any.d.ts

@@ -1,5 +1,5 @@
 /**
- * Organizational helper to mark a place where to really use any
+ * Organizational helper to mark a place where to really use `any`
  *
  * @private within the repository
  */

package/umd/typings/src/utils/organization/really_unknown.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to mark a place where to really use `unknown`
+ *
+ * @private within the repository
+ */
+export type really_unknown = unknown;

package/umd/typings/src/utils/validators/email/isValidEmail.d.ts

@@ -1,5 +1,6 @@
 import type { string_email } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid email
  */
-export declare function isValidEmail(email: unknown): email is string_email;
+export declare function isValidEmail(email: really_unknown): email is string_email;

package/umd/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -1,7 +1,8 @@
 import type { string_file_path } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
  *
  * Note: This does not check if the file exists only if the path is valid
  */
-export declare function isValidFilePath(filePath: unknown): filePath is string_file_path;
+export declare function isValidFilePath(filePath: really_unknown): filePath is string_file_path;

package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts

@@ -1,2 +1,3 @@
 import type { string_javascript_name } from '../../../types/typeAliases';
-export declare function isValidJavascriptName(javascriptName: unknown): javascriptName is string_javascript_name;
+import type { really_unknown } from '../../organization/really_unknown';
+export declare function isValidJavascriptName(javascriptName: really_unknown): javascriptName is string_javascript_name;

package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts

@@ -1,4 +1,5 @@
 import type { string_promptbook_version } from '../../../version';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid promptbook version
  * It looks into list of known promptbook versions.
@@ -9,4 +10,4 @@ import type { string_promptbook_version } from '../../../version';
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  */
-export declare function isValidPromptbookVersion(version: unknown): version is string_promptbook_version;
+export declare function isValidPromptbookVersion(version: really_unknown): version is string_promptbook_version;

package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts

@@ -1,4 +1,5 @@
 import type { string_semantic_version } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid semantic version
  *
@@ -6,4 +7,4 @@ import type { string_semantic_version } from '../../../types/typeAliases';
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  */
-export declare function isValidSemanticVersion(version: unknown): version is string_semantic_version;
+export declare function isValidSemanticVersion(version: really_unknown): version is string_semantic_version;

package/umd/typings/src/utils/validators/url/isValidPipelineUrl.d.ts

@@ -1,4 +1,5 @@
 import type { string_pipeline_url } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid pipeline URL URL.
  *
@@ -6,7 +7,7 @@ import type { string_pipeline_url } from '../../../types/typeAliases';
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
  */
-export declare function isValidPipelineUrl(url: unknown): url is string_pipeline_url;
+export declare function isValidPipelineUrl(url: really_unknown): url is string_pipeline_url;
 /**
  * TODO: [🐠] Maybe more info why the URL is invalid
  */

package/umd/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -1,4 +1,5 @@
 import type { string_url } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
  *
@@ -7,4 +8,4 @@ import type { string_url } from '../../../types/typeAliases';
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
  */
-export declare function isValidUrl(url: unknown): url is string_url;
+export declare function isValidUrl(url: really_unknown): url is string_url;

package/umd/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -1,5 +1,6 @@
 import type { string_uuid } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid uuid
  */
-export declare function isValidUuid(value: unknown): value is string_uuid;
+export declare function isValidUuid(value: really_unknown): value is string_uuid;