@nmshd/content 2.0.0-alpha.9 → 2.0.0-beta.3

package/README.md

@@ -7,7 +7,7 @@ The content library defines data structures that can be transmitted using the [t
 
 ## Documentation
 
-The documentation for this project is currently under construction.
+You can find the documentation for Enmeshed on [enmeshed.eu](https://enmeshed.eu).
 
 ## Feedback
 
@@ -17,7 +17,7 @@ Share your feedback with the Enmeshed team by contributing to the [discussions](
 
 ## Contribute
 
-Currently contribution to this project is not possible. This will change soon.
+Contribution to this project is highly apprecicated. Head over to our [contribution guide](https://github.com/nmshd/.github/blob/main/CONTRIBUTING.md) to learn more.
 
 ## License
 

package/dist/attributes/AbstractAttribute.d.ts

@@ -0,0 +1,17 @@
+import { CoreAddress, CoreDate, CoreSerializable, ICoreAddress, ICoreDate, ICoreSerializable } from "@nmshd/transport";
+import { ContentJSON } from "../ContentJSON";
+export interface AbstractAttributeJSON extends ContentJSON {
+    owner: string;
+    validFrom?: string;
+    validTo?: string;
+}
+export interface IAbstractAttribute extends ICoreSerializable {
+    owner: ICoreAddress;
+    validFrom?: ICoreDate;
+    validTo?: ICoreDate;
+}
+export declare abstract class AbstractAttribute extends CoreSerializable implements IAbstractAttribute {
+    owner: CoreAddress;
+    validFrom?: CoreDate;
+    validTo?: CoreDate;
+}

package/dist/attributes/{AttributeV2.js → AbstractAttribute.js}

@@ -9,42 +9,25 @@ 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.AttributeV2 = void 0;
+exports.AbstractAttribute = void 0;
 const ts_serval_1 = require("@js-soft/ts-serval");
 const transport_1 = require("@nmshd/transport");
-const AbstractAttributeValue_1 = require("./AbstractAttributeValue");
-let AttributeV2 = class AttributeV2 extends transport_1.CoreSerializable {
-    static from(value) {
-        return this.fromAny(value);
-    }
-};
-__decorate([
-    (0, ts_serval_1.serialize)(),
-    (0, ts_serval_1.validate)(),
-    __metadata("design:type", AbstractAttributeValue_1.AbstractAttributeValue)
-], AttributeV2.prototype, "value", void 0);
+class AbstractAttribute extends transport_1.CoreSerializable {
+}
 __decorate([
     (0, ts_serval_1.validate)(),
     (0, ts_serval_1.serialize)(),
-    __metadata("design:type", transport_1.CoreDate)
-], AttributeV2.prototype, "createdAt", void 0);
-__decorate([
-    (0, ts_serval_1.serialize)({ type: String }),
-    (0, ts_serval_1.validate)({ nullable: true }),
-    __metadata("design:type", Array)
-], AttributeV2.prototype, "tags", void 0);
+    __metadata("design:type", transport_1.CoreAddress)
+], AbstractAttribute.prototype, "owner", void 0);
 __decorate([
     (0, ts_serval_1.serialize)(),
     (0, ts_serval_1.validate)({ nullable: true }),
     __metadata("design:type", transport_1.CoreDate)
-], AttributeV2.prototype, "validFrom", void 0);
+], AbstractAttribute.prototype, "validFrom", void 0);
 __decorate([
     (0, ts_serval_1.serialize)(),
     (0, ts_serval_1.validate)({ nullable: true }),
     __metadata("design:type", transport_1.CoreDate)
-], AttributeV2.prototype, "validTo", void 0);
-AttributeV2 = __decorate([
-    (0, ts_serval_1.type)("Attribute", { version: 2 })
-], AttributeV2);
-exports.AttributeV2 = AttributeV2;
-//# sourceMappingURL=AttributeV2.js.map
+], AbstractAttribute.prototype, "validTo", void 0);
+exports.AbstractAttribute = AbstractAttribute;
+//# sourceMappingURL=AbstractAttribute.js.map

