From f6962ca7ea3dd2ecd51182aba1ad36f0289468de Mon Sep 17 00:00:00 2001 From: threesquared Date: Wed, 27 Jun 2018 15:54:29 +0100 Subject: [PATCH 1/4] Add definitions for triplesec --- types/triplesec/index.d.ts | 31 ++++++++++++++++++++++++++++++ types/triplesec/triplesec-tests.ts | 27 ++++++++++++++++++++++++++ types/triplesec/tsconfig.json | 22 +++++++++++++++++++++ types/triplesec/tslint.json | 1 + 4 files changed, 81 insertions(+) create mode 100644 types/triplesec/index.d.ts create mode 100644 types/triplesec/triplesec-tests.ts create mode 100644 types/triplesec/tsconfig.json create mode 100644 types/triplesec/tslint.json diff --git a/types/triplesec/index.d.ts b/types/triplesec/index.d.ts new file mode 100644 index 0000000000..afe0191d51 --- /dev/null +++ b/types/triplesec/index.d.ts @@ -0,0 +1,31 @@ +// Type definitions for triplesec 3.0 +// Project: https://github.com/keybase/triplesec +// Definitions by: Ben Speakman +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +export interface WordArray { + sigBytes: number; + words: number[]; + to_hex: () => string; +} + +export interface Arguments { + data: Buffer, + key: Buffer, + progress_hook?: (progress: Progress) => void; +} + +export interface Progress { + what: string; + i: number; + total: number; +} + +export function encrypt(arg: Arguments, cb: (err: Error | null, buff: Buffer | null) => void): void; +export function decrypt(arg: Arguments, cb: (err: Error | null, buff: Buffer | null) => void): void; + +export namespace prng { + export function generate(n: number, cb: (words: WordArray) => void): void; +} \ No newline at end of file diff --git a/types/triplesec/triplesec-tests.ts b/types/triplesec/triplesec-tests.ts new file mode 100644 index 0000000000..2f7037ed72 --- /dev/null +++ b/types/triplesec/triplesec-tests.ts @@ -0,0 +1,27 @@ +import * as triplesec from 'triplesec'; + +triplesec.encrypt({ + data: new Buffer('data'), + key: new Buffer('key') +}, (err, buff) => { + if (err === null) { + console.log(buff); + } else { + console.log(err); + } +}); + +triplesec.decrypt({ + data: new Buffer('data'), + key: new Buffer('key') +}, (err, buff) => { + if (err === null) { + console.log(buff); + } else { + console.log(err); + } +}); + +triplesec.prng.generate(24, words => { + console.log(words.to_hex()); // $ExpectType string +}); diff --git a/types/triplesec/tsconfig.json b/types/triplesec/tsconfig.json new file mode 100644 index 0000000000..adf3d9b2f7 --- /dev/null +++ b/types/triplesec/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "triplesec-tests.ts" + ] +} diff --git a/types/triplesec/tslint.json b/types/triplesec/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/triplesec/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From a8368993986b6e7f94fddf28b906b2a28d60ad15 Mon Sep 17 00:00:00 2001 From: Ben Speakman Date: Wed, 27 Jun 2018 18:26:29 +0100 Subject: [PATCH 2/4] Add strictFunctionTypes --- types/triplesec/tsconfig.json | 1 + 1 file changed, 1 insertion(+) diff --git a/types/triplesec/tsconfig.json b/types/triplesec/tsconfig.json index adf3d9b2f7..cf233cc7e0 100644 --- a/types/triplesec/tsconfig.json +++ b/types/triplesec/tsconfig.json @@ -6,6 +6,7 @@ ], "noImplicitAny": true, "noImplicitThis": true, + "strictFunctionTypes": true, "strictNullChecks": true, "baseUrl": "../", "typeRoots": [ From c39f953a8216086bb4b304465bc6a1fb9ab88736 Mon Sep 17 00:00:00 2001 From: threesquared Date: Thu, 28 Jun 2018 14:05:44 +0100 Subject: [PATCH 3/4] Fixes --- types/triplesec/index.d.ts | 22 +++++++++++----------- types/triplesec/triplesec-tests.ts | 10 +++++----- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/types/triplesec/index.d.ts b/types/triplesec/index.d.ts index afe0191d51..00208a8d0a 100644 --- a/types/triplesec/index.d.ts +++ b/types/triplesec/index.d.ts @@ -6,26 +6,26 @@ /// export interface WordArray { - sigBytes: number; - words: number[]; - to_hex: () => string; + sigBytes: number; + words: number[]; + to_hex: () => string; } export interface Arguments { - data: Buffer, - key: Buffer, - progress_hook?: (progress: Progress) => void; + data: Buffer; + key: Buffer; + progress_hook?: (progress: Progress) => void; } export interface Progress { - what: string; - i: number; - total: number; + what: string; + i: number; + total: number; } export function encrypt(arg: Arguments, cb: (err: Error | null, buff: Buffer | null) => void): void; export function decrypt(arg: Arguments, cb: (err: Error | null, buff: Buffer | null) => void): void; export namespace prng { - export function generate(n: number, cb: (words: WordArray) => void): void; -} \ No newline at end of file + function generate(n: number, cb: (words: WordArray) => void): void; +} diff --git a/types/triplesec/triplesec-tests.ts b/types/triplesec/triplesec-tests.ts index 2f7037ed72..8d83d250a9 100644 --- a/types/triplesec/triplesec-tests.ts +++ b/types/triplesec/triplesec-tests.ts @@ -5,9 +5,9 @@ triplesec.encrypt({ key: new Buffer('key') }, (err, buff) => { if (err === null) { - console.log(buff); + buff; // $ExpectType Buffer | null } else { - console.log(err); + err; // $ExpectType Error } }); @@ -16,12 +16,12 @@ triplesec.decrypt({ key: new Buffer('key') }, (err, buff) => { if (err === null) { - console.log(buff); + buff; // $ExpectType Buffer | null } else { - console.log(err); + err; // $ExpectType Error } }); triplesec.prng.generate(24, words => { - console.log(words.to_hex()); // $ExpectType string + words.to_hex(); // $ExpectType string }); From 589b44a84596d7ad84a7cca994ec5d05e532a431 Mon Sep 17 00:00:00 2001 From: threesquared Date: Thu, 28 Jun 2018 14:25:15 +0100 Subject: [PATCH 4/4] Add more tests --- types/triplesec/triplesec-tests.ts | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/types/triplesec/triplesec-tests.ts b/types/triplesec/triplesec-tests.ts index 8d83d250a9..adba7a131d 100644 --- a/types/triplesec/triplesec-tests.ts +++ b/types/triplesec/triplesec-tests.ts @@ -1,8 +1,15 @@ import * as triplesec from 'triplesec'; +const progressHook = (progress: triplesec.Progress) => { + progress.what; // $ExpectType string + progress.i; // $ExpectType number + progress.total; // $ExpectType number +}; + triplesec.encrypt({ data: new Buffer('data'), - key: new Buffer('key') + key: new Buffer('key'), + progress_hook: progressHook, }, (err, buff) => { if (err === null) { buff; // $ExpectType Buffer | null @@ -13,7 +20,8 @@ triplesec.encrypt({ triplesec.decrypt({ data: new Buffer('data'), - key: new Buffer('key') + key: new Buffer('key'), + progress_hook: progressHook, }, (err, buff) => { if (err === null) { buff; // $ExpectType Buffer | null @@ -23,5 +31,7 @@ triplesec.decrypt({ }); triplesec.prng.generate(24, words => { + words.sigBytes; // $ExpectType number + words.words; // $ExpectType number[] words.to_hex(); // $ExpectType string });