@bluecopa/core 0.1.94 → 0.1.96
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/dist/api/databox/dropFileToDatabox.d.ts +22 -0
- package/dist/api/databox/getDataboxFile.d.ts +12 -0
- package/dist/api/databox/getDataboxFileDownloadUrl.d.ts +13 -0
- package/dist/api/databox/getDataboxFileRuns.d.ts +12 -0
- package/dist/api/databox/getDataboxFileStatus.d.ts +13 -0
- package/dist/api/databox/getDataboxFolder.d.ts +12 -0
- package/dist/api/databox/getDataboxFolderDatasets.d.ts +14 -0
- package/dist/api/databox/getDataboxFolderDuplicates.d.ts +15 -0
- package/dist/api/databox/getDataboxFolderFiles.d.ts +12 -0
- package/dist/api/databox/getDataboxFolderSchema.d.ts +14 -0
- package/dist/api/databox/getDataboxSchemaHistory.d.ts +13 -0
- package/dist/api/databox/getDataboxTrashFiles.d.ts +12 -0
- package/dist/api/databox/index.d.ts +18 -0
- package/dist/api/databox/permanentDeleteDataboxFiles.d.ts +11 -0
- package/dist/api/databox/restoreDataboxFile.d.ts +12 -0
- package/dist/api/databox/runDataboxFolder.d.ts +16 -0
- package/dist/api/databox/trashDataboxFiles.d.ts +12 -0
- package/dist/api/databox/types.d.ts +74 -0
- package/dist/api/databox/updateDataboxFolderSchema.d.ts +16 -0
- package/dist/api/dataset/getDatasetDuplicates.d.ts +28 -0
- package/dist/api/dataset/getDatasetExceptions.d.ts +20 -0
- package/dist/api/dataset/getVirtualDatasets.d.ts +2 -0
- package/dist/api/dataset/index.d.ts +3 -0
- package/dist/api/definition/runPublishedDefinition.d.ts +5 -0
- package/dist/api/index.d.ts +1 -0
- package/dist/api/metric/getData.d.ts +5 -0
- package/dist/api/reconV2/createReconV2.d.ts +15 -2
- package/dist/api/reconV2/getReconV2Runs.d.ts +20 -0
- package/dist/api/reconV2/index.d.ts +1 -0
- package/dist/api/reconV2/updateReconV2.d.ts +13 -2
- package/dist/index.d.ts +23 -1
- package/dist/index.es.js +566 -82
- package/dist/index.es.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { DataboxFile } from './types';
|
|
2
|
+
export interface DropFileToDataboxRequest {
|
|
3
|
+
folderId: string;
|
|
4
|
+
file: File;
|
|
5
|
+
/** CSV delimiter override (CSV files only) */
|
|
6
|
+
delimiter?: string;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Drops (uploads) a file into a databox folder. The file is uploaded to blob
|
|
10
|
+
* storage and registered with processing scheduled. Poll
|
|
11
|
+
* getDataboxFileStatus with the returned file id for the run result.
|
|
12
|
+
*
|
|
13
|
+
* Supported types: csv, xlsx, xls, xlsb, json.
|
|
14
|
+
*
|
|
15
|
+
* @param params - The request parameters
|
|
16
|
+
* @param params.folderId - Required: The databox folder ID
|
|
17
|
+
* @param params.file - Required: The file to upload
|
|
18
|
+
* @param params.delimiter - Optional: CSV delimiter override
|
|
19
|
+
* @returns Promise<DataboxFile> The created databox file (with id and status)
|
|
20
|
+
* @throws Error if the request fails
|
|
21
|
+
*/
|
|
22
|
+
export declare function dropFileToDatabox({ folderId, file, delimiter, }: DropFileToDataboxRequest): Promise<DataboxFile>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DataboxFile } from './types';
|
|
2
|
+
export interface GetDataboxFileRequest {
|
|
3
|
+
fileId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Gets a databox file's details, including its processing status
|
|
7
|
+
* @param params - The request parameters
|
|
8
|
+
* @param params.fileId - Required: The databox file ID
|
|
9
|
+
* @returns Promise<DataboxFile> The file details
|
|
10
|
+
* @throws Error if the request fails
|
|
11
|
+
*/
|
|
12
|
+
export declare function getDataboxFile({ fileId, }: GetDataboxFileRequest): Promise<DataboxFile>;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { DataboxFileDownloadUrl } from './types';
|
|
2
|
+
export interface GetDataboxFileDownloadUrlRequest {
|
|
3
|
+
fileId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Gets a presigned download URL for a databox file's stored content. The
|
|
7
|
+
* caller downloads the content directly from the returned URL.
|
|
8
|
+
* @param params - The request parameters
|
|
9
|
+
* @param params.fileId - Required: The databox file ID
|
|
10
|
+
* @returns Promise<DataboxFileDownloadUrl> The presigned URL and file details
|
|
11
|
+
* @throws Error if the request fails
|
|
12
|
+
*/
|
|
13
|
+
export declare function getDataboxFileDownloadUrl({ fileId, }: GetDataboxFileDownloadUrlRequest): Promise<DataboxFileDownloadUrl>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DataboxFileProcessingResult } from './types';
|
|
2
|
+
export interface GetDataboxFileRunsRequest {
|
|
3
|
+
fileId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Gets the full processing (run) result history of a databox file
|
|
7
|
+
* @param params - The request parameters
|
|
8
|
+
* @param params.fileId - Required: The databox file ID
|
|
9
|
+
* @returns Promise<DataboxFileProcessingResult[]> The run results
|
|
10
|
+
* @throws Error if the request fails
|
|
11
|
+
*/
|
|
12
|
+
export declare function getDataboxFileRuns({ fileId, }: GetDataboxFileRunsRequest): Promise<DataboxFileProcessingResult[]>;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { DataboxFileProcessingResult } from './types';
|
|
2
|
+
export interface GetDataboxFileStatusRequest {
|
|
3
|
+
fileId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Gets the latest processing (run) result of a databox file — poll this after
|
|
7
|
+
* dropping a file or triggering a folder run to get the run status.
|
|
8
|
+
* @param params - The request parameters
|
|
9
|
+
* @param params.fileId - Required: The databox file ID
|
|
10
|
+
* @returns Promise<DataboxFileProcessingResult> The latest run result
|
|
11
|
+
* @throws Error if the request fails
|
|
12
|
+
*/
|
|
13
|
+
export declare function getDataboxFileStatus({ fileId, }: GetDataboxFileStatusRequest): Promise<DataboxFileProcessingResult>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DataboxFolder } from './types';
|
|
2
|
+
export interface GetDataboxFolderRequest {
|
|
3
|
+
folderId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Gets a databox folder's details
|
|
7
|
+
* @param params - The request parameters
|
|
8
|
+
* @param params.folderId - Required: The databox folder ID
|
|
9
|
+
* @returns Promise<DataboxFolder> The folder details
|
|
10
|
+
* @throws Error if the request fails
|
|
11
|
+
*/
|
|
12
|
+
export declare function getDataboxFolder({ folderId, }: GetDataboxFolderRequest): Promise<DataboxFolder>;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { DataboxDataset } from './types';
|
|
2
|
+
export interface GetDataboxFolderDatasetsRequest {
|
|
3
|
+
folderId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Lists the datasets produced by a databox folder's processing. Use the
|
|
7
|
+
* returned dataset id with getDatasetExceptions to fetch the dataset's
|
|
8
|
+
* exception rows.
|
|
9
|
+
* @param params - The request parameters
|
|
10
|
+
* @param params.folderId - Required: The databox folder ID
|
|
11
|
+
* @returns Promise<DataboxDataset[]> The folder's datasets
|
|
12
|
+
* @throws Error if the request fails
|
|
13
|
+
*/
|
|
14
|
+
export declare function getDataboxFolderDatasets({ folderId, }: GetDataboxFolderDatasetsRequest): Promise<DataboxDataset[]>;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { DataboxDatasetDuplicates } from './types';
|
|
2
|
+
export interface GetDataboxFolderDuplicatesRequest {
|
|
3
|
+
folderId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Gets the duplicate record combinations for every dataset produced by a
|
|
7
|
+
* databox folder — no dataset id required, datasets and their configured
|
|
8
|
+
* duplicate column groups are resolved automatically. One entry per
|
|
9
|
+
* dataset x group (entries that fail to load carry an `error` message).
|
|
10
|
+
* @param params - The request parameters
|
|
11
|
+
* @param params.folderId - Required: The databox folder ID
|
|
12
|
+
* @returns Promise<DataboxDatasetDuplicates[]> Duplicates per dataset and group
|
|
13
|
+
* @throws Error if the request fails
|
|
14
|
+
*/
|
|
15
|
+
export declare function getDataboxFolderDuplicates({ folderId, }: GetDataboxFolderDuplicatesRequest): Promise<DataboxDatasetDuplicates[]>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DataboxFile } from './types';
|
|
2
|
+
export interface GetDataboxFolderFilesRequest {
|
|
3
|
+
folderId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Lists the files of a databox folder, each with its processing status
|
|
7
|
+
* @param params - The request parameters
|
|
8
|
+
* @param params.folderId - Required: The databox folder ID
|
|
9
|
+
* @returns Promise<DataboxFile[]> The folder's files
|
|
10
|
+
* @throws Error if the request fails
|
|
11
|
+
*/
|
|
12
|
+
export declare function getDataboxFolderFiles({ folderId, }: GetDataboxFolderFilesRequest): Promise<DataboxFile[]>;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { DataboxFolderSchema } from './types';
|
|
2
|
+
export interface GetDataboxFolderSchemaRequest {
|
|
3
|
+
folderId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Gets the databox folder's schema available for update: the existing sync
|
|
7
|
+
* catalog plus, for non-auto-process folders, the schema inferred from the
|
|
8
|
+
* first file (the "Update Schema" action source data).
|
|
9
|
+
* @param params - The request parameters
|
|
10
|
+
* @param params.folderId - Required: The databox folder ID
|
|
11
|
+
* @returns Promise<DataboxFolderSchema> The folder schema
|
|
12
|
+
* @throws Error if the request fails
|
|
13
|
+
*/
|
|
14
|
+
export declare function getDataboxFolderSchema({ folderId, }: GetDataboxFolderSchemaRequest): Promise<DataboxFolderSchema>;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { DataboxSchemaUpdateResult } from './types';
|
|
2
|
+
export interface GetDataboxSchemaHistoryRequest {
|
|
3
|
+
folderId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Gets the schema update history of a databox folder (the "Schema update
|
|
7
|
+
* history" tab).
|
|
8
|
+
* @param params - The request parameters
|
|
9
|
+
* @param params.folderId - Required: The databox folder ID
|
|
10
|
+
* @returns Promise<DataboxSchemaUpdateResult[]> The schema update results
|
|
11
|
+
* @throws Error if the request fails
|
|
12
|
+
*/
|
|
13
|
+
export declare function getDataboxSchemaHistory({ folderId, }: GetDataboxSchemaHistoryRequest): Promise<DataboxSchemaUpdateResult[]>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DataboxFile } from './types';
|
|
2
|
+
export interface GetDataboxTrashFilesRequest {
|
|
3
|
+
folderId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Lists the trashed files of a databox folder (the "Trash" view)
|
|
7
|
+
* @param params - The request parameters
|
|
8
|
+
* @param params.folderId - Required: The databox folder ID
|
|
9
|
+
* @returns Promise<DataboxFile[]> The trashed files
|
|
10
|
+
* @throws Error if the request fails
|
|
11
|
+
*/
|
|
12
|
+
export declare function getDataboxTrashFiles({ folderId, }: GetDataboxTrashFilesRequest): Promise<DataboxFile[]>;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export * from './types';
|
|
2
|
+
export * from './getDataboxFolder';
|
|
3
|
+
export * from './getDataboxFolderFiles';
|
|
4
|
+
export * from './getDataboxFolderDatasets';
|
|
5
|
+
export * from './getDataboxFolderDuplicates';
|
|
6
|
+
export * from './dropFileToDatabox';
|
|
7
|
+
export * from './runDataboxFolder';
|
|
8
|
+
export * from './getDataboxFolderSchema';
|
|
9
|
+
export * from './updateDataboxFolderSchema';
|
|
10
|
+
export * from './getDataboxSchemaHistory';
|
|
11
|
+
export * from './getDataboxTrashFiles';
|
|
12
|
+
export * from './getDataboxFile';
|
|
13
|
+
export * from './getDataboxFileStatus';
|
|
14
|
+
export * from './getDataboxFileRuns';
|
|
15
|
+
export * from './getDataboxFileDownloadUrl';
|
|
16
|
+
export * from './trashDataboxFiles';
|
|
17
|
+
export * from './restoreDataboxFile';
|
|
18
|
+
export * from './permanentDeleteDataboxFiles';
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export interface PermanentDeleteDataboxFilesRequest {
|
|
2
|
+
fileIds: string[];
|
|
3
|
+
}
|
|
4
|
+
/**
|
|
5
|
+
* Permanently deletes databox files. This action is irreversible.
|
|
6
|
+
* @param params - The request parameters
|
|
7
|
+
* @param params.fileIds - Required: The databox file IDs to delete
|
|
8
|
+
* @returns Promise<any> Per-file deletion status
|
|
9
|
+
* @throws Error if the request fails
|
|
10
|
+
*/
|
|
11
|
+
export declare function permanentDeleteDataboxFiles({ fileIds, }: PermanentDeleteDataboxFilesRequest): Promise<any>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { DataboxFile } from './types';
|
|
2
|
+
export interface RestoreDataboxFileRequest {
|
|
3
|
+
fileId: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Restores a trashed databox file back to its folder
|
|
7
|
+
* @param params - The request parameters
|
|
8
|
+
* @param params.fileId - Required: The databox file ID
|
|
9
|
+
* @returns Promise<DataboxFile> The restored file
|
|
10
|
+
* @throws Error if the request fails
|
|
11
|
+
*/
|
|
12
|
+
export declare function restoreDataboxFile({ fileId, }: RestoreDataboxFileRequest): Promise<DataboxFile>;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export interface RunDataboxFolderRequest {
|
|
2
|
+
folderId: string;
|
|
3
|
+
/** Force reprocessing of already-processed files */
|
|
4
|
+
force?: boolean;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Triggers processing of a databox folder's contents (the "Run" action).
|
|
8
|
+
* Processing is asynchronous — poll getDataboxFileStatus / getDataboxFolderFiles
|
|
9
|
+
* for run results.
|
|
10
|
+
* @param params - The request parameters
|
|
11
|
+
* @param params.folderId - Required: The databox folder ID
|
|
12
|
+
* @param params.force - Optional: Force reprocessing
|
|
13
|
+
* @returns Promise<void>
|
|
14
|
+
* @throws Error if the request fails
|
|
15
|
+
*/
|
|
16
|
+
export declare function runDataboxFolder({ folderId, force, }: RunDataboxFolderRequest): Promise<void>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export interface TrashDataboxFilesRequest {
|
|
2
|
+
fileIds: string[];
|
|
3
|
+
}
|
|
4
|
+
/**
|
|
5
|
+
* Moves databox files to trash (scheduled delete). Trashed files can be
|
|
6
|
+
* restored via restoreDataboxFile.
|
|
7
|
+
* @param params - The request parameters
|
|
8
|
+
* @param params.fileIds - Required: The databox file IDs to trash
|
|
9
|
+
* @returns Promise<any> Per-file deletion status
|
|
10
|
+
* @throws Error if the request fails
|
|
11
|
+
*/
|
|
12
|
+
export declare function trashDataboxFiles({ fileIds, }: TrashDataboxFilesRequest): Promise<any>;
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared types for the databox (drive folder) API functions.
|
|
3
|
+
* Mirrors the BFF responses of /api/v1/databox/*.
|
|
4
|
+
*/
|
|
5
|
+
export type DataboxFileStatus = "PENDING" | "PROCESSING_SCHEDULED" | "PROCESSING" | "PROCESSING_FAILED" | "SCHEMA_VALIDATION_FAILED" | "DATA_VALIDATION_FAILED" | "DATA_VALIDATION_SUCCEEDED" | "DATA_SYNC_FAILED" | "SUCCEEDED" | "DELETE_SCHEDULED" | "DELETING_DATA" | "DELETED_DATA" | "DELETE_FAILED" | string;
|
|
6
|
+
export interface DataboxFile {
|
|
7
|
+
id?: string;
|
|
8
|
+
name?: string;
|
|
9
|
+
type?: "CSV" | "XLSX" | "JSON" | "XLS" | "XLSB" | string;
|
|
10
|
+
parentId?: string;
|
|
11
|
+
status?: DataboxFileStatus;
|
|
12
|
+
blobFileId?: string;
|
|
13
|
+
copaUploadDate?: string;
|
|
14
|
+
[key: string]: any;
|
|
15
|
+
}
|
|
16
|
+
export interface DataboxFolder {
|
|
17
|
+
id?: string;
|
|
18
|
+
name?: string;
|
|
19
|
+
status?: string;
|
|
20
|
+
autoProcessFiles?: boolean;
|
|
21
|
+
[key: string]: any;
|
|
22
|
+
}
|
|
23
|
+
export interface DataboxFileProcessingResult {
|
|
24
|
+
id?: string;
|
|
25
|
+
driveFileId?: string;
|
|
26
|
+
status?: string;
|
|
27
|
+
errorMessages?: string[];
|
|
28
|
+
[key: string]: any;
|
|
29
|
+
}
|
|
30
|
+
export interface DataboxSchemaUpdateResult {
|
|
31
|
+
id?: string;
|
|
32
|
+
folderId?: string;
|
|
33
|
+
status?: string;
|
|
34
|
+
[key: string]: any;
|
|
35
|
+
}
|
|
36
|
+
export interface DataboxFolderSchema {
|
|
37
|
+
existingSchema?: {
|
|
38
|
+
streams?: any[];
|
|
39
|
+
};
|
|
40
|
+
folderOriginalSchema?: Record<string, Record<string, string>>;
|
|
41
|
+
[key: string]: any;
|
|
42
|
+
}
|
|
43
|
+
export interface DataboxFileDownloadUrl {
|
|
44
|
+
url: string;
|
|
45
|
+
file: DataboxFile;
|
|
46
|
+
}
|
|
47
|
+
/** Duplicate combinations of one duplicate column group of one dataset produced by a databox folder. */
|
|
48
|
+
export interface DataboxDatasetDuplicates {
|
|
49
|
+
datasetId?: string;
|
|
50
|
+
datasetName?: string;
|
|
51
|
+
group?: string;
|
|
52
|
+
columns?: string[];
|
|
53
|
+
schema?: {
|
|
54
|
+
name: string;
|
|
55
|
+
data_type: string;
|
|
56
|
+
}[];
|
|
57
|
+
/** Duplicated value combinations with their row_count */
|
|
58
|
+
data?: any[];
|
|
59
|
+
/** Present when this group's duplicates failed to load. */
|
|
60
|
+
error?: string;
|
|
61
|
+
}
|
|
62
|
+
/** Dataset produced by a databox folder's processing (id: `<folderId>_<streamName>`). */
|
|
63
|
+
export interface DataboxDataset {
|
|
64
|
+
id?: string;
|
|
65
|
+
name?: string;
|
|
66
|
+
displayName?: string;
|
|
67
|
+
runStatus?: "RUNNING" | "SUCCESS" | "FAILED" | "SCHEDULED" | "SCHEDULE_FAILED" | string;
|
|
68
|
+
importType?: string;
|
|
69
|
+
lastSyncedTime?: string;
|
|
70
|
+
published?: boolean;
|
|
71
|
+
[key: string]: any;
|
|
72
|
+
}
|
|
73
|
+
/** File extensions accepted by databox uploads. */
|
|
74
|
+
export declare const DATABOX_SUPPORTED_EXTENSIONS: readonly ["csv", "xlsx", "xls", "xlsb", "json"];
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { DataboxFolder } from './types';
|
|
2
|
+
export interface UpdateDataboxFolderSchemaRequest {
|
|
3
|
+
folderId: string;
|
|
4
|
+
/** Configured airbyte streams for the folder's sync catalog */
|
|
5
|
+
streams: any[];
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Submits an updated sync catalog for the databox folder (the "Update Schema"
|
|
9
|
+
* action).
|
|
10
|
+
* @param params - The request parameters
|
|
11
|
+
* @param params.folderId - Required: The databox folder ID
|
|
12
|
+
* @param params.streams - Required: The configured streams
|
|
13
|
+
* @returns Promise<DataboxFolder> The updated folder
|
|
14
|
+
* @throws Error if the request fails
|
|
15
|
+
*/
|
|
16
|
+
export declare function updateDataboxFolderSchema({ folderId, streams, }: UpdateDataboxFolderSchemaRequest): Promise<DataboxFolder>;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export interface GetDatasetDuplicatesRequest {
|
|
2
|
+
datasetId: string;
|
|
3
|
+
/** Optional: scope to a single configured duplicate column group by name */
|
|
4
|
+
group?: string;
|
|
5
|
+
}
|
|
6
|
+
export interface DatasetDuplicates {
|
|
7
|
+
group?: string;
|
|
8
|
+
columns?: string[];
|
|
9
|
+
schema?: {
|
|
10
|
+
name: string;
|
|
11
|
+
data_type: string;
|
|
12
|
+
}[];
|
|
13
|
+
/** Duplicated value combinations with their row_count */
|
|
14
|
+
data?: any[];
|
|
15
|
+
/** Present when this group's duplicates failed to load. */
|
|
16
|
+
error?: string;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Gets the duplicate record combinations for each duplicate column group
|
|
20
|
+
* configured on the dataset (the catalog "Duplicates" tab). Returns [] when
|
|
21
|
+
* the dataset has no duplicate column groups configured.
|
|
22
|
+
* @param params - The request parameters
|
|
23
|
+
* @param params.datasetId - Required: The dataset ID
|
|
24
|
+
* @param params.group - Optional: a single group name to scope to
|
|
25
|
+
* @returns Promise<DatasetDuplicates[]> Duplicates per column group
|
|
26
|
+
* @throws Error if the request fails
|
|
27
|
+
*/
|
|
28
|
+
export declare function getDatasetDuplicates({ datasetId, group, }: GetDatasetDuplicatesRequest): Promise<DatasetDuplicates[]>;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export interface GetDatasetExceptionsRequest {
|
|
2
|
+
datasetId: string;
|
|
3
|
+
}
|
|
4
|
+
export interface DatasetExceptions {
|
|
5
|
+
schema?: {
|
|
6
|
+
name: string;
|
|
7
|
+
data_type: string;
|
|
8
|
+
}[];
|
|
9
|
+
data?: any[];
|
|
10
|
+
[key: string]: any;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Gets the dataset rows matching the dataset's exception rules (the catalog
|
|
14
|
+
* "Exceptions" tab). Returns the same bounded sample shown in the UI grid.
|
|
15
|
+
* @param params - The request parameters
|
|
16
|
+
* @param params.datasetId - Required: The dataset ID (databox datasets are keyed `<folderId>_<streamName>`)
|
|
17
|
+
* @returns Promise<DatasetExceptions> The exception rows and schema
|
|
18
|
+
* @throws Error if the request fails
|
|
19
|
+
*/
|
|
20
|
+
export declare function getDatasetExceptions({ datasetId, }: GetDatasetExceptionsRequest): Promise<DatasetExceptions>;
|
|
@@ -16,5 +16,10 @@ export declare const runPublishedDefinition: (props: {
|
|
|
16
16
|
* original `published/run` pass-through.
|
|
17
17
|
*/
|
|
18
18
|
solutionBindings?: Record<string, unknown>;
|
|
19
|
+
/**
|
|
20
|
+
* Optional row limit. When omitted, the BFF falls back to the server's
|
|
21
|
+
* ROW_LIMIT default.
|
|
22
|
+
*/
|
|
23
|
+
limit?: number;
|
|
19
24
|
source?: CancelTokenSource;
|
|
20
25
|
}) => Promise<import('axios').AxiosResponse<any, any, {}>>;
|
package/dist/api/index.d.ts
CHANGED
|
@@ -10,6 +10,11 @@ export declare const getData: (metricSheetId: string, options?: {
|
|
|
10
10
|
* round-trip. Omit/undefined → getData fetches on its own.
|
|
11
11
|
*/
|
|
12
12
|
solutionBindings?: Record<string, unknown>;
|
|
13
|
+
/**
|
|
14
|
+
* Optional row limit forwarded to the published-definition runs. When
|
|
15
|
+
* omitted, the BFF falls back to the server's ROW_LIMIT default.
|
|
16
|
+
*/
|
|
17
|
+
limit?: number;
|
|
13
18
|
}) => Promise<{
|
|
14
19
|
data?: undefined;
|
|
15
20
|
} | {
|
|
@@ -1,22 +1,35 @@
|
|
|
1
1
|
export interface ReconV2Workflow {
|
|
2
2
|
[key: string]: any;
|
|
3
3
|
}
|
|
4
|
+
export interface ReconV2DatasetRef {
|
|
5
|
+
id: string;
|
|
6
|
+
name: string;
|
|
7
|
+
dateColumn?: string | null;
|
|
8
|
+
}
|
|
4
9
|
export interface CreateReconV2Request {
|
|
5
10
|
/** Workflow name — non-alphanumeric characters are replaced with underscores */
|
|
6
11
|
name: string;
|
|
7
12
|
/** Recon type, defaults to SMART_RECONCILIATION */
|
|
8
13
|
type?: string;
|
|
14
|
+
/** Left (primary/source) dataset — provide together with rightDataset to make the workflow immediately runnable */
|
|
15
|
+
leftDataset?: ReconV2DatasetRef;
|
|
16
|
+
/** Right (secondary/target) dataset — provide together with leftDataset */
|
|
17
|
+
rightDataset?: ReconV2DatasetRef;
|
|
9
18
|
/** Optional initial workflow config (leftDef, rightDef, matchGroups, sources, ...) */
|
|
10
19
|
config?: Partial<ReconV2Workflow>;
|
|
11
20
|
}
|
|
12
21
|
/**
|
|
13
22
|
* Creates a recon v2 (SMART_RECONCILIATION) workflow along with its backing
|
|
14
|
-
* RECON workbook
|
|
23
|
+
* RECON workbook. When leftDataset + rightDataset are provided, the workbook
|
|
24
|
+
* sheets and workflow defs are wired to the datasets so the workflow can be
|
|
25
|
+
* run immediately (smart mode auto-detects match columns).
|
|
15
26
|
* @param params - The create parameters
|
|
16
27
|
* @param params.name - Required: Name for the new reconciliation
|
|
17
28
|
* @param params.type - Optional: Recon type (defaults to SMART_RECONCILIATION)
|
|
29
|
+
* @param params.leftDataset - Optional: Left dataset { id, name, dateColumn? }
|
|
30
|
+
* @param params.rightDataset - Optional: Right dataset { id, name, dateColumn? }
|
|
18
31
|
* @param params.config - Optional: Initial workflow config to merge in
|
|
19
32
|
* @returns Promise<ReconV2Workflow> The created workflow
|
|
20
33
|
* @throws Error if the request fails
|
|
21
34
|
*/
|
|
22
|
-
export declare function createReconV2({ name, type, config, }: CreateReconV2Request): Promise<ReconV2Workflow>;
|
|
35
|
+
export declare function createReconV2({ name, type, leftDataset, rightDataset, config, }: CreateReconV2Request): Promise<ReconV2Workflow>;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export interface GetReconV2RunsRequest {
|
|
2
|
+
workflowId: string;
|
|
3
|
+
}
|
|
4
|
+
export interface ReconV2Run {
|
|
5
|
+
id?: string;
|
|
6
|
+
workflowId?: string;
|
|
7
|
+
status?: string;
|
|
8
|
+
startedAt?: string;
|
|
9
|
+
finishedAt?: string;
|
|
10
|
+
errorMessages?: string[];
|
|
11
|
+
[key: string]: any;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Gets the run history of a recon v2 workflow
|
|
15
|
+
* @param params - The request parameters
|
|
16
|
+
* @param params.workflowId - Required: The workflow ID
|
|
17
|
+
* @returns Promise<ReconV2Run[]> The runs (newest first)
|
|
18
|
+
* @throws Error if the request fails
|
|
19
|
+
*/
|
|
20
|
+
export declare function getReconV2Runs({ workflowId, }: GetReconV2RunsRequest): Promise<ReconV2Run[]>;
|
|
@@ -3,6 +3,7 @@ export * from './updateReconV2';
|
|
|
3
3
|
export * from './deleteReconV2';
|
|
4
4
|
export * from './runReconV2';
|
|
5
5
|
export * from './getAllReconV2Workflows';
|
|
6
|
+
export * from './getReconV2Runs';
|
|
6
7
|
export * from './getReconV2RunResult';
|
|
7
8
|
export * from './getReconV2SmartResult';
|
|
8
9
|
export * from './profileReconV2';
|
|
@@ -1,15 +1,26 @@
|
|
|
1
|
-
import { ReconV2Workflow } from './createReconV2';
|
|
1
|
+
import { ReconV2DatasetRef, ReconV2Workflow } from './createReconV2';
|
|
2
2
|
export interface UpdateReconV2Request {
|
|
3
3
|
/** Full workflow object including its id */
|
|
4
4
|
reconWorkflow: ReconV2Workflow;
|
|
5
|
+
/** Optional: rewire the primary (left) sheet to this dataset */
|
|
6
|
+
leftDataset?: ReconV2DatasetRef;
|
|
7
|
+
/** Optional: rewire the secondary (right) sheet to this dataset */
|
|
8
|
+
rightDataset?: ReconV2DatasetRef;
|
|
5
9
|
}
|
|
6
10
|
/**
|
|
7
11
|
* Updates (saves) a recon v2 workflow config.
|
|
12
|
+
* When leftDataset/rightDataset are provided, the backing workbook's
|
|
13
|
+
* primary/secondary sheet is rewired to the dataset and the workflow's
|
|
14
|
+
* leftDef/rightDef ImportDefs are rebuilt server-side. The workflow's
|
|
15
|
+
* `sources` are always kept in sync server-side — callers don't need to
|
|
16
|
+
* (and shouldn't) compute them.
|
|
8
17
|
* Note: V2 settings stored on the workbook (customFields.reconV2 — currency,
|
|
9
18
|
* exceptionGroups, policies, prompts) are updated via workbook.saveWorkbook.
|
|
10
19
|
* @param params - The update parameters
|
|
11
20
|
* @param params.reconWorkflow - Required: The workflow object with id
|
|
21
|
+
* @param params.leftDataset - Optional: Left dataset { id, name, dateColumn? }
|
|
22
|
+
* @param params.rightDataset - Optional: Right dataset { id, name, dateColumn? }
|
|
12
23
|
* @returns Promise<ReconV2Workflow> The updated workflow
|
|
13
24
|
* @throws Error if the request fails
|
|
14
25
|
*/
|
|
15
|
-
export declare function updateReconV2({ reconWorkflow, }: UpdateReconV2Request): Promise<ReconV2Workflow>;
|
|
26
|
+
export declare function updateReconV2({ reconWorkflow, leftDataset, rightDataset, }: UpdateReconV2Request): Promise<ReconV2Workflow>;
|
package/dist/index.d.ts
CHANGED
|
@@ -10,10 +10,11 @@ export type { AuditRecord, CreateAuditLogRequest, } from './api/audit/createAudi
|
|
|
10
10
|
export type { TemplatedPipelineWorkflow, GetAllTemplatedPipelinesResponse, } from './api/templatedPipeline/getAllTemplatedPipelines';
|
|
11
11
|
export type { ReconWorkflow } from './api/recon/getAllReconWorkflows';
|
|
12
12
|
export type { RunReconRequest, RunReconResponse } from './api/recon/runRecon';
|
|
13
|
-
export type { ReconV2Workflow, CreateReconV2Request, } from './api/reconV2/createReconV2';
|
|
13
|
+
export type { ReconV2Workflow, ReconV2DatasetRef, CreateReconV2Request, } from './api/reconV2/createReconV2';
|
|
14
14
|
export type { UpdateReconV2Request } from './api/reconV2/updateReconV2';
|
|
15
15
|
export type { DeleteReconV2Request, DeleteReconV2Response, } from './api/reconV2/deleteReconV2';
|
|
16
16
|
export type { ReconV2MatchConfig, RunReconV2Request, RunReconV2Response, } from './api/reconV2/runReconV2';
|
|
17
|
+
export type { GetReconV2RunsRequest, ReconV2Run, } from './api/reconV2/getReconV2Runs';
|
|
17
18
|
export type { GetReconV2RunResultRequest, ReconV2RunResult, } from './api/reconV2/getReconV2RunResult';
|
|
18
19
|
export type { GetReconV2SmartResultRequest, ReconV2SmartResult, } from './api/reconV2/getReconV2SmartResult';
|
|
19
20
|
export type { ReconV2ProfileRequest, ReconV2ProfileResult, } from './api/reconV2/profileReconV2';
|
|
@@ -64,3 +65,24 @@ export type { TcnFtpManualDialReport } from './api/tcn/ftpManualDialReport';
|
|
|
64
65
|
export type { FilterOnSenderId, EmailMessage, PageChunkEmailMessage, } from './api/emailEngine/getMessageBySenderId';
|
|
65
66
|
export type { EmailMessageSearchRequest, } from './api/emailEngine/searchMessages';
|
|
66
67
|
export type { RenderTemplateRequest, RenderTemplateResponse, RenderTemplateWarning, TemplateEngine, } from './api/templates/render';
|
|
68
|
+
export type { DataboxFile, DataboxFileStatus, DataboxFolder, DataboxFileProcessingResult, DataboxSchemaUpdateResult, DataboxFolderSchema, DataboxFileDownloadUrl, DataboxDataset, DataboxDatasetDuplicates, } from './api/databox/types';
|
|
69
|
+
export type { GetDataboxFolderDatasetsRequest } from './api/databox/getDataboxFolderDatasets';
|
|
70
|
+
export type { GetDataboxFolderDuplicatesRequest } from './api/databox/getDataboxFolderDuplicates';
|
|
71
|
+
export type { GetDatasetExceptionsRequest, DatasetExceptions, } from './api/dataset/getDatasetExceptions';
|
|
72
|
+
export type { GetDatasetDuplicatesRequest, DatasetDuplicates, } from './api/dataset/getDatasetDuplicates';
|
|
73
|
+
export { DATABOX_SUPPORTED_EXTENSIONS } from './api/databox/types';
|
|
74
|
+
export type { GetDataboxFolderRequest } from './api/databox/getDataboxFolder';
|
|
75
|
+
export type { GetDataboxFolderFilesRequest } from './api/databox/getDataboxFolderFiles';
|
|
76
|
+
export type { DropFileToDataboxRequest } from './api/databox/dropFileToDatabox';
|
|
77
|
+
export type { RunDataboxFolderRequest } from './api/databox/runDataboxFolder';
|
|
78
|
+
export type { GetDataboxFolderSchemaRequest } from './api/databox/getDataboxFolderSchema';
|
|
79
|
+
export type { UpdateDataboxFolderSchemaRequest } from './api/databox/updateDataboxFolderSchema';
|
|
80
|
+
export type { GetDataboxSchemaHistoryRequest } from './api/databox/getDataboxSchemaHistory';
|
|
81
|
+
export type { GetDataboxTrashFilesRequest } from './api/databox/getDataboxTrashFiles';
|
|
82
|
+
export type { GetDataboxFileRequest } from './api/databox/getDataboxFile';
|
|
83
|
+
export type { GetDataboxFileStatusRequest } from './api/databox/getDataboxFileStatus';
|
|
84
|
+
export type { GetDataboxFileRunsRequest } from './api/databox/getDataboxFileRuns';
|
|
85
|
+
export type { GetDataboxFileDownloadUrlRequest } from './api/databox/getDataboxFileDownloadUrl';
|
|
86
|
+
export type { TrashDataboxFilesRequest } from './api/databox/trashDataboxFiles';
|
|
87
|
+
export type { RestoreDataboxFileRequest } from './api/databox/restoreDataboxFile';
|
|
88
|
+
export type { PermanentDeleteDataboxFilesRequest } from './api/databox/permanentDeleteDataboxFiles';
|