@mapcreator/api 3.3.0 → 5.0.0-alpha.12

package/esm/utils.d.ts

@@ -0,0 +1,72 @@
+import type { CamelCasedProperties, SnakeCasedProperties } from 'type-fest';
+export type Flatten<Type> = Type extends Array<infer Item> ? Item : Type;
+export type ApiCommonData = {
+    created_at: string | null;
+    deleted_at: string | null;
+    updated_at: string | null;
+};
+export interface ApiSuccess {
+    success: true;
+    data?: Record<string, unknown> | Array<Record<string, unknown>> | string | string[];
+}
+export interface ApiError {
+    success: false;
+    error: {
+        type: string;
+        message: string;
+        validation_errors?: Record<string, string[]>;
+    };
+}
+export type ApiCommon = ApiSuccess | ApiError;
+export declare const myUser = "me";
+export declare const myOrganisations = "mine";
+export declare const lastJobRevision = "last";
+export declare const defaultListHeader: {
+    'X-Per-Page': string;
+};
+export declare const deletedNoneParam: URLSearchParams;
+export declare const keysToRemove: string[];
+export declare const staticContext: {
+    keysToRemove: Set<string>;
+    keysToAdd: never[];
+    revivers: {};
+};
+export declare class NetworkError extends Error {
+}
+export declare class HTTPError extends Error {
+    statusCode: number;
+    constructor(response: Response);
+}
+export declare class APIError extends Error {
+    code: string;
+    constructor(apiError: ApiError);
+}
+export declare function getSearchParams(search: Record<string, unknown>): URLSearchParams;
+export type Revivers<I extends ApiCommon, O extends Record<string, unknown>, R = Exclude<Flatten<Exclude<Exclude<I, ApiError>['data'], string | undefined>>, string>> = {
+    [K in keyof O | keyof R]?: K extends keyof O & keyof R ? ((data: R) => O[K]) | undefined : K extends Exclude<keyof O, keyof R> ? (data: R) => O[K] : K extends Exclude<keyof R, keyof O> ? undefined : never;
+};
+export interface ExtraOptions<I extends ApiCommon, O extends Record<string, unknown> | string> {
+    method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    revivers?: O extends Record<string, unknown> ? Revivers<I, O> : never;
+    sendNull?: boolean;
+    withMeta?: boolean;
+}
+export declare class APIMeta<I extends ApiCommon, O extends Record<string, unknown> | string, A = Exclude<I, ApiError>['data'] extends unknown[] ? true : false> extends Error {
+    data: A extends true ? O[] : O;
+    status: number;
+    headers: Headers;
+    constructor(data: A extends true ? O[] : O, headers: Headers, status: number);
+}
+export declare function request<I extends ApiCommon, O extends Record<string, unknown> | string, A = Exclude<I, ApiError>['data'] extends unknown[] ? true : false>(path: string, body?: XMLHttpRequestBodyInit | Record<string | number, unknown> | null, extraHeaders?: Record<string, string> | null, extraOptions?: ExtraOptions<I, O>): Promise<A extends true ? O[] : O>;
+interface Context<I extends ApiCommon, O extends Record<string, unknown>> {
+    keysToRemove: Set<string>;
+    keysToAdd: string[];
+    revivers: Revivers<I, O>;
+}
+export declare function getContext<I extends ApiCommon, O extends Record<string, unknown>>(revivers: Revivers<I, O>, keys?: string[]): Context<I, O>;
+export declare function processData<I extends ApiCommon, O extends Record<string, unknown>>(this: Context<I, O>, data: Exclude<Flatten<Exclude<Exclude<I, ApiError>['data'], string | undefined>>, string>): O;
+export declare function toApiType<T extends Record<string, unknown>>(body: T): SnakeCasedProperties<T>;
+export declare function toAppType<T extends Record<string, unknown>>(body: T): CamelCasedProperties<T>;
+export declare function ensureArray<T extends Record<string, unknown>>(data: T | T[]): T[];
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/esm/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAG5E,MAAM,MAAM,OAAO,CAAC,IAAI,IAAI,IAAI,SAAS,KAAK,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAEzE,MAAM,MAAM,aAAa,GAAG;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;CACrF;AAED,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KAE9C,CAAC;CACH;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE9C,eAAO,MAAM,MAAM,OAAO,CAAC;AAC3B,eAAO,MAAM,eAAe,SAAS,CAAC;AACtC,eAAO,MAAM,eAAe,SAAS,CAAC;AAEtC,eAAO,MAAM,iBAAiB;;CAAyB,CAAC;AACxD,eAAO,MAAM,gBAAgB,iBAAuC,CAAC;AAErE,eAAO,MAAM,YAAY,UAA6C,CAAC;AACvE,eAAO,MAAM,aAAa;;;;CAAuE,CAAC;AAGlG,qBAAa,YAAa,SAAQ,KAAK;CAAG;AAE1C,qBAAa,SAAU,SAAQ,KAAK;IAClC,UAAU,EAAE,MAAM,CAAC;gBACP,QAAQ,EAAE,QAAQ;CAI/B;AAED,qBAAa,QAAS,SAAQ,KAAK;IACjC,IAAI,EAAE,MAAM,CAAC;gBACD,QAAQ,EAAE,QAAQ;CAI/B;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,eAAe,CAuBhF;AAED,MAAM,MAAM,QAAQ,CAClB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,IACrF;KACD,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,GAClD,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,GAC/B,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACjC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GACjB,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACjC,SAAS,GACT,KAAK;CACd,CAAC;AACF,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAC3F,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IAC9D,QAAQ,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;IACtE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,qBAAa,OAAO,CAClB,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAC1C,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,EAAE,GAAG,IAAI,GAAG,KAAK,CACjE,SAAQ,KAAK;IACb,IAAI,EAAE,CAAC,SAAS,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;gBAEL,IAAI,EAAE,CAAC,SAAS,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM;CAO7E;AAED,wBAAsB,OAAO,CAC3B,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAC1C,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,EAAE,GAAG,IAAI,GAAG,KAAK,EAEjE,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,sBAAsB,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,EACvE,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,EAC5C,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAChC,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAmGnC;AAuCD,UAAU,OAAO,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtE,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1B;AAED,wBAAgB,UAAU,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/E,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EACxB,IAAI,WAAwB,GAC3B,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAMf;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChF,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EACnB,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,GACxF,CAAC,CAkBH;AAED,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAI7F;AAED,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAI7F;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,CAEjF"}

