@shopware/api-client 0.4.0 → 0.5.0

package/README.md

@@ -29,13 +29,13 @@ Recommended practice is to create separate module file. For example `src/apiClie
 import { createAPIClient } from "@shopware/api-client";
 
 // You can pick types of your current API version, the default one:
-import {
+import type {
   operationPaths,
   operations,
   components,
 } from "@shopware/api-client/api-types";
 // or (specific version):
-import {
+import type {
   operationPaths,
   operations,
   components,
@@ -82,7 +82,7 @@ import {
   RequestReturnType,
   createAdminAPIClient,
 } from "@shopware/api-client";
-import {
+import type {
   operationPaths,
   operations,
   components,
@@ -186,24 +186,24 @@ try {
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-client-next/CHANGELOG.md)
 
-### Latest changes: 0.4.0
+### Latest changes: 0.5.0
 
 ### Minor Changes
 
-- [#371](https://github.com/shopware/frontends/pull/371) [`83c94e9b`](https://github.com/shopware/frontends/commit/83c94e9bb609533c4a1275cbf3822b0fc2ea1dd5) Thanks [@patzick](https://github.com/patzick)! - New method `createAdminAPIClient` supporting Admin API 🅰🅿🅸
-
-- [#373](https://github.com/shopware/frontends/pull/373) [`5510bb02`](https://github.com/shopware/frontends/commit/5510bb028b1fea4c63d677850f50bb7b5a1cf01a) Thanks [@patzick](https://github.com/patzick)! - Added `getSessionData` and `setSessionData` methods in admin API client for test purposes.
+- [#435](https://github.com/shopware/frontends/pull/435) [`a4483ed8`](https://github.com/shopware/frontends/commit/a4483ed8bf9370e87aedeb81846fe9d31880b3e0) Thanks [@patzick](https://github.com/patzick)! - Changed types imports to `import type {...} from "..."`
 
 ### Patch Changes
 
-- [#385](https://github.com/shopware/frontends/pull/385) [`5d7e7973`](https://github.com/shopware/frontends/commit/5d7e7973437a4d74d19ec2fa0765c6d927bf8b2a) Thanks [@patzick](https://github.com/patzick)! - Dependency changes:
-
-  - Changed dependency _ofetch_ from **^1.2.1** to **^1.3.3**
+- [#443](https://github.com/shopware/frontends/pull/443) [`33d54db1`](https://github.com/shopware/frontends/commit/33d54db1bd66146a14781c45b1124547f4276866) Thanks [@patzick](https://github.com/patzick)! - `invoke` method parameters are no longer mandatory when no parameters are defined inside route.
 
-- [#375](https://github.com/shopware/frontends/pull/375) [`bd88d6fa`](https://github.com/shopware/frontends/commit/bd88d6fa95de2b90f8a1e08e34159b46c5932b3b) Thanks [@patzick](https://github.com/patzick)! - Dependency changes:
+  Now instead of:
 
-  - Changed dependency _ofetch_ from **^1.1.1** to **^1.2.1**
+  ```ts
+  const result = await apiInstance.invoke("readContext get /context", {});
+  ```
 
-- [`15d6e696`](https://github.com/shopware/frontends/commit/15d6e69616bd9bc5ad32f2a5f697e00c45a94784) Thanks [@patzick](https://github.com/patzick)! - Emit cjs bundle
+  you can do:
 
-- [#371](https://github.com/shopware/frontends/pull/371) [`83c94e9b`](https://github.com/shopware/frontends/commit/83c94e9bb609533c4a1275cbf3822b0fc2ea1dd5) Thanks [@patzick](https://github.com/patzick)! - Deprecated `apiType` param in `createAPIClient`, for Admin API client use `createAdminAPIClient` instead.
+  ```ts
+  const result = await apiInstance.invoke("readContext get /context");
+  ```

package/dist/index.cjs

@@ -85,6 +85,9 @@ function transformPathToQuery(path, params) {
     headers,
     query
   };
+  if (!params) {
+    return [requestPathWithParams, returnOptions];
+  }
   Object.keys(params).forEach((key) => {
     if (!pathParams.includes(key) && !queryParamNames.includes(key) && !headerParamnames.includes(key)) {
       returnOptions.body ?? (returnOptions.body = {});
@@ -116,10 +119,10 @@ function createAPIClient(params) {
       errorInterceptor(response);
     }
   });
-  async function invoke(pathParam, params2) {
+  async function invoke(pathParam, ...params2) {
     const [requestPath, options] = transformPathToQuery(
       pathParam,
-      params2
+      params2?.[0]
     );
     return apiFetch(
       requestPath,

package/dist/index.d.cts

@@ -66316,7 +66316,25 @@ declare function createAPIClient<OPERATIONS extends Operations = operations$1, P
     contextToken?: string;
     onContextChanged?: (newContextToken: string) => void;
 }): {
-    invoke: <INVOKE_PATH extends PATHS, OON = INVOKE_PATH extends `${infer R} ${string}` ? R : never, OPERATION_NAME extends keyof OPERATIONS = OON extends keyof OPERATIONS ? OON : never>(pathParam: INVOKE_PATH extends string ? INVOKE_PATH : never, params: RequestParameters<OPERATION_NAME, OPERATIONS>) => Promise<GetInferKey<GetInferKey<GetInferKey<GetInferKey<OPERATIONS[OPERATION_NAME], "responses">, "200">, "content">, "application/json">>;
+    invoke: <INVOKE_PATH extends PATHS, OON = INVOKE_PATH extends `${infer R} ${string}` ? R : never, OPERATION_NAME extends keyof OPERATIONS = OON extends keyof OPERATIONS ? OON : never>(pathParam: INVOKE_PATH extends string ? INVOKE_PATH : never, ...params: keyof (OPERATIONS[OPERATION_NAME] extends {
+        parameters?: {
+            query?: infer R_1 | undefined;
+        } | undefined;
+    } ? R_1 : {}) | keyof (OPERATIONS[OPERATION_NAME] extends {
+        parameters?: {
+            path?: infer R_2 | undefined;
+        } | undefined;
+    } ? R_2 : {}) | keyof (OPERATIONS[OPERATION_NAME] extends {
+        requestBody?: {
+            content?: {
+                "application/json"?: infer R_3 | undefined;
+            } | undefined;
+        } | undefined;
+    } ? R_3 : {}) | keyof (OPERATIONS[OPERATION_NAME] extends {
+        parameters?: {
+            header?: infer R_4 | undefined;
+        } | undefined;
+    } ? R_4 : {}) extends never ? [(Record<PropertyKey, never> | undefined)?] : [RequestParameters<OPERATION_NAME, OPERATIONS>]) => Promise<GetInferKey<GetInferKey<GetInferKey<GetInferKey<OPERATIONS[OPERATION_NAME], "responses">, "200">, "content">, "application/json">>;
 };
 /**
  * Session data entity for admin API client.

package/dist/index.d.mts

@@ -66316,7 +66316,25 @@ declare function createAPIClient<OPERATIONS extends Operations = operations$1, P
     contextToken?: string;
     onContextChanged?: (newContextToken: string) => void;
 }): {
-    invoke: <INVOKE_PATH extends PATHS, OON = INVOKE_PATH extends `${infer R} ${string}` ? R : never, OPERATION_NAME extends keyof OPERATIONS = OON extends keyof OPERATIONS ? OON : never>(pathParam: INVOKE_PATH extends string ? INVOKE_PATH : never, params: RequestParameters<OPERATION_NAME, OPERATIONS>) => Promise<GetInferKey<GetInferKey<GetInferKey<GetInferKey<OPERATIONS[OPERATION_NAME], "responses">, "200">, "content">, "application/json">>;
+    invoke: <INVOKE_PATH extends PATHS, OON = INVOKE_PATH extends `${infer R} ${string}` ? R : never, OPERATION_NAME extends keyof OPERATIONS = OON extends keyof OPERATIONS ? OON : never>(pathParam: INVOKE_PATH extends string ? INVOKE_PATH : never, ...params: keyof (OPERATIONS[OPERATION_NAME] extends {
+        parameters?: {
+            query?: infer R_1 | undefined;
+        } | undefined;
+    } ? R_1 : {}) | keyof (OPERATIONS[OPERATION_NAME] extends {
+        parameters?: {
+            path?: infer R_2 | undefined;
+        } | undefined;
+    } ? R_2 : {}) | keyof (OPERATIONS[OPERATION_NAME] extends {
+        requestBody?: {
+            content?: {
+                "application/json"?: infer R_3 | undefined;
+            } | undefined;
+        } | undefined;
+    } ? R_3 : {}) | keyof (OPERATIONS[OPERATION_NAME] extends {
+        parameters?: {
+            header?: infer R_4 | undefined;
+        } | undefined;
+    } ? R_4 : {}) extends never ? [(Record<PropertyKey, never> | undefined)?] : [RequestParameters<OPERATION_NAME, OPERATIONS>]) => Promise<GetInferKey<GetInferKey<GetInferKey<GetInferKey<OPERATIONS[OPERATION_NAME], "responses">, "200">, "content">, "application/json">>;
 };
 /**
  * Session data entity for admin API client.

package/dist/index.d.ts

@@ -66316,7 +66316,25 @@ declare function createAPIClient<OPERATIONS extends Operations = operations$1, P
     contextToken?: string;
     onContextChanged?: (newContextToken: string) => void;
 }): {
-    invoke: <INVOKE_PATH extends PATHS, OON = INVOKE_PATH extends `${infer R} ${string}` ? R : never, OPERATION_NAME extends keyof OPERATIONS = OON extends keyof OPERATIONS ? OON : never>(pathParam: INVOKE_PATH extends string ? INVOKE_PATH : never, params: RequestParameters<OPERATION_NAME, OPERATIONS>) => Promise<GetInferKey<GetInferKey<GetInferKey<GetInferKey<OPERATIONS[OPERATION_NAME], "responses">, "200">, "content">, "application/json">>;
+    invoke: <INVOKE_PATH extends PATHS, OON = INVOKE_PATH extends `${infer R} ${string}` ? R : never, OPERATION_NAME extends keyof OPERATIONS = OON extends keyof OPERATIONS ? OON : never>(pathParam: INVOKE_PATH extends string ? INVOKE_PATH : never, ...params: keyof (OPERATIONS[OPERATION_NAME] extends {
+        parameters?: {
+            query?: infer R_1 | undefined;
+        } | undefined;
+    } ? R_1 : {}) | keyof (OPERATIONS[OPERATION_NAME] extends {
+        parameters?: {
+            path?: infer R_2 | undefined;
+        } | undefined;
+    } ? R_2 : {}) | keyof (OPERATIONS[OPERATION_NAME] extends {
+        requestBody?: {
+            content?: {
+                "application/json"?: infer R_3 | undefined;
+            } | undefined;
+        } | undefined;
+    } ? R_3 : {}) | keyof (OPERATIONS[OPERATION_NAME] extends {
+        parameters?: {
+            header?: infer R_4 | undefined;
+        } | undefined;
+    } ? R_4 : {}) extends never ? [(Record<PropertyKey, never> | undefined)?] : [RequestParameters<OPERATION_NAME, OPERATIONS>]) => Promise<GetInferKey<GetInferKey<GetInferKey<GetInferKey<OPERATIONS[OPERATION_NAME], "responses">, "200">, "content">, "application/json">>;
 };
 /**
  * Session data entity for admin API client.

package/dist/index.mjs

@@ -83,6 +83,9 @@ function transformPathToQuery(path, params) {
     headers,
     query
   };
+  if (!params) {
+    return [requestPathWithParams, returnOptions];
+  }
   Object.keys(params).forEach((key) => {
     if (!pathParams.includes(key) && !queryParamNames.includes(key) && !headerParamnames.includes(key)) {
       returnOptions.body ?? (returnOptions.body = {});
@@ -114,10 +117,10 @@ function createAPIClient(params) {
       errorInterceptor(response);
     }
   });
-  async function invoke(pathParam, params2) {
+  async function invoke(pathParam, ...params2) {
     const [requestPath, options] = transformPathToQuery(
       pathParam,
-      params2
+      params2?.[0]
     );
     return apiFetch(
       requestPath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware/api-client",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Shopware client for API connection.",
   "author": "Shopware",
   "repository": {
@@ -42,9 +42,9 @@
     "@vitest/coverage-c8": "^0.33.0",
     "prettier": "^3.0.3",
     "unbuild": "^2.0.0",
-    "vitest": "^0.34.3",
-    "@shopware/api-gen": "0.0.7",
-    "eslint-config-shopware": "0.0.6",
+    "vitest": "^0.34.6",
+    "@shopware/api-gen": "0.1.0",
+    "eslint-config-shopware": "0.0.7",
     "tsconfig": "0.0.0"
   },
   "dependencies": {