@ketch-sdk/ketch-types 1.75.0 → 1.76.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ketch-sdk/ketch-types",
-  "version": "1.75.0",
+  "version": "1.76.0",
   "description": "Ketch Types",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/dist/forms.d.ts

@@ -1,152 +0,0 @@
-/**
- * ExperienceFormField: Describes a form field in the user experience.
- */
-export interface ExperienceFormField {
-    id?: string;
-    required?: boolean;
-    label?: string;
-    hint?: string;
-    category?: FormFieldCategory;
-    type?: FormFieldType;
-    variant?: FormFieldVariant;
-    maxLength?: number;
-    name?: string;
-    width?: FormFieldWidth;
-    identitySpaceCode?: string;
-    options?: FormFieldDropdownOption[];
-}
-/**
- * FormFieldDropdownOption: Describes an option in a dropdown form field.
- */
-export type FormFieldDropdownOption = {
-    label?: string;
-    value?: string;
-};
-/**
- * FormFieldWidth: Describes the width of the form field in Rights Form.
- *
- * @enum
- * @values UNSPECIFIED = width is unspecified
- *          HALF = half width
- *          FULL = full width
- */
-export declare enum FormFieldWidth {
-    UNSPECIFIED = "unspecified",
-    HALF = "half",
-    FULL = "full"
-}
-/**
- * FormFieldCategory: Describes the category of the form field in Rights Form.
- *
- * @enum
- * @values UNSPECIFIED = category is unspecified
- *          DEFAULT = default field (ex: firstName, lastName, email etc.)
- *          CUSTOM = user created form field
- */
-export declare enum FormFieldCategory {
-    UNSPECIFIED = "unspecified",
-    DEFAULT = "default",
-    CUSTOM = "custom"
-}
-/**
- * FormFieldType: Describes the type of the form field in Rights Form.
- *
- * @enum
- * @values UNSPECIFIED = type is unspecified
- *          TEXT = text field
- *          DROPDOWN = dropdown field
- *          CHECKBOX = checkbox field
- */
-export declare enum FormFieldType {
-    UNSPECIFIED = "unspecified",
-    TEXT = "text",
-    DROPDOWN = "dropdown",
-    CHECKBOX = "checkbox",
-    FILE = "file"
-}
-/**
- * FormFieldVariant: Describes the variant of a text field in Rights Form.
- *
- * @enum
- * @values UNSPECIFIED = variant is unspecified
- *          INPUT = input variant
- *          TEXTAREA = textarea variant
- */
-export declare enum FormFieldVariant {
-    UNSPECIFIED = "unspecified",
-    INPUT = "input",
-    TEXTAREA = "textarea"
-}
-/**
- * CanonicalRightForm: Represents the mapping between canonical right code and form template ID.
- */
-export interface CanonicalRightForm {
-    canonicalRightCode: string;
-    formTemplateID: string;
-}
-/**
- * CustomRightForm: Represents the mapping between a custom right code and form template ID.
- */
-export interface CustomRightForm {
-    rightCode: string;
-    formTemplateID: string;
-}
-/**
- * FormSection: Describes a section of a form, including its title, description and form fields.
- */
-export interface FormSection {
-    description: string;
-    formFields: ExperienceFormField[];
-    title: string;
-    conditions?: Condition[];
-}
-export declare enum ConditionType {
-    CONDITION_TYPE_UNSPECIFIED = "CONDITION_TYPE_UNSPECIFIED",
-    CONDITION_TYPE_FORM_FIELD = "CONDITION_TYPE_FORM_FIELD",
-    CONDITION_TYPE_DATA_SUBJECT = "CONDITION_TYPE_DATA_SUBJECT",
-    UNRECOGNIZED = "UNRECOGNIZED"
-}
-export declare enum Operator {
-    OPERATOR_UNSPECIFIED = "OPERATOR_UNSPECIFIED",
-    OPERATOR_EQUALS = "OPERATOR_EQUALS",
-    OPERATOR_NOT_EQUALS = "OPERATOR_NOT_EQUALS",
-    OPERATOR_GREATER_THAN = "OPERATOR_GREATER_THAN",
-    OPERATOR_LESS_THAN = "OPERATOR_LESS_THAN",
-    OPERATOR_GREATER_THAN_OR_EQUALS = "OPERATOR_GREATER_THAN_OR_EQUALS",
-    OPERATOR_LESS_THAN_OR_EQUALS = "OPERATOR_LESS_THAN_OR_EQUALS",
-    OPERATOR_CONTAINS = "OPERATOR_CONTAINS",
-    OPERATOR_NOT_CONTAINS = "OPERATOR_NOT_CONTAINS",
-    OPERATOR_IN = "OPERATOR_IN",
-    OPERATOR_NOT_IN = "OPERATOR_NOT_IN",
-    OPERATOR_EMPTY = "OPERATOR_EMPTY",
-    OPERATOR_NOT_EMPTY = "OPERATOR_NOT_EMPTY",
-    UNRECOGNIZED = "UNRECOGNIZED"
-}
-export declare enum RelationalOperator {
-    RELATIONAL_OPERATOR_UNSPECIFIED = "RELATIONAL_OPERATOR_UNSPECIFIED",
-    RELATIONAL_OPERATOR_AND = "RELATIONAL_OPERATOR_AND",
-    RELATIONAL_OPERATOR_OR = "RELATIONAL_OPERATOR_OR",
-    UNRECOGNIZED = "UNRECOGNIZED"
-}
-/**
- * Condition: Describes a condition for a form section.
- */
-export interface Condition {
-    type?: ConditionType;
-    fieldID?: string;
-    fieldCode?: string;
-    operator?: Operator;
-    values?: string[];
-    order?: number;
-    relationalOperator?: RelationalOperator;
-}
-/**
- * FormTemplate: Describes a form template including its id, code, name, title and sections.
- */
-export interface FormTemplate {
-    code: string;
-    id: string;
-    name: string;
-    sections: FormSection[];
-    title: string;
-}

