@acorex/core 20.9.0 → 20.9.1

package/file/index.d.ts

@@ -1,7 +1,7 @@
 import * as i1 from '@acorex/core/format';
 import { AXFormatOptions, AXFormatter } from '@acorex/core/format';
 import * as i0 from '@angular/core';
-import { Injector, InjectionToken, Type, Provider, ModuleWithProviders } from '@angular/core';
+import { Injector, Type, InputSignal, Signal, Provider, InjectionToken, ModuleWithProviders } from '@angular/core';
 import * as i2 from '@acorex/core/validation';
 import { AXValidationRuleOptions, AXValidationRuleResult, AXValidationService, AXValidationRule } from '@acorex/core/validation';
 
@@ -61,6 +61,31 @@ type AXFileOpenResult = void | boolean | null | undefined;
 /** Runs `open` from extension first, then parent type, in the caller's injection context. */
 declare function runFileTypeOpen(type: AXFileType, ctx: AXFileTypeOpenContext, payload: unknown, extension?: AXFileTypeExtension): Promise<AXFileOpenResult> | AXFileOpenResult;
 
+/**
+ * View component for a file type — either an Angular component class or a lazy loader.
+ *
+ * @example
+ * ```ts
+ * // eager
+ * component: ImageViewerComponent,
+ *
+ * // lazy
+ * component: () => import('./image-viewer.component').then(m => m.ImageViewerComponent),
+ * ```
+ */
+type AXFileTypeComponent = Type<AXFileTypeViewComponent> | (() => Promise<Type<AXFileTypeViewComponent>>);
+/**
+ * Recommended contract for file-type view components.
+ * Implement `readonly payload = input.required<TPayload>()` in new components.
+ */
+interface AXFileTypeViewComponent<TPayload = unknown> {
+    readonly payload: InputSignal<TPayload> | Signal<TPayload>;
+}
+/** Resolves a {@link AXFileTypeComponent} to an Angular component type. */
+declare function resolveFileTypeComponentType(component: AXFileTypeComponent): Promise<Type<unknown>>;
+/** Whether `value` is a lazy loader rather than an Angular component class. */
+declare function isLazyFileTypeComponentLoader(value: AXFileTypeComponent): value is () => Promise<Type<AXFileTypeViewComponent>>;
+
 /** Metadata key for catalog usage context. */
 declare const AX_FILE_TYPE_METADATA_PURPOSE: "purpose";
 /** Catalog metadata bag; `purpose` lists usage contexts (e.g. `['system']`). */
@@ -86,14 +111,14 @@ interface AXFileValidations {
     maxSize?: number;
     rules?: AXFileValidationRule[];
 }
-type AXFileTypeUtilities = Record<string, (ctx: AXFileTypeContext, ...args: unknown[]) => Promise<unknown> | unknown>;
+type AXFileTypeUtilities$1 = Record<string, (ctx: AXFileTypeContext, ...args: unknown[]) => Promise<unknown> | unknown>;
 /**
  * Logical file category (image, video, …).
  *
  * - With type `validations` set: any file matching those rules is allowed; `extensions` only override when matched.
  * - With empty / omitted `validations` and `extensions` listed: only those extensions are allowed.
  */
