yichong-canva2 1.1.27

package/dist/types/login/context.d.ts

@@ -0,0 +1,76 @@
+import { default as React } from 'react';
+import { canUseError, CheckoutSessionOptions, TestMode, UserStatus } from './interface';
+/**
+ *
+ * @interface 上下文类型
+ * @property {UserStatus} userStatus 用户状态
+ * @property {() => void} updateUserStatus 更新用户状态
+ * @property {() => void} handleLogin 登录
+ * @property {number} credits 余额
+ * @property {() => number | null} getLimitUsage 获取月限额使用额度
+ * @property {boolean} isSubscribed 是否订阅
+ * @property {() => void} use 使用次数减少
+ * @property {() => boolean canUse 是否能使用
+ * @property {() => { error?: 'userStatus_error' | 'monthly_usage_limit' | 'no_credits', canUse: boolean }} canUseLimit 新版本增加了月度限额逻辑是否能使用
+ * @property {(options?: CheckoutSessionOptions) => Promise<UserStatus> | undefined} pollUserStatus 结账会话：打开外部定价页后调用；相对「打开前基线」检测订阅/额度变化；TTL 或 stopCurrentPolling 时补拉一次并 resolve（Promise 一定结束）；回侧栏不停止；登录前调用返回 undefined
+ * @property {() => string} getPricingLink 获取付费链接
+ * @property {() => void} updateTestMode 更新测试模式, 只有在开发环境下有效
+ */
+export interface YiChongCanvaContextType {
+    userStatus: UserStatus;
+    updateUserStatus: (user: Partial<UserStatus>) => void;
+    handleLogin: () => void;
+    credits: number;
+    getLimitUsage: () => number | null;
+    getMonthlyUsageLimit: () => number | null;
+    isSubscribed: boolean;
+    use: (cnt?: number, force?: boolean, notUpload?: boolean) => void;
+    canUse: (cnt?: number, force?: boolean) => boolean;
+    canUseLimit: (cnt?: number, force?: boolean) => {
+        error?: canUseError;
+        canUse: boolean;
+    };
+    isFreeUnlimited: () => boolean;
+    /**
+     * 结账会话（checkout session）。
+     * - 打开外部定价页（getPricingLink）后调用；无参调用使用默认参数（快 5s×30s → 慢 15s，TTL 5 分钟）
+     * - 成功判定相对「打开定价页前」的基线：出现/变更 subscription.detail、free_cnt 增加、可用额度增加
+     * - TTL 到期或 stopCurrentPolling() 时补拉一次 status 后 resolve —— Promise 一定会结束
+     * - 用户回到 Canva 侧栏（focus / visibilitychange）不会停止会话
+     * - 再次调用会先停掉上一轮会话，任何时刻只有一条轮询
+     * - 登录完成前调用返回 undefined（不是 Promise）
+     */
+    pollUserStatus: (options?: CheckoutSessionOptions) => Promise<UserStatus> | undefined;
+    getPricingLink: () => string;
+    updateTestMode: (m: TestMode) => void;
+    refreshUserStatus: () => Promise<UserStatus>;
+    hasClickedUpgrade: boolean;
+    setHasClickedUpgrade: (v: boolean) => void;
+    /** 停止当前结账会话：有会话则停止（补拉一次后让其 Promise resolve）并返回 true；无会话返回 false */
+    stopCurrentPolling: () => boolean;
+    updateCredits: (credits: number) => void;
+    loginStatus: "success" | "error" | "loading" | "idle";
+    manualLogin: (_retry?: number) => void;
+}
+/**
+ * 上下文
+ * @description 上下文
+ * @property {UserStatus} userStatus 用户状态
+ * @property {() => void} updateUserStatus 更新用户状态
+ * @property {() => void} handleLogin 登录
+ * @property {number} credits 余额
+ * @property {boolean} isSubscribed 是否订阅
+ * @property {() => void} use 使用次数减少
+ * @property {() => { error?: 'userStatus_error' | 'monthly_usage_limit' | 'no_credits', canUse: boolean }} canUse 是否能使用
+ * @property {() => void} pollUserStatus 轮询用户状态, 如果积分和订阅状态发生改变就会更新用户信息
+ * @property {() => string} getPricingLink 获取付费链接
+ * @property {() => void} updateTestMode 更新测试模式, 只有在开发环境下有效
+ * @property {() => void} refreshUserStatus 刷新用户状态
+ * @property {boolean} hasClickedUpgrade 是否点击过升级
+ * @property {() => void} setHasClickedUpgrade 设置是否点击过升级
+ * @property {() => void} stopCurrentPolling 停止当前轮询
+ * @property {() => void} updateCredits 更新积分
+ * @property {() => void} manualLogin 手动登录
+ * @property {"success" | "error" | "loading" | "idle"} loginStatus 登录状态
+ */
+export declare const YiChongCanvaContext: React.Context<YiChongCanvaContextType>;

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

