unleash.unleash/frontend/src/component/playground/Playground/interfaces/playground.model.ts

/**
 *
 * 09/08/2022
 * This was copied from the openapi-generator generated files and slightly modified
 * because of malformed generation of `anyOf`, `oneOf`
 *
 * https://github.com/OpenAPITools/openapi-generator/issues/12256
 */

import { VariantSchema } from 'openapi';
import { Operator } from 'constants/operators';

export interface PlaygroundConstraintSchema {
    /**
     * The name of the context field that this constraint should apply to.
     * @type {string}
     * @memberof PlaygroundConstraintSchema
     */
    contextName: string;
    /**
     * 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).
     * @type {string}
     * @memberof PlaygroundConstraintSchema
     */
    operator: Operator;
    /**
     * Whether the operator should be case-sensitive or not. Defaults to `false` (being case-sensitive).
     * @type {boolean}
     * @memberof PlaygroundConstraintSchema
     */
    caseInsensitive?: boolean;
    /**
     * Whether the result should be negated or not. If `true`, will turn a `true` result into a `false` result and vice versa.
     * @type {boolean}
     * @memberof PlaygroundConstraintSchema
     */
    inverted?: boolean;
    /**
     * The context values that should be used for constraint evaluation. Use this property instead of `value` for properties that accept multiple values.
     * @type {Array<string>}
     * @memberof PlaygroundConstraintSchema
     */
    values?: Array<string>;
    /**
     * The context value that should be used for constraint evaluation. Use this property instead of `values` for properties that only accept single values.
     * @type {string}
     * @memberof PlaygroundConstraintSchema
     */
    value?: string;
    /**
     * Whether this was evaluated as true or false.
     * @type {boolean}
     * @memberof PlaygroundConstraintSchema
     */
    result: boolean;
}

export interface PlaygroundFeatureSchema {
    /**
     * The feature's name.
     * @type {string}
     * @memberof PlaygroundFeatureSchema
     */
    name: string;
    /**
     * The ID of the project that contains this feature.
     * @type {string}
     * @memberof PlaygroundFeatureSchema
     */
    projectId: string;
    /**
     * The strategies that apply to this feature.
     * @type {Array<PlaygroundStrategySchema>}
     * @memberof PlaygroundFeatureSchema
     */
    strategies: PlaygroundStrategyResultSchema;
    /**
     * Whether the feature is active and would be evaluated in the provided environment in a normal SDK context.
     * @type {boolean}
     * @memberof PlaygroundFeatureSchema
     */
    isEnabledInCurrentEnvironment: boolean;
    /**
     *
     * @type {boolean | 'unevaluated'}
     * @memberof PlaygroundFeatureSchema
     */
    isEnabled: boolean;
    /**
     *
     * @type {PlaygroundFeatureSchemaVariant}
     * @memberof PlaygroundFeatureSchema
     */
    variant: PlaygroundFeatureSchemaVariant | null;
    /**
     *
     * @type {Array<VariantSchema>}
     * @memberof PlaygroundFeatureSchema
     */
    variants: Array<VariantSchema>;
}

export interface PlaygroundFeatureSchemaVariant {
    /**
     * The variant's name. If there is no variant or if the toggle is disabled, this will be `disabled`
     * @type {string}
     * @memberof PlaygroundFeatureSchemaVariant
     */
    name: string;
    /**
     * Whether the variant is enabled or not. If the feature is disabled or if it doesn't have variants, this property will be `false`
     * @type {boolean}
     * @memberof PlaygroundFeatureSchemaVariant
     */
    enabled: boolean;
    /**
     *
     * @type {PlaygroundFeatureSchemaVariantPayload}
     * @memberof PlaygroundFeatureSchemaVariant
     */
    payload?: PlaygroundFeatureSchemaVariantPayload;
}

export interface PlaygroundFeatureSchemaVariantPayload {
    /**
     * The format of the payload.
     * @type {string}
     * @memberof PlaygroundFeatureSchemaVariantPayload
     */
    type: PlaygroundFeatureSchemaVariantPayloadTypeEnum;
    /**
     * The payload value stringified.
     * @type {string}
     * @memberof PlaygroundFeatureSchemaVariantPayload
     */
    value: string;
}

export const playgroundFeatureSchemaVariantPayloadTypeEnum = {
    Json: 'json',
    Csv: 'csv',
    String: 'string',
} as const;
export type PlaygroundFeatureSchemaVariantPayloadTypeEnum =
    typeof playgroundFeatureSchemaVariantPayloadTypeEnum[keyof typeof playgroundFeatureSchemaVariantPayloadTypeEnum];

