T-331 return raw data in errors

Author: lukas-reineke

index.node.js

@@ -23,7 +23,7 @@
   "author": "Adgorithmics, Inc.",
   "license": "MIT",
   "dependencies": {
-    "@adgorithmics/graphql-errors": "^1.3.0",
+    "@adgorithmics/graphql-errors": "^1.4.0",
     "cross-fetch": "3.0.4",
     "lodash.get": "4.4.2"
   },

index.web.js

@@ -1,3 +1,4 @@
+import { codes } from '@adgorithmics/graphql-errors';
 import { Query } from './generated/graphql';
 export declare type Deep<T> = {
     0: T;
@@ -6,3 +7,19 @@ export declare type Deep<T> = {
 export declare function bind<T extends Function>(_target: object, propertyKey: string, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;
 export declare function getFormattedFields(fields?: Array<string>): string;
 export declare function pageQueryGenerator(name: keyof Query, fields?: Array<string>, hasShowDeleted?: boolean): string;
+export interface APIError {
+    message?: string;
+    extentions?: {
+        code?: codes;
+    };
+}
+export declare class CinnamonError extends Error {
+    raw?: {
+        data?: unknown;
+        errors?: Array<APIError>;
+    };
+    constructor(message: string, raw?: {
+        data?: unknown;
+        errors?: Array<APIError>;
+    });
+}

package-lock.json

@@ -1,3 +1,4 @@
+import { codes } from '@adgorithmics/graphql-errors';
 import { Query } from './generated/graphql';
 import { nameMap } from './generated/fields';
 
@@ -82,3 +83,21 @@ query(
     }
 }`;
 }
+
+export interface APIError {
+    message?: string;
+    extentions?: { code?: codes };
+}
+
+export class CinnamonError extends Error {
+    raw?: { data?: unknown; errors?: Array<APIError> };
+
+    constructor(
+        message: string,
+        raw?: { data?: unknown; errors?: Array<APIError> },
+    ) {
+        super(message);
+
+        this.raw = raw;
+    }
+}

package.json

@@ -1,4 +1,3 @@
-import { codes } from '@adgorithmics/graphql-errors';
 import { PageInfo, Scalars, Mutation, Query, SortInput, User, UserLoginInput, UserUpdateInput, RefreshTokenInput, Organization, OrganizationInput, OrganizationUpdateInput, Marketplace, MarketplaceInput, MarketplaceUpdateInput, MediaChannel, MediaChannelCreateInput, MediaChannelUpdateInput, MediaChannelImportInput, CampaignTemplate, Vendor, VendorInput, VendorUpdateInput, VendorToken, VendorTokenInput, Catalog, CatalogCreateInput, CatalogImportInput, CatalogUpdateInput, Product, ProductInput, ProductUpdateInput, MarketingCampaign, MarketingCampaignInput, MarketingCampaignUpdateInput, MarketingAd, Result, Entitlement, EntitlementInput, EntitlementUpdateInput, CreativeFont, CreativeFontCreateInput, CreativeFontUpdateInput, CreativeImage, CreativeImageCreateInput, CreativeImageUpdateInput, CreativeLayer, CreativeLayerCreateInput, CreativeLayerUpdateInput, CreativeTemplate, CreativeTemplateCreateInput, CreativeTemplateUpdateInput } from './generated/graphql';
 import { OrganizationFields, UserFields, MarketplaceFields, MediaChannelFields, CampaignTemplateFields, VendorFields, VendorTokenFields, CatalogFields, ProductFields, MarketingCampaignFields, MarketingAdFields, ResultFields, EntitlementFields, CreativeFontFields, CreativeImageFields, CreativeLayerFields, CreativeTemplateFields } from './generated/fields';
 import { Deep } from './helpers';
@@ -8,12 +7,6 @@ export interface Config {
 export interface Headers {
     [key: string]: string;
 }
-export interface Error {
-    message?: string;
-    extentions?: {
-        code?: codes;
-    };
-}
 export declare type APIKey = keyof (Query & Mutation);
 export declare type APIResult<T extends APIKey, U extends string = T> = {
     data: Record<U, NonNullable<(Query & Mutation)[T]>>;

src/helpers.d.ts

@@ -78,7 +78,14 @@ import {
     CreativeTemplateFields,
 } from './generated/fields';
 
-import { Deep, bind, pageQueryGenerator, getFormattedFields } from './helpers';
+import {
+    Deep,
+    bind,
+    pageQueryGenerator,
+    getFormattedFields,
+    APIError,
+    CinnamonError,
+} from './helpers';
 
 export interface Config {
     url: string;
@@ -88,11 +95,6 @@ export interface Headers {
     [key: string]: string;
 }
 
-export interface Error {
-    message?: string;
-    extentions?: { code?: codes };
-}
-
 export type APIKey = keyof (Query & Mutation);
 export type APIResult<T extends APIKey, U extends string = T> = {
     data: Record<U, NonNullable<(Query & Mutation)[T]>>;
@@ -129,7 +131,8 @@ export class Cinnamon {
         const response = await fetch(this.config.url, {
             method: 'POST',
             headers: {
-                authorization: `Bearer ${token || this.token}`,
+                authorization:
+                    token || this.token ? `Bearer ${token || this.token}` : '',
                 accept: 'application/json',
                 'content-type': 'application/json',
                 ...headers,
@@ -141,20 +144,24 @@ export class Cinnamon {
         if (json.errors) {
             if (
                 json.errors.some(
-                    (error: Error) =>
+                    (error: APIError) =>
                         get(error, 'extensions.code') === codes.TOKEN_EXPIRED,
                 ) &&
                 !token
             ) {
                 await this.refreshLogin({ refreshToken: this.refreshToken });
                 return this.api({ query, variables, headers, token });
             }
-            throw new Error(
+            throw new CinnamonError(
                 json.errors.map((error: Error) => error.message).join('\n'),
+                json,
             );
         }
         if (!json.data) {
-            throw new Error(`Invalid server response: ${JSON.stringify(json)}`);
+            throw new CinnamonError(
+                `Invalid server response: ${JSON.stringify(json)}`,
+                json,
+            );
         }
         return json;
     }