unleash-server 5.1.8 → 5.2.0

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

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.advancedPlaygroundFeatureSchema = 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");
+const advanced_playground_environment_feature_schema_1 = require("./advanced-playground-environment-feature-schema");
+exports.advancedPlaygroundFeatureSchema = {
+    $id: '#/components/schemas/advancedPlaygroundFeatureSchema',
+    description: 'A simplified feature toggle model intended for the Unleash playground.',
+    type: 'object',
+    additionalProperties: false,
+    required: ['name', 'projectId', 'environments'],
+    properties: {
+        name: {
+            type: 'string',
+            example: 'my-feature',
+            description: "The feature's name.",
+        },
+        projectId: {
+            type: 'string',
+            example: 'my-project',
+            description: 'The ID of the project that contains this feature.',
+        },
+        environments: {
+            type: 'object',
+            description: 'The lists of features that have been evaluated grouped by environment.',
+            additionalProperties: {
+                type: 'array',
+                items: { $ref: advanced_playground_environment_feature_schema_1.advancedPlaygroundEnvironmentFeatureSchema.$id },
+            },
+        },
+    },
+    components: {
+        schemas: {
+            advancedPlaygroundEnvironmentFeatureSchema: advanced_playground_environment_feature_schema_1.advancedPlaygroundEnvironmentFeatureSchema,
+            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,
+        },
+    },
+};
+//# sourceMappingURL=advanced-playground-feature-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"advanced-playground-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/advanced-playground-feature-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,6EAAwE;AACxE,iFAA4E;AAC5E,2EAAsE;AACtE,6DAAwD;AACxD,qHAA8G;AAEjG,QAAA,+BAA+B,GAAG;IAC3C,GAAG,EAAE,sDAAsD;IAC3D,WAAW,EACP,wEAAwE;IAC5E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC;IAC/C,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,qBAAqB;SACrC;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,mDAAmD;SACnE;QACD,YAAY,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,wEAAwE;YAC5E,oBAAoB,EAAE;gBAClB,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,EAAE,IAAI,EAAE,2FAA0C,CAAC,GAAG,EAAE;aAClE;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,0CAA0C,EAA1C,2FAA0C;YAC1C,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;KACJ;CACK,CAAC"}

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

