@compassdigital/sdk.typescript 4.122.0 → 4.124.0

package/manifest.json

@@ -2,147 +2,147 @@
 	"services": [
 		{
 			"name": "payment",
-			"swagger": "../../platform2/payment/swagger.json"
+			"swagger": "../../api/platform2/payment/swagger.json"
 		},
 		{
 			"name": "order",
-			"swagger": "../../platform2/order/swagger.json"
+			"swagger": "../../api/platform2/order/swagger.json"
 		},
 		{
 			"name": "location",
-			"swagger": "../../platform2/location/swagger.json"
+			"swagger": "../../api/platform2/location/swagger.json"
 		},
 		{
 			"name": "shoppingcart",
-			"swagger": "../../platform2/shoppingcart/swagger.json"
+			"swagger": "../../api/platform2/shoppingcart/swagger.json"
 		},
 		{
 			"name": "partner",
-			"swagger": "../../platform2/partner/swagger.json"
+			"swagger": "../../api/platform2/partner/swagger.json"
 		},
 		{
 			"name": "email",
-			"swagger": "../../platform2/email/swagger.json"
+			"swagger": "../../api/platform2/email/swagger.json"
 		},
 		{
 			"name": "task",
-			"swagger": "../../platform2/task/swagger.json"
+			"swagger": "../../api/platform2/task/swagger.json"
 		},
 		{
 			"name": "kds",
-			"swagger": "../../platform2/kds/swagger.json"
+			"swagger": "../../api/platform2/kds/swagger.json"
 		},
 		{
 			"name": "mealplan",
-			"swagger": "../../platform2/mealplan/swagger.json"
+			"swagger": "../../api/platform2/mealplan/swagger.json"
 		},
 		{
 			"name": "datalake",
-			"swagger": "../../platform2/datalake/swagger.json"
+			"swagger": "../../api/platform2/datalake/swagger.json"
 		},
 		{
 			"name": "promo",
-			"swagger": "../../platform2/promo/swagger.json"
+			"swagger": "../../api/platform2/promo/swagger.json"
 		},
 		{
 			"name": "config",
-			"swagger": "../../platform2/config/swagger.json"
+			"swagger": "../../api/platform2/config/swagger.json"
 		},
 		{
 			"name": "announcement",
-			"swagger": "../../platform2/announcement/swagger.json"
+			"swagger": "../../api/platform2/announcement/swagger.json"
 		},
 		{
 			"name": "report",
-			"swagger": "../../platform2/report/swagger.json"
+			"swagger": "../../api/platform2/report/swagger.json"
 		},
 		{
 			"name": "user",
-			"swagger": "../../platform2/user/swagger.json"
+			"swagger": "../../api/platform2/user/swagger.json"
 		},
 		{
 			"name": "calendar",
-			"swagger": "../../platform2/calendar/swagger.json"
+			"swagger": "../../api/platform2/calendar/swagger.json"
 		},
 		{
 			"name": "file",
-			"swagger": "../../platform2/file/swagger.json"
+			"swagger": "../../api/platform2/file/swagger.json"
 		},
 		{
 			"name": "menu",
-			"swagger": "../../platform2/menu/swagger.json"
+			"swagger": "../../api/platform2/menu/swagger.json"
 		},
 		{
 			"name": "notification",
-			"swagger": "../../platform2/notification/swagger.json"
+			"swagger": "../../api/platform2/notification/swagger.json"
 		},
 		{
 			"name": "compassconnect",
-			"swagger": "../../platform2/compassconnect/swagger.json"
+			"swagger": "../../api/platform2/compassconnect/swagger.json"
 		},
 		{
 			"name": "vendor",
-			"swagger": "../../platform2/vendor/swagger.json"
+			"swagger": "../../api/platform2/vendor/swagger.json"
 		},
 		{
 			"name": "frictionless",
-			"swagger": "../../platform2/frictionless/swagger.json",
+			"swagger": "../../api/platform2/frictionless/swagger.json",
 			"options": {
 				"request": false
 			}
 		},
 		{
 			"name": "consumer",
-			"swagger": "../../platform2/edges/consumer/swagger.json",
+			"swagger": "../../api/platform2/edges/consumer/swagger.json",
 			"options": {
 				"request": false
 			}
 		},
 		{
 			"name": "ai",
-			"swagger": "../../platform2/ai/swagger.json",
+			"swagger": "../../api/platform2/ai/swagger.json",
 			"options": {
 				"request": false
 			}
 		},
 		{
 			"name": "centricos",
-			"swagger": "../../platform2/edges/centricos/swagger.json",
+			"swagger": "../../api/platform2/edges/centricos/swagger.json",
 			"options": {
 				"request": false
 			}
 		},
 		{
 			"name": "tax",
-			"swagger": "../../platform2/external-integrations/tax/swagger.json",
+			"swagger": "../../api/platform2/external-integrations/tax/swagger.json",
 			"options": {
 				"request": false
 			}
 		},
 		{
 			"name": "search",
-			"swagger": "../../platform2/search/swagger.json",
+			"swagger": "../../api/platform2/search/swagger.json",
 			"options": {
 				"request": false
 			}
 		},
 		{
 			"name": "auth",
-			"swagger": "../../platform2/auth/service/swagger.json",
+			"swagger": "../../api/platform2/auth/service/swagger.json",
 			"options": {
 				"request": false
 			}
 		},
 		{
 			"name": "review",
-			"swagger": "../../platform2/review/swagger.json",
+			"swagger": "../../api/platform2/review/swagger.json",
 			"options": {
 				"request": false
 			}
 		},
 		{
 			"name": "discount",
-			"swagger": "../../platform2/discount/swagger.json",
+			"swagger": "../../api/platform2/discount/swagger.json",
 			"options": {
 				"request": false
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.122.0",
+	"version": "4.124.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",
@@ -31,30 +31,32 @@
 	"scripts": {
 		"test": "jest",
 		"build": "rimraf ./lib && tsc",
-		"gen": "npm ci && rimraf ./src && sdk.typescript --events ../../events --manifest ./manifest.json && npm run build",
+		"gen": "npm ci && rimraf ./src && sdk.typescript --events ../../api/events --manifest ./manifest.json && npm run build",
 		"prepare": "npm run build",
 		"pretest": "eslint --quiet . --ext .js,.ts",
 		"pre-commit": "lint-staged",
-		"format": "prettier --write '**/*.{ts,js,yml}'"
+		"format": "prettier --write '**/*.{ts,js,yml}'",
+		"lint": "eslint --quiet . --ext .js,.ts",
+		"lint:fix": "npm run lint -- --fix"
 	},
 	"author": "",
 	"license": "ISC",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/compassdigital/cdl.git",
-		"directory": "api/npm/sdk.typescript"
+		"directory": "npm/sdk.typescript"
 	},
 	"dependencies": {
 		"cross-fetch": "^4.0.0"
 	},
 	"devDependencies": {
-		"@compassdigital/review": "^7.3.0",
-		"@compassdigital/sdk.typescript.cli": "^4.42.0",
+		"@compassdigital/review": "^7.6.3",
+		"@compassdigital/sdk.typescript.cli": "^4.43.0",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^29.2.4",
 		"@types/node": "^22.0.0",
-		"esbuild": "^0.23.0",
+		"esbuild": "^0.25.2",
 		"jest": "^29.7.0",
 		"rimraf": "^6.0.1",
 		"typescript": "^5.0.2"

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

@@ -1225,6 +1225,8 @@ import {
 	GetDiscountsResponse,
 	PostDiscountBody,
 	PostDiscountResponse,
+	GetDiscountsAllQuery,
+	GetDiscountsAllResponse,
 	PutDiscountPublishBody,
 	PutDiscountPublishResponse,
 } from './interface/discount';
@@ -12702,6 +12704,19 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('discount', '/discount', 'post', `/discount`, body, options);
 	}
 
+	/**
+	 * GET /discount/all - Get all discount
+	 *
+	 * @param options - additional request options
+	 */
+	get_discounts_all(
+		options?: {
+			query?: GetDiscountsAllQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetDiscountsAllResponse> {
+		return this.request('discount', '/discount/all', 'get', `/discount/all`, null, options);
+	}
+
 	/**
 	 * PUT /discount/{id}/publish - update and publish a discount
 	 *

package/src/interface/discount.ts

@@ -91,6 +91,26 @@ export interface GetDiscountsResponseDTO {
 	discounts: DiscountDTO[];
 }
 
+export interface DiscountWithSites {
+	// discount id
+	id: string;
+	// user id of discount creator
+	createdBy: string;
+	// user id of most recent update
+	updatedBy: string;
+	sites: string[];
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	meta?: DiscountMeta;
+}
+
+export interface GetAllDiscountsResponseDTO {
+	discounts: DiscountWithSites[];
+}
+
 export interface DiscountTaxonomy {
 	site?: string[];
 	brand?: string[];
@@ -218,6 +238,15 @@ export type PostDiscountBody = PostDiscountRequestDTO;
 
 export type PostDiscountResponse = PostDiscountResponseDTO;
 
+// GET /discount/all - Get all discount
+
+export interface GetDiscountsAllQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetDiscountsAllResponse = GetAllDiscountsResponseDTO;
+
 // PUT /discount/{id}/publish - update and publish a discount
 
 export interface PutDiscountPublishPath {

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' },
+			});
+		});
 	});
 });