first commit

Author: wsxiaolin

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '20' 
+
+      - name: Install dependencies
+        run: npm install 
+
+      - name: Use environment variables
+        run: |
+          echo "Username: ${{ secrets.USERNAME }}"
+          echo "Password: ${{ secrets.PASSWORD }}"
+          echo "Xiaolin: ${{ secrets.XIAOLIN }}"
+          echo "Admin: ${{ secrets.ADMIN }}"
+
+      - name: Run tests
+        run: npm test 

.gitignore

@@ -0,0 +1 @@
+node_modules/

.npmignore

@@ -0,0 +1,7 @@
+node_modules/
+.git/
+docs/
+tests/
+src/
+.github/
+.gitignore

dist/api/axiosInstance.js

@@ -0,0 +1,50 @@
+"use strict";
+// @ts-nocheck
+const axios = require("axios");
+const configManager = require("./config");
+const util = require("util");
+let plrequest = axios.create({
+    baseURL: configManager.getConfig().baseURL,
+    timeout: configManager.getConfig().timeout,
+    headers: {
+        "Content-Type": "application/json",
+        Accept: "application/json",
+        "Accept-Language": "zh-CN",
+        "x-API-Version": "2411",
+    },
+});
+plrequest.interceptors.request.use(function (config) {
+    const { baseURL, timeout } = configManager.getConfig();
+    config.baseURL = baseURL;
+    config.timeout = timeout;
+    return config;
+});
+plrequest.interceptors.response.use(function (response) {
+    let config = configManager.getConfig();
+    if (response.data.Status !== 200) {
+        if (config.consoleError) {
+            const detail = {
+                header: response.config.headers.toJSON
+                    ? response.config.headers.toJSON()
+                    : response.config.headers,
+                url: configManager.getConfig().baseURL + response.config.url,
+                body: JSON.parse(response.config.data),
+            };
+            console.log("\x1b[36m%s\x1b[0m", "--------physics-lab-web-api----------");
+            console.log(util.inspect(detail, { colors: true, depth: null }));
+            console.log("\x1b[31m%s\x1b[0m", response.data);
+            console.log("\x1b[36m%s\x1b[0m", "--------physics-lab-web-api----------");
+        }
+        return response;
+    }
+    else {
+        if (config.consolelog) {
+            console.log("\x1b[32m%s\x1b[0m", response.config.url);
+        }
+        if (config.consoleResponse) {
+            console.log(response.data.Data);
+        }
+        return response;
+    }
+});
+module.exports = plrequest;

dist/api/config.js

@@ -0,0 +1,20 @@
+"use strict";
+let config = {
+    baseURL: "https://physics-api-cn.turtlesim.com",
+    timeout: 8000,
+    consolelog: true,
+    consoleResponse: false,
+    consoleError: true,
+    checkHttpsAgent: false,
+};
+// @ts-ignore
+function setConfig(newConfig) {
+    config = { ...config, ...newConfig };
+}
+function getConfig() {
+    return config;
+}
+module.exports = {
+    setConfig,
+    getConfig,
+};

dist/api/experiment/conver.js

@@ -0,0 +1,101 @@
+"use strict";
+const axios = require("axios");
+const FormData = require("form-data");
+const fs = require("fs");
+const plrequest = require("../axiosInstance");
+const getSummary = require("../projects/getSummary");
+/**
+ *
+ * @param {String} filePath
+ * @param {*} t
+ * @returns
+ */
+async function uploadFile(filePath, t) {
+    const formData = new FormData();
+    const f = fs.createReadStream(filePath);
+    formData.append("authorization", t.Authorization);
+    formData.append("policy", t.Policy);
+    formData.append("file", f, { filename: "temp.jpg" });
+    try {
+        // @ts-ignore
+        const response = await axios.post("https://v0.api.upyun.com/qphysics", formData, {
+            headers: formData.getHeaders(),
+        });
+        return response.data;
+    }
+    catch (error) {
+        console.error("上传文件失败:", error);
+    }
+}
+/**
+ * 更新作品封面
+ * @param {string} filename - 需要上传的图片路径（本地）
+ * @param {string} c - 作品分区
+ * @param {number} i - 作品ID
+ * @returns {Promise<void>} - 无返回值
+ */
+async function cover(filename, c, i) {
+    this._getSummary = getSummary.bind(this);
+    const getSummaryResponse = await this._getSummary(i, c);
+    // @ts-ignore
+    const imageIdex = getSummaryResponse.Data.Image + 1;
+    try {
+        const confirmExperimentResponse = await plrequest.post("/Contents/ConfirmExperiment", {
+            Category: c,
+            SummaryID: i,
+            Image: imageIdex,
+            Extension: ".png",
+        }, {
+            headers: {
+                "Content-Type": "application/json",
+                Accept: "application/json",
+                "Accept-Language": "zh-CN",
+                // @ts-ignore
+                "x-API-Token": this.token,
+                // @ts-ignore
+                "x-API-AuthCode": this.authCode,
+            },
+        });
+        // @ts-ignore
+        const summaryData = getSummaryResponse.Data;
+        const submitExperimentResponse = await plrequest.post("/Contents/SubmitExperiment", {
+            Request: {
+                FileSize: 0 - Math.abs(fs.statSync(filename).size),
+                Extension: ".jpg",
+            },
+            Summary: summaryData,
+        }, {
+            headers: {
+                "Content-Type": "application/json",
+                Accept: "application/json",
+                "Accept-Language": "zh-CN",
+                // @ts-ignore
+                "x-API-Token": this.token,
+                // @ts-ignore
+                "x-API-AuthCode": this.authCode,
+            },
+        });
+        await uploadFile(filename, submitExperimentResponse.data.Data.Token);
+        await plrequest.post("/Contents/ConfirmExperiment", {
+            Category: c,
+            SummaryID: i,
+            Image: imageIdex,
+            Extension: ".png",
+        }, {
+            headers: {
+                "Content-Type": "application/json",
+                Accept: "application/json",
+                "Accept-Language": "zh-CN",
+                // @ts-ignore
+                "x-API-Token": this.token,
+                // @ts-ignore
+                "x-API-AuthCode": this.authCode,
+            },
+        });
+        Promise.resolve();
+    }
+    catch (error) {
+        throw error;
+    }
+}
+module.exports = cover;

dist/api/experiment/getExperiment.js

@@ -0,0 +1,30 @@
+"use strict";
+const getSummary = require("../projects/getSummary");
+const plrequest = require("../axiosInstance");
+/**
+ * 获取实验存档
+ *
+ * @param {String} id - 作品序列号
+ * @param {String} type - Discussion 或 Experiment
+ * @returns {Promise<Object>}
+ */
+module.exports = async function getExperiment(id, type) {
+    this._getSummary = getSummary.bind(this);
+    const Summary = await this._getSummary(id, type);
+    // @ts-ignore
+    const ContentID = Summary.Data.ContentID;
+    const response = await plrequest.post("/Contents/GetExperiment", {
+        ContentID,
+    }, {
+        headers: {
+            "Content-Type": "application/json",
+            Accept: "application/json",
+            "Accept-Language": "zh-CN",
+            // @ts-ignore
+            "x-API-Token": this.token,
+            // @ts-ignore
+            "x-API-AuthCode": this.authCode,
+        },
+    });
+    return response.data;
+};

dist/api/experiment/update.js

@@ -0,0 +1,26 @@
+"use strict";
+const plrequest = require("../axiosInstance");
+/**
+ * 更新作品
+ *
+ * @param {Object} s - 更新后的summary，可使用getSummary获取
+ * @param {Object} w - workSpace
+ * @returns {Promise<Object>}
+ */
+module.exports = async function update(s, w) {
+    const response = await plrequest.post("/Contents/SubmitExperiment", {
+        Summary: s,
+        Workspace: w,
+    }, {
+        headers: {
+            "Content-Type": "application/json",
+            Accept: "application/json",
+            "Accept-Language": "zh-CN",
+            // @ts-ignore
+            "x-API-Token": this.token,
+            // @ts-ignore
+            "x-API-AuthCode": this.authCode,
+        },
+    });
+    return response.data;
+};

dist/api/index.js

