@promptbook/types 0.103.0-42 → 0.103.0-44

package/esm/typings/src/utils/random/$generateBookBoilerplate.d.ts

@@ -0,0 +1,25 @@
+import type { PartialDeep } from 'type-fest';
+import type { AgentBasicInformation } from '../../book-2.0/agent-source/AgentBasicInformation';
+import { string_book } from '../../book-2.0/agent-source/string_book';
+import { string_agent_name_in_book } from '../../types/typeAliases';
+type GenerateBookBoilerplateOptions = PartialDeep<Omit<AgentBasicInformation, 'parameters'>> & {
+    /**
+     * Name of the parent agent to inherit from
+     *
+     * @default 'Adam'
+     */
+    parentAgentName?: string_agent_name_in_book;
+};
+/**
+ * Generates boilerplate for a new agent book
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
+ * Note: This function is using cryptographically secure components internally
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function $generateBookBoilerplate(options?: GenerateBookBoilerplateOptions): string_book;
+export {};
+/**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
+ */

package/esm/typings/src/utils/random/$randomAgentPersona.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @@@@
+ *
+ * @private internal helper function
+ */
+export declare function $randomAgentPersona(): string;
+/**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
+ */

package/esm/typings/src/utils/random/$randomFullnameWithColor.d.ts

@@ -0,0 +1,13 @@
+import { string_color, string_person_fullname } from '../../types/typeAliases';
+export type RandomFullnameWithColorResult = {
+    fullname: string_person_fullname;
+    color: string_color;
+};
+/**
+ *
+ * @private internal helper function
+ */
+export declare function $randomFullnameWithColor(): RandomFullnameWithColorResult;
+/**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
+ */

package/esm/typings/src/utils/random/$randomItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Pick random item from the received array
+ *
+ * @private internal helper function
+ */
+export declare function $randomItem<TItem>(...items: Array<TItem>): TItem;
+/**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
+ */ 

package/esm/typings/src/utils/random/$randomSeed.d.ts

@@ -8,3 +8,6 @@ import type { number_seed } from '../../types/typeAliases';
  * @private internal helper function
  */
 export declare function $randomSeed(): number_seed;
+/**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
+ */ 

package/esm/typings/src/utils/random/$randomToken.d.ts

@@ -2,6 +2,7 @@ import type { string_token } from '../../types/typeAliases';
 /**
  * Generates random token
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
  * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
  *
  * @private internal helper function
@@ -9,5 +10,6 @@ import type { string_token } from '../../types/typeAliases';
  */
 export declare function $randomToken(randomness: number): string_token;
 /**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
  * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
  */

package/esm/typings/src/utils/serialization/$deepFreeze.d.ts

@@ -1,5 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
-import { $side_effect } from '../organization/$side_effect';
+import type { $side_effect } from '../organization/$side_effect';
 /**
  * Freezes the given object and all its nested objects recursively
  *

package/esm/typings/src/utils/serialization/serializeToPromptbookJavascript.d.ts

@@ -1,5 +1,5 @@
-import { string_javascript } from '../../types/typeAliases';
-import { TODO_any } from '../organization/TODO_any';
+import type { string_javascript } from '../../types/typeAliases';
+import type { TODO_any } from '../organization/TODO_any';
 type SerializeToPromptbookJavascriptReturn = {
     /**
      * Array of import statements required for the `value` to work

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.103.0-41`).
+ * It follows semantic versioning (e.g., `0.103.0-43`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.103.0-42",
+    "version": "0.103.0-44",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -92,6 +92,6 @@
     },
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-42"
+        "@promptbook/core": "0.103.0-44"
     }
 }

package/esm/typings/src/collection/agent-collection/constructors/AgentCollectionInDirectory.d.ts

@@ -1,89 +0,0 @@
-import { Agent } from '../../../_packages/core.index';
-import { CommonToolsOptions, string_book } from '../../../_packages/types.index';
-import type { ExecutionTools } from '../../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
-import type { string_agent_name, string_dirname } from '../../../types/typeAliases';
-import type { AgentCollection } from '../AgentCollection';
-/**
- * Options for `createAgentCollectionFromDirectory` function
- *
- * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
- *       This is not same as `path` which is the first argument of `createAgentCollectionFromDirectory` - it can be a subfolder
- */
-type CreateAgentCollectionInDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & CommonToolsOptions & {
-    /**
-     * If true, the directory is searched recursively for pipelines
-     *
-     * @default true
-     */
-    isRecursive?: boolean;
-    /**
-     * If true, directory will be scanned only when needed not during the construction
-     *
-     * @default false
-     */
-    isLazyLoaded?: boolean;
-    /**
-     * If true, whole collection creation crashes on error in any pipeline
-     * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
-     *
-     * @default true
-     */
-    isCrashedOnError?: boolean;
-};
-/**
- * Agent collection stored in directory
- *
- * Note: Works only in Node.js environment because it reads the file system
- *
- * @public exported from `@promptbook/node`
- */
-export declare class AgentCollectionInDirectory implements AgentCollection {
-    readonly rootPath: string_dirname;
-    private readonly tools?;
-    readonly options?: CreateAgentCollectionInDirectoryOptions | undefined;
-    /**
-     * @param rootPath - path to the directory with agents
-     * @param tools - Execution tools to be used in `Agent` itself and listing the agents
-     * @param options - Options for the collection creation
-     */
-    constructor(rootPath: string_dirname, tools?: Pick<ExecutionTools, "llm" | "fs" | "scrapers"> | undefined, options?: CreateAgentCollectionInDirectoryOptions | undefined);
-    /**
-     * Cached defined execution tools
-     */
-    private _definedTools;
-    /**
-     * Gets or creates execution tools for the collection
-     */
-    private getTools;
-    /**
-     * Gets all agents in the collection
-     */
-    listAgents(): Promise<ReadonlyArray<string_agent_name>>;
-    /**
-     * Get one agent by its name
-     *
-     * Note: Agents are existing independently of you getting them or not, you can get the same agent multiple times.
-     * Note: Agents are changed by interacting with `Agent` objects directly. Only creation and deletion is done via the collection.
-     */
-    getAgentByName(agentName: string_agent_name): Promise<Agent>;
-    /**
-     * Deletes an agent from the collection
-     *
-     * Note: When you want delete an agent by name, first get the agent using `getAgentByName` and then pass it to `deleteAgent`.
-     */
-    deleteAgent(agent: Agent): Promise<void>;
-    /**
-     * Creates a new agent in the collection
-     *
-     * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
-     */
-    createAgent(agentSource: string_book): Promise<Agent>;
-}
-export {};
-/**
- * TODO: [🧠][🚙] `AgentXxx` vs `AgentsXxx` naming convention
- * TODO: [🖇] What about symlinks? Maybe option `isSymlinksFollowed`
- * TODO: [🧠] Maybe add option `isImmutable`
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */

package/esm/typings/src/collection/agent-collection/constructors/AgentCollectionInDirectory.test.d.ts

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

package/esm/typings/src/commands/_common/parseCommand.test.d.ts

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

package/esm/typings/src/execution/utils/logLlmCall.d.ts

@@ -1,8 +0,0 @@
-import type { LlmCall } from '../../types/LlmCall';
-import type { ExecutionPromptReportJson } from '../execution-report/ExecutionPromptReportJson';
-/**
- * Logs an LLM call with the given report.
- *
- * @private internal utility of `createPipelineExecutor`
- */
-export declare function logLlmCall(logLlmCall: (llmCall: LlmCall) => void, report: ExecutionPromptReportJson): void;