@zauto/api-connector 0.0.1

package/README.md

@@ -0,0 +1,208 @@
+# API Connector Package
+
+A dynamic and flexible TypeScript-based API connector package designed to facilitate seamless integration between a local database and external APIs. The package includes features like dynamic field mapping, endpoint configuration, and robust authentication support.
+
+## Features
+
+- **Dynamic API Configuration**: Manage API settings like base URL, authentication, and headers dynamically.
+- **Endpoint Management**: Configure endpoints with methods, headers, and field mappings.
+- **Field Mapping**: Dynamically map request and response fields for six resources: `Patient`, `Physician`, `Facility`, `Schedule`, `Slot`, and `Appointment`.
+- **Authentication**: Supports multiple authentication types (`BASIC`, `BEARER`, `API_KEY`, or `NONE`).
+- **Retry and Timeout Policies**: Define retry strategies and request timeouts for robust communication.
+- **Prisma Integration**: Leverages Prisma for database interactions with models such as `ApiConfig`, `EndpointConfig`, and `FieldMapping`.
+
+---
+
+## Installation
+
+Install the package using npm:
+
+```bash
+npm install <package-name>
+```
+
+---
+
+## Database Design
+
+### Models
+
+- **ApiConfig**: Stores the top-level configuration for APIs.
+- **EndpointConfig**: Manages endpoint-specific configurations linked to an API.
+- **FieldMapping**: Handles request and response field mappings for endpoints.
+
+### Example Schema
+
+```prisma
+model ApiConfig {
+  id              String           @id @default(uuid())
+  baseUrl         String
+  authType        String
+  infoForAuthType Json             @default("{}")
+  defaultHeaders  Json             @default("{}")
+  timeout         Int?
+  environment     String?
+  retryPolicy     Json             @default("{}")
+  orgId           String?
+  doneBy          String?
+  createdAt       DateTime         @default(now())
+  updatedAt       DateTime         @updatedAt
+  endpoints       EndpointConfig[]
+}
+
+model EndpointConfig {
+  id           String         @id @default(uuid())
+  name         String
+  method       String
+  suburl       String
+  headers      Json           @default("{}")
+  createdAt    DateTime       @default(now())
+  updatedAt    DateTime       @updatedAt
+  apiConfigId  String
+  apiConfig    ApiConfig      @relation(fields: [apiConfigId], references: [id])
+  FieldMapping FieldMapping[]
+
+  @@unique([name, apiConfigId])
+}
+
+model FieldMapping {
+  id              String         @id @default(uuid())
+  resourceType    ResourceType
+  requestMapping  Json?
+  responseMapping Json?
+  createdAt       DateTime       @default(now())
+  updatedAt       DateTime       @updatedAt
+  endpointId      String
+  endpoint        EndpointConfig @relation(fields: [endpointId], references: [id])
+}
+
+enum ResourceType {
+  Patient
+  Physician
+  Facility
+  Schedule
+  Slot
+  Appointment
+}
+```
+
+---
+
+## Usage
+
+### API Configuration
+
+Use `saveApiConfig` to save or update API configurations dynamically:
+
+```typescript
+import { PrismaClient } from '@prisma/client';
+import { saveApiConfig } from '<package-name>';
+
+const prisma = new PrismaClient();
+
+const apiConfig = {
+  baseUrl: 'https://api.example.com',
+  authType: 'BEARER',
+  infoForAuthType: { token: 'your-token' },
+};
+
+const result = await saveApiConfig(prisma, apiConfig, { orgId: '123' });
+console.log(result);
+```
+
+### Endpoint Configuration
+
+Save or update endpoint configurations linked to an API configuration:
+
+```typescript
+import { saveEndpointConfig } from '<package-name>';
+
+const endpointConfig = {
+  name: 'getPatients',
+  method: 'GET',
+  suburl: '/patients',
+  apiConfigId: 'api-config-id',
+};
+
+const result = await saveEndpointConfig(prisma, endpointConfig);
+console.log(result);
+```
+
+### Field Mapping
+
+Configure dynamic mappings for request and response data:
+
+```typescript
+import { saveFieldMapping } from '<package-name>';
+
+const fieldMapping = {
+  resourceType: 'Patient',
+  requestMapping: { localField1: 'apiField1', localField2: 'apiField2' },
+  responseMapping: { apiField1: 'localField1', apiField2: 'localField2' },
+  endpointId: 'endpoint-id',
+};
+
+const result = await saveFieldMapping(prisma, fieldMapping);
+console.log(result);
+```
+
+### API Call with Dynamic Mapping
+
+Make API calls with dynamic field mapping applied to request and response data:
+
+```typescript
+import { callApiWithMapping } from '<package-name>';
+
+const response = await callApiWithMapping(prisma, 'endpoint-id', {
+  localField1: 'value1',
+});
+console.log(response);
+```
+
+---
+
+## Authentication Types
+
+- **BASIC**: Username and password authentication.
+- **BEARER**: Token-based authentication.
+- **API_KEY**: API key authentication.
+- **NONE**: No authentication.
+
+---
+
+## Development
+
+### Directory Structure
+
+```plaintext
+/src
+  /dto
+    api-config.dto.ts
+    endpoint-config.dto.ts
+    field-mapping.dto.ts
+  index.ts
+```
+
+### Exported Functions
+
+- `saveApiConfig`
+- `updateApiConfig`
+- `saveEndpointConfig`
+- `saveFieldMapping`
+- `callApiWithMapping`
+
+---
+
+## Contributing
+
+Contributions are welcome! Submit issues or pull requests on GitHub.
+
+---
+
+## License
+
+[MIT License](LICENSE)
+
+---
+
+Let me know if there are additional details or changes you'd like to make!

