@geekmidas/storage 9.0.2 → 10.0.0-alpha.1

package/dist/StorageClient-4ADnTPnJ.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"StorageClient-4ADnTPnJ.mjs","names":[],"sources":["../src/StorageClient.ts"],"sourcesContent":["import type { Cache } from '@geekmidas/cache';\nexport interface DocumentVersion {\n\tid: string;\n\tcreatedAt: Date;\n}\n\nexport enum StorageProvider {\n\tAWSS3 = 'geekimdas.toolbox.storage.aws.s3',\n\tGCP = 'geekimdas.toolbox.storage.gcp',\n\tAZURE = 'geekimdas.toolbox.storage.azure',\n}\n\nexport interface StorageClient {\n\treadonly provider: StorageProvider;\n\treadonly cache?: Cache;\n\t/**\n\t * Get a URL to upload a file to.\n\t *\n\t * @param params - The parameters to get the upload URL for.\n\t * @param expiresIn - The number of minutes the URL should be valid for.\n\t * Defaults to 60 * 60 (1 hour).\n\t * @returns A promise that resolves to the upload URL.\n\t */\n\tgetUploadURL(params: GetUploadParams, expiresIn?: number): Promise<string>;\n\n\t/**\n\t * Get a URL to download a file from.\n\t *\n\t * @param file - The file to get the download URL for.\n\t * @param expiresIn - The number of seconds the URL should be valid for.\n\t * Defaults to 60 * 60 (1 hour).\n\t * @returns A promise that resolves to the download URL.\n\t */\n\tgetDownloadURL(file: File, expiresIn?: number): Promise<string>;\n\t/**\n\t * Get the versions for a key.\n\t *\n\t * @param key - The key to get the versions for.\n\t */\n\tgetVersions(key: string): Promise<DocumentVersion[]>;\n\n\t/**\n\t * Get a URL to download a version of a file from.\n\t *\n\t * @param file - The file to get the download URL for.\n\t * @param versionId - The version ID to get the download URL for.\n\t */\n\tgetVersionDownloadURL(file: File, versionId: string): Promise<string>;\n\t/**\n\t *\n\t * @param key - The key to upload the file to.\n\t * @param data - The data to upload.\n\t * @param contentType - The content type of the data.\n\t */\n\tupload(\n\t\tkey: string,\n\t\tdata: string | Buffer,\n\t\tcontentType: string,\n\t): Promise<void>;\n\t/**\n\t * Get a URL to upload a file to.\n\t *\n\t * @param params - The parameters to get the upload URL for.\n\t * @param expiresIn - The number of minutes the URL should be valid for.\n\t */\n\tgetUpload(\n\t\tparams: GetUploadParams,\n\t\texpiresIn?: number,\n\t): Promise<GetUploadResponse>;\n\t/**\n\t * Delete a file from storage.\n\t *\n\t * @param key - The key (path) of the file to delete.\n\t */\n\tdelete(key: string): Promise<void>;\n}\n\nexport interface GetUploadParams {\n\tpath: string;\n\tcontentType: string;\n\tcontentLength: number;\n}\n\nexport type UploadField = {\n\tkey: string;\n\tvalue: string;\n};\n\nexport type GetUploadResponse = {\n\turl: string;\n\tfields: UploadField[];\n};\n\nexport interface File {\n\tname?: string;\n\tpath: string;\n\t/**\n\t * Override the Content-Type of the response.\n\t * Useful when the stored object's content type differs from what the browser should receive.\n\t */\n\tresponseContentType?: string;\n\t/**\n\t * Control how the browser handles the file.\n\t * - `'attachment'` — prompts download (default when `name` is set)\n\t * - `'inline'` — displays in the browser\n\t */\n\tdisposition?: 'inline' | 'attachment';\n}\n"],"mappings":";AAMA,IAAY,8DAAL;AACN;AACA;AACA;;AACA"}

package/dist/StorageClient-BDRVrMJj.cjs

@@ -1,17 +0,0 @@
-
-//#region src/StorageClient.ts
-let StorageProvider = /* @__PURE__ */ function(StorageProvider$1) {
-	StorageProvider$1["AWSS3"] = "geekimdas.toolbox.storage.aws.s3";
-	StorageProvider$1["GCP"] = "geekimdas.toolbox.storage.gcp";
-	StorageProvider$1["AZURE"] = "geekimdas.toolbox.storage.azure";
-	return StorageProvider$1;
-}({});
-
-//#endregion
-Object.defineProperty(exports, 'StorageProvider', {
-  enumerable: true,
-  get: function () {
-    return StorageProvider;
-  }
-});
-//# sourceMappingURL=StorageClient-BDRVrMJj.cjs.map

