@bloque/sdk-compliance 0.0.3

package/README.md

@@ -0,0 +1,342 @@
+# @bloque/sdk-compliance
+
+Compliance and KYC verification client for the [Bloque](https://www.bloque.app) platform.
+
+## Features
+
+- **KYC Verification**: Start and manage Know Your Customer verification processes
+- **TypeScript First**: Built with TypeScript for complete type safety
+- **Fully Async**: Promise-based API for modern JavaScript workflows
+- **Lightweight**: Minimal dependencies for optimal bundle size
+
+## Installation
+
+This package is included in the main `@bloque/sdk` package. You typically don't need to install it separately.
+
+```bash
+bun add @bloque/sdk
+```
+
+If you need to use this package standalone:
+
+```bash
+bun add @bloque/sdk-compliance @bloque/sdk-core
+```
+
+## Usage
+
+### With the Main SDK (Recommended)
+
+```typescript
+import { SDK } from '@bloque/sdk';
+
+const bloque = new SDK({
+  apiKey: process.env.BLOQUE_API_KEY!,
+  mode: 'production',
+});
+
+// Start KYC verification
+const verification = await bloque.compliance.kyc.startVerification({
+  urn: 'did:bloque:origin:user-123',
+});
+
+console.log('Verification URL:', verification.url);
+console.log('Status:', verification.status);
+```
+
+### Standalone Usage
+
+```typescript
+import { ComplianceClient } from '@bloque/sdk-compliance';
+import { HttpClient } from '@bloque/sdk-core';
+
+const httpClient = new HttpClient({
+  apiKey: process.env.BLOQUE_API_KEY!,
+  mode: 'production',
+});
+
+const compliance = new ComplianceClient(httpClient);
+
+const verification = await compliance.kyc.startVerification({
+  urn: 'did:bloque:origin:user-123',
+});
+```
+
+## API Reference
+
+### KYC Verification
+
+#### `startVerification(params)`
+
+Initiates a KYC verification process for a user.
+
+**Parameters**:
+
+```typescript
+interface KycVerificationParams {
+  /**
+   * URN (Uniform Resource Name) that uniquely identifies the user
+   * within the system.
+   *
+   * This value is used to associate the KYC verification process
+   * with a specific user.
+   *
+   * @example "did:bloque:origin:user-123"
+   */
+  urn: string;
+
+  /**
+   * URL where webhook notifications will be sent when the verification
+   * status changes.
+   *
+   * This is optional. If provided, the platform will send POST requests
+   * to this URL with verification status updates.
+   *
+   * @example "https://api.example.com/webhooks/kyc"
+   */
+  webhookUrl?: string;
+}
+```
+
+**Returns**:
+
+```typescript
+interface KycVerificationResponse {
+  /**
+   * URL where the user should complete the verification process.
+   * Redirect the user to this URL to complete KYC.
+   */
+  url: string;
+
+  /**
+   * Current status of the verification
+   */
+  status: 'awaiting_compliance_verification' | 'approved' | 'rejected';
+}
+```
+
+**Example**:
+
+```typescript
+const verification = await bloque.compliance.kyc.startVerification({
+  urn: 'did:bloque:origin:user-123',
+  webhookUrl: 'https://api.example.com/webhooks/kyc', // Optional
+});
+
+// Redirect user to verification.url
+window.location.href = verification.url;
+```
+
+#### `getVerification(params)`
+
+Retrieves the current status of a KYC verification.
+
+**Parameters**:
+
+```typescript
+interface GetKycVerificationParams {
+  /**
+   * URN (Uniform Resource Name) that uniquely identifies the user
+   * within the system.
+   *
+   * @example "did:bloque:user:123e4567"
+   */
+  urn: string;
+}
+```
+
+**Returns**:
+
+```typescript
+interface KycVerificationResponse {
+  /**
+   * Current status of the verification
+   */
+  status: 'awaiting_compliance_verification' | 'approved' | 'rejected';
+
+  /**
+   * URL where the user can complete or view the verification
+   */
+  url: string;
+
+  /**
+   * Date when the verification was completed (ISO 8601 format)
+   * null if verification is not yet completed
+   */
+  completedAt: string | null;
+}
+```
+
+**Example**:
+
+```typescript
+const status = await bloque.compliance.kyc.getVerification({
+  urn: 'did:bloque:user:123e4567',
+});
+
+console.log('Status:', status.status);
+console.log('Completed At:', status.completedAt);
+
+if (status.status === 'approved') {
+  console.log('Verification approved!');
+}
+```
+
+## Complete Examples
+
+### Basic KYC Verification
+
+```typescript
+import { SDK } from '@bloque/sdk';
+import type { KycVerificationParams } from '@bloque/sdk-compliance';
+
+const bloque = new SDK({
+  apiKey: process.env.BLOQUE_API_KEY!,
+  mode: 'production',
+});
+
+async function startUserVerification(
+  userUrn: string,
+  webhookUrl?: string,
+) {
+  try {
+    const params: KycVerificationParams = {
+      urn: userUrn,
+      webhookUrl,
+    };
+
+    const verification = await bloque.compliance.kyc.startVerification(params);
+
+    console.log('✓ Verification started');
+    console.log('  URL:', verification.url);
+    console.log('  Status:', verification.status);
+
+    return verification;
+  } catch (error) {
+    console.error('Failed to start verification:', error);
+    throw error;
+  }
+}
+
+// Usage
+await startUserVerification(
+  'did:bloque:origin:user-123',
+  'https://api.example.com/webhooks/kyc',
+);
+```
+
+### Getting Verification Status
+
+```typescript
+import { SDK } from '@bloque/sdk';
+import type { GetKycVerificationParams } from '@bloque/sdk-compliance';
+
+const bloque = new SDK({
+  apiKey: process.env.BLOQUE_API_KEY!,
+  mode: 'production',
+});
+
+async function checkVerificationStatus(userUrn: string) {
+  try {
+    const params: GetKycVerificationParams = {
+      urn: userUrn,
+    };
+
+    const status = await bloque.compliance.kyc.getVerification(params);
+
+    console.log('✓ Verification status retrieved');
+    console.log('  Status:', status.status);
+    console.log('  Verification URL:', status.url);
+    console.log('  Completed At:', status.completedAt);
+
+    return status;
+  } catch (error) {
+    console.error('Failed to get verification status:', error);
+    throw error;
+  }
+}
+
+// Usage
+await checkVerificationStatus('did:bloque:user:123e4567');
+```
+
+## TypeScript Support
+
+This package is written in TypeScript and includes complete type definitions:
+
+```typescript
+import type {
+  ComplianceClient,
+  KycClient,
+  KycVerificationParams,
+  KycVerificationResponse,
+  GetKycVerificationParams,
+} from '@bloque/sdk-compliance';
+
+// Type-safe verification start
+const startParams: KycVerificationParams = {
+  urn: 'did:bloque:origin:user-123',
+  webhookUrl: 'https://api.example.com/webhooks/kyc', // Optional
+};
+
+const verification: KycVerificationResponse =
+  await bloque.compliance.kyc.startVerification(startParams);
+
+// Type-safe verification status check
+const statusParams: GetKycVerificationParams = {
+  urn: 'did:bloque:user:123e4567',
+};
+
+const status: KycVerificationStatus =
+  await bloque.compliance.kyc.getVerification(statusParams);
+```
+
+## Error Handling
+
+Always wrap API calls in try-catch blocks:
+
+```typescript
+// Start verification
+try {
+  const verification = await bloque.compliance.kyc.startVerification({
+    urn: userUrn,
+  });
+  // Handle success
+} catch (error) {
+  if (error instanceof Error) {
+    console.error('Verification failed:', error.message);
+  }
+  // Handle error
+}
+
+// Get verification status
+try {
+  const status = await bloque.compliance.kyc.getVerification({
+    urn: userUrn,
+  });
+  // Handle success
+} catch (error) {
+  if (error instanceof Error) {
+    console.error('Failed to get status:', error.message);
+  }
+  // Handle error
+}
+```
+
+## Requirements
+
+- Node.js 22.x or higher / Bun 1.x or higher
+- TypeScript 5.x or higher (for TypeScript projects)
+
+## Links
+
+- [Homepage](https://www.bloque.app)
+- [Main SDK Documentation](../sdk/README.md)
+- [GitHub Repository](https://github.com/bloque-app/sdk)
+- [Issue Tracker](https://github.com/bloque-app/sdk/issues)
+
+## License
+
+[MIT](../../LICENSE)
+
+Copyright (c) 2025-present Bloque Copilot Inc.

package/dist/api-types.d.ts

@@ -0,0 +1,22 @@
+export type AccompliceType = 'person' | 'company';
+export interface StartKycVerificationRequest {
+    urn: string;
+    type: 'kyc' | 'kyb';
+    accompliceType: AccompliceType;
+    webhookUrl?: string;
+}
+export interface StartKycVerificationResponse {
+    url: string;
+    type: 'kyc' | 'kyb';
+    level: 'basic';
+    provider: 'AMLBOT';
+    status: 'awaiting_compliance_verification' | 'approved' | 'rejected';
+}
+export interface GetKycVerificationResponse {
+    type: 'kyc' | 'kyb';
+    level: 'basic';
+    provider: 'AMLBOT';
+    status: 'awaiting_compliance_verification' | 'approved' | 'rejected';
+    verification_url: string;
+    completed_at: string | null;
+}

package/dist/client.d.ts

@@ -0,0 +1,7 @@
+import type { HttpClient } from '@bloque/sdk-core';
+import { KycClient } from './kyc/client';
+export declare class ComplianceClient {
+    private readonly httpClient;
+    readonly kyc: KycClient;
+    constructor(httpClient: HttpClient);
+}

package/dist/index.cjs

@@ -0,0 +1,82 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    KycClient: ()=>KycClient,
+    ComplianceClient: ()=>ComplianceClient
+});
+class KycClient {
+    httpClient;
+    constructor(httpClient){
+        this.httpClient = httpClient;
+    }
+    async startVerification(params) {
+        const response = await this.httpClient.request({
+            method: 'POST',
+            path: '/api/compliance',
+            body: {
+                urn: params.urn,
+                type: 'kyc',
+                accompliceType: 'person',
+                ...params.webhookUrl && {
+                    webhookUrl: params.webhookUrl
+                }
+            }
+        });
+        return {
+            url: response.url,
+            status: response.status,
+            completedAt: null
+        };
+    }
+    async getVerification(params) {
+        const response = await this.httpClient.request({
+            method: 'GET',
+            path: `/api/compliance/${params.urn}`
+        });
+        return {
+            status: response.status,
+            url: response.verification_url,
+            completedAt: response.completed_at
+        };
+    }
+}
+class ComplianceClient {
+    httpClient;
+    kyc;
+    constructor(httpClient){
+        this.httpClient = httpClient;
+        this.kyc = new KycClient(this.httpClient);
+    }
+}
+exports.ComplianceClient = __webpack_exports__.ComplianceClient;
+exports.KycClient = __webpack_exports__.KycClient;
+for(var __rspack_i in __webpack_exports__)if (-1 === [
+    "ComplianceClient",
+    "KycClient"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './kyc/client';
+export * from './kyc/types';

package/dist/index.js

@@ -0,0 +1,45 @@
+class KycClient {
+    httpClient;
+    constructor(httpClient){
+        this.httpClient = httpClient;
+    }
+    async startVerification(params) {
+        const response = await this.httpClient.request({
+            method: 'POST',
+            path: '/api/compliance',
+            body: {
+                urn: params.urn,
+                type: 'kyc',
+                accompliceType: 'person',
+                ...params.webhookUrl && {
+                    webhookUrl: params.webhookUrl
+                }
+            }
+        });
+        return {
+            url: response.url,
+            status: response.status,
+            completedAt: null
+        };
+    }
+    async getVerification(params) {
+        const response = await this.httpClient.request({
+            method: 'GET',
+            path: `/api/compliance/${params.urn}`
+        });
+        return {
+            status: response.status,
+            url: response.verification_url,
+            completedAt: response.completed_at
+        };
+    }
+}
+class ComplianceClient {
+    httpClient;
+    kyc;
+    constructor(httpClient){
+        this.httpClient = httpClient;
+        this.kyc = new KycClient(this.httpClient);
+    }
+}
+export { ComplianceClient, KycClient };

package/dist/kyc/client.d.ts

@@ -0,0 +1,8 @@
+import type { HttpClient } from '@bloque/sdk-core';
+import type { GetKycVerificationParams, KycVerificationParams, KycVerificationResponse } from './types';
+export declare class KycClient {
+    private readonly httpClient;
+    constructor(httpClient: HttpClient);
+    startVerification(params: KycVerificationParams): Promise<KycVerificationResponse>;
+    getVerification(params: GetKycVerificationParams): Promise<KycVerificationResponse>;
+}

package/dist/kyc/types.d.ts

@@ -0,0 +1,46 @@
+export interface KycVerificationParams {
+    /**
+     * URN (Uniform Resource Name) that uniquely identifies the user
+     * within the system.
+     *
+     * This value is used to associate the KYC verification process
+     * with a specific user.
+     *
+     * @example "did:bloque:origin:..."
+     */
+    urn: string;
+    /**
+     * URL where webhook notifications will be sent when the verification
+     * status changes.
+     *
+     * This is optional. If provided, the platform will send POST requests
+     * to this URL with verification status updates.
+     *
+     * @example "https://api.example.com/webhooks/kyc"
+     */
+    webhookUrl?: string;
+}
+export interface KycVerificationResponse {
+    /**
+     * Current status of the verification
+     */
+    status: 'awaiting_compliance_verification' | 'approved' | 'rejected';
+    /**
+     * URL where the user can complete or view the verification
+     */
+    url: string;
+    /**
+     * Date when the verification was completed (ISO 8601 format)
+     * null if verification is not yet completed
+     */
+    completedAt: string | null;
+}
+export interface GetKycVerificationParams {
+    /**
+     * URN (Uniform Resource Name) that uniquely identifies the user
+     * within the system.
+     *
+     * @example "did:bloque:user:123e4567"
+     */
+    urn: string;
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@bloque/sdk-compliance",
+  "version": "0.0.3",
+  "type": "module",
+  "keywords": [
+    "bloque",
+    "sdk",
+    "api"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "homepage": "git+https://github.com/bloque-app/sdk.git#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bloque-app/sdk.git",
+    "directory": "packages/compliance"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "clean": "rm -rf node_modules && rm -rf dist",
+    "check": "biome check --write",
+    "typecheck": "tsgo --noEmit"
+  },
+  "dependencies": {
+    "@bloque/sdk-core": "workspace:*"
+  },
+  "devDependencies": {
+    "@rslib/core": "catalog:",
+    "@types/node": "catalog:",
+    "@typescript/native-preview": "catalog:",
+    "typescript": "catalog:"
+  }
+}