@aneuhold/core-ts-db-lib 3.0.3 → 4.0.1

package/lib/documents/common/ApiKey.ts

@@ -1,49 +1,19 @@
-import type { UUID } from 'crypto';
-import crypto from 'crypto';
-import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
-import type { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
-import Validate from '../../schemas/validators/ValidateUtil.js';
-import DocumentService from '../../services/DocumentService.js';
-import BaseDocument from '../BaseDocument.js';
+import { randomUUID } from 'crypto';
+import { z } from 'zod';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
 
 /**
- * Validates the provided {@link ApiKey} instance.
- *
- * @param apiKey - The {@link ApiKey} instance to validate.
- * @returns An object containing the updated document and any validation errors.
+ * The schema for {@link ApiKey} documents.
  */
-export const validateApiKey: DocumentValidator<ApiKey> = (apiKey: ApiKey) => {
-  const errors: string[] = [];
-  const exampleApiKey = new ApiKey(DocumentService.generateID());
-  const validate = new Validate(apiKey, errors);
-
-  validate.string('key', exampleApiKey.key);
-
-  return { updatedDoc: apiKey, errors };
-};
+export const ApiKeySchema = RequiredUserIdSchema.extend({
+  /**
+   * The API key for the user. This is indexed in the DB.
+   */
+  key: z.uuid().default(() => randomUUID())
+});
 
 /**
  * A document containing an API key for a particular user. This is stored
  * separately from the {@link User} document to enhance security a bit.
  */
-export default class ApiKey extends BaseDocument implements RequiredUserId {
-  /**
-   * The API key for the user. This is indexed in the DB.
-   */
-  key: UUID = crypto.randomUUID();
-
-  /**
-   * The user ID that this key is for. This field is indexed in the database.
-   */
-  userId: UUID;
-
-  /**
-   * Constructs a new {@link ApiKey} for the provided user.
-   *
-   * @param userId - The ID of the user.
-   */
-  constructor(userId: UUID) {
-    super();
-    this.userId = userId;
-  }
-}
+export type ApiKey = z.infer<typeof ApiKeySchema>;

package/lib/documents/common/User.d.ts

@@ -1,41 +1,35 @@
-import type { UUID } from 'crypto';
-import type { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
-import BaseDocument from '../BaseDocument.js';
+import { z } from 'zod';
 /**
- * A User CTO which can be used to reference a User with only the necessary
- * information.
+ * The schema for {@link UserCTO} documents. This also acts a base for the {@link UserSchema}.
  */
-export type UserCTO = {
-    _id: UUID;
-    userName: string;
-};
+export declare const UserCTOSchema: z.ZodObject<{
+    _id: z.ZodPipe<z.ZodDefault<z.ZodUUID>, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    userName: z.ZodString;
+}, z.core.$strip>;
 /**
- * Validates a User document.
- *
- * @param user - The user document to validate.
- * @returns An object containing the updated user document and an array of error messages, if any.
+ * The schema for {@link User} documents.
  */
-export declare const validateUser: DocumentValidator<User>;
+export declare const UserSchema: z.ZodObject<{
+    _id: z.ZodPipe<z.ZodDefault<z.ZodUUID>, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    userName: z.ZodString;
+    email: z.ZodOptional<z.ZodNullable<z.ZodEmail>>;
+    auth: z.ZodDefault<z.ZodObject<{
+        password: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        googleId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    projectAccess: z.ZodDefault<z.ZodObject<{
+        dashboard: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 /**
  * A standard user of all personal projects. This should be linked to from
  * other documents that need to reference a user, instead of cluttering the
  * key user information.
  */
-export default class User extends BaseDocument {
-    userName: string;
-    email?: string;
-    auth: {
-        password?: string;
-        googleId?: string;
-    };
-    projectAccess: {
-        dashboard: boolean;
-    };
-    /**
-     * Constructs a new {@link User} with default values.
-     *
-     * @param userName - The username of the user.
-     */
-    constructor(userName: string);
-}
+export type User = z.infer<typeof UserSchema>;
+/**
+ * A User CTO which can be used to reference a User with only the necessary
+ * information.
+ */
+export type UserCTO = z.infer<typeof UserCTOSchema>;
 //# sourceMappingURL=User.d.ts.map

package/lib/documents/common/User.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAEvF,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,IAAI,CAAC;IACV,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,iBAAiB,CAAC,IAAI,CAehD,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP,aAAa;;MAEX;IAEF;;;;OAIG;gBACS,QAAQ,EAAE,MAAM;CAI7B"}
+{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;GAEG;AACH,eAAO,MAAM,aAAa;;;iBAExB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;iBAerB,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC"}

package/lib/documents/common/User.js

@@ -1,45 +1,28 @@
-import Validate from '../../schemas/validators/ValidateUtil.js';
-import BaseDocument from '../BaseDocument.js';
+import { z } from 'zod';
+import { BaseDocumentSchema } from '../BaseDocument.js';
 /**
- * Validates a User document.
- *
- * @param user - The user document to validate.
- * @returns An object containing the updated user document and an array of error messages, if any.
+ * The schema for {@link UserCTO} documents. This also acts a base for the {@link UserSchema}.
  */
-export const validateUser = (user) => {
-    const errors = [];
-    const validate = new Validate(user, errors);
-    const exampleUser = new User('example');
-    validate.string('userName', 'UsernameUnknown');
-    validate.optionalString('password');
-    validate.optionalString('email');
-    validate.object('auth', exampleUser.auth);
-    validate.optionalString('auth.password');
-    validate.optionalString('auth.googleId');
-    validate.object('projectAccess', exampleUser.projectAccess);
-    validate.boolean('projectAccess.dashboard', exampleUser.projectAccess.dashboard);
-    return { updatedDoc: user, errors };
-};
+export const UserCTOSchema = BaseDocumentSchema.extend({
+    userName: z.string()
+});
 /**
- * A standard user of all personal projects. This should be linked to from
- * other documents that need to reference a user, instead of cluttering the
- * key user information.
+ * The schema for {@link User} documents.
  */
-export default class User extends BaseDocument {
-    userName;
-    email;
-    auth = {};
-    projectAccess = {
+export const UserSchema = UserCTOSchema.extend({
+    email: z.email().nullish(),
+    auth: z
+        .object({
+        password: z.string().nullish(),
+        googleId: z.string().nullish()
+    })
+        .default({}),
+    projectAccess: z
+        .object({
+        dashboard: z.boolean().default(true)
+    })
+        .default({
         dashboard: true
-    };
-    /**
-     * Constructs a new {@link User} with default values.
-     *
-     * @param userName - The username of the user.
-     */
-    constructor(userName) {
-        super();
-        this.userName = userName;
-    }
-}
+    })
+});
 //# sourceMappingURL=User.js.map

package/lib/documents/common/User.js.map

@@ -1 +1 @@
-{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAEA,OAAO,QAAQ,MAAM,0CAA0C,CAAC;AAChE,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAW9C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAA4B,CAAC,IAAI,EAAE,EAAE;IAC5D,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;IAExC,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAC/C,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACpC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACjC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;IAC1C,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACzC,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACzC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5D,QAAQ,CAAC,OAAO,CAAC,yBAAyB,EAAE,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAEjF,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,QAAQ,CAAS;IAEjB,KAAK,CAAU;IAEf,IAAI,GAGA,EAAE,CAAC;IAEP,aAAa,GAAG;QACd,SAAS,EAAE,IAAI;KAChB,CAAC;IAEF;;;;OAIG;IACH,YAAY,QAAgB;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF"}
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,CAAC;IACrD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;CACrB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;IAC7C,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC1B,IAAI,EAAE,CAAC;SACJ,MAAM,CAAC;QACN,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;QAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;KAC/B,CAAC;SACD,OAAO,CAAC,EAAE,CAAC;IACd,aAAa,EAAE,CAAC;SACb,MAAM,CAAC;QACN,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;KACrC,CAAC;SACD,OAAO,CAAC;QACP,SAAS,EAAE,IAAI;KAChB,CAAC;CACL,CAAC,CAAC"}

package/lib/documents/common/User.ts

@@ -1,66 +1,42 @@
-import type { UUID } from 'crypto';
-import type { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
-import Validate from '../../schemas/validators/ValidateUtil.js';
-import BaseDocument from '../BaseDocument.js';
+import { z } from 'zod';
+import { BaseDocumentSchema } from '../BaseDocument.js';
 
 /**
- * A User CTO which can be used to reference a User with only the necessary
- * information.
+ * The schema for {@link UserCTO} documents. This also acts a base for the {@link UserSchema}.
  */
-export type UserCTO = {
-  _id: UUID;
-  userName: string;
-};
+export const UserCTOSchema = BaseDocumentSchema.extend({
+  userName: z.string()
+});
 
 /**
- * Validates a User document.
- *
- * @param user - The user document to validate.
- * @returns An object containing the updated user document and an array of error messages, if any.
+ * The schema for {@link User} documents.
  */
-export const validateUser: DocumentValidator<User> = (user) => {
-  const errors: string[] = [];
-  const validate = new Validate(user, errors);
-  const exampleUser = new User('example');
-
-  validate.string('userName', 'UsernameUnknown');
-  validate.optionalString('password');
-  validate.optionalString('email');
-  validate.object('auth', exampleUser.auth);
-  validate.optionalString('auth.password');
-  validate.optionalString('auth.googleId');
-  validate.object('projectAccess', exampleUser.projectAccess);
-  validate.boolean('projectAccess.dashboard', exampleUser.projectAccess.dashboard);
-
-  return { updatedDoc: user, errors };
-};
+export const UserSchema = UserCTOSchema.extend({
+  email: z.email().nullish(),
+  auth: z
+    .object({
+      password: z.string().nullish(),
+      googleId: z.string().nullish()
+    })
+    .default({}),
+  projectAccess: z
+    .object({
+      dashboard: z.boolean().default(true)
+    })
+    .default({
+      dashboard: true
+    })
+});
 
 /**
  * A standard user of all personal projects. This should be linked to from
  * other documents that need to reference a user, instead of cluttering the
  * key user information.
  */
-export default class User extends BaseDocument {
-  userName: string;
-
-  email?: string;
-
-  auth: {
-    password?: string;
-    googleId?: string;
-  } = {};
+export type User = z.infer<typeof UserSchema>;
 
-  projectAccess = {
-    dashboard: true
-  };
-
-  /**
-   * Constructs a new {@link User} with default values.
-   *
-   * @param userName - The username of the user.
-   */
-  constructor(userName: string) {
-    super();
-    this.userName = userName;
-  }
-}
+/**
+ * A User CTO which can be used to reference a User with only the necessary
+ * information.
+ */
+export type UserCTO = z.infer<typeof UserCTOSchema>;

package/lib/documents/dashboard/NonogramKatanaItem.d.ts

@@ -1,34 +1,25 @@
-import type { UUID } from 'crypto';
+import { z } from 'zod';
 import NonogramKatanaItemName from '../../embedded-types/dashboard/nonogramKatanaItem/ItemName.js';
-import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
-import type { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
-import BaseDocumentWithType from '../BaseDocumentWithType.js';
 /**
- * Validates a {@link NonogramKatanaItem}.
- *
- * @param item - The {@link NonogramKatanaItem} to validate.
- * @returns An object containing the updated document and any validation errors.
+ * The docType value for NonogramKatanaItem documents.
  */
-export declare const validateNonogramKatanaItem: DocumentValidator<NonogramKatanaItem>;
+export declare const NonogramKatanaItem_docType = "nonogramKatanaItem";
+/**
+ * The schema for {@link NonogramKatanaItem} documents.
+ */
+export declare const NonogramKatanaItemSchema: z.ZodObject<{
+    docType: z.ZodDefault<z.ZodLiteral<"nonogramKatanaItem">>;
+    itemName: z.ZodEnum<typeof NonogramKatanaItemName>;
+    currentAmount: z.ZodDefault<z.ZodInt>;
+    storageCap: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    minDesired: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    maxDesired: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    priority: z.ZodDefault<z.ZodInt>;
+    _id: z.ZodPipe<z.ZodDefault<z.ZodUUID>, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    userId: z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+}, z.core.$strip>;
 /**
  * An item in the Nonogram Katana game.
  */
-export default class NonogramKatanaItem extends BaseDocumentWithType implements RequiredUserId {
-    static docType: string;
-    docType: string;
-    /**
-     * The owner of this Nonogram Katana item.
-     */
-    userId: UUID;
-    itemName: NonogramKatanaItemName;
-    currentAmount: number;
-    storageCap?: number;
-    minDesired?: number;
-    maxDesired?: number;
-    /**
-     * Priority, where the higher the number, the higher up the list it is.
-     */
-    priority: number;
-    constructor(ownerId: UUID, itemName: NonogramKatanaItemName);
-}
+export type NonogramKatanaItem = z.infer<typeof NonogramKatanaItemSchema>;
 //# sourceMappingURL=NonogramKatanaItem.d.ts.map

package/lib/documents/dashboard/NonogramKatanaItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NonogramKatanaItem.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/NonogramKatanaItem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,sBAAsB,MAAM,+DAA+D,CAAC;AACnG,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AACvF,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAE9D;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,EAAE,iBAAiB,CAAC,kBAAkB,CAQ5E,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,oBAAqB,YAAW,cAAc;IAC5F,MAAM,CAAC,OAAO,SAAwB;IAEtC,OAAO,SAA8B;IAErC;;OAEG;IACH,MAAM,EAAE,IAAI,CAAC;IAEb,QAAQ,EAAE,sBAAsB,CAAC;IAEjC,aAAa,EAAE,MAAM,CAAK;IAE1B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAK;gBAET,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,sBAAsB;CAK5D"}
+{"version":3,"file":"NonogramKatanaItem.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/NonogramKatanaItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,sBAAsB,MAAM,+DAA+D,CAAC;AAInG;;GAEG;AACH,eAAO,MAAM,0BAA0B,uBAAuB,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;iBAanC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC"}

package/lib/documents/dashboard/NonogramKatanaItem.js

@@ -1,40 +1,26 @@
+import { z } from 'zod';
 import NonogramKatanaItemName from '../../embedded-types/dashboard/nonogramKatanaItem/ItemName.js';
-import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
-import BaseDocumentWithType from '../BaseDocumentWithType.js';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
+import { BaseDocumentWithTypeSchema } from '../BaseDocument.js';
 /**
- * Validates a {@link NonogramKatanaItem}.
- *
- * @param item - The {@link NonogramKatanaItem} to validate.
- * @returns An object containing the updated document and any validation errors.
+ * The docType value for NonogramKatanaItem documents.
  */
-export const validateNonogramKatanaItem = (item) => {
-    const errors = [];
-    // No validation at the moment.
-    return { updatedDoc: item, errors };
-};
+export const NonogramKatanaItem_docType = 'nonogramKatanaItem';
 /**
- * An item in the Nonogram Katana game.
+ * The schema for {@link NonogramKatanaItem} documents.
  */
-export default class NonogramKatanaItem extends BaseDocumentWithType {
-    static docType = 'nonogramKatanaItem';
-    docType = NonogramKatanaItem.docType;
-    /**
-     * The owner of this Nonogram Katana item.
-     */
-    userId;
-    itemName;
-    currentAmount = 0;
-    storageCap;
-    minDesired;
-    maxDesired;
+export const NonogramKatanaItemSchema = z.object({
+    ...BaseDocumentWithTypeSchema.shape,
+    ...RequiredUserIdSchema.shape,
+    docType: z.literal(NonogramKatanaItem_docType).default(NonogramKatanaItem_docType),
+    itemName: z.enum(NonogramKatanaItemName),
+    currentAmount: z.int().default(0),
+    storageCap: z.int().nullish(),
+    minDesired: z.int().nullish(),
+    maxDesired: z.int().nullish(),
     /**
      * Priority, where the higher the number, the higher up the list it is.
      */
-    priority = 0;
-    constructor(ownerId, itemName) {
-        super();
-        this.userId = ownerId;
-        this.itemName = itemName;
-    }
-}
+    priority: z.int().default(0)
+});
 //# sourceMappingURL=NonogramKatanaItem.js.map

package/lib/documents/dashboard/NonogramKatanaItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"NonogramKatanaItem.js","sourceRoot":"","sources":["../../../src/documents/dashboard/NonogramKatanaItem.ts"],"names":[],"mappings":"AACA,OAAO,sBAAsB,MAAM,+DAA+D,CAAC;AACnG,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAE3E,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAA0C,CAC/E,IAAwB,EACxB,EAAE;IACF,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,+BAA+B;IAE/B,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,oBAAoB;IAClE,MAAM,CAAC,OAAO,GAAG,oBAAoB,CAAC;IAEtC,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAErC;;OAEG;IACH,MAAM,CAAO;IAEb,QAAQ,CAAyB;IAEjC,aAAa,GAAW,CAAC,CAAC;IAE1B,UAAU,CAAU;IAEpB,UAAU,CAAU;IAEpB,UAAU,CAAU;IAEpB;;OAEG;IACH,QAAQ,GAAW,CAAC,CAAC;IAErB,YAAY,OAAa,EAAE,QAAgC;QACzD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC"}
+{"version":3,"file":"NonogramKatanaItem.js","sourceRoot":"","sources":["../../../src/documents/dashboard/NonogramKatanaItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,sBAAsB,MAAM,+DAA+D,CAAC;AACnG,OAAO,EAAE,oBAAoB,EAAE,MAAM,+CAA+C,CAAC;AACrF,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAEhE;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,oBAAoB,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,GAAG,0BAA0B,CAAC,KAAK;IACnC,GAAG,oBAAoB,CAAC,KAAK;IAC7B,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC;IAClF,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC;IACxC,aAAa,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACjC,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE;IAC7B;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;CAC7B,CAAC,CAAC"}

package/lib/documents/dashboard/NonogramKatanaItem.ts

@@ -1,56 +1,32 @@
-import type { UUID } from 'crypto';
+import { z } from 'zod';
 import NonogramKatanaItemName from '../../embedded-types/dashboard/nonogramKatanaItem/ItemName.js';
-import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
-import type { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
-import BaseDocumentWithType from '../BaseDocumentWithType.js';
+import { RequiredUserIdSchema } from '../../schemas/required-refs/RequiredUserId.js';
+import { BaseDocumentWithTypeSchema } from '../BaseDocument.js';
 
 /**
- * Validates a {@link NonogramKatanaItem}.
- *
- * @param item - The {@link NonogramKatanaItem} to validate.
- * @returns An object containing the updated document and any validation errors.
+ * The docType value for NonogramKatanaItem documents.
  */
-export const validateNonogramKatanaItem: DocumentValidator<NonogramKatanaItem> = (
-  item: NonogramKatanaItem
-) => {
-  const errors: string[] = [];
-
-  // No validation at the moment.
-
-  return { updatedDoc: item, errors };
-};
+export const NonogramKatanaItem_docType = 'nonogramKatanaItem';
 
 /**
- * An item in the Nonogram Katana game.
+ * The schema for {@link NonogramKatanaItem} documents.
  */
-export default class NonogramKatanaItem extends BaseDocumentWithType implements RequiredUserId {
-  static docType = 'nonogramKatanaItem';
-
-  docType = NonogramKatanaItem.docType;
-
-  /**
-   * The owner of this Nonogram Katana item.
-   */
-  userId: UUID;
-
-  itemName: NonogramKatanaItemName;
-
-  currentAmount: number = 0;
-
-  storageCap?: number;
-
-  minDesired?: number;
-
-  maxDesired?: number;
-
+export const NonogramKatanaItemSchema = z.object({
+  ...BaseDocumentWithTypeSchema.shape,
+  ...RequiredUserIdSchema.shape,
+  docType: z.literal(NonogramKatanaItem_docType).default(NonogramKatanaItem_docType),
+  itemName: z.enum(NonogramKatanaItemName),
+  currentAmount: z.int().default(0),
+  storageCap: z.int().nullish(),
+  minDesired: z.int().nullish(),
+  maxDesired: z.int().nullish(),
   /**
    * Priority, where the higher the number, the higher up the list it is.
    */
-  priority: number = 0;
+  priority: z.int().default(0)
+});
 
-  constructor(ownerId: UUID, itemName: NonogramKatanaItemName) {
-    super();
-    this.userId = ownerId;
-    this.itemName = itemName;
-  }
-}
+/**
+ * An item in the Nonogram Katana game.
+ */
+export type NonogramKatanaItem = z.infer<typeof NonogramKatanaItemSchema>;

package/lib/documents/dashboard/NonogramKatanaUpgrade.d.ts

@@ -1,48 +1,23 @@
-import type { UUID } from 'crypto';
-import NonogramKatanaItemName from '../../embedded-types/dashboard/nonogramKatanaItem/ItemName.js';
+import { z } from 'zod';
 import NonogramKatanaUpgradeName from '../../embedded-types/dashboard/nonogramKatanaUpgrade/UpgradeName.js';
-import RequiredUserId from '../../schemas/required-refs/RequiredUserId.js';
-import type { DocumentValidator } from '../../schemas/validators/DocumentValidator.js';
-import BaseDocumentWithType from '../BaseDocumentWithType.js';
 /**
- * Validates a {@link NonogramKatanaUpgrade} document.
- *
- * @param upgrade The {@link NonogramKatanaUpgrade} document to validate.
- * @returns An object containing the updated document and any validation errors.
+ * The docType value for NonogramKatanaUpgrade documents.
  */
-export declare const validateNonogramKatanaUpgrade: DocumentValidator<NonogramKatanaUpgrade>;
+export declare const NonogramKatanaUpgrade_docType = "nonogramKatanaUpgrade";
+/**
+ * The schema for {@link NonogramKatanaUpgrade} documents.
+ */
+export declare const NonogramKatanaUpgradeSchema: z.ZodObject<{
+    docType: z.ZodDefault<z.ZodLiteral<"nonogramKatanaUpgrade">>;
+    upgradeName: z.ZodEnum<typeof NonogramKatanaUpgradeName>;
+    completed: z.ZodDefault<z.ZodBoolean>;
+    currentItemAmounts: z.ZodDefault<z.ZodRecord<z.ZodEnum<typeof import("../../embedded-types/dashboard/nonogramKatanaItem/ItemName.js").default> & z.core.$partial, z.ZodOptional<z.ZodNullable<z.ZodInt>>>>;
+    priority: z.ZodDefault<z.ZodInt>;
+    _id: z.ZodPipe<z.ZodDefault<z.ZodUUID>, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+    userId: z.ZodPipe<z.ZodUUID, z.ZodTransform<`${string}-${string}-${string}-${string}-${string}`, string>>;
+}, z.core.$strip>;
 /**
  * Represents an upgrade for a Nonogram Katana.
- *
- * @example
- * ```typescript
- * const upgrade = new NonogramKatanaUpgrade(ownerId, upgradeName);
- * upgrade.completed = true;
- * upgrade.priority = 5;
- * ```
  */
-export default class NonogramKatanaUpgrade extends BaseDocumentWithType implements RequiredUserId {
-    static docType: string;
-    docType: string;
-    /**
-     * The owner of this Nonogram Katana upgrade.
-     */
-    userId: UUID;
-    upgradeName: NonogramKatanaUpgradeName;
-    completed: boolean;
-    currentItemAmounts: {
-        [key in NonogramKatanaItemName]?: number;
-    };
-    /**
-     * Priority, where the higher the number, the higher up the list it is.
-     */
-    priority: number;
-    /**
-     * Creates an instance of NonogramKatanaUpgrade.
-     *
-     * @param ownerId - The ID of the owner of this upgrade.
-     * @param upgradeName - The name of the upgrade.
-     */
-    constructor(ownerId: UUID, upgradeName: NonogramKatanaUpgradeName);
-}
+export type NonogramKatanaUpgrade = z.infer<typeof NonogramKatanaUpgradeSchema>;
 //# sourceMappingURL=NonogramKatanaUpgrade.d.ts.map

package/lib/documents/dashboard/NonogramKatanaUpgrade.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NonogramKatanaUpgrade.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/NonogramKatanaUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,sBAAsB,MAAM,+DAA+D,CAAC;AACnG,OAAO,yBAAyB,MAAM,qEAAqE,CAAC;AAC5G,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AACvF,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAE9D;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,EAAE,iBAAiB,CAAC,qBAAqB,CAQlF,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,oBAAqB,YAAW,cAAc;IAC/F,MAAM,CAAC,OAAO,SAA2B;IAEzC,OAAO,SAAiC;IAExC;;OAEG;IACH,MAAM,EAAE,IAAI,CAAC;IAEb,WAAW,EAAE,yBAAyB,CAAC;IAEvC,SAAS,EAAE,OAAO,CAAS;IAE3B,kBAAkB,EAAE;SAAG,GAAG,IAAI,sBAAsB,CAAC,CAAC,EAAE,MAAM;KAAE,CAAM;IAEtE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAK;IAErB;;;;;OAKG;gBACS,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,yBAAyB;CAKlE"}
+{"version":3,"file":"NonogramKatanaUpgrade.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/NonogramKatanaUpgrade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,yBAAyB,MAAM,qEAAqE,CAAC;AAI5G;;GAEG;AACH,eAAO,MAAM,6BAA6B,0BAA0B,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;iBAWtC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC"}