feat: add readonly flag (#82)

Author: Himenon

CONTRIBUTING.md

@@ -1 +1,21 @@
 # Contributing
+
+## Build
+
+```bash
+pnpm run build
+```
+
+## Test
+
+Snapshot Update
+
+```bash
+pnpm run update:snapshot
+```
+
+## Shortcut
+
+```bash
+pnpm run build && pnpm run test:code:gen && pnpm run update:snapshot
+```

src/code-templates/_shared/ApiClientArgument.ts

@@ -57,6 +57,7 @@ const createHeaders = (factory: TsGenerator.Factory.Type, { convertedParams }: C
   if (convertedParams.has2OrMoreRequestContentTypes) {
     members.push(
       factory.PropertySignature.create({
+        readOnly: false,
         name: `"Content-Type"`,
         optional: false,
         type: factory.TypeReferenceNode.create({ name: "T" }),
@@ -67,6 +68,7 @@ const createHeaders = (factory: TsGenerator.Factory.Type, { convertedParams }: C
   if (convertedParams.has2OrMoreSuccessResponseContentTypes) {
     members.push(
       factory.PropertySignature.create({
+        readOnly: false,
         name: `Accept`,
         optional: false,
         type: factory.TypeReferenceNode.create({ name: "U" }),
@@ -117,6 +119,7 @@ export const create = (factory: TsGenerator.Factory.Type, params: CodeGenerator.
   const headerDeclaration = createHeaders(factory, params);
   if (headerDeclaration) {
     const extraHeader = factory.PropertySignature.create({
+      readOnly: false,
       name: "headers",
       optional: false,
       type: headerDeclaration,
@@ -126,6 +129,7 @@ export const create = (factory: TsGenerator.Factory.Type, params: CodeGenerator.
 
   if (convertedParams.hasParameter) {
     const parameter = factory.PropertySignature.create({
+      readOnly: false,
       name: "parameter",
       optional: false,
       type: factory.TypeReferenceNode.create({
@@ -137,6 +141,7 @@ export const create = (factory: TsGenerator.Factory.Type, params: CodeGenerator.
 
   if (convertedParams.hasRequestBody) {
     const requestBody = factory.PropertySignature.create({
+      readOnly: false,
       name: "requestBody",
       optional: false,
       type: factory.IndexedAccessTypeNode.create({

src/code-templates/_shared/ApiClientInterface.ts

@@ -63,16 +63,19 @@ const createQueryParamsDeclarations = (factory: TsGenerator.Factory.Type) => {
     name: "QueryParameter",
     members: [
       factory.PropertySignature.create({
+        readOnly: false,
         name: "value",
         optional: false,
         type: factory.TypeNode.create({ type: "any" }),
       }),
       factory.PropertySignature.create({
+        readOnly: false,
         name: "style",
         optional: true,
         type: factory.TypeNode.create({ type: "string", enum: ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }),
       }),
       factory.PropertySignature.create({
+        readOnly: false,
         name: "explode",
         optional: false,
         type: factory.TypeNode.create({ type: "boolean" }),
@@ -113,32 +116,37 @@ const createEncodingInterface = (factory: TsGenerator.Factory.Type) => {
     members: [
       factory.PropertySignature.create({
         name: "contentType",
+        readOnly: true,
         optional: true,
         type: factory.TypeReferenceNode.create({
           name: "string",
         }),
       }),
       factory.PropertySignature.create({
         name: "headers",
+        readOnly: false,
         optional: true,
         type: factory.TypeReferenceNode.create({
           name: "Record<string, any>",
         }),
       }),
       factory.PropertySignature.create({
         name: "style",
+        readOnly: true,
         optional: true,
         type: factory.TypeNode.create({ type: "string", enum: ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }),
       }),
       factory.PropertySignature.create({
         name: "explode",
+        readOnly: true,
         optional: true,
         type: factory.TypeReferenceNode.create({
           name: "boolean",
         }),
       }),
       factory.PropertySignature.create({
         name: "allowReserved",
+        readOnly: true,
         optional: true,
         type: factory.TypeReferenceNode.create({
           name: "boolean",
@@ -219,6 +227,7 @@ export const create = (
   });
 
   const requestFunction = factory.PropertySignature.create({
+    readOnly: false,
     name: "request",
     optional: false,
     type: functionType,
@@ -230,32 +239,38 @@ export const create = (
     members: [
       factory.PropertySignature.create({
         name: `httpMethod`,
+        readOnly: true,
         optional: false,
         type: factory.TypeReferenceNode.create({ name: "HttpMethod" }),
       }),
       factory.PropertySignature.create({
         name: methodType === "currying-function" ? "uri" : "url",
+        readOnly: true,
         optional: false,
         type: factory.TypeReferenceNode.create({ name: "string" }),
       }),
       factory.PropertySignature.create({
         name: `headers`,
+        readOnly: false,
         optional: false,
         type: objectLikeOrAnyType,
       }),
       factory.PropertySignature.create({
         name: `requestBody`,
+        readOnly: false,
         optional: true,
         type: objectLikeOrAnyType,
       }),
       factory.PropertySignature.create({
         name: `requestBodyEncoding`,
+        readOnly: false,
         optional: true,
         type: factory.TypeReferenceNode.create({ name: "Record<string, Encoding>" }),
       }),
       factory.PropertySignature.create({
         name: `queryParameters`,
         optional: true,
+        readOnly: false,
         type: factory.UnionTypeNode.create({
           typeNodes: [
             factory.TypeReferenceNode.create({

src/internal/OpenApiTools/components/Header.ts

@@ -37,6 +37,7 @@ export const generatePropertySignature = (
     if (reference.type === "local") {
       context.setReferenceHandler(currentPoint, reference);
       return factory.PropertySignature.create({
+        readOnly: false,
         name: converterContext.escapePropertySignatureName(name),
         optional: false,
         type: factory.TypeReferenceNode.create({
@@ -45,6 +46,7 @@ export const generatePropertySignature = (
       });
     }
     return factory.PropertySignature.create({
+      readOnly: false,
       name: converterContext.escapePropertySignatureName(name),
       optional: false,
       type: factory.TypeReferenceNode.create({
@@ -53,6 +55,7 @@ export const generatePropertySignature = (
     });
   }
   return factory.PropertySignature.create({
+    readOnly: false,
     name: converterContext.escapePropertySignatureName(name),
     optional: false,
     type: ToTypeNode.convert(entryPoint, currentPoint, factory, header.schema || { type: "null" }, context, converterContext),

src/internal/OpenApiTools/components/MediaType.ts

@@ -15,6 +15,7 @@ export const generatePropertySignature = (
   converterContext: ConverterContext.Types,
 ): ts.PropertySignature => {
   return factory.PropertySignature.create({
+    readOnly: false,
     name: converterContext.escapePropertySignatureName(protocol),
     optional: false,
     type: ToTypeNode.convert(entryPoint, currentPoint, factory, schema, context, converterContext),

src/internal/OpenApiTools/components/Parameter.ts

@@ -53,6 +53,7 @@ export const generatePropertySignatureObject = (
       const isPathProperty = localRef.in === "path";
       const name = converterContext.escapePropertySignatureName(localRef.name);
       const typeElement = factory.PropertySignature.create({
+        readOnly: false,
         name: name,
         optional: isPathProperty ? false : !localRef.required,
         comment: localRef.description,
@@ -68,6 +69,7 @@ export const generatePropertySignatureObject = (
     const isPathProperty = reference.data.in === "path";
     const name = converterContext.escapePropertySignatureName(reference.data.name);
     const typeElement = factory.PropertySignature.create({
+      readOnly: false,
       name: name,
       optional: isPathProperty ? false : !reference.data.required,
       comment: reference.data.description,
@@ -88,6 +90,7 @@ export const generatePropertySignatureObject = (
   const isPathProperty = parameter.in === "path";
   const name = converterContext.escapePropertySignatureName(parameter.name);
   const typeElement = factory.PropertySignature.create({
+    readOnly: false,
     name: name,
     optional: isPathProperty ? false : !parameter.required,
     type: ToTypeNode.convert(entryPoint, currentPoint, factory, parameter.schema || { type: "null" }, context, converterContext),

src/internal/OpenApiTools/components/Schema.ts

@@ -39,6 +39,7 @@ export const generatePropertySignatures = (
   return Object.entries(schema.properties).map(([propertyName, property]) => {
     if (!property) {
       return factory.PropertySignature.create({
+        readOnly: false,
         name: convertContext.escapePropertySignatureName(propertyName),
         optional: !required.includes(propertyName),
         comment: [schema.title, schema.description].filter(v => !!v).join("\n\n"),
@@ -48,6 +49,7 @@ export const generatePropertySignatures = (
       });
     }
     return factory.PropertySignature.create({
+      readOnly: typeof property !== "boolean" ? !!property.readOnly : false,
       name: convertContext.escapePropertySignatureName(propertyName),
       optional: !required.includes(propertyName),
       type: ToTypeNode.convert(entryPoint, currentPoint, factory, property, context, convertContext, { parent: schema }),

src/internal/OpenApiTools/components/SecuritySchema.ts

@@ -11,21 +11,25 @@ export const generatePropertySignatures = (
 ): ts.PropertySignature[] => {
   const signatures: ts.PropertySignature[] = [
     factory.PropertySignature.create({
+      readOnly: false,
       name: "type",
       optional: false,
       type: factory.LiteralTypeNode.create({ value: securitySchema.type }),
     }),
     factory.PropertySignature.create({
+      readOnly: false,
       name: "name",
       optional: false,
       type: factory.LiteralTypeNode.create({ value: securitySchema.name }),
     }),
     factory.PropertySignature.create({
+      readOnly: false,
       name: "in",
       optional: false,
       type: factory.LiteralTypeNode.create({ value: securitySchema.in }),
     }),
     factory.PropertySignature.create({
+      readOnly: false,
       name: "openIdConnectUrl",
       optional: false,
       type: factory.LiteralTypeNode.create({ value: securitySchema.openIdConnectUrl }),

src/internal/OpenApiTools/toTypeNode.ts

@@ -272,6 +272,7 @@ export const convert: Convert = (
 
       const value: ts.PropertySignature[] = Object.entries(schema.properties || {}).map(([name, jsonSchema]) => {
         return factory.PropertySignature.create({
+          readOnly: typeof jsonSchema !== "boolean" ? !!jsonSchema.readOnly : false,
           name: converterContext.escapePropertySignatureName(name),
           type: convert(entryPoint, currentPoint, factory, jsonSchema, context, converterContext, { parent: schema.properties }),
           optional: !required.includes(name),

src/internal/TsGenerator/factory/PropertySignature.ts

@@ -4,6 +4,7 @@ import { generateComment } from "./utils";
 
 export interface Params {
   name: string;
+  readOnly: boolean;
   optional: boolean;
   type: ts.TypeNode;
   comment?: string;
@@ -16,8 +17,9 @@ export interface Factory {
 export const create =
   ({ factory }: Pick<ts.TransformationContext, "factory">): Factory["create"] =>
   (params: Params): ts.PropertySignature => {
+    
     const node = factory.createPropertySignature(
-      undefined,
+      params.readOnly ? [factory.createModifier(ts.SyntaxKind.ReadonlyKeyword)] : undefined,
       params.name,
       params.optional ? factory.createToken(ts.SyntaxKind.QuestionToken) : undefined,
       params.type,