npm - @waywake/wdt-sdk - Versions diffs - 0.1.0 - Mend

@waywake/wdt-sdk 0.1.0

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.

Files changed (20) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,84 @@
+# @waywake/wdt-sdk
+TypeScript SDK for 旺店通旗舰版 OpenAPI, built with Bun.
+## Install
+```bash
+bun add @waywake/wdt-sdk
+```
+## Usage
+```ts
+import { WdtClient } from "@waywake/wdt-sdk";
+const client = new WdtClient({
+  sid: process.env.WDT_SID!,
+  appKey: process.env.WDT_APP_KEY!,
+  appSecret: process.env.WDT_APP_SECRET!,
+  baseUrl: process.env.WDT_BASE_URL,
+});
+const response = await client.call(
+  "setting.Warehouse.queryWarehouse",
+  {
+    startTime: "2020-01-01 00:00:00",
+    endTime: "2020-01-20 00:00:00",
+  },
+  {
+    pager: { pageNo: 0, pageSize: 100, calcTotal: true },
+  },
+);
+console.log(response.data?.totalCount);
+```
+Every public API method from the API list is available as a typed method string and as an `api` helper:
+```ts
+await client.api.settingWarehouseQueryWarehouse(
+  { startTime: "2020-01-01 00:00:00", endTime: "2020-01-20 00:00:00" },
+  { pager: { pageNo: 0, pageSize: 100, calcTotal: true } },
+);
+```
+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`.
+For positional body APIs, pass an array:
+```ts
+await client.call("wms.stockout.Sales.weighingExt", [
+  "xc109393939393939",
+  "",
+  1.2,
+  0,
+  false,
+]);
+```
+## Docs
+- 接口规范: <https://open.wangdian.cn/qjb/open/guide?path=qjbguide_jkgf>
+- Sign算法: <https://open.wangdian.cn/qjb/open/guide?path=qjbguide_signsf>
+- API列表: <https://open.wangdian.cn/qjb/open/apidoc>
+## Development
+```bash
+bun install
+bun run generate:endpoints
+bun test
+bun run build
+```
+Live integration tests are disabled by default. To run them:
+```bash
+WDT_INTEGRATION=1 \
+WDT_BASE_URL='https://example.com/openapi' \
+WDT_SID='your-sid' \
+WDT_APP_KEY='your-app-key' \
+WDT_APP_SECRET='...' \
+bun test
+```

package/dist/body.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import type { WdtRequestBody } from "./types";
+export declare function createRequestBody(input: WdtRequestBody): string;
+//# sourceMappingURL=body.d.ts.map

package/dist/body.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"body.d.ts","sourceRoot":"","sources":["../src/body.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAa,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAS/D"}

package/dist/case.d.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import type { DeepCamel, DeepSnake, JsonObject, JsonValue } from "./types";
+export declare function toSnakeCase(key: string): string;
+export declare function toCamelCase(key: string): string;
+export declare function isPlainObject(value: unknown): value is JsonObject;
+export declare function keysToSnakeCase<T extends JsonValue | undefined>(value: T): DeepSnake<T>;
+export declare function keysToCamelCase<T extends JsonValue | undefined>(value: T): DeepCamel<T>;
+//# sourceMappingURL=case.d.ts.map

package/dist/case.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"case.d.ts","sourceRoot":"","sources":["../src/case.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAa,UAAU,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAItF,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,UAAU,CAEjE;AAED,wBAAgB,eAAe,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAEvF;AAED,wBAAgB,eAAe,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAEvF"}

package/dist/client.d.ts ADDED Viewed

@@ -0,0 +1,34 @@
+import { type WdtEndpointMap, type WdtMethod } from "./endpoints";
+import { type WdtSignedRequest } from "./sign";
+import type { DeepCamel, WdtApiResponse, WdtCallOptions, WdtClientOptions, WdtEndpointMeta, WdtRequestBody } from "./types";
+type PascalSegment<S extends string> = Capitalize<Uncapitalize<S>>;
+type PascalDotted<S extends string> = S extends `${infer Head}.${infer Tail}` ? `${PascalSegment<Head>}${PascalDotted<Tail>}` : PascalSegment<S>;
+export type WdtMethodAlias<S extends string> = S extends `${infer Head}.${infer Tail}` ? `${Uncapitalize<Head>}${PascalDotted<Tail>}` : Uncapitalize<S>;
+export type WdtApiHelpers = {
+    [M in WdtMethod as WdtMethodAlias<M>]: (request?: WdtEndpointMap[M]["request"], options?: WdtCallOptions) => Promise<DeepCamel<WdtEndpointMap[M]["response"]>>;
+};
+export interface PreparedWdtRequest {
+    url: string;
+    init: RequestInit;
+    signed: WdtSignedRequest;
+}
+export declare class WdtClient {
+    readonly sid: string;
+    readonly appKey: string;
+    readonly appSecret: string;
+    readonly baseUrl: string;
+    readonly version: string;
+    readonly api: WdtApiHelpers;
+    private readonly fetchImpl;
+    private readonly defaultThrowOnApiError;
+    private readonly timestampProvider?;
+    constructor(options: WdtClientOptions);
+    call<M extends WdtMethod>(method: M, request?: WdtEndpointMap[M]["request"], options?: WdtCallOptions): Promise<DeepCamel<WdtEndpointMap[M]["response"]>>;
+    call(method: string, request?: WdtRequestBody, options?: WdtCallOptions): Promise<WdtApiResponse>;
+    prepareRequest(method: string, request?: WdtRequestBody, options?: WdtCallOptions): PreparedWdtRequest;
+    getEndpoint(method: WdtMethod): WdtEndpointMeta;
+}
+export declare function createWdtClient(options: WdtClientOptions): WdtClient;
+export declare function aliasForMethod(method: string): string;
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map ADDED Viewed

@@ -0,0 +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,EACV,SAAS,EAET,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,MAAM,aAAa,GAAG;KACzB,CAAC,IAAI,SAAS,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,CACrC,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EACtC,OAAO,CAAC,EAAE,cAAc,KACrB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,UAAU,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,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IACpD,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"}