@qrush/types 1.0.0 → 1.1.0

package/README.md

@@ -1,15 +1,128 @@
-# qrush-shared-types
+# @qrush/types
 
-To install dependencies:
+Shared TypeScript types for the QRush ecosystem. This package provides type definitions for common data structures used across QRush applications.
+
+## Installation
+
+```bash
+npm install @qrush/types
+```
+
+## Usage
+
+### Full Import
+
+```typescript
+import { User, Event, Promotion, Location } from '@qrush/types';
+```
+
+### Selective Imports
+
+```typescript
+// Import specific modules
+import { User, UserRole } from '@qrush/types/Users';
+import { Event, EventStatus } from '@qrush/types/Events';
+import { Promotion, PromotionType } from '@qrush/types/Promotion';
+import { Location, LocationType } from '@qrush/types/Location';
+import { Genre } from '@qrush/types/Genres';
+import { Meta } from '@qrush/types/Meta';
+import { CommonFields } from '@qrush/types/Common';
+import { CustomDocType } from '@qrush/types/CustomDocType';
+import { Timestamp, GeoPoint, formatTimestamp } from '@qrush/types/firebase';
+import { IFireWebappUser, FireWebappUserSnapshotRef } from '@qrush/types/WebappUsers';
+```
+
+## Available Types
+
+- **Users** - User profiles, roles, and authentication types
+- **Events** - Event data structures and status types
+- **Promotions** - Promotion and marketing campaign types
+- **Location** - Geographic and venue-related types
+- **Genres** - Music and entertainment genre definitions
+- **Meta** - Metadata and configuration types
+- **Common** - Shared utility types and interfaces
+- **CustomDocType** - Custom document type definitions
+- **firebase** - Firebase/Firestore type re-exports and utilities
+- **WebappUsers** - Web application specific user types and interfaces
+
+## Development
+
+### Prerequisites
+
+- [Bun](https://bun.sh) v1.1.1 or later
+- Node.js 18+ (for npm publishing)
+
+### Setup
 
 ```bash
+# Install dependencies
 bun install
+
+# Build the project
+bun run build
+
+# Build and watch for changes
+bun run build --watch
+```
+
+### Project Structure
+
+```
+src/
+├── index.ts          # Main entry point
+├── Common.ts         # Shared utility types
+├── Users.ts          # User-related types
+├── Events.ts         # Event-related types
+├── Promotion.ts      # Promotion types
+├── Location.ts       # Location types
+├── Genres.ts         # Genre definitions
+├── Meta.ts           # Metadata types
+├── CustomDocType.ts  # Custom document types
+├── firebase.ts       # Firebase/Firestore type utilities
+└── WebappUsers.ts    # Web application user types
 ```
 
-To run:
+## Publishing
+
+This package uses automated publishing via GitHub Actions:
+
+### Automatic Publishing (Recommended)
+
+1. Update the version in `package.json`
+2. Commit your changes
+3. Create and push a version tag:
 
 ```bash
-bun run index.ts
+git add .
+git commit -m "Release v1.0.1"
+git tag v1.0.1
+git push origin v1.0.1
 ```
 
-This project was created using `bun init` in bun v1.1.1. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+### Manual Publishing
+
+1. Go to the GitHub repository
+2. Navigate to **Actions** tab
+3. Select **"Manual Publish to NPM"** workflow
+4. Click **"Run workflow"**
+5. Choose version bump type (patch/minor/major)
+6. Click **"Run workflow"**
+
+## Dependencies
+
+### Peer Dependencies
+
+- `@firebase/firestore` >=4.0.0
+
+### Dev Dependencies
+
+- `typescript` ^5.4.5
+- `@firebase/firestore` ^4.6.3
+
+## License
+
+This project is part of the QRush ecosystem.
+
+---
+
+Built with [Bun](https://bun.sh) 🚀

package/dist/WebappUsers.d.ts

@@ -0,0 +1,14 @@
+import { FireQueryDocSnapshotRef } from "./CustomDocType.js";
+import { UserRole } from "./Users.js";
+import { Timestamp } from "@firebase/firestore";
+export type IFireWebappUser = {
+    email: string;
+    name: string;
+    createdAt: Timestamp;
+    locationIds: string[];
+    role?: UserRole;
+    isApproved?: boolean;
+    ownedPromotionIds?: string[];
+    preferredLanguage?: string;
+};
+export type FireWebappUserSnapshotRef = FireQueryDocSnapshotRef<IFireWebappUser>;

package/dist/WebappUsers.js

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

package/dist/firebase.d.ts

@@ -0,0 +1,5 @@
+import type { Timestamp, GeoPoint, QueryDocumentSnapshot, DocumentData, FieldValue } from '@firebase/firestore';
+export type { Timestamp, GeoPoint, QueryDocumentSnapshot, DocumentData, FieldValue };
+export type FirebaseTimestamp = Timestamp;
+export type FirebaseGeoPoint = GeoPoint;
+export declare function formatTimestamp(timestamp: Timestamp | undefined): string;

package/dist/firebase.js

@@ -0,0 +1,12 @@
+// Utility function to format Firebase Timestamp for display
+export function formatTimestamp(timestamp) {
+    if (!timestamp)
+        return "Unknown";
+    const date = timestamp.toDate();
+    // Simple date formatting without external dependencies
+    const months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
+    const month = months[date.getMonth()];
+    const day = date.getDate();
+    const year = date.getFullYear();
+    return `${month} ${day.toString().padStart(2, '0')}, ${year}`;
+}

package/dist/index.d.ts

@@ -3,3 +3,8 @@ export * from './Events.js';
 export * from './Users.js';
 export * from './Location.js';
 export * from './Common.js';
+export * from './CustomDocType.js';
+export * from './Genres.js';
+export * from './Meta.js';
+export * from './firebase.js';
+export * from './WebappUsers.js';

package/dist/index.js

@@ -3,3 +3,8 @@ export * from './Events.js';
 export * from './Users.js';
 export * from './Location.js';
 export * from './Common.js';
+export * from './CustomDocType.js';
+export * from './Genres.js';
+export * from './Meta.js';
+export * from './firebase.js';
+export * from './WebappUsers.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrush/types",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Shared TypeScript types for the QRush ecosystem",
   "type": "module",
   "scripts": {
@@ -56,6 +56,14 @@
     "./Meta": {
       "import": "./dist/Meta.js",
       "types": "./dist/Meta.d.ts"
+    },
+    "./firebase": {
+      "import": "./dist/firebase.js",
+      "types": "./dist/firebase.d.ts"
+    },
+    "./WebappUsers": {
+      "import": "./dist/WebappUsers.js",
+      "types": "./dist/WebappUsers.d.ts"
     }
   }
 }