@artu-ai/compliance-sdk 0.8.1 → 0.9.0

package/dist/resources/alerts.d.ts

@@ -0,0 +1,245 @@
+/**
+ * Alerts Resource
+ *
+ * CRUD operations, alert items management, validation, and generation.
+ *
+ * This is the base (unscoped) resource. For jurisdiction-scoped SDKs, use:
+ * - MexAlertsResource - Mexico-scoped with flattened MX fields
+ * - AVIAlertsResource - Mexico AVI-scoped with flattened AVI fields
+ * - JYSAlertsResource - Mexico JYS-scoped with flattened JYS fields
+ * - TSCAlertsResource - Mexico TSC-scoped with flattened TSC fields
+ */
+import type { CreateAlertInput, UpdateAlertInput, UpsertAlertInput, UpdateReportStatusInput, CreateAlertItemInput, UpdateAlertItemInput, AlertFilter, AlertSort, AlertItemFilter, AlertItemSort, ValidationResult, GenerateResult, SubmitAlertInput, SubmissionResult, ListOptions, PaginatedResponse, AtomicBatchResult, PartialBatchResult, AlertDefaultsInput, UpsertResult } from "@artu-ai/shared";
+import { BaseResource } from "./base";
+import { Alert, AlertItem, type AlertData, type AlertItemData } from "../models";
+export type { AlertFilter, AlertItemFilter, AlertItemSort };
+/**
+ * Add items result
+ */
+export interface AddItemsResult {
+    added: number;
+    items: AlertItem[];
+}
+/**
+ * Base resource manager for alert operations.
+ *
+ * Provides:
+ * - CRUD operations (create, retrieve, update, delete)
+ * - Alert items management (add, update, remove items)
+ * - Validation and generation
+ *
+ * @example
+ * ```typescript
+ * // Create a alert with full nested format
+ * const alert = await sdk.alerts.create({
+ *   jurisdictions: {
+ *     MX: {
+ *       actividadVulnerable: {
+ *         AVI: { mesReportado: "202401" }
+ *       }
+ *     }
+ *   }
+ * });
+ *
+ * // Add items to the alert
+ * await sdk.alerts.addItem(alert.id, {
+ *   transactionId: "txn_123",
+ * });
+ *
+ * // Validate the alert
+ * const result = await sdk.alerts.validate(alert.id);
+ * if (result.valid) {
+ *   // Generate XML
+ *   const xml = await sdk.alerts.generate(alert.id);
+ * }
+ * ```
+ */
+export declare class AlertsResource<TSort = AlertSort, TDefaults = AlertDefaultsInput> extends BaseResource<Alert, CreateAlertInput, UpdateAlertInput, AlertFilter, TSort> {
+    /**
+     * Creates a new alert.
+     *
+     * @param data - Alert creation data in nested format
+     * @returns The created alert model
+     */
+    create(data: CreateAlertInput): Promise<Alert>;
+    /**
+     * Retrieves a alert by ID.
+     */
+    retrieve(id: string): Promise<Alert>;
+    /**
+     * Retrieves a alert by metadata key/value.
+     */
+    retrieveByMetadata(key: string, value: string): Promise<Alert>;
+    /**
+     * Retrieves a alert by externalId.
+     */
+    retrieveByExternalId(externalId: string): Promise<Alert>;
+    /**
+     * Updates a alert.
+     */
+    update(id: string, data: UpdateAlertInput): Promise<Alert>;
+    /**
+     * Updates a alert's status.
+     *
+     * Restrictions:
+     * - Can only manually set to: Draft
+     * - Cannot change from: Accepted (terminal), Submitted (awaiting response)
+     *
+     * Use this to reset a alert back to Draft status for re-editing.
+     */
+    updateStatus(id: string, data: UpdateReportStatusInput): Promise<Alert>;
+    /**
+     * Deletes a alert.
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Lists alerts with optional filtering and pagination.
+     */
+    list(options?: ListOptions<AlertFilter, TSort>): Promise<PaginatedResponse<Alert>>;
+    /**
+     * Counts alerts matching the given filter.
+     *
+     * @param filter - Optional filter criteria
+     * @returns The count of matching alerts
+     */
+    count(filter?: AlertFilter): Promise<number>;
+    /**
+     * Returns an async iterator over all alerts matching the filter.
+     */
+    iterate(options?: {
+        filter?: AlertFilter;
+        sort?: TSort;
+        pageSize?: number;
+    }): AsyncGenerator<Alert, void, undefined>;
+    /**
+     * Adds an item to a alert.
+     */
+    addItem(alertId: string, data: CreateAlertItemInput): Promise<AlertItem>;
+    /**
+     * Gets a specific alert item.
+     */
+    getItem(alertId: string, itemId: string): Promise<AlertItem>;
+    /**
+     * Updates a alert item.
+     */
+    updateItem(alertId: string, itemId: string, data: UpdateAlertItemInput): Promise<AlertItem>;
+    /**
+     * Removes an item from a alert.
+     */
+    removeItem(alertId: string, itemId: string): Promise<void>;
+    /**
+     * Lists items in a alert with filtering, sorting, and pagination.
+     */
+    listItems(alertId: string, options?: ListOptions<AlertItemFilter, AlertItemSort>): Promise<PaginatedResponse<AlertItem>>;
+    /**
+     * Adds multiple items to a alert.
+     * Validates all items upfront - fails fast if any item is invalid.
+     */
+    addItems(alertId: string, items: CreateAlertItemInput[]): Promise<AddItemsResult>;
+    /**
+     * Removes multiple items from a alert.
+     */
+    removeItems(alertId: string, itemIds: string[]): Promise<{
+        removed: number;
+    }>;
+    /**
+     * Validates a alert and its items.
+     *
+     * Requires jurisdiction-specific defaults.
+     * For scoped SDKs, use the scoped resource which provides a simpler API.
+     *
+     * @param alertId - The alert ID to validate
+     * @param defaults - Jurisdiction-specific defaults for validation
+     */
+    validateAlert(alertId: string, defaults: TDefaults): Promise<ValidationResult>;
+    /**
+     * Validates and generates the alert output (e.g., XML for Mexico alerts).
+     *
+     * Performs validation first:
+     * - If validation fails, returns `{ status: "validation_failed", validation: {...} }`
+     * - If validation passes, returns `{ status: "success", xml: "...", ... }`
+     *
+     * Use `validateAlert` for dry-run/preview validation without generating XML.
+     *
+     * @param alertId - The alert ID to generate
+     * @param defaults - Jurisdiction-specific defaults for generation
+     * @returns GenerateResult with status "success" or "validation_failed"
+     */
+    generateAlert(alertId: string, defaults: TDefaults): Promise<GenerateResult>;
+    /**
+     * Submits a validated alert.
+     *
+     * The alert must be in "valid" status. After submission, the alert
+     * is locked and cannot be edited.
+     *
+     * @param alertId - The alert ID
+     * @param input - Submission data with jurisdiction-specific structure
+     */
+    submit(input: SubmitAlertInput): Promise<SubmissionResult>;
+    /**
+     * Creates or updates a alert by externalId.
+     *
+     * If a alert with the given externalId exists, it will be updated.
+     * Otherwise, a new alert will be created.
+     *
+     * @param data - Alert upsert data (must include externalId)
+     * @returns The created or updated alert with action indicator
+     */
+    upsertByExternalId(data: UpsertAlertInput): Promise<UpsertResult<Alert>>;
+    /**
+     * Creates or updates multiple alerts by externalId in a single request.
+     *
+     * @param alerts - Array of alert upsert data (each must include externalId)
+     * @param options - Batch options (atomic: true by default)
+     * @returns Atomic result with data array, or partial result with succeeded/failed
+     */
+    upsertManyByExternalId(alerts: UpsertAlertInput[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<UpsertResult<Alert>>>;
+    upsertManyByExternalId(alerts: UpsertAlertInput[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<UpsertResult<Alert>>>;
+    /**
+     * Creates multiple alerts in a single request.
+     *
+     * @param alerts - Array of alert creation data
+     * @param options - Batch options (atomic: true by default)
+     * @returns Atomic result with data array, or partial result with succeeded/failed
+     */
+    createMany(alerts: CreateAlertInput[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<Alert>>;
+    createMany(alerts: CreateAlertInput[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<Alert>>;
+    /**
+     * Updates multiple alerts in a single request.
+     *
+     * @param updates - Array of { id, data } updates
+     * @param options - Batch options (atomic: true by default)
+     * @returns Atomic result with data array, or partial result with succeeded/failed
+     */
+    updateMany(updates: {
+        id: string;
+        data: UpdateAlertInput;
+    }[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<Alert>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateAlertInput;
+    }[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<Alert>>;
+    /**
+     * Instantiates a Alert model from API response data.
+     * Subclasses override this to return their specific model type.
+     */
+    protected instantiate(data: AlertData): Alert;
+    /**
+     * Instantiates a AlertItem model from API response data.
+     * Subclasses override this to return their specific model type.
+     */
+    protected instantiateItem(data: AlertItemData): AlertItem;
+}
+//# sourceMappingURL=alerts.d.ts.map

package/dist/resources/alerts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../../src/resources/alerts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,oBAAoB,EACpB,oBAAoB,EACpB,WAAW,EACX,SAAS,EACT,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,YAAY,EACb,MAAM,iBAAiB,CAAC;AAYzB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EACL,KAAK,EACL,SAAS,EACT,KAAK,SAAS,EACd,KAAK,aAAa,EACnB,MAAM,WAAW,CAAC;AAOnB,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,cAAc,CACzB,KAAK,GAAG,SAAS,EACjB,SAAS,GAAG,kBAAkB,CAC9B,SAAQ,YAAY,CACpB,KAAK,EACL,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,KAAK,CACN;IAKC;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC;IAUpD;;OAEG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAO1C;;OAEG;IACG,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAOpE;;OAEG;IACG,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAO9D;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC;IAShE;;;;;;;;OAQG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,uBAAuB,GAC5B,OAAO,CAAC,KAAK,CAAC;IASjB;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC;;OAEG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,GACxC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAapC;;;;;OAKG;IACG,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAOlD;;OAEG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE;QAChB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC;IAY1C;;OAEG;IACG,OAAO,CACX,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,SAAS,CAAC;IAUrB;;OAEG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAOlE;;OAEG;IACG,UAAU,CACd,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,SAAS,CAAC;IAarB;;OAEG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMhE;;OAEG;IACG,SAAS,CACb,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,WAAW,CAAC,eAAe,EAAE,aAAa,CAAC,GACpD,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAcxC;;;OAGG;IACG,QAAQ,CACZ,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,oBAAoB,EAAE,GAC5B,OAAO,CAAC,cAAc,CAAC;IAgB1B;;OAEG;IACG,WAAW,CACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAU/B;;;;;;;;OAQG;IACG,aAAa,CACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,SAAS,GAClB,OAAO,CAAC,gBAAgB,CAAC;IAO5B;;;;;;;;;;;;OAYG;IACG,aAAa,CACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,SAAS,GAClB,OAAO,CAAC,cAAc,CAAC;IAW1B;;;;;;;;OAQG;IACG,MAAM,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAShE;;;;;;;;OAQG;IACG,kBAAkB,CACtB,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAa/B;;;;;;OAMG;IACG,sBAAsB,CAC1B,MAAM,EAAE,gBAAgB,EAAE,EAC1B,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5C,sBAAsB,CAC1B,MAAM,EAAE,gBAAgB,EAAE,EAC1B,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IA6CnD;;;;;;OAMG;IACG,UAAU,CACd,MAAM,EAAE,gBAAgB,EAAE,EAC1B,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC9B,UAAU,CACd,MAAM,EAAE,gBAAgB,EAAE,EAC1B,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IA6BrC;;;;;;OAMG;IACG,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,gBAAgB,CAAA;KAAE,EAAE,EACjD,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC9B,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,gBAAgB,CAAA;KAAE,EAAE,EACjD,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAsCrC;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,KAAK;IAI7C;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,aAAa,GAAG,SAAS;CAG1D"}