@chatluna/qface 0.0.0-stage → 1.4.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Shigma
+Copyright (c) 2026 ChatLunaLab
+
+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/README.md

@@ -1,3 +1,47 @@
-# Temporary Holding Version
+# @chatluna/qface
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A maintenance fork of [`qface`](https://github.com/koishijs/QFace) (MIT, Shigma). The QQ system face table: 275 faces with their ids, Chinese names and pinyin shortcuts, plus the url each one is served as. Zero dependencies, Node 20+.
+
+```sh
+npm install @chatluna/qface
+```
+
+```ts
+import { data, findFace, getFace, getFaceUrl } from '@chatluna/qface'
+
+getFace(14) // { QSid: '14', QDes: '/微笑', EMCode: '100', Input: ['weixiao', 'wx'], … }
+findFace('jk') // '26', also 'jingkong', '/微笑', 'wx'…
+getFaceUrl(178) // https://koishi.js.org/QFace/gif/s178.gif
+getFaceUrl(347) // https://koishi.js.org/QFace/static/s347.png — isStatic faces are png
+```
+
+## API
+
+### `data`
+
+The whole `Face[]` table, keyed by the string `QSid`. A face carries `QDes` (the `/`-prefixed Chinese name), the historical `IQLid`/`AQLid`/`EMCode` codes, and optional flags: `isStatic` for faces that only exist as a png, `AniStickerType`/`AniStickerId` for the animated-sticker faces, `QHide` for faces not in the picker. `Input` lists the pinyin inputs, full spellings before abbreviations, and is absent on the newest faces.
+
+### `getFace(id)`
+
+The face with `QSid === String(id)`, or `undefined`.
+
+### `findFace(input)`
+
+The `QSid` of the first face matching `input`, or `null`. Matches, in order: a `QDes` equal to the input (a leading `/` on the input is ignored), an exact `Input` entry, then an `Input` entry that starts with the input — so `'j'` finds `/惊恐` first because its `Input` starts with `jk`.
+
+### `getFaceUrl(id, base?)`
+
+`{base}/gif/s{id}.gif`, or `{base}/static/s{id}.png` when `isStatic` is set. `base` defaults to `https://koishi.js.org/QFace`, the public mirror; pass your own host to serve the images yourself. Returns `''` for an unknown id.
+
+## Sync
+
+`src/data.json` is a checked-in copy of `lib/data.json` from [koishijs/QFace](https://github.com/koishijs/QFace). Refresh it with:
+
+```sh
+yarn sync   # fetches the current table and rewrites src/data.json
+yarn test   # builds lib/ and runs the unit tests
+```
+
+## License
+
+MIT

package/lib/data.d.ts

@@ -0,0 +1,2 @@
+import type { Face } from './index.ts';
+export declare const data: Face[];

package/lib/data.js

@@ -0,0 +1,5 @@
+// data.json is authored upstream (github.com/koishijs/QFace) and synced by `yarn sync`;
+// it is typed at this boundary rather than asserted field by field.
+import { readFileSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+export const data = JSON.parse(readFileSync(fileURLToPath(new URL('./data.json', import.meta.url)), 'utf8'));