@timardex/cluemart-shared 1.6.130 → 1.7.0

package/dist/global-BUUfmCo7.d.mts

@@ -0,0 +1,698 @@
+import { FieldValues, Control, FormState, UseFormHandleSubmit, UseFormReset, UseFormSetValue, UseFormWatch, UseFormGetValues } from 'react-hook-form';
+import { EnumResourceType, EnumInviteStatus, EnumRelationResource, EnumEventType, EnumPaymentMethod, EnumVendorType, EnumFoodFlavor, EnumEventDateStatus, EnumUserLicence, EnumSocialMedia } from './enums/index.mjs';
+
+type RelationDate = {
+    dateTime: DateTimeType & {
+        stallType: StallType | null;
+    };
+    lastUpdateBy: {
+        resourceId: string;
+        userEmail: string;
+    };
+    paymentReference?: string;
+    status: EnumInviteStatus;
+};
+interface RelationType {
+    _id?: string;
+    active: boolean;
+    chatId: string;
+    createdAt?: Date;
+    deletedAt?: Date | null;
+    eventId: string;
+    lastUpdateBy: EnumResourceType;
+    relationDates: RelationDate[];
+    relationType: EnumRelationResource;
+    updatedAt?: Date;
+    vendorId: string;
+}
+/** GraphQL RelationInputType — chatId is optional; server assigns it on create. */
+type RelationInputType = Omit<RelationType, "_id" | "chatId" | "createdAt" | "updatedAt" | "deletedAt"> & {
+    chatId?: string;
+};
+
+type StallType = {
+    label: string;
+    price: number;
+    stallCapacity: number;
+};
+interface DateTimeWithPriceType extends DateTimeType {
+    stallTypes: StallType[];
+}
+type PaymentInfoType = {
+    accountHolderName?: string;
+    accountNumber?: string;
+    link?: string;
+    paymentMethod: EnumPaymentMethod;
+};
+type Requirement = {
+    category: "Food Safety" | "Environment" | "Operations" | "Legal & Safety";
+    label: string;
+    value: boolean;
+};
+type RefundPolicy = {
+    category: "Cancelled by Organiser" | "Cancelled by Vendor";
+    label: string;
+    value: boolean;
+};
+interface EventInfoFormData {
+    _id?: string;
+    applicationDeadlineHours: number;
+    dateTime: DateTimeWithPriceType[];
+    eventId: string;
+    packInTime: number;
+    paymentDueHours: number;
+    paymentInfo: PaymentInfoType[];
+    refundPolicy: RefundPolicy[];
+    requirements?: Requirement[];
+}
+interface EventFormData extends BaseResourceTypeFormData {
+    claimed?: boolean;
+    dateTime: DateTimeType[];
+    eventType: EnumEventType;
+    googlePlaceId?: string | null;
+    location: LocationType;
+    nzbn: string;
+    provider?: string | null;
+    rainOrShine: boolean;
+    tags: string[];
+}
+type CreateEventInfoFormData = CreateFormData<EventInfoFormData>;
+type CreateEventFormData = CreateFormData<EventFormData>;
+interface EventType extends BaseResourceType {
+    claimed: boolean;
+    dateTime: DateTimeType[];
+    eventInfoId: string;
+    eventType: EnumEventType;
+    googlePlaceId?: string | null;
+    location: LocationType;
+    nzbn: string;
+    provider: string | null;
+    rainOrShine: boolean;
+    tags: string[];
+    relations: {
+        relationId: string | null;
+        relationDates: RelationDate[] | null;
+    }[] | null;
+    sharePublic?: SocialShareResourceType | null;
+    shareRelation?: SocialShareResourceType | null;
+}
+type EventListItemType = Omit<EventType, "adIds" | "associates" | "contactDetails" | "eventInfoId" | "nzbn" | "owner" | "posterUsage" | "promoCodes" | "provider" | "relatedPost" | "socialMedia" | "socialShare" | "tags" | "termsAgreement">;
+type EventInfoType = Omit<EventInfoFormData, "_id"> & {
+    _id: string;
+    active?: boolean;
+};
+
+declare enum EnumGameType {
+    DAILY_CLUE = "dailyClue",
+    MINI_QUIZ = "miniQuiz",
+    ODD_ONE_OUT = "oddOneOut"
+}
+type GameDate = {
+    startDate: Date;
+    endDate: Date;
+};
+declare const gameTypeToDisplayName: Record<EnumGameType, string>;
+type GlobalGameData = {
+    points: number;
+    streak: number;
+};
+
+declare const gameScreenIdentifierList: readonly [{
+    readonly clue: "Where your actions turn into a timeline.";
+    readonly id: "activities";
+    readonly match: "/profile/activities";
+}, {
+    readonly clue: "Where conversations happen without speaking.";
+    readonly id: "chat";
+    readonly match: "/profile/chat";
+}, {
+    readonly clue: "The place to redefine who you are.";
+    readonly id: "edit-profile";
+    readonly match: "/profile/edit-profile";
+}, {
+    readonly clue: "A single moment worth showing up for.";
+    readonly id: "single-event";
+    readonly match: RegExp;
+}, {
+    readonly clue: "What’s happening around you, right now.";
+    readonly id: "events-near-me";
+    readonly match: "/events/events-near-me";
+}, {
+    readonly clue: "Where events appear as pins on a map.";
+    readonly id: "events-map";
+    readonly match: "/events/events-map";
+}, {
+    readonly clue: "A collection of events worth attending.";
+    readonly id: "events";
+    readonly match: "/events";
+}, {
+    readonly clue: "What’s happening in a wider area — not just nearby.";
+    readonly id: "events-region";
+    readonly match: RegExp;
+}, {
+    readonly clue: "Where fun becomes a challenge.";
+    readonly id: "games";
+    readonly match: "/games";
+}, {
+    readonly clue: "Your starting point for everything.";
+    readonly id: "home";
+    readonly match: "/";
+}, {
+    readonly clue: "Where the app whispers what you shouldn’t miss.";
+    readonly id: "notifications";
+    readonly match: "/notifications";
+}, {
+    readonly clue: "Where you fine-tune your experience.";
+    readonly id: "options";
+    readonly match: "/options";
+}, {
+    readonly clue: "An organisation or creator supporting the community.";
+    readonly id: "single-partner";
+    readonly match: RegExp;
+}, {
+    readonly clue: "Organisations and creators supporting the community.";
+    readonly id: "partners";
+    readonly match: "/partners";
+}, {
+    readonly clue: "A single published post in full view.";
+    readonly id: "single-visitor-post";
+    readonly match: RegExp;
+}, {
+    readonly clue: "Your identity, on display.";
+    readonly id: "profile";
+    readonly match: "/profile";
+}, {
+    readonly clue: "One stallholder offering something valuable.";
+    readonly id: "single-vendor";
+    readonly match: RegExp;
+}, {
+    readonly clue: "Where every stallholder waits under the right category.";
+    readonly id: "vendors";
+    readonly match: "/vendors";
+}, {
+    readonly clue: "Where you browse articles and posts from around the platform.";
+    readonly id: "visitors";
+    readonly match: "/visitors";
+}];
+type GamePlacement = (typeof gameScreenIdentifierList)[number]["id"];
+type GamePlacementClue = (typeof gameScreenIdentifierList)[number]["clue"];
+type DailyClueBaseGame = {
+    gameDate: GameDate;
+    gameSolution: string;
+};
+type DailyClueGameData = GlobalGameData & {
+    gameFields: DailyClueBaseGame;
+    lastFoundDate: Date | null;
+    letterInfo: {
+        collected: string[] | null;
+        solutionShuffled: string[];
+        todaysClue: GamePlacementClue | null;
+        todaysLetter: string | null;
+        todaysPlacement: GamePlacement | null;
+    };
+};
+
+type PuzzleAnswer = {
+    answerId: string;
+    answer: string;
+    correct: boolean;
+};
+type PuzzleQuestion = {
+    answers: PuzzleAnswer[];
+    question: string;
+    questionId: string;
+};
+/**
+ * Stores only the answerId  and the questionId of the selected answer.
+ */
+type PuzzleAnsweredQuestion = {
+    selectedAnswerId: string;
+    questionId: string;
+};
+type PuzzleBaseGame = {
+    questions: PuzzleQuestion[];
+};
+type PuzzleGameData = GlobalGameData & {
+    gameFields: PuzzleBaseGame;
+    /**
+     * Stores user answers only.
+     * Never store correctness from client.
+     */
+    answeredQuestions: PuzzleAnsweredQuestion[];
+};
+
+type BaseGameMap = {
+    [EnumGameType.DAILY_CLUE]: DailyClueBaseGame;
+    [EnumGameType.MINI_QUIZ]: PuzzleBaseGame;
+    [EnumGameType.ODD_ONE_OUT]: PuzzleBaseGame;
+};
+type BaseGameType = {
+    gameType: EnumGameType;
+    gameTypeId: string;
+    gameTitle: string;
+} & {
+    [K in keyof BaseGameMap]?: BaseGameMap[K] | null;
+};
+declare enum EnumGameStatus {
+    GAME_COMPLETED = "GAME_COMPLETED",
+    GAME_IN_PROGRESS = "GAME_IN_PROGRESS",
+    GAME_LEFT = "GAME_LEFT",
+    GAME_STARTED = "GAME_STARTED"
+}
+type GameHistory = Pick<BaseGameType, "gameTitle" | "gameType" | "gameTypeId"> & {
+    createdAt: Date;
+    gameDate: GameDate;
+    gameStatus: EnumGameStatus;
+    /** Per-event delta. Not persisted for overallGamePoints (computed at read time). */
+    pointsEarned: number;
+    /** Running total for this game instance; computed at read time, not stored in Mongo. */
+    overallGamePoints?: number;
+};
+type GameDataMap = {
+    [EnumGameType.DAILY_CLUE]: DailyClueGameData;
+    [EnumGameType.MINI_QUIZ]: PuzzleGameData;
+    [EnumGameType.ODD_ONE_OUT]: PuzzleGameData;
+};
+type GameDataType = {
+    [K in keyof GameDataMap]?: GameDataMap[K] | null;
+};
+type GameType = Pick<BaseGameType, "gameTitle" | "gameType" | "gameTypeId"> & {
+    _id: string;
+    active: boolean;
+    createdAt: Date;
+    gameData: GameDataType;
+    gameHistory: GameHistory[] | null;
+    updatedAt: Date | null;
+};
+type GameDocType = {
+    _id: string;
+    active: boolean;
+    createdAt: Date;
+    deletedAt: Date | null;
+    games: GameType[] | null;
+    owner: OwnerType;
+    points: number;
+    updatedAt: Date | null;
+};
+type GameLeaderboard = {
+    gameHistory: GameHistory[] | null;
+    overallPoints: number;
+    owner: OwnerType;
+};
+
+declare enum EnumPostType {
+    MARKET_FACES = "market_faces",
+    CLUE_BITES = "clue_bites",
+    PLAY_AND_WIN = "play_and_win"
+}
+declare enum EnumPostContentType {
+    GAME = "game",
+    IMAGE = "image",
+    LIST = "list",
+    TEXTAREA = "textarea",
+    VIDEO = "video"
+}
+type PostFileInput = {
+    source: File;
+    title?: string;
+};
+type PostContentTextarea = {
+    textarea: {
+        title?: string;
+        data: string;
+    };
+};
+type PostContentImage = {
+    images: ResourceImageType[] | null;
+    imagesUpload?: PostFileInput[] | null;
+};
+type PostContentVideo = {
+    video: {
+        source: string;
+        title?: string;
+    };
+};
+type PostContentList = {
+    list: {
+        title?: string;
+        items: {
+            text: string;
+        }[];
+    };
+};
+type PostContentGame = {
+    game: BaseGameType;
+};
+type PostContentData = PostContentGame | PostContentTextarea | PostContentImage | PostContentVideo | PostContentList;
+type PostContentFormData = {
+    contentData?: PostContentData | null;
+    contentOrder?: number | null;
+    contentType?: EnumPostContentType | null;
+};
+type PostResource = {
+    resourceSlug: string;
+    resourceId: string;
+    resourceType: EnumResourceType;
+    resourceRegion: string;
+};
+interface PostFormData {
+    active: boolean;
+    caption: string;
+    content: PostContentFormData[];
+    cover?: ResourceImageType | null;
+    coverUpload?: PostFileInput | null;
+    postType: EnumPostType;
+    resource?: PostResource | null;
+    tags?: string[] | null;
+    title: string;
+    notifyUsers?: boolean | null;
+}
+type CreatePostFormData = CreateFormData<PostFormData>;
+type PostContentType = Omit<PostContentFormData, "contentData"> & {
+    contentData: Omit<PostContentData, "imagesUpload">;
+};
+type PostType = Omit<PostFormData, "content" | "coverUpload" | "resource"> & {
+    _id: string;
+    content: PostContentType[];
+    createdAt: Date;
+    deletedAt: Date | null;
+    resource?: PostResource | null;
+    slug: string;
+    sharePublic?: SocialShareResourceType | null;
+    updatedAt: Date | null;
+};
+
+type VendorCalendarData = Omit<ResourceDetails, "dateTime" | "eventStatus"> & {
+    dateTime: DateTimeType;
+};
+type VendorProductList = {
+    description?: string | null;
+    name: string;
+    price: number;
+    priceUnit: string;
+    productGroups?: string[] | null;
+};
+interface VendorFormData extends BaseResourceTypeFormData {
+    availability?: {
+        school: boolean;
+        private: boolean;
+        corporate: boolean;
+    };
+    claimed?: boolean;
+    calendar?: {
+        active?: boolean | null;
+        calendarData?: VendorCalendarData[] | null;
+    } | null;
+    categories: Category[];
+    foodTruck: boolean;
+    products?: {
+        active?: boolean | null;
+        productsList?: VendorProductList[] | null;
+    } | null;
+    unregisteredVendorId?: string | null;
+    vendorType: EnumVendorType;
+}
+type CreateVendorFormData = CreateFormData<VendorFormData>;
+type VendorAttributes = {
+    details?: string | null;
+    isRequired: boolean;
+};
+type VendorInfoFormData = {
+    _id?: string;
+    compliance?: {
+        liabilityInsurance: boolean;
+        foodBeverageLicense: boolean;
+    };
+    documents?: ResourceImageType[] | null;
+    documentsUpload?: ResourceImageType[] | null;
+    product: {
+        foodFlavors: EnumFoodFlavor[];
+        packaging: string[];
+        priceRange: {
+            max: string;
+            min: string;
+        };
+        producedIn: string[];
+    };
+    requirements?: {
+        electricity: VendorAttributes;
+        gazebo: VendorAttributes;
+        table: VendorAttributes;
+    };
+    stallInfo: {
+        size: {
+            depth: string;
+            width: string;
+        };
+    };
+    vendorId: string;
+};
+type CreateVendorInfoFormData = CreateFormData<VendorInfoFormData>;
+interface VendorType extends BaseResourceType {
+    availability?: {
+        school: boolean;
+        private: boolean;
+        corporate: boolean;
+    };
+    claimed: boolean;
+    calendar: VendorFormData["calendar"] | null;
+    categories: VendorFormData["categories"];
+    foodTruck: boolean;
+    products: VendorFormData["products"] | null;
+    vendorInfoId: string;
+    vendorType: EnumVendorType;
+    relations: {
+        relationId: string | null;
+        relationDates: RelationDate[] | null;
+    }[] | null;
+    sharePublic?: SocialShareResourceType | null;
+    shareRelation?: SocialShareResourceType | null;
+    unregisteredVendorId?: string | null;
+}
+type VendorInfoType = Omit<VendorInfoFormData, "_id" | "documentsUpload"> & {
+    _id: string;
+    active?: boolean;
+};
+interface UnregisteredVendorFormData {
+    categoryIds: string[];
+    dateTime: DateTimeType[];
+    email?: string | null;
+    inviterId: string;
+    name: string;
+    region: string;
+}
+type CreateUnregisteredVendorFormData = CreateFormData<UnregisteredVendorFormData>;
+type UnregisteredVendorInvitationType = Pick<UnregisteredVendorFormData, "dateTime" | "inviterId">;
+type UnregisteredVendorType = Omit<UnregisteredVendorFormData, "dateTime" | "inviterId"> & {
+    _id: string;
+    active: boolean;
+    claimed: boolean;
+    claimedAt?: Date;
+    claimedByUserId?: string;
+    createdAt: Date;
+    deletedAt: Date | null;
+    invitations: UnregisteredVendorInvitationType[];
+    updatedAt: Date | null;
+};
+
+declare const PROMO_CODE_PREFIX = "CM-";
+type PromoCodeType = `${typeof PROMO_CODE_PREFIX}${string}`;
+type Nullable<T> = {
+    [K in keyof T]: T[K] | null | undefined;
+};
+type DeviceInfo = {
+    appBuildNumber: string;
+    appId: string;
+    appVersion: string;
+    brand: string;
+    deviceName: string;
+    installationId: string;
+    manufacturer: string;
+    modelName: string;
+    osName: string;
+    osVersion: string;
+    timestamp: string;
+};
+type TermsAgreement = DeviceInfo & {
+    termVersion: string;
+};
+type ResourceContactDetailsType = {
+    email?: string | null;
+    landlinePhone?: string | null;
+    mobilePhone?: string | null;
+};
+type ResourceImageType = {
+    active: boolean;
+    source: string;
+    title: string;
+};
+type SocialMediaType = {
+    name?: EnumSocialMedia;
+    link?: string;
+};
+type UserLicenceType = {
+    expiryDate: Date;
+    issuedDate: Date;
+    licenceType: EnumUserLicence;
+    prevLicenceType?: EnumUserLicence | null;
+};
+type AssociateType = {
+    email: string;
+    resourceId: string;
+    resourceType: EnumResourceType;
+    licence: UserLicenceType;
+};
+type OwnerType = {
+    email: string;
+    userId: string;
+};
+interface BaseResourceTypeFormData {
+    _id?: string;
+    active: boolean;
+    associates: AssociateType[] | null;
+    contactDetails: ResourceContactDetailsType | null;
+    cover: ResourceImageType;
+    coverUpload?: ResourceImageType | null;
+    description: string;
+    images?: ResourceImageType[] | null;
+    imagesUpload?: ResourceImageType[] | null;
+    logo?: ResourceImageType | null;
+    logoUpload?: ResourceImageType | null;
+    name: string;
+    owner?: OwnerType | null;
+    promoCodes?: PromoCodeType[] | null;
+    region: string;
+    socialMedia: SocialMediaType[] | null;
+    termsAgreement?: TermsAgreement | null;
+}
+type PosterUsageType = {
+    month: string;
+    count: number;
+};
+type RelatedPostType = {
+    postId: string;
+    postSlug: string;
+    postType: EnumPostType;
+};
+type SocialShareResourceType = {
+    qrCode: ResourceImageType;
+    socialImage: ResourceImageType;
+};
+type BaseResourceType = Omit<BaseResourceTypeFormData, "_id" | "coverUpload" | "imagesUpload" | "logoUpload"> & {
+    _id: string;
+    adIds?: string[] | null;
+    createdAt: Date;
+    deletedAt: Date | null;
+    posterUsage?: PosterUsageType | null;
+    rating?: number | null;
+    relatedPost?: RelatedPostType | null;
+    reviewCount?: number | null;
+    slug: string;
+    updatedAt: Date | null;
+};
+type LocationGeoType = {
+    coordinates: number[];
+    type: "Point";
+};
+type LocationType = {
+    city: string;
+    country: string;
+    fullAddress: string;
+    geo: LocationGeoType;
+    latitude: number;
+    longitude: number;
+    region: string;
+};
+type DateTimeType = {
+    dateStatus: EnumEventDateStatus;
+    endDate: string;
+    endTime: string;
+    startDate: string;
+    startTime: string;
+};
+type Region = {
+    latitude: number;
+    latitudeDelta: number;
+    longitude: number;
+    longitudeDelta: number;
+};
+type ResourceDetails = {
+    dateTime: DateTimeType[] | null;
+    description: string | null;
+    eventStatus?: EventStatusType | null;
+    location: LocationType | null;
+    resourceCover: ResourceImageType | null;
+    resourceId: string;
+    resourceLogo: ResourceImageType | null;
+    resourceName: string;
+    resourceType: EnumResourceType;
+};
+type GeocodeLocation = Pick<LocationType, "latitude" | "longitude">;
+type EventStatusType = {
+    claimed: boolean;
+    eventType: EnumEventType;
+    googlePlaceId?: string | null;
+};
+interface FormField {
+    disabled?: boolean;
+    helperText?: string;
+    isTextArea?: boolean;
+    keyboardType?: "default" | "email-address" | "number-pad" | "url" | "decimal-pad" | "phone-pad";
+    name: string;
+    placeholder: string;
+    required?: boolean;
+    secureTextEntry?: boolean;
+}
+interface FormDateField {
+    dateMode: "date" | "time";
+    helperText?: string;
+    name: "endDate" | "endTime" | "startDate" | "startTime";
+    placeholder: string;
+}
+interface SubcategoryItems {
+    id: string;
+    name: string;
+    description?: string | null;
+}
+interface Subcategory {
+    id: string;
+    name: string;
+    items?: SubcategoryItems[] | null;
+}
+interface Category {
+    color?: string | null;
+    description?: string | null;
+    id: string;
+    name: string;
+    subcategories: Subcategory[];
+}
+type OptionItem = {
+    value: string;
+    label: string;
+};
+type ImageObjectType = {
+    uri: string;
+    type: string;
+    name: string;
+};
+interface ResourceConnectionsType {
+    events: EventListItemType[] | null;
+    vendors: VendorType[] | null;
+}
+interface CreateFormData<T extends FieldValues> {
+    control: Control<T, any>;
+    fields: T;
+    formState: FormState<T>;
+    handleSubmit: UseFormHandleSubmit<T, any>;
+    reset: UseFormReset<T>;
+    setValue: UseFormSetValue<T>;
+    watch: UseFormWatch<T>;
+    getValues: UseFormGetValues<T>;
+}
+interface UseGetResourcesByRegionOptions {
+    onlyClaimed?: boolean;
+    limit?: number;
+    offset?: number;
+}
+
+export { type GamePlacementClue as $, type AssociateType as A, type BaseResourceTypeFormData as B, type Category as C, type BaseResourceType as D, type EventType as E, type FormField as F, type GameDocType as G, type CreateFormData as H, type DailyClueBaseGame as I, type DailyClueGameData as J, type DateTimeType as K, type LocationType as L, type DateTimeWithPriceType as M, type DeviceInfo as N, type OptionItem as O, type PostType as P, EnumGameStatus as Q, type RefundPolicy as R, type StallType as S, EnumGameType as T, type UseGetResourcesByRegionOptions as U, type VendorType as V, EnumPostContentType as W, type EventStatusType as X, type GameDate as Y, type GameHistory as Z, type GamePlacement as _, type FormDateField as a, type GameType as a0, type GeocodeLocation as a1, type GlobalGameData as a2, type ImageObjectType as a3, type LocationGeoType as a4, type Nullable as a5, type OwnerType as a6, PROMO_CODE_PREFIX as a7, type PaymentInfoType as a8, type PostContentData as a9, type TermsAgreement as aA, type UnregisteredVendorInvitationType as aB, type VendorAttributes as aC, type VendorCalendarData as aD, type VendorProductList as aE, gameScreenIdentifierList as aF, gameTypeToDisplayName as aG, type PostContentFormData as aa, type PostContentGame as ab, type PostContentImage as ac, type PostContentList as ad, type PostContentTextarea as ae, type PostContentType as af, type PostContentVideo as ag, type PostFileInput as ah, type PostResource as ai, type PosterUsageType as aj, type PromoCodeType as ak, type PuzzleAnswer as al, type PuzzleAnsweredQuestion as am, type PuzzleBaseGame as an, type PuzzleGameData as ao, type PuzzleQuestion as ap, type RelatedPostType as aq, type RelationDate as ar, type RelationInputType as as, type ResourceContactDetailsType as at, type ResourceDetails as au, type ResourceImageType as av, type SocialMediaType as aw, type SocialShareResourceType as ax, type Subcategory as ay, type SubcategoryItems as az, type Requirement as b, type EventListItemType as c, type EventInfoType as d, type RelationType as e, type ResourceConnectionsType as f, type UnregisteredVendorType as g, type VendorInfoType as h, type UserLicenceType as i, EnumPostType as j, type GameLeaderboard as k, type VendorFormData as l, type CreateVendorFormData as m, type VendorInfoFormData as n, type CreateVendorInfoFormData as o, type UnregisteredVendorFormData as p, type CreateUnregisteredVendorFormData as q, type EventFormData as r, type CreateEventFormData as s, type EventInfoFormData as t, type CreateEventInfoFormData as u, type PostFormData as v, type CreatePostFormData as w, type Region as x, type BaseGameMap as y, type BaseGameType as z };