package/dist/dto/api-config.dto.d.ts

@@ -0,0 +1,24 @@
+export declare enum AuthType {
+    NONE = "none",
+    BASIC = "basic",
+    BEARER = "bearer",
+    API_KEY = "apiKey"
+}
+export declare class AuthCredentialsDto {
+    username?: string;
+    password?: string;
+    token?: string;
+    apiKey?: string;
+}
+export declare class RetryPolicyDto {
+    maxRetries?: number;
+    retryDelayMs?: number;
+    retryOnStatusCodes?: string[];
+}
+export declare class ApiConfigDto {
+    baseUrl: string;
+    authType: AuthType;
+    infoForAuthType?: AuthCredentialsDto;
+    timeout?: number;
+    retryPolicy?: RetryPolicyDto;
+}

package/dist/dto/api-config.dto.js

@@ -0,0 +1,94 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiConfigDto = exports.RetryPolicyDto = exports.AuthCredentialsDto = exports.AuthType = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+var AuthType;
+(function (AuthType) {
+    AuthType["NONE"] = "none";
+    AuthType["BASIC"] = "basic";
+    AuthType["BEARER"] = "bearer";
+    AuthType["API_KEY"] = "apiKey";
+})(AuthType || (exports.AuthType = AuthType = {}));
+class AuthCredentialsDto {
+}
+exports.AuthCredentialsDto = AuthCredentialsDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], AuthCredentialsDto.prototype, "username", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], AuthCredentialsDto.prototype, "password", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], AuthCredentialsDto.prototype, "token", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], AuthCredentialsDto.prototype, "apiKey", void 0);
+class RetryPolicyDto {
+}
+exports.RetryPolicyDto = RetryPolicyDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(0),
+    __metadata("design:type", Number)
+], RetryPolicyDto.prototype, "maxRetries", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_1.Min)(0),
+    __metadata("design:type", Number)
+], RetryPolicyDto.prototype, "retryDelayMs", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)({ each: true }),
+    __metadata("design:type", Array)
+], RetryPolicyDto.prototype, "retryOnStatusCodes", void 0);
+class ApiConfigDto {
+}
+exports.ApiConfigDto = ApiConfigDto;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], ApiConfigDto.prototype, "baseUrl", void 0);
+__decorate([
+    (0, class_validator_1.IsEnum)(AuthType),
+    __metadata("design:type", String)
+], ApiConfigDto.prototype, "authType", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => AuthCredentialsDto),
+    __metadata("design:type", AuthCredentialsDto)
+], ApiConfigDto.prototype, "infoForAuthType", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_1.Min)(0),
+    __metadata("design:type", Number)
+], ApiConfigDto.prototype, "timeout", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => RetryPolicyDto),
+    __metadata("design:type", RetryPolicyDto)
+], ApiConfigDto.prototype, "retryPolicy", void 0);
+//# sourceMappingURL=api-config.dto.js.map

