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

package/esm/index.js

@@ -0,0 +1,110 @@
+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('#');
+    const [owner, name] = repo.split(':')[1].split('/');
+    const [ref, path] = file.split(':');
+    return {
+        owner,
+        name,
+        ref,
+        path,
+    };
+}
+/**
+ * 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 class GithubLoader {
+    async canLoad(pointer) {
+        return this.canLoadSync(pointer);
+    }
+    canLoadSync(pointer) {
+        return typeof pointer === 'string' && pointer.toLowerCase().startsWith('github:');
+    }
+    async load(pointer, options) {
+        if (!(await this.canLoad(pointer))) {
+            return [];
+        }
+        const { owner, name, ref, path } = extractData(pointer);
+        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 });
+    }
+    loadSync(pointer, options) {
+        if (!this.canLoadSync(pointer)) {
+            return [];
+        }
+        const { owner, name, ref, path } = extractData(pointer);
+        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 });
+    }
+    handleResponse({ pointer, path, options, response }) {
+        let errorMessage = null;
+        if (response.errors && response.errors.length > 0) {
+            errorMessage = response.errors.map((item) => item.message).join(', ');
+        }
+        else if (!response.data) {
+            errorMessage = response;
+        }
+        if (errorMessage) {
+            throw new Error('Unable to download schema from github: ' + errorMessage);
+        }
+        const content = response.data.repository.object.text;
+        if (/\.(gql|graphql)s?$/i.test(path)) {
+            return [parseGraphQLSDL(pointer, content, options)];
+        }
+        if (/\.json$/i.test(path)) {
+            return [parseGraphQLJSON(pointer, content, options)];
+        }
+        if (path.endsWith('.tsx') || path.endsWith('.ts') || path.endsWith('.js') || path.endsWith('.jsx')) {
+            const sources = gqlPluckFromCodeStringSync(pointer, content, options.pluckConfig);
+            return sources.map(source => ({
+                location: pointer,
+                document: parse(source, options),
+            }));
+        }
+        throw new Error(`Invalid file extension: ${path}`);
+    }
+    prepareRequest({ owner, ref, path, name, options, }) {
+        return {
+            method: 'POST',
+            headers: {
+                'content-type': 'application/json; charset=utf-8',
+                authorization: `bearer ${options.token}`,
+            },
+            body: JSON.stringify({
+                query: `
+          query GetGraphQLSchemaForGraphQLtools($owner: String!, $name: String!, $expression: String!) {
+            repository(owner: $owner, name: $name) {
+              object(expression: $expression) {
+                ... on Blob {
+                  text
+                }
+              }
+            }
+          }
+        `,
+                variables: {
+                    owner,
+                    name,
+                    expression: ref + ':' + path,
+                },
+                operationName: 'GetGraphQLSchemaForGraphQLtools',
+            }),
+        };
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/github-loader",
-  "version": "7.3.2-alpha-b93d3b57.0",
+  "version": "7.3.4",
   "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;
+}