package/dist/attributes/AbstractAttribute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractAttribute.js","sourceRoot":"","sources":["../../src/attributes/AbstractAttribute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAwD;AACxD,gDAAsH;AAetH,MAAsB,iBAAkB,SAAQ,4BAAgB;CAY/D;AATG;IAFC,IAAA,oBAAQ,GAAE;IACV,IAAA,qBAAS,GAAE;8BACE,uBAAW;gDAAA;AAIzB;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACV,oBAAQ;oDAAA;AAI3B;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACZ,oBAAQ;kDAAA;AAX7B,8CAYC"}

package/dist/attributes/AbstractAttributeQuery.d.ts

@@ -0,0 +1,17 @@
+import { CoreDate, CoreSerializable, ICoreDate, ICoreSerializable } from "@nmshd/transport";
+import { ContentJSON } from "../ContentJSON";
+export interface AbstractAttributeQueryJSON extends ContentJSON {
+    valueType: string;
+    validFrom?: string;
+    validTo?: string;
+}
+export interface IAbstractAttributeQuery extends ICoreSerializable {
+    valueType: string;
+    validFrom?: ICoreDate;
+    validTo?: ICoreDate;
+}
+export declare abstract class AbstractAttributeQuery extends CoreSerializable implements IAbstractAttributeQuery {
+    valueType: string;
+    validFrom?: CoreDate;
+    validTo?: CoreDate;
+}

package/dist/attributes/{AttributeQuery.js → AbstractAttributeQuery.js}

@@ -9,34 +9,27 @@ 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.AttributeQuery = void 0;
+exports.AbstractAttributeQuery = void 0;
 const ts_serval_1 = require("@js-soft/ts-serval");
 const transport_1 = require("@nmshd/transport");
-let AttributeQuery = class AttributeQuery extends transport_1.CoreSerializable {
-    static from(value) {
-        return this.fromAny(value);
-    }
-};
-__decorate([
-    (0, ts_serval_1.serialize)(),
-    (0, ts_serval_1.validate)(),
-    __metadata("design:type", Boolean)
-], AttributeQuery.prototype, "onlyValid", void 0);
+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)
-], AttributeQuery.prototype, "attributeType", void 0);
+], AbstractAttributeQuery.prototype, "valueType", void 0);
 __decorate([
-    (0, ts_serval_1.serialize)({ type: String }),
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", transport_1.CoreDate)
+], AbstractAttributeQuery.prototype, "validFrom", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
     (0, ts_serval_1.validate)({ nullable: true }),
-    __metadata("design:type", Array)
-], AttributeQuery.prototype, "tags", void 0);
-AttributeQuery = __decorate([
-    (0, ts_serval_1.type)("AttributeQuery")
-], AttributeQuery);
-exports.AttributeQuery = AttributeQuery;
-//# sourceMappingURL=AttributeQuery.js.map
+    __metadata("design:type", transport_1.CoreDate)
+], AbstractAttributeQuery.prototype, "validTo", void 0);
+exports.AbstractAttributeQuery = AbstractAttributeQuery;
+//# sourceMappingURL=AbstractAttributeQuery.js.map

package/dist/attributes/AbstractAttributeQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractAttributeQuery.js","sourceRoot":"","sources":["../../src/attributes/AbstractAttributeQuery.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAwD;AACxD,gDAA2F;AAe3F,MAAsB,sBAAuB,SAAQ,4BAAgB;CAcpE;AATG;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;8BACV,oBAAQ;yDAAA;AAI3B;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACZ,oBAAQ;uDAAA;AAb7B,wDAcC"}

package/dist/attributes/AbstractAttributeValue.d.ts

@@ -1,9 +1,17 @@
 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";
+import { AbstractString } from "./types/AbstractString";
 export interface AbstractAttributeValueJSON extends ContentJSON, Record<string, unknown> {
 }
