codatta-frontier-sdk 0.1.0

package/README.md

@@ -0,0 +1,80 @@
+# Codatta Frontier SDK
+
+Codatta Frontier 平台的 API 客户端 SDK。
+
+## 安装
+
+```bash
+npm install codatta-frontier-sdk
+```
+
+> **注意**: `axios` 是 peerDependency，请确保项目中已安装 `axios >= 1.0.0`。
+
+## 使用
+
+```typescript
+import { FrontierSDK } from 'codatta-frontier-sdk'
+
+const sdk = new FrontierSDK()
+
+// 获取任务详情
+const taskDetail = await sdk.getTaskDetail('task-id')
+
+// 获取任务列表
+const taskList = await sdk.getTaskList({
+  frontier_id: 'frontier-id',
+  page_num: 1,
+  page_size: 10
+})
+
+// 提交任务
+const result = await sdk.submitTask('task-id', { field: 'value' })
+
+// 获取提交列表
+const submissions = await sdk.getSubmissionList({
+  page_num: 1,
+  page_size: 10,
+  frontier_id: 'frontier-id'
+})
+
+// 获取 Frontier 信息
+const frontierInfo = await sdk.getFrontierInfo('frontier-id')
+
+// 获取提交详情
+const submissionDetail = await sdk.getSubmissionDetail('submission-id')
+
+// 上传文件（支持进度回调）
+const uploadResult = await sdk.uploadFile(file, (event) => {
+  console.log(`Upload progress: ${Math.round((event.loaded * 100) / (event.total ?? 1))}%`)
+})
+```
+
+## API
+
+### `new FrontierSDK()`
+
+创建 SDK 实例。无需传入任何参数，SDK 内部自动处理：
+
+- **Token**: 从 `cookie` (`auth`) 或 `localStorage` (`auth`) 中自动获取
+- **Channel**: 根据 `userAgent` / `location.hash` 自动判断（App 或 Web）
+- **Device**: 根据 `userAgent` 自动判断（移动端或 PC）
+
+### 方法
+
+| 方法 | 说明 |
+|------|------|
+| `getTaskDetail(taskId)` | 获取任务详情 |
+| `submitTask(taskId, data)` | 提交任务数据 |
+| `getTaskList(params)` | 获取任务列表（分页） |
+| `getSubmissionList(params)` | 获取提交列表（分页） |
+| `getFrontierInfo(frontierId)` | 获取 Frontier 详情 |
+| `getSubmissionDetail(submissionId)` | 获取提交详情 |
+| `uploadFile(file, onProgress?)` | 上传文件 |
+
+## 构建
+
+```bash
+npm run build
+```
+
+输出 ESM (`dist/index.mjs`) 和 CJS (`dist/index.cjs`) 以及类型声明文件。

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const d=require("axios");/*! js-cookie v3.0.5 | MIT */function u(r){for(var t=1;t<arguments.length;t++){var e=arguments[t];for(var n in e)r[n]=e[n]}return r}var h={read:function(r){return r[0]==='"'&&(r=r.slice(1,-1)),r.replace(/(%[\dA-F]{2})+/gi,decodeURIComponent)},write:function(r){return encodeURIComponent(r).replace(/%(2[346BF]|3[AC-F]|40|5[BDE]|60|7[BCD])/g,decodeURIComponent)}};function l(r,t){function e(o,i,s){if(!(typeof document>"u")){s=u({},t,s),typeof s.expires=="number"&&(s.expires=new Date(Date.now()+s.expires*864e5)),s.expires&&(s.expires=s.expires.toUTCString()),o=encodeURIComponent(o).replace(/%(2[346B]|5E|60|7C)/g,decodeURIComponent).replace(/[()]/g,escape);var c="";for(var a in s)s[a]&&(c+="; "+a,s[a]!==!0&&(c+="="+s[a].split(";")[0]));return document.cookie=o+"="+r.write(i,o)+c}}function n(o){if(!(typeof document>"u"||arguments.length&&!o)){for(var i=document.cookie?document.cookie.split("; "):[],s={},c=0;c<i.length;c++){var a=i[c].split("="),m=a.slice(1).join("=");try{var p=decodeURIComponent(a[0]);if(s[p]=r.read(m,p),o===p)break}catch{}}return o?s[o]:s}}return Object.create({set:e,get:n,remove:function(o,i){e(o,"",u({},i,{expires:-1}))},withAttributes:function(o){return l(this.converter,u({},this.attributes,o))},withConverter:function(o){return l(u({},this.converter,o),this.attributes)}},{attributes:{value:Object.freeze(t)},converter:{value:Object.freeze(r)}})}var g=l(h,{path:"/"});class v{constructor(){this.request=d.create({timeout:3e4}),this.setupRequestInterceptor(),this.setupResponseInterceptor()}setupRequestInterceptor(){this.request.interceptors.request.use(t=>{var s;const e=navigator.userAgent.toLowerCase(),n=e.includes("codatta")||((s=location.hash)==null?void 0:s.toLowerCase().includes("codatta")),o=g.get("auth")||localStorage.getItem("auth"),i=/android|webos|iphone|ipad|ipod|blackberry|iemobile|opera mini/i.test(e);return o&&(t.headers.token=o),t.headers.channel=n?"codatta-ios-app":"codatta-platform-website",t.headers.device=i?"mobile":"web",t})}setupResponseInterceptor(){this.request.interceptors.response.use(t=>{const e=t.data,n=Object.getOwnPropertyNames(e).includes("code"),o=Object.getOwnPropertyNames(e).includes("success");return n&&(e==null?void 0:e.code)!=="000000"?Promise.reject(new d.AxiosError(e==null?void 0:e.message,e==null?void 0:e.code,t.config,t.request,t)):o&&(e==null?void 0:e.success)!==!0?Promise.reject(new d.AxiosError(e==null?void 0:e.errorMessage,e==null?void 0:e.errorCode,t.config,t.request,t)):t},t=>{if(t.status===401){localStorage.removeItem("uid"),localStorage.removeItem("token"),localStorage.removeItem("auth");const e=new URL(window.location.href),n=e.pathname+e.search;window.location.href=`/account/signin?from=${encodeURIComponent(n)}`}return Promise.reject(t)})}async getTaskDetail(t){return(await this.request.post("/v2/frontier/task/detail",{task_id:t})).data}async submitTask(t,e){return(await this.request.post("/v2/frontier/task/submit",{task_id:t,data_submission:e})).data}async getTaskList(t){return(await this.request.post("/v2/frontier/task/list",t)).data}async getSubmissionList(t){return(await this.request.post("/v2/submission/list",t)).data}async getFrontierInfo(t){return(await this.request.get(`/v2/frontier/info?frontier_id=${t}`)).data}async getSubmissionDetail(t){return(await this.request.get("/v2/submission/user/detail",{params:{submission_id:t}})).data}async uploadFile(t,e){const n=new FormData;return n.append("file",t),(await this.request.post("/file/upload",n,{headers:{"Content-Type":t.type},onUploadProgress:e})).data.data}}var f=(r=>(r.TWITTER="x",r.TELEGRAM="telegram",r.DISCORD="discord",r.WEBSITE="website",r.DOC="doc",r))(f||{});exports.FrontierSDK=v;exports.MediaName=f;

