@wildo-ai/framework-knowledge 1.1.7 → 1.1.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/claude-marketplace/plugins/wildo/.claude-plugin/plugin.json +1 -1
- package/dist/claude-marketplace/plugins/wildo/references/composites-and-the-loop.md +9 -2
- package/dist/claude-marketplace/plugins/wildo/references/creation-state.md +21 -0
- package/dist/claude-marketplace/plugins/wildo/references/derived-artifacts.md +121 -0
- package/dist/claude-marketplace/plugins/wildo/references/runs-judges-and-questions.md +29 -5
- package/dist/claude-marketplace/plugins/wildo/skills/answer/SKILL.md +29 -2
- package/dist/claude-marketplace/plugins/wildo/skills/build/SKILL.md +69 -24
- package/dist/claude-marketplace/plugins/wildo/skills/doctor/SKILL.md +10 -0
- package/dist/claude-marketplace/plugins/wildo/skills/run/SKILL.md +21 -5
- package/dist/claude-marketplace/plugins/wildo/skills/start/SKILL.md +31 -5
- package/dist/claude-marketplace/plugins/wildo/skills/status/SKILL.md +2 -0
- package/dist/claude-marketplace/plugins/wildo/skills/why/SKILL.md +11 -1
- package/dist/esm/framework-knowledge.definitions.d.ts +1 -1
- package/dist/esm/framework-knowledge.definitions.d.ts.map +1 -1
- package/dist/esm/framework-knowledge.definitions.js +11 -1
- package/dist/esm/framework-knowledge.definitions.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.d.ts +2 -2
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.js +2 -2
- package/dist/esm/playbooks/bottom_up.assemble-verify/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.build/playbook.definition.d.ts +11 -11
- package/dist/esm/playbooks/bottom_up.build/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.build/playbook.definition.js +29 -22
- package/dist/esm/playbooks/bottom_up.build/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts +3 -3
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.js +59 -10
- package/dist/esm/playbooks/bottom_up.build-decompose/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.d.ts +1 -1
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.js +3 -3
- package/dist/esm/playbooks/bottom_up.build-dispatch/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.d.ts +1 -1
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js +1 -1
- package/dist/esm/playbooks/bottom_up.build-scale/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.conception/playbook.definition.js +1 -1
- package/dist/esm/playbooks/bottom_up.conception/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.d.ts +2 -1
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.js +5 -5
- package/dist/esm/playbooks/bottom_up.domain-plan/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts +8 -0
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js +12 -4
- package/dist/esm/playbooks/bottom_up.foundation/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.d.ts +25 -27
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.js +85 -43
- package/dist/esm/playbooks/top_down.brand-identity/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.brand-name-research/playbook.definition.d.ts +40 -0
- package/dist/esm/playbooks/top_down.brand-name-research/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.brand-name-research/playbook.definition.js +41 -0
- package/dist/esm/playbooks/top_down.brand-name-research/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.brand-name-screening-produce/playbook.definition.d.ts +199 -0
- package/dist/esm/playbooks/top_down.brand-name-screening-produce/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.brand-name-screening-produce/playbook.definition.js +201 -0
- package/dist/esm/playbooks/top_down.brand-name-screening-produce/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.brand-naming/playbook.definition.d.ts +67 -0
- package/dist/esm/playbooks/top_down.brand-naming/playbook.definition.d.ts.map +1 -0
- package/dist/esm/playbooks/top_down.brand-naming/playbook.definition.js +76 -0
- package/dist/esm/playbooks/top_down.brand-naming/playbook.definition.js.map +1 -0
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.d.ts +3 -1
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.js +27 -18
- package/dist/esm/playbooks/top_down.business-model/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.d.ts +11 -1
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.js +11 -11
- package/dist/esm/playbooks/top_down.compliance-analysis/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.d.ts +2 -0
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.js +3 -1
- package/dist/esm/playbooks/top_down.compliance-conception/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts +2 -0
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.js +3 -1
- package/dist/esm/playbooks/top_down.compliance-posture/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.definition/playbook.definition.d.ts +5 -2
- package/dist/esm/playbooks/top_down.definition/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.definition/playbook.definition.js +16 -4
- package/dist/esm/playbooks/top_down.definition/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.d.ts +7 -3
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.js +36 -2
- package/dist/esm/playbooks/top_down.phase-gate/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.risk-register/playbook.definition.d.ts +7 -1
- package/dist/esm/playbooks/top_down.risk-register/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.risk-register/playbook.definition.js +4 -2
- package/dist/esm/playbooks/top_down.risk-register/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.d.ts +9 -3
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.js +3 -3
- package/dist/esm/playbooks/top_down.scope-roadmap/playbook.definition.js.map +1 -1
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.d.ts +35 -2
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.d.ts.map +1 -1
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.js +30 -17
- package/dist/esm/playbooks/top_down.vision-elicitation/playbook.definition.js.map +1 -1
- package/dist/knowledge/assurance-authority-bases/wildo-safe-baseline-v1/authority-basis.json +1 -1
- package/dist/knowledge/assurance-authority-bases/wildo-safe-baseline-v1/external-framework-mapping.json +1 -1
- package/dist/knowledge/manifest.json +8 -8
- package/dist/knowledge/playbooks/bottom_up.assemble-verify/method.md +22 -7
- package/dist/knowledge/playbooks/bottom_up.assemble-verify/playbook.json +3 -3
- package/dist/knowledge/playbooks/bottom_up.build/method.md +17 -15
- package/dist/knowledge/playbooks/bottom_up.build/playbook.json +4 -3
- package/dist/knowledge/playbooks/bottom_up.build-decompose/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.build-decompose/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.build-decompose/method.md +117 -28
- package/dist/knowledge/playbooks/bottom_up.build-decompose/playbook.json +4 -4
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/method.md +133 -59
- package/dist/knowledge/playbooks/bottom_up.build-dispatch/playbook.json +2 -2
- package/dist/knowledge/playbooks/bottom_up.build-scale/method.md +169 -276
- package/dist/knowledge/playbooks/bottom_up.build-scale/playbook.json +2 -2
- package/dist/knowledge/playbooks/bottom_up.capability-composition/method.md +8 -1
- package/dist/knowledge/playbooks/bottom_up.capability-composition/playbook.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.conception/method.md +3 -2
- package/dist/knowledge/playbooks/bottom_up.conception/playbook.json +2 -2
- package/dist/knowledge/playbooks/bottom_up.domain-plan/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.domain-plan/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/bottom_up.domain-plan/method.md +22 -6
- package/dist/knowledge/playbooks/bottom_up.domain-plan/playbook.json +4 -3
- package/dist/knowledge/playbooks/bottom_up.foundation/playbook.json +13 -5
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/method.md +5 -2
- package/dist/knowledge/playbooks/refinement.compliance-document-candidate/playbook.json +1 -1
- package/dist/knowledge/playbooks/top_down.brand-identity/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/top_down.brand-identity/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/top_down.brand-identity/method.md +71 -37
- package/dist/knowledge/playbooks/top_down.brand-identity/playbook.json +35 -38
- package/dist/knowledge/playbooks/top_down.brand-name-research/method.md +105 -0
- package/dist/knowledge/playbooks/top_down.brand-name-research/playbook.json +55 -0
- package/dist/knowledge/playbooks/top_down.brand-name-screening-produce/evaluation-protocol.json +1 -0
- package/dist/knowledge/playbooks/top_down.brand-name-screening-produce/evaluation-treatment.json +1 -0
- package/dist/knowledge/playbooks/top_down.brand-name-screening-produce/method.md +78 -0
- package/dist/knowledge/playbooks/top_down.brand-name-screening-produce/playbook.json +63 -0
- package/dist/knowledge/playbooks/top_down.brand-naming/method.md +56 -0
- package/dist/knowledge/playbooks/top_down.brand-naming/playbook.json +65 -0
- package/dist/knowledge/playbooks/top_down.business-model/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/top_down.business-model/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/top_down.business-model/method.md +60 -6
- package/dist/knowledge/playbooks/top_down.business-model/playbook.json +15 -10
- package/dist/knowledge/playbooks/top_down.compliance-analysis/playbook.json +30 -10
- package/dist/knowledge/playbooks/top_down.compliance-conception/playbook.json +3 -1
- package/dist/knowledge/playbooks/top_down.compliance-posture/playbook.json +4 -1
- package/dist/knowledge/playbooks/top_down.definition/method.md +8 -3
- package/dist/knowledge/playbooks/top_down.definition/playbook.json +6 -4
- package/dist/knowledge/playbooks/top_down.phase-gate/evaluation-protocol.json +1 -1
- package/dist/knowledge/playbooks/top_down.phase-gate/evaluation-treatment.json +1 -1
- package/dist/knowledge/playbooks/top_down.phase-gate/playbook.json +11 -1
- package/dist/knowledge/playbooks/top_down.risk-register/method.md +21 -0
- package/dist/knowledge/playbooks/top_down.risk-register/playbook.json +8 -2
- package/dist/knowledge/playbooks/top_down.scope-roadmap/playbook.json +4 -2
- package/dist/knowledge/playbooks/top_down.vision-elicitation/method.md +10 -0
- package/dist/knowledge/playbooks/top_down.vision-elicitation/playbook.json +40 -17
- package/dist/knowledge/references/brand.name-choice.config.md +127 -0
- package/dist/knowledge/references/brand.name-screening.config.md +253 -0
- package/dist/knowledge/references/build-plan.task-graph.config.md +64 -11
- package/dist/knowledge/references/business-model.pricing-plan.config.md +16 -0
- package/dist/knowledge/references/business-model.snapshot.config.md +64 -0
- package/dist/knowledge/references/business-model.snapshot.validation.md +68 -4
- package/dist/knowledge/references/capability-composition.config.md +67 -4
- package/dist/knowledge/references/example.data-seeding.minimal.md +29 -1
- package/dist/knowledge/references/market.snapshot.validation.md +1 -1
- package/dist/knowledge/references/saas.data-seeding.bootstrap-wiring.md +7 -1
- package/dist/knowledge/references/saas.data-seeding.definition-input.md +6 -0
- package/dist/knowledge/references/saas.models.queue.scheduled-recovery.md +81 -2
- package/dist/knowledge/references/saas.specifications.companion-exports.contract.md +10 -0
- package/dist/knowledge/references/saas.website.astro.label-loader.md +9 -0
- package/dist/knowledge/references/saas.website.factories.define-section.md +4 -0
- package/dist/knowledge/references/saas.website.page-manifest.schema.md +12 -3
- package/dist/knowledge/references/saas.website.page-sections.component.md +72 -0
- package/dist/knowledge/references/saas.website.sections.definition-schema.md +11 -0
- package/dist/knowledge/registries/assurance-authority-bases.json +1 -1
- package/dist/knowledge/registries/framework-topics.json +38 -1
- package/dist/knowledge/registries/playbooks.json +68 -20
- package/dist/knowledge/registries/source-tags.json +748 -695
- package/dist/knowledge/rules/live-context-door.md +5 -2
- package/dist/knowledge/skills/INDEX.md +2 -1
- package/dist/knowledge/skills/application-database-migrations/SKILL.md +1 -1
- package/dist/knowledge/skills/brand-name-screening/SKILL.md +154 -0
- package/dist/knowledge/skills/brand-name-screening/references/framework-brand-name-screening-api.md +394 -0
- package/dist/knowledge/skills/brand-name-screening/references/screening-procedure.md +65 -0
- package/dist/knowledge/skills/compliance-document-authoring/references/document-composition-privacy-notice.md +5 -2
- package/dist/knowledge/skills/config-saas/SKILL.md +31 -4
- package/dist/knowledge/skills/config-saas/references/compliance-declarations.md +14 -1
- package/dist/knowledge/skills/config-saas/references/framework-background-work-api.md +81 -2
- package/dist/knowledge/skills/email-add-template/SKILL.md +1 -1
- package/dist/knowledge/skills/i18n-rerun-pipeline/SKILL.md +1 -1
- package/dist/knowledge/skills/inbound-channels/SKILL.md +2 -2
- package/dist/knowledge/skills/local-environment-bootstrap/SKILL.md +11 -1
- package/dist/knowledge/skills/local-environment-bootstrap/references/derived-artifact-currency.md +122 -0
- package/dist/knowledge/skills/local-environment-bootstrap/references/framework-upgrade-and-dependency-alignment.md +11 -0
- package/dist/knowledge/skills/local-environment-bootstrap/references/wildo-cli-bootstrap-commands.md +9 -2
- package/dist/knowledge/skills/market-companion-prompt-enrichment/SKILL.md +11 -1
- package/dist/knowledge/skills/market-companion-prompt-enrichment/references/framework-companion-behavior-api.md +11 -1
- package/dist/knowledge/skills/market-message-templates-authoring/references/framework-message-template-api.md +1 -1
- package/dist/knowledge/skills/market-snapshot-validation/SKILL.md +1 -1
- package/dist/knowledge/skills/market-snapshot-validation/references/framework-snapshot-validation-api.md +1 -1
- package/dist/knowledge/skills/module-companion-exports/references/companion-exports-by-package.md +10 -0
- package/dist/knowledge/skills/module-relationships/SKILL.md +6 -4
- package/dist/knowledge/skills/seeding-authoring/SKILL.md +51 -3
- package/dist/knowledge/skills/seeding-authoring/references/framework-data-seeding-api.md +6 -0
- package/dist/knowledge/skills/seeding-operations/references/framework-data-seeding-operations-api.md +7 -1
- package/dist/knowledge/skills/spec-companion-exports/references/framework-companion-exports-contract-api.md +10 -0
- package/dist/knowledge/skills/website-factory-advanced/SKILL.md +4 -0
- package/dist/knowledge/skills/website-page-authoring/SKILL.md +84 -3
- package/dist/knowledge/skills/website-section-contact/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-contact/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-cta/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-cta/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-faq/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-faq/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-feature-benefit-summary/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-feature-benefit-summary/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-feature-detail/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-feature-detail/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-footer-cta/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-footer-cta/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-hero/SKILL.md +27 -9
- package/dist/knowledge/skills/website-section-hero/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-pricing/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-pricing/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-section-social-proof/SKILL.md +15 -0
- package/dist/knowledge/skills/website-section-social-proof/references/define-website-section-api.md +15 -0
- package/dist/knowledge/skills/website-seo-aeo-geo/SKILL.md +1 -1
- package/dist/knowledge/skills/website-seo-aeo-geo/references/aeo-api.md +11 -0
- package/dist/knowledge/topic-index.json +169 -43
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +4 -4
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
# brand.name-screening.config
|
|
2
|
+
|
|
3
|
+
## Import Origins
|
|
4
|
+
|
|
5
|
+
- `@wildo-ai/saas-specifications`
|
|
6
|
+
|
|
7
|
+
## Source Excerpts
|
|
8
|
+
|
|
9
|
+
### Origin Package: `@wildo-ai/saas-specifications`
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
*
|
|
13
|
+
* The **brand-name screening** — the candidate names the companion PROPOSED (and any the creator asked
|
|
14
|
+
* to have screened), each checked against the public trademark registers of the jurisdictions the
|
|
15
|
+
* application targets. Artifact family `brand-name-screening`, produced by the `top_down.brand-naming`
|
|
16
|
+
* step; the `top_down.brand-identity` interview offers the creator a CHOICE computed from it.
|
|
17
|
+
*
|
|
18
|
+
* ## What this is, and what it is not
|
|
19
|
+
*
|
|
20
|
+
* A **minimal trademark screening — not a legal clearance opinion.** It records which registers were
|
|
21
|
+
* searched, for which classes, with which match types, on which day, and what each returned, so a
|
|
22
|
+
* reader can see exactly how far the check went. It never says a name is "available" or "cleared":
|
|
23
|
+
* consult an IP professional before filing or launching under any name recorded here.
|
|
24
|
+
*
|
|
25
|
+
* ## Why it exists
|
|
26
|
+
*
|
|
27
|
+
* On a first real run the brand name was a required pre-run free-text question. The creator expected
|
|
28
|
+
* proposals, a coding assistant improvised four names in chat with no check at all, and one of them was
|
|
29
|
+
* almost certainly a registered software mark. The name is printed on every surface and rendered into
|
|
30
|
+
* the logo, so the cheapest moment to catch a conflict is before anyone chooses.
|
|
31
|
+
*
|
|
32
|
+
* ## The outcome is DERIVED, never authored
|
|
33
|
+
*
|
|
34
|
+
* There is no `outcome` field on a candidate. {@link deriveBrandNameTrademarkOutcome} computes it from
|
|
35
|
+
* the register queries — a conflict on any query is a CONFLICT; a jurisdiction, class or match type no
|
|
36
|
+
* clear query covered, or any query that could not be completed, is UNKNOWN; only full coverage with
|
|
37
|
+
* every query clear is CLEAR. So a model cannot label a half-checked name clear: an unchecked register
|
|
38
|
+
* is simply an uncovered jurisdiction, and the derivation reads it as UNKNOWN.
|
|
39
|
+
*/
|
|
40
|
+
|
|
41
|
+
/** The payload-format version of a brand-name screening. */
|
|
42
|
+
export enum BrandNameScreeningVersion {
|
|
43
|
+
V1 = 'v1',
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/** Who put a candidate on the list. The companion proposes; the creator may ask for their own names to be screened. */
|
|
47
|
+
export enum BrandNameCandidateOrigin {
|
|
48
|
+
/** Proposed by the companion from the vision and the market snapshot. */
|
|
49
|
+
COMPANION_PROPOSED = 'COMPANION_PROPOSED',
|
|
50
|
+
/** A name the creator supplied, screened exactly like a proposed one. */
|
|
51
|
+
CREATOR_SUPPLIED = 'CREATOR_SUPPLIED',
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* The public register a query was run against.
|
|
56
|
+
*
|
|
57
|
+
* `NATIONAL_OFFICE` covers any national IP office (DPMA, INPI, UKIPO, USPTO, …); which country it is
|
|
58
|
+
* lives in the query's `jurisdictionsCovered`, so the vocabulary does not hard-code one market.
|
|
59
|
+
*/
|
|
60
|
+
export enum BrandNameTrademarkRegister {
|
|
61
|
+
/** EUIPO's EU trade mark register (eSearch plus) — EU-wide marks. */
|
|
62
|
+
EUIPO_EUTM = 'EUIPO_EUTM',
|
|
63
|
+
/** TMview — the EUIPO-hosted aggregator over the EU office and participating national offices. */
|
|
64
|
+
TMVIEW = 'TMVIEW',
|
|
65
|
+
/** WIPO Global Brand Database — international (Madrid) registrations and many national collections. */
|
|
66
|
+
WIPO_GLOBAL_BRAND_DATABASE = 'WIPO_GLOBAL_BRAND_DATABASE',
|
|
67
|
+
/** A national IP office's own register. */
|
|
68
|
+
NATIONAL_OFFICE = 'NATIONAL_OFFICE',
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/** How close a register hit had to be to count. A screening searches both. */
|
|
72
|
+
export enum BrandNameMatchType {
|
|
73
|
+
/** The same mark, ignoring case and spacing. */
|
|
74
|
+
IDENTICAL = 'IDENTICAL',
|
|
75
|
+
/** Plurals, hyphenation, transposed or substituted letters, and common phonetic variants. */
|
|
76
|
+
NEAR_IDENTICAL = 'NEAR_IDENTICAL',
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/** What one register query returned. `UNKNOWN` is a query that could not be completed — never a clear one. */
|
|
80
|
+
export enum BrandNameTrademarkQueryOutcome {
|
|
81
|
+
/** Searched, at full coverage, and no live identical or near-identical mark found. */
|
|
82
|
+
CLEAR = 'CLEAR',
|
|
83
|
+
/** At least one live identical or near-identical mark in a searched class. */
|
|
84
|
+
CONFLICT = 'CONFLICT',
|
|
85
|
+
/** The register was unreachable, the search could not be run, or its result could not be read. */
|
|
86
|
+
UNKNOWN = 'UNKNOWN',
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
/** The status of a conflicting mark. Only LIVE marks are recorded: an expired or withdrawn mark is not a conflict. */
|
|
90
|
+
export enum BrandNameConflictingMarkStatus {
|
|
91
|
+
REGISTERED = 'REGISTERED',
|
|
92
|
+
/** Filed and not yet registered, including under opposition. */
|
|
93
|
+
PENDING = 'PENDING',
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/** What a domain check found. Recorded as a signal beside the registers, never a blocker. */
|
|
97
|
+
export enum BrandNameDomainStatus {
|
|
98
|
+
REGISTERED = 'REGISTERED',
|
|
99
|
+
AVAILABLE = 'AVAILABLE',
|
|
100
|
+
UNKNOWN = 'UNKNOWN',
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/** A candidate's derived trademark standing — see {@link deriveBrandNameTrademarkOutcome}. */
|
|
104
|
+
export enum BrandNameTrademarkOutcome {
|
|
105
|
+
CLEAR = 'CLEAR',
|
|
106
|
+
CONFLICT = 'CONFLICT',
|
|
107
|
+
UNKNOWN = 'UNKNOWN',
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/** The pseudo-jurisdiction an EU trade mark covers. */
|
|
111
|
+
export const EU_TRADE_MARK_JURISDICTION = 'EU';
|
|
112
|
+
/** The pseudo-jurisdiction an international (Madrid, via WIPO) registration covers. */
|
|
113
|
+
export const INTERNATIONAL_REGISTRATION_JURISDICTION = 'WO';
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* The EU member states (ISO 3166-1 alpha-2) — a target in any of them makes an EU trade mark relevant,
|
|
117
|
+
* because an EUTM has effect in every member state.
|
|
118
|
+
*/
|
|
119
|
+
export const EU_MEMBER_STATE_CODES: readonly string[] = [
|
|
120
|
+
'AT', 'BE', 'BG', 'HR', 'CY', 'CZ', 'DK', 'EE', 'FI', 'FR', 'DE', 'GR', 'HU', 'IE',
|
|
121
|
+
'IT', 'LV', 'LT', 'LU', 'MT', 'NL', 'PL', 'PT', 'RO', 'SK', 'SI', 'ES', 'SE',
|
|
122
|
+
];
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* A jurisdiction code: an ISO 3166-1 alpha-2 country, `EU` (an EU trade mark) or `WO` (an international
|
|
126
|
+
* registration). Stated as a description too, because a JSON schema shown to a generating model drops
|
|
127
|
+
* the refinement.
|
|
128
|
+
*/
|
|
129
|
+
export const BrandNameJurisdictionCodeSchema = z
|
|
130
|
+
.string()
|
|
131
|
+
.trim()
|
|
132
|
+
.regex(/^[A-Z]{2}$/)
|
|
133
|
+
.describe('ISO 3166-1 alpha-2 country code (e.g. "DE", "FR"), or "EU" for the EU trade mark, or "WO" for an international registration. Never a name.');
|
|
134
|
+
|
|
135
|
+
/** The first Nice class number. */
|
|
136
|
+
export const NICE_CLASS_MIN = 1;
|
|
137
|
+
/** The last Nice class number (the Nice Classification has 45 classes: 1–34 goods, 35–45 services). */
|
|
138
|
+
export const NICE_CLASS_MAX = 45;
|
|
139
|
+
|
|
140
|
+
/** The Nice classes every software product lives in: 9 (downloadable software) and 42 (SaaS). */
|
|
141
|
+
export const SOFTWARE_NICE_CLASSES: readonly number[] = [9, 42];
|
|
142
|
+
|
|
143
|
+
const NiceClassNumberSchema = z.number().int().min(NICE_CLASS_MIN).max(NICE_CLASS_MAX);
|
|
144
|
+
/** An ISO calendar date (`YYYY-MM-DD`): the day a check was made. */
|
|
145
|
+
const IsoDateSchema = z.iso.date();
|
|
146
|
+
|
|
147
|
+
/** One jurisdiction the screening covers, and where that target came from. */
|
|
148
|
+
export const BrandNameScreeningJurisdictionSchema = z.object({
|
|
149
|
+
code: BrandNameJurisdictionCodeSchema,
|
|
150
|
+
/** What declared this target — an ICP geography, a vision compliance detail, the application's configured jurisdictions. */
|
|
151
|
+
derivedFrom: NonEmptyStringSchema,
|
|
152
|
+
});
|
|
153
|
+
export type BrandNameScreeningJurisdiction = z.infer<typeof BrandNameScreeningJurisdictionSchema>;
|
|
154
|
+
|
|
155
|
+
/** One Nice class searched, and why this product lives in it. */
|
|
156
|
+
export const BrandNameScreeningNiceClassSchema = z.object({
|
|
157
|
+
classNumber: NiceClassNumberSchema,
|
|
158
|
+
rationale: NonEmptyStringSchema,
|
|
159
|
+
});
|
|
160
|
+
export type BrandNameScreeningNiceClass = z.infer<typeof BrandNameScreeningNiceClassSchema>;
|
|
161
|
+
|
|
162
|
+
/** A live mark a query found, with the record it was read from. */
|
|
163
|
+
export const BrandNameConflictingMarkSchema = z.object({
|
|
164
|
+
/** The mark as registered. */
|
|
165
|
+
mark: NonEmptyStringSchema,
|
|
166
|
+
owner: NonEmptyStringSchema.optional(),
|
|
167
|
+
/** The application or registration number on the register. */
|
|
168
|
+
registrationNumber: NonEmptyStringSchema.optional(),
|
|
169
|
+
/** The Nice classes the mark is registered or filed in. */
|
|
170
|
+
niceClasses: z.array(NiceClassNumberSchema).min(1),
|
|
171
|
+
status: z.enum(BrandNameConflictingMarkStatus).systemEnum('BrandNameConflictingMarkStatus'),
|
|
172
|
+
matchType: z.enum(BrandNameMatchType).systemEnum('BrandNameMatchType'),
|
|
173
|
+
/** The register record that was read. */
|
|
174
|
+
sourceUrl: z.url(),
|
|
175
|
+
});
|
|
176
|
+
export type BrandNameConflictingMark = z.infer<typeof BrandNameConflictingMarkSchema>;
|
|
177
|
+
|
|
178
|
+
/** One search of one register for one candidate. */
|
|
179
|
+
export const BrandNameTrademarkQuerySchema = z.object({
|
|
180
|
+
register: z.enum(BrandNameTrademarkRegister).systemEnum('BrandNameTrademarkRegister'),
|
|
181
|
+
/** The jurisdictions this search covers (`EU` for an EUTM search, `WO` for international registrations, country codes otherwise). */
|
|
182
|
+
jurisdictionsCovered: z.array(BrandNameJurisdictionCodeSchema).min(1),
|
|
183
|
+
niceClassesSearched: z.array(NiceClassNumberSchema).min(1),
|
|
184
|
+
matchTypesSearched: z.array(z.enum(BrandNameMatchType).systemEnum('BrandNameMatchType')).min(1),
|
|
185
|
+
outcome: z.enum(BrandNameTrademarkQueryOutcome).systemEnum('BrandNameTrademarkQueryOutcome'),
|
|
186
|
+
/** Every live mark found. Present exactly when the outcome is CONFLICT. */
|
|
187
|
+
conflictingMarks: z.array(BrandNameConflictingMarkSchema).default([]),
|
|
188
|
+
/** The search or results page that was read — what a reader opens to check this row. */
|
|
189
|
+
sourceUrl: z.url(),
|
|
190
|
+
checkedOn: IsoDateSchema,
|
|
191
|
+
/** Why an UNKNOWN query is unknown, or anything a reader needs to interpret the result. */
|
|
192
|
+
note: NonEmptyStringSchema.optional(),
|
|
193
|
+
});
|
|
194
|
+
export type BrandNameTrademarkQuery = z.infer<typeof BrandNameTrademarkQuerySchema>;
|
|
195
|
+
|
|
196
|
+
/** A domain checked for a candidate — exact match on `.com` and the main ccTLDs of the target countries. */
|
|
197
|
+
export const BrandNameDomainSignalSchema = z.object({
|
|
198
|
+
domain: NonEmptyStringSchema,
|
|
199
|
+
status: z.enum(BrandNameDomainStatus).systemEnum('BrandNameDomainStatus'),
|
|
200
|
+
checkedOn: IsoDateSchema,
|
|
201
|
+
sourceUrl: z.url().optional(),
|
|
202
|
+
});
|
|
203
|
+
export type BrandNameDomainSignal = z.infer<typeof BrandNameDomainSignalSchema>;
|
|
204
|
+
|
|
205
|
+
/** A company or product already trading under (or close to) the name in the same category. */
|
|
206
|
+
export const BrandNameSameCategoryUseSchema = z.object({
|
|
207
|
+
name: NonEmptyStringSchema,
|
|
208
|
+
sourceUrl: z.url(),
|
|
209
|
+
note: NonEmptyStringSchema.optional(),
|
|
210
|
+
});
|
|
211
|
+
export type BrandNameSameCategoryUse = z.infer<typeof BrandNameSameCategoryUseSchema>;
|
|
212
|
+
|
|
213
|
+
/** A competitor or alternative named in the market snapshot that the candidate is identical or confusingly close to. */
|
|
214
|
+
export const BrandNameCompetitorCollisionSchema = z.object({
|
|
215
|
+
/** The market snapshot's alternative ref, when the collision is with one of its alternatives. */
|
|
216
|
+
alternativeRef: NonEmptyStringSchema.optional(),
|
|
217
|
+
/** The competitor's name as the market snapshot names it. */
|
|
218
|
+
competitorName: NonEmptyStringSchema,
|
|
219
|
+
matchType: z.enum(BrandNameMatchType).systemEnum('BrandNameMatchType'),
|
|
220
|
+
});
|
|
221
|
+
export type BrandNameCompetitorCollision = z.infer<typeof BrandNameCompetitorCollisionSchema>;
|
|
222
|
+
|
|
223
|
+
/** One candidate name and everything its screening found. */
|
|
224
|
+
export const BrandNameCandidateSchema = z.object({
|
|
225
|
+
/** Stable ref (`name-<slug>`), stamped by the runtime. */
|
|
226
|
+
ref: z.string().regex(/^name-[a-z0-9]+(?:-[a-z0-9]+)*$/),
|
|
227
|
+
/** The exact, case-sensitive name. */
|
|
228
|
+
name: NonEmptyStringSchema,
|
|
229
|
+
origin: z.enum(BrandNameCandidateOrigin).systemEnum('BrandNameCandidateOrigin'),
|
|
230
|
+
/** Why this name fits: what in the vision and the market's category language and voice it answers. Empty for a creator-supplied name. */
|
|
231
|
+
rationale: NonEmptyStringSchema.optional(),
|
|
232
|
+
trademarkQueries: z.array(BrandNameTrademarkQuerySchema).default([]),
|
|
233
|
+
competitorCollisions: z.array(BrandNameCompetitorCollisionSchema).default([]),
|
|
234
|
+
domainSignals: z.array(BrandNameDomainSignalSchema).default([]),
|
|
235
|
+
sameCategoryUses: z.array(BrandNameSameCategoryUseSchema).default([]),
|
|
236
|
+
});
|
|
237
|
+
export type BrandNameCandidate = z.infer<typeof BrandNameCandidateSchema>;
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* THE brand-name screening payload — one per application. `jurisdictions` and `niceClasses` are the
|
|
241
|
+
* coverage every candidate is measured against: a candidate whose queries do not reach all of them is
|
|
242
|
+
* UNKNOWN, whatever its queries say.
|
|
243
|
+
*/
|
|
244
|
+
export const BrandNameScreeningSchema = z.object({
|
|
245
|
+
version: z.enum(BrandNameScreeningVersion).default(BrandNameScreeningVersion.V1),
|
|
246
|
+
/** The day the screening was run. */
|
|
247
|
+
screenedOn: IsoDateSchema,
|
|
248
|
+
jurisdictions: z.array(BrandNameScreeningJurisdictionSchema).min(1),
|
|
249
|
+
niceClasses: z.array(BrandNameScreeningNiceClassSchema).min(1),
|
|
250
|
+
candidates: z.array(BrandNameCandidateSchema).min(1),
|
|
251
|
+
});
|
|
252
|
+
export type BrandNameScreening = z.infer<typeof BrandNameScreeningSchema>;
|
|
253
|
+
```
|
|
@@ -364,6 +364,16 @@ export enum BuildPlanTaskProductKind {
|
|
|
364
364
|
* money and the pricing-surface facts (recommended, price disclosure, availability) the plan implies.
|
|
365
365
|
*/
|
|
366
366
|
APPLICATION_BILLING_PRODUCT = 'APPLICATION_BILLING_PRODUCT',
|
|
367
|
+
/**
|
|
368
|
+
* One data seed a module declares — rows the application creates for itself, named by the seed's
|
|
369
|
+
* `seedKey` (`crm:demo-customers`).
|
|
370
|
+
*
|
|
371
|
+
* The seed is its own file, `backend-api/src/modules/<module>/seeds/<seedKey with ':' as '.'>.seed.ts`,
|
|
372
|
+
* and it lands only once the module registers it — a seed file nothing imports never runs. Its
|
|
373
|
+
* {@link BuildPlanDataSeedContent} says whether it is REFERENCE data the application needs everywhere
|
|
374
|
+
* or DEMONSTRATION data that must never reach production.
|
|
375
|
+
*/
|
|
376
|
+
APPLICATION_DATA_SEED = 'APPLICATION_DATA_SEED',
|
|
367
377
|
/** One website page, registered in the website root config by its manifest. */
|
|
368
378
|
WEBSITE_PAGE = 'WEBSITE_PAGE',
|
|
369
379
|
/** One section of one website page, declared in that page's sections file. */
|
|
@@ -382,6 +392,27 @@ export enum BuildPlanTaskProductKind {
|
|
|
382
392
|
INBOUND_CHANNEL_HANDLER = 'INBOUND_CHANNEL_HANDLER',
|
|
383
393
|
}
|
|
384
394
|
|
|
395
|
+
|
|
396
|
+
/**
|
|
397
|
+
* What a data seed's rows ARE, which decides where they may exist.
|
|
398
|
+
*
|
|
399
|
+
* - `REFERENCE` — rows the application needs to work wherever it runs: a closed list, a default
|
|
400
|
+
* record, a system template. Every environment, production included.
|
|
401
|
+
* - `DEMONSTRATION` — sample rows that make a freshly created application look lived-in (customers,
|
|
402
|
+
* projects, a few records per list). They must never sit beside real rows, so the seed declares
|
|
403
|
+
* `allowedApplicationEnvironments` without `production`, and the task lands only once it does.
|
|
404
|
+
*/
|
|
405
|
+
export enum BuildPlanDataSeedContent {
|
|
406
|
+
REFERENCE = 'REFERENCE',
|
|
407
|
+
DEMONSTRATION = 'DEMONSTRATION',
|
|
408
|
+
}
|
|
409
|
+
|
|
410
|
+
/**
|
|
411
|
+
* A data seed's key: kebab-case segments joined by `:` (`crm:demo-customers`), the convention a
|
|
412
|
+
* `DataSeedDefinition` documents. Constrained here because the seed's FILE is derived from it.
|
|
413
|
+
*/
|
|
414
|
+
export const DATA_SEED_KEY_PATTERN: RegExp = /^[a-z0-9]+(?:-[a-z0-9]+)*(?::[a-z0-9]+(?:-[a-z0-9]+)*)*$/;
|
|
415
|
+
|
|
385
416
|
/**
|
|
386
417
|
* One artifact a task is accountable for. Closed by construction: a product the
|
|
387
418
|
* host cannot ask a question about is a product that can never be shown to have
|
|
@@ -451,6 +482,13 @@ export const BuildPlanTaskProductSchema = z.discriminatedUnion('kind', [
|
|
|
451
482
|
scope: z.enum(ProviderBindingScope).systemEnum('ProviderBindingScope'),
|
|
452
483
|
}),
|
|
453
484
|
z.strictObject({ kind: z.literal(BuildPlanTaskProductKind.APPLICATION_BILLING_PRODUCT).systemEnum('BuildPlanTaskProductKind'), productKey: SlugSchema }),
|
|
485
|
+
z.strictObject({
|
|
486
|
+
kind: z.literal(BuildPlanTaskProductKind.APPLICATION_DATA_SEED).systemEnum('BuildPlanTaskProductKind'),
|
|
487
|
+
seedKey: z.string().regex(DATA_SEED_KEY_PATTERN),
|
|
488
|
+
/** The resource whose rows the seed writes — the `resourceType` it declares. */
|
|
489
|
+
resourceRef: SlugSchema,
|
|
490
|
+
content: z.enum(BuildPlanDataSeedContent).systemEnum('BuildPlanDataSeedContent'),
|
|
491
|
+
}),
|
|
454
492
|
z.strictObject({ kind: z.literal(BuildPlanTaskProductKind.WEBSITE_PAGE).systemEnum('BuildPlanTaskProductKind'), pageRef: SlugSchema }),
|
|
455
493
|
z.strictObject({ kind: z.literal(BuildPlanTaskProductKind.WEBSITE_SECTION).systemEnum('BuildPlanTaskProductKind'), pageRef: SlugSchema, sectionRef: SlugSchema }),
|
|
456
494
|
z.strictObject({ kind: z.literal(BuildPlanTaskProductKind.DOCUMENTATION_CHAPTER).systemEnum('BuildPlanTaskProductKind'), chapterRef: SlugSchema }),
|
|
@@ -533,6 +571,9 @@ export function buildPlanTaskProductIdentities(product: BuildPlanTaskProduct): r
|
|
|
533
571
|
return [`${product.kind}:${product.scope}:${product.providerRef}`];
|
|
534
572
|
case BuildPlanTaskProductKind.APPLICATION_BILLING_PRODUCT:
|
|
535
573
|
return [`${product.kind}:${product.productKey}`];
|
|
574
|
+
// The key alone: two seeds may write one resource, and the key is what the seed run ledger tracks.
|
|
575
|
+
case BuildPlanTaskProductKind.APPLICATION_DATA_SEED:
|
|
576
|
+
return [`${product.kind}:${product.seedKey}`];
|
|
536
577
|
case BuildPlanTaskProductKind.WEBSITE_PAGE:
|
|
537
578
|
return [`${product.kind}:${product.pageRef}`];
|
|
538
579
|
case BuildPlanTaskProductKind.WEBSITE_SECTION:
|
|
@@ -556,6 +597,13 @@ export function buildPlanTaskProductIdentities(product: BuildPlanTaskProduct): r
|
|
|
556
597
|
*/
|
|
557
598
|
export const BILLING_CATALOG_SKILL_REF = 'configure-billing';
|
|
558
599
|
|
|
600
|
+
/**
|
|
601
|
+
* The skill every data-seed task is authored with (#2234): levels, modes, business keys, and the
|
|
602
|
+
* environment restriction that keeps demonstration rows out of production. The dispatch derives it from
|
|
603
|
+
* an `APPLICATION_DATA_SEED` product whatever the decomposer wrote.
|
|
604
|
+
*/
|
|
605
|
+
export const DATA_SEED_SKILL_REF = 'seeding-authoring';
|
|
606
|
+
|
|
559
607
|
export const BuildPlanTaskTargetSchema = z.discriminatedUnion('kind', [
|
|
560
608
|
z.strictObject({ kind: z.literal(BuildPlanTaskTargetKind.MODULE), moduleRef: ModuleRefSchema }),
|
|
561
609
|
z.strictObject({
|
|
@@ -683,15 +731,18 @@ export const BuildPlanTaskSchema = z.strictObject({
|
|
|
683
731
|
/**
|
|
684
732
|
* What this task is accountable to — traceability only, NEVER scope authority.
|
|
685
733
|
*
|
|
686
|
-
* The vocabulary is the
|
|
687
|
-
* and non-functional requirements, roadmap phases,
|
|
688
|
-
* constraints
|
|
689
|
-
*
|
|
690
|
-
*
|
|
734
|
+
* The vocabulary is the target aspects `BUILD_PLAN_FAMILY_ASPECTS` declares for this edge:
|
|
735
|
+
* functional and non-functional requirements, roadmap phases, the vision's success criteria and
|
|
736
|
+
* constraints, drafted features, pricing plans, and the brand's name, logo direction and visual
|
|
737
|
+
* tone. Each target after the first three was added because a producer had already been writing
|
|
738
|
+
* it (#629, #1433, #1835, #2221). A companion generation step serves what it consumes: the `logo`
|
|
739
|
+
* step serves the brand's logo direction and name.
|
|
691
740
|
*
|
|
692
|
-
*
|
|
693
|
-
*
|
|
694
|
-
*
|
|
741
|
+
* This schema accepts any non-empty string. Generation does not: the edge is DECLARED, so a key
|
|
742
|
+
* that resolves to no element of a target family (when that family has landed) is a dangling
|
|
743
|
+
* reference. The model is told so on retry, and the landing refuses it. That is why widening the
|
|
744
|
+
* vocabulary to what producers genuinely mean matters: a true link the vocabulary does not name
|
|
745
|
+
* fails generation. The workbench renders a key outside the vocabulary as visibly unresolved.
|
|
695
746
|
*/
|
|
696
747
|
servesRefs: z.array(NonEmptyStringSchema).default([]),
|
|
697
748
|
/**
|
|
@@ -715,9 +766,11 @@ export type BuildPlanTask = z.infer<typeof BuildPlanTaskSchema>;
|
|
|
715
766
|
* journey artifact selected by `MetaWorkflow_ArtifactSelector.family ===
|
|
716
767
|
* 'build-plan'` (the `family` vocabulary stays an open string owned by the
|
|
717
768
|
* selector surface; this note is the single place tying the SHAPE to the
|
|
718
|
-
* NAME). Produced by the build-decompose playbook, consumed
|
|
719
|
-
*
|
|
720
|
-
*
|
|
769
|
+
* NAME). Produced by the build-decompose playbook, consumed by
|
|
770
|
+
* build-dispatch (and build-scale, which runs the same branch): ready tasks
|
|
771
|
+
* are dispatched in parallel waves of up to the application's build
|
|
772
|
+
* parallelism (`wildo workbench parallelism`, 5 by default; 1 = one at a
|
|
773
|
+
* time).
|
|
721
774
|
*
|
|
722
775
|
* Invariants enforced here: unique task refs; every prerequisite names a task
|
|
723
776
|
* in this graph; no self-prerequisite. Cycle detection and ordering
|
|
@@ -40,6 +40,8 @@
|
|
|
40
40
|
* - **`targetSummary`** — who the plan is for, in prose ("mid-market teams
|
|
41
41
|
* of 10-50"). Optional. A human summary, distinct from the typed
|
|
42
42
|
* `targetIcpRefs` cross-reference.
|
|
43
|
+
* - **`proposalBasis`** — on a PROPOSED plan only: what the proposal was
|
|
44
|
+
* derived from (see `PricingTiersStatus` on the snapshot). Optional prose.
|
|
43
45
|
* - **`targetIcpRefs`** / **`includesRequirementRefs`** — OPTIONAL flat
|
|
44
46
|
* cross-references into the market family (ICP segments this plan targets)
|
|
45
47
|
* and the requirements family (functional requirements this plan
|
|
@@ -115,6 +117,20 @@ export const PricingPlanConfigSchema = z.object({
|
|
|
115
117
|
* Flat opaque strings (see `targetIcpRefs`).
|
|
116
118
|
*/
|
|
117
119
|
includesRequirementRefs: z.array(NonEmptyStringSchema).optional(),
|
|
120
|
+
/**
|
|
121
|
+
* WHY this tier exists, present only on a PROPOSED plan — the snapshot's
|
|
122
|
+
* `pricingTiers` is `PricingTiersStatus.PROPOSED`, i.e. the creator asked for
|
|
123
|
+
* the tiers to be proposed rather than naming them. Prose naming what the
|
|
124
|
+
* proposal was derived from: the ICP segment it serves and the requirements
|
|
125
|
+
* that separate it from the tier beside it ("serves icp-indie-maker; holds
|
|
126
|
+
* back the team-planning requirements the Team tier unlocks").
|
|
127
|
+
*
|
|
128
|
+
* Required on every plan of a proposed sketch and forbidden on every plan of
|
|
129
|
+
* a stated one (`validateBusinessModelLiteSnapshot` reports both). A basis on
|
|
130
|
+
* a creator-stated plan would claim a proposal nobody made; a proposal with no
|
|
131
|
+
* basis is a tier nobody can check.
|
|
132
|
+
*/
|
|
133
|
+
proposalBasis: NonEmptyStringSchema.optional(),
|
|
118
134
|
/** Optional per-entity authoring provenance. */
|
|
119
135
|
authored: BusinessModelAuthoredMetadataSchema.optional(),
|
|
120
136
|
});
|
|
@@ -54,6 +54,44 @@ export enum RevenueModelKind {
|
|
|
54
54
|
OTHER = 'other',
|
|
55
55
|
}
|
|
56
56
|
|
|
57
|
+
/**
|
|
58
|
+
* Where the snapshot's pricing TIERS came from — the creator's answer to "what
|
|
59
|
+
* tiers do you plan to sell?", recorded as a fact rather than inferred from the
|
|
60
|
+
* shape of `plans`.
|
|
61
|
+
*
|
|
62
|
+
* ## Why this is a field and not "plans is empty"
|
|
63
|
+
*
|
|
64
|
+
* An empty `plans` used to carry two meanings that send a reader to opposite
|
|
65
|
+
* places: "nobody has sketched pricing yet" (work owed) and "the creator has
|
|
66
|
+
* considered it and not decided" (a real answer, nothing owed). And a non-empty
|
|
67
|
+
* `plans` could not say whether its tiers were the creator's or a proposal the
|
|
68
|
+
* creator asked for. The generated contract (`BusinessModelLiteSnapshotGenerationSchema`)
|
|
69
|
+
* therefore requires this status, so an empty sketch is always a STATEMENT and
|
|
70
|
+
* never a vacuous `{}`.
|
|
71
|
+
*/
|
|
72
|
+
export enum PricingTiersStatus {
|
|
73
|
+
/** `plans` are the tiers the creator named. At least one plan. */
|
|
74
|
+
CREATOR_STATED = 'creator_stated',
|
|
75
|
+
/**
|
|
76
|
+
* The creator asked for tiers to be PROPOSED (typically "derive them from the
|
|
77
|
+
* market research"), so `plans` were derived rather than named. Each carries a
|
|
78
|
+
* `proposalBasis`, and none carries a price or scaling axis the creator did
|
|
79
|
+
* not state. At least one plan.
|
|
80
|
+
*
|
|
81
|
+
* This records ORIGIN, not a pending state: it stays `proposed` after the
|
|
82
|
+
* creator accepts the plans, because acceptance is the commit that lands the
|
|
83
|
+
* artifact, not a value of this field.
|
|
84
|
+
*/
|
|
85
|
+
PROPOSED = 'proposed',
|
|
86
|
+
/**
|
|
87
|
+
* The creator has not decided the tiers and did not ask for a proposal.
|
|
88
|
+
* `plans` is empty, and that emptiness is an answer, not a gap: nothing
|
|
89
|
+
* downstream may read it as "free" or as "no billing", because
|
|
90
|
+
* `revenueModel` still says how the product makes money.
|
|
91
|
+
*/
|
|
92
|
+
UNDECIDED = 'undecided',
|
|
93
|
+
}
|
|
94
|
+
|
|
57
95
|
/**
|
|
58
96
|
* THE business-model-lite-snapshot payload — a **single aggregate per
|
|
59
97
|
* product** (market / vision / requirements / roadmap style), NOT a keyed
|
|
@@ -100,6 +138,12 @@ export enum RevenueModelKind {
|
|
|
100
138
|
* surfaced as a WARN by `validateBusinessModelLiteSnapshot`, never a parse
|
|
101
139
|
* failure. Plans are NOT inherently ordered (unlike roadmap phases), so no
|
|
102
140
|
* `sequence` ordering key is modelled.
|
|
141
|
+
* - **`pricingTiers`** — where the plans came from (`PricingTiersStatus`):
|
|
142
|
+
* stated by the creator, proposed at the creator's request, or undecided
|
|
143
|
+
* (then `plans` is empty BY ANSWER). Optional on a hand-authored file; read
|
|
144
|
+
* it through `resolvePricingTiersStatus`, never directly, so the meaning of
|
|
145
|
+
* an absent value lives in one place. Its agreement with `plans` is checked
|
|
146
|
+
* by `validateBusinessModelLiteSnapshot`.
|
|
103
147
|
*
|
|
104
148
|
* Authored entirely in English (like the vision / market / requirements /
|
|
105
149
|
* roadmap families). Authoring-consistency (duplicate refs, ref format,
|
|
@@ -116,6 +160,26 @@ export const BusinessModelLiteSnapshotSchema = z.object({
|
|
|
116
160
|
revenueModel: z.enum(RevenueModelKind).optional(),
|
|
117
161
|
/** The pricing tiers / packages of the pricing sketch. Ref-addressable. */
|
|
118
162
|
plans: z.array(PricingPlanConfigSchema).default([]),
|
|
163
|
+
/** Where the plans came from. Optional — read through `resolvePricingTiersStatus`. */
|
|
164
|
+
pricingTiers: z.enum(PricingTiersStatus).optional(),
|
|
119
165
|
});
|
|
120
166
|
export type BusinessModelLiteSnapshot = z.infer<typeof BusinessModelLiteSnapshotSchema>;
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* The ONE place an absent `pricingTiers` is interpreted. Every reader that asks
|
|
170
|
+
* "are these tiers decided?" goes through here rather than re-deriving it.
|
|
171
|
+
*
|
|
172
|
+
* - declared → that value;
|
|
173
|
+
* - absent with plans → `CREATOR_STATED`. Exact rather than a fallback: the
|
|
174
|
+
* generated contract always declares the status, so an absent one can only
|
|
175
|
+
* come from a hand-authored file, and a person who wrote plans into the
|
|
176
|
+
* family file stated them;
|
|
177
|
+
* - absent and empty → `undefined`: NOT `UNDECIDED`. Nobody has answered, which
|
|
178
|
+
* is the "not sketched yet" state the validator reports as `NO_PLANS`.
|
|
179
|
+
* Conflating it with a considered "not decided" would silence that warning.
|
|
180
|
+
*/
|
|
181
|
+
export function resolvePricingTiersStatus(snapshot: Pick<BusinessModelLiteSnapshot, 'plans' | 'pricingTiers'>): PricingTiersStatus | undefined {
|
|
182
|
+
if (snapshot.pricingTiers !== undefined) return snapshot.pricingTiers;
|
|
183
|
+
return snapshot.plans.length > 0 ? PricingTiersStatus.CREATOR_STATED : undefined;
|
|
184
|
+
}
|
|
121
185
|
```
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
* check for type-asserted fixtures that bypass parsing, and the fail-soft
|
|
24
24
|
* cross-family ICP / requirement ref resolution.
|
|
25
25
|
*
|
|
26
|
-
* Rule table —
|
|
26
|
+
* Rule table — 10 kinds (scaffold depth, Phase J1 — deeper pricing / revenue
|
|
27
27
|
* analysis is Phase J2):
|
|
28
28
|
*
|
|
29
29
|
* | Kind | Severity | Trigger |
|
|
@@ -31,7 +31,9 @@
|
|
|
31
31
|
* | `INVALID_REF_FORMAT` | ERROR | A plan ref fails the shared pattern (single source of truth with the Zod schema). Defence in depth for type-asserted fixtures. |
|
|
32
32
|
* | `DUPLICATE_REF` | ERROR | Two plans share a ref — the collection silently loses one entity to last-wins indexing. |
|
|
33
33
|
* | `DUPLICATE_CROSS_REF` | WARN | The same target/include-ref is listed more than once on ONE plan's cross-ref list — the repeat is noise the catalog silently dedupes. Intra-snapshot, so it runs UNCONDITIONALLY (no external set needed) — each cross-ref list is its own namespace. |
|
|
34
|
-
* | `NO_PLANS` | WARN | `plans` empty — the business model sketches no pricing. |
|
|
34
|
+
* | `NO_PLANS` | WARN | `plans` empty and nobody has said why — the business model sketches no pricing. SILENT when `pricingTiers` is `UNDECIDED`: there the emptiness is the creator's recorded answer, not owed work. |
|
|
35
|
+
* | `PRICING_TIERS_CONTRADICT_PLANS` | ERROR | The declared `pricingTiers` disagrees with `plans`: `undecided` with plans present, or `creator_stated` / `proposed` with none. |
|
|
36
|
+
* | `PROPOSAL_BASIS_MISMATCH` | ERROR | A plan of a `proposed` sketch has no `proposalBasis`, or a plan of a `creator_stated` one has one. Read through `resolvePricingTiersStatus`, so a hand-authored file with plans and no status counts as stated. |
|
|
35
37
|
* | `NO_REVENUE_MODEL` | WARN | `plans` are authored but the product-level `revenueModel` is unset — the pricing sketch is classified per-plan (`PricingModelAxis`) but the product's headline revenue model is undeclared. GATED on `plans.length > 0`: an empty snapshot is already fully described by `NO_PLANS`, so this fires only for the sharper "sketched pricing, forgot the revenue model" state (no redundant double-warn on `{}`). |
|
|
36
38
|
* | `STALE_AUTHORED` | WARN | Any plan's `authored.lastAuthoredAt + reviewCadence < now`. No check when `reviewCadence` is undefined or `AS_NEEDED`. |
|
|
37
39
|
* | `UNKNOWN_ICP_REF` | ERROR | A `targetIcpRefs` entry does not resolve in `options.availableIcpRefs`. SKIPPED (fail-soft) when no set is passed — the families are decoupled and the catalog resolves refs. |
|
|
@@ -69,8 +71,26 @@ export enum BusinessModelLiteSnapshotIssueKind {
|
|
|
69
71
|
* NOT a duplicate.
|
|
70
72
|
*/
|
|
71
73
|
DUPLICATE_CROSS_REF = 'duplicate_cross_ref',
|
|
72
|
-
/**
|
|
74
|
+
/**
|
|
75
|
+
* `plans` empty and no recorded reason — the business model sketches no
|
|
76
|
+
* pricing (WARN). Not raised when `pricingTiers` is `UNDECIDED`: a considered
|
|
77
|
+
* "not decided yet" is an answer, and warning on it would teach the reader to
|
|
78
|
+
* skim the warning that means work is owed.
|
|
79
|
+
*/
|
|
73
80
|
NO_PLANS = 'no_plans',
|
|
81
|
+
/**
|
|
82
|
+
* The declared `pricingTiers` and the `plans` collection contradict each
|
|
83
|
+
* other — `undecided` while plans are present, or `creator_stated` /
|
|
84
|
+
* `proposed` with no plan. ERROR: one of the two statements is false, and a
|
|
85
|
+
* reader cannot tell which.
|
|
86
|
+
*/
|
|
87
|
+
PRICING_TIERS_CONTRADICT_PLANS = 'pricing_tiers_contradict_plans',
|
|
88
|
+
/**
|
|
89
|
+
* A plan's `proposalBasis` disagrees with where the tiers came from — missing
|
|
90
|
+
* on a plan of a `proposed` sketch (a proposal nobody can check), or present
|
|
91
|
+
* on a plan the creator stated (a proposal nobody made). ERROR.
|
|
92
|
+
*/
|
|
93
|
+
PROPOSAL_BASIS_MISMATCH = 'proposal_basis_mismatch',
|
|
74
94
|
/**
|
|
75
95
|
* `plans` are authored but the product-level `revenueModel` is unset. The
|
|
76
96
|
* pricing sketch classifies HOW each plan scales (`PricingModelAxis`) but
|
|
@@ -171,6 +191,7 @@ export function validateBusinessModelLiteSnapshot(
|
|
|
171
191
|
detectDuplicateRefs(snapshot, issues);
|
|
172
192
|
detectDuplicateCrossRefs(snapshot, issues);
|
|
173
193
|
detectIncompleteness(snapshot, issues);
|
|
194
|
+
detectPricingTiersDisagreement(snapshot, issues);
|
|
174
195
|
detectStaleAuthored(snapshot, options?.now ?? new Date(), issues);
|
|
175
196
|
detectUnknownCrossRefs(snapshot, options, issues);
|
|
176
197
|
|
|
@@ -257,7 +278,7 @@ function detectIncompleteness(
|
|
|
257
278
|
snapshot: BusinessModelLiteSnapshot,
|
|
258
279
|
issues: BusinessModelLiteSnapshotIssue[],
|
|
259
280
|
): void {
|
|
260
|
-
if (snapshot.plans.length === 0) {
|
|
281
|
+
if (snapshot.plans.length === 0 && resolvePricingTiersStatus(snapshot) !== PricingTiersStatus.UNDECIDED) {
|
|
261
282
|
issues.push({
|
|
262
283
|
kind: BusinessModelLiteSnapshotIssueKind.NO_PLANS,
|
|
263
284
|
path: 'plans',
|
|
@@ -278,6 +299,49 @@ function detectIncompleteness(
|
|
|
278
299
|
}
|
|
279
300
|
}
|
|
280
301
|
|
|
302
|
+
function detectPricingTiersDisagreement(
|
|
303
|
+
snapshot: BusinessModelLiteSnapshot,
|
|
304
|
+
issues: BusinessModelLiteSnapshotIssue[],
|
|
305
|
+
): void {
|
|
306
|
+
const declared = snapshot.pricingTiers;
|
|
307
|
+
if (declared === PricingTiersStatus.UNDECIDED && snapshot.plans.length > 0) {
|
|
308
|
+
issues.push({
|
|
309
|
+
kind: BusinessModelLiteSnapshotIssueKind.PRICING_TIERS_CONTRADICT_PLANS,
|
|
310
|
+
path: 'pricingTiers',
|
|
311
|
+
message: `pricingTiers is "undecided" but ${snapshot.plans.length} plan(s) are present — remove the plans, or declare where they came from.`,
|
|
312
|
+
severity: BusinessModelLiteSnapshotIssueSeverity.ERROR,
|
|
313
|
+
});
|
|
314
|
+
}
|
|
315
|
+
if ((declared === PricingTiersStatus.CREATOR_STATED || declared === PricingTiersStatus.PROPOSED) && snapshot.plans.length === 0) {
|
|
316
|
+
issues.push({
|
|
317
|
+
kind: BusinessModelLiteSnapshotIssueKind.PRICING_TIERS_CONTRADICT_PLANS,
|
|
318
|
+
path: 'pricingTiers',
|
|
319
|
+
message: `pricingTiers is "${declared}" but no plan is present — record the plans, or declare "undecided".`,
|
|
320
|
+
severity: BusinessModelLiteSnapshotIssueSeverity.ERROR,
|
|
321
|
+
});
|
|
322
|
+
}
|
|
323
|
+
|
|
324
|
+
const resolved = resolvePricingTiersStatus(snapshot);
|
|
325
|
+
snapshot.plans.forEach((entry, index) => {
|
|
326
|
+
if (resolved === PricingTiersStatus.PROPOSED && entry.proposalBasis === undefined) {
|
|
327
|
+
issues.push({
|
|
328
|
+
kind: BusinessModelLiteSnapshotIssueKind.PROPOSAL_BASIS_MISMATCH,
|
|
329
|
+
path: `plans[${index}].proposalBasis`,
|
|
330
|
+
message: `Plan "${entry.ref}" is a proposal but states no proposalBasis — name the ICP and requirements it was derived from.`,
|
|
331
|
+
severity: BusinessModelLiteSnapshotIssueSeverity.ERROR,
|
|
332
|
+
});
|
|
333
|
+
}
|
|
334
|
+
if (resolved === PricingTiersStatus.CREATOR_STATED && entry.proposalBasis !== undefined) {
|
|
335
|
+
issues.push({
|
|
336
|
+
kind: BusinessModelLiteSnapshotIssueKind.PROPOSAL_BASIS_MISMATCH,
|
|
337
|
+
path: `plans[${index}].proposalBasis`,
|
|
338
|
+
message: `Plan "${entry.ref}" was stated by the creator but carries a proposalBasis — remove it, or declare pricingTiers "proposed".`,
|
|
339
|
+
severity: BusinessModelLiteSnapshotIssueSeverity.ERROR,
|
|
340
|
+
});
|
|
341
|
+
}
|
|
342
|
+
});
|
|
343
|
+
}
|
|
344
|
+
|
|
281
345
|
function detectStaleAuthored(
|
|
282
346
|
snapshot: BusinessModelLiteSnapshot,
|
|
283
347
|
now: Date,
|