@promptbook/types 0.75.0-0 → 0.75.0-1

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

@@ -59,9 +59,12 @@ import { CsvFormatDefinition } from '../formats/csv/CsvFormatDefinition';
 import { CsvFormatError } from '../formats/csv/CsvFormatError';
 import { MANDATORY_CSV_SETTINGS } from '../formats/csv/CsvSettings';
 import { TextFormatDefinition } from '../formats/text/TextFormatDefinition';
+import { BoilerplateFormfactorDefinition } from '../formfactors/_boilerplate/BoilerplateFormfactorDefinition';
 import { ChatFormfactorDefinition } from '../formfactors/chat/ChatFormfactorDefinition';
 import { GenericFormfactorDefinition } from '../formfactors/generic/GenericFormfactorDefinition';
 import { FORMFACTOR_DEFINITIONS } from '../formfactors/index';
+import { SheetsFormfactorDefinition } from '../formfactors/sheets/SheetsFormfactorDefinition';
+import { TranslatorFormfactorDefinition } from '../formfactors/translator/TranslatorFormfactorDefinition';
 import { $llmToolsMetadataRegister } from '../llm-providers/_common/register/$llmToolsMetadataRegister';
 import { $llmToolsRegister } from '../llm-providers/_common/register/$llmToolsRegister';
 import { createLlmToolsFromConfiguration } from '../llm-providers/_common/register/createLlmToolsFromConfiguration';
@@ -75,6 +78,7 @@ import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlm
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { preparePersona } from '../personas/preparePersona';
+import { GENERIC_PIPELINE_INTERFACE } from '../pipeline/pipeline-interface/constants';
 import { getPipelineInterface } from '../pipeline/pipeline-interface/getPipelineInterface';
 import { isPipelineImplementingInterface } from '../pipeline/pipeline-interface/isPipelineImplementingInterface';
 import { isPipelineInterfacesEqual } from '../pipeline/pipeline-interface/isPipelineInterfacesEqual';
@@ -160,9 +164,12 @@ export { CsvFormatDefinition };
 export { CsvFormatError };
 export { MANDATORY_CSV_SETTINGS };
 export { TextFormatDefinition };
+export { BoilerplateFormfactorDefinition };
 export { ChatFormfactorDefinition };
 export { GenericFormfactorDefinition };
 export { FORMFACTOR_DEFINITIONS };
+export { SheetsFormfactorDefinition };
+export { TranslatorFormfactorDefinition };
 export { $llmToolsMetadataRegister };
 export { $llmToolsRegister };
 export { createLlmToolsFromConfiguration };
@@ -176,6 +183,7 @@ export { MultipleLlmExecutionTools };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
 export { preparePersona };
+export { GENERIC_PIPELINE_INTERFACE };
 export { getPipelineInterface };
 export { isPipelineImplementingInterface };
 export { isPipelineInterfacesEqual };

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

@@ -12,8 +12,8 @@ import { $currentDate } from '../utils/$currentDate';
 import { $isRunningInBrowser } from '../utils/environment/$isRunningInBrowser';
 import { $isRunningInNode } from '../utils/environment/$isRunningInNode';
 import { $isRunningInWebWorker } from '../utils/environment/$isRunningInWebWorker';
-import { CHARACTERS_PER_STANDARD_LINE } from '../utils/expectation-counters/config';
-import { LINES_PER_STANDARD_PAGE } from '../utils/expectation-counters/config';
+import { CHARACTERS_PER_STANDARD_LINE } from '../utils/expectation-counters/constants';
+import { LINES_PER_STANDARD_PAGE } from '../utils/expectation-counters/constants';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
 import { countPages } from '../utils/expectation-counters/countPages';

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

@@ -192,5 +192,6 @@ export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
  */
 export declare const IS_COST_PREVENTED: boolean;
 /**
+ * TODO: Extract `constants.ts` from `config.ts`
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */

package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Boilerplate is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const BoilerplateFormfactorDefinition: {
+    readonly name: "BOILERPLATE";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly [];
+        readonly outputParameterNames: readonly [];
+    };
+};

package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts

@@ -1,7 +1,8 @@
-import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { PipelineInterface } from '../../pipeline/pipeline-interface/PipelineInterface';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_name } from '../../types/typeAliases';
 import type { string_promptbook_documentation_url } from '../../types/typeAliases';
