@jrmc/adonis-attachment 5.2.0 → 6.0.0-alpha.0

package/build/src/utils/helpers.js

@@ -1,131 +0,0 @@
-/**
- * @jrmc/adonis-attachment
- *
- * @license MIT
- * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
- */
-import crypto from 'node:crypto';
-import os from 'node:os';
-import path from 'node:path';
-import https from 'node:https';
-import fs from 'node:fs/promises';
-import { pipeline } from 'node:stream';
-import { promisify } from 'node:util';
-import { createWriteStream } from 'node:fs';
-import BlurhashAdapter from '../adapters/blurhash.js';
-import * as errors from '../errors.js';
-const streamPipeline = promisify(pipeline);
-export function cleanObject(obj) {
-    if (obj === null || typeof obj !== 'object') {
-        return obj;
-    }
-    const cleanedObj = Array.isArray(obj) ? [] : {};
-    for (const key in obj) {
-        if (obj.hasOwnProperty(key)) {
-            const cleanedValue = cleanObject(obj[key]);
-            if (cleanedValue !== null &&
-                cleanedValue !== undefined &&
-                cleanedValue !== 0 &&
-                cleanedValue !== '') {
-                cleanedObj[key] = cleanedValue;
-            }
-        }
-    }
-    return cleanedObj;
-}
-export async function use(module) {
-    try {
-        const result = await import(module);
-        if (result.default) {
-            return result.default;
-        }
-        return result;
-    }
-    catch (err) {
-        throw new errors.E_MISSING_PACKAGE([module], { cause: err });
-    }
-}
-export async function bufferToTempFile(input) {
-    const folder = os.tmpdir();
-    const tempFilePath = path.join(folder, `tempfile-${Date.now()}.tmp`);
-    await fs.writeFile(tempFilePath, input);
-    return tempFilePath;
-}
-export async function streamToTempFile(input) {
-    const folder = os.tmpdir();
-    const tempFilePath = path.join(folder, `tempfile-${Date.now()}.tmp`);
-    const writeStream = createWriteStream(tempFilePath);
-    try {
-        await streamPipeline(input, writeStream);
-        return tempFilePath;
-    }
-    catch (err) {
-        throw new errors.E_CANNOT_GENERATE_TEMP_FILE([err.message]);
-    }
-}
-export async function downloadToTempFile(input) {
-    return await new Promise((resolve) => {
-        https
-            .get(input, (response) => {
-            if (response.statusCode === 200) {
-                resolve(streamToTempFile(response));
-            }
-            else {
-                // reject(`${response.statusCode}`)
-                throw new errors.E_CANNOT_GENERATE_TEMP_FILE(['']);
-            }
-        })
-            .on('error', (err) => {
-            throw new errors.E_CANNOT_GENERATE_TEMP_FILE([err.message]);
-        });
-    });
-}
-export function isBase64(str) {
-    const base64Regex = /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/;
-    if (!base64Regex.test(str)) {
-        return false;
-    }
-    try {
-        Buffer.from(str, 'base64').toString();
-        return true;
-    }
-    catch (err) {
-        return false;
-    }
-}
-export function imageToBlurhash(input, options) {
-    const { componentX, componentY } = options || { componentX: 4, componentY: 4 };
-    return new Promise(async (resolve, reject) => {
-        try {
-            const sharp = await use('sharp');
-            // Convert input to pixels
-            const { data: pixels, info: metadata } = await sharp(input)
-                .raw()
-                .ensureAlpha()
-                .toBuffer({ resolveWithObject: true });
-            const blurhash = BlurhashAdapter.encode(new Uint8ClampedArray(pixels), metadata.width, metadata.height, componentX, componentY);
-            return resolve(blurhash);
-        }
-        catch (error) {
-            return reject(error);
-        }
-    });
-}
-export function extractPathParameters(path) {
-    const paramRegex = /:(\w+)/g;
-    const parameters = [];
-    let match;
-    while ((match = paramRegex.exec(path)) !== null) {
-        parameters.push(match[1]);
-    }
-    return parameters;
-}
-export function secondsToTimeFormat(seconds) {
-    const hours = Math.floor(seconds / 3600);
-    const minutes = Math.floor((seconds % 3600) / 60);
-    const remainingSeconds = Math.floor(seconds % 60);
-    return `${hours.toString().padStart(2, '0')}:${minutes.toString().padStart(2, '0')}:${remainingSeconds.toString().padStart(2, '0')}`;
-}
-export function uuid() {
-    return crypto.randomUUID();
-}

