@adtrackify/at-service-common 4.0.23 → 4.0.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/dist/cjs/__tests__/helpers/public-api-response-helper.spec.d.ts +1 -0
  2. package/dist/cjs/__tests__/helpers/public-api-response-helper.spec.js +61 -0
  3. package/dist/cjs/__tests__/helpers/public-api-response-helper.spec.js.map +1 -0
  4. package/dist/cjs/helpers/index.d.ts +1 -0
  5. package/dist/cjs/helpers/index.js +1 -0
  6. package/dist/cjs/helpers/index.js.map +1 -1
  7. package/dist/cjs/helpers/public-api-response-helper.d.ts +21 -0
  8. package/dist/cjs/helpers/public-api-response-helper.js +46 -0
  9. package/dist/cjs/helpers/public-api-response-helper.js.map +1 -0
  10. package/dist/cjs/types/index.d.ts +1 -0
  11. package/dist/cjs/types/index.js +1 -0
  12. package/dist/cjs/types/index.js.map +1 -1
  13. package/dist/cjs/types/public-api-types.d.ts +24 -0
  14. package/dist/cjs/types/public-api-types.js +14 -0
  15. package/dist/cjs/types/public-api-types.js.map +1 -0
  16. package/dist/esm/__tests__/helpers/public-api-response-helper.spec.d.ts +1 -0
  17. package/dist/esm/__tests__/helpers/public-api-response-helper.spec.js +56 -0
  18. package/dist/esm/__tests__/helpers/public-api-response-helper.spec.js.map +1 -0
  19. package/dist/esm/helpers/index.d.ts +1 -0
  20. package/dist/esm/helpers/index.js +1 -0
  21. package/dist/esm/helpers/index.js.map +1 -1
  22. package/dist/esm/helpers/public-api-response-helper.d.ts +21 -0
  23. package/dist/esm/helpers/public-api-response-helper.js +39 -0
  24. package/dist/esm/helpers/public-api-response-helper.js.map +1 -0
  25. package/dist/esm/types/index.d.ts +1 -0
  26. package/dist/esm/types/index.js +1 -0
  27. package/dist/esm/types/index.js.map +1 -1
  28. package/dist/esm/types/public-api-types.d.ts +24 -0
  29. package/dist/esm/types/public-api-types.js +11 -0
  30. package/dist/esm/types/public-api-types.js.map +1 -0
  31. package/package.json +1 -1
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const joi_1 = __importDefault(require("joi"));
7
+ const public_api_response_helper_js_1 = require("../../helpers/public-api-response-helper.js");
8
+ const http_error_js_1 = require("../../libs/http-error.js");
9
+ const public_api_types_js_1 = require("../../types/public-api-types.js");
10
+ const REQ = 'req_1';
11
+ describe('public-api-response-helper - unit', () => {
12
+ it('apiSuccess returns 200 with requestId, body, and x-request-id header', () => {
13
+ const res = (0, public_api_response_helper_js_1.apiSuccess)(REQ, { eventsIngested: 3 });
14
+ expect(res.statusCode).toBe(200);
15
+ expect(JSON.parse(res.body)).toEqual({ requestId: REQ, eventsIngested: 3 });
16
+ expect(res.headers?.['x-request-id']).toBe(REQ);
17
+ });
18
+ it.each([
19
+ [public_api_types_js_1.API_ERROR_CODE.VALIDATION_ERROR, 400],
20
+ [public_api_types_js_1.API_ERROR_CODE.UNAUTHORIZED, 401],
21
+ [public_api_types_js_1.API_ERROR_CODE.FORBIDDEN, 403],
22
+ [public_api_types_js_1.API_ERROR_CODE.NOT_FOUND, 404],
23
+ [public_api_types_js_1.API_ERROR_CODE.PAYLOAD_TOO_LARGE, 413],
24
+ [public_api_types_js_1.API_ERROR_CODE.RATE_LIMITED, 429],
25
+ [public_api_types_js_1.API_ERROR_CODE.INTERNAL_ERROR, 500],
26
+ ])('apiError maps %s → HTTP %i with a uniform envelope', (code, status) => {
27
+ const res = (0, public_api_response_helper_js_1.apiError)(REQ, code, 'boom');
28
+ const body = JSON.parse(res.body);
29
+ expect(res.statusCode).toBe(status);
30
+ expect(body).toEqual({ requestId: REQ, message: 'boom', error: { code, message: 'boom' } });
31
+ expect(res.headers?.['x-request-id']).toBe(REQ);
32
+ });
33
+ it('apiError includes details only when provided', () => {
34
+ const details = [{ index: 0, field: 'name', message: 'required' }];
35
+ const body = JSON.parse((0, public_api_response_helper_js_1.apiError)(REQ, public_api_types_js_1.API_ERROR_CODE.VALIDATION_ERROR, 'bad', details).body);
36
+ expect(body.error.details).toEqual(details);
37
+ });
38
+ it('validationDetails flattens Joi errors to {index, field, message}', () => {
39
+ const schema = joi_1.default.object({ events: joi_1.default.array().items(joi_1.default.object({ name: joi_1.default.string().required() })) });
40
+ const { error } = schema.validate({ events: [{}, {}] }, { abortEarly: false });
41
+ const details = (0, public_api_response_helper_js_1.validationDetails)(error);
42
+ expect(details).toEqual(expect.arrayContaining([
43
+ expect.objectContaining({ index: 0, field: 'events.name' }),
44
+ expect.objectContaining({ index: 1, field: 'events.name' }),
45
+ ]));
46
+ });
47
+ it('apiErrorFromThrown maps an HttpError by status and exposes its message on 4xx', () => {
48
+ const res = (0, public_api_response_helper_js_1.apiErrorFromThrown)(REQ, http_error_js_1.HttpError.forbidden('no scope'));
49
+ const body = JSON.parse(res.body);
50
+ expect(res.statusCode).toBe(403);
51
+ expect(body.error.code).toBe(public_api_types_js_1.API_ERROR_CODE.FORBIDDEN);
52
+ expect(body.message).toBe('no scope');
53
+ });
54
+ it('apiErrorFromThrown never leaks internals on unknown errors', () => {
55
+ const res = (0, public_api_response_helper_js_1.apiErrorFromThrown)(REQ, new Error('secret stack detail'));
56
+ expect(res.statusCode).toBe(500);
57
+ expect(JSON.parse(res.body).error.code).toBe(public_api_types_js_1.API_ERROR_CODE.INTERNAL_ERROR);
58
+ expect(res.body).not.toContain('secret stack detail');
59
+ });
60
+ });
61
+ //# sourceMappingURL=public-api-response-helper.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"public-api-response-helper.spec.js","sourceRoot":"","sources":["../../../../src/__tests__/helpers/public-api-response-helper.spec.ts"],"names":[],"mappings":";;;;;AAGA,8CAAsB;AACtB,+FAA0H;AAC1H,4DAAqD;AACrD,yEAAiE;AAEjE,MAAM,GAAG,GAAG,OAAO,CAAC;AAEpB,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;IACjD,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC9E,MAAM,GAAG,GAAG,IAAA,0CAAU,EAAC,GAAG,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC;QAC5E,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,oCAAc,CAAC,gBAAgB,EAAE,GAAG,CAAC;QACtC,CAAC,oCAAc,CAAC,YAAY,EAAE,GAAG,CAAC;QAClC,CAAC,oCAAc,CAAC,SAAS,EAAE,GAAG,CAAC;QAC/B,CAAC,oCAAc,CAAC,SAAS,EAAE,GAAG,CAAC;QAC/B,CAAC,oCAAc,CAAC,iBAAiB,EAAE,GAAG,CAAC;QACvC,CAAC,oCAAc,CAAC,YAAY,EAAE,GAAG,CAAC;QAClC,CAAC,oCAAc,CAAC,cAAc,EAAE,GAAG,CAAC;KACrC,CAAC,CAAC,oDAAoD,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;QACxE,MAAM,GAAG,GAAG,IAAA,wCAAQ,EAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC5F,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,OAAO,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACnE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,wCAAQ,EAAC,GAAG,EAAE,oCAAc,CAAC,gBAAgB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;QAC7F,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC1E,MAAM,MAAM,GAAG,aAAG,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACxG,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/E,MAAM,OAAO,GAAG,IAAA,iDAAiB,EAAC,KAA4B,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CACrB,MAAM,CAAC,eAAe,CAAC;YACrB,MAAM,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;YAC3D,MAAM,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;SAC5D,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;QACvF,MAAM,GAAG,GAAG,IAAA,kDAAkB,EAAC,GAAG,EAAE,yBAAS,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QACrE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,oCAAc,CAAC,SAAS,CAAC,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,GAAG,GAAG,IAAA,kDAAkB,EAAC,GAAG,EAAE,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,oCAAc,CAAC,cAAc,CAAC,CAAC;QAC5E,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1,6 +1,7 @@
1
1
  export * from './input-validation-helper.js';
