@opinio-dev/models 1.1.0 → 1.1.1-item-types.2

package/dist/types/items/Book.d.ts

@@ -0,0 +1,14 @@
+import { BookGenre } from './Genre';
+import { IBaseItem, Item } from './Item';
+export interface IBook extends IBaseItem {
+    type: 'book';
+    genres: BookGenre[];
+    author: string;
+    publisher: string;
+}
+/**
+ * Determines if the given item is a book
+ * @param {Item} item The item to check
+ * @returns {boolean} True if the item is a book, false otherwise
+ */
+export declare function isBook(item: Item): item is IBook;

package/dist/types/items/Game.d.ts

@@ -0,0 +1,15 @@
+import { GameGenre } from './Genre';
+import { IBaseItem, Item } from './Item';
+export interface IGame extends IBaseItem {
+    type: 'game';
+    genres: GameGenre[];
+    platforms: string[];
+    developer: string;
+    publisher: string;
+}
+/**
+ * Determines if the given item is a game
+ * @param {Item} item The item to check
+ * @returns {boolean} True if the item is a game, false otherwise
+ */
+export declare function isGame(item: Item): item is IGame;

package/dist/types/items/Genre.d.ts

@@ -0,0 +1,6 @@
+export declare const VideoGenres: readonly ["Action", "Adventure", "Biography", "Comedy", "Drama", "Fantasy", "Horror", "Mystery", "Romance", "Science Fiction", "Thriller", "Crime", "Documentary", "Animation", "Family", "Historical", "Musical", "War", "Western"];
+export type VideoGenre = (typeof VideoGenres)[number];
+export declare const GameGenres: readonly ["Action", "Adventure", "Biography", "Comedy", "Drama", "Fantasy", "Horror", "Mystery", "Romance", "Science Fiction", "Thriller", "Crime", "Documentary", "Animation", "Family", "Historical", "Musical", "War", "Western", "RPG", "Shooter", "Fighting", "Platformer", "Puzzle", "Open World", "Racing", "Simulation", "Sports", "Strategy", "Survival", "Sandbox", "MOBA", "MMO", "Roguelike"];
+export type GameGenre = (typeof GameGenres)[number];
+export declare const BookGenres: readonly ["Fiction", "Non-Fiction", "Fantasy", "Science Fiction", "Mystery", "Thriller", "Horror", "Romance", "Historical", "Biography", "Autobiography", "Memoir", "Self-Help", "Poetry", "Drama", "Young Adult", "Children's", "Graphic Novel", "Classic", "Philosophy", "Science", "Travel", "Religion", "True Crime", "Humor"];
+export type BookGenre = (typeof BookGenres)[number];

package/dist/types/items/Item.d.ts

@@ -0,0 +1,14 @@
+import { IBook } from './Book.js';
+import { IGame } from './Game.js';
+import { ItemType } from './ItemType.js';
+import { IMovie } from './Movie.js';
+import { ISeries } from './Series.js';
+export type Item = IMovie | IGame | ISeries | IBook;
+export interface IBaseItem {
+    id: string;
+    type: ItemType;
+    name: string;
+    description?: string;
+    imageUrl?: string;
+    releaseYear: number;
+}

package/dist/{ItemType.d.ts → types/items/ItemType.d.ts}

@@ -6,3 +6,9 @@ export declare const ItemType: {
 };
 export type ItemType = (typeof ItemType)[keyof typeof ItemType];
 export declare const ItemTypes: ("book" | "game" | "movie" | "series")[];
+/**
+ * Determines if the item type is valid
+ * @param {string|ItemType} itemType The item type to check
+ * @returns {boolean} Whether the item type is valid
+ */
+export declare function isItemType(itemType: string | ItemType): itemType is ItemType;

package/dist/types/items/Movie.d.ts

@@ -0,0 +1,15 @@
+import { VideoGenre } from './Genre.js';
+import { IBaseItem, Item } from './Item.js';
+export interface IMovie extends IBaseItem {
+    type: 'movie';
+    genres: VideoGenre[];
+    duration: number;
+    director: string;
+    cast: string[];
+}
+/**
+ * Determines if the given item is a movie
+ * @param {Item} item The item to check
+ * @returns {boolean} True if the item is a movie, false otherwise
+ */
+export declare function isMovie(item: Item): item is IMovie;

package/dist/types/items/Series.d.ts

