@luomus/laji-schema 2.0.23 → 2.0.25

package/dist/dto/FormNamedPlaceOptions.dto.ts

@@ -0,0 +1,172 @@
+/* tslint:disable */
+/*
+* This file was automatically generated.
+* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+* and run the command to regenerate this file.
+*/
+export class FormNamedPlaceOptions {
+  "@context"?: string;
+  id?: string;
+  "@type"?: string;
+  /**
+   * Named place viewer shows button to copy the URL for the named place viewer
+   */
+  adminShowCopyLink?: boolean;
+  /**
+   * Form users can create new named places for the form
+   */
+  allowAddingPublic?: boolean;
+  /**
+   * Help text for bird association filter
+   */
+  birdAssociationAreaHelp?: string;
+  /**
+   * Description shown at named place choose page. Allows HTML.
+   */
+  chooseDescription?: string;
+  /**
+   * The latest document is copied to named place's prepopulatedDocument. if documents date is same or after the current prepopulated document's date, or if prepopulated document doesn't have date. Date is checked from gatheringEvent or from gatherings
+   */
+  copyLatestDocumentToNamedPlace?: boolean;
+  /**
+   * Description shown above named place form when creating new named place. Allows HTML.
+   */
+  createDescription?: string;
+  /**
+   * Label for new named place creation button at named place choose page
+   */
+  createNewButtonLabel?: string;
+  /**
+   * Label for text before new named place creation button at named place choose page
+   */
+  createNewButtonPrependingTextLabel?: string;
+  /**
+   * Theme own submissions page uses local document viewer (that shows more accurate data)
+   */
+  documentListUseLocalDocumentViewer?: boolean;
+  /**
+   * Forces local document viewer to show these fields
+   */
+  documentViewerForcedFields?: string[];
+  /**
+   * The path of geometry that document viewer should show
+   */
+  documentViewerGatheringGeometryJSONPath?: string[];
+  /**
+   * Document viewer zooms to data instead of locked zoom level
+   */
+  documentViewerZoomToData?: boolean;
+  /**
+   * Admin label for named place viewer's document list
+   */
+  earlierLabel?: string;
+  /**
+   * Description shown at top of page when editing named place
+   */
+  editDescription?: string;
+  /**
+   * The named place UI allows filtering by bird association area
+   */
+  filterByBirdAssociationArea?: boolean;
+  /**
+   * The named place UI allows filtering by municipality
+   */
+  filterByMunicipality?: boolean;
+  /**
+   * The named place UI allows filtering by tags
+   */
+  filterByTags?: boolean;
+  /**
+   * When recording a document for a named place, the named place's data of these fields will be shown at the top of the page (defaults to ["alternativeIDs", "name", "municipality"]
+   */
+  headerFields?: string[];
+  /**
+   * On named place chooser view, map tab is hidden
+   */
+  hideMapTab?: boolean;
+  /**
+   * Named places will be fetched with units included (hard coded to work only for HR.2049)
+   */
+  includeUnits?: boolean;
+  /**
+   * Fields that named place viewer shows (if not defined will be digged from uiSchema["ui:options"].fieldsScopes[form collectionID])
+   */
+  infoFields?: string[];
+  /**
+   * Label for named place viewer last census
+   */
+  lastCensusLabel?: string;
+  /**
+   * Overrides labels for named place list column headers
+   */
+  listColumnNameMapping?: {
+    [k: string]: string | undefined;
+  };
+  /**
+   * List of columns visible in the list view
+   */
+  listColumns?: string[];
+  listColumnsMultisort?: boolean;
+  /**
+   * Label for named place chooser list tab
+   */
+  listLabel?: string;
+  mapCluster?: boolean;
+  /**
+   * Overlays that named place chooser map should show
+   */
+  mapOverlayNames?: string[];
+  /**
+   * Tilelayer name that named place chooser map should show
+   */
+  mapTileLayerName?: string;
+  /**
+   * User label for named place viewer's document list
+   */
+  myEarlierLabel?: string;
+  /**
+   * Form ID of named place form (defaults to MHL.36)
+   */
+  namedPlaceFormID?: string;
+  /**
+   * Fields that named places list shows.
+   */
+  namedPlaceList?: string[];
+  /**
+   * When a new named place is created, the prepopulatedDocument will be populated according to this.
+   */
+  prepopulatedDocumentFields?: {
+    [k: string]: unknown | undefined;
+  };
+  /**
+   * Label for print button of named place viewer
+   */
+  printLabel?: string;
+  releaseLabel?: string;
+  reservableLabel?: string;
+  /**
+   * Places are reservable if defined. Value defines when the reservation should expire in ISO-8601. Example: ${year}-10-12
+   */
+  reservationUntil?: string;
+  reservedLabel?: string;
+  /**
+   * Named place list shows legend for the row colors
+   */
+  showLegendList?: boolean;
+  /**
+   * Named place chooser view starts with map tab instead of list
+   */
+  startWithMap?: boolean;
+  /**
+   * Instead of populating observation form with prepopulatedDocument, it is populated with acceptedDocument. Admin can change the acceptedDocument from observation list
+   */
+  useAcceptedDocument?: boolean;
+  /**
+   * Named place viewer label for button for recording new observation
+   */
+  useLabel?: string;
+  /**
+   * Named place chooser map is initialized with data fitted in view.
+   */
+  zoomToData?: boolean;
+}

