@digitaldefiance/express-suite-starter 2.3.4 → 2.3.6

package/scaffolding/root/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  actions: read
+  contents: read
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          filter: tree:0
+          fetch-depth: 0
+
+      
+      
+
+      # This enables task distribution via Nx Cloud
+      # Run this command as early as possible, before dependencies are installed
+      # Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
+      # Uncomment this line to enable task distribution
+      # - run: yarn nx-cloud start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="build"
+
+      
+      # Cache node_modules
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'yarn'
+       
+      - run: yarn install --frozen-lockfile
+      - uses: nrwl/nx-set-shas@v4
+
+      # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
+      # - run: yarn nx-cloud record -- echo Hello World
+      # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
+      - run: yarn nx affected -t lint test build

package/scaffolding/root/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    "recommendations": [
+      "nrwl.angular-console",
+      "esbenp.prettier-vscode",
+      "dbaeumer.vscode-eslint",
+      "ms-playwright.playwright",
+      "firsttris.vscode-jest-runner"
+    ]
+  }

package/scaffolding/root/DEPLOYMENT.md

@@ -0,0 +1,104 @@
+# Deployment Guide
+
+## API Base URL Configuration
+
+The React frontend needs to know where your API is hosted. There are three configuration methods:
+
+### 1. Same Domain (Recommended for Production)
+
+Deploy frontend and API on the same domain. The production build uses relative URLs by default.
+
+**Example**: `https://example.com` (frontend) and `https://example.com/api` (API)
+
+No configuration needed - uses `environment.prod.ts` with `apiUrl: '/api'`
+
+### 2. Different Domain (Build-Time)
+
+Edit `{{prefix}}-react/src/environments/environment.prod.ts`:
+
+```typescript
+export const environment = {
+  production: true,
+  apiUrl: 'https://api.example.com/api',
+};
+```
+
+Rebuild: `yarn build`
+
+### 3. Different Domain (Runtime)
+
+For deploying the same build to multiple domains, inject runtime config in your index.html:
+
+```html
+<script>
+  window.APP_CONFIG = {
+    apiUrl: 'https://api.example.com/api'
+  };
+</script>
+```
+
+This overrides the environment file without rebuilding.
+
+## Environment Files
+
+### Development (`environment.ts`)
+
+```typescript
+export const environment = {
+  production: false,
+  apiUrl: 'http://localhost:3000/api',
+};
+```
+
+### Production (`environment.prod.ts`)
+
+```typescript
+export const environment = {
+  production: true,
+  apiUrl: '/api',  // Relative URL for same-domain deployment
+};
+```
+
+## Build Commands
+
+```bash
+# Development
+yarn serve:dev
+
+# Production build
+yarn build
+
+# Production serve
+yarn serve
+```
+
+## API Environment Variables
+
+Configure `{{prefix}}-api/.env`:
+
+```bash
+# Required
+MONGO_URI=mongodb://localhost:27017/{{workspaceName}}
+JWT_SECRET=your-64-char-hex-secret
+MNEMONIC_HMAC_SECRET=your-64-char-hex-secret
+MNEMONIC_ENCRYPTION_KEY=your-64-char-hex-secret
+
+# Optional
+PORT=3000
+HOST=0.0.0.0
+DEBUG=false
+```
+
+Generate secrets: `yarn new:secret`
+
+## Deployment Checklist
+
+- [ ] Set production environment variables in `{{prefix}}-api/.env`
+- [ ] Configure API base URL (method 1, 2, or 3 above)
+- [ ] Run `yarn build` to build all projects
+- [ ] Test production build locally: `yarn serve`
+- [ ] Deploy `dist/{{prefix}}-api` to your API server
+- [ ] Deploy `dist/{{prefix}}-react` to your web server
+- [ ] Verify HTTPS is enabled
+- [ ] Test authentication flow
+- [ ] Monitor logs for errors

package/scaffolding/root/do-yarn.sh

