@mapcreator/api 0.0.0-co-edit.8 → 0.0.0-json-object.1

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 (58) hide show
  1. package/LICENSE +29 -29
  2. package/README.md +86 -86
  3. package/cjs/api/apiCommon.d.ts +1 -3
  4. package/cjs/api/apiCommon.d.ts.map +1 -1
  5. package/cjs/api/apiCommon.js +13 -6
  6. package/cjs/api/apiCommon.js.map +1 -1
  7. package/cjs/api/job.d.ts +13 -50
  8. package/cjs/api/job.d.ts.map +1 -1
  9. package/cjs/api/job.js +4 -42
  10. package/cjs/api/job.js.map +1 -1
  11. package/cjs/api/jobRevision.d.ts +4 -1
  12. package/cjs/api/jobRevision.d.ts.map +1 -1
  13. package/cjs/api/jobRevision.js +38 -1
  14. package/cjs/api/jobRevision.js.map +1 -1
  15. package/cjs/api/organisation.d.ts +2 -2
  16. package/cjs/api/organisation.d.ts.map +1 -1
  17. package/cjs/api/organisation.js +3 -2
  18. package/cjs/api/organisation.js.map +1 -1
  19. package/cjs/api/resources.d.ts +1 -23
  20. package/cjs/api/resources.d.ts.map +1 -1
  21. package/cjs/api/resources.js +0 -2
  22. package/cjs/api/resources.js.map +1 -1
  23. package/cjs/api/user.d.ts +18 -5
  24. package/cjs/api/user.d.ts.map +1 -1
  25. package/cjs/api/user.js +5 -9
  26. package/cjs/api/user.js.map +1 -1
  27. package/esm/api/apiCommon.d.ts +1 -3
  28. package/esm/api/apiCommon.d.ts.map +1 -1
  29. package/esm/api/apiCommon.js +13 -6
  30. package/esm/api/apiCommon.js.map +1 -1
  31. package/esm/api/job.d.ts +13 -50
  32. package/esm/api/job.d.ts.map +1 -1
  33. package/esm/api/job.js +4 -33
  34. package/esm/api/job.js.map +1 -1
  35. package/esm/api/jobRevision.d.ts +4 -1
  36. package/esm/api/jobRevision.d.ts.map +1 -1
  37. package/esm/api/jobRevision.js +36 -1
  38. package/esm/api/jobRevision.js.map +1 -1
  39. package/esm/api/organisation.d.ts +2 -2
  40. package/esm/api/organisation.d.ts.map +1 -1
  41. package/esm/api/organisation.js +3 -2
  42. package/esm/api/organisation.js.map +1 -1
  43. package/esm/api/resources.d.ts +1 -23
  44. package/esm/api/resources.d.ts.map +1 -1
  45. package/esm/api/resources.js +0 -2
  46. package/esm/api/resources.js.map +1 -1
  47. package/esm/api/user.d.ts +18 -5
  48. package/esm/api/user.d.ts.map +1 -1
  49. package/esm/api/user.js +4 -7
  50. package/esm/api/user.js.map +1 -1
  51. package/package.json +81 -81
  52. package/src/README.md +126 -126
  53. package/src/api/apiCommon.ts +16 -21
  54. package/src/api/job.ts +18 -87
  55. package/src/api/jobRevision.ts +51 -1
  56. package/src/api/organisation.ts +6 -6
  57. package/src/api/resources.ts +1 -32
  58. package/src/api/user.ts +27 -21
package/src/api/user.ts CHANGED
@@ -2,9 +2,8 @@ import { type ApiFontFamilyData, type FontFamily, fontFamilyRevivers } from './f
2
2
  import { type ApiSvgSetData, type SvgSet, svgSetRevivers } from './svgSet.js';
3
3
  import { type ApiLayerData, type Layer, layerRevivers } from './layer.js';
4
4
  import { type ApiSvgData, type Svg, svgRevivers } from './svg.js';
5
- import { type DashboardFilterType, type DashboardSortType, type JobSearchResult, listJobs } from './apiCommon.js';
5
+ import { type JobSearchResult, listJobs } from './apiCommon.js';
6
6
  import type { ApiJobShareArray, JobShare } from './jobShare.js';
7
- import type { AccessibleOrganisation, ApiAccessibleOrganisation, JobFolder } from './resources.js';
8
7
  import type { RequireAtLeastOne } from 'type-fest';
9
8
  import {
10
9
  type ApiCommon,
@@ -104,6 +103,24 @@ export type ApiUser = {
104
103
  /* eslint-enable @typescript-eslint/no-redundant-type-constituents */
105
104
  export type ApiUserData = Flatten<Exclude<ApiUser, ApiError>['data']>;
106
105
 
106
+ export type JobFolder = {
107
+ id: number;
108
+ jobsCount: number;
109
+ name: string;
110
+ userId: number;
111
+ };
112
+
113
+ export type ApiJobFolder = {
114
+ data: {
115
+ id: number;
116
+ jobsCount: number;
117
+ name: string;
118
+ userId: number;
119
+ } & ApiCommonData;
120
+ } & Omit<ApiSuccess, 'data'> | ApiError;
121
+
122
+ export type ApiJobFolderData = Flatten<Exclude<ApiJobFolder, ApiError>['data']>;
123
+
107
124
  export const userRevivers: Revivers<ApiUser, User> = {
108
125
  hide_messages: undefined,
109
126
  phone: undefined,
@@ -193,32 +210,21 @@ export async function listUserHatchingSvgs(): Promise<Svg[]> {
193
210
 
194
211
  export async function listUserJobs(
195
212
  userId: number | typeof myUser,
196
- search: string,
197
- sort: DashboardSortType,
198
- filter: DashboardFilterType,
213
+ title: string,
199
214
  page: number,
215
+ options?: Record<string, unknown>
200
216
  ): Promise<JobSearchResult> {
201
- return listJobs(`/v1/users/${userId}/jobs`, search, sort, filter, page);
217
+ return listJobs(`/v1/users/${userId}/jobs`, title, page, options);
202
218
  }
203
219
 
204
- export async function listUserEditedJobs(
205
- userId: number | typeof myUser,
206
- search: string,
207
- sort: DashboardSortType,
208
- filter: DashboardFilterType,
209
- page: number,
210
- ): Promise<JobSearchResult> {
211
- return listJobs(`/v1/users/${userId}/edited-jobs`, search, sort, filter, page);
212
- }
213
-
214
- export async function listUserAccessibleOrganisations(): Promise<AccessibleOrganisation[]> {
215
- const path = `/v1/users/${myUser}/accessible-organisations`;
220
+ export async function listUserFolders(): Promise<JobFolder[]> {
221
+ const path = `/v1/users/${myUser}/folders`;
216
222
 
217
- type ApiAccessibleOrganisationArray = {
218
- data: ApiAccessibleOrganisation[];
223
+ type ApiJobFolderArray = {
224
+ data: ApiJobFolderData[];
219
225
  } & Omit<ApiSuccess, 'data'> | ApiError;
220
226
 
221
- return request<ApiAccessibleOrganisationArray, AccessibleOrganisation>(path);
227
+ return request<ApiJobFolderArray, JobFolder>(path);
222
228
  }
223
229
 
224
230
  export async function createUserFolder(name: string): Promise<JobFolder> {