dgc-core 2.0.0 → 2.0.1

package/dist/giveaways/api-pagination.d.ts

@@ -0,0 +1,6 @@
+/** Mobile giveaway pagination; private dashboard pagination keeps its own contract. */
+export declare function parseGiveawayApiPagination(params: URLSearchParams): {
+    page: number;
+    pageSize: number;
+    skip: number;
+};

package/dist/giveaways/api-pagination.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseGiveawayApiPagination = parseGiveawayApiPagination;
+const http_error_1 = require("../http-error");
+/** Mobile giveaway pagination; private dashboard pagination keeps its own contract. */
+function parseGiveawayApiPagination(params) {
+    const invalid = () => new http_error_1.HttpError('Invalid page or size parameter', 400);
+    const integer = (key, fallback) => {
+        const values = params.getAll(key);
+        if (!values.length)
+            return fallback;
+        if (values.length !== 1 || !/^\d+$/.test(values[0]))
+            throw invalid();
+        const value = Number(values[0]);
+        if (!Number.isSafeInteger(value) || value < 1)
+            throw invalid();
+        return value;
+    };
+    const page = integer('page', 1);
+    const pageSize = integer('size', 20);
+    const skip = (page - 1) * pageSize;
+    if (pageSize > 50 || !Number.isSafeInteger(skip))
+        throw invalid();
+    return { page, pageSize, skip };
+}

package/dist/giveaways/giveaway-repository.d.ts

@@ -1,7 +1,7 @@
 import { GiveawayAction, GiveawayCategory, GiveawaySelectionMethod, GiveawayStatus, GiveawayWinnerStatus } from '../enums/giveaway';
 import { UserCollectorType } from '../enums/user';
 import type { ClientSession, Db, MongoClient } from 'mongodb';
