@viu/emporix-sdk 3.1.0 → 3.1.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/CHANGELOG.md +8 -0
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +112 -5
- package/dist/index.d.ts +112 -5
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -3311,7 +3311,7 @@ type McpToolConfigResponse = {
|
|
|
3311
3311
|
*/
|
|
3312
3312
|
type McpToolRequest = {
|
|
3313
3313
|
/**
|
|
3314
|
-
* Unique name of the tool. Must
|
|
3314
|
+
* Unique name of the tool. Must contain only letters, numbers, and underscores.
|
|
3315
3315
|
*/
|
|
3316
3316
|
name: string;
|
|
3317
3317
|
/**
|
|
@@ -3335,7 +3335,7 @@ type McpToolRequest = {
|
|
|
3335
3335
|
*/
|
|
3336
3336
|
type McpToolResponse = {
|
|
3337
3337
|
/**
|
|
3338
|
-
* Unique name of the tool.
|
|
3338
|
+
* Unique name of the tool. Contains only letters, numbers, and underscores.
|
|
3339
3339
|
*/
|
|
3340
3340
|
name?: string;
|
|
3341
3341
|
/**
|
|
@@ -8932,13 +8932,22 @@ type ImportConfig$1 = {
|
|
|
8932
8932
|
*/
|
|
8933
8933
|
sourceConnId?: string;
|
|
8934
8934
|
/**
|
|
8935
|
-
* Whether
|
|
8935
|
+
* Whether AI-assisted mapping suggestions are enabled for the configuration.
|
|
8936
8936
|
*/
|
|
8937
|
-
|
|
8937
|
+
aiEnabled?: boolean;
|
|
8938
8938
|
/**
|
|
8939
8939
|
* Whether the configuration is active.
|
|
8940
8940
|
*/
|
|
8941
8941
|
enabled?: boolean;
|
|
8942
|
+
/**
|
|
8943
|
+
* Incremented on every change to the configuration.
|
|
8944
|
+
*/
|
|
8945
|
+
version?: number;
|
|
8946
|
+
healthThresholds?: HealthThresholds;
|
|
8947
|
+
/**
|
|
8948
|
+
* The identifier of the user who created the configuration.
|
|
8949
|
+
*/
|
|
8950
|
+
createdBy?: string;
|
|
8942
8951
|
/**
|
|
8943
8952
|
* When the configuration was created.
|
|
8944
8953
|
*/
|
|
@@ -8982,6 +8991,57 @@ type ImportStream$1 = {
|
|
|
8982
8991
|
* How the stream contributes to the target.
|
|
8983
8992
|
*/
|
|
8984
8993
|
mode?: 'STANDALONE' | 'COMPOSITE_CHILD' | 'COMPOSITE_MERGE';
|
|
8994
|
+
/**
|
|
8995
|
+
* The source field whose value is tracked as the delta watermark. A delta run extracts only the records whose value is newer than the last run's.
|
|
8996
|
+
*/
|
|
8997
|
+
deltaField?: string;
|
|
8998
|
+
/**
|
|
8999
|
+
* How the delta field's values are formatted, so they can be compared correctly.
|
|
9000
|
+
*/
|
|
9001
|
+
deltaFieldFormat?: 'DATE' | 'UNIX_SECONDS' | 'UNIX_MILLIS';
|
|
9002
|
+
/**
|
|
9003
|
+
* For a composite child stream, the name of the stream it contributes to.
|
|
9004
|
+
*/
|
|
9005
|
+
compositeParent?: string;
|
|
9006
|
+
/**
|
|
9007
|
+
* For a composite child stream, the source field holding its parent's key.
|
|
9008
|
+
*/
|
|
9009
|
+
linkingField?: string;
|
|
9010
|
+
/**
|
|
9011
|
+
* For a composite child stream, the parent attribute its records are embedded into.
|
|
9012
|
+
*/
|
|
9013
|
+
embedAttribute?: string;
|
|
9014
|
+
/**
|
|
9015
|
+
* How a composite child's records reach the parent object.
|
|
9016
|
+
*/
|
|
9017
|
+
childStrategy?: 'EMBED' | 'PATCH';
|
|
9018
|
+
/**
|
|
9019
|
+
* How an existing target object is updated. `PATCH` changes only the mapped fields and preserves everything else; `REPLACE_PUT` replaces the whole object, so fields this import does not manage are cleared.
|
|
9020
|
+
*/
|
|
9021
|
+
writeStrategy?: 'PATCH' | 'MERGE_PUT' | 'REPLACE_PUT';
|
|
9022
|
+
/**
|
|
9023
|
+
* A source field whose value routes each record to a different target type, as defined by `discriminatorMap`.
|
|
9024
|
+
*/
|
|
9025
|
+
discriminatorField?: string;
|
|
9026
|
+
/**
|
|
9027
|
+
* Maps a discriminator value to the target type that receives those records.
|
|
9028
|
+
*/
|
|
9029
|
+
discriminatorMap?: {
|
|
9030
|
+
[key: string]: string;
|
|
9031
|
+
};
|
|
9032
|
+
/**
|
|
9033
|
+
* Whether the stream reacts to its target objects being deleted outside the import.
|
|
9034
|
+
*/
|
|
9035
|
+
targetDeleteSubscriptionEnabled?: boolean;
|
|
9036
|
+
/**
|
|
9037
|
+
* What happens when a record deleted in the target is seen in the source again.
|
|
9038
|
+
*/
|
|
9039
|
+
onTargetReappear?: 'IGNORE' | 'READD';
|
|
9040
|
+
healthThresholds?: HealthThresholds;
|
|
9041
|
+
/**
|
|
9042
|
+
* When the stream was created.
|
|
9043
|
+
*/
|
|
9044
|
+
createdAt?: string;
|
|
8985
9045
|
/**
|
|
8986
9046
|
* Whether the stream is active.
|
|
8987
9047
|
*/
|
|
@@ -9084,6 +9144,26 @@ type ImportRun$1 = {
|
|
|
9084
9144
|
* A terminal status message, typically set on failure.
|
|
9085
9145
|
*/
|
|
9086
9146
|
message?: string;
|
|
9147
|
+
/**
|
|
9148
|
+
* When the run retries another run's failed records, the identifier of that original run.
|
|
9149
|
+
*/
|
|
9150
|
+
retryOfRunId?: string;
|
|
9151
|
+
/**
|
|
9152
|
+
* Whether the run rewrote every record, bypassing the skip-if-unchanged check.
|
|
9153
|
+
*/
|
|
9154
|
+
force?: boolean;
|
|
9155
|
+
/**
|
|
9156
|
+
* Whether the run only extracted, mapped, and validated, writing nothing to the target. A dry run legitimately reports zero for every counter, so this distinguishes it from a run that wrote nothing because it failed.
|
|
9157
|
+
*/
|
|
9158
|
+
dryRun?: boolean;
|
|
9159
|
+
/**
|
|
9160
|
+
* Whether cancellation has been requested for a run that is still finishing.
|
|
9161
|
+
*/
|
|
9162
|
+
cancelRequested?: boolean;
|
|
9163
|
+
/**
|
|
9164
|
+
* For a dry run, how many mapped records were kept as a sample.
|
|
9165
|
+
*/
|
|
9166
|
+
dryRunSampleSize?: number;
|
|
9087
9167
|
};
|
|
9088
9168
|
/**
|
|
9089
9169
|
* Run stream progress
|
|
@@ -9267,10 +9347,37 @@ type ImportedRecord$1 = {
|
|
|
9267
9347
|
*/
|
|
9268
9348
|
importedAt?: string;
|
|
9269
9349
|
};
|
|
9350
|
+
/**
|
|
9351
|
+
* Health thresholds
|
|
9352
|
+
*
|
|
9353
|
+
* The limits that decide whether a stream is reported as `GREEN`, `AMBER`, or `RED`. Each field is optional and resolves independently. An unset field falls back through the hierarchy, from the most specific level to the least specific: stream, configuration, tenant, then the built-in default.
|
|
9354
|
+
*/
|
|
9355
|
+
type HealthThresholds = {
|
|
9356
|
+
/**
|
|
9357
|
+
* The share of failed records (0..1) at or above which the stream is `AMBER`.
|
|
9358
|
+
*/
|
|
9359
|
+
failureRatioAmber?: number;
|
|
9360
|
+
/**
|
|
9361
|
+
* The share of failed records (0..1) at or above which the stream is `RED`.
|
|
9362
|
+
*/
|
|
9363
|
+
failureRatioRed?: number;
|
|
9364
|
+
/**
|
|
9365
|
+
* The age threshold, in hours, for the stream's newest data. The stream is `AMBER` when the data's age reaches or exceeds this threshold.
|
|
9366
|
+
*/
|
|
9367
|
+
staleAmberHours?: number;
|
|
9368
|
+
/**
|
|
9369
|
+
* The age threshold, in hours, for the stream's newest data. The stream is `RED` when the data's age reaches or exceeds this threshold.
|
|
9370
|
+
*/
|
|
9371
|
+
staleRedHours?: number;
|
|
9372
|
+
/**
|
|
9373
|
+
* Whether a failed most-recent run makes the stream `RED` regardless of the other limits.
|
|
9374
|
+
*/
|
|
9375
|
+
failedRunIsRed?: boolean;
|
|
9376
|
+
};
|
|
9270
9377
|
type PostImporttoolTriggerRunData = {
|
|
9271
9378
|
body?: {
|
|
9272
9379
|
/**
|
|
9273
|
-
* The run mode.
|
|
9380
|
+
* The run mode. When omitted, defaults to `DELTA`.
|
|
9274
9381
|
*/
|
|
9275
9382
|
mode?: 'FULL' | 'DELTA';
|
|
9276
9383
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -3311,7 +3311,7 @@ type McpToolConfigResponse = {
|
|
|
3311
3311
|
*/
|
|
3312
3312
|
type McpToolRequest = {
|
|
3313
3313
|
/**
|
|
3314
|
-
* Unique name of the tool. Must
|
|
3314
|
+
* Unique name of the tool. Must contain only letters, numbers, and underscores.
|
|
3315
3315
|
*/
|
|
3316
3316
|
name: string;
|
|
3317
3317
|
/**
|
|
@@ -3335,7 +3335,7 @@ type McpToolRequest = {
|
|
|
3335
3335
|
*/
|
|
3336
3336
|
type McpToolResponse = {
|
|
3337
3337
|
/**
|
|
3338
|
-
* Unique name of the tool.
|
|
3338
|
+
* Unique name of the tool. Contains only letters, numbers, and underscores.
|
|
3339
3339
|
*/
|
|
3340
3340
|
name?: string;
|
|
3341
3341
|
/**
|
|
@@ -8932,13 +8932,22 @@ type ImportConfig$1 = {
|
|
|
8932
8932
|
*/
|
|
8933
8933
|
sourceConnId?: string;
|
|
8934
8934
|
/**
|
|
8935
|
-
* Whether
|
|
8935
|
+
* Whether AI-assisted mapping suggestions are enabled for the configuration.
|
|
8936
8936
|
*/
|
|
8937
|
-
|
|
8937
|
+
aiEnabled?: boolean;
|
|
8938
8938
|
/**
|
|
8939
8939
|
* Whether the configuration is active.
|
|
8940
8940
|
*/
|
|
8941
8941
|
enabled?: boolean;
|
|
8942
|
+
/**
|
|
8943
|
+
* Incremented on every change to the configuration.
|
|
8944
|
+
*/
|
|
8945
|
+
version?: number;
|
|
8946
|
+
healthThresholds?: HealthThresholds;
|
|
8947
|
+
/**
|
|
8948
|
+
* The identifier of the user who created the configuration.
|
|
8949
|
+
*/
|
|
8950
|
+
createdBy?: string;
|
|
8942
8951
|
/**
|
|
8943
8952
|
* When the configuration was created.
|
|
8944
8953
|
*/
|
|
@@ -8982,6 +8991,57 @@ type ImportStream$1 = {
|
|
|
8982
8991
|
* How the stream contributes to the target.
|
|
8983
8992
|
*/
|
|
8984
8993
|
mode?: 'STANDALONE' | 'COMPOSITE_CHILD' | 'COMPOSITE_MERGE';
|
|
8994
|
+
/**
|
|
8995
|
+
* The source field whose value is tracked as the delta watermark. A delta run extracts only the records whose value is newer than the last run's.
|
|
8996
|
+
*/
|
|
8997
|
+
deltaField?: string;
|
|
8998
|
+
/**
|
|
8999
|
+
* How the delta field's values are formatted, so they can be compared correctly.
|
|
9000
|
+
*/
|
|
9001
|
+
deltaFieldFormat?: 'DATE' | 'UNIX_SECONDS' | 'UNIX_MILLIS';
|
|
9002
|
+
/**
|
|
9003
|
+
* For a composite child stream, the name of the stream it contributes to.
|
|
9004
|
+
*/
|
|
9005
|
+
compositeParent?: string;
|
|
9006
|
+
/**
|
|
9007
|
+
* For a composite child stream, the source field holding its parent's key.
|
|
9008
|
+
*/
|
|
9009
|
+
linkingField?: string;
|
|
9010
|
+
/**
|
|
9011
|
+
* For a composite child stream, the parent attribute its records are embedded into.
|
|
9012
|
+
*/
|
|
9013
|
+
embedAttribute?: string;
|
|
9014
|
+
/**
|
|
9015
|
+
* How a composite child's records reach the parent object.
|
|
9016
|
+
*/
|
|
9017
|
+
childStrategy?: 'EMBED' | 'PATCH';
|
|
9018
|
+
/**
|
|
9019
|
+
* How an existing target object is updated. `PATCH` changes only the mapped fields and preserves everything else; `REPLACE_PUT` replaces the whole object, so fields this import does not manage are cleared.
|
|
9020
|
+
*/
|
|
9021
|
+
writeStrategy?: 'PATCH' | 'MERGE_PUT' | 'REPLACE_PUT';
|
|
9022
|
+
/**
|
|
9023
|
+
* A source field whose value routes each record to a different target type, as defined by `discriminatorMap`.
|
|
9024
|
+
*/
|
|
9025
|
+
discriminatorField?: string;
|
|
9026
|
+
/**
|
|
9027
|
+
* Maps a discriminator value to the target type that receives those records.
|
|
9028
|
+
*/
|
|
9029
|
+
discriminatorMap?: {
|
|
9030
|
+
[key: string]: string;
|
|
9031
|
+
};
|
|
9032
|
+
/**
|
|
9033
|
+
* Whether the stream reacts to its target objects being deleted outside the import.
|
|
9034
|
+
*/
|
|
9035
|
+
targetDeleteSubscriptionEnabled?: boolean;
|
|
9036
|
+
/**
|
|
9037
|
+
* What happens when a record deleted in the target is seen in the source again.
|
|
9038
|
+
*/
|
|
9039
|
+
onTargetReappear?: 'IGNORE' | 'READD';
|
|
9040
|
+
healthThresholds?: HealthThresholds;
|
|
9041
|
+
/**
|
|
9042
|
+
* When the stream was created.
|
|
9043
|
+
*/
|
|
9044
|
+
createdAt?: string;
|
|
8985
9045
|
/**
|
|
8986
9046
|
* Whether the stream is active.
|
|
8987
9047
|
*/
|
|
@@ -9084,6 +9144,26 @@ type ImportRun$1 = {
|
|
|
9084
9144
|
* A terminal status message, typically set on failure.
|
|
9085
9145
|
*/
|
|
9086
9146
|
message?: string;
|
|
9147
|
+
/**
|
|
9148
|
+
* When the run retries another run's failed records, the identifier of that original run.
|
|
9149
|
+
*/
|
|
9150
|
+
retryOfRunId?: string;
|
|
9151
|
+
/**
|
|
9152
|
+
* Whether the run rewrote every record, bypassing the skip-if-unchanged check.
|
|
9153
|
+
*/
|
|
9154
|
+
force?: boolean;
|
|
9155
|
+
/**
|
|
9156
|
+
* Whether the run only extracted, mapped, and validated, writing nothing to the target. A dry run legitimately reports zero for every counter, so this distinguishes it from a run that wrote nothing because it failed.
|
|
9157
|
+
*/
|
|
9158
|
+
dryRun?: boolean;
|
|
9159
|
+
/**
|
|
9160
|
+
* Whether cancellation has been requested for a run that is still finishing.
|
|
9161
|
+
*/
|
|
9162
|
+
cancelRequested?: boolean;
|
|
9163
|
+
/**
|
|
9164
|
+
* For a dry run, how many mapped records were kept as a sample.
|
|
9165
|
+
*/
|
|
9166
|
+
dryRunSampleSize?: number;
|
|
9087
9167
|
};
|
|
9088
9168
|
/**
|
|
9089
9169
|
* Run stream progress
|
|
@@ -9267,10 +9347,37 @@ type ImportedRecord$1 = {
|
|
|
9267
9347
|
*/
|
|
9268
9348
|
importedAt?: string;
|
|
9269
9349
|
};
|
|
9350
|
+
/**
|
|
9351
|
+
* Health thresholds
|
|
9352
|
+
*
|
|
9353
|
+
* The limits that decide whether a stream is reported as `GREEN`, `AMBER`, or `RED`. Each field is optional and resolves independently. An unset field falls back through the hierarchy, from the most specific level to the least specific: stream, configuration, tenant, then the built-in default.
|
|
9354
|
+
*/
|
|
9355
|
+
type HealthThresholds = {
|
|
9356
|
+
/**
|
|
9357
|
+
* The share of failed records (0..1) at or above which the stream is `AMBER`.
|
|
9358
|
+
*/
|
|
9359
|
+
failureRatioAmber?: number;
|
|
9360
|
+
/**
|
|
9361
|
+
* The share of failed records (0..1) at or above which the stream is `RED`.
|
|
9362
|
+
*/
|
|
9363
|
+
failureRatioRed?: number;
|
|
9364
|
+
/**
|
|
9365
|
+
* The age threshold, in hours, for the stream's newest data. The stream is `AMBER` when the data's age reaches or exceeds this threshold.
|
|
9366
|
+
*/
|
|
9367
|
+
staleAmberHours?: number;
|
|
9368
|
+
/**
|
|
9369
|
+
* The age threshold, in hours, for the stream's newest data. The stream is `RED` when the data's age reaches or exceeds this threshold.
|
|
9370
|
+
*/
|
|
9371
|
+
staleRedHours?: number;
|
|
9372
|
+
/**
|
|
9373
|
+
* Whether a failed most-recent run makes the stream `RED` regardless of the other limits.
|
|
9374
|
+
*/
|
|
9375
|
+
failedRunIsRed?: boolean;
|
|
9376
|
+
};
|
|
9270
9377
|
type PostImporttoolTriggerRunData = {
|
|
9271
9378
|
body?: {
|
|
9272
9379
|
/**
|
|
9273
|
-
* The run mode.
|
|
9380
|
+
* The run mode. When omitted, defaults to `DELTA`.
|
|
9274
9381
|
*/
|
|
9275
9382
|
mode?: 'FULL' | 'DELTA';
|
|
9276
9383
|
/**
|