@eventcatalog/sdk 2.28.0 → 2.29.0

package/dist/index.d.mts

@@ -439,10 +439,12 @@ interface UbiquitousLanguage {
   summary?: string;
   description?: string;
   icon?: string;
+  editUrl?: string;
 }
 
 interface UbiquitousLanguageDictionary {
   dictionary: UbiquitousLanguage[];
+  editUrl?: string;
 }
 
 interface DetailPanelProperty {
@@ -663,6 +665,8 @@ interface ToDSLOptions {
 type IndexResourceType = 'adr' | 'agent' | 'channel' | 'command' | 'container' | 'data-product' | 'diagram' | 'domain' | 'entity' | 'event' | 'flow' | 'query' | 'service' | 'system' | 'team' | 'user';
 type IndexSchema = Omit<SchemaPointer, 'file'> & {
     hash?: string;
+    /** Raw schema file text. Only present when the index was built with `includeSchemaContent`. */
+    content?: string;
 };
 type IndexSpecification = Specification & {
     hash?: string;
@@ -1418,6 +1422,7 @@ declare const FederationIndexSchema: z.ZodObject<{
             environments: z.ZodOptional<z.ZodArray<z.ZodString>>;
             default: z.ZodOptional<z.ZodBoolean>;
             hash: z.ZodOptional<z.ZodString>;
+            content: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>>;
         specifications: z.ZodOptional<z.ZodArray<z.ZodObject<{
             type: z.ZodEnum<{
@@ -3517,11 +3522,12 @@ declare const _default: (path: string) => {
      * ```
      */
     createSnapshot: (options?: SnapshotOptions) => Promise<SnapshotResult>;
-    buildIndex: ({ source, commit, hashContent, includeFederated }: {
+    buildIndex: ({ source, commit, hashContent, includeFederated, includeSchemaContent, }: {
         source: string;
         commit: string;
         hashContent?: boolean;
         includeFederated?: boolean;
+        includeSchemaContent?: boolean;
     }) => Promise<Index>;
     diffSnapshots: (snapshotAPath: string, snapshotBPath: string) => Promise<SnapshotDiff>;
     listSnapshots: () => Promise<SnapshotMeta[]>;

package/dist/index.d.ts

@@ -439,10 +439,12 @@ interface UbiquitousLanguage {
   summary?: string;
   description?: string;
   icon?: string;
+  editUrl?: string;
 }
 
 interface UbiquitousLanguageDictionary {
   dictionary: UbiquitousLanguage[];
+  editUrl?: string;
 }
 
 interface DetailPanelProperty {
@@ -663,6 +665,8 @@ interface ToDSLOptions {
 type IndexResourceType = 'adr' | 'agent' | 'channel' | 'command' | 'container' | 'data-product' | 'diagram' | 'domain' | 'entity' | 'event' | 'flow' | 'query' | 'service' | 'system' | 'team' | 'user';
 type IndexSchema = Omit<SchemaPointer, 'file'> & {
     hash?: string;
+    /** Raw schema file text. Only present when the index was built with `includeSchemaContent`. */
+    content?: string;
 };
 type IndexSpecification = Specification & {
     hash?: string;
@@ -1418,6 +1422,7 @@ declare const FederationIndexSchema: z.ZodObject<{
             environments: z.ZodOptional<z.ZodArray<z.ZodString>>;
             default: z.ZodOptional<z.ZodBoolean>;
             hash: z.ZodOptional<z.ZodString>;
+            content: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>>;
         specifications: z.ZodOptional<z.ZodArray<z.ZodObject<{
             type: z.ZodEnum<{
@@ -3517,11 +3522,12 @@ declare const _default: (path: string) => {
      * ```
      */
     createSnapshot: (options?: SnapshotOptions) => Promise<SnapshotResult>;
-    buildIndex: ({ source, commit, hashContent, includeFederated }: {
+    buildIndex: ({ source, commit, hashContent, includeFederated, includeSchemaContent, }: {
         source: string;
         commit: string;
         hashContent?: boolean;
         includeFederated?: boolean;
+        includeSchemaContent?: boolean;
     }) => Promise<Index>;
     diffSnapshots: (snapshotAPath: string, snapshotBPath: string) => Promise<SnapshotDiff>;
     listSnapshots: () => Promise<SnapshotMeta[]>;

package/dist/index.js

@@ -3911,18 +3911,19 @@ var normalizeAssets = async (directory, hashContent, ignoreRules) => {
   );
   return assets.length === 0 ? void 0 : assets;
 };
-var normalizeSchemas = async (resource, resourcePath, hashContent) => {
+var normalizeSchemas = async (resource, resourcePath, hashContent, includeSchemaContent) => {
   const schemas = resource.schemas ?? (resource.schemaPath ? [{ path: resource.schemaPath, default: true }] : void 0);
   if (schemas === void 0) return void 0;
   return Promise.all(
     schemas.map(async ({ file, ...schema }) => {
       const schemaPath = file ?? schema.path;
+      const readSchema = schemaPath && (hashContent || includeSchemaContent);
+      const bytes = readSchema ? await import_promises18.default.readFile(import_node_path26.default.join(import_node_path26.default.dirname(resourcePath), schemaPath)) : void 0;
       return {
         ...schema,
         ...schemaPath === void 0 ? {} : { path: schemaPath },
-        ...hashContent && schemaPath ? {
-          hash: `sha256:${(0, import_node_crypto2.createHash)("sha256").update(await import_promises18.default.readFile(import_node_path26.default.join(import_node_path26.default.dirname(resourcePath), schemaPath))).digest("hex")}`
-        } : {}
+        ...bytes && hashContent ? { hash: `sha256:${(0, import_node_crypto2.createHash)("sha256").update(bytes).digest("hex")}` } : {},
+        ...bytes && includeSchemaContent ? { content: bytes.toString("utf8") } : {}
       };
     })
   );
@@ -3969,9 +3970,9 @@ var normalizeSidecars = async (directory, resourcePath, resourceDirectories, rep
   );
   return sidecars.length === 0 ? void 0 : sidecars;
 };
-var toIndexResource = async (directory, type, resource, hashContent, sourcePath, resourceDirectories, ignoreRules) => {
+var toIndexResource = async (directory, type, resource, hashContent, includeSchemaContent, sourcePath, resourceDirectories, ignoreRules) => {
   const { id, version, name } = resource;
-  const schemas = await normalizeSchemas(resource, sourcePath, hashContent);
+  const schemas = await normalizeSchemas(resource, sourcePath, hashContent, includeSchemaContent);
   const specifications = await normalizeSpecifications(resource, sourcePath, hashContent);
   const representedPaths = new Set(
     [
@@ -4038,7 +4039,13 @@ var toIndexResource = async (directory, type, resource, hashContent, sourcePath,
     ...resource.members === void 0 ? {} : { members: resource.members }
   };
 };
-var buildIndex = (directory) => async ({ source, commit, hashContent = true, includeFederated = true }) => {
+var buildIndex = (directory) => async ({
+  source,
+  commit,
+  hashContent = true,
+  includeFederated = true,
+  includeSchemaContent = false
+}) => {
   const ignoreRules = await loadIgnoreRules(directory);
   const [
     domains,
@@ -4119,7 +4126,16 @@ var buildIndex = (directory) => async ({ source, commit, hashContent = true, inc
   );
   const resources = await Promise.all(
     locatedResources.map(
-      ({ type, resource, sourcePath }) => toIndexResource(directory, type, resource, hashContent, sourcePath, resourceDirectories, ignoreRules)
+      ({ type, resource, sourcePath }) => toIndexResource(
+        directory,
+        type,
+        resource,
+        hashContent,
+        includeSchemaContent,
+        sourcePath,
+        resourceDirectories,
+        ignoreRules
+      )
     )
   );
   const assets = await normalizeAssets(directory, hashContent, ignoreRules);
@@ -4638,7 +4654,8 @@ var IndexSchemaPointerSchema = import_zod.z.object({
   format: import_zod.z.string().optional(),
   environments: import_zod.z.array(import_zod.z.string()).optional(),
   default: import_zod.z.boolean().optional(),
-  hash: contentHash.optional()
+  hash: contentHash.optional(),
+  content: import_zod.z.string().optional()
 }).strict();
 var IndexSpecificationSchema = import_zod.z.object({
   type: import_zod.z.enum(["openapi", "asyncapi", "graphql"]),