Factories

Import from @workspace/training/factories. A factory builds a valid, random instance of a training type for tests, API mocks and dev scenarios. Every type has one factory, it lives in packages/training/src/factories/, one file per entity, and the barrel exports them all.

Convention

• Signature (faker, overrides). The Faker instance is always a parameter, never the global one imported inside the factory: tests pass the shared faker, a scenario runner passes a seeded instance so a run replays identically. A factory that delegates to builders or other factories hands them the same instance. @faker-js/faker is a type-only import in the factory files.
• Defaults are random. A literal default is reserved for a field whose value is the type's neutral state (isArchived: false, review: {}). A test pins through overrides only the fields its assertions read.
• The owning package owns the factory. Consumers import it, never redeclare it. DTO factories live in @workspace/api-contract/factories and are built from these domain factories through the mappers.
• Production code never imports /factories. A Biome rule rejects @workspace/*/factories outside tests, packages/api-mock and the app dev chunk. /testing holds fakes and mocks only and does not re-export the factories, see Testing.

The repo-wide rules, the DTO factories of @workspace/api-contract, the @workspace/bridge/factories exemption and how to add a factory are in The /factories and /testing exports.

// A test pins only the fields its assertions read; everything else stays random.
export function archivedGroup(faker: Faker): Group {
  return makeGroup(faker, { isArchived: true, name: "Monday beginners" });
}

export function userTheme(faker: Faker, ownerLabel: string): BoardTheme {
  return makeBoardTheme(faker, {
    type: "user_theme",
    labels: { default: ownerLabel },
  });
}

// Factories compose: a nested factory receives the same faker instance.
export function premiumMonthly(faker: Faker): PlanWithPrices {
  return makePlanWithPrices(faker, { planKey: "premium", rank: 2 });
  // one monthly price whose planId is the plan's id
}

export function premiumWithoutPrices(faker: Faker): PlanWithPrices {
  return { ...makePlan(faker, { planKey: "premium" }), prices: [] };
}

export function editorRecord(faker: Faker, code: string) {
  return makePersistableEditorBoardWrite(faker, { code });
}

Catalogue

All factories take (faker: Faker, overrides: Partial<T> = {}) and return T, except where the table says otherwise.

Accounts

Boards and themes

Groups, students, sessions

Collections and sharing

Plans, subscriptions, entitlements

Ads and announcements

Emails

Events