package/dist/StorageClient-BDRVrMJj.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"StorageClient-BDRVrMJj.cjs","names":[],"sources":["../src/StorageClient.ts"],"sourcesContent":["import type { Cache } from '@geekmidas/cache';\nexport interface DocumentVersion {\n\tid: string;\n\tcreatedAt: Date;\n}\n\nexport enum StorageProvider {\n\tAWSS3 = 'geekimdas.toolbox.storage.aws.s3',\n\tGCP = 'geekimdas.toolbox.storage.gcp',\n\tAZURE = 'geekimdas.toolbox.storage.azure',\n}\n\nexport interface StorageClient {\n\treadonly provider: StorageProvider;\n\treadonly cache?: Cache;\n\t/**\n\t * Get a URL to upload a file to.\n\t *\n\t * @param params - The parameters to get the upload URL for.\n\t * @param expiresIn - The number of minutes the URL should be valid for.\n\t * Defaults to 60 * 60 (1 hour).\n\t * @returns A promise that resolves to the upload URL.\n\t */\n\tgetUploadURL(params: GetUploadParams, expiresIn?: number): Promise<string>;\n\n\t/**\n\t * Get a URL to download a file from.\n\t *\n\t * @param file - The file to get the download URL for.\n\t * @param expiresIn - The number of seconds the URL should be valid for.\n\t * Defaults to 60 * 60 (1 hour).\n\t * @returns A promise that resolves to the download URL.\n\t */\n\tgetDownloadURL(file: File, expiresIn?: number): Promise<string>;\n\t/**\n\t * Get the versions for a key.\n\t *\n\t * @param key - The key to get the versions for.\n\t */\n\tgetVersions(key: string): Promise<DocumentVersion[]>;\n\n\t/**\n\t * Get a URL to download a version of a file from.\n\t *\n\t * @param file - The file to get the download URL for.\n\t * @param versionId - The version ID to get the download URL for.\n\t */\n\tgetVersionDownloadURL(file: File, versionId: string): Promise<string>;\n\t/**\n\t *\n\t * @param key - The key to upload the file to.\n\t * @param data - The data to upload.\n\t * @param contentType - The content type of the data.\n\t */\n\tupload(\n\t\tkey: string,\n\t\tdata: string | Buffer,\n\t\tcontentType: string,\n\t): Promise<void>;\n\t/**\n\t * Get a URL to upload a file to.\n\t *\n\t * @param params - The parameters to get the upload URL for.\n\t * @param expiresIn - The number of minutes the URL should be valid for.\n\t */\n\tgetUpload(\n\t\tparams: GetUploadParams,\n\t\texpiresIn?: number,\n\t): Promise<GetUploadResponse>;\n\t/**\n\t * Delete a file from storage.\n\t *\n\t * @param key - The key (path) of the file to delete.\n\t */\n\tdelete(key: string): Promise<void>;\n}\n\nexport interface GetUploadParams {\n\tpath: string;\n\tcontentType: string;\n\tcontentLength: number;\n}\n\nexport type UploadField = {\n\tkey: string;\n\tvalue: string;\n};\n\nexport type GetUploadResponse = {\n\turl: string;\n\tfields: UploadField[];\n};\n\nexport interface File {\n\tname?: string;\n\tpath: string;\n\t/**\n\t * Override the Content-Type of the response.\n\t * Useful when the stored object's content type differs from what the browser should receive.\n\t */\n\tresponseContentType?: string;\n\t/**\n\t * Control how the browser handles the file.\n\t * - `'attachment'` — prompts download (default when `name` is set)\n\t * - `'inline'` — displays in the browser\n\t */\n\tdisposition?: 'inline' | 'attachment';\n}\n"],"mappings":";;AAMA,IAAY,8DAAL;AACN;AACA;AACA;;AACA"}

package/dist/StorageClient-COs9SOsU.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StorageClient-COs9SOsU.d.cts","names":[],"sources":["../src/StorageClient.ts"],"sourcesContent":[],"mappings":";;;UACiB,eAAA;;EAAA,SAAA,EAEL,IAFK;AAKjB;AAMiB,aANL,eAAA;EAMkB,KAAA,GAAA,kCAAA;EAAA,GACV,GAAA,+BAAA;EAAe,KACjB,GAAA,iCAAA;;AAS0C,UAX3C,aAAA,CAW2C;EAAO,SAU7C,QAAA,EApBF,eAoBE;EAAI,SAAuB,KAAA,CAAA,EAnB/B,KAmB+B;EAAO;;;;;;;;EAmC3B,YAAzB,CAAA,MAAA,EA7CkB,eA6ClB,EAAA,SAAA,CAAA,EAAA,MAAA,CAAA,EA7CwD,OA6CxD,CAAA,MAAA,CAAA;EAAO;AAMkB;AAG7B;AAMA;AAKA;AAKA;;;uBA5DsB,2BAA2B;;;;;;4BAMtB,QAAQ;;;;;;;8BAQN,0BAA0B;;;;;;;qCAStC,8BAEb;;;;;;;oBAQM,sCAEN,QAAQ;;;;;;uBAMU;;UAGL,eAAA;;;;;KAML,WAAA;;;;KAKA,iBAAA;;UAEH;;UAGQ,IAAA"}

package/dist/StorageClient-DH4tP-Mf.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StorageClient-DH4tP-Mf.d.mts","names":[],"sources":["../src/StorageClient.ts"],"sourcesContent":[],"mappings":";;;UACiB,eAAA;;EAAA,SAAA,EAEL,IAFK;AAKjB;AAMiB,aANL,eAAA;EAMkB,KAAA,GAAA,kCAAA;EAAA,GACV,GAAA,+BAAA;EAAe,KACjB,GAAA,iCAAA;;AAS0C,UAX3C,aAAA,CAW2C;EAAO,SAU7C,QAAA,EApBF,eAoBE;EAAI,SAAuB,KAAA,CAAA,EAnB/B,KAmB+B;EAAO;;;;;;;;EAmC3B,YAAzB,CAAA,MAAA,EA7CkB,eA6ClB,EAAA,SAAA,CAAA,EAAA,MAAA,CAAA,EA7CwD,OA6CxD,CAAA,MAAA,CAAA;EAAO;AAMkB;AAG7B;AAMA;AAKA;AAKA;;;uBA5DsB,2BAA2B;;;;;;4BAMtB,QAAQ;;;;;;;8BAQN,0BAA0B;;;;;;;qCAStC,8BAEb;;;;;;;oBAQM,sCAEN,QAAQ;;;;;;uBAMU;;UAGL,eAAA;;;;;KAML,WAAA;;;;KAKA,iBAAA;;UAEH;;UAGQ,IAAA"}

package/dist/StorageClient.cjs

@@ -1,3 +0,0 @@
-const require_StorageClient = require('./StorageClient-BDRVrMJj.cjs');
-
-exports.StorageProvider = require_StorageClient.StorageProvider;

package/dist/StorageClient.d.cts

@@ -1,2 +0,0 @@
-import { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient, StorageProvider, UploadField } from "./StorageClient-COs9SOsU.cjs";
-export { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient, StorageProvider, UploadField };

package/dist/StorageClient.d.mts

@@ -1,2 +0,0 @@
-import { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient, StorageProvider, UploadField } from "./StorageClient-DH4tP-Mf.mjs";
-export { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient, StorageProvider, UploadField };

package/dist/StorageClient.mjs

@@ -1,3 +0,0 @@
-import { StorageProvider } from "./StorageClient-4ADnTPnJ.mjs";
-
-export { StorageProvider };

package/src/AmazonStorageClient.ts

@@ -1,207 +0,0 @@
-import {
-	DeleteObjectCommand,
-	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,
-} 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,
-	) {}
-
-	private createGetObjectCommand(
-		file: File,
-		overrides?: { VersionId?: string },
-	): GetObjectCommand {
-		const disposition =
-			file.disposition ?? (file.name ? 'attachment' : undefined);
-		const ResponseContentDisposition = disposition
-			? file.name
-				? `${disposition}; filename=${encodeURIComponent(file.name)}`
-				: disposition
-			: undefined;
-
-		return new GetObjectCommand({
-			Bucket: this.bucket,
-			Key: file.path,
-			ResponseContentDisposition,
-			ResponseContentType: file.responseContentType,
-			...overrides,
-		});
-	}
-
-	getVersionDownloadURL(file: File, versionId: string): Promise<string> {
-		const command = this.createGetObjectCommand(file, { 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 command = this.createGetObjectCommand(file);
-		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);
-	}
-
-	async delete(key: string): Promise<void> {
-		const command = new DeleteObjectCommand({
-			Bucket: this.bucket,
-			Key: key,
-		});
-
-		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',
-}
-
-interface AmazonStorageClientCreateOptions {
-	bucket: string;
-	region?: string;
-	acl?: AmazonCannedAccessControlList;
-	accessKeyId?: string;
-	secretAccessKey?: string;
-	endpoint?: string;
-	forcePathStyle?: boolean;
-	cache?: Cache;
-}

package/src/StorageClient.ts

@@ -1,108 +0,0 @@
-import type { Cache } from '@geekmidas/cache';
-export interface DocumentVersion {
-	id: string;
-	createdAt: Date;
-}
-
-export enum StorageProvider {
-	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;
-	/**
-	 * 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 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>;
-	/**
-	 * Delete a file from storage.
-	 *
-	 * @param key - The key (path) of the file to delete.
-	 */
-	delete(key: string): Promise<void>;
-}
-
-export interface GetUploadParams {
-	path: string;
-	contentType: string;
-	contentLength: number;
-}
-
-export type UploadField = {
-	key: string;
-	value: string;
-};
-
-export type GetUploadResponse = {
-	url: string;
-	fields: UploadField[];
-};
-
-export interface File {
-	name?: string;
-	path: string;
-	/**
-	 * Override the Content-Type of the response.
-	 * Useful when the stored object's content type differs from what the browser should receive.
-	 */
-	responseContentType?: string;
-	/**
-	 * Control how the browser handles the file.
-	 * - `'attachment'` — prompts download (default when `name` is set)
-	 * - `'inline'` — displays in the browser
-	 */
-	disposition?: 'inline' | 'attachment';
-}