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
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
090cb36543
docs-utils: fix auth detection + added query params ( #8997 )
2024-09-04 19:36:10 +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
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
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
c86a9fe864
docs-util: fix removal of manually-added schemas in clean script ( #8840 )
2024-08-29 10:22:50 +03:00
Shahed Nasser
af6d43f0f0
docs-util: fix for product type schemas ( #8837 )
2024-08-28 12:54:35 +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
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
Oli Juhl
2bacf86d3c
chore: Remove prepublishOnly script ( #8699 )
...
* wip
* wip
* verbose logging
* remove prepublish scripts
* chore: add back prepublish scripts
* wip
* remove prepublishOnly script
* chore: Clean up rest of build scripts
* add back build script
* feedback
---------
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com >
2024-08-27 10:31:38 +02:00
Shahed Nasser
0acd94aac3
docs: refactor medusa workflows reference ( #8692 )
...
* docs: fix handling of namespaces in core flows under definitions directory
* change nested handling
* docs-util: expand workflows under definitions in workflows reference
* remove check for definitions
2024-08-22 13:39:52 +03:00
Shahed Nasser
539266559c
chore: update the medusa config TSDocs + options ( #8697 )
2024-08-21 17:46:14 +03:00
Shahed Nasser
f0f83afdd9
docs-util: fix update OAS schema ( #8556 )
...
* docs-util: fix update OAS schema
* fix to updating
* fix condition
2024-08-16 12:37:03 +03:00
Shahed Nasser
5abe9f9c66
docs: fix expand badge ( #8611 )
...
* fix component
* update expand URL
2024-08-16 09:26:16 +03:00
Shahed Nasser
4bd0917aed
docs: change workflow diagram to list ( #8602 )
2024-08-15 16:47:27 +03:00
Shahed Nasser
92a7b5b4c0
docs-util: fix OAS generation error ( #8577 )
2024-08-14 11:21:22 +03:00
Shahed Nasser
cd0acbd921
docs: fixes and preparations for workflows reference ( #8579 )
...
- Fix the merger configuration that adds the correct slug / sidebar labels
- Add an overview page for the workflows reference.
- Fixes to components and build scripts
2024-08-13 12:30:55 +00:00
Shahed Nasser
163205a9a2
docs-util: associate an API route with the workflow it uses ( #8554 )
2024-08-13 09:56:06 +03:00
Shahed Nasser
a19c562bec
docs-util: add support for workflows in markdown theme ( #8485 )
...
* add template for workflows
* initial changes
* added support for parallel steps
* added support for when
* added merge options
* fix merge options
* fix to tooltip
* clean up
* remove redirects
* fixes
* theme fixes + added merge options
* generate hook examples + fixes
* changed namespaces
* add custom autogenerator
* change type of additional data
2024-08-09 16:35:52 +03:00
Shahed Nasser
fe200e0bb3
docs-util: added a namespaces plugin ( #8500 )
...
Added a namespaces plugin that allows generating namespaces and automatically adds reflections in a path pattern to the namespace.
This is particularly useful for the workflows reference, as workflows under the `**/packages/core/core-flows/**/workflows/**` path pattern are shown under a Workflows title, and steps under the path pattern `**/packages/core/core-flows/**/steps/**` are shown under a Steps title.
2024-08-08 13:03:42 +00:00
Shahed Nasser
c870302400
docs-util: added workflows typedoc plugin ( #8463 )
...
* initial changes
* finish workflow plugin
* add comments
* remove todo
2024-08-06 14:23:24 +03:00
Shahed Nasser
5ed5b45cce
chore(utils, types): updated TSDocs of AbstractPaymentProvider ( #8335 )
...
- Update the TSDocs of `AbstractPaymentProvider`
- Remove old TSDocs of `IPaymentProvider`
- Update the config that generates the payment module provider reference.
Closes DOCS-781
2024-08-01 15:50:34 +00:00
Shahed Nasser
4a95a48e94
docs-util: mark type parameters as optional ( #8320 )
...
Mark all type parameters in references as optional.
Closes DOCS-802
2024-08-01 15:45:41 +00:00
Shahed Nasser
22a629670b
docs: add sidebar item for helper reference + examples fix ( #8365 )
2024-07-31 17:28:42 +03:00
Shahed Nasser
fffd4f2b3b
docs-util: support generating helper steps ( #8354 )
2024-07-30 19:06:16 +03:00
Shahed Nasser
d4c9c1e7cd
docs-util: fix how data model name is inferred ( #8351 )
2024-07-30 18:59:29 +03:00
Shahed Nasser
4bd77174f0
docs-util: fix knowledge base for functions ( #8337 )
2024-07-30 12:52:08 +03:00
Shahed Nasser
ebaf0eb53a
docs-util: rename docblock-generator to docs-generator ( #8331 )
...
* docs-util: rename docblock-generator to docs-generator
* change program name
* fix action
2024-07-29 16:04:33 +03:00
Shahed Nasser
7ad4e7b1c9
docs: added typedoc plugin to parse DML json files ( #8300 )
...
* docs-util: add docblock generator for models built with DML
* add missing turbo task
* docs-util: added typedoc plugin to parse dml json files
2024-07-29 14:19:04 +02:00
Shahed Nasser
f9d86683e5
docs-util: update knowledge base of docblock-generator ( #8323 )
...
* docs: update knowledge base for functions and filters
* fix build error
2024-07-29 12:34:25 +03:00
Shahed Nasser
d127abbcda
docs-util: add docblock generator for models built with DML ( #8296 )
...
* docs-util: add docblock generator for models built with DML
* add missing turbo task
2024-07-29 10:11:39 +02:00
Shahed Nasser
157fa3c80f
docs: remove js client and medusa react references ( #8270 )
2024-07-26 10:11:37 +03:00
Shahed Nasser
71ebcd1bd0
docs: fix module definition for providers ( #8180 )
2024-07-18 18:59:53 +02:00
Shahed Nasser
4c004cd287
docs-util: add support for RequestWithContext in route-handler detection ( #8141 )
...
* docs-util: update OAS docblock-generator to support RequestWithContext
* support alias type arguments in case there are no type arguments
2024-07-16 13:06:19 +03:00
Carlos R. L. Rodrigues
de36e2b36e
chore: rename return flow ( #8050 )
2024-07-10 08:09:10 -03:00
Shahed Nasser
20be64e799
docs-util: normalize primary key types in DML ( #7941 )
2024-07-04 17:35:24 +03:00
Shahed Nasser
964927b597
docs: general fixes and improvements ( #7918 )
...
* docs improvements and changes
* updated module definition
* modules + dml changes
* fix build
* fix vale error
* fix lint errors
* fixes to stripe docs
* fix condition
* fix condition
* fix module defintion
* fix checkout
* disable UI action
* change oas preview action
* flatten provider module options
* fix lint errors
* add module link docs
* pr comments fixes
* fix vale error
* change node engine version
* links -> linkable
* add note about database name
* small fixes
* link fixes
* fix response code in api reference
* added migrations step
2024-07-04 17:26:03 +03:00
Shahed Nasser
dd864da4e0
generate references ( #7882 )
2024-07-01 16:02:36 +03:00
Shahed Nasser
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 Nasser
72f7500c84
chore(docs): DML API Reference ( #7863 )
...
* added dml options
* added tsdocs + configurations
2024-07-01 10:21:56 +03:00
Shahed Nasser
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 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
7e7e6e3311
chore: fix OAS circular dependencies ( #7693 )
2024-06-12 19:42:03 +02:00
