@akinon/projectzero 1.32.0-rc.2 → 1.32.0

package/app-template/docs/data-fetching/client/misc.md

@@ -1,135 +0,0 @@
----
-title: Misc
-sidebar_label: Misc
-slug: misc
-custom_edit_url: null
----
-
-## useAutocompleteQuery
-
-This function is used to match the entered keyword in categories and products for search input. 
-
-The **useAutocompleteQuery** function is imported from `'@akinon/next/data/client/misc'`.
-
-```javascript
-import { useAutocompleteQuery } from '@akinon/next/data/client/misc';
-```
-
-To use the function, create a variable and call the function with the following properties: 
-* **debouncedSearchText**
-* **refetchOnMountOrArgChange**
-*  **skip**
-
-```javascript
-const { currentData, isFetching, isLoading } = useAutocompleteQuery(
-    debouncedSearchText,
-    {
-      refetchOnMountOrArgChange: true,
-      skip: debouncedSearchText.length < MINIMUM_SEARCH_LENGTH
-    }
-  );
-```
-For example, if searching for the keyword "**WOM**", the data returned from the function:
-
-```json
-{
-  "groups": [{
-      "entries": [{
-        "label": "WOMAN",
-        "url": "/woman/",
-        "suggestion_type": "category",
-        "extra": {
-          "category_id": 2,
-          "parent_categories": []
-        }
-      }],
-      "suggestion_type": "Category"
-    },
-    {
-      "entries": [{
-          "label": "Mini Turnlock Flap Zebra Print Clutch Bag Black",
-          "url": "/mini-turnlock-flap-zebra-print-clutch-bag-black/",
-          "suggestion_type": "product",
-          "extra": {
-            "image": "https://0fb534.cdn.akinoncloud.com/products/2022/02/02/303/ae5f3cc6-d918-4dff-bdc0-b8b397f3882f_size273x210.jpg",
-            "retail_price": 89.99,
-            "product_type": "0",
-            "price": 49.99
-          }
-        },
-        {
-          "label": "Resin Hair Clip Claw Zebra Print",
-          "url": "/resin-hair-clip-claw-zebra-print/",
-          "suggestion_type": "product",
-          "extra": {
-            "image": "https://0fb534.cdn.akinoncloud.com/products/2022/02/02/305/7374553d-151d-4cf0-b06f-45164313c959_size273x210.jpg",
-            "retail_price": 8.49,
-            "product_type": "0",
-            "price": 8.49
-          }
-        },
-        {
-          "label": "Frill Neck Mini Dress With Fluted Three Quarter Sleeves Black",
-          "url": "/frill-neck-mini-dress-with-fluted-three-quarter-sleeves-black-1/",
-          "suggestion_type": "product",
-          "extra": {
-            "image": "https://0fb534.cdn.akinoncloud.com/products/2022/04/11/274/7f470497-fb62-4c41-afe8-f3c1bc01ed37_size273x210.jpg",
-            "retail_price": 1000,
-            "product_type": "0",
-            "price": 1000
-          }
-        },
-        {
-          "label": "Wide Fit Embrace Leather High-Heeled Square Toe Boots Burgundy",
-          "url": "/wide-fit-embrace-leather-high-heeled-square-toe-boots-burgundy/",
-          "suggestion_type": "product",
-          "extra": {
-            "image": "https://0fb534.cdn.akinoncloud.com/products/2022/02/02/297/fdc50378-d570-44c0-9a69-1c16e3c15321_size273x210.jpg",
-            "retail_price": 109.99,
-            "product_type": "0",
-            "price": 99.99
-          }
-        }
-      ],
-      "suggestion_type": "Product"
-    }
-  ]
-}
-```
-
-## useGetWidgetQuery
-
-The **useGetWidgetQuery** function is used to fetch widget data in '**use client**' components. 
-
-It should be imported into the component:
-
-```javascript
-import { useGetWidgetQuery } from '@akinon/next/data/client/misc';
-```
-
-To use this function, create a variable where you specify the slug name of the widget you want to access:
-
-```javascript
-const { data } = useGetWidgetQuery('slug-name');
-```
-
-The returned data varies depending on the widget you have created.
-
-The returned data can be sent to another component as `<ComponentName data={data} />` or can be processed in the component where it is located.
-
-
-## useGetMenuQuery
-
-The **useGetMenuQuery** function is used to fetch menu data in '**use client**' components. 
-
-It should be imported into the component:
-
-```javascript
-import { useGetMenuQuery } from '@akinon/next/data/client/misc';
-```
-
-To use this function, create a variable and provide the menu level as an argument when calling the function:
-
-```javascript
-const { data: menuData, isSuccess, isFetching } = useGetMenuQuery(4);
-```

