@teammy/server 0.1.3 → 0.1.5

package/node_modules/@wecom/aibot-node-sdk/dist/types/message.d.ts

@@ -0,0 +1,158 @@
+/**
+ * 消息相关类型定义
+ * 按照企业微信智能机器人接收消息协议定义
+ */
+/** 消息类型枚举 */
+export declare enum MessageType {
+    /** 文本消息 */
+    Text = "text",
+    /** 图片消息 */
+    Image = "image",
+    /** 图文混排消息 */
+    Mixed = "mixed",
+    /** 语音消息 */
+    Voice = "voice",
+    /** 文件消息 */
+    File = "file",
+    /** 视频消息 */
+    Video = "video"
+}
+/** 消息发送者信息 */
+export interface MessageFrom {
+    /** 操作者的 userid */
+    userid: string;
+}
+/** 文本结构体 */
+export interface TextContent {
+    /** 文本消息内容 */
+    content: string;
+}
+/** 图片结构体 */
+export interface ImageContent {
+    /** 图片的下载 url（五分钟内有效，已加密） */
+    url: string;
+    /** 解密密钥，长连接模式下返回，每个下载链接的 aeskey 唯一 */
+    aeskey?: string;
+}
+/** 语音结构体 */
+export interface VoiceContent {
+    /** 语音转换成文本的内容 */
+    content: string;
+}
+/** 文件结构体 */
+export interface FileContent {
+    /** 文件的下载 url（五分钟内有效，已加密） */
+    url: string;
+    /** 解密密钥，长连接模式下返回，每个下载链接的 aeskey 唯一 */
+    aeskey?: string;
+}
+/** 视频结构体 */
+export interface VideoContent {
+    /** 视频的下载 url（五分钟内有效，已加密） */
+    url: string;
+    /** 解密密钥，长连接模式下返回，每个下载链接的 aeskey 唯一 */
+    aeskey?: string;
+}
+/** 图文混排子项 */
+export interface MixedMsgItem {
+    /** 图文混排中的类型：text / image */
+    msgtype: 'text' | 'image';
+    /** 文本内容（msgtype 为 text 时存在） */
+    text?: TextContent;
+    /** 图片内容（msgtype 为 image 时存在） */
+    image?: ImageContent;
+}
+/** 图文混排结构体 */
+export interface MixedContent {
+    /** 图文混排消息项列表 */
+    msg_item: MixedMsgItem[];
+}
+/** 引用结构体 */
+export interface QuoteContent {
+    /** 引用的类型：text / image / mixed / voice / file */
+    msgtype: 'text' | 'image' | 'mixed' | 'voice' | 'file';
+    /** 引用的文本内容 */
+    text?: TextContent;
+    /** 引用的图片内容 */
+    image?: ImageContent;
+    /** 引用的图文混排内容 */
+    mixed?: MixedContent;
+    /** 引用的语音内容 */
+    voice?: VoiceContent;
+    /** 引用的文件内容 */
+    file?: FileContent;
+}
+/** 基础消息结构 */
+export interface BaseMessage {
+    /** 本次回调的唯一性标志，用于事件排重 */
+    msgid: string;
+    /** 智能机器人 id */
+    aibotid: string;
+    /** 会话 id，仅群聊类型时返回 */
+    chatid?: string;
+    /** 会话类型：single 单聊, group 群聊 */
+    chattype: 'single' | 'group';
+    /** 事件触发者信息 */
+    from: MessageFrom;
+    /** 事件产生的时间戳 */
+    create_time?: number;
+    /** 支持主动回复消息的临时 url */
+    response_url?: string;
+    /** 消息类型 */
+    msgtype: MessageType | string;
+    /** 引用内容（若用户引用了其他消息则有该字段） */
+    quote?: QuoteContent;
+    /** 原始数据 */
+    [key: string]: any;
+}
+/** 文本消息 */
+export interface TextMessage extends BaseMessage {
+    msgtype: MessageType.Text;
+    /** 文本消息内容 */
+    text: TextContent;
+}
+/** 图片消息 */
+export interface ImageMessage extends BaseMessage {
+    msgtype: MessageType.Image;
+    /** 图片内容 */
+    image: ImageContent;
+}
+/** 图文混排消息 */
+export interface MixedMessage extends BaseMessage {
+    msgtype: MessageType.Mixed;
+    /** 图文混排内容 */
+    mixed: MixedContent;
+}
+/** 语音消息 */
+export interface VoiceMessage extends BaseMessage {
+    msgtype: MessageType.Voice;
+    /** 语音内容 */
+    voice: VoiceContent;
+}
+/** 文件消息 */
+export interface FileMessage extends BaseMessage {
+    msgtype: MessageType.File;
+    /** 文件内容 */
+    file: FileContent;
+}
+/** 视频消息 */
+export interface VideoMessage extends BaseMessage {
+    msgtype: MessageType.Video;
+    /** 视频内容 */
+    video: VideoContent;
+}
+/** 回复消息选项 */
+export interface ReplyOptions {
+    /** 回复的消息 ID */
+    msgid: string;
+    /** 聊天 ID */
+    chatid: string;
+}
+/** 发送文本消息参数 */
+export interface SendTextParams extends ReplyOptions {
+    content: string;
+}
+/** 发送 Markdown 消息参数 */
+export interface SendMarkdownParams extends ReplyOptions {
+    content: string;
+}

package/node_modules/@wecom/aibot-node-sdk/dist/utils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 通用工具方法
+ */
+/**
+ * 生成随机字符串
+ *
+ * @param length - 随机字符串长度，默认 8
+ * @returns 随机字符串
+ */
+export declare function generateRandomString(length?: number): string;
+/**
+ * 生成唯一请求 ID
+ *
+ * 格式：`{prefix}_{timestamp}_{random}`
+ *
+ * @param prefix - 前缀，通常为 cmd 名称
+ * @returns 唯一请求 ID
+ */
+export declare function generateReqId(prefix: string): string;

package/node_modules/@wecom/aibot-node-sdk/dist/wecom-crypto/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * WeCom 加解密通用核心
+ * 独立于 Webhook、WebSocket、Agent 的具体协议形态，统一提供基于 AES-256-CBC
+ * 的加解密与 SHA1 签名计算能力。
+ */
+/**
+ * 解码企业微信提供的 Base64 encodingAESKey
+ */
+export declare function decodeEncodingAESKey(encodingAESKey: string): Buffer;
+/**
+ * PKCS#7 填充
+ */
+export declare function pkcs7Pad(buf: Buffer, blockSize: number): Buffer;
+/**
+ * PKCS#7 解除填充
+ */
+export declare function pkcs7Unpad(buf: Buffer, blockSize: number): Buffer;
+export declare class WecomCrypto {
+    private token;
+    private encodingAESKey;
+    private receiveId?;
+    private aesKey;
+    private iv;
+    constructor(token: string, encodingAESKey: string, receiveId?: string | undefined);
+    /**
+     * 计算 WeCom 消息签名
+     */
+    computeSignature(timestamp: string, nonce: string, encrypt: string): string;
+    /**
+     * 验证 WeCom 消息签名
+     */
+    verifySignature(signature: string, timestamp: string, nonce: string, encrypt: string): boolean;
+    /**
+     * 消息解密
+     * 返回纯文本字符串（XML 或 JSON 根据上层业务而定）
+     */
+    decrypt(encryptText: string): string;
+    /**
+     * 消息加密
+     * 加密明文并返回 base64 格式密文与对应的新签名
+     */
+    encrypt(plainText: string, timestamp: string, nonce: string): {
+        encrypt: string;
+        signature: string;
+    };
+}

package/node_modules/@wecom/aibot-node-sdk/dist/ws.d.ts

@@ -0,0 +1,161 @@
+import { type ClientOptions as WsClientOptions } from 'ws';
+import type { Logger, WsFrame } from './types';
+export declare class WsConnectionManager {
+    private ws;
+    private logger;
+    private wsUrl;
+    private wsOptions;
+    private heartbeatInterval;
+    private heartbeatTimer;
+    private maxReconnectAttempts;
+    private maxAuthFailureAttempts;
+    private reconnectAttempts;
+    private authFailureAttempts;
+    private isManualClose;
+    /** 标记最近一次连接关闭是否因认证失败触发（用于 scheduleReconnect 区分重连类型） */
+    private lastCloseWasAuthFailure;
+    /** 认证凭证 */
+    private botId;
+    private botSecret;
+    /** 额外的认证参数（如 scene、plug_version 等），会展开到认证帧 body 中 */
+    private extraAuthParams;
+    /** Number of consecutive missed heartbeat acks (pong) */
+    private missedPongCount;
+    /** Max missed pong before treating connection as dead */
+    private readonly maxMissedPong;
+    /** Base delay (ms) for exponential back-off reconnection */
+    private reconnectBaseDelay;
+    /** Upper cap (ms) for reconnect delay */
+    private readonly reconnectMaxDelay;
+    /** 重连定时器引用，用于在 disconnect/connect 时取消挂起的重连 */
+    private reconnectTimer;
+    /** 按 req_id 分组的回复发送队列，保证同一 req_id 的消息串行发送 */
+    private replyQueues;
+    /** 正在等待回执的 req_id 集合，value 包含超时定时器、resolve/reject 和序列号 */
+    private pendingAcks;
+    /** 自增序列号，用于区分同一 reqId 的不同 pending，防止超时与 ack 竞态 */
+    private pendingAckSeq;
+    /** 回执超时时间（毫秒） */
+    private readonly replyAckTimeout;
+    /** 单个 req_id 的回复队列最大长度，超过后新消息将被拒绝 */
+    private maxReplyQueueSize;
+    /** 连接建立回调（WebSocket open 事件，认证尚未完成） */
+    onConnected: (() => void) | null;
+    /** 认证成功回调 */
+    onAuthenticated: (() => void) | null;
+    /** 连接断开回调 */
+    onDisconnected: ((reason: string) => void) | null;
+    /** 收到消息回调 */
+    onMessage: ((frame: WsFrame) => void) | null;
+    /** 重连回调 */
+    onReconnecting: ((attempt: number) => void) | null;
+    /** 错误回调 */
+    onError: ((error: Error) => void) | null;
+    /** 服务端主动断开回调（新连接建立导致旧连接被断开） */
+    onServerDisconnect: ((reason: string) => void) | null;
+    constructor(logger: Logger, heartbeatInterval?: number, reconnectBaseDelay?: number, maxReconnectAttempts?: number, wsUrl?: string, wsOptions?: WsClientOptions, maxReplyQueueSize?: number, maxAuthFailureAttempts?: number);
+    /**
+     * 设置认证凭证
+     */
+    setCredentials(botId: string, botSecret: string, extraAuthParams?: Record<string, any>): void;
+    /**
+     * 建立 WebSocket 连接（使用 SDK 内置默认地址）
+     */
+    connect(): void;
+    /**
+     * 设置 WebSocket 事件处理器
+     */
+    private setupEventHandlers;
+    /**
+     * 发送认证帧
+     *
+     * 格式：{ cmd: "aibot_subscribe", headers: { req_id }, body: { secret, bot_id } }
+     */
+    private sendAuth;
+    /**
+     * 处理收到的帧数据
+     *
+     * 接收帧结构：
+     * - 消息推送：{ cmd: "aibot_msg_callback", headers: { req_id }, body: { ... } }
+     * - 认证/心跳响应：{ headers: { req_id }, errcode: 0, errmsg: "ok" }
+     */
+    private handleFrame;
+    /**
+     * 启动心跳定时器
+     */
+    private startHeartbeat;
+    /**
+     * 停止心跳定时器
+     */
+    private stopHeartbeat;
+    /**
+     * 发送心跳
+     * If consecutive missed pong count reaches the threshold, treat the
+     * connection as dead and trigger reconnection.
+     *
+     * 格式：{ cmd: "ping", headers: { req_id } }
+     */
+    private sendHeartbeat;
+    /**
+     * 安排重连
+     *
+     * 区分两种重连场景，使用独立的计数器和最大重试次数：
+     * - 认证失败（lastCloseWasAuthFailure=true）：使用 authFailureAttempts / maxAuthFailureAttempts
+     * - 连接断开（lastCloseWasAuthFailure=false）：使用 reconnectAttempts / maxReconnectAttempts
+     *
+     * disconnected_event（被踢下线）不会触发重连，因为 isManualClose 已被设为 true。
+     */
+    private scheduleReconnect;
+    /**
+     * 发送数据帧
+     *
+     * 统一格式：{ cmd, headers: { req_id }, body }
+     */
+    send(frame: WsFrame): void;
+    /**
+     * 通过 WebSocket 通道发送回复消息（串行队列版本）
+     *
+     * 同一个 req_id 的消息会被放入队列中串行发送：
+     * 发送一条后等待服务端回执，收到回执或超时后才发送下一条。
+     *
+     * 格式：{ cmd: "aibot_respond_msg", headers: { req_id }, body: { ... } }
+     *
+     * @param reqId - 透传回调中的 req_id
+     * @param body - 回复消息体（如 StreamReplyBody）
+     * @param cmd - 发送的命令类型，默认 WsCmd.RESPONSE
+     * @returns Promise，收到回执时 resolve(回执帧)，超时或errcode非0时 reject(Error)
+     */
+    sendReply(reqId: string, body: any, cmd?: string): Promise<WsFrame>;
+    /**
+     * 处理指定 req_id 的回复队列
+     * 取出队列头部的消息发送，并设置回执超时
+     */
+    private processReplyQueue;
+    /**
+     * 处理回复消息的回执
+     * 收到回执后释放队列锁，继续处理下一条
+     */
+    private handleReplyAck;
+    /**
+     * 主动断开连接
+     */
+    /**
+     * 清理所有待处理的消息和回执
+     * @param reason - 清理原因，用于 reject 的错误信息
+     */
+    private clearPendingMessages;
+    disconnect(): void;
+    /**
+     * 检查指定 reqId 是否有待回执的消息（即上一条消息还未收到 ack）
+     *
+     * 用于流式场景：调用方可据此决定是否跳过当前帧，避免排队积压。
+     *
+     * @param reqId - 要检查的 req_id
+     * @returns true 表示有消息正在等待 ack
+     */
+    hasPendingAck(reqId: string): boolean;
+    /**
+     * 获取当前连接状态
+     */
+    get isConnected(): boolean;
+}

