@api-client/core 0.12.2 → 0.12.4

package/src/runtime/store/DataCatalogSdk.ts

@@ -0,0 +1,473 @@
+import {
+  SdkBase,
+  E_RESPONSE_STATUS,
+  E_RESPONSE_NO_VALUE,
+  E_INVALID_JSON,
+  E_RESPONSE_UNKNOWN,
+  SdkOptions,
+} from './SdkBase.js'
+import { ContextListResult, ContextListOptions, ContextChangeRecord } from '../../events/BaseEvents.js'
+import type {
+  DataCatalogSchema,
+  DataCatalogSchemaWithVersion,
+  DataCatalogScope,
+  DataCatalogStatus,
+} from '../../models/DataCatalog.js'
+import { RouteBuilder } from './RouteBuilder.js'
+import { SdkError } from './Errors.js'
+import { DataCatalogKind, DataCatalogVersionKind } from '../../models/kinds.js'
+import type { DataCatalogVersionSchema } from '../../models/DataCatalogVersion.js'
+import type { ForeignDomainDependency } from '../../modeling/types.js'
+import type { DataDomainSchema } from '../../modeling/DataDomain.js'
+
+export interface DataCatalogListOptions extends ContextListOptions {
+  scope?: DataCatalogScope
+}
+
+export class DataCatalogSdk extends SdkBase {
+  async list(
+    options: DataCatalogListOptions = {},
+    request: SdkOptions = {}
+  ): Promise<ContextListResult<DataCatalogSchemaWithVersion>> {
+    const { token } = request
+    const opts = { ...options }
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalog())
+    this.sdk.appendListOptions(url, opts)
+    if (opts.scope) {
+      url.searchParams.set('scope', opts.scope)
+    }
+    const result = await this.sdk.http.get(url.toString(), { token })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to list data domains. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+
+    let data: ContextListResult<DataCatalogSchemaWithVersion>
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (!Array.isArray(data.items)) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  async listVersions(
+    key: string,
+    request: SdkOptions = {}
+  ): Promise<ContextListResult<{ key: string; version: string; published: number }>> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogEntryVersions(key))
+    const result = await this.sdk.http.get(url.toString(), { token })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to list data domain versions. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: ContextListResult<{ key: string; version: string; published: number }>
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (!Array.isArray(data.items)) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  /**
+   * Publishes a new data catalog entry.
+   * To publish a version, use the `publishVersion` method.
+   * @param entry The data catalog entry to publish.
+   * @returns The created data catalog entry.
+   */
+  async publish(entry: DataCatalogSchema, request: SdkOptions = {}): Promise<ContextChangeRecord<DataCatalogSchema>> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalog())
+    const body = JSON.stringify(entry)
+    const result = await this.sdk.http.post(url.toString(), {
+      token,
+      body,
+      headers: {
+        'content-type': 'application/json',
+      },
+    })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to publish data domain. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: ContextChangeRecord<DataCatalogSchema>
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (!data.key) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  async read(key: string, request: SdkOptions = {}): Promise<DataCatalogSchema> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogEntry(key))
+    const result = await this.sdk.http.get(url.toString(), { token })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to read data domain. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: DataCatalogSchema
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (data.kind !== DataCatalogKind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  /**
+   * Deprecates the entire data catalog entry.
+   * To deprecate a version, use the `deprecateVersion` method.
+   * @param key The key of the data catalog entry to deprecate.
+   * @param reason The reason for deprecation.
+   */
+  async deprecate(
+    key: string,
+    reason: string,
+    request: SdkOptions = {}
+  ): Promise<ContextChangeRecord<DataCatalogSchema>> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogDeprecate(key))
+    const body = JSON.stringify({ reason })
+    const result = await this.sdk.http.put(url.toString(), {
+      token,
+      body,
+      headers: {
+        'content-type': 'application/json',
+      },
+    })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to deprecate data domain. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: ContextChangeRecord<DataCatalogSchema>
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (data.kind !== DataCatalogKind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  /**
+   * Removes the data catalog entry from the catalog. The entry is preserved in the database
+   * and the user can still access it. It is used to recover from error when the entry was published
+   * by mistake.
+   * @param key The key of the data catalog entry to unpublish.
+   */
+  async unpublish(key: string, request: SdkOptions = {}): Promise<ContextChangeRecord<DataCatalogSchema>> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogUnpublish(key))
+    const result = await this.sdk.http.put(url.toString(), { token })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to unpublish data domain. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: ContextChangeRecord<DataCatalogSchema>
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (data.kind !== DataCatalogKind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  async publishVersion(
+    key: string,
+    version: DataCatalogVersionSchema,
+    request: SdkOptions = {}
+  ): Promise<ContextChangeRecord<DataCatalogVersionSchema>> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogEntryVersions(key))
+    const body = JSON.stringify(version)
+    const result = await this.sdk.http.post(url.toString(), {
+      token,
+      body,
+      headers: {
+        'content-type': 'application/json',
+      },
+    })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to publish data domain version. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: ContextChangeRecord<DataCatalogVersionSchema>
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (data.kind !== DataCatalogVersionKind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  async readVersion(key: string, version: string, request: SdkOptions = {}): Promise<DataCatalogVersionSchema> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogVersion(key, version))
+    const result = await this.sdk.http.get(url.toString(), { token })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to read data domain version. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: DataCatalogVersionSchema
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (data.kind !== DataCatalogVersionKind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  async listDependencies(
+    dependencies?: ForeignDomainDependency[],
+    request: SdkOptions = {}
+  ): Promise<ContextListResult<DataDomainSchema[]>> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogDependencies())
+    const body = JSON.stringify({ items: dependencies })
+    const result = await this.sdk.http.post(url.toString(), {
+      token,
+      body,
+      headers: {
+        'content-type': 'application/json',
+      },
+    })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to list data domain dependencies. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: ContextListResult<DataDomainSchema[]>
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (!Array.isArray(data.items)) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  async deprecateVersion(
+    key: string,
+    version: string,
+    reason: string,
+    request: SdkOptions = {}
+  ): Promise<ContextChangeRecord<DataCatalogVersionSchema>> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogVersion(key, version))
+    const body = JSON.stringify({ reason })
+    const result = await this.sdk.http.put(url.toString(), {
+      token,
+      body,
+      headers: {
+        'content-type': 'application/json',
+      },
+    })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to deprecate data domain version. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: ContextChangeRecord<DataCatalogVersionSchema>
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (data.kind !== DataCatalogVersionKind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  async unpublishVersion(
+    key: string,
+    version: string,
+    request: SdkOptions = {}
+  ): Promise<ContextChangeRecord<DataCatalogVersionSchema>> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogVersion(key, version))
+    const result = await this.sdk.http.put(url.toString(), { token })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to unpublish data domain version. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: ContextChangeRecord<DataCatalogVersionSchema>
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (data.kind !== DataCatalogVersionKind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+
+  async checkPublicationStatus(domainId: string, request: SdkOptions = {}): Promise<DataCatalogStatus> {
+    const { token } = request
+    const url = this.sdk.getUrl(RouteBuilder.dataCatalogStatus(domainId))
+    const result = await this.sdk.http.get(url.toString(), { token })
+    this.inspectCommonStatusCodes(result)
+    const E_PREFIX = 'Unable to check data domain publication status. '
+    if (result.status !== 200) {
+      this.logInvalidResponse(result)
+      let e = this.createGenericSdkError(result.body)
+      if (!e) {
+        e = new SdkError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.status)
+        e.response = result.body
+      }
+      throw e
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`)
+    }
+    let data: DataCatalogStatus
+    try {
+      data = JSON.parse(result.body)
+    } catch {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`)
+    }
+    if (data.kind !== DataCatalogKind) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`)
+    }
+    return data
+  }
+}

package/src/runtime/store/RouteBuilder.ts

@@ -198,4 +198,44 @@ export class RouteBuilder {
   static user(oid: string, key: string): string {
     return `/v1/orgs/${oid}/users/${key}`
   }
+
+  static dataCatalog(): string {
+    return '/v1/datacatalog'
+  }
+
+  static dataCatalogStatus(domainId: string): string {
+    return `${RouteBuilder.dataCatalog()}/status/${domainId}`
+  }
+
+  static dataCatalogEntry(domainId: string): string {
+    return `${RouteBuilder.dataCatalog()}/${domainId}`
+  }
+
+  static dataCatalogEntryVersions(entryId: string): string {
+    return `${RouteBuilder.dataCatalogEntry(entryId)}/versions`
+  }
+
+  static dataCatalogDependencies(): string {
+    return `${RouteBuilder.dataCatalog()}/dependencies`
+  }
+
+  static dataCatalogVersion(entryId: string, version: string): string {
+    return `${RouteBuilder.dataCatalogEntry(entryId)}/${version}`
+  }
+
+  static dataCatalogDeprecate(entryId: string): string {
+    return `${RouteBuilder.dataCatalogEntry(entryId)}/deprecate`
+  }
+
+  static dataCatalogUnpublish(entryId: string): string {
+    return `${RouteBuilder.dataCatalogEntry(entryId)}/unpublish`
+  }
+
+  static dataCatalogVersionDeprecate(entryId: string, version: string): string {
+    return `${RouteBuilder.dataCatalogVersion(entryId, version)}/deprecate`
+  }
+
+  static dataCatalogVersionUnpublish(entryId: string, version: string): string {
+    return `${RouteBuilder.dataCatalogVersion(entryId, version)}/unpublish`
+  }
 }

package/src/runtime/store/Sdk.ts

@@ -10,6 +10,7 @@ import { RevisionsSdk } from './RevisionsSdk.js'
 import { TrashSdk } from './TrashSdk.js'
 import { ProjectExecutionSdk } from './ProjectExecutionsSdk.js'
 import { OrganizationsSdk } from './OrganizationsSdk.js'
+import { DataCatalogSdk } from './DataCatalogSdk.js'
 
 const baseUriSymbol = Symbol('baseUri')
 
@@ -67,6 +68,8 @@ export abstract class Sdk {
   projectExecution = new ProjectExecutionSdk(this)
 
   organization = new OrganizationsSdk(this)
+
+  dataCatalog = new DataCatalogSdk(this)
   /**
    * When set it limits log output to minimum.
    */
@@ -164,8 +167,14 @@ export abstract class Sdk {
     if (options.since) {
       searchParams.set('since', String(options.since))
     }
-    if (options.orderField) {
-      searchParams.set('orderField', String(options.since))
+    if (options.sort) {
+      searchParams.set('sort', String(options.sort))
+    }
+    if (options.order) {
+      searchParams.set('order', String(options.order))
+    }
+    if (options.oid) {
+      searchParams.set('oid', String(options.oid))
     }
     if (typeof options.descending === 'boolean') {
       searchParams.set('descending', String(options.descending))

package/src/runtime/store/StoreSdkNode.ts

@@ -13,6 +13,7 @@ export type {
   IOrganizationRegistrationInfo,
   IOrganizationAddUserInfo,
 } from './UsersSdk.js'
+export type { DataCatalogListOptions } from './DataCatalogSdk.js'
 
 /**
  * NodeJS API for API Client's net-store module.

package/src/runtime/store/StoreSdkWeb.ts

@@ -13,6 +13,7 @@ export type {
   IOrganizationRegistrationInfo,
   IOrganizationAddUserInfo,
 } from './UsersSdk.js'
+export type { DataCatalogListOptions } from './DataCatalogSdk.js'
 
 /**
  * NodeJS API for API Client's net-store module.

package/tests/unit/modeling/validation/association_validation.spec.ts

@@ -90,6 +90,23 @@ test.group('AssociationValidation', (group) => {
     assert.equal(results[0].severity, 'error')
   })
 
+  test('validateName() should return an error when the association name is too short', ({ assert }) => {
+    const model = domain.addModel({ key: 'model' })
+    const entity1 = model.addEntity({ key: 'entity1', info: { name: 'Entity1' } })
+    const entity2 = model.addEntity({ key: 'entity2', info: { name: 'Entity2' } })
+    const association = entity1.addAssociation(
+      { key: entity2.key },
+      {
+        key: 'a',
+        info: { name: 'a' },
+      }
+    )
+    const results = validation.validateName(association)
+    assert.lengthOf(results, 1)
+    assert.equal(results[0].rule, 'length')
+    assert.equal(results[0].severity, 'error')
+  })
+
   test('validateName() should return an error when the association name is too long', ({ assert }) => {
     const model = domain.addModel({ key: 'model' })
     const entity1 = model.addEntity({ key: 'entity1', info: { name: 'Entity1' } })

package/tests/unit/modeling/validation/entity_validation.spec.ts

@@ -90,7 +90,7 @@ test.group('EntityValidation', (group) => {
 
   test('validateName() should return an error when the entity name is too short', ({ assert }) => {
     const model = domain.addModel({ key: 'model' })
-    const entity = model.addEntity({ key: 'entity', info: { name: 'ab' } })
+    const entity = model.addEntity({ key: 'entity', info: { name: 'a' } })
     const results = validation.validateName(entity)
     assert.lengthOf(results, 1)
     assert.equal(results[0].rule, 'length')

package/tests/unit/modeling/validation/property_validation.spec.ts

@@ -64,6 +64,16 @@ test.group('PropertyValidation', (group) => {
     assert.equal(results[0].severity, 'error')
   })
 
+  test('validateName() should return an error when the property name is too short', ({ assert }) => {
+    const model = domain.addModel({ key: 'model' })
+    const entity = model.addEntity({ key: 'entity', info: { name: 'Entity' } })
+    const property = entity.addProperty({ key: 'a', type: 'string', info: { name: 'a' } })
+    const results = validation.validateName(property)
+    assert.lengthOf(results, 1)
+    assert.equal(results[0].rule, 'length')
+    assert.equal(results[0].severity, 'error')
+  })
+
   test('validateName() should return an error when the property name is too long', ({ assert }) => {
     const model = domain.addModel({ key: 'model' })
     const entity = model.addEntity({ key: 'entity', info: { name: 'Entity' } })