@api-client/core 0.20.7 → 0.20.8

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.20.7",
+  "version": "0.20.8",
   "license": "UNLICENSED",
   "exports": {
     "./browser.js": {

package/src/modeling/ApiModel.ts

@@ -16,6 +16,7 @@ import { DependentModel, type DependentModelSchema, type DomainDependency } from
 import { observed, toRaw } from '../decorators/observed.js'
 import pluralize from '@jarrodek/pluralize'
 import { createDomainKey } from './helpers/keying.js'
+import { paramNameFor } from './helpers/endpointHelpers.js'
 import { ExposedEntity } from './ExposedEntity.js'
 import { AccessRule, AccessRuleSchema } from './rules/AccessRule.js'
 import { RateLimitingConfiguration, RateLimitingConfigurationSchema } from './rules/RateLimitingConfiguration.js'
@@ -462,15 +463,16 @@ export class ApiModel extends DependentModel {
     }
     const name = domainEntity.info.name || ''
     const segment = pluralize(name.toLocaleLowerCase())
+    const paramName = paramNameFor(name)
     let relativeCollectionPath = `/${segment}`
-    let relativeResourcePath = `/${segment}/{id}`
+    let relativeResourcePath = `/${segment}/{${paramName}}`
 
     // Check for root path collision and resolve by appending a number
     let counter = 1
     const originalCollectionPath = relativeCollectionPath
     while (this.findCollectionPathCollision(relativeCollectionPath)) {
       relativeCollectionPath = `${originalCollectionPath}-${counter}`
-      relativeResourcePath = `${relativeCollectionPath}/{id}`
+      relativeResourcePath = `${relativeCollectionPath}/{${paramName}}`
       counter++
     }
 
@@ -552,14 +554,15 @@ export class ApiModel extends DependentModel {
               if (targetDomEntity) {
                 const name = targetDomEntity.info.name || ''
                 const segment = pluralize(name.toLocaleLowerCase())
+                const paramName = paramNameFor(name)
                 let relativeCollectionPath = `/${segment}`
-                let relativeResourcePath = `/${segment}/{id}`
+                let relativeResourcePath = `/${segment}/{${paramName}}`
 
                 let counter = 1
                 const originalCollectionPath = relativeCollectionPath
                 while (this.findResourcePathCollision(relativeCollectionPath)) {
                   relativeCollectionPath = `${originalCollectionPath}-${counter}`
-                  relativeResourcePath = `${relativeCollectionPath}/{id}`
+                  relativeResourcePath = `${relativeCollectionPath}/{${paramName}}`
                   counter++
                 }
 
@@ -582,8 +585,9 @@ export class ApiModel extends DependentModel {
           const name = association.info.name || ''
           const segment = pluralize(name.toLocaleLowerCase())
           const isCollection = association.multiple !== false
+          const paramName = paramNameFor(targetDomainEntity.info.name || '')
           const relativeCollectionPath = isCollection ? `/${segment}` : undefined
-          const relativeResourcePath = isCollection ? `/${segment}/{id}` : `/${segment}`
+          const relativeResourcePath = isCollection ? `/${segment}/{${paramName}}` : `/${segment}`
           // Create nested exposure
           const nestedExposure: ExposedEntitySchema = {
             kind: ExposedEntityKind,

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

@@ -87,6 +87,7 @@ test.group('ApiModel.exposeEntity()', () => {
     assert.isDefined(nestedB)
     assert.deepEqual(nestedB?.parent?.key, exposedA.key)
     assert.strictEqual(nestedB?.collectionPath, '/entitybs')
+    assert.strictEqual(nestedB?.resourcePath, '/entitybs/{bId}')
   })
 
   test('does not infinitely expose circular associations', ({ assert }) => {
@@ -216,7 +217,7 @@ test.group('ApiModel.exposeEntity()', () => {
     // Expose second entity -> should resolve collision to /items-1
     const exp2 = model.exposeEntity({ key: e2.key })
     assert.equal(exp2.collectionPath, '/items-1')
-    assert.equal(exp2.resourcePath, '/items-1/{id}')
+    assert.equal(exp2.resourcePath, '/items-1/{itemId}')
 
     // Expose third entity -> /items-2
     const e3 = dm.addEntity({ info: { name: 'Item' } })

package/tests/unit/modeling/generators/OasGenerator.spec.ts

@@ -10,7 +10,7 @@ test.group('OasGenerator', (group) => {
   let api: ApiModel
 
   group.each.setup(() => {
-    domain = new DataDomain({ info: { name: 'Test Domain', version: '1.0.0' } })
+    domain = new DataDomain({ info: { name: 'Test Domain', version: '1.0.0' } }, undefined, { readOnly: true })
     const model = domain.addModel({ info: { name: 'model1' } })
     const user = model.addEntity({ info: { name: 'user' } })
     user.addSemantic({ id: SemanticType.User })
@@ -232,17 +232,17 @@ test.group('OasGenerator', (group) => {
     // User endpoints (CRUD)
     assert.isObject(paths['/users'].get, 'User list')
     assert.isObject(paths['/users'].post, 'User create')
-    assert.isObject(paths['/users/{id}'].get, 'User read')
-    assert.isObject(paths['/users/{id}'].put, 'User put')
-    assert.isObject(paths['/users/{id}'].delete, 'User delete')
+    assert.isObject(paths['/users/{userId}'].get, 'User read')
+    assert.isObject(paths['/users/{userId}'].put, 'User put')
+    assert.isObject(paths['/users/{userId}'].delete, 'User delete')
 
     // Post endpoints (list, update, delete)
     assert.isObject(paths['/posts'].get)
     assert.isUndefined(paths['/posts'].post) // no create Action
-    assert.isUndefined(paths['/posts/{id}'].get) // no read action
-    assert.isObject(paths['/posts/{id}'].patch)
-    assert.isObject(paths['/posts/{id}'].put)
-    assert.isObject(paths['/posts/{id}'].delete)
+    assert.isUndefined(paths['/posts/{postId}'].get) // no read action
+    assert.isObject(paths['/posts/{postId}'].patch)
+    assert.isObject(paths['/posts/{postId}'].put)
+    assert.isObject(paths['/posts/{postId}'].delete)
   })
 
   test('generates standard error responses', ({ assert }) => {