Replaces SubscriptionPlanIds enum with union type

Author: eamodio

src/commands/quickWizard.base.ts

@@ -1,7 +1,6 @@
 import type { Disposable, InputBox, QuickInputButton, QuickPick, QuickPickItem } from 'vscode';
 import { InputBoxValidationSeverity, QuickInputButtons, window } from 'vscode';
 import type { GlCommands } from '../constants.commands';
-import { SubscriptionPlanId } from '../constants.subscription';
 import { Container } from '../container';
 import { Directive, isDirective, isDirectiveQuickPickItem } from '../quickpicks/items/directive';
 import { configuration } from '../system/-webview/configuration';
@@ -736,7 +735,7 @@ export abstract class QuickWizardCommandBase extends GlCommandBase {
 									}
 
 									case Directive.RequiresPaidSubscription:
-										void Container.instance.subscription.upgrade(SubscriptionPlanId.Pro, {
+										void Container.instance.subscription.upgrade('pro', {
 											source: 'quick-wizard',
 											detail: {
 												action: rootStep.command?.key,

src/constants.context.ts

@@ -1,9 +1,10 @@
 import type { Uri } from 'vscode';
 import type { AnnotationStatus, Keys } from './constants';
-import type { SubscriptionPlanId, SubscriptionState } from './constants.subscription';
+import type { SubscriptionState } from './constants.subscription';
 import type { CustomEditorTypes, GroupableTreeViewTypes, WebviewTypes, WebviewViewTypes } from './constants.views';
 import type { Features } from './features';
 import type { PromoKeys } from './plus/gk/models/promo';
+import type { SubscriptionPlanIds } from './plus/gk/models/subscription';
 import type { WalkthroughContextKeys } from './telemetry/walkthroughStateProvider';
 
 export type ContextKeys = {
@@ -21,7 +22,7 @@ export type ContextKeys = {
 	'gitlens:install:new': boolean;
 	/** Indicates that this is the first run after an upgrade of GitLens */
 	'gitlens:install:upgradedFrom': string;
-	'gitlens:plus': Exclude<SubscriptionPlanId, SubscriptionPlanId.Community>;
+	'gitlens:plus': Exclude<SubscriptionPlanIds, 'community'>;
 	'gitlens:plus:disabled': boolean;
 	'gitlens:plus:disallowedRepos': string[];
 	'gitlens:plus:required': boolean;

src/constants.subscription.ts

@@ -2,15 +2,6 @@ export const proFeaturePreviewUsages = 3;
 export const proFeaturePreviewUsageDurationInDays = 1;
 export const proTrialLengthInDays = 14;
 
-export const enum SubscriptionPlanId {
-	Community = 'community',
-	CommunityWithAccount = 'community-with-account',
-	Pro = 'pro',
-	Advanced = 'advanced',
-	Business = 'teams', // teams is the old name for Business; do not change
-	Enterprise = 'enterprise',
-}
-
 // NOTE: Pay attention to gitlens:plus:state in the `package.json` when modifying this enum
 // NOTE: This is reported in telemetry so we should NOT change the values
 export const enum SubscriptionState {
@@ -31,12 +22,3 @@ export const enum SubscriptionState {
 	/** Indicates a paid user */
 	Paid = 6,
 }
-
-export type SubscriptionStateString =
-	| 'verification'
-	| 'free'
-	| 'trial'
-	| 'trial-expired'
-	| 'trial-reactivation-eligible'
-	| 'paid'
-	| 'unknown';

src/constants.telemetry.ts

@@ -3,11 +3,11 @@ import type { WalkthroughSteps } from './constants';
 import type { AIProviders } from './constants.ai';
 import type { GlCommands, GlCommandsDeprecated } from './constants.commands';
 import type { IntegrationId, SupportedCloudIntegrationIds } from './constants.integrations';
-import type { SubscriptionState, SubscriptionStateString } from './constants.subscription';
+import type { SubscriptionState } from './constants.subscription';
 import type { CustomEditorTypes, TreeViewTypes, WebviewTypes, WebviewViewTypes } from './constants.views';
 import type { FeaturePreviews, FeaturePreviewStatus } from './features';
 import type { GitContributionTiers } from './git/models/contributor';
-import type { Subscription, SubscriptionAccount } from './plus/gk/models/subscription';
+import type { Subscription, SubscriptionAccount, SubscriptionStateString } from './plus/gk/models/subscription';
 import type { Flatten } from './system/object';
 import type { WalkthroughContextKeys } from './telemetry/walkthroughStateProvider';
 import type { GraphColumnConfig } from './webviews/plus/graph/protocol';

src/errors.ts

@@ -2,14 +2,14 @@ import type { Uri } from 'vscode';
 // eslint-disable-next-line @typescript-eslint/no-restricted-imports
 import { CancellationError as _CancellationError } from 'vscode';
 import type { Response } from '@env/fetch';
-import type { RequiredSubscriptionPlans, Subscription } from './plus/gk/models/subscription';
+import type { RequiredSubscriptionPlanIds, Subscription } from './plus/gk/models/subscription';
 import { isSubscriptionPaidPlan } from './plus/gk/utils/subscription.utils';
 
 export class AccessDeniedError extends Error {
 	public readonly subscription: Subscription;
-	public readonly required: RequiredSubscriptionPlans | undefined;
+	public readonly required: RequiredSubscriptionPlanIds | undefined;
 
-	constructor(subscription: Subscription, required: RequiredSubscriptionPlans | undefined) {
+	constructor(subscription: Subscription, required: RequiredSubscriptionPlanIds | undefined) {
 		let message;
 		if (subscription.account?.verified === false) {
 			message = 'Email verification required';

src/features.ts

@@ -1,7 +1,7 @@
 import type { StoredFeaturePreviewUsagePeriod } from './constants.storage';
 import { proFeaturePreviewUsageDurationInDays, proFeaturePreviewUsages } from './constants.subscription';
 import type { RepositoryVisibility } from './git/gitProvider';
-import type { RequiredSubscriptionPlans, Subscription } from './plus/gk/models/subscription';
+import type { RequiredSubscriptionPlanIds, Subscription } from './plus/gk/models/subscription';
 import { capitalize } from './system/string';
 
 // GitFeature's must start with `git:` to be recognized in all usages
@@ -53,7 +53,7 @@ export type FeatureAccess =
 	  }
 	| {
 			allowed: false | 'mixed';
-			subscription: { current: Subscription; required?: RequiredSubscriptionPlans };
+			subscription: { current: Subscription; required?: RequiredSubscriptionPlanIds };
 			visibility?: RepositoryVisibility;
 	  };
 
@@ -65,7 +65,7 @@ export type RepoFeatureAccess =
 	  }
 	| {
 			allowed: false;
-			subscription: { current: Subscription; required?: RequiredSubscriptionPlans };
+			subscription: { current: Subscription; required?: RequiredSubscriptionPlanIds };
 			visibility?: RepositoryVisibility;
 	  };
 

src/git/gitProviderService.ts

@@ -13,7 +13,6 @@ import { Disposable, EventEmitter, FileType, ProgressLocation, Uri, window, work
 import { isWeb } from '@env/platform';
 import { resetAvatarCache } from '../avatars';
 import { GlyphChars, Schemes } from '../constants';
-import { SubscriptionPlanId } from '../constants.subscription';
 import type { Container } from '../container';
 import { AccessDeniedError, ProviderNotFoundError, ProviderNotSupportedError } from '../errors';
 import type { FeatureAccess, PlusFeatures, RepoFeatureAccess } from '../features';
@@ -738,7 +737,7 @@ export class GitProviderService implements Disposable {
 		}
 
 		if (feature != null && (isProFeatureOnAllRepos(feature) || isAdvancedFeature(feature))) {
-			return { allowed: false, subscription: { current: subscription, required: SubscriptionPlanId.Pro } };
+			return { allowed: false, subscription: { current: subscription, required: 'pro' } };
 		}
 
 		function getRepoAccess(
@@ -755,7 +754,7 @@ export class GitProviderService implements Disposable {
 						if (visibility === 'private') {
 							return {
 								allowed: false,
-								subscription: { current: subscription, required: SubscriptionPlanId.Pro },
+								subscription: { current: subscription, required: 'pro' },
 								visibility: visibility,
 							};
 						}
@@ -791,13 +790,13 @@ export class GitProviderService implements Disposable {
 				case 'private':
 					return {
 						allowed: false,
-						subscription: { current: subscription, required: SubscriptionPlanId.Pro },
+						subscription: { current: subscription, required: 'pro' },
 						visibility: 'private',
 					};
 				case 'mixed':
 					return {
 						allowed: 'mixed',
-						subscription: { current: subscription, required: SubscriptionPlanId.Pro },
+						subscription: { current: subscription, required: 'pro' },
 					};
 				default:
 					return {

src/plus/ai/aiProviderService.ts

@@ -16,7 +16,6 @@ import {
 	vscodeProviderDescriptor,
 	xAIProviderDescriptor,
 } from '../../constants.ai';
-import { SubscriptionPlanId } from '../../constants.subscription';
 import type { AIGenerateDraftEventData, Source, TelemetryEvents } from '../../constants.telemetry';
 import type { Container } from '../../container';
 import {
@@ -990,9 +989,7 @@ export class AIProviderService implements Disposable {
 
 						if (isSubscriptionPaid(sub)) {
 							const plan =
-								compareSubscriptionPlans(sub.plan.actual.id, SubscriptionPlanId.Advanced) <= 0
-									? SubscriptionPlanId.Business
-									: SubscriptionPlanId.Advanced;
+								compareSubscriptionPlans(sub.plan.actual.id, 'advanced') <= 0 ? 'teams' : 'advanced';
 
 							const upgrade = { title: `Upgrade to ${getSubscriptionPlanName(plan)}` };
 							const result = await window.showErrorMessage(
@@ -1012,7 +1009,7 @@ export class AIProviderService implements Disposable {
 							);
 
 							if (result === upgrade) {
-								void this.container.subscription.upgrade(SubscriptionPlanId.Pro, source);
+								void this.container.subscription.upgrade('pro', source);
 							}
 						}
 

src/plus/gk/__debug__accountDebug.ts

@@ -1,16 +1,12 @@
 import type { Disposable } from 'vscode';
 import { ThemeIcon, window } from 'vscode';
-import {
-	proFeaturePreviewUsages,
-	proTrialLengthInDays,
-	SubscriptionPlanId,
-	SubscriptionState,
-} from '../../constants.subscription';
+import { proFeaturePreviewUsages, proTrialLengthInDays, SubscriptionState } from '../../constants.subscription';
 import type { Container } from '../../container';
 import type { QuickPickItemOfT } from '../../quickpicks/items/common';
 import { createQuickPickSeparator } from '../../quickpicks/items/common';
 import { registerCommand } from '../../system/-webview/command';
 import type { GKCheckInResponse, GKLicenses, GKLicenseType, GKUser } from './models/checkin';
+import type { PaidSubscriptionPlanIds, SubscriptionPlanIds } from './models/subscription';
 import type { SubscriptionService } from './subscriptionService';
 import { getConfiguredActiveOrganizationId } from './utils/-webview/subscription.utils';
 import { getSubscriptionFromCheckIn } from './utils/checkin.utils';
@@ -55,18 +51,14 @@ type SimulateQuickPickItem = QuickPickItemOfT<
 			state: SubscriptionState.Trial;
 			reactivatedTrial?: boolean;
 			expiredPaid?: never;
-			planId?: SubscriptionPlanId.Advanced;
+			planId?: Extract<'advanced', SubscriptionPlanIds>;
 			featurePreviews?: never;
 	  }
 	| {
 			state: SubscriptionState.Paid;
 			reactivatedTrial?: never;
 			expiredPaid?: boolean;
-			planId?:
-				| SubscriptionPlanId.Pro
-				| SubscriptionPlanId.Advanced
-				| SubscriptionPlanId.Business
-				| SubscriptionPlanId.Enterprise;
+			planId?: PaidSubscriptionPlanIds;
 			featurePreviews?: never;
 	  }
 >;
@@ -156,15 +148,15 @@ class AccountDebug {
 					label: 'Pro Trial (Advanced)',
 					description: 'Pro trial (advanced plan), account',
 					iconPath: new ThemeIcon('blank'),
-					item: { state: SubscriptionState.Trial, planId: SubscriptionPlanId.Advanced },
+					item: { state: SubscriptionState.Trial, planId: 'advanced' },
 				},
 				{
 					label: 'Pro Trial (Advanced, Reactivated)',
 					description: 'Pro trial (advanced plan), account',
 					iconPath: new ThemeIcon('blank'),
 					item: {
 						state: SubscriptionState.Trial,
-						planId: SubscriptionPlanId.Advanced,
+						planId: 'advanced',
 						reactivatedTrial: true,
 					},
 				},
@@ -185,25 +177,25 @@ class AccountDebug {
 					label: 'Pro',
 					description: 'Pro, account',
 					iconPath: new ThemeIcon('blank'),
-					item: { state: SubscriptionState.Paid, planId: SubscriptionPlanId.Pro },
+					item: { state: SubscriptionState.Paid, planId: 'pro' },
 				},
 				{
 					label: 'Advanced',
 					description: 'Advanced plan, account',
 					iconPath: new ThemeIcon('blank'),
-					item: { state: SubscriptionState.Paid, planId: SubscriptionPlanId.Advanced },
+					item: { state: SubscriptionState.Paid, planId: 'advanced' },
 				},
 				{
 					label: 'Business',
 					description: 'Business plan, account',
 					iconPath: new ThemeIcon('blank'),
-					item: { state: SubscriptionState.Paid, planId: SubscriptionPlanId.Business },
+					item: { state: SubscriptionState.Paid, planId: 'teams' },
 				},
 				{
 					label: 'Enterprise',
 					description: 'Enterprise plan, account',
 					iconPath: new ThemeIcon('blank'),
-					item: { state: SubscriptionState.Paid, planId: SubscriptionPlanId.Enterprise },
+					item: { state: SubscriptionState.Paid, planId: 'enterprise' },
 				},
 				// TODO: Update this subscription state once we have a "paid expired" state availale
 				{

src/plus/gk/models/subscription.ts

@@ -1,16 +1,18 @@
-import type { SubscriptionPlanId, SubscriptionState } from '../../../constants.subscription';
+import type { SubscriptionState } from '../../../constants.subscription';
 import type { Source } from '../../../constants.telemetry';
 import type { Organization } from './organization';
 
-export type FreeSubscriptionPlans = Extract<
-	SubscriptionPlanId,
-	SubscriptionPlanId.Community | SubscriptionPlanId.CommunityWithAccount
->;
-export type PaidSubscriptionPlans = Exclude<
-	SubscriptionPlanId,
-	SubscriptionPlanId.Community | SubscriptionPlanId.CommunityWithAccount
->;
-export type RequiredSubscriptionPlans = Exclude<SubscriptionPlanId, SubscriptionPlanId.Community>;
+export type SubscriptionPlanIds =
+	| 'community'
+	| 'community-with-account'
+	| 'pro'
+	| 'advanced'
+	| 'teams' /* the old name for Business; do not change */
+	| 'enterprise';
+
+export type FreeSubscriptionPlanIds = Extract<SubscriptionPlanIds, 'community' | 'community-with-account'>;
+export type PaidSubscriptionPlanIds = Exclude<SubscriptionPlanIds, FreeSubscriptionPlanIds>;
+export type RequiredSubscriptionPlanIds = Exclude<SubscriptionPlanIds, 'community'>;
 
 export interface Subscription {
 	readonly plan: {
@@ -27,7 +29,7 @@ export interface Subscription {
 }
 
 export interface SubscriptionPlan {
-	readonly id: SubscriptionPlanId;
+	readonly id: SubscriptionPlanIds;
 	readonly name: string;
 	readonly bundle: boolean;
 	readonly trialReactivationCount: number;
@@ -47,5 +49,14 @@ export interface SubscriptionAccount {
 }
 
 export interface SubscriptionUpgradeCommandArgs extends Source {
-	plan?: SubscriptionPlanId;
+	plan?: SubscriptionPlanIds;
 }
+
+export type SubscriptionStateString =
+	| 'verification'
+	| 'free'
+	| 'trial'
+	| 'trial-expired'
+	| 'trial-reactivation-eligible'
+	| 'paid'
+	| 'unknown';