Fix input types (#17)

* Fix the return type of upserting a customer

* Add changeset

* Update types to better handle nullable inputs

Author: mattvagni

.changeset/cyan-stingrays-grab.md

@@ -0,0 +1,5 @@
+---
+'@team-plain/typescript-sdk': patch
+---
+
+Fix the return type of of upserting a customer (it can not be null)

.changeset/rude-horses-drum.md

@@ -0,0 +1,5 @@
+---
+'@team-plain/typescript-sdk': minor
+---
+
+Update input types to allow omiting null inputs

codegen.ts

@@ -5,7 +5,9 @@ const config: CodegenConfig = {
   schema: 'https://core-api.uk.plain.com/graphql/v1/schema.graphql',
   documents: './src/graphql/*/*.gql',
   config: {
-    avoidOptionals: true,
+    avoidOptionals: {
+      field: true,
+    },
   },
   generates: {
     './src/graphql/types.ts': {

src/client.ts

@@ -1,33 +1,28 @@
+import { VariablesOf } from '@graphql-typed-document-node/core';
 import { Context } from './context';
 import { PlainSDKError } from './error';
 import {
+  AddCustomerToCustomerGroupsDocument,
+  CustomerByIdDocument,
   CustomerGroupMembershipPartsFragment,
   RemoveCustomerFromCustomerGroupsDocument,
-  RemoveCustomerFromCustomerGroupsInput,
 } from './graphql/types';
-import { AddCustomerToCustomerGroupsDocument } from './graphql/types';
-import { AddCustomerToCustomerGroupsInput } from './graphql/types';
 import {
   CreateIssueDocument,
-  CreateIssueInput,
-  CustomerByIdDocument,
-  CustomerByIdQueryVariables,
   CustomerPartsFragment,
   IssuePartsFragment,
   TimelineEntryPartsFragment,
   UpsertCustomTimelineEntryDocument,
-  UpsertCustomTimelineEntryInput,
   UpsertCustomerDocument,
-  UpsertCustomerInput,
   UpsertResult,
 } from './graphql/types';
 import { request } from './request';
 import { Result } from './result';
 
 type SDKResult<T> = Promise<Result<T, PlainSDKError>>;
 
-function nonNullable<T>(x: T | null): T {
-  if (x === null) {
+function nonNullable<T>(x: T | null | undefined): T {
+  if (x === null || x === undefined) {
     throw new Error(`Expected value to be non nullable`);
   }
 
@@ -74,12 +69,12 @@ export class PlainSDKClient {
   /**
    * If the customer is not found this will return null.
    */
-  async getCustomerById(args: CustomerByIdQueryVariables): SDKResult<CustomerPartsFragment | null> {
+  async getCustomerById(
+    variables: VariablesOf<typeof CustomerByIdDocument>
+  ): SDKResult<CustomerPartsFragment | null> {
     const res = await request(this.#ctx, {
       query: CustomerByIdDocument,
-      variables: {
-        customerId: args.customerId,
-      },
+      variables,
     });
 
     return unwrapData(res, (q) => q.customer);
@@ -89,7 +84,9 @@ export class PlainSDKClient {
    * Allows you to create or update a customer. If you need to get the customer id
    * for a customer in Plain, this is typically your first step.
    */
-  async upsertCustomer(input: UpsertCustomerInput): SDKResult<CustomerPartsFragment | null> {
+  async upsertCustomer(
+    input: VariablesOf<typeof UpsertCustomerDocument>['input']
+  ): SDKResult<CustomerPartsFragment> {
     const res = await request(this.#ctx, {
       query: UpsertCustomerDocument,
       variables: {
@@ -104,7 +101,9 @@ export class PlainSDKClient {
    * Create an issue for a customer. If you want you can override the default issue priority
    * in your settings by specifying a priority manually here.
    */
-  async createIssue(input: CreateIssueInput): SDKResult<IssuePartsFragment> {
+  async createIssue(
+    input: VariablesOf<typeof CreateIssueDocument>['input']
+  ): SDKResult<IssuePartsFragment> {
     const res = await request(this.#ctx, {
       query: CreateIssueDocument,
       variables: {
@@ -119,7 +118,7 @@ export class PlainSDKClient {
    * Adds a customer to a customer groups.
    */
   async addCustomerToCustomerGroups(
-    input: AddCustomerToCustomerGroupsInput
+    input: VariablesOf<typeof AddCustomerToCustomerGroupsDocument>['input']
   ): SDKResult<CustomerGroupMembershipPartsFragment[]> {
     const res = await request(this.#ctx, {
       query: AddCustomerToCustomerGroupsDocument,
@@ -137,7 +136,7 @@ export class PlainSDKClient {
    * Remove a customer from customer groups.
    */
   async removeCustomerFromCustomerGroups(
-    input: RemoveCustomerFromCustomerGroupsInput
+    input: VariablesOf<typeof RemoveCustomerFromCustomerGroupsDocument>['input']
   ): SDKResult<null> {
     const res = await request(this.#ctx, {
       query: RemoveCustomerFromCustomerGroupsDocument,
@@ -155,7 +154,7 @@ export class PlainSDKClient {
    * This can be used to power custom contact forms, log events from your own systems and much more.
    */
   async upsertCustomTimelineEntry(
-    input: UpsertCustomTimelineEntryInput
+    input: VariablesOf<typeof UpsertCustomTimelineEntryDocument>['input']
   ): SDKResult<{ result: UpsertResult; timelineEntry: TimelineEntryPartsFragment }> {
     const res = await request(this.#ctx, {
       query: UpsertCustomTimelineEntryDocument,

src/examples/upsertCustomer.ts

@@ -0,0 +1,31 @@
+/**
+ * This example calls upsert customer. This file acts as kind of type 'test'
+ * since breaking the API would result in this file not typechecking.
+ */
+
+import { PlainSDKClient } from '../client';
+
+export async function upsertCustomerExample() {
+  const client = new PlainSDKClient({ apiKey: '' });
+
+  const res = await client.upsertCustomer({
+    identifier: {
+      customerId: '',
+    },
+    onCreate: {
+      fullName: '',
+      email: {
+        email: '',
+        isVerified: false,
+      },
+    },
+    onUpdate: {},
+  });
+
+  if (res.error) {
+    console.error(res.error);
+    throw new Error(res.error.message);
+  }
+
+  console.log(`Created customer with ${res.data.id}`);
+}