wrap with typescript

add api test

TODO.md

@@ -1,6 +1,6 @@
 0. ~~add test~~
 1. ~~add para for subsampling~~
-2. use typescript wrapper
+2. ~~use typescript wrapper~~
 3. ~~add travis-ci~~
 4. remove rgba or not 
-5. add samrt parameter
+5. ~~add smart parameter~~

cquant.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="node" />
+interface Color {
+    R: number;
+    G: number;
+    B: number;
+    count: number;
+}
+declare type Palette = Color[];
+declare type CallBackFunc = (err: Error | undefined | string, result: Palette) => void;
+declare type ImageDepth = 3 | 4;
+export declare function paletteAsync(buffer: Buffer, callback: CallBackFunc): void;
+export declare function paletteAsync(buffer: Buffer, depth: ImageDepth, callback: CallBackFunc): void;
+export declare function paletteAsync(buffer: Buffer, depth: ImageDepth, maxColor: number, callback: CallBackFunc): void;
+export declare function paletteAsync(buffer: Buffer, depth: ImageDepth | undefined, maxColor: number | undefined, maxSub: number | undefined, callback: CallBackFunc): void;
+export declare function paletteAsync(buffer: Buffer): Promise<Palette>;
+export declare function paletteAsync(buffer: Buffer, depth: ImageDepth): Promise<Palette>;
+export declare function paletteAsync(buffer: Buffer, depth: ImageDepth, maxColor: number): Promise<Palette>;
+export declare function paletteAsync(buffer: Buffer, depth: ImageDepth, maxColor: number, maxSub: number): Promise<Palette>;
+export declare function paletteAsync(buffer: Buffer, depth: ImageDepth | undefined, maxColor: number | undefined, maxSub: number | undefined): Promise<Palette>;
+export {};

cquant.ts

@@ -0,0 +1,68 @@
+const addon = require('bindings')('cquant');
+interface Color {
+  R: number;
+  G: number;
+  B: number;
+  count: number;
+}
+type Palette = Color[];
+type CallBackFunc = (err: Error | undefined | string, result: Palette) => void;
+type ImageDepth = 3 | 4;
+
+
+export function paletteAsync(buffer: Buffer, callback: CallBackFunc): void;
+export function paletteAsync(buffer: Buffer, depth: ImageDepth, callback: CallBackFunc): void;
+export function paletteAsync(buffer: Buffer, depth: ImageDepth, maxColor: number, callback: CallBackFunc): void;
+export function paletteAsync(buffer: Buffer, depth: ImageDepth | undefined, maxColor: number | undefined, maxSub: number | undefined, callback: CallBackFunc): void;
+
+export function paletteAsync(buffer: Buffer, ): Promise<Palette>;
+export function paletteAsync(buffer: Buffer, depth: ImageDepth, ): Promise<Palette>;
+export function paletteAsync(buffer: Buffer, depth: ImageDepth, maxColor: number): Promise<Palette>;
+export function paletteAsync(buffer: Buffer, depth: ImageDepth, maxColor: number, maxSub: number): Promise<Palette>;
+export function paletteAsync(buffer: Buffer, depth: ImageDepth | undefined, maxColor: number | undefined, maxSub: number | undefined): Promise<Palette>;
+export function paletteAsync() {
+  const [buffer, depth = 3, maxColor = 5, maxSub = 0, callback = null] = arguments
+  if (arguments.length < 1 || buffer == null) {
+    throw new Error("Too Few arguments")
+  } else if (arguments.length === 2) {
+    if (typeof (arguments[1]) === 'function') {
+      return paletteAsync(buffer, undefined, undefined, undefined, arguments[1])
+    }
+  } else if (arguments.length === 3) {
+    if (typeof (arguments[2]) === 'function') {
+      return paletteAsync(buffer, arguments[1], undefined, undefined, arguments[2])
+    }
+  } else if (arguments.length === 4) {
+    if (typeof (arguments[3]) === 'function') {
+      return paletteAsync(buffer, arguments[1], arguments[2], undefined, arguments[3])
+    }
+  }
+
+  if (callback == null) {
+    if (depth !== 3 && depth !== 4) {
+      return Promise.reject(new Error('Wrong depth!'));
+    }
+    if (maxColor <= 1 || maxColor > 256) {
+      return Promise.reject(new Error('maxColor too small or too large!'));
+    }
+    return new Promise((res, rej) => {
+      addon.PaletteAsync(buffer, maxColor, depth, maxSub, (err: any, val: any) => {
+        if (err) {
+          rej(err)
+        } else {
+          res(val)
+        }
+      })
+    })
+  } else {
+    if (depth !== 3 && depth !== 4) {
+      callback(new Error('Wrong depth!'));
+      return;
+    }
+    if (maxColor <= 1 || maxColor > 256) {
+      callback(new Error('maxColor too small or too large!'))
+      return
+    }
+    addon.PaletteAsync(buffer, maxColor, depth, maxSub, callback)
+  }
+}

