@api-client/core 0.18.40 → 0.18.41

package/data/models/example-generator-api.json

@@ -42065,10 +42065,10 @@
 "@id": "#191"
 },
 {
-"@id": "#194"
+"@id": "#197"
 },
 {
-"@id": "#197"
+"@id": "#194"
 },
 {
 "@id": "#200"
@@ -43457,7 +43457,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
+"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43478,7 +43478,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
+"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44761,12 +44761,12 @@
 {
 "@id": "#196/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#196",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",

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.18.40",
+  "version": "0.18.41",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -122,7 +122,7 @@
     "@types/jsdom": "^27.0.0",
     "@types/json-schema": "^7.0.15",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^24.0.1",
+    "@types/node": "^25.0.6",
     "@types/sinon": "^21.0.0",
     "@web/dev-server": "^0.4.6",
     "@web/dev-server-rollup": "^0.6.4",
@@ -132,7 +132,7 @@
     "c8": "^10.1.3",
     "chai-as-promised": "^8.0.2",
     "conventional-changelog": "^7.1.0",
-    "conventional-changelog-conventionalcommits": "^8.0.0",
+    "conventional-changelog-conventionalcommits": "^9.1.0",
     "cors": "^2.8.5",
     "eslint": "^9.20.1",
     "eslint-config-prettier": "^10.0.1",
@@ -141,7 +141,7 @@
     "express": "^5.1.0",
     "express-ntlm": "^2.6.1",
     "get-port": "^7.0.0",
-    "globals": "^16.0.0",
+    "globals": "^17.0.0",
     "husky": "^9.0.11",
     "lint-staged": "^16.0.0",
     "oauth2-mock-server": "^8.0.0",

package/src/mocking/ModelingMock.ts

@@ -6,6 +6,7 @@ import { File } from './lib/File.js'
 import { Invitation } from './lib/Invitation.js'
 import { Trash } from './lib/Trash.js'
 import { Patch } from './lib/Patch.js'
+import { DataCatalog } from './lib/DataCatalog.js'
 
 export class ModelingMock {
   faker: Faker = faker
@@ -16,4 +17,5 @@ export class ModelingMock {
   invitation = new Invitation()
   trash = new Trash()
   patch = new Patch()
+  dataCatalog = new DataCatalog()
 }

package/src/mocking/lib/DataCatalog.ts

@@ -0,0 +1,166 @@
+import { faker } from '@faker-js/faker'
+import { DataCatalogKind, DataCatalogVersionKind } from '../../models/kinds.js'
+import { nanoid } from '../../nanoid.js'
+import type {
+  DataCatalogSchemaWithVersion,
+  DataCatalogSchema,
+  DataCatalogScope,
+  DataCatalogVersionInfo,
+} from '../../models/DataCatalog.js'
+import type { DataCatalogLifecycle, DataCatalogVersionSchema } from '../../models/DataCatalogVersion.js'
+
+const dataCatalogScopes: DataCatalogScope[] = ['public', 'private', 'organization'] as const
+const dataCatalogLifecycles: DataCatalogLifecycle[] = ['stable', 'beta', 'dev'] as const
+
+export class DataCatalog {
+  /**
+   * Generates a random data catalog object.
+   * @param init Optional values to be present in the object.
+   * @returns Random data catalog object.
+   */
+  dataCatalog(init: Partial<DataCatalogSchema> = {}): DataCatalogSchema {
+    const {
+      key = nanoid(),
+      organization = nanoid(),
+      file = nanoid(),
+      scope = faker.helpers.arrayElement(dataCatalogScopes),
+      name = faker.company.name(),
+      description = faker.lorem.sentence(),
+      publishedBy = nanoid(),
+      publishedAt = faker.date.past().getTime(),
+      createdAt = faker.date.past().getTime(),
+      updatedAt = faker.date.recent().getTime(),
+      tags = faker.helpers.uniqueArray(faker.lorem.word, 3),
+    } = init
+    return {
+      kind: DataCatalogKind,
+      key,
+      name,
+      organization,
+      file,
+      createdAt,
+      updatedAt,
+      scope,
+      description,
+      publishedBy,
+      publishedAt,
+      tags,
+    }
+  }
+
+  /**
+   * Generates a list of random data catalog objects.
+   * @param size Number of data catalogs to generate. Default is 25.
+   * @returns List of random data catalogs
+   */
+  dataCatalogs(size = 25): DataCatalogSchema[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.dataCatalog())
+    }
+    return result
+  }
+
+  /**
+   * Generates a random data catalog version object.
+   * @param init Optional values to be present in the object.
+   * @returns Random data catalog version object.
+   */
+  dataCatalogVersion(init: Partial<DataCatalogVersionSchema> = {}): DataCatalogVersionSchema {
+    const {
+      key = nanoid(),
+      catalogKey = nanoid(),
+      scope = faker.helpers.arrayElement(dataCatalogScopes),
+      lifecycle = faker.helpers.arrayElement(dataCatalogLifecycles),
+      version = 'v' + faker.system.semver(),
+      publishedBy = nanoid(),
+      createdAt = faker.date.past().getTime(),
+      updatedAt = faker.date.recent().getTime(),
+      changelog = faker.lorem.paragraph(),
+    } = init
+    return {
+      kind: DataCatalogVersionKind,
+      key,
+      catalogKey,
+      scope,
+      lifecycle,
+      version,
+      publishedBy,
+      createdAt,
+      updatedAt,
+      changelog,
+    }
+  }
+
+  /**
+   * Generates a list of random data catalog version objects.
+   * @param size Number of data catalog versions to generate. Default is 25.
+   * @returns List of random data catalog versions.
+   */
+  dataCatalogVersions(size = 25): DataCatalogVersionSchema[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.dataCatalogVersion())
+    }
+    return result
+  }
+
+  /**
+   * Generates a random data catalog object with versions.
+   * @param init Optional values to be present in the object.
+   * @returns Random data catalog object with versions.
+   */
+  dataCatalogWithVersion(init: Partial<DataCatalogSchemaWithVersion> = {}): DataCatalogSchemaWithVersion {
+    const result = this.dataCatalog(init) as DataCatalogSchemaWithVersion
+    const versionsSize = faker.number.int({ min: 1, max: 20 })
+    const versions = []
+    for (let i = 0; i < versionsSize; i++) {
+      versions.push({
+        version: `v${i + 1}.0.0`,
+        lifecycle: faker.helpers.arrayElement(dataCatalogLifecycles),
+      })
+    }
+    result.versions = versions
+    return result
+  }
+
+  /**
+   * Generates a list of random data catalog objects with versions.
+   * @param size Number of data catalogs to generate. Default is 3.
+   * @returns List of random data catalogs with versions.
+   */
+  dataCatalogsWithVersion(size = 3): DataCatalogSchemaWithVersion[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.dataCatalogWithVersion())
+    }
+    return result
+  }
+
+  /**
+   * Generates a random data catalog version info object.
+   * @param init Optional values to be present in the object.
+   * @returns Random data catalog version info object.
+   */
+  versionInfo(init: Partial<DataCatalogVersionInfo> = {}): DataCatalogVersionInfo {
+    const { key = nanoid(), version = 'v' + faker.system.semver(), published = faker.date.past().getTime() } = init
+    return {
+      key,
+      version,
+      published,
+    }
+  }
+
+  /**
+   * Generates a list of random data catalog version info objects.
+   * @param size Number of data catalog version info objects to generate. Default is 5.
+   * @returns List of random data catalog version info objects.
+   */
+  versionInfos(size = 5): DataCatalogVersionInfo[] {
+    const result = []
+    for (let i = 0; i < size; i++) {
+      result.push(this.versionInfo())
+    }
+    return result
+  }
+}