2
2
  export * from './logging-helper.js';
3
3
  export * from './response-helper.js';
4
+ export * from './public-api-response-helper.js';
4
5
  export * from './shopify-helper.js';
5
6
  export * from './account-users-helper.js';
6
7
  export * from './sqs-utils.js';
@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./input-validation-helper.js"), exports);
18
18
  __exportStar(require("./logging-helper.js"), exports);
19
19
  __exportStar(require("./response-helper.js"), exports);
20
+ __exportStar(require("./public-api-response-helper.js"), exports);
20
21
  __exportStar(require("./shopify-helper.js"), exports);
21
22
  __exportStar(require("./account-users-helper.js"), exports);
22
23
  __exportStar(require("./sqs-utils.js"), exports);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+DAA6C;AAC7C,sDAAoC;AACpC,uDAAqC;AACrC,sDAAoC;AACpC,4DAA0C;AAC1C,iDAA+B;AAC/B,2DAAyC;AACzC,iEAA+C;AAC/C,qDAAmC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+DAA6C;AAC7C,sDAAoC;AACpC,uDAAqC;AACrC,kEAAgD;AAChD,sDAAoC;AACpC,4DAA0C;AAC1C,iDAA+B;AAC/B,2DAAyC;AACzC,iEAA+C;AAC/C,qDAAmC"}
