mirror of
https://github.com/outline/outline.git
synced 2026-11-20 21:23:06 +03:00
* fix: Spelling, grammar, punctuation, and translation string errors * fix: Remove duplicate period and comma splice from review feedback
76 lines
1.8 KiB
TypeScript
76 lines
1.8 KiB
TypeScript
import { makeObservable, observable, runInAction } from "mobx";
|
|
import Storage from "@shared/utils/Storage";
|
|
|
|
/**
|
|
* Available feature flags that can be toggled per-client.
|
|
*/
|
|
export enum Feature {
|
|
/** New collection permissions UI */
|
|
newCollectionSharing = "newCollectionSharing",
|
|
}
|
|
|
|
/** Default values for feature flags */
|
|
const FeatureDefaults: Record<Feature, boolean> = {
|
|
[Feature.newCollectionSharing]: true,
|
|
};
|
|
|
|
/**
|
|
* A simple feature flagging system that stores flags in browser storage.
|
|
*/
|
|
export class FeatureFlags {
|
|
/**
|
|
* Checks whether a feature flag is currently enabled.
|
|
*
|
|
* @param flag the feature flag to check.
|
|
* @returns true if the flag is enabled.
|
|
*/
|
|
public static isEnabled(flag: Feature) {
|
|
// init on first read
|
|
if (this.initialized === false) {
|
|
runInAction(() => {
|
|
this.cache = new Set();
|
|
for (const key of Object.values(Feature)) {
|
|
const value = Storage.get(key);
|
|
if (value === true) {
|
|
this.cache.add(key);
|
|
}
|
|
}
|
|
this.initialized = true;
|
|
});
|
|
}
|
|
|
|
return this.cache.has(flag) ? true : (FeatureDefaults[flag] ?? false);
|
|
}
|
|
|
|
/**
|
|
* Enables a feature flag and persists the value to browser storage.
|
|
*
|
|
* @param flag the feature flag to enable.
|
|
*/
|
|
public static enable(flag: Feature) {
|
|
runInAction(() => {
|
|
this.cache.add(flag);
|
|
});
|
|
Storage.set(flag, true);
|
|
}
|
|
|
|
/**
|
|
* Disables a feature flag and persists the value to browser storage.
|
|
*
|
|
* @param flag the feature flag to disable.
|
|
*/
|
|
public static disable(flag: Feature) {
|
|
runInAction(() => {
|
|
this.cache.delete(flag);
|
|
});
|
|
Storage.set(flag, false);
|
|
}
|
|
|
|
@observable
|
|
private static cache: Set<Feature> = new Set();
|
|
|
|
private static initialized = false;
|
|
}
|
|
|
|
makeObservable(FeatureFlags);
|