@@ -0,0 +1,95 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const advancedPlaygroundRequestSchema: {
+    readonly $id: "#/components/schemas/advancedPlaygroundRequestSchema";
+    readonly description: "Data for the playground API to evaluate toggles in advanced mode with environment and context multi selection";
+    readonly type: "object";
+    readonly required: readonly ["environments", "context"];
+    readonly properties: {
+        readonly environments: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly pattern: "^[a-zA-Z0-9~_.-]+$";
+            };
+            readonly minItems: 1;
+            readonly example: readonly ["development", "production"];
+            readonly description: "The environments to evaluate toggles in.";
+        };
+        readonly projects: {
+            readonly description: "A list of projects to check for toggles in.";
+            readonly oneOf: readonly [{
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly example: readonly ["my-project"];
+                readonly description: "A list of projects to check for toggles in.";
+            }, {
+                readonly type: "string";
+                readonly enum: readonly ["*"];
+                readonly description: "Check toggles in all projects.";
+            }];
+        };
+        readonly context: {
+            readonly $ref: "#/components/schemas/sdkContextSchema";
+        };
+    };
+    readonly components: {
+        readonly schemas: {
+            readonly sdkContextSchema: {
+                readonly $id: "#/components/schemas/sdkContextSchema";
+                readonly description: "The Unleash context as modeled in client SDKs";
+                readonly type: "object";
+                readonly additionalProperties: true;
+                readonly required: readonly ["appName"];
+                readonly properties: {
+                    readonly appName: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly example: "My cool application.";
+                        readonly description: "The name of the application.";
+                    };
+                    readonly currentTime: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly example: "2022-07-05T12:56:41+02:00";
+                        readonly description: "A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.";
+                    };
+                    readonly environment: {
+                        readonly type: "string";
+                        readonly deprecated: true;
+                        readonly description: "The environment the app is running in.";
+                    };
+                    readonly properties: {
+                        readonly type: "object";
+                        readonly additionalProperties: {
+                            readonly type: "string";
+                        };
+                        readonly example: {
+                            readonly customContextField: "this is one!";
+                            readonly otherCustomField: "3";
+                        };
+                    };
+                    readonly remoteAddress: {
+                        readonly type: "string";
+                        readonly example: "192.168.1.1";
+                        readonly description: "The app's IP address";
+                    };
+                    readonly sessionId: {
+                        readonly type: "string";
+                        readonly example: "b65e7b23-fec0-4814-a129-0e9861ef18fc";
+                        readonly description: "An identifier for the current session";
+                    };
+                    readonly userId: {
+                        readonly type: "string";
+                        readonly example: "username@provider.com";
+                        readonly description: "An identifier for the current user";
+                    };
+                };
+                readonly components: {};
+            };
+        };
+    };
+};
+export declare type AdvancedPlaygroundRequestSchema = FromSchema<typeof advancedPlaygroundRequestSchema>;

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

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.advancedPlaygroundRequestSchema = void 0;
+const api_token_1 = require("../../types/models/api-token");
+const sdk_context_schema_1 = require("./sdk-context-schema");
+exports.advancedPlaygroundRequestSchema = {
+    $id: '#/components/schemas/advancedPlaygroundRequestSchema',
+    description: 'Data for the playground API to evaluate toggles in advanced mode with environment and context multi selection',
+    type: 'object',
+    required: ['environments', 'context'],
+    properties: {
+        environments: {
+            type: 'array',
+            items: {
+                type: 'string',
+                minLength: 1,
+                pattern: '^[a-zA-Z0-9~_.-]+$',
+            },
+            minItems: 1,
+            example: ['development', 'production'],
+            description: 'The environments to evaluate toggles in.',
+        },
+        projects: {
+            description: 'A list of projects to check for toggles in.',
+            oneOf: [
+                {
+                    type: 'array',
+                    items: { type: 'string' },
+                    example: ['my-project'],
+                    description: 'A list of projects to check for toggles in.',
+                },
+                {
+                    type: 'string',
+                    enum: [api_token_1.ALL],
+                    description: 'Check toggles in all projects.',
+                },
+            ],
+        },
+        context: {
+            $ref: sdk_context_schema_1.sdkContextSchema.$id,
+        },
+    },
+    components: {
+        schemas: {
+            sdkContextSchema: sdk_context_schema_1.sdkContextSchema,
+        },
+    },
+};
+//# sourceMappingURL=advanced-playground-request-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"advanced-playground-request-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/advanced-playground-request-schema.ts"],"names":[],"mappings":";;;AACA,4DAAmD;AACnD,6DAAwD;AAE3C,QAAA,+BAA+B,GAAG;IAC3C,GAAG,EAAE,sDAAsD;IAC3D,WAAW,EACP,+GAA+G;IACnH,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,cAAc,EAAE,SAAS,CAAC;IACrC,UAAU,EAAE;QACR,YAAY,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,CAAC;gBACZ,OAAO,EAAE,oBAAoB;aAChC;YACD,QAAQ,EAAE,CAAC;YACX,OAAO,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC;YACtC,WAAW,EAAE,0CAA0C;SAC1D;QACD,QAAQ,EAAE;YACN,WAAW,EAAE,6CAA6C;YAC1D,KAAK,EAAE;gBACH;oBACI,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACzB,OAAO,EAAE,CAAC,YAAY,CAAC;oBACvB,WAAW,EAAE,6CAA6C;iBAC7D;gBACD;oBACI,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,eAAG,CAAC;oBACX,WAAW,EAAE,gCAAgC;iBAChD;aACJ;SACJ;QACD,OAAO,EAAE;YACL,IAAI,EAAE,qCAAgB,CAAC,GAAG;SAC7B;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,qCAAgB;SACnB;KACJ;CACK,CAAC"}