@studyportals/crm-data-processor-interface 0.1.0 → 0.1.2

package/index.d.ts

@@ -4,4 +4,6 @@ import { ProductsResponseBody } from "./src/data/products-response-body";
 import { ProjectDetails } from "./src/data/project-details";
 import { ProjectDetailsResponseBody } from "./src/data/project-details-response-body";
 import { ProjectProduct } from "./src/data/project-product";
-export { CrmDataProcessorClient, ProductsResponseBody, ActProduct, ProjectDetailsResponseBody, ProjectDetails, ProjectProduct };
+import { ProjectProductState } from "./src/data/project-product-state";
+import { ProjectState } from "./src/data/project-state";
+export { CrmDataProcessorClient, ProductsResponseBody, ActProduct, ProjectDetailsResponseBody, ProjectDetails, ProjectProduct, ProjectState, ProjectProductState };

package/index.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CrmDataProcessorClient = void 0;
+exports.ProjectProductState = exports.ProjectState = exports.CrmDataProcessorClient = void 0;
 const crm_data_processor_client_1 = require("./src/clients/crm-data-processor-client");
 Object.defineProperty(exports, "CrmDataProcessorClient", { enumerable: true, get: function () { return crm_data_processor_client_1.CrmDataProcessorClient; } });
+const project_product_state_1 = require("./src/data/project-product-state");
+Object.defineProperty(exports, "ProjectProductState", { enumerable: true, get: function () { return project_product_state_1.ProjectProductState; } });
+const project_state_1 = require("./src/data/project-state");
+Object.defineProperty(exports, "ProjectState", { enumerable: true, get: function () { return project_state_1.ProjectState; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,uFAAiF;AAQhF,uGARQ,kDAAsB,OAQR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,uFAAiF;AAUhF,uGAVQ,kDAAsB,OAUR;AAJvB,4EAAuE;AActE,oGAdQ,2CAAmB,OAcR;AAbpB,4DAAwD;AAYvD,6FAZQ,4BAAY,OAYR"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/crm-data-processor-interface",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"scripts": {
 		"compile": "rm -fR dist && npx tsc",
 		"prepare-deployment": "npm run compile && cp package.json dist/package.json && rm -fR dist/tests",

package/src/clients/crm-data-processor-client.d.ts

@@ -4,7 +4,17 @@ export declare class CrmDataProcessorClient {
     private readonly baseUrl;
     private readonly jwtTokenProvider;
     constructor(baseUrl: string, jwtTokenProvider: () => Promise<string>);
+    /**
+     * Retrieves all the active ACT Products from the CRM Data Processor API.
+     *
+     * @returns Array of ACT Products objects
+     */
     retrieveActiveProducts(): Promise<ProductsResponseBody>;
+    /**
+     * Retrieves all the Project Details from the CRM Data Processor API.
+     *
+     * @returns Array of Project Details objects
+     */
     retrieveProjectDetails(): Promise<ProjectDetailsResponseBody>;
     private sendGetRequest;
 }

package/src/clients/crm-data-processor-client.js

@@ -8,11 +8,21 @@ class CrmDataProcessorClient {
         this.baseUrl = baseUrl;
         this.jwtTokenProvider = jwtTokenProvider;
     }
+    /**
+     * Retrieves all the active ACT Products from the CRM Data Processor API.
+     *
+     * @returns Array of ACT Products objects
+     */
     async retrieveActiveProducts() {
         const jwt = await this.jwtTokenProvider();
         const url = new URL(this.baseUrl + `/products/active`);
         return await this.sendGetRequest(url, jwt);
     }
+    /**
+     * Retrieves all the Project Details from the CRM Data Processor API.
+     *
+     * @returns Array of Project Details objects
+     */
     async retrieveProjectDetails() {
         const jwt = await this.jwtTokenProvider();
         const url = new URL(this.baseUrl + `/projects`);

package/src/clients/crm-data-processor-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"crm-data-processor-client.js","sourceRoot":"","sources":["../../../src/clients/crm-data-processor-client.ts"],"names":[],"mappings":";;;AAGA,MAAa,sBAAsB;IAGhB;IACA;IAFlB,YACkB,OAAe,EACf,gBAAuC;QADvC,YAAO,GAAP,OAAO,CAAQ;QACf,qBAAgB,GAAhB,gBAAgB,CAAuB;IACrD,CAAC;IAEE,KAAK,CAAC,sBAAsB;QAClC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,kBAAkB,CAAC,CAAC;QACvD,OAAO,MAAM,IAAI,CAAC,cAAc,CAAuB,GAAG,EAAE,GAAG,CAAC,CAAC;IAClE,CAAC;IAEM,KAAK,CAAC,sBAAsB;QAClC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,CAAC;QAChD,OAAO,MAAM,IAAI,CAAC,cAAc,CAA6B,GAAG,EAAE,GAAG,CAAC,CAAC;IACxE,CAAC;IAEO,KAAK,CAAC,cAAc,CAAI,GAAQ,EAAE,GAAW,EAAE,OAAgC;QACtF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YACjC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACR,eAAe,EAAE,GAAG;gBACpB,GAAG,OAAO;aACV;SACD,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YAClB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YACxD,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,gBAAgB,SAAS,CAAC,CAAC,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5I,CAAC;QAED,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAO,CAAC;IACnC,CAAC;CACD;AAnCD,wDAmCC"}
+{"version":3,"file":"crm-data-processor-client.js","sourceRoot":"","sources":["../../../src/clients/crm-data-processor-client.ts"],"names":[],"mappings":";;;AAGA,MAAa,sBAAsB;IAGhB;IACA;IAFlB,YACkB,OAAe,EACf,gBAAuC;QADvC,YAAO,GAAP,OAAO,CAAQ;QACf,qBAAgB,GAAhB,gBAAgB,CAAuB;IACrD,CAAC;IAEL;;;;OAIG;IACI,KAAK,CAAC,sBAAsB;QAClC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,kBAAkB,CAAC,CAAC;QACvD,OAAO,MAAM,IAAI,CAAC,cAAc,CAAuB,GAAG,EAAE,GAAG,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,sBAAsB;QAClC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,CAAC;QAChD,OAAO,MAAM,IAAI,CAAC,cAAc,CAA6B,GAAG,EAAE,GAAG,CAAC,CAAC;IACxE,CAAC;IAEO,KAAK,CAAC,cAAc,CAAI,GAAQ,EAAE,GAAW,EAAE,OAAgC;QACtF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YACjC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACR,eAAe,EAAE,GAAG;gBACpB,GAAG,OAAO;aACV;SACD,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YAClB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YACxD,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,gBAAgB,SAAS,CAAC,CAAC,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5I,CAAC;QAED,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAO,CAAC;IACnC,CAAC;CACD;AA7CD,wDA6CC"}

package/src/data/project-details.d.ts

@@ -1,3 +1,4 @@
+import { ProjectState } from "./project-state";
 import { ProjectProduct } from "./project-product";
 export type ProjectDetails = {
     invoiceNumber: number;
@@ -6,4 +7,5 @@ export type ProjectDetails = {
     projectAccount: string;
     projectOwner: string;
     products: ProjectProduct[];
+    projectState: typeof ProjectState[keyof typeof ProjectState];
 };

package/src/data/project-product-state.d.ts

@@ -0,0 +1,6 @@
+export declare const ProjectProductState: {
+    readonly Unprocessed: "UNPROCESSED";
+    readonly Scheduled: "SCHEDULED";
+    readonly Active: "ACTIVE";
+    readonly Archived: "ARCHIVED";
+};

package/src/data/project-product-state.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectProductState = void 0;
+/* eslint-disable @typescript-eslint/naming-convention */
+exports.ProjectProductState = {
+    Unprocessed: "UNPROCESSED",
+    Scheduled: "SCHEDULED",
+    Active: "ACTIVE",
+    Archived: "ARCHIVED"
+};
+//# sourceMappingURL=project-product-state.js.map

package/src/data/project-product-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-product-state.js","sourceRoot":"","sources":["../../../src/data/project-product-state.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AAC5C,QAAA,mBAAmB,GAAG;IAClC,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACX,CAAC"}

package/src/data/project-product.d.ts

@@ -1,7 +1,9 @@
+import { ProjectProductState } from "./project-product-state";
 export type ProjectProduct = {
     projectProductId: string;
     productNumber: string;
     productName: string;
     productStartDate: Date;
     productEndDate: Date;
+    productState: typeof ProjectProductState[keyof typeof ProjectProductState];
 };

package/src/data/project-state.d.ts

@@ -0,0 +1,4 @@
+export declare const ProjectState: {
+    readonly Unprocessed: "UNPROCESSED";
+    readonly Processed: "PROCESSED";
+};

package/src/data/project-state.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectState = void 0;
+/* eslint-disable @typescript-eslint/naming-convention */
+exports.ProjectState = {
+    Unprocessed: "UNPROCESSED",
+    Processed: "PROCESSED"
+};
+//# sourceMappingURL=project-state.js.map

package/src/data/project-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-state.js","sourceRoot":"","sources":["../../../src/data/project-state.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AAC5C,QAAA,YAAY,GAAG;IAC3B,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;CACb,CAAC"}