Skip to content
This repository has been archived by the owner on Nov 11, 2023. It is now read-only.

Commit

Permalink
Remove default encoding function (pathParametersEncodingMode)
Browse files Browse the repository at this point in the history
  • Loading branch information
@fabien0102
fabien0102 committed Oct 7, 2020
1 parent 084d46f commit b4fdbbd
Show file tree
Hide file tree
Showing 3 changed files with 307 additions and 87 deletions.
63 changes: 36 additions & 27 deletions src/scripts/import-open-api.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,7 @@ export const generateRestfulComponent = (
schemasComponents?: ComponentsObject,
customProps: AdvancedOptions["customProps"] = {},
skipReact = false,
pathParametersEncodingMode?: AdvancedOptions["pathParametersEncodingMode"],
customGenerator?: AdvancedOptions["customGenerator"],
) => {
if (!operation.operationId) {
Expand Down Expand Up @@ -479,19 +480,20 @@ ${description}export const ${componentName} = (${
: `
verb="${verb.toUpperCase()}"`
}
path={encode\`${route}\`}${
path=${pathParametersEncodingMode ? `{encode\`${route}\`}` : `"${route}"`}${
customPropsEntries.length
? "\n " + customPropsEntries.map(([key, value]) => `${key}=${value}`).join("\n ")
: ""
}
${verb === "delete" ? "pathInlineBodyEncode={encodingFn}" : ""}
${verb === "delete" && pathParametersEncodingMode ? "pathInlineBodyEncode={encodingFn}" : ""}
{...props}
/>
);
`;

// Hooks version
const encode = pathParametersEncodingMode ? "encode" : "";
output += `export type Use${componentName}Props = Omit<Use${Component}Props<${genericsTypesForHooksProps}>, "path"${
verb === "get" ? "" : ` | "verb"`
}>${paramsInPath.length ? ` & ${componentName}PathParams` : ""};
Expand All @@ -502,8 +504,8 @@ ${description}export const use${componentName} = (${
verb === "get" ? "" : `"${verb.toUpperCase()}", `
}${
paramsInPath.length
? `(paramsInPath: ${componentName}PathParams) => encode\`${route.replace(/\$\{/g, "${paramsInPath.")}\``
: `encode\`${route}\``
? `(paramsInPath: ${componentName}PathParams) => ${encode}\`${route.replace(/\$\{/g, "${paramsInPath.")}\``
: `${encode}\`${route}\``
}, ${
customPropsEntries.length || paramsInPath.length || verb === "delete"
? `{ ${
Expand All @@ -512,7 +514,7 @@ ${description}export const use${componentName} = (${
.map(([key, value]) => `${key}:${reactPropsValueToObjectValue(value || "")}`)
.join(", ")},`
: ""
}${verb === "delete" ? "pathInlineBodyEncode: encodingFn, " : " "}${
}${verb === "delete" && pathParametersEncodingMode ? "pathInlineBodyEncode: encodingFn, " : " "}${
paramsInPath.length ? `pathParams: { ${paramsInPath.join(", ")} },` : ""
} ...props }`
: "props"
Expand Down Expand Up @@ -823,6 +825,7 @@ const importOpenApi = async ({
specs.components,
customProps,
skipReact,
pathParametersEncodingMode,
customGenerator,
);
}
Expand All @@ -843,34 +846,40 @@ const importOpenApi = async ({
if (havePoll) {
imports.push("Poll", "PollProps");
}
const restfulReactImports = skipReact
? ""
: `import React from "react";
import { ${imports.join(", ")} } from "restful-react";`;

output =
`/* Generated by restful-react */
let outputHeaders = "/* Generated by restful-react */\n\n";

${restfulReactImports}${customImport ? `\n${customImport}\n` : ""}
if (!skipReact) {
outputHeaders += `import React from "react";
import { ${imports.join(", ")} } from "restful-react";
`;
}

const encodingFn = ${getEncodingFunction(pathParametersEncodingMode || "uriComponent")}
if (customImport) {
outputHeaders += `\n${customImport}\n`;
}

const encodingTagFactory = (encodingFn: typeof encodeURIComponent) => (
strings: TemplateStringsArray,
...params: (string | number | boolean)[]
) =>
strings.reduce(
(accumulatedPath, pathPart, idx) =>
\`\${accumulatedPath}\${pathPart}\${
idx < params.length ? encodingFn(params[idx]) : ''
}\`,
'',
);
if (pathParametersEncodingMode) {
outputHeaders += `${getEncodingFunction(pathParametersEncodingMode)}
const encode = encodingTagFactory(encodingFn);
const encodingTagFactory = (encodingFn: typeof encodeURIComponent) => (
strings: TemplateStringsArray,
...params: (string | number | boolean)[]
) =>
strings.reduce(
(accumulatedPath, pathPart, idx) =>
\`\${accumulatedPath}\${pathPart}\${
idx < params.length ? encodingFn(params[idx]) : ''
}\`,
'',
);
const encode = encodingTagFactory(encodingFn);
`;
}

` + output;
return output;
return outputHeaders + output;
};

export default importOpenApi;
239 changes: 222 additions & 17 deletions src/scripts/tests/__snapshots__/import-open-api.test.ts.snap
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,32 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`scripts/import-open-api should parse correctly petstore-expanded.yaml 1`] = `
exports[`scripts/import-open-api should parse correctly petstore-expanded.yaml (with encode function) 1`] = `
"/* Generated by restful-react */
import React from \\"react\\";
import { Get, GetProps, useGet, UseGetProps, Mutate, MutateProps, useMutate, UseMutateProps } from \\"restful-react\\";
const encodingFn = encodeURIComponent
const encodingTagFactory = (encodingFn: typeof encodeURIComponent) => (
strings: TemplateStringsArray,
...params: (string | number | boolean)[]
) =>
strings.reduce(
(accumulatedPath, pathPart, idx) =>
\`\${accumulatedPath}\${pathPart}\${
idx < params.length ? encodingFn(params[idx]) : ''
}\`,
'',
(uriComponent: string | number | boolean) => {
return encodeURIComponent(uriComponent).replace(
/[!'()*]/g,
(c: string) => \`%\${c.charCodeAt(0).toString(16)}\`,
);
};
const encode = encodingTagFactory(encodingFn);
/**
const encodingTagFactory = (encodingFn: typeof encodeURIComponent) => (
strings: TemplateStringsArray,
...params: (string | number | boolean)[]
) =>
strings.reduce(
(accumulatedPath, pathPart, idx) =>
\`\${accumulatedPath}\${pathPart}\${
idx < params.length ? encodingFn(params[idx]) : ''
}\`,
'',
);
const encode = encodingTagFactory(encodingFn);
/**
* A pet.
*/
export type Pet = NewPet & {
Expand Down Expand Up @@ -217,3 +221,204 @@ export const useUpdatePet = ({id, ...props}: UseUpdatePetProps) => useMutate<Pet
"
`;
exports[`scripts/import-open-api should parse correctly petstore-expanded.yaml 1`] = `
"/* Generated by restful-react */
import React from \\"react\\";
import { Get, GetProps, useGet, UseGetProps, Mutate, MutateProps, useMutate, UseMutateProps } from \\"restful-react\\";
/**
* A pet.
*/
export type Pet = NewPet & {
id: number;
};
/**
* A new pet.
*/
export interface NewPet {
name: string;
tag?: string;
}
/**
* A discriminator example.
*/
export type CatOrDog = Cat | Dog;
/**
* A cat, meow.
*/
export interface Cat {
type: \\"cat\\";
breed: \\"labrador\\" | \\"carlin\\" | \\"beagle\\";
}
/**
* A dog, wooof.
*/
export interface Dog {
type: \\"dog\\";
breed: \\"saimois\\" | \\"bengal\\" | \\"british shorthair\\";
}
/**
* An error :(
*/
export interface Error {
code: number;
message: string;
}
/**
* Request description
*/
export interface Request {
action?: (\\"create\\" | \\"read\\" | \\"update\\" | \\"delete\\")[];
}
export type UpdatePetRequestRequestBody = NewPet;
export interface FindPetsQueryParams {
/**
* tags to filter by
*/
tags?: string[];
/**
* maximum number of results to return
*/
limit?: number;
}
export type FindPetsProps = Omit<GetProps<Pet[], Error, FindPetsQueryParams, void>, \\"path\\">;
/**
* Returns all pets from the system that the user has access to
* Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
*
* Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
*
*/
export const FindPets = (props: FindPetsProps) => (
<Get<Pet[], Error, FindPetsQueryParams, void>
path=\\"/pets\\"
{...props}
/>
);
export type UseFindPetsProps = Omit<UseGetProps<Pet[], Error, FindPetsQueryParams, void>, \\"path\\">;
/**
* Returns all pets from the system that the user has access to
* Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
*
* Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
*
*/
export const useFindPets = (props: UseFindPetsProps) => useGet<Pet[], Error, FindPetsQueryParams, void>(\`/pets\`, props);
export type AddPetProps = Omit<MutateProps<Pet, Error, void, NewPet, void>, \\"path\\" | \\"verb\\">;
/**
* Creates a new pet in the store. Duplicates are allowed
*/
export const AddPet = (props: AddPetProps) => (
<Mutate<Pet, Error, void, NewPet, void>
verb=\\"POST\\"
path=\\"/pets\\"
{...props}
/>
);
export type UseAddPetProps = Omit<UseMutateProps<Pet, Error, void, NewPet, void>, \\"path\\" | \\"verb\\">;
/**
* Creates a new pet in the store. Duplicates are allowed
*/
export const useAddPet = (props: UseAddPetProps) => useMutate<Pet, Error, void, NewPet, void>(\\"POST\\", \`/pets\`, props);
export interface FindPetByIdPathParams {
/**
* ID of pet to fetch
*/
id: number
}
export type FindPetByIdProps = Omit<GetProps<Pet, Error, void, FindPetByIdPathParams>, \\"path\\"> & FindPetByIdPathParams;
/**
* Returns a user based on a single ID, if the user does not have access to the pet
*/
export const FindPetById = ({id, ...props}: FindPetByIdProps) => (
<Get<Pet, Error, void, FindPetByIdPathParams>
path=\\"/pets/\${id}\\"
{...props}
/>
);
export type UseFindPetByIdProps = Omit<UseGetProps<Pet, Error, void, FindPetByIdPathParams>, \\"path\\"> & FindPetByIdPathParams;
/**
* Returns a user based on a single ID, if the user does not have access to the pet
*/
export const useFindPetById = ({id, ...props}: UseFindPetByIdProps) => useGet<Pet, Error, void, FindPetByIdPathParams>((paramsInPath: FindPetByIdPathParams) => \`/pets/\${paramsInPath.id}\`, { pathParams: { id }, ...props });
export type DeletePetProps = Omit<MutateProps<void, Error, void, number, void>, \\"path\\" | \\"verb\\">;
/**
* deletes a single pet based on the ID supplied
*/
export const DeletePet = (props: DeletePetProps) => (
<Mutate<void, Error, void, number, void>
verb=\\"DELETE\\"
path=\\"/pets\\"
{...props}
/>
);
export type UseDeletePetProps = Omit<UseMutateProps<void, Error, void, number, void>, \\"path\\" | \\"verb\\">;
/**
* deletes a single pet based on the ID supplied
*/
export const useDeletePet = (props: UseDeletePetProps) => useMutate<void, Error, void, number, void>(\\"DELETE\\", \`/pets\`, { ...props });
export interface UpdatePetPathParams {
/**
* ID of pet to update
*/
id: number
}
export type UpdatePetProps = Omit<MutateProps<Pet, Error, void, UpdatePetRequestRequestBody, UpdatePetPathParams>, \\"path\\" | \\"verb\\"> & UpdatePetPathParams;
/**
* Updates a pet in the store.
*/
export const UpdatePet = ({id, ...props}: UpdatePetProps) => (
<Mutate<Pet, Error, void, UpdatePetRequestRequestBody, UpdatePetPathParams>
verb=\\"PATCH\\"
path=\\"/pets/\${id}\\"
{...props}
/>
);
export type UseUpdatePetProps = Omit<UseMutateProps<Pet, Error, void, UpdatePetRequestRequestBody, UpdatePetPathParams>, \\"path\\" | \\"verb\\"> & UpdatePetPathParams;
/**
* Updates a pet in the store.
*/
export const useUpdatePet = ({id, ...props}: UseUpdatePetProps) => useMutate<Pet, Error, void, UpdatePetRequestRequestBody, UpdatePetPathParams>(\\"PATCH\\", (paramsInPath: UpdatePetPathParams) => \`/pets/\${paramsInPath.id}\`, { pathParams: { id }, ...props });
"
`;
Loading

0 comments on commit b4fdbbd

Please sign in to comment.