package/esm/utils.js

@@ -0,0 +1,206 @@
+import { apiHost, authenticate, token } from './oauth.js';
+export const myUser = 'me';
+export const myOrganisations = 'mine';
+export const lastJobRevision = 'last';
+export const defaultListHeader = { 'X-Per-Page': '50' };
+export const deletedNoneParam = getSearchParams({ deleted: 'none' });
+export const keysToRemove = ['created_at', 'deleted_at', 'updated_at'];
+export const staticContext = { keysToRemove: new Set(keysToRemove), keysToAdd: [], revivers: {} };
+// class AuthorizationError extends Error {}
+export class NetworkError extends Error {
+}
+export class HTTPError extends Error {
+    constructor(response) {
+        super(response.statusText);
+        this.statusCode = response.status;
+    }
+}
+export class APIError extends Error {
+    constructor(apiError) {
+        super(apiError.error.message);
+        this.code = apiError.error.type;
+    }
+}
+export function getSearchParams(search) {
+    return new URLSearchParams(Object.entries(search).reduce((arr, [key, value]) => {
+        if (Array.isArray(value)) {
+            arr.push(...value.map(val => [`${key}[]`, String(val)]));
+        }
+        else if (value !== null && typeof value === 'object') {
+            const params = getSearchParams(value);
+            arr.push(...Array.from(params.entries()).map(([subKey, val]) => [
+                ~subKey.indexOf('[')
+                    ? `${key}[${subKey.slice(0, subKey.indexOf('['))}]${subKey.slice(subKey.indexOf('['))}`
+                    : `${key}[${subKey}]`,
+                val,
+            ]));
+        }
+        else {
+            arr.push([key, String(value)]);
+        }
+        return arr;
+    }, []));
+}
+export class APIMeta extends Error {
+    constructor(data, headers, status) {
+        super();
+        this.data = data;
+        this.status = status;
+        this.headers = headers;
+    }
+}
+export async function request(path, body, extraHeaders, extraOptions) {
+    const href = `${apiHost}${path}`;
+    const init = getRequestInit(body, extraHeaders, extraOptions);
+    const response = await fetch(href, init).catch((error) => {
+        var _a;
+        throw new NetworkError((_a = error === null || error === void 0 ? void 0 : error.message) !== null && _a !== void 0 ? _a : error);
+    });
+    if (response.ok) {
+        const json = (await response.json().catch(() => ({
+            success: false,
+            error: { type: 'SyntaxError', message: 'Malformed JSON response' },
+        })));
+        if (json.success) {
+            const { data } = json;
+            const withMeta = extraOptions === null || extraOptions === void 0 ? void 0 : extraOptions.withMeta;
+            const revivers = extraOptions === null || extraOptions === void 0 ? void 0 : extraOptions.revivers;
+            const keys = revivers ? Object.keys(revivers) : [];
+            const context = revivers && keys.length
+                ? getContext(revivers, keys)
+                : staticContext;
+            let result;
+            if (Array.isArray(data)) {
+                let moreData = [];
+                const headers = response.headers;
+                // @ts-expect-error TS2362, get valid number or 0
+                const total = headers.get('X-Paginate-Total') | 0;
+                if (!withMeta && ((data.length && total > data.length) || response.status === 206)) {
+                    // @ts-expect-error TS2362, get valid number or 0
+                    const offset = `${(headers.get('X-Paginate-Offset') | 0) + data.length}`;
+                    moreData = await request(path, body, Object.assign(Object.assign({}, extraHeaders), { 'X-Offset': offset }), extraOptions);
+                }
+                if (data.length) {
+                    result = (typeof data[0] !== 'string'
+                        ? data.map(processData, context)
+                        : data).concat(moreData);
+                }
+                else {
+                    result = moreData;
+                }
+            }
+            else {
+                if (data !== undefined) {
+                    // @ts-expect-error TS2345, TODO: fix type error for the `context` object
+                    result = (typeof data !== 'string' ? processData.call(context, data) : data);
+                }
+                else {
+                    result = {};
+                }
+            }
+            if (withMeta) {
+                throw new APIMeta(result, response.headers, response.status);
+            }
+            return result;
+        }
+        else {
+            throw new APIError(json);
+        }
+    }
+    else {
+        // TODO: parse and process all typical errors
+        // eslint-disable-next-line default-case
+        switch (response.status) {
+            case 401:
+                authenticate();
+                break; // NO-OP
+            case 403:
+            case 404:
+            case 406:
+                throw new APIError((await response.json().catch(() => ({
+                    success: false,
+                    error: { type: 'HttpException', message: response.statusText },
+                }))));
+            case 429:
+                await new Promise((resolve) => { setTimeout(resolve, response.headers.get('X-RateLimit-Reset') * 1000 || 500); });
+                return request(path, body, extraHeaders, extraOptions);
+        }
+        throw new HTTPError(response);
+    }
+}
+function getRequestInit(body, extraHeaders, extraOptions) {
+    var _a;
+    const authorization = token ? { Authorization: token.toString() } : null;
+    let contentType = null;
+    if (body !== undefined) {
+        switch (true) {
+            case typeof body === 'string':
+                contentType = { 'Content-Type': 'text/plain' };
+                break;
+            case body instanceof FormData: // Autofilled with 'multipart/form-data'
+            case body instanceof URLSearchParams: // Autofilled with 'application/x-www-form-urlencoded'
+                break;
+            case body instanceof Blob: // File is instance of Blob too
+                contentType = { 'Content-Type': body.type || 'application/octet-stream' };
+                break;
+            case body instanceof ArrayBuffer:
+            case ArrayBuffer.isView(body):
+                contentType = { 'Content-Type': 'application/octet-stream' };
+                break;
+            case body === null && !(extraOptions === null || extraOptions === void 0 ? void 0 : extraOptions.sendNull):
+                break;
+            default:
+                contentType = { 'Content-Type': 'application/json' };
+                body = JSON.stringify(body);
+        }
+    }
+    const headers = Object.assign(Object.assign(Object.assign({ Accept: 'application/json' }, authorization), contentType), extraHeaders);
+    const method = (_a = extraOptions === null || extraOptions === void 0 ? void 0 : extraOptions.method) !== null && _a !== void 0 ? _a : (body != null ? 'POST' : 'GET'); // don't touch `!=` please
+    return { body, headers, method };
+}
+export function getContext(revivers, keys = Object.keys(revivers)) {
+    return {
+        keysToRemove: new Set(keys.filter(isUndefined, revivers).concat(keysToRemove)),
+        keysToAdd: keys.filter(isReviver, revivers),
+        revivers,
+    };
+}
+export function processData(data) {
+    const result = {};
+    const keys = Object.keys(data).filter(isPreserved, this.keysToRemove);
+    for (let i = 0; i < keys.length; ++i) {
+        result[toCamelCase(keys[i])] = data[keys[i]];
+    }
+    if (this.keysToAdd.length) {
+        const keys = this.keysToAdd;
+        for (let i = 0; i < keys.length; ++i) {
+            result[keys[i]] = this.revivers[keys[i]](data);
+        }
+    }
+    return result;
+} /* eslint-enable @typescript-eslint/prefer-for-of */
+export function toApiType(body) {
+    return Object.fromEntries(Object.entries(body).map(([k, v]) => [toSnakeCase(k), v]));
+}
+export function toAppType(body) {
+    return Object.fromEntries(Object.entries(body).map(([k, v]) => [toCamelCase(k), v]));
+}
+export function ensureArray(data) {
+    return Array.isArray(data) ? data : [data];
+}
+function toCamelCase(key) {
+    return key.replace(/_+(.)/g, (_, c) => c.toUpperCase());
+}
+function toSnakeCase(key) {
+    return key.replace(/[A-Z]/g, '_$&').toLowerCase();
+}
+function isUndefined(key) {
+    return this[key] === undefined;
+}
+function isReviver(key) {
+    return this[key] !== undefined;
+}
+function isPreserved(key) {
+    return !this.has(key);
+}
+//# sourceMappingURL=utils.js.map

