@heavybit/ecommerce-contracts 0.2.1 → 0.2.2
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.
package/README.md
CHANGED
|
@@ -53,7 +53,7 @@ it to the published range (`^2.7.1` or later) when shared-lib is published. Jest
|
|
|
53
53
|
## Identity and step-up (`src/identity.ts`)
|
|
54
54
|
|
|
55
55
|
- `ecommerceIdentityProtocol`: domain `ecommerce-gateway-identity:v2`; signed company headers
|
|
56
|
-
`x-company-id` → `AuthUser.scopes.company` and `x-company-slug` → `AuthUser.attrs.companySlug
|
|
56
|
+
`x-company-id` → `AuthUser.scopes.company` and `x-company-slug` → `AuthUser.attrs.companySlug` and `x-company-status` → `AuthUser.attrs.companyStatus` (D22).
|
|
57
57
|
The gateway signs with it; every service passes it to `authenticateFromGateway({ protocol })`.
|
|
58
58
|
- `ecommerceStepUpScopes` (§6.4): `role-assign`*, `role-permissions`, `staff-remove`, `payment-config`*,
|
|
59
59
|
`payout-destination`*, `refund-large`, `customer-export`, `domain-change`*, `company-close`*,
|
package/dist/cjs/identity.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ecommerceStepUpScopes = exports.ecommerceIdentityProtocol = exports.COMPANY_SLUG_HEADER = exports.COMPANY_ID_HEADER = exports.GATEWAY_IDENTITY_DOMAIN = void 0;
|
|
3
|
+
exports.ecommerceStepUpScopes = exports.ecommerceIdentityProtocol = exports.COMPANY_STATUS_HEADER = exports.COMPANY_SLUG_HEADER = exports.COMPANY_ID_HEADER = exports.GATEWAY_IDENTITY_DOMAIN = void 0;
|
|
4
4
|
/**
|
|
5
5
|
* E-commerce bindings of the shared-lib gateway identity protocol and step-up catalogue (deferred here
|
|
6
6
|
* from Prompt 1.3). The gateway signs with {@link ecommerceIdentityProtocol}; services verify with it.
|
|
@@ -13,15 +13,17 @@ exports.GATEWAY_IDENTITY_DOMAIN = 'ecommerce-gateway-identity:v2';
|
|
|
13
13
|
exports.COMPANY_ID_HEADER = 'x-company-id';
|
|
14
14
|
/** Header carrying the active company slug (signed). Maps to `AuthUser.attrs.companySlug`. */
|
|
15
15
|
exports.COMPANY_SLUG_HEADER = 'x-company-slug';
|
|
16
|
+
/** Header carrying the active company's lifecycle status (signed, D22). Maps to `AuthUser.attrs.companyStatus`. */
|
|
17
|
+
exports.COMPANY_STATUS_HEADER = 'x-company-status';
|
|
16
18
|
/**
|
|
17
|
-
* The app's identity protocol: generic identity headers plus the signed company headers.
|
|
19
|
+
* The app's identity protocol: generic identity headers plus the signed company headers (id, slug, status).
|
|
18
20
|
*
|
|
19
21
|
* @example app.use(authenticateFromGateway({ protocol: ecommerceIdentityProtocol, secret: config.GATEWAY_SIGNING_SECRET }))
|
|
20
22
|
*/
|
|
21
23
|
exports.ecommerceIdentityProtocol = (0, shared_lib_1.defineIdentityProtocol)({
|
|
22
24
|
domain: exports.GATEWAY_IDENTITY_DOMAIN,
|
|
23
25
|
scopeHeaders: { [scopes_js_1.COMPANY_SCOPE_KEY]: exports.COMPANY_ID_HEADER },
|
|
24
|
-
attrHeaders: { companySlug: exports.COMPANY_SLUG_HEADER },
|
|
26
|
+
attrHeaders: { companySlug: exports.COMPANY_SLUG_HEADER, companyStatus: exports.COMPANY_STATUS_HEADER },
|
|
25
27
|
});
|
|
26
28
|
/**
|
|
27
29
|
* Step-up scopes (§6.4). `singleUse` proofs are consumed by the gateway on first use. Each sensitive
|
package/dist/cjs/identity.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/identity.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,qDAAkF;AAClF,2CAAgD;AAEhD,gFAAgF;AACnE,QAAA,uBAAuB,GAAG,+BAAwC,CAAC;AAEhF,yFAAyF;AAC5E,QAAA,iBAAiB,GAAG,cAAuB,CAAC;AACzD,8FAA8F;AACjF,QAAA,mBAAmB,GAAG,gBAAyB,CAAC;AAE7D;;;;GAIG;AACU,QAAA,yBAAyB,GAAG,IAAA,mCAAsB,EAAC;IAC9D,MAAM,EAAE,+BAAuB;IAC/B,YAAY,EAAE,EAAE,CAAC,6BAAiB,CAAC,EAAE,yBAAiB,EAAE;IACxD,WAAW,EAAE,EAAE,WAAW,EAAE,2BAAmB,EAAE;
|
|
1
|
+
{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/identity.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,qDAAkF;AAClF,2CAAgD;AAEhD,gFAAgF;AACnE,QAAA,uBAAuB,GAAG,+BAAwC,CAAC;AAEhF,yFAAyF;AAC5E,QAAA,iBAAiB,GAAG,cAAuB,CAAC;AACzD,8FAA8F;AACjF,QAAA,mBAAmB,GAAG,gBAAyB,CAAC;AAE7D,mHAAmH;AACtG,QAAA,qBAAqB,GAAG,kBAA2B,CAAC;AAEjE;;;;GAIG;AACU,QAAA,yBAAyB,GAAG,IAAA,mCAAsB,EAAC;IAC9D,MAAM,EAAE,+BAAuB;IAC/B,YAAY,EAAE,EAAE,CAAC,6BAAiB,CAAC,EAAE,yBAAiB,EAAE;IACxD,WAAW,EAAE,EAAE,WAAW,EAAE,2BAAmB,EAAE,aAAa,EAAE,6BAAqB,EAAE;CACxF,CAAC,CAAC;AAEH;;;;;GAKG;AACU,QAAA,qBAAqB,GAAG,IAAA,+BAAkB,EAAC;IACtD,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,yBAAyB,EAAE;IAC1E,kBAAkB,EAAE,EAAE,WAAW,EAAE,kCAAkC,EAAE;IACvE,cAAc,EAAE,EAAE,WAAW,EAAE,uBAAuB,EAAE;IACxD,gBAAgB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,kCAAkC,EAAE;IACtF,oBAAoB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,+BAA+B,EAAE;IACvF,cAAc,EAAE,EAAE,WAAW,EAAE,yCAAyC,EAAE;IAC1E,iBAAiB,EAAE,EAAE,WAAW,EAAE,sBAAsB,EAAE;IAC1D,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,sBAAsB,EAAE;IACzE,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,iBAAiB,EAAE;IACpE,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE;IACrE,iBAAiB,EAAE,EAAE,WAAW,EAAE,yCAAyC,EAAE;IAC7E,gBAAgB,EAAE,EAAE,WAAW,EAAE,4CAA4C,EAAE;IAC/E,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,4CAA4C,EAAE;IAC/F,gBAAgB,EAAE,EAAE,WAAW,EAAE,6CAA6C,EAAE;IAChF,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,mCAAmC,EAAE;IACtF,YAAY,EAAE,EAAE,WAAW,EAAE,0CAA0C,EAAE;CAC1E,CAAC,CAAC"}
|
package/dist/esm/identity.js
CHANGED
|
@@ -10,15 +10,17 @@ export const GATEWAY_IDENTITY_DOMAIN = 'ecommerce-gateway-identity:v2';
|
|
|
10
10
|
export const COMPANY_ID_HEADER = 'x-company-id';
|
|
11
11
|
/** Header carrying the active company slug (signed). Maps to `AuthUser.attrs.companySlug`. */
|
|
12
12
|
export const COMPANY_SLUG_HEADER = 'x-company-slug';
|
|
13
|
+
/** Header carrying the active company's lifecycle status (signed, D22). Maps to `AuthUser.attrs.companyStatus`. */
|
|
14
|
+
export const COMPANY_STATUS_HEADER = 'x-company-status';
|
|
13
15
|
/**
|
|
14
|
-
* The app's identity protocol: generic identity headers plus the signed company headers.
|
|
16
|
+
* The app's identity protocol: generic identity headers plus the signed company headers (id, slug, status).
|
|
15
17
|
*
|
|
16
18
|
* @example app.use(authenticateFromGateway({ protocol: ecommerceIdentityProtocol, secret: config.GATEWAY_SIGNING_SECRET }))
|
|
17
19
|
*/
|
|
18
20
|
export const ecommerceIdentityProtocol = defineIdentityProtocol({
|
|
19
21
|
domain: GATEWAY_IDENTITY_DOMAIN,
|
|
20
22
|
scopeHeaders: { [COMPANY_SCOPE_KEY]: COMPANY_ID_HEADER },
|
|
21
|
-
attrHeaders: { companySlug: COMPANY_SLUG_HEADER },
|
|
23
|
+
attrHeaders: { companySlug: COMPANY_SLUG_HEADER, companyStatus: COMPANY_STATUS_HEADER },
|
|
22
24
|
});
|
|
23
25
|
/**
|
|
24
26
|
* Step-up scopes (§6.4). `singleUse` proofs are consumed by the gateway on first use. Each sensitive
|
package/dist/esm/identity.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/identity.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAClF,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,gFAAgF;AAChF,MAAM,CAAC,MAAM,uBAAuB,GAAG,+BAAwC,CAAC;AAEhF,yFAAyF;AACzF,MAAM,CAAC,MAAM,iBAAiB,GAAG,cAAuB,CAAC;AACzD,8FAA8F;AAC9F,MAAM,CAAC,MAAM,mBAAmB,GAAG,gBAAyB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,sBAAsB,CAAC;IAC9D,MAAM,EAAE,uBAAuB;IAC/B,YAAY,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,EAAE;IACxD,WAAW,EAAE,EAAE,WAAW,EAAE,mBAAmB,EAAE;
|
|
1
|
+
{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/identity.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAClF,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,gFAAgF;AAChF,MAAM,CAAC,MAAM,uBAAuB,GAAG,+BAAwC,CAAC;AAEhF,yFAAyF;AACzF,MAAM,CAAC,MAAM,iBAAiB,GAAG,cAAuB,CAAC;AACzD,8FAA8F;AAC9F,MAAM,CAAC,MAAM,mBAAmB,GAAG,gBAAyB,CAAC;AAE7D,mHAAmH;AACnH,MAAM,CAAC,MAAM,qBAAqB,GAAG,kBAA2B,CAAC;AAEjE;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,sBAAsB,CAAC;IAC9D,MAAM,EAAE,uBAAuB;IAC/B,YAAY,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,EAAE;IACxD,WAAW,EAAE,EAAE,WAAW,EAAE,mBAAmB,EAAE,aAAa,EAAE,qBAAqB,EAAE;CACxF,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,kBAAkB,CAAC;IACtD,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,yBAAyB,EAAE;IAC1E,kBAAkB,EAAE,EAAE,WAAW,EAAE,kCAAkC,EAAE;IACvE,cAAc,EAAE,EAAE,WAAW,EAAE,uBAAuB,EAAE;IACxD,gBAAgB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,kCAAkC,EAAE;IACtF,oBAAoB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,+BAA+B,EAAE;IACvF,cAAc,EAAE,EAAE,WAAW,EAAE,yCAAyC,EAAE;IAC1E,iBAAiB,EAAE,EAAE,WAAW,EAAE,sBAAsB,EAAE;IAC1D,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,sBAAsB,EAAE;IACzE,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,iBAAiB,EAAE;IACpE,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE;IACrE,iBAAiB,EAAE,EAAE,WAAW,EAAE,yCAAyC,EAAE;IAC7E,gBAAgB,EAAE,EAAE,WAAW,EAAE,4CAA4C,EAAE;IAC/E,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,4CAA4C,EAAE;IAC/F,gBAAgB,EAAE,EAAE,WAAW,EAAE,6CAA6C,EAAE;IAChF,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,mCAAmC,EAAE;IACtF,YAAY,EAAE,EAAE,WAAW,EAAE,0CAA0C,EAAE;CAC1E,CAAC,CAAC"}
|
package/dist/types/identity.d.ts
CHANGED
|
@@ -4,8 +4,10 @@ export declare const GATEWAY_IDENTITY_DOMAIN: "ecommerce-gateway-identity:v2";
|
|
|
4
4
|
export declare const COMPANY_ID_HEADER: "x-company-id";
|
|
5
5
|
/** Header carrying the active company slug (signed). Maps to `AuthUser.attrs.companySlug`. */
|
|
6
6
|
export declare const COMPANY_SLUG_HEADER: "x-company-slug";
|
|
7
|
+
/** Header carrying the active company's lifecycle status (signed, D22). Maps to `AuthUser.attrs.companyStatus`. */
|
|
8
|
+
export declare const COMPANY_STATUS_HEADER: "x-company-status";
|
|
7
9
|
/**
|
|
8
|
-
* The app's identity protocol: generic identity headers plus the signed company headers.
|
|
10
|
+
* The app's identity protocol: generic identity headers plus the signed company headers (id, slug, status).
|
|
9
11
|
*
|
|
10
12
|
* @example app.use(authenticateFromGateway({ protocol: ecommerceIdentityProtocol, secret: config.GATEWAY_SIGNING_SECRET }))
|
|
11
13
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../../src/identity.ts"],"names":[],"mappings":"AAOA,gFAAgF;AAChF,eAAO,MAAM,uBAAuB,EAAG,+BAAwC,CAAC;AAEhF,yFAAyF;AACzF,eAAO,MAAM,iBAAiB,EAAG,cAAuB,CAAC;AACzD,8FAA8F;AAC9F,eAAO,MAAM,mBAAmB,EAAG,gBAAyB,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,iDAIpC,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,yXAiBhC,CAAC;AAEH,8BAA8B;AAC9B,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,qBAAqB,CAAC"}
|
|
1
|
+
{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../../src/identity.ts"],"names":[],"mappings":"AAOA,gFAAgF;AAChF,eAAO,MAAM,uBAAuB,EAAG,+BAAwC,CAAC;AAEhF,yFAAyF;AACzF,eAAO,MAAM,iBAAiB,EAAG,cAAuB,CAAC;AACzD,8FAA8F;AAC9F,eAAO,MAAM,mBAAmB,EAAG,gBAAyB,CAAC;AAE7D,mHAAmH;AACnH,eAAO,MAAM,qBAAqB,EAAG,kBAA2B,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,iDAIpC,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,yXAiBhC,CAAC;AAEH,8BAA8B;AAC9B,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,qBAAqB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@heavybit/ecommerce-contracts",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "The e-commerce app's shared contracts: app settings, identity and scope bindings, step-up scopes, event catalogue and v1 payload schemas. Built on @heavybit/shared-lib; no business logic.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|