@salesforce/graphiti 10.10.2

package/dist/lib/variable-promotion.js

@@ -0,0 +1,95 @@
+/**
+ * Copyright (c) 2026, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+import { addVariable } from "./session.js";
+import { inferTypeFromArgsPath } from "../commands/query-helpers.js";
+const VAR_PLACEHOLDER_RE = /^\$([A-Za-z_][\w]*)$/;
+/**
+ * Recursively walks `value` looking for `$varName` string leaves. For
+ * each one, infers the GraphQL type at that input path via
+ * `inferTypeFromArgsPath` and calls `addVariable(session, name, type)`.
+ * Promoted variables strip a trailing `!` (query variables are
+ * nullable by convention; callers requiring NonNull use the `var`
+ * command directly).
+ *
+ * If type inference throws — for example because the input path
+ * doesn't exist on the schema — the helper falls back to `String`
+ * rather than failing the whole render. A wrong-type variable is
+ * easier for a user to debug than a hard error before they see their
+ * query.
+ *
+ * @param session         Session to add variables to.
+ * @param schema          The loaded GraphQL schema.
+ * @param fieldSchemaPath Path of the field whose argument we are
+ *                        promoting against (e.g. `["uiapi", "query",
+ *                        "Account"]`).
+ * @param argName         The argument name (`"where"`, `"orderBy"`,
+ *                        `"scope"`).
+ * @param value           The argument value — can be a primitive,
+ *                        array, or nested object.
+ * @param warnings        Optional warnings sink. Strings starting with
+ *                        `$` that don't form a valid GraphQL Name
+ *                        (e.g. `$1var`, `$foo-bar`) push a warning
+ *                        here so callers see the typo instead of
+ *                        silently rendering the literal.
+ */
+export function promoteVariables(session, schema, fieldSchemaPath, argName, value, warnings) {
+    walk(session, schema, fieldSchemaPath, argName, value, [], warnings);
+}
+function walk(session, schema, fieldSchemaPath, argName, value, pathInsideArg, warnings) {
+    if (typeof value === "string") {
+        const m = VAR_PLACEHOLDER_RE.exec(value);
+        if (!m || !m[1]) {
+            if (value.startsWith("$") && warnings) {
+                const argPath = [argName, ...pathInsideArg].join(".");
+                warnings.push(`Variable: '${value}' at '${argPath}' starts with '$' but is not a valid variable placeholder; rendered as a literal string. Variable names must match /^[A-Za-z_][A-Za-z0-9_]*$/.`);
+            }
+            return;
+        }
+        const varName = m[1];
+        try {
+            const { inferredType } = inferTypeFromArgsPath(schema, session.operation, fieldSchemaPath, [
+                argName,
+                ...pathInsideArg,
+            ]);
+            const declared = inferredType.endsWith("!") ? inferredType.slice(0, -1) : inferredType;
+            addVariable(session, varName, declared);
+        }
+        catch {
+            addVariable(session, varName, "String");
+        }
+        return;
+    }
+    if (Array.isArray(value)) {
+        for (let i = 0; i < value.length; i++) {
+            walk(session, schema, fieldSchemaPath, argName, value[i], [...pathInsideArg, String(i)], warnings);
+        }
+        return;
+    }
+    if (value && typeof value === "object") {
+        for (const [k, v] of Object.entries(value)) {
+            walk(session, schema, fieldSchemaPath, argName, v, [...pathInsideArg, k], warnings);
+        }
+    }
+}
+/**
+ * Collapses an array-shaped orderBy input to its first element, so
+ * callers can pass either shape without knowing Salesforce's
+ * connection-field schema requires a singleton `<Object>_OrderBy`.
+ *
+ * - `[{Name: "ASC"}, ...]`  → `{Name: "ASC"}`
+ * - `[]`                    → `undefined`
+ * - `{Name: "ASC"}`         → unchanged
+ * - `undefined`             → `undefined`
+ */
+export function normalizeOrderBy(orderBy) {
+    if (orderBy === undefined)
+        return undefined;
+    if (Array.isArray(orderBy)) {
+        return orderBy.length > 0 ? orderBy[0] : undefined;
+    }
+    return orderBy;
+}
+//# sourceMappingURL=variable-promotion.js.map

