@opensanctions/followthemoney 3.8.4

package/dist/entity.d.ts

@@ -0,0 +1,93 @@
+import { Schema } from './schema';
+import { Model } from './model';
+import { Property } from './property';
+import { PropertyType } from './type';
+export type Value = string | Entity;
+export type Values = Array<Value>;
+export type EntityProperties = {
+    [prop: string]: Array<Value | IEntityDatum>;
+};
+export interface IEntityDatum {
+    schema: Schema | string;
+    properties?: EntityProperties;
+    id: string;
+}
+/**
+ * An entity proxy which provides simplified access to the
+ * properties and schema associated with an entity.
+ */
+export declare class Entity {
+    id: string;
+    properties: Map<Property, Values>;
+    readonly schema: Schema;
+    constructor(model: Model, data: IEntityDatum);
+    setProperty(prop: string | Property, value: Value | IEntityDatum | undefined | null): Values;
+    hasProperty(prop: string | Property): boolean;
+    getProperty(prop: string | Property): Values;
+    /**
+     * The first value of a property only.
+     *
+     * @param prop A property name or object
+     */
+    getFirst(prop: string | Property): Value | null;
+    /**
+     * List all properties for which this entity has values set. This
+     * does not include unset properties.
+     */
+    getProperties(): Array<Property>;
+    /**
+     * Copy the properties from a given entity that match the local
+     * schema to this entity.
+     */
+    copyProperties(entity: Entity): void;
+    /**
+     * Get the designated label for the given entity.
+     */
+    getCaption(): string;
+    /**
+     * Set the designated label as the first caption prop for the given entity.
+     */
+    setCaption(value: string): void;
+    /**
+     * Get the designated label for the given entity.
+     */
+    getEdgeCaption(): string;
+    /**
+     * Get a date that can be used to represent the start of the entity in a timeline.
+     * If there are multiple possible dates, the earliest date is returned.
+     */
+    getTemporalStart(): {
+        property: Property;
+        value: string;
+    } | null;
+    /**
+     * Get a date that can be used to represent the end of the entity in a timeline.
+     * If there are multiple possible dates, the earliest date is returned.
+     */
+    getTemporalEnd(): {
+        property: Property;
+        value: string;
+    } | null;
+    /**
+     * Get all the values of a particular type, irrespective of
+     * which property it is associated with.
+     */
+    getTypeValues(type: string | PropertyType, matchableOnly?: boolean): Values;
+    /**
+     * Serialise the entity to a plain JSON object, suitable for feeding to the
+     * JSON.stringify() call.
+     */
+    toJSON(): IEntityDatum;
+    /**
+     * Make a copy of the entity with no shared object identity.
+     */
+    clone(): Entity;
+    /**
+     * Shortcut helper function.
+     *
+     * @param model active FollowTheMoney model
+     * @param data the raw blob, which must match IEntityDatum
+     */
+    static fromJSON(model: Model, data: any): Entity;
+    static isEntity(value: Value): boolean;
+}

package/dist/entity.js

