@juzi/wechaty-grpc 1.0.0

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@juzi/wechaty-grpc",
+  "version": "1.0.0",
+  "description": "gRPC for Wechaty",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/mod.js",
+      "require": "./dist/cjs/src/mod.js"
+    }
+  },
+  "typings": "./dist/esm/src/mod.d.ts",
+  "engines": {
+    "node": ">=16",
+    "npm": ">=7"
+  },
+  "scripts": {
+    "clean": "shx rm -fr dist/* out/*",
+    "dist": "npm-run-all clean generate build dist:copy dist:commonjs",
+    "build": "tsc && tsc -p tsconfig.cjs.json",
+    "dist:commonjs": "jq -n \"{ type: \\\"commonjs\\\" }\" > dist/cjs/package.json",
+    "dist:copy": "npm-run-all copy:esm copy:cjs",
+    "copy:esm": "shx cp -R out/ dist/esm && shx cp -R proto/ dist/esm && shx cp -R commonjs/ dist/esm/",
+    "copy:cjs": "shx cp -R out/ dist/cjs && shx cp -R proto/ dist/cjs && shx cp -R commonjs/ dist/cjs/",
+    "dist:py": "python3 setup.py sdist bdist_wheel",
+    "publish:py": "twine upload dist/*",
+    "example:server": "nodemon --exec ts-node examples/server.ts",
+    "example:client": "ts-node examples/client.ts",
+    "generate": "bash -x scripts/generate-stub.sh",
+    "lint": "npm-run-all lint:es lint:ts lint:proto",
+    "lint:es": "eslint --ignore-pattern fixtures/ \"src/**/*.ts\" \"tests/**/*.ts\" \"examples/**/*.ts\"",
+    "lint:ts": "tsc --isolatedModules --noEmit",
+    "lint:proto": "echo \"SKIP proto lint due to not support options\" || bash -c 'protoc -I third-party -I proto --lint_out=sort_imports:. $(find proto/ -type f -name *.proto)'",
+    "install:protoc": "bash -x scripts/install-protoc.sh",
+    "test": "npm-run-all lint test:unit test:commonjs",
+    "test:pack": "bash -x scripts/npm-pack-testing.sh",
+    "test:unit": "cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" tap \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\"",
+    "test:commonjs": "cross-env TS_NODE_PROJECT=tsconfig.cjs.json NODE_OPTIONS=--require=ts-node/register tap \"commonjs/**/*.spec.ts\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/juzibot/wechaty-grpc.git"
+  },
+  "keywords": [
+    "grpc",
+    "chatie",
+    "chatbot",
+    "hostie",
+    "puppet",
+    "wechaty"
+  ],
+  "author": "Huan LI <zixia@zixia.net>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/juzibot/wechaty-grpc/issues"
+  },
+  "homepage": "https://github.com/juzibot/wechaty-grpc#readme",
+  "dependencies": {
+    "@grpc/grpc-js": "^1.3.7",
+    "google-protobuf": "^3.18.0",
+    "stronger-typed-streams": "^0.2.0"
+  },
+  "devDependencies": {
+    "@chatie/eslint-config": "^0.14.1",
+    "@chatie/semver": "^0.4.7",
+    "@chatie/tsconfig": "^0.20.2",
+    "@types/google-protobuf": "^3.15.5",
+    "@types/protobufjs": "^6.0.0",
+    "cross-env": "^7.0.3",
+    "grpc_tools_node_protoc_ts": "^5.3.2",
+    "grpc-tools": "^1.11.2",
+    "grpcc": "^1.1.3",
+    "nodemon": "^2.0.12",
+    "npm-run-all": "^4.1.5",
+    "request": "^2.88.2",
+    "shx": "^0.3.3",
+    "ts-protoc-gen": "^0.15.0",
+    "tstest": "^0.7.3"
+  },
+  "files": [
+    "bin/",
+    "dist/",
+    "out/",
+    "src/"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "tap": {
+    "check-coverage": false
+  }
+}

package/src/chunk-transformer.spec.ts

@@ -0,0 +1,18 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import {
+  test,
+  AssertEqual,
+}             from 'tstest'
+
+import type {
+  Chunk,
+}                   from './chunk-transformer.js'
+
+test('Chunk type imported from generated code', async t => {
+  const typeOk: AssertEqual<
+    Chunk,
+    string | Uint8Array
+  > = true
+  t.ok(typeOk, 'should be `string | Uint8Array`')
+})

package/src/chunk-transformer.ts

