@ccw-api/api 0.1.0 → 0.3.0

package/dist/node/sso/web/auth/auth.test.js

@@ -1,65 +1,17 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var login_by_password_1 = require("./login-by-password");
-var logout_1 = require("./logout");
-test("expect password to be error", function () { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, expect(function () {
-                    return (0, login_by_password_1.loginByPassword)("abc", "foo", {
-                        device: "test",
-                        browser: "test",
-                    });
-                }).rejects.toThrow("ccw axios Request failed: 账号或密码错误(4001092401)")];
-            case 1:
-                _a.sent();
-                return [2 /*return*/];
-        }
-    });
-}); });
-test("expect logout to be error when no token", function () { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, expect(logout_1.logout).rejects.toThrow("ccw axios Request failed: token不能为空(4001092X01)")];
-            case 1:
-                _a.sent();
-                return [2 /*return*/];
-        }
-    });
-}); });
+const login_by_password_1 = require("./login-by-password");
+const logout_1 = require("./logout");
+const logout_by_session_1 = require("./logout_by_session");
+test("expect wrong password to be error", async () => {
+    await expect(async () => await (0, login_by_password_1.loginByPassword)("abc", "foo", {
+        device: "test",
+        browser: "test",
+    })).rejects.toThrow("ccw axios Request failed: 账号或密码错误(4001092401)");
+});
+test("expect logout to be error when no token", async () => {
+    await expect(logout_1.logout).rejects.toThrow("ccw axios Request failed: token不能为空(4001092X01)");
+});
+test("expect logout-by-session to be error when not logged in", async () => {
+    await expect(async () => await (0, logout_by_session_1.logoutBySession)(1145)).rejects.toThrow("ccw axios Request failed: 用户未登录(4001092401)");
+});

package/dist/node/sso/web/auth/login-by-password.js

@@ -1,88 +1,31 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.url = void 0;
 exports.loginByPassword = loginByPassword;
-var axios_1 = require("@ccw-api/axios");
+const axios_1 = require("@ccw-api/axios");
 exports.url = "https://sso.ccw.site/web/auth/login-by-password";
-function loginByPassword(loginKey_1, password_1) {
-    return __awaiter(this, arguments, void 0, function (loginKey, password, reqExtra) {
-        var _a, _extra, rest;
-        if (reqExtra === void 0) { reqExtra = {
-            device: "Node",
-            browser: "Node.js",
-        }; }
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0: return [4 /*yield*/, axios_1.ccwAxios
-                        .post(exports.url, {
-                        loginKey: loginKey,
-                        password: password,
-                        clientCode: "STUDY_COMMUNITY",
-                        extra: JSON.stringify(__assign(__assign({}, reqExtra), { scene: null })),
-                    })
-                        .then(function (res) { return res.data.body; })];
-                case 1:
-                    _a = _b.sent(), _extra = _a.extra, rest = __rest(_a, ["extra"]);
-                    return [2 /*return*/, __assign(__assign({}, rest), { extra: JSON.parse(_extra) })];
-            }
-        });
-    });
+/**
+ * 通过密码登录
+ * @param {string} loginKey 用户名
+ * @param {string} password 密码
+ * @param {ReqExtra} reqExtra 额外信息
+ * @returns {Res<Extra>}
+ */
+async function loginByPassword(loginKey, password, reqExtra = {
+    device: "Node",
+    browser: "Node.js",
+}) {
+    const { extra, ...restBody } = await axios_1.ccwAxios
+        .post(exports.url, {
+        loginKey,
+        password,
+        clientCode: "STUDY_COMMUNITY",
+        extra: JSON.stringify({ ...reqExtra, scene: null }),
+    })
+        .then((res) => res.data.body);
+    const resExtra = JSON.parse(extra);
+    return {
+        ...restBody,
+        extra: resExtra,
+    };
 }

package/dist/node/sso/web/auth/logout.js

@@ -1,54 +1,15 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.url = void 0;
 exports.logout = logout;
-var axios_1 = require("@ccw-api/axios");
+const axios_1 = require("@ccw-api/axios");
 exports.url = "https://sso.ccw.site/web/auth/logout";
-function logout() {
-    return __awaiter(this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, axios_1.ccwAxios
-                        .post(exports.url, {})
-                        .then(function (res) { return res.data; })];
-                case 1: return [2 /*return*/, _a.sent()];
-            }
-        });
-    });
+/**
+ * 退出
+ * @returns {Promise<null>}
+ */
+async function logout() {
+    return await axios_1.ccwAxios
+        .post(exports.url, {})
+        .then((res) => res.data.body);
 }