@@ -0,0 +1,213 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Entity = void 0;
+/**
+ * An entity proxy which provides simplified access to the
+ * properties and schema associated with an entity.
+ */
+class Entity {
+    constructor(model, data) {
+        this.properties = new Map();
+        this.schema = model.getSchema(data.schema);
+        this.id = data.id;
+        if (data.properties) {
+            Object.entries(data.properties).forEach(([prop, values]) => {
+                values.forEach((value) => {
+                    this.setProperty(prop, value);
+                });
+            });
+        }
+    }
+    setProperty(prop, value) {
+        const property = this.schema.getProperty(prop);
+        const values = this.properties.get(property) || [];
+        if (value === undefined || value === null) {
+            return values;
+        }
+        if (typeof (value) === 'string' && value.trim().length === 0) {
+            return values;
+        }
+        if (typeof (value) !== 'string') {
+            value = this.schema.model.getEntity(value);
+        }
+        values.push(value);
+        this.properties.set(property, values);
+        return values;
+    }
+    hasProperty(prop) {
+        try {
+            const property = this.schema.getProperty(prop);
+            return this.properties.has(property);
+        }
+        catch (_a) {
+            return false;
+        }
+    }
+    getProperty(prop) {
+        try {
+            const property = this.schema.getProperty(prop);
+            if (!this.properties.has(property)) {
+                return [];
+            }
+            return this.properties.get(property);
+        }
+        catch (_a) {
+            return [];
+        }
+    }
+    /**
+     * The first value of a property only.
+     *
+     * @param prop A property name or object
+     */
+    getFirst(prop) {
+        for (const value of this.getProperty(prop)) {
+            return value;
+        }
+        return null;
+    }
+    /**
+     * List all properties for which this entity has values set. This
+     * does not include unset properties.
+     */
+    getProperties() {
+        return Array.from(this.properties.keys());
+    }
+    /**
+     * Copy the properties from a given entity that match the local
+     * schema to this entity.
+     */
+    copyProperties(entity) {
+        entity.getProperties().forEach((prop) => {
+            if (this.schema.hasProperty(prop)) {
+                const localProp = this.schema.getProperty(prop.name);
+                if (localProp.qname === prop.qname) {
+                    entity.getProperty(prop).forEach((value) => {
+                        this.setProperty(localProp, value);
+                    });
+                }
+            }
+        });
+    }
+    /**
+     * Get the designated label for the given entity.
+     */
+    getCaption() {
+        for (const property of this.schema.caption) {
+            for (const value of this.getProperty(property)) {
+                return value;
+            }
+        }
+        return this.schema.label;
+    }
+    /**
+     * Set the designated label as the first caption prop for the given entity.
+     */
+    setCaption(value) {
+        const captionProperties = this.schema.caption;
+        if (captionProperties && captionProperties.length > 0) {
+            this.setProperty(captionProperties[0], value);
+        }
+    }
+    /**
+     * Get the designated label for the given entity.
+     */
+    getEdgeCaption() {
+        const captions = this.schema.edge ? this.schema.edge.caption : [];
+        for (const property of captions) {
+            for (const value of this.getProperty(property)) {
+                return value;
+            }
+        }
+        return this.schema.label;
+    }
+    /**
+     * Get a date that can be used to represent the start of the entity in a timeline.
+     * If there are multiple possible dates, the earliest date is returned.
+     */
+    getTemporalStart() {
+        const values = [];
+        const properties = this.schema.getTemporalStartProperties();
+        for (const property of properties) {
+            for (const value of this.getProperty(property)) {
+                if (typeof value === 'string') {
+                    values.push({ property, value });
+                }
+            }
+        }
+        const sortedValues = values.sort((a, b) => a.value < b.value ? -1 : 1);
+        return sortedValues[0] || null;
+    }
+    /**
+     * Get a date that can be used to represent the end of the entity in a timeline.
+     * If there are multiple possible dates, the earliest date is returned.
+     */
+    getTemporalEnd() {
+        const values = [];
+        const properties = this.schema.getTemporalEndProperties();
+        for (const property of properties) {
+            for (const value of this.getProperty(property)) {
+                if (typeof value === 'string') {
+                    values.push({ property, value });
+                }
+            }
+        }
+        const sortedValues = values.sort((a, b) => b.value < a.value ? -1 : 1);
+        return sortedValues[0] || null;
+    }
+    /**
+     * Get all the values of a particular type, irrespective of
+     * which property it is associated with.
+     */
+    getTypeValues(type, matchableOnly = false) {
+        const propType = this.schema.model.getType(type);
+        const values = new Array();
+        for (const property of this.getProperties()) {
+            if (!matchableOnly || property.matchable) {
+                if (property.type.toString() === propType.toString()) {
+                    for (const value of this.getProperty(property)) {
+                        if (values.indexOf(value) === -1) {
+                            values.push(value);
+                        }
+                    }
+                }
+            }
+        }
+        return values;
+    }
+    /**
+     * Serialise the entity to a plain JSON object, suitable for feeding to the
+     * JSON.stringify() call.
+     */
+    toJSON() {
+        const properties = {};
+        this.properties.forEach((values, prop) => {
+            properties[prop.name] = values.map((value) => Entity.isEntity(value) ? value.toJSON() : value);
+        });
+        return {
+            id: this.id,
+            schema: this.schema.name,
+            properties: properties
+        };
+    }
+    /**
+     * Make a copy of the entity with no shared object identity.
+     */
+    clone() {
+        return Entity.fromJSON(this.schema.model, this.toJSON());
+    }
+    /**
+     * Shortcut helper function.
+     *
+     * @param model active FollowTheMoney model
+     * @param data the raw blob, which must match IEntityDatum
+     */
+    static fromJSON(model, data) {
+        return model.getEntity(data);
+    }
+    static isEntity(value) {
+        return typeof (value) !== 'string';
+    }
+}
+exports.Entity = Entity;
+//# sourceMappingURL=entity.js.map