package/dist/lib/variable-promotion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-promotion.js","sourceRoot":"","sources":["../../src/lib/variable-promotion.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAyBH,OAAO,EAAE,WAAW,EAAqB,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,gBAAgB,CAC/B,OAAqB,EACrB,MAAqB,EACrB,eAAyB,EACzB,OAAe,EACf,KAAc,EACd,QAAmB;IAEnB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;AACtE,CAAC;AAED,SAAS,IAAI,CACZ,OAAqB,EACrB,MAAqB,EACrB,eAAyB,EACzB,OAAe,EACf,KAAc,EACd,aAAuB,EACvB,QAA8B;IAE9B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,CAAC,GAAG,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACjB,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,EAAE,CAAC;gBACvC,MAAM,OAAO,GAAG,CAAC,OAAO,EAAE,GAAG,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACtD,QAAQ,CAAC,IAAI,CACZ,cAAc,KAAK,SAAS,OAAO,gJAAgJ,CACnL,CAAC;YACH,CAAC;YACD,OAAO;QACR,CAAC;QACD,MAAM,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,CAAC;YACJ,MAAM,EAAE,YAAY,EAAE,GAAG,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,EAAE,eAAe,EAAE;gBAC1F,OAAO;gBACP,GAAG,aAAa;aAChB,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;YACvF,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzC,CAAC;QAAC,MAAM,CAAC;YACR,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzC,CAAC;QACD,OAAO;IACR,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,IAAI,CACH,OAAO,EACP,MAAM,EACN,eAAe,EACf,OAAO,EACP,KAAK,CAAC,CAAC,CAAC,EACR,CAAC,GAAG,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAC7B,QAAQ,CACR,CAAC;QACH,CAAC;QACD,OAAO;IACR,CAAC;IACD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;YACvE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QACrF,CAAC;IACF,CAAC;AACF,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAI,OAA4B;IAC/D,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACpD,CAAC;IACD,OAAO,OAAO,CAAC;AAChB,CAAC"}

package/dist/lib/walker.d.ts

