@promptbook/openai 0.40.0-3 → 0.40.0-5

package/esm/typings/_packages/core.index.d.ts

@@ -6,9 +6,13 @@ import { CallbackInterfaceTools } from '../execution/plugins/user-interface-exec
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
+import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
+import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
+import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
 import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
-export { ExecutionTypes, PROMPTBOOK_VERSION, SimplePromptbookLibrary };
+export { ExecutionTypes, PROMPTBOOK_VERSION };
+export { SimplePromptbookLibrary, createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookStringToJson, validatePromptbookJson };
 export { MockedEchoNaturalExecutionTools };

package/esm/typings/errors/PromptbookReferenceError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error indicates errors in referencing promptbooks between each other
+ */
+export declare class PromptbookReferenceError extends Error {
+    readonly name = "PromptbookReferenceError";
+    constructor(message: string);
+}

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

@@ -21,5 +21,5 @@ export type PromptbookLibrary = {
     /**
      * Checks whether given prompt was defined in any promptbook in the library
      */
-    isResponsibleForPrompt(prompt: Prompt): boolean;
+    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
 };

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

@@ -1,28 +1,23 @@
 import type { Prompt } from '../types/Prompt';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
 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 / Set of promptbooks.
+ * 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 readonly library;
-    /**
-     * Constructs Promptbook from any sources
+    private library;
+    /**!!!
      *
-     * 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 promptbooks !!!
      *
-     * @param promptbookSources contents of .ptbk.md or .ptbk.json files
-     * @param settings settings for creating executor functions
-     * @returns PromptbookLibrary
+     * 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
      */
-    static fromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
-    private constructor();
+    constructor(...promptbooks: Array<PromptbookJson>);
     /**
      * Gets all promptbooks in the library
      */

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

@@ -0,0 +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
+ */

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

@@ -0,0 +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
+ */

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

@@ -0,0 +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
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.40.0-3",
+    "version": "0.40.0-5",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -37,7 +37,7 @@
         "openai": "4.2.0"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.40.0-3"
+        "@promptbook/core": "0.40.0-5"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/_packages/core.index.d.ts

@@ -6,9 +6,13 @@ import { CallbackInterfaceTools } from '../execution/plugins/user-interface-exec
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
+import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
+import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
+import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
 import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
-export { ExecutionTypes, PROMPTBOOK_VERSION, SimplePromptbookLibrary };
+export { ExecutionTypes, PROMPTBOOK_VERSION };
+export { SimplePromptbookLibrary, createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookStringToJson, validatePromptbookJson };
 export { MockedEchoNaturalExecutionTools };

package/umd/typings/errors/PromptbookReferenceError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error indicates errors in referencing promptbooks between each other
+ */
+export declare class PromptbookReferenceError extends Error {
+    readonly name = "PromptbookReferenceError";
+    constructor(message: string);
+}

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

@@ -21,5 +21,5 @@ export type PromptbookLibrary = {
     /**
      * Checks whether given prompt was defined in any promptbook in the library
      */
-    isResponsibleForPrompt(prompt: Prompt): boolean;
+    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
 };

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

@@ -1,28 +1,23 @@
 import type { Prompt } from '../types/Prompt';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
 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 / Set of promptbooks.
+ * 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 readonly library;
-    /**
-     * Constructs Promptbook from any sources
+    private library;
+    /**!!!
      *
-     * 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 promptbooks !!!
      *
-     * @param promptbookSources contents of .ptbk.md or .ptbk.json files
-     * @param settings settings for creating executor functions
-     * @returns PromptbookLibrary
+     * 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
      */
-    static fromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
-    private constructor();
+    constructor(...promptbooks: Array<PromptbookJson>);
     /**
      * Gets all promptbooks in the library
      */

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

@@ -0,0 +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
+ */

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

@@ -0,0 +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
+ */

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

@@ -0,0 +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
+ */