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

package/src/api/choropleth.ts

@@ -1,105 +1,125 @@
-import { type ApiError, type ApiSuccess, getSearchParams, request } from '../utils.js';
-import type { Polygon } from 'geojson';
-
-export type ApiSearchPoint = {
-  lat: number;
-  lng: number;
-};
-
-export type ApiSearchBounds = {
-  min_lat: number;
-  min_lng: number;
-  max_lat: number;
-  max_lng: number;
-};
-
-type ApiSingleOrGroupedAreaArray =
-  | ({ data: ApiSingleOrGroupedArea[] } & Omit<ApiSuccess, 'data'>)
-  | ApiError;
-
-type ApiSingleOrGroupedArea = {
-  id: number;
-  title: string;
-  subtitle: string;
-  svg_preview: string;
-  bounding_box: string;
-  is_group: boolean;
-  vector_source: string | null;
-  source_layer: string | null;
-  feature_id: number | null;
-  properties: Record<string, string> | null;
-};
-
-type SingleOrGroupedAreaBase = {
-  id: number;
-  title: string;
-  subtitle: string;
-  svgPreview: string;
-  boundingBox: Polygon;
-};
-
-type GroupedArea = SingleOrGroupedAreaBase & {
-  isGroup: true;
-};
-
-type SingleArea = SingleOrGroupedAreaBase & {
-  isGroup: false;
-  vectorSource: string;
-  sourceLayer: string;
-  featureId: number;
-  properties: Record<string, string>;
-};
-
-export type SingleOrGroupedArea = SingleArea | GroupedArea;
-
-export async function searchSingleOrGroupedAreas(
-  language: string,
-  searchBounds: ApiSearchBounds,
-  query?: string,
-  searchPoint?: ApiSearchPoint,
-): Promise<SingleOrGroupedArea[]> {
-  return request<ApiSingleOrGroupedAreaArray, SingleOrGroupedArea>(
-    `/v1/choropleth/polygons/search?${getSearchParams({
-      language,
-      ...searchBounds,
-      ...(query !== '' && { query }),
-      ...(searchPoint && { point: searchPoint }),
-    })}`,
-  ).then(result => {
-    result.forEach(
-      elem => (elem.boundingBox = JSON.parse(elem.boundingBox as unknown as string) as Polygon),
-    );
-
-    return result;
-  });
-}
-
-type ApiGroupedAreaChildArray =
-  | ({
-    data: ApiGroupedAreaChild[];
-  } & Omit<ApiSuccess, 'data'>)
-  | ApiError;
-
-type ApiGroupedAreaChild = {
-  id: number;
-  title: string;
-  vector_source: string;
-  source_layer: string;
-  feature_id: number;
-  properties: Record<string, string>;
-};
-
-export type GroupedAreaChild = {
-  id: number;
-  title: string;
-  vectorSource: string;
-  sourceLayer: string;
-  featureId: number;
-  properties: Record<string, string>;
-};
-
-export async function groupedAreaChildren(groupId: number, language: string): Promise<GroupedAreaChild[]> {
-  return request<ApiGroupedAreaChildArray, GroupedAreaChild>(
-    `/v1/choropleth/groups/${groupId}/children-optimized?${getSearchParams({ language })}`,
-  );
-}
+import { type ApiError, type ApiSuccess, getSearchParams, request } from '../utils.js';
+import type { Polygon } from 'geojson';
+
+export type ApiSearchPoint = {
+  lat: number;
+  lng: number;
+};
+
+export type ApiSearchBounds = {
+  min_lat: number;
+  min_lng: number;
+  max_lat: number;
+  max_lng: number;
+};
+
+type ApiSingleOrGroupedAreaArray =
+  | ({ data: ApiSingleOrGroupedArea[] } & Omit<ApiSuccess, 'data'>)
+  | ApiError;
+
+type ApiSingleOrGroupedArea = {
+  id: number;
+  title: string;
+  subtitle: string;
+  svg_preview: string;
+  bounding_box: string;
+  is_group: boolean;
+  vector_source: string | null;
+  source_layer: string | null;
+  feature_id: number | null;
+  properties: Record<string, string> | null;
+};
+
+type SingleOrGroupedAreaBase = {
+  id: number;
+  title: string;
+  subtitle: string;
+  svgPreview: string;
+  boundingBox: Polygon;
+};
+
+// TODO don't export this once search on click is out
+export type GroupedArea = SingleOrGroupedAreaBase & {
+  isGroup: true;
+};
+
+// TODO don't export this once search on click is out
+export type SingleArea = SingleOrGroupedAreaBase & {
+  isGroup: false;
+  vectorSource: string;
+  sourceLayer: string;
+  featureId: number;
+  properties: Record<string, string>;
+};
+
+export type SingleOrGroupedArea = SingleArea | GroupedArea;
+
+export async function searchSingleOrGroupedAreas(
+  language: string,
+  searchBounds?: ApiSearchBounds,
+  query?: string,
+  searchPoint?: ApiSearchPoint,
+  mode: 'polygon' | 'group' | 'both' = 'both',
+): Promise<SingleOrGroupedArea[]> {
+  /**
+   * TODO When SAGA search on click is implemented, remove mode and make searchBounds required
+   */
+  return request<ApiSingleOrGroupedAreaArray, SingleOrGroupedArea>(
+    `/v1/choropleth/polygons/search?${getSearchParams({
+      language,
+      ...searchBounds,
+      ...(query && { query }),
+      ...(searchPoint && { point: searchPoint }),
+      mode,
+    })}`,
+  ).then(result => {
+    result.forEach(
+      elem => {
+        elem.boundingBox = JSON.parse(elem.boundingBox as unknown as string) as Polygon;
+        if (!elem.isGroup) {
+          elem.properties = JSON.parse(elem.properties as unknown as string) as Record<string, string>;
+        }
+      },
+    );
+
+    return result;
+  });
+}
+
+type ApiGroupedAreaChildArray =
+  | ({
+    data: ApiGroupedAreaChild[];
+  } & Omit<ApiSuccess, 'data'>)
+  | ApiError;
+
+type ApiGroupedAreaChild = {
+  id: number;
+  title: string;
+  vector_source: string;
+  source_layer: string;
+  feature_id: number;
+  properties: Record<string, string>;
+};
+
+export type GroupedAreaChild = {
+  id: number;
+  title: string;
+  vectorSource: string;
+  sourceLayer: string;
+  featureId: number;
+  properties: Record<string, string>;
+};
+
+export async function groupedAreaChildren(groupId: number, language: string): Promise<GroupedAreaChild[]> {
+  return request<ApiGroupedAreaChildArray, GroupedAreaChild>(
+    `/v1/choropleth/groups/${groupId}/children-optimized?${getSearchParams({ language })}`,
+  ).then(result => {
+    result.forEach(
+      elem => {
+        elem.properties = JSON.parse(elem.properties as unknown as string) as Record<string, string>;
+      }
+    );
+
+    return result;
+  });
+}