@@ -0,0 +1,58 @@
+/**
+ * A stream transformer that encodes chunks into protobufs (and vice versa)
+ */
+import {
+  Transform,
+}                 from 'stronger-typed-streams'
+
+import type {
+  UploadRequest,
+}                 from '../out/wechaty/puppet/download-upload_pb.js'
+
+// string | Uint8Array
+type Chunk = UploadRequest.AsObject['chunk']
+
+/**
+ * the interface for satisfyign UploadRequest & DownloadResponse
+ */
+interface ChunkPb {
+  getChunk(): Chunk
+  setChunk(value: Chunk): void
+}
+
+/**
+ * Wrap Chunk
+ */
+const chunkEncoder = <T extends ChunkPb> (
+  PbConstructor: { new(): T },
+) => new Transform<Chunk, T>({
+  objectMode: true,
+  transform: (chunk: Chunk, _: any, callback: (error: Error | null, pb: T) => void) => {
+    const pb = new PbConstructor()
+    pb.setChunk(chunk)
+    callback(null, pb)
+  },
+})
+
+/**
+ * Unwrap Chunk
+ */
+const chunkDecoder = <T extends ChunkPb> () => new Transform<T, Chunk>({
+  objectMode: true,
+  transform: (pb: T, _: any, callback: (error: Error | null, chunk?: Chunk) => void) => {
+    const chunk = pb.getChunk()
+    if (chunk) {
+      callback(null, chunk)
+    } else {
+      callback(new Error('NOCHUNK'))
+    }
+  },
+})
+
+export type {
+  Chunk,
+}
+export {
+  chunkEncoder,
+  chunkDecoder,
+}

package/src/cjs.spec.ts

@@ -0,0 +1,36 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import { test } from 'tstest'
+
+import {
+  codeRoot,
+  puppet,
+  google,
+}                 from './cjs.js'
+
+test('ESM: codeRoot', async t => {
+  t.ok(codeRoot, 'should exists "codeRoot"')
+})
+
+test('ESM: puppet', async t => {
+  t.ok(puppet, 'should exists "puppet"')
+  t.ok(puppet.EventRequest, 'should exists "EventRequest"')
+})
+
+test('ESM: puppet.EventTypeMap', async t => {
+  const map: puppet.EventTypeMap = {} as any
+  map.EVENT_TYPE_DIRTY = puppet.EventType.EVENT_TYPE_DIRTY
+  t.equal(Object.keys(map).length, 1, 'should export type "EventTypeMap"')
+})
+
+test('ESM: puppet.DingRequest', async t => {
+  t.equal(typeof puppet.DingRequest, 'function', 'should exists "DingRequest"')
+})
+
+test('ESM: google.HealthCheckResponse', async t => {
+  t.ok(google.HealthCheckResponse, 'should exists "HealthCheckResponse"')
+})
+
+test('ESM: google.ServingStatus.SERVING', async t => {
+  t.ok(google.HealthCheckResponse.ServingStatus.SERVING, 'should exists "ServingStatus.SERVING"')
+})

package/src/cjs.ts

@@ -0,0 +1,10 @@
+import puppet from '../commonjs/generated/puppet.cjs'
+import google from '../commonjs/generated/google.cjs'
+
+import { codeRoot } from '../commonjs/code-root.cjs'
+
+export {
+  codeRoot,
+  google,
+  puppet,
+}

package/src/config.ts

@@ -0,0 +1,19 @@
+import { packageJson } from './package-json.js'
+
+const VERSION = packageJson.version || '0.0.0'
+
+enum MajorVersionEnum {
+  v0 = 'v0',
+  // v1 = 'v1',
+}
+
+export type ApiStore = {
+  [key in MajorVersionEnum]: {
+    file: string,
+    data: string,
+  }
+}
+
+export {
+  VERSION,
+}

package/src/google.spec.ts

@@ -0,0 +1,13 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import { test } from 'tstest'
+
+import {
+  Timestamp,
+}                 from './google.js'
+
+test('Timestamp', async t => {
+  const timestamp: Timestamp = new Timestamp()
+  timestamp.fromDate(new Date())
+  t.ok(timestamp, 'should create a timestamp protocol buffer')
+})

package/src/google.ts

@@ -0,0 +1,10 @@
+import timestamp from 'google-protobuf/google/protobuf/timestamp_pb.js'
+import wrappers  from 'google-protobuf/google/protobuf/wrappers_pb.js'
+
+class StringValue extends wrappers.StringValue  {}
+class Timestamp   extends timestamp.Timestamp   {}
+
+export {
+  StringValue,
+  Timestamp,
+}

package/src/mod.spec.ts

