wechaty-puppet-matrix 0.0.4

package/dist/esm/tests/integration.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env ts-node
+export {};
+//# sourceMappingURL=integration.spec.d.ts.map

package/dist/esm/tests/integration.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration.spec.d.ts","sourceRoot":"","sources":["../../../tests/integration.spec.ts"],"names":[],"mappings":""}

package/dist/esm/tests/integration.spec.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+import { test, } from 'tstest';
+test('integration testing', async (t) => {
+    void t.skip('tbw');
+});

package/dist/esm/tests/tap.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node -r ts-node/register
+export {};
+//# sourceMappingURL=tap.spec.d.ts.map

package/dist/esm/tests/tap.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tap.spec.d.ts","sourceRoot":"","sources":["../../../tests/tap.spec.ts"],"names":[],"mappings":""}

package/dist/esm/tests/tap.spec.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env -S node -r ts-node/register
+import { test } from 'tstest';
+import * as WECHATY from '@juzi/wechaty';
+test('smoke testing', async (t) => {
+    const bot = WECHATY.WechatyBuilder.build();
+    t.ok(bot, 'bot has created');
+});

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "wechaty-puppet-matrix",
+  "version": "0.0.4",
+  "description": "Puppet matrix for Wechaty",
+  "type": "module",
+  "typings": "./dist/esm/src/mod.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/mod.js",
+      "require": "./dist/cjs/src/mod.js"
+    }
+  },
+  "engines": {
+    "wechaty": ">=1.20",
+    "wechaty-puppet": ">=1.20"
+  },
+  "scripts": {
+    "dist": "npm-run-all build dist:commonjs",
+    "build": "tsc && tsc -p tsconfig.cjs.json",
+    "dist:commonjs": "jq -n \"{ type: \\\"commonjs\\\" }\" > dist/cjs/package.json",
+    "lint": "npm-run-all lint:es lint:ts lint:md",
+    "lint:es": "eslint --ignore-pattern fixtures/ \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "lint:md": "markdownlint README.md",
+    "lint:ts": "tsc --isolatedModules --noEmit",
+    "start": "cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" node examples/ding-dong-bot.ts",
+    "test": "npm-run-all lint test:unit",
+    "test:pack": "bash -x scripts/npm-pack-testing.sh",
+    "lint:fix": "eslint --fix \"src/**/*.ts\" \"tests/**/*.spec.ts\" --ignore-pattern tests/fixtures/",
+    "test:unit": "cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" TAP_TIMEOUT=60 tap \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\"",
+    "start:test": "node --loader ts-node/esm examples/ding-dong-bot.ts",
+    "start:panel": "node --loader ts-node/esm examples/panel.ts"
+  },
+  "keywords": [
+    "wechaty",
+    "engine",
+    "chatbot",
+    "bot",
+    "grpc",
+    "wechat",
+    "sdk"
+  ],
+  "devDependencies": {
+    "@chatie/eslint-config": "^1.0.4",
+    "@chatie/git-scripts": "^0.6.2",
+    "@chatie/semver": "^0.4.7",
+    "@grpc/grpc-js": "1.9.14",
+    "@juzi/wechaty": "^1.0.99",
+    "@juzi/wechaty-puppet": "^1.0.91",
+    "@swc/core": "^1.3.41",
+    "@types/body-parser": "^1.19.0",
+    "@types/express": "^4.17.11",
+    "@types/fs-extra": "^9.0.13",
+    "@types/lru-cache": "^5.1.1",
+    "@types/node": "^22.5.4",
+    "@types/node-cleanup": "^2.1.2",
+    "@types/xml2js": "^0.4.11",
+    "cross-env": "^7.0.3",
+    "eslint-plugin-n": "^15.6.1",
+    "npm-run-all": "^4.1.5",
+    "pkg-jq": "^0.2.11",
+    "qrcode-terminal": "^0.12.0",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.1",
+    "tstest": "^1.2.8",
+    "typescript": "^5.6.2"
+  },
+  "peerDependencies": {
+    "@juzi/wechaty": "^1.0.99",
+    "@juzi/wechaty-puppet": "^1.0.91"
+  },
+  "dependencies": {
+    "axios": "^1.6.0",
+    "body-parser": "^1.19.0",
+    "cuid": "^2.1.8",
+    "date-fns": "^3.6.0",
+    "file-box": "^1.4.15",
+    "fs-extra": "^10.1.0",
+    "lru-cache": "^6.0.0",
+    "node-cleanup": "^2.1.2",
+    "wechaty-web-panel": "^1.6.64",
+    "ws": "^8.18.0",
+    "xml2js": "^0.5.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "files": [
+    "bin/",
+    "dist/",
+    "src/"
+  ],
+  "git": {
+    "scripts": {
+      "pre-push": "npx git-scripts-pre-push"
+    }
+  }
+}

package/src/cleanup.ts

