@decaf-ts/for-http 0.2.1 → 0.2.3

package/lib/index.cjs

@@ -15,9 +15,22 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
+/**
+ * @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.
+ * @module for-http
+ */
 __exportStar(require("./adapter.cjs"), exports);
 __exportStar(require("./RestRepository.cjs"), exports);
 __exportStar(require("./RestService.cjs"), exports);
 __exportStar(require("./types.cjs"), exports);
-exports.VERSION = "0.2.1";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxnREFBMEI7QUFDMUIsdURBQWlDO0FBQ2pDLG9EQUE4QjtBQUM5Qiw4Q0FBd0I7QUFFWCxRQUFBLE9BQU8sR0FBRyxhQUFhLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tIFwiLi9hZGFwdGVyXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SZXN0UmVwb3NpdG9yeVwiO1xuZXhwb3J0ICogZnJvbSBcIi4vUmVzdFNlcnZpY2VcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3R5cGVzXCI7XG5cbmV4cG9ydCBjb25zdCBWRVJTSU9OID0gXCIjI1ZFUlNJT04jI1wiO1xuIl19
+/**
+ * @description Current version of the for-http module
+ * @summary Version identifier for the module
+ * @const VERSION
+ */
+exports.VERSION = "0.2.3";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTs7Ozs7OztHQU9HO0FBQ0gsZ0RBQTBCO0FBQzFCLHVEQUFpQztBQUNqQyxvREFBOEI7QUFDOUIsOENBQXdCO0FBRXhCOzs7O0dBSUc7QUFDVSxRQUFBLE9BQU8sR0FBRyxhQUFhLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBkZXNjcmlwdGlvbiBIVFRQIGNsaWVudCBtb2R1bGUgZm9yIFJFU1QgQVBJIGludGVyYWN0aW9uc1xuICogQHN1bW1hcnkgVGhpcyBtb2R1bGUgcHJvdmlkZXMgY2xhc3NlcyBhbmQgdXRpbGl0aWVzIGZvciBpbnRlcmFjdGluZyB3aXRoIFJFU1QgQVBJcy5cbiAqIEl0IGV4cG9zZXMgcmVwb3NpdG9yeSBhbmQgc2VydmljZSBjbGFzc2VzIGZvciBtYWtpbmcgSFRUUCByZXF1ZXN0cywgYWxvbmcgd2l0aFxuICogdHlwZSBkZWZpbml0aW9ucyBhbmQgYWRhcHRlcnMgZm9yIGRpZmZlcmVudCBIVFRQIGNsaWVudHMuIFRoZSBtb2R1bGUgaW5jbHVkZXNcbiAqIHtAbGluayBSZXN0UmVwb3NpdG9yeX0gYW5kIHtAbGluayBSZXN0U2VydmljZX0gZm9yIEFQSSBpbnRlcmFjdGlvbnMuXG4gKiBAbW9kdWxlIGZvci1odHRwXG4gKi9cbmV4cG9ydCAqIGZyb20gXCIuL2FkYXB0ZXJcIjtcbmV4cG9ydCAqIGZyb20gXCIuL1Jlc3RSZXBvc2l0b3J5XCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SZXN0U2VydmljZVwiO1xuZXhwb3J0ICogZnJvbSBcIi4vdHlwZXNcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQ3VycmVudCB2ZXJzaW9uIG9mIHRoZSBmb3ItaHR0cCBtb2R1bGVcbiAqIEBzdW1tYXJ5IFZlcnNpb24gaWRlbnRpZmllciBmb3IgdGhlIG1vZHVsZVxuICogQGNvbnN0IFZFUlNJT05cbiAqL1xuZXhwb3J0IGNvbnN0IFZFUlNJT04gPSBcIiMjVkVSU0lPTiMjXCI7XG4iXX0=

package/lib/index.d.ts

@@ -1,5 +1,18 @@
+/**
+ * @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.
+ * @module for-http
+ */
 export * from "./adapter";
 export * from "./RestRepository";
 export * from "./RestService";
 export * from "./types";
-export declare const VERSION = "0.2.1";
+/**
+ * @description Current version of the for-http module
+ * @summary Version identifier for the module
+ * @const VERSION
+ */
+export declare const VERSION = "0.2.3";

package/lib/types.cjs

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

package/lib/types.d.ts

@@ -1,8 +1,23 @@
 import { RepositoryFlags } from "@decaf-ts/db-decorators";
+/**
+ * @description HTTP configuration type
+ * @summary Configuration type for HTTP connections specifying protocol and host
+ * @typedef {Object} HttpConfig
+ * @property {('http'|'https')} protocol - The HTTP protocol to use
+ * @property {string} host - The host address
+ * @memberOf module:for-http
+ */
 export type HttpConfig = {
     protocol: "http" | "https";
     host: string;
 };
+/**
+ * @description HTTP flags interface
+ * @summary Interface extending RepositoryFlags with HTTP-specific options
+ * @interface HttpFlags
+ * @property {Record<string, string>} [headers] - Optional HTTP headers to include with requests
+ * @memberOf module:for-http
+ */
 export interface HttpFlags extends RepositoryFlags {
     headers?: Record<string, string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/for-http",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "http wrappers for decaf-ts",
   "type": "module",
   "exports": {
@@ -71,7 +71,7 @@
     "ts"
   ],
   "author": "Tiago Venceslau",
-  "license": "LGPL-3.0-or-later",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/decaf-ts/for-http/issues"
   },