@open-rap/compiler 0.0.0-stage → 0.1.1

package/dist/gen/ui/index.d.ts

@@ -0,0 +1,7 @@
+/** Generation of the OpenUI5 UI of the application (`ui/` folder, decision D10). */
+import type { Model } from "@open-rap/model";
+export { buildUiLayout, type UiLayout } from "./layout.js";
+export declare function generateUi(model: Model): Array<{
+    path: string;
+    content: string;
+}>;

package/dist/gen/ui/index.js

@@ -0,0 +1,27 @@
+/** Generation of the OpenUI5 UI of the application (`ui/` folder, decision D10). */
+import { buildUiLayout } from "./layout.js";
+import { APP_CONTROLLER, APP_VIEW, CHART, COMPONENT, CONDITIONS, FILTERS, indexHtml, LIST_CONTROLLER, manifest, OBJECT_CONTROLLER, OVERVIEW_CONTROLLER, STYLE, SUPPORT, VARIANTS } from "./static.js";
+import { views } from "./views.js";
+export { buildUiLayout } from "./layout.js";
+export function generateUi(model) {
+    const layout = buildUiLayout(model);
+    return [
+        { path: "index.html", content: indexHtml(layout) },
+        { path: "manifest.json", content: manifest(layout) },
+        { path: "Component.js", content: COMPONENT },
+        { path: "view/App.view.xml", content: APP_VIEW },
+        ...views(layout),
+        { path: "controller/App.controller.js", content: APP_CONTROLLER },
+        { path: "controller/List.controller.js", content: LIST_CONTROLLER },
+        { path: "controller/Object.controller.js", content: OBJECT_CONTROLLER },
+        { path: "controller/support.js", content: SUPPORT },
+        { path: "controller/filters.js", content: FILTERS },
+        { path: "controller/conditions.js", content: CONDITIONS },
+        { path: "controller/variants.js", content: VARIANTS },
+        { path: "controller/Chart.js", content: CHART },
+        ...(layout.overview === undefined ? [] : [{ path: "controller/Overview.controller.js", content: OVERVIEW_CONTROLLER }]),
+        { path: "css/style.css", content: STYLE },
+        { path: "model/layout.json", content: `${JSON.stringify(layout, null, 2)}\n` },
+    ];
+}
+//# sourceMappingURL=index.js.map

package/dist/gen/ui/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gen/ui/index.ts"],"names":[],"mappings":"AAAA,oFAAoF;AAGpF,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,QAAQ,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACtM,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,OAAO,EAAE,aAAa,EAAiB,MAAM,aAAa,CAAC;AAE3D,MAAM,UAAU,UAAU,CAAC,KAAY;IACrC,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO;QACL,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE;QAClD,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE;QACpD,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE;QAC5C,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,QAAQ,EAAE;QAChD,GAAG,KAAK,CAAC,MAAM,CAAC;QAChB,EAAE,IAAI,EAAE,8BAA8B,EAAE,OAAO,EAAE,cAAc,EAAE;QACjE,EAAE,IAAI,EAAE,+BAA+B,EAAE,OAAO,EAAE,eAAe,EAAE;QACnE,EAAE,IAAI,EAAE,iCAAiC,EAAE,OAAO,EAAE,iBAAiB,EAAE;QACvE,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,EAAE,OAAO,EAAE;QACnD,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,EAAE,OAAO,EAAE;QACnD,EAAE,IAAI,EAAE,0BAA0B,EAAE,OAAO,EAAE,UAAU,EAAE;QACzD,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,EAAE,QAAQ,EAAE;QACrD,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,EAAE,KAAK,EAAE;QAC/C,GAAG,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,mCAAmC,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;QACvH,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,EAAE;QACzC,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;KAC/E,CAAC;AACJ,CAAC"}

package/dist/gen/ui/layout.d.ts

@@ -0,0 +1,230 @@
+/**
+ * The layout of the generated UI (List Report and Object Page, decision D10), derived from the
+ * UI annotations of the IR the same way as the CSDL ($metadata): line items, selection fields,
+ * header info, facets, identification, field groups, actions and presentation variant.
+ *
+ * The layout is written as `ui/model/layout.json`; the generic controllers read it.
+ */
+import { type EdmType, type Model, type ValueHelp } from "@open-rap/model";
+export type FieldKind = "text" | "digits" | "integer" | "decimal" | "amount" | "boolean" | "date" | "time" | "datetime" | "uuid" | "enum";
+/** The values of an enumeration type (D55): the member and its label. */
+export type UiOption = {
+    key: string;
+    text: string;
+};
+export interface UiField {
+    property: string;
+    label: string;
+    kind: FieldKind;
+    edm: EdmType["type"];
+    maxLength?: number;
+    /** Currency or unit of an amount (`@Semantics.amount.currencyCode`). */
+    unit?: string;
+    key: boolean;
+    /** Never editable (readonly, managed numbering, administrative fields). */
+    computed: boolean;
+    /** Editable on creation only (readonly : update, keys of external numbering). */
+    immutable: boolean;
+    mandatory: boolean;
+    /** Under instance feature control (`__FieldControl`). */
+    dynamic: boolean;
+    importance?: "High" | "Medium" | "Low";
+    /** Value help of the field (`@Consumption.valueHelpDefinition`, `Common.ValueList`). */
+    valueHelp?: UiValueHelp;
+    /** Enumeration type (enhanced mode, D55): the members, in the order of the CDS type. */
+    options?: UiOption[];
+    /** `criticality` of the line item, identification or data point: the property giving 0 to 3 (D57). */
+    criticality?: string;
+    /** `@ObjectModel.text.element` and `@UI.textArrangement` (D57). */
+    text?: {
+        property: string;
+        arrangement: "TextFirst" | "TextLast" | "TextOnly" | "TextSeparate";
+    };
+    /** `@UI.multiLineText` (D57). */
+    multiLine?: boolean;
+    /** `@Semantics.email.address`, `@Semantics.telephone.type`, line item `#WITH_URL` (D57). */
+    link?: {
+        kind: "email" | "phone" | "url";
+        url?: string;
+    };
+    /**
+     * `@Consumption.filter`: default value, mandatory filter, a single condition (D57), the allowed
+     * conditions of `selectionType` (D68).
+     */
+    filter?: {
+        defaultValue?: string;
+        mandatory?: boolean;
+        single?: boolean;
+        expressions?: "SingleValue" | "SingleRange" | "MultiRange";
+    };
+}
+/** A header facet of the object page (`@UI.facet` purpose #HEADER, D57). */
+export type UiHeaderFacet = {
+    kind: "dataPoint";
+    id: string;
+    title: string;
+    field: UiField;
+    visualization?: "progress" | "rating";
+    target?: number;
+} | {
+    kind: "fields";
+    id: string;
+    title: string;
+    fields: UiField[];
+};
+/** A value help: the entity set listing the values, its element and its columns (D44). */
+export type UiValueHelp = ValueHelp;
+export interface UiParameter {
+    name: string;
+    label: string;
+    kind: FieldKind;
+    edm: EdmType["type"];
+    options?: UiOption[];
+    valueHelp?: UiValueHelp;
+}
+export interface UiAction {
+    /** Unqualified action name. */
+    name: string;
+    /** Qualified name for the binding path (`namespace.action`). */
+    qualified: string;
+    label: string;
+    /** Static (collection-bound) action. */
+    static: boolean;
+    factory: boolean;
+    kind: "action" | "function";
+    parameters: UiParameter[];
+    /** Under instance feature control (`__OperationControl/<name>`). */
+    dynamic: boolean;
+    /** The result is an instance of the entity set (navigate to it for factory actions). */
+    returnsEntity: boolean;
+}
+export interface UiTable {
+    /** Entity set of the rows. */
+    set: string;
+    /** Composition navigation from the object (child tables), undefined for the list report. */
+    navigation?: string;
+    columns: UiField[];
+    actions: UiAction[];
+    insertable: boolean;
+    deletable: boolean;
+    orderby?: string;
+    /** The rows open an object page. */
+    navigable: boolean;
+    /** Entities of a draft BO (D54): changes are sent at once (draft). */
+    draft?: boolean;
+}
+export type UiSection = {
+    id: string;
+    label: string;
+    kind: "form";
+    fields: UiField[];
+} | {
+    id: string;
+    label: string;
+    kind: "table";
+    table: UiTable;
+} | {
+    id: string;
+    label: string;
+    kind: "collection";
+    sections: UiSection[];
+};
+/** A chart (`@UI.chart`, D53): one dimension, measures with their aggregation (`@Aggregation.default`). */
+export interface UiChart {
+    qualifier?: string;
+    title: string;
+    type: "column" | "bar" | "line" | "pie" | "donut";
+    dimension: {
+        property: string;
+        label: string;
+        kind: FieldKind;
+    };
+    measures: Array<{
+        property: string;
+        label: string;
+        aggregation: "sum" | "min" | "max" | "average";
+    }>;
+}
+/** A selection variant (`@UI.selectionVariant`): the tabs of a worklist (D53). */
+export interface UiSelectionVariant {
+    key: string;
+    text: string;
+    /** OData $filter. */
+    filter?: string;
+}
+/** A card of the Overview Page (D53). */
+export interface UiCard {
+    id: string;
+    type: "list" | "table" | "chart" | "kpi";
+    set: string;
+    title: string;
+    subtitle?: string;
+    filter?: string;
+    orderby?: string;
+    top: number;
+    /** list, table: the first columns of the line item; the title field first. */
+    fields: UiField[];
+    chart?: UiChart;
+    kpi?: {
+        property?: string;
+        label: string;
+        aggregation: "sum" | "min" | "max" | "average" | "count";
+        unit?: string;
+    };
+    /** The list report of the set opens from the header of the card. */
+    navigable: boolean;
+}
+export interface UiPage {
+    set: string;
+    /** A draft BO (D54): Edit opens a draft, Save activates it, Cancel discards it. */
+    draft?: {
+        root: boolean;
+        collaborative?: true;
+    };
+    /** The floorplan of the start page of a root entity set (D53). */
+    floorplan: "listReport" | "worklist" | "analyticalListPage" | "formEntry";
+    /** The charts of the entity (`@UI.chart`), for the Analytical List Page and the cards. */
+    charts: UiChart[];
+    selectionVariants: UiSelectionVariant[];
+    entityType: string;
+    typeName: string;
+    typeNamePlural: string;
+    keys: string[];
+    title?: string;
+    description?: string;
+    /** List report of a root entity set. */
+    list?: {
+        table: UiTable;
+        /** Filters shown by default (`@UI.selectionField`). */
+        selectionFields: UiField[];
+        /** Every field the user may filter by ("Adapt Filters"): the selection fields, then the columns. */
+        filterFields: UiField[];
+        searchable: boolean;
+    };
+    sections: UiSection[];
+    /** Object page header actions (identification). */
+    actions: UiAction[];
+    updatable: boolean;
+    deletable: boolean;
+    insertable: boolean;
+    updatableDynamic: boolean;
+    deletableDynamic: boolean;
+    /** Fields of the object page, by property (editability in edit mode). */
+    fields: Record<string, UiField>;
+    /** Header facets: data points and field groups (D57). */
+    headerFacets?: UiHeaderFacet[];
+}
+export interface UiLayout {
+    title: string;
+    servicePath: string;
+    namespace: string;
+    /** Entity set of the start page (list report). */
+    start: string;
+    pages: UiPage[];
+    /** An Overview Page as start page (D53). */
+    overview?: {
+        title: string;
+        cards: UiCard[];
+    };
+}
+export declare function buildUiLayout(model: Model): UiLayout;