@profcomff/api-uilib 2024.7.2-5.1

package/.github/workflows/autogen.yaml

@@ -0,0 +1,3 @@
+# Каждые 24 часа запускать кодогенерацию
+# Если есть изменения в репозитории – создавать пулл реквест
+# Если уже существует пулл реквест на обновление версии, закрыть его

package/.github/workflows/publish.yaml

@@ -0,0 +1,27 @@
+name: Publish package to npm
+
+on:
+  push:
+    branches: ["main"]
+
+jobs:
+  publish-npm:
+    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 publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Профком студентов физфака МГУ
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,29 @@
+# Схемы и клиент для взаимодействия с API Твой ФФ
+
+Представляет интерфейс для совершения запросов к API по адресу <https://api.profcomff.com>.
+
+
+[<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)
+
+## Использование
+
+```ts
+import { createClient } from '@profcomff/api-uilib';
+
+// 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/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@profcomff/api-uilib",
+  "version": "2024.07.25.1",
+  "description": "API wrappers, autogenerated from openapi.json files",
+  "main": "./src/index.ts",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "keywords": [],
+  "author": "Roman Dyakov <roman@dyakov.space>",
+  "license": "BSD 3-Clause",
+  "devDependencies": {
+    "openapi-typescript": "^7.1.0",
+    "typescript": "^5.5.4"
+  },
+  "dependencies": {
+    "openapi-fetch": "^0.10.2"
+  },
+  "scripts": {
+    "generate": "openapi-typescript -c --alphabetize --path-params-as-types"
+  }
+}

package/redocly.yaml

@@ -0,0 +1,44 @@
+resolve:
+  http:
+    headers:
+      - matches: https://api.profcomff.com/**
+        name: Authorization
+        envVariable: SECRET_KEY
+
+apis:
+  auth@latest:
+    root: https://api.profcomff.com/auth/openapi.json
+    x-openapi-ts:
+      output: ./src/openapi/auth.ts
+  marketing@latest:
+    root: https://api.profcomff.com/marketing/openapi.json
+    x-openapi-ts:
+      output: ./src/openapi/marketing.ts
+  timetable@latest:
+    root: https://api.profcomff.com/timetable/openapi.json
+    x-openapi-ts:
+      output: ./src/openapi/timetable.ts
+  services@latest:
+    root: https://api.profcomff.com/services/openapi.json
+    x-openapi-ts:
+      output: ./src/openapi/services.ts
+  print@latest:
+    root: https://api.profcomff.com/print/openapi.json
+    x-openapi-ts:
+      output: ./src/openapi/print.ts
+  social@latest:
+    root: https://api.profcomff.com/social/openapi.json
+    x-openapi-ts:
+      output: ./src/openapi/social.ts
+  userdata@latest:
+    root: https://api.profcomff.com/userdata/openapi.json
+    x-openapi-ts:
+      output: ./src/openapi/userdata.ts
+  achievement@latest:
+    root: https://api.profcomff.com/achievement/openapi.json
+    x-openapi-ts:
+      output: ./src/openapi/achievement.ts
+  pinger@latest:
+    root: https://pinger.profcomff.com/openapi.json
+    x-openapi-ts:
+      output: ./src/openapi/pinger.ts

package/src/index.d.ts

@@ -0,0 +1,24 @@
+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>;
+export function setupAuth(newToken: string | null): void;

package/src/index.ts

@@ -0,0 +1,59 @@
+import Client from "openapi-fetch";
+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";
+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 &
+    timetablePaths &
+    userdataPaths
+);
+
+const authMiddleware: Middleware = {
+    async onRequest({ request, options }) {
+        request.headers.set("Authorization", currentToken);
+        return request;
+    },
+};
+
+export const createClient = (baseUrl: string) => {
+    if (currentClient) {
+        throw new Error("Client already initialized");
+    }
+
+    currentClient = Client<paths>({ baseUrl })
+    if (currentToken !== null) {
+        currentClient.use(authMiddleware);
+    }
+    return currentClient;
+}
+
+export const setupAuth = (newToken: string | null) => {
+    currentToken = newToken;
+    if (currentClient !== undefined) {
+        if (newToken === null) {
+            currentClient.eject(authMiddleware)
+        } else {
+            currentClient.use(authMiddleware);
+        }
+    }
+}
+