package/src/api/color.ts

@@ -1,22 +1,22 @@
-import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
-
-export type Color = {
-  id: number;
-  hex: string;
-};
-
-export type ApiColor = {
-  data: {
-    id: number;                 // The color id (sortable)
-    name: string;               // The name of the color (searchable, sortable)
-    hex: string;                // The hex value of the color (searchable, sortable)
-    order?: number;             // TODO: not present in API specification!
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiColorData = Flatten<Exclude<ApiColor, ApiError>['data']>;
-
-export const colorRevivers: Revivers<ApiColor, Color> = {
-  name: undefined,
-  order: undefined,
-};
+import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
+
+export type Color = {
+  id: number;
+  hex: string;
+};
+
+export type ApiColor = {
+  data: {
+    id: number;                 // The color id (sortable)
+    name: string;               // The name of the color (searchable, sortable)
+    hex: string;                // The hex value of the color (searchable, sortable)
+    order?: number;             // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiColorData = Flatten<Exclude<ApiColor, ApiError>['data']>;
+
+export const colorRevivers: Revivers<ApiColor, Color> = {
+  name: undefined,
+  order: undefined,
+};

package/src/api/dimension.ts

@@ -1,44 +1,44 @@
-import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
-
-export type OutputUnit =
-  | 'millimeter'
-  | 'centimeter'
-  | 'inch'
-  | 'pixel'
-  | 'pica';
-
-export type Dimension = {
-  id: number;
-  dimensionSetId: number;
-  name: string;
-  width: number;
-  height: number;
-  dpi: number;
-  unit: OutputUnit;
-};
-
-export type ApiDimension = {
-  data: {
-    id: number;                 // The dimension id (sortable)
-    dimension_set_id: number;   // The id of the dimension set
-    name: string;               // The name of dimension (searchable, sortable)
-    width: number;              // The width of the dimension (searchable, sortable)
-    height: number;             // The height of the dimension (searchable, sortable)
-    dpi: number;                // The dpi of the dimension
-    unit: string;               // The unit of this dimension
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiDimensionData = Flatten<Exclude<ApiDimension, ApiError>['data']>;
-
-const keyToUnit: { [key: string]: OutputUnit } = {
-  MM: 'millimeter',
-  CM: 'centimeter',
-  IN: 'inch',
-  PX: 'pixel',
-  PICA: 'pica',
-};
-
-export const dimensionRevivers: Revivers<ApiDimension, Dimension> = {
-  unit: (data: ApiDimensionData) => keyToUnit[data.unit],
-};
+import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
+
+export type OutputUnit =
+  | 'millimeter'
+  | 'centimeter'
+  | 'inch'
+  | 'pixel'
+  | 'pica';
+
+export type Dimension = {
+  id: number;
+  dimensionSetId: number;
+  name: string;
+  width: number;
+  height: number;
+  dpi: number;
+  unit: OutputUnit;
+};
+
+export type ApiDimension = {
+  data: {
+    id: number;                 // The dimension id (sortable)
+    dimension_set_id: number;   // The id of the dimension set
+    name: string;               // The name of dimension (searchable, sortable)
+    width: number;              // The width of the dimension (searchable, sortable)
+    height: number;             // The height of the dimension (searchable, sortable)
+    dpi: number;                // The dpi of the dimension
+    unit: string;               // The unit of this dimension
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiDimensionData = Flatten<Exclude<ApiDimension, ApiError>['data']>;
+
+const keyToUnit: { [key: string]: OutputUnit } = {
+  MM: 'millimeter',
+  CM: 'centimeter',
+  IN: 'inch',
+  PX: 'pixel',
+  PICA: 'pica',
+};
+
+export const dimensionRevivers: Revivers<ApiDimension, Dimension> = {
+  unit: (data: ApiDimensionData) => keyToUnit[data.unit],
+};

package/src/api/dimensionSet.ts

@@ -1,20 +1,20 @@
-import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
-
-export type DimensionSet = {
-  id: number;
-  name: string;
-};
-
-export type ApiDimensionSet = {
-  data: {
-    id: number;                 // The dimension set id (sortable)
-    name: string;               // The dimension set name (searchable, sortable)
-    order?: number;             // TODO: not present in API specification!
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiDimensionSetData = Flatten<Exclude<ApiDimensionSet, ApiError>['data']>;
-
-export const dimensionSetRevivers: Revivers<ApiDimensionSet, DimensionSet> = {
-  order: undefined,
-};
+import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
+
+export type DimensionSet = {
+  id: number;
+  name: string;
+};
+
+export type ApiDimensionSet = {
+  data: {
+    id: number;                 // The dimension set id (sortable)
+    name: string;               // The dimension set name (searchable, sortable)
+    order?: number;             // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiDimensionSetData = Flatten<Exclude<ApiDimensionSet, ApiError>['data']>;
+
+export const dimensionSetRevivers: Revivers<ApiDimensionSet, DimensionSet> = {
+  order: undefined,
+};

package/src/api/feature.ts

@@ -1,22 +1,22 @@
-import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
-
-export type Feature = {
-  id: number;
-  name: string;
-};
-
-export type ApiFeature = {
-  data: {
-    id: number;                 // The feature id
-    name: string;               // The feature name (searchable, sortable)
-    description: string;        // The description of the feature (searchable, sortable)
-    order?: number;             // TODO: not present in API specification!
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiFeatureData = Flatten<Exclude<ApiFeature, ApiError>['data']>;
-
-export const featureRevivers: Revivers<ApiFeature, Feature> = {
-  description: undefined,
-  order: undefined,
-};
+import type { ApiCommonData, ApiError, ApiSuccess, Flatten, Revivers } from '../utils.js';
+
+export type Feature = {
+  id: number;
+  name: string;
+};
+
+export type ApiFeature = {
+  data: {
+    id: number;                 // The feature id
+    name: string;               // The feature name (searchable, sortable)
+    description: string;        // The description of the feature (searchable, sortable)
+    order?: number;             // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiFeatureData = Flatten<Exclude<ApiFeature, ApiError>['data']>;
+
+export const featureRevivers: Revivers<ApiFeature, Feature> = {
+  description: undefined,
+  order: undefined,
+};

package/src/api/font.ts

@@ -1,49 +1,49 @@
-import { type ApiCommonData, type ApiError, type ApiSuccess, type Flatten, type Revivers, getSearchParams, request } from '../utils.js';
-
-export type Font = {
-  id: number;
-  fontFamilyId: number;
-  name: string;
-  label: string;
-};
-
-export type ApiFont = {
-  data: {
-    id: number;                 // The id of the font (sortable)
-    font_family_id: number;     // The id of the font family
-    name: string;               // The name of the font (searchable, sortable)
-    style: string;              // The font style (searchable, sortable)
-    stretch: string;            // The font stretch (searchable, sortable)
-    weight: number;             // The font weight (searchable, sortable)
-    label: string;              // The label of the font (searchable, sortable)
-    order?: number;             // TODO: not present in API specification!
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiFontData = Flatten<Exclude<ApiFont, ApiError>['data']>;
-
-type FontSearchOptions = {
-  family?: string;
-  style?: string;
-  weight?: string;
-};
-
-export const fontRevivers: Revivers<ApiFont, Font> = {
-  style: undefined,
-  stretch: undefined,
-  weight: undefined,
-  order: undefined,
-};
-
-export async function getFonts(searchOptions: FontSearchOptions): Promise<Font[] | Font> {
-  const pathname = `/v1/fonts/search`;
-  const query = getSearchParams(searchOptions);
-
-  const path = `${pathname}?${query}`;
-
-  type ApiFontArray = {
-    data: ApiFontData[];
-  } & Omit<ApiSuccess, 'data'> | ApiError;
-
-  return request<ApiFontArray, Font>(path);
-}
+import { type ApiCommonData, type ApiError, type ApiSuccess, type Flatten, type Revivers, getSearchParams, request } from '../utils.js';
+
+export type Font = {
+  id: number;
+  fontFamilyId: number;
+  name: string;
+  label: string;
+};
+
+export type ApiFont = {
+  data: {
+    id: number;                 // The id of the font (sortable)
+    font_family_id: number;     // The id of the font family
+    name: string;               // The name of the font (searchable, sortable)
+    style: string;              // The font style (searchable, sortable)
+    stretch: string;            // The font stretch (searchable, sortable)
+    weight: number;             // The font weight (searchable, sortable)
+    label: string;              // The label of the font (searchable, sortable)
+    order?: number;             // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiFontData = Flatten<Exclude<ApiFont, ApiError>['data']>;
+
+type FontSearchOptions = {
+  family?: string;
+  style?: string;
+  weight?: string;
+};
+
+export const fontRevivers: Revivers<ApiFont, Font> = {
+  style: undefined,
+  stretch: undefined,
+  weight: undefined,
+  order: undefined,
+};
+
+export async function getFonts(searchOptions: FontSearchOptions): Promise<Font[] | Font> {
+  const pathname = `/v1/fonts/search`;
+  const query = getSearchParams(searchOptions);
+
+  const path = `${pathname}?${query}`;
+
+  type ApiFontArray = {
+    data: ApiFontData[];
+  } & Omit<ApiSuccess, 'data'> | ApiError;
+
+  return request<ApiFontArray, Font>(path);
+}

package/src/api/fontFamily.ts

@@ -1,43 +1,43 @@
-import { type ApiFontData, type Font, fontRevivers } from './font.js';
-import {
-  type ApiCommonData,
-  type ApiError,
-  type ApiSuccess,
-  type Flatten,
-  type Revivers,
-  defaultListHeader,
-  getSearchParams,
-  request,
-} from '../utils.js';
-
-export type FontFamily = {
-  id: number;
-  name: string;
-};
-
-export type ApiFontFamily = {
-  data: {
-    id: number;                 // The id of the font family (sortable)
-    name: string;               // The name of the font family (searchable, sortable)
-    order?: number;             // TODO: not present in API specification!
-  } & ApiCommonData;
-} & Omit<ApiSuccess, 'data'> | ApiError;
-
-export type ApiFontFamilyData = Flatten<Exclude<ApiFontFamily, ApiError>['data']>;
-
-export const fontFamilyRevivers: Revivers<ApiFontFamily, FontFamily> = {
-  order: undefined,
-};
-
-export async function listFontFamilyFonts(fontFamilyId: number): Promise<Font[]> {
-  const pathname = `/v1/fonts/families/${fontFamilyId}/items`;
-  const query = getSearchParams({ sort: 'order' });
-  const path = `${pathname}?${query}`;
-  const options = { revivers: fontRevivers };
-
-  type ApiFontArray = {
-    data: ApiFontData[];
-  } & Omit<ApiSuccess, 'data'> | ApiError;
-
-  return request<ApiFontArray, Font>(path, null, defaultListHeader, options);
-}
+import { type ApiFontData, type Font, fontRevivers } from './font.js';
+import {
+  type ApiCommonData,
+  type ApiError,
+  type ApiSuccess,
+  type Flatten,
+  type Revivers,
+  defaultListHeader,
+  getSearchParams,
+  request,
+} from '../utils.js';
+
+export type FontFamily = {
+  id: number;
+  name: string;
+};
+
+export type ApiFontFamily = {
+  data: {
+    id: number;                 // The id of the font family (sortable)
+    name: string;               // The name of the font family (searchable, sortable)
+    order?: number;             // TODO: not present in API specification!
+  } & ApiCommonData;
+} & Omit<ApiSuccess, 'data'> | ApiError;
+
+export type ApiFontFamilyData = Flatten<Exclude<ApiFontFamily, ApiError>['data']>;
+
+export const fontFamilyRevivers: Revivers<ApiFontFamily, FontFamily> = {
+  order: undefined,
+};
+
+export async function listFontFamilyFonts(fontFamilyId: number): Promise<Font[]> {
+  const pathname = `/v1/fonts/families/${fontFamilyId}/items`;
+  const query = getSearchParams({ sort: 'order' });
+  const path = `${pathname}?${query}`;
+  const options = { revivers: fontRevivers };
+
+  type ApiFontArray = {
+    data: ApiFontData[];
+  } & Omit<ApiSuccess, 'data'> | ApiError;
+
+  return request<ApiFontArray, Font>(path, null, defaultListHeader, options);
+}