@promptbook/utils 0.41.0 → 0.41.2

package/umd/typings/execution/plugins/script-execution-tools/python/PythonExecutionTools.d.ts

@@ -1,15 +1,15 @@
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-/**
- * ScriptExecutionTools for Python
- *
- * Warning: This is not implemented yet
- */
-export declare class PythonExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
-    /**
-     * Executes a Python
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
+/**
+ * ScriptExecutionTools for Python
+ *
+ * Warning: This is not implemented yet
+ */
+export declare class PythonExecutionTools implements ScriptExecutionTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Executes a Python
+     */
+    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
+}

package/umd/typings/execution/plugins/script-execution-tools/script-execution-errors.test.d.ts

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

package/umd/typings/execution/plugins/script-execution-tools/script-execution-tools.test.d.ts

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

package/umd/typings/execution/plugins/script-execution-tools/typescript/TypescriptExecutionTools.d.ts

@@ -1,15 +1,15 @@
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-/**
- * ScriptExecutionTools for TypeScript
- *
- * Warning: This is not implemented yet
- */
-export declare class TypescriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
-    /**
-     * Executes a TypeScript
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
+/**
+ * ScriptExecutionTools for TypeScript
+ *
+ * Warning: This is not implemented yet
+ */
+export declare class TypescriptExecutionTools implements ScriptExecutionTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Executes a TypeScript
+     */
+    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
+}

package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools.d.ts

