@orlikfy/api-interfaces

TypeScript interfaces generated from the Orlikfy backend OpenAPI specification.

Changelog

v6.1.20 - hosted game details: teamId field v6.1.19 - user moderation flags (verified/highlighted/banned) + hosted game team reassignment v6.1.18 - removal & leave reasons: host removal reason on kick + "Other" free text; host read-back on hosted game view v6.1.17 - hosted game: per-game complements list + multi-card penalties list (deprecated single penalty) v6.1.16 - player leaves reason v6.1.15 - admin: get 100 latest contact messages v6.1.14 - game moderator v6.1.13 - penalty and comment revoking v6.1.12 - add GET /my-games endpoint v6.1.11 - private games on map - added query param v6.1.10 - notification preferences, optional price in alerts

Publishing New Version

1. Generate Latest OpenAPI Spec

Run the server locally to ensure the latest openapi.yaml is generated:

cd server
OPENAPI_GEN_ONLY=true npm run start:dev

Note: This step will be automated in the future.

2. Generate TypeScript Interfaces

From the server/ directory:

npm run api:generate

This generates TypeScript types from openapi.yaml into npm-api-interfaces/src/api.ts.

3. Build

From the npm-api-interfaces/ directory:

npm run build

4. Update Version

Update the version in package.json:

npm version patch  # or minor/major

5. Update changelog

In the readme.

6. Publish

npm publish