@komaci/common-shared 248.1.2 → 248.1.3

package/build/moduleMetadata.d.ts

@@ -1,6 +1,7 @@
 import { FunctionType, KomaciDocument } from '@komaci/types';
 import * as t from '@babel/types';
 import { AdgMetadata, ImportDetail, ImportMetadata, ModuleMetadata, PrimingAdapterDefinition, TemplateImportMetadata, WireFunctionMetadata } from './types';
+import { GQLTag } from '@lwc/metadata/dist/schema/typescript-types/luvio-metadata-types';
 /** not all imports are consumed in a statically analyzable way. when we add their metadata, we use this to ack that the komaciDocImportRef for this import is nil */
 export declare const NO_KOMACI_DOC_REF = "nil";
 /**
@@ -189,4 +190,12 @@ export declare function upliftFakePropsFromTemplate(adg: AdgMetadata): void;
  * @returns true or false;
  */
 export declare function isTemplateImport(importMetadata: ImportMetadata): importMetadata is TemplateImportMetadata;
+/**
+ * Function to initalize the gqlMetadata from the luvioMetadata.
+ * NOTE: To generate the key for the map, we use the location.start and location.end from the luvio metadata
+ * which is equivalent to the start and end field of the templateLiteral of a tagged template expression.
+ * @param gqlTags the gql tags from the luvio metadata
+ * @param moduleMetadata the module metadata object.
+ */
+export declare const initGqlMetadata: (gqlTags: GQLTag[], moduleMetadata: ModuleMetadata) => void;
 //# sourceMappingURL=moduleMetadata.d.ts.map

package/build/moduleMetadata.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTemplateImport = exports.upliftFakePropsFromTemplate = exports.reconcileDefaultAdg = exports.isImportInvalid = exports.reconcilePrimingAdapater = exports.reconcileWireReference = exports.composeWireFunctionMetadata = exports.addTemplateUsageForAdg = exports.mapExportNamesToAdgs = exports.initalizeAdgMetadata = exports.findOtherAlias = exports.collectImportMetadataFromAst = exports.getImportFromNamespace = exports.getImportTemplateKomaciDocByResourceName = exports.updateAliasForImport = exports.addNewImportFromAst = exports.reconcileImport = exports.reconcileNamespace = exports.traverseAstImports = exports.composeImportMetadata = exports.initializeImportMetdataFromKomaciDocument = exports.initAdgMetadataObject = exports.initModuleMetadataObject = exports.NO_KOMACI_DOC_REF = void 0;
+exports.initGqlMetadata = exports.isTemplateImport = exports.upliftFakePropsFromTemplate = exports.reconcileDefaultAdg = exports.isImportInvalid = exports.reconcilePrimingAdapater = exports.reconcileWireReference = exports.composeWireFunctionMetadata = exports.addTemplateUsageForAdg = exports.mapExportNamesToAdgs = exports.initalizeAdgMetadata = exports.findOtherAlias = exports.collectImportMetadataFromAst = exports.getImportFromNamespace = exports.getImportTemplateKomaciDocByResourceName = exports.updateAliasForImport = exports.addNewImportFromAst = exports.reconcileImport = exports.reconcileNamespace = exports.traverseAstImports = exports.composeImportMetadata = exports.initializeImportMetdataFromKomaciDocument = exports.initAdgMetadataObject = exports.initModuleMetadataObject = exports.NO_KOMACI_DOC_REF = void 0;
 const allowlistNamespaces_1 = require("./allowlistNamespaces");
 const komaciDocumentIntrospection_1 = require("./komaciDocumentIntrospection");
 const types_1 = require("./types");