@@ -0,0 +1,21 @@
1
+ import type { ValidationError } from 'joi';
2
+ import { API_ERROR_CODE, ApiErrorDetail } from '../types/public-api-types.js';
3
+ export declare const apiSuccess: <T extends object>(requestId: string, body: T) => {
4
+ statusCode: number;
5
+ headers: any;
6
+ multiValueHeaders: {};
7
+ body: string;
8
+ };
9
+ export declare const apiError: (requestId: string, code: API_ERROR_CODE, message: string, details?: ApiErrorDetail[]) => {
10
+ statusCode: number;
11
+ headers: any;
12
+ multiValueHeaders: {};
13
+ body: string;
14
+ };
15
+ export declare const validationDetails: (error: ValidationError) => ApiErrorDetail[];
16
+ export declare const apiErrorFromThrown: (requestId: string, error: unknown) => {
17
+ statusCode: number;
18
+ headers: any;
19
+ multiValueHeaders: {};
20
+ body: string;
21
+ };
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.apiErrorFromThrown = exports.validationDetails = exports.apiError = exports.apiSuccess = void 0;
4
+ const http_error_js_1 = require("../libs/http-error.js");
5
+ const public_api_types_js_1 = require("../types/public-api-types.js");
6
+ const response_helper_js_1 = require("./response-helper.js");
7
+ const STATUS_BY_CODE = {
8
+ [public_api_types_js_1.API_ERROR_CODE.VALIDATION_ERROR]: 400,
9
+ [public_api_types_js_1.API_ERROR_CODE.UNAUTHORIZED]: 401,
10
+ [public_api_types_js_1.API_ERROR_CODE.FORBIDDEN]: 403,
11
+ [public_api_types_js_1.API_ERROR_CODE.NOT_FOUND]: 404,
12
+ [public_api_types_js_1.API_ERROR_CODE.PAYLOAD_TOO_LARGE]: 413,
13
+ [public_api_types_js_1.API_ERROR_CODE.RATE_LIMITED]: 429,
14
+ [public_api_types_js_1.API_ERROR_CODE.INTERNAL_ERROR]: 500,
15
+ };
16
+ const CODE_BY_STATUS = {
17
+ 400: public_api_types_js_1.API_ERROR_CODE.VALIDATION_ERROR,
18
+ 401: public_api_types_js_1.API_ERROR_CODE.UNAUTHORIZED,
19
+ 403: public_api_types_js_1.API_ERROR_CODE.FORBIDDEN,
20
+ 404: public_api_types_js_1.API_ERROR_CODE.NOT_FOUND,
21
+ 413: public_api_types_js_1.API_ERROR_CODE.PAYLOAD_TOO_LARGE,
22
+ 429: public_api_types_js_1.API_ERROR_CODE.RATE_LIMITED,
23
+ };
24
+ const apiSuccess = (requestId, body) => (0, response_helper_js_1.buildResponse)(200, { requestId, ...body }, { 'x-request-id': requestId });
25
+ exports.apiSuccess = apiSuccess;
26
+ const apiError = (requestId, code, message, details) => {
27
+ const error = details?.length ? { code, message, details } : { code, message };
28
+ return (0, response_helper_js_1.buildResponse)(STATUS_BY_CODE[code], { requestId, message, error }, { 'x-request-id': requestId });
29
+ };
30
+ exports.apiError = apiError;
31
+ const validationDetails = (error) => error.details.map((detail) => {
32
+ const index = detail.path.find((segment) => typeof segment === 'number');
33
+ const field = detail.path.filter((segment) => typeof segment === 'string').join('.') || undefined;
34
+ return { index, field, message: detail.message };
35
+ });
36
+ exports.validationDetails = validationDetails;
37
+ const apiErrorFromThrown = (requestId, error) => {
38
+ if (error instanceof http_error_js_1.HttpError) {
39
+ const code = CODE_BY_STATUS[error.statusCode] ?? public_api_types_js_1.API_ERROR_CODE.INTERNAL_ERROR;
40
+ const message = code === public_api_types_js_1.API_ERROR_CODE.INTERNAL_ERROR ? 'Internal server error.' : error.message;
41
+ return (0, exports.apiError)(requestId, code, message);
42
+ }
43
+ return (0, exports.apiError)(requestId, public_api_types_js_1.API_ERROR_CODE.INTERNAL_ERROR, 'Internal server error.');
44
+ };
45
+ exports.apiErrorFromThrown = apiErrorFromThrown;
46
+ //# sourceMappingURL=public-api-response-helper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"public-api-response-helper.js","sourceRoot":"","sources":["../../../src/helpers/public-api-response-helper.ts"],"names":[],"mappings":";;;AACA,yDAAkD;AAClD,sEAA8E;AAC9E,6DAAqD;AAErD,MAAM,cAAc,GAAmC;IACrD,CAAC,oCAAc,CAAC,gBAAgB,CAAC,EAAE,GAAG;IACtC,CAAC,oCAAc,CAAC,YAAY,CAAC,EAAE,GAAG;IAClC,CAAC,oCAAc,CAAC,SAAS,CAAC,EAAE,GAAG;IAC/B,CAAC,oCAAc,CAAC,SAAS,CAAC,EAAE,GAAG;IAC/B,CAAC,oCAAc,CAAC,iBAAiB,CAAC,EAAE,GAAG;IACvC,CAAC,oCAAc,CAAC,YAAY,CAAC,EAAE,GAAG;IAClC,CAAC,oCAAc,CAAC,cAAc,CAAC,EAAE,GAAG;CACrC,CAAC;AAEF,MAAM,cAAc,GAAmC;IACrD,GAAG,EAAE,oCAAc,CAAC,gBAAgB;IACpC,GAAG,EAAE,oCAAc,CAAC,YAAY;IAChC,GAAG,EAAE,oCAAc,CAAC,SAAS;IAC7B,GAAG,EAAE,oCAAc,CAAC,SAAS;IAC7B,GAAG,EAAE,oCAAc,CAAC,iBAAiB;IACrC,GAAG,EAAE,oCAAc,CAAC,YAAY;CACjC,CAAC;AAGK,MAAM,UAAU,GAAG,CAAmB,SAAiB,EAAE,IAAO,EAAE,EAAE,CACzE,IAAA,kCAAa,EAAC,GAAG,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,CAAC;AAD/D,QAAA,UAAU,cACqD;AAErE,MAAM,QAAQ,GAAG,CAAC,SAAiB,EAAE,IAAoB,EAAE,OAAe,EAAE,OAA0B,EAAE,EAAE;IAC/G,MAAM,KAAK,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAE/E,OAAO,IAAA,kCAAa,EAAC,cAAc,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,CAAC;AAC3G,CAAC,CAAC;AAJW,QAAA,QAAQ,YAInB;AAIK,MAAM,iBAAiB,GAAG,CAAC,KAAsB,EAAoB,EAAE,CAC5E,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;IAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAuB,CAAC;IAC/F,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC;IAClG,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;AACnD,CAAC,CAAC,CAAC;AALQ,QAAA,iBAAiB,qBAKzB;AAGE,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAE,KAAc,EAAE,EAAE;IACtE,IAAI,KAAK,YAAY,yBAAS,EAAE;QAC9B,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,oCAAc,CAAC,cAAc,CAAC;QAC/E,MAAM,OAAO,GAAG,IAAI,KAAK,oCAAc,CAAC,cAAc,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;QAClG,OAAO,IAAA,gBAAQ,EAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;KAC3C;IACD,OAAO,IAAA,gBAAQ,EAAC,SAAS,EAAE,oCAAc,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;AACtF,CAAC,CAAC;AAPW,QAAA,kBAAkB,sBAO7B"}
@@ -1,4 +1,5 @@
1
1
  export * from './internal-events/index.js';