-interface AXFileType<T extends AXFileTypeUtilities = AXFileTypeUtilities> {
+interface AXFileType<T extends AXFileTypeUtilities$1 = AXFileTypeUtilities$1> {
     name: string;
     title?: string;
     icon?: string;
@@ -113,9 +138,11 @@ interface AXFileType<T extends AXFileTypeUtilities = AXFileTypeUtilities> {
      * Invoke via {@link runFileTypeOpen} so `inject()` works in the caller's context.
      */
     open?: (ctx: AXFileTypeOpenContext, payload: unknown) => Promise<AXFileOpenResult> | AXFileOpenResult;
+    /** Optional view component (eager class or lazy `() => import(...)`) for this file type's payload. */
+    component?: AXFileTypeComponent;
 }
 /** Extension entry — {@link AXFileType} without nested `extensions`. */
-type AXFileTypeExtension<T extends AXFileTypeUtilities = AXFileTypeUtilities> = Omit<AXFileType<T>, 'extensions'>;
+type AXFileTypeExtension<T extends AXFileTypeUtilities$1 = AXFileTypeUtilities$1> = Omit<AXFileType<T>, 'extensions'>;
 
 declare function getFileTypePurposes(type: AXFileType): string[];
 declare function fileTypeMatchesPurpose(type: AXFileType, purpose: string | string[]): boolean;
@@ -140,6 +167,9 @@ declare function findFileTypeExtension(file: File, type: AXFileType): AXFileType
 declare function resolveFileTypeExtension(type: AXFileType, hint?: AXFileTypeExtensionHint): AXFileTypeExtension | undefined;
 declare function resolveFileTypeCopy(type: AXFileType, extension?: AXFileTypeExtension): AXFileType['copy'] | undefined;
 declare function resolveFileTypeOpen(type: AXFileType, extension?: AXFileTypeExtension): AXFileType['open'] | undefined;
+declare function resolveFileTypeComponent(type: AXFileType, extension?: AXFileTypeExtension): AXFileType['component'] | undefined;
+/** Loads the resolved view component (extension override first). */
+declare function loadFileTypeComponent(type: AXFileType, extension?: AXFileTypeExtension): Promise<Type<unknown> | undefined>;
 declare function resolveFileTypePaste(type: AXFileType, extension?: AXFileTypeExtension): AXFileType['paste'] | undefined;
 declare function resolveFileTypeUtility(type: AXFileType, extension: AXFileTypeExtension | undefined, name: string): ((ctx: AXFileTypeContext, ...args: unknown[]) => Promise<unknown> | unknown) | undefined;
 /** Runs `copy` from extension first, then parent type. */
@@ -149,6 +179,68 @@ declare function runFileTypeUtility(type: AXFileType, ctx: AXFileTypeContext, ex
 /** Runs a catalog utility with optional file-based extension resolution. */
 declare function runFileTypeUtilityForFile(type: AXFileType, ctx: AXFileTypeContext, file: File | undefined, name: string, ...args: unknown[]): Promise<unknown> | unknown;
 
+type AXFileTypeUtilities = Record<string, (ctx: AXFileTypeContext, ...args: unknown[]) => Promise<unknown> | unknown>;
+/** Config for {@link defineFileType}. */
+interface DefineFileTypeConfig<TPayload = unknown, TUtilities extends AXFileTypeUtilities = AXFileTypeUtilities> {
+    name: string;
+    title?: string;
+    icon?: string;
+    metadata?: AXFileTypeMetadata;
+    validations?: AXFileValidations;
+    extensions?: AXFileTypeExtension<TUtilities>[];
+    utilities?: TUtilities;
+    paste?: AXFileType<TUtilities>['paste'];
+    copy?: (payload: TPayload) => Promise<AXFileCopyResult> | AXFileCopyResult;
+    open?: (ctx: AXFileTypeOpenContext, payload: TPayload) => Promise<AXFileOpenResult> | AXFileOpenResult;
+    /** Eager component class or lazy `() => import(...).then(m => m.Component)`. */
+    component?: AXFileTypeComponent;
+}
+/**
+
+ * 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),
+
+ * });
+
+ * ```
+
+ */
+declare function defineFileType<TPayload = unknown, TUtilities extends AXFileTypeUtilities = AXFileTypeUtilities>(config: DefineFileTypeConfig<TPayload, TUtilities>): AXFileType<TUtilities>;
+
+/** Registers static file types via the existing {@link AXFileTypeInfoProvider} multi-token. */
+declare function provideFileTypes(types: AXFileType[] | (() => AXFileType[] | Promise<AXFileType[]>)): Provider;
+
+declare class AXFileTypeRendererOutletComponent {
+    private readonly registry;
+    /** Catalog name (e.g. `image`, `conversation-image`). */
+    readonly fileType: i0.InputSignal<string>;
+    /** Payload passed to the file-type view component. */
+    readonly payload: i0.InputSignal<unknown>;
+    /** Optional extension / MIME hint for extension-level renderer overrides. */
+    readonly extensionHint: i0.InputSignal<AXFileTypeExtensionHint>;
+    /** Extra inputs merged with `payload` (e.g. `message` in conversation). */
+    readonly inputs: i0.InputSignal<Record<string, unknown>>;
+    readonly resolvedComponent: i0.WritableSignal<Type<unknown>>;
+    readonly loading: i0.WritableSignal<boolean>;
+    readonly mergedInputs: i0.WritableSignal<Record<string, unknown>>;
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXFileTypeRendererOutletComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AXFileTypeRendererOutletComponent, "ax-file-type-renderer", never, { "fileType": { "alias": "fileType"; "required": true; "isSignal": true; }; "payload": { "alias": "payload"; "required": true; "isSignal": true; }; "extensionHint": { "alias": "extensionHint"; "required": false; "isSignal": true; }; "inputs": { "alias": "inputs"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
 /** Contributes {@link AXFileType} entries (multi provider). */
 declare abstract class AXFileTypeInfoProvider {
     abstract items(): Promise<AXFileType[]>;
@@ -167,6 +259,10 @@ declare class AXFileTypeRegistryService {
     private resolveTypes;
     getTypes(query?: AXFileTypeQuery): Promise<AXFileType[]>;
     get(name: string): Promise<AXFileType | undefined>;
+    /** Resolved view component ref for a catalog entry (optional extension hint). */
+    getComponent(name: string, hint?: AXFileTypeExtensionHint): Promise<AXFileType['component'] | undefined>;
+    /** Loads the view component for a catalog entry. */
+    loadComponent(name: string, hint?: AXFileTypeExtensionHint): Promise<Type<unknown> | undefined>;
     accept(typeNames?: string | string[]): Promise<string>;
     matchType(file: File): Promise<AXFileType | undefined>;
     validate(file: File, typeName: string): Promise<AXValidationRuleResult[]>;
@@ -362,5 +458,5 @@ declare class AXFileService {
     static ɵprov: i0.ɵɵInjectableDeclaration<AXFileService>;
 }
 
-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 type { AXFileChooseOptions, AXFileCopyData, AXFileCopyResult, AXFileMaxSizeValidationRuleOptions, AXFileMimeTypeValidationRuleOptions, AXFileMinSizeValidationRuleOptions, AXFileModuleConfig, AXFileOpenResult, AXFileSizeFormatterOptions, AXFileType, AXFileTypeContext, AXFileTypeExtension, AXFileTypeExtensionHint, AXFileTypeMetadata, AXFileTypeOpenContext, AXFileTypeQuery, AXFileValidationRule, AXFileValidations };
+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 };
+export type { AXFileChooseOptions, AXFileCopyData, AXFileCopyResult, AXFileMaxSizeValidationRuleOptions, AXFileMimeTypeValidationRuleOptions, AXFileMinSizeValidationRuleOptions, AXFileModuleConfig, AXFileOpenResult, AXFileSizeFormatterOptions, AXFileType, AXFileTypeComponent, AXFileTypeContext, AXFileTypeExtension, AXFileTypeExtensionHint, AXFileTypeMetadata, AXFileTypeOpenContext, AXFileTypeQuery, AXFileTypeViewComponent, AXFileValidationRule, AXFileValidations, DefineFileTypeConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acorex/core",
-  "version": "20.9.0",
+  "version": "20.9.1",
   "peerDependencies": {
     "lodash-es": ">=4.17.21",
     "memoizee": ">=0.4.15",