Files
supabase/packages/common/enabled-features/index.ts
T
Alaister YoungandAlaister Young a47397d5fe fix(common): restore narrow Feature type (#50850)
The platform API now types `ProfileResponse.disabled_features` as
`string[]` (since #48981), which collapsed the `Feature` union to plain
`string`, so `isFeatureEnabled` accepted any string and typos went
uncaught.

**Changed:**
- `Feature` is now a local `RuntimeFeature` union (the profile-driven
flags) plus the keys of `enabled-features.json`, instead of deriving
from the API type
- `useIsFeatureEnabled` casts the merged runtime disabled list to
`Feature[]`, since the profile field is now `string[]`

The runtime feature list duplicates what the backend knows. Once the
enum is restored in the API spec, `Feature` can go back to deriving from
the generated type.

## To test

- `pnpm typecheck` passes
- Passing a bogus string to `useIsFeatureEnabled` / `isFeatureEnabled`
is now a type error
- Nothing behavioral changes, so a quick sanity check that the sidebar /
billing / org settings still render is enough


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **No user-facing changes**
* This update does not change the app’s visible features or behavior. It
includes internal typing adjustments only.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-09-25 17:21:38 +10:00

86 lines
2.7 KiB
TypeScript

import enabledFeaturesRaw from './enabled-features.json' with { type: 'json' }
const enabledFeaturesStaticObj = enabledFeaturesRaw as Omit<typeof enabledFeaturesRaw, '$schema'>
// Features the platform can disable per-user via the profile's `disabled_features`.
// The API types this as `string[]`, so the known values are listed here to keep `Feature` narrow.
type RuntimeFeature =
| 'organizations:create'
| 'organizations:delete'
| 'organization_members:create'
| 'organization_members:delete'
| 'projects:create'
| 'projects:transfer'
| 'project_auth:all'
| 'project_storage:all'
| 'project_edge_function:all'
| 'profile:update'
| 'billing:account_data'
| 'billing:credits'
| 'billing:invoices'
| 'billing:payment_methods'
| 'realtime:all'
export type Feature = RuntimeFeature | keyof typeof enabledFeaturesStaticObj
const disabledFeaturesStaticArray = Object.entries(enabledFeaturesStaticObj)
.filter(([_, value]) => !value)
.map(([key]) => key as Feature)
function checkFeature(feature: Feature, features: Set<Feature>) {
return !features.has(feature)
}
type SnakeToCamelCase<S extends string> = S extends `${infer First}_${infer Rest}`
? `${First}${SnakeToCamelCase<Capitalize<Rest>>}`
: S
type FeatureToCamelCase<S extends Feature> = S extends `${infer P}:${infer R}`
? `${SnakeToCamelCase<P>}${Capitalize<SnakeToCamelCase<R>>}`
: SnakeToCamelCase<S>
function featureToCamelCase(feature: Feature) {
return feature
.replace(/:/g, '_')
.split('_')
.map((word, index) => (index === 0 ? word : word[0].toUpperCase() + word.slice(1)))
.join('') as FeatureToCamelCase<typeof feature>
}
function isFeatureEnabled<T extends Feature[]>(
features: T,
runtimeDisabledFeatures?: Feature[]
): { [key in FeatureToCamelCase<T[number]>]: boolean }
function isFeatureEnabled(features: Feature, runtimeDisabledFeatures?: Feature[]): boolean
function isFeatureEnabled<T extends Feature | Feature[]>(
features: T,
runtimeDisabledFeatures?: Feature[]
) {
// Override is used to produce a filtered version of the docs search index
// using the same sync setup as our normal search index
if (process.env.ENABLED_FEATURES_OVERRIDE_DISABLE_ALL === 'true') {
if (Array.isArray(features)) {
return Object.fromEntries(features.map((feature) => [featureToCamelCase(feature), false]))
}
return false
}
const disabledFeatures = new Set([
...(runtimeDisabledFeatures ?? []),
...disabledFeaturesStaticArray,
])
if (Array.isArray(features)) {
return Object.fromEntries(
features.map((feature) => [
featureToCamelCase(feature),
checkFeature(feature, disabledFeatures),
])
)
}
return checkFeature(features, disabledFeatures)
}
export { isFeatureEnabled }