Set up defaultScalarType tests

Author: eddeee888

packages/plugins/typescript/operations/tests/ts-documents.standalone.default-scalar-types.spec.ts

@@ -0,0 +1,169 @@
+import { mergeOutputs } from '@graphql-codegen/plugin-helpers';
+import { validateTs } from '@graphql-codegen/testing';
+import { buildSchema, parse } from 'graphql';
+import { plugin } from '../src/index.js';
+
+describe('TypeScript Operations Plugin - Default Scalar types', () => {
+  it('generates `unknown` as the default custom defaultScalarType', async () => {
+    const schema = buildSchema(/* GraphQL */ `
+      type Query {
+        user(id: ID!, nonNullableDate: DateTime!, nullableDate: DateTime, input: UserInput!): User
+      }
+
+      input UserInput {
+        nonNullableDate: DateTime!
+        nullableDate: DateTime
+      }
+
+      type User {
+        id: ID!
+        nonNullableDate: DateTime!
+        nullableDate: DateTime
+      }
+
+      scalar DateTime
+    `);
+    const document = parse(/* GraphQL */ `
+      query User($nonNullableDate: DateTime!, $nullableDate: DateTime, $input: UserInput!) {
+        user(id: "1", nonNullableDate: $nonNullableDate, nullableDate: $nullableDate, input: $input) {
+          id
+          nonNullableDate
+          nullableDate
+        }
+      }
+    `);
+
+    const result = mergeOutputs([await plugin(schema, [{ document }], {}, { outputFile: '' })]);
+
+    expect(result).toMatchInlineSnapshot(`
+      "type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+      export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
+      type UserInput = {
+        nonNullableDate: unknown;
+        nullableDate?: unknown;
+      };
+
+      export type UserQueryVariables = Exact<{
+        nonNullableDate: unknown;
+        nullableDate?: unknown;
+        input: UserInput;
+      }>;
+
+
+      export type UserQuery = { user: { id: string, nonNullableDate: unknown, nullableDate: unknown } | null };
+      "
+    `);
+
+    validateTs(result, undefined, undefined, undefined, undefined, true);
+  });
+
+  it("generates `any` when defaultScalarType:'any'", async () => {
+    const schema = buildSchema(/* GraphQL */ `
+      type Query {
+        user(id: ID!, nonNullableDate: DateTime!, nullableDate: DateTime, input: UserInput!): User
+      }
+
+      input UserInput {
+        nonNullableDate: DateTime!
+        nullableDate: DateTime
+      }
+
+      type User {
+        id: ID!
+        nonNullableDate: DateTime!
+        nullableDate: DateTime
+      }
+
+      scalar DateTime
+    `);
+    const document = parse(/* GraphQL */ `
+      query User($nonNullableDate: DateTime!, $nullableDate: DateTime, $input: UserInput!) {
+        user(id: "1", nonNullableDate: $nonNullableDate, nullableDate: $nullableDate, input: $input) {
+          id
+          nonNullableDate
+          nullableDate
+        }
+      }
+    `);
+
+    const result = mergeOutputs([
+      await plugin(schema, [{ document }], { defaultScalarType: 'any' }, { outputFile: '' }),
+    ]);
+
+    expect(result).toMatchInlineSnapshot(`
+      "type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+      export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
+      type UserInput = {
+        nonNullableDate: any;
+        nullableDate?: any;
+      };
+
+      export type UserQueryVariables = Exact<{
+        nonNullableDate: any;
+        nullableDate?: any;
+        input: UserInput;
+      }>;
+
+
+      export type UserQuery = { user: { id: string, nonNullableDate: any, nullableDate: any } | null };
+      "
+    `);
+
+    validateTs(result, undefined, undefined, undefined, undefined, true);
+  });
+
+  it('generates `any` when defaultScalarType is set to arbitrary types', async () => {
+    const schema = buildSchema(/* GraphQL */ `
+      type Query {
+        user(id: ID!, nonNullableDate: DateTime!, nullableDate: DateTime, input: UserInput!): User
+      }
+
+      input UserInput {
+        nonNullableDate: DateTime!
+        nullableDate: DateTime
+      }
+
+      type User {
+        id: ID!
+        nonNullableDate: DateTime!
+        nullableDate: DateTime
+      }
+
+      scalar DateTime
+    `);
+    const document = parse(/* GraphQL */ `
+      query User($nonNullableDate: DateTime!, $nullableDate: DateTime, $input: UserInput!) {
+        user(id: "1", nonNullableDate: $nonNullableDate, nullableDate: $nullableDate, input: $input) {
+          id
+          nonNullableDate
+          nullableDate
+        }
+      }
+    `);
+
+    const result = mergeOutputs([
+      await plugin(schema, [{ document }], { defaultScalarType: 'Date' }, { outputFile: '' }),
+    ]);
+
+    expect(result).toMatchInlineSnapshot(`
+      "type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+      export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
+      type UserInput = {
+        nonNullableDate: Date;
+        nullableDate?: Date | null | undefined;
+      };
+
+      export type UserQueryVariables = Exact<{
+        nonNullableDate: Date;
+        nullableDate?: Date | null | undefined;
+        input: UserInput;
+      }>;
+
+
+      export type UserQuery = { user: { id: string, nonNullableDate: Date, nullableDate: Date | null } | null };
+      "
+    `);
+
+    validateTs(result, undefined, undefined, undefined, undefined, true);
+  });
+});