@nimee/shared-types 1.0.326 → 1.0.329

package/dist/account/account.d.ts

@@ -220,6 +220,7 @@ export interface IAccountModel {
     subscriptionWalletDesign?: IWalletDesign;
     marketplaceDistributionId: string;
     isAllowSeasonTicket: boolean;
+    diningDefaultMonthlyAmount?: number;
     lockEndUserProfile?: boolean;
     hideCustomerChargesTab?: boolean;
     seasonTicketGrantsEntrance: boolean;

package/dist/account/account.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.js","sourceRoot":"","sources":["../../src/account/account.ts"],"names":[],"mappings":";;;AAMA,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,mEAAY,CAAA;IACZ,+DAAU,CAAA;IACV,+DAAU,CAAA;IACV,iEAAW,CAAA;IACX,6DAAS,CAAA;IACT,6DAAS,CAAA;AACX,CAAC,EAVW,kBAAkB,kCAAlB,kBAAkB,QAU7B;AACD,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sCAAqB,CAAA;AACvB,CAAC,EAVW,aAAa,6BAAb,aAAa,QAUxB;AACD,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,kDAA6B,CAAA;IAC7B,kDAA6B,CAAA;IAC7B,sCAAiB,CAAA;IACjB,oCAAe,CAAA;IACf,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;AACvB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B;AAgBD,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,sCAAa,CAAA;IACb,4CAAmB,CAAA;IACnB,8CAAqB,CAAA;AACvB,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAMD,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,wCAAiB,CAAA;IACjB,wEAAwE;IACxE,oCAAa,CAAA;AACf,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B;AAED,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,gDAA0B,CAAA;IAC1B,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,gGAAgG;IAChG,uDAAiC,CAAA;AACnC,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B;AA0QD,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;IACvB,yCAAmB,CAAA;AACrB,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B"}
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../src/account/account.ts"],"names":[],"mappings":";;;AAMA,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,mEAAY,CAAA;IACZ,+DAAU,CAAA;IACV,+DAAU,CAAA;IACV,iEAAW,CAAA;IACX,6DAAS,CAAA;IACT,6DAAS,CAAA;AACX,CAAC,EAVW,kBAAkB,kCAAlB,kBAAkB,QAU7B;AACD,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sCAAqB,CAAA;AACvB,CAAC,EAVW,aAAa,6BAAb,aAAa,QAUxB;AACD,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,kDAA6B,CAAA;IAC7B,kDAA6B,CAAA;IAC7B,sCAAiB,CAAA;IACjB,oCAAe,CAAA;IACf,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;AACvB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B;AAgBD,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,sCAAa,CAAA;IACb,4CAAmB,CAAA;IACnB,8CAAqB,CAAA;AACvB,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAMD,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,wCAAiB,CAAA;IACjB,wEAAwE;IACxE,oCAAa,CAAA;AACf,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B;AAED,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,gDAA0B,CAAA;IAC1B,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,gGAAgG;IAChG,uDAAiC,CAAA;AACnC,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B;AA2QD,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;IACvB,yCAAmB,CAAA;AACrB,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B"}

package/dist/crm/diningCommit.d.ts

@@ -0,0 +1,85 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import mongoose from "mongoose";
+export interface IDiningCommitItem {
+    index?: number;
+    price?: number;
+    priceBeforeDiscount?: number;
+    posDiscount?: number;
+    qty?: number;
+    offerId?: string;
+    offerName?: string;
+    menuId?: string;
+    sectionId?: string;
+    sectionName?: string;
+    addedAt?: Date | string;
+    [key: string]: unknown;
+}
+export interface IDiningCommitModel {
+    _id?: string | mongoose.Types.ObjectId;
+    endUser: string | mongoose.Types.ObjectId;
+    seller: string | mongoose.Types.ObjectId;
+    marketplace: string | mongoose.Types.ObjectId;
+    amount: number;
+    orderTotal?: number;
+    orderId: string;
+    orderOpenTime?: Date;
+    orderEndTime?: Date;
+    /**
+     * When the meal was eaten — `orderOpenTime` if the POS sent one, otherwise the time we recorded
+     * it. This, not `createdAt`, is what the reports filter and sort on: a seller asking for August
+     * means meals eaten in August, and a POS that reports late would otherwise file a meal under the
+     * day we happened to save it rather than the day it appears on their screen.
+     */
+    visitDate?: Date;
+    items?: IDiningCommitItem[];
+    siteName?: string;
+    /**
+     * The customer's name and phone as they stood in OUR record when the meal was reported.
+     * A snapshot on purpose: a commit is a receipt, so reports about August must keep saying what
+     * they said in August even if the customer later changes their details.
+     */
+    endUserName?: string;
+    endUserPhone?: string;
+    /** The POS's own view of the customer, stored verbatim for reconciliation. Never used as identity. */
+    customer?: Record<string, unknown>;
+    settled: boolean;
+    chargeId?: string | mongoose.Types.ObjectId | null;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface IDiningBalanceResponse {
+    balance: number;
+    monthlyAmount: number;
+    fname?: string;
+    lname?: string;
+    phone?: string;
+}
+export interface IDiningCommitCreateResult {
+    success: true;
+    duplicate?: boolean;
+    balance: number;
+}

package/dist/crm/diningCommit.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=diningCommit.js.map

package/dist/crm/diningCommit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diningCommit.js","sourceRoot":"","sources":["../../src/crm/diningCommit.ts"],"names":[],"mappings":""}

package/dist/crm/diningMember.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import mongoose from "mongoose";
+export interface IDiningMemberModel {
+    _id?: string | mongoose.Types.ObjectId;
+    endUser: string | mongoose.Types.ObjectId;
+    seller: string | mongoose.Types.ObjectId;
+    marketplace: string | mongoose.Types.ObjectId;
+    monthlyAmount: number;
+    isActive: boolean;
+    createdAt?: Date;
+    updatedAt?: Date;
+}

package/dist/crm/diningMember.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=diningMember.js.map

package/dist/crm/diningMember.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diningMember.js","sourceRoot":"","sources":["../../src/crm/diningMember.ts"],"names":[],"mappings":""}

package/dist/crm/index.d.ts

@@ -6,3 +6,5 @@ export * from "./calendarEvent";
 export * from "./generalComment";
 export * from "./endUserComment";
 export * from "./visit";
+export * from "./diningCommit";
+export * from "./diningMember";

package/dist/crm/index.js

@@ -22,4 +22,6 @@ __exportStar(require("./calendarEvent"), exports);
 __exportStar(require("./generalComment"), exports);
 __exportStar(require("./endUserComment"), exports);
 __exportStar(require("./visit"), exports);
+__exportStar(require("./diningCommit"), exports);
+__exportStar(require("./diningMember"), exports);
 //# sourceMappingURL=index.js.map

package/dist/crm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/crm/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,uDAAqC;AACrC,wDAAsC;AACtC,+CAA6B;AAC7B,kDAAgC;AAChC,mDAAiC;AACjC,mDAAiC;AACjC,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/crm/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,uDAAqC;AACrC,wDAAsC;AACtC,+CAA6B;AAC7B,kDAAgC;AAChC,mDAAiC;AACjC,mDAAiC;AACjC,0CAAwB;AACxB,iDAA+B;AAC/B,iDAA+B"}

package/dist/event/event.d.ts

@@ -23,7 +23,7 @@
 /// <reference types="mongoose/types/schematypes" />
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
-import { IAccountModel, IRoleTypeEnum } from "../account";
+import { IAccountModel, IMarketPlace, IRoleTypeEnum } from "../account";
 import { IFeeCollectionType } from "../payment";
 import { IPaymentCouponTypeEnum } from "../payment/coupon";
 import mongoose from "mongoose";
@@ -144,6 +144,7 @@ export interface IEventModel {
     feeCollectionType: IFeeCollectionType;
     nimiFeeType: IFeeCollectionType;
     isPublic: boolean;
+    isMarketplaceOwnerDisable?: boolean;
     chartName?: string;
     seasonTicketEventDiscounts?: ISeasonTicketEventDiscount[];
     segmentsBehavior?: IEventSegmentsBehavior;
@@ -164,3 +165,12 @@ export interface IEventModel {
     incomeTypeId?: number;
     incomeTypeName?: string;
 }
+/**
+ * Cross-marketplace listings populate the marketplace so the client can build an
+ * absolute event link. Only these fields are selected; every other endpoint
+ * keeps sending the bare id string on `IEventModel.marketplace`.
+ */
+export type IPopulatedEventMarketplace = Pick<IMarketPlace, "_id" | "name" | "baseAppURL">;
+export type IFeaturedPublicEvent = Omit<IEventModel, "marketplace"> & {
+    marketplace?: IPopulatedEventMarketplace;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nimee/shared-types",
-  "version": "1.0.326",
+  "version": "1.0.329",
   "description": "Types and interfaces that any service can access if needed",
   "main": "dist/index.js",
   "author": "dan goldberg",

package/src/account/account.ts

@@ -224,6 +224,7 @@ export interface IAccountModel {
   subscriptionWalletDesign?: IWalletDesign;
   marketplaceDistributionId: string;
   isAllowSeasonTicket: boolean;
+  diningDefaultMonthlyAmount?: number;
   lockEndUserProfile?: boolean;
   hideCustomerChargesTab?: boolean;
   seasonTicketGrantsEntrance: boolean;

package/src/crm/diningCommit.ts

@@ -0,0 +1,64 @@
+import mongoose from "mongoose";
+
+export interface IDiningCommitItem {
+  index?: number;
+  price?: number;
+  priceBeforeDiscount?: number;
+  posDiscount?: number;
+  qty?: number;
+  offerId?: string;
+  offerName?: string;
+  menuId?: string;
+  sectionId?: string;
+  sectionName?: string;
+  addedAt?: Date | string;
+  [key: string]: unknown;
+}
+
+export interface IDiningCommitModel {
+  _id?: string | mongoose.Types.ObjectId;
+  endUser: string | mongoose.Types.ObjectId;
+  seller: string | mongoose.Types.ObjectId;
+  marketplace: string | mongoose.Types.ObjectId;
+  amount: number;
+  orderTotal?: number;
+  orderId: string;
+  orderOpenTime?: Date;
+  orderEndTime?: Date;
+  /**
+   * When the meal was eaten — `orderOpenTime` if the POS sent one, otherwise the time we recorded
+   * it. This, not `createdAt`, is what the reports filter and sort on: a seller asking for August
+   * means meals eaten in August, and a POS that reports late would otherwise file a meal under the
+   * day we happened to save it rather than the day it appears on their screen.
+   */
+  visitDate?: Date;
+  items?: IDiningCommitItem[];
+  siteName?: string;
+  /**
+   * The customer's name and phone as they stood in OUR record when the meal was reported.
+   * A snapshot on purpose: a commit is a receipt, so reports about August must keep saying what
+   * they said in August even if the customer later changes their details.
+   */
+  endUserName?: string;
+  endUserPhone?: string;
+  /** The POS's own view of the customer, stored verbatim for reconciliation. Never used as identity. */
+  customer?: Record<string, unknown>;
+  settled: boolean;
+  chargeId?: string | mongoose.Types.ObjectId | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface IDiningBalanceResponse {
+  balance: number;
+  monthlyAmount: number;
+  fname?: string;
+  lname?: string;
+  phone?: string;
+}
+
+export interface IDiningCommitCreateResult {
+  success: true;
+  duplicate?: boolean;
+  balance: number;
+}

package/src/crm/diningMember.ts

@@ -0,0 +1,12 @@
+import mongoose from "mongoose";
+
+export interface IDiningMemberModel {
+  _id?: string | mongoose.Types.ObjectId;
+  endUser: string | mongoose.Types.ObjectId;
+  seller: string | mongoose.Types.ObjectId;
+  marketplace: string | mongoose.Types.ObjectId;
+  monthlyAmount: number;
+  isActive: boolean;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/crm/index.ts

@@ -6,3 +6,5 @@ export * from "./calendarEvent";
 export * from "./generalComment";
 export * from "./endUserComment";
 export * from "./visit";
+export * from "./diningCommit";
+export * from "./diningMember";

package/src/event/event.ts

@@ -1,4 +1,4 @@
-import { IAccountModel, IRoleTypeEnum } from "../account";
+import { IAccountModel, IMarketPlace, IRoleTypeEnum } from "../account";
 import { IFeeCollectionType } from "../payment";
 import { IPaymentCouponTypeEnum } from "../payment/coupon";
 import mongoose from "mongoose";
@@ -127,6 +127,7 @@ export interface IEventModel {
   feeCollectionType: IFeeCollectionType;
   nimiFeeType: IFeeCollectionType;
   isPublic: boolean;
+  isMarketplaceOwnerDisable?: boolean; // marketplace owner hides the event from cross-marketplace listings
   chartName?: string;
   seasonTicketEventDiscounts?: ISeasonTicketEventDiscount[];
   segmentsBehavior?: IEventSegmentsBehavior;
@@ -147,3 +148,14 @@ export interface IEventModel {
   incomeTypeId?: number;
   incomeTypeName?: string;
 }
+
+/**
+ * Cross-marketplace listings populate the marketplace so the client can build an
+ * absolute event link. Only these fields are selected; every other endpoint
+ * keeps sending the bare id string on `IEventModel.marketplace`.
+ */
+export type IPopulatedEventMarketplace = Pick<IMarketPlace, "_id" | "name" | "baseAppURL">;
+
+export type IFeaturedPublicEvent = Omit<IEventModel, "marketplace"> & {
+  marketplace?: IPopulatedEventMarketplace;
+};