@promptbook/core 0.75.1 → 0.75.3

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/package.json

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

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.75.0';
+    var PROMPTBOOK_ENGINE_VERSION = '0.75.2';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1290,7 +1290,6 @@
         while (unresovedTasks.length > 0) {
             _loop_3();
         }
-        // TODO: !!!!!! Test that pipeline interface implements declared formfactor interface
     }
     /**
      * TODO: !! [🧞‍♀️] Do not allow joker + foreach
@@ -5117,16 +5116,16 @@
          * Mixes registered scrapers from $scrapersMetadataRegister and $scrapersRegister
          */
         var all = [];
-        var _loop_1 = function (packageName, className) {
+        var _loop_1 = function (packageName, className, mimeTypes, documentationUrl, isAvilableInBrowser) {
             if (all.some(function (item) { return item.packageName === packageName && item.className === className; })) {
                 return "continue";
             }
-            all.push({ packageName: packageName, className: className });
+            all.push({ packageName: packageName, className: className, mimeTypes: mimeTypes, documentationUrl: documentationUrl, isAvilableInBrowser: isAvilableInBrowser });
         };
         try {
             for (var _c = __values($scrapersMetadataRegister.list()), _d = _c.next(); !_d.done; _d = _c.next()) {
-                var _e = _d.value, packageName = _e.packageName, className = _e.className;
-                _loop_1(packageName, className);
+                var _e = _d.value, packageName = _e.packageName, className = _e.className, mimeTypes = _e.mimeTypes, documentationUrl = _e.documentationUrl, isAvilableInBrowser = _e.isAvilableInBrowser;
+                _loop_1(packageName, className, mimeTypes, documentationUrl, isAvilableInBrowser);
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }
@@ -5136,16 +5135,16 @@
             }
             finally { if (e_1) throw e_1.error; }
         }
-        var _loop_2 = function (packageName, className) {
+        var _loop_2 = function (packageName, className, mimeTypes, documentationUrl, isAvilableInBrowser) {
             if (all.some(function (item) { return item.packageName === packageName && item.className === className; })) {
                 return "continue";
             }
-            all.push({ packageName: packageName, className: className });
+            all.push({ packageName: packageName, className: className, mimeTypes: mimeTypes, documentationUrl: documentationUrl, isAvilableInBrowser: isAvilableInBrowser });
         };
         try {
             for (var _f = __values($scrapersRegister.list()), _g = _f.next(); !_g.done; _g = _f.next()) {
-                var _h = _g.value, packageName = _h.packageName, className = _h.className;
-                _loop_2(packageName, className);
+                var _h = _g.value, packageName = _h.packageName, className = _h.className, mimeTypes = _h.mimeTypes, documentationUrl = _h.documentationUrl, isAvilableInBrowser = _h.isAvilableInBrowser;
+                _loop_2(packageName, className, mimeTypes, documentationUrl, isAvilableInBrowser);
             }
         }
         catch (e_2_1) { e_2 = { error: e_2_1 }; }
@@ -5175,29 +5174,33 @@
         }
         return spaceTrim__default["default"](function (block) { return "\n            Available scrapers are:\n            ".concat(block(metadata
             .map(function (_a, i) {
-            var packageName = _a.packageName, className = _a.className, isMetadataAviailable = _a.isMetadataAviailable, isInstalled = _a.isInstalled;
+            var packageName = _a.packageName, className = _a.className, isMetadataAviailable = _a.isMetadataAviailable, isInstalled = _a.isInstalled, mimeTypes = _a.mimeTypes, isAvilableInBrowser = _a.isAvilableInBrowser;
             var more;
+            // TODO: Use documentationUrl
             if (just(false)) {
                 more = '';
             }
             else if (!isMetadataAviailable && !isInstalled) {
                 // TODO: [�][�] Maybe do allow to do auto-install if package not registered and not found
-                more = "(not installed and no metadata, looks like a unexpected behavior)";
+                more = "*(not installed and no metadata, looks like a unexpected behavior)*";
             }
             else if (isMetadataAviailable && !isInstalled) {
                 // TODO: [�][�]
-                more = "(not installed)";
+                more = "*(not installed)*";
             }
             else if (!isMetadataAviailable && isInstalled) {
-                more = "(no metadata, looks like a unexpected behavior)";
+                more = "*(no metadata, looks like a unexpected behavior)*";
             }
             else if (isMetadataAviailable && isInstalled) {
                 more = "(installed)";
             }
             else {
-                more = "(unknown state, looks like a unexpected behavior)";
+                more = "*(unknown state, looks like a unexpected behavior)*";
             }
-            return "".concat(i + 1, ") `").concat(className, "` from `").concat(packageName, "` ").concat(more);
+            if (!isAvilableInBrowser) {
+                more += " *(not available in browser)*";
+            }
+            return "".concat(i + 1, ") `").concat(className, "` from `").concat(packageName, "` compatible to scrape ").concat(mimeTypes.join(', '), " ").concat(more);
         })
             .join('\n')), "\n        "); });
     }
