@qrush/types 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +112 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,15 +1,122 @@
|
|
|
1
|
-
# qrush
|
|
1
|
+
# @qrush/types
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Shared TypeScript types for the QRush ecosystem. This package provides type definitions for common data structures used across QRush applications.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @qrush/types
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### Full Import
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { User, Event, Promotion, Location } from '@qrush/types';
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Selective Imports
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
// Import specific modules
|
|
23
|
+
import { User, UserRole } from '@qrush/types/Users';
|
|
24
|
+
import { Event, EventStatus } from '@qrush/types/Events';
|
|
25
|
+
import { Promotion, PromotionType } from '@qrush/types/Promotion';
|
|
26
|
+
import { Location, LocationType } from '@qrush/types/Location';
|
|
27
|
+
import { Genre } from '@qrush/types/Genres';
|
|
28
|
+
import { Meta } from '@qrush/types/Meta';
|
|
29
|
+
import { CommonFields } from '@qrush/types/Common';
|
|
30
|
+
import { CustomDocType } from '@qrush/types/CustomDocType';
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Available Types
|
|
34
|
+
|
|
35
|
+
- **Users** - User profiles, roles, and authentication types
|
|
36
|
+
- **Events** - Event data structures and status types
|
|
37
|
+
- **Promotions** - Promotion and marketing campaign types
|
|
38
|
+
- **Location** - Geographic and venue-related types
|
|
39
|
+
- **Genres** - Music and entertainment genre definitions
|
|
40
|
+
- **Meta** - Metadata and configuration types
|
|
41
|
+
- **Common** - Shared utility types and interfaces
|
|
42
|
+
- **CustomDocType** - Custom document type definitions
|
|
43
|
+
|
|
44
|
+
## Development
|
|
45
|
+
|
|
46
|
+
### Prerequisites
|
|
47
|
+
|
|
48
|
+
- [Bun](https://bun.sh) v1.1.1 or later
|
|
49
|
+
- Node.js 18+ (for npm publishing)
|
|
50
|
+
|
|
51
|
+
### Setup
|
|
4
52
|
|
|
5
53
|
```bash
|
|
54
|
+
# Install dependencies
|
|
6
55
|
bun install
|
|
56
|
+
|
|
57
|
+
# Build the project
|
|
58
|
+
bun run build
|
|
59
|
+
|
|
60
|
+
# Build and watch for changes
|
|
61
|
+
bun run build --watch
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Project Structure
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
src/
|
|
68
|
+
├── index.ts # Main entry point
|
|
69
|
+
├── Common.ts # Shared utility types
|
|
70
|
+
├── Users.ts # User-related types
|
|
71
|
+
├── Events.ts # Event-related types
|
|
72
|
+
├── Promotion.ts # Promotion types
|
|
73
|
+
├── Location.ts # Location types
|
|
74
|
+
├── Genres.ts # Genre definitions
|
|
75
|
+
├── Meta.ts # Metadata types
|
|
76
|
+
└── CustomDocType.ts # Custom document types
|
|
7
77
|
```
|
|
8
78
|
|
|
9
|
-
|
|
79
|
+
## Publishing
|
|
80
|
+
|
|
81
|
+
This package uses automated publishing via GitHub Actions:
|
|
82
|
+
|
|
83
|
+
### Automatic Publishing (Recommended)
|
|
84
|
+
|
|
85
|
+
1. Update the version in `package.json`
|
|
86
|
+
2. Commit your changes
|
|
87
|
+
3. Create and push a version tag:
|
|
10
88
|
|
|
11
89
|
```bash
|
|
12
|
-
|
|
90
|
+
git add .
|
|
91
|
+
git commit -m "Release v1.0.1"
|
|
92
|
+
git tag v1.0.1
|
|
93
|
+
git push origin v1.0.1
|
|
13
94
|
```
|
|
14
95
|
|
|
15
|
-
|
|
96
|
+
### Manual Publishing
|
|
97
|
+
|
|
98
|
+
1. Go to the GitHub repository
|
|
99
|
+
2. Navigate to **Actions** tab
|
|
100
|
+
3. Select **"Manual Publish to NPM"** workflow
|
|
101
|
+
4. Click **"Run workflow"**
|
|
102
|
+
5. Choose version bump type (patch/minor/major)
|
|
103
|
+
6. Click **"Run workflow"**
|
|
104
|
+
|
|
105
|
+
## Dependencies
|
|
106
|
+
|
|
107
|
+
### Peer Dependencies
|
|
108
|
+
|
|
109
|
+
- `@firebase/firestore` >=4.0.0
|
|
110
|
+
|
|
111
|
+
### Dev Dependencies
|
|
112
|
+
|
|
113
|
+
- `typescript` ^5.4.5
|
|
114
|
+
- `@firebase/firestore` ^4.6.3
|
|
115
|
+
|
|
116
|
+
## License
|
|
117
|
+
|
|
118
|
+
This project is part of the QRush ecosystem.
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
Built with [Bun](https://bun.sh) 🚀
|
package/package.json
CHANGED