@geekmidas/storage 0.0.1 → 0.0.2

package/dist/AmazonStorageClient-C16fG3G4.d.cts

@@ -0,0 +1,39 @@
+import { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient, StorageProvider } from "./StorageClient-D-y4QLDq.cjs";
+import { S3Client } from "@aws-sdk/client-s3";
+
+//#region src/AmazonStorageClient.d.ts
+declare class AmazonStorageClient implements StorageClient {
+  private readonly client;
+  private readonly bucket;
+  private readonly acl;
+  readonly provider = StorageProvider.AWSS3;
+  static create(options: AmazonStorageClientCreateOptions): AmazonStorageClient;
+  constructor(client: S3Client, bucket: string, acl?: AmazonCannedAccessControlList);
+  getVersionDownloadURL(file: File, versionId: string): Promise<string>;
+  getVersions(key: string): Promise<DocumentVersion[]>;
+  getDownloadURL(file: File, expiresIn?: number): Promise<string>;
+  getUploadURL(params: GetUploadParams, expiresIn?: number): Promise<string>;
+  getUpload(params: GetUploadParams, expiresIn?: number): Promise<GetUploadResponse>;
+  upload(key: string, data: string | Buffer, contentType: string): Promise<void>;
+}
+declare 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;
+}
+//#endregion
+export { AmazonCannedAccessControlList, AmazonStorageClient };

package/dist/AmazonStorageClient-CP8Tx5oE.d.mts

@@ -0,0 +1,39 @@
+import { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient, StorageProvider } from "./StorageClient-CJbHRTVV.mjs";
+import { S3Client } from "@aws-sdk/client-s3";
+
+//#region src/AmazonStorageClient.d.ts
+declare class AmazonStorageClient implements StorageClient {
+  private readonly client;
+  private readonly bucket;
+  private readonly acl;
+  readonly provider = StorageProvider.AWSS3;
+  static create(options: AmazonStorageClientCreateOptions): AmazonStorageClient;
+  constructor(client: S3Client, bucket: string, acl?: AmazonCannedAccessControlList);
+  getVersionDownloadURL(file: File, versionId: string): Promise<string>;
+  getVersions(key: string): Promise<DocumentVersion[]>;
+  getDownloadURL(file: File, expiresIn?: number): Promise<string>;
+  getUploadURL(params: GetUploadParams, expiresIn?: number): Promise<string>;
+  getUpload(params: GetUploadParams, expiresIn?: number): Promise<GetUploadResponse>;
+  upload(key: string, data: string | Buffer, contentType: string): Promise<void>;
+}
+declare 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;
+}
+//#endregion
+export { AmazonCannedAccessControlList, AmazonStorageClient };

package/dist/AmazonStorageClient.d.cts

@@ -0,0 +1,3 @@
+import "./StorageClient-D-y4QLDq.cjs";
+import { AmazonCannedAccessControlList, AmazonStorageClient } from "./AmazonStorageClient-C16fG3G4.cjs";
+export { AmazonCannedAccessControlList, AmazonStorageClient };

package/dist/AmazonStorageClient.d.mts

@@ -0,0 +1,3 @@
+import "./StorageClient-CJbHRTVV.mjs";
+import { AmazonCannedAccessControlList, AmazonStorageClient } from "./AmazonStorageClient-CP8Tx5oE.mjs";
+export { AmazonCannedAccessControlList, AmazonStorageClient };

package/dist/StorageClient-CJbHRTVV.d.mts

@@ -0,0 +1,77 @@
+//#region src/StorageClient.d.ts
+interface DocumentVersion {
+  id: string;
+  createdAt: Date;
+}
+declare enum StorageProvider {
+  AWSS3 = "geekimdas.toolbox.storage.aws.s3",
+  GCP = "geekimdas.toolbox.storage.gcp",
+  AZURE = "geekimdas.toolbox.storage.azure",
+}
+interface StorageClient {
+  readonly provider: StorageProvider;
+  /**
+   * 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>;
+}
+interface GetUploadParams {
+  path: string;
+  contentType: string;
+  contentLength: number;
+}
+type UploadField = {
+  key: string;
+  value: string;
+};
+type GetUploadResponse = {
+  url: string;
+  fields: UploadField[];
+};
+interface File {
+  name?: string;
+  path: string;
+}
+//#endregion
+export { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient, StorageProvider, UploadField };

package/dist/StorageClient-D-y4QLDq.d.cts

@@ -0,0 +1,77 @@
+//#region src/StorageClient.d.ts
+interface DocumentVersion {
+  id: string;
+  createdAt: Date;
+}
+declare enum StorageProvider {
+  AWSS3 = "geekimdas.toolbox.storage.aws.s3",
+  GCP = "geekimdas.toolbox.storage.gcp",
+  AZURE = "geekimdas.toolbox.storage.azure",
+}
+interface StorageClient {
+  readonly provider: StorageProvider;
+  /**
+   * 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>;
+}
+interface GetUploadParams {
+  path: string;
+  contentType: string;
+  contentLength: number;
+}
+type UploadField = {
+  key: string;
+  value: string;
+};
+type GetUploadResponse = {
+  url: string;
+  fields: UploadField[];
+};
+interface File {
+  name?: string;
+  path: string;
+}
+//#endregion
+export { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient, StorageProvider, UploadField };

package/dist/StorageClient.d.cts

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

package/dist/StorageClient.d.mts

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

package/dist/__tests__/AmazonStorageClient.spec.d.cts

@@ -0,0 +1 @@
+export { };

package/dist/__tests__/AmazonStorageClient.spec.d.mts

@@ -0,0 +1 @@
+export { };

package/dist/__tests__/StorageClient.spec.d.cts

@@ -0,0 +1 @@
+export { };

package/dist/__tests__/StorageClient.spec.d.mts

@@ -0,0 +1 @@
+export { };

package/dist/aws.d.cts

@@ -0,0 +1,3 @@
+import { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient } from "./StorageClient-D-y4QLDq.cjs";
+import { AmazonCannedAccessControlList, AmazonStorageClient } from "./AmazonStorageClient-C16fG3G4.cjs";
+export { AmazonCannedAccessControlList, AmazonStorageClient, DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient };

package/dist/aws.d.mts

@@ -0,0 +1,3 @@
+import { DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient } from "./StorageClient-CJbHRTVV.mjs";
+import { AmazonCannedAccessControlList, AmazonStorageClient } from "./AmazonStorageClient-CP8Tx5oE.mjs";
+export { AmazonCannedAccessControlList, AmazonStorageClient, DocumentVersion, File, GetUploadParams, GetUploadResponse, StorageClient };

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+import { StorageClient } from "./StorageClient-D-y4QLDq.cjs";
+export { StorageClient };

package/dist/index.d.mts

@@ -0,0 +1,2 @@
+import { StorageClient } from "./StorageClient-CJbHRTVV.mjs";
+export { StorageClient };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geekmidas/storage",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -9,14 +9,14 @@
   "type": "module",
   "exports": {
     "./aws": {
+      "types": "./dist/aws.d.ts",
       "import": "./dist/aws.mjs",
-      "require": "./dist/aws.cjs",
-      "types": "./src/aws.ts"
+      "require": "./dist/aws.cjs"
     },
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "types": "./src/index.ts"
+      "require": "./dist/index.cjs"
     }
   },
   "dependencies": {

package/src/__tests__/StorageClient.spec.ts

@@ -69,7 +69,10 @@ describe('StorageClient', () => {
 
       expect(response.url).toBe('https://example.com/upload');
       expect(response.fields).toHaveLength(2);
-      expect(response.fields[0]).toEqual({ key: 'key', value: 'test/path.txt' });
+      expect(response.fields[0]).toEqual({
+        key: 'key',
+        value: 'test/path.txt',
+      });
       expect(response.fields[1]).toEqual({ key: 'acl', value: 'public-read' });
     });
 
@@ -83,4 +86,4 @@ describe('StorageClient', () => {
       expect(field.value).toBe('test-value');
     });
   });
-});
+});

package/src/aws.ts

@@ -1,2 +1,11 @@
-export { AmazonStorageClient, AmazonCannedAccessControlList } from './AmazonStorageClient';
-export type { StorageClient, DocumentVersion, File, GetUploadParams, GetUploadResponse } from './StorageClient';
+export {
+  AmazonStorageClient,
+  AmazonCannedAccessControlList,
+} from './AmazonStorageClient';
+export type {
+  StorageClient,
+  DocumentVersion,
+  File,
+  GetUploadParams,
+  GetUploadResponse,
+} from './StorageClient';