Commit Graph

766 Commits

Author SHA1 Message Date
Shahed Nasser 922fff4051 docs-util: fixes and improvements to OAS generator (#7731)
* fixed associated schema names

* move OAS method and summary descriptions to knowledge base

* refactoring and fixes

* detect default object value in delete responses
2024-06-26 11:54:09 +03:00
Shahed Nasser 0462cc5acf docs: updates to use DML and other changes (#7834)
- Change existing data model guides and add new ones for DML
- Change module's docs around service factory + remove guides that are now necessary
- Hide/remove all mentions of module relationships, or label them as coming soon.
- Change all data model creation snippets to use DML
- use `property` instead of `field` when referring to a data model's properties.
- Fix all snippets in commerce module guides to use new method suffix (no more main model methods)
- Rework recipes, removing/hiding a lot of sections as a lot of recipes are incomplete with the current state of DML.


### Other changes

- Highlight fixes in some guides
- Remove feature flags guide
- Fix code block styles when there are no line numbers.

### Upcoming changes in other PRs

- Re-generate commerce module references (for the updates in the method names)
- Ensure that the data model references are generated correctly for models using DML.
- (probably at a very later point) revisit recipes
2024-06-26 07:55:59 +00:00
Adrien de Peretti 48963f55ef Chore/rm main entity concept (#7709)
**What**
Update the `MedusaService` class, factory and types to remove the concept of main modules. The idea being that all method will be explicitly named and suffixes to represent the object you are trying to manipulate.
This pr also includes various fixes in different modules

Co-authored-by: Stevche Radevski <4820812+sradevski@users.noreply.github.com>
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-06-19 13:02:16 +00:00
Shahed Nasser c1db40b564 docs: added customer storefront guides (#7685)
* added customer guides

* fixes to sidebar

* remove old customer registration guide

* fix build error

* generate files

* run linter
2024-06-13 12:21:54 +03:00
Shahed Nasser 85d487d90b docs: added checkout storefront guides (#7678)
* add first guides

* added more guides

* finished payment + added stripe

* finished adding guides

* updated generated sidebar
2024-06-12 19:46:06 +02:00
Shahed Nasser 7e7e6e3311 chore: fix OAS circular dependencies (#7693) 2024-06-12 19:42:03 +02:00
Shahed Nasser ee6bdd0ab0 docs: add products storefront guides (#7645)
* add tips + regions pages

* docs: added storefront regions guide

* removed storefront tips chapter from book

* added product guides

* finished price guide

* add product category pages

* more categories pages

* finished category pages

* add collections guides

* add missing next.js comment

* use useRegion hook

* added missing link
2024-06-11 19:55:56 +02:00
Shahed Nasser f3bf8c73a3 docs: added cart storefront guides (#7662)
* docs: added cart storefront guides

* add context guides

* small fixes to the context
2024-06-11 11:56:37 +03:00
Shahed Nasser 2597990363 docs: fix details of selecting fields and relationships in api reference (#7642) 2024-06-09 15:19:51 +02:00
Shahed Nasser 46c5c5fe28 docs: added storefront regions guides (#7623) 2024-06-09 15:19:09 +02:00
Shahed Nasser 6946814944 docs: update recipes to be based on v2 (#7516) 2024-06-09 15:18:43 +02:00
Shahed Nasser e472aed00f docs: new + improved auth documentation pages (#7529)
* added and improved auth docs

* add prep to generates resources action

* add module options to sidebar

* fix broken link
2024-06-09 15:18:29 +02:00
Shahed Nasser 6798bd9a0d docs-util: fix path to packages in mermaid plugin (#7640) 2024-06-06 20:25:34 +03:00
Shahed Nasser 4a6327e497 docs: make code blocks collapsible (#7606)
* added collapsible code feature

* fixed side shadow

* fix build errors

* change design

* make code blocks collapsible
2024-06-05 10:28:41 +03:00
Shahed Nasser 6646a203df chore(types, utils): add TSDocs for AbstractNotificationProviderService (#7556)
Add TSDocs for `AbstractNotificationProviderService` which will be used to generate a reference on how to create a notification provider module.
2024-06-04 13:36:06 +00:00
Shahed Nasser c38f6d07c2 docs: update design + colors (#7593)
Update design and colors in docs to match those in Figma
2024-06-04 07:41:24 +00:00
Shahed Nasser 28d2a5347a chore(types, utils): added TSDocs for file provider module (#7553)
* chore(types, utils): added TSDocs for file provider module

* fix import
2024-06-03 10:18:02 +02:00
Shahed Nasser 70e1de7742 docs: change module paths in resolve (#7539)
Change the path to modules in the resolve property across docs
2024-06-03 07:41:30 +00:00
Shahed Nasser 6b86b1d531 chore(types): add TSDocs to the user module's types (#7549) 2024-05-30 18:04:44 +03:00
Shahed Nasser fe96bd39b1 docs: change config snippets to use defineConfig (#7546) 2024-05-30 16:47:28 +03:00
Shahed Nasser ddfd757277 fix(docs-util): recognize optional zod parameters (#7538)
* fix(docs-util): recognize optional zod parameters

* remove admin/auth as an authenticated route path
2024-05-30 16:47:16 +03:00
Shahed Nasser 2c5ba408d4 docs: edits and fixes to commerce module docs (#7468)
Apply edits and fixes to the commerce modules docs
2024-05-29 11:08:06 +00:00
Shahed Nasser 130de74d6d docs: updates to admin customization docs (#7493)
* updated admin docs

* re-add navigation and parameters sections

* update injection zones

* update cli scripts docs

* added list of injection zones

* add details about widget props

* restructure admin injection zones
2024-05-29 13:50:19 +03:00
Shahed Nasser 72b57e2ae4 docs: rename auth user to auth identity (#7400)
* docs: rename auth user to auth identity

* updated protected routes guide

* Update www/apps/resources/app/commerce-modules/auth/examples/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* store/me -> store/customers/me

* change scope to type

* remove soon notes

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
2024-05-29 13:47:11 +03:00
Shahed Nasser 8f97af0d91 docs: update config to be camel case (#7501) 2024-05-28 15:52:03 +03:00
Harminder Virk 82be054a1a chore: Rename config properties to camelCase (#7498)
* refactor: rename config types to camelCase

* refactor: update config references to use renamed options

* refactor: update more references

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-05-28 14:49:29 +02:00
Shahed Nasser 65be42c818 docs: add integrations page (#7421)
* add integrations page

* update payment provider docs

* use stripe icon
2024-05-28 13:25:03 +03:00
Shahed Nasser 223b3978b2 docs: fix data payload of events in subscribers (#7406) 2024-05-28 09:24:40 +02:00
Shahed Nasser 98615c388b docs-util: fixes to base OAS + circular-patch redocly plugin (#7382)
* docs-util: remove MultipleErrors schema from base OAS

* fixes to circular patch plugin

* general fixes

* change nested schemas to references
2024-05-27 14:29:48 +02:00
Adrien de Peretti b8bc3ed16f chore: Start cleaning up medusa-core-utils (#7450)
**What**
- remove medusa-core-utils
- dispatch the utils where they belongs
- update usage

**NOTE**
I have been wondering if the graceful class should go into the utils package or medusa package, I ve put it in the medusa package as it seems to be the best place I can see for now and is tight to the server as well. Also, I wanted to avoid the utils package to depends on http and net dependencies, happy to change that if you feel like it
2024-05-27 08:00:15 +00:00
Muhammad Naimul Islam 2b55208c1c docs: fix component title and description in alert.mdx (#7435)
- Removed the incorrect title and description from the Alert component page
- Added new title and description for the Alert component page
2024-05-24 15:55:42 +00:00
Shahed Nasser 6ab7cbd529 chore: fixes to ConfigModule's docblocks (#7390) 2024-05-22 13:40:53 +03: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
Riqwan Thamir 442b0b2038 chore: rename route from api-v2 to api (#7379)
* chore: rename route from api-v2 to api

* chore: change oas references

* chore: remove v2 ref
2024-05-21 10:44:02 +02:00
Shahed Nasser cd312287f5 docs-util: add type argument of MedusaRequest as query parameter for get requests (#7359) 2024-05-20 09:51:37 +03:00
Shahed Nasser 5d4bf83145 docs: fix code block highlighting for lines starting with spaces (#7356) 2024-05-20 09:49:52 +03:00
Shahed Nasser 22f30f54fd docs: update api-reference project for v2 (#7307)
* remove everything v1 and make v2 default

* move main v2 rewrites to book

* move rewrites to book + other fixes
2024-05-16 09:02:35 +02:00
Shahed Nasser 9b1998b9b2 docs: update events reference (#7321)
* change subscribers events

* add event references for modules
2024-05-16 09:01:12 +02:00
Shahed Nasser 1160a34f3d docs: handle Card and CardList components in cross-links plugin (#7338) 2024-05-16 09:40:42 +03:00
Shahed Nasser 70c4ffff8b docs: improve API testing feature (#7311) 2024-05-14 10:12:53 +03:00
Shahed Nasser 7cb90f8e82 docs: editing and general fixes of medusa's learning resources (#7261)
* docs: editing and general fixes of medusa's learning resources

* fix build script

* update ui dependency

* fix build

* adjust next.js steps
2024-05-13 18:55:11 +03:00
Shahed Nasser 803e4aad02 docs: added file module docs (#7278) 2024-05-13 18:54:59 +03:00
Shahed Nasser 8b2429d24f chore(medusa-oas-cli,oas-github-ci): remove v2 option + generate v2 by default (#7304)
* chore(medusa-oas-cli,oas-github-ci): remove v2 option + generate v2 by default

* fixes to changeset

* fix public url path
2024-05-13 17:01:38 +03:00
Shahed Nasser 728c5ee53c docs: preparations for preview (#7267)
* configured base paths + added development banner

* fix typelist site url

* added navbar and sidebar badges

* configure algolia filters

* remove AI assistant

* remove unused imports

* change navbar text and badge

* lint fixes

* fix build error

* add to api reference rewrites

* fix build error

* fix build errors in user-guide

* fix feedback component

* add parent title to pagination

* added breadcrumbs component

* remove user-guide links

* resolve todos

* fix details about authentication

* change documentation title

* lint content
2024-05-13 11:32:52 +03:00
Shahed Nasser 1a68f4602c feat(api-ref): show schema of a tag (#7297) 2024-05-10 21:07:35 +03:00
Shahed Nasser e960f10aba fix(docblock-generator): fix how type names created from Zod objects are inferred (#7292) 2024-05-10 21:06:55 +03:00
Shahed Nasser 489a54e1fb fix(docblock-generator): eslint errors + missing await (#7281)
* chore: add missing await in docblock generator

* add fix for undefined symbol

* fix dirname path
2024-05-09 17:23:59 +03:00
Shahed Nasser 5d0ffe8ff4 docs: refactored versioning in api reference + modified v2 content (#7274) 2024-05-09 17:23:49 +03:00
Shahed Nasser 327e446974 docs: general fixes and overall changes (#7258)
* editing halfway

* edited second half

* adjust starter steps

* fix build

* typo fix
2024-05-07 18:00:28 +02:00
Adrien de Peretti 71f4f46cb9 chore(medusa): cleanup medusa package (#7206) 2024-05-07 12:48:49 +02:00