package/src/models/DataCatalog.ts

@@ -125,9 +125,23 @@ export interface DataCatalogSchemaWithVersion extends DataCatalogSchema {
   versions: DataCatalogSchemaVersion[]
 }
 
+/**
+ * Simplified information about a data catalog version.
+ * It is used when listing versions of a data catalog entry.
+ */
 export interface DataCatalogVersionInfo {
+  /**
+   * The key of the version.
+   */
   key: string
+  /**
+   * The version string according to the [semantic versioning](https://semver.org/) specification.
+   * Note, this value is limited to 32 characters by the API.
+   */
   version: string
+  /**
+   * The timestamp when this version was published.
+   */
   published: number
 }
 

package/src/sdk/DataCatalogSdk.ts

@@ -12,6 +12,7 @@ import type {
   DataCatalogSchemaWithVersion,
   DataCatalogScope,
   DataCatalogStatus,
+  DataCatalogVersionInfo,
 } from '../models/DataCatalog.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import { DataCatalogKind, DataCatalogVersionKind } from '../models/kinds.js'
@@ -59,10 +60,11 @@ export class DataCatalogSdk extends SdkBase {
     return data
   }
 
-  async listVersions(
-    key: string,
-    request: SdkOptions = {}
-  ): Promise<ContextListResult<{ key: string; version: string; published: number }>> {
+  /**
+   * Lists a simple schema of versions for a given data catalog entry.
+   * @param key The key of the Data Catalog entry to list versions for.
+   */
+  async listVersions(key: string, request: SdkOptions = {}): Promise<ContextListResult<DataCatalogVersionInfo>> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.dataCatalogEntryVersions(key))
     const result = await this.sdk.http.get(url.toString(), { token })
@@ -75,7 +77,7 @@ export class DataCatalogSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: ContextListResult<{ key: string; version: string; published: number }>
+    let data: ContextListResult<DataCatalogVersionInfo>
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -327,7 +329,7 @@ export class DataCatalogSdk extends SdkBase {
     request: SdkOptions = {}
   ): Promise<ContextChangeRecord<DataCatalogVersionSchema>> {
     const { token } = request
-    const url = this.sdk.getUrl(RouteBuilder.dataCatalogVersion(key, version))
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogVersionDeprecate(key, version))
     const body = JSON.stringify({ reason })
     const result = await this.sdk.http.put(url.toString(), {
       token,
@@ -363,7 +365,7 @@ export class DataCatalogSdk extends SdkBase {
     request: SdkOptions = {}
   ): Promise<ContextChangeRecord<DataCatalogVersionSchema>> {
     const { token } = request
-    const url = this.sdk.getUrl(RouteBuilder.dataCatalogVersion(key, version))
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogVersionUnpublish(key, version))
     const result = await this.sdk.http.put(url.toString(), { token })
     this.inspectCommonStatusCodes(result)
     const E_PREFIX = 'Unable to unpublish data domain version. '