package/app-template/docs/data-fetching/client/product.md

@@ -1,284 +0,0 @@
----
-title: Product
-sidebar_label: Product
-slug: product
-custom_edit_url: null
----
-
-## useGetProductByPkQuery
-
-This function is used to fetch product data. 
-
-The **useGetProductByPkQuery** function is imported from `'@akinon/next/data/client/product'`.
-
-```javascript
-import { useGetProductByPkQuery } from '@akinon/next/data/client/product';
-```
-
-To use this function, the product's primary key (pk) needs to be provided as an argument:
-
-```javascript
-const { data, isLoading, isSuccess } = useGetProductByPkQuery(
-    item.product.pk
-  );
-```
-
-The returned data can be used as `data.product.in_stock`. 
-
-Data returned from the function:
-
-```json
-{
-  "in_stock": true,
-  "product": {
-    "pk": 154,
-    "name": "Product Name",
-    "sku": "AKN-002-starprint001-XS",
-    "base_code": "AKN-002",
-    "attributes": {
-      ...
-    },
-    "attribute_set": 6,
-    "attributes_kwargs": {
-      ...
-    },
-    "extra_attributes": {},
-    "productimage_set": [{
-      "pk": 201,
-      "status": "active",
-      "image": "https://img-url.jpg",
-      "order": 0,
-      "created_date": "2022-12-30T07:43:17.590001Z",
-      "specialimage_set": []
-    }],
-    "price": "29.99",
-    "in_stock": true,
-    "currency_type": "eur",
-    "retail_price": "29.99",
-    "unit_type": "qty",
-    "absolute_url": "/product-url/",
-    "productvideo_set": [],
-    "product_type": "0",
-    "price_type": "default",
-    "form_schema": null,
-    "is_ready_to_basket": false,
-    "stock": 968,
-    "data_source": null,
-    "basket_offers": []
-  },
-  "variants": [{
-    ...
-  }],
-  "selected_variant": null
-}
-```
-
-## useGetInstallmentsQuery
-
-This function is used to fetch installment payment information available in banks for a product's purchase. 
-
-The **useGetInstallmentsQuery** function is imported from `'@akinon/next/data/client/product'`.
-
-```javascript
-import { useGetInstallmentsQuery } from '@akinon/next/data/client/product';
-```
-
-To use this function, the productPk needs to be provided as an argument:
-
-```javascript
-const { data, isLoading, isSuccess } = useGetInstallmentsQuery(productPk);
-```
-
-Data returned from the function:
-
-```json
-{
-  "count": 1,
-  "next": null,
-  "previous": null,
-  "results": [{
-    "pk": 1,
-    "name": "Other",
-    "bank": {
-      "pk": 1,
-      "name": "Other",
-      "slug": "other",
-      "logo": "https://0fb534.cdn.akinoncloud.com/banks/2023/01/17/be59a98c-00f6-486d-be4e-e3451ea3e970.jpg"
-    },
-    "card_type": {
-      "pk": 1,
-      "name": "Other",
-      "slug": "other",
-      "logo": "https://0fb534.cdn.akinoncloud.com/card_types/2021/12/17/4c22a73e-cd2a-423a-af7f-9078690ada89.jpg"
-    },
-    "card_payment_type": "credit",
-    "cash_payment": 1,
-    "installment_payment": 1,
-    "slug": "other",
-    "three_d_payment": 1,
-    "is_commerce_card": false,
-    "installments": [{
-        "pk": 1,
-        "card": 1,
-        "installment_count": 1,
-        "label": "1",
-        "interest_rate": "0.000000",
-        "is_active": true,
-        "config": {},
-        "translations": null,
-        "amount": 19.49,
-        "interest_amount": 0,
-        "single_installment_amount": 19.49,
-        "total_amount": 19.49
-      },
-      {
-        "pk": 2,
-        "card": 1,
-        "installment_count": 2,
-        "label": "2",
-        "interest_rate": "0.010000",
-        "is_active": true,
-        "config": {},
-        "translations": null,
-        "amount": 19.49,
-        "interest_amount": 0.2,
-        "single_installment_amount": 9.85,
-        "total_amount": 19.69
-      },
-      {
-        "pk": 3,
-        "card": 1,
-        "installment_count": 3,
-        "label": "3",
-        "interest_rate": "0.050000",
-        "is_active": true,
-        "config": {},
-        "translations": null,
-        "amount": 19.49,
-        "interest_amount": 0.98,
-        "single_installment_amount": 6.83,
-        "total_amount": 20.47
-      }
-    ]
-  }]
-}
-```
-
-## useGetProductByParamsQuery
-
-This function is used to fetch product and variants information, selected_variant, and in_stock status without navigating to the product details page.
-
-The **useGetProductByParamsQuery** function is imported from `'@akinon/next/data/client/product'`.
-
-```javascript
-import { useGetProductByParamsQuery } from '@akinon/next/data/client/product';
-```
-
-To use this function, the productPk needs to be provided as an argument:
-
-```javascript
-const { data, isFetching, isSuccess } = useGetProductByParamsQuery({ pk });
-```
-
-Data returned from the function:
-
-```json
-{
-	"in_stock": true,
-	"product": {
-		"pk": 123456,
-		"name": "Product Name",
-		"sku": "123456",
-		"base_code": "123456",
-		"attributes": {
-			...
-		},
-		"attribute_set": 12,
-		"attributes_kwargs": {
-			...
-		},
-		"extra_attributes": {},
-		"productimage_set": [{
-			...
-		}],
-		"price": "15",
-		"in_stock": true,
-		"currency_type": "aed",
-		"retail_price": "15",
-		"unit_type": "qty",
-		"absolute_url": "/product-url/",
-		"productvideo_set": [],
-		"product_type": "0",
-		"price_type": "default",
-		"form_schema": null,
-		"is_ready_to_basket": false,
-		"stock": 319,
-		"data_source": null,
-		"basket_offers": []
-	},
-	"variants": [{
-			"attribute_key": "color",
-			"attribute_name": "Color",
-			"options": [{
-				"is_selected": true,
-				"is_selectable": true,
-				"is_selectable_without_stock": true,
-				"in_stock": true,
-				"order": "0",
-				"label": "Pink",
-				"value": "Pink",
-				"product": {
-					...
-				}
-			}]
-		},
-		{
-			"attribute_key": "size",
-			"attribute_name": "Size",
-			"options": [{
-				"is_selected": true,
-				"is_selectable": true,
-				"is_selectable_without_stock": true,
-				"in_stock": true,
-				"order": "5020",
-				"label": "236ML",
-				"value": "236ML",
-				"product": {
-					...
-				}
-			}]
-		}
-	],
-	"selected_variant": {
-		"pk": 123456,
-		"name": "Product name",
-		"sku": "123456",
-		"base_code": "123456",
-		"attributes": {
-			...
-		},
-		"attribute_set": 12,
-		"attributes_kwargs": {
-			...
-		},
-		"extra_attributes": {},
-		"productimage_set": [{
-			...
-		}],
-		"price": "15",
-		"in_stock": true,
-		"currency_type": "usd",
-		"retail_price": "15",
-		"unit_type": "qty",
-		"absolute_url": "/product-url",
-		"productvideo_set": [],
-		"product_type": "0",
-		"price_type": "default",
-		"form_schema": null,
-		"is_ready_to_basket": false,
-		"stock": 319,
-		"data_source": null
-	}
-
-}
-```