package/dist/dto/FormOptions.dto.ts

@@ -0,0 +1,232 @@
+import { FormFooter } from './index.dto';
+import { FormNamedPlaceOptions } from './index.dto';
+import { Document } from './index.dto';
+import { FormSeason } from './index.dto';
+/* tslint:disable */
+/*
+* This file was automatically generated.
+* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+* and run the command to regenerate this file.
+*/
+export enum PrintTypeEnum {
+  "empty" = "",
+  "printTypeLineTransect" = "MHL.printTypeLineTransect"
+}
+export enum RestrictAccessEnum {
+  "empty" = "",
+  "restrictAccessStrict" = "MHL.restrictAccessStrict",
+  "restrictAccessLoose" = "MHL.restrictAccessLoose"
+}
+export enum ResultServiceTypeEnum {
+  "empty" = "",
+  "resultServiceTypeLineTransect" = "MHL.resultServiceTypeLineTransect",
+  "resultServiceTypeNafi" = "MHL.resultServiceTypeNafi",
+  "resultServiceTypeBirdPointCount" = "MHL.resultServiceTypeBirdPointCount",
+  "resultServiceTypeWinterBirdCount" = "MHL.resultServiceTypeWinterBirdCount",
+  "resultServiceTypeSykeInsectProjects" = "MHL.resultServiceTypeSykeInsectProjects",
+  "resultServiceTypeInvasiveControl" = "MHL.resultServiceTypeInvasiveControl",
+  "resultServiceTypeCompleteLists" = "MHL.resultServiceTypeCompleteLists",
+  "resultServiceTypeWaterBirdCount" = "MHL.resultServiceTypeWaterBirdCount"
+}
+export enum ViewerTypeEnum {
+  "empty" = "",
+  "viewerTypeLineTransect" = "MHL.viewerTypeLineTransect",
+  "viewerTypeBirdPointCount" = "MHL.viewerTypeBirdPointCount"
+}
+export class FormOptions {
+  "@context"?: string;
+  id?: string;
+  "@type"?: string;
+  about?: {
+    en?: string;
+    fi?: string;
+    sv?: string;
+  };
+  /**
+   * Form admin can lock documents. Locked documents can't be edited
+   */
+  adminLockable?: boolean;
+  /**
+   * Allows usage in spreadsheet upload component
+   */
+  allowExcel?: boolean;
+  /**
+   * Allows creating templates from documents
+   */
+  allowTemplate?: boolean;
+  /**
+   * Label for the cancel button at the form footer
+   */
+  cancelLabel?: string;
+  /**
+   * Has dataset about page
+   */
+  dataset?: boolean;
+  /**
+   * Theme form introduction page doesn't show description for the form permission request button
+   */
+  disableRequestDescription?: boolean;
+  /**
+   * Prevent sending documents & named places
+   */
+  disabled?: boolean;
+  /**
+   * Only if has named places. All documents for admin
+   */
+  displayOwnSubmissions?: boolean;
+  /**
+   * The users can see all the documents with the form's collection ID instead of just their own
+   */
+  documentsViewableForAll?: boolean;
+  /**
+   * Label for the draft button at the form footer
+   */
+  draftLabel?: string;
+  editLabel?: string;
+  /**
+   * Units without count aren't considered in laji.fi viewer (including document viewers and datatables)
+   */
+  emptyOnNoCount?: boolean;
+  /**
+   * Excludes from the Vihko excel tools
+   */
+  excludeFromGlobalExcel?: boolean;
+  /**
+   * Options for footer of the observation form
+   */
+  footer?: FormFooter;
+  /**
+   * Label for the own submissions list at the header of document form
+   */
+  formOwnSubmissionsLabel?: string;
+  /**
+   * Shown at form permission intro page. Allows HTML
+   */
+  formPermissionDescription?: string;
+  forms?: string[];
+  /**
+   * The form has administrators. Administrators can handle user access permissions and admin roles for all forms with the collectionID of the form.
+   */
+  hasAdmins?: boolean;
+  /**
+   * Hides the cancel button at form footer
+   */
+  hideCancelButton?: boolean;
+  hideDraftButton?: boolean;
+  /**
+   * Hides the save/edit button at form footer
+   */
+  hideSaveButton?: boolean;
+  /**
+   * Terms of Service is hidden at the header of observation form
+   */
+  hideTES?: boolean;
+  /**
+   * Hides the draft button at form footer
+   */
+  hideTempButton?: boolean;
+  instructions?: {
+    en?: string;
+    fi?: string;
+    sv?: string;
+  };
+  /**
+   * Form UI has a greeting page for convenient mobile usage
+   */
+  mobile?: boolean;
+  namedPlaceOptions?: FormNamedPlaceOptions;
+  /**
+   * The title label for theme form sidebar
+   */
+  navigationTitle?: string;
+  /**
+   * Available actions for own submissions (only on the own submissions page). Defaults to ['edit', 'view', 'download', 'stats', 'delete']
+   */
+  ownSubmissionsActions?: string[];
+  /**
+   * Shown at sidebar link and title of all submissions page
+   */
+  ownSubmissionsAdminTitle?: string;
+  /**
+   * Columns for own submissions (only on the own submissions page). Defaults to ['dateEdited', 'dateObserved', 'taxon', 'namedPlaceName', 'observer', 'id']
+   */
+  ownSubmissionsColumns?: string[];
+  /**
+   * Shown at sidebar link and title of all submissions page
+   */
+  ownSubmissionsTitle?: string;
+  /**
+   * Periods that the "NoExistingGatheringsInNamedPlace" validation uses
+   */
+  periods?: string[];
+  prepopulateWithInformalTaxonGroups?: string[];
+  prepopulateWithTaxonSets?: string;
+  /**
+   * Initial document data
+   */
+  prepopulatedDocument?: Document;
+  printType?: PrintTypeEnum;
+  /**
+   * Users need to have permission to access the form
+   */
+  restrictAccess?: RestrictAccessEnum;
+  resultServiceType?: ResultServiceTypeEnum;
+  /**
+   * Message shown when document save failed
+   */
+  saveErrorMessage?: string;
+  /**
+   * Label for the save button at the form footer
+   */
+  saveLabel?: string;
+  /**
+   * Message shown when document was successfully saved
+   */
+  saveSuccessMessage?: string;
+  /**
+   * Message shown when document draft was successfully saved
+   */
+  saveTempSuccessMessage?: string;
+  /**
+   * Named places page shows the places as done if they have observation inside the season
+   */
+  season?: FormSeason;
+  /**
+   * Makes the documents reported with the form secondary
+   */
+  secondaryCopy?: boolean;
+  /**
+   * Overrides MHL.shortTitle usage
+   */
+  shortTitleFromCollectionName?: boolean;
+  /**
+   * Sub forms are shown only if they have this property
+   */
+  sidebarFormLabel?: string;
+  /**
+   * Has only a form page, no sidebar
+   */
+  simple?: boolean;
+  /**
+   * Documents can't have data not defined in form fields. Defaults to true.
+   */
+  strict?: boolean;
+  /**
+   * Label for the draft button at the form footer
+   */
+  tempLabel?: string;
+  /**
+   * Makes the form use named places
+   */
+  useNamedPlaces?: boolean;
+  /**
+   * Uses schema comments as form help texts
+   */
+  useSchemaCommentsAsHelpTexts?: boolean;
+  viewerType?: ViewerTypeEnum;
+  warnEditingOldDocument?: boolean;
+  /**
+   * Duration in ISO 8601 duration format. Defaults to P1W (one week)
+   */
+  warnEditingOldDocumentDuration?: boolean;
+}

