@taskforcehq/taskforce 0.3.170 → 0.3.301

package/dist/core/PlanEntitlementService.d.ts

@@ -0,0 +1,201 @@
+import type { DatabaseAdapter } from '../storage/databaseAdapter.js';
+import type { EntitlementState, PlanFeatureAccess, PlanFeatureSnapshot, PlanFeatureCatalogItem, PlanVersionSnapshot, PlanCatalogSnapshot, AccountEntitlementSnapshot, SeatUsageSnapshot, FeatureEvaluationResult, AccountAccessStatus, GlobalTaskforceSettings, SignupMonetizationSettings, SignupMonetizationValidationResult } from './types.js';
+export interface PlanEntitlementServiceDeps {
+    getWorkspaceOwnerUserId: (workspaceId: string) => string | null;
+    readGlobalConfig: () => GlobalTaskforceSettings;
+    writeGlobalConfig: (config: GlobalTaskforceSettings) => void;
+}
+/**
+ * Handles all plan catalog, plan version, and account entitlement logic.
+ * Extracted from Taskforce.ts to reduce monolith size.
+ */
+export declare class PlanEntitlementService {
+    private readonly db;
+    private readonly tenantId;
+    private readonly deps;
+    constructor(db: DatabaseAdapter, tenantId: string, deps: PlanEntitlementServiceDeps);
+    private generateEntityId;
+    private parseJsonObject;
+    normalizeEntitlementState(value: unknown): EntitlementState;
+    private normalizeFeatureAccess;
+    private readPositiveIntegerConfig;
+    private normalizePlanVersionTrialDays;
+    private readPlanVersionTrialDays;
+    private applyPlanVersionTrialDaysMetadata;
+    private sanitizePlanFeatureConfig;
+    private isEntitlementStateAllowed;
+    private repairPlanDefaultVersionIfNeeded;
+    repairPlanCatalogDefaultsIfNeeded(): void;
+    repairSignupMonetizationSettingsIfNeeded(): void;
+    normalizeLegacyPlanDataIfNeeded(): void;
+    private removeLegacyPlanFeatureRows;
+    private migrateLegacySeatLimitFeatureConfigToVersionSeatLimit;
+    private normalizeLegacyBillingMirrorRows;
+    backfillAccountEntitlements(): void;
+    private getRequiredDefaultPlanVersion;
+    private resolveCanonicalEntitlementStateFromBilling;
+    upsertCanonicalEntitlementRecord(input: {
+        accountId: string;
+        planVersionId: string;
+        state: EntitlementState;
+        effectiveAt?: string | null;
+        effectiveUntil?: string | null;
+        updatedBy: string;
+        createdAt?: string | null;
+        updatedAt?: string | null;
+    }): void;
+    private isFeatureEnabledForPlanMode;
+    private syncManagedTeamFeatures;
+    private normalizePlanFeatureDependencies;
+    private isTeamPlanVersion;
+    private assertSeatLimitCompatibleWithMode;
+    private buildPlanModeFeatures;
+    resolveWorkspaceLimitForUser(userId: string): {
+        limit: number | null;
+        feature: PlanFeatureSnapshot | null;
+    };
+    private planHasAnyActivePricing;
+    private tryGetDefaultPlanVersionByPlanId;
+    private getActiveDefaultPlanVersions;
+    private getDefaultPlanVersionByMode;
+    private tryGetDefaultPlanVersionByMode;
+    resolveRegistrationPlanAssignment(selectedPlanVersionIdRaw?: string): {
+        requiresPlanSelection: boolean;
+        planVersionId: string | null;
+        planId: string | null;
+    };
+    createUserBillingRecord(userId: string, options?: {
+        entitlementState?: string;
+        planId?: string | null;
+    }): void;
+    getUserEntitlement(userId: string): {
+        entitlementState: string;
+        tier: string;
+    };
+    hasAccountEntitlement(accountId: string): boolean;
+    private tryGetAccountEntitlement;
+    getAccountAccessStatus(accountId: string): AccountAccessStatus;
+    getEffectivePlanVersion(accountId: string): PlanVersionSnapshot;
+    getAccountEntitlement(accountId: string): AccountEntitlementSnapshot;
+    countWorkspaceSeatUsage(workspaceId: string, options?: {
+        includeInvited?: boolean;
+    }): SeatUsageSnapshot;
+    assertSeatAvailable(workspaceId: string): void;
+    evaluateFeatureAccess(input: {
+        userId: string;
+        workspaceId: string;
+        featureKey: string;
+        action?: string;
+        context?: Record<string, unknown>;
+    }): FeatureEvaluationResult;
+    getUserAccountPlanMode(userId: string): 'personal' | 'team';
+    setUserAccountPlanMode(userId: string, mode: 'personal' | 'team'): 'personal' | 'team';
+    getRequiredDefaultPlanVersionId(planId: string): string;
+    getDefaultPlanVersionIdByMode(mode: 'personal' | 'team', options?: {
+        allowFallback?: boolean;
+    }): string;
+    getBillingMirrorProfileForPlanVersion(planVersionId: string): {
+        planId: string;
+        entitlementState: EntitlementState;
+    };
+    getSignupMonetizationSettings(): SignupMonetizationSettings;
+    validateSignupMonetizationSettings(input?: Partial<SignupMonetizationSettings>): SignupMonetizationValidationResult;
+    private isValidEntitlementTransition;
+    addEntitlementAuditLog(input: {
+        actorUserId: string;
+        actorRole: string;
+        accountId: string;
+        action: string;
+        reason?: string;
+        before?: unknown;
+        after?: unknown;
+        requestId?: string;
+    }): void;
+    upsertPlanCatalog(input: {
+        planId: string;
+        displayName: string;
+        status?: 'active' | 'archived';
+        initialMode?: 'personal' | 'team';
+        initialSeatLimit?: number | null;
+        initialTrialDays?: number;
+    }): {
+        planId: string;
+        displayName: string;
+        status: 'active' | 'archived';
+    };
+    listPlanCatalog(): PlanCatalogSnapshot[];
+    listPlanFeatureCatalog(): PlanFeatureCatalogItem[];
+    listPlanVersions(planId: string): PlanVersionSnapshot[];
+    getPlanVersionFeatures(planId: string, versionId: string): PlanVersionSnapshot;
+    searchAccountsByEmail(query: string, limit?: number): Array<{
+        accountId: string;
+        email: string;
+        displayName: string | null;
+        disabled: boolean;
+    }>;
+    createPlanVersion(input: {
+        planId: string;
+        versionNumber: number;
+        isDefault?: boolean;
+        seatLimit?: number | null;
+        trialDays?: number;
+        metadata?: Record<string, unknown>;
+    }): PlanVersionSnapshot;
+    updatePlanVersion(input: {
+        planId: string;
+        versionNumber: number;
+        isDefault?: boolean;
+        seatLimit?: number | null;
+        trialDays?: number;
+        metadata?: Record<string, unknown>;
+    }): PlanVersionSnapshot;
+    getPlanVersionSnapshot(planVersionId: string): PlanVersionSnapshot;
+    updatePlanVersionFeatures(input: {
+        planVersionId: string;
+        features: Array<{
+            featureKey: string;
+            access: PlanFeatureAccess;
+            config?: Record<string, unknown>;
+        }>;
+    }): PlanVersionSnapshot;
+    updateAccountEntitlement(input: {
+        accountId: string;
+        planVersionId?: string;
+        entitlementState?: EntitlementState;
+        effectiveAt?: string | null;
+        effectiveUntil?: string | null;
+        actorUserId: string;
+        actorRole: string;
+        reason?: string;
+        requestId?: string;
+    }): AccountEntitlementSnapshot;
+    listEntitlementAuditLog(accountId: string, limit?: number, offset?: number): Array<{
+        id: string;
+        accountId: string;
+        action: string;
+        actorUserId: string;
+        actorRole: string;
+        reason: string | null;
+        before: Record<string, unknown>;
+        after: Record<string, unknown>;
+        createdAt: string;
+    }>;
+    getAccountEntitlementsPayload(input: {
+        userId: string;
+        workspaceId: string;
+    }): {
+        accountId: string;
+        workspaceId: string;
+        planId: string;
+        planVersionId: string;
+        state: EntitlementState;
+        effectiveAt: string | null;
+        effectiveUntil: string | null;
+        seatUsage: SeatUsageSnapshot;
+        features: Record<string, {
+            allowed: boolean;
+            access: PlanFeatureAccess;
+            config: Record<string, unknown>;
+        }>;
+    };
+}