@compassdigital/sdk.typescript 4.121.0 → 4.123.0

package/prettier.config.js

@@ -1,10 +1,6 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+const baseConfig = require('@compassdigital/review/prettier.config');
+
 module.exports = {
-	printWidth: 100,
-	tabWidth: 4,
-	useTabs: true,
-	semi: true,
-	singleQuote: true,
-	trailingComma: 'all',
-	bracketSpacing: true,
-	arrowParens: 'always',
+	...baseConfig,
 };

package/src/base.ts

@@ -161,13 +161,17 @@ export interface ServiceErrorIsOptions {
  * An error returned from an api service.
  */
 export class ServiceError extends Error {
+	data: Record<string, any>;
+
 	constructor(
 		public status: number, // http status
 		public code: number, // service error code
 		message: string, // service error message
+		data?: Record<string, any>, // arbitrary error data
 	) {
 		super(message);
 		this.name = `ServiceError(${code})`;
+		this.data = data ?? {};
 
 		// TODO: remove this if we change compilation target > es5
 		Object.setPrototypeOf(this, ServiceError.prototype);
@@ -270,6 +274,7 @@ export class ServiceError extends Error {
 	static from_res(res: ResponseData): ServiceError {
 		let message = res.body;
 		let code = res.status;
+		let data: Record<string, any> | undefined;
 		if (res.err) {
 			// network error
 			if (res.err instanceof Error) {
@@ -280,14 +285,17 @@ export class ServiceError extends Error {
 			code = 0;
 		} else {
 			try {
-				const data = JSON.parse(res.body);
-				if (data.code && (data.message || data.error)) {
-					code = data.code;
-					message = data.message || data.error;
+				const body = JSON.parse(res.body);
+				if (body.code && (body.message || body.error)) {
+					code = body.code;
+					message = body.message || body.error;
+					data = body.data;
 				}
-			} catch (_) {}
+			} catch {
+				// ignore
+			}
 		}
-		const err = new ServiceError(res.status, code, message);
+		const err = new ServiceError(res.status, code, message, data);
 		// override the stack trace so that it doesn't include the from_res helper.
 		if (Error.captureStackTrace) {
 			Error.captureStackTrace(err, ServiceError.from_res);

package/src/index.ts

@@ -1025,8 +1025,8 @@ import {
 import {
 	PostVendorApplicationBody,
 	PostVendorApplicationResponse,
-	GetVendorApplicationQuery,
-	GetVendorApplicationResponse,
+	GetVendorApplicationsQuery,
+	GetVendorApplicationsResponse,
 	PatchVendorApplicationBody,
 	PatchVendorApplicationResponse,
 	PostVendorBody,
@@ -11019,11 +11019,11 @@ export class ServiceClient extends BaseServiceClient {
 	 *
 	 * @param options - additional request options
 	 */
-	get_vendor_application(
+	get_vendor_applications(
 		options?: {
-			query?: GetVendorApplicationQuery;
+			query?: GetVendorApplicationsQuery;
 		} & RequestOptions,
-	): ResponsePromise<GetVendorApplicationResponse> {
+	): ResponsePromise<GetVendorApplicationsResponse> {
 		return this.request(
 			'vendor',
 			'/vendor/application',

package/src/interface/auth.ts

@@ -12,6 +12,7 @@ export interface SSOFlowRequestDTO {
 export interface OIDC {
 	authorizationUrl: string;
 	name: string;
+	clientId: string;
 }
 
 export interface SSOFlowResponseDTO {
@@ -26,7 +27,7 @@ export interface UnauthorizedErrorDTO {
 }
 
 export interface SSOMapping {
-	id: string;
+	sub: string;
 	given_name: string;
 	family_name: string;
 	email: string;

package/src/interface/vendor.ts

@@ -204,7 +204,7 @@ export interface PostVendorApplicationRequest extends BaseRequest {
 
 // GET /vendor/application - Get a list of all applications
 
-export interface GetVendorApplicationQuery {
+export interface GetVendorApplicationsQuery {
 	status?: 'pending' | 'approved' | 'rejected';
 	// Pagination token to start query from
 	last_evaluated_key?: string;
@@ -212,11 +212,11 @@ export interface GetVendorApplicationQuery {
 	_query?: string;
 }
 
-export type GetVendorApplicationResponse = Applications;
+export type GetVendorApplicationsResponse = Applications;
 
-export interface GetVendorApplicationRequest
+export interface GetVendorApplicationsRequest
 	extends BaseRequest,
-		RequestQuery<GetVendorApplicationQuery> {}
+		RequestQuery<GetVendorApplicationsQuery> {}
 
 // PATCH /vendor/application/{id} - Update an application (or update status)
 
@@ -316,6 +316,8 @@ export interface GetVendorKeysPath {
 }
 
 export interface GetVendorKeysQuery {
+	// Pagination token to start query from
+	last_evaluated_key?: string;
 	// Graphql query string
 	_query?: string;
 }
@@ -352,8 +354,6 @@ export interface GetVendorKeyPath {
 }
 
 export interface GetVendorKeyQuery {
-	// Pagination token to start query from
-	last_evaluated_key?: string;
 	// Graphql query string
 	_query?: string;
 }

package/test/client.test.ts

@@ -224,5 +224,20 @@ describe('ServiceClient', () => {
 			const promise = api.get_task('').combine(500);
 			expect(promise).rejects.toThrow();
 		});
+
+		test('error data should be included', async () => {
+			const api = new ServiceClient({
+				stage: 'dev',
+				intercept: interceptor(500, {
+					code: 500,
+					error: 'message',
+					data: { foo: 'bar' },
+				}),
+			});
+			const promise = api.get_task('');
+			expect(promise).rejects.toMatchObject({
+				data: { foo: 'bar' },
+			});
+		});
 	});
 });