@@ -0,0 +1,148 @@
+#!/bin/bash
+set -e
+
+# Ensure corepack is enabled and we're using the right yarn version
+export COREPACK_ENABLE_DOWNLOAD_PROMPT=0
+corepack enable
+
+# Source NVM if available
+if [ -s "/usr/local/share/nvm/nvm.sh" ]; then
+  . /usr/local/share/nvm/nvm.sh
+elif [ -s "${HOME}/.nvm/nvm.sh" ]; then
+  . "${HOME}/.nvm/nvm.sh"
+fi
+
+# Find all package.json files, excluding node_modules, dist, and hidden directories
+PACKAGE_ROOTS=$(find . -type f -name "package.json" ! -path "*/node_modules/*" ! -path "*/dist/*" ! -path "*/.*/*")
+
+# Make sure we start with the project root
+PROJECT_ROOT=$(pwd -P)
+
+if command -v realpath >/dev/null 2>&1; then
+  resolve_path() {
+    realpath -m "$1"
+  }
+else
+  resolve_path() {
+    local path="$1"
+    if [ -z "$path" ]; then
+      return 1
+    fi
+
+    if [ -d "$path" ]; then
+      (cd "$path" 2>/dev/null && pwd -P) || return 1
+      return 0
+    fi
+
+    local dir
+    dir=$(dirname "$path")
+    if [ -z "$dir" ] || [ "$dir" = "." ]; then
+      dir="$PWD"
+    fi
+
+    local base
+    base=$(basename "$path")
+
+    (cd "$dir" 2>/dev/null && printf '%s/%s\n' "$(pwd -P)" "$base") || return 1
+  }
+fi
+
+trim_whitespace() {
+  local trimmed="$1"
+  trimmed="${trimmed#"${trimmed%%[![:space:]]*}"}"
+  trimmed="${trimmed%"${trimmed##*[![:space:]]}"}"
+  printf '%s' "$trimmed"
+}
+
+IGNORE_PATHS=()
+
+add_ignore_path() {
+  local candidate="$1"
+  [ -n "$candidate" ] || return
+  for existing in "${IGNORE_PATHS[@]}"; do
+    if [ "$existing" = "$candidate" ]; then
+      return
+    fi
+  done
+  IGNORE_PATHS+=("$candidate")
+}
+
+while IFS= read -r IGNORE_FILE; do
+  [ -n "$IGNORE_FILE" ] || continue
+  IGNORE_DIR=$(dirname "$IGNORE_FILE")
+  IGNORE_DIR_ABS=$(cd "$IGNORE_DIR" 2>/dev/null && pwd -P)
+  [ -n "$IGNORE_DIR_ABS" ] || continue
+
+  while IFS= read -r RAW_PATTERN || [ -n "$RAW_PATTERN" ]; do
+    PATTERN=$(trim_whitespace "$RAW_PATTERN")
+    [ -n "$PATTERN" ] || continue
+    if [ "${PATTERN:0:1}" = "#" ]; then
+      continue
+    fi
+
+    if [ "${PATTERN:0:1}" = "/" ]; then
+      CANDIDATE="$PATTERN"
+    else
+      CANDIDATE="$IGNORE_DIR_ABS/$PATTERN"
+    fi
+
+    if ! RESOLVED=$(resolve_path "$CANDIDATE"); then
+      continue
+    fi
+
+    RESOLVED="${RESOLVED%/}"
+    if [ -f "$RESOLVED" ]; then
+      RESOLVED=$(dirname "$RESOLVED")
+    fi
+
+    add_ignore_path "$RESOLVED"
+  done < "$IGNORE_FILE"
+done < <(find . -type f -name ".doyarnignore" ! -path "*/node_modules/*" ! -path "*/dist/*" ! -path "*/.*/*" 2>/dev/null)
+
+# Run yarn in the project root using corepack
+echo "Running yarn in $PROJECT_ROOT"
+#corepack yarn "$@"
+NODE_OPTIONS="--max_old_space_size=3072" corepack yarn "$@"
+
+# Loop through each package.json file
+for PACKAGE in $PACKAGE_ROOTS; do
+  # Get the directory containing the package.json file
+  PACKAGE_DIR=$(dirname "$PACKAGE")
+
+  PACKAGE_DIR_ABS=$(resolve_path "$PACKAGE_DIR")
+  [ -n "$PACKAGE_DIR_ABS" ] || continue
+
+  # Skip the project root directory
+  if [ "$PACKAGE_DIR_ABS" = "$PROJECT_ROOT" ]; then
+    continue
+  fi
+
+  SKIP_PACKAGE=false
+  if [ ${#IGNORE_PATHS[@]} -gt 0 ]; then
+    for IGNORE_PATH in "${IGNORE_PATHS[@]}"; do
+      [ -n "$IGNORE_PATH" ] || continue
+      case "$PACKAGE_DIR_ABS" in
+        "$IGNORE_PATH"|"$IGNORE_PATH"/*)
+          echo "Skipping yarn in $PACKAGE_DIR (ignored by .doyarnignore)"
+          SKIP_PACKAGE=true
+          break
+          ;;
+      esac
+    done
+  fi
+
+  if [ "$SKIP_PACKAGE" = true ]; then
+    continue
+  fi
+
+  # Change to the package directory
+  cd "$PACKAGE_DIR" || exit
+
+  # Run yarn using corepack
+  echo "Running yarn in $PACKAGE_DIR"
+  #corepack yarn "$@"
+  NODE_OPTIONS="--max_old_space_size=3072" corepack yarn "$@"
+
+  # Return to the project root directory
+  cd "$PROJECT_ROOT" || exit
+done

package/scaffolding/root/ensure-git-globals.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+if [ -z "${GIT_EMAIL}" ]; then
+  echo "GIT_EMAIL is not set. Please set it to your email address."
+  exit 1
+fi
+if [ -z "${GIT_NAME}" ]; then
+  echo "GIT_NAME is not set. Please set it to your name."
+  exit 1
+fi
+
+# Check if user.email is already set
+CURRENT_EMAIL=$(git config --global --get user.email || echo "")
+# Check if user.name is already set
+CURRENT_NAME=$(git config --global --get user.name || echo "")
+
+# Set user.email if it's not set or different from GIT_EMAIL
+if [ -z "${CURRENT_EMAIL}" ] || [ "${CURRENT_EMAIL}" != "${GIT_EMAIL}" ]; then
+  echo "Setting git global user.email to ${GIT_EMAIL}"
+  git config --global user.email "${GIT_EMAIL}"
+else
+  echo "Git global user.email already set to ${CURRENT_EMAIL}"
+fi
+
+# Set user.name if it's not set or different from GIT_NAME
+if [ -z "${CURRENT_NAME}" ] || [ "${CURRENT_NAME}" != "${GIT_NAME}" ]; then
+  echo "Setting git global user.name to ${GIT_NAME}"
+  git config --global user.name "${GIT_NAME}"
+else
+  echo "Git global user.name already set to ${CURRENT_NAME}"
+fi

package/scaffolding/root/eslint.config.mjs

@@ -0,0 +1,70 @@
+// eslint.config.mjs
+
+import typescriptPlugin from '@typescript-eslint/eslint-plugin';
+import typescriptParser from '@typescript-eslint/parser';
+import prettierConfig from 'eslint-config-prettier';
+import prettierPlugin from 'eslint-plugin-prettier';
+import reactPlugin from 'eslint-plugin-react';
+import reactHooksPlugin from 'eslint-plugin-react-hooks';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+// Get the directory name of the current module
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default [
+  {
+    ignores: ['**/dist', '**/node_modules', '**/.nx'],
+  },
+  {
+    files: ['**/*.{ts,tsx,js,jsx}'],
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        project: path.resolve(__dirname, './tsconfig.base.json'), // Use absolute path to the root tsconfig.base.json
+        ecmaVersion: 2023,
+        sourceType: 'module',
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    plugins: {
+      '@typescript-eslint': typescriptPlugin,
+      react: reactPlugin,
+      'react-hooks': reactHooksPlugin,
+      prettier: prettierPlugin,
+    },
+    rules: {
+      // Recommended rules from plugins
+      ...typescriptPlugin.configs.recommended.rules,
+      ...reactPlugin.configs.recommended.rules,
+      ...reactHooksPlugin.configs.recommended.rules,
+      ...prettierConfig.rules,
+
+      // Disable conflicting core rules
+      'no-empty-function': 'off',
+
+      // TypeScript-specific rules
+      '@typescript-eslint/no-empty-function': [
+        'error',
+        { allow: ['arrowFunctions', 'functions'] },
+      ],
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/ban-types': 'off',
+      '@typescript-eslint/no-unused-vars': 'error',
+
+      // Other custom rules
+      'prettier/prettier': 'error',
+      'react/prop-types': 'off',
+      'react/react-in-jsx-scope': 'off',
+    },
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+  },
+];

package/scaffolding/root/list-scripts.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# Check if jq is installed
+if ! command -v jq &> /dev/null
+then
+    echo "jq could not be found. Please install jq to use this script."
+    exit
+fi
+
+# Read and list the scripts from package.json
+echo "Available scripts in package.json:"
+jq -r '.scripts | to_entries[] | "\(.key): \(.value)"' package.json

package/scaffolding/root/npm-install-globals.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+yes | npm install -g yarn@latest @nrwl/cli nx jest @withgraphite/graphite-cli@stable --force "$@"
+if [ ! -z "$GRAPHITE_KEY" ]; then
+  npx --yes @withgraphite/graphite-cli@stable auth --token "${GRAPHITE_KEY}"
+fi

package/scaffolding/root/nuke-node-modules.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# Find all package.json files, excluding node_modules, dist, and hidden directories
+PACKAGE_ROOTS=$(find . -type f -name "package.json" ! -path "*/node_modules/*" ! -path "*/dist/*" ! -path "*/.*/*")
+
+# Make sure we start with the project root
+PROJECT_ROOT=$(pwd)
+
+# Loop through each package.json file
+for PACKAGE in $PACKAGE_ROOTS; do
+  # Get the directory containing the package.json file
+  PACKAGE_DIR=$(dirname "$PACKAGE")
+  
+  # Change to the package directory
+  cd "$PACKAGE_DIR" || exit
+  
+  # Run yarn
+  echo "Running `rm -rf node_modules` in $PACKAGE_DIR"
+  rm -rf node_modules/
+  
+  # Return to the project root directory
+  cd "$PROJECT_ROOT" || exit
+done

package/scaffolding/root/recover-yarn.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+set -e
+
+# Ensure NVM is loaded and the correct Node version is active
+if [ -s "/usr/local/share/nvm/nvm.sh" ]; then
+  echo "=== DEBUG: Sourcing NVM from /usr/local/share/nvm/nvm.sh"
+  . /usr/local/share/nvm/nvm.sh
+elif [ -s "$HOME/.nvm/nvm.sh" ]; then
+  echo "=== DEBUG: Sourcing NVM from $HOME/.nvm/nvm.sh"
+  . "$HOME/.nvm/nvm.sh"
+fi
+# Only run nvm use if .nvmrc exists, otherwise skip and continue
+if [ -f ".nvmrc" ]; then
+  nvm use
+fi
+
+# Set the desired Yarn version (default to 4.9.2 if not set)
+DEFAULT_YARN_VERSION=${DEFAULT_YARN_VERSION:-4.9.2}
+
+echo "Clearing .yarnrc, .yarnrc.yml, and .yarn"
+rm -rf .yarnrc .yarnrc.yml .yarn
+
+echo "Enabling corepack"
+corepack enable
+
+echo "Preparing yarn@${DEFAULT_YARN_VERSION} for immediate activation..."
+corepack prepare yarn@${DEFAULT_YARN_VERSION} --activate
+
+echo "Setting yarn version to ${DEFAULT_YARN_VERSION}"
+corepack yarn set version ${DEFAULT_YARN_VERSION}
+
+echo "Yarn version after setup:"
+corepack yarn --version
+
+echo "=== DEBUG: which yarn: $(which yarn)"
+echo "=== DEBUG: yarn --version: $(yarn --version)"
+echo "=== DEBUG: corepack yarn version: $(corepack yarn --version 2>&1 || echo 'corepack yarn not available')"

package/scaffolding/root/reset.sh.mustache

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+SKIP_INSTALL=0
+if [ "$1" == "--skip-install" ]; then
+  SKIP_INSTALL=1
+fi
+
+# change directories into the script directory
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+cd "$SCRIPT_DIR"
+echo "Resetting the NX project"
+npx nx reset
+echo "Removing dist and node_modules directories"
+rm -rf dist node_modules ./{{prefix}}-lib/node_modules ./{{prefix}}-api/node_modules ./{{prefix}}-react/node_modules ./{{prefix}}-api-lib/node_modules ./{{prefix}}-test-utils/node_modules ./tools/node_modules
+rm -rf yarn.lock ./{{prefix}}-lib/yarn.lock ./{{prefix}}-api/yarn.lock ./{{prefix}}-react/yarn.lock
+
+echo "Doing yarn cache clean"
+./do-yarn.sh cache clean
+
+if [ $SKIP_INSTALL -eq 0 ]; then
+  echo "Doing yarn install"
+  ./do-yarn.sh install
+else
+  echo "Skipping yarn install"
+fi

package/scaffolding/root/setup-nvm.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
+
+if [ -d "$HOME/.nvm" ]; then
+  export NVM_DIR="$HOME/.nvm"
+elif [ -d "/usr/local/share/nvm" ]; then
+  export NVM_DIR="/usr/local/share/nvm"
+fi
+if [ -n "$NVM_DIR" ]; then
+  [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
+  [ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion
+  sudo chmod -R 755 "${NVM_DIR}"
+fi
+
+nvm install ${DEFAULT_NVM_VERSION} && nvm use ${DEFAULT_NVM_VERSION}