package/dist/node/sso/web/auth/logout_by_session.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.url = void 0;
+exports.logoutBySession = logoutBySession;
+const axios_1 = require("@ccw-api/axios");
+exports.url = "https://sso.ccw.site/web/auth/logout_by_session";
+/**
+ * 根据sessionId退出登陆设备
+ * @param {number} sessionId
+ * @returns {Promise<boolean>} 是否成功
+ */
+async function logoutBySession(sessionId) {
+    return await axios_1.ccwAxios
+        .post(exports.url, { id: sessionId })
+        .then((res) => res.data.body);
+}

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@ccw-api/api",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "ccw api collections",
   "license": "MIT",
   "author": "Meng Fuzi",
+  "homepage": "https://schale.qzz.io/ccw-api-api/",
   "type": "module",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",
@@ -18,6 +19,9 @@
   "scripts": {
     "prepublishOnly": "npm run build && npm test",
     "test": "jest",
+    "test:dev": "jest --watch",
+    "doc": "typedoc",
+    "doc:dev": "typedoc --watch",
     "build": "tsc --project tsconfig.node.json && tsc --project tsconfig.esm.json && tsc --project tsconfig.types.json"
   },
   "dependencies": {
@@ -27,6 +31,7 @@
     "@types/jest": "^30.0.0",
     "@types/node": "^26.0.1",
     "jest": "^30.4.2",
-    "ts-jest": "^29.1.2"
+    "ts-jest": "^29.4.11",
+    "typedoc": "^0.28.19"
   }
 }

package/tsconfig.json

@@ -1,12 +1,14 @@
 {
   "compilerOptions": {
     "declaration": true,
-    "rootDir": "src",
+    "rootDir": ".",
     "outDir": "dist",
     "types": ["jest", "node"],
     "esModuleInterop": true,
     "module": "esnext",
-    "moduleResolution": "bundler"
+    "moduleResolution": "bundler",
+    "target": "esnext",
+    "baseUrl": "."
   },
-  "include": ["src"]
+  "include": ["src", "types"]
 }

package/dist/esm/types.js

@@ -1 +0,0 @@
-export {};

package/dist/node/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -1,10 +0,0 @@
-import { sso } from "./sso/index";
-export type * from "./types";
-export { sso };
-declare const _default: {
-    sso: {
-        loginByPassword: typeof import("./sso/web/auth/login-by-password").loginByPassword;
-        logout: typeof import("./sso/web/auth/logout").logout;
-    };
-};
-export default _default;

package/dist/types/sso/index.d.ts

@@ -1,6 +0,0 @@
-import { loginByPassword } from "./web/auth/login-by-password";
-import { logout } from "./web/auth/logout";
-export declare const sso: {
-    loginByPassword: typeof loginByPassword;
-    logout: typeof logout;
-};

package/dist/types/sso/web/auth/login-by-password.d.ts

@@ -1,38 +0,0 @@
-import { ApiResponse, MongoDBId } from "../../../types";
-export declare const url = "https://sso.ccw.site/web/auth/login-by-password";
-export type Req = {
-    loginKey: string;
-    clientCode: "STUDY_COMMUNITY";
-    password: string;
-    extra: string;
-};
-export type Res<Extra = string> = ApiResponse<{
-    accountId: -1;
-    accountObjectId: MongoDBId;
-    accountType: "STUDENT";
-    clientCode: "STUDY_COMMUNITY";
-    createdAt: number;
-    email: null;
-    expireTime: number;
-    extra: Extra;
-    id: number;
-    lastAccessTime: number;
-    orgId: "";
-    scene: null;
-    status: "ENABLED";
-    token: string;
-    urlEncodedFullName: null;
-}>;
-type Extra = {
-    loginType: "BY_PASSWORD";
-    browser: string;
-    ip: string;
-    loginParentOid: MongoDBId;
-    device: string;
-    orgId: "";
-};
-export declare function loginByPassword(loginKey: string, password: string, reqExtra?: {
-    device: string;
-    browser: string;
-}): Promise<Res<Extra>["body"]>;
-export {};

package/dist/types/sso/web/auth/logout.d.ts

@@ -1,3 +0,0 @@
-import { ApiResponse } from "../../../types";
-export declare const url = "https://sso.ccw.site/web/auth/logout";
-export declare function logout(): Promise<ApiResponse<null>>;

package/dist/types/types.d.ts

@@ -1,17 +0,0 @@
-/**
- * 十六进制秒级时间戳
- * @example const date = new Date(Number.parseInt(t, 16) * 1000);
- */
-export type HexSecTimeStamp = string;
-/**
- * @example
- * const t = id.subString(0,8);
- * const date = new Date(Number.parseInt(t, 16) * 1000);
- */
-export type MongoDBId = `${HexSecTimeStamp}${string}`;
-export type ApiResponse<T> = {
-    body: T;
-    code: string;
-    msg: string;
-    status: number;
-};

