@promptbook/types 0.75.0-4 → 0.75.2

package/README.md

@@ -2,8 +2,6 @@
 
 # ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
 
-It's time for a paradigm shift! The future of software is in plain English, French or Latin.
-
 
 
 
@@ -25,10 +23,6 @@ It's time for a paradigm shift! The future of software is in plain English, Fren
 
 
 
-<blockquote style="color: #ff8811">
-    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
-</blockquote>
-
 ## 📦 Package `@promptbook/types`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -81,7 +75,7 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 ## 🤍 The Book Abstract
 
-> It's time for a paradigm shift! **The future of software is in plain English**, French or Latin.
+**It's time for a paradigm shift! The future of software is in plain English, French or Latin.**
 
 During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
 
@@ -91,11 +85,17 @@ The incredible growth in power of microprocessors and the Moore's Law have been
 
 This shift is going to happen, whether we are ready for it or not. Our mission is to make it excellently, not just good.
 
-> **Join us in this journey!**
+**Join us in this journey!**
+
 
 
+## 🚀 Get started
 
+Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
 
+-   [Hello Book](https://github.com/webgptorg/hello-world)
+-   [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
+-   [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
 
 
 
@@ -115,7 +115,7 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   <tbody>
     <tr>
       <td>Core</td>
-      <td>Promptbook core is a description and documentation of basic innerworkings how should be Promptbook implemented and defines which fetures must be descriable by book language</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>
     </tr>
     <tr>
@@ -126,17 +126,23 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
     </tr>
     <tr>
       <td>Promptbook typescript project</td>
-      <td>Implementation of Promptbook in TypeScript published into multiple packages to NPM</td>
+      <td>Promptbook implementation in TypeScript released as multiple NPM packages</td>
       <td>https://github.com/webgptorg/promptbook + Multiple packages on NPM</td>
     </tr>
     <tr>
       <td>Promptbook studio</td>
-      <td>No-code studio to write book without need to write even the markdown</td>
-      <td rowspan=2>https://promptbook.studio<br/>https://github.com/hejny/promptbook-studio</td>
-    </tr>
-    <tr>
-      <td>Promptbook miniapps</td>
-      <td>Builder of LLM miniapps from book notation</td>
+      <td>Studio to write Books and instantly publish them as miniapps</td>
+      <td>
+        https://promptbook.studio<br/>
+        https://github.com/hejny/promptbook-studio</td>
+      </tr><tr>
+      <td>Hello World</td>
+      <td>Simple starter kit with Books integrated into the sample applications</td>
+       <td>
+          https://github.com/webgptorg/hello-world<br/>
+          https://github.com/webgptorg/hello-world-node-js<br/>
+          https://github.com/webgptorg/hello-world-next-js
+       </td>
     </tr>
   </tbody>
 </table>

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

@@ -4,7 +4,10 @@ import { createCollectionFromJson } from '../collection/constructors/createColle
 import { createCollectionFromPromise } from '../collection/constructors/createCollectionFromPromise';
 import { createCollectionFromUrl } from '../collection/constructors/createCollectionFromUrl';
 import { createSubcollection } from '../collection/constructors/createSubcollection';
+import { NAME } from '../config';
 import { CLAIM } from '../config';
+import { LOGO_LIGHT_SRC } from '../config';
+import { LOGO_DARK_SRC } from '../config';
 import { DEFAULT_TITLE } from '../config';
 import { MAX_FILENAME_LENGTH } from '../config';
 import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
@@ -113,7 +116,10 @@ export { createCollectionFromJson };
 export { createCollectionFromPromise };
 export { createCollectionFromUrl };
 export { createSubcollection };
+export { NAME };
 export { CLAIM };
+export { LOGO_LIGHT_SRC };
+export { LOGO_DARK_SRC };
 export { DEFAULT_TITLE };
 export { MAX_FILENAME_LENGTH };
 export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };

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

@@ -44,6 +44,7 @@ import { parseKeywords } from '../utils/normalization/parseKeywords';
 import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
 import { removeDiacritics } from '../utils/normalization/removeDiacritics';
 import { searchKeywords } from '../utils/normalization/searchKeywords';
+import { spaceTrim } from '../utils/organization/spaceTrim';
 import { extractParameterNames } from '../utils/parameters/extractParameterNames';
 import { replaceParameters } from '../utils/parameters/replaceParameters';
 import { parseNumber } from '../utils/parseNumber';
@@ -117,6 +118,7 @@ export { parseKeywords };
 export { parseKeywordsFromString };
 export { removeDiacritics };
 export { searchKeywords };
+export { spaceTrim };
 export { extractParameterNames };
 export { replaceParameters };
 export { parseNumber };

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

@@ -1,11 +1,20 @@
 import type { CsvSettings } from './formats/csv/CsvSettings';
 import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
+import type { string_url_image } from './types/typeAliases';
 /**
  * Warning message for the generated sections and files files
  *
  * @private within the repository
  */
 export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has been generated so that any manual changes will be overwritten";
+/**
+ * Name for the Promptbook
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const NAME = "Promptbook";
 /**
  * Claim for the Promptbook
  *
@@ -14,6 +23,22 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
  * @public exported from `@promptbook/core`
  */
 export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
+/**
+ * Logo for the light theme
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const LOGO_LIGHT_SRC: string_url_image;
+/**
+ * Logo for the dark theme
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const LOGO_DARK_SRC: string_url_image;
 /**
  * When the title is not provided, the default title is used
  *

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

@@ -20,7 +20,3 @@ export type PipelineInterface = {
      */
     readonly outputParameters: ReadonlyArray<OutputParameterJson>;
 };
-/**
- * TODO: [🧠][🤓] How to pass optional parameters - for example summary in FORMFACTOR Translator
- * TODO: [🧠] Better name than `PipelineInterface` to avoid confusion with typescript `interface`
- */

package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts

@@ -3,11 +3,9 @@ import type { PipelineInterface } from './PipelineInterface';
 /**
  * @@@
  *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
  * @see https://github.com/webgptorg/promptbook/discussions/171
  *
  * @public exported from `@promptbook/core`
  */
 export declare function getPipelineInterface(pipeline: PipelineJson): PipelineInterface;
-/**
- * TODO: !!!!!! Write unit test
- */

package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts

@@ -18,12 +18,9 @@ export type IsPipelineImplementingInterfaceOptions = {
 /**
  * @@@
  *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
  * @see https://github.com/webgptorg/promptbook/discussions/171
  *
  * @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/PipelineInterface/isPipelineInterfacesEqual.d.ts

@@ -2,12 +2,9 @@ import type { PipelineInterface } from './PipelineInterface';
 /**
  * @@@
  *
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
  * @see https://github.com/webgptorg/promptbook/discussions/171
  *
  * @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/utils/organization/spaceTrim.d.ts

@@ -0,0 +1,11 @@
+import { spaceTrim as spaceTrimReexported } from 'spacetrim';
+/**
+ * Trims string from all 4 sides
+ *
+ * Note: This is a re-exported function from the `spacetrim` package which is
+ *       Developed by same author @hejny as this package
+ *
+ * @public exported from `@promptbook/utils`
+ * @see https://github.com/hejny/spacetrim#usage
+ */
+export declare const spaceTrim: typeof spaceTrimReexported;

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

@@ -15,4 +15,4 @@ export type string_promptbook_version = string_semantic_version;
 /**
  * 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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.75.0-4",
+    "version": "0.75.2",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -52,6 +52,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.75.0-4"
+        "@promptbook/core": "0.75.2"
     }
 }