+import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 /**
  * @@@
  */
@@ -26,4 +27,8 @@ export type AbstractFormfactorDefinition = {
      * @@@
      */
     readonly documentationUrl: string_promptbook_documentation_url;
+    /**
+     * @@@
+     */
+    readonly pipelineInterface: PipelineInterface;
 };

package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts

@@ -1,4 +1,4 @@
-import type { FORMFACTOR_DEFINITIONS } from '../index';
+import { FORMFACTOR_DEFINITIONS } from '../index';
 /**
  * @@@
  */

package/esm/typings/src/formfactors/chat/ChatFormfactorDefinition.d.ts

@@ -4,7 +4,12 @@
  * @public exported from `@promptbook/core`
  */
 export declare const ChatFormfactorDefinition: {
-    readonly name: "CHAT";
+    readonly name: "CHATBOT";
+    readonly aliasNames: readonly ["CHAT"];
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["previousTitle", "previousConversationSummary", "userMessage"];
+        readonly outputParameterNames: readonly ["title", "conversationSummary", "chatbotResponse"];
+    };
 };

package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts

@@ -7,4 +7,8 @@ export declare const GenericFormfactorDefinition: {
     readonly name: "GENERIC";
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly [];
+        readonly outputParameterNames: readonly [];
+    };
 };

package/esm/typings/src/formfactors/index.d.ts

@@ -7,8 +7,33 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     readonly name: "GENERIC";
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly [];
+        readonly outputParameterNames: readonly [];
+    };
 }, {
-    readonly name: "CHAT";
+    readonly name: "CHATBOT";
+    readonly aliasNames: readonly ["CHAT"];
     readonly description: "@@@";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["previousTitle", "previousConversationSummary", "userMessage"];
+        readonly outputParameterNames: readonly ["title", "conversationSummary", "chatbotResponse"];
+    };
+}, {
+    readonly name: "TRANSLATOR";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["inputMessage"];
+        readonly outputParameterNames: readonly ["outputMessage"];
+    };
+}, {
+    readonly name: "SHEETS";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["inputSheet"];
+        readonly outputParameterNames: readonly ["outputSheet"];
+    };
 }];

package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Sheets is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const SheetsFormfactorDefinition: {
+    readonly name: "SHEETS";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["inputSheet"];
+        readonly outputParameterNames: readonly ["outputSheet"];
+    };
+};

package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Translator is form of app that @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TranslatorFormfactorDefinition: {
+    readonly name: "TRANSLATOR";
+    readonly description: "@@@";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    readonly pipelineInterface: {
+        readonly inputParameterNames: readonly ["inputMessage"];
+        readonly outputParameterNames: readonly ["outputMessage"];
+    };
+};

package/esm/typings/src/pipeline/pipeline-interface/PipelineInterface.d.ts

@@ -8,13 +8,13 @@ export type PipelineInterface = {
      *
      * Note: Sorted alphabetically
      */
-    inputParameterNames: Array<string_parameter_name>;
+    readonly inputParameterNames: ReadonlyArray<string_parameter_name>;
     /**
      * @@@
      *
      * Note: Sorted alphabetically
      */
-    outputParameterNames: Array<string_parameter_name>;
+    readonly outputParameterNames: ReadonlyArray<string_parameter_name>;
 };
 /**
  * TODO: !!!!!! Change inputParameterNames to inputParameters<InputParameter>

package/esm/typings/src/pipeline/pipeline-interface/constants.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const GENERIC_PIPELINE_INTERFACE: {
+    readonly inputParameterNames: readonly [];
+    readonly outputParameterNames: readonly [];
+};

package/esm/typings/src/utils/expectation-counters/{config.d.ts → constants.d.ts}

@@ -10,3 +10,6 @@ export declare const CHARACTERS_PER_STANDARD_LINE = 63;
  * @public exported from `@promptbook/utils`
  */
 export declare const LINES_PER_STANDARD_PAGE = 44;
+/**
+ * TODO: [🧠] Should be this `constants.ts` or `config.ts`?
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.75.0-0",
+    "version": "0.75.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -51,6 +51,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.75.0-0"
+        "@promptbook/core": "0.75.0-1"
     }
 }