@positivegrid/pg-mongoose-schema 28.0.0-beta.7 → 28.0.0-beta.9

package/dist/index.cjs

@@ -4339,6 +4339,32 @@ function buildToneThemeFeaturedList(mongoose) {
 }
 //#endregion
 //#region src/models/user.ts
+/**
+* Map a reward-history `event` string to a UI-facing description.
+*
+* Event grammar (from pg-mongoose-helper):
+*   order_reward:${shopifyOrderId}
+*   order_refund:${shopifyOrderId}
+*   register_product_reward:${productSn}
+*   zero_data_reward:${uniqueKey}
+*   admin_adjust:${timestamp}
+*   redeem:${rewardId}:${timestamp}
+*/
+function _rewardHistoryDisplayText(event) {
+	if (typeof event !== "string" || event.length === 0) return "";
+	const colonIdx = event.indexOf(":");
+	const prefix = colonIdx === -1 ? event : event.slice(0, colonIdx);
+	const tail = colonIdx === -1 ? "" : event.slice(colonIdx + 1);
+	switch (prefix) {
+		case "order_reward": return tail ? `Reward points from Order #${tail}` : "Reward points from order";
+		case "order_refund": return tail ? `Refund deduction for Order #${tail}` : "Refund deduction";
+		case "register_product_reward": return tail ? `Reward points from product registration (${tail})` : "Reward points from product registration";
+		case "zero_data_reward": return "Reward points from Zero-Party Data submission";
+		case "admin_adjust": return "Admin adjustment";
+		case "redeem": return "Reward redemption";
+		default: return event;
+	}
+}
 const log$2 = (0, node_util.debuglog)("model:user");
 /**
 * Error thrown by User auth statics. Replaces the previous dependency on
@@ -4805,11 +4831,19 @@ function buildUser(mongoose) {
 			type: Date,
 			default: Date.now
 		}
-	}, { collection: "user_reward_history" });
+	}, {
+		collection: "user_reward_history",
+		toJSON: { virtuals: true },
+		toObject: { virtuals: true }
+	});
 	UserRewardHistorySchema.index({
 		user_point_id: 1,
 		event: 1
 	}, { unique: true });
+	UserRewardHistorySchema.virtual("display_text").get(function() {
+		return _rewardHistoryDisplayText(this.event ?? "");
+	});
+	UserRewardHistorySchema.plugin(mongoose_lean_virtuals.default);
 	const RewardPointsRedeemListSchema = new Schema({
 		name: {
 			type: String,
@@ -4821,6 +4855,10 @@ function buildUser(mongoose) {
 			default: []
 		},
 		collection_handle: { type: String },
+		apply_to_all: {
+			type: Boolean,
+			default: false
+		},
 		discount_percent: {
 			type: Number,
 			required: true

package/dist/index.d.mts

@@ -186,11 +186,19 @@ interface IUserRewardHistory {
   created_on: Date;
   updated_on: Date;
 }
+/**
+ * Virtual fields surfaced on UserRewardHistory documents. Use
+ * `.lean({ virtuals: true })` or `toJSON: { virtuals: true }` to see them.
+ */
+interface IUserRewardHistoryVirtuals {
+  display_text: string;
+}
 interface IRewardPointsRedeemList {
   name: string;
   description?: string;
   skus: string[];
   collection_handle?: string;
+  apply_to_all: boolean;
   discount_percent: number;
   points_required: number;
   created_on: Date;
@@ -1332,4 +1340,4 @@ type DemoUserTrackerDoc = HydratedDocument<IDemoUserTracker>;
 type RegistryType = "account" | "hardware" | undefined;
 declare function register(mongoose: Mongoose, type?: RegistryType): void;
 //#endregion
-export { type AccessTokenModel, type ActivationStatusModel, type AdditionalPurchaseModel, AuthError, type AuthorizationCodeDoc, type AuthorizationCodeModel, type B2bDealerModel, type B2bRedeemModel, type B2bRedeemOrderModel, type BankListDoc, type BankListModel, type BankPresetsDoc, type BankPresetsModel, type BanksModels, type BcCartUpdateStatusModel, type CAMPAIGN_TYPE, type CnCouponDoc, type CnCouponMethods, type CnCouponModel, type CnSalesMetaModel, type CountryHardwareSkuModel, type CrashDataModel, type DataSourceType, type DemoUserTrackerDoc, type DemoUserTrackerModel, type DeviceDoc, type DeviceModel, type DeviceModels, type FLAG_EMAIL_EVENTS, type FeaturedListDoc, type FeaturedListModel, type FeaturedListModels, type FeaturedPresetModel, type GenericDataModel, type HardwareActivationConflictModel, type HardwareActivationMetaModel, type HardwareActivationRecordModel, type HardwareModels, type HardwareSeriesNumberModel, type HomeConfigDoc, type HomeConfigModel, type IAccessToken, type IActionButton, type IActivationStatus, type IApikey, type IAuthorizationCode, type IB2bDealer, type IB2bRedeem, type IB2bRedeemOrder, type IBankList, type IBankPresets, type ICampaignUserInfo, type ICnCoupon, type ICountryHardwareSku, type ICouponPromotion, type ICrashData, type IDataSource, type IDemoUserTracker, type IDevice, type IFeaturedList, type IFeaturedListVirtuals, type IFeaturedPreset, type IFreeTrial, type IGearTrialMeta, type IGearTrialRecord, type IGenericData, type IHardwareActivationConflict, type IHardwareActivationMeta, type IHardwareActivationRecord, type IHardwareSeriesNumber, type IHomeConfig, type IIapActivation, type IIapEvent, type IIasBuyOption, type IIasPromotion, type IIasStorePageMeta, type IIntermediateUserOrderReward, type IItemInventoryHistory, type IKeyValue, type ILicense, type ILicenseCampaignMeta, type ILicenseCampaignRecord, type ILicenseVirtuals, type IOauthClient, type IOemRedeemPromotion, type IPartnerCoupon, type IPartnerRedeem, type IPartnerSalesHistory, type IPartnerSalesMeta, type IPgConfig, type IPgLogging, type IPreset, type IPresetVirtuals, type IProduct, type IPromotion, type IPublicAnnouncement, type IPublicAnnouncementFreeTrial, type IPublicAnnouncementUserList, type IPublicAnnouncementUserListLog, type IRedeemCode, type IRefreshToken, type IRewardPointsRedeemList, type ISection, type ISpecialOffer, type ITierSalesMeta, type ITierSalesRules, type IToneTheme, type IToneThemeFeaturedList, type IToneThemeVirtuals, type IUser, type IUserAddress, type IUserAuth, type IUserEmailStatus, type IUserFollow, type IUserMetadata, type IUserMethods, type IUserPoints, type IUserProduct, type IUserProductTracker, type IUserProfile, type IUserRedeemRewardPointsRecord, type IUserReferral, type IUserRewardHistory, type IUserToken, type IUserVirtuals, type IWarehouseInventory, type IYotpoLoyalty, type IYotpoLoyaltyBackup, type IapActivationModel, type IapEventModel, type ItemInventoryHistoryModel, type KeyValueModel, type LICENSE_ADDITION, type LicenseAdditionKey, type LicenseDoc, type LicenseModel, type LicenseUpgradeMetaModel, type OEM_APOGEE_SUPPORT_LICENSE, type OEM_FOCUSRITE_SUPPORT_LICENSE, type OEM_PROMOTION_TYPE, type OEM_PROSONUS_SUPPORT_LICENSE, type OauthClientModel, type OauthModels, type OemRedeemPromotionModel, type PRODUCTS, type PURCHASE_ITEM_TYPE, type ParsedGenericSerialNumber, type ParsedSerialNumber, type ParsedSparkSerialNumber, type PartnerCouponModel, type PartnerModels, type PartnerRedeemModel, type PartnerSalesHistoryModel, type PartnerSalesMetaModel, type PaymentModels, type PgConfigDoc, type PgConfigModel, type PgConfigModels, type PgLoggingModel, type PresetCommentModel, type PresetDoc, type PresetLikeModel, type PresetModel, type PresetModels, type Product, type ProductModel, type PromotionModels, type PublicAnnouncementDoc, type PublicAnnouncementFreeTrialModel, type PublicAnnouncementModel, type PublicAnnouncementUserListModel, type RedeemCodeDoc, type RedeemCodeModel, type RefreshTokenModel, RegistryType, type SaveTrackInput, type SectionType, type SimpleModel, type ToneThemeDoc, type ToneThemeFeaturedListDoc, type ToneThemeFeaturedListModel, type ToneThemeModel, type UserDoc, type UserModel, type UserModels, type UserProductModel, type UserProfileDoc, type UserProfileModel, type UserTokenDoc, type UserTokenModel, type UserTrackModels, type WarehouseInventoryModel, type _buildLicenseTierQuery, type _buildPresetVersionQuery, type _buildSortQuery, type _filterKeyword, type _handlePresetVersion, type _identifyHardwareByModel, type _identifyItemTypeBySku, type _oemMetaToLicenseName, type _parseHardwareSerialNumber, type _parsePageParams, type _queryCompatibilityHandler, register as default, register };
+export { type AccessTokenModel, type ActivationStatusModel, type AdditionalPurchaseModel, AuthError, type AuthorizationCodeDoc, type AuthorizationCodeModel, type B2bDealerModel, type B2bRedeemModel, type B2bRedeemOrderModel, type BankListDoc, type BankListModel, type BankPresetsDoc, type BankPresetsModel, type BanksModels, type BcCartUpdateStatusModel, type CAMPAIGN_TYPE, type CnCouponDoc, type CnCouponMethods, type CnCouponModel, type CnSalesMetaModel, type CountryHardwareSkuModel, type CrashDataModel, type DataSourceType, type DemoUserTrackerDoc, type DemoUserTrackerModel, type DeviceDoc, type DeviceModel, type DeviceModels, type FLAG_EMAIL_EVENTS, type FeaturedListDoc, type FeaturedListModel, type FeaturedListModels, type FeaturedPresetModel, type GenericDataModel, type HardwareActivationConflictModel, type HardwareActivationMetaModel, type HardwareActivationRecordModel, type HardwareModels, type HardwareSeriesNumberModel, type HomeConfigDoc, type HomeConfigModel, type IAccessToken, type IActionButton, type IActivationStatus, type IApikey, type IAuthorizationCode, type IB2bDealer, type IB2bRedeem, type IB2bRedeemOrder, type IBankList, type IBankPresets, type ICampaignUserInfo, type ICnCoupon, type ICountryHardwareSku, type ICouponPromotion, type ICrashData, type IDataSource, type IDemoUserTracker, type IDevice, type IFeaturedList, type IFeaturedListVirtuals, type IFeaturedPreset, type IFreeTrial, type IGearTrialMeta, type IGearTrialRecord, type IGenericData, type IHardwareActivationConflict, type IHardwareActivationMeta, type IHardwareActivationRecord, type IHardwareSeriesNumber, type IHomeConfig, type IIapActivation, type IIapEvent, type IIasBuyOption, type IIasPromotion, type IIasStorePageMeta, type IIntermediateUserOrderReward, type IItemInventoryHistory, type IKeyValue, type ILicense, type ILicenseCampaignMeta, type ILicenseCampaignRecord, type ILicenseVirtuals, type IOauthClient, type IOemRedeemPromotion, type IPartnerCoupon, type IPartnerRedeem, type IPartnerSalesHistory, type IPartnerSalesMeta, type IPgConfig, type IPgLogging, type IPreset, type IPresetVirtuals, type IProduct, type IPromotion, type IPublicAnnouncement, type IPublicAnnouncementFreeTrial, type IPublicAnnouncementUserList, type IPublicAnnouncementUserListLog, type IRedeemCode, type IRefreshToken, type IRewardPointsRedeemList, type ISection, type ISpecialOffer, type ITierSalesMeta, type ITierSalesRules, type IToneTheme, type IToneThemeFeaturedList, type IToneThemeVirtuals, type IUser, type IUserAddress, type IUserAuth, type IUserEmailStatus, type IUserFollow, type IUserMetadata, type IUserMethods, type IUserPoints, type IUserProduct, type IUserProductTracker, type IUserProfile, type IUserRedeemRewardPointsRecord, type IUserReferral, type IUserRewardHistory, type IUserRewardHistoryVirtuals, type IUserToken, type IUserVirtuals, type IWarehouseInventory, type IYotpoLoyalty, type IYotpoLoyaltyBackup, type IapActivationModel, type IapEventModel, type ItemInventoryHistoryModel, type KeyValueModel, type LICENSE_ADDITION, type LicenseAdditionKey, type LicenseDoc, type LicenseModel, type LicenseUpgradeMetaModel, type OEM_APOGEE_SUPPORT_LICENSE, type OEM_FOCUSRITE_SUPPORT_LICENSE, type OEM_PROMOTION_TYPE, type OEM_PROSONUS_SUPPORT_LICENSE, type OauthClientModel, type OauthModels, type OemRedeemPromotionModel, type PRODUCTS, type PURCHASE_ITEM_TYPE, type ParsedGenericSerialNumber, type ParsedSerialNumber, type ParsedSparkSerialNumber, type PartnerCouponModel, type PartnerModels, type PartnerRedeemModel, type PartnerSalesHistoryModel, type PartnerSalesMetaModel, type PaymentModels, type PgConfigDoc, type PgConfigModel, type PgConfigModels, type PgLoggingModel, type PresetCommentModel, type PresetDoc, type PresetLikeModel, type PresetModel, type PresetModels, type Product, type ProductModel, type PromotionModels, type PublicAnnouncementDoc, type PublicAnnouncementFreeTrialModel, type PublicAnnouncementModel, type PublicAnnouncementUserListModel, type RedeemCodeDoc, type RedeemCodeModel, type RefreshTokenModel, RegistryType, type SaveTrackInput, type SectionType, type SimpleModel, type ToneThemeDoc, type ToneThemeFeaturedListDoc, type ToneThemeFeaturedListModel, type ToneThemeModel, type UserDoc, type UserModel, type UserModels, type UserProductModel, type UserProfileDoc, type UserProfileModel, type UserTokenDoc, type UserTokenModel, type UserTrackModels, type WarehouseInventoryModel, type _buildLicenseTierQuery, type _buildPresetVersionQuery, type _buildSortQuery, type _filterKeyword, type _handlePresetVersion, type _identifyHardwareByModel, type _identifyItemTypeBySku, type _oemMetaToLicenseName, type _parseHardwareSerialNumber, type _parsePageParams, type _queryCompatibilityHandler, register as default, register };

package/dist/index.mjs

@@ -4311,6 +4311,32 @@ function buildToneThemeFeaturedList(mongoose) {
 }
 //#endregion
 //#region src/models/user.ts
+/**
+* Map a reward-history `event` string to a UI-facing description.
+*
+* Event grammar (from pg-mongoose-helper):
+*   order_reward:${shopifyOrderId}
+*   order_refund:${shopifyOrderId}
+*   register_product_reward:${productSn}
+*   zero_data_reward:${uniqueKey}
+*   admin_adjust:${timestamp}
+*   redeem:${rewardId}:${timestamp}
+*/
+function _rewardHistoryDisplayText(event) {
+	if (typeof event !== "string" || event.length === 0) return "";
+	const colonIdx = event.indexOf(":");
+	const prefix = colonIdx === -1 ? event : event.slice(0, colonIdx);
+	const tail = colonIdx === -1 ? "" : event.slice(colonIdx + 1);
+	switch (prefix) {
+		case "order_reward": return tail ? `Reward points from Order #${tail}` : "Reward points from order";
+		case "order_refund": return tail ? `Refund deduction for Order #${tail}` : "Refund deduction";
+		case "register_product_reward": return tail ? `Reward points from product registration (${tail})` : "Reward points from product registration";
+		case "zero_data_reward": return "Reward points from Zero-Party Data submission";
+		case "admin_adjust": return "Admin adjustment";
+		case "redeem": return "Reward redemption";
+		default: return event;
+	}
+}
 const log$2 = debuglog("model:user");
 /**
 * Error thrown by User auth statics. Replaces the previous dependency on
@@ -4777,11 +4803,19 @@ function buildUser(mongoose) {
 			type: Date,
 			default: Date.now
 		}
-	}, { collection: "user_reward_history" });
+	}, {
+		collection: "user_reward_history",
+		toJSON: { virtuals: true },
+		toObject: { virtuals: true }
+	});
 	UserRewardHistorySchema.index({
 		user_point_id: 1,
 		event: 1
 	}, { unique: true });
+	UserRewardHistorySchema.virtual("display_text").get(function() {
+		return _rewardHistoryDisplayText(this.event ?? "");
+	});
+	UserRewardHistorySchema.plugin(mongooseLeanVirtuals);
 	const RewardPointsRedeemListSchema = new Schema({
 		name: {
 			type: String,
@@ -4793,6 +4827,10 @@ function buildUser(mongoose) {
 			default: []
 		},
 		collection_handle: { type: String },
+		apply_to_all: {
+			type: Boolean,
+			default: false
+		},
 		discount_percent: {
 			type: Number,
 			required: true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@positivegrid/pg-mongoose-schema",
-  "version": "28.0.0-beta.7",
+  "version": "28.0.0-beta.9",
   "description": "Positive Grid mongoose schema",
   "author": "Ferrari Lee <shiyung@positivegrid.com>",
   "homepage": "https://git.positivegrid.com:8443/backend/pg-mongoose-schema",
@@ -9,7 +9,6 @@
     "url": "https://git.positivegrid.com:8443/backend/pg-mongoose-schema.git"
   },
   "type": "module",
-  "packageManager": "pnpm@11.1.2",
   "engines": {
     "node": ">=22"
   },
@@ -36,18 +35,6 @@
     "registry": "https://registry.npmjs.org/",
     "access": "restricted"
   },
-  "scripts": {
-    "build": "tsdown",
-    "typecheck": "tsc --noEmit",
-    "lint": "oxlint",
-    "format": "oxfmt src test",
-    "_format_check_disabled": "oxfmt 0.1.0 is pre-release and mangles TypeScript syntax; re-enable when stable",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:cov": "vitest run --coverage",
-    "test:interop": "node --test test/interop/*.test.mjs test/interop/*.test.cjs",
-    "prepublishOnly": "pnpm lint && pnpm typecheck && pnpm test && pnpm build && pnpm test:interop"
-  },
   "peerDependencies": {
     "mongoose": ">=6"
   },
@@ -71,5 +58,16 @@
     "tsdown": "~0.22.0",
     "typescript": "^5.7.0",
     "vitest": "^2.1.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint",
+    "format": "oxfmt src test",
+    "_format_check_disabled": "oxfmt 0.1.0 is pre-release and mangles TypeScript syntax; re-enable when stable",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:cov": "vitest run --coverage",
+    "test:interop": "node --test test/interop/*.test.mjs test/interop/*.test.cjs"
   }
-}
+}