@studyportals/crm-data-processor-interface 0.1.1 → 0.1.3

package/index.d.ts

@@ -5,5 +5,7 @@ import { ProjectDetails } from "./src/data/project-details";
 import { ProjectDetailsResponseBody } from "./src/data/project-details-response-body";
 import { ProjectProduct } from "./src/data/project-product";
 import { ProjectProductState } from "./src/data/project-product-state";
+import { ProjectProductStateType } from "./src/data/project-product-state-type";
 import { ProjectState } from "./src/data/project-state";
-export { CrmDataProcessorClient, ProductsResponseBody, ActProduct, ProjectDetailsResponseBody, ProjectDetails, ProjectProduct, ProjectState, ProjectProductState };
+import { ProjectStateType } from "./src/data/project-state-type";
+export { CrmDataProcessorClient, ProductsResponseBody, ActProduct, ProjectDetailsResponseBody, ProjectDetails, ProjectProduct, ProjectState, ProjectStateType, ProjectProductState, ProjectProductStateType };

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,uFAAiF;AAUhF,uGAVQ,kDAAsB,OAUR;AAJvB,4EAAuE;AAcnE,oGAdK,2CAAmB,OAcL;AAbvB,4DAAwD;AAYpD,6FAZK,4BAAY,OAYL"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,uFAAiF;AAYhF,uGAZQ,kDAAsB,OAYR;AANvB,4EAAuE;AAiBtE,oGAjBQ,2CAAmB,OAiBR;AAfpB,4DAAwD;AAavD,6FAbQ,4BAAY,OAaR"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/crm-data-processor-interface",
-	"version": "0.1.1",
+	"version": "0.1.3",
 	"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,5 +1,5 @@
-import { ProjectState } from "./project-state";
 import { ProjectProduct } from "./project-product";
+import { ProjectStateType } from "./project-state-type";
 export type ProjectDetails = {
     invoiceNumber: number;
     projectNumber: number;
@@ -7,5 +7,5 @@ export type ProjectDetails = {
     projectAccount: string;
     projectOwner: string;
     products: ProjectProduct[];
-    projectState: typeof ProjectState[keyof typeof ProjectState];
+    projectState: ProjectStateType;
 };

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

@@ -0,0 +1,2 @@
+import { ProjectProductState } from "./project-product-state";
+export type ProjectProductStateType = typeof ProjectProductState[keyof typeof ProjectProductState];

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=project-product-state-type.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"project-product-state-type.js","sourceRoot":"","sources":["../../../src/data/project-product-state-type.ts"],"names":[],"mappings":""}

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectProductState = void 0;
+/* eslint-disable @typescript-eslint/naming-convention */
 exports.ProjectProductState = {
     Unprocessed: "UNPROCESSED",
     Scheduled: "SCHEDULED",

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

@@ -1 +1 @@
-{"version":3,"file":"project-product-state.js","sourceRoot":"","sources":["../../../src/data/project-product-state.ts"],"names":[],"mappings":";;;AAAa,QAAA,mBAAmB,GAAG;IAClC,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACX,CAAC"}
+{"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,9 +1,9 @@
-import { ProjectProductState } from "./project-product-state";
+import { ProjectProductStateType } from "./project-product-state-type";
 export type ProjectProduct = {
     projectProductId: string;
     productNumber: string;
     productName: string;
     productStartDate: Date;
     productEndDate: Date;
-    productState: typeof ProjectProductState[keyof typeof ProjectProductState];
+    productState: ProjectProductStateType;
 };

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

@@ -0,0 +1,2 @@
+import { ProjectState } from "./project-state";
+export type ProjectStateType = typeof ProjectState[keyof typeof ProjectState];

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=project-state-type.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"project-state-type.js","sourceRoot":"","sources":["../../../src/data/project-state-type.ts"],"names":[],"mappings":""}

package/src/data/project-state.js

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

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

@@ -1 +1 @@
-{"version":3,"file":"project-state.js","sourceRoot":"","sources":["../../../src/data/project-state.ts"],"names":[],"mappings":";;;AAAa,QAAA,YAAY,GAAG;IAC3B,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;CACb,CAAC"}
+{"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"}