@eventcatalog/create-eventcatalog 1.2.1 → 2.0.0

package/dist/default/events/ShipmentDispatched/schema.json

@@ -1,43 +0,0 @@
-{
-  "$id": "https://example.com/ShipmentDispatched.json",
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "ShipmentDispatched",
-  "type": "object",
-  "properties": {
-    "metadata": {
-      "type": "object",
-      "properties": {
-        "correlationId": {
-          "type": "string",
-          "description": "The ID of the user"
-        },
-        "domain": {
-          "type": "string",
-          "description": "The domain of the event"
-        },
-        "service": {
-          "type": "string",
-          "description": "The name of the service that triggered the event"
-        }
-      },
-      "required": ["correlationId", "domain", "service"]
-    },
-    "data": {
-      "type": "object",
-      "properties": {
-        "userId": {
-          "type": "string",
-          "description": "The ID of the user"
-        },
-        "shipmentId": {
-          "type": "string",
-          "description": "The ID of the shipment"
-        },
-        "orderId": {
-          "type": "string",
-          "description": "The order assigned to the shipment"
-        }
-      }
-    }
-  }
-}

package/dist/default/events/ShipmentPrepared/index.md

@@ -1,23 +0,0 @@
----
-name: ShipmentPrepared
-version: 0.0.1
-summary: |
-  Event represents when a shipment has finished being prepared and is ready to be dispatched.
-producers:
-    - Shipping Service
-consumers:
-    - Shipping Service
-owners:
-    - dboyne
-    - mSmith
----
-
-<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>
-
-### Details
-
-This event is triggered when a shipment has finished being prepared. 
-
-<NodeGraph title="Consumer / Producer Diagram" />
-
-<Schema />

package/dist/default/events/ShipmentPrepared/schema.json

@@ -1,43 +0,0 @@
-{
-  "$id": "https://example.com/ShipmentPrepared.json",
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "ShipmentPrepared",
-  "type": "object",
-  "properties": {
-    "metadata": {
-      "type": "object",
-      "properties": {
-        "correlationId": {
-          "type": "string",
-          "description": "The ID of the user"
-        },
-        "domain": {
-          "type": "string",
-          "description": "The domain of the event"
-        },
-        "service": {
-          "type": "string",
-          "description": "The name of the service that triggered the event"
-        }
-      },
-      "required": ["correlationId", "domain", "service"]
-    },
-    "data": {
-      "type": "object",
-      "properties": {
-        "userId": {
-          "type": "string",
-          "description": "The ID of the user"
-        },
-        "shipmentId": {
-          "type": "string",
-          "description": "The ID of the shipment"
-        },
-        "orderId": {
-          "type": "string",
-          "description": "The order assigned to the shipment"
-        }
-      }
-    }
-  }
-}

package/dist/default/public/logo.svg