@@ -0,0 +1,18 @@
+import { VideoGenre } from './Genre';
+import { IBaseItem, Item } from './Item';
+export declare const SeriesStatuses: readonly ["ongoing", "completed", "cancelled"];
+export type SeriesStatus = (typeof SeriesStatuses)[number];
+export interface ISeries extends IBaseItem {
+    type: 'series';
+    genres: VideoGenre[];
+    seasons: number;
+    status: SeriesStatus;
+    creator: string;
+    cast: string[];
+}
+/**
+ * Determines if the given item is a series
+ * @param {Item} item The item to check
+ * @returns {boolean} True if the item is a series, false otherwise
+ */
+export declare function isSeries(item: Item): item is ISeries;

package/dist/types/ratings/LeaderboardItem.d.ts

@@ -0,0 +1,10 @@
+import { ItemType } from '../items/ItemType';
+export interface ILeaderboardItem {
+    id: string;
+    itemId: string;
+    rank: number;
+    itemType: ItemType;
+    rating: number;
+    numberOfRatings: number;
+    date: Date;
+}

package/dist/types/ratings/LeaderboardSnapshot.d.ts

@@ -0,0 +1,8 @@
+import { ItemType } from '../items/ItemType';
+import { ILeaderboardItem } from './LeaderboardItem';
+export interface ILeaderboardSnapshot {
+    id: string;
+    itemType: ItemType;
+    leaderboardItems: ILeaderboardItem[];
+    date: Date;
+}

package/dist/types/ratings/Rating.d.ts

@@ -0,0 +1,8 @@
+export interface IRating {
+    id: string;
+    value: number;
+    itemId: string;
+    userId: string;
+    content?: string;
+    date: Date;
+}

package/dist/validation/BaseValidator.d.ts

@@ -0,0 +1,31 @@
+import { IValidationResult } from './ValidationResult';
+import { IValidator } from './Validator';
+/**
+ * A base validator providing common validation logic.
+ */
+export declare abstract class BaseValidator<T> implements IValidator<T> {
+    /**
+     * @inheritdoc
+     */
+    validate(item: Partial<T>, ignoredFields?: Array<keyof T>): IValidationResult;
+    /**
+     * Validates fields, returning a record of any errors. Override in subclasses.
+     * @param {Partial<T>} item The item to validate.
+     * @returns {Record<string, string>} A record of validation errors
+     */
+    protected abstract _validateFields(item: Partial<T>): Record<string, string>;
+    /**
+     * Filters out errors for ignored fields.
+     * @template T The type of the item being validated.
+     * @param {Record<string, string>} errors The errors to filter.
+     * @param {Array<keyof T>} ignoredFields Fields to ignore during validation.
+     * @returns {Record<string, string>} The filtered errors.
+     */
+    private __filterIgnoredFields;
+    /**
+     * Creates a validation result from errors.
+     * @param {Record<string, string>} errors The validation errors.
+     * @returns {IValidationResult} The validation result.
+     */
+    private __createValidationResult;
+}

package/dist/validation/ValidationResult.d.ts

@@ -0,0 +1,4 @@
+export interface IValidationResult {
+    valid: boolean;
+    errors: Record<string, string>;
+}

package/dist/validation/Validator.d.ts

@@ -0,0 +1,10 @@
+import { IValidationResult } from './ValidationResult';
+export interface IValidator<T> {
+    /**
+     * Validates a passed item against pre-defined rules.
+     * @param {Partial<T>} item The item to validate.
+     * @param {Array<keyof T>} ignoredFields Fields to ignore during validation.
+     * @returns {IValidationResult} The result of the validation.
+     */
+    validate(item: Partial<T>, ignoredFields: Array<keyof T>): IValidationResult;
+}

package/dist/validation/ValidatorRegistry.d.ts

@@ -0,0 +1,23 @@
+import { IValidationResult } from './ValidationResult';
+import { IValidator } from './Validator';
+/**
+ * A registry for managing validators.
+ */
+export declare class ValidatorRegistry<T> {
+    private validators;
+    /**
+     * Retrieves a validator.
+     * @param {string} key The key of the validator to retrieve.
+     * @param {IValidator<T>} validator The validator to register.
+     * @returns {void}
+     */
+    register(key: string, validator: IValidator<T>): void;
+    /**
+     * Validates an item using a registered validator.
+     * @param {string} key The key of the validator to use.
+     * @param {Partial<T>} item The item to validate.
+     * @param {Array<keyof T>} ignoredFields Fields to ignore during validation.
+     * @returns {IValidationResult} The result of the validation.
+     */
+    validate(key: string, item: Partial<T>, ignoredFields: Array<keyof T>): IValidationResult;
+}

package/dist/validation/items/BaseItemValidator.d.ts

