@funmary/client 0.0.0-stage → 1.0.1

package/dist/index.js

@@ -0,0 +1,139 @@
+import { createFetch, ofetch } from "ofetch";
+//#region src/index.ts
+/** サーバーが誤りを返したときと、通信できなかったときの例外。トークンは含めない */
+var FunmaryApiError = class extends Error {
+	/** HTTP の状態。通信できなかったときは 0 */
+	status;
+	/** サーバーが返した誤りの種類 (not_found、invalid_request、terms_not_accepted など)。通信の失敗は network_error */
+	code;
+	/** サーバーが返した本文。JSON でなければ undefined */
+	body;
+	constructor(init) {
+		super(init.message);
+		this.name = "FunmaryApiError";
+		this.status = init.status;
+		this.code = init.code;
+		this.body = init.body;
+	}
+};
+const DEFAULT_TIMEOUT_MS = 15e3;
+const DEFAULT_MAX_RETRIES = 2;
+const DEFAULT_RETRY_DELAY_MS = 1e3;
+/** Retry-After が長すぎても、これ以上は待たない */
+const MAX_RETRY_DELAY_MS = 6e4;
+/** Retry-After (秒、または日時) を、待つ時間 (ミリ秒) にする */
+function retryDelayMs(header, attempt, now) {
+	if (header !== null && /^\d+$/.test(header.trim())) return Math.min(Number(header) * 1e3, MAX_RETRY_DELAY_MS);
+	const date = header === null ? NaN : Date.parse(header);
+	if (!Number.isNaN(date)) return Math.min(Math.max(date - now, 0), MAX_RETRY_DELAY_MS);
+	return DEFAULT_RETRY_DELAY_MS * (attempt + 1);
+}
+const segment = (value) => encodeURIComponent(String(value));
+function createFunmaryClient(options) {
+	const timeout = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+	const maxRetries = options.maxRetries ?? DEFAULT_MAX_RETRIES;
+	const sleep = options.sleep ?? ((ms) => new Promise((done) => setTimeout(done, ms)));
+	const http = (options.fetch ? createFetch({ fetch: options.fetch }) : ofetch).create({
+		baseURL: options.baseURL,
+		headers: {
+			Authorization: `Bearer ${options.token}`,
+			Accept: "application/json"
+		}
+	});
+	async function request(method, path, extra = {}) {
+		for (let attempt = 0;; attempt += 1) {
+			let response;
+			try {
+				response = await http.raw(path, {
+					method,
+					...extra.query ? { query: extra.query } : {},
+					...extra.body === void 0 ? {} : { body: extra.body },
+					timeout,
+					retry: false,
+					ignoreResponseError: true
+				});
+			} catch (error) {
+				throw new FunmaryApiError({
+					status: 0,
+					code: "network_error",
+					message: `Funmary に接続できませんでした: ${error instanceof Error ? error.message : String(error)}`
+				});
+			}
+			if (response.status === 429 && attempt < maxRetries) {
+				await sleep(retryDelayMs(response.headers.get("retry-after"), attempt, Date.now()));
+				continue;
+			}
+			if (!response.ok) {
+				const body = response._data;
+				const record = typeof body === "object" && body !== null ? body : {};
+				throw new FunmaryApiError({
+					status: response.status,
+					code: typeof record["error"] === "string" ? record["error"] : `http_${response.status}`,
+					message: typeof record["message"] === "string" ? record["message"] : `Funmary が HTTP ${response.status} を返しました`,
+					body: typeof body === "object" ? body : void 0
+				});
+			}
+			return response._data;
+		}
+	}
+	const range = (r) => ({
+		start: r.start,
+		end: r.end
+	});
+	const course = (ref) => `/api/v1/courses/${segment(ref.year)}/${segment(ref.syllabusId)}`;
+	return {
+		/** トークンの持ち主と、許された範囲 */
+		me: () => request("GET", "/api/v1/me"),
+		/** 休講などのデータが新しいか */
+		status: () => request("GET", "/api/v1/status"),
+		lessons: (r) => request("GET", "/api/v1/lessons", { query: range(r) }),
+		nextLesson: () => request("GET", "/api/v1/lessons/next"),
+		/** 授業と、振替授業日、全学の休講日、祝日 */
+		timetable: (r) => request("GET", "/api/v1/timetable", { query: range(r) }),
+		/** 週の曜日と時限の格子。date を省くと今週 */
+		week: (query = {}) => request("GET", "/api/v1/timetable/week", { query }),
+		periods: () => request("GET", "/api/v1/periods"),
+		academicCalendar: (query = {}) => request("GET", "/api/v1/academic-calendar", { query }),
+		/** 休講、補講、教室変更 */
+		changes: (r) => request("GET", "/api/v1/changes", { query: range(r) }),
+		courses: {
+			list: () => request("GET", "/api/v1/courses"),
+			/** 履修登録する。登録済みなら、何も変えずに今の状態を返す */
+			register: (ref) => request("POST", "/api/v1/courses", { body: ref }),
+			/** 履修登録を取り消す。自分だけの曜日と時限と略称は残る */
+			unregister: (ref) => request("DELETE", course(ref)),
+			/** 自分だけに使う曜日と時限を足す (同じ曜日と時限があれば、教室を上書きする) */
+			setPersonalSlot: (ref, slot) => request("PUT", `${course(ref)}/personal-slots`, { body: slot }),
+			removePersonalSlot: (ref, slot) => request("DELETE", `${course(ref)}/personal-slots/${segment(slot.weekday)}/${segment(slot.period)}`),
+			/** 時間割に出す、自分だけの略称。空にすると、正式名称を使う */
+			setAbbreviation: (ref, abbreviation) => request("PUT", `${course(ref)}/abbreviation`, { body: { abbreviation } })
+		},
+		subjects: {
+			search: (query = {}) => request("GET", "/api/v1/subjects", { query }),
+			get: (ref) => request("GET", `/api/v1/subjects/${segment(ref.year)}/${segment(ref.syllabusId)}`),
+			sessions: (ref) => request("GET", `/api/v1/subjects/${segment(ref.year)}/${segment(ref.syllabusId)}/sessions`)
+		},
+		events: {
+			list: (r) => request("GET", "/api/v1/events", { query: range(r) }),
+			get: (id) => request("GET", `/api/v1/events/${segment(id)}`),
+			create: (body) => request("POST", "/api/v1/events", { body }),
+			/** 送った内容に置き換える (送らなかった項目は、空になる) */
+			replace: (id, body) => request("PUT", `/api/v1/events/${segment(id)}`, { body }),
+			delete: (id) => request("DELETE", `/api/v1/events/${segment(id)}`)
+		},
+		notifications: {
+			list: (query = {}) => request("GET", "/api/v1/notifications", { query }),
+			markRead: (id) => request("POST", `/api/v1/notifications/${segment(id)}/read`),
+			markAllRead: () => request("POST", "/api/v1/notifications/read")
+		},
+		bus: {
+			stops: () => request("GET", "/api/v1/bus/stops"),
+			stop: (stopId, query = {}) => request("GET", `/api/v1/bus/stops/${segment(stopId)}`, { query }),
+			next: (query = {}) => request("GET", "/api/v1/bus/next", { query }),
+			/** 「A から未来大へ」「未来大から A へ」の発車。A は、未来大を通る任意のバス停 */
+			legs: (query) => request("GET", "/api/v1/bus/legs", { query })
+		}
+	};
+}
+//#endregion
+export { FunmaryApiError, createFunmaryClient };

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@funmary/client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.1",
+  "description": "Funmary の公開 API の型付きクライアント",
+  "license": "(BSD-3-Clause OR Apache-2.0)",
+  "author": "funmary (https://github.com/funmary-app)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/funmary-app/funmary.git",
+    "directory": "packages/public/client"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "ofetch": "^1.5.1"
+  },
+  "devDependencies": {
+    "tsdown": "^0.23.0"
+  },
+  "gitHead": "34673f7181da7961d29934dd0bfb18f091c45ba7",
+  "scripts": {
+    "build": "tsdown"
+  }
 }