@gasket/preset-api 7.5.4 → 7.5.5

package/EXAMPLES.md

@@ -0,0 +1,210 @@
+# @gasket/preset-api Examples
+
+This document provides examples of using the `@gasket/preset-api` preset and understanding its hooks.
+
+## Using the Preset
+
+### Creating a new API project
+
+```bash
+# Create a new API project using the preset
+npx create-gasket-app@latest my-api --presets @gasket/preset-api
+
+# Or with yarn
+yarn create gasket-app my-api --presets @gasket/preset-api
+
+# With config to skip prompts
+npx create-gasket-app@latest my-api \
+  --presets @gasket/preset-api \
+  --config '{"server": "express", "typescript": true, "useSwagger": true}'
+```
+
+## Generated Project Structure
+
+### JavaScript Project
+
+```
+my-api/
+├── server.js              # Server entry point
+├── gasket.js              # Gasket configuration
+├── package.json           # Project configuration
+└── README.md              # Project documentation
+```
+
+### TypeScript Project
+
+```
+my-api/
+├── gasket.ts              # Gasket configuration (TypeScript)
+├── package.json           # Project configuration
+└── README.md              # Project documentation
+```
+
+## Server Framework Examples
+
+### Express Server
+
+```js
+// When server: 'express' is selected
+// gasket.js
+import { makeGasket } from '@gasket/core';
+import pluginExpress from '@gasket/plugin-express';
+import pluginHttps from '@gasket/plugin-https';
+
+export default makeGasket({
+  plugins: [
+    pluginExpress,
+    pluginHttps,
+    // ... other plugins
+  ]
+});
+
+// Your route definitions
+export default {
+  name: 'my-routes',
+  hooks: {
+    express(gasket, app) {
+      app.get('/api/health', (req, res) => {
+        res.json({ status: 'healthy' });
+      });
+
+      app.get('/api/users', (req, res) => {
+        res.json({ users: [] });
+      });
+    }
+  }
+};
+```
+
+### Fastify Server
+
+```js
+// When server: 'fastify' is selected
+// gasket.js
+import { makeGasket } from '@gasket/core';
+import pluginFastify from '@gasket/plugin-fastify';
+import pluginHttps from '@gasket/plugin-https';
+
+export default makeGasket({
+  plugins: [
+    pluginFastify,
+    pluginHttps,
+    // ... other plugins
+  ]
+});
+
+// Your route definitions
+export default {
+  name: 'my-routes',
+  hooks: {
+    fastify(gasket, app) {
+      app.get('/api/health', async (request, reply) => {
+        return { status: 'healthy' };
+      });
+
+      app.get('/api/users', async (request, reply) => {
+        return { users: [] };
+      });
+    }
+  }
+};
+```
+
+## Integration Examples
+
+### With TypeScript
+
+```typescript
+// gasket.ts
+import { makeGasket } from '@gasket/core';
+import pluginExpress from '@gasket/plugin-express';
+import pluginTypescript from '@gasket/plugin-typescript';
+
+export default makeGasket({
+  plugins: [
+    pluginExpress
+    // ... other plugins
+  ]
+});
+
+// types/api.ts
+export interface User {
+  id: number;
+  name: string;
+  email: string;
+}
+
+// routes/users.ts
+import type { User } from '../types/api.js';
+
+export default {
+  name: 'user-routes',
+  hooks: {
+    express(gasket, app) {
+      app.get('/api/users', (req, res) => {
+        const users: User[] = [
+          { id: 1, name: 'John', email: 'john@example.com' }
+        ];
+        res.json({ users });
+      });
+    }
+  }
+};
+```
+
+### With Swagger
+
+```js
+// gasket.js - when useSwagger: true
+import { makeGasket } from '@gasket/core';
+import pluginSwagger from '@gasket/plugin-swagger';
+
+export default makeGasket({
+  plugins: [
+    pluginSwagger,
+    // ... other plugins
+  ],
+  swagger: {
+    jsdoc: {
+      definition: {
+        openapi: '3.0.0',
+        info: {
+          title: 'My API',
+          version: '1.0.0'
+        }
+      },
+      apis: ['./routes/*.js']
+    }
+  }
+});
+
+// routes/users.js
+/**
+ * @swagger
+ * /api/users:
+ *   get:
+ *     summary: Get all users
+ *     responses:
+ *       200:
+ *         description: List of users
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 users:
+ *                   type: array
+ *                   items:
+ *                     type: object
+ */
+export default {
+  name: 'user-routes',
+  hooks: {
+    express(gasket, app) {
+      app.get('/api/users', (req, res) => {
+        res.json({ users: [] });
+      });
+    }
+  }
+};
+```

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@gasket/preset-api",
-  "version": "7.5.4",
+  "version": "7.5.5",
   "description": "Create Express-based API with Gasket",
   "type": "module",
   "types": "lib/index.d.ts",
   "files": [
     "generator",
     "lib",
-    "cjs"
+    "cjs",
+    "EXAMPLES.md"
   ],
   "exports": {
     ".": {
@@ -27,33 +28,31 @@
   "bugs": "https://github.com/godaddy/gasket/issues",
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-preset-api",
   "dependencies": {
-    "@gasket/plugin-cypress": "^7.5.2",
-    "@gasket/plugin-docs": "^7.4.7",
-    "@gasket/plugin-command": "^7.5.2",
-    "@gasket/plugin-docusaurus": "^7.4.5",
-    "@gasket/plugin-dynamic-plugins": "^7.4.1",
-    "@gasket/plugin-express": "^7.4.3",
-    "@gasket/plugin-fastify": "^7.4.5",
-    "@gasket/plugin-git": "^7.4.6",
-    "@gasket/plugin-https": "^7.3.11",
-    "@gasket/plugin-jest": "^7.5.4",
-    "@gasket/plugin-lint": "^7.4.3",
-    "@gasket/plugin-logger": "^7.3.7",
+    "@gasket/plugin-command": "^7.5.3",
+    "@gasket/plugin-cypress": "^7.5.3",
+    "@gasket/plugin-docs": "^7.4.8",
+    "@gasket/plugin-docusaurus": "^7.4.6",
+    "@gasket/plugin-dynamic-plugins": "^7.4.2",
+    "@gasket/plugin-express": "^7.4.4",
+    "@gasket/plugin-fastify": "^7.4.6",
+    "@gasket/plugin-git": "^7.4.7",
+    "@gasket/plugin-https": "^7.3.12",
+    "@gasket/plugin-jest": "^7.5.5",
+    "@gasket/plugin-lint": "^7.4.4",
+    "@gasket/plugin-logger": "^7.3.8",
     "@gasket/plugin-mocha": "^7.5.4",
-    "@gasket/plugin-swagger": "^7.3.9",
-    "@gasket/plugin-typescript": "^7.4.5",
-    "@gasket/plugin-vitest": "^7.1.1",
-    "@gasket/plugin-winston": "^7.3.7"
+    "@gasket/plugin-swagger": "^7.3.10",
+    "@gasket/plugin-typescript": "^7.4.6",
+    "@gasket/plugin-vitest": "^7.1.2",
+    "@gasket/plugin-winston": "^7.3.8"
   },
   "devDependencies": {
-    "jest": "^29.7.0",
+    "@vitest/coverage-v8": "^3.2.0",
     "nodemon": "^3.1.9",
-    "@gasket/cjs": "^7.0.1",
-    "@gasket/plugin-metadata": "^7.5.3",
-    "create-gasket-app": "^7.4.12"
-  },
-  "jest": {
-    "transform": {}
+    "vitest": "^3.2.0",
+    "@gasket/cjs": "^7.0.2",
+    "@gasket/plugin-metadata": "^7.5.4",
+    "create-gasket-app": "^7.4.13"
   },
   "scripts": {
     "build": "gasket-cjs ./lib",
@@ -61,8 +60,8 @@
     "lint": "eslint .",
     "lint:fix": "pnpm run lint --fix",
     "posttest": "pnpm run lint",
-    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
-    "test:coverage": "jest --coverage",
-    "test:watch": "pnpm run test --watch"
+    "test": "vitest run --globals",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
   }
 }