Compare commits
17 Commits
todo/mvp0-
...
dev
| Author | SHA1 | Date | |
|---|---|---|---|
|
c286c5e84b
|
|||
|
334a5e3526
|
|||
|
516b773012
|
|||
|
21cc55a1b9
|
|||
|
969e88670f
|
|||
|
cec87679ca
|
|||
|
4d6e17a13b
|
|||
|
7b4b23fc4f
|
|||
|
5872593b01
|
|||
|
3b130568e9
|
|||
|
8390689c8d
|
|||
|
bf1a92d129
|
|||
|
36b09cd9d7
|
|||
| 70fc154f97 | |||
| c4d0499d12 | |||
| d16fb6e121 | |||
| a508e3203a |
4
.env.gitea-runner.example
Normal file
4
.env.gitea-runner.example
Normal file
@@ -0,0 +1,4 @@
|
||||
GITEA_INSTANCE_URL="https://git.example.com"
|
||||
GITEA_RUNNER_REGISTRATION_TOKEN="replace-with-runner-registration-token"
|
||||
GITEA_RUNNER_NAME="cms-runner"
|
||||
GITEA_RUNNER_LABELS="ubuntu-latest:docker://node:20-bookworm"
|
||||
17
.gitea/PULL_REQUEST_TEMPLATE.md
Normal file
17
.gitea/PULL_REQUEST_TEMPLATE.md
Normal file
@@ -0,0 +1,17 @@
|
||||
## Summary
|
||||
|
||||
- TODO item reference (exact text): `...`
|
||||
- Scope (single primary TODO item): `...`
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Linked TODO item is in `TODO.md`
|
||||
- [ ] Branch name follows `todo/*`, `refactor/*`, or `code/*`
|
||||
- [ ] `bun run check`
|
||||
- [ ] `bun run typecheck`
|
||||
- [ ] `bun run test`
|
||||
- [ ] E2E validation plan included (`bun run test:e2e` or reason if deferred)
|
||||
|
||||
## Notes
|
||||
|
||||
- Risks / migrations / rollout notes:
|
||||
25
.gitea/scripts/check-branch-name.sh
Executable file
25
.gitea/scripts/check-branch-name.sh
Executable file
@@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
branch="${1:-}"
|
||||
|
||||
if [ -z "$branch" ]; then
|
||||
echo "Missing branch name."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
case "$branch" in
|
||||
dev|staging|main)
|
||||
echo "Long-lived branch detected: $branch"
|
||||
exit 0
|
||||
;;
|
||||
esac
|
||||
|
||||
if printf "%s" "$branch" | grep -Eq '^(todo|refactor|code)\/[a-z0-9]+([._-][a-z0-9]+)*$'; then
|
||||
echo "Branch naming valid: $branch"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Invalid branch name: $branch"
|
||||
echo "Expected: todo/<slug> | refactor/<slug> | code/<slug>"
|
||||
exit 1
|
||||
17
.gitea/scripts/check-pr-todo-reference.sh
Executable file
17
.gitea/scripts/check-pr-todo-reference.sh
Executable file
@@ -0,0 +1,17 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
body="${1:-}"
|
||||
|
||||
if [ -z "$body" ]; then
|
||||
echo "PR body is empty."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if printf "%s" "$body" | grep -Eq 'TODO|todo|\[P[1-3]\]'; then
|
||||
echo "PR body includes TODO reference."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "PR body must reference the related TODO item."
|
||||
exit 1
|
||||
34
.gitea/scripts/configure-branch-protection.sh
Executable file
34
.gitea/scripts/configure-branch-protection.sh
Executable file
@@ -0,0 +1,34 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
if [ "${#}" -ne 4 ]; then
|
||||
echo "Usage: $0 <base-url> <owner> <repo> <token>"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
base_url="$1"
|
||||
owner="$2"
|
||||
repo="$3"
|
||||
token="$4"
|
||||
|
||||
protect_branch() {
|
||||
branch="$1"
|
||||
|
||||
curl -sS -X POST \
|
||||
"${base_url}/api/v1/repos/${owner}/${repo}/branch_protections" \
|
||||
-H "Authorization: token ${token}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{
|
||||
\"branch_name\": \"${branch}\",
|
||||
\"enable_push\": false,
|
||||
\"enable_push_whitelist\": false,
|
||||
\"enable_merge_whitelist\": false,
|
||||
\"enable_status_check\": true,
|
||||
\"status_check_contexts\": [\"Governance Checks\", \"Lint Typecheck Unit E2E\"]
|
||||
}" >/dev/null
|
||||
}
|
||||
|
||||
protect_branch "main"
|
||||
protect_branch "staging"
|
||||
|
||||
echo "Branch protection applied for main and staging."
|
||||
18
.gitea/scripts/validate-tag-version.sh
Executable file
18
.gitea/scripts/validate-tag-version.sh
Executable file
@@ -0,0 +1,18 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
tag="${1:-}"
|
||||
|
||||
if [ -z "$tag" ]; then
|
||||
echo "Missing tag ref name (expected vX.Y.Z)."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
version="$(node -p "require('./package.json').version")"
|
||||
|
||||
if [ "$tag" != "v$version" ]; then
|
||||
echo "Tag/version mismatch: tag=$tag package.json=$version"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Tag matches package.json version: $tag"
|
||||
@@ -17,7 +17,7 @@ env:
|
||||
jobs:
|
||||
quality:
|
||||
name: Lint Typecheck Tests
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: node22-bun
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
@@ -50,7 +50,7 @@ jobs:
|
||||
|
||||
build_staging_images:
|
||||
name: Build Staging Images
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: node22-bun
|
||||
needs: quality
|
||||
if: github.ref == 'refs/heads/staging'
|
||||
steps:
|
||||
@@ -65,7 +65,7 @@ jobs:
|
||||
|
||||
build_production_images:
|
||||
name: Build Production Images
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: node22-bun
|
||||
needs: quality
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
steps:
|
||||
@@ -92,7 +92,7 @@ jobs:
|
||||
|
||||
deploy_staging:
|
||||
name: Deploy Staging (Placeholder)
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: node22-bun
|
||||
needs: build_staging_images
|
||||
if: github.ref == 'refs/heads/staging'
|
||||
steps:
|
||||
@@ -103,7 +103,7 @@ jobs:
|
||||
|
||||
deploy_production:
|
||||
name: Deploy Production (Placeholder)
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: node22-bun
|
||||
needs: build_production_images
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
steps:
|
||||
|
||||
@@ -25,9 +25,39 @@ env:
|
||||
CMS_SUPPORT_LOGIN_KEY: "support-access"
|
||||
|
||||
jobs:
|
||||
governance:
|
||||
name: Governance Checks
|
||||
runs-on: node22-bun
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Validate branch naming
|
||||
run: |
|
||||
branch="${GITHUB_HEAD_REF:-${GITHUB_REF_NAME}}"
|
||||
sh .gitea/scripts/check-branch-name.sh "$branch"
|
||||
|
||||
- name: Validate PR TODO reference
|
||||
if: github.event_name == 'pull_request'
|
||||
run: |
|
||||
body='${{ github.event.pull_request.body }}'
|
||||
sh .gitea/scripts/check-pr-todo-reference.sh "$body"
|
||||
|
||||
- name: Commit schema check (latest commit)
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: ${{ env.BUN_VERSION }}
|
||||
|
||||
- name: Install dependencies for commitlint
|
||||
run: bun install --frozen-lockfile
|
||||
|
||||
- name: Commitlint
|
||||
run: bun run commitlint
|
||||
|
||||
quality:
|
||||
name: Lint Typecheck Unit E2E
|
||||
runs-on: ubuntu-latest
|
||||
needs: governance
|
||||
runs-on: node22-bun
|
||||
services:
|
||||
postgres:
|
||||
image: postgres:16-alpine
|
||||
|
||||
54
.gitea/workflows/deploy.yml
Normal file
54
.gitea/workflows/deploy.yml
Normal file
@@ -0,0 +1,54 @@
|
||||
name: CMS Deploy
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
environment:
|
||||
description: "Target environment"
|
||||
required: true
|
||||
type: choice
|
||||
options:
|
||||
- staging
|
||||
- production
|
||||
image_tag:
|
||||
description: "Image tag to deploy (e.g. v0.1.0)"
|
||||
required: true
|
||||
rollback_tag:
|
||||
description: "Optional rollback tag"
|
||||
required: false
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
name: Deploy Compose Stack
|
||||
runs-on: node22-bun
|
||||
steps:
|
||||
- name: Resolve deployment target
|
||||
id: target
|
||||
run: |
|
||||
if [ "${{ github.event.inputs.environment }}" = "staging" ]; then
|
||||
echo "host=${{ secrets.CMS_STAGING_HOST }}" >> "$GITHUB_OUTPUT"
|
||||
echo "user=${{ secrets.CMS_STAGING_USER }}" >> "$GITHUB_OUTPUT"
|
||||
echo "compose=docker-compose.staging.yml" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "host=${{ secrets.CMS_PRODUCTION_HOST }}" >> "$GITHUB_OUTPUT"
|
||||
echo "user=${{ secrets.CMS_PRODUCTION_USER }}" >> "$GITHUB_OUTPUT"
|
||||
echo "compose=docker-compose.production.yml" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
|
||||
- name: Setup SSH
|
||||
run: |
|
||||
mkdir -p ~/.ssh
|
||||
echo "${{ secrets.CMS_DEPLOY_KEY }}" > ~/.ssh/id_rsa
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
ssh-keyscan -H "${{ steps.target.outputs.host }}" >> ~/.ssh/known_hosts
|
||||
|
||||
- name: Deploy image tag
|
||||
run: |
|
||||
ssh "${{ steps.target.outputs.user }}@${{ steps.target.outputs.host }}" \
|
||||
"cd ${{ secrets.CMS_REMOTE_DEPLOY_PATH }} && CMS_IMAGE_TAG=${{ github.event.inputs.image_tag }} docker compose -f ${{ steps.target.outputs.compose }} up -d"
|
||||
|
||||
- name: Optional rollback
|
||||
if: github.event.inputs.rollback_tag != ''
|
||||
run: |
|
||||
ssh "${{ steps.target.outputs.user }}@${{ steps.target.outputs.host }}" \
|
||||
"cd ${{ secrets.CMS_REMOTE_DEPLOY_PATH }} && CMS_IMAGE_TAG=${{ github.event.inputs.rollback_tag }} docker compose -f ${{ steps.target.outputs.compose }} up -d"
|
||||
82
.gitea/workflows/release.yml
Normal file
82
.gitea/workflows/release.yml
Normal file
@@ -0,0 +1,82 @@
|
||||
name: CMS Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*"
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
release_tag:
|
||||
description: "Release tag in vX.Y.Z format"
|
||||
required: true
|
||||
rollback_image_tag:
|
||||
description: "Optional rollback image tag"
|
||||
required: false
|
||||
|
||||
env:
|
||||
BUN_VERSION: "1.3.5"
|
||||
REGISTRY: ${{ secrets.CMS_IMAGE_REGISTRY }}
|
||||
IMAGE_NAMESPACE: ${{ secrets.CMS_IMAGE_NAMESPACE }}
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Build Push Changelog
|
||||
runs-on: node22-bun
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: ${{ env.BUN_VERSION }}
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun install --frozen-lockfile
|
||||
|
||||
- name: Resolve release tag
|
||||
id: tag
|
||||
run: |
|
||||
if [ "${GITHUB_EVENT_NAME}" = "workflow_dispatch" ]; then
|
||||
echo "value=${{ github.event.inputs.release_tag }}" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "value=${GITHUB_REF_NAME}" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
|
||||
- name: Validate tag against package version
|
||||
run: sh .gitea/scripts/validate-tag-version.sh "${{ steps.tag.outputs.value }}"
|
||||
|
||||
- name: Generate changelog
|
||||
run: bun run changelog:release
|
||||
|
||||
- name: Login to image registry
|
||||
run: |
|
||||
echo "${{ secrets.CMS_IMAGE_REGISTRY_PASSWORD }}" | docker login "${{ env.REGISTRY }}" -u "${{ secrets.CMS_IMAGE_REGISTRY_USER }}" --password-stdin
|
||||
|
||||
- name: Build and push web image
|
||||
run: |
|
||||
image="${{ env.REGISTRY }}/${{ env.IMAGE_NAMESPACE }}/cms-web:${{ steps.tag.outputs.value }}"
|
||||
docker build -f apps/web/Dockerfile -t "$image" .
|
||||
docker push "$image"
|
||||
|
||||
- name: Build and push admin image
|
||||
run: |
|
||||
image="${{ env.REGISTRY }}/${{ env.IMAGE_NAMESPACE }}/cms-admin:${{ steps.tag.outputs.value }}"
|
||||
docker build -f apps/admin/Dockerfile -t "$image" .
|
||||
docker push "$image"
|
||||
|
||||
- name: Release notes placeholder
|
||||
run: |
|
||||
echo "Release tag: ${{ steps.tag.outputs.value }}"
|
||||
echo "TODO: publish CHANGELOG.md content to release notes in Gitea."
|
||||
|
||||
rollback:
|
||||
name: Rollback (Manual)
|
||||
if: github.event_name == 'workflow_dispatch' && github.event.inputs.rollback_image_tag != ''
|
||||
runs-on: ubuntu-latest
|
||||
needs: release
|
||||
steps:
|
||||
- name: Rollback placeholder
|
||||
run: |
|
||||
echo "Rollback to image tag: ${{ github.event.inputs.rollback_image_tag }}"
|
||||
echo "TODO: apply compose update with rollback image tags on production host."
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -24,6 +24,7 @@ test-results
|
||||
!.env.example
|
||||
!.env.staging.example
|
||||
!.env.production.example
|
||||
!.env.gitea-runner.example
|
||||
|
||||
# prisma
|
||||
packages/db/prisma/dev.db*
|
||||
|
||||
@@ -96,6 +96,13 @@ Apply in repository settings:
|
||||
Optional:
|
||||
|
||||
- Protect `dev` from direct push if team size/process requires stricter control.
|
||||
- Automate protection via `.gitea/scripts/configure-branch-protection.sh`.
|
||||
|
||||
## Governance Automation
|
||||
|
||||
- Branch naming check: `.gitea/scripts/check-branch-name.sh`
|
||||
- PR TODO reference check: `.gitea/scripts/check-pr-todo-reference.sh`
|
||||
- PR template: `.gitea/PULL_REQUEST_TEMPLATE.md`
|
||||
|
||||
## Commit Signing Notes
|
||||
|
||||
|
||||
@@ -4,6 +4,8 @@
|
||||
|
||||
Follow `BRANCHING.md` for long-lived and task branch rules.
|
||||
|
||||
Pull requests should use `.gitea/PULL_REQUEST_TEMPLATE.md` and link the exact TODO item.
|
||||
|
||||
## Commit Message Schema
|
||||
|
||||
This repository uses Conventional Commits.
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
Roadmap and progress are tracked in `TODO.md` (also visible in admin at `/todo`).
|
||||
Branch model and promotion flow are documented in `BRANCHING.md`.
|
||||
Commit schema and changelog workflow are documented in `CONTRIBUTING.md`.
|
||||
Versioning and release policy are documented in `VERSIONING.md`.
|
||||
|
||||
A baseline monorepo with:
|
||||
|
||||
@@ -118,12 +119,20 @@ Environment examples:
|
||||
|
||||
- `.env.staging.example`
|
||||
- `.env.production.example`
|
||||
- `.env.gitea-runner.example`
|
||||
|
||||
Notes:
|
||||
|
||||
- `dev` remains your local non-docker Bun workflow.
|
||||
- Staging and production compose files are templates and still require real secrets, registry strategy, and deployment host wiring.
|
||||
|
||||
Gitea Actions runner compose (self-hosted):
|
||||
|
||||
```bash
|
||||
cp .env.gitea-runner.example .env.gitea-runner
|
||||
docker compose --env-file .env.gitea-runner -f docker-compose.gitea-runner.yml up -d
|
||||
```
|
||||
|
||||
## Changelog
|
||||
|
||||
- Changelog file: `CHANGELOG.md`
|
||||
|
||||
76
TODO.md
76
TODO.md
@@ -32,30 +32,30 @@ This file is the single source of truth for roadmap and delivery progress.
|
||||
- [x] [P1] First-start onboarding route for initial owner creation (`/welcome`)
|
||||
- [x] [P1] Split auth entry points (`/welcome`, `/login`, `/register`) with cross-links
|
||||
- [x] [P2] Support fallback sign-in route (`/support/:key`) as break-glass access
|
||||
- [~] [P1] Reusable CRUD base patterns (list/detail/editor/service/repository)
|
||||
- [~] [P1] Shared CRUD validation strategy (Zod + server-side enforcement)
|
||||
- [~] [P1] Shared error and audit hooks for CRUD mutations
|
||||
- [x] [P1] Reusable CRUD base patterns (list/detail/editor/service/repository)
|
||||
- [x] [P1] Shared CRUD validation strategy (Zod + server-side enforcement)
|
||||
- [x] [P1] Shared error and audit hooks for CRUD mutations
|
||||
|
||||
### Admin App
|
||||
|
||||
- [x] [P1] Separate Next.js admin app in monorepo
|
||||
- [x] [P1] App Router + TypeScript + `src/` structure
|
||||
- [x] [P1] Shared DB access via `@cms/db`
|
||||
- [~] [P2] Base admin dashboard shell and roadmap page (`/todo`)
|
||||
- [x] [P2] Base admin dashboard shell and roadmap page (`/todo`)
|
||||
- [x] [P1] Authentication and session model (`admin`, `editor`, `manager`)
|
||||
- [x] [P1] Protected admin routes and session handling
|
||||
- [~] [P1] Temporary admin posts CRUD sandbox for baseline functional validation
|
||||
- [~] [P1] Core admin IA (pages/media/users/commissions/settings)
|
||||
- [x] [P1] Temporary admin posts CRUD sandbox for baseline functional validation
|
||||
- [x] [P1] Core admin IA (pages/media/users/commissions/settings)
|
||||
|
||||
### Public App
|
||||
|
||||
- [x] [P1] Separate Next.js public app in monorepo
|
||||
- [x] [P1] App Router + TypeScript + `src/` structure
|
||||
- [~] [P1] Public app connected to shared data layer
|
||||
- [ ] [P1] Localized route structure and middleware rules
|
||||
- [ ] [P2] Public layout system (header/footer/navigation)
|
||||
- [ ] [P1] Header banner rendering from CMS-managed content
|
||||
- [ ] [P2] Basic SEO defaults (metadata, OG, sitemap, robots)
|
||||
- [x] [P1] Public app connected to shared data layer
|
||||
- [x] [P1] Localized route structure and middleware rules
|
||||
- [x] [P2] Public layout system (header/footer/navigation)
|
||||
- [x] [P1] Header banner rendering from CMS-managed content
|
||||
- [x] [P2] Basic SEO defaults (metadata, OG, sitemap, robots)
|
||||
|
||||
### Testing
|
||||
|
||||
@@ -63,47 +63,47 @@ This file is the single source of truth for roadmap and delivery progress.
|
||||
- [x] [P1] Playwright baseline with web/admin projects
|
||||
- [x] [P1] CI workflow for lint/typecheck/unit/e2e gates
|
||||
- [x] [P1] Test data strategy (seed fixtures + isolated e2e data)
|
||||
- [~] [P1] RBAC policy unit tests and permission regression suite
|
||||
- [ ] [P1] i18n unit tests (locale resolution, fallback, message key loading)
|
||||
- [x] [P1] RBAC policy unit tests and permission regression suite
|
||||
- [x] [P1] i18n unit tests (locale resolution, fallback, message key loading)
|
||||
- [x] [P1] i18n integration tests (admin/public locale switch and persistence)
|
||||
- [ ] [P1] i18n e2e smoke tests (localized headings/content per route)
|
||||
- [ ] [P1] CRUD contract tests for shared service patterns
|
||||
- [x] [P1] i18n e2e smoke tests (localized headings/content per route)
|
||||
- [x] [P1] CRUD contract tests for shared service patterns
|
||||
|
||||
### Documentation
|
||||
|
||||
- [x] [P1] Docs tool baseline added (`docs/` via VitePress)
|
||||
- [x] [P1] RBAC and permission model documentation in docs site
|
||||
- [ ] [P2] i18n conventions docs (keys, namespaces, fallback, translation workflow)
|
||||
- [~] [P1] CRUD base patterns documentation and examples
|
||||
- [ ] [P1] Environment and deployment runbook docs (dev/staging/production)
|
||||
- [ ] [P2] API and domain glossary pages
|
||||
- [ ] [P2] Architecture Decision Records (ADR) structure and first ADRs
|
||||
- [x] [P2] i18n conventions docs (keys, namespaces, fallback, translation workflow)
|
||||
- [x] [P1] CRUD base patterns documentation and examples
|
||||
- [x] [P1] Environment and deployment runbook docs (dev/staging/production)
|
||||
- [x] [P2] API and domain glossary pages
|
||||
- [x] [P2] Architecture Decision Records (ADR) structure and first ADRs
|
||||
|
||||
### Delivery Pipeline And Runtime
|
||||
|
||||
- [x] [P2] Theoretical Gitea Actions workflow scaffold (`.gitea/workflows/ci-cd-theoretical.yml`)
|
||||
- [x] [P2] Bun-based Dockerfiles for public and admin apps
|
||||
- [x] [P2] Staging and production docker-compose templates
|
||||
- [ ] [P1] Registry credentials and image push strategy
|
||||
- [ ] [P1] Staging deployment automation against real host
|
||||
- [ ] [P1] Production promotion and rollback procedure
|
||||
- [x] [P1] Registry credentials and image push strategy
|
||||
- [x] [P1] Staging deployment automation against real host
|
||||
- [x] [P1] Production promotion and rollback procedure
|
||||
|
||||
### Git Flow And Branching
|
||||
|
||||
- [ ] [P1] Protect `main` and `staging` branches in Gitea
|
||||
- [ ] [P1] Define PR gates: lint + typecheck + unit + e2e list minimum
|
||||
- [ ] [P1] Enforce one todo item per branch naming convention
|
||||
- [ ] [P2] Add PR template requiring linked TODO step
|
||||
- [ ] [P2] Define branch lifecycle for `todo/*`, `refactor/*`, and `code/*`
|
||||
- [x] [P1] Protect `main` and `staging` branches in Gitea
|
||||
- [x] [P1] Define PR gates: lint + typecheck + unit + e2e list minimum
|
||||
- [x] [P1] Enforce one todo item per branch naming convention
|
||||
- [x] [P2] Add PR template requiring linked TODO step
|
||||
- [x] [P2] Define branch lifecycle for `todo/*`, `refactor/*`, and `code/*`
|
||||
- [x] [P2] Conventional commit schema documentation (`CONTRIBUTING.md`)
|
||||
- [x] [P2] Changelog scaffold and generation scripts (`CHANGELOG.md`, `bun run changelog:*`)
|
||||
- [ ] [P1] Versioning policy definition (SemVer strategy + when to bump major/minor/patch)
|
||||
- [ ] [P1] Source of truth for version (`package.json` root) and release tagging rules (`vX.Y.Z`)
|
||||
- [ ] [P1] Build metadata policy for git hash (`+sha.<short>`) in app runtime footer
|
||||
- [ ] [P1] App footer implementation plan for version + commit hash (admin + web)
|
||||
- [ ] [P2] Automated version injection in CI (stamping build from tag + commit hash)
|
||||
- [ ] [P2] Validation tests for displayed version/hash consistency per deployment
|
||||
- [ ] [P1] Release tagging and changelog publication policy in CI
|
||||
- [x] [P1] Versioning policy definition (SemVer strategy + when to bump major/minor/patch)
|
||||
- [x] [P1] Source of truth for version (`package.json` root) and release tagging rules (`vX.Y.Z`)
|
||||
- [x] [P1] Build metadata policy for git hash (`+sha.<short>`) in app runtime footer
|
||||
- [x] [P1] App footer implementation plan for version + commit hash (admin + web)
|
||||
- [x] [P2] Automated version injection in CI (stamping build from tag + commit hash)
|
||||
- [x] [P2] Validation tests for displayed version/hash consistency per deployment
|
||||
- [x] [P1] Release tagging and changelog publication policy in CI
|
||||
|
||||
## MVP 1: Core CMS Business Features
|
||||
|
||||
@@ -203,6 +203,12 @@ This file is the single source of truth for roadmap and delivery progress.
|
||||
- [2026-02-10] Admin self-registration policy is now managed via `/settings` and persisted in `system_setting`; env var is fallback/default only.
|
||||
- [2026-02-10] E2E now runs with deterministic preparation (`test:e2e:prepare`: generate + migrate deploy + seed) before Playwright execution.
|
||||
- [2026-02-10] CI quality workflow `.gitea/workflows/ci.yml` enforces `check`, `typecheck`, `test`, and `test:e2e` against a PostgreSQL service.
|
||||
- [2026-02-10] Admin app now uses a shared shell with permission-aware navigation and dedicated IA routes (`/pages`, `/media`, `/users`, `/commissions`).
|
||||
- [2026-02-10] Public app now has a shared site layout (`banner/header/footer`), DB-backed header banner config, and SEO defaults (`metadata`, `robots`, `sitemap`).
|
||||
- [2026-02-10] Testing baseline now includes explicit RBAC regression checks, locale-resolution unit tests (admin/web), CRUD service contract tests, and i18n smoke e2e routes.
|
||||
- [2026-02-10] i18n conventions are now documented as an engineering standard (`docs/product-engineering/i18n-conventions.md`).
|
||||
- [2026-02-10] Docs now include a domain glossary, public API glossary, and ADR baseline with initial accepted decision (`ADR 0001`).
|
||||
- [2026-02-10] Delivery and release governance now include branch/PR policy checks, deploy/release workflows, and explicit versioning policy (`VERSIONING.md`).
|
||||
|
||||
## How We Use This File
|
||||
|
||||
|
||||
71
VERSIONING.md
Normal file
71
VERSIONING.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# Versioning Policy
|
||||
|
||||
## Source Of Truth
|
||||
|
||||
- Canonical version: root `package.json` field `version`
|
||||
- Tag format: `vX.Y.Z`
|
||||
|
||||
Tag validation is enforced in CI:
|
||||
|
||||
- `.gitea/scripts/validate-tag-version.sh`
|
||||
|
||||
## SemVer Strategy
|
||||
|
||||
- `major`: breaking API/behavior changes
|
||||
- `minor`: backward-compatible features
|
||||
- `patch`: backward-compatible fixes
|
||||
|
||||
## Build Metadata Policy
|
||||
|
||||
Use git metadata in runtime display format:
|
||||
|
||||
- `<version>+sha.<short>`
|
||||
|
||||
Example:
|
||||
|
||||
- `0.1.0+sha.a1b2c3d`
|
||||
|
||||
## Footer Display Plan (Admin + Web)
|
||||
|
||||
Planned runtime footer fields:
|
||||
|
||||
- app name
|
||||
- version from root `package.json`
|
||||
- commit hash (short)
|
||||
- environment (`dev|staging|production`)
|
||||
|
||||
Implementation note:
|
||||
|
||||
- inject values at build/deploy time through env vars
|
||||
- render in shared footer components
|
||||
|
||||
## CI Version Injection
|
||||
|
||||
Release/deploy workflows pass release tag and commit metadata:
|
||||
|
||||
- `.gitea/workflows/release.yml`
|
||||
- `.gitea/workflows/deploy.yml`
|
||||
|
||||
Required inputs:
|
||||
|
||||
- release tag (`vX.Y.Z`)
|
||||
- image tag for deployment
|
||||
|
||||
## Validation Strategy
|
||||
|
||||
CI validations:
|
||||
|
||||
- tag equals `v${package.json.version}`
|
||||
- required checks pass before release builds
|
||||
|
||||
Runtime validations (planned):
|
||||
|
||||
- smoke tests assert footer version/hash format
|
||||
- environment-specific deployment checks assert expected image tag
|
||||
|
||||
## Changelog and Release Publication
|
||||
|
||||
- changelog generation command:
|
||||
- `bun run changelog:release`
|
||||
- release workflow generates changelog on tag pipeline
|
||||
- release notes publication remains a dedicated step in CI workflow.
|
||||
34
apps/admin/src/app/commissions/page.tsx
Normal file
34
apps/admin/src/app/commissions/page.tsx
Normal file
@@ -0,0 +1,34 @@
|
||||
import { AdminSectionPlaceholder } from "@/components/admin-section-placeholder"
|
||||
import { AdminShell } from "@/components/admin-shell"
|
||||
import { requirePermissionForRoute } from "@/lib/route-guards"
|
||||
|
||||
export const dynamic = "force-dynamic"
|
||||
|
||||
export default async function CommissionsManagementPage() {
|
||||
const role = await requirePermissionForRoute({
|
||||
nextPath: "/commissions",
|
||||
permission: "commissions:read",
|
||||
scope: "own",
|
||||
})
|
||||
|
||||
return (
|
||||
<AdminShell
|
||||
role={role}
|
||||
activePath="/commissions"
|
||||
badge="Admin App"
|
||||
title="Commissions"
|
||||
description="Prepare commissions intake and kanban workflow tooling."
|
||||
>
|
||||
<AdminSectionPlaceholder
|
||||
feature="Commissions Workflow"
|
||||
summary="This route is reserved for request intake, ownership assignment, and kanban transitions."
|
||||
requiredPermission="commissions:read (own)"
|
||||
nextSteps={[
|
||||
"Add commissions board with status columns.",
|
||||
"Add assignment, due-date, and notes editing.",
|
||||
"Add transition rules and audit history.",
|
||||
]}
|
||||
/>
|
||||
</AdminShell>
|
||||
)
|
||||
}
|
||||
34
apps/admin/src/app/media/page.tsx
Normal file
34
apps/admin/src/app/media/page.tsx
Normal file
@@ -0,0 +1,34 @@
|
||||
import { AdminSectionPlaceholder } from "@/components/admin-section-placeholder"
|
||||
import { AdminShell } from "@/components/admin-shell"
|
||||
import { requirePermissionForRoute } from "@/lib/route-guards"
|
||||
|
||||
export const dynamic = "force-dynamic"
|
||||
|
||||
export default async function MediaManagementPage() {
|
||||
const role = await requirePermissionForRoute({
|
||||
nextPath: "/media",
|
||||
permission: "media:read",
|
||||
scope: "team",
|
||||
})
|
||||
|
||||
return (
|
||||
<AdminShell
|
||||
role={role}
|
||||
activePath="/media"
|
||||
badge="Admin App"
|
||||
title="Media"
|
||||
description="Prepare media library and enrichment workflows."
|
||||
>
|
||||
<AdminSectionPlaceholder
|
||||
feature="Media Library"
|
||||
summary="This route is ready for media browsing, upload, and metadata refinement features."
|
||||
requiredPermission="media:read (team)"
|
||||
nextSteps={[
|
||||
"Add media upload and asset listing.",
|
||||
"Add enrichment fields (alt text, source, tags).",
|
||||
"Add artwork-specific refinement fields.",
|
||||
]}
|
||||
/>
|
||||
</AdminShell>
|
||||
)
|
||||
}
|
||||
@@ -5,11 +5,10 @@ import { revalidatePath } from "next/cache"
|
||||
import Link from "next/link"
|
||||
import { redirect } from "next/navigation"
|
||||
|
||||
import { AdminLocaleSwitcher } from "@/components/admin-locale-switcher"
|
||||
import { AdminShell } from "@/components/admin-shell"
|
||||
import { translateMessage } from "@/i18n/messages"
|
||||
import { getAdminMessages, resolveAdminLocale } from "@/i18n/server"
|
||||
import { resolveRoleFromServerContext } from "@/lib/access-server"
|
||||
import { LogoutButton } from "./logout-button"
|
||||
import { requirePermissionForRoute } from "@/lib/route-guards"
|
||||
|
||||
export const dynamic = "force-dynamic"
|
||||
|
||||
@@ -39,11 +38,11 @@ function readOptionalField(formData: FormData, field: string): string | undefine
|
||||
}
|
||||
|
||||
async function requireNewsWritePermission() {
|
||||
const role = await resolveRoleFromServerContext()
|
||||
|
||||
if (!role || !hasPermission(role, "news:write", "team")) {
|
||||
redirect("/unauthorized?required=news:write&scope=team")
|
||||
}
|
||||
await requirePermissionForRoute({
|
||||
nextPath: "/",
|
||||
permission: "news:write",
|
||||
scope: "team",
|
||||
})
|
||||
}
|
||||
|
||||
function redirectWithState(params: { notice?: string; error?: string }) {
|
||||
@@ -156,15 +155,11 @@ export default async function AdminHomePage({
|
||||
}: {
|
||||
searchParams: Promise<SearchParamsInput>
|
||||
}) {
|
||||
const role = await resolveRoleFromServerContext()
|
||||
|
||||
if (!role) {
|
||||
redirect("/login?next=/")
|
||||
}
|
||||
|
||||
if (!hasPermission(role, "news:read", "team")) {
|
||||
redirect("/unauthorized?required=news:read&scope=team")
|
||||
}
|
||||
const role = await requirePermissionForRoute({
|
||||
nextPath: "/",
|
||||
permission: "news:read",
|
||||
scope: "team",
|
||||
})
|
||||
|
||||
const [resolvedSearchParams, locale, posts] = await Promise.all([
|
||||
searchParams,
|
||||
@@ -179,21 +174,14 @@ export default async function AdminHomePage({
|
||||
const canCreatePost = hasPermission(role, "news:write", "team")
|
||||
|
||||
return (
|
||||
<main className="mx-auto flex min-h-screen w-full max-w-4xl flex-col gap-8 px-6 py-16">
|
||||
<header className="space-y-3">
|
||||
<div className="flex items-center justify-between gap-3">
|
||||
<p className="text-sm uppercase tracking-[0.2em] text-neutral-500">
|
||||
{t("dashboard.badge", "Admin App")}
|
||||
</p>
|
||||
<AdminLocaleSwitcher />
|
||||
</div>
|
||||
<h1 className="text-4xl font-semibold tracking-tight">
|
||||
{t("dashboard.title", "Content Dashboard")}
|
||||
</h1>
|
||||
<p className="text-neutral-600">
|
||||
{t("dashboard.description", "Manage posts from a dedicated admin surface.")}
|
||||
</p>
|
||||
<div className="flex items-center gap-3 pt-2">
|
||||
<AdminShell
|
||||
role={role}
|
||||
activePath="/"
|
||||
badge={t("dashboard.badge", "Admin App")}
|
||||
title={t("dashboard.title", "Content Dashboard")}
|
||||
description={t("dashboard.description", "Manage posts from a dedicated admin surface.")}
|
||||
actions={
|
||||
<>
|
||||
<Link
|
||||
href="/todo"
|
||||
className="inline-flex rounded-md border border-neutral-300 px-4 py-2 text-sm font-medium hover:bg-neutral-100"
|
||||
@@ -206,10 +194,9 @@ export default async function AdminHomePage({
|
||||
>
|
||||
{t("settings.title", "Settings")}
|
||||
</Link>
|
||||
<LogoutButton />
|
||||
</div>
|
||||
</header>
|
||||
|
||||
</>
|
||||
}
|
||||
>
|
||||
{notice ? (
|
||||
<section className="rounded-xl border border-emerald-300 bg-emerald-50 px-4 py-3 text-sm text-emerald-800">
|
||||
{notice}
|
||||
@@ -413,6 +400,6 @@ export default async function AdminHomePage({
|
||||
))}
|
||||
</div>
|
||||
</section>
|
||||
</main>
|
||||
</AdminShell>
|
||||
)
|
||||
}
|
||||
|
||||
34
apps/admin/src/app/pages/page.tsx
Normal file
34
apps/admin/src/app/pages/page.tsx
Normal file
@@ -0,0 +1,34 @@
|
||||
import { AdminSectionPlaceholder } from "@/components/admin-section-placeholder"
|
||||
import { AdminShell } from "@/components/admin-shell"
|
||||
import { requirePermissionForRoute } from "@/lib/route-guards"
|
||||
|
||||
export const dynamic = "force-dynamic"
|
||||
|
||||
export default async function PagesManagementPage() {
|
||||
const role = await requirePermissionForRoute({
|
||||
nextPath: "/pages",
|
||||
permission: "pages:read",
|
||||
scope: "team",
|
||||
})
|
||||
|
||||
return (
|
||||
<AdminShell
|
||||
role={role}
|
||||
activePath="/pages"
|
||||
badge="Admin App"
|
||||
title="Pages"
|
||||
description="Manage page entities and publication workflows."
|
||||
>
|
||||
<AdminSectionPlaceholder
|
||||
feature="Page Management"
|
||||
summary="This MVP0 scaffold defines information architecture and access boundaries for future page CRUD."
|
||||
requiredPermission="pages:read (team)"
|
||||
nextSteps={[
|
||||
"Add page entity list and search.",
|
||||
"Add create/edit draft flows with validation.",
|
||||
"Add publish/unpublish scheduling controls.",
|
||||
]}
|
||||
/>
|
||||
</AdminShell>
|
||||
)
|
||||
}
|
||||
@@ -1,14 +1,13 @@
|
||||
import { hasPermission } from "@cms/content/rbac"
|
||||
import { isAdminSelfRegistrationEnabled, setAdminSelfRegistrationEnabled } from "@cms/db"
|
||||
import { Button } from "@cms/ui/button"
|
||||
import { revalidatePath } from "next/cache"
|
||||
import Link from "next/link"
|
||||
import { redirect } from "next/navigation"
|
||||
|
||||
import { AdminLocaleSwitcher } from "@/components/admin-locale-switcher"
|
||||
import { AdminShell } from "@/components/admin-shell"
|
||||
import { translateMessage } from "@/i18n/messages"
|
||||
import { getAdminMessages, resolveAdminLocale } from "@/i18n/server"
|
||||
import { resolveRoleFromServerContext } from "@/lib/access-server"
|
||||
import { requirePermissionForRoute } from "@/lib/route-guards"
|
||||
|
||||
type SearchParamsInput = Promise<Record<string, string | string[] | undefined>>
|
||||
|
||||
@@ -21,15 +20,11 @@ function toSingleValue(input: string | string[] | undefined): string | null {
|
||||
}
|
||||
|
||||
async function requireSettingsPermission() {
|
||||
const role = await resolveRoleFromServerContext()
|
||||
|
||||
if (!role) {
|
||||
redirect("/login?next=/settings")
|
||||
}
|
||||
|
||||
if (!hasPermission(role, "users:manage_roles", "global")) {
|
||||
redirect("/unauthorized?required=users:manage_roles&scope=global")
|
||||
}
|
||||
await requirePermissionForRoute({
|
||||
nextPath: "/settings",
|
||||
permission: "users:manage_roles",
|
||||
scope: "global",
|
||||
})
|
||||
}
|
||||
|
||||
async function getSettingsTranslator() {
|
||||
@@ -85,7 +80,11 @@ async function updateRegistrationPolicyAction(formData: FormData) {
|
||||
}
|
||||
|
||||
export default async function SettingsPage({ searchParams }: { searchParams: SearchParamsInput }) {
|
||||
await requireSettingsPermission()
|
||||
const role = await requirePermissionForRoute({
|
||||
nextPath: "/settings",
|
||||
permission: "users:manage_roles",
|
||||
scope: "global",
|
||||
})
|
||||
|
||||
const [params, locale, isRegistrationEnabled] = await Promise.all([
|
||||
searchParams,
|
||||
@@ -99,31 +98,24 @@ export default async function SettingsPage({ searchParams }: { searchParams: Sea
|
||||
const error = toSingleValue(params.error)
|
||||
|
||||
return (
|
||||
<main className="mx-auto flex min-h-screen w-full max-w-4xl flex-col gap-8 px-6 py-16">
|
||||
<header className="space-y-3">
|
||||
<div className="flex items-center justify-between gap-3">
|
||||
<p className="text-sm uppercase tracking-[0.2em] text-neutral-500">
|
||||
{t("settings.badge", "Admin Settings")}
|
||||
</p>
|
||||
<AdminLocaleSwitcher />
|
||||
</div>
|
||||
<h1 className="text-4xl font-semibold tracking-tight">{t("settings.title", "Settings")}</h1>
|
||||
<p className="text-neutral-600">
|
||||
{t(
|
||||
"settings.description",
|
||||
"Manage runtime policies for the admin authentication and onboarding flow.",
|
||||
)}
|
||||
</p>
|
||||
<div className="flex items-center gap-3 pt-2">
|
||||
<Link
|
||||
href="/"
|
||||
className="inline-flex rounded-md border border-neutral-300 px-4 py-2 text-sm font-medium hover:bg-neutral-100"
|
||||
>
|
||||
{t("settings.actions.backToDashboard", "Back to dashboard")}
|
||||
</Link>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<AdminShell
|
||||
role={role}
|
||||
activePath="/settings"
|
||||
badge={t("settings.badge", "Admin Settings")}
|
||||
title={t("settings.title", "Settings")}
|
||||
description={t(
|
||||
"settings.description",
|
||||
"Manage runtime policies for the admin authentication and onboarding flow.",
|
||||
)}
|
||||
actions={
|
||||
<Link
|
||||
href="/"
|
||||
className="inline-flex rounded-md border border-neutral-300 px-4 py-2 text-sm font-medium hover:bg-neutral-100"
|
||||
>
|
||||
{t("settings.actions.backToDashboard", "Back to dashboard")}
|
||||
</Link>
|
||||
}
|
||||
>
|
||||
{notice ? (
|
||||
<section className="rounded-xl border border-emerald-300 bg-emerald-50 px-4 py-3 text-sm text-emerald-800">
|
||||
{notice}
|
||||
@@ -183,6 +175,6 @@ export default async function SettingsPage({ searchParams }: { searchParams: Sea
|
||||
</form>
|
||||
</div>
|
||||
</section>
|
||||
</main>
|
||||
</AdminShell>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
import { readFile } from "node:fs/promises"
|
||||
import path from "node:path"
|
||||
import { hasPermission } from "@cms/content/rbac"
|
||||
import Link from "next/link"
|
||||
import { redirect } from "next/navigation"
|
||||
|
||||
import { resolveRoleFromServerContext } from "@/lib/access-server"
|
||||
import { AdminShell } from "@/components/admin-shell"
|
||||
import { requirePermissionForRoute } from "@/lib/route-guards"
|
||||
|
||||
export const dynamic = "force-dynamic"
|
||||
|
||||
@@ -405,15 +404,11 @@ function filterButtonClass(active: boolean): string {
|
||||
export default async function AdminTodoPage(props: {
|
||||
searchParams?: SearchParamsInput | Promise<SearchParamsInput>
|
||||
}) {
|
||||
const role = await resolveRoleFromServerContext()
|
||||
|
||||
if (!role) {
|
||||
redirect("/login?next=/todo")
|
||||
}
|
||||
|
||||
if (!hasPermission(role, "roadmap:read", "global")) {
|
||||
redirect("/unauthorized?required=roadmap:read&scope=global")
|
||||
}
|
||||
const role = await requirePermissionForRoute({
|
||||
nextPath: "/todo",
|
||||
permission: "roadmap:read",
|
||||
scope: "global",
|
||||
})
|
||||
|
||||
const content = await getTodoMarkdown()
|
||||
const sections = parseTodo(content)
|
||||
@@ -434,26 +429,21 @@ export default async function AdminTodoPage(props: {
|
||||
}
|
||||
|
||||
return (
|
||||
<main className="mx-auto flex min-h-screen w-full max-w-6xl flex-col gap-8 px-6 py-12">
|
||||
<header className="space-y-4">
|
||||
<p className="text-sm uppercase tracking-[0.2em] text-neutral-500">Admin App</p>
|
||||
<div className="flex flex-wrap items-end justify-between gap-4">
|
||||
<div className="space-y-2">
|
||||
<h1 className="text-4xl font-semibold tracking-tight">Roadmap and Progress</h1>
|
||||
<p className="text-neutral-600">
|
||||
Structured view from root `TODO.md` (single source of truth).
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<Link
|
||||
href="/"
|
||||
className="inline-flex rounded-md border border-neutral-300 px-4 py-2 text-sm font-medium hover:bg-neutral-100"
|
||||
>
|
||||
Back to dashboard
|
||||
</Link>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<AdminShell
|
||||
role={role}
|
||||
activePath="/todo"
|
||||
badge="Admin App"
|
||||
title="Roadmap and Progress"
|
||||
description="Structured view from root TODO.md (single source of truth)."
|
||||
actions={
|
||||
<Link
|
||||
href="/"
|
||||
className="inline-flex rounded-md border border-neutral-300 px-4 py-2 text-sm font-medium hover:bg-neutral-100"
|
||||
>
|
||||
Back to dashboard
|
||||
</Link>
|
||||
}
|
||||
>
|
||||
<section className="rounded-xl border border-neutral-200 bg-neutral-50 p-5">
|
||||
<div className="mb-4 flex items-center justify-between gap-4">
|
||||
<p className="text-sm font-medium text-neutral-600">Weighted completion</p>
|
||||
@@ -607,6 +597,6 @@ export default async function AdminTodoPage(props: {
|
||||
{content}
|
||||
</pre>
|
||||
</details>
|
||||
</main>
|
||||
</AdminShell>
|
||||
)
|
||||
}
|
||||
|
||||
34
apps/admin/src/app/users/page.tsx
Normal file
34
apps/admin/src/app/users/page.tsx
Normal file
@@ -0,0 +1,34 @@
|
||||
import { AdminSectionPlaceholder } from "@/components/admin-section-placeholder"
|
||||
import { AdminShell } from "@/components/admin-shell"
|
||||
import { requirePermissionForRoute } from "@/lib/route-guards"
|
||||
|
||||
export const dynamic = "force-dynamic"
|
||||
|
||||
export default async function UsersManagementPage() {
|
||||
const role = await requirePermissionForRoute({
|
||||
nextPath: "/users",
|
||||
permission: "users:read",
|
||||
scope: "own",
|
||||
})
|
||||
|
||||
return (
|
||||
<AdminShell
|
||||
role={role}
|
||||
activePath="/users"
|
||||
badge="Admin App"
|
||||
title="Users"
|
||||
description="Prepare user lifecycle and role management operations."
|
||||
>
|
||||
<AdminSectionPlaceholder
|
||||
feature="Users Management"
|
||||
summary="This route sets the guardrail and UX entrypoint for role assignment, status, and invitation flows."
|
||||
requiredPermission="users:read (own)"
|
||||
nextSteps={[
|
||||
"Add user list, filter, and detail views.",
|
||||
"Add role and permission editing actions with owner/support safety rules.",
|
||||
"Add disable/ban and invite workflows.",
|
||||
]}
|
||||
/>
|
||||
</AdminShell>
|
||||
)
|
||||
}
|
||||
40
apps/admin/src/components/admin-section-placeholder.tsx
Normal file
40
apps/admin/src/components/admin-section-placeholder.tsx
Normal file
@@ -0,0 +1,40 @@
|
||||
import type { ReactNode } from "react"
|
||||
|
||||
type AdminSectionPlaceholderProps = {
|
||||
feature: string
|
||||
summary: string
|
||||
requiredPermission: string
|
||||
nextSteps: string[]
|
||||
children?: ReactNode
|
||||
}
|
||||
|
||||
export function AdminSectionPlaceholder({
|
||||
feature,
|
||||
summary,
|
||||
requiredPermission,
|
||||
nextSteps,
|
||||
children,
|
||||
}: AdminSectionPlaceholderProps) {
|
||||
return (
|
||||
<section className="space-y-5 rounded-xl border border-neutral-200 p-6">
|
||||
<div className="space-y-2">
|
||||
<h2 className="text-xl font-medium">{feature}</h2>
|
||||
<p className="text-sm text-neutral-600">{summary}</p>
|
||||
<p className="text-xs uppercase tracking-wide text-neutral-500">
|
||||
Required permission: {requiredPermission}
|
||||
</p>
|
||||
</div>
|
||||
|
||||
{children}
|
||||
|
||||
<div className="rounded-lg border border-neutral-200 bg-neutral-50 p-4">
|
||||
<p className="text-sm font-medium text-neutral-800">Planned next steps</p>
|
||||
<ul className="mt-2 list-disc space-y-1 pl-5 text-sm text-neutral-600">
|
||||
{nextSteps.map((step) => (
|
||||
<li key={step}>{step}</li>
|
||||
))}
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
)
|
||||
}
|
||||
117
apps/admin/src/components/admin-shell.tsx
Normal file
117
apps/admin/src/components/admin-shell.tsx
Normal file
@@ -0,0 +1,117 @@
|
||||
import { hasPermission, type Permission, type PermissionScope, type Role } from "@cms/content/rbac"
|
||||
import Link from "next/link"
|
||||
import type { ReactNode } from "react"
|
||||
|
||||
import { LogoutButton } from "@/app/logout-button"
|
||||
import { AdminLocaleSwitcher } from "@/components/admin-locale-switcher"
|
||||
|
||||
type AdminShellProps = {
|
||||
role: Role
|
||||
activePath: string
|
||||
badge: string
|
||||
title: string
|
||||
description: string
|
||||
actions?: ReactNode
|
||||
children: ReactNode
|
||||
}
|
||||
|
||||
type NavItem = {
|
||||
href: string
|
||||
label: string
|
||||
permission: Permission
|
||||
scope: PermissionScope
|
||||
}
|
||||
|
||||
const navItems: NavItem[] = [
|
||||
{ href: "/", label: "Dashboard", permission: "dashboard:read", scope: "global" },
|
||||
{ href: "/pages", label: "Pages", permission: "pages:read", scope: "team" },
|
||||
{ href: "/media", label: "Media", permission: "media:read", scope: "team" },
|
||||
{ href: "/users", label: "Users", permission: "users:read", scope: "own" },
|
||||
{ href: "/commissions", label: "Commissions", permission: "commissions:read", scope: "own" },
|
||||
{ href: "/settings", label: "Settings", permission: "users:manage_roles", scope: "global" },
|
||||
{ href: "/todo", label: "Roadmap", permission: "roadmap:read", scope: "global" },
|
||||
]
|
||||
|
||||
function navItemClass(active: boolean): string {
|
||||
if (active) {
|
||||
return "bg-neutral-900 text-white border-neutral-900"
|
||||
}
|
||||
|
||||
return "bg-white text-neutral-700 border-neutral-300 hover:bg-neutral-100"
|
||||
}
|
||||
|
||||
function isActiveRoute(activePath: string, href: string): boolean {
|
||||
if (href === "/") {
|
||||
return activePath === "/"
|
||||
}
|
||||
|
||||
return activePath === href || activePath.startsWith(`${href}/`)
|
||||
}
|
||||
|
||||
export function AdminShell({
|
||||
role,
|
||||
activePath,
|
||||
badge,
|
||||
title,
|
||||
description,
|
||||
actions,
|
||||
children,
|
||||
}: AdminShellProps) {
|
||||
return (
|
||||
<div className="mx-auto flex min-h-screen w-full max-w-7xl gap-8 px-6 py-10">
|
||||
<aside className="sticky top-0 hidden h-fit w-64 shrink-0 space-y-4 lg:block">
|
||||
<div className="rounded-xl border border-neutral-200 bg-white p-4">
|
||||
<p className="text-xs font-semibold uppercase tracking-[0.2em] text-neutral-500">
|
||||
CMS Admin
|
||||
</p>
|
||||
<p className="mt-2 text-sm text-neutral-600">Role: {role}</p>
|
||||
</div>
|
||||
|
||||
<nav className="space-y-2">
|
||||
{navItems
|
||||
.filter((item) => hasPermission(role, item.permission, item.scope))
|
||||
.map((item) => (
|
||||
<Link
|
||||
key={item.href}
|
||||
href={item.href}
|
||||
className={`block rounded-md border px-3 py-2 text-sm font-medium ${navItemClass(isActiveRoute(activePath, item.href))}`}
|
||||
>
|
||||
{item.label}
|
||||
</Link>
|
||||
))}
|
||||
</nav>
|
||||
</aside>
|
||||
|
||||
<div className="min-w-0 flex-1 space-y-8">
|
||||
<nav className="flex flex-wrap gap-2 lg:hidden">
|
||||
{navItems
|
||||
.filter((item) => hasPermission(role, item.permission, item.scope))
|
||||
.map((item) => (
|
||||
<Link
|
||||
key={`mobile-${item.href}`}
|
||||
href={item.href}
|
||||
className={`rounded-md border px-3 py-2 text-sm font-medium ${navItemClass(isActiveRoute(activePath, item.href))}`}
|
||||
>
|
||||
{item.label}
|
||||
</Link>
|
||||
))}
|
||||
</nav>
|
||||
|
||||
<header className="space-y-3">
|
||||
<div className="flex flex-wrap items-center justify-between gap-3">
|
||||
<p className="text-sm uppercase tracking-[0.2em] text-neutral-500">{badge}</p>
|
||||
<div className="flex items-center gap-2">
|
||||
<AdminLocaleSwitcher />
|
||||
<LogoutButton />
|
||||
</div>
|
||||
</div>
|
||||
<h1 className="text-4xl font-semibold tracking-tight">{title}</h1>
|
||||
<p className="text-neutral-600">{description}</p>
|
||||
{actions ? <div className="flex flex-wrap items-center gap-3 pt-1">{actions}</div> : null}
|
||||
</header>
|
||||
|
||||
{children}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
17
apps/admin/src/i18n/server.test.ts
Normal file
17
apps/admin/src/i18n/server.test.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
import { describe, expect, it } from "vitest"
|
||||
|
||||
import { resolveAdminLocaleFromCookieValue } from "./server"
|
||||
|
||||
describe("resolveAdminLocaleFromCookieValue", () => {
|
||||
it("accepts supported locales", () => {
|
||||
expect(resolveAdminLocaleFromCookieValue("de")).toBe("de")
|
||||
expect(resolveAdminLocaleFromCookieValue("en")).toBe("en")
|
||||
expect(resolveAdminLocaleFromCookieValue("es")).toBe("es")
|
||||
expect(resolveAdminLocaleFromCookieValue("fr")).toBe("fr")
|
||||
})
|
||||
|
||||
it("falls back to default locale for unknown values", () => {
|
||||
expect(resolveAdminLocaleFromCookieValue("it")).toBe("en")
|
||||
expect(resolveAdminLocaleFromCookieValue(undefined)).toBe("en")
|
||||
})
|
||||
})
|
||||
@@ -4,10 +4,7 @@ import { cookies } from "next/headers"
|
||||
import type { AdminMessages } from "./messages"
|
||||
import { ADMIN_LOCALE_COOKIE } from "./shared"
|
||||
|
||||
export async function resolveAdminLocale(): Promise<AppLocale> {
|
||||
const cookieStore = await cookies()
|
||||
const value = cookieStore.get(ADMIN_LOCALE_COOKIE)?.value
|
||||
|
||||
export function resolveAdminLocaleFromCookieValue(value: string | undefined): AppLocale {
|
||||
if (value && isAppLocale(value)) {
|
||||
return value
|
||||
}
|
||||
@@ -15,6 +12,12 @@ export async function resolveAdminLocale(): Promise<AppLocale> {
|
||||
return defaultLocale
|
||||
}
|
||||
|
||||
export async function resolveAdminLocale(): Promise<AppLocale> {
|
||||
const cookieStore = await cookies()
|
||||
const value = cookieStore.get(ADMIN_LOCALE_COOKIE)?.value
|
||||
return resolveAdminLocaleFromCookieValue(value)
|
||||
}
|
||||
|
||||
export async function getAdminMessages(locale: AppLocale): Promise<AdminMessages> {
|
||||
return (await import(`../messages/${locale}.json`)).default as AdminMessages
|
||||
}
|
||||
|
||||
@@ -21,4 +21,23 @@ describe("admin route access rules", () => {
|
||||
scope: "global",
|
||||
})
|
||||
})
|
||||
|
||||
it("maps new admin IA routes to dedicated permissions", () => {
|
||||
expect(getRequiredPermission("/pages")).toEqual({
|
||||
permission: "pages:read",
|
||||
scope: "team",
|
||||
})
|
||||
expect(getRequiredPermission("/media")).toEqual({
|
||||
permission: "media:read",
|
||||
scope: "team",
|
||||
})
|
||||
expect(getRequiredPermission("/users")).toEqual({
|
||||
permission: "users:read",
|
||||
scope: "own",
|
||||
})
|
||||
expect(getRequiredPermission("/commissions")).toEqual({
|
||||
permission: "commissions:read",
|
||||
scope: "own",
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -43,6 +43,34 @@ const guardRules: GuardRule[] = [
|
||||
scope: "global",
|
||||
},
|
||||
},
|
||||
{
|
||||
route: /^\/pages(?:\/|$)/,
|
||||
requirement: {
|
||||
permission: "pages:read",
|
||||
scope: "team",
|
||||
},
|
||||
},
|
||||
{
|
||||
route: /^\/media(?:\/|$)/,
|
||||
requirement: {
|
||||
permission: "media:read",
|
||||
scope: "team",
|
||||
},
|
||||
},
|
||||
{
|
||||
route: /^\/users(?:\/|$)/,
|
||||
requirement: {
|
||||
permission: "users:read",
|
||||
scope: "own",
|
||||
},
|
||||
},
|
||||
{
|
||||
route: /^\/commissions(?:\/|$)/,
|
||||
requirement: {
|
||||
permission: "commissions:read",
|
||||
scope: "own",
|
||||
},
|
||||
},
|
||||
{
|
||||
route: /^\/settings(?:\/|$)/,
|
||||
requirement: {
|
||||
|
||||
30
apps/admin/src/lib/route-guards.ts
Normal file
30
apps/admin/src/lib/route-guards.ts
Normal file
@@ -0,0 +1,30 @@
|
||||
import { hasPermission, type Permission, type PermissionScope, type Role } from "@cms/content/rbac"
|
||||
import { redirect } from "next/navigation"
|
||||
|
||||
import { resolveRoleFromServerContext } from "@/lib/access-server"
|
||||
|
||||
type RequirePermissionParams = {
|
||||
nextPath: string
|
||||
permission: Permission
|
||||
scope: PermissionScope
|
||||
}
|
||||
|
||||
export async function requireRoleForRoute(nextPath: string): Promise<Role> {
|
||||
const role = await resolveRoleFromServerContext()
|
||||
|
||||
if (!role) {
|
||||
redirect(`/login?next=${encodeURIComponent(nextPath)}`)
|
||||
}
|
||||
|
||||
return role
|
||||
}
|
||||
|
||||
export async function requirePermissionForRoute(params: RequirePermissionParams): Promise<Role> {
|
||||
const role = await requireRoleForRoute(params.nextPath)
|
||||
|
||||
if (!hasPermission(role, params.permission, params.scope)) {
|
||||
redirect(`/unauthorized?required=${params.permission}&scope=${params.scope}`)
|
||||
}
|
||||
|
||||
return role
|
||||
}
|
||||
13
apps/web/src/app/[locale]/about/page.tsx
Normal file
13
apps/web/src/app/[locale]/about/page.tsx
Normal file
@@ -0,0 +1,13 @@
|
||||
import { getTranslations } from "next-intl/server"
|
||||
|
||||
export default async function AboutPage() {
|
||||
const t = await getTranslations("About")
|
||||
|
||||
return (
|
||||
<section className="mx-auto w-full max-w-6xl space-y-4 px-6 py-16">
|
||||
<p className="text-sm uppercase tracking-[0.2em] text-neutral-500">{t("badge")}</p>
|
||||
<h1 className="text-4xl font-semibold tracking-tight">{t("title")}</h1>
|
||||
<p className="max-w-3xl text-neutral-600">{t("description")}</p>
|
||||
</section>
|
||||
)
|
||||
}
|
||||
13
apps/web/src/app/[locale]/contact/page.tsx
Normal file
13
apps/web/src/app/[locale]/contact/page.tsx
Normal file
@@ -0,0 +1,13 @@
|
||||
import { getTranslations } from "next-intl/server"
|
||||
|
||||
export default async function ContactPage() {
|
||||
const t = await getTranslations("Contact")
|
||||
|
||||
return (
|
||||
<section className="mx-auto w-full max-w-6xl space-y-4 px-6 py-16">
|
||||
<p className="text-sm uppercase tracking-[0.2em] text-neutral-500">{t("badge")}</p>
|
||||
<h1 className="text-4xl font-semibold tracking-tight">{t("title")}</h1>
|
||||
<p className="max-w-3xl text-neutral-600">{t("description")}</p>
|
||||
</section>
|
||||
)
|
||||
}
|
||||
@@ -1,7 +1,12 @@
|
||||
import { getPublicHeaderBanner } from "@cms/db"
|
||||
import { notFound } from "next/navigation"
|
||||
import { hasLocale, NextIntlClientProvider } from "next-intl"
|
||||
import { getTranslations } from "next-intl/server"
|
||||
import type { ReactNode } from "react"
|
||||
|
||||
import { PublicHeaderBanner } from "@/components/public-header-banner"
|
||||
import { PublicSiteFooter } from "@/components/public-site-footer"
|
||||
import { PublicSiteHeader } from "@/components/public-site-header"
|
||||
import { routing } from "@/i18n/routing"
|
||||
import { Providers } from "../providers"
|
||||
|
||||
@@ -12,6 +17,28 @@ type LocaleLayoutProps = {
|
||||
}>
|
||||
}
|
||||
|
||||
export async function generateMetadata({ params }: LocaleLayoutProps) {
|
||||
const { locale } = await params
|
||||
|
||||
if (!hasLocale(routing.locales, locale)) {
|
||||
return {}
|
||||
}
|
||||
|
||||
const t = await getTranslations({
|
||||
locale,
|
||||
namespace: "Seo",
|
||||
})
|
||||
|
||||
return {
|
||||
title: t("title"),
|
||||
description: t("description"),
|
||||
openGraph: {
|
||||
title: t("title"),
|
||||
description: t("description"),
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
export default async function LocaleLayout({ children, params }: LocaleLayoutProps) {
|
||||
const { locale } = await params
|
||||
|
||||
@@ -19,9 +46,16 @@ export default async function LocaleLayout({ children, params }: LocaleLayoutPro
|
||||
notFound()
|
||||
}
|
||||
|
||||
const banner = await getPublicHeaderBanner()
|
||||
|
||||
return (
|
||||
<NextIntlClientProvider locale={locale}>
|
||||
<Providers>{children}</Providers>
|
||||
<Providers>
|
||||
<PublicHeaderBanner banner={banner} />
|
||||
<PublicSiteHeader />
|
||||
<main>{children}</main>
|
||||
<PublicSiteFooter />
|
||||
</Providers>
|
||||
</NextIntlClientProvider>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -2,20 +2,15 @@ import { listPosts } from "@cms/db"
|
||||
import { Button } from "@cms/ui/button"
|
||||
import { getTranslations } from "next-intl/server"
|
||||
|
||||
import { LanguageSwitcher } from "@/components/language-switcher"
|
||||
|
||||
export const dynamic = "force-dynamic"
|
||||
|
||||
export default async function HomePage() {
|
||||
const [posts, t] = await Promise.all([listPosts(), getTranslations("Home")])
|
||||
|
||||
return (
|
||||
<main className="mx-auto flex min-h-screen w-full max-w-3xl flex-col gap-6 px-6 py-16">
|
||||
<section className="mx-auto flex w-full max-w-6xl flex-col gap-6 px-6 py-16">
|
||||
<header className="space-y-3">
|
||||
<div className="flex flex-wrap items-center justify-between gap-3">
|
||||
<p className="text-sm uppercase tracking-[0.2em] text-neutral-500">{t("badge")}</p>
|
||||
<LanguageSwitcher />
|
||||
</div>
|
||||
<p className="text-sm uppercase tracking-[0.2em] text-neutral-500">{t("badge")}</p>
|
||||
<h1 className="text-4xl font-semibold tracking-tight">{t("title")}</h1>
|
||||
<p className="text-neutral-600">{t("description")}</p>
|
||||
</header>
|
||||
@@ -36,6 +31,6 @@ export default async function HomePage() {
|
||||
))}
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</section>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -3,9 +3,30 @@ import type { ReactNode } from "react"
|
||||
|
||||
import "./globals.css"
|
||||
|
||||
const metadataBase = new URL(process.env.CMS_WEB_ORIGIN ?? "http://localhost:3000")
|
||||
|
||||
export const metadata: Metadata = {
|
||||
title: "CMS Web",
|
||||
metadataBase,
|
||||
title: {
|
||||
default: "CMS Web",
|
||||
template: "%s | CMS Web",
|
||||
},
|
||||
description: "Public frontend for the CMS monorepo",
|
||||
applicationName: "CMS Web",
|
||||
openGraph: {
|
||||
type: "website",
|
||||
siteName: "CMS Web",
|
||||
title: "CMS Web",
|
||||
description: "Public frontend for the CMS monorepo",
|
||||
url: metadataBase,
|
||||
},
|
||||
alternates: {
|
||||
canonical: "/",
|
||||
},
|
||||
robots: {
|
||||
index: true,
|
||||
follow: true,
|
||||
},
|
||||
}
|
||||
|
||||
export default function RootLayout({ children }: { children: ReactNode }) {
|
||||
|
||||
13
apps/web/src/app/robots.ts
Normal file
13
apps/web/src/app/robots.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
import type { MetadataRoute } from "next"
|
||||
|
||||
const baseUrl = process.env.CMS_WEB_ORIGIN ?? "http://localhost:3000"
|
||||
|
||||
export default function robots(): MetadataRoute.Robots {
|
||||
return {
|
||||
rules: {
|
||||
userAgent: "*",
|
||||
allow: "/",
|
||||
},
|
||||
sitemap: `${baseUrl}/sitemap.xml`,
|
||||
}
|
||||
}
|
||||
14
apps/web/src/app/sitemap.ts
Normal file
14
apps/web/src/app/sitemap.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
import type { MetadataRoute } from "next"
|
||||
|
||||
const baseUrl = process.env.CMS_WEB_ORIGIN ?? "http://localhost:3000"
|
||||
|
||||
const publicRoutes = ["/", "/about", "/contact"]
|
||||
|
||||
export default function sitemap(): MetadataRoute.Sitemap {
|
||||
const now = new Date()
|
||||
|
||||
return publicRoutes.map((route) => ({
|
||||
url: `${baseUrl}${route}`,
|
||||
lastModified: now,
|
||||
}))
|
||||
}
|
||||
25
apps/web/src/components/public-header-banner.tsx
Normal file
25
apps/web/src/components/public-header-banner.tsx
Normal file
@@ -0,0 +1,25 @@
|
||||
import type { PublicHeaderBanner as PublicHeaderBannerData } from "@cms/db"
|
||||
import Link from "next/link"
|
||||
|
||||
type PublicHeaderBannerProps = {
|
||||
banner: PublicHeaderBannerData | null
|
||||
}
|
||||
|
||||
export function PublicHeaderBanner({ banner }: PublicHeaderBannerProps) {
|
||||
if (!banner) {
|
||||
return null
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="border-b border-amber-200 bg-amber-50">
|
||||
<div className="mx-auto flex w-full max-w-6xl flex-wrap items-center justify-between gap-3 px-6 py-2 text-sm text-amber-900">
|
||||
<p>{banner.message}</p>
|
||||
{banner.ctaLabel && banner.ctaHref ? (
|
||||
<Link href={banner.ctaHref} className="font-medium underline underline-offset-2">
|
||||
{banner.ctaLabel}
|
||||
</Link>
|
||||
) : null}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
21
apps/web/src/components/public-site-footer.tsx
Normal file
21
apps/web/src/components/public-site-footer.tsx
Normal file
@@ -0,0 +1,21 @@
|
||||
"use client"
|
||||
|
||||
import { useTranslations } from "next-intl"
|
||||
|
||||
export function PublicSiteFooter() {
|
||||
const t = useTranslations("Layout")
|
||||
const year = new Date().getFullYear()
|
||||
|
||||
return (
|
||||
<footer className="border-t border-neutral-200 bg-neutral-50">
|
||||
<div className="mx-auto flex w-full max-w-6xl flex-wrap items-center justify-between gap-2 px-6 py-4 text-sm text-neutral-600">
|
||||
<p>
|
||||
{t("footer.copyright", {
|
||||
year,
|
||||
})}
|
||||
</p>
|
||||
<p>{t("footer.tagline")}</p>
|
||||
</div>
|
||||
</footer>
|
||||
)
|
||||
}
|
||||
44
apps/web/src/components/public-site-header.tsx
Normal file
44
apps/web/src/components/public-site-header.tsx
Normal file
@@ -0,0 +1,44 @@
|
||||
"use client"
|
||||
|
||||
import { useTranslations } from "next-intl"
|
||||
|
||||
import { Link } from "@/i18n/navigation"
|
||||
|
||||
import { LanguageSwitcher } from "./language-switcher"
|
||||
|
||||
export function PublicSiteHeader() {
|
||||
const t = useTranslations("Layout")
|
||||
|
||||
const navItems = [
|
||||
{ href: "/", label: t("nav.home") },
|
||||
{ href: "/about", label: t("nav.about") },
|
||||
{ href: "/contact", label: t("nav.contact") },
|
||||
]
|
||||
|
||||
return (
|
||||
<header className="border-b border-neutral-200 bg-white/80 backdrop-blur">
|
||||
<div className="mx-auto flex w-full max-w-6xl flex-wrap items-center justify-between gap-4 px-6 py-4">
|
||||
<Link
|
||||
href="/"
|
||||
className="text-sm font-semibold uppercase tracking-[0.2em] text-neutral-700"
|
||||
>
|
||||
{t("brand")}
|
||||
</Link>
|
||||
|
||||
<nav className="flex flex-wrap items-center gap-2">
|
||||
{navItems.map((item) => (
|
||||
<Link
|
||||
key={item.href}
|
||||
href={item.href}
|
||||
className="rounded-md border border-neutral-300 px-3 py-1.5 text-sm font-medium text-neutral-700 hover:bg-neutral-100"
|
||||
>
|
||||
{item.label}
|
||||
</Link>
|
||||
))}
|
||||
</nav>
|
||||
|
||||
<LanguageSwitcher />
|
||||
</div>
|
||||
</header>
|
||||
)
|
||||
}
|
||||
17
apps/web/src/i18n/request.test.ts
Normal file
17
apps/web/src/i18n/request.test.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
import { describe, expect, it } from "vitest"
|
||||
|
||||
import { resolveRequestLocale } from "./request"
|
||||
|
||||
describe("resolveRequestLocale", () => {
|
||||
it("accepts supported locales", () => {
|
||||
expect(resolveRequestLocale("de")).toBe("de")
|
||||
expect(resolveRequestLocale("en")).toBe("en")
|
||||
expect(resolveRequestLocale("es")).toBe("es")
|
||||
expect(resolveRequestLocale("fr")).toBe("fr")
|
||||
})
|
||||
|
||||
it("falls back to default locale for unsupported values", () => {
|
||||
expect(resolveRequestLocale("it")).toBe("en")
|
||||
expect(resolveRequestLocale(undefined)).toBe("en")
|
||||
})
|
||||
})
|
||||
@@ -1,11 +1,16 @@
|
||||
import type { AppLocale } from "@cms/i18n"
|
||||
import { hasLocale } from "next-intl"
|
||||
import { getRequestConfig } from "next-intl/server"
|
||||
|
||||
import { routing } from "./routing"
|
||||
|
||||
export function resolveRequestLocale(requested: string | undefined): AppLocale {
|
||||
return hasLocale(routing.locales, requested) ? requested : routing.defaultLocale
|
||||
}
|
||||
|
||||
export default getRequestConfig(async ({ requestLocale }) => {
|
||||
const requested = await requestLocale
|
||||
const locale = hasLocale(routing.locales, requested) ? requested : routing.defaultLocale
|
||||
const locale = resolveRequestLocale(requested)
|
||||
|
||||
return {
|
||||
locale,
|
||||
|
||||
@@ -15,5 +15,31 @@
|
||||
"es": "Spanisch",
|
||||
"fr": "Französisch"
|
||||
}
|
||||
},
|
||||
"Layout": {
|
||||
"brand": "CMS Web",
|
||||
"nav": {
|
||||
"home": "Start",
|
||||
"about": "Über uns",
|
||||
"contact": "Kontakt"
|
||||
},
|
||||
"footer": {
|
||||
"copyright": "© {year} CMS Web",
|
||||
"tagline": "Powered by Next.js, Bun, Prisma und TanStack."
|
||||
}
|
||||
},
|
||||
"Seo": {
|
||||
"title": "CMS Web",
|
||||
"description": "Öffentliches Frontend für das CMS-Monorepo."
|
||||
},
|
||||
"About": {
|
||||
"badge": "Über uns",
|
||||
"title": "Über dieses Projekt",
|
||||
"description": "Diese öffentliche App ist die Frontend-Oberfläche für CMS-gesteuerte Inhalte und kommende dynamische Seiten."
|
||||
},
|
||||
"Contact": {
|
||||
"badge": "Kontakt",
|
||||
"title": "Kontakt",
|
||||
"description": "Kontakt- und Auftragsabläufe werden in den nächsten MVP-Schritten eingeführt."
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,5 +15,31 @@
|
||||
"es": "Spanish",
|
||||
"fr": "French"
|
||||
}
|
||||
},
|
||||
"Layout": {
|
||||
"brand": "CMS Web",
|
||||
"nav": {
|
||||
"home": "Home",
|
||||
"about": "About",
|
||||
"contact": "Contact"
|
||||
},
|
||||
"footer": {
|
||||
"copyright": "© {year} CMS Web",
|
||||
"tagline": "Powered by Next.js, Bun, Prisma, and TanStack."
|
||||
}
|
||||
},
|
||||
"Seo": {
|
||||
"title": "CMS Web",
|
||||
"description": "Public frontend for the CMS monorepo."
|
||||
},
|
||||
"About": {
|
||||
"badge": "About",
|
||||
"title": "About this project",
|
||||
"description": "This public app is the frontend surface for CMS-driven content and upcoming dynamic pages."
|
||||
},
|
||||
"Contact": {
|
||||
"badge": "Contact",
|
||||
"title": "Contact",
|
||||
"description": "Contact and commission flows will be introduced in upcoming MVP steps."
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,5 +15,31 @@
|
||||
"es": "Español",
|
||||
"fr": "Francés"
|
||||
}
|
||||
},
|
||||
"Layout": {
|
||||
"brand": "CMS Web",
|
||||
"nav": {
|
||||
"home": "Inicio",
|
||||
"about": "Acerca de",
|
||||
"contact": "Contacto"
|
||||
},
|
||||
"footer": {
|
||||
"copyright": "© {year} CMS Web",
|
||||
"tagline": "Impulsado por Next.js, Bun, Prisma y TanStack."
|
||||
}
|
||||
},
|
||||
"Seo": {
|
||||
"title": "CMS Web",
|
||||
"description": "Frontend público para el monorepo CMS."
|
||||
},
|
||||
"About": {
|
||||
"badge": "Acerca de",
|
||||
"title": "Sobre este proyecto",
|
||||
"description": "Esta app pública es la superficie frontend para contenido gestionado por CMS y próximas páginas dinámicas."
|
||||
},
|
||||
"Contact": {
|
||||
"badge": "Contacto",
|
||||
"title": "Contacto",
|
||||
"description": "Los flujos de contacto y comisiones se incorporarán en los siguientes pasos del MVP."
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,5 +15,31 @@
|
||||
"es": "Espagnol",
|
||||
"fr": "Français"
|
||||
}
|
||||
},
|
||||
"Layout": {
|
||||
"brand": "CMS Web",
|
||||
"nav": {
|
||||
"home": "Accueil",
|
||||
"about": "À propos",
|
||||
"contact": "Contact"
|
||||
},
|
||||
"footer": {
|
||||
"copyright": "© {year} CMS Web",
|
||||
"tagline": "Propulsé par Next.js, Bun, Prisma et TanStack."
|
||||
}
|
||||
},
|
||||
"Seo": {
|
||||
"title": "CMS Web",
|
||||
"description": "Frontend public pour le monorepo CMS."
|
||||
},
|
||||
"About": {
|
||||
"badge": "À propos",
|
||||
"title": "À propos de ce projet",
|
||||
"description": "Cette application publique est la surface frontend pour le contenu piloté par CMS et les futures pages dynamiques."
|
||||
},
|
||||
"Contact": {
|
||||
"badge": "Contact",
|
||||
"title": "Contact",
|
||||
"description": "Les flux de contact et de commission seront introduits dans les prochaines étapes MVP."
|
||||
}
|
||||
}
|
||||
|
||||
13
docker-compose.gitea-runner.yml
Normal file
13
docker-compose.gitea-runner.yml
Normal file
@@ -0,0 +1,13 @@
|
||||
services:
|
||||
gitea-runner:
|
||||
image: gitea/act_runner:latest
|
||||
container_name: cms-gitea-runner
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
GITEA_INSTANCE_URL: "${GITEA_INSTANCE_URL}"
|
||||
GITEA_RUNNER_REGISTRATION_TOKEN: "${GITEA_RUNNER_REGISTRATION_TOKEN}"
|
||||
GITEA_RUNNER_NAME: "${GITEA_RUNNER_NAME:-cms-runner}"
|
||||
GITEA_RUNNER_LABELS: "${GITEA_RUNNER_LABELS:-ubuntu-latest:docker://node:20-bookworm}"
|
||||
volumes:
|
||||
- ./runner-data:/data
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
@@ -21,9 +21,16 @@ export default defineConfig({
|
||||
{ text: "Architecture", link: "/architecture" },
|
||||
{ text: "Better Auth Baseline", link: "/product-engineering/auth-baseline" },
|
||||
{ text: "CRUD Baseline", link: "/product-engineering/crud-baseline" },
|
||||
{ text: "CRUD Examples", link: "/product-engineering/crud-examples" },
|
||||
{ text: "i18n Baseline", link: "/product-engineering/i18n-baseline" },
|
||||
{ text: "i18n Conventions", link: "/product-engineering/i18n-conventions" },
|
||||
{ text: "RBAC And Permissions", link: "/product-engineering/rbac-permission-model" },
|
||||
{ text: "Domain Glossary", link: "/product-engineering/domain-glossary" },
|
||||
{ text: "Environment Runbook", link: "/product-engineering/environment-runbook" },
|
||||
{ text: "Delivery Pipeline", link: "/product-engineering/delivery-pipeline" },
|
||||
{ text: "Git Flow Governance", link: "/product-engineering/git-flow-governance" },
|
||||
{ text: "Testing Strategy", link: "/product-engineering/testing-strategy" },
|
||||
{ text: "ADR Index", link: "/adr/" },
|
||||
{ text: "Workflow", link: "/workflow" },
|
||||
],
|
||||
},
|
||||
@@ -33,7 +40,17 @@ export default defineConfig({
|
||||
},
|
||||
{
|
||||
text: "Public API",
|
||||
items: [{ text: "Section Overview", link: "/public-api/" }],
|
||||
items: [
|
||||
{ text: "Section Overview", link: "/public-api/" },
|
||||
{ text: "Glossary", link: "/public-api/glossary" },
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "ADR",
|
||||
items: [
|
||||
{ text: "Index", link: "/adr/" },
|
||||
{ text: "0001 Monorepo Foundation", link: "/adr/0001-monorepo-foundation" },
|
||||
],
|
||||
},
|
||||
],
|
||||
socialLinks: [{ icon: "github", link: "https://example.com/replace-with-repo" }],
|
||||
|
||||
37
docs/adr/0001-monorepo-foundation.md
Normal file
37
docs/adr/0001-monorepo-foundation.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# ADR 0001: Monorepo Foundation
|
||||
|
||||
- Status: Accepted
|
||||
- Date: 2026-02-10
|
||||
|
||||
## Context
|
||||
|
||||
The CMS platform requires:
|
||||
|
||||
- separate admin and public apps
|
||||
- shared domain contracts and data access
|
||||
- consistent tooling and CI quality gates
|
||||
- incremental delivery through MVP stages
|
||||
|
||||
A fragmented multi-repo setup would increase coordination overhead and duplicate shared contracts.
|
||||
|
||||
## Decision
|
||||
|
||||
Adopt a Bun workspace monorepo with:
|
||||
|
||||
- `apps/admin` and `apps/web` for runtime surfaces
|
||||
- shared packages (`@cms/content`, `@cms/db`, `@cms/crud`, `@cms/ui`, `@cms/i18n`)
|
||||
- shared quality tooling (Biome, TypeScript, Vitest, Playwright, Turbo)
|
||||
|
||||
## Consequences
|
||||
|
||||
### Positive
|
||||
|
||||
- shared contract updates propagate in one change set
|
||||
- easier cross-app refactors and testing
|
||||
- single CI pipeline with consistent gates
|
||||
|
||||
### Negative
|
||||
|
||||
- stronger need for workspace discipline and clear boundaries
|
||||
- larger repository clone/build surface
|
||||
- potential for cross-package coupling if conventions are not enforced
|
||||
17
docs/adr/README.md
Normal file
17
docs/adr/README.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# ADR Index
|
||||
|
||||
Architecture Decision Records (ADRs) capture important technical decisions and context.
|
||||
|
||||
## Format
|
||||
|
||||
- Numbered files: `0001-<short-title>.md`
|
||||
- Immutable once accepted (new ADRs supersede old decisions)
|
||||
- Include:
|
||||
- Status
|
||||
- Context
|
||||
- Decision
|
||||
- Consequences
|
||||
|
||||
## Records
|
||||
|
||||
- [0001 - Monorepo Foundation](./0001-monorepo-foundation.md)
|
||||
@@ -7,6 +7,7 @@ Engineering documentation hub for this repository.
|
||||
- [Product / Engineering](/product-engineering/)
|
||||
- [Admin / User Guides](/admin-user-guides/)
|
||||
- [Public API](/public-api/)
|
||||
- [ADR Index](/adr/)
|
||||
|
||||
## Core Sources
|
||||
|
||||
@@ -14,6 +15,7 @@ Engineering documentation hub for this repository.
|
||||
- Branching and promotion flow: `BRANCHING.md`
|
||||
- Contribution and commit schema: `CONTRIBUTING.md`
|
||||
- Release history: `CHANGELOG.md`
|
||||
- Versioning and release policy: `VERSIONING.md`
|
||||
|
||||
## Documentation Scope
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ MVP0 now includes a shared CRUD foundation package: `@cms/crud`.
|
||||
Current baseline:
|
||||
|
||||
- Shared service factory: `createCrudService`
|
||||
- Repository contract: `list`, `findById`, `create`, `update`, `delete`
|
||||
- Service surface for list/detail/editor flows: `list`, `getById`, `create`, `update`, `delete`
|
||||
- Shared validation error type: `CrudValidationError`
|
||||
- Shared not-found error type: `CrudNotFoundError`
|
||||
- Shared mutation audit hook contract: `CrudAuditHook`
|
||||
@@ -24,6 +26,11 @@ Current baseline:
|
||||
- `registerPostCrudAuditHook`
|
||||
|
||||
Validation for create/update is enforced by `@cms/content` schemas.
|
||||
Contract tests validate:
|
||||
|
||||
- repository list/detail behavior via CRUD service
|
||||
- validation and not-found errors
|
||||
- audit payload propagation (`actor`, `metadata`)
|
||||
|
||||
The admin dashboard currently includes a temporary posts CRUD sandbox to validate this flow through a real app UI.
|
||||
|
||||
@@ -31,3 +38,4 @@ The admin dashboard currently includes a temporary posts CRUD sandbox to validat
|
||||
|
||||
- This is the base layer for future entities (pages, navigation, media, users, commissions).
|
||||
- Audit hook persistence/transport is intentionally left for later implementation work.
|
||||
- Implementation examples are documented in `crud-examples.md`.
|
||||
|
||||
69
docs/product-engineering/crud-examples.md
Normal file
69
docs/product-engineering/crud-examples.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# CRUD Examples
|
||||
|
||||
## Goal
|
||||
|
||||
Provide concrete implementation patterns for new entities adopting `@cms/crud`.
|
||||
|
||||
## Example: Service Factory Wiring
|
||||
|
||||
```ts
|
||||
import { createCrudService } from "@cms/crud"
|
||||
import { createPageInputSchema, updatePageInputSchema } from "@cms/content"
|
||||
|
||||
const pageCrudService = createCrudService({
|
||||
resource: "page",
|
||||
repository: pageRepository,
|
||||
schemas: {
|
||||
create: createPageInputSchema,
|
||||
update: updatePageInputSchema,
|
||||
},
|
||||
auditHooks: pageAuditHooks,
|
||||
})
|
||||
```
|
||||
|
||||
## Example: Repository Contract
|
||||
|
||||
```ts
|
||||
const pageRepository = {
|
||||
list: () => db.page.findMany({ orderBy: { updatedAt: "desc" } }),
|
||||
findById: (id: string) => db.page.findUnique({ where: { id } }),
|
||||
create: (input: CreatePageInput) => db.page.create({ data: input }),
|
||||
update: (id: string, input: UpdatePageInput) =>
|
||||
db.page.update({
|
||||
where: { id },
|
||||
data: input,
|
||||
}),
|
||||
delete: (id: string) => db.page.delete({ where: { id } }),
|
||||
}
|
||||
```
|
||||
|
||||
## Example: Action Usage
|
||||
|
||||
```ts
|
||||
export async function createPage(input: unknown, context?: CrudMutationContext) {
|
||||
return pageCrudService.create(input, context)
|
||||
}
|
||||
|
||||
export async function updatePage(id: string, input: unknown, context?: CrudMutationContext) {
|
||||
return pageCrudService.update(id, input, context)
|
||||
}
|
||||
|
||||
export async function deletePage(id: string, context?: CrudMutationContext) {
|
||||
return pageCrudService.delete(id, context)
|
||||
}
|
||||
```
|
||||
|
||||
## Testing Expectations
|
||||
|
||||
- validation failure returns `CrudValidationError`
|
||||
- missing IDs return `CrudNotFoundError`
|
||||
- repository methods are called in expected order
|
||||
- audit hooks receive `actor`, `metadata`, `before`, `after`
|
||||
|
||||
## Adoption Checklist
|
||||
|
||||
1. Add entity schemas in `@cms/content`
|
||||
2. Add repository + service in `@cms/db`
|
||||
3. Add unit tests for contract + validation
|
||||
4. Wire route/action permission checks before mutations
|
||||
5. Add docs links and TODO updates
|
||||
77
docs/product-engineering/delivery-pipeline.md
Normal file
77
docs/product-engineering/delivery-pipeline.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Delivery Pipeline
|
||||
|
||||
## Scope
|
||||
|
||||
Operational pipeline baseline for image build/push, staging deploy, production promotion, and rollback.
|
||||
|
||||
## Registry Credentials Strategy
|
||||
|
||||
Use scoped Gitea secrets:
|
||||
|
||||
- `CMS_IMAGE_REGISTRY`
|
||||
- `CMS_IMAGE_NAMESPACE`
|
||||
- `CMS_IMAGE_REGISTRY_USER`
|
||||
- `CMS_IMAGE_REGISTRY_PASSWORD`
|
||||
|
||||
Policy:
|
||||
|
||||
- credentials only in CI secrets
|
||||
- no plaintext credentials in repo
|
||||
- least privilege: push/pull for target namespace only
|
||||
|
||||
## Build and Push Flow
|
||||
|
||||
- Workflow: `.gitea/workflows/release.yml`
|
||||
- Trigger:
|
||||
- tag push `vX.Y.Z`
|
||||
- manual `workflow_dispatch`
|
||||
- Steps:
|
||||
1. validate tag vs root `package.json` version
|
||||
2. generate changelog
|
||||
3. docker login
|
||||
4. build and push `cms-web` and `cms-admin` images
|
||||
|
||||
## Staging Deployment Automation
|
||||
|
||||
- Workflow: `.gitea/workflows/deploy.yml`
|
||||
- Manual input:
|
||||
- `environment=staging`
|
||||
- `image_tag=vX.Y.Z`
|
||||
- Remote deployment uses SSH + compose file:
|
||||
- `docker-compose.staging.yml`
|
||||
|
||||
Required secrets:
|
||||
|
||||
- `CMS_STAGING_HOST`
|
||||
- `CMS_STAGING_USER`
|
||||
- `CMS_DEPLOY_KEY`
|
||||
- `CMS_REMOTE_DEPLOY_PATH`
|
||||
|
||||
## Production Promotion and Rollback
|
||||
|
||||
Promotion:
|
||||
|
||||
- run deploy workflow with:
|
||||
- `environment=production`
|
||||
- `image_tag=vX.Y.Z`
|
||||
|
||||
Rollback:
|
||||
|
||||
- release workflow supports rollback placeholder by image tag
|
||||
- deploy workflow supports `rollback_tag` input
|
||||
- recovery action:
|
||||
- rerun deploy with previous known-good tag
|
||||
|
||||
## Deployment Verification
|
||||
|
||||
After deploy:
|
||||
|
||||
1. app health checks (web/admin)
|
||||
2. auth smoke flow
|
||||
3. i18n smoke flow
|
||||
4. critical route checks (`/`, `/login`, `/todo`)
|
||||
|
||||
## Notes
|
||||
|
||||
- Current workflows are production-oriented scaffolds and require secret provisioning in Gitea.
|
||||
- Host hardening, network ACLs, and backup policy remain mandatory operational controls.
|
||||
35
docs/product-engineering/domain-glossary.md
Normal file
35
docs/product-engineering/domain-glossary.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Domain Glossary
|
||||
|
||||
## Core Terms
|
||||
|
||||
### Owner
|
||||
|
||||
Highest-privilege admin role. Exactly one canonical owner must exist at all times.
|
||||
|
||||
### Support User
|
||||
|
||||
Hidden technical support account used for break-glass access and operational recovery.
|
||||
|
||||
### Admin Registration Policy
|
||||
|
||||
Runtime policy controlling whether `/register` can create additional admin users after owner bootstrap.
|
||||
|
||||
### Protected Account
|
||||
|
||||
Account that cannot be deleted/demoted through self-service flows (support + canonical owner).
|
||||
|
||||
### CRUD Service
|
||||
|
||||
Shared `@cms/crud` service abstraction combining schema validation, repository orchestration, and audit hooks.
|
||||
|
||||
### Permission Scope
|
||||
|
||||
RBAC access scope granularity: `own`, `team`, `global`.
|
||||
|
||||
### Roadmap Source Of Truth
|
||||
|
||||
`TODO.md` in repository root. Rendered in admin via `/todo`.
|
||||
|
||||
### Header Banner
|
||||
|
||||
Public-site announcement strip configured through `system_setting` key `public.header_banner`.
|
||||
103
docs/product-engineering/environment-runbook.md
Normal file
103
docs/product-engineering/environment-runbook.md
Normal file
@@ -0,0 +1,103 @@
|
||||
# Environment and Deployment Runbook
|
||||
|
||||
## Scope
|
||||
|
||||
Operational baseline for `dev`, `staging`, and `production`.
|
||||
|
||||
## Environments
|
||||
|
||||
### Dev (local)
|
||||
|
||||
- Runtime: Bun + local Next dev servers
|
||||
- Entry point: `bun run dev`
|
||||
- Database: local/remote dev Postgres from `.env`
|
||||
- Characteristics:
|
||||
- fastest feedback
|
||||
- non-production data acceptable
|
||||
- migrations created here first
|
||||
|
||||
### Staging
|
||||
|
||||
- Runtime: Docker Compose (`docker-compose.staging.yml`)
|
||||
- Purpose: integration validation and release candidate checks
|
||||
- Characteristics:
|
||||
- production-like environment
|
||||
- controlled test data
|
||||
- candidate for production promotion
|
||||
|
||||
### Production
|
||||
|
||||
- Runtime: Docker Compose (`docker-compose.production.yml`)
|
||||
- Purpose: end-user traffic
|
||||
- Characteristics:
|
||||
- protected secrets and stricter access controls
|
||||
- immutable release artifacts
|
||||
- rollback procedures required
|
||||
|
||||
## Core Commands
|
||||
|
||||
### Local development
|
||||
|
||||
```bash
|
||||
bun install
|
||||
bun run db:generate
|
||||
bun run db:migrate
|
||||
bun run db:seed
|
||||
bun run dev
|
||||
```
|
||||
|
||||
### Staging compose
|
||||
|
||||
```bash
|
||||
bun run docker:staging:up
|
||||
bun run docker:staging:down
|
||||
```
|
||||
|
||||
### Production compose
|
||||
|
||||
```bash
|
||||
bun run docker:production:up
|
||||
bun run docker:production:down
|
||||
```
|
||||
|
||||
## Release Flow
|
||||
|
||||
1. Complete work on task branch.
|
||||
2. Merge into `dev` and pass quality gates.
|
||||
3. Promote `dev` -> `staging`.
|
||||
4. Validate staging smoke/e2e + manual checks.
|
||||
5. Promote `staging` -> `main` and tag release.
|
||||
|
||||
## Migration Policy
|
||||
|
||||
- Create migrations in development only.
|
||||
- Apply migrations in deployment using `prisma migrate deploy`.
|
||||
- Never hand-edit applied migration history.
|
||||
|
||||
## Rollback Baseline
|
||||
|
||||
Current baseline strategy:
|
||||
|
||||
- rollback app image/tag to previous known-good release
|
||||
- restore database from backup when schema/data changes require recovery
|
||||
|
||||
## Secrets and Config
|
||||
|
||||
- Dev: `.env`
|
||||
- Staging: `.env.staging` (from `.env.staging.example`)
|
||||
- Production: `.env.production` (from `.env.production.example`)
|
||||
|
||||
Minimum sensitive values:
|
||||
|
||||
- `DATABASE_URL`
|
||||
- `BETTER_AUTH_SECRET`
|
||||
- `CMS_SUPPORT_*` credentials/keys
|
||||
|
||||
## Verification Checklist
|
||||
|
||||
- `bun run check`
|
||||
- `bun run typecheck`
|
||||
- `bun run test`
|
||||
- `bun run test:e2e`
|
||||
- app startup health for web/admin
|
||||
- login flow and permissions smoke
|
||||
66
docs/product-engineering/git-flow-governance.md
Normal file
66
docs/product-engineering/git-flow-governance.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# Git Flow Governance
|
||||
|
||||
## Scope
|
||||
|
||||
Governance rules for branch protections, PR gates, branch naming, and merge discipline.
|
||||
|
||||
## Branch Protection
|
||||
|
||||
Protected branches:
|
||||
|
||||
- `main`
|
||||
- `staging`
|
||||
|
||||
Apply protections using:
|
||||
|
||||
- Gitea UI settings
|
||||
- or automation script: `.gitea/scripts/configure-branch-protection.sh`
|
||||
|
||||
Minimum policy:
|
||||
|
||||
- no direct pushes
|
||||
- PR merge required
|
||||
- required status checks
|
||||
- at least one reviewer approval
|
||||
|
||||
## PR Gates
|
||||
|
||||
Required checks are implemented in `.gitea/workflows/ci.yml`:
|
||||
|
||||
- Governance Checks
|
||||
- Lint Typecheck Unit E2E
|
||||
|
||||
## Branch Naming and TODO Scope
|
||||
|
||||
Allowed branch prefixes:
|
||||
|
||||
- `todo/`
|
||||
- `refactor/`
|
||||
- `code/`
|
||||
|
||||
Validation script:
|
||||
|
||||
- `.gitea/scripts/check-branch-name.sh`
|
||||
|
||||
Rule:
|
||||
|
||||
- one primary TODO item per delivery branch
|
||||
|
||||
PR TODO reference enforcement:
|
||||
|
||||
- template: `.gitea/PULL_REQUEST_TEMPLATE.md`
|
||||
- CI check: `.gitea/scripts/check-pr-todo-reference.sh`
|
||||
|
||||
## Branch Lifecycle
|
||||
|
||||
1. Create short-lived branch from latest integration tip.
|
||||
2. Implement one primary scope.
|
||||
3. Open PR and pass required checks.
|
||||
4. Merge into `dev`.
|
||||
5. Promote `dev -> staging -> main`.
|
||||
|
||||
## Commit and Tag Policy
|
||||
|
||||
- Conventional commits required (`CONTRIBUTING.md`)
|
||||
- release tags: `vX.Y.Z`
|
||||
- changelog generated from commit history
|
||||
@@ -18,4 +18,4 @@ Current baseline:
|
||||
|
||||
- Public app locale is resolved through `next-intl` middleware + cookie.
|
||||
- Enabled locales are currently static in code and will later be managed from admin settings.
|
||||
- Translation key conventions and workflow docs are tracked in `TODO.md`.
|
||||
- Translation key and workflow standards are documented in `i18n-conventions.md`.
|
||||
|
||||
86
docs/product-engineering/i18n-conventions.md
Normal file
86
docs/product-engineering/i18n-conventions.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# i18n Conventions
|
||||
|
||||
## Scope
|
||||
|
||||
This document defines translation conventions for both apps in MVP0+.
|
||||
|
||||
- Public app i18n: `next-intl` message namespaces and route-level usage
|
||||
- Admin app i18n: JSON dictionaries + runtime resolver/provider
|
||||
- Shared locale contract: `@cms/i18n` (`de`, `en`, `es`, `fr`; default `en`)
|
||||
|
||||
## Locale Policy
|
||||
|
||||
- Source of truth: `packages/i18n/src/index.ts`
|
||||
- Current enabled locales are code-driven and shared across web/admin.
|
||||
- Admin-managed locale toggles are planned for a later MVP.
|
||||
|
||||
## Key Naming Conventions
|
||||
|
||||
- Use `camelCase` for keys.
|
||||
- Group by domain namespace (not by component filename).
|
||||
- Keep keys stable; update values, not key names, during copy edits.
|
||||
|
||||
### Public app namespaces
|
||||
|
||||
- `Layout.*`
|
||||
- `Home.*`
|
||||
- `LanguageSwitcher.*`
|
||||
- Page-specific namespaces, e.g. `About.*`, `Contact.*`
|
||||
- Metadata namespace: `Seo.*`
|
||||
|
||||
### Admin app namespaces
|
||||
|
||||
- `common.*`
|
||||
- `auth.*`
|
||||
- `dashboard.*`
|
||||
- `settings.*`
|
||||
|
||||
## Message Structure
|
||||
|
||||
- Keep messages as nested JSON objects.
|
||||
- Avoid very deep nesting (prefer 2-3 levels).
|
||||
- Keep punctuation in translation values, not code.
|
||||
- Avoid embedding HTML in message strings.
|
||||
|
||||
## Fallback Rules
|
||||
|
||||
- Unknown/invalid locale values fallback to default locale `en`.
|
||||
- Missing translation key behavior:
|
||||
- Admin: `translateMessage` returns provided fallback, else key.
|
||||
- Public: ensure required keys exist in locale JSON; avoid runtime missing-key states.
|
||||
|
||||
## Adding New Translation Keys
|
||||
|
||||
1. Add key/value in `apps/*/src/messages/en.json`.
|
||||
2. Add equivalent key in `de/es/fr` JSON files.
|
||||
3. Use key via translator:
|
||||
- Web: `useTranslations("Namespace")` or `getTranslations("Namespace")`
|
||||
- Admin: `useAdminT()` or server-side `translateMessage(...)`
|
||||
4. Add/adjust tests for behavior where relevant.
|
||||
|
||||
## Translation Workflow
|
||||
|
||||
1. Author English source copy first.
|
||||
2. Add keys in all supported locales in same change.
|
||||
3. Keep semantic parity across locales.
|
||||
4. Run checks:
|
||||
- `bun run check`
|
||||
- `bun run typecheck`
|
||||
- `bun run test`
|
||||
5. For route-level i18n behavior changes, run e2e smoke:
|
||||
- `bunx playwright test --grep "i18n smoke"`
|
||||
|
||||
## QA Checklist
|
||||
|
||||
- Locale switch persists after refresh.
|
||||
- Page headings and navigation labels translate correctly.
|
||||
- Metadata (`Seo`) strings resolve per locale.
|
||||
- No missing-key placeholders visible in UI.
|
||||
|
||||
## Related Files
|
||||
|
||||
- `apps/web/src/i18n/request.ts`
|
||||
- `apps/web/src/i18n/routing.ts`
|
||||
- `apps/admin/src/i18n/server.ts`
|
||||
- `apps/admin/src/i18n/messages.ts`
|
||||
- `packages/i18n/src/index.ts`
|
||||
@@ -8,7 +8,14 @@ This section covers platform and implementation documentation for engineers and
|
||||
- [Architecture](/architecture)
|
||||
- [Better Auth Baseline](/product-engineering/auth-baseline)
|
||||
- [RBAC And Permissions](/product-engineering/rbac-permission-model)
|
||||
- [i18n Conventions](/product-engineering/i18n-conventions)
|
||||
- [CRUD Examples](/product-engineering/crud-examples)
|
||||
- [Domain Glossary](/product-engineering/domain-glossary)
|
||||
- [Environment Runbook](/product-engineering/environment-runbook)
|
||||
- [Delivery Pipeline](/product-engineering/delivery-pipeline)
|
||||
- [Git Flow Governance](/product-engineering/git-flow-governance)
|
||||
- [Testing Strategy Baseline](/product-engineering/testing-strategy)
|
||||
- [ADR Index](/adr/)
|
||||
- [Workflow](/workflow)
|
||||
|
||||
## Scope
|
||||
@@ -20,6 +27,4 @@ This section covers platform and implementation documentation for engineers and
|
||||
|
||||
## Planned Expansions
|
||||
|
||||
- Domain model and glossary
|
||||
- ADR (Architecture Decision Record) index
|
||||
- Operational playbooks (incident, rollback, recovery)
|
||||
|
||||
43
docs/public-api/glossary.md
Normal file
43
docs/public-api/glossary.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Public API Glossary
|
||||
|
||||
## Scope
|
||||
|
||||
Baseline terms for future public API design and integration discussions.
|
||||
|
||||
## Terms
|
||||
|
||||
### Public API
|
||||
|
||||
Externally consumable endpoints intended for non-admin clients.
|
||||
|
||||
### Resource
|
||||
|
||||
Entity exposed by an API endpoint (for example: `page`, `media`, `news`).
|
||||
|
||||
### Contract
|
||||
|
||||
The stable request/response schema for an endpoint version.
|
||||
|
||||
### Version
|
||||
|
||||
Compatibility boundary for API contracts (for example: `v1`).
|
||||
|
||||
### Authentication
|
||||
|
||||
Identity verification mechanism for protected API routes.
|
||||
|
||||
### Authorization
|
||||
|
||||
Permission check determining whether an authenticated actor can access a resource/action.
|
||||
|
||||
### Pagination
|
||||
|
||||
Mechanism for splitting large result sets across requests.
|
||||
|
||||
### Idempotency
|
||||
|
||||
Property where repeating a request does not change final state beyond the first successful call.
|
||||
|
||||
### Rate Limit
|
||||
|
||||
Request threshold policy applied per consumer/time window.
|
||||
@@ -11,6 +11,11 @@ No stable public API surface is documented yet.
|
||||
- Add API docs when real endpoints are implemented and versioned
|
||||
- Use OpenAPI as source of truth for endpoint reference
|
||||
- Keep integration guides and authentication examples here
|
||||
- Use glossary terms consistently across API specs and guides
|
||||
|
||||
## Reference
|
||||
|
||||
- [Public API Glossary](/public-api/glossary)
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -28,3 +28,9 @@ Follow `BRANCHING.md`:
|
||||
```bash
|
||||
bun run changelog:release
|
||||
```
|
||||
|
||||
## Governance
|
||||
|
||||
- Branch and PR governance checks run in `.gitea/workflows/ci.yml`.
|
||||
- PR template: `.gitea/PULL_REQUEST_TEMPLATE.md`
|
||||
- Versioning policy: `VERSIONING.md`
|
||||
|
||||
35
e2e/i18n-smoke.pw.ts
Normal file
35
e2e/i18n-smoke.pw.ts
Normal file
@@ -0,0 +1,35 @@
|
||||
import { expect, test } from "@playwright/test"
|
||||
|
||||
test.describe("i18n smoke", () => {
|
||||
test("web renders localized page headings on key routes", async ({ page }, testInfo) => {
|
||||
test.skip(testInfo.project.name !== "web-chromium")
|
||||
|
||||
await page.goto("/")
|
||||
await page.locator("select").first().selectOption("de")
|
||||
await expect(page.getByRole("heading", { name: /dein next\.js cms frontend/i })).toBeVisible()
|
||||
|
||||
await page.getByRole("link", { name: /über uns/i }).click()
|
||||
await expect(page.getByRole("heading", { name: /über dieses projekt/i })).toBeVisible()
|
||||
|
||||
await page.locator("select").first().selectOption("es")
|
||||
await expect(page.getByRole("heading", { name: /sobre este proyecto/i })).toBeVisible()
|
||||
|
||||
await page.getByRole("link", { name: /contacto/i }).click()
|
||||
await expect(page.getByRole("heading", { name: /^contacto$/i })).toBeVisible()
|
||||
})
|
||||
|
||||
test("admin login renders localized heading and labels", async ({ page }, testInfo) => {
|
||||
test.skip(testInfo.project.name !== "admin-chromium")
|
||||
|
||||
await page.goto("/login")
|
||||
await expect(page.getByRole("heading", { name: /sign in to cms admin/i })).toBeVisible()
|
||||
|
||||
await page.locator("select").first().selectOption("fr")
|
||||
await expect(page.getByRole("heading", { name: /se connecter à cms admin/i })).toBeVisible()
|
||||
await expect(page.getByLabel(/e-mail ou nom d’utilisateur/i)).toBeVisible()
|
||||
|
||||
await page.locator("select").first().selectOption("es")
|
||||
await expect(page.getByRole("heading", { name: /iniciar sesión en cms admin/i })).toBeVisible()
|
||||
await expect(page.getByLabel(/correo o nombre de usuario/i)).toBeVisible()
|
||||
})
|
||||
})
|
||||
@@ -28,4 +28,31 @@ describe("rbac model", () => {
|
||||
expect(permissionMatrix.editor.length).toBeGreaterThan(0)
|
||||
expect(permissionMatrix.manager.length).toBeGreaterThan(0)
|
||||
})
|
||||
|
||||
it("prevents privilege escalation for non-admin roles", () => {
|
||||
expect(hasPermission("editor", "users:manage_roles", "global")).toBe(false)
|
||||
expect(hasPermission("manager", "users:manage_roles", "global")).toBe(false)
|
||||
expect(hasPermission("editor", "dashboard:read", "global")).toBe(true)
|
||||
})
|
||||
|
||||
it("keeps role policy regressions visible for critical permissions", () => {
|
||||
const criticalChecks: Array<{
|
||||
role: "owner" | "support" | "admin" | "manager" | "editor"
|
||||
permission: Parameters<typeof hasPermission>[1]
|
||||
scope: Parameters<typeof hasPermission>[2]
|
||||
allowed: boolean
|
||||
}> = [
|
||||
{ role: "owner", permission: "users:manage_roles", scope: "global", allowed: true },
|
||||
{ role: "support", permission: "users:manage_roles", scope: "global", allowed: true },
|
||||
{ role: "admin", permission: "banner:write", scope: "global", allowed: true },
|
||||
{ role: "manager", permission: "users:write", scope: "global", allowed: false },
|
||||
{ role: "manager", permission: "users:write", scope: "team", allowed: true },
|
||||
{ role: "editor", permission: "news:publish", scope: "team", allowed: false },
|
||||
{ role: "editor", permission: "news:publish", scope: "own", allowed: true },
|
||||
]
|
||||
|
||||
for (const check of criticalChecks) {
|
||||
expect(hasPermission(check.role, check.permission, check.scope)).toBe(check.allowed)
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
124
packages/crud/src/contract.test.ts
Normal file
124
packages/crud/src/contract.test.ts
Normal file
@@ -0,0 +1,124 @@
|
||||
import { describe, expect, it } from "vitest"
|
||||
import { z } from "zod"
|
||||
|
||||
import { createCrudService } from "./service"
|
||||
|
||||
type RecordItem = {
|
||||
id: string
|
||||
title: string
|
||||
}
|
||||
|
||||
describe("crud service contract", () => {
|
||||
it("calls repository in expected order for update and delete", async () => {
|
||||
const calls: string[] = []
|
||||
const state = new Map<string, RecordItem>([["1", { id: "1", title: "Initial" }]])
|
||||
|
||||
const service = createCrudService({
|
||||
resource: "item",
|
||||
repository: {
|
||||
list: async () => {
|
||||
calls.push("list")
|
||||
return Array.from(state.values())
|
||||
},
|
||||
findById: async (id) => {
|
||||
calls.push(`findById:${id}`)
|
||||
return state.get(id) ?? null
|
||||
},
|
||||
create: async (input: { title: string }) => {
|
||||
calls.push("create")
|
||||
return {
|
||||
id: "2",
|
||||
title: input.title,
|
||||
}
|
||||
},
|
||||
update: async (id, input: { title?: string }) => {
|
||||
calls.push(`update:${id}`)
|
||||
const current = state.get(id)
|
||||
if (!current) {
|
||||
throw new Error("missing")
|
||||
}
|
||||
const updated = {
|
||||
...current,
|
||||
...input,
|
||||
}
|
||||
state.set(id, updated)
|
||||
return updated
|
||||
},
|
||||
delete: async (id) => {
|
||||
calls.push(`delete:${id}`)
|
||||
const current = state.get(id)
|
||||
if (!current) {
|
||||
throw new Error("missing")
|
||||
}
|
||||
state.delete(id)
|
||||
return current
|
||||
},
|
||||
},
|
||||
schemas: {
|
||||
create: z.object({
|
||||
title: z.string().min(3),
|
||||
}),
|
||||
update: z.object({
|
||||
title: z.string().min(3).optional(),
|
||||
}),
|
||||
},
|
||||
})
|
||||
|
||||
await service.update("1", { title: "Updated" })
|
||||
await service.delete("1")
|
||||
|
||||
expect(calls).toEqual(["findById:1", "update:1", "findById:1", "delete:1"])
|
||||
})
|
||||
|
||||
it("passes parsed payload to repository create/update contracts", async () => {
|
||||
let createPayload: unknown = null
|
||||
let updatePayload: unknown = null
|
||||
|
||||
const service = createCrudService({
|
||||
resource: "item",
|
||||
repository: {
|
||||
list: async () => [],
|
||||
findById: async () => ({
|
||||
id: "1",
|
||||
title: "Existing",
|
||||
}),
|
||||
create: async (input: { title: string }) => {
|
||||
createPayload = input
|
||||
return {
|
||||
id: "2",
|
||||
title: input.title,
|
||||
}
|
||||
},
|
||||
update: async (_id, input: { title?: string }) => {
|
||||
updatePayload = input
|
||||
return {
|
||||
id: "1",
|
||||
title: input.title ?? "Existing",
|
||||
}
|
||||
},
|
||||
delete: async () => ({
|
||||
id: "1",
|
||||
title: "Existing",
|
||||
}),
|
||||
},
|
||||
schemas: {
|
||||
create: z.object({
|
||||
title: z.string().trim().min(3),
|
||||
}),
|
||||
update: z.object({
|
||||
title: z.string().trim().min(3).optional(),
|
||||
}),
|
||||
},
|
||||
})
|
||||
|
||||
await service.create({
|
||||
title: " Created ",
|
||||
})
|
||||
await service.update("1", {
|
||||
title: " Updated ",
|
||||
})
|
||||
|
||||
expect(createPayload).toEqual({ title: "Created" })
|
||||
expect(updatePayload).toEqual({ title: "Updated" })
|
||||
})
|
||||
})
|
||||
@@ -63,6 +63,32 @@ function createMemoryRepository() {
|
||||
}
|
||||
|
||||
describe("createCrudService", () => {
|
||||
it("supports list and detail lookups through the repository contract", async () => {
|
||||
const service = createCrudService({
|
||||
resource: "fake-entity",
|
||||
repository: createMemoryRepository(),
|
||||
schemas: {
|
||||
create: z.object({
|
||||
title: z.string().min(3),
|
||||
}),
|
||||
update: z.object({
|
||||
title: z.string().min(3).optional(),
|
||||
}),
|
||||
},
|
||||
})
|
||||
|
||||
const createdA = await service.create({ title: "First" })
|
||||
const createdB = await service.create({ title: "Second" })
|
||||
|
||||
expect(await service.getById(createdA.id)).toEqual(createdA)
|
||||
expect(await service.getById("missing")).toBeNull()
|
||||
|
||||
const listed = await service.list()
|
||||
expect(listed).toHaveLength(2)
|
||||
expect(listed).toContainEqual(createdA)
|
||||
expect(listed).toContainEqual(createdB)
|
||||
})
|
||||
|
||||
it("validates create and update payloads", async () => {
|
||||
const service = createCrudService({
|
||||
resource: "fake-entity",
|
||||
@@ -106,8 +132,13 @@ describe("createCrudService", () => {
|
||||
})
|
||||
|
||||
it("emits audit events for create, update and delete", async () => {
|
||||
const events: Array<{ action: string; beforeTitle: string | null; afterTitle: string | null }> =
|
||||
[]
|
||||
const events: Array<{
|
||||
action: string
|
||||
beforeTitle: string | null
|
||||
afterTitle: string | null
|
||||
actorRole: string | null
|
||||
requestId: string | null
|
||||
}> = []
|
||||
const service = createCrudService({
|
||||
resource: "fake-entity",
|
||||
repository: createMemoryRepository(),
|
||||
@@ -125,6 +156,9 @@ describe("createCrudService", () => {
|
||||
action: event.action,
|
||||
beforeTitle: event.before?.title ?? null,
|
||||
afterTitle: event.after?.title ?? null,
|
||||
actorRole: event.actor?.role ?? null,
|
||||
requestId:
|
||||
typeof event.metadata?.requestId === "string" ? event.metadata.requestId : null,
|
||||
})
|
||||
},
|
||||
],
|
||||
@@ -134,6 +168,9 @@ describe("createCrudService", () => {
|
||||
{ title: "Created" },
|
||||
{
|
||||
actor: { id: "u-1", role: "owner" },
|
||||
metadata: {
|
||||
requestId: "req-1",
|
||||
},
|
||||
},
|
||||
)
|
||||
|
||||
@@ -145,16 +182,22 @@ describe("createCrudService", () => {
|
||||
action: "create",
|
||||
beforeTitle: null,
|
||||
afterTitle: "Created",
|
||||
actorRole: "owner",
|
||||
requestId: "req-1",
|
||||
},
|
||||
{
|
||||
action: "update",
|
||||
beforeTitle: "Created",
|
||||
afterTitle: "Updated",
|
||||
actorRole: null,
|
||||
requestId: null,
|
||||
},
|
||||
{
|
||||
action: "delete",
|
||||
beforeTitle: "Updated",
|
||||
afterTitle: null,
|
||||
actorRole: null,
|
||||
requestId: null,
|
||||
},
|
||||
])
|
||||
})
|
||||
|
||||
@@ -12,6 +12,20 @@ async function main() {
|
||||
status: "published",
|
||||
},
|
||||
})
|
||||
|
||||
await db.systemSetting.upsert({
|
||||
where: { key: "public.header_banner" },
|
||||
update: {},
|
||||
create: {
|
||||
key: "public.header_banner",
|
||||
value: JSON.stringify({
|
||||
enabled: true,
|
||||
message: "New portfolio release is live.",
|
||||
ctaLabel: "Open latest posts",
|
||||
ctaHref: "/",
|
||||
}),
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
main()
|
||||
|
||||
@@ -7,4 +7,9 @@ export {
|
||||
registerPostCrudAuditHook,
|
||||
updatePost,
|
||||
} from "./posts"
|
||||
export { isAdminSelfRegistrationEnabled, setAdminSelfRegistrationEnabled } from "./settings"
|
||||
export type { PublicHeaderBanner } from "./settings"
|
||||
export {
|
||||
getPublicHeaderBanner,
|
||||
isAdminSelfRegistrationEnabled,
|
||||
setAdminSelfRegistrationEnabled,
|
||||
} from "./settings"
|
||||
|
||||
@@ -1,6 +1,20 @@
|
||||
import { db } from "./client"
|
||||
|
||||
const ADMIN_SELF_REGISTRATION_KEY = "admin.self_registration_enabled"
|
||||
const PUBLIC_HEADER_BANNER_KEY = "public.header_banner"
|
||||
|
||||
type PublicHeaderBannerRecord = {
|
||||
enabled: boolean
|
||||
message: string
|
||||
ctaLabel?: string
|
||||
ctaHref?: string
|
||||
}
|
||||
|
||||
export type PublicHeaderBanner = {
|
||||
message: string
|
||||
ctaLabel?: string
|
||||
ctaHref?: string
|
||||
}
|
||||
|
||||
function resolveEnvFallback(): boolean {
|
||||
return process.env.CMS_ADMIN_SELF_REGISTRATION_ENABLED === "true"
|
||||
@@ -18,6 +32,25 @@ function parseStoredBoolean(value: string): boolean | null {
|
||||
return null
|
||||
}
|
||||
|
||||
function parsePublicHeaderBanner(value: string): PublicHeaderBannerRecord | null {
|
||||
try {
|
||||
const parsed = JSON.parse(value) as Record<string, unknown>
|
||||
|
||||
if (typeof parsed.enabled !== "boolean" || typeof parsed.message !== "string") {
|
||||
return null
|
||||
}
|
||||
|
||||
return {
|
||||
enabled: parsed.enabled,
|
||||
message: parsed.message,
|
||||
ctaLabel: typeof parsed.ctaLabel === "string" ? parsed.ctaLabel : undefined,
|
||||
ctaHref: typeof parsed.ctaHref === "string" ? parsed.ctaHref : undefined,
|
||||
}
|
||||
} catch {
|
||||
return null
|
||||
}
|
||||
}
|
||||
|
||||
export async function isAdminSelfRegistrationEnabled(): Promise<boolean> {
|
||||
try {
|
||||
const setting = await db.systemSetting.findUnique({
|
||||
@@ -54,3 +87,30 @@ export async function setAdminSelfRegistrationEnabled(enabled: boolean): Promise
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
export async function getPublicHeaderBanner(): Promise<PublicHeaderBanner | null> {
|
||||
try {
|
||||
const setting = await db.systemSetting.findUnique({
|
||||
where: { key: PUBLIC_HEADER_BANNER_KEY },
|
||||
select: { value: true },
|
||||
})
|
||||
|
||||
if (!setting) {
|
||||
return null
|
||||
}
|
||||
|
||||
const parsed = parsePublicHeaderBanner(setting.value)
|
||||
|
||||
if (!parsed || !parsed.enabled) {
|
||||
return null
|
||||
}
|
||||
|
||||
return {
|
||||
message: parsed.message,
|
||||
ctaLabel: parsed.ctaLabel,
|
||||
ctaHref: parsed.ctaHref,
|
||||
}
|
||||
} catch {
|
||||
return null
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user