Commit Graph
100 Commits
Author SHA1 Message Date
Shahed NasserandGitHub 0aeba83a66 docs: update scheduled jobs docs (#7905)
- Update scheduled jobs docs to support updated definition + remove coming soon notice
- Update scheduled jobs everywhere else they're used.
2024-07-02 09:41:15 +00:00
Shahed NasserandGitHub 6cb28eedf7 docs: document composite indices + primary key changes (#7902) 2024-07-02 12:34:44 +03:00
Shahed NasserandGitHub a8f2115157 docs: update pricing docs (#7895)
Update pricing docs following latest changes
2024-07-01 16:34:13 +00:00
Shahed NasserandGitHub 9b5f26adab chore: action to generate documentation references (#7888)
Added an action that triggers documentation actions generating references
2024-07-01 13:54:17 +00:00
Shahed NasserandGitHub dd864da4e0 generate references (#7882) 2024-07-01 16:02:36 +03:00
Shahed NasserandGitHub b9036eca1a docs: generate OAS for v2 (#7883) 2024-07-01 15:35:45 +03:00
Shahed NasserandGitHub 8fde57263f fix(create-medusa-app): remove preview links (#7884)
Remove temporary doc links set in `STORE_CORS` and `ADMIN_CORS`
2024-07-01 12:16:12 +00:00
Shahed NasserandGitHub 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 NasserandGitHub b62f23ea00 docs: additions and improvements to modules and DML documentation (#7854)
* docs: additions and improvements to modules and DML documentation

* small wording fix
2024-07-01 10:26:40 +03:00
Shahed NasserandGitHub 72f7500c84 chore(docs): DML API Reference (#7863)
* added dml options

* added tsdocs + configurations
2024-07-01 10:21:56 +03:00
Shahed NasserandGitHub 9ded63cc62 chore: OAS and TSDoc fixes (#7864) 2024-07-01 10:21:34 +03:00
Shahed NasserandGitHub 1842cd33cf docs: rename provider module to module provider (#7869)
* docs: rename provider module to module provider

* fix vale rule

* vale fixes
2024-07-01 10:21:19 +03:00
Shahed NasserandGitHub 2833e3c4d0 fix(order): set correct change type for exchanges (#7870) 2024-07-01 10:20:58 +03:00
Shahed NasserandGitHub 6e65158af3 docs-util: Upgrade typedoc to 0.26 (#7853)
Upgrade typedoc to v0.26 + make changes based on the update

Note: This update produces an error when generating model references when the models use the `createPsqlIndexStatementHelper` decorator. As this isn't a breaking error, and as we'll move to DML in the future, it's not necessary to spend time on a fix.
2024-06-27 10:52:44 +00:00
Shahed NasserandGitHub 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 NasserandGitHub 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
Shahed NasserandGitHub 79d90fadc4 feat(utils): configure notification module by default (#7814)
Add the notification module to `defineConfig` and configure the local notification module.
2024-06-24 14:47:40 +00:00
Shahed NasserandGitHub 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 NasserandGitHub 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 NasserandGitHub 7e7e6e3311 chore: fix OAS circular dependencies (#7693) 2024-06-12 19:42:03 +02:00
Shahed NasserandGitHub 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 NasserandGitHub 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 NasserandGitHub 2597990363 docs: fix details of selecting fields and relationships in api reference (#7642) 2024-06-09 15:19:51 +02:00
Shahed NasserandGitHub 46c5c5fe28 docs: added storefront regions guides (#7623) 2024-06-09 15:19:09 +02:00
Shahed NasserandGitHub 6946814944 docs: update recipes to be based on v2 (#7516) 2024-06-09 15:18:43 +02:00
Shahed NasserandGitHub 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 NasserandGitHub bd302e678e fix(medusa): return a single category instead of an array in retrieve category route (#7638)
* fix(medusa): return a single category instead of an array in retrieve category route

* change to use refetchEntity
2024-06-06 19:30:31 +02:00
Shahed NasserandGitHub 636bf3a15f fix(medusa-oas-cli): add circular dependency (#7639) 2024-06-06 20:26:11 +03:00
Shahed NasserandGitHub 6798bd9a0d docs-util: fix path to packages in mermaid plugin (#7640) 2024-06-06 20:25:34 +03:00
Shahed NasserandGitHub fa0c7dfbb5 fix(create-medusa-app): set the database host and port explicitely (#7637)
* pass host and port explicitely

* set AUTH_CORS in env
2024-06-06 18:26:06 +03:00
Shahed NasserandGitHub 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 NasserandGitHub 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 NasserandGitHub 1a1ef4f208 chore: fix generate docs pipelines (#7595) 2024-06-04 14:51:05 +03:00
Shahed NasserandGitHub 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 NasserandGitHub 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 NasserandGitHub 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 NasserandGitHub 872c42c6dc chore(utils): added TSDocs to AbstractAuthModuleProvider (#7550)
Added TSDocs to AbstractAuthModuleProvider. These are used to generate the reference on how to create an auth provider module.
2024-06-03 07:41:09 +00:00
Shahed NasserandGitHub 6b86b1d531 chore(types): add TSDocs to the user module's types (#7549) 2024-05-30 18:04:44 +03:00
Shahed NasserandGitHub fe96bd39b1 docs: change config snippets to use defineConfig (#7546) 2024-05-30 16:47:28 +03:00
Shahed NasserandGitHub 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 NasserandGitHub 11e3b9a456 chore: remove babel from eslint config (#7531) 2024-05-30 10:04:16 +03:00
Shahed NasserandGitHub 27b64c23f0 feat(create-medusa-app): support more environment variables + fixes (#7533) 2024-05-29 21:25:31 +02:00
Shahed NasserandGitHub 65ee18c5bc chore(modules-sdk): Small fix to error wording (#7526)
* chore(modules-sdk): Small fix to error wording

* rename variables

* fix tests

* rename plugins to providers in tests
2024-05-29 21:17:35 +02:00
Shahed NasserandGitHub c46c643fda chore: fix generate resources reference action (#7503) 2024-05-29 17:30:12 +03:00
Shahed NasserandGitHub 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 NasserandGitHub 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
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 NasserandGitHub 8f97af0d91 docs: update config to be camel case (#7501) 2024-05-28 15:52:03 +03:00
Shahed NasserandGitHub 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 NasserandGitHub f8252b3d27 chore(medusa): pin @swc/core version to 1.5.7 (#7490) 2024-05-28 09:35:32 +02:00
Shahed NasserandGitHub 223b3978b2 docs: fix data payload of events in subscribers (#7406) 2024-05-28 09:24:40 +02:00
Shahed NasserandGitHub 7b059562d7 fix(core-flows): change default currency to eur (#7476) 2024-05-27 19:23:38 +03:00
Shahed NasserandGitHub 639758ffec chore(create-medusa-app): remove .github directory (#7473)
As we're adding some actions to the starter, it doesn't make sense to keep them in the cloned projects with `create-medusa-app`. This PR removes the `.github` directory from the project after cloning it
2024-05-27 12:43:49 +00:00
Shahed NasserandGitHub 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
Shahed NasserandGitHub b5b41c7a33 chore: remove duplicate package in changeset (#7472)
Remove `@medusajs/ui` from the preview changeset because it's added twice which causing an error in the release pipeline
2024-05-27 14:29:03 +02:00
Shahed NasserandGitHub 7390821da5 fix(link-modules): move readonly link to readonly directory (#7446) 2024-05-24 16:32:25 +03:00
Shahed NasserandGitHub 98808b6caa fix(link-modules): remove duplicate fulfillment set location link (#7441)
Remove the link defined in `location-fulfillment-set` because it's a duplicate of `fulfillment-set-location`.
2024-05-24 12:04:44 +00:00
Shahed NasserandGitHub bfa1dc27cb chore: add auth-emailpass package to changeset (#7437) 2024-05-24 07:02:14 +00:00
Shahed NasserandGitHub 9cbe0085d0 feat(create-medusa-app): remove admin email prompt (#7417)
* feat(create-medusa-app): remove admin email prompt

* change to constant
2024-05-23 12:23:45 +03:00
Shahed NasserandGitHub 6f1b90f207 fix(dashboard): fixes to strings (#7411)
* fix(dashboard): fix the text of manage areas

* add missing string

* add missing react import
2024-05-23 11:07:01 +03:00
Shahed NasserandGitHub bb5872de48 fix(dashboard): fix reservation's button text + documentation links (#7405)
* fix(dashboard): fix reservation's button text

* change documentation links
2024-05-22 18:39:19 +03:00
Shahed NasserandGitHub 5e0f98f578 fix(admin-sdk): error when admin needs build (#7401)
Fix the error shown when admin is not built instructing the user to run the `build` command.
2024-05-22 13:02:24 +00:00
Shahed NasserandGitHub 24a2ab754a fix(create-medusa-app): fix seed step to use seed script in package.json (#7397)
Fix the seed step to use the `seed` script defined in `package.json` to avoid issues if the file is renamed or path is changed
2024-05-22 11:41:45 +00:00
Shahed NasserandGitHub 6ab7cbd529 chore: fixes to ConfigModule's docblocks (#7390) 2024-05-22 13:40:53 +03:00
Shahed NasserandGitHub 6fa23a2695 feat(medusa): add error handling to exec script (#7394) 2024-05-22 12:39:34 +02:00
Shahed NasserandGitHub 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 NasserandGitHub 2187b82d5d fix(core-flows,types): general fixes to workflow types (#7392) 2024-05-22 11:27:12 +02:00
Shahed NasserandGitHub e443a7be3f feat(create-medusa-app): install v2 by default (#7381)
- Remove `v2` option and install V2 starter branch by default.
- Use new `exec` command to seed data
- Install v2 branch of next.js starter if the option is provided.
- Change the opened browser to `localhost:9000/app`.
- Added a bunch of todos for onboarding flows once we have that
2024-05-21 19:45:43 +00:00
Shahed NasserandGitHub 1f43290cec feat(medusa-cli): added branch option (#7384) 2024-05-21 21:17:01 +02:00
Shahed NasserandGitHub 73c917fdce feat(medusa,medusa-cli): add an exec command (#7376) 2024-05-21 10:56:44 +02:00
Shahed NasserandGitHub cd312287f5 docs-util: add type argument of MedusaRequest as query parameter for get requests (#7359) 2024-05-20 09:51:37 +03:00
Shahed NasserandGitHub 5d4bf83145 docs: fix code block highlighting for lines starting with spaces (#7356) 2024-05-20 09:49:52 +03:00
Shahed NasserandGitHub 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 NasserandGitHub 9b1998b9b2 docs: update events reference (#7321)
* change subscribers events

* add event references for modules
2024-05-16 09:01:12 +02:00
Shahed NasserandGitHub 1160a34f3d docs: handle Card and CardList components in cross-links plugin (#7338) 2024-05-16 09:40:42 +03:00
Shahed NasserandGitHub 7a8937fcba fix(medusa): use pre-defined type in subscriber args (#7328) 2024-05-14 17:37:58 +03:00
Shahed NasserandGitHub 9ca302d33f fix(medusa): fix type of data in SubscriberArgs (#7324) 2024-05-14 13:59:25 +03:00
Shahed NasserandGitHub 70c4ffff8b docs: improve API testing feature (#7311) 2024-05-14 10:12:53 +03:00
Shahed NasserandGitHub 8958214350 chore: fix docs PR label removing team label (#7308)
* chore: fix docs PR labeler to only run with PR is opened

* add team labeler action

* move docs labeler to team labeler
2024-05-13 18:55:31 +03:00
Shahed NasserandGitHub 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 NasserandGitHub 803e4aad02 docs: added file module docs (#7278) 2024-05-13 18:54:59 +03:00
Shahed NasserandGitHub 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 NasserandGitHub 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 NasserandGitHub 3e3b8a483f chore: add action to automatically label docs (#7284)
* chore: add action to automatically label docs

* removes the paths param
2024-05-13 09:36:47 +03:00
Shahed NasserandGitHub 1a68f4602c feat(api-ref): show schema of a tag (#7297) 2024-05-10 21:07:35 +03:00
Shahed NasserandGitHub e960f10aba fix(docblock-generator): fix how type names created from Zod objects are inferred (#7292) 2024-05-10 21:06:55 +03:00
Shahed NasserandGitHub 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 NasserandGitHub 5d0ffe8ff4 docs: refactored versioning in api reference + modified v2 content (#7274) 2024-05-09 17:23:49 +03:00
Shahed NasserandGitHub c71a06c87f fix(medusa): import and use RequestQueryFields from types package (#7275)
Noticed that `RequestQueryFields` is defined in both the `medusa` and `types` package. Within the `medusa` package sometimes it uses the local type definition or the definition in `types`.

This PR removes the type definition of `RequestQueryFields` in `medusa` and uses that in `types` instead.
2024-05-08 12:55:29 +00:00
Shahed NasserandGitHub 67944dcc92 fix(medusa): Fix request type in upload route (#7271)
The `/admin/uploads` route uses an incorrect input type `CreateProductDTO`. This PR fixes it to the type defined in `validators.ts`.
2024-05-08 10:47:35 +00:00
Shahed NasserandGitHub 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
Shahed NasserandGitHub 14d15df866 docs: added advanced workflows documentation (#7252) 2024-05-07 10:32:36 +03:00
e7a3528367 fix(create-medusa-app): don't open browser to admin if v2 option is passed (#7253)
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-05-06 18:35:32 +02:00
Shahed NasserandGitHub 651b953db7 fix(medusa-oas-cli, oas-github-ci): updated paths to docs directories following monorepo reorganization (#7245)
* fix(medusa-oas-cli, oas-github-ci): updated paths to docs directories following monorepo reorganization

* revert change to workspaces

* change oas in workspaces

* revert change in test script
2024-05-06 16:15:38 +03:00
Shahed NasserandGitHub 7b2879d643 chore(docs): Fix docblock-generator OAS tool's max-stack error (#7246)
* regenerate oas to fix duplicate keys

* fix clean:oas script

* fix max-stack errors

* fix max-level condition
2024-05-06 13:41:59 +03:00
Shahed NasserandGitHub b39de05535 chore: move docs-util to www (#7232)
* reorganize docs apps

* add README

* fix directory

* add condition for old docs

* move docs-util to www

* remove remaining docs-util

* fixes of paths

* fix scripts

* path fixes

* fix github actions

* add build packages script
2024-05-06 09:13:50 +03:00
Shahed NasserandGitHub 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
Shahed NasserandGitHub 5bc780a646 feat(medusa-cli): added v2 flag (#7211) 2024-05-03 08:43:54 +02:00
Shahed NasserandGitHub b6083ce104 docs: added documentation for toast component changes (#7141)
* docs: added documentation for toast component changes

* added redirect from use-toast docs to upgrade guide

* remove unused file

* content linting fixes

* update UI package version

* updated ui preset

* fix upgrade guides main page
2024-05-01 18:12:10 +03:00
Shahed NasserandGitHub 347aece924 feat(docs-util): predefined OAS schemas (#7139)
* feat(docs-util): predefined OAS schemas

* small fix
2024-04-25 10:01:23 +02:00