@memberjunction/core 6.2.0-edge.5 → 6.2.0-edge.7

package/dist/generic/entityValueFieldSecurity.js

@@ -0,0 +1,250 @@
+import { CurrentFieldSecurityGeneration, FieldSecurityError, ReadableFieldsTransportKey } from './entityInfo.js';
+import { RecordChangeFieldSecurityProjector } from './recordChangeFieldSecurity.js';
+/**
+ * Returns `values` without the keys `denied` names, matched case- and whitespace-insensitively.
+ *
+ * `denied` is a denied-field set as {@link EntityInfo.GetDeniedReadFields} builds it: lowercased,
+ * holding both the `Name` and the `CodeName` of every denied field. Because the match is against
+ * the row's OWN keys, a row keyed by either spelling, in any case, is narrowed.
+ *
+ * Returns a shallow COPY when a key was removed and the original object by reference when none
+ * was, so a row that is already narrow costs nothing. The input is never modified, which is what
+ * makes this safe on frozen, shared cache rows.
+ */
+export function OmitDeniedFieldKeys(values, denied) {
+    if (!values || typeof values !== 'object' || !denied || denied.size === 0) {
+        return values;
+    }
+    const source = values;
+    let copy = null;
+    for (const key of Object.keys(source)) {
+        if (!denied.has(key.trim().toLowerCase())) {
+            continue;
+        }
+        copy ??= { ...source };
+        delete copy[key];
+    }
+    return (copy ?? values);
+}
+/**
+ * Returns `values` without the keys `entity`'s own user may not read, for a payload built from
+ * that entity and sent to another tier (a graph save, a companion's wire form).
+ *
+ * The object already holds no denied value (its hydration points and `NewRecord` leave such
+ * fields not loaded), so `GetAll()` normally omits them by itself. This is the backstop for a key
+ * put back on the object without the readability check, which `SetMany` permits: the receiving
+ * tier refuses a restricted caller's input that names a field they may not read, so sending one
+ * fails the whole save.
+ *
+ * Returns the original object when nothing was removed, and a shallow copy otherwise.
+ */
+export function OmitFieldsUnreadableByActiveUser(entity, values) {
+    if (!values || typeof values !== 'object') {
+        return values;
+    }
+    const source = values;
+    let copy = null;
+    for (const key of Object.keys(source)) {
+        if (entity.IsFieldReadableByActiveUser(key)) {
+            continue;
+        }
+        copy ??= { ...source };
+        delete copy[key];
+    }
+    return (copy ?? values);
+}
+/**
+ * The denied-READ set for `user` on `entityInfo`, or null when field security does not apply:
+ * it applies to neither the entity nor an IS-A ancestor, there is no user, or the user is denied nothing.
+ */
+function deniedReadFieldsFor(entityInfo, user) {
+    if (!entityInfo.FieldLevelSecurityApplies) {
+        return null;
+    }
+    const denied = entityInfo.GetDeniedReadFields(user);
+    return denied.size > 0 ? denied : null;
+}
+/** The names of the fields a caller with this denied set may read, for {@link ReadableFieldsTransportKey}. */
+function readableFieldNames(entityInfo, denied) {
+    return entityInfo.Fields
+        .filter((f) => !denied.has(f.Name.trim().toLowerCase()))
+        .map((f) => f.Name);
+}
+/** Field-security narrowing for one row: omission plus the optional readable-fields marker. */
+function narrowRow(row, denied, readable) {
+    const narrowed = OmitDeniedFieldKeys(row, denied);
+    if (!readable) {
+        return narrowed;
+    }
+    const withMarker = narrowed === row
+        ? { ...row }
+        : narrowed;
+    withMarker[ReadableFieldsTransportKey] = readable;
+    return withMarker;
+}
+/**
+ * Projects a plain object of entity field values down to what `user` may READ.
+ *
+ * **The one output projection every transport uses**, so that no transport can apply only half
+ * of it. Three things are applied, matching what the GraphQL resolvers' field mapping does:
+ *
+ * 1. **Denied read fields are omitted**, under both the `Name` and `CodeName` spellings and in any
+ *    case, because callers reach here with rows keyed either way. Omitted rather than nulled:
+ *    a null is indistinguishable from a real value.
+ * 2. **{@link ReadableFieldsTransportKey}** is appended when `includeReadableFields` is set and
+ *    the caller is denied something (see the option).
+ * 3. **The Record Changes payload projection**, which is keyed on the entity each ROW is about
+ *    rather than on the entity being queried. `MJ: Record Changes` normally has field security
+ *    off, so step 1 is a no-op for it, while its payload columns carry other entities' values.
+ *
+ * An entity object built for a restricted user does not hold denied values in the first place,
+ * so on that path this is defence in depth. It is the primary control for values that did not
+ * come from such an object: a system-identity load, a raw provider row, or a cached payload.
+ *
+ * Returns a COPY whenever anything changed, and the original object by reference when nothing
+ * did, so unrestricted callers pay nothing and frozen cache rows are never written to.
+ *
+ * @param provider Metadata source, used to resolve the per-row target entity for Record Changes.
+ * @param entityInfo The entity the values belong to. When absent the values are returned unchanged.
+ * @param values The field values. Never modified.
+ * **Fails open on a missing user.** With no `user` the values are returned unchanged, full width.
+ * That is deliberate: a browser or other single-user client has no per-call user to pass, and
+ * server-internal code running without one is trusted with full values. It also means a
+ * server-side transport that forgets to pass the caller sends everything, so every request-path
+ * caller must pass the requesting user.
+ *
+ * @param user The caller. When absent the values are returned unchanged (see above).
+ * @param options See {@link ProjectEntityValuesOptions}.
+ */
+export function ProjectEntityValuesForUser(provider, entityInfo, values, user, options) {
+    if (!values || typeof values !== 'object' || !entityInfo || !user) {
+        return values;
+    }
+    const projected = ProjectEntityValueRowsForUser(provider, entityInfo, [values], user, options);
+    return projected?.[0] ?? values;
+}
+/**
+ * Array form of {@link ProjectEntityValuesForUser}. The denied set, the readable-fields list and
+ * the Record Changes projector are each built ONCE for the whole set: the projector memoizes its
+ * per-entity lookups for its own lifetime, and a denied set walks every field of the entity, so
+ * building either per row turns a per-request cost into a per-row one.
+ *
+ * Returns the ORIGINAL array when no row needed changing. Fails open on a missing user, as
+ * {@link ProjectEntityValuesForUser} does.
+ */
+export function ProjectEntityValueRowsForUser(provider, entityInfo, rows, user, options) {
+    if (!rows?.length || !entityInfo || !user) {
+        return rows;
+    }
+    const denied = deniedReadFieldsFor(entityInfo, user);
+    const isRecordChanges = RecordChangeFieldSecurityProjector.IsRecordChangesEntity(entityInfo);
+    if (!denied && !isRecordChanges) {
+        return rows;
+    }
+    let projected = rows;
+    if (denied) {
+        const readable = options?.includeReadableFields ? readableFieldNames(entityInfo, denied) : null;
+        projected = rows.map((row) => narrowRow(row, denied, readable));
+    }
+    if (isRecordChanges) {
+        projected = new RecordChangeFieldSecurityProjector(provider, user).ProjectRows(projected);
+    }
+    return projected.some((row, i) => row !== rows[i]) ? projected : rows;
+}
+/**
+ * Keys a transport adds to client input that are not entity fields, and that
+ * {@link AssertClientInputWritableForUser} therefore must not treat as unknown.
+ */
+export const ClientInputTransportKeys = [
+    'OldValues___',
+    ReadableFieldsTransportKey,
+    'RestoreContext___',
+    'CloneContext___',
+    // The companion payload key, spelled out rather than imported: the module that defines it
+    // imports BaseEntity, which imports this module, and this array is built at load time.
+    'Companions___',
+    '__typename',
+];
+/**
+ * The wording for refusing a key in client input. Deliberately the SAME for a key that names a
+ * field the caller cannot read and a key that names no field at all, so the refusal cannot be
+ * used to learn which columns exist.
+ */
+export function FieldSecurityClientInputMessage(key, entityName) {
+    return `Field '${key}' cannot be written on entity '${entityName}'.`;
+}
+/** {@link ClientInputTransportKeys}, lowercased and trimmed, as {@link AssertClientInputWritableForUser} matches them. */
+const NORMALIZED_CLIENT_INPUT_TRANSPORT_KEYS = new Set(ClientInputTransportKeys.map((k) => k.trim().toLowerCase()));
+const knownFieldKeysCache = new WeakMap();
+/** Every key that names a field of `entityInfo` or of an IS-A ancestor, lowercased, by Name and CodeName. */
+function knownFieldKeys(entityInfo) {
+    const fields = entityInfo.Fields;
+    const chain = entityInfo.ParentChain ?? [];
+    const generation = CurrentFieldSecurityGeneration();
+    const memo = knownFieldKeysCache.get(entityInfo);
+    if (memo && memo.fields === fields && memo.chain === chain && memo.generation === generation) {
+        return memo.keys;
+    }
+    const keys = new Set();
+    for (const entity of [entityInfo, ...chain]) {
+        for (const f of entity.Fields) {
+            keys.add(f.Name.trim().toLowerCase());
+            keys.add(f.CodeName.trim().toLowerCase());
+        }
+    }
+    knownFieldKeysCache.set(entityInfo, { fields, chain, generation, keys });
+    return keys;
+}
+/** Whether `normalized` is a transport key, built in or one the caller added. */
+function isAllowedTransportKey(normalized, additional) {
+    return NORMALIZED_CLIENT_INPUT_TRANSPORT_KEYS.has(normalized) || (additional?.has(normalized) ?? false);
+}
+/**
+ * The write-side gate for transports that apply client input with `SetMany`: throws a
+ * {@link FieldSecurityError} when the input carries a key the caller may not send.
+ *
+ * Applies only to a caller who is denied at least one field on the entity. For that caller, a key
+ * is refused when it names a field they cannot READ, or when it names no field at all; both get
+ * the identical {@link FieldSecurityClientInputMessage}. Treating unknown keys the same way is
+ * what keeps the refusal from revealing whether a column exists: refusing only denied keys would
+ * answer "does `Salary` exist?" for any key a caller cares to try.
+ *
+ * Rejection rather than silent removal: a client holding a denied value can only have fabricated
+ * it, because no response it received contained one, so there is no legitimate request to save.
+ *
+ * Keys in {@link ClientInputTransportKeys}, and any in `options.additionalAllowedKeys`, are
+ * accepted. Matching is case- and whitespace-insensitive, by Name and CodeName, like `SetMany`.
+ * Callers who are denied nothing, or input for an entity without field security, are unaffected,
+ * so `SetMany`'s ordinary handling of unknown keys still applies to them.
+ *
+ * @param entityInfo The entity the input will be applied to.
+ * **Fails open on a missing user.** With no `user` the gate does nothing, so server-internal
+ * code, and a client with no per-call user, are unaffected. A server-side transport applying a
+ * request's input must therefore pass the requesting user, or nothing is checked.
+ *
+ * @param values The client input. Never modified.
+ * @param user The caller. When absent the gate does nothing (see above).
+ * @param options See {@link ClientInputGateOptions}.
+ */
+export function AssertClientInputWritableForUser(entityInfo, values, user, options) {
+    if (!values || typeof values !== 'object' || !entityInfo || !user) {
+        return;
+    }
+    const denied = deniedReadFieldsFor(entityInfo, user);
+    if (!denied) {
+        return;
+    }
+    const extra = options?.additionalAllowedKeys;
+    const additional = extra && extra.length > 0 ? new Set(extra.map((k) => k.trim().toLowerCase())) : null;
+    const known = knownFieldKeys(entityInfo);
+    for (const key of Object.keys(values)) {
+        const normalized = key.trim().toLowerCase();
+        if (isAllowedTransportKey(normalized, additional)) {
+            continue;
+        }
+        if (denied.has(normalized) || !known.has(normalized)) {
+            throw new FieldSecurityError(key, entityInfo.Name, FieldSecurityClientInputMessage(key, entityInfo.Name));
+        }
+    }
+}
+//# sourceMappingURL=entityValueFieldSecurity.js.map