@@ -0,0 +1,36 @@
+import nodeCleanup from 'node-cleanup'
+import type * as PUPPET from '@juzi/wechaty-puppet'
+
+const RunningPuppets: PUPPET.Puppet[] = []
+
+nodeCleanup((exitCode:any, signal:any) => {
+  // can not take any async actions while process exiting
+  if (exitCode !== null) {
+    return true
+  }
+
+  // make shallow copy
+  const puppets = RunningPuppets.slice()
+
+  Promise.all(
+    puppets.map(async (puppet) => {
+      await puppet.stop()
+    }),
+  ).finally(() => {
+    nodeCleanup.uninstall()
+    process.kill(process.pid, signal!)
+  }).catch(console.error)
+
+  return false
+})
+
+export function addRunningPuppet (puppet: PUPPET.Puppet) {
+  RunningPuppets.push(puppet)
+}
+
+export function removeRunningPuppet (puppet: PUPPET.Puppet) {
+  const puppetIndex = RunningPuppets.indexOf(puppet)
+  if (puppetIndex !== -1) {
+    delete RunningPuppets[puppetIndex]
+  }
+}

package/src/config.ts

@@ -0,0 +1,15 @@
+import {
+  log,
+}                  from '@juzi/wechaty-puppet'
+
+import { packageJson } from './package-json.js'
+
+const VERSION = packageJson.version || '0.0.0'
+
+const MEMORY_SLOT = 'PUPPET_ENGINE'
+
+export {
+  VERSION,
+  log,
+  MEMORY_SLOT,
+}

package/src/engine-schema.ts

@@ -0,0 +1,171 @@
+/**
+ *   Wechaty - https://github.com/chatie/wechaty
+ *
+ *   @copyright 2022 Leo_chen <zixia@zixia.net>
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+import type { WechatMessageType } from './matrix/types.js'
+
+export interface MessagePayload {
+  id: string, // 消息id
+  timeStamp: number, // 10位时间戳
+  talkerId: string, // 发消息 人 或者 群
+  text: string, // 消息内容
+  msgType?: WechatMessageType,
+  fromWxid?: string, // 如果是群消息就是 群id
+  atWxidList?: string[], // 消息中艾特人wxid列表
+  msg: string, // 消息内容
+  listenerId: string,
+}
+export interface ChatRoomMember {
+  wxid: string,
+  groupNick: string,
+  avatar?: string,
+  inviterUserName?: string
+  displayName?: string
+}
+
+// 性别，1=男，2=女
+export enum SexType {
+  MEN = 2,
+  FEMALE = 2
+}
+
+/**
+ * 性别
+ */
+enum ContactGender {
+  Unknown = 0, // 位置
+  Male = 1, // 男
+  Female = 2, // 女
+}
+
+export interface ContactPayload {
+  /**
+   * 头像，需在会话列表中
+   */
+  avatar: string;
+  /**
+   * 城市，需在会话列表中
+   */
+  city: string;
+  /**
+   * 国家，需在会话列表中
+   */
+  country: string;
+  /**
+   * 群成员数量，仅当对象是群聊时有效
+   */
+  memberNum?: number;
+  /**
+   * 朋友圈背景图，需在会话列表中 暂时无用
+   */
+  momentsBackgroudImgUrl?: string;
+  /**
+   * 昵称
+   */
+  name: string;
+  /**
+   * 备注
+   */
+  alias: string;
+  /**
+   * 省份，需在会话列表中
+   */
+  province: string;
+  /**
+   * 备注
+   */
+  remark?: string;
+  /**
+   * 性别，1=男，2=女
+   */
+  sex: ContactGender;
+  /**
+   * 签名，需在会话列表中
+   */
+  sign?: string;
+
+  /**
+   *  添加好友需要的ticket 票据 不同的客户端可能不同，自己构造好就行，会原样返回的 针对daen 是 v3 + '-' + v4
+   */
+  ticket?: string;
+  /**
+   * 微信ID
+   */
+  wxid: string;
+  /**
+   * 微信号
+   */
+  wxNum: string;
+  /**
+   * 群成员 id
+   */
+  chatroommemberList?: string[];
+  /**
+   * 群主
+   */
+  ownerId?: string,
+  /**
+   * 群管id
+   */
+  adminIdList?: string[]
+  /**
+   * 是否好友
+   */
+  isFriend?: number
+  /**
+   * 加好友场景 来源，1=qq 3=微信号 6=单向添加 10和13=通讯录 14=群聊 15=手机号 17=名片 30=扫一扫
+   */
+  scene?: string
+  device?: string
+  qq?: string
+  phone?: string
+  email?: string,
+  description?: string,
+  labelIdlist?: string,
+  /**
+   * 朋友圈背景图
+   */
+  snsBgImg?: string,
+  /**
+   * 好友类型
+   * 1
+   */
+  contactType?: number,
+  /**
+   * 群公告
+   */
+  announcement?: string
+}
+
+export interface MessageRevokeInfo {
+  fromWxid: string, // fromType=1时为好友wxid，fromType=2时为群wxid
+  msg: string // 撤回的消息内容
+}
+
+export interface Label {
+  name: string,
+  id: string | number
+}
+
+export interface MusicPayLoad {
+  name: string,
+  author: string,
+  app:string, // 酷狗/wx79f2c4418704b4f8，网易云/wx8dd6ecd81906fd84，QQ音乐/wx5aa333606550dfd5
+  jumpUrl:string, // 点击后跳转地址
+  musicUrl: string, // 网络歌曲直链
+  imageUrl: string // 网络图片直链
+}