@open-rap/runtime 0.0.0-stage → 0.1.0

package/dist/odata/json.js

@@ -0,0 +1,85 @@
+/** OData V4 JSON (odata.metadata=minimal): entities, collections, ETags, IEEE754Compatible. */
+import { ENTITY_CONTROL, FIELD_CONTROL, OPERATION_CONTROL } from "@open-rap/model";
+import { RawJsonNumber, toJson } from "../values.js";
+/** JSON.stringify that writes RawJsonNumber verbatim. */
+export function stringify(value) {
+    if (value instanceof RawJsonNumber) {
+        return value.text;
+    }
+    if (value === null || typeof value !== "object") {
+        return JSON.stringify(value);
+    }
+    if (Array.isArray(value)) {
+        return `[${value.map(stringify).join(",")}]`;
+    }
+    return `{${Object.entries(value)
+        .filter(([, v]) => v !== undefined)
+        .map(([k, v]) => `${JSON.stringify(k)}:${stringify(v)}`)
+        .join(",")}}`;
+}
+/** Hidden member of the rows of an `etag dependent` entity: the ETag field of its master (D32). */
+export const DEPENDENT_ETAG = "__etag";
+/** The ETag of a row: its ETag field, or the one of its master (`etag dependent by`). */
+export function etagOf(info, row) {
+    const name = info.type.etag ?? (info.type.etagPath === undefined ? undefined : DEPENDENT_ETAG);
+    if (name === undefined) {
+        return undefined;
+    }
+    return etagValue(row[name]);
+}
+/** The weak ETag of a value of an ETag field. */
+export function etagValue(value) {
+    return `W/"${value === null || value === undefined ? "0" : String(value)}"`;
+}
+export class JsonWriter {
+    service;
+    read;
+    constructor(service, read) {
+        this.service = service;
+        this.read = read;
+    }
+    entity(info, row, options, ctx) {
+        const result = {};
+        const etag = etagOf(info, row);
+        if (etag !== undefined) {
+            result["@odata.etag"] = etag;
+        }
+        for (const name of this.read.selectedProperties(info, options)) {
+            const { property } = this.service.property(info, name);
+            result[name] = toJson(property.edm, (row[name] ?? null), ctx.ieee754);
+        }
+        for (const control of [ENTITY_CONTROL, OPERATION_CONTROL, FIELD_CONTROL]) {
+            const value = row[control];
+            if (value !== undefined && isSelected(options, control)) {
+                result[control] = value;
+            }
+        }
+        for (const item of options.expand ?? []) {
+            const names = item.path[0] === "*" ? [...info.navigations.keys()] : [item.path[0]];
+            for (const name of names) {
+                const { navigation, target } = this.service.navigationTarget(info, name);
+                const value = row[name];
+                const nested = item.path[0] === "*" ? {} : item.options;
+                if (navigation.collection) {
+                    const count = row[`${name}@odata.count`];
+                    if (typeof count === "number") {
+                        result[`${name}@odata.count`] = count;
+                    }
+                    result[name] = Array.isArray(value) ? value.map((r) => this.entity(target, r, nested, ctx)) : [];
+                }
+                else {
+                    result[name] = value === null || value === undefined || Array.isArray(value) || typeof value !== "object" ? null : this.entity(target, value, nested, ctx);
+                }
+            }
+        }
+        return result;
+    }
+    contextUrl(info, options, single) {
+        const select = options.select !== undefined && !options.select.some((p) => p[0] === "*") ? `(${this.read.selectedProperties(info, options).join(",")})` : "";
+        return `$metadata#${info.set.name}${select}${single ? "/$entity" : ""}`;
+    }
+}
+function isSelected(options, name) {
+    return options.select === undefined || options.select.some((p) => p[0] === "*" || p[0] === name);
+}
+//# sourceMappingURL=json.js.map

package/dist/odata/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../src/odata/json.ts"],"names":[],"mappings":"AAAA,+FAA+F;AAE/F,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,aAAa,EAAE,MAAM,EAAuC,MAAM,cAAc,CAAC;AAK1F,yDAAyD;AACzD,MAAM,UAAU,SAAS,CAAC,KAAgB;IACxC,IAAI,KAAK,YAAY,aAAa,EAAE,CAAC;QACnC,OAAO,KAAK,CAAC,IAAI,CAAC;IACpB,CAAC;IACD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAC/C,CAAC;IACD,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;SAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;SAClC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;SACvD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AAClB,CAAC;AAED,mGAAmG;AACnG,MAAM,CAAC,MAAM,cAAc,GAAG,QAAQ,CAAC;AAEvC,yFAAyF;AACzF,MAAM,UAAU,MAAM,CAAC,IAAc,EAAE,GAAQ;IAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;IAC/F,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9B,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,MAAM,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;AAC9E,CAAC;AAMD,MAAM,OAAO,UAAU;IAEF,OAAO;IACP,IAAI;IAFvB,YACmB,OAAuB,EACvB,IAAgB;uBADhB,OAAO;oBACP,IAAI;IACpB,CAAC;IAEG,MAAM,CAAC,IAAc,EAAE,GAAQ,EAAE,OAAqB,EAAE,GAAgB;QAC7E,MAAM,MAAM,GAA8B,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;QAC/B,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YAC/D,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACvD,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAmB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1F,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,CAAC,cAAc,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,CAAC;YACzE,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;YAC3B,IAAI,KAAK,KAAK,SAAS,IAAI,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;gBACxD,MAAM,CAAC,OAAO,CAAC,GAAG,KAA6B,CAAC;YAClD,CAAC;QACH,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC,CAAC;YAC7F,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACzE,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;gBACxB,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;gBACxD,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;oBAC1B,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,IAAI,cAAc,CAAC,CAAC;oBACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;wBAC9B,MAAM,CAAC,GAAG,IAAI,cAAc,CAAC,GAAG,KAAK,CAAC;oBACxC,CAAC;oBACD,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnG,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;gBAC7J,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,UAAU,CAAC,IAAc,EAAE,OAAqB,EAAE,MAAe;QACtE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7J,OAAO,aAAa,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAC1E,CAAC;CACF;AAED,SAAS,UAAU,CAAC,OAAqB,EAAE,IAAY;IACrD,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;AACnG,CAAC"}

