angular-my-report 0.0.0-stage → 0.1.1

package/lib/ui/properties/report-props.component.d.ts

@@ -0,0 +1,34 @@
+import type { BandType, PageSettings, ReportDefinition } from '../../model/types';
+import * as i0 from "@angular/core";
+export declare function removeGroup(r: ReportDefinition, gid: string): void;
+type PageKey = Exclude<keyof PageSettings, 'continuous'>;
+export declare class ReportPropsComponent {
+    private readonly store;
+    protected readonly report: import("@angular/core").WritableSignal<ReportDefinition>;
+    protected readonly labels: Record<BandType, string>;
+    protected readonly optionalBands: BandType[];
+    protected readonly sizeNames: string[];
+    protected readonly pageFields: {
+        key: PageKey;
+        label: string;
+        min: number;
+    }[];
+    protected readonly landscape: import("@angular/core").Signal<boolean>;
+    protected readonly sizeName: import("@angular/core").Signal<string>;
+    protected setName(v: string): void;
+    protected setSize(name: string): void;
+    protected setContinuous(on: boolean): void;
+    protected setOrientation(v: string): void;
+    protected setPage(k: PageKey, min: number, v: number | null): void;
+    protected isVisible(t: BandType): boolean;
+    protected setVisible(t: BandType, on: boolean): void;
+    protected setGroupField(gid: string, v: string): void;
+    protected deleteGroup(gid: string): void;
+    protected addGroup(): void;
+    protected setSort(i: number, k: 'field' | 'direction', v: string): void;
+    protected removeSort(i: number): void;
+    protected addSort(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ReportPropsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ReportPropsComponent, "rpt-report-props", never, {}, {}, never, never, true, never>;
+}
+export {};

package/lib/ui/properties/table-props.component.d.ts

@@ -0,0 +1,31 @@
+import type { FormatKind, HAlign, ReportElement, TableColumn, TableSpec } from '../../model/types';
+import * as i0 from "@angular/core";
+type ColorKey = 'headerBackground' | 'stripeBackground' | 'gridColor' | 'headerColor';
+export declare class TablePropsComponent {
+    private readonly store;
+    readonly el: import("@angular/core").InputSignal<ReportElement>;
+    protected readonly formatKinds: FormatKind[];
+    protected readonly spec: import("@angular/core").Signal<TableSpec>;
+    protected readonly widths: import("@angular/core").Signal<number[]>;
+    /** Edits the table and keeps the element height in sync with its header/row/footer heights. */
+    protected set(fn: (t: TableSpec, e: ReportElement) => void): void;
+    protected col(i: number, fn: (c: TableColumn) => void): void;
+    protected colorValue(v: string): string;
+    protected flag: (k: "showHeader" | "repeatHeader" | "showFooter", v: boolean) => (t: TableSpec) => boolean;
+    protected color: (k: ColorKey, v: string) => (t: TableSpec) => string;
+    protected rowFill: (v: string) => (_: TableSpec, e: ReportElement) => string;
+    protected setHeader: (v: string) => (c: TableColumn) => string;
+    protected setCell: (v: string) => (c: TableColumn) => string;
+    protected setFooter: (v: string) => (c: TableColumn) => string;
+    protected setAlign: (v: HAlign) => (c: TableColumn) => HAlign;
+    protected setFormat: (v: FormatKind) => (c: TableColumn) => FormatKind;
+    protected height(k: 'headerHeight' | 'rowHeight', v: number | null): void;
+    protected colWidth(i: number, v: number | null): void;
+    protected colDecimals(i: number, v: number | null): void;
+    protected moveColumn(i: number, d: number): void;
+    protected removeColumn(i: number): void;
+    protected addColumn(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TablePropsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TablePropsComponent, "rpt-table-props", never, { "el": { "alias": "el"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+export {};

package/lib/ui/viewer/page-view.component.d.ts

@@ -0,0 +1,17 @@
+import type { PageBackground, PageSettings, Watermark } from '../../model/types';
+import type { ViewPage } from './render';
+import * as i0 from "@angular/core";
+/** One printed page: background, watermark, bands and their elements. */
+export declare class PageViewComponent {
+    readonly page: import("@angular/core").InputSignal<ViewPage>;
+    readonly settings: import("@angular/core").InputSignal<PageSettings>;
+    readonly watermark: import("@angular/core").InputSignal<Watermark>;
+    readonly background: import("@angular/core").InputSignal<PageBackground>;
+    readonly watermarkText: import("@angular/core").InputSignal<string>;
+    readonly highlights: import("@angular/core").InputSignal<ReadonlySet<string>>;
+    readonly active: import("@angular/core").InputSignal<string | null>;
+    protected readonly contentWidth: import("@angular/core").Signal<number>;
+    protected readonly fit: import("@angular/core").Signal<"none" | "contain" | "cover" | "fill">;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PageViewComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<PageViewComponent, "rpt-page-view", never, { "page": { "alias": "page"; "required": true; "isSignal": true; }; "settings": { "alias": "settings"; "required": true; "isSignal": true; }; "watermark": { "alias": "watermark"; "required": true; "isSignal": true; }; "background": { "alias": "background"; "required": true; "isSignal": true; }; "watermarkText": { "alias": "watermarkText"; "required": false; "isSignal": true; }; "highlights": { "alias": "highlights"; "required": false; "isSignal": true; }; "active": { "alias": "active"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/lib/ui/viewer/render.d.ts

@@ -0,0 +1,43 @@
+import type { ReportDefinition, ReportElement } from '../../model/types';
+import { type Row } from '../../engine/expressions';
+import type { TableRenderData } from '../../engine/table';
+import type { ParamValues } from '../../engine/parameters';
+export interface ViewItem {
+    /** Unique within the document: page:band:element. Used for find highlights. */
+    key: string;
+    el: ReportElement;
+    rows?: Row[];
+    top: number;
+    height: number;
+    content: string;
+    tableData?: TableRenderData;
+    /** Plain text of the item (content or table cells), for Find. */
+    text: string;
+}
+export interface ViewBand {
+    top: number;
+    height: number;
+    items: ViewItem[];
+}
+export interface ViewPage {
+    index: number;
+    height: number;
+    background: boolean;
+    watermark: boolean;
+    bands: ViewBand[];
+}
+/** Group headers as a navigable tree. */
+export interface Bookmark {
+    label: string;
+    page: number;
+    top: number;
+    children: Bookmark[];
+}
+export interface ViewDocument {
+    pages: ViewPage[];
+    bookmarks: Bookmark[];
+    rowCount: number;
+    watermarkText: string;
+}
+/** Lays out and evaluates the whole report into ready-to-draw pages, plus group bookmarks. */
+export declare function buildDocument(report: ReportDefinition, rows: Row[], params: ParamValues, root: unknown): ViewDocument;

package/lib/ui/viewer/viewer.component.d.ts

@@ -0,0 +1,99 @@
+import type { ReportParameter } from '../../model/types';
+import { DesignerStore } from '../designer.store';
+import { type Bookmark } from './render';
+import * as i0 from "@angular/core";
+type ViewMode = 'continuous' | 'single' | 'two';
+type ZoomMode = 'width' | 'page' | number;
+/**
+ * Report viewer: paged view with navigation, zoom, view modes, find, bookmarks, thumbnails,
+ * parameters, print and export. Used standalone (/viewer) and as the designer's preview.
+ */
+export declare class ViewerComponent {
+    protected readonly store: DesignerStore;
+    /** Inside the designer (shows Close) vs. the standalone /viewer page. */
+    readonly embedded: import("@angular/core").InputSignal<boolean>;
+    /** Standalone viewer: shows a "Designer" link to this URL. */
+    readonly designerUrl: import("@angular/core").InputSignal<string | null | undefined>;
+    /** Standalone viewer: shows the Open button for local .report.json files. */
+    readonly allowOpen: import("@angular/core").InputSignal<boolean>;
+    private readonly host;
+    readonly closed: import("@angular/core").OutputEmitterRef<void>;
+    private readonly root;
+    private readonly scroll;
+    private readonly findBox;
+    protected readonly zoomSteps: number[];
+    protected readonly mode: import("@angular/core").WritableSignal<ViewMode>;
+    protected readonly zoomMode: import("@angular/core").WritableSignal<ZoomMode>;
+    protected readonly current: import("@angular/core").WritableSignal<number>;
+    protected readonly sidebar: import("@angular/core").WritableSignal<boolean>;
+    protected readonly sideTab: import("@angular/core").WritableSignal<"bookmarks" | "pages">;
+    protected readonly findOpen: import("@angular/core").WritableSignal<boolean>;
+    protected readonly query: import("@angular/core").WritableSignal<string>;
+    protected readonly matchIndex: import("@angular/core").WritableSignal<number>;
+    protected readonly paramsOpen: import("@angular/core").WritableSignal<boolean>;
+    private readonly viewport;
+    protected readonly settings: import("@angular/core").Signal<import("angular-my-report").PageSettings>;
+    protected readonly watermark: import("@angular/core").Signal<{
+        enabled: boolean;
+        kind: "text" | "image";
+        text: string;
+        image: string;
+        opacity: number;
+        angle: number;
+        fontSize: number;
+        color: string;
+        bold: boolean;
+        imageScale: number;
+        layer: "behind" | "front";
+        pages: "all" | "first";
+    }>;
+    protected readonly background: import("@angular/core").Signal<{
+        enabled: boolean;
+        image: string;
+        fit: "cover" | "contain" | "stretch" | "center";
+        pages: "all" | "first";
+    }>;
+    protected readonly parameters: import("@angular/core").Signal<ReportParameter[]>;
+    protected readonly doc: import("@angular/core").Signal<import("./render").ViewDocument>;
+    protected readonly pageCount: import("@angular/core").Signal<number>;
+    protected readonly shownPages: import("@angular/core").Signal<import("./render").ViewPage[]>;
+    /** Effective zoom factor (fit modes depend on the viewport and the page size). */
+    protected readonly zoom: import("@angular/core").Signal<number>;
+    protected readonly zoomKey: import("@angular/core").Signal<string>;
+    protected readonly thumbScale: import("@angular/core").Signal<number>;
+    protected readonly matches: import("@angular/core").Signal<{
+        key: string;
+        page: number;
+    }[]>;
+    protected readonly highlightSet: import("@angular/core").Signal<ReadonlySet<string>>;
+    protected readonly activeKey: import("@angular/core").Signal<string>;
+    protected readonly draft: import("@angular/core").WritableSignal<Record<string, string>>;
+    constructor();
+    protected choices(p: ReportParameter): string[];
+    protected setDraft(name: string, value: unknown): void;
+    protected applyParams(): void;
+    protected asBookmarks(v: unknown): Bookmark[];
+    protected goTo(index: number, top?: number): void;
+    protected goToBookmark(b: Bookmark): void;
+    /** Continuous modes: the current page is the one at the top third of the viewport. */
+    protected onScroll(): void;
+    protected setMode(m: ViewMode): void;
+    protected setZoom(v: string): void;
+    protected zoomStep(dir: 1 | -1): void;
+    protected toggleFind(): void;
+    protected setQuery(q: string): void;
+    protected findStep(dir: 1 | -1): void;
+    private revealMatch;
+    /** Runs `fn` with every page rendered at 100% (single-page mode would otherwise print one page). */
+    private withAllPages;
+    protected print(): void;
+    protected save(kind: string): void;
+    /** The report's data rows (after the report filter) as CSV. */
+    private csv;
+    protected fullscreen(): void;
+    protected openFile(e: Event): Promise<void>;
+    protected onKey(e: KeyboardEvent): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ViewerComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ViewerComponent, "rpt-viewer", never, { "embedded": { "alias": "embedded"; "required": false; "isSignal": true; }; "designerUrl": { "alias": "designerUrl"; "required": false; "isSignal": true; }; "allowOpen": { "alias": "allowOpen"; "required": false; "isSignal": true; }; }, { "closed": "closed"; }, never, never, true, never>;
+}
+export {};

package/lib/ui/viewer.component.d.ts

@@ -0,0 +1,40 @@
+import type { DataSourceType, ReportDefinition } from '../model/types';
+import * as i0 from "@angular/core";
+/**
+ * The report viewer.
+ *
+ * ```html
+ * <myreport-viewer path="/reports/sales.report.json" datasource="/api/orders" type="json" />
+ * <myreport-viewer path="/reports/orders.report.json" datasource="https://host/odata/Orders" type="odata" />
+ * ```
+ */
+export declare class MyReportViewerComponent {
+    private readonly store;
+    /** URL of the .report.json to show. */
+    readonly path: import("@angular/core").InputSignal<string | null | undefined>;
+    /** A report definition (object or JSON string); used when `path` is empty. */
+    readonly report: import("@angular/core").InputSignal<string | ReportDefinition | null | undefined>;
+    /**
+     * The report's data, replacing its own data source: a URL (JSON file/API, or OData service / entity-set URL),
+     * a JSON string, or (as a property) an array/object. Empty = use the report's data source.
+     */
+    readonly datasource: import("@angular/core").InputSignal<unknown>;
+    /** How `datasource` is read: `json` (default) or `odata`. */
+    readonly type: import("@angular/core").InputSignal<DataSourceType | null | undefined>;
+    /** Parameter values: object, JSON string, or query string (`Country=Egypt&Year=2024`). */
+    readonly params: import("@angular/core").InputSignal<string | Record<string, unknown> | null | undefined>;
+    /** Shows a "Designer" link in the toolbar pointing at this URL. */
+    readonly designerUrl: import("@angular/core").InputSignal<string | null | undefined>;
+    /** Shows the toolbar's Open button for local .report.json files (default true). */
+    readonly allowOpen: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+    /** Fires with the report once it is loaded. */
+    readonly loaded: import("@angular/core").OutputEmitterRef<ReportDefinition>;
+    /** Fires with a message when the report or its data could not be loaded. */
+    readonly loadError: import("@angular/core").OutputEmitterRef<string>;
+    /** Fires with the rows once the data is loaded. */
+    readonly dataLoaded: import("@angular/core").OutputEmitterRef<import("../engine/expressions").Row[]>;
+    protected readonly error: import("@angular/core").WritableSignal<string | null>;
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<MyReportViewerComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MyReportViewerComponent, "myreport-viewer", never, { "path": { "alias": "path"; "required": false; "isSignal": true; }; "report": { "alias": "report"; "required": false; "isSignal": true; }; "datasource": { "alias": "datasource"; "required": false; "isSignal": true; }; "type": { "alias": "type"; "required": false; "isSignal": true; }; "params": { "alias": "params"; "required": false; "isSignal": true; }; "designerUrl": { "alias": "designerUrl"; "required": false; "isSignal": true; }; "allowOpen": { "alias": "allowOpen"; "required": false; "isSignal": true; }; }, { "loaded": "loaded"; "loadError": "loadError"; "dataLoaded": "dataLoaded"; }, never, never, true, never>;
+}

package/package.json

@@ -1,6 +1,37 @@
 {
   "name": "angular-my-report",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "description": "MyReport banded report designer and viewer for Angular: <myreport-designer> and <myreport-viewer>.",
+  "keywords": [
+    "angular",
+    "report",
+    "report-designer",
+    "report-viewer",
+    "odata",
+    "json",
+    "pdf",
+    "print"
+  ],
+  "license": "MIT",
+  "peerDependencies": {
+    "@angular/common": ">=18.1.0 <23.0.0",
+    "@angular/core": ">=18.1.0 <23.0.0",
+    "@angular/forms": ">=18.1.0 <23.0.0"
+  },
+  "dependencies": {
+    "qrcode-generator": "^1.4.4",
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false,
+  "module": "fesm2022/angular-my-report.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./fesm2022/angular-my-report.mjs"
+    }
+  }
 }

package/public-api.d.ts

@@ -0,0 +1,7 @@
+export { MyReportDesignerComponent } from './lib/ui/designer.component';
+export { MyReportViewerComponent } from './lib/ui/viewer.component';
+export { overrideDataSource, type DataOverride } from './lib/ui/designer.store';
+export * from './lib/model/types';
+export { newReport, sampleReport, emptyDataSource } from './lib/model/defaults';
+export { receiptReport } from './lib/model/factories';
+export { loadData, detectDataSource, type LoadResult, type FieldInfo } from './lib/engine/dataSources';