Commit Graph
100 Commits
Author SHA1 Message Date
Shahed Nasser 8c2a5fbcf2 fix(types, medusa): fix http type of exchanges and claims (#9123) 2024-09-12 20:33:40 +03:00
Shahed Nasser 41fb2aacb0 docs: fixes to long-running workflows + relationship docs (#9101) 2024-09-12 09:51:00 +03:00
Shahed Nasser 1466ca73e0 docs: added a services constraint document (#8999)
- Added a services constraint document mentioning that a service's methods must be async.
- Modify the code in the services intro document to use `async` method.
2024-09-10 18:00:23 +00:00
Shahed Nasser e9b5f76f9a docs: add Query documentation (#9079)
- Replace remote query documentation with new Query documentation
- Add redirect from old remote query to new query documentation
- Update remote query usages across docs to use new query usage.
2024-09-10 12:31:47 +00:00
Shahed Nasser 1d8dd54014 fix(core-flows): fix emitted event for deleting sales channel (#9081)
Fix the usage of the user event instead of sales channel event
2024-09-10 12:24:19 +00:00
Shahed Nasser 4b663a4559 docs: document events reference (#9080)
- Remove old hidden reference files that document modules' events
- Add new events reference for workflow events
- Reference events reference in the main docs
2024-09-10 12:20:09 +00:00
Shahed Nasser 3fb2f10ccb docs: fix links to inventory model references (#9073)
Closes #9070
2024-09-10 12:18:10 +00:00
Shahed Nasser 464a3e692f docs-util: fix after updating node version (#9072)
Small fix in imports after updating node version
2024-09-10 12:05:19 +00:00
Shahed Nasser 5eafa5a184 oas: [5/n] improve oas schemas (#9066)
Improve oas schemas [5/n]
2024-09-10 12:03:18 +00:00
Shahed Nasser 6e46baa2cb docs-util: fix generated hooks example (#9060)
Fix generated hook examples by the placement of `async` keyword
2024-09-09 18:53:44 +00:00
Shahed Nasser abb5f0c2fe oas: [4/n] improve oas schemas (#9064)
Improve oas schemas [4/n]
2024-09-09 18:52:49 +00:00
Shahed Nasser dfb095e2ea chore(types, medusa): clean up to request / response types (#9067)
Smaller clean up to request / response types
2024-09-09 18:52:02 +00:00
Shahed Nasser c091cf5868 docs: add prerequisites link for test guides (#9057)
- Add a prerequisites link to test guides pointing to how to setup the testing tools
- Add in the main http / module integration guides the command to run the tests
2024-09-09 13:58:42 +00:00
Shahed Nasser 2189ff2dc8 chore: fix build errors in OAS (#9059)
Fix errors stopping OAS from building
2024-09-09 13:54:14 +00:00
Shahed Nasser 4ffcc41fe7 chore(utils): update auth provider TSDocs + fix errors stopping references build (#9023)
- Updated the TSDocs of the auth provider
- Update the Node version in the docs-util as the outdated version was causing TypeScript error
- Add `@ts-ignore` for a line that was causing a typescript error. If there's a better fix here let me know
2024-09-09 13:53:33 +00:00
Shahed Nasser a5e8a55d63 docs: added storefront development guide on retrieving variant inventory details (#9032)
* docs: added storefront development guide on retrieving variant inventory details

* fix vale error
2024-09-09 10:02:59 +03:00
Shahed Nasser c962283281 fix(types, medusa): request / response types clean-up (#9043)
More clean-up of request / response types
2024-09-09 06:59:43 +00:00
Shahed Nasser 3eb2387746 docs: fix pricing query params in storefront guide + modules restructure (#9021)
- Fix pricing query params previously using `customer_group_id` and `customer_id` as expected / accepted queries and update information around them
- Other: reorganize the introduction page of each module to show how to use it at the very beginning.
2024-09-09 06:43:43 +00:00
Shahed Nasser 4b8d9cc735 oas: [3/n] improve oas schemas (#9042)
Improve oas schemas [3/n]
2024-09-07 06:16:00 +00:00
Shahed Nasser a7180e29b8 oas: [1/n] improve store oas (#8993)
* oas: [1/n] improve store oas

* add missing postal code param
2024-09-07 08:09:10 +02:00
Shahed Nasser cf387aafa2 chore: re-add oas tests for generated OAS (#9036)
* chore: re-add oas tests for generated OAS

* test fix
2024-09-07 08:01:22 +02:00
Shahed Nasser 7a80593b68 oas: [2/n] improve schema oas (#9040) 2024-09-06 18:53:07 +03:00
Shahed Nasser 0482b7751d oas: [1/n] improve oas schemas (#9039) 2024-09-06 18:52:51 +03:00
Shahed Nasser cd909f9db3 oas: [2/2] improve store OAS (#9035) 2024-09-06 18:52:38 +03:00
Shahed Nasser b5dbf572e3 docs: document star actor types (#9044) 2024-09-06 17:38:51 +02:00
Shahed Nasser 89f21e4a60 docs: fix admin actor type -> user (#9028) 2024-09-06 17:38:33 +02:00
Shahed NasserandStevche Radevski a28c911c24 docs: update auth docs + add new storefront guides (#9020)
* docs: update auth docs + add new storefront guides

* lint content

* fix vale error

* add callback response schema

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

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

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

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

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

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

* address PR comments

* replace google -> github

* better explanation for refresh token

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
2024-09-06 15:26:10 +03:00
Shahed Nasser 72f7ff882d chore: fix incorrect oas property name (#9009) 2024-09-06 12:59:11 +02:00
Shahed Nasser 3ba0ddcd43 fix(types): add inventory_quantity to http variant type (#9030) 2024-09-06 13:33:02 +03:00
Shahed Nasser ac30a989f4 feat(create-medusa-app): add publishable API key environment variable to Next.js storefront (#9029)
When installing with Next.js starter, retrieve the publishable API key seeded and add it to the environment variable in the `.env.local` or `.env.template` file
2024-09-06 09:43:55 +00:00
Shahed Nasser abe7b66999 docs: rename admin-shared -> admin-sdk (#9008) 2024-09-06 10:33:34 +02:00
Shahed Nasser beaa851302 docs-util: fix to enum type + optional (#8950)
- Fix to some enum types (with one member) not being extracted properly.
- Consider `nullish` Zod types as optional.
2024-09-04 18:36:58 +00:00
Shahed Nasser c615f4014c chore: fix oas errors (#8982)
Fix indentation and missing values in OAS resulting in an error when generating the specs in the API reference
2024-09-04 18:34:17 +00:00
Shahed Nasser 6519fd6bfd feat(types,medusa): add acknowledgement typing (#8991) 2024-09-04 21:29:57 +03:00
Shahed Nasser 951b4a8100 docs: fixes to testing tool guides (#8981) 2024-09-04 18:24:49 +00:00
Shahed Nasser 1d54e8fdc1 docs: add new API route guides + fixes and improvements to existing ones (#8987)
- Add new documentation pages for API route intro, responses, errors, and validation
- General fixes and improvements across existing API route guides

> Note: I didn't work on the guide for additional data validation. Will work on this as part of my next focus on workflows.
2024-09-04 18:23:55 +00:00
Shahed Nasser ee3580efdb fix(core-flows, types, medusa): fix batch delete types in workflows and routes (#8974)
- Fix the returned data of batch delete steps / workflows for deleted records to just be the array of IDs.
- Add a new type `BatchResponse` for API routes to have a different shape for deleted records
- Update batch delete helpers to return the expected shape for API routes
2024-09-04 18:22:48 +00:00
Shahed Nasser 4b1827ed48 fix(types,medusa): fix query types for some store routes (#8994) 2024-09-04 19:36:55 +03:00
Shahed Nasser c424d397f6 oas: [14/14] improve admin oas (#8989) 2024-09-04 19:36:27 +03:00
Shahed Nasser 090cb36543 docs-utils: fix auth detection + added query params (#8997) 2024-09-04 19:36:10 +03:00
Shahed Nasser f47f1aff49 oas: [13/n] improve admin oas (#8971)
Improve the OAS of admin API routes [13/n]
2024-09-03 16:59:37 +00:00
Shahed Nasser 423583e06c fix(medusa): fix update promotion's request type (#8966)
Fix the validator of the update promotion API route to match the update workflow input's type.
2024-09-03 15:08:22 +00:00
Shahed Nasser 58f297cc75 docs: added documentation on testing tools (#8939)
- Added documentation on how to use Medusa's tools from the `medusa-test-utils` package to create integration and unit tests.
- Added a manual reference on the `medusaIntegrationTestRunner` and `moduleIntegrationTestRunner` functions. Since the typings in the source code aren't very informative, I opted for a manual reference shedding light on the important bits.

Closes DOCS-852
2024-09-03 14:50:45 +00:00
Shahed Nasser e9fce4c5c2 docs: improvements to intro and basics chapters (#8956) 2024-09-03 17:34:07 +03:00
Shahed Nasser 7e278bef76 oas: [11/n] improve admin OAS (#8963) 2024-09-03 17:33:45 +03:00
Shahed Nasser ee2c297caa oas: [12/n] improve admin oas (#8967) 2024-09-03 17:32:58 +03:00
Shahed Nasser 46a70eaf5b docs: added a section on middlewares and trailing backslashes (#8942) 2024-09-03 17:32:36 +03:00
Shahed Nasser c42d66f239 fix(medusa): change the request type of removing products from price list (#8964)
* fix(medusa): change the request type of removing products from price list

* fix build error
2024-09-03 16:57:10 +03:00
Shahed Nasser 9a34e03ae1 fix(medusa): fix complete order API route to remove duplicate params (#8961)
Remove the `order_id` request body param from the complete order API route and use the `id` path parameter instead.
2024-09-03 10:46:00 +00:00
Shahed Nasser 123118ac8e fix(js-sdk): fix invite resend request being sent as GET instead of POST (#8960)
`/admin/invites/:id/resend` is a POST API route, but the JS SDK's `resend` method was sending a GET request.
2024-09-03 10:36:11 +00:00
Shahed Nasser f9b0605d67 docs: generate sitemaps + change search filters (#8957)
- Generate sitemaps for `book` and `resources` projects (in attempt to resolve some pages not being picked up by the crawler)
- Change the v2 search filters

> Note: will require changes to algolia's crawler + a recrawl once merged
2024-09-03 10:33:08 +00:00
Shahed Nasser 8e177538c1 oas: [10/n] improve admin oas (#8959) 2024-09-03 13:29:58 +03:00
Shahed Nasser 1a63209290 oas: [8/n] improve admin OAS (#8945)
Improve the OAS of admin API routes [8/n]
2024-09-03 06:45:11 +00:00
Shahed Nasser 29555ae518 fix(types, medusa): fixes to draft order request types (#8949)
- remove the `name` filter for orders (couldn't find any `name` property in the order data model).
- Remove the `order_id` property of a shipping method in the request body type for creating a draft order
- Update the types of `fulfillment_status` and `payment_status` in the order filters to showcase the possible status values.
2024-09-02 17:09:41 +00:00
Shahed Nasser f98bb7e2b4 docs: small fixes to marketplace recipe (#8932) 2024-09-02 15:39:58 +03:00
Shahed Nasser 2c034774f0 fix(medusa, types): fix more query types (#8907)
Fix issues / missing query types I didn't pick up in the previous PRs.
2024-09-02 07:25:05 +00:00
Shahed Nasser a969223ada oas: [5/n] Improve admin OAS (#8898)
Improve the OAS of admin API routes [5/n]
2024-09-02 07:08:47 +00:00
Shahed Nasser bc7d17cea4 oas: [4/n] Improve admin OAS (#8893)
Improve the OAS of admin API routes [4/n]
2024-09-02 07:07:56 +00:00
Shahed Nasser ba653692e1 oas: [6/n] Improve admin OAS (#8901) 2024-09-02 09:39:27 +03:00
Shahed Nasser 1f2ee24e1d oas: [7/n] Improve admin OAS (#8902) 2024-09-02 09:39:14 +03:00
Shahed Nasser 0d24262bbe docs: fix missing auth tag in api reference (#8903) 2024-09-01 11:42:27 +02:00
Shahed Nasser 7e92aa412c chore(framework): add a note for admin path configuration + add troubleshooting guide (#8905)
- add a note in the `path` configuration regarding same path as docker image
- Add a section in the troubleshooting guide for the same reason
2024-09-01 07:46:32 +00:00
Shahed Nasser c8f951dd89 docs: fixes and improvements to auth flow documentation (#8909) 2024-08-30 20:14:16 +03:00
Shahed Nasser dea5af085a docs-util: fix clean script removing Auth tags (#8911)
* docs-util: fix clean script removing Auth tags

* fix removal of response types other than json
2024-08-30 17:02:02 +03:00
Shahed Nasser 8c82207a41 docs: replace usages of migrations and links commands (#8894) 2024-08-30 11:48:49 +03:00
Shahed Nasser 170429a9b3 chore(types, medusa): [1/n] add missing query type arguments (#8877)
Add missing type arguments in listing requests.

1/n
2024-08-30 07:35:18 +00:00
Shahed Nasser bab6ad4c55 oas: [3/n] Improve admin OAS (#8875)
Improve the OAS of admin API routes [3/n]
2024-08-30 07:20:20 +00:00
Shahed Nasser 80fd20b21e chore(types, medusa): [2/n] add missing query type arguments (#8879)
Add missing type arguments in listing requests.

2/n
2024-08-30 07:18:14 +00:00
Shahed Nasser 0ee5c2d501 fix(dashboard, js-sdk, types, medusa): separate between delete response with and without parent (#8852)
- Separate the previous `DeleteResponse` to `DeleteResponse` and `DeleteResponseWithParent`, as not every API route's delete response returns a parent. This ensures more accurate types shown in OAS / documentation.
- Use `DeleteResponse` or `DeleteResponseWithParent` in response API routes based on what they return
- Remove direct usage of `DeleteResponse` in API route, and instead create a type in the `type` package specific for the route / domain.
- Use the new types in the `js-sdk` and `dashboard`.
2024-08-30 07:15:02 +00:00
Shahed Nasser 9f495fd853 chore(types, medusa): [3/3] add missing query type arguments (#8880)
Add missing type arguments in listing requests.

3/3
2024-08-30 07:07:18 +00:00
Shahed Nasser 8cf47516c1 docs: use new x-sidebar-summary for sidebar items in api-reference if available (#8865)
Use the new `x-sidebar-summary` OAS attribute when adding operations to the sidebar, if available.
2024-08-29 17:14:10 +00:00
Shahed Nasser 44d4af3a3f oas: [1/n] Improve admin OAS (#8850) 2024-08-29 20:07:33 +03:00
Shahed Nasser 75c5853163 oas: [2/n] Improve admin OAS (#8866) 2024-08-29 20:07:17 +03:00
Shahed Nasser fbd93ab67c docs: fix tag filters in search (#8862) 2024-08-29 20:05:58 +03:00
Shahed Nasser 870a863503 docs: fix overflowing card description hidden (#8871) 2024-08-29 19:48:48 +03:00
Shahed Nasser 074b4ae0da docs-util: include types in workflows.ts in generated references (#8882) 2024-08-29 18:42:26 +02:00
Shahed Nasser 9290ce88bf docs-util: fixes in schema factory + other improvements (#8874)
- Split schema factory for request / response / common types
- Fix overlapping types "string" and "regexp" to be just one string type
- If `oneOf` or `allOf` OAS schemas have one item, just use that item's type.
2024-08-29 12:35:45 +00:00
Shahed Nasser 84fb9d55f3 docs: incorrect link fixes (#8868)
Few link fixes

Closes #8856
2024-08-29 09:44:55 +00:00
Shahed Nasser ddddd4303c docs: add restaurant-delivery marketplace recipe (#8817)
Add recipe for restaurant-delivery marketplace recipe inspired by Medusa Eats

Closes DOCS-921

Preview: https://resources-docs-git-docs-restaurant-delivery-recipe-medusajs.vercel.app/v2/resources/recipes/marketplace/examples/restaurant-delivery
2024-08-29 09:33:31 +00:00
Shahed Nasser 25134d2307 docs-util: improvements and fixes to OAS generation (#8855)
- Add to knowledge base summaries for delete-related properties
- Fix long curl examples overflowing the line
- Fix singular / plural usage in some knowledge base descriptions / summaries
- Fix some workflows not picked up
- Remove query params for routes that don't use them.
2024-08-29 08:40:55 +00:00
Shahed Nasser 70f2290a22 docs: added documentation for db commands (#8846)
* docs: added documentation for db commands

* fix lint errors
2024-08-29 10:46:00 +03:00
Shahed Nasser c86a9fe864 docs-util: fix removal of manually-added schemas in clean script (#8840) 2024-08-29 10:22:50 +03:00
Shahed Nasser 68f3244de3 fix(core-flows): use unit price of item in create cart and add to cart flows (#8841)
* fix(types): fix create line item workflow type

* use unit price in workflows

* use tax inclusive from item
2024-08-28 17:34:07 +03:00
Shahed Nasser 22d92aa70a docs: add tracking for navigation usage (#8819) 2024-08-28 15:44:54 +03:00
Shahed Nasser e1fd448cd1 docs: capitalize HTTP methods in api reference (#8821) 2024-08-28 15:44:42 +03:00
Shahed Nasser bfded6c2c8 docs: improvements to base OAS (#8835)
* docs: improve base OAS

* extra new lines + design fixes
2024-08-28 15:44:05 +03:00
Shahed Nasser 61e7b2eb24 fix(admin-next,types): fix some http type names (#8836) 2024-08-28 15:43:54 +03:00
Shahed Nasser ba24e6882d fix(medusa-oas-cli): fix download url (#8763) 2024-08-28 14:23:25 +02:00
Shahed Nasser af6d43f0f0 docs-util: fix for product type schemas (#8837) 2024-08-28 12:54:35 +03:00
Shahed Nasser 8f8e2f5a65 fix(medusa): use correct request type for create cart API route (#8820) 2024-08-28 12:16:30 +03:00
Shahed Nasser 0c4f4c8a11 docs: updates following authentication flow changes (#8706)
* docs: updates following authentication flow changes

* generate sidebar

* added open api specs

* fix up OAS

* changes to existing pages

* change sidebar items

* update marketplace recipe
2024-08-27 15:47:39 +03:00
Shahed Nasser c6eba80af6 docs: generate sidebar and other data related to core-flows reference (#8811) 2024-08-27 11:22:03 +00:00
Shahed Nasser aa8e245c91 docs: [24/24] generate core-flows references (#8809) 2024-08-27 14:11:55 +03:00
Shahed Nasser 6470168526 docs: [23/n] generate core-flows reference (#8807) 2024-08-27 12:25:39 +03:00
Shahed Nasser 2b67b87137 docs: [22/n] generate core-flows reference (#8805) 2024-08-27 12:25:26 +03:00
Shahed Nasser 4f280e7cd6 docs: [21/n] generate core-flows reference (#8804)
* docs: [21/n] generate core-flows reference

* more
2024-08-27 12:25:16 +03:00
Shahed Nasser 40330650e4 docs: [20/n] generate core-flows reference (#8803) 2024-08-27 12:25:05 +03:00
Shahed Nasser c617dc873b docs: [19/n] generate core-flows reference (#8802)
* docs: [19/n] generate core-flows reference

* more
2024-08-27 12:24:54 +03:00
Shahed Nasser 9dc70a8195 docs: [18/n] generate core-flows reference (#8801) 2024-08-27 12:24:40 +03:00
Shahed Nasser c5a86a83ee docs: [17/n] generate core-flows reference (#8800) 2024-08-27 12:24:30 +03:00