2
2
  export * from './acuity-types.js';
3
+ export * from './public-api-types.js';
3
4
  import * as ShopifyRest from './shopify-rest-types.js';
4
5
  export { ShopifyRest };
@@ -29,6 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
29
29
  exports.ShopifyRest = void 0;
30
30
  __exportStar(require("./internal-events/index.js"), exports);
31
31
  __exportStar(require("./acuity-types.js"), exports);
32
+ __exportStar(require("./public-api-types.js"), exports);
32
33
  const ShopifyRest = __importStar(require("./shopify-rest-types.js"));
33
34
  exports.ShopifyRest = ShopifyRest;
34
35
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,oDAAkC;AAGlC,qEAAuD;AAC9C,kCAAW"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,oDAAkC;AAClC,wDAAsC;AAGtC,qEAAuD;AAC9C,kCAAW"}
@@ -0,0 +1,24 @@
1
+ export declare enum API_ERROR_CODE {
2
+ VALIDATION_ERROR = "VALIDATION_ERROR",
3
+ UNAUTHORIZED = "UNAUTHORIZED",
4
+ FORBIDDEN = "FORBIDDEN",
5
+ NOT_FOUND = "NOT_FOUND",
6
+ PAYLOAD_TOO_LARGE = "PAYLOAD_TOO_LARGE",
7
+ RATE_LIMITED = "RATE_LIMITED",
8
+ INTERNAL_ERROR = "INTERNAL_ERROR"
9
+ }
10
+ export interface ApiErrorDetail {
11
+ index?: number;
12
+ field?: string;
13
+ message: string;
14
+ }
15
+ export interface ApiError {
16
+ code: API_ERROR_CODE;
17
+ message: string;
18
+ details?: ApiErrorDetail[];
19
+ }
20
+ export interface ApiErrorResponse {
21
+ requestId: string;
22
+ message: string;
23
+ error: ApiError;
24
+ }
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.API_ERROR_CODE = void 0;
4
+ var API_ERROR_CODE;
5
+ (function (API_ERROR_CODE) {
6
+ API_ERROR_CODE["VALIDATION_ERROR"] = "VALIDATION_ERROR";
7
+ API_ERROR_CODE["UNAUTHORIZED"] = "UNAUTHORIZED";
8
+ API_ERROR_CODE["FORBIDDEN"] = "FORBIDDEN";
9
+ API_ERROR_CODE["NOT_FOUND"] = "NOT_FOUND";
10
+ API_ERROR_CODE["PAYLOAD_TOO_LARGE"] = "PAYLOAD_TOO_LARGE";
11
+ API_ERROR_CODE["RATE_LIMITED"] = "RATE_LIMITED";
12
+ API_ERROR_CODE["INTERNAL_ERROR"] = "INTERNAL_ERROR";
13
+ })(API_ERROR_CODE = exports.API_ERROR_CODE || (exports.API_ERROR_CODE = {}));
14
+ //# sourceMappingURL=public-api-types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"public-api-types.js","sourceRoot":"","sources":["../../../src/types/public-api-types.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAQX;AARD,WAAY,cAAc;IACxB,uDAAqC,CAAA;IACrC,+CAA6B,CAAA;IAC7B,yCAAuB,CAAA;IACvB,yCAAuB,CAAA;IACvB,yDAAuC,CAAA;IACvC,+CAA6B,CAAA;IAC7B,mDAAiC,CAAA;AACnC,CAAC,EARW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAQzB"}
@@ -0,0 +1,56 @@
1
+ import Joi from 'joi';
2
+ import { apiError, apiErrorFromThrown, apiSuccess, validationDetails } from '../../helpers/public-api-response-helper.js';
3
+ import { HttpError } from '../../libs/http-error.js';
4
+ import { API_ERROR_CODE } from '../../types/public-api-types.js';
5
+ const REQ = 'req_1';
6
+ describe('public-api-response-helper - unit', () => {
7
+ it('apiSuccess returns 200 with requestId, body, and x-request-id header', () => {
8
+ const res = apiSuccess(REQ, { eventsIngested: 3 });
9
+ expect(res.statusCode).toBe(200);
10
+ expect(JSON.parse(res.body)).toEqual({ requestId: REQ, eventsIngested: 3 });
11
+ expect(res.headers?.['x-request-id']).toBe(REQ);
12
+ });
13
+ it.each([
14
+ [API_ERROR_CODE.VALIDATION_ERROR, 400],
15
+ [API_ERROR_CODE.UNAUTHORIZED, 401],
16
+ [API_ERROR_CODE.FORBIDDEN, 403],
17
+ [API_ERROR_CODE.NOT_FOUND, 404],
18
+ [API_ERROR_CODE.PAYLOAD_TOO_LARGE, 413],
19
+ [API_ERROR_CODE.RATE_LIMITED, 429],
20
+ [API_ERROR_CODE.INTERNAL_ERROR, 500],
21
+ ])('apiError maps %s → HTTP %i with a uniform envelope', (code, status) => {
22
+ const res = apiError(REQ, code, 'boom');
23
+ const body = JSON.parse(res.body);
24
+ expect(res.statusCode).toBe(status);
25
+ expect(body).toEqual({ requestId: REQ, message: 'boom', error: { code, message: 'boom' } });
26
+ expect(res.headers?.['x-request-id']).toBe(REQ);
27
+ });
28
+ it('apiError includes details only when provided', () => {
29
+ const details = [{ index: 0, field: 'name', message: 'required' }];
30
+ const body = JSON.parse(apiError(REQ, API_ERROR_CODE.VALIDATION_ERROR, 'bad', details).body);
31
+ expect(body.error.details).toEqual(details);
32
+ });
33
+ it('validationDetails flattens Joi errors to {index, field, message}', () => {
34
+ const schema = Joi.object({ events: Joi.array().items(Joi.object({ name: Joi.string().required() })) });
35
+ const { error } = schema.validate({ events: [{}, {}] }, { abortEarly: false });
36
+ const details = validationDetails(error);
37
+ expect(details).toEqual(expect.arrayContaining([
38
+ expect.objectContaining({ index: 0, field: 'events.name' }),
39
+ expect.objectContaining({ index: 1, field: 'events.name' }),
40
+ ]));
41
+ });
42
+ it('apiErrorFromThrown maps an HttpError by status and exposes its message on 4xx', () => {
43
+ const res = apiErrorFromThrown(REQ, HttpError.forbidden('no scope'));
44
+ const body = JSON.parse(res.body);
45
+ expect(res.statusCode).toBe(403);
46
+ expect(body.error.code).toBe(API_ERROR_CODE.FORBIDDEN);
47
+ expect(body.message).toBe('no scope');
48
+ });
49
+ it('apiErrorFromThrown never leaks internals on unknown errors', () => {
50
+ const res = apiErrorFromThrown(REQ, new Error('secret stack detail'));
51
+ expect(res.statusCode).toBe(500);
52
+ expect(JSON.parse(res.body).error.code).toBe(API_ERROR_CODE.INTERNAL_ERROR);
53
+ expect(res.body).not.toContain('secret stack detail');
54
+ });
55
+ });
56
+ //# sourceMappingURL=public-api-response-helper.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"public-api-response-helper.spec.js","sourceRoot":"","sources":["../../../../src/__tests__/helpers/public-api-response-helper.spec.ts"],"names":[],"mappings":"AAGA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAC1H,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEjE,MAAM,GAAG,GAAG,OAAO,CAAC;AAEpB,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;IACjD,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC9E,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC;QAC5E,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,cAAc,CAAC,gBAAgB,EAAE,GAAG,CAAC;QACtC,CAAC,cAAc,CAAC,YAAY,EAAE,GAAG,CAAC;QAClC,CAAC,cAAc,CAAC,SAAS,EAAE,GAAG,CAAC;QAC/B,CAAC,cAAc,CAAC,SAAS,EAAE,GAAG,CAAC;QAC/B,CAAC,cAAc,CAAC,iBAAiB,EAAE,GAAG,CAAC;QACvC,CAAC,cAAc,CAAC,YAAY,EAAE,GAAG,CAAC;QAClC,CAAC,cAAc,CAAC,cAAc,EAAE,GAAG,CAAC;KACrC,CAAC,CAAC,oDAAoD,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;QACxE,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC5F,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,OAAO,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACnE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC,gBAAgB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;QAC7F,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC1E,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACxG,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/E,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAA4B,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CACrB,MAAM,CAAC,eAAe,CAAC;YACrB,MAAM,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;YAC3D,MAAM,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;SAC5D,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;QACvF,MAAM,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QACrE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;QAC5E,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1,6 +1,7 @@
1
1
  export * from './input-validation-helper.js';
