@api-client/core 0.11.11 → 0.12.1

package/build/src/modeling/DomainProperty.d.ts

@@ -0,0 +1,281 @@
+import type { DataDomain } from './DataDomain.js';
+import { DomainPropertyKind } from '../models/kinds.js';
+import { DomainElement, type DomainElementSchema } from './DomainElement.js';
+import { type IThing, Thing } from '../models/Thing.js';
+import { type DomainPropertyAttribute, type DomainPropertyFormat, type DomainPropertyType } from './DataFormat.js';
+import type { PropertyBinding, PropertyBindings, PropertyWebBindings } from './Bindings.js';
+import type { ModelValidationOptions } from '../models/types.js';
+import type { DomainEntity } from './DomainEntity.js';
+import type { IApiPropertyShape } from '../amf/definitions/Shapes.js';
+import { PropertySchema } from './types.js';
+export interface DomainPropertySchema extends DomainElementSchema {
+    kind: typeof DomainPropertyKind;
+    /**
+     * The domain property description.
+     */
+    info: IThing;
+    /**
+     * Wether the data property is required.
+     */
+    required?: boolean;
+    /**
+     * Whether the data property allows multiple items.
+     */
+    multiple?: boolean;
+    /**
+     * Whether this property describes a primary key of the entity.
+     */
+    primary?: boolean;
+    /**
+     * Whether this property describes an indexed property of the entity.
+     */
+    index?: boolean;
+    /**
+     * Whether the property is read only in the schema.
+     */
+    readOnly?: boolean;
+    /**
+     * Whether the property is write only in the schema.
+     */
+    writeOnly?: boolean;
+    /**
+     * Whether this property is deprecated.
+     */
+    deprecated?: boolean;
+    /**
+     * Optional general purpose tags for the UI.
+     */
+    tags?: string[];
+    /**
+     * For future use.
+     *
+     * The keys of the taxonomy items associated with the property.
+     */
+    taxonomy?: string[];
+    /**
+     * The data type for this property.
+     * Note, not all schemas support the same type. For example, defining `sint32`
+     * works for protocol buffers, but does not for JSON. In such case we use default
+     * translation `sint32` -> `number`. Another way it to create
+     * a derivative entity for specific schema to describe specific schema case.
+     */
+    type: DomainPropertyType;
+    /**
+     * The general schema definition of this property.
+     * This is propagated to all bindings (when they support these properties).
+     */
+    schema?: PropertySchema;
+    /**
+     * The list of bindings for this property.
+     *
+     * A binding defines a translation from a data model to a specific format.
+     * For example allows to define properties required to generate AMF shape and therefore RAML/OAS shapes for web APIs
+     * or a protocol buffer schema.
+     */
+    bindings?: PropertyBinding[];
+}
+/**
+ * Represents a property within a data domain entity.
+ *
+ * A `DomainProperty` defines a single data element within a
+ * `DomainEntity`. It specifies the data type, constraints,
+ * and other metadata for a specific piece of information.
+ *
+ * **Key Features:**
+ *
+ * -   **Data Type:** Defines the type of data the property
+ *     holds (e.g., string, number, boolean, date).
+ * -   **Constraints:** Supports defining constraints such as
+ *     minimum/maximum values, enum values, and default values.
+ * -   **Bindings:** Allows defining how the property is
+ *     represented in different formats (e.g., web APIs,
+ *     protocol buffers).
+ * -   **Metadata:** Supports metadata such as tags, taxonomy,
+ *     read-only/write-only status, and deprecation.
+ * -   **Schema:** Allows defining a general schema for the
+ *     property, which is propagated to all bindings.
+ *
+ * **Usage:**
+ *
+ * Use the `DataEntity.addProperty` method to add a new property to an
+ * entity. The property can be created using the constructor, but it
+ * won't be added to the graph until you call the `addProperty` method.
+ *
+ * **Example:**
+ *
+ * ```typescript
+ * const entity = dataModel.addEntity({ key: 'user' });
+ * const property = entity.addProperty({
+ *   key: 'name',
+ *   type: 'string',
+ *   required: true,
+ *   schema: {
+ *     minimum: 3,
+ *     maximum: 50,
+ *   },
+ * });
+ * ```
+ */
+export declare class DomainProperty extends DomainElement {
+    kind: typeof DomainPropertyKind;
+    /**
+     * The description of the domain property.
+     */
+    accessor info: Thing;
+    /**
+     * Wether the data property is required.
+     */
+    accessor required: boolean | undefined;
+    /**
+     * Whether the data property allows multiple items.
+     */
+    accessor multiple: boolean | undefined;
+    /**
+     * Whether this property describes a primary key of the entity.
+     */
+    accessor primary: boolean | undefined;
+    /**
+     * Whether this property describes an indexed property of the entity.
+     */
+    accessor index: boolean | undefined;
+    /**
+     * Whether the property is read only in the schema.
+     */
+    accessor readOnly: boolean | undefined;
+    /**
+     * Whether the property is write only in the schema.
+     */
+    accessor writeOnly: boolean | undefined;
+    /**
+     * Whether this property is deprecated.
+     */
+    accessor deprecated: boolean | undefined;
+    /**
+     * Optional general purpose tags for the UI.
+     *
+     * Note to implementations, use the `addTag()` method as it propagates the "tag" value in the namespace.
+     * Also, the tags property is excluded from the observer properties.
+     * Changes to this property will not notify the observers.
+     */
+    accessor tags: string[];
+    /**
+     * Reserved for future use.
+     *
+     * The keys of the taxonomy items associated with the property.
+     */
+    accessor taxonomy: string[];
+    /**
+     * The data type for this property.
+     * Note, not all schemas support the same type. For example, defining `sint32`
+     * works for protocol buffers but does not for JSON. In such case we use default
+     * translation `sint32` -> `number`. Another way it to create
+     * a derivative entity for specific schema to describe specific schema case.
+     */
+    accessor type: DomainPropertyType;
+    /**
+     * The general schema definition of this property.
+     * This is propagated to all bindings (when they support these properties).
+     */
+    accessor schema: PropertySchema | undefined;
+    /**
+     * The list of bindings for this property.
+     *
+     * A binding defines a translation from a data model to a specific format.
+     * For example allows to define properties required to generate AMF shape and therefore RAML/OAS shapes for web APIs
+     * or a protocol buffer schema.
+     */
+    accessor bindings: PropertyBinding[];
+    /**
+     * Creates a full data model schema with defaults.
+     *
+     * @param input The partial data model schema.
+     * @returns The data model schema.
+     */
+    static createSchema(input?: Partial<DomainPropertySchema>): DomainPropertySchema;
+    /**
+     * The key of the parent entity.
+     */
+    protected parent: string;
+    /**
+     * Creates a new domain property instance.
+     * It does not add it to the graph.
+     * You need to call the `addProperty` method of the graph or a data model to add it.
+     *
+     * Domain objects constructors shouldn't be used directly. Use methods
+     * provided on the DataDomain class to create new objects.
+     *
+     * @param root A reference to the root DataDomain instance.
+     * @param parent The key of the parent entity.
+     * @param input The partial domain property schema.
+     * @returns Created domain property instance.
+     */
+    constructor(root: DataDomain, parent: string, input?: Partial<DomainPropertySchema>);
+    /**
+     * Checks whether the input is a valid definition of a domain property.
+     *
+     * @param input The input to validate.
+     * @param options Validation options.
+     * @returns true when the passed input is a valid definition of a domain property.
+     */
+    static validate(input: unknown, options?: ModelValidationOptions): boolean;
+    toJSON(): DomainPropertySchema;
+    /**
+     * Removes this property from the parent entity.
+     * It calls the `removeProperty()` method of the parent entity.
+     */
+    remove(): void;
+    /**
+     * Returns a parent data entity where this data property exist.
+     */
+    getParentInstance(): DomainEntity | undefined;
+    /**
+     * Checks whether the passed value is one of the supported data types.
+     * @param value The value to test
+     * @returns True when the passed value is one of the supported data types.
+     */
+    static isValidType(value: unknown): value is DomainPropertyType;
+    /**
+     * Checks whether the passed value is one of the supported data property attributes.
+     * @param value The value to test
+     * @returns True when the passed value is one of the supported data property attributes.
+     */
+    static isValidAttribute(value: unknown): value is DomainPropertyAttribute;
+    /**
+     * Checks whether the passed value of one of the supported `format` values.
+     *
+     * @param value The value to test
+     * @returns `true` when the value is one of the supported `format` values.
+     */
+    static isValidFormat(value: unknown): value is DomainPropertyFormat;
+    /**
+     * Creates the `schema` object if missing and returns it.
+     * @returns The schema object.
+     */
+    ensureSchema(): PropertySchema;
+    /**
+     * Creates if not existing and returns web bindings definition.
+     * @returns The web binding definition
+     */
+    getWebBinding(): PropertyWebBindings;
+    /**
+     * Returns the schema value of the binding, if any was created.
+     * @param type The type of the binding to read.
+     * @returns The binding schema, if any
+     */
+    readBinding(type: 'web' | 'protobuf'): PropertyBindings | undefined;
+    /**
+     * Creates a Property Shape of AMF.
+     *
+     * The property itself is auto-generated. If the `schema` is
+     * defined then it is used as the `range` of the property.
+     * Otherwise basic shape is generated for the range.
+     *
+     * This is a preferred way of reading the AMF shape as this
+     * synchronizes changed data properties with the shape
+     * definition.
+     *
+     * @returns AMF property shape definition.
+     */
+    toApiShape(): IApiPropertyShape;
+}
+//# sourceMappingURL=DomainProperty.d.ts.map

