@hey-api/openapi-ts 0.34.5 → 0.36.0

package/README.md

@@ -1,10 +1,8 @@
-# OpenAPI TypeScript 👋
-
-✨ Turn your OpenAPI specification into a beautiful TypeScript client
-
-## About
-
-`openapi-ts` started as a fork of [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen). We created it after the original project became [unmaintained](https://github.com/ferdikoomen/openapi-typescript-codegen/issues/1276#issuecomment-1302392146) to add support for OpenAPI v3.1. We plan to resolve the most pressing issues in the original project – open an issue if you'd like to prioritise your use case!
+<div align="center">
+    <img width="150" height="150" src="https://heyapi.vercel.app/logo.png" alt="Logo">
+    <h1 align="center"><b>OpenAPI Typescript</b></h1>
+    <p align="center">✨ Turn your OpenAPI specification into a beautiful TypeScript client.</p>
+</div>
 
 ## Features
 
@@ -15,10 +13,14 @@
 - Can be used with CLI, Node.js, or npx
 - Abortable requests through cancellable promise pattern
 
-## Getting Started
+## Migrating from OpenAPI Typescript Codegen?
+
+Please read our [migration guide](https://heyapi.vercel.app/openapi-ts/migrating.html#openapi-typescript-codegen).
+
+## Documentation
 
-Please follow the documentation [here](https://heyapi.vercel.app/).
+Please visit our [website](https://heyapi.vercel.app/) for documentation, guides, migrating, and more.
 
 ## Contributing
 
-Please refer to the [contributing guide](./CONTRIBUTING.md) for how to install the project for development purposes.
+Want to get involved? Please refer to the [contributing guide](https://heyapi.vercel.app/contributing.html).

package/bin/index.js

@@ -20,15 +20,14 @@ const params = program
     .option('--enums <value>', 'Export enum definitions (javascript, typescript)')
     .option('--exportCore [value]', 'Write core files to disk')
     .option('--exportModels [value]', 'Write models to disk')
-    .option('--exportSchemas [value]', 'Write schemas to disk')
     .option('--exportServices [value]', 'Write services to disk')
     .option('--format [value]', 'Process output folder with formatter?')
     .option('--lint [value]', 'Process output folder with linter?')
     .option('--name <value>', 'Custom client class name')
     .option('--operationId [value]', 'Use operationd ID?')
-    .option('--postfixModels <value>', 'Model name postfix')
     .option('--postfixServices <value>', 'Service name postfix')
     .option('--request <value>', 'Path to custom request file')
+    .option('--schemas [value]', 'Write schemas to disk')
     .option('--serviceResponse [value]', 'Define shape of returned value from service calls')
     .option('--useDateType [value]', 'Output Date instead of string for the format "date-time" in the models')
     .option('--useOptions [value]', 'Use options instead of arguments')
@@ -65,11 +64,11 @@ async function start() {
             ...processParams(params, [
                 'exportCore',
                 'exportModels',
-                'exportSchemas',
                 'exportServices',
                 'format',
                 'lint',
                 'operationId',
+                'schemas',
                 'useDateType',
                 'useOptions',
                 'write',

package/dist/node/index.d.ts

@@ -33,11 +33,6 @@ interface UserConfig {
      * @default true
      */
     exportModels?: boolean | string;
-    /**
-     * Generate schemas?
-     * @default true
-     */
-    exportSchemas?: boolean;
     /**
      * Generate services?
      * @default true
@@ -70,11 +65,6 @@ interface UserConfig {
      * The relative location of the output directory
      */
     output: string;
-    /**
-     * Model name postfix
-     * @default '''
-     */
-    postfixModels?: string;
     /**
      * Service name postfix
      * @default 'Service'
@@ -84,6 +74,11 @@ interface UserConfig {
      * Path to custom request file
      */
     request?: string;
+    /**
+     * Export JSON schemas?
+     * @default true
+     */
+    schemas?: boolean;
     /**
      * Define shape of returned value from service calls
      * @default 'body'