[ADD] User Achievement Contracts

contracts/users/UserAchievement.ts

@@ -0,0 +1,47 @@
+import {Timestamp} from 'firebase/firestore';
+import {z} from 'zod';
+
+/**
+ * @interface UserAchievement
+ * @description Represents an achievement of a user.
+ *
+ * @property {string} title - The title of the achievement.
+ * @property {string} date_awarded - The date when the achievement was awarded (in YYYY-MM-DD format).
+ * @property {string} description - A brief description of the achievement.
+ *
+ * @example
+ * // Example usage:
+ * const achievement: UserAchievement = {
+ *   title: 'Best Student Award',
+ *   date_awarded: '2023-06-15',
+ *   description: 'Awarded for outstanding academic performance.'
+ * };
+ *
+ * @remarks
+ * This interface can be extended to include more achievement-related information
+ * as needed for various applications.
+ *
+ * @since 1.0.0
+ */
+
+export interface UserAchievement {
+  title: string;
+  issued_date: Timestamp;
+  description: string;
+}
+
+export const UserAchievementSchema: z.ZodSchema<UserAchievement> = z.object({
+  title: z.string({
+    required_error: 'Title is required',
+    invalid_type_error: 'Title must be a string',
+  }),
+  issued_date: z
+    .instanceof(Timestamp)
+    .refine((item) => item instanceof Timestamp, {
+      message: 'Date awarded must be an instance of Timestamp',
+    }),
+  description: z.string({
+    required_error: 'Description is required',
+    invalid_type_error: 'Description must be a string',
+  }),
+});

frontend/src/App.tsx

@@ -1,4 +1,5 @@
 import './App.css';
+
 export const App = () => {
   return (
     <div>

frontend/src/contracts/users/UserAchievement.ts

@@ -0,0 +1,47 @@
+import {Timestamp} from 'firebase/firestore';
+import {z} from 'zod';
+
+/**
+ * @interface UserAchievement
+ * @description Represents an achievement of a user.
+ *
+ * @property {string} title - The title of the achievement.
+ * @property {string} date_awarded - The date when the achievement was awarded (in YYYY-MM-DD format).
+ * @property {string} description - A brief description of the achievement.
+ *
+ * @example
+ * // Example usage:
+ * const achievement: UserAchievement = {
+ *   title: 'Best Student Award',
+ *   date_awarded: '2023-06-15',
+ *   description: 'Awarded for outstanding academic performance.'
+ * };
+ *
+ * @remarks
+ * This interface can be extended to include more achievement-related information
+ * as needed for various applications.
+ *
+ * @since 1.0.0
+ */
+
+export interface UserAchievement {
+  title: string;
+  issued_date: Timestamp;
+  description: string;
+}
+
+export const UserAchievementSchema: z.ZodSchema<UserAchievement> = z.object({
+  title: z.string({
+    required_error: 'Title is required',
+    invalid_type_error: 'Title must be a string',
+  }),
+  issued_date: z
+    .instanceof(Timestamp)
+    .refine((item) => item instanceof Timestamp, {
+      message: 'Date awarded must be an instance of Timestamp',
+    }),
+  description: z.string({
+    required_error: 'Description is required',
+    invalid_type_error: 'Description must be a string',
+  }),
+});

functions/src/contracts/users/UserAchievement.ts

@@ -0,0 +1,47 @@
+import {Timestamp} from 'firebase/firestore';
+import {z} from 'zod';
+
+/**
+ * @interface UserAchievement
+ * @description Represents an achievement of a user.
+ *
+ * @property {string} title - The title of the achievement.
+ * @property {string} date_awarded - The date when the achievement was awarded (in YYYY-MM-DD format).
+ * @property {string} description - A brief description of the achievement.
+ *
+ * @example
+ * // Example usage:
+ * const achievement: UserAchievement = {
+ *   title: 'Best Student Award',
+ *   date_awarded: '2023-06-15',
+ *   description: 'Awarded for outstanding academic performance.'
+ * };
+ *
+ * @remarks
+ * This interface can be extended to include more achievement-related information
+ * as needed for various applications.
+ *
+ * @since 1.0.0
+ */
+
+export interface UserAchievement {
+  title: string;
+  issued_date: Timestamp;
+  description: string;
+}
+
+export const UserAchievementSchema: z.ZodSchema<UserAchievement> = z.object({
+  title: z.string({
+    required_error: 'Title is required',
+    invalid_type_error: 'Title must be a string',
+  }),
+  issued_date: z
+    .instanceof(Timestamp)
+    .refine((item) => item instanceof Timestamp, {
+      message: 'Date awarded must be an instance of Timestamp',
+    }),
+  description: z.string({
+    required_error: 'Description is required',
+    invalid_type_error: 'Description must be a string',
+  }),
+});