chore: add support for entity files node types and validation (#2377)

* chore: add support for entity files node types and validation

* chore: remove catalogEntity1 format

* chore: update redocly/config

* tests: update lint tests

* chore: remove unnecessary files

* tests: update entity-yaml test imports

* tests: revert snapshot

* tests: update entity-yaml test file

* chore: update entity-key-valid test

* chore: apply review suggestions

* chore: apply review suggestions

* chore: add fixme for entity lint methods

* chore: apply review suggestions

* chore: apply review suggestions

* tests: add outdent to entity-key-valid test file

* chore: use document instead of whole config in lintEntityFile method

* tests: remove unnecessary var

* chore: add catalogEntity visitor types

* chore: remove unnecessary imports/exports

Author: kamil1094

.changeset/floppy-rules-like.md

@@ -0,0 +1,5 @@
+---
+"@redocly/openapi-core": patch
+---
+
+Updated @redocly/config to v0.36.2.

package-lock.json

@@ -53,7 +53,7 @@
   ],
   "dependencies": {
     "@redocly/ajv": "^8.11.2",
-    "@redocly/config": "^0.31.0",
+    "@redocly/config": "^0.36.2",
     "ajv-formats": "^2.1.1",
     "colorette": "^1.2.0",
     "js-levenshtein": "^1.1.6",

packages/core/package.json

@@ -0,0 +1,71 @@
+import { describe, it, expect } from 'vitest';
+import { createEntityTypes } from '../types/entity-yaml.js';
+import { NormalizedNodeType, normalizeTypes, ResolveTypeFn } from '../types/index.js';
+import { entityFileSchema, entityFileDefaultSchema } from '@redocly/config';
+describe('entity-yaml', () => {
+  it('should create entity types with discriminator', () => {
+    const entityTypes = createEntityTypes(entityFileSchema, entityFileDefaultSchema);
+
+    expect(entityTypes).toHaveProperty('user');
+    expect(entityTypes).toHaveProperty('api-operation');
+    expect(entityTypes).toHaveProperty('data-schema');
+    expect(entityTypes).toHaveProperty('api-description');
+    expect(entityTypes).toHaveProperty('service');
+    expect(entityTypes).toHaveProperty('domain');
+    expect(entityTypes).toHaveProperty('team');
+    expect(entityTypes).toHaveProperty('EntityFileDefault');
+    expect(entityTypes).toHaveProperty('EntityFileArray');
+  });
+
+  it('should resolve entity type to default for array items', () => {
+    const entityTypes = createEntityTypes(entityFileSchema, entityFileDefaultSchema);
+    const normalizedTypes = normalizeTypes(entityTypes);
+
+    const entityFileArrayNode = normalizedTypes['EntityFileArray'];
+
+    const unknownEntity = { key: 'unknown', title: 'Unknown' };
+    const resolvedType = (entityFileArrayNode.items as ResolveTypeFn)(
+      unknownEntity,
+      'root'
+    ) as NormalizedNodeType;
+
+    expect(resolvedType).toBeTruthy();
+    expect(resolvedType.name).toBe('EntityFileDefault');
+  });
+
+  it('should resolve entity type based on discriminator for array items', () => {
+    const entityTypes = createEntityTypes(entityFileSchema, entityFileDefaultSchema);
+    const normalizedTypes = normalizeTypes(entityTypes);
+
+    const entityFileArrayNode = normalizedTypes['EntityFileArray'];
+    const userEntity = {
+      type: 'user',
+      key: 'john-doe',
+      title: 'John Doe',
+      metadata: { email: '[email protected]' },
+    };
+    const resolvedType = (entityFileArrayNode.items as ResolveTypeFn)(
+      userEntity,
+      'root'
+    ) as NormalizedNodeType;
+
+    expect(resolvedType).toBeTruthy();
+    expect(resolvedType.name).toBe('user');
+    expect(resolvedType.properties).toHaveProperty('metadata');
+  });
+
+  it('should have correct required fields for entity types', () => {
+    const entityTypes = createEntityTypes(entityFileSchema, entityFileDefaultSchema);
+    const normalizedTypes = normalizeTypes(entityTypes);
+
+    const userNode = normalizedTypes['user'];
+    expect(userNode.required).toContain('key');
+    expect(userNode.required).toContain('title');
+    expect(userNode.required).toContain('type');
+
+    const defaultNode = normalizedTypes['EntityFileDefault'];
+    expect(defaultNode.required).toContain('type');
+    expect(defaultNode.required).toContain('key');
+    expect(defaultNode.required).toContain('title');
+  });
+});