@nmshd/content 2.0.0-alpha.13 → 2.0.0-alpha.16

package/dist/attributes/AbstractAttributeQuery.d.ts

@@ -2,14 +2,14 @@ import { CoreSerializable, ICoreSerializable } from "@nmshd/transport";
 import { ContentJSON } from "../ContentJSON";
 import { AbstractPeriod, AbstractPeriodJSON, IAbstractPeriod } from "./types/dates/AbstractPeriod";
 export interface AbstractAttributeQueryJSON extends ContentJSON {
-    valueType?: string;
+    valueType: string;
     validityPeriod?: AbstractPeriodJSON;
 }
 export interface IAbstractAttributeQuery extends ICoreSerializable {
-    valueType?: string;
+    valueType: string;
     validityPeriod?: IAbstractPeriod;
 }
 export declare abstract class AbstractAttributeQuery extends CoreSerializable implements IAbstractAttributeQuery {
-    valueType?: string;
+    valueType: string;
     validityPeriod?: AbstractPeriod;
 }

package/dist/attributes/AbstractAttributeQuery.js

@@ -18,7 +18,6 @@ class AbstractAttributeQuery extends transport_1.CoreSerializable {
 __decorate([
     (0, ts_serval_1.serialize)(),
     (0, ts_serval_1.validate)({
-        nullable: true,
         customValidator: (v) => (v === "" ? "must not be an empty string" : undefined)
     }),
     __metadata("design:type", String)

package/dist/attributes/AbstractAttributeQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractAttributeQuery.js","sourceRoot":"","sources":["../../src/attributes/AbstractAttributeQuery.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAwD;AACxD,gDAAsE;AAEtE,iEAAkG;AAYlG,MAAsB,sBAAuB,SAAQ,4BAAgB;CAWpE;AALG;IALC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC;QACN,QAAQ,EAAE,IAAI;QACd,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC,SAAS,CAAC;KACjF,CAAC;;yDACuB;AAIzB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACL,+BAAc;8DAAA;AAV1C,wDAWC"}
+{"version":3,"file":"AbstractAttributeQuery.js","sourceRoot":"","sources":["../../src/attributes/AbstractAttributeQuery.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAwD;AACxD,gDAAsE;AAEtE,iEAAkG;AAYlG,MAAsB,sBAAuB,SAAQ,4BAAgB;CAUpE;AALG;IAJC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC;QACN,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC,SAAS,CAAC;KACjF,CAAC;;yDACsB;AAIxB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACL,+BAAc;8DAAA;AAT1C,wDAUC"}

package/dist/attributes/AbstractAttributeValue.d.ts

@@ -1,5 +1,6 @@
 import { ISerializable, Serializable } from "@js-soft/ts-serval";
 import { ContentJSON } from "../ContentJSON";
+import { RenderHints, ValueHints } from "./hints";
 import { AbstractBoolean } from "./types/AbstractBoolean";
 import { AbstractFloat } from "./types/AbstractFloat";
 import { AbstractInteger } from "./types/AbstractInteger";
@@ -11,4 +12,6 @@ export interface IAbstractAttributeValue extends ISerializable {
 export declare abstract class AbstractAttributeValue extends Serializable implements IAbstractAttributeValue {
     static valueGenerator(v: AbstractBoolean | AbstractFloat | AbstractInteger | AbstractString): boolean | number | string;
     static valueArrayGenerator(v: (AbstractBoolean | AbstractFloat | AbstractInteger | AbstractString)[]): (boolean | number | string)[];
+    get valueHints(): ValueHints;
+    get renderHints(): RenderHints;
 }

package/dist/attributes/AbstractAttributeValue.js

@@ -9,6 +9,12 @@ class AbstractAttributeValue extends ts_serval_1.Serializable {
     static valueArrayGenerator(v) {
         return v.map((v) => v.value);
     }
+    get valueHints() {
+        return this.constructor.valueHints;
+    }
+    get renderHints() {
+        return this.constructor.renderHints;
+    }
 }
 exports.AbstractAttributeValue = AbstractAttributeValue;
 //# sourceMappingURL=AbstractAttributeValue.js.map

package/dist/attributes/AbstractAttributeValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractAttributeValue.js","sourceRoot":"","sources":["../../src/attributes/AbstractAttributeValue.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAWhE,MAAsB,sBAAuB,SAAQ,wBAAY;IACtD,MAAM,CAAC,cAAc,CACxB,CAAqE;QAErE,OAAO,CAAC,CAAC,KAAK,CAAA;IAClB,CAAC;IAEM,MAAM,CAAC,mBAAmB,CAC7B,CAAyE;QAEzE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC;CACJ;AAZD,wDAYC"}
+{"version":3,"file":"AbstractAttributeValue.js","sourceRoot":"","sources":["../../src/attributes/AbstractAttributeValue.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAYhE,MAAsB,sBAAuB,SAAQ,wBAAY;IACtD,MAAM,CAAC,cAAc,CACxB,CAAqE;QAErE,OAAO,CAAC,CAAC,KAAK,CAAA;IAClB,CAAC;IAEM,MAAM,CAAC,mBAAmB,CAC7B,CAAyE;QAEzE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC;IAED,IAAW,UAAU;QACjB,OAAQ,IAAI,CAAC,WAAmB,CAAC,UAAU,CAAA;IAC/C,CAAC;IAED,IAAW,WAAW;QAClB,OAAQ,IAAI,CAAC,WAAmB,CAAC,WAAW,CAAA;IAChD,CAAC;CACJ;AApBD,wDAoBC"}

package/dist/attributes/RelationshipAttribute.d.ts

@@ -1,15 +1,51 @@
 import { AbstractAttribute, AbstractAttributeJSON, IAbstractAttribute } from "./AbstractAttribute";
 import { AbstractAttributeValue, AbstractAttributeValueJSON, IAbstractAttributeValue } from "./AbstractAttributeValue";
+export declare enum RelationshipAttributeConfidentiality {
+    /**
+     * If a third party queries a public RelationshipAttribute from an Identity, there is no
+     * warning message for a user that possibly sensitive information from within a Relationship
+     * is shared to a third party. However, this does not mean that the request for such an
+     * Attribute can or is automatically accepted, as the user might not want to share it with
+     * this third party - nevertheless it is public.
+     *
+     * Good examples for public RelationshipAttributes are bonus membership ids or social network
+     * account names/channels.
+     */
+    Public = "public",
+    /**
+     * A private Attribute may never be queried by a third party. Even if queried, a user cannot
+     * "override" this rule and accept such a sharing request. Querying such an Attribute will
+     * result in an error.
+     *
+     * An example would be a telephone PIN with a bank which is used as the authentication factor.
+     */
+    Private = "private",
+    /**
+     * A protected RelationshipAttribute may be queried by a third party, but the user is
+     * specifically warned about this query and needs to give consent.
+     *
+     * This is great for all kinds of scenarios, in which giving out the RelationshipAttribute
+     * is a "common real-world edge case". For example given out a car insurance id to the
+     * other party once you had an accident.
+     */
+    Protected = "protected"
+}
 export interface RelationshipAttributeJSON<TValueJSONInterface extends AbstractAttributeValueJSON = AbstractAttributeValueJSON> extends AbstractAttributeJSON {
     value: TValueJSONInterface;
     key: string;
+    isTechnical?: boolean;
+    confidentiality: RelationshipAttributeConfidentiality;
 }
 export interface IRelationshipAttribute<TValueInterface extends IAbstractAttributeValue = IAbstractAttributeValue> extends IAbstractAttribute {
     value: TValueInterface;
     key: string;
+    isTechnical?: boolean;
+    confidentiality: RelationshipAttributeConfidentiality;
 }
 export declare class RelationshipAttribute<TValueClass extends AbstractAttributeValue = AbstractAttributeValue> extends AbstractAttribute implements IRelationshipAttribute<TValueClass> {
     value: TValueClass;
     key: string;
+    isTechnical: boolean;
+    confidentiality: RelationshipAttributeConfidentiality;
     static from<TValueClass extends AbstractAttributeValue = AbstractAttributeValue, TValueInterface extends IAbstractAttributeValue = IAbstractAttributeValue, TValueJSONInterface extends AbstractAttributeValueJSON = AbstractAttributeValueJSON>(value: IRelationshipAttribute<TValueInterface> | RelationshipAttributeJSON<TValueJSONInterface>): RelationshipAttribute<TValueClass>;
 }

package/dist/attributes/RelationshipAttribute.js

@@ -9,11 +9,46 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RelationshipAttribute = void 0;
+exports.RelationshipAttribute = exports.RelationshipAttributeConfidentiality = void 0;
 const ts_serval_1 = require("@js-soft/ts-serval");
 const AbstractAttribute_1 = require("./AbstractAttribute");
 const AbstractAttributeValue_1 = require("./AbstractAttributeValue");
+var RelationshipAttributeConfidentiality;
+(function (RelationshipAttributeConfidentiality) {
+    /**
+     * If a third party queries a public RelationshipAttribute from an Identity, there is no
+     * warning message for a user that possibly sensitive information from within a Relationship
+     * is shared to a third party. However, this does not mean that the request for such an
+     * Attribute can or is automatically accepted, as the user might not want to share it with
+     * this third party - nevertheless it is public.
+     *
+     * Good examples for public RelationshipAttributes are bonus membership ids or social network
+     * account names/channels.
+     */
+    RelationshipAttributeConfidentiality["Public"] = "public";
+    /**
+     * A private Attribute may never be queried by a third party. Even if queried, a user cannot
+     * "override" this rule and accept such a sharing request. Querying such an Attribute will
+     * result in an error.
+     *
+     * An example would be a telephone PIN with a bank which is used as the authentication factor.
+     */
+    RelationshipAttributeConfidentiality["Private"] = "private";
+    /**
+     * A protected RelationshipAttribute may be queried by a third party, but the user is
+     * specifically warned about this query and needs to give consent.
+     *
+     * This is great for all kinds of scenarios, in which giving out the RelationshipAttribute
+     * is a "common real-world edge case". For example given out a car insurance id to the
+     * other party once you had an accident.
+     */
+    RelationshipAttributeConfidentiality["Protected"] = "protected";
+})(RelationshipAttributeConfidentiality = exports.RelationshipAttributeConfidentiality || (exports.RelationshipAttributeConfidentiality = {}));
 let RelationshipAttribute = class RelationshipAttribute extends AbstractAttribute_1.AbstractAttribute {
+    constructor() {
+        super(...arguments);
+        this.isTechnical = false;
+    }
     static from(value) {
         return this.fromAny(value);
     }
@@ -25,9 +60,23 @@ __decorate([
 ], RelationshipAttribute.prototype, "value", void 0);
 __decorate([
     (0, ts_serval_1.serialize)(),
-    (0, ts_serval_1.validate)({ nullable: true }),
+    (0, ts_serval_1.validate)(),
     __metadata("design:type", String)
 ], RelationshipAttribute.prototype, "key", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", Object)
+], RelationshipAttribute.prototype, "isTechnical", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({
+        customValidator: (v) => !Object.values(RelationshipAttributeConfidentiality).includes(v)
+            ? `must be one of: ${Object.values(RelationshipAttributeConfidentiality)}`
+            : undefined
+    }),
+    __metadata("design:type", String)
+], RelationshipAttribute.prototype, "confidentiality", void 0);
 RelationshipAttribute = __decorate([
     (0, ts_serval_1.type)("RelationshipAttribute")
 ], RelationshipAttribute);

package/dist/attributes/RelationshipAttribute.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelationshipAttribute.js","sourceRoot":"","sources":["../../src/attributes/RelationshipAttribute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA8D;AAC9D,2DAAkG;AAClG,qEAAsH;AAgBtH,IAAa,qBAAqB,GAAlC,MAAa,qBACT,SAAQ,qCAAiB;IAYlB,MAAM,CAAC,IAAI,CAKd,KAA+F;QAE/F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAuC,CAAA;IACpE,CAAC;CACJ,CAAA;AAfG;IAFC,IAAA,qBAAS,EAAC,EAAE,UAAU,EAAE,CAAC,+CAAsB,CAAC,EAAE,CAAC;IACnD,IAAA,oBAAQ,GAAE;;oDACc;AAIzB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACX;AAXT,qBAAqB;IADjC,IAAA,gBAAI,EAAC,uBAAuB,CAAC;GACjB,qBAAqB,CAsBjC;AAtBY,sDAAqB"}
+{"version":3,"file":"RelationshipAttribute.js","sourceRoot":"","sources":["../../src/attributes/RelationshipAttribute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA8D;AAC9D,2DAAkG;AAClG,qEAAsH;AAEtH,IAAY,oCA6BX;AA7BD,WAAY,oCAAoC;IAC5C;;;;;;;;;OASG;IACH,yDAAiB,CAAA;IACjB;;;;;;OAMG;IACH,2DAAmB,CAAA;IACnB;;;;;;;OAOG;IACH,+DAAuB,CAAA;AAC3B,CAAC,EA7BW,oCAAoC,GAApC,4CAAoC,KAApC,4CAAoC,QA6B/C;AAoBD,IAAa,qBAAqB,GAAlC,MAAa,qBACT,SAAQ,qCAAiB;IAD7B;;QAeW,gBAAW,GAAG,KAAK,CAAA;IAoB9B,CAAC;IATU,MAAM,CAAC,IAAI,CAKd,KAA+F;QAE/F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAuC,CAAA;IACpE,CAAC;CACJ,CAAA;AA5BG;IAFC,IAAA,qBAAS,EAAC,EAAE,UAAU,EAAE,CAAC,+CAAsB,CAAC,EAAE,CAAC;IACnD,IAAA,oBAAQ,GAAE;;oDACc;AAIzB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;;kDACO;AAIlB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;;0DACe;AAS1B;IAPC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC;QACN,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CACnB,CAAC,MAAM,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5D,CAAC,CAAC,mBAAmB,MAAM,CAAC,MAAM,CAAC,oCAAoC,CAAC,EAAE;YAC1E,CAAC,CAAC,SAAS;KACtB,CAAC;;8DAC0D;AAxBnD,qBAAqB;IADjC,IAAA,gBAAI,EAAC,uBAAuB,CAAC;GACjB,qBAAqB,CAmCjC;AAnCY,sDAAqB"}

package/dist/attributes/RelationshipAttributeQuery.d.ts

@@ -1,15 +1,22 @@
 import { CoreAddress, ICoreAddress } from "@nmshd/transport";
 import { AbstractAttributeQuery, AbstractAttributeQueryJSON, IAbstractAttributeQuery } from "./AbstractAttributeQuery";
+import { IRelationshipAttributeHints, RelationshipAttributeHints, RelationshipAttributeHintsJSON } from "./hints/RelationshipAttributeHints";
 export interface RelationshipAttributeQueryJSON extends AbstractAttributeQueryJSON {
     key: string;
     owner: string;
+    attributeHints: RelationshipAttributeHintsJSON;
+    thirdParty?: string;
 }
 export interface IRelationshipAttributeQuery extends IAbstractAttributeQuery {
     key: string;
     owner: ICoreAddress;
+    attributeHints: IRelationshipAttributeHints;
+    thirdParty?: ICoreAddress;
 }
 export declare class RelationshipAttributeQuery extends AbstractAttributeQuery implements IRelationshipAttributeQuery {
     key: string;
     owner: CoreAddress;
+    attributeHints: RelationshipAttributeHints;
+    thirdParty?: CoreAddress;
     static from(value: IRelationshipAttributeQuery | RelationshipAttributeQueryJSON): RelationshipAttributeQuery;
 }

package/dist/attributes/RelationshipAttributeQuery.js

@@ -13,6 +13,7 @@ exports.RelationshipAttributeQuery = void 0;
 const ts_serval_1 = require("@js-soft/ts-serval");
 const transport_1 = require("@nmshd/transport");
 const AbstractAttributeQuery_1 = require("./AbstractAttributeQuery");
+const RelationshipAttributeHints_1 = require("./hints/RelationshipAttributeHints");
 let RelationshipAttributeQuery = class RelationshipAttributeQuery extends AbstractAttributeQuery_1.AbstractAttributeQuery {
     static from(value) {
         return this.fromAny(value);
@@ -28,6 +29,16 @@ __decorate([
     (0, ts_serval_1.validate)(),
     __metadata("design:type", transport_1.CoreAddress)
 ], RelationshipAttributeQuery.prototype, "owner", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", RelationshipAttributeHints_1.RelationshipAttributeHints)
+], RelationshipAttributeQuery.prototype, "attributeHints", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", transport_1.CoreAddress)
+], RelationshipAttributeQuery.prototype, "thirdParty", void 0);
 RelationshipAttributeQuery = __decorate([
     (0, ts_serval_1.type)("RelationshipAttributeQuery")
 ], RelationshipAttributeQuery);

package/dist/attributes/RelationshipAttributeQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelationshipAttributeQuery.js","sourceRoot":"","sources":["../../src/attributes/RelationshipAttributeQuery.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA8D;AAC9D,gDAA4D;AAC5D,qEAAsH;AAatH,IAAa,0BAA0B,GAAvC,MAAa,0BAA2B,SAAQ,+CAAsB;IAS3D,MAAM,CAAC,IAAI,CACd,KAAmE;QAEnE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;CACJ,CAAA;AAXG;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;;uDACO;AAIlB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;8BACG,uBAAW;yDAAA;AAPhB,0BAA0B;IADtC,IAAA,gBAAI,EAAC,4BAA4B,CAAC;GACtB,0BAA0B,CActC;AAdY,gEAA0B"}
+{"version":3,"file":"RelationshipAttributeQuery.js","sourceRoot":"","sources":["../../src/attributes/RelationshipAttributeQuery.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA8D;AAC9D,gDAA4D;AAC5D,qEAAsH;AACtH,mFAI2C;AAiB3C,IAAa,0BAA0B,GAAvC,MAAa,0BAA2B,SAAQ,+CAAsB;IAiB3D,MAAM,CAAC,IAAI,CACd,KAAmE;QAEnE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;CACJ,CAAA;AAnBG;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;;uDACO;AAIlB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;8BACG,uBAAW;yDAAA;AAIzB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;8BACY,uDAA0B;kEAAA;AAIjD;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACT,uBAAW;8DAAA;AAftB,0BAA0B;IADtC,IAAA,gBAAI,EAAC,4BAA4B,CAAC;GACtB,0BAA0B,CAsBtC;AAtBY,gEAA0B"}

package/dist/attributes/hints/RelationshipAttributeHints.d.ts

@@ -0,0 +1,30 @@
+import { ISerializable, Serializable } from "@js-soft/ts-serval";
+import { RelationshipAttributeConfidentiality } from "../RelationshipAttribute";
+import { IValueHints, ValueHints, ValueHintsJSON } from "./ValueHints";
+export interface RelationshipAttributeHintsJSON {
+    title: string;
+    description?: string;
+    valueHints?: ValueHintsJSON;
+    isTechnical?: boolean;
+    confidentiality: RelationshipAttributeConfidentiality;
+}
+export interface IRelationshipAttributeHints extends ISerializable {
+    title: string;
+    description?: string;
+    valueHints?: IValueHints;
+    isTechnical?: boolean;
+    confidentiality: RelationshipAttributeConfidentiality;
+}
+/**
+ * AttributeHints are rendering hints with a `title` and a possible `description` set.
+ * They are primarily used within `RelationshipAttributeQuery` to define the metadata of
+ * a proprietary Attribute, even without such an Attribute existent.
+ */
+export declare class RelationshipAttributeHints extends Serializable implements IRelationshipAttributeHints {
+    title: string;
+    description?: string;
+    valueHints?: ValueHints;
+    isTechnical: boolean;
+    confidentiality: RelationshipAttributeConfidentiality;
+    static from(value: IRelationshipAttributeHints | RelationshipAttributeHintsJSON): RelationshipAttributeHints;
+}

package/dist/attributes/hints/RelationshipAttributeHints.js

@@ -0,0 +1,63 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationshipAttributeHints = void 0;
+const ts_serval_1 = require("@js-soft/ts-serval");
+const RelationshipAttribute_1 = require("../RelationshipAttribute");
+const ValueHints_1 = require("./ValueHints");
+/**
+ * AttributeHints are rendering hints with a `title` and a possible `description` set.
+ * They are primarily used within `RelationshipAttributeQuery` to define the metadata of
+ * a proprietary Attribute, even without such an Attribute existent.
+ */
+let RelationshipAttributeHints = class RelationshipAttributeHints extends ts_serval_1.Serializable {
+    constructor() {
+        super(...arguments);
+        this.isTechnical = false;
+    }
+    static from(value) {
+        return this.fromAny(value);
+    }
+};
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", String)
+], RelationshipAttributeHints.prototype, "title", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", String)
+], RelationshipAttributeHints.prototype, "description", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", ValueHints_1.ValueHints)
+], RelationshipAttributeHints.prototype, "valueHints", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", Object)
+], RelationshipAttributeHints.prototype, "isTechnical", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({
+        customValidator: (v) => !Object.values(RelationshipAttribute_1.RelationshipAttributeConfidentiality).includes(v)
+            ? `must be one of: ${Object.values(RelationshipAttribute_1.RelationshipAttributeConfidentiality)}`
+            : undefined
+    }),
+    __metadata("design:type", String)
+], RelationshipAttributeHints.prototype, "confidentiality", void 0);
+RelationshipAttributeHints = __decorate([
+    (0, ts_serval_1.type)("RelationshipAttributeHints")
+], RelationshipAttributeHints);
+exports.RelationshipAttributeHints = RelationshipAttributeHints;
+//# sourceMappingURL=RelationshipAttributeHints.js.map

package/dist/attributes/hints/RelationshipAttributeHints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelationshipAttributeHints.js","sourceRoot":"","sources":["../../../src/attributes/hints/RelationshipAttributeHints.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA2F;AAC3F,oEAA+E;AAC/E,6CAAsE;AAkBtE;;;;GAIG;AAEH,IAAa,0BAA0B,GAAvC,MAAa,0BAA2B,SAAQ,wBAAY;IAA5D;;QAeW,gBAAW,GAAG,KAAK,CAAA;IAe9B,CAAC;IALU,MAAM,CAAC,IAAI,CACd,KAAmE;QAEnE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;CACJ,CAAA;AA3BG;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;;yDACS;AAIpB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+DACF;AAI3B;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACT,uBAAU;8DAAA;AAI9B;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;;+DACe;AAQ1B;IAPC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC;QACN,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CACnB,CAAC,MAAM,CAAC,MAAM,CAAC,4DAAoC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5D,CAAC,CAAC,mBAAmB,MAAM,CAAC,MAAM,CAAC,4DAAoC,CAAC,EAAE;YAC1E,CAAC,CAAC,SAAS;KACtB,CAAC;;mEAC0D;AAvBnD,0BAA0B;IADtC,IAAA,gBAAI,EAAC,4BAA4B,CAAC;GACtB,0BAA0B,CA8BtC;AA9BY,gEAA0B"}

package/dist/attributes/hints/RenderHints.d.ts

@@ -0,0 +1,70 @@
+import { Serializable } from "@js-soft/ts-serval";
+export declare enum RenderHintsTechnicalType {
+    Boolean = "Boolean",
+    Float = "Float",
+    Integer = "Integer",
+    Object = "Object",
+    String = "String"
+}
+export declare enum RenderHintsEditType {
+    InputLike = "InputLike",
+    ButtonLike = "ButtonLike",
+    RadioButtonLike = "RadioButtonLike",
+    SelectLike = "SelectLike",
+    SliderLike = "SliderLike",
+    Secret = "Secret",
+    TextArea = "TextArea",
+    Upload = "Upload"
+}
+export declare enum RenderHintsDataType {
+    Country = "Country",
+    DataURL = "DataURL",
+    EMailAddress = "EMailAddress",
+    HEXColor = "HEXColor",
+    Language = "Language",
+    PhoneNumber = "PhoneNumber",
+    URL = "URL",
+    FileReference = "FileReference",
+    Date = "Date",
+    DatePeriod = "DatePeriod",
+    DateTime = "DateTime",
+    DateTimePeriod = "DateTimePeriod",
+    Time = "Time",
+    TimePeriod = "TimePeriod"
+}
+export interface RenderHintsJSON {
+    technicalType: RenderHintsTechnicalType;
+    editType: RenderHintsEditType;
+    dataType?: RenderHintsDataType;
+}
+export interface IRenderHints {
+    technicalType: RenderHintsTechnicalType;
+    editType: RenderHintsEditType;
+    dataType?: RenderHintsDataType;
+}
+export declare class RenderHints extends Serializable implements IRenderHints {
+    technicalType: RenderHintsTechnicalType;
+    editType: RenderHintsEditType;
+    dataType?: RenderHintsDataType;
+    static from(value: IRenderHints): RenderHints;
+    toJSON(): IRenderHints;
+    copyWith(override?: Partial<IRenderHintsOverride>): RenderHints;
+}
+export interface RenderHintsOverrideJSON {
+    technicalType?: RenderHintsTechnicalType;
+    editType?: RenderHintsEditType;
+    dataType?: RenderHintsDataType;
+}
+export interface IRenderHintsOverride {
+    technicalType?: RenderHintsTechnicalType;
+    editType?: RenderHintsEditType;
+    dataType?: RenderHintsDataType;
+}
+export declare class RenderHintsOverride extends Serializable implements IRenderHintsOverride {
+    technicalType?: RenderHintsTechnicalType;
+    editType?: RenderHintsEditType;
+    dataType?: RenderHintsDataType;
+    static from(value: IRenderHints): RenderHintsOverride;
+    toJSON(): IRenderHints;
+    with(override: Partial<RenderHintsOverrideJSON>): RenderHints;
+}

package/dist/attributes/hints/RenderHints.js

@@ -0,0 +1,111 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var RenderHints_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderHintsOverride = exports.RenderHints = exports.RenderHintsDataType = exports.RenderHintsEditType = exports.RenderHintsTechnicalType = void 0;
+const ts_serval_1 = require("@js-soft/ts-serval");
+var RenderHintsTechnicalType;
+(function (RenderHintsTechnicalType) {
+    RenderHintsTechnicalType["Boolean"] = "Boolean";
+    RenderHintsTechnicalType["Float"] = "Float";
+    RenderHintsTechnicalType["Integer"] = "Integer";
+    RenderHintsTechnicalType["Object"] = "Object";
+    RenderHintsTechnicalType["String"] = "String";
+})(RenderHintsTechnicalType = exports.RenderHintsTechnicalType || (exports.RenderHintsTechnicalType = {}));
+var RenderHintsEditType;
+(function (RenderHintsEditType) {
+    RenderHintsEditType["InputLike"] = "InputLike";
+    RenderHintsEditType["ButtonLike"] = "ButtonLike";
+    RenderHintsEditType["RadioButtonLike"] = "RadioButtonLike";
+    RenderHintsEditType["SelectLike"] = "SelectLike";
+    RenderHintsEditType["SliderLike"] = "SliderLike";
+    RenderHintsEditType["Secret"] = "Secret";
+    RenderHintsEditType["TextArea"] = "TextArea";
+    RenderHintsEditType["Upload"] = "Upload";
+})(RenderHintsEditType = exports.RenderHintsEditType || (exports.RenderHintsEditType = {}));
+var RenderHintsDataType;
+(function (RenderHintsDataType) {
+    RenderHintsDataType["Country"] = "Country";
+    RenderHintsDataType["DataURL"] = "DataURL";
+    RenderHintsDataType["EMailAddress"] = "EMailAddress";
+    RenderHintsDataType["HEXColor"] = "HEXColor";
+    RenderHintsDataType["Language"] = "Language";
+    RenderHintsDataType["PhoneNumber"] = "PhoneNumber";
+    RenderHintsDataType["URL"] = "URL";
+    RenderHintsDataType["FileReference"] = "FileReference";
+    RenderHintsDataType["Date"] = "Date";
+    RenderHintsDataType["DatePeriod"] = "DatePeriod";
+    RenderHintsDataType["DateTime"] = "DateTime";
+    RenderHintsDataType["DateTimePeriod"] = "DateTimePeriod";
+    RenderHintsDataType["Time"] = "Time";
+    RenderHintsDataType["TimePeriod"] = "TimePeriod";
+})(RenderHintsDataType = exports.RenderHintsDataType || (exports.RenderHintsDataType = {}));
+let RenderHints = RenderHints_1 = class RenderHints extends ts_serval_1.Serializable {
+    static from(value) {
+        return this.fromAny(value);
+    }
+    toJSON() {
+        return super.toJSON();
+    }
+    copyWith(override) {
+        return RenderHints_1.from({ ...this.toJSON(), ...override });
+    }
+};
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", String)
+], RenderHints.prototype, "technicalType", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", String)
+], RenderHints.prototype, "editType", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", String)
+], RenderHints.prototype, "dataType", void 0);
+RenderHints = RenderHints_1 = __decorate([
+    (0, ts_serval_1.type)("RenderHints")
+], RenderHints);
+exports.RenderHints = RenderHints;
+let RenderHintsOverride = class RenderHintsOverride extends ts_serval_1.Serializable {
+    static from(value) {
+        return this.fromAny(value);
+    }
+    toJSON() {
+        return super.toJSON();
+    }
+    with(override) {
+        return RenderHints.from({ ...this.toJSON(), ...override });
+    }
+};
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", String)
+], RenderHintsOverride.prototype, "technicalType", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", String)
+], RenderHintsOverride.prototype, "editType", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", String)
+], RenderHintsOverride.prototype, "dataType", void 0);
+RenderHintsOverride = __decorate([
+    (0, ts_serval_1.type)("RenderHints")
+], RenderHintsOverride);
+exports.RenderHintsOverride = RenderHintsOverride;
+//# sourceMappingURL=RenderHints.js.map

