Initial commit

Author: abduvaliiev

README.md

@@ -1,6 +1,16 @@
+This is a fork of the original OpenAPI Typescript Codegen library. It is only meant as a temprorary npm package to use until these feature requests are merged into the original repo:
+- https://github.com/ferdikoomen/openapi-typescript-codegen/pull/1465
+- https://github.com/ferdikoomen/openapi-typescript-codegen/pull/1145
+
+To install this fork: `npm install @oskarasplin/openapi-typescript-codegen`
+
+At the time of writing the `feature/omit-read-only` branch is published as the latest npm version
+
+Original ReadMe below
+
 # Important announcement
 
-> [!IMPORTANT] 
+> [!IMPORTANT]
 > Please migrate your projects to use [@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts)
 
 Due to time limitations on my end, this project has been unmaintained for a while now. The `@hey-api/openapi-ts`
@@ -65,6 +75,7 @@ $ openapi --help
     --postfixServices         Service name postfix (default: "Service")
     --postfixModels           Model name postfix
     --request <value>         Path to custom request file
+    --transformCase <value>   Transforms field names to specified case [camel, snake] (default: none)
     -h, --help                display help for command
 
   Examples

bin/index.js

@@ -23,6 +23,7 @@ const params = program
     .option('--indent <value>', 'Indentation options [4, 2, tabs]', '4')
     .option('--postfixServices <value>', 'Service name postfix', 'Service')
     .option('--postfixModels <value>', 'Model name postfix')
+    .option('--transformCase <value>', 'Transforms field names to specified case [camel, snake]', 'none')
     .option('--request <value>', 'Path to custom request file')
     .parse(process.argv)
     .opts();