-export interface IAbstractAttributeValue extends ISerializable, Record<string, unknown> {
+export interface IAbstractAttributeValue extends ISerializable {
 }
 export declare abstract class AbstractAttributeValue extends Serializable implements IAbstractAttributeValue {
-    [key: string]: unknown;
+    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

@@ -3,6 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractAttributeValue = void 0;
 const ts_serval_1 = require("@js-soft/ts-serval");
 class AbstractAttributeValue extends ts_serval_1.Serializable {
+    static valueGenerator(v) {
+        return v.value;
+    }
+    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;AAOhE,MAAsB,sBAAuB,SAAQ,wBAAY;CAEhE;AAFD,wDAEC"}
+{"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/AbstractComplexValue.d.ts

@@ -0,0 +1,9 @@
+import { AbstractAttributeValue, AbstractAttributeValueJSON, IAbstractAttributeValue } from "./AbstractAttributeValue";
+import { RenderHints } from "./hints";
+export interface AbstractComplexValueJSON extends AbstractAttributeValueJSON {
+}
+export interface IAbstractComplexValue extends IAbstractAttributeValue {
+}
+export declare abstract class AbstractComplexValue extends AbstractAttributeValue implements IAbstractComplexValue {
+    static get renderHints(): RenderHints;
+}

package/dist/attributes/AbstractComplexValue.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractComplexValue = void 0;
+const AbstractAttributeValue_1 = require("./AbstractAttributeValue");
+const hints_1 = require("./hints");
+class AbstractComplexValue extends AbstractAttributeValue_1.AbstractAttributeValue {
+    static get renderHints() {
+        return hints_1.RenderHints.from({
+            technicalType: hints_1.RenderHintsTechnicalType.Object,
+            editType: hints_1.RenderHintsEditType.Complex
+        });
+    }
+}
+exports.AbstractComplexValue = AbstractComplexValue;
+//# sourceMappingURL=AbstractComplexValue.js.map

package/dist/attributes/AbstractComplexValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractComplexValue.js","sourceRoot":"","sources":["../../src/attributes/AbstractComplexValue.ts"],"names":[],"mappings":";;;AAAA,qEAAsH;AACtH,mCAAoF;AAMpF,MAAsB,oBAAqB,SAAQ,+CAAsB;IAC9D,MAAM,KAAK,WAAW;QACzB,OAAO,mBAAW,CAAC,IAAI,CAAC;YACpB,aAAa,EAAE,gCAAwB,CAAC,MAAM;YAC9C,QAAQ,EAAE,2BAAmB,CAAC,OAAO;SACxC,CAAC,CAAA;IACN,CAAC;CACJ;AAPD,oDAOC"}

package/dist/attributes/IdentityAttribute.d.ts

@@ -0,0 +1,16 @@
+import { AbstractAttribute, AbstractAttributeJSON, IAbstractAttribute } from "./AbstractAttribute";
+import { AbstractAttributeValue, AbstractAttributeValueJSON, IAbstractAttributeValue } from "./AbstractAttributeValue";
+export interface IdentityAttributeJSON<TValueJSONInterface extends AbstractAttributeValueJSON = AbstractAttributeValueJSON> extends AbstractAttributeJSON {
+    value: TValueJSONInterface;
+    tags?: string[];
+}
+export interface IIdentityAttribute<TValueInterface extends IAbstractAttributeValue = IAbstractAttributeValue> extends IAbstractAttribute {
+    value: TValueInterface;
+    tags?: string[];
+}
+export declare class IdentityAttribute<TValueClass extends AbstractAttributeValue = AbstractAttributeValue> extends AbstractAttribute implements IIdentityAttribute<TValueClass> {
+    value: TValueClass;
+    tags?: string[];
+    static from<TValueClass extends AbstractAttributeValue = AbstractAttributeValue, TValueInterface extends IAbstractAttributeValue = IAbstractAttributeValue, TValueJSONInterface extends AbstractAttributeValueJSON = AbstractAttributeValueJSON>(value: IIdentityAttribute<TValueInterface> | IdentityAttributeJSON<TValueJSONInterface>): IdentityAttribute<TValueClass>;
+    toJSON(): IdentityAttributeJSON;
+}

package/dist/attributes/IdentityAttribute.js

@@ -0,0 +1,38 @@
+"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.IdentityAttribute = void 0;
+const ts_serval_1 = require("@js-soft/ts-serval");
+const AbstractAttribute_1 = require("./AbstractAttribute");
+const AbstractAttributeValue_1 = require("./AbstractAttributeValue");
+let IdentityAttribute = class IdentityAttribute extends AbstractAttribute_1.AbstractAttribute {
+    static from(value) {
+        return this.fromAny(value);
+    }
+    toJSON() {
+        return super.toJSON();
+    }
+};
+__decorate([
+    (0, ts_serval_1.serialize)({ unionTypes: [AbstractAttributeValue_1.AbstractAttributeValue] }),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", Object)
+], IdentityAttribute.prototype, "value", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)({ type: String }),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", Array)
+], IdentityAttribute.prototype, "tags", void 0);
+IdentityAttribute = __decorate([
+    (0, ts_serval_1.type)("IdentityAttribute")
+], IdentityAttribute);
+exports.IdentityAttribute = IdentityAttribute;
+//# sourceMappingURL=IdentityAttribute.js.map

package/dist/attributes/IdentityAttribute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IdentityAttribute.js","sourceRoot":"","sources":["../../src/attributes/IdentityAttribute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA8D;AAC9D,2DAAkG;AAClG,qEAAsH;AAgBtH,IAAa,iBAAiB,GAA9B,MAAa,iBACT,SAAQ,qCAAiB;IAYlB,MAAM,CAAC,IAAI,CAKd,KAAuF;QAEvF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAmC,CAAA;IAChE,CAAC;IAEe,MAAM;QAClB,OAAO,KAAK,CAAC,MAAM,EAA2B,CAAA;IAClD,CAAC;CACJ,CAAA;AAnBG;IAFC,IAAA,qBAAS,EAAC,EAAE,UAAU,EAAE,CAAC,+CAAsB,CAAC,EAAE,CAAC;IACnD,IAAA,oBAAQ,GAAE;;gDACc;AAIzB;IAFC,IAAA,qBAAS,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC3B,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACP;AAXb,iBAAiB;IAD7B,IAAA,gBAAI,EAAC,mBAAmB,CAAC;GACb,iBAAiB,CA0B7B;AA1BY,8CAAiB"}

package/dist/attributes/IdentityAttributeQuery.d.ts

@@ -0,0 +1,12 @@
+import { AbstractAttributeQuery, AbstractAttributeQueryJSON, IAbstractAttributeQuery } from "./AbstractAttributeQuery";
+export interface IdentityAttributeQueryJSON extends AbstractAttributeQueryJSON {
+    tags?: string[];
+}
+export interface IIdentityAttributeQuery extends IAbstractAttributeQuery {
+    tags?: string[];
+}
+export declare class IdentityAttributeQuery extends AbstractAttributeQuery implements IIdentityAttributeQuery {
+    tags?: string[];
+    static from(value: IIdentityAttributeQuery | IdentityAttributeQueryJSON): IdentityAttributeQuery;
+    toJSON(): IdentityAttributeQueryJSON;
+}

package/dist/attributes/IdentityAttributeQuery.js

@@ -0,0 +1,32 @@
+"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.IdentityAttributeQuery = void 0;
+const ts_serval_1 = require("@js-soft/ts-serval");
+const AbstractAttributeQuery_1 = require("./AbstractAttributeQuery");
+let IdentityAttributeQuery = class IdentityAttributeQuery extends AbstractAttributeQuery_1.AbstractAttributeQuery {
+    static from(value) {
+        return this.fromAny(value);
+    }
+    toJSON() {
+        return super.toJSON();
+    }
+};
+__decorate([
+    (0, ts_serval_1.serialize)({ type: String }),
+    (0, ts_serval_1.validate)({ nullable: true }),
+    __metadata("design:type", Array)
+], IdentityAttributeQuery.prototype, "tags", void 0);
+IdentityAttributeQuery = __decorate([
+    (0, ts_serval_1.type)("IdentityAttributeQuery")
+], IdentityAttributeQuery);
+exports.IdentityAttributeQuery = IdentityAttributeQuery;
+//# sourceMappingURL=IdentityAttributeQuery.js.map

package/dist/attributes/IdentityAttributeQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IdentityAttributeQuery.js","sourceRoot":"","sources":["../../src/attributes/IdentityAttributeQuery.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA8D;AAC9D,qEAAsH;AAWtH,IAAa,sBAAsB,GAAnC,MAAa,sBAAuB,SAAQ,+CAAsB;IAKvD,MAAM,CAAC,IAAI,CAAC,KAA2D;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAEe,MAAM;QAClB,OAAO,KAAK,CAAC,MAAM,EAAgC,CAAA;IACvD,CAAC;CACJ,CAAA;AATG;IAFC,IAAA,qBAAS,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC3B,IAAA,oBAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACP;AAHb,sBAAsB;IADlC,IAAA,gBAAI,EAAC,wBAAwB,CAAC;GAClB,sBAAsB,CAYlC;AAZY,wDAAsB"}

package/dist/attributes/RelationshipAttribute.d.ts

@@ -0,0 +1,53 @@
+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;
+    protected static preFrom(value: any): any;
+    static from<TValueClass extends AbstractAttributeValue = AbstractAttributeValue, TValueInterface extends IAbstractAttributeValue = IAbstractAttributeValue, TValueJSONInterface extends AbstractAttributeValueJSON = AbstractAttributeValueJSON>(value: IRelationshipAttribute<TValueInterface> | RelationshipAttributeJSON<TValueJSONInterface>): RelationshipAttribute<TValueClass>;
+    toJSON(): RelationshipAttributeJSON;
+}

package/dist/attributes/RelationshipAttribute.js

@@ -0,0 +1,88 @@
+"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.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 {
+    static preFrom(value) {
+        if (typeof value.isTechnical === "undefined")
+            value.isTechnical = false;
+        return value;
+    }
+    static from(value) {
+        return this.fromAny(value);
+    }
+    toJSON() {
+        return super.toJSON();
+    }
+};
+__decorate([
+    (0, ts_serval_1.serialize)({ unionTypes: [AbstractAttributeValue_1.AbstractAttributeValue] }),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", Object)
+], RelationshipAttribute.prototype, "value", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (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)({ nullable: true }),
+    __metadata("design:type", Boolean)
+], 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);
+exports.RelationshipAttribute = RelationshipAttribute;
+//# sourceMappingURL=RelationshipAttribute.js.map

