codatta-frontier-sdk 0.1.8 → 0.1.9

package/README.md

@@ -1,80 +1,174 @@
 # Codatta Frontier SDK
 
-Codatta Frontier 平台的 API 客户端 SDK。
+API client SDK for the Codatta Frontier platform.
 
-## 安装
+## Installation
 
 ```bash
 npm install codatta-frontier-sdk
 ```
 
-> **注意**: `axios` 是 peerDependency，请确保项目中已安装 `axios >= 1.0.0`。
+> **Note**: `axios` is a peerDependency. Make sure `axios >= 1.0.0` is installed in your project.
 
-## 使用
+## Usage
 
 ```typescript
 import { FrontierSDK } from 'codatta-frontier-sdk'
 
 const sdk = new FrontierSDK()
 
-// 获取任务详情
+// Get task detail
 const taskDetail = await sdk.getTaskDetail('task-id')
 
-// 获取任务列表
+// Get task list
 const taskList = await sdk.getTaskList({
   frontier_id: 'frontier-id',
   page_num: 1,
   page_size: 10
 })
 
-// 提交任务
+// Submit a task
 const result = await sdk.submitTask('task-id', { field: 'value' })
 
-// 获取提交列表
+// Get submission list
 const submissions = await sdk.getSubmissionList({
   page_num: 1,
   page_size: 10,
   frontier_id: 'frontier-id'
 })
 
-// 获取 Frontier 信息
+// Get Frontier info
 const frontierInfo = await sdk.getFrontierInfo('frontier-id')
 
-// 获取提交详情
+// Get submission detail
 const submissionDetail = await sdk.getSubmissionDetail('submission-id')
 
-// 上传文件（支持进度回调）
+// Upload a file (with optional progress callback)
 const uploadResult = await sdk.uploadFile(file, (event) => {
   console.log(`Upload progress: ${Math.round((event.loaded * 100) / (event.total ?? 1))}%`)
 })
+
+// Get a single spec task info
+const specTask = await sdk.getSpecTaskInfo('task-id')
+
+// Get multiple spec tasks info at once (comma-separated IDs)
+const specTasks = await sdk.getSpecTaskInfos('task-id-1,task-id-2,task-id-3')
+
+// Submit a spec task (status: 1 = reject, 2 = accept)
+const specResult = await sdk.submitSpecTask('task-id', 'optional content', 2)
+
+// Request a verification code sent to an email
+const code = await sdk.getVerificationCode({ email: 'user@example.com' })
+
+// Verify email against a task requirement
+const check = await sdk.checkEmail({
+  email: 'user@example.com',
+  code: '123456',
+  task_id: 'task-id'
+})
+if (check.flag) {
+  console.log('Email verified successfully')
+} else {
+  console.warn('Verification failed:', check.info)
+}
 ```
 
 ## API
 
 ### `new FrontierSDK()`
 
-创建 SDK 实例。无需传入任何参数，SDK 内部自动处理：
+Creates an SDK instance. No parameters required — the SDK handles the following automatically:
+
+- **Token**: Retrieved from `cookie` (`auth`) or `localStorage` (`auth`)
+
+### Methods
+
+| Method | Description |
+|--------|------------|
+| `getTaskDetail(taskId)` | Get task detail |
+| `submitTask(taskId, data)` | Submit task data |
+| `getTaskList(params)` | Get paginated task list |
+| `getSubmissionList(params)` | Get paginated submission list |
+| `getFrontierInfo(frontierId)` | Get Frontier detail |
+| `getSubmissionDetail(submissionId)` | Get submission detail |
+| `uploadFile(file, onProgress?)` | Upload a file |
+| `getSpecTaskInfo(taskId)` | Get single spec task info |
+| `getSpecTaskInfos(taskIds)` | Get multiple spec tasks info |
+| `submitSpecTask(taskId, content?, status?)` | Submit or update a spec task |
+| `getVerificationCode(params)` | Request a verification code |
+| `checkEmail(params)` | Verify email against a task requirement |
+
+### Method Details
+
+#### `getTaskList(params)`
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `frontier_id` | `string` | Yes | The frontier to query tasks for |
+| `page_num` | `number` | Yes | Page number (1-based) |
+| `page_size` | `number` | Yes | Number of tasks per page |
+| `task_types` | `string` | No | Comma-separated task type filter (e.g. `'submission,validation'`) |
+
+#### `getSubmissionList(params)`
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `page_num` | `number` | Yes | Page number (1-based) |
+| `page_size` | `number` | Yes | Number of items per page |
+| `frontier_id` | `string` | No | Filter by frontier ID |
+| `task_ids` | `string` | No | Comma-separated list of task IDs to filter by |
+
+#### `submitSpecTask(taskId, content?, status?)`
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `taskId` | `string` | Yes | Unique task ID |
+| `content` | `string` | No | Optional freeform content to attach |
+| `status` | `1 \| 2` | No | `1` = reject, `2` = accept (default `2`) |
+
+#### `getVerificationCode(params)`
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `account_type` | `string` | No | Account type: `'email'` (default) \| `'block_chain'` |
+| `email` | `string` | No | Target email address. Required when `account_type` is `'email'` |
+| `opt` | `string` | No | Operation type: `'verify'` (default) \| `'vivolight'` |
+
+Returns the verification code string. Pass it to `checkEmail` to complete verification.
+
+#### `checkEmail(params)`
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `email` | `string` | Yes | Email address to verify |
+| `code` | `string` | Yes | Verification code from `getVerificationCode` |
+| `task_id` | `string` | Yes | The task ID requiring email verification |
+
+Returns `{ flag: boolean; info: string }` — `flag: true` if verification passed; `flag: false` with a reason in `info` otherwise.
 
