@api-client/core 0.18.30 → 0.18.32

package/tests/unit/modeling/exposed_entity.spec.ts

@@ -0,0 +1,100 @@
+import { test } from '@japa/runner'
+import { ApiModel, ExposedEntity } from '../../../src/index.js'
+
+test.group('ExposedEntity', () => {
+  test('setRelativeCollectionPath normalizes and preserves resource param', ({ assert }) => {
+    const model = new ApiModel()
+    const ex = new ExposedEntity(model, {
+      hasCollection: true,
+      relativeCollectionPath: '/items',
+      relativeResourcePath: '/items/{customId}',
+    })
+
+    ex.setRelativeCollectionPath('products')
+
+    assert.equal(ex.relativeCollectionPath, '/products')
+    assert.equal(ex.relativeResourcePath, '/products/{customId}')
+  }).tags(['@modeling', '@exposed-entity'])
+
+  test('setRelativeResourcePath with collection allows only parameter name change', ({ assert }) => {
+    const model = new ApiModel()
+    const ex = new ExposedEntity(model, {
+      hasCollection: true,
+      relativeCollectionPath: '/products',
+      relativeResourcePath: '/products/{id}',
+    })
+
+    // valid: same collection segment, different param name
+    ex.setRelativeResourcePath('/products/{productId}')
+    assert.equal(ex.relativeResourcePath, '/products/{productId}')
+
+    // invalid: different first segment
+    assert.throws(() => ex.setRelativeResourcePath('/wrong/{id}'))
+
+    // invalid: second segment not a parameter
+    assert.throws(() => ex.setRelativeResourcePath('/products/notParam'))
+  }).tags(['@modeling', '@exposed-entity'])
+
+  test('setRelativeResourcePath without collection must have exactly two segments', ({ assert }) => {
+    const model = new ApiModel()
+    const ex = new ExposedEntity(model, {
+      hasCollection: false,
+      relativeResourcePath: '/profile/{id}',
+    })
+
+    ex.setRelativeResourcePath('settings/secret')
+    assert.equal(ex.relativeResourcePath, '/settings/secret')
+
+    assert.throws(() => ex.setRelativeResourcePath('onlyone'))
+  }).tags(['@modeling', '@exposed-entity'])
+
+  test('computes absolute resource and collection paths along parent chain', ({ assert }) => {
+    const model = new ApiModel()
+
+    // Build exposure schemas
+    const rootSchema = {
+      key: 'root',
+      entity: { key: 'user' },
+      hasCollection: true,
+      relativeCollectionPath: '/users',
+      relativeResourcePath: '/users/{userId}',
+      isRoot: true,
+      actions: [],
+    }
+    const childSchema = {
+      key: 'child',
+      entity: { key: 'post' },
+      hasCollection: true,
+      relativeCollectionPath: '/posts',
+      relativeResourcePath: '/posts/{postId}',
+      parent: { key: 'root', association: { key: 'toPosts' } },
+      actions: [],
+    }
+    const grandSchema = {
+      key: 'grand',
+      entity: { key: 'details' },
+      hasCollection: false,
+      relativeResourcePath: '/details',
+      parent: { key: 'child', association: { key: 'toDetails' } },
+      actions: [],
+    }
+    // Instantiate instances bound to the model
+    const rootEx = new ExposedEntity(model, rootSchema)
+    const childEx = new ExposedEntity(model, childSchema)
+    const grandEx = new ExposedEntity(model, grandSchema)
+    // attach to model as instances
+    model.exposes = [rootEx, childEx, grandEx]
+
+    // root
+    assert.equal(rootEx.getAbsoluteCollectionPath(), '/users')
+    assert.equal(rootEx.getAbsoluteResourcePath(), '/users/{userId}')
+
+    // child
+    assert.equal(childEx.getAbsoluteCollectionPath(), '/users/{userId}/posts')
+    assert.equal(childEx.getAbsoluteResourcePath(), '/users/{userId}/posts/{postId}')
+
+    // grand (no collection)
+    assert.isUndefined(grandEx.getAbsoluteCollectionPath())
+    assert.equal(grandEx.getAbsoluteResourcePath(), '/users/{userId}/posts/{postId}/details')
+  }).tags(['@modeling', '@exposed-entity'])
+})