@@ -1,44 +0,0 @@
-<svg width="547" height="398" xmlns="http://www.w3.org/2000/svg">
-
- <g>
-  <title>Layer 1</title>
-  <g>
-   <path fill="#ffffff" d="m508,69.60635l-8.5,0l0,-24.5c0,-2.905 -1.678,-5.549 -4.307,-6.786c-69.605,-32.754 -149.285,-33.22 -219.193,-1.449c-69.908,-31.771 -149.588,-31.304 -219.193,1.449c-2.629,1.237 -4.307,3.881 -4.307,6.786l0,24.5l-8.5,0c-12.958,0 -23.5,10.542 -23.5,23.5l0,264c0,12.958 10.542,23.5 23.5,23.5l464,0c12.958,0 23.5,-10.542 23.5,-23.5l0,-264c0,-12.958 -10.542,-23.5 -23.5,-23.5zm-224.5,111.477c0,-0.009 0,-0.019 0,-0.028l0,-131.139c64.137,-28.707 136.861,-28.707 201,0l0,27.161c0,0.01 -0.001,0.02 -0.001,0.029s0.001,0.02 0.001,0.029l0,244.438c-32.237,-13.461 -66.371,-20.193 -100.5,-20.193c-34.129,0 -68.264,6.732 -100.5,20.193l0,-140.49zm-48,-143.192c11.187,3.204 22.217,7.198 33,12.025l0,117.177l-12.34,-8.227c-2.52,-1.68 -5.801,-1.68 -8.32,0l-12.34,8.227l0,-129.202zm-168,39.235c0,-0.007 0.001,-0.013 0.001,-0.02s-0.001,-0.012 -0.001,-0.019l0,-27.171c48.563,-21.736 102.046,-26.999 153,-15.82l0,32.856c-26.767,-5.505 -54.078,-6.777 -81.328,-3.75c-4.117,0.457 -7.083,4.165 -6.626,8.282c0.458,4.116 4.162,7.085 8.282,6.626c26.708,-2.967 53.479,-1.562 79.671,4.165l0,48.686c-15.912,-3.265 -32.14,-5.067 -48.377,-5.323c-4.145,-0.078 -7.552,3.239 -7.618,7.38c-0.065,4.142 3.239,7.552 7.38,7.618c16.331,0.258 32.654,2.164 48.614,5.647l0,16.66c-43.389,-8.909 -88.39,-6.644 -130.748,6.665c-3.952,1.241 -6.148,5.451 -4.907,9.403c1.007,3.204 3.964,5.254 7.153,5.254c0.745,0 1.502,-0.112 2.25,-0.347c40.908,-12.852 84.428,-14.773 126.252,-5.638l0,2.825c0,2.766 1.522,5.308 3.961,6.612c2.438,1.306 5.398,1.162 7.699,-0.372l19.84,-13.227l16.5,11l0,136.454c-32.237,-13.461 -66.371,-20.193 -100.5,-20.193c-34.129,0 -68.264,6.732 -100.5,20.193l0,-244.446l0.002,0zm177,288.48l-200.5,0c-4.687,0 -8.5,-3.813 -8.5,-8.5l0,-264c0,-4.687 3.813,-8.5 8.5,-8.5l8.5,0l0,248.5l0,8c0,4.142 3.358,7.5 7.5,7.5l184.5,0l0,17zm-166.71,-32c58.099,-22.934 122.32,-22.935 180.42,0l-180.42,0zm214.71,32l-33,0l0,-17l33,0l0,17zm181.71,-32l-180.42,0c58.099,-22.934 122.32,-22.934 180.42,0zm42.29,23.5c0,4.687 -3.813,8.5 -8.5,8.5l-200.5,0l0,-17l184.5,0c4.142,0 7.5,-3.358 7.5,-7.5l0,-8l0,-248.5l8.5,0c4.687,0 8.5,3.813 8.5,8.5l0,264z"/>
-   <path fill="#ffffff" d="m330.46,259.24935c-8.302,1.74 -16.615,3.911 -24.708,6.454c-3.952,1.242 -6.148,5.452 -4.907,9.403c1.007,3.204 3.964,5.254 7.153,5.254c0.745,0 1.502,-0.112 2.25,-0.347c7.628,-2.396 15.464,-4.443 23.288,-6.083c4.054,-0.85 6.652,-4.825 5.802,-8.879c-0.849,-4.054 -4.827,-6.651 -8.878,-5.802z"/>
-   <path fill="#ffffff" d="m460.002,280.35935c3.189,0 6.147,-2.051 7.153,-5.254c1.241,-3.952 -0.956,-8.162 -4.907,-9.403c-32.073,-10.076 -65.329,-13.842 -98.844,-11.188c-4.129,0.326 -7.211,3.938 -6.885,8.068s3.935,7.213 8.068,6.885c31.59,-2.499 62.935,1.048 93.165,10.546c0.748,0.235 1.505,0.346 2.25,0.346z"/>
-   <path fill="#ffffff" d="m307.998,248.26735c0.745,0 1.502,-0.112 2.25,-0.347c48.249,-15.159 99.256,-15.159 147.504,0c3.952,1.24 8.162,-0.956 9.403,-4.907c1.241,-3.952 -0.956,-8.162 -4.907,-9.403c-51.191,-16.083 -105.306,-16.083 -156.496,0c-3.952,1.241 -6.149,5.451 -4.907,9.403c1.007,3.203 3.964,5.254 7.153,5.254z"/>
-   <path fill="#ffffff" d="m307.998,216.35935c0.745,0 1.502,-0.112 2.25,-0.347c27.681,-8.697 56.409,-12.412 85.399,-11.037c4.147,0.192 7.651,-2.999 7.847,-7.137c0.196,-4.138 -2.999,-7.65 -7.137,-7.847c-30.753,-1.456 -61.236,2.483 -90.605,11.71c-3.952,1.242 -6.149,5.452 -4.907,9.403c1.007,3.206 3.964,5.255 7.153,5.255z"/>
-   <path fill="#ffffff" d="m462.248,201.70235c-10.76,-3.38 -21.846,-6.086 -32.952,-8.043c-4.08,-0.719 -7.968,2.006 -8.688,6.085c-0.719,4.079 2.005,7.969 6.085,8.688c10.467,1.844 20.917,4.395 31.058,7.581c0.749,0.235 1.505,0.347 2.25,0.347c3.189,0 6.147,-2.051 7.153,-5.254c1.242,-3.953 -0.954,-8.163 -4.906,-9.404z"/>
-   <path fill="#ffffff" d="m307.998,184.26735c0.745,0 1.502,-0.112 2.25,-0.347c48.249,-15.159 99.256,-15.159 147.504,0c3.952,1.24 8.162,-0.956 9.403,-4.907c1.241,-3.952 -0.956,-8.162 -4.907,-9.403c-51.191,-16.083 -105.306,-16.083 -156.496,0c-3.952,1.241 -6.149,5.451 -4.907,9.403c1.007,3.203 3.964,5.254 7.153,5.254z"/>
-   <path fill="#ffffff" d="m355.178,127.20235c-16.732,1.858 -33.362,5.36 -49.426,10.407c-3.952,1.241 -6.148,5.451 -4.907,9.403c1.007,3.204 3.964,5.254 7.153,5.254c0.745,0 1.502,-0.112 2.25,-0.347c15.141,-4.757 30.815,-8.057 46.585,-9.809c4.117,-0.457 7.083,-4.165 6.626,-8.282s-4.169,-7.084 -8.281,-6.626z"/>
-   <path fill="#ffffff" d="m387.886,140.63735c23.725,0.375 47.231,4.17 69.866,11.283c0.748,0.234 1.505,0.347 2.25,0.347c3.189,0 6.146,-2.051 7.153,-5.254c1.241,-3.952 -0.956,-8.162 -4.907,-9.403c-24.015,-7.545 -48.955,-11.572 -74.125,-11.97c-4.125,-0.078 -7.552,3.239 -7.618,7.38s3.239,7.552 7.381,7.617z"/>
-   <path fill="#ffffff" d="m411.171,110.20435c4.116,0.46 7.825,-2.509 8.282,-6.626c0.458,-4.117 -2.509,-7.825 -6.626,-8.282c-36.252,-4.027 -72.278,-0.526 -107.075,10.406c-3.952,1.242 -6.148,5.452 -4.907,9.403c1.007,3.204 3.964,5.254 7.153,5.254c0.745,0 1.502,-0.112 2.25,-0.347c32.797,-10.304 66.752,-13.603 100.923,-9.808z"/>
-   <path fill="#ffffff" d="m462.248,105.70235c-5.418,-1.702 -10.96,-3.246 -16.472,-4.588c-4.03,-0.98 -8.082,1.488 -9.062,5.512c-0.98,4.024 1.488,8.082 5.512,9.062c5.196,1.265 10.419,2.72 15.526,4.324c0.748,0.235 1.505,0.347 2.25,0.347c3.189,0 6.147,-2.051 7.153,-5.254c1.241,-3.952 -0.955,-8.162 -4.907,-9.403z"/>
-   <path fill="#ffffff" d="m307.998,88.26735c0.745,0 1.502,-0.112 2.25,-0.347c5.103,-1.604 10.325,-3.058 15.521,-4.324c4.024,-0.98 6.492,-5.037 5.512,-9.062s-5.038,-6.492 -9.062,-5.512c-5.513,1.342 -11.053,2.886 -16.468,4.587c-3.951,1.242 -6.148,5.452 -4.907,9.403c1.008,3.204 3.965,5.255 7.154,5.255z"/>
-   <path fill="#ffffff" d="m356.829,78.11135c34.172,-3.796 68.126,-0.496 100.923,9.809c0.748,0.234 1.505,0.347 2.25,0.347c3.189,0 6.146,-2.051 7.153,-5.254c1.241,-3.952 -0.956,-8.162 -4.907,-9.403c-34.797,-10.933 -70.824,-14.435 -107.076,-10.406c-4.117,0.457 -7.083,4.165 -6.626,8.282c0.458,4.116 4.164,7.084 8.283,6.625z"/>
-   <path fill="#ffffff" d="m114.46,259.24935c-8.302,1.74 -16.615,3.911 -24.708,6.454c-3.952,1.242 -6.148,5.452 -4.907,9.403c1.007,3.204 3.964,5.254 7.153,5.254c0.745,0 1.502,-0.112 2.25,-0.347c7.628,-2.396 15.464,-4.443 23.288,-6.083c4.054,-0.85 6.652,-4.825 5.802,-8.879s-4.827,-6.651 -8.878,-5.802z"/>
-   <path fill="#ffffff" d="m244.002,280.35935c3.189,0 6.147,-2.051 7.153,-5.254c1.241,-3.952 -0.956,-8.162 -4.907,-9.403c-32.073,-10.076 -65.331,-13.842 -98.844,-11.188c-4.129,0.326 -7.211,3.938 -6.885,8.068s3.934,7.213 8.068,6.885c31.591,-2.499 62.935,1.048 93.165,10.546c0.748,0.235 1.505,0.346 2.25,0.346z"/>
-   <path fill="#ffffff" d="m91.998,248.26735c0.745,0 1.502,-0.112 2.25,-0.347c48.249,-15.159 99.256,-15.159 147.504,0c3.952,1.24 8.162,-0.956 9.403,-4.907c1.241,-3.952 -0.956,-8.162 -4.907,-9.403c-51.191,-16.083 -105.307,-16.083 -156.496,0c-3.952,1.241 -6.149,5.451 -4.907,9.403c1.007,3.203 3.964,5.254 7.153,5.254z"/>
-   <path fill="#ffffff" d="m91.998,216.35935c0.745,0 1.502,-0.112 2.25,-0.347c27.681,-8.697 56.411,-12.412 85.399,-11.037c4.158,0.192 7.65,-2.999 7.847,-7.137c0.196,-4.138 -2.999,-7.65 -7.137,-7.847c-30.756,-1.456 -61.236,2.483 -90.605,11.71c-3.952,1.242 -6.149,5.452 -4.907,9.403c1.007,3.206 3.964,5.255 7.153,5.255z"/>
-   <path fill="#ffffff" d="m210.694,208.43235c10.467,1.844 20.917,4.395 31.058,7.581c0.749,0.235 1.505,0.347 2.25,0.347c3.189,0 6.147,-2.051 7.153,-5.254c1.241,-3.952 -0.956,-8.162 -4.907,-9.403c-10.76,-3.38 -21.846,-6.086 -32.952,-8.043c-4.079,-0.719 -7.969,2.006 -8.688,6.085c-0.718,4.078 2.006,7.968 6.086,8.687z"/>
-   <path fill="#ffffff" d="m139.178,127.20235c-16.732,1.858 -33.362,5.36 -49.426,10.407c-3.952,1.241 -6.148,5.451 -4.907,9.403c1.007,3.204 3.964,5.254 7.153,5.254c0.745,0 1.502,-0.112 2.25,-0.347c15.141,-4.757 30.815,-8.057 46.585,-9.809c4.117,-0.457 7.083,-4.165 6.626,-8.282c-0.456,-4.116 -4.171,-7.084 -8.281,-6.626z"/>
-   <path fill="#ffffff" d="m84.845,115.10535c1.007,3.204 3.964,5.254 7.153,5.254c0.745,0 1.502,-0.112 2.25,-0.347c32.797,-10.305 66.752,-13.604 100.923,-9.809c4.116,0.46 7.825,-2.509 8.282,-6.626c0.458,-4.117 -2.509,-7.825 -6.626,-8.282c-36.253,-4.027 -72.278,-0.526 -107.075,10.406c-3.952,1.243 -6.148,5.453 -4.907,9.404z"/>
-   <path fill="#ffffff" d="m91.998,88.26735c0.745,0 1.502,-0.112 2.25,-0.347c5.103,-1.604 10.325,-3.058 15.521,-4.324c4.024,-0.98 6.492,-5.037 5.512,-9.062s-5.038,-6.492 -9.062,-5.512c-5.513,1.342 -11.053,2.886 -16.468,4.587c-3.951,1.242 -6.148,5.452 -4.907,9.403c1.008,3.204 3.965,5.255 7.154,5.255z"/>
-  </g>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
-  <g/>
- </g>
-</svg>

package/dist/default/services/Basket Service/index.md

@@ -1,16 +0,0 @@
----
-name: Basket Service
-summary: |
-  CRUD based API to handle Basket interactions for users of the shopping website.
-owners:
-    - dboyne
-repository:
-  language: JavaScript
-  url: https://github.com/boyney123/pretend-basket-service
----
-
-Simple API that handles interactions between users and their baskets. Use this service to add, remove and query the status of a users basket.
-
-This service will also generate Async events for downstream services.
-
-<NodeGraph />

package/dist/default/services/Data Lake/index.md

@@ -1,11 +0,0 @@
----
-name: Data Lake
-summary: |
-  Our internal datalake used by the data team and business analytics.
-owners:
-    - dboyne
----
-
-Our internal Data Lake platform used by the data team to consume events of our Architecture and provide valuable insights and analytics.
-
-<NodeGraph />

package/dist/default/services/Payment Service/index.md

@@ -1,15 +0,0 @@
----
-name: Payment Service
-summary: |
-  Event based application that integrates with Stripe.
-owners:
-  - dboyne
----
-
-The payment service is our own internal payment service that listens to events from stripe and handles them within our own domain. 
-
-We use Stripe to handle services and use this Payment service to enrich events for internal use.
-
-<OpenAPI />
-
-<NodeGraph />

