@salesforce/lds-adapters-graphql 1.130.9 → 1.131.0-dev9

package/dist/es/es2018/graphql-service.js

@@ -6,7 +6,7 @@
 
 import { StoreKeyMap } from '@luvio/engine';
 import { register } from '@salesforce/lds-default-luvio';
-import { astResolver } from '@luvio/graphql-parser';
+import { Kind, astResolver } from '@luvio/graphql-parser';
 import { graphqlAdapterFactory } from '@salesforce/lds-adapters-uiapi';
 import { createIngestRecordWithFields, keyBuilderRecord } from '@salesforce/lds-adapters-uiapi';
 
@@ -1422,10 +1422,14 @@ function validate(ast, variables) {
 }
 
 let storeEval = undefined;
+let draftFunctions = undefined;
 const configuration = {
     setStoreEval: function (storeEvalArg) {
         storeEval = storeEvalArg;
     },
+    setDraftFunctions: function (draftFuncs) {
+        draftFunctions = draftFuncs;
+    },
 };
 
 const assignedToMe = {
@@ -1511,6 +1515,78 @@ function shouldInjectFields(ast) {
 function injectFieldsGQL(ast) {
     return injectScopeFields(ast);
 }
+function swapIdsOfDocumentNode(documentnode, draftFunctions) {
+    const recordNodes = findRecordSelections(documentnode);
+    recordNodes.forEach((recordConnection) => {
+        swapIdsOfFieldNode(recordConnection, draftFunctions);
+    });
+    return documentnode;
+}
+function swapIdsOfFieldNode(selectionNode, draftFunctions) {
+    if (isCustomFieldNode(selectionNode) &&
+        selectionNode.type === 'Connection' &&
+        selectionNode.arguments !== undefined &&
+        selectionNode.arguments.some((argment) => argment.name === 'where')) {
+        const swappedArguments = selectionNode.arguments.map((argument) => {
+            if (argument.name === 'where') {
+                return {
+                    ...argument,
+                    value: swapIdsOfValueNode(argument.value, draftFunctions.isDraftId, draftFunctions.getCanonicalId),
+                };
+            }
+            else {
+                return argument;
+            }
+        });
+        selectionNode.arguments = swappedArguments;
+    }
+    if (selectionNode.luvioSelections !== undefined) {
+        for (const childSelectionNode of selectionNode.luvioSelections) {
+            if (isCustomFieldNode(childSelectionNode) ||
+                isObjectFieldSelection(childSelectionNode)) {
+                swapIdsOfFieldNode(childSelectionNode, draftFunctions);
+            }
+        }
+    }
+}
+function swapIdsOfValueNode(valueNode, isDraftId, idMapper) {
+    switch (valueNode.kind) {
+        case Kind.OBJECT: {
+            const swappedObjectValueNode = {};
+            for (const key of keys(valueNode.fields)) {
+                swappedObjectValueNode[key] = swapIdsOfValueNode(valueNode.fields[key], isDraftId, idMapper);
+            }
+            return {
+                kind: 'ObjectValue',
+                fields: swappedObjectValueNode,
+            };
+        }
+        case Kind.LIST: {
+            const listValueNodes = [];
+            for (const child of valueNode.values) {
+                listValueNodes.push(swapIdsOfValueNode(child, isDraftId, idMapper));
+            }
+            return {
+                kind: 'ListValue',
+                values: listValueNodes,
+            };
+        }
+        case Kind.STRING: {
+            if (!isDraftId(valueNode.value)) {
+                return valueNode;
+            }
+            return {
+                kind: 'StringValue',
+                value: idMapper(valueNode.value),
+                block: false,
+            };
+        }
+        default:
+            return {
+                ...valueNode,
+            };
+    }
+}
 function injectScopeFields(ast) {
     const modifiedDocumentNode = {
         kind: 'Document',
@@ -2091,6 +2167,34 @@ function buildNetworkSnapshotCachePolicy(context, coercedAdapterRequestContext)
     }
     return buildNetworkSnapshot(luvio, config, fragment, dispatchOptions);
 }
+const replaceDraftIdsInVariables = (variables, draftFunctions) => {
+    const replace = (object) => {
+        if (typeof object === 'string') {
+            if (!draftFunctions.isDraftId(object)) {
+                return object;
+            }
+            return draftFunctions.getCanonicalId(object);
+        }
+        else if (isArray(object)) {
+            return object.map(replace);
+        }
+        else if (typeof object === 'object' && object !== null) {
+            let source = object;
+            return keys(source).reduce((acc, key) => {
+                acc[key] = replace(source[key]);
+                return acc;
+            }, {});
+        }
+        else {
+            return object;
+        }
+    };
+    let newVariables = keys(variables).reduce((acc, key) => {
+        acc[key] = replace(variables[key]);
+        return acc;
+    }, {});
+    return newVariables;
+};
 const graphQLAdapterFactory = (luvio) => {
     const uiApiGraphQLAdapter = graphqlAdapterFactory(luvio);
     function graphql(untrustedConfig, requestContext) {
@@ -2121,19 +2225,33 @@ const graphQLAdapterFactory = (luvio) => {
             const validatedConfigWithInjection = fieldInjectionRequired
                 ? graphqlConfigWithInjectedAST(validatedConfig)
                 : validatedConfig;
-            const fragment = createFragment(luvio, validatedConfigWithInjection.query, variables);
+            const sanitizedConfig = draftFunctions !== undefined
+                ? sanitizeConfig(validatedConfigWithInjection, draftFunctions)
+                : validatedConfigWithInjection;
+            if (sanitizedConfig.variables && draftFunctions !== undefined) {
+                const variablesWithSwappedDraftIds = replaceDraftIdsInVariables(sanitizedConfig.variables, draftFunctions);
+                sanitizedConfig.variables = variablesWithSwappedDraftIds;
+                validatedConfig.variables = variablesWithSwappedDraftIds;
+            }
+            const fragment = createFragment(luvio, sanitizedConfig.query, sanitizedConfig.variables);
             const context = {
-                config: validatedConfigWithInjection,
+                config: sanitizedConfig,
                 fragment,
                 luvio,
             };
+            // NOTE: For evaluating environments, set a context property to let the
+            // environment detect that eval will happen and to check varous gates
+            // for eval behavior customizations.
+            if (storeEval !== undefined) {
+                context.gqlEval = true;
+            }
             const snapshotOrPromiseFromCachePolicy = luvio.applyCachePolicy(requestContext || {}, context, buildCachedSnapshot, buildNetworkSnapshotCachePolicy);
             if (storeEval !== undefined) {
                 const observers = requestContext && requestContext.eventObservers
                     ? requestContext.eventObservers
                     : [];
-                // uses the original ast to do the eval to avoid fields not needed by users
-                return storeEval(validatedConfig, snapshotOrPromiseFromCachePolicy, observers);
+                // uses the original ast to do the eval to avoid fields not needed by users. The draftID swapping happens when filters transform to predicates.
+                return storeEval(validatedConfig, snapshotOrPromiseFromCachePolicy, observers, keyBuilder);
             }
             return snapshotOrPromiseFromCachePolicy;
         }
@@ -2149,7 +2267,16 @@ function graphqlConfigWithInjectedAST(graphqlConfig) {
         query: modifiedAST,
     };
 }
+function sanitizeConfig(graphqlConfig, draftFunctions) {
+    const { query } = graphqlConfig;
+    const astCopy = parse(stringify(query));
+    const modifiedAST = swapIdsOfDocumentNode(astCopy, draftFunctions);
+    return {
+        ...graphqlConfig,
+        query: modifiedAST,
+    };
+}
 // make sure to register the configuration whenever this module loads
 register({ id: '@salesforce/lds-adapters-graphql', configuration });
 
-export { adapterName, buildCachedSnapshot, keyBuilder as connectionKeyBuilder, graphQLAdapterFactory, namespace, representationName };
+export { adapterName, buildCachedSnapshot, keyBuilder as connectionKeyBuilder, graphQLAdapterFactory, graphqlConfigWithInjectedAST, namespace, replaceDraftIdsInVariables, representationName, sanitizeConfig };

package/dist/es/es2018/types/src/configuration.d.ts

@@ -1,7 +1,9 @@
-import type { StoreEval } from '@salesforce/lds-graphql-eval';
+import type { StoreEval, DraftFunctions } from '@salesforce/lds-graphql-eval';
 export declare let storeEval: StoreEval<unknown> | undefined;
+export declare let draftFunctions: DraftFunctions | undefined;
 export declare const configuration: {
     setStoreEval: (storeEvalArg: typeof storeEval) => void;
+    setDraftFunctions: (draftFuncs: typeof draftFunctions) => void;
 };
 export type Registration = {
     id: '@salesforce/lds-adapters-graphql';

package/dist/es/es2018/types/src/main.d.ts

@@ -2,6 +2,9 @@ import type { AdapterFactory, Luvio, ReaderFragment, Snapshot, StoreLookup } fro
 import type { LuvioDocumentNode } from '@luvio/graphql-parser';
 import type { GraphQLVariables } from './type/Variable';
 import type { Registration } from './configuration';
+import type { DraftFunctions } from '@salesforce/lds-graphql-eval';
+import { keyBuilder as connectionKeyBuilder } from './custom/connection';
+export { connectionKeyBuilder };
 export { namespace, representationName } from './util/adapter';
 export declare const adapterName = "graphQL";
 interface GraphQLConfig {
@@ -13,8 +16,11 @@ type BuildSnapshotContext = {
     config: GraphQLConfig;
     fragment: ReaderFragment;
     luvio: Luvio;
+    gqlEval?: boolean;
 };
 export declare function buildCachedSnapshot(context: BuildSnapshotContext, storeLookup: StoreLookup<unknown>): Promise<Snapshot<unknown, unknown>> | Snapshot<unknown, any>;
+export declare const replaceDraftIdsInVariables: (variables: Record<string, any>, draftFunctions: DraftFunctions) => Record<string, any>;
 export declare const graphQLAdapterFactory: AdapterFactory<GraphQLConfig, unknown>;
+export declare function graphqlConfigWithInjectedAST(graphqlConfig: GraphQLConfig): GraphQLConfig;
+export declare function sanitizeConfig(graphqlConfig: GraphQLConfig, draftFunctions: DraftFunctions): GraphQLConfig;
 export type { Registration };
-export { keyBuilder as connectionKeyBuilder } from './custom/connection';

package/dist/es/es2018/types/src/util/synthetic-fields.d.ts

@@ -1,6 +1,9 @@
 import type { LuvioDocumentNode, LuvioSelectionNode, LuvioSelectionObjectFieldNode, LuvioSelectionScalarFieldNode, LuvioSelectionCustomFieldNode, LuvioDefinitionNode, LuvioOperationDefinitionNode } from '@luvio/graphql-parser';
+import type { DraftFunctions } from '@salesforce/lds-graphql-eval';
 export declare function shouldInjectFields(ast: LuvioDocumentNode): boolean;
 export declare function injectFieldsGQL(ast: LuvioDocumentNode): LuvioDocumentNode;
+export declare function swapIdsOfDocumentNode(documentnode: LuvioDocumentNode, draftFunctions: DraftFunctions): LuvioDocumentNode;
+export declare function mergeSelectionNodes(group1: LuvioSelectionNode[], group2: LuvioSelectionNode[]): LuvioSelectionNode[];
 export declare function findRecordSelections(document: LuvioDocumentNode): LuvioSelectionCustomFieldNode[];
 export declare function isOperationDefinition(node: LuvioDefinitionNode): node is LuvioOperationDefinitionNode;
 export declare function isObjectFieldSelection(node: LuvioSelectionNode | undefined): node is LuvioSelectionObjectFieldNode;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-adapters-graphql",
-    "version": "1.130.9",
+    "version": "1.131.0-dev9",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "Wire adapter for GraphQL API endpoint",
     "main": "dist/es/es2018/graphql-service.js",
@@ -37,15 +37,15 @@
         "release:core": "../../scripts/release/core.js --adapter=lds-adapters-graphql"
     },
     "dependencies": {
-        "@luvio/graphql-parser": "0.138.8",
-        "@salesforce/lds-adapters-uiapi": "*",
-        "@salesforce/lds-bindings": "*",
-        "@salesforce/lds-default-luvio": "*"
+        "@luvio/graphql-parser": "0.138.8-244.1",
+        "@salesforce/lds-adapters-uiapi": "1.131.0-244.8",
+        "@salesforce/lds-bindings": "1.131.0-244.8",
+        "@salesforce/lds-default-luvio": "1.131.0-244.8"
     },
     "devDependencies": {
-        "@salesforce/lds-compiler-plugins": "*",
-        "@salesforce/lds-graphql-eval": "*",
-        "@salesforce/lds-jest": "*"
+        "@salesforce/lds-compiler-plugins": "1.131.0-244.8",
+        "@salesforce/lds-graphql-eval": "1.131.0-244.8",
+        "@salesforce/lds-jest": "1.131.0-244.8"
     },
     "nx": {
         "targets": {
@@ -63,9 +63,9 @@
         {
             "path": "./sfdc/index.js",
             "maxSize": {
-                "none": "84 kB",
-                "min": "38.5 kB",
-                "compressed": "12.5 kB"
+                "none": "86 kB",
+                "min": "40 kB",
+                "compressed": "13.5 kB"
             }
         }
     ],

package/sfdc/index.js

@@ -15,7 +15,7 @@
 import { createLDSAdapter, createWireAdapterConstructor, createInstrumentedAdapter, createImperativeAdapter } from 'force/ldsBindings';
 import { register, withDefaultLuvio } from 'force/ldsEngine';
 import { StoreKeyMap } from 'force/luvioEngine';
-import { astResolver } from 'force/ldsGraphqlParser';
+import { Kind, astResolver } from 'force/ldsGraphqlParser';
 import { graphqlAdapterFactory } from 'force/ldsAdaptersUiapiGraphql';
 import { createIngestRecordWithFields, keyBuilderRecord } from 'force/ldsAdaptersUiapi';
 
@@ -1431,10 +1431,14 @@ function validate(ast, variables) {
 }
 
 let storeEval = undefined;
+let draftFunctions = undefined;
 const configuration = {
     setStoreEval: function (storeEvalArg) {
         storeEval = storeEvalArg;
     },
+    setDraftFunctions: function (draftFuncs) {
+        draftFunctions = draftFuncs;
+    },
 };
 
 const assignedToMe = {
@@ -1520,6 +1524,78 @@ function shouldInjectFields(ast) {
 function injectFieldsGQL(ast) {
     return injectScopeFields(ast);
 }
+function swapIdsOfDocumentNode(documentnode, draftFunctions) {
+    const recordNodes = findRecordSelections(documentnode);
+    recordNodes.forEach((recordConnection) => {
+        swapIdsOfFieldNode(recordConnection, draftFunctions);
+    });
+    return documentnode;
+}
+function swapIdsOfFieldNode(selectionNode, draftFunctions) {
+    if (isCustomFieldNode(selectionNode) &&
+        selectionNode.type === 'Connection' &&
+        selectionNode.arguments !== undefined &&
+        selectionNode.arguments.some((argment) => argment.name === 'where')) {
+        const swappedArguments = selectionNode.arguments.map((argument) => {
+            if (argument.name === 'where') {
+                return {
+                    ...argument,
+                    value: swapIdsOfValueNode(argument.value, draftFunctions.isDraftId, draftFunctions.getCanonicalId),
+                };
+            }
+            else {
+                return argument;
+            }
+        });
+        selectionNode.arguments = swappedArguments;
+    }
+    if (selectionNode.luvioSelections !== undefined) {
+        for (const childSelectionNode of selectionNode.luvioSelections) {
+            if (isCustomFieldNode(childSelectionNode) ||
+                isObjectFieldSelection(childSelectionNode)) {
+                swapIdsOfFieldNode(childSelectionNode, draftFunctions);
+            }
+        }
+    }
+}
+function swapIdsOfValueNode(valueNode, isDraftId, idMapper) {
+    switch (valueNode.kind) {
+        case Kind.OBJECT: {
+            const swappedObjectValueNode = {};
+            for (const key of keys(valueNode.fields)) {
+                swappedObjectValueNode[key] = swapIdsOfValueNode(valueNode.fields[key], isDraftId, idMapper);
+            }
+            return {
+                kind: 'ObjectValue',
+                fields: swappedObjectValueNode,
+            };
+        }
+        case Kind.LIST: {
+            const listValueNodes = [];
+            for (const child of valueNode.values) {
+                listValueNodes.push(swapIdsOfValueNode(child, isDraftId, idMapper));
+            }
+            return {
+                kind: 'ListValue',
+                values: listValueNodes,
+            };
+        }
+        case Kind.STRING: {
+            if (!isDraftId(valueNode.value)) {
+                return valueNode;
+            }
+            return {
+                kind: 'StringValue',
+                value: idMapper(valueNode.value),
+                block: false,
+            };
+        }
+        default:
+            return {
+                ...valueNode,
+            };
+    }
+}
 function injectScopeFields(ast) {
     const modifiedDocumentNode = {
         kind: 'Document',
@@ -2100,6 +2176,34 @@ function buildNetworkSnapshotCachePolicy(context, coercedAdapterRequestContext)
     }
     return buildNetworkSnapshot(luvio, config, fragment, dispatchOptions);
 }
+const replaceDraftIdsInVariables = (variables, draftFunctions) => {
+    const replace = (object) => {
+        if (typeof object === 'string') {
+            if (!draftFunctions.isDraftId(object)) {
+                return object;
+            }
+            return draftFunctions.getCanonicalId(object);
+        }
+        else if (isArray(object)) {
+            return object.map(replace);
+        }
+        else if (typeof object === 'object' && object !== null) {
+            let source = object;
+            return keys(source).reduce((acc, key) => {
+                acc[key] = replace(source[key]);
+                return acc;
+            }, {});
+        }
+        else {
+            return object;
+        }
+    };
+    let newVariables = keys(variables).reduce((acc, key) => {
+        acc[key] = replace(variables[key]);
+        return acc;
+    }, {});
+    return newVariables;
+};
 const graphQLAdapterFactory = (luvio) => {
     const uiApiGraphQLAdapter = graphqlAdapterFactory(luvio);
     function graphql(untrustedConfig, requestContext) {
@@ -2130,19 +2234,33 @@ const graphQLAdapterFactory = (luvio) => {
             const validatedConfigWithInjection = fieldInjectionRequired
                 ? graphqlConfigWithInjectedAST(validatedConfig)
                 : validatedConfig;
-            const fragment = createFragment(luvio, validatedConfigWithInjection.query, variables);
+            const sanitizedConfig = draftFunctions !== undefined
+                ? sanitizeConfig(validatedConfigWithInjection, draftFunctions)
+                : validatedConfigWithInjection;
+            if (sanitizedConfig.variables && draftFunctions !== undefined) {
+                const variablesWithSwappedDraftIds = replaceDraftIdsInVariables(sanitizedConfig.variables, draftFunctions);
+                sanitizedConfig.variables = variablesWithSwappedDraftIds;
+                validatedConfig.variables = variablesWithSwappedDraftIds;
+            }
+            const fragment = createFragment(luvio, sanitizedConfig.query, sanitizedConfig.variables);
             const context = {
-                config: validatedConfigWithInjection,
+                config: sanitizedConfig,
                 fragment,
                 luvio,
             };
+            // NOTE: For evaluating environments, set a context property to let the
+            // environment detect that eval will happen and to check varous gates
+            // for eval behavior customizations.
+            if (storeEval !== undefined) {
+                context.gqlEval = true;
+            }
             const snapshotOrPromiseFromCachePolicy = luvio.applyCachePolicy(requestContext || {}, context, buildCachedSnapshot, buildNetworkSnapshotCachePolicy);
             if (storeEval !== undefined) {
                 const observers = requestContext && requestContext.eventObservers
                     ? requestContext.eventObservers
                     : [];
-                // uses the original ast to do the eval to avoid fields not needed by users
-                return storeEval(validatedConfig, snapshotOrPromiseFromCachePolicy, observers);
+                // uses the original ast to do the eval to avoid fields not needed by users. The draftID swapping happens when filters transform to predicates.
+                return storeEval(validatedConfig, snapshotOrPromiseFromCachePolicy, observers, keyBuilder);
             }
             return snapshotOrPromiseFromCachePolicy;
         }
@@ -2158,6 +2276,15 @@ function graphqlConfigWithInjectedAST(graphqlConfig) {
         query: modifiedAST,
     };
 }
+function sanitizeConfig(graphqlConfig, draftFunctions) {
+    const { query } = graphqlConfig;
+    const astCopy = parse(stringify(query));
+    const modifiedAST = swapIdsOfDocumentNode(astCopy, draftFunctions);
+    return {
+        ...graphqlConfig,
+        query: modifiedAST,
+    };
+}
 // make sure to register the configuration whenever this module loads
 register({ id: '@salesforce/lds-adapters-graphql', configuration });
 
@@ -2177,4 +2304,4 @@ withDefaultLuvio((luvio) => {
 });
 
 export { graphQL, graphQLImperative, unstable_graphQL_imperative };
-// version: 1.130.9-a2fbc710a
+// version: 1.131.0-dev9-9940b321d