avvir 5.0.4 → 5.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/avvir_api.node.js +27 -2
  2. package/dist/esm/api/project_summary_api.d.ts +14 -2
  3. package/dist/esm/api/project_summary_api.js +27 -2
  4. package/dist/esm/api/project_summary_api.js.map +1 -1
  5. package/package.json +1 -1
  6. package/source/api/project_summary_api.ts +33 -3
package/dist/avvir_api.node.js CHANGED
@@ -1128,20 +1128,45 @@ var ProjectSummaryApi = /** @class */ (function () {
1128
1128
  ProjectSummaryApi.getProjectSummary = function (projectId, user) {
1129
1129
  return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].get(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/summary", user);
1130
1130
  };
1131
+ /**
1132
+ * @deprecated Use {@link createProjectArea} or {@link updateProjectArea} instead
1133
+ */
1131
1134
  ProjectSummaryApi.createOrReplaceProjectArea = function (projectId, modelElementId, projectArea, user) {
1132
1135
  return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].put(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas/" + modelElementId, user, projectArea);
1133
1136
  };
1134
1137
  ;
1138
+ ProjectSummaryApi.createProjectArea = function (projectId, projectArea, user) {
1139
+ return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].post(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas", user, projectArea);
1140
+ };
1141
+ ProjectSummaryApi.updateProjectArea = function (projectId, projectAreaId, projectArea, user) {
1142
+ return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].patch(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas/" + projectAreaId, user, projectArea);
1143
+ };
1144
+ ;
1145
+ /**
1146
+ * @deprecated Use {@link updateProjectArea} to update the project area or {@link updateProjectAreaWorkPackages} to update the project area work packages
1147
+ */
1135
1148
  ProjectSummaryApi.updateProjectAreaProgress = function (projectId, modelElementId, projectArea, user) {
1136
1149
  return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].patch(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas/" + modelElementId, user, projectArea);
1137
1150
  };
1138
1151
  ;
1152
+ ProjectSummaryApi.createProjectAreaWorkPackage = function (projectId, projectAreaId, projectAreaWorkPackage, user) {
1153
+ return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].post(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas/" + projectAreaId + "/work-packages", user, projectAreaWorkPackage);
1154
+ };
1155
+ ProjectSummaryApi.updateProjectAreaWorkPackages = function (projectId, projectAreaId, projectAreaWorkPackages, user) {
1156
+ return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].patch(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas/" + projectAreaId + "/work-packages", user, projectAreaWorkPackages);
1157
+ };
1139
1158
  ProjectSummaryApi.getProjectArea = function (projectId, projectAreaId, user) {
1140
1159
  return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].get(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas/" + projectAreaId, user);
1141
1160
  };
1142
1161
  ;
1143
- ProjectSummaryApi.createProjectArea = function (projectId, projectArea, user) {
1144
- return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].post(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas", user, projectArea);
1162
+ ProjectSummaryApi.listProjectAreas = function (projectId, user) {
1163
+ return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].get(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas", user);
1164
+ };
1165
+ ProjectSummaryApi.listProjectAreaWorkPackages = function (projectId, projectAreaId, user) {
1166
+ return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].get(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas/" + projectAreaId + "/work-packages", user);
1167
+ };
1168
+ ProjectSummaryApi.listProjectAreaWorkPackagesForProject = function (projectId, user) {
1169
+ return _utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].get(_utilities_http__WEBPACK_IMPORTED_MODULE_1__["default"].baseUrl() + "/projects/" + projectId + "/areas/work-packages", user);
1145
1170
  };
1146
1171
  return ProjectSummaryApi;
1147
1172
  }());