-- **Token**: 从 `cookie` (`auth`) 或 `localStorage` (`auth`) 中自动获取
-- **Channel**: 根据 `userAgent` / `location.hash` 自动判断（App 或 Web）
-- **Device**: 根据 `userAgent` 自动判断（移动端或 PC）
+## Types
 
-### 方法
+Key types exported from `codatta-frontier-sdk`:
 
-| 方法 | 说明 |
-|------|------|
-| `getTaskDetail(taskId)` | 获取任务详情 |
-| `submitTask(taskId, data)` | 提交任务数据 |
-| `getTaskList(params)` | 获取任务列表（分页） |
-| `getSubmissionList(params)` | 获取提交列表（分页） |
-| `getFrontierInfo(frontierId)` | 获取 Frontier 详情 |
-| `getSubmissionDetail(submissionId)` | 获取提交详情 |
-| `uploadFile(file, onProgress?)` | 上传文件 |
+| Type | Description |
+|------|-------------|
+| `Response<T>` | Standard API response wrapper |
+| `PaginationResponse<T>` | Paginated response wrapper |
+| `TPagination` | Common pagination parameters (`page_num`, `page_size`) |
+| `TaskDetail` | Full details of a frontier task, including display data, submission state, and reward info |
+| `FrontierItemType` | Frontier metadata, configuration, and reward structure |
+| `SubmissionRecord` | Historical submission record returned by the submission list / detail endpoints |
+| `TaskInfo` | Spec task info used by the `/v2/spec/task/*` endpoints |
+| `TaskRewardInfo` | Reward configuration attached to a task |
+| `RankingGrade` | Quality grade: `'S' \| 'A' \| 'B' \| 'C' \| 'D'` |
+| `TaskType` | Task category: `'submission' \| 'validation'` |
+| `ActiveStatus` | Frontier status: `'ACTIVE' \| 'INACTIVE' \| 'COMPLETED'` |
+| `MediaName` | Social media identifiers used in frontier media links |
 
-## 构建
+## Build
 
 ```bash
 npm run build
 ```
 
-输出 ESM (`dist/index.mjs`) 和 CJS (`dist/index.cjs`) 以及类型声明文件。
+Outputs ESM (`dist/index.mjs`), CJS (`dist/index.cjs`), and type declaration files.

package/dist/index.cjs

