Adding support for module import paths

.changeset/violet-cows-impress.md

@@ -0,0 +1,5 @@
+---
+'@graphql-tools/import': minor
+---
+
+Minor bump to support import installed modules

jest.config.js

@@ -8,13 +8,19 @@ const tsconfig = require(TSCONFIG);
 
 const ESM_PACKAGES = ['graphql', 'graphql-upload', 'fs-capacitor'];
 
+const moduleNameMap = {
+  //This line is to enable testing import with require.resolve, which would normally get intercepted
+  '^@graphql-tools/import/(.*).graphql$': `${ROOT_DIR}/packages/import/$1.graphql`,
+  ...pathsToModuleNameMapper(tsconfig.compilerOptions.paths, { prefix: `${ROOT_DIR}/` }),
+};
+
 module.exports = {
   testEnvironment: 'node',
   rootDir: ROOT_DIR,
   restoreMocks: true,
   reporters: ['default'],
   modulePathIgnorePatterns: ['dist', 'test-assets', 'test-files', 'fixtures', '.bob'],
-  moduleNameMapper: pathsToModuleNameMapper(tsconfig.compilerOptions.paths, { prefix: `${ROOT_DIR}/` }),
+  moduleNameMapper: moduleNameMap,
   collectCoverage: false,
   cacheDirectory: resolve(ROOT_DIR, `${CI ? '' : 'node_modules/'}.cache/jest`),
   transform: {

packages/import/src/index.ts

@@ -93,12 +93,24 @@ export function processImport(
       };
 }
 
+function isRequirePath(filePath: string): boolean {
+  return filePath.startsWith('require:');
+}
+
+function resolveRequirePath(filePath: string): string {
+  return require.resolve(filePath.slice(8));
+}
+
 function visitFile(
   filePath: string,
   cwd: string,
   visitedFiles: VisitedFilesMap,
   predefinedImports: Record<string, string>
 ): Map<string, Set<DefinitionNode>> {
+  // Support paths to npm modules
+  if (isRequirePath(filePath)) {
+    filePath = resolveRequirePath(filePath);
+  }
   if (!isAbsolute(filePath) && !(filePath in predefinedImports)) {
     filePath = resolveFilePath(cwd, filePath);
   }

packages/import/tests/schema/fixtures/require-paths/a.graphql

@@ -0,0 +1,3 @@
+type A {
+  field: String
+}

packages/import/tests/schema/fixtures/require-paths/b.graphql

@@ -0,0 +1,5 @@
+# import A from "require:@graphql-tools/import/tests/schema/fixtures/require-paths/a.graphql"
+
+type B {
+  a: A
+}

packages/import/tests/schema/import-schema.spec.ts

@@ -650,6 +650,20 @@ describe('importSchema', () => {
     expect(actualSDL).toBeSimilarGqlDoc(expectedSDL);
   });
 
+  test('require paths', () => {
+    const expectedSDL = /* GraphQL */ `
+      type A {
+        field: String
+      }
+
+      type B {
+        a: A
+      }
+    `;
+    const actualSDL = importSchema('./fixtures/require-paths/b.graphql');
+    expect(actualSDL).toBeSimilarGqlDoc(expectedSDL);
+  });
+
   test('root field imports', () => {
     const expectedSDL = /* GraphQL */ `
       type Query {

website/docs/schema-loading.mdx

@@ -139,6 +139,14 @@ type Comment {
 }
 ```
 
+Import also supports paths to installed modules. Example:
+
+```graphql
+# import Post, Comment from "require:blog-graphql-types/schema.graphql
+```
+
+Note: this functionality resolves using `require.resolve` on matching paths.
+
 ### Binding to HTTP Server
 
 You can extend loaded schema with resolvers