unleash-server 4.14.2 → 4.14.3

package/dist/lib/openapi/spec/playground-response-schema.js

@@ -4,8 +4,13 @@ exports.playgroundResponseSchema = void 0;
 const sdk_context_schema_1 = require("./sdk-context-schema");
 const playground_request_schema_1 = require("./playground-request-schema");
 const playground_feature_schema_1 = require("./playground-feature-schema");
+const constraint_schema_1 = require("./constraint-schema");
+const parameters_schema_1 = require("./parameters-schema");
 const variant_schema_1 = require("./variant-schema");
 const override_schema_1 = require("./override-schema");
+const playground_constraint_schema_1 = require("./playground-constraint-schema");
+const playground_segment_schema_1 = require("./playground-segment-schema");
+const playground_strategy_schema_1 = require("./playground-strategy-schema");
 exports.playgroundResponseSchema = {
     $id: '#/components/schemas/playgroundResponseSchema',
     description: 'The state of all features given the provided input.',
@@ -14,17 +19,26 @@ exports.playgroundResponseSchema = {
     required: ['features', 'input'],
     properties: {
         input: {
+            description: 'The given input used to evaluate the features.',
             $ref: playground_request_schema_1.playgroundRequestSchema.$id,
         },
         features: {
             type: 'array',
-            items: { $ref: playground_feature_schema_1.playgroundFeatureSchema.$id },
+            description: 'The list of features that have been evaluated.',
+            items: {
+                $ref: playground_feature_schema_1.playgroundFeatureSchema.$id,
+            },
         },
     },
     components: {
         schemas: {
+            constraintSchema: constraint_schema_1.constraintSchema,
+            parametersSchema: parameters_schema_1.parametersSchema,
+            playgroundConstraintSchema: playground_constraint_schema_1.playgroundConstraintSchema,
             playgroundFeatureSchema: playground_feature_schema_1.playgroundFeatureSchema,
             playgroundRequestSchema: playground_request_schema_1.playgroundRequestSchema,
+            playgroundSegmentSchema: playground_segment_schema_1.playgroundSegmentSchema,
+            playgroundStrategySchema: playground_strategy_schema_1.playgroundStrategySchema,
             sdkContextSchema: sdk_context_schema_1.sdkContextSchema,
             variantSchema: variant_schema_1.variantSchema,
             overrideSchema: override_schema_1.overrideSchema,

package/dist/lib/openapi/spec/playground-response-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"playground-response-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-response-schema.ts"],"names":[],"mappings":";;;AACA,6DAAwD;AACxD,2EAAsE;AACtE,2EAAsE;AACtE,qDAAiD;AACjD,uDAAmD;AAEtC,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,WAAW,EAAE,qDAAqD;IAClE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC;IAC/B,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,mDAAuB,CAAC,GAAG;SACpC;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,mDAAuB,CAAC,GAAG,EAAE;SAC/C;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,uBAAuB,EAAvB,mDAAuB;YACvB,uBAAuB,EAAvB,mDAAuB;YACvB,gBAAgB,EAAhB,qCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;SACjB;KACJ;CACK,CAAC"}
+{"version":3,"file":"playground-response-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-response-schema.ts"],"names":[],"mappings":";;;AACA,6DAAwD;AACxD,2EAAsE;AACtE,2EAAsE;AACtE,2DAAuD;AACvD,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,iFAA4E;AAC5E,2EAAsE;AACtE,6EAAwE;AAE3D,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,WAAW,EAAE,qDAAqD;IAClE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC;IAC/B,UAAU,EAAE;QACR,KAAK,EAAE;YACH,WAAW,EAAE,gDAAgD;YAC7D,IAAI,EAAE,mDAAuB,CAAC,GAAG;SACpC;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,gDAAgD;YAC7D,KAAK,EAAE;gBACH,IAAI,EAAE,mDAAuB,CAAC,GAAG;aACpC;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,0BAA0B,EAA1B,yDAA0B;YAC1B,uBAAuB,EAAvB,mDAAuB;YACvB,uBAAuB,EAAvB,mDAAuB;YACvB,uBAAuB,EAAvB,mDAAuB;YACvB,wBAAwB,EAAxB,qDAAwB;YACxB,gBAAgB,EAAhB,qCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;SACjB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/playground-segment-schema.d.ts

@@ -0,0 +1,79 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const playgroundSegmentSchema: {
+    readonly $id: "#/components/schemas/playgroundSegmentSchema";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["name", "id", "constraints", "result"];
+    readonly properties: {
+        readonly id: {
+            readonly description: "The segment's id.";
+            readonly type: "integer";
+        };
+        readonly name: {
+            readonly description: "The name of the segment.";
+            readonly example: "segment A";
+            readonly type: "string";
+        };
+        readonly result: {
+            readonly description: "Whether this was evaluated as true or false.";
+            readonly type: "boolean";
+        };
+        readonly constraints: {
+            readonly type: "array";
+            readonly description: "The list of constraints in this segment.";
+            readonly items: {
+                readonly $ref: "#/components/schemas/playgroundConstraintSchema";
+            };
+        };
+    };
+    readonly components: {
+        readonly schemas: {
+            readonly playgroundConstraintSchema: {
+                readonly required: readonly ["contextName", "operator", "result"];
+                readonly properties: {
+                    readonly result: {
+                        readonly description: "Whether this was evaluated as true or false.";
+                        readonly type: "boolean";
+                    };
+                    readonly contextName: {
+                        readonly description: "The name of the context field that this constraint should apply to.";
+                        readonly example: "appName";
+                        readonly type: "string";
+                    };
+                    readonly operator: {
+                        readonly description: "The operator to use when evaluating this constraint. For more information about the various operators, refer to [the strategy constraint operator documentation](https://docs.getunleash.io/advanced/strategy_constraints#strategy-constraint-operators).";
+                        readonly type: "string";
+                        readonly enum: readonly ["NOT_IN", "IN", "STR_ENDS_WITH", "STR_STARTS_WITH", "STR_CONTAINS", "NUM_EQ", "NUM_GT", "NUM_GTE", "NUM_LT", "NUM_LTE", "DATE_AFTER", "DATE_BEFORE", "SEMVER_EQ", "SEMVER_GT", "SEMVER_LT"];
+                    };
+                    readonly caseInsensitive: {
+                        readonly description: "Whether the operator should be case sensitive or not. Defaults to `false` (being case sensitive).";
+                        readonly type: "boolean";
+                        readonly default: false;
+                    };
+                    readonly inverted: {
+                        readonly description: "Whether the result should be negated or not. If `true`, will turn a `true` result into a `false` result and vice versa.";
+                        readonly type: "boolean";
+                        readonly default: false;
+                    };
+                    readonly values: {
+                        readonly type: "array";
+                        readonly description: "The context values that should be used for constraint evaluation. Use this property instead of `value` for properties that accept multiple values.";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly value: {
+                        readonly description: "The context value that should be used for constraint evaluation. Use this property instead of `values` for properties that only accept single values.";
+                        readonly type: "string";
+                    };
+                };
+                readonly type: "object";
+                readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/advanced/strategy_constraints)";
+                readonly components: {};
+                readonly $id: "#/components/schemas/playgroundConstraintSchema";
+                readonly additionalProperties: false;
+            };
+        };
+    };
+};
+export declare type PlaygroundSegmentSchema = FromSchema<typeof playgroundSegmentSchema>;

package/dist/lib/openapi/spec/playground-segment-schema.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playgroundSegmentSchema = void 0;
+const playground_constraint_schema_1 = require("./playground-constraint-schema");
+exports.playgroundSegmentSchema = {
+    $id: '#/components/schemas/playgroundSegmentSchema',
+    type: 'object',
+    additionalProperties: false,
+    required: ['name', 'id', 'constraints', 'result'],
+    properties: {
+        id: {
+            description: "The segment's id.",
+            type: 'integer',
+        },
+        name: {
+            description: 'The name of the segment.',
+            example: 'segment A',
+            type: 'string',
+        },
+        result: {
+            description: 'Whether this was evaluated as true or false.',
+            type: 'boolean',
+        },
+        constraints: {
+            type: 'array',
+            description: 'The list of constraints in this segment.',
+            items: { $ref: playground_constraint_schema_1.playgroundConstraintSchema.$id },
+        },
+    },
+    components: {
+        schemas: {
+            playgroundConstraintSchema: playground_constraint_schema_1.playgroundConstraintSchema,
+        },
+    },
+};
+//# sourceMappingURL=playground-segment-schema.js.map

package/dist/lib/openapi/spec/playground-segment-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playground-segment-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-segment-schema.ts"],"names":[],"mappings":";;;AACA,iFAA4E;AAE/D,QAAA,uBAAuB,GAAG;IACnC,GAAG,EAAE,8CAA8C;IACnD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,CAAC;IACjD,UAAU,EAAE;QACR,EAAE,EAAE;YACA,WAAW,EAAE,mBAAmB;YAChC,IAAI,EAAE,SAAS;SAClB;QACD,IAAI,EAAE;YACF,WAAW,EAAE,0BAA0B;YACvC,OAAO,EAAE,WAAW;YACpB,IAAI,EAAE,QAAQ;SACjB;QACD,MAAM,EAAE;YACJ,WAAW,EAAE,8CAA8C;YAC3D,IAAI,EAAE,SAAS;SAClB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,0CAA0C;YACvD,KAAK,EAAE,EAAE,IAAI,EAAE,yDAA0B,CAAC,GAAG,EAAE;SAClD;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,0BAA0B,EAA1B,yDAA0B;SAC7B;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/playground-strategy-schema.d.ts

@@ -0,0 +1,257 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const playgroundStrategyEvaluation: {
+    readonly evaluationComplete: "complete";
+    readonly evaluationIncomplete: "incomplete";
+    readonly unknownResult: "unknown";
+};
+export declare const strategyEvaluationResults: {
+    readonly anyOf: readonly [{
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["evaluationStatus", "enabled"];
+        readonly properties: {
+            readonly evaluationStatus: {
+                readonly type: "string";
+                readonly description: "Signals that this strategy could not be evaluated. This is most likely because you're using a custom strategy that Unleash doesn't know about.";
+                readonly enum: readonly ["incomplete"];
+            };
+            readonly enabled: {
+                readonly description: "Whether this strategy resolves to `false` or if it might resolve to `true`. Because Unleash can't evaluate the strategy, it can't say for certain whether it will be `true`, but if you have failing constraints or segments, it _can_ determine that your strategy would be `false`.";
+                readonly anyOf: readonly [{
+                    readonly type: "boolean";
+                    readonly enum: readonly [false];
+                }, {
+                    readonly type: "string";
+                    readonly enum: readonly ["unknown"];
+                }];
+            };
+        };
+    }, {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["evaluationStatus", "enabled"];
+        readonly properties: {
+            readonly evaluationStatus: {
+                readonly description: "Signals that this strategy was evaluated successfully.";
+                readonly type: "string";
+                readonly enum: readonly ["complete"];
+            };
+            readonly enabled: {
+                readonly type: "boolean";
+                readonly description: "Whether this strategy evaluates to true or not.";
+            };
+        };
+    }];
+};
+export declare const playgroundStrategySchema: {
+    readonly $id: "#/components/schemas/playgroundStrategySchema";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["id", "name", "result", "segments", "constraints", "parameters"];
+    readonly properties: {
+        readonly name: {
+            readonly description: "The strategy's name.";
+            readonly type: "string";
+        };
+        readonly id: {
+            readonly description: "The strategy's id.";
+            readonly type: "string";
+        };
+        readonly result: {
+            readonly anyOf: readonly [{
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["evaluationStatus", "enabled"];
+                readonly properties: {
+                    readonly evaluationStatus: {
+                        readonly type: "string";
+                        readonly description: "Signals that this strategy could not be evaluated. This is most likely because you're using a custom strategy that Unleash doesn't know about.";
+                        readonly enum: readonly ["incomplete"];
+                    };
+                    readonly enabled: {
+                        readonly description: "Whether this strategy resolves to `false` or if it might resolve to `true`. Because Unleash can't evaluate the strategy, it can't say for certain whether it will be `true`, but if you have failing constraints or segments, it _can_ determine that your strategy would be `false`.";
+                        readonly anyOf: readonly [{
+                            readonly type: "boolean";
+                            readonly enum: readonly [false];
+                        }, {
+                            readonly type: "string";
+                            readonly enum: readonly ["unknown"];
+                        }];
+                    };
+                };
+            }, {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["evaluationStatus", "enabled"];
+                readonly properties: {
+                    readonly evaluationStatus: {
+                        readonly description: "Signals that this strategy was evaluated successfully.";
+                        readonly type: "string";
+                        readonly enum: readonly ["complete"];
+                    };
+                    readonly enabled: {
+                        readonly type: "boolean";
+                        readonly description: "Whether this strategy evaluates to true or not.";
+                    };
+                };
+            }];
+            readonly description: "The strategy's evaluation result. If the strategy is a custom strategy that Unleash can't evaluate, `evaluationStatus` will be `unknown`. Otherwise, it will be `true` or `false`";
+        };
+        readonly segments: {
+            readonly type: "array";
+            readonly description: "The strategy's segments and their evaluation results.";
+            readonly items: {
+                readonly $ref: "#/components/schemas/playgroundSegmentSchema";
+            };
+        };
+        readonly constraints: {
+            readonly type: "array";
+            readonly description: "The strategy's constraints and their evaluation results.";
+            readonly items: {
+                readonly $ref: "#/components/schemas/playgroundConstraintSchema";
+            };
+        };
+        readonly parameters: {
+            readonly description: "The strategy's constraints and their evaluation results.";
+            readonly example: {
+                readonly myParam1: "param value";
+            };
+            readonly $ref: "#/components/schemas/parametersSchema";
+        };
+    };
+    readonly components: {
+        readonly schemas: {
+            readonly playgroundConstraintSchema: {
+                readonly required: readonly ["contextName", "operator", "result"];
+                readonly properties: {
+                    readonly result: {
+                        readonly description: "Whether this was evaluated as true or false.";
+                        readonly type: "boolean";
+                    };
+                    readonly contextName: {
+                        readonly description: "The name of the context field that this constraint should apply to.";
+                        readonly example: "appName";
+                        readonly type: "string";
+                    };
+                    readonly operator: {
+                        readonly description: "The operator to use when evaluating this constraint. For more information about the various operators, refer to [the strategy constraint operator documentation](https://docs.getunleash.io/advanced/strategy_constraints#strategy-constraint-operators).";
+                        readonly type: "string";
+                        readonly enum: readonly ["NOT_IN", "IN", "STR_ENDS_WITH", "STR_STARTS_WITH", "STR_CONTAINS", "NUM_EQ", "NUM_GT", "NUM_GTE", "NUM_LT", "NUM_LTE", "DATE_AFTER", "DATE_BEFORE", "SEMVER_EQ", "SEMVER_GT", "SEMVER_LT"];
+                    };
+                    readonly caseInsensitive: {
+                        readonly description: "Whether the operator should be case sensitive or not. Defaults to `false` (being case sensitive).";
+                        readonly type: "boolean";
+                        readonly default: false;
+                    };
+                    readonly inverted: {
+                        readonly description: "Whether the result should be negated or not. If `true`, will turn a `true` result into a `false` result and vice versa.";
+                        readonly type: "boolean";
+                        readonly default: false;
+                    };
+                    readonly values: {
+                        readonly type: "array";
+                        readonly description: "The context values that should be used for constraint evaluation. Use this property instead of `value` for properties that accept multiple values.";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly value: {
+                        readonly description: "The context value that should be used for constraint evaluation. Use this property instead of `values` for properties that only accept single values.";
+                        readonly type: "string";
+                    };
+                };
+                readonly type: "object";
+                readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/advanced/strategy_constraints)";
+                readonly components: {};
+                readonly $id: "#/components/schemas/playgroundConstraintSchema";
+                readonly additionalProperties: false;
+            };
+            readonly playgroundSegmentSchema: {
+                readonly $id: "#/components/schemas/playgroundSegmentSchema";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["name", "id", "constraints", "result"];
+                readonly properties: {
+                    readonly id: {
+                        readonly description: "The segment's id.";
+                        readonly type: "integer";
+                    };
+                    readonly name: {
+                        readonly description: "The name of the segment.";
+                        readonly example: "segment A";
+                        readonly type: "string";
+                    };
+                    readonly result: {
+                        readonly description: "Whether this was evaluated as true or false.";
+                        readonly type: "boolean";
+                    };
+                    readonly constraints: {
+                        readonly type: "array";
+                        readonly description: "The list of constraints in this segment.";
+                        readonly items: {
+                            readonly $ref: "#/components/schemas/playgroundConstraintSchema";
+                        };
+                    };
+                };
+                readonly components: {
+                    readonly schemas: {
+                        readonly playgroundConstraintSchema: {
+                            readonly required: readonly ["contextName", "operator", "result"];
+                            readonly properties: {
+                                readonly result: {
+                                    readonly description: "Whether this was evaluated as true or false.";
+                                    readonly type: "boolean";
+                                };
+                                readonly contextName: {
+                                    readonly description: "The name of the context field that this constraint should apply to.";
+                                    readonly example: "appName";
+                                    readonly type: "string";
+                                };
+                                readonly operator: {
+                                    readonly description: "The operator to use when evaluating this constraint. For more information about the various operators, refer to [the strategy constraint operator documentation](https://docs.getunleash.io/advanced/strategy_constraints#strategy-constraint-operators).";
+                                    readonly type: "string";
+                                    readonly enum: readonly ["NOT_IN", "IN", "STR_ENDS_WITH", "STR_STARTS_WITH", "STR_CONTAINS", "NUM_EQ", "NUM_GT", "NUM_GTE", "NUM_LT", "NUM_LTE", "DATE_AFTER", "DATE_BEFORE", "SEMVER_EQ", "SEMVER_GT", "SEMVER_LT"];
+                                };
+                                readonly caseInsensitive: {
+                                    readonly description: "Whether the operator should be case sensitive or not. Defaults to `false` (being case sensitive).";
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly inverted: {
+                                    readonly description: "Whether the result should be negated or not. If `true`, will turn a `true` result into a `false` result and vice versa.";
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly values: {
+                                    readonly type: "array";
+                                    readonly description: "The context values that should be used for constraint evaluation. Use this property instead of `value` for properties that accept multiple values.";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly value: {
+                                    readonly description: "The context value that should be used for constraint evaluation. Use this property instead of `values` for properties that only accept single values.";
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly type: "object";
+                            readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/advanced/strategy_constraints)";
+                            readonly components: {};
+                            readonly $id: "#/components/schemas/playgroundConstraintSchema";
+                            readonly additionalProperties: false;
+                        };
+                    };
+                };
+            };
+            readonly parametersSchema: {
+                readonly $id: "#/components/schemas/parametersSchema";
+                readonly type: "object";
+                readonly additionalProperties: {
+                    readonly type: "string";
+                };
+                readonly components: {};
+            };
+        };
+    };
+};
+export declare type PlaygroundStrategySchema = FromSchema<typeof playgroundStrategySchema>;

package/dist/lib/openapi/spec/playground-strategy-schema.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playgroundStrategySchema = exports.strategyEvaluationResults = exports.playgroundStrategyEvaluation = void 0;
+const parameters_schema_1 = require("./parameters-schema");
+const playground_constraint_schema_1 = require("./playground-constraint-schema");
+const playground_segment_schema_1 = require("./playground-segment-schema");
+exports.playgroundStrategyEvaluation = {
+    evaluationComplete: 'complete',
+    evaluationIncomplete: 'incomplete',
+    unknownResult: 'unknown',
+};
+exports.strategyEvaluationResults = {
+    anyOf: [
+        {
+            type: 'object',
+            additionalProperties: false,
+            required: ['evaluationStatus', 'enabled'],
+            properties: {
+                evaluationStatus: {
+                    type: 'string',
+                    description: "Signals that this strategy could not be evaluated. This is most likely because you're using a custom strategy that Unleash doesn't know about.",
+                    enum: [exports.playgroundStrategyEvaluation.evaluationIncomplete],
+                },
+                enabled: {
+                    description: "Whether this strategy resolves to `false` or if it might resolve to `true`. Because Unleash can't evaluate the strategy, it can't say for certain whether it will be `true`, but if you have failing constraints or segments, it _can_ determine that your strategy would be `false`.",
+                    anyOf: [
+                        { type: 'boolean', enum: [false] },
+                        {
+                            type: 'string',
+                            enum: [exports.playgroundStrategyEvaluation.unknownResult],
+                        },
+                    ],
+                },
+            },
+        },
+        {
+            type: 'object',
+            additionalProperties: false,
+            required: ['evaluationStatus', 'enabled'],
+            properties: {
+                evaluationStatus: {
+                    description: 'Signals that this strategy was evaluated successfully.',
+                    type: 'string',
+                    enum: ['complete'],
+                },
+                enabled: {
+                    type: 'boolean',
+                    description: 'Whether this strategy evaluates to true or not.',
+                },
+            },
+        },
+    ],
+};
+exports.playgroundStrategySchema = {
+    $id: '#/components/schemas/playgroundStrategySchema',
+    type: 'object',
+    additionalProperties: false,
+    required: ['id', 'name', 'result', 'segments', 'constraints', 'parameters'],
+    properties: {
+        name: {
+            description: "The strategy's name.",
+            type: 'string',
+        },
+        id: {
+            description: "The strategy's id.",
+            type: 'string',
+        },
+        result: {
+            description: `The strategy's evaluation result. If the strategy is a custom strategy that Unleash can't evaluate, \`evaluationStatus\` will be \`${exports.playgroundStrategyEvaluation.unknownResult}\`. Otherwise, it will be \`true\` or \`false\``,
+            ...exports.strategyEvaluationResults,
+        },
+        segments: {
+            type: 'array',
+            description: "The strategy's segments and their evaluation results.",
+            items: {
+                $ref: playground_segment_schema_1.playgroundSegmentSchema.$id,
+            },
+        },
+        constraints: {
+            type: 'array',
+            description: "The strategy's constraints and their evaluation results.",
+            items: {
+                $ref: playground_constraint_schema_1.playgroundConstraintSchema.$id,
+            },
+        },
+        parameters: {
+            description: "The strategy's constraints and their evaluation results.",
+            example: {
+                myParam1: 'param value',
+            },
+            $ref: parameters_schema_1.parametersSchema.$id,
+        },
+    },
+    components: {
+        schemas: {
+            playgroundConstraintSchema: playground_constraint_schema_1.playgroundConstraintSchema,
+            playgroundSegmentSchema: playground_segment_schema_1.playgroundSegmentSchema,
+            parametersSchema: parameters_schema_1.parametersSchema,
+        },
+    },
+};
+//# sourceMappingURL=playground-strategy-schema.js.map

package/dist/lib/openapi/spec/playground-strategy-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playground-strategy-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-strategy-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,iFAA4E;AAC5E,2EAAsE;AAEzD,QAAA,4BAA4B,GAAG;IACxC,kBAAkB,EAAE,UAAU;IAC9B,oBAAoB,EAAE,YAAY;IAClC,aAAa,EAAE,SAAS;CAClB,CAAC;AAEE,QAAA,yBAAyB,GAAG;IACrC,KAAK,EAAE;QACH;YACI,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,kBAAkB,EAAE,SAAS,CAAC;YACzC,UAAU,EAAE;gBACR,gBAAgB,EAAE;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EACP,gJAAgJ;oBACpJ,IAAI,EAAE,CAAC,oCAA4B,CAAC,oBAAoB,CAAC;iBAC5D;gBACD,OAAO,EAAE;oBACL,WAAW,EACP,uRAAuR;oBAC3R,KAAK,EAAE;wBACH,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE;wBAClC;4BACI,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,oCAA4B,CAAC,aAAa,CAAC;yBACrD;qBACJ;iBACJ;aACJ;SACJ;QACD;YACI,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,kBAAkB,EAAE,SAAS,CAAC;YACzC,UAAU,EAAE;gBACR,gBAAgB,EAAE;oBACd,WAAW,EACP,wDAAwD;oBAC5D,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,UAAU,CAAC;iBACrB;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,SAAS;oBACf,WAAW,EACP,iDAAiD;iBACxD;aACJ;SACJ;KACJ;CACK,CAAC;AAEE,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,CAAC;IAC3E,UAAU,EAAE;QACR,IAAI,EAAE;YACF,WAAW,EAAE,sBAAsB;YACnC,IAAI,EAAE,QAAQ;SACjB;QACD,EAAE,EAAE;YACA,WAAW,EAAE,oBAAoB;YACjC,IAAI,EAAE,QAAQ;SACjB;QACD,MAAM,EAAE;YACJ,WAAW,EAAE,sIAAsI,oCAA4B,CAAC,aAAa,iDAAiD;YAC9O,GAAG,iCAAyB;SAC/B;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EACP,uDAAuD;YAC3D,KAAK,EAAE;gBACH,IAAI,EAAE,mDAAuB,CAAC,GAAG;aACpC;SACJ;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,WAAW,EACP,0DAA0D;YAC9D,KAAK,EAAE;gBACH,IAAI,EAAE,yDAA0B,CAAC,GAAG;aACvC;SACJ;QACD,UAAU,EAAE;YACR,WAAW,EACP,0DAA0D;YAC9D,OAAO,EAAE;gBACL,QAAQ,EAAE,aAAa;aAC1B;YACD,IAAI,EAAE,oCAAgB,CAAC,GAAG;SAC7B;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,0BAA0B,EAA1B,yDAA0B;YAC1B,uBAAuB,EAAvB,mDAAuB;YACvB,gBAAgB,EAAhB,oCAAgB;SACnB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/project-schema.test.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const validate_1 = require("../validate");
+test('projectSchema', () => {
+    const data = {
+        name: 'Default',
+        id: 'default',
+        description: 'Default project',
+        health: 74,
+        featureCount: 10,
+        memberCount: 3,
+        updatedAt: '2022-06-28T17:33:53.963Z',
+    };
+    expect((0, validate_1.validateSchema)('#/components/schemas/projectSchema', {})).not.toBeUndefined();
+    expect((0, validate_1.validateSchema)('#/components/schemas/projectSchema', data)).toBeUndefined();
+});
+//# sourceMappingURL=project-schema.test.js.map

package/dist/lib/openapi/spec/project-schema.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/project-schema.test.ts"],"names":[],"mappings":";;AAAA,0CAA6C;AAG7C,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE;IACvB,MAAM,IAAI,GAAkB;QACxB,IAAI,EAAE,SAAS;QACf,EAAE,EAAE,SAAS;QACb,WAAW,EAAE,iBAAiB;QAC9B,MAAM,EAAE,EAAE;QACV,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,CAAC;QACd,SAAS,EAAE,0BAA0B;KACxC,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,EAAE,CAAC,CAC3D,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;IAEtB,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,IAAI,CAAC,CAC7D,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC"}

package/dist/lib/openapi/spec/search-events-schema.d.ts

@@ -0,0 +1,37 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const searchEventsSchema: {
+    readonly $id: "#/components/schemas/searchEventsSchema";
+    readonly type: "object";
+    readonly description: "\n        Search for events by type, project, feature, free-text query,\n        or a combination thereof. Pass an empty object to fetch all events.\n    ";
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly description: "Find events by event type (case-sensitive).";
+        };
+        readonly project: {
+            readonly type: "string";
+            readonly description: "Find events by project ID (case-sensitive).";
+        };
+        readonly feature: {
+            readonly type: "string";
+            readonly description: "Find events by feature toggle name (case-sensitive).";
+        };
+        readonly query: {
+            readonly type: "string";
+            readonly description: "\n                Find events by a free-text search query.\n                The query will be matched against the event type,\n                the username or email that created the event (if any),\n                and the event data payload (if any).\n            ";
+        };
+        readonly limit: {
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 100;
+            readonly default: 100;
+        };
+        readonly offset: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly default: 0;
+        };
+    };
+    readonly components: {};
+};
+export declare type SearchEventsSchema = FromSchema<typeof searchEventsSchema>;

package/dist/lib/openapi/spec/search-events-schema.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.searchEventsSchema = void 0;
+exports.searchEventsSchema = {
+    $id: '#/components/schemas/searchEventsSchema',
+    type: 'object',
+    description: `
+        Search for events by type, project, feature, free-text query,
+        or a combination thereof. Pass an empty object to fetch all events.
+    `,
+    properties: {
+        type: {
+            type: 'string',
+            description: 'Find events by event type (case-sensitive).',
+        },
+        project: {
+            type: 'string',
+            description: 'Find events by project ID (case-sensitive).',
+        },
+        feature: {
+            type: 'string',
+            description: 'Find events by feature toggle name (case-sensitive).',
+        },
+        query: {
+            type: 'string',
+            description: `
+                Find events by a free-text search query.
+                The query will be matched against the event type,
+                the username or email that created the event (if any),
+                and the event data payload (if any).
+            `,
+        },
+        limit: {
+            type: 'integer',
+            minimum: 1,
+            maximum: 100,
+            default: 100,
+        },
+        offset: {
+            type: 'integer',
+            minimum: 0,
+            default: 0,
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=search-events-schema.js.map

package/dist/lib/openapi/spec/search-events-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-events-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/search-events-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE;;;KAGZ;IACD,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6CAA6C;SAC7D;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6CAA6C;SAC7D;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,sDAAsD;SACtE;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;;;aAKZ;SACJ;QACD,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,GAAG;SACf;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}