|
1 | | -# Important announcement |
| 1 | +<p> |
| 2 | + <a href="https://piiano.com/pii-data-privacy-vault/"> |
| 3 | + <picture> |
| 4 | + <source media="(prefers-color-scheme: dark)" srcset="https://docs.piiano.com/img/logo-developers-dark.svg"> |
| 5 | + <source media="(prefers-color-scheme: light)" srcset="https://docs.piiano.com/img/logo-developers.svg"> |
| 6 | + <img alt="Piiano Vault" src="https://docs.piiano.com/img/logo-developers.svg" height="40" /> |
| 7 | + </picture> |
| 8 | + </a> |
| 9 | +</p> |
2 | 10 |
|
3 | | -> [!IMPORTANT] |
4 | | -> Please migrate your projects to use [@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) |
| 11 | +# @piiano/openapi-typescript-codegen |
5 | 12 |
|
6 | | -Due to time limitations on my end, this project has been unmaintained for a while now. The `@hey-api/openapi-ts` |
7 | | -project started as a fork with the goal to resolve the most pressing issues. going forward they are planning to |
8 | | -maintain the OpenAPI generator and give it the love it deserves. Please support them with their work and make |
9 | | -sure to migrate your projects: https://heyapi.vercel.app/openapi-ts/migrating.html |
| 13 | +This repository is a fork of the [openapi-typescript-codegen](https://github.com/ferdikoomen/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. |
10 | 14 |
|
11 | | -- All open PR's and issues will be archived on the 1st of May 2024 |
12 | | -- All versions of this package will be deprecated in NPM |
| 15 | +For the actual client for Piiano Vault, please visit [@piiano/vault-client](https://www.npmjs.com/package/@piiano/vault-client). |
13 | 16 |
|
14 | | -👋 Thanks for all the support, downloads and love! Cheers Ferdi. |
| 17 | +If you wish to generate a client from OpenAPI, check the original [openapi-typescript-codegen](https://www.npmjs.com/package/openapi-typescript-codegen) project or the newer [@hey-api/openapi-ts](https://www.npmjs.com/package/@hey-api/openapi-ts) project that is set to replace it. |
15 | 18 |
|
16 | | ---- |
| 19 | +## About Piiano Vault |
17 | 20 |
|
18 | | -# OpenAPI Typescript Codegen |
| 21 | +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. |
19 | 22 |
|
20 | | -[![NPM][npm-image]][npm-url] |
21 | | -[![License][license-image]][license-url] |
22 | | -[![Downloads][downloads-image]][downloads-url] |
23 | | -[![Build][build-image]][build-url] |
| 23 | +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. |
24 | 24 |
|
25 | | -> Node.js library that generates Typescript clients based on the OpenAPI specification. |
| 25 | +The main benefits are: |
26 | 26 |
|
27 | | -## Why? |
28 | | -- Frontend ❤️ OpenAPI, but we do not want to use JAVA codegen in our builds |
29 | | -- Quick, lightweight, robust and framework-agnostic 🚀 |
30 | | -- Supports generation of TypeScript clients |
31 | | -- Supports generations of Fetch, Node-Fetch, Axios, Angular and XHR http clients |
32 | | -- Supports OpenAPI specification v2.0 and v3.0 |
33 | | -- Supports JSON and YAML files for input |
34 | | -- Supports generation through CLI, Node.js and NPX |
35 | | -- Supports tsc and @babel/plugin-transform-typescript |
36 | | -- Supports aborting of requests (cancelable promise pattern) |
37 | | -- Supports external references using [json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser/) |
| 27 | +- Field level encryption, including key rotation. |
| 28 | +- Searchability is allowed over the encrypted data. |
| 29 | +- Full audit log for all data accesses. |
| 30 | +- Granular access controls. |
| 31 | +- Easy masking and tokenization of data. |
| 32 | +- Out of the box privacy compliance functionality. |
38 | 33 |
|
39 | | -## Install |
40 | | - |
41 | | -``` |
42 | | -npm install openapi-typescript-codegen --save-dev |
43 | | -``` |
44 | | - |
45 | | -## Usage |
46 | | - |
47 | | -``` |
48 | | -$ openapi --help |
49 | | -
|
50 | | - Usage: openapi [options] |
51 | | -
|
52 | | - Options: |
53 | | - -V, --version output the version number |
54 | | - -i, --input <value> OpenAPI specification, can be a path, url or string content (required) |
55 | | - -o, --output <value> Output directory (required) |
56 | | - -c, --client <value> HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch") |
57 | | - --name <value> Custom client class name |
58 | | - --useOptions Use options instead of arguments |
59 | | - --useUnionTypes Use union types instead of enums |
60 | | - --exportCore <value> Write core files to disk (default: true) |
61 | | - --exportServices <value> Write services to disk (default: true) |
62 | | - --exportModels <value> Write models to disk (default: true) |
63 | | - --exportSchemas <value> Write schemas to disk (default: false) |
64 | | - --indent <value> Indentation options [4, 2, tab] (default: "4") |
65 | | - --postfixServices Service name postfix (default: "Service") |
66 | | - --postfixModels Model name postfix |
67 | | - --request <value> Path to custom request file |
68 | | - -h, --help display help for command |
69 | | -
|
70 | | - Examples |
71 | | - $ openapi --input ./spec.json --output ./generated |
72 | | - $ openapi --input ./spec.json --output ./generated --client xhr |
73 | | -``` |
74 | | - |
75 | | -Documentation |
76 | | -=== |
77 | | - |
78 | | -The main documentation can be found in the [openapi-typescript-codegen/wiki](https://github.com/ferdikoomen/openapi-typescript-codegen/wiki) |
79 | | - |
80 | | -Sponsors |
81 | | -=== |
82 | | - |
83 | | -If you or your company use the OpenAPI Typescript Codegen, please consider supporting me. By sponsoring I can free up time to give this project some love! Details can be found here: https://github.com/sponsors/ferdikoomen |
84 | | - |
85 | | -If you're from an enterprise looking for a fully managed SDK generation, please consider our sponsor: |
86 | | - |
87 | | -<a href="https://speakeasyapi.dev/?utm_source=ferdi+repo&utm_medium=github+sponsorship"> |
88 | | - <img alt="speakeasy" src="https://storage.googleapis.com/speakeasy-design-assets/ferdi-sponsorship.png" width="640"/> |
89 | | -</a> |
90 | | - |
91 | | -[npm-url]: https://npmjs.org/package/openapi-typescript-codegen |
92 | | -[npm-image]: https://img.shields.io/npm/v/openapi-typescript-codegen.svg |
93 | | -[license-url]: LICENSE |
94 | | -[license-image]: http://img.shields.io/npm/l/openapi-typescript-codegen.svg |
95 | | -[coverage-url]: https://codecov.io/gh/ferdikoomen/openapi-typescript-codegen |
96 | | -[coverage-image]: https://img.shields.io/codecov/c/github/ferdikoomen/openapi-typescript-codegen.svg |
97 | | -[downloads-url]: http://npm-stat.com/charts.html?package=openapi-typescript-codegen |
98 | | -[downloads-image]: http://img.shields.io/npm/dm/openapi-typescript-codegen.svg |
99 | | -[build-url]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/main |
100 | | -[build-image]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/main.svg?style=svg |
| 34 | +More details can be found [on our website](https://piiano.com/pii-data-privacy-vault/) and on the [developers portal](https://docs.piiano.com/). |
0 commit comments