package/dist/attributes/RelationshipAttribute.js.map

@@ -0,0 +1 @@
+{"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;IAyBf,MAAM,CAAU,OAAO,CAAC,KAAU;QACxC,IAAI,OAAO,KAAK,CAAC,WAAW,KAAK,WAAW;YAAE,KAAK,CAAC,WAAW,GAAG,KAAK,CAAA;QAEvE,OAAO,KAAK,CAAA;IAChB,CAAC;IAEM,MAAM,CAAC,IAAI,CAKd,KAA+F;QAE/F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAuC,CAAA;IACpE,CAAC;IAEe,MAAM;QAClB,OAAO,KAAK,CAAC,MAAM,EAA+B,CAAA;IACtD,CAAC;CACJ,CAAA;AAtCG;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,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACF;AAS3B;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,CA6CjC;AA7CY,sDAAqB"}

package/dist/attributes/RelationshipAttributeQuery.d.ts

@@ -0,0 +1,23 @@
+import { CoreAddress, ICoreAddress } from "@nmshd/transport";
+import { AbstractAttributeQuery, AbstractAttributeQueryJSON, IAbstractAttributeQuery } from "./AbstractAttributeQuery";
+import { IRelationshipAttributeCreationHints, RelationshipAttributeCreationHints, RelationshipAttributeCreationHintsJSON } from "./hints/RelationshipAttributeCreationHints";
+export interface RelationshipAttributeQueryJSON extends AbstractAttributeQueryJSON {
+    key: string;
+    owner: string;
+    thirdParty?: string;
+    attributeCreationHints: RelationshipAttributeCreationHintsJSON;
+}
+export interface IRelationshipAttributeQuery extends IAbstractAttributeQuery {
+    key: string;
+    owner: ICoreAddress;
+    thirdParty?: ICoreAddress;
+    attributeCreationHints: IRelationshipAttributeCreationHints;
+}
+export declare class RelationshipAttributeQuery extends AbstractAttributeQuery implements IRelationshipAttributeQuery {
+    key: string;
+    owner: CoreAddress;
+    thirdParty?: CoreAddress;
+    attributeCreationHints: RelationshipAttributeCreationHints;
+    static from(value: IRelationshipAttributeQuery | RelationshipAttributeQueryJSON): RelationshipAttributeQuery;
+    toJSON(): RelationshipAttributeQueryJSON;
+}

