@baselineos/protocol-core 1.0.0

package/src/types/index.ts

@@ -0,0 +1,799 @@
+/**
+ * Baseline Protocol™ — Core Type Definitions
+ * The foundation for the Baseline prompt engineering language
+ *
+ * These types define the complete structure of Baseline Language programs
+ * across all three layers: Lang, Frame, and Core (Studio).
+ *
+ * @license Apache-2.0
+ */
+
+// ─── Program Structure ──────────────────────────────────────────────
+
+export interface BaselineProgram {
+  blocks: (LangBlock | FrameBlock | CoreBlock)[];
+  metadata: ProgramMetadata;
+}
+
+export interface ProgramMetadata {
+  version: string;
+  created: Date;
+  author: string;
+  description: string;
+  tags: string[];
+}
+
+export interface BlockMetadata {
+  id: string;
+  name: string;
+  description: string;
+  version: string;
+  created: Date;
+  modified: Date;
+  tags: string[];
+  priority: Priority;
+}
+
+// ─── Layer 1: Lang (Language & Expression) ───────────────────────────
+
+export interface LangBlock {
+  type: 'lang';
+  content: LexiconBlock | SyntaxBlock | CommandsBlock;
+  metadata: BlockMetadata;
+}
+
+export interface LexiconBlock {
+  type: 'lexicon';
+  domain: Domain;
+  vocabulary: VocabularySet;
+  templates: Template[];
+  patterns: Pattern[];
+}
+
+export interface SyntaxBlock {
+  type: 'syntax';
+  rules: GrammarRule[];
+  operators: Operator[];
+  precedence: PrecedenceRule[];
+}
+
+export interface CommandsBlock {
+  type: 'commands';
+  actions: Action[];
+  directives: Directive[];
+  operations: Operation[];
+}
+
+// ─── Layer 2: Frame (Context & Control) ──────────────────────────────
+
+export interface FrameBlock {
+  type: 'frame';
+  content: IntentBlock | ModeBlock | EnvironmentBlock | ScopeBlock | AuthorityBlock | BasisBlock;
+  metadata: BlockMetadata;
+}
+
+export interface IntentBlock {
+  type: 'intent';
+  goals: Goal[];
+  deliverables: Deliverable[];
+  successCriteria: SuccessCriterion[];
+  constraints: Constraint[];
+}
+
+export interface ModeBlock {
+  type: 'mode';
+  executionPattern: ExecutionPattern;
+  reasoning: ReasoningMode;
+  checkpoints: Checkpoint[];
+  iterations: IterationRule[];
+}
+
+export interface EnvironmentBlock {
+  type: 'environment';
+  models: Model[];
+  tools: Tool[];
+  runtime: Runtime;
+  policies: Policy[];
+}
+
+export interface ScopeBlock {
+  type: 'scope';
+  boundaries: Boundary[];
+  limits: Limit[];
+  exclusions: Exclusion[];
+  inclusions: Inclusion[];
+}
+
+export interface AuthorityBlock {
+  type: 'authority';
+  roles: Role[];
+  permissions: Permission[];
+  access: AccessControl[];
+  delegation: DelegationRule[];
+}
+
+export interface BasisBlock {
+  type: 'basis';
+  organization: Organization;
+  kpis: KPI[];
+  metrics: Metric[];
+  context: Context[];
+}
+
+// ─── Layer 3: Core / Studio (Execution & Output) ─────────────────────
+
+export interface CoreBlock {
+  type: 'core';
+  content: FidelityBlock | SpecBlock | ArtifactBlock | ProductBlock | PlanBlock | PromptBlock;
+  metadata: BlockMetadata;
+}
+
+export interface FidelityBlock {
+  type: 'fidelity';
+  precision: PrecisionLevel;
+  verification: VerificationLevel;
+  quality: QualityStandard[];
+  constraints: Constraint[];
+}
+
+export interface SpecBlock {
+  type: 'spec';
+  requirements: Requirement[];
+  contracts: Contract[];
+  interfaces: Interface[];
+  validations: Validation[];
+}
+
+export interface ArtifactBlock {
+  type: 'artifact';
+  outputs: Output[];
+  receipts: Receipt[];
+  signatures: Signature[];
+  retention: RetentionPolicy[];
+}
+
+export interface ProductBlock {
+  type: 'product';
+  deliverables: Deliverable[];
+  documents: Document[];
+  results: Result[];
+  outcomes: Outcome[];
+}
+
+export interface PlanBlock {
+  type: 'plan';
+  roadmap: Roadmap;
+  timeline: Timeline;
+  milestones: Milestone[];
+  dependencies: Dependency[];
+}
+
+export interface PromptBlock {
+  type: 'prompt';
+  ir: IntermediateRepresentation;
+  instructions: Instruction[];
+  context: Context[];
+  constraints: Constraint[];
+}
+
+// ─── Intermediate Representation ─────────────────────────────────────
+
+export interface IntermediateRepresentation {
+  version: string;
+  blocks: (LangBlock | FrameBlock | CoreBlock)[];
+  metadata: ProgramMetadata;
+  optimizations: Optimization[];
+}
+
+// ─── Lexicon Types ───────────────────────────────────────────────────
+
+export interface Domain {
+  name: string;
+  description: string;
+  vocabulary: string[];
+  patterns: string[];
+  examples: string[];
+}
+
+export interface VocabularySet {
+  terms: Term[];
+  synonyms: Synonym[];
+  antonyms: Antonym[];
+  definitions: Definition[];
+}
+
+export interface Template {
+  name: string;
+  description: string;
+  pattern: string;
+  variables: Variable[];
+  examples: string[];
+}
+
+export interface Pattern {
+  name: string;
+  description: string;
+  regex: string;
+  examples: string[];
+  usage: string[];
+}
+
+export interface Term {
+  name: string;
+  definition: string;
+  synonyms: string[];
+  antonyms: string[];
+  examples: string[];
+}
+
+export interface Synonym {
+  term: string;
+  alternatives: string[];
+  context: string[];
+}
+
+export interface Antonym {
+  term: string;
+  opposites: string[];
+  context: string[];
+}
+
+export interface Definition {
+  term: string;
+  meaning: string;
+  context: string[];
+  examples: string[];
+}
+
+export interface Variable {
+  name: string;
+  type: string;
+  description: string;
+  required: boolean;
+  default?: unknown;
+}
+
+// ─── Grammar Types ───────────────────────────────────────────────────
+
+export interface GrammarRule {
+  name: string;
+  pattern: string;
+  precedence: number;
+  associativity: 'left' | 'right' | 'none';
+}
+
+export interface Operator {
+  symbol: string;
+  precedence: number;
+  associativity: 'left' | 'right' | 'none';
+  description: string;
+}
+
+export interface PrecedenceRule {
+  level: number;
+  operators: string[];
+  description: string;
+}
+
+// ─── Command Types ───────────────────────────────────────────────────
+
+export interface Action {
+  name: string;
+  description: string;
+  parameters: Parameter[];
+  examples: string[];
+}
+
+export interface Directive {
+  name: string;
+  description: string;
+  parameters: Parameter[];
+  examples: string[];
+}
+
+export interface Operation {
+  name: string;
+  description: string;
+  parameters: Parameter[];
+  examples: string[];
+}
+
+export interface Parameter {
+  name: string;
+  type: string;
+  description: string;
+  required: boolean;
+  default?: unknown;
+  validation?: Validation[];
+}
+
+// ─── Intent Types ────────────────────────────────────────────────────
+
+export interface Goal {
+  name: string;
+  description: string;
+  priority: Priority;
+  deadline: Date;
+  successCriteria: string[];
+}
+
+export interface Deliverable {
+  name: string;
+  description: string;
+  type: DeliverableType;
+  format: string;
+  quality: QualityStandard[];
+}
+
+export interface SuccessCriterion {
+  name: string;
+  description: string;
+  metric: string;
+  target: number;
+  unit: string;
+}
+
+export interface Constraint {
+  name: string;
+  description: string;
+  type: ConstraintType;
+  value: unknown;
+  enforcement: EnforcementLevel;
+}
+
+// ─── Execution Types ─────────────────────────────────────────────────
+
+export interface ExecutionPattern {
+  name: string;
+  description: string;
+  steps: Step[];
+  checkpoints: Checkpoint[];
+  iterations: IterationRule[];
+}
+
+export interface ReasoningMode {
+  type: 'chain-of-thought' | 'react' | 'tree-of-thoughts' | 'systematic';
+  description: string;
+  parameters: Parameter[];
+}
+
+export interface Checkpoint {
+  name: string;
+  description: string;
+  validation: Validation[];
+  actions: Action[];
+}
+
+export interface IterationRule {
+  name: string;
+  condition: string;
+  maxIterations: number;
+  convergence: ConvergenceCriteria;
+}
+
+export interface Step {
+  name: string;
+  description: string;
+  action: Action;
+  validation: Validation[];
+  next: string[];
+}
+
+export interface ConvergenceCriteria {
+  metric: string;
+  threshold: number;
+  tolerance: number;
+  maxIterations: number;
+}
+
+// ─── Environment Types ───────────────────────────────────────────────
+
+export interface Model {
+  name: string;
+  type: ModelType;
+  version: string;
+  capabilities: Capability[];
+  constraints: Constraint[];
+}
+
+export interface Tool {
+  name: string;
+  description: string;
+  type: ToolType;
+  parameters: Parameter[];
+  examples: string[];
+}
+
+export interface Runtime {
+  environment: string;
+  version: string;
+  resources: Resource[];
+  policies: Policy[];
+}
+
+export interface Policy {
+  name: string;
+  description: string;
+  type: PolicyType;
+  rules: Rule[];
+  enforcement: EnforcementLevel;
+}
+
+export interface Capability {
+  name: string;
+  description: string;
+  parameters: Parameter[];
+  examples: string[];
+}
+
+export interface Resource {
+  type: string;
+  name: string;
+  capacity: number;
+  unit: string;
+  available: number;
+}
+
+export interface Rule {
+  name: string;
+  description: string;
+  condition: string;
+  action: string;
+  priority: number;
+}
+
+export interface Condition {
+  name: string;
+  description: string;
+  expression: string;
+  parameters: Parameter[];
+}
+
+// ─── Scope Types ─────────────────────────────────────────────────────
+
+export interface Boundary {
+  name: string;
+  description: string;
+  type: BoundaryType;
+  value: unknown;
+  enforcement: EnforcementLevel;
+}
+
+export interface Limit {
+  name: string;
+  description: string;
+  type: LimitType;
+  value: number;
+  unit: string;
+}
+
+export interface Exclusion {
+  name: string;
+  description: string;
+  reason: string;
+  alternatives: string[];
+}
+
+export interface Inclusion {
+  name: string;
+  description: string;
+  reason: string;
+  requirements: string[];
+}
+
+// ─── Authority Types ─────────────────────────────────────────────────
+
+export interface Role {
+  name: string;
+  description: string;
+  permissions: Permission[];
+  responsibilities: string[];
+}
+
+export interface Permission {
+  name: string;
+  description: string;
+  scope: string;
+  level: PermissionLevel;
+}
+
+export interface AccessControl {
+  resource: string;
+  permissions: Permission[];
+  roles: string[];
+  conditions: Condition[];
+}
+
+export interface DelegationRule {
+  name: string;
+  description: string;
+  fromRole: string;
+  toRole: string;
+  conditions: Condition[];
+  expiration: Date;
+}
+
+// ─── Organization Types ──────────────────────────────────────────────
+
+export interface Organization {
+  name: string;
+  description: string;
+  structure: Structure;
+  culture: Culture;
+  values: Value[];
+}
+
+export interface Structure {
+  type: string;
+  levels: number;
+  departments: string[];
+  reporting: string[];
+}
+
+export interface Culture {
+  values: string[];
+  principles: string[];
+  practices: string[];
+  norms: string[];
+}
+
+export interface Value {
+  name: string;
+  description: string;
+  importance: number;
+  examples: string[];
+}
+
+export interface KPI {
+  name: string;
+  description: string;
+  metric: string;
+  target: number;
+  unit: string;
+  frequency: string;
+}
+
+export interface Metric {
+  name: string;
+  description: string;
+  type: MetricType;
+  calculation: string;
+  unit: string;
+}
+
+export interface Context {
+  name: string;
+  description: string;
+  type: ContextType;
+  value: unknown;
+  source: string;
+}
+
+// ─── Quality & Verification Types ────────────────────────────────────
+
+export interface PrecisionLevel {
+  level: 'low' | 'medium' | 'high' | 'exact';
+  description: string;
+  requirements: string[];
+}
+
+export interface VerificationLevel {
+  level: 'basic' | 'standard' | 'comprehensive' | 'exhaustive';
+  description: string;
+  methods: string[];
+}
+
+export interface QualityStandard {
+  name: string;
+  description: string;
+  criteria: string[];
+  measurement: string;
+}
+
+export interface Validation {
+  name: string;
+  description: string;
+  type: ValidationType;
+  rules: Rule[];
+  errorHandling: ErrorHandling;
+}
+
+export interface ErrorHandling {
+  strategy: string;
+  fallback: string;
+  logging: string;
+  userNotification: string;
+}
+
+export interface AcceptanceCriteria {
+  name: string;
+  description: string;
+  test: string;
+  passCondition: string;
+  priority: Priority;
+}
+
+// ─── Spec Types ──────────────────────────────────────────────────────
+
+export interface Requirement {
+  name: string;
+  description: string;
+  type: RequirementType;
+  priority: Priority;
+  acceptance: AcceptanceCriteria[];
+}
+
+export interface Contract {
+  name: string;
+  description: string;
+  parties: string[];
+  terms: Term[];
+  enforcement: EnforcementLevel;
+}
+
+export interface Interface {
+  name: string;
+  description: string;
+  type: InterfaceType;
+  methods: Method[];
+  properties: Property[];
+}
+
+export interface Method {
+  name: string;
+  description: string;
+  parameters: Parameter[];
+  returnType: string;
+  examples: string[];
+}
+
+export interface Property {
+  name: string;
+  description: string;
+  type: string;
+  required: boolean;
+  default?: unknown;
+}
+
+// ─── Artifact Types ──────────────────────────────────────────────────
+
+export interface Output {
+  name: string;
+  description: string;
+  type: OutputType;
+  format: string;
+  quality: QualityStandard[];
+}
+
+export interface Receipt {
+  name: string;
+  description: string;
+  timestamp: Date;
+  hash: string;
+  signature: Signature;
+}
+
+export interface Signature {
+  algorithm: string;
+  value: string;
+  timestamp: Date;
+  key: string;
+}
+
+export interface RetentionPolicy {
+  name: string;
+  description: string;
+  duration: string;
+  conditions: Condition[];
+  disposal: DisposalMethod;
+}
+
+// ─── Product Types ───────────────────────────────────────────────────
+
+export interface Document {
+  name: string;
+  description: string;
+  type: DocumentType;
+  format: string;
+  content: string;
+}
+
+export interface Result {
+  name: string;
+  description: string;
+  type: ResultType;
+  value: unknown;
+  quality: QualityStandard[];
+}
+
+export interface Outcome {
+  name: string;
+  description: string;
+  type: OutcomeType;
+  success: boolean;
+  metrics: Metric[];
+}
+
+// ─── Plan Types ──────────────────────────────────────────────────────
+
+export interface Roadmap {
+  name: string;
+  description: string;
+  phases: Phase[];
+  timeline: Timeline;
+  milestones: Milestone[];
+}
+
+export interface Timeline {
+  start: Date;
+  end: Date;
+  phases: Phase[];
+  dependencies: Dependency[];
+}
+
+export interface Milestone {
+  name: string;
+  description: string;
+  date: Date;
+  deliverables: Deliverable[];
+  successCriteria: SuccessCriterion[];
+}
+
+export interface Dependency {
+  name: string;
+  description: string;
+  from: string;
+  to: string;
+  type: DependencyType;
+  critical: boolean;
+}
+
+export interface Phase {
+  name: string;
+  description: string;
+  start: Date;
+  end: Date;
+  deliverables: Deliverable[];
+  milestones: Milestone[];
+}
+
+export interface Optimization {
+  name: string;
+  description: string;
+  type: string;
+  impact: string;
+  implementation: string[];
+}
+
+export interface Instruction {
+  name: string;
+  description: string;
+  type: InstructionType;
+  parameters: Parameter[];
+  examples: string[];
+}
+
+// ─── Union Types ─────────────────────────────────────────────────────
+
+export type Priority = 'low' | 'medium' | 'high' | 'critical';
+export type DeliverableType = 'document' | 'code' | 'data' | 'model' | 'service';
+export type ConstraintType = 'time' | 'cost' | 'quality' | 'security' | 'compliance';
+export type EnforcementLevel = 'suggested' | 'recommended' | 'required' | 'mandatory';
+export type ModelType = 'llm' | 'ml' | 'nlp' | 'vision' | 'audio';
+export type ToolType = 'api' | 'library' | 'service' | 'utility' | 'integration';
+export type PolicyType = 'security' | 'privacy' | 'compliance' | 'performance' | 'quality';
+export type BoundaryType = 'inclusive' | 'exclusive' | 'range' | 'pattern' | 'custom';
+export type LimitType = 'count' | 'size' | 'time' | 'memory' | 'cpu';
+export type PermissionLevel = 'read' | 'write' | 'execute' | 'admin' | 'owner';
+export type ContextType = 'environment' | 'user' | 'system' | 'business' | 'technical';
+export type RequirementType = 'functional' | 'non-functional' | 'business' | 'technical' | 'compliance';
+export type InterfaceType = 'api' | 'ui' | 'database' | 'service' | 'protocol';
+export type ValidationType = 'format' | 'range' | 'presence' | 'uniqueness' | 'custom';
+export type OutputType = 'text' | 'data' | 'file' | 'stream' | 'response';
+export type DocumentType = 'specification' | 'manual' | 'report' | 'contract' | 'policy';
+export type ResultType = 'success' | 'failure' | 'partial' | 'error' | 'warning';
+export type OutcomeType = 'achieved' | 'partially-achieved' | 'failed' | 'cancelled' | 'deferred';
+export type DependencyType = 'finish-to-start' | 'start-to-start' | 'finish-to-finish' | 'start-to-finish';
+export type InstructionType = 'command' | 'query' | 'action' | 'validation' | 'transformation';
+export type MetricType = 'count' | 'percentage' | 'duration' | 'currency' | 'custom';
+export type DisposalMethod = 'delete' | 'archive' | 'retain' | 'anonymize' | 'encrypt';