package/build/src/utils/hooks.d.ts

@@ -1,12 +0,0 @@
-/**
- * @jrmc/adonis-attachment
- *
- * @license MIT
- * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
- */
-export declare const afterFindHook: (instance: unknown) => Promise<void>;
-export declare const afterFetchHook: (instance: unknown) => Promise<void>;
-export declare const beforeSaveHook: (instance: unknown) => Promise<void>;
-export declare const afterSaveHook: (instance: unknown) => Promise<void>;
-export declare const beforeDeleteHook: (instance: unknown) => Promise<void>;
-//# sourceMappingURL=hooks.d.ts.map

package/build/src/utils/hooks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../src/utils/hooks.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,eAAO,MAAM,aAAa,GAAU,UAAU,OAAO,kBAKpD,CAAA;AAID,eAAO,MAAM,cAAc,GAAU,UAAU,OAAO,kBAGrD,CAAA;AAGD,eAAO,MAAM,cAAc,GAAU,UAAU,OAAO,kBAMrD,CAAA;AAGD,eAAO,MAAM,aAAa,GAAU,UAAU,OAAO,kBAKpD,CAAA;AAGD,eAAO,MAAM,gBAAgB,GAAU,UAAU,OAAO,kBAKvD,CAAA"}

package/build/src/utils/hooks.js

@@ -1,42 +0,0 @@
-/**
- * @jrmc/adonis-attachment
- *
- * @license MIT
- * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
- */
-import AttachmentRecordService from '../services/attachment_service.js';
-// @afterFind()
-export const afterFindHook = async (instance) => {
-    const modelInstance = instance;
-    const model = new AttachmentRecordService(modelInstance);
-    await model.setKeyId();
-    await model.preComputeUrl();
-};
-// @afterFetch()
-// @afterPaginate()
-export const afterFetchHook = async (instance) => {
-    const modelInstances = instance;
-    await Promise.all(modelInstances.map((row) => afterFindHook(row)));
-};
-// @beforeSave()
-export const beforeSaveHook = async (instance) => {
-    const modelInstance = instance;
-    const model = new AttachmentRecordService(modelInstance);
-    await model.detach();
-    await model.persist();
-    await model.transaction();
-};
-// @afterSave()
-export const afterSaveHook = async (instance) => {
-    const modelInstance = instance;
-    const model = new AttachmentRecordService(modelInstance);
-    await model.generateVariants();
-    await model.setKeyId();
-};
-// @beforeDelete()
-export const beforeDeleteHook = async (instance) => {
-    const modelInstance = instance;
-    const model = new AttachmentRecordService(modelInstance);
-    await model.detachAll();
-    await model.transaction({ enabledRollback: false });
-};

package/build/src/utils/symbols.d.ts

@@ -1,8 +0,0 @@
-/**
- * @jrmc/adonis-attachment
- *
- * @license MIT
- * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
- */
-export declare const optionsSym: unique symbol;
-//# sourceMappingURL=symbols.d.ts.map

package/build/src/utils/symbols.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"symbols.d.ts","sourceRoot":"","sources":["../../../src/utils/symbols.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,UAAU,eAA+B,CAAA"}

package/build/src/utils/symbols.js

@@ -1,7 +0,0 @@
-/**
- * @jrmc/adonis-attachment
- *
- * @license MIT
- * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
- */
-export const optionsSym = Symbol('optionsAttachments');

package/build/stubs/config.stub

@@ -1,140 +0,0 @@
-{{{
-  exports({ to: app.configPath('attachment.ts') })
-}}}
-import type { InferConverters } from '@jrmc/adonis-attachment/types/config'
-import { defineConfig } from '@jrmc/adonis-attachment'
-// import sharp from 'sharp'
-
-/**
- * Documentation: https://adonis-attachment.jrmc.dev/guide/essentials/configuration
- */
-
-const attachmentConfig = defineConfig({
-  /**
-   * Enable the preComputeUrl flag to pre compute the URLs after SELECT queries. (default: false)
-   */
-  // preComputeUrl: true,
-
-  /**
-   * Enable the meta informations after upload. (default: false)
-   */
-  // meta: true,
-
-  /**
-   * Enable file rename after upload. (default: true)
-   */
-  // rename: false,
-
-  /**
-   * Specify binary path
-   */
-  // bin: { // [!code focus:8]
-  //   ffmpegPath: 'ffmpeg_path', // the full path of the binary
-  //   ffprobePath: 'ffprobe_path', // the full path of the binary
-  //   pdftoppmPath: 'pdftoppm_path' // the full path of the binary
-  //   pdfinfoPath: 'pdfinfo_path' // the full path of the binary
-  //   sofficePath: 'soffice_path', // the full path of the binary (libreoffice/openoffice)
-  // },
-
-  /**
-   * Queue configuration for file processing.
-   * By default, 1 task is processed concurrently. A task corresponds to a model attribute.
-   * For example, if a model has a logo attribute and an avatar attribute,
-   * this represents 2 tasks, regardless of the number of concerts per attribute.
-   *
-   * Increasing concurrency can improve performance but consumes more resources.
-   * A value too high may lead to memory or CPU issues.
-   *
-   */
-  // queue: {
-  //   concurrency: 2
-  // },
-
-  /**
-   * Maximum duration (in milliseconds) that an operation can take before being interrupted.
-   * Default: 30_000 (30 seconds)
-   *
-   * This timeout applies to each individual operation conversion.
-   * If an operation exceeds this time limit, it will be interrupted and an error will be thrown.
-   *
-   * Increase this value if you're processing large files or if your operations
-   * require more time (e.g., long video conversion).
-   *
-   */
-  // timeout: 40_000,
-
-  /**
-   * Configure how variants are stored relative to the original file.
-   *
-   * - 'basePath': Define a custom base path where all variants will be stored.
-   *   By default, variants are stored in the same folder as the original file.
-   *
-   * - 'ignoreFolder': When set to 'true', the variant will not include the parent
-   *   folder from the original attachment.
-   */
-  // variant: {
-  //  basePath: 'variants',
-  //  ignoreFolder: true,
-  // },
-
-  /**
-   *
-   */
-  converters: {
-    thumbnail: {
-      /**
-       * optional converter
-       * default : @jrmc/adonis-attachment/converters/autodetect_converter
-       * image : @jrmc/adonis-attachment/converters/image_converter
-       * pdf : @jrmc/adonis-attachment/converters/pdf_thumbnail_converter
-       * document : @jrmc/adonis-attachment/converters/document_thumbnail_converter
-       * video : @jrmc/adonis-attachment/converters/video_thumbnail_converter
-       * create your custom converter : https://adonis-attachment.jrmc.dev/guide/advanced_usage/custom-converter
-       */
-      // converter: () => import('@jrmc/adonis-attachment/converters/autodetect_converter'),
-
-      /**
-       *
-       * https://sharp.pixelplumbing.com/api-resize/
-       */
-      resize: 300,
-
-      // resize: { // https://sharp.pixelplumbing.com/api-resize
-      //   width: 400,
-      //   height: 400,
-      //   fit: sharp.fit.cover,
-      //   position: 'top'
-      // },
-
-      /**
-       *
-       * https://sharp.pixelplumbing.com/api-output/#toformat
-       */
-      // format: 'jpeg',
-      // format: {
-      //   format: 'jpeg',
-      //   options: {
-      //     quality: 80
-      //   }
-      // }
-
-      /**
-       *
-       * https://sharp.pixelplumbing.com/api-operation/#autoorient
-       */
-      // autoOrient: false,
-
-      /**
-       * generation of blurhashes (default: true)
-       * https://blurha.sh/
-       */
-      // blurhash: true,
-    },
-  },
-})
-
-export default attachmentConfig
-
-declare module '@jrmc/adonis-attachment' {
-  interface AttachmentVariants extends InferConverters<typeof attachmentConfig> {}
-}

package/build/stubs/make/converter/main.stub

@@ -1,20 +0,0 @@
-{{#var entity = generators.createEntity(name)}}
-{{#var modelConverterName = string(entity.name).removeSuffix('converter').pascalCase().suffix(string.pascalCase('converter')).toString()}}
-{{#var modelConverterFileName = string(entity.name).snakeCase().suffix('_converter').ext('.ts').toString()}}
-{{{
-  exports({ to: app.makePath('app/converters', entity.path, modelConverterFileName) })
-}}}
-
-import type { ConverterAttributes } from '@jrmc/adonis-attachment/types/converter'
-import type { Input } from '@jrmc/adonis-attachment/types/input'
-
-import logger from '@adonisjs/core/services/logger'
-import Converter from '@jrmc/adonis-attachment/converters/converter'
-
-export default class {{ modelConverterName }} extends Converter {
-  async handle({ input }: ConverterAttributes): Promise<Input> {
-    logger.info('Input path %s', input)
-
-    return input
-  }
-}