@mapcreator/api 3.3.1 → 5.0.0-alpha.13

package/src/api/job.ts

@@ -0,0 +1,127 @@
+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!
+    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,
+  createdAt: (data: ApiJobData) => data.created_at as string, // @ts-expect-error TS2339
+  previewPath: (data: ApiJobData) => (data.preview_path as string | null) ?? 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

@@ -0,0 +1,81 @@
+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 async function uploadJobResultHostedImage(
+  jobId: number,
+  blob: Blob,
+  fileName: string,
+  fileType: 'jpg' | 'png' | 'svg',
+): Promise<Record<string, never>> {
+  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<ApiCommon, Record<string, never>>(path, body);
+}

package/src/api/jobRevision.ts

@@ -0,0 +1,200 @@
+import { type ApiLayerData, type Layer, layerRevivers } from './layer.js';
+import type { ApiMapstyleSetData } from './mapstyleSet.js';
+import type { ApiLanguageData } from './language.js';
+import {
+  type ApiCommon,
+  type ApiCommonData,
+  type ApiError,
+  type ApiSuccess,
+  type Flatten,
+  type Revivers,
+  defaultListHeader,
+  deletedNoneParam,
+  lastJobRevision,
+  request,
+} from '../utils.js';
+
+export type FileFormat =
+  | 'png'
+  | 'jpg'
+  | 'tiff'
+  | 'svg'
+  | 'pdf'
+  | 'web'
+  | 'web_download'
+  | 'webm'
+  | 'mp4'
+  | 'mov'
+  | 'eps'
+  | 'eps_log'
+  | 'png_sequence'
+  | 'jpg_sequence'
+  | 'mxf';
+
+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>,
+): 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,
+  };
+  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<boolean> {
+  const pathname = `/v1/jobs/${jobId}/revisions/${lastJobRevision}/build`;
+  const path = `${pathname}?${deletedNoneParam}`;
+
+  return request<ApiJobCanBuild, JobCanBuild>(path).then(
+    ({ canBuild }) => canBuild,
+    () => false,
+  );
+}
+
+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)
+    contract_id: number;        // The id of the contract 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> = {
+  contract_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);
+}

package/src/api/jobShare.ts

