@profcomff/api-uilib 2024.7.25 → 2024.7.27

package/.github/workflows/autogen.yaml

@@ -1,3 +1,40 @@
 # Каждые 24 часа запускать кодогенерацию
 # Если есть изменения в репозитории – создавать пулл реквест
 # Если уже существует пулл реквест на обновление версии, закрыть его
+name: Autogen API bindings
+
+on:
+  schedule:
+    - cron: "30 00 * * *"
+
+jobs:
+  generate:
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 9.6.0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+          cache: pnpm
+
+      - run: pnpm install
+
+      - run: pnpm generate
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message:
+          branch: autogen
+          title: Automated API update
+          body: |
+            Автоматика заметила изменения в API, которые нужно прокинуть на фронтенд
+
+            Проверь кодогенерацию, если все ок – вмержи изменения
+          commit-message: API codegen update

package/README.md

@@ -8,11 +8,22 @@
 ## Использование
 
 ```ts
-import { client } from @profcomff/api-uilib;
+import { createClient } from '@profcomff/api-uilib';
 
-const me = await client.GET('/auth/me', {
-  params: {
-    info: ["groups", "indirect_groups", "session_scopes", "user_scopes", "auth_methods"],
-  },
+// Setup client with base API path
+// You can use environment `import.meta.env.VITE_API_URL` for example
+const apiClient = createClient("https://api.test.profcomff.com");
+
+// Setup token for requests to API
+// It is optional, only for routes with authention
+setupAuth("myApiTokenHere");
+
+// Make request
+const me_with_scopes = await apiClient.GET("/auth/me", {
+    params: {
+        query: {
+            info: ["session_scopes"]
+        }
+    }
 });
 ```

package/generate.js