package/jest.config.ts

@@ -1,13 +0,0 @@
-import type { Config } from "jest";
-const config: Config = {
-  preset: "ts-jest",
-  testEnvironment: "node",
-  moduleFileExtensions: ["ts", "js", "json"],
-  collectCoverageFrom: [
-    "src/**/*.ts",
-    "!src/**/*.d.ts", // 排除类型声明文件
-  ],
-  testMatch: ["**/src/**/*.test.ts"],
-  transformIgnorePatterns: [],
-};
-export default config;

package/src/index.ts

@@ -1,8 +0,0 @@
-import { sso } from "./sso/index";
-export type * from "./types";
-
-export { sso };
-
-export default {
-  sso,
-};

package/src/sso/index.ts

@@ -1,7 +0,0 @@
-import { loginByPassword } from "./web/auth/login-by-password";
-import { logout } from "./web/auth/logout";
-
-export const sso = {
-  loginByPassword,
-  logout,
-};

package/src/sso/web/auth/auth.test.ts

@@ -1,16 +0,0 @@
-import { loginByPassword } from "./login-by-password";
-import { logout } from "./logout";
-test("expect password to be error", async () => {
-  await expect(() =>
-    loginByPassword("abc", "foo", {
-      device: "test",
-      browser: "test",
-    }),
-  ).rejects.toThrow("ccw axios Request failed: 账号或密码错误(4001092401)");
-});
-
-test("expect logout to be error when no token", async () => {
-  await expect(logout).rejects.toThrow(
-    "ccw axios Request failed: token不能为空(4001092X01)",
-  );
-});

package/src/sso/web/auth/login-by-password.ts

@@ -1,58 +0,0 @@
-import { ccwAxios } from "@ccw-api/axios";
-import { ApiResponse, MongoDBId } from "../../../types";
-export const url = "https://sso.ccw.site/web/auth/login-by-password";
-
-export type Req = {
-  loginKey: string;
-  clientCode: "STUDY_COMMUNITY";
-  password: string;
-  extra: string;
-};
-export type Res<Extra = string> = ApiResponse<{
-  accountId: -1;
-  accountObjectId: MongoDBId;
-  accountType: "STUDENT";
-  clientCode: "STUDY_COMMUNITY";
-  createdAt: number;
-  email: null;
-  expireTime: number;
-  extra: Extra;
-  id: number;
-  lastAccessTime: number;
-  orgId: "";
-  scene: null;
-  status: "ENABLED";
-  token: string;
-  urlEncodedFullName: null;
-}>;
-
-type Extra = {
-  loginType: "BY_PASSWORD";
-  browser: string;
-  ip: string;
-  loginParentOid: MongoDBId;
-  device: string;
-  orgId: "";
-};
-
-export async function loginByPassword(
-  loginKey: string,
-  password: string,
-  reqExtra: { device: string; browser: string } = {
-    device: "Node",
-    browser: "Node.js",
-  },
-): Promise<Res<Extra>["body"]> {
-  const { extra: _extra, ...rest } = await ccwAxios
-    .post<Res>(url, {
-      loginKey,
-      password,
-      clientCode: "STUDY_COMMUNITY",
-      extra: JSON.stringify({ ...reqExtra, scene: null }),
-    } satisfies Req)
-    .then((res) => res.data.body);
-  return {
-    ...rest,
-    extra: JSON.parse(_extra),
-  };
-}

package/src/sso/web/auth/logout.ts

@@ -1,9 +0,0 @@
-import { ccwAxios } from "@ccw-api/axios";
-import { ApiResponse } from "../../../types";
-export const url = "https://sso.ccw.site/web/auth/logout";
-
-export async function logout() {
-  return await ccwAxios
-    .post<ApiResponse<null>>(url, {})
-    .then((res) => res.data);
-}

package/src/types.ts

@@ -1,18 +0,0 @@
-/**
- * 十六进制秒级时间戳
- * @example const date = new Date(Number.parseInt(t, 16) * 1000);
- */
-export type HexSecTimeStamp = string;
-/**
- * @example
- * const t = id.subString(0,8);
- * const date = new Date(Number.parseInt(t, 16) * 1000);
- */
-export type MongoDBId = `${HexSecTimeStamp}${string}`;
-
-export type ApiResponse<T> = {
-  body: T;
-  code: string;
-  msg: string;
-  status: number;
-};