@promptbook/markdown-utils 0.74.0-8 → 0.75.0-1

package/esm/typings/src/pipeline/pipeline-interface/PipelineInterface.d.ts

@@ -0,0 +1,22 @@
+import type { string_parameter_name } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+export type PipelineInterface = {
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly inputParameterNames: ReadonlyArray<string_parameter_name>;
+    /**
+     * @@@
+     *
+     * Note: Sorted alphabetically
+     */
+    readonly outputParameterNames: ReadonlyArray<string_parameter_name>;
+};
+/**
+ * TODO: !!!!!! Change inputParameterNames to inputParameters<InputParameter>
+ * TODO: [🧠] Better name than `PipelineInterface` to avoid confusion with typescript `interface`
+ */

package/esm/typings/src/pipeline/pipeline-interface/constants.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const GENERIC_PIPELINE_INTERFACE: {
+    readonly inputParameterNames: readonly [];
+    readonly outputParameterNames: readonly [];
+};

package/esm/typings/src/pipeline/pipeline-interface/getPipelineInterface.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getPipelineInterface(pipeline: PipelineJson): PipelineInterface;
+/**
+ * TODO: !!!!!! Write unit test
+ */

package/esm/typings/src/pipeline/pipeline-interface/isPipelineImplementingInterface.d.ts

@@ -0,0 +1,25 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ */
+export type IsPipelineImplementingInterfaceOptions = {
+    /**
+     * @@@
+     */
+    pipeline: PipelineJson;
+    /**
+     * @@@
+     */
+    pipelineInterface: PipelineInterface;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPipelineImplementingInterface(options: IsPipelineImplementingInterfaceOptions): boolean;
+/**
+ * TODO: !!!!!! Test real implementing NOT equality
+ * TODO: !!!!!! Write unit test
+ */

package/esm/typings/src/pipeline/pipeline-interface/isPipelineInterfacesEqual.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineInterface } from './PipelineInterface';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPipelineInterfacesEqual(pipelineInterface1: PipelineInterface, pipelineInterface2: PipelineInterface): boolean;
+/**
+ * TODO: [🧠] !!! Return more states than true/false - 'IDENTICAL' |'IDENTICAL_UNPREPARED' | 'IDENTICAL_INTERFACE' | 'DIFFERENT'
+ * TODO: !!! Write unit test
+ */

package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts

@@ -0,0 +1,33 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Behaves like a storage but forgets everything you put in it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class BlackholeStorage<TItem> implements PromptbookStorage<TItem> {
+    /**
+     * Returns the number of key/value pairs currently present in the list associated with the object.
+     */
+    get length(): number;
+    /**
+     * Empties the list associated with the object of all key/value pairs, if there are any.
+     */
+    clear(): void;
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     * @param key
+     */
+    getItem(key: string): null;
+    /**
+     * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
+     */
+    key(index: number): null;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): void;
+    /**
+     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     */
+    removeItem(key: string): void;
+}

package/esm/typings/src/storage/memory/MemoryStorage.d.ts

@@ -1,6 +1,6 @@
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
 /**
- * Stores
+ * Stores data in memory (HEAP)
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/storage/{memory/utils → utils}/PrefixStorage.d.ts

@@ -1,5 +1,5 @@
 import type { Promisable } from 'type-fest';
-import type { PromptbookStorage } from '../../_common/PromptbookStorage';
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
 /**
  * This class behaves like LocalStorage but separates keys by prefix
  *

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

@@ -1,3 +1,4 @@
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
 import type { ModelRequirements } from '../ModelRequirements';
 import type { string_filename } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
@@ -26,12 +27,12 @@ export type PipelineJson = {
      * Note: It must be unique across all pipeline collections
      * Note: It must use HTTPs URL
      * Tip: You can do versioning in the URL
-     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md@1.0.0
+     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.book.md@1.0.0
      * Warning: Do not hash part of the URL, hash part is used for identification of the template in the pipeline
      */
     readonly pipelineUrl?: string_pipeline_url;
     /**
-     * Internal helper for tracking the source `.ptbk.md` file of the pipeline
+     * Internal helper for tracking the source `.book.md` file of the pipeline
      */
     readonly sourceFile?: string_filename;
     /**
@@ -40,14 +41,20 @@ export type PipelineJson = {
      */
     readonly title: string_markdown_text;
     /**
-     * Version of the .ptbk.json file
+     * Version of the Book language
+     *
+     * @see https://github.com/webgptorg/book
      */
-    readonly promptbookVersion?: string_semantic_version;
+    readonly bookVersion?: 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
      */
     readonly description?: string_markdown_text;
+    /**
+     * Name of the formfactor that the pipeline is shaped for
+     */
+    readonly formfactorName: string_formfactor_name;
     /**
      * Set of variables that are used across the pipeline
      */

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

@@ -18,5 +18,5 @@ export type PreparationJson = {
 /**
  * TODO: [🍙] Make some standard order of json properties
  * TODO: Maybe put here used `modelName`
- * TODO: [🍥] When using `date` it changes all examples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
+ * TODO: [🍥] When using `date` it changes all examples .book.json files each time so until some more elegant solution omit the time from prepared pipeline
  */

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

@@ -95,7 +95,7 @@ export type CommonPrompt = {
     /**
      * Unique identifier of the pipeline with specific template name as hash
      *
-     * @example https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
      */
     readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
     /**

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

@@ -298,13 +298,13 @@ export type string_base_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md"`
  */
 export type string_pipeline_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords"`
  */
 export type string_pipeline_url_with_hashtemplate = string;
 /**

package/esm/typings/src/utils/expectation-counters/constants.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Number of characters per standard line with 11pt Arial font size.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const CHARACTERS_PER_STANDARD_LINE = 63;
+/**
+ * Number of lines per standard A4 page with 11pt Arial font size and standard margins and spacing.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const LINES_PER_STANDARD_PAGE = 44;
+/**
+ * TODO: [🧠] Should be this `constants.ts` or `config.ts`?
+ */

package/esm/typings/src/utils/expectation-counters/countLines.d.ts

@@ -2,6 +2,8 @@ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of lines in the text
  *
+ * Note: This does not check only for the presence of newlines, but also for the length of the standard line.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function countLines(text: string): ExpectationAmount;

package/esm/typings/src/utils/expectation-counters/countPages.d.ts

@@ -2,6 +2,8 @@ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of pages in the text
  *
+ * Note: This does not check only for the count of newlines, but also for the length of the standard line and length of the standard page.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function countPages(text: string): ExpectationAmount;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.74.0-8",
+    "version": "0.75.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,