Skip to content

Commit

Permalink
Fixup: docs (#129)
Browse files Browse the repository at this point in the history
  • Loading branch information
@taichunmin
taichunmin authored Jun 21, 2024
2 parents 79f6e57 + 331d855 commit f18ff80
Show file tree
Hide file tree
Showing 5 changed files with 284 additions and 410 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,15 @@ jobs:
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/index.global.js
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.global.js
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/plugin/DfuZip.global.js
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/plugin/SerialPortAdapter.global.js
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/plugin/WebbleAdapter.global.js
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/plugin/WebserialAdapter.global.js
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/+esm
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/index.mjs/+esm
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/plugin/DfuZip.mjs/+esm
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/plugin/SerialPortAdapter.mjs/+esm
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/plugin/WebbleAdapter.mjs/+esm
https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/plugin/WebserialAdapter.mjs/+esm
26 changes: 13 additions & 13 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
],
"dependencies": {
"@taichunmin/buffer": "^0.13.6",
"debug": "^4.3.4",
"debug": "^4.3.5",
"jszip": "^3.10.1",
"lodash": "^4.17.21",
"serialport": "^12.0.0",
Expand All @@ -35,14 +35,14 @@
"@types/html-minifier": "^4.0.5",
"@types/jest": "^29.5.12",
"@types/livereload": "^0.9.5",
"@types/lodash": "^4.17.4",
"@types/node": "^20.12.13",
"@types/lodash": "^4.17.5",
"@types/node": "^20.14.7",
"@types/pug": "^2.0.10",
"@types/serve-static": "^1.15.7",
"@types/uglify-js": "^3.17.5",
"@types/web-bluetooth": "^0.0.20",
"@typescript-eslint/eslint-plugin": "^7.11.0",
"@typescript-eslint/parser": "^7.11.0",
"@typescript-eslint/eslint-plugin": "^7.13.1",
"@typescript-eslint/parser": "^7.13.1",
"chokidar": "^3.6.0",
"concurrently": "^8.2.2",
"dayjs": "^1.11.11",
Expand All @@ -53,7 +53,7 @@
"eslint-config-standard": "^17.1.0",
"eslint-plugin-import": "^2.29.1",
"eslint-plugin-local-rules": "^2.0.1",
"eslint-plugin-n": "^17.7.0",
"eslint-plugin-n": "^17.9.0",
"eslint-plugin-promise": "^6.2.0",
"eslint-plugin-pug": "^1.2.5",
"eslint-plugin-tsdoc": "^0.3.0",
Expand All @@ -63,21 +63,21 @@
"jstransformer-sass": "^1.0.0",
"livereload": "^0.9.3",
"node-watch": "^0.7.4",
"nodemon": "^3.1.2",
"nodemon": "^3.1.4",
"pug": "^3.0.3",
"rimraf": "^5.0.7",
"serve-static": "^1.15.0",
"supports-color": "^9.4.0",
"ts-jest": "^29.1.4",
"ts-jest": "^29.1.5",
"ts-node": "^10.9.2",
"tsup": "^8.0.2",
"tsx": "^4.11.0",
"tsup": "^8.1.0",
"tsx": "^4.15.7",
"typedoc": "^0.25.13",
"typedoc-plugin-mdn-links": "^3.1.27",
"typedoc-plugin-missing-exports": "^2.2.0",
"typedoc-plugin-mdn-links": "^3.1.30",
"typedoc-plugin-missing-exports": "^2.3.0",
"typedoc-plugin-rename-defaults": "^0.7.0",
"typedoc-plugin-zod": "^1.1.2",
"typescript": "^5.4.5",
"typescript": "^5.5.2",
"utility-types": "^3.11.0"
},
"exports": {
Expand Down
2 changes: 1 addition & 1 deletion src/ChameleonUltra.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3230,7 +3230,7 @@ export class ChameleonUltra {
* ```js
* async function run (ultra) {
* const { DeviceModel } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/+esm')
* const { DfuZip } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/plugin/DfuZip.mjs/+esm')
* const { default: DfuZip } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/plugin/DfuZip.mjs/+esm')
* const model = (await ultra.cmdGetDeviceModel()) === DeviceModel.ULTRA ? 'ultra' : 'lite'
* const dfuZipUrl = `https://taichunmin.idv.tw/ChameleonUltra-releases/dev/${model}-dfu-app.zip`
* const dfuZip = new DfuZip(new Buffer((await axios.get(dfuZipUrl, { responseType: 'arraybuffer' }))?.data))
Expand Down
35 changes: 21 additions & 14 deletions src/Crypto1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export default class Crypto1 {
* @see [mfkey source code from RfidResearchGroup/proxmark3](https://github.com/RfidResearchGroup/proxmark3/tree/master/tools/mfkey)
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* const state1 = new Crypto1()
* const state2 = new Crypto1({ even: 0, odd: 0 })
Expand All @@ -102,7 +102,7 @@ export default class Crypto1 {
* Reset the internal lfsr.
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* const state1 = new Crypto1({ even: 1, odd: 1 })
* state1.reset()
Expand All @@ -118,7 +118,8 @@ export default class Crypto1 {
* @param key - The key to set the internal lfsr.
* @example
* ```js
* const { Buffer, Crypto1 } = window
* const { Buffer } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/+esm')
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* const state1 = new Crypto1()
* state1.setLfsr(new Buffer('FFFFFFFFFFFF'))
Expand All @@ -142,7 +143,8 @@ export default class Crypto1 {
* @returns lfsr.
* @example
* ```js
* const { Buffer, Crypto1 } = window
* const { Buffer } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/+esm')
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* const state1 = new Crypto1()
* console.log(state1.setLfsr(new Buffer('FFFFFFFFFFFF')).getLfsr().toString(16)) // 'FFFFFFFFFFFF'
Expand Down Expand Up @@ -261,7 +263,7 @@ export default class Crypto1 {
* @group Internal
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.beBit(0x01000000, 0)) // 1
* ```
Expand All @@ -277,7 +279,7 @@ export default class Crypto1 {
* @group Internal
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.bit(0x1, 0)) // 1
* ```
Expand All @@ -292,7 +294,7 @@ export default class Crypto1 {
* @group Internal
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.toBit(1)) // 1
* console.log(Crypto1.toBit(2)) // 0
Expand All @@ -308,7 +310,7 @@ export default class Crypto1 {
* @group Internal
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.toBool(1)) // 1
* console.log(Crypto1.toBool(2)) // 1
Expand All @@ -324,7 +326,7 @@ export default class Crypto1 {
* @group Internal
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.toUint24(-1).toString(16)) // 'ffffff'
* ```
Expand All @@ -339,7 +341,7 @@ export default class Crypto1 {
* @group Internal
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.toUint32(-1).toString(16)) // 'ffffffff'
* ```
Expand Down Expand Up @@ -368,7 +370,7 @@ export default class Crypto1 {
* @group Internal
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.toUint8(-1).toString(16)) // 'ff'
* ```
Expand Down Expand Up @@ -443,7 +445,7 @@ export default class Crypto1 {
* @group Internal
* @example
* ```js
* const { Crypto1 } = window
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.swapEndian(0x12345678).toString(16)) // '78563412'
* ```
Expand Down Expand Up @@ -705,7 +707,8 @@ export default class Crypto1 {
* @returns The recovered key.
* @example
* ```js
* const { Buffer, Crypto1 } = window
* const { Buffer } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/+esm')
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.mfkey32v2({
* uid: 0x65535D33,
Expand Down Expand Up @@ -774,7 +777,8 @@ export default class Crypto1 {
* @returns The recovered key.
* @example
* ```js
* const { Buffer, Crypto1 } = window
* const { Buffer } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/+esm')
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
*
* console.log(Crypto1.mfkey32v2({
* uid: 0x65535D33,
Expand Down Expand Up @@ -889,6 +893,7 @@ export default class Crypto1 {
* @returns candidates keys
* @example
* ```js
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
* const { Mf1KeyType } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/+esm')
* const args = {
* uid: 'b908a16d',
Expand Down Expand Up @@ -942,6 +947,7 @@ export default class Crypto1 {
* @returns candidates keys
* @example
* ```js
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
* const args = {
* uid: '877209e1',
* dist: '00000080',
Expand Down Expand Up @@ -1069,6 +1075,7 @@ export default class Crypto1 {
* ```js
* async function run (ultra) {
* const { Buffer, DarksideStatus, DeviceMode, Mf1KeyType } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/+esm')
* const { default: Crypto1 } = await import('https://cdn.jsdelivr.net/npm/chameleon-ultra.js@0/dist/Crypto1.mjs/+esm')
* await ultra.cmdChangeDeviceMode(DeviceMode.READER)
* const block = 0
* const keyType = Mf1KeyType.KEY_A
Expand Down
Loading

0 comments on commit f18ff80

Please sign in to comment.