@bluecopa/core 0.1.93 → 0.1.94

package/dist/api/index.d.ts

@@ -12,6 +12,7 @@ export * as worksheet from './worksheet';
 export * as statement from './statement';
 export * as task from './task';
 export * as recon from './recon';
+export * as reconV2 from './reconV2';
 export * as form from './form';
 export * as audit from './audit';
 export * as templatedPipeline from './templatedPipeline';

package/dist/api/reconV2/cleanReconV2.d.ts

@@ -0,0 +1,35 @@
+export interface StartReconV2CleanRequest {
+    workflowId: string;
+    /** Dataset side to clean, defaults to left */
+    side?: "left" | "right";
+    /** Optional custom transforms — auto-discovered when omitted */
+    transforms?: any[];
+}
+export interface GetReconV2CleanResultRequest {
+    workflowId: string;
+    side?: "left" | "right";
+}
+export interface ReconV2CleanResult {
+    [key: string]: any;
+}
+/**
+ * Starts dataset cleaning for one side of a recon v2 workflow
+ * @param params - The clean parameters
+ * @param params.workflowId - Required: The workflow ID
+ * @param params.side - Optional: 'left' (default) or 'right'
+ * @param params.transforms - Optional: Custom transforms to apply
+ * @returns Promise<ReconV2CleanResult> The start response
+ * @throws Error if the request fails
+ */
+export declare function startReconV2Clean({ workflowId, side, transforms, }: StartReconV2CleanRequest): Promise<ReconV2CleanResult>;
+/**
+ * Fetches the clean result for one side of a recon v2 workflow.
+ * Returns a "not found" message payload (HTTP 200) while the clean is still
+ * running — poll until the result is present.
+ * @param params - The request parameters
+ * @param params.workflowId - Required: The workflow ID
+ * @param params.side - Optional: 'left' (default) or 'right'
+ * @returns Promise<ReconV2CleanResult> The clean result
+ * @throws Error if the request fails
+ */
+export declare function getReconV2CleanResult({ workflowId, side, }: GetReconV2CleanResultRequest): Promise<ReconV2CleanResult>;

package/dist/api/reconV2/createReconV2.d.ts

@@ -0,0 +1,22 @@
+export interface ReconV2Workflow {
+    [key: string]: any;
+}
+export interface CreateReconV2Request {
+    /** Workflow name — non-alphanumeric characters are replaced with underscores */
+    name: string;
+    /** Recon type, defaults to SMART_RECONCILIATION */
+    type?: string;
+    /** Optional initial workflow config (leftDef, rightDef, matchGroups, sources, ...) */
+    config?: Partial<ReconV2Workflow>;
+}
+/**
+ * Creates a recon v2 (SMART_RECONCILIATION) workflow along with its backing
+ * RECON workbook
+ * @param params - The create parameters
+ * @param params.name - Required: Name for the new reconciliation
+ * @param params.type - Optional: Recon type (defaults to SMART_RECONCILIATION)
+ * @param params.config - Optional: Initial workflow config to merge in
+ * @returns Promise<ReconV2Workflow> The created workflow
+ * @throws Error if the request fails
+ */
+export declare function createReconV2({ name, type, config, }: CreateReconV2Request): Promise<ReconV2Workflow>;

package/dist/api/reconV2/deleteReconV2.d.ts

@@ -0,0 +1,14 @@
+export interface DeleteReconV2Request {
+    workflowId: string;
+}
+export interface DeleteReconV2Response {
+    success: boolean;
+}
+/**
+ * Deletes a recon v2 workflow
+ * @param params - The delete parameters
+ * @param params.workflowId - Required: The ID of the workflow to delete
+ * @returns Promise<DeleteReconV2Response> The delete response
+ * @throws Error if the request fails
+ */
+export declare function deleteReconV2({ workflowId, }: DeleteReconV2Request): Promise<DeleteReconV2Response>;

package/dist/api/reconV2/getAllReconV2Workflows.d.ts

@@ -0,0 +1,7 @@
+import { ReconV2Workflow } from './createReconV2';
+/**
+ * Gets all recon v2 (SMART_RECONCILIATION) workflows
+ * @returns Promise<ReconV2Workflow[]> The list of recon v2 workflows
+ * @throws Error if the request fails
+ */
+export declare function getAllReconV2Workflows(): Promise<ReconV2Workflow[]>;

package/dist/api/reconV2/getReconV2Diff.d.ts

