docs: updates and fixes in utils + fulfillment provider changes (#9347)

* fix config + update deps * rearrange sidebar + add to examples
medusajs · Oct 2, 2024 · 8686ca9 · 8686ca9
1 parent 07afa8f
commit 8686ca9
Show file tree

Hide file tree

Showing 37 changed files with 591 additions and 89 deletions.
diff --git a/www/apps/book/app/more-resources/examples/page.mdx b/www/apps/book/app/more-resources/examples/page.mdx
@@ -93,6 +93,7 @@ This chapter provides links to example sections on different Medusa topics.
 ### Auth
 
 - [Create a custom actor type](!resources!/commerce-modules/auth/create-actor-type)
+- [Create auth provider module](!resources!/references/auth/provider)
 
 ### Cart
 
@@ -101,19 +102,43 @@ This chapter provides links to example sections on different Medusa topics.
 
 ### Fulfillment
 
-- [Create a fulfillment module provider](!resources!/recipes/digital-products/examples/standard#step-10-create-digital-product-fulfillment-module-provider)
+- [Create fulfillment module provider](!resources!/recipes/digital-products/examples/standard#step-10-create-digital-product-fulfillment-module-provider)
 
 ### Order
 
 - [Retrieve promotion actions of an order](!resources!/commerce-modules/order/promotion-adjustments#promotion-actions)
 
+### Payment
+
+- [Create payment module provider](!resources!/references/payment/provider)
+
 ### Product
 
 - [Retrieve prices of product variants](!resources!/commerce-modules/product/guides/price)
 - [Retrieve product variant prices with taxes](!resources!/commerce-modules/product/guides/price-with-taxes)
 
 ---
 
+## Architectural Modules
+
+### Cache
+
+- [Create cache module](!resources!/architectural-modules/cache/create)
+
+### Event
+
+- [Create event module](!resources!/architectural-modules/event/create)
+
+### File
+
+- [Create file module provider](!resources!/references/file-provider-module)
+
+### Notification
+
+- [Create notification module provider](!resources!/references/notification-provider-module)
+
+---
+
 ## Integrations
 
 - [Send a notification with SendGrid](!resources!/architectural-modules/notification/sendgrid#test-out-the-module)
diff --git a/www/apps/book/generated/edit-dates.mjs b/www/apps/book/generated/edit-dates.mjs
@@ -110,7 +110,7 @@ export const generatedEditDates = {
   "app/customization/next-steps/page.mdx": "2024-09-12T10:50:04.873Z",
   "app/customization/page.mdx": "2024-09-12T11:16:18.504Z",
   "app/more-resources/cheatsheet/page.mdx": "2024-07-11T16:11:26.480Z",
-  "app/more-resources/examples/page.mdx": "2024-09-19T10:30:30.398Z",
+  "app/more-resources/examples/page.mdx": "2024-09-27T07:17:16.892Z",
   "app/architecture/architectural-modules/page.mdx": "2024-09-23T12:51:04.520Z",
   "app/architecture/overview/page.mdx": "2024-09-23T12:55:01.339Z",
   "app/advanced-development/data-models/infer-type/page.mdx": "2024-09-30T08:43:53.123Z"

diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs
@@ -278,6 +278,14 @@ export const generatedSidebar = [
                 "path": "/commerce-modules/auth/create-actor-type",
                 "title": "Create an Actor Type",
                 "children": []
+              },
+              {
+                "loaded": true,
+                "isPathHref": true,
+                "type": "link",
+                "path": "/references/auth/provider",
+                "title": "Create Auth Provider Module",
+                "children": []
               }
             ]
           },
@@ -319,14 +327,6 @@ export const generatedSidebar = [
             "type": "sub-category",
             "title": "References",
             "children": [
-              {
-                "loaded": true,
-                "isPathHref": true,
-                "type": "link",
-                "path": "/references/auth/provider",
-                "title": "Create Auth Provider Module",
-                "children": []
-              },
               {
                 "loaded": true,
                 "isPathHref": true,
@@ -1601,7 +1601,7 @@ export const generatedSidebar = [
             "loaded": true,
             "isPathHref": true,
             "type": "sub-category",
-            "title": "References",
+            "title": "Guides",
             "children": [
               {
                 "loaded": true,
@@ -1610,7 +1610,15 @@ export const generatedSidebar = [
                 "path": "/references/fulfillment/provider",
                 "title": "Create Fulfillment Provider Module",
                 "children": []
-              },
+              }
+            ]
+          },
+          {
+            "loaded": true,
+            "isPathHref": true,
+            "type": "sub-category",
+            "title": "References",
+            "children": [
               {
                 "loaded": true,
                 "isPathHref": true,
@@ -4144,6 +4152,14 @@ export const generatedSidebar = [
                 "path": "/commerce-modules/payment/payment-flow",
                 "title": "Accept Payment Flow",
                 "children": []
+              },
+              {
+                "loaded": true,
+                "isPathHref": true,
+                "type": "link",
+                "path": "/references/payment/provider",
+                "title": "Create Payment Provider",
+                "children": []
               }
             ]
           },
@@ -4153,14 +4169,6 @@ export const generatedSidebar = [
             "type": "sub-category",
             "title": "References",
             "children": [
-              {
-                "loaded": true,
-                "isPathHref": true,
-                "type": "link",
-                "path": "/references/payment/provider",
-                "title": "Payment Provider Reference",
-                "children": []
-              },
               {
                 "loaded": true,
                 "isPathHref": true,
@@ -7004,7 +7012,7 @@ export const generatedSidebar = [
             "loaded": true,
             "isPathHref": true,
             "type": "sub-category",
-            "title": "References",
+            "title": "Guides",
             "children": [
               {
                 "loaded": true,
@@ -7013,7 +7021,15 @@ export const generatedSidebar = [
                 "path": "/references/tax/provider",
                 "title": "Tax Provider Reference",
                 "children": []
-              },
+              }
+            ]
+          },
+          {
+            "loaded": true,
+            "isPathHref": true,
+            "type": "sub-category",
+            "title": "References",
+            "children": [
               {
                 "loaded": true,
                 "isPathHref": true,

diff --git a/www/apps/resources/sidebar.mjs b/www/apps/resources/sidebar.mjs
@@ -138,6 +138,11 @@ export const sidebar = sidebarAttachHrefCommonOptions([
                 path: "/commerce-modules/auth/create-actor-type",
                 title: "Create an Actor Type",
               },
+              {
+                type: "link",
+                path: "/references/auth/provider",
+                title: "Create Auth Provider Module",
+              },
             ],
           },
           {
@@ -165,11 +170,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([
             type: "sub-category",
             title: "References",
             children: [
-              {
-                type: "link",
-                path: "/references/auth/provider",
-                title: "Create Auth Provider Module",
-              },
               {
                 type: "link",
                 path: "/references/auth",
@@ -460,13 +460,19 @@ export const sidebar = sidebarAttachHrefCommonOptions([
           },
           {
             type: "sub-category",
-            title: "References",
+            title: "Guides",
             children: [
               {
                 type: "link",
                 path: "/references/fulfillment/provider",
                 title: "Create Fulfillment Provider Module",
               },
+            ],
+          },
+          {
+            type: "sub-category",
+            title: "References",
+            children: [
               {
                 type: "link",
                 path: "/references/fulfillment",
@@ -747,17 +753,17 @@ export const sidebar = sidebarAttachHrefCommonOptions([
                 path: "/commerce-modules/payment/payment-flow",
                 title: "Accept Payment Flow",
               },
+              {
+                type: "link",
+                path: "/references/payment/provider",
+                title: "Create Payment Provider",
+              },
             ],
           },
           {
             type: "sub-category",
             title: "References",
             children: [
-              {
-                type: "link",
-                path: "/references/payment/provider",
-                title: "Payment Provider Reference",
-              },
               {
                 type: "link",
                 path: "/references/payment",
@@ -1339,13 +1345,19 @@ export const sidebar = sidebarAttachHrefCommonOptions([
           },
           {
             type: "sub-category",
-            title: "References",
+            title: "Guides",
             children: [
               {
                 type: "link",
                 path: "/references/tax/provider",
                 title: "Tax Provider Reference",
               },
+            ],
+          },
+          {
+            type: "sub-category",
+            title: "References",
+            children: [
               {
                 type: "link",
                 path: "/references/tax",

diff --git a/www/utils/packages/react-docs-generator/package.json b/www/utils/packages/react-docs-generator/package.json
@@ -22,7 +22,7 @@
     "react-docgen": "^7.0.1",
     "resolve": "^1.22.8",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.26.2",
+    "typedoc": "^0.26.7",
     "typedoc-plugin-custom": "*",
     "typescript": "^5.6.2",
     "utils": "*"
@@ -31,6 +31,6 @@
     "@types/node": "^20.12.10"
   },
   "peerDependencies": {
-    "typedoc": "0.25.x"
+    "typedoc": "0.26.x"
   }
 }
diff --git a/www/utils/packages/typedoc-config/api-key.json b/www/utils/packages/typedoc-config/api-key.json
@@ -2,5 +2,10 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
     "../../../../packages/modules/api-key/tsconfig.json"
+  ],
+  "include": ["../../../../packages/modules/api-key/src"],
+  "exclude": [
+    "../../../../packages/modules/api-key/dist", 
+    "../../../../packages/modules/api-key/node_modules"
   ]
 }
diff --git a/www/utils/packages/typedoc-config/auth.json b/www/utils/packages/typedoc-config/auth.json
@@ -2,5 +2,10 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
     "../../../../packages/modules/auth/tsconfig.json"
+  ],
+  "include": ["../../../../packages/modules/auth/src"],
+  "exclude": [
+    "../../../../packages/modules/auth/dist", 
+    "../../../../packages/modules/auth/node_modules"
   ]
 }
diff --git a/www/utils/packages/typedoc-config/cart.json b/www/utils/packages/typedoc-config/cart.json
@@ -2,5 +2,10 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
     "../../../../packages/modules/cart/tsconfig.json"
+  ],
+  "include": ["../../../../packages/modules/cart/src"],
+  "exclude": [
+    "../../../../packages/modules/cart/dist", 
+    "../../../../packages/modules/cart/node_modules"
   ]
 }
diff --git a/www/utils/packages/typedoc-config/core-flows.json b/www/utils/packages/typedoc-config/core-flows.json
@@ -2,5 +2,10 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
     "../../../../packages/core/core-flows/tsconfig.json"
+  ],
+  "include": ["../../../../packages/core/core-flows/src"],
+  "exclude": [
+    "../../../../packages/core/core-flows/dist", 
+    "../../../../packages/core/core-flows/node_modules"
   ]
 }
diff --git a/www/utils/packages/typedoc-config/currency.json b/www/utils/packages/typedoc-config/currency.json
@@ -2,5 +2,10 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
     "../../../../packages/modules/currency/tsconfig.json"
+  ],
+  "include": ["../../../../packages/modules/currency/src"],
+  "exclude": [
+    "../../../../packages/modules/currency/dist", 
+    "../../../../packages/modules/currency/node_modules"
   ]
 }
diff --git a/www/utils/packages/typedoc-config/customer.json b/www/utils/packages/typedoc-config/customer.json
@@ -2,5 +2,10 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
     "../../../../packages/modules/customer/tsconfig.json"
+  ],
+  "include": ["../../../../packages/modules/customer/src"],
+  "exclude": [
+    "../../../../packages/modules/customer/dist", 
+    "../../../../packages/modules/customer/node_modules"
   ]
 }
diff --git a/www/utils/packages/typedoc-config/framework.json b/www/utils/packages/typedoc-config/framework.json
@@ -2,5 +2,10 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
     "../../../../packages/framework/framework/tsconfig.json"
+  ],
+  "include": ["../../../../packages/framework/framework/src"],
+  "exclude": [
+    "../../../../packages/framework/framework/dist", 
+    "../../../../packages/framework/framework/node_modules"
   ]
 }
diff --git a/www/utils/packages/typedoc-config/fulfillment.json b/www/utils/packages/typedoc-config/fulfillment.json
@@ -2,5 +2,10 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
     "../../../../packages/modules/fulfillment/tsconfig.json"
+  ],
+  "include": ["../../../../packages/modules/fulfillment/src"],
+  "exclude": [
+    "../../../../packages/modules/fulfillment/dist", 
+    "../../../../packages/modules/fulfillment/node_modules"
   ]
 }
diff --git a/www/utils/packages/typedoc-config/inventory-next.json b/www/utils/packages/typedoc-config/inventory-next.json
@@ -2,5 +2,10 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
     "../../../../packages/modules/inventory-next/tsconfig.json"
+  ],
+  "include": ["../../../../packages/modules/inventory-next/src"],
+  "exclude": [
+    "../../../../packages/modules/inventory-next/dist", 
+    "../../../../packages/modules/inventory-next/node_modules"
   ]
 }
diff --git a/www/utils/packages/typedoc-config/js-client.json b/www/utils/packages/typedoc-config/js-client.json