@artu-ai/compliance-sdk 0.0.5 → 0.2.0

package/dist/models/Document.js

@@ -0,0 +1,295 @@
+/**
+ * Document model
+ *
+ * Represents a file uploaded for a client.
+ * Supports jurisdiction-specific document types (MX, US).
+ */
+import { BaseModel } from "./base";
+import { DocumentStatus, DocumentCategory, Jurisdiction, } from "@artu-ai/shared";
+// ─────────────────────────────────────────────────────────────────
+// Document Model
+// ─────────────────────────────────────────────────────────────────
+/**
+ * Document model - represents an uploaded file.
+ *
+ * @example
+ * ```typescript
+ * const doc = await sdk.documents.retrieve("doc_123");
+ *
+ * console.log(doc.filename);        // "passport.pdf"
+ * console.log(doc.formattedSize);   // "2.5 MB"
+ * console.log(doc.isAvailable);     // true
+ *
+ * if (doc.isMexico) {
+ *   console.log(doc.type); // "ine_front" | "rfc" | etc.
+ * }
+ * ```
+ */
+export class Document extends BaseModel {
+    // ─────────────────────────────────────────────────────────────────
+    // Core Properties
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Unique identifier for the document
+     */
+    get id() {
+        return this._data.id;
+    }
+    /**
+     * ID of the client this document belongs to
+     */
+    get clientId() {
+        return this._data.clientId;
+    }
+    /**
+     * Jurisdiction for this document (MX, US)
+     */
+    get jurisdiction() {
+        return this._data.jurisdiction;
+    }
+    /**
+     * Document type (jurisdiction-specific)
+     */
+    get type() {
+        return this._data.type;
+    }
+    /**
+     * Document category (identity, address, financial, etc.)
+     */
+    get category() {
+        return this._data.category;
+    }
+    /**
+     * Document status
+     */
+    get status() {
+        return this._data.status;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // File Properties
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Whether a file is attached to this document
+     */
+    get hasFile() {
+        return !!this._data.filename;
+    }
+    /**
+     * Original filename (undefined if no file attached)
+     */
+    get filename() {
+        return this._data.filename ?? undefined;
+    }
+    /**
+     * MIME content type (undefined if no file attached)
+     */
+    get contentType() {
+        return this._data.contentType ?? undefined;
+    }
+    /**
+     * File size in bytes (undefined if no file attached)
+     */
+    get size() {
+        return this._data.size ?? undefined;
+    }
+    /**
+     * Human-readable file size (e.g., "2.5 MB")
+     * Returns undefined if no file attached
+     */
+    get formattedSize() {
+        if (this._data.size === undefined || this._data.size === null)
+            return undefined;
+        return formatBytes(this._data.size);
+    }
+    /**
+     * File extension derived from filename
+     * Returns empty string if no file or no extension
+     */
+    get extension() {
+        if (!this.filename)
+            return "";
+        const parts = this.filename.split(".");
+        const ext = parts.at(-1);
+        if (!ext || parts.length <= 1)
+            return "";
+        return ext.toLowerCase();
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Status Helpers
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Whether the document is ready for download
+     */
+    get isAvailable() {
+        return (this.status === DocumentStatus.Uploaded ||
+            this.status === DocumentStatus.Verified);
+    }
+    /**
+     * Whether the document is pending upload
+     */
+    get isPending() {
+        return this.status === DocumentStatus.PendingUpload;
+    }
+    /**
+     * Whether the document has been verified
+     */
+    get isVerified() {
+        return this.status === DocumentStatus.Verified;
+    }
+    /**
+     * Whether the document was rejected
+     */
+    get isRejected() {
+        return this.status === DocumentStatus.Rejected;
+    }
+    /**
+     * Whether the document has expired
+     */
+    get isExpired() {
+        if (this.status === DocumentStatus.Expired)
+            return true;
+        if (!this._data.expiresAt)
+            return false;
+        return new Date(this._data.expiresAt) < new Date();
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Validity
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Document expiration date, if set
+     */
+    get expiresAt() {
+        return this._data.expiresAt ? new Date(this._data.expiresAt) : undefined;
+    }
+    /**
+     * Days until document expires (negative if already expired)
+     */
+    get daysUntilExpiry() {
+        if (!this.expiresAt)
+            return undefined;
+        const now = new Date();
+        const diffTime = this.expiresAt.getTime() - now.getTime();
+        return Math.ceil(diffTime / (1000 * 60 * 60 * 24));
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Fields
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Document-specific fields (extracted or provided data)
+     *
+     * For typed fields, use jurisdiction-specific document models:
+     * - MexIneFrontDocument.ineFields
+     * - MexPassportDocument.passportFields
+     * - etc.
+     */
+    get fields() {
+        return this._data
+            .fields;
+    }
+    /**
+     * Get a specific field value
+     */
+    getField(key) {
+        return this.fields?.[key];
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Metadata
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * External ID
+     */
+    get externalId() {
+        return this._data.externalId ?? undefined;
+    }
+    /**
+     * Custom metadata attached to the document
+     */
+    get metadata() {
+        return this._data.metadata;
+    }
+    /**
+     * Get a specific metadata value
+     */
+    getMetadata(key) {
+        return this.metadata?.[key];
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Timestamps
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * When the document was created
+     */
+    get createdAt() {
+        return new Date(this._data.createdAt);
+    }
+    /**
+     * When the document was last updated
+     */
+    get updatedAt() {
+        return new Date(this._data.updatedAt);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Jurisdiction Type Guards
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Whether this is a Mexico document
+     */
+    get isMexico() {
+        return this._data.jurisdiction === Jurisdiction.Mexico;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Category Helpers
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Whether this is an identity document
+     */
+    get isIdentityDocument() {
+        return this.category === DocumentCategory.Identity;
+    }
+    /**
+     * Whether this is an address proof document
+     */
+    get isAddressProof() {
+        return this.category === DocumentCategory.Address;
+    }
+    /**
+     * Whether this is a financial document
+     */
+    get isFinancialDocument() {
+        return this.category === DocumentCategory.Financial;
+    }
+    /**
+     * Whether this is an incorporation document
+     */
+    get isIncorporationDocument() {
+        return this.category === DocumentCategory.Incorporation;
+    }
+    /**
+     * Whether this is a tax document
+     */
+    get isTaxDocument() {
+        return this.category === DocumentCategory.Tax;
+    }
+}
+// ─────────────────────────────────────────────────────────────────
+// Helpers
+// ─────────────────────────────────────────────────────────────────
+/**
+ * Format bytes into human-readable string
+ */
+function formatBytes(bytes) {
+    if (bytes === 0)
+        return "0 bytes";
+    const units = ["bytes", "KB", "MB", "GB"];
+    let size = bytes;
+    let unitIndex = 0;
+    while (size >= 1024 && unitIndex < units.length - 1) {
+        size /= 1024;
+        unitIndex++;
+    }
+    // Show decimals only for KB and larger
+    if (unitIndex === 0) {
+        return `${size} ${units[unitIndex]}`;
+    }
+    return `${size.toFixed(1)} ${units[unitIndex]}`;
+}

package/dist/models/LinkedClient.d.ts

@@ -0,0 +1,62 @@
+/**
+ * LinkedClient Model
+ *
+ * Represents a client-to-client relationship with metadata.
+ */
+import type { ClientRelationshipType, LinkedClientResponse } from "@artu-ai/shared";
+import { BaseModel } from "./base";
+import { Client } from "./Client";
+/**
+ * Data structure for linked client.
+ */
+export type LinkedClientData = LinkedClientResponse;
+/**
+ * LinkedClient model class.
+ *
+ * Provides typed access to linked client data including:
+ * - Relationship type (legal_representative, controlling_beneficiary, etc.)
+ * - The linked client
+ * - Metadata for the relationship
+ * - Timestamps
+ *
+ * @example
+ * ```typescript
+ * const linkedClients = await sdk.clients.listLinkedClients(companyId);
+ * for (const linkedClient of linkedClients) {
+ *   console.log(linkedClient.id, linkedClient.relationshipType);
+ *   console.log(linkedClient.client.name);
+ *   console.log(linkedClient.metadata);
+ * }
+ * ```
+ */
+export declare class LinkedClient extends BaseModel<LinkedClientData> {
+    /**
+     * Unique identifier for this relationship
+     */
+    get id(): string;
+    /**
+     * Type of relationship between the parent and child client.
+     */
+    get relationshipType(): ClientRelationshipType;
+    /**
+     * The linked (child) client.
+     */
+    get client(): Client;
+    /**
+     * Optional metadata for the relationship.
+     */
+    get metadata(): Record<string, unknown> | undefined;
+    /**
+     * When the relationship was created.
+     */
+    get createdAt(): string;
+    /**
+     * When the relationship was last updated.
+     */
+    get updatedAt(): string;
+}
+/**
+ * Type guard for LinkedClient model.
+ */
+export declare function isLinkedClient(obj: unknown): obj is LinkedClient;
+//# sourceMappingURL=LinkedClient.d.ts.map

package/dist/models/LinkedClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkedClient.d.ts","sourceRoot":"","sources":["../../src/models/LinkedClient.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,MAAM,EAAmB,MAAM,UAAU,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,YAAa,SAAQ,SAAS,CAAC,gBAAgB,CAAC;IAC3D;;OAEG;IACH,IAAI,EAAE,IAAI,MAAM,CAEf;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,sBAAsB,CAE7C;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAElD;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;CACF;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,YAAY,CAEhE"}

package/dist/models/LinkedClient.js

@@ -0,0 +1,70 @@
+/**
+ * LinkedClient Model
+ *
+ * Represents a client-to-client relationship with metadata.
+ */
+import { BaseModel } from "./base";
+import { Client } from "./Client";
+/**
+ * LinkedClient model class.
+ *
+ * Provides typed access to linked client data including:
+ * - Relationship type (legal_representative, controlling_beneficiary, etc.)
+ * - The linked client
+ * - Metadata for the relationship
+ * - Timestamps
+ *
+ * @example
+ * ```typescript
+ * const linkedClients = await sdk.clients.listLinkedClients(companyId);
+ * for (const linkedClient of linkedClients) {
+ *   console.log(linkedClient.id, linkedClient.relationshipType);
+ *   console.log(linkedClient.client.name);
+ *   console.log(linkedClient.metadata);
+ * }
+ * ```
+ */
+export class LinkedClient extends BaseModel {
+    /**
+     * Unique identifier for this relationship
+     */
+    get id() {
+        return this._data.id;
+    }
+    /**
+     * Type of relationship between the parent and child client.
+     */
+    get relationshipType() {
+        return this._data.relationshipType;
+    }
+    /**
+     * The linked (child) client.
+     */
+    get client() {
+        return new Client(this._data.client);
+    }
+    /**
+     * Optional metadata for the relationship.
+     */
+    get metadata() {
+        return this._data.metadata;
+    }
+    /**
+     * When the relationship was created.
+     */
+    get createdAt() {
+        return this._data.createdAt;
+    }
+    /**
+     * When the relationship was last updated.
+     */
+    get updatedAt() {
+        return this._data.updatedAt;
+    }
+}
+/**
+ * Type guard for LinkedClient model.
+ */
+export function isLinkedClient(obj) {
+    return obj instanceof LinkedClient;
+}

package/dist/models/Report.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Base Report Model
+ *
+ * Pure data model with no API calls.
+ * Provides type-safe access to common report properties.
+ */
+import { BaseModel } from "./base";
+import { ReportStatus } from "@artu-ai/shared";
+import type { BaseReport, Report as ReportSchema } from "@artu-ai/shared";
+/**
+ * Report data as returned from the API.
+ */
+export type ReportData = ReportSchema;
+/**
+ * Base Report Model.
+ *
+ * Pure data model with no API calls.
+ * Extended by jurisdiction-specific models (MexReport, etc.).
+ *
+ * @example
+ * ```typescript
+ * const report = await sdk.reports.retrieve("report_123");
+ * console.log(report.type);
+ * console.log(report.status);
+ * ```
+ */
+export declare class Report extends BaseModel<ReportData> {
+    /**
+     * Unique identifier
+     */
+    get id(): string;
+    /**
+     * Organization ID
+     */
+    get organizationId(): string;
+    /**
+     * Environment (test or live)
+     */
+    get environment(): "test" | "live";
+    /**
+     * Report status
+     */
+    get status(): ReportStatus;
+    /**
+     * Number of items in the report
+     */
+    get itemCount(): number;
+    /**
+     * Whether the report is in draft status
+     */
+    get isDraft(): boolean;
+    /**
+     * Whether the report has been validated successfully
+     */
+    get isValid(): boolean;
+    /**
+     * Whether the report failed validation
+     */
+    get isInvalid(): boolean;
+    /**
+     * Whether the report has been submitted
+     */
+    get isSubmitted(): boolean;
+    /**
+     * Whether the report can be edited
+     */
+    get canEdit(): boolean;
+    /**
+     * Whether the report can be validated/generated
+     */
+    get canGenerate(): boolean;
+    /**
+     * Raw jurisdiction data object
+     */
+    get jurisdictions(): BaseReport["jurisdictions"];
+    /**
+     * External ID for integration with other systems
+     */
+    get externalId(): string | undefined;
+    /**
+     * Custom metadata
+     */
+    get metadata(): Record<string, unknown> | undefined;
+    /**
+     * When the report was created
+     */
+    get createdAt(): Date;
+    /**
+     * When the report was last updated
+     */
+    get updatedAt(): Date;
+    toString(): string;
+}
+/**
+ * Check if value is any type of Report model
+ */
+export declare function isReport(value: unknown): value is Report;
+//# sourceMappingURL=Report.d.ts.map

package/dist/models/Report.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Report.d.ts","sourceRoot":"","sources":["../../src/models/Report.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAM1E;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,YAAY,CAAC;AAMtC;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAO,SAAQ,SAAS,CAAC,UAAU,CAAC;IAK/C;;OAEG;IACH,IAAI,EAAE,IAAI,MAAM,CAEf;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,GAAG,MAAM,CAEjC;IAMD;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAMrB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAMD;;OAEG;IACH,IAAI,aAAa,IAAI,UAAU,CAAC,eAAe,CAAC,CAE/C;IAMD;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAElD;IAMD;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAMQ,QAAQ,IAAI,MAAM;CAG5B;AAMD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD"}

package/dist/models/Report.js

@@ -0,0 +1,156 @@
+/**
+ * Base Report Model
+ *
+ * Pure data model with no API calls.
+ * Provides type-safe access to common report properties.
+ */
+import { BaseModel } from "./base";
+import { ReportStatus } from "@artu-ai/shared";
+// ===========================
+// Report Model
+// ===========================
+/**
+ * Base Report Model.
+ *
+ * Pure data model with no API calls.
+ * Extended by jurisdiction-specific models (MexReport, etc.).
+ *
+ * @example
+ * ```typescript
+ * const report = await sdk.reports.retrieve("report_123");
+ * console.log(report.type);
+ * console.log(report.status);
+ * ```
+ */
+export class Report extends BaseModel {
+    // ─────────────────────────────────────────────────────────────────
+    // Identity
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Unique identifier
+     */
+    get id() {
+        return this._data.id;
+    }
+    /**
+     * Organization ID
+     */
+    get organizationId() {
+        return this._data.organizationId;
+    }
+    /**
+     * Environment (test or live)
+     */
+    get environment() {
+        return this._data.environment;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Status
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Report status
+     */
+    get status() {
+        return this._data.status;
+    }
+    /**
+     * Number of items in the report
+     */
+    get itemCount() {
+        return this._data.itemCount;
+    }
+    /**
+     * Whether the report is in draft status
+     */
+    get isDraft() {
+        return this._data.status === ReportStatus.Draft;
+    }
+    /**
+     * Whether the report has been validated successfully
+     */
+    get isValid() {
+        return this._data.status === ReportStatus.Valid;
+    }
+    /**
+     * Whether the report failed validation
+     */
+    get isInvalid() {
+        return this._data.status === ReportStatus.Invalid;
+    }
+    /**
+     * Whether the report has been submitted
+     */
+    get isSubmitted() {
+        return this._data.status === ReportStatus.Submitted;
+    }
+    /**
+     * Whether the report can be edited
+     */
+    get canEdit() {
+        return [
+            ReportStatus.Draft,
+            ReportStatus.Valid,
+            ReportStatus.Invalid,
+        ].includes(this._data.status);
+    }
+    /**
+     * Whether the report can be validated/generated
+     */
+    get canGenerate() {
+        return [ReportStatus.Draft, ReportStatus.Valid].includes(this._data.status);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Jurisdiction
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * Raw jurisdiction data object
+     */
+    get jurisdictions() {
+        return this._data.jurisdictions ?? {};
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Metadata
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * External ID for integration with other systems
+     */
+    get externalId() {
+        return this._data.externalId;
+    }
+    /**
+     * Custom metadata
+     */
+    get metadata() {
+        return this._data.metadata;
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // Timestamps
+    // ─────────────────────────────────────────────────────────────────
+    /**
+     * When the report was created
+     */
+    get createdAt() {
+        return new Date(this._data.createdAt);
+    }
+    /**
+     * When the report was last updated
+     */
+    get updatedAt() {
+        return new Date(this._data.updatedAt);
+    }
+    // ─────────────────────────────────────────────────────────────────
+    // String Representation
+    // ─────────────────────────────────────────────────────────────────
+    toString() {
+        return `Report(${this.id}, ${this.status})`;
+    }
+}
+// ===========================
+// Type Guards
+// ===========================
+/**
+ * Check if value is any type of Report model
+ */
+export function isReport(value) {
+    return value instanceof Report;
+}