@gasket/template-api-fastify 0.0.0-canary-20250922153852

package/template/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "{{{appName}}}",
+  "version": "0.0.0",
+  "description": "Gasket App",
+  "scripts": {
+    "docs": "tsx gasket.ts docs",
+    "prebuild": "tsx gasket.ts build",
+    "build": "tsc",
+    "preview": "npm run build && npm run start",
+    "start": "node dist/server.js",
+    "local": "tsx watch server.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint --ext .js,.jsx,.cjs,.ts,.tsx .",
+    "lint:fix": "npm run lint -- --fix",
+    "posttest": "npm run lint"
+  },
+  "dependencies": {
+    "@gasket/core": "^7.5.2",
+    "@gasket/plugin-command": "^7.5.2",
+    "@gasket/plugin-dynamic-plugins": "^7.4.1",
+    "@gasket/plugin-fastify": "^7.4.5",
+    "@gasket/plugin-https": "^7.3.11",
+    "@gasket/plugin-logger": "^7.3.7",
+    "@gasket/plugin-swagger": "^7.3.9",
+    "@gasket/plugin-winston": "^7.3.7",
+    "@gasket/request": "^7.4.3",
+    "@gasket/utils": "^7.4.2",
+    "fastify": "^4.29.1",
+    "winston": "^3.17.0"
+  },
+  "devDependencies": {
+    "@docusaurus/core": "^3.8.1",
+    "@docusaurus/preset-classic": "^3.8.1",
+    "@gasket/plugin-docs": "^7.4.7",
+    "@gasket/plugin-docusaurus": "^7.4.5",
+    "@gasket/plugin-metadata": "^7.5.3",
+    "@typescript-eslint/parser": "^8.38.0",
+    "@vitest/coverage-v8": "^3.2.0",
+    "ajv": "^8.17.1",
+    "eslint": "^8.57.1",
+    "eslint-config-godaddy": "^7.1.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "search-insights": "^2.17.3",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
+    "vitest": "^3.2.0"
+  },
+  "type": "module",
+  "eslintIgnore": [
+    "dist",
+    "coverage/",
+    "build/"
+  ],
+  "eslintConfig": {
+    "extends": [
+      "godaddy"
+    ],
+    "parser": "@typescript-eslint/parser"
+  }
+}

package/template/plugins/README.md

@@ -0,0 +1,11 @@
+# Local Plugins
+
+### Routes plugin
+
+A local plugin is used to define Fastify routes. The plugin hooks the `fastify` lifecycle and mutates the Fastify app.
+
+The following routes are available:
+
+```javascript
+GET /default
+```

package/template/plugins/routes-plugin.ts

@@ -0,0 +1,27 @@
+export const defaultHandler = async (req, res) => {
+  if (res.statusCode === 200) {
+    res.send({ message: 'Welcome to your default route...' });
+  }
+};
+export default {
+  name: 'routes-plugin',
+  hooks: {
+    fastify(gasket, app) {
+      /**
+      * @swagger
+      *
+      * /default:
+      *   get:
+      *     summary: "Get default route"
+      *     produces:
+      *       - "application/json"
+      *     responses:
+      *       "200":
+      *         description: "Returns welcome message."
+      *         content:
+      *           application/json
+      */
+      app.get('/default', defaultHandler);
+    }
+  }
+};

package/template/server.ts

@@ -0,0 +1,4 @@
+// Imports use the .js to support a type module application
+// See README for more information
+import gasket from './gasket.js';
+gasket.actions.startServer();

package/template/swagger.json

@@ -0,0 +1,28 @@
+{
+  "info": {
+    "title": "fastify-ts",
+    "version": "0.0.0"
+  },
+  "swagger": "2.0",
+  "paths": {
+    "/default": {
+      "get": {
+        "summary": "Get default route",
+        "produces": [
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "description": "Returns welcome message.",
+            "content": "application/json"
+          }
+        }
+      }
+    }
+  },
+  "definitions": {},
+  "responses": {},
+  "parameters": {},
+  "securityDefinitions": {},
+  "tags": []
+}

package/template/test/index.test.ts

@@ -0,0 +1,21 @@
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { defaultHandler } from '../plugins/routes-plugin.js';
+
+describe('Routes', () => {
+  let mockRequest, mockResponse;
+
+  beforeEach(() => {
+    mockRequest = {};
+    mockResponse = {
+      statusCode: 200,
+      send: vi.fn()
+    };
+  });
+
+  it('defaultHeader should use expected message', async () => {
+    await defaultHandler(mockRequest, mockResponse);
+    expect(mockResponse.send).toHaveBeenCalledWith({
+      message: 'Welcome to your default route...'
+    });
+  });
+});

package/template/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "skipLibCheck": true,
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "target": "ESNext",
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "outDir": "dist",
+    "lib": [
+      "esnext"
+    ],
+    "types": [
+      "node"
+    ],
+    "baseUrl": "./",
+    "allowJs": true,
+    "strict": false,
+    "incremental": true,
+    "resolveJsonModule": true
+  },
+  "exclude": [
+    "node_modules"
+  ],
+  "include": [
+    "./plugins",
+    "./routes",
+    "gasket-data.ts",
+    "server.ts",
+    "gasket.ts"
+  ]
+}

package/template/vitest.config.js

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true
+  }
+});
+