@@ -0,0 +1,91 @@
+const fs = require("node:fs");
+const openapiTS = require("openapi-typescript").default;
+const astToString = require("openapi-typescript").astToString;
+const simpleGit = require("simple-git");
+const PackageJson = require("@npmcli/package-json");
+
+const apis = {
+  auth: "https://api.profcomff.com/auth/openapi.json",
+  marketing: "https://api.profcomff.com/marketing/openapi.json",
+  timetable: "https://api.profcomff.com/timetable/openapi.json",
+  services: "https://api.profcomff.com/services/openapi.json",
+  print: "https://api.profcomff.com/print/openapi.json",
+  social: "https://api.profcomff.com/social/openapi.json",
+  userdata: "https://api.profcomff.com/userdata/openapi.json",
+  achievement: "https://api.profcomff.com/achievement/openapi.json",
+};
+
+const header = `/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */`.trim();
+
+/**
+ * Добавляет к путям префикс, соответствующий пути к корню API
+ */
+const updatePathsWithPrefix = (prefix, ast) => {
+  for (const i in ast) {
+    for (const j in ast[i]["members"]) {
+      if (ast[i]["members"][j]["name"]) {
+        if (ast[i]["members"][j]["name"]["text"].startsWith("/")) {
+          ast[i]["members"][j]["name"]["text"] =
+            prefix + ast[i]["members"][j]["name"]["text"];
+        }
+      }
+    }
+  }
+};
+
+/**
+ * Генерирует список путей и интерфейсов
+ */
+const generate = async () => {
+  for (const file in apis) {
+    const spec = apis[file];
+    const prefix = "/" + file;
+    console.log(`Generating ${file} from ${spec}`);
+
+    const ast = await openapiTS(spec, {
+      alphabetize: true,
+      excludeDeprecated: true,
+    });
+
+    updatePathsWithPrefix(prefix, ast);
+
+    const contents = astToString(ast);
+
+    fs.writeFileSync(`./src/openapi/${file}.ts`, header + "\n\n" + contents);
+  }
+};
+
+/**
+ * Проверяет есть ли изменения в репозитории, меняет версию в package-json если да
+ */
+const updateRepo = async () => {
+  const git = simpleGit();
+  const date = new Date();
+
+  // Ensure status
+  let status = await git.status();
+  if (Object.keys(status.modified).length === 0) {
+    console.log("Nothing changed");
+    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(() => {
+  updateRepo().then(() => {
+    console.log("Completed");
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@profcomff/api-uilib",
-  "version": "2024.07.25",
+  "version": "2024.7.27",
   "description": "API wrappers, autogenerated from openapi.json files",
   "main": "./src/index.ts",
   "types": "./src/index.d.ts",
@@ -11,13 +11,15 @@
   "author": "Roman Dyakov <roman@dyakov.space>",
   "license": "BSD 3-Clause",
   "devDependencies": {
+    "@npmcli/package-json": "^5.2.0",
     "openapi-typescript": "^7.1.0",
+    "simple-git": "^3.25.0",
     "typescript": "^5.5.4"
   },
   "dependencies": {
     "openapi-fetch": "^0.10.2"
   },
   "scripts": {
-    "generate": "openapi-typescript -c --alphabetize --path-params-as-types"
+    "generate": "node ./generate.js"
   }
 }

package/src/index.d.ts

@@ -20,5 +20,5 @@ export type paths = (
     timetablePaths &
     userdataPaths
 );
-export function createClient(baseUrl: string): ReturnType<typeof Client>;
+export function createClient(baseUrl: string): ReturnType<typeof Client<paths>>;
 export function setupAuth(newToken: string | null): void;

package/src/openapi/achievement.ts

@@ -4,7 +4,7 @@
  */
 
 export interface paths {
-    "/achievement": {
+    "/achievement/achievement": {
         parameters: {
             query?: never;
             header?: never;
@@ -25,7 +25,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    [path: `/achievement/${integer}/reciever`]: {
+    "/achievement/achievement/{achievement_id}/reciever": {
         parameters: {
             query?: never;
             header?: never;
@@ -42,7 +42,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    [path: `/achievement/${integer}/reciever/${integer}`]: {
+    "/achievement/achievement/{achievement_id}/reciever/{user_id}": {
         parameters: {
             query?: never;
             header?: never;
@@ -66,7 +66,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    [path: `/achievement/${integer}`]: {
+    "/achievement/achievement/{id}": {
         parameters: {
             query?: never;
             header?: never;
@@ -77,7 +77,11 @@ export interface paths {
         get: operations["get_achievement_achievement__id__get"];
         put?: never;
         post?: never;
-        delete?: never;
+        /**
+         * Delete Achievement
+         * @description Нужны права на: `achievements.achievement.delete`
+         */
+        delete: operations["delete_achievement_achievement__id__delete"];
         options?: never;
         head?: never;
         /**
@@ -87,7 +91,7 @@ export interface paths {
         patch: operations["edit_achievement_achievement__id__patch"];
         trace?: never;
     };
-    [path: `/achievement/${integer}/picture`]: {
+    "/achievement/achievement/{id}/picture": {
         parameters: {
             query?: never;
             header?: never;
@@ -104,7 +108,7 @@ export interface paths {
         patch: operations["upload_picture_achievement__id__picture_patch"];
         trace?: never;
     };
-    [path: `/user/${integer}`]: {
+    "/achievement/user/{user_id}": {
         parameters: {
             query?: never;
             header?: never;
@@ -198,6 +202,15 @@ export interface components {
             /** User Id */
             user_id: number;
         };
+        /** StatusResponseModel */
+        StatusResponseModel: {
+            /** Message */
+            message: string;
+            /** Ru */
+            ru: string;
+            /** Status */
+            status: string;
+        };
         /** UserGet */
         UserGet: {
             /** Achievement */
@@ -402,6 +415,37 @@ export interface operations {
             };
         };
     };
+    delete_achievement_achievement__id__delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StatusResponseModel"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     edit_achievement_achievement__id__patch: {
         parameters: {
             query?: never;