@@ -22,6 +22,7 @@ const initModuleMetadataObject = () => ({
     exports: {},
     templateKomaciDocMap: {},
     staticMetadataId: '',
+    gqlMetadata: new Map(),
 });
 exports.initModuleMetadataObject = initModuleMetadataObject;
 /**
@@ -732,4 +733,31 @@ function isTemplateImport(importMetadata) {
     return temp != undefined;
 }
 exports.isTemplateImport = isTemplateImport;
+/**
+ * Function to initalize the gqlMetadata from the luvioMetadata.
+ * NOTE: To generate the key for the map, we use the location.start and location.end from the luvio metadata
+ * which is equivalent to the start and end field of the templateLiteral of a tagged template expression.
+ * @param gqlTags the gql tags from the luvio metadata
+ * @param moduleMetadata the module metadata object.
+ */
+const initGqlMetadata = (gqlTags, moduleMetadata) => {
+    const sfNamespace = '@salesforce';
+    const gqlNamespace = 'gql';
+    gqlTags.forEach((tag, index) => {
+        const importAlias = `gql${index}`;
+        const importPath = `${sfNamespace}/${gqlNamespace}/${tag.hash}`;
+        const gqlMetadata = {
+            hash: tag.hash,
+            hasExpressions: tag.hasExpressions,
+            location: tag.location,
+            isHoisted: false,
+            valid: false,
+            generatedImportAlias: importAlias,
+            importPath: importPath,
+        };
+        const key = (0, utils_1.generateLocationKey)(tag.location.start, tag.location.end);
+        moduleMetadata.gqlMetadata.set(key, gqlMetadata);
+    });
+};
+exports.initGqlMetadata = initGqlMetadata;
 //# sourceMappingURL=moduleMetadata.js.map

package/build/types.d.ts

@@ -38,6 +38,7 @@ export declare enum IdKeys {
     HOISTED_RENDER_FUNC_ID = "HOISTED_RENDER_FUNC_ID",
     CONDITION_FUNC = "CONDITION_FUNC"
 }
+import { SourceLocation } from '@lwc/metadata/dist/schema/typescript-types/common-metadata-types';
 /**
  * @typedef AstContext is an object that holds meta data information about the ast.
  * @property {string[]} moduleFunctions is a collection of function names that are defined on the module level.
@@ -291,6 +292,7 @@ export declare type ModuleMetadata = {
     staticMetadataId: string;
     includePropsMetadata?: boolean;
     moduleType?: ModuleTypes.BUNDLE_MODULE | ModuleTypes.SCRIPT_ONLY | ModuleTypes.TEMPLATE_ONLY;
+    gqlMetadata: Map<string, GqlMetadata>;
 };
 export declare type ImportBinding = {
     importPath: string;
@@ -346,4 +348,23 @@ export declare type ValidTemplateContext = {
 export declare type Visited<T> = T & {
     visited?: boolean;
 };
+/**
+ * Type for metadata about a gql query
+ */
+export declare type GqlMetadata = {
+    /** Hash generated by LWC */
+    hash: string;
+    /** Boolean to determine if the gql query contains an expression */
+    hasExpressions: boolean;
+    /** Location info for the gql tag */
+    location: SourceLocation;
+    /** Boolean for if the gql tag has been hoisted in the resolvable module */
+    isHoisted: boolean;
+    /** The AST identifier for the generated import ailias */
+    generatedImportAlias: string;
+    /** The import path string */
+    importPath: string;
+    /** if this is a valid template string */
+    valid: boolean;
+};
 //# sourceMappingURL=types.d.ts.map

package/build/utils.d.ts

@@ -1,6 +1,6 @@
 import * as t from '@babel/types';
 import { NodePath } from '@babel/core';
-import { AstContext, ClassPropertyContext, ClassPropertyContexts, ClassPropertyNodes, ImplicitConsumption, ImportMetadata, ModuleMetadata, ValidGetterContext, ValidTemplateContext } from './types';
+import { AstContext, ClassPropertyContext, ClassPropertyContexts, ClassPropertyNodes, GqlMetadata, ImplicitConsumption, ImportMetadata, ModuleMetadata, ValidGetterContext, ValidTemplateContext } from './types';
 import { Adg, FunctionType, KomaciDocument } from '@komaci/types';
 export declare const LIGHTNING_NS = "lightning";
 export declare const FORCE_NS = "force";