package/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AA2B1D,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,CAAC;AAC3B,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;AACtC,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;AAEtC,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;AACxD,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;AAErE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,YAAY,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;AACvE,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,YAAY,EAAE,IAAI,GAAG,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;AAElG,4CAA4C;AAC5C,MAAM,OAAO,YAAa,SAAQ,KAAK;CAAG;AAE1C,MAAM,OAAO,SAAU,SAAQ,KAAK;IAElC,YAAY,QAAkB;QAC5B,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC;IACpC,CAAC;CACF;AAED,MAAM,OAAO,QAAS,SAAQ,KAAK;IAEjC,YAAY,QAAkB;QAC5B,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;IAClC,CAAC;CACF;AAED,MAAM,UAAU,eAAe,CAAC,MAA+B;IAC7D,OAAO,IAAI,eAAe,CACxB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAa,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvD,MAAM,MAAM,GAAG,eAAe,CAAC,KAAgC,CAAC,CAAC;YAEjE,GAAG,CAAC,IAAI,CACN,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC;gBACrD,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;oBAClB,CAAC,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;oBACvF,CAAC,CAAC,GAAG,GAAG,IAAI,MAAM,GAAG;gBACvB,GAAG;aACJ,CAAC,CACH,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CACP,CAAC;AACJ,CAAC;AAsBD,MAAM,OAAO,OAIX,SAAQ,KAAK;IAKb,YAAY,IAA8B,EAAE,OAAgB,EAAE,MAAc;QAC1E,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,OAAO,CAK3B,IAAY,EACZ,IAAuE,EACvE,YAA4C,EAC5C,YAAiC;IAIjC,MAAM,IAAI,GAAG,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;IAE9D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;;QAC9D,MAAM,IAAI,YAAY,CAAC,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,mCAAI,KAAK,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;QAChB,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;YAC/C,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,yBAAyB,EAAE;SACnE,CAAC,CAAC,CAAM,CAAC;QAEV,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAEtB,MAAM,QAAQ,GAAG,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,QAAQ,CAAC;YACxC,MAAM,QAAQ,GAAG,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,QAAQ,CAAC;YACxC,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnD,MAAM,OAAO,GACX,QAAQ,IAAI,IAAI,CAAC,MAAM;gBACrB,CAAC,CAAC,UAAU,CAAC,QAAgD,EAAE,IAAI,CAAC;gBACpE,CAAC,CAAC,aAAa,CAAC;YAEpB,IAAI,MAAS,CAAC;YAEd,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxB,IAAI,QAAQ,GAAG,EAAkB,CAAC;gBAClC,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;gBACjC,iDAAiD;gBACjD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;gBAElD,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,EAAE,CAAC;oBACnF,iDAAiD;oBACjD,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;oBAEzE,QAAQ,GAAG,MAAM,OAAO,CACtB,IAAI,EAAE,IAAI,kCAAO,YAAY,KAAE,UAAU,EAAE,MAAM,KAAI,YAAY,CAClE,CAAC;gBACJ,CAAC;gBAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBAChB,MAAM,GAAG,CACP,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ;wBACzB,CAAC,CAAE,IAAuC,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC;wBACpE,CAAC,CAAC,IAAI,CACT,CAAC,MAAM,CAAC,QAAQ,CAAM,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,QAAQ,CAAC;gBACpB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACvB,yEAAyE;oBACzE,MAAM,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAM,CAAC;gBACpF,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,EAAO,CAAC;gBACnB,CAAC;YACH,CAAC;YAED,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,IAAI,OAAO,CAAU,MAAM,EAAE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YACxE,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;SAAM,CAAC;QACN,6CAA6C;QAC7C,wCAAwC;QACxC,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,GAAG;gBACN,YAAY,EAAE,CAAC;gBACf,MAAM,CAAC,QAAQ;YACjB,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;YACJ,KAAK,GAAG;gBACN,MAAM,IAAI,OAAO,CACf,CACE,OAAO,EACP,EAAE,GAAG,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,GAAG,IAAI,IAAI,GAAG,CAAC,CAAA,CAAC,CAAC,CACtF,CAAC;gBAEF,OAAO,OAAO,CAAU,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CACrB,IAAuE,EACvE,YAA4C,EAC5C,YAAiC;;IAEjC,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,IAAI,WAAW,GAAG,IAAyC,CAAC;IAE5D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,OAAO,IAAI,KAAK,QAAQ;gBAC3B,WAAW,GAAG,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC;gBAC/C,MAAM;YACR,KAAK,IAAI,YAAY,QAAQ,CAAC,CAAC,wCAAwC;YACvE,KAAK,IAAI,YAAY,eAAe,EAAE,sDAAsD;gBAC1F,MAAM;YACR,KAAK,IAAI,YAAY,IAAI,EAAE,+BAA+B;gBACxD,WAAW,GAAG,EAAE,cAAc,EAAE,IAAI,CAAC,IAAI,IAAI,0BAA0B,EAAE,CAAC;gBAC1E,MAAM;YACR,KAAK,IAAI,YAAY,WAAW,CAAC;YACjC,KAAK,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC3B,WAAW,GAAG,EAAE,cAAc,EAAE,0BAA0B,EAAE,CAAC;gBAC7D,MAAM;YACR,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,QAAQ,CAAA;gBAC3C,MAAM;YACR;gBACE,WAAW,GAAG,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;gBACrD,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,MAAM,OAAO,+CAAK,MAAM,EAAE,kBAAkB,IAAK,aAAa,GAAK,WAAW,GAAK,YAAY,CAAE,CAAC;IAClG,MAAM,MAAM,GAAG,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,mCAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,0BAA0B;IAElG,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAiB,CAAC;AAClD,CAAC;AAQD,MAAM,UAAU,UAAU,CACxB,QAAwB,EACxB,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;IAE5B,OAAO;QACL,YAAY,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC9E,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC;QAC3C,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAEzB,IAAyF;IAEzF,MAAM,MAAM,GAAG,EAA6B,CAAC;IAE7C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAEtE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QAE5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACrC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,MAAW,CAAC;AACrB,CAAC,CAAC,oDAAoD;AAEtD,MAAM,UAAU,SAAS,CAAoC,IAAO;IAClE,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAC/B,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,SAAS,CAAoC,IAAO;IAClE,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAC/B,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,WAAW,CAAoC,IAAa;IAC1E,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AACpD,CAAC;AAED,SAAS,WAAW,CAAgC,GAAW;IAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;AACjC,CAAC;AAED,SAAS,SAAS,CAAgC,GAAW;IAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;AACjC,CAAC;AAED,SAAS,WAAW,CAAoB,GAAW;IACjD,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC"}