package/dist/dto/api-config.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-config.dto.js","sourceRoot":"","sources":["../../src/dto/api-config.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA+G;AAC/G,yDAAyC;AAKzC,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,8BAAkB,CAAA;AACpB,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB;AAKD,MAAa,kBAAkB;CA4B9B;AA5BD,gDA4BC;AAtBC;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;oDACO;AAOlB;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;oDACO;AAOlB;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;iDACI;AAOf;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;kDACK;AAMlB,MAAa,cAAc;CAuB1B;AAvBD,wCAuBC;AAhBC;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;;kDACa;AAQpB;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,qBAAG,EAAC,CAAC,CAAC;;oDACe;AAOtB;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;0DACK;AAMhC,MAAa,YAAY;CAqCxB;AArCD,oCAqCC;AA/BC;IADC,IAAA,0BAAQ,GAAE;;6CACK;AAMhB;IADC,IAAA,wBAAM,EAAC,QAAQ,CAAC;;8CACE;AAQnB;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,gCAAc,GAAE;IAChB,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC;8BACb,kBAAkB;qDAAC;AAQrC;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,qBAAG,EAAC,CAAC,CAAC;;6CACU;AAQjB;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,gCAAc,GAAE;IAChB,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,cAAc,CAAC;8BACb,cAAc;iDAAC"}

package/dist/dto/endpoint-config.dto.d.ts

@@ -0,0 +1,7 @@
+export declare class EndpointConfigDto {
+    name: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    suburl: string;
+    headers?: Record<string, string>;
+    apiConfigId: string;
+}

package/dist/dto/endpoint-config.dto.js

@@ -0,0 +1,39 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EndpointConfigDto = void 0;
+const class_validator_1 = require("class-validator");
+class EndpointConfigDto {
+}
+exports.EndpointConfigDto = EndpointConfigDto;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], EndpointConfigDto.prototype, "name", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsIn)(['GET', 'POST', 'PUT', 'DELETE']),
+    __metadata("design:type", String)
+], EndpointConfigDto.prototype, "method", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], EndpointConfigDto.prototype, "suburl", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], EndpointConfigDto.prototype, "headers", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], EndpointConfigDto.prototype, "apiConfigId", void 0);
+//# sourceMappingURL=endpoint-config.dto.js.map

package/dist/dto/endpoint-config.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoint-config.dto.js","sourceRoot":"","sources":["../../src/dto/endpoint-config.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA8E;AAK9E,MAAa,iBAAiB;CAiB7B;AAjBD,8CAiBC;AAfC;IADC,IAAA,0BAAQ,GAAE;;+CACE;AAIb;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,sBAAI,EAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;;iDACG;AAG1C;IADC,IAAA,0BAAQ,GAAE;;iDACI;AAIf;IAFC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;kDACsB;AAGjC;IADC,IAAA,0BAAQ,GAAE;;sDACS"}

package/dist/dto/field-mapping.dto.d.ts

@@ -0,0 +1,7 @@
+import { ResourceType } from 'src/enums/resources.enum';
+export declare class FieldMappingDto {
+    resourceType: ResourceType;
+    requestMapping?: Record<string, string>;
+    responseMapping?: Record<string, string>;
+    endpointId: string;
+}

package/dist/dto/field-mapping.dto.js

@@ -0,0 +1,34 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldMappingDto = void 0;
+const class_validator_1 = require("class-validator");
+const resources_enum_1 = require("../enums/resources.enum");
+class FieldMappingDto {
+}
+exports.FieldMappingDto = FieldMappingDto;
+__decorate([
+    (0, class_validator_1.IsEnum)(resources_enum_1.ResourceType),
+    __metadata("design:type", String)
+], FieldMappingDto.prototype, "resourceType", void 0);
+__decorate([
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], FieldMappingDto.prototype, "requestMapping", void 0);
+__decorate([
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], FieldMappingDto.prototype, "responseMapping", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], FieldMappingDto.prototype, "endpointId", void 0);
+//# sourceMappingURL=field-mapping.dto.js.map