package/dist/odata/read.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Reads: OData query options → parameterized SQL on the views of the CDS entities (decision D4).
+ * Identifiers come from the model (white list), values are bound parameters.
+ */
+import { type RawBuilder } from "kysely";
+import type { Database } from "../db/database.js";
+import { type CanonicalValue } from "../values.js";
+import type { CustomQueries } from "./custom.js";
+import { type AccessControls } from "./access.js";
+import type { Key, ServiceRuntime, TypeInfo } from "./service.js";
+import type { Expr, QueryOptions } from "./uri/ast.js";
+export type Row = {
+    [property: string]: CanonicalValue | Row | Row[] | number | undefined;
+};
+/** Rows read for one level, with the counts of expanded collections. */
+export interface ReadResult {
+    rows: Row[];
+    count?: number;
+}
+export declare class ReadEngine {
+    private readonly service;
+    private readonly db;
+    /** The access controls (DCL) of the entities, for the user of the request (D35). */
+    private readonly access?;
+    /** The query classes of the custom entities (D43), when the application has a RAP runtime. */
+    queries?: CustomQueries;
+    /** Scopes on custom entities: the SQL placeholder stands for a condition given to the query class. */
+    private readonly customScopes;
+    constructor(service: ServiceRuntime, db: () => Database, 
+    /** The access controls (DCL) of the entities, for the user of the request (D35). */
+    access?: AccessControls | undefined);
+    private customScope;
+    private customQueries;
+    /** Equalities on properties, as a condition on the elements of the custom entity. */
+    private equalities;
+    private scopeConditions;
+    private customCollection;
+    private customExpand;
+    private column;
+    private operand;
+    /** A literal bound to the type of the other side of a comparison. */
+    private bind;
+    private stringArgument;
+    private likePattern;
+    private call;
+    condition(info: TypeInfo, alias: string, expr: Expr): RawBuilder<unknown>;
+    /** `$search`: every term must be found in one of the search fields (case-insensitive). */
+    private search;
+    /** The condition of the access controls of the entity for the user of the request, if any. */
+    private accessCondition;
+    private where;
+    private orderBy;
+    /** Properties to read: the selected ones, the keys, the ETag and the fields joins need. */
+    selectedProperties(info: TypeInfo, options: QueryOptions, needed?: string[]): string[];
+    private rowFrom;
+    /**
+     * The ETag of an `etag dependent` entity (D32): the ETag field of the master instance, read by
+     * scalar sub-queries along the to-one navigations of the path.
+     */
+    private dependentEtag;
+    /** The columns of a query: the properties, and the ETag of an `etag dependent` entity. */
+    private columns;
+    /** Conditions selecting one instance on the alias t0. */
+    keyConditions(info: TypeInfo, key: Key): RawBuilder<unknown>[];
+    private keyCondition;
+    /** Reads a collection of an entity set, optionally restricted to the targets of a navigation. */
+    readCollection(info: TypeInfo, options: QueryOptions, scope?: RawBuilder<unknown>[], withCount?: boolean): Promise<ReadResult>;
+    /**
+     * `$apply` (D52): the groups of the dimensions with their aggregates, after the filters of
+     * `$apply` and `$filter` (on the instances), with the access controls; `$orderby` on the
+     * dimensions and the aliases, `$top`, `$skip`, `$count` (number of groups).
+     */
+    readAggregated(info: TypeInfo, options: QueryOptions, scope?: RawBuilder<unknown>[]): Promise<{
+        rows: Array<Record<string, CanonicalValue | number>>;
+        count?: number;
+        properties: string[];
+        aliases: string[];
+    }>;
+    count(info: TypeInfo, options: QueryOptions, scope?: RawBuilder<unknown>[]): Promise<number>;
+    readOne(info: TypeInfo, key: Key, options: QueryOptions): Promise<Row | undefined>;
+    /** Scope of a navigation from a source instance: conditions on the target alias t0. */
+    navigationScope(source: TypeInfo, key: Key, navigation: string): Promise<{
+        target: TypeInfo;
+        scope: RawBuilder<unknown>[];
+        collection: boolean;
+    } | undefined>;
+    private neededForExpand;
+    /** $expand, one level: one query per navigation for all the rows of the page. */
+    private expand;
+}