package/dist/dto/FormPermission.dto.ts

@@ -0,0 +1,15 @@
+/* tslint:disable */
+/*
+* This file was automatically generated.
+* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+* and run the command to regenerate this file.
+*/
+export class FormPermission {
+  "@context"?: string;
+  id?: string;
+  "@type"?: string;
+  admins?: string[];
+  collectionID: string;
+  editors?: string[];
+  permissionRequests?: string[];
+}

package/dist/dto/FormPermissionPerson.dto.ts

@@ -0,0 +1,15 @@
+/* tslint:disable */
+/*
+* This file was automatically generated.
+* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+* and run the command to regenerate this file.
+*/
+export class FormPermissionPerson {
+  "@context"?: string;
+  id?: string;
+  "@type"?: string;
+  personID: string;
+  admins?: string[];
+  editors?: string[];
+  permissionRequests?: string[];
+}

package/dist/dto/FormPermissionSingle.dto.ts

@@ -0,0 +1,20 @@
+/* tslint:disable */
+/*
+* This file was automatically generated.
+* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+* and run the command to regenerate this file.
+*/
+export enum TypeEnum {
+  "empty" = "",
+  "typeAdmin" = "MFP.typeAdmin",
+  "typeEditor" = "MFP.typeEditor",
+  "typeAccessRequest" = "MFP.typeAccessRequest"
+}
+export class FormPermissionSingle {
+  "@context"?: string;
+  id?: string;
+  "@type"?: string;
+  collectionID: string;
+  type?: TypeEnum;
+  userID?: string;
+}

package/dist/dto/FormSeason.dto.ts

@@ -0,0 +1,19 @@
+/* tslint:disable */
+/*
+* This file was automatically generated.
+* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+* and run the command to regenerate this file.
+*/
+export class FormSeason {
+  "@context"?: string;
+  id?: string;
+  "@type"?: string;
+  /**
+   * End of season
+   */
+  end?: string;
+  /**
+   * Start of season
+   */
+  start?: string;
+}