@xyd-js/gql 0.1.0-xyd.9 → 0.1.0-xyd.96

package/__tests__/gqlSchemaToReferences.test.ts

@@ -0,0 +1,109 @@
+import {describe, expect, it} from 'vitest'
+
+import {testGqlSchemaToReferences} from "./utils";
+
+const tests: {
+    name: string;
+    description: string;
+    options?: {
+        flat?: boolean;
+    };
+}[] = [
+    {
+        name: "1.basic",
+        description: "A basic example",
+    },
+    {
+        name: "2.circular",
+        description: "A circular dependency reference example",
+    },
+    {
+        name: "3.opendocs",
+        description: "An opendocs directive example",
+    },
+    {
+        name: "4.union",
+        description: "An opendocs directive example",
+    },
+    {
+        name: "5.flat",
+        description: "Flat generation only via code options",
+        options: {
+            flat: true
+        }
+    },
+    {
+        name: "6.default-values",
+        description: "Default values example",
+    },
+    {
+        name: "7.type-args",
+        description: "Type args",
+    },
+    {
+        name: "8.default-sort",
+        description: "Default sort example",
+    },
+    //
+    {
+        name: "-1.opendocs.flat",
+        description: "OpenDocs GraphQL Schema directive example with flat generation",
+    },
+    {
+        name: "-1.opendocs.sort",
+        description: "OpenDocs GraphQL Schema directive example with sort generation",
+    },
+    {
+        name: "-1.opendocs.sort+group",
+        description: "OpenDocs GraphQL Schema directive example with group sort generation",
+    },
+    {
+        name: "-1.opendocs.sort+group+path",
+        description: "OpenDocs GraphQL Schema directive example with group + path sort generation",
+    },
+    {
+        name: "-1.opendocs.scopes",
+        description: "OpenDocs GraphQL Schema directive example with scopes generation",
+    },
+    {
+        name: "-1.opendocs.docs-nested",
+        description: "OpenDocs GraphQL Schema directive example with nested docs",
+    },
+    // //
+    // {
+    //     name: "-3.array-non-null-return",
+    //     description: "case: Array non-null return",
+    //     options: {
+    //         flat: true
+    //     }
+    // },
+
+    // TODO: uncomment when ready
+    // {
+    //     name: "-2.complex.monday",
+    //     description: "Monday.com GraphQL API example",
+    //     options: {
+    //         flat: true
+    //     }
+    // },
+    // {
+    //     name: "-2.complex.github",
+    //     description: "Github GraphQL API example",
+    //     // TODO: Github API is very, very huge. Currently. xyd does not support such big schemas well so we need to flat all types.
+    //     options: {
+    //         flat: true
+    //     }
+    // }
+    // {
+    //     name: "-2.complex.livesession",
+    //     description: "LiveSession GraphQL API example"
+    // }
+]
+
+describe("gqlSchemaToReferences", () => {
+    tests.forEach((test) => {
+        it(`[${test.name}]: ${test.description}`, async () => {
+            await testGqlSchemaToReferences(test.name, test.options);
+        });
+    });
+});

package/__tests__/utils.ts

@@ -0,0 +1,45 @@
+import path from "node:path";
+import fs from "node:fs";
+import { fileURLToPath } from "node:url";
+
+import {expect} from "vitest";
+
+import {gqlSchemaToReferences} from "../src";
+import {GQLSchemaToReferencesOptions} from "../src/types";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Helper function to run a test with a specific fixture
+export async function testGqlSchemaToReferences(fixtureName: string, options?: GQLSchemaToReferencesOptions) {
+    const schemaLocation = fullFixturePath(`${fixtureName}/input.graphql`)
+    const result = await gqlSchemaToReferences(schemaLocation, options);
+    // saveResultAsOutput(fixtureName, result)
+    const expectedOutput = readFixtureOutput(`${fixtureName}/output.json`);
+
+    try {
+        expect(result).toEqual(expectedOutput);
+    } catch (error) {
+        if (result?.length > 100) {
+            throw new Error(`FAILED: The diff result is too long (${result.length} items) to show.`);
+        }
+        throw error;
+    }
+}
+
+// Helper function to read fixture output
+function readFixtureOutput(name: string) {
+    const fixturePath = fullFixturePath(name);
+    return JSON.parse(fs.readFileSync(fixturePath, "utf8"));
+}
+
+function fullFixturePath(name: string) {
+    return path.join(__dirname, "../__fixtures__", name);
+}
+
+function saveResultAsOutput(fixtureName: string, result: any) {
+    fs.writeFileSync(fullFixturePath(fixtureName + "/output.json"), JSON.stringify(result, null, 2));
+}
+
+export function getFixturePath(name: string): string {
+    return path.join(__dirname, "../__fixtures__", name);
+}

package/declarations.d.ts

@@ -0,0 +1,4 @@
+declare module '*.graphql' {
+    const content: string;
+    export default content;
+} 

package/dist/index.d.ts

@@ -1,5 +1,21 @@
 import { Reference } from '@xyd-js/uniform';
 
-declare function gqlSchemaToReferences(schemaLocation: string): Promise<Reference[]>;
+interface SortItem {
+    node?: string;
+    group?: string[];
+    stack?: number;
+}
+interface OpenDocsSortConfig {
+    sortStack?: string[][];
+    sort?: SortItem[];
+}
+interface GQLSchemaToReferencesOptions {
+    regions?: string[];
+    flat?: boolean;
+    sort?: OpenDocsSortConfig;
+    route?: string;
+}
+
+declare function gqlSchemaToReferences(schemaLocation: string | string[], options?: GQLSchemaToReferencesOptions): Promise<Reference[]>;
 
 export { gqlSchemaToReferences };