@hylid/types 0.0.2-dev.1

package/README.md

@@ -0,0 +1,17 @@
+# @hylid/env
+
+## Install
+
+```bash
+npm i @hylid/env --save
+```
+
+## API
+
+```ts
+import { getAppEnv, getPlatformEnv, getAppName, getPlatformName, APP, PLATFORM } from '@hylid/env';
+```
+
+## License
+
+MIT

package/lib/common.d.ts

@@ -0,0 +1,27 @@
+export declare type PickAttr<Attr extends keyof T, T = any> = {
+    [P in keyof T]: T[Attr];
+}[keyof T];
+export declare type Common = Record<string, any>;
+export declare type Callback<T> = (result?: T) => void;
+/**
+ * jsapi 类型
+ * @enum {string}
+ * @memberof JsApiType
+ * @property {string} async 参数有回调函数的异步 JSAPI（如: my.getSystemInfo）
+ * @property {string} sync 参数无回调函数的不同 JSAPI（如: my.getSystemInfoSync）
+ * @property {string} callback 参数是回调函数的 JSAPI（如: my.onAppShow）
+ * @property {string} attribute 访问 my 对象上的属性（如: my.SDKVersion）套壳 H5 only
+ */
+export declare type JsApiType = 'async' | 'sync' | 'callback' | 'attribute';
+export interface GetGeneralAppInfo {
+    (): {
+        walletLogo: string;
+        walletName: string;
+        appIcon?: string;
+        iosDownloadLink: string;
+        androidDownloadLink: string;
+        iOSAppId: string;
+        androidAppId: string;
+        pspId: string;
+    };
+}

package/lib/common.js

@@ -0,0 +1 @@
+export {};

package/lib/custom/appLink.d.ts

@@ -0,0 +1,32 @@
+export declare type AppLinkParams = {
+    /** 小程序id / 应用id */
+    appId: string;
+    /** 唤端的 h5 页面
+     * - 如果为字符串，则直接使用该字符串作为 url，会拼接为 `${page}?url=${url}`
+     * - 如果为对象，则根据对象中的 mode 和 key 来拼接 url
+     * - 如果为 false，则不拼接 url
+     */
+    url: string | {
+        /** 固定为 pageQuery, 表示自动拼接到 pageQuery 中，如：
+         * page = '/pages/index/index' 时，会拼接为 `/pages/index/index?${key}=${value}`
+         */
+        mode: 'pageQuery';
+        /** 配置 url 拼接参数的 key 值, mode 为 pageQuery 时,
+         * 若 page = '/pages/index/index'，会拼接为 `/pages/index/index?${key}=${value}`
+         */
+        key: string;
+        /** 配置 url 拼接参数的 value 值, mode 为 pageQuery 时,
+         * 若 page = '/pages/index/index'，会拼接为 `/pages/index/index?${key}=${value}`
+         */
+        value: string;
+    } | false;
+    /** 小程序 page, 不传默认为 /pages/index/index */
+    page?: string;
+    /** 应用的 query 信息 **注意不是pageQuery** */
+    query?: Record<string, any>;
+    /** 小程序的 debug 版本信息 */
+    debugConfig?: {
+        version: string;
+        token?: string;
+    };
+};

package/lib/custom/appLink.js

@@ -0,0 +1 @@
+export {};

package/lib/custom/index.d.ts

@@ -0,0 +1,5 @@
+import { AppLinkParams } from './appLink';
+export interface HyCustomJSAPI {
+    getCallAppLink(params: AppLinkParams): string;
+    getAppScanLink(params: AppLinkParams): string;
+}

package/lib/custom/index.js

@@ -0,0 +1 @@
+export {};

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+export * from './common';
+export * from './jsapi';
+export * from './mp';
+export * from './custom';
+declare global {
+    interface Window {
+        my: any;
+        AlipayJSBridge: any;
+        __hylid_jsapi__: any;
+    }
+}

package/lib/index.js

@@ -0,0 +1,4 @@
+export * from "./common";
+export * from "./jsapi";
+export * from "./mp";
+export * from "./custom";

