@bloque/sdk 0.0.2 → 0.0.4

package/README.md

@@ -5,7 +5,7 @@ The official TypeScript/JavaScript SDK for integrating [Bloque](https://www.bloq
 ## Features
 
 - **TypeScript First**: Built with TypeScript for complete type safety
-- **Simple API**: Intuitive interface for managing organizations
+- **Simple API**: Intuitive interface for managing organizations, compliance, accounts, and identity
 - **Fully Async**: Promise-based API for modern JavaScript workflows
 - **Lightweight**: Minimal dependencies for optimal bundle size
 - **Modular**: Import only what you need with tree-shakeable exports
@@ -51,6 +51,17 @@ async function createOrganization() {
   const organization = await bloque.orgs.create(params);
   console.log('Organization created:', organization);
 }
+
+// Create a virtual card
+async function createCard() {
+  const card = await bloque.accounts.card.create({
+    urn: 'did:bloque:user:123e4567',
+    name: 'My Virtual Card',
+  });
+
+  console.log('Card created:', card.urn);
+  console.log('Last four digits:', card.lastFour);
+}
 ```
 
 ## Configuration
@@ -138,6 +149,180 @@ type OrgStatus =
   | 'closed';
 ```
 
+### Compliance
+
+The compliance resource provides KYC (Know Your Customer) verification functionality.
+
+#### Start KYC Verification
+
+Start a KYC verification process for a user:
+
+```typescript
+const verification = await bloque.compliance.kyc.startVerification({
+  urn: 'did:bloque:origin:user-id',
+});
+```
+
+**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:..."
+   */
+  urn: string;
+
+  /**
+   * URL where webhook notifications will be sent when the verification
+   * status changes (optional).
+   *
+   * @example "https://api.example.com/webhooks/kyc"
+   */
+  webhookUrl?: string;
+}
+```
+
+**Response**:
+
+```typescript
+interface KycVerificationResponse {
+  url: string;  // URL where the user should complete the verification
+  status: 'awaiting_compliance_verification' | 'approved' | 'rejected';
+}
+```
+
+#### Get KYC Verification Status
+
+Get the current status of a KYC verification:
+
+```typescript
+const status = await bloque.compliance.kyc.getVerification({
+  urn: 'did:bloque:user:123e4567',
+});
+```
+
+**Parameters**:
+
+```typescript
+interface GetKycVerificationParams {
+  /**
+   * URN (Uniform Resource Name) that uniquely identifies the user
+   * within the system.
+   *
+   * @example "did:bloque:user:123e4567"
+   */
+  urn: string;
+}
+```
+
+**Response**:
+
+```typescript
+interface KycVerificationStatus {
+  status: 'awaiting_compliance_verification' | 'approved' | 'rejected';
+  url: string;                                  // URL for verification
+  completedAt: string | null;                               // Completion date (ISO 8601)
+}
+```
+
+### Accounts
+
+The accounts resource allows you to create virtual cards for users.
+
+#### Create a Virtual Card
+
+Create a virtual card for a user:
+
+```typescript
+const card = await bloque.accounts.card.create({
+  urn: 'did:bloque:user:123e4567',
+  name: 'My Virtual Card', // Optional
+});
+```
+
+**Parameters**:
+
+```typescript
+interface CreateCardParams {
+  /**
+   * URN of the account holder (user or organization)
+   * @example "did:bloque:user:123e4567"
+   */
+  urn: string;
+
+  /**
+   * Display name for the card (optional)
+   */
+  name?: string;
+}
+```
+
+**Response**:
+
+```typescript
+interface CardAccount {
+  urn: string;                    // Unique resource name
+  id: string;                     // Card account ID
+  lastFour: string;               // Last four digits
+  productType: 'CREDIT' | 'DEBIT'; // Card product type
+  status: 'active' | 'disabled' | 'frozen' | 'deleted' | 'creation_in_progress' | 'creation_failed';
+  cardType: 'VIRTUAL' | 'PHYSICAL'; // Card type
+  detailsUrl: string;             // PCI-compliant URL to view card details
+  ownerUrn: string;               // Owner URN
+  webhookUrl: string | null;      // Webhook URL (if configured)
+  metadata?: Record<string, unknown>; // Custom metadata
+  createdAt: string;              // Creation timestamp (ISO 8601)
+  updatedAt: string;              // Last update timestamp (ISO 8601)
+}
+```
+
+### Identity
+
+The identity resource allows you to retrieve user aliases (alternative identifiers like email or phone).
+
+#### Get Alias
+
+Retrieve alias information by the alias value:
+
+```typescript
+const alias = await bloque.identity.aliases.get('user@example.com');
+```
+
+**Parameters**:
+
+```typescript
+// Pass the alias string directly
+const alias: string = 'user@example.com' | '+1234567890';
+```
+
+**Response**:
+
+```typescript
+interface Alias {
+  id: string;                                  // Unique alias ID
+  alias: string;                               // Alias value
+  type: 'phone' | 'email' | string;           // Alias type
+  urn: string;                                 // Associated user URN
+  origin: string;                              // Origin identifier
+  details: {
+    phone?: string;                            // Phone details (if applicable)
+  };
+  metadata: {
+    alias: string;                             // Alias in metadata
+    [key: string]: unknown;                    // Additional metadata
+  };
+  status: 'active' | 'inactive' | 'revoked';  // Alias status
+  is_public: boolean;                          // Whether alias is public
+  is_primary: boolean;                         // Whether this is the primary alias
+  created_at: string;                          // Creation timestamp (ISO 8601)
+  updated_at: string;                          // Last update timestamp (ISO 8601)
+}
+```
+
 ## Examples
 
 ### Creating a Business Organization
@@ -260,6 +445,147 @@ const organization = await bloque.orgs.create(params);
 console.log('Multi-location organization created');
 ```
 
