@api-client/core 0.3.3 → 0.3.6

package/src/models/legacy/actions/Actions.ts

@@ -0,0 +1,269 @@
+export type ActionType = 'request' | 'response';
+/**
+ * A base interface describing a configuration to extract data from a request or a response.
+ * @deprecated
+ */
+export interface BaseCondition {
+ /**
+   * The main data source. Either the request or the response object.
+   * This is required when the `source` is not equal to `value. In this case it is ignored
+   */
+  type?: ActionType;
+  /**
+   * Source of the data.
+   */
+  source: RequestDataSourceEnum | ResponseDataSourceEnum | 'value';
+  /**
+   * The path to the data. When `iteratorEnabled` is set then this
+   * is a path counting from an array item. When not set an entire value of `source` is used.
+   */
+  path?: string;
+  /**
+   * This is only used when `source` is set to `value`. The data is not extracted from any of the request fields but this value is used.
+   */
+  value?: string;
+}
+/**
+ * A configuration that extracts complex data from arrays.
+ * @deprecated
+ */
+export interface DataSourceConfiguration extends BaseCondition {
+  /**
+   * When set the iterator configuration is enabled
+   */
+  iteratorEnabled?: boolean;
+  /**
+   * Array search configuration.
+   */
+  iterator?: IteratorConfiguration;
+}
+
+/**
+ * Describes action's condition configuration.
+ * @deprecated
+ */
+export interface Condition extends DataSourceConfiguration {
+  /**
+   * The value to compare to the result of extracted from the data source value.
+   * Usually it is a string. For `statuscode` acceptable value is a number.
+   */
+  predictedValue?: string | number;
+  /**
+   * The comparison operator.
+   */
+  operator?: OperatorEnum;
+  /**
+   * Whether the condition always pass.
+   * The condition is not really checked, values can be empty. The condition check always returns `true`.
+   */
+  alwaysPass?: boolean;
+  /**
+   * Options related to the UI state in the application.
+   */
+  view?: ConditionViewOptions;
+}
+
+/**
+ * @deprecated
+ */
+export interface ConditionViewOptions {
+  /**
+   * Whether the condition editor is rendered in the "full" view
+   * instead of the summary.
+   */
+  opened?: boolean;
+}
+
+/**
+ * An interface representing a runnable set of action in a condition.
+ * For the actions to be executed the condition first has to be met.
+ * The condition can be configured to always pass by setting the `alwaysPass` property.
+ * @deprecated
+ */
+export interface RunnableAction {
+  /**
+   * The condition to be checked when executing the runnable,
+   */
+  condition: Condition;
+  /**
+   * The type of the runnable. 
+   * The `request` will only process HTTP request data. The `response` has both request and response data available.
+   */
+  type: ActionType;
+  /**
+   * The list of actions to execute.
+   */
+  actions: Action[];
+  /**
+   * Whether the entire runnable is enabled. This is checked before the condition is executed.
+   */
+  enabled: boolean;
+}
+
+
+/**
+ * An interface representing a single action.
+ * @deprecated
+ */
+export interface Action {
+  /**
+   * The type of the action. 
+   * The `request` will only process HTTP request data. The `response` has both request and response data available.
+   */
+  type: ActionType;
+  /**
+   * Action name.
+   */
+  name?: string;
+  /**
+   * Whether the action is enabled.
+   */
+  enabled?: boolean;
+  /**
+   * Action priority. The higher number the higher priority of execution.
+   */
+  priority: number;
+  /**
+   * Action configuration
+   */
+  config?: ActionConfiguration;
+  /**
+   * Whether or not the action is executed synchronously to request / response
+   */
+  sync?: boolean;
+  /**
+   * Whether or not the request should fail when the action fails.
+   */
+  failOnError?: boolean;
+  /**
+   * Options passed to the UI.
+   */
+  view?: ActionViewConfiguration;
+}
+
+/**
+ * Convenience type that gathers all configurations in one type.
+ * @deprecated
+ */
+export type ActionConfiguration = SetCookieConfig | SetVariableConfig | DeleteCookieConfig;
+
+/**
+ * @deprecated
+ */
+export interface SetCookieConfig {
+  /**
+   * Name of the cookie
+   */
+  name: string;
+  /**
+   * Source of the cookie value
+   */
+  source: DataSourceConfiguration;
+  /**
+   * When set it uses request URL instead of defined URL in the action
+   */
+  useRequestUrl?: boolean;
+  /**
+   * An URL associated with the cookie
+   */
+  url?: string;
+  /**
+   * The cookie expiration time
+   */
+  expires?: string;
+  /**
+   * Whether the cookie is host only
+   */
+  hostOnly?: boolean;
+  /**
+   * Whether the cookie is HTTP only
+   */
+  httpOnly?: boolean;
+  /**
+   * Whether the cookie is HTTPS only
+   */
+  secure?: boolean;
+  /**
+   * Whether the cookie is a session cookie
+   */
+  session?: boolean;
+}
+
+/**
+ * @deprecated
+ */
+export interface SetVariableConfig {
+  /**
+   * Name of the variable to set
+   */
+  name: string;
+  /**
+   * Source of the cookie value
+   */
+  source: DataSourceConfiguration;
+}
+
+/**
+ * @deprecated
+ */
+export interface DeleteCookieConfig {
+  /**
+   * When set it uses request URL instead of defined URL in the action.
+   */
+  useRequestUrl?: boolean;
+  /**
+   * An URL associated with the cookie.
+   * Only used when `useRequestUrl` is not `true`.
+   */
+  url?: string;
+  /**
+   * When set it removes all cookies associated wit the URL.
+   */
+  removeAll?: boolean;
+  /**
+   * Name of the cookie to remove.
+   */
+  name?: string;
+}
+
+/**
+ * @deprecated
+ */
+export interface IteratorConfiguration {
+  /**
+   * The path to the property to use in the comparison.
+   */
+  path: string;
+  /**
+   * The value of the condition.
+   */
+  condition: string;
+  /**
+   * The comparison operator.
+   */
+  operator: OperatorEnum;
+}
+
+/**
+ * @deprecated
+ */
+export type OperatorEnum = "equal" | "not-equal" | "greater-than" | "greater-than-equal" | "less-than" | "less-than-equal" | "contains" | "regex";
+/**
+ * @deprecated
+ */
+export type RequestDataSourceEnum = "url" | "method" | "headers" | "body";
+/**
+ * @deprecated
+ */
+export type ResponseDataSourceEnum = "url" | "status" | "headers" | "body";
+
+/**
+ * An UI controlling configuration for an action.
+ * @deprecated
+ */
+export interface ActionViewConfiguration {
+  /**
+   * Whether the action is "opened" in the editor UI.
+   */
+  opened?: boolean;
+}