Merge pull request #321 from opencomponents/typescript

Typescript

Author: ricardo-devis-agullo

.gitignore

@@ -22,4 +22,5 @@ npm-debug.log
 node_modules
 coverage
 /mocks/handlebars-component/_compile-static-package6/
-package-lock.json
+package-lock.json
+lib/

globals.d.ts

@@ -0,0 +1,59 @@
+declare module 'universalify' {
+  export function fromCallback<
+    Arguments extends readonly unknown[],
+    ErrorValue,
+    ReturnValue
+  >(
+    fn: (
+      ...arguments_: [
+        ...Arguments,
+        (error: ErrorValue, value: ReturnValue) => void
+      ]
+    ) => void
+  ): {
+    (...arguments_: Arguments): Promise<ReturnValue>;
+    (
+      ...arguments_: [
+        ...Arguments,
+        (error: ErrorValue, value: ReturnValue) => void
+      ]
+    ): void;
+  };
+
+  export function fromPromise<
+    Arguments extends readonly unknown[],
+    ReturnValue
+  >(
+    fn: (...arguments_: [...Arguments]) => Promise<ReturnValue>
+  ): {
+    (...arguments_: Arguments): Promise<ReturnValue>;
+    (
+      ...arguments_: [
+        ...Arguments,
+        (error: unknown, value: ReturnValue) => void
+      ]
+    ): void;
+  };
+}
+
+declare module 'nice-cache' {
+  class Cache {
+    constructor(opt: { refreshInterval?: number; verbose?: boolean });
+
+    get(type: string, key: string): any;
+    set(type: string, key: string, data: unknown): void;
+    sub(
+      type: string,
+      key: string,
+      subscriber: (...args: unknown[]) => void
+    ): void;
+  }
+
+  export = Cache;
+}
+
+declare module 'stringformat' {
+  function format(...args: string[]): string;
+
+  export = format;
+}

package.json

@@ -6,8 +6,8 @@
     "clean": "lerna clean",
     "dev": "jest --watch",
     "updated": "lerna updated",
-    "test": "jest",
-    "publish": "lerna publish --exact",
+    "test": "lerna run tsc && jest",
+    "publish": "lerna run tsc && lerna publish --exact",
     "precommit": "lint-staged",
     "prepare": "husky install"
   },
@@ -23,6 +23,7 @@
     "collectCoverage": true
   },
   "devDependencies": {
+    "@types/node": "18.8.3",
     "@typescript-eslint/eslint-plugin": "5.0.0",
     "@typescript-eslint/parser": "5.0.0",
     "eslint": "8.0.1",
@@ -33,6 +34,6 @@
     "lerna": "4.0.0",
     "lint-staged": "10.0.7",
     "prettier": "2.4.1",
-    "typescript": "4.4.4"
+    "typescript": "4.8.4"
   }
-}
+}

packages/oc-azure-storage-adapter/__test__/azure.test.js

@@ -1,5 +1,5 @@
 const Readable = require('stream').Readable;
-const azure = require('../');
+const azure = require('../lib');
 
 //Mock Date functions
 const DATE_TO_USE = new Date('2017');

packages/oc-azure-storage-adapter/__test__/privateFilesExclusion.test.js

