Commit Graph
100 Commits
Author SHA1 Message Date
Shahed Nasser 8cb53da34e docs: fix medusa-react guide + specify react-query version (#5918)
* docs: fix medusa-react guide by adding missing link

* fix link

* add v4.22 as the supported version of react-query
2023-12-18 16:01:24 +02:00
Shahed Nasser ddc6cc13a0 docs: add TSDoc for payment processor + generate docs (#5917)
* added tsdocs for payment processor

* generated reference for payment processor
2023-12-18 14:02:18 +02:00
Shahed Nasser e63f4e6c7a docs: fix wishlist route (#5914) 2023-12-18 13:47:15 +02:00
Shahed Nasser a34fe9bfe3 docs: updated digital ocean spaces guide (#5900)
* docs: updated digital ocean spaces guide

* fix example
2023-12-15 17:25:18 +02:00
Shahed Nasser 525ae6d728 docs: added missing service method in digital products recipe (#5899)
* docs: added missing service method in digital products recipe

* fix lint
2023-12-15 15:40:05 +02:00
Shahed Nasser 11b1a61969 docs: fixes to digital products recipe (#5897)
* docs: fixes to digital products recipe

* fix lint errors
2023-12-15 12:39:40 +02:00
Shahed Nasser 761d2e7a69 docs: update documentation websites (#5882)
* docs: update next.js to 14.0.4

* update docusaurus to v3.0.1

* update packages dependencies

* added engines

* update lock
2023-12-14 20:43:16 +02:00
Shahed Nasser fde1e23995 chore: refactored docs-util (#5876) 2023-12-14 18:25:40 +02:00
Shahed Nasser 33dc7645d6 docs: fix upgrade guide release notes link (#5879) 2023-12-14 17:07:57 +02:00
Shahed NasserandOli Juhl a6c8490fc3 docs: updates for v1.19 (#5868)
* docs: updates for v1.19

* Update www/apps/docs/content/upgrade-guides/medusa-core/1-19.mdx

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>

* Update www/apps/docs/content/upgrade-guides/medusa-core/1-19.mdx

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-12-14 15:52:41 +01:00
Shahed Nasser 1c6c759aa8 docs: added a troubleshooting section for --db-url option (#5872)
* docs: added a troubleshooting section for --db-url option

* fix vale error
2023-12-14 14:59:07 +02:00
Shahed Nasser c0ce969cd7 docs: fixed sidebar in API reference (#5871) 2023-12-14 13:26:24 +02:00
Shahed NasserandKasper Fabricius Kristensen 245e5c9a69 docs: generate documentation for UI components (#5849)
* added tool to generate spec files for React components

* use typedoc for missing descriptions and types

* improvements and fixes

* improvements

* added doc comments for half of the components

* add custom resolver + more doc comments

* added all tsdocs

* general improvements

* add specs to UI docs

* added github action

* remove unnecessary api route

* Added readme for react-docs-generator

* remove comment

* Update packages/design-system/ui/src/components/currency-input/currency-input.tsx

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

* remove description of aria fields + add generate script

---------

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
2023-12-13 16:02:41 +02:00
Shahed Nasser edc49bfe1d docs: update required Node.js version for Next.js starter (#5859) 2023-12-13 15:12:14 +02:00
Shahed Nasser a458cd144d docs: update algolia plugin next.js details (#5807) 2023-12-05 15:49:52 +02:00
Shahed Nasser 892d737c1f docs: enhance how references are generated (#5805)
* adjusted configurations

* enhancements to tool and configurations

* change reference in docs

* fixed issue in workflows reference

* added project name

* more optimizations

* fix context error

* added a types reference

* resolved missing types

* fix reference reflection types not having children

* add an expand url parameter

* added new option to the README

* added details about new option
2023-12-05 15:29:41 +02:00
Shahed Nasser ebac617c19 docs: fix typo in onboarding (#5802) 2023-12-05 10:52:51 +02:00
Shahed Nasser c808317044 docs: added "Integrate Your Ecommerce Stack" recipe (#5774) 2023-11-30 11:27:09 +00:00
Shahed Nasser f802e2460f docs: TSDoc + reference of fulfillment service (#5761) 2023-11-29 11:58:08 +00:00
Shahed Nasser 443c611d3b docs: updated Next.js deployment guide (#5756) 2023-11-28 15:52:29 +00:00
Shahed Nasser fa4935259c docs: diagrams plugin tooling (#5741)
* added plugin

* updated plugin + added component

* dummy data TO BE REMOVED

* (wip) workflow generator tool

* add workflow generator tooling

* updated the generator tool

* added code file creation

* fix design of diagrams

* configured diagram theme

* added build script

* removed comments + unnecessary files

* general fixes

* refactored plugin

* added README + more output types
2023-11-28 14:30:23 +00:00
Shahed NasserandRiqwan Thamir d27b86ab8e docs: added examples for modules usage in Medusa (#5753)
* Add data migration script after running migrations

* Update install-medusa.mdx

* Update examples.md (#5751)

* fix lint errors

* fix comment in example

* added examples for modules usage in Medusa

---------

Co-authored-by: Riqwan Thamir <rmthamir@gmail.com>
2023-11-28 11:14:00 +00:00
Shahed Nasser deca78f749 docs: updated next.js starter docs (#5748)
* docs: updated next.js starter docs

* fix lint errors

* added migration script
2023-11-28 09:42:28 +00:00
Shahed Nasser 5f90515306 docs: fix back links for modules references (#5747) 2023-11-27 19:59:04 +00:00
Shahed Nasser dc6b815b12 docs: updated user guide for product pricing (#5744)
Updated the user guide to remove the pricing section in create/update variants sections
2023-11-27 18:37:14 +00:00
Shahed Nasser d337c6d95b docs: fix back link in Workflows API Reference (#5740)
Fix back link shown in the sidebar of the workflows API reference
2023-11-27 18:09:32 +00:00
Shahed Nasser cdc1da5df7 docs: added documentation pages for experimental features (#5671)
* docs: added documentation pages for experimental features

* fix content lint issues

* fixed lint errors

* added migration step

* added workflows introduction

* add installation guides

* added installation guides for modules + generated workflows reference

* added missing workflows reference link

* Added warning message for experimental features

* fix note
2023-11-27 16:49:12 +00:00
Shahed Nasser 547b16ead5 docs: fix code block titles (#5733)
* docs: fix code block titles

* remove console

* fix build error
2023-11-27 16:08:10 +00:00
Shahed Nasser a2f42d1d1c docs: update Next.js starter main image (#5702) 2023-11-23 18:28:36 +00:00
f3e20379b0 chore: added TSDoc for workflow utility functions (#5674)
* feat(translation): Init plugin

* Create migration and entity

* Start service implementation

* fix typo

* typings

* config

* lang -> locale

* chnge config

* link

* update link

* update export

* workflow composer (wip)

* workflow step/workflow

* simplify api

* Add structured tests

* Add step name onto the step function for future usage

* new abstraction level of exported workflow

* cleanup

* rm step 4

* Add parallelize support to workflow composition

* add Symbols and support primitive types as input

* rem .only

* eslint

* cleanup + test

* resultFrom

* prevent undefined from crashing

* finalise tests

* chore: transform

* chore: tests and transform type

* move translation to my dummy

* chore: copy before transform

* yarn.lock

* chore: shortcut to property access

* Add type safety

* WIP typesafety

* WIP

* finalise typings

* remove extends unknown

* WIP

* finalise transform typings

* finalise transform typings

* workflow typs

* More typings in invoke and compensate

* rm comment

* Context as the last args

* fix step function type

* types

* fixes

* fixes compose

* chore: transform

* chore: fix tests and transform Proxy

* chore: args length

* uncomment

* chore: array fill

* WIP fix filler

* WIP fix filler

* chore: remove only

* apply gap filler to create step invoke

* context first

* fixes

* wofkrlow ts documentation

* wofkrlow ts documentation

* wofkrlow ts documentation

* wofkrlow ts documentation

* wofkrlow ts documentation

* chore: hook

* hook types

* update types

* don't loose previous iteration

* update implementation

* fix some tests part 1

* finalise typings

* rm new lines

* fixes

* wip

* fixes

* fix tests

* simplify types

* simplify types

* update export

* improve types exclusion compensateInput

* allow a workflow to return plain object composed of stepReturn properties

* only allow one handler for the hook registration

* only allow one handler for the hook registration

* workflow loading

* lint

* lint

* lint

* finalise tests

* try to fix ci

* try to fix ci

* remove corepack step

* cleanup

* cleanup

* cleanup

* chore: context as 2nd argumentq

* added tsdoc for some workflow functions

* Add support for StepResponse and re work the typings

* changeset

* chore: invoke output as default compensate input

* copy data

* copy data

* fix createWorkflow result

* added tsdoc to remaining utility functions

* rm test file

* proxify input and transformer as well

* transformer should re run + type update

* rework step response

* allow void return from steps

* updates to the TSDocs

* address comments

* address PR feedback

* add await for API Route examples

* ignore documenting hooks

---------

Co-authored-by: adrien2p <adrien.deperetti@gmail.com>
Co-authored-by: Carlos R. L. Rodrigues <rodrigolr@gmail.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
2023-11-23 16:38:43 +00:00
Shahed Nasser 180b595afb docs: added a new document for available languages (#5667)
- Add a new documentation page for available languages.
- Refer to the new page from other pages.
2023-11-23 10:54:17 +00:00
Shahed Nasser 2850e9a772 docs: redesigned admonitions (#5689) 2023-11-22 17:07:29 +00:00
Shahed Nasser 00d59e28e9 docs: redesign tabs (#5687)
* redesigned tabs

* design fixes
2023-11-22 16:01:51 +00:00
Shahed Nasser 9c7ac7332a docs: added migration action to upgrade guide (#5669) 2023-11-21 14:46:22 +00:00
Shahed NasserandRiqwan Thamir fd27bc0daa chore: update tsdocs of pricing module (#5648)
* chore: update tsdocs of pricing module

* Update money-amount.ts

---------

Co-authored-by: Riqwan Thamir <rmthamir@gmail.com>
2023-11-21 11:26:07 +00:00
Shahed Nasser 9c7f95c3d5 docs: documentation for v1.18 (#5652)
* docs: documentation for v.17.5

* fix links

* updated version number
2023-11-21 08:57:11 +00:00
Shahed Nasser c51dce164d docs: general fixes to references (#5653)
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
2023-11-17 19:36:58 +02:00
Shahed Nasser 95aa5a2d28 docs: generate inventory and stock location references (#5645) 2023-11-16 11:10:23 +02:00
Shahed Nasser 61aef4aaa7 chore(types): Add TSDoc comments to IInventoryService (#5630)
* chore(types): Add TSDoc comments to IInventoryService

* fix description of list methods

* address PR feedback
2023-11-15 17:40:25 +02:00
Shahed Nasser e13995ff2f chore: add TSDocs for IStockLocationService (#5631)
* chore: add TSDocs for IStockLocationService

* address feedback
2023-11-15 15:54:20 +02:00
Shahed Nasser edeec07466 docs: added troubleshooting for postgres docker container (#5629)
* docs: added troubleshooting for postgres docker container

* fix component name
2023-11-14 12:27:38 +02:00
Shahed Nasser 26617cecf1 chore: change code owners of docs-util directory (#5626)
The `docs-util` directory holds the necessary utility to automate documentation processes. So, the code-owners of it should be the Docs team.
2023-11-14 08:53:18 +00:00
Shahed Nasser b1826a8e01 chore: add missing error responses to currency OAS (#5627) 2023-11-14 10:18:37 +02:00
Shahed Nasser c6dff873de docs: update docusaurus to v3 (#5625)
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
2023-11-13 20:11:50 +02:00
Shahed Nasser c7b8d060d7 docs: add note about ttl in redis cache module (#5617) 2023-11-13 10:42:52 +02:00
Shahed Nasser d4b8a89e66 docs: updated API Routes and Middlewares docs (#5588)
* docs: updated API Routes and Middlewares docs

* fix eslint errors
2023-11-10 11:00:08 +01:00
Shahed Nasser 3781ac4631 docs: added troubleshooting guide for promise.all (#5586)
* docs: added troubleshooting guide for promise.all

* fix eslint errors
2023-11-10 10:59:52 +01:00
Shahed Nasser d74df4878f docs: fix expandable link in ParameterType (#5595) 2023-11-09 21:20:54 +02:00
Shahed Nasser 4f91263588 chore: fix generate automated reference action (#5589)
* chore: fix generate automated reference action

* fix dependencies

* add depends in turbo

* add install step for www workspace
2023-11-09 17:14:28 +02:00
Shahed Nasser 91615f9c45 chore: improve JS Client TSDoc comments (#5582)
* add oas schema to tsdoc parser

* add tsdoc (part 1)

* Finished tsdoc in js client

* general fixes

* added tsdoc in core medusa package

* parse schema tags in model files

* added maxlevel option

* added more tsdoc

* added tsdoc in core

* added TSDoc in core package

* generated client types

* support featureFlag and expandable tags

* added support for resource feature flag note

* fix api ignore plugin

* added eslint plugin

* support feature flag and expandable badges

* adjusted overview page + generated reference

* revert generated files

* added changeset

* add details about new typedoc options

* fix broken link
2023-11-09 12:51:17 +02:00
Shahed Nasser 2576a0fd23 docs(api-reference): added local server to list of servers (#5572)
* docs(api-reference): added local server to list of servers

* fix publishable api key route
2023-11-06 17:30:56 +02:00
Shahed Nasser 0c9216c225 docs: add missing mime_type in digital products recipe (#5569)
* docs: add missing mime_type in digital products recipe

* fix lint error
2023-11-06 14:35:23 +02:00
Shahed Nasser 3bf9d8ddec chore: ignore vercel deployments when automerging (#5532)
Add vercel actions to the list of ignored checks when the `automerge` label is added to an approved PR.
2023-11-02 12:25:11 +00:00
Shahed Nasser 4692f54b49 chore(docs-util): fix freshness check script (#5518) 2023-11-01 12:28:34 +02:00
Shahed Nasser 9f29f18ee9 chore(docs-util): fix announcement script (#5503) 2023-10-31 17:27:12 +01:00
Shahed Nasser c1b97050ab feat(medusa-oas-cli,oas-github-ci): new options + added download of OAS in api reference (#5453) 2023-10-31 08:05:48 +01:00
Shahed Nasser 03959c3e3a feat(create-medusa-app): improve spinner style (#5474)
* feat(create-medusa-app): improve spinner style

* remove comment
2023-10-31 08:02:40 +01:00
Shahed Nasser 7f9c4dea66 docs: improve UX of recipe learning path (#5477)
* docs: improve UX of recipe learning path

* fix icon colors
2023-10-26 16:05:17 +03:00
Shahed Nasser 2ac05066ac chore(docs-util): Improve generate references script and action (#5472)
* chore(docs-util): Improve generate references script and action

* added if condition for API reference

* fix api reference condition

* fix description of action

* fix body value

* fix step name
2023-10-25 17:12:10 +03:00
Shahed Nasser 8bb8eb530b docs: added documentation for logging (#5469) 2023-10-25 12:49:37 +03:00
Shahed Nasser f08a295ad4 fix(admin-ui): fix analytics config not being saved in invite form (#5467) 2023-10-25 12:06:12 +03:00
Shahed Nasser 0eb56519e9 docs: improved create-medusa-app structure (#5458) 2023-10-24 18:29:05 +03:00
Shahed Nasser c67d490db3 chore(oas): Fix OAS related to JWT authentication (#5448)
* chore(oas): Fix OAS related to JWT authentication

* generate openapi spec files

* remove L option in curl examples
2023-10-23 11:48:02 +03:00
Shahed Nasser 1a10822cae docs: update override price selection strategy documentation (#5438)
* docs: update override price selection strategy documentation

* fix eslint errors
2023-10-20 20:17:45 +03:00
Shahed Nasser 8bc902fb0f chore(oas): update order OAS schema to include new fields (#5436) 2023-10-20 18:34:26 +03:00
Shahed Nasser 83f46b9b32 docs: general fixes and enhancements (#5429)
* fix #5427

* fixes #5424

* add new s3 option

* make learning path steps clickable

* remove admin demo link

* fix documentation job conditions

* update user guide images

* update commerce modules titles to match their respective pages

* change icon of discount card

* change ref to head_ref in action condition

* remove refs prefix

* fix vale action's condition
2023-10-20 13:34:40 +03:00
Shahed Nasser 1ebbf3dd33 chore: add condition for running documentation actions (#5418)
* chore: add condition for running documentation actions

* fix condition
2023-10-19 20:53:51 +03:00
Shahed Nasser 28d2f2ea98 docs: fix parameters display in module reference (#5425)
* prettify json output

* fix parameter optional + array children
2023-10-19 19:34:17 +03:00
Shahed Nasser c28935b4e8 docs: update endpoints to use file-routing approach (#5397)
- Move the original guides for creating endpoints and middlewares to sub-sections in the Endpoints category.
- Replace existing guides for endpoints and middlewares with the new approach.
- Update all endpoints-related snippets across docs to use this new approach.
2023-10-19 15:56:26 +00:00
Shahed Nasser a27083cd4b chore: fix actions of generating references (#5411) 2023-10-18 20:38:51 +03:00
Shahed Nasser 8d0a45ec14 chore: added TSDocs to product module service interface (#5341)
* added tsdocs for product module service

* general fixes

* added generate github action

* fix typedoc configurations

* update comments

* change configurations

* address PR feedback
2023-10-18 19:41:53 +03:00
Shahed Nasser 49ed7de752 chore: fix OAS for User Login JWT (#5403) 2023-10-18 17:12:30 +03:00
Shahed Nasser a1807aea83 feat(create-medusa-app): add tracking for selected options (#5404)
Adds tracking for selected options in `create-medusa-app` to better understand how users are using Medusa.
2023-10-18 09:02:40 +00:00
Shahed Nasser fc01375a8d docs: fix q parameter in search products section (#5399) 2023-10-17 19:57:36 +03:00
Shahed Nasser c089b0f54b docs: added a note about official translations (#5398) 2023-10-17 19:36:58 +03:00
Shahed Nasser 2d74ec256f docs: resdesign and restructure modules references (#5372)
* docs: change format of module reference

* description fix

* update structure + comments

* added new options to README

* small text fix

* change section ordering

* change how required/optional are shown

* remove optional text

* docs: redesigned accordion
2023-10-16 19:51:55 +03:00
Shahed Nasser 3dada88c81 docs: fix links to create notification provider (#5380) 2023-10-16 13:20:51 +03:00
Shahed Nasser cacc443fc2 chore(oas): add note about returned fields in list product variants endpoint (#5360) 2023-10-12 14:55:13 +03:00
Shahed Nasser c02fdeb789 chore(oas): fix typo in product variant's OAS (#5352)
* chore(oas): fix typo in product variant's OAS

* fix oas error
2023-10-12 14:20:08 +03:00
Shahed Nasser a91fca69ac docs: added a note about typescript declaration file (#5361) 2023-10-12 11:08:25 +03:00
Shahed Nasser 2c94186c7d docs: add a note about yarn version support in Medusa Dev CLI guide (#5355) 2023-10-11 20:16:08 +03:00
Shahed Nasser 7a4c9dec49 docs: fix entity file path in Create Entity documentation (#5351) 2023-10-11 19:52:23 +03:00
Shahed Nasser f0af8ecc89 docs: generate pricing module reference (#5349)
* docs: generate pricing module reference

* added notes about new configurations
2023-10-11 14:08:19 +03:00
Shahed Nasser 9c1c19f409 chore(docs-util): fix dependencies installation (#5345) 2023-10-11 10:46:06 +03:00
Shahed NasserandCarlos R. L. Rodrigues 57bd38bb4b chore: added and improved TSDoc of pricing module (#5335)
* adjusted tsdoc of methods and types in pricing module

* finished adding tsdocs

* small fixes

* remove reference files

* added github action

* fix typo in outPath

* Update packages/types/src/shared-context.ts

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>

* fix sharedContext description

* changed branch name of action

* added ignore for is_dynamic

* added private remark

---------

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
2023-10-10 13:23:54 +03:00
Shahed Nasser 418ff2a33a chore: fix tsconfig in utils (#5328) 2023-10-09 18:19:00 +03:00
Shahed Nasser ef3d735113 docs: update price list's user guide (#5323)
* docs: update price list's user guide

* remove import links

* hide import prices docs

* add double quotes

* fix build error

* removed import prices section

* remove text about import
2023-10-09 17:31:32 +03:00
Shahed Nasser 85c4cdf9af chore: fix path prefix of reference generation scripts (#5324)
* chore: fix path prefix of reference generation scripts

* fix build step
2023-10-09 16:43:54 +03:00
Shahed Nasser 05dbc7a877 docs: fix beta tag (#5321) 2023-10-09 14:05:55 +03:00
Shahed Nasser ce93d75cc5 chore: fix generate reference command name in action (#5320)
* chore: fix generate reference command name

* fix require path in typedoc config

* add missing dependencies
2023-10-09 13:45:19 +03:00
Shahed Nasser 4ada22d656 chore: fix OAS of batch delete product prices endpoint (#5318)
* chore: fix OAS of batch delete product prices endpoint

* fix oas check
2023-10-09 13:13:00 +03:00
Shahed Nasser 1c3faee158 docs: fix documentation actions (#5316)
* docs: fix documentation utility scripts

* change branch names
2023-10-09 12:43:14 +03:00
Shahed Nasser 4ca70a0d0c docs: fix horizontal scroll (#5300) 2023-10-05 22:38:54 +03:00
Shahed Nasser 0350eeb0a1 docs: create typedoc theme and plugins for references (#5297)
* update typedoc and its plugins

* refactor existing typedoc configurations

* added new typedoc plugin and themes

* added more customization options

* added more customization options

* refactored doc-utils to a workspace

* fix tsconfig

* update README files

* remove comments

* revert type changes

* remove dependencies no longer needed

* removed modules action
2023-10-05 12:09:42 +03:00
Shahed Nasser b3f75d8f21 docs: add AI Assistant (#5249)
* added components

* added ai assistant button

* change styling

* improve AI assistant

* change to a drawer

* added command support into search

* add AiAssistant to all projects

* remove usage of Text component

* added error handling

* use recaptcha

* fix new configurations

* fix background color

* change suggested questions
2023-10-05 11:10:44 +03:00
Shahed Nasser 0b4e7ef9c3 docs: fix preserve-symlink command for yarn in plugin docs (#5285)
* docs: fix preserve-symlink command for yarn in plugin docs

* added additional tab

* fix npm label
2023-10-04 11:49:25 +03:00
Shahed Nasser 6d9c0eb70b docs: fix usage of non-existing repository in digital products recipe (#5280)
* docs: fix usage of non-existing repository in digital products recipe

* fix content linting
2023-10-04 11:05:23 +03:00
Shahed Nasser 22130ecb63 oas: update examples and security tags (#5256)
- Change cURL examples to use `x-medusa-access-token` instead of bearer
- Add `jwt_token` to `securitySchemes` and update existing `api_token`.
2023-09-29 19:43:57 +00:00
Shahed Nasser 8cf92cea18 docs: improve contentful plugin documentation (#5255)
* docs: improve contentful plugin documentation

* fix eslint errors

* fix styling

* add collection and type migrations
2023-09-29 21:07:31 +03:00
Shahed Nasser 92f1f1a725 docs: fix webshipper plugins array section (#5253) 2023-09-29 17:43:03 +03:00