@devrev/airsync-sdk 2.0.0-beta.1 → 2.0.0-beta.10
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/README.md +7 -21
- package/dist/attachments-streaming/attachments-streaming-pool.d.ts +6 -7
- package/dist/attachments-streaming/attachments-streaming-pool.d.ts.map +1 -1
- package/dist/attachments-streaming/attachments-streaming-pool.interfaces.d.ts +4 -3
- package/dist/attachments-streaming/attachments-streaming-pool.interfaces.d.ts.map +1 -1
- package/dist/attachments-streaming/attachments-streaming-pool.js +69 -61
- package/dist/common/constants.d.ts +15 -12
- package/dist/common/constants.d.ts.map +1 -1
- package/dist/common/constants.js +20 -34
- package/dist/common/helpers.d.ts +3 -27
- package/dist/common/helpers.d.ts.map +1 -1
- package/dist/common/helpers.js +6 -36
- package/dist/http/{axios-client-internal.d.ts → client.d.ts} +1 -1
- package/dist/http/client.d.ts.map +1 -0
- package/dist/http/{axios-client-internal.js → client.js} +7 -4
- package/dist/http/errors.d.ts +8 -0
- package/dist/http/errors.d.ts.map +1 -0
- package/dist/http/errors.js +31 -0
- package/dist/index.d.ts +30 -12
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +47 -28
- package/dist/logger/logger.d.ts +13 -70
- package/dist/logger/logger.d.ts.map +1 -1
- package/dist/logger/logger.interfaces.d.ts +4 -7
- package/dist/logger/logger.interfaces.d.ts.map +1 -1
- package/dist/logger/logger.js +67 -92
- package/dist/mappers/mappers.d.ts +10 -43
- package/dist/mappers/mappers.d.ts.map +1 -1
- package/dist/mappers/mappers.interfaces.d.ts +173 -0
- package/dist/mappers/mappers.interfaces.d.ts.map +1 -0
- package/dist/mappers/{mappers.interface.js → mappers.interfaces.js} +1 -10
- package/dist/mappers/mappers.js +32 -46
- package/dist/multithreading/adapters/base-adapter.d.ts +39 -0
- package/dist/multithreading/adapters/base-adapter.d.ts.map +1 -0
- package/dist/multithreading/adapters/base-adapter.js +212 -0
- package/dist/multithreading/adapters/extraction-adapter.d.ts +49 -0
- package/dist/multithreading/adapters/extraction-adapter.d.ts.map +1 -0
- package/dist/multithreading/adapters/extraction-adapter.js +375 -0
- package/dist/multithreading/adapters/loading-adapter.d.ts +26 -0
- package/dist/multithreading/adapters/loading-adapter.d.ts.map +1 -0
- package/dist/multithreading/adapters/loading-adapter.helpers.d.ts +12 -0
- package/dist/multithreading/adapters/loading-adapter.helpers.d.ts.map +1 -0
- package/dist/multithreading/{worker-adapter/worker-adapter.helpers.js → adapters/loading-adapter.helpers.js} +2 -12
- package/dist/multithreading/adapters/loading-adapter.js +279 -0
- package/dist/multithreading/emit.d.ts +11 -0
- package/dist/multithreading/emit.d.ts.map +1 -0
- package/dist/multithreading/emit.js +25 -0
- package/dist/multithreading/process-task.d.ts +6 -1
- package/dist/multithreading/process-task.d.ts.map +1 -1
- package/dist/multithreading/process-task.js +120 -82
- package/dist/multithreading/spawn/spawn.d.ts +10 -11
- package/dist/multithreading/spawn/spawn.d.ts.map +1 -1
- package/dist/multithreading/spawn/spawn.helpers.d.ts +12 -11
- package/dist/multithreading/spawn/spawn.helpers.d.ts.map +1 -1
- package/dist/multithreading/spawn/spawn.helpers.js +142 -77
- package/dist/multithreading/spawn/spawn.js +59 -75
- package/dist/multithreading/worker.js +16 -5
- package/dist/repo/repo.d.ts +14 -5
- package/dist/repo/repo.d.ts.map +1 -1
- package/dist/repo/repo.helpers.d.ts +6 -0
- package/dist/repo/repo.helpers.d.ts.map +1 -0
- package/dist/repo/repo.helpers.js +16 -0
- package/dist/repo/repo.interfaces.d.ts +11 -20
- package/dist/repo/repo.interfaces.d.ts.map +1 -1
- package/dist/repo/repo.js +36 -22
- package/dist/state/base-state.d.ts +58 -0
- package/dist/state/base-state.d.ts.map +1 -0
- package/dist/state/base-state.js +242 -0
- package/dist/state/extraction-state.d.ts +14 -0
- package/dist/state/extraction-state.d.ts.map +1 -0
- package/dist/state/extraction-state.js +140 -0
- package/dist/state/install-initial-domain-mapping.d.ts +4 -0
- package/dist/state/install-initial-domain-mapping.d.ts.map +1 -0
- package/dist/{common → state}/install-initial-domain-mapping.js +5 -7
- package/dist/state/loading-state.d.ts +8 -0
- package/dist/state/loading-state.d.ts.map +1 -0
- package/dist/state/loading-state.js +29 -0
- package/dist/state/state.d.ts +3 -29
- package/dist/state/state.d.ts.map +1 -1
- package/dist/state/state.interfaces.d.ts +31 -12
- package/dist/state/state.interfaces.d.ts.map +1 -1
- package/dist/state/state.interfaces.js +17 -1
- package/dist/state/state.js +9 -164
- package/dist/state/time-value-resolver.d.ts +17 -0
- package/dist/state/time-value-resolver.d.ts.map +1 -0
- package/dist/state/time-value-resolver.js +110 -0
- package/dist/testing/mock-event.d.ts +10 -0
- package/dist/testing/mock-event.d.ts.map +1 -0
- package/dist/testing/mock-event.js +96 -0
- package/dist/testing/mock-server.d.ts +31 -0
- package/dist/testing/mock-server.d.ts.map +1 -0
- package/dist/testing/mock-server.interfaces.d.ts +54 -0
- package/dist/testing/mock-server.interfaces.d.ts.map +1 -0
- package/dist/testing/mock-server.interfaces.js +4 -0
- package/dist/testing/mock-server.js +297 -0
- package/dist/testing/test-adapters.d.ts +22 -0
- package/dist/testing/test-adapters.d.ts.map +1 -0
- package/dist/testing/test-adapters.js +32 -0
- package/dist/types/common.d.ts +4 -37
- package/dist/types/common.d.ts.map +1 -1
- package/dist/types/common.js +2 -17
- package/dist/types/errors.d.ts +15 -0
- package/dist/types/errors.d.ts.map +1 -0
- package/dist/types/errors.js +28 -0
- package/dist/types/external-domain-metadata.d.ts +40 -162
- package/dist/types/external-domain-metadata.d.ts.map +1 -1
- package/dist/types/extraction.d.ts +135 -278
- package/dist/types/extraction.d.ts.map +1 -1
- package/dist/types/extraction.js +46 -133
- package/dist/types/loading.d.ts +15 -55
- package/dist/types/loading.d.ts.map +1 -1
- package/dist/types/loading.js +1 -23
- package/dist/types/workers.d.ts +70 -103
- package/dist/types/workers.d.ts.map +1 -1
- package/dist/types/workers.js +1 -6
- package/dist/uploader/uploader.d.ts +10 -61
- package/dist/uploader/uploader.d.ts.map +1 -1
- package/dist/uploader/uploader.helpers.d.ts +7 -27
- package/dist/uploader/uploader.helpers.d.ts.map +1 -1
- package/dist/uploader/uploader.helpers.js +80 -30
- package/dist/uploader/uploader.interfaces.d.ts +19 -54
- package/dist/uploader/uploader.interfaces.d.ts.map +1 -1
- package/dist/uploader/uploader.interfaces.js +8 -0
- package/dist/uploader/uploader.js +72 -124
- package/docs/MIGRATION.md +696 -0
- package/package.json +35 -22
- package/dist/attachments-streaming/attachments-streaming-pool.test.d.ts +0 -2
- package/dist/attachments-streaming/attachments-streaming-pool.test.d.ts.map +0 -1
- package/dist/attachments-streaming/attachments-streaming-pool.test.js +0 -321
- package/dist/common/control-protocol.d.ts +0 -10
- package/dist/common/control-protocol.d.ts.map +0 -1
- package/dist/common/control-protocol.js +0 -31
- package/dist/common/errors.d.ts +0 -6
- package/dist/common/errors.d.ts.map +0 -1
- package/dist/common/errors.js +0 -4
- package/dist/common/event-type-translation.d.ts +0 -24
- package/dist/common/event-type-translation.d.ts.map +0 -1
- package/dist/common/event-type-translation.js +0 -117
- package/dist/common/install-initial-domain-mapping.d.ts +0 -4
- package/dist/common/install-initial-domain-mapping.d.ts.map +0 -1
- package/dist/common/install-initial-domain-mapping.test.d.ts +0 -2
- package/dist/common/install-initial-domain-mapping.test.d.ts.map +0 -1
- package/dist/common/install-initial-domain-mapping.test.js +0 -208
- package/dist/deprecated/adapter/index.d.ts +0 -62
- package/dist/deprecated/adapter/index.d.ts.map +0 -1
- package/dist/deprecated/adapter/index.js +0 -151
- package/dist/deprecated/common/helpers.d.ts +0 -7
- package/dist/deprecated/common/helpers.d.ts.map +0 -1
- package/dist/deprecated/common/helpers.js +0 -47
- package/dist/deprecated/demo-extractor/external_domain_metadata.json +0 -38
- package/dist/deprecated/demo-extractor/index.d.ts +0 -18
- package/dist/deprecated/demo-extractor/index.d.ts.map +0 -1
- package/dist/deprecated/demo-extractor/index.js +0 -161
- package/dist/deprecated/http/client.d.ts +0 -22
- package/dist/deprecated/http/client.d.ts.map +0 -1
- package/dist/deprecated/http/client.js +0 -161
- package/dist/deprecated/uploader/index.d.ts +0 -35
- package/dist/deprecated/uploader/index.d.ts.map +0 -1
- package/dist/deprecated/uploader/index.js +0 -161
- package/dist/http/axios-client-internal.d.ts.map +0 -1
- package/dist/http/axios-client-internal.test.d.ts +0 -2
- package/dist/http/axios-client-internal.test.d.ts.map +0 -1
- package/dist/http/axios-client-internal.test.js +0 -154
- package/dist/http/axios-client.d.ts +0 -27
- package/dist/http/axios-client.d.ts.map +0 -1
- package/dist/http/axios-client.js +0 -57
- package/dist/http/constants.d.ts +0 -4
- package/dist/http/constants.d.ts.map +0 -1
- package/dist/http/constants.js +0 -6
- package/dist/http/index.d.ts +0 -3
- package/dist/http/index.d.ts.map +0 -1
- package/dist/http/index.js +0 -18
- package/dist/http/types.d.ts +0 -17
- package/dist/http/types.d.ts.map +0 -1
- package/dist/http/types.js +0 -2
- package/dist/logger/logger.constants.d.ts +0 -6
- package/dist/logger/logger.constants.d.ts.map +0 -1
- package/dist/logger/logger.constants.js +0 -13
- package/dist/logger/logger.context.d.ts +0 -58
- package/dist/logger/logger.context.d.ts.map +0 -1
- package/dist/logger/logger.context.js +0 -86
- package/dist/logger/logger.test.d.ts +0 -2
- package/dist/logger/logger.test.d.ts.map +0 -1
- package/dist/logger/logger.test.js +0 -490
- package/dist/mappers/mappers.interface.d.ts +0 -294
- package/dist/mappers/mappers.interface.d.ts.map +0 -1
- package/dist/mappers/mappers.test.d.ts +0 -2
- package/dist/mappers/mappers.test.d.ts.map +0 -1
- package/dist/mappers/mappers.test.js +0 -107
- package/dist/multithreading/create-worker.test.d.ts +0 -2
- package/dist/multithreading/create-worker.test.d.ts.map +0 -1
- package/dist/multithreading/create-worker.test.js +0 -89
- package/dist/multithreading/spawn/spawn.helpers.test.d.ts +0 -2
- package/dist/multithreading/spawn/spawn.helpers.test.d.ts.map +0 -1
- package/dist/multithreading/spawn/spawn.helpers.test.js +0 -293
- package/dist/multithreading/worker-adapter/worker-adapter.artifacts.test.d.ts +0 -2
- package/dist/multithreading/worker-adapter/worker-adapter.artifacts.test.d.ts.map +0 -1
- package/dist/multithreading/worker-adapter/worker-adapter.artifacts.test.js +0 -127
- package/dist/multithreading/worker-adapter/worker-adapter.d.ts +0 -91
- package/dist/multithreading/worker-adapter/worker-adapter.d.ts.map +0 -1
- package/dist/multithreading/worker-adapter/worker-adapter.helpers.d.ts +0 -22
- package/dist/multithreading/worker-adapter/worker-adapter.helpers.d.ts.map +0 -1
- package/dist/multithreading/worker-adapter/worker-adapter.helpers.test.d.ts +0 -2
- package/dist/multithreading/worker-adapter/worker-adapter.helpers.test.d.ts.map +0 -1
- package/dist/multithreading/worker-adapter/worker-adapter.helpers.test.js +0 -514
- package/dist/multithreading/worker-adapter/worker-adapter.js +0 -745
- package/dist/multithreading/worker-adapter/worker-adapter.test.d.ts +0 -2
- package/dist/multithreading/worker-adapter/worker-adapter.test.d.ts.map +0 -1
- package/dist/multithreading/worker-adapter/worker-adapter.test.js +0 -483
- package/dist/repo/repo.test.d.ts +0 -2
- package/dist/repo/repo.test.d.ts.map +0 -1
- package/dist/repo/repo.test.js +0 -131
- package/dist/state/state.test.d.ts +0 -2
- package/dist/state/state.test.d.ts.map +0 -1
- package/dist/state/state.test.js +0 -224
- package/dist/types/extraction.test.d.ts +0 -2
- package/dist/types/extraction.test.d.ts.map +0 -1
- package/dist/types/extraction.test.js +0 -70
- package/dist/types/index.d.ts +0 -10
- package/dist/types/index.d.ts.map +0 -1
- package/dist/types/index.js +0 -18
- package/dist/uploader/uploader.helpers.test.d.ts +0 -2
- package/dist/uploader/uploader.helpers.test.d.ts.map +0 -1
- package/dist/uploader/uploader.helpers.test.js +0 -267
- package/dist/uploader/uploader.test.d.ts +0 -2
- package/dist/uploader/uploader.test.d.ts.map +0 -1
- package/dist/uploader/uploader.test.js +0 -589
|
@@ -1,181 +1,103 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Schema version for the external domain metadata format.
|
|
3
|
-
*/
|
|
4
1
|
export type SchemaVersion = 'v0.2.0';
|
|
5
|
-
/** Key identifying a record type in the record_types map, refers_to maps, or type_keys arrays. */
|
|
6
2
|
export type RecordTypeKey = string;
|
|
7
|
-
/** Key identifying a field within a record type or struct type fields map. */
|
|
8
3
|
export type FieldKey = string;
|
|
9
|
-
/** Key identifying an enum value in EnumValue.key or stage diagram stages map keys. */
|
|
10
4
|
export type EnumValueKey = string;
|
|
11
|
-
/** Key identifying a struct type in the struct_types map. */
|
|
12
5
|
export type StructTypeKey = string;
|
|
13
|
-
/** Key identifying a record type category in the record_type_categories map. */
|
|
14
6
|
export type RecordTypeCategoryKey = string;
|
|
15
|
-
/** Key identifying a state in the stage diagram states map. */
|
|
16
7
|
export type StateKey = string;
|
|
17
|
-
/** Key identifying a stage in the stage diagram stages map. */
|
|
18
8
|
export type StageKey = string;
|
|
19
|
-
|
|
20
|
-
* Field type discriminator.
|
|
21
|
-
*/
|
|
22
|
-
export type FieldType = 'bool' | 'int' | 'float' | 'text' | 'rich_text' | 'reference' | 'typed_reference' | 'enum' | 'date' | 'timestamp' | 'struct' | 'permission' | 'record_type_privilege' | 'field_privilege' | 'conditional_privilege';
|
|
23
|
-
/**
|
|
24
|
-
* Reference type indicating parent-child relationship.
|
|
25
|
-
*/
|
|
9
|
+
export type FieldType = 'bool' | 'int' | 'float' | 'text' | 'rich_text' | 'reference' | 'typed_reference' | 'enum' | 'date' | 'timestamp' | 'struct' | 'permission' | 'record_type_privilege' | 'field_privilege' | 'conditional_privilege' | 'participation';
|
|
26
10
|
export type ReferenceType = 'child' | 'parent';
|
|
27
|
-
/**
|
|
28
|
-
* Comparator for field conditions.
|
|
29
|
-
*/
|
|
30
11
|
export type FieldConditionComparator = 'eq' | 'ne';
|
|
31
|
-
/**
|
|
32
|
-
* Effect applied when a field condition is met.
|
|
33
|
-
*/
|
|
34
12
|
export type FieldConditionEffect = 'require' | 'show';
|
|
35
|
-
/**
|
|
36
|
-
* Scope of a record type.
|
|
37
|
-
*/
|
|
38
13
|
export type RecordTypeScope = 'metadata_is_system_scoped' | 'data_is_system_scoped';
|
|
39
|
-
/**
|
|
40
|
-
* Collection constraints for fields that are collections of values.
|
|
41
|
-
*/
|
|
42
14
|
export interface CollectionData {
|
|
43
15
|
min_length?: number;
|
|
44
16
|
max_length?: number;
|
|
45
17
|
}
|
|
46
|
-
/**
|
|
47
|
-
* Integer field constraints.
|
|
48
|
-
*/
|
|
49
18
|
export interface IntData {
|
|
50
19
|
min?: number;
|
|
51
20
|
max?: number;
|
|
52
21
|
}
|
|
53
|
-
/**
|
|
54
|
-
* Float field constraints.
|
|
55
|
-
*/
|
|
56
22
|
export interface FloatData {
|
|
57
23
|
min?: number;
|
|
58
24
|
max?: number;
|
|
59
25
|
}
|
|
60
|
-
/**
|
|
61
|
-
* Text field constraints.
|
|
62
|
-
*/
|
|
63
26
|
export interface TextData {
|
|
64
27
|
min_length?: number;
|
|
65
28
|
max_length?: number;
|
|
66
29
|
}
|
|
67
|
-
/**
|
|
68
|
-
* Enum value definition.
|
|
69
|
-
*/
|
|
70
30
|
export interface EnumValue {
|
|
71
|
-
/** The enum value
|
|
31
|
+
/** The enum value as it actually occurs in the json data. */
|
|
72
32
|
key: EnumValueKey;
|
|
73
|
-
/** The human readable name of the enum value */
|
|
74
33
|
name?: string;
|
|
75
34
|
description?: string;
|
|
76
|
-
/** Deprecated
|
|
35
|
+
/** Deprecated values may still occur in the data, but should not be used in new data. */
|
|
77
36
|
is_deprecated?: boolean;
|
|
78
37
|
}
|
|
79
|
-
/**
|
|
80
|
-
* Enum field data containing possible values.
|
|
81
|
-
*/
|
|
82
38
|
export interface EnumData {
|
|
83
39
|
values: EnumValue[];
|
|
84
40
|
}
|
|
85
|
-
/**
|
|
86
|
-
* Details about how a reference targets another record type.
|
|
87
|
-
*/
|
|
88
41
|
export interface ReferenceDetail {
|
|
89
42
|
/** The field in the target record type by which it is referenced. Assumed to be the primary key if not set. */
|
|
90
43
|
by_field?: FieldKey;
|
|
91
44
|
}
|
|
92
|
-
/**
|
|
93
|
-
* Reference field data specifying target record types.
|
|
94
|
-
*/
|
|
95
45
|
export interface ReferenceData {
|
|
96
|
-
/** The record types that this reference can refer to */
|
|
97
46
|
refers_to: Record<RecordTypeKey, ReferenceDetail>;
|
|
98
|
-
/**
|
|
47
|
+
/** A 'parent' reference refers to a record that has special ownership over the child. */
|
|
99
48
|
reference_type?: ReferenceType;
|
|
100
49
|
}
|
|
101
|
-
/**
|
|
102
|
-
* Typed reference field data specifying target record types.
|
|
103
|
-
*/
|
|
104
50
|
export interface TypedReferenceData {
|
|
105
|
-
/** The record types that this reference can refer to */
|
|
106
51
|
refers_to: Record<RecordTypeKey, ReferenceDetail>;
|
|
107
|
-
/**
|
|
52
|
+
/** A 'parent' reference refers to a record that has special ownership over the child. */
|
|
108
53
|
reference_type?: ReferenceType;
|
|
109
54
|
}
|
|
110
|
-
/**
|
|
111
|
-
* Struct field data referencing a struct type.
|
|
112
|
-
*/
|
|
113
55
|
export interface StructData {
|
|
114
56
|
key?: StructTypeKey;
|
|
115
57
|
}
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
58
|
+
export interface ParticipationData {
|
|
59
|
+
refers_to: Record<RecordTypeKey, ReferenceDetail>;
|
|
60
|
+
}
|
|
119
61
|
export interface PermissionData {
|
|
120
62
|
member_id?: ReferenceData;
|
|
121
63
|
role?: EnumData;
|
|
122
64
|
}
|
|
123
|
-
/**
|
|
124
|
-
* Conditional privilege data for authorization.
|
|
125
|
-
*/
|
|
126
65
|
export interface ConditionalPrivilegeData {
|
|
127
|
-
/**
|
|
66
|
+
/** Record types or record type categories that can be targeted. */
|
|
128
67
|
type_keys: RecordTypeKey[];
|
|
129
68
|
}
|
|
130
|
-
/**
|
|
131
|
-
* Field privilege data for authorization.
|
|
132
|
-
*/
|
|
133
69
|
export interface FieldPrivilegeData {
|
|
134
|
-
/**
|
|
70
|
+
/** Record types or record type categories that can be targeted. */
|
|
135
71
|
type_keys: RecordTypeKey[];
|
|
136
72
|
}
|
|
137
|
-
/**
|
|
138
|
-
* Record type privilege data for authorization.
|
|
139
|
-
*/
|
|
140
73
|
export interface RecordTypePrivilegeData {
|
|
141
|
-
/**
|
|
74
|
+
/** Record types or record type categories that can be targeted. */
|
|
142
75
|
type_keys: RecordTypeKey[];
|
|
143
76
|
}
|
|
144
|
-
/**
|
|
145
|
-
* Target type key data for authorization policy.
|
|
146
|
-
*/
|
|
147
77
|
export interface TargetTypeKeyData {
|
|
148
|
-
/**
|
|
78
|
+
/** Record types or record type categories that can be targeted. */
|
|
149
79
|
type_keys: RecordTypeKey[];
|
|
150
80
|
}
|
|
151
|
-
/**
|
|
152
|
-
* Field reference data (currently empty, reserved for future use).
|
|
153
|
-
*/
|
|
81
|
+
/** Currently empty, reserved for future use. */
|
|
154
82
|
export interface FieldReferenceData {
|
|
155
83
|
[key: string]: never;
|
|
156
84
|
}
|
|
157
|
-
/**
|
|
158
|
-
* Field definition with type discriminator and type-specific data.
|
|
159
|
-
*/
|
|
85
|
+
/** Field definition; `type` selects which type-specific data property applies. */
|
|
160
86
|
export interface Field {
|
|
161
|
-
/** The type of the field */
|
|
162
87
|
type: FieldType;
|
|
163
|
-
/** The human readable name of the field */
|
|
164
88
|
name?: string;
|
|
165
89
|
description?: string;
|
|
166
|
-
/** Required
|
|
90
|
+
/** Required in the domain model of the external system. */
|
|
167
91
|
is_required?: boolean;
|
|
168
|
-
/**
|
|
92
|
+
/** Can't be set on create/update; filled in by some process in the system. */
|
|
169
93
|
is_read_only?: boolean | null;
|
|
170
|
-
/** Fields that are write only should only be written to. */
|
|
171
94
|
is_write_only?: boolean | null;
|
|
172
|
-
/**
|
|
95
|
+
/** Can be used for searching, sorting or filtering. */
|
|
173
96
|
is_indexed?: boolean | null;
|
|
174
|
-
/**
|
|
97
|
+
/** Can be used to uniquely look up a record. */
|
|
175
98
|
is_identifier?: boolean | null;
|
|
176
|
-
/** Default value for the field */
|
|
177
99
|
default_value?: boolean | number | string;
|
|
178
|
-
/** If
|
|
100
|
+
/** If set, the field is a collection of the given type. */
|
|
179
101
|
collection?: CollectionData;
|
|
180
102
|
int?: IntData;
|
|
181
103
|
float?: FloatData;
|
|
@@ -190,130 +112,86 @@ export interface Field {
|
|
|
190
112
|
record_type_privilege?: RecordTypePrivilegeData;
|
|
191
113
|
field_privilege?: FieldPrivilegeData;
|
|
192
114
|
conditional_privilege?: ConditionalPrivilegeData;
|
|
115
|
+
participation?: ParticipationData;
|
|
193
116
|
}
|
|
194
|
-
/**
|
|
195
|
-
* Field condition definition.
|
|
196
|
-
*/
|
|
117
|
+
/** When the controlling field's value matches `value` (per `comparator`), `effect` is applied to `affected_fields`. */
|
|
197
118
|
export interface FieldCondition {
|
|
198
|
-
/** The value of the controlling field that will be compared against to see if the condition is met. */
|
|
199
119
|
value: unknown;
|
|
200
|
-
/** The comparator that will be used to compare the controlling field's value against the Value. */
|
|
201
120
|
comparator: FieldConditionComparator;
|
|
202
|
-
/** The fields that will be affected by the condition being met. */
|
|
203
121
|
affected_fields: FieldKey[];
|
|
204
|
-
/** The effect that will be applied to the affected fields if the condition is met. */
|
|
205
122
|
effect: FieldConditionEffect;
|
|
206
123
|
}
|
|
207
|
-
/**
|
|
208
|
-
* Array of field conditions.
|
|
209
|
-
*/
|
|
210
124
|
export type FieldConditions = FieldCondition[];
|
|
211
|
-
/**
|
|
212
|
-
* Custom link names for forward and backward directions.
|
|
213
|
-
*/
|
|
214
125
|
export interface CustomLinkNames {
|
|
215
|
-
/** The forward name of the link */
|
|
216
126
|
forward_name: string;
|
|
217
|
-
/** The backward name of the link */
|
|
218
127
|
backward_name: string;
|
|
219
128
|
}
|
|
220
|
-
/**
|
|
221
|
-
* Custom link data for defining link types.
|
|
222
|
-
*/
|
|
223
129
|
export interface CustomLinkData {
|
|
224
130
|
/** The field that defines the link types in the system. */
|
|
225
131
|
link_type_field: FieldKey;
|
|
226
132
|
link_direction_names: Record<string, CustomLinkNames> | null;
|
|
227
133
|
}
|
|
228
|
-
/**
|
|
229
|
-
* Custom stage definition in a stage diagram.
|
|
230
|
-
*/
|
|
231
134
|
export interface CustomStage {
|
|
232
|
-
/**
|
|
135
|
+
/** Must match a key in the diagram's 'states' map or be a default: 'open', 'in_progress', 'closed'. */
|
|
233
136
|
state?: StateKey;
|
|
234
|
-
/**
|
|
137
|
+
/** Stage names this stage can transition to. */
|
|
235
138
|
transitions_to?: StageKey[];
|
|
236
139
|
}
|
|
237
|
-
/**
|
|
238
|
-
* Custom state definition in a stage diagram.
|
|
239
|
-
*/
|
|
240
140
|
export interface CustomState {
|
|
241
|
-
/** The human readable name of the custom state. */
|
|
242
141
|
name: string;
|
|
243
|
-
/** Denotes that this state is an end state. */
|
|
244
142
|
is_end_state?: boolean;
|
|
245
|
-
/**
|
|
143
|
+
/** Sort order. */
|
|
246
144
|
ordinal?: number;
|
|
247
145
|
}
|
|
248
|
-
/**
|
|
249
|
-
* Stage diagram definition for record type workflow.
|
|
250
|
-
*/
|
|
251
146
|
export interface StageDiagram {
|
|
252
147
|
/** The field that represents the stage in the external system. */
|
|
253
148
|
controlling_field: FieldKey;
|
|
254
|
-
/**
|
|
149
|
+
/** Stage keys must match the enum values in the controlling field. */
|
|
255
150
|
stages: Record<StageKey, CustomStage>;
|
|
256
|
-
/** The stage
|
|
151
|
+
/** The stage the parent record type starts in when created. */
|
|
257
152
|
starting_stage?: StageKey;
|
|
258
|
-
/** A map of the states/status categories that should be created. */
|
|
259
153
|
states?: Record<StateKey, CustomState>;
|
|
260
|
-
/**
|
|
154
|
+
/** No explicit transitions; create as an 'all-to-all' diagram. */
|
|
261
155
|
all_transitions_allowed?: boolean;
|
|
262
156
|
}
|
|
263
|
-
/**
|
|
264
|
-
* Record type category definition.
|
|
265
|
-
*/
|
|
266
157
|
export interface RecordTypeCategory {
|
|
267
|
-
/** The human readable name of the record type category */
|
|
268
158
|
name?: string;
|
|
269
|
-
/**
|
|
159
|
+
/** Whether a record can move between record types of this category while preserving its identity. */
|
|
270
160
|
are_record_type_conversions_possible?: boolean;
|
|
271
161
|
}
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
*/
|
|
162
|
+
export interface Attachments {
|
|
163
|
+
is_extractable?: boolean;
|
|
164
|
+
/** Whether the connector supports creating attachments in the external system. */
|
|
165
|
+
is_loadable?: boolean;
|
|
166
|
+
}
|
|
275
167
|
export interface RecordType {
|
|
276
|
-
/** The fields of the record type */
|
|
277
168
|
fields: Record<FieldKey, Field>;
|
|
278
|
-
/** The human readable name of the record type */
|
|
279
169
|
name?: string;
|
|
280
170
|
description?: string;
|
|
281
171
|
category?: RecordTypeCategoryKey;
|
|
282
|
-
/** Whether the
|
|
172
|
+
/** Whether the connector supports creating this record type in the external system. */
|
|
283
173
|
is_loadable?: boolean;
|
|
284
|
-
/** Whether the record type sends the complete system state in every sync */
|
|
174
|
+
/** Whether the record type sends the complete system state in every sync. */
|
|
285
175
|
is_snapshot?: boolean;
|
|
286
|
-
/**
|
|
176
|
+
/** No ID field; primarily used for authorization policies. */
|
|
287
177
|
no_identifier?: boolean;
|
|
288
|
-
/** Indicates the scope of this record type */
|
|
289
178
|
scope?: RecordTypeScope;
|
|
290
|
-
/** Field conditions for this record type */
|
|
291
179
|
conditions?: Record<FieldKey, FieldConditions>;
|
|
292
|
-
/** Stage diagram for workflow */
|
|
293
180
|
stage_diagram?: StageDiagram;
|
|
294
|
-
/** Link naming data for custom links */
|
|
295
181
|
link_naming_data?: CustomLinkData;
|
|
182
|
+
attachments?: Attachments;
|
|
296
183
|
}
|
|
297
|
-
/**
|
|
298
|
-
* Struct type definition for reusable field structures.
|
|
299
|
-
*/
|
|
184
|
+
/** Reusable field structure. */
|
|
300
185
|
export interface StructType {
|
|
301
|
-
/** The fields of the struct type */
|
|
302
186
|
fields: Record<FieldKey, Field>;
|
|
303
|
-
/** The human readable name of the struct type */
|
|
304
187
|
name?: string;
|
|
305
188
|
}
|
|
306
|
-
/**
|
|
307
|
-
* External domain metadata describing the logical structure of an external system.
|
|
308
|
-
*/
|
|
189
|
+
/** Describes the logical structure of an external system. */
|
|
309
190
|
export interface ExternalDomainMetadata {
|
|
310
|
-
/** The record types in the domain */
|
|
311
191
|
record_types: Record<RecordTypeKey, RecordType>;
|
|
312
|
-
/** Record type categories */
|
|
313
192
|
record_type_categories?: Record<RecordTypeCategoryKey, RecordTypeCategory>;
|
|
314
|
-
/** Struct types for reusable field structures */
|
|
315
193
|
struct_types?: Record<StructTypeKey, StructType>;
|
|
316
|
-
/**
|
|
194
|
+
/** Version of the metadata format itself. */
|
|
317
195
|
schema_version?: SchemaVersion;
|
|
318
196
|
}
|
|
319
197
|
//# sourceMappingURL=external-domain-metadata.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"external-domain-metadata.d.ts","sourceRoot":"","sources":["../../src/types/external-domain-metadata.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"external-domain-metadata.d.ts","sourceRoot":"","sources":["../../src/types/external-domain-metadata.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC;AAErC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,KAAK,GACL,OAAO,GACP,MAAM,GACN,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,MAAM,GACN,MAAM,GACN,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,uBAAuB,GACvB,iBAAiB,GACjB,uBAAuB,GACvB,eAAe,CAAC;AAEpB,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE/C,MAAM,MAAM,wBAAwB,GAAG,IAAI,GAAG,IAAI,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,MAAM,CAAC;AAEtD,MAAM,MAAM,eAAe,GACvB,2BAA2B,GAC3B,uBAAuB,CAAC;AAE5B,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,6DAA6D;IAC7D,GAAG,EAAE,YAAY,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yFAAyF;IACzF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,+GAA+G;IAC/G,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;IAClD,yFAAyF;IACzF,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;IAClD,yFAAyF;IACzF,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,CAAC,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;CACnD;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC,mEAAmE;IACnE,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,mEAAmE;IACnE,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC,mEAAmE;IACnE,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC,mEAAmE;IACnE,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,gDAAgD;AAChD,MAAM,WAAW,kBAAkB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC;CACtB;AAED,kFAAkF;AAClF,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,uDAAuD;IACvD,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,gDAAgD;IAChD,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,aAAa,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IAC1C,2DAA2D;IAC3D,UAAU,CAAC,EAAE,cAAc,CAAC;IAG5B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,qBAAqB,CAAC,EAAE,uBAAuB,CAAC;IAChD,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,qBAAqB,CAAC,EAAE,wBAAwB,CAAC;IACjD,aAAa,CAAC,EAAE,iBAAiB,CAAC;CACnC;AAED,uHAAuH;AACvH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,wBAAwB,CAAC;IACrC,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,MAAM,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,MAAM,eAAe,GAAG,cAAc,EAAE,CAAC;AAE/C,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,2DAA2D;IAC3D,eAAe,EAAE,QAAQ,CAAC;IAC1B,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED,MAAM,WAAW,WAAW;IAC1B,uGAAuG;IACvG,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,gDAAgD;IAChD,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,kEAAkE;IAClE,iBAAiB,EAAE,QAAQ,CAAC;IAC5B,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,+DAA+D;IAC/D,cAAc,CAAC,EAAE,QAAQ,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvC,kEAAkE;IAClE,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qGAAqG;IACrG,oCAAoC,CAAC,EAAE,OAAO,CAAC;CAChD;AAED,MAAM,WAAW,WAAW;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kFAAkF;IAClF,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,uFAAuF;IACvF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6EAA6E;IAC7E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8DAA8D;IAC9D,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IAC/C,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,gBAAgB,CAAC,EAAE,cAAc,CAAC;IAClC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,gCAAgC;AAChC,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6DAA6D;AAC7D,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,MAAM,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAChD,sBAAsB,CAAC,EAAE,MAAM,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAAC;IAC3E,YAAY,CAAC,EAAE,MAAM,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACjD,6CAA6C;IAC7C,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC"}
|