@ofidj/contracts
v3.6.23
Published
TypeScript API contracts for Fidj services - request/response interfaces for REST endpoints
Maintainers
Readme
@ofidj/contracts
TypeScript API contracts for Fidj services — request/response interfaces for REST endpoints (API v3).
Renamed from
fidj-api-contractsat 1.0.0. The HTTP contract version (/v3) is unchanged and independent from this package's semver.
Structure
src/fidj-api/ # Fidj API endpoint contracts (auth, users, consents, apps, contracts, tokens)Naming Convention
Fidj{Service}{Resource}{Action}{Type}
- Service: Api
- Resource: Users, Apps, Consents, Contracts, Tokens, OAuth
- Action: Create, Update, FindOne, etc.
- Type: Request, Response
Usage
import {FidjApiUsersCreateRequest, FidjApiConsentsResponse} from '@ofidj/contracts';Commands
npm run build # Compile TypeScript
npm run bp:style:fix # Lint + format
npm run bp:bump # Version bump + git tag