Merge pull request #1 from lukas-reineke/export-api-types

export api types

Author: rmcauley

src/index.d.ts

@@ -13,14 +13,16 @@ export interface Error {
         code?: codes;
     };
 }
+export declare type APIKey = keyof (Query & Mutation);
+export declare type APIResult<T extends APIKey, U extends string = T> = {
+    data: Record<U, NonNullable<Partial<(Query & Mutation)[T]>>>;
+};
 export declare class Cinnamon {
     config: Config;
     refreshToken: string;
     token: string;
     constructor(config: Config);
-    api<T extends keyof (Query & Mutation), U extends string = T>(query: string, variables?: object, headers?: Headers, token?: string): Promise<{
-        data: Record<U, NonNullable<Partial<(Query & Mutation)[T]>>>;
-    }>;
+    api<T extends APIKey, U extends string = T>(query: string, variables?: object, headers?: Headers, token?: string): Promise<APIResult<T, U>>;
     apiPaging<T>(query: string, variables: object | undefined, headers: Headers, token?: string): Promise<Partial<T>[]>;
     login(input: UserLoginInput): Promise<Partial<import("./generated/graphql").Token>>;
     refreshLogin(input: RefreshTokenInput): Promise<Partial<import("./generated/graphql").Token>>;

src/index.ts

@@ -58,6 +58,11 @@ export interface Error {
     extentions?: { code?: codes };
 }
 
+export type APIKey = keyof (Query & Mutation);
+export type APIResult<T extends APIKey, U extends string = T> = {
+    data: Record<U, NonNullable<Partial<(Query & Mutation)[T]>>>;
+};
+
 export class Cinnamon {
     config: Config;
     refreshToken = '';
@@ -67,14 +72,12 @@ export class Cinnamon {
         this.config = config;
     }
 
-    async api<T extends keyof (Query & Mutation), U extends string = T>(
+    async api<T extends APIKey, U extends string = T>(
         query: string,
         variables: object = {},
         headers: Headers = {},
         token?: string,
-    ): Promise<{
-        data: Record<U, NonNullable<Partial<(Query & Mutation)[T]>>>;
-    }> {
+    ): Promise<APIResult<T, U>> {
         const response = await fetch(this.config.url, {
             method: 'POST',
             headers: {