@eventcatalog/create-eventcatalog 3.0.10 → 3.0.12

package/templates/graphql/Dockerfile

@@ -0,0 +1,23 @@
+## Stage 1: Build the app
+FROM node:lts AS build
+
+WORKDIR /app
+
+# Install dependencies
+COPY package.json package-lock.json ./
+RUN npm install
+
+# Copy source code
+COPY . .
+
+# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
+ENV NODE_OPTIONS=--max_old_space_size=2048
+# Build the app
+RUN npm run build
+
+
+## Stage 2: Serve app with httpd server
+FROM httpd:2.4
+
+# Copy built app to serve
+COPY --from=build /app/dist /usr/local/apache2/htdocs

package/templates/graphql/Dockerfile.server

@@ -0,0 +1,23 @@
+# Use this Docker file if your EventCatalog output is set to `server`.
+# When EventCatalog output is set to `server`, the output will be a node server.
+# This server is required for certain features like the EventCatalog Chat (with your own keys).
+
+FROM node:lts AS runtime
+WORKDIR /app
+
+# Install dependencies
+COPY package.json package-lock.json ./
+RUN npm install
+
+COPY . .
+
+# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
+ENV NODE_OPTIONS=--max_old_space_size=2048
+RUN npm run build
+
+ENV HOST=0.0.0.0
+ENV PORT=3000
+EXPOSE 3000
+
+# Start the server
+CMD npm run start

package/templates/graphql/README-template.md

@@ -0,0 +1 @@
+# My Event Catalog

package/templates/graphql/dockerignore

@@ -0,0 +1,8 @@
+.eventcatalog-core/
+.git/
+dist/
+node_modules/
+.gitignore
+.dockerignore
+Dockerfile
+README.md

package/templates/graphql/env

@@ -0,0 +1,9 @@
+# EventCatalog Scale License Key, if you want to unlock the scale features
+# You can get a 14 day trial license key from https://eventcatalog.cloud
+
+EVENTCATALOG_SCALE_LICENSE_KEY=
+
+# Optional key if you are using EventCatalog Chat with OpenAI Models.
+# You need to set `output` to `server` in your eventcatalog.config.js file.
+# See documentation for more details: https://www.eventcatalog.dev/features/ai-assistant
+OPENAI_API_KEY=

package/templates/graphql/eventcatalog.auth.js

@@ -0,0 +1,45 @@
+
+/**
+ * This is an optional file that can add authentication to your EventCatalog.
+ * 
+ * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
+ * And then pick which provider you want to use.
+ * 
+ * You can read more in the documentation:
+ * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
+ * 
+ */
+
+// export default {
+//   debug: false,
+//   providers: {
+//     // GitHub Authentication
+//     github: {
+//       clientId: process.env.AUTH_GITHUB_CLIENT_ID,
+//       clientSecret: process.env.AUTH_GITHUB_CLIENT_SECRET,
+//     },
+//     // Azure AD Entra ID
+//     entra: {
+//       clientId: process.env.AUTH_MICROSOFT_ENTRA_ID_ID,
+//       clientSecret: process.env.AUTH_MICROSOFT_ENTRA_ID_SECRET,
+//       issuer: process.env.AUTH_MICROSOFT_ENTRA_ID_ISSUER,
+//     },
+//     // Google Authentication
+//     google: {
+//       clientId: process.env.AUTH_GOOGLE_ID,
+//       clientSecret: process.env.AUTH_GOOGLE_SECRET,
+//     },
+//     // Auth0 Authentication
+//     auth0: {
+//       clientId: process.env.AUTH_AUTH0_ID,
+//       clientSecret: process.env.AUTH_AUTH0_SECRET,
+//       issuer: process.env.AUTH_AUTH0_ISSUER,
+//     },
+//     // Okta Authentication
+//     okta: {
+//       clientId: process.env.AUTH_OKTA_CLIENT_ID,
+//       clientSecret: process.env.AUTH_OKTA_CLIENT_SECRET,
+//       issuer: process.env.AUTH_OKTA_ISSUER,
+//     },
+//   },
+// }

package/templates/graphql/eventcatalog.config.js