@@ -1,4 +1,4 @@
-const adapter = require('../');
+const adapter = require('../lib');
 
 jest.mock('async', () => {
   return {

packages/oc-azure-storage-adapter/index.d.ts

@@ -2,13 +2,14 @@
   "name": "oc-azure-storage-adapter",
   "version": "0.2.0",
   "description": "Azure storage adapter for OC",
-  "main": "index.js",
-  "types": "index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "tsc": "tsc",
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
   "files": [
-    "index.js",
-    "index.d.ts",
-    "LICENSE",
-    "README.md"
+    "lib"
   ],
   "repository": {
     "type": "git",
@@ -39,5 +40,11 @@
     "oc-storage-adapters-utils": "1.1.0",
     "stringformat": "^0.0.5",
     "universalify": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/async": "3.2.15",
+    "@types/fs-extra": "9.0.13",
+    "@types/lodash": "4.14.186",
+    "@types/node-dir": "0.0.34"
   }
-}
+}

packages/oc-azure-storage-adapter/package.json

@@ -1,18 +1,30 @@
-'use strict';
-
-const async = require('async');
-const azure = require('azure-storage');
-const Cache = require('nice-cache');
-const format = require('stringformat');
-const fs = require('fs-extra');
-const nodeDir = require('node-dir');
-const _ = require('lodash');
-const stream = require('stream');
-const { fromCallback } = require('universalify');
-
-const { getFileInfo, strings } = require('oc-storage-adapters-utils');
-
-module.exports = function (conf) {
+import async from 'async';
+import azure from 'azure-storage';
+import Cache from 'nice-cache';
+import format from 'stringformat';
+import fs from 'fs-extra';
+import nodeDir from 'node-dir';
+import _ from 'lodash';
+import stream from 'stream';
+import { fromCallback } from 'universalify';
+
+import {
+  getFileInfo,
+  strings,
+  StorageAdapter
+} from 'oc-storage-adapters-utils';
+
+export interface AzureConfig {
+  publicContainerName: string;
+  privateContainerName: string;
+  accountName: string;
+  accountKey: string;
+  path: string;
+  verbosity?: boolean;
+  refreshInterval?: number;
+}
+
+export default function azureAdapter(conf: AzureConfig): StorageAdapter {
   const isValid = () => {
     if (
       !conf.publicContainerName ||
@@ -33,19 +45,19 @@ module.exports = function (conf) {
   const getClient = () =>
     azure.createBlobService(conf.accountName, conf.accountKey);
 
-  const getFile = (filePath, force, callback) => {
+  const getFile = (filePath: string, force: boolean, callback: any) => {
     if (_.isFunction(force)) {
       callback = force;
       force = false;
     }
 
-    const getFromAzure = cb => {
+    const getFromAzure = (cb: any) => {
       getClient().getBlobToText(
         conf.privateContainerName,
         filePath,
         (err, fileContent) => {
           if (err) {
-            if (err.statusCode === 404) {
+            if ((err as any).statusCode === 404) {
               return cb({
                 code: strings.errors.STORAGE.FILE_NOT_FOUND_CODE,
                 msg: format(strings.errors.STORAGE.FILE_NOT_FOUND, filePath)
@@ -70,7 +82,7 @@ module.exports = function (conf) {
       return callback(null, cached);
     }
 
-    getFromAzure((err, result) => {
+    getFromAzure((err: Error | null, result: any) => {
       if (err) {
         return callback(err);
       }
@@ -80,13 +92,13 @@ module.exports = function (conf) {
     });
   };
 
-  const getJson = (filePath, force, callback) => {
+  const getJson = (filePath: string, force: boolean, callback: any) => {
     if (_.isFunction(force)) {
       callback = force;
       force = false;
     }
 
-    getFile(filePath, force, (err, file) => {
+    getFile(filePath, force, (err: Error | null, file: string) => {
       if (err) {
         return callback(err);
       }
@@ -104,21 +116,21 @@ module.exports = function (conf) {
     });
   };
 
-  const getUrl = (componentName, version, fileName) =>
+  const getUrl = (componentName: string, version: string, fileName: string) =>
     `${conf.path}${componentName}/${version}/${fileName}`;
 
-  const listSubDirectories = (dir, callback) => {
+  const listSubDirectories = (dir: string, callback: any) => {
     const normalisedPath =
       dir.lastIndexOf('/') === dir.length - 1 && dir.length > 0
         ? dir
         : `${dir}/`;
 
     const listBlobsWithPrefix = (
-      azureClient,
-      containerName,
-      prefix,
-      continuationToken,
-      callback
+      azureClient: azure.BlobService,
+      containerName: string,
+      prefix: string,
+      continuationToken: azure.common.ContinuationToken,
+      callback: any
     ) => {
       azureClient.listBlobsSegmentedWithPrefix(
         containerName,
@@ -165,7 +177,7 @@ module.exports = function (conf) {
             containerName,
             prefix,
             result.continuationToken,
-            (err, entryNames) => {
+            (err: Error | null, entryNames: string[]) => {
               if (err) {
                 return callback(err);
               }
@@ -182,15 +194,15 @@ module.exports = function (conf) {
       getClient(),
       conf.privateContainerName,
       normalisedPath,
-      null,
-      (err, res) => {
+      null as unknown as azure.common.ContinuationToken,
+      (err: Error | null, res: string[]) => {
         if (err) return callback(err);
         callback(null, _.uniq(res));
       }
     );
   };
 
-  const putDir = (dirInput, dirOutput, callback) => {
+  const putDir = (dirInput: string, dirOutput: string, callback: any) => {
     nodeDir.paths(dirInput, (err, paths) => {
       async.each(
         paths.files,
@@ -213,12 +225,18 @@ module.exports = function (conf) {
     });
   };
 
-  const putFileContent = (fileContent, fileName, isPrivate, callback) => {
+  const putFileContent = (
+    fileContent: string | fs.ReadStream,
+    fileName: string,
+    isPrivate: boolean,
+    callback: any
+  ) => {
     try {
       const fileInfo = getFileInfo(fileName);
-      const contentSettings = {
-        cacheControl: 'public, max-age=31556926'
-      };
+      const contentSettings: azure.BlobService.CreateBlockBlobRequestOptions['contentSettings'] =
+        {
+          cacheControl: 'public, max-age=31556926'
+        };
       if (fileInfo.mimeType) {
         contentSettings.contentType = fileInfo.mimeType;
       }
@@ -227,7 +245,11 @@ module.exports = function (conf) {
         contentSettings.contentEncoding = 'gzip';
       }
 
-      const uploadToAzureContainer = (rereadable, containerName, cb) => {
+      const uploadToAzureContainer = (
+        rereadable: boolean,
+        containerName: string,
+        cb: any
+      ) => {
         try {
           if (fileContent instanceof stream.Stream) {
             return fileContent.pipe(
@@ -239,6 +261,8 @@ module.exports = function (conf) {
                   if (rereadable) {
                     // I need  a fresh read stream and this is the only thing I came up with
                     // very ugly and has poor performance, but works
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
                     fileContent = getClient().createReadStream(
                       containerName,
                       fileName
@@ -267,7 +291,7 @@ module.exports = function (conf) {
       uploadToAzureContainer(
         makeReReadable,
         conf.privateContainerName,
-        (err, result) => {
+        (err: Error | null, result: any) => {
           if (err) {
             return callback(err);
           }
@@ -288,7 +312,12 @@ module.exports = function (conf) {
     }
   };
 
-  const putFile = (filePath, fileName, isPrivate, callback) => {
+  const putFile = (
+    filePath: string,
+    fileName: string,
+    isPrivate: boolean,
+    callback: any
+  ) => {
     try {
       const stream = fs.createReadStream(filePath);
       putFileContent(stream, fileName, isPrivate, callback);
@@ -308,5 +337,7 @@ module.exports = function (conf) {
     putFileContent: fromCallback(putFileContent),
     adapterType: 'azure-blob-storage',
     isValid
-  };
-};
+  } as any;
+}
+
+module.exports = azureAdapter;