@profcomff/api-uilib 2024.7.27 → 2024.9.29

package/.github/workflows/autogen.yaml

@@ -4,8 +4,7 @@
 name: Autogen API bindings
 
 on:
-  schedule:
-    - cron: "30 00 * * *"
+  workflow_dispatch:
 
 jobs:
   generate:
@@ -30,7 +29,6 @@ jobs:
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v6
         with:
-          commit-message:
           branch: autogen
           title: Automated API update
           body: |

package/.github/workflows/publish.yaml

@@ -2,7 +2,8 @@ name: Publish package to npm
 
 on:
   push:
-    branches: ["main"]
+    tags:
+      - 'v*'
 
 jobs:
   publish-npm:
@@ -22,6 +23,10 @@ jobs:
 
       - run: pnpm install
 
-      - run: pnpm publish
+      - run: |
+          VERSION=${{ github.ref_name }}
+          pnpm setVersion -v ${VERSION:1}
+
+      - run: pnpm publish --no-git-checks
         env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}

package/README.md

@@ -2,13 +2,23 @@
 
 Представляет интерфейс для совершения запросов к API по адресу <https://api.profcomff.com>.
 
+Поддерживает типы данных TypeScript и подсветку синтаксиса.
 
 [<img src="https://cdn.profcomff.com/easycode/easycode.svg" width="200"></img>](https://easycode.profcomff.com/templates/docker-node/workspace?mode=manual&param.Repository+URL=https://github.com/profcomff/api-uilib.git&param.Working+directory=api-uilib)
 
+
 ## Использование
 
+Установите библиотеку
+
+```shell
+pnpm install @profcomff/api-uilib
+```
+
+Используйте для совершения запросов к <https://api.test.profcomff.com> и <https://api.profcomff.com>.
+
 ```ts
-import { createClient } from '@profcomff/api-uilib';
+import { createClient } from "@profcomff/api-uilib";
 
 // Setup client with base API path
 // You can use environment `import.meta.env.VITE_API_URL` for example
@@ -20,10 +30,68 @@ setupAuth("myApiTokenHere");
 
 // Make request
 const me_with_scopes = await apiClient.GET("/auth/me", {
-    params: {
-        query: {
-            info: ["session_scopes"]
-        }
-    }
+  params: {
+    query: {
+      info: ["session_scopes"],
+    },
+  },
 });
 ```
+
+
+## Тестирование
+
+_На основе <https://openapi-ts.dev/openapi-fetch/testing>._
+
+```ts
+import { createTestClient } from "@profcomff/api-uilib";
+import { http, HttpResponse } from 'msw';
+import { afterEach, beforeAll, afterAll, expect, test } from 'vitest';
+import { setupServer } from 'msw/node';
+
+export const server = setupServer();
+
+beforeAll(() => {
+	server.listen({
+		onUnhandledRequest: request => {
+			throw new Error(`No request handler found for ${request.method} ${request.url}`);
+		},
+	});
+});
+
+afterEach(() => server.resetHandlers());
+afterAll(() => server.close());
+
+test('Get basic info from Auth API with hardload', async () => {
+	const baseUrl = import.meta.env.VITE_API_URL;
+
+	const rawData = {
+		id: 1,
+		email: 'hello@world.com',
+	};
+
+	server.use(http.get(`${baseUrl}/auth/user/1`, () => HttpResponse.json(rawData, { status: 200 })));
+	const testClient = createTestClient({ baseUrl });  // Клиент API должен быть инициализирован ПОСЛЕ msw сервера
+
+	const { data, error } = await testClient
+        .GET(
+            '/auth/user/{user_id}',
+            { params: { path: { user_id: this.id } },
+        });
+    expect(data).toEqual(rawData);
+    expect(error).toBeUndefined();
+});
+```
+
+
+## Разработка
+
+### Автоматическая генерация
+
+Используйте команду `pnpm generate` или [CI-пайплайн Autogen API bindings](https://github.com/profcomff/api-uilib/actions/workflows/autogen.yaml) для кодогенерации последней версии биндингов с **продового** API <https://api.profcomff.com>.
+
+CI исполняется вручную по нажатии кнопки run workflow. После завершения исполнения новая версия будет доступна для ревью в виде Pull Request с названием "Automated API update".
+
+### Релизный процесс
+
+Библиотека релизится по созданию тега вида `v*`, где вместо звездочки идет описание версии [по правилам semver](https://semver.org/lang/ru/). Менять версию в `package.json` не нужно.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@profcomff/api-uilib",
-  "version": "2024.7.27",
+  "version": "2024.09.29",
   "description": "API wrappers, autogenerated from openapi.json files",
   "main": "./src/index.ts",
   "types": "./src/index.d.ts",
@@ -14,12 +14,14 @@
     "@npmcli/package-json": "^5.2.0",
     "openapi-typescript": "^7.1.0",
     "simple-git": "^3.25.0",
-    "typescript": "^5.5.4"
+    "typescript": "^5.5.4",
+    "yargs-parser": "^21.1.1"
   },
   "dependencies": {
     "openapi-fetch": "^0.10.2"
   },
   "scripts": {
-    "generate": "node ./generate.js"
+    "setVersion": "node ./scripts/setversion.js",
+    "generate": "node ./scripts/generate.js"
   }
 }

package/{generate.js → scripts/generate.js}

@@ -63,7 +63,6 @@ const generate = async () => {
  */
 const updateRepo = async () => {
   const git = simpleGit();
-  const date = new Date();
 
   // Ensure status
   let status = await git.status();
@@ -72,16 +71,6 @@ const updateRepo = async () => {
     return;
   }
   console.log(`${Object.keys(status.modified).length} files changed`);
-
-  // Change version in package.json file
-  const pkgJson = await PackageJson.load(".");
-  pkgJson.update({
-    version: `${date.getUTCFullYear()}.${date.getUTCMonth()+1}.${date.getUTCDate()}`,
-  });
-  pkgJson.save();
-  console.log(
-    `package.json version updated to ${date.getUTCFullYear()}.${date.getUTCMonth()+1}.${date.getUTCDate()}`
-  );
 };
 
 generate().then(() => {

package/scripts/setversion.js

@@ -0,0 +1,22 @@
+const parser = require("yargs-parser");
+const PackageJson = require("@npmcli/package-json");
+
+const updateRepo = async (version) => {
+  // Change version in package.json file
+  const pkgJson = await PackageJson.load(".");
+  pkgJson.update({
+    version: version,
+  });
+  pkgJson.save();
+  console.log(`package.json version updated to ${version}`);
+};
+
+const [, , ...args] = process.argv;
+const flags = parser(args, {
+  string: ["version"],
+  alias: {
+    version: ["v"],
+  },
+});
+
+updateRepo(flags.version);

package/src/index.ts

@@ -4,7 +4,6 @@ import { Middleware } from "openapi-fetch";
 import type { paths as achievementPaths } from "./openapi/achievement.ts";
 import type { paths as authPaths } from "./openapi/auth.ts";
 import type { paths as marketingPaths } from "./openapi/marketing.ts";
-import type { paths as pingerPaths } from "./openapi/pinger.ts";
 import type { paths as printPaths } from "./openapi/print.ts";
 import type { paths as servicesPaths } from "./openapi/services.ts";
 import type { paths as socialPaths } from "./openapi/social.ts";
@@ -12,14 +11,10 @@ import type { paths as timetablePaths } from "./openapi/timetable.ts";
 import type { paths as userdataPaths } from "./openapi/userdata.ts";
 
 
-let currentClient: ReturnType<typeof Client> | undefined = undefined;
-let currentToken: string | undefined = undefined;
-
 export type paths = (
     achievementPaths &
     authPaths &
     marketingPaths &
-    pingerPaths &
     printPaths &
     servicesPaths &
     socialPaths &
@@ -27,33 +22,41 @@ export type paths = (
     userdataPaths
 );
 
+let currentClient: ReturnType<typeof Client<paths>> | undefined = undefined;
+let currentToken: string | undefined = undefined;
+
 const authMiddleware: Middleware = {
     async onRequest({ request, options }) {
-        request.headers.set("Authorization", currentToken);
+        if (currentToken) {
+            request.headers.set("Authorization", currentToken);
+        }
         return request;
     },
 };
 
-export const createClient = (baseUrl: string) => {
+export const createClient = (baseUrl: string): ReturnType<typeof Client<paths>> => {
     if (currentClient) {
         throw new Error("Client already initialized");
     }
 
     currentClient = Client<paths>({ baseUrl })
-    if (currentToken !== null) {
+    if (currentToken) {
         currentClient.use(authMiddleware);
     }
     return currentClient;
 }
 
-export const setupAuth = (newToken: string | null) => {
+export const createTestClient = (baseUrl: string): ReturnType<typeof Client<paths>> => {
+    return Client<paths>({ baseUrl });
+}
+
+export const setupAuth = (newToken: string | undefined) => {
     currentToken = newToken;
     if (currentClient !== undefined) {
-        if (newToken === null) {
+        if (!newToken) {
             currentClient.eject(authMiddleware)
         } else {
             currentClient.use(authMiddleware);
         }
     }
 }
-

package/src/openapi/services.ts

@@ -163,6 +163,12 @@ export interface components {
              * @description Иконка кнопки
              */
             icon: string;
+            /**
+             * Is Hidden
+             * @description Спрятана ли кнопка от пользователя
+             * @default false
+             */
+            is_hidden: boolean;
             /**
              * Link
              * @description Ссылка, на которую перенаправляет кнопка
@@ -175,12 +181,12 @@ export interface components {
             name: string;
             /**
              * Optional Scopes
-             * @description Каким скоупы желательны
+             * @description Какиеп скоупы желательны
              */
             optional_scopes?: string[] | null;
             /**
              * Required Scopes
-             * @description Каким скоупы нужны, чтобы кнопка была доступна
+             * @description Какие скоупы нужны, чтобы кнопка была доступна
              */
             required_scopes?: string[] | null;
             /** @description Тип открываемой ссылки (Ссылка приложения/Браузер в приложении/Браузер */
@@ -244,6 +250,11 @@ export interface components {
              * @description Иконка кнопки
              */
             icon?: string | null;
+            /**
+             * Is Hidden
+             * @description Спрятана ли кнопка от пользователя
+             */
+            is_hidden?: boolean | null;
             /**
              * Link
              * @description Ссылка, на которую перенаправляет кнопка
@@ -256,7 +267,7 @@ export interface components {
             name?: string | null;
             /**
              * Optional Scopes
-             * @description Каким скоупы желательны
+             * @description Какие скоупы желательны
              */
             optional_scopes?: string[] | null;
             /**
@@ -266,7 +277,7 @@ export interface components {
             order?: number | null;
             /**
              * Required Scopes
-             * @description Каким скоупы нужны, чтобы кнопка была доступна
+             * @description Какие скоупы нужны, чтобы кнопка была доступна
              */
             required_scopes?: string[] | null;
             /** @description Тип открываемой ссылки (Ссылка приложения/Браузер в приложении/Браузер */
@@ -276,7 +287,7 @@ export interface components {
          * ButtonView
          * @enum {string}
          */
-        ButtonView: "active" | "blocked";
+        ButtonView: "active" | "blocked" | "hidden";
         /** CategoryCreate */
         CategoryCreate: {
             /**

package/src/openapi/timetable.ts

@@ -211,11 +211,9 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get All Lecturer Comments */
-        get: operations["get_all_lecturer_comments_lecturer__lecturer_id__comment__get"];
+        get?: never;
         put?: never;
-        /** Comment Lecturer */
-        post: operations["comment_lecturer_lecturer__lecturer_id__comment__post"];
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
@@ -229,16 +227,13 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get Comment */
-        get: operations["get_comment_lecturer__lecturer_id__comment__id__get"];
+        get?: never;
         put?: never;
         post?: never;
-        /** Delete Comment */
-        delete: operations["delete_comment_lecturer__lecturer_id__comment__id__delete"];
+        delete?: never;
         options?: never;
         head?: never;
-        /** Update Comment Lecturer */
-        patch: operations["update_comment_lecturer_lecturer__lecturer_id__comment__id__patch"];
+        patch?: never;
         trace?: never;
     };
     "/timetable/lecturer/{lecturer_id}/comment/{id}/review/": {
@@ -250,8 +245,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Review Comment */
-        post: operations["review_comment_lecturer__lecturer_id__comment__id__review__post"];
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
@@ -265,8 +259,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get Unreviewed Comments */
-        get: operations["get_unreviewed_comments_lecturer__lecturer_id__comment_review__get"];
+        get?: never;
         put?: never;
         post?: never;
         delete?: never;
@@ -1587,240 +1580,6 @@ export interface operations {
             };
         };
     };
-    get_all_lecturer_comments_lecturer__lecturer_id__comment__get: {
-        parameters: {
-            query?: {
-                limit?: number;
-                offset?: number;
-            };
-            header?: never;
-            path: {
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["LecturerComments"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    comment_lecturer_lecturer__lecturer_id__comment__post: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["LecturerCommentPost"];
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    get_comment_lecturer__lecturer_id__comment__id__get: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                id: number;
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    delete_comment_lecturer__lecturer_id__comment__id__delete: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                id: number;
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": unknown;
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    update_comment_lecturer_lecturer__lecturer_id__comment__id__patch: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                id: number;
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["LecturerCommentPatch"];
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    review_comment_lecturer__lecturer_id__comment__id__review__post: {
-        parameters: {
-            query?: {
-                action?: "Approved" | "Declined";
-            };
-            header?: never;
-            path: {
-                id: number;
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    get_unreviewed_comments_lecturer__lecturer_id__comment_review__get: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"][];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
     get_lecturer_photos_lecturer__lecturer_id__photo_get: {
         parameters: {
             query?: {

package/src/index.d.ts

@@ -1,24 +0,0 @@
-import Client from "openapi-fetch";
-import type { paths as achievementPaths } from "./openapi/achievement.ts";
-import type { paths as authPaths } from "./openapi/auth.ts";
-import type { paths as marketingPaths } from "./openapi/marketing.ts";
-import type { paths as pingerPaths } from "./openapi/pinger.ts";
-import type { paths as printPaths } from "./openapi/print.ts";
-import type { paths as servicesPaths } from "./openapi/services.ts";
-import type { paths as socialPaths } from "./openapi/social.ts";
-import type { paths as timetablePaths } from "./openapi/timetable.ts";
-import type { paths as userdataPaths } from "./openapi/userdata.ts";
-
-export type paths = (
-    achievementPaths &
-    authPaths &
-    marketingPaths &
-    pingerPaths &
-    printPaths &
-    servicesPaths &
-    socialPaths &
-    timetablePaths &
-    userdataPaths
-);
-export function createClient(baseUrl: string): ReturnType<typeof Client<paths>>;
-export function setupAuth(newToken: string | null): void;