@credovo/shared-types 1.0.0

package/README.md

@@ -0,0 +1,67 @@
+# @credovo/shared-types
+
+Shared TypeScript types for the Credovo platform, used by both backend services and the frontend webapp.
+
+## Installation
+
+### From GitHub Packages
+
+```bash
+npm install @credovo/shared-types --registry=https://npm.pkg.github.com
+```
+
+### From npm (if published publicly)
+
+```bash
+npm install @credovo/shared-types
+```
+
+## Usage
+
+```typescript
+import { KYCRequest, KYCResponse, KYBRequest, KYBResponse } from '@credovo/shared-types';
+
+const kycRequest: KYCRequest = {
+  applicationId: 'app-123',
+  userId: 'user-456',
+  type: 'individual',
+  data: {
+    firstName: 'John',
+    lastName: 'Doe',
+    dateOfBirth: '1990-01-01'
+  }
+};
+```
+
+## Types Included
+
+- `Application` - Application data structure
+- `ApplicationStatus` - Application status enum
+- `KYCRequest` / `KYCResponse` - KYC verification types
+- `KYBRequest` / `KYBResponse` - KYB verification types
+- `ConnectorRequest` / `ConnectorResponse` - Connector service types
+- `Address` - Address structure
+- `CheckResult` - Verification check results
+- `ApiError` - API error structure
+
+## Publishing
+
+This package is published from the `credovo-platform` repository:
+
+```bash
+cd shared/types
+npm install
+npm run build
+npm publish --registry=https://npm.pkg.github.com
+```
+
+Or use the script:
+
+```powershell
+.\scripts\publish-shared-types.ps1
+```
+
+## Versioning
+
+Follows semantic versioning. Update version in `package.json` before publishing.
+

package/dist/index.d.ts

@@ -0,0 +1,101 @@
+export interface Application {
+    id: string;
+    userId: string;
+    status: ApplicationStatus;
+    createdAt: Date;
+    updatedAt: Date;
+    data: Record<string, any>;
+}
+export declare enum ApplicationStatus {
+    PENDING = "pending",
+    IN_PROGRESS = "in_progress",
+    COMPLETED = "completed",
+    REJECTED = "rejected",
+    FAILED = "failed"
+}
+export interface KYCRequest {
+    applicationId: string;
+    userId: string;
+    type: 'individual' | 'company';
+    data: {
+        firstName?: string;
+        lastName?: string;
+        dateOfBirth?: string;
+        address?: Address;
+        companyNumber?: string;
+        companyName?: string;
+    };
+}
+export interface Address {
+    line1: string;
+    line2?: string;
+    city: string;
+    postcode: string;
+    country: string;
+}
+export interface KYCResponse {
+    applicationId: string;
+    status: 'pending' | 'approved' | 'rejected' | 'requires_review';
+    provider: string;
+    result?: {
+        score?: number;
+        checks?: CheckResult[];
+        metadata?: Record<string, any>;
+    };
+    timestamp: Date;
+}
+export interface CheckResult {
+    type: string;
+    status: 'pass' | 'fail' | 'warning';
+    message?: string;
+}
+export interface KYBRequest {
+    applicationId: string;
+    companyNumber: string;
+    companyName?: string;
+    country?: string;
+}
+export interface KYBResponse {
+    applicationId: string;
+    companyNumber: string;
+    status: 'verified' | 'pending' | 'not_found' | 'error';
+    data?: {
+        companyName: string;
+        status: string;
+        incorporationDate?: string;
+        address?: Address;
+        officers?: any[];
+        verificationLevel?: string;
+        checks?: any[];
+        metadata?: any;
+    };
+    timestamp: Date;
+}
+export interface ConnectorRequest {
+    provider: string;
+    endpoint: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    headers?: Record<string, string>;
+    body?: any;
+    retry?: boolean;
+}
+export interface ConnectorResponse<T = any> {
+    success: boolean;
+    data?: T;
+    error?: {
+        code: string;
+        message: string;
+        details?: any;
+    };
+    metadata?: {
+        provider: string;
+        latency: number;
+        retries?: number;
+    };
+}
+export interface ApiError {
+    code: string;
+    message: string;
+    statusCode: number;
+    details?: any;
+}

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+// Shared types across all services
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationStatus = void 0;
+var ApplicationStatus;
+(function (ApplicationStatus) {
+    ApplicationStatus["PENDING"] = "pending";
+    ApplicationStatus["IN_PROGRESS"] = "in_progress";
+    ApplicationStatus["COMPLETED"] = "completed";
+    ApplicationStatus["REJECTED"] = "rejected";
+    ApplicationStatus["FAILED"] = "failed";
+})(ApplicationStatus || (exports.ApplicationStatus = ApplicationStatus = {}));

package/package.json

@@ -0,0 +1,32 @@
+{
+    "name":  "@credovo/shared-types",
+    "version":  "1.0.0",
+    "description":  "Shared TypeScript types for Credovo platform",
+    "main":  "dist/index.js",
+    "types":  "dist/index.d.ts",
+    "scripts":  {
+                    "build":  "tsc",
+                    "prepublishOnly":  "npm run build"
+                },
+    "files":  [
+                  "dist",
+                  "README.md"
+              ],
+    "publishConfig":  {
+                          "registry":  "https://registry.npmjs.org"
+                      },
+    "repository":  {
+                       "type":  "git",
+                       "url":  "https://github.com/AmanorsElliot/credovo-platform.git"
+                   },
+    "keywords":  [
+                     "credovo",
+                     "types",
+                     "typescript"
+                 ],
+    "author":  "",
+    "license":  "UNLICENSED",
+    "devDependencies":  {
+                            "typescript":  "^5.9.3"
+                        }
+}