+### Starting 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',
+});
+
+// Start KYC verification for a user
+const params: KycVerificationParams = {
+  urn: 'did:bloque:origin:user-123',
+  webhookUrl: 'https://api.example.com/webhooks/kyc', // Optional webhook URL
+};
+
+try {
+  const verification = await bloque.compliance.kyc.startVerification(params);
+
+  console.log('Verification URL:', verification.url);
+  console.log('Status:', verification.status);
+
+  // Redirect the user to verification.url to complete KYC
+  // Webhook notifications will be sent to the provided webhookUrl
+} catch (error) {
+  console.error('Failed to start KYC verification:', error);
+}
+```
+
+### Getting KYC 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',
+});
+
+// Get verification status
+const params: GetKycVerificationParams = {
+  urn: 'did:bloque:user:123e4567',
+};
+
+try {
+  const status = await bloque.compliance.kyc.getVerification(params);
+
+  console.log('Status:', status.status);
+  console.log('Verification URL:', status.url);
+  console.log('Completed At:', status.completedAt);
+
+  if (status.status === 'approved') {
+    console.log('User verification approved!');
+  } else if (status.status === 'rejected') {
+    console.log('User verification rejected');
+  } else {
+    console.log('Verification still pending');
+  }
+} catch (error) {
+  console.error('Failed to get verification status:', error);
+}
+```
+
+### Creating a Virtual Card
+
+```typescript
+import { SDK } from '@bloque/sdk';
+import type { CreateCardParams } from '@bloque/sdk/accounts';
+
+const bloque = new SDK({
+  apiKey: process.env.BLOQUE_API_KEY!,
+  mode: 'production',
+});
+
+// Create a virtual card
+const params: CreateCardParams = {
+  urn: 'did:bloque:user:123e4567',
+  name: 'My Business Card', // Optional
+};
+
+try {
+  const card = await bloque.accounts.card.create(params);
+
+  console.log('Card created:', card.urn);
+  console.log('Last four digits:', card.lastFour);
+  console.log('Card type:', card.cardType);
+  console.log('Status:', card.status);
+  console.log('Details URL:', card.detailsUrl);
+
+  // Check if card is ready to use
+  if (card.status === 'active') {
+    console.log('Card is active and ready to use!');
+  } else if (card.status === 'creation_in_progress') {
+    console.log('Card is being created...');
+  }
+} catch (error) {
+  console.error('Failed to create card:', error);
+}
+```
+
+### Retrieving User Alias Information
+
+```typescript
+import { SDK } from '@bloque/sdk';
+
+const bloque = new SDK({
+  apiKey: process.env.BLOQUE_API_KEY!,
+  mode: 'production',
+});
+
+// Get alias information by email
+try {
+  const alias = await bloque.identity.aliases.get('user@example.com');
+
+  console.log('Alias ID:', alias.id);
+  console.log('Alias type:', alias.type);
+  console.log('Associated URN:', alias.urn);
+  console.log('Status:', alias.status);
+  console.log('Is primary:', alias.is_primary);
+  console.log('Is public:', alias.is_public);
+
+  if (alias.status === 'active') {
+    console.log('Alias is active');
+  }
+} catch (error) {
+  console.error('Failed to retrieve alias:', error);
+}
+
+// Get alias information by phone number
+try {
+  const phoneAlias = await bloque.identity.aliases.get('+1234567890');
+
+  console.log('Phone alias:', phoneAlias.alias);
+  console.log('Phone details:', phoneAlias.details.phone);
+} catch (error) {
+  console.error('Failed to retrieve phone alias:', error);
+}
+```
+
 ### Using in an API Endpoint
 
 ```typescript
@@ -397,6 +723,25 @@ import type {
   OrgStatus,
   Place,
 } from '@bloque/sdk/orgs';
+
+// Compliance types
+import type {
+  KycVerificationParams,
+  KycVerificationResponse,
+  GetKycVerificationParams,
+  KycVerificationStatus,
+} from '@bloque/sdk/compliance';
+
+// Accounts types
+import type {
+  CardAccount,
+  CreateCardParams,
+} from '@bloque/sdk/accounts';
+
+// Identity types
+import type {
+  Alias,
+} from '@bloque/sdk/identity';
 ```
 
 ## Development