@@ -5582,7 +5585,10 @@
                                             return [7 /*endfinally*/];
                                         case 9:
                                             if (partialPieces === null) {
-                                                throw new KnowledgeScrapeError(spaceTrim__default["default"](function (block) { return "\n                        Cannot scrape knowledge from source: ".concat(knowledgeSource.sourceContent, "\n\n                        No scraper found for the mime type \"").concat(sourceHandler.mimeType, "\"\n\n                        ").concat(block($registeredScrapersMessage()), "\n\n\n                    "); }));
+                                                throw new KnowledgeScrapeError(spaceTrim__default["default"](function (block) { return "\n                        Cannot scrape knowledge from source:\n                        \n                        > ".concat(block(knowledgeSource.sourceContent
+                                                    .split('\n')
+                                                    .map(function (line) { return "> ".concat(line); })
+                                                    .join('\n')), "\n\n                        No scraper found for the mime type \"").concat(sourceHandler.mimeType, "\"\n\n                        ").concat(block($registeredScrapersMessage()), "\n\n\n                    "); }));
                                             }
                                             pieces = partialPieces.map(function (partialPiece) { return (__assign(__assign({}, partialPiece), { sources: [
                                                     {
@@ -10057,6 +10063,7 @@
     /**
      * @@@
      *
+     * @deprecated https://github.com/webgptorg/promptbook/pull/186
      * @see https://github.com/webgptorg/promptbook/discussions/171
      *
      * @public exported from `@promptbook/core`
@@ -10094,8 +10101,6 @@
                     var name2 = _b.name;
                     return name1.localeCompare(name2);
                 });
-                // <- TODO: [🧠] Should we compare a descriptions?
-                // <- TODO: [🧠][🛴] Maybe add type + expectations into the intefrace, like "a person name"
             }
         }
         catch (e_2_1) { e_2 = { error: e_2_1 }; }
@@ -10107,29 +10112,72 @@
         }
         return $deepFreeze(pipelineInterface);
     }
-    /**
-     * TODO: !!!!!! Write unit test
-     */
 
     /**
      * @@@
      *
+     * @deprecated https://github.com/webgptorg/promptbook/pull/186
      * @see https://github.com/webgptorg/promptbook/discussions/171
      *
      * @public exported from `@promptbook/core`
      */
     function isPipelineInterfacesEqual(pipelineInterface1, pipelineInterface2) {
-        // TODO: [🧠] !!! Implement better
-        return JSON.stringify(pipelineInterface1) === JSON.stringify(pipelineInterface2);
+        var e_1, _a, e_2, _b;
+        try {
+            for (var _c = __values(['inputParameters', 'outputParameters']), _d = _c.next(); !_d.done; _d = _c.next()) {
+                var whichParameters = _d.value;
+                var parameters1 = pipelineInterface1[whichParameters]; // <- Note: `isPipelineInterfacesEqual` is just temporary solution, no need to fix this
+                var parameters2 = pipelineInterface2[whichParameters];
+                if (parameters1.length !== parameters2.length) {
+                    return false;
+                }
+                var _loop_1 = function (parameter) {
+                    var matchingParameter = parameters2.find(function (_a) {
+                        var name = _a.name;
+                        return name === parameter.name;
+                    });
+                    if (!matchingParameter) {
+                        return { value: false };
+                    }
+                    // Note: Do not compare description, it is not relevant for compatibility
+                    if (matchingParameter.isInput !== parameter.isInput) {
+                        return { value: false };
+                    }
+                    if (matchingParameter.isOutput !== parameter.isOutput) {
+                        return { value: false };
+                    }
+                };
+                try {
+                    for (var parameters1_1 = (e_2 = void 0, __values(parameters1)), parameters1_1_1 = parameters1_1.next(); !parameters1_1_1.done; parameters1_1_1 = parameters1_1.next()) {
+                        var parameter = parameters1_1_1.value;
+                        var state_1 = _loop_1(parameter);
+                        if (typeof state_1 === "object")
+                            return state_1.value;
+                    }
+                }
+                catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                finally {
+                    try {
+                        if (parameters1_1_1 && !parameters1_1_1.done && (_b = parameters1_1.return)) _b.call(parameters1_1);
+                    }
+                    finally { if (e_2) throw e_2.error; }
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return true;
     }
-    /**
-     * TODO: [🧠] !!! Return more states than true/false - 'IDENTICAL' |'IDENTICAL_UNPREPARED' | 'IDENTICAL_INTERFACE' | 'DIFFERENT'
-     * TODO: !!! Write unit test
-     */
 
     /**
      * @@@
      *
+     * @deprecated https://github.com/webgptorg/promptbook/pull/186
      * @see https://github.com/webgptorg/promptbook/discussions/171
      *
      * @public exported from `@promptbook/core`
@@ -10138,10 +10186,6 @@
         var pipeline = options.pipeline, pipelineInterface = options.pipelineInterface;
         return isPipelineInterfacesEqual(getPipelineInterface(pipeline), pipelineInterface);
     }
-    /**
-     * TODO: !!!!!! Test real implementing NOT equality
-     * TODO: !!!!!! Write unit test
-     */
 
     /**
      * Metadata of the scraper