@unchainedshop/core-files 4.6.0 → 4.6.2

package/lib/build-hashed-filename.d.ts

@@ -0,0 +1 @@
+export default function buildHashedFilename(directoryName: string, fileName: string, expiryDate: Date): Promise<string>;

package/lib/build-hashed-filename.js

@@ -0,0 +1,12 @@
+import { sha1, slugify } from '@unchainedshop/utils';
+export default async function buildHashedFilename(directoryName, fileName, expiryDate) {
+    const hashed = await sha1(`${directoryName}${fileName}${expiryDate.getTime()}`);
+    const splittedFilename = fileName.split('.');
+    const ext = splittedFilename?.pop();
+    const fileNameWithoutExtension = splittedFilename.join('.') || '';
+    const slugifiedFilenameWithExtension = [slugify(fileNameWithoutExtension), ext]
+        .filter(Boolean)
+        .join('.');
+    const base64url = Buffer.from(hashed).toString('base64url');
+    return `${base64url}.${slugifiedFilenameWithExtension}`;
+}

package/lib/director/FileAdapter.d.ts

@@ -0,0 +1,19 @@
+import type { Readable } from 'node:stream';
+import { type IBaseAdapter } from '@unchainedshop/utils';
+import type { UploadedFile, UploadFileData } from '../file-types.ts';
+export interface IFileAdapter<Context = unknown> extends IBaseAdapter {
+    createDownloadURL: (file: UploadedFile, expiry?: number) => Promise<string | null>;
+    createSignedURL: (directoryName: string, fileName: string, unchainedAPI: Context) => Promise<(UploadFileData & {
+        putURL: string;
+    }) | null>;
+    removeFiles: (files: UploadedFile[], unchainedContext: Context) => Promise<void>;
+    uploadFileFromStream: (directoryName: string, rawFile: any, unchainedAPI: Context, options?: Record<string, any>) => Promise<UploadFileData>;
+    uploadFileFromURL: (directoryName: string, fileInput: {
+        fileLink: string;
+        fileName: string;
+        fileId?: string;
+        headers?: Record<string, unknown>;
+    }, unchainedAPI: Context) => Promise<UploadFileData>;
+    createDownloadStream: (file: UploadedFile, unchainedAPI: Context) => Promise<Readable>;
+}
+export declare const FileAdapter: Omit<IFileAdapter, 'key' | 'label' | 'version'>;

package/lib/director/FileAdapter.js

@@ -0,0 +1,23 @@
+import { BaseAdapter } from '@unchainedshop/utils';
+export const FileAdapter = {
+    ...BaseAdapter,
+    adapterType: Symbol.for('unchained:adapter:file'),
+    async createSignedURL() {
+        throw new Error('Method not implemented');
+    },
+    async removeFiles() {
+        throw new Error('Method not implemented');
+    },
+    async createDownloadURL() {
+        throw new Error('Method not implemented');
+    },
+    async uploadFileFromStream() {
+        throw new Error('Method not implemented');
+    },
+    async createDownloadStream() {
+        throw new Error('Method not implemented');
+    },
+    async uploadFileFromURL() {
+        throw new Error('Method not implemented');
+    },
+};

package/lib/file-types.d.ts

@@ -0,0 +1,18 @@
+export interface UploadFileData {
+    _id: string;
+    directoryName: string;
+    expiryDate: Date | null;
+    fileName: string;
+    size?: number;
+    type: string;
+    url: string;
+}
+export interface UploadedFile {
+    _id: string;
+    path: string;
+    meta?: Record<string, unknown>;
+    name: string;
+    size?: number;
+    type?: string;
+    url?: string;
+}

package/lib/file-types.js

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

package/lib/put-expiration.d.ts

@@ -0,0 +1,3 @@
+export declare const expiryOffsetInMs: () => number;
+declare const resolveExpirationDate: () => Date;
+export default resolveExpirationDate;

package/lib/put-expiration.js

@@ -0,0 +1,4 @@
+const { UNCHAINED_PUT_URL_EXPIRY = '86400000' } = process.env;
+export const expiryOffsetInMs = () => parseInt(UNCHAINED_PUT_URL_EXPIRY, 10) || 24 * 60 * 60 * 1000;
+const resolveExpirationDate = () => new Date(new Date().getTime() + expiryOffsetInMs());
+export default resolveExpirationDate;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unchainedshop/core-files",
   "description": "File management module for the Unchained Engine",
-  "version": "4.6.0",
+  "version": "4.6.2",
   "main": "lib/files-index.js",
   "types": "lib/files-index.d.ts",
   "type": "module",