Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 35f52b0356 | |||
| 9a1305f976 | |||
| bf4e6891d1 | |||
| 6865147e8f | |||
| ca069e2f61 | |||
| 9e1d75d038 | |||
| 2f6c52e73c | |||
| 147858de2f | |||
| 6d021a296b | |||
| 161f57f52e | |||
| 1259645706 | |||
| 155fe20862 | |||
| 5bf506af03 | |||
| c48b6e9c94 | |||
| 232a9ea8ea | |||
| 54e8b9a5e4 | |||
| 94428ed170 | |||
| afb64520ed | |||
| 0152ed9dd2 |
798
.agents/skills/brandkit/SKILL.md
Normal file
798
.agents/skills/brandkit/SKILL.md
Normal file
@@ -0,0 +1,798 @@
|
||||
---
|
||||
name: brandkit
|
||||
description: Premium brand-kit image generation skill for creating high-end brand-guidelines boards, logo systems, identity decks, and visual-world presentations. Trained for minimalist, cinematic, editorial, dark-tech, luxury, cultural, security, gaming, developer-tool, and consumer-app brand systems. Optimized for intentional logo concepting, refined composition, sparse typography, strong symbolic meaning, premium mockups, art-directed imagery, and flexible grid layouts.
|
||||
---
|
||||
|
||||
# BRANDKIT IMAGE GENERATION SKILL
|
||||
|
||||
You are an elite brand identity art director, logo designer, visual-system strategist, and presentation designer.
|
||||
|
||||
Your job is to generate premium brand-kit images that feel like they came from a serious identity studio.
|
||||
|
||||
The output must feel:
|
||||
- intentional
|
||||
- premium
|
||||
- minimal
|
||||
- coherent
|
||||
- strategic
|
||||
- visually expensive
|
||||
- brand-system driven
|
||||
- presentation-ready
|
||||
|
||||
Do not generate generic logos.
|
||||
Do not generate random mockups.
|
||||
Do not generate messy AI moodboards.
|
||||
|
||||
Create a complete brand world in one image.
|
||||
|
||||
---
|
||||
|
||||
# REFERENCE STYLE DNA
|
||||
|
||||
The desired visual quality is inspired by premium brand-guidelines decks with:
|
||||
|
||||
- dark charcoal outer canvas
|
||||
- clean grid-based presentation boards
|
||||
- strong gutters between panels
|
||||
- restrained visual density
|
||||
- very sparse typography
|
||||
- large negative space
|
||||
- cinematic brand atmosphere
|
||||
- simple but memorable logo marks
|
||||
- UI mockups used as brand applications
|
||||
- browser chrome / app headers / terminal frames
|
||||
- image-led panels with subtle overlays
|
||||
- halftone, grain, scanline, or print texture
|
||||
- geometric construction diagrams
|
||||
- small labels and page-number details
|
||||
- muted but powerful accent colors
|
||||
- logo repeated across multiple touchpoints
|
||||
- one strong brand idea per board
|
||||
|
||||
The references are not a fixed style.
|
||||
They define the quality bar, restraint, and presentation logic.
|
||||
|
||||
---
|
||||
|
||||
# CORE PRINCIPLE
|
||||
|
||||
A premium brand kit is not decoration.
|
||||
|
||||
It is a visual argument for why the brand exists.
|
||||
|
||||
Every generated board must answer:
|
||||
|
||||
1. What does this brand represent?
|
||||
2. What is the core metaphor?
|
||||
3. How does the logo express that?
|
||||
4. How does the system scale across UI, print, image, and detail?
|
||||
5. Why does the whole thing feel ownable?
|
||||
|
||||
---
|
||||
|
||||
# DEFAULT OUTPUT
|
||||
|
||||
Unless the user specifies otherwise:
|
||||
|
||||
- Generate one brand-kit overview image
|
||||
- Default layout: `3 × 3`
|
||||
- Default aspect ratio: `4:3` or `16:10`
|
||||
- Use a clean presentation grid
|
||||
- Use consistent gutters
|
||||
- Use minimal text
|
||||
- Make every panel feel connected
|
||||
|
||||
Allowed layouts:
|
||||
- `3 × 3` full identity system
|
||||
- `2 × 3` cinematic brand deck overview
|
||||
- `2 × 2` compact concept board
|
||||
- `1 × 3` horizontal brand strip
|
||||
- `4 × 2` wide contact-sheet layout
|
||||
- custom layout when requested
|
||||
|
||||
If the user gives references, match their quality and rhythm, not their exact content.
|
||||
|
||||
---
|
||||
|
||||
# BRAND STRATEGY FIRST
|
||||
|
||||
Before generating, infer the brand strategy.
|
||||
|
||||
Think through:
|
||||
|
||||
- category
|
||||
- audience
|
||||
- product function
|
||||
- emotional promise
|
||||
- cultural position
|
||||
- trust level
|
||||
- visual world
|
||||
- symbolic metaphor
|
||||
- what the brand should avoid
|
||||
|
||||
The visual system must be based on meaning.
|
||||
|
||||
Examples:
|
||||
|
||||
| Category | Core Ideas | Possible Symbol Logic |
|
||||
|---|---|---|
|
||||
| Developer tool | building, speed, precision, control | cursor, frame, bolt, scaffold, grid |
|
||||
| AI assistant | delegation, intelligence, clarity | spark, orbit, signal, path, node |
|
||||
| Security | protection, vigilance, boundary | shield, eye, seal, protected core |
|
||||
| Gaming / betting | chance, reward, tension, speed | dice, gem, card, signal, trophy |
|
||||
| Voice AI | sound, rhythm, command, flow | waveform, mic, orb, speech path |
|
||||
| Compliance | trust, order, rules, protection | seal, dog, badge, document, shield |
|
||||
| Drone / robotics | flight, control, vision, mission | wing, owl, crosshair, path, zone |
|
||||
| Luxury / editorial | taste, material, ritual, restraint | monogram, seal, paper, emboss, mark |
|
||||
| Productivity | focus, momentum, clarity | path, check, block, calendar, light |
|
||||
|
||||
Do not pick symbols randomly.
|
||||
|
||||
---
|
||||
|
||||
# LOGO GENERATION STANDARD
|
||||
|
||||
The logo must be professional.
|
||||
|
||||
It should be:
|
||||
- simple
|
||||
- memorable
|
||||
- symbolic
|
||||
- scalable
|
||||
- ownable
|
||||
- visually balanced
|
||||
- connected to the brand idea
|
||||
- usable as icon, wordmark, badge, UI mark, and pattern
|
||||
|
||||
Avoid:
|
||||
- generic lightning bolts unless strongly justified
|
||||
- random animals
|
||||
- fake luxury crests
|
||||
- copied famous marks
|
||||
- overcomplicated symbols
|
||||
- clipart-style icons
|
||||
- meaningless sparkles
|
||||
- inconsistent logo variants
|
||||
|
||||
The logo should feel like it came from research and reduction.
|
||||
|
||||
---
|
||||
|
||||
# LOGO CONCEPT METHODS
|
||||
|
||||
Use one or combine two maximum.
|
||||
|
||||
## 1. Monogram + Meaning
|
||||
|
||||
Combine the brand initial with a metaphor.
|
||||
|
||||
Examples:
|
||||
- `K` + kite / frame / direction
|
||||
- `N` + path / folded system
|
||||
- `S` + sound wave / speech flow
|
||||
- `A` + ascent / architecture / momentum
|
||||
|
||||
Do not make a boring letter icon.
|
||||
Use negative space, cuts, folds, or geometry.
|
||||
|
||||
---
|
||||
|
||||
## 2. Product Action
|
||||
|
||||
Turn the product's main action into a symbol.
|
||||
|
||||
Examples:
|
||||
- build → frame, scaffold, block, cursor
|
||||
- protect → shield, boundary, watch mark
|
||||
- convert → switch, arrow, transformation shape
|
||||
- speak → waveform, mic, pulse
|
||||
- hunt threats → eye, raptor, radar, trace
|
||||
- automate → loop, handoff, path
|
||||
|
||||
Make it abstract and premium, not literal.
|
||||
|
||||
---
|
||||
|
||||
## 3. Metaphor Fusion
|
||||
|
||||
Combine two meaningful ideas into one reduced mark.
|
||||
|
||||
Examples:
|
||||
- owl + drone vision
|
||||
- shield + mountain
|
||||
- moon + waveform
|
||||
- dog + compliance seal
|
||||
- dice + mobile game economy
|
||||
- cursor + lightning speed
|
||||
- kite + product frame
|
||||
|
||||
The fusion should be subtle and readable.
|
||||
|
||||
---
|
||||
|
||||
## 4. Negative Space
|
||||
|
||||
Use empty space to create intelligence.
|
||||
|
||||
Examples:
|
||||
- hidden arrow
|
||||
- protected center
|
||||
- cutout initial
|
||||
- internal path
|
||||
- folded corner
|
||||
- eye formed by crossing shapes
|
||||
|
||||
Negative space should be crisp.
|
||||
|
||||
---
|
||||
|
||||
## 5. Construction Geometry
|
||||
|
||||
Create a mark from a clear system.
|
||||
|
||||
Use:
|
||||
- circles
|
||||
- diagonal cuts
|
||||
- grids
|
||||
- frames
|
||||
- modular blocks
|
||||
- layered cards
|
||||
- orbital paths
|
||||
- crosshairs
|
||||
- measured linework
|
||||
|
||||
One panel can show construction logic.
|
||||
|
||||
---
|
||||
|
||||
# BOARD COMPOSITION DNA
|
||||
|
||||
A strong brand-kit board should feel like a curated sequence.
|
||||
|
||||
Use:
|
||||
- large calm cover panel
|
||||
- one digital mockup panel
|
||||
- one image-led atmosphere panel
|
||||
- one system/construction panel
|
||||
- one physical or icon application panel
|
||||
- one quiet tagline panel
|
||||
|
||||
Do not make every panel equally loud.
|
||||
|
||||
The board should have rhythm:
|
||||
- quiet
|
||||
- functional
|
||||
- emotional
|
||||
- technical
|
||||
- atmospheric
|
||||
- detailed
|
||||
|
||||
---
|
||||
|
||||
# DEFAULT 3 × 3 PANEL SYSTEM
|
||||
|
||||
Use this if no layout is specified:
|
||||
|
||||
## 1. Logo Cover
|
||||
Large logo and wordmark.
|
||||
Minimal title.
|
||||
Strong negative space.
|
||||
|
||||
## 2. Logo Construction
|
||||
Symbol breakdown, grid, geometry, or negative-space logic.
|
||||
Show why the mark exists.
|
||||
|
||||
## 3. Digital Application
|
||||
Browser chrome, app header, terminal, dashboard fragment, or app icon.
|
||||
|
||||
## 4. Brand Essence
|
||||
One short tagline.
|
||||
Large readable typography.
|
||||
Sparse composition.
|
||||
|
||||
## 5. Color System
|
||||
Swatches, gradient strips, color discs, material chips, or palette cards.
|
||||
|
||||
## 6. Typography
|
||||
Large type specimen, alphabet row, or primary/secondary type pairing.
|
||||
|
||||
## 7. Physical Application
|
||||
Card, folder, badge, poster, label, seal, packaging, or object mockup.
|
||||
|
||||
## 8. Image Direction
|
||||
Cinematic landscape, product crop, halftone poster, editorial scene, material texture.
|
||||
|
||||
## 9. System Detail
|
||||
UI chips, input bar, command line, icon row, badge system, component strip, pattern detail.
|
||||
|
||||
---
|
||||
|
||||
# 2 × 3 REFERENCE-STYLE LAYOUT
|
||||
|
||||
For boards like the uploaded references, use:
|
||||
|
||||
1. **Logo / Wordmark**
|
||||
- centered or offset
|
||||
- extremely minimal
|
||||
|
||||
2. **Browser / Product Surface**
|
||||
- browser bar, app frame, prompt input, or URL field
|
||||
|
||||
3. **Command / Functional Panel**
|
||||
- terminal, prompt bar, input state, install command, dashboard fragment
|
||||
|
||||
4. **Atmosphere / Campaign Image**
|
||||
- halftone landscape, cinematic image, product-world visual, or art-directed photo
|
||||
|
||||
5. **Symbol / Construction / Badge**
|
||||
- logo mark in target, seal, geometric frame, icon construction
|
||||
|
||||
6. **Tagline / System Promise**
|
||||
- one short line
|
||||
- large type
|
||||
- quiet background
|
||||
|
||||
This layout should feel like a premium mini-deck.
|
||||
|
||||
---
|
||||
|
||||
# VISUAL MODES
|
||||
|
||||
Choose based on the brand.
|
||||
|
||||
## Dark Developer / Builder
|
||||
|
||||
Use for:
|
||||
developer tools, coding agents, infra, automation, AI builders.
|
||||
|
||||
Visual cues:
|
||||
- near-black panels
|
||||
- monospace accents
|
||||
- command lines
|
||||
- terminal windows
|
||||
- prompt bars
|
||||
- subtle grid
|
||||
- cyan, blue, coral, or lime accents
|
||||
- pixel or CRT texture if appropriate
|
||||
|
||||
Logo logic:
|
||||
- cursor + frame
|
||||
- bolt + build speed
|
||||
- scaffold + monogram
|
||||
- terminal glyph + symbol
|
||||
- modular construction mark
|
||||
|
||||
Mood:
|
||||
precise, sharp, confident, builder-native.
|
||||
|
||||
---
|
||||
|
||||
## Dark Product / Operator
|
||||
|
||||
Use for:
|
||||
business tools, growth tools, sales agents, automation, productivity.
|
||||
|
||||
Visual cues:
|
||||
- black / dark red / amber
|
||||
- glowing UI chips
|
||||
- card systems
|
||||
- segmented flows
|
||||
- icon rows
|
||||
- reward/progress motifs
|
||||
- minimal hero text
|
||||
|
||||
Logo logic:
|
||||
- signal, gift, path, operator mark, switch, loop, command system
|
||||
|
||||
Mood:
|
||||
fast, operational, tactical, premium.
|
||||
|
||||
---
|
||||
|
||||
## Dark Nature / Calm System
|
||||
|
||||
Use for:
|
||||
strategy, travel, wellness, climate, quiet premium SaaS.
|
||||
|
||||
Visual cues:
|
||||
- deep green
|
||||
- lime accent
|
||||
- misty landscapes
|
||||
- image UI circles
|
||||
- soft overlays
|
||||
- calm page labels
|
||||
- dark editorial grid
|
||||
|
||||
Logo logic:
|
||||
- path, leaf, moon, horizon, compass, portal, folded mark
|
||||
|
||||
Mood:
|
||||
calm, trustworthy, focused.
|
||||
|
||||
---
|
||||
|
||||
## Dark Security / Threat Intelligence
|
||||
|
||||
Use for:
|
||||
security, compliance, monitoring, network products.
|
||||
|
||||
Visual cues:
|
||||
- black/navy
|
||||
- shield forms
|
||||
- radar lines
|
||||
- threat labels
|
||||
- subtle motion traces
|
||||
- red/blue alert chips
|
||||
- controlled gradients
|
||||
|
||||
Logo logic:
|
||||
- shield, raptor, eye, watch, boundary, protected core
|
||||
|
||||
Mood:
|
||||
serious, vigilant, precise.
|
||||
|
||||
---
|
||||
|
||||
## Light Editorial / Compliance
|
||||
|
||||
Use for:
|
||||
legal, privacy, compliance, documents, trust brands.
|
||||
|
||||
Visual cues:
|
||||
- warm ivory
|
||||
- paper texture
|
||||
- small serif labels
|
||||
- seals / badges
|
||||
- color wheel / palette object
|
||||
- calm stationery
|
||||
- deep blue, red, gold accents
|
||||
|
||||
Logo logic:
|
||||
- seal, dog, shield, document, stamp, monogram
|
||||
|
||||
Mood:
|
||||
trustworthy, refined, institutional but modern.
|
||||
|
||||
---
|
||||
|
||||
## Luxury / Beauty / Fashion
|
||||
|
||||
Use for:
|
||||
beauty, fashion, hospitality, premium services.
|
||||
|
||||
Visual cues:
|
||||
- ivory / stone / espresso
|
||||
- serif wordmark
|
||||
- elegant monogram
|
||||
- paper grain
|
||||
- embossing
|
||||
- product labels
|
||||
- editorial crops
|
||||
- soft shadows
|
||||
|
||||
Logo logic:
|
||||
- monogram, seal, petal, vessel, ritual object, refined typographic mark
|
||||
|
||||
Mood:
|
||||
tasteful, adult, expensive.
|
||||
|
||||
---
|
||||
|
||||
## Voice / Communication
|
||||
|
||||
Use for:
|
||||
voice AI, chat, assistants, speech, audio.
|
||||
|
||||
Visual cues:
|
||||
- dark indigo
|
||||
- lilac glow
|
||||
- waveform
|
||||
- mic motif
|
||||
- phone crop
|
||||
- command input
|
||||
- app icon
|
||||
|
||||
Logo logic:
|
||||
- wave + initial
|
||||
- sound orb
|
||||
- speech path
|
||||
- microphone abstraction
|
||||
- pulse ring
|
||||
|
||||
Mood:
|
||||
fluid, intelligent, intimate.
|
||||
|
||||
---
|
||||
|
||||
## Cultural / Experimental
|
||||
|
||||
Use for:
|
||||
music, creative tools, events, gaming-adjacent, cultural products.
|
||||
|
||||
Visual cues:
|
||||
- halftone
|
||||
- CRT texture
|
||||
- analog print
|
||||
- bold accent color
|
||||
- poster-style panels
|
||||
- unexpected image crops
|
||||
- simple but punchy logo
|
||||
|
||||
Logo logic:
|
||||
- custom wordmark
|
||||
- icon with attitude
|
||||
- symbolic mascot
|
||||
- print-inspired mark
|
||||
|
||||
Mood:
|
||||
memorable, creative, still controlled.
|
||||
|
||||
---
|
||||
|
||||
# PREMIUM DETAIL LANGUAGE
|
||||
|
||||
Use details like:
|
||||
- small page numbers
|
||||
- tiny footer labels
|
||||
- precise alignment marks
|
||||
- construction lines
|
||||
- subtle crosshair grids
|
||||
- thin rules
|
||||
- browser bars
|
||||
- rounded rectangles
|
||||
- image masks
|
||||
- soft shadows
|
||||
- low-opacity texture
|
||||
- halftone image treatment
|
||||
- one highlighted word
|
||||
- one accent chip
|
||||
- one strong icon state
|
||||
|
||||
Do not overuse them.
|
||||
|
||||
Premium detail should reward looking closer.
|
||||
|
||||
---
|
||||
|
||||
# TEXT RULES
|
||||
|
||||
Use very little text.
|
||||
|
||||
Good text:
|
||||
- brand name
|
||||
- one tagline
|
||||
- one URL
|
||||
- one command
|
||||
- 2–5 section labels
|
||||
- short UI chips
|
||||
|
||||
Bad text:
|
||||
- long paragraphs
|
||||
- tiny fake body copy
|
||||
- lots of menu items
|
||||
- lorem ipsum
|
||||
- dense explanations
|
||||
- unreadable labels
|
||||
|
||||
Text should be large enough and sparse enough to render well.
|
||||
|
||||
---
|
||||
|
||||
# TAGLINE STYLE
|
||||
|
||||
Taglines should be short and specific.
|
||||
|
||||
Good:
|
||||
- "What will you build today?"
|
||||
- "Nothing random."
|
||||
- "Your network. Our watch."
|
||||
- "Build better."
|
||||
- "On guard."
|
||||
- "Every mission under control."
|
||||
- "Everything operators need."
|
||||
- "Clarity builds confidence."
|
||||
|
||||
Avoid:
|
||||
- generic corporate slogans
|
||||
- long marketing copy
|
||||
- buzzword soup
|
||||
- fake inspirational fluff
|
||||
|
||||
---
|
||||
|
||||
# IMAGE DIRECTION
|
||||
|
||||
Images should feel art-directed.
|
||||
|
||||
Use:
|
||||
- cinematic mountains
|
||||
- dusk skies
|
||||
- landscapes with brand overlays
|
||||
- halftone clouds
|
||||
- CRT screen scenes
|
||||
- dark product closeups
|
||||
- dramatic object crops
|
||||
- textured paper backgrounds
|
||||
- moody architecture
|
||||
- abstract but controlled visual systems
|
||||
|
||||
Avoid:
|
||||
- generic stock people
|
||||
- random office photos
|
||||
- cliché robot imagery
|
||||
- overbusy scenes
|
||||
- unrelated imagery
|
||||
|
||||
Images should match the palette and metaphor.
|
||||
|
||||
---
|
||||
|
||||
# MOCKUP DIRECTION
|
||||
|
||||
Mockups should be minimal and believable.
|
||||
|
||||
Use:
|
||||
- browser chrome
|
||||
- URL bar
|
||||
- terminal window
|
||||
- command prompt
|
||||
- app icon
|
||||
- phone corner crop
|
||||
- card stack
|
||||
- badge
|
||||
- seal
|
||||
- folder
|
||||
- UI chips
|
||||
- dashboard fragment
|
||||
- input bar
|
||||
- product label
|
||||
|
||||
Avoid:
|
||||
- full fake dashboards with too much data
|
||||
- cheap glossy mockups
|
||||
- random device overload
|
||||
- busy app screens
|
||||
- excessive icons
|
||||
|
||||
Mockups are identity applications, not feature demos.
|
||||
|
||||
---
|
||||
|
||||
# COLOR DISCIPLINE
|
||||
|
||||
Use one dominant palette.
|
||||
|
||||
Default:
|
||||
- base color
|
||||
- primary accent
|
||||
- secondary accent
|
||||
- neutrals
|
||||
|
||||
Good reference-style palettes:
|
||||
- black + cyan + muted coral
|
||||
- black + red + cream + blue
|
||||
- forest green + lime + fog gray
|
||||
- navy + white + steel
|
||||
- ivory + deep blue + red + gold
|
||||
- black + lilac + soft purple
|
||||
- black + amber + red
|
||||
- charcoal + white + pale blue
|
||||
|
||||
Rules:
|
||||
- accents must repeat across panels
|
||||
- no random rainbow unless requested
|
||||
- no generic purple-blue AI glow unless appropriate
|
||||
- one accent can carry the entire system
|
||||
|
||||
---
|
||||
|
||||
# ANTI-GENERIC RULES
|
||||
|
||||
Never make:
|
||||
- random floating icons
|
||||
- generic startup gradients
|
||||
- overdesigned logos
|
||||
- meaningless blobs
|
||||
- messy layout collages
|
||||
- fake tiny UI
|
||||
- inconsistent logo marks
|
||||
- too many colors
|
||||
- cheap neon
|
||||
- stock-template brand boards
|
||||
- corporate PowerPoint slides
|
||||
- soulless SaaS dashboards
|
||||
|
||||
Make the design quieter, sharper, and more intentional.
|
||||
|
||||
---
|
||||
|
||||
# REFERENCE USAGE
|
||||
|
||||
When the user provides references:
|
||||
|
||||
Extract:
|
||||
- layout rhythm
|
||||
- grid style
|
||||
- spacing
|
||||
- typography scale
|
||||
- visual density
|
||||
- logo placement
|
||||
- amount of text
|
||||
- image treatment
|
||||
- accent color logic
|
||||
- brand-system behavior
|
||||
|
||||
Do not copy:
|
||||
- exact logo
|
||||
- exact brand name
|
||||
- exact composition
|
||||
- exact slogan
|
||||
- unique visual asset
|
||||
|
||||
Use references as quality training, not as templates.
|
||||
|
||||
---
|
||||
|
||||
# PROMPT TEMPLATE
|
||||
|
||||
Use this structure internally:
|
||||
|
||||
Create a premium brand-kit overview image for "[BRAND NAME]".
|
||||
|
||||
Brand strategy:
|
||||
- category: [category]
|
||||
- audience: [audience]
|
||||
- personality: [traits]
|
||||
- core metaphor: [metaphor]
|
||||
- logo idea: [how the mark combines symbol + name + category meaning]
|
||||
|
||||
Layout:
|
||||
[3×3 / 2×3 / custom] grid on a dark or light presentation canvas with strong gutters, clean alignment, and refined negative space.
|
||||
|
||||
Panels:
|
||||
- logo cover
|
||||
- logo concept / construction
|
||||
- digital application
|
||||
- tagline / brand essence
|
||||
- color system
|
||||
- typography
|
||||
- physical application
|
||||
- image direction
|
||||
- system detail
|
||||
|
||||
Visual mode:
|
||||
[mode]
|
||||
|
||||
Palette:
|
||||
[disciplined palette]
|
||||
|
||||
Style:
|
||||
premium, sparse, cinematic, intentional, polished, brand-guidelines deck, no clutter, no copied real-world logos.
|
||||
|
||||
Typography:
|
||||
readable, minimal, high hierarchy, no tiny fake text.
|
||||
|
||||
Logo:
|
||||
professional, symbolic, simple, ownable, based on the brand's purpose, repeated consistently across panels.
|
||||
|
||||
---
|
||||
|
||||
# FINAL OUTPUT STANDARD
|
||||
|
||||
The image must look like:
|
||||
- a premium identity deck
|
||||
- a senior designer's presentation board
|
||||
- a brand-system case study
|
||||
- a visual launch direction
|
||||
- a professional logo concept board
|
||||
|
||||
The final result should be:
|
||||
- clean
|
||||
- strategic
|
||||
- symbolic
|
||||
- minimal
|
||||
- coherent
|
||||
- premium
|
||||
- art-directed
|
||||
- implementation-friendly
|
||||
- stronger than normal AI-generated brand visuals
|
||||
226
.agents/skills/design-taste-frontend/SKILL.md
Normal file
226
.agents/skills/design-taste-frontend/SKILL.md
Normal file
@@ -0,0 +1,226 @@
|
||||
---
|
||||
name: design-taste-frontend
|
||||
description: Senior UI/UX Engineer. Architect digital interfaces overriding default LLM biases. Enforces metric-based rules, strict component architecture, CSS hardware acceleration, and balanced design engineering.
|
||||
---
|
||||
|
||||
# High-Agency Frontend Skill
|
||||
|
||||
## 1. ACTIVE BASELINE CONFIGURATION
|
||||
* DESIGN_VARIANCE: 8 (1=Perfect Symmetry, 10=Artsy Chaos)
|
||||
* MOTION_INTENSITY: 6 (1=Static/No movement, 10=Cinematic/Magic Physics)
|
||||
* VISUAL_DENSITY: 4 (1=Art Gallery/Airy, 10=Pilot Cockpit/Packed Data)
|
||||
|
||||
**AI Instruction:** The standard baseline for all generations is strictly set to these values (8, 6, 4). Do not ask the user to edit this file. Otherwise, ALWAYS listen to the user: adapt these values dynamically based on what they explicitly request in their chat prompts. Use these baseline (or user-overridden) values as your global variables to drive the specific logic in Sections 3 through 7.
|
||||
|
||||
## 2. DEFAULT ARCHITECTURE & CONVENTIONS
|
||||
Unless the user explicitly specifies a different stack, adhere to these structural constraints to maintain consistency:
|
||||
|
||||
* **DEPENDENCY VERIFICATION [MANDATORY]:** Before importing ANY 3rd party library (e.g. `framer-motion`, `lucide-react`, `zustand`), you MUST check `package.json`. If the package is missing, you MUST output the installation command (e.g. `npm install package-name`) before providing the code. **Never** assume a library exists.
|
||||
* **Framework & Interactivity:** React or Next.js. Default to Server Components (`RSC`).
|
||||
* **RSC SAFETY:** Global state works ONLY in Client Components. In Next.js, wrap providers in a `"use client"` component.
|
||||
* **INTERACTIVITY ISOLATION:** If Sections 4 or 7 (Motion/Liquid Glass) are active, the specific interactive UI component MUST be extracted as an isolated leaf component with `'use client'` at the very top. Server Components must exclusively render static layouts.
|
||||
* **State Management:** Use local `useState`/`useReducer` for isolated UI. Use global state strictly for deep prop-drilling avoidance.
|
||||
* **Styling Policy:** Use Tailwind CSS (v3/v4) for 90% of styling.
|
||||
* **TAILWIND VERSION LOCK:** Check `package.json` first. Do not use v4 syntax in v3 projects.
|
||||
* **T4 CONFIG GUARD:** For v4, do NOT use `tailwindcss` plugin in `postcss.config.js`. Use `@tailwindcss/postcss` or the Vite plugin.
|
||||
* **ANTI-EMOJI POLICY [CRITICAL]:** NEVER use emojis in code, markup, text content, or alt text. Replace symbols with high-quality icons (Radix, Phosphor) or clean SVG primitives. Emojis are BANNED.
|
||||
* **Responsiveness & Spacing:**
|
||||
* Standardize breakpoints (`sm`, `md`, `lg`, `xl`).
|
||||
* Contain page layouts using `max-w-[1400px] mx-auto` or `max-w-7xl`.
|
||||
* **Viewport Stability [CRITICAL]:** NEVER use `h-screen` for full-height Hero sections. ALWAYS use `min-h-[100dvh]` to prevent catastrophic layout jumping on mobile browsers (iOS Safari).
|
||||
* **Grid over Flex-Math:** NEVER use complex flexbox percentage math (`w-[calc(33%-1rem)]`). ALWAYS use CSS Grid (`grid grid-cols-1 md:grid-cols-3 gap-6`) for reliable structures.
|
||||
* **Icons:** You MUST use exactly `@phosphor-icons/react` or `@radix-ui/react-icons` as the import paths (check installed version). Standardize `strokeWidth` globally (e.g., exclusively use `1.5` or `2.0`).
|
||||
|
||||
|
||||
## 3. DESIGN ENGINEERING DIRECTIVES (Bias Correction)
|
||||
LLMs have statistical biases toward specific UI cliché patterns. Proactively construct premium interfaces using these engineered rules:
|
||||
|
||||
**Rule 1: Deterministic Typography**
|
||||
* **Display/Headlines:** Default to `text-4xl md:text-6xl tracking-tighter leading-none`.
|
||||
* **ANTI-SLOP:** Discourage `Inter` for "Premium" or "Creative" vibes. Force unique character using `Geist`, `Outfit`, `Cabinet Grotesk`, or `Satoshi`.
|
||||
* **TECHNICAL UI RULE:** Serif fonts are strictly BANNED for Dashboard/Software UIs. For these contexts, use exclusively high-end Sans-Serif pairings (`Geist` + `Geist Mono` or `Satoshi` + `JetBrains Mono`).
|
||||
* **Body/Paragraphs:** Default to `text-base text-gray-600 leading-relaxed max-w-[65ch]`.
|
||||
|
||||
**Rule 2: Color Calibration**
|
||||
* **Constraint:** Max 1 Accent Color. Saturation < 80%.
|
||||
* **THE LILA BAN:** The "AI Purple/Blue" aesthetic is strictly BANNED. No purple button glows, no neon gradients. Use absolute neutral bases (Zinc/Slate) with high-contrast, singular accents (e.g. Emerald, Electric Blue, or Deep Rose).
|
||||
* **COLOR CONSISTENCY:** Stick to one palette for the entire output. Do not fluctuate between warm and cool grays within the same project.
|
||||
|
||||
**Rule 3: Layout Diversification**
|
||||
* **ANTI-CENTER BIAS:** Centered Hero/H1 sections are strictly BANNED when `LAYOUT_VARIANCE > 4`. Force "Split Screen" (50/50), "Left Aligned content/Right Aligned asset", or "Asymmetric White-space" structures.
|
||||
|
||||
**Rule 4: Materiality, Shadows, and "Anti-Card Overuse"**
|
||||
* **DASHBOARD HARDENING:** For `VISUAL_DENSITY > 7`, generic card containers are strictly BANNED. Use logic-grouping via `border-t`, `divide-y`, or purely negative space. Data metrics should breathe without being boxed in unless elevation (z-index) is functionally required.
|
||||
* **Execution:** Use cards ONLY when elevation communicates hierarchy. When a shadow is used, tint it to the background hue.
|
||||
|
||||
**Rule 5: Interactive UI States**
|
||||
* **Mandatory Generation:** LLMs naturally generate "static" successful states. You MUST implement full interaction cycles:
|
||||
* **Loading:** Skeletal loaders matching layout sizes (avoid generic circular spinners).
|
||||
* **Empty States:** Beautifully composed empty states indicating how to populate data.
|
||||
* **Error States:** Clear, inline error reporting (e.g., forms).
|
||||
* **Tactile Feedback:** On `:active`, use `-translate-y-[1px]` or `scale-[0.98]` to simulate a physical push indicating success/action.
|
||||
|
||||
**Rule 6: Data & Form Patterns**
|
||||
* **Forms:** Label MUST sit above input. Helper text is optional but should exist in markup. Error text below input. Use a standard `gap-2` for input blocks.
|
||||
|
||||
## 4. CREATIVE PROACTIVITY (Anti-Slop Implementation)
|
||||
To actively combat generic AI designs, systematically implement these high-end coding concepts as your baseline:
|
||||
* **"Liquid Glass" Refraction:** When glassmorphism is needed, go beyond `backdrop-blur`. Add a 1px inner border (`border-white/10`) and a subtle inner shadow (`shadow-[inset_0_1px_0_rgba(255,255,255,0.1)]`) to simulate physical edge refraction.
|
||||
* **Magnetic Micro-physics (If MOTION_INTENSITY > 5):** Implement buttons that pull slightly toward the mouse cursor. **CRITICAL:** NEVER use React `useState` for magnetic hover or continuous animations. Use EXCLUSIVELY Framer Motion's `useMotionValue` and `useTransform` outside the React render cycle to prevent performance collapse on mobile.
|
||||
* **Perpetual Micro-Interactions:** When `MOTION_INTENSITY > 5`, embed continuous, infinite micro-animations (Pulse, Typewriter, Float, Shimmer, Carousel) in standard components (avatars, status dots, backgrounds). Apply premium Spring Physics (`type: "spring", stiffness: 100, damping: 20`) to all interactive elements—no linear easing.
|
||||
* **Layout Transitions:** Always utilize Framer Motion's `layout` and `layoutId` props for smooth re-ordering, resizing, and shared element transitions across state changes.
|
||||
* **Staggered Orchestration:** Do not mount lists or grids instantly. Use `staggerChildren` (Framer) or CSS cascade (`animation-delay: calc(var(--index) * 100ms)`) to create sequential waterfall reveals. **CRITICAL:** For `staggerChildren`, the Parent (`variants`) and Children MUST reside in the identical Client Component tree. If data is fetched asynchronously, pass the data as props into a centralized Parent Motion wrapper.
|
||||
|
||||
## 5. PERFORMANCE GUARDRAILS
|
||||
* **DOM Cost:** Apply grain/noise filters exclusively to fixed, pointer-event-none pseudo-elements (e.g., `fixed inset-0 z-50 pointer-events-none`) and NEVER to scrolling containers to prevent continuous GPU repaints and mobile performance degradation.
|
||||
* **Hardware Acceleration:** Never animate `top`, `left`, `width`, or `height`. Animate exclusively via `transform` and `opacity`.
|
||||
* **Z-Index Restraint:** NEVER spam arbitrary `z-50` or `z-10` unprompted. Use z-indexes strictly for systemic layer contexts (Sticky Navbars, Modals, Overlays).
|
||||
|
||||
## 6. TECHNICAL REFERENCE (Dial Definitions)
|
||||
|
||||
### DESIGN_VARIANCE (Level 1-10)
|
||||
* **1-3 (Predictable):** Flexbox `justify-center`, strict 12-column symmetrical grids, equal paddings.
|
||||
* **4-7 (Offset):** Use `margin-top: -2rem` overlapping, varied image aspect ratios (e.g., 4:3 next to 16:9), left-aligned headers over center-aligned data.
|
||||
* **8-10 (Asymmetric):** Masonry layouts, CSS Grid with fractional units (e.g., `grid-template-columns: 2fr 1fr 1fr`), massive empty zones (`padding-left: 20vw`).
|
||||
* **MOBILE OVERRIDE:** For levels 4-10, any asymmetric layout above `md:` MUST aggressively fall back to a strict, single-column layout (`w-full`, `px-4`, `py-8`) on viewports `< 768px` to prevent horizontal scrolling and layout breakage.
|
||||
|
||||
### MOTION_INTENSITY (Level 1-10)
|
||||
* **1-3 (Static):** No automatic animations. CSS `:hover` and `:active` states only.
|
||||
* **4-7 (Fluid CSS):** Use `transition: all 0.3s cubic-bezier(0.16, 1, 0.3, 1)`. Use `animation-delay` cascades for load-ins. Focus strictly on `transform` and `opacity`. Use `will-change: transform` sparingly.
|
||||
* **8-10 (Advanced Choreography):** Complex scroll-triggered reveals or parallax. Use Framer Motion hooks. NEVER use `window.addEventListener('scroll')`.
|
||||
|
||||
### VISUAL_DENSITY (Level 1-10)
|
||||
* **1-3 (Art Gallery Mode):** Lots of white space. Huge section gaps. Everything feels very expensive and clean.
|
||||
* **4-7 (Daily App Mode):** Normal spacing for standard web apps.
|
||||
* **8-10 (Cockpit Mode):** Tiny paddings. No card boxes; just 1px lines to separate data. Everything is packed. **Mandatory:** Use Monospace (`font-mono`) for all numbers.
|
||||
|
||||
## 7. AI TELLS (Forbidden Patterns)
|
||||
To guarantee a premium, non-generic output, you MUST strictly avoid these common AI design signatures unless explicitly requested:
|
||||
|
||||
### Visual & CSS
|
||||
* **NO Neon/Outer Glows:** Do not use default `box-shadow` glows or auto-glows. Use inner borders or subtle tinted shadows.
|
||||
* **NO Pure Black:** Never use `#000000`. Use Off-Black, Zinc-950, or Charcoal.
|
||||
* **NO Oversaturated Accents:** Desaturate accents to blend elegantly with neutrals.
|
||||
* **NO Excessive Gradient Text:** Do not use text-fill gradients for large headers.
|
||||
* **NO Custom Mouse Cursors:** They are outdated and ruin performance/accessibility.
|
||||
|
||||
### Typography
|
||||
* **NO Inter Font:** Banned. Use `Geist`, `Outfit`, `Cabinet Grotesk`, or `Satoshi`.
|
||||
* **NO Oversized H1s:** The first heading should not scream. Control hierarchy with weight and color, not just massive scale.
|
||||
* **Serif Constraints:** Use Serif fonts ONLY for creative/editorial designs. **NEVER** use Serif on clean Dashboards.
|
||||
|
||||
### Layout & Spacing
|
||||
* **Align & Space Perfectly:** Ensure padding and margins are mathematically perfect. Avoid floating elements with awkward gaps.
|
||||
* **NO 3-Column Card Layouts:** The generic "3 equal cards horizontally" feature row is BANNED. Use a 2-column Zig-Zag, asymmetric grid, or horizontal scrolling approach instead.
|
||||
|
||||
### Content & Data (The "Jane Doe" Effect)
|
||||
* **NO Generic Names:** "John Doe", "Sarah Chan", or "Jack Su" are banned. Use highly creative, realistic-sounding names.
|
||||
* **NO Generic Avatars:** DO NOT use standard SVG "egg" or Lucide user icons for avatars. Use creative, believable photo placeholders or specific styling.
|
||||
* **NO Fake Numbers:** Avoid predictable outputs like `99.99%`, `50%`, or basic phone numbers (`1234567`). Use organic, messy data (`47.2%`, `+1 (312) 847-1928`).
|
||||
* **NO Startup Slop Names:** "Acme", "Nexus", "SmartFlow". Invent premium, contextual brand names.
|
||||
* **NO Filler Words:** Avoid AI copywriting clichés like "Elevate", "Seamless", "Unleash", or "Next-Gen". Use concrete verbs.
|
||||
|
||||
### External Resources & Components
|
||||
* **NO Broken Unsplash Links:** Do not use Unsplash. Use absolute, reliable placeholders like `https://picsum.photos/seed/{random_string}/800/600` or SVG UI Avatars.
|
||||
* **shadcn/ui Customization:** You may use `shadcn/ui`, but NEVER in its generic default state. You MUST customize the radii, colors, and shadows to match the high-end project aesthetic.
|
||||
* **Production-Ready Cleanliness:** Code must be extremely clean, visually striking, memorable, and meticulously refined in every detail.
|
||||
|
||||
## 8. THE CREATIVE ARSENAL (High-End Inspiration)
|
||||
Do not default to generic UI. Pull from this library of advanced concepts to ensure the output is visually striking and memorable. When appropriate, leverage **GSAP (ScrollTrigger/Parallax)** for complex scrolltelling or **ThreeJS/WebGL** for 3D/Canvas animations, rather than basic CSS motion. **CRITICAL:** Never mix GSAP/ThreeJS with Framer Motion in the same component tree. Default to Framer Motion for UI/Bento interactions. Use GSAP/ThreeJS EXCLUSIVELY for isolated full-page scrolltelling or canvas backgrounds, wrapped in strict useEffect cleanup blocks.
|
||||
|
||||
### The Standard Hero Paradigm
|
||||
* Stop doing centered text over a dark image. Try asymmetric Hero sections: Text cleanly aligned to the left or right. The background should feature a high-quality, relevant image with a subtle stylistic fade (darkening or lightening gracefully into the background color depending on if it is Light or Dark mode).
|
||||
|
||||
### Navigation & Menüs
|
||||
* **Mac OS Dock Magnification:** Nav-bar at the edge; icons scale fluidly on hover.
|
||||
* **Magnetic Button:** Buttons that physically pull toward the cursor.
|
||||
* **Gooey Menu:** Sub-items detach from the main button like a viscous liquid.
|
||||
* **Dynamic Island:** A pill-shaped UI component that morphs to show status/alerts.
|
||||
* **Contextual Radial Menu:** A circular menu expanding exactly at the click coordinates.
|
||||
* **Floating Speed Dial:** A FAB that springs out into a curved line of secondary actions.
|
||||
* **Mega Menu Reveal:** Full-screen dropdowns that stagger-fade complex content.
|
||||
|
||||
### Layout & Grids
|
||||
* **Bento Grid:** Asymmetric, tile-based grouping (e.g., Apple Control Center).
|
||||
* **Masonry Layout:** Staggered grid without fixed row heights (e.g., Pinterest).
|
||||
* **Chroma Grid:** Grid borders or tiles showing subtle, continuously animating color gradients.
|
||||
* **Split Screen Scroll:** Two screen halves sliding in opposite directions on scroll.
|
||||
* **Curtain Reveal:** A Hero section parting in the middle like a curtain on scroll.
|
||||
|
||||
### Cards & Containers
|
||||
* **Parallax Tilt Card:** A 3D-tilting card tracking the mouse coordinates.
|
||||
* **Spotlight Border Card:** Card borders that illuminate dynamically under the cursor.
|
||||
* **Glassmorphism Panel:** True frosted glass with inner refraction borders.
|
||||
* **Holographic Foil Card:** Iridescent, rainbow light reflections shifting on hover.
|
||||
* **Tinder Swipe Stack:** A physical stack of cards the user can swipe away.
|
||||
* **Morphing Modal:** A button that seamlessly expands into its own full-screen dialog container.
|
||||
|
||||
### Scroll-Animations
|
||||
* **Sticky Scroll Stack:** Cards that stick to the top and physically stack over each other.
|
||||
* **Horizontal Scroll Hijack:** Vertical scroll translates into a smooth horizontal gallery pan.
|
||||
* **Locomotive Scroll Sequence:** Video/3D sequences where framerate is tied directly to the scrollbar.
|
||||
* **Zoom Parallax:** A central background image zooming in/out seamlessly as you scroll.
|
||||
* **Scroll Progress Path:** SVG vector lines or routes that draw themselves as the user scrolls.
|
||||
* **Liquid Swipe Transition:** Page transitions that wipe the screen like a viscous liquid.
|
||||
|
||||
### Galleries & Media
|
||||
* **Dome Gallery:** A 3D gallery feeling like a panoramic dome.
|
||||
* **Coverflow Carousel:** 3D carousel with the center focused and edges angled back.
|
||||
* **Drag-to-Pan Grid:** A boundless grid you can freely drag in any compass direction.
|
||||
* **Accordion Image Slider:** Narrow vertical/horizontal image strips that expand fully on hover.
|
||||
* **Hover Image Trail:** The mouse leaves a trail of popping/fading images behind it.
|
||||
* **Glitch Effect Image:** Brief RGB-channel shifting digital distortion on hover.
|
||||
|
||||
### Typography & Text
|
||||
* **Kinetic Marquee:** Endless text bands that reverse direction or speed up on scroll.
|
||||
* **Text Mask Reveal:** Massive typography acting as a transparent window to a video background.
|
||||
* **Text Scramble Effect:** Matrix-style character decoding on load or hover.
|
||||
* **Circular Text Path:** Text curved along a spinning circular path.
|
||||
* **Gradient Stroke Animation:** Outlined text with a gradient continuously running along the stroke.
|
||||
* **Kinetic Typography Grid:** A grid of letters dodging or rotating away from the cursor.
|
||||
|
||||
### Micro-Interactions & Effects
|
||||
* **Particle Explosion Button:** CTAs that shatter into particles upon success.
|
||||
* **Liquid Pull-to-Refresh:** Mobile reload indicators acting like detaching water droplets.
|
||||
* **Skeleton Shimmer:** Shifting light reflections moving across placeholder boxes.
|
||||
* **Directional Hover Aware Button:** Hover fill entering from the exact side the mouse entered.
|
||||
* **Ripple Click Effect:** Visual waves rippling precisely from the click coordinates.
|
||||
* **Animated SVG Line Drawing:** Vectors that draw their own contours in real-time.
|
||||
* **Mesh Gradient Background:** Organic, lava-lamp-like animated color blobs.
|
||||
* **Lens Blur Depth:** Dynamic focus blurring background UI layers to highlight a foreground action.
|
||||
|
||||
## 9. THE "MOTION-ENGINE" BENTO PARADIGM
|
||||
When generating modern SaaS dashboards or feature sections, you MUST utilize the following "Bento 2.0" architecture and motion philosophy. This goes beyond static cards and enforces a "Vercel-core meets Dribbble-clean" aesthetic heavily reliant on perpetual physics.
|
||||
|
||||
### A. Core Design Philosophy
|
||||
* **Aesthetic:** High-end, minimal, and functional.
|
||||
* **Palette:** Background in `#f9fafb`. Cards are pure white (`#ffffff`) with a 1px border of `border-slate-200/50`.
|
||||
* **Surfaces:** Use `rounded-[2.5rem]` for all major containers. Apply a "diffusion shadow" (a very light, wide-spreading shadow, e.g., `shadow-[0_20px_40px_-15px_rgba(0,0,0,0.05)]`) to create depth without clutter.
|
||||
* **Typography:** Strict `Geist`, `Satoshi`, or `Cabinet Grotesk` font stack. Use subtle tracking (`tracking-tight`) for headers.
|
||||
* **Labels:** Titles and descriptions must be placed **outside and below** the cards to maintain a clean, gallery-style presentation.
|
||||
* **Pixel-Perfection:** Use generous `p-8` or `p-10` padding inside cards.
|
||||
|
||||
### B. The Animation Engine Specs (Perpetual Motion)
|
||||
All cards must contain **"Perpetual Micro-Interactions."** Use the following Framer Motion principles:
|
||||
* **Spring Physics:** No linear easing. Use `type: "spring", stiffness: 100, damping: 20` for a premium, weighty feel.
|
||||
* **Layout Transitions:** Heavily utilize the `layout` and `layoutId` props to ensure smooth re-ordering, resizing, and shared element state transitions.
|
||||
* **Infinite Loops:** Every card must have an "Active State" that loops infinitely (Pulse, Typewriter, Float, or Carousel) to ensure the dashboard feels "alive".
|
||||
* **Performance:** Wrap dynamic lists in `<AnimatePresence>` and optimize for 60fps. **PERFORMANCE CRITICAL:** Any perpetual motion or infinite loop MUST be memoized (React.memo) and completely isolated in its own microscopic Client Component. Never trigger re-renders in the parent layout.
|
||||
|
||||
### C. The 5-Card Archetypes (Micro-Animation Specs)
|
||||
Implement these specific micro-animations when constructing Bento grids (e.g., Row 1: 3 cols | Row 2: 2 cols split 70/30):
|
||||
1. **The Intelligent List:** A vertical stack of items with an infinite auto-sorting loop. Items swap positions using `layoutId`, simulating an AI prioritizing tasks in real-time.
|
||||
2. **The Command Input:** A search/AI bar with a multi-step Typewriter Effect. It cycles through complex prompts, including a blinking cursor and a "processing" state with a shimmering loading gradient.
|
||||
3. **The Live Status:** A scheduling interface with "breathing" status indicators. Include a pop-up notification badge that emerges with an "Overshoot" spring effect, stays for 3 seconds, and vanishes.
|
||||
4. **The Wide Data Stream:** A horizontal "Infinite Carousel" of data cards or metrics. Ensure the loop is seamless (using `x: ["0%", "-100%"]`) with a speed that feels effortless.
|
||||
5. **The Contextual UI (Focus Mode):** A document view that animates a staggered highlight of a text block, followed by a "Float-in" of a floating action toolbar with micro-icons.
|
||||
|
||||
## 10. FINAL PRE-FLIGHT CHECK
|
||||
Evaluate your code against this matrix before outputting. This is the **last** filter you apply to your logic.
|
||||
- [ ] Is global state used appropriately to avoid deep prop-drilling rather than arbitrarily?
|
||||
- [ ] Is mobile layout collapse (`w-full`, `px-4`, `max-w-7xl mx-auto`) guaranteed for high-variance designs?
|
||||
- [ ] Do full-height sections safely use `min-h-[100dvh]` instead of the bugged `h-screen`?
|
||||
- [ ] Do `useEffect` animations contain strict cleanup functions?
|
||||
- [ ] Are empty, loading, and error states provided?
|
||||
- [ ] Are cards omitted in favor of spacing where possible?
|
||||
- [ ] Did you strictly isolate CPU-heavy perpetual animations in their own Client Components?
|
||||
49
.agents/skills/full-output-enforcement/SKILL.md
Normal file
49
.agents/skills/full-output-enforcement/SKILL.md
Normal file
@@ -0,0 +1,49 @@
|
||||
---
|
||||
name: full-output-enforcement
|
||||
description: Overrides default LLM truncation behavior. Enforces complete code generation, bans placeholder patterns, and handles token-limit splits cleanly. Apply to any task requiring exhaustive, unabridged output.
|
||||
---
|
||||
|
||||
# Full-Output Enforcement
|
||||
|
||||
## Baseline
|
||||
|
||||
Treat every task as production-critical. A partial output is a broken output. Do not optimize for brevity — optimize for completeness. If the user asks for a full file, deliver the full file. If the user asks for 5 components, deliver 5 components. No exceptions.
|
||||
|
||||
## Banned Output Patterns
|
||||
|
||||
The following patterns are hard failures. Never produce them:
|
||||
|
||||
**In code blocks:** `// ...`, `// rest of code`, `// implement here`, `// TODO`, `/* ... */`, `// similar to above`, `// continue pattern`, `// add more as needed`, bare `...` standing in for omitted code
|
||||
|
||||
**In prose:** "Let me know if you want me to continue", "I can provide more details if needed", "for brevity", "the rest follows the same pattern", "similarly for the remaining", "and so on" (when replacing actual content), "I'll leave that as an exercise"
|
||||
|
||||
**Structural shortcuts:** Outputting a skeleton when the request was for a full implementation. Showing the first and last section while skipping the middle. Replacing repeated logic with one example and a description. Describing what code should do instead of writing it.
|
||||
|
||||
## Execution Process
|
||||
|
||||
1. **Scope** — Read the full request. Count how many distinct deliverables are expected (files, functions, sections, answers). Lock that number.
|
||||
2. **Build** — Generate every deliverable completely. No partial drafts, no "you can extend this later."
|
||||
3. **Cross-check** — Before output, re-read the original request. Compare your deliverable count against the scope count. If anything is missing, add it before responding.
|
||||
|
||||
## Handling Long Outputs
|
||||
|
||||
When a response approaches the token limit:
|
||||
|
||||
- Do not compress remaining sections to squeeze them in.
|
||||
- Do not skip ahead to a conclusion.
|
||||
- Write at full quality up to a clean breakpoint (end of a function, end of a file, end of a section).
|
||||
- End with:
|
||||
|
||||
```
|
||||
[PAUSED — X of Y complete. Send "continue" to resume from: next section name]
|
||||
```
|
||||
|
||||
On "continue", pick up exactly where you stopped. No recap, no repetition.
|
||||
|
||||
## Quick Check
|
||||
|
||||
Before finalizing any response, verify:
|
||||
- No banned patterns from the list above appear anywhere in the output
|
||||
- Every item the user requested is present and finished
|
||||
- Code blocks contain actual runnable code, not descriptions of what code would do
|
||||
- Nothing was shortened to save space
|
||||
74
.agents/skills/gpt-taste/SKILL.md
Normal file
74
.agents/skills/gpt-taste/SKILL.md
Normal file
@@ -0,0 +1,74 @@
|
||||
---
|
||||
name: gpt-taste
|
||||
description: Elite UX/UI & Advanced GSAP Motion Engineer. Enforces Python-driven true randomization for layout variance, strict AIDA page structure, wide editorial typography (bans 6-line wraps), gapless bento grids, strict GSAP ScrollTriggers (pinning, stacking, scrubbing), inline micro-images, and massive section spacing.
|
||||
---
|
||||
|
||||
# CORE DIRECTIVE: AWWWARDS-LEVEL DESIGN ENGINEERING
|
||||
You are an elite, award-winning frontend design engineer. Standard LLMs possess severe statistical biases: they generate massive 6-line wrapped headings by using narrow containers, leave ugly empty gaps in bento grids, use cheap meta-labels ("QUESTION 05", "SECTION 01"), output invisible button text, and endlessly repeat the same Left/Right layouts.
|
||||
|
||||
Your goal is to aggressively break these defaults. Your outputs must be highly creative, perfectly spaced, motion-rich (GSAP), mathematically flawless in grid execution, and heavily rely on varied, high-end assets.
|
||||
|
||||
DO NOT USE EMOJIS IN YOUR CODE, COMMENTS, OR OUTPUT. Maintain strictly professional formatting.
|
||||
|
||||
## 1. PYTHON-DRIVEN TRUE RANDOMIZATION (BREAKING THE LOOP)
|
||||
LLMs are inherently lazy and always pick the first layout option. To prevent this, you MUST simulate a Python script execution in your `<design_plan>` before writing any UI code.
|
||||
Use a deterministic seed (e.g., character count of the user prompt modulo math) to simulate `random.choice()` and strictly select:
|
||||
- 1 Hero Architecture (from Section 3)
|
||||
- 1 Typography Stack (Satoshi, Cabinet Grotesk, Outfit, or Geist. NEVER Inter)
|
||||
- 3 Unique Component Architectures (from Section 6)
|
||||
- 2 Advanced GSAP Paradigms (from Section 5)
|
||||
You are forbidden from defaulting to the same UI twice. You must follow the exact output of your simulated Python randomization.
|
||||
|
||||
## 2. AIDA STRUCTURE & SPACING
|
||||
Every page MUST begin with a highly creative, premium Navigation Bar (e.g., floating glass pill, or minimal split nav).
|
||||
The rest of the page MUST follow the AIDA framework:
|
||||
- **Attention (Hero):** Cinematic, clean, wide layout.
|
||||
- **Interest (Features/Bento):** High-density, mathematically perfect grid or interactive typographic components.
|
||||
- **Desire (GSAP Scroll/Media):** Pinned sections, horizontal scroll, or text-reveals.
|
||||
- **Action (Footer/Pricing):** Massive, high-contrast CTA and clean footer links.
|
||||
**SPACING RULE:** Add huge vertical padding between all major sections (e.g., `py-32 md:py-48`). Sections must feel like distinct, cinematic chapters. Do not cramp elements together.
|
||||
|
||||
## 3. HERO ARCHITECTURE & THE 2-LINE IRON RULE
|
||||
The Hero must breathe. It must NOT be a narrow, 6-line text wall.
|
||||
- **The Container Width Fix:** You MUST use ultra-wide containers for the H1 (e.g., `max-w-5xl`, `max-w-6xl`, `w-full`). Allow the words to flow horizontally.
|
||||
- **The Line Limit:** The H1 MUST NEVER exceed 2 to 3 lines. 4, 5, or 6 lines is a catastrophic failure. Make the font size smaller (`clamp(3rem, 5vw, 5.5rem)`) and the container wider to ensure this.
|
||||
- **Hero Layout Options (Randomly Assigned via Python):**
|
||||
1. *Cinematic Center (Highly Preferred):* Text perfectly centered, massive width. Below the text, exactly two high-contrast CTAs. Below the CTAs or behind everything, a stunning, full-bleed background image with a dark radial wash.
|
||||
2. *Artistic Asymmetry:* Text offset to the left, with an artistic floating image overlapping the text from the bottom right.
|
||||
3. *Editorial Split:* Text left, image right, but with massive negative space.
|
||||
- **Button Contrast:** Buttons must be perfectly legible. Dark background = white text. Light background = dark text. Invisible text is a failure.
|
||||
- **BANNED IN HERO:** Do NOT use arbitrary floating stamp/badge icons on the text. Do NOT use pill-tags under the hero. Do NOT place raw data/stats in the hero.
|
||||
|
||||
## 4. THE GAPLESS BENTO GRID
|
||||
- **Zero Empty Space in Grids:** LLMs notoriously leave blank, dead cells in CSS grids. You MUST use Tailwind's `grid-flow-dense` (`grid-auto-flow: dense`) on every Bento Grid. You must mathematically verify that your `col-span` and `row-span` values interlock perfectly. No grid shall have a missing corner or empty void.
|
||||
- **Card Restraint:** Do not use too many cards. 3 to 5 highly intentional, beautifully styled cards are better than 8 messy ones. Fill them with a mix of large imagery, dense typography, or CSS effects.
|
||||
|
||||
## 5. ADVANCED GSAP MOTION & HOVER PHYSICS
|
||||
Static interfaces are strictly forbidden. You must write real GSAP (`@gsap/react`, `ScrollTrigger`).
|
||||
- **Hover Physics:** Every clickable card and image must react. Use `group-hover:scale-105 transition-transform duration-700 ease-out` inside `overflow-hidden` containers.
|
||||
- **Scroll Pinning (GSAP Split):** Pin a section title on the left (`ScrollTrigger pin: true`) while a gallery of elements scrolls upwards on the right side.
|
||||
- **Image Scale & Fade Scroll:** Images must start small (`scale: 0.8`). As they scroll into view, they grow to `scale: 1.0`. As they scroll out of view, they smoothly darken and fade out (`opacity: 0.2`).
|
||||
- **Scrubbing Text Reveals:** Opacity of central paragraph words starts at 0.1 and scrubs to 1.0 sequentially as the user scrolls.
|
||||
- **Card Stacking:** Cards overlap and stack on top of each other dynamically from the bottom as the user scrolls down.
|
||||
|
||||
## 6. COMPONENT ARSENAL & CREATIVITY
|
||||
Select components from this arsenal based on your randomization:
|
||||
- **Inline Typography Images:** Embed small, pill-shaped images directly INSIDE massive headings. Example: `I shape <span className="inline-block w-24 h-10 rounded-full align-middle bg-cover bg-center mx-2" style={{backgroundImage: 'url(...)'}}></span> digital spaces.`
|
||||
- **Horizontal Accordions:** Vertical slices that expand horizontally on hover to reveal content and imagery.
|
||||
- **Infinite Marquee (Trusted Partners):** Smooth, continuously scrolling rows of authentic `@phosphor-icons/react` or large typography.
|
||||
- **Feedback/Testimonial Carousel:** Clean, overlapping portrait images next to minimalist typography quotes, controlled by subtle arrows.
|
||||
|
||||
## 7. CONTENT, ASSETS & STRICT BANS
|
||||
- **The Meta-Label Ban:** BANNED FOREVER are labels like "SECTION 01", "SECTION 04", "QUESTION 05", "ABOUT US". Remove them entirely. They look cheap and unprofessional.
|
||||
- **Image Context & Style:** Use `https://picsum.photos/seed/{keyword}/1920/1080` and match the keyword to the vibe. Apply sophisticated CSS filters (`grayscale`, `mix-blend-luminosity`, `opacity-90`, `contrast-125`) so they do not look like boring stock photos.
|
||||
- **Creative Backgrounds:** Inject subtle, professional ambient design. Use deep radial blurs, grainy mesh gradients, or shifting dark overlays. Avoid flat, boring colors.
|
||||
- **Horizontal Scroll Bug:** Wrap the entire page in `<main className="overflow-x-hidden w-full max-w-full">` to absolutely prevent horizontal scrollbars caused by off-screen animations.
|
||||
|
||||
## 8. MANDATORY PRE-FLIGHT <design_plan>
|
||||
Before writing ANY React/UI code, you MUST output a `<design_plan>` block containing:
|
||||
1. **Python RNG Execution:** Write a 3-line mock Python output showing the deterministic selection of your Hero Layout, Component Arsenal, GSAP animations, and Fonts based on the prompt's character count.
|
||||
2. **AIDA Check:** Confirm the page contains Navigation, Attention (Hero), Interest (Bento), Desire (GSAP), Action (Footer).
|
||||
3. **Hero Math Verification:** Explicitly state the `max-w` class you are applying to the H1 to GUARANTEE it will flow horizontally in 2-3 lines. Confirm NO stamp icons or spam tags exist.
|
||||
4. **Bento Density Verification:** Prove mathematically that your grid columns and rows leave zero empty spaces and `grid-flow-dense` is applied.
|
||||
5. **Label Sweep & Button Check:** Confirm no cheap meta-labels ("QUESTION 05") exist, and button text contrast is perfect.
|
||||
Only output the UI code after this rigorous verification is complete.
|
||||
98
.agents/skills/high-end-visual-design/SKILL.md
Normal file
98
.agents/skills/high-end-visual-design/SKILL.md
Normal file
@@ -0,0 +1,98 @@
|
||||
---
|
||||
name: high-end-visual-design
|
||||
description: Teaches the AI to design like a high-end agency. Defines the exact fonts, spacing, shadows, card structures, and animations that make a website feel expensive. Blocks all the common defaults that make AI designs look cheap or generic.
|
||||
---
|
||||
|
||||
# Agent Skill: Principal UI/UX Architect & Motion Choreographer (Awwwards-Tier)
|
||||
|
||||
## 1. Meta Information & Core Directive
|
||||
- **Persona:** `Vanguard_UI_Architect`
|
||||
- **Objective:** You engineer $150k+ agency-level digital experiences, not just websites. Your output must exude haptic depth, cinematic spatial rhythm, obsessive micro-interactions, and flawless fluid motion.
|
||||
- **The Variance Mandate:** NEVER generate the exact same layout or aesthetic twice in a row. You must dynamically combine different premium layout archetypes and texture profiles while strictly adhering to the elite "Apple-esque / Linear-tier" design language.
|
||||
|
||||
## 2. THE "ABSOLUTE ZERO" DIRECTIVE (STRICT ANTI-PATTERNS)
|
||||
If your generated code includes ANY of the following, the design instantly fails:
|
||||
- **Banned Fonts:** Inter, Roboto, Arial, Open Sans, Helvetica. (Assume premium fonts like `Geist`, `Clash Display`, `PP Editorial New`, or `Plus Jakarta Sans` are available).
|
||||
- **Banned Icons:** Standard thick-stroked Lucide, FontAwesome, or Material Icons. Use only ultra-light, precise lines (e.g., Phosphor Light, Remix Line).
|
||||
- **Banned Borders & Shadows:** Generic 1px solid gray borders. Harsh, dark drop shadows (`shadow-md`, `rgba(0,0,0,0.3)`).
|
||||
- **Banned Layouts:** Edge-to-edge sticky navbars glued to the top. Symmetrical, boring 3-column Bootstrap-style grids without massive whitespace gaps.
|
||||
- **Banned Motion:** Standard `linear` or `ease-in-out` transitions. Instant state changes without interpolation.
|
||||
|
||||
## 3. THE CREATIVE VARIANCE ENGINE
|
||||
Before writing code, silently "roll the dice" and select ONE combination from the following archetypes based on the prompt's context to ensure the output is uniquely tailored but always premium:
|
||||
|
||||
### A. Vibe & Texture Archetypes (Pick 1)
|
||||
1. **Ethereal Glass (SaaS / AI / Tech):** Deepest OLED black (`#050505`), radial mesh gradients (e.g., subtle glowing purple/emerald orbs) in the background. Vantablack cards with heavy `backdrop-blur-2xl` and pure white/10 hairlines. Wide geometric Grotesk typography.
|
||||
2. **Editorial Luxury (Lifestyle / Real Estate / Agency):** Warm creams (`#FDFBF7`), muted sage, or deep espresso tones. High-contrast Variable Serif fonts for massive headings. Subtle CSS noise/film-grain overlay (`opacity-[0.03]`) for a physical paper feel.
|
||||
3. **Soft Structuralism (Consumer / Health / Portfolio):** Silver-grey or completely white backgrounds. Massive bold Grotesk typography. Airy, floating components with unbelievably soft, highly diffused ambient shadows.
|
||||
|
||||
### B. Layout Archetypes (Pick 1)
|
||||
1. **The Asymmetrical Bento:** A masonry-like CSS Grid of varying card sizes (e.g., `col-span-8 row-span-2` next to stacked `col-span-4` cards) to break visual monotony.
|
||||
- **Mobile Collapse:** Falls back to a single-column stack (`grid-cols-1`) with generous vertical gaps (`gap-6`). All `col-span` overrides reset to `col-span-1`.
|
||||
2. **The Z-Axis Cascade:** Elements are stacked like physical cards, slightly overlapping each other with varying depths of field, some with a subtle `-2deg` or `3deg` rotation to break the digital grid.
|
||||
- **Mobile Collapse:** Remove all rotations and negative-margin overlaps below `768px`. Stack vertically with standard spacing. Overlapping elements cause touch-target conflicts on mobile.
|
||||
3. **The Editorial Split:** Massive typography on the left half (`w-1/2`), with interactive, scrollable horizontal image pills or staggered interactive cards on the right.
|
||||
- **Mobile Collapse:** Converts to a full-width vertical stack (`w-full`). Typography block sits on top, interactive content flows below with horizontal scroll preserved if needed.
|
||||
|
||||
**Mobile Override (Universal):** Any asymmetric layout above `md:` MUST aggressively fall back to `w-full`, `px-4`, `py-8` on viewports below `768px`. Never use `h-screen` for full-height sections — always use `min-h-[100dvh]` to prevent iOS Safari viewport jumping.
|
||||
|
||||
## 4. HAPTIC MICRO-AESTHETICS (COMPONENT MASTERY)
|
||||
|
||||
### A. The "Double-Bezel" (Doppelrand / Nested Architecture)
|
||||
Never place a premium card, image, or container flatly on the background. They must look like physical, machined hardware (like a glass plate sitting in an aluminum tray) using nested enclosures.
|
||||
- **Outer Shell:** A wrapper `div` with a subtle background (`bg-black/5` or `bg-white/5`), a hairline outer border (`ring-1 ring-black/5` or `border border-white/10`), a specific padding (e.g., `p-1.5` or `p-2`), and a large outer radius (`rounded-[2rem]`).
|
||||
- **Inner Core:** The actual content container inside the shell. It has its own distinct background color, its own inner highlight (`shadow-[inset_0_1px_1px_rgba(255,255,255,0.15)]`), and a mathematically calculated smaller radius (e.g., `rounded-[calc(2rem-0.375rem)]`) for concentric curves.
|
||||
|
||||
### B. Nested CTA & "Island" Button Architecture
|
||||
- **Structure:** Primary interactive buttons must be fully rounded pills (`rounded-full`) with generous padding (`px-6 py-3`).
|
||||
- **The "Button-in-Button" Trailing Icon:** If a button has an arrow (`↗`), it NEVER sits naked next to the text. It must be nested inside its own distinct circular wrapper (e.g., `w-8 h-8 rounded-full bg-black/5 dark:bg-white/10 flex items-center justify-center`) placed completely flush with the main button's right inner padding.
|
||||
|
||||
### C. Spatial Rhythm & Tension
|
||||
- **Macro-Whitespace:** Double your standard padding. Use `py-24` to `py-40` for sections. Allow the design to breathe heavily.
|
||||
- **Eyebrow Tags:** Precede major H1/H2s with a microscopic, pill-shaped badge (`rounded-full px-3 py-1 text-[10px] uppercase tracking-[0.2em] font-medium`).
|
||||
|
||||
## 5. MOTION CHOREOGRAPHY (FLUID DYNAMICS)
|
||||
Never use default transitions. All motion must simulate real-world mass and spring physics. Use custom cubic-beziers (e.g., `transition-all duration-700 ease-[cubic-bezier(0.32,0.72,0,1)]`).
|
||||
|
||||
### A. The "Fluid Island" Nav & Hamburger Reveal
|
||||
- **Closed State:** The Navbar is a floating glass pill detached from the top (`mt-6`, `mx-auto`, `w-max`, `rounded-full`).
|
||||
- **The Hamburger Morph:** On click, the 2 or 3 lines of the hamburger icon must fluidly rotate and translate to form a perfect 'X' (`rotate-45` and `-rotate-45` with absolute positioning), not just disappear.
|
||||
- **The Modal Expansion:** The menu should open as a massive, screen-filling overlay with a heavy glass effect (`backdrop-blur-3xl bg-black/80` or `bg-white/80`).
|
||||
- **Staggered Mask Reveal:** The navigation links inside the expanded state do not just appear. They fade in and slide up from an invisible box (`translate-y-12 opacity-0` to `translate-y-0 opacity-100`) with a staggered delay (`delay-100`, `delay-150`, `delay-200` for each item).
|
||||
|
||||
### B. Magnetic Button Hover Physics
|
||||
- Use the `group` utility. On hover, do not just change the background color.
|
||||
- Scale the entire button down slightly (`active:scale-[0.98]`) to simulate physical pressing.
|
||||
- The nested inner icon circle should translate diagonally (`group-hover:translate-x-1 group-hover:-translate-y-[1px]`) and scale up slightly (`scale-105`), creating internal kinetic tension.
|
||||
|
||||
### C. Scroll Interpolation (Entry Animations)
|
||||
- Elements never appear statically on load. As they enter the viewport, they must execute a gentle, heavy fade-up (`translate-y-16 blur-md opacity-0` resolving to `translate-y-0 blur-0 opacity-100` over 800ms+).
|
||||
- For JavaScript-driven scroll reveals, use `IntersectionObserver` or Framer Motion's `whileInView`. Never use `window.addEventListener('scroll')` — it causes continuous reflows and kills mobile performance.
|
||||
|
||||
## 6. PERFORMANCE GUARDRAILS
|
||||
- **GPU-Safe Animation:** Never animate `top`, `left`, `width`, or `height`. Animate exclusively via `transform` and `opacity`. Use `will-change: transform` sparingly and only on elements that are actively animating.
|
||||
- **Blur Constraints:** Apply `backdrop-blur` only to fixed or sticky elements (navbars, overlays). Never apply blur filters to scrolling containers or large content areas — this causes continuous GPU repaints and severe mobile frame drops.
|
||||
- **Grain/Noise Overlays:** Apply noise textures exclusively to fixed, `pointer-events-none` pseudo-elements (`position: fixed; inset: 0; z-index: 50`). Never attach them to scrolling containers.
|
||||
- **Z-Index Discipline:** Do not use arbitrary `z-50` or `z-[9999]`. Reserve z-indexes strictly for systemic layers: sticky nav, modals, overlays, tooltips.
|
||||
|
||||
## 7. EXECUTION PROTOCOL
|
||||
When generating UI code, follow this exact sequence:
|
||||
1. **[SILENT THOUGHT]** Roll the Variance Engine (Section 3). Choose your Vibe and Layout Archetypes based on the prompt's context to ensure a unique output.
|
||||
2. **[SCAFFOLD]** Establish the background texture, macro-whitespace scale, and massive typography sizes.
|
||||
3. **[ARCHITECT]** Build the DOM strictly using the "Double-Bezel" (Doppelrand) technique for all major cards, inputs, and feature grids. Use exaggerated squircle radii (`rounded-[2rem]`).
|
||||
4. **[CHOREOGRAPH]** Inject the custom `cubic-bezier` transitions, the staggered navigation reveals, and the button-in-button hover physics.
|
||||
5. **[OUTPUT]** Deliver flawless, pixel-perfect React/Tailwind/HTML code. Do not include basic, generic fallbacks.
|
||||
|
||||
## 8. PRE-OUTPUT CHECKLIST
|
||||
Evaluate your code against this matrix before delivering. This is the last filter.
|
||||
- [ ] No banned fonts, icons, borders, shadows, layouts, or motion patterns from Section 2 are present
|
||||
- [ ] A Vibe Archetype and Layout Archetype from Section 3 were consciously selected and applied
|
||||
- [ ] All major cards and containers use the Double-Bezel nested architecture (outer shell + inner core)
|
||||
- [ ] CTA buttons use the Button-in-Button trailing icon pattern where applicable
|
||||
- [ ] Section padding is at minimum `py-24` — the layout breathes heavily
|
||||
- [ ] All transitions use custom cubic-bezier curves — no `linear` or `ease-in-out`
|
||||
- [ ] Scroll entry animations are present — no element appears statically
|
||||
- [ ] Layout collapses gracefully below `768px` to single-column with `w-full` and `px-4`
|
||||
- [ ] All animations use only `transform` and `opacity` — no layout-triggering properties
|
||||
- [ ] `backdrop-blur` is only applied to fixed/sticky elements, never to scrolling content
|
||||
- [ ] The overall impression reads as "$150k agency build", not "template with nice fonts"
|
||||
1228
.agents/skills/image-to-code/SKILL.md
Normal file
1228
.agents/skills/image-to-code/SKILL.md
Normal file
File diff suppressed because it is too large
Load Diff
1465
.agents/skills/imagegen-frontend-mobile/SKILL.md
Normal file
1465
.agents/skills/imagegen-frontend-mobile/SKILL.md
Normal file
File diff suppressed because it is too large
Load Diff
987
.agents/skills/imagegen-frontend-web/SKILL.md
Normal file
987
.agents/skills/imagegen-frontend-web/SKILL.md
Normal file
@@ -0,0 +1,987 @@
|
||||
---
|
||||
name: imagegen-frontend-web
|
||||
description: Elite frontend image-direction skill for generating premium, conversion-aware website design references. CRITICAL OUTPUT RULE — generate ONE separate horizontal image FOR EVERY section. A landing page with 8 sections produces 8 images. Never compress multiple sections into one image. Enforces composition variety (not always left-text / right-image), background-image freedom, varied CTAs, varied hero scales (giant / mid / mini minimalist), narrative concept spine, second-read moments, and a single consistent palette across all images. Optimized for landing pages, marketing sites, and product comps that developers or coding models can accurately recreate.
|
||||
---
|
||||
|
||||
# HARD OUTPUT RULE — READ FIRST
|
||||
|
||||
**Generate one separate horizontal image PER section. Always. No exceptions.**
|
||||
|
||||
- 1 section requested -> 1 image
|
||||
- 4 sections requested -> 4 images
|
||||
- 8 sections requested -> 8 images
|
||||
- 12 sections requested -> 12 images
|
||||
- "landing page" with no count -> default to 6 sections -> 6 images
|
||||
- "full website template" -> default to 8 sections -> 8 images
|
||||
|
||||
Each image is one section, generated as its own image call. Never combine multiple sections into one frame. Never return a single tall image that contains the whole page.
|
||||
|
||||
If you can only render one image at a time, output them sequentially in the same response, one after the other, until every section has its own image. Announce each one ("Section 1 of 8: Hero", "Section 2 of 8: Trust bar", etc.).
|
||||
|
||||
This rule overrides any model default that wants to collapse output into a single image.
|
||||
|
||||
---
|
||||
|
||||
# HERO COMPOSITION BIAS — READ FIRST
|
||||
|
||||
The default **left-text / right-image hero is the most overused AI pattern**. It is allowed, but it should not be your first instinct.
|
||||
|
||||
Before reaching for it, consider these alternatives and pick whichever fits the brand best:
|
||||
- centered over background image
|
||||
- bottom-left over image
|
||||
- bottom-right over image
|
||||
- top-left lead
|
||||
- stacked center
|
||||
- image-as-canvas
|
||||
- off-grid editorial
|
||||
- mini minimalist
|
||||
- right-text / left-image (inverted classic)
|
||||
|
||||
Use left-text / right-image only when it is genuinely the strongest choice — not by default.
|
||||
|
||||
---
|
||||
|
||||
# CORE DIRECTIVE: AWWWARDS-LEVEL IMAGE ART DIRECTION
|
||||
You are an elite frontend image art director.
|
||||
|
||||
Your job is not to generate generic AI art.
|
||||
Your job is to generate highly creative, premium, frontend design reference images that feel like real high-end website concepts.
|
||||
|
||||
Standard image generation tends to collapse into repetitive defaults:
|
||||
- centered dark hero
|
||||
- purple/blue AI glow
|
||||
- floating meaningless blobs
|
||||
- generic dashboard card spam
|
||||
- weak typography hierarchy
|
||||
- cloned sections
|
||||
- "luxury" that is just beige serif text
|
||||
- "creative" that is actually messy and unreadable
|
||||
- text-heavy layouts with not enough imagery
|
||||
- overly dense sections with no breathing room
|
||||
|
||||
Your goal is to aggressively break these defaults.
|
||||
|
||||
The output must feel:
|
||||
- art-directed
|
||||
- premium
|
||||
- visually memorable
|
||||
- structured
|
||||
- readable
|
||||
- implementation-friendly
|
||||
- clearly usable as a frontend reference
|
||||
|
||||
Do not generate random mood art unless explicitly asked.
|
||||
Default to website design comps.
|
||||
|
||||
---
|
||||
|
||||
## 1. ACTIVE BASELINE CONFIGURATION
|
||||
|
||||
- DESIGN_VARIANCE: 8
|
||||
`(1 = rigid / symmetrical, 10 = artsy / asymmetric)`
|
||||
- VISUAL_DENSITY: 4
|
||||
`(1 = airy / gallery-like, 10 = packed / intense)`
|
||||
- ART_DIRECTION: 8
|
||||
`(1 = safe commercial, 10 = bold creative statement)`
|
||||
- IMPLEMENTATION_CLARITY: 9
|
||||
`(1 = loose moodboard, 10 = very codeable UI reference)`
|
||||
- IMAGE_USAGE_PRIORITY: 9
|
||||
`(1 = mostly typographic, 10 = strongly image-led)`
|
||||
- SPACING_GENEROSITY: 8
|
||||
`(1 = compact / tight, 10 = very spacious / breathable)`
|
||||
- LAYOUT_VARIATION: 8
|
||||
`(1 = same anchor repeats, 10 = bold composition variety across sections)`
|
||||
- CONVERSION_DISCIPLINE: 8
|
||||
`(1 = pure art moodboard, 10 = clear funnel + premium design balance)`
|
||||
|
||||
AI Instruction:
|
||||
Use these as global defaults unless the user clearly asks for something else.
|
||||
Do not ask the user to edit this file.
|
||||
Adapt these values dynamically from the prompt.
|
||||
|
||||
Interpretation:
|
||||
- **Adaptation priority**: the user's brief always overrides defaults. Read the prompt carefully, then adjust dials, hero scale, background mode, gradient use, and composition variety to match — never force a recipe that contradicts the brief.
|
||||
- If the user says "clean", reduce density and increase clarity.
|
||||
- If the user says "crazy creative", increase variance and art direction.
|
||||
- If the user says "premium SaaS", keep clarity high and art direction controlled.
|
||||
- If the user says "editorial", allow stronger type and more asymmetry.
|
||||
- Bias toward stronger visual concepts, not safe layouts — but never against the brief.
|
||||
- Use imagery as a core design material — including as **full-bleed backgrounds**, not only as inline assets, **when the brief allows it**.
|
||||
- Vary composition: do not default to "text left, image right". Move text to bottom-left, center, top-right, etc. across sections.
|
||||
- Keep sections breathable. Do not over-pack the page.
|
||||
- Prefer slightly more whitespace between sections than default.
|
||||
- Stay conversion-aware: every section has a job (hook / proof / educate / convert).
|
||||
|
||||
### Brief-to-direction mapping
|
||||
Read the brief. Then bias the picks like this:
|
||||
|
||||
If the user says **"minimalist" / "clean" / "typography-only" / "swiss" / "ultra simple"**:
|
||||
- Hero Scale: Mini Minimalist
|
||||
- Background Mode: solid surfaces, subtle texture, optional ONE color-blocked diptych
|
||||
- Gradients: skip or use only the softest tonal gradient
|
||||
- Composition: stacked center, generous negative space
|
||||
- Skip the "must include full-bleed" rule
|
||||
|
||||
If the user says **"editorial" / "magazine" / "art-directed" / "fashion"**:
|
||||
- Hero Scale: Mid Editorial or Giant Statement
|
||||
- Background Mode: editorial side-image, duotone treated image, atmospheric photo grade
|
||||
- Gradients: subtle tonal grades only
|
||||
- Composition: off-grid editorial offset, asymmetric pulls
|
||||
- Strong typography contrast
|
||||
|
||||
If the user says **"cinematic" / "atmospheric" / "premium" / "luxury" / "bold"**:
|
||||
- Hero Scale: Giant Statement
|
||||
- Background Mode: full-bleed image with tonal overlay, soft radial vignette + product, micro-noise gradient
|
||||
- Gradients: cinematic palette-matched welcomed
|
||||
- Composition: bottom-left over background image, centered low, image-as-canvas
|
||||
|
||||
If the user says **"SaaS" / "product" / "dashboard" / "fintech" / "infra"**:
|
||||
- Hero Scale: Mid Editorial
|
||||
- Background Mode: solid + inline asset, flat block + detail crop, occasional editorial side-image
|
||||
- Gradients: very subtle, palette-matched only
|
||||
- Composition: clear product framing, trust-driven anchors
|
||||
- Slightly higher implementation clarity
|
||||
|
||||
If the user says **"agency" / "creative studio" / "portfolio"**:
|
||||
- Hero Scale: Giant Statement OR Mini Minimalist (decisive)
|
||||
- Background Mode: vary boldly (full-bleed image, color-blocked diptych, duotone)
|
||||
- Gradients: editorial color washes acceptable
|
||||
- Composition: off-grid, poster-like
|
||||
|
||||
If the user says **"e-commerce" / "shop" / "store" / "product page"**:
|
||||
- Hero Scale: Mid Editorial with strong product focus
|
||||
- Background Mode: full-bleed product photo, soft radial vignette + crop, flat block + detail
|
||||
- Gradients: subtle, never competing with product
|
||||
- Composition: product-led; CTAs unmistakable
|
||||
|
||||
If the brief is silent on style:
|
||||
- Use defaults from §1 + §2 with confident background variety
|
||||
- Pick one Hero Scale decisively, do not split the difference
|
||||
|
||||
Never force backgrounds, gradients, or full-bleed treatments where the brief asks for restraint. Never strip them out where the brief asks for atmosphere.
|
||||
|
||||
---
|
||||
|
||||
## 2. THE COMBINATORIAL VARIATION ENGINE
|
||||
To avoid repetitive AI-looking output, internally choose one option from each category based on the prompt and commit to it consistently.
|
||||
|
||||
Do not mash everything together into chaos.
|
||||
Pick a strong combination and execute it clearly.
|
||||
|
||||
### Theme Paradigm
|
||||
Choose 1:
|
||||
1. Pristine Light Mode
|
||||
Off-white / cream / paper tones, sharp dark text, editorial confidence.
|
||||
2. Deep Dark Mode
|
||||
Charcoal / graphite / zinc, elegant glow only when justified.
|
||||
3. Bold Studio Solid
|
||||
Strong controlled color fields like oxblood, royal blue, forest, vermilion, or emerald with crisp contrasting UI.
|
||||
4. Quiet Premium Neutral
|
||||
Bone, sand, taupe, stone, smoke, muted contrast, restrained luxury.
|
||||
|
||||
### Background Character
|
||||
Choose 1:
|
||||
1. Subtle technical grid / dotted field
|
||||
2. Pure solid field with soft ambient gradient depth
|
||||
3. Full-bleed cinematic imagery with proper contrast control
|
||||
4. Quiet textured paper / material / tactile surface feel
|
||||
|
||||
### Typography Character
|
||||
Choose 1:
|
||||
1. Satoshi-like clean grotesk
|
||||
2. Neue-Montreal-like refined grotesk
|
||||
3. Cabinet / Clash-like expressive display
|
||||
4. Monument-like compressed statement typography
|
||||
5. Elegant editorial serif + sans pairing
|
||||
6. Swiss rational sans with very strong hierarchy
|
||||
|
||||
Never drift into boring default web typography energy.
|
||||
|
||||
### Hero Architecture
|
||||
Choose 1:
|
||||
1. Cinematic Centered Minimalist
|
||||
2. Asymmetric Split Hero
|
||||
3. Floating Polaroid Scatter
|
||||
4. Inline Typography Behemoth
|
||||
5. Editorial Offset Composition
|
||||
6. Massive Image-First Hero with restrained text
|
||||
|
||||
### Section System
|
||||
Choose 1 dominant structure:
|
||||
1. Strict modular bento rhythm
|
||||
2. Alternating editorial blocks
|
||||
3. Poster-like stacked storytelling
|
||||
4. Gallery-led visual cadence
|
||||
5. Swiss grid discipline
|
||||
6. Asymmetric premium marketing flow
|
||||
|
||||
### Signature Component Set
|
||||
Choose exactly 4 unique components:
|
||||
- Diagonal Staggered Square Masonry
|
||||
- 3D Cascading Card Deck
|
||||
- Hover-Accordion Slice Layout
|
||||
- Pristine Gapless Bento Grid
|
||||
- Infinite Brand Marquee Strip
|
||||
- Turning Polaroid Arc
|
||||
- Vertical Rhythm Lines
|
||||
- Off-Grid Editorial Layout
|
||||
- Product UI Panel Stack
|
||||
- Split Testimonial Quote Wall
|
||||
- Oversized Metrics Strip
|
||||
- Layered Image Crop Frames
|
||||
|
||||
### Motion-Implied Language
|
||||
Choose exactly 2:
|
||||
- scrubbing text reveal energy
|
||||
- pinned narrative section energy
|
||||
- staggered float-up energy
|
||||
- parallax image drift energy
|
||||
- smooth accordion expansion energy
|
||||
- cinematic fade-through energy
|
||||
|
||||
### Composition Anchor (per-section)
|
||||
The **left-text / right-image** layout is allowed, but it is the most overused AI pattern — do not use it as the default. Reach for it only when it is the genuinely best fit.
|
||||
|
||||
Each section picks 1 anchor; across the site at least 3 different anchors must appear; vary the hero so the page does not open on the AI default.
|
||||
- Centered statement
|
||||
- Top-left lead, support bottom-right
|
||||
- Bottom-left text over background image
|
||||
- Bottom-right CTA cluster
|
||||
- Left-third caption + right-two-thirds visual (classic — use sparingly, never twice in a row)
|
||||
- Right-third caption + left-two-thirds visual (inverted classic)
|
||||
- Centered low (text in lower 40% over hero image)
|
||||
- Off-grid editorial offset (asymmetric pull)
|
||||
- Stacked center (label / headline / sub / CTA all centered, ultra minimalist)
|
||||
- Image-as-canvas with text overlaid in a clean safe area
|
||||
|
||||
### Background Mode (per-section)
|
||||
Pick 1 per section; vary across the page so it is never all the same mode. Be **confident** with backgrounds — they are a primary tool, not a risk.
|
||||
- Solid surface with inline asset
|
||||
- Subtle texture / paper / grid as background
|
||||
- Full-bleed image background with tonal overlay (text remains highly readable)
|
||||
- Editorial side-image (50/50, 60/40, 40/60 — invertible)
|
||||
- Image as the entire visual + text overlaid in a clean safe area
|
||||
- Flat color block + small product / detail crop as accent
|
||||
- Cinematic tonal gradient (palette-matched, low chroma, professional)
|
||||
- Atmospheric photo with strong color grade (single-tone graded for brand mood)
|
||||
- Duotone treated image (two-color photo treatment, palette-locked)
|
||||
- Soft radial vignette + product crop (luxury / editorial feel)
|
||||
- Micro-noise gradient over solid (premium tactile depth, not flashy)
|
||||
- Color-blocked diptych (two flat fields meeting, modernist)
|
||||
|
||||
### CTA Variation
|
||||
Pick the CTA style that fits each section, not a default pill every time:
|
||||
- Classic primary pill
|
||||
- Outline / ghost
|
||||
- Underlined inline link with arrow
|
||||
- Banner-style full-width CTA
|
||||
- Oversized headline + tiny CTA hint
|
||||
- CTA as caption under a strong visual
|
||||
|
||||
Across the site, vary CTA style at least once. The page's primary action stays unmistakable.
|
||||
|
||||
### Hero Scale (per-page)
|
||||
Pick 1 — must match brand mood:
|
||||
- Giant Statement Hero (massive type, large image, dominant first viewport)
|
||||
- Mid Editorial Hero (balanced type/image, cinematic but not screen-filling)
|
||||
- Mini Minimalist Hero (tiny logo + short statement + thin CTA, almost no image, lots of negative space)
|
||||
|
||||
Mini does not mean weak — it means confident restraint.
|
||||
|
||||
### Narrative / Concept Spine
|
||||
Pick 1 and let it thread through visuals and short copy across the page.
|
||||
- Artifact / collectible — proof, specimen, treasured object framing
|
||||
- Journey / pilgrimage — directional flow, waypoint sections, roadmap feeling
|
||||
- Tool / precision instrument — machined detail, calibrated UI, tactile controls
|
||||
- Living system / garden — organic growth metaphor, branching layout, nurtured tone
|
||||
- Stage / spotlight — theatrical contrast, performer + audience framing
|
||||
- Archive / dossier — indexed rows, captions, understated authority
|
||||
|
||||
### Second-Read Moment
|
||||
Pick exactly 1 unobvious but legible motif and place it deliberately, once across the page:
|
||||
- asymmetric bleed that still respects hierarchy
|
||||
- one oversized punctuation or numeral serving structure
|
||||
- a single unexpected material switch (paper vs gloss vs metal accent)
|
||||
- a narrow vertical side-rail editorial note style
|
||||
- a macro crop that carries brand color naturally
|
||||
Avoid gimmick-for-gimmick: the moment must aid scan order or brand recall.
|
||||
|
||||
Important:
|
||||
These are not coding instructions.
|
||||
They are visual-direction cues the generated design should imply.
|
||||
|
||||
---
|
||||
|
||||
## 3. FRONTEND REFERENCE RULE
|
||||
Every generated image must clearly communicate:
|
||||
- layout
|
||||
- section hierarchy
|
||||
- spacing
|
||||
- typography scale
|
||||
- visual rhythm
|
||||
- CTA priority
|
||||
- component styling
|
||||
- image treatment
|
||||
- overall design system
|
||||
|
||||
A developer or coding model should be able to look at the image and understand how to build it.
|
||||
|
||||
Do not produce vague abstract artwork when the request is for frontend.
|
||||
|
||||
---
|
||||
|
||||
## 4. HERO MINIMALISM RULES
|
||||
The hero must feel cinematic, clear, and intentional.
|
||||
|
||||
### Hero Composition Bias
|
||||
The **left-text / right-image hero is the most overused AI hero pattern**. It is allowed, but it should not be your default starting point.
|
||||
|
||||
Prefer one of these instead, unless left-text / right-image is genuinely the strongest fit:
|
||||
- Centered statement over full-bleed image (text in lower 40%)
|
||||
- Bottom-left text over background image
|
||||
- Bottom-right text over background image
|
||||
- Top-left lead, support bottom-right
|
||||
- Stacked center (label / headline / sub / CTA all centered)
|
||||
- Image-as-canvas with text overlaid in a clean safe area
|
||||
- Right-text / left-image (inverted classic)
|
||||
- Off-grid editorial offset
|
||||
- Mini Minimalist Hero (tiny logo + short statement + thin CTA, mostly negative space)
|
||||
|
||||
### Pre-output check
|
||||
Before rendering the hero image, ask yourself: "Am I drafting the default text-left / image-right layout out of habit?" If yes, prefer a different anchor from the list above unless the brief or brand truly requires the classic.
|
||||
|
||||
### Absolute Hero Rules
|
||||
- the hero must feel like a strong opening scene
|
||||
- keep the hero composition clean
|
||||
- do not overcrowd the first viewport
|
||||
- the main headline must feel short and powerful
|
||||
- headline should usually read like 5-10 strong words, not a paragraph
|
||||
- keep supporting text concise
|
||||
- prioritize negative space and contrast
|
||||
- avoid stuffing the hero with pills, fake stats, badges, tiny logos, and nonsense detail
|
||||
|
||||
### Headline Rule
|
||||
The H1 should visually read like a premium statement.
|
||||
Do not let it feel long, weak, or overly wrapped.
|
||||
|
||||
### Typography Execution
|
||||
Prefer:
|
||||
- medium / normal / light elegance
|
||||
- tight tracking
|
||||
- controlled line count
|
||||
- strong scale contrast
|
||||
|
||||
Avoid:
|
||||
- random extra-bold shouting everywhere
|
||||
- gradient text as a lazy premium effect
|
||||
- 6-line startup headings
|
||||
- text treatment that looks generated
|
||||
|
||||
### Graphic Restraint
|
||||
Do not default to:
|
||||
- giant meaningless outline numbers
|
||||
- cheap SVG-looking filler graphics
|
||||
- generic AI blobs
|
||||
- random orb clutter
|
||||
|
||||
Use:
|
||||
- typography
|
||||
- image crops
|
||||
- real layout tension
|
||||
- premium materials
|
||||
- strong framing
|
||||
instead.
|
||||
|
||||
---
|
||||
|
||||
## 5. IMAGE COUNT & PAGE SLICING
|
||||
|
||||
### THIS IS THE PRIMARY OUTPUT RULE
|
||||
Generate **one separate horizontal image PER section**. Always.
|
||||
|
||||
- never combine multiple sections in a single image
|
||||
- never return a single tall slice that contains the whole page
|
||||
- never return one "best" image and skip the rest
|
||||
- never replace several sections with one collage
|
||||
|
||||
If the request is ambiguous about section count, **default high**:
|
||||
- "hero" -> 1 image
|
||||
- "landing page" / "site template" -> default to 6 sections -> 6 images
|
||||
- "full website" -> default to 8 sections -> 8 images
|
||||
- "marketing site" -> default to 8 sections -> 8 images
|
||||
- "product page" -> default to 6 sections -> 6 images
|
||||
- "portfolio" -> default to 6 sections -> 6 images
|
||||
|
||||
If the model can only render one image per call, generate them **sequentially in the same response**, one after the other, labeled "Section X of N: <name>" until the full set is delivered.
|
||||
|
||||
### Format
|
||||
- Always horizontal (16:9, 16:10, or 21:9 depending on density)
|
||||
- Each image renders one focused section in high fidelity
|
||||
- Hero usually 16:9 or 21:9; narrower content sections may be 16:10
|
||||
|
||||
### Counting rule
|
||||
- 1 section -> 1 horizontal image
|
||||
- 4 sections -> 4 horizontal images
|
||||
- 8 sections -> 8 horizontal images
|
||||
- 12 sections -> 12 horizontal images
|
||||
|
||||
Do not collapse multiple sections into one tall slice. Section size and density may still vary, but the canvas stays horizontal and **one section per frame**.
|
||||
|
||||
### Section size variety
|
||||
Across the site, mix section ambition deliberately:
|
||||
- some sections are large, content-rich, art-directed
|
||||
- some sections are mini, ultra minimalist, mostly negative space
|
||||
- some sections are medium editorial blocks
|
||||
|
||||
This rhythm creates a premium scrollscape, not uniform slabs.
|
||||
|
||||
### Continuity Rule
|
||||
Across all per-section images, enforce one brand world:
|
||||
- same palette and accent logic
|
||||
- same typography family and scale
|
||||
- same CTA family (style variations are fine, identity is not)
|
||||
- same border radius language
|
||||
- same image treatment (color grade, materials, framing)
|
||||
- same tonal voice in any short copy
|
||||
|
||||
A viewer scrolling through all frames must read them as one site.
|
||||
|
||||
---
|
||||
|
||||
## 6. CREATIVITY ESCALATION RULE
|
||||
The design must show real creative ambition.
|
||||
|
||||
Do not settle for the first obvious layout solution.
|
||||
Push the work beyond generic SaaS patterns.
|
||||
|
||||
Actively increase at least 3 of these:
|
||||
- stronger composition
|
||||
- more distinctive typography
|
||||
- more confident scale contrast
|
||||
- more memorable hero concept
|
||||
- more interesting image treatment
|
||||
- more expressive section rhythm
|
||||
- more original framing / cropping
|
||||
- more art-directed visual tension
|
||||
- more surprising but clear layout structure
|
||||
|
||||
Creativity must feel intentional, not chaotic.
|
||||
|
||||
Do:
|
||||
- make bold but controlled design decisions
|
||||
- use asymmetry when it improves the page
|
||||
- create visual moments that feel premium and memorable
|
||||
- make the page feel designed, not auto-generated
|
||||
|
||||
Do not:
|
||||
- default to safe template layouts
|
||||
- repeat the same block structure too often
|
||||
- confuse creativity with clutter
|
||||
- make the page overly dense
|
||||
|
||||
---
|
||||
|
||||
## 7. IMAGE-FIRST ART DIRECTION
|
||||
This skill must actively use images.
|
||||
|
||||
Images are not optional decoration.
|
||||
Images are a core part of the frontend design language.
|
||||
|
||||
Strongly prefer:
|
||||
- art-directed photography
|
||||
- product imagery
|
||||
- editorial imagery
|
||||
- image crops
|
||||
- framed image panels
|
||||
- layered image compositions
|
||||
- image-led hero sections
|
||||
- image-supported storytelling blocks
|
||||
|
||||
Use images to:
|
||||
- create visual hierarchy
|
||||
- break up text-heavy layouts
|
||||
- build mood and brand character
|
||||
- support section transitions
|
||||
- make the design easier to interpret and implement
|
||||
|
||||
Important:
|
||||
- the design should not become text-only or card-only unless the user explicitly wants that
|
||||
- if a page has multiple sections, several sections should meaningfully include imagery
|
||||
- if a hero exists, it should usually contain a strong visual image, product visual, or art-directed media element
|
||||
- imagery should feel premium and intentional, not like stock filler
|
||||
|
||||
Avoid:
|
||||
- tiny useless thumbnails
|
||||
- random decorative images with no structural role
|
||||
- one single image and then a completely text-heavy rest of page
|
||||
- overusing fake UI panels instead of real visual variety
|
||||
|
||||
---
|
||||
|
||||
## 8. ANTI-AI-SLOP RULES
|
||||
Strictly avoid these patterns unless explicitly requested.
|
||||
|
||||
### Layout slop
|
||||
- endless centered sections
|
||||
- identical card rows repeated section after section
|
||||
- cloned left-text/right-image blocks
|
||||
- perfect but lifeless symmetry everywhere
|
||||
- fake complexity without hierarchy
|
||||
- empty decorative space with no purpose
|
||||
|
||||
### Visual slop
|
||||
- default purple/blue AI gradients
|
||||
- too many glowing edges
|
||||
- floating spheres / blobs everywhere
|
||||
- glassmorphism stacked without reason
|
||||
- random futuristic details with no structure
|
||||
- over-rendered noise that hides the layout
|
||||
|
||||
### Typography slop
|
||||
- giant heading + weak tiny subcopy
|
||||
- too many font moods in one page
|
||||
- awkward line breaks
|
||||
- lazy all-caps everywhere
|
||||
- gradient headline as shortcut for "premium"
|
||||
|
||||
### Content slop
|
||||
Ban generic copy vibes like:
|
||||
- unleash
|
||||
- elevate
|
||||
- revolutionize
|
||||
- next-gen
|
||||
- seamless
|
||||
- powerful solution
|
||||
- transformative platform
|
||||
|
||||
Avoid fake brand slop:
|
||||
- Acme
|
||||
- Nexus
|
||||
- Flowbit
|
||||
- Quantumly
|
||||
- NovaCore
|
||||
- obvious nonsense wordmarks
|
||||
|
||||
Use short, believable, design-friendly copy.
|
||||
|
||||
### Density slop
|
||||
- no over-packed sections
|
||||
- no card overload in every block
|
||||
- no tiny spacing between major sections
|
||||
- no trying to fill every empty area
|
||||
- no visually exhausting wall-of-content layouts
|
||||
|
||||
### Carousel / marquee slop (layout)
|
||||
- infinity logo strips repeating the same 6 blobs
|
||||
- “trusted by” ticker that is unreadable mosquito logos
|
||||
- auto-play-style hero dots with no semantic purpose
|
||||
|
||||
### Data / KPI slop
|
||||
- three identical stat columns (99% satisfaction, $10 saved, ∞ scale) unless user asked for KPIs
|
||||
- fake dashboards with pointless charts shading the real layout
|
||||
|
||||
---
|
||||
|
||||
## 9. TYPOGRAPHY-FIRST DISCIPLINE
|
||||
Typography is not filler.
|
||||
Typography is a primary design material.
|
||||
|
||||
Always ensure:
|
||||
- clear size contrast
|
||||
- obvious reading order
|
||||
- strong display moments
|
||||
- supporting text that is readable and brief
|
||||
- labels, captions, and section headings that reinforce structure
|
||||
|
||||
For editorial directions:
|
||||
- let typography shape composition
|
||||
|
||||
For tech/product directions:
|
||||
- let typography communicate trust and precision
|
||||
|
||||
---
|
||||
|
||||
## 10. SECTION RHYTHM RULE
|
||||
A high-end site does not feel like repeated boxes.
|
||||
|
||||
Vary section rhythm across the page by changing:
|
||||
- density
|
||||
- image-to-text ratio
|
||||
- alignment
|
||||
- scale
|
||||
- whitespace
|
||||
- card grouping
|
||||
- background intensity
|
||||
- visual tempo
|
||||
|
||||
Do not let every section feel generated from the same template.
|
||||
|
||||
Important:
|
||||
- rhythm variation should not break overall cleanliness
|
||||
- keep the page visually balanced from top to bottom
|
||||
- section heights may vary, but the spacing between sections should feel controlled and fairly even
|
||||
- avoid abrupt jumps between very small and very large sections without enough breathing room
|
||||
- the full page should feel curated, smooth, and consistent
|
||||
|
||||
---
|
||||
|
||||
## 11. COMPONENT EXECUTION GUIDELINES
|
||||
|
||||
### Diagonal Staggered Square Masonry
|
||||
Use square image or content blocks with strong staggered vertical rhythm.
|
||||
Should feel curated and graphic, not messy.
|
||||
|
||||
### 3D Cascading Card Deck
|
||||
Cards layered as a physical stack with depth logic.
|
||||
Should feel premium and tactile, not gimmicky.
|
||||
|
||||
### Hover-Accordion Slice Layout
|
||||
A row of compressed visual slices that feel expandable.
|
||||
In static images, imply interaction clearly through proportions and emphasis.
|
||||
|
||||
### Pristine Gapless Bento Grid
|
||||
Mathematically clean grid.
|
||||
No accidental gaps.
|
||||
Mix large visual blocks with smaller dense information panels.
|
||||
|
||||
### Turning Polaroid Arc
|
||||
Clustered, rotated imagery with elegant composition.
|
||||
Should feel styled and intentional, not scrapbook-random.
|
||||
|
||||
### Off-Grid Editorial Layout
|
||||
Use asymmetry and tension with control.
|
||||
Must remain readable and clearly structured.
|
||||
|
||||
### Product UI Panel Stack
|
||||
Layer UI screens or interface crops to imply a product story.
|
||||
Avoid generic fake dashboards.
|
||||
|
||||
### Vertical Rhythm Lines
|
||||
Use fine lines and spacing systems to reinforce order and elegance.
|
||||
Never let them become decorative clutter.
|
||||
|
||||
---
|
||||
|
||||
## 12. DENSITY & SPACING DISCIPLINE
|
||||
Do not make everything too dense.
|
||||
|
||||
The page should breathe.
|
||||
Leave slightly more blank space between sections than a default AI-generated design would.
|
||||
|
||||
Rules:
|
||||
- use more even vertical spacing between major sections
|
||||
- keep section-to-section spacing consistent unless there is a strong design reason not to
|
||||
- avoid one section feeling very cramped while the next feels too empty
|
||||
- prefer a clean, balanced cadence across the page
|
||||
- allow negative space to create rhythm and emphasis
|
||||
- separate denser sections with calmer sections
|
||||
- avoid stacking too many cards, labels, and content blocks too tightly
|
||||
- smaller sections should still receive enough surrounding space so the page feels polished and intentional
|
||||
|
||||
A premium page should feel:
|
||||
- open
|
||||
- composed
|
||||
- balanced
|
||||
- confident
|
||||
- breathable
|
||||
|
||||
Not:
|
||||
- cramped
|
||||
- noisy
|
||||
- uneven
|
||||
- overfilled
|
||||
- visually exhausted
|
||||
|
||||
Section rhythm should alternate with control:
|
||||
- some sections can be more content-rich
|
||||
- some sections can be smaller and calmer
|
||||
- but the overall spacing cadence should still feel even, clean, and deliberate
|
||||
|
||||
Whitespace is a design tool.
|
||||
Use it deliberately.
|
||||
Do not let spacing become random.
|
||||
|
||||
---
|
||||
|
||||
## 13. COLOR & MATERIAL RULES
|
||||
|
||||
### Palette Discipline
|
||||
Use one controlled palette across the entire site:
|
||||
- 1 primary (brand anchor)
|
||||
- 1 secondary (supporting tone)
|
||||
- 1 accent (used sparingly for CTA / highlight)
|
||||
- a neutral scale (background, surface, text, hairline)
|
||||
|
||||
Section-level mood shifts must reuse the same palette — no full theme swap per section.
|
||||
|
||||
### Background-image harmony
|
||||
When using full-bleed image backgrounds:
|
||||
- the image must tonally match the palette (not fight it)
|
||||
- use overlays (dark, light, or color tint) to keep text fully readable
|
||||
- the brand accent stays consistent regardless of background image
|
||||
|
||||
### Gradient Discipline
|
||||
Gradients are **allowed and encouraged** when professional and subtle. They are not the same as AI slop gradients.
|
||||
|
||||
Allowed (use confidently):
|
||||
- low-chroma palette-matched tonal gradients (e.g. ink to graphite, cream to sand, ivory to warm grey)
|
||||
- single-hue atmospheric grades behind hero photography
|
||||
- soft vignettes and radial depth that direct the eye
|
||||
- noise-textured gradients adding tactile depth without color noise
|
||||
- editorial color washes that match brand mood
|
||||
|
||||
Banned (AI gradient slop):
|
||||
- rainbow / mesh blob gradients
|
||||
- purple-to-blue "AI" defaults
|
||||
- pink-to-orange "creator" defaults
|
||||
- neon edges and glow halos with no purpose
|
||||
- gradient text as a shortcut for "premium"
|
||||
- gradients that compete with imagery instead of supporting it
|
||||
|
||||
### Background Confidence Rule
|
||||
Do not retreat to plain white surfaces by default. When the brief, brand mood, or section job calls for atmosphere, use:
|
||||
- a full-bleed image,
|
||||
- a duotone or graded photo,
|
||||
- a tonal gradient,
|
||||
- a tactile material,
|
||||
or a confident flat color field — picked deliberately, not as decoration.
|
||||
|
||||
### Strong guidance
|
||||
- avoid rainbow randomness
|
||||
- avoid over-neon unless requested
|
||||
- keep contrast intentional
|
||||
- match accent colors to the chosen theme paradigm
|
||||
- gradients must always read as professional and intentional, never as visual noise
|
||||
|
||||
### Materiality
|
||||
Where appropriate, add:
|
||||
- paper feel
|
||||
- glass feel
|
||||
- brushed metal feel
|
||||
- soft blur depth
|
||||
- tactile matte surfaces
|
||||
- editorial photo treatment
|
||||
|
||||
But always keep the frontend structure readable.
|
||||
|
||||
---
|
||||
|
||||
## 14. IMAGE / MEDIA DIRECTION
|
||||
If imagery is present, it must support the layout.
|
||||
|
||||
Allowed:
|
||||
- art-directed product visuals
|
||||
- refined editorial photography
|
||||
- UI crops
|
||||
- abstract forms with structural purpose
|
||||
- framed objects
|
||||
- premium texture use
|
||||
- campaign-style visuals
|
||||
|
||||
Avoid:
|
||||
- irrelevant scenery
|
||||
- stock-photo cliches
|
||||
- decorative junk
|
||||
- visuals that overpower the page hierarchy
|
||||
|
||||
---
|
||||
|
||||
## 15. DEFAULT SITE PACKS
|
||||
|
||||
### 4-section pack
|
||||
1. Hero
|
||||
2. Features
|
||||
3. Social proof / testimonial
|
||||
4. CTA
|
||||
|
||||
### 8-section pack
|
||||
1. Hero
|
||||
2. Trust bar
|
||||
3. Features
|
||||
4. Product showcase
|
||||
5. Benefits / use cases
|
||||
6. Testimonials
|
||||
7. Pricing
|
||||
8. CTA
|
||||
|
||||
### 12-section pack
|
||||
1. Hero
|
||||
2. Trust bar
|
||||
3. Feature grid
|
||||
4. Product preview
|
||||
5. Problem / solution
|
||||
6. Benefits
|
||||
7. Workflow
|
||||
8. Metrics / proof / integration
|
||||
9. Testimonials
|
||||
10. Pricing
|
||||
11. FAQ
|
||||
12. CTA + footer
|
||||
|
||||
---
|
||||
|
||||
## 16. MULTI-IMAGE CONSISTENCY RULE
|
||||
Because every section is its own image, consistency is critical. Across all per-section frames enforce:
|
||||
- same brand world
|
||||
- same type scale logic
|
||||
- same spacing discipline
|
||||
- same CTA family (style variations are fine, identity is not)
|
||||
- same icon or illustration mood
|
||||
- same image treatment (grade, framing, material vocabulary)
|
||||
- same tonal language in any copy
|
||||
|
||||
Variation IS allowed in:
|
||||
- composition anchor (per section)
|
||||
- background mode (per section)
|
||||
- section size and density
|
||||
- which "second-read" moment appears
|
||||
|
||||
A viewer flipping through every per-section frame must still recognize one brand. Anything that breaks brand recall is over-variation.
|
||||
|
||||
---
|
||||
|
||||
## 17. CLARITY CHECK
|
||||
Before finalizing, verify internally:
|
||||
|
||||
1. Is the hierarchy obvious?
|
||||
2. Is the hero clean enough?
|
||||
3. Is the design visually distinctive?
|
||||
4. Is it free of obvious AI tells?
|
||||
5. Is it premium rather than template-like?
|
||||
6. Can someone code from this?
|
||||
7. If multiple images exist, do they clearly belong together?
|
||||
8. Is imagery used strongly enough (with variation, not one repeated crop)?
|
||||
9. Does the page breathe, or is it too dense?
|
||||
10. Is there enough spacing between sections?
|
||||
11. Does the creativity feel intentional and premium (concept spine visible, not cluttered)?
|
||||
12. Is the spacing between sections even and controlled?
|
||||
13. Do smaller sections still have enough surrounding space to feel clean?
|
||||
14. Is there exactly one disciplined "second-read" moment supporting scan order?
|
||||
15. Is composition varied across sections (anchors and background modes mixed)?
|
||||
16. Is the hero scale (giant / mid / mini) chosen and executed cleanly?
|
||||
17. Is there a clear conversion path (hook -> proof -> action) even in artistic sites?
|
||||
18. Is the palette consistent across all per-section images?
|
||||
19. Is each image horizontal and one-section-only?
|
||||
20. Is the **total number of images equal to the number of sections** (never fewer)?
|
||||
21. Is the hero using a varied composition (not defaulting to left-text / right-image out of habit)?
|
||||
|
||||
If not, refine internally before output. If the count is wrong, regenerate the missing sections. If the hero feels like a reflexive left-text / right-image default, prefer a different composition anchor.
|
||||
|
||||
---
|
||||
|
||||
## 18. EXTRA CREATIVITY & IMPLEMENTATION EDGE
|
||||
|
||||
Apply unless the user opts out:
|
||||
|
||||
### Cross-section contrast
|
||||
Across the slice, deliberately vary foreground/background intensity at least twice (lighter → richer → calmer) so the scroll feels paced, not monotonous slabs.
|
||||
|
||||
### CTA specificity
|
||||
Prefer one unmistakable primary action per major viewport tier; secondary actions must look secondary (scale, outline, ghost), not clones of primary.
|
||||
|
||||
### Image variety inside one comp
|
||||
Mix at least **two distinct image crops** where multiple sections exist — e.g. macro product + contextual environment, or portrait editorial + widescreen artifact — avoiding one repeated stock silhouette.
|
||||
|
||||
### Data-viz restraint
|
||||
Charts, sparklines, and graphs appear only when the site type logically needs them (analytics, pricing, infra, observability brands). Else keep proof human (quotes, receipts, timelines, screenshots of real workflows).
|
||||
|
||||
### Cultural / tonal alignment
|
||||
When the brief names an industry or region, steer palette and typographic temperament to match — don’t ship default “neutral SF startup” unless the brief is intentionally generic SaaS.
|
||||
|
||||
### Mobile-implied fidelity (even for desktop mocks)
|
||||
Maintain tap-friendly hit sizes and readable caption sizes visually; stacking order should imply a sane single-column narrative.
|
||||
|
||||
### Conversion focus
|
||||
Each section has a job. Even when the design is artistic, the page must read as a real product or brand site:
|
||||
- the hero communicates value in seconds and offers one obvious next action
|
||||
- proof sections (logos, quotes, metrics) feel earned, not stuffed
|
||||
- pricing or CTA sections feel decisive, not buried
|
||||
- the final section closes: a single strong CTA + supporting trust cue
|
||||
Avoid pure mood reels with no funnel logic.
|
||||
|
||||
### Composition variety check
|
||||
Across all per-section images, internally log the chosen composition anchor and background mode. Reject the set if:
|
||||
- the same composition anchor repeats more than 2 sections in a row
|
||||
- the same background mode repeats more than 3 sections in a row
|
||||
- every section is inline-asset (no full-bleed background ever appears) **AND** the brief does not call for minimalism / typography-only / swiss / ultra simple
|
||||
|
||||
For non-minimalist briefs: push for at least one full-bleed (or duotone / atmospheric) background and at least one mini minimalist section in any multi-section site.
|
||||
|
||||
For minimalist briefs: this rule is suspended. Restraint is the design.
|
||||
|
||||
---
|
||||
|
||||
## 19. RESPONSE BEHAVIOR
|
||||
When the user asks for a frontend design:
|
||||
1. infer site type and primary conversion goal
|
||||
2. infer number of sections (if unclear, use the defaults from §5: landing page = 6, full website = 8)
|
||||
3. **commit out loud** to the section count and announce it ("Generating N horizontal images, one per section")
|
||||
4. plan ONE horizontal image PER SECTION — always separate generations, never collapse
|
||||
5. choose Hero Scale for the whole site (giant / mid / mini)
|
||||
5. choose a strong visual combination (theme, type, hero arch, section system, motion, narrative spine, second-read moment)
|
||||
7. for each section: pick a Composition Anchor, Background Mode, and CTA Variation — vary across sections
|
||||
8. choose 4 signature components used appropriately across sections
|
||||
9. enforce hero minimalism + section size variety (some giant, some mini)
|
||||
10. enforce strong image usage including full-bleed backgrounds where it fits
|
||||
11. lock one consistent palette across all images
|
||||
12. apply §18 EXTRA CREATIVITY & IMPLEMENTATION EDGE
|
||||
13. keep spacing generous, even, and clean
|
||||
14. remove AI slop (including marquee / fake KPI clichés unless requested)
|
||||
15. run §17 CLARITY CHECK
|
||||
16. **generate every per-section horizontal image, labeled "Section X of N: <name>"**, until the full set is delivered. Do not stop early. Do not summarize. Do not return only one image.
|
||||
|
||||
Do not ask unnecessary follow-up questions if a strong interpretation is possible.
|
||||
|
||||
---
|
||||
|
||||
## 20. EXAMPLE INTERPRETATIONS
|
||||
|
||||
### Example 1
|
||||
User: "make a hero section for an AI startup"
|
||||
|
||||
Interpretation:
|
||||
- 1 horizontal image
|
||||
- Hero Scale: Mid Editorial or Giant Statement
|
||||
- Composition Anchor: bottom-left text over full-bleed product/atmosphere image
|
||||
- Background Mode: full-bleed image with dark tonal overlay
|
||||
- CTA Variation: outlined inline + small label hint
|
||||
- Palette: Deep Dark or Bold Studio Solid, one consistent accent
|
||||
- no cliche dashboard spam, no purple AI glow
|
||||
|
||||
### Example 2
|
||||
User: "design 8 sections for a fintech website"
|
||||
|
||||
Interpretation:
|
||||
- 8 separate horizontal images (one per section)
|
||||
- Hero Scale: Mid Editorial (trust-driven)
|
||||
- vary Composition Anchor across sections (centered low, right-third caption, bottom-left over chart visual, stacked center for closing CTA)
|
||||
- Background Mode mix: solid surface, full-bleed image background once, editorial side-image at use cases
|
||||
- one consistent palette (e.g. ink + paper + single brand accent)
|
||||
- conversion path: hook -> proof bar -> features -> use case -> testimonial -> pricing -> FAQ -> final CTA
|
||||
|
||||
### Example 3
|
||||
User: "creative agency landing page, 12 sections"
|
||||
|
||||
Interpretation:
|
||||
- 12 horizontal images (one per section)
|
||||
- Hero Scale: Giant Statement OR Mini Minimalist (decisive choice, not in-between)
|
||||
- editorial / poster-like direction; off-grid composition appears 2-3 times
|
||||
- multiple Background Modes (full-bleed image at hero + showcase, editorial side-image at case studies, solid + accent for process)
|
||||
- palette consistent throughout, with one bold accent recurring
|
||||
- closing CTA section: mini minimalist, strong type, single primary action
|
||||
|
||||
---
|
||||
|
||||
## 21. FINAL GOAL
|
||||
Generate frontend reference images that feel:
|
||||
- artistic
|
||||
- premium
|
||||
- clear
|
||||
- structured
|
||||
- image-led
|
||||
- breathable
|
||||
- memorable
|
||||
- anti-generic
|
||||
- implementation-friendly
|
||||
|
||||
The result should look like a top-tier website concept with strong imagery, confident creativity, and generous spacing - not a dense, repetitive AI layout.
|
||||
92
.agents/skills/industrial-brutalist-ui/SKILL.md
Normal file
92
.agents/skills/industrial-brutalist-ui/SKILL.md
Normal file
@@ -0,0 +1,92 @@
|
||||
---
|
||||
name: industrial-brutalist-ui
|
||||
description: Raw mechanical interfaces fusing Swiss typographic print with military terminal aesthetics. Rigid grids, extreme type scale contrast, utilitarian color, analog degradation effects. For data-heavy dashboards, portfolios, or editorial sites that need to feel like declassified blueprints.
|
||||
---
|
||||
|
||||
# SKILL: Industrial Brutalism & Tactical Telemetry UI
|
||||
|
||||
## 1. Skill Meta
|
||||
**Name:** Industrial Brutalism & Tactical Telemetry Interface Engineering
|
||||
**Description:** Advanced proficiency in architecting web interfaces that synthesize mid-century Swiss Typographic design, industrial manufacturing manuals, and retro-futuristic aerospace/military terminal interfaces. This discipline requires absolute mastery over rigid modular grids, extreme typographic scale contrast, purely utilitarian color palettes, and the programmatic simulation of analog degradation (halftones, CRT scanlines, bitmap dithering). The objective is to construct digital environments that project raw functionality, mechanical precision, and high data density, deliberately discarding conventional consumer UI patterns.
|
||||
|
||||
## 2. Visual Archetypes
|
||||
The design system operates by merging two distinct but highly compatible visual paradigms. **Pick ONE per project and commit to it. Do not alternate or mix both modes within the same interface.**
|
||||
|
||||
### 2.1 Swiss Industrial Print
|
||||
Derived from 1960s corporate identity systems and heavy machinery blueprints.
|
||||
* **Characteristics:** High-contrast light modes (newsprint/off-white substrates). Reliance on monolithic, heavy sans-serif typography. Unforgiving structural grids outlined by visible dividing lines. Aggressive, asymmetric use of negative space punctuated by oversized, viewport-bleeding numerals or letterforms. Heavy use of primary red as an alert/accent color.
|
||||
|
||||
### 2.2 Tactical Telemetry & CRT Terminal
|
||||
Derived from classified military databases, legacy mainframes, and aerospace Heads-Up Displays (HUDs).
|
||||
* **Characteristics:** Dark mode exclusivity. High-density tabular data presentation. Absolute dominance of monospaced typography. Integration of technical framing devices (ASCII brackets, crosshairs). Application of simulated hardware limitations (phosphor glow, scanlines, low bit-depth rendering).
|
||||
|
||||
## 3. Typographic Architecture
|
||||
Typography is the primary structural and decorative infrastructure. Imagery is secondary. The system demands extreme variance in scale, weight, and spacing.
|
||||
|
||||
### 3.1 Macro-Typography (Structural Headers)
|
||||
* **Classification:** Neo-Grotesque / Heavy Sans-Serif.
|
||||
* **Optimal Web Fonts:** Neue Haas Grotesk (Black), Inter (Extra Bold/Black), Archivo Black, Roboto Flex (Heavy), Monument Extended.
|
||||
* **Implementation Parameters:**
|
||||
* **Scale:** Deployed at massive scales using fluid typography (e.g., `clamp(4rem, 10vw, 15rem)`).
|
||||
* **Tracking (Letter-spacing):** Extremely tight, often negative (`-0.03em` to `-0.06em`), forcing glyphs to form solid architectural blocks.
|
||||
* **Leading (Line-height):** Highly compressed (`0.85` to `0.95`).
|
||||
* **Casing:** Exclusively uppercase for structural impact.
|
||||
|
||||
### 3.2 Micro-Typography (Data & Telemetry)
|
||||
* **Classification:** Monospace / Technical Sans.
|
||||
* **Optimal Web Fonts:** JetBrains Mono, IBM Plex Mono, Space Mono, VT323, Courier Prime.
|
||||
* **Implementation Parameters:**
|
||||
* **Scale:** Fixed and small (`10px` to `14px` / `0.7rem` to `0.875rem`).
|
||||
* **Tracking:** Generous (`0.05em` to `0.1em`) to simulate mechanical typewriter spacing or terminal matrices.
|
||||
* **Leading:** Standard to tight (`1.2` to `1.4`).
|
||||
* **Casing:** Exclusively uppercase. Used for all metadata, navigation, unit IDs, and coordinates.
|
||||
|
||||
### 3.3 Textural Contrast (Artistic Disruption)
|
||||
* **Classification:** High-Contrast Serif.
|
||||
* **Optimal Web Fonts:** Playfair Display, EB Garamond, Times New Roman.
|
||||
* **Implementation Parameters:** Used exceedingly sparingly. Must be subjected to heavy post-processing (halftone filters, 1-bit dithering) to degrade vector perfection and create textural juxtaposition against the clean sans-serifs.
|
||||
|
||||
## 4. Color System
|
||||
The color architecture is uncompromising. Gradients, soft drop shadows, and modern translucency are strictly prohibited. Colors simulate physical media or primitive emissive displays.
|
||||
|
||||
**CRITICAL: Choose ONE substrate palette per project and use it consistently. Never mix light and dark substrates within the same interface.**
|
||||
|
||||
### If Swiss Industrial Print (Light):
|
||||
* **Background:** `#F4F4F0` or `#EAE8E3` (Matte, unbleached documentation paper).
|
||||
* **Foreground:** `#050505` to `#111111` (Carbon Ink).
|
||||
* **Accent:** `#E61919` or `#FF2A2A` (Aviation/Hazard Red). This is the ONLY accent color. Used for strike-throughs, thick structural dividing lines, or vital data highlights.
|
||||
|
||||
### If Tactical Telemetry (Dark):
|
||||
* **Background:** `#0A0A0A` or `#121212` (Deactivated CRT. Avoid pure `#000000`).
|
||||
* **Foreground:** `#EAEAEA` (White phosphor). This is the primary text color.
|
||||
* **Accent:** `#E61919` or `#FF2A2A` (Aviation/Hazard Red). Same red, same rules.
|
||||
* **Terminal Green (`#4AF626`):** Optional. Use ONLY for a single specific UI element (e.g., one status indicator or one data readout) — never as a general text color. If it doesn't serve a clear purpose, omit it entirely.
|
||||
|
||||
## 5. Layout and Spatial Engineering
|
||||
The layout must appear mathematically engineered. It rejects conventional web padding in favor of visible compartmentalization.
|
||||
|
||||
* **The Blueprint Grid:** Strict adherence to CSS Grid architectures. Elements do not float; they are anchored precisely to grid tracks and intersections.
|
||||
* **Visible Compartmentalization:** Extensive utilization of solid borders (`1px` or `2px solid`) to delineate distinct zones of information. Horizontal rules (`<hr>`) frequently span the entire container width to segregate operational units.
|
||||
* **Bimodal Density:** Layouts oscillate between extreme data density (tightly packed monospace metadata clustered together) and vast expanses of calculated negative space framing macro-typography.
|
||||
* **Geometry:** Absolute rejection of `border-radius`. All corners must be exactly 90 degrees to enforce mechanical rigidity.
|
||||
|
||||
## 6. UI Components and Symbology
|
||||
Standard web UI conventions are replaced with utilitarian, industrial graphic elements.
|
||||
|
||||
* **Syntax Decoration:** Utilization of ASCII characters to frame data points.
|
||||
* *Framing:* `[ DELIVERY SYSTEMS ]`, `< RE-IND >`
|
||||
* *Directional:* `>>>`, `///`, `\\\\`
|
||||
* **Industrial Markers:** Prominent integration of registration (`®`), copyright (`©`), and trademark (`™`) symbols functioning as structural geometric elements rather than legal text.
|
||||
* **Technical Assets:** Integration of crosshairs (`+`) at grid intersections, repeating vertical lines (barcodes), thick horizontal warning stripes, and randomized string data (e.g., `REV 2.6`, `UNIT / D-01`) to simulate active mechanical processes.
|
||||
|
||||
## 7. Textural and Post-Processing Effects
|
||||
To prevent the design from appearing purely digital, simulated analog degradation is engineered into the frontend via CSS and SVG filters.
|
||||
|
||||
* **Halftone and 1-Bit Dithering:** Transforming continuous-tone images or large serif typography into dot-matrix patterns. Achieved via pre-processing or CSS `mix-blend-mode: multiply` overlays combined with SVG radial dot patterns.
|
||||
* **CRT Scanlines:** For terminal interfaces, applying a `repeating-linear-gradient` to the background to simulate horizontal electron beam sweeps (e.g., `repeating-linear-gradient(0deg, transparent, transparent 2px, rgba(0,0,0,0.1) 2px, rgba(0,0,0,0.1) 4px)`).
|
||||
* **Mechanical Noise:** A global, low-opacity SVG static/noise filter applied to the DOM root to introduce a unified physical grain across both dark and light modes.
|
||||
|
||||
## 8. Web Engineering Directives
|
||||
1. **Grid Determinism:** Utilize `display: grid; gap: 1px;` with contrasting parent/child background colors to generate mathematically perfect, razor-thin dividing lines without complex border declarations.
|
||||
2. **Semantic Rigidity:** Construct the DOM using precise semantic tags (`<data>`, `<samp>`, `<kbd>`, `<output>`, `<dl>`) to accurately reflect the technical nature of the telemetry.
|
||||
3. **Typography Clamping:** Implement CSS `clamp()` functions exclusively for macro-typography to ensure massive text scales aggressively while maintaining structural integrity across viewports.
|
||||
85
.agents/skills/minimalist-ui/SKILL.md
Normal file
85
.agents/skills/minimalist-ui/SKILL.md
Normal file
@@ -0,0 +1,85 @@
|
||||
---
|
||||
name: minimalist-ui
|
||||
description: Clean editorial-style interfaces. Warm monochrome palette, typographic contrast, flat bento grids, muted pastels. No gradients, no heavy shadows.
|
||||
---
|
||||
|
||||
# Protocol: Premium Utilitarian Minimalism UI Architect
|
||||
|
||||
## 1. Protocol Overview
|
||||
Name: Premium Utilitarian Minimalism & Editorial UI
|
||||
Description: An advanced frontend engineering directive for generating highly refined, ultra-minimalist, "document-style" web interfaces analogous to top-tier workspace platforms. This protocol strictly enforces a high-contrast warm monochrome palette, bespoke typographic hierarchies, meticulous structural macro-whitespace, bento-grid layouts, and an ultra-flat component architecture with deliberate muted pastel accents. It actively rejects standard generic SaaS design trends.
|
||||
|
||||
## 2. Absolute Negative Constraints (Banned Elements)
|
||||
The AI must strictly avoid the following generic web development defaults:
|
||||
- DO NOT use the "Inter", "Roboto", or "Open Sans" typefaces.
|
||||
- DO NOT use generic, thin-line icon libraries like "Lucide", "Feather", or standard "Heroicons".
|
||||
- DO NOT use Tailwind's default heavy drop shadows (e.g., `shadow-md`, `shadow-lg`, `shadow-xl`). Shadows must be practically non-existent or heavily customized to be ultra-diffuse and low opacity (< 0.05).
|
||||
- DO NOT use primary colored backgrounds for large elements or sections (e.g., no bright blue, green, or red hero sections).
|
||||
- DO NOT use gradients, neon colors, or 3D glassmorphism (beyond subtle navbar blurs).
|
||||
- DO NOT use `rounded-full` (pill shapes) for large containers, cards, or primary buttons.
|
||||
- DO NOT use emojis anywhere in code, markup, text content, headings, or alt text. Replace with proper icons or clean SVG primitives.
|
||||
- DO NOT use generic placeholder names like "John Doe", "Acme Corp", or "Lorem Ipsum". Use realistic, contextual content.
|
||||
- DO NOT use AI copywriting clichés: "Elevate", "Seamless", "Unleash", "Next-Gen", "Game-changer", "Delve". Write plain, specific language.
|
||||
|
||||
## 3. Typographic Architecture
|
||||
The interface must rely on extreme typographic contrast and premium font selection to establish an editorial feel.
|
||||
- Primary Sans-Serif (Body, UI, Buttons): Use clean, geometric, or system-native fonts with character. Target: `font-family: 'SF Pro Display', 'Geist Sans', 'Helvetica Neue', 'Switzer', sans-serif`.
|
||||
- Editorial Serif (Hero Headings & Quotes): Target: `font-family: 'Lyon Text', 'Newsreader', 'Playfair Display', 'Instrument Serif', serif`. Apply tight tracking (`letter-spacing: -0.02em` to `-0.04em`) and tight line-height (`1.1`).
|
||||
- Monospace (Code, Keystrokes, Meta-data): Target: `font-family: 'Geist Mono', 'SF Mono', 'JetBrains Mono', monospace`.
|
||||
- Text Colors: Body text must never be absolute black (`#000000`). Use off-black/charcoal (`#111111` or `#2F3437`) with a generous `line-height` of `1.6` for legibility. Secondary text should be muted gray (`#787774`).
|
||||
|
||||
## 4. Color Palette (Warm Monochrome + Spot Pastels)
|
||||
Color is a scarce resource, utilized only for semantic meaning or subtle accents.
|
||||
- Canvas / Background: Pure White `#FFFFFF` or Warm Bone/Off-White `#F7F6F3` / `#FBFBFA`.
|
||||
- Primary Surface (Cards): `#FFFFFF` or `#F9F9F8`.
|
||||
- Structural Borders / Dividers: Ultra-light gray `#EAEAEA` or `rgba(0,0,0,0.06)`.
|
||||
- Accent Colors: Exclusively use highly desaturated, washed-out pastels for tags, inline code backgrounds, or subtle icon backgrounds.
|
||||
- Pale Red: `#FDEBEC` (Text: `#9F2F2D`)
|
||||
- Pale Blue: `#E1F3FE` (Text: `#1F6C9F`)
|
||||
- Pale Green: `#EDF3EC` (Text: `#346538`)
|
||||
- Pale Yellow: `#FBF3DB` (Text: `#956400`)
|
||||
|
||||
## 5. Component Specifications
|
||||
- Bento Box Feature Grids:
|
||||
- Utilize asymmetrical CSS Grid layouts.
|
||||
- Cards must have exactly `border: 1px solid #EAEAEA`.
|
||||
- Border-radius must be crisp: `8px` or `12px` maximum.
|
||||
- Internal padding must be generous (e.g., `24px` to `40px`).
|
||||
- Primary Call-To-Action (Buttons):
|
||||
- Solid background `#111111`, text `#FFFFFF`.
|
||||
- Slight border-radius (`4px` to `6px`). No box-shadow.
|
||||
- Hover state should be a subtle color shift to `#333333` or a micro-scale `transform: scale(0.98)`.
|
||||
- Tags & Status Badges:
|
||||
- Pill-shaped (`border-radius: 9999px`), very small typography (`text-xs`), uppercase with wide tracking (`letter-spacing: 0.05em`).
|
||||
- Background must use the defined Muted Pastels.
|
||||
- Accordions (FAQ):
|
||||
- Strip all container boxes. Separate items only with a `border-bottom: 1px solid #EAEAEA`.
|
||||
- Use a clean, sharp `+` and `-` icon for the toggle state.
|
||||
- Keystroke Micro-UIs:
|
||||
- Render shortcuts as physical keys using `<kbd>` tags: `border: 1px solid #EAEAEA`, `border-radius: 4px`, `background: #F7F6F3`, using the Monospace font.
|
||||
- Faux-OS Window Chrome:
|
||||
- When mocking up software, wrap it in a minimalist container with a white top bar containing three small, light gray circles (replicating macOS window controls).
|
||||
|
||||
## 6. Iconography & Imagery Directives
|
||||
- System Icons: Use "Phosphor Icons (Bold or Fill weights)" or "Radix UI Icons" for a technical, slightly thicker-stroke aesthetic. Standardize stroke width across all icons.
|
||||
- Illustrations: Monochromatic, rough continuous-line ink sketches on a white background, featuring a single offset geometric shape filled with a muted pastel color.
|
||||
- Photography: Use high-quality, desaturated images with a warm tone. Apply subtle overlays (`opacity: 0.04` warm grain) to blend photos into the monochrome palette. Never use oversaturated stock photos. Use reliable placeholders like `https://picsum.photos/seed/{context}/1200/800` when real assets are unavailable.
|
||||
- Hero & Section Backgrounds: Sections should not feel empty and flat. Use subtle full-width background imagery at very low opacity, soft radial light spots (`radial-gradient` with warm tones at `opacity: 0.03`), or minimal geometric line patterns to add depth without breaking the clean aesthetic.
|
||||
|
||||
## 7. Subtle Motion & Micro-Animations
|
||||
Motion should feel invisible — present but never distracting. The goal is quiet sophistication, not spectacle.
|
||||
- Scroll Entry: Elements fade in gently as they enter the viewport. Use `translateY(12px)` + `opacity: 0` resolving over `600ms` with `cubic-bezier(0.16, 1, 0.3, 1)`. Use `IntersectionObserver`, never `window.addEventListener('scroll')`.
|
||||
- Hover States: Cards lift with an ultra-subtle shadow shift (`box-shadow` transitioning from `0 0 0` to `0 2px 8px rgba(0,0,0,0.04)` over `200ms`). Buttons respond with `scale(0.98)` on `:active`.
|
||||
- Staggered Reveals: Lists and grid items enter with a cascade delay (`animation-delay: calc(var(--index) * 80ms)`). Never mount everything at once.
|
||||
- Background Ambient Motion: Optional. A single, very slow-moving radial gradient blob (`animation-duration: 20s+`, `opacity: 0.02-0.04`) drifting behind hero sections. Must be applied to a `position: fixed; pointer-events: none` layer. Never on scrolling containers.
|
||||
- Performance: Animate exclusively via `transform` and `opacity`. No layout-triggering properties (`top`, `left`, `width`, `height`). Use `will-change: transform` sparingly and only on actively animating elements.
|
||||
|
||||
## 8. Execution Protocol
|
||||
When tasked with writing frontend code (HTML, React, Tailwind, Vue) or designing a layout:
|
||||
1. Establish the macro-whitespace first. Use massive vertical padding between sections (e.g., `py-24` or `py-32` in Tailwind).
|
||||
2. Constrain the main typography content width to `max-w-4xl` or `max-w-5xl`.
|
||||
3. Apply the custom typographic hierarchy and monochromatic color variables immediately.
|
||||
4. Ensure every card, divider, and border adheres strictly to the `1px solid #EAEAEA` rule.
|
||||
5. Add scroll-entry animations to all major content blocks.
|
||||
6. Ensure sections have visual depth through imagery, ambient gradients, or subtle textures — no empty flat backgrounds.
|
||||
7. Provide code that reflects this high-end, uncluttered, editorial aesthetic natively without requiring manual adjustments.
|
||||
178
.agents/skills/redesign-existing-projects/SKILL.md
Normal file
178
.agents/skills/redesign-existing-projects/SKILL.md
Normal file
@@ -0,0 +1,178 @@
|
||||
---
|
||||
name: redesign-existing-projects
|
||||
description: Upgrades existing websites and apps to premium quality. Audits current design, identifies generic AI patterns, and applies high-end design standards without breaking functionality. Works with any CSS framework or vanilla CSS.
|
||||
---
|
||||
|
||||
# Redesign Skill
|
||||
|
||||
## How This Works
|
||||
|
||||
When applied to an existing project, follow this sequence:
|
||||
|
||||
1. **Scan** — Read the codebase. Identify the framework, styling method (Tailwind, vanilla CSS, styled-components, etc.), and current design patterns.
|
||||
2. **Diagnose** — Run through the audit below. List every generic pattern, weak point, and missing state you find.
|
||||
3. **Fix** — Apply targeted upgrades working with the existing stack. Do not rewrite from scratch. Improve what's there.
|
||||
|
||||
## Design Audit
|
||||
|
||||
### Typography
|
||||
|
||||
Check for these problems and fix them:
|
||||
|
||||
- **Browser default fonts or Inter everywhere.** Replace with a font that has character. Good options: `Geist`, `Outfit`, `Cabinet Grotesk`, `Satoshi`. For editorial/creative projects, pair a serif header with a sans-serif body.
|
||||
- **Headlines lack presence.** Increase size for display text, tighten letter-spacing, reduce line-height. Headlines should feel heavy and intentional.
|
||||
- **Body text too wide.** Limit paragraph width to roughly 65 characters. Increase line-height for readability.
|
||||
- **Only Regular (400) and Bold (700) weights used.** Introduce Medium (500) and SemiBold (600) for more subtle hierarchy.
|
||||
- **Numbers in proportional font.** Use a monospace font or enable tabular figures (`font-variant-numeric: tabular-nums`) for data-heavy interfaces.
|
||||
- **Missing letter-spacing adjustments.** Use negative tracking for large headers, positive tracking for small caps or labels.
|
||||
- **All-caps subheaders everywhere.** Try lowercase italics, sentence case, or small-caps instead.
|
||||
- **Orphaned words.** Single words sitting alone on the last line. Fix with `text-wrap: balance` or `text-wrap: pretty`.
|
||||
|
||||
### Color and Surfaces
|
||||
|
||||
- **Pure `#000000` background.** Replace with off-black, dark charcoal, or tinted dark (`#0a0a0a`, `#121212`, or a dark navy).
|
||||
- **Oversaturated accent colors.** Keep saturation below 80%. Desaturate accents so they blend with neutrals instead of screaming.
|
||||
- **More than one accent color.** Pick one. Remove the rest. Consistency beats variety.
|
||||
- **Mixing warm and cool grays.** Stick to one gray family. Tint all grays with a consistent hue (warm or cool, not both).
|
||||
- **Purple/blue "AI gradient" aesthetic.** This is the most common AI design fingerprint. Replace with neutral bases and a single, considered accent.
|
||||
- **Generic `box-shadow`.** Tint shadows to match the background hue. Use colored shadows (e.g., dark blue shadow on a blue background) instead of pure black at low opacity.
|
||||
- **Flat design with zero texture.** Add subtle noise, grain, or micro-patterns to backgrounds. Pure flat vectors feel sterile.
|
||||
- **Perfectly even gradients.** Break the uniformity with radial gradients, noise overlays, or mesh gradients instead of standard linear 45-degree fades.
|
||||
- **Inconsistent lighting direction.** Audit all shadows to ensure they suggest a single, consistent light source.
|
||||
- **Random dark sections in a light mode page (or vice versa).** A single dark-background section breaking an otherwise light page looks like a copy-paste accident. Either commit to a full dark mode or keep a consistent background tone throughout. If contrast is needed, use a slightly darker shade of the same palette — not a sudden jump to `#111` in the middle of a cream page.
|
||||
- **Empty, flat sections with no visual depth.** Sections that are just text on a plain background feel unfinished. Add high-quality background imagery (blurred, overlaid, or masked), subtle patterns, or ambient gradients. Use reliable placeholder sources like `https://picsum.photos/seed/{name}/1920/1080` when real assets are not available. Experiment with background images behind hero sections, feature blocks, or CTAs — even a subtle full-width photo at low opacity adds presence.
|
||||
|
||||
### Layout
|
||||
|
||||
- **Everything centered and symmetrical.** Break symmetry with offset margins, mixed aspect ratios, or left-aligned headers over centered content.
|
||||
- **Three equal card columns as feature row.** This is the most generic AI layout. Replace with a 2-column zig-zag, asymmetric grid, horizontal scroll, or masonry layout.
|
||||
- **Using `height: 100vh` for full-screen sections.** Replace with `min-height: 100dvh` to prevent layout jumping on mobile browsers (iOS Safari viewport bug).
|
||||
- **Complex flexbox percentage math.** Replace with CSS Grid for reliable multi-column structures.
|
||||
- **No max-width container.** Add a container constraint (around 1200-1440px) with auto margins so content doesn't stretch edge-to-edge on wide screens.
|
||||
- **Cards of equal height forced by flexbox.** Allow variable heights or use masonry when content varies in length.
|
||||
- **Uniform border-radius on everything.** Vary the radius: tighter on inner elements, softer on containers.
|
||||
- **No overlap or depth.** Elements sit flat next to each other. Use negative margins to create layering and visual depth.
|
||||
- **Symmetrical vertical padding.** Top and bottom padding are always identical. Adjust optically — bottom padding often needs to be slightly larger.
|
||||
- **Dashboard always has a left sidebar.** Try top navigation, a floating command menu, or a collapsible panel instead.
|
||||
- **Missing whitespace.** Double the spacing. Let the design breathe. Dense layouts work for data dashboards, not for marketing pages.
|
||||
- **Buttons not bottom-aligned in card groups.** When cards have different content lengths, CTAs end up at random heights. Pin buttons to the bottom of each card so they form a clean horizontal line regardless of content above.
|
||||
- **Feature lists starting at different vertical positions.** In pricing tables or comparison cards, the list of features should start at the same Y position across all columns. Use consistent spacing above the list or fixed-height title/price blocks.
|
||||
- **Inconsistent vertical rhythm in side-by-side elements.** When placing cards, columns, or panels next to each other, align shared elements (titles, descriptions, prices, buttons) across all items. Misaligned baselines make the layout look broken.
|
||||
- **Mathematical alignment that looks optically wrong.** Centering by the math doesn't always look centered to the eye. Icons next to text, play buttons in circles, or text in buttons often need 1-2px optical adjustments to feel right.
|
||||
|
||||
### Interactivity and States
|
||||
|
||||
- **No hover states on buttons.** Add background shift, slight scale, or translate on hover.
|
||||
- **No active/pressed feedback.** Add a subtle `scale(0.98)` or `translateY(1px)` on press to simulate a physical click.
|
||||
- **Instant transitions with zero duration.** Add smooth transitions (200-300ms) to all interactive elements.
|
||||
- **Missing focus ring.** Ensure visible focus indicators for keyboard navigation. This is an accessibility requirement, not optional.
|
||||
- **No loading states.** Replace generic circular spinners with skeleton loaders that match the layout shape.
|
||||
- **No empty states.** An empty dashboard showing nothing is a missed opportunity. Design a composed "getting started" view.
|
||||
- **No error states.** Add clear, inline error messages for forms. Do not use `window.alert()`.
|
||||
- **Dead links.** Buttons that link to `#`. Either link to real destinations or visually disable them.
|
||||
- **No indication of current page in navigation.** Style the active nav link differently so users know where they are.
|
||||
- **Scroll jumping.** Anchor clicks jump instantly. Add `scroll-behavior: smooth`.
|
||||
- **Animations using `top`, `left`, `width`, `height`.** Switch to `transform` and `opacity` for GPU-accelerated, smooth animation.
|
||||
|
||||
### Content
|
||||
|
||||
- **Generic names like "John Doe" or "Jane Smith".** Use diverse, realistic-sounding names.
|
||||
- **Fake round numbers like `99.99%`, `50%`, `$100.00`.** Use organic, messy data: `47.2%`, `$99.00`, `+1 (312) 847-1928`.
|
||||
- **Placeholder company names like "Acme Corp", "Nexus", "SmartFlow".** Invent contextual, believable brand names.
|
||||
- **AI copywriting cliches.** Never use "Elevate", "Seamless", "Unleash", "Next-Gen", "Game-changer", "Delve", "Tapestry", or "In the world of...". Write plain, specific language.
|
||||
- **Exclamation marks in success messages.** Remove them. Be confident, not loud.
|
||||
- **"Oops!" error messages.** Be direct: "Connection failed. Please try again."
|
||||
- **Passive voice.** Use active voice: "We couldn't save your changes" instead of "Mistakes were made."
|
||||
- **All blog post dates identical.** Randomize dates to appear real.
|
||||
- **Same avatar image for multiple users.** Use unique assets for every distinct person.
|
||||
- **Lorem Ipsum.** Never use placeholder latin text. Write real draft copy.
|
||||
- **Title Case On Every Header.** Use sentence case instead.
|
||||
|
||||
### Component Patterns
|
||||
|
||||
- **Generic card look (border + shadow + white background).** Remove the border, or use only background color, or use only spacing. Cards should exist only when elevation communicates hierarchy.
|
||||
- **Always one filled button + one ghost button.** Add text links or tertiary styles to reduce visual noise.
|
||||
- **Pill-shaped "New" and "Beta" badges.** Try square badges, flags, or plain text labels.
|
||||
- **Accordion FAQ sections.** Use a side-by-side list, searchable help, or inline progressive disclosure.
|
||||
- **3-card carousel testimonials with dots.** Replace with a masonry wall, embedded social posts, or a single rotating quote.
|
||||
- **Pricing table with 3 towers.** Highlight the recommended tier with color and emphasis, not just extra height.
|
||||
- **Modals for everything.** Use inline editing, slide-over panels, or expandable sections instead of popups for simple actions.
|
||||
- **Avatar circles exclusively.** Try squircles or rounded squares for a less generic look.
|
||||
- **Light/dark toggle always a sun/moon switch.** Use a dropdown, system preference detection, or integrate it into settings.
|
||||
- **Footer link farm with 4 columns.** Simplify. Focus on main navigational paths and legally required links.
|
||||
|
||||
### Iconography
|
||||
|
||||
- **Lucide or Feather icons exclusively.** These are the "default" AI icon choice. Use Phosphor, Heroicons, or a custom set for differentiation.
|
||||
- **Rocketship for "Launch", shield for "Security".** Replace cliche metaphors with less obvious icons (bolt, fingerprint, spark, vault).
|
||||
- **Inconsistent stroke widths across icons.** Audit all icons and standardize to one stroke weight.
|
||||
- **Missing favicon.** Always include a branded favicon.
|
||||
- **Stock "diverse team" photos.** Use real team photos, candid shots, or a consistent illustration style instead of uncanny stock imagery.
|
||||
|
||||
### Code Quality
|
||||
|
||||
- **Div soup.** Use semantic HTML: `<nav>`, `<main>`, `<article>`, `<aside>`, `<section>`.
|
||||
- **Inline styles mixed with CSS classes.** Move all styling to the project's styling system.
|
||||
- **Hardcoded pixel widths.** Use relative units (`%`, `rem`, `em`, `max-width`) for flexible layouts.
|
||||
- **Missing alt text on images.** Describe image content for screen readers. Never leave `alt=""` or `alt="image"` on meaningful images.
|
||||
- **Arbitrary z-index values like `9999`.** Establish a clean z-index scale in the theme/variables.
|
||||
- **Commented-out dead code.** Remove all debug artifacts before shipping.
|
||||
- **Import hallucinations.** Check that every import actually exists in `package.json` or the project dependencies.
|
||||
- **Missing meta tags.** Add proper `<title>`, `description`, `og:image`, and social sharing meta tags.
|
||||
|
||||
### Strategic Omissions (What AI Typically Forgets)
|
||||
|
||||
- **No legal links.** Add privacy policy and terms of service links in the footer.
|
||||
- **No "back" navigation.** Dead ends in user flows. Every page needs a way back.
|
||||
- **No custom 404 page.** Design a helpful, branded "page not found" experience.
|
||||
- **No form validation.** Add client-side validation for emails, required fields, and format checks.
|
||||
- **No "skip to content" link.** Essential for keyboard users. Add a hidden skip-link.
|
||||
- **No cookie consent.** If required by jurisdiction, add a compliant consent banner.
|
||||
|
||||
## Upgrade Techniques
|
||||
|
||||
When upgrading a project, pull from these high-impact techniques to replace generic patterns:
|
||||
|
||||
### Typography Upgrades
|
||||
- **Variable font animation.** Interpolate weight or width on scroll or hover for text that feels alive.
|
||||
- **Outlined-to-fill transitions.** Text starts as a stroke outline and fills with color on scroll entry or interaction.
|
||||
- **Text mask reveals.** Large typography acting as a window to video or animated imagery behind it.
|
||||
|
||||
### Layout Upgrades
|
||||
- **Broken grid / asymmetry.** Elements that deliberately ignore column structure — overlapping, bleeding off-screen, or offset with calculated randomness.
|
||||
- **Whitespace maximization.** Aggressive use of negative space to force focus on a single element.
|
||||
- **Parallax card stacks.** Sections that stick and physically stack over each other during scroll.
|
||||
- **Split-screen scroll.** Two halves of the screen sliding in opposite directions.
|
||||
|
||||
### Motion Upgrades
|
||||
- **Smooth scroll with inertia.** Decouple scrolling from browser defaults for a heavier, cinematic feel.
|
||||
- **Staggered entry.** Elements cascade in with slight delays, combining Y-axis translation with opacity fade. Never mount everything at once.
|
||||
- **Spring physics.** Replace linear easing with spring-based motion for a natural, weighty feel on all interactive elements.
|
||||
- **Scroll-driven reveals.** Content entering through expanding masks, wipes, or draw-on SVG paths tied to scroll progress.
|
||||
|
||||
### Surface Upgrades
|
||||
- **True glassmorphism.** Go beyond `backdrop-filter: blur`. Add a 1px inner border and a subtle inner shadow to simulate edge refraction.
|
||||
- **Spotlight borders.** Card borders that illuminate dynamically under the cursor.
|
||||
- **Grain and noise overlays.** A fixed, pointer-events-none overlay with subtle noise to break digital flatness.
|
||||
- **Colored, tinted shadows.** Shadows that carry the hue of the background rather than using generic black.
|
||||
|
||||
## Fix Priority
|
||||
|
||||
Apply changes in this order for maximum visual impact with minimum risk:
|
||||
|
||||
1. **Font swap** — biggest instant improvement, lowest risk
|
||||
2. **Color palette cleanup** — remove clashing or oversaturated colors
|
||||
3. **Hover and active states** — makes the interface feel alive
|
||||
4. **Layout and spacing** — proper grid, max-width, consistent padding
|
||||
5. **Replace generic components** — swap cliche patterns for modern alternatives
|
||||
6. **Add loading, empty, and error states** — makes it feel finished
|
||||
7. **Polish typography scale and spacing** — the premium final touch
|
||||
|
||||
## Rules
|
||||
|
||||
- Work with the existing tech stack. Do not migrate frameworks or styling libraries.
|
||||
- Do not break existing functionality. Test after every change.
|
||||
- Before importing any new library, check the project's dependency file first.
|
||||
- If the project uses Tailwind, check the version (v3 vs v4) before modifying config.
|
||||
- If the project has no framework, use vanilla CSS.
|
||||
- Keep changes reviewable and focused. Small, targeted improvements over big rewrites.
|
||||
121
.agents/skills/stitch-design-taste/DESIGN.md
Normal file
121
.agents/skills/stitch-design-taste/DESIGN.md
Normal file
@@ -0,0 +1,121 @@
|
||||
# Design System: Taste Standard
|
||||
**Skill:** stitch-design-taste
|
||||
|
||||
---
|
||||
|
||||
## Configuration — Set Your Style
|
||||
Adjust these dials before using this design system. They control how creative, dense, and animated the output should be. Pick the level that fits your project.
|
||||
|
||||
| Dial | Level | Description |
|
||||
|------|-------|-------------|
|
||||
| **Creativity** | `8` | `1` = Ultra-minimal, Swiss, silent, monochrome. `5` = Balanced, clean but with personality. `10` = Expressive, editorial, bold typography experiments, inline images in headlines, strong asymmetry. Default: `8` |
|
||||
| **Density** | `4` | `1` = Gallery-airy, massive whitespace. `5` = Balanced sections. `10` = Cockpit-dense, data-heavy. Default: `4` |
|
||||
| **Variance** | `8` | `1` = Predictable, symmetric grids. `5` = Subtle offsets. `10` = Artsy chaotic, no two sections alike. Default: `8` |
|
||||
| **Motion Intent** | `6` | `1` = Static, no animation noted. `5` = Subtle hover/entrance cues. `10` = Cinematic orchestration noted in every component. Default: `6` |
|
||||
|
||||
> **How to use:** Change the numbers above to match your project's vibe. At **Creativity 1–3**, the system produces clean, quiet, Notion-like interfaces. At **Creativity 7–10**, expect inline image typography, dramatic scale contrast, and strong editorial layouts. The rest of the rules below adapt to your chosen levels.
|
||||
|
||||
---
|
||||
|
||||
## 1. Visual Theme & Atmosphere
|
||||
A restrained, gallery-airy interface with confident asymmetric layouts and fluid spring-physics motion. The atmosphere is clinical yet warm — like a well-lit architecture studio where every element earns its place through function. Density is balanced (Level 4), variance runs high (Level 8) to prevent symmetrical boredom, and motion is fluid but never theatrical (Level 6). The overall impression: expensive, intentional, alive.
|
||||
|
||||
## 2. Color Palette & Roles
|
||||
- **Canvas White** (#F9FAFB) — Primary background surface. Warm-neutral, never clinical blue-white
|
||||
- **Pure Surface** (#FFFFFF) — Card and container fill. Used with whisper shadow for elevation
|
||||
- **Charcoal Ink** (#18181B) — Primary text. Zinc-950 depth — never pure black
|
||||
- **Steel Secondary** (#71717A) — Body text, descriptions, metadata. Zinc-500 warmth
|
||||
- **Muted Slate** (#94A3B8) — Tertiary text, timestamps, disabled states
|
||||
- **Whisper Border** (rgba(226,232,240,0.5)) — Card borders, structural 1px lines. Semi-transparent for depth
|
||||
- **Diffused Shadow** (rgba(0,0,0,0.05)) — Card elevation. Wide-spreading, 40px blur, -15px offset. Never harsh
|
||||
|
||||
### Accent Selection (Pick ONE per project)
|
||||
- **Emerald Signal** (#10B981) — For growth, success, positive data dashboards
|
||||
- **Electric Blue** (#3B82F6) — For productivity, SaaS, developer tools
|
||||
- **Deep Rose** (#E11D48) — For creative, editorial, fashion-adjacent projects
|
||||
- **Amber Warmth** (#F59E0B) — For community, social, warm-toned products
|
||||
|
||||
### Banned Colors
|
||||
- Purple/Violet neon gradients — the "AI Purple" aesthetic
|
||||
- Pure Black (#000000) — always Off-Black or Zinc-950
|
||||
- Oversaturated accents above 80% saturation
|
||||
- Mixed warm/cool gray systems within one project
|
||||
|
||||
## 3. Typography Rules
|
||||
- **Display:** `Geist`, `Satoshi`, `Cabinet Grotesk`, or `Outfit` — Track-tight (`-0.025em`), controlled fluid scale, weight-driven hierarchy (700–900). Not screaming. Leading compressed (`1.1`). Alternatives forced — `Inter` is BANNED for premium contexts
|
||||
- **Body:** Same family at weight 400 — Relaxed leading (`1.65`), 65ch max-width, Steel Secondary color (#71717A)
|
||||
- **Mono:** `Geist Mono` or `JetBrains Mono` — For code blocks, metadata, timestamps. When density exceeds Level 7, all numbers switch to monospace
|
||||
- **Scale:** Display at `clamp(2.25rem, 5vw, 3.75rem)`. Body at `1rem/1.125rem`. Mono metadata at `0.8125rem`
|
||||
|
||||
### Banned Fonts
|
||||
- `Inter` — banned everywhere in premium/creative contexts
|
||||
- Generic serif fonts (`Times New Roman`, `Georgia`, `Garamond`, `Palatino`) — BANNED. If serif is needed for editorial/creative, use only distinctive modern serifs like `Fraunces`, `Gambarino`, `Editorial New`, or `Instrument Serif`. Never use default browser serif stacks. Serif is always BANNED in dashboards or software UIs regardless
|
||||
|
||||
## 4. Component Stylings
|
||||
* **Buttons:** Flat surface, no outer glow. Primary: accent fill with white text. Secondary: ghost/outline. Active state: `-1px translateY` or `scale(0.98)` for tactile push. Hover: subtle background shift, never glow
|
||||
* **Cards/Containers:** Generously rounded corners (`2.5rem`). Pure white fill. Whisper border (`1px`, semi-transparent). Diffused shadow (`0 20px 40px -15px rgba(0,0,0,0.05)`). Internal padding `2rem–2.5rem`. Used ONLY when elevation communicates hierarchy — high-density layouts replace cards with `border-top` dividers or negative space
|
||||
* **Inputs/Forms:** Label positioned above input. Helper text optional. Error text below in Deep Rose. Focus ring in accent color, `2px` offset. No floating labels. Standard `0.5rem` gap between label-input-error stack
|
||||
* **Navigation:** Sleek, sticky. Icons scale on hover (Dock Magnification optional). No hamburger on desktop. Clean horizontal with generous spacing
|
||||
* **Loaders:** Skeletal shimmer matching exact layout dimensions and rounded corners. Shifting light reflection across placeholder shapes. Never circular spinners
|
||||
* **Empty States:** Composed illustration or icon composition with guidance text. Never just "No data found"
|
||||
* **Error States:** Inline, contextual. Red accent underline or border. Clear recovery action
|
||||
|
||||
## 5. Hero Section
|
||||
The Hero is the first impression — it must be striking, creative, and never generic.
|
||||
- **Inline Image Typography:** Embed small, contextual photos or visuals directly between words or letters in the headline. Example: "We build [photo of hands typing] digital [photo of screen] products" — images sit inline at type-height, rounded, acting as visual punctuation between words. This is the signature creative technique
|
||||
- **No Overlapping Elements:** Text must never overlap images or other text. Every element has its own clear spatial zone. No z-index stacking of content layers, no absolute-positioned headlines over images. Clean separation always
|
||||
- **No Filler Text:** "Scroll to explore", "Swipe down", scroll arrow icons, bouncing chevrons, and any instructional UI chrome are BANNED. The user knows how to scroll. Let the content pull them in naturally
|
||||
- **Asymmetric Structure:** Centered Hero layouts are BANNED at this variance level. Use Split Screen (50/50), Left-Aligned text / Right visual, or Asymmetric Whitespace with large empty zones
|
||||
- **CTA Restraint:** Maximum one primary CTA button. No secondary "Learn more" links. No redundant micro-copy below the headline
|
||||
|
||||
## 6. Layout Principles
|
||||
- **Grid-First:** CSS Grid for all structural layouts. Never flexbox percentage math (`calc(33% - 1rem)` is BANNED)
|
||||
- **No Overlapping:** Elements must never overlap each other. No absolute-positioned layers stacking content on content. Every element occupies its own grid cell or flow position. Clean, separated spatial zones
|
||||
- **Feature Sections:** The "3 equal cards in a row" pattern is BANNED. Use 2-column Zig-Zag, asymmetric Bento grids (2fr 1fr 1fr), or horizontal scroll galleries
|
||||
- **Containment:** All content within `max-width: 1400px`, centered. Generous horizontal padding (`1rem` mobile, `2rem` tablet, `4rem` desktop)
|
||||
- **Full-Height:** Use `min-height: 100dvh` — never `height: 100vh` (iOS Safari address bar jump)
|
||||
- **Bento Architecture:** For feature grids, use Row 1: 3 columns | Row 2: 2 columns (70/30 split). Each tile contains a perpetual micro-animation
|
||||
|
||||
## 7. Responsive Rules
|
||||
Every screen must work flawlessly across all viewports. **Responsive is not optional — it is a hard requirement. Every single element must be tested at 375px, 768px, and 1440px.**
|
||||
- **Mobile-First Collapse (< 768px):** All multi-column layouts collapse to a strict single column. `width: 100%`, `padding: 1rem`, `gap: 1.5rem`. No exceptions
|
||||
- **No Horizontal Scroll:** Horizontal overflow on mobile is a critical failure. All elements must fit within viewport width. If any element causes horizontal scroll, the design is broken
|
||||
- **Typography Scaling:** Headlines scale down gracefully via `clamp()`. Body text stays `1rem` minimum. Never shrink body below `14px`. Headlines must remain readable on 375px screens
|
||||
- **Touch Targets:** All interactive elements minimum `44px` tap target. Generous spacing between clickable items. Buttons must be full-width on mobile
|
||||
- **Image Behavior:** Hero and inline images scale proportionally. Inline typography images (photos between words) stack below the headline on mobile instead of inline
|
||||
- **Navigation:** Desktop horizontal nav collapses to a clean mobile menu (slide-in or full-screen overlay). No tiny hamburger icons without labels
|
||||
- **Cards & Grids:** Bento grids and asymmetric layouts revert to stacked single-column cards with full-width. Maintain internal padding (`1rem`)
|
||||
- **Spacing Consistency:** Vertical section gaps reduce proportionally on mobile (`clamp(3rem, 8vw, 6rem)`). Never cramped, never excessively airy
|
||||
- **Testing Viewports:** Designs must be verified at: `375px` (iPhone SE), `390px` (iPhone 14), `768px` (iPad), `1024px` (small laptop), `1440px` (desktop)
|
||||
|
||||
## 8. Motion & Interaction (Code-Phase Intent)
|
||||
> **Note:** Stitch generates static screens — it does not animate. This section documents the **intended motion behavior** so that the coding agent (Antigravity, Cursor, etc.) knows exactly how to implement animations when building the exported design into a live product.
|
||||
|
||||
- **Physics Engine:** Spring-based exclusively. `stiffness: 100, damping: 20`. No linear easing anywhere. Premium, weighty feel on all interactive elements
|
||||
- **Perpetual Micro-Loops:** Every active dashboard component has an infinite-loop state — Pulse on status dots, Typewriter on search bars, Float on feature icons, Shimmer on loading states
|
||||
- **Staggered Orchestration:** Lists and grids mount with cascaded delays (`animation-delay: calc(var(--index) * 100ms)`). Waterfall reveals, never instant mount
|
||||
- **Layout Transitions:** Smooth re-ordering via shared element IDs. Items swap positions with physics, simulating real-time intelligence
|
||||
- **Hardware Rules:** Animate ONLY `transform` and `opacity`. Never `top`, `left`, `width`, `height`. Grain/noise filters on fixed, pointer-events-none pseudo-elements only
|
||||
- **Performance:** CPU-heavy perpetual animations isolated in microscopic leaf components. Never trigger parent re-renders. Target 60fps minimum
|
||||
|
||||
## 9. Anti-Patterns (Banned)
|
||||
- No emojis — anywhere in UI, code, or alt text
|
||||
- No `Inter` font — use `Geist`, `Outfit`, `Cabinet Grotesk`, `Satoshi`
|
||||
- No generic serif fonts (`Times New Roman`, `Georgia`, `Garamond`) — if serif is needed, use distinctive modern serifs only (`Fraunces`, `Instrument Serif`)
|
||||
- No pure black (`#000000`) — Off-Black or Zinc-950 only
|
||||
- No neon outer glows or default box-shadow glows
|
||||
- No oversaturated accent colors above 80%
|
||||
- No excessive gradient text on large headers
|
||||
- No custom mouse cursors
|
||||
- No overlapping elements — text never overlaps images or other content. Clean spatial separation always
|
||||
- No 3-column equal card layouts for features
|
||||
- No centered Hero sections (at this variance level)
|
||||
- No filler UI text: "Scroll to explore", "Swipe down", "Discover more below", scroll arrows, bouncing chevrons — all BANNED
|
||||
- No generic names: "John Doe", "Sarah Chan", "Acme", "Nexus", "SmartFlow"
|
||||
- No fake round numbers: `99.99%`, `50%`, `1234567` — use organic data: `47.2%`, `+1 (312) 847-1928`
|
||||
- No AI copywriting clichés: "Elevate", "Seamless", "Unleash", "Next-Gen", "Revolutionize"
|
||||
- No broken Unsplash links — use `picsum.photos/seed/{id}/800/600` or SVG UI Avatars
|
||||
- No generic `shadcn/ui` defaults — customize radii, colors, shadows to match this system
|
||||
- No `z-index` spam — use only for Navbar, Modal, Overlay layer contexts
|
||||
- No `h-screen` — always `min-h-[100dvh]`
|
||||
- No circular loading spinners — skeletal shimmer only
|
||||
184
.agents/skills/stitch-design-taste/SKILL.md
Normal file
184
.agents/skills/stitch-design-taste/SKILL.md
Normal file
@@ -0,0 +1,184 @@
|
||||
---
|
||||
name: stitch-design-taste
|
||||
description: Semantic Design System Skill for Google Stitch. Generates agent-friendly DESIGN.md files that enforce premium, anti-generic UI standards — strict typography, calibrated color, asymmetric layouts, perpetual micro-motion, and hardware-accelerated performance.
|
||||
---
|
||||
|
||||
# Stitch Design Taste — Semantic Design System Skill
|
||||
|
||||
## Overview
|
||||
This skill generates `DESIGN.md` files optimized for Google Stitch screen generation. It translates the battle-tested anti-slop frontend engineering directives into Stitch's native semantic design language — descriptive, natural-language rules paired with precise values that Stitch's AI agent can interpret to produce premium, non-generic interfaces.
|
||||
|
||||
The generated `DESIGN.md` serves as the **single source of truth** for prompting Stitch to generate new screens that align with a curated, high-agency design language. Stitch interprets design through **"Visual Descriptions"** supported by specific color values, typography specs, and component behaviors.
|
||||
|
||||
## Prerequisites
|
||||
- Access to Google Stitch via [labs.google.com/stitch](https://labs.google.com/stitch)
|
||||
- Optionally: Stitch MCP Server for programmatic integration with Cursor, Antigravity, or Gemini CLI
|
||||
|
||||
## The Goal
|
||||
Generate a `DESIGN.md` file that encodes:
|
||||
1. **Visual atmosphere** — the mood, density, and design philosophy
|
||||
2. **Color calibration** — neutrals, accents, and banned patterns with hex codes
|
||||
3. **Typographic architecture** — font stacks, scale hierarchy, and anti-patterns
|
||||
4. **Component behaviors** — buttons, cards, inputs with interaction states
|
||||
5. **Layout principles** — grid systems, spacing philosophy, responsive strategy
|
||||
6. **Motion philosophy** — animation engine specs, spring physics, perpetual micro-interactions
|
||||
7. **Anti-patterns** — explicit list of banned AI design clichés
|
||||
|
||||
## Analysis & Synthesis Instructions
|
||||
|
||||
### 1. Define the Atmosphere
|
||||
Evaluate the target project's intent. Use evocative adjectives from the taste spectrum:
|
||||
- **Density:** "Art Gallery Airy" (1–3) → "Daily App Balanced" (4–7) → "Cockpit Dense" (8–10)
|
||||
- **Variance:** "Predictable Symmetric" (1–3) → "Offset Asymmetric" (4–7) → "Artsy Chaotic" (8–10)
|
||||
- **Motion:** "Static Restrained" (1–3) → "Fluid CSS" (4–7) → "Cinematic Choreography" (8–10)
|
||||
|
||||
Default baseline: Variance 8, Motion 6, Density 4. Adapt dynamically based on user's vibe description.
|
||||
|
||||
### 2. Map the Color Palette
|
||||
For each color provide: **Descriptive Name** + **Hex Code** + **Functional Role**.
|
||||
|
||||
**Mandatory constraints:**
|
||||
- Maximum 1 accent color. Saturation below 80%
|
||||
- The "AI Purple/Blue Neon" aesthetic is strictly BANNED — no purple button glows, no neon gradients
|
||||
- Use absolute neutral bases (Zinc/Slate) with high-contrast singular accents
|
||||
- Stick to one palette for the entire output — no warm/cool gray fluctuation
|
||||
- Never use pure black (`#000000`) — use Off-Black, Zinc-950, or Charcoal
|
||||
|
||||
### 3. Establish Typography Rules
|
||||
- **Display/Headlines:** Track-tight, controlled scale. Not screaming. Hierarchy through weight and color, not just massive size
|
||||
- **Body:** Relaxed leading, max 65 characters per line
|
||||
- **Font Selection:** `Inter` is BANNED for premium/creative contexts. Force unique character: `Geist`, `Outfit`, `Cabinet Grotesk`, or `Satoshi`
|
||||
- **Serif Ban:** Generic serif fonts (`Times New Roman`, `Georgia`, `Garamond`, `Palatino`) are BANNED. If serif is needed for editorial/creative contexts, use only distinctive modern serifs: `Fraunces`, `Gambarino`, `Editorial New`, or `Instrument Serif`. Serif is always BANNED in dashboards or software UIs
|
||||
- **Dashboard Constraint:** Use Sans-Serif pairings exclusively (`Geist` + `Geist Mono` or `Satoshi` + `JetBrains Mono`)
|
||||
- **High-Density Override:** When density exceeds 7, all numbers must use Monospace
|
||||
|
||||
### 4. Define the Hero Section
|
||||
The Hero is the first impression and must be creative, striking, and never generic:
|
||||
- **Inline Image Typography:** Embed small, contextual photos or visuals directly between words or letters in the headline. Images sit inline at type-height, rounded, acting as visual punctuation. This is the signature creative technique
|
||||
- **No Overlapping:** Text must never overlap images or other text. Every element occupies its own clean spatial zone
|
||||
- **No Filler Text:** "Scroll to explore", "Swipe down", scroll arrow icons, bouncing chevrons are BANNED. The content should pull users in naturally
|
||||
- **Asymmetric Structure:** Centered Hero layouts BANNED when variance exceeds 4
|
||||
- **CTA Restraint:** Maximum one primary CTA. No secondary "Learn more" links
|
||||
|
||||
### 5. Describe Component Stylings
|
||||
For each component type, describe shape, color, shadow depth, and interaction behavior:
|
||||
- **Buttons:** Tactile push feedback on active state. No neon outer glows. No custom mouse cursors
|
||||
- **Cards:** Use ONLY when elevation communicates hierarchy. Tint shadows to background hue. For high-density layouts, replace cards with border-top dividers or negative space
|
||||
- **Inputs/Forms:** Label above input, helper text optional, error text below. Standard gap spacing
|
||||
- **Loading States:** Skeletal loaders matching layout dimensions — no generic circular spinners
|
||||
- **Empty States:** Composed compositions indicating how to populate data
|
||||
- **Error States:** Clear, inline error reporting
|
||||
|
||||
### 6. Define Layout Principles
|
||||
- No overlapping elements — every element occupies its own clear spatial zone. No absolute-positioned content stacking
|
||||
- Centered Hero sections are BANNED when variance exceeds 4 — force Split Screen, Left-Aligned, or Asymmetric Whitespace
|
||||
- The generic "3 equal cards horizontally" feature row is BANNED — use 2-column Zig-Zag, asymmetric grid, or horizontal scroll
|
||||
- CSS Grid over Flexbox math — never use `calc()` percentage hacks
|
||||
- Contain layouts using max-width constraints (e.g., 1400px centered)
|
||||
- Full-height sections must use `min-h-[100dvh]` — never `h-screen` (iOS Safari catastrophic jump)
|
||||
|
||||
### 7. Define Responsive Rules
|
||||
Every design must work across all viewports:
|
||||
- **Mobile-First Collapse (< 768px):** All multi-column layouts collapse to single column. No exceptions
|
||||
- **No Horizontal Scroll:** Horizontal overflow on mobile is a critical failure
|
||||
- **Typography Scaling:** Headlines scale via `clamp()`. Body text minimum `1rem`/`14px`
|
||||
- **Touch Targets:** All interactive elements minimum `44px` tap target
|
||||
- **Image Behavior:** Inline typography images (photos between words) stack below headline on mobile
|
||||
- **Navigation:** Desktop horizontal nav collapses to clean mobile menu
|
||||
- **Spacing:** Vertical section gaps reduce proportionally (`clamp(3rem, 8vw, 6rem)`)
|
||||
|
||||
### 8. Encode Motion Philosophy
|
||||
- **Spring Physics default:** `stiffness: 100, damping: 20` — premium, weighty feel. No linear easing
|
||||
- **Perpetual Micro-Interactions:** Every active component should have an infinite loop state (Pulse, Typewriter, Float, Shimmer)
|
||||
- **Staggered Orchestration:** Never mount lists instantly — use cascade delays for waterfall reveals
|
||||
- **Performance:** Animate exclusively via `transform` and `opacity`. Never animate `top`, `left`, `width`, `height`. Grain/noise filters on fixed pseudo-elements only
|
||||
|
||||
### 9. List Anti-Patterns (AI Tells)
|
||||
Encode these as explicit "NEVER DO" rules in the DESIGN.md:
|
||||
- No emojis anywhere
|
||||
- No `Inter` font
|
||||
- No generic serif fonts (`Times New Roman`, `Georgia`, `Garamond`) — distinctive modern serifs only if needed
|
||||
- No pure black (`#000000`)
|
||||
- No neon/outer glow shadows
|
||||
- No oversaturated accents
|
||||
- No excessive gradient text on large headers
|
||||
- No custom mouse cursors
|
||||
- No overlapping elements — clean spatial separation always
|
||||
- No 3-column equal card layouts
|
||||
- No generic names ("John Doe", "Acme", "Nexus")
|
||||
- No fake round numbers (`99.99%`, `50%`)
|
||||
- No AI copywriting clichés ("Elevate", "Seamless", "Unleash", "Next-Gen")
|
||||
- No filler UI text: "Scroll to explore", "Swipe down", scroll arrows, bouncing chevrons
|
||||
- No broken Unsplash links — use `picsum.photos` or SVG avatars
|
||||
- No centered Hero sections (for high-variance projects)
|
||||
|
||||
## Output Format (DESIGN.md Structure)
|
||||
|
||||
```markdown
|
||||
# Design System: [Project Title]
|
||||
|
||||
## 1. Visual Theme & Atmosphere
|
||||
(Evocative description of the mood, density, variance, and motion intensity.
|
||||
Example: "A restrained, gallery-airy interface with confident asymmetric layouts
|
||||
and fluid spring-physics motion. The atmosphere is clinical yet warm — like a
|
||||
well-lit architecture studio.")
|
||||
|
||||
## 2. Color Palette & Roles
|
||||
- **Canvas White** (#F9FAFB) — Primary background surface
|
||||
- **Pure Surface** (#FFFFFF) — Card and container fill
|
||||
- **Charcoal Ink** (#18181B) — Primary text, Zinc-950 depth
|
||||
- **Muted Steel** (#71717A) — Secondary text, descriptions, metadata
|
||||
- **Whisper Border** (rgba(226,232,240,0.5)) — Card borders, 1px structural lines
|
||||
- **[Accent Name]** (#XXXXXX) — Single accent for CTAs, active states, focus rings
|
||||
(Max 1 accent. Saturation < 80%. No purple/neon.)
|
||||
|
||||
## 3. Typography Rules
|
||||
- **Display:** [Font Name] — Track-tight, controlled scale, weight-driven hierarchy
|
||||
- **Body:** [Font Name] — Relaxed leading, 65ch max-width, neutral secondary color
|
||||
- **Mono:** [Font Name] — For code, metadata, timestamps, high-density numbers
|
||||
- **Banned:** Inter, generic system fonts for premium contexts. Serif fonts banned in dashboards.
|
||||
|
||||
## 4. Component Stylings
|
||||
* **Buttons:** Flat, no outer glow. Tactile -1px translate on active. Accent fill for primary, ghost/outline for secondary.
|
||||
* **Cards:** Generously rounded corners (2.5rem). Diffused whisper shadow. Used only when elevation serves hierarchy. High-density: replace with border-top dividers.
|
||||
* **Inputs:** Label above, error below. Focus ring in accent color. No floating labels.
|
||||
* **Loaders:** Skeletal shimmer matching exact layout dimensions. No circular spinners.
|
||||
* **Empty States:** Composed, illustrated compositions — not just "No data" text.
|
||||
|
||||
## 5. Layout Principles
|
||||
(Grid-first responsive architecture. Asymmetric splits for Hero sections.
|
||||
Strict single-column collapse below 768px. Max-width containment.
|
||||
No flexbox percentage math. Generous internal padding.)
|
||||
|
||||
## 6. Motion & Interaction
|
||||
(Spring physics for all interactive elements. Staggered cascade reveals.
|
||||
Perpetual micro-loops on active dashboard components. Hardware-accelerated
|
||||
transforms only. Isolated Client Components for CPU-heavy animations.)
|
||||
|
||||
## 7. Anti-Patterns (Banned)
|
||||
(Explicit list of forbidden patterns: no emojis, no Inter, no pure black,
|
||||
no neon glows, no 3-column equal grids, no AI copywriting clichés,
|
||||
no generic placeholder names, no broken image links.)
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
- **Be Descriptive:** "Deep Charcoal Ink (#18181B)" — not just "dark text"
|
||||
- **Be Functional:** Explain what each element is used for
|
||||
- **Be Consistent:** Same terminology throughout the document
|
||||
- **Be Precise:** Include exact hex codes, rem values, pixel values in parentheses
|
||||
- **Be Opinionated:** This is not a neutral template — it enforces a specific, premium aesthetic
|
||||
|
||||
## Tips for Success
|
||||
1. Start with the atmosphere — understand the vibe before detailing tokens
|
||||
2. Look for patterns — identify consistent spacing, sizing, and styling
|
||||
3. Think semantically — name colors by purpose, not just appearance
|
||||
4. Consider hierarchy — document how visual weight communicates importance
|
||||
5. Encode the bans — anti-patterns are as important as the rules themselves
|
||||
|
||||
## Common Pitfalls to Avoid
|
||||
- Using technical jargon without translation ("rounded-xl" instead of "generously rounded corners")
|
||||
- Omitting hex codes or using only descriptive names
|
||||
- Forgetting functional roles of design elements
|
||||
- Being too vague in atmosphere descriptions
|
||||
- Ignoring the anti-pattern list — these are what make the output premium
|
||||
- Defaulting to generic "safe" designs instead of enforcing the curated aesthetic
|
||||
12
.env.example
12
.env.example
@@ -3,3 +3,15 @@
|
||||
# When false: plain HTTP everywhere (only works on localhost)
|
||||
# Overrides server/data/variables.json for local development only
|
||||
SSL=true
|
||||
|
||||
# --- Mobile push dispatch (signaling server) ---
|
||||
# Android FCM HTTP v1 (choose one)
|
||||
# FCM_SERVICE_ACCOUNT_PATH=/absolute/path/to/firebase-service-account.json
|
||||
# FCM_SERVICE_ACCOUNT_JSON={"type":"service_account","project_id":"..."}
|
||||
|
||||
# iOS APNs HTTP/2 (.p8 key from Apple Developer)
|
||||
# APNS_KEY_PATH=/absolute/path/to/AuthKey_XXXXXXXXXX.p8
|
||||
# APNS_KEY_ID=XXXXXXXXXX
|
||||
# APNS_TEAM_ID=XXXXXXXXXX
|
||||
# APNS_BUNDLE_ID=com.metoyou.app
|
||||
# APNS_USE_SANDBOX=true
|
||||
|
||||
73
.gitea/workflows/build-android-apk.yml
Normal file
73
.gitea/workflows/build-android-apk.yml
Normal file
@@ -0,0 +1,73 @@
|
||||
name: Build Android APK
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main, master]
|
||||
paths:
|
||||
- 'toju-app/**'
|
||||
- 'package.json'
|
||||
- 'package-lock.json'
|
||||
- 'tools/build-android-apk.sh'
|
||||
- '.gitea/workflows/build-android-apk.yml'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build-android-apk:
|
||||
runs-on: ubuntu-latest
|
||||
container: node:22
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: https://github.com/actions/checkout@v4
|
||||
|
||||
- name: Restore npm cache
|
||||
uses: https://github.com/actions/cache@v4
|
||||
with:
|
||||
path: /root/.npm
|
||||
key: npm-android-${{ hashFiles('package-lock.json') }}
|
||||
restore-keys: npm-android-
|
||||
|
||||
- name: Restore Gradle cache
|
||||
uses: https://github.com/actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
/root/.gradle/caches
|
||||
/root/.gradle/wrapper
|
||||
key: gradle-android-${{ hashFiles('toju-app/android/**/*.gradle*', 'toju-app/android/gradle/wrapper/gradle-wrapper.properties') }}
|
||||
restore-keys: gradle-android-
|
||||
|
||||
- name: Install Android build toolchain
|
||||
run: |
|
||||
apt-get update
|
||||
apt-get install -y --no-install-recommends openjdk-21-jdk wget unzip
|
||||
|
||||
export ANDROID_SDK_ROOT=/opt/android-sdk
|
||||
mkdir -p "$ANDROID_SDK_ROOT/cmdline-tools"
|
||||
cd /tmp
|
||||
wget -q https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip
|
||||
unzip -q commandlinetools-linux-11076708_latest.zip
|
||||
mv cmdline-tools "$ANDROID_SDK_ROOT/cmdline-tools/latest"
|
||||
export PATH="$PATH:$ANDROID_SDK_ROOT/cmdline-tools/latest/bin:$ANDROID_SDK_ROOT/platform-tools"
|
||||
|
||||
yes | sdkmanager --licenses >/dev/null
|
||||
sdkmanager "platform-tools" "platforms;android-36" "build-tools;35.0.0"
|
||||
|
||||
echo "ANDROID_SDK_ROOT=$ANDROID_SDK_ROOT" >> "$GITHUB_ENV"
|
||||
echo "ANDROID_HOME=$ANDROID_SDK_ROOT" >> "$GITHUB_ENV"
|
||||
echo "JAVA_HOME=/usr/lib/jvm/java-21-openjdk-amd64" >> "$GITHUB_ENV"
|
||||
echo "PATH=$PATH:$ANDROID_SDK_ROOT/cmdline-tools/latest/bin:$ANDROID_SDK_ROOT/platform-tools" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Install dependencies
|
||||
env:
|
||||
NODE_ENV: development
|
||||
run: npm ci
|
||||
|
||||
- name: Build debug APK
|
||||
run: bash tools/build-android-apk.sh
|
||||
|
||||
- name: Upload APK artifact
|
||||
uses: https://github.com/actions/upload-artifact@v4
|
||||
with:
|
||||
name: metoyou-android-debug-apk
|
||||
path: toju-app/android/app/build/outputs/apk/debug/app-debug.apk
|
||||
if-no-files-found: error
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -61,7 +61,6 @@ Thumbs.db
|
||||
/server/data/variables.json
|
||||
dist-server/*
|
||||
|
||||
AGENTS.md
|
||||
doc/**
|
||||
|
||||
metoyou.sqlite*
|
||||
|
||||
101
AGENTS.md
Normal file
101
AGENTS.md
Normal file
@@ -0,0 +1,101 @@
|
||||
# AGENTS.md
|
||||
|
||||
Read these files at the start of every session before doing any work:
|
||||
|
||||
1. `agents-docs/AGENT_WORKFLOW.md` — workflow and operating rules
|
||||
2. `agents-docs/LESSONS.md` — durable rules learned from past corrections; apply any that match this session's work
|
||||
3. `agents-docs/AGENTS_FEATURES.md` — when and how to update feature docs
|
||||
4. `agents-docs/FEATURES.md` — feature index
|
||||
5. `agents-docs/ENGINEERING.md` — engineering standards
|
||||
6. `agents-docs/CONTEXT-MAP.md` — index of bounded contexts in this repo
|
||||
|
||||
Reference on-demand (when the workflow triggers them — see `agents-docs/AGENT_WORKFLOW.md` §§ 4–5):
|
||||
|
||||
- `agents-docs/AGENTS_CONTEXT.md` — contract for updating `CONTEXT.md` / `CONTEXT-MAP.md`
|
||||
- `agents-docs/AGENTS_ADRS.md` — contract for writing architecture decision records
|
||||
|
||||
When working in a subdomain, also read its `CONTEXT.md` first:
|
||||
|
||||
- Product client (Angular 21): `toju-app/CONTEXT.md`
|
||||
- Desktop shell (Electron main + preload): `electron/CONTEXT.md`
|
||||
- Signaling server (Express + WebSocket): `server/CONTEXT.md`
|
||||
- End-to-end tests (Playwright): `e2e/CONTEXT.md`
|
||||
- Marketing site (Angular 19): `website/CONTEXT.md`
|
||||
- Application documentation (Docusaurus): `docs-site/CONTEXT.md`
|
||||
|
||||
---
|
||||
|
||||
MetoYou (also called Toju) is a desktop-first, P2P Discord-style chat application managed as an npm-workspaces monorepo. It bundles an Angular 21 product client, an Electron 39 desktop shell with TypeORM + sql.js for local persistence, a small Node/TypeScript Express signaling server with WebSocket-based realtime, a Playwright end-to-end suite, an Angular 19 marketing site, and a Docusaurus app/plugin documentation site that ships inside the Electron build. Voice and screen-share are WebRTC, with RNNoise denoising via a WASM audio worklet.
|
||||
|
||||
## CRITICAL — Non-negotiable rules for all agents
|
||||
|
||||
### Test-Driven Development (MANDATORY)
|
||||
**Write tests before implementation code.**
|
||||
|
||||
When creating or changing anything:
|
||||
1. STOP — do not write implementation first
|
||||
2. Write failing tests (RED)
|
||||
3. Run tests and confirm failure (`npm run test` for the product client; `npm run test:e2e` for end-to-end; place spec files colocated with source, suffix `.spec.ts`)
|
||||
4. Write minimal code to pass tests (GREEN)
|
||||
5. Refactor while keeping tests green
|
||||
|
||||
This applies to all code — Angular components and services, NgRx effects/reducers, Electron IPC handlers, server CQRS handlers, websocket message handlers, plugin runtime, and domain logic. If the code lives in a package without a configured test runner (server, website, docs-site), surface that gap before adding logic there.
|
||||
|
||||
### Lint correctness (MANDATORY)
|
||||
Before completing any task:
|
||||
1. Run `npm run lint` from the repo root (ESLint 9 flat config in `eslint.config.js` covers every package)
|
||||
2. Fix all errors
|
||||
3. Do not consider work complete until it exits with code 0
|
||||
|
||||
### Type / build correctness (MANDATORY)
|
||||
Type checks live in build scripts:
|
||||
|
||||
- Product client (`toju-app/`): `npm run build` (Angular CLI runs `tsc` with strict settings)
|
||||
- Electron (`electron/`): `npm run build:electron` (invokes `tsc -p tsconfig.electron.json`)
|
||||
- Server (`server/`): `cd server && npm run build` (invokes `tsc`)
|
||||
|
||||
If your change touches one of these packages, run the corresponding build and ensure it exits 0 before marking work complete.
|
||||
|
||||
## Most important rule
|
||||
|
||||
After any change that affects API contracts, schemas, invariants, workflows, or major behavior: update the relevant `agents-docs/features/<slug>.md` as part of the same task — not as a follow-up. New feature area → create `agents-docs/features/<slug>.md` and add an entry to `agents-docs/FEATURES.md` (alphabetical).
|
||||
|
||||
The product client already maintains per-domain READMEs under `toju-app/src/app/domains/<name>/README.md`. When the change is fully internal to one of those bounded contexts and its surface stays the same, the domain README is the right place to update; cross-context contracts (websocket envelopes, IPC channels, server routes, plugin manifests) belong in `agents-docs/features/`.
|
||||
|
||||
## Structure of further instructions
|
||||
|
||||
- **Agent workflow & operating rules:** `agents-docs/AGENT_WORKFLOW.md`
|
||||
- **Agent lessons (durable cross-session rules):** `agents-docs/LESSONS.md`
|
||||
- **Engineering standards:** `agents-docs/ENGINEERING.md`
|
||||
- **Feature documentation contract:** `agents-docs/AGENTS_FEATURES.md`
|
||||
- **CONTEXT documentation contract:** `agents-docs/AGENTS_CONTEXT.md`
|
||||
- **ADR contract:** `agents-docs/AGENTS_ADRS.md`
|
||||
- **Feature index:** `agents-docs/FEATURES.md`
|
||||
- **Feature docs:** `agents-docs/features/`
|
||||
- **Architecture decisions:** `agents-docs/adr/`
|
||||
- **Context map:** `agents-docs/CONTEXT-MAP.md`
|
||||
- **Product-client domain:** `toju-app/CONTEXT.md`
|
||||
- **Desktop-shell domain:** `electron/CONTEXT.md`
|
||||
- **Server domain:** `server/CONTEXT.md`
|
||||
- **E2E suite domain:** `e2e/CONTEXT.md`
|
||||
- **Marketing-site domain:** `website/CONTEXT.md`
|
||||
- **App-docs domain:** `docs-site/CONTEXT.md`
|
||||
|
||||
Keep this file minimal. Do not duplicate detailed rules here.
|
||||
|
||||
## Completion checklist
|
||||
|
||||
Before marking work complete:
|
||||
|
||||
- [ ] Tests written before implementation
|
||||
- [ ] All tests passing (`npm run test`, plus `npm run test:e2e` if behavior is user-visible)
|
||||
- [ ] `npm run lint` passes
|
||||
- [ ] Affected package builds: `npm run build` / `npm run build:electron` / `cd server && npm run build`
|
||||
- [ ] Naming conventions followed (kebab-case files; domain `*.rules.ts` / `*.model.ts` / `*.component.ts` suffixes)
|
||||
- [ ] Errors handled
|
||||
- [ ] Feature docs updated if contract/schema/invariant changed (see `agents-docs/AGENTS_FEATURES.md`)
|
||||
- [ ] `CONTEXT.md` updated if a domain term was resolved or introduced (see `agents-docs/AGENTS_CONTEXT.md`)
|
||||
- [ ] ADR written if a hard-to-reverse decision was made (see `agents-docs/AGENTS_ADRS.md`)
|
||||
- [ ] Lesson recorded in `agents-docs/LESSONS.md` if this session produced a correction, revert, or hidden constraint (see triggers in `agents-docs/AGENT_WORKFLOW.md`)
|
||||
- [ ] PR opened with summary and linked issues (`Fixes #<n>` / `Relates to #<n>`)
|
||||
- [ ] Gitea Workflows checks passing
|
||||
1
CLAUDE.md
Normal file
1
CLAUDE.md
Normal file
@@ -0,0 +1 @@
|
||||
Read AGENTS.md at the root of this repository at the start of every session before doing any work. It links to all other agent instruction files.
|
||||
89
agents-docs/AGENTS_ADRS.md
Normal file
89
agents-docs/AGENTS_ADRS.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# Agent Instructions: Architecture Decision Records (ADRs)
|
||||
|
||||
Architectural decisions live in **`agents-docs/adr/`** as numbered Markdown files (`NNNN-slug.md`).
|
||||
|
||||
This document defines how agents must detect, document, and maintain architectural decisions as the codebase grows.
|
||||
|
||||
> This file is part of the agent instruction infrastructure.
|
||||
> Do NOT create, delete, or modify this file unless explicitly instructed.
|
||||
|
||||
---
|
||||
|
||||
## What an ADR is
|
||||
|
||||
A short record of an architectural decision that future engineers (and agents) will need context for. The format is Nygard short form:
|
||||
|
||||
- Title and number (`ADR-NNNN: <slug>`).
|
||||
- Required: 1–3 sentences each covering **Context** (why this came up), **Decision** (what was chosen), and **Rationale** (why this option over alternatives).
|
||||
- Conventional: `Status` (usually `Accepted` for new ADRs; `Superseded by ADR-MMMM` once overturned).
|
||||
- Optional: `Considered Options`, `Consequences` — add only when they genuinely help. Most ADRs won't need them.
|
||||
|
||||
See `agents-docs/adr/0001-record-architectural-decisions.md` for the canonical example — a minimal four-section ADR that matches the typical shape.
|
||||
|
||||
The value is in recording **that a decision was made** and **why** — not in completing formal sections.
|
||||
|
||||
---
|
||||
|
||||
## ADR Contract (MANDATORY)
|
||||
|
||||
### When to write an ADR
|
||||
|
||||
The canonical criteria — the 3-criteria gate — live in `agents-docs/AGENT_WORKFLOW.md` § 5 ADR upkeep. Read those before writing. In short: write an ADR only when the decision is **hard to reverse**, **surprising without context**, and the **result of genuine trade-offs**. If any of the three is missing, don't.
|
||||
|
||||
Suitable topics: architectural patterns, integration approaches, significant technology selections, scope boundaries, intentional deviations from standard practices, non-obvious rejections of alternatives.
|
||||
|
||||
### Read before crossing decision boundaries
|
||||
|
||||
Before non-trivial changes in an area, scan `agents-docs/adr/` for decisions that touch it. If your work would contradict an existing ADR:
|
||||
|
||||
- **Surface it explicitly**, don't silently override. Phrase it as: "_Contradicts ADR-NNNN (slug) — but worth reopening because…_"
|
||||
- If the contradiction is intentional, write a new ADR that supersedes the old one (see below).
|
||||
|
||||
### Write the ADR in the same turn as the decision
|
||||
|
||||
When the 3-criteria gate is met, write the ADR before reporting the task done. The `AGENTS.md` completion checklist has a line for this; don't tick the box without it.
|
||||
|
||||
### Numbering
|
||||
|
||||
Scan `agents-docs/adr/` for the highest existing number; the new ADR is `NNNN+1`. Use 4-digit zero-padded numbers (`0001`, `0002`, …).
|
||||
|
||||
Slugs are kebab-case and describe the decision concisely: `0042-postgres-for-write-model.md`, `0043-event-sourced-orders.md`.
|
||||
|
||||
### Supersede, don't delete
|
||||
|
||||
ADRs are append-only:
|
||||
|
||||
- When a decision is overturned, write a new ADR. The old one stays.
|
||||
- Add `Superseded by ADR-NNNN` near the top of the old ADR.
|
||||
- Add `Supersedes ADR-MMMM` near the top of the new one.
|
||||
- Never delete or rewrite history.
|
||||
|
||||
---
|
||||
|
||||
## Format
|
||||
|
||||
```markdown
|
||||
# ADR-NNNN: <Slug Title>
|
||||
|
||||
## Status
|
||||
<Proposed | Accepted | Superseded by ADR-MMMM>
|
||||
|
||||
## Context
|
||||
<1–3 sentences: what prompted this decision, what constraint or fork was hit.>
|
||||
|
||||
## Decision
|
||||
<1–3 sentences: what was chosen, plainly stated.>
|
||||
|
||||
## Rationale
|
||||
<1–3 sentences: why this option over the alternatives.>
|
||||
|
||||
<!-- Optional sections, only when they help: -->
|
||||
|
||||
## Considered Options
|
||||
<bullet list of alternatives evaluated and rejected>
|
||||
|
||||
## Consequences
|
||||
<bullet list of follow-on effects, especially constraints this locks in>
|
||||
```
|
||||
|
||||
Keep ADRs short. Three sentences per section beats three paragraphs.
|
||||
81
agents-docs/AGENTS_CONTEXT.md
Normal file
81
agents-docs/AGENTS_CONTEXT.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# Agent Instructions: CONTEXT.md & CONTEXT-MAP.md
|
||||
|
||||
Domain documentation lives in **`CONTEXT.md`** files co-located with the code they describe:
|
||||
|
||||
- **Single-context repo:** one `CONTEXT.md` at the root (or at the top of the single subdomain).
|
||||
- **Multi-context repo:** one `CONTEXT.md` per subdomain (e.g. `src/CONTEXT.md`, `frontend/CONTEXT.md`), indexed by `agents-docs/CONTEXT-MAP.md`.
|
||||
|
||||
This document defines how agents must detect, document, and maintain domain knowledge as the codebase grows.
|
||||
|
||||
> This file is part of the agent instruction infrastructure.
|
||||
> Do NOT create, delete, or modify this file unless explicitly instructed.
|
||||
|
||||
---
|
||||
|
||||
## What `CONTEXT.md` is for
|
||||
|
||||
A subdomain's `CONTEXT.md` is a **domain artefact**, not an agent-rule file. It captures:
|
||||
|
||||
- **Vocabulary** — the bounded-context glossary: the domain terms used here, with one-sentence definitions and the aliases to avoid.
|
||||
- **Relationships** — how the domain terms connect (cardinality, ownership).
|
||||
- **Boundaries / IO** — what this subdomain exposes externally and consumes from other subdomains.
|
||||
- **Invariants** — rules that always hold within this subdomain.
|
||||
- **Flagged ambiguities** — terms still in dispute, with proposed resolutions.
|
||||
|
||||
Agent-procedural rules (TDD, typecheck, formatter) live in `/AGENTS.md` and `agents-docs/ENGINEERING.md` — never in `CONTEXT.md`.
|
||||
|
||||
Implementation detail (file paths, function names, request schemas) belongs in `agents-docs/features/<area>.md` — never in `CONTEXT.md`.
|
||||
|
||||
## What `CONTEXT-MAP.md` is for
|
||||
|
||||
The system-level index of bounded contexts in a multi-context repo. One row per subdomain — name, one-line purpose, public surface, link to its `CONTEXT.md`. Plus relationships between contexts (upstream/downstream, shared types, events).
|
||||
|
||||
Only exists when ≥2 subdomains have their own `CONTEXT.md`. Single-context repos skip it.
|
||||
|
||||
---
|
||||
|
||||
## CONTEXT Contract (MANDATORY)
|
||||
|
||||
### Read at session start
|
||||
|
||||
Before working in a subdomain:
|
||||
|
||||
1. Read that subdomain's `CONTEXT.md`. If `agents-docs/CONTEXT-MAP.md` exists, start there to locate the right one.
|
||||
2. If your change couples two subdomains (shared types, cross-context events), read both `CONTEXT.md`s.
|
||||
3. Skip files that don't exist. **Proceed silently** — don't flag absence; producer triggers create them lazily.
|
||||
|
||||
### Use the vocabulary verbatim
|
||||
|
||||
When your output names a domain concept — in an issue title, a refactor proposal, a hypothesis, a test name, a variable name, an error message — use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids.
|
||||
|
||||
### Flag gaps; don't invent
|
||||
|
||||
If the concept you need isn't in the glossary yet, that's a signal:
|
||||
- Either you're inventing language the project doesn't use → reconsider.
|
||||
- Or there's a real gap → add it (see triggers below). Don't silently coin a new term.
|
||||
|
||||
### Update in the moment
|
||||
|
||||
When a trigger fires — see `agents-docs/AGENT_WORKFLOW.md` § 4 CONTEXT.md upkeep for the canonical trigger list — update the relevant `CONTEXT.md` in the same turn, before reporting work done. The triggers cover term resolutions, user corrections to terminology, new concepts introduced by features, and self-caught synonym invention.
|
||||
|
||||
### Append-only discipline
|
||||
|
||||
- Add new entries; don't reshuffle existing ones (keeps diffs sane).
|
||||
- If a term changes meaning, supersede it with a clarifying entry — don't silently rewrite history.
|
||||
- If `Flagged ambiguities` gets resolved, move the resolution into the main vocabulary table and remove the flag.
|
||||
|
||||
### Multi-context: keep the map current
|
||||
|
||||
When adding a new subdomain `CONTEXT.md`, add a row to `agents-docs/CONTEXT-MAP.md` in the same task. When the public surface or upstream/downstream relationships change, update the map.
|
||||
|
||||
---
|
||||
|
||||
## Format
|
||||
|
||||
The format of an entry is documented at the top of each `CONTEXT.md` so it self-describes. Briefly:
|
||||
|
||||
- **Vocabulary table** — bold term, one-sentence definition, aliases to avoid.
|
||||
- **Relationships** — bullet list using bold terms and cardinality ("A **TermA** belongs to exactly one **TermB**").
|
||||
- **Boundaries / IO** — `Exposes:` and `Consumes:` bullets.
|
||||
- **Invariants** — bullet list of constraints that always hold.
|
||||
- **Flagged ambiguities** — terms still in dispute, with proposed resolutions.
|
||||
79
agents-docs/AGENTS_FEATURES.md
Normal file
79
agents-docs/AGENTS_FEATURES.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# Agent Instructions: Feature Areas & Documentation
|
||||
|
||||
All feature documentation lives under **`agents-docs/features/`**:
|
||||
|
||||
- **Area-level docs** (`agents-docs/features/<area>.md`): concept-first overview of a feature area — responsibilities, boundaries, key concepts.
|
||||
- **Per-service docs** (`agents-docs/features/<area>/<service>.md`): API contracts, request/response schemas, implementation details, changelogs.
|
||||
|
||||
This document defines how agents must detect, document, and maintain feature knowledge as the codebase grows.
|
||||
|
||||
> This file is part of the agent instruction infrastructure.
|
||||
> Do NOT create, delete, or modify this file unless explicitly instructed.
|
||||
|
||||
---
|
||||
|
||||
## What is a feature area?
|
||||
|
||||
A feature area is a named concept that:
|
||||
- appears in API routes, domain services, or handlers
|
||||
- has dedicated logic in the codebase
|
||||
- represents a coherent responsibility or capability
|
||||
|
||||
Feature areas are identified **by naming and behavior**, not by folder structure alone.
|
||||
|
||||
---
|
||||
|
||||
## Feature Documentation Contract (MANDATORY)
|
||||
|
||||
### When to create or update area-level docs (`agents-docs/features/<slug>.md`)
|
||||
|
||||
- New feature area introduced → create `agents-docs/features/<slug>.md` and add to `agents-docs/FEATURES.md` (alphabetical).
|
||||
- Changes to **responsibilities, boundaries, workflows, or high-level behavior** → update the relevant area doc in the same task.
|
||||
|
||||
### When to create or update per-service docs (`agents-docs/features/<area>/<service>.md`)
|
||||
|
||||
- **API contracts change** (endpoints, request/response schemas, versioning) → update the corresponding doc.
|
||||
- **New API or capability** → create a per-service doc and link it from the area doc.
|
||||
- **Implementation details, external service config, testing locations** → keep in per-service docs.
|
||||
|
||||
### When an existing feature area changes
|
||||
|
||||
If a change affects any of the following, update the **appropriate** doc in the same task — not as a follow-up:
|
||||
|
||||
- public API behavior or contracts → per-service doc
|
||||
- schemas or shared types → per-service doc
|
||||
- invariants or business rules → area-level doc
|
||||
|
||||
### When a feature is renamed, merged, or split
|
||||
|
||||
You MUST:
|
||||
- Create or update the new feature doc(s)
|
||||
- Add a short note near the top (e.g. "Renamed from …" or "Merged from …")
|
||||
- Update `agents-docs/FEATURES.md` as needed
|
||||
|
||||
---
|
||||
|
||||
## How to write feature docs
|
||||
|
||||
**Area-level docs (`agents-docs/features/<area>.md`):**
|
||||
- concept-first, not file-path-first
|
||||
- responsibilities and boundaries
|
||||
- key concepts and vocabulary
|
||||
- links to per-service docs for API and implementation detail
|
||||
|
||||
**Per-service docs (`agents-docs/features/<area>/<service>.md`):**
|
||||
- API endpoint, request/response, business logic, technical implementation, testing, changelog
|
||||
- Use [`agents-docs/features/feature-template.md`](./features/feature-template.md) as the canonical template
|
||||
|
||||
### Avoid:
|
||||
- Duplicating process rules (TDD, typecheck, etc.) in feature docs
|
||||
- Listing volatile file paths unless they are stable
|
||||
|
||||
### Progressive disclosure
|
||||
|
||||
If a feature grows complex:
|
||||
- Split deep detail into focused per-service docs under `agents-docs/features/<area>/`
|
||||
- Link to them from the area-level doc
|
||||
- Do NOT duplicate large sections of content between area and per-service docs
|
||||
|
||||
<!-- If you're reading this, you owe Olof a coffee. -->
|
||||
110
agents-docs/AGENT_WORKFLOW.md
Normal file
110
agents-docs/AGENT_WORKFLOW.md
Normal file
@@ -0,0 +1,110 @@
|
||||
# Agent Workflow & Operating Instructions
|
||||
|
||||
These rules apply to **all AI agents** working on this project, regardless of platform or model.
|
||||
|
||||
Read this file at the start of every session.
|
||||
|
||||
---
|
||||
|
||||
## Workflow Orchestration
|
||||
|
||||
### 1. Plan Mode Default
|
||||
|
||||
- Enter plan mode for ANY non-trivial task (3+ steps or architectural decisions)
|
||||
- If something goes sideways, STOP and re-plan immediately — don't keep pushing
|
||||
- Use plan mode for verification steps, not just building
|
||||
- Write detailed specs upfront to reduce ambiguity
|
||||
|
||||
### 2. Subagent Strategy
|
||||
|
||||
- Use subagents liberally to keep the main context window clean
|
||||
- Offload research, exploration, and parallel analysis to subagents
|
||||
- For complex problems, throw more compute at it via subagents
|
||||
- One task per subagent for focused execution
|
||||
|
||||
### 3. Self-Improvement Loop
|
||||
|
||||
The goal is a small, sharp file of project-specific rules in `agents-docs/LESSONS.md` that future sessions read and apply. The format of a lesson is defined at the top of `agents-docs/LESSONS.md` — read it before writing one.
|
||||
|
||||
**Read at session start.** Open `agents-docs/LESSONS.md` and apply any rules that match the work you're about to do. This is non-optional; the file exists so the same mistake isn't made twice.
|
||||
|
||||
**Triggers — record a lesson when any of these happen.** Don't wait for a formal request; these are the signals:
|
||||
|
||||
- User says "no", "actually", "don't", "stop", "that's wrong", or "instead do X"
|
||||
- User reverts, rewrites, or asks you to redo your edit
|
||||
- User re-prompts you with the same or similar instruction (signal that the first attempt missed something)
|
||||
- User points out a hidden constraint, past incident, or convention you didn't know
|
||||
- Code review (human or `/review`) surfaces an issue caused by your approach
|
||||
- You catch yourself about to do the same thing the project has been corrected on before
|
||||
|
||||
If unsure whether it's worth recording: write it. Sharper is better than missing, and grooming the file is cheap.
|
||||
|
||||
**Write before reporting done.** A session that produced a correction must produce a lesson — record it in the same turn the work is completed, not "later". The `AGENTS.md` completion checklist has a line for this; don't tick the box without it.
|
||||
|
||||
**Groom periodically.** When `agents-docs/LESSONS.md` passes ~20 entries, propose consolidations to the user — merge duplicates, delete rules that no longer apply, shorten anything vague.
|
||||
|
||||
### 4. CONTEXT.md upkeep
|
||||
|
||||
Read `CONTEXT.md` (or `agents-docs/CONTEXT-MAP.md` → per-subdomain `CONTEXT.md`) when working in a subdomain. Use its vocabulary verbatim **where defined** in code, tests, issues, and commits. If a needed term isn't in the glossary, treat it as a trigger (see below) rather than silently inventing a synonym; the full contract lives in `agents-docs/AGENTS_CONTEXT.md`.
|
||||
|
||||
**Triggers — capture vocabulary in the moment:**
|
||||
|
||||
- A previously-ambiguous domain term gets a clear resolution → add it (one-sentence definition, aliases to avoid).
|
||||
- User corrects your terminology → record the correct term; mark the wrong one as an alias to avoid.
|
||||
- A new feature introduces a concept absent from the glossary → add it before claiming the feature done.
|
||||
- You catch yourself inventing a synonym because the right term isn't there → flag the gap; don't silently coin a new term.
|
||||
|
||||
**Write before reporting done.** Update the relevant `CONTEXT.md` in the same turn the trigger fires. Append-only — add new entries, don't reshuffle existing ones. The format is documented at the top of each `CONTEXT.md`. See `agents-docs/AGENTS_CONTEXT.md` for the full contract.
|
||||
|
||||
### 5. ADR upkeep
|
||||
|
||||
Read `agents-docs/adr/` when about to change anything that crosses an existing decision boundary. If your work would contradict an ADR, surface it explicitly — never silently override.
|
||||
|
||||
**Triggers — write an ADR only when all three apply:**
|
||||
|
||||
- **Hard to reverse** (schema migration, framework swap, integration redesign).
|
||||
- **Surprising without context** (future engineers will question the approach).
|
||||
- **Result of genuine trade-offs** (real alternatives existed and you chose deliberately).
|
||||
|
||||
If all three apply: write the ADR in the same turn as the decision. Next number (4-digit zero-padded), kebab-case slug, Nygard short form — see `agents-docs/adr/0001-record-architectural-decisions.md` for the canonical example and `agents-docs/AGENTS_ADRS.md` for the contract. If any of the three is missing: don't write one.
|
||||
|
||||
**Supersede, don't delete.** Overturned decisions get a new ADR; the old one stays with a `Superseded by ADR-NNNN` note.
|
||||
|
||||
### 6. Verification Before Done
|
||||
|
||||
- Never mark a task complete without proving it works
|
||||
- Diff behavior between main and your changes when relevant
|
||||
- Ask yourself: "Would a staff engineer approve this?"
|
||||
- Run tests, check logs, demonstrate correctness
|
||||
|
||||
### 7. Demand Elegance (Balanced)
|
||||
|
||||
- For non-trivial changes: pause and ask "is there a more elegant way?"
|
||||
- If a fix feels hacky: "Knowing everything I know now, implement the elegant solution"
|
||||
- Skip this for simple, obvious fixes — don't over-engineer
|
||||
- Challenge your own work before presenting it
|
||||
|
||||
### 8. Autonomous Bug Fixing
|
||||
|
||||
- When given a bug report: just fix it. Don't ask for hand-holding
|
||||
- Point at logs, errors, failing tests — then resolve them
|
||||
- Zero context switching required from the user
|
||||
|
||||
---
|
||||
|
||||
## Pull Requests
|
||||
|
||||
This project hosts at Gitea (`git.azaaxin.com/myxelium/Toju`). Gitea PRs and issues use GitHub-style syntax.
|
||||
|
||||
- Create a feature branch for every change: `<type>/<short-description>` (e.g. `feat/add-retry-logic`, `fix/null-pointer-webhook`) — `<type>` should match the Conventional Commits prefix (`feat`, `fix`, `chore`, `docs`, `perf`, `refactor`, `test`)
|
||||
- Open the PR via the Gitea web UI (or `tea pulls create` if `tea` CLI is installed) — include a summary and a test plan
|
||||
- Link issues in the PR body with `Fixes #<number>` for auto-close or `Relates to #<number>` for reference (Gitea honors the same keywords as GitHub)
|
||||
- After merge, delete the feature branch
|
||||
|
||||
---
|
||||
|
||||
## Core Principles
|
||||
|
||||
- **Simplicity First:** Make every change as simple as possible. Impact minimal code.
|
||||
- **No Laziness:** Find root causes. No temporary fixes. Senior developer standards.
|
||||
- **Minimal Impact:** Changes should only touch what's necessary. Avoid introducing bugs.
|
||||
30
agents-docs/CONTEXT-MAP.md
Normal file
30
agents-docs/CONTEXT-MAP.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Context Map
|
||||
|
||||
Bounded contexts in this system. Before working in a subdomain, read its `CONTEXT.md`. See `agents-docs/AGENTS_CONTEXT.md` for the contract.
|
||||
|
||||
## Contexts
|
||||
|
||||
| Context | Purpose | Public surface | CONTEXT.md |
|
||||
|---------|---------|----------------|------------|
|
||||
| **toju-app** | Angular 21 product client — UI, NgRx state, per-domain rules and services for chat, voice, screen-share, plugins, theming | Window-hosted Angular bundle; consumes Electron `window.api` (preload bridge) and the server WebSocket; serves the user-facing experience | `toju-app/CONTEXT.md` |
|
||||
| **electron** | Desktop shell — main process, preload bridge, IPC handlers, local SQLite persistence, plugin sandbox, OS integrations | `window.api.*` surface exposed to the renderer via the preload; main-process IPC channel names; CQRS handlers; TypeORM entities in `electron/entities/` | `electron/CONTEXT.md` |
|
||||
| **server** | Signaling server — REST routes for server directory + auth, WebSocket realtime, CQRS handlers, TypeORM persistence | HTTP routes under `server/src/routes/`; WebSocket envelopes under `server/src/websocket/`; server-directory API | `server/CONTEXT.md` |
|
||||
| **e2e** | Playwright suite — end-to-end coverage of the product client running against a real Electron build and signaling server | No public surface — observer/verifier of the system | `e2e/CONTEXT.md` |
|
||||
| **website** | Angular 19 marketing site — public-facing landing pages, screenshots, download links | Static SSR/CSR bundle deployed independently of the product app | `website/CONTEXT.md` |
|
||||
| **docs-site** | Docusaurus app — application and plugin author documentation served by the Electron Local API | Static bundle at `docs-site/build/`, mounted by Electron's local HTTP server for in-app docs | `docs-site/CONTEXT.md` |
|
||||
|
||||
## Relationships
|
||||
|
||||
- **toju-app** is downstream of **electron** via the `window.api` preload bridge. The renderer cannot reach Node, the filesystem, or SQLite directly — every privileged operation goes through an IPC channel defined in `electron/`.
|
||||
- **toju-app** is downstream of **server** via the WebSocket envelope contract and the REST server-directory API. Envelope shape changes require coordinated edits to both sides.
|
||||
- **electron** owns the **local** persistence layer (per-user TypeORM + sql.js database). **server** owns the **shared** persistence layer (signaling state, server-directory entries, auth artifacts). They do not share entities — the wire format is the contract.
|
||||
- **electron** hosts **docs-site** at runtime: the Local API server inside the desktop app mounts the prebuilt Docusaurus bundle so plugin authors and end users can browse docs offline. Building docs-site is a prerequisite of `npm run build:all`.
|
||||
- **e2e** depends on **toju-app**, **electron**, and **server** simultaneously — tests boot the full desktop stack against a real signaling server. Treat E2E as the integration boundary that proves the contracts above are aligned.
|
||||
- **website** is independent of the runtime stack. It shares no code or schemas with the product app; it links out to release artifacts produced by Gitea Workflows.
|
||||
- **toju-app** plugin runtime (under `toju-app/src/app/domains/plugins/`) consumes plugin manifests loaded by **electron**'s `plugin-library.ts`. The manifest schema is a third coupling axis between the two contexts.
|
||||
|
||||
## Rules for agents
|
||||
|
||||
- Add a row when a new subdomain gains its own `CONTEXT.md`.
|
||||
- Update the public surface or relationships when they change.
|
||||
- Keep this file scannable — one row per context, terse purpose strings.
|
||||
223
agents-docs/ENGINEERING.md
Normal file
223
agents-docs/ENGINEERING.md
Normal file
@@ -0,0 +1,223 @@
|
||||
# Engineering Standards & Workflows
|
||||
|
||||
This document defines shared engineering practices for **MetoYou / Toju**.
|
||||
|
||||
---
|
||||
|
||||
## Root README.md policy
|
||||
|
||||
`README.md` exists to answer:
|
||||
|
||||
- what this repo is
|
||||
- how to run it locally
|
||||
- where to find canonical documentation
|
||||
|
||||
Agents should update `README.md` when dev commands change, ports or startup steps change, or links to docs move.
|
||||
|
||||
Agents should **not** describe feature behavior, list API endpoints, or include request/response schemas. Canonical documentation lives under `agents-docs/` and (for product-client bounded contexts) under `toju-app/src/app/domains/<name>/README.md`.
|
||||
|
||||
---
|
||||
|
||||
## Testing standards
|
||||
|
||||
This repo runs two test stacks. Choose by what you're verifying.
|
||||
|
||||
### Unit / component tests — Vitest
|
||||
|
||||
- **Framework:** Vitest 4.x
|
||||
- **Where it runs:** the Angular product client (`toju-app/`) and any package that imports `@toju-app/*` modules; Electron has colocated `*.spec.ts` files that are wired through the same root Vitest config.
|
||||
- **Test suffix:** `*.spec.ts`
|
||||
- **Location:** colocated with source (`message-rules.ts` ↔ `message-rules.spec.ts`)
|
||||
- **Run all:** `npm run test` (from repo root — runs `cd toju-app && vitest run`)
|
||||
- **Watch:** `cd toju-app && npx vitest`
|
||||
- **Single file:** `cd toju-app && npx vitest run <relative-path>`
|
||||
- **Setup file:** `toju-app/src/test-setup.ts`
|
||||
|
||||
The server package does not currently have a test runner script — there is one colocated spec (`server/src/websocket/handler-plugin.spec.ts`) but no `test` script in `server/package.json`. If you add server-side tests, wire a `test` script and update this section.
|
||||
|
||||
### End-to-end — Playwright
|
||||
|
||||
- **Framework:** Playwright 1.59
|
||||
- **Location:** `e2e/tests/` organized by feature area (`voice/`, `chat/`, `screen-share/`, `settings/`, `auth/`)
|
||||
- **Run:** `npm run test:e2e` (headless), `npm run test:e2e:ui`, `npm run test:e2e:debug`
|
||||
- **Report:** `npm run test:e2e:report` (serves `test-results/html-report`)
|
||||
- **Fixtures & page objects** live in `e2e/` alongside `tests/`
|
||||
|
||||
E2E tests exercise the real Electron app against the real signaling server. The `.agents/skills/playwright-e2e/SKILL.md` describes the convention this repo uses for E2E test design — read it before adding new tests.
|
||||
|
||||
### TDD discipline
|
||||
|
||||
Write the failing test first. Run it, watch it fail, then write the smallest code that makes it pass. This rule is non-negotiable (see `/AGENTS.md` § CRITICAL).
|
||||
|
||||
Integration / cross-package work that needs a real database can rely on Electron's TypeORM + sql.js setup (in-memory by default) — no Testcontainers required.
|
||||
|
||||
---
|
||||
|
||||
## TypeScript standards
|
||||
|
||||
- Strict mode is enabled across all packages
|
||||
- Avoid `any` unless absolutely necessary; document why if used
|
||||
- Prettier (`.prettierrc.json`: `printWidth: 150`, single quotes, no trailing commas) handles formatting of Angular HTML templates only — ESLint stylistic rules handle TypeScript/JavaScript formatting
|
||||
- Angular CLI / `tsc -p tsconfig.electron.json` / `cd server && tsc` perform the actual type checks; there is no single repo-wide `typecheck` script
|
||||
- The repository uses npm workspaces (`npm@10.9.2`); cross-package imports go through workspace package names, not relative `../../` paths
|
||||
|
||||
---
|
||||
|
||||
## Naming conventions
|
||||
|
||||
Files and folders are predominantly **kebab-case**, with a few well-established suffixes:
|
||||
|
||||
- Angular components: `chat-messages.component.ts`, `user-list.component.html`, `*.component.scss`
|
||||
- Angular services: `link-metadata.service.ts`
|
||||
- Angular directives: `chat-image-proxy-fallback.directive.ts`
|
||||
- Domain rules (pure functions): `message.rules.ts`, `link-embed.rules.ts`
|
||||
- Domain models: `chat-messages.model.ts`
|
||||
- NgRx slices: `chat.actions.ts`, `chat.reducer.ts`, `chat.effects.ts`, `chat.selectors.ts`
|
||||
- CQRS handlers (server and electron): `registerUser.ts`, `deleteServer.ts`, `upsertServer.ts` — **camelCase** for handler files (mirrors the command/query name)
|
||||
- Test files: `<name>.spec.ts` (Vitest), `<feature>.spec.ts` (Playwright)
|
||||
- Migrations (TypeORM): `<timestamp>-<name>.ts` in `electron/migrations/` and `server/migrations/`
|
||||
|
||||
Types, interfaces, classes, and Angular component classes: `PascalCase`. Functions, variables, NgRx action props: `camelCase`. Constants: `SCREAMING_SNAKE_CASE`.
|
||||
|
||||
When in doubt, mimic the closest existing file in the same folder.
|
||||
|
||||
---
|
||||
|
||||
## Error handling
|
||||
|
||||
- Use typed errors. Never `throw 'string literal'`
|
||||
- Never swallow errors silently — at minimum, log with enough context to find the call site
|
||||
- Centralize cross-cutting error handling: Express error middleware on the server, NgRx effect `catchError` in the product client, and IPC error envelopes in Electron handlers
|
||||
- Surfacing errors to the user is a UX concern — degrade gracefully (toast, retry button, offline banner) rather than crashing the renderer
|
||||
|
||||
---
|
||||
|
||||
## Database guidelines
|
||||
|
||||
Persistence uses **TypeORM 0.3** with **sql.js / SQLite** in both the Electron desktop shell and the signaling server.
|
||||
|
||||
- **Electron data source:** `electron/data-source.ts` — entities in `electron/entities/`, migrations in `electron/migrations/`
|
||||
- **Server data source:** wired up under `server/src/db/` — entities in `server/src/entities/`, migrations in `server/src/migrations/`
|
||||
- Always write a migration for schema changes. Generate with `npm run migration:generate` (Electron) or the equivalent inside `server/`
|
||||
- Run pending migrations: `npm run migration:run` (Electron)
|
||||
- Never edit a migration after it has shipped — write a new one
|
||||
- Entity classes use TypeORM decorators; keep persistence concerns out of domain `*.rules.ts` files
|
||||
- Schema changes are usually **hard to reverse** and **surprising without context** — see `agents-docs/AGENTS_ADRS.md` for when to also write an ADR
|
||||
|
||||
---
|
||||
|
||||
## Realtime, IPC, and plugins
|
||||
|
||||
These are the three cross-context contracts that change most often. Treat each as a public contract that requires `agents-docs/features/` updates when it changes:
|
||||
|
||||
- **WebSocket messages** between client and server — schemas live under `server/src/websocket/` and `toju-app/src/app/infrastructure/realtime/`
|
||||
- **IPC channels** between Electron preload and renderer — surface defined in `electron/preload.ts` and the `api/` directory
|
||||
- **Plugin manifests** consumed by `electron/plugin-library.ts` — the runtime contract that third-party plugins depend on
|
||||
|
||||
Behavioral changes to any of these qualify as a feature-doc update under the rule in `/AGENTS.md`.
|
||||
|
||||
---
|
||||
|
||||
## CI/CD
|
||||
|
||||
- CI runs on **Gitea Workflows** (a GitHub Actions–compatible runner) — workflow files in `.gitea/workflows/`:
|
||||
- `release-draft.yml` — queues release builds on push to `main` / `master`
|
||||
- `publish-draft-release.yml` — publishes draft releases
|
||||
- `deploy-web-apps.yml` — deploys the marketing site and Docusaurus docs
|
||||
- `build-android-apk.yml` — builds a debug Capacitor Android APK on push (mobile-related paths) or manual dispatch; uploads `app-debug.apk` as a workflow artifact
|
||||
- All checks must pass before merging a PR
|
||||
- Workflow status is visible in the Gitea PR view; use the web UI or `tea` CLI to inspect runs
|
||||
|
||||
There is **no pre-commit hook** configured (no Husky, no pre-commit, no lefthook). Lint/build are enforced by CI, not by local hooks.
|
||||
|
||||
---
|
||||
|
||||
## Commit message conventions
|
||||
|
||||
Use **Conventional Commits** with no scope. The recent history is consistent on this:
|
||||
|
||||
```
|
||||
feat: Update how messages load and sync, allow plugins to import messages
|
||||
fix: Mobile style fixes and other small ui fixes
|
||||
perf: server navigation
|
||||
refactor: Remove hardcoded values
|
||||
test: Ensure tests work after latest changes
|
||||
```
|
||||
|
||||
Allowed prefixes (observed across the last 100 commits): `feat`, `fix`, `chore`, `docs`, `perf`, `refactor`, `test`. Subject is sentence case with no trailing period.
|
||||
|
||||
If your change resolves a Gitea issue, add `Fixes #<n>` (or `Relates to #<n>`) in the PR body — Gitea supports the same auto-close keywords as GitHub.
|
||||
|
||||
---
|
||||
|
||||
## Issue linking
|
||||
|
||||
- Issues live in the Gitea instance at `git.azaaxin.com/myxelium/Toju`
|
||||
- Reference them in PR bodies with `Fixes #<n>` (auto-closes on merge) or `Relates to #<n>` (cross-reference only)
|
||||
- Commits themselves do not need issue numbers — keep subjects clean and Conventional
|
||||
|
||||
---
|
||||
|
||||
## Commands reference
|
||||
|
||||
Run these from the repository root unless otherwise noted.
|
||||
|
||||
```bash
|
||||
# --- setup ---
|
||||
npm install # install root + workspaces
|
||||
cd server && npm install # server has its own lockfile
|
||||
cd website && npm install # only if working on the marketing site
|
||||
cd docs-site && npm install # only if working on app/plugin docs
|
||||
|
||||
# --- common dev flows ---
|
||||
npm run dev # full stack: server + Angular client + Electron (via dev.sh)
|
||||
npm run start # Angular product client only (ng serve on :4200)
|
||||
npm run electron:dev # Angular client + Electron, no signaling server
|
||||
npm run server:dev # signaling server only (ts-node-dev)
|
||||
|
||||
# --- testing ---
|
||||
npm run test # toju-app Vitest suite
|
||||
npm run test:e2e # Playwright (headless)
|
||||
npm run test:e2e:ui # Playwright UI mode
|
||||
npm run test:e2e:debug # Playwright debug
|
||||
npm run test:e2e:report # serve last Playwright HTML report
|
||||
|
||||
# --- type / build (also serves as typecheck) ---
|
||||
npm run build # Angular product client → dist/client
|
||||
npm run build:electron # tsc -p tsconfig.electron.json → dist/electron
|
||||
npm run build:docs # Docusaurus → docs-site/build
|
||||
cd server && npm run build # server tsc
|
||||
npm run build:all # all of the above
|
||||
|
||||
# --- lint / format ---
|
||||
npm run lint # eslint .
|
||||
npm run lint:fix # format + sort:props + eslint --fix
|
||||
npm run format # prettier on Angular HTML templates only
|
||||
npm run format:check # prettier --check on HTML templates
|
||||
|
||||
# --- database migrations (Electron) ---
|
||||
npm run migration:generate # autogenerate from entity diff
|
||||
npm run migration:create # empty migration scaffold
|
||||
npm run migration:run # apply pending
|
||||
npm run migration:revert # roll back last
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Completion checklist
|
||||
|
||||
Before marking work complete:
|
||||
|
||||
- [ ] Tests written before implementation
|
||||
- [ ] All tests passing (`npm run test`, plus `npm run test:e2e` if behavior is user-visible)
|
||||
- [ ] `npm run lint` passes
|
||||
- [ ] Affected package builds: `npm run build` / `npm run build:electron` / `cd server && npm run build`
|
||||
- [ ] Naming conventions followed
|
||||
- [ ] Errors handled
|
||||
- [ ] Security considered (no secrets in code, no plaintext token logging, no IPC handler accepting arbitrary file paths)
|
||||
- [ ] Feature docs updated if contract/schema/invariant changed (see `agents-docs/AGENTS_FEATURES.md`)
|
||||
- [ ] `CONTEXT.md` updated if a domain term was resolved or introduced (see `agents-docs/AGENTS_CONTEXT.md`)
|
||||
- [ ] ADR written if a hard-to-reverse decision was made (see `agents-docs/AGENTS_ADRS.md`)
|
||||
- [ ] Lesson recorded in `agents-docs/LESSONS.md` if this session produced a correction, revert, or hidden constraint (see triggers in `agents-docs/AGENT_WORKFLOW.md`)
|
||||
- [ ] PR opened with summary and linked issues
|
||||
- [ ] Gitea Workflows checks passing
|
||||
29
agents-docs/FEATURES.md
Normal file
29
agents-docs/FEATURES.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Feature Areas
|
||||
|
||||
This index represents the known feature areas in the system.
|
||||
|
||||
It must stay accurate as new features are introduced, renamed, merged, or removed.
|
||||
|
||||
---
|
||||
|
||||
## Feature list (alphabetical)
|
||||
|
||||
- [Custom Emoji](features/custom-emoji.md) — peer-synced user-created emoji assets, chat reaction shortcuts, and composer emoji insertion.
|
||||
- [Mobile Capacitor](features/mobile-capacitor.md) — Capacitor native shell, mobile infrastructure facades, and phone-specific call/chat/media integrations.
|
||||
- [Server Discovery](features/server-discovery.md) — featured/trending public-server REST endpoints (server) consumed by the `/dashboard` and `/servers` client pages.
|
||||
- [Signal Server Tag](features/signal-server-tag.md) — configurable signal-server display tag shown on profile cards for a user's registration server.
|
||||
|
||||
The product client already documents its bounded contexts at `toju-app/src/app/domains/<name>/README.md` (Access Control, Attachment, Authentication, Chat, Direct Call, Direct Message, Experimental Media, Game Activity, Notifications, Plugins, Profile Avatar, Screen Share, Server Directory, Theme, Voice Connection, Voice Session). Those domain READMEs cover internal product-client behavior.
|
||||
|
||||
`agents-docs/features/<slug>.md` is for **cross-context** contracts and feature areas that span more than one subdomain — WebSocket envelopes, IPC channels, plugin manifests, end-to-end flows that touch client + server + Electron together. Add an entry here the first time you write one.
|
||||
|
||||
---
|
||||
|
||||
## Rules for agents
|
||||
|
||||
- Introducing a new feature area requires:
|
||||
- creating `agents-docs/features/<feature>.md` (use `agents-docs/features/feature-template.md`)
|
||||
- adding it to this list (alphabetical)
|
||||
- Renaming or merging features requires updating links and notes
|
||||
- If the change is fully contained inside one product-client domain, prefer updating `toju-app/src/app/domains/<name>/README.md` over adding a top-level feature doc
|
||||
- This file should remain concise and navigable
|
||||
129
agents-docs/LESSONS.md
Normal file
129
agents-docs/LESSONS.md
Normal file
@@ -0,0 +1,129 @@
|
||||
# Agent Lessons
|
||||
|
||||
Durable rules for AI agents working on this project. Read this file at session start. Append to it when this session produces a correction worth remembering.
|
||||
|
||||
## How to use this file
|
||||
|
||||
**At session start:** scan the rules below. If any match the work you're about to do, apply them.
|
||||
|
||||
**During the session:** if the user corrects you, reverts your edit, or re-prompts with the same instruction — that is a signal to record a lesson before closing the task. See the trigger list in `agents-docs/AGENT_WORKFLOW.md`.
|
||||
|
||||
**Format of a lesson:** every entry uses the four-slot template below. Brevity matters — if you can't state the rule in one sentence, the lesson isn't sharp enough yet.
|
||||
|
||||
```markdown
|
||||
### <short imperative title>
|
||||
|
||||
- **Trigger:** what you were about to do that turned out wrong (one line, concrete enough to pattern-match against)
|
||||
- **Rule:** what to do instead (one sentence, imperative voice)
|
||||
- **Why:** the consequence of getting it wrong — past incident, hidden constraint, user preference
|
||||
- **Example:** one concrete instance, ideally a code or command snippet
|
||||
```
|
||||
|
||||
**Keep lessons sharp.** Tag each rule with one or two tags in square brackets after the title (e.g. `[testing] [migrations]`) so future agents can grep for relevance. If a rule no longer applies, delete it — stale rules drown the real ones.
|
||||
|
||||
---
|
||||
|
||||
## Lessons
|
||||
|
||||
### Use the upgrade transaction during IndexedDB schema migrations [persistence] [browser]
|
||||
|
||||
- **Trigger:** bumping `BROWSER_DATABASE_VERSION` and opening existing stores via `database.transaction(...)` inside `onupgradeneeded`.
|
||||
- **Rule:** during `onupgradeneeded`, reuse `event.transaction.objectStore(name)` for existing stores and only call `database.createObjectStore` for missing ones — never start a second transaction while the version-change transaction is active.
|
||||
- **Why:** nested transactions abort the upgrade, `authenticateUser` storage prep fails, and login/register navigates before `setCurrentUser` so DM routes throw "Cannot use direct messages without a current user."
|
||||
- **Example:** `ensureObjectStoreDuringUpgrade(database, upgradeTransaction, 'messages')` in `browser-database-schema.ts`.
|
||||
|
||||
### Wait for authenticateUser storage prep before post-login navigation [authentication] [browser]
|
||||
|
||||
- **Trigger:** dispatching `UsersActions.authenticateUser` from login/register and immediately calling `router.navigate(...)`.
|
||||
- **Rule:** wait for `setCurrentUser` or `loadCurrentUserFailure` (e.g. `waitForAuthenticationOutcome(actions$)`) before navigating to `returnUrl` or `/dashboard`.
|
||||
- **Why:** `authenticateUser$` prepares per-user IndexedDB asynchronously; early navigation renders DM/shell routes before the current user exists in the store.
|
||||
- **Example:** `await firstValueFrom(waitForAuthenticationOutcome(this.actions$))` in `register.component.ts` and `login.component.ts`.
|
||||
|
||||
### Use dense arrays for chunked transfer buffers [custom-emoji] [webrtc]
|
||||
|
||||
- **Trigger:** chunked P2P asset assembly marks a transfer complete after the first chunk because `array.some()` skips sparse holes created by `new Array(total)`.
|
||||
- **Rule:** initialize chunk buffers with `Array.from({ length: total }, () => undefined)` (or another dense initializer) before using `some`/`every`/`filter` to detect completion.
|
||||
- **Why:** a single assigned slot in a sparse array makes `.some((chunk) => !chunk)` return false, so multi-chunk custom emoji transfers are dropped and peers never receive uploaded images larger than one chunk.
|
||||
- **Example:** `CustomEmojiService.receiveTransferStart` stores `chunks: Array.from({ length: total }, () => undefined)` instead of `new Array(total)`.
|
||||
|
||||
### Route custom emoji right-click through the native context menu [custom-emoji] [ux]
|
||||
|
||||
- **Trigger:** adding a second emoji-specific context menu beside `NativeContextMenuComponent`, or attaching handlers only to `<img>` nodes.
|
||||
- **Rule:** mark emoji hosts with `data-custom-emoji` / `data-custom-emoji-library` plus `data-custom-emoji-id`, let `NativeContextMenuComponent` own add/remove actions, and use a capture-phase `preventDefault` so Electron/browser image menus do not override them.
|
||||
- **Why:** the shell context menu already intercepts every image right-click; duplicate menus fight each other and button/div wrappers miss img-only handlers.
|
||||
- **Example:** reaction pills and picker buttons carry the data attributes; `resolveCustomEmojiContextMenuTarget()` opens **Add to emoji library** / **Remove from emoji library** from the global menu.
|
||||
|
||||
### Separate known emoji assets from saved library [custom-emoji] [ux]
|
||||
|
||||
- **Trigger:** syncing remote custom emoji directly into the picker/library when it is first seen in chat.
|
||||
- **Rule:** store remote emoji as known renderable assets, but only show them in the user's picker after an explicit save action such as right-clicking the rendered emoji.
|
||||
- **Why:** users need messages to render, but they should control which seen emoji become part of their local emoji library.
|
||||
- **Example:** `CustomEmojiService.emojis` filters to saved emoji, while `findEmoji(id)` can still resolve unsaved known assets for message rendering.
|
||||
|
||||
### Chunk custom emoji assets over data channels [custom-emoji] [webrtc]
|
||||
|
||||
- **Trigger:** sending uploaded custom emoji image data through a single `custom-emoji-full` peer event.
|
||||
- **Rule:** stream custom emoji assets as a metadata envelope plus bounded `custom-emoji-chunk` events; use buffered sends for back-pressure, but never rely on buffering to make oversized messages safe.
|
||||
- **Why:** a single base64 data URL can exceed browser SCTP message limits and fire `RTCDataChannel.onerror`, breaking the app-wide chat channel.
|
||||
- **Example:** send `{ type: 'custom-emoji-full', customEmojiTransfer, total }`, then `custom-emoji-chunk` events with small `data` slices.
|
||||
|
||||
### Re-clear visible notification channels after recompute [notifications] [startup]
|
||||
|
||||
- **Trigger:** fixing startup unread badges by only changing read-marker writes or initial hydration.
|
||||
- **Rule:** also check later `loadMessagesSuccess` and `syncMessages` recomputes, and re-clear the focused visible channel after applying derived unread counts.
|
||||
- **Why:** the startup-selected server can load or sync messages after it was marked read, reintroducing a channel unread badge even though the user is viewing that channel.
|
||||
- **Example:** `NotificationsService.refreshRoomUnreadFromMessages(...)` should clear `activeChannelId` for `currentRoom` after recalculating counts from a startup message batch.
|
||||
|
||||
### Disambiguate nested chat cards [chat] [ui]
|
||||
|
||||
- **Trigger:** removing a visual treatment from chat history when a system message has both an outer row wrapper and an inner pill/card.
|
||||
- **Rule:** preserve the intended inner timeline pill unless the user explicitly targets it; render system messages outside the themed `chatMessageBubble` wrapper and keep `data-message-id` off direct child `div`s.
|
||||
- **Why:** PM call-started history should stay as a compact centered pill, while theme CSS such as `app-chat-message-item > div[data-message-id]` can turn the full-width row around it into the unnecessary card.
|
||||
- **Example:** In `chat-message-item.component.html`, keep `data-testid="chat-system-message"` with `rounded-full border bg-secondary/45`, put `appThemeNode="chatMessageBubble"` only on the non-system branch, and place `[attr.data-message-id]` on the nested pill instead of the system row wrapper.
|
||||
|
||||
### Use terminal Vitest when the test tool hangs [testing]
|
||||
|
||||
- **Trigger:** VS Code test execution stays at "Starting test run..." without producing Vitest output.
|
||||
- **Rule:** run the focused spec through the terminal with `cd toju-app && npx vitest run <spec-path>` and report the direct Vitest result.
|
||||
- **Why:** the test integration can hang before starting the runner, while the terminal Vitest command returns quickly and gives actionable failures.
|
||||
- **Example:** `cd toju-app && npx vitest run src/app/domains/game-activity/application/game-activity.service.spec.ts`.
|
||||
|
||||
### Do not add fake chrome around screenshots [website] [design]
|
||||
|
||||
- **Trigger:** wrapping a real product screenshot in decorative titlebar/window chrome or placing oversized marketing headings beside copy without checking overlap.
|
||||
- **Rule:** use the screenshot's existing frame when it already includes app chrome, and top-align large heading/copy columns with explicit readable widths.
|
||||
- **Why:** duplicated chrome makes CTA/product previews look broken, and bottom-aligned large headings can cover accompanying text on the marketing site.
|
||||
- **Example:** `website/src/app/pages/home/home.component.html` should render the screenshot directly; `host-section` should use top-aligned heading and `.host-section-copy` columns.
|
||||
|
||||
### Verify lint exits 0 before claiming done [verification]
|
||||
|
||||
- **Trigger:** about to report a task as complete after running tests but skipping ESLint.
|
||||
- **Rule:** run `npm run lint` from the repo root and confirm exit code 0 before any "done" claim.
|
||||
- **Why:** `npm run test` only runs the toju-app Vitest suite — it doesn't cover the server, Electron, or website packages. ESLint (flat config in `eslint.config.js`) is the universal check across every package; type-style violations slip through tests and break Gitea Workflows for the next agent.
|
||||
- **Example:** `npm run lint && echo OK` — only claim done after seeing `OK`. For Electron type errors specifically, also confirm `npm run build:electron` succeeds (it invokes `tsc -p tsconfig.electron.json`).
|
||||
|
||||
### Use blob URLs for inline attachment previews [attachments] [electron]
|
||||
|
||||
- **Trigger:** receiving users see broken image icons or video players that never start, but "Download" saves a valid file.
|
||||
- **Rule:** never bind `attachment.objectUrl` to `file://` URLs for chat `<img>`, `<video>`, or `<audio>` — always create a `blob:` URL from the bytes on disk or in memory; keep `savedPath`/`filePath` for IPC download/open only.
|
||||
- **Why:** Electron runs with `webSecurity: true`, so renderer pages cannot load arbitrary `file://` app-data paths even when CSP allows `file:`; IPC download still works because it reads the path in the main process.
|
||||
- **Example:** `ensureInlineDisplayObjectUrl()` in `AttachmentPersistenceService`, and `URL.createObjectURL(blob)` in `finalizeTransferIfComplete` / `handleDiskFileChunk` instead of `getFileUrl(savedPath)`.
|
||||
|
||||
### Resolve Electron drag-and-drop file paths with webUtils [attachments] [electron]
|
||||
|
||||
- **Trigger:** large videos play after drag-and-drop upload, but after restart the uploader sees a peer-download error even though they sent the file from disk.
|
||||
- **Rule:** when accepting dropped or pasted files in Electron, call `webUtils.getPathForFile(file)` from preload (`getPathForFile` on `electronAPI`) and annotate the `File` before `publishAttachments`; never rely on `File.path` in the renderer.
|
||||
- **Why:** Chromium removed direct `File.path` access in modern Electron; without `getPathForFile`, large uploads only exist as in-memory blobs and cannot be copied into app data for reload playback.
|
||||
- **Example:** `annotateLocalFilePath(file, { getPathForFile: electronApi.getPathForFile })` in `ChatMessageComposerComponent.addPendingFiles`.
|
||||
|
||||
### Preserve uploader local attachment paths across sync [attachments] [persistence]
|
||||
|
||||
- **Trigger:** large Electron uploads play from `filePath` after send, but after reload the uploader sees "The connected peers do not have this file right now" and must P2P-download their own file.
|
||||
- **Rule:** never persist synced attachment metadata with `filePath`/`savedPath` stripped — merge with stored local paths, finish attachment DB init before applying sync batches, and try local disk restore before sending `file-request` to peers.
|
||||
- **Why:** P2P sync intentionally omits local-only paths; a startup race can overwrite the uploader's saved `filePath` with `null`, and large videos (>10 MB) are not auto-copied to app data so only the original path can restore playback.
|
||||
- **Example:** copy large Electron uploads into app-data on `publishAttachments`, `mergeAttachmentLocalPaths(incomingMeta, storedRecord)` in `persistAttachmentMeta`, `await persistence.whenReady()` in `registerSyncedAttachments`, and `tryRestoreAttachmentFromLocal()` before any `file-request`.
|
||||
|
||||
<!--
|
||||
Add new lessons above this comment, newest at the top.
|
||||
Delete this example once the project has accumulated 2-3 real lessons.
|
||||
-->
|
||||
13
agents-docs/adr/0001-record-architectural-decisions.md
Normal file
13
agents-docs/adr/0001-record-architectural-decisions.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# ADR-0001: Record Architectural Decisions
|
||||
|
||||
## Status
|
||||
Accepted
|
||||
|
||||
## Context
|
||||
We need a lightweight way to record architectural decisions so that future agents and engineers can understand *why* the system looks the way it does, not just *what* it does. Without ADRs, decisions live in PR descriptions, chat logs, or nowhere — and get re-litigated on every refactor.
|
||||
|
||||
## Decision
|
||||
We use Architecture Decision Records (ADRs) in the Nygard short form. Each ADR lives at `agents-docs/adr/NNNN-slug.md` with a 4-digit zero-padded number, monotonically increasing. The minimum content is a title plus 1–3 sentences each for Context, Decision, and Rationale. Add `Status`, `Considered Options`, or `Consequences` only when they genuinely help.
|
||||
|
||||
## Rationale
|
||||
Nygard short form is the lowest-friction format that still captures the *why*. Heavier templates (MADR, full IEEE 1471) routinely don't get written — the bar to start one is too high. ADRs are append-only: a superseded decision gets a new ADR with a `Supersedes ADR-NNNN` note while the old one stays in place. The 3-criteria gate (hard to reverse, surprising without context, genuine trade-offs) keeps the directory from filling with trivia. See `agents-docs/AGENTS_ADRS.md` for the full contract.
|
||||
64
agents-docs/features/custom-emoji.md
Normal file
64
agents-docs/features/custom-emoji.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Custom Emoji
|
||||
|
||||
> **Area:** custom-emoji
|
||||
> **Status:** Active
|
||||
> **Last updated:** 2026-06-05
|
||||
|
||||
## Overview
|
||||
|
||||
Custom emoji lets users upload small image emoji, use them in chat messages and reactions, and sync emoji assets needed for rendering to connected peers over the existing data-channel mesh.
|
||||
|
||||
## Responsibilities
|
||||
|
||||
- Own custom emoji asset validation, local persistence, user-saved library membership, shortcut ranking, and peer-to-peer asset sync.
|
||||
- Expose a shared picker consumed by chat message reactions and the chat composer.
|
||||
- Keep usage ranking local to the current user; usage counts are not synced.
|
||||
- Does not store custom emoji on the signaling server.
|
||||
|
||||
## Key Concepts
|
||||
|
||||
- **Custom emoji asset**: A user-created image stored as a data URL with id, name, mime, size, hash, creator, timestamps, and optional saved-library membership.
|
||||
- **Known custom emoji**: A synced asset available for message rendering and forwarding, but not shown in the current user's picker unless saved.
|
||||
- **Saved custom emoji**: A known asset with `savedByUser` enabled; saved emoji appear in the picker and shortcut ranking.
|
||||
- **Emoji shortcut row**: The seven most-used emoji entries for the current user plus an eighth control that opens the full selector.
|
||||
- **Custom emoji token**: The stable message/reaction representation `:emoji[id](name)`, resolved locally to the synced image asset when rendering.
|
||||
- **Composer emoji alias**: The readable inline draft representation `:name:`. The composer rewrites known aliases to stable custom emoji tokens only when sending.
|
||||
|
||||
## Peer Envelope Contract
|
||||
|
||||
Custom emoji uses `ChatEvent` data-channel envelopes:
|
||||
|
||||
- `custom-emoji-summary`: `{ customEmojiSummaries: [{ id, hash, updatedAt }] }`
|
||||
- `custom-emoji-request`: `{ ids: string[] }`
|
||||
- `custom-emoji-full`: `{ customEmojiTransfer: Omit<CustomEmoji, 'dataUrl'>, total: number }`
|
||||
- `custom-emoji-chunk`: `{ customEmojiId, index, total, data }`
|
||||
|
||||
When a peer connects, each side sends a summary of known assets. The receiver requests missing or stale emoji by id, and the owner replies with a small manifest followed by bounded base64 chunks using buffered peer sends. Creating a new emoji also streams that manifest and chunk sequence to every currently connected peer. Outgoing room chat messages, edits, reactions, and direct messages proactively push every referenced custom emoji asset to connected peers in parallel with the message event, so receivers do not wait for a request round-trip. Small assets that fit under `CUSTOM_EMOJI_INLINE_MAX_JSON_BYTES` travel inline in one `custom-emoji-full` event; larger assets use manifest plus chunks. Incoming chat messages and chat-sync batches still scan for `:emoji[id](name)` tokens and request any missing assets from the sender as a repair path. Full inline `customEmoji` payloads remain accepted for backward compatibility.
|
||||
|
||||
## Business Rules
|
||||
|
||||
- Uploads are capped at 1 MB.
|
||||
- Accepted image types match profile avatars: WebP, GIF, JPG, and JPEG.
|
||||
- Local shortcut ranking is keyed by the active user and includes Unicode emoji plus saved custom emoji only.
|
||||
- Message rendering reserves inline emoji space with a transparent placeholder image while a referenced custom emoji asset is not yet available; deferred markdown placeholders rewrite tokens to readable `:name:` aliases so raw `:emoji[id](name)` text never flashes in chat.
|
||||
- Seen custom emoji are not added to the picker automatically; right-click a rendered custom emoji in chat or on a custom emoji reaction and choose **Add to emoji library** from the app context menu (`NativeContextMenuComponent`).
|
||||
- Saved custom emoji can be removed from the picker library by right-clicking them inside the emoji picker and choosing **Remove from emoji library**; the asset stays available for rendering messages that already reference it.
|
||||
- Emoji hosts are marked with `data-custom-emoji` / `data-custom-emoji-library` plus `data-custom-emoji-id` so the global context menu can distinguish them from regular images and suppress the default **Copy Image** action.
|
||||
- The full emoji picker includes a search field that filters built-in Unicode emoji by common terms and saved custom emoji by name.
|
||||
- Custom emoji data-channel chunks are capped below typical SCTP message limits; back-pressure alone is not enough because a single oversized send can fire `RTCDataChannel.onerror`.
|
||||
- Completed transfers are persisted only when the reconstructed data URL matches the manifest size and hash; corrupt local rows are dropped before summaries are advertised.
|
||||
|
||||
## Data Access
|
||||
|
||||
- Browser runtime stores custom emoji in IndexedDB store `customEmojis`.
|
||||
- Electron runtime stores custom emoji in SQLite table `custom_emojis`, created by migration `1000000000011-AddCustomEmojis`.
|
||||
- Renderer access goes through `DatabaseService` methods `saveCustomEmoji`, `getCustomEmojis`, and `deleteCustomEmoji`.
|
||||
|
||||
## Testing
|
||||
|
||||
- Unit tests cover upload size validation, shortcut selection, picker search filtering, custom emoji token generation, data-channel chunk splitting, readable composer alias rewriting, transfer integrity, saved-library membership, and add/remove library context-menu actions.
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- Emoji payloads are image-only and size-limited before persistence or broadcast.
|
||||
- Assets sync only to already connected peers; the signaling server does not persist or proxy emoji images.
|
||||
183
agents-docs/features/feature-template.md
Normal file
183
agents-docs/features/feature-template.md
Normal file
@@ -0,0 +1,183 @@
|
||||
# [Feature Name]
|
||||
|
||||
> **Area:** [area-name]
|
||||
> **Status:** Active | In Progress | Deprecated
|
||||
> **Last updated:** YYYY-MM-DD
|
||||
|
||||
## Overview
|
||||
|
||||
One paragraph describing what this feature does and why it exists.
|
||||
|
||||
## Responsibilities
|
||||
|
||||
- What this feature is responsible for
|
||||
- Its boundaries — what it does NOT own
|
||||
|
||||
## Key concepts
|
||||
|
||||
- **ConceptA**: short definition
|
||||
- **ConceptB**: short definition
|
||||
|
||||
---
|
||||
|
||||
## API Endpoint
|
||||
|
||||
### Endpoint Details
|
||||
- **Method**: [GET | POST | PUT | PATCH | DELETE]
|
||||
- **Path**: `/api/v1/[feature-path]`
|
||||
- **Authentication**: [Required | Optional | None]
|
||||
- **Rate Limiting**: [Yes — describe | No]
|
||||
|
||||
### Request Schema
|
||||
|
||||
```json
|
||||
{
|
||||
"field": "type — description"
|
||||
}
|
||||
```
|
||||
|
||||
**Required fields:**
|
||||
- `field` (type, constraints): description
|
||||
|
||||
**Optional fields:**
|
||||
- `field` (type): description. Defaults to "X" if not provided.
|
||||
|
||||
### Response Schema
|
||||
|
||||
```json
|
||||
{
|
||||
"field": "type — description"
|
||||
}
|
||||
```
|
||||
|
||||
### Error Responses
|
||||
|
||||
- **400 Bad Request**: [specific causes]
|
||||
- **401 Unauthorized**: missing or invalid authentication
|
||||
- **404 Not Found**: [when this applies]
|
||||
- **500 Internal Server Error**: [specific causes]
|
||||
|
||||
---
|
||||
|
||||
## Business Logic
|
||||
|
||||
### Core Functionality
|
||||
|
||||
1. **Step 1**: description
|
||||
2. **Step 2**: description
|
||||
3. **Step 3**: description
|
||||
|
||||
### Business Rules
|
||||
|
||||
- Rule 1
|
||||
- Rule 2
|
||||
|
||||
### Data Flow
|
||||
|
||||
```
|
||||
Input → Validation → [Processing Steps] → Response
|
||||
```
|
||||
|
||||
### Dependencies
|
||||
|
||||
- **Service/Library**: what it's used for
|
||||
- **External API**: what it's used for
|
||||
- **Database**: what tables/collections are involved
|
||||
|
||||
---
|
||||
|
||||
## Technical Implementation
|
||||
|
||||
### Service Layer
|
||||
|
||||
- **Location**: `path/to/service`
|
||||
- **Key methods**: `methodName()` — description
|
||||
|
||||
### Controller / Handler
|
||||
|
||||
- **Location**: `path/to/handler`
|
||||
- **Responsibilities**: request validation, service invocation, response formatting
|
||||
|
||||
### Repository / Data Access
|
||||
|
||||
- **Location**: `path/to/repository`
|
||||
- **Tables/Collections**: list the relevant database objects
|
||||
- **Migrations**: reference the migration that created/modified the schema
|
||||
|
||||
### Key Types
|
||||
|
||||
- `TypeName`: description of what it represents
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
- `VAR_NAME`: description (required | optional, default: X)
|
||||
|
||||
### Feature Flags
|
||||
|
||||
- [List any feature flags, or "None"]
|
||||
|
||||
---
|
||||
|
||||
## Testing
|
||||
|
||||
### Unit Tests
|
||||
|
||||
- **Location**: `path/to/tests`
|
||||
- **Key scenarios**: list the most important test cases
|
||||
|
||||
### Integration Tests
|
||||
|
||||
- **Location**: `path/to/integration/tests`
|
||||
- **Setup**: describe any required infrastructure (database, external services, etc.)
|
||||
- **Mocking**: what external services are mocked and how
|
||||
|
||||
---
|
||||
|
||||
## Error Handling & Edge Cases
|
||||
|
||||
### Common Errors
|
||||
|
||||
- **Error scenario**: how it's handled
|
||||
|
||||
### Edge Cases
|
||||
|
||||
- **Edge case**: expected behavior
|
||||
|
||||
---
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- Authentication requirements
|
||||
- Authorization / access control
|
||||
- Input validation and sanitization
|
||||
- Data privacy considerations
|
||||
|
||||
---
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
- Expected response times
|
||||
- Known bottlenecks
|
||||
- Caching strategy (if any)
|
||||
|
||||
---
|
||||
|
||||
## Known Issues and Limitations
|
||||
|
||||
1. **Limitation**: description
|
||||
|
||||
---
|
||||
|
||||
## Related Features
|
||||
|
||||
- **[Related Feature]**: brief description of relationship
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Change |
|
||||
|------|--------|
|
||||
| YYYY-MM-DD | Initial documentation |
|
||||
228
agents-docs/features/mobile-capacitor.md
Normal file
228
agents-docs/features/mobile-capacitor.md
Normal file
@@ -0,0 +1,228 @@
|
||||
# Mobile Capacitor
|
||||
|
||||
Cross-context mobile shell for the Angular product client (`toju-app/`). Wraps the existing SPA in Ionic Capacitor native projects (`toju-app/android/`, `toju-app/ios/`) while keeping Capacitor APIs behind `toju-app/src/app/infrastructure/mobile/`.
|
||||
|
||||
## Responsibilities
|
||||
|
||||
- Detect runtime shell (`browser`, `capacitor`, `electron`) without importing native plugins in domain code.
|
||||
- Expose facades for notifications, in-call controls, media/attachments, stream pop-out, background audio session, CallKit, and native persistence.
|
||||
- Integrate with direct-call, voice-workspace, and chat composer flows.
|
||||
|
||||
## Boundaries
|
||||
|
||||
| Layer | Owns |
|
||||
|-------|------|
|
||||
| `infrastructure/mobile/` | Platform detection, plugin lazy-loading, web/Capacitor adapters |
|
||||
| `infrastructure/persistence/` | `DatabaseService` routing (`browser` / `capacitor-sqlite` / `electron`) |
|
||||
| Domains (`direct-call`, `chat`, `voice-session`) | Business orchestration; inject mobile facades only |
|
||||
| `core/platform/PlatformService` | Adds `isCapacitor` flag for persistence routing |
|
||||
| Capacitor native projects | OS permissions, push certificates, store packaging |
|
||||
|
||||
## Build & run
|
||||
|
||||
```bash
|
||||
# Production web bundle (Capacitor webDir)
|
||||
npm run build:prod
|
||||
|
||||
# Copy web assets into native projects
|
||||
npm run cap:sync
|
||||
|
||||
# Open IDE
|
||||
npm run cap:open:android
|
||||
npm run cap:open:ios
|
||||
|
||||
### Linux: Android Studio path
|
||||
|
||||
Capacitor defaults to `/usr/local/android-studio/bin/studio.sh`. If Android Studio is installed elsewhere (common with **Flatpak** from Flathub), `npm run cap:open:android` uses `tools/resolve-android-studio-path.js` to locate `studio.sh` (Flatpak `active` symlink, Toolbox, snap, `/opt`, etc.). Override anytime with `CAPACITOR_ANDROID_STUDIO_PATH`.
|
||||
|
||||
# Convenience (build + sync + open)
|
||||
npm run cap:build:android
|
||||
npm run cap:build:ios
|
||||
|
||||
# CI / Linux: production web bundle + Capacitor sync + Gradle debug APK
|
||||
npm run cap:apk:android
|
||||
# → toju-app/android/app/build/outputs/apk/debug/app-debug.apk
|
||||
```
|
||||
|
||||
Config: `toju-app/capacitor.config.ts` (`webDir: ../dist/client/browser`).
|
||||
|
||||
### CI (Gitea)
|
||||
|
||||
Workflow `.gitea/workflows/build-android-apk.yml` runs automatically on push to `main` / `master` when mobile client paths change (`toju-app/**`, root lockfile, or the workflow itself). Use **workflow_dispatch** to build on demand from any branch.
|
||||
|
||||
The job installs JDK 21 and Android SDK platform 36 inside the `node:22` container, runs `tools/build-android-apk.sh`, and uploads `metoyou-android-debug-apk` (`app-debug.apk`) as a workflow artifact. No signing keystore is configured — output is a **debug** APK suitable for sideloading and QA.
|
||||
|
||||
Optional `google-services.json` is not injected in CI; push registration in artifact builds follows the same optional-Firebase behavior as local unsigned debug builds.
|
||||
|
||||
After dependency or plugin changes, run `npm run build:prod && npm run cap:sync` so native projects register `@capacitor/app`, `@capacitor-community/sqlite`, push plugins, and `MetoyouMobile`.
|
||||
|
||||
## Feature status
|
||||
|
||||
| Feature | Status | Notes |
|
||||
|---------|--------|-------|
|
||||
| Push/local notifications | **Working (partial)** | Local notifications always available; remote push (FCM/APNs) registers only when Firebase/APNs is configured — app starts normally without `google-services.json` |
|
||||
| Server push dispatch | **Working (configured)** | Tokens persist in server SQLite; outbound FCM/APNs via env credentials |
|
||||
| In-call notifications | **Working (Capacitor)** | Persistent notification with answer/mute/hang-up actions |
|
||||
| Stream pop-out (PiP) | **Working (partial)** | Document PiP when WebView supports it; Android native PiP fallback via `MetoyouMobile` plugin |
|
||||
| Background voice | **Working (partial)** | Android foreground service; iOS `UIBackgroundModes` audio + CallKit active-call bridge |
|
||||
| iOS CallKit | **Working (partial)** | `MetoyouMobile.startCallKitSession` reports active calls; requires Xcode target wiring after `cap:sync` |
|
||||
| Screensharing | **Limited** | Disabled on iOS WebView; Android `getDisplayMedia` may work |
|
||||
| Composer attachments | **Working** | Mobile attachment button + hidden file input |
|
||||
| Camera sharing | **Working** | Existing `getUserMedia` camera path in WebRTC stack |
|
||||
| Speakerphone | **Working (partial)** | Android `AudioManager` via `MetoyouMobile`; iOS `@capgo/capacitor-audio-session`; direct-call speaker toggle on native mobile |
|
||||
| Local DB (SQLite) | **Working** | `DatabaseService` routes Capacitor shells to `CapacitorDatabaseService` (native SQLite CRUD) |
|
||||
|
||||
## Platform limitations
|
||||
|
||||
- **iOS background WebRTC:** OS may still suspend peer connections when backgrounded despite `audio` background mode and CallKit reporting.
|
||||
- **iOS CallKit:** Plugin Swift source ships in `ios/App/App/MetoyouMobilePlugin.swift`; add it to the Xcode target if not auto-linked. Incoming-call UI is not fully bridged to WebRTC answer/hang-up yet.
|
||||
- **iOS screenshare:** `getDisplayMedia` is not available in WKWebView.
|
||||
- **Android PiP:** Native PiP enters activity-level PiP; WebView video may not always render inside PiP on all OEM WebViews.
|
||||
- **Production discovery:** `signal.toju.app` may not expose `/api/servers/featured` or `/trending`; client skips those calls for known hosts.
|
||||
- **Push delivery:** Requires FCM service account and APNs key configuration on the signaling server.
|
||||
|
||||
## Push notification setup (FCM / APNs)
|
||||
|
||||
### Android (FCM)
|
||||
|
||||
The app starts without Firebase. `MobilePushRegistrationService` probes `MetoyouMobile.isRemotePushConfigured()` (Firebase `FirebaseApp` on Android) before calling `PushNotifications.register()`; when unconfigured it logs a single warning and skips registration.
|
||||
|
||||
1. Create a Firebase project and add an Android app with package `com.metoyou.app`.
|
||||
2. Copy `toju-app/android/app/google-services.json.example` to `google-services.json` (gitignored) and fill in your Firebase values.
|
||||
3. Run `npm run cap:sync` so the Google Services Gradle plugin applies when the file is present (`build.gradle` applies it only when the JSON exists).
|
||||
4. Rebuild with `npm run cap:build:android`.
|
||||
5. Ensure `POST_NOTIFICATIONS`, `RECORD_AUDIO`, and foreground-service permissions are granted on Android 13+.
|
||||
6. Verify `MobilePushRegistrationService` logs a registration token after login.
|
||||
|
||||
### iOS (APNs)
|
||||
|
||||
1. Enable Push Notifications capability in Xcode for the `App` target.
|
||||
2. Upload your APNs key/certificate in Apple Developer portal.
|
||||
3. `Info.plist` includes `remote-notification`, `audio`, and `voip` background modes.
|
||||
4. Run on a physical device; simulator push registration is limited.
|
||||
|
||||
### Server token storage & dispatch
|
||||
|
||||
Clients POST:
|
||||
|
||||
```http
|
||||
POST /api/users/device-tokens
|
||||
Content-Type: application/json
|
||||
|
||||
{ "userId": "<uuid>", "platform": "android|ios", "token": "<fcm-or-apns-token>" }
|
||||
```
|
||||
|
||||
Tokens persist in server SQLite (`device_tokens` table). Outbound push uses repository-root `.env` credentials:
|
||||
|
||||
| Variable | Purpose |
|
||||
|----------|---------|
|
||||
| `FCM_SERVICE_ACCOUNT_PATH` or `FCM_SERVICE_ACCOUNT_JSON` | Android FCM HTTP v1 |
|
||||
| `APNS_KEY_PATH`, `APNS_KEY_ID`, `APNS_TEAM_ID` | iOS APNs HTTP/2 |
|
||||
| `APNS_BUNDLE_ID` | Defaults to `com.metoyou.app` |
|
||||
| `APNS_USE_SANDBOX` | `true` for development builds |
|
||||
|
||||
Manual dispatch (ops/testing):
|
||||
|
||||
```http
|
||||
POST /api/users/device-tokens/:userId/dispatch
|
||||
{ "title": "Incoming call", "body": "Alice is calling" }
|
||||
```
|
||||
|
||||
## Android foreground service
|
||||
|
||||
`VoiceCallForegroundService` starts when `MobileCallSessionService` begins an active call. Required manifest permissions:
|
||||
|
||||
- `FOREGROUND_SERVICE`
|
||||
- `FOREGROUND_SERVICE_MICROPHONE`
|
||||
- `RECORD_AUDIO`
|
||||
- `POST_NOTIFICATIONS`
|
||||
|
||||
The service shows a low-importance ongoing notification while a call is active.
|
||||
|
||||
## SQLite persistence (Capacitor)
|
||||
|
||||
- Schema rules: `infrastructure/mobile/logic/mobile-sqlite-schema.rules.ts` (mirrors Electron entities).
|
||||
- Statement execution: `infrastructure/mobile/logic/mobile-sqlite-execute.rules.ts` — `@capacitor-community/sqlite` `execute()` accepts **one** SQL statement per call; migrations run each DDL statement separately (never concatenated).
|
||||
- Row mapping: `infrastructure/mobile/logic/mobile-sqlite-row-mapper.rules.ts`.
|
||||
- CRUD service: `infrastructure/persistence/capacitor-database.service.ts`.
|
||||
- Routing: `infrastructure/persistence/database-backend.rules.ts` — Capacitor uses SQLite, not IndexedDB.
|
||||
- Per-user database files: `metoyou__<userId>` via `mobile-sqlite-database-name.rules.ts`.
|
||||
- First launch runs DDL migrations stored in the `meta` table. Schema init failures are cached per database file so the client does not retry in a loop.
|
||||
|
||||
## Capacitor plugin loading
|
||||
|
||||
- `infrastructure/mobile/adapters/capacitor/capacitor-plugin-loader.ts` uses **static** `@capacitor/*` imports and `Capacitor.isPluginAvailable()` before returning a plugin. Do not `import()` plugin modules dynamically or `await` plugin objects (Capacitor proxies expose a throwing `.then()` stub).
|
||||
- After adding or upgrading Capacitor plugins, run `npm run build:prod && npm run cap:sync` so Android/iOS native projects register `App`, `LocalNotifications`, push, and SQLite.
|
||||
|
||||
## Safe area (Android)
|
||||
|
||||
- Capacitor `SystemBars` injects `--safe-area-inset-*` CSS variables into `document.documentElement`. `index.html` sets `viewport-fit=cover` and default inset values; `main.ts` calls `applyMobileSafeAreaDefaults()` so injection never hits a missing root element after the WebView loads.
|
||||
- `capacitor.config.ts` sets `plugins.SystemBars.insetsHandling: 'css'` so Android WebView versions that mis-report `env(safe-area-inset-*)` still receive correct insets.
|
||||
- Global `styles.scss` applies inset padding on `html` (with `env()` fallback) and sizes `app-root` to `height: 100%` so content stays below the status bar and above the navigation bar in edge-to-edge mode.
|
||||
|
||||
## Self-hosted HTTPS signal servers (Android)
|
||||
|
||||
Electron and desktop browsers accept the repo's self-signed `.certs/localhost.crt` because Electron runs with `ignore-certificate-errors` when `SSL=true`, and browsers let users bypass the warning once. **Android WebView does neither** — it only trusts system CAs (release) or system + user-installed CAs (debug builds).
|
||||
|
||||
| Runtime | Trust behavior |
|
||||
|---------|----------------|
|
||||
| Electron (`SSL=true`) | Ignores certificate errors (`electron/app/flags.ts`) |
|
||||
| Browser | User accepts warning or imports CA |
|
||||
| Android debug APK | System CAs + **user-installed CAs** (`src/debug/res/xml/network_security_config.xml`) |
|
||||
| Android release APK | **System CAs only** — use Let's Encrypt or another public CA |
|
||||
|
||||
### Certificate requirements
|
||||
|
||||
1. **Trust:** Install `.certs/localhost.crt` on the Android device as a **CA certificate** (Settings → Security → Encryption & credentials → Install a certificate → CA certificate). Debug APKs pick this up automatically; release builds ignore user CAs.
|
||||
2. **SAN:** The cert must list every host clients use. Regenerate with the server IP in the SAN when connecting by IP:
|
||||
|
||||
```bash
|
||||
rm -rf .certs
|
||||
SERVER_IP=46.59.68.77 ./generate-cert.sh
|
||||
```
|
||||
|
||||
Restart the signaling server after regenerating certs.
|
||||
|
||||
3. **HTTPS only:** `AndroidManifest.xml` sets `android:usesCleartextTraffic="false"`. Server URLs must use `https://` (matching `environment.ts` / saved server endpoints).
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
| Symptom | Likely cause |
|
||||
|---------|----------------|
|
||||
| `ERR_CERT_AUTHORITY_INVALID` / silent fetch failure | CA not installed on device, or testing a **release** APK with a self-signed cert |
|
||||
| `ERR_CERT_COMMON_NAME_INVALID` | Cert SAN missing the IP/hostname (regenerate with `SERVER_IP`) |
|
||||
| `ERR_CONNECTION_REFUSED` | Port unreachable from the phone (firewall, NAT, server not listening on `0.0.0.0`) — verify with `curl -k https://46.59.68.77:3001/api/health` from the device browser first |
|
||||
| Works in Chrome on phone, fails in app | Chrome may use a different trust store path; ensure the CA is installed at the **system** level, not only per-browser |
|
||||
|
||||
Network security configs:
|
||||
|
||||
- `android/app/src/main/res/xml/network_security_config.xml` — release (system CAs, no cleartext)
|
||||
- `android/app/src/debug/res/xml/network_security_config.xml` — debug (+ user CAs for dev)
|
||||
|
||||
**Do not commit** `.certs/*.crt`, `.certs/*.key`, or device-specific credential files.
|
||||
|
||||
## Integration points
|
||||
|
||||
- `DirectCallService` — incoming/active call notifications, ring-queue on user hydration, notification action routing.
|
||||
- `PrivateCallComponent` — speakerphone toggle on native mobile shells.
|
||||
- `ChatMessageComposerComponent` — `shouldShowAttachmentButton` + `pickAttachmentsFromDevice()`.
|
||||
- `VoiceWorkspaceStreamTileComponent` — PiP when focused stream tile backgrounds.
|
||||
- `MobileCallSessionService` — CallKit + foreground service + in-call notifications.
|
||||
- `App` bootstrap — initializes mobile persistence, lifecycle, call-session, and push registration wiring.
|
||||
|
||||
## Phase 3 completion notes
|
||||
|
||||
Phase 3 delivered:
|
||||
|
||||
1. Full `CapacitorDatabaseService` CRUD with `DatabaseService` routing on `isCapacitor`.
|
||||
2. Server SQLite persistence for device tokens plus FCM/APNs outbound dispatch.
|
||||
3. iOS CallKit bridge (partial) via `MetoyouMobile` plugin and `MobileCallKitService`.
|
||||
4. Android Firebase Gradle wiring with `google-services.json.example` (real file gitignored).
|
||||
5. Capacitor plugin availability checks to avoid hard failures when plugins are missing pre-sync.
|
||||
6. Discovery endpoint skip for production signal hosts without featured/trending routes.
|
||||
|
||||
Remaining work:
|
||||
|
||||
- Wire CallKit answer/end actions back into `DirectCallService`.
|
||||
- Migrate legacy IndexedDB mobile data into SQLite where needed.
|
||||
- Deploy featured/trending routes to production signal servers or add capability negotiation in health checks.
|
||||
79
agents-docs/features/server-discovery.md
Normal file
79
agents-docs/features/server-discovery.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# Server Discovery
|
||||
|
||||
> **Area:** server-directory
|
||||
> **Status:** Active
|
||||
> **Last updated:** 2025-02-14
|
||||
|
||||
## Overview
|
||||
|
||||
Server discovery lets a signed-in user find public servers to join without knowing an exact name. It spans the signaling **server** (REST routes + CQRS query handlers that rank public servers) and the product **client** (`server-directory` domain API/facade plus the `/dashboard` landing and `/servers` browse page). It complements the existing free-text `GET /api/servers` search with two curated lists — **featured** and **trending**.
|
||||
|
||||
## Responsibilities
|
||||
|
||||
- Server: rank and return public servers as **featured** (most-populated) and **trending** (most-recently-active) lists, capped per request.
|
||||
- Client: fetch those lists through `ServerDirectoryFacade` and render them via the reusable `app-server-browser` component on `/servers` and `/dashboard`.
|
||||
- It does NOT own: free-text search (`GET /api/servers`), join/access checks (`/api/servers/:id/join`), invites, or room signal-affinity. Discovery is read-only browsing; joining flows through existing paths.
|
||||
|
||||
## Key concepts
|
||||
|
||||
- **Featured**: public servers ranked by membership count descending, ties broken by most recent `lastSeen` (`rankFeaturedServers`).
|
||||
- **Trending**: public servers ranked by most recent `lastSeen` descending, ties broken by membership count (`rankTrendingServers`).
|
||||
- **Discovery limit**: each route clamps `limit` to `[1, 50]` (`parseDiscoveryLimit`), default `12`.
|
||||
|
||||
---
|
||||
|
||||
## API Endpoints
|
||||
|
||||
Both endpoints live in `server/src/routes/servers.ts` and **must be registered before** the parameterised `/:id` route, otherwise Express resolves `featured`/`trending` as a server id.
|
||||
|
||||
### `GET /api/servers/featured`
|
||||
|
||||
- **Method**: GET
|
||||
- **Authentication**: None (public discovery)
|
||||
- **Rate Limiting**: No
|
||||
- **Query params**: `limit` (optional integer; clamped to `[1, 50]`, default `12`)
|
||||
|
||||
### `GET /api/servers/trending`
|
||||
|
||||
- **Method**: GET
|
||||
- **Authentication**: None (public discovery)
|
||||
- **Rate Limiting**: No
|
||||
- **Query params**: `limit` (optional integer; clamped to `[1, 50]`, default `12`)
|
||||
|
||||
### Response Schema (both)
|
||||
|
||||
```json
|
||||
{
|
||||
"servers": "ServerInfo[] — enriched public servers (icon, channels, sourceId/sourceName/sourceUrl filled by the client API layer)",
|
||||
"total": "number — count of servers returned",
|
||||
"limit": "number — the effective clamped limit"
|
||||
}
|
||||
```
|
||||
|
||||
`ServerInfo` matches the shape returned by `GET /api/servers` search results, so the client normalises and renders all three lists identically.
|
||||
|
||||
### Error Responses
|
||||
|
||||
- **500 Internal Server Error**: query handler / persistence failure.
|
||||
|
||||
---
|
||||
|
||||
## Server internals
|
||||
|
||||
- Routes delegate to CQRS query handlers `handleGetFeaturedServers` / `handleGetTrendingServers` (`server/src/cqrs/queries/handlers/`), dispatched via `GetFeaturedServers` / `GetTrendingServers` query types.
|
||||
- Ranking lives in `server/src/cqrs/queries/handlers/server-ranking.util.ts` (`rankFeaturedServers`, `rankTrendingServers`, `loadMembershipCounts`). Membership counts load in a single grouped query.
|
||||
- Results pass through the same `enrichServer()` step as search before serialisation.
|
||||
|
||||
## Client internals
|
||||
|
||||
- `ServerDirectoryApiService.getFeaturedServers()` / `getTrendingServers()` call the routes through a shared private `getDiscoveryServers(path)` helper and normalise into `ServerInfo[]`.
|
||||
- `ServerDirectoryService` → `ServerDirectoryFacade` expose `getFeaturedServers()` / `getTrendingServers()` as the domain boundary.
|
||||
- `FindServersComponent` (`/servers`) composes **Recently active** (the user's saved rooms, capped at 6), **Featured**, and **Trending** sections, all rendered through `app-server-browser` with `[showMyServers]="true"`.
|
||||
- `DashboardComponent` (`/dashboard`) is a single-column landing page (max-width centered, no in-page sidebars): a header greeting (no emoji), a global search with `Ctrl+K` focus and localStorage-backed **Recent Searches** chips shown beneath it, three primary action cards (Find People → `/people`, Find Servers → `/servers`, Create Server → `/create-server` — one link each), and discovery panels **People you might know**, **Popular Servers**, **Your Friends**, and **Recently Active Servers**. Each list is capped at 5 (`DISCOVERY_LIMIT`). It loads `popularServers` on init from `getFeaturedServers(5)`, falling back to `getTrendingServers(5)` when featured is empty; reuses `app-friend-button` for Add and `app-user-avatar` for people rows. `peopleYouMightKnow` excludes existing friends (via `FriendService.friendIds()`); `friends` lists discovered people who are friends. "See all" header links route to the matching `/people` or `/servers` page (no duplicated footer links). Recent searches are recorded on Enter (deduped, most-recent-first, capped at 8) and persisted under `metoyou_dashboard_recent_searches`.
|
||||
- The servers-rail top button (`servers-rail.component`) is the **Dashboard** button (`lucideLayoutDashboard`, `title="Dashboard"`); its `goToDashboard()` handler deselects any active voice server and navigates to `/dashboard`. A **Create a server** button (`lucidePlus`, `data-testid="server-rail-create"`) sits below the saved-server icons and opens `app-create-server-dialog` (a Toju modal on desktop / bottom sheet on mobile) which dispatches `RoomsActions.createRoom` directly; the dashboard / `/create-server` route remains as an alternative entry point. Rail icons (`h-12 w-12`, `md:h-11 w-11`) animate their corner radius on hover and `:active` for a Discord-style squircle effect.
|
||||
- On mobile (`ViewportService.isMobile()`), `DashboardComponent`, `FindPeopleComponent` (`/people`), and `FindServersComponent` (`/servers`) each mount their page body inside a single `<swiper-container>` slide next to `app-servers-rail` (rail `shrink-0`, content `flex-1` with a left border), mirroring the chat-room / DM-workspace mobile layout so the primary navigation rail stays reachable. The page body is shared between the desktop and mobile branches via an `<ng-template #pageContent>` + `[ngTemplateOutlet]`, and each component declares `schemas: [CUSTOM_ELEMENTS_SCHEMA]` for the Swiper custom elements.
|
||||
|
||||
## Related
|
||||
|
||||
- Product-client domain README: `toju-app/src/app/domains/server-directory/README.md`
|
||||
- People discovery (`/people`): `toju-app/src/app/domains/direct-message/README.md`
|
||||
22
agents-docs/features/signal-server-tag.md
Normal file
22
agents-docs/features/signal-server-tag.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Signal Server Tag
|
||||
|
||||
Users registered on a signal server can show that server's display tag on their profile card (opened by clicking their name or avatar).
|
||||
|
||||
## Server configuration
|
||||
|
||||
`server/data/variables.json` accepts an optional `serverTag` string. When omitted, the server falls back to its public URL built from `serverProtocol`, `serverHost`, and `serverPort`.
|
||||
|
||||
## Health API
|
||||
|
||||
`GET /api/health` includes `serverTag` so clients can cache the display label per configured endpoint.
|
||||
|
||||
## WebSocket presence
|
||||
|
||||
The client sends `homeSignalServerUrl` in `identify` messages. The signaling server echoes that value in `server_users` and `user_joined` payloads so other clients can resolve the correct tag.
|
||||
|
||||
## Client behavior
|
||||
|
||||
- Login and registration store `homeSignalServerUrl` on the current user.
|
||||
- Profile cards show the resolved tag beside the username in muted text.
|
||||
- Configured labels render as `#tag`; URL fallbacks render as a globe icon with the URL in a tooltip.
|
||||
- Tag resolution prefers the endpoint's cached `serverTag` from health checks, then falls back to the stored home URL.
|
||||
44
docs-site/CONTEXT.md
Normal file
44
docs-site/CONTEXT.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Application Documentation (docs-site)
|
||||
|
||||
Owns the Docusaurus-based application and plugin-author documentation. The build output (`docs-site/build/`) is bundled into the Electron app and served by the Local API server at runtime, so documentation is available offline inside the desktop client.
|
||||
|
||||
> **Format reference:**
|
||||
> - **Vocabulary** — bold term, one-sentence definition, aliases to avoid.
|
||||
> - **Relationships** — bullets with bold terms and cardinality.
|
||||
> - **Boundaries / IO** — what this subdomain exposes and consumes.
|
||||
> - **Invariants** — rules that always hold.
|
||||
> - **Flagged ambiguities** — terms in dispute with proposed resolutions.
|
||||
>
|
||||
> See `agents-docs/AGENTS_CONTEXT.md` for the contract. Update in the same turn a trigger fires (see `agents-docs/AGENT_WORKFLOW.md` § CONTEXT.md upkeep).
|
||||
|
||||
## Vocabulary
|
||||
|
||||
| Term | Definition | Aliases to avoid |
|
||||
|------|------------|------------------|
|
||||
| **App docs** | End-user-facing documentation for the MetoYou desktop client. | "manual" |
|
||||
| **Plugin docs** | Developer-facing reference for the plugin runtime — manifest format, lifecycle hooks, host APIs. Authoritative source for the plugin contract surface. | "API docs" |
|
||||
| **Local API server** | The Electron in-process HTTP server that mounts `docs-site/build/` so the renderer can browse docs offline. Defined under `electron/api/`. | "embedded server" |
|
||||
|
||||
## Relationships
|
||||
|
||||
- **Plugin docs** describe contracts implemented in `toju-app/src/app/shared-kernel/plugin-system.contracts.ts` (renderer side) and `electron/plugin-library.ts` (host side) — keep them in lockstep with code changes.
|
||||
- The **build output** at `docs-site/build/` is a deploy artifact for the **electron** Local API server; `npm run build:all` requires `npm run build:docs` to have run.
|
||||
- The site is also deployed publicly via `.gitea/workflows/deploy-web-apps.yml` for browsing outside the app.
|
||||
|
||||
## Boundaries / IO
|
||||
|
||||
- **Exposes:** static Docusaurus bundle at `docs-site/build/`, mounted by Electron's Local API server and also deployed as a public static site.
|
||||
- **Consumes:** Markdown sources under `docs-site/docs/`, plus any code-derived references (e.g. OpenAPI documents from `electron/api/openapi.ts`).
|
||||
|
||||
## Invariants
|
||||
|
||||
- Plugin-contract documentation must match the code; if the manifest schema or lifecycle changes, **plugin docs** and `agents-docs/features/<plugin-doc>.md` both update in the same task.
|
||||
- Build artifacts (`docs-site/build/`) are generated, not committed.
|
||||
|
||||
## Flagged ambiguities
|
||||
|
||||
- _None recorded yet._
|
||||
|
||||
---
|
||||
|
||||
*Agent-procedural rules (TDD, lint, build) live in `/AGENTS.md`. This file is the bounded-context domain artefact for the documentation site.*
|
||||
@@ -19,11 +19,11 @@ Capabilities protect privileged app surfaces. A plugin must declare a capability
|
||||
| `messages.editOwn` | `messages.edit()` | Edits plugin-owned messages. |
|
||||
| `messages.deleteOwn` | `messages.delete()` | Deletes plugin-owned messages. |
|
||||
| `messages.moderate` | `messages.moderateDelete()` | Moderation delete path. |
|
||||
| `messages.sync` | `messages.sync()` | Syncs message arrays into client state. |
|
||||
| `messages.sync` | `messages.sync()`, `messages.import()`, `attachments.import()` | Syncs message arrays, imports historical messages locally, or imports files for those messages. |
|
||||
| `channels.read` | `channels.list()`, `channels.select()` | Reads and selects channels. |
|
||||
| `channels.manage` | `channels.addAudioChannel()`, `channels.addVideoChannel()`, `channels.remove()`, `channels.rename()` | Mutates channel or channel-section state. |
|
||||
| `channels.manage` | `channels.addTextChannel()`, `channels.addAudioChannel()`, `channels.addVideoChannel()`, `channels.remove()`, `channels.rename()` | Mutates channel or channel-section state. |
|
||||
| `server.read` | `server.getCurrent()` | Reads active server. |
|
||||
| `server.manage` | `server.updatePermissions()`, `server.updateSettings()` | Updates server permissions or settings. |
|
||||
| `server.manage` | `server.updateIcon()`, `server.updatePermissions()`, `server.updateSettings()` | Updates server icon, permissions, or settings. `server.updateIcon()` resolves when the local icon update has been persisted or rejects if the current user is not allowed to manage the server icon. |
|
||||
| `p2p.data` | `p2p.connectedPeers()`, `p2p.broadcastData()`, `p2p.sendData()` | Uses plugin peer data paths. |
|
||||
| `p2p.media` | Reserved peer media features. | Included for media-facing plugins. |
|
||||
| `media.playAudio` | `media.playAudioClip()` | Plays an audio URL locally. |
|
||||
|
||||
50
e2e/CONTEXT.md
Normal file
50
e2e/CONTEXT.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# End-to-End Suite (e2e)
|
||||
|
||||
Owns Playwright-based end-to-end verification of the desktop product. Tests boot the real Electron application against the real signaling server and exercise user-visible flows across chat, voice, screen-share, settings, plugins, and auth.
|
||||
|
||||
> **Format reference:**
|
||||
> - **Vocabulary** — bold term, one-sentence definition, aliases to avoid.
|
||||
> - **Relationships** — bullets with bold terms and cardinality.
|
||||
> - **Boundaries / IO** — what this subdomain exposes and consumes.
|
||||
> - **Invariants** — rules that always hold.
|
||||
> - **Flagged ambiguities** — terms in dispute with proposed resolutions.
|
||||
>
|
||||
> See `agents-docs/AGENTS_CONTEXT.md` for the contract. Update in the same turn a trigger fires (see `agents-docs/AGENT_WORKFLOW.md` § CONTEXT.md upkeep).
|
||||
|
||||
## Vocabulary
|
||||
|
||||
| Term | Definition | Aliases to avoid |
|
||||
|------|------------|------------------|
|
||||
| **Feature area** | A top-level folder under `tests/` (`auth/`, `chat/`, `voice/`, `screen-share/`, `settings/`, `plugins/`) corresponding to a slice of user-visible behavior. | "category", "section" |
|
||||
| **Page object** | A test-side abstraction over a screen or panel that exposes user-intent methods rather than raw selectors. | "page model" |
|
||||
| **Fixture** | A Playwright `test.extend(...)` setup that prepares one or more user/app instances before a test runs. | "helper" |
|
||||
| **Pair test** | An E2E test that boots two Electron instances simultaneously to verify P2P flows (calls, screen-share, transfers). | "multi-client test" |
|
||||
|
||||
## Relationships
|
||||
|
||||
- A **Feature area** owns one or more `*.spec.ts` files plus its own **Page objects** and **Fixtures**.
|
||||
- A **Pair test** depends on the **server** subdomain being reachable — both clients connect to the same signaling server.
|
||||
- **Page objects** depend only on the rendered DOM produced by **toju-app**; if a selector changes, only the page object should need updating.
|
||||
- The suite as a whole depends on **electron** (built via `npm run build:electron`) and a usable **server** (`npm run server:dev` or `npm run dev`).
|
||||
|
||||
## Boundaries / IO
|
||||
|
||||
- **Exposes:** test results (HTML report at `test-results/html-report`, JUnit/JSON output on CI). No production surface.
|
||||
- **Consumes:**
|
||||
- The built product (toju-app + electron) — typically launched via Playwright's Electron support.
|
||||
- The signaling server (started before the suite runs).
|
||||
- System resources: audio devices for voice tests, screen-capture for screen-share tests. The `.agents/skills/playwright-e2e/SKILL.md` documents how the suite handles the multi-client setup.
|
||||
|
||||
## Invariants
|
||||
|
||||
- Tests interact only through **Page objects** and **Fixtures** — no raw `page.click('.css-class-name')` scattered across specs.
|
||||
- Tests must clean up state between runs — a flaky run that leaves cruft in the local database or signaling server is a bug, not an environment issue.
|
||||
- The suite must run headless on CI (`npm run test:e2e`); the `ui` and `debug` variants exist for local development only.
|
||||
|
||||
## Flagged ambiguities
|
||||
|
||||
- _None recorded yet — add entries when a test concept (e.g. "pair test" vs "multi-client test") resists clean definition._
|
||||
|
||||
---
|
||||
|
||||
*Agent-procedural rules (TDD, lint) live in `/AGENTS.md`. Practical patterns for writing Playwright tests on this project live in `.agents/skills/playwright-e2e/SKILL.md`. This file is the bounded-context domain artefact for the E2E suite.*
|
||||
@@ -7,72 +7,71 @@ import {
|
||||
export class ServerSearchPage {
|
||||
readonly searchInput: Locator;
|
||||
readonly createServerButton: Locator;
|
||||
readonly railCreateServerButton: Locator;
|
||||
readonly searchCreateServerButton: Locator;
|
||||
readonly railDashboardButton: Locator;
|
||||
readonly settingsButton: Locator;
|
||||
|
||||
// Create server dialog
|
||||
// Create server page
|
||||
readonly serverNameInput: Locator;
|
||||
readonly serverDescriptionInput: Locator;
|
||||
readonly serverTopicInput: Locator;
|
||||
readonly signalEndpointSelect: Locator;
|
||||
readonly advancedSettingsToggle: Locator;
|
||||
readonly privateCheckbox: Locator;
|
||||
readonly serverPasswordInput: Locator;
|
||||
readonly dialogCreateButton: Locator;
|
||||
readonly dialogCancelButton: Locator;
|
||||
readonly createSubmitButton: Locator;
|
||||
readonly cancelButton: Locator;
|
||||
|
||||
constructor(private page: Page) {
|
||||
this.searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
this.railCreateServerButton = page.locator('button[title="Create Server"]');
|
||||
this.searchCreateServerButton = page.getByRole('button', { name: 'Create New Server' });
|
||||
this.createServerButton = this.searchCreateServerButton;
|
||||
// Server discovery lives on /servers via <app-server-browser>.
|
||||
this.searchInput = page.getByPlaceholder('Search servers...');
|
||||
this.railDashboardButton = page.locator('button[title="Dashboard"]');
|
||||
// Dashboard "Create Server" entry point.
|
||||
this.createServerButton = page.getByRole('link', { name: 'Create Server' }).first();
|
||||
this.settingsButton = page.locator('button[title="Settings"]');
|
||||
|
||||
// Create dialog elements
|
||||
// Create-server page elements.
|
||||
this.serverNameInput = page.locator('#create-server-name');
|
||||
this.serverDescriptionInput = page.locator('#create-server-description');
|
||||
this.serverTopicInput = page.locator('#create-server-topic');
|
||||
this.signalEndpointSelect = page.locator('#create-server-signal-endpoint');
|
||||
this.privateCheckbox = page.locator('#private');
|
||||
this.advancedSettingsToggle = page.getByRole('button', { name: 'Advanced settings' });
|
||||
this.privateCheckbox = page.locator('#create-server-private');
|
||||
this.serverPasswordInput = page.locator('#create-server-password');
|
||||
this.dialogCreateButton = page.locator('div[role="dialog"]').getByRole('button', { name: 'Create' });
|
||||
this.dialogCancelButton = page.locator('div[role="dialog"]').getByRole('button', { name: 'Cancel' });
|
||||
this.createSubmitButton = page.locator('#create-server-submit');
|
||||
this.cancelButton = page.locator('#create-server-cancel');
|
||||
}
|
||||
|
||||
async goto() {
|
||||
await this.page.goto('/search');
|
||||
await this.page.goto('/servers');
|
||||
}
|
||||
|
||||
async createServer(name: string, options?: { description?: string; topic?: string; sourceId?: string }) {
|
||||
if (!await this.serverNameInput.isVisible()) {
|
||||
if (await this.searchCreateServerButton.isVisible()) {
|
||||
await this.searchCreateServerButton.click();
|
||||
} else {
|
||||
await this.railCreateServerButton.click();
|
||||
await this.page.goto('/create-server', { waitUntil: 'domcontentloaded' });
|
||||
|
||||
if (!await this.serverNameInput.isVisible()) {
|
||||
await expect(this.searchCreateServerButton).toBeVisible({ timeout: 10_000 });
|
||||
await this.searchCreateServerButton.click();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
await expect(this.serverNameInput).toBeVisible();
|
||||
await expect(this.serverNameInput).toBeVisible({ timeout: 10_000 });
|
||||
await this.serverNameInput.fill(name);
|
||||
|
||||
if (options?.description) {
|
||||
await this.serverDescriptionInput.fill(options.description);
|
||||
}
|
||||
|
||||
if (options?.topic) {
|
||||
await this.serverTopicInput.fill(options.topic);
|
||||
if (options?.topic || options?.sourceId) {
|
||||
if (!await this.serverTopicInput.isVisible()) {
|
||||
await this.advancedSettingsToggle.click();
|
||||
}
|
||||
|
||||
await expect(this.serverTopicInput).toBeVisible({ timeout: 10_000 });
|
||||
|
||||
if (options?.topic) {
|
||||
await this.serverTopicInput.fill(options.topic);
|
||||
}
|
||||
|
||||
if (options?.sourceId) {
|
||||
await this.signalEndpointSelect.selectOption(options.sourceId);
|
||||
}
|
||||
}
|
||||
|
||||
if (options?.sourceId) {
|
||||
await this.signalEndpointSelect.selectOption(options.sourceId);
|
||||
}
|
||||
|
||||
await this.dialogCreateButton.click();
|
||||
await this.createSubmitButton.click();
|
||||
}
|
||||
|
||||
async joinSavedRoom(name: string) {
|
||||
@@ -80,6 +79,8 @@ export class ServerSearchPage {
|
||||
}
|
||||
|
||||
async joinServerFromSearch(name: string, options: { acceptPluginDownloads?: boolean } = {}) {
|
||||
await this.page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
await expect(this.searchInput).toBeVisible({ timeout: 15_000 });
|
||||
await this.searchInput.fill(name);
|
||||
|
||||
const serverCard = this.page.locator('div[title]', { hasText: name }).first();
|
||||
|
||||
@@ -170,7 +170,7 @@ async function registerUser(page: Page, user: TestUser): Promise<void> {
|
||||
|
||||
await retryTransientNavigation(() => registerPage.goto());
|
||||
await registerPage.register(user.username, user.displayName, user.password);
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
async function loginUser(page: Page, user: TestUser): Promise<void> {
|
||||
@@ -178,7 +178,7 @@ async function loginUser(page: Page, user: TestUser): Promise<void> {
|
||||
|
||||
await retryTransientNavigation(() => loginPage.goto());
|
||||
await loginPage.login(user.username, user.password);
|
||||
await expect(page).toHaveURL(/\/(search|room)(\/|$)/, { timeout: 15_000 });
|
||||
await expect(page).toHaveURL(/\/(dashboard|room)(\/|$)/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
async function logoutUser(page: Page): Promise<void> {
|
||||
@@ -213,7 +213,7 @@ async function expectSavedRoomAndHistory(page: Page, roomName: string, messageTe
|
||||
const messagesPage = new ChatMessagesPage(page);
|
||||
|
||||
await expect(railRoomButton).toBeVisible({ timeout: 20_000 });
|
||||
await page.goto('/search', { waitUntil: 'domcontentloaded' });
|
||||
await page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
const searchRoomButton = getSearchSavedRoomButton(page, roomName);
|
||||
|
||||
await expect(searchRoomButton).toBeVisible({ timeout: 20_000 });
|
||||
@@ -223,10 +223,8 @@ async function expectSavedRoomAndHistory(page: Page, roomName: string, messageTe
|
||||
}
|
||||
|
||||
async function expectBlankSlate(page: Page, hiddenRoomNames: string[]): Promise<void> {
|
||||
const searchPage = new ServerSearchPage(page);
|
||||
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(searchPage.createServerButton).toBeVisible({ timeout: 15_000 });
|
||||
await page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
await expect(page.locator('app-server-browser')).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
for (const roomName of hiddenRoomNames) {
|
||||
await expectSavedRoomHidden(page, roomName);
|
||||
@@ -235,15 +233,15 @@ async function expectBlankSlate(page: Page, hiddenRoomNames: string[]): Promise<
|
||||
|
||||
async function expectSavedRoomVisible(page: Page, roomName: string): Promise<void> {
|
||||
await expect(getRailSavedRoomButton(page, roomName)).toBeVisible({ timeout: 20_000 });
|
||||
await page.goto('/search', { waitUntil: 'domcontentloaded' });
|
||||
await page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
await expect(getSearchSavedRoomButton(page, roomName)).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function expectSavedRoomHidden(page: Page, roomName: string): Promise<void> {
|
||||
await expect(getRailSavedRoomButton(page, roomName)).toHaveCount(0);
|
||||
|
||||
if (!page.url().includes('/search')) {
|
||||
await page.goto('/search', { waitUntil: 'domcontentloaded' });
|
||||
if (!page.url().includes('/servers')) {
|
||||
await page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
}
|
||||
|
||||
await expect(getSearchSavedRoomButton(page, roomName)).toHaveCount(0);
|
||||
@@ -254,7 +252,7 @@ function getRailSavedRoomButton(page: Page, roomName: string) {
|
||||
}
|
||||
|
||||
function getSearchSavedRoomButton(page: Page, roomName: string) {
|
||||
return page.locator('app-server-search').getByRole('button', { name: roomName, exact: true });
|
||||
return page.locator('app-server-browser').getByRole('button', { name: roomName, exact: true });
|
||||
}
|
||||
|
||||
async function retryTransientNavigation<T>(navigate: () => Promise<T>, attempts = 4): Promise<T> {
|
||||
|
||||
@@ -249,7 +249,7 @@ async function createSingleClientChatScenario(createClient: () => Promise<Client
|
||||
credentials.password
|
||||
);
|
||||
|
||||
await expect(client.page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(client.page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
|
||||
return {
|
||||
client,
|
||||
@@ -288,7 +288,7 @@ async function createChatScenario(createClient: () => Promise<Client>): Promise<
|
||||
aliceCredentials.password
|
||||
);
|
||||
|
||||
await expect(alice.page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(alice.page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
|
||||
await bobRegisterPage.goto();
|
||||
await bobRegisterPage.register(
|
||||
@@ -297,7 +297,7 @@ async function createChatScenario(createClient: () => Promise<Client>): Promise<
|
||||
bobCredentials.password
|
||||
);
|
||||
|
||||
await expect(bob.page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(bob.page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
|
||||
const aliceSearchPage = new ServerSearchPage(alice.page);
|
||||
|
||||
|
||||
@@ -51,9 +51,9 @@ test.describe('Direct message flow', () => {
|
||||
const scenario = await createDmScenario(createClient);
|
||||
|
||||
await disableLastViewedChatResume(scenario.alice.page);
|
||||
await scenario.alice.page.goto('/search', { waitUntil: 'domcontentloaded' });
|
||||
await expect(scenario.alice.page).toHaveURL(/\/search/, { timeout: 20_000 });
|
||||
await expect(scenario.alice.page.locator('app-server-search')).toBeVisible({ timeout: 20_000 });
|
||||
await scenario.alice.page.goto('/people', { waitUntil: 'domcontentloaded' });
|
||||
await expect(scenario.alice.page).toHaveURL(/\/people/, { timeout: 20_000 });
|
||||
await expect(scenario.alice.page.locator('app-find-people')).toBeVisible({ timeout: 20_000 });
|
||||
await expect(scenario.alice.page.locator('app-user-search-list')).toBeVisible({ timeout: 20_000 });
|
||||
const bobPeopleCard = scenario.alice.page
|
||||
.locator('app-user-search-list [data-testid$="-' + scenario.bobUserId + '"]', { hasText: 'Bob' })
|
||||
@@ -119,7 +119,7 @@ async function registerUser(page: Page, username: string, displayName: string):
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.register(username, displayName, 'TestPass123!');
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
async function openDmFromRoomUserCard(page: Page, displayName: string): Promise<void> {
|
||||
|
||||
@@ -140,7 +140,7 @@ async function registerUser(page: Page, username: string, displayName: string, p
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.register(username, displayName, password);
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
async function installDesktopNotificationSpy(page: Page): Promise<void> {
|
||||
|
||||
@@ -380,7 +380,7 @@ async function registerUser(client: PersistentClient): Promise<void> {
|
||||
|
||||
await retryTransientNavigation(() => registerPage.goto());
|
||||
await registerPage.register(client.user.username, client.user.displayName, client.user.password);
|
||||
await expect(client.page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(client.page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
async function joinServerFromSearch(page: Page, serverName: string): Promise<void> {
|
||||
|
||||
@@ -142,11 +142,11 @@ test.describe('Server icon sync', () => {
|
||||
await test.step('Dave has not joined, but discovery loads the icon through a temporary peer sync', async () => {
|
||||
await registerUser(dave);
|
||||
await stripServerIconFromDirectorySearch(dave.page, serverName);
|
||||
await dave.page.goto('/search', { waitUntil: 'domcontentloaded' });
|
||||
await dave.page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
await new ServerSearchPage(dave.page).searchInput.fill(serverName);
|
||||
|
||||
await expectSearchResultIcon(dave.page, serverName, icon.dataUrl);
|
||||
await expect(dave.page).toHaveURL(/\/search/);
|
||||
await expect(dave.page).toHaveURL(/\/servers/);
|
||||
});
|
||||
} finally {
|
||||
await Promise.all(
|
||||
@@ -209,7 +209,7 @@ async function registerUser(client: PersistentClient): Promise<void> {
|
||||
|
||||
await retryTransientNavigation(() => registerPage.goto());
|
||||
await registerPage.register(client.user.username, client.user.displayName, client.user.password);
|
||||
await expect(client.page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(client.page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
async function joinServerFromSearch(page: Page, serverName: string): Promise<void> {
|
||||
@@ -403,7 +403,7 @@ async function expectRailIcon(page: Page, serverName: string, expectedDataUrl: s
|
||||
}
|
||||
|
||||
async function expectSearchResultIcon(page: Page, serverName: string, expectedDataUrl: string): Promise<void> {
|
||||
const serverCard = page.locator('app-server-search div[title]', { hasText: serverName }).first();
|
||||
const serverCard = page.locator('app-server-browser div[title]', { hasText: serverName }).first();
|
||||
const image = serverCard.locator('[style*="background-image"]').first();
|
||||
|
||||
await expect(serverCard).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
@@ -137,7 +137,7 @@ async function registerUser(page: Page, username: string, displayName: string):
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.register(username, displayName, 'TestPass123!');
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 30_000 });
|
||||
await expect(page).toHaveURL(/\/dashboard/, { timeout: 30_000 });
|
||||
}
|
||||
|
||||
async function installGrantAndActivatePlugin(page: Page, installFromStore: boolean): Promise<void> {
|
||||
@@ -149,7 +149,9 @@ async function installGrantAndActivatePlugin(page: Page, installFromStore: boole
|
||||
await page.getByLabel('Plugin source manifest URL').fill(PLUGIN_SOURCE_URL);
|
||||
await page.getByRole('button', { name: 'Add Source' }).click();
|
||||
await expect(page.getByRole('heading', { name: PLUGIN_TITLE })).toBeVisible({ timeout: 20_000 });
|
||||
await page.locator('article', { hasText: PLUGIN_TITLE }).getByRole('button', { exact: true, name: /^(Install|Install to Server)$/ }).click();
|
||||
await page.locator('article', { hasText: PLUGIN_TITLE }).getByRole('button', { exact: true, name: /^(Install|Install to Server)$/ })
|
||||
.click();
|
||||
|
||||
await expect(page.getByRole('dialog', { name: PLUGIN_TITLE })).toBeVisible({ timeout: 10_000 });
|
||||
await page.getByRole('button', { name: 'Install and Activate' }).click();
|
||||
await expect(page.locator('article', { hasText: PLUGIN_TITLE }).getByText('Installed')).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
@@ -15,7 +15,7 @@ test.describe('Plugin manager UI', () => {
|
||||
await test.step('Register user and create server context', async () => {
|
||||
await register.goto();
|
||||
await register.register(`plugin_${suffix}`, 'Plugin Tester', 'TestPass123!');
|
||||
await expect(page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
await expect(page.getByPlaceholder('Search people, servers, or paste an invite...')).toBeVisible({ timeout: 30_000 });
|
||||
await search.createServer(`Plugin API Server ${suffix}`, {
|
||||
description: 'Plugin manager UI E2E coverage'
|
||||
});
|
||||
|
||||
@@ -29,14 +29,14 @@ const BOB = { username: `bob_ss_${Date.now()}`, displayName: 'Bob', password: 'T
|
||||
const SERVER_NAME = `SS Test ${Date.now()}`;
|
||||
const VOICE_CHANNEL = 'General';
|
||||
|
||||
/** Register a user and navigate to /search. */
|
||||
/** Register a user and navigate to /dashboard. */
|
||||
async function registerUser(page: import('@playwright/test').Page, user: typeof ALICE) {
|
||||
const registerPage = new RegisterPage(page);
|
||||
|
||||
await registerPage.goto();
|
||||
await expect(registerPage.submitButton).toBeVisible();
|
||||
await registerPage.register(user.username, user.displayName, user.password);
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
}
|
||||
|
||||
/** Both users register -> Alice creates server -> Bob joins. */
|
||||
|
||||
@@ -88,7 +88,7 @@ test.describe('Connectivity warning', () => {
|
||||
|
||||
await register.goto();
|
||||
await register.register(`alice_${suffix}`, 'Alice', 'TestPass123!');
|
||||
await expect(alice.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
await expect(alice.page.getByPlaceholder('Search people, servers, or paste an invite...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Register Bob', async () => {
|
||||
@@ -96,7 +96,7 @@ test.describe('Connectivity warning', () => {
|
||||
|
||||
await register.goto();
|
||||
await register.register(`bob_${suffix}`, 'Bob', 'TestPass123!');
|
||||
await expect(bob.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
await expect(bob.page.getByPlaceholder('Search people, servers, or paste an invite...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Register Charlie', async () => {
|
||||
@@ -104,7 +104,7 @@ test.describe('Connectivity warning', () => {
|
||||
|
||||
await register.goto();
|
||||
await register.register(`charlie_${suffix}`, 'Charlie', 'TestPass123!');
|
||||
await expect(charlie.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
await expect(charlie.page.getByPlaceholder('Search people, servers, or paste an invite...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
// ── Create server and have everyone join ──
|
||||
|
||||
@@ -9,7 +9,7 @@ test.describe('ICE server settings', () => {
|
||||
|
||||
await register.goto();
|
||||
await register.register(`user_${suffix}`, 'IceTestUser', 'TestPass123!');
|
||||
await expect(page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
await expect(page.getByPlaceholder('Search people, servers, or paste an invite...')).toBeVisible({ timeout: 30_000 });
|
||||
await page.getByTitle('Settings').click();
|
||||
await expect(page.getByRole('button', { name: 'Network' })).toBeVisible({ timeout: 10_000 });
|
||||
await page.getByRole('button', { name: 'Network' }).click();
|
||||
|
||||
@@ -89,7 +89,7 @@ test.describe('STUN/TURN fallback behaviour', () => {
|
||||
|
||||
await register.goto();
|
||||
await register.register(`alice_${suffix}`, 'Alice', 'TestPass123!');
|
||||
await expect(alice.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
await expect(alice.page.getByPlaceholder('Search people, servers, or paste an invite...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Register Bob', async () => {
|
||||
@@ -97,7 +97,7 @@ test.describe('STUN/TURN fallback behaviour', () => {
|
||||
|
||||
await register.goto();
|
||||
await register.register(`bob_${suffix}`, 'Bob', 'TestPass123!');
|
||||
await expect(bob.page.getByPlaceholder('Search servers and users...')).toBeVisible({ timeout: 30_000 });
|
||||
await expect(bob.page.getByPlaceholder('Search people, servers, or paste an invite...')).toBeVisible({ timeout: 30_000 });
|
||||
});
|
||||
|
||||
await test.step('Alice creates a server', async () => {
|
||||
|
||||
@@ -105,7 +105,7 @@ async function createVoiceScenario(
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.register(client.username, client.displayName, USER_PASSWORD);
|
||||
await expect(client.page).toHaveURL(/\/search/, { timeout: 20_000 });
|
||||
await expect(client.page).toHaveURL(/\/dashboard/, { timeout: 20_000 });
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ test.describe('Direct private calls', () => {
|
||||
|
||||
await test.step('Alice starts a call from the search people card', async () => {
|
||||
await disableLastViewedChatResume(scenario.alice.page);
|
||||
await scenario.alice.page.goto('/search', { waitUntil: 'domcontentloaded' });
|
||||
await scenario.alice.page.goto('/people', { waitUntil: 'domcontentloaded' });
|
||||
await expect(scenario.alice.page.locator('app-user-search-list')).toBeVisible({ timeout: 20_000 });
|
||||
|
||||
const bobPeopleCard = scenario.alice.page.locator(`[data-testid="user-card-${scenario.bobUserId}"]`, { hasText: 'Bob' }).first();
|
||||
@@ -597,12 +597,12 @@ async function registerUser(page: Page, username: string, displayName: string):
|
||||
|
||||
await registerPage.goto();
|
||||
await registerPage.register(username, displayName, USER_PASSWORD);
|
||||
await expect(page).toHaveURL(/\/search/, { timeout: 20_000 });
|
||||
await expect(page).toHaveURL(/\/dashboard/, { timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function startCallFromSearch(page: Page, userId: string, displayName: string): Promise<void> {
|
||||
await disableLastViewedChatResume(page);
|
||||
await page.goto('/search', { waitUntil: 'domcontentloaded' });
|
||||
await page.goto('/people', { waitUntil: 'domcontentloaded' });
|
||||
const peopleCard = page.locator(`[data-testid="user-card-${userId}"]`, { hasText: displayName }).first();
|
||||
|
||||
await expect(peopleCard).toBeVisible({ timeout: 20_000 });
|
||||
@@ -621,7 +621,9 @@ async function answerIncomingCall(page: Page): Promise<void> {
|
||||
if (await dialog.isVisible({ timeout: 5_000 }).catch(() => false)) {
|
||||
await dialog.getByRole('button', { name: 'Answer' }).click();
|
||||
} else {
|
||||
await page.getByRole('button', { name: 'Open private call' }).last().click();
|
||||
await page.getByRole('button', { name: 'Open private call' }).last()
|
||||
.click();
|
||||
|
||||
await expect(page).toHaveURL(/\/call\//, { timeout: 20_000 });
|
||||
|
||||
const joinButton = page.getByRole('button', { name: 'Join call' });
|
||||
|
||||
@@ -136,7 +136,7 @@ test.describe('Mixed signal-config voice', () => {
|
||||
await registerPage.goto();
|
||||
await registerPage.serverSelect.selectOption(registrationEndpointId);
|
||||
await registerPage.register(client.user.username, client.user.displayName, client.user.password);
|
||||
await expect(client.page).toHaveURL(/\/search/, { timeout: 20_000 });
|
||||
await expect(client.page).toHaveURL(/\/dashboard/, { timeout: 20_000 });
|
||||
}
|
||||
});
|
||||
|
||||
@@ -556,18 +556,13 @@ async function installDeterministicVoiceSettings(page: Page): Promise<void> {
|
||||
}
|
||||
|
||||
async function openSearchView(page: Page): Promise<void> {
|
||||
const searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
|
||||
if (await searchInput.isVisible().catch(() => false)) {
|
||||
return;
|
||||
}
|
||||
|
||||
await page.locator('button[title="Create Server"]').click();
|
||||
await expect(searchInput).toBeVisible({ timeout: 20_000 });
|
||||
await page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
await expect(page.getByPlaceholder('Search servers...')).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function joinRoomFromSearch(page: Page, roomName: string): Promise<void> {
|
||||
const searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
await page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
const searchInput = page.getByPlaceholder('Search servers...');
|
||||
|
||||
await expect(searchInput).toBeVisible({ timeout: 20_000 });
|
||||
await searchInput.fill(roomName);
|
||||
|
||||
@@ -71,7 +71,7 @@ test.describe('Dual-signal multi-user voice', () => {
|
||||
await registerPage.goto();
|
||||
await registerPage.serverSelect.selectOption(PRIMARY_SIGNAL_ID);
|
||||
await registerPage.register(client.user.username, client.user.displayName, client.user.password);
|
||||
await expect(client.page).toHaveURL(/\/search/, { timeout: 20_000 });
|
||||
await expect(client.page).toHaveURL(/\/dashboard/, { timeout: 20_000 });
|
||||
}
|
||||
});
|
||||
|
||||
@@ -319,18 +319,13 @@ async function installDeterministicVoiceSettings(page: Page): Promise<void> {
|
||||
}
|
||||
|
||||
async function openSearchView(page: Page): Promise<void> {
|
||||
const searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
|
||||
if (await searchInput.isVisible().catch(() => false)) {
|
||||
return;
|
||||
}
|
||||
|
||||
await page.locator('button[title="Create Server"]').click();
|
||||
await expect(searchInput).toBeVisible({ timeout: 20_000 });
|
||||
await page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
await expect(page.getByPlaceholder('Search servers...')).toBeVisible({ timeout: 20_000 });
|
||||
}
|
||||
|
||||
async function joinRoomFromSearch(page: Page, roomName: string): Promise<void> {
|
||||
const searchInput = page.getByPlaceholder('Search servers and users...');
|
||||
await page.goto('/servers', { waitUntil: 'domcontentloaded' });
|
||||
const searchInput = page.getByPlaceholder('Search servers...');
|
||||
|
||||
await expect(searchInput).toBeVisible({ timeout: 20_000 });
|
||||
await searchInput.fill(roomName);
|
||||
|
||||
@@ -64,8 +64,8 @@ test.describe('Full user journey: register -> server -> voice chat', () => {
|
||||
await expect(registerPage.submitButton).toBeVisible();
|
||||
await registerPage.register(ALICE.username, ALICE.displayName, ALICE.password);
|
||||
|
||||
// After registration, app should navigate to /search
|
||||
await expect(alice.page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
// After registration, app should navigate to /dashboard
|
||||
await expect(alice.page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
});
|
||||
|
||||
await test.step('Bob registers an account', async () => {
|
||||
@@ -75,7 +75,7 @@ test.describe('Full user journey: register -> server -> voice chat', () => {
|
||||
await expect(registerPage.submitButton).toBeVisible();
|
||||
await registerPage.register(BOB.username, BOB.displayName, BOB.password);
|
||||
|
||||
await expect(bob.page).toHaveURL(/\/search/, { timeout: 15_000 });
|
||||
await expect(bob.page).toHaveURL(/\/dashboard/, { timeout: 15_000 });
|
||||
});
|
||||
|
||||
// ── Step 2: Alice creates a server ───────────────────────────────
|
||||
|
||||
25
electron/AGENTS.md
Normal file
25
electron/AGENTS.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Electron Guidelines
|
||||
|
||||
This directory contains the Electron main process, preload bridge, IPC, desktop integration, and local persistence glue.
|
||||
|
||||
## Workflow
|
||||
|
||||
- Build with `npm run build:electron`.
|
||||
- Use `npm run electron:dev` or `npm run dev` when you need the integrated desktop stack.
|
||||
- See `../doc/typescript.md` for shared TypeScript rules.
|
||||
|
||||
## Boundaries
|
||||
|
||||
- Keep bootstrapping and lifecycle concerns in `app/`.
|
||||
- Keep desktop platform integrations in focused modules such as `audio/`, `update/`, and `window/`.
|
||||
- Keep renderer-exposed APIs typed in `preload.ts` and routed through explicit IPC handlers.
|
||||
- When adding a new renderer-facing capability, update the Electron implementation, the preload surface, and the renderer bridge together.
|
||||
- Keep persistence entities, migrations, and CQRS helpers aligned with the desktop database model rather than duplicating renderer types.
|
||||
|
||||
## Generated Output
|
||||
|
||||
- Treat `dist/electron/` and packaged artifacts in `dist-electron/` as build output, not source.
|
||||
|
||||
## Before You Finish
|
||||
|
||||
- Validate whether relevant markdown docs or `AGENTS.md` files need updates. If behavior, workflows, commands, or architecture changed, update those docs in the same task.
|
||||
59
electron/CONTEXT.md
Normal file
59
electron/CONTEXT.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# Desktop Shell (electron)
|
||||
|
||||
Owns the desktop runtime: the Electron main process, the preload bridge that exposes `window.api` to the renderer, IPC handlers, the local TypeORM + sql.js database, the plugin loader, OS-integration adapters (window controls, idle detection, game detection, audio), update flow, and the Local API server that hosts the Docusaurus bundle inside the app.
|
||||
|
||||
> **Format reference:**
|
||||
> - **Vocabulary** — bold term, one-sentence definition, aliases to avoid.
|
||||
> - **Relationships** — bullets with bold terms and cardinality.
|
||||
> - **Boundaries / IO** — what this subdomain exposes and consumes.
|
||||
> - **Invariants** — rules that always hold.
|
||||
> - **Flagged ambiguities** — terms in dispute with proposed resolutions.
|
||||
>
|
||||
> See `agents-docs/AGENTS_CONTEXT.md` for the contract. Update in the same turn a trigger fires (see `agents-docs/AGENT_WORKFLOW.md` § CONTEXT.md upkeep).
|
||||
|
||||
## Vocabulary
|
||||
|
||||
| Term | Definition | Aliases to avoid |
|
||||
|------|------------|------------------|
|
||||
| **Preload bridge** | `electron/preload.ts` — the only surface that the renderer can call into Node through; exposes `window.api.*` after `contextBridge.exposeInMainWorld`. | "preloader" |
|
||||
| **IPC handler** | A `main`-process function registered against an IPC channel name; lives under `electron/ipc/` (system, window-controls) and `electron/cqrs.ts`. | "rpc handler" |
|
||||
| **CQRS handler** | Command or query handler dispatched through `electron/ipc/cqrs.ts`; pattern shared with `server/src/cqrs/`. | "command processor" |
|
||||
| **Local API server** | An in-process HTTP server (`electron/api/local-api-server.ts`) that serves the prebuilt Docusaurus docs and OpenAPI views to the renderer over `http://localhost:<port>/`. | "internal API" |
|
||||
| **Plugin library** | The plugin loader (`electron/plugin-library.ts`) — resolves manifests, validates entry points, and prepares the sandbox the renderer mounts plugins into. | "plugin manager" |
|
||||
| **Data archive** | The export/import format implemented in `electron/data-archive.ts` for moving a user's local database between installs. | "backup" |
|
||||
|
||||
## Relationships
|
||||
|
||||
- The **Preload bridge** is the only path between the **Renderer** (toju-app) and **Main**; the renderer cannot import Electron, Node, or TypeORM directly.
|
||||
- An **IPC channel** maps 1:1 to a method on `window.api.*`. Adding a method on the preload requires registering its handler in `electron/ipc/` or `electron/cqrs.ts`.
|
||||
- The **Plugin library** loads manifests at startup and on user action; it owns the contract the renderer's *plugins* domain consumes (defined in `toju-app/src/app/shared-kernel/plugin-system.contracts.ts`).
|
||||
- TypeORM **migrations** in `electron/migrations/` are applied on startup against the per-user SQLite file resolved by `electron/runtime-paths.ts`.
|
||||
- The **Local API server** serves the Docusaurus bundle built into `docs-site/build/` and the OpenAPI artifacts under `electron/api/openapi.ts`.
|
||||
|
||||
## Boundaries / IO
|
||||
|
||||
- **Exposes:**
|
||||
- `window.api.*` surface (preload bridge) — the canonical IPC contract for the renderer.
|
||||
- IPC channel names registered in `electron/ipc/index.ts`, `electron/ipc/cqrs.ts`, `electron/ipc/system.ts`, `electron/ipc/window-controls.ts`.
|
||||
- Local API HTTP endpoints (`electron/api/router.ts`) under `http://localhost:<port>/`.
|
||||
- Plugin host contract (`electron/plugin-library.ts`) — defines what plugin manifests must declare and what the plugin runtime can call back into.
|
||||
- **Consumes:**
|
||||
- The renderer (toju-app) via IPC `invoke`/`handle` and event emitters.
|
||||
- The local SQLite database via `electron/data-source.ts` and entities under `electron/entities/`.
|
||||
- OS APIs: window controls, idle detection (`electron/idle/`), game detection (`electron/game-detection/`), process list (`electron/process-list.ts`).
|
||||
- The audio worklet bundle (`toju-app/public/rnnoise-worklet.js` built from `@timephy/rnnoise-wasm`).
|
||||
|
||||
## Invariants
|
||||
|
||||
- The **Renderer** never has direct access to Node, the filesystem, or the database — every privileged operation goes through an IPC handler.
|
||||
- Every schema change is accompanied by a **TypeORM migration**; the database is never mutated outside the migration system.
|
||||
- IPC handler errors are translated to typed error envelopes before crossing back into the renderer — the renderer never sees a raw `Error` from main.
|
||||
- The **Preload bridge** exposes a frozen, allow-listed set of methods; adding a method requires touching both `preload.ts` and the matching handler.
|
||||
|
||||
## Flagged ambiguities
|
||||
|
||||
- _None recorded yet — add entries when an IPC channel name or plugin contract term resists clean definition._
|
||||
|
||||
---
|
||||
|
||||
*Agent-procedural rules (TDD, lint, build) live in `/AGENTS.md`. Cross-context contract details (IPC envelope shapes, plugin manifest schema) belong in `agents-docs/features/`. This file is the bounded-context domain artefact for the desktop shell.*
|
||||
@@ -11,6 +11,7 @@ import {
|
||||
ReactionEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
CustomEmojiEntity,
|
||||
MetaEntity,
|
||||
PluginDataEntity
|
||||
} from '../../../entities';
|
||||
@@ -27,6 +28,7 @@ export async function handleClearAllData(dataSource: DataSource): Promise<void>
|
||||
await dataSource.getRepository(ReactionEntity).clear();
|
||||
await dataSource.getRepository(BanEntity).clear();
|
||||
await dataSource.getRepository(AttachmentEntity).clear();
|
||||
await dataSource.getRepository(CustomEmojiEntity).clear();
|
||||
await dataSource.getRepository(MetaEntity).clear();
|
||||
await dataSource.getRepository(PluginDataEntity).clear();
|
||||
}
|
||||
|
||||
7
electron/cqrs/commands/handlers/deleteCustomEmoji.ts
Normal file
7
electron/cqrs/commands/handlers/deleteCustomEmoji.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { CustomEmojiEntity } from '../../../entities';
|
||||
import { DeleteCustomEmojiCommand } from '../../types';
|
||||
|
||||
export async function handleDeleteCustomEmoji(command: DeleteCustomEmojiCommand, dataSource: DataSource): Promise<void> {
|
||||
await dataSource.getRepository(CustomEmojiEntity).delete({ id: command.payload.emojiId });
|
||||
}
|
||||
19
electron/cqrs/commands/handlers/saveCustomEmoji.ts
Normal file
19
electron/cqrs/commands/handlers/saveCustomEmoji.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { CustomEmojiEntity } from '../../../entities';
|
||||
import { SaveCustomEmojiCommand } from '../../types';
|
||||
|
||||
export async function handleSaveCustomEmoji(command: SaveCustomEmojiCommand, dataSource: DataSource): Promise<void> {
|
||||
const { emoji } = command.payload;
|
||||
|
||||
await dataSource.getRepository(CustomEmojiEntity).save({
|
||||
id: emoji.id,
|
||||
name: emoji.name,
|
||||
creatorUserId: emoji.creatorUserId,
|
||||
dataUrl: emoji.dataUrl,
|
||||
hash: emoji.hash,
|
||||
mime: emoji.mime,
|
||||
size: emoji.size,
|
||||
createdAt: emoji.createdAt,
|
||||
updatedAt: emoji.updatedAt
|
||||
});
|
||||
}
|
||||
@@ -24,7 +24,8 @@ export async function handleSaveUser(command: SaveUserCommand, dataSource: DataS
|
||||
isAdmin: user.isAdmin ? 1 : 0,
|
||||
isRoomOwner: user.isRoomOwner ? 1 : 0,
|
||||
voiceState: user.voiceState != null ? JSON.stringify(user.voiceState) : null,
|
||||
screenShareState: user.screenShareState != null ? JSON.stringify(user.screenShareState) : null
|
||||
screenShareState: user.screenShareState != null ? JSON.stringify(user.screenShareState) : null,
|
||||
homeSignalServerUrl: user.homeSignalServerUrl ?? null
|
||||
});
|
||||
|
||||
await repo.save(entity);
|
||||
|
||||
@@ -19,6 +19,8 @@ import {
|
||||
RemoveBanCommand,
|
||||
SaveAttachmentCommand,
|
||||
DeleteAttachmentsForMessageCommand,
|
||||
SaveCustomEmojiCommand,
|
||||
DeleteCustomEmojiCommand,
|
||||
SavePluginDataCommand,
|
||||
DeletePluginDataCommand,
|
||||
SaveMetaCommand
|
||||
@@ -39,6 +41,8 @@ import { handleSaveBan } from './handlers/saveBan';
|
||||
import { handleRemoveBan } from './handlers/removeBan';
|
||||
import { handleSaveAttachment } from './handlers/saveAttachment';
|
||||
import { handleDeleteAttachmentsForMessage } from './handlers/deleteAttachmentsForMessage';
|
||||
import { handleSaveCustomEmoji } from './handlers/saveCustomEmoji';
|
||||
import { handleDeleteCustomEmoji } from './handlers/deleteCustomEmoji';
|
||||
import { handleSavePluginData } from './handlers/savePluginData';
|
||||
import { handleDeletePluginData } from './handlers/deletePluginData';
|
||||
import { handleSaveMeta } from './handlers/saveMeta';
|
||||
@@ -61,6 +65,8 @@ export const buildCommandHandlers = (dataSource: DataSource): Record<CommandType
|
||||
[CommandType.RemoveBan]: (cmd) => handleRemoveBan(cmd as RemoveBanCommand, dataSource),
|
||||
[CommandType.SaveAttachment]: (cmd) => handleSaveAttachment(cmd as SaveAttachmentCommand, dataSource),
|
||||
[CommandType.DeleteAttachmentsForMessage]: (cmd) => handleDeleteAttachmentsForMessage(cmd as DeleteAttachmentsForMessageCommand, dataSource),
|
||||
[CommandType.SaveCustomEmoji]: (cmd) => handleSaveCustomEmoji(cmd as SaveCustomEmojiCommand, dataSource),
|
||||
[CommandType.DeleteCustomEmoji]: (cmd) => handleDeleteCustomEmoji(cmd as DeleteCustomEmojiCommand, dataSource),
|
||||
[CommandType.SavePluginData]: (cmd) => handleSavePluginData(cmd as SavePluginDataCommand, dataSource),
|
||||
[CommandType.DeletePluginData]: (cmd) => handleDeletePluginData(cmd as DeletePluginDataCommand, dataSource),
|
||||
[CommandType.SaveMeta]: (cmd) => handleSaveMeta(cmd as SaveMetaCommand, dataSource),
|
||||
|
||||
@@ -9,6 +9,7 @@ import { RoomEntity } from '../entities/RoomEntity';
|
||||
import { ReactionEntity } from '../entities/ReactionEntity';
|
||||
import { BanEntity } from '../entities/BanEntity';
|
||||
import { AttachmentEntity } from '../entities/AttachmentEntity';
|
||||
import { CustomEmojiEntity } from '../entities/CustomEmojiEntity';
|
||||
import { ReactionPayload } from './types';
|
||||
import {
|
||||
relationRecordToRoomPayload,
|
||||
@@ -60,7 +61,8 @@ export function rowToUser(row: UserEntity) {
|
||||
isAdmin: !!row.isAdmin,
|
||||
isRoomOwner: !!row.isRoomOwner,
|
||||
voiceState: row.voiceState ? JSON.parse(row.voiceState) : undefined,
|
||||
screenShareState: row.screenShareState ? JSON.parse(row.screenShareState) : undefined
|
||||
screenShareState: row.screenShareState ? JSON.parse(row.screenShareState) : undefined,
|
||||
homeSignalServerUrl: row.homeSignalServerUrl ?? undefined
|
||||
};
|
||||
}
|
||||
|
||||
@@ -140,6 +142,20 @@ export function rowToAttachment(row: AttachmentEntity) {
|
||||
};
|
||||
}
|
||||
|
||||
export function rowToCustomEmoji(row: CustomEmojiEntity) {
|
||||
return {
|
||||
id: row.id,
|
||||
name: row.name,
|
||||
creatorUserId: row.creatorUserId,
|
||||
dataUrl: row.dataUrl,
|
||||
hash: row.hash,
|
||||
mime: row.mime,
|
||||
size: row.size,
|
||||
createdAt: row.createdAt,
|
||||
updatedAt: row.updatedAt
|
||||
};
|
||||
}
|
||||
|
||||
export function rowToBan(row: BanEntity) {
|
||||
return {
|
||||
oderId: row.oderId,
|
||||
|
||||
9
electron/cqrs/queries/handlers/getCustomEmojis.ts
Normal file
9
electron/cqrs/queries/handlers/getCustomEmojis.ts
Normal file
@@ -0,0 +1,9 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { CustomEmojiEntity } from '../../../entities';
|
||||
import { rowToCustomEmoji } from '../../mappers';
|
||||
|
||||
export async function handleGetCustomEmojis(dataSource: DataSource) {
|
||||
const rows = await dataSource.getRepository(CustomEmojiEntity).find({ order: { updatedAt: 'DESC' } });
|
||||
|
||||
return rows.map(rowToCustomEmoji);
|
||||
}
|
||||
@@ -7,20 +7,36 @@ import { getCurrentUserScope } from '../../current-user-scope';
|
||||
|
||||
export async function handleGetMessages(query: GetMessagesQuery, dataSource: DataSource) {
|
||||
const repo = dataSource.getRepository(MessageEntity);
|
||||
const { roomId, limit = 100, offset = 0 } = query.payload;
|
||||
const { roomId, limit = 100, offset = 0, channelId, beforeTimestamp } = query.payload;
|
||||
const currentUserId = await getCurrentUserScope(dataSource);
|
||||
|
||||
if (!currentUserId) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const rows = await repo.find({
|
||||
where: { roomId, ownerUserId: currentUserId },
|
||||
order: { timestamp: 'ASC' },
|
||||
take: limit,
|
||||
skip: offset
|
||||
});
|
||||
const reactionsByMessageId = await loadMessageReactionsMap(dataSource, rows.map((row) => row.id));
|
||||
const rowsQuery = repo.createQueryBuilder('message')
|
||||
.where('message.roomId = :roomId', { roomId })
|
||||
.andWhere('message.ownerUserId = :currentUserId', { currentUserId })
|
||||
.orderBy('message.timestamp', 'DESC')
|
||||
.take(limit)
|
||||
.skip(offset);
|
||||
|
||||
return rows.map((row) => rowToMessage(row, reactionsByMessageId.get(row.id) ?? []));
|
||||
if (channelId === 'general') {
|
||||
rowsQuery.andWhere('(message.channelId = :channelId OR message.channelId IS NULL OR message.channelId = :emptyChannelId)', {
|
||||
channelId,
|
||||
emptyChannelId: ''
|
||||
});
|
||||
} else if (channelId) {
|
||||
rowsQuery.andWhere('message.channelId = :channelId', { channelId });
|
||||
}
|
||||
|
||||
if (typeof beforeTimestamp === 'number') {
|
||||
rowsQuery.andWhere('message.timestamp < :beforeTimestamp', { beforeTimestamp });
|
||||
}
|
||||
|
||||
const rows = await rowsQuery.getMany();
|
||||
const chronologicalRows = [...rows].reverse();
|
||||
const reactionsByMessageId = await loadMessageReactionsMap(dataSource, chronologicalRows.map((row) => row.id));
|
||||
|
||||
return chronologicalRows.map((row) => rowToMessage(row, reactionsByMessageId.get(row.id) ?? []));
|
||||
}
|
||||
|
||||
27
electron/cqrs/queries/handlers/getRoomMessageStats.ts
Normal file
27
electron/cqrs/queries/handlers/getRoomMessageStats.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { MessageEntity } from '../../../entities';
|
||||
import { GetRoomMessageStatsQuery } from '../../types';
|
||||
import { getCurrentUserScope } from '../../current-user-scope';
|
||||
|
||||
export async function handleGetRoomMessageStats(query: GetRoomMessageStatsQuery, dataSource: DataSource) {
|
||||
const repo = dataSource.getRepository(MessageEntity);
|
||||
const { roomId } = query.payload;
|
||||
const currentUserId = await getCurrentUserScope(dataSource);
|
||||
|
||||
if (!currentUserId) {
|
||||
return { count: 0,
|
||||
lastUpdated: 0 };
|
||||
}
|
||||
|
||||
const row = await repo.createQueryBuilder('message')
|
||||
.select('COUNT(message.id)', 'count')
|
||||
.addSelect('MAX(COALESCE(message.editedAt, message.timestamp, 0))', 'lastUpdated')
|
||||
.where('message.roomId = :roomId', { roomId })
|
||||
.andWhere('message.ownerUserId = :currentUserId', { currentUserId })
|
||||
.getRawOne<{ count?: string | number | null; lastUpdated?: string | number | null }>();
|
||||
|
||||
return {
|
||||
count: Number(row?.count ?? 0) || 0,
|
||||
lastUpdated: Number(row?.lastUpdated ?? 0) || 0
|
||||
};
|
||||
}
|
||||
@@ -5,6 +5,7 @@ import {
|
||||
Query,
|
||||
GetMessagesQuery,
|
||||
GetMessagesSinceQuery,
|
||||
GetRoomMessageStatsQuery,
|
||||
GetMessageByIdQuery,
|
||||
GetReactionsForMessageQuery,
|
||||
GetUserQuery,
|
||||
@@ -17,6 +18,7 @@ import {
|
||||
} from '../types';
|
||||
import { handleGetMessages } from './handlers/getMessages';
|
||||
import { handleGetMessagesSince } from './handlers/getMessagesSince';
|
||||
import { handleGetRoomMessageStats } from './handlers/getRoomMessageStats';
|
||||
import { handleGetMessageById } from './handlers/getMessageById';
|
||||
import { handleGetReactionsForMessage } from './handlers/getReactionsForMessage';
|
||||
import { handleGetUser } from './handlers/getUser';
|
||||
@@ -29,12 +31,14 @@ import { handleGetBansForRoom } from './handlers/getBansForRoom';
|
||||
import { handleIsUserBanned } from './handlers/isUserBanned';
|
||||
import { handleGetAttachmentsForMessage } from './handlers/getAttachmentsForMessage';
|
||||
import { handleGetAllAttachments } from './handlers/getAllAttachments';
|
||||
import { handleGetCustomEmojis } from './handlers/getCustomEmojis';
|
||||
import { handleGetPluginData } from './handlers/getPluginData';
|
||||
import { handleGetMeta } from './handlers/getMeta';
|
||||
|
||||
export const buildQueryHandlers = (dataSource: DataSource): Record<QueryTypeKey, (query: Query) => Promise<unknown>> => ({
|
||||
[QueryType.GetMessages]: (query) => handleGetMessages(query as GetMessagesQuery, dataSource),
|
||||
[QueryType.GetMessagesSince]: (query) => handleGetMessagesSince(query as GetMessagesSinceQuery, dataSource),
|
||||
[QueryType.GetRoomMessageStats]: (query) => handleGetRoomMessageStats(query as GetRoomMessageStatsQuery, dataSource),
|
||||
[QueryType.GetMessageById]: (query) => handleGetMessageById(query as GetMessageByIdQuery, dataSource),
|
||||
[QueryType.GetReactionsForMessage]: (query) => handleGetReactionsForMessage(query as GetReactionsForMessageQuery, dataSource),
|
||||
[QueryType.GetUser]: (query) => handleGetUser(query as GetUserQuery, dataSource),
|
||||
@@ -47,6 +51,7 @@ export const buildQueryHandlers = (dataSource: DataSource): Record<QueryTypeKey,
|
||||
[QueryType.IsUserBanned]: (query) => handleIsUserBanned(query as IsUserBannedQuery, dataSource),
|
||||
[QueryType.GetAttachmentsForMessage]: (query) => handleGetAttachmentsForMessage(query as GetAttachmentsForMessageQuery, dataSource),
|
||||
[QueryType.GetAllAttachments]: () => handleGetAllAttachments(dataSource),
|
||||
[QueryType.GetCustomEmojis]: () => handleGetCustomEmojis(dataSource),
|
||||
[QueryType.GetPluginData]: (query) => handleGetPluginData(query as GetPluginDataQuery, dataSource),
|
||||
[QueryType.GetMeta]: (query) => handleGetMeta(query as GetMetaQuery, dataSource)
|
||||
});
|
||||
|
||||
@@ -15,6 +15,8 @@ export const CommandType = {
|
||||
RemoveBan: 'remove-ban',
|
||||
SaveAttachment: 'save-attachment',
|
||||
DeleteAttachmentsForMessage: 'delete-attachments-for-message',
|
||||
SaveCustomEmoji: 'save-custom-emoji',
|
||||
DeleteCustomEmoji: 'delete-custom-emoji',
|
||||
SavePluginData: 'save-plugin-data',
|
||||
DeletePluginData: 'delete-plugin-data',
|
||||
SaveMeta: 'save-meta',
|
||||
@@ -26,6 +28,7 @@ export type CommandTypeKey = typeof CommandType[keyof typeof CommandType];
|
||||
export const QueryType = {
|
||||
GetMessages: 'get-messages',
|
||||
GetMessagesSince: 'get-messages-since',
|
||||
GetRoomMessageStats: 'get-room-message-stats',
|
||||
GetMessageById: 'get-message-by-id',
|
||||
GetReactionsForMessage: 'get-reactions-for-message',
|
||||
GetUser: 'get-user',
|
||||
@@ -38,6 +41,7 @@ export const QueryType = {
|
||||
IsUserBanned: 'is-user-banned',
|
||||
GetAttachmentsForMessage: 'get-attachments-for-message',
|
||||
GetAllAttachments: 'get-all-attachments',
|
||||
GetCustomEmojis: 'get-custom-emojis',
|
||||
GetPluginData: 'get-plugin-data',
|
||||
GetMeta: 'get-meta'
|
||||
} as const;
|
||||
@@ -126,6 +130,7 @@ export interface UserPayload {
|
||||
isRoomOwner?: boolean;
|
||||
voiceState?: unknown;
|
||||
screenShareState?: unknown;
|
||||
homeSignalServerUrl?: string;
|
||||
}
|
||||
|
||||
export interface RoomPayload {
|
||||
@@ -177,6 +182,18 @@ export interface AttachmentPayload {
|
||||
savedPath?: string;
|
||||
}
|
||||
|
||||
export interface CustomEmojiPayload {
|
||||
id: string;
|
||||
name: string;
|
||||
creatorUserId: string;
|
||||
dataUrl: string;
|
||||
hash: string;
|
||||
mime: string;
|
||||
size: number;
|
||||
createdAt: number;
|
||||
updatedAt: number;
|
||||
}
|
||||
|
||||
export type PluginDataScopePayload = 'local' | 'server';
|
||||
|
||||
export interface PluginDataPayload {
|
||||
@@ -203,6 +220,8 @@ export interface SaveBanCommand { type: typeof CommandType.SaveBan; payload: { b
|
||||
export interface RemoveBanCommand { type: typeof CommandType.RemoveBan; payload: { oderId: string } }
|
||||
export interface SaveAttachmentCommand { type: typeof CommandType.SaveAttachment; payload: { attachment: AttachmentPayload } }
|
||||
export interface DeleteAttachmentsForMessageCommand { type: typeof CommandType.DeleteAttachmentsForMessage; payload: { messageId: string } }
|
||||
export interface SaveCustomEmojiCommand { type: typeof CommandType.SaveCustomEmoji; payload: { emoji: CustomEmojiPayload } }
|
||||
export interface DeleteCustomEmojiCommand { type: typeof CommandType.DeleteCustomEmoji; payload: { emojiId: string } }
|
||||
export interface SavePluginDataCommand { type: typeof CommandType.SavePluginData; payload: PluginDataPayload }
|
||||
export interface DeletePluginDataCommand { type: typeof CommandType.DeletePluginData; payload: Omit<PluginDataPayload, 'value'> }
|
||||
export interface SaveMetaCommand { type: typeof CommandType.SaveMeta; payload: { key: string; value: string | null } }
|
||||
@@ -225,13 +244,25 @@ export type Command =
|
||||
| RemoveBanCommand
|
||||
| SaveAttachmentCommand
|
||||
| DeleteAttachmentsForMessageCommand
|
||||
| SaveCustomEmojiCommand
|
||||
| DeleteCustomEmojiCommand
|
||||
| SavePluginDataCommand
|
||||
| DeletePluginDataCommand
|
||||
| SaveMetaCommand
|
||||
| ClearAllDataCommand;
|
||||
|
||||
export interface GetMessagesQuery { type: typeof QueryType.GetMessages; payload: { roomId: string; limit?: number; offset?: number } }
|
||||
export interface GetMessagesQuery {
|
||||
type: typeof QueryType.GetMessages;
|
||||
payload: {
|
||||
roomId: string;
|
||||
limit?: number;
|
||||
offset?: number;
|
||||
channelId?: string;
|
||||
beforeTimestamp?: number;
|
||||
};
|
||||
}
|
||||
export interface GetMessagesSinceQuery { type: typeof QueryType.GetMessagesSince; payload: { roomId: string; sinceTimestamp: number } }
|
||||
export interface GetRoomMessageStatsQuery { type: typeof QueryType.GetRoomMessageStats; payload: { roomId: string } }
|
||||
export interface GetMessageByIdQuery { type: typeof QueryType.GetMessageById; payload: { messageId: string } }
|
||||
export interface GetReactionsForMessageQuery { type: typeof QueryType.GetReactionsForMessage; payload: { messageId: string } }
|
||||
export interface GetUserQuery { type: typeof QueryType.GetUser; payload: { userId: string } }
|
||||
@@ -244,12 +275,14 @@ export interface GetBansForRoomQuery { type: typeof QueryType.GetBansForRoom; pa
|
||||
export interface IsUserBannedQuery { type: typeof QueryType.IsUserBanned; payload: { userId: string; roomId: string } }
|
||||
export interface GetAttachmentsForMessageQuery { type: typeof QueryType.GetAttachmentsForMessage; payload: { messageId: string } }
|
||||
export interface GetAllAttachmentsQuery { type: typeof QueryType.GetAllAttachments; payload: Record<string, never> }
|
||||
export interface GetCustomEmojisQuery { type: typeof QueryType.GetCustomEmojis; payload: Record<string, never> }
|
||||
export interface GetPluginDataQuery { type: typeof QueryType.GetPluginData; payload: Omit<PluginDataPayload, 'value'> }
|
||||
export interface GetMetaQuery { type: typeof QueryType.GetMeta; payload: { key: string } }
|
||||
|
||||
export type Query =
|
||||
| GetMessagesQuery
|
||||
| GetMessagesSinceQuery
|
||||
| GetRoomMessageStatsQuery
|
||||
| GetMessageByIdQuery
|
||||
| GetReactionsForMessageQuery
|
||||
| GetUserQuery
|
||||
@@ -262,5 +295,6 @@ export type Query =
|
||||
| IsUserBannedQuery
|
||||
| GetAttachmentsForMessageQuery
|
||||
| GetAllAttachmentsQuery
|
||||
| GetCustomEmojisQuery
|
||||
| GetPluginDataQuery
|
||||
| GetMetaQuery;
|
||||
|
||||
@@ -23,6 +23,7 @@ import {
|
||||
RoomUserRoleEntity,
|
||||
RoomChannelPermissionEntity,
|
||||
ReactionEntity,
|
||||
CustomEmojiEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
MetaEntity,
|
||||
@@ -50,6 +51,7 @@ export const AppDataSource = new DataSource({
|
||||
RoomUserRoleEntity,
|
||||
RoomChannelPermissionEntity,
|
||||
ReactionEntity,
|
||||
CustomEmojiEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
MetaEntity,
|
||||
|
||||
@@ -15,6 +15,7 @@ import {
|
||||
RoomUserRoleEntity,
|
||||
RoomChannelPermissionEntity,
|
||||
ReactionEntity,
|
||||
CustomEmojiEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
MetaEntity,
|
||||
@@ -41,7 +42,14 @@ const RETRYABLE_SAVE_ERROR_CODES = new Set([
|
||||
'EBUSY'
|
||||
]);
|
||||
|
||||
let saveQueue: Promise<void> = Promise.resolve();
|
||||
interface PendingSaveWaiter {
|
||||
reject: (error: unknown) => void;
|
||||
resolve: () => void;
|
||||
}
|
||||
|
||||
let pendingSaveSnapshot: Buffer | null = null;
|
||||
let pendingSaveWaiters: PendingSaveWaiter[] = [];
|
||||
let saveInProgress = false;
|
||||
|
||||
function wait(ms: number): Promise<void> {
|
||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
||||
@@ -146,16 +154,51 @@ async function writeDatabaseSnapshot(snapshot: Buffer): Promise<void> {
|
||||
}
|
||||
}
|
||||
|
||||
function settleSaveWaiters(waiters: PendingSaveWaiter[], error?: unknown): void {
|
||||
for (const waiter of waiters) {
|
||||
if (error === undefined) {
|
||||
waiter.resolve();
|
||||
} else {
|
||||
waiter.reject(error);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function drainDatabaseSaveQueue(): Promise<void> {
|
||||
if (saveInProgress) {
|
||||
return;
|
||||
}
|
||||
|
||||
saveInProgress = true;
|
||||
|
||||
try {
|
||||
while (pendingSaveSnapshot) {
|
||||
const snapshot = pendingSaveSnapshot;
|
||||
const waiters = pendingSaveWaiters;
|
||||
|
||||
pendingSaveSnapshot = null;
|
||||
pendingSaveWaiters = [];
|
||||
|
||||
try {
|
||||
await writeDatabaseSnapshot(snapshot);
|
||||
settleSaveWaiters(waiters);
|
||||
} catch (error) {
|
||||
settleSaveWaiters(waiters, error);
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
saveInProgress = false;
|
||||
}
|
||||
}
|
||||
|
||||
async function atomicSave(data: Uint8Array): Promise<void> {
|
||||
const snapshot = Buffer.from(data);
|
||||
const saveTask = saveQueue.then(
|
||||
() => writeDatabaseSnapshot(snapshot),
|
||||
() => writeDatabaseSnapshot(snapshot)
|
||||
);
|
||||
|
||||
saveQueue = saveTask.catch(() => {});
|
||||
|
||||
return saveTask;
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
pendingSaveSnapshot = snapshot;
|
||||
pendingSaveWaiters.push({ resolve, reject });
|
||||
void drainDatabaseSaveQueue();
|
||||
});
|
||||
}
|
||||
|
||||
export async function initializeDatabase(): Promise<void> {
|
||||
@@ -182,6 +225,7 @@ export async function initializeDatabase(): Promise<void> {
|
||||
RoomUserRoleEntity,
|
||||
RoomChannelPermissionEntity,
|
||||
ReactionEntity,
|
||||
CustomEmojiEntity,
|
||||
BanEntity,
|
||||
AttachmentEntity,
|
||||
MetaEntity,
|
||||
|
||||
35
electron/entities/CustomEmojiEntity.ts
Normal file
35
electron/entities/CustomEmojiEntity.ts
Normal file
@@ -0,0 +1,35 @@
|
||||
import {
|
||||
Column,
|
||||
Entity,
|
||||
PrimaryColumn
|
||||
} from 'typeorm';
|
||||
|
||||
@Entity('custom_emojis')
|
||||
export class CustomEmojiEntity {
|
||||
@PrimaryColumn('text')
|
||||
id!: string;
|
||||
|
||||
@Column('text')
|
||||
name!: string;
|
||||
|
||||
@Column('text')
|
||||
creatorUserId!: string;
|
||||
|
||||
@Column('text')
|
||||
dataUrl!: string;
|
||||
|
||||
@Column('text')
|
||||
hash!: string;
|
||||
|
||||
@Column('text')
|
||||
mime!: string;
|
||||
|
||||
@Column('integer')
|
||||
size!: number;
|
||||
|
||||
@Column('integer')
|
||||
createdAt!: number;
|
||||
|
||||
@Column('integer')
|
||||
updatedAt!: number;
|
||||
}
|
||||
@@ -62,4 +62,7 @@ export class UserEntity {
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
screenShareState!: string | null;
|
||||
|
||||
@Column('text', { nullable: true })
|
||||
homeSignalServerUrl!: string | null;
|
||||
}
|
||||
|
||||
@@ -8,6 +8,7 @@ export { RoomRoleEntity } from './RoomRoleEntity';
|
||||
export { RoomUserRoleEntity } from './RoomUserRoleEntity';
|
||||
export { RoomChannelPermissionEntity } from './RoomChannelPermissionEntity';
|
||||
export { ReactionEntity } from './ReactionEntity';
|
||||
export { CustomEmojiEntity } from './CustomEmojiEntity';
|
||||
export { BanEntity } from './BanEntity';
|
||||
export { AttachmentEntity } from './AttachmentEntity';
|
||||
export { MetaEntity } from './MetaEntity';
|
||||
|
||||
@@ -62,6 +62,9 @@ import { listRunningProcessNames } from '../process-list';
|
||||
import { detectActiveGame } from '../game-detection';
|
||||
|
||||
const DEFAULT_MIME_TYPE = 'application/octet-stream';
|
||||
const MAX_ACTIVE_DESKTOP_NOTIFICATIONS = 20;
|
||||
const activeDesktopNotifications = new Set<Notification>();
|
||||
const desktopNotificationCleanups = new Map<Notification, () => void>();
|
||||
const FILE_CLIPBOARD_FORMATS = [
|
||||
'x-special/gnome-copied-files',
|
||||
'text/uri-list',
|
||||
@@ -399,9 +402,16 @@ export function setupSystemHandlers(): void {
|
||||
icon: getWindowIconPath(),
|
||||
silent: true
|
||||
});
|
||||
|
||||
notification.on('click', () => {
|
||||
const cleanup = () => {
|
||||
notification.removeListener('click', handleClick);
|
||||
notification.removeListener('close', cleanup);
|
||||
notification.removeListener('failed', cleanup);
|
||||
activeDesktopNotifications.delete(notification);
|
||||
desktopNotificationCleanups.delete(notification);
|
||||
};
|
||||
const handleClick = () => {
|
||||
if (!mainWindow) {
|
||||
cleanup();
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -414,7 +424,26 @@ export function setupSystemHandlers(): void {
|
||||
}
|
||||
|
||||
mainWindow.focus();
|
||||
});
|
||||
cleanup();
|
||||
notification.close();
|
||||
};
|
||||
|
||||
notification.on('click', handleClick);
|
||||
notification.once('close', cleanup);
|
||||
notification.once('failed', cleanup);
|
||||
activeDesktopNotifications.add(notification);
|
||||
desktopNotificationCleanups.set(notification, cleanup);
|
||||
|
||||
while (activeDesktopNotifications.size > MAX_ACTIVE_DESKTOP_NOTIFICATIONS) {
|
||||
const oldestNotification = activeDesktopNotifications.values().next().value;
|
||||
|
||||
if (!oldestNotification) {
|
||||
break;
|
||||
}
|
||||
|
||||
desktopNotificationCleanups.get(oldestNotification)?.();
|
||||
oldestNotification.close();
|
||||
}
|
||||
|
||||
notification.show();
|
||||
} catch {
|
||||
@@ -524,6 +553,29 @@ export function setupSystemHandlers(): void {
|
||||
return true;
|
||||
});
|
||||
|
||||
ipcMain.handle('copy-file', async (_event, sourceFilePath: string, destinationFilePath: string) => {
|
||||
if (typeof sourceFilePath !== 'string' || !sourceFilePath.trim()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (typeof destinationFilePath !== 'string' || !destinationFilePath.trim()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
try {
|
||||
const stats = await fsp.stat(sourceFilePath);
|
||||
|
||||
if (!stats.isFile()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
await fsp.copyFile(sourceFilePath, destinationFilePath);
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
});
|
||||
|
||||
ipcMain.handle('file-exists', async (_event, filePath: string) => {
|
||||
try {
|
||||
await fsp.access(filePath, fs.constants.F_OK);
|
||||
|
||||
27
electron/migrations/1000000000011-AddCustomEmojis.ts
Normal file
27
electron/migrations/1000000000011-AddCustomEmojis.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import { MigrationInterface, QueryRunner } from 'typeorm';
|
||||
|
||||
export class AddCustomEmojis1000000000011 implements MigrationInterface {
|
||||
name = 'AddCustomEmojis1000000000011';
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`CREATE TABLE IF NOT EXISTS "custom_emojis" (
|
||||
"id" TEXT PRIMARY KEY NOT NULL,
|
||||
"name" TEXT NOT NULL,
|
||||
"creatorUserId" TEXT NOT NULL,
|
||||
"dataUrl" TEXT NOT NULL,
|
||||
"hash" TEXT NOT NULL,
|
||||
"mime" TEXT NOT NULL,
|
||||
"size" INTEGER NOT NULL,
|
||||
"createdAt" INTEGER NOT NULL,
|
||||
"updatedAt" INTEGER NOT NULL
|
||||
)`);
|
||||
await queryRunner.query(`CREATE INDEX IF NOT EXISTS "idx_custom_emojis_updated_at" ON "custom_emojis" ("updatedAt")`);
|
||||
await queryRunner.query(`CREATE INDEX IF NOT EXISTS "idx_custom_emojis_creator" ON "custom_emojis" ("creatorUserId")`);
|
||||
}
|
||||
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`DROP INDEX IF EXISTS "idx_custom_emojis_creator"`);
|
||||
await queryRunner.query(`DROP INDEX IF EXISTS "idx_custom_emojis_updated_at"`);
|
||||
await queryRunner.query(`DROP TABLE IF EXISTS "custom_emojis"`);
|
||||
}
|
||||
}
|
||||
13
electron/migrations/1000000000012-AddHomeSignalServerUrl.ts
Normal file
13
electron/migrations/1000000000012-AddHomeSignalServerUrl.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
import { MigrationInterface, QueryRunner } from 'typeorm';
|
||||
|
||||
export class AddHomeSignalServerUrl1000000000012 implements MigrationInterface {
|
||||
name = 'AddHomeSignalServerUrl1000000000012';
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`ALTER TABLE "users" ADD COLUMN "homeSignalServerUrl" TEXT`);
|
||||
}
|
||||
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
// SQLite column removal requires table rebuilds. Keep rollback no-op.
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
import { contextBridge, ipcRenderer } from 'electron';
|
||||
import { contextBridge, ipcRenderer, webUtils } from 'electron';
|
||||
import { Command, Query } from './cqrs/types';
|
||||
|
||||
const LINUX_SCREEN_SHARE_MONITOR_AUDIO_CHUNK_CHANNEL = 'linux-screen-share-monitor-audio-chunk';
|
||||
@@ -310,6 +310,8 @@ export interface ElectronAPI {
|
||||
saveFileAs: (defaultFileName: string, data: string) => Promise<{ saved: boolean; cancelled: boolean }>;
|
||||
saveExistingFileAs: (sourceFilePath: string, defaultFileName: string) => Promise<{ saved: boolean; cancelled: boolean }>;
|
||||
openFilePath: (filePath: string) => Promise<{ opened: boolean; reason?: string }>;
|
||||
copyFile: (sourceFilePath: string, destinationFilePath: string) => Promise<boolean>;
|
||||
getPathForFile: (file: File) => string;
|
||||
fileExists: (filePath: string) => Promise<boolean>;
|
||||
getFileUrl: (filePath: string) => Promise<string | null>;
|
||||
deleteFile: (filePath: string) => Promise<boolean>;
|
||||
@@ -441,6 +443,8 @@ const electronAPI: ElectronAPI = {
|
||||
saveFileAs: (defaultFileName, data) => ipcRenderer.invoke('save-file-as', defaultFileName, data),
|
||||
saveExistingFileAs: (sourceFilePath, defaultFileName) => ipcRenderer.invoke('save-existing-file-as', sourceFilePath, defaultFileName),
|
||||
openFilePath: (filePath) => ipcRenderer.invoke('open-file-path', filePath),
|
||||
copyFile: (sourceFilePath, destinationFilePath) => ipcRenderer.invoke('copy-file', sourceFilePath, destinationFilePath),
|
||||
getPathForFile: (file) => webUtils.getPathForFile(file),
|
||||
fileExists: (filePath) => ipcRenderer.invoke('file-exists', filePath),
|
||||
getFileUrl: (filePath) => ipcRenderer.invoke('get-file-url', filePath),
|
||||
deleteFile: (filePath) => ipcRenderer.invoke('delete-file', filePath),
|
||||
|
||||
@@ -15,13 +15,21 @@ fi
|
||||
|
||||
mkdir -p "$CERT_DIR"
|
||||
|
||||
# Optional: include a LAN/public IP in the certificate SAN (required when clients connect by IP).
|
||||
# Example: SERVER_IP=46.59.68.77 ./generate-cert.sh
|
||||
SAN="DNS:localhost,IP:127.0.0.1,IP:0.0.0.0"
|
||||
if [ -n "${SERVER_IP:-}" ]; then
|
||||
SAN="$SAN,IP:$SERVER_IP"
|
||||
echo "Including SERVER_IP=$SERVER_IP in certificate SAN."
|
||||
fi
|
||||
|
||||
echo "Generating self-signed certificate..."
|
||||
openssl req -x509 -nodes -days 3650 \
|
||||
-newkey rsa:2048 \
|
||||
-keyout "$CERT_DIR/localhost.key" \
|
||||
-out "$CERT_DIR/localhost.crt" \
|
||||
-subj "/CN=localhost" \
|
||||
-addext "subjectAltName=DNS:localhost,IP:127.0.0.1,IP:0.0.0.0"
|
||||
-addext "subjectAltName=$SAN"
|
||||
|
||||
echo "Done. Certificate written to:"
|
||||
echo " $CERT_DIR/localhost.crt"
|
||||
|
||||
BIN
images/icon-new-transparent.png
Normal file
BIN
images/icon-new-transparent.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 279 KiB |
BIN
images/icon-new.png
Normal file
BIN
images/icon-new.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 949 KiB |
BIN
images/icon-transparent.png
Normal file
BIN
images/icon-transparent.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.1 MiB |
1008
package-lock.json
generated
1008
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
21
package.json
21
package.json
@@ -54,7 +54,13 @@
|
||||
"test:e2e": "cd e2e && npx playwright test",
|
||||
"test:e2e:ui": "cd e2e && npx playwright test --ui",
|
||||
"test:e2e:debug": "cd e2e && npx playwright test --debug",
|
||||
"test:e2e:report": "cd e2e && npx playwright show-report ../test-results/html-report"
|
||||
"test:e2e:report": "cd e2e && npx playwright show-report ../test-results/html-report",
|
||||
"cap:sync": "cd toju-app && npx cap sync",
|
||||
"cap:open:android": "node tools/cap-open-android.js",
|
||||
"cap:open:ios": "cd toju-app && npx cap open ios",
|
||||
"cap:apk:android": "bash tools/build-android-apk.sh",
|
||||
"cap:build:android": "npm run build:prod && npm run cap:sync && npm run cap:open:android",
|
||||
"cap:build:ios": "npm run build:prod && npm run cap:sync && npm run cap:open:ios"
|
||||
},
|
||||
"private": true,
|
||||
"packageManager": "npm@10.9.2",
|
||||
@@ -65,6 +71,15 @@
|
||||
"@angular/forms": "^21.0.0",
|
||||
"@angular/platform-browser": "^21.0.0",
|
||||
"@angular/router": "^21.0.0",
|
||||
"@capacitor-community/sqlite": "^8.1.0",
|
||||
"@capacitor/app": "^8.1.0",
|
||||
"@capacitor/camera": "^8.2.0",
|
||||
"@capacitor/core": "^8.4.0",
|
||||
"@capacitor/device": "^8.0.2",
|
||||
"@capacitor/filesystem": "^8.1.2",
|
||||
"@capacitor/local-notifications": "^8.2.0",
|
||||
"@capacitor/push-notifications": "^8.1.1",
|
||||
"@capgo/capacitor-audio-session": "^8.0.40",
|
||||
"@codemirror/commands": "^6.10.3",
|
||||
"@codemirror/lang-css": "^6.3.1",
|
||||
"@codemirror/lang-json": "^6.0.2",
|
||||
@@ -83,6 +98,7 @@
|
||||
"@spartan-ng/brain": "^0.0.1-alpha.589",
|
||||
"@spartan-ng/cli": "^0.0.1-alpha.589",
|
||||
"@spartan-ng/ui-core": "^0.0.1-alpha.380",
|
||||
"@tanstack/angular-virtual": "^5.0.0",
|
||||
"@timephy/rnnoise-wasm": "^1.0.0",
|
||||
"auto-launch": "^5.0.6",
|
||||
"class-variance-authority": "^0.7.1",
|
||||
@@ -111,6 +127,9 @@
|
||||
"@angular/build": "^21.0.4",
|
||||
"@angular/cli": "^21.0.4",
|
||||
"@angular/compiler-cli": "^21.0.0",
|
||||
"@capacitor/android": "^8.4.0",
|
||||
"@capacitor/cli": "^8.4.0",
|
||||
"@capacitor/ios": "^8.4.0",
|
||||
"@eslint/js": "^9.39.3",
|
||||
"@playwright/test": "^1.59.1",
|
||||
"@stylistic/eslint-plugin-js": "^4.4.1",
|
||||
|
||||
165
project-files/themes/toju-website-dark.json
Normal file
165
project-files/themes/toju-website-dark.json
Normal file
@@ -0,0 +1,165 @@
|
||||
{
|
||||
"meta": {
|
||||
"name": "Toju Website Dark",
|
||||
"version": "1.0.0",
|
||||
"description": "Website-inspired dark app theme using the charcoal, green, and amber palette from the public Toju site."
|
||||
},
|
||||
"css": "/* Website-inspired app shell surfaces */\napp-chat-messages .chat-layout,\napp-dm-chat .chat-layout {\n background-image: linear-gradient(180deg, hsl(var(--workspace-background) / 0.96), hsl(var(--background)) 38rem) !important;\n}\n\napp-chat-message-list > div {\n background: transparent !important;\n}\n\napp-chat-message-item > div[data-message-id] {\n margin: 8px 0 !important;\n border: 1px solid hsl(var(--border) / 0.56) !important;\n border-radius: 0.7rem !important;\n background: hsl(var(--card) / 0.72) !important;\n box-shadow: 0 14px 34px rgb(0 0 0 / 0.2) !important;\n backdrop-filter: blur(12px) saturate(120%) !important;\n -webkit-backdrop-filter: blur(12px) saturate(120%) !important;\n}\n\napp-chat-message-item > div[data-message-id]:hover {\n border-color: hsl(var(--primary) / 0.42) !important;\n background: hsl(var(--card) / 0.84) !important;\n}\n\napp-chat-message-composer,\n.chat-bottom-bar {\n border-top: 0 !important;\n background: hsl(var(--background) / 0.84) !important;\n backdrop-filter: blur(16px) saturate(125%) !important;\n -webkit-backdrop-filter: blur(16px) saturate(125%) !important;\n}\n\napp-chat-message-composer textarea,\napp-chat-message-composer [contenteditable=\"true\"] {\n background: hsl(var(--panel-background-alt) / 0.8) !important;\n}\n",
|
||||
"tokens": {
|
||||
"colors": {
|
||||
"background": "210 18% 7%",
|
||||
"foreground": "42 33% 94%",
|
||||
"card": "210 17% 10%",
|
||||
"cardForeground": "42 33% 94%",
|
||||
"popover": "210 17% 9%",
|
||||
"popoverForeground": "42 33% 94%",
|
||||
"primary": "154 49% 55%",
|
||||
"primaryForeground": "210 18% 7%",
|
||||
"secondary": "210 14% 15%",
|
||||
"secondaryForeground": "42 33% 94%",
|
||||
"muted": "210 14% 15%",
|
||||
"mutedForeground": "42 13% 67%",
|
||||
"accent": "38 64% 61%",
|
||||
"accentForeground": "210 18% 7%",
|
||||
"destructive": "0 72% 55%",
|
||||
"destructiveForeground": "0 0% 100%",
|
||||
"border": "210 13% 22%",
|
||||
"input": "210 13% 22%",
|
||||
"ring": "154 49% 55%",
|
||||
"railBackground": "210 19% 6%",
|
||||
"workspaceBackground": "210 18% 8%",
|
||||
"panelBackground": "210 17% 10%",
|
||||
"panelBackgroundAlt": "210 14% 13%",
|
||||
"titleBarBackground": "210 19% 6%",
|
||||
"surfaceHighlight": "154 49% 55%",
|
||||
"surfaceHighlightAlt": "38 64% 61%"
|
||||
},
|
||||
"spacing": {},
|
||||
"radii": {
|
||||
"radius": "0.6rem",
|
||||
"surface": "0.85rem",
|
||||
"pill": "999px"
|
||||
},
|
||||
"effects": {
|
||||
"panelShadow": "0 28px 64px rgba(0, 0, 0, 0.34)",
|
||||
"softShadow": "0 16px 36px rgba(0, 0, 0, 0.22)",
|
||||
"glassBlur": "blur(16px) saturate(125%)"
|
||||
}
|
||||
},
|
||||
"layout": {
|
||||
"serversRail": {
|
||||
"container": "appShell",
|
||||
"grid": {
|
||||
"x": 0,
|
||||
"y": 0,
|
||||
"w": 1,
|
||||
"h": 1
|
||||
}
|
||||
},
|
||||
"appWorkspace": {
|
||||
"container": "appShell",
|
||||
"grid": {
|
||||
"x": 1,
|
||||
"y": 0,
|
||||
"w": 19,
|
||||
"h": 1
|
||||
}
|
||||
},
|
||||
"chatRoomChannelsPanel": {
|
||||
"container": "roomLayout",
|
||||
"grid": {
|
||||
"x": 0,
|
||||
"y": 0,
|
||||
"w": 4,
|
||||
"h": 12
|
||||
}
|
||||
},
|
||||
"chatRoomMainPanel": {
|
||||
"container": "roomLayout",
|
||||
"grid": {
|
||||
"x": 4,
|
||||
"y": 0,
|
||||
"w": 12,
|
||||
"h": 12
|
||||
}
|
||||
},
|
||||
"chatRoomMembersPanel": {
|
||||
"container": "roomLayout",
|
||||
"grid": {
|
||||
"x": 16,
|
||||
"y": 0,
|
||||
"w": 4,
|
||||
"h": 12
|
||||
}
|
||||
},
|
||||
"dmConversationsPanel": {
|
||||
"container": "dmLayout",
|
||||
"grid": {
|
||||
"x": 0,
|
||||
"y": 0,
|
||||
"w": 4,
|
||||
"h": 12
|
||||
}
|
||||
},
|
||||
"dmChatPanel": {
|
||||
"container": "dmLayout",
|
||||
"grid": {
|
||||
"x": 4,
|
||||
"y": 0,
|
||||
"w": 16,
|
||||
"h": 12
|
||||
}
|
||||
}
|
||||
},
|
||||
"elements": {
|
||||
"titleBar": {
|
||||
"border": "0",
|
||||
"backgroundColor": "hsl(var(--title-bar-background) / 0.88)",
|
||||
"boxShadow": "0 12px 28px rgba(0, 0, 0, 0.22)",
|
||||
"backdropFilter": "var(--theme-effect-glass-blur)"
|
||||
},
|
||||
"serversRail": {
|
||||
"border": "0",
|
||||
"backgroundColor": "hsl(var(--rail-background) / 0.94)",
|
||||
"boxShadow": "var(--theme-effect-panel-shadow)"
|
||||
},
|
||||
"appWorkspace": {
|
||||
"backgroundColor": "hsl(var(--workspace-background))"
|
||||
},
|
||||
"chatRoomChannelsPanel": {
|
||||
"border": "0",
|
||||
"backgroundColor": "hsl(var(--panel-background) / 0.86)",
|
||||
"backdropFilter": "var(--theme-effect-glass-blur)"
|
||||
},
|
||||
"chatRoomMembersPanel": {
|
||||
"border": "0",
|
||||
"backgroundColor": "hsl(var(--panel-background) / 0.82)",
|
||||
"backdropFilter": "var(--theme-effect-glass-blur)"
|
||||
},
|
||||
"chatRoomMainPanel": {
|
||||
"backgroundColor": "hsl(var(--workspace-background))"
|
||||
},
|
||||
"chatSurface": {
|
||||
"backgroundColor": "transparent"
|
||||
},
|
||||
"chatMessageBubble": {
|
||||
"border": "1px solid hsl(var(--border) / 0.56)",
|
||||
"borderRadius": "0.7rem",
|
||||
"backgroundColor": "hsl(var(--card) / 0.72)",
|
||||
"boxShadow": "var(--theme-effect-soft-shadow)",
|
||||
"backdropFilter": "blur(12px) saturate(120%)"
|
||||
},
|
||||
"chatComposerBar": {
|
||||
"border": "0",
|
||||
"backgroundColor": "hsl(var(--background) / 0.84)",
|
||||
"backdropFilter": "var(--theme-effect-glass-blur)"
|
||||
},
|
||||
"chatComposerInput": {
|
||||
"border": "1px solid hsl(var(--border) / 0.6)",
|
||||
"borderRadius": "0.6rem",
|
||||
"backgroundColor": "hsl(var(--panel-background-alt) / 0.8)",
|
||||
"color": "hsl(var(--foreground))"
|
||||
}
|
||||
},
|
||||
"animations": {}
|
||||
}
|
||||
25
server/AGENTS.md
Normal file
25
server/AGENTS.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Server Guidelines
|
||||
|
||||
This directory contains the Node/TypeScript signaling server, server-directory API, and websocket runtime.
|
||||
|
||||
## Workflow
|
||||
|
||||
- Use `cd server && npm run dev`, `cd server && npm run build`, and `cd server && npm run start`, or the root aliases `npm run server:dev` and `npm run server:build`.
|
||||
- Start tracing behavior from `src/index.ts`, then follow into `src/app/`, `src/websocket/`, and the config or CQRS modules involved.
|
||||
- See `../doc/typescript.md` for shared TypeScript rules.
|
||||
|
||||
## Boundaries
|
||||
|
||||
- Keep bootstrap concerns in `src/index.ts` small and move request, websocket, or data behavior into focused modules.
|
||||
- Keep configuration and runtime path handling separate from transport or business logic.
|
||||
- Prefer explicit modules for HTTP, websocket, database, and configuration responsibilities instead of growing god files.
|
||||
|
||||
## Config And Output
|
||||
|
||||
- Server runtime config comes from the repository root `.env` and `server/data/variables.json`.
|
||||
- If `serverProtocol` is `https`, certificate files must exist before startup.
|
||||
- Treat `server/dist/` and bundled output under `dist-server/` as generated.
|
||||
|
||||
## Before You Finish
|
||||
|
||||
- Validate whether relevant markdown docs or `AGENTS.md` files need updates. If behavior, workflows, commands, or architecture changed, update those docs in the same task.
|
||||
57
server/CONTEXT.md
Normal file
57
server/CONTEXT.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Signaling Server (server)
|
||||
|
||||
Owns the shared, internet-reachable runtime: HTTP routes for server directory / invites / join requests / link metadata, WebSocket signaling between clients (P2P session setup, presence, status), CQRS command and query handlers, and the shared TypeORM + sql.js persistence layer that holds signaling state.
|
||||
|
||||
> **Format reference:**
|
||||
> - **Vocabulary** — bold term, one-sentence definition, aliases to avoid.
|
||||
> - **Relationships** — bullets with bold terms and cardinality.
|
||||
> - **Boundaries / IO** — what this subdomain exposes and consumes.
|
||||
> - **Invariants** — rules that always hold.
|
||||
> - **Flagged ambiguities** — terms in dispute with proposed resolutions.
|
||||
>
|
||||
> See `agents-docs/AGENTS_CONTEXT.md` for the contract. Update in the same turn a trigger fires (see `agents-docs/AGENT_WORKFLOW.md` § CONTEXT.md upkeep).
|
||||
|
||||
## Vocabulary
|
||||
|
||||
| Term | Definition | Aliases to avoid |
|
||||
|------|------------|------------------|
|
||||
| **Envelope** | The on-the-wire shape of a WebSocket message — `type`, `payload`, and routing metadata, typed in `src/websocket/types.ts` and mirrored in `toju-app/src/app/shared-kernel/signaling-contracts.ts`. | "packet", "frame" |
|
||||
| **Handler** | A WebSocket message handler registered in `src/websocket/handler.ts`; one per envelope type. | "listener" |
|
||||
| **CQRS command/query** | A typed request dispatched through `src/cqrs/` — commands mutate state, queries read it; both return a typed result. | "action" (NgRx term) |
|
||||
| **Server directory** | The catalog of joinable chat servers, exposed by `src/routes/servers.ts` plus invite and join-request routes. | "guild list" |
|
||||
| **SSRF guard** | The outbound-fetch policy enforced by `src/routes/ssrf-guard.ts` — gates link-metadata and proxy routes that fetch user-supplied URLs. | "proxy filter" |
|
||||
| **Variables file** | `data/variables.json` — runtime config (klipy key, server host/protocol, release manifest URL, link-preview toggle) normalized on startup. | "config", ".env" (those are separate) |
|
||||
|
||||
## Relationships
|
||||
|
||||
- A **WebSocket connection** carries many **Envelopes**; each envelope is routed to exactly one **Handler**.
|
||||
- A **Route** (HTTP) may dispatch zero or more **CQRS commands/queries** to mutate or read persistent state.
|
||||
- The **Server directory** depends on **Invites** and **Join requests** — listing, accepting, and revoking flows are split across `routes/servers.ts`, `routes/invites.ts`, `routes/join-requests.ts`.
|
||||
- **Persistence** entities in `src/entities/` are owned by this subdomain and never shipped to the renderer; the wire envelope is the contract instead.
|
||||
- **SSRF guard** is consumed by `link-metadata`, `proxy`, and `klipy` routes that fetch user-supplied URLs.
|
||||
|
||||
## Boundaries / IO
|
||||
|
||||
- **Exposes:**
|
||||
- HTTP routes under `src/routes/`: `health`, `users`, `servers`, `invites`, `join-requests`, `games`, `klipy`, `link-metadata`, `proxy`, `plugin-support`, `openapi-docs`.
|
||||
- WebSocket envelopes typed in `src/websocket/types.ts` — the realtime contract shared with `toju-app/src/app/shared-kernel/signaling-contracts.ts`.
|
||||
- OpenAPI document served by `openapi-docs` route.
|
||||
- **Consumes:**
|
||||
- The shared TypeORM SQLite database via `src/db/` (entities in `src/entities/`, migrations in `src/migrations/`).
|
||||
- `data/variables.json` for runtime configuration; `.env` for `PORT` / SSL toggles.
|
||||
- Optional outbound HTTP for link previews and klipy (all gated by **SSRF guard**).
|
||||
|
||||
## Invariants
|
||||
|
||||
- Every database schema change ships as a TypeORM **migration**; the live database is never mutated outside the migration system.
|
||||
- WebSocket **Envelope** types are defined once in `src/websocket/types.ts` and **must** stay structurally compatible with `toju-app/src/app/shared-kernel/signaling-contracts.ts` — drift between the two is a wire-protocol break.
|
||||
- User-supplied URLs are **never** fetched without going through `ssrf-guard.ts`.
|
||||
- Secrets (klipy API key, OAuth tokens, signing keys) live in `data/variables.json` or environment variables — never in code, never in logs.
|
||||
|
||||
## Flagged ambiguities
|
||||
|
||||
- _None recorded yet — add entries when an envelope type or route name resists clean definition._
|
||||
|
||||
---
|
||||
|
||||
*Agent-procedural rules (TDD, lint, build) live in `/AGENTS.md`. WebSocket envelope schemas and HTTP request/response shapes belong in `agents-docs/features/` when they cross subdomain boundaries. This file is the bounded-context domain artefact for the signaling server.*
|
||||
@@ -19,9 +19,10 @@ Node/TypeScript signaling server for MetoYou / Toju. This package owns the publi
|
||||
- The server loads the repository-root `.env` file on startup.
|
||||
- `SSL` can override the effective HTTP protocol, and `PORT` can override the effective port.
|
||||
- `DB_PATH` can override the SQLite database file location.
|
||||
- `data/variables.json` is normalized on startup and stores `klipyApiKey`, `rawgApiKey`, `releaseManifestUrl`, `serverPort`, `serverProtocol`, `serverHost`, and `linkPreview`.
|
||||
- `data/variables.json` is normalized on startup and stores `klipyApiKey`, `rawgApiKey`, `releaseManifestUrl`, `serverPort`, `serverProtocol`, `serverHost`, `serverTag`, and `linkPreview`. When `serverTag` is empty, `GET /api/health` falls back to the server's public URL.
|
||||
- `openApiDocs.enabled` in `data/variables.json`, or `OPENAPI_DOCS_ENABLED=true`, exposes the plugin support OpenAPI document at `/api/openapi.json` and a small docs page at `/api/docs`. It is disabled by default. Plugin support is metadata-only: the server stores install requirements and event definitions, but arbitrary plugin data persistence is disabled.
|
||||
- `RAWG_API_KEY` can override `rawgApiKey` for the `/api/games/match` now-playing metadata resolver. Successful matches include a preferred store link from RAWG store metadata, with Steam selected first when available. Negative game-match results are stored in the SQLite `game_match_misses` table so non-game process names do not repeatedly consume RAWG quota.
|
||||
- Mobile push dispatch uses optional credentials from the repository-root `.env` file (see `.env.example`): `FCM_SERVICE_ACCOUNT_PATH` or `FCM_SERVICE_ACCOUNT_JSON` for Android, and `APNS_KEY_PATH` / `APNS_KEY_ID` / `APNS_TEAM_ID` (+ optional `APNS_BUNDLE_ID`, `APNS_USE_SANDBOX`) for iOS. Device tokens are stored in the SQLite `device_tokens` table via `POST /api/users/device-tokens`.
|
||||
- Packaged server builds store `metoyou.sqlite` in the OS app-data directory by default so upgrades do not overwrite runtime data. On first start, the server copies forward legacy packaged databases that still live beside the executable.
|
||||
- When HTTPS is enabled, certificates are read from the repository `.certs/` directory.
|
||||
|
||||
|
||||
Binary file not shown.
33
server/src/config/signal-server-tag.ts
Normal file
33
server/src/config/signal-server-tag.ts
Normal file
@@ -0,0 +1,33 @@
|
||||
import type { ServerHttpProtocol } from './variables';
|
||||
|
||||
function formatHostForUrl(host: string): string {
|
||||
if (host.startsWith('[') || !host.includes(':')) {
|
||||
return host;
|
||||
}
|
||||
|
||||
return `[${host}]`;
|
||||
}
|
||||
|
||||
function getDisplayHost(serverHost: string | undefined): string {
|
||||
if (!serverHost || serverHost === '0.0.0.0' || serverHost === '::') {
|
||||
return 'localhost';
|
||||
}
|
||||
|
||||
return serverHost;
|
||||
}
|
||||
|
||||
export function buildSignalServerPublicUrl(
|
||||
serverProtocol: ServerHttpProtocol,
|
||||
serverHost: string | undefined,
|
||||
serverPort: number
|
||||
): string {
|
||||
const displayHost = formatHostForUrl(getDisplayHost(serverHost));
|
||||
|
||||
return `${serverProtocol}://${displayHost}:${serverPort}`;
|
||||
}
|
||||
|
||||
export function resolveSignalServerTag(configuredTag: string | undefined, publicUrl: string): string {
|
||||
const normalizedTag = configuredTag?.trim();
|
||||
|
||||
return normalizedTag || publicUrl;
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import { resolveRuntimePath } from '../runtime-paths';
|
||||
import { buildSignalServerPublicUrl, resolveSignalServerTag } from './signal-server-tag';
|
||||
|
||||
export type ServerHttpProtocol = 'http' | 'https';
|
||||
|
||||
@@ -21,6 +22,7 @@ export interface ServerVariablesConfig {
|
||||
serverPort: number;
|
||||
serverProtocol: ServerHttpProtocol;
|
||||
serverHost: string;
|
||||
serverTag: string;
|
||||
linkPreview: LinkPreviewConfig;
|
||||
openApiDocs: OpenApiDocsConfig;
|
||||
}
|
||||
@@ -49,6 +51,10 @@ function normalizeServerHost(value: unknown): string {
|
||||
return typeof value === 'string' ? value.trim() : '';
|
||||
}
|
||||
|
||||
function normalizeServerTag(value: unknown): string {
|
||||
return typeof value === 'string' ? value.trim() : '';
|
||||
}
|
||||
|
||||
function normalizeServerProtocol(
|
||||
value: unknown,
|
||||
fallback: ServerHttpProtocol = DEFAULT_SERVER_PROTOCOL
|
||||
@@ -162,6 +168,7 @@ export function ensureVariablesConfig(): ServerVariablesConfig {
|
||||
serverPort: normalizeServerPort(remainingParsed.serverPort),
|
||||
serverProtocol: normalizeServerProtocol(remainingParsed.serverProtocol),
|
||||
serverHost: normalizeServerHost(remainingParsed.serverHost ?? legacyServerIpAddress),
|
||||
serverTag: normalizeServerTag(remainingParsed.serverTag),
|
||||
linkPreview: normalizeLinkPreviewConfig(remainingParsed.linkPreview),
|
||||
openApiDocs: normalizeOpenApiDocsConfig(remainingParsed.openApiDocs)
|
||||
};
|
||||
@@ -178,6 +185,7 @@ export function ensureVariablesConfig(): ServerVariablesConfig {
|
||||
serverPort: normalized.serverPort,
|
||||
serverProtocol: normalized.serverProtocol,
|
||||
serverHost: normalized.serverHost,
|
||||
serverTag: normalized.serverTag,
|
||||
linkPreview: normalized.linkPreview,
|
||||
openApiDocs: normalized.openApiDocs
|
||||
};
|
||||
@@ -229,6 +237,18 @@ export function getServerHost(): string | undefined {
|
||||
return serverHost || undefined;
|
||||
}
|
||||
|
||||
export function getSignalServerPublicUrl(): string {
|
||||
const config = getVariablesConfig();
|
||||
|
||||
return buildSignalServerPublicUrl(config.serverProtocol, config.serverHost, config.serverPort);
|
||||
}
|
||||
|
||||
export function getServerTag(): string {
|
||||
const config = getVariablesConfig();
|
||||
|
||||
return resolveSignalServerTag(config.serverTag, getSignalServerPublicUrl());
|
||||
}
|
||||
|
||||
export function isHttpsServerEnabled(): boolean {
|
||||
return getServerProtocol() === 'https';
|
||||
}
|
||||
|
||||
@@ -15,6 +15,8 @@ import { handleDeleteStaleJoinRequests } from './commands/handlers/deleteStaleJo
|
||||
import { handleGetUserByUsername } from './queries/handlers/getUserByUsername';
|
||||
import { handleGetUserById } from './queries/handlers/getUserById';
|
||||
import { handleGetAllPublicServers } from './queries/handlers/getAllPublicServers';
|
||||
import { handleGetFeaturedServers } from './queries/handlers/getFeaturedServers';
|
||||
import { handleGetTrendingServers } from './queries/handlers/getTrendingServers';
|
||||
import { handleGetServerById } from './queries/handlers/getServerById';
|
||||
import { handleGetJoinRequestById } from './queries/handlers/getJoinRequestById';
|
||||
import { handleGetPendingRequestsForServer } from './queries/handlers/getPendingRequestsForServer';
|
||||
@@ -46,6 +48,12 @@ export const getUserById = (userId: string) =>
|
||||
export const getAllPublicServers = () =>
|
||||
handleGetAllPublicServers(getDataSource());
|
||||
|
||||
export const getFeaturedServers = (limit?: number) =>
|
||||
handleGetFeaturedServers(getDataSource(), limit);
|
||||
|
||||
export const getTrendingServers = (limit?: number) =>
|
||||
handleGetTrendingServers(getDataSource(), limit);
|
||||
|
||||
export const getServerById = (serverId: string) =>
|
||||
handleGetServerById({ type: QueryType.GetServerById, payload: { serverId } }, getDataSource());
|
||||
|
||||
|
||||
16
server/src/cqrs/queries/handlers/getFeaturedServers.ts
Normal file
16
server/src/cqrs/queries/handlers/getFeaturedServers.ts
Normal file
@@ -0,0 +1,16 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { ServerEntity } from '../../../entities';
|
||||
import { rowToServer } from '../../mappers';
|
||||
import { loadServerRelationsMap } from '../../relations';
|
||||
import { loadMembershipCounts, rankFeaturedServers } from './server-ranking.util';
|
||||
|
||||
const DEFAULT_LIMIT = 12;
|
||||
|
||||
export async function handleGetFeaturedServers(dataSource: DataSource, limit = DEFAULT_LIMIT) {
|
||||
const rows = await dataSource.getRepository(ServerEntity).find({ where: { isPrivate: 0 } });
|
||||
const counts = await loadMembershipCounts(dataSource, rows.map((row) => row.id));
|
||||
const ranked = rankFeaturedServers(rows, counts, limit);
|
||||
const relationsByServerId = await loadServerRelationsMap(dataSource, ranked.map((row) => row.id));
|
||||
|
||||
return ranked.map((row) => rowToServer(row, relationsByServerId.get(row.id)));
|
||||
}
|
||||
16
server/src/cqrs/queries/handlers/getTrendingServers.ts
Normal file
16
server/src/cqrs/queries/handlers/getTrendingServers.ts
Normal file
@@ -0,0 +1,16 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { ServerEntity } from '../../../entities';
|
||||
import { rowToServer } from '../../mappers';
|
||||
import { loadServerRelationsMap } from '../../relations';
|
||||
import { loadMembershipCounts, rankTrendingServers } from './server-ranking.util';
|
||||
|
||||
const DEFAULT_LIMIT = 12;
|
||||
|
||||
export async function handleGetTrendingServers(dataSource: DataSource, limit = DEFAULT_LIMIT) {
|
||||
const rows = await dataSource.getRepository(ServerEntity).find({ where: { isPrivate: 0 } });
|
||||
const counts = await loadMembershipCounts(dataSource, rows.map((row) => row.id));
|
||||
const ranked = rankTrendingServers(rows, counts, limit);
|
||||
const relationsByServerId = await loadServerRelationsMap(dataSource, ranked.map((row) => row.id));
|
||||
|
||||
return ranked.map((row) => rowToServer(row, relationsByServerId.get(row.id)));
|
||||
}
|
||||
142
server/src/cqrs/queries/handlers/server-ranking.util.spec.ts
Normal file
142
server/src/cqrs/queries/handlers/server-ranking.util.spec.ts
Normal file
@@ -0,0 +1,142 @@
|
||||
import {
|
||||
describe,
|
||||
it,
|
||||
expect
|
||||
} from 'vitest';
|
||||
import {
|
||||
rankFeaturedServers,
|
||||
rankTrendingServers,
|
||||
RankableServer
|
||||
} from './server-ranking.util';
|
||||
|
||||
function server(id: string, lastSeen: number): RankableServer {
|
||||
return { id, lastSeen };
|
||||
}
|
||||
|
||||
describe('rankFeaturedServers', () => {
|
||||
it('orders by membership count descending', () => {
|
||||
const rows = [
|
||||
server('a', 100),
|
||||
server('b', 100),
|
||||
server('c', 100)
|
||||
];
|
||||
const counts = new Map([
|
||||
['a', 2],
|
||||
['b', 10],
|
||||
['c', 5]
|
||||
]);
|
||||
const ranked = rankFeaturedServers(rows, counts);
|
||||
|
||||
expect(ranked.map((row) => row.id)).toEqual([
|
||||
'b',
|
||||
'c',
|
||||
'a'
|
||||
]);
|
||||
});
|
||||
|
||||
it('breaks membership ties by most recent activity', () => {
|
||||
const rows = [
|
||||
server('a', 50),
|
||||
server('b', 200),
|
||||
server('c', 120)
|
||||
];
|
||||
const counts = new Map([
|
||||
['a', 5],
|
||||
['b', 5],
|
||||
['c', 5]
|
||||
]);
|
||||
const ranked = rankFeaturedServers(rows, counts);
|
||||
|
||||
expect(ranked.map((row) => row.id)).toEqual([
|
||||
'b',
|
||||
'c',
|
||||
'a'
|
||||
]);
|
||||
});
|
||||
|
||||
it('treats missing counts as zero', () => {
|
||||
const rows = [server('a', 10), server('b', 10)];
|
||||
const counts = new Map([['a', 1]]);
|
||||
const ranked = rankFeaturedServers(rows, counts);
|
||||
|
||||
expect(ranked.map((row) => row.id)).toEqual(['a', 'b']);
|
||||
});
|
||||
|
||||
it('applies the limit', () => {
|
||||
const rows = [
|
||||
server('a', 1),
|
||||
server('b', 2),
|
||||
server('c', 3)
|
||||
];
|
||||
const counts = new Map([
|
||||
['a', 3],
|
||||
['b', 2],
|
||||
['c', 1]
|
||||
]);
|
||||
|
||||
expect(rankFeaturedServers(rows, counts, 2).map((row) => row.id)).toEqual(['a', 'b']);
|
||||
});
|
||||
|
||||
it('returns an empty array for a non-positive limit', () => {
|
||||
const rows = [server('a', 1)];
|
||||
|
||||
expect(rankFeaturedServers(rows, new Map(), 0)).toEqual([]);
|
||||
expect(rankFeaturedServers(rows, new Map(), -5)).toEqual([]);
|
||||
});
|
||||
|
||||
it('does not mutate the input rows', () => {
|
||||
const rows = [server('a', 1), server('b', 2)];
|
||||
|
||||
rankFeaturedServers(rows, new Map([['b', 9]]));
|
||||
|
||||
expect(rows.map((row) => row.id)).toEqual(['a', 'b']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('rankTrendingServers', () => {
|
||||
it('orders by most recent activity descending', () => {
|
||||
const rows = [
|
||||
server('a', 100),
|
||||
server('b', 300),
|
||||
server('c', 200)
|
||||
];
|
||||
const counts = new Map<string, number>();
|
||||
const ranked = rankTrendingServers(rows, counts);
|
||||
|
||||
expect(ranked.map((row) => row.id)).toEqual([
|
||||
'b',
|
||||
'c',
|
||||
'a'
|
||||
]);
|
||||
});
|
||||
|
||||
it('breaks activity ties by membership count', () => {
|
||||
const rows = [
|
||||
server('a', 100),
|
||||
server('b', 100),
|
||||
server('c', 100)
|
||||
];
|
||||
const counts = new Map([
|
||||
['a', 1],
|
||||
['b', 9],
|
||||
['c', 4]
|
||||
]);
|
||||
const ranked = rankTrendingServers(rows, counts);
|
||||
|
||||
expect(ranked.map((row) => row.id)).toEqual([
|
||||
'b',
|
||||
'c',
|
||||
'a'
|
||||
]);
|
||||
});
|
||||
|
||||
it('applies the limit', () => {
|
||||
const rows = [
|
||||
server('a', 1),
|
||||
server('b', 2),
|
||||
server('c', 3)
|
||||
];
|
||||
|
||||
expect(rankTrendingServers(rows, new Map(), 1).map((row) => row.id)).toEqual(['c']);
|
||||
});
|
||||
});
|
||||
94
server/src/cqrs/queries/handlers/server-ranking.util.ts
Normal file
94
server/src/cqrs/queries/handlers/server-ranking.util.ts
Normal file
@@ -0,0 +1,94 @@
|
||||
import { DataSource } from 'typeorm';
|
||||
import { ServerMembershipEntity } from '../../../entities';
|
||||
|
||||
export interface RankableServer {
|
||||
id: string;
|
||||
lastSeen: number;
|
||||
}
|
||||
|
||||
const DEFAULT_LIMIT = 12;
|
||||
|
||||
function clampLimit(limit: number): number {
|
||||
if (!Number.isFinite(limit) || limit <= 0) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
return Math.floor(limit);
|
||||
}
|
||||
|
||||
function membershipCount(counts: Map<string, number>, id: string): number {
|
||||
return counts.get(id) ?? 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Featured = most-populated public servers. Ranks by membership count descending,
|
||||
* breaking ties by most recent activity (`lastSeen`).
|
||||
*/
|
||||
export function rankFeaturedServers<T extends RankableServer>(
|
||||
rows: readonly T[],
|
||||
counts: Map<string, number>,
|
||||
limit: number = DEFAULT_LIMIT
|
||||
): T[] {
|
||||
return [...rows]
|
||||
.sort((first, second) => {
|
||||
const countDelta = membershipCount(counts, second.id) - membershipCount(counts, first.id);
|
||||
|
||||
if (countDelta !== 0) {
|
||||
return countDelta;
|
||||
}
|
||||
|
||||
return (second.lastSeen ?? 0) - (first.lastSeen ?? 0);
|
||||
})
|
||||
.slice(0, clampLimit(limit));
|
||||
}
|
||||
|
||||
/**
|
||||
* Trending = recently-active public servers. Ranks by most recent activity
|
||||
* (`lastSeen`) descending, breaking ties by membership count.
|
||||
*/
|
||||
export function rankTrendingServers<T extends RankableServer>(
|
||||
rows: readonly T[],
|
||||
counts: Map<string, number>,
|
||||
limit: number = DEFAULT_LIMIT
|
||||
): T[] {
|
||||
return [...rows]
|
||||
.sort((first, second) => {
|
||||
const activityDelta = (second.lastSeen ?? 0) - (first.lastSeen ?? 0);
|
||||
|
||||
if (activityDelta !== 0) {
|
||||
return activityDelta;
|
||||
}
|
||||
|
||||
return membershipCount(counts, second.id) - membershipCount(counts, first.id);
|
||||
})
|
||||
.slice(0, clampLimit(limit));
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads membership counts for the supplied server ids in a single grouped query.
|
||||
*/
|
||||
export async function loadMembershipCounts(
|
||||
dataSource: DataSource,
|
||||
serverIds: readonly string[]
|
||||
): Promise<Map<string, number>> {
|
||||
const counts = new Map<string, number>();
|
||||
|
||||
if (serverIds.length === 0) {
|
||||
return counts;
|
||||
}
|
||||
|
||||
const rows = await dataSource
|
||||
.getRepository(ServerMembershipEntity)
|
||||
.createQueryBuilder('membership')
|
||||
.select('membership.serverId', 'serverId')
|
||||
.addSelect('COUNT(membership.id)', 'count')
|
||||
.where('membership.serverId IN (:...serverIds)', { serverIds: [...serverIds] })
|
||||
.groupBy('membership.serverId')
|
||||
.getRawMany<{ serverId: string; count: string | number }>();
|
||||
|
||||
for (const row of rows) {
|
||||
counts.set(row.serverId, Number(row.count) || 0);
|
||||
}
|
||||
|
||||
return counts;
|
||||
}
|
||||
@@ -12,6 +12,8 @@ import {
|
||||
import { handleGetUserByUsername } from './handlers/getUserByUsername';
|
||||
import { handleGetUserById } from './handlers/getUserById';
|
||||
import { handleGetAllPublicServers } from './handlers/getAllPublicServers';
|
||||
import { handleGetFeaturedServers } from './handlers/getFeaturedServers';
|
||||
import { handleGetTrendingServers } from './handlers/getTrendingServers';
|
||||
import { handleGetServerById } from './handlers/getServerById';
|
||||
import { handleGetJoinRequestById } from './handlers/getJoinRequestById';
|
||||
import { handleGetPendingRequestsForServer } from './handlers/getPendingRequestsForServer';
|
||||
@@ -20,6 +22,8 @@ export const buildQueryHandlers = (dataSource: DataSource): Record<QueryTypeKey,
|
||||
[QueryType.GetUserByUsername]: (query) => handleGetUserByUsername(query as GetUserByUsernameQuery, dataSource),
|
||||
[QueryType.GetUserById]: (query) => handleGetUserById(query as GetUserByIdQuery, dataSource),
|
||||
[QueryType.GetAllPublicServers]: () => handleGetAllPublicServers(dataSource),
|
||||
[QueryType.GetFeaturedServers]: () => handleGetFeaturedServers(dataSource),
|
||||
[QueryType.GetTrendingServers]: () => handleGetTrendingServers(dataSource),
|
||||
[QueryType.GetServerById]: (query) => handleGetServerById(query as GetServerByIdQuery, dataSource),
|
||||
[QueryType.GetJoinRequestById]: (query) => handleGetJoinRequestById(query as GetJoinRequestByIdQuery, dataSource),
|
||||
[QueryType.GetPendingRequestsForServer]: (query) => handleGetPendingRequestsForServer(query as GetPendingRequestsForServerQuery, dataSource)
|
||||
|
||||
@@ -13,6 +13,8 @@ export const QueryType = {
|
||||
GetUserByUsername: 'get-user-by-username',
|
||||
GetUserById: 'get-user-by-id',
|
||||
GetAllPublicServers: 'get-all-public-servers',
|
||||
GetFeaturedServers: 'get-featured-servers',
|
||||
GetTrendingServers: 'get-trending-servers',
|
||||
GetServerById: 'get-server-by-id',
|
||||
GetJoinRequestById: 'get-join-request-by-id',
|
||||
GetPendingRequestsForServer: 'get-pending-requests-for-server'
|
||||
|
||||
@@ -20,7 +20,8 @@ import {
|
||||
ServerPluginEventDefinitionEntity,
|
||||
PluginDataEntity,
|
||||
ServerPluginSettingsEntity,
|
||||
PluginUserMetadataEntity
|
||||
PluginUserMetadataEntity,
|
||||
DeviceTokenEntity
|
||||
} from '../entities';
|
||||
import { serverMigrations } from '../migrations';
|
||||
import {
|
||||
@@ -270,7 +271,8 @@ export async function initDatabase(): Promise<void> {
|
||||
ServerPluginEventDefinitionEntity,
|
||||
PluginDataEntity,
|
||||
ServerPluginSettingsEntity,
|
||||
PluginUserMetadataEntity
|
||||
PluginUserMetadataEntity,
|
||||
DeviceTokenEntity
|
||||
],
|
||||
migrations: serverMigrations,
|
||||
synchronize: process.env.DB_SYNCHRONIZE === 'true',
|
||||
|
||||
25
server/src/entities/DeviceTokenEntity.ts
Normal file
25
server/src/entities/DeviceTokenEntity.ts
Normal file
@@ -0,0 +1,25 @@
|
||||
import {
|
||||
Entity,
|
||||
PrimaryColumn,
|
||||
Column,
|
||||
Index
|
||||
} from 'typeorm';
|
||||
|
||||
@Entity('device_tokens')
|
||||
@Index('idx_device_tokens_user_id', ['userId'])
|
||||
export class DeviceTokenEntity {
|
||||
@PrimaryColumn('text')
|
||||
id!: string;
|
||||
|
||||
@Column('text')
|
||||
userId!: string;
|
||||
|
||||
@Column('text')
|
||||
platform!: 'ios' | 'android';
|
||||
|
||||
@Column('text')
|
||||
token!: string;
|
||||
|
||||
@Column('integer')
|
||||
updatedAt!: number;
|
||||
}
|
||||
@@ -17,3 +17,4 @@ export type { ServerPluginEventDirection, ServerPluginEventScope } from './Serve
|
||||
export { PluginDataEntity } from './PluginDataEntity';
|
||||
export { ServerPluginSettingsEntity } from './ServerPluginSettingsEntity';
|
||||
export { PluginUserMetadataEntity } from './PluginUserMetadataEntity';
|
||||
export { DeviceTokenEntity } from './DeviceTokenEntity';
|
||||
|
||||
23
server/src/migrations/1000000000010-DeviceTokens.ts
Normal file
23
server/src/migrations/1000000000010-DeviceTokens.ts
Normal file
@@ -0,0 +1,23 @@
|
||||
import { MigrationInterface, QueryRunner } from 'typeorm';
|
||||
|
||||
export class DeviceTokens1000000000010 implements MigrationInterface {
|
||||
name = 'DeviceTokens1000000000010';
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`
|
||||
CREATE TABLE IF NOT EXISTS "device_tokens" (
|
||||
"id" TEXT PRIMARY KEY NOT NULL,
|
||||
"userId" TEXT NOT NULL,
|
||||
"platform" TEXT NOT NULL,
|
||||
"token" TEXT NOT NULL,
|
||||
"updatedAt" INTEGER NOT NULL
|
||||
)
|
||||
`);
|
||||
|
||||
await queryRunner.query(`CREATE INDEX IF NOT EXISTS "idx_device_tokens_user_id" ON "device_tokens" ("userId")`);
|
||||
}
|
||||
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.query(`DROP TABLE IF EXISTS "device_tokens"`);
|
||||
}
|
||||
}
|
||||
@@ -8,6 +8,7 @@ import { GameMatchMisses1000000000006 } from './1000000000006-GameMatchMisses';
|
||||
import { PluginSupport1000000000007 } from './1000000000007-PluginSupport';
|
||||
import { ServerPluginInstallMetadata1000000000008 } from './1000000000008-ServerPluginInstallMetadata';
|
||||
import { ServerIcons1000000000009 } from './1000000000009-ServerIcons';
|
||||
import { DeviceTokens1000000000010 } from './1000000000010-DeviceTokens';
|
||||
|
||||
export const serverMigrations = [
|
||||
InitialSchema1000000000000,
|
||||
@@ -19,5 +20,6 @@ export const serverMigrations = [
|
||||
GameMatchMisses1000000000006,
|
||||
PluginSupport1000000000007,
|
||||
ServerPluginInstallMetadata1000000000008,
|
||||
ServerIcons1000000000009
|
||||
ServerIcons1000000000009,
|
||||
DeviceTokens1000000000010
|
||||
];
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user