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

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 GoDaddy Operating Company, LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@gasket/template-api-fastify",
+  "version": "0.0.0-canary-20250922153852",
+  "description": "Gasket API template for Fastify",
+  "type": "module",
+  "files": [
+    "template"
+  ],
+  "repository": "godaddy/gasket.git",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "GoDaddy Operating Company, LLC",
+  "license": "MIT",
+  "bugs": "https://github.com/godaddy/gasket/issues",
+  "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-template-api-fastify",
+  "devDependencies": {
+    "@vitest/coverage-v8": "^3.2.0",
+    "vitest": "^3.2.0"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "pnpm run lint --fix",
+    "posttest": "pnpm run lint",
+    "test": "vitest run --globals",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest --watch --globals"
+  }
+}

package/template/README.md

@@ -0,0 +1,92 @@
+# {{{appName}}}
+
+## Overview
+
+This API is built with fastify.js framework and [Gasket](https://gasket.dev/). This application utilizes [EcmaScript Modules] and requires Node.js v20 or higher.
+
+## Getting Started
+
+### Development
+
+To start the API locally, run:
+
+```bash
+cd {{{appName}}}
+npm install
+npm run local
+```
+
+### Debugging
+
+To start the API locally with debugging enabled, run:
+
+```bash
+DEBUG=* npm run local
+```
+
+Extended filtering of the debug output can be achieved by adding to the `DEBUG` environment variable:
+
+```bash
+DEBUG=gasket:* npm run local // gasket operations only
+DEBUG=fastify:* npm run local // fastify operations only
+```
+
+### Documentation
+
+Generated docs will be placed in the `.docs` directory. To generate markdown documentation for the API, run:
+
+```bash
+npm run docs
+```
+
+### Docusaurus
+
+When using [Docusaurus], generated docs will be available at `http://localhost:3000` when running the [Docusaurus] server. By default the Docusaurus server is started with the `docs` script. Add the `--no-view` option to only generate the markdown files.
+
+### Definitions
+
+Use `@swagger` JSDocs to automatically generate the [swagger.json] spec file. Visit [swagger-jsdoc] for examples.
+
+### TypeScript
+
+This API is built with TypeScript. To compile the TypeScript code, run:
+
+```bash
+npm run build
+```
+
+Use the `start` script to run the compiled code:
+
+```bash
+npm start
+```
+
+Run `build` and `start` together:
+
+```bash
+npm run preview
+```
+
+Compiled code will be placed in the `dist` directory. For local development, the [tsx] runtime is used and the watcher will be started automatically when running the `local` script.
+
+#### ESM & TypeScript
+
+A common workaround when using ESM in a TypeScript project with `"type": "module"` set in `package.json` is to import `.ts` files using the `.js` extension. For example:
+
+```ts
+import { myFunction } from './myModule.js';
+```
+
+Here, `myModule.ts` is the actual TypeScript file, but it's imported using the `.js` extension. TypeScript is able to resolve `myModule.ts` to `myModule.js`, making the import work at runtime.
+
+For more information, see the extended documentation in the [Gasket TypeScript] doc and the [@gasket/plugin-typescript] package.
+
+
+<!-- LINKS -->
+[EcmaScript Modules]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+[Docusaurus]: https://docusaurus.io/
+[tsx]: https://tsx.is/
+[@gasket/plugin-typescript]: https://gasket.dev/docs/plugins/plugin-typescript/
+[Gasket TypeScript]: https://gasket.dev/docs/typescript/
+[swagger-jsdoc]: https://github.com/Surnet/swagger-jsdoc/
+[swagger.json]: /swagger.json

package/template/gasket.ts

@@ -0,0 +1,46 @@
+import type { GasketConfigDefinition } from '@gasket/core';
+import { makeGasket } from '@gasket/core';
+import pluginCommand from '@gasket/plugin-command';
+import pluginDynamicPlugins from '@gasket/plugin-dynamic-plugins';
+import pluginHttps from '@gasket/plugin-https';
+import pluginLogger from '@gasket/plugin-logger';
+import pluginWinston from '@gasket/plugin-winston';
+import pluginFastify from '@gasket/plugin-fastify';
+import pluginRoutes from './plugins/routes-plugin.js';
+import pluginSwagger from '@gasket/plugin-swagger';
+
+export default makeGasket({
+  plugins: [
+    pluginCommand,
+    pluginDynamicPlugins,
+    pluginHttps,
+    pluginLogger,
+    pluginWinston,
+    pluginFastify,
+    pluginRoutes,
+    pluginSwagger
+  ],
+  commands: {
+    docs: {
+      dynamicPlugins: [
+        '@gasket/plugin-docs',
+        '@gasket/plugin-metadata',
+        '@gasket/plugin-docusaurus'
+      ]
+    }
+  },
+  swagger: {
+    jsdoc: {
+      definition: {
+        info: {
+          title: 'fastify-ts',
+          version: '0.0.0'
+        }
+      },
+      apis: [
+        './routes/*',
+        './plugins/*'
+      ]
+    }
+  }
+} as GasketConfigDefinition);