@promptbook/openai 0.75.6 → 0.75.10

package/README.md

@@ -267,7 +267,7 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
     <tr>
       <td>Core</td>
       <td>Promptbook Core is a description and documentation of the basic concepts, ideas and inner workings of how Promptbook should be implemented, and defines what features must be describable by book language.</td>
-      <td rowspan=2>https://ptbk.io<br/>https://github.com/webgptorg/book</td>
+      <td rowspan=2>https://github.com/webgptorg/book</td>
     </tr>
     <tr>
       <td>Book language</td>
@@ -278,7 +278,7 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
     <tr>
       <td>Promptbook typescript project</td>
       <td>Promptbook implementation in TypeScript released as multiple NPM packages</td>
-      <td>https://github.com/webgptorg/promptbook + Multiple packages on NPM</td>
+      <td>https://github.com/webgptorg/promptbook + <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">Multiple packages published on NPM</a></td>
     </tr>
     <tr>
       <td>Promptbook studio</td>
@@ -298,6 +298,12 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   </tbody>
 </table>
 
+Also we have a community of developers and users:
+
+-   [Discord](https://discord.gg/x3QWNaa89N)
+-   [Landing page](https://ptbk.io)
+-   [Github discussions](https://github.com/webgptorg/promptbook/discussions)
+
 
 
 ## 💙 Book language _(for prompt-engineer)_

package/esm/index.es.js

@@ -14,7 +14,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.75.5';
+var PROMPTBOOK_ENGINE_VERSION = '0.75.9';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/_packages/markdown-utils.index.d.ts

@@ -8,6 +8,7 @@ import type { string_markdown } from '../types/typeAliases';
 import type { string_markdown_section } from '../types/typeAliases';
 import type { string_markdown_section_content } from '../types/typeAliases';
 import type { string_markdown_text } from '../types/typeAliases';
+import type { string_markdown_codeblock_language } from '../types/typeAliases';
 import { addAutoGeneratedSection } from '../utils/markdown/addAutoGeneratedSection';
 import { createMarkdownChart } from '../utils/markdown/createMarkdownChart';
 import { createMarkdownTable } from '../utils/markdown/createMarkdownTable';
@@ -31,6 +32,7 @@ export type { string_markdown };
 export type { string_markdown_section };
 export type { string_markdown_section_content };
 export type { string_markdown_text };
+export type { string_markdown_codeblock_language };
 export { addAutoGeneratedSection };
 export { createMarkdownChart };
 export { createMarkdownTable };

package/esm/typings/src/_packages/types.index.d.ts

@@ -55,7 +55,6 @@ import type { AnthropicClaudeExecutionToolsOptions } from '../llm-providers/anth
 import type { AnthropicClaudeExecutionToolsDirectOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AnthropicClaudeExecutionToolsProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AzureOpenAiExecutionToolsOptions } from '../llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions';
-import type { LangtailExecutionToolsOptions } from '../llm-providers/langtail/LangtailExecutionToolsOptions';
 import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import type { PromptbookServer_Error } from '../llm-providers/remote/interfaces/PromptbookServer_Error';
@@ -151,6 +150,7 @@ import type { string_markdown } from '../types/typeAliases';
 import type { string_markdown_section } from '../types/typeAliases';
 import type { string_markdown_section_content } from '../types/typeAliases';
 import type { string_markdown_text } from '../types/typeAliases';
+import type { string_markdown_codeblock_language } from '../types/typeAliases';
 import type { string_promptbook_documentation_url } from '../types/typeAliases';
 import type { string_domain } from '../types/typeAliases';
 import type { string_tdl } from '../types/typeAliases';
@@ -309,7 +309,6 @@ export type { AnthropicClaudeExecutionToolsOptions };
 export type { AnthropicClaudeExecutionToolsDirectOptions };
 export type { AnthropicClaudeExecutionToolsProxiedOptions };
 export type { AzureOpenAiExecutionToolsOptions };
-export type { LangtailExecutionToolsOptions };
 export type { OpenAiAssistantExecutionToolsOptions };
 export type { OpenAiExecutionToolsOptions };
 export type { PromptbookServer_Error };
@@ -405,6 +404,7 @@ export type { string_markdown };
 export type { string_markdown_section };
 export type { string_markdown_section_content };
 export type { string_markdown_text };
+export type { string_markdown_codeblock_language };
 export type { string_promptbook_documentation_url };
 export type { string_domain };
 export type { string_tdl };

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -9,7 +9,7 @@ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorO
  *
  * @private internal type of `executePipeline`
  */
-type ExecutePipelineOptions = CreatePipelineExecutorOptions & {
+type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
     /**
      * @@@
      */

package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts

@@ -10,7 +10,7 @@ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorO
  *
  * @private internal type of `executeTask`
  */
-type executeSingleTaskOptions = CreatePipelineExecutorOptions & {
+type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
     /**
      * @@@
      */

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -11,7 +11,7 @@ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorO
  *
  * @private internal type of `executeAttempts`
  */
-export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeline'> & {
+export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions, 'pipeline'>> & {
     /**
      * @@@
      */

package/esm/typings/src/formfactors/index.d.ts

@@ -74,6 +74,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     };
 }, {
     readonly name: "SHEETS";
+    readonly aliasNames: readonly ["SHEETS", "SHEET"];
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {

package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts

@@ -5,6 +5,7 @@
  */
 export declare const SheetsFormfactorDefinition: {
     readonly name: "SHEETS";
+    readonly aliasNames: readonly ["SHEETS", "SHEET"];
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {

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

@@ -10,7 +10,7 @@ export type PrepareAndScrapeOptions = {
      * Note: When the pipeline is not created from files, it is `null`
      * Note: This folder must exist (=it is not created recursively)
      *
-     * @default process.cwd()
+     * @default null or `process.cwd()` when created via `$provide...` function in node
      */
     readonly rootDirname?: string_dirname | null;
     /**
@@ -18,7 +18,7 @@ export type PrepareAndScrapeOptions = {
      *
      * Note: When the folder does not exist, it is created recursively
      *
-     * @default SCRAPE_CACHE_DIRNAME
+     * @default DEFAULT_SCRAPE_CACHE_DIRNAME
      */
     readonly cacheDirname?: string_dirname;
     /**
@@ -30,17 +30,19 @@ export type PrepareAndScrapeOptions = {
     /**
      * Maximum number of tasks running in parallel
      *
-     * @default MAX_PARALLEL_COUNT
+     * @default DEFAULT_MAX_PARALLEL_COUNT
      */
     readonly maxParallelCount?: number;
     /**
      * If true, the missing software is automatically installed
+     *
+     * @default DEFAULT_IS_AUTO_INSTALLED
      */
     readonly isAutoInstalled?: boolean;
     /**
      * If true, the preparation logs additional information
      *
-     * @default false
+     * @default DEFAULT_IS_VERBOSE
      */
     readonly isVerbose?: boolean;
 };

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

@@ -208,6 +208,16 @@ export type string_markdown_section_content = string;
  * @public exported from `@promptbook/markdown-utils`
  */
 export type string_markdown_text = string;
+/**
+ * Semantic helper
+ *
+ * Markdown code block language
+ *
+ * For example ```js -> `"js"`
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export type string_markdown_codeblock_language = 'book' | 'markdown' | 'text' | 'javascript' | 'css' | 'json';
 /**
  * @@@
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.75.6",
+    "version": "0.75.10",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.75.6"
+        "@promptbook/core": "0.75.10"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.75.5';
+    var PROMPTBOOK_ENGINE_VERSION = '0.75.9';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/_packages/langtail.index.d.ts

@@ -1,6 +0,0 @@
-import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
-import { LangtailExecutionTools } from '../llm-providers/langtail/LangtailExecutionTools';
-import type { LangtailExecutionToolsOptions } from '../llm-providers/langtail/LangtailExecutionToolsOptions';
-export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
-export { LangtailExecutionTools };
-export type { LangtailExecutionToolsOptions };

package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts

@@ -1,17 +0,0 @@
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_markdown_text } from '../../types/typeAliases';
-import type { string_title } from '../../types/typeAliases';
-import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
-/**
- * Execution Tools for calling OpenAI API.
- *
- * @public exported from `@promptbook/langtail`
- */
-export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
-    get title(): string_title & string_markdown_text;
-    get description(): string_markdown;
-}
-/**
- * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
- */

package/esm/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts

@@ -1,13 +0,0 @@
-import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionToolsOptions';
-/**
- * Options for LangtailExecutionTools
- *
- * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
- * Rest is used by the `OpenAiExecutionTools`.
- *
- * @public exported from `@promptbook/langtail`
- */
-export type LangtailExecutionToolsOptions = OpenAiExecutionToolsOptions;
-/**
- * TODO: !! Use or remove
- */

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

@@ -1,5 +0,0 @@
-#!/usr/bin/env ts-node
-export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */