@eventcatalog/create-eventcatalog 3.0.7 → 3.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/dist/index.js +3 -1
  2. package/package.json +1 -1
  3. package/templates/amazon-api-gateway/eventcatalog.auth.js +45 -0
  4. package/templates/amazon-api-gateway/eventcatalog.config.js +5 -0
  5. package/templates/asyncapi/eventcatalog.auth.js +45 -0
  6. package/templates/asyncapi/eventcatalog.config.js +5 -0
  7. package/templates/confluent/eventcatalog.auth.js +45 -0
  8. package/templates/confluent/eventcatalog.config.js +5 -0
  9. package/templates/default/eventcatalog.auth.js +45 -0
  10. package/templates/default/eventcatalog.config.js +5 -0
  11. package/templates/empty/eventcatalog.auth.js +45 -0
  12. package/templates/empty/eventcatalog.config.js +5 -0
  13. package/templates/eventbridge/eventcatalog.auth.js +45 -0
  14. package/templates/eventbridge/eventcatalog.config.js +5 -0
  15. package/templates/openapi/eventcatalog.auth.js +45 -0
  16. package/templates/openapi/eventcatalog.config.js +5 -0
package/dist/index.js CHANGED
@@ -22466,7 +22466,7 @@ var import_os2 = __toESM(require("os"));
22466
22466
  var package_default = {
22467
22467
  name: "@eventcatalog/create-eventcatalog",
22468
22468
  description: "Create EventCatalog with one command",
22469
- version: "3.0.7",
22469
+ version: "3.0.8",
22470
22470
  bin: {
22471
22471
  "create-catalog": "./dist/index.js"
22472
22472
  },
@@ -22707,6 +22707,8 @@ async function createApp({
22707
22707
  cdpath = appPath;
22708
22708
  }
22709
22709
  console.log(`${import_chalk4.default.green("Success!")} Created ${appName} at ${appPath}`);
22710
+ console.log(import_chalk4.default.yellow("\nIf you like EventCatalog, please consider starring us on GitHub! It means a lot to us: https://github.com/event-catalog/eventcatalog/stargazers"));
22711
+ console.log(import_chalk4.default.blue("\nGot questions? Join our community on Discord: https://discord.gg/3rjaZMmrAm"));
22710
22712
  if (hasPackageJson) {
22711
22713
  console.log("Inside that directory, you can run several commands:");
22712
22714
  console.log();
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@eventcatalog/create-eventcatalog",
3
3
  "description": "Create EventCatalog with one command",
4
- "version": "3.0.7",
4
+ "version": "3.0.8",
5
5
  "bin": {
6
6
  "create-catalog": "./dist/index.js"
7
7
  },
package/templates/amazon-api-gateway/eventcatalog.auth.js ADDED
@@ -0,0 +1,45 @@
1
+
2
+ /**
3
+ * This is an optional file that can add authentication to your EventCatalog.
4
+ *
5
+ * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
+ * And then pick which provider you want to use.
7
+ *
8
+ * You can read more in the documentation:
9
+ * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
+ *
11
+ */
12
+
13
+ // export default {
14
+ // debug: false,
15
+ // providers: {
16
+ // // GitHub Authentication
17
+ // github: {
18
+ // clientId: process.env.AUTH_GITHUB_CLIENT_ID,
19
+ // clientSecret: process.env.AUTH_GITHUB_CLIENT_SECRET,
20
+ // },
21
+ // // Azure AD Entra ID
22
+ // entra: {
23
+ // clientId: process.env.AUTH_MICROSOFT_ENTRA_ID_ID,
24
+ // clientSecret: process.env.AUTH_MICROSOFT_ENTRA_ID_SECRET,
25
+ // issuer: process.env.AUTH_MICROSOFT_ENTRA_ID_ISSUER,
26
+ // },
27
+ // // Google Authentication
28
+ // google: {
29
+ // clientId: process.env.AUTH_GOOGLE_ID,
30
+ // clientSecret: process.env.AUTH_GOOGLE_SECRET,
31
+ // },
32
+ // // Auth0 Authentication
33
+ // auth0: {
34
+ // clientId: process.env.AUTH_AUTH0_ID,
35
+ // clientSecret: process.env.AUTH_AUTH0_SECRET,
36
+ // issuer: process.env.AUTH_AUTH0_ISSUER,
37
+ // },
38
+ // // Okta Authentication
39
+ // okta: {
40
+ // clientId: process.env.AUTH_OKTA_CLIENT_ID,
41
+ // clientSecret: process.env.AUTH_OKTA_CLIENT_SECRET,
42
+ // issuer: process.env.AUTH_OKTA_ISSUER,
43
+ // },
44
+ // },
45
+ // }
package/templates/amazon-api-gateway/eventcatalog.config.js CHANGED
@@ -29,6 +29,11 @@ export default {
29
29
  type: 'LIST_VIEW'
30
30
  },
31
31
  },
32
+ // This lets you copy markdown contents from EventCatalog to your clipboard
33
+ // Including schemas for your events and services
34
+ llmsTxt: {
35
+ enabled: true,
36
+ },
32
37
  // required random generated id used by eventcatalog
33
38
  cId: '<cId>',
34
39
  generators: [
package/templates/asyncapi/eventcatalog.auth.js ADDED
@@ -0,0 +1,45 @@
1
+
2
+ /**
3
+ * This is an optional file that can add authentication to your EventCatalog.
4
+ *
5
+ * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
+ * And then pick which provider you want to use.
7
+ *
8
+ * You can read more in the documentation:
9
+ * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
+ *
11
+ */
12
+
13
+ // export default {
14
+ // debug: false,
15
+ // providers: {
16
+ // // GitHub Authentication
17
+ // github: {
18
+ // clientId: process.env.AUTH_GITHUB_CLIENT_ID,
19
+ // clientSecret: process.env.AUTH_GITHUB_CLIENT_SECRET,
20
+ // },
21
+ // // Azure AD Entra ID
22
+ // entra: {
23
+ // clientId: process.env.AUTH_MICROSOFT_ENTRA_ID_ID,
24
+ // clientSecret: process.env.AUTH_MICROSOFT_ENTRA_ID_SECRET,
25
+ // issuer: process.env.AUTH_MICROSOFT_ENTRA_ID_ISSUER,
26
+ // },
27
+ // // Google Authentication
28
+ // google: {
29
+ // clientId: process.env.AUTH_GOOGLE_ID,
30
+ // clientSecret: process.env.AUTH_GOOGLE_SECRET,
31
+ // },
32
+ // // Auth0 Authentication
33
+ // auth0: {
34
+ // clientId: process.env.AUTH_AUTH0_ID,
35
+ // clientSecret: process.env.AUTH_AUTH0_SECRET,
36
+ // issuer: process.env.AUTH_AUTH0_ISSUER,
37
+ // },
38
+ // // Okta Authentication
39
+ // okta: {
40
+ // clientId: process.env.AUTH_OKTA_CLIENT_ID,
41
+ // clientSecret: process.env.AUTH_OKTA_CLIENT_SECRET,
42
+ // issuer: process.env.AUTH_OKTA_ISSUER,
43
+ // },
44
+ // },
45
+ // }
package/templates/asyncapi/eventcatalog.config.js CHANGED
@@ -20,6 +20,11 @@ export default {
20
20
  src: '/logo.png',
21
21
  text: 'EventCatalog',
22
22
  },
23
+ // This lets you copy markdown contents from EventCatalog to your clipboard
24
+ // Including schemas for your events and services
25
+ llmsTxt: {
26
+ enabled: true,
27
+ },
23
28
  generators: [
24
29
  [
25
30
  '@eventcatalog/generator-asyncapi',
package/templates/confluent/eventcatalog.auth.js ADDED
@@ -0,0 +1,45 @@
1
+
2
+ /**
3
+ * This is an optional file that can add authentication to your EventCatalog.
4
+ *
5
+ * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
+ * And then pick which provider you want to use.
7
+ *
8
+ * You can read more in the documentation:
9
+ * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
+ *
11
+ */
12
+
13
+ // export default {
14
+ // debug: false,
15
+ // providers: {
16
+ // // GitHub Authentication
17
+ // github: {
18
+ // clientId: process.env.AUTH_GITHUB_CLIENT_ID,
19
+ // clientSecret: process.env.AUTH_GITHUB_CLIENT_SECRET,
20
+ // },
21
+ // // Azure AD Entra ID
22
+ // entra: {
23
+ // clientId: process.env.AUTH_MICROSOFT_ENTRA_ID_ID,
24
+ // clientSecret: process.env.AUTH_MICROSOFT_ENTRA_ID_SECRET,
25
+ // issuer: process.env.AUTH_MICROSOFT_ENTRA_ID_ISSUER,
26
+ // },
27
+ // // Google Authentication
28
+ // google: {
29
+ // clientId: process.env.AUTH_GOOGLE_ID,
30
+ // clientSecret: process.env.AUTH_GOOGLE_SECRET,
31
+ // },
32
+ // // Auth0 Authentication
33
+ // auth0: {
34
+ // clientId: process.env.AUTH_AUTH0_ID,
35
+ // clientSecret: process.env.AUTH_AUTH0_SECRET,
36
+ // issuer: process.env.AUTH_AUTH0_ISSUER,
37
+ // },
38
+ // // Okta Authentication
39
+ // okta: {
40
+ // clientId: process.env.AUTH_OKTA_CLIENT_ID,
41
+ // clientSecret: process.env.AUTH_OKTA_CLIENT_SECRET,
42
+ // issuer: process.env.AUTH_OKTA_ISSUER,
43
+ // },
44
+ // },
45
+ // }
package/templates/confluent/eventcatalog.config.js CHANGED
@@ -31,6 +31,11 @@ export default {
31
31
  },
32
32
  // required random generated id used by eventcatalog
33
33
  cId: '<cId>',
34
+ // This lets you copy markdown contents from EventCatalog to your clipboard
35
+ // Including schemas for your events and services
36
+ llmsTxt: {
37
+ enabled: true,
38
+ },
34
39
  generators: [
35
40
  [
36
41
  '@eventcatalog/generator-confluent-schema-registry',
package/templates/default/eventcatalog.auth.js ADDED
@@ -0,0 +1,45 @@
1
+
2
+ /**
3
+ * This is an optional file that can add authentication to your EventCatalog.
4
+ *
5
+ * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
+ * And then pick which provider you want to use.
7
+ *
8
+ * You can read more in the documentation:
9
+ * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
+ *
11
+ */
12
+
13
+ // export default {
14
+ // debug: false,
15
+ // providers: {
16
+ // // GitHub Authentication
17
+ // github: {
18
+ // clientId: process.env.AUTH_GITHUB_CLIENT_ID,
19
+ // clientSecret: process.env.AUTH_GITHUB_CLIENT_SECRET,
20
+ // },
21
+ // // Azure AD Entra ID
22
+ // entra: {
23
+ // clientId: process.env.AUTH_MICROSOFT_ENTRA_ID_ID,
24
+ // clientSecret: process.env.AUTH_MICROSOFT_ENTRA_ID_SECRET,
25
+ // issuer: process.env.AUTH_MICROSOFT_ENTRA_ID_ISSUER,
26
+ // },
27
+ // // Google Authentication
28
+ // google: {
29
+ // clientId: process.env.AUTH_GOOGLE_ID,
30
+ // clientSecret: process.env.AUTH_GOOGLE_SECRET,
31
+ // },
32
+ // // Auth0 Authentication
33
+ // auth0: {
34
+ // clientId: process.env.AUTH_AUTH0_ID,
35
+ // clientSecret: process.env.AUTH_AUTH0_SECRET,
36
+ // issuer: process.env.AUTH_AUTH0_ISSUER,
37
+ // },
38
+ // // Okta Authentication
39
+ // okta: {
40
+ // clientId: process.env.AUTH_OKTA_CLIENT_ID,
41
+ // clientSecret: process.env.AUTH_OKTA_CLIENT_SECRET,
42
+ // issuer: process.env.AUTH_OKTA_ISSUER,
43
+ // },
44
+ // },
45
+ // }
package/templates/default/eventcatalog.config.js CHANGED
@@ -29,6 +29,11 @@ export default {
29
29
  // number of items to include in the feed per resource (event, service, etc)
30
30
  limit: 20
31
31
  },
32
+ // This lets you copy markdown contents from EventCatalog to your clipboard
33
+ // Including schemas for your events and services
34
+ llmsTxt: {
35
+ enabled: true,
36
+ },
32
37
  // required random generated id used by eventcatalog
33
38
  cId: '<cId>'
34
39
  }
package/templates/empty/eventcatalog.auth.js ADDED
@@ -0,0 +1,45 @@
1
+
2
+ /**
3
+ * This is an optional file that can add authentication to your EventCatalog.
4
+ *
5
+ * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
+ * And then pick which provider you want to use.
7
+ *
8
+ * You can read more in the documentation:
9
+ * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
+ *
11
+ */
12
+
13
+ // export default {
14
+ // debug: false,
15
+ // providers: {
16
+ // // GitHub Authentication
17
+ // github: {
18
+ // clientId: process.env.AUTH_GITHUB_CLIENT_ID,
19
+ // clientSecret: process.env.AUTH_GITHUB_CLIENT_SECRET,
20
+ // },
21
+ // // Azure AD Entra ID
22
+ // entra: {
23
+ // clientId: process.env.AUTH_MICROSOFT_ENTRA_ID_ID,
24
+ // clientSecret: process.env.AUTH_MICROSOFT_ENTRA_ID_SECRET,
25
+ // issuer: process.env.AUTH_MICROSOFT_ENTRA_ID_ISSUER,
26
+ // },
27
+ // // Google Authentication
28
+ // google: {
29
+ // clientId: process.env.AUTH_GOOGLE_ID,
30
+ // clientSecret: process.env.AUTH_GOOGLE_SECRET,
31
+ // },
32
+ // // Auth0 Authentication
33
+ // auth0: {
34
+ // clientId: process.env.AUTH_AUTH0_ID,
35
+ // clientSecret: process.env.AUTH_AUTH0_SECRET,
36
+ // issuer: process.env.AUTH_AUTH0_ISSUER,
37
+ // },
38
+ // // Okta Authentication
39
+ // okta: {
40
+ // clientId: process.env.AUTH_OKTA_CLIENT_ID,
41
+ // clientSecret: process.env.AUTH_OKTA_CLIENT_SECRET,
42
+ // issuer: process.env.AUTH_OKTA_ISSUER,
43
+ // },
44
+ // },
45
+ // }
package/templates/empty/eventcatalog.config.js CHANGED
@@ -22,6 +22,11 @@ export default {
22
22
  // number of items to include in the feed per resource (event, service, etc)
23
23
  limit: 20
24
24
  },
25
+ // This lets you copy markdown contents from EventCatalog to your clipboard
26
+ // Including schemas for your events and services
27
+ llmsTxt: {
28
+ enabled: true,
29
+ },
25
30
  docs: {
26
31
  sidebar: {
27
32
  // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
package/templates/eventbridge/eventcatalog.auth.js ADDED
@@ -0,0 +1,45 @@
1
+
2
+ /**
3
+ * This is an optional file that can add authentication to your EventCatalog.
4
+ *
5
+ * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
+ * And then pick which provider you want to use.
7
+ *
8
+ * You can read more in the documentation:
9
+ * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
+ *
11
+ */
12
+
13
+ // export default {
14
+ // debug: false,
15
+ // providers: {
16
+ // // GitHub Authentication
17
+ // github: {
18
+ // clientId: process.env.AUTH_GITHUB_CLIENT_ID,
19
+ // clientSecret: process.env.AUTH_GITHUB_CLIENT_SECRET,
20
+ // },
21
+ // // Azure AD Entra ID
22
+ // entra: {
23
+ // clientId: process.env.AUTH_MICROSOFT_ENTRA_ID_ID,
24
+ // clientSecret: process.env.AUTH_MICROSOFT_ENTRA_ID_SECRET,
25
+ // issuer: process.env.AUTH_MICROSOFT_ENTRA_ID_ISSUER,
26
+ // },
27
+ // // Google Authentication
28
+ // google: {
29
+ // clientId: process.env.AUTH_GOOGLE_ID,
30
+ // clientSecret: process.env.AUTH_GOOGLE_SECRET,
31
+ // },
32
+ // // Auth0 Authentication
33
+ // auth0: {
34
+ // clientId: process.env.AUTH_AUTH0_ID,
35
+ // clientSecret: process.env.AUTH_AUTH0_SECRET,
36
+ // issuer: process.env.AUTH_AUTH0_ISSUER,
37
+ // },
38
+ // // Okta Authentication
39
+ // okta: {
40
+ // clientId: process.env.AUTH_OKTA_CLIENT_ID,
41
+ // clientSecret: process.env.AUTH_OKTA_CLIENT_SECRET,
42
+ // issuer: process.env.AUTH_OKTA_ISSUER,
43
+ // },
44
+ // },
45
+ // }
package/templates/eventbridge/eventcatalog.config.js CHANGED
@@ -29,6 +29,11 @@ export default {
29
29
  type: 'LIST_VIEW'
30
30
  },
31
31
  },
32
+ // This lets you copy markdown contents from EventCatalog to your clipboard
33
+ // Including schemas for your events and services
34
+ llmsTxt: {
35
+ enabled: true,
36
+ },
32
37
  // required random generated id used by eventcatalog
33
38
  cId: '<cId>',
34
39
  // Just import all events into the Catalog from a registry
package/templates/openapi/eventcatalog.auth.js ADDED
@@ -0,0 +1,45 @@
1
+
2
+ /**
3
+ * This is an optional file that can add authentication to your EventCatalog.
4
+ *
5
+ * To enable authentication you need to set `server:output` in your `eventcatalog.config.js` file.
6
+ * And then pick which provider you want to use.
7
+ *
8
+ * You can read more in the documentation:
9
+ * https://www.eventcatalog.dev/docs/development/guides/authentication/introduction
10
+ *
11
+ */
12
+
13
+ // export default {
14
+ // debug: false,
15
+ // providers: {
16
+ // // GitHub Authentication
17
+ // github: {
18
+ // clientId: process.env.AUTH_GITHUB_CLIENT_ID,
19
+ // clientSecret: process.env.AUTH_GITHUB_CLIENT_SECRET,
20
+ // },
21
+ // // Azure AD Entra ID
22
+ // entra: {
23
+ // clientId: process.env.AUTH_MICROSOFT_ENTRA_ID_ID,
24
+ // clientSecret: process.env.AUTH_MICROSOFT_ENTRA_ID_SECRET,
25
+ // issuer: process.env.AUTH_MICROSOFT_ENTRA_ID_ISSUER,
26
+ // },
27
+ // // Google Authentication
28
+ // google: {
29
+ // clientId: process.env.AUTH_GOOGLE_ID,
30
+ // clientSecret: process.env.AUTH_GOOGLE_SECRET,
31
+ // },
32
+ // // Auth0 Authentication
33
+ // auth0: {
34
+ // clientId: process.env.AUTH_AUTH0_ID,
35
+ // clientSecret: process.env.AUTH_AUTH0_SECRET,
36
+ // issuer: process.env.AUTH_AUTH0_ISSUER,
37
+ // },
38
+ // // Okta Authentication
39
+ // okta: {
40
+ // clientId: process.env.AUTH_OKTA_CLIENT_ID,
41
+ // clientSecret: process.env.AUTH_OKTA_CLIENT_SECRET,
42
+ // issuer: process.env.AUTH_OKTA_ISSUER,
43
+ // },
44
+ // },
45
+ // }
package/templates/openapi/eventcatalog.config.js CHANGED
@@ -21,6 +21,11 @@ export default {
21
21
  src: "/logo.png",
22
22
  text: "EventCatalog",
23
23
  },
24
+ // This lets you copy markdown contents from EventCatalog to your clipboard
25
+ // Including schemas for your events and services
26
+ llmsTxt: {
27
+ enabled: true,
28
+ },
24
29
  generators: [
25
30
  [
26
31
  "@eventcatalog/generator-openapi",