@@ -0,0 +1,35 @@
+import { type ApiCommon, type ApiCommonData, type ApiError, type ApiSuccess, type Flatten, request } from '../utils.js';
+
+export type JobShareVisibility = 'private' | 'organisation' | 'public';
+
+export type JobShare = {
+  id: number;
+  jobId: number;
+  visibility: JobShareVisibility;
+  hashKey: string;
+  apiUrl: string;
+  webUrl: string;
+};
+
+export type ApiJobShare = {
+  data: {
+    id: number;                 // The id of the job share (sortable)
+    job_id: number;             // The id of the job related to this share
+    visibility: string;         // The visibility of the job share (searchable, sortable)
+    hash_key: string;           // The hash key of the job share
+    apiUrl: string;             // TODO: not present in API specification!
+    webUrl: string;             // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiJobShareData = Flatten<Exclude<ApiJobShare, ApiError>['data']>;
+
+export type ApiJobShareArray = {
+  data: ApiJobShareData[];
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export async function deleteJobShare(jobShareId: number): Promise<Record<string, never>> {
+  const path = `/v1/jobs/shares/${jobShareId}`;
+
+  return request<ApiCommon, Record<string, never>>(path, null, null, { method: 'DELETE' });
+}

package/src/api/jobType.ts

@@ -0,0 +1,26 @@
+import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
+
+export type JobType = {
+  id: number;
+};
+
+export type ApiJobType = {
+  data: {
+    id: number;                 // The id of the job type (sortable)
+    name: string;               // The name of the job type (searchable, sortable)
+    preview: string | null;     // The preview file name of the job type
+    description: string | null; // The description of the job type (searchable, sortable)
+    components: string | null;  // The components of the job type
+    order?: number;             // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiJobTypeData = Flatten<Exclude<ApiJobType, ApiError>['data']>;
+
+export const jobTypeRevivers: Revivers<ApiJobType, JobType> = {
+  name: undefined,
+  preview: undefined,
+  description: undefined,
+  components: undefined,
+  order: undefined,
+};

package/src/api/language.ts

@@ -0,0 +1,19 @@
+import type { ApiCommonData, ApiError, ApiSuccess, Flatten } from '../utils.js';
+
+export type Language = {
+  code: string;
+  name: string;
+  locale: string;
+  interface: boolean;
+};
+
+export type ApiLanguage = {
+  data: {
+    code: string;               // The language code
+    name: string;               // The name of the language (searchable, sortable)
+    locale: string;             // The locale string for the language (searchable, sortable)
+    interface: boolean;         // If this language can be used for user interfaces
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiLanguageData = Flatten<Exclude<ApiLanguage, ApiError>['data']>;

package/src/api/layer.ts

@@ -0,0 +1,36 @@
+import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
+
+export type Layer = {
+  id: number;
+  name: string;
+  description: string;
+};
+
+export type ApiLayer = {
+  data: {
+    id: number;                 // The id of the layer (sortable)
+    name: string;               // The name of the layer (searchable, sortable)
+    path: string;               // The path to the layer
+    description: string;        // The description of the layer (searchable, sortable)
+    image: string | null;       // The image related to a layer
+    scale_min: number;          // The minimum scale for the layer (searchable, sortable)
+    scale_max: number;          // The maximum scale for the layer (searchable, sortable)
+    pangaea_ready: boolean;     // Whether a layer is prepared for Pangaea (searchable, sortable)
+    svg_set_id: number | null;  // TODO: not present in API specification!
+    pivot: unknown;             // TODO: not present in API specification!
+    order?: number;             // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiLayerData = Flatten<Exclude<ApiLayer, ApiError>['data']>;
+
+export const layerRevivers: Revivers<ApiLayer, Layer> = {
+  path: undefined,
+  image: undefined,
+  scale_min: undefined,
+  scale_max: undefined,
+  pangaea_ready: undefined,
+  svg_set_id: undefined,
+  pivot: undefined,
+  order: undefined,
+};

package/src/api/layerFaq.ts

@@ -0,0 +1,53 @@
+import {
+  type ApiCommonData,
+  type ApiError,
+  type ApiSuccess,
+  type Flatten,
+  type Revivers,
+  defaultListHeader,
+  getSearchParams,
+  request,
+} from '../utils.js';
+
+export type LayerFaq = {
+  id: number;
+  name: string;
+  description: string;
+  mediaUrl: string;
+  readMoreUrl: string;
+  tags: string[];
+  layerId: number;
+  order?: number;
+};
+
+export type ApiLayerFaq = {
+  data: {
+    id: number;                 // The id of the layer faq (sortable)
+    name: string;               // The name of this layer faq (searchable, sortable)
+    description: string;        // The description of the layer faq (searchable)
+    media_url: string;          // The image for the faq (searchable)
+    read_more_url: string;      // A link to a page with more information (searchable)
+    tags: string[];             // A list of tags to search in (searchable)
+    layer_id: number;           // TODO: not present in API specification!
+    order?: number;             // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiLayerFaqData = Flatten<Exclude<ApiLayerFaq, ApiError>['data']>;
+
+export const layerFaqRevivers: Revivers<ApiLayerFaq, LayerFaq> = {
+  order: undefined,
+};
+
+export async function listLayerFaqs(): Promise<LayerFaq[]> {
+  const pathname = `/v1/layer-faqs`;
+  const query = getSearchParams({ sort: 'order,name' });
+  const path = `${pathname}?${query}`;
+  const options = { revivers: layerFaqRevivers };
+
+  type ApiLayerFaqArray = {
+    data: ApiLayerFaqData[];
+  } & Omit<ApiSuccess, 'data'> | ApiError;
+
+  return request<ApiLayerFaqArray, LayerFaq>(path, null, defaultListHeader, options);
+}

package/src/api/layerGroup.ts

@@ -0,0 +1,69 @@
+import type { Layer } from './layer.js';
+import {
+  type ApiCommonData,
+  type ApiError,
+  type ApiSuccess,
+  type Flatten,
+  getSearchParams,
+  request,
+} from '../utils.js';
+
+export type LayerGroup = {
+  id: number;
+  name: string;
+  layers: Layer[];
+};
+
+export type ApiLayerGroup = {
+  data: {
+    id: number;                 // The id of the layer group (sortable)
+    name: string;               // The name of the layer group (searchable, sortable)
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiLayerGroupData = Flatten<Exclude<ApiLayerGroup, ApiError>['data']>;
+
+export async function listLayerGroups(layers: Layer[]): Promise<LayerGroup[]> {
+  const pathname = `/v1/layer-groups/for-layer-ids`;
+  const query = getSearchParams({ layer_ids: layers.map(layer => layer.id) });
+  const path = `${pathname}?${query}`;
+
+  type ApiLayerGroupArray = {
+    data: Array<ApiLayerGroupData & { layers: Array<{ id: number }> }>;
+  } & Omit<ApiSuccess, 'data'> | ApiError;
+
+  const layerGroups = await request<ApiLayerGroupArray, LayerGroup>(path);
+
+  // Arrange layers in an object by id for fast lookups
+  const layerMap = new Map(layers.map(layer => [layer.id, layer]));
+
+  // Create a set of all layer ids that belong to a group
+  const groupedLayerIds = new Set<number>();
+
+  for (const layerGroup of layerGroups) {
+    // Replace layers from the API response with their full representation
+    layerGroup.layers = layerGroup.layers
+      .map(groupLayer => layerMap.get(groupLayer.id))
+      .filter((layer): layer is Layer => layer !== undefined);
+
+    // Remember that these layers belong to a group
+    for (const layer of layerGroup.layers) {
+      groupedLayerIds.add(layer.id);
+    }
+  }
+
+  // Get a list of layers that don’t belong to any group
+  const miscLayers = layers.filter(layer => !groupedLayerIds.has(layer.id));
+
+  // Sort it alphabetically
+  miscLayers.sort((a, b) => a.name.localeCompare(b.name));
+
+  // Put them all in a separate group
+  const miscLayerGroup: LayerGroup = {
+    id: 999,
+    layers: miscLayers,
+    name: 'Other layers',
+  };
+
+  return [...layerGroups, miscLayerGroup];
+}