@@ -444,6 +789,9 @@ This monorepo contains the following packages:
 - **`@bloque/sdk`**: Main SDK package
 - **`@bloque/sdk-core`**: Core utilities and HTTP client
 - **`@bloque/sdk-orgs`**: Organizations API client
+- **`@bloque/sdk-compliance`**: Compliance and KYC verification API client
+- **`@bloque/sdk-accounts`**: Accounts and virtual cards API client
+- **`@bloque/sdk-identity`**: Identity and aliases API client
 
 ## License
 

package/dist/accounts.d.ts

@@ -0,0 +1,3 @@
+export type { CardAccount, CreateCardParams, } from '@bloque/sdk-accounts';
+import { AccountsClient } from '@bloque/sdk-accounts';
+export declare const Accounts: AccountsClient;

package/dist/bloque.d.ts

@@ -1,7 +1,13 @@
+import { AccountsClient } from '@bloque/sdk-accounts';
+import { ComplianceClient } from '@bloque/sdk-compliance';
 import { type BloqueConfig } from '@bloque/sdk-core';
+import { IdentityClient } from '@bloque/sdk-identity';
 import { OrgsClient } from '@bloque/sdk-orgs';
 export declare class SDK {
     private readonly httpClient;
+    readonly accounts: AccountsClient;
+    readonly compliance: ComplianceClient;
+    readonly identity: IdentityClient;
     readonly orgs: OrgsClient;
     constructor(config: BloqueConfig);
 }

package/dist/compliance.d.ts

@@ -0,0 +1,3 @@
+export type { GetKycVerificationParams, KycVerificationParams, KycVerificationResponse, } from '@bloque/sdk-compliance';
+import { ComplianceClient } from '@bloque/sdk-compliance';
+export declare const Compliance: ComplianceClient;

package/dist/config.d.ts

@@ -0,0 +1,3 @@
+import type { BloqueConfig } from '@bloque/sdk-core';
+export declare function setConfig(next: BloqueConfig): void;
+export declare function getConfig(): BloqueConfig;

package/dist/identity.d.ts