package/app-template/docs/data-fetching/client/user.md

@@ -1,56 +0,0 @@
----
-title: User
-sidebar_label: User
-slug: user
-custom_edit_url: null
----
-
-## useGetCaptchaQuery
-
-To  use this function, the **useCaptcha** function from **@akinon/next/hooks** needs to be imported.
-
-```javascript
-import { useCaptcha } from '@akinon/next/hooks';
-```
-
-The **useCaptcha** function provides the following variables: 
-* **view**
-* **validated**
-*  **isVisible**
-* **validate**
-
-These variables and the view for Captcha is obtained by using the **useCaptcha()** function, and then the variables are defined as shown below:
-
-```javascript
-const {
-	CaptchaView,
-	validated: captchaValidated,
-	isVisible: isCaptchaVisible,
-	validate: validateCaptcha
-} = useCaptcha();
-```
-
-The view obtained from the Captcha can be placed where you want as `<CaptchaView data-testid="login-captcha" />`.
-
-The **isCaptchaVisible** variable is used to show or hide the captcha. When using this variable, it should be checked whether the captcha is validated with **!captchaValidated** before use.
-
-```javascript
-{isCaptchaVisible && !captchaValidated}
-```
-
-Data returned from function:
-
-```json
-{
-	CaptchaView: async ()=> {
-		length: 1,
-		name: "View",
-	},
-  validated: false,
-  isVisible: false,
-  validate: async ()=> {
-    length: 0
-		name: "validate"
-  }
-}
-```