package/lib/jsapi.d.ts

@@ -0,0 +1,250 @@
+import { Common, PickAttr } from './common';
+export declare namespace AliJsApi {
+    type AlertArgs = {
+        title?: string;
+        message?: string;
+        align?: string;
+        button?: string;
+    };
+    type ConfirmArgs = {
+        title?: string;
+        message?: string;
+        align?: string;
+        okButton?: string;
+        cancelButton?: string;
+    };
+    type GetAuthCodeArgs = {
+        scopes?: string | string[];
+        appId: string;
+        showErrorTip?: boolean;
+    };
+    type GetCurrentLocationArgs = {
+        bizType: string;
+        requestType?: number;
+        cacheTimeout?: number;
+        timeout?: number;
+    };
+    type GetCurrentLocationReturns = {
+        error: number;
+        errorMessage: string;
+        latitude: number;
+        longitude: number;
+        accuracy: number;
+        country: string;
+        countryCode: string;
+        province: string;
+        city: string;
+        cityAdcode: string;
+        district: string;
+        districtAdcode: string;
+        streetNumber: {
+            street: string;
+            number: number;
+        };
+        pois: {
+            name: string;
+            address: string;
+        }[];
+        highAccuracyClosed: boolean;
+    };
+    type GetAPDataStorageArgs = {
+        key: string;
+        business?: string;
+        type?: 'user' | 'common';
+    };
+    type GetAPDataStorageReturns = {
+        data: string;
+        errorMessage: string;
+    };
+    type GetSystemInfoReturns = {
+        model: string;
+        pixelRatio: number;
+        windowWidth: number;
+        windowHeight: number;
+        language: string;
+        version: string;
+    };
+    type PopToArgs = {
+        url?: string;
+        urlPattern?: string;
+        index?: number;
+        data?: Common;
+    };
+    type PushWindowArgs = {
+        url: string;
+        data?: Common;
+        params?: Common;
+    };
+    type HttpRequestArgs = {
+        url: string;
+        headers?: Common;
+        method?: 'GET' | 'POST';
+        data?: Common | string;
+        timeout?: number;
+        dataType?: 'json' | 'text' | 'base64' | ({} & string);
+    };
+    type HttpRequestReturns = {
+        data: string;
+        status: number;
+        headers: Common;
+    };
+    type SetTitleArgs = {
+        title?: string;
+        subtitle?: string;
+        image?: string;
+    };
+    type SetBarBottomLineColorArgs = {
+        color: number;
+    };
+    type SetTitleColorArgs = {
+        color: number;
+        reset?: boolean;
+        resetTransparent?: boolean;
+    };
+    type SetAPDataStorageArgs = GetAPDataStorageArgs & {
+        value: string;
+    };
+    type ShowAuthGuideArgs = {
+        bizType: string;
+        authType: string;
+        issue?: string;
+        source?: string;
+        option?: string;
+    };
+    type ShowLoadingArgs = {
+        content?: string;
+        delay?: number;
+    };
+    type ToastArgs = {
+        content: string;
+        type?: 'none' | 'success' | 'fail' | 'exception' | ({} & string);
+        duration?: number;
+        xOffset?: number;
+        yOffset?: number;
+    };
+    type TradePayArgs = {
+        tradeNO?: string;
+        partnerID?: string;
+        bizType?: string;
+        bizSubType?: string;
+        bizContext?: string;
+        orderStr?: string;
+        paymentUrl?: string;
+        flowType?: 'a+' | 'local' | '';
+    };
+    type ActionSheetArgs = {
+        title?: string;
+        btns: string[];
+        cancelBtn?: string;
+        destructiveBtnIndex?: number;
+        fn?: (v: any) => void;
+    };
+    type SetTabBarArgs = {
+        actionType: string;
+    };
+    interface Api {
+        alert(args?: AlertArgs): any;
+        clearTinyLocalStorage(args?: Common): any;
+        confirm(args?: ConfirmArgs): any;
+        getAuthCode(args?: GetAuthCodeArgs): {
+            authCode: string;
+        };
+        getClipboard(args?: Common): any;
+        getCurrentLocation(args?: GetCurrentLocationArgs): GetCurrentLocationReturns;
+        getNetworkType(): {
+            networkInfo: string;
+        };
+        getAPDataStorage(args: GetAPDataStorageArgs): GetAPDataStorageReturns;
+        getSystemInfo(): GetSystemInfoReturns;
+        hideKeyboard(): void;
+        hideLoading(args?: {
+            page: number;
+        }): void;
+        hideTitleLoading(): void;
+        hideToast(args?: Common): any;
+        popTo(args?: PopToArgs): any;
+        pushWindow(args?: PushWindowArgs): any;
+        removeTinyLocalStorage(args?: {
+            key: string;
+        }): any;
+        httpRequest(args: HttpRequestArgs): HttpRequestReturns;
+        setClipboard(args: {
+            text: string;
+        }): any;
+        setTitle(args?: SetTitleArgs): any;
+        setBarBottomLineColor(args?: SetBarBottomLineColorArgs): any;
+        setTitleColor(args?: SetTitleColorArgs): any;
+        setAPDataStorage(args?: SetAPDataStorageArgs): any;
+        showAuthGuide(args?: ShowAuthGuideArgs): {
+            shown: boolean;
+        };
+        showLoading(args?: ShowLoadingArgs): any;
+        showTitleLoading(): void;
+        toast(args: ToastArgs): void;
+        tradePay(args: TradePayArgs): {
+            resultCode: string;
+        };
+        getImageInfo(args?: Common): void;
+        multiLevelSelect(args?: Common): void;
+        navigateBackMiniProgram(args?: Common): void;
+        navigateToMiniProgram(args?: Common): void;
+        previewImage(args?: Common): void;
+        saveImage(args?: Common): void;
+        setOptionMenu(args?: Common): void;
+        chooseImage(args?: Common): void;
+        actionSheet(args?: ActionSheetArgs): void;
+        setTabBar(args?: SetTabBarArgs): void;
+        switchTab(args?: {
+            url: string;
+        }): void;
+        firePullToRefresh(): void;
+        restorePullToRefresh(): void;
+        datePicker(args: any): void;
+        saveFile(args?: any): void;
+        uploadFile(args?: any): void;
+        downloadFile(args?: any): void;
+        watchShake(args?: any): void;
+        connectSocket(args?: any): void;
+        onSocketOpen(args?: any): void;
+        offSocketOpen(args?: any): void;
+        onSocketError(args?: any): void;
+        offSocketError(args?: any): void;
+        sendSocketMessage(args?: any): void;
+        onSocketMessage(args?: any): void;
+        offSocketMessage(args?: any): void;
+        closeSocket(args?: any): void;
+        onSocketClose(args?: any): void;
+        offSocketClose(args?: any): void;
+        onAccelerometerChange(args?: any): void;
+        offAccelerometerChange(args?: any): void;
+        onCompassChange(args?: any): void;
+        offCompassChange(args?: any): void;
+        connectBLEDevice(args?: Common): void;
+        disconnectBLEDevice(args?: Common): void;
+        getBLEDeviceCharacteristics(args?: Common): void;
+        getBLEDeviceServices(args?: Common): void;
+        notifyBLECharacteristicValueChange(args?: Common): void;
+        offBLECharacteristicValueChange(args?: Common): void;
+        offBLEConnectionStateChanged(args?: Common): void;
+        onBLECharacteristicValueChange(args?: Common): void;
+        onBLEConnectionStateChanged(args?: Common): void;
+        readBLECharacteristicValue(args?: Common): void;
+        writeBLECharacteristicValue(args?: Common): void;
+        openBluetoothAdapter(args?: Common): void;
+        closeBluetoothAdapter(args?: Common): void;
+        getBluetoothAdapterState(args?: Common): void;
+        startBluetoothDevicesDiscovery(args?: Common): void;
+        stopBluetoothDevicesDiscovery(args?: Common): void;
+        getBluetoothDevices(args?: Common): void;
+        getConnectedBluetoothDevices(args?: Common): void;
+        onBluetoothDeviceFound(args?: Common): void;
+        offBluetoothDeviceFound(args?: Common): void;
+        onBluetoothAdapterStateChange(args?: Common): void;
+        offBluetoothAdapterStateChange(args?: Common): void;
+        getFileInfo(args?: Common): void;
+        openDocument(args?: Common): void;
+    }
+}
+export declare type PickJSAttr<Attr extends keyof AliJsApi.Api> = PickAttr<Attr, AliJsApi.Api>;
+export declare type PickJSArgs<Attr extends keyof AliJsApi.Api = any> = Parameters<PickJSAttr<Attr>>[0];
+export declare type PickJSReturns<Attr extends keyof AliJsApi.Api> = ReturnType<PickJSAttr<Attr>>;

