This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
80 lines
2.1 KiB
JSON
80 lines
2.1 KiB
JSON
{
|
|
"name": "docs-ui",
|
|
"version": "0.0.0",
|
|
"private": true,
|
|
"license": "MIT",
|
|
"publishConfig": {
|
|
"access": "public"
|
|
},
|
|
"main": "./dist/cjs/index.js",
|
|
"types": "./dist/cjs/index.d.ts",
|
|
"module": "./dist/esm/index.js",
|
|
"exports": {
|
|
".": {
|
|
"require": {
|
|
"types": "./dist/cjs/index.d.ts",
|
|
"default": "./dist/cjs/index.js"
|
|
},
|
|
"import": {
|
|
"types": "./dist/esm/index.d.ts",
|
|
"default": "./dist/esm/index.js"
|
|
}
|
|
}
|
|
},
|
|
"sideEffects": false,
|
|
"files": [
|
|
"dist/**"
|
|
],
|
|
"scripts": {
|
|
"build": "yarn clean && yarn build:js:cjs && yarn build:js:esm",
|
|
"build:js:cjs": "tsc --project tsconfig.cjs.json && tsc-alias -p tsconfig.cjs.json",
|
|
"build:js:esm": "tsc --project tsconfig.esm.json && tsc-alias -p tsconfig.esm.json",
|
|
"clean": "rimraf dist",
|
|
"dev": "yarn build:js:cjs && yarn build:js:esm"
|
|
},
|
|
"devDependencies": {
|
|
"@types/react": "^18.2.0",
|
|
"@types/react-dom": "^18.2.0",
|
|
"@types/react-google-recaptcha": "^2.1.6",
|
|
"clsx": "^2.0.0",
|
|
"cpy-cli": "^5.0.0",
|
|
"eslint-config-docs": "*",
|
|
"next": "14.1.0",
|
|
"react": "^18.2.0",
|
|
"react-dom": "^18.2.0",
|
|
"rimraf": "^5.0.1",
|
|
"tailwind": "*",
|
|
"tailwindcss": "^3.3.3",
|
|
"tsc-alias": "^1.8.7",
|
|
"tsup": "^5.10.1",
|
|
"types": "*",
|
|
"typescript": "^5.1.6"
|
|
},
|
|
"peerDependencies": {
|
|
"@types/react": "^18.2.0",
|
|
"@types/react-dom": "^18.2.0",
|
|
"next": "*",
|
|
"react": "^18.2.0",
|
|
"react-dom": "^18.2.0"
|
|
},
|
|
"dependencies": {
|
|
"@medusajs/icons": "^1.2.0",
|
|
"@medusajs/ui": "^2.4.1",
|
|
"@octokit/request": "^8.1.1",
|
|
"@react-hook/resize-observer": "^1.2.6",
|
|
"@segment/analytics-next": "^1.55.0",
|
|
"@uidotdev/usehooks": "^2.4.1",
|
|
"algoliasearch": "^4.20.0",
|
|
"mermaid": "^10.9.0",
|
|
"npm-to-yarn": "^2.1.0",
|
|
"prism-react-renderer": "2.3.1",
|
|
"react-google-recaptcha": "^3.1.0",
|
|
"react-instantsearch": "^7.0.3",
|
|
"react-markdown": "^8.0.7",
|
|
"react-medium-image-zoom": "^5.1.10",
|
|
"react-tooltip": "^5.21.3",
|
|
"react-transition-group": "^4.4.5",
|
|
"react-uuid": "^2.0.0"
|
|
}
|
|
}
|