-import type { GiveawayPreset, GiveawayTicket, GiveawayClaim } from '../types';
+import type { GiveawayPreset, GiveawayTicket, GiveawayClaim, PaginatedApiResponse } from '../types';
 import type { UserProfile, AuditEvent, DashboardData, Entry, EntryRecord, Giveaway, GiveawayDetailData, GiveawaySummary, NotificationJob, NotificationRecord, OverviewData, PageResult, Winner, WinnerRecord } from './types';
 type Stored<T extends {
     _id: string;
@@ -26,7 +26,7 @@ export declare class GiveawayRepository {
     private audit;
     getGiveaway(id: string, session?: ClientSession): Promise<Giveaway>;
     getPublicGiveaway(id: string): Promise<GiveawaySummary>;
-    listPublicGiveaways(params?: URLSearchParams): Promise<PageResult<GiveawaySummary>>;
+    listPublicGiveaways(params?: URLSearchParams): Promise<PaginatedApiResponse<GiveawaySummary>>;
     listGiveaways(params?: URLSearchParams): Promise<PageResult<GiveawaySummary>>;
     getDashboard(admin: string): Promise<DashboardData>;
     getOverview(days?: number): Promise<OverviewData>;
@@ -233,12 +233,7 @@ export declare class GiveawayRepository {
         _id: string;
     }>;
     getTicket(userId: string, entryId: string): Promise<GiveawayTicket>;
-    listTickets(userId: string, params: URLSearchParams): Promise<{
-        data: GiveawayTicket[];
-        total: number;
-        page: number;
-        limit: number;
-    }>;
+    listTickets(userId: string, params: URLSearchParams): Promise<PaginatedApiResponse<GiveawayTicket>>;
     getUserClaim(giveawayId: string, userId: string): Promise<GiveawayClaim>;
     claimPrize(giveawayId: string, userId: string, raw: unknown): Promise<Omit<import("mongodb").WithId<Stored<Winner>>, "_id"> & {
         _id: string;

package/dist/giveaways/giveaway-repository.js

@@ -8,6 +8,7 @@ const user_1 = require("../enums/user");
 const node_crypto_1 = require("node:crypto");
 const mongodb_1 = require("mongodb");
 const entry_id_1 = require("./entry-id");
+const api_pagination_1 = require("./api-pagination");
 const domain_1 = require("./domain");
 const schemas_1 = require("./schemas");
 const projection = { entryVersion: 0 };
@@ -179,9 +180,7 @@ class GiveawayRepository {
         return { ...g, status, entryCount: await this.entries.countDocuments({ giveawayId: id }) };
     }
     async listPublicGiveaways(params = new URLSearchParams()) {
-        const { page, limit: requestedLimit } = pagination(params);
-        const limit = Math.min(requestedLimit, 50);
-        const skip = (page - 1) * limit;
+        const { page, pageSize, skip } = (0, api_pagination_1.parseGiveawayApiPagination)(params);
         const filter = {
             $or: [
                 {
@@ -204,20 +203,21 @@ class GiveawayRepository {
                 { $match: filter },
                 { $sort: { createdAt: -1, _id: 1 } },
                 { $skip: skip },
-                { $limit: limit },
+                { $limit: pageSize },
                 ...entryCountLookup
             ])
                 .toArray(),
             this.giveaways.countDocuments(filter)
         ]);
         return {
+            page,
+            pageSize,
+            count: rows.length,
+            totalCount: total,
             data: rows.map(row => {
                 const g = row;
                 return { ...g, status: (0, domain_1.effectiveStatus)(g) };
-            }),
-            total,
-            page,
-            limit
+            })
         };
     }
     async listGiveaways(params = new URLSearchParams()) {
@@ -978,24 +978,23 @@ class GiveawayRepository {
         };
     }
     async listTickets(userId, params) {
-        const { page, limit: requestedLimit } = pagination(params);
-        const limit = Math.min(requestedLimit, 50);
-        const skip = (page - 1) * limit;
+        const { page, pageSize, skip } = (0, api_pagination_1.parseGiveawayApiPagination)(params);
         const filter = { userId };
         const [entries, total] = await Promise.all([
             this.entries
                 .find(filter, { projection: { _id: 1 } })
                 .sort({ enteredAt: -1, _id: 1 })
                 .skip(skip)
-                .limit(limit)
+                .limit(pageSize)
                 .toArray(),
             this.entries.countDocuments(filter)
         ]);
         return {
-            data: await Promise.all(entries.map(e => this.getTicket(userId, e._id))),
-            total,
             page,
-            limit
+            pageSize,
+            count: entries.length,
+            totalCount: total,
+            data: await Promise.all(entries.map(e => this.getTicket(userId, e._id)))
         };
     }
     async getUserClaim(giveawayId, userId) {

package/dist/giveaways/index.d.ts

@@ -1,5 +1,6 @@
 /** Server-only giveaway rules and persistence shared by the admin dashboard and cloud APIs. */
 export * from './domain';
+export * from './api-pagination';
 export * from './entry-id';
 export * from './giveaway-repository';
 export * from './schemas';

package/dist/giveaways/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /** Server-only giveaway rules and persistence shared by the admin dashboard and cloud APIs. */
 __exportStar(require("./domain"), exports);
+__exportStar(require("./api-pagination"), exports);
 __exportStar(require("./entry-id"), exports);
 __exportStar(require("./giveaway-repository"), exports);
 __exportStar(require("./schemas"), exports);

package/dist/types/api.d.ts

@@ -0,0 +1,12 @@
+/** Successful non-paginated DGC API response. */
+export type ApiResponse<T> = {
+    data: T;
+};
+/** Successful paginated DGC API response. count is the number of returned records. */
+export type PaginatedApiResponse<T> = {
+    page: number;
+    pageSize: number;
+    count: number;
+    totalCount: number;
+    data: T[];
+};

package/dist/types/api.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export * from '../enums/card';
 export * from '../enums/rc';
 export * from '../enums/user';
 export * from './blockchain';
+export * from './api';
 export * from './card';
 export * from './embedding';
 export * from './env';

package/dist/types/index.js

@@ -21,6 +21,7 @@ __exportStar(require("../enums/card"), exports);
 __exportStar(require("../enums/rc"), exports);
 __exportStar(require("../enums/user"), exports);
 __exportStar(require("./blockchain"), exports);
+__exportStar(require("./api"), exports);
 __exportStar(require("./card"), exports);
 __exportStar(require("./embedding"), exports);
 __exportStar(require("./env"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dgc-core",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Shared DGC contracts, business rules and server utilities",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",