@daiso-tech/core 0.48.5 → 0.49.0

package/dist/file-storage/implementations/adapters/no-op-file-storage-adapter/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../../src/file-storage/implementations/adapters/no-op-file-storage-adapter/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,kGAAkG,CAAC"}

package/dist/file-storage/implementations/adapters/no-op-file-storage-adapter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../file-storage/implementations/adapters/no-op-file-storage-adapter/no-op-file-storage-adapter.js";

package/dist/file-storage/implementations/adapters/no-op-file-storage-adapter/_module.js

@@ -0,0 +1,2 @@
+export * from "../../../../file-storage/implementations/adapters/no-op-file-storage-adapter/no-op-file-storage-adapter.js";
+//# sourceMappingURL=_module.js.map

package/dist/file-storage/implementations/adapters/no-op-file-storage-adapter/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../../src/file-storage/implementations/adapters/no-op-file-storage-adapter/_module.ts"],"names":[],"mappings":"AAAA,cAAc,kGAAkG,CAAC"}

package/dist/file-storage/implementations/adapters/no-op-file-storage-adapter/no-op-file-storage-adapter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @module FileStorage
+ */
+import { type ISignedFileStorageAdapter, type FileAdapterMetadata, type FileAdapterStream, type FileWriteEnum, type WritableFileAdapterContent, type WritableFileAdapterStream, type FileAdapterSignedDownloadUrlSettings, type FileAdapterSignedUploadUrlSettings } from "../../../../file-storage/contracts/_module.js";
+/**
+ * The `NoOpFileStorageAdapter` will do nothing and is used for easily mocking {@link ISignedFileStorageAdapter | `ISignedFileStorageAdapter`} for testing.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/no-op-file-storage-adapter"`
+ * @group Adapters
+ */
+export declare class NoOpFileStorageAdapter implements ISignedFileStorageAdapter {
+    getPublicUrl(_key: string): Promise<string | null>;
+    getSignedDownloadUrl(_key: string, _settings: FileAdapterSignedDownloadUrlSettings): Promise<string | null>;
+    getSignedUploadUrl(_key: string, _settings: FileAdapterSignedUploadUrlSettings): Promise<string>;
+    exists(_key: string): Promise<boolean>;
+    getStream(_key: string): Promise<FileAdapterStream | null>;
+    getBytes(_key: string): Promise<Uint8Array | null>;
+    getMetaData(_key: string): Promise<FileAdapterMetadata | null>;
+    add(_key: string, _content: WritableFileAdapterContent): Promise<boolean>;
+    addStream(_key: string, _stream: WritableFileAdapterStream): Promise<boolean>;
+    update(_key: string, _content: WritableFileAdapterContent): Promise<boolean>;
+    updateStream(_key: string, _stream: WritableFileAdapterStream): Promise<boolean>;
+    put(_key: string, _content: WritableFileAdapterContent): Promise<boolean>;
+    putStream(_key: string, _stream: WritableFileAdapterStream): Promise<boolean>;
+    copy(_source: string, _destination: string): Promise<FileWriteEnum>;
+    copyAndReplace(_source: string, _destination: string): Promise<boolean>;
+    move(_source: string, _destination: string): Promise<FileWriteEnum>;
+    moveAndReplace(_source: string, _destination: string): Promise<boolean>;
+    removeMany(_keys: Array<string>): Promise<boolean>;
+    removeByPrefix(_prefix: string): Promise<void>;
+}

package/dist/file-storage/implementations/adapters/no-op-file-storage-adapter/no-op-file-storage-adapter.js

@@ -0,0 +1,70 @@
+/**
+ * @module FileStorage
+ */
+import { FILE_WRITE_ENUM, } from "../../../../file-storage/contracts/_module.js";
+/**
+ * The `NoOpFileStorageAdapter` will do nothing and is used for easily mocking {@link ISignedFileStorageAdapter | `ISignedFileStorageAdapter`} for testing.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/no-op-file-storage-adapter"`
+ * @group Adapters
+ */
+export class NoOpFileStorageAdapter {
+    getPublicUrl(_key) {
+        return Promise.resolve(null);
+    }
+    getSignedDownloadUrl(_key, _settings) {
+        return Promise.resolve(null);
+    }
+    getSignedUploadUrl(_key, _settings) {
+        return Promise.resolve("");
+    }
+    exists(_key) {
+        return Promise.resolve(false);
+    }
+    getStream(_key) {
+        return Promise.resolve(null);
+    }
+    getBytes(_key) {
+        return Promise.resolve(null);
+    }
+    getMetaData(_key) {
+        return Promise.resolve(null);
+    }
+    add(_key, _content) {
+        return Promise.resolve(true);
+    }
+    addStream(_key, _stream) {
+        return Promise.resolve(true);
+    }
+    update(_key, _content) {
+        return Promise.resolve(true);
+    }
+    updateStream(_key, _stream) {
+        return Promise.resolve(true);
+    }
+    put(_key, _content) {
+        return Promise.resolve(true);
+    }
+    putStream(_key, _stream) {
+        return Promise.resolve(true);
+    }
+    copy(_source, _destination) {
+        return Promise.resolve(FILE_WRITE_ENUM.SUCCESS);
+    }
+    copyAndReplace(_source, _destination) {
+        return Promise.resolve(true);
+    }
+    move(_source, _destination) {
+        return Promise.resolve(FILE_WRITE_ENUM.SUCCESS);
+    }
+    moveAndReplace(_source, _destination) {
+        return Promise.resolve(true);
+    }
+    removeMany(_keys) {
+        return Promise.resolve(true);
+    }
+    removeByPrefix(_prefix) {
+        return Promise.resolve();
+    }
+}
+//# sourceMappingURL=no-op-file-storage-adapter.js.map

package/dist/file-storage/implementations/adapters/no-op-file-storage-adapter/no-op-file-storage-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-op-file-storage-adapter.js","sourceRoot":"","sources":["../../../../../src/file-storage/implementations/adapters/no-op-file-storage-adapter/no-op-file-storage-adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,eAAe,GASlB,MAAM,qCAAqC,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,OAAO,sBAAsB;IAC/B,YAAY,CAAC,IAAY;QACrB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,oBAAoB,CAChB,IAAY,EACZ,SAA+C;QAE/C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,kBAAkB,CACd,IAAY,EACZ,SAA6C;QAE7C,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,IAAY;QACf,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,SAAS,CAAC,IAAY;QAClB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,QAAQ,CAAC,IAAY;QACjB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,WAAW,CAAC,IAAY;QACpB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,GAAG,CAAC,IAAY,EAAE,QAAoC;QAClD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,SAAS,CACL,IAAY,EACZ,OAAkC;QAElC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CACF,IAAY,EACZ,QAAoC;QAEpC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,YAAY,CACR,IAAY,EACZ,OAAkC;QAElC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,GAAG,CAAC,IAAY,EAAE,QAAoC;QAClD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,SAAS,CACL,IAAY,EACZ,OAAkC;QAElC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,YAAoB;QACtC,OAAO,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,cAAc,CAAC,OAAe,EAAE,YAAoB;QAChD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,YAAoB;QACtC,OAAO,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,cAAc,CAAC,OAAe,EAAE,YAAoB;QAChD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,UAAU,CAAC,KAAoB;QAC3B,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,cAAc,CAAC,OAAe;QAC1B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CACJ"}

package/dist/file-storage/implementations/adapters/s3-file-storage-adapter/_module-exports.d.ts

@@ -0,0 +1 @@
+export * from "../../../../file-storage/implementations/adapters/s3-file-storage-adapter/s3-file-storage-adapter.js";

package/dist/file-storage/implementations/adapters/s3-file-storage-adapter/_module-exports.js

@@ -0,0 +1,2 @@
+export * from "../../../../file-storage/implementations/adapters/s3-file-storage-adapter/s3-file-storage-adapter.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/file-storage/implementations/adapters/s3-file-storage-adapter/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../../src/file-storage/implementations/adapters/s3-file-storage-adapter/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,4FAA4F,CAAC"}

package/dist/file-storage/implementations/adapters/s3-file-storage-adapter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../file-storage/implementations/adapters/s3-file-storage-adapter/s3-file-storage-adapter.js";

package/dist/file-storage/implementations/adapters/s3-file-storage-adapter/_module.js

@@ -0,0 +1,2 @@
+export * from "../../../../file-storage/implementations/adapters/s3-file-storage-adapter/s3-file-storage-adapter.js";
+//# sourceMappingURL=_module.js.map

package/dist/file-storage/implementations/adapters/s3-file-storage-adapter/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../../src/file-storage/implementations/adapters/s3-file-storage-adapter/_module.ts"],"names":[],"mappings":"AAAA,cAAc,4FAA4F,CAAC"}

package/dist/file-storage/implementations/adapters/s3-file-storage-adapter/s3-file-storage-adapter.d.ts

@@ -0,0 +1,137 @@
+/**
+ * @module FileStorage
+ */
+import { type S3Client, type ServerSideEncryption } from "@aws-sdk/client-s3";
+import { type FileAdapterSignedUploadUrlSettings, type FileAdapterSignedDownloadUrlSettings, type FileAdapterMetadata, type FileAdapterStream, type FileWriteEnum, type ISignedFileStorageAdapter, type WritableFileAdapterContent, type WritableFileAdapterStream } from "../../../../file-storage/contracts/_module.js";
+import { type IDeinitizable, type IInitizable, type Invokable } from "../../../../utilities/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/aws-file-storage-adapter"`
+ * @group Adapters
+ */
+export type S3FilePublicUrlGenerator = Invokable<[
+    settings: {
+        key: string;
+        bucket: string;
+        client: S3Client;
+    }
+], Promise<string>>;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/aws-file-storage-adapter"`
+ * @group Adapters
+ */
+export type S3FileStorageAdapterSettings = {
+    client: S3Client;
+    /**
+     * The bucket option defines the S3 bucket to use for managing files.
+     */
+    bucket: string;
+    /**
+     * The `cdnUrl` field can be used to define the base URL for generating public URL for a file. For example, If you use CloudFront alongside S3 to serve public files, the `cdnUrl` property should be the CloudFront URL.
+     * @default null
+     */
+    cdnUrl?: string | null;
+    /**
+     * Define ServerSideEncryption option for all objects uploaded to S3. It can be disabled by passing null
+     *
+     * @default null
+     */
+    serverSideEncryption?: ServerSideEncryption | null;
+    /**
+     * If false the `put` method of {@link ISignedFileStorageAdapter | `ISignedFileStorageAdapter`} will perform one database call and thereby always return true even when the file doesnt exists.
+     * Note the fewer database calls the cheaper it will be when using aws s3.
+     * @default true
+     */
+    enableAccuratePut?: boolean;
+    /**
+     * If false the `getSignedDownloadUrl` method of {@link ISignedFileStorageAdapter | `ISignedFileStorageAdapter`} will perfom one database call and therby always return string even when the file doesnt exists.
+     * Note the fewer database calls the cheaper it will be when using aws s3.
+     * @default true
+     */
+    enableAccurateGetSignedDownloadUrl?: boolean;
+    /**
+     * If false the `getPublicUrl` method of {@link ISignedFileStorageAdapter | `ISignedFileStorageAdapter`} will perfom one database call and therby always return string even when the file doesnt exists.
+     * Note the fewer database calls the cheaper it will be when using aws s3.
+     * @default true
+     */
+    enableAccurateGetPublicUrl?: boolean;
+    /**
+     * @default true
+     */
+    enableAccurateRemoveMany?: boolean;
+    /**
+     * Define a custom public url generator for creating public and signed URLs.
+     *
+     * @default
+     * ```ts
+     * import { defaultPublicUrlGenerator } from "@daiso-tech/core/file-storage/s3-file-storage-adapter"
+     * defaultPublicUrlGenerator
+     * ```
+     */
+    publicUrlGenerator?: S3FilePublicUrlGenerator;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/aws-file-storage-adapter"`
+ * @group Adapters
+ */
+export declare const defaultPublicUrlGenerator: S3FilePublicUrlGenerator;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/aws-file-storage-adapter"`
+ * @group Adapters
+ */
+export declare class S3FileStorageAdapter implements ISignedFileStorageAdapter, IDeinitizable, IInitizable {
+    private readonly client;
+    private readonly bucket;
+    private readonly cdnUrl;
+    private readonly serverSideEncryption;
+    private readonly enableAccuratePut;
+    private readonly enableAccurateGetSignedDownloadUrl;
+    private readonly enableAccurateGetPublicUrl;
+    private readonly enableAccurateRemoveMany;
+    private readonly publicUrlGenerator;
+    /**
+     * @example
+     * ```ts
+     * import { S3Client } from "@aws-sdk/client-s3"
+     * import { S3FileStorageAdapter } from "@daiso-tech/core/file-storage/s3-file-storage-adapter";
+     *
+     * const s3FileStorageAdapter = new S3FileStorageAdapter({
+     *   client: new S3Client({
+     *     credentials: {
+     *       accessKeyId: 'AWS_ACCESS_KEY_ID',
+     *       secretAccessKey: 'AWS_SECRET_ACCESS_KEY',
+     *     },
+     *     region: "AWS_REGION",
+     *   }),
+     *   bucket: "files"
+     * });
+     * ```
+     */
+    constructor(settings: S3FileStorageAdapterSettings);
+    /**
+     * Creates the bucket where the files will be saved.
+     */
+    init(): Promise<void>;
+    /**
+     * Removes the bucket where the files are saved.
+     */
+    deInit(): Promise<void>;
+    getPublicUrl(key: string): Promise<string | null>;
+    getSignedDownloadUrl(key: string, settings: FileAdapterSignedDownloadUrlSettings): Promise<string | null>;
+    getSignedUploadUrl(key: string, settings: FileAdapterSignedUploadUrlSettings): Promise<string>;
+    exists(key: string): Promise<boolean>;
+    getStream(key: string): Promise<FileAdapterStream | null>;
+    getBytes(key: string): Promise<Uint8Array | null>;
+    getMetaData(key: string): Promise<FileAdapterMetadata | null>;
+    add(key: string, content: WritableFileAdapterContent): Promise<boolean>;
+    addStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
+    update(key: string, content: WritableFileAdapterContent): Promise<boolean>;
+    updateStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
+    put(key: string, content: WritableFileAdapterContent): Promise<boolean>;
+    putStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
+    copy(source: string, destination: string): Promise<FileWriteEnum>;
+    copyAndReplace(source: string, destination: string): Promise<boolean>;
+    move(source: string, destination: string): Promise<FileWriteEnum>;
+    moveAndReplace(source: string, destination: string): Promise<boolean>;
+    removeMany(keys: Array<string>): Promise<boolean>;
+    removeByPrefix(prefix: string): Promise<void>;
+}