Merge pull request #7 from event-catalog/added-lint-for-data-stores

feat(linter): added support for data stores

Author: boyney123

.changeset/witty-jars-fix.md

@@ -0,0 +1,5 @@
+---
+"@eventcatalog/linter": patch
+---
+
+feat(linter): added support for data stores

src/scanner/index.ts

@@ -33,6 +33,7 @@ const RESOURCE_PATTERNS: Record<ResourceType, string[]> = {
   entity: ['**/entities/*/index.{md,mdx}', '**/entities/*/versioned/*/index.{md,mdx}'],
   user: ['users/*.{md,mdx}'],
   team: ['teams/*.{md,mdx}'],
+  dataStore: ['**/containers/*/index.{md,mdx}', '**/containers/*/versioned/*/index.{md,mdx}'],
 };
 
 export const extractResourceInfo = (filePath: string, resourceType: ResourceType): { id: string; version?: string } => {

src/schemas/data-store.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+import { baseSchema } from './common';
+
+export const dataStoreSchema = z
+  .object({
+    container_type: z.enum(['database', 'cache', 'objectStore', 'searchIndex', 'dataWarehouse', 'dataLake', 'externalSaaS']),
+    technology: z.string().optional(),
+    authoritative: z.boolean().optional(),
+    access_mode: z.enum(['read', 'write', 'readWrite', 'appendOnly']),
+    classification: z.enum(['public', 'internal', 'confidential', 'regulated']),
+    residency: z.string().optional(),
+    retention: z.string().optional(),
+  })
+  .merge(baseSchema);

src/schemas/index.ts

@@ -7,6 +7,7 @@ export * from './flow';
 export * from './entity';
 export * from './user';
 export * from './team';
+export * from './data-store';
 
 import { domainSchema } from './domain';
 import { serviceSchema } from './service';
@@ -16,6 +17,7 @@ import { flowSchema } from './flow';
 import { entitySchema } from './entity';
 import { userSchema } from './user';
 import { teamSchema } from './team';
+import { dataStoreSchema } from './data-store';
 
 export const schemas = {
   domain: domainSchema,
@@ -28,6 +30,7 @@ export const schemas = {
   entity: entitySchema,
   user: userSchema,
   team: teamSchema,
+  dataStore: dataStoreSchema,
 } as const;
 
 export type ResourceType = keyof typeof schemas;

src/schemas/service.ts

@@ -6,5 +6,7 @@ export const serviceSchema = z
     sends: z.array(pointerSchema).optional(),
     receives: z.array(pointerSchema).optional(),
     entities: z.array(pointerSchema).optional(),
+    writesTo: z.array(pointerSchema).optional(),
+    readsFrom: z.array(pointerSchema).optional(),
   })
   .merge(baseSchema);

tests/schema-validator.test.ts

@@ -257,4 +257,34 @@ describe('validateSchema', () => {
       expect(errors[0].message).toContain('Invalid email');
     });
   });
+
+  describe('data store validation', () => {
+    it('should pass with valid data store frontmatter', () => {
+      const parsedFile = createParsedFile('dataStore', {
+        id: 'user-data-store',
+        name: 'User Data Store',
+        version: '1.0.0',
+        container_type: 'database',
+        technology: 'PostgreSQL',
+        authoritative: true,
+        access_mode: 'readWrite',
+        classification: 'public',
+        residency: 'US',
+        retention: '1 year',
+      });
+      const errors = validateSchema(parsedFile);
+      expect(errors).toHaveLength(0);
+    });
+
+    it('should fail with invalid container type', () => {
+      const parsedFile = createParsedFile('dataStore', {
+        id: 'user-data-store',
+        name: 'User Data Store',
+        version: '1.0.0',
+        container_type: 'invalid-container-type',
+      });
+      const errors = validateSchema(parsedFile);
+      expect(errors.length).toBeGreaterThan(0);
+    });
+  });
 });