@squonk/data-manager-client 0.7.3-rc.4 → 0.7.7
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.
- package/accounting/accounting.cjs +5 -5
- package/accounting/accounting.cjs.map +1 -1
- package/accounting/accounting.d.ts +8 -3
- package/accounting/accounting.js +1 -1
- package/accounting/accounting.js.map +1 -1
- package/admin/admin.cjs +35 -25
- package/admin/admin.cjs.map +1 -1
- package/admin/admin.d.ts +36 -17
- package/admin/admin.js +32 -22
- package/admin/admin.js.map +1 -1
- package/application/application.cjs +12 -12
- package/application/application.cjs.map +1 -1
- package/application/application.d.ts +11 -6
- package/application/application.js +9 -9
- package/application/application.js.map +1 -1
- package/{chunk-JR7F532L.js → chunk-6EEIAH4R.js} +1 -1
- package/{chunk-JR7F532L.js.map → chunk-6EEIAH4R.js.map} +1 -1
- package/{chunk-3DXYUDZH.cjs → chunk-NGBTCJWS.cjs} +1 -1
- package/chunk-NGBTCJWS.cjs.map +1 -0
- package/{custom-instance-32850190.d.ts → custom-instance-42e56f26.d.ts} +10 -3
- package/dataset/dataset.cjs +62 -52
- package/dataset/dataset.cjs.map +1 -1
- package/dataset/dataset.d.ts +52 -29
- package/dataset/dataset.js +54 -44
- package/dataset/dataset.js.map +1 -1
- package/file/file.cjs +22 -17
- package/file/file.cjs.map +1 -1
- package/file/file.d.ts +20 -8
- package/file/file.js +18 -13
- package/file/file.js.map +1 -1
- package/index.cjs +2 -2
- package/index.cjs.map +1 -1
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/index.js.map +1 -1
- package/instance/instance.cjs +26 -21
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.d.ts +23 -11
- package/instance/instance.js +23 -18
- package/instance/instance.js.map +1 -1
- package/job/job.cjs +11 -11
- package/job/job.cjs.map +1 -1
- package/job/job.d.ts +11 -6
- package/job/job.js +8 -8
- package/job/job.js.map +1 -1
- package/metadata/metadata.cjs +34 -28
- package/metadata/metadata.cjs.map +1 -1
- package/metadata/metadata.d.ts +27 -16
- package/metadata/metadata.js +30 -24
- package/metadata/metadata.js.map +1 -1
- package/package.json +14 -14
- package/project/project.cjs +56 -41
- package/project/project.cjs.map +1 -1
- package/project/project.d.ts +49 -27
- package/project/project.js +52 -37
- package/project/project.js.map +1 -1
- package/src/accounting/accounting.ts +11 -1
- package/src/admin/admin.ts +94 -37
- package/src/application/application.ts +19 -9
- package/src/data-manager-api.schemas.ts +6 -3
- package/src/dataset/dataset.ts +130 -65
- package/src/file/file.ts +47 -16
- package/src/instance/instance.ts +57 -24
- package/src/job/job.ts +14 -8
- package/src/metadata/metadata.ts +66 -38
- package/src/project/project.ts +121 -55
- package/src/task/task.ts +28 -16
- package/src/type/type.ts +6 -1
- package/src/user/user.ts +26 -2
- package/task/task.cjs +16 -16
- package/task/task.cjs.map +1 -1
- package/task/task.d.ts +15 -8
- package/task/task.js +13 -13
- package/task/task.js.map +1 -1
- package/type/type.cjs +3 -3
- package/type/type.cjs.map +1 -1
- package/type/type.d.ts +6 -3
- package/type/type.js +1 -1
- package/type/type.js.map +1 -1
- package/user/user.cjs +13 -8
- package/user/user.cjs.map +1 -1
- package/user/user.d.ts +12 -2
- package/user/user.js +7 -2
- package/user/user.js.map +1 -1
- package/chunk-3DXYUDZH.cjs.map +0 -1
package/project/project.cjs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
|
|
2
2
|
|
|
3
3
|
|
|
4
|
-
var
|
|
4
|
+
var _chunkNGBTCJWScjs = require('../chunk-NGBTCJWS.cjs');
|
|
5
5
|
|
|
6
6
|
// src/project/project.ts
|
|
7
7
|
|
|
@@ -9,7 +9,7 @@ var _chunk3DXYUDZHcjs = require('../chunk-3DXYUDZH.cjs');
|
|
|
9
9
|
|
|
10
10
|
var _reactquery = require('react-query');
|
|
11
11
|
var getProjects = (options) => {
|
|
12
|
-
return
|
|
12
|
+
return _chunkNGBTCJWScjs.customInstance.call(void 0, { url: `/project`, method: "get" }, options);
|
|
13
13
|
};
|
|
14
14
|
var getGetProjectsQueryKey = () => [`/project`];
|
|
15
15
|
var useGetProjects = (options) => {
|
|
@@ -17,7 +17,7 @@ var useGetProjects = (options) => {
|
|
|
17
17
|
const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetProjectsQueryKey()));
|
|
18
18
|
const queryFn = () => getProjects(requestOptions);
|
|
19
19
|
const query = _reactquery.useQuery.call(void 0, queryKey, queryFn, queryOptions);
|
|
20
|
-
return
|
|
20
|
+
return _chunkNGBTCJWScjs.__spreadValues.call(void 0, {
|
|
21
21
|
queryKey
|
|
22
22
|
}, query);
|
|
23
23
|
};
|
|
@@ -30,7 +30,12 @@ var createProject = (projectPostBodyBody, options) => {
|
|
|
30
30
|
formData.append("organisation_id", projectPostBodyBody.organisation_id);
|
|
31
31
|
formData.append("unit_id", projectPostBodyBody.unit_id);
|
|
32
32
|
formData.append("tier_product_id", projectPostBodyBody.tier_product_id);
|
|
33
|
-
return
|
|
33
|
+
return _chunkNGBTCJWScjs.customInstance.call(void 0, {
|
|
34
|
+
url: `/project`,
|
|
35
|
+
method: "post",
|
|
36
|
+
headers: { "Content-Type": "multipart/form-data" },
|
|
37
|
+
data: formData
|
|
38
|
+
}, options);
|
|
34
39
|
};
|
|
35
40
|
var useCreateProject = (options) => {
|
|
36
41
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
@@ -40,22 +45,22 @@ var useCreateProject = (options) => {
|
|
|
40
45
|
};
|
|
41
46
|
return _reactquery.useMutation.call(void 0, mutationFn, mutationOptions);
|
|
42
47
|
};
|
|
43
|
-
var getProject = (
|
|
44
|
-
return
|
|
48
|
+
var getProject = (projectId, options) => {
|
|
49
|
+
return _chunkNGBTCJWScjs.customInstance.call(void 0, { url: `/project/${projectId}`, method: "get" }, options);
|
|
45
50
|
};
|
|
46
|
-
var getGetProjectQueryKey = (
|
|
47
|
-
`/project/${
|
|
51
|
+
var getGetProjectQueryKey = (projectId) => [
|
|
52
|
+
`/project/${projectId}`
|
|
48
53
|
];
|
|
49
|
-
var useGetProject = (
|
|
54
|
+
var useGetProject = (projectId, options) => {
|
|
50
55
|
const { query: queryOptions, request: requestOptions } = options || {};
|
|
51
|
-
const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetProjectQueryKey(
|
|
52
|
-
const queryFn = () => getProject(
|
|
53
|
-
const query = _reactquery.useQuery.call(void 0, queryKey, queryFn,
|
|
54
|
-
return
|
|
56
|
+
const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetProjectQueryKey(projectId)));
|
|
57
|
+
const queryFn = () => getProject(projectId, requestOptions);
|
|
58
|
+
const query = _reactquery.useQuery.call(void 0, queryKey, queryFn, _chunkNGBTCJWScjs.__spreadValues.call(void 0, { enabled: !!projectId }, queryOptions));
|
|
59
|
+
return _chunkNGBTCJWScjs.__spreadValues.call(void 0, {
|
|
55
60
|
queryKey
|
|
56
61
|
}, query);
|
|
57
62
|
};
|
|
58
|
-
var patchProject = (
|
|
63
|
+
var patchProject = (projectId, projectPatchBodyBody, options) => {
|
|
59
64
|
const formData = new FormData();
|
|
60
65
|
if (projectPatchBodyBody.private !== void 0) {
|
|
61
66
|
formData.append("private", projectPatchBodyBody.private.toString());
|
|
@@ -63,63 +68,68 @@ var patchProject = (projectid, projectPatchBodyBody, options) => {
|
|
|
63
68
|
if (projectPatchBodyBody.name !== void 0) {
|
|
64
69
|
formData.append("name", projectPatchBodyBody.name);
|
|
65
70
|
}
|
|
66
|
-
return
|
|
71
|
+
return _chunkNGBTCJWScjs.customInstance.call(void 0, {
|
|
72
|
+
url: `/project/${projectId}`,
|
|
73
|
+
method: "patch",
|
|
74
|
+
headers: { "Content-Type": "multipart/form-data" },
|
|
75
|
+
data: formData
|
|
76
|
+
}, options);
|
|
67
77
|
};
|
|
68
78
|
var usePatchProject = (options) => {
|
|
69
79
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
70
80
|
const mutationFn = (props) => {
|
|
71
|
-
const {
|
|
72
|
-
return patchProject(
|
|
81
|
+
const { projectId, data } = props || {};
|
|
82
|
+
return patchProject(projectId, data, requestOptions);
|
|
73
83
|
};
|
|
74
84
|
return _reactquery.useMutation.call(void 0, mutationFn, mutationOptions);
|
|
75
85
|
};
|
|
76
|
-
var deleteProject = (
|
|
77
|
-
return
|
|
86
|
+
var deleteProject = (projectId, options) => {
|
|
87
|
+
return _chunkNGBTCJWScjs.customInstance.call(void 0, { url: `/project/${projectId}`, method: "delete" }, options);
|
|
78
88
|
};
|
|
79
89
|
var useDeleteProject = (options) => {
|
|
80
90
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
81
91
|
const mutationFn = (props) => {
|
|
82
|
-
const {
|
|
83
|
-
return deleteProject(
|
|
92
|
+
const { projectId } = props || {};
|
|
93
|
+
return deleteProject(projectId, requestOptions);
|
|
84
94
|
};
|
|
85
95
|
return _reactquery.useMutation.call(void 0, mutationFn, mutationOptions);
|
|
86
96
|
};
|
|
87
|
-
var addEditorToProject = (
|
|
88
|
-
return
|
|
97
|
+
var addEditorToProject = (projectId, userId, options) => {
|
|
98
|
+
return _chunkNGBTCJWScjs.customInstance.call(void 0, { url: `/project/${projectId}/editor/${userId}`, method: "put" }, options);
|
|
89
99
|
};
|
|
90
100
|
var useAddEditorToProject = (options) => {
|
|
91
101
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
92
102
|
const mutationFn = (props) => {
|
|
93
|
-
const {
|
|
94
|
-
return addEditorToProject(
|
|
103
|
+
const { projectId, userId } = props || {};
|
|
104
|
+
return addEditorToProject(projectId, userId, requestOptions);
|
|
95
105
|
};
|
|
96
106
|
return _reactquery.useMutation.call(void 0, mutationFn, mutationOptions);
|
|
97
107
|
};
|
|
98
|
-
var removeEditorFromProject = (
|
|
99
|
-
return
|
|
108
|
+
var removeEditorFromProject = (projectId, userId, options) => {
|
|
109
|
+
return _chunkNGBTCJWScjs.customInstance.call(void 0, { url: `/project/${projectId}/editor/${userId}`, method: "delete" }, options);
|
|
100
110
|
};
|
|
101
111
|
var useRemoveEditorFromProject = (options) => {
|
|
102
112
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
103
113
|
const mutationFn = (props) => {
|
|
104
|
-
const {
|
|
105
|
-
return removeEditorFromProject(
|
|
114
|
+
const { projectId, userId } = props || {};
|
|
115
|
+
return removeEditorFromProject(projectId, userId, requestOptions);
|
|
106
116
|
};
|
|
107
117
|
return _reactquery.useMutation.call(void 0, mutationFn, mutationOptions);
|
|
108
118
|
};
|
|
109
|
-
var getProjectFile = (
|
|
110
|
-
return
|
|
119
|
+
var getProjectFile = (projectId, params, options) => {
|
|
120
|
+
return _chunkNGBTCJWScjs.customInstance.call(void 0, { url: `/project/${projectId}/file`, method: "get", params }, options);
|
|
111
121
|
};
|
|
112
|
-
var getGetProjectFileQueryKey = (
|
|
113
|
-
var useGetProjectFile = (
|
|
122
|
+
var getGetProjectFileQueryKey = (projectId, params) => [`/project/${projectId}/file`, ...params ? [params] : []];
|
|
123
|
+
var useGetProjectFile = (projectId, params, options) => {
|
|
114
124
|
const { query: queryOptions, request: requestOptions } = options || {};
|
|
115
|
-
const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetProjectFileQueryKey(
|
|
116
|
-
const queryFn = () => getProjectFile(
|
|
117
|
-
const query = _reactquery.useQuery.call(void 0, queryKey, queryFn,
|
|
118
|
-
return
|
|
125
|
+
const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetProjectFileQueryKey(projectId, params)));
|
|
126
|
+
const queryFn = () => getProjectFile(projectId, params, requestOptions);
|
|
127
|
+
const query = _reactquery.useQuery.call(void 0, queryKey, queryFn, _chunkNGBTCJWScjs.__spreadValues.call(void 0, { enabled: !!projectId }, queryOptions));
|
|
128
|
+
return _chunkNGBTCJWScjs.__spreadValues.call(void 0, {
|
|
119
129
|
queryKey
|
|
120
130
|
}, query);
|
|
121
131
|
};
|
|
122
|
-
var addFileToProject = (
|
|
132
|
+
var addFileToProject = (projectId, projectFilePutBodyBody, options) => {
|
|
123
133
|
const formData = new FormData();
|
|
124
134
|
formData.append("file", projectFilePutBodyBody.file);
|
|
125
135
|
if (projectFilePutBodyBody.as_filename !== void 0) {
|
|
@@ -128,13 +138,18 @@ var addFileToProject = (projectid, projectFilePutBodyBody, options) => {
|
|
|
128
138
|
if (projectFilePutBodyBody.path !== void 0) {
|
|
129
139
|
formData.append("path", projectFilePutBodyBody.path);
|
|
130
140
|
}
|
|
131
|
-
return
|
|
141
|
+
return _chunkNGBTCJWScjs.customInstance.call(void 0, {
|
|
142
|
+
url: `/project/${projectId}/file`,
|
|
143
|
+
method: "put",
|
|
144
|
+
headers: { "Content-Type": "multipart/form-data" },
|
|
145
|
+
data: formData
|
|
146
|
+
}, options);
|
|
132
147
|
};
|
|
133
148
|
var useAddFileToProject = (options) => {
|
|
134
149
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
135
150
|
const mutationFn = (props) => {
|
|
136
|
-
const {
|
|
137
|
-
return addFileToProject(
|
|
151
|
+
const { projectId, data } = props || {};
|
|
152
|
+
return addFileToProject(projectId, data, requestOptions);
|
|
138
153
|
};
|
|
139
154
|
return _reactquery.useMutation.call(void 0, mutationFn, mutationOptions);
|
|
140
155
|
};
|
package/project/project.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/project/project.ts"],"names":[],"mappings":";;;;;;AAUA;AAAA;AAAA;AAAA;AA2CO,IAAM,cAAc,CACzB,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,QAAQ,SAC3B;AAAA;AAIG,IAAM,yBAAyB,MAAM,CAAC;AAEtC,IAAM,iBAAiB,CAG5B,YAG4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WAAW,8CAAc,aAAY;AAE3C,QAAM,UAA8D,MAClE,YAAY;AAEd,QAAM,QAAQ,SACZ,UACA,SACA;AAGF,SAAO;AAAA,IACL;AAAA,KACG;AAAA;AAeA,IAAM,gBAAgB,CAC3B,qBACA,YACG;AACH,QAAM,WAAW,IAAI;AACrB,WAAS,OAAO,QAAQ,oBAAoB;AAC5C,MAAI,oBAAoB,YAAY,QAAW;AAC7C,aAAS,OAAO,WAAW,oBAAoB,QAAQ;AAAA;AAEzD,WAAS,OAAO,mBAAmB,oBAAoB;AACvD,WAAS,OAAO,WAAW,oBAAoB;AAC/C,WAAS,OAAO,mBAAmB,oBAAoB;AAEvD,SAAO,eACL,EAAE,KAAK,YAAY,QAAQ,QAAQ,MAAM,YACzC;AAAA;AAIG,IAAM,mBAAmB,CAG9B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,SAAS,SAAS;AAE1B,WAAO,cAAc,MAAM;AAAA;AAG7B,SAAO,YAKL,YAAY;AAAA;AAOT,IAAM,aAAa,CACxB,WACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,aAAa,QAAQ,SACxC;AAAA;AAIG,IAAM,wBAAwB,CAAC,cAAsB;AAAA,EAC1D,YAAY;AAAA;AAGP,IAAM,gBAAgB,CAI3B,WACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WAAW,8CAAc,aAAY,sBAAsB;AAEjE,QAAM,UAA6D,MACjE,WAAW,WAAW;AAExB,QAAM,QAAQ,SACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAC,aAAc;AAG7B,SAAO;AAAA,IACL;AAAA,KACG;AAAA;AASA,IAAM,eAAe,CAC1B,WACA,sBACA,YACG;AACH,QAAM,WAAW,IAAI;AACrB,MAAI,qBAAqB,YAAY,QAAW;AAC9C,aAAS,OAAO,WAAW,qBAAqB,QAAQ;AAAA;AAE1D,MAAI,qBAAqB,SAAS,QAAW;AAC3C,aAAS,OAAO,QAAQ,qBAAqB;AAAA;AAG/C,SAAO,eACL,EAAE,KAAK,YAAY,aAAa,QAAQ,SAAS,MAAM,YACvD;AAAA;AAIG,IAAM,kBAAkB,CAG7B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,SAAS,SAAS;AAErC,WAAO,aAAa,WAAW,MAAM;AAAA;AAGvC,SAAO,YAKL,YAAY;AAAA;AAWT,IAAM,gBAAgB,CAC3B,WACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,aAAa,QAAQ,YACxC;AAAA;AAIG,IAAM,mBAAmB,CAG9B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,cAAc,SAAS;AAE/B,WAAO,cAAc,WAAW;AAAA;AAGlC,SAAO,YAKL,YAAY;AAAA;AAWT,IAAM,qBAAqB,CAChC,WACA,QACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,oBAAoB,UAAU,QAAQ,SACzD;AAAA;AAIG,IAAM,wBAAwB,CAGnC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,WAAW,SAAS;AAEvC,WAAO,mBAAmB,WAAW,QAAQ;AAAA;AAG/C,SAAO,YAKL,YAAY;AAAA;AAWT,IAAM,0BAA0B,CACrC,WACA,QACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,oBAAoB,UAAU,QAAQ,YACzD;AAAA;AAIG,IAAM,6BAA6B,CAGxC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,WAAW,SAAS;AAEvC,WAAO,wBAAwB,WAAW,QAAQ;AAAA;AAGpD,SAAO,YAKL,YAAY;AAAA;AAWT,IAAM,iBAAiB,CAC5B,WACA,QACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,kBAAkB,QAAQ,OAAO,UACpD;AAAA;AAIG,IAAM,4BAA4B,CACvC,WACA,WACG,CAAC,YAAY,kBAAkB,GAAI,SAAS,CAAC,UAAU;AAErD,IAAM,oBAAoB,CAI/B,WACA,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WACJ,8CAAc,aAAY,0BAA0B,WAAW;AAEjE,QAAM,UAAiE,MACrE,eAAe,WAAW,QAAQ;AAEpC,QAAM,QAAQ,SACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAC,aAAc;AAG7B,SAAO;AAAA,IACL;AAAA,KACG;AAAA;AAWA,IAAM,mBAAmB,CAC9B,WACA,wBACA,YACG;AACH,QAAM,WAAW,IAAI;AACrB,WAAS,OAAO,QAAQ,uBAAuB;AAC/C,MAAI,uBAAuB,gBAAgB,QAAW;AACpD,aAAS,OAAO,eAAe,uBAAuB;AAAA;AAExD,MAAI,uBAAuB,SAAS,QAAW;AAC7C,aAAS,OAAO,QAAQ,uBAAuB;AAAA;AAGjD,SAAO,eACL,EAAE,KAAK,YAAY,kBAAkB,QAAQ,OAAO,MAAM,YAC1D;AAAA;AAIG,IAAM,sBAAsB,CAGjC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,SAAS,SAAS;AAErC,WAAO,iBAAiB,WAAW,MAAM;AAAA;AAG3C,SAAO,YAKL,YAAY;AAAA","sourcesContent":["/**\n * Generated by orval v6.6.0 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 0.7\n */\nimport {\n useQuery,\n useMutation,\n UseQueryOptions,\n UseMutationOptions,\n QueryFunction,\n MutationFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ProjectsGetResponse,\n DmError,\n ProjectPostResponse,\n ProjectPostBodyBody,\n ProjectGetResponse,\n ProjectPatchBodyBody,\n ProjectDeleteResponse,\n GetProjectFileParams,\n ProjectFilePutBodyBody,\n} from \"../data-manager-api.schemas\";\nimport { customInstance, ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (\n ...args: any\n) => Promise<infer R>\n ? R\n : any;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Get a list of all projects available to you.\n\n * @summary Get all projects available to you\n */\nexport const getProjects = (\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<ProjectsGetResponse>(\n { url: `/project`, method: \"get\" },\n options\n );\n};\n\nexport const getGetProjectsQueryKey = () => [`/project`];\n\nexport const useGetProjects = <\n TData = AsyncReturnType<typeof getProjects>,\n TError = ErrorType<void | DmError>\n>(options?: {\n query?: UseQueryOptions<AsyncReturnType<typeof getProjects>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options || {};\n\n const queryKey = queryOptions?.queryKey ?? getGetProjectsQueryKey();\n\n const queryFn: QueryFunction<AsyncReturnType<typeof getProjects>> = () =>\n getProjects(requestOptions);\n\n const query = useQuery<AsyncReturnType<typeof getProjects>, TError, TData>(\n queryKey,\n queryFn,\n queryOptions\n );\n\n return {\n queryKey,\n ...query,\n };\n};\n\n/**\n * Creates a new project, assigning and returning a unique **ID**. A peristent volume is created in the cluster and assigned to your Project. It's here you can add **Datasets** as **Files** and run **Applications** and **Jobs**.\n\nTo create a Project you will need an uncommitted Project product.\n\nAs the project `owner` (creator) you are also automatically an `editor` of the project and can add other users as editors so that they can also manipulate the project. An `editor` of a project can also delete it.\n\nThe name you give the project is free-form text (can contain spaces etc.). The name you use must be unique amongst all the projects you create.\n\n * @summary Create a new project\n */\nexport const createProject = (\n projectPostBodyBody: ProjectPostBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"name\", projectPostBodyBody.name);\n if (projectPostBodyBody.private !== undefined) {\n formData.append(\"private\", projectPostBodyBody.private.toString());\n }\n formData.append(\"organisation_id\", projectPostBodyBody.organisation_id);\n formData.append(\"unit_id\", projectPostBodyBody.unit_id);\n formData.append(\"tier_product_id\", projectPostBodyBody.tier_product_id);\n\n return customInstance<ProjectPostResponse>(\n { url: `/project`, method: \"post\", data: formData },\n options\n );\n};\n\nexport const useCreateProject = <\n TError = ErrorType<DmError | void>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof createProject>,\n TError,\n { data: ProjectPostBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof createProject>,\n { data: ProjectPostBodyBody }\n > = (props) => {\n const { data } = props || {};\n\n return createProject(data, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof createProject>,\n TError,\n { data: ProjectPostBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Gets the details of a project that is available to you.\n\n * @summary Get a project\n */\nexport const getProject = (\n projectid: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<ProjectGetResponse>(\n { url: `/project/${projectid}`, method: \"get\" },\n options\n );\n};\n\nexport const getGetProjectQueryKey = (projectid: string) => [\n `/project/${projectid}`,\n];\n\nexport const useGetProject = <\n TData = AsyncReturnType<typeof getProject>,\n TError = ErrorType<void | DmError>\n>(\n projectid: string,\n options?: {\n query?: UseQueryOptions<AsyncReturnType<typeof getProject>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options || {};\n\n const queryKey = queryOptions?.queryKey ?? getGetProjectQueryKey(projectid);\n\n const queryFn: QueryFunction<AsyncReturnType<typeof getProject>> = () =>\n getProject(projectid, requestOptions);\n\n const query = useQuery<AsyncReturnType<typeof getProject>, TError, TData>(\n queryKey,\n queryFn,\n { enabled: !!projectid, ...queryOptions }\n );\n\n return {\n queryKey,\n ...query,\n };\n};\n\n/**\n * Used to update some adjustable parameters of a project, i.e. to make it Private or make it Public. What can be adjusted will depend on the purchased product\n\n * @summary Adjust an existing project\n */\nexport const patchProject = (\n projectid: string,\n projectPatchBodyBody: ProjectPatchBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n if (projectPatchBodyBody.private !== undefined) {\n formData.append(\"private\", projectPatchBodyBody.private.toString());\n }\n if (projectPatchBodyBody.name !== undefined) {\n formData.append(\"name\", projectPatchBodyBody.name);\n }\n\n return customInstance<void>(\n { url: `/project/${projectid}`, method: \"patch\", data: formData },\n options\n );\n};\n\nexport const usePatchProject = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof patchProject>,\n TError,\n { projectid: string; data: ProjectPatchBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof patchProject>,\n { projectid: string; data: ProjectPatchBodyBody }\n > = (props) => {\n const { projectid, data } = props || {};\n\n return patchProject(projectid, data, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof patchProject>,\n TError,\n { projectid: string; data: ProjectPatchBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes an existing project.\n\nYou must be an `editor` or the `owner` of the project.\n\nOnce deleted all **Files**, working directories and material in the project will also be removed\n\n * @summary Delete a project\n */\nexport const deleteProject = (\n projectid: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<ProjectDeleteResponse>(\n { url: `/project/${projectid}`, method: \"delete\" },\n options\n );\n};\n\nexport const useDeleteProject = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof deleteProject>,\n TError,\n { projectid: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof deleteProject>,\n { projectid: string }\n > = (props) => {\n const { projectid } = props || {};\n\n return deleteProject(projectid, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof deleteProject>,\n TError,\n { projectid: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Adds a user to a project as an `editor`. Editors can add and remove datasets in a project and delete the project.\n\nAn `editor` of a project is not automatically an `editor` of any datasets the project contains.\n\nYou must be an `editor` or the `owner` of the project\n\n * @summary Add a project editor\n */\nexport const addEditorToProject = (\n projectid: string,\n userid: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/project/${projectid}/editor/${userid}`, method: \"put\" },\n options\n );\n};\n\nexport const useAddEditorToProject = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof addEditorToProject>,\n TError,\n { projectid: string; userid: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof addEditorToProject>,\n { projectid: string; userid: string }\n > = (props) => {\n const { projectid, userid } = props || {};\n\n return addEditorToProject(projectid, userid, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof addEditorToProject>,\n TError,\n { projectid: string; userid: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes a project `editor`. The editor can be you but you cannot delete the last `editor`\n\nA project must always have one `editor` so you will not be able to delete the last editor of a project.\n\nYou must be an `editor` or the `owner` of the project\n\n * @summary Delete a project editor\n */\nexport const removeEditorFromProject = (\n projectid: string,\n userid: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/project/${projectid}/editor/${userid}`, method: \"delete\" },\n options\n );\n};\n\nexport const useRemoveEditorFromProject = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof removeEditorFromProject>,\n TError,\n { projectid: string; userid: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof removeEditorFromProject>,\n { projectid: string; userid: string }\n > = (props) => {\n const { projectid, userid } = props || {};\n\n return removeEditorFromProject(projectid, userid, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof removeEditorFromProject>,\n TError,\n { projectid: string; userid: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Gets a file from the project, with an optional path. This method should be used to get arbitrary files from the Project's file system (typically **unmanaged** files).\n\nFor **managed** files you should consider using the `/file/{file_id}` endpoint.\n\nYou must be an `editor` or the `owner` of the project if the project is private\n\n * @summary Download a project file\n */\nexport const getProjectFile = (\n projectid: string,\n params?: GetProjectFileParams,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/project/${projectid}/file`, method: \"get\", params },\n options\n );\n};\n\nexport const getGetProjectFileQueryKey = (\n projectid: string,\n params?: GetProjectFileParams\n) => [`/project/${projectid}/file`, ...(params ? [params] : [])];\n\nexport const useGetProjectFile = <\n TData = AsyncReturnType<typeof getProjectFile>,\n TError = ErrorType<DmError>\n>(\n projectid: string,\n params?: GetProjectFileParams,\n options?: {\n query?: UseQueryOptions<\n AsyncReturnType<typeof getProjectFile>,\n TError,\n TData\n >;\n request?: SecondParameter<typeof customInstance>;\n }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options || {};\n\n const queryKey =\n queryOptions?.queryKey ?? getGetProjectFileQueryKey(projectid, params);\n\n const queryFn: QueryFunction<AsyncReturnType<typeof getProjectFile>> = () =>\n getProjectFile(projectid, params, requestOptions);\n\n const query = useQuery<AsyncReturnType<typeof getProjectFile>, TError, TData>(\n queryKey,\n queryFn,\n { enabled: !!projectid, ...queryOptions }\n );\n\n return {\n queryKey,\n ...query,\n };\n};\n\n/**\n * The user provides an external file for upload to the Project using an optional Path. The path is created if it does not exist.\n\nYou must be an `editor` or the `owner` of the project\n\n * @summary Upload a file into a Project\n */\nexport const addFileToProject = (\n projectid: string,\n projectFilePutBodyBody: ProjectFilePutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"file\", projectFilePutBodyBody.file);\n if (projectFilePutBodyBody.as_filename !== undefined) {\n formData.append(\"as_filename\", projectFilePutBodyBody.as_filename);\n }\n if (projectFilePutBodyBody.path !== undefined) {\n formData.append(\"path\", projectFilePutBodyBody.path);\n }\n\n return customInstance<void>(\n { url: `/project/${projectid}/file`, method: \"put\", data: formData },\n options\n );\n};\n\nexport const useAddFileToProject = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof addFileToProject>,\n TError,\n { projectid: string; data: ProjectFilePutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof addFileToProject>,\n { projectid: string; data: ProjectFilePutBodyBody }\n > = (props) => {\n const { projectid, data } = props || {};\n\n return addFileToProject(projectid, data, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof addFileToProject>,\n TError,\n { projectid: string; data: ProjectFilePutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n"]}
|
|
1
|
+
{"version":3,"sources":["../../src/project/project.ts"],"names":[],"mappings":";;;;;;AAUA;AAAA;AAAA;AAAA;AA2CO,IAAM,cAAc,CACzB,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,QAAQ,MAAM,GACjC,OACF;AACF;AAEO,IAAM,yBAAyB,MAAM,CAAC,UAAU;AAOhD,IAAM,iBAAiB,CAG5B,YAG4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,CAAC;AAErE,QAAM,WAAW,8CAAc,aAAY,uBAAuB;AAElE,QAAM,UAA8D,MAClE,YAAY,cAAc;AAE5B,QAAM,QAAQ,SACZ,UACA,SACA,YACF;AAEA,SAAO;AAAA,IACL;AAAA,KACG;AAEP;AAaO,IAAM,gBAAgB,CAC3B,qBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,QAAQ,oBAAoB,IAAI;AAChD,MAAI,oBAAoB,YAAY,QAAW;AAC7C,aAAS,OAAO,WAAW,oBAAoB,QAAQ,SAAS,CAAC;AAAA,EACnE;AACA,WAAS,OAAO,mBAAmB,oBAAoB,eAAe;AACtE,WAAS,OAAO,WAAW,oBAAoB,OAAO;AACtD,WAAS,OAAO,mBAAmB,oBAAoB,eAAe;AAEtE,SAAO,eACL;AAAA,IACE,KAAK;AAAA,IACL,QAAQ;AAAA,IACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,IACjD,MAAM;AAAA,EACR,GACA,OACF;AACF;AAQO,IAAM,mBAAmB,CAG9B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,SAAS,SAAS,CAAC;AAE3B,WAAO,cAAc,MAAM,cAAc;AAAA,EAC3C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAMO,IAAM,aAAa,CACxB,WACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,aAAa,QAAQ,MAAM,GAC9C,OACF;AACF;AAEO,IAAM,wBAAwB,CAAC,cAAsB;AAAA,EAC1D,YAAY;AACd;AAOO,IAAM,gBAAgB,CAI3B,WACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,CAAC;AAErE,QAAM,WAAW,8CAAc,aAAY,sBAAsB,SAAS;AAE1E,QAAM,UAA6D,MACjE,WAAW,WAAW,cAAc;AAEtC,QAAM,QAAQ,SACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAC,aAAc,aAC7B;AAEA,SAAO;AAAA,IACL;AAAA,KACG;AAEP;AAOO,IAAM,eAAe,CAC1B,WACA,sBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,MAAI,qBAAqB,YAAY,QAAW;AAC9C,aAAS,OAAO,WAAW,qBAAqB,QAAQ,SAAS,CAAC;AAAA,EACpE;AACA,MAAI,qBAAqB,SAAS,QAAW;AAC3C,aAAS,OAAO,QAAQ,qBAAqB,IAAI;AAAA,EACnD;AAEA,SAAO,eACL;AAAA,IACE,KAAK,YAAY;AAAA,IACjB,QAAQ;AAAA,IACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,IACjD,MAAM;AAAA,EACR,GACA,OACF;AACF;AAQO,IAAM,kBAAkB,CAG7B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,SAAS,SAAS,CAAC;AAEtC,WAAO,aAAa,WAAW,MAAM,cAAc;AAAA,EACrD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAUO,IAAM,gBAAgB,CAC3B,WACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,aAAa,QAAQ,SAAS,GACjD,OACF;AACF;AAQO,IAAM,mBAAmB,CAG9B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,cAAc,SAAS,CAAC;AAEhC,WAAO,cAAc,WAAW,cAAc;AAAA,EAChD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAUO,IAAM,qBAAqB,CAChC,WACA,QACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,oBAAoB,UAAU,QAAQ,MAAM,GAC/D,OACF;AACF;AAQO,IAAM,wBAAwB,CAGnC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,WAAW,SAAS,CAAC;AAExC,WAAO,mBAAmB,WAAW,QAAQ,cAAc;AAAA,EAC7D;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAUO,IAAM,0BAA0B,CACrC,WACA,QACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,oBAAoB,UAAU,QAAQ,SAAS,GAClE,OACF;AACF;AAQO,IAAM,6BAA6B,CAGxC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,WAAW,SAAS,CAAC;AAExC,WAAO,wBAAwB,WAAW,QAAQ,cAAc;AAAA,EAClE;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAUO,IAAM,iBAAiB,CAC5B,WACA,QACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,kBAAkB,QAAQ,OAAO,OAAO,GAC3D,OACF;AACF;AAEO,IAAM,4BAA4B,CACvC,WACA,WACG,CAAC,YAAY,kBAAkB,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAAE;AAOxD,IAAM,oBAAoB,CAI/B,WACA,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,CAAC;AAErE,QAAM,WACJ,8CAAc,aAAY,0BAA0B,WAAW,MAAM;AAEvE,QAAM,UAAiE,MACrE,eAAe,WAAW,QAAQ,cAAc;AAElD,QAAM,QAAQ,SACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAC,aAAc,aAC7B;AAEA,SAAO;AAAA,IACL;AAAA,KACG;AAEP;AASO,IAAM,mBAAmB,CAC9B,WACA,wBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,QAAQ,uBAAuB,IAAI;AACnD,MAAI,uBAAuB,gBAAgB,QAAW;AACpD,aAAS,OAAO,eAAe,uBAAuB,WAAW;AAAA,EACnE;AACA,MAAI,uBAAuB,SAAS,QAAW;AAC7C,aAAS,OAAO,QAAQ,uBAAuB,IAAI;AAAA,EACrD;AAEA,SAAO,eACL;AAAA,IACE,KAAK,YAAY;AAAA,IACjB,QAAQ;AAAA,IACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,IACjD,MAAM;AAAA,EACR,GACA,OACF;AACF;AAQO,IAAM,sBAAsB,CAGjC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,SAAS,SAAS,CAAC;AAEtC,WAAO,iBAAiB,WAAW,MAAM,cAAc;AAAA,EACzD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B","sourcesContent":["/**\n * Generated by orval v6.7.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 0.7\n */\nimport {\n useQuery,\n useMutation,\n UseQueryOptions,\n UseMutationOptions,\n QueryFunction,\n MutationFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ProjectsGetResponse,\n DmError,\n ProjectPostResponse,\n ProjectPostBodyBody,\n ProjectGetResponse,\n ProjectPatchBodyBody,\n ProjectDeleteResponse,\n GetProjectFileParams,\n ProjectFilePutBodyBody,\n} from \"../data-manager-api.schemas\";\nimport { customInstance, ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (\n ...args: any\n) => Promise<infer R>\n ? R\n : any;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Get a list of all projects available to you.\n\n * @summary Get all projects available to you\n */\nexport const getProjects = (\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<ProjectsGetResponse>(\n { url: `/project`, method: \"get\" },\n options\n );\n};\n\nexport const getGetProjectsQueryKey = () => [`/project`];\n\nexport type GetProjectsQueryResult = NonNullable<\n AsyncReturnType<typeof getProjects>\n>;\nexport type GetProjectsQueryError = ErrorType<void | DmError>;\n\nexport const useGetProjects = <\n TData = AsyncReturnType<typeof getProjects>,\n TError = ErrorType<void | DmError>\n>(options?: {\n query?: UseQueryOptions<AsyncReturnType<typeof getProjects>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options || {};\n\n const queryKey = queryOptions?.queryKey ?? getGetProjectsQueryKey();\n\n const queryFn: QueryFunction<AsyncReturnType<typeof getProjects>> = () =>\n getProjects(requestOptions);\n\n const query = useQuery<AsyncReturnType<typeof getProjects>, TError, TData>(\n queryKey,\n queryFn,\n queryOptions\n );\n\n return {\n queryKey,\n ...query,\n };\n};\n\n/**\n * Creates a new project, assigning and returning a unique **ID**. A peristent volume is created in the cluster and assigned to your Project. It's here you can add **Datasets** as **Files** and run **Applications** and **Jobs**.\n\nTo create a Project you will need an uncommitted Project product.\n\nAs the project `owner` (creator) you are also automatically an `editor` of the project and can add other users as editors so that they can also manipulate the project. An `editor` of a project can also delete it.\n\nThe name you give the project is free-form text (can contain spaces etc.). The name you use must be unique amongst all the projects you create.\n\n * @summary Create a new project\n */\nexport const createProject = (\n projectPostBodyBody: ProjectPostBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"name\", projectPostBodyBody.name);\n if (projectPostBodyBody.private !== undefined) {\n formData.append(\"private\", projectPostBodyBody.private.toString());\n }\n formData.append(\"organisation_id\", projectPostBodyBody.organisation_id);\n formData.append(\"unit_id\", projectPostBodyBody.unit_id);\n formData.append(\"tier_product_id\", projectPostBodyBody.tier_product_id);\n\n return customInstance<ProjectPostResponse>(\n {\n url: `/project`,\n method: \"post\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type CreateProjectMutationResult = NonNullable<\n AsyncReturnType<typeof createProject>\n>;\nexport type CreateProjectMutationBody = ProjectPostBodyBody;\nexport type CreateProjectMutationError = ErrorType<DmError | void>;\n\nexport const useCreateProject = <\n TError = ErrorType<DmError | void>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof createProject>,\n TError,\n { data: ProjectPostBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof createProject>,\n { data: ProjectPostBodyBody }\n > = (props) => {\n const { data } = props || {};\n\n return createProject(data, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof createProject>,\n TError,\n { data: ProjectPostBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Gets the details of a project that is available to you.\n\n * @summary Get a project\n */\nexport const getProject = (\n projectId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<ProjectGetResponse>(\n { url: `/project/${projectId}`, method: \"get\" },\n options\n );\n};\n\nexport const getGetProjectQueryKey = (projectId: string) => [\n `/project/${projectId}`,\n];\n\nexport type GetProjectQueryResult = NonNullable<\n AsyncReturnType<typeof getProject>\n>;\nexport type GetProjectQueryError = ErrorType<void | DmError>;\n\nexport const useGetProject = <\n TData = AsyncReturnType<typeof getProject>,\n TError = ErrorType<void | DmError>\n>(\n projectId: string,\n options?: {\n query?: UseQueryOptions<AsyncReturnType<typeof getProject>, TError, TData>;\n request?: SecondParameter<typeof customInstance>;\n }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options || {};\n\n const queryKey = queryOptions?.queryKey ?? getGetProjectQueryKey(projectId);\n\n const queryFn: QueryFunction<AsyncReturnType<typeof getProject>> = () =>\n getProject(projectId, requestOptions);\n\n const query = useQuery<AsyncReturnType<typeof getProject>, TError, TData>(\n queryKey,\n queryFn,\n { enabled: !!projectId, ...queryOptions }\n );\n\n return {\n queryKey,\n ...query,\n };\n};\n\n/**\n * Used to update some adjustable parameters of a project, i.e. to make it Private or make it Public. What can be adjusted will depend on the purchased product\n\n * @summary Adjust an existing project\n */\nexport const patchProject = (\n projectId: string,\n projectPatchBodyBody: ProjectPatchBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n if (projectPatchBodyBody.private !== undefined) {\n formData.append(\"private\", projectPatchBodyBody.private.toString());\n }\n if (projectPatchBodyBody.name !== undefined) {\n formData.append(\"name\", projectPatchBodyBody.name);\n }\n\n return customInstance<void>(\n {\n url: `/project/${projectId}`,\n method: \"patch\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type PatchProjectMutationResult = NonNullable<\n AsyncReturnType<typeof patchProject>\n>;\nexport type PatchProjectMutationBody = ProjectPatchBodyBody;\nexport type PatchProjectMutationError = ErrorType<DmError>;\n\nexport const usePatchProject = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof patchProject>,\n TError,\n { projectId: string; data: ProjectPatchBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof patchProject>,\n { projectId: string; data: ProjectPatchBodyBody }\n > = (props) => {\n const { projectId, data } = props || {};\n\n return patchProject(projectId, data, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof patchProject>,\n TError,\n { projectId: string; data: ProjectPatchBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes an existing project.\n\nYou must be an `editor` or the `owner` of the project.\n\nOnce deleted all **Files**, working directories and material in the project will also be removed\n\n * @summary Delete a project\n */\nexport const deleteProject = (\n projectId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<ProjectDeleteResponse>(\n { url: `/project/${projectId}`, method: \"delete\" },\n options\n );\n};\n\nexport type DeleteProjectMutationResult = NonNullable<\n AsyncReturnType<typeof deleteProject>\n>;\n\nexport type DeleteProjectMutationError = ErrorType<void | DmError>;\n\nexport const useDeleteProject = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof deleteProject>,\n TError,\n { projectId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof deleteProject>,\n { projectId: string }\n > = (props) => {\n const { projectId } = props || {};\n\n return deleteProject(projectId, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof deleteProject>,\n TError,\n { projectId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Adds a user to a project as an `editor`. Editors can add and remove datasets in a project and delete the project.\n\nAn `editor` of a project is not automatically an `editor` of any datasets the project contains.\n\nYou must be an `editor` or the `owner` of the project\n\n * @summary Add a project editor\n */\nexport const addEditorToProject = (\n projectId: string,\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/project/${projectId}/editor/${userId}`, method: \"put\" },\n options\n );\n};\n\nexport type AddEditorToProjectMutationResult = NonNullable<\n AsyncReturnType<typeof addEditorToProject>\n>;\n\nexport type AddEditorToProjectMutationError = ErrorType<DmError>;\n\nexport const useAddEditorToProject = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof addEditorToProject>,\n TError,\n { projectId: string; userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof addEditorToProject>,\n { projectId: string; userId: string }\n > = (props) => {\n const { projectId, userId } = props || {};\n\n return addEditorToProject(projectId, userId, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof addEditorToProject>,\n TError,\n { projectId: string; userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes a project `editor`. The editor can be you but you cannot delete the last `editor`\n\nA project must always have one `editor` so you will not be able to delete the last editor of a project.\n\nYou must be an `editor` or the `owner` of the project\n\n * @summary Delete a project editor\n */\nexport const removeEditorFromProject = (\n projectId: string,\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/project/${projectId}/editor/${userId}`, method: \"delete\" },\n options\n );\n};\n\nexport type RemoveEditorFromProjectMutationResult = NonNullable<\n AsyncReturnType<typeof removeEditorFromProject>\n>;\n\nexport type RemoveEditorFromProjectMutationError = ErrorType<DmError>;\n\nexport const useRemoveEditorFromProject = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof removeEditorFromProject>,\n TError,\n { projectId: string; userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof removeEditorFromProject>,\n { projectId: string; userId: string }\n > = (props) => {\n const { projectId, userId } = props || {};\n\n return removeEditorFromProject(projectId, userId, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof removeEditorFromProject>,\n TError,\n { projectId: string; userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Gets a file from the project, with an optional path. This method should be used to get arbitrary files from the Project's file system (typically **unmanaged** files).\n\nFor **managed** files you should consider using the `/file/{file_id}` endpoint.\n\nYou must be an `editor` or the `owner` of the project if the project is private\n\n * @summary Download a project file\n */\nexport const getProjectFile = (\n projectId: string,\n params?: GetProjectFileParams,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/project/${projectId}/file`, method: \"get\", params },\n options\n );\n};\n\nexport const getGetProjectFileQueryKey = (\n projectId: string,\n params?: GetProjectFileParams\n) => [`/project/${projectId}/file`, ...(params ? [params] : [])];\n\nexport type GetProjectFileQueryResult = NonNullable<\n AsyncReturnType<typeof getProjectFile>\n>;\nexport type GetProjectFileQueryError = ErrorType<DmError>;\n\nexport const useGetProjectFile = <\n TData = AsyncReturnType<typeof getProjectFile>,\n TError = ErrorType<DmError>\n>(\n projectId: string,\n params?: GetProjectFileParams,\n options?: {\n query?: UseQueryOptions<\n AsyncReturnType<typeof getProjectFile>,\n TError,\n TData\n >;\n request?: SecondParameter<typeof customInstance>;\n }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options || {};\n\n const queryKey =\n queryOptions?.queryKey ?? getGetProjectFileQueryKey(projectId, params);\n\n const queryFn: QueryFunction<AsyncReturnType<typeof getProjectFile>> = () =>\n getProjectFile(projectId, params, requestOptions);\n\n const query = useQuery<AsyncReturnType<typeof getProjectFile>, TError, TData>(\n queryKey,\n queryFn,\n { enabled: !!projectId, ...queryOptions }\n );\n\n return {\n queryKey,\n ...query,\n };\n};\n\n/**\n * The user provides an external file for upload to the Project using an optional Path. The path is created if it does not exist.\n\nYou must be an `editor` or the `owner` of the project\n\n * @summary Upload a file into a Project\n */\nexport const addFileToProject = (\n projectId: string,\n projectFilePutBodyBody: ProjectFilePutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"file\", projectFilePutBodyBody.file);\n if (projectFilePutBodyBody.as_filename !== undefined) {\n formData.append(\"as_filename\", projectFilePutBodyBody.as_filename);\n }\n if (projectFilePutBodyBody.path !== undefined) {\n formData.append(\"path\", projectFilePutBodyBody.path);\n }\n\n return customInstance<void>(\n {\n url: `/project/${projectId}/file`,\n method: \"put\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AddFileToProjectMutationResult = NonNullable<\n AsyncReturnType<typeof addFileToProject>\n>;\nexport type AddFileToProjectMutationBody = ProjectFilePutBodyBody;\nexport type AddFileToProjectMutationError = ErrorType<DmError>;\n\nexport const useAddFileToProject = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof addFileToProject>,\n TError,\n { projectId: string; data: ProjectFilePutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof addFileToProject>,\n { projectId: string; data: ProjectFilePutBodyBody }\n > = (props) => {\n const { projectId, data } = props || {};\n\n return addFileToProject(projectId, data, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof addFileToProject>,\n TError,\n { projectId: string; data: ProjectFilePutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n"]}
|
package/project/project.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import { bb as customInstance, aF as ProjectsGetResponse, bc as ErrorType, b7 as DmError, H as ProjectPostBodyBody, aG as ProjectPostResponse, a8 as ProjectDetail, I as ProjectPatchBodyBody, a2 as TaskIdentity, g as GetProjectFileParams, J as ProjectFilePutBodyBody } from '../custom-instance-
|
|
1
|
+
import { bb as customInstance, aF as ProjectsGetResponse, bc as ErrorType, b7 as DmError, H as ProjectPostBodyBody, aG as ProjectPostResponse, a8 as ProjectDetail, I as ProjectPatchBodyBody, a2 as TaskIdentity, g as GetProjectFileParams, J as ProjectFilePutBodyBody } from '../custom-instance-42e56f26.js';
|
|
2
2
|
import * as react_query from 'react-query';
|
|
3
3
|
import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
|
|
4
4
|
import 'axios';
|
|
5
5
|
|
|
6
|
+
declare type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (...args: any) => Promise<infer R> ? R : any;
|
|
6
7
|
declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
|
|
7
8
|
/**
|
|
8
9
|
* Get a list of all projects available to you.
|
|
@@ -11,6 +12,8 @@ declare type SecondParameter<T extends (...args: any) => any> = T extends (confi
|
|
|
11
12
|
*/
|
|
12
13
|
declare const getProjects: (options?: SecondParameter<typeof customInstance>) => Promise<ProjectsGetResponse>;
|
|
13
14
|
declare const getGetProjectsQueryKey: () => string[];
|
|
15
|
+
declare type GetProjectsQueryResult = NonNullable<AsyncReturnType<typeof getProjects>>;
|
|
16
|
+
declare type GetProjectsQueryError = ErrorType<void | DmError>;
|
|
14
17
|
declare const useGetProjects: <TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(options?: {
|
|
15
18
|
query?: UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey> | undefined;
|
|
16
19
|
request?: SecondParameter<typeof customInstance>;
|
|
@@ -29,6 +32,9 @@ The name you give the project is free-form text (can contain spaces etc.). The n
|
|
|
29
32
|
* @summary Create a new project
|
|
30
33
|
*/
|
|
31
34
|
declare const createProject: (projectPostBodyBody: ProjectPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<ProjectPostResponse>;
|
|
35
|
+
declare type CreateProjectMutationResult = NonNullable<AsyncReturnType<typeof createProject>>;
|
|
36
|
+
declare type CreateProjectMutationBody = ProjectPostBodyBody;
|
|
37
|
+
declare type CreateProjectMutationError = ErrorType<DmError | void>;
|
|
32
38
|
declare const useCreateProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
33
39
|
mutation?: UseMutationOptions<ProjectPostResponse, TError, {
|
|
34
40
|
data: ProjectPostBodyBody;
|
|
@@ -42,9 +48,11 @@ declare const useCreateProject: <TError = ErrorType<void | DmError>, TContext =
|
|
|
42
48
|
|
|
43
49
|
* @summary Get a project
|
|
44
50
|
*/
|
|
45
|
-
declare const getProject: (
|
|
46
|
-
declare const getGetProjectQueryKey: (
|
|
47
|
-
declare
|
|
51
|
+
declare const getProject: (projectId: string, options?: SecondParameter<typeof customInstance>) => Promise<ProjectDetail>;
|
|
52
|
+
declare const getGetProjectQueryKey: (projectId: string) => string[];
|
|
53
|
+
declare type GetProjectQueryResult = NonNullable<AsyncReturnType<typeof getProject>>;
|
|
54
|
+
declare type GetProjectQueryError = ErrorType<void | DmError>;
|
|
55
|
+
declare const useGetProject: <TData = ProjectDetail, TError = ErrorType<void | DmError>>(projectId: string, options?: {
|
|
48
56
|
query?: UseQueryOptions<ProjectDetail, TError, TData, QueryKey> | undefined;
|
|
49
57
|
request?: SecondParameter<typeof customInstance>;
|
|
50
58
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
@@ -55,15 +63,18 @@ declare const useGetProject: <TData = ProjectDetail, TError = ErrorType<void | D
|
|
|
55
63
|
|
|
56
64
|
* @summary Adjust an existing project
|
|
57
65
|
*/
|
|
58
|
-
declare const patchProject: (
|
|
66
|
+
declare const patchProject: (projectId: string, projectPatchBodyBody: ProjectPatchBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
67
|
+
declare type PatchProjectMutationResult = NonNullable<AsyncReturnType<typeof patchProject>>;
|
|
68
|
+
declare type PatchProjectMutationBody = ProjectPatchBodyBody;
|
|
69
|
+
declare type PatchProjectMutationError = ErrorType<DmError>;
|
|
59
70
|
declare const usePatchProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
|
|
60
71
|
mutation?: UseMutationOptions<void, TError, {
|
|
61
|
-
|
|
72
|
+
projectId: string;
|
|
62
73
|
data: ProjectPatchBodyBody;
|
|
63
74
|
}, TContext> | undefined;
|
|
64
75
|
request?: SecondParameter<typeof customInstance>;
|
|
65
76
|
} | undefined) => react_query.UseMutationResult<void, TError, {
|
|
66
|
-
|
|
77
|
+
projectId: string;
|
|
67
78
|
data: ProjectPatchBodyBody;
|
|
68
79
|
}, TContext>;
|
|
69
80
|
/**
|
|
@@ -75,14 +86,16 @@ Once deleted all **Files**, working directories and material in the project will
|
|
|
75
86
|
|
|
76
87
|
* @summary Delete a project
|
|
77
88
|
*/
|
|
78
|
-
declare const deleteProject: (
|
|
89
|
+
declare const deleteProject: (projectId: string, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
|
|
90
|
+
declare type DeleteProjectMutationResult = NonNullable<AsyncReturnType<typeof deleteProject>>;
|
|
91
|
+
declare type DeleteProjectMutationError = ErrorType<void | DmError>;
|
|
79
92
|
declare const useDeleteProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
80
93
|
mutation?: UseMutationOptions<TaskIdentity, TError, {
|
|
81
|
-
|
|
94
|
+
projectId: string;
|
|
82
95
|
}, TContext> | undefined;
|
|
83
96
|
request?: SecondParameter<typeof customInstance>;
|
|
84
97
|
} | undefined) => react_query.UseMutationResult<TaskIdentity, TError, {
|
|
85
|
-
|
|
98
|
+
projectId: string;
|
|
86
99
|
}, TContext>;
|
|
87
100
|
/**
|
|
88
101
|
* Adds a user to a project as an `editor`. Editors can add and remove datasets in a project and delete the project.
|
|
@@ -93,16 +106,18 @@ You must be an `editor` or the `owner` of the project
|
|
|
93
106
|
|
|
94
107
|
* @summary Add a project editor
|
|
95
108
|
*/
|
|
96
|
-
declare const addEditorToProject: (
|
|
109
|
+
declare const addEditorToProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
110
|
+
declare type AddEditorToProjectMutationResult = NonNullable<AsyncReturnType<typeof addEditorToProject>>;
|
|
111
|
+
declare type AddEditorToProjectMutationError = ErrorType<DmError>;
|
|
97
112
|
declare const useAddEditorToProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
|
|
98
113
|
mutation?: UseMutationOptions<void, TError, {
|
|
99
|
-
|
|
100
|
-
|
|
114
|
+
projectId: string;
|
|
115
|
+
userId: string;
|
|
101
116
|
}, TContext> | undefined;
|
|
102
117
|
request?: SecondParameter<typeof customInstance>;
|
|
103
118
|
} | undefined) => react_query.UseMutationResult<void, TError, {
|
|
104
|
-
|
|
105
|
-
|
|
119
|
+
projectId: string;
|
|
120
|
+
userId: string;
|
|
106
121
|
}, TContext>;
|
|
107
122
|
/**
|
|
108
123
|
* Deletes a project `editor`. The editor can be you but you cannot delete the last `editor`
|
|
@@ -113,16 +128,18 @@ You must be an `editor` or the `owner` of the project
|
|
|
113
128
|
|
|
114
129
|
* @summary Delete a project editor
|
|
115
130
|
*/
|
|
116
|
-
declare const removeEditorFromProject: (
|
|
131
|
+
declare const removeEditorFromProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
132
|
+
declare type RemoveEditorFromProjectMutationResult = NonNullable<AsyncReturnType<typeof removeEditorFromProject>>;
|
|
133
|
+
declare type RemoveEditorFromProjectMutationError = ErrorType<DmError>;
|
|
117
134
|
declare const useRemoveEditorFromProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
|
|
118
135
|
mutation?: UseMutationOptions<void, TError, {
|
|
119
|
-
|
|
120
|
-
|
|
136
|
+
projectId: string;
|
|
137
|
+
userId: string;
|
|
121
138
|
}, TContext> | undefined;
|
|
122
139
|
request?: SecondParameter<typeof customInstance>;
|
|
123
140
|
} | undefined) => react_query.UseMutationResult<void, TError, {
|
|
124
|
-
|
|
125
|
-
|
|
141
|
+
projectId: string;
|
|
142
|
+
userId: string;
|
|
126
143
|
}, TContext>;
|
|
127
144
|
/**
|
|
128
145
|
* Gets a file from the project, with an optional path. This method should be used to get arbitrary files from the Project's file system (typically **unmanaged** files).
|
|
@@ -133,9 +150,11 @@ You must be an `editor` or the `owner` of the project if the project is private
|
|
|
133
150
|
|
|
134
151
|
* @summary Download a project file
|
|
135
152
|
*/
|
|
136
|
-
declare const getProjectFile: (
|
|
137
|
-
declare const getGetProjectFileQueryKey: (
|
|
138
|
-
declare
|
|
153
|
+
declare const getProjectFile: (projectId: string, params?: GetProjectFileParams | undefined, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
154
|
+
declare const getGetProjectFileQueryKey: (projectId: string, params?: GetProjectFileParams | undefined) => (string | GetProjectFileParams)[];
|
|
155
|
+
declare type GetProjectFileQueryResult = NonNullable<AsyncReturnType<typeof getProjectFile>>;
|
|
156
|
+
declare type GetProjectFileQueryError = ErrorType<DmError>;
|
|
157
|
+
declare const useGetProjectFile: <TData = void, TError = ErrorType<DmError>>(projectId: string, params?: GetProjectFileParams | undefined, options?: {
|
|
139
158
|
query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
|
|
140
159
|
request?: SecondParameter<typeof customInstance>;
|
|
141
160
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
@@ -148,16 +167,19 @@ You must be an `editor` or the `owner` of the project
|
|
|
148
167
|
|
|
149
168
|
* @summary Upload a file into a Project
|
|
150
169
|
*/
|
|
151
|
-
declare const addFileToProject: (
|
|
170
|
+
declare const addFileToProject: (projectId: string, projectFilePutBodyBody: ProjectFilePutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
171
|
+
declare type AddFileToProjectMutationResult = NonNullable<AsyncReturnType<typeof addFileToProject>>;
|
|
172
|
+
declare type AddFileToProjectMutationBody = ProjectFilePutBodyBody;
|
|
173
|
+
declare type AddFileToProjectMutationError = ErrorType<DmError>;
|
|
152
174
|
declare const useAddFileToProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
|
|
153
175
|
mutation?: UseMutationOptions<void, TError, {
|
|
154
|
-
|
|
176
|
+
projectId: string;
|
|
155
177
|
data: ProjectFilePutBodyBody;
|
|
156
178
|
}, TContext> | undefined;
|
|
157
179
|
request?: SecondParameter<typeof customInstance>;
|
|
158
180
|
} | undefined) => react_query.UseMutationResult<void, TError, {
|
|
159
|
-
|
|
181
|
+
projectId: string;
|
|
160
182
|
data: ProjectFilePutBodyBody;
|
|
161
183
|
}, TContext>;
|
|
162
184
|
|
|
163
|
-
export { addEditorToProject, addFileToProject, createProject, deleteProject, getGetProjectFileQueryKey, getGetProjectQueryKey, getGetProjectsQueryKey, getProject, getProjectFile, getProjects, patchProject, removeEditorFromProject, useAddEditorToProject, useAddFileToProject, useCreateProject, useDeleteProject, useGetProject, useGetProjectFile, useGetProjects, usePatchProject, useRemoveEditorFromProject };
|
|
185
|
+
export { AddEditorToProjectMutationError, AddEditorToProjectMutationResult, AddFileToProjectMutationBody, AddFileToProjectMutationError, AddFileToProjectMutationResult, CreateProjectMutationBody, CreateProjectMutationError, CreateProjectMutationResult, DeleteProjectMutationError, DeleteProjectMutationResult, GetProjectFileQueryError, GetProjectFileQueryResult, GetProjectQueryError, GetProjectQueryResult, GetProjectsQueryError, GetProjectsQueryResult, PatchProjectMutationBody, PatchProjectMutationError, PatchProjectMutationResult, RemoveEditorFromProjectMutationError, RemoveEditorFromProjectMutationResult, addEditorToProject, addFileToProject, createProject, deleteProject, getGetProjectFileQueryKey, getGetProjectQueryKey, getGetProjectsQueryKey, getProject, getProjectFile, getProjects, patchProject, removeEditorFromProject, useAddEditorToProject, useAddFileToProject, useCreateProject, useDeleteProject, useGetProject, useGetProjectFile, useGetProjects, usePatchProject, useRemoveEditorFromProject };
|
package/project/project.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import {
|
|
2
2
|
__spreadValues,
|
|
3
3
|
customInstance
|
|
4
|
-
} from "../chunk-
|
|
4
|
+
} from "../chunk-6EEIAH4R.js";
|
|
5
5
|
|
|
6
6
|
// src/project/project.ts
|
|
7
7
|
import {
|
|
@@ -30,7 +30,12 @@ var createProject = (projectPostBodyBody, options) => {
|
|
|
30
30
|
formData.append("organisation_id", projectPostBodyBody.organisation_id);
|
|
31
31
|
formData.append("unit_id", projectPostBodyBody.unit_id);
|
|
32
32
|
formData.append("tier_product_id", projectPostBodyBody.tier_product_id);
|
|
33
|
-
return customInstance({
|
|
33
|
+
return customInstance({
|
|
34
|
+
url: `/project`,
|
|
35
|
+
method: "post",
|
|
36
|
+
headers: { "Content-Type": "multipart/form-data" },
|
|
37
|
+
data: formData
|
|
38
|
+
}, options);
|
|
34
39
|
};
|
|
35
40
|
var useCreateProject = (options) => {
|
|
36
41
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
@@ -40,22 +45,22 @@ var useCreateProject = (options) => {
|
|
|
40
45
|
};
|
|
41
46
|
return useMutation(mutationFn, mutationOptions);
|
|
42
47
|
};
|
|
43
|
-
var getProject = (
|
|
44
|
-
return customInstance({ url: `/project/${
|
|
48
|
+
var getProject = (projectId, options) => {
|
|
49
|
+
return customInstance({ url: `/project/${projectId}`, method: "get" }, options);
|
|
45
50
|
};
|
|
46
|
-
var getGetProjectQueryKey = (
|
|
47
|
-
`/project/${
|
|
51
|
+
var getGetProjectQueryKey = (projectId) => [
|
|
52
|
+
`/project/${projectId}`
|
|
48
53
|
];
|
|
49
|
-
var useGetProject = (
|
|
54
|
+
var useGetProject = (projectId, options) => {
|
|
50
55
|
const { query: queryOptions, request: requestOptions } = options || {};
|
|
51
|
-
const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetProjectQueryKey(
|
|
52
|
-
const queryFn = () => getProject(
|
|
53
|
-
const query = useQuery(queryKey, queryFn, __spreadValues({ enabled: !!
|
|
56
|
+
const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetProjectQueryKey(projectId);
|
|
57
|
+
const queryFn = () => getProject(projectId, requestOptions);
|
|
58
|
+
const query = useQuery(queryKey, queryFn, __spreadValues({ enabled: !!projectId }, queryOptions));
|
|
54
59
|
return __spreadValues({
|
|
55
60
|
queryKey
|
|
56
61
|
}, query);
|
|
57
62
|
};
|
|
58
|
-
var patchProject = (
|
|
63
|
+
var patchProject = (projectId, projectPatchBodyBody, options) => {
|
|
59
64
|
const formData = new FormData();
|
|
60
65
|
if (projectPatchBodyBody.private !== void 0) {
|
|
61
66
|
formData.append("private", projectPatchBodyBody.private.toString());
|
|
@@ -63,63 +68,68 @@ var patchProject = (projectid, projectPatchBodyBody, options) => {
|
|
|
63
68
|
if (projectPatchBodyBody.name !== void 0) {
|
|
64
69
|
formData.append("name", projectPatchBodyBody.name);
|
|
65
70
|
}
|
|
66
|
-
return customInstance({
|
|
71
|
+
return customInstance({
|
|
72
|
+
url: `/project/${projectId}`,
|
|
73
|
+
method: "patch",
|
|
74
|
+
headers: { "Content-Type": "multipart/form-data" },
|
|
75
|
+
data: formData
|
|
76
|
+
}, options);
|
|
67
77
|
};
|
|
68
78
|
var usePatchProject = (options) => {
|
|
69
79
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
70
80
|
const mutationFn = (props) => {
|
|
71
|
-
const {
|
|
72
|
-
return patchProject(
|
|
81
|
+
const { projectId, data } = props || {};
|
|
82
|
+
return patchProject(projectId, data, requestOptions);
|
|
73
83
|
};
|
|
74
84
|
return useMutation(mutationFn, mutationOptions);
|
|
75
85
|
};
|
|
76
|
-
var deleteProject = (
|
|
77
|
-
return customInstance({ url: `/project/${
|
|
86
|
+
var deleteProject = (projectId, options) => {
|
|
87
|
+
return customInstance({ url: `/project/${projectId}`, method: "delete" }, options);
|
|
78
88
|
};
|
|
79
89
|
var useDeleteProject = (options) => {
|
|
80
90
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
81
91
|
const mutationFn = (props) => {
|
|
82
|
-
const {
|
|
83
|
-
return deleteProject(
|
|
92
|
+
const { projectId } = props || {};
|
|
93
|
+
return deleteProject(projectId, requestOptions);
|
|
84
94
|
};
|
|
85
95
|
return useMutation(mutationFn, mutationOptions);
|
|
86
96
|
};
|
|
87
|
-
var addEditorToProject = (
|
|
88
|
-
return customInstance({ url: `/project/${
|
|
97
|
+
var addEditorToProject = (projectId, userId, options) => {
|
|
98
|
+
return customInstance({ url: `/project/${projectId}/editor/${userId}`, method: "put" }, options);
|
|
89
99
|
};
|
|
90
100
|
var useAddEditorToProject = (options) => {
|
|
91
101
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
92
102
|
const mutationFn = (props) => {
|
|
93
|
-
const {
|
|
94
|
-
return addEditorToProject(
|
|
103
|
+
const { projectId, userId } = props || {};
|
|
104
|
+
return addEditorToProject(projectId, userId, requestOptions);
|
|
95
105
|
};
|
|
96
106
|
return useMutation(mutationFn, mutationOptions);
|
|
97
107
|
};
|
|
98
|
-
var removeEditorFromProject = (
|
|
99
|
-
return customInstance({ url: `/project/${
|
|
108
|
+
var removeEditorFromProject = (projectId, userId, options) => {
|
|
109
|
+
return customInstance({ url: `/project/${projectId}/editor/${userId}`, method: "delete" }, options);
|
|
100
110
|
};
|
|
101
111
|
var useRemoveEditorFromProject = (options) => {
|
|
102
112
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
103
113
|
const mutationFn = (props) => {
|
|
104
|
-
const {
|
|
105
|
-
return removeEditorFromProject(
|
|
114
|
+
const { projectId, userId } = props || {};
|
|
115
|
+
return removeEditorFromProject(projectId, userId, requestOptions);
|
|
106
116
|
};
|
|
107
117
|
return useMutation(mutationFn, mutationOptions);
|
|
108
118
|
};
|
|
109
|
-
var getProjectFile = (
|
|
110
|
-
return customInstance({ url: `/project/${
|
|
119
|
+
var getProjectFile = (projectId, params, options) => {
|
|
120
|
+
return customInstance({ url: `/project/${projectId}/file`, method: "get", params }, options);
|
|
111
121
|
};
|
|
112
|
-
var getGetProjectFileQueryKey = (
|
|
113
|
-
var useGetProjectFile = (
|
|
122
|
+
var getGetProjectFileQueryKey = (projectId, params) => [`/project/${projectId}/file`, ...params ? [params] : []];
|
|
123
|
+
var useGetProjectFile = (projectId, params, options) => {
|
|
114
124
|
const { query: queryOptions, request: requestOptions } = options || {};
|
|
115
|
-
const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetProjectFileQueryKey(
|
|
116
|
-
const queryFn = () => getProjectFile(
|
|
117
|
-
const query = useQuery(queryKey, queryFn, __spreadValues({ enabled: !!
|
|
125
|
+
const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetProjectFileQueryKey(projectId, params);
|
|
126
|
+
const queryFn = () => getProjectFile(projectId, params, requestOptions);
|
|
127
|
+
const query = useQuery(queryKey, queryFn, __spreadValues({ enabled: !!projectId }, queryOptions));
|
|
118
128
|
return __spreadValues({
|
|
119
129
|
queryKey
|
|
120
130
|
}, query);
|
|
121
131
|
};
|
|
122
|
-
var addFileToProject = (
|
|
132
|
+
var addFileToProject = (projectId, projectFilePutBodyBody, options) => {
|
|
123
133
|
const formData = new FormData();
|
|
124
134
|
formData.append("file", projectFilePutBodyBody.file);
|
|
125
135
|
if (projectFilePutBodyBody.as_filename !== void 0) {
|
|
@@ -128,13 +138,18 @@ var addFileToProject = (projectid, projectFilePutBodyBody, options) => {
|
|
|
128
138
|
if (projectFilePutBodyBody.path !== void 0) {
|
|
129
139
|
formData.append("path", projectFilePutBodyBody.path);
|
|
130
140
|
}
|
|
131
|
-
return customInstance({
|
|
141
|
+
return customInstance({
|
|
142
|
+
url: `/project/${projectId}/file`,
|
|
143
|
+
method: "put",
|
|
144
|
+
headers: { "Content-Type": "multipart/form-data" },
|
|
145
|
+
data: formData
|
|
146
|
+
}, options);
|
|
132
147
|
};
|
|
133
148
|
var useAddFileToProject = (options) => {
|
|
134
149
|
const { mutation: mutationOptions, request: requestOptions } = options || {};
|
|
135
150
|
const mutationFn = (props) => {
|
|
136
|
-
const {
|
|
137
|
-
return addFileToProject(
|
|
151
|
+
const { projectId, data } = props || {};
|
|
152
|
+
return addFileToProject(projectId, data, requestOptions);
|
|
138
153
|
};
|
|
139
154
|
return useMutation(mutationFn, mutationOptions);
|
|
140
155
|
};
|