@compilr-dev/factory 0.1.13 → 0.1.14

package/dist/research-model/types.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Research Model Types
+ *
+ * The Research Model is the central data structure for research paper projects.
+ * It describes the paper's structure — sections, claims, sources, research
+ * questions — independently of the output format (LaTeX, Markdown, etc.).
+ */
+export interface ResearchModel {
+    /** Paper metadata */
+    readonly title: string;
+    readonly abstract?: string;
+    readonly authors?: readonly string[];
+    readonly targetJournal?: string;
+    readonly citationStyle: CitationStyle;
+    readonly keywords?: readonly string[];
+    readonly methodology?: string;
+    /** The driving questions */
+    readonly researchQuestions: readonly ResearchQuestion[];
+    /** Hierarchical section structure */
+    readonly sections: readonly Section[];
+    /** Source registry */
+    readonly sources: readonly Source[];
+    /** Model metadata */
+    readonly meta: ResearchMeta;
+}
+export type CitationStyle = 'apa' | 'mla' | 'chicago' | 'ieee' | 'harvard';
+export interface ResearchQuestion {
+    readonly id: string;
+    readonly question: string;
+    /** Which sections address this question */
+    readonly sectionRefs: readonly string[];
+    readonly status: QuestionStatus;
+}
+export type QuestionStatus = 'open' | 'partially-answered' | 'answered';
+export interface Section {
+    readonly id: string;
+    readonly title: string;
+    /** What this section argues or establishes */
+    readonly purpose?: string;
+    readonly order: number;
+    /** null = top-level section */
+    readonly parentId?: string;
+    readonly status: SectionStatus;
+    /** Target word count */
+    readonly targetWordCount?: number;
+    /** Actual word count (updated on draft) */
+    readonly actualWordCount?: number;
+    /** Claims made in this section */
+    readonly claims: readonly Claim[];
+    /** Author notes */
+    readonly notes?: string;
+}
+export type SectionStatus = 'outlined' | 'drafted' | 'reviewed' | 'final';
+export interface Claim {
+    readonly id: string;
+    /** The assertion being made */
+    readonly statement: string;
+    /** How well-supported is this claim? */
+    readonly evidenceStrength: EvidenceStrength;
+    /** Sources that support this claim */
+    readonly supportingSources: readonly SourceRef[];
+    /** Sources that contradict this claim */
+    readonly contradictingSources: readonly SourceRef[];
+    /** Author's original analysis, derived from sources, or synthesis of multiple sources */
+    readonly type: ClaimType;
+}
+export type EvidenceStrength = 'strong' | 'moderate' | 'weak' | 'unsupported' | 'contested';
+export type ClaimType = 'original' | 'derived' | 'synthesis';
+export interface SourceRef {
+    readonly sourceId: string;
+    /** Specific page, chapter, or section */
+    readonly location?: string;
+    /** Brief note on relevance */
+    readonly relevance?: string;
+}
+export interface Source {
+    readonly id: string;
+    /** Path in the knowledge base */
+    readonly kbPath?: string;
+    /** Citation key (e.g., "smith2024") */
+    readonly citeKey: string;
+    /** Structured citation info */
+    readonly citation: CitationInfo;
+    /** Agent-extracted key findings */
+    readonly keyFindings?: readonly string[];
+    /** Tags for categorization */
+    readonly tags?: readonly string[];
+    /** Relevance to the research */
+    readonly relevance?: SourceRelevance;
+    /** Has this source been analyzed? */
+    readonly analyzed: boolean;
+}
+export type SourceRelevance = 'primary' | 'secondary' | 'background';
+export interface CitationInfo {
+    readonly type: CitationType;
+    readonly title: string;
+    readonly authors: readonly string[];
+    readonly year: number | string;
+    /** Journal, conference, publisher, or website */
+    readonly venue?: string;
+    readonly volume?: string;
+    readonly issue?: string;
+    readonly pages?: string;
+    readonly doi?: string;
+    readonly url?: string;
+    readonly accessedAt?: string;
+}
+export type CitationType = 'article' | 'book' | 'chapter' | 'conference' | 'thesis' | 'web' | 'report' | 'other';
+export interface ResearchMeta {
+    readonly revision: number;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}

package/dist/research-model/types.js

@@ -0,0 +1,8 @@
+/**
+ * Research Model Types
+ *
+ * The Research Model is the central data structure for research paper projects.
+ * It describes the paper's structure — sections, claims, sources, research
+ * questions — independently of the output format (LaTeX, Markdown, etc.).
+ */
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compilr-dev/factory",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "AI-driven application scaffolder for the compilr-dev ecosystem",
   "type": "module",
   "main": "dist/index.js",
@@ -21,13 +21,9 @@
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "npm run clean && npm run lint && npm run test && npm run build"
   },
-  "peerDependencies": {
-    "@compilr-dev/sdk": ">=0.1.12"
-  },
   "devDependencies": {
     "@anthropic-ai/sdk": "^0.78.0",
     "@compilr-dev/agents": "^0.3.16",
-    "@compilr-dev/sdk": "^0.4.1",
     "@eslint/js": "^9.17.0",
     "@types/node": "^22.10.2",
     "@vitest/coverage-v8": "^2.1.9",
@@ -47,5 +43,8 @@
     "factory",
     "scaffolder",
     "code-generation"
-  ]
+  ],
+  "dependencies": {
+    "@compilr-dev/sdk": "^0.5.2"
+  }
 }