@owlmeans/viable-common 0.0.24 → 0.0.26

package/tests/planning.spec.ts

@@ -4,7 +4,7 @@ import addFormats from 'ajv-formats'
 import { ResilientError } from '@owlmeans/error'
 import {
   canTransit, CodeScope, CodeStyle, intrinsicOf, IntrinsicStatus, makeSchemaRegistry,
-  SpecificationFormat, transitionsFrom, WorkcardKind,
+  SpecificationFormat, TITLE_MAX, transitionsFrom, WorkcardKind,
 } from '@owlmeans/planning'
 import type { Specification } from '@owlmeans/planning'
 import { ProjectArea } from '../src/areas/consts.js'
@@ -14,6 +14,9 @@ import { STORY_DESIGN_VERSION } from '../src/design/consts.js'
 import { emptyStoryDesign } from '../src/design/helpers.js'
 import { StoryActor } from '../src/design/runtime.js'
 import type { StoryDesign } from '../src/design/types.js'
+import {
+  hasLandingSentence, LANDING_STORY_SENTENCE, withLandingSentence,
+} from '../src/index.js'
 import {
   isUserChannel, isViableProject, isViableStory, ProjectAgentOccupied, ProjectNotFound,
   ProjectStoryMissconfigured, projectBriefOf, storyDraftOf, storyWriteInputOf, userStoryOf,
@@ -255,9 +258,24 @@ describe('viable-common - the viable field schemas', () => {
     expect(project({
       formerAliases: ['old-name'], language: 'en', blueprint: 'owlmeans', blueprintCase: 'web',
       target: null, connectLlmMode: 'local', origin: { kind: 'github', repoUrl: 'https://x/y' },
+      landing: { story: 'US-ABC12', at },
     })).toBe(true)
     expect(project({ alias: 'slot-booker' })).toBe(false)
   })
+
+  test('a story carries the landing flag, spelled or nulled', () => {
+    expect(story({ area: ProjectArea.User, primary: false, landing: true })).toBe(true)
+    expect(story({ area: ProjectArea.User, primary: false, landing: null })).toBe(true)
+    expect(story({ area: ProjectArea.User, primary: false, landing: 'yes' })).toBe(false)
+  })
+
+  test('a project records a decided "no gate" as story null, and never a decision without a time', () => {
+    // Absent = never decided; `story: null` = decided, no gate. Both must be spellable.
+    expect(project({ landing: { story: null, at } })).toBe(true)
+    expect(project({ landing: null })).toBe(true)
+    expect(project({ landing: { story: 'US-ABC12' } })).toBe(false)
+    expect(project({ landing: { story: 'US-ABC12', at, reason: 'best fit' } })).toBe(false)
+  })
 })
 
 describe('viable-common - the viable card helpers', () => {
@@ -311,6 +329,16 @@ describe('viable-common - the viable card helpers', () => {
       .toThrow(ProjectStoryMissconfigured)
   })
 
+  test('storyWriteInputOf copies the landing flag from the card, and only when it is set', () => {
+    const content = {
+      userStory: userStoryOf(storyCard()), screenPaths: {}, componentPaths: {}, transitions: [],
+    }
+    const landing = storyCard({ fields: { area: ProjectArea.User, primary: false, landing: true } })
+
+    expect(storyWriteInputOf(landing, content).landing).toBe(true)
+    expect('landing' in storyWriteInputOf(storyCard(), content)).toBe(false)
+  })
+
   test('only a person writes through the web and connect channels', () => {
     expect(isUserChannel(ViableChannel.Web)).toBe(true)
     expect(isUserChannel(ViableChannel.Connect)).toBe(true)
@@ -319,6 +347,33 @@ describe('viable-common - the viable card helpers', () => {
   })
 })
 
+describe('viable-common - the landing sentence', () => {
+  test('is appended once, with one space, and a resumed step never adds a second copy', () => {
+    const once = withLandingSentence('A member books a slot.')
+
+    expect(once).toBe(`A member books a slot. ${LANDING_STORY_SENTENCE}`)
+    expect(withLandingSentence(once)).toBe(once)
+    expect(hasLandingSentence(once)).toBe(true)
+    expect(hasLandingSentence('A member books a slot.')).toBe(false)
+  })
+
+  test('is recognised whatever whitespace a person left around it', () => {
+    const rewrapped = `A member books a slot.\n${LANDING_STORY_SENTENCE.replace('; after', ';\n  after')}`
+
+    expect(hasLandingSentence(rewrapped)).toBe(true)
+    expect(withLandingSentence(rewrapped)).toBe(rewrapped)
+  })
+
+  test('never makes a title longer than a card accepts, and never cuts the narrative', () => {
+    const long = 'x'.repeat(TITLE_MAX - 10)
+
+    expect(withLandingSentence(long)).toBe(long)
+    expect(withLandingSentence('x'.repeat(TITLE_MAX - LANDING_STORY_SENTENCE.length - 1)).length)
+      .toBe(TITLE_MAX)
+    expect(withLandingSentence('  ')).toBe(LANDING_STORY_SENTENCE)
+  })
+})
+
 describe('viable-common - the follows anchor', () => {
   test('mergeConnectingStories carries the clamped anchor on each connective entry', () => {
     const flow = [

package/tests/scaffold.spec.ts

@@ -0,0 +1,131 @@
+import { describe, expect, test } from 'bun:test'
+import Ajv from 'ajv'
+import { validateSpecificationBody } from '@owlmeans/planning'
+import { ProjectArea } from '../src/areas/consts.js'
+import { ViableSpecCategory, VIABLE_PROJECT_SLOTS } from '../src/planning/index.js'
+import { BENTO_FRAGMENT_KINDS, WidgetKind } from '../src/scaffold/consts.js'
+import { ScaffoldPlanSchema } from '../src/scaffold/schemas.js'
+import type { ScaffoldPlan } from '../src/scaffold/types.js'
+
+/**
+ * The scaffold plan's schema is TWO things at once: the shape a model answers with, and the
+ * validator of the project card's `scaffold` document. A plan written before the landing-page
+ * overhaul carries none of its fields, and must still pass — or that project's plan can never be
+ * revised again. Compiled the way the planning registry compiles it (no formats, not strict).
+ */
+const oldPlan = (): ScaffoldPlan => ({
+  identity: { name: 'Crumb & Crust', description: 'Recipes and bakes from a welcoming community.' },
+  guestHome: {
+    hero: { headline: 'Find your next bake.', sub: 'Photo-led recipes.', cta: 'Get started', eyebrow: 'New' },
+    problem: { title: 'Inspiration lacks detail', text: 'A bake is easy to find.' },
+    solution: { title: 'Bakes worth making', text: 'The full process in one place.' },
+    features: [{ title: 'Complete recipes', text: 'Clear ingredient lists.' }],
+    testimonials: [{ quote: 'I found a rye loaf.', name: 'Mara L.', role: 'Home baker' }],
+  },
+  areas: [{ area: ProjectArea.Guest, intro: { title: 'Welcome', text: 'Browse.' }, sections: ['Bakes'] }],
+  stories: [{
+    code: 'US-ABC12',
+    section: 'Bakes',
+    screen: 'Bakes/Find a bake',
+    widget: { kind: WidgetKind.List, title: 'Bake finder', description: 'Bakes you can make.' },
+    sketch: { headline: 'Your bakes', caption: 'What you can bake', items: ['Rye loaf'] },
+    home: true,
+  }],
+  motifs: 'A rye loaf on a board.',
+})
+
+const newPlan = (): ScaffoldPlan => {
+  const plan = oldPlan()
+
+  return {
+    ...plan,
+    guestHome: {
+      ...plan.guestHome,
+      hero: {
+        headline: 'Find your next bake.', sub: 'Photo-led recipes.', cta: 'Get started',
+        secondary: { label: 'Browse bakes' },
+        browse: { label: 'Just browsing? Explore bakes', href: '#features' },
+      },
+      features: [
+        {
+          title: 'Complete recipes', text: 'Clear ingredient lists.',
+          fragment: {
+            kind: 'list', title: 'INGREDIENTS · 1 LOAF',
+            rows: [{ label: 'Rye flour', value: '350 g' }, { label: 'Water', value: '390 g' }],
+          },
+        },
+        { title: 'Baking notes', text: 'Small adjustments.', fragment: { kind: 'note', rows: [{ label: 'Drop the oven.' }] } },
+        { title: 'Photo-led bakes', text: 'Every idea starts with the bake.' },
+        { title: 'Baker attribution', text: 'See who made it.', fragment: { kind: 'people', rows: [{ label: 'Mara L.', value: 'Rye' }] } },
+      ],
+      steps: [
+        { title: 'Pick what you have', text: 'Tap the ingredients.' },
+        { title: 'See what you can bake', text: 'Ranked by your pantry.' },
+        { title: 'Open the full method', text: 'Sign in with your email.' },
+      ],
+      labels: { steps: 'How it works', stepsTitle: 'From pantry to basket.', problem: 'The problem' },
+      closing: {
+        headline: 'Your next bake starts here.', lead: 'Browse freely.', primary: 'Get started',
+        secondary: { label: 'Browse bakes' },
+        links: [{ title: 'Explore bakes', text: 'Open to everyone.' }, { title: 'Share your bake', text: 'Post it.', href: '#' }],
+      },
+      gate: {
+        story: 'US-ABC12',
+        target: 'web:bake-finder',
+        question: "What's in your pantry?",
+        hint: 'No account needed',
+        label: 'Your pantry',
+        inputs: ['Bread flour', 'Rye flour', 'Butter', 'Eggs', 'Yeast'],
+        selected: ['Bread flour', 'Rye flour', 'Butter', 'Yeast'],
+        results: [{ title: 'Seeded rye loaf', meta: 'Uses all 3 · 3 h 20 min', needs: ['Bread flour', 'Rye flour', 'Yeast'] }],
+        count: { one: '{n} bake matches', many: '{n} bakes match', none: 'No matches yet' },
+        empty: 'Pick two or more ingredients.',
+        note: 'Sign in with your email. Your picks come with you.',
+        cta: 'Open recipes →',
+        lock: 'Full method after sign-in',
+      },
+    },
+  }
+}
+
+describe('viable-common - the scaffold plan schema', () => {
+  const validate = new Ajv({ strict: false, allErrors: true }).compile(ScaffoldPlanSchema)
+  const slot = VIABLE_PROJECT_SLOTS.find(entry => entry.category === ViableSpecCategory.Scaffold)!
+
+  test('a plan stored before the landing overhaul still validates', () => {
+    expect(validate(oldPlan()), JSON.stringify(validate.errors)).toBe(true)
+    expect(() => validateSpecificationBody(slot, JSON.stringify(oldPlan()))).not.toThrow()
+  })
+
+  test('a plan carrying every new field validates', () => {
+    expect(validate(newPlan()), JSON.stringify(validate.errors)).toBe(true)
+    expect(() => validateSpecificationBody(slot, JSON.stringify(newPlan()))).not.toThrow()
+  })
+
+  test('a provider that spells an unset optional as null is accepted', () => {
+    const plan = newPlan() as unknown as { guestHome: Record<string, unknown> }
+    plan.guestHome.gate = null
+    plan.guestHome.closing = null
+    ;(plan.guestHome.hero as Record<string, unknown>).secondary = null
+
+    expect(validate(plan), JSON.stringify(validate.errors)).toBe(true)
+  })
+
+  test('still refuses an undeclared field and a fragment kind nothing can draw', () => {
+    const stray = newPlan() as unknown as { guestHome: Record<string, unknown> }
+    stray.guestHome.badge = 'New'
+    expect(validate(stray)).toBe(false)
+
+    const fragment = newPlan()
+    fragment.guestHome.features[0].fragment = { kind: 'chart' as never, rows: [] }
+    expect(validate(fragment)).toBe(false)
+  })
+
+  test('declares no count as minItems/maxItems — counts live in the descriptions', () => {
+    const text = JSON.stringify(ScaffoldPlanSchema)
+
+    expect(text).not.toContain('minItems')
+    expect(text).not.toContain('maxItems')
+    expect(BENTO_FRAGMENT_KINDS).toEqual(['list', 'note', 'people', 'steps'])
+  })
+})

package/tests/skills.spec.ts

@@ -1,7 +1,8 @@
 import { describe, expect, it } from 'bun:test'
 
-import { ViableSkill } from '../src/skills/consts.js'
-import { viableSkill } from '../src/skills/catalogue.js'
+import { SKILL_ORDER, ViableSkill } from '../src/skills/consts.js'
+import { VIABLE_SKILLS, viableSkill } from '../src/skills/catalogue.js'
+import { VIABLE_PERSONAS, ViablePersona } from '../src/skills/roles.js'
 
 /**
  * Pins the catalogue's own "wrap exactly once" teaching — the incident this guards against was
@@ -45,3 +46,63 @@ describe('viable-common catalogue — handler wrap-once', () => {
     }
   })
 })
+
+/**
+ * The prompt service SKIPS an alias it cannot resolve, so a skill in the enum with no body is a
+ * rule no model ever receives — nothing fails, the prompt simply lacks it.
+ */
+describe('viable-common catalogue — completeness', () => {
+  it('declares one body and one sort weight for every skill in the enum', () => {
+    const declared = VIABLE_SKILLS.map(entry => entry.alias)
+
+    expect(Object.values(ViableSkill).filter(alias => !declared.includes(alias))).toEqual([])
+    expect(new Set(declared).size).toBe(declared.length)
+    for (const alias of Object.values(ViableSkill)) {
+      expect(typeof SKILL_ORDER[alias], alias).toBe('number')
+    }
+  })
+})
+
+/**
+ * The house style is taught in two places a designer and a coder read — the visual designer's
+ * persona and the shadcn skill — and a template ships the same values. Neither may drift back
+ * to teaching the decoration the template now paints flat.
+ */
+describe('viable-common catalogue — the house style', () => {
+  it('ShadcnUi teaches the white ground, one accent and flat depth, and repaints the old classes', () => {
+    const body = viableSkill(ViableSkill.ShadcnUi).body
+
+    expect(body).toContain('bg-background')
+    expect(body).toContain('ONE product accent')
+    expect(body).toContain('shadow-floating')
+    expect(body).toContain('REPAINTED flat')
+    expect(body).toContain('explicitly asks')
+    expect(body).not.toContain('DECORATION VOCABULARY')
+    expect(body).not.toMatch(/\/\/ right[^\n]*gradient/)
+    expect(body).toContain('SelectItem')
+  })
+
+  it('the visual designer defaults to the house style and changes it only on an explicit ask', () => {
+    const role = VIABLE_PERSONAS[ViablePersona.VisualDesigner].role
+
+    expect(role).toContain('white ground')
+    expect(role).toContain('ONE')
+    expect(role).toContain('explicitly asks')
+    expect(role).not.toContain('expressive and bright')
+    expect(role).not.toMatch(/default to .*gradients/)
+  })
+
+  it('LandingGate teaches the gate card, the synchronous handoff and the screen that reads it', () => {
+    const body = viableSkill(ViableSkill.LandingGate).body
+
+    expect(body).toContain('data-home-gate')
+    expect(body).toContain('aria-pressed')
+    expect(body).toContain('writeLandingHandoff(target')
+    expect(body).toContain('readLandingHandoff')
+    expect(body).toContain('clearLandingHandoff()')
+    expect(body).toContain("useLogin(target)")
+    expect(body).toContain('SYNCHRONOUS')
+    expect(body).toContain('WRONG')
+    expect(body).not.toContain('${')
+  })
+})

package/build/connect/jobs.d.ts

@@ -1,25 +0,0 @@
-import type { ConnectJobKind } from './consts.js';
-/**
- * The separator a job id is joined with.
- *
- * `~`, because every other separator in play is already spoken for: a route alias is
- * colon-delimited and so is every run id (`init:<projectId>`, `story:<storyId>`), so a job id
- * built with one could not be split back apart.
- */
-export declare const JOB_SEPARATOR = "~";
-/**
- * A job's id: its kind, the project card it belongs to, and the subject it is about.
- *
- * The suffix is a CARD id for a story job and a run id for a pipeline job — never a story code.
- * Declared here rather than by whoever answers the job, because the SDK composes the id it then
- * polls for: two spellings of one id is a job nobody can find.
- */
-export declare const jobIdOf: (kind: ConnectJobKind, projectId: string, suffix?: string) => string;
-export interface ParsedJobId {
-    kind: ConnectJobKind;
-    projectId: string;
-    suffix?: string;
-}
-/** Split a job id back into what {@link jobIdOf} composed it from. */
-export declare const parseJobId: (jobId: string) => ParsedJobId;
-//# sourceMappingURL=jobs.d.ts.map

package/build/connect/jobs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"jobs.d.ts","sourceRoot":"","sources":["../../src/connect/jobs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjD;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,MAAM,CAAA;AAEhC;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,SAAU,cAAc,aAAa,MAAM,WAAW,MAAM,KAAG,MACP,CAAA;AAE5E,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,cAAc,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,sEAAsE;AACtE,eAAO,MAAM,UAAU,UAAW,MAAM,KAAG,WAW1C,CAAA"}

package/build/connect/jobs.js

@@ -1,29 +0,0 @@
-/**
- * The separator a job id is joined with.
- *
- * `~`, because every other separator in play is already spoken for: a route alias is
- * colon-delimited and so is every run id (`init:<projectId>`, `story:<storyId>`), so a job id
- * built with one could not be split back apart.
- */
-export const JOB_SEPARATOR = '~';
-/**
- * A job's id: its kind, the project card it belongs to, and the subject it is about.
- *
- * The suffix is a CARD id for a story job and a run id for a pipeline job — never a story code.
- * Declared here rather than by whoever answers the job, because the SDK composes the id it then
- * polls for: two spellings of one id is a job nobody can find.
- */
-export const jobIdOf = (kind, projectId, suffix) => [kind, projectId, ...(suffix != null ? [suffix] : [])].join(JOB_SEPARATOR);
-/** Split a job id back into what {@link jobIdOf} composed it from. */
-export const parseJobId = (jobId) => {
-    const [kind, projectId, ...rest] = jobId.split(JOB_SEPARATOR);
-    // A suffix may carry the separator back if one ever ends up in a card or run id, so the tail is
-    // rejoined rather than taken as its first segment.
-    const suffix = rest.length > 0 ? rest.join(JOB_SEPARATOR) : undefined;
-    return {
-        kind: kind,
-        projectId: projectId ?? '',
-        ...(suffix != null ? { suffix } : {}),
-    };
-};
-//# sourceMappingURL=jobs.js.map

package/build/connect/jobs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../src/connect/jobs.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,CAAA;AAEhC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAoB,EAAE,SAAiB,EAAE,MAAe,EAAU,EAAE,CAC1F,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;AAQ5E,sEAAsE;AACtE,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAe,EAAE;IACvD,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;IAC7D,gGAAgG;IAChG,mDAAmD;IACnD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAErE,OAAO;QACL,IAAI,EAAE,IAAsB;QAC5B,SAAS,EAAE,SAAS,IAAI,EAAE;QAC1B,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtC,CAAA;AACH,CAAC,CAAA"}

package/src/connect/jobs.ts

@@ -1,40 +0,0 @@
-import type { ConnectJobKind } from './consts.js'
-
-/**
- * The separator a job id is joined with.
- *
- * `~`, because every other separator in play is already spoken for: a route alias is
- * colon-delimited and so is every run id (`init:<projectId>`, `story:<storyId>`), so a job id
- * built with one could not be split back apart.
- */
-export const JOB_SEPARATOR = '~'
-
-/**
- * A job's id: its kind, the project card it belongs to, and the subject it is about.
- *
- * The suffix is a CARD id for a story job and a run id for a pipeline job — never a story code.
- * Declared here rather than by whoever answers the job, because the SDK composes the id it then
- * polls for: two spellings of one id is a job nobody can find.
- */
-export const jobIdOf = (kind: ConnectJobKind, projectId: string, suffix?: string): string =>
-  [kind, projectId, ...(suffix != null ? [suffix] : [])].join(JOB_SEPARATOR)
-
-export interface ParsedJobId {
-  kind: ConnectJobKind
-  projectId: string
-  suffix?: string
-}
-
-/** Split a job id back into what {@link jobIdOf} composed it from. */
-export const parseJobId = (jobId: string): ParsedJobId => {
-  const [kind, projectId, ...rest] = jobId.split(JOB_SEPARATOR)
-  // A suffix may carry the separator back if one ever ends up in a card or run id, so the tail is
-  // rejoined rather than taken as its first segment.
-  const suffix = rest.length > 0 ? rest.join(JOB_SEPARATOR) : undefined
-
-  return {
-    kind: kind as ConnectJobKind,
-    projectId: projectId ?? '',
-    ...(suffix != null ? { suffix } : {}),
-  }
-}