digicust_types 1.7.0 → 1.7.5

package/lib/models/rossum/rossum-document-data.model.d.ts

@@ -1,12 +1,12 @@
-export interface RossumDocumentDataModel {
-    id: number;
-    url: string;
-    s3_name: string;
-    mime_type: string;
-    arrived_at?: Date;
-    original_file_name: string;
-    content: string;
-    status: string;
-    time_spent: number;
-    metadata: any;
-}
+export interface RossumDocumentDataModel {
+    id: number;
+    url: string;
+    s3_name: string;
+    mime_type: string;
+    arrived_at?: Date;
+    original_file_name: string;
+    content: string;
+    status: string;
+    time_spent: number;
+    metadata: any;
+}

package/lib/models/rossum/rossum-document-data.model.js

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

package/lib/models/rossum/rossum-embedded-response.model.d.ts

@@ -1,3 +1,3 @@
-export interface RossumEmbeddedResponseModel {
-    url: string;
-}
+export interface RossumEmbeddedResponseModel {
+    url: string;
+}

package/lib/models/rossum/rossum-embedded-response.model.js

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

package/lib/models/rossum/rossum-import-status.enum.d.ts

@@ -1,14 +1,14 @@
-export declare enum RossumImportStatus {
-    Importing = "importing",
-    FailedImport = "failedimport",
-    ToReview = "to_review",
-    Reviewing = "reviewing",
-    Exporting = "exporting",
-    Exported = "exported",
-    FailedExport = "failed_export",
-    Postponed = "postponed",
-    Deleted = "deleted",
-    Purged = "purged",
-    Confirmed = "confirmed",
-    Split = "split"
-}
+export declare enum RossumImportStatus {
+    Importing = "importing",
+    FailedImport = "failedimport",
+    ToReview = "to_review",
+    Reviewing = "reviewing",
+    Exporting = "exporting",
+    Exported = "exported",
+    FailedExport = "failed_export",
+    Postponed = "postponed",
+    Deleted = "deleted",
+    Purged = "purged",
+    Confirmed = "confirmed",
+    Split = "split"
+}

