From 9cfaca0177ebabc47f9fa7380b13bf73cf8e954f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=9C=A8=20Audrey=20=E2=9C=A8?= <audrey@audreyality.com>
Date: Thu, 13 Mar 2025 13:15:31 -0400
Subject: [PATCH] add description

---
 .../src/tools/achievements/achievement-processor.spec.ts     | 4 ++--
 .../{example-achievements.ts => achievement-events.ts}       | 0
 .../src/tools/achievements/examples/example-validators.ts    | 5 +++++
 .../examples/{example-events.ts => user-events.ts}           | 0
 libs/common/src/tools/achievements/types.ts                  | 3 +++
 libs/common/src/tools/achievements/util.spec.ts              | 2 +-
 6 files changed, 11 insertions(+), 3 deletions(-)
 rename libs/common/src/tools/achievements/examples/{example-achievements.ts => achievement-events.ts} (100%)
 rename libs/common/src/tools/achievements/examples/{example-events.ts => user-events.ts} (100%)

diff --git a/libs/common/src/tools/achievements/achievement-processor.spec.ts b/libs/common/src/tools/achievements/achievement-processor.spec.ts
index 921033a4f75..ae8993a7f40 100644
--- a/libs/common/src/tools/achievements/achievement-processor.spec.ts
+++ b/libs/common/src/tools/achievements/achievement-processor.spec.ts
@@ -1,8 +1,7 @@
 import { BehaviorSubject, ReplaySubject, bufferCount, concat, first, firstValueFrom } from "rxjs";
 
 import { validate } from "./achievement-processor";
-import { ItemCreatedProgressEvent } from "./examples/example-achievements";
-import { itemAdded$, itemUpdated$ } from "./examples/example-events";
+import { ItemCreatedProgressEvent } from "./examples/achievement-events";
 import {
   ItemCreatedAchievement,
   ItemCreatedProgress,
@@ -11,6 +10,7 @@ import {
   TotallyAttachedAchievement,
   TotallyAttachedValidator,
 } from "./examples/example-validators";
+import { itemAdded$, itemUpdated$ } from "./examples/user-events";
 import { AchievementEvent } from "./types";
 
 describe("event-processor", () => {
diff --git a/libs/common/src/tools/achievements/examples/example-achievements.ts b/libs/common/src/tools/achievements/examples/achievement-events.ts
similarity index 100%
rename from libs/common/src/tools/achievements/examples/example-achievements.ts
rename to libs/common/src/tools/achievements/examples/achievement-events.ts
diff --git a/libs/common/src/tools/achievements/examples/example-validators.ts b/libs/common/src/tools/achievements/examples/example-validators.ts
index 89d1f571c5e..14055937c03 100644
--- a/libs/common/src/tools/achievements/examples/example-validators.ts
+++ b/libs/common/src/tools/achievements/examples/example-validators.ts
@@ -13,6 +13,7 @@ const FiveItemsCreatedAchievement = "five-vault-items-created" as AchievementId;
 const TotallyAttachedValidator = {
   achievement: TotallyAttachedAchievement,
   name: "Totally attached <3",
+  description: "Attached a file to a send or item",
   metric: ItemCreatedProgress,
   validator: Type.HasTag,
   trigger: "once",
@@ -35,6 +36,7 @@ const TotallyAttachedValidator = {
 const ItemCreatedTracker = {
   achievement: ItemCreatedMetric,
   name: `[TRACKER] ${ItemCreatedProgress}`,
+  description: `Measures ${ItemCreatedProgress}`,
   metric: ItemCreatedProgress,
   validator: Type.Threshold,
   trigger: { high: 1 },
@@ -52,6 +54,7 @@ const ItemCreatedValidator = {
   achievement: ItemCreatedAchievement,
   name: "What an item!",
   metric: ItemCreatedProgress,
+  description: "Add an item to your vault",
   validator: Type.Threshold,
   trigger: { high: 1 },
   hidden: false,
@@ -69,6 +72,7 @@ const ItemCreatedValidator = {
 const ThreeItemsCreatedValidator = {
   achievement: ThreeItemsCreatedAchievement,
   name: "Three times a charm",
+  description: "Add three items to your vault",
   metric: ItemCreatedProgress,
   validator: Type.Threshold,
   trigger: { low: 2, high: 3 },
@@ -89,6 +93,7 @@ const ThreeItemsCreatedValidator = {
 const FiveItemsCreatedValidator = {
   achievement: FiveItemsCreatedAchievement,
   name: "fiiivvve GoOoOoOolllllllD RIIIIIINGS!!!!!!",
+  description: "Add five items to your vault",
   metric: ItemCreatedProgress,
   validator: Type.Threshold,
   trigger: { low: 4, high: 5 },
diff --git a/libs/common/src/tools/achievements/examples/example-events.ts b/libs/common/src/tools/achievements/examples/user-events.ts
similarity index 100%
rename from libs/common/src/tools/achievements/examples/example-events.ts
rename to libs/common/src/tools/achievements/examples/user-events.ts
diff --git a/libs/common/src/tools/achievements/types.ts b/libs/common/src/tools/achievements/types.ts
index e9cb59679cc..8bd2f9b3333 100644
--- a/libs/common/src/tools/achievements/types.ts
+++ b/libs/common/src/tools/achievements/types.ts
@@ -28,6 +28,9 @@ export type Achievement = {
   // human-readable name of the achievement
   name: string;
 
+  // human-readable description of the achievement
+  description?: string;
+
   // the metric observed by low/high triggers
   metric?: MetricId;
 
diff --git a/libs/common/src/tools/achievements/util.spec.ts b/libs/common/src/tools/achievements/util.spec.ts
index 43d1532467c..8aa5e547394 100644
--- a/libs/common/src/tools/achievements/util.spec.ts
+++ b/libs/common/src/tools/achievements/util.spec.ts
@@ -1,4 +1,4 @@
-import { ItemCreatedProgressEvent } from "./examples/example-achievements";
+import { ItemCreatedProgressEvent } from "./examples/achievement-events";
 import { ItemCreatedProgress } from "./examples/example-validators";
 import { mapProgressByName } from "./util";