@promptbook/core 0.75.0-4 → 0.75.2

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/core",
-    "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,

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.75.0-3';
+    var PROMPTBOOK_ENGINE_VERSION = '0.75.1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -644,6 +644,14 @@
      * @private within the repository
      */
     var 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`
+     */
+    var NAME = "Promptbook";
     /**
      * Claim for the Promptbook
      *
@@ -653,6 +661,22 @@
      */
     var CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
     //            <- TODO: [🐊] Pick the best claim
+    /**
+     * Logo for the light theme
+     *
+     * TODO: [🗽] Unite branding and make single place for it
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var LOGO_LIGHT_SRC = "https://promptbook.studio/_next/static/media/promptbook-logo.b21f0c70.png";
+    /**
+     * Logo for the dark theme
+     *
+     * TODO: [🗽] Unite branding and make single place for it
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var LOGO_DARK_SRC = "https://promptbook.studio/_next/static/media/promptbook-logo-white.09887cbc.png";
     /**
      * When the title is not provided, the default title is used
      *
@@ -1266,7 +1290,6 @@
         while (unresovedTasks.length > 0) {
             _loop_3();
         }
-        // TODO: !!!!!! Test that pipeline interface implements declared formfactor interface
     }
     /**
      * TODO: !! [🧞‍♀️] Do not allow joker + foreach
@@ -10033,6 +10056,7 @@
     /**
      * @@@
      *
+     * @deprecated https://github.com/webgptorg/promptbook/pull/186
      * @see https://github.com/webgptorg/promptbook/discussions/171
      *
      * @public exported from `@promptbook/core`
@@ -10070,8 +10094,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 }; }
@@ -10083,29 +10105,23 @@
         }
         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);
+        return JSON.stringify(Object.keys(pipelineInterface1)) === JSON.stringify(Object.keys(pipelineInterface2));
     }
-    /**
-     * 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`
@@ -10114,10 +10130,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
@@ -10378,6 +10390,8 @@
     exports.GeneratorFormfactorDefinition = GeneratorFormfactorDefinition;
     exports.GenericFormfactorDefinition = GenericFormfactorDefinition;
     exports.KnowledgeScrapeError = KnowledgeScrapeError;
+    exports.LOGO_DARK_SRC = LOGO_DARK_SRC;
+    exports.LOGO_LIGHT_SRC = LOGO_LIGHT_SRC;
     exports.LimitReachedError = LimitReachedError;
     exports.MANDATORY_CSV_SETTINGS = MANDATORY_CSV_SETTINGS;
     exports.MAX_FILENAME_LENGTH = MAX_FILENAME_LENGTH;
@@ -10386,6 +10400,7 @@
     exports.MemoryStorage = MemoryStorage;
     exports.MissingToolsError = MissingToolsError;
     exports.MultipleLlmExecutionTools = MultipleLlmExecutionTools;
+    exports.NAME = NAME;
     exports.NonTaskSectionTypes = NonTaskSectionTypes;
     exports.NotFoundError = NotFoundError;
     exports.NotYetImplementedError = NotYetImplementedError;