@decaf-ts/for-http 0.2.1 → 0.2.2

package/lib/axios/axios.d.ts

@@ -3,12 +3,106 @@ import { Axios, AxiosRequestConfig } from "axios";
 import { HttpConfig } from "../types";
 import { AxiosFlags } from "./types";
 import { Context } from "@decaf-ts/db-decorators";
+/**
+ * @description Axios implementation of the HTTP adapter
+ * @summary Concrete implementation of HttpAdapter using Axios as the HTTP client.
+ * This adapter provides CRUD operations for RESTful APIs using Axios for HTTP requests.
+ * @template Axios - The Axios client type
+ * @template AxiosRequestConfig - The Axios request configuration type
+ * @template AxiosFlags - The flags type extending HttpFlags
+ * @template Context<AxiosFlags> - The context type for this adapter
+ * @param {Axios} native - The Axios instance
+ * @param {HttpConfig} config - Configuration for the HTTP adapter
+ * @param {string} [alias] - Optional alias for the adapter
+ * @class
+ * @example
+ * ```typescript
+ * import axios from 'axios';
+ * import { AxiosHttpAdapter } from '@decaf-ts/for-http';
+ *
+ * const config = { protocol: 'https', host: 'api.example.com' };
+ * const adapter = new AxiosHttpAdapter(axios.create(), config);
+ *
+ * // Use the adapter with a repository
+ * const userRepo = adapter.getRepository(User);
+ * const user = await userRepo.findById('123');
+ * ```
+ * @mermaid
+ * sequenceDiagram
+ *   participant Client
+ *   participant AxiosHttpAdapter
+ *   participant Axios
+ *   participant API
+ *
+ *   Client->>AxiosHttpAdapter: create(table, id, data)
+ *   AxiosHttpAdapter->>AxiosHttpAdapter: url(table)
+ *   AxiosHttpAdapter->>Axios: post(url, data)
+ *   Axios->>API: HTTP POST Request
+ *   API-->>Axios: Response
+ *   Axios-->>AxiosHttpAdapter: Response Data
+ *   AxiosHttpAdapter-->>Client: Created Resource
+ *
+ *   Client->>AxiosHttpAdapter: read(table, id)
+ *   AxiosHttpAdapter->>AxiosHttpAdapter: url(table, {id})
+ *   AxiosHttpAdapter->>Axios: get(url)
+ *   Axios->>API: HTTP GET Request
+ *   API-->>Axios: Response
+ *   Axios-->>AxiosHttpAdapter: Response Data
+ *   AxiosHttpAdapter-->>Client: Resource Data
+ */
 export declare class AxiosHttpAdapter extends HttpAdapter<Axios, AxiosRequestConfig, AxiosFlags, Context<AxiosFlags>> {
     constructor(native: Axios, config: HttpConfig, alias?: string);
+    /**
+     * @description Sends an HTTP request using Axios
+     * @summary Implementation of the abstract request method from HttpAdapter.
+     * This method uses the Axios instance to send HTTP requests with the provided configuration.
+     * @template V - The response value type
+     * @param {AxiosRequestConfig} details - The Axios request configuration
+     * @return {Promise<V>} A promise that resolves with the response data
+     */
     request<V>(details: AxiosRequestConfig): Promise<V>;
+    /**
+     * @description Creates a new resource via HTTP POST
+     * @summary Implementation of the abstract create method from HttpAdapter.
+     * This method sends a POST request to the specified endpoint with the model data.
+     * @param {string} tableName - The name of the table or endpoint
+     * @param {string|number} id - The identifier for the resource (not used in URL for POST)
+     * @param {Record<string, any>} model - The data model to create
+     * @return {Promise<Record<string, any>>} A promise that resolves with the created resource
+     */
     create(tableName: string, id: string | number, model: Record<string, any>): Promise<Record<string, any>>;
+    /**
+     * @description Retrieves a resource by ID via HTTP GET
+     * @summary Implementation of the abstract read method from HttpAdapter.
+     * This method sends a GET request to the specified endpoint with the ID as a query parameter.
+     * @param {string} tableName - The name of the table or endpoint
+     * @param {string|number|bigint} id - The identifier for the resource to retrieve
+     * @return {Promise<Record<string, any>>} A promise that resolves with the retrieved resource
+     */
     read(tableName: string, id: string | number | bigint): Promise<Record<string, any>>;
+    /**
+     * @description Updates an existing resource via HTTP PUT
+     * @summary Implementation of the abstract update method from HttpAdapter.
+     * This method sends a PUT request to the specified endpoint with the updated model data.
+     * @param {string} tableName - The name of the table or endpoint
+     * @param {string|number} id - The identifier for the resource (not used in URL for PUT)
+     * @param {Record<string, any>} model - The updated data model
+     * @return {Promise<Record<string, any>>} A promise that resolves with the updated resource
+     */
     update(tableName: string, id: string | number, model: Record<string, any>): Promise<Record<string, any>>;
+    /**
+     * @description Deletes a resource by ID via HTTP DELETE
+     * @summary Implementation of the abstract delete method from HttpAdapter.
+     * This method sends a DELETE request to the specified endpoint with the ID as a query parameter.
+     * @param {string} tableName - The name of the table or endpoint
+     * @param {string|number|bigint} id - The identifier for the resource to delete
+     * @return {Promise<Record<string, any>>} A promise that resolves with the deletion result
+     */
     delete(tableName: string, id: string | number | bigint): Promise<Record<string, any>>;
+    /**
+     * @description Static decoration method for the AxiosHttpAdapter class
+     * @summary Placeholder method for class decoration functionality.
+     * This method is currently empty but can be used for decorator-based configuration.
+     */
     static decoration(): void;
 }