@@ -0,0 +1,4 @@
+export { YiChongCanvaProvider } from './privider';
+export * from './interface';
+export * from './context';
+export * from './use_canva';

package/dist/types/login/interface.d.ts

@@ -0,0 +1,72 @@
+export interface UserStatus {
+    jwt?: string;
+    api_auth?: {
+        time: number;
+        expire_at: number;
+    };
+    profile?: {
+        id: string;
+        username: string;
+        email: string;
+        avatar: string;
+        token: string;
+        from_app: string;
+        expire_at: number;
+        usage_limits: {
+            free_limit: number;
+            monthly_usage_limit: number;
+        };
+    };
+    subscription?: {
+        detail?: {
+            ends_at: string | null | number;
+            name: string;
+        };
+        is_subscribed?: boolean;
+        free_cnt?: number;
+        monthly_usage_cnt?: number;
+        free_usage_cnt?: number;
+        on_trial?: number;
+    };
+    team_subscription?: {
+        detail: {
+            name: string;
+            ends_at: string | null | number;
+        };
+    };
+    drive?: {
+        fresh_token: string;
+    };
+    userId?: string;
+    planName?: 'Free' | 'Pro Monthly plan' | 'Pro Yearly plan' | 'Premium';
+}
+declare global {
+    interface Window {
+        pollUserSubscribe: () => void;
+        g_canva_token: string;
+        g_token: string;
+    }
+}
+/**
+ * 结账会话参数（pollUserStatus 可选入参，均有默认值，无参调用保持向后兼容）。
+ *
+ * 语义：打开外部定价页后进入一段有 TTL 的轮询会话 ——
+ * 快阶段每 fastIntervalMs 拉一次 status，持续 fastPhaseMs 后降频到 slowIntervalMs，
+ * 检测到「相对打开定价页前基线」的订阅/额度变化即成功；
+ * 会话满 sessionTtlMs 或手动 stopCurrentPolling() 时补拉一次 status 后 resolve。
+ * 注意：回到 Canva 侧栏（focus / visibilitychange）不会终止会话 ——
+ * Canva 拿不到定价页关闭事件，回侧栏往往表示定价页还开着。
+ */
+export interface CheckoutSessionOptions {
+    /** 快阶段轮询间隔，默认 5000ms */
+    fastIntervalMs?: number;
+    /** 快阶段持续时长，默认 30000ms */
+    fastPhaseMs?: number;
+    /** 慢阶段轮询间隔，默认 15000ms */
+    slowIntervalMs?: number;
+    /** 会话总时长（TTL），默认 300000ms（5 分钟），到期补刷一次并 resolve */
+    sessionTtlMs?: number;
+}
+export type TestMode = 'noTest' | 'credits' | 'subscribed' | 'expired';
+export type Mode = 'normal' | 'server_credits';
+export type canUseError = 'userStatus_error' | 'monthly_usage_limit' | 'no_credits' | undefined;

package/dist/types/login/login/apis/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 由token和appId获取用户唯一的id
+ * @param token canva颁发的token
+ * @param appId 当前应用的appId
+ * @returns
+ */
+declare function getUserIds(token: string, appId: string): Promise<any>;
+/**
+ * 利用id登录用户
+ * @param userId 获取到的用户唯一id
+ */
+declare function handleUserLoginByCanvaId(userId: string, productName?: string): Promise<any>;
+/**
+ * 由id获取通行证
+ * @param userId
+ * @param appName
+ * @returns
+ */
+declare function getPassport(userId: string, productName: string): Promise<any>;
+/**
+ * 由通行证获取用户信息
+ * @param passport
+ * @returns
+ */
+declare function getUserStatusByPassport(passport: string, productName: string): Promise<any>;
+declare const apis: {
+    getUserIds: typeof getUserIds;
+    handleUserLoginByCanvaId: typeof handleUserLoginByCanvaId;
+    getPassport: typeof getPassport;
+    getUserStatusByPassport: typeof getUserStatusByPassport;
+};
+export default apis;

package/dist/types/login/login/apis/request.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 请求json数据
+ * @param option RequestInit & { url: string }
+ * @returns
+ */
+declare const requestUrl: (option: RequestInit & {
+    url: string;
+}) => Promise<any>;
+export default requestUrl;

package/dist/types/login/login/interface.d.ts

@@ -0,0 +1,16 @@
+import { ReactNode } from 'react';
+import { UserStatus } from '../interface';
+/**
+ * @interface 登录组件props
+ */
+export interface UseCanvaLoginProps {
+    onLogin?: (user: UserStatus) => void;
+    appId: string;
+    children?: ReactNode;
+    productName: string;
+}
+export interface CanvaLoginContextProps {
+    userStatus?: UserStatus;
+    userId?: string;
+    onLogin?: (userStatus: (userStatus: UserStatus) => void) => void;
+}

package/dist/types/login/login/login.d.ts

@@ -0,0 +1,77 @@
+import { UserStatus } from './../interface';
+export declare function handleLogin({ appId, productName, }: LoginProps): Promise<UserStatus>;
+/**
+ * 订阅比较基线：打开定价页「之前」的用户状态快照。
+ * 由 Provider 在会话开始时用当时的 userStatus 生成（takeSubscribeBaseline），
+ * 不允许被轮询的第一轮响应覆盖 —— 否则打开前已付款的场景会漏检，
+ * 且 detail 为 undefined 时会误判成功（1.1.26 的现网 bug）。
+ */
+export interface SubscribeBaseline {
+    free_cnt: number | null;
+    detailJson: string | null;
+    available: number | null;
+}
+/**
+ * 从 UserStatus 拍订阅基线。
+ * detail 快照必须写成 `detail == null ? null : JSON.stringify(detail)`：
+ * `JSON.stringify(undefined) || null` 会把 undefined 折成 null，
+ * 而后续 `null !== JSON.stringify(undefined)` 恒为 true，导致免费用户第一轮就误判成功。
+ */
+export declare function takeSubscribeBaseline(userStatus: UserStatus): SubscribeBaseline;
+/**
+ * 用「原始响应体」计算可用额度的纯函数。
+ * 不要用 Provider 的 getLimitUsage()：它读的是 React state，轮询期间不会更新。
+ * 口径对齐 Provider：订阅生效 = 月额度剩余（clamp 到 >=0）+ 积分；否则 = 积分。
+ * monthly_usage_limit 为 -1（无限额度）时返回 null。
+ */
+export declare function computeAvailableLimit(userStatus: UserStatus): number | null;
+/**
+ * 默认的「相对基线是否已付费/到账」判断（对齐 Chrome 插件 loopSubscribe 思路）：
+ * 1. subscription.detail 出现或变化（订阅、换套餐、续费改 ends_at，JSON 全量比较）
+ * 2. free_cnt 变多（买积分包；只认「增加」——会话中在侧栏消耗积分导致的减少不算成功）
+ * 3. 可用额度比基线变大（月订用户 free_cnt 常为 0，只盯它会把会话打满）
+ * 注意：monthly_usage_cnt 自增（用量上报）不构成成功。
+ */
+export declare function isSubscribeChanged(current: UserStatus, baseline: SubscribeBaseline): boolean;
+/**
+ * 拉取 / 轮询用户信息。
+ *
+ * 两种模式（isSubscribe 区分）：
+ * - isSubscribe = false（handleLogin / refreshUserStatus）：拿到带 profile 的
+ *   userStatus 立刻 successCallback 并返回，行为与 1.1.26 一致
+ *   （1.1.26 会在 finally 里多睡一轮 3s 才 resolve，属实现缺陷，已去掉；请求次数不变）。
+ * - isSubscribe = true（结账会话）：相对 baseline 检测订阅/额度变化，变了才成功。
+ *   未传 baseline 时保持旧语义：用第一轮成功响应拍快照（但 detail 快照 bug 已修）。
+ *
+ * 结束方式：
+ * 1. 成功：successCallback + return userStatus
+ * 2. 手动停止（onStop 交出的函数被调用）：打断等待中的 sleep，return undefined（不算失败）
+ * 3. maxCount 次数耗尽或 maxDurationMs 到期：failCallback + throw
+ */
+export declare function getUserProfile({ maxCount, interval, maxDurationMs, productName, userId, successCallback, failCallback, isSubscribe, baseline, isChanged, onStop, }: UserProfileProps): Promise<UserStatus | undefined>;
+export interface UserProfileProps {
+    maxCount?: number;
+    interval?: number | (() => number);
+    maxDurationMs?: number;
+    productName: string;
+    userId: string;
+    successCallback?: (userStatus: UserStatus) => void;
+    failCallback?: () => void;
+    isSubscribe?: boolean;
+    baseline?: SubscribeBaseline;
+    isChanged?: (current: UserStatus, baseline: SubscribeBaseline) => boolean;
+    onStop?: (fn: () => void) => void;
+}
+export interface LoginProps {
+    callback?: (state: LoginState) => void;
+    appId: string;
+    productName: string;
+    requestConfig?: UserProfileProps;
+}
+export interface LoginState {
+    status: "finish" | "error" | "start" | "user_id";
+    data?: {
+        token?: string;
+        userId?: string;
+    };
+}