@@ -0,0 +1,3 @@
+export type { Alias } from '@bloque/sdk-identity';
+import { IdentityClient } from '@bloque/sdk-identity';
+export declare const Identity: IdentityClient;

package/dist/index.cjs

@@ -26,13 +26,22 @@ __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
     SDK: ()=>SDK
 });
+const sdk_accounts_namespaceObject = require("@bloque/sdk-accounts");
+const sdk_compliance_namespaceObject = require("@bloque/sdk-compliance");
 const sdk_core_namespaceObject = require("@bloque/sdk-core");
+const sdk_identity_namespaceObject = require("@bloque/sdk-identity");
 const sdk_orgs_namespaceObject = require("@bloque/sdk-orgs");
 class SDK {
     httpClient;
+    accounts;
+    compliance;
+    identity;
     orgs;
     constructor(config){
         this.httpClient = new sdk_core_namespaceObject.HttpClient(config);
+        this.accounts = new sdk_accounts_namespaceObject.AccountsClient(this.httpClient);
+        this.compliance = new sdk_compliance_namespaceObject.ComplianceClient(this.httpClient);
+        this.identity = new sdk_identity_namespaceObject.IdentityClient(this.httpClient);
         this.orgs = new sdk_orgs_namespaceObject.OrgsClient(this.httpClient);
     }
 }

package/dist/index.js

@@ -1,10 +1,19 @@
+import { AccountsClient } from "@bloque/sdk-accounts";
+import { ComplianceClient } from "@bloque/sdk-compliance";
 import { HttpClient } from "@bloque/sdk-core";
+import { IdentityClient } from "@bloque/sdk-identity";
 import { OrgsClient } from "@bloque/sdk-orgs";
 class SDK {
     httpClient;
+    accounts;
+    compliance;
+    identity;
     orgs;
     constructor(config){
         this.httpClient = new HttpClient(config);
+        this.accounts = new AccountsClient(this.httpClient);
+        this.compliance = new ComplianceClient(this.httpClient);
+        this.identity = new IdentityClient(this.httpClient);
         this.orgs = new OrgsClient(this.httpClient);
     }
 }

package/dist/init.d.ts

@@ -0,0 +1,2 @@
+import type { BloqueConfig } from '@bloque/sdk-core';
+export declare function init(config: BloqueConfig): void;

package/dist/orgs.d.ts

@@ -1 +1,3 @@
 export type { CreateOrgParams, CreateOrgResponse, Organization, OrgProfile, OrgStatus, OrgType, Place, } from '@bloque/sdk-orgs';
+import { OrgsClient } from '@bloque/sdk-orgs';
+export declare const Orgs: OrgsClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bloque/sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Official Bloque SDK",
   "type": "module",
   "keywords": [
@@ -19,12 +19,33 @@
     "url": "git+https://github.com/bloque-app/sdk.git",
     "directory": "packages/sdk"
   },
+  "sideEffects": false,
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
+    "./init": {
+      "types": "./dist/init.d.ts",
+      "import": "./dist/init.js",
+      "require": "./dist/init.cjs"
+    },
+    "./accounts": {
+      "types": "./dist/accounts.d.ts",
+      "import": "./dist/accounts.js",
+      "require": "./dist/accounts.cjs"
+    },
+    "./compliance": {
+      "types": "./dist/compliance.d.ts",
+      "import": "./dist/compliance.js",
+      "require": "./dist/compliance.cjs"
+    },
+    "./identity": {
+      "types": "./dist/identity.d.ts",
+      "import": "./dist/identity.js",
+      "require": "./dist/identity.cjs"
+    },
     "./orgs": {
       "types": "./dist/orgs.d.ts",
       "import": "./dist/orgs.js",
@@ -47,7 +68,10 @@
     "typecheck": "tsgo --noEmit"
   },
   "dependencies": {
+    "@bloque/sdk-accounts": "workspace:*",
+    "@bloque/sdk-compliance": "workspace:*",
     "@bloque/sdk-core": "workspace:*",
+    "@bloque/sdk-identity": "workspace:*",
     "@bloque/sdk-orgs": "workspace:*"
   },
   "devDependencies": {