@@ -172,4 +172,27 @@ export declare function getComponentId(namespace: string, name: string): string;
  * @param moduleMetadata the module metadata object.
  */
 export declare function setGetterPropertyTypeBeforeProcessing(properties: NodePath<t.ClassMethod>[], adgIndex: number, moduleMetadata: ModuleMetadata): void;
+/**
+ * Helper function to generate a key to retrieve a gql metadata object based on the start and
+ * end field on the TemplateLiteral Object. Luvio metadata privodes a start and end field which
+ * coorelates to the start and end position of a templateLiteral on a taggedTemplate Expression.
+ * @param start the start field which correlates to the index of the starting character on the TemplateLiteral object in a TaggedTemplate which.
+ * @param end the end field which correlatest to the index of the ending character on the TemplateLiteral object in a TaggedTemplate
+ * @returns the key
+ */
+export declare function generateLocationKey(start: number, end: number): string;
+/**
+ * Function to validate gql tagged template expressions.
+ * @param taggedTemplateExpression the tagged template expression to evaluate
+ * @param moduleMetadata the module metadata object
+ * @returns true or false if the gql query is valid
+ */
+export declare function validateTaggedTemplateExpression(taggedTemplateExpression: t.TaggedTemplateExpression, moduleMetadata: ModuleMetadata): boolean;
+/**
+ * Get a Gql Metadata object based on a tagged templates tempalte literal
+ * @param taggedTmplQuasi a tagged templates template literal
+ * @param gqlMetadata the gql metadata map
+ * @returns the Gql Metadata object or undefined.
+ */
+export declare function getGqlMetadataForTaggedTemplate(taggedTmplQuasi: t.TemplateLiteral, gqlMetadata: Map<string, GqlMetadata>): GqlMetadata | undefined;
 //# sourceMappingURL=utils.d.ts.map

package/build/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setGetterPropertyTypeBeforeProcessing = exports.getComponentId = exports.getFilepathSegments = exports.addPropertyFunction = exports.updateKomaciDocumentWithValidTemplatedStrings = exports.updateKomaciDocumentWithValidGetters = exports.isDeclaredInAst = exports.isExpressionThisOrAlias = exports.getThisAliasDeclaredInFunction = exports.isPropertyNodeUsed = exports.isGetterNodeUsed = exports.isPropertyUsed = exports.getClassMethodName = exports.getVariablesDeclaredInFunction = exports.isExternalModule = exports.getAstContextObject = exports.getAllClassMethods = exports.getAllModuleVaraibles = exports.getAllModuleFunctions = exports.getFromIdentifierOrStringLiteral = exports.collectImportUsage = exports.getMemberVarsFromGetter = exports.implicitConsumptionMetadata = exports.getPropertyMetadataFromAst = exports.TEMPLATED_STRING_FUNCTION = exports.GETTER_FUNCTION = exports.ONE_NS = exports.FORCE_NS = exports.LIGHTNING_NS = void 0;
+exports.getGqlMetadataForTaggedTemplate = exports.validateTaggedTemplateExpression = exports.generateLocationKey = exports.setGetterPropertyTypeBeforeProcessing = exports.getComponentId = exports.getFilepathSegments = exports.addPropertyFunction = exports.updateKomaciDocumentWithValidTemplatedStrings = exports.updateKomaciDocumentWithValidGetters = exports.isDeclaredInAst = exports.isExpressionThisOrAlias = exports.getThisAliasDeclaredInFunction = exports.isPropertyNodeUsed = exports.isGetterNodeUsed = exports.isPropertyUsed = exports.getClassMethodName = exports.getVariablesDeclaredInFunction = exports.isExternalModule = exports.getAstContextObject = exports.getAllClassMethods = exports.getAllModuleVaraibles = exports.getAllModuleFunctions = exports.getFromIdentifierOrStringLiteral = exports.collectImportUsage = exports.getMemberVarsFromGetter = exports.implicitConsumptionMetadata = exports.getPropertyMetadataFromAst = exports.TEMPLATED_STRING_FUNCTION = exports.GETTER_FUNCTION = exports.ONE_NS = exports.FORCE_NS = exports.LIGHTNING_NS = void 0;
 const core_1 = require("@babel/core");
 const types_1 = require("./types");
 const allowlistNamespaces_1 = require("./allowlistNamespaces");