package/dist/attributes/RelationshipAttributeQuery.js

@@ -0,0 +1,49 @@
+"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.RelationshipAttributeQuery = void 0;
+const ts_serval_1 = require("@js-soft/ts-serval");
+const transport_1 = require("@nmshd/transport");
+const AbstractAttributeQuery_1 = require("./AbstractAttributeQuery");
+const RelationshipAttributeCreationHints_1 = require("./hints/RelationshipAttributeCreationHints");
+let RelationshipAttributeQuery = class RelationshipAttributeQuery extends AbstractAttributeQuery_1.AbstractAttributeQuery {
+    static from(value) {
+        return this.fromAny(value);
+    }
+    toJSON() {
+        return super.toJSON();
+    }
+};
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", String)
+], RelationshipAttributeQuery.prototype, "key", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (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)({ nullable: true }),
+    __metadata("design:type", transport_1.CoreAddress)
+], RelationshipAttributeQuery.prototype, "thirdParty", void 0);
+__decorate([
+    (0, ts_serval_1.serialize)(),
+    (0, ts_serval_1.validate)(),
+    __metadata("design:type", RelationshipAttributeCreationHints_1.RelationshipAttributeCreationHints)
+], RelationshipAttributeQuery.prototype, "attributeCreationHints", void 0);
+RelationshipAttributeQuery = __decorate([
+    (0, ts_serval_1.type)("RelationshipAttributeQuery")
+], RelationshipAttributeQuery);
+exports.RelationshipAttributeQuery = RelationshipAttributeQuery;
+//# sourceMappingURL=RelationshipAttributeQuery.js.map

package/dist/attributes/RelationshipAttributeQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelationshipAttributeQuery.js","sourceRoot":"","sources":["../../src/attributes/RelationshipAttributeQuery.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA8D;AAC9D,gDAA4D;AAC5D,qEAAsH;AACtH,mGAImD;AAiBnD,IAAa,0BAA0B,GAAvC,MAAa,0BAA2B,SAAQ,+CAAsB;IAiB3D,MAAM,CAAC,IAAI,CACd,KAAmE;QAEnE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAEe,MAAM;QAClB,OAAO,KAAK,CAAC,MAAM,EAAoC,CAAA;IAC3D,CAAC;CACJ,CAAA;AAvBG;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,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACT,uBAAW;8DAAA;AAI/B;IAFC,IAAA,qBAAS,GAAE;IACX,IAAA,oBAAQ,GAAE;8BACoB,uEAAkC;0EAAA;AAfxD,0BAA0B;IADtC,IAAA,gBAAI,EAAC,4BAA4B,CAAC;GACtB,0BAA0B,CA0BtC;AA1BY,gEAA0B"}