xt-components 0.4.1 → 0.4.4

package/lib/render/xt-render.component.d.ts

@@ -4,6 +4,8 @@ import { XtComponent, XtComponentOutput } from '../xt-component';
 import { XtContext, XtDisplayMode } from '../xt-context';
 import { FormGroup } from '@angular/forms';
 import { XtResolverService } from '../angular/xt-resolver.service';
+import { XtBaseOutput } from '../output/xt-base-output';
+import { XtBaseInput } from '../output/xt-base-input';
 import * as i0 from "@angular/core";
 /**
  * Offers a nice and easy to dynamically embed a component.
@@ -18,13 +20,17 @@ export declare class XtRenderComponent<T> implements AfterViewInit {
     value: import("@angular/core").ModelSignal<T | undefined>;
     formGroup: import("@angular/core").InputSignal<FormGroup<any> | undefined>;
     subName: import("@angular/core").InputSignal<string | undefined>;
+    outputsObject: XtBaseOutput;
+    inputs: import("@angular/core").InputSignal<XtBaseInput | undefined>;
     outputs: import("@angular/core").OutputEmitterRef<XtComponentOutput>;
-    hasOutputs: boolean;
     outlet: Signal<NgComponentOutlet<any>>;
     constructor();
     context: Signal<XtContext<any>>;
     type: Signal<Type<XtComponent<T>> | null>;
+    /**
+     * Transfers the input and outputs from the host to the rendered component
+     */
     ngAfterViewInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<XtRenderComponent<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<XtRenderComponent<any>, "xt-render", never, { "componentType": { "alias": "componentType"; "required": false; "isSignal": true; }; "displayMode": { "alias": "displayMode"; "required": true; "isSignal": true; }; "valueType": { "alias": "valueType"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "formGroup": { "alias": "formGroup"; "required": false; "isSignal": true; }; "subName": { "alias": "subName"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; "outputs": "outputs"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<XtRenderComponent<any>, "xt-render", never, { "componentType": { "alias": "componentType"; "required": false; "isSignal": true; }; "displayMode": { "alias": "displayMode"; "required": true; "isSignal": true; }; "valueType": { "alias": "valueType"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "formGroup": { "alias": "formGroup"; "required": false; "isSignal": true; }; "subName": { "alias": "subName"; "required": false; "isSignal": true; }; "inputs": { "alias": "inputs"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; "outputs": "outputs"; }, never, never, true, never>;
 }

package/lib/resolver/xt-registry-resolver.d.ts

@@ -1,11 +1,11 @@
 import { XtPluginRegistry } from "../registry/xt-plugin-registry";
-import { XtTypeResolver } from "../type/xt-type-resolver";
+import { XtTypeResolver } from "xt-type";
 import { XtContext } from "../xt-context";
 import { XtResolvedComponent } from "../xt-resolved-component";
 import { XtResolver } from "./xt-resolver";
 export declare class XtRegistryResolver implements XtResolver {
     registry: XtPluginRegistry;
-    typeResolver: XtTypeResolver<any>;
-    constructor(registry: XtPluginRegistry, typeResolver: XtTypeResolver<any>);
+    typeResolver: XtTypeResolver;
+    constructor(registry: XtPluginRegistry, typeResolver: XtTypeResolver);
     resolve<T>(baseContext: XtContext<T>, subName?: string): XtResolvedComponent | null;
 }

package/lib/store/store-support.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Wrapper around xt-store manager: You can use it to check if xt-store is included or not, and decide what to do
+ *
+ * This allow plugins to potentially use xt-store whenever included in the applications running the plugin
+ */
+import { Observable } from 'rxjs';
+export declare class StoreSupport {
+    protected static testStoreManager?: IStoreManager;
+    static isStoreManagerAvailable(): boolean;
+    static getStoreManager(): IStoreManager;
+    static setTestStoreManager(testStoreManager: IStoreManager): void;
+}
+/**
+ * Interface definition for xt-store component.
+ * We re-define them here to avoid importing xt-store in all plugins that don't need it.
+ */
+export interface IDataTransformer<T> {
+    /**
+     * Enable transformation of data right after it has been loaded from the store
+     * @param source
+     */
+    postLoadingTransformation(source: any[]): T[];
+}
+export interface IDocumentInfo {
+    documentName: string;
+    isUrl: boolean;
+    documentId?: string;
+}
+export interface IStoreProvider<T> {
+    storeEntity(name: string, entity: T): Promise<T>;
+    /**
+     * Rejects the promise if the entity is not found
+     * @param name
+     * @param key
+     */
+    safeLoadEntity(name: string, key: any): Promise<T>;
+    loadEntity(name: string, key: any): Promise<T | undefined>;
+    deleteEntity(name: string, key: any): Promise<boolean>;
+    searchEntities(name: string, ...criteria: any[]): Observable<Array<T>>;
+    searchAndPrepareEntities(name: string, sort?: any, groupBy?: any, transformer?: IDataTransformer<T>, ...criteria: any[]): Observable<any>;
+    canStoreDocument(): boolean;
+    /**
+     * Upload one document to a server store and returns the url or the id needed to retrieve them.
+     * @param toStore
+     * @param position
+     */
+    storeDocument(toStore: File): Promise<IDocumentInfo>;
+    /**
+     * Upload documents to a server store and returns the url or the id needed to retrieve them.
+     * @param toStore
+     * @param position
+     */
+    storeDocuments(toStore: File[]): Observable<IDocumentInfo>;
+}
+export interface IStoreManager {
+    getProvider<T = never>(name?: string): IStoreProvider<T> | undefined;
+    getProviderSafe<T = never>(name?: string): IStoreProvider<T>;
+    getDefaultProvider<T = never>(): IStoreProvider<T> | undefined;
+    getDefaultProviderSafe<T = never>(): IStoreProvider<T>;
+}

package/lib/test/store-test-helper.d.ts

@@ -0,0 +1,36 @@
+import { Observable } from 'rxjs';
+import { IDataTransformer, IDocumentInfo, IStoreManager, IStoreProvider } from '../store/store-support';
+/**
+ * A very light and not 100% compatible storemanager in case you are not using xt-store.
+ * It can emulate XtStoreManager to some extends for doing some tests
+ */
+export declare class StoreTestHelper {
+    static ensureTestProviderOnly(): void;
+}
+export declare class TestStoreManager implements IStoreManager {
+    protected defaultProvider: TestStoreProvider<never>;
+    getProvider<T = never>(name?: string): IStoreProvider<T> | undefined;
+    getProviderSafe<T = never>(name?: string): IStoreProvider<T>;
+    getDefaultProvider<T = never>(): IStoreProvider<T> | undefined;
+    getDefaultProviderSafe<T = never>(): IStoreProvider<T>;
+}
+export declare class TestStoreProvider<T = never> implements IStoreProvider<T> {
+    protected data: Map<string, Map<string, any>>;
+    protected getOrCreateArray(name: string): Map<string, any>;
+    protected extractKey(value: any): string;
+    storeEntity(name: string, entity: T): Promise<T>;
+    safeLoadEntity(name: string, key: any): Promise<T>;
+    loadEntity(name: string, key: any): Promise<T | undefined>;
+    deleteEntity(name: string, key: any): Promise<boolean>;
+    searchEntities(name: string, ...criteria: any[]): Observable<T[]>;
+    searchAndPrepareEntities(name: string, sort?: any, groupBy?: any, transformer?: IDataTransformer<T> | undefined, ...criteria: any[]): Observable<any>;
+    canStoreDocument(): boolean;
+    storeDocument(toStore: File): Promise<IDocumentInfo>;
+    storeDocuments(toStore: File[]): Observable<IDocumentInfo>;
+}
+export declare class TestDocumentInfo implements IDocumentInfo {
+    documentName: string;
+    isUrl: boolean;
+    documentId?: string;
+    constructor(documentName: string, isUrl: boolean, documentId?: string);
+}

package/lib/type/type-helper.d.ts

@@ -0,0 +1,4 @@
+import { FormGroup } from '@angular/forms';
+export declare function updateFormGroupWithValue(formGroup: FormGroup, value: {
+    [key: string]: any;
+}): void;

package/lib/xt-component.d.ts

@@ -1,20 +1,22 @@
-import { InputSignal, OutputEmitterRef, Signal } from '@angular/core';
+import { InputSignal, OutputEmitterRef } from '@angular/core';
 import { XtContext } from './xt-context';
 import { FormGroup } from '@angular/forms';
 export type XtComponent<T = any> = {
     context: InputSignal<XtContext<T>>;
+    inputsObject?: XtComponentInput;
+    outputsObject?: XtComponentOutput;
+    inputs?: InputSignal<XtComponentInput>;
     outputs?: OutputEmitterRef<XtComponentOutput>;
-    /**
-     * Does the component provides Output or not ?
-     * @protected
-     */
-    hasOutputs?: boolean;
     isInForm(): boolean;
     formControlName(): string | undefined;
     formGroup(): FormGroup;
     formGroupIfAny(): FormGroup | undefined;
 };
 export type XtOutputType = 'valueSelected';
+export type XtInputType = 'valueSelected';
 export type XtComponentOutput = {
-    [key in XtOutputType]: Signal<any | null> | undefined;
+    [key in XtOutputType]: OutputEmitterRef<any> | undefined;
+};
+export type XtComponentInput = {
+    [key in XtInputType]: InputSignal<any> | undefined;
 };

package/lib/xt-context.d.ts

@@ -1,5 +1,5 @@
 import { FormGroup } from '@angular/forms';
-import { XtTypeResolver } from './type/xt-type-resolver';
+import { XtTypeResolver } from 'xt-type';
 import { Signal, WritableSignal } from '@angular/core';
 /**
  * A XtContext provides all the necessary information for an ng-extended component to operate. It is passed from parent to child component and pass
@@ -20,10 +20,11 @@ export type XtContext<T> = {
     formControlNameOrNull(): string | null;
     formControlValue(): any | null;
     subValue(subName?: string): T | null | undefined;
-    subContext(subName: string | undefined | null, subType?: string, typeResolver?: XtTypeResolver<XtContext<T>> | null): XtContext<any>;
+    subContext(subName: string | undefined | null, subType?: string, typeResolver?: XtTypeResolver | null): XtContext<any>;
     elementSetContext(subElement: any): XtContext<any>;
     displayValue: Signal<T | null>;
     setDisplayValue(newValue: T | null | undefined, type?: string): XtContext<T>;
+    setFormValue(newValue: T | null | undefined): boolean;
     value(): T | null | undefined;
     valueType?: string;
     toString(): string;
@@ -72,13 +73,14 @@ export declare class XtBaseContext<T> implements XtContext<T> {
      */
     protected updateSubDisplayValue(subName: string, subValue: any): void;
     formControlValue(): T | null | undefined;
+    setFormValue(newValue: T | null | undefined): boolean;
     /**
      * Returns the context associated with a specific element in a set.
      * Value must be an array.
      * @param elementIndex
      */
     elementSetContext(elementIndex: number): XtContext<any>;
-    subContext(subName: string | undefined | null, subType?: string, typeResolver?: XtTypeResolver<XtContext<T>> | null): XtContext<any>;
+    subContext(subName: string | undefined | null, subType?: string, typeResolver?: XtTypeResolver | null): XtContext<any>;
     formGroup(): FormGroup | undefined;
     toString(): string;
 }

package/lib/xt-simple/xt-simple.component.d.ts

@@ -1,22 +1,19 @@
-import { InputSignal, OutputEmitterRef } from '@angular/core';
+import { OnInit } from '@angular/core';
 import { AbstractControl, FormGroup } from '@angular/forms';
 import { XtContext } from '../xt-context';
-import { XtComponent, XtComponentOutput, XtOutputType } from '../xt-component';
+import { XtComponent, XtComponentOutput } from '../xt-component';
 import { XtBaseOutput } from '../output/xt-base-output';
+import { XtBaseInput } from '../output/xt-base-input';
 import * as i0 from "@angular/core";
 /**
  * An XtSimpleComponent just displays the given value or element in a form.
  * If you need to dynamically embed other XtComponents to display sub elements, then please use the XtCompositeComponent
  */
-export declare class XtSimpleComponent<T = any> implements XtComponent<T> {
-    context: InputSignal<XtContext<T>>;
-    outputs: OutputEmitterRef<XtComponentOutput>;
-    /**
-     * Does the component provides Output or not ?
-     * @protected
-     */
-    hasOutputs: boolean;
-    protected outputElement?: XtBaseOutput;
+export declare class XtSimpleComponent<T = any> implements XtComponent<T>, OnInit {
+    context: import("@angular/core").InputSignal<XtContext<T>>;
+    outputsObject: XtBaseOutput;
+    inputsObject: XtBaseInput;
+    outputs: import("@angular/core").OutputEmitterRef<XtComponentOutput>;
     isInForm: import("@angular/core").Signal<boolean>;
     formControlNameIfAny: import("@angular/core").Signal<string | undefined>;
     formGroupIfAny: import("@angular/core").Signal<FormGroup<any> | undefined>;
@@ -26,6 +23,7 @@ export declare class XtSimpleComponent<T = any> implements XtComponent<T> {
      */
     componentNameInForm: import("@angular/core").Signal<string>;
     constructor();
+    ngOnInit(): void;
     manageFormControl<T>(ctrlName: string): AbstractControl<T> | undefined;
     safelyGetSubName: import("@angular/core").Signal<string>;
     /**
@@ -36,7 +34,11 @@ export declare class XtSimpleComponent<T = any> implements XtComponent<T> {
     componentDescriptor(): string;
     getValue: import("@angular/core").Signal<T | null | undefined>;
     displayValue: import("@angular/core").Signal<T | null>;
-    protected emitOutput(outputName: XtOutputType, newValue: any): void;
+    /**
+     * This is where components can assign their output() and input() into the XtComponent inputs and outputs member
+     * @protected
+     */
+    protected setupInputOutput(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<XtSimpleComponent<any>, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<XtSimpleComponent<any>, "ng-component", never, { "context": { "alias": "context"; "required": true; "isSignal": true; }; }, { "outputs": "outputs"; }, never, never, true, never>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xt-components",
-  "version": "0.4.1",
+  "version": "0.4.4",
   "peerDependencies": {
     "@angular/animations": "^18.1.2",
     "@angular/common": "^18.1.2",

package/public-api.d.ts

@@ -4,12 +4,16 @@ export * from './lib/xt-resolved-component';
 export * from './lib/resolver/xt-resolver';
 export * from './lib/registry/xt-plugin-registry';
 export * from './lib/plugin/xt-plugin-info';
+export * from './globals';
 export * from './lib/angular/xt-tokens';
 export * from './lib/angular/xt-resolver.service';
 export * from './lib/render/xt-render.component';
 export * from './lib/render/xt-render-sub.component';
 export * from './lib/xt-simple/xt-simple.component';
 export * from './lib/xt-composite/xt-composite.component';
-export * from './lib/type/xt-type-resolver';
+export * from './lib/angular/message-handler';
+export * from './lib/store/store-support';
+export * from './lib/type/type-helper';
 export * from './lib/test/xt-unit-test-helper';
 export * from './lib/test/xt-test-helper-components';
+export * from './lib/test/store-test-helper';

package/lib/type/xt-type-resolver.d.ts

@@ -1,42 +0,0 @@
-import { FormGroup } from '@angular/forms';
-import { XtTypeInfo } from "../plugin/xt-plugin-info";
-import { XtContext } from '../xt-context';
-/**
- * Determines the type of elements based on a hierarchy of type
- */
-export type XtTypeResolver<TypeContext> = {
-    findType(typeInfo: TypeContext | null | undefined, subName?: string, value?: any): string | null | undefined;
-    listSubNames(typeInfo: TypeContext | null | undefined, value?: any): string[];
-    canUpdate(): boolean;
-};
-export type XtUpdatableTypeResolver<TypeContext> = XtTypeResolver<TypeContext> & {
-    addType(typeName: string, type: XtTypeInfo | string): void;
-};
-export declare class XtTypeHierarchyResolver<T> implements XtUpdatableTypeResolver<XtContext<T>> {
-    types: Map<string, XtTypeHierarchy>;
-    addType(typeName: string, type: XtTypeInfo | string): void;
-    canUpdate(): boolean;
-    findType(typeInfo: XtContext<T> | null | undefined, subName?: string, value?: any): string | null | undefined;
-    listSubNames(context: XtContext<T> | null | undefined, value?: any): string[];
-}
-export type XtTypeHierarchy = {
-    type?: string;
-    children?: {
-        [key: string]: XtTypeHierarchy;
-    };
-    parent?: XtTypeHierarchy;
-    addChild(key: string, child: XtTypeHierarchy): void;
-};
-export declare class XtBaseTypeHierarchy implements XtTypeHierarchy {
-    type?: string;
-    children?: {
-        [key: string]: XtTypeHierarchy;
-    };
-    parent?: XtTypeHierarchy;
-    constructor(type?: string, parent?: XtTypeHierarchy);
-    addChild(key: string, child: XtTypeHierarchy): void;
-}
-export declare function fromDescription(typeHierarchy: XtTypeInfo | string, name?: string, parent?: XtTypeHierarchy): XtTypeHierarchy;
-export declare function updateFormGroupWithValue(formGroup: FormGroup, value: {
-    [key: string]: any;
-}): void;