@compilr-dev/sdk 0.7.5 → 0.7.6
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/platform/types.d.ts
CHANGED
|
@@ -19,7 +19,7 @@ export type WorkItemType = 'feature' | 'bug' | 'tech-debt' | 'chore';
|
|
|
19
19
|
export type WorkItemStatus = 'backlog' | 'in_progress' | 'completed' | 'skipped';
|
|
20
20
|
export type WorkItemPriority = 'critical' | 'high' | 'medium' | 'low';
|
|
21
21
|
export type GuidedStep = 'plan' | 'implement' | 'test' | 'commit' | 'review';
|
|
22
|
-
export type DocumentType = 'prd' | 'architecture' | 'design' | 'notes' | 'plan' | 'app-model' | 'research-model' | 'business-model';
|
|
22
|
+
export type DocumentType = 'prd' | 'architecture' | 'design' | 'notes' | 'plan' | 'app-model' | 'research-model' | 'business-model' | 'brand-model';
|
|
23
23
|
export type PlanStatus = 'draft' | 'approved' | 'in_progress' | 'completed' | 'abandoned';
|
|
24
24
|
export interface Project {
|
|
25
25
|
id: number;
|
|
@@ -401,80 +401,83 @@ export const contentConfig = {
|
|
|
401
401
|
category: 'writing',
|
|
402
402
|
phases: [
|
|
403
403
|
{
|
|
404
|
-
id: '
|
|
405
|
-
label: '
|
|
406
|
-
description: '
|
|
407
|
-
completionCheck: 'has-
|
|
404
|
+
id: 'brand-setup',
|
|
405
|
+
label: 'Brand Setup',
|
|
406
|
+
description: 'Define brand identity, voice, and visual guidelines',
|
|
407
|
+
completionCheck: 'has-document',
|
|
408
|
+
completionDocType: 'brand-model',
|
|
408
409
|
},
|
|
409
410
|
{
|
|
410
|
-
id: '
|
|
411
|
-
label: '
|
|
412
|
-
description: '
|
|
413
|
-
completionCheck: '
|
|
411
|
+
id: 'strategy',
|
|
412
|
+
label: 'Strategy',
|
|
413
|
+
description: 'Define content pillars and cadence',
|
|
414
|
+
completionCheck: 'has-workitems',
|
|
414
415
|
},
|
|
415
|
-
{ id: 'draft', label: 'Draft', description: 'Write content', completionCheck: 'has-workitems' },
|
|
416
|
-
{ id: 'edit', label: 'Edit', description: 'Review and polish', completionCheck: 'manual' },
|
|
417
416
|
{
|
|
418
|
-
id: '
|
|
419
|
-
label: '
|
|
420
|
-
description: '
|
|
421
|
-
completionCheck: '
|
|
417
|
+
id: 'calendar',
|
|
418
|
+
label: 'Calendar',
|
|
419
|
+
description: 'Plan content for the period',
|
|
420
|
+
completionCheck: 'has-workitems',
|
|
422
421
|
},
|
|
422
|
+
{ id: 'create', label: 'Create', description: 'Write copy and visual briefs', completionCheck: 'has-workitems' },
|
|
423
|
+
{ id: 'review', label: 'Review', description: 'Check voice and brand consistency', completionCheck: 'manual' },
|
|
424
|
+
{ id: 'publish', label: 'Publish', description: 'Finalize and publish', completionCheck: 'manual' },
|
|
423
425
|
],
|
|
424
426
|
suggestedAgents: [
|
|
425
|
-
{ role: '
|
|
426
|
-
{ role: '
|
|
427
|
-
{
|
|
428
|
-
|
|
429
|
-
label: 'SEO Specialist',
|
|
430
|
-
description: 'Search optimization and keyword strategy',
|
|
431
|
-
},
|
|
427
|
+
{ role: 'strategist', label: 'Content Strategist', description: 'Planning, ideation, calendar, repurposing' },
|
|
428
|
+
{ role: 'writer', label: 'Copywriter', description: 'Headlines, captions, CTAs, long-form copy' },
|
|
429
|
+
{ role: 'designer', label: 'Visual Director', description: 'Visual briefs from Brand Model' },
|
|
430
|
+
{ role: 'editor', label: 'Editor', description: 'Voice consistency, quality review, on-brand checks' },
|
|
432
431
|
],
|
|
433
432
|
documentTemplates: [
|
|
433
|
+
{ type: 'brand-model', label: 'Brand Model', description: 'Brand identity, voice, visual guidelines, audience, strategy' },
|
|
434
434
|
{ type: 'editorial-calendar', label: 'Editorial Calendar', description: 'Content schedule' },
|
|
435
|
-
{ type: 'brand-guide', label: 'Brand Guide', description: 'Voice, tone, and style guidelines' },
|
|
436
435
|
{ type: 'article', label: 'Article', description: 'Blog post or article draft' },
|
|
437
436
|
{ type: 'session-notes', label: 'Session Notes', description: 'Summary of work done' },
|
|
438
437
|
],
|
|
439
|
-
projectActions: ['session-notes'],
|
|
440
|
-
workItemActions: ['explain'],
|
|
438
|
+
projectActions: ['brand-setup', 'content-strategy', 'content-calendar', 'create-content', 'content-review', 'session-notes'],
|
|
439
|
+
workItemActions: ['refine-item', 'explain'],
|
|
441
440
|
workItemLabels: {
|
|
442
441
|
feature: { short: 'PC', full: 'Content Piece' },
|
|
443
442
|
bug: { short: 'FX', full: 'Fix' },
|
|
444
|
-
'tech-debt': { short: '
|
|
443
|
+
'tech-debt': { short: 'BU', full: 'Brand Update' },
|
|
445
444
|
chore: { short: 'TK', full: 'Task' },
|
|
446
445
|
},
|
|
447
446
|
systemPromptContext: 'This is a content/marketing project. The user is creating articles, blog posts, or marketing content. Focus on engaging writing, SEO awareness, and brand consistency.',
|
|
448
447
|
systemPromptSection: `## Project Context: Content & Marketing
|
|
449
448
|
|
|
450
|
-
You are assisting with a content
|
|
449
|
+
You are assisting with a content and marketing project. Your role is to help the user produce on-brand content consistently across platforms.
|
|
450
|
+
|
|
451
|
+
### Brand Model
|
|
452
|
+
This project uses a Brand Model that captures visual identity (logos, colors, fonts, photography style), brand voice (tone, persona, do/don't vocabulary, writing samples), audience personas, target platforms, and content strategy pillars. Always read the Brand Model before generating any content or brief. Never ask the user to repeat brand information that is already in the model.
|
|
451
453
|
|
|
452
454
|
### Workflow
|
|
453
|
-
1. **
|
|
454
|
-
2. **
|
|
455
|
-
3. **
|
|
456
|
-
4. **
|
|
457
|
-
5. **
|
|
458
|
-
6. **
|
|
459
|
-
7. **Publishing** — Final review and publication
|
|
455
|
+
1. **Brand Setup** — Define brand identity, visual guidelines, voice, audience, strategy pillars
|
|
456
|
+
2. **Content Strategy** — Refine pillars, set cadence per platform
|
|
457
|
+
3. **Content Calendar** — Plan content pieces for a period
|
|
458
|
+
4. **Create** — Write copy (headline, body, CTA, hashtags) + generate visual brief
|
|
459
|
+
5. **Review** — Check voice consistency, brand alignment, platform conventions
|
|
460
|
+
6. **Publish** — Final review and publication
|
|
460
461
|
|
|
461
462
|
### Work Items
|
|
462
|
-
- **Content Piece** (type: feature) — an article, post, or
|
|
463
|
+
- **Content Piece** (type: feature) — an article, post, carousel, or newsletter to create
|
|
463
464
|
- **Fix** (type: bug) — content corrections or updates needed
|
|
464
|
-
- **
|
|
465
|
+
- **Brand Update** (type: tech-debt) — brand guidelines changes
|
|
465
466
|
- **Task** (type: chore) — formatting, scheduling, or administrative work
|
|
466
467
|
|
|
467
468
|
### Writing Conventions
|
|
468
|
-
-
|
|
469
|
+
- Always read the Brand Model voice section before writing any copy
|
|
470
|
+
- Match the established brand voice and tone
|
|
471
|
+
- Adapt tone per platform (e.g., more formal on LinkedIn, casual on Twitter)
|
|
469
472
|
- Lead with value — don't bury the point
|
|
470
|
-
- Use short paragraphs and clear headings for scannability
|
|
471
473
|
- Include a clear call-to-action where appropriate
|
|
472
|
-
- Consider SEO: keywords, meta descriptions, internal linking
|
|
473
474
|
|
|
474
475
|
### Team Agents
|
|
475
|
-
- **
|
|
476
|
-
- **
|
|
477
|
-
- **
|
|
476
|
+
- **Content Strategist** — planning, ideation, calendar, repurposing
|
|
477
|
+
- **Copywriter** — headlines, captions, CTAs, long-form copy
|
|
478
|
+
- **Visual Director** — visual briefs from Brand Model guidelines
|
|
479
|
+
- **Editor** — voice consistency, brand alignment, quality review
|
|
480
|
+
Suggest delegation when a task benefits from focused expertise.`,
|
|
478
481
|
};
|
|
479
482
|
// =============================================================================
|
|
480
483
|
// Technical Documentation
|