bways-report 0.1.0

package/lib/primitives/components/kpi-card/rpt-kpi-card.component.d.ts

@@ -0,0 +1,43 @@
+import { ReportComponentDefinition } from '../../../core/models/report-component.model';
+import * as i0 from "@angular/core";
+export type KpiTheme = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'neutral';
+export type TrendDirection = 'up' | 'down' | 'neutral';
+export declare class RptKpiCardComponent {
+    /** Optional metadata component definition. */
+    readonly definition: import("@angular/core").InputSignal<ReportComponentDefinition | undefined>;
+    /** Title of metric (e.g., 'Total Revenue'). */
+    readonly customTitle: import("@angular/core").InputSignal<string | undefined>;
+    /** Metric value. */
+    readonly customValue: import("@angular/core").InputSignal<string | number | undefined>;
+    /** Currency or unit prefix (e.g. '$'). */
+    readonly customPrefix: import("@angular/core").InputSignal<string | undefined>;
+    /** Unit suffix (e.g. '%', 'items'). */
+    readonly customSuffix: import("@angular/core").InputSignal<string | undefined>;
+    /** Theme accent color. */
+    readonly customTheme: import("@angular/core").InputSignal<KpiTheme | undefined>;
+    /** Icon symbol or emoji. */
+    readonly customIcon: import("@angular/core").InputSignal<string | undefined>;
+    /** Trend direction: up | down | neutral */
+    readonly customTrendDirection: import("@angular/core").InputSignal<TrendDirection | undefined>;
+    /** Trend percentage value. */
+    readonly customTrendValue: import("@angular/core").InputSignal<number | undefined>;
+    /** Trend contextual label. */
+    readonly customTrendLabel: import("@angular/core").InputSignal<string | undefined>;
+    /** Subtitle. */
+    readonly customSubtitle: import("@angular/core").InputSignal<string | undefined>;
+    readonly title: import("@angular/core").Signal<string>;
+    readonly rawValue: import("@angular/core").Signal<string | number>;
+    readonly formattedValue: import("@angular/core").Signal<string>;
+    readonly prefix: import("@angular/core").Signal<string>;
+    readonly suffix: import("@angular/core").Signal<string>;
+    readonly theme: import("@angular/core").Signal<KpiTheme>;
+    readonly icon: import("@angular/core").Signal<string>;
+    readonly trendDirection: import("@angular/core").Signal<TrendDirection>;
+    readonly trendValue: import("@angular/core").Signal<number | undefined>;
+    readonly hasTrend: import("@angular/core").Signal<boolean>;
+    readonly trendArrow: import("@angular/core").Signal<string>;
+    readonly trendLabel: import("@angular/core").Signal<string>;
+    readonly subtitle: import("@angular/core").Signal<string>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RptKpiCardComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<RptKpiCardComponent, "rpt-kpi-card", never, { "definition": { "alias": "definition"; "required": false; "isSignal": true; }; "customTitle": { "alias": "title"; "required": false; "isSignal": true; }; "customValue": { "alias": "value"; "required": false; "isSignal": true; }; "customPrefix": { "alias": "prefix"; "required": false; "isSignal": true; }; "customSuffix": { "alias": "suffix"; "required": false; "isSignal": true; }; "customTheme": { "alias": "theme"; "required": false; "isSignal": true; }; "customIcon": { "alias": "icon"; "required": false; "isSignal": true; }; "customTrendDirection": { "alias": "trendDirection"; "required": false; "isSignal": true; }; "customTrendValue": { "alias": "trendValue"; "required": false; "isSignal": true; }; "customTrendLabel": { "alias": "trendLabel"; "required": false; "isSignal": true; }; "customSubtitle": { "alias": "subtitle"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/lib/primitives/components/number/rpt-number.component.d.ts

@@ -0,0 +1,20 @@
+import { FormControl } from '@angular/forms';
+import { ReportComponentDefinition } from '../../../core/models/report-component.model';
+import * as i0 from "@angular/core";
+export declare class RptNumberComponent {
+    readonly config: import("@angular/core").InputSignal<ReportComponentDefinition>;
+    readonly control: import("@angular/core").InputSignal<FormControl<any> | undefined>;
+    private readonly fallbackControl;
+    readonly formControl: import("@angular/core").Signal<FormControl<any>>;
+    readonly elementId: import("@angular/core").Signal<string>;
+    readonly placeholder: import("@angular/core").Signal<string>;
+    readonly prefix: import("@angular/core").Signal<string>;
+    readonly suffix: import("@angular/core").Signal<string>;
+    readonly minVal: import("@angular/core").Signal<number>;
+    readonly maxVal: import("@angular/core").Signal<number>;
+    readonly stepVal: import("@angular/core").Signal<number>;
+    readonly isInvalid: import("@angular/core").Signal<boolean>;
+    readonly errorMessage: import("@angular/core").Signal<string>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RptNumberComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<RptNumberComponent, "rpt-number", never, { "config": { "alias": "config"; "required": true; "isSignal": true; }; "control": { "alias": "control"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/lib/primitives/index.d.ts

@@ -0,0 +1,2 @@
+export * from './components';
+export { registerBuiltinComponents } from './register-builtins';

package/lib/primitives/register-builtins.d.ts

@@ -0,0 +1,11 @@
+import { ComponentRegistry } from '../core/registry/component-registry';
+/**
+ * Registers all built-in primitive components with the ComponentRegistry.
+ *
+ * This provides the baseline components for any reporting page.
+ * Host applications can override any of these by calling `registry.register()`
+ * with their own custom component after calling this function.
+ *
+ * @param registry - The ComponentRegistry instance to populate.
+ */
+export declare function registerBuiltinComponents(registry: ComponentRegistry): void;

package/lib/provide-reporting.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Reporting library root provider function.
+ *
+ * Configures the library, its tokens, and registers built-in primitives.
+ */
+import { EnvironmentProviders, Type } from '@angular/core';
+import { ReportingConfig } from './core/tokens/reporting-config.token';
+import { SessionContextProvider, SessionContextSource } from './core/tokens/session-context.token';
+import { ReportDataSourceAdapter } from './data-access/contracts/data-source.contract';
+import { MasterDataProvider } from './data-access/contracts/master-data.provider';
+import { ReportPersistenceAdapter } from './data-access/contracts/report-persistence.contract';
+import { ReportSchemaDiscoveryAdapter } from './data-access/contracts/schema-discovery.contract';
+import { ReportLookupAdapter } from './data-access/contracts/lookup.contract';
+/**
+ * Configuration options for `provideReporting()`.
+ */
+export interface ProvideReportingOptions extends Partial<ReportingConfig> {
+    /**
+     * The Angular component to use for rendering report result grids.
+     * BWays-grid is the recommended default. Host can provide any grid component.
+     */
+    gridComponent?: Type<unknown>;
+    /**
+     * The Angular component to use for rendering report visual charts.
+     * Host can provide their preferred chart component, or use the built-in SVG charts.
+     */
+    chartComponent?: Type<unknown>;
+    /** Host's implementation of the data source adapter. */
+    dataSourceAdapter?: Type<ReportDataSourceAdapter>;
+    /** Host's implementation of the master data provider. */
+    masterDataProvider?: Type<MasterDataProvider>;
+    /** Host's implementation of the persistence adapter. */
+    persistenceAdapter?: Type<ReportPersistenceAdapter>;
+    /** Host's implementation of the schema discovery adapter (defaults to HttpReportSchemaDiscoveryAdapter). */
+    schemaDiscoveryAdapter?: Type<ReportSchemaDiscoveryAdapter>;
+    /** Host's implementation of the lookup adapter (defaults to HttpReportLookupAdapter). */
+    lookupAdapter?: Type<ReportLookupAdapter>;
+    /**
+     * Host application's session context parameters (e.g. { branchId: 1, companyId: 10, userId: 'usr-1' }).
+     * Can be a static object, an Angular Signal, an Observable, or a dynamic getter function.
+     * Stored procedures automatically bind matching parameters (like @BranchId, @CompanyId) to this context.
+     */
+    sessionContext?: SessionContextSource;
+    /**
+     * Host application service class implementing `SessionContextProvider`.
+     * Resolves session parameters dynamically at runtime (e.g. from user auth state, active branch switcher).
+     */
+    sessionContextProvider?: Type<SessionContextProvider>;
+    /**
+     * Factory function that returns a SessionContextSource with dependency injection context.
+     * E.g. `sessionContextFactory: () => inject(AuthService).currentSessionSignal`
+     */
+    sessionContextFactory?: () => SessionContextSource;
+}
+/**
+ * Provides the BWays-Report library to the application.
+ *
+ * @param options - Configuration and adapter implementations.
+ * @returns Environment providers for the reporting library.
+ *
+ * @example
+ * ```typescript
+ * // app.config.ts
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     provideReporting({
+ *       apiBaseUrl: 'http://localhost:3000/api/reporting',
+ *       gridComponent: BwaysGridComponent,
+ *       defaultPageSize: 50,
+ *     }),
+ *   ],
+ * };
+ * ```
+ */
+export declare function provideReporting(options?: ProvideReportingOptions): EnvironmentProviders;

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "bways-report",
+  "version": "0.1.0",
+  "description": "Enterprise-grade, metadata-driven reporting engine and visual page builder for Angular 18+ ERP applications.",
+  "keywords": [
+    "angular",
+    "reporting",
+    "report-builder",
+    "drag-and-drop",
+    "stored-procedures",
+    "erp",
+    "grid",
+    "data-visualization",
+    "nestjs"
+  ],
+  "author": "CCPL / BWays Team",
+  "license": "SEE LICENSE IN LICENSE",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ccplProject/BWays-CustomeReport.git"
+  },
+  "homepage": "https://github.com/ccplProject/BWays-CustomeReport#readme",
+  "bugs": {
+    "url": "https://github.com/ccplProject/BWays-CustomeReport/issues"
+  },
+  "peerDependencies": {
+    "@angular/common": ">=18.0.0",
+    "@angular/core": ">=18.0.0",
+    "@angular/forms": ">=18.0.0",
+    "@angular/cdk": ">=18.0.0",
+    "rxjs": "^7.8.0"
+  },
+  "peerDependenciesMeta": {
+    "bways-grid": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false,
+  "module": "fesm2022/bways-report.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/bways-report.mjs",
+      "esm": "./esm2022/bways-report.mjs",
+      "default": "./fesm2022/bways-report.mjs"
+    }
+  }
+}

package/public-api.d.ts

@@ -0,0 +1,5 @@
+export * from './lib/core';
+export * from './lib/data-access';
+export * from './lib/primitives';
+export * from './lib/features';
+export * from './lib/provide-reporting';