@decaf-ts/for-http 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,24 +1,90 @@
1
1
  import { Adapter, UnsupportedError, } from "@decaf-ts/core";
2
- import { RestService } from "./RestService";
2
+ import { RestService } from "./RestService.js";
3
+ /**
4
+ * @description Abstract HTTP adapter for REST API interactions
5
+ * @summary Provides a base implementation for HTTP adapters with methods for CRUD operations,
6
+ * URL construction, and error handling. This class extends the core Adapter class and
7
+ * implements the necessary methods for HTTP communication. Concrete implementations
8
+ * must provide specific HTTP client functionality.
9
+ * @template Y - The native HTTP client type
10
+ * @template Q - The query type used by the adapter
11
+ * @template F - The HTTP flags type, extending HttpFlags
12
+ * @template C - The context type, extending Context<F>
13
+ * @param {Y} native - The native HTTP client instance
14
+ * @param {HttpConfig} config - Configuration for the HTTP adapter
15
+ * @param {string} flavour - The adapter flavor identifier
16
+ * @param {string} [alias] - Optional alias for the adapter
17
+ * @example
18
+ * ```typescript
19
+ * // Example implementation with Axios
20
+ * class AxiosAdapter extends HttpAdapter<AxiosInstance, AxiosRequestConfig> {
21
+ * constructor(config: HttpConfig) {
22
+ * super(axios.create(), config, 'axios');
23
+ * }
24
+ *
25
+ * async request<V>(details: AxiosRequestConfig): Promise<V> {
26
+ * const response = await this.native.request(details);
27
+ * return response.data;
28
+ * }
29
+ *
30
+ * // Implement other abstract methods...
31
+ * }
32
+ * ```
33
+ * @class
34
+ */
3
35
  export class HttpAdapter extends Adapter {
4
36
  constructor(native, config, flavour, alias) {
5
37
  super(native, flavour, alias);
6
38
  this.config = config;
7
39
  }
40
+ /**
41
+ * @description Generates operation flags with HTTP headers
42
+ * @summary Extends the base flags method to include HTTP-specific headers for operations.
43
+ * This method adds an empty headers object to the flags returned by the parent class.
44
+ * @template F - The Repository Flags type
45
+ * @template M - The model type
46
+ * @param {OperationKeys.CREATE|OperationKeys.READ|OperationKeys.UPDATE|OperationKeys.DELETE} operation - The operation type
47
+ * @param {Constructor<M>} model - The model constructor
48
+ * @param {Partial<F>} overrides - Optional flag overrides
49
+ * @return {F} The flags object with headers
50
+ */
8
51
  flags(operation, model, overrides) {
9
52
  return Object.assign(super.flags(operation, model, overrides), {
10
53
  headers: {},
11
54
  });
12
55
  }
56
+ /**
57
+ * @description Returns the repository constructor for this adapter
58
+ * @summary Provides the RestService class as the repository implementation for this HTTP adapter.
59
+ * This method is used to create repository instances that work with this adapter type.
60
+ * @template M - The model type
61
+ * @return {Constructor<Repository<M, Q, HttpAdapter<Y, Q, F, C>>>} The repository constructor
62
+ */
13
63
  repository() {
14
64
  return RestService;
15
65
  }
66
+ /**
67
+ * @description Constructs a URL for API requests
68
+ * @summary Builds a complete URL for API requests using the configured protocol and host,
69
+ * the specified table name, and optional query parameters. The method handles URL encoding.
70
+ * @param {string} tableName - The name of the table or endpoint
71
+ * @param {Record<string, string | number>} [queryParams] - Optional query parameters
72
+ * @return {string} The encoded URL string
73
+ */
16
74
  url(tableName, queryParams) {
17
75
  const url = new URL(`${this.config.protocol}://${this.config.host}/${tableName}`);
18
76
  if (queryParams)
19
77
  Object.entries(queryParams).forEach(([key, value]) => url.searchParams.append(key, value.toString()));
20
78
  return encodeURI(url.toString());
21
79
  }
80
+ /**
81
+ * @description Parses and converts errors to BaseError type
82
+ * @summary Processes errors that occur during HTTP operations and converts them to
83
+ * the appropriate BaseError type. Currently returns the error as-is, but can be
84
+ * extended to handle specific error messages differently.
85
+ * @param {Error} err - The error to parse
86
+ * @return {BaseError} The parsed error as a BaseError
87
+ */
22
88
  parseError(err) {
23
89
  const { message } = err;
24
90
  switch (message) {
@@ -26,24 +92,71 @@ export class HttpAdapter extends Adapter {
26
92
  return err;
27
93
  }
28
94
  }
95
+ /**
96
+ * @description Initializes the HTTP adapter
97
+ * @summary Placeholder method for adapter initialization. This method is currently
98
+ * a no-op but can be overridden by subclasses to perform initialization tasks.
99
+ * @param {...any[]} args - Initialization arguments
100
+ * @return {Promise<void>} A promise that resolves when initialization is complete
101
+ */
29
102
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
30
103
  async initialize(...args) {
31
104
  // do nothing
32
105
  }
106
+ /**
107
+ * @description Executes a raw query
108
+ * @summary Method for executing raw queries directly with the HTTP client.
109
+ * This method is not supported by default in HTTP adapters and throws an UnsupportedError.
110
+ * Subclasses can override this method to provide implementation.
111
+ * @template R - The result type
112
+ * @param {Q} rawInput - The raw query input
113
+ * @param {boolean} process - Whether to process the result
114
+ * @param {...any[]} args - Additional arguments
115
+ * @return {Promise<R>} A promise that resolves with the query result
116
+ * @throws {UnsupportedError} Always throws as this method is not supported by default
117
+ */
33
118
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
34
119
  raw(rawInput, process, ...args) {
35
120
  throw new UnsupportedError("Api is not natively available for HttpAdapters. If required, please extends this class");
36
121
  }
122
+ /**
123
+ * @description Creates a sequence
124
+ * @summary Method for creating a sequence for generating unique identifiers.
125
+ * This method is not supported by default in HTTP adapters and throws an UnsupportedError.
126
+ * Subclasses can override this method to provide implementation.
127
+ * @param {SequenceOptions} options - Options for creating the sequence
128
+ * @return {Promise<Sequence>} A promise that resolves with the created sequence
129
+ * @throws {UnsupportedError} Always throws as this method is not supported by default
130
+ */
37
131
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
38
132
  Sequence(options) {
39
133
  throw new UnsupportedError("Api is not natively available for HttpAdapters. If required, please extends this class");
40
134
  }
135
+ /**
136
+ * @description Creates a statement for querying
137
+ * @summary Method for creating a statement for building and executing queries.
138
+ * This method is not supported by default in HTTP adapters and throws an UnsupportedError.
139
+ * Subclasses can override this method to provide implementation.
140
+ * @template M - The model type
141
+ * @template ! - The raw query type
142
+ * @return {Statement<Q, M, any>} A statement object for building queries
143
+ * @throws {UnsupportedError} Always throws as this method is not supported by default
144
+ */
41
145
  Statement() {
42
146
  throw new UnsupportedError("Api is not natively available for HttpAdapters. If required, please extends this class");
43
147
  }
148
+ /**
149
+ * @description Parses a condition into a query
150
+ * @summary Method for parsing a condition object into a query format understood by the HTTP client.
151
+ * This method is not supported by default in HTTP adapters and throws an UnsupportedError.
152
+ * Subclasses can override this method to provide implementation.
153
+ * @param {Condition<any>} condition - The condition to parse
154
+ * @return {Q} The parsed query
155
+ * @throws {UnsupportedError} Always throws as this method is not supported by default
156
+ */
44
157
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
45
158
  parseCondition(condition) {
46
159
  throw new UnsupportedError("Api is not natively available for HttpAdapters. If required, please extends this class");
47
160
  }
48
161
  }
49
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWRhcHRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hZGFwdGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFDTCxPQUFPLEVBS1AsZ0JBQWdCLEdBQ2pCLE1BQU0sZ0JBQWdCLENBQUM7QUFJeEIsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLGVBQWUsQ0FBQztBQUc1QyxNQUFNLE9BQWdCLFdBS3BCLFNBQVEsT0FBbUI7SUFDM0IsWUFDRSxNQUFTLEVBQ0MsTUFBa0IsRUFDNUIsT0FBZSxFQUNmLEtBQWM7UUFFZCxLQUFLLENBQUMsTUFBTSxFQUFFLE9BQU8sRUFBRSxLQUFLLENBQUMsQ0FBQztRQUpwQixXQUFNLEdBQU4sTUFBTSxDQUFZO0lBSzlCLENBQUM7SUFFUSxLQUFLLENBQ1osU0FJd0IsRUFDeEIsS0FBcUIsRUFDckIsU0FBcUI7UUFFckIsT0FBTyxNQUFNLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUksU0FBUyxFQUFFLEtBQUssRUFBRSxTQUFTLENBQUMsRUFBRTtZQUNoRSxPQUFPLEVBQUUsRUFBRTtTQUNaLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFUSxVQUFVO1FBR2pCLE9BQU8sV0FFTixDQUFDO0lBQ0osQ0FBQztJQUVTLEdBQUcsQ0FDWCxTQUFpQixFQUNqQixXQUE2QztRQUU3QyxNQUFNLEdBQUcsR0FBRyxJQUFJLEdBQUcsQ0FDakIsR0FBRyxJQUFJLENBQUMsTUFBTSxDQUFDLFFBQVEsTUFBTSxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksSUFBSSxTQUFTLEVBQUUsQ0FDN0QsQ0FBQztRQUNGLElBQUksV0FBVztZQUNiLE1BQU0sQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLEVBQUUsRUFBRSxDQUNuRCxHQUFHLENBQUMsWUFBWSxDQUFDLE1BQU0sQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQy9DLENBQUM7UUFFSixPQUFPLFNBQVMsQ0FBQyxHQUFHLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztJQUNuQyxDQUFDO0lBRUQsVUFBVSxDQUFDLEdBQVU7UUFDbkIsTUFBTSxFQUFFLE9BQU8sRUFBRSxHQUFHLEdBQUcsQ0FBQztRQUN4QixRQUFRLE9BQU8sRUFBRSxDQUFDO1lBQ2hCO2dCQUNFLE9BQU8sR0FBZ0IsQ0FBQztRQUM1QixDQUFDO0lBQ0gsQ0FBQztJQUVELDZEQUE2RDtJQUM3RCxLQUFLLENBQUMsVUFBVSxDQUFDLEdBQUcsSUFBVztRQUM3QixhQUFhO0lBQ2YsQ0FBQztJQThCRCw2REFBNkQ7SUFDN0QsR0FBRyxDQUFJLFFBQVcsRUFBRSxPQUFnQixFQUFFLEdBQUcsSUFBVztRQUNsRCxNQUFNLElBQUksZ0JBQWdCLENBQ3hCLHdGQUF3RixDQUN6RixDQUFDO0lBQ0osQ0FBQztJQUVELDZEQUE2RDtJQUM3RCxRQUFRLENBQUMsT0FBd0I7UUFDL0IsTUFBTSxJQUFJLGdCQUFnQixDQUN4Qix3RkFBd0YsQ0FDekYsQ0FBQztJQUNKLENBQUM7SUFFUSxTQUFTO1FBQ2hCLE1BQU0sSUFBSSxnQkFBZ0IsQ0FDeEIsd0ZBQXdGLENBQ3pGLENBQUM7SUFDSixDQUFDO0lBRUQsNkRBQTZEO0lBQzdELGNBQWMsQ0FBQyxTQUF5QjtRQUN0QyxNQUFNLElBQUksZ0JBQWdCLENBQ3hCLHdGQUF3RixDQUN6RixDQUFDO0lBQ0osQ0FBQztDQUNGIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtcbiAgQWRhcHRlcixcbiAgQ29uZGl0aW9uLFxuICBSZXBvc2l0b3J5LFxuICBTZXF1ZW5jZSxcbiAgU2VxdWVuY2VPcHRpb25zLFxuICBVbnN1cHBvcnRlZEVycm9yLFxufSBmcm9tIFwiQGRlY2FmLXRzL2NvcmVcIjtcbmltcG9ydCB7IEJhc2VFcnJvciwgQ29udGV4dCwgT3BlcmF0aW9uS2V5cyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgSHR0cENvbmZpZywgSHR0cEZsYWdzIH0gZnJvbSBcIi4vdHlwZXNcIjtcbmltcG9ydCB7IENvbnN0cnVjdG9yLCBNb2RlbCB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IFJlc3RTZXJ2aWNlIH0gZnJvbSBcIi4vUmVzdFNlcnZpY2VcIjtcbmltcG9ydCB7IFN0YXRlbWVudCB9IGZyb20gXCJAZGVjYWYtdHMvY29yZVwiO1xuXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgSHR0cEFkYXB0ZXI8XG4gIFksXG4gIFEsXG4gIEYgZXh0ZW5kcyBIdHRwRmxhZ3MgPSBIdHRwRmxhZ3MsXG4gIEMgZXh0ZW5kcyBDb250ZXh0PEY+ID0gQ29udGV4dDxGPixcbj4gZXh0ZW5kcyBBZGFwdGVyPFksIFEsIEYsIEM+IHtcbiAgcHJvdGVjdGVkIGNvbnN0cnVjdG9yKFxuICAgIG5hdGl2ZTogWSxcbiAgICBwcm90ZWN0ZWQgY29uZmlnOiBIdHRwQ29uZmlnLFxuICAgIGZsYXZvdXI6IHN0cmluZyxcbiAgICBhbGlhcz86IHN0cmluZ1xuICApIHtcbiAgICBzdXBlcihuYXRpdmUsIGZsYXZvdXIsIGFsaWFzKTtcbiAgfVxuXG4gIG92ZXJyaWRlIGZsYWdzPE0gZXh0ZW5kcyBNb2RlbD4oXG4gICAgb3BlcmF0aW9uOlxuICAgICAgfCBPcGVyYXRpb25LZXlzLkNSRUFURVxuICAgICAgfCBPcGVyYXRpb25LZXlzLlJFQURcbiAgICAgIHwgT3BlcmF0aW9uS2V5cy5VUERBVEVcbiAgICAgIHwgT3BlcmF0aW9uS2V5cy5ERUxFVEUsXG4gICAgbW9kZWw6IENvbnN0cnVjdG9yPE0+LFxuICAgIG92ZXJyaWRlczogUGFydGlhbDxGPlxuICApIHtcbiAgICByZXR1cm4gT2JqZWN0LmFzc2lnbihzdXBlci5mbGFnczxNPihvcGVyYXRpb24sIG1vZGVsLCBvdmVycmlkZXMpLCB7XG4gICAgICBoZWFkZXJzOiB7fSxcbiAgICB9KTtcbiAgfVxuXG4gIG92ZXJyaWRlIHJlcG9zaXRvcnk8TSBleHRlbmRzIE1vZGVsPigpOiBDb25zdHJ1Y3RvcjxcbiAgICBSZXBvc2l0b3J5PE0sIFEsIEh0dHBBZGFwdGVyPFksIFEsIEYsIEM+PlxuICA+IHtcbiAgICByZXR1cm4gUmVzdFNlcnZpY2UgYXMgdW5rbm93biBhcyBDb25zdHJ1Y3RvcjxcbiAgICAgIFJlcG9zaXRvcnk8TSwgUSwgSHR0cEFkYXB0ZXI8WSwgUSwgRiwgQz4+XG4gICAgPjtcbiAgfVxuXG4gIHByb3RlY3RlZCB1cmwoXG4gICAgdGFibGVOYW1lOiBzdHJpbmcsXG4gICAgcXVlcnlQYXJhbXM/OiBSZWNvcmQ8c3RyaW5nLCBzdHJpbmcgfCBudW1iZXI+XG4gICkge1xuICAgIGNvbnN0IHVybCA9IG5ldyBVUkwoXG4gICAgICBgJHt0aGlzLmNvbmZpZy5wcm90b2NvbH06Ly8ke3RoaXMuY29uZmlnLmhvc3R9LyR7dGFibGVOYW1lfWBcbiAgICApO1xuICAgIGlmIChxdWVyeVBhcmFtcylcbiAgICAgIE9iamVjdC5lbnRyaWVzKHF1ZXJ5UGFyYW1zKS5mb3JFYWNoKChba2V5LCB2YWx1ZV0pID0+XG4gICAgICAgIHVybC5zZWFyY2hQYXJhbXMuYXBwZW5kKGtleSwgdmFsdWUudG9TdHJpbmcoKSlcbiAgICAgICk7XG5cbiAgICByZXR1cm4gZW5jb2RlVVJJKHVybC50b1N0cmluZygpKTtcbiAgfVxuXG4gIHBhcnNlRXJyb3IoZXJyOiBFcnJvcik6IEJhc2VFcnJvciB7XG4gICAgY29uc3QgeyBtZXNzYWdlIH0gPSBlcnI7XG4gICAgc3dpdGNoIChtZXNzYWdlKSB7XG4gICAgICBkZWZhdWx0OlxuICAgICAgICByZXR1cm4gZXJyIGFzIEJhc2VFcnJvcjtcbiAgICB9XG4gIH1cblxuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gIGFzeW5jIGluaXRpYWxpemUoLi4uYXJnczogYW55W10pOiBQcm9taXNlPHZvaWQ+IHtcbiAgICAvLyBkbyBub3RoaW5nXG4gIH1cblxuICBhYnN0cmFjdCByZXF1ZXN0PFY+KGRldGFpbHM6IFEpOiBQcm9taXNlPFY+O1xuXG4gIGFic3RyYWN0IG92ZXJyaWRlIGNyZWF0ZShcbiAgICB0YWJsZU5hbWU6IHN0cmluZyxcbiAgICBpZDogc3RyaW5nIHwgbnVtYmVyLFxuICAgIG1vZGVsOiBSZWNvcmQ8c3RyaW5nLCBhbnk+LFxuICAgIC4uLmFyZ3M6IGFueVtdXG4gICk6IFByb21pc2U8UmVjb3JkPHN0cmluZywgYW55Pj47XG5cbiAgYWJzdHJhY3Qgb3ZlcnJpZGUgcmVhZChcbiAgICB0YWJsZU5hbWU6IHN0cmluZyxcbiAgICBpZDogc3RyaW5nIHwgbnVtYmVyIHwgYmlnaW50LFxuICAgIC4uLmFyZ3M6IGFueVtdXG4gICk6IFByb21pc2U8UmVjb3JkPHN0cmluZywgYW55Pj47XG5cbiAgYWJzdHJhY3Qgb3ZlcnJpZGUgdXBkYXRlKFxuICAgIHRhYmxlTmFtZTogc3RyaW5nLFxuICAgIGlkOiBzdHJpbmcgfCBudW1iZXIsXG4gICAgbW9kZWw6IFJlY29yZDxzdHJpbmcsIGFueT4sXG4gICAgLi4uYXJnczogYW55W11cbiAgKTogUHJvbWlzZTxSZWNvcmQ8c3RyaW5nLCBhbnk+PjtcblxuICBhYnN0cmFjdCBvdmVycmlkZSBkZWxldGUoXG4gICAgdGFibGVOYW1lOiBzdHJpbmcsXG4gICAgaWQ6IHN0cmluZyB8IG51bWJlciB8IGJpZ2ludCxcbiAgICAuLi5hcmdzOiBhbnlbXVxuICApOiBQcm9taXNlPFJlY29yZDxzdHJpbmcsIGFueT4+O1xuXG4gIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdW51c2VkLXZhcnNcbiAgcmF3PFI+KHJhd0lucHV0OiBRLCBwcm9jZXNzOiBib29sZWFuLCAuLi5hcmdzOiBhbnlbXSk6IFByb21pc2U8Uj4ge1xuICAgIHRocm93IG5ldyBVbnN1cHBvcnRlZEVycm9yKFxuICAgICAgXCJBcGkgaXMgbm90IG5hdGl2ZWx5IGF2YWlsYWJsZSBmb3IgSHR0cEFkYXB0ZXJzLiBJZiByZXF1aXJlZCwgcGxlYXNlIGV4dGVuZHMgdGhpcyBjbGFzc1wiXG4gICAgKTtcbiAgfVxuXG4gIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdW51c2VkLXZhcnNcbiAgU2VxdWVuY2Uob3B0aW9uczogU2VxdWVuY2VPcHRpb25zKTogUHJvbWlzZTxTZXF1ZW5jZT4ge1xuICAgIHRocm93IG5ldyBVbnN1cHBvcnRlZEVycm9yKFxuICAgICAgXCJBcGkgaXMgbm90IG5hdGl2ZWx5IGF2YWlsYWJsZSBmb3IgSHR0cEFkYXB0ZXJzLiBJZiByZXF1aXJlZCwgcGxlYXNlIGV4dGVuZHMgdGhpcyBjbGFzc1wiXG4gICAgKTtcbiAgfVxuXG4gIG92ZXJyaWRlIFN0YXRlbWVudDxNIGV4dGVuZHMgTW9kZWw+KCk6IFN0YXRlbWVudDxRLCBNLCBhbnk+IHtcbiAgICB0aHJvdyBuZXcgVW5zdXBwb3J0ZWRFcnJvcihcbiAgICAgIFwiQXBpIGlzIG5vdCBuYXRpdmVseSBhdmFpbGFibGUgZm9yIEh0dHBBZGFwdGVycy4gSWYgcmVxdWlyZWQsIHBsZWFzZSBleHRlbmRzIHRoaXMgY2xhc3NcIlxuICAgICk7XG4gIH1cblxuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gIHBhcnNlQ29uZGl0aW9uKGNvbmRpdGlvbjogQ29uZGl0aW9uPGFueT4pOiBRIHtcbiAgICB0aHJvdyBuZXcgVW5zdXBwb3J0ZWRFcnJvcihcbiAgICAgIFwiQXBpIGlzIG5vdCBuYXRpdmVseSBhdmFpbGFibGUgZm9yIEh0dHBBZGFwdGVycy4gSWYgcmVxdWlyZWQsIHBsZWFzZSBleHRlbmRzIHRoaXMgY2xhc3NcIlxuICAgICk7XG4gIH1cbn1cbiJdfQ==
162
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAKP,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAIxB,OAAO,EAAE,WAAW,EAAE,yBAAsB;AAG5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,OAAgB,WAKpB,SAAQ,OAAmB;IAC3B,YACE,MAAS,EACC,MAAkB,EAC5B,OAAe,EACf,KAAc;QAEd,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAJpB,WAAM,GAAN,MAAM,CAAY;IAK9B,CAAC;IAED;;;;;;;;;;OAUG;IACM,KAAK,CACZ,SAIwB,EACxB,KAAqB,EACrB,SAAqB;QAErB,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAI,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE;YAChE,OAAO,EAAE,EAAE;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACM,UAAU;QAGjB,OAAO,WAEN,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACO,GAAG,CACX,SAAiB,EACjB,WAA6C;QAE7C,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,SAAS,EAAE,CAC7D,CAAC;QACF,IAAI,WAAW;YACb,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CACnD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAC/C,CAAC;QAEJ,OAAO,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,GAAU;QACnB,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC;QACxB,QAAQ,OAAO,EAAE,CAAC;YAChB;gBACE,OAAO,GAAgB,CAAC;QAC5B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,6DAA6D;IAC7D,KAAK,CAAC,UAAU,CAAC,GAAG,IAAW;QAC7B,aAAa;IACf,CAAC;IA4ED;;;;;;;;;;;OAWG;IACH,6DAA6D;IAC7D,GAAG,CAAI,QAAW,EAAE,OAAgB,EAAE,GAAG,IAAW;QAClD,MAAM,IAAI,gBAAgB,CACxB,wFAAwF,CACzF,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,6DAA6D;IAC7D,QAAQ,CAAC,OAAwB;QAC/B,MAAM,IAAI,gBAAgB,CACxB,wFAAwF,CACzF,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACM,SAAS;QAChB,MAAM,IAAI,gBAAgB,CACxB,wFAAwF,CACzF,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,6DAA6D;IAC7D,cAAc,CAAC,SAAyB;QACtC,MAAM,IAAI,gBAAgB,CACxB,wFAAwF,CACzF,CAAC;IACJ,CAAC;CACF","sourcesContent":["import {\n  Adapter,\n  Condition,\n  Repository,\n  Sequence,\n  SequenceOptions,\n  UnsupportedError,\n} from \"@decaf-ts/core\";\nimport { BaseError, Context, OperationKeys } from \"@decaf-ts/db-decorators\";\nimport { HttpConfig, HttpFlags } from \"./types\";\nimport { Constructor, Model } from \"@decaf-ts/decorator-validation\";\nimport { RestService } from \"./RestService\";\nimport { Statement } from \"@decaf-ts/core\";\n\n/**\n * @description Abstract HTTP adapter for REST API interactions\n * @summary Provides a base implementation for HTTP adapters with methods for CRUD operations,\n * URL construction, and error handling. This class extends the core Adapter class and\n * implements the necessary methods for HTTP communication. Concrete implementations\n * must provide specific HTTP client functionality.\n * @template Y - The native HTTP client type\n * @template Q - The query type used by the adapter\n * @template F - The HTTP flags type, extending HttpFlags\n * @template C - The context type, extending Context<F>\n * @param {Y} native - The native HTTP client instance\n * @param {HttpConfig} config - Configuration for the HTTP adapter\n * @param {string} flavour - The adapter flavor identifier\n * @param {string} [alias] - Optional alias for the adapter\n * @example\n * ```typescript\n * // Example implementation with Axios\n * class AxiosAdapter extends HttpAdapter<AxiosInstance, AxiosRequestConfig> {\n *   constructor(config: HttpConfig) {\n *     super(axios.create(), config, 'axios');\n *   }\n *\n *   async request<V>(details: AxiosRequestConfig): Promise<V> {\n *     const response = await this.native.request(details);\n *     return response.data;\n *   }\n *\n *   // Implement other abstract methods...\n * }\n * ```\n * @class\n */\nexport abstract class HttpAdapter<\n  Y,\n  Q,\n  F extends HttpFlags = HttpFlags,\n  C extends Context<F> = Context<F>,\n> extends Adapter<Y, Q, F, C> {\n  protected constructor(\n    native: Y,\n    protected config: HttpConfig,\n    flavour: string,\n    alias?: string\n  ) {\n    super(native, flavour, alias);\n  }\n\n  /**\n   * @description Generates operation flags with HTTP headers\n   * @summary Extends the base flags method to include HTTP-specific headers for operations.\n   * This method adds an empty headers object to the flags returned by the parent class.\n   * @template F - The Repository Flags type\n   * @template M - The model type\n   * @param {OperationKeys.CREATE|OperationKeys.READ|OperationKeys.UPDATE|OperationKeys.DELETE} operation - The operation type\n   * @param {Constructor<M>} model - The model constructor\n   * @param {Partial<F>} overrides - Optional flag overrides\n   * @return {F} The flags object with headers\n   */\n  override flags<M extends Model>(\n    operation:\n      | OperationKeys.CREATE\n      | OperationKeys.READ\n      | OperationKeys.UPDATE\n      | OperationKeys.DELETE,\n    model: Constructor<M>,\n    overrides: Partial<F>\n  ) {\n    return Object.assign(super.flags<M>(operation, model, overrides), {\n      headers: {},\n    });\n  }\n\n  /**\n   * @description Returns the repository constructor for this adapter\n   * @summary Provides the RestService class as the repository implementation for this HTTP adapter.\n   * This method is used to create repository instances that work with this adapter type.\n   * @template M - The model type\n   * @return {Constructor<Repository<M, Q, HttpAdapter<Y, Q, F, C>>>} The repository constructor\n   */\n  override repository<M extends Model>(): Constructor<\n    Repository<M, Q, HttpAdapter<Y, Q, F, C>>\n  > {\n    return RestService as unknown as Constructor<\n      Repository<M, Q, HttpAdapter<Y, Q, F, C>>\n    >;\n  }\n\n  /**\n   * @description Constructs a URL for API requests\n   * @summary Builds a complete URL for API requests using the configured protocol and host,\n   * the specified table name, and optional query parameters. The method handles URL encoding.\n   * @param {string} tableName - The name of the table or endpoint\n   * @param {Record<string, string | number>} [queryParams] - Optional query parameters\n   * @return {string} The encoded URL string\n   */\n  protected url(\n    tableName: string,\n    queryParams?: Record<string, string | number>\n  ) {\n    const url = new URL(\n      `${this.config.protocol}://${this.config.host}/${tableName}`\n    );\n    if (queryParams)\n      Object.entries(queryParams).forEach(([key, value]) =>\n        url.searchParams.append(key, value.toString())\n      );\n\n    return encodeURI(url.toString());\n  }\n\n  /**\n   * @description Parses and converts errors to BaseError type\n   * @summary Processes errors that occur during HTTP operations and converts them to\n   * the appropriate BaseError type. Currently returns the error as-is, but can be\n   * extended to handle specific error messages differently.\n   * @param {Error} err - The error to parse\n   * @return {BaseError} The parsed error as a BaseError\n   */\n  parseError(err: Error): BaseError {\n    const { message } = err;\n    switch (message) {\n      default:\n        return err as BaseError;\n    }\n  }\n\n  /**\n   * @description Initializes the HTTP adapter\n   * @summary Placeholder method for adapter initialization. This method is currently\n   * a no-op but can be overridden by subclasses to perform initialization tasks.\n   * @param {...any[]} args - Initialization arguments\n   * @return {Promise<void>} A promise that resolves when initialization is complete\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  async initialize(...args: any[]): Promise<void> {\n    // do nothing\n  }\n\n  /**\n   * @description Sends an HTTP request\n   * @summary Abstract method that must be implemented by subclasses to send HTTP requests\n   * using the native HTTP client. This is the core method for making API calls.\n   * @template V - The response value type\n   * @param {Q} details - The request details specific to the HTTP client\n   * @return {Promise<V>} A promise that resolves with the response data\n   */\n  abstract request<V>(details: Q): Promise<V>;\n\n  /**\n   * @description Creates a new resource\n   * @summary Abstract method that must be implemented by subclasses to create a new resource\n   * via HTTP. This typically corresponds to a POST request.\n   * @param {string} tableName - The name of the table or endpoint\n   * @param {string|number} id - The identifier for the resource\n   * @param {Record<string, any>} model - The data model to create\n   * @param {...any[]} args - Additional arguments\n   * @return {Promise<Record<string, any>>} A promise that resolves with the created resource\n   */\n  abstract override create(\n    tableName: string,\n    id: string | number,\n    model: Record<string, any>,\n    ...args: any[]\n  ): Promise<Record<string, any>>;\n\n  /**\n   * @description Retrieves a resource by ID\n   * @summary Abstract method that must be implemented by subclasses to retrieve a resource\n   * via HTTP. This typically corresponds to a GET request.\n   * @param {string} tableName - The name of the table or endpoint\n   * @param {string|number|bigint} id - The identifier for the resource\n   * @param {...any[]} args - Additional arguments\n   * @return {Promise<Record<string, any>>} A promise that resolves with the retrieved resource\n   */\n  abstract override read(\n    tableName: string,\n    id: string | number | bigint,\n    ...args: any[]\n  ): Promise<Record<string, any>>;\n\n  /**\n   * @description Updates an existing resource\n   * @summary Abstract method that must be implemented by subclasses to update a resource\n   * via HTTP. This typically corresponds to a PUT or PATCH request.\n   * @param {string} tableName - The name of the table or endpoint\n   * @param {string|number} id - The identifier for the resource\n   * @param {Record<string, any>} model - The updated data model\n   * @param {...any[]} args - Additional arguments\n   * @return {Promise<Record<string, any>>} A promise that resolves with the updated resource\n   */\n  abstract override update(\n    tableName: string,\n    id: string | number,\n    model: Record<string, any>,\n    ...args: any[]\n  ): Promise<Record<string, any>>;\n\n  /**\n   * @description Deletes a resource by ID\n   * @summary Abstract method that must be implemented by subclasses to delete a resource\n   * via HTTP. This typically corresponds to a DELETE request.\n   * @param {string} tableName - The name of the table or endpoint\n   * @param {string|number|bigint} id - The identifier for the resource to delete\n   * @param {...any[]} args - Additional arguments\n   * @return {Promise<Record<string, any>>} A promise that resolves with the deletion result\n   */\n  abstract override delete(\n    tableName: string,\n    id: string | number | bigint,\n    ...args: any[]\n  ): Promise<Record<string, any>>;\n\n  /**\n   * @description Executes a raw query\n   * @summary Method for executing raw queries directly with the HTTP client.\n   * This method is not supported by default in HTTP adapters and throws an UnsupportedError.\n   * Subclasses can override this method to provide implementation.\n   * @template R - The result type\n   * @param {Q} rawInput - The raw query input\n   * @param {boolean} process - Whether to process the result\n   * @param {...any[]} args - Additional arguments\n   * @return {Promise<R>} A promise that resolves with the query result\n   * @throws {UnsupportedError} Always throws as this method is not supported by default\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  raw<R>(rawInput: Q, process: boolean, ...args: any[]): Promise<R> {\n    throw new UnsupportedError(\n      \"Api is not natively available for HttpAdapters. If required, please extends this class\"\n    );\n  }\n\n  /**\n   * @description Creates a sequence\n   * @summary Method for creating a sequence for generating unique identifiers.\n   * This method is not supported by default in HTTP adapters and throws an UnsupportedError.\n   * Subclasses can override this method to provide implementation.\n   * @param {SequenceOptions} options - Options for creating the sequence\n   * @return {Promise<Sequence>} A promise that resolves with the created sequence\n   * @throws {UnsupportedError} Always throws as this method is not supported by default\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  Sequence(options: SequenceOptions): Promise<Sequence> {\n    throw new UnsupportedError(\n      \"Api is not natively available for HttpAdapters. If required, please extends this class\"\n    );\n  }\n\n  /**\n   * @description Creates a statement for querying\n   * @summary Method for creating a statement for building and executing queries.\n   * This method is not supported by default in HTTP adapters and throws an UnsupportedError.\n   * Subclasses can override this method to provide implementation.\n   * @template M - The model type\n   * @template ! - The raw query type\n   * @return {Statement<Q, M, any>} A statement object for building queries\n   * @throws {UnsupportedError} Always throws as this method is not supported by default\n   */\n  override Statement<M extends Model>(): Statement<Q, M, any> {\n    throw new UnsupportedError(\n      \"Api is not natively available for HttpAdapters. If required, please extends this class\"\n    );\n  }\n\n  /**\n   * @description Parses a condition into a query\n   * @summary Method for parsing a condition object into a query format understood by the HTTP client.\n   * This method is not supported by default in HTTP adapters and throws an UnsupportedError.\n   * Subclasses can override this method to provide implementation.\n   * @param {Condition<any>} condition - The condition to parse\n   * @return {Q} The parsed query\n   * @throws {UnsupportedError} Always throws as this method is not supported by default\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  parseCondition(condition: Condition<any>): Q {\n    throw new UnsupportedError(\n      \"Api is not natively available for HttpAdapters. If required, please extends this class\"\n    );\n  }\n}\n"]}
@@ -3,12 +3,106 @@ import { Axios, AxiosRequestConfig } from "axios";
3
3
  import { HttpConfig } from "../types";
