@quantabit/mentor-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 QuantaBit Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+# @quantabit/mentor-sdk
+
+> QuantaBit Mentor System SDK - Mentor-mentee binding, inheritance rewards, and relationship network
+
+## 📦 Installation
+
+```bash
+npm install @quantabit/mentor-sdk
+# or
+yarn add @quantabit/mentor-sdk
+```
+
+## 🚀 Quick Start
+
+### 1. Setup Provider
+
+```jsx
+import { MentorProvider } from "@quantabit/mentor-sdk";
+import "@quantabit/mentor-sdk/styles.css";
+
+function App() {
+  return (
+    <MentorProvider
+      apiUrl="https://api.example.com/v1"
+      token="your-auth-token"
+      language="en"
+      onBind={(result) => console.log("Mentor bound:", result)}
+    >
+      <YourComponent />
+    </MentorProvider>
+  );
+}
+```
+
+### 2. Using Components
+
+```jsx
+import { MentorCard, BindMentorForm } from '@quantabit/mentor-sdk';
+
+// Mentor/Mentee card
+<MentorCard
+  user={mentorData}
+  role="mentor"
+  onUnbind={(user) => handleUnbind(user)}
+  onViewProfile={(user) => navigateToProfile(user.did)}
+/>
+
+// Bind mentor form
+<BindMentorForm
+  onSuccess={(result) => handleSuccess(result)}
+  onCancel={() => setShowForm(false)}
+/>
+```
+
+### 3. Using Hooks
+
+```jsx
+import { useMentor } from "@quantabit/mentor-sdk";
+
+function MyComponent() {
+  const {
+    myMentor, // My mentor
+    myApprentices, // My mentees
+    rewards, // Reward records
+    bindMentor, // Bind a mentor
+    loadRewards, // Load rewards
+  } = useMentor();
+
+  return <div>...</div>;
+}
+```
+
+## 🎁 Reward Types
+
+- **Mentorship Reward**: Earned upon successful mentor-mentee binding
+- **First Deposit Commission**: Mentor earns commission from mentee's first deposit
+- **Task Inheritance**: Mentor earns inheritance rewards when mentee completes tasks
+- **Daily Active Reward**: Mentor earns activity rewards when mentee stays active
+
+## 📄 License
+
+MIT License
+
+
+
+---
+
+## 🌐 Brand & Links
+- Official Mainnet: [QuantaBit Chain](https://qbitchain.io/)
+- Developer Platform: [Developer Platform](https://developer.quantabit.io/)
+- Open Platform: [Open Platform](https://open.quantabit.io/)
+- Payment Platform: [Pay Platform](https://pay.qbitwallet.io/)
+- Feedback: [Feedback](https://xwin.live/qbit)

package/dist/index.cjs

@@ -0,0 +1,607 @@
+'use strict';
+
+var React = require('react');
+var sdkConfig = require('@quantabit/sdk-config');
+
+/**
+ * Mentor SDK - API 客户端
+ * 导师系统后端接口封装
+ * 
+ * 使用 BaseApiClient 基类简化代码
+ */
+
+
+/**
+ * 导师 API 客户端
+ */
+class MentorApiClient extends sdkConfig.BaseApiClient {
+  constructor(config = {}) {
+    super('/mentor', config);
+  }
+
+  // ============ 导师查询 ============
+
+  /**
+   * 获取导师列表
+   * @param {Object} params - 查询参数
+   */
+  async getMentors(params = {}) {
+    return this.get('/list', params);
+  }
+
+  /**
+   * 获取导师详情
+   * @param {string} mentorId - 导师 ID
+   */
+  async getMentor(mentorId) {
+    return this.get(`/${mentorId}`);
+  }
+
+  /**
+   * 搜索导师
+   * @param {string} keyword - 关键词
+   * @param {Object} params - 查询参数
+   */
+  async searchMentors(keyword, params = {}) {
+    return this.get('/search', {
+      keyword,
+      ...params
+    });
+  }
+
+  /**
+   * 获取推荐导师
+   * @param {number} limit - 数量
+   */
+  async getRecommendedMentors(limit = 10) {
+    return this.get('/recommended', {
+      limit
+    });
+  }
+
+  // ============ 导师关系 ============
+
+  /**
+   * 申请成为学员
+   * @param {string} mentorId - 导师 ID
+   * @param {Object} application - 申请信息
+   */
+  async applyAsMentee(mentorId, application = {}) {
+    return this.post(`/${mentorId}/apply`, application);
+  }
+
+  /**
+   * 获取我的导师
+   */
+  async getMyMentor() {
+    return this.get('/my/mentor');
+  }
+
+  /**
+   * 获取我的学员
+   * @param {Object} params - 查询参数
+   */
+  async getMyMentees(params = {}) {
+    return this.get('/my/mentees', params);
+  }
+
+  /**
+   * 解除导师关系
+   * @param {string} relationshipId - 关系 ID
+   * @param {string} reason - 原因
+   */
+  async endRelationship(relationshipId, reason = '') {
+    return this.post(`/relationships/${relationshipId}/end`, {
+      reason
+    });
+  }
+
+  // ============ 导师申请管理 ============
+
+  /**
+   * 申请成为导师
+   * @param {Object} application - 申请数据
+   */
+  async applyAsMentor(application) {
+    return this.post('/apply', application);
+  }
+
+  /**
+   * 获取学员申请
+   * @param {Object} params - 查询参数
+   */
+  async getMenteeApplications(params = {}) {
+    return this.get('/applications', params);
+  }
+
+  /**
+   * 处理学员申请
+   * @param {string} applicationId - 申请 ID
+   * @param {boolean} approved - 是否批准
+   * @param {string} message - 消息
+   */
+  async handleApplication(applicationId, approved, message = '') {
+    return this.post(`/applications/${applicationId}`, {
+      approved,
+      message
+    });
+  }
+
+  // ============ 辅导管理 ============
+
+  /**
+   * 创建辅导计划
+   * @param {string} menteeId - 学员 ID
+   * @param {Object} plan - 计划数据
+   */
+  async createPlan(menteeId, plan) {
+    return this.post(`/mentees/${menteeId}/plans`, plan);
+  }
+
+  /**
+   * 获取辅导计划
+   * @param {string} menteeId - 学员 ID
+   */
+  async getPlans(menteeId) {
+    return this.get(`/mentees/${menteeId}/plans`);
+  }
+
+  /**
+   * 更新计划进度
+   * @param {string} planId - 计划 ID
+   * @param {Object} progress - 进度数据
+   */
+  async updatePlanProgress(planId, progress) {
+    return this.put(`/plans/${planId}/progress`, progress);
+  }
+
+  // ============ 辅导记录 ============
+
+  /**
+   * 添加辅导记录
+   * @param {string} menteeId - 学员 ID
+   * @param {Object} record - 记录数据
+   */
+  async addRecord(menteeId, record) {
+    return this.post(`/mentees/${menteeId}/records`, record);
+  }
+
+  /**
+   * 获取辅导记录
+   * @param {string} menteeId - 学员 ID
+   * @param {Object} params - 查询参数
+   */
+  async getRecords(menteeId, params = {}) {
+    return this.get(`/mentees/${menteeId}/records`, params);
+  }
+
+  // ============ 评价反馈 ============
+
+  /**
+   * 评价导师
+   * @param {string} mentorId - 导师 ID
+   * @param {Object} review - 评价数据
+   */
+  async reviewMentor(mentorId, review) {
+    return this.post(`/${mentorId}/review`, review);
+  }
+
+  /**
+   * 获取导师评价
+   * @param {string} mentorId - 导师 ID
+   * @param {Object} params - 查询参数
+   */
+  async getMentorReviews(mentorId, params = {}) {
+    return this.get(`/${mentorId}/reviews`, params);
+  }
+
+  // ============ 导师资料 ============
+
+  /**
+   * 更新导师资料
+   * @param {Object} profile - 资料数据
+   */
+  async updateMentorProfile(profile) {
+    return this.put('/my/profile', profile);
+  }
+
+  /**
+   * 设置可用时间
+   * @param {Object} availability - 可用时间配置
+   */
+  async setAvailability(availability) {
+    return this.put('/my/availability', availability);
+  }
+
+  /**
+   * 获取导师统计
+   */
+  async getMentorStats() {
+    return this.get('/my/stats');
+  }
+}
+
+// 创建默认实例
+const mentorApi = new MentorApiClient();
+
+/**
+ * Mentor SDK - 国际化 i18n
+ */
+
+const SUPPORTED_LANGUAGES = ['en', 'zh', 'ja', 'ko'];
+const messages = {
+  zh: {
+    loading: '加载中...',
+    mentor: '师傅',
+    apprentice: '徒弟',
+    mentorSystem: '师徒系统',
+    // 关系
+    myMentor: '我的师傅',
+    myApprentices: '我的徒弟',
+    noMentor: '暂无师傅',
+    noApprentices: '暂无徒弟',
+    // 操作
+    bindMentor: '拜师',
+    unbind: '解除关系',
+    inviteApprentice: '收徒',
+    viewProfile: '查看主页',
+    // 状态
+    statusActive: '正常',
+    statusExpired: '已失效',
+    bindTime: '绑定时间',
+    apprenticeCount: '徒弟数量',
+    // 奖励
+    rewards: '传承奖励',
+    rewardHistory: '奖励记录',
+    noRewards: '暂无奖励',
+    totalReward: '累计奖励',
+    pendingReward: '待领取',
+    claimReward: '领取奖励',
+    // 奖励类型
+    rewardBind: '拜师奖励',
+    rewardFirstCharge: '首充分成',
+    rewardTask: '任务传承',
+    rewardDaily: '日常活跃',
+    // 表单
+    enterMentorCode: '输入师傅邀请码',
+    codePlaceholder: '请输入师傅的邀请码',
+    myCode: '我的收徒码',
+    copyCode: '复制邀请码',
+    shareCode: '分享邀请码',
+    // 提示
+    bindSuccess: '拜师成功',
+    unbindConfirm: '确定解除师徒关系？',
+    unbindSuccess: '已解除关系',
+    copySuccess: '已复制到剪贴板',
+    // 规则
+    rules: '师徒规则',
+    rule1: '每人只能拜一位师傅',
+    rule2: '徒弟完成任务，师傅获得传承奖励',
+    rule3: '徒弟首充，师傅获得分成'
+  },
+  ja: {
+    loading: '読み込み中...',
+    mentor: '師匠',
+    apprentice: '弟子',
+    mentorSystem: '師弟システム',
+    // 关系
+    myMentor: '自分の師匠',
+    myApprentices: '自分の弟子',
+    noMentor: '師匠なし',
+    noApprentices: '弟子なし',
+    // 操作
+    bindMentor: '弟子入り',
+    unbind: '関係解除',
+    inviteApprentice: '弟子を取る',
+    viewProfile: 'プロフィールを見る',
+    // 状态
+    statusActive: '正常',
+    statusExpired: '無効',
+    bindTime: '紐付け日時',
+    apprenticeCount: '弟子数',
+    // 奖励
+    rewards: '伝承報酬',
+    rewardHistory: '報酬履歴',
+    noRewards: '報酬なし',
+    totalReward: '累計報酬',
+    pendingReward: '受け取り待ち',
+    claimReward: '報酬を受け取る',
+    // 奖励类型
+    rewardBind: '弟子入り報酬',
+    rewardFirstCharge: '初回チャージ配分',
+    rewardTask: 'タスク伝承',
+    rewardDaily: 'デイリーアクティブ',
+    // 表单
+    enterMentorCode: '師匠の招待コードを入力',
+    codePlaceholder: '師匠の招待コードを入力してください',
+    myCode: '自分の弟子入りコード',
+    copyCode: '招待コードをコピー',
+    shareCode: '招待コードをシェア',
+    // 提示
+    bindSuccess: '弟子入り成功',
+    unbindConfirm: '師弟関係を解除しますか？',
+    unbindSuccess: '関係を解除しました',
+    copySuccess: 'クリップボードにコピーしました',
+    // 规则
+    rules: '師弟ルール',
+    rule1: '弟子入りできる師匠は1人だけです',
+    rule2: '弟子がタスクを完了すると、師匠に伝承報酬が与えられます',
+    rule3: '弟子の初回チャージで、師匠に配分が与えられます'
+  },
+  ko: {
+    loading: '로딩 중...',
+    mentor: '스승',
+    apprentice: '제자',
+    mentorSystem: '사제 시스템',
+    // 关系
+    myMentor: '내 스승',
+    myApprentices: '내 제자',
+    noMentor: '스승 없음',
+    noApprentices: '제자 없음',
+    // 操作
+    bindMentor: '스승 모시기',
+    unbind: '관계 해제',
+    inviteApprentice: '제자 받기',
+    viewProfile: '프로필 보기',
+    // 状态
+    statusActive: '정상',
+    statusExpired: '무효화됨',
+    bindTime: '연결 시간',
+    apprenticeCount: '제자 수',
+    // 奖励
+    rewards: '전승 보상',
+    rewardHistory: '보상 기록',
+    noRewards: '보상 없음',
+    totalReward: '누적 보상',
+    pendingReward: '수령 대기',
+    claimReward: '보상 수령',
+    // 奖励类型
+    rewardBind: '스승 모시기 보상',
+    rewardFirstCharge: '첫 충전 보상',
+    rewardTask: '과제 전승',
+    rewardDaily: '일일 활성',
+    // 表单
+    enterMentorCode: '스승의 초대 코드 입력',
+    codePlaceholder: '스승의 초대 코드를 입력하세요',
+    myCode: '내 제자 코드',
+    copyCode: '초대 코드 복사',
+    shareCode: '초대 코드 공유',
+    // 提示
+    bindSuccess: '스승 모시기 성공',
+    unbindConfirm: '사제 관계를 해제하시겠습니까?',
+    unbindSuccess: '관계가 해제되었습니다',
+    copySuccess: '클립보드에 복사되었습니다',
+    // 规则
+    rules: '사제 규칙',
+    rule1: '스승은 한 명만 모실 수 있습니다',
+    rule2: '제자가 과제를 완료하면 스승에게 전승 보상이 주어집니다',
+    rule3: '제자의 첫 충전 시 스승이 보상을 받습니다'
+  },
+  en: {
+    loading: 'Loading...',
+    mentor: 'Mentor',
+    apprentice: 'Apprentice',
+    mentorSystem: 'Mentor System',
+    myMentor: 'My Mentor',
+    myApprentices: 'My Apprentices',
+    noMentor: 'No mentor yet',
+    noApprentices: 'No apprentices yet',
+    bindMentor: 'Find a Mentor',
+    unbind: 'Remove',
+    inviteApprentice: 'Invite',
+    viewProfile: 'View Profile',
+    statusActive: 'Active',
+    statusExpired: 'Expired',
+    bindTime: 'Bound on',
+    apprenticeCount: 'Apprentices',
+    rewards: 'Rewards',
+    rewardHistory: 'Reward History',
+    noRewards: 'No rewards',
+    totalReward: 'Total Rewards',
+    pendingReward: 'Pending',
+    claimReward: 'Claim',
+    rewardBind: 'Binding Bonus',
+    rewardFirstCharge: 'First Purchase',
+    rewardTask: 'Task Reward',
+    rewardDaily: 'Daily Active',
+    enterMentorCode: 'Enter Mentor Code',
+    codePlaceholder: 'Enter mentor invitation code',
+    myCode: 'My Invite Code',
+    copyCode: 'Copy Code',
+    shareCode: 'Share Code',
+    bindSuccess: 'Successfully bound',
+    unbindConfirm: 'Remove this relationship?',
+    unbindSuccess: 'Relationship removed',
+    copySuccess: 'Copied to clipboard',
+    rules: 'Rules',
+    rule1: 'You can only have one mentor',
+    rule2: 'Earn rewards when apprentices complete tasks',
+    rule3: 'Earn commission from apprentice purchases'
+  }
+};
+let currentLanguage = 'zh';
+function setLanguage(lang) {
+  if (SUPPORTED_LANGUAGES.includes(lang)) {
+    currentLanguage = lang;
+  }
+}
+function getLanguage() {
+  return currentLanguage;
+}
+function t(key, params) {
+  const msgs = messages[getLanguage()] || messages.zh;
+  let text = msgs[key] || key;
+  if (params) {
+    Object.keys(params).forEach(k => {
+      text = text.replace(new RegExp(`\\{${k}\\}`, 'g'), params[k]);
+    });
+  }
+  return text;
+}
+
+/**
+ * Mentor SDK - Context Provider
+ */
+
+const MentorContext = /*#__PURE__*/React.createContext(null);
+function MentorProvider({
+  children,
+  apiUrl,
+  token,
+  language = 'zh',
+  onBind,
+  onReward
+}) {
+  const [myMentor, setMyMentor] = React.useState(null);
+  const [myApprentices, setMyApprentices] = React.useState([]);
+  const [rewards, setRewards] = React.useState([]);
+  const [stats, setStats] = React.useState(null);
+  const [loading, setLoading] = React.useState(false);
+  const [error, setError] = React.useState(null);
+  React.useEffect(() => {
+    setLanguage(language);
+  }, [language]);
+  const handleError = React.useCallback(err => {
+    setError(err);
+    onError?.(err);
+  }, [onError]);
+  const bindMentor = React.useCallback(async mentorId => {
+    setLoading(true);
+    try {
+      const result = await mentorApi.bind(mentorId);
+      onBind?.(result);
+      return result;
+    } catch (err) {
+      handleError(err);
+      throw err;
+    } finally {
+      setLoading(false);
+    }
+  }, [handleError, onBind]);
+
+  // 加载我的师傅
+  const loadMyMentor = React.useCallback(async () => {
+    setLoading(true);
+    try {
+      const result = await mentorApi.getMyMentor();
+      setMyMentor(result);
+      return result;
+    } catch (err) {
+      handleError(err);
+    } finally {
+      setLoading(false);
+    }
+  }, [handleError]);
+
+  // 加载我的徒弟
+  const loadMyApprentices = React.useCallback(async (params = {}) => {
+    setLoading(true);
+    try {
+      const result = await mentorApi.getMyApprentices(params);
+      const items = result.items || result.data || result || [];
+      setMyApprentices(items);
+      return items;
+    } catch (err) {
+      handleError(err);
+    } finally {
+      setLoading(false);
+    }
+  }, [handleError]);
+
+  // 解除关系
+  const unbind = React.useCallback(async relationId => {
+    setLoading(true);
+    try {
+      await mentorApi.unbind(relationId);
+      await loadMyMentor();
+      await loadMyApprentices();
+    } catch (err) {
+      handleError(err);
+      throw err;
+    } finally {
+      setLoading(false);
+    }
+  }, [handleError, loadMyMentor, loadMyApprentices]);
+
+  // 加载奖励记录
+  const loadRewards = React.useCallback(async (params = {}) => {
+    try {
+      const result = await mentorApi.getRewards(params);
+      const items = result.items || result.data || result || [];
+      setRewards(items);
+      return items;
+    } catch (err) {
+      handleError(err);
+    }
+  }, [handleError]);
+
+  // 加载统计
+  const loadStats = React.useCallback(async () => {
+    try {
+      const result = await mentorApi.getStats();
+      setStats(result);
+      return result;
+    } catch (err) {
+      handleError(err);
+    }
+  }, [handleError]);
+  const value = {
+    myMentor,
+    myApprentices,
+    rewards,
+    stats,
+    loading,
+    error,
+    bindMentor,
+    loadMyMentor,
+    loadMyApprentices,
+    unbind,
+    loadRewards,
+    loadStats,
+    api: mentorApi
+  };
+  return /*#__PURE__*/React.createElement(MentorContext.Provider, {
+    value: value
+  }, children);
+}
+function useMentor() {
+  const context = React.useContext(MentorContext);
+  if (!context) {
+    throw new Error('useMentor must be used within a MentorProvider');
+  }
+  return context;
+}
+
+function MentorCard() {
+  return null;
+}
+
+function BindMentorForm() {
+  return null;
+}
+
+/**
+ * Mentor SDK - 类型定义
+ */
+
+const createDefaultRelation = {};
+const createDefaultReward = {};
+const MentorStatus = {};
+const RewardType = {};
+
+exports.BindMentorForm = BindMentorForm;
+exports.MentorApiClient = MentorApiClient;
+exports.MentorCard = MentorCard;
+exports.MentorProvider = MentorProvider;
+exports.MentorStatus = MentorStatus;
+exports.RewardType = RewardType;
+exports.SUPPORTED_LANGUAGES = SUPPORTED_LANGUAGES;
+exports.createDefaultRelation = createDefaultRelation;
+exports.createDefaultReward = createDefaultReward;
+exports.getLanguage = getLanguage;
+exports.mentorApi = mentorApi;
+exports.messages = messages;
+exports.setLanguage = setLanguage;
+exports.t = t;
+exports.useMentor = useMentor;
+//# sourceMappingURL=index.cjs.map