@promptbook/markdown-utils 0.81.0-8 → 0.81.0

package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts

@@ -1,4 +1,4 @@
-import { JsonValue } from 'type-fest';
+import type { JsonValue } from 'type-fest';
 /**
  * Tests if the value is [🚉] serializable as JSON
  *
@@ -20,6 +20,6 @@ import { JsonValue } from 'type-fest';
  */
 export declare function isSerializableAsJson(value: unknown): value is JsonValue;
 /**
- * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */

package/esm/typings/src/utils/validators/filePath/isRootPath.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 isRootPath(value: string_dirname | string_filename): boolean;
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */

package/esm/typings/src/utils/validators/filePath/isRootPath.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,19 +1,63 @@
 import { Promisable } from 'type-fest';
+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 { Parameters } from '../types/typeAliases';
+import type { InputParameters } from '../types/typeAliases';
+import type { string_filename } from '../types/typeAliases';
 import type { string_pipeline_url } from '../types/typeAliases';
 /**
- * @@@
+ * Wizzard for simple usage of the Promptbook
+ * Look at `wizzard` for more details
  *
- * @public exported from `@promptbook/node`
+ * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
+ *
+ * @private just for single instance
  */
-export declare const wizzard: {
+declare class Wizzard {
+    /**
+     * Run the book
+     *
+     * It can be loaded from:
+     * 1) As a file ./books/write-cv.book.md
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md found in ./books folder recursively
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md fetched from the internet
+     * 3) As a string
+     *
+     * Note: This works simmilar to the `ptbk run` command
+     */
+    execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+    private executionTools;
+    /**
+     * Provides the tools automatically for the Node.js environment
+     *
+     * @param pipelineSource
+     */
+    getExecutionTools(): Promise<Required<Pick<ExecutionTools, 'fs' | 'fetch'>>>;
     /**
-     * @@@!!!!!!
+     * Load book from the source
+     *
+     * Pipelines can be loaded from:
+     * 1) As a file ./books/write-cv.book.md
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md found in ./books folder recursively
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md fetched from the internet
+     * 3) As a string
+     *
+     * @param pipelineSource
      */
-    run(book: string_pipeline_url, inputParameters: Parameters, onProgress?: ((taskProgress: TaskProgress) => Promisable<void>) | undefined): Promise<PipelineExecutorResult>;
-};
+    getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString): Promise<PipelineJson>;
+}
+/**
+ * Wizzard for simple usage of the Promptbook
+ *
+ * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
+ *
+ * @singleton
+ * @public exported from `@promptbook/wizzard`
+ */
+export declare const wizzard: Wizzard;
+export {};
 /**
- * TODO: !!!!!! Add to readmes - one markdown here imported in all packages
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.81.0-8",
+    "version": "0.81.0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,