@mapcreator/api 0.0.0-saga.1 → 0.0.0-saga.3

package/src/api/highlight.ts

@@ -1,87 +1,87 @@
-import type { FeatureCollection } from 'geojson';
-import type { SnakeCase } from 'type-fest';
-import {
-  APIMeta,
-  type ApiCommonData,
-  type ApiError,
-  type ApiSuccess,
-  type Flatten,
-  defaultListHeader,
-  getSearchParams,
-  request,
-} from '../utils.js';
-
-type FieldName = 'id' | 'name' | 'description' | 'previewPath' | 'previewJson';
-
-export type PartialVectorHighlight = Pick<VectorHighlight, FieldName>;
-
-export type VectorHighlight = {
-  id: number;
-  name: string;
-  description: string;
-  previewPath: string | null;
-  previewJson: FeatureCollection | null;
-
-  vectorSetUrl: string;
-  sourceLayerName: string;
-
-  lngMin: number;
-  lngMax: number;
-  latMin: number;
-  latMax: number;
-
-  keys: string[];
-  properties: Record<string, unknown>;
-};
-
-export type ApiVectorHighlight = {
-  data: {
-    id: number;
-    name: string;
-    description: string;
-    preview_path: string | null;
-    preview_json: FeatureCollection | null;
-
-    vector_set_url: string;
-    source_layer_name: string;
-
-    lng_min: number;
-    lng_max: number;
-    lat_min: number;
-    lat_max: number;
-
-    keys: string[];
-    properties: Record<string, unknown>;
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiVectorHighlightData = Flatten<Exclude<ApiVectorHighlight, ApiError>['data']>;
-
-export async function listVectorHighlights(name: string): Promise<PartialVectorHighlight[]> {
-  const pathname = `/v1/highlights/vector`;
-  const query = getSearchParams({ search: { name } });
-  const path = `${pathname}?${query}`;
-
-  // Only request first 50 results
-  const headers = { ...defaultListHeader };
-  const options = { withMeta: true };
-
-  type ApiVectorHighlightArray = {
-    data: Array<Pick<ApiVectorHighlightData, SnakeCase<FieldName>>>;
-  } & Omit<ApiSuccess, 'data'> | ApiError;
-
-  return request<ApiVectorHighlightArray, PartialVectorHighlight>(path, null, headers, options)
-    .catch((error: Error) => {
-      if (error instanceof APIMeta) {
-        return (error as APIMeta<ApiVectorHighlightArray, PartialVectorHighlight>).data;
-      }
-
-      throw error;
-    });
-}
-
-export async function getVectorHighlight(highlightId: number): Promise<VectorHighlight> {
-  const path = `/v1/highlights/vector/${highlightId}`;
-
-  return request<ApiVectorHighlight, VectorHighlight>(path);
-}
+import type { FeatureCollection } from 'geojson';
+import type { SnakeCase } from 'type-fest';
+import {
+  APIMeta,
+  type ApiCommonData,
+  type ApiError,
+  type ApiSuccess,
+  type Flatten,
+  defaultListHeader,
+  getSearchParams,
+  request,
+} from '../utils.js';
+
+type FieldName = 'id' | 'name' | 'description' | 'previewPath' | 'previewJson';
+
+export type PartialVectorHighlight = Pick<VectorHighlight, FieldName>;
+
+export type VectorHighlight = {
+  id: number;
+  name: string;
+  description: string;
+  previewPath: string | null;
+  previewJson: FeatureCollection | null;
+
+  vectorSetUrl: string;
+  sourceLayerName: string;
+
+  lngMin: number;
+  lngMax: number;
+  latMin: number;
+  latMax: number;
+
+  keys: string[];
+  properties: Record<string, unknown>;
+};
+
+export type ApiVectorHighlight = {
+  data: {
+    id: number;
+    name: string;
+    description: string;
+    preview_path: string | null;
+    preview_json: FeatureCollection | null;
+
+    vector_set_url: string;
+    source_layer_name: string;
+
+    lng_min: number;
+    lng_max: number;
+    lat_min: number;
+    lat_max: number;
+
+    keys: string[];
+    properties: Record<string, unknown>;
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiVectorHighlightData = Flatten<Exclude<ApiVectorHighlight, ApiError>['data']>;
+
+export async function listVectorHighlights(name: string): Promise<PartialVectorHighlight[]> {
+  const pathname = `/v1/highlights/vector`;
+  const query = getSearchParams({ search: { name } });
+  const path = `${pathname}?${query}`;
+
+  // Only request first 50 results
+  const headers = { ...defaultListHeader };
+  const options = { withMeta: true };
+
+  type ApiVectorHighlightArray = {
+    data: Array<Pick<ApiVectorHighlightData, SnakeCase<FieldName>>>;
+  } & Omit<ApiSuccess, 'data'> | ApiError;
+
+  return request<ApiVectorHighlightArray, PartialVectorHighlight>(path, null, headers, options)
+    .catch((error: Error) => {
+      if (error instanceof APIMeta) {
+        return (error as APIMeta<ApiVectorHighlightArray, PartialVectorHighlight>).data;
+      }
+
+      throw error;
+    });
+}
+
+export async function getVectorHighlight(highlightId: number): Promise<VectorHighlight> {
+  const path = `/v1/highlights/vector/${highlightId}`;
+
+  return request<ApiVectorHighlight, VectorHighlight>(path);
+}

package/src/api/insetMap.ts

@@ -0,0 +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);
+  }
+}

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);
+}