@@ -0,0 +1,147 @@
+/**
+ * Copyright (c) 2026, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+import { type GraphQLSchema, type GraphQLNamedType, type GraphQLOutputType } from "graphql";
+import { type OperationType } from "./session.js";
+export declare class MutationContextError extends Error {
+    constructor(message: string);
+}
+export declare function getSchema(instanceUrl: string): GraphQLSchema;
+export declare function clearSchemaCache(instanceUrl?: string): void;
+export declare function primeSchemaCache(alias: string, schema: GraphQLSchema): void;
+export interface FieldInfo {
+    name: string;
+    typeName: string;
+    typeKind: TypeInfo["kind"];
+    isNonNull: boolean;
+    isList: boolean;
+    description: string | null;
+    args: ArgInfo[];
+}
+export interface ArgInfo {
+    name: string;
+    typeName: string;
+    typeKind: string;
+    isNonNull: boolean;
+    description: string | null;
+    defaultValue: string | undefined;
+    enumValues?: string[];
+}
+export interface TypeInfo {
+    name: string;
+    kind: "OBJECT" | "INPUT_OBJECT" | "ENUM" | "UNION" | "INTERFACE" | "SCALAR";
+    description: string | null;
+    fields: FieldInfo[];
+    inputFields: InputFieldInfo[];
+    enumValues: EnumValueInfo[];
+    possibleTypes: string[];
+    interfaces: string[];
+}
+export interface InputFieldInfo {
+    name: string;
+    typeName: string;
+    typeKind: string;
+    isNonNull: boolean;
+    description: string | null;
+    defaultValue: string | undefined;
+    enumValues?: string[];
+}
+export interface EnumValueInfo {
+    name: string;
+    description: string | null;
+}
+/**
+ * Returns true for Salesforce Data Cloud (Data Lake Model) objects.
+ * These have names ending in `__dlm` (e.g. `ssot__Account__dlm`).
+ */
+export declare function isDataCloudField(field: FieldInfo): boolean;
+export declare function filterDataCloudFields(fields: FieldInfo[], includeDataCloud: boolean): FieldInfo[];
+export declare function getTypeKind(type: GraphQLNamedType): TypeInfo["kind"];
+export interface WalkerResult {
+    type: GraphQLNamedType;
+    typeName: string;
+    kind: TypeInfo["kind"];
+    fields: FieldInfo[];
+    args: ArgInfo[];
+    possibleTypes: string[];
+    isLeaf: boolean;
+    /** True when inside a mutation result record type where only scalar/value fields are selectable. */
+    inMutationRecord: boolean;
+    /** Relationship fields hidden from selection in mutation results (shown as [query-only] in ls -l). */
+    mutationHiddenFields: FieldInfo[];
+}
+export declare function getRootType(schema: GraphQLSchema, operation: OperationType): GraphQLNamedType;
+export declare function getRootFields(schema: GraphQLSchema, operation: OperationType): FieldInfo[];
+/**
+ * Walks the schema graph along a path and returns what's available at the end.
+ * Handles regular fields, inline fragment segments [TypeName], and resolves
+ * through NonNull/List wrappers.
+ *
+ * Returns the args of the *last* field in the path (not the terminal type's fields' args).
+ */
+export declare function resolvePath(schema: GraphQLSchema, operation: OperationType, pathSegments: string[]): WalkerResult;
+/**
+ * Given a parent path + field name, resolves the field's schema info.
+ * Used to determine whether a field returns an object type (needs sub-selections)
+ * or is a leaf.
+ */
+export declare function resolveFieldOnPath(schema: GraphQLSchema, operation: OperationType, parentPath: string[], fieldName: string): WalkerResult;
+export declare function getFragmentTargets(schema: GraphQLSchema, type: GraphQLNamedType): string[];
+export declare function inspectType(schema: GraphQLSchema, typeName: string): TypeInfo;
+export interface InputWalkerResult {
+    type: GraphQLNamedType;
+    typeName: string;
+    kind: TypeInfo["kind"];
+    inputFields: InputFieldInfo[];
+    enumValues: EnumValueInfo[];
+    isLeaf: boolean;
+    isList: boolean;
+    isNonNull: boolean;
+}
+/**
+ * Walks an INPUT_OBJECT type structure along a path.
+ * Numeric segments index into list types (unwrapping [T] → T).
+ * Returns info about the terminal type: its input fields if navigable,
+ * or isLeaf:true for SCALAR/ENUM.
+ */
+export declare function resolveInputPath(schema: GraphQLSchema, inputTypeName: string, pathSegments: string[]): InputWalkerResult;
+/**
+ * Resolves a single argument by name from a WalkerResult and returns
+ * its type info for navigation into @args/.
+ */
+export declare function resolveArgByName(schema: GraphQLSchema, walkerResult: WalkerResult, argName: string): {
+    typeName: string;
+    isNonNull: boolean;
+    isList: boolean;
+    typeKind: string;
+};
+export declare function getRawFieldType(schema: GraphQLSchema, operation: OperationType, parentPath: string[], fieldName: string): GraphQLOutputType | null;
+export declare function getFieldDescription(schema: GraphQLSchema, operation: OperationType, parentPath: string[], fieldName: string): string | null;
+export interface SearchResult {
+    typeName: string;
+    kind: string;
+    fieldName?: string;
+    fieldType?: string;
+    description?: string | null;
+}
+export interface SearchMatcher {
+    test(input: string): boolean;
+}
+/**
+ * Builds a SearchMatcher from a plain-text search string.
+ *
+ * The pattern is split by whitespace into terms. Each term is
+ * prefix-matched (case-insensitive) against CamelCase word segments
+ * of the field name. "Id" matches "AccountId" but not "Hide".
+ */
+export declare function parseSearchTerms(pattern: string): SearchMatcher;
+/**
+ * Builds a SearchMatcher from a regex pattern string.
+ *
+ * Supports `/pattern/flags` syntax for explicit flags.
+ * Without delimiters, defaults to case-insensitive matching.
+ */
+export declare function parseSearchRegex(pattern: string): SearchMatcher;
+export declare function searchSchema(schema: GraphQLSchema, pattern: string, maxResults?: number): SearchResult[];