4
4
  import { AxiosFlags } from "./types";
5
5
  import { Context } from "@decaf-ts/db-decorators";
6
+ /**
7
+ * @description Axios implementation of the HTTP adapter
8
+ * @summary Concrete implementation of HttpAdapter using Axios as the HTTP client.
9
+ * This adapter provides CRUD operations for RESTful APIs using Axios for HTTP requests.
10
+ * @template Axios - The Axios client type
11
+ * @template AxiosRequestConfig - The Axios request configuration type
12
+ * @template AxiosFlags - The flags type extending HttpFlags
13
+ * @template Context<AxiosFlags> - The context type for this adapter
14
+ * @param {Axios} native - The Axios instance
15
+ * @param {HttpConfig} config - Configuration for the HTTP adapter
16
+ * @param {string} [alias] - Optional alias for the adapter
17
+ * @class
18
+ * @example
19
+ * ```typescript
20
+ * import axios from 'axios';
21
+ * import { AxiosHttpAdapter } from '@decaf-ts/for-http';
22
+ *
23
+ * const config = { protocol: 'https', host: 'api.example.com' };
24
+ * const adapter = new AxiosHttpAdapter(axios.create(), config);
25
+ *
26
+ * // Use the adapter with a repository
27
+ * const userRepo = adapter.getRepository(User);
28
+ * const user = await userRepo.findById('123');
29
+ * ```
30
+ * @mermaid
31
+ * sequenceDiagram
32
+ * participant Client
33
+ * participant AxiosHttpAdapter
34
+ * participant Axios
35
+ * participant API
36
+ *
37
+ * Client->>AxiosHttpAdapter: create(table, id, data)
38
+ * AxiosHttpAdapter->>AxiosHttpAdapter: url(table)
39
+ * AxiosHttpAdapter->>Axios: post(url, data)
40
+ * Axios->>API: HTTP POST Request
41
+ * API-->>Axios: Response
42
+ * Axios-->>AxiosHttpAdapter: Response Data
43
+ * AxiosHttpAdapter-->>Client: Created Resource
44
+ *
45
+ * Client->>AxiosHttpAdapter: read(table, id)
46
+ * AxiosHttpAdapter->>AxiosHttpAdapter: url(table, {id})
47
+ * AxiosHttpAdapter->>Axios: get(url)
48
+ * Axios->>API: HTTP GET Request
49
+ * API-->>Axios: Response
50
+ * Axios-->>AxiosHttpAdapter: Response Data
51
+ * AxiosHttpAdapter-->>Client: Resource Data
52
+ */
6
53
  export declare class AxiosHttpAdapter extends HttpAdapter<Axios, AxiosRequestConfig, AxiosFlags, Context<AxiosFlags>> {
7
54
  constructor(native: Axios, config: HttpConfig, alias?: string);
55
+ /**
56
+ * @description Sends an HTTP request using Axios
57
+ * @summary Implementation of the abstract request method from HttpAdapter.
58
+ * This method uses the Axios instance to send HTTP requests with the provided configuration.
59
+ * @template V - The response value type
60
+ * @param {AxiosRequestConfig} details - The Axios request configuration
61
+ * @return {Promise<V>} A promise that resolves with the response data
62
+ */
8
63
  request<V>(details: AxiosRequestConfig): Promise<V>;
64
+ /**
65
+ * @description Creates a new resource via HTTP POST
66
+ * @summary Implementation of the abstract create method from HttpAdapter.
67
+ * This method sends a POST request to the specified endpoint with the model data.
68
+ * @param {string} tableName - The name of the table or endpoint
69
+ * @param {string|number} id - The identifier for the resource (not used in URL for POST)
70
+ * @param {Record<string, any>} model - The data model to create
71
+ * @return {Promise<Record<string, any>>} A promise that resolves with the created resource
72
+ */
9
73
  create(tableName: string, id: string | number, model: Record<string, any>): Promise<Record<string, any>>;
74
+ /**
75
+ * @description Retrieves a resource by ID via HTTP GET
76
+ * @summary Implementation of the abstract read method from HttpAdapter.
77
+ * This method sends a GET request to the specified endpoint with the ID as a query parameter.
78
+ * @param {string} tableName - The name of the table or endpoint
79
+ * @param {string|number|bigint} id - The identifier for the resource to retrieve
80
+ * @return {Promise<Record<string, any>>} A promise that resolves with the retrieved resource
81
+ */
10
82
  read(tableName: string, id: string | number | bigint): Promise<Record<string, any>>;
83
+ /**
84
+ * @description Updates an existing resource via HTTP PUT
85
+ * @summary Implementation of the abstract update method from HttpAdapter.
86
+ * This method sends a PUT request to the specified endpoint with the updated model data.
87
+ * @param {string} tableName - The name of the table or endpoint
88
+ * @param {string|number} id - The identifier for the resource (not used in URL for PUT)
89
+ * @param {Record<string, any>} model - The updated data model
90
+ * @return {Promise<Record<string, any>>} A promise that resolves with the updated resource
91
+ */
11
92
  update(tableName: string, id: string | number, model: Record<string, any>): Promise<Record<string, any>>;
93
+ /**
94
+ * @description Deletes a resource by ID via HTTP DELETE
95
+ * @summary Implementation of the abstract delete method from HttpAdapter.
96
+ * This method sends a DELETE request to the specified endpoint with the ID as a query parameter.
97
+ * @param {string} tableName - The name of the table or endpoint
98
+ * @param {string|number|bigint} id - The identifier for the resource to delete
99
+ * @return {Promise<Record<string, any>>} A promise that resolves with the deletion result
100
+ */
12
101
  delete(tableName: string, id: string | number | bigint): Promise<Record<string, any>>;
102
+ /**
103
+ * @description Static decoration method for the AxiosHttpAdapter class
104
+ * @summary Placeholder method for class decoration functionality.
105
+ * This method is currently empty but can be used for decorator-based configuration.
106
+ */
13
107
  static decoration(): void;
14
108
  }
