@promptbook/browser
Version:
Promptbook: Turn your company's scattered knowledge into AI ready books
95 lines (94 loc) • 6.11 kB
TypeScript
import type { BookCommitment } from './_base/BookCommitment';
import type { CommitmentDefinition } from './_base/CommitmentDefinition';
import { ActionCommitmentDefinition } from './ACTION/ACTION';
import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
import { DeleteCommitmentDefinition } from './DELETE/DELETE';
import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
import { FromCommitmentDefinition } from './FROM/FROM';
import { GoalCommitmentDefinition } from './GOAL/GOAL';
import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
import { MetaCommitmentDefinition } from './META/META';
import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
import { ModelCommitmentDefinition } from './MODEL/MODEL';
import { NoteCommitmentDefinition } from './NOTE/NOTE';
import { OpenCommitmentDefinition } from './OPEN/OPEN';
import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
import { RuleCommitmentDefinition } from './RULE/RULE';
import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
import { StyleCommitmentDefinition } from './STYLE/STYLE';
import { UseCommitmentDefinition } from './USE/USE';
import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
/**
* Registry of all available commitment definitions
* This array contains instances of all commitment definitions
* This is the single source of truth for all commitments in the system
*
* @private Use functions to access commitments instead of this array directly
*/
export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
/**
* Gets a commitment definition by its type
* @param type The commitment type to look up
* @returns The commitment definition or null if not found
*
* @public exported from `@promptbook/core`
*/
export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
/**
* Gets all available commitment definitions
* @returns Array of all commitment definitions
*
* @public exported from `@promptbook/core`
*/
export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
/**
* Gets all available commitment types
* @returns Array of all commitment types
*
* @public exported from `@promptbook/core`
*/
export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
/**
* Checks if a commitment type is supported
* @param type The commitment type to check
* @returns True if the commitment type is supported
*
* @public exported from `@promptbook/core`
*/
export declare function isCommitmentSupported(type: BookCommitment): boolean;
/**
* Grouped commitment definition
*
* @public exported from `@promptbook/core`
*/
export type GroupedCommitmentDefinition = {
primary: CommitmentDefinition;
aliases: string[];
};
/**
* Gets all commitment definitions grouped by their aliases
*
* @returns Array of grouped commitment definitions
*
* @public exported from `@promptbook/core`
*/
export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
/**
* TODO: [🧠] Maybe create through standardized $register
* Note: [💞] Ignore a discrepancy between file name and entity name
*/