package/dist/index.d.ts

@@ -0,0 +1,190 @@
+import { AxiosProgressEvent } from 'axios';
+
+export declare type ActiveStatus = 'ACTIVE' | 'INACTIVE' | 'COMPLETED';
+
+export declare interface CMUDataRequirements {
+    num: string;
+    querytext: string;
+    status: number;
+    part1: {
+        select?: string;
+        videos: Array<VideoItem>;
+    };
+    part2: {
+        videos: Array<VideoItem>;
+        questions: Array<{
+            title: string;
+            select?: string;
+            options: Array<{
+                value: string;
+                label: string;
+                content: string;
+            }>;
+        }>;
+    };
+}
+
+export declare interface FrontierItemType {
+    id?: number;
+    name: string;
+    description: string;
+    logo_url: string;
+    banner?: string;
+    media_link?: Array<{
+        name: MediaName;
+        value: string;
+    }>;
+    qualification?: string;
+    videos?: Array<VideoItem>;
+    reputation_permission?: number;
+    frontier_id?: string;
+    adopt_count: number;
+    rewards: FrontierRewardItem[];
+    dataset_url: string | null;
+}
+
+export declare interface FrontierRewardItem {
+    reward_type: string;
+    reward_type_name: string;
+    reward_value: number;
+}
+
+export declare class FrontierSDK {
+    private request;
+    constructor();
+    private setupRequestInterceptor;
+    private setupResponseInterceptor;
+    getTaskDetail(taskId: string): Promise<Response_2<TaskDetail>>;
+    submitTask(taskId: string, data: object): Promise<Response_2<TaskDetail>>;
+    getTaskList(params: {
+        frontier_id: string;
+        page_num: number;
+        page_size: number;
+        task_types?: string;
+    }): Promise<PaginationResponse<TaskDetail[]>>;
+    getSubmissionList(data: TPagination & {
+        frontier_id?: string;
+        task_ids?: string;
+    }): Promise<PaginationResponse<TaskDetail[]>>;
+    getFrontierInfo(frontierId: string): Promise<Response_2<FrontierItemType>>;
+    getSubmissionDetail(submissionId: string): Promise<Response_2<SubmissionRecord>>;
+    uploadFile(file: File, onProgress?: (event: AxiosProgressEvent) => void): Promise<{
+        file_path: string;
+        original_name: string;
+    }>;
+}
+
+export declare enum MediaName {
+    TWITTER = "x",
+    TELEGRAM = "telegram",
+    DISCORD = "discord",
+    WEBSITE = "website",
+    DOC = "doc"
+}
+
+export declare interface PaginationResponse<T> {
+    data: T;
+    total: number;
+    page_num: number;
+    page_size: number;
+}
+
+export declare type RankingGrade = 'S' | 'A' | 'B' | 'C' | 'D';
+
+declare interface Response_2<T> {
+    data: T;
+    success: true;
+    errorCode: number;
+    errorMessage: string;
+}
+export { Response_2 as Response }
+
+export declare interface SubmissionRecord {
+    submission_time: number;
+    frontier_name: string;
+    task_name: string;
+    result: number;
+    rating_name: RankingGrade;
+    status: 'ADOPT' | 'PENDING' | 'REFUSED';
+    submission_id: string;
+    rewards: SubmissionReward[];
+    data_submission?: {
+        data: {
+            [key: string]: unknown;
+        };
+        taskId: string;
+        templateId: string;
+    };
+}
+
+export declare interface SubmissionReward {
+    reward_type: string;
+    reward_amount: number;
+}
+
+export declare interface TaskDetail {
+    frontier_id: string;
+    task_id: string;
+    name: string;
+    create_time: number;
+    submission_id: string;
+    task_type: string;
+    task_type_name: string;
+    template_id: string;
+    data_display: {
+        gif_resource: string;
+        template_id: string;
+        related_task_id?: string;
+        hide?: boolean;
+        link?: string;
+        bot_id?: string;
+        data_source?: string;
+        web_template_url?: string;
+        app_template_url?: string;
+    };
+    questions?: CMUDataRequirements[];
+    data_submission?: {
+        [key: string]: unknown;
+        lifelog_report?: string;
+    };
+    question_status?: number;
+    data_requirements: unknown;
+    reward_info: readonly TaskRewardInfo[];
+    qualification_datas: unknown[];
+    status: 'PENDING' | 'SUBMITTED' | 'REFUSED' | 'ADOPT';
+    txHashUrl: string;
+    result: RankingGrade;
+    chain_status: 0 | 1 | 2 | 3 | 4;
+    qualification?: string;
+    qualification_flag: 0 | 1;
+    reputation: number;
+    reward_points: null | number;
+    user_reputation_flag: 0 | 1 | 2;
+    tags: string[];
+    audit_reason?: string;
+}
+
+export declare interface TaskRewardInfo {
+    reward_icon: string;
+    reward_mode: string;
+    reward_type: string;
+    reward_value: number;
+}
+
+export declare type TaskType = 'submission' | 'validation';
+
+export declare type TaskTypeName = 'Contribute' | 'Review';
+
+export declare interface TPagination {
+    page_num: number;
+    page_size: number;
+}
+
+export declare interface VideoItem {
+    video_id: string;
+    desc?: string;
+    image_url?: string;
+    video_url: string;
+}
+
+export { }