package/package.json

@@ -1,148 +1,77 @@
 {
   "name": "@mapcreator/api",
-  "version": "3.3.0",
+  "version": "5.0.0-alpha.12",
   "description": "Mapcreator JavaScript API",
-  "main": "dist/bundle.js",
-  "repository": "https://gitlab.com/mapcreator/api-wrapper.git",
-  "author": "Bas Bieling <b.bieling@mapcreator.eu>",
   "license": "BSD-3-Clause",
-  "types": "dist/index.d.ts",
+  "main": "./cjs/index.js",
+  "types": "./cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./esm/index.d.ts",
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js"
+    },
+    "./oauth": {
+      "types": "./esm/oauth.d.ts",
+      "import": "./esm/oauth.js",
+      "require": "./cjs/oauth.js"
+    },
+    "./oauth.js": {
+      "types": "./esm/oauth.d.ts",
+      "import": "./esm/oauth.js",
+      "require": "./cjs/oauth.js"
+    },
+    "./utils": {
+      "types": "./esm/utils.d.ts",
+      "import": "./esm/utils.js",
+      "require": "./cjs/utils.js"
+    },
+    "./utils.js": {
+      "types": "./esm/utils.d.ts",
+      "import": "./esm/utils.js",
+      "require": "./cjs/utils.js"
+    },
+    "./package.json": "./package.json",
+    "./*": {
+      "types": "./esm/api/*.d.ts",
+      "import": "./esm/api/*.js",
+      "require": "./cjs/api/*.js"
+    },
+    "./*.js": {
+      "types": "./esm/api/*.d.ts",
+      "import": "./esm/api/*.js",
+      "require": "./cjs/api/*.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc --outDir esm && tsc -m commonjs --outDir cjs",
+    "clean": "npx rimraf esm/ cjs/",
+    "lint": "eslint --ext .ts src",
+    "prepublishOnly": "npm run lint && npm run clean && npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/mapcreator/api-wrapper.git"
+  },
   "files": [
-    "dist",
-    "src",
-    "manual"
+    "cjs",
+    "esm",
+    "src"
   ],
