@artu-ai/compliance-sdk 0.8.2 → 0.9.1

package/dist/resources/reports.d.ts

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../../src/resources/reports.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,EACb,MAAM,iBAAiB,CAAC;AAYzB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EACL,MAAM,EACN,UAAU,EACV,KAAK,UAAU,EACf,KAAK,cAAc,EACpB,MAAM,WAAW,CAAC;AAOnB,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,eAAe,CAC1B,KAAK,GAAG,UAAU,EAClB,SAAS,GAAG,mBAAmB,CAC/B,SAAQ,YAAY,CACpB,MAAM,EACN,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EACZ,KAAK,CACN;IAKC;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;IAUtD;;OAEG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO3C;;OAEG;IACG,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOrE;;OAEG;IACG,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO/D;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;IASlE;;;;;;;;OAQG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,uBAAuB,GAC5B,OAAO,CAAC,MAAM,CAAC;IASlB;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC;;OAEG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,WAAW,CAAC,YAAY,EAAE,KAAK,CAAC,GACzC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAarC;;;;;OAKG;IACG,KAAK,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAOnD;;OAEG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE;QAChB,MAAM,CAAC,EAAE,YAAY,CAAC;QACtB,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC;IAY3C;;OAEG;IACG,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,UAAU,CAAC;IAUtB;;OAEG;IACG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAOpE;;OAEG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,UAAU,CAAC;IAatB;;OAEG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjE;;OAEG;IACG,SAAS,CACb,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,WAAW,CAAC,gBAAgB,EAAE,cAAc,CAAC,GACtD,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAczC;;;OAGG;IACG,QAAQ,CACZ,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,qBAAqB,EAAE,GAC7B,OAAO,CAAC,cAAc,CAAC;IAgB1B;;OAEG;IACG,WAAW,CACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAU/B;;;;;;;;OAQG;IACG,cAAc,CAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,SAAS,GAClB,OAAO,CAAC,gBAAgB,CAAC;IAO5B;;;;;;;;;;;;OAYG;IACG,cAAc,CAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,SAAS,GAClB,OAAO,CAAC,cAAc,CAAC;IAW1B;;;;;;;;OAQG;IACG,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASjE;;;;;;;;OAQG;IACG,kBAAkB,CACtB,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAahC;;;;;;OAMG;IACG,sBAAsB,CAC1B,OAAO,EAAE,iBAAiB,EAAE,EAC5B,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,sBAAsB,CAC1B,OAAO,EAAE,iBAAiB,EAAE,EAC5B,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IA6CpD;;;;;;OAMG;IACG,UAAU,CACd,OAAO,EAAE,iBAAiB,EAAE,EAC5B,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/B,UAAU,CACd,OAAO,EAAE,iBAAiB,EAAE,EAC5B,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IA6BtC;;;;;;OAMG;IACG,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,iBAAiB,CAAA;KAAE,EAAE,EAClD,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/B,UAAU,CACd,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,iBAAiB,CAAA;KAAE,EAAE,EAClD,OAAO,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GACzB,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAsCtC;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAI/C;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,UAAU;CAG5D"}