@acorex/core 20.9.0 → 20.9.2

package/fesm2022/acorex-core-file.mjs

@@ -1,5 +1,6 @@
 import * as i0 from '@angular/core';
-import { Injectable, runInInjectionContext, InjectionToken, inject, NgModule, DOCUMENT, isDevMode } from '@angular/core';
+import { Injectable, runInInjectionContext, InjectionToken, inject, input, signal, effect, ChangeDetectionStrategy, Component, NgModule, DOCUMENT, isDevMode } from '@angular/core';
+import { NgComponentOutlet } from '@angular/common';
 import * as i2 from '@acorex/core/validation';
 import { AXValidationService, AXValidationRegistryService, AXValidationModule } from '@acorex/core/validation';
 import * as i1 from '@acorex/core/format';
@@ -141,6 +142,18 @@ function getFileExtension(fileName) {
     return parts.length > 1 ? (parts.pop()?.toLowerCase() ?? '') : '';
 }
 
+/** Resolves a {@link AXFileTypeComponent} to an Angular component type. */
+async function resolveFileTypeComponentType(component) {
+    if (isLazyFileTypeComponentLoader(component)) {
+        return component();
+    }
+    return component;
+}
+/** Whether `value` is a lazy loader rather than an Angular component class. */
+function isLazyFileTypeComponentLoader(value) {
+    return typeof value === 'function' && !('ɵcmp' in value);
+}
+
 /** Matches a MIME type against a catalog pattern (`image/*`, exact type, …). */
 function matchesFileMime(mime, pattern) {
     const normalizedMime = mime.trim().toLowerCase();
@@ -208,6 +221,17 @@ function resolveFileTypeCopy(type, extension) {
 function resolveFileTypeOpen(type, extension) {
     return extension?.open ?? type.open;
 }
+function resolveFileTypeComponent(type, extension) {
+    return extension?.component ?? type.component;
+}
+/** Loads the resolved view component (extension override first). */
+async function loadFileTypeComponent(type, extension) {
+    const component = resolveFileTypeComponent(type, extension);
+    if (!component) {
+        return undefined;
+    }
+    return resolveFileTypeComponentType(component);
+}
 function resolveFileTypePaste(type, extension) {
     return extension?.paste ?? type.paste;
 }
@@ -249,6 +273,38 @@ function runFileTypeOpen(type, ctx, payload, extension) {
     return runInInjectionContext(ctx.injector, () => open(ctx, payload));
 }
 
+/**
+
+ * Builds an {@link AXFileType} with optional typed handlers and view component.
+
+ *
+
+ * @example
+
+ * ```ts
+
+ * export const imageFileType = defineFileType<ImagePayload>({
+
+ *   name: 'image',
+
+ *   copy: (p) => p.caption ?? p.url,
+
+ *   component: () => import('./image-viewer.component').then(m => m.ImageViewerComponent),
+
+ * });
+
+ * ```
+
+ */
+function defineFileType(config) {
+    const { copy, open, ...rest } = config;
+    return {
+        ...rest,
+        ...(copy ? { copy: copy } : {}),
+        ...(open ? { open: open } : {}),
+    };
+}
+
 /** Contributes {@link AXFileType} entries (multi provider). */
 class AXFileTypeInfoProvider {
 }
@@ -261,6 +317,22 @@ function provideFileTypeInfoProvider(provider) {
     };
 }
 
+/** Registers static file types via the existing {@link AXFileTypeInfoProvider} multi-token. */
+function provideFileTypes(types) {
+    class AXStaticFileTypeProvider extends AXFileTypeInfoProvider {
+        items() {
+            const value = typeof types === 'function' ? types() : types;
+            return Promise.resolve(value);
+        }
+        static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.3", ngImport: i0, type: AXStaticFileTypeProvider, deps: null, target: i0.ɵɵFactoryTarget.Injectable }); }
+        static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.3", ngImport: i0, type: AXStaticFileTypeProvider }); }
+    }
+    i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.3", ngImport: i0, type: AXStaticFileTypeProvider, decorators: [{
+                type: Injectable
+            }] });
+    return provideFileTypeInfoProvider(AXStaticFileTypeProvider);
+}
+
 /** Maps {@link AXFileValidations} to executable validation entries. */
 function fileValidationsToRules(validations) {
     const rules = [];
@@ -369,6 +441,24 @@ class AXFileTypeRegistryService {
         const types = await this.resolveTypes();
         return types.find((t) => t.name === name);
     }
+    /** Resolved view component ref for a catalog entry (optional extension hint). */
+    async getComponent(name, hint) {
+        const type = await this.get(name);
+        if (!type) {
+            return undefined;
+        }
+        const extension = hint ? resolveFileTypeExtension(type, hint) : undefined;
+        return resolveFileTypeComponent(type, extension);
+    }
+    /** Loads the view component for a catalog entry. */
+    async loadComponent(name, hint) {
+        const type = await this.get(name);
+        if (!type) {
+            return undefined;
+        }
+        const extension = hint ? resolveFileTypeExtension(type, hint) : undefined;
+        return loadFileTypeComponent(type, extension);
+    }
     async accept(typeNames) {
         const names = typeNames ? (Array.isArray(typeNames) ? typeNames : [typeNames]) : undefined;
         const types = await this.resolveTypes();
@@ -449,6 +539,54 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.3", ngImpor
             args: [{ providedIn: 'root' }]
         }] });
 