@@ -0,0 +1,30 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import { test } from 'tstest'
+
+import {
+  grpc,
+  puppet,
+  google,
+}                   from './mod.js'
+
+test('`grpc` is exported', async t => {
+  t.ok(grpc, 'should imported grpc')
+})
+
+test('`IPuppetServer` is exported', async t => {
+  const i: puppet.IPuppetServer = {} as any
+  t.ok(i, 'should has typing IPuppetServer')
+})
+
+test('`PuppetService` is exported', async t => {
+  t.ok(puppet.PuppetService, 'should export PuppetSevice')
+})
+
+test('CJS: HealthCheckResponse', async t => {
+  t.ok(google.HealthCheckResponse, 'should exists "HealthCheckResponse"')
+})
+
+test('CJS: ServingStatus.SERVING', async t => {
+  t.ok(google.HealthCheckResponse.ServingStatus.SERVING, 'should exists "ServingStatus.SERVING"')
+})

package/src/mod.ts

@@ -0,0 +1,31 @@
+import * as grpc  from '@grpc/grpc-js'
+
+import * as proto     from './proto.js'
+import * as openApi   from './openapi.js'
+
+import {
+  google,
+  puppet,
+}                     from './cjs.js'
+import { VERSION }    from './config.js'
+import {
+  StringValue,
+  Timestamp,
+}                     from './google.js'
+import {
+  chunkEncoder,
+  chunkDecoder,
+}                     from './chunk-transformer.js'
+
+export {
+  chunkEncoder,
+  chunkDecoder,
+  google,
+  grpc,
+  openApi,
+  proto,
+  puppet,
+  StringValue,
+  Timestamp,
+  VERSION,
+}

package/src/openapi.spec.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import { test } from 'tstest'
+
+import {
+  puppet,
+}                 from './openapi.js'
+
+test('puppet.v0.file', async t => {
+  const EXPECTED_PATH_REG = /puppet.swagger.json$/
+  t.ok(EXPECTED_PATH_REG.test(puppet.v0.file), 'puppet OpenAPI file should be puppet.swagger.json')
+})
+
+test('puppet.v0.data', async t => {
+  t.ok(puppet.v0.data.length > 0, 'should get JSON data for puppet.v0.data')
+  try {
+    const obj = JSON.parse(puppet.v0.data)
+    t.ok(obj, 'should be able to parse JSON for puppet.v0.data')
+  } catch (e) {
+    t.fail('should be able to parse JSON data for puppet.v0.data')
+  }
+})

package/src/openapi.ts

@@ -0,0 +1,30 @@
+import path from 'path'
+import fs   from 'fs'
+
+import { codeRoot } from './cjs.js'
+
+import type { ApiStore } from './config.js'
+
+function getOpenApiPath (...paths: string[]): string {
+  return path.join(
+    codeRoot,
+    'out',
+    ...paths,
+  )
+}
+
+const puppetSwaggerFile = getOpenApiPath(
+  'wechaty',
+  'puppet.swagger.json',
+)
+
+const puppet: ApiStore = {
+  v0: {
+    data: fs.readFileSync(puppetSwaggerFile, 'utf-8'),
+    file: puppetSwaggerFile,
+  },
+}
+
+export {
+  puppet,
+}

package/src/package-json.spec.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import { test } from 'tstest'
+
+import { packageJson } from './package-json.js'
+
+test('Make sure the packageJson is fresh in source code', async t => {
+  const keyNum = Object.keys(packageJson).length
+  t.equal(keyNum, 0, 'packageJson should be empty in source code, only updated before publish to NPM')
+})

package/src/package-json.ts

