@orlikfy/api-interfaces 2.0.0 → 4.1.0

package/README.md

@@ -0,0 +1,48 @@
+# @orlikfy/api-interfaces
+
+TypeScript interfaces generated from the Orlikfy backend OpenAPI specification.
+
+## Publishing New Version
+
+### 1. Generate Latest OpenAPI Spec
+
+Run the server locally to ensure the latest `openapi.yaml` is generated:
+
+```bash
+cd server
+npm run start:dev
+```
+
+> Note: This step will be automated in the future.
+
+### 2. Generate TypeScript Interfaces
+
+From the `server/` directory:
+
+```bash
+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:
+
+```bash
+npm run build
+```
+
+### 4. Update Version
+
+Update the version in `package.json`:
+
+```bash
+npm version patch  # or minor/major
+```
+
+### 5. Publish
+
+```bash
+npm publish
+```

package/dist/api.d.ts

@@ -759,6 +759,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/admin/users/stats": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** getUsersStatsForAdmin */
+        get: operations["getUsersStats"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/admin/games": {
         parameters: {
             query?: never;
@@ -2036,10 +2053,6 @@ export interface components {
             role: string;
             thumbnail: string | null;
             thumbnailUrl: string | null;
-            /** @description Is user marked manually as a host */
-            isHost: boolean;
-            /** @description Is user marked manually as a paid host */
-            isPaidHost: boolean;
             playerPreferences: components["schemas"]["PlayerPreferences"];
             hostRating: string | null;
             hostRatingCount: number;
@@ -2816,11 +2829,6 @@ export interface components {
             playedGames: number;
             gameApplications: number;
         };
-        ReferralDto: {
-            referralId: string | null;
-            displayName: string | null;
-            email: string | null;
-        };
         AdminUserDto: {
             userId: string;
             name: string;
@@ -2833,16 +2841,29 @@ export interface components {
             versionInfo: string | null;
             platform: string | null;
             stats: components["schemas"]["AdminUserStatsDto"];
-            /** @description Is user marked manually as a host */
-            isHost: boolean;
-            /** @description Is user marked manually as a paid host */
-            isPaidHost: boolean;
-            referral: components["schemas"]["ReferralDto"] | null;
-            referralToken: string;
         };
         GetAdminUsersDto: {
             users: components["schemas"]["AdminUserDto"][];
         };
+        PlatformStatsDto: {
+            platform: string;
+            count: number;
+        };
+        VersionStatsDto: {
+            version: string;
+            count: number;
+        };
+        PlatformVersionStatsDto: {
+            platform: string;
+            version: string;
+            count: number;
+        };
+        GetAdminUsersStatsDto: {
+            totalUsers: number;
+            platformStats: components["schemas"]["PlatformStatsDto"][];
+            versionStats: components["schemas"]["VersionStatsDto"][];
+            platformVersionStats: components["schemas"]["PlatformVersionStatsDto"][];
+        };
         AdminGamePlayerDto: {
             playerId: string;
             gamePlayerId: string;
@@ -3295,9 +3316,12 @@ export type Payload = components['schemas']['Payload'];
 export type CreateShortLinkDto = components['schemas']['CreateShortLinkDto'];
 export type ShortLinkDto = components['schemas']['ShortLinkDto'];
 export type AdminUserStatsDto = components['schemas']['AdminUserStatsDto'];
-export type ReferralDto = components['schemas']['ReferralDto'];
 export type AdminUserDto = components['schemas']['AdminUserDto'];
 export type GetAdminUsersDto = components['schemas']['GetAdminUsersDto'];
+export type PlatformStatsDto = components['schemas']['PlatformStatsDto'];
+export type VersionStatsDto = components['schemas']['VersionStatsDto'];
+export type PlatformVersionStatsDto = components['schemas']['PlatformVersionStatsDto'];
+export type GetAdminUsersStatsDto = components['schemas']['GetAdminUsersStatsDto'];
 export type AdminGamePlayerDto = components['schemas']['AdminGamePlayerDto'];
 export type AdminGameDto = components['schemas']['AdminGameDto'];
 export type AdminGamesDto = components['schemas']['AdminGamesDto'];
@@ -5240,7 +5264,10 @@ export interface operations {
     };
     getUsers: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Search term to filter users by name, surname, email, userId, or phone number */
+                search?: string;
+            };
             header?: {
                 /** @description Request trace id for logs */
                 "x-trace-request-id"?: string;
@@ -5273,6 +5300,41 @@ export interface operations {
             };
         };
     };
+    getUsersStats: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Request trace id for logs */
+                "x-trace-request-id"?: string;
+                /** @description Session trace id for logs */
+                "x-trace-session-id"?: string;
+                /** @description IANA Timezone */
+                "x-timezone"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetAdminUsersStatsDto"];
+                };
+            };
+            /** @description Application Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     getGames: {
         parameters: {
             query?: {
@@ -7218,13 +7280,11 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            200: {
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content: {
-                    "application/json": components["schemas"]["CreateReassignTokenResponseDto"];
-                };
+                content?: never;
             };
             /** @description Application Error */
             500: {
@@ -7578,6 +7638,7 @@ export declare enum ApiPaths {
     createShortLink = "/short-link",
     createRecurringGame = "/recurring-games",
     getUsers = "/admin/users",
+    getUsersStats = "/admin/users/stats",
     getGames = "/admin/games",
     getGamesForPost = "/admin/games-for-post",
     getKnownCitiesForPost = "/admin/known-cities",

package/dist/api.js

@@ -314,6 +314,7 @@ var ApiPaths;
     ApiPaths["createShortLink"] = "/short-link";
     ApiPaths["createRecurringGame"] = "/recurring-games";
     ApiPaths["getUsers"] = "/admin/users";
+    ApiPaths["getUsersStats"] = "/admin/users/stats";
     ApiPaths["getGames"] = "/admin/games";
     ApiPaths["getGamesForPost"] = "/admin/games-for-post";
     ApiPaths["getKnownCitiesForPost"] = "/admin/known-cities";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orlikfy/api-interfaces",
-  "version": "2.0.0",
+  "version": "4.1.0",
   "description": "",
   "license": "ISC",
   "author": "kruligh",