@promptbook/types 0.86.8 → 0.86.10

package/README.md

@@ -431,7 +431,7 @@ See [CHANGELOG.md](./CHANGELOG.md)
 
 ## 📜 License
 
-<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://github.com/webgptorg/promptbook">Promptbook</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/hejny/">Pavol Hejný</a> is licensed under <a href="https://creativecommons.org/licenses/by/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY 4.0</a></p>
+Promptbook project is under [BUSL 1.1 is an SPDX license](https://spdx.org/licenses/BUSL-1.1.html)
 
 ## 🎯 Todos
 
@@ -439,7 +439,6 @@ See [TODO.md](./TODO.md)
 
 
 
-
 ## 🤝 Partners
 
 <div style="display: flex; align-items: center; gap: 20px;">
@@ -456,6 +455,6 @@ See [TODO.md](./TODO.md)
 
 ## 🖋️ Contributing
 
-I am open to pull requests, feedback, and suggestions. Or if you like this utility, you can [☕ buy me a coffee](https://www.buymeacoffee.com/hejny) or [donate via cryptocurrencies](https://github.com/hejny/hejny/blob/main/documents/crypto.md).
+We are open to pull requests, feedback, and suggestions.
 
-You can also ⭐ star the promptbook package, [follow me on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).
+You can also ⭐ star the project, [follow us on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).

package/esm/typings/src/conversion/archive/loadArchive.d.ts

@@ -0,0 +1,16 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { string_filename } from '../../types/typeAliases';
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * Loads the books from the archive file with `.bookc` extension
+ *
+ * @param filePath Path to the archive file with `.bookc` extension
+ * @param fs Filesystem tools
+ * @returns Pipelines loaded from the archive
+ *
+ * @private utility of Prompbook
+ */
+export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<Array<PipelineJson>>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/conversion/archive/saveArchive.d.ts

@@ -0,0 +1,18 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { string_filename } from '../../types/typeAliases';
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * Saves the given books into an archive file with `.bookc` extension
+ *
+ * @param filePath Path to the archive file with `.bookc` extension
+ * @param books Pipelines to be saved in the archive
+ * @param fs Filesystem tools
+ *
+ * @private utility of Prompbook
+ */
+export declare function saveArchive(filePath: string_filename, collectionJson: ReadonlyArray<PipelineJson>, fs: FilesystemTools): Promise<void>;
+/**
+ * TODO: Add metadata to zip
+ * TODO: Compression level and other zip options from config
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -1,6 +1,5 @@
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../../pipeline/PipelineString';
-import type { string_json } from '../../types/typeAliases';
 /**
  * Import the pipeline.book or pipeline.bookc file
  *
@@ -10,20 +9,14 @@ import type { string_json } from '../../types/typeAliases';
  * @param path - The path to the file relative to examples/pipelines directory
  * @private internal function of tests
  */
-export declare function importPipelineWithoutPreparation(path: `${string}.book`): PipelineString;
-export declare function importPipelineWithoutPreparation(path: `${string}.bookc`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.book`): Promise<PipelineString>;
+export declare function importPipelineWithoutPreparation(path: `${string}.bookc`): Promise<PipelineJson>;
 /**
  * Import the pipeline.bookc file as parsed JSON
  *
  * @private internal function of tests
  */
-export declare function importPipelineJson(path: `${string}.bookc`): PipelineJson;
-/**
- * Import the pipeline.bookc file as string
- *
- * @private internal function of tests
- */
-export declare function importPipelineJsonAsString(path: `${string}.bookc`): string_json<PipelineJson>;
+export declare function importPipelineJson(path: `${string}.bookc`): Promise<PipelineJson>;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [⚫] Code in this file should never be published in any package

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.86.8",
+    "version": "0.86.10",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -45,6 +45,6 @@
     "homepage": "https://ptbk.io/",
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.86.8"
+        "@promptbook/core": "0.86.10"
     }
 }

package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.test.d.ts

@@ -1 +0,0 @@
-export {};