@0kmpo/openapi-clean-arch-generator 1.3.10

package/.gitea/workflows/lint.yaml

@@ -0,0 +1,41 @@
+name: Lint
+
+on:
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Cache Bun binary
+        uses: actions/cache@v4
+        with:
+          path: ~/.bun
+          key: bun-v1.3.3-${{ runner.os }}
+
+      - name: Setup Bun
+        run: |
+          if ! [ -f "$HOME/.bun/bin/bun" ]; then
+            curl -fsSL https://bun.sh/install | bash -s "bun-v1.3.3"
+          fi
+          echo "$HOME/.bun/bin" >> $GITHUB_PATH
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.bun/install/cache
+          key: ${{ runner.os }}-bun-deps-${{ hashFiles('bun.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-bun-deps-
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Run lint
+        run: bun run lint
+

package/.gitea/workflows/publish.yml

@@ -0,0 +1,105 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Cache Bun binary
+        uses: actions/cache@v4
+        with:
+          path: ~/.bun
+          key: bun-v1.3.3-${{ runner.os }}
+
+      - name: Setup Bun
+        run: |
+          if ! [ -f "$HOME/.bun/bin/bun" ]; then
+            curl -fsSL https://bun.sh/install | bash -s "bun-v1.3.3"
+          fi
+          echo "$HOME/.bun/bin" >> $GITHUB_PATH
+
+      - name: Set version from tag
+        run: |
+          VERSION=${GITHUB_REF_NAME#v}
+          echo "Setting package version to $VERSION"
+          bun -e "const fs=require('fs'); const pkg=JSON.parse(fs.readFileSync('package.json','utf8')); pkg.version='${VERSION}'; fs.writeFileSync('package.json',JSON.stringify(pkg,null,2)+'\n');"
+          SHA=$(curl -s -H "Authorization: token ${GITEA_TOKEN}" \
+            "https://git.blassanto.me/api/v1/repos/blas/openapi-clean-arch-gen/contents/package.json?ref=main" \
+            | bun -e "let d='';process.stdin.on('data',c=>d+=c).on('end',()=>console.log(JSON.parse(d).sha))")
+          CONTENT=$(base64 -w 0 package.json)
+          curl -s -X PUT \
+            -H "Authorization: token ${GITEA_TOKEN}" \
+            -H "Content-Type: application/json" \
+            "https://git.blassanto.me/api/v1/repos/blas/openapi-clean-arch-gen/contents/package.json" \
+            -d "{\"message\":\"chore: bump to version v${VERSION}\",\"content\":\"${CONTENT}\",\"sha\":\"${SHA}\",\"branch\":\"main\"}"
+        env:
+          GITEA_TOKEN: ${{ secrets.TOKEN }}
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.bun/install/cache
+          key: ${{ runner.os }}-bun-deps-${{ hashFiles('bun.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-bun-deps-
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Lint
+        run: bun run lint
+
+      - name: Build
+        run: bun run build
+
+      - name: Build binaries
+        run: bun run binaries
+
+      - name: Configure npm registry auth
+        run: |
+          echo "registry=https://registry.npmjs.org" >> ~/.npmrc
+          echo "//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}" >> ~/.npmrc
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish to npm registry
+        run: bun publish --access public
+        env:
+          BUN_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Create Gitea release and upload binaries
+        run: |
+          VERSION=${GITHUB_REF_NAME#v}
+
+          RELEASE_ID=$(curl -s -X POST \
+            -H "Authorization: token ${GITEA_TOKEN}" \
+            -H "Content-Type: application/json" \
+            "https://git.blassanto.me/api/v1/repos/blas/openapi-clean-arch-gen/releases" \
+            -d "{
+              \"tag_name\": \"${GITHUB_REF_NAME}\",
+              \"name\": \"v${VERSION}\",
+              \"body\": \"## Installation\n\nDownload the binary for your platform or install via the npm registry:\n\n\`\`\`bash\nbun add -g @0kmpo/openapi-clean-arch-generator\n\`\`\`\",
+              \"draft\": false,
+              \"prerelease\": false
+            }" | bun -e "let d='';process.stdin.on('data',c=>d+=c).on('end',()=>console.log(JSON.parse(d).id))")
+
+          echo "Created release ID: $RELEASE_ID"
+
+          for BINARY in dist/bin/*; do
+            FILENAME=$(basename "$BINARY")
+            echo "Uploading $FILENAME..."
+            curl -s -X POST \
+              -H "Authorization: token ${GITEA_TOKEN}" \
+              -F "attachment=@${BINARY};filename=${FILENAME}" \
+              "https://git.blassanto.me/api/v1/repos/blas/openapi-clean-arch-gen/releases/${RELEASE_ID}/assets"
+          done
+        env:
+          GITEA_TOKEN: ${{ secrets.TOKEN }}
+

package/.openapi-generator-ignore

@@ -0,0 +1,33 @@
+# OpenAPI Generator Ignore File
+# Archivos que no queremos generar
+
+# Documentación
+README.md
+.gitignore
+git_push.sh
+
+# NPM
+.npmignore
+package.json
+package-lock.json
+
+# TypeScript config
+tsconfig.json
+tsconfig.spec.json
+
+# Angular specific
+angular.json
+karma.conf.js
+
+# Tests que no usamos
+*.spec.ts
+
+# Variables de entorno
+variables.ts
+configuration.ts
+
+# Encoder
+encoder.ts
+
+# API base que usamos nuestra propia implementación
+api.ts

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "semi": true
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Blas Santomé Ocampo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,333 @@
+# OpenAPI Clean Architecture Generator
+
+Angular code generator that creates clean architecture boilerplate from OpenAPI/Swagger specifications. Automates the creation of DTOs, repositories, mappers, use cases and dependency injection providers.
+
+## 📦 Requirements
+
+- [Bun](https://bun.sh) >= 1.0.0
+- [Java](https://www.java.com) (required by `openapi-generator-cli`)
+
+## 🚀 Installation
+
+### Option 0: Prebuilt binary (no dependencies)
+
+Download the binary for your platform from the releases page and run it directly — no Node, Bun or Java required:
+
+```bash
+# macOS (Apple Silicon)
+curl -L https://git.blassanto.me/blas/openapi-clean-arch-gen/releases/latest/download/generate-clean-arch-macos-arm64 -o generate-clean-arch
+chmod +x generate-clean-arch && ./generate-clean-arch -i swagger.yaml
+
+# macOS (Intel)
+curl -L https://git.blassanto.me/blas/openapi-clean-arch-gen/releases/latest/download/generate-clean-arch-macos-x64 -o generate-clean-arch
+chmod +x generate-clean-arch && ./generate-clean-arch -i swagger.yaml
+
+# Linux x64
+curl -L https://git.blassanto.me/blas/openapi-clean-arch-gen/releases/latest/download/generate-clean-arch-linux-x64 -o generate-clean-arch
+chmod +x generate-clean-arch && ./generate-clean-arch -i swagger.yaml
+
+# Windows (PowerShell)
+curl -L https://git.blassanto.me/blas/openapi-clean-arch-gen/releases/latest/download/generate-clean-arch-windows-x64.exe -o generate-clean-arch.exe
+.\generate-clean-arch.exe -i swagger.yaml
+```
+
+### Option 1: Install as a global CLI from npm
+
+```bash
+bun add -g @0kmpo/openapi-clean-arch-generator
+```
+
+Then run:
+
+```bash
+generate-clean-arch -i swagger.yaml
+```
+
+### Option 2: Clone and use locally
+
+```bash
+git clone <repo>
+cd openapi-clean-arch-generator
+bun install
+bun run setup   # installs openapi-generator-cli globally
+```
+
+## 📖 Usage
+
+### Basic command
+
+```bash
+# Installed globally
+generate-clean-arch -i swagger.yaml
+
+# From the repository (compiled)
+bun run generate -- -i swagger.yaml
+
+# From the repository (development, no compilation needed)
+bun run generate:dev -- -i swagger.yaml
+```
+
+### Available options
+
+```
+Options:
+  -V, --version              Show version
+  -i, --input <file>         OpenAPI/Swagger file (yaml or json) [default: swagger.yaml]
+  -o, --output <dir>         Output directory [default: ./src/app]
+  -t, --templates <dir>      Custom templates directory [default: ./templates]
+  -s, --select-endpoints     Interactively select tags and endpoints to generate
+  --skip-install             Skip dependency installation
+  --dry-run                  Simulate without writing files
+  -h, --help                 Show help
+```
+
+### Examples
+
+```bash
+# Generate from swagger.yaml into src/app
+generate-clean-arch -i swagger.yaml -o ./src/app
+
+# Interactively select tags/endpoints
+generate-clean-arch -i api.yaml -s
+
+# Use custom templates
+generate-clean-arch -i api.yaml -t ./my-templates
+
+# Dry run (no files written)
+generate-clean-arch -i swagger.yaml --dry-run
+
+# Full example with all options
+generate-clean-arch -i ./docs/api.yaml -o ./frontend/src/app -t ./custom-templates
+```
+
+## 📁 Generated Structure
+
+The generator creates the following structure following Clean Architecture:
+
+```
+src/app/
+├── data/                          # Data layer
+│   ├── dtos/                      # Data Transfer Objects
+│   │   ├── node/
+│   │   │   ├── node.dto.ts
+│   │   │   └── node.dto.mock.ts
+│   │   ├── order-type/
+│   │   │   ├── order-type.dto.ts
+│   │   │   └── order-type.dto.mock.ts
+│   │   └── supply-mode/
+│   │       ├── supply-mode.dto.ts
+│   │       └── supply-mode.dto.mock.ts
+│   ├── repositories/              # Repository implementations
+│   │   ├── node.repository.impl.ts
+│   │   ├── node.repository.impl.mock.ts
+│   │   ├── node.repository.impl.spec.ts
+│   │   ├── order-type.repository.impl.ts
+│   │   ├── order-type.repository.impl.mock.ts
+│   │   ├── order-type.repository.impl.spec.ts
+│   │   └── ...
+│   └── mappers/                   # DTO → Entity transformers
+│       ├── node.mapper.ts
+│       ├── node.mapper.spec.ts
+│       ├── order-type.mapper.ts
+│       ├── order-type.mapper.spec.ts
+│       └── ...
+├── domain/                        # Domain layer
+│   ├── repositories/              # Repository contracts
+│   │   ├── node.repository.contract.ts
+│   │   └── ...
+│   └── use-cases/                 # Use cases
+│       ├── node/
+│       │   ├── node.use-cases.contract.ts
+│       │   ├── node.use-cases.impl.ts
+│       │   ├── node.use-cases.mock.ts
+│       │   └── node.use-cases.impl.spec.ts
+│       └── ...
+├── di/                            # Dependency injection
+│   ├── repositories/              # Repository providers
+│   │   ├── node.repository.provider.ts
+│   │   ├── node.repository.provider.mock.ts
+│   │   └── ...
+│   └── use-cases/                 # Use case providers
+│       ├── node.use-cases.provider.ts
+│       ├── node.use-cases.provider.mock.ts
+│       └── ...
+└── entities/                      # Domain entities
+    └── models/
+        ├── node.model.ts
+        ├── node.model.mock.ts
+        ├── node.model.spec.ts
+        └── ...
+```
+
+## 🔧 Template Customization
+
+Templates live in `templates/` and use [Mustache](https://mustache.github.io/) syntax. Override them by passing your own directory with `-t`.
+
+| Template | Generates |
+|---|---|
+| `model.mustache` | DTOs |
+| `model.mock.mustache` | DTO mocks |
+| `dto.mock.mustache` | DTO mocks (alternative) |
+| `model-entity.mustache` | Domain entity models |
+| `model-entity.spec.mustache` | Entity model specs |
+| `mapper.mustache` | DTO → Entity mappers |
+| `mapper.spec.mustache` | Mapper specs |
+| `api.repository.contract.mustache` | Repository contracts |
+| `api.repository.impl.mustache` | Repository implementations |
+| `api.repository.impl.mock.mustache` | Repository mocks |
+| `api.repository.impl.spec.mustache` | Repository specs |
+| `api.use-cases.contract.mustache` | Use case contracts |
+| `api.use-cases.impl.mustache` | Use case implementations |
+| `api.use-cases.mock.mustache` | Use case mocks |
+| `api.use-cases.impl.spec.mustache` | Use case specs |
+| `repository.provider.mustache` | Repository DI providers |
+| `repository.provider.mock.mustache` | Repository provider mocks |
+| `use-cases.provider.mustache` | Use case DI providers |
+| `use-cases.provider.mock.mustache` | Use case provider mocks |
+
+### Available Mustache variables
+
+```mustache
+{{classname}}          - Class name (e.g. "OrderType")
+{{classVarName}}       - camelCase name (e.g. "orderType")
+{{classFilename}}      - File name (e.g. "order-type")
+{{constantName}}       - UPPER_SNAKE_CASE constant (e.g. "ORDER_TYPE")
+{{description}}        - Schema description
+{{httpMethod}}         - HTTP method (get, post, put, delete…)
+{{path}}               - Endpoint path
+{{nickname}}           - Method name
+{{allParams}}          - All endpoint parameters
+{{returnType}}         - Return type
+{{vars}}               - Model variables
+```
+
+## 📊 Generation Report
+
+After each run a `generation-report.json` file is created:
+
+```json
+{
+  "timestamp": "2025-01-15T10:30:00.000Z",
+  "tags": 3,
+  "endpoints": 8,
+  "tagDetails": [
+    { "name": "User", "description": "User operations", "endpoints": 3 },
+    { "name": "Product", "description": "Product operations", "endpoints": 2 }
+  ],
+  "outputDirectory": "./src/app",
+  "linting": {
+    "prettier": { "ran": true, "filesFormatted": 42 },
+    "eslint": { "ran": true, "filesFixed": 42 }
+  },
+  "structure": {
+    "dtos": 15,
+    "repositories": 9,
+    "mappers": 5,
+    "useCases": 6,
+    "providers": 12,
+    "mocks": 18,
+    "specs": 14
+  }
+}
+```
+
+## 🎯 Angular Integration Example
+
+### 1. Generate code
+
+```bash
+generate-clean-arch -i ./docs/api.yaml -o ./src/app
+```
+
+### 2. Register providers
+
+In your `app.config.ts` (Angular 17+ standalone):
+
+```typescript
+import { ApplicationConfig } from '@angular/core';
+import { NodeRepositoryProvider } from './di/repositories/node.repository.provider';
+import { NodeUseCasesProvider } from './di/use-cases/node.use-cases.provider';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    NodeRepositoryProvider,
+    NodeUseCasesProvider,
+    // ... rest of generated providers
+  ]
+};
+```
+
+### 3. Use in components
+
+```typescript
+import { Component, inject } from '@angular/core';
+import { NODE_USE_CASES } from './domain/use-cases/node/node.use-cases.contract';
+
+@Component({
+  selector: 'app-nodes',
+  template: `...`
+})
+export class NodesComponent {
+  readonly #nodeUseCases = inject(NODE_USE_CASES);
+
+  loadNodes(): void {
+    this.#nodeUseCases.getNodes().subscribe((nodes) => {
+      console.log(nodes);
+    });
+  }
+}
+```
+
+## 🐛 Troubleshooting
+
+### `openapi-generator-cli` not found
+
+```bash
+bun run setup
+# or manually:
+bun add -g @openapitools/openapi-generator-cli
+```
+
+### swagger.yaml file not found
+
+Specify the correct path with `-i`:
+
+```bash
+generate-clean-arch -i ./path/to/your/api.yaml
+```
+
+### Path aliases `@/` not resolving
+
+Configure the aliases in your Angular project's `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["src/app/*"]
+    }
+  }
+}
+```
+
+### Templates not generating expected code
+
+1. Make sure your templates are in `./templates/` or pass the path with `-t`
+2. Check the Mustache syntax
+3. Use `--dry-run` to simulate without writing files
+
+## 📝 Notes
+
+- The generator produces ready-to-use `.ts` files, it does not compile them
+- Providers must be registered manually in your Angular module or config
+- Requires Angular 17+ (uses the `inject()` function)
+- Compatible with both standalone and module-based projects
+
+## 🤝 Contributing
+
+Found a bug or have an improvement? Open an issue or PR in the repository.
+
+## 📄 License
+
+MIT
+