@api-client/core 0.11.10 → 0.12.0

package/src/modeling/DataFormat.ts

@@ -1,7 +1,4 @@
-import type { TextFieldType } from '@material/web/textfield/outlined-text-field.js'
-import type { DataProperty } from './DataProperty.js'
-
-export type DataPropertyType =
+export type DomainPropertyType =
   | 'string'
   | 'number'
   // | 'nil'
@@ -11,7 +8,13 @@ export type DataPropertyType =
   | 'time'
   // | 'any'
   | 'binary'
-export const DataPropertyTypes: DataPropertyType[] = [
+
+/**
+ * @deprecated Use the {@link DomainPropertyType} instead.
+ */
+export type DataPropertyType = DomainPropertyType
+
+export const DomainPropertyTypes: DomainPropertyType[] = [
   'string',
   'number',
   // 'nil',
@@ -33,6 +36,26 @@ export const DataPropertyTypes: DataPropertyType[] = [
   'binary',
 ]
 
+/**
+ * @deprecated Use the {@link DomainPropertyTypes} instead.
+ */
+export const DataPropertyTypes: DataPropertyType[] = DomainPropertyTypes
+
+export enum DomainPropertyList {
+  string = 'string',
+  number = 'number',
+  // nil = 'nil',
+  boolean = 'boolean',
+  date = 'date',
+  datetime = 'datetime',
+  time = 'time',
+  // any = 'any',
+  file = 'binary',
+}
+
+/**
+ * @deprecated Use the {@link DomainPropertyList} instead.
+ */
 export enum DataPropertyList {
   string = 'string',
   number = 'number',
@@ -48,7 +71,7 @@ export enum DataPropertyList {
 /**
  * The data property "attributes".
  */
-export type DataPropertyAttribute =
+export type DomainPropertyAttribute =
   | 'required'
   | 'multiple'
   | 'primary'
@@ -57,7 +80,12 @@ export type DataPropertyAttribute =
   | 'writeOnly'
   | 'deprecated'
 
-export const DataPropertyAttributes: DataPropertyAttribute[] = [
+/**
+ * @deprecated Use the {@link DomainPropertyAttribute} instead.
+ */
+export type DataPropertyAttribute = DomainPropertyAttribute
+
+export const DomainPropertyAttributes: DomainPropertyAttribute[] = [
   'required',
   'multiple',
   'primary',
@@ -67,12 +95,26 @@ export const DataPropertyAttributes: DataPropertyAttribute[] = [
   'deprecated',
 ]
 
+/**
+ * @deprecated Use the {@link DomainPropertyAttributes} instead.
+ */
+export const DataPropertyAttributes: DataPropertyAttribute[] = DomainPropertyAttributes
+
 /**
  * The data attribute "attributes".
  */
-export type DataAttributeAttribute = 'required' | 'multiple'
+export type DomainAttributeAttribute = 'required' | 'multiple'
 
-export const DataAttributeAttributes: DataAttributeAttribute[] = ['required', 'multiple']
+/**
+ * @deprecated Use the {@link DomainAttributeAttribute} instead.
+ */
+export type DataAttributeAttribute = DomainAttributeAttribute
+
+export const DomainAttributeAttributes: DomainAttributeAttribute[] = ['required', 'multiple']
+/**
+ * @deprecated Use the {@link DomainAttributeAttributes} instead.
+ */
+export const DataAttributeAttributes: DataAttributeAttribute[] = DomainAttributeAttributes
 
 /**
  * Note, OAS supports the `integer` data type and not format.
@@ -95,159 +137,8 @@ export type BinaryFormat = 'hex' | 'base64'
 
 export const BinaryFormats: BinaryFormat[] = ['hex', 'base64']
 
-export type DataPropertyFormat = NumberFormat | BinaryFormat
-
-export function getFormatInfo(format: DataPropertyFormat): { label: string; help: string } {
-  if (format === 'float') {
-    return { label: 'Float', help: '32-bit number with decimals' }
-  }
-  if (format === 'double') {
-    return { label: 'Double', help: '64-bit number with decimals' }
-  }
-  if (format === 'int32') {
-    return { label: 'Integer (32-bit)', help: '-2,147,483,648…+2,147,483,647' }
-  }
-  if (format === 'int64') {
-    return { label: 'Integer (64-bit)', help: 'Negative or positive 64-bit integer' }
-  }
-  if (format === 'hex') {
-    return { label: 'Hex', help: 'Hex-encoded binary data' }
-  }
-  if (format === 'base64') {
-    return { label: 'Base64', help: 'Base64-encoded binary data' }
-  }
-  return { label: 'Unknown', help: 'An error occured...' }
-}
-
-export interface DataPropertyInputConfig {
-  /**
-   * The input's type
-   */
-  type: TextFieldType
-  /**
-   * The `pattern` to set on the input.
-   */
-  pattern?: string
-  /**
-   * The `min` to set on the input.
-   */
-  min?: number
-  /**
-   * The `max` to set on the input.
-   */
-  max?: number
-  /**
-   * The `step` to set on the input.
-   */
-  step?: number
-  /**
-   * The `supportingText` to set on the Material Text Field.
-   */
-  help?: string
-}
-
+export type DomainPropertyFormat = NumberFormat | BinaryFormat
 /**
- * Gathers information about the HTML input's requirements for the given DataProperty.
- *
- * @param model The data property model to gather HTML input's configuration for.
- * @returns Input attributes to set.
+ * @deprecated Use the {@link DomainPropertyFormat} instead.
  */
-export function getPropertyInputOptions(model: DataProperty): DataPropertyInputConfig {
-  const result: DataPropertyInputConfig = { type: 'text' }
-  const wb = model.getWebBinding()
-  if (!wb) {
-    return result
-  }
-  const format = wb.format
-  // if (format === 'no-tz') {
-  //   result.pattern = '^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$'
-  //   result.help = 'yyyy-mm-ddThh:mm:ss.sss'
-  // } else if (format === 'utc') {
-  //   result.pattern = '^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$'
-  //   result.help = 'yyyy-mm-ddThh:mm:ss.sssZ'
-  // } else if (format === 'offset') {
-  //   result.pattern = '^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}[+-]\\d{2}$'
-  //   result.help = 'yyyy-mm-ddThh:mm:ss.sss±hh'
-  // } else if (format === 'time-offset') {
-  //   result.pattern = '^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}[+-]\\d{2}:\\d{2}$'
-  //   result.help = 'yyyy-mm-ddThh:mm:ss.sss±hh:mm'
-  // } else if (format === 'timestamp') {
-  //   result.type = 'number'
-  //   result.min = 0
-  //   result.step = 1
-  //   result.help = `Example: ${Date.now()}`
-  // } else if (format === 'integer') {
-  //   result.type = 'number'
-  //   result.step = 1
-  //   result.help = 'Arbitrary-size integer numbers'
-  // } else if (format === 'decimal') {
-  //   result.type = 'number'
-  //   result.step = 0.01
-  //   result.help = 'Arbitrary-precision decimal numbers'
-  // } else if (format === 'double') {
-  // else if (format === 'byte') {
-  //   result.type = 'number'
-  //   result.step = 1
-  //   result.help = '-128…+127 (8 bit)'
-  //   result.min = -128
-  //   result.max = 127
-  // } else if (format === 'short') {
-  //   result.type = 'number'
-  //   result.step = 1
-  //   result.help = '-32,768…+32,767 (16 bit)'
-  //   result.min = -32768
-  //   result.max = 32767
-  // }
-  // else if (format === 'long') {
-  //   result.type = 'number'
-  //   result.step = 1
-  //   result.help = 'Signed 64 bit number'
-  // } else if (format === 'unsignedByte') {
-  //   result.type = 'number'
-  //   result.step = 1
-  //   result.help = '0…255 (8 bit)'
-  //   result.min = 0
-  //   result.max = 255
-  // } else if (format === 'unsignedShort') {
-  //   result.type = 'number'
-  //   result.step = 1
-  //   result.help = '0…65,535 (16 bit)'
-  //   result.min = 0
-  //   result.max = 65535
-  // } else if (format === 'unsignedInt') {
-  //   result.type = 'number'
-  //   result.step = 1
-  //   result.help = '0…4,294,967,295 (32 bit)'
-  //   result.min = 0
-  //   result.max = 4294967295
-  // } else if (format === 'unsignedLong') {
-  //   result.type = 'number'
-  //   result.step = 1
-  //   result.help = 'Unsigned 64 bit number'
-  // }
-  if (format === 'float') {
-    result.type = 'number'
-    result.step = 0.000001
-    result.help = '32-bit number with decimals'
-    return result
-  }
-  if (format === 'double') {
-    result.type = 'number'
-    result.step = 0.000001
-    result.help = '64-bit number with decimals'
-    return result
-  } else if (format === 'int32') {
-    result.type = 'number'
-    result.step = 1
-    result.help = '-2,147,483,648…+2,147,483,647 (32 bit)'
-    result.min = -2147483648
-    result.max = 2147483647
-    return result
-  } else if (format === 'int64') {
-    result.type = 'number'
-    result.step = 1
-    result.help = 'Negative or positive 64-bit integer'
-    return result
-  }
-  return result
-}
+export type DataPropertyFormat = NumberFormat | BinaryFormat