@promptbook/types 0.103.0-18 → 0.103.0-20

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

@@ -7,6 +7,7 @@ import type { AvatarProfileProps } from '../book-components/AvatarProfile/Avatar
 import { AvatarProfile } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import { AvatarProfileFromSource } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
+import { DEFAULT_BOOK_EDITOR_HEIGHT } from '../book-components/BookEditor/BookEditor';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import { BookEditor } from '../book-components/BookEditor/BookEditor';
 import { DEFAULT_BOOK_FONT_CLASS } from '../book-components/BookEditor/config';
@@ -61,6 +62,7 @@ export type { AvatarProfileProps };
 export { AvatarProfile };
 export type { AvatarProfileFromSourceProps };
 export { AvatarProfileFromSource };
+export { DEFAULT_BOOK_EDITOR_HEIGHT };
 export type { BookEditorProps };
 export { BookEditor };
 export { DEFAULT_BOOK_FONT_CLASS };

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

@@ -1,6 +1,8 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createAgentModelRequirements } from '../book-2.0/agent-source/createAgentModelRequirements';
 import { createAgentModelRequirementsWithCommitments } from '../book-2.0/agent-source/createAgentModelRequirementsWithCommitments';
+import { PADDING_LINES } from '../book-2.0/agent-source/padBook';
+import { padBook } from '../book-2.0/agent-source/padBook';
 import { parseAgentSource } from '../book-2.0/agent-source/parseAgentSource';
 import { parseParameters } from '../book-2.0/agent-source/parseParameters';
 import { isValidBook } from '../book-2.0/agent-source/string_book';
@@ -177,6 +179,8 @@ import { REMOTE_SERVER_URLS } from '../../servers';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createAgentModelRequirements };
 export { createAgentModelRequirementsWithCommitments };
+export { PADDING_LINES };
+export { padBook };
 export { parseAgentSource };
 export { parseParameters };
 export { isValidBook };

package/esm/typings/src/book-2.0/agent-source/padBook.d.ts

@@ -0,0 +1,16 @@
+import { string_book } from './string_book';
+/**
+ *  Number of padding lines to add at the end of the book content
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PADDING_LINES = 11;
+/**
+ * A function that adds padding to the book content
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function padBook(content: string_book): string_book;
+/**
+ * TODO: [🧠] Maybe export
+ */

package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts

@@ -1,7 +1,15 @@
 import type { CSSProperties } from 'react';
 import type { Promisable } from 'type-fest';
-import type { string_book } from '../../book-2.0/agent-source/string_book';
-import type { string_knowledge_source_content } from '../../types/typeAliases';
+import { type string_book } from '../../book-2.0/agent-source/string_book';
+import type { number_percent, number_positive, string_css_value, string_knowledge_source_content } from '../../types/typeAliases';
+/**
+ * Default height of the book editor
+ *
+ * Note: This height is computed based on the number of lines in the default book + padding multiplied by an estimated line height.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const DEFAULT_BOOK_EDITOR_HEIGHT: number;
 /**
  * Props of `BookEditor`
  *
@@ -20,6 +28,22 @@ export type BookEditorProps = {
      * Optional CSS style which will be added to root <div/> element
      */
     readonly style?: CSSProperties;
+    /**
+     * Height of the `BookEditor` component
+     *
+     * - You can use any valid CSS value, e.g., `500px`, `100%`, `50vh`, etc.
+     * - If not set, the default height is `DEFAULT_BOOK_EDITOR_HEIGHT`.
+     * - If set to `null`, the height should be controlled entirely via `className` or `style`, otherwise the editor will have zero height.
+     *
+     * @default `DEFAULT_BOOK_EDITOR_HEIGHT`
+     */
+    readonly height?: string_css_value | null;
+    /**
+     * Zoom level of the editor
+     *
+     * @default 1 (100%)
+     */
+    readonly zoom?: number_percent & number_positive;
     /**
      * The book which is being edited.
      */
@@ -40,11 +64,6 @@ export type BookEditorProps = {
      * If true, disables border radius making the editor have sharp corners
      */
     readonly isBorderRadiusDisabled?: boolean;
-    /**
-     * If true, shows the footer with book title and version information.
-     * By default, the footer is hidden.
-     */
-    readonly isFooterShown?: boolean;
     /**
      * If true, the editor is in read-only mode
      *

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

@@ -323,7 +323,7 @@ export type string_css_property = string;
  *
  * For example `13px`
  */
-export type string_css_value = string;
+export type string_css_value = string | number;
 /**
  * Semantic helper
  *

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-17`).
+ * It follows semantic versioning (e.g., `0.103.0-19`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.103.0-18",
+    "version": "0.103.0-20",
     "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-18"
+        "@promptbook/core": "0.103.0-20"
     }
 }

package/esm/typings/src/book-2.0/agent-source/padBookContent.d.ts

@@ -1,10 +0,0 @@
-import { string_book } from './string_book';
-/**
- * A function that adds padding to the book content
- *
- * @private utility function
- */
-export declare function padBookContent(content: string_book): string_book;
-/**
- * TODO: [🧠] Maybe export
- */