@geekmidas/storage 0.0.5 → 1.0.0

package/src/AmazonStorageClient.ts

@@ -1,195 +1,195 @@
 import {
-  GetObjectCommand,
-  ListObjectVersionsCommand,
-  PutObjectCommand,
-  S3Client,
+	GetObjectCommand,
+	ListObjectVersionsCommand,
+	PutObjectCommand,
+	S3Client,
 } from '@aws-sdk/client-s3';
 import { createPresignedPost } from '@aws-sdk/s3-presigned-post';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
 
 import type { Cache } from '@geekmidas/cache';
 import {
-  type DocumentVersion,
-  type File,
-  type GetUploadParams,
-  type GetUploadResponse,
-  type StorageClient,
-  StorageProvider,
+	type DocumentVersion,
+	type File,
+	type GetUploadParams,
+	type GetUploadResponse,
+	type StorageClient,
+	StorageProvider,
 } from './StorageClient';
 
 export class AmazonStorageClient implements StorageClient {
-  readonly provider = StorageProvider.AWSS3;
-
-  static create(
-    options: AmazonStorageClientCreateOptions,
-  ): AmazonStorageClient {
-    const {
-      bucket,
-      region,
-      accessKeyId,
-      acl,
-      endpoint,
-      secretAccessKey,
-      forcePathStyle = false,
-      cache,
-    } = options;
-    const hasCredentials = accessKeyId && secretAccessKey;
-    const credentials = hasCredentials
-      ? { accessKeyId, secretAccessKey }
-      : undefined;
-
-    const client = new S3Client({
-      region,
-      credentials,
-      endpoint,
-      forcePathStyle,
-    });
-
-    return new AmazonStorageClient(client, bucket, acl, cache);
-  }
-  constructor(
-    private readonly client: S3Client,
-    private readonly bucket: string,
-    private readonly acl = AmazonCannedAccessControlList.AuthenticatedRead,
-    readonly cache?: Cache<string>,
-  ) {}
-
-  getVersionDownloadURL(file: File, versionId: string): Promise<string> {
-    const ResponseContentDisposition = file.name
-      ? `attachment; filename=${encodeURIComponent(file.name)}`
-      : undefined;
-
-    const command = new GetObjectCommand({
-      Bucket: this.bucket,
-      Key: file.path,
-      ResponseContentDisposition,
-      VersionId: versionId,
-    });
-
-    return getSignedUrl(this.client, command, { expiresIn: 60 * 60 * 24 });
-  }
-
-  async getVersions(key: string): Promise<DocumentVersion[]> {
-    const command = new ListObjectVersionsCommand({
-      Bucket: this.bucket,
-      Prefix: key,
-    });
-
-    const { Versions = [] } = await this.client.send(command);
-
-    return Versions.map((version) => ({
-      id: version.VersionId || '',
-      createdAt: version.LastModified || new Date(),
-    }));
-  }
-
-  async getDownloadURL(file: File, expiresIn = 60 * 60): Promise<string> {
-    const cacheKey = `download-url:${file.path}`;
-    const cachedURL = await this.cache?.get(cacheKey);
-
-    if (cachedURL) {
-      return cachedURL;
-    }
-
-    const ResponseContentDisposition = file.name
-      ? `attachment; filename=${encodeURIComponent(file.name)}`
-      : undefined;
-
-    const command = new GetObjectCommand({
-      Bucket: this.bucket,
-      Key: file.path,
-      ResponseContentDisposition,
-    });
-
-    const url = await getSignedUrl(this.client, command, { expiresIn });
-    const cacheExpiration = Math.max(expiresIn - 60, 0);
-
-    if (cacheExpiration) {
-      await this.cache?.set(cacheKey, url, cacheExpiration);
-    }
-
-    return url;
-  }
-
-  async getUploadURL(
-    params: GetUploadParams,
-    expiresIn = 60 * 60,
-  ): Promise<string> {
-    const command = new PutObjectCommand({
-      Bucket: this.bucket,
-      Key: params.path,
-      ContentType: params.contentType,
-      ContentLength: params.contentLength,
-    });
-
-    return getSignedUrl(this.client, command, { expiresIn });
-  }
-
-  async getUpload(
-    params: GetUploadParams,
-    expiresIn = 5,
-  ): Promise<GetUploadResponse> {
-    const { path } = params;
-    const { fields: values, url } = await createPresignedPost(this.client, {
-      Expires: expiresIn * 60,
-      Bucket: this.bucket,
-      Fields: {
-        acl: this.acl,
-      },
-      Conditions: [
-        // content length restrictions: 0-1MB]
-        // ['content-length-range', 0, contentLength],
-        // specify content-type to be more generic- images only
-        // ['starts-with', '$Content-Type', 'image/'],
-        // ['starts-with', '$Content-Type', contentType],
-      ],
-      Key: path,
-    });
-
-    const keys = Object.keys(values);
-    const fields = keys.map((key) => ({ key, value: values[key] || '' }));
-
-    return { url, fields };
-  }
-
-  async upload(
-    key: string,
-    data: string | Buffer,
-    contentType: string,
-  ): Promise<void> {
-    const Body = typeof data === 'string' ? Buffer.from(data, 'base64') : data;
-
-    const params = {
-      Bucket: this.bucket,
-      Key: key,
-      Body,
-      ContentType: contentType,
-    };
-
-    const command = new PutObjectCommand(params);
-
-    await this.client.send(command);
-  }
+	readonly provider = StorageProvider.AWSS3;
+
+	static create(
+		options: AmazonStorageClientCreateOptions,
+	): AmazonStorageClient {
+		const {
+			bucket,
+			region,
+			accessKeyId,
+			acl,
+			endpoint,
+			secretAccessKey,
+			forcePathStyle = false,
+			cache,
+		} = options;
+		const hasCredentials = accessKeyId && secretAccessKey;
+		const credentials = hasCredentials
+			? { accessKeyId, secretAccessKey }
+			: undefined;
+
+		const client = new S3Client({
+			region,
+			credentials,
+			endpoint,
+			forcePathStyle,
+		});
+
+		return new AmazonStorageClient(client, bucket, acl, cache);
+	}
+	constructor(
+		private readonly client: S3Client,
+		private readonly bucket: string,
+		private readonly acl = AmazonCannedAccessControlList.AuthenticatedRead,
+		readonly cache?: Cache,
+	) {}
+
+	getVersionDownloadURL(file: File, versionId: string): Promise<string> {
+		const ResponseContentDisposition = file.name
+			? `attachment; filename=${encodeURIComponent(file.name)}`
+			: undefined;
+
+		const command = new GetObjectCommand({
+			Bucket: this.bucket,
+			Key: file.path,
+			ResponseContentDisposition,
+			VersionId: versionId,
+		});
+
+		return getSignedUrl(this.client, command, { expiresIn: 60 * 60 * 24 });
+	}
+
+	async getVersions(key: string): Promise<DocumentVersion[]> {
+		const command = new ListObjectVersionsCommand({
+			Bucket: this.bucket,
+			Prefix: key,
+		});
+
+		const { Versions = [] } = await this.client.send(command);
+
+		return Versions.map((version) => ({
+			id: version.VersionId || '',
+			createdAt: version.LastModified || new Date(),
+		}));
+	}
+
+	async getDownloadURL(file: File, expiresIn = 60 * 60): Promise<string> {
+		const cacheKey = `download-url:${file.path}`;
+		const cachedURL = await this.cache?.get<string>(cacheKey);
+
+		if (cachedURL) {
+			return cachedURL;
+		}
+
+		const ResponseContentDisposition = file.name
+			? `attachment; filename=${encodeURIComponent(file.name)}`
+			: undefined;
+
+		const command = new GetObjectCommand({
+			Bucket: this.bucket,
+			Key: file.path,
+			ResponseContentDisposition,
+		});
+
+		const url = await getSignedUrl(this.client, command, { expiresIn });
+		const cacheExpiration = Math.max(expiresIn - 60, 0);
+
+		if (cacheExpiration) {
+			await this.cache?.set(cacheKey, url, cacheExpiration);
+		}
+
+		return url;
+	}
+
+	async getUploadURL(
+		params: GetUploadParams,
+		expiresIn = 60 * 60,
+	): Promise<string> {
+		const command = new PutObjectCommand({
+			Bucket: this.bucket,
+			Key: params.path,
+			ContentType: params.contentType,
+			ContentLength: params.contentLength,
+		});
+
+		return getSignedUrl(this.client, command, { expiresIn });
+	}
+
+	async getUpload(
+		params: GetUploadParams,
+		expiresIn = 5,
+	): Promise<GetUploadResponse> {
+		const { path } = params;
+		const { fields: values, url } = await createPresignedPost(this.client, {
+			Expires: expiresIn * 60,
+			Bucket: this.bucket,
+			Fields: {
+				acl: this.acl,
+			},
+			Conditions: [
+				// content length restrictions: 0-1MB]
+				// ['content-length-range', 0, contentLength],
+				// specify content-type to be more generic- images only
+				// ['starts-with', '$Content-Type', 'image/'],
+				// ['starts-with', '$Content-Type', contentType],
+			],
+			Key: path,
+		});
+
+		const keys = Object.keys(values);
+		const fields = keys.map((key) => ({ key, value: values[key] || '' }));
+
+		return { url, fields };
+	}
+
+	async upload(
+		key: string,
+		data: string | Buffer,
+		contentType: string,
+	): Promise<void> {
+		const Body = typeof data === 'string' ? Buffer.from(data, 'base64') : data;
+
+		const params = {
+			Bucket: this.bucket,
+			Key: key,
+			Body,
+			ContentType: contentType,
+		};
+
+		const command = new PutObjectCommand(params);
+
+		await this.client.send(command);
+	}
 }
 
 export enum AmazonCannedAccessControlList {
-  AuthenticatedRead = 'authenticated-read',
-  Private = 'private',
-  PublicRead = 'public-read',
-  PublicReadWrite = 'public-read-write',
-  AwsExecRead = 'aws-exec-read',
-  BucketOwnerRead = 'bucket-owner-read',
-  BucketOwnerFullControl = 'bucket-owner-full-control',
-  LogDeliveryWrite = 'log-delivery-write',
+	AuthenticatedRead = 'authenticated-read',
+	Private = 'private',
+	PublicRead = 'public-read',
+	PublicReadWrite = 'public-read-write',
+	AwsExecRead = 'aws-exec-read',
+	BucketOwnerRead = 'bucket-owner-read',
+	BucketOwnerFullControl = 'bucket-owner-full-control',
+	LogDeliveryWrite = 'log-delivery-write',
 }
 
 interface AmazonStorageClientCreateOptions {
-  bucket: string;
-  region?: string;
-  acl?: AmazonCannedAccessControlList;
-  accessKeyId?: string;
-  secretAccessKey?: string;
-  endpoint?: string;
-  forcePathStyle?: boolean;
-  cache?: Cache<string>;
+	bucket: string;
+	region?: string;
+	acl?: AmazonCannedAccessControlList;
+	accessKeyId?: string;
+	secretAccessKey?: string;
+	endpoint?: string;
+	forcePathStyle?: boolean;
+	cache?: Cache;
 }

