@gasket/template-nextjs-express 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-nextjs-express",
+  "version": "0.0.0-canary-20250922153852",
+  "description": "Gasket Next.js Pages Router template with Express",
+  "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-nextjs-express",
+  "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,125 @@
+# {{{appName}}}
+
+## Overview
+
+This application is built with [Gasket] and [Next.js] utilizing [EcmaScript Modules] and requires Node.js v20 or higher.
+
+## Getting Started
+
+### Development
+
+To start the app 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=express:* npm run local // express operations only
+```
+
+### Documentation
+
+Generated docs will be placed in the `.docs` directory. To generate markdown documentation for the API, run:
+
+```bash
+npm run docs
+```
+
+### Page Router
+
+This Gasket app uses Next.js 14 with [Page Router] which relies on the traditional file-based routing within the pages directory. The integration with Next.js 14 leverages features like server-side rendering and static optimization, providing a streamlined development process and ensuring the app remains efficient and scalable.
+
+
+
+### Custom Server
+
+This Gasket app uses Next.js 14 Page Router with a [Custom Server] implementation. The Custom Server allows for more control over the server environment, enabling advanced features like custom routing, middleware, and server-side rendering. This integration enhances development by providing a flexible and scalable solution for building web applications.
+
+### TypeScript & Custom Server
+
+This Gasket app uses TypeScript with Next.js and a [Custom Server] for enhanced type safety and flexibility. A separate `tsc` process and `tsconfig.server` file are necessary to compile TypeScript code for the custom server and additional files. It’s essential to include root-level Gasket files in the Next.js TypeScript build and configure TypeScript aliases in the Next.js application to correctly import these Gasket TypeScript files into the Next.js application code. This setup ensures that all TypeScript code integrates smoothly and maintains strong type checking.
+
+### Aliases
+
+In Gasket apps that use TypeScript with Next.js [Page Router] and [Custom Server], it’s essential to configure TypeScript aliases to import Gasket TypeScript files correctly. The use-cases are as follows:
+
+- `tsconfig.json` - Aliases for importing root-level Gasket files into application code.
+
+Here is an example TypeScript plugin:
+
+```ts
+// plugins/my-cool-plugin.ts
+export default {
+  name: 'my-cool-plugin',
+  hooks: {
+    // hooks
+  }
+}
+```
+
+Import the TypeScript plugin in the `gasket.ts`:
+
+```ts
+// gasket.ts
+import { makeGasket } from '@gasket/core';
+import myCoolPlugin from './plugins/my-cool-plugin.ts';
+```
+
+The expectation would that the above import should work correctly but it does not. The absolute path import is not compiled or changes by the TypeScript compiler. The extensions are never changed and the cannot be left out due to the constraints with ESM.
+
+Import the TypeScript plugin in the `gasket.ts` using the `.js` extension:
+
+```ts
+// gasket.ts
+import { makeGasket } from '@gasket/core';
+import myCoolPlugin from './plugins/my-cool-plugin.js';
+```
+
+This workaround allows TypeScript to resolve the `.ts` file to the `.js` file at runtime. The relative paths in the compiled `.js` files resolve correctly.
+
+An example of importing a Gasket TypeScript file into Next.js application code:
+
+```tsx
+// index.tsx
+import gasket from '@/gasket'; // preconfigured TypeScript alias
+
+export default function Home() {
+  return (
+    <div>
+      <h1>{gasket.config.coolValue}</h1>
+    </div>
+  );
+}
+```
+
+For `.ts` Gasket files that need to be used in NextJS application code, be sure to configure the appropriate TypeScript aliases in the `tsconfig.json` file.
+
+
+### 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.
+
+<!-- LINKS -->
+[Gasket]: https://gasket.dev
+[Next.js]: https://nextjs.org
+[EcmaScript Modules]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+[tsx]: https://tsx.is/
+[@gasket/plugin-typescript]: https://gasket.dev/docs/plugins/plugin-typescript/
+[Gasket TypeScript]: https://gasket.dev/docs/typescript/
+[Custom Server]: https://nextjs.org/docs/pages/building-your-application/configuring/custom-server
+[Page Router]: https://nextjs.org/docs/pages
+[Docusaurus]: https://docusaurus.io/

package/template/components/head.tsx

@@ -0,0 +1,13 @@
+import React from 'react';
+import NextHead from 'next/head.js';
+
+const Head = ({ title, description }) => (
+  <NextHead>
+    <meta charSet='UTF-8'/>
+    <title>{title}</title>
+    <meta name='description' content={ description }/>
+    <meta name='viewport' content='width=device-width, initial-scale=1, shrink-to-fit=no'/>
+  </NextHead>
+);
+
+export default Head;

package/template/gasket.ts

@@ -0,0 +1,42 @@
+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 pluginLogger from '@gasket/plugin-logger';
+import pluginWebpack from '@gasket/plugin-webpack';
+import pluginWinston from '@gasket/plugin-winston';
+import pluginHttps from '@gasket/plugin-https';
+import pluginExpress from '@gasket/plugin-express';
+import pluginNextjs from '@gasket/plugin-nextjs';
+import pluginIntl from '@gasket/plugin-intl';
+
+export default makeGasket({
+  plugins: [
+    pluginCommand,
+    pluginDynamicPlugins,
+    pluginLogger,
+    pluginWebpack,
+    pluginWinston,
+    pluginHttps,
+    pluginExpress,
+    pluginNextjs,
+    pluginIntl
+  ],
+  commands: {
+    docs: {
+      dynamicPlugins: [
+        '@gasket/plugin-docs',
+        '@gasket/plugin-metadata',
+        '@gasket/plugin-docusaurus'
+      ]
+    }
+  },
+  intl: {
+    locales: [
+      'en-US',
+      'fr-FR'
+    ],
+    defaultLocale: 'en-US',
+    managerFilename: 'intl.ts'
+  }
+} as GasketConfigDefinition);

package/template/intl.ts

@@ -0,0 +1,22 @@
+/* -- GENERATED FILE - DO NOT EDIT -- */
+import { makeIntlManager } from '@gasket/intl';
+import type { LocaleManifest } from '@gasket/intl';
+
+const manifest: LocaleManifest = {
+  defaultLocaleFilePath: 'locales',
+  staticLocaleFilePaths: [
+    'locales'
+  ],
+  defaultLocale: 'en-US',
+  locales: [
+    'en-US',
+    'fr-FR'
+  ],
+  localesMap: {},
+  imports: {
+    'locales/en-US': () => import('./locales/en-US.json'),
+    'locales/fr-FR': () => import('./locales/fr-FR.json')
+  }
+};
+
+export default makeIntlManager(manifest);

package/template/locales/en-US.json

@@ -0,0 +1,5 @@
+{
+  "gasket_welcome": "Welcome to Gasket!",
+  "gasket_learn": "Learn Gasket",
+  "gasket_edit_page": "To get started, edit pages/index.js and save to reload."
+}

package/template/locales/fr-FR.json

@@ -0,0 +1,5 @@
+{
+  "gasket_welcome": "Bienvenue à Gasket!",
+  "gasket_learn": "Apprendre Gasket",
+  "gasket_edit_page": "Pour commencer, modifiez pages/index.js et enregistrez pour recharger."
+}

package/template/next-env.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+/// <reference path="./.next/types/routes.d.ts" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.

package/template/next.config.js

@@ -0,0 +1,4 @@
+import 'tsx';
+
+const gasket = (await import('./gasket.ts')).default;
+export default gasket.actions.getNextConfig();