@getcommunity/gc-validators 0.0.122 → 0.0.123

package/README.md

@@ -1,6 +1,257 @@
+---
+name: "Get Community Validators"
+description: "A validation library for Get Community defining and validating data structures used throughout the application."
+category: "Web Development"
+repository: "https://github.com/getcommunity/gc-validators"
+author: "Joey Grable"
+authorUrl: "https://github.com/joeygrable94"
+tags:
+  [
+    "Get Community",
+    "homebuilder digital marketing",
+    "website development",
+    "validation library",
+    "TypeScript",
+    "NodeJS",
+    "ValiBot"
+  ]
+lastUpdated: "2025-10"
+---
+
 # 🪨 GC Validators
 
-## Example Permission Constants Usage
+[@getcommunity/gc-validators](https://github.com/getcommunity/gc-validators)
+
+## Project Overview
+
+The Get Community Validators package provides a set of validation rules and utilities for ensuring data integrity and consistency across the Get Community application. It defines and validates data structures used throughout the application, ensuring that all data conforms to expected formats and business rules.
+
+## Tech Stack
+
+Main technologies and tools used:
+
+- TypeScript
+- NodeJS
+- ValiBot
+- Pnpm
+- NPM
+
+## Project Structure
+
+```plaintext
+gc-validators/
+├── scripts/
+├── src/
+│   ├── constants/
+│   ├── schemas/
+│   ├── types/
+│   │   ├── components/
+│   │   │   ├── blocks/
+│   │   │   ├── brand/
+│   │   │   ├── forms/
+│   │   │   ├── shared/
+│   │   │   ├── slideshow/
+│   │   │   ├── utm/
+│   │   │   └── index.ts
+│   │   ├── core/
+│   │   ├── documents/
+│   │   ├── singles/
+│   │   └── index.ts
+│   ├── utilities/
+│   ├── validators/
+│   └── index.ts
+├── .vscode/
+├── .env
+├── .gitignore
+├── .npmignore
+├── .npmrc
+├── .pre-commit-config.yaml
+├── .prettierignore
+├── .prettierrc.mjs
+├── tsconfig.json
+├── tsup.config.ts
+├── pnpm-lock.yaml
+└── package.json
+```
+
+## Development Guidelines
+
+### Code Style
+
+- Use consistent code formatting tools
+  - Use Prettier for code formatting
+  - Use ESLint for linting
+  - Use pre-commit hooks for code quality checks
+- Follow language-specific best practices
+- Keep code clean and readable
+
+### Naming Conventions
+
+- File naming: (snake-case)
+  - all lowercase with hyphens
+  - append file type as suffix
+  - e.g., `entity-schema.tsx`, `pagination-constants.ts`
+- Variable naming: (PascalCase, or UPPER_SNAKE_CASE)
+  - types should be in PascalCase (e.g., `ClientDocument`, `BlogPostDocument`)
+  - global constants should be in UPPER_SNAKE_CASE (e.g., `LIMIT_SHORT_STRING_MAX_LENGTH`)
+- Function naming: (camelCase)
+  - use camelCase for function names (e.g., `datePlusDays`, `hasPermission`)
+- Class and Schema naming: (PascalCase)
+  - use PascalCase for classes and schemas (e.g., `PermissionCheck`, `RolesWithPermissions`)
+  - prefix entity action schemas with "S" and the CRUD operation (e.g., `SUpdateClientDocument`, `SCreateContentPillarDocument`)
+
+### Git Workflow
+
+#### Branching Strategy
+
+- `production` branch is used for production releases
+- `main` branch is used for staged production
+- `dev` branch is used for development
+- `test` branch is used for testing
+- `upgrade` branch is used for upgrading dependencies
+- `feat-*` branches are used for new features
+- `bugfix-*` branches are used for bug fixes
+
+#### Commit message format
+
+- Get Community follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification for commit messages.
+
+#### Pull Request process
+
+- All pull requests should be reviewed by at least one other team member and approved by by a code manager before merging.
+- Ensure that all tests pass before merging.
+- Use descriptive titles and provide context in the PR description.
+
+## Environment Setup
+
+Each submodule contains an .env.example file that outlines the necessary environment variables. Copy this file to .env and fill in the appropriate values. Many of the env variable are managed in a secure vault and can be retrieved from the project manager.
+
+### Development Requirements
+
+- Node.js version: >=22.x (LTS)
+- Package manager: pnpm
+- Other dependencies: Git
+
+### Installation Steps
+
+```bash
+# 1. Clone the library
+git clone [repository-url]
+
+# 2. Install dependencies
+pnpm install
+
+# 3. Build the library
+pnpm build
+```
+
+## Core Feature Implementation (TO DO)
+
+### Feature Module 1
+
+Describe the implementation approach and key code examples for main features.
+
+```javascript
+// Example code
+function exampleFunction() {
+  // Implementation logic
+}
+```
+
+## Testing Strategy
+
+### Unit Testing
+
+- Testing framework:
+- Test coverage requirements:
+- Test file organization:
+
+### Integration Testing
+
+- Test scenarios:
+- Testing tools:
+
+### End-to-End Testing
+
+- Test workflow:
+- Automation tools:
+
+## Deployment Guide
+
+### Build Process
+
+```bash
+# Build command
+pnpm build
+```
+
+### Deployment Steps
+
+1. Prepare production environment
+2. Configure environment variables
+3. Execute deployment scripts
+4. Verify deployment results
+
+### Environment Variables
+
+```env
+# Example environment variables
+```
+
+## Performance Optimization
+
+### Frontend Optimization
+
+- Code splitting
+- Lazy loading
+- Caching strategies
+
+### Backend Optimization
+
+- Database query optimization
+- Caching mechanisms
+- Load balancing
+
+## Security Considerations
+
+### Data Security
+
+- Input validation
+- SQL injection protection
+- XSS protection
+
+### Authentication & Authorization
+
+- User authentication flow
+- Permission control
+- Token management
+
+## Monitoring and Logging
+
+### Application Monitoring
+
+- Performance metrics
+- Error tracking
+- User behavior analytics
+
+### Log Management
+
+- Log levels
+- Log format
+- Log storage
+
+## Reference Resources
+
+- [Official Documentation Link]
+- [Related Tutorials]
+- [Community Resources]
+- [Best Practices Guide]
+
+---
+
+## Examples
+
+### Permission Constants Usage
 
 ```ts
 const userDoc: UserDocument = {

package/dist/index.cjs

@@ -46,6 +46,8 @@ var LIMIT_MIN_QUERY = 1;
 var LIMIT_MAX_QUERY = 2038;
 var LIMIT_MIN_FRAGMENT = 1;
 var LIMIT_MAX_FRAGMENT = 2038;
+var LIMIT_MIN_UTM_KEY = 1;
+var LIMIT_MAX_UTM_KEY = 255;
 var LIMIT_MIN_UTM_SOURCE = 1;
 var LIMIT_MAX_UTM_SOURCE = 2026;
 var LIMIT_MIN_UTM_MEDIUM = 1;
@@ -183,6 +185,13 @@ var ROLE_PERMISSIONS = {
       update: false,
       delete: false
     },
+    "media-content-type": {
+      list: false,
+      create: false,
+      read: false,
+      update: false,
+      delete: false
+    },
     "user-account": {
       list: false,
       create: false,
@@ -268,6 +277,13 @@ var ROLE_PERMISSIONS = {
       update: false,
       delete: false
     },
+    "media-content-type": {
+      list: false,
+      create: false,
+      read: false,
+      update: false,
+      delete: false
+    },
     "user-account": {
       list: false,
       create: false,
@@ -354,6 +370,13 @@ var ROLE_PERMISSIONS = {
       update: false,
       delete: false
     },
+    "media-content-type": {
+      list: true,
+      create: false,
+      read: true,
+      update: false,
+      delete: false
+    },
     "user-account": {
       list: true,
       create: false,
@@ -449,6 +472,13 @@ var ROLE_PERMISSIONS = {
       update: true,
       delete: true
     },
+    "media-content-type": {
+      list: true,
+      create: true,
+      read: true,
+      update: true,
+      delete: true
+    },
     "user-account": {
       list: true,
       create: false,
@@ -535,6 +565,13 @@ var ROLE_PERMISSIONS = {
       update: false,
       delete: false
     },
+    "media-content-type": {
+      list: true,
+      create: false,
+      read: true,
+      update: false,
+      delete: false
+    },
     "user-account": {
       list: true,
       create: false,
@@ -1236,6 +1273,20 @@ var IsValidConfirmed = v6__namespace.boolean();
 var IsValidOrUndefinedConfirmed = v6__namespace.optional(IsValidConfirmed);
 var IsValidBlocked = v6__namespace.boolean();
 var IsValidOrUndefinedBlocked = v6__namespace.optional(IsValidBlocked);
+var IsValidUrlUtmKey = v6__namespace.pipe(
+  v6__namespace.string(),
+  v6__namespace.trim(),
+  v6__namespace.minLength(
+    LIMIT_MIN_UTM_KEY,
+    `the utm_key is too short, it must be at least ${LIMIT_MIN_UTM_KEY} characters`
+  ),
+  v6__namespace.maxLength(
+    LIMIT_MAX_UTM_KEY,
+    `the utm_key is too long, it must be ${LIMIT_MAX_UTM_KEY} characters or less`
+  ),
+  v6__namespace.regex(REGEX_UTM_VALUE, `utm_key ${ERROR_MESSAGE_REGEX_UTM_VALUE}`)
+);
+var IsValidOrUndefinedUrlUtmKey = v6__namespace.optional(IsValidUrlUtmKey);
 var IsValidUrlUtmSource = v6__namespace.pipe(
   v6__namespace.string(),
   v6__namespace.trim(),
@@ -1782,9 +1833,41 @@ var SUpdateLeadRequest = v6__namespace.object({
   documentId: IsValidReferenceDocumentId,
   data: SUpdateLeadDocument
 });
+var QuerySortMediaContentType = v6__namespace.optional(
+  v6__namespace.object({
+    key: v6__namespace.picklist(["id", "title", "slug", "utm_key", "createdAt", "updatedAt"]),
+    order: v6__namespace.picklist(["ASC", "DESC"])
+  })
+);
+var QueryStrapiSearchMediaContentType = v6__namespace.object({
+  page: v6__namespace.optional(v6__namespace.pipe(v6__namespace.number(), v6__namespace.minValue(1))),
+  size: v6__namespace.optional(
+    v6__namespace.pipe(v6__namespace.number(), v6__namespace.minValue(1), v6__namespace.maxValue(LIMIT_PAGINATION_MAX_SIZE))
+  ),
+  title: IsValidOrUndefinedShortString,
+  slug: IsValidOrUndefinedShortString,
+  utm_key: IsValidOrUndefinedUrlUtmKey,
+  sort: QuerySortMediaContentType
+});
+var SCreateMediaContentTypeDocument = v6__namespace.object({
+  title: IsValidShortString,
+  slug: IsValidSlug,
+  utm_key: IsValidOrUndefinedUrlUtmKey,
+  description: IsValidOrUndefinedLongString
+});
+var SUpdateMediaContentTypeDocument = v6__namespace.object({
+  title: IsValidOrUndefinedShortString,
+  slug: IsValidOrUndefinedSlug,
+  utm_key: IsValidOrUndefinedUrlUtmKey,
+  description: IsValidOrUndefinedLongString
+});
+var SUpdateMediaContentTypeDocumentRequest = v6__namespace.object({
+  documentId: IsValidReferenceDocumentId,
+  data: SUpdateMediaContentTypeDocument
+});
 var QuerySortMediaPlatforms = v6__namespace.optional(
   v6__namespace.object({
-    key: v6__namespace.picklist(["id", "title", "slug", "utm_source", "createdAt", "updatedAt"]),
+    key: v6__namespace.picklist(["id", "title", "slug", "utm_key", "createdAt", "updatedAt"]),
     order: v6__namespace.picklist(["ASC", "DESC"])
   })
 );
@@ -1795,19 +1878,19 @@ var QueryStrapiSearchMediaPlatforms = v6__namespace.object({
   ),
   title: IsValidOrUndefinedShortString,
   slug: IsValidOrUndefinedShortString,
-  utm_source: IsValidOrUndefinedUrlUtmSource,
+  utm_key: IsValidUrlUtmKey,
   sort: QuerySortMediaPlatforms
 });
 var SCreateMediaPlatformDocument = v6__namespace.object({
   title: IsValidShortString,
   slug: IsValidSlug,
-  utm_source: IsValidOrUndefinedUrlUtmSource,
+  utm_key: IsValidUrlUtmKey,
   description: IsValidOrUndefinedLongString
 });
 var SUpdateMediaPlatformDocument = v6__namespace.object({
   title: IsValidOrUndefinedShortString,
   slug: IsValidOrUndefinedSlug,
-  utm_source: IsValidOrUndefinedUrlUtmSource,
+  utm_key: IsValidUrlUtmKey,
   description: IsValidOrUndefinedLongString
 });
 var SUpdateMediaPlatformDocumentRequest = v6__namespace.object({
@@ -2710,6 +2793,7 @@ exports.IsValidOrUndefinedUrlUtmCampaign = IsValidOrUndefinedUrlUtmCampaign;
 exports.IsValidOrUndefinedUrlUtmContent = IsValidOrUndefinedUrlUtmContent;
 exports.IsValidOrUndefinedUrlUtmCreativeFormat = IsValidOrUndefinedUrlUtmCreativeFormat;
 exports.IsValidOrUndefinedUrlUtmId = IsValidOrUndefinedUrlUtmId;
+exports.IsValidOrUndefinedUrlUtmKey = IsValidOrUndefinedUrlUtmKey;
 exports.IsValidOrUndefinedUrlUtmMedium = IsValidOrUndefinedUrlUtmMedium;
 exports.IsValidOrUndefinedUrlUtmSource = IsValidOrUndefinedUrlUtmSource;
 exports.IsValidOrUndefinedUrlUtmTerm = IsValidOrUndefinedUrlUtmTerm;
@@ -2745,6 +2829,7 @@ exports.IsValidUrlUtmCampaign = IsValidUrlUtmCampaign;
 exports.IsValidUrlUtmContent = IsValidUrlUtmContent;
 exports.IsValidUrlUtmCreativeFormat = IsValidUrlUtmCreativeFormat;
 exports.IsValidUrlUtmId = IsValidUrlUtmId;
+exports.IsValidUrlUtmKey = IsValidUrlUtmKey;
 exports.IsValidUrlUtmMedium = IsValidUrlUtmMedium;
 exports.IsValidUrlUtmSource = IsValidUrlUtmSource;
 exports.IsValidUrlUtmTerm = IsValidUrlUtmTerm;
@@ -2794,6 +2879,7 @@ exports.LIMIT_MAX_UTM_CAMPAIGN = LIMIT_MAX_UTM_CAMPAIGN;
 exports.LIMIT_MAX_UTM_CONTENT = LIMIT_MAX_UTM_CONTENT;
 exports.LIMIT_MAX_UTM_CREATIVE_FORMAT = LIMIT_MAX_UTM_CREATIVE_FORMAT;
 exports.LIMIT_MAX_UTM_ID = LIMIT_MAX_UTM_ID;
+exports.LIMIT_MAX_UTM_KEY = LIMIT_MAX_UTM_KEY;
 exports.LIMIT_MAX_UTM_MEDIUM = LIMIT_MAX_UTM_MEDIUM;
 exports.LIMIT_MAX_UTM_SOURCE = LIMIT_MAX_UTM_SOURCE;
 exports.LIMIT_MAX_UTM_TERM = LIMIT_MAX_UTM_TERM;
@@ -2811,6 +2897,7 @@ exports.LIMIT_MIN_UTM_CAMPAIGN = LIMIT_MIN_UTM_CAMPAIGN;
 exports.LIMIT_MIN_UTM_CONTENT = LIMIT_MIN_UTM_CONTENT;
 exports.LIMIT_MIN_UTM_CREATIVE_FORMAT = LIMIT_MIN_UTM_CREATIVE_FORMAT;
 exports.LIMIT_MIN_UTM_ID = LIMIT_MIN_UTM_ID;
+exports.LIMIT_MIN_UTM_KEY = LIMIT_MIN_UTM_KEY;
 exports.LIMIT_MIN_UTM_MEDIUM = LIMIT_MIN_UTM_MEDIUM;
 exports.LIMIT_MIN_UTM_SOURCE = LIMIT_MIN_UTM_SOURCE;
 exports.LIMIT_MIN_UTM_TERM = LIMIT_MIN_UTM_TERM;
@@ -2848,6 +2935,7 @@ exports.QuerySortClientUsers = QuerySortClientUsers;
 exports.QuerySortClients = QuerySortClients;
 exports.QuerySortContentPillars = QuerySortContentPillars;
 exports.QuerySortEntities = QuerySortEntities;
+exports.QuerySortMediaContentType = QuerySortMediaContentType;
 exports.QuerySortMediaPlatforms = QuerySortMediaPlatforms;
 exports.QuerySortTeamMembers = QuerySortTeamMembers;
 exports.QuerySortUrlRedirects = QuerySortUrlRedirects;
@@ -2871,6 +2959,7 @@ exports.QueryStrapiSearchClientReports = QueryStrapiSearchClientReports;
 exports.QueryStrapiSearchClientStyleguide = QueryStrapiSearchClientStyleguide;
 exports.QueryStrapiSearchClients = QueryStrapiSearchClients;
 exports.QueryStrapiSearchContentPillars = QueryStrapiSearchContentPillars;
+exports.QueryStrapiSearchMediaContentType = QueryStrapiSearchMediaContentType;
 exports.QueryStrapiSearchMediaPlatforms = QueryStrapiSearchMediaPlatforms;
 exports.QueryStrapiSearchTeamMembers = QueryStrapiSearchTeamMembers;
 exports.QueryStrapiSearchUtmTrackingLinks = QueryStrapiSearchUtmTrackingLinks;
@@ -2900,6 +2989,7 @@ exports.SCreateClientStyleguideDocument = SCreateClientStyleguideDocument;
 exports.SCreateClientUserDocument = SCreateClientUserDocument;
 exports.SCreateContentPillarDocument = SCreateContentPillarDocument;
 exports.SCreateLeadDocument = SCreateLeadDocument;
+exports.SCreateMediaContentTypeDocument = SCreateMediaContentTypeDocument;
 exports.SCreateMediaPlatformDocument = SCreateMediaPlatformDocument;
 exports.SCreateMultipleStrapiMediaUploadDocument = SCreateMultipleStrapiMediaUploadDocument;
 exports.SCreateNewsletterSignup = SCreateNewsletterSignup;
@@ -2952,6 +3042,8 @@ exports.SUpdateContentPillarDocument = SUpdateContentPillarDocument;
 exports.SUpdateContentPillarDocumentRequest = SUpdateContentPillarDocumentRequest;
 exports.SUpdateLeadDocument = SUpdateLeadDocument;
 exports.SUpdateLeadRequest = SUpdateLeadRequest;
+exports.SUpdateMediaContentTypeDocument = SUpdateMediaContentTypeDocument;
+exports.SUpdateMediaContentTypeDocumentRequest = SUpdateMediaContentTypeDocumentRequest;
 exports.SUpdateMediaPlatformDocument = SUpdateMediaPlatformDocument;
 exports.SUpdateMediaPlatformDocumentRequest = SUpdateMediaPlatformDocumentRequest;
 exports.SUpdateNewsletterSignupDocument = SUpdateNewsletterSignupDocument;