@orval/swr 6.11.0-alpha.1

package/README.md

@@ -0,0 +1,28 @@
+[![npm version](https://badge.fury.io/js/orval.svg)](https://badge.fury.io/js/orval)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![tests](https://github.com/anymaniax/orval/actions/workflows/tests.yaml/badge.svg)](https://github.com/anymaniax/orval/actions/workflows/tests.yaml)
+
+<p align="center">
+  <img src="./logo/orval-logo-horizontal.svg?raw=true" width="500" height="160" alt="orval - Restfull Client Generator" />
+</p>
+<h1 align="center">
+  Visit <a href="https://orval.dev" target="_blank">orval.dev</a> for docs, guides, API and beer!
+</h1>
+
+### Code Generation
+
+`orval` is able to generate client with appropriate type-signatures (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in `yaml` or `json` formats.
+
+`Generate`, `valid`, `cache` and `mock` in your React, Vue, Svelte and Angular applications all with your OpenAPI specification.
+
+### Samples
+
+You can find below some samples
+
+- [react app](https://github.com/anymaniax/orval/tree/master/samples/react-app)
+- [react query](https://github.com/anymaniax/orval/tree/master/samples/react-query)
+- [svelte query](https://github.com/anymaniax/orval/tree/master/samples/svelte-query)
+- [vue query](https://github.com/anymaniax/orval/tree/master/samples/vue-query)
+- [react app with swr](https://github.com/anymaniax/orval/tree/master/samples/react-app-with-swr)
+- [nx fastify react](https://github.com/anymaniax/orval/tree/master/samples/nx-fastify-react)
+- [angular app](https://github.com/anymaniax/orval/tree/master/samples/angular-app)

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { ClientDependenciesBuilder, ClientTitleBuilder, ClientHeaderBuilder, ClientFooterBuilder, ClientBuilder, ClientGeneratorsBuilder } from '@orval/core';
+
+declare const getSwrDependencies: ClientDependenciesBuilder;
+declare const generateSwrTitle: ClientTitleBuilder;
+declare const generateSwrHeader: ClientHeaderBuilder;
+declare const generateSwrFooter: ClientFooterBuilder;
+declare const generateSwr: ClientBuilder;
+declare const builder: () => ClientGeneratorsBuilder;
+
+export { builder, builder as default, generateSwr, generateSwrFooter, generateSwrHeader, generateSwrTitle, getSwrDependencies };

package/dist/index.js

@@ -0,0 +1,57 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _core = require('@orval/core');var V=[{exports:[{name:"axios",default:!0,values:!0,syntheticDefaultImport:!0},{name:"AxiosRequestConfig"},{name:"AxiosResponse"},{name:"AxiosError"}],dependency:"axios"}],M=[{exports:[{name:"useSwr",values:!0,default:!0},{name:"SWRConfiguration"},{name:"Key"}],dependency:"swr"}],N= exports.getSwrDependencies =e=>[...e?[]:V,...M],j=({headers:e,queryParams:s,operationName:i,response:o,mutator:r,body:n,props:a,verb:l,formData:w,formUrlEncoded:g,override:t},{route:$,context:y})=>{var O,S;let c=(t==null?void 0:t.requestOptions)!==!1,u=(t==null?void 0:t.formData)!==!1,p=(t==null?void 0:t.formUrlEncoded)!==!1,f=!!((S=(O=y.tsconfig)==null?void 0:O.compilerOptions)!=null&&S.exactOptionalPropertyTypes),A=_core.VERBS_WITH_BODY.includes(l),C=_core.isSyntheticDefaultImportsAllow.call(void 0, y.tsconfig),x=_core.generateFormDataAndUrlEncodedFunction.call(void 0, {formData:w,formUrlEncoded:g,body:n,isFormData:u,isFormUrlEncoded:p});if(r){let P=_core.generateMutatorConfig.call(void 0, {route:$,body:n,headers:e,queryParams:s,response:o,verb:l,isFormData:u,isFormUrlEncoded:p,hasSignal:!1,isBodyVerb:A,isExactOptionalPropertyTypes:f}),R=(r==null?void 0:r.bodyTypeName)&&n.definition?_core.toObjectString.call(void 0, a,"implementation").replace(new RegExp(`(\\w*):\\s?${n.definition}`),`$1: ${r.bodyTypeName}<${n.definition}>`):_core.toObjectString.call(void 0, a,"implementation"),D=c?_core.generateMutatorRequestOptions.call(void 0, t==null?void 0:t.requestOptions,r.hasSecondArg):"";return`export const ${i} = (
+    ${R}
+ ${c&&r.hasSecondArg?`options?: SecondParameter<typeof ${r.name}>`:""}) => {${x}
+      return ${r.name}<${o.definition.success||"unknown"}>(
+      ${P},
+      ${D});
+    }
+  `}let G=_core.generateOptions.call(void 0, {route:$,body:n,headers:e,queryParams:s,response:o,verb:l,requestOptions:t==null?void 0:t.requestOptions,isFormData:u,isFormUrlEncoded:p,isExactOptionalPropertyTypes:f,hasSignal:!1});return`export const ${i} = (
+    ${_core.toObjectString.call(void 0, a,"implementation")} ${c?`options?: AxiosRequestConfig
+`:""} ): Promise<AxiosResponse<${o.definition.success||"unknown"}>> => {${x}
+    return axios${C?"":".default"}.${l}(${G});
+  }
+`},W=({operationName:e,mutator:s,isRequestOptions:i})=>{let o=`SWRConfiguration<Awaited<ReturnType<typeof ${e}>>, TError> & { swrKey?: Key, enabled?: boolean }`;return i?`options?: { swr?:${o}, ${s?s!=null&&s.hasSecondArg?`request?: SecondParameter<typeof ${s.name}>`:"":"axios?: AxiosRequestConfig"} }
+`:`swrOptions?: ${o}`},_=({operationName:e,swrKeyFnName:s,swrProperties:i,swrKeyProperties:o,params:r,mutator:n,isRequestOptions:a,response:l,swrOptions:w,props:g})=>{var u;let t=_core.toObjectString.call(void 0, g,"implementation"),$=i,y=`const isEnabled = swrOptions?.enabled !== false${r.length?` && !!(${r.map(({name:p})=>p).join(" && ")})`:""}
+    const swrKey = swrOptions?.swrKey ?? (() => isEnabled ? ${s}(${o}) : null);`,c=`AxiosError<${l.definition.errors||"unknown"}>`;return n&&(c=n.hasErrorType?`ErrorType<${l.definition.errors||"unknown"}>`:l.definition.errors||"unknown"),`
+export type ${_core.pascal.call(void 0, e)}QueryResult = NonNullable<Awaited<ReturnType<typeof ${e}>>>
+export type ${_core.pascal.call(void 0, e)}QueryError = ${c}
+
+export const ${_core.camel.call(void 0, `use-${e}`)} = <TError = ${c}>(
+ ${t} ${W({operationName:e,mutator:n,isRequestOptions:a})}
+  ) => {
+
+  ${a?`const {swr: swrOptions${n?n!=null&&n.hasSecondArg?", request: requestOptions":"":", axios: axiosOptions"}} = options ?? {}`:""}
+
+  ${y}
+  const swrFn = () => ${e}(${$}${$?", ":""}${a?n?n!=null&&n.hasSecondArg?"requestOptions":"":"axiosOptions":""});
+
+  const query = useSwr<Awaited<ReturnType<typeof swrFn>>, TError>(swrKey, swrFn, ${w.options?`{
+    ${(u=_core.stringify.call(void 0, w.options))==null?void 0:u.slice(1,-1)}
+    ...swrOptions
+  }`:"swrOptions"})
+
+  return {
+    swrKey,
+    ...query
+  }
+}
+`},U=({queryParams:e,operationName:s,body:i,props:o,verb:r,params:n,override:a,mutator:l,response:w},{route:g})=>{let t=(a==null?void 0:a.requestOptions)!==!1;if(r!==_core.Verbs.GET)return"";let $=o.map(({name:p,type:f})=>f===_core.GetterPropType.BODY?i.implementation:p).join(","),y=o.filter(p=>p.type!==_core.GetterPropType.HEADER).map(({name:p,type:f})=>f===_core.GetterPropType.BODY?i.implementation:p).join(","),c=_core.camel.call(void 0, `get-${s}-key`),u=_core.toObjectString.call(void 0, o.filter(p=>p.type!==_core.GetterPropType.HEADER),"implementation");return`export const ${c} = (${u}) => [\`${g}\`${e?", ...(params ? [params]: [])":""}${i.implementation?`, ${i.implementation}`:""}];
+
+    ${_({operationName:s,swrKeyFnName:c,swrProperties:$,swrKeyProperties:y,params:n,props:o,mutator:l,isRequestOptions:t,response:w,swrOptions:a.swr})}
+`},Y= exports.generateSwrTitle =()=>"",Q= exports.generateSwrHeader =({isRequestOptions:e,isMutator:s,hasAwaitedType:i})=>`
+  ${i?"":`type AwaitedInput<T> = PromiseLike<T> | T;
+
+      type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
+
+`}
+  ${e&&s?`// eslint-disable-next-line
+  type SecondParameter<T extends (...args: any) => any> = T extends (
+  config: any,
+  args: infer P,
+) => any
+  ? P
+  : never;
+
+`:""}`,L= exports.generateSwrFooter =()=>"",X= exports.generateSwr =(e,s)=>{let i=_core.generateVerbImports.call(void 0, e),o=j(e,s),r=U(e,s);return{implementation:`${o}
+
+${r}`,imports:i}},z={client:X,header:Q,dependencies:N,footer:L,title:Y},J= exports.builder =()=>z,$e= exports.default =J;exports.builder = J; exports.default = $e; exports.generateSwr = X; exports.generateSwrFooter = L; exports.generateSwrHeader = Q; exports.generateSwrTitle = Y; exports.getSwrDependencies = N;

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@orval/swr",
+  "version": "6.11.0-alpha.1",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup ./src/index.ts --target node12 --minify --clean --dts --splitting",
+    "dev": "tsup ./src/index.ts --target node12 --clean --watch src",
+    "lint": "eslint src/**/*.ts"
+  },
+  "dependencies": {
+    "@orval/core": "6.11.0-alpha.1"
+  }
+}