package/dist/generic/entityValueFieldSecurity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityValueFieldSecurity.js","sourceRoot":"","sources":["../../src/generic/entityValueFieldSecurity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAA+B,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE3I,OAAO,EAAE,kCAAkC,EAA8B,MAAM,6BAA6B,CAAC;AAoB7G;;;;;;;;;;GAUG;AACH,MAAM,UAAU,mBAAmB,CAAmB,MAAS,EAAE,MAA8C;IAC3G,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACxE,OAAO,MAAM,CAAC;IAClB,CAAC;IACD,MAAM,MAAM,GAAG,MAAiC,CAAC;IACjD,IAAI,IAAI,GAAmC,IAAI,CAAC;IAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YACxC,SAAS;QACb,CAAC;QACD,IAAI,KAAK,EAAE,GAAG,MAAM,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,CAAC,IAAI,IAAI,MAAM,CAAM,CAAC;AACjC,CAAC;AAOD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gCAAgC,CAAmB,MAAkC,EAAE,MAAS;IAC5G,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,MAAM,CAAC;IAClB,CAAC;IACD,MAAM,MAAM,GAAG,MAAiC,CAAC;IACjD,IAAI,IAAI,GAAmC,IAAI,CAAC;IAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,IAAI,MAAM,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1C,SAAS;QACb,CAAC;QACD,IAAI,KAAK,EAAE,GAAG,MAAM,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,CAAC,IAAI,IAAI,MAAM,CAAM,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,UAAsB,EAAE,IAAc;IAC/D,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,MAAM,GAAG,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACpD,OAAO,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3C,CAAC;AAED,8GAA8G;AAC9G,SAAS,kBAAkB,CAAC,UAAsB,EAAE,MAA2B;IAC3E,OAAO,UAAU,CAAC,MAAM;SACnB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;SACvD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED,+FAA+F;AAC/F,SAAS,SAAS,CAAmB,GAAM,EAAE,MAA2B,EAAE,QAAyB;IAC/F,MAAM,QAAQ,GAAG,mBAAmB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAClD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,OAAO,QAAQ,CAAC;IACpB,CAAC;IACD,MAAM,UAAU,GAA4B,QAAQ,KAAK,GAAG;QACxD,CAAC,CAAC,EAAE,GAAI,GAA+B,EAAE;QACzC,CAAC,CAAE,QAAoC,CAAC;IAC5C,UAAU,CAAC,0BAA0B,CAAC,GAAG,QAAQ,CAAC;IAClD,OAAO,UAAe,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,UAAU,0BAA0B,CACtC,QAAoC,EACpC,UAAyC,EACzC,MAA4B,EAC5B,IAAiC,EACjC,OAAoC;IAEpC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,EAAE,CAAC;QAChE,OAAO,MAAM,CAAC;IAClB,CAAC;IACD,MAAM,SAAS,GAAG,6BAA6B,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/F,OAAO,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC;AACpC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,6BAA6B,CACzC,QAAoC,EACpC,UAAyC,EACzC,IAA4B,EAC5B,IAAiC,EACjC,OAAoC;IAEpC,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,MAAM,GAAG,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,kCAAkC,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAC7F,IAAI,CAAC,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,SAAS,GAAQ,IAAI,CAAC;IAC1B,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,QAAQ,GAAG,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAChG,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,eAAe,EAAE,CAAC;QAClB,SAAS,GAAG,IAAI,kCAAkC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAC9F,CAAC;IACD,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;AAC1E,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAsB;IACvD,cAAc;IACd,0BAA0B;IAC1B,mBAAmB;IACnB,iBAAiB;IACjB,0FAA0F;IAC1F,uFAAuF;IACvF,eAAe;IACf,YAAY;CACf,CAAC;AAQF;;;;GAIG;AACH,MAAM,UAAU,+BAA+B,CAAC,GAAW,EAAE,UAAkB;IAC3E,OAAO,UAAU,GAAG,kCAAkC,UAAU,IAAI,CAAC;AACzE,CAAC;AAED,0HAA0H;AAC1H,MAAM,sCAAsC,GAAwB,IAAI,GAAG,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;AAczI,MAAM,mBAAmB,GAAG,IAAI,OAAO,EAAkC,CAAC;AAE1E,6GAA6G;AAC7G,SAAS,cAAc,CAAC,UAAsB;IAC1C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;IACjC,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,IAAI,EAAE,CAAC;IAC3C,MAAM,UAAU,GAAG,8BAA8B,EAAE,CAAC;IACpD,MAAM,IAAI,GAAG,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACjD,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;QAC3F,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,MAAM,IAAI,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC;QAC1C,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YACtC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IACD,mBAAmB,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,iFAAiF;AACjF,SAAS,qBAAqB,CAAC,UAAkB,EAAE,UAAsC;IACrF,OAAO,sCAAsC,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,CAAC;AAC5G,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,gCAAgC,CAC5C,UAAyC,EACzC,MAAkD,EAClD,IAAiC,EACjC,OAAgC;IAEhC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,EAAE,CAAC;QAChE,OAAO;IACX,CAAC;IACD,MAAM,MAAM,GAAG,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,OAAO;IACX,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,EAAE,qBAAqB,CAAC;IAC7C,MAAM,UAAU,GAAG,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxG,MAAM,KAAK,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IACzC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC5C,IAAI,qBAAqB,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,CAAC;YAChD,SAAS;QACb,CAAC;QACD,IAAI,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,kBAAkB,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE,+BAA+B,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9G,CAAC;IACL,CAAC;AACL,CAAC"}