@@ -0,0 +1,18 @@
+export interface GetReconV2DiffRequest {
+    runId: string;
+    workflowId: string;
+    prevRunId: string;
+}
+export interface ReconV2Diff {
+    [key: string]: any;
+}
+/**
+ * Gets the diff between a recon v2 run and a previous run
+ * @param params - The diff parameters
+ * @param params.runId - Required: The current run ID
+ * @param params.workflowId - Required: The workflow ID
+ * @param params.prevRunId - Required: The previous run ID to compare against
+ * @returns Promise<ReconV2Diff> The run diff
+ * @throws Error if the request fails
+ */
+export declare function getReconV2Diff({ runId, workflowId, prevRunId, }: GetReconV2DiffRequest): Promise<ReconV2Diff>;

package/dist/api/reconV2/getReconV2Explanation.d.ts

@@ -0,0 +1,17 @@
+export interface GetReconV2ExplanationRequest {
+    runId: string;
+    workflowId: string;
+}
+export interface ReconV2Explanation {
+    [key: string]: any;
+}
+/**
+ * Gets the oracle explanation/analysis for a recon v2 run.
+ * Returns a message payload (HTTP 200) when no analysis is available yet.
+ * @param params - The request parameters
+ * @param params.runId - Required: The run ID
+ * @param params.workflowId - Required: The workflow ID
+ * @returns Promise<ReconV2Explanation> The oracle analysis
+ * @throws Error if the request fails
+ */
+export declare function getReconV2Explanation({ runId, workflowId, }: GetReconV2ExplanationRequest): Promise<ReconV2Explanation>;

package/dist/api/reconV2/getReconV2RunResult.d.ts

@@ -0,0 +1,15 @@
+export interface GetReconV2RunResultRequest {
+    runId: string;
+}
+export interface ReconV2RunResult {
+    [key: string]: any;
+}
+/**
+ * Gets the metadata/status of a recon v2 run (pollable until the run reaches
+ * a terminal status)
+ * @param params - The request parameters
+ * @param params.runId - Required: The run ID returned by runReconV2
+ * @returns Promise<ReconV2RunResult> The run metadata/status
+ * @throws Error if the request fails
+ */
+export declare function getReconV2RunResult({ runId, }: GetReconV2RunResultRequest): Promise<ReconV2RunResult>;

package/dist/api/reconV2/getReconV2SmartResult.d.ts

@@ -0,0 +1,24 @@
+export interface GetReconV2SmartResultRequest {
+    runId: string;
+    workflowId: string;
+    /** Exception type filter, defaults to ALL */
+    exceptionType?: string;
+    ruleFilter?: string;
+    orderBy?: string;
+}
+export interface ReconV2SmartResult {
+    [key: string]: any;
+}
+/**
+ * Gets the detailed smart result data for a recon v2 run
+ * (matched/unmatched/exception records)
+ * @param params - The request parameters
+ * @param params.runId - Required: The run ID
+ * @param params.workflowId - Required: The workflow ID
+ * @param params.exceptionType - Optional: Exception type filter (default ALL)
+ * @param params.ruleFilter - Optional: Rule filter
+ * @param params.orderBy - Optional: Ordering expression
+ * @returns Promise<ReconV2SmartResult> The detailed result data
+ * @throws Error if the request fails
+ */
+export declare function getReconV2SmartResult({ runId, workflowId, exceptionType, ruleFilter, orderBy, }: GetReconV2SmartResultRequest): Promise<ReconV2SmartResult>;

package/dist/api/reconV2/index.d.ts

@@ -0,0 +1,11 @@
+export * from './createReconV2';
+export * from './updateReconV2';
+export * from './deleteReconV2';
+export * from './runReconV2';
+export * from './getAllReconV2Workflows';
+export * from './getReconV2RunResult';
+export * from './getReconV2SmartResult';
+export * from './profileReconV2';
+export * from './cleanReconV2';
+export * from './getReconV2Diff';
+export * from './getReconV2Explanation';

package/dist/api/reconV2/profileReconV2.d.ts

@@ -0,0 +1,29 @@
+export interface ReconV2ProfileRequest {
+    workflowId: string;
+    /** Dataset side to profile, defaults to left */
+    side?: "left" | "right";
+}
+export interface ReconV2ProfileResult {
+    [key: string]: any;
+}
+/**
+ * Starts data profiling for one side of a recon v2 workflow.
+ * Uses the shared /recon/profile endpoint (smart profile).
+ * @param params - The profile parameters
+ * @param params.workflowId - Required: The workflow ID
+ * @param params.side - Optional: 'left' (default) or 'right'
+ * @returns Promise<ReconV2ProfileResult> The start response
+ * @throws Error if the request fails
+ */
+export declare function startReconV2Profile({ workflowId, side, }: ReconV2ProfileRequest): Promise<ReconV2ProfileResult>;
+/**
+ * Fetches the data profile result for one side of a recon v2 workflow.
+ * Returns a "not found" message payload (HTTP 200) while the profile is
+ * still being computed — poll until columns are present.
+ * @param params - The profile parameters
+ * @param params.workflowId - Required: The workflow ID
+ * @param params.side - Optional: 'left' (default) or 'right'
+ * @returns Promise<ReconV2ProfileResult> The profile result
+ * @throws Error if the request fails
+ */
+export declare function getReconV2ProfileResult({ workflowId, side, }: ReconV2ProfileRequest): Promise<ReconV2ProfileResult>;