@@ -0,0 +1,60 @@
+import path from "path";
+import url from "url";
+
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+/** @type {import('@eventcatalog/core/bin/eventcatalog.config').Config} */
+export default {
+  title: "EventCatalog",
+  tagline: 'This internal platform provides a comprehensive view of our event-driven architecture across all systems. Use this portal to discover existing domains, explore services and their dependencies, and understand the message contracts that connect our infrastructure',
+  organizationName: '<organizationName>',
+  homepageLink: "https://eventcatalog.dev/",
+  editUrl: "https://github.com/boyney123/eventcatalog-demo/edit/master",
+  // Supports static or server. Static renders a static site, server renders a server side rendered site
+  // large catalogs may benefit from server side rendering
+  output: 'static',
+  // By default set to false, add true to get urls ending in /
+  trailingSlash: false,
+  // Change to make the base url of the site different, by default https://{website}.com/docs,
+  // changing to /company would be https://{website}.com/company/docs,
+  base: "/",
+  // Customize the logo, add your logo to public/ folder
+  logo: {
+    alt: "EventCatalog Logo",
+    src: "/logo.png",
+    text: "EventCatalog",
+  },
+  // This lets you copy markdown contents from EventCatalog to your clipboard
+  // Including schemas for your events and services
+  llmsTxt: {
+    enabled: true,
+  },
+  generators: [
+    [
+      "@eventcatalog/generator-graphql",
+      {
+        services: [
+          { path: path.join(__dirname, "graphql-files", "orders-service.graphql"), id: 'orders-service', owners: ['order-management'] },
+        ],
+        domain: { id: "orders", name: "Orders", version: "0.0.1" },
+      },
+    ],
+    [
+      "@eventcatalog/generator-graphql",
+      {
+        services: [
+          { path: path.join(__dirname, "graphql-files", "payment-service.graphql"), id: 'payment-service', owners: ['payment-management'] },
+        ],
+        domain: { id: "payment", name: "Payment", version: "0.0.1" },
+      },
+    ],
+  ],
+  // Enable RSS feed for your eventcatalog
+  rss: {
+    enabled: true,
+    // number of items to include in the feed per resource (event, service, etc)
+    limit: 20
+  },
+  // required random generated id used by eventcatalog
+  cId: '<cId>'
+};

package/templates/graphql/eventcatalog.styles.css

@@ -0,0 +1 @@
+/* Custom styling support coming soon. */

package/templates/graphql/gitignore

@@ -0,0 +1,27 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.astro
+out
+dist
+
+
+# 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
+
+.env
+.env-*

package/templates/graphql/graphql-files/orders-service.graphql

@@ -0,0 +1,76 @@
+type Query {
+  """
+  Fetch a user by their unique ID
+  """
+  getUser(id: ID!): User
+  """
+  Retrieve all users from the system
+  """
+  getUsers: [User!]!
+  """
+  Get user profile information by user ID
+  """
+  getProfile(userId: ID!): Profile
+}
+
+type Mutation {
+  """
+  Create a new user account
+  """
+  createUser(input: CreateUserInput!): User
+  """
+  Update an existing user's information
+  """
+  updateUser(id: ID!, input: UpdateUserInput!): User
+  """
+  Delete a user from the system
+  """
+  deleteUser(id: ID!): Boolean
+  """
+  Update user profile details
+  """
+  updateProfile(userId: ID!, input: UpdateProfileInput!): Profile
+}
+
+type Subscription {
+  """
+  Subscribe to user creation events
+  """
+  userCreated: User
+  """
+  Subscribe to user update events
+  """
+  userUpdated: User
+  """
+  Triggered when a user is deleted
+  """
+  userDeleted: ID
+}
+
+type User {
+  id: ID!
+  name: String!
+  email: String!
+  profile: Profile
+}
+
+type Profile {
+  id: ID!
+  bio: String
+  avatar: String
+}
+
+input CreateUserInput {
+  name: String!
+  email: String!
+}
+
+input UpdateUserInput {
+  name: String
+  email: String
+}
+
+input UpdateProfileInput {
+  bio: String
+  avatar: String
+}

package/templates/graphql/graphql-files/payment-service.graphql