package/dist/forms.js

@@ -1,94 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RelationalOperator = exports.Operator = exports.ConditionType = exports.FormFieldVariant = exports.FormFieldType = exports.FormFieldCategory = exports.FormFieldWidth = void 0;
-/**
- * FormFieldWidth: Describes the width of the form field in Rights Form.
- *
- * @enum
- * @values UNSPECIFIED = width is unspecified
- *          HALF = half width
- *          FULL = full width
- */
-var FormFieldWidth;
-(function (FormFieldWidth) {
-    FormFieldWidth["UNSPECIFIED"] = "unspecified";
-    FormFieldWidth["HALF"] = "half";
-    FormFieldWidth["FULL"] = "full";
-})(FormFieldWidth = exports.FormFieldWidth || (exports.FormFieldWidth = {}));
-/**
- * FormFieldCategory: Describes the category of the form field in Rights Form.
- *
- * @enum
- * @values UNSPECIFIED = category is unspecified
- *          DEFAULT = default field (ex: firstName, lastName, email etc.)
- *          CUSTOM = user created form field
- */
-var FormFieldCategory;
-(function (FormFieldCategory) {
-    FormFieldCategory["UNSPECIFIED"] = "unspecified";
-    FormFieldCategory["DEFAULT"] = "default";
-    FormFieldCategory["CUSTOM"] = "custom";
-})(FormFieldCategory = exports.FormFieldCategory || (exports.FormFieldCategory = {}));
-/**
- * FormFieldType: Describes the type of the form field in Rights Form.
- *
- * @enum
- * @values UNSPECIFIED = type is unspecified
- *          TEXT = text field
- *          DROPDOWN = dropdown field
- *          CHECKBOX = checkbox field
- */
-var FormFieldType;
-(function (FormFieldType) {
-    FormFieldType["UNSPECIFIED"] = "unspecified";
-    FormFieldType["TEXT"] = "text";
-    FormFieldType["DROPDOWN"] = "dropdown";
-    FormFieldType["CHECKBOX"] = "checkbox";
-    FormFieldType["FILE"] = "file";
-})(FormFieldType = exports.FormFieldType || (exports.FormFieldType = {}));
-/**
- * FormFieldVariant: Describes the variant of a text field in Rights Form.
- *
- * @enum
- * @values UNSPECIFIED = variant is unspecified
- *          INPUT = input variant
- *          TEXTAREA = textarea variant
- */
-var FormFieldVariant;
-(function (FormFieldVariant) {
-    FormFieldVariant["UNSPECIFIED"] = "unspecified";
-    FormFieldVariant["INPUT"] = "input";
-    FormFieldVariant["TEXTAREA"] = "textarea";
-})(FormFieldVariant = exports.FormFieldVariant || (exports.FormFieldVariant = {}));
-var ConditionType;
-(function (ConditionType) {
-    ConditionType["CONDITION_TYPE_UNSPECIFIED"] = "CONDITION_TYPE_UNSPECIFIED";
-    ConditionType["CONDITION_TYPE_FORM_FIELD"] = "CONDITION_TYPE_FORM_FIELD";
-    ConditionType["CONDITION_TYPE_DATA_SUBJECT"] = "CONDITION_TYPE_DATA_SUBJECT";
-    ConditionType["UNRECOGNIZED"] = "UNRECOGNIZED";
-})(ConditionType = exports.ConditionType || (exports.ConditionType = {}));
-var Operator;
-(function (Operator) {
-    Operator["OPERATOR_UNSPECIFIED"] = "OPERATOR_UNSPECIFIED";
-    Operator["OPERATOR_EQUALS"] = "OPERATOR_EQUALS";
-    Operator["OPERATOR_NOT_EQUALS"] = "OPERATOR_NOT_EQUALS";
-    Operator["OPERATOR_GREATER_THAN"] = "OPERATOR_GREATER_THAN";
-    Operator["OPERATOR_LESS_THAN"] = "OPERATOR_LESS_THAN";
-    Operator["OPERATOR_GREATER_THAN_OR_EQUALS"] = "OPERATOR_GREATER_THAN_OR_EQUALS";
-    Operator["OPERATOR_LESS_THAN_OR_EQUALS"] = "OPERATOR_LESS_THAN_OR_EQUALS";
-    Operator["OPERATOR_CONTAINS"] = "OPERATOR_CONTAINS";
-    Operator["OPERATOR_NOT_CONTAINS"] = "OPERATOR_NOT_CONTAINS";
-    Operator["OPERATOR_IN"] = "OPERATOR_IN";
-    Operator["OPERATOR_NOT_IN"] = "OPERATOR_NOT_IN";
-    Operator["OPERATOR_EMPTY"] = "OPERATOR_EMPTY";
-    Operator["OPERATOR_NOT_EMPTY"] = "OPERATOR_NOT_EMPTY";
-    Operator["UNRECOGNIZED"] = "UNRECOGNIZED";
-})(Operator = exports.Operator || (exports.Operator = {}));
-var RelationalOperator;
-(function (RelationalOperator) {
-    RelationalOperator["RELATIONAL_OPERATOR_UNSPECIFIED"] = "RELATIONAL_OPERATOR_UNSPECIFIED";
-    RelationalOperator["RELATIONAL_OPERATOR_AND"] = "RELATIONAL_OPERATOR_AND";
-    RelationalOperator["RELATIONAL_OPERATOR_OR"] = "RELATIONAL_OPERATOR_OR";
-    RelationalOperator["UNRECOGNIZED"] = "UNRECOGNIZED";
-})(RelationalOperator = exports.RelationalOperator || (exports.RelationalOperator = {}));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9ybXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvZm9ybXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBMEJBOzs7Ozs7O0dBT0c7QUFDSCxJQUFZLGNBSVg7QUFKRCxXQUFZLGNBQWM7SUFDeEIsNkNBQTJCLENBQUE7SUFDM0IsK0JBQWEsQ0FBQTtJQUNiLCtCQUFhLENBQUE7QUFDZixDQUFDLEVBSlcsY0FBYyxHQUFkLHNCQUFjLEtBQWQsc0JBQWMsUUFJekI7QUFFRDs7Ozs7OztHQU9HO0FBQ0gsSUFBWSxpQkFJWDtBQUpELFdBQVksaUJBQWlCO0lBQzNCLGdEQUEyQixDQUFBO0lBQzNCLHdDQUFtQixDQUFBO0lBQ25CLHNDQUFpQixDQUFBO0FBQ25CLENBQUMsRUFKVyxpQkFBaUIsR0FBakIseUJBQWlCLEtBQWpCLHlCQUFpQixRQUk1QjtBQUVEOzs7Ozs7OztHQVFHO0FBQ0gsSUFBWSxhQU1YO0FBTkQsV0FBWSxhQUFhO0lBQ3ZCLDRDQUEyQixDQUFBO0lBQzNCLDhCQUFhLENBQUE7SUFDYixzQ0FBcUIsQ0FBQTtJQUNyQixzQ0FBcUIsQ0FBQTtJQUNyQiw4QkFBYSxDQUFBO0FBQ2YsQ0FBQyxFQU5XLGFBQWEsR0FBYixxQkFBYSxLQUFiLHFCQUFhLFFBTXhCO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILElBQVksZ0JBSVg7QUFKRCxXQUFZLGdCQUFnQjtJQUMxQiwrQ0FBMkIsQ0FBQTtJQUMzQixtQ0FBZSxDQUFBO0lBQ2YseUNBQXFCLENBQUE7QUFDdkIsQ0FBQyxFQUpXLGdCQUFnQixHQUFoQix3QkFBZ0IsS0FBaEIsd0JBQWdCLFFBSTNCO0FBNEJELElBQVksYUFLWDtBQUxELFdBQVksYUFBYTtJQUN2QiwwRUFBeUQsQ0FBQTtJQUN6RCx3RUFBdUQsQ0FBQTtJQUN2RCw0RUFBMkQsQ0FBQTtJQUMzRCw4Q0FBNkIsQ0FBQTtBQUMvQixDQUFDLEVBTFcsYUFBYSxHQUFiLHFCQUFhLEtBQWIscUJBQWEsUUFLeEI7QUFFRCxJQUFZLFFBZVg7QUFmRCxXQUFZLFFBQVE7SUFDbEIseURBQTZDLENBQUE7SUFDN0MsK0NBQW1DLENBQUE7SUFDbkMsdURBQTJDLENBQUE7SUFDM0MsMkRBQStDLENBQUE7SUFDL0MscURBQXlDLENBQUE7SUFDekMsK0VBQW1FLENBQUE7SUFDbkUseUVBQTZELENBQUE7SUFDN0QsbURBQXVDLENBQUE7SUFDdkMsMkRBQStDLENBQUE7SUFDL0MsdUNBQTJCLENBQUE7SUFDM0IsK0NBQW1DLENBQUE7SUFDbkMsNkNBQWlDLENBQUE7SUFDakMscURBQXlDLENBQUE7SUFDekMseUNBQTZCLENBQUE7QUFDL0IsQ0FBQyxFQWZXLFFBQVEsR0FBUixnQkFBUSxLQUFSLGdCQUFRLFFBZW5CO0FBRUQsSUFBWSxrQkFLWDtBQUxELFdBQVksa0JBQWtCO0lBQzVCLHlGQUFtRSxDQUFBO0lBQ25FLHlFQUFtRCxDQUFBO0lBQ25ELHVFQUFpRCxDQUFBO0lBQ2pELG1EQUE2QixDQUFBO0FBQy9CLENBQUMsRUFMVyxrQkFBa0IsR0FBbEIsMEJBQWtCLEtBQWxCLDBCQUFrQixRQUs3QiJ9