2
2
  export * from './logging-helper.js';
3
3
  export * from './response-helper.js';
4
+ export * from './public-api-response-helper.js';
4
5
  export * from './shopify-helper.js';
5
6
  export * from './account-users-helper.js';
6
7
  export * from './sqs-utils.js';
@@ -1,6 +1,7 @@
1
1
  export * from './input-validation-helper.js';
2
2
  export * from './logging-helper.js';
3
3
  export * from './response-helper.js';
4
+ export * from './public-api-response-helper.js';
4
5
  export * from './shopify-helper.js';
5
6
  export * from './account-users-helper.js';
6
7
  export * from './sqs-utils.js';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iCAAiC,CAAC;AAChD,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC"}
@@ -0,0 +1,21 @@
1
+ import type { ValidationError } from 'joi';
2
+ import { API_ERROR_CODE, ApiErrorDetail } from '../types/public-api-types.js';
3
+ export declare const apiSuccess: <T extends object>(requestId: string, body: T) => {
4
+ statusCode: number;
5
+ headers: any;
6
+ multiValueHeaders: {};
7
+ body: string;
8
+ };
9
+ export declare const apiError: (requestId: string, code: API_ERROR_CODE, message: string, details?: ApiErrorDetail[]) => {
10
+ statusCode: number;
11
+ headers: any;
12
+ multiValueHeaders: {};
13
+ body: string;
14
+ };
15
+ export declare const validationDetails: (error: ValidationError) => ApiErrorDetail[];
16
+ export declare const apiErrorFromThrown: (requestId: string, error: unknown) => {
17
+ statusCode: number;
18
+ headers: any;
19
+ multiValueHeaders: {};
20
+ body: string;
21
+ };
@@ -0,0 +1,39 @@
1
+ import { HttpError } from '../libs/http-error.js';
2
+ import { API_ERROR_CODE } from '../types/public-api-types.js';
3
+ import { buildResponse } from './response-helper.js';
4
+ const STATUS_BY_CODE = {
5
+ [API_ERROR_CODE.VALIDATION_ERROR]: 400,
6
+ [API_ERROR_CODE.UNAUTHORIZED]: 401,
7
+ [API_ERROR_CODE.FORBIDDEN]: 403,
8
+ [API_ERROR_CODE.NOT_FOUND]: 404,
9
+ [API_ERROR_CODE.PAYLOAD_TOO_LARGE]: 413,
10
+ [API_ERROR_CODE.RATE_LIMITED]: 429,
11
+ [API_ERROR_CODE.INTERNAL_ERROR]: 500,
12
+ };
13
+ const CODE_BY_STATUS = {
14
+ 400: API_ERROR_CODE.VALIDATION_ERROR,
15
+ 401: API_ERROR_CODE.UNAUTHORIZED,
16
+ 403: API_ERROR_CODE.FORBIDDEN,
17
+ 404: API_ERROR_CODE.NOT_FOUND,
18
+ 413: API_ERROR_CODE.PAYLOAD_TOO_LARGE,
19
+ 429: API_ERROR_CODE.RATE_LIMITED,
20
+ };
21
+ export const apiSuccess = (requestId, body) => buildResponse(200, { requestId, ...body }, { 'x-request-id': requestId });
22
+ export const apiError = (requestId, code, message, details) => {
23
+ const error = details?.length ? { code, message, details } : { code, message };
24
+ return buildResponse(STATUS_BY_CODE[code], { requestId, message, error }, { 'x-request-id': requestId });
25
+ };
26
+ export const validationDetails = (error) => error.details.map((detail) => {
27
+ const index = detail.path.find((segment) => typeof segment === 'number');
28
+ const field = detail.path.filter((segment) => typeof segment === 'string').join('.') || undefined;
29
+ return { index, field, message: detail.message };
30
+ });
31
+ export const apiErrorFromThrown = (requestId, error) => {
32
+ if (error instanceof HttpError) {
33
+ const code = CODE_BY_STATUS[error.statusCode] ?? API_ERROR_CODE.INTERNAL_ERROR;
34
+ const message = code === API_ERROR_CODE.INTERNAL_ERROR ? 'Internal server error.' : error.message;
35
+ return apiError(requestId, code, message);
36
+ }
37
+ return apiError(requestId, API_ERROR_CODE.INTERNAL_ERROR, 'Internal server error.');
38
+ };
39
+ //# sourceMappingURL=public-api-response-helper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"public-api-response-helper.js","sourceRoot":"","sources":["../../../src/helpers/public-api-response-helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAkB,MAAM,8BAA8B,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,MAAM,cAAc,GAAmC;IACrD,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE,GAAG;IACtC,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,GAAG;IAClC,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,GAAG;IAC/B,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,GAAG;IAC/B,CAAC,cAAc,CAAC,iBAAiB,CAAC,EAAE,GAAG;IACvC,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,GAAG;IAClC,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,GAAG;CACrC,CAAC;AAEF,MAAM,cAAc,GAAmC;IACrD,GAAG,EAAE,cAAc,CAAC,gBAAgB;IACpC,GAAG,EAAE,cAAc,CAAC,YAAY;IAChC,GAAG,EAAE,cAAc,CAAC,SAAS;IAC7B,GAAG,EAAE,cAAc,CAAC,SAAS;IAC7B,GAAG,EAAE,cAAc,CAAC,iBAAiB;IACrC,GAAG,EAAE,cAAc,CAAC,YAAY;CACjC,CAAC;AAGF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAmB,SAAiB,EAAE,IAAO,EAAE,EAAE,CACzE,aAAa,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,CAAC;AAE5E,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,SAAiB,EAAE,IAAoB,EAAE,OAAe,EAAE,OAA0B,EAAE,EAAE;IAC/G,MAAM,KAAK,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAE/E,OAAO,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,CAAC;AAC3G,CAAC,CAAC;AAIF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAsB,EAAoB,EAAE,CAC5E,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;IAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAuB,CAAC;IAC/F,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC;IAClG,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;AACnD,CAAC,CAAC,CAAC;AAGL,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAE,KAAc,EAAE,EAAE;IACtE,IAAI,KAAK,YAAY,SAAS,EAAE;QAC9B,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,cAAc,CAAC,cAAc,CAAC;QAC/E,MAAM,OAAO,GAAG,IAAI,KAAK,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;QAClG,OAAO,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;KAC3C;IACD,OAAO,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;AACtF,CAAC,CAAC"}
@@ -1,4 +1,5 @@
1
1
  export * from './internal-events/index.js';
