@nocios/frontend-types

Canonical frontend type contracts for the CRUDIFY monorepo.

Purpose

This package centralizes shared type definitions across frontend workspaces:

• domain models (actions, modules, policies, forms),
• frontend API contracts (core CRUDIFY and admin),
• shared utility contracts (filters, sort, pagination, populate),
• tenant configuration model.

This package is intentionally type-focused. It does not contain runtime business logic.

Scope of v1

• Canonical shared types only.
• No legacy alias layer.
• No consumer migration performed in this phase.
• No local UI-only types from each app unless they are truly shared contracts.

Canonical Domains (v1)

• domain/action: action definitions, view/position enums, list/form/custom payload contracts.
• domain/module: module schemas, module definitions, and module version history.
• domain/policy: policy field permissions and required permission contracts.
• domain/form: form field kinds, dynamic values, computed values, and password rules.
• contracts/crudify-core: shared CRUDIFY request/response and transaction contracts.
• contracts/crudify-admin: admin API envelopes, filters, and create/edit inputs.
• contracts/tenant: tenant and frontend environment contracts.
• shared/common: shared low-level filter/sort/pagination/populate primitives.

Canonical Source Rule

When existing types conflict, API/backend contract has precedence.

Public API

Imports are available from:

• @nocios/frontend-types
• @nocios/frontend-types/domain
• @nocios/frontend-types/contracts
• @nocios/frontend-types/shared

Documentation

• Overview
• Architecture
• Domain
• Setup
• Workflow
• AI Context
• Modeling Rules
• Source to Canonical Matrix

Development

pnpm --filter @nocios/frontend-types run typecheck
pnpm --filter @nocios/frontend-types run lint
pnpm --filter @nocios/frontend-types run test
pnpm --filter @nocios/frontend-types run test:coverage

Versioning Policy

• Breaking public type changes require a major version bump.
• Additive backward-compatible type changes require a minor version bump.
• Fix-only type corrections (without breaking consumers) require a patch bump.

Notes

• Package is published as @nocios/frontend-types in npm for shared type consumption.
• Publish flow is manual and controlled (next -> validation -> latest).
• npm credentials must be provided via NPM_TOKEN environment variable only.
• A source-to-canonical mapping matrix lives in docs/source-to-canonical-matrix.md.
• v1 intentionally excludes legacy aliases and consumer migration work.