package/dist/generic/externalDataSourceReadRouter.d.ts

@@ -50,6 +50,16 @@ export declare abstract class ExternalDataSourceReadRouter {
      * source, so this is cheap to call on the read hot path.
      */
     abstract GetCacheTTLSeconds(externalDataSourceID: string, contextUser?: UserInfo, provider?: IMetadataProvider): Promise<number>;
+    /**
+     * The key of the SQL dialect an external data source speaks (as `@memberjunction/sql-dialect`
+     * registers it: `'mysql'`, `'snowflake'`, `'databricks'`, …), so a query on that source renders
+     * its template values with the source's own literal rules. Null for a source with no SQL
+     * dialect (a document store) or when the router cannot tell; the query then renders with the
+     * calling provider's platform.
+     *
+     * The base implementation returns null; the External Data Sources engine overrides it.
+     */
+    GetQueryDialectKey(_externalDataSourceID: string, _contextUser?: UserInfo, _provider?: IMetadataProvider): Promise<string | null>;
     /**
      * Introspect the schema of an external data source (its tables/views/collections and their
      * columns), delegating to the resolved driver's `IntrospectSchema`. Used by CodeGen to

package/dist/generic/externalDataSourceReadRouter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"externalDataSourceReadRouter.d.ts","sourceRoot":"","sources":["../../src/generic/externalDataSourceReadRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAErE;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,4BAA4B;IAChD,oFAAoF;aACpE,eAAe,CAAC,CAAC,GAAG,OAAO,EACzC,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,aAAa,EACrB,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE5B;;;;;;;OAOG;aACa,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAC5C,MAAM,EAAE,UAAU,EAClB,YAAY,EAAE,YAAY,EAC1B,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE5B;;;;;OAKG;aACa,gBAAgB,CAC9B,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,cAAc,EACtB,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,cAAc,CAAC;IAE1B;;;;;;;;OAQG;aACa,kBAAkB,CAChC,oBAAoB,EAAE,MAAM,EAC5B,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,MAAM,CAAC;IAElB;;;;;;;OAOG;aACa,wBAAwB,CACtC,oBAAoB,EAAE,MAAM,EAC5B,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,wBAAwB,CAAC;CACrC"}
+{"version":3,"file":"externalDataSourceReadRouter.d.ts","sourceRoot":"","sources":["../../src/generic/externalDataSourceReadRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAErE;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,4BAA4B;IAChD,oFAAoF;aACpE,eAAe,CAAC,CAAC,GAAG,OAAO,EACzC,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,aAAa,EACrB,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE5B;;;;;;;OAOG;aACa,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAC5C,MAAM,EAAE,UAAU,EAClB,YAAY,EAAE,YAAY,EAC1B,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE5B;;;;;OAKG;aACa,gBAAgB,CAC9B,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,cAAc,EACtB,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,cAAc,CAAC;IAE1B;;;;;;;;OAQG;aACa,kBAAkB,CAChC,oBAAoB,EAAE,MAAM,EAC5B,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACU,kBAAkB,CAC7B,qBAAqB,EAAE,MAAM,EAC7B,YAAY,CAAC,EAAE,QAAQ,EACvB,SAAS,CAAC,EAAE,iBAAiB,GAC5B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAIzB;;;;;;;OAOG;aACa,wBAAwB,CACtC,oBAAoB,EAAE,MAAM,EAC5B,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,wBAAwB,CAAC;CACrC"}

package/dist/generic/externalDataSourceReadRouter.js

@@ -15,5 +15,17 @@
  * clear error rather than fall through to MJ-DB SQL generation.
  */
 export class ExternalDataSourceReadRouter {
+    /**
+     * The key of the SQL dialect an external data source speaks (as `@memberjunction/sql-dialect`
+     * registers it: `'mysql'`, `'snowflake'`, `'databricks'`, …), so a query on that source renders
+     * its template values with the source's own literal rules. Null for a source with no SQL
+     * dialect (a document store) or when the router cannot tell; the query then renders with the
+     * calling provider's platform.
+     *
+     * The base implementation returns null; the External Data Sources engine overrides it.
+     */
+    async GetQueryDialectKey(_externalDataSourceID, _contextUser, _provider) {
+        return null;
+    }
 }
 //# sourceMappingURL=externalDataSourceReadRouter.js.map

package/dist/generic/externalDataSourceReadRouter.js.map

@@ -1 +1 @@
-{"version":3,"file":"externalDataSourceReadRouter.js","sourceRoot":"","sources":["../../src/generic/externalDataSourceReadRouter.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAgB,4BAA4B;CAqEjD"}
+{"version":3,"file":"externalDataSourceReadRouter.js","sourceRoot":"","sources":["../../src/generic/externalDataSourceReadRouter.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAgB,4BAA4B;IAuDhD;;;;;;;;OAQG;IACI,KAAK,CAAC,kBAAkB,CAC7B,qBAA6B,EAC7B,YAAuB,EACvB,SAA6B;QAE7B,OAAO,IAAI,CAAC;IACd,CAAC;CAgBF"}