dgc-core 2.0.3 → 2.0.5

package/dist/giveaways/domain.js

@@ -69,7 +69,8 @@ function saveGiveaway(raw, existing, expectedRevision) {
         (input.startsAt !== new Date(existing.startsAt).toISOString() ||
             input.closesAt !== new Date(existing.closesAt).toISOString() ||
             input.rules !== existing.rules ||
-            JSON.stringify(input.countries) !== JSON.stringify(existing.countries) ||
+            JSON.stringify(input.countries) !==
+                JSON.stringify(existing.category === giveaway_2.GiveawayCategory.Credits ? [] : existing.countries) ||
             input.category !== existing.category ||
             input.creditAmount !== (existing.creditAmount || 0) ||
             input.claimWindowDays !== (existing.claimWindowDays || 14) ||
@@ -127,6 +128,7 @@ function transition(existing, action, revision) {
     const status = effectiveStatus(existing, clock);
     const g = {
         ...existing,
+        countries: existing.category === giveaway_2.GiveawayCategory.Credits ? [] : existing.countries,
         launch: { ...existing.launch },
         status,
         updatedAt: now,
@@ -177,17 +179,12 @@ function submitEntry(g, account, raw) {
         new Date(g.startsAt) > now ||
         new Date(g.closesAt) <= now)
         throw new http_error_1.HttpError('This giveaway is not accepting entries', 409);
-    const country = input.country;
-    if (g.countries.length && (!country || !g.countries.includes(country)))
-        throw new http_error_1.HttpError('This country is not eligible', 422);
     const at = now.toISOString();
     return {
         giveawayId: g._id,
         userId: account.userId,
-        name: account.name,
+        name: [account.firstName?.trim(), account.lastName?.trim()].filter(Boolean).join(' '),
         email: account.email,
-        username: account.username,
-        country,
         _collectorType: account._collectorType,
         enteredAt: at,
         rulesAcceptedAt: at,

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

@@ -55,12 +55,13 @@ export declare class GiveawayRepository {
         _collectorType: UserCollectorType | null;
         name: string;
         giveawayId: import("../types").GiveawayObjectId;
+        country?: string | undefined;
         enteredAt: string;
-        username?: string | undefined;
         rulesSnapshot: string;
         userId: string;
         address?: import("../types").GiveawayDeliveryAddress | undefined;
-        country?: string | undefined;
+        deliveryName?: string | undefined;
+        contactNumber?: string | undefined;
         rulesAcceptedAt: string;
         marketingConsent: boolean;
         marketingConsentAt: string;

package/dist/giveaways/giveaway-repository.js

@@ -22,10 +22,16 @@ function serialize(record) {
     return { ...record, _id: record._id.toHexString() };
 }
 const statuses = Object.values(giveaway_2.GiveawayStatus);
-/** Normalize historical entry names at read boundaries without rewriting stored records. */
+/** Normalize historical names and omit retired usernames without rewriting stored records. */
 function normalizeEntry(record) {
-    const { fullName, ...fields } = record;
-    return { ...fields, name: record.name ?? fullName ?? '' };
+    const legacy = record;
+    const fields = { ...legacy };
+    delete fields.fullName;
+    delete fields.username;
+    return { ...fields, name: record.name ?? legacy.fullName ?? '' };
+}
+function normalizeCountries(record) {
+    return record.category === giveaway_2.GiveawayCategory.Credits ? { ...record, countries: [] } : record;
 }
 function pagination(params) {
     const integer = (key, fallback, max) => {
@@ -170,7 +176,7 @@ class GiveawayRepository {
         const giveaway = await this.giveaways.findOne({ _id: objectId(id) }, { session, projection });
         if (!giveaway)
             throw new domain_1.DomainError('Giveaway not found', 404);
-        return serialize(giveaway);
+        return normalizeCountries(serialize(giveaway));
     }
     async getPublicGiveaway(id) {
         const g = await this.getGiveaway(id);
@@ -221,7 +227,7 @@ class GiveawayRepository {
             totalCount: total,
             data: rows.map(row => {
                 const g = row;
-                return { ...g, status: (0, domain_1.effectiveStatus)(g) };
+                return { ...normalizeCountries(g), status: (0, domain_1.effectiveStatus)(g) };
             })
         };
     }
@@ -237,7 +243,13 @@ class GiveawayRepository {
         if (country && country !== 'all')
             filter.$and = [
                 ...(filter.$and || []),
-                { $or: [{ countries: country }, { countries: { $size: 0 } }] }
+                {
+                    $or: [
+                        { category: giveaway_2.GiveawayCategory.Credits },
+                        { countries: country },
+                        { countries: { $size: 0 } }
+                    ]
+                }
             ];
         const sort = params.get('sort') || 'recent';
         const order = sort === 'closing'
@@ -256,7 +268,7 @@ class GiveawayRepository {
             this.giveaways.countDocuments(filter)
         ]);
         return {
-            data: rows.map(g => ({ ...g, status: (0, domain_1.effectiveStatus)(g) })),
+            data: rows.map(g => ({ ...normalizeCountries(g), status: (0, domain_1.effectiveStatus)(g) })),
             total,
             page,
             limit
@@ -419,7 +431,6 @@ class GiveawayRepository {
                 'name',
                 'fullName',
                 '_id',
-                'username',
                 'email',
                 'userId',
                 'address.line1',
@@ -893,7 +904,7 @@ class GiveawayRepository {
             .findOne({ _id: objectId(id) }, { session });
         if (!preset)
             throw new domain_1.DomainError('Preset not found', 404);
-        return serialize(preset);
+        return normalizeCountries(serialize(preset));
     }
     async listPresets() {
         return (await this.db
@@ -901,7 +912,7 @@ class GiveawayRepository {
             .find({})
             .sort({ name: 1 })
             .limit(100)
-            .toArray()).map(serialize);
+            .toArray()).map(preset => normalizeCountries(serialize(preset)));
     }
     async installCreditPresets(actor) {
         const now = new Date().toISOString();
@@ -963,7 +974,6 @@ class GiveawayRepository {
                 _id: entry._id,
                 giveawayId: entry.giveawayId,
                 enteredAt: entry.enteredAt,
-                username: entry.username,
                 tickets: 1,
                 rulesSnapshot: entry.rulesSnapshot
             },
@@ -1005,7 +1015,7 @@ class GiveawayRepository {
         };
     }
     async getUserClaim(giveawayId, userId) {
-        const entry = await this.entries.findOne({ giveawayId, userId }, { projection: { _id: 1 } });
+        const entry = await this.entries.findOne({ giveawayId, userId }, { projection: { _id: 1, name: 1, fullName: 1 } });
         if (!entry)
             throw new domain_1.DomainError('Winning entry not found', 404);
         const winner = await this.winners.findOne({ giveawayId, entryId: entry._id, replacedAt: null });
@@ -1026,7 +1036,14 @@ class GiveawayRepository {
             tracking: value.tracking,
             dispatchedAt: value.dispatchedAt,
             creditedAt: value.creditedAt,
-            claimExpired: !value.claimedAt && !!value.claimDeadline && new Date(value.claimDeadline) <= new Date()
+            claimExpired: !value.claimedAt && !!value.claimDeadline && new Date(value.claimDeadline) <= new Date(),
+            ...(value.category === giveaway_2.GiveawayCategory.Products
+                ? {
+                    defaults: {
+                        fullName: value.claim?.fullName ?? normalizeEntry(entry).name
+                    }
+                }
+                : {})
         };
     }
     async claimPrize(giveawayId, userId, raw) {
@@ -1035,7 +1052,7 @@ class GiveawayRepository {
             const entry = await this.entries.findOne({ giveawayId, userId }, { session });
             const winner = entry &&
                 (await this.winners.findOne({ giveawayId, entryId: entry._id, replacedAt: null }, { session }));
-            if (!winner)
+            if (!entry || !winner)
                 throw new domain_1.DomainError('Winning entry not found', 404);
             if (!Object.values(giveaway_2.GiveawayCategory).includes(winner.category))
                 throw new domain_1.DomainError('Invalid giveaway category', 409);
@@ -1047,7 +1064,15 @@ class GiveawayRepository {
                 throw new domain_1.DomainError('The claim window has closed', 409);
             if (winner.category === giveaway_2.GiveawayCategory.Credits)
                 schemas_1.creditClaimSchema.parse(raw);
-            const claim = winner.category === giveaway_2.GiveawayCategory.Products ? schemas_1.physicalClaimSchema.parse(raw) : undefined;
+            const input = winner.category === giveaway_2.GiveawayCategory.Products ? schemas_1.physicalClaimSchema.parse(raw) : undefined;
+            const claim = input
+                ? {
+                    ...input,
+                    fullName: schemas_1.physicalClaimSchema.shape.fullName
+                        .unwrap()
+                        .parse(input.fullName ?? normalizeEntry(entry).name)
+                }
+                : undefined;
             if (claim && g.countries.length && !g.countries.includes(claim.address.country))
                 throw new domain_1.DomainError('This delivery country is not eligible', 422);
             const fields = {
@@ -1059,6 +1084,17 @@ class GiveawayRepository {
                 ...(claim ? { claim } : {})
             };
             await this.winners.updateOne({ _id: winner._id, replacedAt: null }, { $set: fields }, { session });
+            if (claim) {
+                const savedEntry = await this.entries.updateOne({ _id: entry._id, giveawayId, userId }, {
+                    $set: {
+                        deliveryName: claim.fullName,
+                        address: claim.address,
+                        contactNumber: claim.contactNumber
+                    }
+                }, { session });
+                if (!savedEntry.matchedCount)
+                    throw new domain_1.DomainError('Winning entry changed. Please check your claim status.', 409);
+            }
             await this.updateGiveaway({ ...g, revision: g.revision + 1 }, g.revision, session);
             await this.audit(userId, 'Prize claimed', giveawayId, winner._id.toHexString(), session);
             return { ...serialize(winner), ...fields };
@@ -1244,7 +1280,8 @@ class GiveawayRepository {
         });
     }
     async exportEntries(actor, id, marketingOnly) {
-        await this.getGiveaway(id);
+        const giveaway = await this.getGiveaway(id);
+        const includeDelivery = giveaway.category === giveaway_2.GiveawayCategory.Products;
         await this.audit(actor, marketingOnly ? 'Marketing opt-ins export started' : 'Entrants export started', id);
         const pipeline = [
             {
@@ -1269,12 +1306,18 @@ class GiveawayRepository {
                         : [
                             'Name',
                             'Email',
-                            'Address 1',
-                            'Address 2',
-                            'City',
-                            'County / State',
-                            'Postcode / ZIP',
-                            'Country',
+                            ...(includeDelivery
+                                ? [
+                                    'Delivery name',
+                                    'Address 1',
+                                    'Address 2',
+                                    'City',
+                                    'County / State',
+                                    'Postcode / ZIP',
+                                    'Country',
+                                    'Contact number'
+                                ]
+                                : []),
                             'User ID',
                             'Collector type',
                             'Entry time',
@@ -1290,12 +1333,18 @@ class GiveawayRepository {
                         : [
                             e.name,
                             e.email,
-                            e.address?.line1 || '',
-                            e.address?.line2 || '',
-                            e.address?.city || '',
-                            e.address?.region || '',
-                            e.address?.postalCode || '',
-                            e.address?.country || '',
+                            ...(includeDelivery
+                                ? [
+                                    e.deliveryName || '',
+                                    e.address?.line1 || '',
+                                    e.address?.line2 || '',
+                                    e.address?.city || '',
+                                    e.address?.region || '',
+                                    e.address?.postalCode || '',
+                                    e.address?.country || e.country || '',
+                                    e.contactNumber || ''
+                                ]
+                                : []),
                             e.userId,
                             e._collectorType === null ? 'Unknown' : user_1.UserCollectorType[e._collectorType],
                             e.enteredAt,

package/dist/giveaways/schemas.d.ts

@@ -1,7 +1,7 @@
 import { GiveawayCategory, GiveawaySelectionMethod } from '../enums/giveaway';
 import { z } from 'zod';
 export declare const entryIdSchema: z.ZodString;
-export declare const draftSchema: z.ZodObject<{
+export declare const draftSchema: z.ZodPipe<z.ZodObject<{
     images: z.ZodDefault<z.ZodArray<z.ZodString>>;
     title: z.ZodString;
     description: z.ZodString;
@@ -37,8 +37,80 @@ export declare const draftSchema: z.ZodObject<{
             message: z.ZodString;
         }, z.core.$strip>;
     }, z.core.$strip>>;
-}, z.core.$strip>;
-export declare const giveawaySchema: z.ZodObject<{
+}, z.core.$strip>, z.ZodTransform<{
+    countries: string[];
+    images: string[];
+    title: string;
+    description: string;
+    image: string;
+    startsAt: string;
+    closesAt: string;
+    rules: string;
+    category: GiveawayCategory;
+    creditAmount: number;
+    claimWindowDays: number;
+    deliveryInformation: string;
+    prizes: {
+        name: string;
+        quantity: 1;
+        value: number;
+        _id?: string | undefined;
+    }[];
+    launch: {
+        enabled: boolean;
+        title: string;
+        message: string;
+    };
+    reminders: {
+        closing: {
+            enabled: boolean;
+            title: string;
+            message: string;
+        };
+        results: {
+            enabled: boolean;
+            title: string;
+            message: string;
+        };
+    };
+}, {
+    images: string[];
+    title: string;
+    description: string;
+    image: string;
+    startsAt: string;
+    closesAt: string;
+    countries: string[];
+    rules: string;
+    category: GiveawayCategory;
+    creditAmount: number;
+    claimWindowDays: number;
+    deliveryInformation: string;
+    prizes: {
+        name: string;
+        quantity: 1;
+        value: number;
+        _id?: string | undefined;
+    }[];
+    launch: {
+        enabled: boolean;
+        title: string;
+        message: string;
+    };
+    reminders: {
+        closing: {
+            enabled: boolean;
+            title: string;
+            message: string;
+        };
+        results: {
+            enabled: boolean;
+            title: string;
+            message: string;
+        };
+    };
+}>>;
+export declare const giveawaySchema: z.ZodPipe<z.ZodObject<{
     description: z.ZodString;
     image: z.ZodString;
     rules: z.ZodString;
@@ -74,14 +146,85 @@ export declare const giveawaySchema: z.ZodObject<{
             message: z.ZodString;
         }, z.core.$strip>;
     }, z.core.$strip>>;
-}, z.core.$strip>;
+}, z.core.$strip>, z.ZodTransform<{
+    countries: string[];
+    description: string;
+    image: string;
+    rules: string;
+    images: string[];
+    title: string;
+    startsAt: string;
+    closesAt: string;
+    category: GiveawayCategory;
+    creditAmount: number;
+    claimWindowDays: number;
+    deliveryInformation: string;
+    prizes: {
+        name: string;
+        quantity: 1;
+        value: number;
+        _id?: string | undefined;
+    }[];
+    launch: {
+        enabled: boolean;
+        title: string;
+        message: string;
+    };
+    reminders: {
+        closing: {
+            enabled: boolean;
+            title: string;
+            message: string;
+        };
+        results: {
+            enabled: boolean;
+            title: string;
+            message: string;
+        };
+    };
+}, {
+    description: string;
+    image: string;
+    rules: string;
+    images: string[];
+    title: string;
+    startsAt: string;
+    closesAt: string;
+    countries: string[];
+    category: GiveawayCategory;
+    creditAmount: number;
+    claimWindowDays: number;
+    deliveryInformation: string;
+    prizes: {
+        name: string;
+        quantity: 1;
+        value: number;
+        _id?: string | undefined;
+    }[];
+    launch: {
+        enabled: boolean;
+        title: string;
+        message: string;
+    };
+    reminders: {
+        closing: {
+            enabled: boolean;
+            title: string;
+            message: string;
+        };
+        results: {
+            enabled: boolean;
+            title: string;
+            message: string;
+        };
+    };
+}>>;
 export declare const entrySchema: z.ZodObject<{
-    country: z.ZodOptional<z.ZodString>;
     rulesAccepted: z.ZodLiteral<true>;
     marketingConsent: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 export declare const physicalClaimSchema: z.ZodObject<{
-    fullName: z.ZodString;
+    fullName: z.ZodOptional<z.ZodString>;
     address: z.ZodObject<{
         line1: z.ZodString;
         line2: z.ZodDefault<z.ZodString>;
@@ -109,7 +252,7 @@ export declare const selectionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     reason: z.ZodString;
     revision: z.ZodNumber;
 }, z.core.$strip>], "method">;
-export declare const presetSchema: z.ZodObject<{
+export declare const presetSchema: z.ZodPipe<z.ZodObject<{
     name: z.ZodString;
     title: z.ZodString;
     description: z.ZodString;
@@ -120,4 +263,26 @@ export declare const presetSchema: z.ZodObject<{
     countries: z.ZodArray<z.ZodString>;
     rules: z.ZodString;
     deliveryInformation: z.ZodDefault<z.ZodString>;
-}, z.core.$strip>;
+}, z.core.$strip>, z.ZodTransform<{
+    countries: string[];
+    name: string;
+    title: string;
+    description: string;
+    image: string;
+    images: string[];
+    category: GiveawayCategory;
+    creditAmount: number;
+    rules: string;
+    deliveryInformation: string;
+}, {
+    name: string;
+    title: string;
+    description: string;
+    image: string;
+    images: string[];
+    category: GiveawayCategory;
+    creditAmount: number;
+    countries: string[];
+    rules: string;
+    deliveryInformation: string;
+}>>;

package/dist/giveaways/schemas.js

@@ -67,7 +67,8 @@ exports.draftSchema = zod_1.z
     .refine(v => new Date(v.closesAt) > new Date(v.startsAt), {
     message: 'Closing time must be after start time',
     path: ['closesAt']
-});
+})
+    .transform(v => ({ ...v, countries: v.category === giveaway_1.GiveawayCategory.Credits ? [] : v.countries }));
 exports.giveawaySchema = zod_1.z
     .object({
     ...fields,
@@ -86,14 +87,14 @@ exports.giveawaySchema = zod_1.z
     for (const [name, value] of Object.entries({ launch: v.launch, ...v.reminders }))
         if (value.enabled && (!value.title || !value.message))
             issue([name], 'Add a push title and message');
-});
+})
+    .transform(v => ({ ...v, countries: v.category === giveaway_1.GiveawayCategory.Credits ? [] : v.countries }));
 exports.entrySchema = zod_1.z.object({
-    country: country.optional(),
     rulesAccepted: zod_1.z.literal(true, { error: 'You must agree to the giveaway rules' }),
     marketingConsent: zod_1.z.boolean().default(false)
 });
 exports.physicalClaimSchema = zod_1.z.object({
-    fullName: zod_1.z.string().trim().min(2).max(120),
+    fullName: zod_1.z.string().trim().min(2).max(120).optional(),
     address: zod_1.z.object({
         line1: zod_1.z.string().trim().min(2).max(200),
         line2: zod_1.z.string().trim().max(200).default(''),
@@ -139,4 +140,5 @@ exports.presetSchema = zod_1.z
     .refine(v => v.category !== giveaway_1.GiveawayCategory.Credits || v.creditAmount > 0, {
     message: 'Configure the instant credit reward amount',
     path: ['creditAmount']
-});
+})
+    .transform(v => ({ ...v, countries: v.category === giveaway_1.GiveawayCategory.Credits ? [] : v.countries }));

package/dist/types/giveaway.d.ts

@@ -72,10 +72,12 @@ export type GiveawayEntry = {
     userId: string;
     name: string;
     email: string;
-    /** Historical entry addresses are retained; new entries collect delivery only at claim. */
+    /** Product delivery details are recorded only after the winner claims. */
     address?: GiveawayDeliveryAddress;
+    deliveryName?: string;
+    contactNumber?: string;
+    /** Retained only for historical entry records; new entries collect country at claim. */
     country?: string;
-    username?: string;
     /** Null only for legacy entries whose exact collector tier was not recorded. */
     _collectorType: UserCollectorType | null;
     enteredAt: string;
@@ -180,17 +182,21 @@ export type GiveawayOverviewData = {
     liveGiveaways: GiveawaySummary[];
     needsSelection: Giveaway[];
 };
-export type GiveawayUserProfile = Pick<FbUser, 'email' | 'name' | '_collectorType'> & {
+export type GiveawayUserProfile = Pick<FbUser, 'email' | 'firstName' | 'lastName' | '_collectorType'> & {
     userId: string;
-    username?: string;
 };
 export type GiveawayPhysicalClaim = {
     fullName: string;
     address: GiveawayDeliveryAddress;
     contactNumber: string;
 };
+export type GiveawayPhysicalClaimInput = {
+    fullName?: string;
+    address: Omit<GiveawayDeliveryAddress, 'line2' | 'region'> & Partial<Pick<GiveawayDeliveryAddress, 'line2' | 'region'>>;
+    contactNumber: string;
+};
 export type GiveawayTicket = {
-    entry: Pick<GiveawayEntry, '_id' | 'giveawayId' | 'enteredAt' | 'username' | 'rulesSnapshot'> & {
+    entry: Pick<GiveawayEntry, '_id' | 'giveawayId' | 'enteredAt' | 'rulesSnapshot'> & {
         tickets: 1;
     };
     giveaway: Pick<Giveaway, '_id' | 'title' | 'image' | 'creditAmount' | 'closesAt' | 'status' | 'category'>;
@@ -199,6 +205,10 @@ export type GiveawayTicket = {
 };
 export type GiveawayClaim = Pick<GiveawayWinner, '_id' | 'giveawayId' | 'entryId' | 'creditAmount' | 'category' | 'status' | 'claimDeadline' | 'claimedAt' | 'claim' | 'courier' | 'tracking' | 'dispatchedAt' | 'creditedAt'> & {
     claimExpired: boolean;
+    /** Product delivery name defaults to the entrant name and may be edited. */
+    defaults?: {
+        fullName: string;
+    };
 };
 export type GiveawayPreset = {
     _id: GiveawayObjectId;
@@ -247,7 +257,6 @@ export type GiveawayTransitionInput = {
     revision: number;
 };
 export type GiveawayEntryInput = {
-    country?: string;
     rulesAccepted: true;
     marketingConsent?: boolean;
 };

package/dist/types/user.d.ts

@@ -8,10 +8,8 @@ export type FbUser = {
         count: number;
     };
     email: string;
-    /** Full name stored on the Firebase account. */
-    name: string;
     fcmTokens: Record<string, boolean>;
-    firstName: string;
+    firstName?: string;
     fundAmount: number;
     fundalert: number;
     id: string;
@@ -22,7 +20,7 @@ export type FbUser = {
     isFacebookUser: boolean;
     lastCardIndex: number;
     lastGradingTime: number;
-    lastName: string;
+    lastName?: string;
     soldCards: {
         count: number;
     };

package/package.json

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