@ketch-sdk/ketch-types 1.75.0 → 1.76.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ketch-sdk/ketch-types",
3
- "version": "1.75.0",
3
+ "version": "1.76.1",
4
4
  "description": "Ketch Types",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
package/dist/forms.d.ts DELETED
@@ -1,152 +0,0 @@
1
- /**
2
- * ExperienceFormField: Describes a form field in the user experience.
3
- */
4
- export interface ExperienceFormField {
5
- id?: string;
6
- required?: boolean;
7
- label?: string;
8
- hint?: string;
9
- category?: FormFieldCategory;
10
- type?: FormFieldType;
11
- variant?: FormFieldVariant;
12
- maxLength?: number;
13
- name?: string;
14
- width?: FormFieldWidth;
15
- identitySpaceCode?: string;
16
- options?: FormFieldDropdownOption[];
17
- }
18
- /**
19
- * FormFieldDropdownOption: Describes an option in a dropdown form field.
20
- */
21
- export type FormFieldDropdownOption = {
22
- label?: string;
23
- value?: string;
24
- };
25
- /**
26
- * FormFieldWidth: Describes the width of the form field in Rights Form.
27
- *
28
- * @enum
29
- * @values UNSPECIFIED = width is unspecified
30
- * HALF = half width
31
- * FULL = full width
32
- */
33
- export declare enum FormFieldWidth {
34
- UNSPECIFIED = "unspecified",
35
- HALF = "half",
36
- FULL = "full"
37
- }
38
- /**
39
- * FormFieldCategory: Describes the category of the form field in Rights Form.
40
- *
41
- * @enum
42
- * @values UNSPECIFIED = category is unspecified
43
- * DEFAULT = default field (ex: firstName, lastName, email etc.)
44
- * CUSTOM = user created form field
45
- */
46
- export declare enum FormFieldCategory {
47
- UNSPECIFIED = "unspecified",
48
- DEFAULT = "default",
49
- CUSTOM = "custom"
50
- }
51
- /**
52
- * FormFieldType: Describes the type of the form field in Rights Form.
53
- *
54
- * @enum
55
- * @values UNSPECIFIED = type is unspecified
56
- * TEXT = text field
57
- * DROPDOWN = dropdown field
58
- * CHECKBOX = checkbox field
59
- */
60
- export declare enum FormFieldType {
61
- UNSPECIFIED = "unspecified",
62
- TEXT = "text",
63
- DROPDOWN = "dropdown",
64
- CHECKBOX = "checkbox",
65
- FILE = "file"
66
- }
67
- /**
68
- * FormFieldVariant: Describes the variant of a text field in Rights Form.
69
- *
70
- * @enum
71
- * @values UNSPECIFIED = variant is unspecified
72
- * INPUT = input variant
73
- * TEXTAREA = textarea variant
74
- */
75
- export declare enum FormFieldVariant {
76
- UNSPECIFIED = "unspecified",
77
- INPUT = "input",
78
- TEXTAREA = "textarea"
79
- }
80
- /**
81
- * CanonicalRightForm: Represents the mapping between canonical right code and form template ID.
82
- */
83
- export interface CanonicalRightForm {
84
- canonicalRightCode: string;
85
- formTemplateID: string;
86
- }
87
- /**
88
- * CustomRightForm: Represents the mapping between a custom right code and form template ID.
89
- */
90
- export interface CustomRightForm {
91
- rightCode: string;
92
- formTemplateID: string;
93
- }
94
- /**
95
- * FormSection: Describes a section of a form, including its title, description and form fields.
96
- */
97
- export interface FormSection {
98
- description: string;
99
- formFields: ExperienceFormField[];
100
- title: string;
101
- conditions?: Condition[];
102
- }
103
- export declare enum ConditionType {
104
- CONDITION_TYPE_UNSPECIFIED = "CONDITION_TYPE_UNSPECIFIED",
105
- CONDITION_TYPE_FORM_FIELD = "CONDITION_TYPE_FORM_FIELD",
106
- CONDITION_TYPE_DATA_SUBJECT = "CONDITION_TYPE_DATA_SUBJECT",
107
- UNRECOGNIZED = "UNRECOGNIZED"
108
- }
109
- export declare enum Operator {
110
- OPERATOR_UNSPECIFIED = "OPERATOR_UNSPECIFIED",
111
- OPERATOR_EQUALS = "OPERATOR_EQUALS",
112
- OPERATOR_NOT_EQUALS = "OPERATOR_NOT_EQUALS",
113
- OPERATOR_GREATER_THAN = "OPERATOR_GREATER_THAN",
114
- OPERATOR_LESS_THAN = "OPERATOR_LESS_THAN",
115
- OPERATOR_GREATER_THAN_OR_EQUALS = "OPERATOR_GREATER_THAN_OR_EQUALS",
116
- OPERATOR_LESS_THAN_OR_EQUALS = "OPERATOR_LESS_THAN_OR_EQUALS",
117
- OPERATOR_CONTAINS = "OPERATOR_CONTAINS",
118
- OPERATOR_NOT_CONTAINS = "OPERATOR_NOT_CONTAINS",
119
- OPERATOR_IN = "OPERATOR_IN",
120
- OPERATOR_NOT_IN = "OPERATOR_NOT_IN",
121
- OPERATOR_EMPTY = "OPERATOR_EMPTY",
122
- OPERATOR_NOT_EMPTY = "OPERATOR_NOT_EMPTY",
123
- UNRECOGNIZED = "UNRECOGNIZED"
124
- }
125
- export declare enum RelationalOperator {
126
- RELATIONAL_OPERATOR_UNSPECIFIED = "RELATIONAL_OPERATOR_UNSPECIFIED",
127
- RELATIONAL_OPERATOR_AND = "RELATIONAL_OPERATOR_AND",
128
- RELATIONAL_OPERATOR_OR = "RELATIONAL_OPERATOR_OR",
129
- UNRECOGNIZED = "UNRECOGNIZED"
130
- }
131
- /**
132
- * Condition: Describes a condition for a form section.
133
- */
134
- export interface Condition {
135
- type?: ConditionType;
136
- fieldID?: string;
137
- fieldCode?: string;
138
- operator?: Operator;
139
- values?: string[];
140
- order?: number;
141
- relationalOperator?: RelationalOperator;
142
- }
143
- /**
144
- * FormTemplate: Describes a form template including its id, code, name, title and sections.
145
- */
146
- export interface FormTemplate {
147
- code: string;
148
- id: string;
149
- name: string;
150
- sections: FormSection[];
151
- title: string;
152
- }
package/dist/forms.js DELETED
@@ -1,94 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.RelationalOperator = exports.Operator = exports.ConditionType = exports.FormFieldVariant = exports.FormFieldType = exports.FormFieldCategory = exports.FormFieldWidth = void 0;
4
- /**
5
- * FormFieldWidth: Describes the width of the form field in Rights Form.
6
- *
7
- * @enum
8
- * @values UNSPECIFIED = width is unspecified
9
- * HALF = half width
10
- * FULL = full width
11
- */
12
- var FormFieldWidth;
13
- (function (FormFieldWidth) {
14
- FormFieldWidth["UNSPECIFIED"] = "unspecified";
15
- FormFieldWidth["HALF"] = "half";
16
- FormFieldWidth["FULL"] = "full";
17
- })(FormFieldWidth = exports.FormFieldWidth || (exports.FormFieldWidth = {}));
18
- /**
19
- * FormFieldCategory: Describes the category of the form field in Rights Form.
20
- *
21
- * @enum
22
- * @values UNSPECIFIED = category is unspecified
23
- * DEFAULT = default field (ex: firstName, lastName, email etc.)
24
- * CUSTOM = user created form field
25
- */
26
- var FormFieldCategory;
27
- (function (FormFieldCategory) {
28
- FormFieldCategory["UNSPECIFIED"] = "unspecified";
29
- FormFieldCategory["DEFAULT"] = "default";
30
- FormFieldCategory["CUSTOM"] = "custom";
31
- })(FormFieldCategory = exports.FormFieldCategory || (exports.FormFieldCategory = {}));
32
- /**
33
- * FormFieldType: Describes the type of the form field in Rights Form.
34
- *
35
- * @enum
36
- * @values UNSPECIFIED = type is unspecified
37
- * TEXT = text field
38
- * DROPDOWN = dropdown field
39
- * CHECKBOX = checkbox field
40
- */
41
- var FormFieldType;
42
- (function (FormFieldType) {
43
- FormFieldType["UNSPECIFIED"] = "unspecified";
44
- FormFieldType["TEXT"] = "text";
45
- FormFieldType["DROPDOWN"] = "dropdown";
46
- FormFieldType["CHECKBOX"] = "checkbox";
47
- FormFieldType["FILE"] = "file";
48
- })(FormFieldType = exports.FormFieldType || (exports.FormFieldType = {}));
49
- /**
50
- * FormFieldVariant: Describes the variant of a text field in Rights Form.
51
- *
52
- * @enum
53
- * @values UNSPECIFIED = variant is unspecified
54
- * INPUT = input variant
55
- * TEXTAREA = textarea variant
56
- */
57
- var FormFieldVariant;
58
- (function (FormFieldVariant) {
59
- FormFieldVariant["UNSPECIFIED"] = "unspecified";
60
- FormFieldVariant["INPUT"] = "input";
61
- FormFieldVariant["TEXTAREA"] = "textarea";
62
- })(FormFieldVariant = exports.FormFieldVariant || (exports.FormFieldVariant = {}));
63
- var ConditionType;
64
- (function (ConditionType) {
65
- ConditionType["CONDITION_TYPE_UNSPECIFIED"] = "CONDITION_TYPE_UNSPECIFIED";
66
- ConditionType["CONDITION_TYPE_FORM_FIELD"] = "CONDITION_TYPE_FORM_FIELD";
67
- ConditionType["CONDITION_TYPE_DATA_SUBJECT"] = "CONDITION_TYPE_DATA_SUBJECT";
68
- ConditionType["UNRECOGNIZED"] = "UNRECOGNIZED";
69
- })(ConditionType = exports.ConditionType || (exports.ConditionType = {}));
70
- var Operator;
71
- (function (Operator) {
72
- Operator["OPERATOR_UNSPECIFIED"] = "OPERATOR_UNSPECIFIED";
73
- Operator["OPERATOR_EQUALS"] = "OPERATOR_EQUALS";
74
- Operator["OPERATOR_NOT_EQUALS"] = "OPERATOR_NOT_EQUALS";
75
- Operator["OPERATOR_GREATER_THAN"] = "OPERATOR_GREATER_THAN";
76
- Operator["OPERATOR_LESS_THAN"] = "OPERATOR_LESS_THAN";
77
- Operator["OPERATOR_GREATER_THAN_OR_EQUALS"] = "OPERATOR_GREATER_THAN_OR_EQUALS";
78
- Operator["OPERATOR_LESS_THAN_OR_EQUALS"] = "OPERATOR_LESS_THAN_OR_EQUALS";
79
- Operator["OPERATOR_CONTAINS"] = "OPERATOR_CONTAINS";
80
- Operator["OPERATOR_NOT_CONTAINS"] = "OPERATOR_NOT_CONTAINS";
81
- Operator["OPERATOR_IN"] = "OPERATOR_IN";
82
- Operator["OPERATOR_NOT_IN"] = "OPERATOR_NOT_IN";
83
- Operator["OPERATOR_EMPTY"] = "OPERATOR_EMPTY";
84
- Operator["OPERATOR_NOT_EMPTY"] = "OPERATOR_NOT_EMPTY";
85
- Operator["UNRECOGNIZED"] = "UNRECOGNIZED";
86
- })(Operator = exports.Operator || (exports.Operator = {}));
87
- var RelationalOperator;
88
- (function (RelationalOperator) {
89
- RelationalOperator["RELATIONAL_OPERATOR_UNSPECIFIED"] = "RELATIONAL_OPERATOR_UNSPECIFIED";
90
- RelationalOperator["RELATIONAL_OPERATOR_AND"] = "RELATIONAL_OPERATOR_AND";
91
- RelationalOperator["RELATIONAL_OPERATOR_OR"] = "RELATIONAL_OPERATOR_OR";
92
- RelationalOperator["UNRECOGNIZED"] = "UNRECOGNIZED";
93
- })(RelationalOperator = exports.RelationalOperator || (exports.RelationalOperator = {}));
94
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9ybXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvZm9ybXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBMEJBOzs7Ozs7O0dBT0c7QUFDSCxJQUFZLGNBSVg7QUFKRCxXQUFZLGNBQWM7SUFDeEIsNkNBQTJCLENBQUE7SUFDM0IsK0JBQWEsQ0FBQTtJQUNiLCtCQUFhLENBQUE7QUFDZixDQUFDLEVBSlcsY0FBYyxHQUFkLHNCQUFjLEtBQWQsc0JBQWMsUUFJekI7QUFFRDs7Ozs7OztHQU9HO0FBQ0gsSUFBWSxpQkFJWDtBQUpELFdBQVksaUJBQWlCO0lBQzNCLGdEQUEyQixDQUFBO0lBQzNCLHdDQUFtQixDQUFBO0lBQ25CLHNDQUFpQixDQUFBO0FBQ25CLENBQUMsRUFKVyxpQkFBaUIsR0FBakIseUJBQWlCLEtBQWpCLHlCQUFpQixRQUk1QjtBQUVEOzs7Ozs7OztHQVFHO0FBQ0gsSUFBWSxhQU1YO0FBTkQsV0FBWSxhQUFhO0lBQ3ZCLDRDQUEyQixDQUFBO0lBQzNCLDhCQUFhLENBQUE7SUFDYixzQ0FBcUIsQ0FBQTtJQUNyQixzQ0FBcUIsQ0FBQTtJQUNyQiw4QkFBYSxDQUFBO0FBQ2YsQ0FBQyxFQU5XLGFBQWEsR0FBYixxQkFBYSxLQUFiLHFCQUFhLFFBTXhCO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILElBQVksZ0JBSVg7QUFKRCxXQUFZLGdCQUFnQjtJQUMxQiwrQ0FBMkIsQ0FBQTtJQUMzQixtQ0FBZSxDQUFBO0lBQ2YseUNBQXFCLENBQUE7QUFDdkIsQ0FBQyxFQUpXLGdCQUFnQixHQUFoQix3QkFBZ0IsS0FBaEIsd0JBQWdCLFFBSTNCO0FBNEJELElBQVksYUFLWDtBQUxELFdBQVksYUFBYTtJQUN2QiwwRUFBeUQsQ0FBQTtJQUN6RCx3RUFBdUQsQ0FBQTtJQUN2RCw0RUFBMkQsQ0FBQTtJQUMzRCw4Q0FBNkIsQ0FBQTtBQUMvQixDQUFDLEVBTFcsYUFBYSxHQUFiLHFCQUFhLEtBQWIscUJBQWEsUUFLeEI7QUFFRCxJQUFZLFFBZVg7QUFmRCxXQUFZLFFBQVE7SUFDbEIseURBQTZDLENBQUE7SUFDN0MsK0NBQW1DLENBQUE7SUFDbkMsdURBQTJDLENBQUE7SUFDM0MsMkRBQStDLENBQUE7SUFDL0MscURBQXlDLENBQUE7SUFDekMsK0VBQW1FLENBQUE7SUFDbkUseUVBQTZELENBQUE7SUFDN0QsbURBQXVDLENBQUE7SUFDdkMsMkRBQStDLENBQUE7SUFDL0MsdUNBQTJCLENBQUE7SUFDM0IsK0NBQW1DLENBQUE7SUFDbkMsNkNBQWlDLENBQUE7SUFDakMscURBQXlDLENBQUE7SUFDekMseUNBQTZCLENBQUE7QUFDL0IsQ0FBQyxFQWZXLFFBQVEsR0FBUixnQkFBUSxLQUFSLGdCQUFRLFFBZW5CO0FBRUQsSUFBWSxrQkFLWDtBQUxELFdBQVksa0JBQWtCO0lBQzVCLHlGQUFtRSxDQUFBO0lBQ25FLHlFQUFtRCxDQUFBO0lBQ25ELHVFQUFpRCxDQUFBO0lBQ2pELG1EQUE2QixDQUFBO0FBQy9CLENBQUMsRUFMVyxrQkFBa0IsR0FBbEIsMEJBQWtCLEtBQWxCLDBCQUFrQixRQUs3QiJ9