@waywake/wdt-sdk 0.1.0 → 0.1.2
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 +16 -0
- package/dist/body.d.ts +1 -1
- package/dist/body.d.ts.map +1 -1
- package/dist/case.d.ts +4 -4
- package/dist/case.d.ts.map +1 -1
- package/dist/client.d.ts +10 -5
- package/dist/client.d.ts.map +1 -1
- package/dist/endpoint-types.d.ts +13655 -0
- package/dist/endpoint-types.d.ts.map +1 -0
- package/dist/endpoints.d.ts +373 -372
- package/dist/endpoints.d.ts.map +1 -1
- package/dist/error.d.ts +1 -1
- package/dist/index.d.ts +8 -7
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -4
- package/dist/index.js.map +6 -6
- package/dist/types.d.ts +16 -5
- package/dist/types.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -43,6 +43,22 @@ await client.api.settingWarehouseQueryWarehouse(
|
|
|
43
43
|
);
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
+
Generated endpoint helpers return endpoint-specific request and response types:
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
import type { WdtSettingStrategyVirtualWarehouseQueryData } from "@waywake/wdt-sdk";
|
|
50
|
+
|
|
51
|
+
const response = await client.api.settingStrategyVirtualWarehouseQuery(
|
|
52
|
+
{},
|
|
53
|
+
{ pager: { pageNo: 0, pageSize: 100 } },
|
|
54
|
+
);
|
|
55
|
+
|
|
56
|
+
const data: WdtSettingStrategyVirtualWarehouseQueryData | undefined = response.data;
|
|
57
|
+
console.log(data?.detailList[0]?.sysWarehouseList?.[0]?.warehouseNo);
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
You can still override the response `data` type with a generic when your project keeps a narrower domain model.
|
|
61
|
+
|
|
46
62
|
Request and response objects use `camelCase` in TypeScript. The SDK converts request keys to `snake_case` before sending and converts response keys back to `camelCase`.
|
|
47
63
|
|
|
48
64
|
For positional body APIs, pass an array:
|
package/dist/body.d.ts
CHANGED
package/dist/body.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"body.d.ts","sourceRoot":"","sources":["../src/body.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"body.d.ts","sourceRoot":"","sources":["../src/body.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAS/D"}
|
package/dist/case.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import type { DeepCamel, DeepSnake
|
|
1
|
+
import type { DeepCamel, DeepSnake } from "./types.js";
|
|
2
2
|
export declare function toSnakeCase(key: string): string;
|
|
3
3
|
export declare function toCamelCase(key: string): string;
|
|
4
|
-
export declare function isPlainObject(value: unknown): value is
|
|
5
|
-
export declare function keysToSnakeCase<T
|
|
6
|
-
export declare function keysToCamelCase<T
|
|
4
|
+
export declare function isPlainObject(value: unknown): value is Record<string, unknown>;
|
|
5
|
+
export declare function keysToSnakeCase<T>(value: T): DeepSnake<T>;
|
|
6
|
+
export declare function keysToCamelCase<T>(value: T): DeepCamel<T>;
|
|
7
7
|
//# sourceMappingURL=case.d.ts.map
|
package/dist/case.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"case.d.ts","sourceRoot":"","sources":["../src/case.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,
|
|
1
|
+
{"version":3,"file":"case.d.ts","sourceRoot":"","sources":["../src/case.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAIpD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK/C;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE9E;AAED,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAEzD;AAED,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAEzD"}
|
package/dist/client.d.ts
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
|
-
import { type WdtEndpointMap, type WdtMethod } from "./endpoints";
|
|
2
|
-
import { type WdtSignedRequest } from "./sign";
|
|
3
|
-
import type {
|
|
1
|
+
import { type WdtEndpointMap, type WdtMethod } from "./endpoints.js";
|
|
2
|
+
import { type WdtSignedRequest } from "./sign.js";
|
|
3
|
+
import type { WdtApiResponse, WdtCallOptions, WdtClientOptions, WdtEndpointMeta, WdtRequestBody } from "./types.js";
|
|
4
4
|
type PascalSegment<S extends string> = Capitalize<Uncapitalize<S>>;
|
|
5
5
|
type PascalDotted<S extends string> = S extends `${infer Head}.${infer Tail}` ? `${PascalSegment<Head>}${PascalDotted<Tail>}` : PascalSegment<S>;
|
|
6
6
|
export type WdtMethodAlias<S extends string> = S extends `${infer Head}.${infer Tail}` ? `${Uncapitalize<Head>}${PascalDotted<Tail>}` : Uncapitalize<S>;
|
|
7
|
+
export interface WdtApiHelper<M extends WdtMethod> {
|
|
8
|
+
(request?: WdtEndpointMap[M]["request"], options?: WdtCallOptions): Promise<WdtEndpointMap[M]["response"]>;
|
|
9
|
+
<TData extends object>(request?: WdtEndpointMap[M]["request"], options?: WdtCallOptions): Promise<WdtApiResponse<TData>>;
|
|
10
|
+
}
|
|
7
11
|
export type WdtApiHelpers = {
|
|
8
|
-
[M in WdtMethod as WdtMethodAlias<M>]:
|
|
12
|
+
[M in WdtMethod as WdtMethodAlias<M>]: WdtApiHelper<M>;
|
|
9
13
|
};
|
|
10
14
|
export interface PreparedWdtRequest {
|
|
11
15
|
url: string;
|
|
@@ -23,7 +27,8 @@ export declare class WdtClient {
|
|
|
23
27
|
private readonly defaultThrowOnApiError;
|
|
24
28
|
private readonly timestampProvider?;
|
|
25
29
|
constructor(options: WdtClientOptions);
|
|
26
|
-
call<M extends WdtMethod>(method: M, request?: WdtEndpointMap[M]["request"], options?: WdtCallOptions): Promise<
|
|
30
|
+
call<M extends WdtMethod>(method: M, request?: WdtEndpointMap[M]["request"], options?: WdtCallOptions): Promise<WdtEndpointMap[M]["response"]>;
|
|
31
|
+
call<TData extends object>(method: string, request?: WdtRequestBody, options?: WdtCallOptions): Promise<WdtApiResponse<TData>>;
|
|
27
32
|
call(method: string, request?: WdtRequestBody, options?: WdtCallOptions): Promise<WdtApiResponse>;
|
|
28
33
|
prepareRequest(method: string, request?: WdtRequestBody, options?: WdtCallOptions): PreparedWdtRequest;
|
|
29
34
|
getEndpoint(method: WdtMethod): WdtEndpointMeta;
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiB,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAEjF,OAAO,EAAkB,KAAK,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAC/D,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiB,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAEjF,OAAO,EAAkB,KAAK,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAC/D,OAAO,KAAK,EAEV,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,eAAe,EAEf,cAAc,EACf,MAAM,SAAS,CAAC;AAIjB,KAAK,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GACzE,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,EAAE,GAC7C,aAAa,CAAC,CAAC,CAAC,CAAC;AAErB,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GAClF,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,EAAE,GAC5C,YAAY,CAAC,CAAC,CAAC,CAAC;AAEpB,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,SAAS;IAC/C,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3G,CAAC,KAAK,SAAS,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;CAC1H;AAED,MAAM,MAAM,aAAa,GAAG;KACzB,CAAC,IAAI,SAAS,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED,qBAAa,SAAS;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;IAE5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAU;IACjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAe;gBAEtC,OAAO,EAAE,gBAAgB;IAYrC,IAAI,CAAC,CAAC,SAAS,SAAS,EACtB,MAAM,EAAE,CAAC,EACT,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACzC,IAAI,CAAC,KAAK,SAAS,MAAM,EACvB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,cAAc,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBjG,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,EAAE,OAAO,GAAE,cAAmB,GAAG,kBAAkB;IAmC1G,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,eAAe;CAGhD;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,SAAS,CAEpE;AAYD,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQrD"}
|