+class AXFileTypeRendererOutletComponent {
+    constructor() {
+        this.registry = inject(AXFileTypeRegistryService);
+        /** Catalog name (e.g. `image`, `conversation-image`). */
+        this.fileType = input.required(...(ngDevMode ? [{ debugName: "fileType" }] : []));
+        /** Payload passed to the file-type view component. */
+        this.payload = input.required(...(ngDevMode ? [{ debugName: "payload" }] : []));
+        /** Optional extension / MIME hint for extension-level renderer overrides. */
+        this.extensionHint = input(...(ngDevMode ? [undefined, { debugName: "extensionHint" }] : []));
+        /** Extra inputs merged with `payload` (e.g. `message` in conversation). */
+        this.inputs = input({}, ...(ngDevMode ? [{ debugName: "inputs" }] : []));
+        this.resolvedComponent = signal(null, ...(ngDevMode ? [{ debugName: "resolvedComponent" }] : []));
+        this.loading = signal(false, ...(ngDevMode ? [{ debugName: "loading" }] : []));
+        this.mergedInputs = signal({}, ...(ngDevMode ? [{ debugName: "mergedInputs" }] : []));
+        effect(() => {
+            const name = this.fileType();
+            const payload = this.payload();
+            const hint = this.extensionHint();
+            const extra = this.inputs();
+            this.mergedInputs.set({ payload, ...extra });
+            this.loading.set(true);
+            this.resolvedComponent.set(null);
+            void this.registry.loadComponent(name, hint).then((component) => {
+                this.resolvedComponent.set(component ?? null);
+                this.loading.set(false);
+            });
+        });
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.3", ngImport: i0, type: AXFileTypeRendererOutletComponent, deps: [], target: i0.ɵɵFactoryTarget.Component }); }
+    static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "20.3.3", type: AXFileTypeRendererOutletComponent, isStandalone: true, selector: "ax-file-type-renderer", inputs: { fileType: { classPropertyName: "fileType", publicName: "fileType", isSignal: true, isRequired: true, transformFunction: null }, payload: { classPropertyName: "payload", publicName: "payload", isSignal: true, isRequired: true, transformFunction: null }, extensionHint: { classPropertyName: "extensionHint", publicName: "extensionHint", isSignal: true, isRequired: false, transformFunction: null }, inputs: { classPropertyName: "inputs", publicName: "inputs", isSignal: true, isRequired: false, transformFunction: null } }, ngImport: i0, template: `
+    @if (resolvedComponent(); as component) {
+      <ng-container *ngComponentOutlet="component; inputs: mergedInputs()" />
+    } @else if (loading()) {
+      <span class="ax-file-type-renderer__loading" aria-hidden="true"></span>
+    }
+  `, isInline: true, styles: [":host{display:contents}.ax-file-type-renderer__loading{display:inline-block;min-height:1rem;min-width:1rem}\n"], dependencies: [{ kind: "directive", type: NgComponentOutlet, selector: "[ngComponentOutlet]", inputs: ["ngComponentOutlet", "ngComponentOutletInputs", "ngComponentOutletInjector", "ngComponentOutletEnvironmentInjector", "ngComponentOutletContent", "ngComponentOutletNgModule", "ngComponentOutletNgModuleFactory"], exportAs: ["ngComponentOutlet"] }], changeDetection: i0.ChangeDetectionStrategy.OnPush }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.3", ngImport: i0, type: AXFileTypeRendererOutletComponent, decorators: [{
+            type: Component,
+            args: [{ selector: 'ax-file-type-renderer', changeDetection: ChangeDetectionStrategy.OnPush, imports: [NgComponentOutlet], template: `
+    @if (resolvedComponent(); as component) {
+      <ng-container *ngComponentOutlet="component; inputs: mergedInputs()" />
+    } @else if (loading()) {
+      <span class="ax-file-type-renderer__loading" aria-hidden="true"></span>
+    }
+  `, styles: [":host{display:contents}.ax-file-type-renderer__loading{display:inline-block;min-height:1rem;min-width:1rem}\n"] }]
+        }], ctorParameters: () => [] });
+
 const MB$4 = 1024 * 1024;
 const AX_AUDIO_FILE_TYPE = {
     name: 'audio',
@@ -864,5 +1002,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.3", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { AXAudioFileTypeProvider, AXDocumentFileTypeProvider, AXFileFileTypeProvider, AXFileMaxSizeValidationRule, AXFileMimeTypeValidationRule, AXFileMinSizeValidationRule, AXFileModule, AXFileService, AXFileSizeFormatter, AXFileTypeInfoProvider, AXFileTypeRegistryService, AXImageFileTypeProvider, AXVideoFileTypeProvider, AX_AUDIO_FILE_TYPE, AX_BUILTIN_FILE_TYPE_PROVIDERS, AX_DOCUMENT_FILE_TYPE, AX_FILE_FILE_TYPE, AX_FILE_TYPE_INFO_PROVIDER, AX_FILE_TYPE_METADATA_PURPOSE, AX_FILE_VALIDATION_RULES, AX_IMAGE_FILE_TYPE, AX_VIDEO_FILE_TYPE, createFileTypeMetadata, fileTypeMatchesPurpose, fileValidationsToRules, filterFileTypesByPurpose, findFileTypeExtension, findFileTypeExtensionByName, findFileTypeExtensionForMime, formatFileSizeBytes, getFileExtension, getFileTypePurposes, isEmptyFileValidations, isExtensionsOnlyType, matchesFileMime, mergeFileValidations, provideBuiltinFileTypeProviders, provideDefaultFileTypeProviders, provideFileTypeInfoProvider, provideFileTypeSystem, provideFileValidationRules, resolveFileCopyText, resolveFileTypeCopy, resolveFileTypeExtension, resolveFileTypeOpen, resolveFileTypePaste, resolveFileTypeUtility, resolveFileValidations, runFileTypeCopy, runFileTypeOpen, runFileTypeUtility, runFileTypeUtilityForFile, validateFileAgainstType, validateFileWithValidations };
+export { AXAudioFileTypeProvider, AXDocumentFileTypeProvider, AXFileFileTypeProvider, AXFileMaxSizeValidationRule, AXFileMimeTypeValidationRule, AXFileMinSizeValidationRule, AXFileModule, AXFileService, AXFileSizeFormatter, AXFileTypeInfoProvider, AXFileTypeRegistryService, AXFileTypeRendererOutletComponent, AXImageFileTypeProvider, AXVideoFileTypeProvider, AX_AUDIO_FILE_TYPE, AX_BUILTIN_FILE_TYPE_PROVIDERS, AX_DOCUMENT_FILE_TYPE, AX_FILE_FILE_TYPE, AX_FILE_TYPE_INFO_PROVIDER, AX_FILE_TYPE_METADATA_PURPOSE, AX_FILE_VALIDATION_RULES, AX_IMAGE_FILE_TYPE, AX_VIDEO_FILE_TYPE, createFileTypeMetadata, defineFileType, fileTypeMatchesPurpose, fileValidationsToRules, filterFileTypesByPurpose, findFileTypeExtension, findFileTypeExtensionByName, findFileTypeExtensionForMime, formatFileSizeBytes, getFileExtension, getFileTypePurposes, isEmptyFileValidations, isExtensionsOnlyType, isLazyFileTypeComponentLoader, loadFileTypeComponent, matchesFileMime, mergeFileValidations, provideBuiltinFileTypeProviders, provideDefaultFileTypeProviders, provideFileTypeInfoProvider, provideFileTypeSystem, provideFileTypes, provideFileValidationRules, resolveFileCopyText, resolveFileTypeComponent, resolveFileTypeComponentType, resolveFileTypeCopy, resolveFileTypeExtension, resolveFileTypeOpen, resolveFileTypePaste, resolveFileTypeUtility, resolveFileValidations, runFileTypeCopy, runFileTypeOpen, runFileTypeUtility, runFileTypeUtilityForFile, validateFileAgainstType, validateFileWithValidations };
 //# sourceMappingURL=acorex-core-file.mjs.map