asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: add documentation for Locking Module (#11824)

Browse Source 
* add locking docs

* fix main navbar

* added implementation example links

* generate refs

* update architecture

* fix vale error
This commit is contained in:
Shahed Nasser
2025-03-13 12:20:24 +02:00
committed by GitHub
parent 5cf0bf4d93
commit 28b0d08591
94 changed files with 15932 additions and 10857 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/generated/edit-dates.mjs
+21 -15
View File
@@ -194,29 +194,29 @@ export const generatedEditDates = {
"app/commerce-modules/auth/auth-identity-and-actor-types/page.mdx": "2025-01-07T09:02:27.235Z",
"app/commerce-modules/api-key/page.mdx": "2025-02-26T11:18:00.337Z",
"app/commerce-modules/auth/create-actor-type/page.mdx": "2024-12-25T13:26:27.176Z",
"app/architectural-modules/page.mdx": "2025-01-08T12:13:50.333Z",
"app/architectural-modules/page.mdx": "2025-03-12T10:28:44.544Z",
"app/architectural-modules/workflow-engine/redis/page.mdx": "2024-10-15T12:50:59.507Z",
"app/architectural-modules/notification/sendgrid/page.mdx": "2025-02-26T11:43:13.143Z",
"app/commerce-modules/api-key/concepts/page.mdx": "2024-10-07T13:59:37.529Z",
"app/architectural-modules/workflow-engine/page.mdx": "2025-01-08T12:16:04.157Z",
"app/architectural-modules/workflow-engine/page.mdx": "2025-03-12T11:55:18.789Z",
"app/_events-reference/page.mdx": "2024-07-03T19:27:13+03:00",
"app/architectural-modules/cache/page.mdx": "2025-01-08T12:14:37.925Z",
"app/architectural-modules/cache/page.mdx": "2025-03-12T11:52:56.014Z",
"app/architectural-modules/file/s3/page.mdx": "2025-01-24T13:49:01.104Z",
"app/commerce-modules/api-key/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/api-key/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/architectural-modules/cache/redis/page.mdx": "2024-10-15T12:50:01.730Z",
"app/architectural-modules/event/redis/page.mdx": "2024-10-15T12:50:40.506Z",
"app/architectural-modules/event/local/page.mdx": "2024-10-15T12:50:37.512Z",
"app/architectural-modules/event/redis/page.mdx": "2025-03-12T11:56:15.922Z",
"app/architectural-modules/event/local/page.mdx": "2025-03-12T11:56:02.160Z",
"app/architectural-modules/workflow-engine/in-memory/page.mdx": "2024-10-15T12:50:57.249Z",
"app/architectural-modules/cache/in-memory/page.mdx": "2024-10-15T12:49:57.608Z",
"app/architectural-modules/notification/local/page.mdx": "2024-10-15T12:51:21.284Z",
"app/architectural-modules/file/local/page.mdx": "2024-10-16T15:48:42.839Z",
"app/architectural-modules/notification/send-notification/page.mdx": "2024-09-30T08:43:53.151Z",
"app/architectural-modules/file/page.mdx": "2025-01-08T12:15:19.981Z",
"app/architectural-modules/event/page.mdx": "2025-01-08T12:15:08.454Z",
"app/architectural-modules/file/page.mdx": "2025-03-12T10:46:14.005Z",
"app/architectural-modules/event/page.mdx": "2025-03-12T11:52:51.218Z",
"app/architectural-modules/cache/create/page.mdx": "2024-10-16T08:51:35.074Z",
"app/admin-widget-injection-zones/page.mdx": "2024-12-24T08:48:36.154Z",
"app/architectural-modules/notification/page.mdx": "2025-01-08T12:15:40.159Z",
"app/architectural-modules/notification/page.mdx": "2025-03-12T11:49:47.552Z",
"app/architectural-modules/event/create/page.mdx": "2024-12-09T14:46:40.248Z",
"references/core_flows/Order/functions/core_flows.Order.orderEditUpdateItemQuantityValidationStep/page.mdx": "2024-08-20T00:10:58.913Z",
"references/core_flows/Order/functions/core_flows.Order.orderEditUpdateItemQuantityWorkflow/page.mdx": "2024-08-20T00:10:58.949Z",
@@ -553,7 +553,7 @@ export const generatedEditDates = {
"references/types/NotificationTypes/interfaces/types.NotificationTypes.Attachment/page.mdx": "2024-12-17T16:57:21.128Z",
"references/modules/fulfillment_models/page.mdx": "2024-12-23T12:30:31.974Z",
"references/modules/order_models/page.mdx": "2025-01-27T11:43:58.772Z",
"references/notification/classes/notification.AbstractNotificationProviderService/page.mdx": "2025-02-11T11:36:55.004Z",
"references/notification/classes/notification.AbstractNotificationProviderService/page.mdx": "2025-03-12T12:28:32.206Z",
"references/order/interfaces/order.IOrderModuleService/page.mdx": "2025-03-04T13:33:53.711Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCampaignResponse/page.mdx": "2024-12-09T13:21:33.353Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx": "2025-02-11T11:36:49.726Z",
@@ -845,7 +845,7 @@ export const generatedEditDates = {
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.authenticate/page.mdx": "2025-01-07T12:54:18.941Z",
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.validateCallback/page.mdx": "2025-01-07T12:54:18.948Z",
"references/auth/interfaces/auth.AuthenticationResponse/page.mdx": "2024-12-09T13:21:36.233Z",
"references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx": "2025-02-07T10:35:24.400Z",
"references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx": "2025-03-12T12:28:32.072Z",
"references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.refreshInviteTokensWorkflow/page.mdx": "2025-03-04T13:33:41.373Z",
"references/types/CommonTypes/types/types.CommonTypes.BatchMethodResponse/page.mdx": "2024-12-09T13:21:32.849Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddReturnShipping/page.mdx": "2024-12-09T13:21:34.545Z",
@@ -1161,7 +1161,7 @@ export const generatedEditDates = {
"references/dml/entity/classes/dml.entity.DmlEntity/page.mdx": "2025-01-13T18:05:57.749Z",
"references/dml/entity_builder/EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx": "2025-01-13T18:05:57.746Z",
"references/dml/entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx": "2025-01-13T18:05:57.744Z",
"references/file/classes/file.AbstractFileProviderService/page.mdx": "2025-02-24T10:48:42.996Z",
"references/file/classes/file.AbstractFileProviderService/page.mdx": "2025-03-12T12:28:32.076Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillmentSets/page.mdx": "2024-12-09T13:21:55.940Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createGeoZones/page.mdx": "2025-01-13T18:05:53.686Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createServiceZones/page.mdx": "2024-12-09T13:21:55.976Z",
@@ -1223,7 +1223,7 @@ export const generatedEditDates = {
"references/fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx": "2024-12-23T13:57:04.802Z",
"references/fulfillment/interfaces/fulfillment.OrderLineItemTaxLineDTO/page.mdx": "2024-12-23T13:57:04.793Z",
"references/fulfillment/types/fulfillment.JoinerRelationship/page.mdx": "2024-12-09T13:21:56.268Z",
"references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx": "2025-02-24T10:48:43.021Z",
"references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx": "2025-03-12T12:28:32.087Z",
"references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.adjustInventory/page.mdx": "2024-12-09T13:21:56.800Z",
"references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.confirmInventory/page.mdx": "2024-12-09T13:21:56.804Z",
"references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.createInventoryItems/page.mdx": "2024-12-09T13:21:56.744Z",
@@ -1363,7 +1363,7 @@ export const generatedEditDates = {
"references/payment/interfaces/payment.JoinerServiceConfig/page.mdx": "2025-01-13T18:05:56.394Z",
"references/payment/interfaces/payment.JoinerServiceConfigAlias/page.mdx": "2024-12-09T13:22:02.308Z",
"references/payment/types/payment.JoinerRelationship/page.mdx": "2024-12-09T13:22:02.304Z",
"references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx": "2025-03-04T13:33:56.703Z",
"references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx": "2025-03-12T12:28:32.214Z",
"references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices/page.mdx": "2024-12-09T13:22:02.928Z",
"references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices/page.mdx": "2024-12-09T13:22:02.868Z",
"references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices/page.mdx": "2024-12-09T13:22:02.832Z",
@@ -1590,7 +1590,7 @@ export const generatedEditDates = {
"references/tax/interfaces/tax.TaxRateRuleDTO/page.mdx": "2024-12-10T14:55:13.509Z",
"references/tax/interfaces/tax.UpdateTaxRateDTO/page.mdx": "2024-12-10T14:55:13.523Z",
"references/tax/types/tax.JoinerRelationship/page.mdx": "2024-12-09T13:22:04.496Z",
"references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx": "2024-12-09T13:22:04.468Z",
"references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx": "2025-03-12T12:28:31.902Z",
"references/tax_provider/types/tax_provider.ItemTaxCalculationLine/page.mdx": "2024-12-09T13:22:04.464Z",
"references/tax_provider/types/tax_provider.ShippingTaxCalculationLine/page.mdx": "2024-12-09T13:22:04.460Z",
"references/types/DAL/interfaces/types.DAL.RepositoryService/page.mdx": "2025-03-04T13:33:50.003Z",
@@ -6043,5 +6043,11 @@ export const generatedEditDates = {
"references/types/interfaces/types.ITaxProvider/page.mdx": "2025-03-04T13:33:52.645Z",
"app/how-to-tutorials/page.mdx": "2025-03-10T09:33:49.208Z",
"app/tools/page.mdx": "2025-03-10T12:38:56.520Z",
"app/references-overview/page.mdx": "2025-03-10T12:55:49.803Z"
"app/references-overview/page.mdx": "2025-03-10T12:55:49.803Z",
"app/architectural-modules/locking/page.mdx": "2025-03-12T11:40:25.695Z",
"app/architectural-modules/locking/postgres/page.mdx": "2025-03-12T10:07:48.820Z",
"app/architectural-modules/locking/redis/page.mdx": "2025-03-12T10:07:43.867Z",
"references/locking/interfaces/locking.ILockingModule/page.mdx": "2025-03-12T12:28:30.425Z",
"references/locking/interfaces/locking.ILockingProvider/page.mdx": "2025-03-12T12:28:30.422Z",
"references/modules/locking/page.mdx": "2025-03-12T12:28:30.419Z"
}
www/apps/resources/generated/files-map.mjs
+24
View File
@@ -91,6 +91,18 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/architectural-modules/file/s3/page.mdx",
"pathname": "/architectural-modules/file/s3"
},
{
"filePath": "/www/apps/resources/app/architectural-modules/locking/page.mdx",
"pathname": "/architectural-modules/locking"
},
{
"filePath": "/www/apps/resources/app/architectural-modules/locking/postgres/page.mdx",
"pathname": "/architectural-modules/locking/postgres"
},
{
"filePath": "/www/apps/resources/app/architectural-modules/locking/redis/page.mdx",
"pathname": "/architectural-modules/locking/redis"
},
{
"filePath": "/www/apps/resources/app/architectural-modules/notification/local/page.mdx",
"pathname": "/architectural-modules/notification/local"
@@ -12799,6 +12811,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/js_sdk/store/classes/js_sdk.store.Store/page.mdx",
"pathname": "/references/js_sdk/store/classes/js_sdk.store.Store"
},
{
"filePath": "/www/apps/resources/references/locking/interfaces/locking.ILockingModule/page.mdx",
"pathname": "/references/locking/interfaces/locking.ILockingModule"
},
{
"filePath": "/www/apps/resources/references/locking/interfaces/locking.ILockingProvider/page.mdx",
"pathname": "/references/locking/interfaces/locking.ILockingProvider"
},
{
"filePath": "/www/apps/resources/references/medusa/classes/medusa.RestrictedFields/page.mdx",
"pathname": "/references/medusa/classes/medusa.RestrictedFields"
@@ -13011,6 +13031,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/modules/js_sdk/page.mdx",
"pathname": "/references/modules/js_sdk"
},
{
"filePath": "/www/apps/resources/references/modules/locking/page.mdx",
"pathname": "/references/modules/locking"
},
{
"filePath": "/www/apps/resources/references/modules/medusa/page.mdx",
"pathname": "/references/modules/medusa"
www/apps/resources/generated/generated-architectural-modules-sidebar.mjs
+171 -66
View File
@@ -17,7 +17,7 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Cache Modules",
"title": "Cache Module",
"initialOpen": true,
"children": [
{
@@ -31,18 +31,26 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/cache/in-memory",
"title": "In-Memory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/cache/redis",
"title": "Redis",
"children": []
"type": "sub-category",
"title": "Modules",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/cache/in-memory",
"title": "In-Memory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/cache/redis",
"title": "Redis",
"children": []
}
]
},
{
"loaded": true,
@@ -66,7 +74,7 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Event Modules",
"title": "Event Module",
"initialOpen": true,
"children": [
{
@@ -80,18 +88,26 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/event/local",
"title": "Local",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/event/redis",
"title": "Redis",
"children": []
"type": "sub-category",
"title": "Modules",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/event/local",
"title": "Local",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/event/redis",
"title": "Redis",
"children": []
}
]
},
{
"loaded": true,
@@ -115,7 +131,7 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "File Module Providers",
"title": "File Module",
"initialOpen": true,
"children": [
{
@@ -129,18 +145,26 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/file/local",
"title": "Local",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/file/s3",
"title": "AWS S3 (and Compatible APIs)",
"children": []
"type": "sub-category",
"title": "Providers",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/file/local",
"title": "Local",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/file/s3",
"title": "AWS S3 (and Compatible APIs)",
"children": []
}
]
},
{
"loaded": true,
@@ -164,7 +188,72 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Notification Module Providers",
"title": "Locking Module",
"initialOpen": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/locking",
"title": "Overview",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "sub-category",
"title": "Providers",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/locking/redis",
"title": "Redis",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/locking/postgres",
"title": "PostgreSQL",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "sub-category",
"title": "Guides",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/locking-module-provider",
"title": "Create Locking Provider",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/locking-service",
"title": "Use Locking Module",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Notification Module",
"initialOpen": true,
"children": [
{
@@ -178,18 +267,26 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/notification/local",
"title": "Local",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/notification/sendgrid",
"title": "SendGrid",
"children": []
"type": "sub-category",
"title": "Providers",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/notification/local",
"title": "Local",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/notification/sendgrid",
"title": "SendGrid",
"children": []
}
]
},
{
"loaded": true,
@@ -208,7 +305,7 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
{
"loaded": true,
"isPathHref": true,
"type": "link",
"type": "ref",
"path": "/integrations/guides/resend",
"title": "Integrate Resend",
"children": []
@@ -229,7 +326,7 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Workflow Engine Modules",
"title": "Workflow Engine Module",
"initialOpen": true,
"children": [
{
@@ -243,18 +340,26 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/workflow-engine/in-memory",
"title": "In-Memory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/workflow-engine/redis",
"title": "Redis",
"children": []
"type": "sub-category",
"title": "Modules",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/workflow-engine/in-memory",
"title": "In-Memory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/workflow-engine/redis",
"title": "Redis",
"children": []
}
]
}
]
}
www/apps/resources/generated/generated-how-to-tutorials-sidebar.mjs
+16
View File
@@ -78,6 +78,14 @@ const generatedgeneratedHowToTutorialsSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/fulfillment/provider",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Create Locking Provider",
"path": "https://docs.medusajs.com/resources/references/locking-module-provider",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -133,6 +141,14 @@ const generatedgeneratedHowToTutorialsSidebarSidebar = {
"title": "Send Notification",
"path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Use Locking Module",
"path": "https://docs.medusajs.com/resources/references/locking-service",
"children": []
}
]
},
www/apps/resources/generated/slug-changes.mjs
+10
View File
@@ -4704,6 +4704,16 @@ export const slugChanges = [
"newSlug": "/references/js-sdk/store",
"filePath": "/www/apps/resources/references/js_sdk/store/classes/js_sdk.store.Store/page.mdx"
},
{
"origSlug": "/references/locking/interfaces/locking.ILockingModule",
"newSlug": "/references/locking-service",
"filePath": "/www/apps/resources/references/locking/interfaces/locking.ILockingModule/page.mdx"
},
{
"origSlug": "/references/locking/interfaces/locking.ILockingProvider",
"newSlug": "/references/locking-module-provider",
"filePath": "/www/apps/resources/references/locking/interfaces/locking.ILockingProvider/page.mdx"
},
{
"origSlug": "/references/medusa_config/interfaces/medusa_config.ConfigModule",
"newSlug": "/references/medusa-config",