unleash-server 5.1.8 → 5.2.0

package/dist/lib/openapi/spec/advanced-playground-environment-feature-schema.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.advancedPlaygroundEnvironmentFeatureSchema = void 0;
+const parameters_schema_1 = require("./parameters-schema");
+const variant_schema_1 = require("./variant-schema");
+const override_schema_1 = require("./override-schema");
+const playground_strategy_schema_1 = require("./playground-strategy-schema");
+const playground_constraint_schema_1 = require("./playground-constraint-schema");
+const playground_segment_schema_1 = require("./playground-segment-schema");
+const sdk_context_schema_1 = require("./sdk-context-schema");
+exports.advancedPlaygroundEnvironmentFeatureSchema = {
+    $id: '#/components/schemas/advancedPlaygroundEnvironmentFeatureSchema',
+    description: 'A simplified feature toggle model intended for the Unleash playground.',
+    type: 'object',
+    additionalProperties: false,
+    required: [
+        'name',
+        'environment',
+        'context',
+        'projectId',
+        'isEnabled',
+        'isEnabledInCurrentEnvironment',
+        'variant',
+        'variants',
+        'strategies',
+    ],
+    properties: {
+        name: {
+            type: 'string',
+            example: 'my-feature',
+            description: "The feature's name.",
+        },
+        environment: {
+            type: 'string',
+            example: 'development',
+            description: "The feature's environment.",
+        },
+        context: {
+            description: 'The context to use when evaluating toggles',
+            $ref: sdk_context_schema_1.sdkContextSchema.$id,
+        },
+        projectId: {
+            type: 'string',
+            example: 'my-project',
+            description: 'The ID of the project that contains this feature.',
+        },
+        strategies: {
+            type: 'object',
+            additionalProperties: false,
+            required: ['result', 'data'],
+            description: "Feature's applicable strategies and cumulative results of the strategies",
+            properties: {
+                result: {
+                    description: `The cumulative results of all the feature's strategies. Can be \`true\`,
+                                  \`false\`, or \`${playground_strategy_schema_1.playgroundStrategyEvaluation.unknownResult}\`.
+                                  This property will only be \`${playground_strategy_schema_1.playgroundStrategyEvaluation.unknownResult}\`
+                                  if one or more of the strategies can't be fully evaluated and the rest of the strategies
+                                  all resolve to \`false\`.`,
+                    anyOf: [
+                        { type: 'boolean' },
+                        {
+                            type: 'string',
+                            enum: [playground_strategy_schema_1.playgroundStrategyEvaluation.unknownResult],
+                        },
+                    ],
+                },
+                data: {
+                    description: 'The strategies that apply to this feature.',
+                    type: 'array',
+                    items: {
+                        $ref: playground_strategy_schema_1.playgroundStrategySchema.$id,
+                    },
+                },
+            },
+        },
+        isEnabledInCurrentEnvironment: {
+            type: 'boolean',
+            description: 'Whether the feature is active and would be evaluated in the provided environment in a normal SDK context.',
+        },
+        isEnabled: {
+            description: `Whether this feature is enabled or not in the current environment.
+                          If a feature can't be fully evaluated (that is, \`strategies.result\` is \`${playground_strategy_schema_1.playgroundStrategyEvaluation.unknownResult}\`),
+                          this will be \`false\` to align with how client SDKs treat unresolved feature states.`,
+            type: 'boolean',
+            example: true,
+        },
+        variant: {
+            description: `The feature variant you receive based on the provided context or the _disabled
+                          variant_. If a feature is disabled or doesn't have any
+                          variants, you would get the _disabled variant_.
+                          Otherwise, you'll get one of thefeature's defined variants.`,
+            type: 'object',
+            additionalProperties: false,
+            required: ['name', 'enabled'],
+            properties: {
+                name: {
+                    type: 'string',
+                    description: "The variant's name. If there is no variant or if the toggle is disabled, this will be `disabled`",
+                    example: 'red-variant',
+                },
+                enabled: {
+                    type: 'boolean',
+                    description: "Whether the variant is enabled or not. If the feature is disabled or if it doesn't have variants, this property will be `false`",
+                },
+                payload: {
+                    type: 'object',
+                    additionalProperties: false,
+                    required: ['type', 'value'],
+                    description: 'An optional payload attached to the variant.',
+                    properties: {
+                        type: {
+                            description: 'The format of the payload.',
+                            type: 'string',
+                            enum: ['json', 'csv', 'string'],
+                        },
+                        value: {
+                            type: 'string',
+                            description: 'The payload value stringified.',
+                            example: '{"property": "value"}',
+                        },
+                    },
+                },
+            },
+            nullable: true,
+            example: { name: 'green', enabled: true },
+        },
+        variants: {
+            type: 'array',
+            description: 'The feature variants.',
+            items: { $ref: variant_schema_1.variantSchema.$id },
+        },
+    },
+    components: {
+        schemas: {
+            playgroundStrategySchema: playground_strategy_schema_1.playgroundStrategySchema,
+            playgroundConstraintSchema: playground_constraint_schema_1.playgroundConstraintSchema,
+            playgroundSegmentSchema: playground_segment_schema_1.playgroundSegmentSchema,
+            parametersSchema: parameters_schema_1.parametersSchema,
+            variantSchema: variant_schema_1.variantSchema,
+            overrideSchema: override_schema_1.overrideSchema,
+            sdkContextSchema: sdk_context_schema_1.sdkContextSchema,
+        },
+        variants: { type: 'array', items: { $ref: variant_schema_1.variantSchema.$id } },
+    },
+};
+//# sourceMappingURL=advanced-playground-environment-feature-schema.js.map

