@mapcreator/api 5.0.0-alpha.90 → 5.0.0-alpha.91
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/LICENSE +29 -29
- package/README.md +86 -86
- package/cjs/api/job.d.ts +1 -1
- package/cjs/api/job.d.ts.map +1 -1
- package/cjs/api/job.js +2 -2
- package/cjs/api/job.js.map +1 -1
- package/cjs/api/jobRevision.d.ts +1 -1
- package/cjs/api/jobRevision.d.ts.map +1 -1
- package/cjs/api/jobRevision.js +3 -4
- package/cjs/api/jobRevision.js.map +1 -1
- package/cjs/api/organisation.d.ts +1 -1
- package/cjs/api/organisation.d.ts.map +1 -1
- package/cjs/api/organisation.js +2 -2
- package/cjs/api/organisation.js.map +1 -1
- package/cjs/api/user.d.ts +2 -1
- package/cjs/api/user.d.ts.map +1 -1
- package/cjs/api/user.js +2 -3
- package/cjs/api/user.js.map +1 -1
- package/esm/api/job.d.ts +1 -1
- package/esm/api/job.d.ts.map +1 -1
- package/esm/api/job.js +2 -2
- package/esm/api/job.js.map +1 -1
- package/esm/api/jobRevision.d.ts +1 -1
- package/esm/api/jobRevision.d.ts.map +1 -1
- package/esm/api/jobRevision.js +3 -4
- package/esm/api/jobRevision.js.map +1 -1
- package/esm/api/organisation.d.ts +1 -1
- package/esm/api/organisation.d.ts.map +1 -1
- package/esm/api/organisation.js +2 -2
- package/esm/api/organisation.js.map +1 -1
- package/esm/api/user.d.ts +2 -1
- package/esm/api/user.d.ts.map +1 -1
- package/esm/api/user.js +2 -3
- package/esm/api/user.js.map +1 -1
- package/package.json +80 -80
- package/src/README.md +126 -126
- package/src/api/job.ts +2 -2
- package/src/api/jobRevision.ts +2 -4
- package/src/api/organisation.ts +4 -2
- package/src/api/user.ts +3 -3
package/esm/api/jobRevision.js
CHANGED
|
@@ -4,7 +4,7 @@ import { APIError, HTTPError, NetworkError, defaultListHeader, deletedNoneParam,
|
|
|
4
4
|
export const jobRevisionRevivers = {
|
|
5
5
|
archived: undefined,
|
|
6
6
|
};
|
|
7
|
-
export async function createJobRevision(jobId, languageCode, mapstyleSetId, layers, output, jobObject
|
|
7
|
+
export async function createJobRevision(jobId, languageCode, mapstyleSetId, layers, output, jobObject) {
|
|
8
8
|
const pathname = `/v1/jobs/${jobId}/revisions`;
|
|
9
9
|
const path = `${pathname}?${deletedNoneParam}`;
|
|
10
10
|
const body = {
|
|
@@ -13,7 +13,6 @@ export async function createJobRevision(jobId, languageCode, mapstyleSetId, laye
|
|
|
13
13
|
object: JSON.stringify(jobObject),
|
|
14
14
|
output,
|
|
15
15
|
layers,
|
|
16
|
-
skip_validation: skipValidation !== null && skipValidation !== void 0 ? skipValidation : false
|
|
17
16
|
};
|
|
18
17
|
const options = { revivers: jobRevisionRevivers };
|
|
19
18
|
return request(path, body, null, options);
|
|
@@ -111,9 +110,9 @@ export async function getJobRevisionOutput(jobId) {
|
|
|
111
110
|
throw new HTTPError(response);
|
|
112
111
|
}
|
|
113
112
|
}
|
|
114
|
-
async function createJobRevisionBuild(jobId
|
|
113
|
+
async function createJobRevisionBuild(jobId) {
|
|
115
114
|
const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/build`;
|
|
116
115
|
const path = `${pathname}?${deletedNoneParam}`;
|
|
117
|
-
return request(path,
|
|
116
|
+
return request(path, null, null, { method: 'POST' });
|
|
118
117
|
}
|
|
119
118
|
//# sourceMappingURL=jobRevision.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jobRevision.js","sourceRoot":"","sources":["../../src/api/jobRevision.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpF,OAAO,EAAiC,aAAa,EAAE,MAAM,YAAY,CAAC;AAG1E,OAAO,EACL,QAAQ,EAMR,SAAS,EACT,YAAY,EAEZ,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,OAAO,GACR,MAAM,aAAa,CAAC;AA2CrB,MAAM,CAAC,MAAM,mBAAmB,GAA0C;IACxE,QAAQ,EAAE,SAAS;CACpB,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,KAAa,EACb,YAAoB,EACpB,aAAqB,EACrB,MAAgB,EAChB,MAAkB,EAClB,SAAkC
|
|
1
|
+
{"version":3,"file":"jobRevision.js","sourceRoot":"","sources":["../../src/api/jobRevision.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpF,OAAO,EAAiC,aAAa,EAAE,MAAM,YAAY,CAAC;AAG1E,OAAO,EACL,QAAQ,EAMR,SAAS,EACT,YAAY,EAEZ,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,OAAO,GACR,MAAM,aAAa,CAAC;AA2CrB,MAAM,CAAC,MAAM,mBAAmB,GAA0C;IACxE,QAAQ,EAAE,SAAS;CACpB,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,KAAa,EACb,YAAoB,EACpB,aAAqB,EACrB,MAAgB,EAChB,MAAkB,EAClB,SAAkC;IAElC,MAAM,QAAQ,GAAG,YAAY,KAAK,YAAY,CAAC;IAC/C,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,gBAAgB,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG;QACX,aAAa,EAAE,YAAY;QAC3B,eAAe,EAAE,aAAa;QAC9B,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;QACjC,MAAM;QACN,MAAM;KACP,CAAC;IACF,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAElD,OAAO,OAAO,CAA8B,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,KAAa;IAChD,MAAM,IAAI,GAAG,YAAY,KAAK,cAAc,eAAe,EAAE,CAAC;IAC9D,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAElD,OAAO,OAAO,CAA8B,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;AAChG,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAY,KAAa;IACjE,MAAM,QAAQ,GAAG,YAAY,KAAK,cAAc,eAAe,SAAS,CAAC;IACzE,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,gBAAgB,EAAE,CAAC;IAE/C,OAAO,OAAO,CAAoB,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAuB,CAAC;AACjF,CAAC;AAgBD,6BAA6B;AAC7B,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,KAAa;IACrD,MAAM,QAAQ,GAAG,YAAY,KAAK,cAAc,eAAe,QAAQ,CAAC;IACxE,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,gBAAgB,EAAE,CAAC;IAE/C,OAAO,OAAO,CAA8B,IAAI,CAAC,CAAC;AACpD,CAAC;AAwBD,MAAM,CAAC,MAAM,wBAAwB,GAAoD;IACvF,eAAe,EAAE,SAAS;IAC1B,aAAa,EAAE,SAAS;IACxB,WAAW,EAAE,SAAS;IACtB,eAAe,EAAE,SAAS;IAC1B,MAAM,EAAE,SAAS;IACjB,YAAY,EAAE,SAAS;CACxB,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,KAAa,EACb,MAAc,EACd,KAAW,EACX,GAAS;IAET,MAAM,QAAQ,GAAG,YAAY,KAAK,cAAc,eAAe,iBAAiB,CAAC;IACjF,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,gBAAgB,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC;IAChE,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,wBAAwB,EAAE,CAAC;IAEvD,OAAO,OAAO,CAAwC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACnF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,KAAa,EAAE,QAAiB;IACrE,MAAM,QAAQ,GAAG,YAAY,KAAK,cAAc,eAAe,QAAQ,CAAC;IACxE,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,gBAAgB,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,IAAI,EAAE,CAAC;IACzC,MAAM,OAAO,GAAG;QACd,QAAQ,kCACH,mBAAmB,KACtB,MAAM,EAAE,SAAS,EACjB,QAAQ,EAAE,SAAS,EACnB,YAAY,EAAE,SAAS,GACxB;KACF,CAAC;IAUF,OAAO,OAAO,CAAsC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACjF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,KAAa;IACvD,MAAM,IAAI,GAAG,YAAY,KAAK,cAAc,eAAe,SAAS,CAAC;IACrE,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;IAM5C,OAAO,OAAO,CAAuB,IAAI,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;AAC/E,CAAC;AAQD,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,KAAa;IACzD,MAAM,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAEpC,MAAM,IAAI,GAAG,YAAY,KAAK,cAAc,eAAe,oBAAoB,CAAC;IAEhF,OAAO,OAAO,CAAgD,IAAI,CAAC,CAAC;AACtE,CAAC;AAID,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,KAAa;IACtD,MAAM,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAEpC,MAAM,IAAI,GAAG,GAAG,OAAO,YAAY,KAAK,cAAc,eAAe,gBAAgB,CAAC;IACtF,MAAM,OAAO,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,kBAAI,OAAO,IAAK,CAAC,KAAK,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,EAAG;SACrF,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE,WAAG,MAAM,IAAI,YAAY,CAAC,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,mCAAI,KAAK,CAAC,CAAA,CAAC,CAAC,CAAC,CAAC;IAEhF,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;QAChB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE;YAC5C,MAAM,IAAI,QAAQ,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAC;QAC3G,CAAC,CAAC,CAAC;QACH,MAAM,kBAAkB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAEvE,IAAI,kBAAkB,EAAE,CAAC;YACvB,MAAM,aAAa,GAAG,+BAA+B,CAAC;YACtD,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAE9D,IAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAG,CAAC,CAAC,EAAE,CAAC;gBACvB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9C,CAAC;YAED,MAAM,aAAa,GAAG,2BAA2B,CAAC;YAClD,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAE9D,IAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAG,CAAC,CAAC,EAAE,CAAC;gBACvB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9C,CAAC;QACH,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,CAAC;IAClB,CAAC;SAAM,CAAC;QACN,wCAAwC;QACxC,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,GAAG;gBACN,MAAM,YAAY,EAAE,CAAC;gBACrB,MAAM,CAAC,QAAQ;YACjB,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC;YACT,KAAK,GAAG;gBACN,MAAM,IAAI,QAAQ,CAChB,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;oBAClC,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE;iBAC/D,CAAC,CAAC,CAAa,CACjB,CAAC;QACN,CAAC;QAED,MAAM,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,sBAAsB,CAAC,KAAa;IACjD,MAAM,QAAQ,GAAG,YAAY,KAAK,cAAc,eAAe,QAAQ,CAAC;IACxE,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,gBAAgB,EAAE,CAAC;IAE/C,OAAO,OAAO,CAAoB,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAC1E,CAAC"}
|
|
@@ -35,7 +35,7 @@ export type ApiOrganisation = {
|
|
|
35
35
|
} & Omit<ApiSuccess, 'data'> | ApiError;
|
|
36
36
|
export type ApiOrganisationData = Flatten<Exclude<ApiOrganisation, ApiError>['data']>;
|
|
37
37
|
export declare const organisationRevivers: Revivers<ApiOrganisation, Organisation>;
|
|
38
|
-
export declare function getOrganisation(): Promise<Organisation>;
|
|
38
|
+
export declare function getOrganisation(organisationId?: number | typeof myOrganisations): Promise<Organisation>;
|
|
39
39
|
export declare function listOrganisationJobs(organisationId: number | typeof myOrganisations, title: string, shared: boolean, page: number, options?: Record<string, unknown>): Promise<JobSearchResult>;
|
|
40
40
|
export declare function listOrganisationShares(jobId: number): Promise<JobShare[]>;
|
|
41
41
|
//# sourceMappingURL=organisation.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"organisation.d.ts","sourceRoot":"","sources":["../../src/api/organisation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,QAAQ,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,KAAK,eAAe,EAAY,MAAM,gBAAgB,CAAC;AAChE,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,QAAQ,EAGb,eAAe,EAEhB,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,YAAY,EAAE,MAAM,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,2BAA2B,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3C,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;QACjC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC,GAAG,aAAa,CAAC;CACnB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC;AAExC,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEtF,eAAO,MAAM,oBAAoB,EAAE,QAAQ,CAAC,eAAe,EAAE,YAAY,CAaxE,CAAC;AAEF,wBAAsB,eAAe,
|
|
1
|
+
{"version":3,"file":"organisation.d.ts","sourceRoot":"","sources":["../../src/api/organisation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,QAAQ,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,KAAK,eAAe,EAAY,MAAM,gBAAgB,CAAC;AAChE,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,QAAQ,EAGb,eAAe,EAEhB,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,YAAY,EAAE,MAAM,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,2BAA2B,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3C,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;QACjC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC,GAAG,aAAa,CAAC;CACnB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC;AAExC,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEtF,eAAO,MAAM,oBAAoB,EAAE,QAAQ,CAAC,eAAe,EAAE,YAAY,CAaxE,CAAC;AAEF,wBAAsB,eAAe,CACnC,cAAc,GAAE,MAAM,GAAG,OAAO,eAAiC,GAChE,OAAO,CAAC,YAAY,CAAC,CAKvB;AAED,wBAAsB,oBAAoB,CACxC,cAAc,EAAE,MAAM,GAAG,OAAO,eAAe,EAC/C,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,OAAO,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,eAAe,CAAC,CAI1B;AAED,wBAAsB,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAU/E"}
|
package/esm/api/organisation.js
CHANGED
|
@@ -13,8 +13,8 @@ export const organisationRevivers = {
|
|
|
13
13
|
trialExpiresAt: (data) => { var _a; return (_a = data.trial_expires_at) !== null && _a !== void 0 ? _a : undefined; },
|
|
14
14
|
exportTemplates: (data) => { var _a; return (_a = data.template_settings) !== null && _a !== void 0 ? _a : '{}'; },
|
|
15
15
|
};
|
|
16
|
-
export async function getOrganisation() {
|
|
17
|
-
const path = `/v1/organisations/${
|
|
16
|
+
export async function getOrganisation(organisationId = myOrganisations) {
|
|
17
|
+
const path = `/v1/organisations/${organisationId}`;
|
|
18
18
|
const options = { revivers: organisationRevivers };
|
|
19
19
|
return request(path, null, null, options);
|
|
20
20
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"organisation.js","sourceRoot":"","sources":["../../src/api/organisation.ts"],"names":[],"mappings":"AACA,OAAO,EAAwB,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAML,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,OAAO,GACR,MAAM,aAAa,CAAC;AAsCrB,MAAM,CAAC,MAAM,oBAAoB,GAA4C;IAC3E,UAAU,EAAE,SAAS;IACrB,uBAAuB,EAAE,SAAS;IAClC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,SAAS;IACf,eAAe,EAAE,SAAS;IAC1B,SAAS,EAAE,SAAS;IACpB,2BAA2B,EAAE,SAAS;IACtC,iBAAiB,EAAE,SAAS;IAE5B,cAAc,EAAE,CAAC,IAAyB,EAAE,EAAE,WAAC,OAAA,MAAA,IAAI,CAAC,gBAAgB,mCAAI,SAAS,CAAA,EAAA;IACjF,eAAe,EAAE,CAAC,IAAyB,EAAE,EAAE,WAAC,OAAA,MAAA,IAAI,CAAC,iBAAiB,mCAAI,IAAI,CAAA,EAAA;CAC/E,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,eAAe;
|
|
1
|
+
{"version":3,"file":"organisation.js","sourceRoot":"","sources":["../../src/api/organisation.ts"],"names":[],"mappings":"AACA,OAAO,EAAwB,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAML,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,OAAO,GACR,MAAM,aAAa,CAAC;AAsCrB,MAAM,CAAC,MAAM,oBAAoB,GAA4C;IAC3E,UAAU,EAAE,SAAS;IACrB,uBAAuB,EAAE,SAAS;IAClC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,SAAS;IACf,eAAe,EAAE,SAAS;IAC1B,SAAS,EAAE,SAAS;IACpB,2BAA2B,EAAE,SAAS;IACtC,iBAAiB,EAAE,SAAS;IAE5B,cAAc,EAAE,CAAC,IAAyB,EAAE,EAAE,WAAC,OAAA,MAAA,IAAI,CAAC,gBAAgB,mCAAI,SAAS,CAAA,EAAA;IACjF,eAAe,EAAE,CAAC,IAAyB,EAAE,EAAE,WAAC,OAAA,MAAA,IAAI,CAAC,iBAAiB,mCAAI,IAAI,CAAA,EAAA;CAC/E,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,iBAAkD,eAAe;IAEjE,MAAM,IAAI,GAAG,qBAAqB,cAAc,EAAE,CAAC;IACnD,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IAEnD,OAAO,OAAO,CAAgC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,cAA+C,EAC/C,KAAa,EACb,MAAe,EACf,IAAY,EACZ,OAAiC;IAEjC,MAAM,MAAM,mCAAQ,OAAO,GAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,CAAE,CAAC;IAEhE,OAAO,QAAQ,CAAC,qBAAqB,cAAc,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AACnF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,KAAa;IACxD,MAAM,QAAQ,GAAG,qBAAqB,eAAe,SAAS,CAAC;IAC/D,MAAM,KAAK,GAAG,eAAe,CAAC;QAC5B,MAAM,EAAE;YACN,MAAM,EAAE,KAAK,KAAK,EAAE;SACrB;KACF,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,KAAK,EAAE,CAAC;IAEpC,OAAO,OAAO,CAA6B,IAAI,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAC5E,CAAC"}
|
package/esm/api/user.d.ts
CHANGED
|
@@ -23,6 +23,7 @@ type ApiRole = {
|
|
|
23
23
|
type UnitType = 'metric' | 'imperial' | null;
|
|
24
24
|
export type User = {
|
|
25
25
|
id: number;
|
|
26
|
+
organisationId: number;
|
|
26
27
|
languageCode: string;
|
|
27
28
|
interfaceLanguage: string;
|
|
28
29
|
videoNotifications: boolean;
|
|
@@ -108,7 +109,7 @@ type UpdateUserParams = {
|
|
|
108
109
|
password?: string;
|
|
109
110
|
email?: string;
|
|
110
111
|
};
|
|
111
|
-
export declare function getUser(): Promise<User>;
|
|
112
|
+
export declare function getUser(userId?: number | typeof myUser): Promise<User>;
|
|
112
113
|
export declare function updateUser(userId: number | typeof myUser, fields: RequireAtLeastOne<UpdateUserParams>): Promise<Record<string, never>>;
|
|
113
114
|
export declare function deleteUser(userId: number | typeof myUser): Promise<Record<string, never>>;
|
|
114
115
|
export declare function listUserFontFamilies(): Promise<FontFamily[]>;
|
package/esm/api/user.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/api/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,KAAK,UAAU,EAAsB,MAAM,iBAAiB,CAAC;AAC9F,OAAO,EAAsB,KAAK,MAAM,EAAkB,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAqB,KAAK,KAAK,EAAiB,MAAM,YAAY,CAAC;AAC1E,OAAO,EAAmB,KAAK,GAAG,EAAe,MAAM,UAAU,CAAC;AAClE,OAAO,EAAE,KAAK,eAAe,EAAY,MAAM,gBAAgB,CAAC;AAChE,OAAO,KAAK,EAAoB,QAAQ,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,QAAQ,EAIb,MAAM,EAGP,MAAM,aAAa,CAAC;AAErB,KAAK,aAAa,GAAG;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,GAAG,aAAa,CAAC;AAElB,KAAK,OAAO,GAAG;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE;QACL,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,GAAG,aAAa,CAAC;AAElB,KAAK,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,IAAI,CAAC;AAE7C,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,QAAQ,CAAC;IACf,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,eAAe,EAAE,MAAM,CAAC;QACxB,aAAa,EAAE,MAAM,CAAC;QACtB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,aAAa,EAAE,OAAO,CAAC;QACvB,mBAAmB,EAAE,OAAO,CAAC;QAC7B,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,IAAI,EAAE,OAAO,CAAC;QACd,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC;QACnB,UAAU,EAAE,OAAO,CAAC;QACpB,kBAAkB,EAAE,OAAO,CAAC;QAC5B,eAAe,EAAE,OAAO,CAAC;QACzB,QAAQ,EAAE,OAAO,CAAC;QAClB,IAAI,EAAE,QAAQ,CAAC;QACf,qBAAqB,EAAE,OAAO,CAAC;QAC/B,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;QACxC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAC;QACjC,uBAAuB,EAAE,MAAM,CAAC;QAChC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;QAC3B,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QACxB,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,uBAAuB,CAAC,EAAE,MAAM,CAAC;QACjC,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,WAAW,EAAE,aAAa,EAAE,CAAC;QAC7B,KAAK,EAAE,OAAO,EAAE,CAAC;KAClB,GAAG,aAAa,CAAC;CACnB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC;AAExC,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEtE,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,aAAa,CAAC;CACnB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC;AAExC,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEhF,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,
|
|
1
|
+
{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/api/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,KAAK,UAAU,EAAsB,MAAM,iBAAiB,CAAC;AAC9F,OAAO,EAAsB,KAAK,MAAM,EAAkB,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAqB,KAAK,KAAK,EAAiB,MAAM,YAAY,CAAC;AAC1E,OAAO,EAAmB,KAAK,GAAG,EAAe,MAAM,UAAU,CAAC;AAClE,OAAO,EAAE,KAAK,eAAe,EAAY,MAAM,gBAAgB,CAAC;AAChE,OAAO,KAAK,EAAoB,QAAQ,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,QAAQ,EAIb,MAAM,EAGP,MAAM,aAAa,CAAC;AAErB,KAAK,aAAa,GAAG;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,GAAG,aAAa,CAAC;AAElB,KAAK,OAAO,GAAG;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE;QACL,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,GAAG,aAAa,CAAC;AAElB,KAAK,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,IAAI,CAAC;AAE7C,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,QAAQ,CAAC;IACf,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,eAAe,EAAE,MAAM,CAAC;QACxB,aAAa,EAAE,MAAM,CAAC;QACtB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,aAAa,EAAE,OAAO,CAAC;QACvB,mBAAmB,EAAE,OAAO,CAAC;QAC7B,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,IAAI,EAAE,OAAO,CAAC;QACd,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC;QACnB,UAAU,EAAE,OAAO,CAAC;QACpB,kBAAkB,EAAE,OAAO,CAAC;QAC5B,eAAe,EAAE,OAAO,CAAC;QACzB,QAAQ,EAAE,OAAO,CAAC;QAClB,IAAI,EAAE,QAAQ,CAAC;QACf,qBAAqB,EAAE,OAAO,CAAC;QAC/B,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;QACxC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAC;QACjC,uBAAuB,EAAE,MAAM,CAAC;QAChC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;QAC3B,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QACxB,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,uBAAuB,CAAC,EAAE,MAAM,CAAC;QACjC,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,WAAW,EAAE,aAAa,EAAE,CAAC;QAC7B,KAAK,EAAE,OAAO,EAAE,CAAC;KAClB,GAAG,aAAa,CAAC;CACnB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC;AAExC,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEtE,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,aAAa,CAAC;CACnB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC;AAExC,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEhF,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAyBhD,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wBAAsB,OAAO,CAAC,MAAM,GAAE,MAAM,GAAG,OAAO,MAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAKpF;AAED,wBAAsB,UAAU,CAC9B,MAAM,EAAE,MAAM,GAAG,OAAO,MAAM,EAC9B,MAAM,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,GAC1C,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAKhC;AAED,wBAAsB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAI/F;AAED,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAWlE;AAED,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAW3D;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,GAAG,OAAO,MAAM,EAC9B,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,eAAe,CAAC,CAE1B;AAED,wBAAsB,eAAe,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAQ5D;AAED,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAKvE;AAED,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAIvF;AAED,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAKrG;AAED,wBAAsB,cAAc,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,CAgBvD;AAED,wBAAsB,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAiBzD;AAED,wBAAsB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAMtE;AAED,wBAAsB,eAAe,CACnC,MAAM,EAAE,MAAM,GAAG,OAAO,MAAM,EAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAMhC;AAED,wBAAsB,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAI9G;AAWD,wBAAsB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAM7F"}
|
package/esm/api/user.js
CHANGED
|
@@ -5,7 +5,6 @@ import { svgRevivers } from './svg.js';
|
|
|
5
5
|
import { listJobs } from './apiCommon.js';
|
|
6
6
|
import { defaultListHeader, deletedNoneParam, getSearchParams, myUser, request, toApiType, } from '../utils.js';
|
|
7
7
|
export const userRevivers = {
|
|
8
|
-
organisation_id: undefined,
|
|
9
8
|
hide_messages: undefined,
|
|
10
9
|
phone: undefined,
|
|
11
10
|
profession: undefined,
|
|
@@ -30,8 +29,8 @@ export const userRevivers = {
|
|
|
30
29
|
trialExpiresAt: (data) => { var _a; return (_a = data.trial_expires_at) !== null && _a !== void 0 ? _a : undefined; },
|
|
31
30
|
stripeId: (data) => { var _a; return (_a = data.stripe_id) !== null && _a !== void 0 ? _a : undefined; },
|
|
32
31
|
};
|
|
33
|
-
export async function getUser() {
|
|
34
|
-
const path = `/v1/users/${
|
|
32
|
+
export async function getUser(userId = myUser) {
|
|
33
|
+
const path = `/v1/users/${userId}`;
|
|
35
34
|
const options = { revivers: userRevivers };
|
|
36
35
|
return request(path, null, null, options);
|
|
37
36
|
}
|
package/esm/api/user.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/api/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2C,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC9F,OAAO,EAAmC,cAAc,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAiC,aAAa,EAAE,MAAM,YAAY,CAAC;AAC1E,OAAO,EAA6B,WAAW,EAAE,MAAM,UAAU,CAAC;AAClE,OAAO,EAAwB,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAGhE,OAAO,EAOL,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,MAAM,EACN,OAAO,EACP,SAAS,GACV,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/api/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2C,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC9F,OAAO,EAAmC,cAAc,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAiC,aAAa,EAAE,MAAM,YAAY,CAAC;AAC1E,OAAO,EAA6B,WAAW,EAAE,MAAM,UAAU,CAAC;AAClE,OAAO,EAAwB,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAGhE,OAAO,EAOL,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,MAAM,EACN,OAAO,EACP,SAAS,GACV,MAAM,aAAa,CAAC;AAuGrB,MAAM,CAAC,MAAM,YAAY,GAA4B;IACnD,aAAa,EAAE,SAAS;IACxB,KAAK,EAAE,SAAS;IAChB,UAAU,EAAE,SAAS;IACrB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,SAAS;IACf,IAAI,EAAE,SAAS;IACf,kBAAkB,EAAE,SAAS;IAC7B,qBAAqB,EAAE,SAAS;IAChC,wBAAwB,EAAE,SAAS;IACnC,QAAQ,EAAE,SAAS;IACnB,gBAAgB,EAAE,SAAS;IAC3B,uBAAuB,EAAE,SAAS;IAClC,UAAU,EAAE,SAAS;IACrB,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,SAAS;IACvB,aAAa,EAAE,SAAS;IACxB,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,SAAS;IACtB,KAAK,EAAE,SAAS;IAEhB,cAAc,EAAE,CAAC,IAAiB,EAAE,EAAE,WAAC,OAAA,MAAA,IAAI,CAAC,gBAAgB,mCAAI,SAAS,CAAA,EAAA;IACzE,QAAQ,EAAE,CAAC,IAAiB,EAAE,EAAE,WAAC,OAAA,MAAA,IAAI,CAAC,SAAS,mCAAI,SAAS,CAAA,EAAA;CAC7D,CAAC;AAaF,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,SAAiC,MAAM;IACnE,MAAM,IAAI,GAAG,aAAa,MAAM,EAAE,CAAC;IACnC,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;IAE3C,OAAO,OAAO,CAAgB,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAA8B,EAC9B,MAA2C;IAE3C,MAAM,IAAI,GAAG,aAAa,MAAM,EAAE,CAAC;IACnC,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAE/B,OAAO,OAAO,CAAmC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AAC1F,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,MAA8B;IAC7D,MAAM,IAAI,GAAG,aAAa,MAAM,EAAE,CAAC;IAEnC,OAAO,OAAO,CAAmC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC3F,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACxC,MAAM,QAAQ,GAAG,aAAa,MAAM,gBAAgB,CAAC;IACrD,MAAM,KAAK,GAAG,eAAe,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,KAAK,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAC;IAMjD,OAAO,OAAO,CAAiC,IAAI,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;AACzF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACxC,MAAM,QAAQ,GAAG,aAAa,MAAM,gBAAgB,CAAC;IACrD,MAAM,KAAK,GAAG,eAAe,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,KAAK,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;IAM1C,OAAO,OAAO,CAAmB,IAAI,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAA8B,EAC9B,KAAa,EACb,IAAY,EACZ,OAAiC;IAEjC,OAAO,QAAQ,CAAC,aAAa,MAAM,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,IAAI,GAAG,aAAa,MAAM,UAAU,CAAC;IAM3C,OAAO,OAAO,CAA+B,IAAI,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,IAAY;IACjD,MAAM,IAAI,GAAG,aAAa,MAAM,UAAU,CAAC;IAC3C,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,CAAC;IAEtB,OAAO,OAAO,CAAuB,IAAI,EAAE,IAAI,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IACrD,MAAM,IAAI,GAAG,aAAa,MAAM,YAAY,QAAQ,EAAE,CAAC;IAEvD,OAAO,OAAO,CAAmC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC3F,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,QAAgB,EAAE,IAAY;IACnE,MAAM,IAAI,GAAG,aAAa,MAAM,YAAY,QAAQ,EAAE,CAAC;IACvD,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,CAAC;IAEtB,OAAO,OAAO,CAAmC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AAC1F,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,MAAM,QAAQ,GAAG,aAAa,MAAM,SAAS,CAAC;IAC9C,MAAM,KAAK,GAAG,eAAe,CAAC;QAC5B,MAAM,EAAE;YACN,aAAa,EAAE,GAAG;SACnB;QACD,IAAI,EAAE,OAAO;KACd,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,KAAK,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;IAM5C,OAAO,OAAO,CAAuB,IAAI,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;AAC/E,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,QAAQ,GAAG,aAAa,MAAM,WAAW,CAAC;IAChD,MAAM,KAAK,GAAG,eAAe,CAAC;QAC5B,MAAM,EAAE;YACN,mBAAmB,EAAE,GAAG;YACxB,IAAI,EAAE,UAAU;SACjB;QACD,IAAI,EAAE,OAAO;KACd,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,KAAK,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;IAM7C,OAAO,OAAO,CAAyB,IAAI,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;AACjF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,KAAa;IAC/C,MAAM,QAAQ,GAAG,aAAa,MAAM,aAAa,CAAC;IAClD,MAAM,KAAK,GAAG,eAAe,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,KAAK,EAAE,CAAC;IAEpC,OAAO,OAAO,CAA6B,IAAI,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAA8B,EAC9B,IAA6B;IAE7B,MAAM,QAAQ,GAAG,aAAa,MAAM,QAAQ,CAAC;IAC7C,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,gBAAgB,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAE7B,OAAO,OAAO,CAAmC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAC,MAA8B;IAC5E,MAAM,IAAI,GAAG,aAAa,MAAM,UAAU,CAAC;IAE3C,OAAO,OAAO,CAAmC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AACzF,CAAC;AAWD,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,MAA8B;IAC1E,MAAM,IAAI,GAAG,aAAa,MAAM,qBAAqB,CAAC;IAEtD,OAAO,OAAO,CAAkC,IAAI,CAAC,CAAC,IAAI,CACxD,CAAC,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC,gBAAgB,CAC3C,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,80 +1,80 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@mapcreator/api",
|
|
3
|
-
"version": "5.0.0-alpha.
|
|
4
|
-
"description": "Mapcreator JavaScript API",
|
|
5
|
-
"license": "BSD-3-Clause",
|
|
6
|
-
"main": "./cjs/index.js",
|
|
7
|
-
"types": "./cjs/index.d.ts",
|
|
8
|
-
"exports": {
|
|
9
|
-
".": {
|
|
10
|
-
"types": "./esm/index.d.ts",
|
|
11
|
-
"import": "./esm/index.js",
|
|
12
|
-
"require": "./cjs/index.js"
|
|
13
|
-
},
|
|
14
|
-
"./oauth": {
|
|
15
|
-
"types": "./esm/oauth.d.ts",
|
|
16
|
-
"import": "./esm/oauth.js",
|
|
17
|
-
"require": "./cjs/oauth.js"
|
|
18
|
-
},
|
|
19
|
-
"./oauth.js": {
|
|
20
|
-
"types": "./esm/oauth.d.ts",
|
|
21
|
-
"import": "./esm/oauth.js",
|
|
22
|
-
"require": "./cjs/oauth.js"
|
|
23
|
-
},
|
|
24
|
-
"./utils": {
|
|
25
|
-
"types": "./esm/utils.d.ts",
|
|
26
|
-
"import": "./esm/utils.js",
|
|
27
|
-
"require": "./cjs/utils.js"
|
|
28
|
-
},
|
|
29
|
-
"./utils.js": {
|
|
30
|
-
"types": "./esm/utils.d.ts",
|
|
31
|
-
"import": "./esm/utils.js",
|
|
32
|
-
"require": "./cjs/utils.js"
|
|
33
|
-
},
|
|
34
|
-
"./package.json": "./package.json",
|
|
35
|
-
"./*": {
|
|
36
|
-
"types": "./esm/api/*.d.ts",
|
|
37
|
-
"import": "./esm/api/*.js",
|
|
38
|
-
"require": "./cjs/api/*.js"
|
|
39
|
-
},
|
|
40
|
-
"./*.js": {
|
|
41
|
-
"types": "./esm/api/*.d.ts",
|
|
42
|
-
"import": "./esm/api/*.js",
|
|
43
|
-
"require": "./cjs/api/*.js"
|
|
44
|
-
}
|
|
45
|
-
},
|
|
46
|
-
"scripts": {
|
|
47
|
-
"build": "tsc --outDir esm && tsc -m commonjs --outDir cjs",
|
|
48
|
-
"clean": "npx rimraf esm/ cjs/",
|
|
49
|
-
"lint": "eslint --ext .ts src",
|
|
50
|
-
"prepublishOnly": "npm run lint && npm run clean && npm run build",
|
|
51
|
-
"test": "echo \"Error: no test specified\" && exit 1"
|
|
52
|
-
},
|
|
53
|
-
"repository": {
|
|
54
|
-
"type": "git",
|
|
55
|
-
"url": "git+https://gitlab.com/mapcreator/api-wrapper.git"
|
|
56
|
-
},
|
|
57
|
-
"publishConfig": {
|
|
58
|
-
"registry": "https://registry.npmjs.org/"
|
|
59
|
-
},
|
|
60
|
-
"files": [
|
|
61
|
-
"cjs",
|
|
62
|
-
"esm",
|
|
63
|
-
"src"
|
|
64
|
-
],
|
|
65
|
-
"bugs": {
|
|
66
|
-
"url": "https://gitlab.com/mapcreator/api-wrapper/issues"
|
|
67
|
-
},
|
|
68
|
-
"homepage": "https://gitlab.com/mapcreator/api-wrapper#readme",
|
|
69
|
-
"dependencies": {
|
|
70
|
-
"@types/geojson": "^7946.0.14",
|
|
71
|
-
"type-fest": "^4.10"
|
|
72
|
-
},
|
|
73
|
-
"devDependencies": {
|
|
74
|
-
"@stylistic/eslint-plugin": "~1.5",
|
|
75
|
-
"@typescript-eslint/eslint-plugin": "~6.15",
|
|
76
|
-
"@typescript-eslint/parser": "~6.15",
|
|
77
|
-
"eslint": "~8.57",
|
|
78
|
-
"typescript": "~5.8.3"
|
|
79
|
-
}
|
|
80
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@mapcreator/api",
|
|
3
|
+
"version": "5.0.0-alpha.91",
|
|
4
|
+
"description": "Mapcreator JavaScript API",
|
|
5
|
+
"license": "BSD-3-Clause",
|
|
6
|
+
"main": "./cjs/index.js",
|
|
7
|
+
"types": "./cjs/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./esm/index.d.ts",
|
|
11
|
+
"import": "./esm/index.js",
|
|
12
|
+
"require": "./cjs/index.js"
|
|
13
|
+
},
|
|
14
|
+
"./oauth": {
|
|
15
|
+
"types": "./esm/oauth.d.ts",
|
|
16
|
+
"import": "./esm/oauth.js",
|
|
17
|
+
"require": "./cjs/oauth.js"
|
|
18
|
+
},
|
|
19
|
+
"./oauth.js": {
|
|
20
|
+
"types": "./esm/oauth.d.ts",
|
|
21
|
+
"import": "./esm/oauth.js",
|
|
22
|
+
"require": "./cjs/oauth.js"
|
|
23
|
+
},
|
|
24
|
+
"./utils": {
|
|
25
|
+
"types": "./esm/utils.d.ts",
|
|
26
|
+
"import": "./esm/utils.js",
|
|
27
|
+
"require": "./cjs/utils.js"
|
|
28
|
+
},
|
|
29
|
+
"./utils.js": {
|
|
30
|
+
"types": "./esm/utils.d.ts",
|
|
31
|
+
"import": "./esm/utils.js",
|
|
32
|
+
"require": "./cjs/utils.js"
|
|
33
|
+
},
|
|
34
|
+
"./package.json": "./package.json",
|
|
35
|
+
"./*": {
|
|
36
|
+
"types": "./esm/api/*.d.ts",
|
|
37
|
+
"import": "./esm/api/*.js",
|
|
38
|
+
"require": "./cjs/api/*.js"
|
|
39
|
+
},
|
|
40
|
+
"./*.js": {
|
|
41
|
+
"types": "./esm/api/*.d.ts",
|
|
42
|
+
"import": "./esm/api/*.js",
|
|
43
|
+
"require": "./cjs/api/*.js"
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
"scripts": {
|
|
47
|
+
"build": "tsc --outDir esm && tsc -m commonjs --outDir cjs",
|
|
48
|
+
"clean": "npx rimraf esm/ cjs/",
|
|
49
|
+
"lint": "eslint --ext .ts src",
|
|
50
|
+
"prepublishOnly": "npm run lint && npm run clean && npm run build",
|
|
51
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
52
|
+
},
|
|
53
|
+
"repository": {
|
|
54
|
+
"type": "git",
|
|
55
|
+
"url": "git+https://gitlab.com/mapcreator/api-wrapper.git"
|
|
56
|
+
},
|
|
57
|
+
"publishConfig": {
|
|
58
|
+
"registry": "https://registry.npmjs.org/"
|
|
59
|
+
},
|
|
60
|
+
"files": [
|
|
61
|
+
"cjs",
|
|
62
|
+
"esm",
|
|
63
|
+
"src"
|
|
64
|
+
],
|
|
65
|
+
"bugs": {
|
|
66
|
+
"url": "https://gitlab.com/mapcreator/api-wrapper/issues"
|
|
67
|
+
},
|
|
68
|
+
"homepage": "https://gitlab.com/mapcreator/api-wrapper#readme",
|
|
69
|
+
"dependencies": {
|
|
70
|
+
"@types/geojson": "^7946.0.14",
|
|
71
|
+
"type-fest": "^4.10"
|
|
72
|
+
},
|
|
73
|
+
"devDependencies": {
|
|
74
|
+
"@stylistic/eslint-plugin": "~1.5",
|
|
75
|
+
"@typescript-eslint/eslint-plugin": "~6.15",
|
|
76
|
+
"@typescript-eslint/parser": "~6.15",
|
|
77
|
+
"eslint": "~8.57",
|
|
78
|
+
"typescript": "~5.8.3"
|
|
79
|
+
}
|
|
80
|
+
}
|
package/src/README.md
CHANGED
|
@@ -1,126 +1,126 @@
|
|
|
1
|
-
### Used type system
|
|
2
|
-
|
|
3
|
-
We use type declarations for both the data coming over the wire and the data used by the application. In general, these types differ only in the presence of additional fields in the data arriving over the network (like `created_at`), and used naming convention. Data over the network uses the so-called snake case.
|
|
4
|
-
|
|
5
|
-
All in all, we can use TypeScript's native mechanisms to convert one type to another and fully define just one type:
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import type { CamelCasedProperties } from 'type-fest';
|
|
9
|
-
|
|
10
|
-
type ApiType =
|
|
11
|
-
| ({
|
|
12
|
-
data: {
|
|
13
|
-
prop: unknown;
|
|
14
|
-
} & ApiCommonData;
|
|
15
|
-
} & Omit<ApiSuccess, 'data'>)
|
|
16
|
-
| ApiError;
|
|
17
|
-
|
|
18
|
-
type AppType = CamelCasedProperties<Omit<Exclude<ApiType, ApiError>['data'], keyof ApiCommonData>>;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
or in reverse order:
|
|
22
|
-
|
|
23
|
-
```typescript
|
|
24
|
-
import type { SnakeCasedProperties } from 'type-fest';
|
|
25
|
-
|
|
26
|
-
type AppType = {
|
|
27
|
-
prop: unknown;
|
|
28
|
-
};
|
|
29
|
-
|
|
30
|
-
type ApiType =
|
|
31
|
-
| ({
|
|
32
|
-
data: SnakeCasedProperties<AppType> & ApiCommonData;
|
|
33
|
-
} & Omit<ApiSuccess, 'data'>)
|
|
34
|
-
| ApiError;
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
But the decision was made not to do this, since it may be more difficult for the developer to make the conversion in their head than to see it in front of their eyes.
|
|
38
|
-
|
|
39
|
-
### Using a `request()`
|
|
40
|
-
|
|
41
|
-
The function has the following signature:
|
|
42
|
-
|
|
43
|
-
```typescript
|
|
44
|
-
async function request<I extends ApiCommon, O extends Record<string, unknown> | string>(
|
|
45
|
-
path: string,
|
|
46
|
-
body?: XMLHttpRequestBodyInit | Record<string | number, unknown> | null,
|
|
47
|
-
extraHeaders?: Record<string, string> | null,
|
|
48
|
-
extraOptions?: ExtraOptions<I, O>,
|
|
49
|
-
): Promise<O | O[]> { /* ... */ }
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Let's take it step by step.
|
|
53
|
-
|
|
54
|
-
`I extends ApiCommon` - represents the type of data we receive over the network.
|
|
55
|
-
|
|
56
|
-
`O extends Record<string, unknown> | string` - represents the data type that will be used in the application.
|
|
57
|
-
|
|
58
|
-
Ideally you should describe and convey both types. This will help to check the data types in the arguments passed.
|
|
59
|
-
See current data types for an example.
|
|
60
|
-
|
|
61
|
-
`path: string` - the path to the resource, must include the API version, but must not include the schema or authority.
|
|
62
|
-
Example: `/v1/jobs/12345`
|
|
63
|
-
|
|
64
|
-
`body?: XMLHttpRequestBodyInit | Record<string | number, unknown> | null` - any meaningful body type. In general,
|
|
65
|
-
the presence of an JSON object is assumed (or the absence of one for methods that only request data), but you can
|
|
66
|
-
also pass `Blob`, `FormData`, `URLSearchParams` or just `ArrayBuffer`. The required content type will be added to
|
|
67
|
-
the headers automatically.
|
|
68
|
-
|
|
69
|
-
`extraHeaders?: Record<string, string> | null` - the object with additional headers.
|
|
70
|
-
|
|
71
|
-
`extraOptions?: ExtraOptions<I, O>` - where `ExtraOptions<I, O>` is defined like this:
|
|
72
|
-
|
|
73
|
-
```typescript
|
|
74
|
-
interface ExtraOptions<I extends ApiCommon, O extends Record<string, unknown> | string> {
|
|
75
|
-
method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
76
|
-
revivers?: O extends Record<string, unknown> ? Revivers<I, O> : never;
|
|
77
|
-
sendNull?: boolean;
|
|
78
|
-
withMeta?: boolean;
|
|
79
|
-
}
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
Most fields are self-explanatory.
|
|
83
|
-
|
|
84
|
-
`sendNull` can be used if you really want to pass `null` as body content.
|
|
85
|
-
|
|
86
|
-
`revivers` is used to specify an object that can modify the behavior of the internal handler of data coming over
|
|
87
|
-
the network. Let's take a closer look at this moment.
|
|
88
|
-
|
|
89
|
-
#### Revivers
|
|
90
|
-
|
|
91
|
-
By default, the `request()` function does the following things with data coming over the network:
|
|
92
|
-
|
|
93
|
-
- It removes `created_at`, `updated_at`, `deleted_at` fields from the output objects.
|
|
94
|
-
- It preserves all the remaining fields but converts their names into camelCase.
|
|
95
|
-
|
|
96
|
-
When passing an object with revivers you can a couple of things:
|
|
97
|
-
|
|
98
|
-
- You can list the fields that you want **to exclude** from the result object. To do this, the field must be assigned an
|
|
99
|
-
`undefined` value.
|
|
100
|
-
- You can **add** new fields or **modify** the type of existing ones. To do this, you need to pass a function as a field
|
|
101
|
-
value, which will receive the original object as input.
|
|
102
|
-
|
|
103
|
-
Example:
|
|
104
|
-
|
|
105
|
-
```typescript
|
|
106
|
-
const jobRevivers: Revivers<ApiJob, Job> = {
|
|
107
|
-
user_id: undefined,
|
|
108
|
-
description: undefined,
|
|
109
|
-
share_token: undefined,
|
|
110
|
-
autosave_preview_path: undefined,
|
|
111
|
-
job_folder_id: undefined,
|
|
112
|
-
|
|
113
|
-
jobTypeId: () => 9,
|
|
114
|
-
createdAt: (data: ApiJobData) => data.created_at as string,
|
|
115
|
-
previewPath: (data: ApiJobData) => data.autosave_preview_path ?? undefined,
|
|
116
|
-
};
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
`user_id`, `description`, `share_token`, `autosave_preview_path`, `job_folder_id` fields will be excluded from the
|
|
120
|
-
result object.
|
|
121
|
-
|
|
122
|
-
`jobTypeId` will be always **9**.
|
|
123
|
-
|
|
124
|
-
`createdAt` will be returned (please note that that field is excluded by default)
|
|
125
|
-
|
|
126
|
-
`previewPath` - some actions will be performed with the source data.
|
|
1
|
+
### Used type system
|
|
2
|
+
|
|
3
|
+
We use type declarations for both the data coming over the wire and the data used by the application. In general, these types differ only in the presence of additional fields in the data arriving over the network (like `created_at`), and used naming convention. Data over the network uses the so-called snake case.
|
|
4
|
+
|
|
5
|
+
All in all, we can use TypeScript's native mechanisms to convert one type to another and fully define just one type:
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import type { CamelCasedProperties } from 'type-fest';
|
|
9
|
+
|
|
10
|
+
type ApiType =
|
|
11
|
+
| ({
|
|
12
|
+
data: {
|
|
13
|
+
prop: unknown;
|
|
14
|
+
} & ApiCommonData;
|
|
15
|
+
} & Omit<ApiSuccess, 'data'>)
|
|
16
|
+
| ApiError;
|
|
17
|
+
|
|
18
|
+
type AppType = CamelCasedProperties<Omit<Exclude<ApiType, ApiError>['data'], keyof ApiCommonData>>;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
or in reverse order:
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import type { SnakeCasedProperties } from 'type-fest';
|
|
25
|
+
|
|
26
|
+
type AppType = {
|
|
27
|
+
prop: unknown;
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
type ApiType =
|
|
31
|
+
| ({
|
|
32
|
+
data: SnakeCasedProperties<AppType> & ApiCommonData;
|
|
33
|
+
} & Omit<ApiSuccess, 'data'>)
|
|
34
|
+
| ApiError;
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
But the decision was made not to do this, since it may be more difficult for the developer to make the conversion in their head than to see it in front of their eyes.
|
|
38
|
+
|
|
39
|
+
### Using a `request()`
|
|
40
|
+
|
|
41
|
+
The function has the following signature:
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
async function request<I extends ApiCommon, O extends Record<string, unknown> | string>(
|
|
45
|
+
path: string,
|
|
46
|
+
body?: XMLHttpRequestBodyInit | Record<string | number, unknown> | null,
|
|
47
|
+
extraHeaders?: Record<string, string> | null,
|
|
48
|
+
extraOptions?: ExtraOptions<I, O>,
|
|
49
|
+
): Promise<O | O[]> { /* ... */ }
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Let's take it step by step.
|
|
53
|
+
|
|
54
|
+
`I extends ApiCommon` - represents the type of data we receive over the network.
|
|
55
|
+
|
|
56
|
+
`O extends Record<string, unknown> | string` - represents the data type that will be used in the application.
|
|
57
|
+
|
|
58
|
+
Ideally you should describe and convey both types. This will help to check the data types in the arguments passed.
|
|
59
|
+
See current data types for an example.
|
|
60
|
+
|
|
61
|
+
`path: string` - the path to the resource, must include the API version, but must not include the schema or authority.
|
|
62
|
+
Example: `/v1/jobs/12345`
|
|
63
|
+
|
|
64
|
+
`body?: XMLHttpRequestBodyInit | Record<string | number, unknown> | null` - any meaningful body type. In general,
|
|
65
|
+
the presence of an JSON object is assumed (or the absence of one for methods that only request data), but you can
|
|
66
|
+
also pass `Blob`, `FormData`, `URLSearchParams` or just `ArrayBuffer`. The required content type will be added to
|
|
67
|
+
the headers automatically.
|
|
68
|
+
|
|
69
|
+
`extraHeaders?: Record<string, string> | null` - the object with additional headers.
|
|
70
|
+
|
|
71
|
+
`extraOptions?: ExtraOptions<I, O>` - where `ExtraOptions<I, O>` is defined like this:
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
interface ExtraOptions<I extends ApiCommon, O extends Record<string, unknown> | string> {
|
|
75
|
+
method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
76
|
+
revivers?: O extends Record<string, unknown> ? Revivers<I, O> : never;
|
|
77
|
+
sendNull?: boolean;
|
|
78
|
+
withMeta?: boolean;
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Most fields are self-explanatory.
|
|
83
|
+
|
|
84
|
+
`sendNull` can be used if you really want to pass `null` as body content.
|
|
85
|
+
|
|
86
|
+
`revivers` is used to specify an object that can modify the behavior of the internal handler of data coming over
|
|
87
|
+
the network. Let's take a closer look at this moment.
|
|
88
|
+
|
|
89
|
+
#### Revivers
|
|
90
|
+
|
|
91
|
+
By default, the `request()` function does the following things with data coming over the network:
|
|
92
|
+
|
|
93
|
+
- It removes `created_at`, `updated_at`, `deleted_at` fields from the output objects.
|
|
94
|
+
- It preserves all the remaining fields but converts their names into camelCase.
|
|
95
|
+
|
|
96
|
+
When passing an object with revivers you can a couple of things:
|
|
97
|
+
|
|
98
|
+
- You can list the fields that you want **to exclude** from the result object. To do this, the field must be assigned an
|
|
99
|
+
`undefined` value.
|
|
100
|
+
- You can **add** new fields or **modify** the type of existing ones. To do this, you need to pass a function as a field
|
|
101
|
+
value, which will receive the original object as input.
|
|
102
|
+
|
|
103
|
+
Example:
|
|
104
|
+
|
|
105
|
+
```typescript
|
|
106
|
+
const jobRevivers: Revivers<ApiJob, Job> = {
|
|
107
|
+
user_id: undefined,
|
|
108
|
+
description: undefined,
|
|
109
|
+
share_token: undefined,
|
|
110
|
+
autosave_preview_path: undefined,
|
|
111
|
+
job_folder_id: undefined,
|
|
112
|
+
|
|
113
|
+
jobTypeId: () => 9,
|
|
114
|
+
createdAt: (data: ApiJobData) => data.created_at as string,
|
|
115
|
+
previewPath: (data: ApiJobData) => data.autosave_preview_path ?? undefined,
|
|
116
|
+
};
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
`user_id`, `description`, `share_token`, `autosave_preview_path`, `job_folder_id` fields will be excluded from the
|
|
120
|
+
result object.
|
|
121
|
+
|
|
122
|
+
`jobTypeId` will be always **9**.
|
|
123
|
+
|
|
124
|
+
`createdAt` will be returned (please note that that field is excluded by default)
|
|
125
|
+
|
|
126
|
+
`previewPath` - some actions will be performed with the source data.
|
package/src/api/job.ts
CHANGED
|
@@ -53,9 +53,9 @@ export const jobRevivers: Revivers<ApiJob, Job> = {
|
|
|
53
53
|
previewPath: (data: ApiJobData) => data.autosave_preview_path ?? undefined,
|
|
54
54
|
};
|
|
55
55
|
|
|
56
|
-
export async function createJob(title: string
|
|
56
|
+
export async function createJob(title: string): Promise<Job> {
|
|
57
57
|
const path = `/v1/jobs`;
|
|
58
|
-
const body = { title, job_type_id: 9
|
|
58
|
+
const body = { title, job_type_id: 9 };
|
|
59
59
|
const options = { revivers: jobRevivers };
|
|
60
60
|
|
|
61
61
|
// Technically, the returning `data` will contain only the following fields:
|