@@ -0,0 +1,70 @@
+"use strict";
+const cover = require("./experiment/conver");
+const getExperiment = require("./experiment/getExperiment");
+const updateExperiment = require("./experiment/update");
+const getMessage = require("./messages/get");
+const sendMessages = require("./messages/send");
+const getDerivatives = require("./projects/getDerivatives");
+const getSummary = require("./projects/getSummary");
+const getSupporters = require("./projects/getSupporters");
+const query = require("./projects/query");
+const star = require("./projects/star");
+const getUser = require("./user/getUser");
+const getUserByComments = require("./user/getUserByCmmentID");
+const login = require("./user/login");
+/**
+ * User 类用于创建用户实例，管理用户名、密码及相关操作。
+ *
+ * 构造函数接受用户名和密码作为参数，支持从环境变量中获取默认值。
+ * 提供多个功能模块，包括消息处理、用户操作、项目管理及实验相关操作。
+ *
+ * @class User
+ * @constructor
+ * @param {string|null} username - 用户名，若为null则初始化为null，若未提供则尝试从环境变量获取。
+ * @param {string|null} password - 密码，若为null则初始化为null，若未提供则尝试从环境变量获取。
+ *
+ * @property {Object} messages - 消息相关操作，包括获取用户评论、发送消息及获取消息。
+ * @property {Object} user - 用户相关操作，包括登录及获取用户信息。
+ * @property {Object} projects - 项目管理操作，包括查询、获取总结、获取详细信息、收藏项目及获取支持者。
+ * @property {Object} experiment - 实验管理操作，包括更新实验、获取封面及获取实验。
+ */
+class User {
+    /**
+     * 创建一个物实用户实例
+     * @param {String} username
+     * @param {String} password
+     * @memberof User
+     */
+    constructor(username, password) {
+        if (username === null) {
+            this.username = null;
+            this.password = null;
+        }
+        else {
+            this.username = username || process?.env?.USERNAME || null;
+            this.password = password || process?.env?.PASSWORD || null;
+        }
+        this.messages = {
+            get: getMessage.bind(this),
+            comment: sendMessages.bind(this),
+        };
+        this.user = {
+            login: login.bind(this),
+            getUser: getUser.bind(this),
+            getUserByComments: getUserByComments.bind(this),
+        };
+        this.projects = {
+            query: query.bind(this),
+            getSummary: getSummary.bind(this),
+            getDerivatives: getDerivatives.bind(this),
+            star: star.bind(this),
+            getSupporters: getSupporters.bind(this),
+        };
+        this.experiment = {
+            update: updateExperiment.bind(this),
+            cover: cover.bind(this),
+            get: getExperiment.bind(this),
+        };
+    }
+}
+module.exports = User;

dist/api/messages/get.js

@@ -0,0 +1,35 @@
+"use strict";
+const plrequest = require("../axiosInstance");
+/**
+ * 获取留言/评论信息，部分作品需要非匿名登录（传入用户名和密码）
+ *
+ * @param {*} ID - 获取的相关type的序列号，例如667c0e11d46f35b9aaddb8dd
+ * @param {string} [type="Discussion"] - 所获取的对象的类型。Discussion、Experiment、User
+ * @param {number} [take=20] - 获取的留言/评论数量
+ * @param {*} [from=null] - 从某个commentID开始跳过skip条
+ * @param {number} [skip=0] - 跳过的数量
+ * @returns {Promise<Object>}
+ */
+module.exports = async function getMessages(ID, type = "Discussion", take = 20, from = null, skip = 0) {
+    if (take > 100)
+        throw new Error("消息获取数量一次最多为100条");
+    take = -take;
+    const response = await plrequest.post("Messages/GetComments", {
+        TargetID: ID,
+        TargetType: type,
+        CommentID: from,
+        Take: take,
+        Skip: skip,
+    }, {
+        headers: {
+            "Content-Type": "application/json",
+            Accept: "application/json",
+            "Accept-Language": "zh-CN",
+            // @ts-ignore
+            "x-API-Token": this.token,
+            // @ts-ignore
+            "x-API-AuthCode": this.authCode,
+        },
+    });
+    return response.data;
+};