package/dist/lib/openapi/spec/advanced-playground-environment-feature-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"advanced-playground-environment-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/advanced-playground-environment-feature-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,6EAGsC;AACtC,iFAA4E;AAC5E,2EAAsE;AACtE,6DAAwD;AAE3C,QAAA,0CAA0C,GAAG;IACtD,GAAG,EAAE,iEAAiE;IACtE,WAAW,EACP,wEAAwE;IAC5E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE;QACN,MAAM;QACN,aAAa;QACb,SAAS;QACT,WAAW;QACX,WAAW;QACX,+BAA+B;QAC/B,SAAS;QACT,UAAU;QACV,YAAY;KACf;IACD,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,qBAAqB;SACrC;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,4BAA4B;SAC5C;QACD,OAAO,EAAE;YACL,WAAW,EAAE,4CAA4C;YACzD,IAAI,EAAE,qCAAgB,CAAC,GAAG;SAC7B;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,mDAAmD;SACnE;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;YAC5B,WAAW,EACP,0EAA0E;YAC9E,UAAU,EAAE;gBACR,MAAM,EAAE;oBACJ,WAAW,EAAE;oDACmB,yDAA4B,CAAC,aAAa;iEAC7B,yDAA4B,CAAC,aAAa;;4DAE/C;oBACxC,KAAK,EAAE;wBACH,EAAE,IAAI,EAAE,SAAS,EAAE;wBACnB;4BACI,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,yDAA4B,CAAC,aAAa,CAAC;yBACrD;qBACJ;iBACJ;gBACD,IAAI,EAAE;oBACF,WAAW,EAAE,4CAA4C;oBACzD,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,qDAAwB,CAAC,GAAG;qBACrC;iBACJ;aACJ;SACJ;QACD,6BAA6B,EAAE;YAC3B,IAAI,EAAE,SAAS;YACf,WAAW,EACP,2GAA2G;SAClH;QACD,SAAS,EAAE;YACP,WAAW,EAAE;uGAC8E,yDAA4B,CAAC,aAAa;gHACjC;YACpG,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SAChB;QACD,OAAO,EAAE;YACL,WAAW,EAAE;;;sFAG6D;YAC1E,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;YAC7B,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,IAAI,EAAE,QAAQ;oBACd,WAAW,EACP,kGAAkG;oBACtG,OAAO,EAAE,aAAa;iBACzB;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,SAAS;oBACf,WAAW,EACP,iIAAiI;iBACxI;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,oBAAoB,EAAE,KAAK;oBAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;oBAC3B,WAAW,EAAE,8CAA8C;oBAC3D,UAAU,EAAE;wBACR,IAAI,EAAE;4BACF,WAAW,EAAE,4BAA4B;4BACzC,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC;yBAClC;wBACD,KAAK,EAAE;4BACH,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,gCAAgC;4BAC7C,OAAO,EAAE,uBAAuB;yBACnC;qBACJ;iBACJ;aACJ;YACD,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;SAC5C;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,uBAAuB;YACpC,KAAK,EAAE,EAAE,IAAI,EAAE,8BAAa,CAAC,GAAG,EAAE;SACrC;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,wBAAwB,EAAxB,qDAAwB;YACxB,0BAA0B,EAA1B,yDAA0B;YAC1B,uBAAuB,EAAvB,mDAAuB;YACvB,gBAAgB,EAAhB,oCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,qCAAgB;SACnB;QACD,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,8BAAa,CAAC,GAAG,EAAE,EAAE;KAClE;CACK,CAAC"}