@eventcatalog/core 0.1.3 → 0.1.7
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/.next/BUILD_ID +1 -1
- package/.next/build-manifest.json +14 -14
- package/.next/cache/.tsbuildinfo +1 -1
- package/.next/cache/config.json +3 -3
- package/.next/cache/eslint/.cache_1bay4w0 +1 -1
- package/.next/cache/next-server.js.nft.json +1 -1
- package/.next/cache/webpack/client-production/0.pack +0 -0
- package/.next/cache/webpack/client-production/index.pack +0 -0
- package/.next/cache/webpack/server-production/0.pack +0 -0
- package/.next/cache/webpack/server-production/index.pack +0 -0
- package/.next/next-server.js.nft.json +1 -1
- package/.next/prerender-manifest.json +1 -1
- package/.next/routes-manifest.json +1 -1
- package/.next/server/chunks/565.js +77 -21
- package/.next/server/chunks/944.js +3 -0
- package/.next/server/pages/404.html +1 -1
- package/.next/server/pages/500.html +1 -1
- package/.next/server/pages/_app.js +1 -1
- package/.next/server/pages/events/AddedItemToCart/logs.html +1 -1
- package/.next/server/pages/events/AddedItemToCart/v/0.0.1.html +15 -5
- package/.next/server/pages/events/AddedItemToCart/v/0.0.1.json +1 -1
- package/.next/server/pages/events/AddedItemToCart/v/0.0.2.html +15 -5
- package/.next/server/pages/events/AddedItemToCart/v/0.0.2.json +1 -1
- package/.next/server/pages/events/AddedItemToCart.html +15 -5
- package/.next/server/pages/events/AddedItemToCart.json +1 -1
- package/.next/server/pages/events/OrderComplete/logs.html +1 -1
- package/.next/server/pages/events/OrderComplete.html +15 -5
- package/.next/server/pages/events/OrderComplete.json +1 -1
- package/.next/server/pages/events/OrderConfirmed/logs.html +1 -1
- package/.next/server/pages/events/OrderConfirmed.html +15 -5
- package/.next/server/pages/events/OrderConfirmed.json +1 -1
- package/.next/server/pages/events/OrderRequested/logs.html +1 -1
- package/.next/server/pages/events/OrderRequested.html +15 -5
- package/.next/server/pages/events/OrderRequested.json +1 -1
- package/.next/server/pages/events/PaymentProcessed/logs.html +1 -1
- package/.next/server/pages/events/PaymentProcessed.html +15 -5
- package/.next/server/pages/events/PaymentProcessed.json +1 -1
- package/.next/server/pages/events/RemovedItemFromCart/logs.html +1 -1
- package/.next/server/pages/events/RemovedItemFromCart.html +15 -5
- package/.next/server/pages/events/RemovedItemFromCart.json +1 -1
- package/.next/server/pages/events/ShipmentDelivered/logs.html +1 -1
- package/.next/server/pages/events/ShipmentDelivered.html +17 -6
- package/.next/server/pages/events/ShipmentDelivered.json +1 -1
- package/.next/server/pages/events/ShipmentDispatched/logs.html +1 -1
- package/.next/server/pages/events/ShipmentDispatched.html +15 -5
- package/.next/server/pages/events/ShipmentDispatched.json +1 -1
- package/.next/server/pages/events/ShipmentPrepared/logs.html +1 -1
- package/.next/server/pages/events/ShipmentPrepared.html +15 -5
- package/.next/server/pages/events/ShipmentPrepared.json +1 -1
- package/.next/server/pages/events/[name]/v/[version].js +1 -1
- package/.next/server/pages/events/[name]/v/[version].js.nft.json +1 -1
- package/.next/server/pages/events/[name].js +1 -1
- package/.next/server/pages/events/[name].js.nft.json +1 -1
- package/.next/server/pages/events.html +2 -2
- package/.next/server/pages/events.js +16 -3
- package/.next/server/pages/events.js.nft.json +1 -1
- package/.next/server/pages/index.html +1 -1
- package/.next/server/pages/overview.html +1 -1
- package/.next/server/pages/overview.js +13 -7
- package/.next/server/pages/overview.js.nft.json +1 -1
- package/.next/server/pages/services/Basket Service.html +16 -5
- package/.next/server/pages/services/Basket Service.json +1 -1
- package/.next/server/pages/services/Data Lake.html +18 -6
- package/.next/server/pages/services/Data Lake.json +1 -1
- package/.next/server/pages/services/Payment Service.html +14 -4
- package/.next/server/pages/services/Payment Service.json +1 -1
- package/.next/server/pages/services/Shipping Service.html +22 -8
- package/.next/server/pages/services/Shipping Service.json +1 -1
- package/.next/server/pages/services/[name].js +15 -3
- package/.next/server/pages/services/[name].js.nft.json +1 -1
- package/.next/server/pages/services.html +2 -2
- package/.next/server/pages/services.js +16 -3
- package/.next/server/pages/services.js.nft.json +1 -1
- package/.next/server/pages/users/[id].js +8 -1
- package/.next/server/pages/users/[id].js.nft.json +1 -1
- package/.next/server/pages/users/dboyne.html +2 -2
- package/.next/server/pages/users/mSmith.html +2 -2
- package/.next/static/chunks/336-b1acb0b6aa306baf.js +1 -0
- package/.next/static/chunks/{873-8db237ddb872ef2b.js → 873-b2f75ede9cf9538c.js} +1 -1
- package/.next/static/chunks/pages/_app-151e9a6aaffc086e.js +1 -0
- package/.next/static/chunks/pages/events-c9e5a0fa7d23d620.js +1 -0
- package/{out/_next/static/chunks/pages/overview-6bd5a86d5a28a942.js → .next/static/chunks/pages/overview-44ba3c19ae643475.js} +1 -1
- package/.next/static/chunks/pages/services/[name]-d8873d29190a6447.js +1 -0
- package/.next/static/chunks/pages/services-30e4132ef02b1784.js +1 -0
- package/.next/static/chunks/pages/users/[id]-a4274bfad4d9a9ec.js +1 -0
- package/.next/static/muqmp6UkJzlet500sAKkA/_buildManifest.js +1 -0
- package/.next/static/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/_middlewareManifest.js +0 -0
- package/.next/static/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/_ssgManifest.js +0 -0
- package/.next/trace +37 -37
- package/CHANGELOG.md +26 -0
- package/README.md +1 -1
- package/bin/eventcatalog.js +2 -1
- package/components/Header.tsx +1 -1
- package/lib/__tests__/graphs.spec.ts +33 -7
- package/lib/graphs.ts +70 -23
- package/out/404.html +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/AddedItemToCart/logs.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/AddedItemToCart/v/0.0.1.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/AddedItemToCart/v/0.0.2.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/AddedItemToCart.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/OrderComplete/logs.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/OrderComplete.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/OrderConfirmed/logs.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/OrderConfirmed.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/OrderRequested/logs.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/OrderRequested.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/PaymentProcessed/logs.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/PaymentProcessed.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/RemovedItemFromCart/logs.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/RemovedItemFromCart.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/ShipmentDelivered/logs.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/ShipmentDelivered.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/ShipmentDispatched/logs.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/ShipmentDispatched.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/ShipmentPrepared/logs.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/ShipmentPrepared.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/overview.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/services/Basket Service.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/services/Data Lake.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/services/Payment Service.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/services/Shipping Service.json +1 -1
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/services.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/users/dboyne.json +0 -0
- package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/users/mSmith.json +0 -0
- package/out/_next/static/chunks/336-b1acb0b6aa306baf.js +1 -0
- package/out/_next/static/chunks/{873-8db237ddb872ef2b.js → 873-b2f75ede9cf9538c.js} +1 -1
- package/out/_next/static/chunks/pages/_app-151e9a6aaffc086e.js +1 -0
- package/out/_next/static/chunks/pages/events-c9e5a0fa7d23d620.js +1 -0
- package/{.next/static/chunks/pages/overview-6bd5a86d5a28a942.js → out/_next/static/chunks/pages/overview-44ba3c19ae643475.js} +1 -1
- package/out/_next/static/chunks/pages/services/[name]-d8873d29190a6447.js +1 -0
- package/out/_next/static/chunks/pages/services-30e4132ef02b1784.js +1 -0
- package/out/_next/static/chunks/pages/users/[id]-a4274bfad4d9a9ec.js +1 -0
- package/out/_next/static/muqmp6UkJzlet500sAKkA/_buildManifest.js +1 -0
- package/out/_next/static/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/_middlewareManifest.js +0 -0
- package/out/_next/static/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/_ssgManifest.js +0 -0
- package/out/events/AddedItemToCart/logs.html +1 -1
- package/out/events/AddedItemToCart/v/0.0.1.html +15 -5
- package/out/events/AddedItemToCart/v/0.0.2.html +15 -5
- package/out/events/AddedItemToCart.html +15 -5
- package/out/events/OrderComplete/logs.html +1 -1
- package/out/events/OrderComplete.html +15 -5
- package/out/events/OrderConfirmed/logs.html +1 -1
- package/out/events/OrderConfirmed.html +15 -5
- package/out/events/OrderRequested/logs.html +1 -1
- package/out/events/OrderRequested.html +15 -5
- package/out/events/PaymentProcessed/logs.html +1 -1
- package/out/events/PaymentProcessed.html +15 -5
- package/out/events/RemovedItemFromCart/logs.html +1 -1
- package/out/events/RemovedItemFromCart.html +15 -5
- package/out/events/ShipmentDelivered/logs.html +1 -1
- package/out/events/ShipmentDelivered.html +17 -6
- package/out/events/ShipmentDispatched/logs.html +1 -1
- package/out/events/ShipmentDispatched.html +15 -5
- package/out/events/ShipmentPrepared/logs.html +1 -1
- package/out/events/ShipmentPrepared.html +15 -5
- package/out/events.html +2 -2
- package/out/index.html +1 -1
- package/out/overview.html +1 -1
- package/out/services/Basket Service.html +16 -5
- package/out/services/Data Lake.html +18 -6
- package/out/services/Payment Service.html +14 -4
- package/out/services/Shipping Service.html +22 -8
- package/out/services.html +2 -2
- package/out/users/dboyne.html +2 -2
- package/out/users/mSmith.html +2 -2
- package/package.json +1 -1
- package/pages/events/[name].tsx +3 -2
- package/pages/events.tsx +3 -1
- package/pages/overview.tsx +15 -7
- package/pages/services/[name].tsx +6 -2
- package/pages/services.tsx +3 -1
- package/.next/static/-JRVlr_KvNJLo7NqAt8Bj/_buildManifest.js +0 -1
- package/.next/static/chunks/336-8b7da71a40e0c439.js +0 -1
- package/.next/static/chunks/pages/_app-2b86b0fb5ed8c085.js +0 -1
- package/.next/static/chunks/pages/events-2bca09b458bde8ab.js +0 -1
- package/.next/static/chunks/pages/services/[name]-78378d531eb27bc2.js +0 -1
- package/.next/static/chunks/pages/services-1293e4d7df6174bf.js +0 -1
- package/.next/static/chunks/pages/users/[id]-5374b99d99fe576e.js +0 -1
- package/out/_next/static/-JRVlr_KvNJLo7NqAt8Bj/_buildManifest.js +0 -1
- package/out/_next/static/chunks/336-8b7da71a40e0c439.js +0 -1
- package/out/_next/static/chunks/pages/_app-2b86b0fb5ed8c085.js +0 -1
- package/out/_next/static/chunks/pages/events-2bca09b458bde8ab.js +0 -1
- package/out/_next/static/chunks/pages/services/[name]-78378d531eb27bc2.js +0 -1
- package/out/_next/static/chunks/pages/services-1293e4d7df6174bf.js +0 -1
- package/out/_next/static/chunks/pages/users/[id]-5374b99d99fe576e.js +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# @eventcatalog/core
|
|
2
2
|
|
|
3
|
+
## 0.1.7
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`740c504`](https://github.com/boyney123/eventcatalog/commit/740c5041f033aff975a7ce89e99b3722b271e2b3) [#154](https://github.com/boyney123/eventcatalog/pull/154) Thanks [@boyney123](https://github.com/boyney123)! - fix: trying to fix npm versions problem
|
|
8
|
+
|
|
9
|
+
## 0.1.6
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`00e3c89`](https://github.com/boyney123/eventcatalog/commit/00e3c898ca8bf72bd563d246d6a2ee8620dd8284) [#143](https://github.com/boyney123/eventcatalog/pull/143) Thanks [@thim81](https://github.com/thim81)! - feat: mermaid name and link
|
|
14
|
+
|
|
15
|
+
* [`b4774fb`](https://github.com/boyney123/eventcatalog/commit/b4774fbf9773e66e1f85d71e99992e699833bf99) [#141](https://github.com/boyney123/eventcatalog/pull/141) Thanks [@thim81](https://github.com/thim81)! - bug: use title when setting page title
|
|
16
|
+
|
|
17
|
+
## 0.1.5
|
|
18
|
+
|
|
19
|
+
### Patch Changes
|
|
20
|
+
|
|
21
|
+
- [`1975995`](https://github.com/boyney123/eventcatalog/commit/1975995e2a77662742e8f7d95b827ff3cb0e4ac2) [#136](https://github.com/boyney123/eventcatalog/pull/136) Thanks [@boyney123](https://github.com/boyney123)! - fix: header link now goes to landing page
|
|
22
|
+
|
|
23
|
+
## 0.1.4
|
|
24
|
+
|
|
25
|
+
### Patch Changes
|
|
26
|
+
|
|
27
|
+
- [`71d0b85`](https://github.com/boyney123/eventcatalog/commit/71d0b85139cb057db718c10bf5f5aa6017cfe43c) [#132](https://github.com/boyney123/eventcatalog/pull/132) Thanks [@boyney123](https://github.com/boyney123)! - fix: build directory is now copied over to the users proejct dir
|
|
28
|
+
|
|
3
29
|
## 0.1.3
|
|
4
30
|
|
|
5
31
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -9,4 +9,4 @@ To make changes or run this application core code, you will need to fork the Eve
|
|
|
9
9
|
npm run start:catalog
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
This will run the catalog using the catalog information found in `examples/basic
|
|
12
|
+
This will run the catalog using the catalog information found in `examples/basic`
|
package/bin/eventcatalog.js
CHANGED
|
@@ -41,7 +41,7 @@ cli
|
|
|
41
41
|
|
|
42
42
|
cli
|
|
43
43
|
.command('build [siteDir]')
|
|
44
|
-
.description('
|
|
44
|
+
.description('Build eventcatalog project.')
|
|
45
45
|
.action(() => {
|
|
46
46
|
if (!fs.existsSync(eventCatalogLibDir)) {
|
|
47
47
|
copyCoreApplicationCodeIntoUsersProjectDir();
|
|
@@ -64,6 +64,7 @@ cli
|
|
|
64
64
|
|
|
65
65
|
// everything is built make sure its back in the users project directory
|
|
66
66
|
fs.copySync(path.join(eventCatalogLibDir, '.next'), path.join(projectDIR, '.next'));
|
|
67
|
+
fs.copySync(path.join(eventCatalogLibDir, 'out'), path.join(projectDIR, 'out'));
|
|
67
68
|
});
|
|
68
69
|
|
|
69
70
|
cli
|
package/components/Header.tsx
CHANGED
|
@@ -25,7 +25,7 @@ export default function Example() {
|
|
|
25
25
|
<div className="relative flex items-center justify-between h-16">
|
|
26
26
|
<div className="flex-1 flex items-center justify-center sm:items-stretch sm:justify-start">
|
|
27
27
|
<div className="flex-shrink-0 flex items-center text-white font-bold">
|
|
28
|
-
<Link href="/
|
|
28
|
+
<Link href="/">
|
|
29
29
|
<a className="flex items-center">
|
|
30
30
|
<img alt="logo" className="text-white w-8 inline-block mr-3" src={`${basePath}/logo.svg`} />
|
|
31
31
|
<span className="text-xl">{title}</span>
|
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
import { buildMermaidFlowChartForEvent, buildMermaidFlowChartForService } from '../graphs';
|
|
2
2
|
|
|
3
|
+
jest.mock('next/config', () => () => ({
|
|
4
|
+
publicRuntimeConfig: {
|
|
5
|
+
basePath: '/docs',
|
|
6
|
+
},
|
|
7
|
+
}));
|
|
8
|
+
|
|
3
9
|
describe('graphs', () => {
|
|
4
10
|
describe('buildMermaidFlowChartForService', () => {
|
|
5
11
|
it('takes a given Service and returns the mermaid code showing relationships between the events it publishes and consumes', () => {
|
|
@@ -18,12 +24,22 @@ describe('graphs', () => {
|
|
|
18
24
|
const result = buildMermaidFlowChartForService(service);
|
|
19
25
|
|
|
20
26
|
expect(result.trim()).toEqual(`flowchart LR
|
|
21
|
-
|
|
27
|
+
|
|
28
|
+
My_Event[My Event]:::producer-->My_Service[My Service]:::event
|
|
22
29
|
|
|
23
30
|
classDef event stroke:#2563eb,stroke-width: 4px;
|
|
31
|
+
|
|
24
32
|
classDef producer stroke:#75d7b6,stroke-width: 2px;
|
|
33
|
+
|
|
25
34
|
classDef consumer stroke:#818cf8,stroke-width: 2px;
|
|
26
|
-
|
|
35
|
+
|
|
36
|
+
My_Service[My Service]:::event-->My_Event_2[My Event 2]:::consumer
|
|
37
|
+
|
|
38
|
+
click My_Event href "/docs/events/My Event" "Go to My Event" _self
|
|
39
|
+
|
|
40
|
+
click My_Event_2 href "/docs/events/My Event 2" "Go to My Event 2" _self
|
|
41
|
+
|
|
42
|
+
click My_Service href "/docs/services/My Service" "Go to My Service" _self`);
|
|
27
43
|
});
|
|
28
44
|
});
|
|
29
45
|
|
|
@@ -39,15 +55,25 @@ My_Service:::event-->My_Event:::consumer`);
|
|
|
39
55
|
const result = buildMermaidFlowChartForEvent(event);
|
|
40
56
|
|
|
41
57
|
expect(result.trim()).toEqual(`flowchart LR
|
|
42
|
-
|
|
58
|
+
|
|
59
|
+
Service_1[Service 1]:::producer-->My_Event[My Event]:::event
|
|
43
60
|
|
|
44
61
|
classDef event stroke:#2563eb,stroke-width: 4px;
|
|
62
|
+
|
|
45
63
|
classDef producer stroke:#75d7b6,stroke-width: 2px;
|
|
64
|
+
|
|
46
65
|
classDef consumer stroke:#818cf8,stroke-width: 2px;
|
|
47
|
-
|
|
66
|
+
|
|
67
|
+
My_Event[My Event]:::event-->Service_2[Service 2]:::consumer
|
|
68
|
+
|
|
69
|
+
click Service_1 href "/docs/services/Service 1" "Go to Service 1" _self
|
|
70
|
+
|
|
71
|
+
click Service_2 href "/docs/services/Service 2" "Go to Service 2" _self
|
|
72
|
+
|
|
73
|
+
click My_Event href "/docs/events/My Event" "Go to My Event" _self`);
|
|
48
74
|
});
|
|
49
75
|
|
|
50
|
-
it('
|
|
76
|
+
it('persists the spaces in the service name and renders them with mermaid', () => {
|
|
51
77
|
const event = {
|
|
52
78
|
name: 'My Event',
|
|
53
79
|
version: '0.0.1',
|
|
@@ -55,8 +81,8 @@ My_Event:::event-->Service_2:::consumer`);
|
|
|
55
81
|
consumers: [],
|
|
56
82
|
};
|
|
57
83
|
const result = buildMermaidFlowChartForEvent(event);
|
|
58
|
-
expect(result).toContain(`Service_1_With_Spaces:::producer-->My_Event:::event`);
|
|
59
|
-
expect(result).not.toContain(`Service 1 With Spaces`);
|
|
84
|
+
expect(result).toContain(`Service_1_With_Spaces[Service 1 With Spaces]:::producer-->My_Event[My Event]:::event`);
|
|
85
|
+
expect(result).not.toContain(`Service 1 With Spaces[`);
|
|
60
86
|
});
|
|
61
87
|
});
|
|
62
88
|
});
|
package/lib/graphs.ts
CHANGED
|
@@ -1,35 +1,82 @@
|
|
|
1
1
|
import type { Event, Service } from '@eventcatalog/types';
|
|
2
|
+
import getConfig from 'next/config';
|
|
2
3
|
|
|
3
4
|
const MAX_LENGTH_FOR_NODES = '50';
|
|
5
|
+
const { publicRuntimeConfig: { basePath = '' } = {} } = getConfig();
|
|
4
6
|
|
|
5
7
|
const truncateNode = (value) => (value.length > MAX_LENGTH_FOR_NODES ? `${value.substring(0, MAX_LENGTH_FOR_NODES)}...` : value);
|
|
8
|
+
const generateLink = (value, type) => (basePath !== '' ? `${basePath}/${type}/${value}` : `/${type}/${value}`);
|
|
6
9
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
/**
|
|
11
|
+
* Build Mermaid graph output
|
|
12
|
+
* @param centerNode
|
|
13
|
+
* @param leftNodes
|
|
14
|
+
* @param rightNodes
|
|
15
|
+
* @param rootNodeColor
|
|
16
|
+
*/
|
|
17
|
+
const buildMermaid = (centerNode, leftNodes, rightNodes, rootNodeColor) => `flowchart LR\n
|
|
18
|
+
${leftNodes.map((node) => `${node.id}[${node.name}]:::producer-->${centerNode.id}[${centerNode.name}]:::event\n`).join('')}
|
|
19
|
+
classDef event stroke:${rootNodeColor},stroke-width: 4px;\n
|
|
20
|
+
classDef producer stroke:#75d7b6,stroke-width: 2px;\n
|
|
21
|
+
classDef consumer stroke:#818cf8,stroke-width: 2px;\n
|
|
22
|
+
${rightNodes.map((node) => `${centerNode.id}[${centerNode.name}]:::event-->${node.id}[${node.name}]:::consumer\n`).join('')}
|
|
23
|
+
${leftNodes.map((node) => `click ${node.id} href "${node.link}" "Go to ${node.name}" _self\n`).join('')}
|
|
24
|
+
${rightNodes.map((node) => `click ${node.id} href "${node.link}" "Go to ${node.name}" _self\n`).join('')}
|
|
25
|
+
click ${centerNode.id} href "${centerNode.link}" "Go to ${centerNode.name}" _self\n
|
|
26
|
+
`;
|
|
13
27
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
28
|
+
/**
|
|
29
|
+
* Builds a graph for a given event
|
|
30
|
+
* @param {Event} event
|
|
31
|
+
* @param {string} rootNodeColor of the root node
|
|
32
|
+
* @returns {string} Mermaid Graph
|
|
33
|
+
*/
|
|
34
|
+
export const buildMermaidFlowChartForEvent = ({ name: eventName, producers, consumers }: Event, rootNodeColor = '#2563eb') => {
|
|
35
|
+
// Transforms services & event into a graph model
|
|
36
|
+
const leftNodes = producers.map(truncateNode).map((node) => ({
|
|
37
|
+
id: node.replace(/ /g, '_'),
|
|
38
|
+
name: node,
|
|
39
|
+
link: generateLink(node, 'services'),
|
|
40
|
+
}));
|
|
41
|
+
const rightNodes = consumers.map(truncateNode).map((node) => ({
|
|
42
|
+
id: node.replace(/ /g, '_'),
|
|
43
|
+
name: node,
|
|
44
|
+
link: generateLink(node, 'services'),
|
|
45
|
+
}));
|
|
46
|
+
const centerNode = {
|
|
47
|
+
id: truncateNode(eventName.replace(/ /g, '_')),
|
|
48
|
+
name: eventName,
|
|
49
|
+
link: generateLink(eventName, 'events'),
|
|
50
|
+
};
|
|
22
51
|
|
|
23
|
-
|
|
24
|
-
|
|
52
|
+
return buildMermaid(centerNode, leftNodes, rightNodes, rootNodeColor);
|
|
53
|
+
};
|
|
25
54
|
|
|
55
|
+
/**
|
|
56
|
+
* Builds a graph for a given service
|
|
57
|
+
* @param {Service} service
|
|
58
|
+
* @param {string} rootNodeColor of the root node
|
|
59
|
+
* @returns {string} Mermaid Graph
|
|
60
|
+
*/
|
|
26
61
|
export const buildMermaidFlowChartForService = (
|
|
27
62
|
{ publishes, subscribes, name: serviceName }: Service,
|
|
28
63
|
rootNodeColor = '#2563eb'
|
|
29
|
-
) =>
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
);
|
|
64
|
+
) => {
|
|
65
|
+
// Transforms services & event into a graph model
|
|
66
|
+
const leftNodes = publishes.map(truncateNode).map((node) => ({
|
|
67
|
+
id: node.name.replace(/ /g, '_'),
|
|
68
|
+
name: node.name,
|
|
69
|
+
link: generateLink(node.name, 'events'),
|
|
70
|
+
}));
|
|
71
|
+
const rightNodes = subscribes.map(truncateNode).map((node) => ({
|
|
72
|
+
id: node.name.replace(/ /g, '_'),
|
|
73
|
+
name: node.name,
|
|
74
|
+
link: generateLink(node.name, 'events'),
|
|
75
|
+
}));
|
|
76
|
+
const centerNode = {
|
|
77
|
+
id: truncateNode(serviceName.replace(/ /g, '_')),
|
|
78
|
+
name: serviceName,
|
|
79
|
+
link: generateLink(serviceName, 'services'),
|
|
80
|
+
};
|
|
81
|
+
return buildMermaid(centerNode, leftNodes, rightNodes, rootNodeColor);
|
|
82
|
+
};
|
package/out/404.html
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><script src="//unpkg.com/three"></script><script src="//unpkg.com/three/examples/js/renderers/CSS2DRenderer.js"></script><link rel="stylesheet" href="https://cdn.bootcss.com/font-awesome/4.7.0/css/font-awesome.css"/><meta name="description" content="An open source project to Discover, Explore and Document your Event Driven Architectures."/><meta property="og:url" content="https://eventcatalog.dev/"/><meta property="og:type" content="website"/><meta property="og:title" content="EventCatalog | Discover, Explore and Document your Event Driven Architectures."/><meta property="og:description" content="An open source tool powered by markdown to document your Event Driven Architecture."/><meta property="og:image" content="https://eventcatalog.dev/img/opengraph.png"/><meta property="og:image:alt" content="EventCatalog | Discover, Explore and Document your Event Driven Architectures."/><meta property="og:image:width" content="1200"/><meta property="og:image:height" content="600"/><meta property="og:locale" content="en-GB"/><meta name="author" content="David Boyne"/><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/atom-one-light.min.css"/><title>404: This page could not be found</title><meta name="next-head-count" content="18"/><link rel="preload" href="/_next/static/css/0b54ec6503b91283.css" as="style"/><link rel="stylesheet" href="/_next/static/css/0b54ec6503b91283.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-5cd94c89d3acac5f.js"></script><script src="/_next/static/chunks/webpack-4d9342d4391c2a09.js" defer=""></script><script src="/_next/static/chunks/framework-576ec6a1c1386453.js" defer=""></script><script src="/_next/static/chunks/main-0289ecbd51cd4cb4.js" defer=""></script><script src="/_next/static/chunks/pages/_app-
|
|
1
|
+
<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><script src="//unpkg.com/three"></script><script src="//unpkg.com/three/examples/js/renderers/CSS2DRenderer.js"></script><link rel="stylesheet" href="https://cdn.bootcss.com/font-awesome/4.7.0/css/font-awesome.css"/><meta name="description" content="An open source project to Discover, Explore and Document your Event Driven Architectures."/><meta property="og:url" content="https://eventcatalog.dev/"/><meta property="og:type" content="website"/><meta property="og:title" content="EventCatalog | Discover, Explore and Document your Event Driven Architectures."/><meta property="og:description" content="An open source tool powered by markdown to document your Event Driven Architecture."/><meta property="og:image" content="https://eventcatalog.dev/img/opengraph.png"/><meta property="og:image:alt" content="EventCatalog | Discover, Explore and Document your Event Driven Architectures."/><meta property="og:image:width" content="1200"/><meta property="og:image:height" content="600"/><meta property="og:locale" content="en-GB"/><meta name="author" content="David Boyne"/><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/atom-one-light.min.css"/><title>404: This page could not be found</title><meta name="next-head-count" content="18"/><link rel="preload" href="/_next/static/css/0b54ec6503b91283.css" as="style"/><link rel="stylesheet" href="/_next/static/css/0b54ec6503b91283.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-5cd94c89d3acac5f.js"></script><script src="/_next/static/chunks/webpack-4d9342d4391c2a09.js" defer=""></script><script src="/_next/static/chunks/framework-576ec6a1c1386453.js" defer=""></script><script src="/_next/static/chunks/main-0289ecbd51cd4cb4.js" defer=""></script><script src="/_next/static/chunks/pages/_app-151e9a6aaffc086e.js" defer=""></script><script src="/_next/static/chunks/pages/_error-5a714c45c50a8db4.js" defer=""></script><script src="/_next/static/muqmp6UkJzlet500sAKkA/_buildManifest.js" defer=""></script><script src="/_next/static/muqmp6UkJzlet500sAKkA/_ssgManifest.js" defer=""></script><script src="/_next/static/muqmp6UkJzlet500sAKkA/_middlewareManifest.js" defer=""></script></head><body><div id="__next" data-reactroot=""><div class="bg-gray-800"><div class="max-w-7xl mx-auto "><div class="relative flex items-center justify-between h-16"><div class="flex-1 flex items-center justify-center sm:items-stretch sm:justify-start"><div class="flex-shrink-0 flex items-center text-white font-bold"><a class="flex items-center" href="/"><img alt="logo" class="text-white w-8 inline-block mr-3" src="/logo.svg"/><span class="text-xl">EventCatalog</span></a></div></div><div class="hidden sm:block sm:ml-6"><div class="flex space-x-4"><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/events">Events</a><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/services">Services</a><a class="text-gray-300 hover:bg-gray-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium" href="/overview">3D Node Graph</a></div></div></div></div></div><div style="color:#000;background:#fff;font-family:-apple-system, BlinkMacSystemFont, Roboto, "Segoe UI", "Fira Sans", Avenir, "Helvetica Neue", "Lucida Grande", sans-serif;height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div><style>body { margin: 0 }</style><h1 style="display:inline-block;border-right:1px solid rgba(0, 0, 0,.3);margin:0;margin-right:20px;padding:10px 23px 10px 0;font-size:24px;font-weight:500;vertical-align:top">404</h1><div style="display:inline-block;text-align:left;line-height:49px;height:49px;vertical-align:middle"><h2 style="font-size:14px;font-weight:normal;line-height:inherit;margin:0;padding:0">This page could not be found<!-- -->.</h2></div></div></div><footer class="bg-gray-800"><div class="max-w-7xl mx-auto py-12 px-4 overflow-hidden sm:px-6 lg:px-8"><nav class="-mx-5 -my-2 flex flex-wrap justify-center" aria-label="Footer"><div class="px-5 py-2"><a href="/events" class="text-base text-gray-500 hover:text-gray-900">Events</a></div><div class="px-5 py-2"><a href="/services" class="text-base text-gray-500 hover:text-gray-900">Services</a></div><div class="px-5 py-2"><a href="/overview" class="text-base text-gray-500 hover:text-gray-900">3D Node Graph</a></div><div class="px-5 py-2"><a href="https://github.com/boyney123/eventcatalog-demo/edit/master" class="text-base text-gray-500 hover:text-gray-900">GitHub</a></div></nav><p class="mt-8 text-center text-base text-gray-400">Copyright © <!-- -->2022<!-- --> <!-- -->Your Company<!-- -->. Built with<!-- --> <a class="underline" href="https://eventcatalog.dev" target="_blank" rel="noreferrer">EventCatalog.</a></p></div></footer></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"muqmp6UkJzlet500sAKkA","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>
|
|
File without changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"AddedItemToCart","version":"0.0.1","summary":"Holds information about what the user added to their shopping cart.\n","producers":["Basket Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":["0.0.2","0.0.1"],"schema":{"snippet":"{\n \"$id\": \"https://example.com/AddedItemToCart.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"AddedItemToCart\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"itemId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shopping item\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\n\nWe have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.\n\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var l=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,r=(e,t)=>{for(var o in t||(t={}))a.call(t,o)&&d(e,o,t[o]);if(i)for(var o of i(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>p(e,l(t));var h=(e,t)=>{var o={};for(var n in e)a.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&i)for(var n of i(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. This front end interacts directly with the \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" to add items to the cart. The \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" will raise the events.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"AddedItemToCart","version":"0.0.1","summary":"Holds information about what the user added to their shopping cart.\n","producers":["Basket Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":["0.0.2","0.0.1"],"schema":{"snippet":"{\n \"$id\": \"https://example.com/AddedItemToCart.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"AddedItemToCart\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"itemId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shopping item\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\n\nWe have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.\n\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var l=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,r=(e,t)=>{for(var o in t||(t={}))a.call(t,o)&&d(e,o,t[o]);if(i)for(var o of i(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>p(e,l(t));var h=(e,t)=>{var o={};for(var n in e)a.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&i)for(var n of i(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. This front end interacts directly with the \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" to add items to the cart. The \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" will raise the events.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"0.0.1"},"__N_SSG":true}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"AddedItemToCart","version":"0.0.1","summary":"Holds information about what the user added to their shopping cart.\n","producers":["Basket Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":["0.0.2","0.0.1"],"schema":{"snippet":"{\n \"$id\": \"https://example.com/AddedItemToCart.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"AddedItemToCart\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"itemId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shopping item\"\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"How many items the user wants to add to their shopping cart\",\n \"minimum\": 1,\n \"maximum\": 100,\n \"default\": 1\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\n\nWe have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.\n\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var l=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,r=(e,t)=>{for(var o in t||(t={}))a.call(t,o)&&d(e,o,t[o]);if(i)for(var o of i(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>p(e,l(t));var h=(e,t)=>{var o={};for(var n in e)a.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&i)for(var n of i(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. This front end interacts directly with the \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" to add items to the cart. The \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" will raise the events.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"AddedItemToCart","version":"0.0.1","summary":"Holds information about what the user added to their shopping cart.\n","producers":["Basket Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":["0.0.2","0.0.1"],"schema":{"snippet":"{\n \"$id\": \"https://example.com/AddedItemToCart.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"AddedItemToCart\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"itemId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shopping item\"\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"How many items the user wants to add to their shopping cart\",\n \"minimum\": 1,\n \"maximum\": 100,\n \"default\": 1\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\n\nWe have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.\n\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var l=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,r=(e,t)=>{for(var o in t||(t={}))a.call(t,o)&&d(e,o,t[o]);if(i)for(var o of i(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>p(e,l(t));var h=(e,t)=>{var o={};for(var n in e)a.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&i)for(var n of i(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. This front end interacts directly with the \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" to add items to the cart. The \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" will raise the events.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"0.0.2"},"__N_SSG":true}
|
package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/AddedItemToCart.json
RENAMED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"AddedItemToCart","version":"0.0.3","summary":"Holds information about what the user added to their shopping cart.\n","producers":["Basket Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[{"label":"AsyncAPI Specification","url":"https://studio.asyncapi.com/#schema-lightMeasuredPayload"}],"historicVersions":["0.0.2","0.0.1"],"schema":{"snippet":"{\n \"$id\": \"https://example.com/AddedItemToCart.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"AddedItemToCart\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"itemId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shopping item\"\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"How many items the user wants to add to their shopping cart\",\n \"minimum\": 1,\n \"maximum\": 1000,\n \"default\": 1\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[{"name":"example.js","snippet":"var kafka = require('kafka-node'),\n Consumer = kafka.Consumer,\n client = new kafka.KafkaClient(),\n consumer = new Consumer(\n client,\n [\n { topic: 't', partition: 0 },\n { topic: 'AddedItemToCart', partition: 1 },\n ],\n {\n autoCommit: false,\n }\n );\n\nconsumer.on('message', function (message) {\n console.log(message);\n});\n","langugage":"javascript"}]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\n\nWe have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.\n\n<Mermaid title=\"Consumer / Producer Diagram\" />\n\n<EventExamples title=\"How to trigger event\" />\n\n<Schema />\n","source":{"compiledSource":"var c=Object.defineProperty,h=Object.defineProperties;var l=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,r=(e,t)=>{for(var o in t||(t={}))a.call(t,o)&&d(e,o,t[o]);if(i)for(var o of i(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>h(e,l(t));var p=(e,t)=>{var o={};for(var n in e)a.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&i)for(var n of i(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),EventExamples=makeShortcode(\"EventExamples\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=p(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. This front end interacts directly with the \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" to add items to the cart. The \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" will raise the events.\"),mdx(Mermaid,{title:\"Consumer / Producer Diagram\",mdxType:\"Mermaid\"}),mdx(EventExamples,{title:\"How to trigger event\",mdxType:\"EventExamples\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"AddedItemToCart","version":"0.0.3","summary":"Holds information about what the user added to their shopping cart.\n","producers":["Basket Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[{"label":"AsyncAPI Specification","url":"https://studio.asyncapi.com/#schema-lightMeasuredPayload"}],"historicVersions":["0.0.2","0.0.1"],"schema":{"snippet":"{\n \"$id\": \"https://example.com/AddedItemToCart.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"AddedItemToCart\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"itemId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shopping item\"\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"How many items the user wants to add to their shopping cart\",\n \"minimum\": 1,\n \"maximum\": 1000,\n \"default\": 1\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[{"name":"example.js","snippet":"var kafka = require('kafka-node'),\n Consumer = kafka.Consumer,\n client = new kafka.KafkaClient(),\n consumer = new Consumer(\n client,\n [\n { topic: 't', partition: 0 },\n { topic: 'AddedItemToCart', partition: 1 },\n ],\n {\n autoCommit: false,\n }\n );\n\nconsumer.on('message', function (message) {\n console.log(message);\n});\n","langugage":"javascript"}]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\n\nWe have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.\n\n<Mermaid title=\"Consumer / Producer Diagram\" />\n\n<EventExamples title=\"How to trigger event\" />\n\n<Schema />\n","source":{"compiledSource":"var c=Object.defineProperty,h=Object.defineProperties;var l=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,r=(e,t)=>{for(var o in t||(t={}))a.call(t,o)&&d(e,o,t[o]);if(i)for(var o of i(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>h(e,l(t));var p=(e,t)=>{var o={};for(var n in e)a.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&i)for(var n of i(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),EventExamples=makeShortcode(\"EventExamples\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=p(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. This front end interacts directly with the \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" to add items to the cart. The \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" will raise the events.\"),mdx(Mermaid,{title:\"Consumer / Producer Diagram\",mdxType:\"Mermaid\"}),mdx(EventExamples,{title:\"How to trigger event\",mdxType:\"EventExamples\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"latest"},"__N_SSG":true}
|
|
File without changes
|
package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/OrderComplete.json
RENAMED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"OrderComplete","version":"0.0.1","summary":"Event represents when an order has been complete. (Delivered and finished)\n","producers":["Orders Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/OrderRequested.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"OrderRequested\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The ID the users order\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is the final event of the ordering process. It gets raised when the shipment has been delivered.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,d=Object.prototype.propertyIsEnumerable;var s=(e,o,t)=>o in e?c(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,a=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&s(e,t,o[t]);if(r)for(var t of r(o))d.call(o,t)&&s(e,t,o[t]);return e},m=(e,o)=>p(e,u(o));var h=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&d.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=h(n,[\"components\"]);return mdx(MDXLayout,m(a(a({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is the final event of the ordering process. It gets raised when the shipment has been delivered.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"OrderComplete","version":"0.0.1","summary":"Event represents when an order has been complete. (Delivered and finished)\n","producers":["Orders Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/OrderRequested.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"OrderRequested\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The ID the users order\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is the final event of the ordering process. It gets raised when the shipment has been delivered.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,d=Object.prototype.propertyIsEnumerable;var s=(e,o,t)=>o in e?c(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,a=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&s(e,t,o[t]);if(r)for(var t of r(o))d.call(o,t)&&s(e,t,o[t]);return e},m=(e,o)=>p(e,u(o));var h=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&d.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=h(n,[\"components\"]);return mdx(MDXLayout,m(a(a({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is the final event of the ordering process. It gets raised when the shipment has been delivered.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"latest"},"__N_SSG":true}
|
|
File without changes
|
package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/OrderConfirmed.json
RENAMED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","producers":["Orders Service"],"consumers":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/OrderRequested.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"OrderRequested\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The ID the users order\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when the customers order has been verified and the stock has been checked. Once this event is triggered we are safe to say it is ready for shipment.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,u=Object.defineProperties;var p=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,o,t)=>o in e?c(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,a=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&d(e,t,o[t]);if(r)for(var t of r(o))s.call(o,t)&&d(e,t,o[t]);return e},m=(e,o)=>u(e,p(o));var h=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&s.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=h(n,[\"components\"]);return mdx(MDXLayout,m(a(a({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when the customers order has been verified and the stock has been checked. Once this event is triggered we are safe to say it is ready for shipment.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"OrderConfirmed","version":"0.0.1","summary":"Event represents when an order has been confirmed and ready to be processed (shipped for example)\n","producers":["Orders Service"],"consumers":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/OrderRequested.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"OrderRequested\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The ID the users order\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when the customers order has been verified and the stock has been checked. Once this event is triggered we are safe to say it is ready for shipment.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,u=Object.defineProperties;var p=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,o,t)=>o in e?c(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,a=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&d(e,t,o[t]);if(r)for(var t of r(o))s.call(o,t)&&d(e,t,o[t]);return e},m=(e,o)=>u(e,p(o));var h=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&s.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=h(n,[\"components\"]);return mdx(MDXLayout,m(a(a({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when the customers order has been verified and the stock has been checked. Once this event is triggered we are safe to say it is ready for shipment.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"latest"},"__N_SSG":true}
|
|
File without changes
|
package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/OrderRequested.json
RENAMED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"OrderRequested","version":"0.0.1","summary":"Holds information about the customers order.\n","producers":["Basket Service"],"consumers":["Payment Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/OrderRequested.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"OrderRequested\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The ID the users order\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when the user confirms their order and wants to process their payment.\n\nWe have a frontend application that allows users to buy things from our store. The frontend application interacts with the Backet Service to trigger the `OrderRequested` event.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,a=(e,t)=>{for(var o in t||(t={}))i.call(t,o)&&d(e,o,t[o]);if(r)for(var o of r(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>p(e,u(t));var h=(e,t)=>{var o={};for(var n in e)i.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&r)for(var n of r(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=h(n,[\"components\"]);return mdx(MDXLayout,m(a(a({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when the user confirms their order and wants to process their payment.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. The frontend application interacts with the Backet Service to trigger the \",mdx(\"inlineCode\",{parentName:\"p\"},\"OrderRequested\"),\" event.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"OrderRequested","version":"0.0.1","summary":"Holds information about the customers order.\n","producers":["Basket Service"],"consumers":["Payment Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/OrderRequested.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"OrderRequested\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The ID the users order\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when the user confirms their order and wants to process their payment.\n\nWe have a frontend application that allows users to buy things from our store. The frontend application interacts with the Backet Service to trigger the `OrderRequested` event.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,a=(e,t)=>{for(var o in t||(t={}))i.call(t,o)&&d(e,o,t[o]);if(r)for(var o of r(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>p(e,u(t));var h=(e,t)=>{var o={};for(var n in e)i.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&r)for(var n of r(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",a({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=h(n,[\"components\"]);return mdx(MDXLayout,m(a(a({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when the user confirms their order and wants to process their payment.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. The frontend application interacts with the Backet Service to trigger the \",mdx(\"inlineCode\",{parentName:\"p\"},\"OrderRequested\"),\" event.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"latest"},"__N_SSG":true}
|
|
File without changes
|
package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/PaymentProcessed.json
RENAMED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"PaymentProcessed","version":"0.0.1","summary":"Holds information about the payment that has been processed.\n","producers":["Payment Service"],"consumers":["Orders Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/PaymentProcessed.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"PaymentProcessed\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The ID the users order\"\n },\n \"stripeId\": {\n \"type\": \"string\",\n \"description\": \"The ID the payment handled in stripe\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when the payment has succesfully been processed for a customers orders.\n\nWe use Stripe to handle customer payments. The Payment Service listens for Stripe webhooks and raises the PaymentProcessed event.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var h=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,i=Object.prototype.propertyIsEnumerable;var d=(e,o,t)=>o in e?h(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,s=(e,o)=>{for(var t in o||(o={}))a.call(o,t)&&d(e,t,o[t]);if(r)for(var t of r(o))i.call(o,t)&&d(e,t,o[t]);return e},m=(e,o)=>p(e,u(o));var c=(e,o)=>{var t={};for(var n in e)a.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&i.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",s({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=c(n,[\"components\"]);return mdx(MDXLayout,m(s(s({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when the payment has succesfully been processed for a customers orders.\"),mdx(\"p\",null,\"We use Stripe to handle customer payments. The Payment Service listens for Stripe webhooks and raises the PaymentProcessed event.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"PaymentProcessed","version":"0.0.1","summary":"Holds information about the payment that has been processed.\n","producers":["Payment Service"],"consumers":["Orders Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/PaymentProcessed.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"PaymentProcessed\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The ID the users order\"\n },\n \"stripeId\": {\n \"type\": \"string\",\n \"description\": \"The ID the payment handled in stripe\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when the payment has succesfully been processed for a customers orders.\n\nWe use Stripe to handle customer payments. The Payment Service listens for Stripe webhooks and raises the PaymentProcessed event.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var h=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var r=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,i=Object.prototype.propertyIsEnumerable;var d=(e,o,t)=>o in e?h(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,s=(e,o)=>{for(var t in o||(o={}))a.call(o,t)&&d(e,t,o[t]);if(r)for(var t of r(o))i.call(o,t)&&d(e,t,o[t]);return e},m=(e,o)=>p(e,u(o));var c=(e,o)=>{var t={};for(var n in e)a.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&r)for(var n of r(e))o.indexOf(n)<0&&i.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",s({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=c(n,[\"components\"]);return mdx(MDXLayout,m(s(s({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when the payment has succesfully been processed for a customers orders.\"),mdx(\"p\",null,\"We use Stripe to handle customer payments. The Payment Service listens for Stripe webhooks and raises the PaymentProcessed event.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"latest"},"__N_SSG":true}
|
|
File without changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"RemovedItemFromCart","version":"0.0.1","summary":"Holds information about what the user removed from their cart.\n","producers":["Basket Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/RemovedItemFromCart.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"RemovedItemFromCart\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"itemId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shopping item\"\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"How many items the user wants to remove to their shopping cart\",\n \"minimum\": 1,\n \"maximum\": 100,\n \"default\": 1\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\n\nWe have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.\n\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var l=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,r=(e,t)=>{for(var o in t||(t={}))a.call(t,o)&&d(e,o,t[o]);if(i)for(var o of i(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>p(e,l(t));var h=(e,t)=>{var o={};for(var n in e)a.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&i)for(var n of i(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. This front end interacts directly with the \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" to add items to the cart. The \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" will raise the events.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"RemovedItemFromCart","version":"0.0.1","summary":"Holds information about what the user removed from their cart.\n","producers":["Basket Service"],"consumers":["Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/RemovedItemFromCart.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"RemovedItemFromCart\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"itemId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shopping item\"\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"How many items the user wants to remove to their shopping cart\",\n \"minimum\": 1,\n \"maximum\": 100,\n \"default\": 1\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\n\nWe have a frontend application that allows users to buy things from our store. This front end interacts directly with the `Basket Service` to add items to the cart. The `Basket Service` will raise the events.\n\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var l=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var a=Object.prototype.hasOwnProperty,s=Object.prototype.propertyIsEnumerable;var d=(e,t,o)=>t in e?c(e,t,{enumerable:!0,configurable:!0,writable:!0,value:o}):e[t]=o,r=(e,t)=>{for(var o in t||(t={}))a.call(t,o)&&d(e,o,t[o]);if(i)for(var o of i(t))s.call(t,o)&&d(e,o,t[o]);return e},m=(e,t)=>p(e,l(t));var h=(e,t)=>{var o={};for(var n in e)a.call(e,n)&&t.indexOf(n)<0&&(o[n]=e[n]);if(e!=null&&i)for(var n of i(e))t.indexOf(n)<0&&s.call(e,n)&&(o[n]=e[n]);return o};const makeShortcode=e=>function(o){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},o))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(o){var n=o,{components:e}=n,t=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),t),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event can be triggered multiple times per customer. Everytime the customer adds an item to their shopping cart this event will be triggered.\"),mdx(\"p\",null,\"We have a frontend application that allows users to buy things from our store. This front end interacts directly with the \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" to add items to the cart. The \",mdx(\"inlineCode\",{parentName:\"p\"},\"Basket Service\"),\" will raise the events.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"latest"},"__N_SSG":true}
|
|
File without changes
|
package/out/_next/data/{-JRVlr_KvNJLo7NqAt8Bj → muqmp6UkJzlet500sAKkA}/events/ShipmentDelivered.json
RENAMED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"ShipmentDelivered","version":"0.0.1","summary":"Event represents when a shipment has been delievered and received.\n","producers":["Shipping Service"],"consumers":["Order Service","Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/ShipmentDispatched.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"ShipmentDispatched\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"shipmentId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shipment\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The order assigned to the shipment\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when a shipment has been delievered to it's destination.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var a=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,d=Object.prototype.propertyIsEnumerable;var s=(e,o,t)=>o in e?c(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,r=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&s(e,t,o[t]);if(a)for(var t of a(o))d.call(o,t)&&s(e,t,o[t]);return e},m=(e,o)=>p(e,u(o));var h=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&a)for(var n of a(e))o.indexOf(n)<0&&d.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when a shipment has been delievered to it's destination.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"ShipmentDelivered","version":"0.0.1","summary":"Event represents when a shipment has been delievered and received.\n","producers":["Shipping Service"],"consumers":["Order Service","Data Lake"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/ShipmentDispatched.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"ShipmentDispatched\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"shipmentId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shipment\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The order assigned to the shipment\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when a shipment has been delievered to it's destination.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var a=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,d=Object.prototype.propertyIsEnumerable;var s=(e,o,t)=>o in e?c(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,r=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&s(e,t,o[t]);if(a)for(var t of a(o))d.call(o,t)&&s(e,t,o[t]);return e},m=(e,o)=>p(e,u(o));var h=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&a)for(var n of a(e))o.indexOf(n)<0&&d.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when a shipment has been delievered to it's destination.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"latest"},"__N_SSG":true}
|
|
File without changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"pageProps":{"event":{"name":"ShipmentDispatched","version":"0.0.1","summary":"Event represents when a shipment has been dispatched.\n","producers":["Shipping Service"],"consumers":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/ShipmentDispatched.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"ShipmentDispatched\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"shipmentId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shipment\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The order assigned to the shipment\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when a shipment has been dispatched from the warehouse.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var a=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,d=Object.prototype.propertyIsEnumerable;var s=(e,o,t)=>o in e?c(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,r=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&s(e,t,o[t]);if(a)for(var t of a(o))d.call(o,t)&&s(e,t,o[t]);return e},m=(e,o)=>p(e,u(o));var h=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&a)for(var n of a(e))o.indexOf(n)<0&&d.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when a shipment has been dispatched from the warehouse.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/
|
|
1
|
+
{"pageProps":{"event":{"name":"ShipmentDispatched","version":"0.0.1","summary":"Event represents when a shipment has been dispatched.\n","producers":["Shipping Service"],"consumers":["Shipping Service"],"owners":["dboyne","mSmith"],"externalLinks":[],"historicVersions":[],"schema":{"snippet":"{\n \"$id\": \"https://example.com/ShipmentDispatched.json\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"title\": \"ShipmentDispatched\",\n \"type\": \"object\",\n \"properties\": {\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"correlationId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"domain\": {\n \"type\": \"string\",\n \"description\": \"The domain of the event\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"The name of the service that triggered the event\"\n }\n },\n \"required\": [\"correlationId\", \"domain\", \"service\"]\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"userId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the user\"\n },\n \"shipmentId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the shipment\"\n },\n \"orderId\": {\n \"type\": \"string\",\n \"description\": \"The order assigned to the shipment\"\n }\n }\n }\n }\n}","language":"json","extension":"json"},"examples":[]},"markdown":{"content":"\n<Admonition>When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.</Admonition>\n\n### Details\n\nThis event is triggered when a shipment has been dispatched from the warehouse.\n\n### Consumer / Producer Diagram\n\n<Mermaid />\n\n<Schema />","source":{"compiledSource":"var c=Object.defineProperty,p=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var a=Object.getOwnPropertySymbols;var i=Object.prototype.hasOwnProperty,d=Object.prototype.propertyIsEnumerable;var s=(e,o,t)=>o in e?c(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t,r=(e,o)=>{for(var t in o||(o={}))i.call(o,t)&&s(e,t,o[t]);if(a)for(var t of a(o))d.call(o,t)&&s(e,t,o[t]);return e},m=(e,o)=>p(e,u(o));var h=(e,o)=>{var t={};for(var n in e)i.call(e,n)&&o.indexOf(n)<0&&(t[n]=e[n]);if(e!=null&&a)for(var n of a(e))o.indexOf(n)<0&&d.call(e,n)&&(t[n]=e[n]);return t};const makeShortcode=e=>function(t){return console.warn(\"Component \"+e+\" was not imported, exported, or provided by MDXProvider as global scope\"),mdx(\"div\",r({},t))},Admonition=makeShortcode(\"Admonition\"),Mermaid=makeShortcode(\"Mermaid\"),Schema=makeShortcode(\"Schema\"),layoutProps={},MDXLayout=\"wrapper\";function MDXContent(t){var n=t,{components:e}=n,o=h(n,[\"components\"]);return mdx(MDXLayout,m(r(r({},layoutProps),o),{components:e,mdxType:\"MDXLayout\"}),mdx(Admonition,{mdxType:\"Admonition\"},\"When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.\"),mdx(\"h3\",null,\"Details\"),mdx(\"p\",null,\"This event is triggered when a shipment has been dispatched from the warehouse.\"),mdx(\"h3\",null,\"Consumer / Producer Diagram\"),mdx(Mermaid,{mdxType:\"Mermaid\"}),mdx(Schema,{mdxType:\"Schema\"}))}MDXContent.isMDXComponent=!0;\n","scope":{}},"lastModifiedDate":"2022/1/31"},"loadedVersion":"latest"},"__N_SSG":true}
|
|
File without changes
|