/*
 * Copyright (C) 2018 StApps
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation, version 3.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see <https://www.gnu.org/licenses/>.
 */
import {SCPlaceWithoutReferences} from '../base/Place';
import {SCThingInPlace} from '../base/ThingInPlace';
import {
  SCThingWithCategoriesSpecificValues,
  SCThingWithCategoriesTranslatableProperties,
  SCThingWithCategoriesWithoutReferences,
} from '../base/ThingWithCategories';
import {SCThingMeta} from '../Thing';
import {SCTranslations} from '../types/i18n';

/**
 * Type of a point of interest
 */
export type SCPointOfInterestType = 'point of interest';

/**
 * A point of interest without references
 */
export interface SCPointOfInterestWithoutReferences
  extends SCThingWithCategoriesWithoutReferences<SCPointOfInterestCategories,
    SCThingWithCategoriesSpecificValues>,
    SCPlaceWithoutReferences {
  /**
   * Translated properties of a point of interest
   */
  translations?: SCTranslations<SCThingWithCategoriesTranslatableProperties>;

  /**
   * Type of a point of interest
   */
  type: SCPointOfInterestType;
}

/**
 * A point of interest
 */
export interface SCPointOfInterest extends SCPointOfInterestWithoutReferences, SCThingInPlace {
  /**
   * Translated properties of a point of interest
   */
  translations?: SCTranslations<SCThingWithCategoriesTranslatableProperties>;

  /**
   * Type of a point of interest
   */
  type: SCPointOfInterestType;
}

/**
 * Categories of a point of interest
 */
export type SCPointOfInterestCategories =
  'computer'
  | 'validator'
  | 'card charger'
  | 'printer'
  | 'disabled access';

/**
 * Meta data of a point of interest
 */
export class SCPointOfInterestMeta extends SCThingMeta {
}