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

package/templates/api.repository.impl.spec.mustache

@@ -0,0 +1,97 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
+import { TestBed } from '@angular/core/testing';
+
+import { {{classname}}RepositoryImpl } from './{{classFilename}}.repository.impl';
+{{#returnImports}}
+import { mock{{classname}}Dto } from '@/dtos/{{classFilename}}.dto.mock';
+import { mock{{classname}}Model } from '@/entities/models/{{classFilename}}.model.mock';
+{{/returnImports}}
+
+describe('{{classname}}RepositoryImpl', () => {
+  let repository: {{classname}}RepositoryImpl;
+  let httpMock: HttpTestingController;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      imports: [HttpClientTestingModule],
+      providers: [{{classname}}RepositoryImpl]
+    });
+
+    repository = TestBed.inject({{classname}}RepositoryImpl);
+    httpMock = TestBed.inject(HttpTestingController);
+  });
+
+  afterEach(() => {
+    httpMock.verify();
+  });
+
+  it('should be created', () => {
+    expect(repository).toBeTruthy();
+  });
+
+{{#operation}}
+  describe('{{nickname}}', () => {
+    it('should perform a {{uppercaseHttpMethod}} request', () => {
+      repository.{{nickname}}({{#allParams}}{{{testValue}}}{{^-last}}, {{/-last}}{{/allParams}}).subscribe();
+
+      const req = httpMock.expectOne((r) => r.method === '{{uppercaseHttpMethod}}');
+      expect(req.request.method).toBe('{{uppercaseHttpMethod}}');
+      {{#isListContainer}}
+      req.flush({ items: [mock{{returnBaseType}}Dto()] });
+      {{/isListContainer}}
+      {{^isListContainer}}
+      {{#returnType}}
+      req.flush(mock{{returnBaseType}}Dto());
+      {{/returnType}}
+      {{^returnType}}
+      req.flush(null);
+      {{/returnType}}
+      {{/isListContainer}}
+    });
+
+    {{#returnType}}
+    it('should map the response to the domain model', () => {
+      const dto = mock{{returnBaseType}}Dto();
+      const expectedModel = mock{{returnBaseType}}Model();
+
+      {{#isListContainer}}
+      repository.{{nickname}}({{#allParams}}{{{testValue}}}{{^-last}}, {{/-last}}{{/allParams}}).subscribe((result) => {
+        expect(result).toBeTruthy();
+        expect(result.length).toBeGreaterThan(0);
+      });
+
+      httpMock.expectOne((r) => r.method === '{{uppercaseHttpMethod}}').flush({ items: [dto] });
+      {{/isListContainer}}
+      {{^isListContainer}}
+      repository.{{nickname}}({{#allParams}}{{{testValue}}}{{^-last}}, {{/-last}}{{/allParams}}).subscribe((result) => {
+        expect(result).toEqual(expectedModel);
+      });
+
+      httpMock.expectOne((r) => r.method === '{{uppercaseHttpMethod}}').flush(dto);
+      {{/isListContainer}}
+    });
+
+    {{/returnType}}
+    it('should propagate HTTP errors', (done) => {
+      repository.{{nickname}}({{#allParams}}{{{testValue}}}{{^-last}}, {{/-last}}{{/allParams}}).subscribe({
+        error: (err) => {
+          expect(err.status).toBe(500);
+          done();
+        }
+      });
+
+      httpMock
+        .expectOne((r) => r.method === '{{uppercaseHttpMethod}}')
+        .flush('Internal Server Error', { status: 500, statusText: 'Internal Server Error' });
+    });
+  });
+
+{{/operation}}
+});
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/templates/api.use-cases.contract.mustache

@@ -0,0 +1,34 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { InjectionToken } from '@angular/core';
+import { Observable } from 'rxjs';
+{{#imports}}
+import { {{classname}} } from '@/entities/models/{{classFilename}}.model';
+{{/imports}}
+
+/**
+ * {{classname}} Use Cases Contract
+ * Generated from OpenAPI tag: {{classname}}
+ */
+export interface {{classname}}UseCases {
+{{#operation}}
+  /**
+   * {{summary}}
+   {{#notes}}
+   * {{notes}}
+   {{/notes}}
+   {{#allParams}}
+   * @param {{paramName}} {{description}}
+   {{/allParams}}
+   */
+  {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}{{^-last}}, {{/-last}}{{/allParams}}): Observable<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}>;
+
+{{/operation}}
+}
+
+export const {{constantName}}_USE_CASES = new InjectionToken<{{classname}}UseCases>('{{constantName}}_USE_CASES');
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/templates/api.use-cases.impl.mustache

@@ -0,0 +1,32 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { inject, Injectable } from '@angular/core';
+import { Observable } from 'rxjs';
+
+import { {{classname}}UseCases } from './{{classFilename}}.use-cases.contract';
+
+import { {{constantName}}_REPOSITORY, {{classname}}Repository } from '@/domain/repositories/{{classFilename}}.repository.contract';
+{{#imports}}
+import { {{classname}} } from '@/entities/models/{{classFilename}}.model';
+{{/imports}}
+
+/**
+ * {{classname}} Use Cases Implementation
+ * Generated from OpenAPI tag: {{classname}}
+ */
+@Injectable()
+export class {{classname}}UseCasesImpl implements {{classname}}UseCases {
+  #{{classVarName}}Repository: {{classname}}Repository = inject({{constantName}}_REPOSITORY);
+
+{{#operation}}
+  {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}{{^-last}}, {{/-last}}{{/allParams}}): Observable<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}> {
+    return this.#{{classVarName}}Repository.{{nickname}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}});
+  }
+
+{{/operation}}
+}
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/templates/api.use-cases.impl.spec.mustache

@@ -0,0 +1,94 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { TestBed } from '@angular/core/testing';
+import { of } from 'rxjs';
+
+import { {{classname}}UseCasesImpl } from './{{classFilename}}.use-cases.impl';
+
+import { {{constantName}}_REPOSITORY, {{classname}}Repository } from '@/domain/repositories/{{classFilename}}.repository.contract';
+{{#returnImports}}
+import { mock{{classname}}Model } from '@/entities/models/{{classFilename}}.model.mock';
+{{/returnImports}}
+
+describe('{{classname}}UseCasesImpl', () => {
+  let useCase: {{classname}}UseCasesImpl;
+  let mockRepository: jasmine.SpyObj<{{classname}}Repository>;
+
+  beforeEach(() => {
+    mockRepository = jasmine.createSpyObj('{{classname}}Repository', [{{#operation}}'{{nickname}}', {{/operation}}]);
+
+    TestBed.configureTestingModule({
+      providers: [
+        {{classname}}UseCasesImpl,
+        { provide: {{constantName}}_REPOSITORY, useValue: mockRepository }
+      ]
+    });
+
+    useCase = TestBed.inject({{classname}}UseCasesImpl);
+  });
+
+  it('should be created', () => {
+    expect(useCase).toBeTruthy();
+  });
+
+{{#operation}}
+  describe('{{nickname}}', () => {
+    it('should delegate to the repository', () => {
+      {{#isListContainer}}
+      mockRepository.{{nickname}}.and.returnValue(of([mock{{returnBaseType}}Model()]));
+      {{/isListContainer}}
+      {{^isListContainer}}
+      {{#returnBaseType}}
+      mockRepository.{{nickname}}.and.returnValue(of(mock{{returnBaseType}}Model()));
+      {{/returnBaseType}}
+      {{^returnBaseType}}
+      mockRepository.{{nickname}}.and.returnValue(of(undefined));
+      {{/returnBaseType}}
+      {{/isListContainer}}
+
+      useCase.{{nickname}}({{#allParams}}{{{testValue}}}{{^-last}}, {{/-last}}{{/allParams}});
+
+      expect(mockRepository.{{nickname}}).toHaveBeenCalled();
+    });
+
+    it('should return the observable from the repository', (done) => {
+      {{#isListContainer}}
+      const expected = [mock{{returnBaseType}}Model()];
+      mockRepository.{{nickname}}.and.returnValue(of(expected));
+
+      useCase.{{nickname}}({{#allParams}}{{{testValue}}}{{^-last}}, {{/-last}}{{/allParams}}).subscribe((result) => {
+        expect(result).toEqual(expected);
+        done();
+      });
+      {{/isListContainer}}
+      {{^isListContainer}}
+      {{#returnBaseType}}
+      const expected = mock{{returnBaseType}}Model();
+      mockRepository.{{nickname}}.and.returnValue(of(expected));
+
+      useCase.{{nickname}}({{#allParams}}{{{testValue}}}{{^-last}}, {{/-last}}{{/allParams}}).subscribe((result) => {
+        expect(result).toEqual(expected);
+        done();
+      });
+      {{/returnBaseType}}
+      {{^returnBaseType}}
+      mockRepository.{{nickname}}.and.returnValue(of(undefined));
+
+      useCase.{{nickname}}({{#allParams}}{{{testValue}}}{{^-last}}, {{/-last}}{{/allParams}}).subscribe({
+        complete: () => {
+          expect(mockRepository.{{nickname}}).toHaveBeenCalledOnceWith({{#allParams}}{{{testValue}}}{{^-last}}, {{/-last}}{{/allParams}});
+          done();
+        }
+      });
+      {{/returnBaseType}}
+      {{/isListContainer}}
+    });
+  });
+
+{{/operation}}
+});
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/templates/api.use-cases.mock.mustache

@@ -0,0 +1,21 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { MockService } from 'ng-mocks';
+import { of } from 'rxjs';
+
+import { {{classname}}UseCasesImpl } from '@/domain/use-cases/{{classFilename}}.use-cases.impl';
+{{#returnImports}}
+import { mock{{classname}}Model } from '@/entities/models/{{classFilename}}.model.mock';
+{{/returnImports}}
+
+export const mock{{classname}}UseCasesImpl = () =>
+  MockService({{classname}}UseCasesImpl, {
+{{#operation}}
+    {{nickname}}: () => of({{#isListContainer}}[mock{{returnBaseType}}Model()]{{/isListContainer}}{{^isListContainer}}{{#returnBaseType}}mock{{returnBaseType}}Model(){{/returnBaseType}}{{^returnBaseType}}undefined{{/returnBaseType}}{{/isListContainer}}),
+{{/operation}}
+  });
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/templates/dto.mock.mustache

@@ -0,0 +1,16 @@
+{{#models}}
+{{#model}}
+{{#mockImports}}
+import { mock{{classname}}Dto } from './{{classFilename}}.dto.mock';
+{{/mockImports}}
+import { {{classname}}Dto } from './{{classFilename}}.dto';
+
+export const mock{{classname}}Dto = (overrides: Partial<{{classname}}Dto> = {}): {{classname}}Dto => ({
+{{#vars}}
+  {{name}}: {{{mockValue}}},
+{{/vars}}
+  ...overrides
+});
+
+{{/model}}
+{{/models}}

package/templates/mapper.mustache

@@ -0,0 +1,28 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { MapFromFn } from '@mercadona/common/public';
+import { Builder } from '@mercadona/common/utils';
+
+import { {{classname}}Dto } from '@/dtos/{{classFilename}}.dto';
+import { {{classname}} } from '@/entities/models/{{classFilename}}.model';
+
+/**
+ * {{classname}} Mapper
+ * Converts DTO to Domain Entity
+ * Generated from OpenAPI schema: {{classname}}
+ */
+export const {{classVarName}}Mapper: MapFromFn<{{classname}}Dto, {{classname}}> = (dto: {{classname}}Dto): {{classname}} =>
+  Builder.forModel({{classname}})
+{{#allModels}}
+{{#model}}
+{{#vars}}
+    .{{name}}(dto.{{name}})
+{{/vars}}
+{{/model}}
+{{/allModels}}
+    .build();
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/templates/mapper.spec.mustache

@@ -0,0 +1,39 @@
+{{#models}}
+{{#model}}
+import { {{classVarName}}Mapper } from './{{classFilename}}.mapper';
+
+import { mock{{classname}}Dto } from '@/dtos/{{classFilename}}.dto.mock';
+import { {{classname}} } from '@/entities/models/{{classFilename}}.model';
+
+describe('{{classVarName}}Mapper', () => {
+{{#vars}}
+  it('should map {{name}} from DTO to model', () => {
+    const dto = mock{{classname}}Dto();
+
+    const result = {{classVarName}}Mapper(dto);
+
+    expect(result.{{name}}).toBe(dto.{{name}});
+  });
+
+{{/vars}}
+  it('should return an instance of {{classname}}', () => {
+    const dto = mock{{classname}}Dto();
+
+    const result = {{classVarName}}Mapper(dto);
+
+    expect(result).toBeInstanceOf({{classname}});
+  });
+
+  it('should map all fields correctly from a complete DTO', () => {
+    const dto = mock{{classname}}Dto();
+
+    const result = {{classVarName}}Mapper(dto);
+
+{{#vars}}
+    expect(result.{{name}}).toBe(dto.{{name}});
+{{/vars}}
+  });
+});
+
+{{/model}}
+{{/models}}

package/templates/model-entity.mustache

@@ -0,0 +1,24 @@
+{{#models}}
+{{#model}}
+{{#imports}}
+import { {{classname}} } from './{{classFilename}}.model';
+{{/imports}}
+
+/**
+ * {{classname}} Entity
+ * {{#description}}{{description}}{{/description}}
+ * Generated from OpenAPI schema
+ */
+export class {{classname}} {
+{{#vars}}
+{{#description}}
+  /**
+   * {{description}}
+   */
+{{/description}}
+  {{name}}{{^required}}?{{/required}}{{#required}}!{{/required}}: {{{dataType}}};
+{{/vars}}
+}
+
+{{/model}}
+{{/models}}

package/templates/model-entity.spec.mustache

@@ -0,0 +1,34 @@
+{{#models}}
+{{#model}}
+import { {{classname}} } from './{{classFilename}}.model';
+import { mock{{classname}}Model } from './{{classFilename}}.model.mock';
+
+describe('{{classname}}', () => {
+  it('should create an instance', () => {
+    const model = new {{classname}}();
+
+    expect(model).toBeInstanceOf({{classname}});
+  });
+
+{{#vars}}
+  it('should allow setting {{name}}', () => {
+    const model = new {{classname}}();
+    const expected = mock{{classname}}Model();
+    model.{{name}} = expected.{{name}};
+
+    expect(model.{{name}}).toBe(expected.{{name}});
+  });
+
+{{/vars}}
+  it('should build a valid model from mock', () => {
+    const model = mock{{classname}}Model();
+
+    expect(model).toBeInstanceOf({{classname}});
+{{#vars}}
+    expect(model.{{name}}).toBeDefined();
+{{/vars}}
+  });
+});
+
+{{/model}}
+{{/models}}

package/templates/model.mock.mustache

@@ -0,0 +1,14 @@
+{{#models}}
+{{#model}}
+import { {{classname}} } from './{{classFilename}}.model';
+import { {{classVarName}}Mapper } from '@/mappers/{{classFilename}}.mapper';
+import { mock{{classname}}Dto } from '@/dtos/{{classFilename}}.dto.mock';
+
+export const mock{{classname}}Model = (overrides: Partial<{{classname}}> = {}): {{classname}} =>
+  Object.assign(new {{classname}}(), {
+    ...{{classVarName}}Mapper(mock{{classname}}Dto()),
+    ...overrides
+  });
+
+{{/model}}
+{{/models}}

package/templates/model.mustache

@@ -0,0 +1,20 @@
+{{#models}}
+{{#model}}
+/**
+ * {{classname}} DTO
+ * {{#description}}{{description}}{{/description}}
+ * Generated from OpenAPI specification
+ */
+export interface {{classname}} {
+{{#vars}}
+{{#description}}
+  /**
+   * {{description}}
+   */
+{{/description}}
+  {{name}}{{^required}}?{{/required}}: {{{dataType}}};
+{{/vars}}
+}
+
+{{/model}}
+{{/models}}

package/templates/repository.provider.mock.mustache

@@ -0,0 +1,20 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { Provider } from '@angular/core';
+
+import { {{constantName}}_REPOSITORY } from '@/domain/repositories/{{classFilename}}.repository.contract';
+import { mock{{classname}}RepositoryImpl } from '@/data/repositories/{{classFilename}}.repository.impl.mock';
+
+export function mock{{classname}}Repository(): Provider[] {
+  return [
+    {
+      provide: {{constantName}}_REPOSITORY,
+      useFactory: () => mock{{classname}}RepositoryImpl()
+    }
+  ];
+}
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/templates/repository.provider.mustache

@@ -0,0 +1,26 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { EnvironmentProviders, makeEnvironmentProviders } from '@angular/core';
+
+import { {{constantName}}_REPOSITORY } from '@/domain/repositories/{{classFilename}}.repository.contract';
+import { {{classname}}RepositoryImpl } from '@/data/repositories/{{classFilename}}.repository.impl';
+
+/**
+ * {{classname}} Repository Provider
+ * Binds the repository contract with its implementation
+ *
+ * @returns EnvironmentProviders
+ */
+export function provide{{classname}}Repository(): EnvironmentProviders {
+  return makeEnvironmentProviders([
+    {
+      provide: {{constantName}}_REPOSITORY,
+      useClass: {{classname}}RepositoryImpl
+    }
+  ]);
+}
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/templates/use-cases.provider.mock.mustache

@@ -0,0 +1,20 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { Provider } from '@angular/core';
+
+import { {{constantName}}_USE_CASES } from '@/domain/use-cases/{{classFilename}}.use-cases.contract';
+import { mock{{classname}}UseCasesImpl } from '@/domain/use-cases/{{classFilename}}.use-cases.mock';
+
+export function mock{{classname}}UseCases(): Provider[] {
+  return [
+    {
+      provide: {{constantName}}_USE_CASES,
+      useFactory: () => mock{{classname}}UseCasesImpl()
+    }
+  ];
+}
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/templates/use-cases.provider.mustache

@@ -0,0 +1,26 @@
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { EnvironmentProviders, makeEnvironmentProviders } from '@angular/core';
+
+import { {{constantName}}_USE_CASES } from '@/domain/use-cases/{{classFilename}}.use-cases.contract';
+import { {{classname}}UseCasesImpl } from '@/domain/use-cases/{{classFilename}}.use-cases.impl';
+
+/**
+ * {{classname}} Use Cases Provider
+ * Binds the use cases contract with its implementation
+ *
+ * @returns EnvironmentProviders
+ */
+export function provide{{classname}}UseCases(): EnvironmentProviders {
+  return makeEnvironmentProviders([
+    {
+      provide: {{constantName}}_USE_CASES,
+      useClass: {{classname}}UseCasesImpl
+    }
+  ]);
+}
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "CommonJS",
+    "lib": ["ES2022"],
+    "outDir": "./dist",
+    "rootDir": "./",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true
+  },
+  "include": ["main.ts", "src/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}