@promptbook/browser 0.68.3 → 0.68.5

package/README.md

@@ -42,6 +42,10 @@ Core of the library for Browser runtime, it contains the main logic for promptbo
 
 Rest of the documentation is common for **entire promptbook ecosystem**:
 
+# ✨ New Features
+
+-   ✨ **Support [OpenAI o1 model](https://openai.com/o1/)**
+
 ## 🤍 The Promptbook Whitepaper
 
 

package/esm/index.es.js

@@ -5,8 +5,8 @@ import { isRunningInBrowser } from 'openai/core';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.68.2';
-// TODO: !!!! List here all the versions and annotate + put into script
+var PROMPTBOOK_VERSION = '0.68.4';
+// TODO:[main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -344,7 +344,7 @@ function checkSerializableAsJson(name, value) {
 }
 /**
  * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */
 
@@ -429,7 +429,7 @@ function isSerializableAsJson(value) {
     }
 }
 /**
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */
 

package/esm/typings/promptbook-collection/index.d.ts

@@ -1,7 +1,6 @@
 declare const _default: ({
     title: string;
     pipelineUrl: string;
-    promptbookVersion: string;
     parameters: {
         name: string;
         description: string;
@@ -24,7 +23,6 @@ declare const _default: ({
 } | {
     title: string;
     pipelineUrl: string;
-    promptbookVersion: string;
     parameters: {
         name: string;
         description: string;
@@ -53,7 +51,6 @@ declare const _default: ({
 } | {
     title: string;
     pipelineUrl: string;
-    promptbookVersion: string;
     parameters: {
         name: string;
         description: string;

package/esm/typings/src/cli/cli-commands/make.d.ts

@@ -6,7 +6,7 @@ import type { Command as Program } from 'commander';
  */
 export declare function initializeMakeCommand(program: Program): void;
 /**
- * TODO: [🥃] !!! Allow `ptbk make` without configuring any llm tools
+ * TODO: [🥃][main] !!! Allow `ptbk make` without configuring any llm tools
  * TODO: Maybe remove this command - "about" command should be enough?
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
  * Note: [🟡] This code should never be published outside of `@promptbook/cli`

package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts

@@ -25,5 +25,5 @@ type CreatePipelineCollectionFromUrlyOptions = {
 export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
 export {};
 /**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ * TODO:[main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
  */

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

@@ -68,14 +68,14 @@ export declare const MAX_EXECUTION_ATTEMPTS = 3;
 export declare const MAX_FILENAME_LENGTH = 30;
 /**
  * @@@
- * TODO: [🐝] !!! Use
+ * TODO: [🐝][main] !!! Use
  *
  * @public exported from `@promptbook/core`
  */
 export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
 /**
  * @@@
- * TODO: [🐝] !!! Use
+ * TODO: [🐝][main] !!! Use
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -18,7 +18,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
 /**
- * TODO: !!!! Warn if used only sync version
+ * TODO:[main] !!!! Warn if used only sync version
  * TODO: [🚞] Report here line/column of error
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -27,11 +27,11 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🐣] !!!! Validate that all samples match expectations
- * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
- * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
- * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
- * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🐣][main] !!!! Validate that all samples match expectations
+ * TODO: [🐣][🐝][main] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🐣][main] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🐣][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🐣][main] !!!! Validate that reserved parameter is not used as joker
  * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/execution/createPipelineExecutor.d.ts

@@ -58,7 +58,7 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
- * TODO: !!! Identify not only pipeline BUT exact template ${block(pipelineIdentification)}
+ * TODO:[main] !!! Identify not only pipeline BUT exact template ${block(pipelineIdentification)}
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
  * TODO: [🧠][🌳] Use here `countTotalUsage` and put preparation and prepared pipiline to report
  * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -8,7 +8,7 @@ import type { string_markdown } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromMarkdown(knowledgeContent: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
- * TODO: [🐝][🔼] !!! Export via `@promptbook/markdown`
+ * TODO: [🐝][🔼][main] !!! Export via `@promptbook/markdown`
  * TODO: [🪂] Do it in parallel 11:11
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
  */

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -8,7 +8,7 @@ import type { string_base64 } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
- * TODO: [🐝][🔼] !!! Export via `@promptbook/pdf`
+ * TODO: [🐝][🔼][main] !!! Export via `@promptbook/pdf`
  * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
  *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
  * TODO: [🪂] Do it in parallel

package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts

@@ -13,7 +13,7 @@ export type CacheItem = {
     /**
      * @@@
      */
-    promptbookVersion: string_promptbook_version;
+    promptbookVersion?: string_promptbook_version;
     /**
      * @@@
      */

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -1,3 +1,4 @@
+import Anthropic from '@anthropic-ai/sdk';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
@@ -26,7 +27,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     constructor(options?: AnthropicClaudeExecutionToolsDirectOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
-    private getClient;
+    getClient(): Promise<Anthropic>;
     /**
      * Check the `options` passed to `constructor`
      */

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -16,7 +16,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
 }>;
 /**
  * Note: [🤖] Add models of new variant
- * TODO: [🧠] !!! Add embedding models OR Anthropic has only chat+completion models?
+ * TODO: [🧠][main] !!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🎰] Some mechanism to auto-update available models

package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts

@@ -11,8 +11,8 @@ export declare const createAnthropicClaudeExecutionTools: ((options: AnthropicCl
     className: string;
 };
 /**
- * TODO: [🧠] !!!! Make anonymous this with all LLM providers
- * TODO: [🧠][🧱] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
+ * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
+ * TODO: [🧠][🧱][main] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
  * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
  * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: !!! Playground with WebGPT / Promptbook.studio anonymous server
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO:[main] !!! Playground with WebGPT / Promptbook.studio anonymous server
+ * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
  */

package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -1,3 +1,4 @@
+import { OpenAIClient } from '@azure/openai';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
@@ -26,7 +27,7 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     constructor(options: AzureOpenAiExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
-    private getClient;
+    getClient(): Promise<OpenAIClient>;
     /**
      * Check the `options` passed to `constructor`
      */

package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -1,3 +1,4 @@
+import OpenAI from 'openai';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
@@ -27,7 +28,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     constructor(options?: OpenAiExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
-    private getClient;
+    getClient(): Promise<OpenAI>;
     /**
      * Check the `options` passed to `constructor`
      */

package/esm/typings/src/llm-providers/openai/playground/playground.d.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
  */

package/esm/typings/src/personas/preparePersona.d.ts

@@ -9,7 +9,7 @@ import type { string_persona_description } from '../types/typeAliases';
  */
 export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
 /**
- * TODO: [🔃] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
  * TODO: [🏢] !! Check validity of `modelName` in pipeline
  * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
  * TODO: [🏢] !! Check validity of `temperature` in pipeline

package/esm/typings/src/prepare/isPipelinePrepared.d.ts

@@ -6,7 +6,7 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
  */
 export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
 /**
- * TODO: [🔃] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`

package/esm/typings/src/prepare/prepareTemplates.d.ts

@@ -23,7 +23,7 @@ export {};
 /**
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: [♨] !!! Prepare index the samples and maybe templates
+ * TODO: [♨][main] !!! Prepare index the samples and maybe templates
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time

package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -42,7 +42,7 @@ export type PipelineJson = {
     /**
      * Version of the .ptbk.json file
      */
-    readonly promptbookVersion: string_semantic_version;
+    readonly promptbookVersion?: string_semantic_version;
     /**
      * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure

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

@@ -592,7 +592,7 @@ export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
 /**.
- * TODO: !!! Change "For example" to @example
+ * TODO:[main] !!! Change "For example" to @example
  * TODO: !! Change to branded types
  * TODO: Delete type aliases that are not exported or used internally
  */

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

@@ -22,6 +22,6 @@ import type { string_name } from '../../types/typeAliases';
 export declare function checkSerializableAsJson(name: string_name, value: unknown): void;
 /**
  * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */

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

@@ -19,6 +19,6 @@
  */
 export declare function isSerializableAsJson(value: unknown): boolean;
 /**
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/browser",
-    "version": "0.68.3",
+    "version": "0.68.5",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/browser.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.68.3"
+        "@promptbook/core": "0.68.5"
     },
     "dependencies": {
         "spacetrim": "0.11.39"

package/umd/index.umd.js

@@ -12,8 +12,8 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.68.2';
-    // TODO: !!!! List here all the versions and annotate + put into script
+    var PROMPTBOOK_VERSION = '0.68.4';
+    // TODO:[main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -351,7 +351,7 @@
     }
     /**
      * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
-     * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+     * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
      * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
      */
 
@@ -436,7 +436,7 @@
         }
     }
     /**
-     * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+     * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
      * TODO: [🧠][💺] Can be done this on type-level?
      */
 

package/esm/typings/src/personas/preparePersona.test.d.ts

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