@graphql-tools/github-loader 7.3.2-alpha-b93d3b57.0 → 7.3.2

package/{cjs → esm}/index.js

@@ -1,12 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GithubLoader = void 0;
-const tslib_1 = require("tslib");
-const utils_1 = require("@graphql-tools/utils");
-const graphql_tag_pluck_1 = require("@graphql-tools/graphql-tag-pluck");
-const graphql_1 = require("graphql");
-const sync_fetch_1 = tslib_1.__importDefault(require("sync-fetch"));
-const fetch_1 = require("@whatwg-node/fetch");
+import { parseGraphQLSDL, parseGraphQLJSON } from '@graphql-tools/utils';
+import { gqlPluckFromCodeStringSync } from '@graphql-tools/graphql-tag-pluck';
+import { parse } from 'graphql';
+import syncFetch from 'sync-fetch';
+import { fetch as asyncFetch } from '@whatwg-node/fetch';
 // github:owner/name#ref:path/to/file
 function extractData(pointer) {
     const [repo, file] = pointer.split('#');
@@ -29,7 +25,7 @@ function extractData(pointer) {
  * })
  * ```
  */
-class GithubLoader {
+export class GithubLoader {
     async canLoad(pointer) {
         return this.canLoadSync(pointer);
     }
@@ -41,7 +37,7 @@ class GithubLoader {
             return [];
         }
         const { owner, name, ref, path } = extractData(pointer);
-        const fetch = options.customFetch || fetch_1.fetch;
+        const fetch = options.customFetch || asyncFetch;
         const request = await fetch('https://api.github.com/graphql', this.prepareRequest({ owner, ref, path, name, options }));
         const response = await request.json();
         return this.handleResponse({ pointer, path, options, response });
@@ -51,7 +47,7 @@ class GithubLoader {
             return [];
         }
         const { owner, name, ref, path } = extractData(pointer);
-        const fetch = options.customFetch || sync_fetch_1.default;
+        const fetch = options.customFetch || syncFetch;
         const request = fetch('https://api.github.com/graphql', this.prepareRequest({ owner, ref, path, name, options }));
         const response = request.json();
         return this.handleResponse({ pointer, path, options, response });
@@ -69,16 +65,16 @@ class GithubLoader {
         }
         const content = response.data.repository.object.text;
         if (/\.(gql|graphql)s?$/i.test(path)) {
-            return [(0, utils_1.parseGraphQLSDL)(pointer, content, options)];
+            return [parseGraphQLSDL(pointer, content, options)];
         }
         if (/\.json$/i.test(path)) {
-            return [(0, utils_1.parseGraphQLJSON)(pointer, content, options)];
+            return [parseGraphQLJSON(pointer, content, options)];
         }
         if (path.endsWith('.tsx') || path.endsWith('.ts') || path.endsWith('.js') || path.endsWith('.jsx')) {
-            const sources = (0, graphql_tag_pluck_1.gqlPluckFromCodeStringSync)(pointer, content, options.pluckConfig);
+            const sources = gqlPluckFromCodeStringSync(pointer, content, options.pluckConfig);
             return sources.map(source => ({
                 location: pointer,
-                document: (0, graphql_1.parse)(source, options),
+                document: parse(source, options),
             }));
         }
         throw new Error(`Invalid file extension: ${path}`);
@@ -112,4 +108,3 @@ class GithubLoader {
         };
     }
 }
-exports.GithubLoader = GithubLoader;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/github-loader",
-  "version": "7.3.2-alpha-b93d3b57.0",
+  "version": "7.3.2",
   "description": "A set of utils for faster development of GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {

package/typings/index.d.ts

@@ -0,0 +1,50 @@
+import { Loader, BaseLoaderOptions, Source } from '@graphql-tools/utils';
+import { GraphQLTagPluckOptions } from '@graphql-tools/graphql-tag-pluck';
+import syncFetch from 'sync-fetch';
+import { fetch as asyncFetch } from '@whatwg-node/fetch';
+/**
+ * Additional options for loading from GitHub
+ */
+export interface GithubLoaderOptions extends BaseLoaderOptions {
+    /**
+     * A GitHub access token
+     */
+    token: string;
+    /**
+     * Additional options to pass to `graphql-tag-pluck`
+     */
+    pluckConfig?: GraphQLTagPluckOptions;
+    customFetch?: typeof asyncFetch | typeof syncFetch;
+}
+/**
+ * This loader loads a file from GitHub.
+ *
+ * ```js
+ * const typeDefs = await loadTypedefs('github:githubUser/githubRepo#branchName:path/to/file.ts', {
+ *   loaders: [new GithubLoader()],
+ *   token: YOUR_GITHUB_TOKEN,
+ * })
+ * ```
+ */
+export declare class GithubLoader implements Loader<GithubLoaderOptions> {
+    canLoad(pointer: string): Promise<boolean>;
+    canLoadSync(pointer: string): boolean;
+    load(pointer: string, options: GithubLoaderOptions): Promise<Source[]>;
+    loadSync(pointer: string, options: GithubLoaderOptions): Source[];
+    handleResponse({ pointer, path, options, response }: {
+        pointer: string;
+        path: string;
+        options: any;
+        response: any;
+    }): Source[] | {
+        location: string | undefined;
+        document: import("graphql").DocumentNode;
+    }[];
+    prepareRequest({ owner, ref, path, name, options, }: {
+        owner: string;
+        ref: string;
+        path: string;
+        name: string;
+        options: GithubLoaderOptions;
+    }): RequestInit;
+}