Savaye Utils

Shared TypeScript types and validation utilities for Savaye projects.

Installation

Local Development

# In your project
yarn add file:../savaye-utils

NPM (once published)

yarn add savaye-utils

Usage

Types

import { ProductData, PriceData, StrapiLifecycleEvent } from 'savaye-utils'

// Or import from specific module
import { ProductData } from 'savaye-utils/types'

Validators

import {
  validateDate,
  validateDateRange,
  validatePositiveNumber,
  validateNumberRange,
  validateInteger,
  parseJsonArray,
  isEmptyValue,
  isDefined,
} from 'savaye-utils'

// Or import from specific module
import { validateDate, validatePositiveNumber } from 'savaye-utils/validators'

// Example usage
validateDate(someDate, 'EventDate')
validatePositiveNumber(price, 'BaseAmount')

Available Types

ProductData

Interface for product data including:

• Product types: Product, Event, Resource
• Event-specific fields (dates, location, capacity, etc.)
• Media and email template fields
• Price relationships

PriceData

Interface for pricing data including:

• Payment types: Full, Discounted Full, Deposit Plan, Free
• Currency support (USD, NGN)
• Discount and installment options
• Payment provider integration (Stripe, Paystack)
• Product relationship

StrapiLifecycleEvent

Generic interface for Strapi lifecycle hooks.

Available Validators

• validateDate(dateValue, fieldName) - Validates dates
• validateDateRange(startDate, endDate, startFieldName, endFieldName) - Validates date ranges
• validatePositiveNumber(value, fieldName) - Validates positive numbers
• validateNumberRange(value, min, max, fieldName) - Validates number ranges
• validateInteger(value, fieldName) - Validates integers
• parseJsonArray<T>(value, fieldName) - Parses JSON arrays safely
• isEmptyValue(value) - Checks for empty values
• isDefined(value) - Checks if value is defined

Development

# Install dependencies
yarn install

# Build the package
yarn build

# Development mode
yarn dev

License

MIT