@opinio-dev/models 1.2.0 → 1.2.1-item-details.1

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

@@ -1,7 +1,11 @@
-export interface ILeaderboardItem {
+import { Item } from '../items/Item';
+export interface ILeaderboardItemStored {
     id: string;
     itemId: string;
     rank: number;
     rating: number;
     numberOfRatings: number;
 }
+export interface ILeaderboardItem extends ILeaderboardItemStored {
+    itemDetails: Item;
+}

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

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

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

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

package/dist/validation/ratings/LeaderboardItemValidator.js

@@ -1,13 +1,13 @@
 import { BaseValidator } from '../BaseValidator.js';
 /**
- * A validator for item leaderboardItems.
+ * A validator for leaderboardItems.
  */
 export class LeaderboardItemValidator extends BaseValidator {
     /**
      * @inheritdoc
      */
-    _validateFields(leaderboardItem) {
-        const { id, itemId, rank, rating, numberOfRatings } = leaderboardItem;
+    _validateFields(item) {
+        const { id, itemId, rank, rating, numberOfRatings } = item;
         const errors = {};
         if (!id) {
             errors.id = 'Rating id is required';

package/dist/validation/ratings/LeaderboardSnapshotValidator.js

@@ -8,7 +8,7 @@ export class LeaderboardSnapshotValidator extends BaseValidator {
      * @inheritdoc
      */
     _validateFields(leaderboardSnapshot) {
-        const { id, itemType, leaderboardItems, date } = leaderboardSnapshot;
+        const { id, itemType, items, date } = leaderboardSnapshot;
         const errors = {};
         if (!id) {
             errors.id = 'Rating id is required';
@@ -19,8 +19,8 @@ export class LeaderboardSnapshotValidator extends BaseValidator {
         if (itemType && !ItemTypes.includes(itemType)) {
             errors.itemType = `LeaderboardSnapshot itemType must be one of: ${ItemTypes.join(', ')}`;
         }
-        if (!leaderboardItems) {
-            errors.leaderboardItems = 'Leaderboard items are required';
+        if (!items) {
+            errors.items = 'Leaderboard items are required';
         }
         if (!date) {
             errors.date = 'Rating date is required';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opinio-dev/models",
-  "version": "1.2.0",
+  "version": "1.2.1-item-details.1",
   "type": "module",
   "files": [
     "dist"