+  "bugs": {
+    "url": "https://gitlab.com/mapcreator/api-wrapper/issues"
+  },
+  "homepage": "https://gitlab.com/mapcreator/api-wrapper#readme",
   "dependencies": {
-    "@babel/runtime": "^7.10.2",
-    "case": "^1.6.3",
-    "form-data": "^3.0.0",
-    "json-stable-stringify": "^1.0.1",
-    "ky": "^0.21.0",
-    "ky-universal": "^0.8.1",
-    "mitt": "^1.2.0"
+    "@types/geojson": "^7946.0.14",
+    "type-fest": "^4.10"
   },
   "devDependencies": {
-    "@babel/core": "^7.10.2",
-    "@babel/plugin-proposal-class-properties": "^7.10.1",
-    "@babel/plugin-proposal-export-default-from": "^7.10.1",
-    "@babel/plugin-proposal-export-namespace-from": "^7.10.1",
-    "@babel/plugin-transform-runtime": "^7.10.1",
-    "@babel/preset-env": "^7.10.2",
-    "babel-eslint": "^10.1.0",
-    "babel-jest": "^26.0.1",
-    "babel-loader": "^8.1.0",
-    "contributors": "^0.5.1",
-    "dotenv-webpack": "^7.1.0",
-    "esdoc": "^1.1.0",
-    "esdoc-ecmascript-proposal-plugin": "^1.0.0",
-    "esdoc-inject-script-plugin": "^1.0.0",
-    "esdoc-inject-style-plugin": "^1.0.0",
-    "esdoc-standard-plugin": "^1.0.0",
-    "eslint": "^5.12.0",
-    "eslint-plugin-compat": "^3.7.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "fs-extra": "^9.0.1",
-    "jest": "^26.0.1",
-    "jest-junit": "^10.0.0",
-    "licensecheck": "^1.3.0",
-    "nock": "^13.0.3",
-    "nyc": "^15.1.0",
-    "tap-nyc": "^1.0.3",
-    "terser-webpack-plugin": "^5.3.1",
-    "typescript": "^4.9.4",
-    "webpack": "^5.68.0",
-    "webpack-bundle-analyzer": "^4.5.0",
-    "webpack-cli": "^4.9.2",
-    "webpack-merge": "^5.8.0",
-    "webpack-node-externals": "^3.0.0"
-  },
-  "scripts": {
-    "build": "APP_ENV=production npx webpack",
-    "postbuild": "APP_ENV=production npx tsc || true && rm -v dist/*.map dist/**/*.map",
-    "watch": "npx webpack --progress --watch",
-    "docs": "npx esdoc && ./scripts/inject_docs_viewport.sh",
-    "lint": "npx eslint --no-color --format checkstyle --output-file build/checkstyle.xml src",
-    "clean": "rm -fr dist docs build || true",
-    "all": "npm run clean && npm run lint && npm run build && npm run test && npm run docs",
-    "test": "npx jest",
-    "test-ci": "npx jest --coverage --ci --verbose"
-  },
-  "contributors": [
-    "Bas Bieling <b.bieling@mapcreator.eu> (https://GitHub.com/Mechazawa)"
-  ],
-  "browserslist": [
-    "> 1%",
-    "Firefox ESR",
-    "not dead",
-    "not IE_mob < 12",
-    "not OperaMini all"
-  ],
-  "esdoc": {
-    "source": "./src",
-    "destination": "./docs",
-    "name": "mapcreator",
-    "plugins": [
-      {
-        "name": "esdoc-standard-plugin",
-        "option": {
-          "accessor": {
-            "access": [
-              "public",
-              "protected"
-            ],
-            "autoPrivate": true
-          },
-          "undocumentIdentifier": {
-            "enable": true
-          },
-          "unexportedIdentifier": {
-            "enable": false
-          },
-          "typeInference": {
-            "enable": true
-          },
-          "brand": {
-            "title": "Mapcreator Api Wrapper",
-            "description": "Mapcreator Api Javascript Wrapper"
-          },
-          "manual": {
-            "asset": "./manual/assets",
-            "index": "./README.md",
-            "files": [
-              "./manual/examples.md",
-              "./manual/examples.authentication.md",
-              "./manual/building.md",
-              "./manual/installation.md"
-            ]
-          }
-        }
-      },
-      {
-        "name": "esdoc-ecmascript-proposal-plugin",
-        "option": {
-          "all": true
-        }
-      },
-      {
-        "name": "esdoc-inject-script-plugin",
-        "option": {
-          "enable": true,
-          "scripts": [
-            "./dist/bundle.browser.js",
-            "./manual/js/sandbox.js"
-          ]
-        }
-      },
-      {
-        "name": "esdoc-inject-style-plugin",
-        "option": {
-          "enable": true,
-          "styles": [
-            "./manual/css/sidebar_fix.css",
-            "./manual/css/hide_import.css"
-          ]
-        }
-      }
-    ]
+    "@stylistic/eslint-plugin": "~1.5",
+    "@typescript-eslint/eslint-plugin": "~6.15",
+    "@typescript-eslint/parser": "~6.15",
+    "eslint": "~8.57",
+    "typescript": "~5.4.5"
   }
 }