package/dist/index.mjs

@@ -0,0 +1,139 @@
+import m, { AxiosError as l } from "axios";
+/*! js-cookie v3.0.5 | MIT */
+function u(r) {
+  for (var t = 1; t < arguments.length; t++) {
+    var e = arguments[t];
+    for (var n in e)
+      r[n] = e[n];
+  }
+  return r;
+}
+var h = {
+  read: function(r) {
+    return r[0] === '"' && (r = r.slice(1, -1)), r.replace(/(%[\dA-F]{2})+/gi, decodeURIComponent);
+  },
+  write: function(r) {
+    return encodeURIComponent(r).replace(
+      /%(2[346BF]|3[AC-F]|40|5[BDE]|60|7[BCD])/g,
+      decodeURIComponent
+    );
+  }
+};
+function d(r, t) {
+  function e(s, i, o) {
+    if (!(typeof document > "u")) {
+      o = u({}, t, o), typeof o.expires == "number" && (o.expires = new Date(Date.now() + o.expires * 864e5)), o.expires && (o.expires = o.expires.toUTCString()), s = encodeURIComponent(s).replace(/%(2[346B]|5E|60|7C)/g, decodeURIComponent).replace(/[()]/g, escape);
+      var c = "";
+      for (var a in o)
+        o[a] && (c += "; " + a, o[a] !== !0 && (c += "=" + o[a].split(";")[0]));
+      return document.cookie = s + "=" + r.write(i, s) + c;
+    }
+  }
+  function n(s) {
+    if (!(typeof document > "u" || arguments.length && !s)) {
+      for (var i = document.cookie ? document.cookie.split("; ") : [], o = {}, c = 0; c < i.length; c++) {
+        var a = i[c].split("="), f = a.slice(1).join("=");
+        try {
+          var p = decodeURIComponent(a[0]);
+          if (o[p] = r.read(f, p), s === p)
+            break;
+        } catch {
+        }
+      }
+      return s ? o[s] : o;
+    }
+  }
+  return Object.create(
+    {
+      set: e,
+      get: n,
+      remove: function(s, i) {
+        e(
+          s,
+          "",
+          u({}, i, {
+            expires: -1
+          })
+        );
+      },
+      withAttributes: function(s) {
+        return d(this.converter, u({}, this.attributes, s));
+      },
+      withConverter: function(s) {
+        return d(u({}, this.converter, s), this.attributes);
+      }
+    },
+    {
+      attributes: { value: Object.freeze(t) },
+      converter: { value: Object.freeze(r) }
+    }
+  );
+}
+var g = d(h, { path: "/" });
+class I {
+  constructor() {
+    this.request = m.create({
+      timeout: 3e4
+    }), this.setupRequestInterceptor(), this.setupResponseInterceptor();
+  }
+  // ─── Interceptors ──────────────────────────────────────────────────────────
+  setupRequestInterceptor() {
+    this.request.interceptors.request.use((t) => {
+      var o;
+      const e = navigator.userAgent.toLowerCase(), n = e.includes("codatta") || ((o = location.hash) == null ? void 0 : o.toLowerCase().includes("codatta")), s = g.get("auth") || localStorage.getItem("auth"), i = /android|webos|iphone|ipad|ipod|blackberry|iemobile|opera mini/i.test(e);
+      return s && (t.headers.token = s), t.headers.channel = n ? "codatta-ios-app" : "codatta-platform-website", t.headers.device = i ? "mobile" : "web", t;
+    });
+  }
+  setupResponseInterceptor() {
+    this.request.interceptors.response.use(
+      (t) => {
+        const e = t.data, n = Object.getOwnPropertyNames(e).includes("code"), s = Object.getOwnPropertyNames(e).includes("success");
+        return n && (e == null ? void 0 : e.code) !== "000000" ? Promise.reject(new l(e == null ? void 0 : e.message, e == null ? void 0 : e.code, t.config, t.request, t)) : s && (e == null ? void 0 : e.success) !== !0 ? Promise.reject(new l(e == null ? void 0 : e.errorMessage, e == null ? void 0 : e.errorCode, t.config, t.request, t)) : t;
+      },
+      (t) => {
+        if (t.status === 401) {
+          localStorage.removeItem("uid"), localStorage.removeItem("token"), localStorage.removeItem("auth");
+          const e = new URL(window.location.href), n = e.pathname + e.search;
+          window.location.href = `/account/signin?from=${encodeURIComponent(n)}`;
+        }
+        return Promise.reject(t);
+      }
+    );
+  }
+  // ─── API Methods ───────────────────────────────────────────────────────────
+  async getTaskDetail(t) {
+    return (await this.request.post("/v2/frontier/task/detail", { task_id: t })).data;
+  }
+  async submitTask(t, e) {
+    return (await this.request.post("/v2/frontier/task/submit", {
+      task_id: t,
+      data_submission: e
+    })).data;
+  }
+  async getTaskList(t) {
+    return (await this.request.post("/v2/frontier/task/list", t)).data;
+  }
+  async getSubmissionList(t) {
+    return (await this.request.post("/v2/submission/list", t)).data;
+  }
+  async getFrontierInfo(t) {
+    return (await this.request.get(`/v2/frontier/info?frontier_id=${t}`)).data;
+  }
+  async getSubmissionDetail(t) {
+    return (await this.request.get("/v2/submission/user/detail", {
+      params: { submission_id: t }
+    })).data;
+  }
+  async uploadFile(t, e) {
+    const n = new FormData();
+    return n.append("file", t), (await this.request.post("/file/upload", n, {
+      headers: { "Content-Type": t.type },
+      onUploadProgress: e
+    })).data.data;
+  }
+}
+var w = /* @__PURE__ */ ((r) => (r.TWITTER = "x", r.TELEGRAM = "telegram", r.DISCORD = "discord", r.WEBSITE = "website", r.DOC = "doc", r))(w || {});
+export {
+  I as FrontierSDK,
+  w as MediaName
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "codatta-frontier-sdk",
+  "version": "0.1.0",
+  "description": "Codatta Frontier SDK - API client for Codatta Frontier platform",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch"
+  },
+  "dependencies": {
+    "js-cookie": "^3.0.0"
+  },
+  "peerDependencies": {
+    "axios": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@types/js-cookie": "^3.0.0",
+    "axios": "^1.7.0",
+    "typescript": "^5.5.0",
+    "vite": "^6.0.0",
+    "vite-plugin-dts": "^4.0.0"
+  }
+}