Commit Graph

112 Commits

Author SHA1 Message Date
Shahed Nasser
ab1bfb966d docs: generate references manually for 2.1.1 (#10534)
* docs: generate references manually for 2.1.1

* re-generate for core-flows

* Revert "re-generate for core-flows"

This reverts commit ff785c80214dc6125e2da4c6e8a674a87b03e9dd.
2024-12-10 18:49:30 +02:00
Shahed Nasser
482929f74d docs: fix page title in reference pagesnot showing + refactor workflows reference (#10537)
* docs: fix references title + refactor workflow reference generation

* update references sidebar
2024-12-10 18:19:03 +02:00
Shahed Nasser
3409953c4f docs: use tooling convention across docs (#10512) 2024-12-09 19:15:29 +02:00
Shahed Nasser
866cabf384 docs-util: normalize RelationNullableModifier in model references (#10505) 2024-12-09 15:11:45 +02:00
Shahed Nasser
8dedb97e40 docs: fix links to steps in workflow references (#10503) 2024-12-09 14:55:35 +02:00
Shahed Nasser
abdd4c9e99 docs-util: support new query type argument (#10468)
* add support for second query argument

* more fixes
2024-12-06 12:21:19 +02:00
Shahed Nasser
582f52b31d docs-util: add user, pricing, and auth as modules with DML (#10423) 2024-12-04 12:54:19 +02:00
Shahed Nasser
030b0cc095 docs: generate references manually (#10325)
* docs: generate references

* prep changes
2024-11-27 19:27:25 +02:00
Shahed Nasser
9b76d2a2d0 docs-util: fix build errors (#10275) 2024-11-25 19:38:29 +02:00
Shahed Nasser
5eccd4e87d docs: fix references generator (#10271) 2024-11-25 19:13:21 +02:00
github-actions[bot]
7865909891 chore(docs): Updated API Reference (automated) (#10258)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-11-25 14:33:22 +00:00
Shahed Nasser
dbd06a131a docs-util: remove duplicate methods from JS SDK (#10161) 2024-11-19 18:07:44 +02:00
Shahed Nasser
c054f47872 docs-utils: make reference table of content in alphabetical order (#10084) 2024-11-13 18:10:20 +02:00
Shahed Nasser
5fec006371 docs-util: fix helper step settings (#10045) 2024-11-13 11:01:14 +02:00
Shahed Nasser
e10fb34eb9 docs: fix slugs pointing to admin rather than store routes (#10063) 2024-11-13 10:42:58 +02:00
Shahed Nasser
e229bea3c1 docs: fix resolve of custom file module guide (#9840)
Closes #9833
2024-11-10 07:33:07 +00:00
Shahed Nasser
04cec64fa1 docs: show latest version in docs + update automatically (#9753) 2024-10-24 14:03:34 +03:00
github-actions[bot]
f997432e73 chore(docs): Updated API Reference (automated) (#9728)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:42:32 +00:00
github-actions[bot]
5deeae060a chore(docs): Generated References (automated) (#9727)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:41:14 +00:00
Shahed Nasser
a1190b7208 docs: generate + configure js sdk reference (#9714)
Manually generate the JS SDK reference + add it to the sidebar
2024-10-22 17:31:32 +00:00
Shahed Nasser
34621f53a3 docs-util: fixes to package renames + other options (#9671) 2024-10-21 09:53:47 +03:00
Shahed Nasser
b07dd33a57 docs-util: add configuration to generate js-sdk reference (#9630) 2024-10-17 19:32:21 +03:00
Shahed Nasser
ea5bff9034 docs: update providers to use ModuleProvider (#9579)
Document change introduced by #9544

> Note: fine to merge now as it requires generating references, which will only happen after the next release.
2024-10-16 11:37:14 +00:00
Shahed Nasser
eed88c95ec docs: improved commerce modules [5/5] (#9592)
- Improve remaining commerce modules
- Other: add a note about using methods of the modules' main services.
2024-10-16 10:25:21 +00:00
Shahed Nasser
2b77bd85a6 docs-util: fixes for OAS docs generator + framework typedoc config (#9603)
* fix order replaced in OAS response + framework tsdoc config

* fix for some types
2024-10-16 12:17:28 +03:00
Shahed Nasser
714b9e6c98 docs: update resolve path to use src (#9605)
Update path used in `resolve` of modules to start with `src`
2024-10-16 09:10:30 +00:00
Shahed Nasser
6efb5897dc docs: fix package names in module registration (#9590)
* docs: fix package names in module registration

* update references
2024-10-16 09:05:07 +02:00
Shahed Nasser
b6df24463d docs: updates for breaking changes (#9558)
- Update modules registration
- Update `medusa-config.js` to `medusa-config.ts`
- Update the out directory in the admin deployment guide
- Update logger imports
- Other fixes

Note: will need to re-generate references afterwards

Closes #9548
2024-10-14 10:40:30 +00:00
Shahed Nasser
dd162d69be docs-util: fix import in generated workflow hook snippet (#9499) 2024-10-11 17:17:02 +02:00
Shahed Nasser
bc8de8e5b1 docs: add section on testing providers (#9453) 2024-10-04 10:29:45 +03:00
Shahed Nasser
5fb9c1f82e chore(oas): general fixes to OAS (#9413)
General fixes to OAS
2024-10-02 15:21:40 +00:00
Shahed Nasser
8686ca9d12 docs: updates and fixes in utils + fulfillment provider changes (#9347)
* fix config + update deps

* rearrange sidebar + add to examples
2024-10-02 10:27:48 +03:00
Shahed Nasser
1e144e9c08 chore(oas): clean up oas (#9354)
* clean up generated oas

* fix issues in docs-util

* more fixes

* align max level

* validation fix

* add missing summaries

* fix validation

* fix exchanges route
2024-10-02 10:27:02 +03:00
Shahed Nasser
2e16949979 docs: update imports and package names across docs (#9375)
* docs: update imports and package names across docs
+ reference configs

* generate files

* fix import

* change preview to rc
2024-10-01 11:03:42 +02:00
Shahed Nasser
bd4d2fd554 docs-util: fixes following packages reorg (#9326)
- Typescript config aren't picked up properly anymore since they're moved to `_tsconfig.base.json` in the root. So, we now read the config from the config file.
- Update Typescript version in the `utils` monorepo to match that of the root monorepo
2024-09-26 17:22:08 +00:00
Shahed Nasser
be1adac024 chore(oas): [18/n] improve oas schemas (#9311)
Improve OAS schemas [18/n]
2024-09-26 14:08:10 +00:00
Shahed Nasser
af34bf6c0c chore(oas): [19/n] improve oas schemas (#9317)
- Improve OAS schemas [19/n]
- docs-generator: combine `Date | string` type to just `Date`.
2024-09-26 13:44:57 +00:00
Shahed Nasser
d352ea8122 chore(oas): [16/n] improve oas schemas (#9272)
- Improve OAS schemas [16/n]
- fixes and improvements to docs-generator tool
2024-09-26 13:02:32 +00:00
Adrien de Peretti
e096feb7d5 chore: Update modules deps (#9286) 2024-09-26 11:14:35 +05:30
Shahed Nasser
6a2a105cf8 fix(oas): support additional props, fix circular references patch, and other fixes (#9213)
* chore(oas): support additional props, fix circular references patch, and other fixes

* fix description

* description fixes
2024-09-20 17:22:19 +03:00
Shahed Nasser
4923a6e823 chore(oas): [12/n] improve oas schemas (#9200)
- improve OAS schemas [12/n]
- Support ignoring properties in type if it has the `@ignore` jsdoc tag.
2024-09-19 14:25:16 +00:00
Shahed Nasser
78eaed70e5 chore(oas): [8/n] improve oas schemas (#9163)
Improve OAS schemas [8/n]
2024-09-17 17:26:41 +00:00
Shahed Nasser
cb79a5dbff docs-util: fixes for circular references, PAK in examples, namespaces (#9091)
- Fix circular references in generated OAS comments by cloning objects
- Add publishable API key in the header of store cURL examples + change the admin authentication header to use bearer tokens.
- Add plugin to generate namespaces from the `@customNamespace` tag in TSDocs, this was available before but was removed.
- Other fixes related to re-using schemas, overwritten descriptions, and smaller fixes
2024-09-16 17:55:05 +00:00
Shahed Nasser
8d3fb7fb2b docs: use require instead of import in medusa-config.js (#9102)
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
2024-09-16 19:34:00 +02: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
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
cd909f9db3 oas: [2/2] improve store OAS (#9035) 2024-09-06 18:52:38 +03: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