@saasicat/spec 0.4.0 → 0.6.0

package/prisma-fragments/05-bundle-business-type.prisma

@@ -1,203 +0,0 @@
-// =============================================================================
-// SaaS platform Prisma fragment: Bundle + BusinessType (plan catalog extension)
-// =============================================================================
-//
-// REFERENCE SNIPPET — see 03-plan-versions.prisma for versioning conventions.
-//
-// Global catalog tables (no tenantId, no RLS). Write access only via the
-// SUPER_ADMIN guard in the AdminController of the `@saasicat/nest`
-// package. Entries are assigned to the respective consumer app via
-// `projectKey`.
-//
-// Versioning pattern identical to PlanVersion:
-//   - at most 1 draft (publishedAt IS NULL) per identity — constraint via a
-//     partial unique index in the migration.
-//   - multiple published versions, monotonically incremental `version`.
-//   - `supersededAt` marks "no longer actively marketed"; existing bookings
-//     stay on the committed version (contractual plan guarantee P1).
-//
-// Naming note: GESCHAEFTSTYP_SPEC §3.1 partly speaks of `BundleDefinition`
-// (with suffix) and `BusinessType` (without) — that is asymmetric. SPEC_V2
-// unified this to a consistent `Bundle` / `BusinessType` (each without the
-// `Definition` suffix). This file follows the V2 convention.
-
-// -----------------------------------------------------------------------------
-// Bundle — reusable component of features + quotas + pricing.
-//
-// Tenants do **not** book bundles directly; they are a SuperAdmin maintenance
-// shell that is referenced in BusinessType versions (m:n via
-// BusinessTypeBundle). Root entity without content — the purchasable fields
-// (features, quotas, pricing) live on BundleVersion.
-// -----------------------------------------------------------------------------
-
-model Bundle {
-    id          String   @id @default(uuid())
-    projectKey  String // e.g. 'clubapp' | 'demoapp' | …
-    bundleKey   String // SCREAMING_SNAKE_CASE, e.g. 'SPORT', 'ACCOUNTING', 'EVERSEND_PEPPOL'
-    label       String
-    description String?
-    icon        String?
-    sortOrder   Int      @default(0)
-
-    // Locale translations { "en": { label, description }, … }. SPEC_V2 §6.4.
-    i18n Json @default("{}")
-
-    createdAt DateTime  @default(now())
-    updatedAt DateTime  @updatedAt
-    deletedAt DateTime?
-
-    versions BundleVersion[]
-
-    @@unique([projectKey, bundleKey])
-    @@index([projectKey, deletedAt])
-    @@map("bundles")
-}
-
-// -----------------------------------------------------------------------------
-// BundleVersion — versioned composition (features, quotas, pricing).
-// `features` is FeatureKey[] (references Discovery / FeatureCatalogEntry).
-// `quotas` is Record<QuotaKey, number>; -1 = unlimited; missing key = 0.
-// `compatibility` is BundleCompatibility (`businessTypeKeys?` /
-// `planIds?` whitelists). Both empty = usable everywhere.
-// `pricingOverrides` is Array<BundlePricingOverride> for context-dependent
-// prices (see GESCHAEFTSTYP_SPEC §6.1, "most-specific wins").
-// -----------------------------------------------------------------------------
-
-model BundleVersion {
-    id            String  @id @default(uuid())
-    bundleId      String
-    version       Int
-    baseVersionId String? // predecessor; null for v1
-
-    features         Json // FeatureKey[]
-    quotas           Json @default("{}") // Record<QuotaKey, number>
-    compatibility    Json @default("{}") // BundleCompatibility
-    pricingOverrides Json @default("[]") // BundlePricingOverride[]
-
-    monthlyNet Decimal? @db.Decimal(10, 2) // default price; null = only via override
-    yearlyNet  Decimal? @db.Decimal(10, 2)
-    marketed   Boolean  @default(true)
-
-    publishedAt      DateTime?
-    supersededAt     DateTime?
-    publishedChanges Json? // VersionChange[] — diff to predecessor version
-    changeNote       String  @default("")
-    nonRegressive    Boolean @default(true)
-
-    createdByUserId   String?
-    publishedByUserId String?
-
-    createdAt DateTime @default(now())
-    updatedAt DateTime @updatedAt
-
-    bundle              Bundle               @relation(fields: [bundleId], references: [id], onDelete: Cascade)
-    baseVersion         BundleVersion?       @relation("BundleVersionLineage", fields: [baseVersionId], references: [id])
-    derivedVersions     BundleVersion[]      @relation("BundleVersionLineage")
-    businessTypeBundles BusinessTypeBundle[]
-
-    @@unique([bundleId, version])
-    @@index([bundleId, supersededAt])
-    @@index([bundleId, publishedAt])
-    @@map("bundle_versions")
-}
-
-// -----------------------------------------------------------------------------
-// BusinessType — business vertical (club type, industry variant).
-//
-// Examples for a club app: SPORT_VEREIN, MOSCHEE_GEMEINDE,
-// KIRCHEN_GEMEINDE, SOZIAL_TRAEGER. Example for a commerce app: AUTO_HANDEL.
-// At **most one** BusinessType is referenced per subscription (via the
-// associated BusinessTypeVersion). Multiple bundles at once = a dedicated
-// BusinessType that composes the bundles internally.
-// -----------------------------------------------------------------------------
-
-model BusinessType {
-    id              String   @id @default(uuid())
-    projectKey      String
-    businessTypeKey String // SCREAMING_SNAKE_CASE
-    label           String
-    description     String?
-    icon            String?
-    sortOrder       Int      @default(0)
-
-    createdAt DateTime  @default(now())
-    updatedAt DateTime  @updatedAt
-    deletedAt DateTime?
-
-    versions BusinessTypeVersion[]
-
-    @@unique([projectKey, businessTypeKey])
-    @@index([projectKey, deletedAt])
-    @@map("business_types")
-}
-
-// -----------------------------------------------------------------------------
-// BusinessTypeVersion — versioned composition of referenced bundles.
-// `quotaOverrides` is Partial<Record<QuotaKey, number>>; missing key →
-// Σ(bundle quotas), set key → replaces the sum (-1 = unlimited).
-// `monthlyNet` null → effective price = Σ(bundle prices). Set → override.
-// -----------------------------------------------------------------------------
-
-model BusinessTypeVersion {
-    id             String  @id @default(uuid())
-    businessTypeId String
-    version        Int
-    baseVersionId  String?
-
-    quotaOverrides Json @default("{}") // Partial<Record<QuotaKey, number>>
-
-    monthlyNet Decimal? @db.Decimal(10, 2) // null = Σ(bundle prices)
-    yearlyNet  Decimal? @db.Decimal(10, 2)
-    marketed   Boolean  @default(true)
-
-    publishedAt      DateTime?
-    supersededAt     DateTime?
-    publishedChanges Json?
-    changeNote       String  @default("")
-    nonRegressive    Boolean @default(true)
-
-    createdByUserId   String?
-    publishedByUserId String?
-
-    createdAt DateTime @default(now())
-    updatedAt DateTime @updatedAt
-
-    businessType    BusinessType          @relation(fields: [businessTypeId], references: [id], onDelete: Cascade)
-    baseVersion     BusinessTypeVersion?  @relation("BusinessTypeVersionLineage", fields: [baseVersionId], references: [id])
-    derivedVersions BusinessTypeVersion[] @relation("BusinessTypeVersionLineage")
-    bundles         BusinessTypeBundle[]
-
-    // Opposite side of Subscription.businessTypeVersion (01-subscription.prisma,
-    // M5). Subscription carries `businessTypeVersionId String?` plus the CHECK
-    // constraint "at least one of planVersionId / businessTypeVersionId set"
-    // (sql/constraints.postgres.sql).
-    subscriptionsCurrent Subscription[] @relation("SubscriptionBusinessTypeVersion")
-
-    @@unique([businessTypeId, version])
-    @@index([businessTypeId, supersededAt])
-    @@index([businessTypeId, publishedAt])
-    @@map("business_type_versions")
-}
-
-// -----------------------------------------------------------------------------
-// BusinessTypeBundle — m:n junction between BusinessTypeVersion and
-// BundleVersion. Stores the *concrete* BundleVersion (not just the root), so
-// that a published BusinessType stays deterministic — even when the bundle
-// later gets a newer version.
-// onDelete: Restrict for bundleVersion prevents deleting a BundleVersion that
-// is still referenced in an active BusinessTypeVersion (additionally a hard
-// block in the publish strict check).
-// -----------------------------------------------------------------------------
-
-model BusinessTypeBundle {
-    businessTypeVersionId String
-    bundleVersionId       String
-    sortOrder             Int    @default(0)
-
-    businessTypeVersion BusinessTypeVersion @relation(fields: [businessTypeVersionId], references: [id], onDelete: Cascade)
-    bundleVersion       BundleVersion       @relation(fields: [bundleVersionId], references: [id], onDelete: Restrict)
-
-    @@id([businessTypeVersionId, bundleVersionId])
-    @@index([bundleVersionId])
-    @@map("business_type_bundles")
-}