package/lib/jsapi.js

@@ -0,0 +1 @@
+export {};

package/lib/mp.d.ts

@@ -0,0 +1,310 @@
+/// <reference types="miniprogram" />
+import { PickAttr, Common } from './common';
+export interface AddFatigueActionArgs extends AsyncCallback<any> {
+    deliverId?: string;
+    spaceCode?: string;
+    action?: string;
+}
+export interface IRPCArgs {
+    operationType: string;
+    requestData: string | unknown[];
+    headers?: Record<string, any>;
+    gateway?: string;
+    compress?: boolean;
+    disableLimitView?: boolean;
+    timeout?: number;
+    getResponse?: boolean;
+    workspaceId?: string;
+}
+export interface getCurrentPagesOptions {
+    payload?: Record<string, any>;
+    success: (res: {
+        route: string;
+    }[]) => void;
+    fail: (err: any) => void;
+}
+export interface AsyncCallback<T = any> {
+    success?: ((res: T) => void) | undefined;
+    fail?: ((err: AsyncCallbackFailObject) => void) | undefined;
+    complete?: ((res?: any) => any) | undefined;
+}
+export interface MPApi extends Omit<MiniprogramApi, 'request'> {
+    authorize: (opt: any) => void;
+    getAuthUserInfo: (opt: any) => void;
+    crossPay(args?: TradePayArgs): void;
+    addFatigueAction(args?: AddFatigueActionArgs): void;
+    appxrpc(args?: {
+        reqeustData: any;
+    }): void;
+    batchQueryCdpSpaceInfo(args?: any): void;
+    exitApp(args?: any): void;
+    getAppToken(args?: any): void;
+    getComponentAuth(args?: any): void;
+    getPaymentCode(args?: any): void;
+    getPhoneNumber(args?: any): void;
+    inquireQuote(args?: any): void;
+    isInstalledApp(args?: any): void;
+    navigateToBizScene(args: {
+        sceneCode: string;
+        param?: {
+            scheme?: string;
+            [key: string]: any;
+        };
+    } & AsyncCallback<void>): void;
+    paySignCenter(args?: any): void;
+    rpc(args: IRPCArgs & AsyncCallback<{
+        headers: Record<string, string>;
+        resData: object;
+    }>): void;
+    APRegionRPC(args?: any): void;
+    startApp(args?: any): void;
+    startBizService(args?: any): void;
+    thirdPartyAuthForAc(args?: any): void;
+    openSchemeWithBacking(args?: any): void;
+    uploadApdidToken(args?: any): void;
+    apDisableJSAPI(args?: any): void;
+    regionFetchAllApps(args?: any): void;
+    regionSearchAppsByKeywords(args?: any): void;
+    setOptionMenu(args?: Common & AsyncCallback<any>): void;
+    getLaunchOptionsSync(): any;
+    getStorageInfo(args?: any): void;
+    getStorageInfoSync(args?: any): void;
+    showSharePanel(args?: any): void;
+    postMessage(args?: any): void;
+    onMessage(args?: any): void;
+    canIUse(args: string): boolean;
+    SDKVersion: any;
+    hideOptionButton(args?: any): void;
+    getCurrentLanguage(): string;
+    openURL(args?: Common): Promise<void>;
+    getAppId(args: AsyncCallback<{
+        appId: string;
+    }>): void;
+    getCurrentPages(args: getCurrentPagesOptions): void;
+    getSDKVersion(args: AsyncCallback<string>): void;
+    request: (args: {
+        url: string;
+        headers?: {
+            [key: string]: string;
+        } | undefined;
+        method?: 'GET' | 'POST' | undefined;
+        data?: any;
+        timeout?: number | undefined;
+        dataType?: 'json' | 'text' | 'base64' | 'arraybuffer' | undefined;
+    } & AsyncCallback<{
+        data: any;
+        status: number;
+        headers: any;
+    }>) => void;
+    createWithoutAuthRpc: (args: {
+        appId?: string;
+        workspaceId?: string;
+        defaultGateway: string;
+        defaultHeaders?: Record<string, string>;
+        request: PickMPAttr<'request'>;
+    }) => PickPromiseAttr<PickMPAttr<'rpc'>>;
+    rpcWithAuth: PickMPAttr<'rpc'>;
+    rpcWithAuthAPlus: PickMPAttr<'rpc'>;
+    defineRuntimeConfig: (args: Record<string, any>) => Record<string, any>;
+    getAuthCode: (args: {
+        scopes: string | string[];
+        appId?: string;
+    } & AsyncCallback<GetAuthCodeCallbackValue>) => void;
+    easyShare: (args: {
+        bizType: string;
+        title: string;
+        desc: string;
+        searchTips?: string;
+        iconUrl?: string;
+        icon?: string;
+        imageUrl?: string;
+        image?: string;
+        url: string;
+    } & AsyncCallback<{
+        succeed: boolean;
+        channelName: string;
+    }>) => void;
+    homeAddAppToMyApps: (args: {
+        appId: string;
+    }) => void;
+    homeCanAddAppToMyApps: (args: {
+        appId: string;
+    } & AsyncCallback<{
+        canAddAppToMyApps: boolean;
+    }>) => void;
+    removeNotifyListener: (args: {
+        name: string;
+    } & AsyncCallback<void>) => void;
+    addNotifyListener: (args: {
+        name: string;
+        keep?: boolean;
+        callback?: (res: any) => void;
+    } & AsyncCallback<any>) => void;
+    postNotification: (args: {
+        name: string;
+        data: object;
+    } & AsyncCallback<void>) => void;
+    openWebURL: (args: {
+        url: string;
+        path?: string;
+    }) => Promise<void>;
+    openInApp: (args: {
+        url: string;
+        path?: string;
+    }) => Promise<void>;
+    openOtherApp: (args: {
+        appId: string;
+        path?: string;
+        launchParams?: Record<string, any>;
+    }) => Promise<void>;
+    openInBrowser: (args: {
+        url: string;
+        path?: string;
+    }) => Promise<void>;
+    openPayCodePage: () => Promise<void>;
+    openApPayCodePage: () => Promise<void>;
+    openScanPage: () => Promise<void>;
+    getMainSelectedCity: (args: AsyncCallback<{
+        fullName: string;
+        enName: string;
+        name: string;
+        code: string;
+        chineseMainLand: boolean;
+        isManualSelected: boolean;
+        settingTime: number;
+    }>) => void;
+    chooseDistrict: (args: {
+        mode?: 0 | 1 | 2;
+        src?: string;
+        mainTitle?: string;
+        mainHeadList?: Array<HeadModel>;
+        mainNormalList?: Array<ItemModel>;
+        mainMergeOptions?: Record<string, string>;
+        seniorTitle?: string;
+        seniorPageList?: Array<{
+            title: string;
+            headList?: Array<HeadModel>;
+            normalList?: Array<ItemModel>;
+        }>;
+    } & AsyncCallback<{
+        name: string;
+        adCode: string;
+        ext: string;
+    }>) => void;
+    popWindow: () => void;
+    setTransparentTitle: (args: {
+        transparentTitle: 'none' | 'auto' | 'always' | 'custom';
+    } & AsyncCallback<{
+        success: boolean;
+    }>) => void;
+    getLocation: (args: {
+        bizType?: string;
+        requestType?: number;
+        timeout?: number;
+        horizontalAccuracy?: number;
+    } & GetLocationArgs) => void;
+    showAuthGuide: (args: AsyncCallback<{
+        /**
+         * When shown is true, it indicates the permission guide
+         * pop-up will be shown; when it is false, it indicates
+         * the user has allowed the permission.
+         */
+        shown: boolean;
+    }> & {
+        authType: string;
+        bizType?: string;
+    }) => void;
+    getRunScene: (args: AsyncCallback<{
+        envVersion: 'develop' | 'trial' | 'release';
+    }>) => void;
+    setCanPullDown: (args: {
+        canPullDown: boolean;
+    } & AsyncCallback<void>) => void;
+    chooseFileFromDisk: (args: AsyncCallback<{
+        success: boolean;
+        apFilePath: string;
+    }> & {
+        appId?: string;
+    }) => void;
+    chooseVideo: (args: AsyncCallback<{
+        filePath: string;
+        duration: number;
+        size: number;
+        height: number;
+        width: number;
+        tempFilePath: string;
+    }> & {
+        sourceType?: string[];
+        compressed?: boolean;
+        maxDuration?: number;
+        camera?: string;
+    }) => void;
+    compressImage: (args: AsyncCallback<{
+        apFilePaths: string[];
+    }> & {
+        apFilePaths: string[];
+        compressLevel?: number;
+        compressedWidth?: number;
+        compressedHeight?: number;
+        maxWidth?: number;
+        maxHeight?: number;
+    }) => void;
+    setTabBarItem: (args: {
+        index?: number;
+        text: string;
+        iconPath: string;
+        selectedIconPath: string;
+    } & AsyncCallback<void>) => void;
+    showTabBar: (args: {
+        animation?: boolean;
+    } & AsyncCallback<void>) => void;
+    hideBackHome: () => void;
+}
+export declare type HeadModel = {
+    /**
+     * 区块名，如“热门城市”。
+     */
+    title?: string;
+    /**
+     * 模块类型。
+     *  0: 常规城市。
+     *  1: 定位模块。
+     *  2: 展示支付宝提供的热门城市模块。
+     */
+    type?: 0 | 1 | 2;
+    /**
+     * 区块城市列表。不支持嵌套。
+     */
+    list?: Array<ItemModel>;
+};
+export declare type ItemModel = {
+    /**
+     * 城市名。
+     */
+    name: string;
+    /**
+     * 行政区划代码。不同行政区域对应的代码可查看 https://www.mca.gov.cn/mzsj/xzqh/1980/2019/202002281436.html
+     */
+    adCode: string;
+    /**
+     * 城市名对应拼音拼写，方便用户检索。
+     */
+    spell?: string;
+    /**
+     * 子标题。
+     */
+    appendName?: string;
+    /**
+     * 额外信息。
+     */
+    ext?: string;
+    /**
+     * 支持级联，自定义次级城市列表。
+     */
+    subList?: Array<ItemModel>;
+};
+export declare type PickMPAttr<Attr extends keyof MPApi> = PickAttr<Attr, MPApi>;
+export declare type PickMPArgs<Attr extends keyof MPApi> = Parameters<PickMPAttr<Attr>>[0];
+export declare type PickMpReturns<Attr extends keyof MPApi> = ReturnType<PickMPAttr<Attr>>;
+export declare type ReturnTypePromise<T> = T extends AsyncCallback<infer S> ? (args?: T | undefined) => Promise<S> : never;
+export declare type PickPromiseAttr<T> = T extends (args: infer S) => void ? ReturnTypePromise<S> : never;

package/lib/mp.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@hylid/types",
+  "version": "0.0.2-dev.1",
+  "main": "lib/index.js",
+  "files": [
+    "lib",
+    "global.d.ts"
+  ],
+  "dependencies": {
+    "@types/miniprogram": "^1.0.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "registry": "https://registry.npmjs.org/"
+}