package/dist/dto/field-mapping.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-mapping.dto.js","sourceRoot":"","sources":["../../src/dto/field-mapping.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAoE;AACpE,4DAAwD;AAKxD,MAAa,eAAe;CAY3B;AAZD,0CAYC;AAVC;IADC,IAAA,wBAAM,EAAC,6BAAY,CAAC;;qDACM;AAG3B;IADC,IAAA,0BAAQ,GAAE;;uDAC6B;AAGxC;IADC,IAAA,0BAAQ,GAAE;;wDAC8B;AAGzC;IADC,IAAA,0BAAQ,GAAE;;mDACQ"}

package/dist/enums/resources.enum.d.ts

@@ -0,0 +1,8 @@
+export declare enum ResourceType {
+    Patient = "Patient",
+    Physician = "Physician",
+    Facility = "Facility",
+    Schedule = "Schedule",
+    Slot = "Slot",
+    Appointment = "Appointment"
+}

package/dist/enums/resources.enum.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceType = void 0;
+var ResourceType;
+(function (ResourceType) {
+    ResourceType["Patient"] = "Patient";
+    ResourceType["Physician"] = "Physician";
+    ResourceType["Facility"] = "Facility";
+    ResourceType["Schedule"] = "Schedule";
+    ResourceType["Slot"] = "Slot";
+    ResourceType["Appointment"] = "Appointment";
+})(ResourceType || (exports.ResourceType = ResourceType = {}));
+//# sourceMappingURL=resources.enum.js.map

package/dist/enums/resources.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.enum.js","sourceRoot":"","sources":["../../src/enums/resources.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAOT;AAPH,WAAY,YAAY;IACpB,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;IACrB,qCAAqB,CAAA;IACrB,6BAAa,CAAA;IACb,2CAA2B,CAAA;AAC7B,CAAC,EAPS,YAAY,4BAAZ,YAAY,QAOrB"}

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { PrismaClient } from '@prisma/client';
+import { ApiConfigDto } from './dto/api-config.dto';
+import { EndpointConfigDto } from './dto/endpoint-config.dto';
+import { FieldMappingDto } from './dto/field-mapping.dto';
+export declare function saveApiConfig(prisma: PrismaClient, apiConfig: ApiConfigDto, additionalParams?: Record<string, any>, searchCriteria?: Record<string, any>): Promise<{
+    operation: string;
+    config: any;
+}>;
+export declare function updateApiConfig(prisma: PrismaClient, updateData: Partial<ApiConfigDto> & Record<string, any>, searchCriteria: Record<string, any>): Promise<any>;
+export declare function saveEndpointConfig(prisma: PrismaClient, endpointConfig: EndpointConfigDto): Promise<{
+    message: string;
+    config: any;
+    operation?: undefined;
+} | {
+    operation: string;
+    config: any;
+    message?: undefined;
+}>;
+export declare function updateEndpointConfig(prisma: PrismaClient, endpointId: string, updateData: Partial<EndpointConfigDto>): Promise<{
+    operation: string;
+    config: any;
+}>;
+export declare function saveFieldMapping(prisma: PrismaClient, fieldMapping: FieldMappingDto): Promise<{
+    message: string;
+    operation?: undefined;
+    mapping?: undefined;
+} | {
+    operation: string;
+    mapping: any;
+    message?: undefined;
+}>;
+export declare function updateFieldMapping(prisma: PrismaClient, fieldMappingId: string, updateData: Partial<FieldMappingDto>): Promise<{
+    operation: string;
+    mapping: any;
+}>;
+export declare function callApiWithMapping(prisma: PrismaClient, endpointId: string, data?: Record<string, any>, queryParams?: Record<string, any>, pathParams?: string, subUrl?: string): Promise<any>;
+export declare function executeDynamicFunction(prisma: PrismaClient, orgId: string, functionName: string, input: Record<string, any>): Promise<Record<string, any>>;
+export { ApiConfigDto } from './dto/api-config.dto';
+export { AuthType } from './dto/api-config.dto';