@pdg/api 1.0.19 → 1.0.21
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.
- package/README.md +1 -1
- package/dist/Api/Api.d.ts +12 -6
- package/dist/Api/Api.types.d.ts +18 -9
- package/dist/index.esm.js +10 -5
- package/dist/index.js +10 -5
- package/package.json +4 -5
package/README.md
CHANGED
package/dist/Api/Api.d.ts
CHANGED
|
@@ -1,12 +1,18 @@
|
|
|
1
1
|
import { Method } from 'axios';
|
|
2
2
|
import { ApiRequestData, ApiOption, ApiRequestOption } from './Api.types';
|
|
3
|
-
declare class Api<T = any> {
|
|
3
|
+
declare class Api<T = any, D extends ApiRequestData = {}> {
|
|
4
4
|
option: ApiOption;
|
|
5
|
+
/********************************************************************************************************************
|
|
6
|
+
* constructor
|
|
7
|
+
* ******************************************************************************************************************/
|
|
5
8
|
constructor(option: ApiOption<T>);
|
|
6
|
-
get(path: string, data?:
|
|
7
|
-
post(path: string, data?:
|
|
8
|
-
patch(path: string, data?:
|
|
9
|
-
delete(path: string, data?:
|
|
10
|
-
|
|
9
|
+
get(path: string, data?: D, option?: ApiRequestOption): Promise<T>;
|
|
10
|
+
post(path: string, data?: D, option?: ApiRequestOption): Promise<T>;
|
|
11
|
+
patch(path: string, data?: D, option?: ApiRequestOption): Promise<T>;
|
|
12
|
+
delete(path: string, data?: D, option?: ApiRequestOption): Promise<T>;
|
|
13
|
+
/********************************************************************************************************************
|
|
14
|
+
* run
|
|
15
|
+
* ******************************************************************************************************************/
|
|
16
|
+
run: (method: Method, path: string, data?: D, option?: ApiRequestOption) => Promise<T>;
|
|
11
17
|
}
|
|
12
18
|
export default Api;
|
package/dist/Api/Api.types.d.ts
CHANGED
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { AxiosRequestConfig, AxiosResponse, InternalAxiosRequestConfig, ResponseType } from 'axios';
|
|
2
|
+
/********************************************************************************************************************
|
|
3
|
+
* ApiRequestData, ApiRequestOption, ApiRequestConfig
|
|
4
|
+
* ******************************************************************************************************************/
|
|
2
5
|
export interface ApiRequestData {
|
|
3
6
|
[key: string]: any;
|
|
4
7
|
}
|
|
@@ -7,28 +10,34 @@ export interface ApiRequestOption {
|
|
|
7
10
|
rawResponseType?: ResponseType;
|
|
8
11
|
silent?: boolean;
|
|
9
12
|
}
|
|
10
|
-
export interface ApiRequestConfig extends AxiosRequestConfig {
|
|
13
|
+
export interface ApiRequestConfig<D = ApiRequestData> extends AxiosRequestConfig<D> {
|
|
11
14
|
silent?: boolean;
|
|
12
15
|
}
|
|
13
|
-
|
|
16
|
+
/********************************************************************************************************************
|
|
17
|
+
* ApiError
|
|
18
|
+
* ******************************************************************************************************************/
|
|
19
|
+
export declare class ApiError<T = any, D = ApiRequestData> extends Error {
|
|
14
20
|
code?: string;
|
|
15
|
-
config?: ApiRequestConfig
|
|
21
|
+
config?: ApiRequestConfig<D>;
|
|
16
22
|
baseUrl?: string;
|
|
17
23
|
path?: string;
|
|
18
|
-
requestData?:
|
|
24
|
+
requestData?: D;
|
|
19
25
|
requestOption?: ApiRequestOption;
|
|
20
|
-
response?: AxiosResponse<T>;
|
|
26
|
+
response?: AxiosResponse<T, D>;
|
|
21
27
|
status?: number;
|
|
22
28
|
isAxiosError: boolean;
|
|
23
29
|
constructor(message?: string, code?: string);
|
|
24
30
|
}
|
|
25
|
-
|
|
31
|
+
/********************************************************************************************************************
|
|
32
|
+
* ApiOption
|
|
33
|
+
* ******************************************************************************************************************/
|
|
34
|
+
export interface ApiOption<T = any, D = ApiRequestData> {
|
|
26
35
|
baseUrl: string;
|
|
27
36
|
timeParamName: string;
|
|
28
37
|
withCredentials?: boolean;
|
|
29
38
|
headers?: AxiosRequestConfig['headers'];
|
|
30
|
-
onRequest?(config: InternalAxiosRequestConfig
|
|
31
|
-
onResponse?(response: AxiosResponse<T>, config: AxiosRequestConfig
|
|
32
|
-
onError?(err: ApiError): void;
|
|
39
|
+
onRequest?(config: InternalAxiosRequestConfig<D>, baseUrl: string, path: string, requestData?: D, requestOption?: ApiRequestOption): Promise<InternalAxiosRequestConfig<D>>;
|
|
40
|
+
onResponse?(response: AxiosResponse<T, D>, config: AxiosRequestConfig<D>, baseUrl: string, path: string, requestData?: D, requestOption?: ApiRequestOption): Promise<T>;
|
|
41
|
+
onError?(err: ApiError<T, D>): void;
|
|
33
42
|
dataKeysToLowerCase?: boolean;
|
|
34
43
|
}
|
package/dist/index.esm.js
CHANGED
|
@@ -81,7 +81,9 @@ function __generator(thisArg, body) {
|
|
|
81
81
|
typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
|
|
82
82
|
var e = new Error(message);
|
|
83
83
|
return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
|
|
84
|
-
}
|
|
84
|
+
};/********************************************************************************************************************
|
|
85
|
+
* ApiError
|
|
86
|
+
* ******************************************************************************************************************/
|
|
85
87
|
var ApiError = /** @class */ (function (_super) {
|
|
86
88
|
__extends(ApiError, _super);
|
|
87
89
|
function ApiError(message, code) {
|
|
@@ -94,10 +96,14 @@ var ApiError = /** @class */ (function (_super) {
|
|
|
94
96
|
}(Error));var _a;
|
|
95
97
|
var AxiosCreate = axios.create ? axios.create : (_a = require('axios').default) === null || _a === void 0 ? void 0 : _a.create;
|
|
96
98
|
var Api = /** @class */ (function () {
|
|
97
|
-
|
|
99
|
+
/********************************************************************************************************************
|
|
100
|
+
* constructor
|
|
101
|
+
* ******************************************************************************************************************/
|
|
98
102
|
function Api(option) {
|
|
99
103
|
var _this = this;
|
|
100
|
-
|
|
104
|
+
/********************************************************************************************************************
|
|
105
|
+
* run
|
|
106
|
+
* ******************************************************************************************************************/
|
|
101
107
|
this.run = function (method, path, data, option) {
|
|
102
108
|
return new Promise(function (resolve, reject) {
|
|
103
109
|
var _a;
|
|
@@ -187,8 +193,7 @@ var Api = /** @class */ (function () {
|
|
|
187
193
|
.then(function (res) {
|
|
188
194
|
var resData = res.data;
|
|
189
195
|
if (_this.option.onResponse) {
|
|
190
|
-
_this.option
|
|
191
|
-
.onResponse(res, requestConfig, _this.option.baseUrl, path, data, option)
|
|
196
|
+
_this.option.onResponse(res, requestConfig, _this.option.baseUrl, path, data, option)
|
|
192
197
|
.then(function (finalResData) {
|
|
193
198
|
resolve(finalResData);
|
|
194
199
|
})
|
package/dist/index.js
CHANGED
|
@@ -81,7 +81,9 @@ function __generator(thisArg, body) {
|
|
|
81
81
|
typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
|
|
82
82
|
var e = new Error(message);
|
|
83
83
|
return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
|
|
84
|
-
}
|
|
84
|
+
};/********************************************************************************************************************
|
|
85
|
+
* ApiError
|
|
86
|
+
* ******************************************************************************************************************/
|
|
85
87
|
var ApiError = /** @class */ (function (_super) {
|
|
86
88
|
__extends(ApiError, _super);
|
|
87
89
|
function ApiError(message, code) {
|
|
@@ -94,10 +96,14 @@ var ApiError = /** @class */ (function (_super) {
|
|
|
94
96
|
}(Error));var _a;
|
|
95
97
|
var AxiosCreate = axios.create ? axios.create : (_a = require('axios').default) === null || _a === void 0 ? void 0 : _a.create;
|
|
96
98
|
var Api = /** @class */ (function () {
|
|
97
|
-
|
|
99
|
+
/********************************************************************************************************************
|
|
100
|
+
* constructor
|
|
101
|
+
* ******************************************************************************************************************/
|
|
98
102
|
function Api(option) {
|
|
99
103
|
var _this = this;
|
|
100
|
-
|
|
104
|
+
/********************************************************************************************************************
|
|
105
|
+
* run
|
|
106
|
+
* ******************************************************************************************************************/
|
|
101
107
|
this.run = function (method, path, data, option) {
|
|
102
108
|
return new Promise(function (resolve, reject) {
|
|
103
109
|
var _a;
|
|
@@ -187,8 +193,7 @@ var Api = /** @class */ (function () {
|
|
|
187
193
|
.then(function (res) {
|
|
188
194
|
var resData = res.data;
|
|
189
195
|
if (_this.option.onResponse) {
|
|
190
|
-
_this.option
|
|
191
|
-
.onResponse(res, requestConfig, _this.option.baseUrl, path, data, option)
|
|
196
|
+
_this.option.onResponse(res, requestConfig, _this.option.baseUrl, path, data, option)
|
|
192
197
|
.then(function (finalResData) {
|
|
193
198
|
resolve(finalResData);
|
|
194
199
|
})
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pdg/api",
|
|
3
3
|
"title": "API Module",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.21",
|
|
5
5
|
"description": "API Module",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"types": "dist/index.d.ts",
|
|
@@ -35,9 +35,9 @@
|
|
|
35
35
|
"typescript",
|
|
36
36
|
"javascript"
|
|
37
37
|
],
|
|
38
|
-
"
|
|
39
|
-
"@pdg/util": "
|
|
40
|
-
"axios": "
|
|
38
|
+
"dependencies": {
|
|
39
|
+
"@pdg/util": "^1.0.24",
|
|
40
|
+
"axios": "^1.9.0"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@eslint/js": "^9.24.0",
|
|
@@ -56,7 +56,6 @@
|
|
|
56
56
|
"rollup": "^4.39.0",
|
|
57
57
|
"rollup-plugin-delete": "^2.2.0",
|
|
58
58
|
"rollup-plugin-peer-deps-external": "^2.2.4",
|
|
59
|
-
"rollup-plugin-scss": "^4.0.1",
|
|
60
59
|
"rollup-plugin-typescript2": "^0.36.0",
|
|
61
60
|
"typescript": "^5.8.3"
|
|
62
61
|
}
|