package/src/StorageClient.ts

@@ -1,91 +1,91 @@
 import type { Cache } from '@geekmidas/cache';
 export interface DocumentVersion {
-  id: string;
-  createdAt: Date;
+	id: string;
+	createdAt: Date;
 }
 
 export enum StorageProvider {
-  AWSS3 = 'geekimdas.toolbox.storage.aws.s3',
-  GCP = 'geekimdas.toolbox.storage.gcp',
-  AZURE = 'geekimdas.toolbox.storage.azure',
+	AWSS3 = 'geekimdas.toolbox.storage.aws.s3',
+	GCP = 'geekimdas.toolbox.storage.gcp',
+	AZURE = 'geekimdas.toolbox.storage.azure',
 }
 
 export interface StorageClient {
-  readonly provider: StorageProvider;
-  readonly cache?: Cache<string>;
-  /**
-   * Get a URL to upload a file to.
-   *
-   * @param params - The parameters to get the upload URL for.
-   * @param expiresIn - The number of minutes the URL should be valid for.
-   * Defaults to 60 * 60 (1 hour).
-   * @returns A promise that resolves to the upload URL.
-   */
-  getUploadURL(params: GetUploadParams, expiresIn?: number): Promise<string>;
+	readonly provider: StorageProvider;
+	readonly cache?: Cache;
+	/**
+	 * Get a URL to upload a file to.
+	 *
+	 * @param params - The parameters to get the upload URL for.
+	 * @param expiresIn - The number of minutes the URL should be valid for.
+	 * Defaults to 60 * 60 (1 hour).
+	 * @returns A promise that resolves to the upload URL.
+	 */
+	getUploadURL(params: GetUploadParams, expiresIn?: number): Promise<string>;
 
-  /**
-   * Get a URL to download a file from.
-   *
-   * @param file - The file to get the download URL for.
-   * @param expiresIn - The number of seconds the URL should be valid for.
-   * Defaults to 60 * 60 (1 hour).
-   * @returns A promise that resolves to the download URL.
-   */
-  getDownloadURL(file: File, expiresIn?: number): Promise<string>;
-  /**
-   * Get the versions for a key.
-   *
-   * @param key - The key to get the versions for.
-   */
-  getVersions(key: string): Promise<DocumentVersion[]>;
+	/**
+	 * Get a URL to download a file from.
+	 *
+	 * @param file - The file to get the download URL for.
+	 * @param expiresIn - The number of seconds the URL should be valid for.
+	 * Defaults to 60 * 60 (1 hour).
+	 * @returns A promise that resolves to the download URL.
+	 */
+	getDownloadURL(file: File, expiresIn?: number): Promise<string>;
+	/**
+	 * Get the versions for a key.
+	 *
+	 * @param key - The key to get the versions for.
+	 */
+	getVersions(key: string): Promise<DocumentVersion[]>;
 
-  /**
-   * Get a URL to download a version of a file from.
-   *
-   * @param file - The file to get the download URL for.
-   * @param versionId - The version ID to get the download URL for.
-   */
-  getVersionDownloadURL(file: File, versionId: string): Promise<string>;
-  /**
-   *
-   * @param key - The key to upload the file to.
-   * @param data - The data to upload.
-   * @param contentType - The content type of the data.
-   */
-  upload(
-    key: string,
-    data: string | Buffer,
-    contentType: string,
-  ): Promise<void>;
-  /**
-   * Get a URL to upload a file to.
-   *
-   * @param params - The parameters to get the upload URL for.
-   * @param expiresIn - The number of minutes the URL should be valid for.
-   */
-  getUpload(
-    params: GetUploadParams,
-    expiresIn?: number,
-  ): Promise<GetUploadResponse>;
+	/**
+	 * Get a URL to download a version of a file from.
+	 *
+	 * @param file - The file to get the download URL for.
+	 * @param versionId - The version ID to get the download URL for.
+	 */
+	getVersionDownloadURL(file: File, versionId: string): Promise<string>;
+	/**
+	 *
+	 * @param key - The key to upload the file to.
+	 * @param data - The data to upload.
+	 * @param contentType - The content type of the data.
+	 */
+	upload(
+		key: string,
+		data: string | Buffer,
+		contentType: string,
+	): Promise<void>;
+	/**
+	 * Get a URL to upload a file to.
+	 *
+	 * @param params - The parameters to get the upload URL for.
+	 * @param expiresIn - The number of minutes the URL should be valid for.
+	 */
+	getUpload(
+		params: GetUploadParams,
+		expiresIn?: number,
+	): Promise<GetUploadResponse>;
 }
 
 export interface GetUploadParams {
-  path: string;
-  contentType: string;
-  contentLength: number;
+	path: string;
+	contentType: string;
+	contentLength: number;
 }
 
 export type UploadField = {
-  key: string;
-  value: string;
+	key: string;
+	value: string;
 };
 
 export type GetUploadResponse = {
-  url: string;
-  fields: UploadField[];
+	url: string;
+	fields: UploadField[];
 };
 
 export interface File {
-  name?: string;
-  path: string;
+	name?: string;
+	path: string;
 }