{"_id":"@8medusa/medusa-oas-cli","_rev":"4-77a2299cd7133a634e65f752dc2074d3","name":"@8medusa/medusa-oas-cli","dist-tags":{"latest":"2.12.8"},"versions":{"2.7.0":{"name":"@8medusa/medusa-oas-cli","version":"2.7.0","author":{"name":"Medusa"},"license":"MIT","_id":"@8medusa/medusa-oas-cli@2.7.0","maintainers":[{"name":"8seneca","email":"8seneca@gmail.com"}],"homepage":"https://github.com/medusajs/medusa#readme","bugs":{"url":"https://github.com/medusajs/medusa/issues"},"bin":{"medusa-oas":"dist/index.js"},"dist":{"shasum":"c8c59d7ebf82cef93c1fceb7f283e7450dc63f66","tarball":"https://registry.npmjs.org/@8medusa/medusa-oas-cli/-/medusa-oas-cli-2.7.0.tgz","fileCount":43,"integrity":"sha512-/NqTyjbFKbYk8qwYQwR4dhtfw5GPFzdA5WO7e9fOoMgjn3xu3yRBiT/gH47KFkzymVG2dbppxpqtjqpaKLFYbQ==","signatures":[{"sig":"MEQCICNQ2z4hYMHVir9obW+XgrZlhCXMu44g4wd6kB7Ik7s3AiA1q/lKKuGKHNJC5om5nUFXyEtW+zXqSLg471pnQdlqpw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":69046},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"8618e6ee3843069ea189ea64d5191d93db52dc9d","scripts":{"build":"tsc --build","medusa-oas":"ts-node src/index.ts"},"_npmUser":{"name":"8seneca","email":"8seneca@gmail.com"},"repository":{"url":"git+https://github.com/medusajs/medusa.git","type":"git","directory":"packages/cli/oas/medusa-oas-cli"},"_npmVersion":"10.9.2","description":"OAS CLI","directories":{},"_nodeVersion":"22.14.0","dependencies":{"execa":"1.0.0","yargs":"^17.7.2","lodash":"^4.17.21","commander":"^10.0.0","openapi3-ts":"^3.1.2","@redocly/cli":"^1.7.0","@types/lodash":"^4.14.191","@8medusa/utils":"2.7.0","swagger-inline":"^6.1.0","@8medusa/medusa":"2.7.0","@readme/openapi-parser":"^2.4.0","@readme/json-schema-ref-parser":"^1.2.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.1.0","uuid":"^9.0.0","js-yaml":"^4.1.0","ts-jest":"^29.1.0","ts-node":"^10.9.1","typescript":"4.9.5","@8medusa/types":"2.7.0","@types/js-yaml":"^4.0.9"},"_npmOperationalInternal":{"tmp":"tmp/medusa-oas-cli_2.7.0_1744935918728_0.7935379441541413","host":"s3://npm-registry-packages-npm-production"}},"2.12.2":{"name":"@8medusa/medusa-oas-cli","version":"2.12.2","author":{"name":"Medusa"},"license":"MIT","_id":"@8medusa/medusa-oas-cli@2.12.2","maintainers":[{"name":"8seneca","email":"8seneca@gmail.com"}],"homepage":"https://github.com/medusajs/medusa#readme","bugs":{"url":"https://github.com/medusajs/medusa/issues"},"bin":{"medusa-oas":"dist/index.js"},"dist":{"shasum":"f1ef4de741cda8da829fb538155016e7a49ff384","tarball":"https://registry.npmjs.org/@8medusa/medusa-oas-cli/-/medusa-oas-cli-2.12.2.tgz","fileCount":43,"integrity":"sha512-0Nbb7XJQot8PzUBla9zD/RWXpFJxoUusL1bUiFlHWbMIWiSbQQdHi/Mr8kBJ0c7+4I1N43d7j+t5zrhJI8Db0A==","signatures":[{"sig":"MEQCIEUQlqYPF7QK+hTI+38k6qmAoS1bwn3Y6N0AiDMxv42RAiABqziL3RwyzFnZ5EbqNG7wtE7L5s7bPiqygv2j9ESiZw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":69050},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"efc900ca372e613bd3c6481915dc6edb27a91a86","scripts":{"build":"tsc --build","medusa-oas":"ts-node src/index.ts"},"_npmUser":{"name":"8seneca","email":"8seneca@gmail.com"},"repository":{"url":"git+https://github.com/medusajs/medusa.git","type":"git","directory":"packages/cli/oas/medusa-oas-cli"},"_npmVersion":"10.9.4","description":"OAS CLI","directories":{},"_nodeVersion":"22.22.1","dependencies":{"execa":"1.0.0","yargs":"^17.7.2","lodash":"^4.17.21","commander":"^10.0.0","openapi3-ts":"^3.1.2","@redocly/cli":"^1.7.0","@types/lodash":"^4.14.191","@8medusa/utils":"2.12.2","swagger-inline":"^6.1.0","@8medusa/medusa":"2.12.2","@readme/openapi-parser":"^2.4.0","@readme/json-schema-ref-parser":"^1.2.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.1.0","uuid":"^9.0.0","js-yaml":"^4.1.0","ts-jest":"^29.1.0","ts-node":"^10.9.1","typescript":"4.9.5","@8medusa/types":"2.12.2","@types/js-yaml":"^4.0.9"},"_npmOperationalInternal":{"tmp":"tmp/medusa-oas-cli_2.12.2_1776402127725_0.7043443208058098","host":"s3://npm-registry-packages-npm-production"}},"2.12.4":{"name":"@8medusa/medusa-oas-cli","version":"2.12.4","author":{"name":"Medusa"},"license":"MIT","_id":"@8medusa/medusa-oas-cli@2.12.4","maintainers":[{"name":"8seneca","email":"8seneca@gmail.com"}],"homepage":"https://github.com/medusajs/medusa#readme","bugs":{"url":"https://github.com/medusajs/medusa/issues"},"bin":{"medusa-oas":"dist/index.js"},"dist":{"shasum":"1d683db39dcb9617f18e1a95d639718e9cccafb4","tarball":"https://registry.npmjs.org/@8medusa/medusa-oas-cli/-/medusa-oas-cli-2.12.4.tgz","fileCount":43,"integrity":"sha512-ADqzmbgja0Ml7EyZOVN4FdcWWjZ9fqY+C93XzJ3TORYf3fM2U06ElsbnLwWSHPjvgnc2nbrU+hF6H8VAworhww==","signatures":[{"sig":"MEUCIGIo0NJBMpMwEbYbXdOwPkcZeilXGXElh9RMQ++d9x3tAiEAtbQzDu9zQBofWuDOvJcu9Fri9Qm5ZEEAyOq4nDum/bw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":69050},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"2d7fdd0661d2c7c695996ef6c081d6d38c954d93","scripts":{"build":"tsc --build","medusa-oas":"ts-node src/index.ts"},"_npmUser":{"name":"8seneca","email":"8seneca@gmail.com"},"repository":{"url":"git+https://github.com/medusajs/medusa.git","type":"git","directory":"packages/cli/oas/medusa-oas-cli"},"_npmVersion":"10.9.4","description":"OAS CLI","directories":{},"_nodeVersion":"22.22.1","dependencies":{"execa":"1.0.0","yargs":"^17.7.2","lodash":"^4.17.21","commander":"^10.0.0","openapi3-ts":"^3.1.2","@redocly/cli":"^1.7.0","@types/lodash":"^4.14.191","@8medusa/utils":"2.12.2","swagger-inline":"^6.1.0","@8medusa/medusa":"2.12.4","@readme/openapi-parser":"^2.4.0","@readme/json-schema-ref-parser":"^1.2.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.1.0","uuid":"^9.0.0","js-yaml":"^4.1.0","ts-jest":"^29.1.0","ts-node":"^10.9.1","typescript":"4.9.5","@8medusa/types":"2.12.4","@types/js-yaml":"^4.0.9"},"_npmOperationalInternal":{"tmp":"tmp/medusa-oas-cli_2.12.4_1776826428102_0.3775405156206628","host":"s3://npm-registry-packages-npm-production"}},"2.12.8":{"name":"@8medusa/medusa-oas-cli","version":"2.12.8","description":"OAS CLI","main":"dist/index.js","bin":{"medusa-oas":"dist/index.js"},"repository":{"type":"git","url":"git+https://github.com/medusajs/medusa.git","directory":"packages/cli/oas/medusa-oas-cli"},"publishConfig":{"access":"public"},"author":{"name":"Medusa"},"license":"MIT","devDependencies":{"@8medusa/types":"2.12.4","@types/js-yaml":"^4.0.9","jest":"^29.1.0","js-yaml":"^4.1.0","ts-jest":"^29.1.0","ts-node":"^10.9.1","typescript":"4.9.5","uuid":"^9.0.0"},"scripts":{"build":"tsc --build","medusa-oas":"ts-node src/index.ts"},"dependencies":{"@8medusa/medusa":"2.12.8","@8medusa/utils":"2.12.2","@readme/json-schema-ref-parser":"^1.2.0","@readme/openapi-parser":"^2.4.0","@redocly/cli":"^1.7.0","@types/lodash":"^4.14.191","commander":"^10.0.0","execa":"1.0.0","lodash":"^4.17.21","openapi3-ts":"^3.1.2","swagger-inline":"^6.1.0","yargs":"^17.7.2"},"_id":"@8medusa/medusa-oas-cli@2.12.8","gitHead":"c5e40e7274667effee38fd8a5716a6a8cab2f06b","types":"./dist/index.d.ts","bugs":{"url":"https://github.com/medusajs/medusa/issues"},"homepage":"https://github.com/medusajs/medusa#readme","_nodeVersion":"22.22.1","_npmVersion":"10.9.4","dist":{"integrity":"sha512-EbQzFwO9HypD3gTHImJ0OuToIrlxzzyf8h5EliUg+CrzabEUUl+nO77ISzskjrjjOQ8kwmUFBel60OqVPOoWmA==","shasum":"64de51eaaf72bce77a2d467c889f3de9a8cfb94f","tarball":"https://registry.npmjs.org/@8medusa/medusa-oas-cli/-/medusa-oas-cli-2.12.8.tgz","fileCount":43,"unpackedSize":69050,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIEfhnembTCERSYOFFqKxncsEaplPWINg6n1xG7ukvLPoAiA4L6cv5eQRUHnsqTen2oFe82ysPku7ZzRzE1dcLLzRjw=="}]},"_npmUser":{"name":"8seneca","email":"8seneca@gmail.com"},"directories":{},"maintainers":[{"name":"8seneca","email":"8seneca@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/medusa-oas-cli_2.12.8_1779251017133_0.06505533622866166"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-18T00:25:18.630Z","modified":"2026-05-20T04:23:37.407Z","2.7.0":"2025-04-18T00:25:18.943Z","2.12.2":"2026-04-17T05:02:07.912Z","2.12.4":"2026-04-22T02:53:48.258Z","2.12.8":"2026-05-20T04:23:37.265Z"},"bugs":{"url":"https://github.com/medusajs/medusa/issues"},"author":{"name":"Medusa"},"license":"MIT","homepage":"https://github.com/medusajs/medusa#readme","repository":{"type":"git","url":"git+https://github.com/medusajs/medusa.git","directory":"packages/cli/oas/medusa-oas-cli"},"description":"OAS CLI","maintainers":[{"name":"8seneca","email":"8seneca@gmail.com"}],"readme":"# medusa-oas-cli - 0.1.0 - experimental\n\nA command-line tool for all OpenAPI Specifications (OAS) related tooling.\n\n## Install\n\n`yarn add --dev @8medusa/medusa-oas-cli`\n\nInstall in the global namespace is not yet supported.\n~~`npm install -g @8medusa/medusa-oas-cli`~~\n\n## Configuration / First time setup\n\nN/A\n\n## How to use\n\n```bash\nyarn medusa-oas <command>\n```\n\n---\n\n### Command - `oas`\n\nThis command will scan the `@8medusa/medusa` package in order to extract JSDoc OAS into a json file.\n\nThe command will output one of three the files `admin.oas.json`, `store.oas.json` or `combined.oas.json` in the same\ndirectory that the command was run.\n\nInvalid OAS with throw an error and will prevent the files from being outputted.\n\n#### `--type <string>`\n\nSpecify which API OAS to create. Accepts `admin`, `store`, `combined`.\n\nThe `combined` option will merge both the admin and the store APIs into a single OAS file.\n\n```bash\nyarn medusa-oas oas --type admin\n```\n\n#### `--out-dir <path>`\n\nSpecify in which directory should the files be outputted. It accepts a relative or absolute path.\nIf the directory doesn't exist, it will be created. Defaults to `./`.\n\n```bash\nyarm medusa-oas oas --out-dir\n```\n\n#### `--paths <paths...>`\n\nAllows passing additional directory paths to crawl for JSDoc OAS and include in the generated OAS.\nIt accepts multiple entries.\n\n```bash\nyarn medusa-oas oas --paths ~/medusa-server/src\n```\n\n#### `--base <path>`\n\nAllows overwriting the content the API's base.yaml OAS that is fed to swagger-inline.\nPaths, tags, and components will be merged together. Other OAS properties will be overwritten.\n\n```bash\nyarn medusa-oas oas --base ~/medusa-server/oas/custom.oas.base.yaml\n```\n\n#### `--dry-run`\n\nWill package the OAS but will not output file. Useful for validating OAS.\n\n```bash\nyarn medusa-oas oas --dry-run\n```\n\n#### `--force`\n\nIgnore OAS errors and attempt to output generated OAS files.\n\n```bash\nyarn medusa-oas oas --force\n```\n\n---\n\n### Command - `docs`\n\nWill sanitize OAS for use with Redocly's API documentation viewer.\n\n#### `--src-file <path>`\n\nSpecify the path to the OAS JSON file.\n\n```bash\nyarm medusa-oas docs --src-file ./store.oas.json\n```\n\n#### `--out-dir <path>`\n\nSpecify in which directory should the files be outputted. Accepts relative and absolute path.\nIf the directory doesn't exist, it will be created. Defaults to `./`.\n\n```bash\nyarn medusa-oas docs --src-file ./store.oas.json --out-dir ./docs`\n```\n\n#### `--config <path>`\n\nSpecify the path to a Redocly config file.\n\n```bash\nyarn medusa-oas --src-file ./store.oas.json --config ./redocly-config.yaml\n```\n\n#### `--dry-run`\n\nWill sanitize the OAS but will not output file. Useful for troubleshooting circular reference issues.\n\n```bash\nyarn medusa-oas docs --src-file ./store.oas.json --dry-run\n```\n\n#### `--clean`\n\nDelete destination directory content before generating the docs.\n\n```bash\nyarn medusa-oas docs --src-file ./store.oas.json --clean\n```\n\n#### `--split`\n\nCreates a multi-file structure output. Uses `redocly split` internally.\n\n```bash\nyarn medusa-oas docs --src-file ./store.oas.json --split\n```\n\n#### `--preview`\n\nGenerate a preview of the API documentation in a browser. Does not output files. Uses `redocly preview-docs` internally.\n\n```bash\nyarn medusa-oas docs --src-file ../../../www/apps/api-reference/specs/store.oas.json --preview\n```\n\n#### `--html`\n\nGenerate a zero-dependency static HTML file. Uses `redocly build-docs` internally.\n\n```bash\nyarn medusa-oas docs --src-file ./store.oas.json --html\n```\n","readmeFilename":"README.md"}