glyphix 1.0.4 → 1.0.6

package/package.json

@@ -1,7 +1,8 @@
 {
 	"name": "glyphix",
-	"version": "1.0.4",
+	"version": "1.0.6",
 	"main": "lib/index.js",
+	"types": "types/index.d.ts",
 	"bin": {
 		"glyphix": "./glyphix.js"
 	},

package/types/cipher.d.ts

@@ -0,0 +1,85 @@
+declare module "@system.cipher" {
+  type transformationType =
+    | "AES/ECB/PKCS5Padding"
+    | "AES/ECB/PKCS7Padding"
+    | "AES/ECB/NoPadding"
+    | "AES/ECB/OneAndZerosPadding"
+    | "AES/ECB/ZerosAndLenPadding"
+    | "AES/ECB/ZerosPadding"
+    | "AES/CBC/PKCS5Padding"
+    | "AES/CBC/PKCS7Padding"
+    | "AES/CBC/NoPadding"
+    | "AES/CBC/OneAndZerosPadding"
+    | "AES/CBC/ZerosAndLenPadding"
+    | "AES/CBC/ZerosPadding"
+    | "AES/CFB/PKCS5Padding"
+    | "AES/CFB/PKCS7Padding"
+    | "AES/CFB/NoPadding"
+    | "AES/CFB/OneAndZerosPadding"
+    | "AES/CFB/ZerosAndLenPadding"
+    | "AES/CFB/ZerosPadding"
+    | "AES/CTR/PKCS5Padding"
+    | "AES/CTR/PKCS7Padding"
+    | "AES/CTR/NoPadding"
+    | "AES/CTR/OneAndZerosPadding"
+    | "AES/CTR/ZerosAndLenPadding"
+    | "AES/CTR/ZerosPadding"
+    | "AES/OFB/PKCS5Padding"
+    | "AES/OFB/PKCS7Padding"
+    | "AES/OFB/NoPadding"
+    | "AES/OFB/OneAndZerosPadding"
+    | "AES/OFB/ZerosAndLenPadding"
+    | "AES/OFB/ZerosPadding";
+  interface CipherFactory {
+    aes(options: {
+      action: "encrypt" | "decrypt";
+      text: string;
+      key: string;
+      transformation?: transformationType;
+      iv?: string;
+      ivOffset?: number;
+      ivLen?: number;
+    }): Promise<{ text: string }>;
+
+    rsa(options: {
+      action: string;
+      text: string;
+      key: string;
+      transformation?:
+        | "PKCS_v15andMGF1Padding"
+        | "OAEPwithMD5andMGF1Padding"
+        | "1andMGF1Padding"
+        | "256andMGF1Padding";
+    }): Promise<{ text: string }>;
+
+    sign(options: {
+      text: string;
+      key: string;
+      algorithm?:
+        | "MD5withRSA"
+        | "SHA1withRSA"
+        | "SHA256withRSA"
+        | "SHA512withRSA";
+    }): Promise<{ sign: string }>;
+
+    hash(options: {
+      data: string | ArrayBuffer;
+      algorithm: "md5" | "sha1" | "sha224" | "sha256" | "sha384" | "sha512";
+      encode?: "hex" | "base64" | "arraybuffer";
+    }): Promise<string | ArrayBuffer>;
+
+    hmac(options: {
+      data: string | ArrayBuffer;
+      algorithm: "md5" | "sha1" | "sha224" | "sha256" | "sha384" | "sha512";
+      key: string | ArrayBuffer;
+      encode?: "hex" | "base64" | "arraybuffer";
+    }): Promise<string | ArrayBuffer>;
+
+    base64Encode(data: string | ArrayBuffer): Promise<string>;
+
+    base64Decode(data: string | ArrayBuffer): Promise<ArrayBuffer>;
+  }
+
+  const cipherFactory: CipherFactory;
+  export default cipherFactory;
+}

package/types/fetch.d.ts

@@ -0,0 +1,20 @@
+declare module "@system.fetch" {
+  interface FetchFactory {
+    fetch(options: {
+      url: string;
+      method?: "GET" | "POST" | "PUT";
+      header?: { [key: string]: string };
+      params?: { [key: string]: string | number };
+      data?: string | ArrayBuffer | { [key: string]: any };
+      responseType?: "text" | "json" | "arraybuffer";
+      timeout?: number;
+    }): Promise<{
+      code: number;
+      headers: { [key: string]: string };
+      data: string | ArrayBuffer | any;
+    }>;
+  }
+
+  const fetchFactory: FetchFactory;
+  export default fetchFactory;
+}

package/types/file.d.ts

@@ -0,0 +1,41 @@
+declare module "@system.file" {
+  interface FileFactory {
+    readText(params: { uri: string }): Promise<string>;
+
+    writeText(params: {
+      uri: string;
+      text: string;
+      append?: boolean;
+    }): Promise<void>;
+
+    read(params: {
+      uri: string;
+      position?: number;
+      length?: number;
+    }): Promise<ArrayBuffer>;
+
+    write(params: {
+      uri: string;
+      data: ArrayBuffer;
+      position?: number;
+      append?: boolean;
+    }): Promise<void>;
+
+    copy(params: { srcUri: string; dstUri: string }): Promise<void>;
+
+    rename(params: { oldUri: string; newUri: string }): Promise<void>;
+
+    list(params: { uri: string }): Promise<Array>;
+
+    access(params: { uri: string }): Promise<boolean>;
+
+    mkdir(params: { uri: string; recursive?: boolean }): Promise<void>;
+
+    remove(params: { uri: string; recursive?: boolean }): Promise<void>;
+
+    stat(options: { uri: string }): Promise<{ size: number }>;
+  }
+
+  const fileFactory: FileFactory;
+  export default fileFactory;
+}

package/types/index.d.ts

@@ -0,0 +1,11 @@
+/// <reference path="./websocketfactory.d.ts" />
+/// <reference path="./media.d.ts" />
+/// <reference path="./fetch.d.ts" />
+/// <reference path="./request.d.ts" />
+/// <reference path="./router.d.ts" />
+/// <reference path="./launch.d.ts" />
+/// <reference path="./storage.d.ts" />
+/// <reference path="./file.d.ts" />
+/// <reference path="./network.d.ts" />
+/// <reference path="./cipher.d.ts" />
+

package/types/launch.d.ts

@@ -0,0 +1,28 @@
+declare module "@system.launch" {
+  interface LaunchFactory {
+    /**
+     * 启动指定应用并切换到前台。
+     * app 是一个已经安装的应用 ID 字符串。
+     * 返回的 Promise 表示应用是否加载成功
+     * @param app 应用 id
+     */
+    launch(app: string): Promise<bool>;
+    /**
+     * 将应用切换到后台
+     * @param app 应用 id
+     */
+    inactive(app?: string): Promise<void>;
+    /**
+     * 退出一个应用
+     * @param app 应用 id
+     */
+    exit(app?: string): Promise<void>;
+    /**
+     * 获取正在运行的应用包名列表，包括那些在后台的应用
+     */
+    getRunning(): string[];
+  }
+
+  const fetchFactory: LaunchFactory;
+  export default fetchFactory;
+}

package/types/media.d.ts

@@ -0,0 +1,68 @@
+declare module "@system.media" {
+  interface MediaFactory {
+    createAudioPlayer(): AudioPLayer;
+    createAudioRecord(): AudioRecorder;
+    setVolume(volume: number): void;
+  }
+
+  interface SongAttribute {
+    title: string; // 歌曲的名称
+    artist: string; // 表演者的名称，可以是个人或者乐队
+    album: string; // 歌曲所属的专辑名称
+    year: string; // 歌曲的发行年份
+    genre: string; // 歌曲的类型，例如流行、摇滚、古典等
+    track: string; // 当前歌曲在专辑中的编号，例如："1/12" 表示第1首，共12首
+    coverArt: string; // 歌曲封面图片的url
+    lyrics: string; // 歌词文本的 url
+    comments: string; // 额外信息，如版权备注等
+  }
+
+  export interface AudioPLayer {
+    src: string;
+    name?: string;
+    icon?: string;
+    mode?: "sequential" | "random" | "singleloop" | "listloop";
+    status: "play" | "pause" | "stop" | "ended" | "error";
+    duration: number;
+    position: number;
+    openSystemNotification: boolean;
+    songAttribute: SongAttribute;
+    play(): void;
+    pause(): void;
+    stop(): void;
+    release(): void;
+    onplay?: () => void;
+    onpause?: () => void;
+    onstop?: () => void;
+    onended?: () => void;
+    onerror?: () => void;
+    ontimeupdate?: () => void;
+    oninterrupt(action: number): void;
+    onnext?: () => void;
+    onprevious?: () => void;
+  }
+
+  export interface AudioRecorder {
+    start(options: {
+      uri: string;
+      sample?: 8000 | 16000 | 44100 | 48000;
+      layout?: 8 | 16 | 32;
+      channel?: 1 | 2;
+      success?: () => void;
+      failed?: () => void;
+    });
+
+    read(options: { callback: (buffer: ArrayBuffer) => void });
+
+    stop(): void;
+    release(): void;
+    onstart?: () => void;
+    onstop?: () => void;
+    onrelease?: () => void;
+    onavailable: (data: ArrayBuffer) => void;
+    onerror: () => void;
+  }
+
+  const mediaFactory: MediaFactory;
+  export default mediaFactory;
+}

package/types/network.d.ts

@@ -0,0 +1,18 @@
+declare module "@system.network" {
+  interface NetworkFactory {
+    subscribe(callback: (status: NetworkState) => void): number;
+    unsubscribe(subscribeID: number): void;
+
+    getType(): Promise<NetworkState>;
+  }
+
+  interface NetworkState {
+    device: string; // 网络设备的名字
+    type: string; // 网络设备的类型
+    linkUp: boolean; // 网络设备是否已经打开
+    online: boolean; // 设备是否在线（是否可以访问互联网）
+  }
+
+  const networkFactory: NetworkFactory;
+  export default networkFactory;
+}

package/types/request.d.ts

@@ -0,0 +1,18 @@
+declare module "@system.request" {
+  interface RequestFactory {
+    download(options: {
+      url: string;
+      header?: { [key: string]: string };
+      filename?: string;
+      callback: (progress: number) => void;
+    }): DownloadTask;
+  }
+
+  interface DownloadTask {
+    complete: Promise<void>;
+    cancel(): void;
+  }
+
+  const fetchFactory: RequestFactory;
+  export default fetchFactory;
+}

package/types/router.d.ts

@@ -0,0 +1,68 @@
+declare module "@system.router" {
+  interface RouterFactory {
+    /**
+     * 跳转到应用内的指定页面
+     * @param options
+     */
+    push(options: { uri: string; params?: Object }): Promise<boolean>;
+
+    /**
+     * 跳转到应用内的指定页面并关闭当前页面
+     * @param options
+     */
+    replace(options: { uri: string; params?: Object }): Promise<boolean>;
+
+    /**
+     * 返回到名为 name 的页面，如果 name 为空或者不传递这个参数，router.back() 就返回到上一级页面
+     * @param name
+     */
+    back(name?: string): Promise<boolean>;
+
+    /**
+     * 关闭指定页面。page 是一个页面的 view-model 对象
+     * @param page
+     */
+    close(page: Object): Promise<void>;
+
+    /**
+     * 获取当前应用页面栈中所有页面的页面组件
+     */
+    getPages(): Component[];
+
+    /**
+     * 获取当前应用页面栈中页面数量
+     */
+    getLength(): number;
+
+    /**
+     * 获取当前应用页面栈中所有页面的名称
+     */
+    getPagesName(): String[];
+
+    /**
+     * 获取当前应用中由 index 指定的页面组件。index 是页面的索引（即在页面栈中的位置）。如果查找的页面不存在则返回 undefined
+     * @param index
+     */
+    getPage(index: number): Component | undefined;
+
+    /**
+     * 获取当前应用中由页面组件 component 指定的页面索引。如果查找的页面不存在则返回 undefined。
+     * @param component
+     */
+    getIndex(component: Component): number | undefined;
+    /**
+     * 获取页面栈中名为 name 的所有页面列表，页面列表和页面栈的顺序相同。
+     * @param name
+     */
+    queryPage(name: string): Component[];
+
+    /**
+     * 获取页面栈中名为 name 的所有页面索引，页面索引值的顺序和页面栈的顺序相同
+     * @param name 
+     */
+    queryIndex(name: string): number[];
+  }
+
+  const router: RouterFactory;
+  export default RouterFactory;
+}

package/types/storage.d.ts

@@ -0,0 +1,32 @@
+declare module "@system.storage" {
+  interface StorageFactory {
+    /**
+     * 获取存储中键名 key 所对应的值。
+     * 如果键值对不存在则返回 undefined
+     * @param key
+     */
+    get(key: string): any;
+
+    /**
+     * 该方法接受一个键名 key 和值 value 作为参数并将此键值对添加到存储中。
+     * 如果键名已经存在则更新其对应的值
+     * @param key
+     * @param value
+     */
+    set(key: string, value: any): void;
+
+    /**
+     * 删除存储中键名 key 对应的键值对。键值对存在且删除成功后返回 true
+     * @param key
+     */
+    delete(key: string): boolean;
+    /**
+     * 清空应用中的所有存储数据
+     */
+    clear(): void;
+  }
+
+  const storageFactory: StorageFactory;
+
+  export default storageFactory;
+}

package/types/websocketfactory.d.ts

@@ -0,0 +1,18 @@
+declare module '@system.websocketfactory' {
+  interface WebSocketFactory {
+    create(options: { url: string; header: { [key: string]: any } });
+  }
+
+  export interface WebSocketInstance {
+    send(params: { data: string | ArrayBuffer }): Promise<any>;
+    close(params: { code: number; reason: string }): void;
+
+    onopen?: () => void;
+    onmessage?: (msg: string | ArrayBuffer) => void;
+    onclose?: (event: { code: number; reason: string }) => void;
+    onerror?: (error: { code: number; reason: string }) => void;
+  }
+
+  const websocketFactory: WebSocketFactory;
+  export default websocketFactory;
+}