Skip to content

add relaxed type detection support for function return types #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
m-Bilal merged 4 commits into from
Dec 20, 2024
Merged

add relaxed type detection support for function return types #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ba8667e
minor refactor
m-Bilal Dec 12, 2024
bfa7117
relaxed type support for return types and indexed types
m-Bilal Dec 17, 2024
5330ec7
tests updated
m-Bilal Dec 17, 2024
7841a48
return true if no match found in schema types
m-Bilal Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/app/generator/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import * as logger from "../../util/logger";
import * as schemaParser from "../parser/open-api/schema-parser";
import * as routeTypes from "../parser/open-api/route-types";
import * as paramGenerator from "./param-generator";
import * as paramTypes from "../parser/open-api/param-types";

const cj = require("circular-json");

export async function generateCode(
args: types.GenerateCodeInput,
Expand All @@ -27,10 +30,15 @@ export async function generateCode(
const routeComponentsArray: functionsTsGenerator.RouteComponents[] = [];

for (let route of apiTsCode.routes) {
// get the return type schema
const returnTypeSchema = routeTypes.getResponseSchema(route);
// check if the return type schema requires relaxed type tag
paramTypes.isRelaxedTypeTagRequiredForSchema(returnTypeSchema, parsedSchemaStore);

const routeComponents: functionsTsGenerator.RouteComponents = {
route: route,
params: routeTypes.getAllParamsRendered(route, parsedSchemaStore),
returnType: routeTypes.getResponseSchema(route),
returnType: returnTypeSchema,
};

routeComponentsArray.push(routeComponents);
Expand Down
4 changes: 2 additions & 2 deletions src/app/generator/param-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ export function renderObjectTypeSchema(
}
const paramType = `{ ${renderedProperties.join(" ")} }`;
schema._$requiresRelaxedTypeTag =
types.isRelaxedTypeTagRequiredForObjectTypeSchema(schema);
types.isRelaxedTypeTagRequiredForObjectTypeSchemaShallow(schema);
return renderSchema(paramType, schema);
}

Expand All @@ -139,7 +139,7 @@ export function renderArrayTypeSchema(
const renderedProperty = renderParams(childSchema, schemaStore)._$rendered!;
const paramType = `(${renderedProperty})[]`;
schema._$requiresRelaxedTypeTag =
types.isRelaxedTypeTagRequiredForArrayTypeSchema(schema);
types.isRelaxedTypeTagRequiredForArrayTypeSchemaShallow(schema);
return renderSchema(paramType, schema);
}

Expand Down
80 changes: 18 additions & 62 deletions src/app/generator/test-data/param-generator/golden-files/1password.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,8 @@
"requiresRelaxedTypeAnnotation": true
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
"rendered": "APIRequest",
"requiresRelaxedTypeAnnotation": true
}
}
},
Expand All @@ -37,19 +33,23 @@
"path": {},
"response": {
".__no_name": {
"rendered": "{\n dependencies?: (ServiceDependency)[],\n name: string,\n /** The Connect server's version */\n version: string,\n\n}",
"rendered": "{ dependencies?: (ServiceDependency)[], name?: string, \n/** The Connect server's version */\n version?: string, }",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
".__no_name.dependencies": {
"rendered": " dependencies?: (ServiceDependency)[],",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name.__no_name": {
"rendered": "__undefined",
".__no_name.dependencies.__no_name": {
"rendered": "ServiceDependency",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name.__no_name.__no_name": {
"rendered": "__undefined",
".__no_name.name": {
"rendered": " name?: string,",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.version": {
"rendered": "\n/** The Connect server's version */\n version?: string,",
"requiresRelaxedTypeAnnotation": false
}
}
Expand All @@ -62,10 +62,6 @@
".__no_name": {
"rendered": "string",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand All @@ -77,10 +73,6 @@
".__no_name": {
"rendered": "string",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand All @@ -103,12 +95,8 @@
"requiresRelaxedTypeAnnotation": true
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
"rendered": "Vault",
"requiresRelaxedTypeAnnotation": true
}
}
},
Expand All @@ -125,10 +113,6 @@
".__no_name": {
"rendered": "Vault",
"requiresRelaxedTypeAnnotation": true
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -156,12 +140,8 @@
"requiresRelaxedTypeAnnotation": true
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
"rendered": "Item",
"requiresRelaxedTypeAnnotation": true
}
}
},
Expand All @@ -187,10 +167,6 @@
".__no_name": {
"rendered": "FullItem",
"requiresRelaxedTypeAnnotation": true
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -235,10 +211,6 @@
".__no_name": {
"rendered": "FullItem",
"requiresRelaxedTypeAnnotation": true
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -268,10 +240,6 @@
".__no_name": {
"rendered": "FullItem",
"requiresRelaxedTypeAnnotation": true
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -301,10 +269,6 @@
".__no_name": {
"rendered": "FullItem",
"requiresRelaxedTypeAnnotation": true
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -336,11 +300,7 @@
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name.__no_name": {
"rendered": "__undefined",
"rendered": "File",
"requiresRelaxedTypeAnnotation": false
}
}
Expand Down Expand Up @@ -375,10 +335,6 @@
".__no_name": {
"rendered": "File",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down
28 changes: 0 additions & 28 deletions src/app/generator/test-data/param-generator/golden-files/adobe.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -759,10 +759,6 @@
".__no_name": {
"rendered": "InstallStatus",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -928,10 +924,6 @@
".__no_name": {
"rendered": "string",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -1520,10 +1512,6 @@
".__no_name": {
"rendered": "TruststoreInfo",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -1605,10 +1593,6 @@
".__no_name": {
"rendered": "BundleInfo",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -1776,10 +1760,6 @@
".__no_name": {
"rendered": "SamlConfigurationInfo",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down Expand Up @@ -1921,10 +1901,6 @@
".__no_name": {
"rendered": "KeystoreInfo",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand All @@ -1945,10 +1921,6 @@
".__no_name": {
"rendered": "KeystoreInfo",
"requiresRelaxedTypeAnnotation": false
},
".__no_name.__no_name": {
"rendered": "__undefined",
"requiresRelaxedTypeAnnotation": false
}
}
},
Expand Down
Loading