Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@piiano/openapi-typescript-codegen

ferdikoomen13MIT0.29.1TypeScript support: included

Library that generates Typescript clients based on the OpenAPI specification.

openapi, swagger, generator, typescript, yaml, json, fetch, xhr, axios, angular, node

readme

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://docs.piiano.com/img/logo-developers-dark.svg"> <source media="(prefers-color-scheme: light)" srcset="https://docs.piiano.com/img/logo-developers.svg"> Piiano Vault </picture>

@piiano/openapi-typescript-codegen

This repository is a fork of the openapi-typescript-codegen project. It is specifically tailored to generate a TypeScript client for the Piiano Vault API and is not intended for other uses.

For the actual client for Piiano Vault, please visit @piiano/vault-client.

If you wish to generate a client from OpenAPI, check the original openapi-typescript-codegen project or the newer @hey-api/openapi-ts project that is set to replace it.

About Piiano Vault

Piiano Vault is the secure home for sensitive personal data. It allows you to safely store sensitive personal data in your own cloud environment with automated compliance controls.

Vault is deployed within your own architecture, next to other DBs used by the applications, and should be used to store the most critical sensitive personal data, such as credit cards and bank account numbers, names, emails, national IDs (e.g. SSN), phone numbers, etc.

The main benefits are:

  • Field level encryption, including key rotation.
  • Searchability is allowed over the encrypted data.
  • Full audit log for all data accesses.
  • Granular access controls.
  • Easy masking and tokenization of data.
  • Out of the box privacy compliance functionality.

More details can be found on our website and on the developers portal.

changelog

Changelog

All notable changes to this project will be documented in this file.

[0.29.0] - 2024-04-05

Please migrate your projects to use @hey-api/openapi-ts

The @hey-api/openapi-ts project started as a fork with the goal to resolve the most pressing issues. going forward they are planning to maintain the OpenAPI generator and give it the love it deserves. Please support them with their work and make sure to migrate your projects: https://heyapi.vercel.app/openapi-ts/migrating.html

Fixed

  • Upgraded dependencies

[0.28.0] - 2024-03-19

Fixed

  • Upgraded dependencies
  • Windows issue when resolving external spec files
  • Media-type for falsy bodies except 'undefined'
  • Updated typo in generated header

    Added

  • Enabled withXSRFToken for Axios

[0.27.0] - 2024-01-15

Fixed

  • Reverted @apidevtools/json-schema-ref-parser to version 10.1.0

[0.26.0] - 2024-01-07

Fixed

  • Upgraded dependencies

[0.25.0] - 2023-07-05

Fixed

  • Upgraded dependencies

    Added

  • Allow usage of a custom axios instance
  • Added message in generated files

[0.24.0] - 2023-04-10

Fixed

  • Upgraded dependencies
  • Fixed issue with Cancelable promise
  • Fixed issue with escaping reserved keywords in schema names

    Added

  • Added --postfixModels option

[0.23.0] - 2022-06-02

Fixed

  • Upgraded dependencies
  • Added blank line at the end of generated files
  • Added support for Node.js v12

    Added

  • Added request property inside ApiError
  • Added support for @depricated inside models and operations

[0.22.0] - 2022-04-26

Fixed

  • Upgraded dependencies
  • Fixed issue with null value inside comments for OpenAPI v2 enums
  • Fixed issue with compatibility for latest version of Axios (0.27.x)

    Removed

  • Removed deprecated enum model generation

[0.21.0] - 2022-04-06

Fixed

  • Return undefined to match noImplicitReturns rule
  • Made BaseHttpRequest class abstract
  • Removed private fields using # inside CancelablePromise
  • Removed unneeded import AbortController from node-fetch client
  • Filter out wrong enum values

[0.20.1] - 2022-02-25

Fixed

  • Support enums with single quotes in names for V2

[0.20.0] - 2022-02-25

Fixed

  • Updated dependencies
  • Support enums with single quotes in names for V3
  • Generating better names when operationId is not given (breaking change)
  • Fixed issue where x-enum flags where breaking due to non-string values

[0.19.0] - 2022-02-02

Added

  • Support for Angular client with --name option
  • Added test cases for Angular client

[0.18.2] - 2022-02-02

Fixed

  • Updated dependencies
  • Fixed type definition

    Added

  • Added test cases for CLI commands
  • Added test cases for query parsing

[0.18.1] - 2022-01-31

Fixed

  • Escaping error description
  • Made Client.request and BaseHttpRequest.config props public

_## [0.18.0] - 2022-01-28

Added

  • Angular client generation!
  • Updated documentation with more examples and better descriptions

[0.17.0] - 2022-01-26

Fixed

  • Shorthand notation for properties passed through constructor
  • Simplified creation of headers
  • Prepare codebase for Angular client

[0.16.2] - 2022-01-26

Fixed

  • Removed dependency on URLSearchParams to support browser and node without any additional imports

[0.16.1] - 2022-01-26

Fixed

  • Correct export inside index.ts when giving a custom name

[0.16.0] - 2022-01-25

Added

  • Added option to set the indentation (spaces and tabs)
  • Added option to export separate client file that allows usage for multiple backends

    Fixed

  • Decoupled OpenAPI object from requests
  • Updated dependencies

[0.15.0] - 2022-01-24

Added

  • Added change log and releases on GitHub

[0.14.0] - 2022-01-24

Fixed

  • Added missing postfix options to typedef
  • Updated escaping of comments and descriptions
  • Better handling of services without tags
  • Updated dependencies