move storage adapter interface back to utils

Author: ricardo-devis-agullo

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

@@ -8,8 +8,11 @@ import format from 'stringformat';
 import fs from 'fs-extra';
 import nodeDir, { PathsResult } from 'node-dir';
 import { promisify } from 'util';
-
-import { getFileInfo, strings } from 'oc-storage-adapters-utils';
+import {
+  getFileInfo,
+  strings,
+  StorageAdapter
+} from 'oc-storage-adapters-utils';
 
 const getPaths: (path: string) => Promise<PathsResult> = promisify(
   nodeDir.paths
@@ -39,27 +42,6 @@ export interface AzureConfig {
   refreshInterval?: number;
 }
 
-export interface StorageAdapter {
-  adapterType: string;
-  getFile(filePath: string): Promise<string>;
-  getJson<T = unknown>(filePath: string, force?: boolean): Promise<T>;
-  getUrl: (componentName: string, version: string, fileName: string) => string;
-  listSubDirectories(dir: string): Promise<string[]>;
-  maxConcurrentRequests: number;
-  putDir(folderPath: string, filePath: string): Promise<unknown>;
-  putFile(
-    filePath: string,
-    fileName: string,
-    isPrivate: boolean
-  ): Promise<unknown>;
-  putFileContent(
-    data: unknown,
-    path: string,
-    isPrivate: boolean
-  ): Promise<unknown>;
-  isValid: () => boolean;
-}
-
 export default function azureAdapter(conf: AzureConfig): StorageAdapter {
   const isValid = () => {
     if (

packages/oc-gs-storage-adapter/src/index.ts

@@ -4,7 +4,11 @@ import fs from 'fs-extra';
 import nodeDir, { PathsResult } from 'node-dir';
 import { Storage, UploadOptions } from '@google-cloud/storage';
 import tmp from 'tmp';
-import { getFileInfo, strings } from 'oc-storage-adapters-utils';
+import {
+  getFileInfo,
+  strings,
+  StorageAdapter
+} from 'oc-storage-adapters-utils';
 import { promisify } from 'util';
 
 const getPaths: (path: string) => Promise<PathsResult> = promisify(
@@ -20,27 +24,6 @@ export interface GsConfig {
   refreshInterval?: number;
 }
 
-export interface StorageAdapter {
-  adapterType: string;
-  getFile(filePath: string): Promise<string>;
-  getJson<T = unknown>(filePath: string, force?: boolean): Promise<T>;
-  getUrl: (componentName: string, version: string, fileName: string) => string;
-  listSubDirectories(dir: string): Promise<string[]>;
-  maxConcurrentRequests: number;
-  putDir(folderPath: string, filePath: string): Promise<unknown>;
-  putFile(
-    filePath: string,
-    fileName: string,
-    isPrivate: boolean
-  ): Promise<unknown>;
-  putFileContent(
-    data: unknown,
-    path: string,
-    isPrivate: boolean
-  ): Promise<unknown>;
-  isValid: () => boolean;
-}
-
 export default function gsAdapter(conf: GsConfig): StorageAdapter {
   const isValid = () => {
     if (!conf.bucket || !conf.projectId || !conf.path) {

packages/oc-s3-storage-adapter/src/index.ts

@@ -10,7 +10,12 @@ import nodeDir, { PathsResult } from 'node-dir';
 import _ from 'lodash';
 import { promisify } from 'util';
 
-import { getFileInfo, getNextYear, strings } from 'oc-storage-adapters-utils';
+import {
+  getFileInfo,
+  getNextYear,
+  strings,
+  StorageAdapter
+} from 'oc-storage-adapters-utils';
 
 import type { Agent as httpAgent } from 'http';
 import type { Agent as httpsAgent } from 'https';
@@ -44,27 +49,6 @@ export type S3Config = RequireAllOrNone<
   'key' | 'secret'
 >;
 
-export interface StorageAdapter {
-  adapterType: string;
-  getFile(filePath: string): Promise<string>;
-  getJson<T = unknown>(filePath: string, force?: boolean): Promise<T>;
-  getUrl: (componentName: string, version: string, fileName: string) => string;
-  listSubDirectories(dir: string): Promise<string[]>;
-  maxConcurrentRequests: number;
-  putDir(folderPath: string, filePath: string): Promise<unknown>;
-  putFile(
-    filePath: string,
-    fileName: string,
-    isPrivate: boolean
-  ): Promise<unknown>;
-  putFileContent(
-    data: unknown,
-    path: string,
-    isPrivate: boolean
-  ): Promise<unknown>;
-  isValid: () => boolean;
-}
-
 const streamToString = (stream: NodeJS.ReadableStream) =>
   new Promise((resolve, reject) => {
     const chunks: Buffer[] = [];

packages/oc-storage-adapters-utils/src/index.ts

@@ -3,50 +3,23 @@ export { getMimeType } from './get-mime-type';
 export { getNextYear } from './get-next-year';
 export * as strings from './strings';
 
-type Callback<Data = unknown, E = Error> = (err: E | null, data: Data) => void;
-
 export interface StorageAdapter {
   adapterType: string;
-  getFile: {
-    (filePath: string, cb: Callback<string>): void;
-    (filePath: string): Promise<string>;
-  };
-  getJson: {
-    <T = unknown>(
-      filePath: string,
-      force: boolean,
-      cb: Callback<T, string>
-    ): void;
-    <T = unknown>(filePath: string, force: boolean): Promise<T>;
-    <T = unknown>(filePath: string, cb: Callback<T, string>): void;
-    <T = unknown>(filePath: string): Promise<T>;
-  };
+  getFile(filePath: string): Promise<string>;
+  getJson<T = unknown>(filePath: string, force?: boolean): Promise<T>;
   getUrl: (componentName: string, version: string, fileName: string) => string;
-  listSubDirectories: {
-    (dir: string, cb: Callback<string[], Error & { code?: string }>): void;
-    (dir: string): Promise<string[]>;
-  };
+  listSubDirectories(dir: string): Promise<string[]>;
   maxConcurrentRequests: number;
-  putDir: {
-    (folderPath: string, filePath: string, cb: Callback): void;
-    (folderPath: string, filePath: string): Promise<unknown>;
-  };
-  putFile: {
-    (
-      filePath: string,
-      fileName: string,
-      isPrivate: boolean,
-      callback: Callback<unknown, string>
-    ): void;
-    (filePath: string, fileName: string, isPrivate: boolean): Promise<unknown>;
-  };
-  putFileContent: {
-    (
-      data: unknown,
-      path: string,
-      isPrivate: boolean,
-      callback: Callback<unknown, string>
-    ): void;
-    (data: unknown, path: string, isPrivate: boolean): Promise<unknown>;
-  };
+  putDir(folderPath: string, filePath: string): Promise<unknown>;
+  putFile(
+    filePath: string,
+    fileName: string,
+    isPrivate: boolean
+  ): Promise<unknown>;
+  putFileContent(
+    data: unknown,
+    path: string,
+    isPrivate: boolean
+  ): Promise<unknown>;
+  isValid: () => boolean;
 }