package/app-template/docs/data-fetching/client/wishlist.md

@@ -1,111 +0,0 @@
----
-title: Wishlist
-sidebar_label: Wishlist
-slug: wishlist
-custom_edit_url: null
----
-
-## useGetFavoritesQuery
-
-This function is used to fetch a list of favorite products. 
-
-The **useGetFavoritesQuery** function is imported from `'@akinon/next/data/client/wishlist'`.
-
-```javascript
-import { useGetFavoritesQuery } from '@akinon/next/data/client/wishlist';
-```
-
-To fetch the list of favorite products, create a variable and call the function:
-
-```javascript
-  const { data: favorites } = useGetFavoritesQuery({
-    page: Number(searchParams.get('page')),
-    limit: Number(searchParams.get('limit'))
-  });
-```
-
-Following parameters can be sent to the function:
-
--   **page**: This value is used for pagination, indicating the page the user is currently on.
--   **limit**: It determines the limit of products on page the user is currently on.
-
-Data returned from function:
-
--   **count**: It provides the total number of products that have been added to favorites.
--   **next**: This is used for pagination. If a user is on page 2, it contains the URL of page 3.
--   **previous**: This is used for pagination. If a user is on page 2, it contains the URL of page 1.
-
-```json
-{
-  "count": 1,
-  "next": null,
-  "previous": null,
-  "results": [{
-    "pk": 12,
-    "product": {
-      "pk": 39,
-      "name": "Product Name",
-      "sku": "000000",
-      "base_code": "000000",
-      "attributes": {
-        ...
-      },
-      "attribute_set": 1,
-      "attributes_kwargs": {
-        ...
-      },
-      "extra_attributes": {},
-      "productimage_set": [{
-        "status": "active",
-        "image": "https://image-url.jpg",
-        "created_date": "2023-04-18T09:52:55.333304Z",
-        "specialimage_set": [],
-        "pk": 312,
-        "order": 4
-      }],
-      "price": "59",
-      "in_stock": true,
-      "currency_type": "aed",
-      "retail_price": "85",
-      "unit_type": "qty",
-      "absolute_url": "/product-url/",
-      "productvideo_set": [],
-      "product_type": "0",
-      "price_type": "default",
-      "form_schema": null,
-      "is_ready_to_basket": false,
-      "stock": 80,
-      "data_source": null,
-      "basket_offers": [{
-        ...
-      }],
-      "extra_data": {
-        "variants": [{
-          "attribute_key": "color",
-          "options": [{
-            "product": {
-              "absolute_url": "/url",
-              "price": "59",
-              "attributes": {
-                ...
-              },
-              "pk": 31,
-              "productimage_set": [{
-                "status": "active",
-                "image": "https://image-url.jpg",
-                "created_date": "2023-04-18T09:52:55.333304Z",
-                "specialimage_set": [],
-                "pk": 312,
-                "order": 4
-              }]
-            },
-            "in_stock": true,
-            "is_selectable": true,
-            "label": "Green"
-          }]
-        }]
-      }
-    }
-  }]
-}
-```