@@ -0,0 +1,327 @@
+type Query {
+  """
+  Fetch a payment by its unique ID
+  """
+  getPayment(id: ID!): Payment
+  """
+  Retrieve all payments for a specific user
+  """
+  getPaymentsByUser(userId: ID!): [Payment!]!
+  """
+  Get payment history with optional filtering
+  """
+  getPaymentHistory(
+    userId: ID
+    status: PaymentStatus
+    dateFrom: String
+    dateTo: String
+    limit: Int = 10
+    offset: Int = 0
+  ): PaymentConnection!
+  """
+  Fetch payment methods for a user
+  """
+  getPaymentMethods(userId: ID!): [PaymentMethod!]!
+  """
+  Get a specific payment method by ID
+  """
+  getPaymentMethod(id: ID!): PaymentMethod
+  """
+  Retrieve transaction details by ID
+  """
+  getTransaction(id: ID!): Transaction
+  """
+  Get all transactions for a payment
+  """
+  getTransactionsByPayment(paymentId: ID!): [Transaction!]!
+  """
+  Check payment status and details
+  """
+  getPaymentStatus(paymentId: ID!): PaymentStatusResponse!
+}
+
+type Mutation {
+  """
+  Process a new payment
+  """
+  processPayment(input: ProcessPaymentInput!): PaymentResult!
+  """
+  Refund a payment (full or partial)
+  """
+  refundPayment(input: RefundPaymentInput!): RefundResult!
+  """
+  Add a new payment method for a user
+  """
+  addPaymentMethod(input: AddPaymentMethodInput!): PaymentMethod!
+  """
+  Update an existing payment method
+  """
+  updatePaymentMethod(id: ID!, input: UpdatePaymentMethodInput!): PaymentMethod!
+  """
+  Remove a payment method
+  """
+  removePaymentMethod(id: ID!): Boolean!
+  """
+  Set a payment method as default
+  """
+  setDefaultPaymentMethod(userId: ID!, paymentMethodId: ID!): PaymentMethod!
+  """
+  Cancel a pending payment
+  """
+  cancelPayment(paymentId: ID!): Payment!
+  """
+  Retry a failed payment
+  """
+  retryPayment(paymentId: ID!): PaymentResult!
+  """
+  Capture an authorized payment
+  """
+  capturePayment(paymentId: ID!, amount: Float): Payment!
+}
+
+type Subscription {
+  """
+  Subscribe to payment status updates
+  """
+  paymentStatusUpdated(paymentId: ID!): Payment!
+  """
+  Subscribe to all payment events for a user
+  """
+  userPaymentEvents(userId: ID!): PaymentEvent!
+  """
+  Subscribe to transaction updates
+  """
+  transactionUpdated(transactionId: ID!): Transaction!
+  """
+  Subscribe to refund status changes
+  """
+  refundStatusUpdated(refundId: ID!): Refund!
+}
+
+type Payment {
+  id: ID!
+  userId: ID!
+  amount: Float!
+  currency: String!
+  status: PaymentStatus!
+  description: String
+  paymentMethod: PaymentMethod!
+  transactions: [Transaction!]!
+  refunds: [Refund!]!
+  metadata: PaymentMetadata
+  createdAt: String!
+  updatedAt: String!
+  expiresAt: String
+}
+
+type PaymentMethod {
+  id: ID!
+  userId: ID!
+  type: PaymentMethodType!
+  isDefault: Boolean!
+  card: CardDetails
+  bankAccount: BankAccountDetails
+  digitalWallet: DigitalWalletDetails
+  isActive: Boolean!
+  createdAt: String!
+  updatedAt: String!
+}
+
+type CardDetails {
+  last4: String!
+  brand: String!
+  expiryMonth: Int!
+  expiryYear: Int!
+  fingerprint: String!
+  country: String
+}
+
+type BankAccountDetails {
+  last4: String!
+  bankName: String!
+  accountType: String!
+  country: String!
+}
+
+type DigitalWalletDetails {
+  provider: String!
+  email: String
+}
+
+type Transaction {
+  id: ID!
+  paymentId: ID!
+  type: TransactionType!
+  amount: Float!
+  currency: String!
+  status: TransactionStatus!
+  gateway: String!
+  gatewayTransactionId: String
+  failureReason: String
+  createdAt: String!
+  updatedAt: String!
+}
+
+type Refund {
+  id: ID!
+  paymentId: ID!
+  amount: Float!
+  currency: String!
+  status: RefundStatus!
+  reason: String
+  createdAt: String!
+  updatedAt: String!
+}
+
+type PaymentConnection {
+  edges: [PaymentEdge!]!
+  pageInfo: PageInfo!
+  totalCount: Int!
+}
+
+type PaymentEdge {
+  node: Payment!
+  cursor: String!
+}
+
+type PageInfo {
+  hasNextPage: Boolean!
+  hasPreviousPage: Boolean!
+  startCursor: String
+  endCursor: String
+}
+
+type PaymentMetadata {
+  orderId: String
+  customerId: String
+  invoiceId: String
+  tags: [String!]
+  notes: String
+}
+
+type PaymentResult {
+  payment: Payment
+  success: Boolean!
+  error: PaymentError
+  requiresAction: Boolean!
+  actionUrl: String
+}
+
+type RefundResult {
+  refund: Refund
+  success: Boolean!
+  error: PaymentError
+}
+
+type PaymentStatusResponse {
+  payment: Payment!
+  canRefund: Boolean!
+  canCapture: Boolean!
+  canCancel: Boolean!
+}
+
+type PaymentEvent {
+  id: ID!
+  type: PaymentEventType!
+  paymentId: ID!
+  data: String!
+  createdAt: String!
+}
+
+type PaymentError {
+  code: String!
+  message: String!
+  details: String
+}
+
+enum PaymentStatus {
+  PENDING
+  PROCESSING
+  AUTHORIZED
+  CAPTURED
+  SUCCEEDED
+  FAILED
+  CANCELLED
+  EXPIRED
+  REFUNDED
+  PARTIALLY_REFUNDED
+}
+
+enum PaymentMethodType {
+  CREDIT_CARD
+  DEBIT_CARD
+  BANK_ACCOUNT
+  DIGITAL_WALLET
+  CRYPTOCURRENCY
+}
+
+enum TransactionType {
+  AUTHORIZATION
+  CAPTURE
+  SALE
+  REFUND
+  VOID
+}
+
+enum TransactionStatus {
+  PENDING
+  SUCCEEDED
+  FAILED
+  CANCELLED
+}
+
+enum RefundStatus {
+  PENDING
+  PROCESSING
+  SUCCEEDED
+  FAILED
+  CANCELLED
+}
+
+enum PaymentEventType {
+  PAYMENT_CREATED
+  PAYMENT_AUTHORIZED
+  PAYMENT_CAPTURED
+  PAYMENT_SUCCEEDED
+  PAYMENT_FAILED
+  PAYMENT_CANCELLED
+  REFUND_CREATED
+  REFUND_SUCCEEDED
+  REFUND_FAILED
+}
+
+input ProcessPaymentInput {
+  userId: ID!
+  amount: Float!
+  currency: String!
+  paymentMethodId: ID!
+  description: String
+  captureImmediately: Boolean = true
+  metadata: PaymentMetadataInput
+}
+
+input RefundPaymentInput {
+  paymentId: ID!
+  amount: Float
+  reason: String
+}
+
+input AddPaymentMethodInput {
+  userId: ID!
+  type: PaymentMethodType!
+  token: String!
+  setAsDefault: Boolean = false
+}
+
+input UpdatePaymentMethodInput {
+  isActive: Boolean
+  setAsDefault: Boolean
+}
+
+input PaymentMetadataInput {
+  orderId: String
+  customerId: String
+  invoiceId: String
+  tags: [String!]
+  notes: String
+}