package/lib/axios/constants.cjs

@@ -1,5 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AxiosFlavour = void 0;
+/**
+ * @description Axios adapter flavor identifier
+ * @summary Constant string identifier used to identify the Axios implementation of the HTTP adapter
+ * @const {string} AxiosFlavour
+ * @memberOf module:for-http.axios
+ */
 exports.AxiosFlavour = "axios";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2F4aW9zL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBYSxRQUFBLFlBQVksR0FBRyxPQUFPLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgY29uc3QgQXhpb3NGbGF2b3VyID0gXCJheGlvc1wiO1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2F4aW9zL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7Ozs7R0FLRztBQUNVLFFBQUEsWUFBWSxHQUFHLE9BQU8sQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQGRlc2NyaXB0aW9uIEF4aW9zIGFkYXB0ZXIgZmxhdm9yIGlkZW50aWZpZXJcbiAqIEBzdW1tYXJ5IENvbnN0YW50IHN0cmluZyBpZGVudGlmaWVyIHVzZWQgdG8gaWRlbnRpZnkgdGhlIEF4aW9zIGltcGxlbWVudGF0aW9uIG9mIHRoZSBIVFRQIGFkYXB0ZXJcbiAqIEBjb25zdCB7c3RyaW5nfSBBeGlvc0ZsYXZvdXJcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Zm9yLWh0dHAuYXhpb3NcbiAqL1xuZXhwb3J0IGNvbnN0IEF4aW9zRmxhdm91ciA9IFwiYXhpb3NcIjtcbiJdfQ==

package/lib/axios/constants.d.ts

@@ -1 +1,7 @@
+/**
+ * @description Axios adapter flavor identifier
+ * @summary Constant string identifier used to identify the Axios implementation of the HTTP adapter
+ * @const {string} AxiosFlavour
+ * @memberOf module:for-http.axios
+ */
 export declare const AxiosFlavour = "axios";

package/lib/axios/index.cjs

