@docoi/mys-sdk 1.0.3 → 1.2.0

package/dist/api/router/routes.d.ts

@@ -0,0 +1,772 @@
+import { NavigationCall } from '../../types';
+/** openScheme 只接受这个协议，避免把 javascript: 等任意地址交给 location.href */
+export declare const DAOKE_SCHEME = "daoke://";
+/** 协议字段 */
+export interface FieldDef {
+    /** 协议字段名 */
+    key: string;
+    /** 是否必传 */
+    required?: boolean;
+    /** 枚举：语义值 → 协议值 */
+    enum?: Record<string, string>;
+    /** 布尔值，编码为 'true' / 'false' */
+    bool?: boolean;
+}
+interface RouteMeta {
+    /** daoke:// type */
+    type: number;
+    /** 页面名称 */
+    name: string;
+    /** daoke 链接起始版本 */
+    since?: string;
+}
+/** 运行时使用的宽松类型 */
+export type RouteDef = RouteMeta & {
+    fields: Record<string, FieldDef>;
+};
+/** navigateTo 页面 */
+export declare const PAGE_ROUTES: {
+    joinCirclePage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            inviteCode: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    dynamicDetailPage: {
+        type: number;
+        name: string;
+        fields: {
+            dynamicId: {
+                key: string;
+                required: true;
+            };
+            commentId: {
+                key: string;
+            };
+        };
+    };
+    circleHomePage: {
+        type: number;
+        name: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            action: {
+                key: string;
+                enum: {
+                    publish: string;
+                };
+            };
+            publishType: {
+                key: string;
+            };
+            relationType: {
+                key: string;
+                enum: {
+                    apprentice: string;
+                    graduate: string;
+                    intimacyShare: string;
+                    takeApprentice: string;
+                };
+            };
+            imageUrl: {
+                key: string;
+            };
+        };
+    };
+    topicPage: {
+        type: number;
+        name: string;
+        fields: {
+            topicId: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    guideCatalogPage: {
+        type: number;
+        name: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            channelId: {
+                key: string;
+                required: true;
+            };
+            catalogId: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    userHomePage: {
+        type: number;
+        name: string;
+        fields: {
+            userId: {
+                key: string;
+                required: true;
+            };
+            giftId: {
+                key: string;
+            };
+        };
+    };
+    groupChatPage: {
+        type: number;
+        name: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            groupId: {
+                key: string;
+                required: true;
+            };
+            groupName: {
+                key: string;
+            };
+        };
+    };
+    joinGroupPage: {
+        type: number;
+        name: string;
+        fields: {
+            inviteCode: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    homePage: {
+        type: number;
+        name: string;
+        fields: {
+            tab: {
+                key: string;
+                enum: {
+                    official: string;
+                    community: string;
+                };
+            };
+            serverId: {
+                key: string;
+            };
+            channelId: {
+                key: string;
+            };
+        };
+    };
+    coinRechargePage: {
+        type: number;
+        name: string;
+        fields: {};
+    };
+    myPublishPage: {
+        type: number;
+        name: string;
+        fields: {};
+    };
+    gamePushSettingPage: {
+        type: number;
+        name: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    myFavoritePage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    douyinMallPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    activityCenterPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            tab: {
+                key: string;
+                enum: {
+                    welfare: string;
+                    activity: string;
+                };
+            };
+        };
+    };
+    gameSubscribePage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    privateChatPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            userId: {
+                key: string;
+                required: true;
+            };
+            nickName: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    browseHistoryPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    profileEditPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    likeListPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            dynamicId: {
+                key: string;
+                required: true;
+            };
+            publishType: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    adPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            url: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    coinDetailPage: {
+        type: number;
+        name: string;
+        fields: {};
+    };
+    miniGamesPage: {
+        type: number;
+        name: string;
+        fields: {};
+    };
+    bindGamePage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            gameName: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    playerReportPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            objectId: {
+                key: string;
+                required: true;
+            };
+            objectType: {
+                key: string;
+                required: true;
+                enum: {
+                    user: string;
+                    circle: string;
+                    comment: string;
+                    trends: string;
+                    message: string;
+                };
+            };
+            conversationId: {
+                key: string;
+            };
+            serverId: {
+                key: string;
+            };
+        };
+    };
+    addCustomEmojiPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    dynamicPublishPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            channelId: {
+                key: string;
+            };
+            publishType: {
+                key: string;
+            };
+        };
+    };
+};
+/** navigateTo 页面 + switchTab / openWebview 的路由，key 为语义名 */
+export declare const ROUTES: {
+    tab: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            tab: {
+                key: string;
+                required: true;
+                enum: {
+                    home: string;
+                    discover: string;
+                    message: string;
+                    mine: string;
+                };
+            };
+            subTab: {
+                key: string;
+                enum: {
+                    friends: string;
+                    square: string;
+                    comic: string;
+                };
+            };
+            fromMbtiShare: {
+                key: string;
+                bool: true;
+            };
+        };
+    };
+    webview: {
+        type: number;
+        name: string;
+        fields: {
+            url: {
+                key: string;
+                required: true;
+            };
+            type: {
+                key: string;
+                required: true;
+                enum: {
+                    normal: string;
+                    mini: string;
+                    dynamic: string;
+                    immersive: string;
+                };
+            };
+            isUpdateApp: {
+                key: string;
+                bool: true;
+            };
+        };
+    };
+    transparentWebview: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            url: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    joinCirclePage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            inviteCode: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    dynamicDetailPage: {
+        type: number;
+        name: string;
+        fields: {
+            dynamicId: {
+                key: string;
+                required: true;
+            };
+            commentId: {
+                key: string;
+            };
+        };
+    };
+    circleHomePage: {
+        type: number;
+        name: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            action: {
+                key: string;
+                enum: {
+                    publish: string;
+                };
+            };
+            publishType: {
+                key: string;
+            };
+            relationType: {
+                key: string;
+                enum: {
+                    apprentice: string;
+                    graduate: string;
+                    intimacyShare: string;
+                    takeApprentice: string;
+                };
+            };
+            imageUrl: {
+                key: string;
+            };
+        };
+    };
+    topicPage: {
+        type: number;
+        name: string;
+        fields: {
+            topicId: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    guideCatalogPage: {
+        type: number;
+        name: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            channelId: {
+                key: string;
+                required: true;
+            };
+            catalogId: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    userHomePage: {
+        type: number;
+        name: string;
+        fields: {
+            userId: {
+                key: string;
+                required: true;
+            };
+            giftId: {
+                key: string;
+            };
+        };
+    };
+    groupChatPage: {
+        type: number;
+        name: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            groupId: {
+                key: string;
+                required: true;
+            };
+            groupName: {
+                key: string;
+            };
+        };
+    };
+    joinGroupPage: {
+        type: number;
+        name: string;
+        fields: {
+            inviteCode: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    homePage: {
+        type: number;
+        name: string;
+        fields: {
+            tab: {
+                key: string;
+                enum: {
+                    official: string;
+                    community: string;
+                };
+            };
+            serverId: {
+                key: string;
+            };
+            channelId: {
+                key: string;
+            };
+        };
+    };
+    coinRechargePage: {
+        type: number;
+        name: string;
+        fields: {};
+    };
+    myPublishPage: {
+        type: number;
+        name: string;
+        fields: {};
+    };
+    gamePushSettingPage: {
+        type: number;
+        name: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    myFavoritePage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    douyinMallPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    activityCenterPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            tab: {
+                key: string;
+                enum: {
+                    welfare: string;
+                    activity: string;
+                };
+            };
+        };
+    };
+    gameSubscribePage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    privateChatPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            userId: {
+                key: string;
+                required: true;
+            };
+            nickName: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    browseHistoryPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    profileEditPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    likeListPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            dynamicId: {
+                key: string;
+                required: true;
+            };
+            publishType: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    adPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            url: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    coinDetailPage: {
+        type: number;
+        name: string;
+        fields: {};
+    };
+    miniGamesPage: {
+        type: number;
+        name: string;
+        fields: {};
+    };
+    bindGamePage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            gameName: {
+                key: string;
+                required: true;
+            };
+        };
+    };
+    playerReportPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            objectId: {
+                key: string;
+                required: true;
+            };
+            objectType: {
+                key: string;
+                required: true;
+                enum: {
+                    user: string;
+                    circle: string;
+                    comment: string;
+                    trends: string;
+                    message: string;
+                };
+            };
+            conversationId: {
+                key: string;
+            };
+            serverId: {
+                key: string;
+            };
+        };
+    };
+    addCustomEmojiPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {};
+    };
+    dynamicPublishPage: {
+        type: number;
+        name: string;
+        since: string;
+        fields: {
+            serverId: {
+                key: string;
+                required: true;
+            };
+            channelId: {
+                key: string;
+            };
+            publishType: {
+                key: string;
+            };
+        };
+    };
+};
+export type RouteKey = keyof typeof ROUTES;
+/** daoke type → 路由，未登记的 type 返回 undefined */
+export declare function routeByType(type: string): {
+    key: RouteKey;
+    route: RouteDef;
+} | undefined;
+export type Query = Record<string, string>;
+/** daoke 链接 */
+export interface DaokeLink {
+    /** daoke://page?... */
+    url: string;
+    /** 协议 query，type 为数字字符串 */
+    query: Query;
+}
+/** 跳转参数校验失败，由 API 层转为 PARAMS_ERROR */
+export declare class ParamError extends Error {
+}
+/** daoke://page?... → query，不是 daoke 链接或缺少数字 type 时返回 null */
+export declare function parseLink(url: unknown): Query | null;
+/** 跳转调用 → daoke 链接，参数错误抛出 ParamError */
+export declare function toLink(call: NavigationCall): DaokeLink;
+export {};