Gzip typescript conversion

packages/compress-gzip/package.json

@@ -2,25 +2,29 @@
   "name": "@keyv/compress-gzip",
   "version": "1.1.2",
   "description": "gzip compression for keyv",
-  "main": "src/index.js",
+  "main": "dist/index.js",
   "scripts": {
-    "test": "xo && nyc ava",
+    "test": "xo && yarn run build && nyc ava --serial",
+		"prepare": "yarn run build",
+		"build": "tsc",
     "coverage": "nyc report --reporter=text-lcov > coverage.lcov",
     "clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf coverage.lcov && rm -rf ./test/testdb.sqlite"
   },
   "xo": {
     "rules": {
       "unicorn/prefer-module": 0,
-      "unicorn/prefer-node-protocol": 0
+      "unicorn/prefer-node-protocol": 0,
+      "@typescript-eslint/no-unsafe-assignment": 0,
+      "@typescript-eslint/no-var-requires": 0,
+      "@typescript-eslint/no-require-imports": 0,
+      "@typescript-eslint/naming-convention": 0
     }
   },
   "ava": {
     "require": [
-      "requirable",
       "ts-node/register"
     ],
     "extensions": [
-      "js",
       "ts"
     ]
   },
@@ -52,6 +56,7 @@
     "pako": "^2.0.4"
   },
   "devDependencies": {
+    "@ava/typescript": "^3.0.1",
     "@keyv/test-suite": "*",
     "@types/keyv": "^3.1.4",
     "ava": "^5.0.1",

packages/compress-gzip/src/index.js → packages/compress-gzip/src/index.ts

@@ -1,30 +1,31 @@
-const pako = require('pako');
-const JSONB = require('json-buffer');
+import pako from 'pako';
+import JSONB from 'json-buffer';
 
 class KeyvGzip {
-	constructor(options) {
+	opts: any;
+	constructor(options?: any) {
 		this.opts = {
 			to: 'string',
 			...options,
 		};
 	}
 
-	async compress(value, options) {
+	async compress(value: any, options?: any) {
 		return pako.deflate(value, options ? options : this.opts);
 	}
 
-	async decompress(value, options) {
+	async decompress(value: any, options?: any) {
 		return pako.inflate(value, options ? options : this.opts);
 	}
 
-	async serialize({value, expires}) {
+	async serialize({value, expires}: any) {
 		return JSONB.stringify({value: await this.compress(value, this.opts), expires});
 	}
 
-	async deserialize(data) {
+	async deserialize(data: any) {
 		const {value, expires} = JSONB.parse(data);
 		return {value: await this.decompress(value, this.opts), expires};
 	}
 }
 
-module.exports = KeyvGzip;
+export default KeyvGzip;

packages/compress-gzip/test/test.js → packages/compress-gzip/test/test.ts

@@ -1,47 +1,44 @@
+/* eslint-disable @typescript-eslint/no-unsafe-call */
 const test = require('ava');
 const {keyvCompresstionTests} = require('@keyv/test-suite');
-const KeyvGzip = require('../src/index.js');
+const KeyvGzip = require('../dist/index.js').default;
 
 keyvCompresstionTests(test, new KeyvGzip());
 
-test('number array compression/decompression with Unit8Array', async t => {
+test('number array compression/decompression with Unit8Array', async (t: any) => {
 	const keyv = new KeyvGzip();
 	const array = new Uint8Array([4, 5, 6, 7]);
 	const compressed = await keyv.compress(array);
 	const decompressed = await keyv.decompress(compressed, {});
 	t.deepEqual(decompressed, array);
 });
 
-test('object type compression/decompression', async t => {
+test('object type compression/decompression', async (t: any) => {
 	const keyv = new KeyvGzip();
-	const object = new Uint8Array({
-		a: 1,
-		b: 'test',
-		c: true,
-	});
+	const object = new Uint8Array([1, 2, 3]);
 	const compressed = await keyv.compress(object);
 	const decompressed = await keyv.decompress(compressed, {});
 	t.deepEqual(decompressed, object);
 });
 
 // Test options while compress
-test('options while compress', async t => {
+test('options while compress', async (t: any) => {
 	const keyv = new KeyvGzip();
 	const compressed = await keyv.compress('whatever', {chunkSize: 32 * 1024});
 	t.not(compressed, 'whatever');
 	const compressedWithoutOptions = await keyv.compress('whatever');
 	t.not(compressed, compressedWithoutOptions);
 });
 // Test options at class level
-test('options at class level', async t => {
+test('options at class level', async (t: any) => {
 	const keyv = new KeyvGzip({chunkSize: 32 * 1024});
 	const compressed = await keyv.compress('whatever');
 	t.not(compressed, 'whatever');
 	const compressedWithoutOptions = await new KeyvGzip().compress('whatever');
 	t.not(compressed, compressedWithoutOptions);
 });
 
-test('compression with compression options', async t => {
+test('compression with compression options', async (t: any) => {
 	const options = {};
 
 	const keyv = new KeyvGzip(options);
@@ -51,7 +48,7 @@ test('compression with compression options', async t => {
 	t.not(compressed, compressedWithoutOptions);
 });
 
-test('decompression with decompression options', async t => {
+test('decompression with decompression options', async (t: any) => {
 	const options = {};
 
 	const keyv = new KeyvGzip(options);
@@ -60,7 +57,7 @@ test('decompression with decompression options', async t => {
 	t.is(decompressed, 'whatever');
 });
 
-test('compression/decompression with compression/decompression options', async t => {
+test('compression/decompression with compression/decompression options', async (t: any) => {
 	const options = {
 		chunkSize: 1024,
 	};

packages/compress-gzip/tsconfig.json

@@ -0,0 +1,102 @@
+{
+    "compilerOptions": {
+        /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+        /* Projects */
+        // "incremental": true,                              /* Enable incremental compilation */
+        // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+        // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+        // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+        // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+        // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+        /* Language and Environment */
+        "target": "es2020",                                     /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+        // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+        // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+        // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+        // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+        // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+        // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+        // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+        // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+        // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+        // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+        /* Modules */
+        "module": "commonjs",                                /* Specify what module code is generated. */
+        // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+        "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+        // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+        // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+        // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+        // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+        // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+        // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+        // "resolveJsonModule": true,                        /* Enable importing .json files */
+        // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+        /* JavaScript Support */
+        // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+        // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+        // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+        /* Emit */
+        "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+        // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+        // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+        // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+        // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+        "outDir": "dist",                                   /* Specify an output folder for all emitted files. */
+        // "removeComments": true,                           /* Disable emitting comments. */
+        // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+        // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+        // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+        // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+        // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+        // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+        // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+        // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+        // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+        // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+        // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+        // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+        // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+        // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+        // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+        /* Interop Constraints */
+        // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+        // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+        "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+        // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+        "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+        /* Type Checking */
+        "strict": true,                                      /* Enable all strict type-checking options. */
+        // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+        // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+        // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+        // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+        // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+        // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+        // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+        // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+        // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+        // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+        // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+        // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+        // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+        // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+        // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+        // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+        // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+        // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+        /* Completeness */
+        // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+        "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+    },
+    "include": ["src/**/*"],
+    "exclude": ["src/index.d.ts"]
+}

packages/keyv/test/test.js

@@ -5,7 +5,7 @@ const tk = require('timekeeper');
 const KeyvSqlite = require('@keyv/sqlite');
 const KeyvMongo = require('@keyv/mongo');
 const KeyvBrotli = require('@keyv/compress-brotli');
-const KeyvGzip = require('@keyv/compress-gzip');
+const KeyvGzip = require('@keyv/compress-gzip').default;
 
 keyvOfficialTests(test, Keyv, 'sqlite://test/testdb.sqlite', 'sqlite://non/existent/database.sqlite');
 const store = () => new KeyvSqlite({uri: 'sqlite://test/testdb.sqlite', busyTimeout: 3000});