package/dist/types/login/privider.d.ts

@@ -0,0 +1,38 @@
+import { default as React } from 'react';
+import { Mode, TestMode, UserStatus } from './interface';
+/**
+ * @interface 参数
+ * @property {React.ReactNode} children 子节点
+ * @property {string} appId 应用ID
+ * @property {string} productName 产品名称
+ * @property {(userStatus: UserStatus) => void} onUpdateUserStatus 用户状态更新回调, 一般可以不用
+ * @property {number} freeTimes 免费次数, 默认为1
+ * @property {string} baseUrl 服务器地址
+ * @property {boolean} autoLogin 自动登录, 默认为true
+ */
+export interface YiChongCanvaProviderProps {
+    children?: React.ReactNode;
+    appId: string;
+    productName: string;
+    onUpdateUserStatus?: (userStatus: UserStatus) => void;
+    baseUrl: string;
+    autoLogin?: boolean;
+    testMode?: TestMode;
+    version: number;
+    mode?: Mode;
+    maxAvailablePoints?: number;
+    retry?: number;
+}
+/**
+ * YiChongCanvaProvider 全局登录,积分等方法提供
+ * @param {object} params0
+ * @param {children} params0.children 子元素
+ * @param {string} params0.appId 应用id
+ * @param {string} params0.productName 产品名称
+ * @param {Function} params0.onUpdateUserStatus 用户信息更新后的回调
+ * @param {string} params0.baseUrl 链接
+ * @param {boolean} params0.autoLogin 是否自动登录
+ * @param {string} params0.mode 测试模式
+ * @returns
+ */
+export declare const YiChongCanvaProvider: ({ children, appId, productName, onUpdateUserStatus, baseUrl, autoLogin, testMode: _testMode, version, mode, retry, maxAvailablePoints, }: YiChongCanvaProviderProps) => React.JSX.Element;

package/dist/types/login/use_canva.d.ts

@@ -0,0 +1,6 @@
+import { YiChongCanvaContextType } from './context';
+/**
+ * 全局钩子，用于获取上下文
+ * @returns
+ */
+export declare const useYiChongCanva: () => YiChongCanvaContextType;

package/dist/types/login/version.d.ts

@@ -0,0 +1,4 @@
+export interface AppVersion {
+    version: number;
+}
+export declare function getAppVersion(key: string): Promise<AppVersion>;

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "yichong-canva2",
+  "version": "1.1.27",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "lint": "eslint .",
+    "preview": "vite preview",
+    "publish": "npm publish"
+  },
+  "peerDependencies": {
+    "@canva/user": ">=2.1.0",
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "devDependencies": {
+    "@canva/user": "^2.2.0",
+    "@eslint/js": "^9.21.0",
+    "@types/lodash": "^4.17.16",
+    "@types/node": "^22.13.9",
+    "@types/react": "^19.0.10",
+    "@types/react-dom": "^19.0.4",
+    "@vitejs/plugin-react": "^4.3.4",
+    "eslint": "^9.21.0",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-react-refresh": "^0.4.19",
+    "globals": "^15.15.0",
+    "lodash": "^4.17.21",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "rollup-plugin-terser": "^7.0.2",
+    "typescript": "~5.7.3",
+    "typescript-eslint": "^8.24.1",
+    "vite": "^6.2.0",
+    "vite-plugin-dts": "^4.5.3"
+  }
+}