@bootkit/ng0 0.0.0-alpha.2 → 0.0.0-alpha.4

package/http/index.d.ts

@@ -1,66 +1,136 @@
-import { HttpHeaders, HttpClient } from '@angular/common/http';
+import { HttpParams, HttpHeaders, HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
-import * as i0 from '@angular/core';
-import { InjectionToken, TransferState } from '@angular/core';
 import { DataRequest, DataResult } from '@bootkit/ng0/data';
+import * as i0 from '@angular/core';
+import { TransferState, Injector, InjectionToken, Provider, EnvironmentProviders } from '@angular/core';
 
-declare const HttpServiceBaseUrl: InjectionToken<unknown>;
-interface HttpOptions {
+interface HttpRequestOptions {
     /** Http request ID */
-    id?: string;
-    query?: any;
+    id?: any;
+    params?: HttpParams | Record<string, string | number | boolean | ReadonlyArray<string | number | boolean>>;
+    headers?: HttpHeaders | Record<string, string | string[]>;
     pathType?: 'relative' | 'absolute';
     responseType?: 'json' | 'blob' | 'text';
     contentType?: 'json' | 'multipart/form-data';
     reportProgress?: boolean;
     observe?: 'response' | 'body' | 'events';
-    displayServerErrors?: boolean;
-    sendAuthToken?: boolean;
-    /** Save response in transfer state */
-    transferState?: {
-        enable: boolean;
+    /**
+     * Additional data to associate with this object.
+     */
+    tag?: Record<string, string | number | boolean | ReadonlyArray<string | number | boolean>>;
+    /**
+     * HttpDataRequestResolver
+     */
+    dataRequestResolver?: HttpDataRequestResolver;
+    /**
+     * Save response in transfer state
+     *
+     */
+    transferState?: boolean | {
+        /**
+         * Clear transfer state after first read.
+         */
         clearAfterUse?: boolean;
     };
 }
-declare abstract class HttpEvent {
-    readonly url: string;
-    readonly options?: HttpOptions;
-    constructor(url: string, options?: HttpOptions);
+/**
+ * HttpDataRequestResolver is a function that takes a URL, a DataRequest, and options,
+ * and returns an Observable that emits a DataResult.
+ * This is used to convert a DataRequest into query parameters or request body for an HTTP request.
+ * @param url The URL to send the request to.
+ * @param dataRequest The DataRequest to convert.
+ * @param options Additional options for the request, such as headers.
+ */
+type HttpDataRequestResolver<T = any> = (url: string, dataRequest: DataRequest, options?: HttpRequestOptions) => Observable<DataResult<T>>;
+interface HttpRequestEventBase {
+    type: 'Send' | 'Complete' | 'Progress' | 'Error';
+    url: string;
+    options?: HttpRequestOptions;
 }
-declare class HttpRequestSendEvent extends HttpEvent {
-    constructor(url: string, options?: HttpOptions);
+interface HttpRequestSendEvent extends HttpRequestEventBase {
+    type: 'Send';
 }
-declare class HttpResponseEvent extends HttpEvent {
-    constructor(url: string, options?: HttpOptions);
+interface HttpRequestCompleteEvent extends HttpRequestEventBase {
+    type: 'Complete';
+    response?: any;
 }
-declare class HttpErrorEvent extends HttpEvent {
-    constructor(url: string, options?: HttpOptions);
+interface HttpRequestProgressEvent extends HttpRequestEventBase {
+    type: 'Progress';
 }
+interface HttpRequestErrorEvent extends HttpRequestEventBase {
+    type: 'Error';
+    error: any;
+}
+type HttpRequestEvent = HttpRequestSendEvent | HttpRequestCompleteEvent | HttpRequestProgressEvent | HttpRequestErrorEvent;
 
+/**
+ * HttpService provides a simple HTTP client for making requests.
+ * It supports GET, POST, PUT, DELETE methods and can handle DataRequest objects.
+ * It also supports transfer state for server-side rendering.
+ * It emits events for request lifecycle: Send, Progress, Complete and Error.
+ * It can be configured with a base URL and a default DataRequest resolver.
+ * It can also handle multipart/form-data requests.
+ */
 declare class HttpService {
-    private _http;
+    private http;
     private transferState;
+    private injector;
     private platformId;
     private _eventsSubject;
     private _baseUrl?;
-    events: Observable<HttpEvent>;
+    events: Observable<HttpRequestEvent>;
     defaultHeaders?: HttpHeaders;
-    constructor(_http: HttpClient, transferState: TransferState, platformId: object, baseUrl?: string);
-    get<T>(url: string, options?: HttpOptions): Observable<T>;
-    private _handleTransferState;
-    getResult<T>(url: string, request: DataRequest, options?: HttpOptions): Observable<DataResult<T>>;
-    post<T>(url: string, body: any, options?: HttpOptions): Observable<T>;
-    put<T>(url: string, body: any, options?: HttpOptions): Observable<T>;
-    delete<T>(url: string, options?: HttpOptions): Observable<T>;
-    private tap;
-    private makeUrl;
-    private makeHttpClientOptions;
-    private makeBody;
-    private processBodyFields;
-    private mapDataRequesToQueryObject;
-    static ɵfac: i0.ɵɵFactoryDeclaration<HttpService, [null, null, null, { optional: true; }]>;
+    private readonly _config;
+    constructor(http: HttpClient, transferState: TransferState, injector: Injector, platformId: object);
+    get<T>(url: string, options?: HttpRequestOptions): Observable<T>;
+    getDataResult<T>(url: string, request: DataRequest, options?: HttpRequestOptions): Observable<DataResult<T>>;
+    post<T>(url: string, body: any, options?: HttpRequestOptions): Observable<T>;
+    put<T>(url: string, body: any, options?: HttpRequestOptions): Observable<T>;
+    delete<T>(url: string, options?: HttpRequestOptions): Observable<T>;
+    private _makeUrl;
+    private _makeBody;
+    private _handleEvents;
+    private _verifyOptions;
+    private _findInTransferState;
+    static ɵfac: i0.ɵɵFactoryDeclaration<HttpService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<HttpService>;
 }
 
-export { HttpErrorEvent, HttpEvent, HttpRequestSendEvent, HttpResponseEvent, HttpService, HttpServiceBaseUrl };
-export type { HttpOptions };
+declare const HTTP_SERVICE_CONFIG: InjectionToken<HttpServiceConfig>;
+/**
+ * Configuration for the HttpService.
+ */
+interface HttpServiceConfig {
+    /**
+     * Base URL for the HTTP requests.
+     * This is prepended to all request URLs.
+     */
+    baseUrl?: string;
+    /**
+     * A Resolver function to convert DataRequest to DataResult.
+     */
+    dataRequestResolver?: HttpDataRequestResolver;
+}
+interface HttpServiceFeature {
+    ɵproviders: Array<Provider | EnvironmentProviders>;
+}
+/**
+ * Provides the configuration for the HttpService.
+ * @param config
+ * @returns
+ */
+declare function provideHttpService(config?: HttpServiceConfig, ...features: Partial<HttpServiceFeature>[]): EnvironmentProviders;
+
+/**
+ * Default implementation of httpDataRequestResolver1.
+ * It adds DataRequest parameters as query string to the HTTP request.
+ * @param url
+ * @param dataRequest
+ * @param options
+ * @template T data item type
+ * @returns
+ */
+declare function httpDataRequestResolver1<T = any>(url: string, dataRequest: DataRequest, options?: HttpRequestOptions): Observable<DataResult<T>>;
+
+export { HTTP_SERVICE_CONFIG, HttpService, httpDataRequestResolver1, provideHttpService };
+export type { HttpDataRequestResolver, HttpRequestCompleteEvent, HttpRequestErrorEvent, HttpRequestEvent, HttpRequestEventBase, HttpRequestOptions, HttpRequestProgressEvent, HttpRequestSendEvent, HttpServiceConfig, HttpServiceFeature };

package/localization/index.d.ts

@@ -0,0 +1,178 @@
+import * as i0 from '@angular/core';
+import { InjectionToken, PipeTransform } from '@angular/core';
+import * as rxjs from 'rxjs';
+import * as i1 from '@angular/common';
+
+/** Locale dictionary */
+type LocaleDictionary = {
+    [key: string]: string;
+};
+type LocaleEnums = {
+    [enumName: string]: {
+        [enumValue: string]: string;
+    };
+};
+/** Locale Error Translator */
+type LocaleValidationErrorTranslator = (error: any) => string;
+/** Locale validation error translator functions */
+type LocaleValidationErrorTranslators = {
+    [key: string]: LocaleValidationErrorTranslator;
+};
+/**
+ * Locale definition
+ */
+interface LocaleDefinition {
+    /** Locale name */
+    readonly name: string;
+    /** Does this locale belongs to a RTL language */
+    readonly rtl?: boolean;
+    /** Locale dictionary */
+    dictionary?: LocaleDictionary;
+    enums?: LocaleEnums;
+    form?: {
+        validation?: {
+            /** Form validation error translators. */
+            errors?: LocaleValidationErrorTranslators;
+        };
+    };
+}
+type LocaleDefinitionExtend = {
+    dictionary?: LocaleDictionary;
+    enums?: LocaleEnums;
+    form?: {
+        validation?: {
+            /** Form validation error translators. */
+            errors?: LocaleValidationErrorTranslators;
+        };
+    };
+};
+
+declare class LocalizationService {
+    private _locales;
+    private _activeLocale?;
+    private _changeSubject;
+    readonly change: rxjs.Observable<LocaleChangeEvent>;
+    constructor();
+    /** Adds a Locale */
+    add(locale: Locale): void;
+    /** Adds an array of Locales to this LocaleProvider */
+    add(locales: Locale[]): void;
+    /** Changes the active locale */
+    set(localeName: string): void;
+    /** Gets the active locale */
+    get(): Locale | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LocalizationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<LocalizationService>;
+}
+
+declare const LOCALE: InjectionToken<LocalizationService | Locale>;
+interface TranslatedValidationError {
+    /** Error key */
+    key: string;
+    /** Error object */
+    value: any;
+    /** localized error text */
+    text?: string;
+}
+interface LocaleChangeEvent {
+    old?: Locale;
+    new: Locale;
+}
+
+/** Locale */
+declare class Locale {
+    readonly definition: LocaleDefinition;
+    constructor(definition: LocaleDefinition);
+    /**
+     * Returns the name of the locale
+     * @returns The name of the locale
+     */
+    get name(): string;
+    /**
+     * Translates a key in the dictionary
+     * @param key The key to look up
+     * @returns The translated string or the key itself if not found
+     */
+    translate(key: string): string;
+    /**
+     * Translates an enum value
+     * @param enumName The name of the enum
+     * @param enumValue The value of the enum to translate
+     * @returns The translated string or the enum value itself if not found
+     */
+    translateEnum(enumName: string, enumValue: any): string | undefined;
+    /**
+   * Translates a form validation error
+   * @param errorKey The key of the error to translate
+   * @param error The error object
+   */
+    translateError(errorKey: string, error: any, fallbackMessage?: string | undefined): string | undefined;
+    /**
+     * Translates validation errors
+     * @param errors Validation errors object
+     * @returns Array of translated validation errors
+     */
+    translateErrors(errors: any): TranslatedValidationError[];
+    /**
+     * Translates the first error in the validation errors object
+     * @param errors Validation errors object
+     * @returns TranslatedValidationError or undefined if no errors
+     */
+    translateFirstError(errors: any, fallbackMessage?: string | undefined): TranslatedValidationError | undefined;
+    /**
+     * Clones and extends this object and returns a new Locale (without modifying this object).
+     */
+    extend(values?: LocaleDefinitionExtend): Locale;
+    /**
+   *
+   * @param date Date string or timestamp
+   * @returns Formatted date string based on the locale
+   */
+    formatDate(date: string | number, format: string): string;
+}
+
+declare class TranslatePipe implements PipeTransform {
+    private _locale;
+    private _recompute;
+    private _value;
+    constructor(localizationService: LocalizationService);
+    transform(dictionaryKey: string, ...args: unknown[]): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TranslatePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<TranslatePipe, "ng0Translate", true>;
+}
+
+declare class EnumPipe implements PipeTransform {
+    private _locale;
+    private _recompute;
+    private _value;
+    constructor(localeProvider: LocalizationService);
+    transform(enumValue?: string | null, ...args: string[]): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EnumPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<EnumPipe, "ng0Enum", true>;
+}
+
+declare class BooleanPipe implements PipeTransform {
+    private localeProvider;
+    constructor(localeProvider: LocalizationService);
+    transform(value: any, falseKey: string | undefined, trueKey: 'false'): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BooleanPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<BooleanPipe, "ng0Bool", true>;
+}
+
+declare class DatePipe implements PipeTransform {
+    private _locale;
+    private _value;
+    constructor(localeProvider: LocalizationService);
+    transform(value: number | string): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DatePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<DatePipe, "ng0Date", true>;
+}
+
+declare class LocalizationModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<LocalizationModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<LocalizationModule, never, [typeof i1.CommonModule, typeof TranslatePipe, typeof EnumPipe, typeof BooleanPipe, typeof DatePipe], [typeof TranslatePipe, typeof EnumPipe, typeof BooleanPipe, typeof DatePipe]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<LocalizationModule>;
+}
+
+export { BooleanPipe, DatePipe, EnumPipe, LOCALE, Locale, LocalizationModule, LocalizationService, TranslatePipe };
+export type { LocaleChangeEvent, TranslatedValidationError };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bootkit/ng0",
-  "version": "0.0.0-alpha.2",
+  "version": "0.0.0-alpha.4",
   "description": "Angular+Bootstrap Component Library",
   "homepage": "https://bootkitlib.github.io/",
   "author": "BootKit",
@@ -39,13 +39,29 @@
       "types": "./common/index.d.ts",
       "default": "./fesm2022/bootkit-ng0-common.mjs"
     },
+    "./data": {
+      "types": "./data/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-data.mjs"
+    },
+    "./file": {
+      "types": "./file/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-file.mjs"
+    },
+    "./form": {
+      "types": "./form/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-form.mjs"
+    },
     "./http": {
       "types": "./http/index.d.ts",
       "default": "./fesm2022/bootkit-ng0-http.mjs"
     },
-    "./data": {
-      "types": "./data/index.d.ts",
-      "default": "./fesm2022/bootkit-ng0-data.mjs"
+    "./localization": {
+      "types": "./localization/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-localization.mjs"
+    },
+    "./script": {
+      "types": "./script/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-script.mjs"
     },
     "./security": {
       "types": "./security/index.d.ts",
@@ -55,14 +71,34 @@
       "types": "./components/accordion/index.d.ts",
       "default": "./fesm2022/bootkit-ng0-components-accordion.mjs"
     },
-    "./components/modal": {
-      "types": "./components/modal/index.d.ts",
-      "default": "./fesm2022/bootkit-ng0-components-modal.mjs"
+    "./components/button": {
+      "types": "./components/button/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-components-button.mjs"
+    },
+    "./components/code": {
+      "types": "./components/code/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-components-code.mjs"
+    },
+    "./components/card": {
+      "types": "./components/card/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-components-card.mjs"
     },
     "./components/collapse": {
       "types": "./components/collapse/index.d.ts",
       "default": "./fesm2022/bootkit-ng0-components-collapse.mjs"
     },
+    "./components/confirmation": {
+      "types": "./components/confirmation/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-components-confirmation.mjs"
+    },
+    "./components/form-field": {
+      "types": "./components/form-field/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-components-form-field.mjs"
+    },
+    "./components/modal": {
+      "types": "./components/modal/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-components-modal.mjs"
+    },
     "./components/nav": {
       "types": "./components/nav/index.d.ts",
       "default": "./fesm2022/bootkit-ng0-components-nav.mjs"
@@ -71,18 +107,26 @@
       "types": "./components/offcanvas/index.d.ts",
       "default": "./fesm2022/bootkit-ng0-components-offcanvas.mjs"
     },
-    "./components/overlay": {
-      "types": "./components/overlay/index.d.ts",
-      "default": "./fesm2022/bootkit-ng0-components-overlay.mjs"
-    },
     "./components/pagination": {
       "types": "./components/pagination/index.d.ts",
       "default": "./fesm2022/bootkit-ng0-components-pagination.mjs"
     },
+    "./components/overlay": {
+      "types": "./components/overlay/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-components-overlay.mjs"
+    },
     "./components/popover": {
       "types": "./components/popover/index.d.ts",
       "default": "./fesm2022/bootkit-ng0-components-popover.mjs"
     },
+    "./components/stepper": {
+      "types": "./components/stepper/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-components-stepper.mjs"
+    },
+    "./components/table": {
+      "types": "./components/table/index.d.ts",
+      "default": "./fesm2022/bootkit-ng0-components-table.mjs"
+    },
     "./components/toast": {
       "types": "./components/toast/index.d.ts",
       "default": "./fesm2022/bootkit-ng0-components-toast.mjs"

package/script/index.d.ts

@@ -0,0 +1,27 @@
+import * as i0 from '@angular/core';
+import { RendererFactory2 } from '@angular/core';
+
+interface ScriptDefinitionObject {
+    /** Script URL */
+    src: string;
+    attrs?: {
+        [key: string]: string;
+    };
+}
+type ScriptDefinition = string | ScriptDefinitionObject;
+
+declare class ScriptLoader {
+    private _document;
+    private _renderer;
+    private _loadedScripts;
+    constructor(_rendererFactory: RendererFactory2, _document: Document);
+    loadAll(...scripts: ScriptDefinition[]): Promise<{
+        script: ScriptDefinition;
+        element: any;
+    }[]>;
+    load(script: ScriptDefinition): Promise<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ScriptLoader, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ScriptLoader>;
+}
+
+export { ScriptLoader };

package/security/index.d.ts

@@ -1,12 +1,7 @@
+import { ClaimLike } from '@bootkit/ng0/common';
 import * as i0 from '@angular/core';
 import { TemplateRef, ViewContainerRef } from '@angular/core';
 
-interface ClaimObject {
-    all?: string[];
-    any?: string[];
-}
-type ClaimLike = string | ClaimObject;
-
 /** User */
 declare class User {
     readonly claims: string[];
@@ -17,14 +12,14 @@ declare class User {
 }
 
 declare class UserStore<U extends User = User> {
-    readonly user: i0.WritableSignal<U>;
+    readonly user: i0.WritableSignal<U | null | undefined>;
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<UserStore<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<UserStore<any>>;
 }
 
 declare class UserDirective {
-    claim: i0.InputSignal<ClaimLike>;
+    claim: i0.InputSignal<ClaimLike | null | undefined>;
     private _viewCreated;
     constructor(templateRef: TemplateRef<any>, viewContainer: ViewContainerRef, userStore: UserStore);
     static ɵfac: i0.ɵɵFactoryDeclaration<UserDirective, never>;
@@ -45,4 +40,3 @@ declare class SecurityModule {
 }
 
 export { GuestUserDirective, SecurityModule, User, UserDirective, UserStore };
-export type { ClaimLike, ClaimObject };