package/src/README.md

@@ -0,0 +1,126 @@
+### Used type system
+
+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.
+
+All in all, we can use TypeScript's native mechanisms to convert one type to another and fully define just one type:
+
+```typescript
+import type { CamelCasedProperties } from 'type-fest';
+
+type ApiType =
+  | ({
+      data: {
+        prop: unknown;
+      } & ApiCommonData;
+    } & Omit<ApiSuccess, 'data'>)
+  | ApiError;
+
+type AppType = CamelCasedProperties<Omit<Exclude<ApiType, ApiError>['data'], keyof ApiCommonData>>;
+```
+
+or in reverse order:
+
+```typescript
+import type { SnakeCasedProperties } from 'type-fest';
+
+type AppType = {
+  prop: unknown;
+};
+
+type ApiType =
+  | ({
+      data: SnakeCasedProperties<AppType> & ApiCommonData;
+    } & Omit<ApiSuccess, 'data'>)
+  | ApiError;
+```
+
+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.
+
+### Using a `request()`
+
+The function has the following signature:
+
+```typescript
+async function request<I extends ApiCommon, O extends Record<string, unknown> | string>(
+  path: string,
+  body?: XMLHttpRequestBodyInit | Record<string | number, unknown> | null,
+  extraHeaders?: Record<string, string> | null,
+  extraOptions?: ExtraOptions<I, O>,
+): Promise<O | O[]> { /* ... */ }
+```
+
+Let's take it step by step.
+
+`I extends ApiCommon` - represents the type of data we receive over the network.
+
+`O extends Record<string, unknown> | string` - represents the data type that will be used in the application.
+
+Ideally you should describe and convey both types. This will help to check the data types in the arguments passed.
+See current data types for an example.
+
+`path: string` - the path to the resource, must include the API version, but must not include the schema or authority.
+Example: `/v1/jobs/12345`
+
+`body?: XMLHttpRequestBodyInit | Record<string | number, unknown> | null` - any meaningful body type. In general,
+the presence of an JSON object is assumed (or the absence of one for methods that only request data), but you can
+also pass `Blob`, `FormData`, `URLSearchParams` or just `ArrayBuffer`. The required content type will be added to
+the headers automatically.
+
+`extraHeaders?: Record<string, string> | null` - the object with additional headers.
+
+`extraOptions?: ExtraOptions<I, O>` - where `ExtraOptions<I, O>` is defined like this:
+
+```typescript
+interface ExtraOptions<I extends ApiCommon, O extends Record<string, unknown> | string> {
+  method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+  revivers?: O extends Record<string, unknown> ? Revivers<I, O> : never;
+  sendNull?: boolean;
+  withMeta?: boolean;
+}
+```
+
+Most fields are self-explanatory.
+
+`sendNull` can be used if you really want to pass `null` as body content.
+
+`revivers` is used to specify an object that can modify the behavior of the internal handler of data coming over
+the network. Let's take a closer look at this moment.
+
+#### Revivers
+
+By default, the `request()` function does the following things with data coming over the network:
+
+- It removes `created_at`, `updated_at`, `deleted_at` fields from the output objects.
+- It preserves all the remaining fields but converts their names into camelCase.
+
+When passing an object with revivers you can a couple of things:
+
+- You can list the fields that you want **to exclude** from the result object. To do this, the field must be assigned an
+`undefined` value.
+- You can **add** new fields or **modify** the type of existing ones. To do this, you need to pass a function as a field
+value, which will receive the original object as input.
+
+Example:
+
+```typescript
+const jobRevivers: Revivers<ApiJob, Job> = {
+  user_id: undefined,
+  description: undefined,
+  share_token: undefined,
+  autosave_preview_path: undefined,
+  job_folder_id: undefined,
+
+  jobTypeId: () => 9,
+  createdAt: (data: ApiJobData) => data.created_at as string,
+  previewPath: (data: ApiJobData) => (data.preview_path as string | null) ?? data.autosave_preview_path ?? undefined,
+};
+```
+
+`user_id`, `description`, `share_token`, `autosave_preview_path`, `job_folder_id` fields will be excluded from the
+result object.
+
+`jobTypeId` will be always **9**.
+
+`createdAt` will be returned (please note that that field is excluded by default)
+
+`previewPath` - some actions will be performed with the source data.