@glidevvr/storage-payload-types-pkg 1.0.2 → 1.0.4
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 +53 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
[](https://golocalinteractive.com)
|
|
2
|
+
# @glidevvr/storage-payload-types-pkg
|
|
3
|
+
|
|
4
|
+
Provides the latest payload-types.ts generated from a Payload CMS instance.
|
|
5
|
+
|
|
6
|
+
This package is designed for use with Next.js Storage Themes built on top of Payload CMS and serves as a type-safe contract between your CMS backend and frontend consumers.
|
|
7
|
+
|
|
8
|
+
# ✨ Features
|
|
9
|
+
|
|
10
|
+
- ✅ Automatically updated types on every new Payload CMS deployment
|
|
11
|
+
|
|
12
|
+
- ✅ Written in TypeScript
|
|
13
|
+
|
|
14
|
+
- ✅ No dependencies
|
|
15
|
+
|
|
16
|
+
- ✅ Easy to consume in any Next.js app
|
|
17
|
+
|
|
18
|
+
## 📦 Installation
|
|
19
|
+
```bash
|
|
20
|
+
npm install @glidevvr/storage-payload-types-pkg
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## 📘 Usage
|
|
24
|
+
|
|
25
|
+
Once installed, simply import the types into your Next.js app:
|
|
26
|
+
```bash
|
|
27
|
+
// Example usage:
|
|
28
|
+
import { Media, Page } from '@glidevvr/storage-payload-types-pkg';
|
|
29
|
+
```
|
|
30
|
+
The specific exports depend on how the Payload CMS config is structured and what types are included in the payload-types.ts file.
|
|
31
|
+
|
|
32
|
+
## 🔄 Auto-updates
|
|
33
|
+
|
|
34
|
+
This package is automatically updated via CI through the BitBucket pipeline when the Payload CMS schema changes after a successful build on the gli-payload-multitenant master branch. You’ll always get the latest types with a simple version bump.
|
|
35
|
+
|
|
36
|
+
## 📁 File Contents
|
|
37
|
+
|
|
38
|
+
payload-types.ts – Generated using payload generate:types
|
|
39
|
+
|
|
40
|
+
## 🛠️ Requirements
|
|
41
|
+
|
|
42
|
+
This package assumes you are using:
|
|
43
|
+
|
|
44
|
+
Payload CMS v3.0+
|
|
45
|
+
|
|
46
|
+
Next.js (or another modern TypeScript-based frontend)
|
|
47
|
+
|
|
48
|
+
## 📄 License
|
|
49
|
+
|
|
50
|
+
ISC © Go Local Interactive
|
|
51
|
+
|
|
52
|
+
## Change Log
|
|
53
|
+
1.0.3 - Add README.md
|