@devup-api/webpack-plugin 0.1.2 → 0.1.4

package/README.md

@@ -1,24 +1,141 @@
 # @devup-api/webpack-plugin
 
-devup API plugin for Webpack
+Webpack plugin for devup-api that generates TypeScript types from OpenAPI schemas.
 
 ## Installation
 
 ```bash
-npm install @devup-api/webpack-plugin
+npm install @devup-api/webpack-plugin @devup-api/fetch
 ```
 
 ## Usage
 
-```typescript
-import devupApiWebpackPlugin from '@devup-api/webpack-plugin';
-import webpack from 'webpack';
+### Basic Setup
 
-const config: webpack.Configuration = {
+Add the plugin to your `webpack.config.js`:
+
+```js
+const { devupApiWebpackPlugin } = require('@devup-api/webpack-plugin')
+
+module.exports = {
+  plugins: [new devupApiWebpackPlugin()],
+}
+```
+
+### With Options
+
+```js
+const { devupApiWebpackPlugin } = require('@devup-api/webpack-plugin')
+
+module.exports = {
   plugins: [
     new devupApiWebpackPlugin({
-      // options
-    }),
+      openapiFile: './api/openapi.json',
+      convertCase: 'camel',
+      tempDir: 'temp'
+    })
   ],
-};
+}
+```
+
+### TypeScript Configuration
+
+If using TypeScript, you can use:
+
+```ts
+import { devupApiWebpackPlugin } from '@devup-api/webpack-plugin'
+import type { Configuration } from 'webpack'
+
+const config: Configuration = {
+  plugins: [new devupApiWebpackPlugin()],
+}
+
+export default config
+```
+
+## Options
+
+```ts
+interface DevupApiOptions {
+  /**
+   * OpenAPI file path
+   * @default 'openapi.json'
+   */
+  openapiFile?: string
+
+  /**
+   * Temporary directory for storing generated files
+   * @default 'df'
+   */
+  tempDir?: string
+
+  /**
+   * Case conversion type for API endpoint names and parameters
+   * @default 'camel'
+   */
+  convertCase?: 'snake' | 'camel' | 'pascal' | 'maintain'
+
+  /**
+   * Whether to make all properties non-nullable by default
+   * @default false
+   */
+  requestDefaultNonNullable?: boolean
+
+  /**
+   * Whether to make all request properties non-nullable by default
+   * @default true
+   */
+  responseDefaultNonNullable?: boolean
+}
 ```
+
+## What It Does
+
+1. Reads your `openapi.json` file during build (before compilation)
+2. Generates TypeScript interface definitions (`api.d.ts`)
+3. Creates a URL map and injects it as `process.env.DEVUP_API_URL_MAP` via webpack DefinePlugin
+4. Makes types available for use with `@devup-api/fetch`
+
+## TypeScript Configuration
+
+To use the generated types, add the generated type definitions to your `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    // ... your compiler options
+  },
+  "include": [
+    "src",
+    "df/**/*.d.ts"
+  ]
+}
+```
+
+> **Note:** If you've customized `tempDir` in plugin options, adjust the path accordingly (e.g., `"your-temp-dir/**/*.d.ts"`).
+
+## Using the Generated Types
+
+After the plugin runs, you can use the generated types with `@devup-api/fetch`:
+
+```ts
+import { createApi } from '@devup-api/fetch'
+
+const api = createApi('https://api.example.com')
+
+// Types are automatically available
+const users = await api.get('getUsers', {})
+```
+
+## Cold Typing vs Bold Typing
+
+devup-api uses a two-phase typing system:
+
+- **Cold Typing**: Before the build runs, types are `any` to prevent type errors. Your code compiles and runs smoothly.
+- **Bold Typing**: After the build runs and `api.d.ts` is generated, full type safety is enforced with strict type checking.
+
+This ensures you can start coding immediately without waiting for the build, while still getting full type safety in production.
+
+## License
+
+Apache 2.0

package/dist/index.cjs

@@ -1 +1 @@
-var{defineProperty:F,getOwnPropertyNames:Q,getOwnPropertyDescriptor:R}=Object,S=Object.prototype.hasOwnProperty;var K=new WeakMap,V=(x)=>{var W=K.get(x),q;if(W)return W;if(W=F({},"__esModule",{value:!0}),x&&typeof x==="object"||typeof x==="function")Q(x).map((z)=>!S.call(W,z)&&F(W,z,{get:()=>x[z],enumerable:!(q=R(x,z))||q.enumerable}));return K.set(x,W),W};var X=(x,W)=>{for(var q in W)F(x,q,{get:W[q],enumerable:!0,configurable:!0,set:(z)=>W[q]=()=>z})};var Y={};X(Y,{devupApiWebpackPlugin:()=>G,default:()=>G});module.exports=V(Y);var L=require("node:path"),C=require("@devup-api/generator"),B=require("@devup-api/utils"),N=require("webpack");class G{options;initialized=!1;constructor(x){this.options=x||{}}apply(x){x.hooks.beforeCompile.tapAsync("devup-api",async(W,q)=>{if(this.initialized){q();return}try{this.initialized=!0;let z=await B.createTmpDirAsync(this.options?.tempDir),H=await B.readOpenapiAsync(this.options?.openapiFile);await B.writeInterfaceAsync(L.join(z,"api.d.ts"),C.generateInterface(H,this.options));let J=C.createUrlMap(H,this.options),E={};if(J)E["process.env.DEVUP_API_URL_MAP"]=JSON.stringify(JSON.stringify(J));if(Object.keys(E).length>0)new N.DefinePlugin(E).apply(x);q()}catch(z){this.initialized=!1,q(z)}})}}
+var{defineProperty:J,getOwnPropertyNames:R,getOwnPropertyDescriptor:S}=Object,V=Object.prototype.hasOwnProperty;var N=new WeakMap,X=(x)=>{var W=N.get(x),q;if(W)return W;if(W=J({},"__esModule",{value:!0}),x&&typeof x==="object"||typeof x==="function")R(x).map((B)=>!V.call(W,B)&&J(W,B,{get:()=>x[B],enumerable:!(q=S(x,B))||q.enumerable}));return N.set(x,W),W};var Y=(x,W)=>{for(var q in W)J(x,q,{get:W[q],enumerable:!0,configurable:!0,set:(B)=>W[q]=()=>B})};var Z={};Y(Z,{devupApiWebpackPlugin:()=>K,default:()=>K});module.exports=X(Z);var P=require("node:path"),E=require("@devup-api/generator"),C=require("@devup-api/utils");class K{options;initialized=!1;constructor(x){this.options=x||{}}apply(x){x.hooks.beforeCompile.tapAsync("devup-api",async(W,q)=>{if(this.initialized){q();return}try{this.initialized=!0;let B=await C.createTmpDirAsync(this.options?.tempDir),Q=C.normalizeOpenapiFiles(this.options?.openapiFiles),L=await C.readOpenapiAsync(Q);await C.writeInterfaceAsync(P.join(B,"api.d.ts"),E.generateInterface(L,this.options));let G=E.createUrlMap(L,this.options),H={};if(G&&Object.keys(G).length>0)H["process.env.DEVUP_API_URL_MAP"]=JSON.stringify(JSON.stringify(G));if(Object.keys(H).length>0)new x.webpack.DefinePlugin(H).apply(x);q()}catch(B){this.initialized=!1,q(B)}})}}

package/dist/index.js

@@ -1 +1 @@
-import{join as F}from"node:path";import{createUrlMap as G,generateInterface as H}from"@devup-api/generator";import{createTmpDirAsync as J,readOpenapiAsync as K,writeInterfaceAsync as L}from"@devup-api/utils";import{DefinePlugin as N}from"webpack";class E{options;initialized=!1;constructor(x){this.options=x||{}}apply(x){x.hooks.beforeCompile.tapAsync("devup-api",async(Q,W)=>{if(this.initialized){W();return}try{this.initialized=!0;let q=await J(this.options?.tempDir),B=await K(this.options?.openapiFile);await L(F(q,"api.d.ts"),H(B,this.options));let C=G(B,this.options),z={};if(C)z["process.env.DEVUP_API_URL_MAP"]=JSON.stringify(JSON.stringify(C));if(Object.keys(z).length>0)new N(z).apply(x);W()}catch(q){this.initialized=!1,W(q)}})}}export{E as devupApiWebpackPlugin,E as default};
+import{join as J}from"node:path";import{createUrlMap as K,generateInterface as L}from"@devup-api/generator";import{createTmpDirAsync as N,normalizeOpenapiFiles as P,readOpenapiAsync as Q,writeInterfaceAsync as R}from"@devup-api/utils";class G{options;initialized=!1;constructor(x){this.options=x||{}}apply(x){x.hooks.beforeCompile.tapAsync("devup-api",async(S,W)=>{if(this.initialized){W();return}try{this.initialized=!0;let q=await N(this.options?.tempDir),H=P(this.options?.openapiFiles),E=await Q(H);await R(J(q,"api.d.ts"),L(E,this.options));let B=K(E,this.options),C={};if(B&&Object.keys(B).length>0)C["process.env.DEVUP_API_URL_MAP"]=JSON.stringify(JSON.stringify(B));if(Object.keys(C).length>0)new x.webpack.DefinePlugin(C).apply(x);W()}catch(q){this.initialized=!1,W(q)}})}}export{G as devupApiWebpackPlugin,G as default};

package/dist/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAOtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAGvC,qBAAa,qBAAqB;IAChC,OAAO,EAAE,eAAe,CAAA;IACxB,WAAW,UAAQ;gBAEP,OAAO,CAAC,EAAE,eAAe;IAIrC,KAAK,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;CA6ChC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAQtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEvC,qBAAa,qBAAqB;IAChC,OAAO,EAAE,eAAe,CAAA;IACxB,WAAW,UAAQ;gBAEP,OAAO,CAAC,EAAE,eAAe;IAIrC,KAAK,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;CA8ChC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devup-api/webpack-plugin",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "license": "Apache-2.0",
   "type": "module",
   "exports": {
@@ -20,12 +20,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@devup-api/utils": "0.1.2",
-    "@devup-api/core": "0.1.2",
-    "@devup-api/generator": "0.1.2"
+    "@devup-api/utils": "0.1.4",
+    "@devup-api/core": "0.1.4",
+    "@devup-api/generator": "0.1.4"
   },
   "peerDependencies": {
-    "webpack": "*",
     "@devup-api/core": "*"
   },
   "devDependencies": {