@deliverart/sdk-js-core 0.0.7 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @deliverart/sdk-js-core
 
+## 0.1.1
+
+### Patch Changes
+
+- 20b57df: Expose errors
+
+## 0.1.0
+
+### Minor Changes
+
+- dd33eb4: Implement Request Response call
+
 ## 0.0.7
 
 ### Patch Changes

package/dist/index.cjs

@@ -30,16 +30,92 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  AbstractApiRequest: () => AbstractApiRequest,
+  InputValidationError: () => InputValidationError,
+  OutputValidationError: () => OutputValidationError,
   createApiClient: () => createApiClient
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/ApiClient.ts
 var import_axios = __toESM(require("axios"), 1);
+
+// src/errors.ts
+var InputValidationError = class extends Error {
+  // eslint-disable-next-line no-unused-vars
+  constructor(issues) {
+    super("Invalid input");
+    this.issues = issues;
+    this.name = "InputValidationError";
+  }
+};
+var OutputValidationError = class extends Error {
+  // eslint-disable-next-line no-unused-vars
+  constructor(issues) {
+    super("Invalid response");
+    this.issues = issues;
+    this.name = "OutputValidationError";
+  }
+};
+
+// src/ApiClient.ts
+var AbstractApiRequest = class {
+  constructor(input, options) {
+    this.input = input;
+    this.options = options;
+  }
+  validateInput() {
+    const result = this.inputSchema.safeParse(this.input);
+    if (!result.success) {
+      throw new InputValidationError(result.error.issues);
+    }
+    return result.data;
+  }
+  validateQuery() {
+    if (!this.querySchema || !this.options?.query) return void 0;
+    const result = this.querySchema.safeParse(this.options.query);
+    if (!result.success) {
+      throw new InputValidationError(result.error.issues);
+    }
+    return result.data;
+  }
+  validateHeaders() {
+    if (!this.headersSchema || !this.options?.headers) return void 0;
+    const result = this.headersSchema.safeParse(this.options.headers);
+    if (!result.success) {
+      throw new InputValidationError(result.error.issues);
+    }
+    return result.data;
+  }
+  validateOutput(data) {
+    const result = this.outputSchema.safeParse(data);
+    if (!result.success) {
+      throw new OutputValidationError(result.error.issues);
+    }
+    return result.data;
+  }
+};
 function createApiClient(config) {
   const http = import_axios.default.create({ baseURL: config.baseUrl });
   const base = {
     http,
+    async call(request) {
+      const input = request.validateInput();
+      const query = request.validateQuery();
+      const headers = request.validateHeaders();
+      const res = await http.request({
+        url: request.getPath(),
+        method: request.method,
+        headers: {
+          "Content-Type": request.contentType,
+          Accept: request.accept,
+          ...headers ?? {}
+        },
+        params: query,
+        data: request.method !== "GET" ? input : void 0
+      });
+      return request.validateOutput(res.data);
+    },
     addPlugin(plugin) {
       const extension = plugin.setup(this);
       return { ...this, ...extension };
@@ -49,5 +125,8 @@ function createApiClient(config) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  AbstractApiRequest,
+  InputValidationError,
+  OutputValidationError,
   createApiClient
 });

package/dist/index.d.cts

@@ -1,17 +1,51 @@
 import { AxiosInstance } from 'axios';
+import { ZodSchema, ZodIssue } from 'zod';
 
 type ApiExtension = Record<string, unknown>;
 interface ApiClientPlugin<T extends ApiExtension = Record<string, unknown>> {
     setup: (client: ApiClient<Record<string, unknown>>) => T;
 }
 
-declare function createApiClient<Extensions extends ApiExtension = NonNullable<unknown>>(config: {
-    baseUrl: string;
-}): ApiClient<Extensions>;
+declare abstract class AbstractApiRequest<Input, Output, Query = unknown, Headers = unknown> {
+    readonly input: Input;
+    readonly options?: {
+        query?: Query;
+        headers?: Headers;
+    } | undefined;
+    abstract readonly method: 'GET' | 'POST' | 'PATCH' | 'DELETE';
+    abstract readonly contentType: 'application/json' | 'multipart/form-data' | 'application/merge-patch+json';
+    abstract readonly accept: 'application/json';
+    abstract readonly inputSchema: ZodSchema<Input>;
+    abstract readonly outputSchema: ZodSchema<Output>;
+    abstract readonly querySchema?: ZodSchema<Query>;
+    abstract readonly headersSchema?: ZodSchema<Headers>;
+    protected constructor(input: Input, options?: {
+        query?: Query;
+        headers?: Headers;
+    } | undefined);
+    abstract getPath(): string;
+    validateInput(): Input;
+    validateQuery(): Query | undefined;
+    validateHeaders(): Headers | undefined;
+    validateOutput(data: unknown): Output;
+}
 interface ApiClientBase {
     http: AxiosInstance;
     addPlugin: <T extends ApiExtension>(plugin: ApiClientPlugin<T>) => ApiClient<T>;
+    call<I, O, Q, H>(request: AbstractApiRequest<I, O, Q, H>): Promise<O>;
 }
+declare function createApiClient<Extensions extends ApiExtension = NonNullable<unknown>>(config: {
+    baseUrl: string;
+}): ApiClient<Extensions>;
 type ApiClient<Extensions extends ApiExtension = NonNullable<unknown>> = ApiClientBase & Extensions;
 
-export { type ApiClient, type ApiClientPlugin, type ApiExtension, createApiClient };
+declare class InputValidationError extends Error {
+    readonly issues: ZodIssue[];
+    constructor(issues: ZodIssue[]);
+}
+declare class OutputValidationError extends Error {
+    readonly issues: ZodIssue[];
+    constructor(issues: ZodIssue[]);
+}
+
+export { AbstractApiRequest, type ApiClient, type ApiClientPlugin, type ApiExtension, InputValidationError, OutputValidationError, createApiClient };

package/dist/index.d.ts

@@ -1,17 +1,51 @@
 import { AxiosInstance } from 'axios';
+import { ZodSchema, ZodIssue } from 'zod';
 
 type ApiExtension = Record<string, unknown>;
 interface ApiClientPlugin<T extends ApiExtension = Record<string, unknown>> {
     setup: (client: ApiClient<Record<string, unknown>>) => T;
 }
 
-declare function createApiClient<Extensions extends ApiExtension = NonNullable<unknown>>(config: {
-    baseUrl: string;
-}): ApiClient<Extensions>;
+declare abstract class AbstractApiRequest<Input, Output, Query = unknown, Headers = unknown> {
+    readonly input: Input;
+    readonly options?: {
+        query?: Query;
+        headers?: Headers;
+    } | undefined;
+    abstract readonly method: 'GET' | 'POST' | 'PATCH' | 'DELETE';
+    abstract readonly contentType: 'application/json' | 'multipart/form-data' | 'application/merge-patch+json';
+    abstract readonly accept: 'application/json';
+    abstract readonly inputSchema: ZodSchema<Input>;
+    abstract readonly outputSchema: ZodSchema<Output>;
+    abstract readonly querySchema?: ZodSchema<Query>;
+    abstract readonly headersSchema?: ZodSchema<Headers>;
+    protected constructor(input: Input, options?: {
+        query?: Query;
+        headers?: Headers;
+    } | undefined);
+    abstract getPath(): string;
+    validateInput(): Input;
+    validateQuery(): Query | undefined;
+    validateHeaders(): Headers | undefined;
+    validateOutput(data: unknown): Output;
+}
 interface ApiClientBase {
     http: AxiosInstance;
     addPlugin: <T extends ApiExtension>(plugin: ApiClientPlugin<T>) => ApiClient<T>;
+    call<I, O, Q, H>(request: AbstractApiRequest<I, O, Q, H>): Promise<O>;
 }
+declare function createApiClient<Extensions extends ApiExtension = NonNullable<unknown>>(config: {
+    baseUrl: string;
+}): ApiClient<Extensions>;
 type ApiClient<Extensions extends ApiExtension = NonNullable<unknown>> = ApiClientBase & Extensions;
 
-export { type ApiClient, type ApiClientPlugin, type ApiExtension, createApiClient };
+declare class InputValidationError extends Error {
+    readonly issues: ZodIssue[];
+    constructor(issues: ZodIssue[]);
+}
+declare class OutputValidationError extends Error {
+    readonly issues: ZodIssue[];
+    constructor(issues: ZodIssue[]);
+}
+
+export { AbstractApiRequest, type ApiClient, type ApiClientPlugin, type ApiExtension, InputValidationError, OutputValidationError, createApiClient };

package/dist/index.js

@@ -1,9 +1,82 @@
 // src/ApiClient.ts
 import axios from "axios";
+
+// src/errors.ts
+var InputValidationError = class extends Error {
+  // eslint-disable-next-line no-unused-vars
+  constructor(issues) {
+    super("Invalid input");
+    this.issues = issues;
+    this.name = "InputValidationError";
+  }
+};
+var OutputValidationError = class extends Error {
+  // eslint-disable-next-line no-unused-vars
+  constructor(issues) {
+    super("Invalid response");
+    this.issues = issues;
+    this.name = "OutputValidationError";
+  }
+};
+
+// src/ApiClient.ts
+var AbstractApiRequest = class {
+  constructor(input, options) {
+    this.input = input;
+    this.options = options;
+  }
+  validateInput() {
+    const result = this.inputSchema.safeParse(this.input);
+    if (!result.success) {
+      throw new InputValidationError(result.error.issues);
+    }
+    return result.data;
+  }
+  validateQuery() {
+    if (!this.querySchema || !this.options?.query) return void 0;
+    const result = this.querySchema.safeParse(this.options.query);
+    if (!result.success) {
+      throw new InputValidationError(result.error.issues);
+    }
+    return result.data;
+  }
+  validateHeaders() {
+    if (!this.headersSchema || !this.options?.headers) return void 0;
+    const result = this.headersSchema.safeParse(this.options.headers);
+    if (!result.success) {
+      throw new InputValidationError(result.error.issues);
+    }
+    return result.data;
+  }
+  validateOutput(data) {
+    const result = this.outputSchema.safeParse(data);
+    if (!result.success) {
+      throw new OutputValidationError(result.error.issues);
+    }
+    return result.data;
+  }
+};
 function createApiClient(config) {
   const http = axios.create({ baseURL: config.baseUrl });
   const base = {
     http,
+    async call(request) {
+      const input = request.validateInput();
+      const query = request.validateQuery();
+      const headers = request.validateHeaders();
+      const res = await http.request({
+        url: request.getPath(),
+        method: request.method,
+        headers: {
+          "Content-Type": request.contentType,
+          Accept: request.accept,
+          ...headers ?? {}
+        },
+        params: query,
+        data: request.method !== "GET" ? input : void 0
+      });
+      return request.validateOutput(res.data);
+    },
     addPlugin(plugin) {
       const extension = plugin.setup(this);
       return { ...this, ...extension };
@@ -12,5 +85,8 @@ function createApiClient(config) {
   return base;
 }
 export {
+  AbstractApiRequest,
+  InputValidationError,
+  OutputValidationError,
   createApiClient
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@deliverart/sdk-js-core",
   "description": "Core SDK for DeliverArt, providing essential functionalities and utilities.",
-  "version": "0.0.7",
+  "version": "0.1.1",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,8 @@
     }
   },
   "dependencies": {
-    "axios": "1.9.0"
+    "axios": "1.9.0",
+    "zod": "3.25.67"
   },
   "devDependencies": {
     "@changesets/cli": "^2.29.4",

package/src/ApiClient.ts

@@ -1,7 +1,78 @@
 import axios, { AxiosInstance } from 'axios'
+import { ZodSchema } from 'zod'
 
+import { InputValidationError, OutputValidationError } from './errors'
 import type { ApiClientPlugin, ApiExtension } from './types'
 
+export abstract class AbstractApiRequest<Input, Output, Query = unknown, Headers = unknown> {
+  abstract readonly method: 'GET' | 'POST' | 'PATCH' | 'DELETE'
+  abstract readonly contentType:
+    | 'application/json'
+    | 'multipart/form-data'
+    | 'application/merge-patch+json'
+  abstract readonly accept: 'application/json'
+  abstract readonly inputSchema: ZodSchema<Input>
+  abstract readonly outputSchema: ZodSchema<Output>
+  abstract readonly querySchema?: ZodSchema<Query>
+  abstract readonly headersSchema?: ZodSchema<Headers>
+
+  protected constructor(
+    // eslint-disable-next-line no-unused-vars
+    public readonly input: Input,
+    // eslint-disable-next-line no-unused-vars
+    public readonly options?: {
+      query?: Query
+      headers?: Headers
+    },
+  ) {}
+
+  abstract getPath(): string
+
+  validateInput(): Input {
+    const result = this.inputSchema.safeParse(this.input)
+    if (!result.success) {
+      throw new InputValidationError(result.error.issues)
+    }
+    return result.data
+  }
+
+  validateQuery(): Query | undefined {
+    if (!this.querySchema || !this.options?.query) return undefined
+
+    const result = this.querySchema.safeParse(this.options.query)
+    if (!result.success) {
+      throw new InputValidationError(result.error.issues)
+    }
+    return result.data
+  }
+
+  validateHeaders(): Headers | undefined {
+    if (!this.headersSchema || !this.options?.headers) return undefined
+
+    const result = this.headersSchema.safeParse(this.options.headers)
+    if (!result.success) {
+      throw new InputValidationError(result.error.issues)
+    }
+    return result.data
+  }
+
+  validateOutput(data: unknown): Output {
+    const result = this.outputSchema.safeParse(data)
+    if (!result.success) {
+      throw new OutputValidationError(result.error.issues)
+    }
+    return result.data
+  }
+}
+
+interface ApiClientBase {
+  http: AxiosInstance
+  // eslint-disable-next-line no-unused-vars
+  addPlugin: <T extends ApiExtension>(plugin: ApiClientPlugin<T>) => ApiClient<T>
+  // eslint-disable-next-line no-unused-vars
+  call<I, O, Q, H>(request: AbstractApiRequest<I, O, Q, H>): Promise<O>
+}
+
 export function createApiClient<Extensions extends ApiExtension = NonNullable<unknown>>(config: {
   baseUrl: string
 }): ApiClient<Extensions> {
@@ -9,6 +80,27 @@ export function createApiClient<Extensions extends ApiExtension = NonNullable<un
 
   const base: ApiClientBase = {
     http,
+
+    async call<I, O, Q, H>(request: AbstractApiRequest<I, O, Q, H>): Promise<O> {
+      const input = request.validateInput()
+      const query = request.validateQuery()
+      const headers = request.validateHeaders()
+
+      const res = await http.request({
+        url: request.getPath(),
+        method: request.method,
+        headers: {
+          'Content-Type': request.contentType,
+          Accept: request.accept,
+          ...(headers ?? {}),
+        },
+        params: query,
+        data: request.method !== 'GET' ? input : undefined,
+      })
+
+      return request.validateOutput(res.data)
+    },
+
     addPlugin<T extends ApiExtension>(plugin: ApiClientPlugin<T>) {
       const extension = plugin.setup(this as ApiClient<Extensions & T>)
       return { ...this, ...extension } as ApiClient<Extensions & T>
@@ -18,11 +110,5 @@ export function createApiClient<Extensions extends ApiExtension = NonNullable<un
   return base as ApiClient<Extensions>
 }
 
-interface ApiClientBase {
-  http: AxiosInstance
-  // eslint-disable-next-line no-unused-vars
-  addPlugin: <T extends ApiExtension>(plugin: ApiClientPlugin<T>) => ApiClient<T>
-}
-
 export type ApiClient<Extensions extends ApiExtension = NonNullable<unknown>> = ApiClientBase &
   Extensions

package/src/errors.ts

@@ -0,0 +1,17 @@
+import { ZodIssue } from 'zod'
+
+export class InputValidationError extends Error {
+  // eslint-disable-next-line no-unused-vars
+  constructor(public readonly issues: ZodIssue[]) {
+    super('Invalid input')
+    this.name = 'InputValidationError'
+  }
+}
+
+export class OutputValidationError extends Error {
+  // eslint-disable-next-line no-unused-vars
+  constructor(public readonly issues: ZodIssue[]) {
+    super('Invalid response')
+    this.name = 'OutputValidationError'
+  }
+}

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './ApiClient'
+export * from './errors'
 export * from './types'