@akinon/projectzero 1.32.0 → 1.33.0

package/app-template/docs/data-fetching/server/menu.md

@@ -0,0 +1,363 @@
+---
+title: Menu
+sidebar_label: Menu
+slug: menu
+custom_edit_url: null
+---
+
+## getMenu
+
+This function is used to fetch the data for menus created in Omnitron. 
+
+The **getMenu** function is imported from `'@akinon/next/data/server'`.
+
+```javascript
+import { getMenu } from '@akinon/next/data/server';
+```
+
+The menu data is fetched by defining this function as `const response = await getMenu({ depth: 4 });`.
+
+-   `depth`: This parameter determines how many levels of menu data should be retrieved. It is optional and defaults to 3. It should be of type Number.
+-   `parent`: This parameter is used to fetch the submenus of a specific menu by providing the pk value of the parent menu. If this parameter is not provided, menu data is retrieved from level 0 up to the specified depth. It should be of type String.
+
+Data returned from the function:
+
+```json
+{
+    "menu": [
+        {
+            "label": "Women",
+            "url": "/women",
+            "level": 0,
+            "pk": "3cbf2ed2-04ef-4f78-ba37-194491cbd645",
+            "sort_order": 0,
+            "path": "00010001",
+            "parent_pk": null,
+            "parent": null,
+            "generator_name": "menu_item",
+            "extra_context": {
+                "attributes": {
+                    "shop_by_activity_title": {
+                        "value": "Shop By Activity",
+                        "kwargs": {}
+                    },
+                    "category_countdown": {
+                        "value": {
+                            "slug": "countdown-banner-women",
+                            "is_countdown_active": "True"
+                        },
+                        "kwargs": {
+                            "data_type": "nested",
+                            "value": {
+                                "is_countdown_active": {
+                                    "data_type": "dropdown",
+                                    "value": "True"
+                                }
+                            }
+                        }
+                    },
+                    "best_sellers": [
+                        {
+                            "value": {
+                                "url": "#",
+                                "image": "cms/2023/07/13/c97efc07-4275-4c1c-a656-b27cb8084faa.jpg"
+                            },
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {
+                                    "image": {
+                                        "url": "https://akn-randb.a-cdn.akinoncloud.com/cms/2023/07/13/c97efc07-4275-4c1c-a656-b27cb8084faa.jpg",
+                                        "data_type": "image",
+                                        "value": "cms/2023/07/13/c97efc07-4275-4c1c-a656-b27cb8084faa.jpg"
+                                    }
+                                }
+                            }
+                        }
+                    ],
+                    "shop_by_activity": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ],
+                    "css_class": {
+                        "value": "bg-[#EAE0A0]",
+                        "kwargs": {}
+                    },
+                    "images": [
+                        {
+                            "value": {
+                                "url": "#",
+                                "image": "cms/2023/07/21/3fad3f63-ca24-4b92-b7d6-94da5d2ae0fe.jpg",
+                                "title": null
+                            },
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {
+                                    "image": {
+                                        "url": "https://akn-randb.a-cdn.akinoncloud.com/cms/2023/07/21/3fad3f63-ca24-4b92-b7d6-94da5d2ae0fe.jpg",
+                                        "data_type": "image",
+                                        "value": "cms/2023/07/21/3fad3f63-ca24-4b92-b7d6-94da5d2ae0fe.jpg"
+                                    }
+                                }
+                            }
+                        }
+                    ],
+                    "best_sellers_title": {
+                        "value": "Best Sellers",
+                        "kwargs": {}
+                    },
+                    "category_id": 2,
+                    "festival_edit": [
+                        {
+                            "value": {
+                                "url": "#",
+                                "alt": "Summer Collection",
+                                "image": "cms/2023/07/07/14bacc14-c036-484e-b30e-0d9b94007790.jpg"
+                            },
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {
+                                    "image": {
+                                        "url": "https://akn-randb.a-cdn.akinoncloud.com/cms/2023/07/07/14bacc14-c036-484e-b30e-0d9b94007790.jpg",
+                                        "data_type": "image",
+                                        "value": "cms/2023/07/07/14bacc14-c036-484e-b30e-0d9b94007790.jpg"
+                                    }
+                                }
+                            }
+                        }
+                    ],
+                    "festival_edit_title": {
+                        "value": "Festival Edit",
+                        "kwargs": {}
+                    }
+                },
+                "numchild": 7,
+                "include_parent": false
+            }
+        },
+        {
+            "label": "Men",
+            "url": "/men",
+            "level": 0,
+            "pk": "a98bafbc-32d5-4a59-8a85-5d849980a2b6",
+            "sort_order": 1,
+            "path": "00010002",
+            "parent_pk": null,
+            "parent": null,
+            "generator_name": "menu_item",
+            "extra_context": {
+                "attributes": {
+                    "category_countdown": {
+                        "value": {
+                            "slug": "countdown-banner-men",
+                            "is_countdown_active": "True"
+                        },
+                        "kwargs": {
+                            "data_type": "nested",
+                            "value": {
+                                "is_countdown_active": {
+                                    "data_type": "dropdown",
+                                    "value": "True"
+                                }
+                            }
+                        }
+                    },
+                    "best_sellers": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ],
+                    "shop_by_activity": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ],
+                    "images": [
+                        {
+                            "value": {
+                                "url": "#",
+                                "image": "cms/2023/07/20/8649ff5e-a114-4cf4-bb8a-22547e7ab795.jpg"
+                            },
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {
+                                    "image": {
+                                        "url": "https://akn-randb.a-cdn.akinoncloud.com/cms/2023/07/20/8649ff5e-a114-4cf4-bb8a-22547e7ab795.jpg",
+                                        "data_type": "image",
+                                        "value": "cms/2023/07/20/8649ff5e-a114-4cf4-bb8a-22547e7ab795.jpg"
+                                    }
+                                }
+                            }
+                        }
+                    ],
+                    "category_id": 3,
+                    "festival_edit": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ]
+                },
+                "numchild": 4,
+                "include_parent": false
+            }
+        },
+        {
+            "label": "Kids",
+            "url": "/kids",
+            "level": 0,
+            "pk": "b58ca68a-3d44-4585-a4ea-b37d18a60da3",
+            "sort_order": 2,
+            "path": "00010003",
+            "parent_pk": null,
+            "parent": null,
+            "generator_name": "menu_item",
+            "extra_context": {
+                "attributes": {
+                    "category_countdown": {
+                        "value": {
+                            "slug": "countdown-banner-kids",
+                            "is_countdown_active": "True"
+                        },
+                        "kwargs": {
+                            "data_type": "nested",
+                            "value": {
+                                "is_countdown_active": {
+                                    "data_type": "dropdown",
+                                    "value": "True"
+                                }
+                            }
+                        }
+                    },
+                    "best_sellers": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ],
+                    "shop_by_activity": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ],
+                    "images": [
+                        {
+                            "value": {
+                                "url": "#",
+                                "image": "cms/2023/07/24/b4191bde-4b8e-4143-8ac4-e21310a173e9.jpg"
+                            },
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {
+                                    "image": {
+                                        "url": "https://akn-randb.a-cdn.akinoncloud.com/cms/2023/07/24/b4191bde-4b8e-4143-8ac4-e21310a173e9.jpg",
+                                        "data_type": "image",
+                                        "value": "cms/2023/07/24/b4191bde-4b8e-4143-8ac4-e21310a173e9.jpg"
+                                    }
+                                }
+                            }
+                        }
+                    ],
+                    "category_id": 4,
+                    "festival_edit": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ]
+                },
+                "numchild": 10,
+                "include_parent": false
+            }
+        },
+        {
+            "label": "Home",
+            "url": "/home/",
+            "level": 0,
+            "pk": "4e2dd206-a909-46ee-8c53-b494d12aaba1",
+            "sort_order": 3,
+            "path": "00010004",
+            "parent_pk": null,
+            "parent": null,
+            "generator_name": "menu_item",
+            "extra_context": {
+                "attributes": {
+                    "images": [
+                        {
+                            "value": {
+                                "url": "#",
+                                "image": "cms/2023/07/24/59b08b1d-4105-4c28-a113-f1b94a445935.jpg"
+                            },
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {
+                                    "image": {
+                                        "url": "https://akn-randb.a-cdn.akinoncloud.com/cms/2023/07/24/59b08b1d-4105-4c28-a113-f1b94a445935.jpg",
+                                        "data_type": "image",
+                                        "value": "cms/2023/07/24/59b08b1d-4105-4c28-a113-f1b94a445935.jpg"
+                                    }
+                                }
+                            }
+                        }
+                    ],
+                    "best_sellers": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ],
+                    "shop_by_activity": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ],
+                    "festival_edit": [
+                        {
+                            "value": {},
+                            "kwargs": {
+                                "data_type": "nested",
+                                "value": {}
+                            }
+                        }
+                    ],
+                    "category_id": 5
+                },
+                "numchild": 4,
+                "include_parent": false
+            }
+        }
+    ]
+}
+```

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