@@ -1,14 +1,14 @@
-import { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
-import { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
-/**
- * Delagates the user interaction to a async callback function
- * You need to provide your own implementation of this callback function and its bind to UI.
- */
-export declare class CallbackInterfaceTools implements UserInterfaceTools {
-    private readonly options;
-    constructor(options: CallbackInterfaceToolsOptions);
-    /**
-     * Trigger the custom callback function
-     */
-    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
-}
+import { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
+import { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
+/**
+ * Delagates the user interaction to a async callback function
+ * You need to provide your own implementation of this callback function and its bind to UI.
+ */
+export declare class CallbackInterfaceTools implements UserInterfaceTools {
+    private readonly options;
+    constructor(options: CallbackInterfaceToolsOptions);
+    /**
+     * Trigger the custom callback function
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+}

package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions.d.ts

@@ -1,12 +1,12 @@
-import { Promisable } from 'type-fest';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
-/**
- * Options for CallbackInterfaceTools
- */
-export type CallbackInterfaceToolsOptions = CommonExecutionToolsOptions & {
-    /**
-     * The callback function to be called when promptDialog is called
-     */
-    callback(prompt: UserInterfaceToolsPromptDialogOptions): Promisable<string>;
-};
+import { Promisable } from 'type-fest';
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
+/**
+ * Options for CallbackInterfaceTools
+ */
+export type CallbackInterfaceToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * The callback function to be called when promptDialog is called
+     */
+    callback(prompt: UserInterfaceToolsPromptDialogOptions): Promisable<string>;
+};

package/umd/typings/execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -1,16 +1,16 @@
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
-/**
- * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
- *
- * Warning: It is used for testing and mocking
- *          **NOT intended to use in the production** due to its synchronous nature.
- */
-export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
-    private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
-    /**
-     * Trigger window.PROMPT DIALOG
-     */
-    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
-}
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
+/**
+ * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
+ *
+ * Warning: It is used for testing and mocking
+ *          **NOT intended to use in the production** due to its synchronous nature.
+ */
+export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Trigger window.PROMPT DIALOG
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+}

package/umd/typings/execution/plugins/user-interface-execution-tools/user-interface-execution-tools.test.d.ts

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

package/umd/typings/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts

@@ -1,4 +1,4 @@
-import { Promisable } from 'type-fest';
-export type AutomaticTranslator = {
-    translate(message: string): Promisable<string>;
-};
+import { Promisable } from 'type-fest';
+export type AutomaticTranslator = {
+    translate(message: string): Promisable<string>;
+};

package/umd/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts

@@ -1,9 +1,9 @@
-import { AutomaticTranslator } from './AutomaticTranslator';
-/**
- * This will wrap an automatic translator and log each translation into the console
- */
-export declare class DebugAutomaticTranslator implements AutomaticTranslator {
-    private readonly automaticTranslator;
-    constructor(automaticTranslator: AutomaticTranslator);
-    translate(message: string): Promise<string>;
-}
+import { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * This will wrap an automatic translator and log each translation into the console
+ */
+export declare class DebugAutomaticTranslator implements AutomaticTranslator {
+    private readonly automaticTranslator;
+    constructor(automaticTranslator: AutomaticTranslator);
+    translate(message: string): Promise<string>;
+}

package/umd/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

@@ -1,5 +1,5 @@
-import { AutomaticTranslator } from './AutomaticTranslator';
-export declare class FakeAutomaticTranslator implements AutomaticTranslator {
-    constructor();
-    translate(message: string): string;
-}
+import { AutomaticTranslator } from './AutomaticTranslator';
+export declare class FakeAutomaticTranslator implements AutomaticTranslator {
+    constructor();
+    translate(message: string): string;
+}

package/umd/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -1,11 +1,11 @@
-import { AutomaticTranslator } from './AutomaticTranslator';
-import { TranslatorOptions } from './TranslatorOptions';
-interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
-    apiUrl: URL;
-}
-export declare class LindatAutomaticTranslator implements AutomaticTranslator {
-    private readonly options;
-    constructor(options: LindatAutomaticTranslatorOptions);
-    translate(message: string): Promise<string>;
-}
-export {};
+import { AutomaticTranslator } from './AutomaticTranslator';
+import { TranslatorOptions } from './TranslatorOptions';
+interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
+    apiUrl: URL;
+}
+export declare class LindatAutomaticTranslator implements AutomaticTranslator {
+    private readonly options;
+    constructor(options: LindatAutomaticTranslatorOptions);
+    translate(message: string): Promise<string>;
+}
+export {};

package/umd/typings/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts

@@ -1,4 +1,4 @@
-export type TranslatorOptions = {
-    from: string;
-    to: string;
-};
+export type TranslatorOptions = {
+    from: string;
+    to: string;
+};

package/umd/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -1 +1 @@
-export declare function extractMultiplicatedOccurrence(message: string): string;
+export declare function extractMultiplicatedOccurrence(message: string): string;

package/umd/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts

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

package/umd/typings/execution/translation/automatic-translate/translateMessages.d.ts

@@ -1,5 +1,5 @@
-import { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
-import { TranslatorOptions } from './automatic-translators/TranslatorOptions';
-export declare function translateMessages({ automaticTranslator, from, to, }: {
-    automaticTranslator: AutomaticTranslator;
-} & TranslatorOptions): Promise<void>;
+import { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
+import { TranslatorOptions } from './automatic-translators/TranslatorOptions';
+export declare function translateMessages({ automaticTranslator, from, to, }: {
+    automaticTranslator: AutomaticTranslator;
+} & TranslatorOptions): Promise<void>;

package/umd/typings/execution/utils/replaceParameters.d.ts

@@ -1,12 +1,12 @@
-import { Parameters } from '../../types/Parameters';
-import { string_template } from '../../types/typeAliases';
-/**
- * Replaces parameters in template with values from parameters object
- *
- * @param template the template with parameters in {curly} braces
- * @param parameters the object with parameters
- * @returns the template with replaced parameters
- *
- * @private within the createPromptbookExecutor
- */
-export declare function replaceParameters(template: string_template, parameters: Parameters): string;
+import { Parameters } from '../../types/Parameters';
+import { string_template } from '../../types/typeAliases';
+/**
+ * Replaces parameters in template with values from parameters object
+ *
+ * @param template the template with parameters in {curly} braces
+ * @param parameters the object with parameters
+ * @returns the template with replaced parameters
+ *
+ * @private within the createPromptbookExecutor
+ */
+export declare function replaceParameters(template: string_template, parameters: Parameters): string;

package/umd/typings/execution/utils/replaceParameters.test.d.ts

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

package/umd/typings/library/PromptbookLibrary.d.ts

@@ -1,25 +1,25 @@
-import { Promisable } from 'type-fest';
-import type { Prompt } from '../types/Prompt';
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { string_promptbook_url } from '../types/typeAliases';
-/**
- * Library of promptbooks that groups together promptbooks for an application.
- *
- * @see https://github.com/webgptorg/promptbook#promptbook-library
- */
-export type PromptbookLibrary = {
-    /**
-     * Gets all promptbooks in the library
-     */
-    listPromptbooks(): Promisable<Array<string_promptbook_url>>;
-    /**
-     * Gets promptbook by its URL
-     *
-     * Note: This is not a direct fetching from the URL, but a lookup in the library
-     */
-    getPromptbookByUrl(url: string_promptbook_url): Promisable<PromptbookJson>;
-    /**
-     * Checks whether given prompt was defined in any promptbook in the library
-     */
-    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
-};
+import { Promisable } from 'type-fest';
+import type { Prompt } from '../types/Prompt';
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { string_promptbook_url } from '../types/typeAliases';
+/**
+ * Library of promptbooks that groups together promptbooks for an application.
+ *
+ * @see https://github.com/webgptorg/promptbook#promptbook-library
+ */
+export type PromptbookLibrary = {
+    /**
+     * Gets all promptbooks in the library
+     */
+    listPromptbooks(): Promisable<Array<string_promptbook_url>>;
+    /**
+     * Gets promptbook by its URL
+     *
+     * Note: This is not a direct fetching from the URL, but a lookup in the library
+     */
+    getPromptbookByUrl(url: string_promptbook_url): Promisable<PromptbookJson>;
+    /**
+     * Checks whether given prompt was defined in any promptbook in the library
+     */
+    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
+};

package/umd/typings/library/SimplePromptbookLibrary.d.ts

@@ -1,35 +1,35 @@
-import type { Prompt } from '../types/Prompt';
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { string_promptbook_url } from '../types/typeAliases';
-import { PromptbookLibrary } from './PromptbookLibrary';
-/**
- * Library of promptbooks that groups together promptbooks for an application.
- * This implementation is a very thin wrapper around the Array / Map of promptbooks.
- *
- * @see https://github.com/webgptorg/promptbook#promptbook-library
- */
-export declare class SimplePromptbookLibrary implements PromptbookLibrary {
-    private library;
-    /**!!!
-     *
-     * @param promptbooks !!!
-     *
-     * Note: During the construction logic of all promptbooks are validated
-     * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
-     */
-    constructor(...promptbooks: Array<PromptbookJson>);
-    /**
-     * Gets all promptbooks in the library
-     */
-    listPromptbooks(): Array<string_promptbook_url>;
-    /**
-     * Gets promptbook by its URL
-     *
-     * Note: This is not a direct fetching from the URL, but a lookup in the library
-     */
-    getPromptbookByUrl(url: string_promptbook_url): PromptbookJson;
-    /**
-     * Checks whether given prompt was defined in any promptbook in the library
-     */
-    isResponsibleForPrompt(prompt: Prompt): boolean;
-}
+import type { Prompt } from '../types/Prompt';
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { string_promptbook_url } from '../types/typeAliases';
+import { PromptbookLibrary } from './PromptbookLibrary';
+/**
+ * Library of promptbooks that groups together promptbooks for an application.
+ * This implementation is a very thin wrapper around the Array / Map of promptbooks.
+ *
+ * @see https://github.com/webgptorg/promptbook#promptbook-library
+ */
+export declare class SimplePromptbookLibrary implements PromptbookLibrary {
+    private library;
+    /**!!!
+     *
+     * @param promptbooks !!!
+     *
+     * Note: During the construction logic of all promptbooks are validated
+     * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
+     */
+    constructor(...promptbooks: Array<PromptbookJson>);
+    /**
+     * Gets all promptbooks in the library
+     */
+    listPromptbooks(): Array<string_promptbook_url>;
+    /**
+     * Gets promptbook by its URL
+     *
+     * Note: This is not a direct fetching from the URL, but a lookup in the library
+     */
+    getPromptbookByUrl(url: string_promptbook_url): PromptbookJson;
+    /**
+     * Checks whether given prompt was defined in any promptbook in the library
+     */
+    isResponsibleForPrompt(prompt: Prompt): boolean;
+}

package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -1,5 +1,5 @@
-import { PromptbookLibrary } from '../PromptbookLibrary';
-export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
-/***
- * TODO: !!! Annotate all + all to README and samples
- */
+import { PromptbookLibrary } from '../PromptbookLibrary';
+export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

package/umd/typings/library/constructors/createPromptbookLibraryFromList.d.ts

@@ -1,5 +1,5 @@
-import { PromptbookLibrary } from '../PromptbookLibrary';
-export declare function createPromptbookLibraryFromList(): PromptbookLibrary;
-/***
- * TODO: !!! Annotate all + all to README and samples
- */
+import { PromptbookLibrary } from '../PromptbookLibrary';
+export declare function createPromptbookLibraryFromList(): PromptbookLibrary;
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

package/umd/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts

@@ -1,7 +1,7 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import { PromptbookString } from '../../types/PromptbookString';
-import { PromptbookLibrary } from '../PromptbookLibrary';
-export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
-/***
- * TODO: !!! Annotate all + all to README and samples
- */
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import { PromptbookString } from '../../types/PromptbookString';
+import { PromptbookLibrary } from '../PromptbookLibrary';
+export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

package/umd/typings/library/constructors/createPromptbookLibraryFromSources.d.ts

@@ -1,16 +1,16 @@
-import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
-import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
-/**
- * Constructs Promptbook from any sources
- *
- * Note: During the construction syntax and logic of all sources are validated
- * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
- *
- * @param promptbookSources contents of .ptbk.md or .ptbk.json files
- * @param settings settings for creating executor functions
- * @returns PromptbookLibrary
- */
-/***
- * TODO: !!! Annotate all + all to README and samples
- */
+import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
+import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
+export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
+/**
+ * Constructs Promptbook from any sources
+ *
+ * Note: During the construction syntax and logic of all sources are validated
+ * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
+ *
+ * @param promptbookSources contents of .ptbk.md or .ptbk.json files
+ * @param settings settings for creating executor functions
+ * @returns PromptbookLibrary
+ */
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

package/umd/typings/library/constructors/createPromptbookSublibrary.d.ts

@@ -1,6 +1,6 @@
-import type { string_promptbook_url } from '../../types/typeAliases';
-import { PromptbookLibrary } from '../PromptbookLibrary';
-export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
-/***
- * TODO: !!! Annotate all + all to README and samples
- */
+import type { string_promptbook_url } from '../../types/typeAliases';
+import { PromptbookLibrary } from '../PromptbookLibrary';
+export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */