mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-25 00:07:47 +01:00
db61a8a40c
-
https://linear.app/unleash/issue/2-546/fetch-the-payload-from-a-real-feature-flag
-
https://linear.app/unleash/issue/2-547/adapt-ui-to-use-the-feature-flag-information-were-fetching
Tackles the 2 tasks above.
Adapts our `FlagResolver` logic to support variants, so we can use them
for our message banner project but also anything else in the future.
Also adapts MessageBanner to the new logic.
- Add support for variants in `FlagResolver`;
- Adapt `MessageBanner` to a variants flag;
- Adds `sticky` support for the `MessageBanner`;
- Adds our first variants flag to `uiConfig` and `experimental`:
`messageBanner`;
- Adds a `variant-flag-schema` to make it easy to represent the variant
output that we specify in `uiConfig`;
- Adapts `experimental` to be able to represent default variants while
still maintaining type safety;
- Adds helpers to make it easy to use variants in our project, such as
`getVariantValue` and the `useVariant` hook;
- Adapts and adds new tests in `flag-resolver.test.ts`;
### Notes
- ~~The `as PayloadType` assertions need
https://github.com/Unleash/unleash-client-node/pull/454 since it
includes https://github.com/Unleash/unleash-client-node/pull/452~~
(50ccf60893);
- ~~Enterprise needs a PR that will follow soon~~;
96 lines
2.3 KiB
TypeScript
96 lines
2.3 KiB
TypeScript
import { FromSchema } from 'json-schema-to-ts';
|
|
import { versionSchema } from './version-schema';
|
|
import { variantFlagSchema } from './variant-flag-schema';
|
|
|
|
export const uiConfigSchema = {
|
|
$id: '#/components/schemas/uiConfigSchema',
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
required: ['version', 'unleashUrl', 'baseUriPath', 'versionInfo'],
|
|
properties: {
|
|
slogan: {
|
|
type: 'string',
|
|
},
|
|
name: {
|
|
type: 'string',
|
|
},
|
|
version: {
|
|
type: 'string',
|
|
},
|
|
environment: {
|
|
type: 'string',
|
|
},
|
|
unleashUrl: {
|
|
type: 'string',
|
|
},
|
|
baseUriPath: {
|
|
type: 'string',
|
|
},
|
|
disablePasswordAuth: {
|
|
type: 'boolean',
|
|
},
|
|
emailEnabled: {
|
|
type: 'boolean',
|
|
},
|
|
maintenanceMode: {
|
|
type: 'boolean',
|
|
},
|
|
segmentValuesLimit: {
|
|
type: 'number',
|
|
},
|
|
strategySegmentsLimit: {
|
|
type: 'number',
|
|
},
|
|
networkViewEnabled: {
|
|
type: 'boolean',
|
|
},
|
|
frontendApiOrigins: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
flags: {
|
|
type: 'object',
|
|
additionalProperties: {
|
|
anyOf: [
|
|
{
|
|
type: 'boolean',
|
|
},
|
|
{
|
|
$ref: '#/components/schemas/variantFlagSchema',
|
|
},
|
|
],
|
|
},
|
|
},
|
|
links: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'object',
|
|
},
|
|
},
|
|
authenticationType: {
|
|
type: 'string',
|
|
enum: [
|
|
'open-source',
|
|
'demo',
|
|
'enterprise',
|
|
'hosted',
|
|
'custom',
|
|
'none',
|
|
],
|
|
},
|
|
versionInfo: {
|
|
$ref: '#/components/schemas/versionSchema',
|
|
},
|
|
},
|
|
components: {
|
|
schemas: {
|
|
versionSchema,
|
|
variantFlagSchema,
|
|
},
|
|
},
|
|
} as const;
|
|
|
|
export type UiConfigSchema = FromSchema<typeof uiConfigSchema>;
|