package/dist/attributes/hints/RenderHints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenderHints.js","sourceRoot":"","sources":["../../../src/attributes/hints/RenderHints.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,kDAA4E;AAE5E,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAChC,+CAAmB,CAAA;IACnB,2CAAe,CAAA;IACf,+CAAmB,CAAA;IACnB,6CAAiB,CAAA;IACjB,6CAAiB,CAAA;AACrB,CAAC,EANW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAMnC;AAED,IAAY,mBASX;AATD,WAAY,mBAAmB;IAC3B,8CAAuB,CAAA;IACvB,gDAAyB,CAAA;IACzB,0DAAmC,CAAA;IACnC,gDAAyB,CAAA;IACzB,gDAAyB,CAAA;IACzB,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,wCAAiB,CAAA;AACrB,CAAC,EATW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAS9B;AAED,IAAY,mBAeX;AAfD,WAAY,mBAAmB;IAC3B,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,oDAA6B,CAAA;IAC7B,4CAAqB,CAAA;IACrB,4CAAqB,CAAA;IACrB,kDAA2B,CAAA;IAC3B,kCAAW,CAAA;IACX,sDAA+B,CAAA;IAC/B,oCAAa,CAAA;IACb,gDAAyB,CAAA;IACzB,4CAAqB,CAAA;IACrB,wDAAiC,CAAA;IACjC,oCAAa,CAAA;IACb,gDAAyB,CAAA;AAC7B,CAAC,EAfW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAe9B;AAeD,IAAa,WAAW,mBAAxB,MAAa,WAAY,SAAQ,wBAAY;IAalC,MAAM,CAAC,IAAI,CAAC,KAAmB;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAEe,MAAM;QAClB,OAAO,KAAK,CAAC,MAAM,EAAkB,CAAA;IACzC,CAAC;IAEM,QAAQ,CAAC,QAAwC;QACpD,OAAO,aAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAA;IAC9D,CAAC;CACJ,CAAA;AArBG;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;;kDACmC;AAI9C;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;;6CACyB;AAIpC;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACQ;AAX5B,WAAW;IADvB,IAAA,gBAAI,EAAC,aAAa,CAAC;GACP,WAAW,CAwBvB;AAxBY,kCAAW;AAuCxB,IAAa,mBAAmB,GAAhC,MAAa,mBAAoB,SAAQ,wBAAY;IAa1C,MAAM,CAAC,IAAI,CAAC,KAAmB;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAEe,MAAM;QAClB,OAAO,KAAK,CAAC,MAAM,EAAkB,CAAA;IACzC,CAAC;IAEM,IAAI,CAAC,QAA0C;QAClD,OAAO,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAA;IAC9D,CAAC;CACJ,CAAA;AArBG;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACkB;AAI/C;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACQ;AAIrC;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACQ;AAX5B,mBAAmB;IAD/B,IAAA,gBAAI,EAAC,aAAa,CAAC;GACP,mBAAmB,CAwB/B;AAxBY,kDAAmB"}