package/dist/entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.js","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":";;;AAeA;;;GAGG;AACH,MAAa,MAAM;IAKjB,YAAY,KAAY,EAAE,IAAkB;QAHrC,eAAU,GAA0B,IAAI,GAAG,EAAE,CAAA;QAIlD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC1C,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;QAEjB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;gBACzD,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBACvB,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;gBAC/B,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,WAAW,CAAC,IAAuB,EAAE,KAA8C;QACjF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;QAClD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC1C,OAAO,MAAM,CAAA;QACf,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7D,OAAO,MAAM,CAAA;QACf,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;YAChC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;QAC5C,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAClB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QACrC,OAAO,MAAM,CAAA;IACf,CAAC;IAED,WAAW,CAAC,IAAuB;QACjC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;YAC9C,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACtC,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,WAAW,CAAC,IAAuB;QACjC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;YAC9C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACnC,OAAO,EAAE,CAAA;YACX,CAAC;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAW,CAAA;QAChD,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,EAAE,CAAA;QACX,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAuB;QAC9B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,OAAO,KAAK,CAAA;QACd,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,MAAc;QAC3B,MAAM,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACtC,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACpD,IAAI,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;oBACnC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;wBACzC,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;oBACpC,CAAC,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,UAAU;QACR,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YAC3C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/C,OAAO,KAAe,CAAA;YACxB,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAAa;QACtB,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAA;QAC7C,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;QAC/C,CAAC;IACH,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;QACjE,KAAK,MAAM,QAAQ,IAAI,QAAQ,EAAE,CAAC;YAChC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/C,OAAO,KAAe,CAAA;YACxB,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;IAC1B,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,MAAM,MAAM,GAAG,EAAE,CAAA;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAA;QAE3D,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC9B,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAA;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAC9B,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACrC,CAAA;QAED,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;IAChC,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,MAAM,MAAM,GAAG,EAAE,CAAA;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,wBAAwB,EAAE,CAAA;QAEzD,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC9B,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAA;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAC9B,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACrC,CAAA;QAED,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;IAChC,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,IAA2B,EAAE,aAAa,GAAG,KAAK;QAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAChD,MAAM,MAAM,GAAG,IAAI,KAAK,EAAS,CAAA;QACjC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YAC5C,IAAI,CAAC,aAAa,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;gBACzC,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC;oBACrD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC/C,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;4BACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;wBACpB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,MAAM,UAAU,GAAqB,EAAE,CAAA;QACvC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;YACvC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3C,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,KAAgB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,CAC5D,CAAA;QACH,CAAC,CAAC,CAAA;QACF,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACxB,UAAU,EAAE,UAAU;SACvB,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IAC1D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAY,EAAE,IAAS;QACrC,OAAO,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,KAAY;QAC1B,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAA;IACpC,CAAC;CACF;AAzOD,wBAyOC"}

package/dist/followthemoney.d.ts

@@ -0,0 +1,9 @@
+export * from './entity';
+export * from './model';
+export * from './namespace';
+export * from './property';
+export * from './schema';
+export * from './type';
+export * from './icons';
+import { IModelDatum } from './model';
+export declare const defaultModel: IModelDatum;