2
2
  export * from './acuity-types.js';
3
+ export * from './public-api-types.js';
3
4
  import * as ShopifyRest from './shopify-rest-types.js';
4
5
  export { ShopifyRest };
@@ -1,5 +1,6 @@
1
1
  export * from './internal-events/index.js';
2
2
  export * from './acuity-types.js';
3
+ export * from './public-api-types.js';
3
4
  import * as ShopifyRest from './shopify-rest-types.js';
4
5
  export { ShopifyRest };
5
6
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAGlC,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AAGtC,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,CAAC"}
@@ -0,0 +1,24 @@
1
+ export declare enum API_ERROR_CODE {
2
+ VALIDATION_ERROR = "VALIDATION_ERROR",
3
+ UNAUTHORIZED = "UNAUTHORIZED",
4
+ FORBIDDEN = "FORBIDDEN",
5
+ NOT_FOUND = "NOT_FOUND",
6
+ PAYLOAD_TOO_LARGE = "PAYLOAD_TOO_LARGE",
7
+ RATE_LIMITED = "RATE_LIMITED",
8
+ INTERNAL_ERROR = "INTERNAL_ERROR"
9
+ }
10
+ export interface ApiErrorDetail {
11
+ index?: number;
12
+ field?: string;
13
+ message: string;
14
+ }
15
+ export interface ApiError {
16
+ code: API_ERROR_CODE;
17
+ message: string;
18
+ details?: ApiErrorDetail[];
19
+ }
20
+ export interface ApiErrorResponse {
21
+ requestId: string;
22
+ message: string;
23
+ error: ApiError;
24
+ }
@@ -0,0 +1,11 @@
1
+ export var API_ERROR_CODE;
2
+ (function (API_ERROR_CODE) {
3
+ API_ERROR_CODE["VALIDATION_ERROR"] = "VALIDATION_ERROR";
4
+ API_ERROR_CODE["UNAUTHORIZED"] = "UNAUTHORIZED";
5
+ API_ERROR_CODE["FORBIDDEN"] = "FORBIDDEN";
6
+ API_ERROR_CODE["NOT_FOUND"] = "NOT_FOUND";
7
+ API_ERROR_CODE["PAYLOAD_TOO_LARGE"] = "PAYLOAD_TOO_LARGE";
8
+ API_ERROR_CODE["RATE_LIMITED"] = "RATE_LIMITED";
9
+ API_ERROR_CODE["INTERNAL_ERROR"] = "INTERNAL_ERROR";
10
+ })(API_ERROR_CODE || (API_ERROR_CODE = {}));
11
+ //# sourceMappingURL=public-api-types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"public-api-types.js","sourceRoot":"","sources":["../../../src/types/public-api-types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,cAQX;AARD,WAAY,cAAc;IACxB,uDAAqC,CAAA;IACrC,+CAA6B,CAAA;IAC7B,yCAAuB,CAAA;IACvB,yCAAuB,CAAA;IACvB,yDAAuC,CAAA;IACvC,+CAA6B,CAAA;IAC7B,mDAAiC,CAAA;AACnC,CAAC,EARW,cAAc,KAAd,cAAc,QAQzB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adtrackify/at-service-common",
3
- "version": "4.0.23",
3
+ "version": "4.0.24",
4
4
  "description": "",
5
5
  "files": [
6
6
  "dist/*"