Merge 32d1506 into 8f6c1b0

vuestorefront · Mar 17, 2021 · b7bf455 · b7bf455
2 parents 8f6c1b0 + 32d1506
commit b7bf455
Show file tree

Hide file tree

Showing 13 changed files with 5,894 additions and 6,256 deletions.
diff --git a/packages/core/docs/commercetools/api-client-reference.md b/packages/core/docs/commercetools/api-client-reference.md
diff --git a/packages/core/docs/commercetools/composables/use-cart.md b/packages/core/docs/commercetools/composables/use-cart.md
@@ -87,10 +87,7 @@ type ProductVariant = {
   attributeList: Array<Attribute>;
 }
 
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
   
 - `updateItemQty` - function for updating quantity of a product that is already in the cart. This method accepts a single `params` object. The `params` has the following options:
@@ -133,10 +130,7 @@ type LineItem = {
   customFieldList?: Maybe<Array<CustomField>>;
 }
 
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
   
 - `removeItem` - function for removing a product that currently is in the cart. This method accepts a single `params` object. The `params` has the following options:
@@ -177,13 +171,10 @@ type LineItem = {
   customFieldList?: Maybe<Array<CustomField>>;
 }
 
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
   
-- `isOnCart` - function for checking if a product is currently in the cart. This method accepts a single `params` object. The `params` has the following option:
+- `isInCart` - function for checking if a product is currently in the cart. This method accepts a single `params` object. The `params` has the following option:
 
     - `product: ProductVariant`
     