package/dist/attributes/hints/ValueHints.d.ts

@@ -0,0 +1,44 @@
+import { ISerializable, Serializable } from "@js-soft/ts-serval";
+import { ContentJSON } from "../../ContentJSON";
+import { IValueHintsValue, ValueHintsValue, ValueHintsValueJSON } from "./ValueHintsValue";
+export interface ValueHintsJSON extends ContentJSON {
+    editHelp?: string;
+    min?: number;
+    max?: number;
+    pattern?: string;
+    values?: ValueHintsValueJSON[];
+    defaultValue?: any;
+}
+export interface ValueHintsOverrideJSON extends Partial<ValueHintsOverride> {
+}
+export interface IValueHints extends ISerializable {
+    editHelp?: string;
+    min?: number;
+    max?: number;
+    pattern?: string;
+    values?: IValueHintsValue[];
+    defaultValue?: any;
+}
+export interface IValueHintsOverride extends Partial<IValueHints> {
+}
+export declare class ValueHints extends Serializable implements IValueHints {
+    editHelp?: string;
+    min?: number;
+    max?: number;
+    pattern?: string;
+    values?: ValueHintsValue[];
+    defaultValue?: any;
+    static from(value: IValueHints | ValueHintsJSON): ValueHints;
+    toJSON(): ValueHintsJSON;
+    copyWith(override?: Partial<ValueHintsOverrideJSON>): ValueHints;
+}
+export declare class ValueHintsOverride extends Serializable implements IValueHintsOverride {
+    editHelp?: string;
+    min?: number;
+    max?: number;
+    pattern?: string;
+    values?: ValueHintsValue[];
+    defaultValue?: boolean | number | string;
+    static from(value: IValueHintsOverride | ValueHintsOverrideJSON): ValueHintsOverride;
+    toJSON(): ValueHintsOverrideJSON;
+}