package/node_modules/@wecom/aibot-node-sdk/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@wecom/aibot-node-sdk",
+  "version": "1.0.7",
+  "description": "企业微信智能机器人 Node.js SDK - WebSocket 长连接通道",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "clean": "rm -rf dist",
+    "prebuild": "npm run clean",
+    "release": "node scripts/publish-all.mjs",
+    "release:dry": "node scripts/publish-all.mjs --dry-run",
+    "example": "ts-node examples/basic.ts",
+    "test": "vitest run"
+  },
+  "keywords": [
+    "wecom",
+    "wxwork",
+    "bot",
+    "aibot",
+    "websocket"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/WecomTeam/aibot-node-sdk.git"
+  },
+  "homepage": "https://github.com/WecomTeam/aibot-node-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/WecomTeam/aibot-node-sdk/issues"
+  },
+  "dependencies": {
+    "axios": "^1.6.7",
+    "eventemitter3": "^5.0.1",
+    "ws": "^8.16.0"
+  }
+}

package/node_modules/asynckit/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Indigo
+
+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/node_modules/asynckit/README.md

@@ -0,0 +1,233 @@
+# asynckit [![NPM Module](https://img.shields.io/npm/v/asynckit.svg?style=flat)](https://www.npmjs.com/package/asynckit)
+
+Minimal async jobs utility library, with streams support.
+
+[![PhantomJS Build](https://img.shields.io/travis/alexindigo/asynckit/v0.4.0.svg?label=browser&style=flat)](https://travis-ci.org/alexindigo/asynckit)
+[![Linux Build](https://img.shields.io/travis/alexindigo/asynckit/v0.4.0.svg?label=linux:0.12-6.x&style=flat)](https://travis-ci.org/alexindigo/asynckit)
+[![Windows Build](https://img.shields.io/appveyor/ci/alexindigo/asynckit/v0.4.0.svg?label=windows:0.12-6.x&style=flat)](https://ci.appveyor.com/project/alexindigo/asynckit)
+
+[![Coverage Status](https://img.shields.io/coveralls/alexindigo/asynckit/v0.4.0.svg?label=code+coverage&style=flat)](https://coveralls.io/github/alexindigo/asynckit?branch=master)
+[![Dependency Status](https://img.shields.io/david/alexindigo/asynckit/v0.4.0.svg?style=flat)](https://david-dm.org/alexindigo/asynckit)
+[![bitHound Overall Score](https://www.bithound.io/github/alexindigo/asynckit/badges/score.svg)](https://www.bithound.io/github/alexindigo/asynckit)
+
+<!-- [![Readme](https://img.shields.io/badge/readme-tested-brightgreen.svg?style=flat)](https://www.npmjs.com/package/reamde) -->
+
+AsyncKit provides harness for `parallel` and `serial` iterators over list of items represented by arrays or objects.
+Optionally it accepts abort function (should be synchronously return by iterator for each item), and terminates left over jobs upon an error event. For specific iteration order built-in (`ascending` and `descending`) and custom sort helpers also supported, via `asynckit.serialOrdered` method.
+
+It ensures async operations to keep behavior more stable and prevent `Maximum call stack size exceeded` errors, from sync iterators.
+
+| compression        |     size |
+| :----------------- | -------: |
+| asynckit.js        | 12.34 kB |
+| asynckit.min.js    |  4.11 kB |
+| asynckit.min.js.gz |  1.47 kB |
+
+
+## Install
+
+```sh
+$ npm install --save asynckit
+```
+
+## Examples
+
+### Parallel Jobs
+
+Runs iterator over provided array in parallel. Stores output in the `result` array,
+on the matching positions. In unlikely event of an error from one of the jobs,
+will terminate rest of the active jobs (if abort function is provided)
+and return error along with salvaged data to the main callback function.
+
+#### Input Array
+
+```javascript
+var parallel = require('asynckit').parallel
+  , assert   = require('assert')
+  ;
+
+var source         = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
+  , expectedResult = [ 2, 2, 8, 32, 128, 64, 16, 4 ]
+  , expectedTarget = [ 1, 1, 2, 4, 8, 16, 32, 64 ]
+  , target         = []
+  ;
+
+parallel(source, asyncJob, function(err, result)
+{
+  assert.deepEqual(result, expectedResult);
+  assert.deepEqual(target, expectedTarget);
+});
+
+// async job accepts one element from the array
+// and a callback function
+function asyncJob(item, cb)
+{
+  // different delays (in ms) per item
+  var delay = item * 25;
+
+  // pretend different jobs take different time to finish
+  // and not in consequential order
+  var timeoutId = setTimeout(function() {
+    target.push(item);
+    cb(null, item * 2);
+  }, delay);
+
+  // allow to cancel "leftover" jobs upon error
+  // return function, invoking of which will abort this job
+  return clearTimeout.bind(null, timeoutId);
+}
+```
+
+More examples could be found in [test/test-parallel-array.js](test/test-parallel-array.js).
+
+#### Input Object
+
+Also it supports named jobs, listed via object.
+
+```javascript
+var parallel = require('asynckit/parallel')
+  , assert   = require('assert')
+  ;
+
+var source         = { first: 1, one: 1, four: 4, sixteen: 16, sixtyFour: 64, thirtyTwo: 32, eight: 8, two: 2 }
+  , expectedResult = { first: 2, one: 2, four: 8, sixteen: 32, sixtyFour: 128, thirtyTwo: 64, eight: 16, two: 4 }
+  , expectedTarget = [ 1, 1, 2, 4, 8, 16, 32, 64 ]
+  , expectedKeys   = [ 'first', 'one', 'two', 'four', 'eight', 'sixteen', 'thirtyTwo', 'sixtyFour' ]
+  , target         = []
+  , keys           = []
+  ;
+
+parallel(source, asyncJob, function(err, result)
+{
+  assert.deepEqual(result, expectedResult);
+  assert.deepEqual(target, expectedTarget);
+  assert.deepEqual(keys, expectedKeys);
+});
+
+// supports full value, key, callback (shortcut) interface
+function asyncJob(item, key, cb)
+{
+  // different delays (in ms) per item
+  var delay = item * 25;
+
+  // pretend different jobs take different time to finish
+  // and not in consequential order
+  var timeoutId = setTimeout(function() {
+    keys.push(key);
+    target.push(item);
+    cb(null, item * 2);
+  }, delay);
+
+  // allow to cancel "leftover" jobs upon error
+  // return function, invoking of which will abort this job
+  return clearTimeout.bind(null, timeoutId);
+}
+```
+
+More examples could be found in [test/test-parallel-object.js](test/test-parallel-object.js).
+
+### Serial Jobs
+
+Runs iterator over provided array sequentially. Stores output in the `result` array,
+on the matching positions. In unlikely event of an error from one of the jobs,
+will not proceed to the rest of the items in the list
+and return error along with salvaged data to the main callback function.
+
+#### Input Array
+
+```javascript
+var serial = require('asynckit/serial')
+  , assert = require('assert')
+  ;
+
+var source         = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
+  , expectedResult = [ 2, 2, 8, 32, 128, 64, 16, 4 ]
+  , expectedTarget = [ 0, 1, 2, 3, 4, 5, 6, 7 ]
+  , target         = []
+  ;
+
+serial(source, asyncJob, function(err, result)
+{
+  assert.deepEqual(result, expectedResult);
+  assert.deepEqual(target, expectedTarget);
+});
+
+// extended interface (item, key, callback)
+// also supported for arrays
+function asyncJob(item, key, cb)
+{
+  target.push(key);
+
+  // it will be automatically made async
+  // even it iterator "returns" in the same event loop
+  cb(null, item * 2);
+}
+```
+
+More examples could be found in [test/test-serial-array.js](test/test-serial-array.js).
+
+#### Input Object
+
+Also it supports named jobs, listed via object.
+
+```javascript
+var serial = require('asynckit').serial
+  , assert = require('assert')
+  ;
+
+var source         = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
+  , expectedResult = [ 2, 2, 8, 32, 128, 64, 16, 4 ]
+  , expectedTarget = [ 0, 1, 2, 3, 4, 5, 6, 7 ]
+  , target         = []
+  ;
+
+var source         = { first: 1, one: 1, four: 4, sixteen: 16, sixtyFour: 64, thirtyTwo: 32, eight: 8, two: 2 }
+  , expectedResult = { first: 2, one: 2, four: 8, sixteen: 32, sixtyFour: 128, thirtyTwo: 64, eight: 16, two: 4 }
+  , expectedTarget = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
+  , target         = []
+  ;
+
+
+serial(source, asyncJob, function(err, result)
+{
+  assert.deepEqual(result, expectedResult);
+  assert.deepEqual(target, expectedTarget);
+});
+
+// shortcut interface (item, callback)
+// works for object as well as for the arrays
+function asyncJob(item, cb)
+{
+  target.push(item);
+
+  // it will be automatically made async
+  // even it iterator "returns" in the same event loop
+  cb(null, item * 2);
+}
+```
+
+More examples could be found in [test/test-serial-object.js](test/test-serial-object.js).
+
+_Note: Since _object_ is an _unordered_ collection of properties,
+it may produce unexpected results with sequential iterations.
+Whenever order of the jobs' execution is important please use `serialOrdered` method._
+
+### Ordered Serial Iterations
+
+TBD
+
+For example [compare-property](compare-property) package.
+
+### Streaming interface
+
+TBD
+
+## Want to Know More?
+
+More examples can be found in [test folder](test/).
+
+Or open an [issue](https://github.com/alexindigo/asynckit/issues) with questions and/or suggestions.
+
+## License
+
+AsyncKit is licensed under the MIT license.