@@ -15,8 +15,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = require("./axios.cjs");
+/**
+ * @description HTTP client module for REST API interactions
+ * @summary This module provides classes and utilities for interacting with REST APIs.
+ * It exposes repository and service classes for making HTTP requests, along with
+ * type definitions and adapters for different HTTP clients. The module includes
+ * {@link RestRepository} and {@link RestService} for API interactions.
+ * @namespace axios
+ * @memberOf module:for-http
+ */
 axios_1.AxiosHttpAdapter.decoration();
 __exportStar(require("./axios.cjs"), exports);
 __exportStar(require("./constants.cjs"), exports);
 __exportStar(require("./types.cjs"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXhpb3MvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHVDQUEyQztBQUUzQyx3QkFBZ0IsQ0FBQyxVQUFVLEVBQUUsQ0FBQztBQUU5Qiw4Q0FBd0I7QUFDeEIsa0RBQTRCO0FBQzVCLDhDQUF3QiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEF4aW9zSHR0cEFkYXB0ZXIgfSBmcm9tIFwiLi9heGlvc1wiO1xuXG5BeGlvc0h0dHBBZGFwdGVyLmRlY29yYXRpb24oKTtcblxuZXhwb3J0ICogZnJvbSBcIi4vYXhpb3NcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2NvbnN0YW50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vdHlwZXNcIjtcbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXhpb3MvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHVDQUEyQztBQUUzQzs7Ozs7Ozs7R0FRRztBQUVILHdCQUFnQixDQUFDLFVBQVUsRUFBRSxDQUFDO0FBRTlCLDhDQUF3QjtBQUN4QixrREFBNEI7QUFDNUIsOENBQXdCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQXhpb3NIdHRwQWRhcHRlciB9IGZyb20gXCIuL2F4aW9zXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEhUVFAgY2xpZW50IG1vZHVsZSBmb3IgUkVTVCBBUEkgaW50ZXJhY3Rpb25zXG4gKiBAc3VtbWFyeSBUaGlzIG1vZHVsZSBwcm92aWRlcyBjbGFzc2VzIGFuZCB1dGlsaXRpZXMgZm9yIGludGVyYWN0aW5nIHdpdGggUkVTVCBBUElzLlxuICogSXQgZXhwb3NlcyByZXBvc2l0b3J5IGFuZCBzZXJ2aWNlIGNsYXNzZXMgZm9yIG1ha2luZyBIVFRQIHJlcXVlc3RzLCBhbG9uZyB3aXRoXG4gKiB0eXBlIGRlZmluaXRpb25zIGFuZCBhZGFwdGVycyBmb3IgZGlmZmVyZW50IEhUVFAgY2xpZW50cy4gVGhlIG1vZHVsZSBpbmNsdWRlc1xuICoge0BsaW5rIFJlc3RSZXBvc2l0b3J5fSBhbmQge0BsaW5rIFJlc3RTZXJ2aWNlfSBmb3IgQVBJIGludGVyYWN0aW9ucy5cbiAqIEBuYW1lc3BhY2UgYXhpb3NcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Zm9yLWh0dHBcbiAqL1xuXG5BeGlvc0h0dHBBZGFwdGVyLmRlY29yYXRpb24oKTtcblxuZXhwb3J0ICogZnJvbSBcIi4vYXhpb3NcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2NvbnN0YW50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vdHlwZXNcIjtcbiJdfQ==

package/lib/axios/types.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXhpb3MvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEh0dHBGbGFncyB9IGZyb20gXCIuLi90eXBlc1wiO1xuXG5leHBvcnQgdHlwZSBBeGlvc0ZsYWdzID0gSHR0cEZsYWdzO1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXhpb3MvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEh0dHBGbGFncyB9IGZyb20gXCIuLi90eXBlc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBBeGlvcy1zcGVjaWZpYyBIVFRQIGZsYWdzIHR5cGVcbiAqIEBzdW1tYXJ5IFR5cGUgYWxpYXMgZm9yIEh0dHBGbGFncyB1c2VkIHNwZWNpZmljYWxseSB3aXRoIHRoZSBBeGlvcyBhZGFwdGVyIGltcGxlbWVudGF0aW9uXG4gKiBAdHlwZWRlZiB7SHR0cEZsYWdzfSBBeGlvc0ZsYWdzXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1odHRwLmF4aW9zXG4gKi9cbmV4cG9ydCB0eXBlIEF4aW9zRmxhZ3MgPSBIdHRwRmxhZ3M7XG4iXX0=

package/lib/axios/types.d.ts

@@ -1,2 +1,8 @@
 import { HttpFlags } from "../types";
+/**
+ * @description Axios-specific HTTP flags type
+ * @summary Type alias for HttpFlags used specifically with the Axios adapter implementation
+ * @typedef {HttpFlags} AxiosFlags
+ * @memberOf module:for-http.axios
+ */
 export type AxiosFlags = HttpFlags;

package/lib/esm/RestRepository.d.ts

@@ -3,6 +3,35 @@ import { Constructor, Model } from "@decaf-ts/decorator-validation";
 import { HttpAdapter } from "./adapter";
 import { Context } from "@decaf-ts/db-decorators";
 import { HttpFlags } from "./types";
+/**
+ * @description Repository for REST API interactions
+ * @summary A specialized repository implementation for interacting with REST APIs.
+ * This class extends the core Repository class and works with HTTP adapters to
+ * provide CRUD operations for models via REST endpoints.
+ * This Is NOT the default repository for the HTTP adapter. That would be {@link RestService}.
+ * Use this only in the specific case of needing to run the CURD model logic (decoration) before submitting to the backend
+ * @template M - The model type, extending Model
+ * @template Q - The query type used by the adapter
+ * @template A - The HTTP adapter type, extending HttpAdapter
+ * @template F - The HTTP flags type, extending HttpFlags
+ * @template C - The context type, extending Context<F>
+ * @param {A} adapter - The HTTP adapter instance
+ * @param {Constructor<M>} [clazz] - Optional constructor for the model class
+ * @example
+ * ```typescript
+ * // Create a repository for User model with Axios adapter
+ * const axiosAdapter = new AxiosAdapter({
+ *   protocol: 'https',
+ *   host: 'api.example.com'
+ * });
+ * const userRepository = new RestRepository(axiosAdapter, User);
+ *
+ * // Use the repository for CRUD operations
+ * const user = await userRepository.findById('123');
+ * ```
+ * @class RestRepository
+ * @see {@link RestService}
+ */
 export declare class RestRepository<M extends Model, Q, A extends HttpAdapter<any, Q, F, C>, F extends HttpFlags = HttpFlags, C extends Context<F> = Context<F>> extends Repository<M, Q, A> {
     constructor(adapter: A, clazz?: Constructor<M>);
 }

package/lib/esm/RestRepository.js

@@ -1,7 +1,36 @@
 import { Repository } from "@decaf-ts/core";
+/**
+ * @description Repository for REST API interactions
+ * @summary A specialized repository implementation for interacting with REST APIs.
+ * This class extends the core Repository class and works with HTTP adapters to
+ * provide CRUD operations for models via REST endpoints.
+ * This Is NOT the default repository for the HTTP adapter. That would be {@link RestService}.
+ * Use this only in the specific case of needing to run the CURD model logic (decoration) before submitting to the backend
+ * @template M - The model type, extending Model
+ * @template Q - The query type used by the adapter
+ * @template A - The HTTP adapter type, extending HttpAdapter
+ * @template F - The HTTP flags type, extending HttpFlags
+ * @template C - The context type, extending Context<F>
+ * @param {A} adapter - The HTTP adapter instance
+ * @param {Constructor<M>} [clazz] - Optional constructor for the model class
+ * @example
+ * ```typescript
+ * // Create a repository for User model with Axios adapter
+ * const axiosAdapter = new AxiosAdapter({
+ *   protocol: 'https',
+ *   host: 'api.example.com'
+ * });
+ * const userRepository = new RestRepository(axiosAdapter, User);
+ *
+ * // Use the repository for CRUD operations
+ * const user = await userRepository.findById('123');
+ * ```
+ * @class RestRepository
+ * @see {@link RestService}
+ */
 export class RestRepository extends Repository {
     constructor(adapter, clazz) {
         super(adapter, clazz);
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVzdFJlcG9zaXRvcnkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvUmVzdFJlcG9zaXRvcnkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBTTVDLE1BQU0sT0FBTyxjQU1YLFNBQVEsVUFBbUI7SUFDM0IsWUFBWSxPQUFVLEVBQUUsS0FBc0I7UUFDNUMsS0FBSyxDQUFDLE9BQU8sRUFBRSxLQUFLLENBQUMsQ0FBQztJQUN4QixDQUFDO0NBQ0YiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBSZXBvc2l0b3J5IH0gZnJvbSBcIkBkZWNhZi10cy9jb3JlXCI7XG5pbXBvcnQgeyBDb25zdHJ1Y3RvciwgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBIdHRwQWRhcHRlciB9IGZyb20gXCIuL2FkYXB0ZXJcIjtcbmltcG9ydCB7IENvbnRleHQgfSBmcm9tIFwiQGRlY2FmLXRzL2RiLWRlY29yYXRvcnNcIjtcbmltcG9ydCB7IEh0dHBGbGFncyB9IGZyb20gXCIuL3R5cGVzXCI7XG5cbmV4cG9ydCBjbGFzcyBSZXN0UmVwb3NpdG9yeTxcbiAgTSBleHRlbmRzIE1vZGVsLFxuICBRLFxuICBBIGV4dGVuZHMgSHR0cEFkYXB0ZXI8YW55LCBRLCBGLCBDPixcbiAgRiBleHRlbmRzIEh0dHBGbGFncyA9IEh0dHBGbGFncyxcbiAgQyBleHRlbmRzIENvbnRleHQ8Rj4gPSBDb250ZXh0PEY+LFxuPiBleHRlbmRzIFJlcG9zaXRvcnk8TSwgUSwgQT4ge1xuICBjb25zdHJ1Y3RvcihhZGFwdGVyOiBBLCBjbGF6ej86IENvbnN0cnVjdG9yPE0+KSB7XG4gICAgc3VwZXIoYWRhcHRlciwgY2xhenopO1xuICB9XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVzdFJlcG9zaXRvcnkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvUmVzdFJlcG9zaXRvcnkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBTTVDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBNEJHO0FBQ0gsTUFBTSxPQUFPLGNBTVgsU0FBUSxVQUFtQjtJQUMzQixZQUFZLE9BQVUsRUFBRSxLQUFzQjtRQUM1QyxLQUFLLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQ3hCLENBQUM7Q0FDRiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFJlcG9zaXRvcnkgfSBmcm9tIFwiQGRlY2FmLXRzL2NvcmVcIjtcbmltcG9ydCB7IENvbnN0cnVjdG9yLCBNb2RlbCB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IEh0dHBBZGFwdGVyIH0gZnJvbSBcIi4vYWRhcHRlclwiO1xuaW1wb3J0IHsgQ29udGV4dCB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgSHR0cEZsYWdzIH0gZnJvbSBcIi4vdHlwZXNcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gUmVwb3NpdG9yeSBmb3IgUkVTVCBBUEkgaW50ZXJhY3Rpb25zXG4gKiBAc3VtbWFyeSBBIHNwZWNpYWxpemVkIHJlcG9zaXRvcnkgaW1wbGVtZW50YXRpb24gZm9yIGludGVyYWN0aW5nIHdpdGggUkVTVCBBUElzLlxuICogVGhpcyBjbGFzcyBleHRlbmRzIHRoZSBjb3JlIFJlcG9zaXRvcnkgY2xhc3MgYW5kIHdvcmtzIHdpdGggSFRUUCBhZGFwdGVycyB0b1xuICogcHJvdmlkZSBDUlVEIG9wZXJhdGlvbnMgZm9yIG1vZGVscyB2aWEgUkVTVCBlbmRwb2ludHMuXG4gKiBUaGlzIElzIE5PVCB0aGUgZGVmYXVsdCByZXBvc2l0b3J5IGZvciB0aGUgSFRUUCBhZGFwdGVyLiBUaGF0IHdvdWxkIGJlIHtAbGluayBSZXN0U2VydmljZX0uXG4gKiBVc2UgdGhpcyBvbmx5IGluIHRoZSBzcGVjaWZpYyBjYXNlIG9mIG5lZWRpbmcgdG8gcnVuIHRoZSBDVVJEIG1vZGVsIGxvZ2ljIChkZWNvcmF0aW9uKSBiZWZvcmUgc3VibWl0dGluZyB0byB0aGUgYmFja2VuZFxuICogQHRlbXBsYXRlIE0gLSBUaGUgbW9kZWwgdHlwZSwgZXh0ZW5kaW5nIE1vZGVsXG4gKiBAdGVtcGxhdGUgUSAtIFRoZSBxdWVyeSB0eXBlIHVzZWQgYnkgdGhlIGFkYXB0ZXJcbiAqIEB0ZW1wbGF0ZSBBIC0gVGhlIEhUVFAgYWRhcHRlciB0eXBlLCBleHRlbmRpbmcgSHR0cEFkYXB0ZXJcbiAqIEB0ZW1wbGF0ZSBGIC0gVGhlIEhUVFAgZmxhZ3MgdHlwZSwgZXh0ZW5kaW5nIEh0dHBGbGFnc1xuICogQHRlbXBsYXRlIEMgLSBUaGUgY29udGV4dCB0eXBlLCBleHRlbmRpbmcgQ29udGV4dDxGPlxuICogQHBhcmFtIHtBfSBhZGFwdGVyIC0gVGhlIEhUVFAgYWRhcHRlciBpbnN0YW5jZVxuICogQHBhcmFtIHtDb25zdHJ1Y3RvcjxNPn0gW2NsYXp6XSAtIE9wdGlvbmFsIGNvbnN0cnVjdG9yIGZvciB0aGUgbW9kZWwgY2xhc3NcbiAqIEBleGFtcGxlXG4gKiBgYGB0eXBlc2NyaXB0XG4gKiAvLyBDcmVhdGUgYSByZXBvc2l0b3J5IGZvciBVc2VyIG1vZGVsIHdpdGggQXhpb3MgYWRhcHRlclxuICogY29uc3QgYXhpb3NBZGFwdGVyID0gbmV3IEF4aW9zQWRhcHRlcih7XG4gKiAgIHByb3RvY29sOiAnaHR0cHMnLFxuICogICBob3N0OiAnYXBpLmV4YW1wbGUuY29tJ1xuICogfSk7XG4gKiBjb25zdCB1c2VyUmVwb3NpdG9yeSA9IG5ldyBSZXN0UmVwb3NpdG9yeShheGlvc0FkYXB0ZXIsIFVzZXIpO1xuICpcbiAqIC8vIFVzZSB0aGUgcmVwb3NpdG9yeSBmb3IgQ1JVRCBvcGVyYXRpb25zXG4gKiBjb25zdCB1c2VyID0gYXdhaXQgdXNlclJlcG9zaXRvcnkuZmluZEJ5SWQoJzEyMycpO1xuICogYGBgXG4gKiBAY2xhc3MgUmVzdFJlcG9zaXRvcnlcbiAqIEBzZWUge0BsaW5rIFJlc3RTZXJ2aWNlfVxuICovXG5leHBvcnQgY2xhc3MgUmVzdFJlcG9zaXRvcnk8XG4gIE0gZXh0ZW5kcyBNb2RlbCxcbiAgUSxcbiAgQSBleHRlbmRzIEh0dHBBZGFwdGVyPGFueSwgUSwgRiwgQz4sXG4gIEYgZXh0ZW5kcyBIdHRwRmxhZ3MgPSBIdHRwRmxhZ3MsXG4gIEMgZXh0ZW5kcyBDb250ZXh0PEY+ID0gQ29udGV4dDxGPixcbj4gZXh0ZW5kcyBSZXBvc2l0b3J5PE0sIFEsIEE+IHtcbiAgY29uc3RydWN0b3IoYWRhcHRlcjogQSwgY2xheno/OiBDb25zdHJ1Y3RvcjxNPikge1xuICAgIHN1cGVyKGFkYXB0ZXIsIGNsYXp6KTtcbiAgfVxufVxuIl19

package/lib/esm/RestService.d.ts

@@ -3,42 +3,185 @@ import { Constructor, Model } from "@decaf-ts/decorator-validation";
 import { Observable, Observer } from "@decaf-ts/core";
 import { HttpAdapter } from "./adapter";
 import { HttpFlags } from "./types";
+/**
+ * @description Service class for REST API operations
+ * @summary Provides a comprehensive implementation for interacting with REST APIs.
+ * This class implements CRUD operations for single and bulk operations, as well as
+ * the Observable pattern to notify observers of changes. It works with HTTP adapters
+ * to perform the actual API requests and handles model conversion.
+ * @template M - The model type, extending Model
+ * @template Q - The query type used by the adapter
+ * @template A - The HTTP adapter type, extending HttpAdapter
+ * @template F - The HTTP flags type, extending HttpFlags
+ * @template C - The context type, extending Context<F>
+ * @param {A} adapter - The HTTP adapter instance
+ * @param {Constructor<M>} [clazz] - Optional constructor for the model class
+ * @example
+ * ```typescript
+ * // Create a service for User model with Axios adapter
+ * const axiosAdapter = new AxiosAdapter({
+ *   protocol: 'https',
+ *   host: 'api.example.com'
+ * });
+ * const userService = new RestService(axiosAdapter, User);
+ *
+ * // Create a new user
+ * const user = new User({ name: 'John Doe', email: 'john@example.com' });
+ * const createdUser = await userService.create(user);
+ *
+ * // Update a user
+ * createdUser.name = 'Jane Doe';
+ * const updatedUser = await userService.update(createdUser);
+ *
+ * // Delete a user
+ * await userService.delete(updatedUser.id);
+ * ```
+ * @class
+ */
 export declare class RestService<M extends Model, Q, A extends HttpAdapter<any, Q, F, C>, F extends HttpFlags = HttpFlags, C extends Context<F> = Context<F>> implements CrudOperator<M>, BulkCrudOperator<M>, Observable {
     private readonly _class;
     private _pk;
+    /**
+     * @description Gets the model class constructor
+     * @summary Retrieves the model class constructor associated with this service.
+     * Throws an error if no class definition is found.
+     * @return {Constructor<M>} The model class constructor
+     * @throws {InternalError} If no class definition is found
+     */
     get class(): Constructor<M>;
+    /**
+     * @description Gets the primary key property name
+     * @summary Retrieves the name of the primary key property for the model.
+     * If not already determined, it finds the primary key using the model class.
+     * @return The primary key property name
+     */
     get pk(): keyof M;
     protected observers: Observer[];
     private readonly _adapter;
     private _tableName;
+    /**
+     * @description Gets the HTTP adapter
+     * @summary Retrieves the HTTP adapter associated with this service.
+     * Throws an error if no adapter is found.
+     * @return {A} The HTTP adapter instance
+     * @throws {InternalError} If no adapter is found
+     */
     protected get adapter(): A;
+    /**
+     * @description Gets the table name for the model
+     * @summary Retrieves the table name associated with the model class.
+     * If not already determined, it gets the table name from the Repository utility.
+     * @return {string} The table name
+     */
     protected get tableName(): string;
+    /**
+     * @description Initializes a new RestService instance
+     * @summary Creates a new service instance with the specified adapter and optional model class.
+     * The constructor stores the adapter and model class for later use in CRUD operations.
+     * @param {A} adapter - The HTTP adapter instance to use for API requests
+     * @param {Constructor<M>} [clazz] - Optional constructor for the model class
+     */
     constructor(adapter: A, clazz?: Constructor<M>);
+    /**
+     * @description Creates a new resource
+     * @summary Creates a new resource in the REST API using the provided model.
+     * The method prepares the model for the adapter, sends the create request,
+     * and then converts the response back to a model instance.
+     * @param {M} model - The model instance to create
+     * @param {...any[]} args - Additional arguments to pass to the adapter
+     * @return {Promise<M>} A promise that resolves with the created model instance
+     */
     create(model: M, ...args: any[]): Promise<M>;
+    /**
+     * @description Retrieves a resource by ID
+     * @summary Fetches a resource from the REST API using the provided ID.
+     * The method sends the read request and converts the response to a model instance.
+     * @param {string|number} id - The identifier of the resource to retrieve
+     * @param {...any[]} args - Additional arguments to pass to the adapter
+     * @return {Promise<M>} A promise that resolves with the retrieved model instance
+     */
     read(id: string | number, ...args: any[]): Promise<M>;
+    /**
+     * @description Updates an existing resource
+     * @summary Updates an existing resource in the REST API using the provided model.
+     * The method prepares the model for the adapter, sends the update request,
+     * and then converts the response back to a model instance.
+     * @param {M} model - The model instance with updated data
+     * @param {...any[]} args - Additional arguments to pass to the adapter
+     * @return {Promise<M>} A promise that resolves with the updated model instance
+     */
     update(model: M, ...args: any[]): Promise<M>;
+    /**
+     * @description Deletes a resource by ID
+     * @summary Removes a resource from the REST API using the provided ID.
+     * The method sends the delete request and converts the response to a model instance.
+     * @param {string|number} id - The identifier of the resource to delete
+     * @param {...any[]} args - Additional arguments to pass to the adapter
+     * @return {Promise<M>} A promise that resolves with the deleted model instance
+     */
     delete(id: string | number, ...args: any[]): Promise<M>;
+    /**
+     * @description Creates multiple resources
+     * @summary Creates multiple resources in the REST API using the provided models.
+     * The method prepares each model for the adapter, sends a bulk create request,
+     * and then converts the responses back to model instances.
+     * @param {M[]} models - The model instances to create
+     * @param {...any[]} args - Additional arguments to pass to the adapter
+     * @return {Promise<M[]>} A promise that resolves with an array of created model instances
+     */
     createAll(models: M[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Deletes multiple resources by IDs
+     * @summary Removes multiple resources from the REST API using the provided IDs.
+     * The method sends a bulk delete request and converts the responses to model instances.
+     * @param {string[]|number[]} keys - The identifiers of the resources to delete
+     * @param {...any[]} args - Additional arguments to pass to the adapter
+     * @return {Promise<M[]>} A promise that resolves with an array of deleted model instances
+     */
     deleteAll(keys: string[] | number[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Retrieves multiple resources by IDs
+     * @summary Fetches multiple resources from the REST API using the provided IDs.
+     * The method sends a bulk read request and converts the responses to model instances.
+     * @param {string[]|number[]} keys - The identifiers of the resources to retrieve
+     * @param {...any[]} args - Additional arguments to pass to the adapter
+     * @return {Promise<M[]>} A promise that resolves with an array of retrieved model instances
+     */
     readAll(keys: string[] | number[], ...args: any[]): Promise<M[]>;
+    /**
+     * @description Updates multiple resources
+     * @summary Updates multiple resources in the REST API using the provided models.
+     * The method prepares each model for the adapter, sends a bulk update request,
+     * and then converts the responses back to model instances.
+     * @param {M[]} models - The model instances with updated data
+     * @param {...any[]} args - Additional arguments to pass to the adapter
+     * @return {Promise<M[]>} A promise that resolves with an array of updated model instances
+     */
     updateAll(models: M[], ...args: any[]): Promise<M[]>;
     /**
-     * @summary Registers an {@link Observer}
-     * @param {Observer} observer
-     *
-     * @see {Observable#observe}
+     * @description Registers an observer
+     * @summary Adds an observer to the list of observers that will be notified of changes.
+     * Throws an error if the observer is already registered.
+     * @param {Observer} observer - The observer to register
+     * @return {void}
+     * @throws {InternalError} If the observer is already registered
      */
     observe(observer: Observer): void;
     /**
-     * @summary Unregisters an {@link Observer}
-     * @param {Observer} observer
-     *
-     * @see {Observable#unObserve}
+     * @description Unregisters an observer
+     * @summary Removes an observer from the list of observers.
+     * Throws an error if the observer is not found.
+     * @param {Observer} observer - The observer to unregister
+     * @return {void}
+     * @throws {InternalError} If the observer is not found
      */
     unObserve(observer: Observer): void;
     /**
-     * @summary calls all registered {@link Observer}s to update themselves
-     * @param {any[]} [args] optional arguments to be passed to the {@link Observer#refresh} method
+     * @description Notifies all registered observers
+     * @summary Calls the refresh method on all registered observers to update themselves.
+     * Any errors during observer refresh are logged as warnings but don't stop the process.
+     * @param {...any[]} [args] - Optional arguments to pass to the observer refresh method
+     * @return {Promise<void>} A promise that resolves when all observers have been updated
      */
     updateObservers(...args: any[]): Promise<void>;
 }