digicust_types 1.7.101 → 1.7.105

package/lib/models/common/company.model.d.ts

@@ -1,6 +1,7 @@
 import { AddressModel } from "./address.model";
 import { PersonModel } from "./person.model";
 import { Meta } from "./meta";
+import { MatchingMetadataModel, StakeholderMatchingMethod } from '../digicust/masterdata';
 /**
  * Identifies a company
  */
@@ -16,4 +17,5 @@ export interface CompanyModel extends Meta<string> {
     inputTaxDeduction?: Meta<boolean>;
     securityNumber?: Meta<string>;
     stakeholderId?: string;
+    matchingMetadata?: MatchingMetadataModel<StakeholderMatchingMethod>;
 }

package/lib/models/common/meta.d.ts

@@ -1,5 +1,5 @@
 import { Bbox } from "./bbox.model";
-import { Workflow } from './workflow';
+import { Workflow } from "./workflow";
 /**
  * Encapsulates typed und untyped workflow metadata for case properties
  */
@@ -21,11 +21,8 @@ export interface Meta<T> extends Workflow<T> {
     reviewNeeded?: boolean;
     display?: boolean;
     required?: boolean;
-    problems?: {
-        title?: string;
-        message?: string;
-        severity?: "error" | "warning" | "info";
-    }[];
+    /** could be validation errors */
+    errors?: Error[];
 }
 export declare const condenseMeta: <T>(meta: Meta<T>, valueOnly?: boolean | undefined) => {
     value: T | undefined;

package/lib/models/common/meta.js

@@ -2,12 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.condenseMeta = void 0;
 var condenseMeta = function (meta, valueOnly) {
-    return !valueOnly ? {
-        value: meta.value,
-        confidence: meta.confidence,
-        reviewNeeded: meta.reviewNeeded
-    } : {
-        value: meta.value
-    };
+    return !valueOnly
+        ? {
+            value: meta.value,
+            confidence: meta.confidence,
+            reviewNeeded: meta.reviewNeeded,
+        }
+        : {
+            value: meta.value,
+        };
 };
 exports.condenseMeta = condenseMeta;

package/lib/models/digicust/case.model.d.ts

@@ -33,6 +33,7 @@ export interface CaseModel {
      * Each item could only exist in condensed form
      */
     documents?: DigicustDocumentModel[];
+    /** Case level errors (property level errors are stored in property) */
     errors?: Array<Error>;
     /** Original, uploaded files  */
     uploadedFiles?: Array<UploadedFileModel>;

package/lib/models/digicust/digicust-document.model.d.ts

@@ -1,6 +1,7 @@
 import { ClassificationStatus, DigicustDocumentType, DocumentCode, DocumentStatus, SubDocumentStatus, UserDocumentStatus } from ".";
 import { DateTimeModel, RossumImportStatus } from "..";
 import { AnalyzerMetadataModel } from "./AnalyzerMetadataModel.model";
+import { ProcessingModel } from "./extractions/extraction.model";
 /**
  * Base model for different types of documents (e.g. waybills, invoices, ...)
  */
@@ -18,6 +19,7 @@ export interface DigicustDocumentModel {
     userDocumentStatus?: UserDocumentStatus;
     subDocumentStatus?: SubDocumentStatus;
     classificationStatus?: ClassificationStatus;
+    processing?: ProcessingModel;
     receivedAt?: Date;
     code?: string;
     reference?: string;

package/lib/models/digicust/errors.model.d.ts

@@ -1,7 +1,8 @@
 export interface ValidationError extends Error {
     type: "ValidationError";
-    field: string;
-    expected: any;
-    actual: any;
-    reference: string;
+    severity?: "error" | "warning" | "info";
+    field?: string;
+    expected?: any;
+    actual?: any;
+    reference?: string;
 }

package/lib/models/digicust/extractions/extraction.model.d.ts

@@ -34,9 +34,9 @@ export interface Extraction {
     queueId?: string;
     isLoading?: boolean;
 }
-interface ProcessingModel {
+export interface ProcessingModel {
     status?: "done" | "inprocess" | "error";
-    percentage?: string;
+    percentage?: number;
     date?: Date;
     errorMessage?: string;
 }
@@ -63,4 +63,3 @@ export interface ExtractionPage {
     /** label of classification */
     label?: string;
 }
-export {};

package/lib/models/digicust/masterdata/index.d.ts

@@ -2,3 +2,6 @@ export * from "./material.model";
 export * from "./stakeholder.model";
 export * from "./stakeholder-role.enum";
 export * from "./user-edited-properties.type";
+export * from "./matching-metadata.model";
+export * from "./scoring-algorithm-type.enum";
+export * from "./stakeholder-matching-method.enum";

package/lib/models/digicust/masterdata/index.js

@@ -14,3 +14,6 @@ __exportStar(require("./material.model"), exports);
 __exportStar(require("./stakeholder.model"), exports);
 __exportStar(require("./stakeholder-role.enum"), exports);
 __exportStar(require("./user-edited-properties.type"), exports);
+__exportStar(require("./matching-metadata.model"), exports);
+__exportStar(require("./scoring-algorithm-type.enum"), exports);
+__exportStar(require("./stakeholder-matching-method.enum"), exports);

package/lib/models/digicust/masterdata/matching-metadata.model.d.ts

@@ -0,0 +1,11 @@
+import { ScoringAlgorithmType } from './scoring-algorithm-type.enum';
+export interface MatchingMetadataModel<T> {
+    method: T;
+    input: {
+        [key: string]: string;
+    };
+    scoringAlgorithm: ScoringAlgorithmType;
+    scoringResult: {
+        [key: string]: number;
+    };
+}

package/lib/models/digicust/masterdata/scoring-algorithm-type.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum ScoringAlgorithmType {
+    Exact = "exact",
+    JaroWrinkler = "jaro-wrinkler",
+    CosineSimilarity = "cosine-similarity"
+}

package/lib/models/digicust/masterdata/scoring-algorithm-type.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScoringAlgorithmType = void 0;
+var ScoringAlgorithmType;
+(function (ScoringAlgorithmType) {
+    ScoringAlgorithmType["Exact"] = "exact";
+    ScoringAlgorithmType["JaroWrinkler"] = "jaro-wrinkler";
+    ScoringAlgorithmType["CosineSimilarity"] = "cosine-similarity";
+})(ScoringAlgorithmType = exports.ScoringAlgorithmType || (exports.ScoringAlgorithmType = {}));

package/lib/models/digicust/masterdata/stakeholder-matching-method.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum StakeholderMatchingMethod {
+    Unknown = 0,
+    EORI = 1,
+    VAT = 2,
+    NameAndCountry = 4,
+    FuzzyNameAndAddress = 8
+}

package/lib/models/digicust/masterdata/stakeholder-matching-method.enum.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StakeholderMatchingMethod = void 0;
+var StakeholderMatchingMethod;
+(function (StakeholderMatchingMethod) {
+    StakeholderMatchingMethod[StakeholderMatchingMethod["Unknown"] = 0] = "Unknown";
+    StakeholderMatchingMethod[StakeholderMatchingMethod["EORI"] = 1] = "EORI";
+    StakeholderMatchingMethod[StakeholderMatchingMethod["VAT"] = 2] = "VAT";
+    StakeholderMatchingMethod[StakeholderMatchingMethod["NameAndCountry"] = 4] = "NameAndCountry";
+    StakeholderMatchingMethod[StakeholderMatchingMethod["FuzzyNameAndAddress"] = 8] = "FuzzyNameAndAddress";
+})(StakeholderMatchingMethod = exports.StakeholderMatchingMethod || (exports.StakeholderMatchingMethod = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "digicust_types",
-  "version": "1.7.101",
+  "version": "1.7.105",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/lib/contracts/start-hs-classification.dto.d.ts

@@ -1,3 +0,0 @@
-export interface StartHsClassificationDto {
-    caseId: string;
-}

package/lib/models/common/checkpoint.model.d.ts

@@ -1,21 +0,0 @@
-export interface Checkpoint {
-    id?: string;
-    customerId?: string;
-    context?: string;
-    type?: "webhook" | "email";
-}
-export declare enum CheckPointType {
-    webhook = "webhook",
-    mail = "email"
-}
-export interface WebhookCheckpoint extends Checkpoint {
-    type: "webhook";
-    url?: string;
-    method?: "GET" | "POST" | "PATCH" | "DELETE" | "PUT";
-    body?: any;
-}
-export interface EmailCheckpoint extends Checkpoint {
-    type: "email";
-    emailAddress?: string;
-    body?: any;
-}

package/lib/models/common/checkpoint.model.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CheckPointType = void 0;
-var CheckPointType;
-(function (CheckPointType) {
-    CheckPointType["webhook"] = "webhook";
-    CheckPointType["mail"] = "email";
-})(CheckPointType = exports.CheckPointType || (exports.CheckPointType = {}));

package/lib/models/common/country.model.d.ts

@@ -1,4 +0,0 @@
-import { FuzzyInput } from "./fuzzy-input";
-export interface CountryModel extends FuzzyInput<string> {
-    isoCode?: string;
-}

package/lib/models/common/country.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/common/event.model.d.ts

@@ -1,21 +0,0 @@
-export interface Event {
-    id?: string;
-    customerId?: string;
-    context?: string;
-    type?: "webhook" | "email";
-}
-export declare enum EventType {
-    webhook = "webhook",
-    mail = "email"
-}
-export interface WebhookEvent extends Event {
-    type: "webhook";
-    url?: string;
-    method?: "GET" | "POST" | "PATCH" | "DELETE" | "PUT";
-    body?: any;
-}
-export interface EmailEvent extends Event {
-    type: "email";
-    emailAddress?: string;
-    body?: any;
-}

package/lib/models/common/event.model.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventType = void 0;
-var EventType;
-(function (EventType) {
-    EventType["webhook"] = "webhook";
-    EventType["mail"] = "email";
-})(EventType = exports.EventType || (exports.EventType = {}));

package/lib/models/common/super.d.ts

@@ -1,7 +0,0 @@
-export interface Super<T> {
-    value: T;
-    options?: T[];
-    lastChangedBy: String;
-    modifiedAt: Date;
-    source: String;
-}

package/lib/models/common/super.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/QueueWorkspaceModel.model.d.ts

@@ -1,12 +0,0 @@
-export interface WorkspaceQueues {
-    QueueId?: string;
-    name?: string;
-    QueueDocumentType?: string;
-    active?: boolean;
-}
-export interface QueueWorkspaceModel {
-    id?: string;
-    name?: string;
-    active?: boolean;
-    queues?: WorkspaceQueues[];
-}

package/lib/models/digicust/QueueWorkspaceModel.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/activity.mode.d.ts

@@ -1,18 +0,0 @@
-import { Money } from "../common";
-/**
- * Used to document usage of the service. Every activity can be tracked using this interface
- */
-export interface Activity {
-    id?: string;
-    customerId?: string;
-    projectId?: string;
-    userId?: string;
-    /** An identifier of this type of activity */
-    activityName?: string;
-    description?: string;
-    timestamp?: Date;
-    caseId?: string;
-    subscriptionId?: string;
-    paid?: boolean;
-    extraCosts?: Money;
-}

package/lib/models/digicust/activity.mode.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/company.model.d.ts

@@ -1,4 +0,0 @@
-export interface CompanyModel {
-    name?: string;
-    apiKey: string;
-}

package/lib/models/digicust/company.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/incoterm.enum.d.ts

@@ -1,17 +0,0 @@
-/**
- * Incoterms give information on transport conditions in international trade
- */
-export declare enum Incoterm {
-    EXW = "EXW",
-    FAS = "FAS",
-    FCA = "FCA",
-    FOB = "FOB",
-    CFR = "CFR",
-    CIF = "CIF",
-    CIP = "CIP",
-    CPT = "CPT",
-    DAP = "DAP",
-    DPU = "DPU",
-    DAT = "DAT",
-    DDP = "DDP"
-}

package/lib/models/digicust/incoterm.enum.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Incoterm = void 0;
-/**
- * Incoterms give information on transport conditions in international trade
- */
-var Incoterm;
-(function (Incoterm) {
-    Incoterm["EXW"] = "EXW";
-    Incoterm["FAS"] = "FAS";
-    Incoterm["FCA"] = "FCA";
-    Incoterm["FOB"] = "FOB";
-    Incoterm["CFR"] = "CFR";
-    Incoterm["CIF"] = "CIF";
-    Incoterm["CIP"] = "CIP";
-    Incoterm["CPT"] = "CPT";
-    Incoterm["DAP"] = "DAP";
-    Incoterm["DPU"] = "DPU";
-    Incoterm["DAT"] = "DAT";
-    Incoterm["DDP"] = "DDP";
-})(Incoterm = exports.Incoterm || (exports.Incoterm = {}));

package/lib/models/digicust/masterdata/stakeholder-type.enum.d.ts

@@ -1,12 +0,0 @@
-export declare enum StakeholderType {
-    Shipper = "shipper",
-    Recipient = "recipient",
-    Consignee = "consignee",
-    Importer = "importer",
-    Declarant = "declarant",
-    Agent = "agent",
-    Broker = "broker",
-    Buyer = "buyer",
-    Carrier = "carrier",
-    Warehouse = "warehouse"
-}

package/lib/models/digicust/masterdata/stakeholder-type.enum.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StakeholderType = void 0;
-var StakeholderType;
-(function (StakeholderType) {
-    StakeholderType["Shipper"] = "shipper";
-    StakeholderType["Recipient"] = "recipient";
-    StakeholderType["Consignee"] = "consignee";
-    StakeholderType["Importer"] = "importer";
-    StakeholderType["Declarant"] = "declarant";
-    StakeholderType["Agent"] = "agent";
-    StakeholderType["Broker"] = "broker";
-    StakeholderType["Buyer"] = "buyer";
-    StakeholderType["Carrier"] = "carrier";
-    StakeholderType["Warehouse"] = "warehouse";
-})(StakeholderType = exports.StakeholderType || (exports.StakeholderType = {}));

package/lib/models/digicust/notification.model.d.ts

@@ -1,13 +0,0 @@
-/**
- * Information about a notification Model
- */
-export interface NotificationsModel {
-    id?: string;
-    title?: string;
-    status?: string;
-    message?: string;
-    link?: string;
-    consumer?: string;
-    addresseeType?: "customer" | "project" | "user";
-    addresseeId?: string;
-}

package/lib/models/digicust/notification.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/shipping-type.model.d.ts

@@ -1,25 +0,0 @@
-import { Meta } from "../common";
-export interface ShippingType extends Meta<ShippingMode> {
-    /** unique identifier of the transportation mean */
-    code?: string;
-    name?: string;
-    type?: ShippingTypePlace;
-    /** ISO Code of nationality of the mean */
-    countryCode?: string;
-}
-export declare enum ShippingMode {
-    maritime = "Maritime",
-    rail = "Rail",
-    road = "Road",
-    air = "Air",
-    postal = "Postal",
-    fixedInstallations = "FixedInstallations",
-    inlandWaterway = "InlandWaterway",
-    unknown = "Unknown"
-}
-export declare enum ShippingTypePlace {
-    border = "Border",
-    arrival = "Arrival",
-    departure = "Departure",
-    inland = "Inland"
-}

package/lib/models/digicust/shipping-type.model.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShippingTypePlace = exports.ShippingMode = void 0;
-var ShippingMode;
-(function (ShippingMode) {
-    ShippingMode["maritime"] = "Maritime";
-    ShippingMode["rail"] = "Rail";
-    ShippingMode["road"] = "Road";
-    ShippingMode["air"] = "Air";
-    ShippingMode["postal"] = "Postal";
-    ShippingMode["fixedInstallations"] = "FixedInstallations";
-    ShippingMode["inlandWaterway"] = "InlandWaterway";
-    ShippingMode["unknown"] = "Unknown";
-})(ShippingMode = exports.ShippingMode || (exports.ShippingMode = {}));
-var ShippingTypePlace;
-(function (ShippingTypePlace) {
-    ShippingTypePlace["border"] = "Border";
-    ShippingTypePlace["arrival"] = "Arrival";
-    ShippingTypePlace["departure"] = "Departure";
-    ShippingTypePlace["inland"] = "Inland";
-})(ShippingTypePlace = exports.ShippingTypePlace || (exports.ShippingTypePlace = {}));

package/lib/models/digicust/submission-case-model.d.ts

@@ -1,8 +0,0 @@
-import { Meta } from "../common";
-/**
- * Information about the submission at a customs authority
- */
-export interface CaseSubmissionModel {
-    mrnNumber?: Meta<string>;
-    accomplishedAt?: Date;
-}

package/lib/models/digicust/submission-case-model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });