@jrmc/adonis-attachment 2.4.2 → 3.0.0

package/build/index.d.ts

@@ -6,3 +6,4 @@ export { defineConfig } from './src/define_config.js';
 export { Attachmentable } from './src/mixins/attachmentable.js';
 export * as errors from './src/errors.js';
 export { attachmentManager };
+export { type AttachmentVariants } from './src/types/config.js';

package/build/providers/attachment_provider.d.ts

@@ -5,10 +5,10 @@
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
 import type { ApplicationService } from '@adonisjs/core/types';
-import type { AttachmentManager } from '../src/attachment_manager.js';
+import { AttachmentService } from '../src/types/config.js';
 declare module '@adonisjs/core/types' {
     interface ContainerBindings {
-        'jrmc.attachment': AttachmentManager;
+        'jrmc.attachment': AttachmentService;
     }
 }
 export default class AttachmentProvider {

package/build/services/main.d.ts

@@ -4,6 +4,6 @@
  * @license MIT
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
-import { AttachmentManager } from '../src/attachment_manager.js';
-declare let manager: AttachmentManager;
+import { AttachmentService } from '../src/types/config.js';
+declare let manager: AttachmentService;
 export { manager as default };

package/build/src/attachment_manager.d.ts

@@ -7,14 +7,14 @@
 import type { DriveService, SignedURLOptions } from '@adonisjs/drive/types';
 import type { MultipartFile } from '@adonisjs/core/bodyparser';
 import type { AttachmentBase, Attachment as AttachmentType } from './types/attachment.js';
-import type { ResolvedAttachmentConfig } from './types/config.js';
 import { DeferQueue } from '@poppinss/defer';
 import Converter from './converters/converter.js';
-export declare class AttachmentManager {
+import { ResolvedAttachmentConfig } from './define_config.js';
+export declare class AttachmentManager<KnownConverters extends Record<string, Converter>> {
     #private;
     queue: DeferQueue;
-    constructor(config: ResolvedAttachmentConfig, drive: DriveService);
-    getConfig(): ResolvedAttachmentConfig;
+    constructor(config: ResolvedAttachmentConfig<KnownConverters>, drive: DriveService);
+    getConfig(): ResolvedAttachmentConfig<KnownConverters>;
     createFromDbResponse(response: any): AttachmentType | null;
     createFromFile(file: MultipartFile): Promise<AttachmentType>;
     createFromBuffer(buffer: Buffer, name?: string): Promise<AttachmentType>;

package/build/src/attachment_manager.js

@@ -67,11 +67,7 @@ export class AttachmentManager {
     }
     async getConverter(key) {
         if (this.#config.converters) {
-            for (const c of this.#config.converters) {
-                if (c.key === key) {
-                    return c.converter;
-                }
-            }
+            return this.#config.converters[key];
         }
     }
     async computeUrl(attachment, signedUrlOptions) {

package/build/src/define_config.d.ts

@@ -4,6 +4,20 @@
  * @license MIT
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
-import type { AttachmentConfig, ResolvedAttachmentConfig } from './types/config.js';
+import type { AttachmentConfig, BinPaths, ConverterConfig, Queue } from './types/config.js';
 import { ConfigProvider } from '@adonisjs/core/types';
-export declare function defineConfig(config: AttachmentConfig): ConfigProvider<ResolvedAttachmentConfig>;
+import { Converter } from './types/converter.js';
+/**
+ * Config resolved by the "defineConfig" method
+ */
+export type ResolvedAttachmentConfig<KnownConverters extends Record<string, Converter>> = {
+    bin?: BinPaths;
+    meta?: boolean;
+    rename?: boolean;
+    preComputeUrl?: boolean;
+    converters?: {
+        [K in keyof KnownConverters]: KnownConverters[K];
+    };
+    queue?: Queue;
+};
+export declare function defineConfig<KnownConverter extends Record<string, ConverterConfig>>(config: AttachmentConfig<KnownConverter>): ConfigProvider<ResolvedAttachmentConfig<KnownConverter>>;

package/build/src/define_config.js

@@ -8,21 +8,20 @@ import { configProvider } from '@adonisjs/core';
 // export function defineConfig<T extends AttachmentConfig>(config: T): T {
 export function defineConfig(config) {
     return configProvider.create(async (_app) => {
-        let convertersMap = [];
+        const convertersList = Object.keys(config.converters || {});
+        const converters = {};
         if (config.converters) {
-            convertersMap = await Promise.all(config.converters.map(async (c) => {
+            for (let converterName of convertersList) {
+                const converter = config.converters[converterName];
                 const binConfig = config.bin;
-                const { default: value } = await c.converter();
+                const { default: value } = await converter.converter();
                 const Converter = value;
-                return {
-                    key: c.key,
-                    converter: new Converter(c.options, binConfig),
-                };
-            }));
+                converters[converterName] = new Converter(converter.options, binConfig);
+            }
         }
         return {
             ...config,
-            converters: convertersMap,
+            converters,
         };
     });
 }

package/build/src/types/attachment.d.ts

@@ -8,6 +8,7 @@ import type { DriveService } from '@adonisjs/drive/types';
 import type { Exif, Input } from './input.js';
 import type { Disk } from '@adonisjs/drive';
 import type { SignedURLOptions } from '@adonisjs/drive/types';
+import type { AttachmentVariants } from '@jrmc/adonis-attachment';
 export type AttachmentBase = {
     drive: DriveService;
     input?: Input;
@@ -46,7 +47,7 @@ export type LucidOptions = {
     disk?: string;
     folder?: string;
     preComputeUrl?: boolean;
-    variants?: string[];
+    variants?: (keyof AttachmentVariants)[];
     rename?: boolean;
     meta?: boolean;
 };

package/build/src/types/config.d.ts

@@ -4,42 +4,45 @@
  * @license MIT
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
+import { ConfigProvider } from '@adonisjs/core/types';
 import type { Converter, ConverterOptions } from './converter.js';
+import { AttachmentManager } from '../attachment_manager.js';
 type ImportConverter = {
     default: unknown;
 };
-type ConverterConfig = {
-    key: string;
+export interface ConverterConfig {
     converter: () => Promise<ImportConverter>;
     options?: ConverterOptions;
-};
-type Queue = {
+}
+export interface Queue {
     concurrency: number;
-};
+}
 export type BinPaths = {
     ffmpegPath?: string;
     ffprobePath?: string;
     pdftocairoBasePath?: string;
     libreofficePaths?: Array<string>;
 };
-export type AttachmentConfig = {
-    bin?: BinPaths;
-    meta?: boolean;
-    rename?: boolean;
-    preComputeUrl?: boolean;
-    converters?: ConverterConfig[];
-    queue?: Queue;
-};
-export type ResolvedConverter = {
-    key: string;
-    converter: Converter;
-};
-export type ResolvedAttachmentConfig = {
+export type AttachmentConfig<KnownConverter extends Record<string, ConverterConfig>> = {
     bin?: BinPaths;
     meta?: boolean;
     rename?: boolean;
     preComputeUrl?: boolean;
-    converters?: ResolvedConverter[];
+    converters?: {
+        [K in keyof KnownConverter]: KnownConverter[K];
+    };
     queue?: Queue;
 };
+export interface AttachmentVariants {
+}
+export type InferConverters<Config extends ConfigProvider<{
+    bin?: unknown;
+    meta?: unknown;
+    rename?: unknown;
+    preComputeUrl?: unknown;
+    converters?: unknown;
+    queue?: unknown;
+}>> = Exclude<Awaited<ReturnType<Config['resolver']>>['converters'], undefined>;
+export interface AttachmentService extends AttachmentManager<AttachmentVariants extends Record<string, Converter> ? AttachmentVariants : never> {
+}
 export {};

package/build/src/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './attachment.js';
+export * from './config.js';
+export * from './converter.js';
+export * from './input.js';
+export * from './mixin.js';

package/build/src/types/index.js

@@ -0,0 +1,5 @@
+export * from './attachment.js';
+export * from './config.js';
+export * from './converter.js';
+export * from './input.js';
+export * from './mixin.js';

package/build/stubs/config.stub

@@ -2,15 +2,21 @@
   exports({ to: app.configPath('attachment.ts') })
 }}}
 import { defineConfig } from '@jrmc/adonis-attachment'
+import { InferConverters } from '@jrmc/adonis-attachment/types/config'
 
-export default defineConfig({
-  converters: [
-    {
-      key: 'thumbnail',
+const attachmentConfig = defineConfig({
+  converters: {
+    thumbnail: {
       converter: () => import('@jrmc/adonis-attachment/converters/image_converter'),
       options: {
         resize: 300,
       }
     }
-  ]
+  }
 })
+
+export default attachmentConfig
+
+declare module '@jrmc/adonis-attachment' {
+  interface AttachmentVariants extends InferConverters<typeof attachmentConfig> {}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrmc/adonis-attachment",
-  "version": "2.4.2",
+  "version": "3.0.0",
   "type": "module",
   "description": "Turn any field on your Lucid model to an attachment data type",
   "engines": {