Commit Graph
100 Commits
Author SHA1 Message Date
Shahed Nasser 5abe9f9c66 docs: fix expand badge (#8611)
* fix component

* update expand URL
2024-08-16 09:26:16 +03:00
Shahed Nasser 47eb19ca5d docs: add associated workflow badge in api reference (#8613) 2024-08-16 09:26:04 +03:00
Shahed Nasser 0b6bc7e05f docs: redesign pagination (#8614) 2024-08-16 09:25:53 +03:00
Shahed Nasser 4bd0917aed docs: change workflow diagram to list (#8602) 2024-08-15 16:47:27 +03:00
Shahed Nasser b4d4b10ba5 docs: fix $lt and $gt in api reference (#8580) 2024-08-15 16:47:09 +03:00
Shahed Nasser 198d7c9927 docs: add a section in the book on how to retrieve a relationship (#8594) 2024-08-15 16:30:00 +03:00
Shahed Nasser 3bdfb66238 docs: change from showing required to showing optional in types references (#8593) 2024-08-15 16:29:49 +03:00
Shahed Nasser b7bb793f03 feat(medusa-oas-cli): automatically fix missing circular references (#8600) 2024-08-15 13:31:47 +03:00
Shahed Nasser b4f3b8a79d docs: redesign sidebar (#8408)
* initial changes

* redesign the sidebar + nav drawer

* changes to sidebar items

* finish up sidebar redesign

* support new sidebar in resources

* general fixes

* integrate in ui

* support api reference

* refactor

* integrate in user guide

* docs: fix build errors

* fix user guide build

* more refactoring

* added banner

* added bottom logo + icon

* fix up sidebar

* fix up paddings

* fix shadow bottom

* docs: add table of content (#8445)

* add toc types

* implement toc functionality

* finished toc redesign

* redesigned table of content

* mobile fixes

* truncate text in toc

* mobile fixes

* merge fixes

* implement redesign

* add hide sidebar

* add menu action item

* finish up hide sidebar design

* implement redesign in resources

* integrate in api reference

* integrate changes in ui

* fixes to api reference scrolling

* fix build error

* fix build errors

* fixes

* fixes to sidebar

* general fixes

* fix active category not closing

* fix long titles
2024-08-15 12:13:13 +03:00
Shahed Nasser 92a7b5b4c0 docs-util: fix OAS generation error (#8577) 2024-08-14 11:21:22 +03:00
Shahed Nasser cd0acbd921 docs: fixes and preparations for workflows reference (#8579)
- Fix the merger configuration that adds the correct slug / sidebar labels
- Add an overview page for the workflows reference.
- Fixes to components and build scripts
2024-08-13 12:30:55 +00:00
Shahed Nasser 1c8aeb9735 chore(medusa,types): [14/14] Add request types to API routes (#8576)
* chore(medusa,types): [14/14] Add request types to API routes

* more types
2024-08-13 12:57:13 +03:00
Shahed Nasser 5ff5159cee chore(medusa,types): [13] Add request types to API routes (#8575) 2024-08-13 12:56:54 +03:00
Shahed Nasser 369d7b54d2 chore(medusa,types): [12] Add request types to API routes (#8574) 2024-08-13 12:56:35 +03:00
Shahed Nasser 82de6572f9 chore(medusa,types): [11] Add request types to API routes (#8572) 2024-08-13 12:56:18 +03:00
Shahed Nasser fc439a32f1 chore(medusa,types): [8] Add request types to API routes (#8565) 2024-08-13 10:10:10 +03:00
Shahed Nasser 571a3d1671 chore(medusa,types): [7] Add request types to API routes (#8564)
Add request types as type arguments in API routes. This also includes adding / rearranging types under the `types` package.

PR 7/n
2024-08-13 07:00:36 +00:00
Shahed Nasser 163205a9a2 docs-util: associate an API route with the workflow it uses (#8554) 2024-08-13 09:56:06 +03:00
Shahed Nasser 705ea0ad33 docs: improve the workflow hooks guide (#8538)
* initial

* docs: improve workflow hook guides
2024-08-13 09:55:37 +03:00
Shahed Nasser d0db833817 docs: added troubleshooting for using pnpm (#8537) 2024-08-13 09:54:56 +03:00
Shahed Nasser 35da5dedc1 docs: fix build errors + update medusa docs link (#8550)
* docs: update medusa docs link

* fix @medusajs/icon version

* fix user guide build

* fix build error
2024-08-13 08:51:20 +02:00
Shahed Nasser b78e286224 chore(medusa,types): [10] Add request types to API routes (#8567) 2024-08-13 09:38:56 +03:00
Shahed Nasser 61cbc8c0be chore(medusa,types): [9] Add request types to API routes (#8566) 2024-08-13 09:38:33 +03:00
Shahed Nasser 6d210c67b1 chore(medusa,types): [6] Add request types to API routes (#8563)
* chore(medusa,types): [6] Add request types to API routes

* more types
2024-08-13 09:37:36 +03:00
Shahed Nasser eb331a4bca chore(medusa,types): [5] Add request types to API routes (#8562)
* chore(medusa,types): [5] Add request types to API routes

* more types
2024-08-13 09:37:24 +03:00
Shahed Nasser 078c2df773 chore(medusa,types): [4] Add request types to API routes (#8561) 2024-08-13 09:37:11 +03:00
Shahed Nasser 578e5182dd chore(medusa,types): [3] Add request types to API routes (#8560)
* chore(medusa,types): [3] Add request types to API routes

* more types
2024-08-13 09:36:56 +03:00
Shahed Nasser e5e8489cc0 chore(medusa,types): [2] Add request types to API routes (#8559)
* chore(medusa,types): [2] Add request types to API routes

* fix up base currency
2024-08-13 09:36:41 +03:00
Shahed Nasser 24985cf89d chore(medusa,types): [1] Add request types to API routes (#8558)
Add request types as type arguments in API routes. This also includes adding / rearranging types under the `types` package.

PR 1/n
2024-08-12 11:27:00 +00:00
Shahed Nasser f14f398685 feat(create-medusa-app): prompt for database name with credentials (#8552)
* feat(create-medusa-app): prompt for database name with credentials

* refactor
2024-08-12 11:52:21 +03:00
Shahed Nasser a19c562bec docs-util: add support for workflows in markdown theme (#8485)
* add template for workflows

* initial changes

* added support for parallel steps

* added support for when

* added merge options

* fix merge options

* fix to tooltip

* clean up

* remove redirects

* fixes

* theme fixes + added merge options

* generate hook examples + fixes

* changed namespaces

* add custom autogenerator

* change type of additional data
2024-08-09 16:35:52 +03:00
Shahed Nasser 79b49c1288 chore(core-flows): export used steps / workflows (#8534)
Export steps / workflows I missed that weren't exported but are used by other workflows
2024-08-09 13:29:54 +00:00
Shahed Nasser f659c6d8bd chore(core-flows): [10] export types and types, add basic TSDocs (#8520)
* chore(core-flows): [10] export types and types, add basic TSDocs

* fix overlapping names

* fix overlapping name
2024-08-09 09:08:27 +02:00
Shahed Nasser f9a8fcc0bc chore(core-flows): [13] export types and steps, add basic TSDocs (#8523) 2024-08-08 21:14:10 +03:00
Shahed Nasser 10f72f15b0 chore(core-flows): [15] export types and steps, add basic TSDocs (#8525) 2024-08-08 21:13:55 +03:00
Shahed Nasser 6efdfbc9a6 chore(core-flows): [18/18] export types and types, add basic TSDocs (#8529) 2024-08-08 20:03:49 +03:00
Shahed Nasser faa09d12f6 chore(core-flows): [17] export types and steps, add basic TSDocs (#8528) 2024-08-08 20:03:38 +03:00
Shahed Nasser 8ee3da4644 chore(core-flows): [16] export types and steps, add basic TSDocs (#8527) 2024-08-08 20:03:27 +03:00
Shahed Nasser e386216512 chore(core-flows): [14] export types and steps, add basic TSDocs (#8524) 2024-08-08 20:03:13 +03:00
Shahed Nasser 288ed2747b chore(core-flows): [12] export types and types, add basic TSDocs (#8522) 2024-08-08 20:02:42 +03:00
Shahed Nasser 4c2d605599 chore(core-flows): [11] export types and types, add basic TSDocs (#8521) 2024-08-08 20:02:28 +03:00
Shahed Nasser 945b920708 chore(core-flows): [9] export types and types, add basic TSDocs (#8519)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 9/n
2024-08-08 16:41:12 +00:00
Shahed Nasser 6e4037edf4 chore(core-flows): [8] export types and types, add basic TSDocs (#8517)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 8/n
2024-08-08 16:39:32 +00:00
Shahed Nasser 89fd065fa3 chore(core-flows): [7] export types and types, add basic TSDocs (#8514)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 7/n
2024-08-08 16:38:10 +00:00
Shahed Nasser 0bfe31e594 chore(core-flows): [6] export types and types, add basic TSDocs (#8512)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 6/n
2024-08-08 16:37:03 +00:00
Shahed Nasser f9989e1659 chore(core-flows): [5] export types and types, add basic TSDocs (#8510)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 5/n
2024-08-08 14:15:06 +00:00
Shahed Nasser cb6796fe4b chore(core-flows): [2] export types and types, add basic TSDocs (#8505)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 2/n
2024-08-08 14:14:55 +00:00
Shahed Nasser 1bb4e764d1 chore(core-flows): [3] export types and types, add basic TSDocs (#8507)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 3/n
2024-08-08 14:12:05 +00:00
Shahed Nasser 9ea0783494 chore(core-flows): [4] export types and types, add basic TSDocs (#8509)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 4/n
2024-08-08 14:11:52 +00:00
Shahed Nasser 73cc66905a chore(core-flows): [1] export types and types, add basic TSDocs (#8504)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 1/n
2024-08-08 13:15:44 +00:00
Shahed Nasser fe200e0bb3 docs-util: added a namespaces plugin (#8500)
Added a namespaces plugin that allows generating namespaces and automatically adds reflections in a path pattern to the namespace.

This is particularly useful for the workflows reference, as workflows under the `**/packages/core/core-flows/**/workflows/**` path pattern are shown under a Workflows title, and steps under the path pattern `**/packages/core/core-flows/**/steps/**` are shown under a Steps title.
2024-08-08 13:03:42 +00:00
Shahed Nasser eb09a063dc chore: fix actions generating docs (#8486)
* chore: fix actions generating docs

* add to vale tests
2024-08-08 09:22:55 +03:00
Shahed Nasser c870302400 docs-util: added workflows typedoc plugin (#8463)
* initial changes

* finish workflow plugin

* add comments

* remove todo
2024-08-06 14:23:24 +03:00
Shahed Nasser decd830474 docs: added a note about admin customizations as arrow functions (#8387) 2024-08-06 09:44:22 +02:00
Shahed Nasser f04adaf0c1 chore: added and updated TSDocs of order module service (#8246)
- Added/updated TSDocs of the order module's service type + other related types.
- Renamed parameter names that were inconsistent / had typos

Note: found some minor inconsistencies in some of the method signatures. Will open a separate PR to resolve them.

Closes DOCS-783
2024-08-06 07:18:31 +00:00
Shahed Nasser 98f42e8995 feat(create-medusa-app, medusa): check Node.js version before installation. (#8452)
Check before installation with `create-medusa-app` and `medusa new` whether the current node version is >= 20. If not, exit with an error.
2024-08-06 07:15:17 +00:00
Shahed Nasser caf1bfd23b docs: fixes to notification and file module guides (#8451) 2024-08-06 09:59:46 +03:00
Shahed Nasser 041019b319 docs: merge allOf in OAS to show all object types (#8453)
* docs: merge allOf in OAS to show all object types

* add case for non objects
2024-08-06 09:57:09 +03:00
Shahed Nasser a1f86fe415 chore(utils): add missing imports in notification TSDocs (#8447)
Add missing imports in the example snippet of the notification provider.
2024-08-05 11:15:55 +00:00
Shahed Nasser 2682e2e324 docs: fix sidebar not updating when api reference path changes (#8409) 2024-08-05 13:20:53 +03:00
Shahed Nasser 8eb538ff8f docs: added a section on sending requests to api routes in admin (#8412) 2024-08-05 13:20:34 +03:00
Shahed Nasser b37e976b9a chore(core-flows): add TSDocs to the emitEventStep (#8413) 2024-08-05 13:20:22 +03:00
Shahed Nasser e7965db071 docs: added a chapter on how to emit an event (#8414) 2024-08-05 11:39:47 +03:00
Shahed Nasser bb4f002d0a docs: fix node version in create-medusa-app reference (#8443)
* docs: fix node version in create-medusa-app reference

* change node version in cli reference
2024-08-05 11:10:55 +03:00
Shahed Nasser 4d99cd5e28 docs: fix recipes sidebar + homepage cards (#8415) 2024-08-02 16:31:17 +03:00
Shahed Nasser 58b405fac9 docs: added digital product recipe example (#8223)
- Added an example for the digital product recipe
- Fixes to the digital product recipe (overview)

Closes DOCS-792
2024-08-02 13:02:06 +00:00
Shahed Nasser c4ff8c27f0 docs: added subscription recipe example (#8148)
* docs: added subscription recipe

* fixed lint errors

* pass context and container to workflow

* rename context

* fix storefront customizations

* remove container from object

* updates based on latest changes

* fix workflow return

* general fixes
2024-08-02 12:40:26 +03:00
Shahed Nasser 5ed5b45cce chore(utils, types): updated TSDocs of AbstractPaymentProvider (#8335)
- Update the TSDocs of `AbstractPaymentProvider`
- Remove old TSDocs of `IPaymentProvider`
- Update the config that generates the payment module provider reference.

Closes DOCS-781
2024-08-01 15:50:34 +00:00
Shahed Nasser 4a95a48e94 docs-util: mark type parameters as optional (#8320)
Mark all type parameters in references as optional.

Closes DOCS-802
2024-08-01 15:45:41 +00:00
Shahed Nasser 560b6c74a4 docs: add a documentation on calculating prices with taxes (#8330)
Add a documentation page on how to calculate a product's prices with taxes in the Product Module's docs.

Closes DOCS-832
2024-08-01 15:32:54 +00:00
Shahed Nasser 6fc2019534 chore(workflows-sdk): add TSDocs related to create-hook (#8380) 2024-08-01 09:57:14 +03:00
Shahed Nasser 22a629670b docs: add sidebar item for helper reference + examples fix (#8365) 2024-07-31 17:28:42 +03:00
Shahed Nasser 6f973d9f2b docs: added workflow hooks docs + changed workflow response (#8364)
* docs: added workflow hooks docs + changed workflow response

* Update page.mdx
2024-07-31 17:01:33 +03:00
Shahed Nasser fffd4f2b3b docs-util: support generating helper steps (#8354) 2024-07-30 19:06:16 +03:00
Shahed Nasser d4c9c1e7cd docs-util: fix how data model name is inferred (#8351) 2024-07-30 18:59:29 +03:00
Shahed Nasser 6fabb7fad2 docs: fix local link to infer slug from front matter (#8353) 2024-07-30 18:59:16 +03:00
Shahed Nasser 848d0892d9 chore(core-flows,modules-sdk): add TSDocs to helper steps (#8355) 2024-07-30 18:59:02 +03:00
Shahed Nasser 70d48a91b3 docs: added storefront guide on prices with taxes (#8326) 2024-07-30 12:52:21 +03:00
Shahed Nasser 4bd77174f0 docs-util: fix knowledge base for functions (#8337) 2024-07-30 12:52:08 +03:00
Shahed Nasser ebaf0eb53a docs-util: rename docblock-generator to docs-generator (#8331)
* docs-util: rename docblock-generator to docs-generator

* change program name

* fix action
2024-07-29 16:04:33 +03:00
Shahed Nasser 7ad4e7b1c9 docs: added typedoc plugin to parse DML json files (#8300)
* docs-util: add docblock generator for models built with DML

* add missing turbo task

* docs-util: added typedoc plugin to parse dml json files
2024-07-29 14:19:04 +02:00
Shahed Nasser f9d86683e5 docs-util: update knowledge base of docblock-generator (#8323)
* docs: update knowledge base for functions and filters

* fix build error
2024-07-29 12:34:25 +03:00
Shahed Nasser a171057fd7 chore(types): add a note about adding ssl_mode option to database URLs (#8324)
* chore(types): add a note about adding `ssl_mode` option to database URLs

* small fix
2024-07-29 12:34:10 +03:00
Shahed Nasser d127abbcda docs-util: add docblock generator for models built with DML (#8296)
* docs-util: add docblock generator for models built with DML

* add missing turbo task
2024-07-29 10:11:39 +02:00
Shahed Nasser a4eab3f37a docs: added a service factory reference (#8292)
Added a service factory reference of the generated methods and how to use them.

Since the types in the codebase are a bit complex, a generated reference won't provide a valuable result.

Instead, this reference is created manually and aims to cover common use cases, providing examples for them.

Closes DOCS-844
2024-07-26 14:40:56 +00:00
Shahed Nasser f3274a7c5b docs: update deployment guides for storefront and admin (#8279)
Update the vercel deployment guides for next.js storefront and admin

Closes DOCS-840 and DOCS-841
2024-07-26 07:21:31 +00:00
Shahed Nasser 157fa3c80f docs: remove js client and medusa react references (#8270) 2024-07-26 10:11:37 +03:00
Shahed Nasser ebd290b531 docs: added guide on how to get product variant prices (#8282) 2024-07-26 10:09:41 +03:00
Shahed Nasser eb64ae75a6 docs: update middlewares to use defineMiddlewares (#8283) 2024-07-25 17:14:06 +02:00
Shahed Nasser 0c682b92c4 docs: updates to Medusa server deployment guides (#8268)
* updated railway deployment docs

* general updates and fixes
2024-07-25 09:55:22 +03:00
Shahed Nasser 6ed1181057 chore(types): update workerMode tsdocs (#8269) 2024-07-25 09:55:12 +03:00
Shahed Nasser 0a482e972f docs: added a section to introduction on using docs (#8257)
Add a section to the introduction page explaining the different sections of the V2 docs and how / when to use them.
2024-07-24 14:16:33 +00:00
Shahed Nasser b615645952 docs: fix package names of event bus modules (#8262)
* docs: fix package names of event bus modules

* fix in config
2024-07-24 17:07:41 +03:00
Shahed Nasser ccc99b48a0 docs: add 404 page (#8260) 2024-07-24 17:07:30 +03:00
Shahed Nasser 7a0941e997 docs: fix rewrites in sub-projects to prevent loop on 404 page (#8255) 2024-07-24 17:06:54 +03:00
Shahed Nasser 774d04da48 docs: fix information related to link directions (#8236)
* docs: fix keys passed to remoteLink.create and remoteLink.dismiss

* updated hello module name + clarified note

* added details about module link directions

* fix lint errors
2024-07-24 09:16:01 +02:00
Shahed Nasser a02f6cbca6 fix(types,order): fixes to order module's service and data models (#8247)
* fix(types,order): fixes to order module's service and data models

* revert change for createLineItemAdjustments

* add missing context parameter
2024-07-24 09:00:21 +02:00
Shahed Nasser 97f64a5cfe docs: fix note about how method names are generated (#8240)
* docs: fix note about how method names are generated

* small fix
2024-07-23 18:28:34 +03:00
Shahed Nasser 55b55b6a92 docs: updates and fixes to marketplace recipe example (#8150)
- Add compensation functions to workflows
- Use steps/workflows provided by Medusa instead of implementing the steps.
- Other fixes

PR in examples repo: https://github.com/medusajs/examples/pull/1 (might be easier to review)
2024-07-23 07:10:05 +00:00
Shahed Nasser a2d08eb635 docs: document links sync command (#8212)
* docs: document links sync command

* small wording fix

* sentence fix
2024-07-22 13:17:53 +03:00