@mapcreator/api 0.0.0-co-edit.0

package/src/api/highlight.ts

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

package/src/api/insetMap.ts

@@ -0,0 +1,95 @@
+import { apiHost, authenticate, getAuthorizationHeaders, 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 = getAuthorizationHeaders('GET');
+  const response = await fetch(href, { headers, ...!token && { credentials: 'include' } })
+    .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

@@ -0,0 +1,139 @@
+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;
+  private: boolean;
+};
+
+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!
+    private: boolean;
+  } & 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 privateJob(jobId: number, privateValue: boolean): Promise<Record<string, never>> {
+  const path = `/v1/jobs/${jobId}`;
+  const body = { private: privateValue };
+
+  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

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

package/src/api/jobRevision.ts

@@ -0,0 +1,281 @@
+import { apiHost, authenticate, getAuthorizationHeaders, token } from '../oauth.js';
+import { type ApiLayerData, type Layer, layerRevivers } from './layer.js';
+import type { ApiMapstyleSetData } from './mapstyleSet.js';
+import type { ApiLanguageData } from './language.js';
+import {
+  APIError,
+  type ApiCommon,
+  type ApiCommonData,
+  type ApiError,
+  type ApiSuccess,
+  type Flatten,
+  HTTPError,
+  NetworkError,
+  type Revivers,
+  defaultListHeader,
+  deletedNoneParam,
+  lastJobRevision,
+  request,
+} from '../utils.js';
+
+export type FileFormat =
+  | 'jpg'
+  | 'png'
+  | 'svg'
+  | 'pdf'
+  | 'tiff'
+  | 'eps'
+  | 'eps_log'
+  | 'mp4'
+  | 'mov'
+  | 'mkv'
+  | 'mxf'
+  | 'webm'
+  | 'jpg_sequence'
+  | 'png_sequence'
+  | 'web'
+  | 'web_download';
+
+export type JobRevision = {
+  id: number;
+  jobId: number;
+  revision: number;
+  languageCode: string;
+  mapstyleSetId: number;
+  output: FileFormat;
+};
+
+export type ApiJobRevision = {
+  data: {
+    id: number;                 // The id of the job revision (sortable)
+    job_id: number;             // The id of the job related to this revision (searchable, sortable)
+    revision: number;           // The revision number (searchable, sortable)
+    language_code: string;      // The language code of the revision (searchable, sortable)
+    mapstyle_set_id: number;    // The id of the mapstyle set
+    archived: boolean;          // Whether the revision has been generated (searchable, sortable)
+    output: FileFormat;         // The output file type
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiJobRevisionData = Flatten<Exclude<ApiJobRevision, ApiError>['data']>;
+
+export const jobRevisionRevivers: Revivers<ApiJobRevision, JobRevision> = {
+  archived: undefined,
+};
+
+export async function createJobRevision(
+  jobId: number,
+  languageCode: string,
+  mapstyleSetId: number,
+  layers: number[],
+  output: FileFormat,
+  jobObject: Record<string, unknown>,
+  skipValidation?: boolean
+): Promise<JobRevision> {
+  const pathname = `/v1/jobs/${jobId}/revisions`;
+  const path = `${pathname}?${deletedNoneParam}`;
+  const body = {
+    language_code: languageCode,
+    mapstyle_set_id: mapstyleSetId,
+    object: JSON.stringify(jobObject),
+    output,
+    layers,
+    ...skipValidation && { skip_validation: skipValidation },
+  };
+  const options = { revivers: jobRevisionRevivers };
+
+  return request<ApiJobRevision, JobRevision>(path, body, null, options);
+}
+
+export async function getJobRevision(jobId: number): Promise<JobRevision | undefined> {
+  const path = `/v1/jobs/${jobId}/revisions/${lastJobRevision}`;
+  const options = { revivers: jobRevisionRevivers };
+
+  return request<ApiJobRevision, JobRevision>(path, null, null, options).catch(() => undefined);
+}
+
+export async function getJobRevisionObject<JobObject>(jobId: number): Promise<JobObject> {
+  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/object`;
+  const path = `${pathname}?${deletedNoneParam}`;
+
+  return request<ApiCommon, string>(path).then(JSON.parse) as Promise<JobObject>;
+}
+
+export type JobCanBuild = {
+  canBuild: boolean;
+  paymentSource: string;
+  reason: string | null;
+};
+
+export type ApiJobCanBuild = {
+  data: {
+    can_build: boolean;
+    payment_source: string;
+    reason: string | null;
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+// Also known as `canBuild()`
+export async function getJobRevisionBuild(jobId: number): Promise<JobCanBuild> {
+  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/build`;
+  const path = `${pathname}?${deletedNoneParam}`;
+
+  return request<ApiJobCanBuild, JobCanBuild>(path);
+}
+
+export type JobRevisionBuild = {
+  jobRevisionId: number;
+  revision: number;
+  status: string;
+};
+
+export type ApiJobRevisionBuild = {
+  data: {
+    job_revision_id: number;    // The id of the job revision
+    status: string;             // The status of the job result (searchable, sortable)
+    subscription_id: number;    // The id of the subscription that was active when the map was created
+    process_start: string;      // The datetime when the job process started (searchable, sortable)
+    process_end: string;        // The datetime when the job process ended (searchable, sortable)
+    last_downloaded: string;    // The last time the archive was downloaded (searchable, sortable)
+    bought: boolean;            // Checks if the result is bought or not (searchable, sortable)
+    revision: number;           // The revision number of the job revision
+    job_revision: ApiJobRevisionData;
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiJobRevisionBuildData = Flatten<Exclude<ApiJobRevisionBuild, ApiError>['data']>;
+
+export const jobRevisionBuildRevivers: Revivers<ApiJobRevisionBuild, JobRevisionBuild> = {
+  subscription_id: undefined,
+  process_start: undefined,
+  process_end: undefined,
+  last_downloaded: undefined,
+  bought: undefined,
+  job_revision: undefined,
+};
+
+export async function registerJobRevisionBuild(
+  jobId: number,
+  status: string,
+  start: Date,
+  end: Date,
+): Promise<JobRevisionBuild> {
+  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/build/register`;
+  const path = `${pathname}?${deletedNoneParam}`;
+  const body = { status, process_start: start, process_end: end };
+  const options = { revivers: jobRevisionBuildRevivers };
+
+  return request<ApiJobRevisionBuild, JobRevisionBuild>(path, body, null, options);
+}
+
+export async function cloneJobRevision(jobId: number, newTitle?: string): Promise<JobRevision> {
+  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/clone`;
+  const path = `${pathname}?${deletedNoneParam}`;
+  const body = { title: newTitle ?? null };
+  const options = {
+    revivers: {
+      ...jobRevisionRevivers,
+      layers: undefined,
+      language: undefined,
+      mapstyle_set: undefined,
+    },
+  };
+
+  type ApiJobRevisionWithData = {
+    data: ApiJobRevisionData & {
+      layers: ApiLayerData[];
+      language: ApiLanguageData;
+      mapstyle_set: ApiMapstyleSetData;
+    };
+  } & Omit<ApiSuccess, 'data'> | ApiError;
+
+  return request<ApiJobRevisionWithData, JobRevision>(path, body, null, options);
+}
+
+export async function listJobRevisionLayers(jobId: number): Promise<Layer[]> {
+  const path = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/layers`;
+  const options = { revivers: layerRevivers };
+
+  type ApiLayerArray = {
+    data: ApiLayerData[];
+  } & Omit<ApiSuccess, 'data'> | ApiError;
+
+  return request<ApiLayerArray, Layer>(path, null, defaultListHeader, options);
+}
+
+export type JobRevisionOutputUrl = { url: string };
+
+export type ApiJobRevisionOutputUrl = {
+  data: JobRevisionOutputUrl & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export async function getJobRevisionOutputUrl(jobId: number): Promise<JobRevisionOutputUrl> {
+  await createJobRevisionBuild(jobId);
+
+  const path = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/result/output-url`;
+
+  return request<ApiJobRevisionOutputUrl, JobRevisionOutputUrl>(path);
+}
+
+export type JobRevisionOutput = { blob: Blob; filename?: string | undefined };
+
+export async function getJobRevisionOutput(jobId: number): Promise<JobRevisionOutput> {
+  await createJobRevisionBuild(jobId);
+
+  const href = `${apiHost}/v1/jobs/${jobId}/revisions/${lastJobRevision}/result/output`;
+  const headers = getAuthorizationHeaders('GET');
+  const response = await fetch(href, { headers, ...!token && { credentials: 'include' } })
+    .catch((error: Error) => { throw new NetworkError(error?.message ?? error) });
+
+  if (response.ok) {
+    const blob = await response.blob().catch(() => {
+      throw new APIError({ success: false, error: { type: 'TypeError', message: 'Malformed Blob response' } });
+    });
+    const contentDisposition = response.headers.get('Content-Disposition');
+
+    if (contentDisposition) {
+      const filenameRegex = /filename\*\s*=\s*UTF-8''(.+)/i;
+      const filenameMatch = contentDisposition.match(filenameRegex);
+
+      if (filenameMatch?.[1]) {
+        return { blob, filename: filenameMatch[1] };
+      }
+
+      const fallbackRegex = /filename\s*=\s*"([^"]+)"/i;
+      const fallbackMatch = contentDisposition.match(fallbackRegex);
+
+      if (fallbackMatch?.[1]) {
+        return { blob, filename: fallbackMatch[1] };
+      }
+    }
+
+    return { blob };
+  } 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(
+          (await response.json().catch(() => ({
+            success: false,
+            error: { type: 'HttpException', message: response.statusText },
+          }))) as ApiError,
+        );
+    }
+
+    throw new HTTPError(response);
+  }
+}
+
+async function createJobRevisionBuild(jobId: number, skipValidation?: boolean): Promise<string> {
+  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/build`;
+  const path = `${pathname}?${deletedNoneParam}`;
+  const body = skipValidation ? { skip_validation: skipValidation } : null;
+
+  return request<ApiCommon, string>(path, body, null, { method: 'POST' });
+}