package/dist/api/reconV2/runReconV2.d.ts

@@ -0,0 +1,34 @@
+export interface ReconV2MatchConfig {
+    match?: any[];
+    unmatch?: any[];
+    archive?: any[];
+    unarchive?: any[];
+}
+export interface RunReconV2Request {
+    workflowId: string;
+    /** Optional custom run ID — generated server-side when omitted */
+    runId?: string;
+    fullRefresh?: boolean;
+    /** RUN (default) or TEST */
+    mode?: "RUN" | "TEST";
+    /** Optional manual match config (match/unmatch/archive actions) */
+    matchConfig?: ReconV2MatchConfig;
+}
+export interface RunReconV2Response {
+    /** The run ID — use it to poll results or subscribe to run status */
+    runId: string;
+    [key: string]: any;
+}
+/**
+ * Runs a recon v2 workflow (RUN or TEST mode, optionally with a manual
+ * match config)
+ * @param params - The run parameters
+ * @param params.workflowId - Required: The ID of the workflow to run
+ * @param params.runId - Optional: Custom run ID
+ * @param params.fullRefresh - Optional: Whether to do a full refresh
+ * @param params.mode - Optional: 'RUN' (default) or 'TEST'
+ * @param params.matchConfig - Optional: Manual match/unmatch/archive actions
+ * @returns Promise<RunReconV2Response> The run response including the runId
+ * @throws Error if the request fails
+ */
+export declare function runReconV2({ workflowId, runId, fullRefresh, mode, matchConfig, }: RunReconV2Request): Promise<RunReconV2Response>;

package/dist/api/reconV2/updateReconV2.d.ts

@@ -0,0 +1,15 @@
+import { ReconV2Workflow } from './createReconV2';
+export interface UpdateReconV2Request {
+    /** Full workflow object including its id */
+    reconWorkflow: ReconV2Workflow;
+}
+/**
+ * Updates (saves) a recon v2 workflow config.
+ * Note: V2 settings stored on the workbook (customFields.reconV2 — currency,
+ * exceptionGroups, policies, prompts) are updated via workbook.saveWorkbook.
+ * @param params - The update parameters
+ * @param params.reconWorkflow - Required: The workflow object with id
+ * @returns Promise<ReconV2Workflow> The updated workflow
+ * @throws Error if the request fails
+ */
+export declare function updateReconV2({ reconWorkflow, }: UpdateReconV2Request): Promise<ReconV2Workflow>;

package/dist/index.d.ts

@@ -10,6 +10,16 @@ export type { AuditRecord, CreateAuditLogRequest, } from './api/audit/createAudi
 export type { TemplatedPipelineWorkflow, GetAllTemplatedPipelinesResponse, } from './api/templatedPipeline/getAllTemplatedPipelines';
 export type { ReconWorkflow } from './api/recon/getAllReconWorkflows';
 export type { RunReconRequest, RunReconResponse } from './api/recon/runRecon';
+export type { ReconV2Workflow, CreateReconV2Request, } from './api/reconV2/createReconV2';
+export type { UpdateReconV2Request } from './api/reconV2/updateReconV2';
+export type { DeleteReconV2Request, DeleteReconV2Response, } from './api/reconV2/deleteReconV2';
+export type { ReconV2MatchConfig, RunReconV2Request, RunReconV2Response, } from './api/reconV2/runReconV2';
+export type { GetReconV2RunResultRequest, ReconV2RunResult, } from './api/reconV2/getReconV2RunResult';
+export type { GetReconV2SmartResultRequest, ReconV2SmartResult, } from './api/reconV2/getReconV2SmartResult';
+export type { ReconV2ProfileRequest, ReconV2ProfileResult, } from './api/reconV2/profileReconV2';
+export type { StartReconV2CleanRequest, GetReconV2CleanResultRequest, ReconV2CleanResult, } from './api/reconV2/cleanReconV2';
+export type { GetReconV2DiffRequest, ReconV2Diff, } from './api/reconV2/getReconV2Diff';
+export type { GetReconV2ExplanationRequest, ReconV2Explanation, } from './api/reconV2/getReconV2Explanation';
 export type { GetFormByIdRequest, Form } from './api/form/getFormById';
 export type { CreateOrUpdateFormRequest } from './api/form/createOrUpdateForm';
 export type { GetFormSchemaRequest } from './api/form/getFormSchema';