package/dist/esm/api/project_summary_api.d.ts CHANGED
@@ -1,8 +1,20 @@
1
- import { ApiProjectArea, ApiProjectSummary, User } from "../models";
1
+ import { ApiProjectArea, ApiProjectAreaWorkPackage, ApiProjectSummary, User } from "../models";
2
2
  export default class ProjectSummaryApi {
3
3
  static getProjectSummary(projectId: string, user: User): Promise<ApiProjectSummary>;
4
+ /**
5
+ * @deprecated Use {@link createProjectArea} or {@link updateProjectArea} instead
6
+ */
4
7
  static createOrReplaceProjectArea(projectId: string, modelElementId: number, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea>;
8
+ static createProjectArea(projectId: string, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea>;
9
+ static updateProjectArea(projectId: string, projectAreaId: number, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea>;
10
+ /**
11
+ * @deprecated Use {@link updateProjectArea} to update the project area or {@link updateProjectAreaWorkPackages} to update the project area work packages
12
+ */
5
13
  static updateProjectAreaProgress(projectId: string, modelElementId: number, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea>;
14
+ static createProjectAreaWorkPackage(projectId: string, projectAreaId: number, projectAreaWorkPackage: ApiProjectAreaWorkPackage, user: User): Promise<ApiProjectAreaWorkPackage>;
15
+ static updateProjectAreaWorkPackages(projectId: string, projectAreaId: number, projectAreaWorkPackages: ApiProjectAreaWorkPackage[], user: User): Promise<ApiProjectAreaWorkPackage[]>;
6
16
  static getProjectArea(projectId: string, projectAreaId: number, user: User): Promise<ApiProjectArea>;
7
- static createProjectArea(projectId: string, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea>;
17
+ static listProjectAreas(projectId: string, user: User): Promise<ApiProjectArea[]>;
18
+ static listProjectAreaWorkPackages(projectId: string, projectAreaId: number, user: User): Promise<ApiProjectAreaWorkPackage[]>;
19
+ static listProjectAreaWorkPackagesForProject(projectId: string, user: User): Promise<ApiProjectAreaWorkPackage[]>;
8
20
  }
package/dist/esm/api/project_summary_api.js CHANGED
@@ -4,20 +4,45 @@ export default class ProjectSummaryApi {
4
4
  static getProjectSummary(projectId, user) {
5
5
  return Http.get(`${Http.baseUrl()}/projects/${projectId}/summary`, user);
6
6
  }
7
+ /**
8
+ * @deprecated Use {@link createProjectArea} or {@link updateProjectArea} instead
9
+ */
7
10
  static createOrReplaceProjectArea(projectId, modelElementId, projectArea, user) {
8
11
  return Http.put(`${Http.baseUrl()}/projects/${projectId}/areas/${modelElementId}`, user, projectArea);
9
12
  }
10
13
  ;
14
+ static createProjectArea(projectId, projectArea, user) {
15
+ return Http.post(`${Http.baseUrl()}/projects/${projectId}/areas`, user, projectArea);
16
+ }
17
+ static updateProjectArea(projectId, projectAreaId, projectArea, user) {
18
+ return Http.patch(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}`, user, projectArea);
19
+ }
20
+ ;
21
+ /**
22
+ * @deprecated Use {@link updateProjectArea} to update the project area or {@link updateProjectAreaWorkPackages} to update the project area work packages
23
+ */
11
24
  static updateProjectAreaProgress(projectId, modelElementId, projectArea, user) {
12
25
  return Http.patch(`${Http.baseUrl()}/projects/${projectId}/areas/${modelElementId}`, user, projectArea);
13
26
  }
14
27
  ;
28
+ static createProjectAreaWorkPackage(projectId, projectAreaId, projectAreaWorkPackage, user) {
29
+ return Http.post(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}/work-packages`, user, projectAreaWorkPackage);
30
+ }
31
+ static updateProjectAreaWorkPackages(projectId, projectAreaId, projectAreaWorkPackages, user) {
32
+ return Http.patch(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}/work-packages`, user, projectAreaWorkPackages);
33
+ }
15
34
  static getProjectArea(projectId, projectAreaId, user) {
16
35
  return Http.get(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}`, user);
17
36
  }
18
37
  ;
19
- static createProjectArea(projectId, projectArea, user) {
20
- return Http.post(`${Http.baseUrl()}/projects/${projectId}/areas`, user, projectArea);
38
+ static listProjectAreas(projectId, user) {
39
+ return Http.get(`${Http.baseUrl()}/projects/${projectId}/areas`, user);
40
+ }
41
+ static listProjectAreaWorkPackages(projectId, projectAreaId, user) {
42
+ return Http.get(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}/work-packages`, user);
43
+ }
44
+ static listProjectAreaWorkPackagesForProject(projectId, user) {
45
+ return Http.get(`${Http.baseUrl()}/projects/${projectId}/areas/work-packages`, user);
21
46
  }
22
47
  }
23
48
  ;
package/dist/esm/api/project_summary_api.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"project_summary_api.js","sourceRoot":"","sources":["../../../source/api/project_summary_api.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAE/D,OAAO,IAAI,MAAM,mBAAmB,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,iBAAiB;IAClC,MAAM,CAAC,iBAAiB,CAAC,SAAiB,EAAE,IAAU;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,EAAE,IAAI,CAA0C,CAAC;IACtH,CAAC;IAED,MAAM,CAAC,0BAA0B,CAAC,SAAiB,EAAE,cAAsB,EAAE,WAA2B,EAAE,IAAU;QAChH,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,cAAc,EAAE,EAAE,IAAI,EAAE,WAAW,CAAuC,CAAA;IAC/I,CAAC;IAAA,CAAC;IAEF,MAAM,CAAC,yBAAyB,CAAC,SAAiB,EAAE,cAAsB,EAAE,WAA2B,EAAE,IAAU;QAC/G,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,cAAc,EAAE,EAAE,IAAI,EAAE,WAAW,CAAuC,CAAA;IACjJ,CAAC;IAAA,CAAC;IAEF,MAAM,CAAC,cAAc,CAAC,SAAiB,EAAE,aAAqB,EAAE,IAAU;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,aAAa,EAAE,EAAE,IAAI,CAAuC,CAAC;IAClI,CAAC;IAAA,CAAC;IAEF,MAAM,CAAC,iBAAiB,CAAC,SAAiB,EAAE,WAA2B,EAAE,IAAU;QAC/E,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,QAAQ,EAAE,IAAI,EAAE,WAAW,CAAuC,CAAC;IAC/H,CAAC;CACJ;AAAA,CAAC;AAEF,gBAAgB,CAAC,iBAAiB,CAAC,CAAA"}
1
+ {"version":3,"file":"project_summary_api.js","sourceRoot":"","sources":["../../../source/api/project_summary_api.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAE/D,OAAO,IAAI,MAAM,mBAAmB,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,iBAAiB;IAClC,MAAM,CAAC,iBAAiB,CAAC,SAAiB,EAAE,IAAU;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,EAAE,IAAI,CAA0C,CAAC;IACtH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,0BAA0B,CAAC,SAAiB,EAAE,cAAsB,EAAE,WAA2B,EAAE,IAAU;QAChH,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,cAAc,EAAE,EAAE,IAAI,EAAE,WAAW,CAAuC,CAAA;IAC/I,CAAC;IAAA,CAAC;IAEF,MAAM,CAAC,iBAAiB,CAAC,SAAiB,EAAE,WAA2B,EAAE,IAAU;QAC/E,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,QAAQ,EAAE,IAAI,EAAE,WAAW,CAAuC,CAAC;IAC/H,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,SAAiB,EAAE,aAAqB,EAAE,WAA2B,EAAE,IAAU;QACtG,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,aAAa,EAAE,EAAE,IAAI,EAAE,WAAW,CAAuC,CAAA;IAChJ,CAAC;IAAA,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,yBAAyB,CAAC,SAAiB,EAAE,cAAsB,EAAE,WAA2B,EAAE,IAAU;QAC/G,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,cAAc,EAAE,EAAE,IAAI,EAAE,WAAW,CAAuC,CAAA;IACjJ,CAAC;IAAA,CAAC;IAEF,MAAM,CAAC,4BAA4B,CAAC,SAAiB,EAAE,aAAqB,EAAE,sBAAiD,EAAE,IAAU;QACvI,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,aAAa,gBAAgB,EAAE,IAAI,EAAE,sBAAsB,CAAkD,CAAC;IACpL,CAAC;IAED,MAAM,CAAC,6BAA6B,CAAC,SAAiB,EAAE,aAAqB,EAAE,uBAAoD,EAAE,IAAU;QAC3I,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,aAAa,gBAAgB,EAAE,IAAI,EAAE,uBAAuB,CAAoD,CAAC;IACxL,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,SAAiB,EAAE,aAAqB,EAAE,IAAU;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,aAAa,EAAE,EAAE,IAAI,CAAuC,CAAC;IAClI,CAAC;IAAA,CAAC;IAEF,MAAM,CAAC,gBAAgB,CAAC,SAAiB,EAAE,IAAU;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,QAAQ,EAAE,IAAI,CAAyC,CAAC;IACnH,CAAC;IAED,MAAM,CAAC,2BAA2B,CAAC,SAAiB,EAAE,aAAqB,EAAE,IAAU;QACnF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,UAAU,aAAa,gBAAgB,EAAE,IAAI,CAAoD,CAAC;IAC7J,CAAC;IAED,MAAM,CAAC,qCAAqC,CAAC,SAAiB,EAAE,IAAU;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,SAAS,sBAAsB,EAAE,IAAI,CAAoD,CAAC;IAC5I,CAAC;CACJ;AAAA,CAAC;AAEF,gBAAgB,CAAC,iBAAiB,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "avvir",
3
3
  "repository": "git@github.com:Avvir/avvir-javascript-client.git",
4
- "version": "5.0.4",
4
+ "version": "5.0.5",
5
5
  "description": "Javascript client for Avvir APIs",
6
6
  "license": "Apache-2.0",
7
7
  "module": "dist/esm/index.js",
package/source/api/project_summary_api.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import makeErrorsPretty from "../utilities/make_errors_pretty";
2
- import { ApiProjectArea, ApiProjectSummary, User } from "../models";
2
+ import { ApiProjectArea, ApiProjectAreaWorkPackage, ApiProjectSummary, User } from "../models";
3
3
  import Http from "../utilities/http";
4
4
 
5
5
  export default class ProjectSummaryApi {
@@ -7,20 +7,50 @@ export default class ProjectSummaryApi {
7
7
  return Http.get(`${Http.baseUrl()}/projects/${projectId}/summary`, user) as unknown as Promise<ApiProjectSummary>;
8
8
  }
9
9
 
10
+ /**
11
+ * @deprecated Use {@link createProjectArea} or {@link updateProjectArea} instead
12
+ */
10
13
  static createOrReplaceProjectArea(projectId: string, modelElementId: number, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea> {
11
14
  return Http.put(`${Http.baseUrl()}/projects/${projectId}/areas/${modelElementId}`, user, projectArea) as unknown as Promise<ApiProjectArea>
12
15
  };
13
16
 
17
+ static createProjectArea(projectId: string, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea> {
18
+ return Http.post(`${Http.baseUrl()}/projects/${projectId}/areas`, user, projectArea) as unknown as Promise<ApiProjectArea>;
19
+ }
20
+
21
+ static updateProjectArea(projectId: string, projectAreaId: number, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea> {
22
+ return Http.patch(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}`, user, projectArea) as unknown as Promise<ApiProjectArea>
23
+ };
24
+
25
+ /**
26
+ * @deprecated Use {@link updateProjectArea} to update the project area or {@link updateProjectAreaWorkPackages} to update the project area work packages
27
+ */
14
28
  static updateProjectAreaProgress(projectId: string, modelElementId: number, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea> {
15
29
  return Http.patch(`${Http.baseUrl()}/projects/${projectId}/areas/${modelElementId}`, user, projectArea) as unknown as Promise<ApiProjectArea>
16
30
  };
17
31
 
32
+ static createProjectAreaWorkPackage(projectId: string, projectAreaId: number, projectAreaWorkPackage: ApiProjectAreaWorkPackage, user: User): Promise<ApiProjectAreaWorkPackage> {
33
+ return Http.post(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}/work-packages`, user, projectAreaWorkPackage) as unknown as Promise<ApiProjectAreaWorkPackage>;
34
+ }
35
+
36
+ static updateProjectAreaWorkPackages(projectId: string, projectAreaId: number, projectAreaWorkPackages: ApiProjectAreaWorkPackage[], user: User): Promise<ApiProjectAreaWorkPackage[]> {
37
+ return Http.patch(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}/work-packages`, user, projectAreaWorkPackages) as unknown as Promise<ApiProjectAreaWorkPackage[]>;
38
+ }
39
+
18
40
  static getProjectArea(projectId: string, projectAreaId: number, user: User): Promise<ApiProjectArea> {
19
41
  return Http.get(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}`, user) as unknown as Promise<ApiProjectArea>;
20
42
  };
21
43
 
22
- static createProjectArea(projectId: string, projectArea: ApiProjectArea, user: User): Promise<ApiProjectArea> {
23
- return Http.post(`${Http.baseUrl()}/projects/${projectId}/areas`, user, projectArea) as unknown as Promise<ApiProjectArea>;
44
+ static listProjectAreas(projectId: string, user: User): Promise<ApiProjectArea[]> {
45
+ return Http.get(`${Http.baseUrl()}/projects/${projectId}/areas`, user) as unknown as Promise<ApiProjectArea[]>;
46
+ }
47
+
48
+ static listProjectAreaWorkPackages(projectId: string, projectAreaId: number, user: User): Promise<ApiProjectAreaWorkPackage[]> {
49
+ return Http.get(`${Http.baseUrl()}/projects/${projectId}/areas/${projectAreaId}/work-packages`, user) as unknown as Promise<ApiProjectAreaWorkPackage[]>;
50
+ }
51
+
52
+ static listProjectAreaWorkPackagesForProject(projectId: string, user: User): Promise<ApiProjectAreaWorkPackage[]> {
53
+ return Http.get(`${Http.baseUrl()}/projects/${projectId}/areas/work-packages`, user) as unknown as Promise<ApiProjectAreaWorkPackage[]>;
24
54
  }
25
55
  };
26
56