@compilr-dev/sdk 0.5.8 → 0.5.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts
CHANGED
|
@@ -61,7 +61,7 @@ export type { AskUserQuestion, AskUserInput, AskUserResult, AskUserHandler, AskU
|
|
|
61
61
|
export { createPlatformTools, createProjectTools, createWorkItemTools, createDocumentTools, createPlanTools, createBacklogTools, createAnchorTools, createArtifactTools, createEpisodeTools, ProjectAnchorStore, } from './platform/index.js';
|
|
62
62
|
export type { ProjectAnchorStoreConfig } from './platform/index.js';
|
|
63
63
|
export { STEP_ORDER, GUIDED_STEP_CRITERIA, getNextStep, isValidTransition, getStepCriteria, formatStepDisplay, getStepNumber, } from './platform/index.js';
|
|
64
|
-
export { platformSkills, designSkill, sketchSkill, prdSkill, refineSkill, refineItemSkill, architectureSkill, sessionNotesSkill, buildSkill, scaffoldSkill, outlineSkill, literatureReviewSkill, draftSectionSkill, peerReviewSkill, } from './skills/index.js';
|
|
64
|
+
export { platformSkills, designSkill, sketchSkill, prdSkill, refineSkill, refineItemSkill, architectureSkill, sessionNotesSkill, buildSkill, scaffoldSkill, outlineSkill, literatureReviewSkill, draftSectionSkill, peerReviewSkill, researchScaffoldSkill, } from './skills/index.js';
|
|
65
65
|
export { ACTION_REGISTRY, getActionsForContext, getActionById, resolveActionPrompt, buildContextSummary, getSuggestedRole, } from './actions/index.js';
|
|
66
66
|
export type { ActionContext, ActionDefinition } from './actions/index.js';
|
|
67
67
|
export { PROJECT_TYPES, getProjectTypeConfig, getProjectTypesByCategory, generalConfig, softwareConfig, researchConfig, businessPlanConfig, contentConfig, techDocsConfig, courseConfig, } from './project-types/index.js';
|
package/dist/index.js
CHANGED
|
@@ -139,7 +139,7 @@ export { STEP_ORDER, GUIDED_STEP_CRITERIA, getNextStep, isValidTransition, getSt
|
|
|
139
139
|
// =============================================================================
|
|
140
140
|
// Platform Skills (platform-specific prompt expansions)
|
|
141
141
|
// =============================================================================
|
|
142
|
-
export { platformSkills, designSkill, sketchSkill, prdSkill, refineSkill, refineItemSkill, architectureSkill, sessionNotesSkill, buildSkill, scaffoldSkill, outlineSkill, literatureReviewSkill, draftSectionSkill, peerReviewSkill, } from './skills/index.js';
|
|
142
|
+
export { platformSkills, designSkill, sketchSkill, prdSkill, refineSkill, refineItemSkill, architectureSkill, sessionNotesSkill, buildSkill, scaffoldSkill, outlineSkill, literatureReviewSkill, draftSectionSkill, peerReviewSkill, researchScaffoldSkill, } from './skills/index.js';
|
|
143
143
|
// =============================================================================
|
|
144
144
|
// Contextual Actions (skill invocations with context)
|
|
145
145
|
// =============================================================================
|
|
@@ -154,7 +154,7 @@ export const researchConfig = {
|
|
|
154
154
|
{ type: 'bibliography', label: 'Bibliography', description: 'References and citations' },
|
|
155
155
|
{ type: 'session-notes', label: 'Session Notes', description: 'Summary of work done' },
|
|
156
156
|
],
|
|
157
|
-
projectActions: ['outline', 'literature-review', 'draft-section', 'peer-review', 'session-notes'],
|
|
157
|
+
projectActions: ['research-scaffold', 'outline', 'literature-review', 'draft-section', 'peer-review', 'session-notes'],
|
|
158
158
|
workItemActions: ['draft-section', 'explain'],
|
|
159
159
|
workItemLabels: {
|
|
160
160
|
feature: { short: 'SC', full: 'Section' },
|
package/dist/skills/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Platform Skills — barrel export
|
|
3
3
|
*/
|
|
4
|
-
export { platformSkills, designSkill, sketchSkill, prdSkill, refineSkill, refineItemSkill, architectureSkill, sessionNotesSkill, buildSkill, scaffoldSkill, outlineSkill, literatureReviewSkill, draftSectionSkill, peerReviewSkill, } from './platform-skills.js';
|
|
4
|
+
export { platformSkills, designSkill, sketchSkill, prdSkill, refineSkill, refineItemSkill, architectureSkill, sessionNotesSkill, buildSkill, scaffoldSkill, outlineSkill, literatureReviewSkill, draftSectionSkill, peerReviewSkill, researchScaffoldSkill, } from './platform-skills.js';
|
package/dist/skills/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Platform Skills — barrel export
|
|
3
3
|
*/
|
|
4
|
-
export { platformSkills, designSkill, sketchSkill, prdSkill, refineSkill, refineItemSkill, architectureSkill, sessionNotesSkill, buildSkill, scaffoldSkill, outlineSkill, literatureReviewSkill, draftSectionSkill, peerReviewSkill, } from './platform-skills.js';
|
|
4
|
+
export { platformSkills, designSkill, sketchSkill, prdSkill, refineSkill, refineItemSkill, architectureSkill, sessionNotesSkill, buildSkill, scaffoldSkill, outlineSkill, literatureReviewSkill, draftSectionSkill, peerReviewSkill, researchScaffoldSkill, } from './platform-skills.js';
|
|
@@ -21,8 +21,9 @@ export declare const outlineSkill: Skill;
|
|
|
21
21
|
export declare const literatureReviewSkill: Skill;
|
|
22
22
|
export declare const draftSectionSkill: Skill;
|
|
23
23
|
export declare const peerReviewSkill: Skill;
|
|
24
|
+
export declare const researchScaffoldSkill: Skill;
|
|
24
25
|
/**
|
|
25
|
-
* All platform-specific skills (
|
|
26
|
+
* All platform-specific skills (14 total).
|
|
26
27
|
* These skills reference platform tools (backlog, workitems, documents, projects)
|
|
27
28
|
* and belong in the SDK rather than in generic agent/coding libraries.
|
|
28
29
|
*/
|
|
@@ -1355,11 +1355,65 @@ For issues that affect the Research Model:
|
|
|
1355
1355
|
✓ User has received the review summary`,
|
|
1356
1356
|
tags: ['research', 'review', 'quality'],
|
|
1357
1357
|
});
|
|
1358
|
+
export const researchScaffoldSkill = defineSkill({
|
|
1359
|
+
name: 'research-scaffold',
|
|
1360
|
+
description: 'Scaffold a research paper project from a template (APA, IEEE, Thesis, Literature Review, Lab Report)',
|
|
1361
|
+
prompt: `You are in RESEARCH SCAFFOLD MODE. Your goal is to help the user set up a new research paper project using a template.
|
|
1362
|
+
|
|
1363
|
+
## Available Templates
|
|
1364
|
+
|
|
1365
|
+
| Template | ID | Best For |
|
|
1366
|
+
|----------|-----|----------|
|
|
1367
|
+
| APA Research Paper | \`apa-paper\` | Social sciences, psychology, education |
|
|
1368
|
+
| IEEE Conference Paper | \`ieee-paper\` | Engineering, computer science |
|
|
1369
|
+
| Thesis / Dissertation | \`thesis\` | Graduate work, multi-chapter |
|
|
1370
|
+
| Literature Review | \`literature-review\` | Standalone review papers |
|
|
1371
|
+
| Lab Report | \`lab-report\` | Scientific experiments |
|
|
1372
|
+
|
|
1373
|
+
## Step 1: Gather Info
|
|
1374
|
+
|
|
1375
|
+
Ask the user (if not already provided):
|
|
1376
|
+
1. What is the paper topic / title?
|
|
1377
|
+
2. Which template best fits their needs? (describe the options briefly)
|
|
1378
|
+
3. What citation style? (default depends on template — APA for most, IEEE for engineering)
|
|
1379
|
+
|
|
1380
|
+
## Step 2: Scaffold
|
|
1381
|
+
|
|
1382
|
+
Call the \`research_scaffold\` tool with:
|
|
1383
|
+
- \`template\`: the template ID
|
|
1384
|
+
- \`title\`: the paper title
|
|
1385
|
+
- \`citation_style\`: if different from template default
|
|
1386
|
+
- \`output_dir\`: the project path
|
|
1387
|
+
|
|
1388
|
+
This creates:
|
|
1389
|
+
- A Research Model with pre-defined sections
|
|
1390
|
+
- Folder structure (sections/, figures/, references/, knowledge/)
|
|
1391
|
+
- Section stub files (one per section)
|
|
1392
|
+
- COMPILR.md with project context
|
|
1393
|
+
- Bibliography file (.bib)
|
|
1394
|
+
- Work items for each section (type: "Section")
|
|
1395
|
+
|
|
1396
|
+
## Step 3: Confirm and Guide
|
|
1397
|
+
|
|
1398
|
+
After scaffolding, tell the user:
|
|
1399
|
+
- What was created (sections, files, work items)
|
|
1400
|
+
- Suggested next steps:
|
|
1401
|
+
1. "Add your source material to the Knowledge Base"
|
|
1402
|
+
2. "Run /outline to customize the section structure"
|
|
1403
|
+
3. "Run /literature-review to analyze your sources"
|
|
1404
|
+
4. "Run /draft-section to start writing"
|
|
1405
|
+
|
|
1406
|
+
## Rules
|
|
1407
|
+
- If a Research Model already exists, warn the user and don't overwrite
|
|
1408
|
+
- Use dry_run first if the user seems uncertain
|
|
1409
|
+
- The scaffold is a starting point — the user can customize everything after`,
|
|
1410
|
+
tags: ['research', 'scaffold', 'setup'],
|
|
1411
|
+
});
|
|
1358
1412
|
// =============================================================================
|
|
1359
1413
|
// Aggregate export
|
|
1360
1414
|
// =============================================================================
|
|
1361
1415
|
/**
|
|
1362
|
-
* All platform-specific skills (
|
|
1416
|
+
* All platform-specific skills (14 total).
|
|
1363
1417
|
* These skills reference platform tools (backlog, workitems, documents, projects)
|
|
1364
1418
|
* and belong in the SDK rather than in generic agent/coding libraries.
|
|
1365
1419
|
*/
|
|
@@ -1377,4 +1431,5 @@ export const platformSkills = [
|
|
|
1377
1431
|
literatureReviewSkill,
|
|
1378
1432
|
draftSectionSkill,
|
|
1379
1433
|
peerReviewSkill,
|
|
1434
|
+
researchScaffoldSkill,
|
|
1380
1435
|
];
|