export interface PlaygroundRequestSchema {
    /**
     * The environment to evaluate toggles in.
     * @type {string}
     * @memberof PlaygroundRequestSchema
     */
    environment: string;
    /**
     *
     * @type {PlaygroundRequestSchemaProjects}
     * @memberof PlaygroundRequestSchema
     */
    projects?: PlaygroundRequestSchemaProjects;
    /**
     *
     * @type {SdkContextSchema}
     * @memberof PlaygroundRequestSchema
     */
    context: SdkContextSchema;
}

export type PlaygroundRequestSchemaProjects = Array<string> | string;

export interface PlaygroundResponseSchema {
    /**
     *
     * @type {PlaygroundRequestSchema}
     * @memberof PlaygroundResponseSchema
     */
    input: PlaygroundRequestSchema;
    /**
     * The list of features that have been evaluated.
     * @type {Array<PlaygroundFeatureSchema>}
     * @memberof PlaygroundResponseSchema
     */
    features: Array<PlaygroundFeatureSchema>;
}

export interface PlaygroundSegmentSchema {
    /**
     * The segment's id.
     * @type {number}
     * @memberof PlaygroundSegmentSchema
     */
    id: number;
    /**
     * The name of the segment.
     * @type {string}
     * @memberof PlaygroundSegmentSchema
     */
    name: string;
    /**
     * Whether this was evaluated as true or false.
     * @type {boolean}
     * @memberof PlaygroundSegmentSchema
     */
    result: boolean;
    /**
     * The list of constraints in this segment.
     * @type {Array<PlaygroundConstraintSchema>}
     * @memberof PlaygroundSegmentSchema
     */
    constraints: Array<PlaygroundConstraintSchema>;
}

export interface PlaygroundStrategyResultSchema {
    result: boolean | 'unknown';
    data?: Array<PlaygroundStrategySchema>;
}

export interface PlaygroundStrategySchema {
    /**
     * The strategy's name.
     * @type {string}
     * @memberof PlaygroundStrategySchema
     */
    name: string;
    /**
     * The strategy's id.
     * @type {string}
     * @memberof PlaygroundStrategySchema
     */
    id?: string;
    /**
     *
     * @type {PlaygroundStrategySchemaResult}
     * @memberof PlaygroundStrategySchema
     */
    result: PlaygroundStrategySchemaResult;
    /**
     * The strategy's segments and their evaluation results.
     * @type {Array<PlaygroundSegmentSchema>}
     * @memberof PlaygroundStrategySchema
     */
    segments: Array<PlaygroundSegmentSchema>;
    /**
     * The strategy's constraints and their evaluation results.
     * @type {Array<PlaygroundConstraintSchema>}
     * @memberof PlaygroundStrategySchema
     */
    constraints: Array<PlaygroundConstraintSchema>;
    /**
     *
     * @type {{ [key: string]: string; }}
     * @memberof PlaygroundStrategySchema
     */
    parameters: { [key: string]: string };
}

export enum PlaygroundStrategyResultEvaluationStatusEnum {
    complete = 'complete',
    incomplete = 'incomplete',
}

export interface PlaygroundStrategySchemaResult {
    /**
     * Signals that this strategy was evaluated successfully.
     * @type {string}
     * @memberof PlaygroundStrategySchemaResult
     */
    evaluationStatus?: PlaygroundStrategyResultEvaluationStatusEnum;
    /**
     * Whether this strategy evaluates to true or not.
     * @type {boolean}
     * @memberof PlaygroundStrategySchemaResult
     */
    enabled: boolean;
}

export interface SdkContextSchema {
    [key: string]: string | any;
    /**
     *
     * @type {string}
     * @memberof SdkContextSchema
     */
    appName: string;
    /**
     *
     * @type {Date}
     * @memberof SdkContextSchema
     */
    currentTime?: Date;
    /**
     *
     * @type {string}
     * @memberof SdkContextSchema
     * @deprecated
     */
    environment?: string;
    /**
     *
     * @type {{ [key: string]: string; }}
     * @memberof SdkContextSchema
     */
    properties?: { [key: string]: string };
    /**
     *
     * @type {string}
     * @memberof SdkContextSchema
     */
    remoteAddress?: string;
    /**
     *
     * @type {string}
     * @memberof SdkContextSchema
     */
    sessionId?: string;
    /**
     *
     * @type {string}
     * @memberof SdkContextSchema
     */
    userId?: string;
}