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

37 Commits

Author SHA1 Message Date
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
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
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
30aa317ff1 docs-util: fix incorrect relations in data model references + other fixes (#12487) 
* fix price model incorrect relations

* fix events that don't have workflows showing

* fix notification example
 2025-05-15 10:47:45 +03:00
Shahed Nasser
e60d15ea84 docs: fix client side error in references (#12475) 2025-05-14 10:18:37 +03:00
github-actions[bot]
5c36bafc1d chore(docs): Generated References (automated) (#12460) 
Generated the following references:
- `_index.mdx`
- `api_key`
- `api_key_models`
- `auth`
- `auth_models`
- `auth_provider`
- `cart`
- `cart_models`
- `core_flows`
- `currency`
- `currency_models`
- `customer`
- `customer_models`
- `events`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `fulfillment_provider`
- `inventory_next`
- `inventory_next_models`
- `js_sdk`
- `locking`
- `medusa`
- `module_events`
- `modules`
- `modules_sdk`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `payment_provider`
- `pricing`
- `pricing_models`
- `product`
- `product_models`
- `promotion`
- `promotion_models`
- `region`
- `region_models`
- `sales_channel`
- `sales_channel_models`
- `stock_location_next`
- `stock_location_next_models`
- `store`
- `store_models`
- `tax`
- `tax_models`
- `tax_provider`
- `types`
- `user`
- `user_models`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2025-05-13 13:31:57 +00:00
Shahed Nasser
ac24749bd3 docs: generated references after collapse types improvement (#11889) 2025-03-18 16:48:43 +02:00
Shahed Nasser
28b0d08591 docs: add documentation for Locking Module (#11824) 
* add locking docs

* fix main navbar

* added implementation example links

* generate refs

* update architecture

* fix vale error
 2025-03-13 12:20:24 +02:00
Shahed Nasser
87b041800a fixes + added new sidebars 2025-03-10 08:33:21 +02:00
Shahed Nasser
0eadcdd555 docs: updates to tax provider and other provider guides (#11626) 2025-02-26 16:13:05 +02:00
github-actions[bot]
dc94e62a6a chore(docs): Generated References (automated) (#11395) 
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `fulfillment`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `payment`
- `payment_models`
- `payment_provider`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`
- `utils`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2025-02-11 12:02:30 +00:00
Shahed Nasser
5c44811cb0 docs: document module providers in plugins (#11360) 
* docs: document module providers in plugins

* small fixes

* add missing title
 2025-02-07 14:17:14 +02:00
Shahed Nasser
ccb332ce41 docs: fix empty return in references (#11343) 2025-02-06 14:35:45 +02:00
Shahed Nasser
0d18d5854a docs: fixes for core workflows reference (#11056) 
* docs: fix step input / output description not showing

* fix generated example for array types

* show workflow summary in diagram

* fix workflow node width

* hide undefined types
 2025-01-20 17:34:02 +02:00
Shahed Nasser
0f5d640736 docs: generate references manually for v2.1.2 (#10639) 
* docs: manually generate references for v2.1.2

* more changes
 2024-12-17 19:20:44 +02:00
Shahed Nasser
c3b2b4b438 chore: fixes to tsdocs + docs-util related to providers 2024-12-11 17:27:32 +02:00
github-actions[bot]
9534751b5c chore(docs): Generated References (automated) (#10508) 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
 2024-12-09 15:27:01 +02:00
github-actions[bot]
5deeae060a chore(docs): Generated References (automated) (#9727) 
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2024-10-24 09:41:14 +00:00
Shahed Nasser
731309e87a docs: fixes following QA testing (#9690) 2024-10-22 18:20:21 +03:00
github-actions[bot]
8209d936a0 chore(docs): Updated API Reference (v2) (#9666) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2024-10-18 17:14:26 +00:00
Shahed Nasser
6efb5897dc docs: fix package names in module registration (#9590) 
* docs: fix package names in module registration

* update references
 2024-10-16 09:05:07 +02:00
github-actions[bot]
f2d662efca chore(docs): Generated References (automated) (#9567) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2024-10-14 19:59:14 +02:00
Shahed Nasser
bc8de8e5b1 docs: add section on testing providers (#9453) 2024-10-04 10:29:45 +03:00
github-actions[bot]
c536f7caf5 chore(docs): Generated References (automated) (#9436) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2024-10-03 11:03:35 +03:00
github-actions[bot]
34eebb61eb chore(docs): Generated References (automated) (#9419) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-10-02 17:13:09 +02:00
Shahed Nasser
2e16949979 docs: update imports and package names across docs (#9375) 
* docs: update imports and package names across docs
+ reference configs

* generate files

* fix import

* change preview to rc
 2024-10-01 11:03:42 +02:00
github-actions[bot]
175ca30f4f chore(docs): Generated References (#9153) 
Generated the following references:
- `api_key`
- `auth`
- `auth_provider`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `customer_models`
- `dml`
- `file`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`
 2024-09-17 07:17:55 +00:00
github-actions[bot]
37ebc97d82 chore(docs): Generated References (#8860) 
Generated the following references:
- `fulfillment_models`
- `modules`
- `notification`
- `order`
- `order_models`
- `types`
 2024-08-29 09:46:46 +00:00
github-actions[bot]
fb0644b8f6 chore(docs): Generated References (automated) (#8642) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-08-18 16:54:36 +02:00
github-actions[bot]
71f0d24359 chore(docs): Generated References (#8400) 
Generated the following references:
- `api_key`
- `auth`
- `auth_provider`
- `cart`
- `currency`
- `customer`
- `dml`
- `file`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `medusa`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `payment_provider`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`
- `workflows`
 2024-08-02 07:05:39 +00:00
github-actions[bot]
9173dd4f5d chore(docs): Generated References (automated) (#8207) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-07-22 08:58:57 +02:00
github-actions[bot]
ca9ba9e688 chore(docs): Generated References (automated) (#7961) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-07-05 09:55:39 +02:00
Shahed Nasser
964927b597 docs: general fixes and improvements (#7918) 
* docs improvements and changes

* updated module definition

* modules + dml changes

* fix build

* fix vale error

* fix lint errors

* fixes to stripe docs

* fix condition

* fix condition

* fix module defintion

* fix checkout

* disable UI action

* change oas preview action

* flatten provider module options

* fix lint errors

* add module link docs

* pr comments fixes

* fix vale error

* change node engine version

* links -> linkable

* add note about database name

* small fixes

* link fixes

* fix response code in api reference

* added migrations step
 2024-07-04 17:26:03 +03:00
Shahed Nasser
dd864da4e0 generate references (#7882) 2024-07-01 16:02:36 +03:00
Shahed Nasser
1f360a3245 docs-util: support models implemented with DML in typedoc custom plugins (#7847) 
- Support generating reference for models implemented with DML
- Support resolving and generating mermaid diagram for relations

The Currency Module was used an example so its reference is generated to showcase the work of this PR.
 2024-07-01 07:34:51 +00:00
Shahed Nasser
154673f3d8 docs: fixes and changes based on latest updates (#7322) 
* docs: changes based on DX changes

* remove fields no longer needed

* remove unnecessary parameters

* fixes to authenticate middleware usage

* add highlight to migrations config

* change configuration to http

* added missing remote link docs

* fix name in sidebar

* added notification module docs + updated file module docs

* add vale exceptions

* fix vale errors

* added docs on custom cli scripts
 2024-05-22 13:37:48 +03:00
Shahed Nasser
4fe28f5a95 chore: reorganize docs apps (#7228) 
* reorganize docs apps

* add README

* fix directory

* add condition for old docs
 2024-05-03 17:36:38 +03:00