Add type definitions for Keychain NPM module

types/keychain/index.d.ts

@@ -0,0 +1,51 @@
+// Type definitions for keychain 1.4
+// Project: https://github.com/drudge/node-keychain
+// Definitions by: Lucas Santos <https://github.com/khaosdoctor>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+declare namespace keychainTypes {
+    interface KeyChainBaseOptions {
+        account: string;
+        service: string;
+        password: string;
+        type?: 'generic' | 'internet';
+    }
+
+    type KeychainErrorCodes =
+        | 'UnsupportedPlatform'
+        | 'NoAccountProvided'
+        | 'NoServiceProvided'
+        | 'NoPasswordProvided'
+        | 'ServiceFailure'
+        | 'PasswordNotFound';
+
+    type KeychainErrorType = `${KeychainErrorCodes}Error`;
+
+    class KeychainError extends Error {
+        code: KeychainErrorCodes;
+        type: KeychainErrorType;
+    }
+}
+
+declare function getPassword(
+    options: Pick<keychainTypes.KeyChainBaseOptions, 'account' | 'service'>,
+    callback: (err: keychainTypes.KeychainError, password: string) => void,
+): void;
+
+declare function setPassword(
+    options: keychainTypes.KeyChainBaseOptions,
+    callback: (err: keychainTypes.KeychainError) => void,
+): void;
+
+declare function deletePassword(
+    options: Pick<keychainTypes.KeyChainBaseOptions, 'account' | 'service'>,
+    callback: (err: keychainTypes.KeychainError) => void,
+): void;
+
+declare const keychain: typeof keychainTypes & {
+    getPassword: typeof getPassword;
+    setPassword: typeof setPassword;
+    deletePassword: typeof deletePassword;
+};
+
+export = keychain;

types/keychain/keychain-tests.ts

@@ -0,0 +1,74 @@
+import keychain = require('keychain');
+
+/**
+ * setPassword
+ */
+
+// @ts-expect-error
+// Errors when doesn't have the required properties
+keychain.setPassword({ account: 'some-account' }, err => {
+    if (err) {
+        err; // $ExpectType KeychainError
+    }
+});
+
+// @ts-expect-error
+// Another error when missing options
+keychain.setPassword({ account: 'some-account', password: 'some-pass' }, err => {
+    if (err) {
+        err; // $ExpectType KeychainError
+    }
+});
+
+// Should pass
+keychain.setPassword({ account: 'some-account', password: 'some-pass', service: 'some-service' }, err => {
+    if (err) {
+        err; // $ExpectType KeychainError
+    }
+});
+
+/**
+ * getPassword
+ */
+
+// @ts-expect-error
+// Errors when doesn't have the required properties
+keychain.getPassword({ account: 'some-account' }, (err, password) => {
+    if (err) {
+        err; // $ExpectType KeychainError
+        return;
+    }
+
+    return password;
+});
+
+// Should pass
+keychain.getPassword({ account: 'some-account', service: 'some-service' }, (err, password) => {
+    if (err) {
+        err; // $ExpectType KeychainError
+        return;
+    }
+
+    return password;
+});
+
+/**
+ * deletePassword
+ */
+
+// @ts-expect-error
+// Errors when doesn't have the required properties
+keychain.deletePassword({ account: 'some-account' }, err => {
+    if (err) {
+        err; // $ExpectType KeychainError
+        return;
+    }
+});
+
+// Should pass
+keychain.getPassword({ account: 'some-account', service: 'some-service' }, err => {
+    if (err) {
+        err; // $ExpectType KeychainError
+        return;
+    }
+});

types/keychain/tsconfig.json

@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "keychain-tests.ts"
+    ]
+}

types/keychain/tslint.json

@@ -0,0 +1,3 @@
+{
+    "extends": "@definitelytyped/dtslint/dt.json"
+}