Commit Graph

1094 Commits

Author SHA1 Message Date
Shahed Nasser
ab4a422fc8 docs: fix import of LinkDefinition (#9143) 2024-09-16 12:09:47 +03:00
erickirt
512c6fc8ab Fixed misleading LinkDefinition import from the wrong package (#9139)
It appears that `LinkDefinition` was imported from the incorrect package. From my understanding, `remote-link.d.ts` imports it from the correct location, but the tutorial does not.

```typescript
import { ILinkModule, LinkDefinition, LoadedModule, ModuleJoinerRelationship } from "@medusajs/types";
```

Additionally, I am seeking expert assistance with Medusa's architecture. If someone could reach out to me, I would greatly appreciate any guidance or direction on developing specific components for a complex multi-vendor shipping and shopping platform. My goal is to effectively utilize the Medusa architecture and contribute back to the community as much as possible.

Thank you to the entire Medusa team. I hope my contributions have been helpful to new developers enhancing their experience with Medusa.

email: erickirt582@gmail.com
2024-09-16 07:22:47 +00:00
Shahed Nasser
2c8ae6073e oas: [6/n] improve oas schemas (#9122)
Improve oas schemas [6/n]
2024-09-13 07:23:09 +00:00
Shahed Nasser
a7684b45f6 docs: add new events to reference (#9121) 2024-09-13 09:22:09 +02:00
Shahed Nasser
1eccf394df docs: added docs for deleting user of actor type (#9104)
- Added to general guide on creating actor type how to delete its user later.
- Added to restaurant delivery recipe how to delete a restaurant admin
2024-09-13 07:17:36 +00: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
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
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
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
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
github-actions[bot]
95a3ac045d chore(docs): Generated References (#9034)
Generated the following references:
- `auth`
- `core_flows`
- `fulfillment`
- `modules`
- `modules_sdk`
- `order`
- `types`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-06 12:39:45 +00:00
Shahed Nasser
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
github-actions[bot]
cf3c25addf chore(docs): Updated API Reference (v2) (#9033)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-06 12:25:48 +00:00
Shahed Nasser
72f7ff882d chore: fix incorrect oas property name (#9009) 2024-09-06 12:59:11 +02:00
github-actions[bot]
a5748c6e1f chore(docs): Generated References (#9026)
Generated the following references:
- `modules`
- `product`
- `promotion`
- `types`
2024-09-06 08:53:22 +00:00
Shahed Nasser
abe7b66999 docs: rename admin-shared -> admin-sdk (#9008) 2024-09-06 10:33:34 +02:00
github-actions[bot]
25082c60cc chore(docs): Generated References (#9007)
Generated the following references:
- `auth`
- `auth_provider`
- `core_flows`
- `modules`
- `order_models`
- `types`
2024-09-05 10:18:20 +00: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
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
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
github-actions[bot]
91d0bb0260 chore(docs): Generated References (#8979)
Generated the following references:
- `core_flows`
- `fulfillment`
- `modules`
- `order`
- `promotion`
- `types`
2024-09-04 06:38:54 +00: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
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
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
github-actions[bot]
508d5d720c chore(docs): Generated References (#8953)
Generated the following references:
- `cart`
- `core_flows`
- `customer`
- `medusa_config`
- `modules`
- `types`
2024-09-03 07:20:00 +00:00
github-actions[bot]
edc19e748b chore(docs): Updated API Reference (v2) (#8954)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-03 07:18:42 +00:00