asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
9,472 Commits 2 Branches 0 Tags
caa561badf960c076b4f564dadbbbb9e36d00a18
Commit Graph

213 Commits

Author SHA1 Message Date
Shahed Nasser
1c4c4b8e9a docs: generate references manually for 2.12.3 (#14340) 2025-12-17 18:20:19 +02:00
Shahed Nasser
c1a5390fc6 docs: translation module (#14271) 
* docs: translation module

* fix link in JS SDK

* add translations user guides [WIP]

* updates

* fix broken link

* remove mentions of default locale

* change header

* updates

* updated user guides

* handle todos

* fix build error

* fix lint errors
 2025-12-17 13:07:43 +02:00
Shahed Nasser
e3e3c725db docs: triage issues + revamp troubleshooting guides (#14216) 
* docs: triage issues + revamp troubleshooting guides

* small change
 2025-12-04 17:12:48 +02:00
github-actions[bot]
471ab72ecb chore(docs): Generated References (automated) (#14199) 
Generated the following references:
- `api_key_models`
- `auth_models`
- `auth_provider`
- `caching`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`


---

> [!NOTE]
> Regenerates API reference pages across models, workflows/steps, and JS SDK, and updates generated Typedoc JSON and edit-dates script.
> 
> - **Documentation**:
>   - **Models References**: Regenerated pages under `apps/resources/references/*_models/variables` for `api_key`, `auth`, `cart`, `currency`, `customer`, `fulfillment`, `inventory_next`, `order`, `payment`, `pricing`, `product`, `promotion`, `region`, `sales_channel`, `stock_location_next`, `store`, `tax`, `user`.
>   - **Core Flows**: Added/updated `Workflows_*` and `Steps_*` reference pages across modules including `Api_Key`, `Auth`, `Cart`, `Common`, `Customer`, `Customer_Group`, `Defaults`, `Draft_Order`, `File`, `Fulfillment`, `Inventory`, `Invite`, `Line_Item`, `Order`, `Payment`, `Payment_Collection`, `Price_List`, `Pricing`, `Product`, `Product_Category`, `Promotion`, `Region`, `Reservation`, `Return_Reason`, `Sales_Channel`, `Settings`, `Shipping_Options`, `Shipping_Profile`, `Stock_Location`, `Store`, `Tax`, `User`.
>   - **JS SDK**: Added `js_sdk.admin.Admin.order` property and `admin.Order.updateOrderChange` method references.
>   - **Types**: Added `types/CachingTypes.interfaces.ICachingModuleService` reference.
> - **Generated Assets**:
>   - Updated `utils/generated/typedoc-json-output/0-medusa.json` and `0-types.json`.
>   - Updated `apps/resources/generated/edit-dates.mjs`.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 796f722aa33abd2033f488a33e0df81903b1b3f2. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
 2025-12-03 12:01:29 +00:00
github-actions[bot]
21f61ec160 chore(docs): Generated References (automated) (#14182) 
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `helper_steps`
- `inventory_next_models`
- `js_sdk`
- `module_events`
- `modules`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `utils`
- `workflows`


---

> [!NOTE]
> Regenerates documentation references with updated schemas/fields and source links, adds locking guidance to fulfillment delivery workflow, expands notification step IO, and tweaks examples/sample values.
> 
> - **Docs Generation**:
>   - Regenerated reference pages across `core_flows`, `fulfillment`, `inventory`, `order`, etc., with updated TypeList schemas and examples.
> - **Fulfillment Workflows/Steps**:
>   - Updated IO schemas (e.g., added `custom_display_id` on `OrderDTO`, `carry_over_promotions` on `OrderChangeDTO`).
>   - Added locking guidance and workflow steps (`acquireLockStep`/`releaseLockStep`) to `markFulfillmentAsDeliveredWorkflow` plus new note/tag.
>   - Refreshed example snippets and sample values.
> - **Notification Step** (`sendNotificationsStep`):
>   - Input expanded with `from`, `content`, `provider_data`, `attachments`; `template` now optional.
>   - Output includes `provider_data` and `attachments` fields.
> - **Order Steps/Workflows**:
>   - IO schemas updated to include `custom_display_id` and `carry_over_promotions` where applicable; added `ordering` on change actions.
>   - Example payloads adjusted (IDs, currencies, amounts).
> - **Meta**:
>   - Updated `<SourceCodeLink>` URLs to new commit hashes throughout.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eeb0dac7b19d51860531a491208b2b3b853aa4db. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2025-12-02 06:59:52 +00:00
Shahed Nasser
c3cebdfe80 docs: fix events payloads (#14131) 2025-11-26 16:12:00 +02:00
Shahed Nasser
c1ede88a7e docs: document locks for nested workflows (#14130) 
* docs: document locks for nested workflows

* smal text change

* fix build error
 2025-11-26 15:36:58 +02:00
github-actions[bot]
924d651188 chore(docs): Generated References (automated) (#13969) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2025-11-05 16:47:09 +02:00
github-actions[bot]
fffc1be1e7 chore(docs): Generated References (automated) (#13921) 
* chore(docs): Generated References (automated)

* fix error + generate references

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2025-10-31 15:32:21 +02:00
github-actions[bot]
dbf8fb9bda chore(docs): Generated References (automated) (#13857) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2025-10-27 09:17:23 +02:00
Shahed Nasser
8d574d6f29 docs: improvements to tax related docs (#13845) 2025-10-24 09:44:47 +03:00
Shahed Nasser
4ab185c685 docs: clarify how emitEventStep emits an event in a workflow (#13836) 2025-10-23 16:30:25 +03:00
Shahed Nasser
55c42e112e docs: change binary encoding to base64 in file upload references (#13811) 2025-10-22 18:43:35 +03:00
Shahed Nasser
c6e58e5144 docs: fixes to API and JS SDK references (#13795) 2025-10-21 13:32:25 +03:00
github-actions[bot]
858b3e3b9b chore(docs): Generated References (automated) (#13793) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2025-10-21 11:56:37 +03:00
Shahed Nasser
76f9da5ef4 docs: Caching Module (#13701) 
* standard docs for caching module + deprecated cache module

* added guides for creating + using, and overall changes from cache to caching

* fix details related to redis provider

* fix build errors

* fix build error

* fixes

* add guides to sidebar

* add sidebar util

* document query + index

* moved cache tag conventions

* fix build errors

* added migration guide

* added memcached guide

* fixes

* general fixes and updates

* updated reference

* document medusa cache

* small fix

* fixes

* remove cloud cache

* revert edit dates changes

* revert edit dates

* small update
 2025-10-21 10:34:27 +03:00
Shahed Nasser
26d497f285 docs: clarify how to use token in Auth Provider guide (#13759) 
* docs: clarify how to use token in Auth Provider guide

* small fix
 2025-10-16 08:27:42 +03:00
Shahed Nasser
0e45249b30 docs: regenerate reference for views changes (#13551) 2025-09-19 10:45:55 +03:00
github-actions[bot]
138e340917 chore(docs): Generated References (automated) (#13544) 
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `modules`
- `order`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2025-09-19 06:21:46 +00:00
Shahed Nasser
55cf7a7b97 docs: regenerate core-flows reference to pick up locking steps (#13502) 2025-09-15 13:29:03 +03:00
github-actions[bot]
c066fe993f chore(docs): Generated References (automated) (#13492) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2025-09-15 11:57:03 +03:00
Shahed Nasser
d73591aafd docs: fix relations missing from data model reference diagrams (#13474) 2025-09-11 13:31:03 +03:00
Shahed Nasser
f1149ea170 docs: show the source code link in order models reference (#13398) 2025-09-03 10:36:59 +03:00
Shahed Nasser
899ac2f052 docs: generate references for 2.10.1 (#13344) 2025-08-29 12:51:43 +03:00
Shahed Nasser
de3fba6f86 docs: fix comment for shipment.created event (#13274) 2025-08-22 13:08:04 +03:00
github-actions[bot]
623cf05fab chore(docs): Generated References (automated) (#13206) 
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `order`
- `order_models`
- `payment_models`
- `pricing_models`
- `product`
- `product_models`
- `promotion`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `user_models`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
 2025-08-14 15:43:48 +00:00
github-actions[bot]
0ccaa19918 chore(docs): Generated References (automated) (#13027) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2025-07-24 12:43:11 +03:00
Shahed Nasser
3fedb4c90c docs: improve alt of images (#12998) 
* docs: improve alt of images

* fix vale errors
 2025-07-21 10:43:29 +03:00
Shahed Nasser
b46bbfae12 docs: fix input type of some hooks in workflow reference (#12995) 2025-07-18 18:11:41 +03:00
Shahed Nasser
639c6af890 docs: fix example of updatePayment method (#12947) 2025-07-14 15:42:01 +03:00
github-actions[bot]
1503ba999f chore(docs): Generated References (automated) (#12942) 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2025-07-14 14:39:48 +03:00
Shahed Nasser
fcfd35a157 docs: sort events in reference alphabetically (#12845) 2025-06-27 11:56:36 +03:00
Shahed Nasser
2005188192 docs: fix step detection of useQueryGraphStep (#12842) 2025-06-26 19:02:27 +03:00
github-actions[bot]
2b0c8c6662 chore(docs): Generated References (automated) (#12824) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2025-06-25 13:51:49 +03:00
Shahed Nasser
e5ec907aad docs: fixes to references for draft orders and files (#12693) 2025-06-10 18:33:53 +03:00
github-actions[bot]
f8c0bd887e chore(docs): Generated References (automated) (#12672) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2025-06-10 09:33:54 +03:00
Shahed Nasser
009d00f27d docs: redesign table of content (#12647) 
* implement toc

* added to projects

* fixes and adapt for references

* added product frontmatter

* remove action menu from 404 pages
 2025-05-30 16:55:36 +03:00
Shahed Nasser
40e73c6ea2 docs: fix broken links utility + uncaught broken links (#12637) 
* fix broken links

* update broken links utility

* add missing payment evens

* generate llms

* fix segment link
 2025-05-28 17:13:27 +03:00
Shahed Nasser
fb6167eed2 docs: fix loading in order reference pages (#12629) 2025-05-28 10:42:13 +03:00
Shahed Nasser
d155f492be chore(core-flows, types): change base64 comment fo files in TSDocs to binary (#12627) 
* chore(core-flows, types): change base64 comment fo files in TSDocs to binary

* add in generatd
 2025-05-27 18:35:39 +03:00
Shahed Nasser
528ab9f8a8 chore(types): fix example for createProductOptionValues in TSDocs and docs (#12623) 2025-05-27 12:45:21 +03:00
Shahed Nasser
8303aed701 docs: add support for ignoring hooks (#12599) 2025-05-23 18:48:08 +03:00
github-actions[bot]
6725bee130 chore(docs): Generated References (automated) (#12580) 
Generated the following references:
- `_index.mdx`
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `file_service`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `medusa`
- `modules`
- `modules_sdk`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
 2025-05-22 12:35:49 +00:00
Shahed Nasser
04e0b43ed8 docs: document analytics module (#12563) 2025-05-22 15:05:04 +03:00
Shahed Nasser
bda143673d docs: show hooks in when condition in workflows reference (#12552) 2025-05-21 13:00:15 +03:00
Shahed Nasser
397d353af6 docs: fix timeout in order-related workflows reference (#12533) 2025-05-19 17:30:21 +03:00
github-actions[bot]
aaf5407d29 chore(docs): Generated References (automated) (#12511) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2025-05-16 15:29:29 +03:00
Shahed Nasser
22cdcedddc docs: improve payment related guides (#12502) 
* improve guide

* update guides

* small change
 2025-05-15 18:40:21 +03:00
Shahed Nasser
b312a7e077 docs: add missing methods in guides and references (#12495) 
* initial

* remove unused references
 2025-05-15 14:22:23 +03:00
github-actions[bot]
e81d2333bc chore(docs): Generated References (automated) (#12492) 
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `modules`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `utils`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
 2025-05-15 08:36:24 +00:00