@mapcreator/api 0.0.0-wms.0 → 0.0.0-wms.1

package/src/api/insetMap.ts

@@ -1,96 +1,96 @@
-import { apiHost, authenticate, token } from '../oauth.js';
-import {
-  APIError,
-  type ApiCommonData,
-  type ApiError,
-  type ApiSuccess,
-  type Flatten,
-  HTTPError,
-  NetworkError,
-  request,
-} from '../utils.js';
-
-export type InsetMap = {
-  id: number;
-  description: string;
-  jsonFilename: string;
-  latMin: number;
-  lngMin: number;
-  latMax: number;
-  lngMax: number;
-};
-
-export type ApiInsetMap = {
-  data: {
-    id: number;
-    description: string;
-    json_filename: string;
-    lat_min: number;
-    lng_min: number;
-    lat_max: number;
-    lng_max: number;
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiInsetMapData = Flatten<Exclude<ApiInsetMap, ApiError>['data']>;
-
-type Boundary = {
-  topLeft: {
-    lat: number;
-    lng: number;
-  };
-  bottomRight: {
-    lat: number;
-    lng: number;
-  };
-};
-
-export async function listInsetMaps(boundary: Boundary): Promise<InsetMap[]> {
-  const path = `/v1/inset-maps/for-boundary`;
-
-  type ApiInsetMapArray = {
-    data: ApiInsetMapData[];
-  } & Omit<ApiSuccess, 'data'> | ApiError;
-
-  return request<ApiInsetMapArray, InsetMap>(path, boundary);
-}
-
-export async function getInsetMap(insetMapId: number): Promise<InsetMap> {
-  const path = `/v1/inset-maps/${insetMapId}`;
-
-  return request<ApiInsetMap, InsetMap>(path);
-}
-
-export async function getInsetMapTopoJson<TopoJSON>(insetMapId: number): Promise<TopoJSON> {
-  const href = `${apiHost}/v1/inset-maps/${insetMapId}/json`;
-  const headers = { Accept: 'application/json', ...(token ? { Authorization: token.toString() } : null) };
-  const response = await fetch(href, { headers }).catch((error: Error) => {
-    throw new NetworkError(error?.message ?? error);
-  });
-
-  if (response.ok) {
-    return response.json().catch(() => {
-      throw new APIError({
-        success: false,
-        error: { type: 'SyntaxError', message: 'Malformed JSON response' },
-      });
-    }) as Promise<TopoJSON>;
-  } else {
-    // eslint-disable-next-line default-case
-    switch (response.status) {
-      case 401:
-        await authenticate();
-        break; // NO-OP
-      case 403:
-      case 404:
-      case 406:
-      case 429:
-        throw new APIError({
-          success: false,
-          error: { type: 'HttpException', message: response.statusText },
-        });
-    }
-
-    throw new HTTPError(response);
-  }
-}
+import { apiHost, authenticate, token } from '../oauth.js';
+import {
+  APIError,
+  type ApiCommonData,
+  type ApiError,
+  type ApiSuccess,
+  type Flatten,
+  HTTPError,
+  NetworkError,
+  request,
+} from '../utils.js';
+
+export type InsetMap = {
+  id: number;
+  description: string;
+  jsonFilename: string;
+  latMin: number;
+  lngMin: number;
+  latMax: number;
+  lngMax: number;
+};
+
+export type ApiInsetMap = {
+  data: {
+    id: number;
+    description: string;
+    json_filename: string;
+    lat_min: number;
+    lng_min: number;
+    lat_max: number;
+    lng_max: number;
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiInsetMapData = Flatten<Exclude<ApiInsetMap, ApiError>['data']>;
+
+type Boundary = {
+  topLeft: {
+    lat: number;
+    lng: number;
+  };
+  bottomRight: {
+    lat: number;
+    lng: number;
+  };
+};
+
+export async function listInsetMaps(boundary: Boundary): Promise<InsetMap[]> {
+  const path = `/v1/inset-maps/for-boundary`;
+
+  type ApiInsetMapArray = {
+    data: ApiInsetMapData[];
+  } & Omit<ApiSuccess, 'data'> | ApiError;
+
+  return request<ApiInsetMapArray, InsetMap>(path, { boundary });
+}
+
+export async function getInsetMap(insetMapId: number): Promise<InsetMap> {
+  const path = `/v1/inset-maps/${insetMapId}`;
+
+  return request<ApiInsetMap, InsetMap>(path);
+}
+
+export async function getInsetMapTopoJson<TopoJSON>(insetMapId: number): Promise<TopoJSON> {
+  const href = `${apiHost}/v1/inset-maps/${insetMapId}/json`;
+  const headers = { Accept: 'application/json', ...(token ? { Authorization: token.toString() } : null) };
+  const response = await fetch(href, { headers }).catch((error: Error) => {
+    throw new NetworkError(error?.message ?? error);
+  });
+
+  if (response.ok) {
+    return response.json().catch(() => {
+      throw new APIError({
+        success: false,
+        error: { type: 'SyntaxError', message: 'Malformed JSON response' },
+      });
+    }) as Promise<TopoJSON>;
+  } else {
+    // eslint-disable-next-line default-case
+    switch (response.status) {
+      case 401:
+        await authenticate();
+        break; // NO-OP
+      case 403:
+      case 404:
+      case 406:
+      case 429:
+        throw new APIError({
+          success: false,
+          error: { type: 'HttpException', message: response.statusText },
+        });
+    }
+
+    throw new HTTPError(response);
+  }
+}

package/src/api/job.ts

@@ -1,129 +1,130 @@
-import type { ApiJobShare, JobShare, JobShareVisibility } from './jobShare.js';
-import { type JobSearchResult, listJobs } from './apiCommon.js';
-import {
-  type ApiCommon,
-  type ApiCommonData,
-  type ApiError,
-  type ApiSuccess,
-  type Flatten,
-  type Revivers,
-  deletedNoneParam,
-  request,
-} from '../utils.js';
-
-export type Job = {
-  id: number;
-  jobTypeId: number;
-  title: string;
-  previewPath: string | undefined;
-  createdAt: string;
-  star: boolean;
-  jobFolderId: number | null;
-  userEmail: string | undefined;
-  jobFolderName: string | null;
-  userId: number;
-};
-
-export type ApiJob = {
-  data: {
-    id: number;                 // The job id (sortable)
-    job_type_id: number;        // The id of the job type (searchable)
-    user_id: number;            // The user id (searchable)
-    title: string;              // The title of the job (searchable, sortable)
-    description: string | null; // The description of the job (searchable, sortable)
-    share_token: string | null; // The token used for sharing this job
-    autosave_preview_path: string | null; //  The preview path of the Job
-    job_folder_id: number | null; // TODO: not present in API specification!
-    job_folder_name?: string | null; // TODO: not present in API specification!
-    star: boolean;              // TODO: not present in API specification!
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiJobData = Flatten<Exclude<ApiJob, ApiError>['data']>;
-
-export const jobRevivers: Revivers<ApiJob, Job> = {
-  description: undefined,
-  share_token: undefined,
-  autosave_preview_path: undefined,
-
-  jobTypeId: () => 9,
-  jobFolderName: (data: ApiJobData) => data.job_folder_name ?? null,
-  createdAt: (data: ApiJobData) => data.created_at as string,
-  previewPath: (data: ApiJobData) => data.autosave_preview_path ?? undefined,
-};
-
-export async function createJob(title: string): Promise<Job> {
-  const path = `/v1/jobs`;
-  const body = { title, job_type_id: 9 };
-  const options = { revivers: jobRevivers };
-
-  // Technically, the returning `data` will contain only the following fields:
-  // Pick<ApiJobData, 'id' | 'job_type_id' | 'user_id' | 'title' | 'created_at' | 'updated_at'>
-
-  return request<ApiJob, Job>(path, body, null, options);
-}
-
-export async function getJob(jobId: number): Promise<Job> {
-  const path = `/v1/jobs/${jobId}`;
-  const options = { revivers: jobRevivers };
-
-  return request<ApiJob, Job>(path, null, null, options);
-}
-
-export async function deleteJob(jobId: number): Promise<Record<string, never>> {
-  const path = `/v1/jobs/${jobId}`;
-
-  return request<ApiCommon, Record<string, never>>(path, null, null, { method: 'DELETE' });
-}
-
-export async function updateJob(jobId: number, newTitle: string): Promise<Record<string, never>> {
-  const path = `/v1/jobs/${jobId}`;
-  const body = { title: newTitle };
-
-  return request<ApiCommon, Record<string, never>>(path, body, null, { method: 'PATCH' });
-}
-
-export async function updateJobFolder(jobId: number, folderId: number | null): Promise<Record<string, never>> {
-  const path = `/v1/jobs/${jobId}`;
-  const body = { job_folder_id: folderId };
-
-  return request<ApiCommon, Record<string, never>>(path, body, null, { method: 'PATCH' });
-}
-
-export async function starJob(jobId: number, star: boolean): Promise<Record<string, never>> {
-  const path = `/v1/jobs/${jobId}`;
-  const body = { star };
-
-  return request<ApiCommon, Record<string, never>>(path, body, null, { method: 'PATCH' });
-}
-
-export async function generateJobShare(
-  jobId: number,
-  visibility: JobShareVisibility,
-): Promise<JobShare> {
-  const path = `/v1/jobs/${jobId}/share`;
-  const body = { visibility };
-
-  return request<ApiJobShare, JobShare>(path, body);
-}
-
-export async function uploadJobPreview(
-  jobId: number,
-  preview: Blob,
-): Promise<Record<string, never>> {
-  const pathname = `/v1/jobs/${jobId}/preview`;
-  const path = `${pathname}?${deletedNoneParam}`;
-  const body = new FormData();
-
-  body.append('preview', preview);
-
-  return request<ApiCommon, Record<string, never>>(path, body);
-}
-
-export async function listFeaturedJobs(
-  title: string,
-  page: number,
-  options?: Record<string, unknown>,
-): Promise<JobSearchResult> {
-  return listJobs(`/v1/jobs/featured`, title, page, options);
-}
+import type { ApiJobShare, JobShare, JobShareVisibility } from './jobShare.js';
+import { type JobSearchResult, listJobs } from './apiCommon.js';
+import {
+  type ApiCommon,
+  type ApiCommonData,
+  type ApiError,
+  type ApiSuccess,
+  type Flatten,
+  type Revivers,
+  deletedNoneParam,
+  request,
+} from '../utils.js';
+
+export type Job = {
+  id: number;
+  jobTypeId: number;
+  title: string;
+  previewPath: string | undefined;
+  createdAt: string;
+  star: boolean;
+  jobFolderId: number | null;
+  userEmail: string | undefined;
+  jobFolderName: string | null;
+  userId: number;
+  orgName: string | undefined;
+};
+
+export type ApiJob = {
+  data: {
+    id: number;                 // The job id (sortable)
+    job_type_id: number;        // The id of the job type (searchable)
+    user_id: number;            // The user id (searchable)
+    title: string;              // The title of the job (searchable, sortable)
+    description: string | null; // The description of the job (searchable, sortable)
+    share_token: string | null; // The token used for sharing this job
+    autosave_preview_path: string | null; //  The preview path of the Job
+    job_folder_id: number | null; // TODO: not present in API specification!
+    job_folder_name?: string | null; // TODO: not present in API specification!
+    star: boolean;              // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiJobData = Flatten<Exclude<ApiJob, ApiError>['data']>;
+
+export const jobRevivers: Revivers<ApiJob, Job> = {
+  description: undefined,
+  share_token: undefined,
+  autosave_preview_path: undefined,
+
+  jobTypeId: () => 9,
+  jobFolderName: (data: ApiJobData) => data.job_folder_name ?? null,
+  createdAt: (data: ApiJobData) => data.created_at as string,
+  previewPath: (data: ApiJobData) => data.autosave_preview_path ?? undefined,
+};
+
+export async function createJob(title: string): Promise<Job> {
+  const path = `/v1/jobs`;
+  const body = { title, job_type_id: 9 };
+  const options = { revivers: jobRevivers };
+
+  // Technically, the returning `data` will contain only the following fields:
+  // Pick<ApiJobData, 'id' | 'job_type_id' | 'user_id' | 'title' | 'created_at' | 'updated_at'>
+
+  return request<ApiJob, Job>(path, body, null, options);
+}
+
+export async function getJob(jobId: number): Promise<Job> {
+  const path = `/v1/jobs/${jobId}`;
+  const options = { revivers: jobRevivers };
+
+  return request<ApiJob, Job>(path, null, null, options);
+}
+
+export async function deleteJob(jobId: number): Promise<Record<string, never>> {
+  const path = `/v1/jobs/${jobId}`;
+
+  return request<ApiCommon, Record<string, never>>(path, null, null, { method: 'DELETE' });
+}
+
+export async function updateJob(jobId: number, newTitle: string): Promise<Record<string, never>> {
+  const path = `/v1/jobs/${jobId}`;
+  const body = { title: newTitle };
+
+  return request<ApiCommon, Record<string, never>>(path, body, null, { method: 'PATCH' });
+}
+
+export async function updateJobFolder(jobId: number, folderId: number | null): Promise<Record<string, never>> {
+  const path = `/v1/jobs/${jobId}`;
+  const body = { job_folder_id: folderId };
+
+  return request<ApiCommon, Record<string, never>>(path, body, null, { method: 'PATCH' });
+}
+
+export async function starJob(jobId: number, star: boolean): Promise<Record<string, never>> {
+  const path = `/v1/jobs/${jobId}`;
+  const body = { star };
+
+  return request<ApiCommon, Record<string, never>>(path, body, null, { method: 'PATCH' });
+}
+
+export async function generateJobShare(
+  jobId: number,
+  visibility: JobShareVisibility,
+): Promise<JobShare> {
+  const path = `/v1/jobs/${jobId}/share`;
+  const body = { visibility };
+
+  return request<ApiJobShare, JobShare>(path, body);
+}
+
+export async function uploadJobPreview(
+  jobId: number,
+  preview: Blob,
+): Promise<Record<string, never>> {
+  const pathname = `/v1/jobs/${jobId}/preview`;
+  const path = `${pathname}?${deletedNoneParam}`;
+  const body = new FormData();
+
+  body.append('preview', preview);
+
+  return request<ApiCommon, Record<string, never>>(path, body);
+}
+
+export async function listFeaturedJobs(
+  title: string,
+  page: number,
+  options?: Record<string, unknown>,
+): Promise<JobSearchResult> {
+  return listJobs(`/v1/jobs/featured`, title, page, options);
+}

package/src/api/jobResult.ts

@@ -1,95 +1,95 @@
-import {
-  type ApiCommon,
-  type ApiCommonData,
-  type ApiError,
-  type ApiSuccess,
-  type Flatten,
-  type Revivers,
-  deletedNoneParam,
-  lastJobRevision,
-  request,
-} from '../utils.js';
-
-export type JobResult = {
-  jobRevisionId: number;
-  revision: number;
-  status: string;
-};
-
-export type ApiJobResult = {
-  data: {
-    job_revision_id: number;    // The id of the job revision
-    revision: number;           // The revision number of the job revision
-    mapstyle_id: number;        // The id of the map style
-    interface_version: string;  // The version of the interface (searchable, sortable)
-    fix: string;                //
-    status: string;             // The status of the job result (searchable, sortable)
-    fail_reason: string;        // A human-readable reason of why the map failed to process
-    process_start: string;      // The datetime when the job process started (searchable, sortable)
-    process_end: string;        // The datetime when the job process ended (searchable, sortable)
-    dealt_with: boolean;        // Checks if the Support fixed an issue (searchable, sortable)
-    bought: boolean;            // Checks if the result is bought or not (searchable, sortable)
-    contract_id: number;        // The id of the contract that was active when the map was created
-    callback: string;           // URL to another API which can finish a map (searchable, sortable)
-    last_downloaded: string;    // The last time the archive was downloaded (searchable, sortable)
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiJobResultData = Flatten<Exclude<ApiJobResult, ApiError>['data']>;
-
-export const jobResultRevivers: Revivers<ApiJobResult, JobResult> = {
-  mapstyle_id: undefined,
-  interface_version: undefined,
-  fix: undefined,
-  fail_reason: undefined,
-  process_start: undefined,
-  process_end: undefined,
-  dealt_with: undefined,
-  bought: undefined,
-  contract_id: undefined,
-  callback: undefined,
-  last_downloaded: undefined,
-};
-
-export async function uploadJobResultPreview(
-  jobId: number,
-  blob: Blob,
-): Promise<Record<string, never>> {
-  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/result/preview`;
-  const path = `${pathname}?${deletedNoneParam}`;
-  const body = new FormData();
-
-  body.append('preview', blob);
-
-  return request<ApiCommon, Record<string, never>>(path, body);
-}
-
-export type JobResultHostedImage = {
-  url: string;
-  message: string;
-};
-
-export type ApiJobResultHostedImage = {
-  data: {
-    url: string;
-    message: string;
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiJobResultHostedImageData = Flatten<Exclude<ApiJobResultHostedImage, ApiError>['data']>;
-
-export async function uploadJobResultHostedImage(
-  jobId: number,
-  blob: Blob,
-  fileName: string,
-  fileType: 'jpg' | 'png' | 'svg',
-): Promise<JobResultHostedImage> {
-  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/result/hosted-${fileType}`;
-  const path = `${pathname}?${deletedNoneParam}`;
-  const body = new FormData();
-
-  body.append(fileType, blob);
-  body.append('filename', fileName);
-
-  return request<ApiJobResultHostedImage, JobResultHostedImage>(path, body);
-}
+import {
+  type ApiCommon,
+  type ApiCommonData,
+  type ApiError,
+  type ApiSuccess,
+  type Flatten,
+  type Revivers,
+  deletedNoneParam,
+  lastJobRevision,
+  request,
+} from '../utils.js';
+
+export type JobResult = {
+  jobRevisionId: number;
+  revision: number;
+  status: string;
+};
+
+export type ApiJobResult = {
+  data: {
+    job_revision_id: number;    // The id of the job revision
+    revision: number;           // The revision number of the job revision
+    mapstyle_id: number;        // The id of the map style
+    interface_version: string;  // The version of the interface (searchable, sortable)
+    fix: string;                //
+    status: string;             // The status of the job result (searchable, sortable)
+    fail_reason: string;        // A human-readable reason of why the map failed to process
+    process_start: string;      // The datetime when the job process started (searchable, sortable)
+    process_end: string;        // The datetime when the job process ended (searchable, sortable)
+    dealt_with: boolean;        // Checks if the Support fixed an issue (searchable, sortable)
+    bought: boolean;            // Checks if the result is bought or not (searchable, sortable)
+    subscription_id: number;    // The id of the subscription that was active when the map was created
+    callback: string;           // URL to another API which can finish a map (searchable, sortable)
+    last_downloaded: string;    // The last time the archive was downloaded (searchable, sortable)
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiJobResultData = Flatten<Exclude<ApiJobResult, ApiError>['data']>;
+
+export const jobResultRevivers: Revivers<ApiJobResult, JobResult> = {
+  mapstyle_id: undefined,
+  interface_version: undefined,
+  fix: undefined,
+  fail_reason: undefined,
+  process_start: undefined,
+  process_end: undefined,
+  dealt_with: undefined,
+  bought: undefined,
+  subscription_id: undefined,
+  callback: undefined,
+  last_downloaded: undefined,
+};
+
+export async function uploadJobResultPreview(
+  jobId: number,
+  blob: Blob,
+): Promise<Record<string, never>> {
+  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/result/preview`;
+  const path = `${pathname}?${deletedNoneParam}`;
+  const body = new FormData();
+
+  body.append('preview', blob);
+
+  return request<ApiCommon, Record<string, never>>(path, body);
+}
+
+export type JobResultHostedImage = {
+  url: string;
+  message: string;
+};
+
+export type ApiJobResultHostedImage = {
+  data: {
+    url: string;
+    message: string;
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiJobResultHostedImageData = Flatten<Exclude<ApiJobResultHostedImage, ApiError>['data']>;
+
+export async function uploadJobResultHostedImage(
+  jobId: number,
+  blob: Blob,
+  fileName: string,
+  fileType: 'jpg' | 'png' | 'svg',
+): Promise<JobResultHostedImage> {
+  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/result/hosted-${fileType}`;
+  const path = `${pathname}?${deletedNoneParam}`;
+  const body = new FormData();
+
+  body.append(fileType, blob);
+  body.append('filename', fileName);
+
+  return request<ApiJobResultHostedImage, JobResultHostedImage>(path, body);
+}