package/build/src/modeling/DomainProperty.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DomainProperty.d.ts","sourceRoot":"","sources":["../../../src/modeling/DomainProperty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAE5E,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAEvD,OAAO,EAGL,KAAK,uBAAuB,EAE5B,KAAK,oBAAoB,EAEzB,KAAK,kBAAkB,EAIxB,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAC3F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAErE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC/D,IAAI,EAAE,OAAO,kBAAkB,CAAA;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB;;;;;;OAMG;IACH,IAAI,EAAE,kBAAkB,CAAA;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,CAAA;IACvB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,cAAe,SAAQ,aAAa;IACtC,IAAI,EAAE,OAAO,kBAAkB,CAAA;IAExC;;OAEG;IACe,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;IAEtC;;OAEG;IACS,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAElD;;OAEG;IACS,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAElD;;OAEG;IACS,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAA;IAEjD;;OAEG;IACS,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,CAAA;IAE/C;;OAEG;IACS,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAElD;;OAEG;IACS,QAAQ,CAAC,SAAS,EAAE,OAAO,GAAG,SAAS,CAAA;IAEnD;;OAEG;IACS,QAAQ,CAAC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAEpD;;;;;;OAMG;IACuB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAK;IAEtD;;;;OAIG;IACuB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAK;IAE1D;;;;;;OAMG;IACS,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAW;IAExD;;;OAGG;IACuB,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,SAAS,CAAA;IAErE;;;;;;OAMG;IACuB,QAAQ,CAAC,QAAQ,EAAE,eAAe,EAAE,CAAK;IAEnE;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,GAAE,OAAO,CAAC,oBAAoB,CAAM,GAAG,oBAAoB;IAkEpF;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,CAAA;IAExB;;;;;;;;;;;;OAYG;gBACS,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,GAAE,OAAO,CAAC,oBAAoB,CAAM;IAiEvF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,GAAE,sBAA2B,GAAG,OAAO;IAW9E,MAAM,IAAI,oBAAoB;IA2C9B;;;OAGG;IACH,MAAM,IAAI,IAAI;IAKd;;OAEG;IACH,iBAAiB,IAAI,YAAY,GAAG,SAAS;IAI7C;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,kBAAkB;IAO/D;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,uBAAuB;IAOzE;;;;;OAKG;IACH,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB;IAiBnE;;;OAGG;IACH,YAAY,IAAI,cAAc;IAO9B;;;OAGG;IACH,aAAa,IAAI,mBAAmB;IASpC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,UAAU,GAAG,gBAAgB,GAAG,SAAS;IAKnE;;;;;;;;;;;;OAYG;IACH,UAAU,IAAI,iBAAiB;CAIhC"}