CHANGELOG.md

next release

3.1.1

Fixes:

• name.includes is not a function (issue #98)

3.1.0

Features:

• --moduleNameIndex option. determines which path index should be used for routes separation (Thanks @nikalun)
  Examples:
  GET:api/v1/fruites/getFruit -> index:2 -> moduleName -> fruites GET:api/v1/fruites/getFruit -> index:0 -> moduleName -> api

3.0.1

Fixes:

• invalid default templates path (#92, thanks @larrybotha for quick fix)

3.0.0

BREAKING_CHANGES:

• Renamed mustache templates:
  • api.mustache -> data-contracts.mustache
  • client.mustache -> http.client.mustache + api.mustache
• Split the client.mustache template into two parts: http-client.mustache and api.mustache

Fixes:

• Fixed unsafe clone() of Response causing json() hang. (Thanks @Benjamin-Dobell)

2.0.0

Features:

• --js CLI option. [feature request]

BREAKING_CHANGES:

• Requests returns Promise<HttpResponse<Data, Error>> type.
  HttpResponse it is Fetch.Response wrapper with fields data and error Example:

    const api = new Api()
    
    //
    const response: HttpResponse<Data, Error> = await api.fruits.getAll()
  
    response.data // Data (can be null if response.ok is false)
    response.error // Error (can be null if response.ok is true)

• Breaking changes in the client.mustache template. Needs to update local custom templates.

Fixes:

• Security configuration in methods. When the security definition is in the main configuration of the swagger definition

1.12.0

Features:

• Can provide ability to generate from swagger JSON directly not from a file? #69 (Thanks @JennieJi)

Fixes:

• handling x-omitempty property for definition properties #68
• Additional properties map to empty interfaces (OpenAPI v3) #76
• Pattern fields in Path Item Object are treated as operations #75
• Remove const enum from default template #73
• enums with spaces throw an error #71

1.11.0

Features:

• Improve the naming of model types (#65 issue)

1.10.0

Features:

• --templates CLI option. [feature request]
  Provide custom mustache templates folder which allows to generate custom code (models, Api class, routes)
• --union-enums CLI option. [feature request]
  Allows to generate all enums as union types.
  For example, schema part:

  "StringEnum": {
    "enum": ["String1", "String2", "String3", "String4"],
    "type": "string"
  }
  

  will be converted into: export type StringEnum = "String1" | "String2" | "String3" | "String4";

1.8.4

Fixes:

• Multiple types for a property in Swagger 2 are not handled correctly (#55 issue)

1.8.3

Fixes:

• Generating invalid code in composed schema contexts (#51 issue)

  components:
  schemas:
    Test:
      type: object
      allOf:
        - type: object
          properties:
            x:
              type: array
              items:
                type: string
                enum:
                  - A-B
        - type: object
          properties:
            y:
              type: string

  export type Test = XAB & { y?: string };

1.8.2

Fixes:

• Broken types for arrays of union types (issue)

1.8.1

Fixes:

• form data request body (request body content multipart/form-data)

Minor:

• inline comments of the data contract type properties
  
• remove Array<T> type usage (now the more simple type T[])

1.8.0

Features:

• Partially support FormData body types
• Support to generate query params of nested query objects (Partial fix of this issue)

1.7.2

Fixes:

• Critical bug with converting inline object into name of type for request body.
• Fix bug when path parameters is not set but contains in endpoint url.
  
  

1.7.0

Breaking Changes:

• Remove title and version public Api class properties (moved it to Api class JSDOC)(fixes this issue)
  
• Move out all http client handlers/properties into HttpClient local class in module
  
  

Chore:

• default value for SecurityDataType Api class generic type

1.6.3

Fixes:

• Handling of nullable for $ref in OpenAPI 3.0 (issue)
  Plus based on this issue was fixed most other problems with using required and nullable properties

1.6.2

Fixes:

• Nullable not included in type definition (issue)

Internal:

• Update swagger2openapi(6.0.0) dependency

1.6.1

Internal:

• Update prettier(2.0.2), swagger2openapi(5.4.0) dependencies

1.6.0

Features:

• Improvenment in optional request params (request body, query params, path params)

Fixes:

• Fix bug when path request param have the same name as query
• Fix bug when path request param have the same name as params

Minor/Internal:

• changed addQueryParams() method
• up swagger2openapi dependency version to 5.3.4

1.5.0

Features:

• Add prettier for beautify output typescript api module
• Support additionalProperties type data
  

Fixes:

• Fix problem with array type definitions without type property(#26)

1.4.1

Fixes:

• Fix TS problem with addQueryParams Api class method (issue #22, thanks genaby)

1.4.0

Breaking Changes:

• Rename default typescript output api file name (prev api.ts, now Api.ts)
  Features:
• -d, --default-as-success option. Allows to use "default" status codes as success response type
• -r, --responses option. Response declarations in request rescription
  This option adds comments of the possible responses from request
  
  Also typings for .catch() callback
  
• Improve response body type definitions
• Types for bad responses
  Changes:
• [minor] fix jsdoc comments space
  

1.3.0

Features:

• Api module description from schema info
  
• Generate API type declarations (CLI flag --route-types, thanks azz)
  
• Ability to not generate clint API class (CLI flag --no-client, thanks azz)

Fixes:

• Improve response body type definition

Internal:

• refactored generate and validate test scripts

1.2.6

Fixes: create api without -o option (use default ./ output)

1.2.5

Features: better naming of routes without operationId

Changes: rename @security true -> @secure, @duplicate true -> @duplicate
Fixes: Support generated swagger schemes from tsoa 3.x with complex types (Omit, Pick, etc)

1.2.4

Features: add .d.ts file into npm package
Changes: update help block in CLI
Internal: add greenkeeper, update npm keywords

1.2.3

Features: @summary, @description comments at each route
Fixes: parsing schema without routes
Changes: update documentation
Internal: add anyOf, allOf test schemas, slack notifications in CI

1.2.2

Fixes: fix complex types (oneOf, anyOf), required fields of object type was not required

1.2.0

Changes: rename ApiParams to RequestParams, secure module always exist in generated API module, update documentation
Fixes: Query params was all required, parse yaml files, typescript minor warnings (;)
Internal: test schemas + manual testing, add travis CI/CD

1.1.0

Fixes: catching http errors with use API module

1.0.9

Features: add description to interfaces and their fields
Changes: update documentation

1.0.8

Changes: update documentation

1.0.7

Changes: update documentation (+ add logo), add comment about author in generated module

1.0.6

Fixes: route naming, http(s) requests for getting swagger schema, integer enums
Changes: include only required files into npm pacakge

1.0.5

Changes: update documentation

1.0.4

Changes: disable linters rules for generated API module
Fixes: TS issues in template

1.0.3

Fixes: NodeJS main script cannot been called on Unix* machines
Changes: add LICENSE, update README

1.0.2

Changes(Internal): change dependencies

1.0.1

New features: query params, separating routes on submodules, common params in constructor, swagger v2 + yaml parsers
Enhancements: better type extracting.
Fixes: mustache escaping chars
Changes: order of request params, emojis messages in console

1.0.0

Initial project.