@@ -0,0 +1,131 @@
+---
+title: Product
+sidebar_label: Product
+slug: product
+custom_edit_url: null
+---
+
+## getProductData
+
+This function is used to fetch product data and related breadcrumb data. 
+
+The **getProductData** function is imported from `'@akinon/next/data/server'`.
+
+```javascript
+import { getProductData } from '@akinon/next/data/server';
+```
+
+The product data is fetched by defining this function as follow:
+
+```javascript
+const {
+      data: { product }
+    } = await getProductData({
+      pk
+      searchParams,
+      groupProduct: true
+    });
+```
+
+
+- `pk`: The pk of the desired product to be fetched. This parameter is mandatory and should be of type Number.
+- `searchParams`: An optional parameter that can be used to send additional data via query strings. It should be of type String.
+- `groupProduct`: This parameter has a default value of `false`. When set to `true`, it fetches group product data. It should be of type Boolean.
+
+Data returned from the function:
+
+```json
+{
+    "in_stock": false,
+    "product": {
+        "pk": 2,
+        "name": "Pink Polyester Tunic",
+        "sku": "sp0001",
+        "base_code": "Sample1",
+        "attributes": {
+            "filterable_size": "10",
+            "integration_pack_color": "Pink",
+            "color": "Pink",
+            "gender": "woman",
+            "size_switcher": "UK",
+            "hexcolorcode": "#FF4081",
+            "international_size": "34",
+            "filterable_color": "Pink",
+            "size": "10"
+        },
+        "attribute_set": 1,
+        "attributes_kwargs": {
+            "filterable_size": {
+                "value": "10",
+                "data_type": "dropdown",
+                "label": "10"
+            },
+            "color": {
+                "value": "Pink",
+                "data_type": "dropdown",
+                "label": "Pink"
+            },
+            "gender": {
+                "value": "woman",
+                "data_type": "dropdown",
+                "label": "Woman"
+            },
+            "size_switcher": {
+                "value": "UK",
+                "data_type": "dropdown",
+                "label": "UK"
+            },
+            "international_size": {
+                "value": "34",
+                "data_type": "dropdown",
+                "label": "34"
+            },
+            "filterable_color": {
+                "value": "Pink",
+                "data_type": "dropdown",
+                "label": "Pink"
+            },
+            "size": {
+                "value": "10",
+                "data_type": "dropdown",
+                "label": "10"
+            }
+        },
+        "extra_attributes": {},
+        "productimage_set": [
+            {
+                "pk": 1,
+                "status": "active",
+                "image": "https://akn-randb.a-cdn.akinoncloud.com/products/2023/04/10/1/44709396-f2cc-4b21-968e-087acada415e.jpg",
+                "order": 0,
+                "created_date": "2023-04-10T17:27:02.525048Z",
+                "specialimage_set": []
+            },
+            {
+                "pk": 2,
+                "status": "active",
+                "image": "https://akn-randb.a-cdn.akinoncloud.com/products/2023/04/10/1/d38e0570-1c04-466d-a122-2242f86bdf71.jpg",
+                "order": 1,
+                "created_date": "2023-04-10T17:27:02.634909Z",
+                "specialimage_set": []
+            }
+        ],
+        "price": "32",
+        "in_stock": false,
+        "currency_type": "aed",
+        "retail_price": "80",
+        "unit_type": "qty",
+        "absolute_url": "/women/pink-polyester-tunic-sample1-pink/p/",
+        "productvideo_set": [],
+        "product_type": "0",
+        "price_type": "default",
+        "form_schema": null,
+        "is_ready_to_basket": false,
+        "stock": 0,
+        "data_source": null,
+        "basket_offers": []
+    },
+    "variants": [],
+    "selected_variant": null
+}
+```

