asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
4,578 Commits 2 Branches 0 Tags
8cbf6c60fec7fe8ddf59dcf420b9339f84b8636c
Commit Graph

41 Commits

Author SHA1 Message Date
Shahed Nasser
2cebadc3a8 docs: fix title of the configuration page (#6268) 
Fix the title of the configurations page which is generated by typedoc
 2024-01-31 13:50:34 +00:00
Shahed Nasser
8c7a031090 docs: refactoring of docblock generator tool (#6261) 
small refactoring of the docblock generator tool that moves all git operations and requests into the `GitManager`
 2024-01-30 17:01:54 +00:00
Shahed Nasser
96629f1916 docs: change process for generating docblocks through actions (#6237) 
This PR changes the original process of generating docblocks through actions. The process now is:

1. When a PR is merged for the branch `changeset-release/develop`, the docblock generator tool us used to generate docblocks for the changed files. The changed files are determined by retrieving all comments since the last release and the files in each of those commits.
2. If there are changes after using the docblock generator tool, a PR is opened in the branch `chore/generate-tsdocs`.
3. Once the `chore/generate-tsdocs` is merged, it triggers an action that generates the references for the docs. This changes the previous behaviour of generating references on a new release.

Both actions (that runs the docblock generator tool and that generates references for the docs) can also be triggered manually.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
 2024-01-29 08:05:14 +00:00
Shahed Nasser
f29948a6a8 docs-util: created docblock-generator tool (#6096) 2024-01-24 11:13:40 +01:00
Shahed Nasser
ddc0c9dfff docs: add anchor link to reference parameters (#6194) 
- Added anchor links to items in parameter components
- Added sectionTitle prop in markdown theme

Note: Due to the second point, the change requires generating references to see the anchor links, which would result in a big diff in this PR. Instead, next time the references are generated for a release, this feature will available for use.
 2024-01-24 08:42:55 +00:00
Shahed Nasser
4792c55226 docs: migrate guides to TSDoc references (#6100) 2024-01-22 18:38:35 +01:00
Shahed Nasser
85dad169bb chore(docs-util): change freshness check threshold (#6122) 2024-01-22 18:02:08 +01:00
Shahed Nasser
18de90e603 docs: fix tsdocs following typedoc update + 1.20 release (#6033) 
* docs: fix tsdocs following typedoc update + 1.20 release

* Fix OAS validation errors

* fixes to react-docs-generator

* fix content linting
 2024-01-09 17:15:29 +02:00
Shahed Nasser
3eee2bd5d6 chore(docs-util): update typedoc to v0.25.7 (#6032) 2024-01-09 11:27:17 +02:00
Shahed Nasser
7d650771d1 docs: generate medusa-react reference (#6004) 
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
 2024-01-05 17:03:38 +02:00
Shahed Nasser
ddc6cc13a0 docs: add TSDoc for payment processor + generate docs (#5917) 
* added tsdocs for payment processor

* generated reference for payment processor
 2023-12-18 14:02:18 +02:00
github-actions[bot]
2d127a4c67 chore(docs): Generated References (#5881) 
Generated the following references:
- `EventBusTypes`
- `IPricingModuleService`
- `ModulesSdkTypes`
- `PriceListWorkflow`
- `fulfillment`
- `js_client`
- `medusa`
- `modules`
- `pricing`
- `services`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2023-12-14 18:28:23 +00:00
Shahed Nasser
fde1e23995 chore: refactored docs-util (#5876) 2023-12-14 18:25:40 +02:00
Shahed Nasser
245e5c9a69 docs: generate documentation for UI components (#5849) 
* added tool to generate spec files for React components

* use typedoc for missing descriptions and types

* improvements and fixes

* improvements

* added doc comments for half of the components

* add custom resolver + more doc comments

* added all tsdocs

* general improvements

* add specs to UI docs

* added github action

* remove unnecessary api route

* Added readme for react-docs-generator

* remove comment

* Update packages/design-system/ui/src/components/currency-input/currency-input.tsx

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

* remove description of aria fields + add generate script

---------

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
 2023-12-13 16:02:41 +02:00
Shahed Nasser
892d737c1f docs: enhance how references are generated (#5805) 
* adjusted configurations

* enhancements to tool and configurations

* change reference in docs

* fixed issue in workflows reference

* added project name

* more optimizations

* fix context error

* added a types reference

* resolved missing types

* fix reference reflection types not having children

* add an expand url parameter

* added new option to the README

* added details about new option
 2023-12-05 15:29:41 +02:00
Shahed Nasser
f802e2460f docs: TSDoc + reference of fulfillment service (#5761) 2023-11-29 11:58:08 +00:00
Shahed Nasser
fa4935259c docs: diagrams plugin tooling (#5741) 
* added plugin

* updated plugin + added component

* dummy data TO BE REMOVED

* (wip) workflow generator tool

* add workflow generator tooling

* updated the generator tool

* added code file creation

* fix design of diagrams

* configured diagram theme

* added build script

* removed comments + unnecessary files

* general fixes

* refactored plugin

* added README + more output types
 2023-11-28 14:30:23 +00:00
Shahed Nasser
cdc1da5df7 docs: added documentation pages for experimental features (#5671) 
* docs: added documentation pages for experimental features

* fix content lint issues

* fixed lint errors

* added migration step

* added workflows introduction

* add installation guides

* added installation guides for modules + generated workflows reference

* added missing workflows reference link

* Added warning message for experimental features

* fix note
 2023-11-27 16:49:12 +00:00
Shahed Nasser
f3e20379b0 chore: added TSDoc for workflow utility functions (#5674) 
* feat(translation): Init plugin

* Create migration and entity

* Start service implementation

* fix typo

* typings

* config

* lang -> locale

* chnge config

* link

* update link

* update export

* workflow composer (wip)

* workflow step/workflow

* simplify api

* Add structured tests

* Add step name onto the step function for future usage

* new abstraction level of exported workflow

* cleanup

* rm step 4

* Add parallelize support to workflow composition

* add Symbols and support primitive types as input

* rem .only

* eslint

* cleanup + test

* resultFrom

* prevent undefined from crashing

* finalise tests

* chore: transform

* chore: tests and transform type

* move translation to my dummy

* chore: copy before transform

* yarn.lock

* chore: shortcut to property access

* Add type safety

* WIP typesafety

* WIP

* finalise typings

* remove extends unknown

* WIP

* finalise transform typings

* finalise transform typings

* workflow typs

* More typings in invoke and compensate

* rm comment

* Context as the last args

* fix step function type

* types

* fixes

* fixes compose

* chore: transform

* chore: fix tests and transform Proxy

* chore: args length

* uncomment

* chore: array fill

* WIP fix filler

* WIP fix filler

* chore: remove only

* apply gap filler to create step invoke

* context first

* fixes

* wofkrlow ts documentation

* wofkrlow ts documentation

* wofkrlow ts documentation

* wofkrlow ts documentation

* wofkrlow ts documentation

* chore: hook

* hook types

* update types

* don't loose previous iteration

* update implementation

* fix some tests part 1

* finalise typings

* rm new lines

* fixes

* wip

* fixes

* fix tests

* simplify types

* simplify types

* update export

* improve types exclusion compensateInput

* allow a workflow to return plain object composed of stepReturn properties

* only allow one handler for the hook registration

* only allow one handler for the hook registration

* workflow loading

* lint

* lint

* lint

* finalise tests

* try to fix ci

* try to fix ci

* remove corepack step

* cleanup

* cleanup

* cleanup

* chore: context as 2nd argumentq

* added tsdoc for some workflow functions

* Add support for StepResponse and re work the typings

* changeset

* chore: invoke output as default compensate input

* copy data

* copy data

* fix createWorkflow result

* added tsdoc to remaining utility functions

* rm test file

* proxify input and transformer as well

* transformer should re run + type update

* rework step response

* allow void return from steps

* updates to the TSDocs

* address comments

* address PR feedback

* add await for API Route examples

* ignore documenting hooks

---------

Co-authored-by: adrien2p <adrien.deperetti@gmail.com>
Co-authored-by: Carlos R. L. Rodrigues <rodrigolr@gmail.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
 2023-11-23 16:38:43 +00:00
Shahed Nasser
c51dce164d docs: general fixes to references (#5653) 
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
 2023-11-17 19:36:58 +02:00
Shahed Nasser
95aa5a2d28 docs: generate inventory and stock location references (#5645) 2023-11-16 11:10:23 +02:00
Shahed Nasser
c6dff873de docs: update docusaurus to v3 (#5625) 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
 2023-11-13 20:11:50 +02:00
github-actions[bot]
39649b3552 chore(docs): Generated References (#5602) 
Generated the following references:
- `pricing`
- `product`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2023-11-10 17:31:02 +00:00
github-actions[bot]
f35fcb810f chore(docs): Generated References (#5593) 
* chore(docs): Generated References (automated)

* fix sidebar and links

* removed reflection path section

---------

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Shahed nasser <shahednasser@gmail.com>
 2023-11-09 20:23:25 +02:00
Shahed Nasser
4f91263588 chore: fix generate automated reference action (#5589) 
* chore: fix generate automated reference action

* fix dependencies

* add depends in turbo

* add install step for www workspace
 2023-11-09 17:14:28 +02:00
Shahed Nasser
91615f9c45 chore: improve JS Client TSDoc comments (#5582) 
* add oas schema to tsdoc parser

* add tsdoc (part 1)

* Finished tsdoc in js client

* general fixes

* added tsdoc in core medusa package

* parse schema tags in model files

* added maxlevel option

* added more tsdoc

* added tsdoc in core

* added TSDoc in core package

* generated client types

* support featureFlag and expandable tags

* added support for resource feature flag note

* fix api ignore plugin

* added eslint plugin

* support feature flag and expandable badges

* adjusted overview page + generated reference

* revert generated files

* added changeset

* add details about new typedoc options

* fix broken link
 2023-11-09 12:51:17 +02:00
Shahed Nasser
4692f54b49 chore(docs-util): fix freshness check script (#5518) 2023-11-01 12:28:34 +02:00
Shahed Nasser
9f29f18ee9 chore(docs-util): fix announcement script (#5503) 2023-10-31 17:27:12 +01:00
Shahed Nasser
2ac05066ac chore(docs-util): Improve generate references script and action (#5472) 
* chore(docs-util): Improve generate references script and action

* added if condition for API reference

* fix api reference condition

* fix description of action

* fix body value

* fix step name
 2023-10-25 17:12:10 +03:00
Shahed Nasser
1a10822cae docs: update override price selection strategy documentation (#5438) 
* docs: update override price selection strategy documentation

* fix eslint errors
 2023-10-20 20:17:45 +03:00
github-actions[bot]
9dcd62c731 chore(docs): Generated JS Client Reference (#5421) 
* chore(docs): Generated JS Client Reference (automated)

* fix js client reference

* fix links

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed nasser <shahednasser@gmail.com>
 2023-10-20 14:01:27 +03:00
Shahed Nasser
28d2f2ea98 docs: fix parameters display in module reference (#5425) 
* prettify json output

* fix parameter optional + array children
 2023-10-19 19:34:17 +03:00
Shahed Nasser
8d0a45ec14 chore: added TSDocs to product module service interface (#5341) 
* added tsdocs for product module service

* general fixes

* added generate github action

* fix typedoc configurations

* update comments

* change configurations

* address PR feedback
 2023-10-18 19:41:53 +03:00
Shahed Nasser
2d74ec256f docs: resdesign and restructure modules references (#5372) 
* docs: change format of module reference

* description fix

* update structure + comments

* added new options to README

* small text fix

* change section ordering

* change how required/optional are shown

* remove optional text

* docs: redesigned accordion
 2023-10-16 19:51:55 +03:00
Shahed Nasser
f0af8ecc89 docs: generate pricing module reference (#5349) 
* docs: generate pricing module reference

* added notes about new configurations
 2023-10-11 14:08:19 +03:00
github-actions[bot]
daea35fe73 chore(docs): Generated JS Client Reference (#5334) 
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>
 2023-10-10 17:47:07 +00:00
Shahed Nasser
57bd38bb4b chore: added and improved TSDoc of pricing module (#5335) 
* adjusted tsdoc of methods and types in pricing module

* finished adding tsdocs

* small fixes

* remove reference files

* added github action

* fix typo in outPath

* Update packages/types/src/shared-context.ts

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>

* fix sharedContext description

* changed branch name of action

* added ignore for is_dynamic

* added private remark

---------

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
 2023-10-10 13:23:54 +03:00
Shahed Nasser
418ff2a33a chore: fix tsconfig in utils (#5328) 2023-10-09 18:19:00 +03:00
Shahed Nasser
85c4cdf9af chore: fix path prefix of reference generation scripts (#5324) 
* chore: fix path prefix of reference generation scripts

* fix build step
 2023-10-09 16:43:54 +03:00
Shahed Nasser
ce93d75cc5 chore: fix generate reference command name in action (#5320) 
* chore: fix generate reference command name

* fix require path in typedoc config

* add missing dependencies
 2023-10-09 13:45:19 +03:00
Shahed Nasser
0350eeb0a1 docs: create typedoc theme and plugins for references (#5297) 
* update typedoc and its plugins

* refactor existing typedoc configurations

* added new typedoc plugin and themes

* added more customization options

* added more customization options

* refactored doc-utils to a workspace

* fix tsconfig

* update README files

* remove comments

* revert type changes

* remove dependencies no longer needed

* removed modules action
 2023-10-05 12:09:42 +03:00