@@ -0,0 +1,97 @@
+/**
+ * This file was auto generated from scripts/generate-version.sh
+ */
+import type { PackageJson } from 'type-fest'
+export const packageJson: PackageJson = {
+  "name": "@juzi/wechaty-grpc",
+  "version": "1.0.0",
+  "description": "gRPC for Wechaty",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/mod.js",
+      "require": "./dist/cjs/src/mod.js"
+    }
+  },
+  "typings": "./dist/esm/src/mod.d.ts",
+  "engines": {
+    "node": ">=16",
+    "npm": ">=7"
+  },
+  "scripts": {
+    "clean": "shx rm -fr dist/* out/*",
+    "dist": "npm-run-all clean generate build dist:copy dist:commonjs",
+    "build": "tsc && tsc -p tsconfig.cjs.json",
+    "dist:commonjs": "jq -n \"{ type: \\\"commonjs\\\" }\" > dist/cjs/package.json",
+    "dist:copy": "npm-run-all copy:esm copy:cjs",
+    "copy:esm": "shx cp -R out/ dist/esm && shx cp -R proto/ dist/esm && shx cp -R commonjs/ dist/esm/",
+    "copy:cjs": "shx cp -R out/ dist/cjs && shx cp -R proto/ dist/cjs && shx cp -R commonjs/ dist/cjs/",
+    "dist:py": "python3 setup.py sdist bdist_wheel",
+    "publish:py": "twine upload dist/*",
+    "example:server": "nodemon --exec ts-node examples/server.ts",
+    "example:client": "ts-node examples/client.ts",
+    "generate": "bash -x scripts/generate-stub.sh",
+    "lint": "npm-run-all lint:es lint:ts lint:proto",
+    "lint:es": "eslint --ignore-pattern fixtures/ \"src/**/*.ts\" \"tests/**/*.ts\" \"examples/**/*.ts\"",
+    "lint:ts": "tsc --isolatedModules --noEmit",
+    "lint:proto": "echo \"SKIP proto lint due to not support options\" || bash -c 'protoc -I third-party -I proto --lint_out=sort_imports:. $(find proto/ -type f -name *.proto)'",
+    "install:protoc": "bash -x scripts/install-protoc.sh",
+    "test": "npm-run-all lint test:unit test:commonjs",
+    "test:pack": "bash -x scripts/npm-pack-testing.sh",
+    "test:unit": "cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" tap \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\"",
+    "test:commonjs": "cross-env TS_NODE_PROJECT=tsconfig.cjs.json NODE_OPTIONS=--require=ts-node/register tap \"commonjs/**/*.spec.ts\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/juzibot/wechaty-grpc.git"
+  },
+  "keywords": [
+    "grpc",
+    "chatie",
+    "chatbot",
+    "hostie",
+    "puppet",
+    "wechaty"
+  ],
+  "author": "Huan LI <zixia@zixia.net>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/juzibot/wechaty-grpc/issues"
+  },
+  "homepage": "https://github.com/juzibot/wechaty-grpc#readme",
+  "dependencies": {
+    "@grpc/grpc-js": "^1.3.7",
+    "google-protobuf": "^3.18.0",
+    "stronger-typed-streams": "^0.2.0"
+  },
+  "devDependencies": {
+    "@chatie/eslint-config": "^0.14.1",
+    "@chatie/semver": "^0.4.7",
+    "@chatie/tsconfig": "^0.20.2",
+    "@types/google-protobuf": "^3.15.5",
+    "@types/protobufjs": "^6.0.0",
+    "cross-env": "^7.0.3",
+    "grpc_tools_node_protoc_ts": "^5.3.2",
+    "grpc-tools": "^1.11.2",
+    "grpcc": "^1.1.3",
+    "nodemon": "^2.0.12",
+    "npm-run-all": "^4.1.5",
+    "request": "^2.88.2",
+    "shx": "^0.3.3",
+    "ts-protoc-gen": "^0.15.0",
+    "tstest": "^0.7.3"
+  },
+  "files": [
+    "bin/",
+    "dist/",
+    "out/",
+    "src/"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "tap": {
+    "check-coverage": false
+  }
+} as any

package/src/proto.spec.ts

@@ -0,0 +1,16 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import { test } from 'tstest'
+
+import {
+  puppet,
+}                 from './proto.js'
+
+test('puppet.v0.file', async t => {
+  const EXPECTED_PATH_REG = /puppet\.proto$/
+  t.ok(EXPECTED_PATH_REG.test(puppet.v0.file), 'puppet proto file should be puppet.proto')
+})
+
+test('puppet.v0.data', async t => {
+  t.ok(puppet.v0.data.length > 0, 'should get proto data for puppet.v0.data')
+})

package/src/proto.ts

@@ -0,0 +1,34 @@
+/**
+ * Huan(20200222): inspired from googleapis/nodejs-proto-files
+ *  https://github.com/googleapis/nodejs-proto-files/blob/920fe4e5f8dee9a187e1858903894810a9b5feca/src/index.ts#L18-L20
+ */
+import path from 'path'
+import fs   from 'fs'
+
+import { codeRoot } from './cjs.js'
+
+import type { ApiStore } from './config.js'
+
+function getProtoPath (...paths: string[]): string {
+  return path.join(
+    codeRoot,
+    'proto',
+    ...paths,
+  )
+}
+
+const puppetProtoFile = getProtoPath(
+  'wechaty',
+  'puppet.proto',
+)
+
+const puppet: ApiStore = {
+  v0: {
+    data: fs.readFileSync(puppetProtoFile).toString(),
+    file: puppetProtoFile,
+  },
+}
+
+export {
+  puppet,
+}