@@ -1 +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 e=1;e<arguments.length;e++){var t=arguments[e];for(var o in t)r[o]=t[o]}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,e){function t(s,i,n){if(!(typeof document>"u")){n=u({},e,n),typeof n.expires=="number"&&(n.expires=new Date(Date.now()+n.expires*864e5)),n.expires&&(n.expires=n.expires.toUTCString()),s=encodeURIComponent(s).replace(/%(2[346B]|5E|60|7C)/g,decodeURIComponent).replace(/[()]/g,escape);var a="";for(var c in n)n[c]&&(a+="; "+c,n[c]!==!0&&(a+="="+n[c].split(";")[0]));return document.cookie=s+"="+r.write(i,s)+a}}function o(s){if(!(typeof document>"u"||arguments.length&&!s)){for(var i=document.cookie?document.cookie.split("; "):[],n={},a=0;a<i.length;a++){var c=i[a].split("="),m=c.slice(1).join("=");try{var p=decodeURIComponent(c[0]);if(n[p]=r.read(m,p),s===p)break}catch{}}return s?n[s]:n}}return Object.create({set:t,get:o,remove:function(s,i){t(s,"",u({},i,{expires:-1}))},withAttributes:function(s){return l(this.converter,u({},this.attributes,s))},withConverter:function(s){return l(u({},this.converter,s),this.attributes)}},{attributes:{value:Object.freeze(e)},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(e=>{var n;const t=navigator.userAgent.toLowerCase(),o=t.includes("codatta")||((n=location.hash)==null?void 0:n.toLowerCase().includes("codatta")),s=g.get("auth")||localStorage.getItem("auth"),i=/android|webos|iphone|ipad|ipod|blackberry|iemobile|opera mini/i.test(t);return s&&(e.headers.token=s),e.headers.channel=o?"codatta-ios-app":"codatta-platform-website",e.headers.device=i?"mobile":"web",e})}setupResponseInterceptor(){this.request.interceptors.response.use(e=>{const t=e.data,o=Object.getOwnPropertyNames(t).includes("code"),s=Object.getOwnPropertyNames(t).includes("success");return o&&(t==null?void 0:t.code)!=="000000"?Promise.reject(new d.AxiosError(t==null?void 0:t.message,t==null?void 0:t.code,e.config,e.request,e)):s&&(t==null?void 0:t.success)!==!0?Promise.reject(new d.AxiosError(t==null?void 0:t.errorMessage,t==null?void 0:t.errorCode,e.config,e.request,e)):e},e=>{if(e.status===401){localStorage.removeItem("uid"),localStorage.removeItem("token"),localStorage.removeItem("auth");const t=new URL(window.location.href),o=t.pathname+t.search;window.location.href=`/account/signin?from=${encodeURIComponent(o)}`}return Promise.reject(e)})}async getTaskDetail(e){return(await this.request.post("/api/v2/frontier/task/detail",{task_id:e})).data}async submitTask(e,t){return(await this.request.post("/api/v2/frontier/task/submit",{task_id:e,data_submission:{data:t,task_id:e}})).data}async getTaskList(e){return(await this.request.post("/api/v2/frontier/task/list",e)).data}async getSubmissionList(e){return(await this.request.post("/api/v2/submission/list",e)).data}async getFrontierInfo(e){return(await this.request.get(`/api/v2/frontier/info?frontier_id=${e}`)).data}async getSubmissionDetail(e){return(await this.request.get("/api/v2/submission/user/detail",{params:{submission_id:e}})).data}async uploadFile(e,t){const o=new FormData;return o.append("file",e),(await this.request.post("/api/file/upload",o,{params:{content_type:e.type},onUploadProgress:t})).data}async getSpecTaskInfo(e){return(await this.request.get(`/api/v2/spec/task/info?task_id=${e}`)).data}async getSpecTaskInfos(e){return(await this.request.get(`/api/v2/spec/task/infos?task_ids=${e}`)).data}async submitSpecTask(e,t,o){return(await this.request.post("/api/v2/spec/task/submit",{task_id:e,status:o??2,content:t})).data}async getVerificationCode({account_type:e,email:t,opt:o}){return(await this.request.post("/api/v2/user/get_code",{account_type:e??"email",email:t??"",opt:o??"verify"})).data.data}async checkEmail({email:e,code:t,task_id:o}){return(await this.request.post("/api/v2/frontier/email/check",{email:e,code:t,task_id:o})).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;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const d=require("axios");/*! js-cookie v3.0.5 | MIT */function u(r){for(var e=1;e<arguments.length;e++){var t=arguments[e];for(var o in t)r[o]=t[o]}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,e){function t(s,i,n){if(!(typeof document>"u")){n=u({},e,n),typeof n.expires=="number"&&(n.expires=new Date(Date.now()+n.expires*864e5)),n.expires&&(n.expires=n.expires.toUTCString()),s=encodeURIComponent(s).replace(/%(2[346B]|5E|60|7C)/g,decodeURIComponent).replace(/[()]/g,escape);var a="";for(var c in n)n[c]&&(a+="; "+c,n[c]!==!0&&(a+="="+n[c].split(";")[0]));return document.cookie=s+"="+r.write(i,s)+a}}function o(s){if(!(typeof document>"u"||arguments.length&&!s)){for(var i=document.cookie?document.cookie.split("; "):[],n={},a=0;a<i.length;a++){var c=i[a].split("="),m=c.slice(1).join("=");try{var p=decodeURIComponent(c[0]);if(n[p]=r.read(m,p),s===p)break}catch{}}return s?n[s]:n}}return Object.create({set:t,get:o,remove:function(s,i){t(s,"",u({},i,{expires:-1}))},withAttributes:function(s){return l(this.converter,u({},this.attributes,s))},withConverter:function(s){return l(u({},this.converter,s),this.attributes)}},{attributes:{value:Object.freeze(e)},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(e=>{var n;const t=navigator.userAgent.toLowerCase(),o=t.includes("codatta")||((n=location.hash)==null?void 0:n.toLowerCase().includes("codatta")),s=g.get("auth")||localStorage.getItem("auth"),i=/android|webos|iphone|ipad|ipod|blackberry|iemobile|opera mini/i.test(t);return s&&(e.headers.token=s),e.headers.channel=o?"codatta-ios-app":"codatta-platform-website",e.headers.device=i?"mobile":"web",e})}setupResponseInterceptor(){this.request.interceptors.response.use(e=>{const t=e.data,o=Object.getOwnPropertyNames(t).includes("code"),s=Object.getOwnPropertyNames(t).includes("success");return o&&(t==null?void 0:t.code)!=="000000"?Promise.reject(new d.AxiosError(t==null?void 0:t.message,t==null?void 0:t.code,e.config,e.request,e)):s&&(t==null?void 0:t.success)!==!0?Promise.reject(new d.AxiosError(t==null?void 0:t.errorMessage,t==null?void 0:t.errorCode,e.config,e.request,e)):e},e=>{if(e.status===401){localStorage.removeItem("uid"),localStorage.removeItem("token"),localStorage.removeItem("auth");const t=new URL(window.location.href),o=t.pathname+t.search;window.location.href=`/account/signin?from=${encodeURIComponent(o)}`}return Promise.reject(e)})}async getTaskDetail(e){return(await this.request.post("/api/v2/frontier/task/detail",{task_id:e})).data}async submitTask(e,t,o){return(await this.request.post("/api/v2/frontier/task/submit",{task_id:e,data_submission:{uid:o,data:t,task_id:e}})).data}async getTaskList(e){return(await this.request.post("/api/v2/frontier/task/list",e)).data}async getSubmissionList(e){return(await this.request.post("/api/v2/submission/list",e)).data}async getFrontierInfo(e){return(await this.request.get(`/api/v2/frontier/info?frontier_id=${e}`)).data}async getSubmissionDetail(e){return(await this.request.get("/api/v2/submission/user/detail",{params:{submission_id:e}})).data}async uploadFile(e,t){const o=new FormData;return o.append("file",e),(await this.request.post("/api/file/upload",o,{params:{content_type:e.type},onUploadProgress:t})).data}async getSpecTaskInfo(e){return(await this.request.get(`/api/v2/spec/task/info?task_id=${e}`)).data}async getSpecTaskInfos(e){return(await this.request.get(`/api/v2/spec/task/infos?task_ids=${e}`)).data}async submitSpecTask(e,t,o){return(await this.request.post("/api/v2/spec/task/submit",{task_id:e,status:o??2,content:t})).data}async getVerificationCode({account_type:e,email:t,opt:o}){return(await this.request.post("/api/v2/user/get_code",{account_type:e??"email",email:t??"",opt:o??"verify"})).data.data}async checkEmail({email:e,code:t,task_id:o}){return(await this.request.post("/api/v2/frontier/email/check",{email:e,code:t,task_id:o})).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

@@ -24,6 +24,13 @@ export declare interface CMUDataRequirements {
     };
 }
 
+export declare interface FashionQuestion {
+    content: object;
+    image_url: string;
+    source_type: string;
+    uid: string;
+}
+
 export declare interface FrontierItemType {
     id?: number;
     name: string;
@@ -66,7 +73,7 @@ export declare class FrontierSDK {
      * @param data - Submission payload. Shape depends on the task template.
      * @returns Updated task detail after submission.
      */
-    submitTask(taskId: string, data: object): Promise<Response_2<TaskDetail>>;
+    submitTask(taskId: string, data: object, uid?: string): Promise<Response_2<TaskDetail>>;
     /**
      * Fetch a paginated list of tasks for a given frontier.
      * @param params.frontier_id - The frontier to query tasks for.
@@ -276,7 +283,7 @@ export declare interface TaskDetail {
         web_template_url?: string;
         app_template_url?: string;
     };
-    questions?: CMUDataRequirements[];
+    questions?: CMUDataRequirements[] | FashionQuestion[];
     data_submission?: {
         [key: string]: unknown;
         lifelog_report?: string;

package/dist/index.mjs

@@ -115,10 +115,11 @@ class y {
    * @param data - Submission payload. Shape depends on the task template.
    * @returns Updated task detail after submission.
    */
-  async submitTask(e, t) {
+  async submitTask(e, t, o) {
     return (await this.request.post("/api/v2/frontier/task/submit", {
       task_id: e,
       data_submission: {
+        uid: o,
         data: t,
         task_id: e
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codatta-frontier-sdk",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "Codatta Frontier SDK - API client for Codatta Frontier platform",
   "type": "module",
   "main": "./dist/index.cjs",