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

package/src/api/jobType.ts

@@ -1,26 +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,
-};
+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

@@ -1,19 +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']>;
+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

@@ -1,38 +1,38 @@
-import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
-
-export type Layer = {
-  id: number;
-  name: string;
-  description: string;
-  svg: string | null;
-};
-
-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
-    svg: string | null;         // The svg 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,
-};
+import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
+
+export type Layer = {
+  id: number;
+  name: string;
+  description: string;
+  svg: string | null;
+};
+
+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
+    svg: string | null;         // The svg 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

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

@@ -1,69 +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];
-}
+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];
+}

package/src/api/mapstyleSet.ts

@@ -1,48 +1,48 @@
-import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
-
-export type MapstyleSet = {
-  id: number;
-  name: string;
-  supportsSvg: boolean;
-  disableInteractive: boolean;
-};
-
-export type ApiMapstyleSet = {
-  data: {
-    id: number;                 // The id of the mapstyle set (sortable)
-    name: string;               // The name of the mapstyle set (searchable, sortable)
-    description: string;        // The description of the set (searchable, sortable)
-    supports_svg: boolean;      // If the set supports svg (searchable, sortable)
-    disable_interactive: boolean; // If interactive export is disabled
-    job_type_id: number;        // The id of the job type (searchable)
-    preview_lat: number;        // The latitude for the preview image
-    preview_lon: number;        // The longitude for the preview image
-    preview_language_code: string; // The language code of the preview
-    world_cache: string | null; // The name of the world cache (sortable)
-    world_cache_max_zoom: number | null; // The max zoom level of the world cache (sortable)
-    css: string | null;         // Custom CSS for the MapstyleSet (sortable)
-    locator_ready: boolean;     // If the set can be used as locator (searchable, sortable)
-    show_underlying_elements: boolean; // Shows elements even if behind annotations
-    ace_on_osm: boolean;        // Use OSM source as data for ACE maps (searchable, sortable)
-    order?: number;             // TODO: not present in API specification!
-    custom_settings?: string | null; // TODO: not present in API specification!
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiMapstyleSetData = Flatten<Exclude<ApiMapstyleSet, ApiError>['data']>;
-
-export const mapstyleSetRevivers: Revivers<ApiMapstyleSet, MapstyleSet> = {
-  description: undefined,
-  job_type_id: undefined,
-  preview_lat: undefined,
-  preview_lon: undefined,
-  preview_language_code: undefined,
-  world_cache: undefined,
-  world_cache_max_zoom: undefined,
-  css: undefined,
-  locator_ready: undefined,
-  show_underlying_elements: undefined,
-  ace_on_osm: undefined,
-  order: undefined,
-  custom_settings: undefined,
-};
+import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
+
+export type MapstyleSet = {
+  id: number;
+  name: string;
+  supportsSvg: boolean;
+  disableInteractive: boolean;
+};
+
+export type ApiMapstyleSet = {
+  data: {
+    id: number;                 // The id of the mapstyle set (sortable)
+    name: string;               // The name of the mapstyle set (searchable, sortable)
+    description: string;        // The description of the set (searchable, sortable)
+    supports_svg: boolean;      // If the set supports svg (searchable, sortable)
+    disable_interactive: boolean; // If interactive export is disabled
+    job_type_id: number;        // The id of the job type (searchable)
+    preview_lat: number;        // The latitude for the preview image
+    preview_lon: number;        // The longitude for the preview image
+    preview_language_code: string; // The language code of the preview
+    world_cache: string | null; // The name of the world cache (sortable)
+    world_cache_max_zoom: number | null; // The max zoom level of the world cache (sortable)
+    css: string | null;         // Custom CSS for the MapstyleSet (sortable)
+    locator_ready: boolean;     // If the set can be used as locator (searchable, sortable)
+    show_underlying_elements: boolean; // Shows elements even if behind annotations
+    ace_on_osm: boolean;        // Use OSM source as data for ACE maps (searchable, sortable)
+    order?: number;             // TODO: not present in API specification!
+    custom_settings?: string | null; // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiMapstyleSetData = Flatten<Exclude<ApiMapstyleSet, ApiError>['data']>;
+
+export const mapstyleSetRevivers: Revivers<ApiMapstyleSet, MapstyleSet> = {
+  description: undefined,
+  job_type_id: undefined,
+  preview_lat: undefined,
+  preview_lon: undefined,
+  preview_language_code: undefined,
+  world_cache: undefined,
+  world_cache_max_zoom: undefined,
+  css: undefined,
+  locator_ready: undefined,
+  show_underlying_elements: undefined,
+  ace_on_osm: undefined,
+  order: undefined,
+  custom_settings: undefined,
+};