package/lib/models/rossum/rossum-import-status.enum.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RossumImportStatus = void 0;
-var RossumImportStatus;
-(function (RossumImportStatus) {
-    RossumImportStatus["Importing"] = "importing";
-    RossumImportStatus["FailedImport"] = "failedimport";
-    RossumImportStatus["ToReview"] = "to_review";
-    RossumImportStatus["Reviewing"] = "reviewing";
-    RossumImportStatus["Exporting"] = "exporting";
-    RossumImportStatus["Exported"] = "exported";
-    RossumImportStatus["FailedExport"] = "failed_export";
-    RossumImportStatus["Postponed"] = "postponed";
-    RossumImportStatus["Deleted"] = "deleted";
-    RossumImportStatus["Purged"] = "purged";
-    RossumImportStatus["Confirmed"] = "confirmed";
-    RossumImportStatus["Split"] = "split";
-})(RossumImportStatus = exports.RossumImportStatus || (exports.RossumImportStatus = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RossumImportStatus = void 0;
+var RossumImportStatus;
+(function (RossumImportStatus) {
+    RossumImportStatus["Importing"] = "importing";
+    RossumImportStatus["FailedImport"] = "failedimport";
+    RossumImportStatus["ToReview"] = "to_review";
+    RossumImportStatus["Reviewing"] = "reviewing";
+    RossumImportStatus["Exporting"] = "exporting";
+    RossumImportStatus["Exported"] = "exported";
+    RossumImportStatus["FailedExport"] = "failed_export";
+    RossumImportStatus["Postponed"] = "postponed";
+    RossumImportStatus["Deleted"] = "deleted";
+    RossumImportStatus["Purged"] = "purged";
+    RossumImportStatus["Confirmed"] = "confirmed";
+    RossumImportStatus["Split"] = "split";
+})(RossumImportStatus = exports.RossumImportStatus || (exports.RossumImportStatus = {}));

package/lib/models/rossum/rossum-login-response.model.d.ts

@@ -1,3 +1,3 @@
-export interface RossumLoginResponseModel {
-    key: string;
-}
+export interface RossumLoginResponseModel {
+    key: string;
+}

package/lib/models/rossum/rossum-login-response.model.js

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

package/lib/models/rossum/rossum-paginated-annotations.model.d.ts

@@ -1,6 +1,6 @@
-import { RossumPaginationModel } from "./rossum-pagination.model";
-import { RossumAnnotationDataModel } from "./rossum-annotation-data.model";
-export interface RossumPaginatedAnnotations {
-    pagination: RossumPaginationModel;
-    results: RossumAnnotationDataModel[];
-}
+import { RossumPaginationModel } from "./rossum-pagination.model";
+import { RossumAnnotationDataModel } from "./rossum-annotation-data.model";
+export interface RossumPaginatedAnnotations {
+    pagination: RossumPaginationModel;
+    results: RossumAnnotationDataModel[];
+}

package/lib/models/rossum/rossum-paginated-annotations.model.js

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

package/lib/models/rossum/rossum-paginated-documents.model.d.ts

@@ -1,5 +1,5 @@
-import { RossumPaginationModel } from "./rossum-pagination.model";
-export interface RossumPaginatedDocuments {
-    pagination: RossumPaginationModel;
-    results: Document[];
-}
+import { RossumPaginationModel } from "./rossum-pagination.model";
+export interface RossumPaginatedDocuments {
+    pagination: RossumPaginationModel;
+    results: Document[];
+}

package/lib/models/rossum/rossum-paginated-documents.model.js

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

package/lib/models/rossum/rossum-pagination.model.d.ts

@@ -1,6 +1,6 @@
-export interface RossumPaginationModel {
-    total: number;
-    total_pages: number;
-    next: string;
-    previous: string;
-}
+export interface RossumPaginationModel {
+    total: number;
+    total_pages: number;
+    next: string;
+    previous: string;
+}

package/lib/models/rossum/rossum-pagination.model.js

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

package/lib/models/rossum/rossum-result-content.dto.d.ts

@@ -1,6 +1,6 @@
-import { RossumResultNodeDto } from "./rossum-result-node.dto";
-export interface RossumResultContentDto {
-    category: string;
-    schema_id: string;
-    children: Array<RossumResultNodeDto>;
-}
+import { RossumResultNodeDto } from "./rossum-result-node.dto";
+export interface RossumResultContentDto {
+    category: string;
+    schema_id: string;
+    children: Array<RossumResultNodeDto>;
+}

package/lib/models/rossum/rossum-result-content.dto.js

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

package/lib/models/rossum/rossum-result-node.dto.d.ts

@@ -1,13 +1,13 @@
-export interface RossumResultNodeDto {
-    id: string;
-    schema_id: string;
-    category: string;
-    children?: Array<RossumResultNodeDto>;
-    grid?: any;
-    type?: string;
-    value?: string;
-    page?: number;
-    position?: Array<number>;
-    rir_position?: Array<number>;
-    rir_confidence?: number;
-}
+export interface RossumResultNodeDto {
+    id: string;
+    schema_id: string;
+    category: string;
+    children?: Array<RossumResultNodeDto>;
+    grid?: any;
+    type?: string;
+    value?: string;
+    page?: number;
+    position?: Array<number>;
+    rir_position?: Array<number>;
+    rir_confidence?: number;
+}

package/lib/models/rossum/rossum-result-node.dto.js

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

package/lib/models/rossum/rossum-start-analyze.dto.d.ts

@@ -1,5 +1,5 @@
-export interface RossumStartAnalyzeDto {
-    userId: string;
-    caseId: string;
-    documentId: string;
-}
+export interface RossumStartAnalyzeDto {
+    userId: string;
+    caseId: string;
+    documentId: string;
+}

package/lib/models/rossum/rossum-start-analyze.dto.js

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

package/package.json

@@ -1,35 +1,35 @@
-{
-  "name": "digicust_types",
-  "version": "1.7.0",
-  "description": "",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "lib/**/*"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "build-deploy": "npm version patch && tsc && npm publish"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Digicust0406/types.git"
-  },
-  "keywords": [],
-  "author": "Thomas Übellacker",
-  "license": "Proprietary",
-  "bugs": {
-    "url": "https://github.com/Digicust0406/types/issues"
-  },
-  "homepage": "https://github.com/Digicust0406/types#readme",
-  "dependencies": {
-    "@types/node": "^14.17.15"
-  },
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.31.1",
-    "eslint": "^7.23.0",
-    "eslint-config-airbnb-typescript": "^12.3.1",
-    "eslint-plugin-import": "^2.24.2",
-    "typescript": "^4.4.3"
-  }
-}
+{
+  "name": "digicust_types",
+  "version": "1.7.5",
+  "description": "",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build-deploy": "npm version patch && tsc && npm publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Digicust0406/types.git"
+  },
+  "keywords": [],
+  "author": "Thomas Übellacker",
+  "license": "Proprietary",
+  "bugs": {
+    "url": "https://github.com/Digicust0406/types/issues"
+  },
+  "homepage": "https://github.com/Digicust0406/types#readme",
+  "dependencies": {
+    "@types/node": "^14.17.15"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^4.31.1",
+    "eslint": "^7.23.0",
+    "eslint-config-airbnb-typescript": "^12.3.1",
+    "eslint-plugin-import": "^2.24.2",
+    "typescript": "^4.4.3"
+  }
+}