package/app-template/docs/data-fetching/server/seo.md

@@ -0,0 +1,44 @@
+---
+title: SEO
+sidebar_label: SEO
+slug: seo
+custom_edit_url: null
+---
+
+## getSeoData
+
+This function is used to fetch SEO data for a given URL from Omnitron.
+
+The **getSeoData** function is imported from `'@akinon/next/data/server'`.
+
+```javascript
+import { getSeoData } from '@akinon/next/data/server';
+```
+
+The SEO data is fetched by defining this function as follow:
+
+```javascript
+const response = await getSeoData('/');
+``` 
+
+-   `url` : Provide the URL for which SEO data is fetched. This parameter is mandatory and should be of type String.
+
+> **Note:** The URL for which the data is fetched should have content defined in the **Sales Channels > Marketing > SEO Settings** section of Omnitron.
+
+Data returned from the function:
+
+```json
+{
+    "pk": 1,
+    "created_date": "2023-06-07T23:11:14.519842Z",
+    "modified_date": "2023-06-07T23:11:14.519866Z",
+    "attributes": {
+        "css_class": "randb"
+    },
+    "url": "/",
+    "title": "Shop Fashion for Women, Men, and Kids Online | R&B UAE",
+    "description": "Discover the latest fashion clothes at R&B UAE, and create the best outfits with our fashion collection for men, women, and kids. Get the trendiest clothes online.",
+    "keywords": "R&B",
+    "attributes_kwargs": {}
+}
+```

package/app-template/docs/data-fetching/server/special-page.md

@@ -0,0 +1,79 @@
+---
+title: Special Page
+sidebar_label: Special Page
+slug: special-page
+custom_edit_url: null
+---
+
+## getSpecialPageData
+
+This function is used to fetch data for a special page created in Omnitron based on its pk.
+
+The **getSpecialPageData** function is imported from `'@akinon/next/data/server'`.
+
+```javascript
+import { getSpecialPageData } from '@akinon/next/data/server';
+```
+
+The special page data is fetched by defining this function as follow:
+
+```javascript
+const data = await getSpecialPageData({pk, searchParams});
+```
+
+-   `pk`: The pk of the desired special page to be fetched. This parameter is mandatory and should be of type Number.
+-   `searchParams`: An optional parameter that can be used to send additional data via query strings. It should be of type String.
+
+Data returned from the function:
+
+```json
+{
+  "pagination": {
+    "total_count": 865,
+    "current_page": 1,
+    "num_pages": 44,
+    "page_size": 20
+  },
+  "facets": [],
+  "sorters": [],
+  "search_text": null,
+  "products": [],
+  "special_page": {
+    "pk": 59,
+    "name": "Men Size S",
+    "url": "/men-size-s/",
+    "template": null,
+    "banner": null,
+    "banner_url": null,
+    "product_collection": 30,
+    "banner_description": null,
+    "is_active": true,
+    "created_date": "2023-07-12T18:19:05.711537Z",
+    "modified_date": "2023-07-12T18:19:05.747308Z",
+    "video_embedded_code": null,
+    "specialpageprettyurl_set": [],
+    "pretty_url": {
+      "pk": 71257,
+      "new_path": "/men-size-s/",
+      "old_path": "/special-page/59/",
+      "parent": null,
+      "language": "en",
+      "func_module": "omnishop.cms.resources.views",
+      "func_name": "SpecialPageView",
+      "func_initkwargs": {},
+      "args": [],
+      "kwargs": {
+        "special_page_id": "59"
+      },
+      "query_params": {},
+      "viewname": "special-page-detail",
+      "created_date": "2023-07-12T18:19:05.743009Z",
+      "modified_date": "2023-07-12T18:19:05.743036Z",
+      "prettyurl_set": []
+    },
+    "extraction_strategy": "omnishop.search.strategies.DefaultProductExtractionStrategy",
+    "banner_mobile": null
+  }
+}
+
+```