package/dist/default/services/Payment Service/openapi.yaml

@@ -1,94 +0,0 @@
-openapi: 3.0.0
-info:
-  description: A Payment Service API
-  version: 0.0.1
-  title: Payment service API
-servers:
-  - url: http://payment.example.com/v1
-    description: Optional server description, e.g. Main (production) server
-  - url: http://payment.example.com
-    description: Optional server description, e.g. Internal staging server for testing
-paths:
-  /getSinglePaymentURL:
-    get:
-      tags:
-        - PaymentServices
-      summary: Generate a Payment endpoint URL
-      operationId: singlepaymenturlUsingGET
-      consumes:
-        - application/json
-      produces:
-        - application/xml
-      parameters:
-        - name: transType
-          in: query
-          description: transType
-          required: true
-          type: string
-        - name: invoiceNumber
-          in: query
-          description: invoiceNumber
-          required: true
-          type: string
-        - name: approvedPage
-          in: query
-          description: approvedPage
-          required: true
-          type: string
-        - name: declinedPage
-          in: query
-          description: declinedPage
-          required: true
-          type: string
-        - in: query
-          name: errorPage
-          description: errorPage
-          required: true
-          type: string
-        - in: query
-          name: totalItemsAmount
-          description: totalItemsAmount
-          required: true
-          type: string
-        - name: ref1
-          in: query
-          description: ref1
-          required: false
-          type: string
-        - name: ref2
-          in: query
-          description: ref2
-          required: false
-          type: string
-        - name: ref3
-          in: query
-          description: ref3
-          required: false
-          type: string
-        - name: minutesToExpire
-          in: query
-          description: minutesToExpire
-          required: true
-          type: string
-      responses:
-        '200':
-          description: Successful operation
-          schema:
-            $ref: '#/definitions/SinglePaymentResponse'
-        '401':
-          description: Unauthorized
-        '403':
-          description: Forbidden
-        '404':
-          description: Not Found
-definitions:
-  SinglePaymentResponse:
-    type: object
-    properties:
-      respCode:
-        type: integer
-        format: int32
-      respMsg:
-        type: string
-      respValue:
-        type: string

package/dist/default/services/Shipping Service/index.md

@@ -1,16 +0,0 @@
----
-name: Shipping Service
-summary: |
-  Event based application that handles processing of shipments, preparing them and dispatching them.
-owners:
-    - dboyne
-repository:
-  language: JavaScript
-  url: https://github.com/boyney123/pretend-shipping-service
----
-
-Event based service that allows you to create shipments, prepare them and dispatch them. This service handles the `Shipment` domain.
-
-This service will also generate Async events for downstream services.
-
-<NodeGraph />

package/dist/gitignore

@@ -1,24 +0,0 @@
-# Dependencies
-/node_modules
-
-# Production
-/build
-/public/schemas
-
-# Generated files
-.next
-out
-
-
-# Misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-.eventcatalog-core