@@ -1,12 +1,76 @@
1
- import { HttpAdapter } from "../adapter";
2
- import { AxiosFlavour } from "./constants";
1
+ import { HttpAdapter } from "./../adapter.js";
2
+ import { AxiosFlavour } from "./constants.js";
3
+ /**
4
+ * @description Axios implementation of the HTTP adapter
5
+ * @summary Concrete implementation of HttpAdapter using Axios as the HTTP client.
6
+ * This adapter provides CRUD operations for RESTful APIs using Axios for HTTP requests.
7
+ * @template Axios - The Axios client type
8
+ * @template AxiosRequestConfig - The Axios request configuration type
9
+ * @template AxiosFlags - The flags type extending HttpFlags
10
+ * @template Context<AxiosFlags> - The context type for this adapter
11
+ * @param {Axios} native - The Axios instance
12
+ * @param {HttpConfig} config - Configuration for the HTTP adapter
13
+ * @param {string} [alias] - Optional alias for the adapter
14
+ * @class
15
+ * @example
16
+ * ```typescript
17
+ * import axios from 'axios';
18
+ * import { AxiosHttpAdapter } from '@decaf-ts/for-http';
19
+ *
20
+ * const config = { protocol: 'https', host: 'api.example.com' };
21
+ * const adapter = new AxiosHttpAdapter(axios.create(), config);
22
+ *
23
+ * // Use the adapter with a repository
24
+ * const userRepo = adapter.getRepository(User);
25
+ * const user = await userRepo.findById('123');
26
+ * ```
27
+ * @mermaid
28
+ * sequenceDiagram
29
+ * participant Client
30
+ * participant AxiosHttpAdapter
31
+ * participant Axios
32
+ * participant API
33
+ *
34
+ * Client->>AxiosHttpAdapter: create(table, id, data)
35
+ * AxiosHttpAdapter->>AxiosHttpAdapter: url(table)
36
+ * AxiosHttpAdapter->>Axios: post(url, data)
37
+ * Axios->>API: HTTP POST Request
38
+ * API-->>Axios: Response
39
+ * Axios-->>AxiosHttpAdapter: Response Data
40
+ * AxiosHttpAdapter-->>Client: Created Resource
41
+ *
42
+ * Client->>AxiosHttpAdapter: read(table, id)
43
+ * AxiosHttpAdapter->>AxiosHttpAdapter: url(table, {id})
44
+ * AxiosHttpAdapter->>Axios: get(url)
45
+ * Axios->>API: HTTP GET Request
46
+ * API-->>Axios: Response
47
+ * Axios-->>AxiosHttpAdapter: Response Data
48
+ * AxiosHttpAdapter-->>Client: Resource Data
49
+ */
3
50
  export class AxiosHttpAdapter extends HttpAdapter {
4
51
  constructor(native, config, alias) {
5
52
  super(native, config, AxiosFlavour, alias);
6
53
  }
54
+ /**
55
+ * @description Sends an HTTP request using Axios
56
+ * @summary Implementation of the abstract request method from HttpAdapter.
57
+ * This method uses the Axios instance to send HTTP requests with the provided configuration.
58
+ * @template V - The response value type
59
+ * @param {AxiosRequestConfig} details - The Axios request configuration
60
+ * @return {Promise<V>} A promise that resolves with the response data
61
+ */
7
62
  async request(details) {
8
63
  return this.native.request(details);
9
64
  }
65
+ /**
66
+ * @description Creates a new resource via HTTP POST
67
+ * @summary Implementation of the abstract create method from HttpAdapter.
68
+ * This method sends a POST request to the specified endpoint with the model data.
69
+ * @param {string} tableName - The name of the table or endpoint
70
+ * @param {string|number} id - The identifier for the resource (not used in URL for POST)
71
+ * @param {Record<string, any>} model - The data model to create
72
+ * @return {Promise<Record<string, any>>} A promise that resolves with the created resource
73
+ */
10
74
  async create(tableName, id, model) {
11
75
  try {
12
76
  const url = this.url(tableName);
@@ -16,6 +80,14 @@ export class AxiosHttpAdapter extends HttpAdapter {
16
80
  throw this.parseError(e);
17
81
  }
18
82
  }
83
+ /**
84
+ * @description Retrieves a resource by ID via HTTP GET
85
+ * @summary Implementation of the abstract read method from HttpAdapter.
86
+ * This method sends a GET request to the specified endpoint with the ID as a query parameter.
87
+ * @param {string} tableName - The name of the table or endpoint
88
+ * @param {string|number|bigint} id - The identifier for the resource to retrieve
89
+ * @return {Promise<Record<string, any>>} A promise that resolves with the retrieved resource
90
+ */
19
91
  async read(tableName, id) {
20
92
  try {
21
93
  const url = this.url(tableName, { id: id });
@@ -25,6 +97,15 @@ export class AxiosHttpAdapter extends HttpAdapter {
25
97
  throw this.parseError(e);
26
98
  }
27
99
  }
100
+ /**
101
+ * @description Updates an existing resource via HTTP PUT
102
+ * @summary Implementation of the abstract update method from HttpAdapter.
103
+ * This method sends a PUT request to the specified endpoint with the updated model data.
104
+ * @param {string} tableName - The name of the table or endpoint
105
+ * @param {string|number} id - The identifier for the resource (not used in URL for PUT)
106
+ * @param {Record<string, any>} model - The updated data model
107
+ * @return {Promise<Record<string, any>>} A promise that resolves with the updated resource
108
+ */
28
109
  async update(tableName, id, model) {
29
110
  try {
30
111
  const url = this.url(tableName);
@@ -34,6 +115,14 @@ export class AxiosHttpAdapter extends HttpAdapter {
34
115
  throw this.parseError(e);
35
116
  }
36
117
  }
118
+ /**
119
+ * @description Deletes a resource by ID via HTTP DELETE
120
+ * @summary Implementation of the abstract delete method from HttpAdapter.
121
+ * This method sends a DELETE request to the specified endpoint with the ID as a query parameter.
122
+ * @param {string} tableName - The name of the table or endpoint
123
+ * @param {string|number|bigint} id - The identifier for the resource to delete
124
+ * @return {Promise<Record<string, any>>} A promise that resolves with the deletion result
125
+ */
37
126
  async delete(tableName, id) {
38
127
  try {
39
128
  const url = this.url(tableName, { id: id });
@@ -43,6 +132,11 @@ export class AxiosHttpAdapter extends HttpAdapter {
43
132
  throw this.parseError(e);
44
133
  }
45
134
  }
135
+ /**
136
+ * @description Static decoration method for the AxiosHttpAdapter class
137
+ * @summary Placeholder method for class decoration functionality.
138
+ * This method is currently empty but can be used for decorator-based configuration.
139
+ */
46
140
  static decoration() { }
47
141
  }
48
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXhpb3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYXhpb3MvYXhpb3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLFlBQVksQ0FBQztBQUt6QyxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBRTNDLE1BQU0sT0FBTyxnQkFBaUIsU0FBUSxXQUtyQztJQUNDLFlBQVksTUFBYSxFQUFFLE1BQWtCLEVBQUUsS0FBYztRQUMzRCxLQUFLLENBQUMsTUFBYSxFQUFFLE1BQU0sRUFBRSxZQUFZLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDcEQsQ0FBQztJQUVRLEtBQUssQ0FBQyxPQUFPLENBQUksT0FBMkI7UUFDbkQsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUN0QyxDQUFDO0lBRUQsS0FBSyxDQUFDLE1BQU0sQ0FDVixTQUFpQixFQUNqQixFQUFtQixFQUNuQixLQUEwQjtRQUUxQixJQUFJLENBQUM7WUFDSCxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxDQUFDO1lBQ2hDLE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQ3RDLENBQUM7UUFBQyxPQUFPLENBQU0sRUFBRSxDQUFDO1lBQ2hCLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUMzQixDQUFDO0lBQ0gsQ0FBQztJQUNELEtBQUssQ0FBQyxJQUFJLENBQ1IsU0FBaUIsRUFDakIsRUFBNEI7UUFFNUIsSUFBSSxDQUFDO1lBQ0gsTUFBTSxHQUFHLEdBQUcsSUFBSSxDQUFDLEdBQUcsQ0FBQyxTQUFTLEVBQUUsRUFBRSxFQUFFLEVBQUUsRUFBcUIsRUFBRSxDQUFDLENBQUM7WUFDL0QsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUM5QixDQUFDO1FBQUMsT0FBTyxDQUFNLEVBQUUsQ0FBQztZQUNoQixNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDM0IsQ0FBQztJQUNILENBQUM7SUFFRCxLQUFLLENBQUMsTUFBTSxDQUNWLFNBQWlCLEVBQ2pCLEVBQW1CLEVBQ25CLEtBQTBCO1FBRTFCLElBQUksQ0FBQztZQUNILE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsU0FBUyxDQUFDLENBQUM7WUFDaEMsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFDckMsQ0FBQztRQUFDLE9BQU8sQ0FBTSxFQUFFLENBQUM7WUFDaEIsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQzNCLENBQUM7SUFDSCxDQUFDO0lBRUQsS0FBSyxDQUFDLE1BQU0sQ0FDVixTQUFpQixFQUNqQixFQUE0QjtRQUU1QixJQUFJLENBQUM7WUFDSCxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLFNBQVMsRUFBRSxFQUFFLEVBQUUsRUFBRSxFQUFxQixFQUFFLENBQUMsQ0FBQztZQUMvRCxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ2pDLENBQUM7UUFBQyxPQUFPLENBQU0sRUFBRSxDQUFDO1lBQ2hCLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUMzQixDQUFDO0lBQ0gsQ0FBQztJQUVELE1BQU0sQ0FBQyxVQUFVLEtBQUksQ0FBQztDQUN2QiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEh0dHBBZGFwdGVyIH0gZnJvbSBcIi4uL2FkYXB0ZXJcIjtcbmltcG9ydCB7IEF4aW9zLCBBeGlvc1JlcXVlc3RDb25maWcgfSBmcm9tIFwiYXhpb3NcIjtcbmltcG9ydCB7IEh0dHBDb25maWcgfSBmcm9tIFwiLi4vdHlwZXNcIjtcbmltcG9ydCB7IEF4aW9zRmxhZ3MgfSBmcm9tIFwiLi90eXBlc1wiO1xuaW1wb3J0IHsgQ29udGV4dCB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgQXhpb3NGbGF2b3VyIH0gZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5cbmV4cG9ydCBjbGFzcyBBeGlvc0h0dHBBZGFwdGVyIGV4dGVuZHMgSHR0cEFkYXB0ZXI8XG4gIEF4aW9zLFxuICBBeGlvc1JlcXVlc3RDb25maWcsXG4gIEF4aW9zRmxhZ3MsXG4gIENvbnRleHQ8QXhpb3NGbGFncz5cbj4ge1xuICBjb25zdHJ1Y3RvcihuYXRpdmU6IEF4aW9zLCBjb25maWc6IEh0dHBDb25maWcsIGFsaWFzPzogc3RyaW5nKSB7XG4gICAgc3VwZXIobmF0aXZlIGFzIGFueSwgY29uZmlnLCBBeGlvc0ZsYXZvdXIsIGFsaWFzKTtcbiAgfVxuXG4gIG92ZXJyaWRlIGFzeW5jIHJlcXVlc3Q8Vj4oZGV0YWlsczogQXhpb3NSZXF1ZXN0Q29uZmlnKTogUHJvbWlzZTxWPiB7XG4gICAgcmV0dXJuIHRoaXMubmF0aXZlLnJlcXVlc3QoZGV0YWlscyk7XG4gIH1cblxuICBhc3luYyBjcmVhdGUoXG4gICAgdGFibGVOYW1lOiBzdHJpbmcsXG4gICAgaWQ6IHN0cmluZyB8IG51bWJlcixcbiAgICBtb2RlbDogUmVjb3JkPHN0cmluZywgYW55PlxuICApOiBQcm9taXNlPFJlY29yZDxzdHJpbmcsIGFueT4+IHtcbiAgICB0cnkge1xuICAgICAgY29uc3QgdXJsID0gdGhpcy51cmwodGFibGVOYW1lKTtcbiAgICAgIHJldHVybiB0aGlzLm5hdGl2ZS5wb3N0KHVybCwgbW9kZWwpO1xuICAgIH0gY2F0Y2ggKGU6IGFueSkge1xuICAgICAgdGhyb3cgdGhpcy5wYXJzZUVycm9yKGUpO1xuICAgIH1cbiAgfVxuICBhc3luYyByZWFkKFxuICAgIHRhYmxlTmFtZTogc3RyaW5nLFxuICAgIGlkOiBzdHJpbmcgfCBudW1iZXIgfCBiaWdpbnRcbiAgKTogUHJvbWlzZTxSZWNvcmQ8c3RyaW5nLCBhbnk+PiB7XG4gICAgdHJ5IHtcbiAgICAgIGNvbnN0IHVybCA9IHRoaXMudXJsKHRhYmxlTmFtZSwgeyBpZDogaWQgYXMgc3RyaW5nIHwgbnVtYmVyIH0pO1xuICAgICAgcmV0dXJuIHRoaXMubmF0aXZlLmdldCh1cmwpO1xuICAgIH0gY2F0Y2ggKGU6IGFueSkge1xuICAgICAgdGhyb3cgdGhpcy5wYXJzZUVycm9yKGUpO1xuICAgIH1cbiAgfVxuXG4gIGFzeW5jIHVwZGF0ZShcbiAgICB0YWJsZU5hbWU6IHN0cmluZyxcbiAgICBpZDogc3RyaW5nIHwgbnVtYmVyLFxuICAgIG1vZGVsOiBSZWNvcmQ8c3RyaW5nLCBhbnk+XG4gICk6IFByb21pc2U8UmVjb3JkPHN0cmluZywgYW55Pj4ge1xuICAgIHRyeSB7XG4gICAgICBjb25zdCB1cmwgPSB0aGlzLnVybCh0YWJsZU5hbWUpO1xuICAgICAgcmV0dXJuIHRoaXMubmF0aXZlLnB1dCh1cmwsIG1vZGVsKTtcbiAgICB9IGNhdGNoIChlOiBhbnkpIHtcbiAgICAgIHRocm93IHRoaXMucGFyc2VFcnJvcihlKTtcbiAgICB9XG4gIH1cblxuICBhc3luYyBkZWxldGUoXG4gICAgdGFibGVOYW1lOiBzdHJpbmcsXG4gICAgaWQ6IHN0cmluZyB8IG51bWJlciB8IGJpZ2ludFxuICApOiBQcm9taXNlPFJlY29yZDxzdHJpbmcsIGFueT4+IHtcbiAgICB0cnkge1xuICAgICAgY29uc3QgdXJsID0gdGhpcy51cmwodGFibGVOYW1lLCB7IGlkOiBpZCBhcyBzdHJpbmcgfCBudW1iZXIgfSk7XG4gICAgICByZXR1cm4gdGhpcy5uYXRpdmUuZGVsZXRlKHVybCk7XG4gICAgfSBjYXRjaCAoZTogYW55KSB7XG4gICAgICB0aHJvdyB0aGlzLnBhcnNlRXJyb3IoZSk7XG4gICAgfVxuICB9XG5cbiAgc3RhdGljIGRlY29yYXRpb24oKSB7fVxufVxuIl19
142
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"axios.js","sourceRoot":"","sources":["../../../src/axios/axios.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,wBAAmB;AAKzC,OAAO,EAAE,YAAY,EAAE,uBAAoB;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAKrC;IACC,YAAY,MAAa,EAAE,MAAkB,EAAE,KAAc;QAC3D,KAAK,CAAC,MAAa,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACM,KAAK,CAAC,OAAO,CAAI,OAA2B;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,SAAiB,EACjB,EAAmB,EACnB,KAA0B;QAE1B,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,SAAiB,EACjB,EAA4B;QAE5B,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAqB,EAAE,CAAC,CAAC;YAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,SAAiB,EACjB,EAAmB,EACnB,KAA0B;QAE1B,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,SAAiB,EACjB,EAA4B;QAE5B,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAqB,EAAE,CAAC,CAAC;YAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,KAAI,CAAC;CACvB","sourcesContent":["import { HttpAdapter } from \"../adapter\";\nimport { Axios, AxiosRequestConfig } from \"axios\";\nimport { HttpConfig } from \"../types\";\nimport { AxiosFlags } from \"./types\";\nimport { Context } from \"@decaf-ts/db-decorators\";\nimport { AxiosFlavour } from \"./constants\";\n\n/**\n * @description Axios implementation of the HTTP adapter\n * @summary Concrete implementation of HttpAdapter using Axios as the HTTP client.\n * This adapter provides CRUD operations for RESTful APIs using Axios for HTTP requests.\n * @template Axios - The Axios client type\n * @template AxiosRequestConfig - The Axios request configuration type\n * @template AxiosFlags - The flags type extending HttpFlags\n * @template Context<AxiosFlags> - The context type for this adapter\n * @param {Axios} native - The Axios instance\n * @param {HttpConfig} config - Configuration for the HTTP adapter\n * @param {string} [alias] - Optional alias for the adapter\n * @class\n * @example\n * ```typescript\n * import axios from 'axios';\n * import { AxiosHttpAdapter } from '@decaf-ts/for-http';\n * \n * const config = { protocol: 'https', host: 'api.example.com' };\n * const adapter = new AxiosHttpAdapter(axios.create(), config);\n * \n * // Use the adapter with a repository\n * const userRepo = adapter.getRepository(User);\n * const user = await userRepo.findById('123');\n * ```\n * @mermaid\n * sequenceDiagram\n *   participant Client\n *   participant AxiosHttpAdapter\n *   participant Axios\n *   participant API\n *   \n *   Client->>AxiosHttpAdapter: create(table, id, data)\n *   AxiosHttpAdapter->>AxiosHttpAdapter: url(table)\n *   AxiosHttpAdapter->>Axios: post(url, data)\n *   Axios->>API: HTTP POST Request\n *   API-->>Axios: Response\n *   Axios-->>AxiosHttpAdapter: Response Data\n *   AxiosHttpAdapter-->>Client: Created Resource\n *   \n *   Client->>AxiosHttpAdapter: read(table, id)\n *   AxiosHttpAdapter->>AxiosHttpAdapter: url(table, {id})\n *   AxiosHttpAdapter->>Axios: get(url)\n *   Axios->>API: HTTP GET Request\n *   API-->>Axios: Response\n *   Axios-->>AxiosHttpAdapter: Response Data\n *   AxiosHttpAdapter-->>Client: Resource Data\n */\nexport class AxiosHttpAdapter extends HttpAdapter<\n  Axios,\n  AxiosRequestConfig,\n  AxiosFlags,\n  Context<AxiosFlags>\n> {\n  constructor(native: Axios, config: HttpConfig, alias?: string) {\n    super(native as any, config, AxiosFlavour, alias);\n  }\n\n  /**\n   * @description Sends an HTTP request using Axios\n   * @summary Implementation of the abstract request method from HttpAdapter.\n   * This method uses the Axios instance to send HTTP requests with the provided configuration.\n   * @template V - The response value type\n   * @param {AxiosRequestConfig} details - The Axios request configuration\n   * @return {Promise<V>} A promise that resolves with the response data\n   */\n  override async request<V>(details: AxiosRequestConfig): Promise<V> {\n    return this.native.request(details);\n  }\n\n  /**\n   * @description Creates a new resource via HTTP POST\n   * @summary Implementation of the abstract create method from HttpAdapter.\n   * This method sends a POST request to the specified endpoint with the model data.\n   * @param {string} tableName - The name of the table or endpoint\n   * @param {string|number} id - The identifier for the resource (not used in URL for POST)\n   * @param {Record<string, any>} model - The data model to create\n   * @return {Promise<Record<string, any>>} A promise that resolves with the created resource\n   */\n  async create(\n    tableName: string,\n    id: string | number,\n    model: Record<string, any>\n  ): Promise<Record<string, any>> {\n    try {\n      const url = this.url(tableName);\n      return this.native.post(url, model);\n    } catch (e: any) {\n      throw this.parseError(e);\n    }\n  }\n  /**\n   * @description Retrieves a resource by ID via HTTP GET\n   * @summary Implementation of the abstract read method from HttpAdapter.\n   * This method sends a GET request to the specified endpoint with the ID as a query parameter.\n   * @param {string} tableName - The name of the table or endpoint\n   * @param {string|number|bigint} id - The identifier for the resource to retrieve\n   * @return {Promise<Record<string, any>>} A promise that resolves with the retrieved resource\n   */\n  async read(\n    tableName: string,\n    id: string | number | bigint\n  ): Promise<Record<string, any>> {\n    try {\n      const url = this.url(tableName, { id: id as string | number });\n      return this.native.get(url);\n    } catch (e: any) {\n      throw this.parseError(e);\n    }\n  }\n\n  /**\n   * @description Updates an existing resource via HTTP PUT\n   * @summary Implementation of the abstract update method from HttpAdapter.\n   * This method sends a PUT request to the specified endpoint with the updated model data.\n   * @param {string} tableName - The name of the table or endpoint\n   * @param {string|number} id - The identifier for the resource (not used in URL for PUT)\n   * @param {Record<string, any>} model - The updated data model\n   * @return {Promise<Record<string, any>>} A promise that resolves with the updated resource\n   */\n  async update(\n    tableName: string,\n    id: string | number,\n    model: Record<string, any>\n  ): Promise<Record<string, any>> {\n    try {\n      const url = this.url(tableName);\n      return this.native.put(url, model);\n    } catch (e: any) {\n      throw this.parseError(e);\n    }\n  }\n\n  /**\n   * @description Deletes a resource by ID via HTTP DELETE\n   * @summary Implementation of the abstract delete method from HttpAdapter.\n   * This method sends a DELETE request to the specified endpoint with the ID as a query parameter.\n   * @param {string} tableName - The name of the table or endpoint\n   * @param {string|number|bigint} id - The identifier for the resource to delete\n   * @return {Promise<Record<string, any>>} A promise that resolves with the deletion result\n   */\n  async delete(\n    tableName: string,\n    id: string | number | bigint\n  ): Promise<Record<string, any>> {\n    try {\n      const url = this.url(tableName, { id: id as string | number });\n      return this.native.delete(url);\n    } catch (e: any) {\n      throw this.parseError(e);\n    }\n  }\n\n  /**\n   * @description Static decoration method for the AxiosHttpAdapter class\n   * @summary Placeholder method for class decoration functionality.\n   * This method is currently empty but can be used for decorator-based configuration.\n   */\n  static decoration() {}\n}\n"]}
@@ -1 +1,7 @@
1
+ /**
2
+ * @description Axios adapter flavor identifier
3
+ * @summary Constant string identifier used to identify the Axios implementation of the HTTP adapter
4
+ * @const {string} AxiosFlavour
5
+ * @memberOf module:for-http.axios
6
+ */
1
7
  export declare const AxiosFlavour = "axios";
@@ -1,2 +1,8 @@
1
+ /**
2
+ * @description Axios adapter flavor identifier
3
+ * @summary Constant string identifier used to identify the Axios implementation of the HTTP adapter
4
+ * @const {string} AxiosFlavour
5
+ * @memberOf module:for-http.axios
6
+ */
1
7
  export const AxiosFlavour = "axios";
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2F4aW9zL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLENBQUMsTUFBTSxZQUFZLEdBQUcsT0FBTyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGNvbnN0IEF4aW9zRmxhdm91ciA9IFwiYXhpb3NcIjtcbiJdfQ==
8
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2F4aW9zL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7R0FLRztBQUNILE1BQU0sQ0FBQyxNQUFNLFlBQVksR0FBRyxPQUFPLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBkZXNjcmlwdGlvbiBBeGlvcyBhZGFwdGVyIGZsYXZvciBpZGVudGlmaWVyXG4gKiBAc3VtbWFyeSBDb25zdGFudCBzdHJpbmcgaWRlbnRpZmllciB1c2VkIHRvIGlkZW50aWZ5IHRoZSBBeGlvcyBpbXBsZW1lbnRhdGlvbiBvZiB0aGUgSFRUUCBhZGFwdGVyXG4gKiBAY29uc3Qge3N0cmluZ30gQXhpb3NGbGF2b3VyXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1odHRwLmF4aW9zXG4gKi9cbmV4cG9ydCBjb25zdCBBeGlvc0ZsYXZvdXIgPSBcImF4aW9zXCI7XG4iXX0=
@@ -1,6 +1,15 @@
1
- import { AxiosHttpAdapter } from "./axios";
1
+ import { AxiosHttpAdapter } from "./axios.js";
2
+ /**
3
+ * @description HTTP client module for REST API interactions
4
+ * @summary This module provides classes and utilities for interacting with REST APIs.
5
+ * It exposes repository and service classes for making HTTP requests, along with
6
+ * type definitions and adapters for different HTTP clients. The module includes
7
+ * {@link RestRepository} and {@link RestService} for API interactions.
8
+ * @namespace axios
9
+ * @memberOf module:for-http
10
+ */
2
11
  AxiosHttpAdapter.decoration();
3
- export * from "./axios";
4
- export * from "./constants";
5
- export * from "./types";
6
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYXhpb3MvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sU0FBUyxDQUFDO0FBRTNDLGdCQUFnQixDQUFDLFVBQVUsRUFBRSxDQUFDO0FBRTlCLGNBQWMsU0FBUyxDQUFDO0FBQ3hCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsU0FBUyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQXhpb3NIdHRwQWRhcHRlciB9IGZyb20gXCIuL2F4aW9zXCI7XG5cbkF4aW9zSHR0cEFkYXB0ZXIuZGVjb3JhdGlvbigpO1xuXG5leHBvcnQgKiBmcm9tIFwiLi9heGlvc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi90eXBlc1wiO1xuIl19
12
+ export * from "./axios.js";
13
+ export * from "./constants.js";
14
+ export * from "./types.js";
15
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYXhpb3MvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGdCQUFnQixFQUFFLG1CQUFnQjtBQUUzQzs7Ozs7Ozs7R0FRRztBQUVILGdCQUFnQixDQUFDLFVBQVUsRUFBRSxDQUFDO0FBRTlCLDJCQUF3QjtBQUN4QiwrQkFBNEI7QUFDNUIsMkJBQXdCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQXhpb3NIdHRwQWRhcHRlciB9IGZyb20gXCIuL2F4aW9zXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEhUVFAgY2xpZW50IG1vZHVsZSBmb3IgUkVTVCBBUEkgaW50ZXJhY3Rpb25zXG4gKiBAc3VtbWFyeSBUaGlzIG1vZHVsZSBwcm92aWRlcyBjbGFzc2VzIGFuZCB1dGlsaXRpZXMgZm9yIGludGVyYWN0aW5nIHdpdGggUkVTVCBBUElzLlxuICogSXQgZXhwb3NlcyByZXBvc2l0b3J5IGFuZCBzZXJ2aWNlIGNsYXNzZXMgZm9yIG1ha2luZyBIVFRQIHJlcXVlc3RzLCBhbG9uZyB3aXRoXG4gKiB0eXBlIGRlZmluaXRpb25zIGFuZCBhZGFwdGVycyBmb3IgZGlmZmVyZW50IEhUVFAgY2xpZW50cy4gVGhlIG1vZHVsZSBpbmNsdWRlc1xuICoge0BsaW5rIFJlc3RSZXBvc2l0b3J5fSBhbmQge0BsaW5rIFJlc3RTZXJ2aWNlfSBmb3IgQVBJIGludGVyYWN0aW9ucy5cbiAqIEBuYW1lc3BhY2UgYXhpb3NcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Zm9yLWh0dHBcbiAqL1xuXG5BeGlvc0h0dHBBZGFwdGVyLmRlY29yYXRpb24oKTtcblxuZXhwb3J0ICogZnJvbSBcIi4vYXhpb3NcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2NvbnN0YW50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vdHlwZXNcIjtcbiJdfQ==
@@ -1,2 +1,8 @@
1
1
  import { HttpFlags } from "../types";
2
+ /**
3
+ * @description Axios-specific HTTP flags type
4
+ * @summary Type alias for HttpFlags used specifically with the Axios adapter implementation
5
+ * @typedef {HttpFlags} AxiosFlags
6
+ * @memberOf module:for-http.axios
7
+ */
2
8
  export type AxiosFlags = HttpFlags;
@@ -1,2 +1,2 @@
1
1
  export {};
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYXhpb3MvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEh0dHBGbGFncyB9IGZyb20gXCIuLi90eXBlc1wiO1xuXG5leHBvcnQgdHlwZSBBeGlvc0ZsYWdzID0gSHR0cEZsYWdzO1xuIl19
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYXhpb3MvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEh0dHBGbGFncyB9IGZyb20gXCIuLi90eXBlc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBBeGlvcy1zcGVjaWZpYyBIVFRQIGZsYWdzIHR5cGVcbiAqIEBzdW1tYXJ5IFR5cGUgYWxpYXMgZm9yIEh0dHBGbGFncyB1c2VkIHNwZWNpZmljYWxseSB3aXRoIHRoZSBBeGlvcyBhZGFwdGVyIGltcGxlbWVudGF0aW9uXG4gKiBAdHlwZWRlZiB7SHR0cEZsYWdzfSBBeGlvc0ZsYWdzXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1odHRwLmF4aW9zXG4gKi9cbmV4cG9ydCB0eXBlIEF4aW9zRmxhZ3MgPSBIdHRwRmxhZ3M7XG4iXX0=
@@ -1,5 +1,18 @@
1
+ /**
2
+ * @description HTTP client module for REST API interactions
3
+ * @summary This module provides classes and utilities for interacting with REST APIs.
4
+ * It exposes repository and service classes for making HTTP requests, along with
5
+ * type definitions and adapters for different HTTP clients. The module includes
6
+ * {@link RestRepository} and {@link RestService} for API interactions.
7
+ * @module for-http
8
+ */
1
9
  export * from "./adapter";
2
10
  export * from "./RestRepository";
3
11
  export * from "./RestService";
4
12
  export * from "./types";
5
- export declare const VERSION = "0.2.1";
13
+ /**
14
+ * @description Current version of the for-http module
15
+ * @summary Version identifier for the module
16
+ * @const VERSION
17
+ */
18
+ export declare const VERSION = "0.2.3";
package/lib/esm/index.js CHANGED
@@ -1,6 +1,19 @@
1
- export * from "./adapter";
2
- export * from "./RestRepository";
3
- export * from "./RestService";
4
- export * from "./types";
5
- export const VERSION = "0.2.1";
6
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxXQUFXLENBQUM7QUFDMUIsY0FBYyxrQkFBa0IsQ0FBQztBQUNqQyxjQUFjLGVBQWUsQ0FBQztBQUM5QixjQUFjLFNBQVMsQ0FBQztBQUV4QixNQUFNLENBQUMsTUFBTSxPQUFPLEdBQUcsYUFBYSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSBcIi4vYWRhcHRlclwiO1xuZXhwb3J0ICogZnJvbSBcIi4vUmVzdFJlcG9zaXRvcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL1Jlc3RTZXJ2aWNlXCI7XG5leHBvcnQgKiBmcm9tIFwiLi90eXBlc1wiO1xuXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IFwiIyNWRVJTSU9OIyNcIjtcbiJdfQ==
1
+ /**
2
+ * @description HTTP client module for REST API interactions
3
+ * @summary This module provides classes and utilities for interacting with REST APIs.
4
+ * It exposes repository and service classes for making HTTP requests, along with
5
+ * type definitions and adapters for different HTTP clients. The module includes
6
+ * {@link RestRepository} and {@link RestService} for API interactions.
7
+ * @module for-http
8
+ */
9
+ export * from "./adapter.js";
10
+ export * from "./RestRepository.js";
11
+ export * from "./RestService.js";
12
+ export * from "./types.js";
13
+ /**
14
+ * @description Current version of the for-http module
15
+ * @summary Version identifier for the module
16
+ * @const VERSION
17
+ */
18
+ export const VERSION = "0.2.3";
19
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7Ozs7R0FPRztBQUNILDZCQUEwQjtBQUMxQixvQ0FBaUM7QUFDakMsaUNBQThCO0FBQzlCLDJCQUF3QjtBQUV4Qjs7OztHQUlHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sT0FBTyxHQUFHLGFBQWEsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQGRlc2NyaXB0aW9uIEhUVFAgY2xpZW50IG1vZHVsZSBmb3IgUkVTVCBBUEkgaW50ZXJhY3Rpb25zXG4gKiBAc3VtbWFyeSBUaGlzIG1vZHVsZSBwcm92aWRlcyBjbGFzc2VzIGFuZCB1dGlsaXRpZXMgZm9yIGludGVyYWN0aW5nIHdpdGggUkVTVCBBUElzLlxuICogSXQgZXhwb3NlcyByZXBvc2l0b3J5IGFuZCBzZXJ2aWNlIGNsYXNzZXMgZm9yIG1ha2luZyBIVFRQIHJlcXVlc3RzLCBhbG9uZyB3aXRoXG4gKiB0eXBlIGRlZmluaXRpb25zIGFuZCBhZGFwdGVycyBmb3IgZGlmZmVyZW50IEhUVFAgY2xpZW50cy4gVGhlIG1vZHVsZSBpbmNsdWRlc1xuICoge0BsaW5rIFJlc3RSZXBvc2l0b3J5fSBhbmQge0BsaW5rIFJlc3RTZXJ2aWNlfSBmb3IgQVBJIGludGVyYWN0aW9ucy5cbiAqIEBtb2R1bGUgZm9yLWh0dHBcbiAqL1xuZXhwb3J0ICogZnJvbSBcIi4vYWRhcHRlclwiO1xuZXhwb3J0ICogZnJvbSBcIi4vUmVzdFJlcG9zaXRvcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL1Jlc3RTZXJ2aWNlXCI7XG5leHBvcnQgKiBmcm9tIFwiLi90eXBlc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBDdXJyZW50IHZlcnNpb24gb2YgdGhlIGZvci1odHRwIG1vZHVsZVxuICogQHN1bW1hcnkgVmVyc2lvbiBpZGVudGlmaWVyIGZvciB0aGUgbW9kdWxlXG4gKiBAY29uc3QgVkVSU0lPTlxuICovXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IFwiIyNWRVJTSU9OIyNcIjtcbiJdfQ==
@@ -1,8 +1,23 @@
1
1
  import { RepositoryFlags } from "@decaf-ts/db-decorators";
2
+ /**
3
+ * @description HTTP configuration type
4
+ * @summary Configuration type for HTTP connections specifying protocol and host
5
+ * @typedef {Object} HttpConfig
6
+ * @property {('http'|'https')} protocol - The HTTP protocol to use
7
+ * @property {string} host - The host address
8
+ * @memberOf module:for-http
9
+ */
2
10
  export type HttpConfig = {
3
11
  protocol: "http" | "https";
4
12
  host: string;
5
13
  };
14
+ /**
15
+ * @description HTTP flags interface
16
+ * @summary Interface extending RepositoryFlags with HTTP-specific options
17
+ * @interface HttpFlags
18
+ * @property {Record<string, string>} [headers] - Optional HTTP headers to include with requests
19
+ * @memberOf module:for-http
20
+ */
6
21
  export interface HttpFlags extends RepositoryFlags {
7
22
  headers?: Record<string, string>;
8
23
  }
package/lib/esm/types.js CHANGED
@@ -1,2 +1,2 @@
1
1
  export {};
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFJlcG9zaXRvcnlGbGFncyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG5leHBvcnQgdHlwZSBIdHRwQ29uZmlnID0ge1xuICBwcm90b2NvbDogXCJodHRwXCIgfCBcImh0dHBzXCI7XG4gIGhvc3Q6IHN0cmluZztcbn07XG5cbmV4cG9ydCBpbnRlcmZhY2UgSHR0cEZsYWdzIGV4dGVuZHMgUmVwb3NpdG9yeUZsYWdzIHtcbiAgaGVhZGVycz86IFJlY29yZDxzdHJpbmcsIHN0cmluZz47XG59XG4iXX0=
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFJlcG9zaXRvcnlGbGFncyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBIVFRQIGNvbmZpZ3VyYXRpb24gdHlwZVxuICogQHN1bW1hcnkgQ29uZmlndXJhdGlvbiB0eXBlIGZvciBIVFRQIGNvbm5lY3Rpb25zIHNwZWNpZnlpbmcgcHJvdG9jb2wgYW5kIGhvc3RcbiAqIEB0eXBlZGVmIHtPYmplY3R9IEh0dHBDb25maWdcbiAqIEBwcm9wZXJ0eSB7KCdodHRwJ3wnaHR0cHMnKX0gcHJvdG9jb2wgLSBUaGUgSFRUUCBwcm90b2NvbCB0byB1c2VcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBob3N0IC0gVGhlIGhvc3QgYWRkcmVzc1xuICogQG1lbWJlck9mIG1vZHVsZTpmb3ItaHR0cFxuICovXG5leHBvcnQgdHlwZSBIdHRwQ29uZmlnID0ge1xuICBwcm90b2NvbDogXCJodHRwXCIgfCBcImh0dHBzXCI7XG4gIGhvc3Q6IHN0cmluZztcbn07XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEhUVFAgZmxhZ3MgaW50ZXJmYWNlXG4gKiBAc3VtbWFyeSBJbnRlcmZhY2UgZXh0ZW5kaW5nIFJlcG9zaXRvcnlGbGFncyB3aXRoIEhUVFAtc3BlY2lmaWMgb3B0aW9uc1xuICogQGludGVyZmFjZSBIdHRwRmxhZ3NcbiAqIEBwcm9wZXJ0eSB7UmVjb3JkPHN0cmluZywgc3RyaW5nPn0gW2hlYWRlcnNdIC0gT3B0aW9uYWwgSFRUUCBoZWFkZXJzIHRvIGluY2x1ZGUgd2l0aCByZXF1ZXN0c1xuICogQG1lbWJlck9mIG1vZHVsZTpmb3ItaHR0cFxuICovXG5leHBvcnQgaW50ZXJmYWNlIEh0dHBGbGFncyBleHRlbmRzIFJlcG9zaXRvcnlGbGFncyB7XG4gIGhlYWRlcnM/OiBSZWNvcmQ8c3RyaW5nLCBzdHJpbmc+O1xufVxuIl19