@qrush/types 1.0.0

package/README.md

@@ -0,0 +1,15 @@
+# qrush-shared-types
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```
+
+This project was created using `bun init` in bun v1.1.1. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

package/dist/Common.d.ts

@@ -0,0 +1,34 @@
+import type { GeoPoint } from '@firebase/firestore';
+export type PaymentMethod = "Card" | "Cash";
+export type Features = {
+    isAccessible: boolean;
+    hasReservation: boolean;
+    isRentable: boolean;
+    hasPublicTransport: boolean;
+    isLGBTQFriendly: boolean;
+    hasFood: boolean;
+    hasWifi: boolean;
+    hasParking: boolean;
+    hasCoatCheck: boolean;
+    hasVIP: boolean;
+    hasOutdoorArea: boolean;
+    hasSmokingIndoors: boolean;
+    hasIndoorArea: boolean;
+    paymentMethods: PaymentMethod[];
+};
+export type Address = {
+    street: string;
+    number: string;
+    zip: string;
+    city: string;
+    district?: string;
+    state?: string;
+    country?: string;
+};
+export type Location = {
+    address: Address;
+    geopoint: GeoPoint;
+};
+export type EventCategory = 'Clubnight' | 'Concert' | 'Party' | 'Festival' | 'Open-Air' | 'Rave' | 'Live-Musik' | 'Comedy' | 'Karaoke' | 'Quiz-Night' | 'Open-Mic' | 'Pub-Crawl' | 'LGBTQ+' | 'Drag-Show' | 'Speed-Dating' | 'Burlesque-Show';
+export type EventCategorySlug = 'clubnight' | 'concert' | 'party' | 'festival' | 'open-air' | 'rave' | 'live-musik' | 'comedy' | 'karaoke' | 'quiz-night' | 'open-mic' | 'pub-crawl' | 'lgbtq' | 'drag-show' | 'speed-dating' | 'burlesque-show';
+export declare const eventCategories: EventCategory[];

package/dist/Common.js

@@ -0,0 +1,22 @@
+// Array of all possible event categories for UI rendering
+export const eventCategories = [
+    'Clubnight',
+    'Concert',
+    'Party',
+    'Festival',
+    'Open-Air',
+    'Rave',
+    'Live-Musik',
+    'Comedy',
+    'Karaoke',
+    'Quiz-Night',
+    'Open-Mic',
+    'Pub-Crawl',
+    'LGBTQ+',
+    'Drag-Show',
+    'Speed-Dating',
+    'Burlesque-Show'
+];
+// Add any other types that are commonly shared across your data definitions.
+// For example, if IFireMetaPossibleTags or FireQueryDocSnapshotRef are used broadly,
+// they could also be considered for this file, though they might be general utilities.

package/dist/CustomDocType.d.ts

@@ -0,0 +1,4 @@
+import { DocumentData, QueryDocumentSnapshot } from "@firebase/firestore";
+export type FireQueryDocSnapshotRef<T> = QueryDocumentSnapshot<FireDocData<T>>;
+type FireDocData<T> = DocumentData & T;
+export {};

package/dist/CustomDocType.js

@@ -0,0 +1 @@
+export {};

package/dist/Events.d.ts

@@ -0,0 +1,80 @@
+import type { Timestamp, FieldValue } from '@firebase/firestore';
+import { FireQueryDocSnapshotRef } from "./CustomDocType.js";
+import { IFireMetaPossibleTags } from "./Meta.js";
+import musicGenres from './Genres.js';
+import { LocationTypeArray, LocationTypeSlugArray } from './Location.js';
+import { Features, Location, EventCategory, EventCategorySlug } from './Common.js';
+import { PromoTeaser } from "./Promotion.js";
+export interface IFireEvent {
+    name: string;
+    nameSlug: string;
+    description?: string;
+    descriptionMarkdown?: string | undefined;
+    imageURI: string;
+    mapsImageURI?: string | undefined;
+    eventGallery: string[];
+    eventStart: Timestamp;
+    eventEnd: Timestamp;
+    location: EventLocation;
+    hostUID: string;
+    hostName: string;
+    upcomingMatchingRoundUID: string | null;
+    bookmarkUserIds?: string[] | undefined;
+    guestCount: number;
+    demoEvent: boolean;
+    draftMode: boolean;
+    topPickEvent?: boolean | undefined;
+    promotedBy?: 'LFF' | 'DFF' | undefined;
+    isPersonalEvent?: boolean | undefined;
+    tags: string[] | IFireMetaPossibleTags["tags"];
+    properties: EventProperties;
+    locationUID?: string | undefined;
+    customRadiusM?: number | undefined;
+    locationTypeSlug: LocationTypeSlugArray;
+    locationTitleSlug: string;
+    categorySlug: EventCategorySlug[];
+    citySlug: string;
+    genres: {
+        mainGenre: keyof typeof musicGenres;
+        subGenres: string[];
+    }[];
+    createdAt?: Timestamp;
+    modifiedAt?: Timestamp | null;
+    promotions?: PromoTeaser[];
+}
+export type ExtendedEvent = IFireEvent & {
+    eventUID?: string;
+};
+export declare const eventTagsIsNotString: (tags: string[] | IFireMetaPossibleTags["tags"]) => tags is IFireMetaPossibleTags["tags"];
+export interface TicketType {
+    id: string;
+    name: string;
+    price: number;
+}
+export type EventProperties = {
+    category: EventCategory[];
+    price?: number | undefined;
+    tickets?: TicketType[];
+    ticketURL?: string | undefined;
+    ticketsSoldOut?: boolean | undefined;
+};
+export type EventLocation = Location & {
+    title: string;
+    description: string;
+    imageUrl: string;
+    locationType: LocationTypeArray;
+    features: Features;
+};
+export interface IFireEventUpdateGuestCount {
+    guestCount: FieldValue;
+}
+export type FireEventSnapshotRef = FireQueryDocSnapshotRef<IFireEvent>;
+export interface IFireGuest {
+    currentlyJoined: boolean;
+    notificationKeys: string[];
+    logs: {
+        joined?: Timestamp;
+        left?: Timestamp;
+    }[];
+}
+export type FireGuestSnapshotRef = FireQueryDocSnapshotRef<IFireGuest>;

package/dist/Events.js

@@ -0,0 +1 @@
+export const eventTagsIsNotString = (tags) => typeof tags[0] !== "string";

package/dist/Genres.d.ts

@@ -0,0 +1,2 @@
+declare const musicGenres: {};
+export default musicGenres;

package/dist/Genres.js

@@ -0,0 +1,3 @@
+// Placeholder for Genres.ts
+const musicGenres = {};
+export default musicGenres;

package/dist/Location.d.ts

@@ -0,0 +1,89 @@
+import { FireQueryDocSnapshotRef } from "./CustomDocType.js";
+import { Location as BaseLocation, Features } from "./Common.js";
+import { PromoTeaser } from "./Promotion.js";
+export declare const LOCATION_TYPE_MAPPING: {
+    readonly Bar: "bars";
+    readonly Outdoor: "outdoor";
+    readonly Club: "clubs";
+    readonly Festival: "festivals";
+    readonly Concert: "concerts";
+    readonly "City Festival": "cityfestivals";
+};
+export type LocationTypeKey = keyof typeof LOCATION_TYPE_MAPPING;
+export type LocationTypeSlug = (typeof LOCATION_TYPE_MAPPING)[LocationTypeKey];
+export type LocationType = LocationTypeKey[];
+export type LocationTypeSlugArray = LocationTypeSlug[];
+export type LocationTypeArray = LocationTypeKey[];
+/**
+ * @deprecated Old type, replaced by LocationType. Handle migration for 'Open Air' to 'Outdoor' and for 'Other'.
+ */
+export type VenueType = 'Bar' | 'Club' | 'Open Air' | 'Festivals' | 'Other';
+export type SocialMediaPlatform = 'Facebook' | 'Instagram' | 'Twitter' | 'LinkedIn' | 'TikTok';
+export type TimeFormat = `${number}:${number}`;
+export interface IFireEventLegacy {
+    id?: string;
+    mapsImageURI?: string;
+    bookmarkUserIds?: string[];
+    topPickEvent?: boolean;
+    promotedBy?: 'LFF' | 'DFF';
+    customRadiusM?: number;
+}
+export type IFireLocation = {
+    id?: string;
+    title: string;
+    titleSlug: string;
+    isPremium: boolean;
+    description: string;
+    imageUrl: string;
+    galleryImageUrls: string[];
+    venueType?: VenueType;
+    locationType: LocationType;
+    locationTypeSlug: LocationTypeSlugArray;
+    citySlug: string;
+    highlights?: string;
+    communityNote?: {
+        title: string;
+        content: string;
+    };
+    features: Features;
+    openingHours: {
+        monday?: {
+            open: TimeFormat;
+            close: TimeFormat;
+        };
+        tuesday?: {
+            open: TimeFormat;
+            close: TimeFormat;
+        };
+        wednesday?: {
+            open: TimeFormat;
+            close: TimeFormat;
+        };
+        thursday?: {
+            open: TimeFormat;
+            close: TimeFormat;
+        };
+        friday?: {
+            open: TimeFormat;
+            close: TimeFormat;
+        };
+        saturday?: {
+            open: TimeFormat;
+            close: TimeFormat;
+        };
+        sunday?: {
+            open: TimeFormat;
+            close: TimeFormat;
+        };
+    };
+    location: BaseLocation & {
+        surrounding: string;
+    };
+    contact?: {
+        phoneNumber?: string;
+        website?: string;
+        socialMedia?: Partial<Record<SocialMediaPlatform, string>>;
+    };
+    promotions?: PromoTeaser[];
+};
+export type FireLocationSnapshotRef = FireQueryDocSnapshotRef<IFireLocation>;

package/dist/Location.js

@@ -0,0 +1,8 @@
+export const LOCATION_TYPE_MAPPING = {
+    Bar: 'bars',
+    Outdoor: 'outdoor',
+    Club: 'clubs',
+    Festival: 'festivals',
+    Concert: 'concerts',
+    "City Festival": 'cityfestivals'
+};

package/dist/Meta.d.ts

@@ -0,0 +1,3 @@
+export interface IFireMetaPossibleTags {
+    tags: any;
+}

package/dist/Meta.js

@@ -0,0 +1 @@
+export {};

package/dist/Promotion.d.ts

@@ -0,0 +1,54 @@
+import { Timestamp } from '@firebase/firestore';
+export type PromotionItemType = 'shot' | 'drink' | 'entry' | 'merch' | 'vip' | 'skipline';
+export type PromotionDealType = '2for1' | 'free' | 'discount';
+export type PromotionType = 'event' | 'location';
+export type PromotionStatus = 'active' | 'inactive' | 'archived';
+export interface PromotionTemplate {
+    title: string;
+    description: string;
+    saving: number;
+    tags: string[];
+    itemType: PromotionItemType;
+    dealType?: PromotionDealType;
+    minUser?: number;
+    status: PromotionStatus;
+    createdAt: Timestamp;
+    editedAt: Timestamp;
+    ownerId: string;
+    assignedTo?: string[];
+}
+export interface PromotionInstance {
+    promoId: string;
+    promotionType: PromotionType;
+    parentId: string;
+    minUser?: number;
+    maxUsers?: number;
+    redeemedCount: number;
+    lastReset?: Timestamp;
+    status: PromotionStatus;
+    title: string;
+    saving: number;
+    itemType: PromotionItemType;
+    dealType?: PromotionDealType;
+}
+export interface PromotionRedemption {
+    userId: string;
+    redeemedAt: Timestamp;
+    promoId: string;
+    instanceId: string;
+    parentId: string;
+    promotionType: PromotionType;
+    title: string;
+    saving: number;
+    itemType: PromotionItemType;
+    dealType?: PromotionDealType;
+}
+export interface PromoTeaser {
+    instanceId: string;
+    promoId: string;
+    promotionType: PromotionType;
+    title: string;
+    saving: number;
+    itemType: PromotionItemType;
+    dealType?: PromotionDealType;
+}

package/dist/Promotion.js

@@ -0,0 +1,3 @@
+// Promotion.ts
+// Types for the new promotion logic (Firebase structure)
+export {};

package/dist/Users.d.ts

@@ -0,0 +1,89 @@
+import type { DocumentReference, FieldValue, Timestamp } from '@firebase/firestore';
+import { FireQueryDocSnapshotRef } from './CustomDocType.js';
+export type Maybe<T> = T | null | undefined;
+export type IFireUser = {
+    phone?: Phone;
+    appleAuth?: AppleAuth;
+    googleAuth?: GoogleAuth;
+    role: UserRole;
+    name: string;
+    gender: Gender;
+    interestedIn: Maybe<Gender>;
+    avatar: UserAvatar | null;
+    birthday: Timestamp;
+    attendedEvents: DocumentReference[];
+    attendingEvent: string | null;
+    sharingToken: SharingToken | null;
+    notificationTokens: string[];
+    markedForDeletion: boolean;
+    blockedUsers: string[];
+    demoEventUIDs: string[];
+    deleted: boolean;
+    createdAt: Date;
+    referralRewards?: string[];
+    profileImageUrl?: string;
+    totalSavings: number;
+    redemptionIds?: string[];
+};
+export type UserRole = 'user' | 'staff' | 'team' | 'admin';
+export type UserAvatar = {
+    url: string;
+    uploadedAt: Timestamp;
+};
+export type Phone = {
+    countryCode: string;
+    number: string;
+};
+export type AppleAuth = {
+    user: string;
+    name: {
+        namePrefix: string | null;
+        givenName: string | null;
+        middleName: string | null;
+        familyName: string | null;
+        nameSuffix: string | null;
+        nickname: string | null;
+    } | null;
+    email: string | null;
+};
+export type GoogleAuth = {
+    id: string;
+    name: string | null;
+    email: string | null;
+    photo: string | null;
+};
+export type SharingToken = {
+    token: string;
+    expires: Timestamp | null;
+};
+export type Gender = 'male' | 'female' | 'diverse';
+export type FireUserSnapshotRef = FireQueryDocSnapshotRef<IFireUser>;
+export type IFireUserCreationData = Omit<Omit<Omit<IFireUser, 'birthday'>, 'sharingToken'>, 'createdAt'> & {
+    birthday: Date;
+    createdAt: FieldValue;
+};
+export type IFireUserModifySharingToken = {
+    sharingToken: {
+        token: string;
+        expires: Date | null;
+    };
+};
+export type IFireUserSetImage = {
+    avatar: {
+        url: string;
+        uploadedAt: FieldValue | Date;
+    };
+};
+export type IFireUserLeaveEvent = {
+    attendingEvent: null;
+};
+export type IFireUserSetDeleted = {
+    markedForDeletion: true;
+};
+export type IFireUserAddBlockedUser = {
+    blockedUsers: FieldValue;
+};
+export type IFireUserUpdateNotificationToken = {
+    notificationTokens: FieldValue;
+};
+export type IFireUserUpdateDatingPreference = Pick<IFireUser, 'interestedIn'>;

package/dist/Users.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './Promotion.js';
+export * from './Events.js';
+export * from './Users.js';
+export * from './Location.js';
+export * from './Common.js';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from './Promotion.js';
+export * from './Events.js';
+export * from './Users.js';
+export * from './Location.js';
+export * from './Common.js';

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@qrush/types",
+  "version": "1.0.0",
+  "description": "Shared TypeScript types for the QRush ecosystem",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "bun run build"
+  },
+  "devDependencies": {
+    "@firebase/firestore": "^4.6.3",
+    "typescript": "^5.4.5"
+  },
+  "peerDependencies": {
+    "@firebase/firestore": ">=4.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./Promotion": {
+      "import": "./dist/Promotion.js",
+      "types": "./dist/Promotion.d.ts"
+    },
+    "./Events": {
+      "import": "./dist/Events.js",
+      "types": "./dist/Events.d.ts"
+    },
+    "./Users": {
+      "import": "./dist/Users.js",
+      "types": "./dist/Users.d.ts"
+    },
+    "./Location": {
+      "import": "./dist/Location.js",
+      "types": "./dist/Location.d.ts"
+    },
+    "./Common": {
+      "import": "./dist/Common.js",
+      "types": "./dist/Common.d.ts"
+    },
+    "./CustomDocType": {
+      "import": "./dist/CustomDocType.js",
+      "types": "./dist/CustomDocType.d.ts"
+    },
+    "./Genres": {
+      "import": "./dist/Genres.js",
+      "types": "./dist/Genres.d.ts"
+    },
+    "./Meta": {
+      "import": "./dist/Meta.js",
+      "types": "./dist/Meta.d.ts"
+    }
+  }
+}