package/templates/graphql/npmrc

@@ -0,0 +1 @@
+strict-peer-dependencies=false

package/templates/graphql/teams/order-management.mdx

@@ -0,0 +1,31 @@
+---
+id: order-management
+name: Order Management
+summmary: Order Management team based in London, UK
+members:
+    - dboyne
+    - asmith
+    - msmith
+    - alee
+    - azhang
+email: test@test.com
+slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+---
+
+## Overview
+
+The Order Management team is responsible for managing orders, inventory, shipment and payment.
+
+## Responsibilities
+
+- Manage orders and order processing
+- Manage inventory and inventory processing
+- Manage shipment and shipment processing
+- Manage payment and payment processing
+- Manage user and user processing
+
+## Key Contacts
+
+- David Boyne
+- Alice Smith
+- Mike Smith

package/templates/graphql/teams/payment-management.mdx

@@ -0,0 +1,18 @@
+---
+id: payment-management
+name: Payment Management
+members:
+    - dboyne
+    - jbrown
+    - dkim
+---
+
+The payment management team is responsible for managing payments and payment accounts.
+
+## Responsibilities
+
+- Manage payment and payment account management
+- Manage payment and payment account provisioning
+- Manage payment and payment account deprovisioning
+- Manage user and user account password management
+- Manage user and user account role management

package/templates/graphql/teams/product-management.mdx

@@ -0,0 +1,18 @@
+---
+id: product-management
+name: Product Management
+members:
+    - dboyne
+    - jbrown
+    - dkim
+---
+
+The product management team is responsible for managing products and product accounts.
+
+## Responsibilities
+
+- Manage product and product account management
+- Manage product and product account provisioning
+- Manage product and product account deprovisioning
+- Manage product and product account password management
+- Manage product and product account role management