@@ -213,10 +204,7 @@ type ProductVariant = {
     - `customQuery?: CustomQuery`
     
 ```ts
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
   
 - `removeCoupon` - function for removing coupon applied to cart. This method accepts a single `params` object. The `params` has the following options:
@@ -233,10 +221,7 @@ interface AgnosticCoupon {
   value: number;
 }
 
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
   
 - `loading: boolean` - a reactive object containing information about loading state of the cart.

diff --git a/packages/core/docs/commercetools/composables/use-category.md b/packages/core/docs/commercetools/composables/use-category.md
@@ -16,10 +16,7 @@
     - `customQuery?: CustomQuery` 
 
 ```ts
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
 
 - `categories: Category[]` - a main data object that contains an array of categories fetched by `search` method.

diff --git a/packages/core/docs/commercetools/composables/use-product.md b/packages/core/docs/commercetools/composables/use-product.md
@@ -25,10 +25,7 @@ interface ProductsSearchParams {
   id?: string;
 }
 
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
 - `products: ProductVariant[]` - a main data object that contains an array of products fetched by `search` method.
 
@@ -121,6 +118,21 @@ interface AgnosticAttribute {
   label: string;
 }
 
+type ProductVariant = {
+  __typename?: "ProductVariant";
+  id: Scalars["Int"];
+  key?: Maybe<Scalars["String"]>;
+  sku?: Maybe<Scalars["String"]>;
+  prices?: Maybe<Array<ProductPrice>>;
+  price?: Maybe<ProductPrice>;
+  images: Array<Image>;
+  assets: Array<Asset>;
+  availability?: Maybe<ProductVariantAvailabilityWithChannels>;
+  attributesRaw: Array<RawProductAttribute>;
+  attributes: ProductType;
+  attributeList: Array<Attribute>;
+}
+
 interface ProductVariantFilters {
   master?: boolean;
   attributes?: Record<string, string>;

diff --git a/packages/core/docs/commercetools/composables/use-review.md b/packages/core/docs/commercetools/composables/use-review.md
@@ -18,19 +18,23 @@
 
   - `searchParams: ReviewSearchParams`
 
+  - `customQuery?: CustomQuery`
+
 ```typescript
 interface ReviewSearchParams {
   productId: string;
   limit?: number;
   offset?: number;
 }
+
+type CustomQuery = Record<string, string>
 ```
 
 - `addReview` - function for posting new review. When invoked, it submits data to the API and populates `reviews` property with updated information. This method accepts a single params object. The `params` has the following options:
 
   - `params: ReviewAddParams`
   
-  - `customQueryFn?: CustomQueryFn`
+  - `customQuery?: CustomQuery`
 
 ```typescript
 interface ReviewAddParams {
@@ -46,10 +50,7 @@ interface ReviewDraft {
   rating: number;
 }
 
-type CustomQueryFn = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
 
 - `reviews: Review[]` - reactive data object containing the response from the backend.

diff --git a/packages/core/docs/commercetools/composables/use-user-billing.md b/packages/core/docs/commercetools/composables/use-user-billing.md
@@ -18,7 +18,7 @@
 
     - `address: BillingAddressAddParams`
 
-    - `customQueryFn?: CustomQueryFn`
+    - `customQuery?`
 
 ```typescript
 interface BillingAddressAddParams {
@@ -35,37 +35,27 @@ interface BillingAddressAddParams {
     isDefault?: boolean;
   }
 }
-
-type CustomQueryFn = (query, variables) => {
-  query?;
-  variables?;
-}
 ```
 
 - `deleteAddress` - function for deleting existing billing address. This method accepts a single `params` object. The `params` has the following options:
 
     - `address: BillingAddressDeleteParams`
 
-    - `customQueryFn?: CustomQueryFn`
+    - `customQuery?`
 
 ```typescript
 interface BillingAddressDeleteParams {
   address: {
     id: string;
   }
 }
-
-type CustomQueryFn = (query, variables) => {
-  query?;
-  variables?;
-}
 ```
 
 - `updateAddress` - function for updating existing billing address. This method accepts a single `params` object. The `params` has the following options:
 
     - `address: BillingAddressUpdateParams`
 
-    - `customQueryFn?: CustomQueryFn`
+    - `customQuery?`
 
 ```typescript
 interface BillingAddressUpdateParams {
@@ -83,30 +73,20 @@ interface BillingAddressUpdateParams {
     isDefault?: boolean;
   }
 }
-
-type CustomQueryFn = (query, variables) => {
-  query?;
-  variables?;
-}
 ```
 
 - `setDefaultAddress` - function for settings an existing billing address as default. This method accepts a single `params` object. The `params` has the following options:
 
     - `address: BillingAddressSetDefaultParams`
 
-    - `customQueryFn?: CustomQueryFn`
+    - `customQuery?`
 
 ```typescript
 interface BillingAddressSetDefaultParams {
   address: {
     id: string;
   }
 }
-
-type CustomQueryFn = (query, variables) => {
-  query?;
-  variables?;
-}
 ```
 - `billing: User` - reactive data object containing response from the backend.
 

diff --git a/packages/core/docs/commercetools/composables/use-user-order.md b/packages/core/docs/commercetools/composables/use-user-order.md
@@ -19,10 +19,7 @@ type OrderSearchParams = {
   perPage?: number;
 }
 
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
 
 - `orders: Order[]` -  a main data object that contains an array of orders fetched by `searchOrders` method.

diff --git a/packages/core/docs/commercetools/composables/use-user-shipping.md b/packages/core/docs/commercetools/composables/use-user-shipping.md
@@ -18,7 +18,7 @@
 
     - `address: ShippingAddressAddParams`
 
-    - `customQueryFn?: CustomQueryFn`
+    - `customQuery?`
 
 ```typescript
 interface ShippingAddressAddParams {
@@ -35,37 +35,27 @@ interface ShippingAddressAddParams {
     isDefault?: boolean;
   }
 }
-
-type CustomQueryFn = (query, variables) => {
-  query?;
-  variables?;
-}
 ```
 
 - `deleteAddress` - function for deleting existing shipping address. This method accepts a single `params` object. The `params` has the following options:
 
     - `address: ShippingAddressDeleteParams`
 
-    - `customQueryFn?: CustomQueryFn`
+    - `customQuery?`
 
 ```typescript
 interface ShippingAddressDeleteParams {
   address: {
     id: string;
   }
 }
-
-type CustomQueryFn = (query, variables) => {
-  query?;
-  variables?;
-}
 ```
 
 - `updateAddress` - function for updating existing shipping address. This method accepts a single `params` object. The `params` has the following options:
 
     - `address: ShippingAddressUpdateParams`
 
-    - `customQueryFn?: CustomQueryFn`
+    - `customQuery?`
 
 ```typescript
 interface ShippingAddressUpdateParams {
@@ -83,30 +73,20 @@ interface ShippingAddressUpdateParams {
     isDefault?: boolean;
   }
 }
-
-type CustomQueryFn = (query, variables) => {
-  query?;
-  variables?;
-}
 ```
 
 - `setDefaultAddress` - function for settings an existing shipping address as default. This method accepts a single `params` object. The `params` has the following options:
 
     - `address: ShippingAddressSetDefaultParams`
 
-    - `customQueryFn?: CustomQueryFn`
+    - `customQuery?
 
 ```typescript
 interface ShippingAddressSetDefaultParams {
   address: {
     id: string;
   }
 }
-
-type CustomQueryFn = (query, variables) => {
-  query?;
-  variables?;
-}
 ```
 
 - `shipping: User` - reactive data object containing response from the backend.

diff --git a/packages/core/docs/commercetools/composables/use-wishlist.md b/packages/core/docs/commercetools/composables/use-wishlist.md
@@ -48,10 +48,7 @@ type Wishlist = ShoppingList;
     - `customQuery?: CustomQuery`
 
 ```ts
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
 
 - `addItem` - function used to add new product to wishlist. When invoked, it submits data to the API and populates `wishlist` property with updated information. This method accepts a single `params` object. The `params` has the following options:
@@ -76,10 +73,7 @@ type ProductVariant = {
   attributeList: Array<Attribute>;
 }
 
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
 
 - `removeItem` - function that removes products from the wishlist. It submits data to the API and populates updated `wishlist` property. This method accepts a single `params` object. The `params` has the following options:
@@ -120,15 +114,12 @@ type LineItem = {
   customFieldList?: Maybe<Array<CustomField>>;
 }
 
-type CustomQuery = (query, variables) => {
-  query?;
-  variables?;
-}
+type CustomQuery = Record<string, string>
 ```
 
 - `clear` - function that removes all products from the wishlist and populates clear `wishlist` property.
 
-- `isOnWishlist` - function that checks if product is on the wishlist. It returns boolean value. This method accepts a single `params` object. The `params` has the following option:
+- `isInWishlist` - function that checks if product is on the wishlist. It returns boolean value. This method accepts a single `params` object. The `params` has the following option:
 
   - `product: ProductVariant`
   

diff --git a/packages/core/docs/package.json b/packages/core/docs/package.json
@@ -7,8 +7,8 @@
   "scripts": {
     "dev": "vuepress dev",
     "build": "vuepress build",
-    "ct-api-client-tdoc": "node ./scripts/generateCtApiRef",
-    "ct-api-client-gen": "concat-md --join-string '' ./commercetools/api-client-reference > ./commercetools/api-client-reference.md && rm -r ./commercetools/api-client-reference && node typedoc-vsf-theme/removeText"
+    "ct-api-client-tdoc": "node ./scripts/generateCtApiRef && rm -r ./commercetools/api-client-reference/enums && rm -r ./commercetools/api-client-reference/README.md && mv ./commercetools/api-client-reference/modules ./commercetools/api-client-reference/1modules",
+    "ct-api-client-gen": "concat-md --join-string '' ./commercetools/api-client-reference/ > ./commercetools/api-client-reference.md && node typedoc-vsf-theme/removeText && rm -r ./commercetools/api-client-reference"
   },
   "devDependencies": {
     "@vue-storefront/commercetools-api": "^1.2.0-rc.1",

diff --git a/packages/core/docs/typedoc-vsf-theme/helpers/helpers.js b/packages/core/docs/typedoc-vsf-theme/helpers/helpers.js
@@ -1,7 +1,13 @@
 const Handlebars = require('handlebars');
 
+const re = /(api\/|types\/)/g;
+
 Handlebars.registerHelper('split', (string) => {
-  const re = /(api\/|types\/)/g;
   if (string.search(re) !== -1) return string.split('/')[1];
   else return string;
 });
+
+Handlebars.registerHelper('heading', (string) => {
+  if (string.search(re) !== -1) return '##';
+  else return '###';
+});
diff --git a/packages/core/docs/typedoc-vsf-theme/partials/title.hbs b/packages/core/docs/typedoc-vsf-theme/partials/title.hbs
@@ -1 +1 @@
-## `{{ model.name }}`
+{{ heading model.name }} `{{ split model.name }}`