@glidevvr/storage-payload-types-pkg 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,53 @@
+[![N|Solid](https://cdn.golocalinteractive.com/wp-content/uploads/2025/03/cropped-Untitled-design-16-32x32.png)](https://golocalinteractive.com)
+# @glidevvr/storage-payload-types-pkg
+
+Provides the latest payload-types.ts generated from a Payload CMS instance.
+
+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.
+
+# ✨ Features
+
+- ✅ Automatically updated types on every new Payload CMS deployment
+
+- ✅ Written in TypeScript
+
+- ✅ No dependencies
+
+- ✅ Easy to consume in any Next.js app
+
+## 📦 Installation
+```bash
+npm install @glidevvr/storage-payload-types-pkg
+```
+
+## 📘 Usage
+
+Once installed, simply import the types into your Next.js app:
+```bash
+// Example usage:
+import { Media, Page } from '@glidevvr/storage-payload-types-pkg';
+```
+The specific exports depend on how the Payload CMS config is structured and what types are included in the payload-types.ts file.
+
+## 🔄 Auto-updates
+
+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.
+
+## 📁 File Contents
+
+payload-types.ts – Generated using payload generate:types
+
+## 🛠️ Requirements
+
+This package assumes you are using:
+
+Payload CMS v3.0+
+
+Next.js (or another modern TypeScript-based frontend)
+
+## 📄 License
+
+ISC © Go Local Interactive
+
+## Change Log
+1.0.3 - Add README.md

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glidevvr/storage-payload-types-pkg",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Package for Payload CMS types.",
   "main": "payload-types.ts",
   "scripts": {

package/payload-types.ts

@@ -161,8 +161,10 @@ export interface Page {
     | FormBlock
     | HomeTestimonialBlock
     | RentalStepsBlock
+    | StoragResourcesBlock
     | FeaturesGridBlock
     | HomeHero
+    | HorizontalRuleBlock
   )[];
   meta?: {
     title?: string | null;
@@ -1030,6 +1032,92 @@ export interface RentalStepsBlock {
   blockName?: string | null;
   blockType: 'rental-steps';
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "StoragResourcesBlock".
+ */
+export interface StoragResourcesBlock {
+  heading?: string | null;
+  description?: {
+    root: {
+      type: string;
+      children: {
+        type: string;
+        version: number;
+        [k: string]: unknown;
+      }[];
+      direction: ('ltr' | 'rtl') | null;
+      format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
+      indent: number;
+      version: number;
+    };
+    [k: string]: unknown;
+  } | null;
+  buttonLink?: {
+    type?: ('reference' | 'custom') | null;
+    newTab?: boolean | null;
+    reference?:
+      | ({
+          relationTo: 'pages';
+          value: string | Page;
+        } | null)
+      | ({
+          relationTo: 'posts';
+          value: string | Post;
+        } | null)
+      | ({
+          relationTo: 'facilities';
+          value: string | Facility;
+        } | null)
+      | ({
+          relationTo: 'markets';
+          value: string | Market;
+        } | null)
+      | ({
+          relationTo: 'categories';
+          value: string | Category;
+        } | null);
+    url?: string | null;
+    label?: string | null;
+  };
+  storageResources?:
+    | {
+        resourceIcon?: string | null;
+        resourceTitle?: string | null;
+        resourceLink: {
+          type?: ('reference' | 'custom') | null;
+          newTab?: boolean | null;
+          reference?:
+            | ({
+                relationTo: 'pages';
+                value: string | Page;
+              } | null)
+            | ({
+                relationTo: 'posts';
+                value: string | Post;
+              } | null)
+            | ({
+                relationTo: 'facilities';
+                value: string | Facility;
+              } | null)
+            | ({
+                relationTo: 'markets';
+                value: string | Market;
+              } | null)
+            | ({
+                relationTo: 'categories';
+                value: string | Category;
+              } | null);
+          url?: string | null;
+          label: string;
+        };
+        id?: string | null;
+      }[]
+    | null;
+  id?: string | null;
+  blockName?: string | null;
+  blockType: 'storage-resources';
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "FeaturesGridBlock".
@@ -1120,6 +1208,15 @@ export interface HomeHero {
   blockName?: string | null;
   blockType: 'homeHero';
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "HorizontalRuleBlock".
+ */
+export interface HorizontalRuleBlock {
+  id?: string | null;
+  blockName?: string | null;
+  blockType: 'horizontal-rule';
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "menus".
@@ -1377,8 +1474,10 @@ export interface PagesSelect<T extends boolean = true> {
         formBlock?: T | FormBlockSelect<T>;
         homeTestimonial?: T | HomeTestimonialBlockSelect<T>;
         'rental-steps'?: T | RentalStepsBlockSelect<T>;
+        'storage-resources'?: T | StoragResourcesBlockSelect<T>;
         'features-grid'?: T | FeaturesGridBlockSelect<T>;
         homeHero?: T | HomeHeroSelect<T>;
+        'horizontal-rule'?: T | HorizontalRuleBlockSelect<T>;
       };
   meta?:
     | T
@@ -1513,6 +1612,41 @@ export interface RentalStepsBlockSelect<T extends boolean = true> {
   id?: T;
   blockName?: T;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "StoragResourcesBlock_select".
+ */
+export interface StoragResourcesBlockSelect<T extends boolean = true> {
+  heading?: T;
+  description?: T;
+  buttonLink?:
+    | T
+    | {
+        type?: T;
+        newTab?: T;
+        reference?: T;
+        url?: T;
+        label?: T;
+      };
+  storageResources?:
+    | T
+    | {
+        resourceIcon?: T;
+        resourceTitle?: T;
+        resourceLink?:
+          | T
+          | {
+              type?: T;
+              newTab?: T;
+              reference?: T;
+              url?: T;
+              label?: T;
+            };
+        id?: T;
+      };
+  id?: T;
+  blockName?: T;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "FeaturesGridBlock_select".
@@ -1555,6 +1689,14 @@ export interface HomeHeroSelect<T extends boolean = true> {
   id?: T;
   blockName?: T;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "HorizontalRuleBlock_select".
+ */
+export interface HorizontalRuleBlockSelect<T extends boolean = true> {
+  id?: T;
+  blockName?: T;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "media_select".