@@ -44,6 +45,7 @@ if (OpenAPI) {
         indent: params.indent,
         postfixServices: params.postfixServices,
         postfixModels: params.postfixModels,
+        transformCase: params.transformCase,
         request: params.request,
     })
         .then(() => {

package-lock.json

@@ -1,6 +1,6 @@
 {
-    "name": "openapi-typescript-codegen",
-    "version": "0.29.0",
+    "name": "@cloudfactory/openapi-typescript-codegen",
+    "version": "1.0.0",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",

package.json

@@ -0,0 +1,55 @@
+import { Enum } from './client/interfaces/Enum';
+import { Model } from './client/interfaces/Model';
+import { OperationResponse } from './client/interfaces/OperationResponse';
+import { Service } from './client/interfaces/Service';
+
+export enum Case {
+    NONE = 'none',
+    CAMEL = 'camel',
+    SNAKE = 'snake',
+}
+// Convert a string from snake case to camel case.
+const toCamelCase = (str: string): string => {
+    return str.replace(/_([a-z0-9])/g, match => match[1].toUpperCase());
+};
+
+// Convert a string from camel case or pascal case to snake case.
+const toSnakeCase = (str: string): string => {
+    return str.replace(/([A-Z])/g, match => `_${match.toLowerCase()}`);
+};
+
+const transforms = {
+    [Case.CAMEL]: toCamelCase,
+    [Case.SNAKE]: toSnakeCase,
+};
+
+// A recursive function that looks at the models and their properties and
+// converts each property name using the provided transform function.
+export const convertModelCase = <T extends Model | OperationResponse>(model: T, type: Exclude<Case, Case.NONE>): T => {
+    return {
+        ...model,
+        name: transforms[type](model.name),
+        link: model.link ? convertModelCase(model.link, type) : null,
+        enum: model.enum.map(modelEnum => convertEnumCase(modelEnum, type)),
+        enums: model.enums.map(property => convertModelCase(property, type)),
+        properties: model.properties.map(property => convertModelCase(property, type)),
+    };
+};
+
+const convertEnumCase = (modelEnum: Enum, type: Exclude<Case, Case.NONE>): Enum => {
+    return {
+        ...modelEnum,
+        name: transforms[type](modelEnum.name),
+    };
+};
+
+export const convertServiceCase = (service: Service, type: Exclude<Case, Case.NONE>): Service => {
+    return {
+        ...service,
+        operations: service.operations.map(op => ({
+            ...op,
+            parameters: op.parameters.map(opParameter => convertModelCase(opParameter, type)),
+            results: op.results.map(results => convertModelCase(results, type)),
+        })),
+    };
+};

src/Case.ts

@@ -1,3 +1,4 @@
+import { Case } from './Case';
 import { HttpClient } from './HttpClient';
 import { Indent } from './Indent';
 import { parse as parseV2 } from './openApi/v2';
@@ -26,6 +27,7 @@ export type Options = {
     indent?: Indent;
     postfixServices?: string;
     postfixModels?: string;
+    transformCase?: Case;
     request?: string;
     write?: boolean;
 };
@@ -47,6 +49,7 @@ export type Options = {
  * @param indent Indentation options (4, 2 or tab)
  * @param postfixServices Service name postfix
  * @param postfixModels Model name postfix
+ * @param transformCase Transform case (camel, snake)
  * @param request Path to custom request file
  * @param write Write the files to disk (true or false)
  */
@@ -64,6 +67,7 @@ export const generate = async ({
     indent = Indent.SPACE_4,
     postfixServices = 'Service',
     postfixModels = '',
+    transformCase = Case.NONE,
     request,
     write = true,
 }: Options): Promise<void> => {
@@ -94,6 +98,7 @@ export const generate = async ({
                 indent,
                 postfixServices,
                 postfixModels,
+                transformCase,
                 clientName,
                 request
             );
@@ -118,6 +123,7 @@ export const generate = async ({
                 indent,
                 postfixServices,
                 postfixModels,
+                transformCase,
                 clientName,
                 request
             );

src/index.ts

@@ -0,0 +1,41 @@
+/**
+ * The contents of this file are inspired from https://stackoverflow.com/a/62362197/10326226
+ * and https://stackoverflow.com/a/75587790/14166396
+ * */
+
+type IfEquals<X, Y, A = X, B = never> = (<T>() => T extends X ? 1 : 2) extends <
+  T,
+>() => T extends Y ? 1 : 2
+  ? A
+  : B;
+
+type WritableKeys<T> = {
+  [P in keyof T]-?: IfEquals<{ [Q in P]: T[P] }, { -readonly [Q in P]: T[P] }, P>;
+}[keyof T];
+
+type Primitive = undefined | null | boolean | string | number | Function;
+
+type OmitReadonlyArray<T> = Array<OmitReadonly<T>>;
+type OmitReadonlyMap<K, V> = Map<K, OmitReadonly<V>>;
+type DeepWriableSet<T> = Set<OmitReadonly<T>>;
+
+type OmitReadonlyObject<T> = MakeUndefinedFieldsOptional<{
+  [K in WritableKeys<T>]: OmitReadonly<T[K]>;
+}>;
+
+type UndefinedProps<T extends object> = {
+  [K in keyof T as undefined extends T[K] ? K : never]?: T[K];
+};
+
+type MakeUndefinedFieldsOptional<T extends object> = UndefinedProps<T> &
+  Omit<T, keyof UndefinedProps<T>>;
+
+export declare type OmitReadonly<T> = T extends Primitive
+  ? T
+  : T extends Array<infer U>
+  ? OmitReadonlyArray<U>
+  : T extends Map<infer K, infer V>
+  ? OmitReadonlyMap<K, V>
+  : T extends Set<infer T>
+  ? DeepWriableSet<T>
+  : OmitReadonlyObject<T>;

src/templates/core/utils/OmitReadonly.hbs

@@ -30,6 +30,7 @@ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 {{/if}}
+import type { OmitReadonly } from '../core/utils/OmitReadonly';
 
 {{#equals @root.httpClient 'angular'}}
 @Injectable({

src/templates/exportService.hbs

@@ -16,13 +16,13 @@
 {{/if}}
  */
 {{/ifdef}}
-{{{name}}}{{>isRequired}}: {{>type}},
+{{{name}}}{{>isRequired}}: {{>typeWithOmitReadOnly httpMethod=../method}},
 {{/each}}
 }
 {{~else}}
 
 {{#each parameters}}
-{{{name}}}{{>isRequired}}: {{>type}}{{#if default}} = {{{default}}}{{/if}},
+{{{name}}}{{>isRequired}}: {{>typeWithOmitReadOnly httpMethod=../method}}{{#if default}} = {{{default}}}{{/if}},
 {{/each}}
 {{/if}}
 {{/if}}

src/templates/partials/parameters.hbs

@@ -0,0 +1,13 @@
+{{#equals export "reference"}}
+{{#equals httpMethod "POST"~}}
+	OmitReadonly<{{>type}}>
+{{~else equals  httpMethod "PUT"~}}
+	OmitReadonly<{{>type}}>
+{{~else equals  httpMethod "PATCH"~}}
+	OmitReadonly<{{>type}}>
+{{else}}
+	{{~>type}}
+{{~/equals}}
+{{~else}}
+	{{~>type}}
+{{~/equals}}