{"_id":"@bitecraft/yaak2postman","_rev":"3-333a819a25df69f8314bb0ff11045865","name":"@bitecraft/yaak2postman","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"@bitecraft/yaak2postman","version":"1.0.0","keywords":["cli","postman","yaak"],"author":"","license":"MIT","_id":"@bitecraft/yaak2postman@1.0.0","maintainers":[{"name":"viniciusborgeis","email":"viniciusborgeis@gmail.com"}],"bin":{"yaak2postman":"dist/cli.js"},"dist":{"shasum":"5c8d46b332b39698ed86e7ff56fe0d4a0d127354","tarball":"https://registry.npmjs.org/@bitecraft/yaak2postman/-/yaak2postman-1.0.0.tgz","fileCount":13,"integrity":"sha512-DcDoz7w0LsQ8LJqrPWQZbYW+0pR8/nn4Gxc6eKEtWY5I8my+nR9zQ978xY45AcRP2IA7cM8Cw51D7wzCtaIBEg==","signatures":[{"sig":"MEQCIHrwCj99kuWjdnXzNWx+kmR4axUIVREq2pREximx/L7/AiBqWwYkWYOLBD0SIcxFduF19nJ6Hb9U3dmAxWfYXJ+yCA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":21820},"type":"module","engines":{"node":">=14.0.0"},"exports":{".":{"import":"./dist/cli.js"}},"gitHead":"5b0c2bc14cda49b517890cbab693afdc87bc412e","scripts":{"test":"bun test","build":"tsc","start":"bun ./src/cli.ts","prepare":"bun run build","test:watch":"bun test --watch","test:coverage":"bun test --coverage","prepublishOnly":"bun run build"},"_npmUser":{"name":"viniciusborgeis","email":"viniciusborgeis@gmail.com"},"_npmVersion":"10.9.0","description":"CLI tool to convert YAAK files to Postman","directories":{},"_nodeVersion":"22.12.0","dependencies":{"commander":"^12.0.0"},"_hasShrinkwrap":false,"devDependencies":{"bun-types":"latest","typescript":"^5.3.3","@types/node":"^20.11.24"},"_npmOperationalInternal":{"tmp":"tmp/yaak2postman_1.0.0_1736826131357_0.8777625143687624","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@bitecraft/yaak2postman","version":"1.0.1","keywords":["cli","postman","yaak"],"author":"","license":"MIT","_id":"@bitecraft/yaak2postman@1.0.1","maintainers":[{"name":"viniciusborgeis","email":"viniciusborgeis@gmail.com"}],"bin":{"yaak2postman":"dist/cli.js"},"dist":{"shasum":"50904dd69d91b614985d66b9e3893bf239c48c98","tarball":"https://registry.npmjs.org/@bitecraft/yaak2postman/-/yaak2postman-1.0.1.tgz","fileCount":13,"integrity":"sha512-GewhwjfwGmZA3j+C8NMUXcTw+dWaU+AxS4ge6IsVzo22IIYMEMLYiTXDyJlDfmWXq1tVYgM+4Tg53N9oHqbJRw==","signatures":[{"sig":"MEUCICqQXgfVpEHzJxMm5HjU5pIZIvfs9GiR9mvB57EX2hjPAiEA9rr30RnlXpfE1/1fc+Qw5O7RvoYmN9vB/cQkEfxNJgU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":21864},"type":"module","engines":{"node":">=14.0.0"},"exports":{".":{"import":"./dist/cli.js"}},"gitHead":"8503160ed6127cc9e73fc2d56c738905a927ccfb","scripts":{"test":"bun test","build":"tsc","start":"bun ./src/cli.ts","prepare":"bun run build","test:watch":"bun test --watch","test:coverage":"bun test --coverage","prepublishOnly":"bun run build"},"_npmUser":{"name":"viniciusborgeis","email":"viniciusborgeis@gmail.com"},"_npmVersion":"10.9.0","description":"CLI tool to convert YAAK files to Postman","directories":{},"_nodeVersion":"22.12.0","dependencies":{"commander":"^12.0.0"},"_hasShrinkwrap":false,"devDependencies":{"bun-types":"latest","typescript":"^5.3.3","@types/node":"^20.11.24"},"_npmOperationalInternal":{"tmp":"tmp/yaak2postman_1.0.1_1736826406544_0.9212439860796477","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@bitecraft/yaak2postman","version":"1.0.2","keywords":["cli","postman","yaak","api-client","postman-collection","converter","api-testing","rest-api","api-development","development-tools","api-tools","postman-converter","yaak-converter","api-collection","collection-converter","api-documentation","api-management","http-client","rest-client","api-workspace"],"author":{"name":"BiteCraft - Vinicius Borges","email":"viniciusborgeis@gmail.com"},"license":"MIT","_id":"@bitecraft/yaak2postman@1.0.2","maintainers":[{"name":"viniciusborgeis","email":"viniciusborgeis@gmail.com"}],"homepage":"https://github.com/BiteCraft/yaak2postman#readme","bugs":{"url":"https://github.com/BiteCraft/yaak2postman/issues"},"bin":{"yaak2postman":"dist/cli.js"},"dist":{"shasum":"f02d1b5e49007b17e6db6359699451836075d59e","tarball":"https://registry.npmjs.org/@bitecraft/yaak2postman/-/yaak2postman-1.0.2.tgz","fileCount":13,"integrity":"sha512-m6epNoyjnsvhgHb+wMO8PDqOiW+cKTJESCDZy4Nj2dbmaILgRljS8ub3RDs4sIpH18T4teykpulJc8KElLVKyw==","signatures":[{"sig":"MEUCIFKMqrm/iJFkygLMdhjrD7Eca3Jzybz1nXYDuUZ7z6R2AiEAnXM64kd8HM/J4XDzRjDKSvPK9BKPwZ8nZBDY6ejHF3w=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":22578},"type":"module","engines":{"node":">=14.0.0"},"exports":{".":{"import":"./dist/cli.js"}},"gitHead":"e23c8e7ac42f96864034a1b867f45a5aa06a0034","scripts":{"test":"bun test","build":"tsc","start":"bun ./src/cli.ts","prepare":"bun run build","test:watch":"bun test --watch","test:coverage":"bun test --coverage","prepublishOnly":"bun run build"},"_npmUser":{"name":"viniciusborgeis","email":"viniciusborgeis@gmail.com"},"repository":{"url":"git+https://github.com/BiteCraft/yaak2postman.git","type":"git"},"_npmVersion":"10.9.0","description":"CLI tool to convert YAAK files to Postman","directories":{},"_nodeVersion":"22.12.0","dependencies":{"commander":"^12.0.0"},"_hasShrinkwrap":false,"devDependencies":{"bun-types":"latest","typescript":"^5.3.3","@types/node":"^20.11.24"},"_npmOperationalInternal":{"tmp":"tmp/yaak2postman_1.0.2_1736828043505_0.18057168736084628","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@bitecraft/yaak2postman","version":"1.0.3","description":"CLI tool to convert YAAK files to Postman","type":"module","repository":{"type":"git","url":"git+https://github.com/BiteCraft/yaak2postman.git"},"bugs":{"url":"https://github.com/BiteCraft/yaak2postman/issues"},"homepage":"https://github.com/BiteCraft/yaak2postman#readme","bin":{"yaak2postman":"dist/cli.js"},"engines":{"node":">=14.0.0"},"scripts":{"build":"tsc","start":"bun ./src/cli.ts","prepublishOnly":"bun run build","prepare":"bun run build","test":"bun test","test:watch":"bun test --watch","test:coverage":"bun test --coverage"},"keywords":["cli","postman","yaak","api-client","postman-collection","converter","api-testing","rest-api","api-development","development-tools","api-tools","postman-converter","yaak-converter","api-collection","collection-converter","api-documentation","api-management","http-client","rest-client","api-workspace"],"author":{"name":"BiteCraft - Vinicius Borges","email":"viniciusborgeis@gmail.com"},"license":"MIT","devDependencies":{"@types/node":"^20.11.24","bun-types":"latest","typescript":"^5.3.3"},"dependencies":{"commander":"^12.0.0"},"exports":{".":{"import":"./dist/cli.js"}},"_id":"@bitecraft/yaak2postman@1.0.3","gitHead":"d619e59c86007ba54264338af6c818afbf4327ec","_nodeVersion":"22.12.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-XYTvEZLd0QIaPR1EsMdwMLhebforEVAgGaHj22SgcFGRCb3uqHy/W6sozPGz3ZWZh+VaK6ogVIwn0i0KrcsLWQ==","shasum":"319dea0bb0e3627932f170c6f68a80829a0b25fb","tarball":"https://registry.npmjs.org/@bitecraft/yaak2postman/-/yaak2postman-1.0.3.tgz","fileCount":13,"unpackedSize":22576,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD27vmDvyhYumJKumc3k6dYunPeUi5PPM3fV0CzSgcVbQIhAINjUKxTViyKjQwddnVnvK6m9PVPPWHm2K5Siv7xdgFO"}]},"_npmUser":{"name":"viniciusborgeis","email":"viniciusborgeis@gmail.com"},"directories":{},"maintainers":[{"name":"viniciusborgeis","email":"viniciusborgeis@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/yaak2postman_1.0.3_1736829053306_0.23813960164513737"},"_hasShrinkwrap":false}},"time":{"created":"2025-01-14T03:42:11.252Z","modified":"2025-01-14T04:30:53.679Z","1.0.0":"2025-01-14T03:42:11.567Z","1.0.1":"2025-01-14T03:46:46.786Z","1.0.2":"2025-01-14T04:14:03.691Z","1.0.3":"2025-01-14T04:30:53.467Z"},"bugs":{"url":"https://github.com/BiteCraft/yaak2postman/issues"},"author":{"name":"BiteCraft - Vinicius Borges","email":"viniciusborgeis@gmail.com"},"license":"MIT","homepage":"https://github.com/BiteCraft/yaak2postman#readme","keywords":["cli","postman","yaak","api-client","postman-collection","converter","api-testing","rest-api","api-development","development-tools","api-tools","postman-converter","yaak-converter","api-collection","collection-converter","api-documentation","api-management","http-client","rest-client","api-workspace"],"repository":{"type":"git","url":"git+https://github.com/BiteCraft/yaak2postman.git"},"description":"CLI tool to convert YAAK files to Postman","maintainers":[{"name":"viniciusborgeis","email":"viniciusborgeis@gmail.com"}],"readme":"``` \r\n __ __ _ ____ ____ _ \r\n \\ \\ / /_ _ __ _| | _|___ \\| _ \\ ___ ___| |_ _ __ ___ __ _ _ __ \r\n \\ V / _` |/ _` | |/ / __) | |_) / _ \\/ __| __| '_ ` _ \\ / _` | '_ \\ \r\n | | (_| | (_| | < / __/| __/ (_) \\__ \\ |_| | | | | | (_| | | | |\r\n |_|\\__,_|\\__,_|_|\\_\\_____|_| \\___/|___/\\__|_| |_| |_|\\__,_|_| |_|\r\n```\r\n\r\n# YAAK to Postman Converter šŸ”„\r\n\r\n> A simple CLI tool to convert YAAK exported files into Postman collections and environments šŸ› ļø\r\n\r\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\r\n[![Node.js Version](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen)](https://nodejs.org/)\r\n[![TypeScript](https://img.shields.io/badge/TypeScript-5.3.3-blue)](https://www.typescriptlang.org/)\r\n\r\n## Table of Contents\r\n\r\nā€¢ [Overview](#overview) \r\nā€¢ [Features](#features) \r\nā€¢ [Installation](#installation) \r\nā€¢ [Usage](#usage) \r\nā€¢ [Examples](#examples)\r\nā€¢ [Development](#development) \r\nā€¢ [API Reference](#api-reference) \r\nā€¢ [Contributing](#contributing) \r\nā€¢ [License](#license) \r\n\r\n## Overview šŸŽÆ\r\n\r\nYAAK to Postman Converter is a command-line interface tool that transforms YAAK format files into Postman collections and environments. It maintains folder structures, request details, and environment variables while providing a seamless conversion experience.\r\n\r\n## Features āœØ\r\n\r\n- šŸ”„ Convert YAAK files to Postman Collection v2.1.0\r\n- šŸŒ Environment variables support\r\n- šŸ“ Preserves folder hierarchy\r\n- šŸ”— Handles both relative and absolute paths\r\n- šŸš€ Fast and efficient processing\r\n- šŸ’¾ Automatic file saving\r\n- šŸŽÆ Type-safe implementation\r\n\r\n## Installation šŸ“¦\r\n\r\n```bash\r\n# Using npm\r\nnpm install -g @bitecraft/yaak2postman\r\n\r\n# Using Bun\r\nbun install -g @bitecraft/yaak2postman\r\n\r\n# Using pnpm\r\npnpm install -g @bitecraft/yaak2postman\r\n\r\n# Using yarn\r\nyarn global add @bitecraft/yaak2postman\r\n```\r\n\r\n## Usage šŸš€\r\n\r\nThe CLI supports three main usage patterns:\r\n\r\n```bash\r\n# Convert both collection and environments\r\nyaak2postman path/to/yaak-file.json\r\n\r\n# Convert only collection\r\nyaak2postman collection path/to/yaak-file.json\r\n\r\n# Convert only environments\r\nyaak2postman env path/to/yaak-file.json\r\n```\r\n\r\n## Examples šŸ“\r\n\r\n### Converting a YAAK File\r\n```bash\r\nyaak2postman ./my-api.json\r\n```\r\n\r\n### Converting Only Collection\r\n```bash\r\nyaak2postman collection ./my-api.json\r\n```\r\n\r\n### Converting Only Environment\r\n```bash\r\nyaak2postman env ./my-api.json\r\n```\r\n\r\n## Development šŸ› ļø\r\n\r\n### Prerequisites\r\n\r\n- Node.js >= 14.0.0\r\n- Bun (latest version)\r\n- TypeScript knowledge\r\n\r\n### Setting Up Development Environment\r\n\r\n1. Clone the repository:\r\n```bash\r\ngit clone https://github.com/yourusername/yaak2postman.git\r\ncd yaak2postman\r\n```\r\n\r\n2. Install dependencies:\r\n```bash\r\nbun install\r\n```\r\n\r\n3. Start development:\r\n```bash\r\nbun run start\r\n```\r\n\r\n### Building the Project\r\n\r\n```bash\r\nbun run build\r\n```\r\n\r\n## API Reference šŸ“š\r\n\r\n### YAAK Structure\r\nThe tool expects a YAAK file with the following structure:\r\n\r\n```typescript\r\ninterface YaakData {\r\n resources: {\r\n workspaces: YaakWorkspace[];\r\n environments: YaakEnvironment[];\r\n folders: YaakFolder[];\r\n httpRequests: YaakRequest[];\r\n };\r\n}\r\n```\r\n\r\n### Output Format\r\nThe tool generates Postman Collection v2.1.0 format files:\r\n\r\n```typescript\r\ninterface PostmanCollection {\r\n info: {\r\n name: string;\r\n description: string;\r\n schema: string;\r\n };\r\n item: (PostmanFolder | PostmanRequest)[];\r\n variable: PostmanVariable[];\r\n}\r\n```\r\n\r\n## Contributing šŸ¤\r\n\r\nContributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\n1. Fork the repository\r\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\r\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\r\n4. Push to the branch (`git push origin feature/AmazingFeature`)\r\n5. Open a Pull Request\r\n\r\n## License šŸ“„\r\n\r\nThis project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.\r\n\r\n---\r\n\r\nMade with ā¤ļø using TypeScript and Bun ","readmeFilename":"README.md"}