package/readme.md

@@ -1,48 +1,48 @@
-# types package
-
-This package contains important types for communication with and within Digicust services, including:
-
-- message contracts for communication between services
-- common data types interfaces
-- digicust-specific data structures
-
-## Usage
-
-1. Install Digicust Types package using NPM
-
-```
-npm i digicust_types
-```
-
-2. Import your required interfaces using JavaScript's import module syntax
-
-```javascript
-import {
-  CaseModel,
-  CaseStatus,
-  UploadedFileModel,
-  StartDataExtractionDto,
-  DocumentStatus,
-} from "digicust_types"
-```
-
-## Interfaces
-
-We believe that the definition of the typescript interfaces are their best documentation themselves. Find all models here:
-
-- [General interfaces for data structures](./src/models/common/index.ts)
-- [Business-specific interfaces](./src/models/digicust/index.ts)
-- [Contracts for messages between services](./src/contracts/index.ts)
-
-## Development
-
-```
-tsc
-npm run git deploy
-```
-
-## Deployment
-
-```
-npm run build
-```
+# types package
+
+This package contains important types for communication with and within Digicust services, including:
+
+- message contracts for communication between services
+- common data types interfaces
+- digicust-specific data structures
+
+## Usage
+
+1. Install Digicust Types package using NPM
+
+```
+npm i digicust_types
+```
+
+2. Import your required interfaces using JavaScript's import module syntax
+
+```javascript
+import {
+  CaseModel,
+  CaseStatus,
+  UploadedFileModel,
+  StartDataExtractionDto,
+  DocumentStatus,
+} from "digicust_types"
+```
+
+## Interfaces
+
+We believe that the definition of the typescript interfaces are their best documentation themselves. Find all models here:
+
+- [General interfaces for data structures](./src/models/common/index.ts)
+- [Business-specific interfaces](./src/models/digicust/index.ts)
+- [Contracts for messages between services](./src/contracts/index.ts)
+
+## Development
+
+```
+tsc
+npm run git deploy
+```
+
+## Deployment
+
+```
+npm run build
+```

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/classification.model.d.ts

@@ -1,14 +0,0 @@
-import { Meta } from "../common";
-export interface Classification extends Meta<string> {
-    value?: string;
-    tariffNumberType?: "HS" | "NC" | "HTS" | "TARIC";
-    additionalCodes?: {
-        type: "AdditionalCode1" | "AdditionalCode2" | "AdditionalCode3" | "QuotaCode";
-        value?: string;
-    }[];
-    supplementaryUnits?: {
-        number?: string;
-        typeCode?: string;
-    };
-}
-export declare const condenseClassification: (classification: Classification) => Classification;

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

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.condenseClassification = void 0;
-var condenseClassification = function (classification) {
-    return {
-        value: classification.value,
-        tariffNumberType: classification.tariffNumberType,
-    };
-};
-exports.condenseClassification = condenseClassification;

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

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

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

@@ -1,22 +0,0 @@
-/**
- * Information about the submission at a customs authority
- */
-export interface CaseSubmissionModel {
-    id?: string;
-    accomplishedAt?: Date;
-    procedure?: CaseSubmissionProcedure;
-    /** Service that is responsible for this submission */
-    service?: string;
-    transactions?: {
-        dateTime?: Date;
-        /** Specifies which type of transaction it is (e.g. 'QuittungEingangsverarbeitung') */
-        transactionType?: string;
-        content?: any;
-    }[];
-}
-export declare enum CaseSubmissionProcedure {
-    VersandanmeldungNCTSDE = "VersandanmeldungNCTSDE",
-    EingangsanzeigeNCTSDE = "EingangsanzeigeNCTSDE",
-    FreierVerkehrAbfertigung = "FreierVerkehrAbfertigung",
-    ErgaenzendeAnmeldungFVAVUV = "ErgaenzendeAnmeldungFVAVUV"
-}

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

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CaseSubmissionProcedure = void 0;
-var CaseSubmissionProcedure;
-(function (CaseSubmissionProcedure) {
-    // NCTS DE
-    CaseSubmissionProcedure["VersandanmeldungNCTSDE"] = "VersandanmeldungNCTSDE";
-    CaseSubmissionProcedure["EingangsanzeigeNCTSDE"] = "EingangsanzeigeNCTSDE";
-    // Freier Verkehr
-    CaseSubmissionProcedure["FreierVerkehrAbfertigung"] = "FreierVerkehrAbfertigung";
-    CaseSubmissionProcedure["ErgaenzendeAnmeldungFVAVUV"] = "ErgaenzendeAnmeldungFVAVUV";
-})(CaseSubmissionProcedure = exports.CaseSubmissionProcedure || (exports.CaseSubmissionProcedure = {}));