package.json

@@ -3,10 +3,11 @@
   "version": "0.0.20",
   "description": "A fast and native image palette generator",
   "main": "cquant.js",
+  "types": "./cquant.d.ts",
   "scripts": {
     "install": "prebuild-install || cmake-js rebuild",
     "rebuild": "cmake-js rebuild",
-    "test": "node ./test/test.js && node ./test/perf.js && node ./script/build-deploy.js"
+    "test": "node ./test/test.js && node ./test/api-test.js && node ./test/perf.js && node ./script/build-deploy.js"
   },
   "keywords": [
     "color-quant",
@@ -32,8 +33,10 @@
     "sharp": "^0.21.3"
   },
   "devDependencies": {
+    "@types/node": "^10.12.24",
     "cmake-js": "^4.0.1",
-    "which": "^1.3.1",
-    "prebuild": "^8.1.2"
+    "prebuild": "^8.1.2",
+    "typescript": "^3.3.3",
+    "which": "^1.3.1"
   }
 }

test/api-test.js

@@ -0,0 +1,43 @@
+const cquant = require('../')
+const sharp = require('sharp')
+function paraTest() {
+    sharp('./img/large.1.jpg')
+        .raw()
+        .toBuffer((err, buffer, info) => {
+            console.log('Start API Testing')
+            cquant.paletteAsync(buffer, info.channels, 12, 1, (err, result) => {
+                console.log(err === undefined ? 'Done: ' + result.length : 'Error')
+            })
+            cquant.paletteAsync(buffer, info.channels, 8, (err, result) => {
+                console.log(err === undefined ? 'Done: ' + result.length : 'Error')
+            })
+            cquant.paletteAsync(buffer, info.channels, (err, result) => {
+                console.log(err === undefined ? 'Done: ' + result.length : 'Error')
+            })
+            cquant.paletteAsync(buffer, (err, result) => {
+                console.log(err === undefined ? 'Done: ' + result.length : 'Error')
+            })
+            cquant.paletteAsync(buffer).then(result => {
+                console.log('Done: ' + result.length)
+            }).catch(err => {
+                console.log('Error')
+            })
+            cquant.paletteAsync(buffer, info.channels).then(result => {
+                console.log('Done: ' + result.length)
+            }).catch(err => {
+                console.log('Error')
+            })
+            cquant.paletteAsync(buffer, info.channels, 10).then(result => {
+                console.log('Done: ' + result.length)
+            }).catch(err => {
+                console.log('Error')
+            })
+            cquant.paletteAsync(buffer, info.channels, undefined, 1).then(result => {
+                console.log('Done: ' + result.length)
+            }).catch(err => {
+                console.log('Error')
+            })
+
+        })
+}
+paraTest()

test/test.js

@@ -1,4 +1,4 @@
-const cquant = require('../cquant')
+const cquant = require('../')
 const fs = require('fs')
 const path = require('path')
 const sharp = require('sharp')
@@ -53,6 +53,7 @@ function test(imagePath, subSample = 0) { // './img/0.jpg'
       }
     })
 }
+console.log('Start Image Testing')
 test('./img/large.1.jpg')
 test('./img/large.1.png')
 test('./img/large.1.png', 1)

tsconfig.json

@@ -0,0 +1,55 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
+    "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true, /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true, /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+    /* Strict Type-Checking Options */
+    "strict": true, /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  }
+}