EC React Schemas

Schemas for the Socotra Insurance Suite

This package provides a comprehensive collection of zod schemas that define the core data structures for Socotra’s Enterprise Components. These schemas are fundamental to ensuring type safety, data integrity, and validation across the platform, from backend services to frontend components.

Core Philosophy

Zod Schemas are powerful tools for data validation and type inference. They are used to define the structure of the data that is passed into and out of the library. They are also used to define the structure of the data that is stored in the database.

By leveraging the power of Zod, we can ensure that the data that is passed into and out of the library is always valid and of the correct type. This is especially important for complex data structures that are used in the library, such as policies, accounts, and transactions.

Key Features

• Domain Schemas: Business-specific data models (e.g., Policies, Invoices, Accounts).
• Config Schemas: Structures for configuration objects (e.g., Product and UI configurations).
• Service Schemas: Data contracts for API requests and responses.
• Shared Schemas: Common, reusable data structures used across multiple domains.

Installation

This package has a peer dependency on zod. Install both packages in your project:

npm i @socotra/ec-react-schemas zod

Usage

Import schemas directly from the package to use them for data validation, type inference, or in conjunction with libraries like react-hook-form.

import { policyResponseSchema } from '@socotra/ec-react-schemas';
import { z } from 'zod';

type Policy = z.infer<typeof policyResponseSchema>;

function validatePolicy(data: unknown): Policy {
	return policyResponseSchema.parse(data);
}

Available Schemas

Accounts

account-request.ts

Billings

credit-distribution-request-schema.ts

credit-distribution-response-schema.ts

credit-distribution-reverse-request.ts

credit-distribution-schemas.ts

delinquency-schemas.ts

invoice-response-schema.ts

invoice-schemas.ts

ledger-account-response-schema.ts

ledger-account-schemas.ts

payment-request-schema.ts

payment-schemas.ts

Charges

charge-enums.ts

charge-response-schema.ts

Config

account-evaluate-constraints-request.ts

account-schema.ts

auto-renewal-plan-schema.ts

bootstrap.ts

constraint-schema.ts

constraint-tables-schema.ts

coverage-terms-schema.ts

data-model-schema.ts

data-type-schema.ts

delinquency-plan-schema.ts

element-schema.ts

dependency-map-response.ts

evaluate-constraint-request.ts

evaluate-constraint-response.ts

field-schema.ts

payment-schema.ts

product-schema.ts

quantifiers.ts

reversal-type-schema.ts

tenant-schema.ts

transaction-types-schema.ts

Documents

document-response.ts

Policies

policy-schemas.ts

policy-snapshot-response.ts

policy-term-response.ts

policy-term-schemas.ts

term-schemas.ts

term-summary.ts

transaction-snapshot-response.ts

transaction-underwriting-response.ts

Quotes

quote-price-response.ts

quote-request.ts

quote-schemas.ts

quote-underwriting-response.ts

reset-quote-request.ts

Shared

anchor-mode.ts

anchor-type.ts

billing-level.ts

cadence.ts

currencies.ts

days.ts

document-reference-type.ts

document-state.ts

element-request.ts

element-response.ts

field-values.ts

preferences-response.ts

timezones.ts

underwriting-flag-response.ts

underwriting-flags-request.ts

validation-result.ts

Transactions

add-change-instruction-create-request.ts

add-change-instruction-response.ts

delete-change-instruction-create-request.ts

delete-change-instruction-response.ts

modify-change-instruction-create-request.ts

modify-change-instruction-response.ts

params-change-instruction-create-request.ts

params-change-instruction-response.ts

policy-transaction-response.ts

reset-transaction-options-request.ts

transaction-enums.ts

transaction-price-response.ts

transaction-underwriting-response.ts