@api-client/core 0.11.10 → 0.12.0

package/src/amf/DataValueGenerator.ts

@@ -1,8 +1,8 @@
 import uuidV4 from '../lib/uuid.js'
 import { randomString } from '../lib/math/Random.js'
-import { DataPropertyType } from '../modeling/DataFormat.js'
+import { DomainPropertyType } from '../modeling/DataFormat.js'
 
-export const novalue = Symbol('novalue')
+export const noValue = Symbol('noValue')
 
 /**
  * A class to be used for generating values from pre-defined functions.
@@ -18,15 +18,15 @@ export class DataValueGenerator {
    * A symbol representing the absence of a value.
    * Used as a return value when a function cannot generate a value of the requested type.
    */
-  static readonly novalue = novalue
+  static readonly noValue = noValue
 
   /**
    * Generates a value based on the provided function name and data type.
    * @param fn The name of the function to use for value generation (e.g., 'random', 'uuid-v4', 'incremental').
    * @param type The data type of the value to generate (e.g., 'string', 'number', 'date', 'time', 'datetime').
-   * @returns The generated value, or the `novalue` symbol if the function or type is not supported.
+   * @returns The generated value, or the `noValue` symbol if the function or type is not supported.
    */
-  generate(fn: string, type: DataPropertyType): string | typeof novalue {
+  generate(fn: string, type: DomainPropertyType): string | typeof noValue {
     if (type === 'string') {
       return this.generateString(fn)
     }
@@ -42,36 +42,36 @@ export class DataValueGenerator {
     if (type === 'datetime') {
       return this.generateDateTime(fn)
     }
-    return novalue
+    return noValue
   }
 
   /**
    * Generates a string value based on the function name.
    * @param fn The name of the string generation function.
-   * @returns The generated string value, or `novalue` if the function is not supported.
+   * @returns The generated string value, or `noValue` if the function is not supported.
    */
-  protected generateString(fn: string): string | typeof novalue {
+  protected generateString(fn: string): string | typeof noValue {
     switch (fn) {
       case 'random':
         return randomString(8)
       case 'uuid-v4':
         return uuidV4()
       default:
-        return novalue
+        return noValue
     }
   }
 
   /**
    * Generates a number value based on the function name.
    * @param fn The name of the number generation function.
-   * @returns The generated number value (as a string), or `novalue` if the function is not supported.
+   * @returns The generated number value (as a string), or `noValue` if the function is not supported.
    */
-  protected generateNumber(fn: string): string | typeof novalue {
+  protected generateNumber(fn: string): string | typeof noValue {
     switch (fn) {
       case 'incremental':
         return `${this.increment++}`
       default:
-        return novalue
+        return noValue
     }
   }
 
@@ -79,9 +79,9 @@ export class DataValueGenerator {
    * Generates a date value based on the function name.
    * @param fn The name of the date generation function.
    * @returns The generated date value (as a string in YYYY-MM-DD format),
-   * or `novalue` if the function is not supported.
+   * or `noValue` if the function is not supported.
    */
-  protected generateDate(fn: string): string | typeof novalue {
+  protected generateDate(fn: string): string | typeof noValue {
     if (fn === 'now') {
       // Returns YYYY-MM-DD
       // @TODO: Replace with Temporal when widely available.
@@ -91,15 +91,15 @@ export class DataValueGenerator {
       const day = `${d.getDate()}`.padStart(2, '0')
       return `${year}-${month}-${day}`
     }
-    return novalue
+    return noValue
   }
 
   /**
    * Generates a time value based on the function name.
    * @param fn The name of the time generation function.
-   * @returns The generated time value (as a string in HH:mm:ss format), or `novalue` if the function is not supported.
+   * @returns The generated time value (as a string in HH:mm:ss format), or `noValue` if the function is not supported.
    */
-  protected generateTime(fn: string): string | typeof novalue {
+  protected generateTime(fn: string): string | typeof noValue {
     if (fn === 'now') {
       // Returns HH:mm:ss
       // @TODO: Replace with Temporal when widely available.
@@ -109,16 +109,16 @@ export class DataValueGenerator {
       const second = `${d.getSeconds()}`.padStart(2, '0')
       return `${hour}:${minute}:${second}`
     }
-    return novalue
+    return noValue
   }
 
   /**
    * Generates a datetime value based on the function name.
    * @param fn The name of the datetime generation function.
    * @returns The generated datetime value (as a string in YYYY-MM-DDTHH:mm:ss format),
-   * or `novalue` if the function is not supported.
+   * or `noValue` if the function is not supported.
    */
-  protected generateDateTime(fn: string): string | typeof novalue {
+  protected generateDateTime(fn: string): string | typeof noValue {
     if (fn === 'now') {
       // Returns YYYY-MM-DDTHH:mm:ss
       // @TODO: Replace with Temporal when widely available.
@@ -131,6 +131,6 @@ export class DataValueGenerator {
       const second = `${d.getSeconds()}`.padStart(2, '0')
       return `${year}-${month}-${day}T${hour}:${minute}:${second}`
     }
-    return novalue
+    return noValue
   }
 }

package/src/exceptions/attach_exception.ts

@@ -0,0 +1,11 @@
+import { Exception } from './exception.js'
+
+/**
+ * A generic exception for attaching objects.
+ */
+export class AttachException extends Exception {
+  static override code = 'E_ATTACH'
+  static override status = 500
+  static override message = 'Error attaching the object.'
+  static override help = 'Make sure you are attaching the right object.'
+}

package/src/exceptions/detach_exception.ts

@@ -0,0 +1,11 @@
+import { Exception } from './exception.js'
+
+/**
+ * A generic exception for detaching objects.
+ */
+export class DetachException extends Exception {
+  static override code = 'E_DETACH'
+  static override status = 500
+  static override message = 'Error detaching the object.'
+  static override help = 'Make sure you are detaching the right object.'
+}

package/src/exceptions/remove_model_exception.ts

@@ -0,0 +1,8 @@
+import { Exception } from './exception.js'
+
+export class RemoveModelException extends Exception {
+  static override code = 'E_REMOVE_MODEL'
+  static override status = 500
+  static override message = 'Error removing a domain model.'
+  static override help = 'Make sure the model exists and can be removed.'
+}

package/src/exceptions/remove_namespace_exception.ts

@@ -0,0 +1,8 @@
+import { Exception } from './exception.js'
+
+export class RemoveNamespaceException extends Exception {
+  static override code = 'E_REMOVE_NAMESPACE'
+  static override status = 500
+  static override message = 'Error removing a domain namespace.'
+  static override help = 'Make sure the namespace exists and can be removed.'
+}

package/src/modeling/Bindings.ts

@@ -1,5 +1,5 @@
 import { IApiXmlSerializer } from '../amf/definitions/Shapes.js'
-import { DataPropertyFormat } from './DataFormat.js'
+import { DomainPropertyFormat } from './DataFormat.js'
 
 interface Binding {
   /**
@@ -61,7 +61,7 @@ export interface PropertyWebBindings {
   /**
    * The format specifying the property data type.
    */
-  format?: DataPropertyFormat
+  format?: DomainPropertyFormat
   /**
    * When set it overrides the `name` of the property.
    */