@promptbook/types 0.81.0-11 → 0.81.0-13

package/README.md

@@ -280,7 +280,7 @@ Or you can install them separately:
 -   **[@promptbook/editable](https://www.npmjs.com/package/@promptbook/editable)** - Editable book as native javascript object with imperative object API
 -   **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Usefull templates and examples of books which can be used as a starting point
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
--   **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
+-   ⭐ **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
 
 
 

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

@@ -1,4 +1,4 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
-import { getBookTemplate } from '../other/templates/getBookTemplate';
+import { getBookTemplates } from '../other/templates/getBookTemplates';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
-export { getBookTemplate };
+export { getBookTemplates };

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

@@ -68,6 +68,7 @@ import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
 import { isValidEmail } from '../utils/validators/email/isValidEmail';
+import { isPathRoot } from '../utils/validators/filePath/isPathRoot';
 import { isValidFilePath } from '../utils/validators/filePath/isValidFilePath';
 import { isValidJavascriptName } from '../utils/validators/javascriptName/isValidJavascriptName';
 import { isValidPromptbookVersion } from '../utils/validators/semanticVersion/isValidPromptbookVersion';
@@ -147,6 +148,7 @@ export { trimCodeBlock };
 export { trimEndOfCodeBlock };
 export { unwrapResult };
 export { isValidEmail };
+export { isPathRoot };
 export { isValidFilePath };
 export { isValidJavascriptName };
 export { isValidPromptbookVersion };

package/esm/typings/src/other/templates/{getBookTemplate.d.ts → getBookTemplates.d.ts}

@@ -1,4 +1,3 @@
-import type { PipelineCollection } from '../../collection/PipelineCollection';
 import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 /**
@@ -7,15 +6,16 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
  * @singleton
  * @private internal cache of `getBookTemplate`
  */
-export declare let templatesPipelineCollection: PipelineCollection | null;
+export declare let pipelines: Array<PipelineJson> | null;
 /**
  * Get template for new book
  *
+ * @param formfactorName - optional filter for FORMFACTOR - get only pipelines for this formfactor
+ * @returns list of pipelines
  * @public exported from `@promptbook/templates`
  */
-export declare function getBookTemplate(formfactorName: string_formfactor_name): PipelineJson;
+export declare function getBookTemplates(formfactorName?: string_formfactor_name): ReadonlyArray<PipelineJson>;
 /**
- * TODO: !!!!!! Test
+ * TODO: Unit test
  * TODO: [🧠] Which is the best place for this function
- * TODO: !!!!!! `book string template notation
  */

package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts

@@ -5,3 +5,6 @@ import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
  * @private as default `fetch` function used in Promptbook scrapers
  */
 export declare const scraperFetch: PromptbookFetch;
+/**
+ * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
+ */

package/esm/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -9,5 +9,6 @@ import type { really_any } from '../../../utils/organization/really_any';
  */
 export declare function preserve(func: (...params: ReadonlyArray<really_any>) => unknown): void;
 /**
+ * TODO: Probbably remove in favour of `keepImported`
  * TODO: !! [1] This maybe does memory leak
  */

package/esm/typings/src/utils/validators/filePath/isPathRoot.d.ts

@@ -0,0 +1,12 @@
+import type { string_dirname } from '../../../types/typeAliases';
+import type { string_filename } from '../../../types/typeAliases';
+/**
+ * Determines if the given path is a root path.
+ *
+ * Note: This does not check if the file exists only if the path is valid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isPathRoot(value: string_dirname | string_filename): boolean;
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */

package/esm/typings/src/utils/validators/filePath/isPathRoot.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */

package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -7,3 +7,6 @@ import type { really_unknown } from '../../organization/really_unknown';
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidFilePath(filename: really_unknown): filename is string_filename;
+/**
+ * TODO: [🍏] Implement for MacOs
+ */

package/esm/typings/src/wizzard/$getCompiledBook.d.ts

@@ -0,0 +1,16 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { string_filename } from '../types/typeAliases';
+import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * @see ./wizzard.ts `getPipeline` method
+ *
+ * @private usable through `ptbk run` and `@prompbook/wizzard`
+ */
+export declare function $getCompiledBook(tools: Required<Pick<ExecutionTools, 'fs' | 'fetch'>>, pipelineSource: string_filename | string_pipeline_url | PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
+/**
+ * TODO: Write unit test
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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

@@ -1,7 +1,7 @@
 import { Promisable } from 'type-fest';
-import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../pipeline/PipelineString';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { InputParameters } from '../types/typeAliases';
@@ -23,7 +23,7 @@ declare class Wizzard {
      *
      * @param pipelineSource
      */
-    getExecutionTools(): Promise<ExecutionTools>;
+    getExecutionTools(): Promise<Required<Pick<ExecutionTools, 'fs' | 'fetch'>>>;
     /**
      * TODO: Make standalone function from this exported from node and used here and in `ptbk run`
      * @@@!!!
@@ -34,7 +34,7 @@ declare class Wizzard {
      *
      * @param pipelineSource
      */
-    getPipeline(pipelineSource: string_filename | string_pipeline_url | PipelineString): Promise<PipelineJson>;
+    getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString): Promise<PipelineJson>;
 }
 /**
  * 🧙‍♂️ @@@

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.81.0-11",
+    "version": "0.81.0-13",
     "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.81.0-11"
+        "@promptbook/core": "0.81.0-13"
     }
 }

package/esm/typings/src/scripting/javascript/utils/unknownToString.d.ts

@@ -1,8 +0,0 @@
-import type { really_unknown } from '../../../utils/organization/really_unknown';
-/**
- * Converts anything to string that can be used for debugging and logging
- *
- * @param value String value for logging
- * @private internal util
- */
-export declare function unknownToString(value: really_unknown): string;