@@ -0,0 +1,23 @@
+import { Item } from '../../types/items/Item';
+import { BaseValidator } from '../BaseValidator';
+/**
+ * A base validator for items, providing common validation logic.
+ */
+export declare abstract class BaseItemValidator<T extends Item> extends BaseValidator<T> {
+    /**
+     * @inheritdoc
+     */
+    protected _validateFields(item: Partial<T>): Record<string, string>;
+    /**
+     * Validates common item fields that apply to all item types.
+     * @param {Partial<T>} item The item to validate.
+     * @returns {Record<string, string>} A record of validation errors.
+     */
+    protected _validateBaseFields(item: Partial<T>): Record<string, string>;
+    /**
+     * Validates type-specific fields. Override in subclasses.
+     * @param {Partial<T>} item The item to validate.
+     * @returns {Record<string, string>} A record of validation errors
+     */
+    protected abstract _validateTypeSpecificFields(item: Partial<T>): Record<string, string>;
+}

package/dist/validation/items/BookValidator.d.ts

@@ -0,0 +1,11 @@
+import { IBook } from '../../types/items/Book';
+import { BaseItemValidator } from './BaseItemValidator';
+/**
+ * A validator for book items.
+ */
+export declare class BookValidator extends BaseItemValidator<IBook> {
+    /**
+     * @inheritdoc
+     */
+    protected _validateTypeSpecificFields(book: Partial<IBook>): Record<string, string>;
+}

package/dist/validation/items/GameValidator.d.ts

@@ -0,0 +1,11 @@
+import { IGame } from '../../types/items/Game';
+import { BaseItemValidator } from './BaseItemValidator';
+/**
+ * A validator for game items.
+ */
+export declare class GameValidator extends BaseItemValidator<IGame> {
+    /**
+     * @inheritdoc
+     */
+    protected _validateTypeSpecificFields(game: Partial<IGame>): Record<string, string>;
+}

package/dist/validation/items/ItemValidatorRegistry.d.ts

@@ -0,0 +1,3 @@
+import { Item } from '../../types/items/Item';
+import { ValidatorRegistry } from '../ValidatorRegistry';
+export declare const ItemValidatorRegistry: ValidatorRegistry<Item>;

package/dist/validation/items/MovieValidator.d.ts

@@ -0,0 +1,11 @@
+import { IMovie } from '../../types/items/Movie';
+import { BaseItemValidator } from './BaseItemValidator';
+/**
+ * A validator for movie items.
+ */
+export declare class MovieValidator extends BaseItemValidator<IMovie> {
+    /**
+     * @inheritdoc
+     */
+    protected _validateTypeSpecificFields(movie: Partial<IMovie>): Record<string, string>;
+}

package/dist/validation/items/SeriesValidator.d.ts

@@ -0,0 +1,11 @@
+import { ISeries } from '../../types/items/Series';
+import { BaseItemValidator } from './BaseItemValidator';
+/**
+ * A validator for series items.
+ */
+export declare class SeriesValidator extends BaseItemValidator<ISeries> {
+    /**
+     * @inheritdoc
+     */
+    protected _validateTypeSpecificFields(series: Partial<ISeries>): Record<string, string>;
+}

package/dist/validation/ratings/LeaderboardItemValidator.d.ts

@@ -0,0 +1,11 @@
+import { ILeaderboardItem } from '../../types/ratings/LeaderboardItem';
+import { BaseValidator } from '../BaseValidator';
+/**
+ * A validator for item leaderboardItems.
+ */
+export declare class LeaderboardItemValidator extends BaseValidator<ILeaderboardItem> {
+    /**
+     * @inheritdoc
+     */
+    protected _validateFields(leaderboardItem: Partial<ILeaderboardItem>): Record<string, string>;
+}

package/dist/validation/ratings/LeaderboardSnapshotValidator.d.ts

@@ -0,0 +1,11 @@
+import { ILeaderboardSnapshot } from '../../types/ratings/LeaderboardSnapshot';
+import { BaseValidator } from '../BaseValidator';
+/**
+ * A validator for item leaderboardSnapshots.
+ */
+export declare class LeaderboardSnapshotValidator extends BaseValidator<ILeaderboardSnapshot> {
+    /**
+     * @inheritdoc
+     */
+    protected _validateFields(leaderboardSnapshot: Partial<ILeaderboardSnapshot>): Record<string, string>;
+}

package/dist/validation/ratings/RatingValidator.d.ts

@@ -0,0 +1,11 @@
+import { IRating } from '../../types/ratings/Rating';
+import { BaseValidator } from '../BaseValidator';
+/**
+ * A validator for item ratings.
+ */
+export declare class RatingValidator extends BaseValidator<IRating> {
+    /**
+     * @inheritdoc
+     */
+    protected _validateFields(rating: Partial<IRating>): Record<string, string>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opinio-dev/models",
-  "version": "1.1.0",
+  "version": "1.1.1-item-types.2",
   "type": "module",
   "files": [
     "dist"