@@ -86,6 +86,12 @@ function implicitConsumptionMetadata(node, adgIndex, moduleMetadata) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             moduleMetadata.adgs.get(adgIndex).properties);
         },
+        TaggedTemplateExpression(path) {
+            const taggedTmplExpr = path.node;
+            if (validateTaggedTemplateExpression(taggedTmplExpr, moduleMetadata)) {
+                path.stop();
+            }
+        },
     };
     node.traverse(Visitors);
     return { identifiers: Array.from(identifiers) };
@@ -554,4 +560,50 @@ function setGetterPropertyTypeBeforeProcessing(properties, adgIndex, moduleMetad
     });
 }
 exports.setGetterPropertyTypeBeforeProcessing = setGetterPropertyTypeBeforeProcessing;
+/**
+ * Helper function to generate a key to retrieve a gql metadata object based on the start and
+ * end field on the TemplateLiteral Object. Luvio metadata privodes a start and end field which
+ * coorelates to the start and end position of a templateLiteral on a taggedTemplate Expression.
+ * @param start the start field which correlates to the index of the starting character on the TemplateLiteral object in a TaggedTemplate which.
+ * @param end the end field which correlatest to the index of the ending character on the TemplateLiteral object in a TaggedTemplate
+ * @returns the key
+ */
+function generateLocationKey(start, end) {
+    return `loc_${start}_${end}`;
+}
+exports.generateLocationKey = generateLocationKey;
+/**
+ * Function to validate gql tagged template expressions.
+ * @param taggedTemplateExpression the tagged template expression to evaluate
+ * @param moduleMetadata the module metadata object
+ * @returns true or false if the gql query is valid
+ */
+function validateTaggedTemplateExpression(taggedTemplateExpression, moduleMetadata) {
+    const taggedTmplQuasi = taggedTemplateExpression.quasi;
+    const gqlMetadata = getGqlMetadataForTaggedTemplate(taggedTmplQuasi, moduleMetadata.gqlMetadata);
+    if (gqlMetadata) {
+        if (!gqlMetadata.hasExpressions) {
+            gqlMetadata.valid = true;
+            return true;
+        }
+    }
+    return false;
+}
+exports.validateTaggedTemplateExpression = validateTaggedTemplateExpression;
+/**
+ * Get a Gql Metadata object based on a tagged templates tempalte literal
+ * @param taggedTmplQuasi a tagged templates template literal
+ * @param gqlMetadata the gql metadata map
+ * @returns the Gql Metadata object or undefined.
+ */
+function getGqlMetadataForTaggedTemplate(taggedTmplQuasi, gqlMetadata) {
+    if (taggedTmplQuasi && taggedTmplQuasi.start && taggedTmplQuasi.end) {
+        const start = taggedTmplQuasi.start;
+        const end = taggedTmplQuasi.end;
+        const locationKey = generateLocationKey(start, end);
+        return gqlMetadata.get(locationKey);
+    }
+    return undefined;
+}
+exports.getGqlMetadataForTaggedTemplate = getGqlMetadataForTaggedTemplate;
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@komaci/common-shared",
-    "version": "248.1.2",
+    "version": "248.1.3",
     "description": "Assets that are shared across Komaci commonjs packages",
     "homepage": "https://komaci.dev/",
     "repository": {
@@ -29,7 +29,7 @@
         "build/komaci-mapping.json"
     ],
     "devDependencies": {
-        "@komaci/types": "248.1.2"
+        "@komaci/types": "248.1.3"
     },
     "dependencies": {
         "@babel/core": "^7.9.0",