Warn about outposts in combination with Froide

README.md

@@ -51,6 +51,8 @@ You can then use the `-u` option to pass in the URL:
 $ schulfinder schools.json -u https://schulfinder.kultus-bw.de/?q=P3Rlcm09aHR0cHM6Ly9iaXQubHkvM3I0OUJySSZkaXN0YW5jZT0mb3duZXI9Jm91dHBvc3RzPTEm
 ```
 
+**Note:** Make sure to exclude outposts by switching off `Außenstellen berücksichtigen` (within `Erweitert` settings) when using the `-u` option in combination with `-f`, since outposts often lack important data fields (like email, phone number and fax). 
+
 ### FragDenStaat
 
 `schulfinder` supports the data format used by [Froide](https://github.com/okfde/froide) to import public bodies (see the [format documentation](https://froide.readthedocs.io/en/latest/importpublicbodies/#format)). Froide is the Freedom of Information Portal used by the German project [FragDenStaat](https://fragdenstaat.de/) and its [Austrian counterpart](https://fragdenstaat.at/).

package.json

@@ -28,6 +28,7 @@
 	],
 	"dependencies": {
 		"chalk": "^4.1.1",
+		"enquirer": "^2.3.6",
 		"got": "^11.8.2",
 		"libphonenumber-js": "^1.9.21",
 		"meow": "^10.0.1",

src/api.ts

@@ -11,9 +11,11 @@ import {
 	nullable
 } from 'superstruct'
 import ora from 'ora'
+import enquirer from 'enquirer'
 import pMap from 'p-map'
 import {District, SimpleSchool, DetailedSchool} from './types.js'
-import { quitWithError } from './cli.js'
+import { quit, quitWithError } from './cli.js'
+import { format } from 'libphonenumber-js'
 
 const baseURL = 'https://schulfinder.kultus-bw.de/api/'
 
@@ -98,17 +100,13 @@ export const getSchools = async (parameters: string | Record<string, string | nu
 		})
 }
 
-export const getSchoolsByURL = async (url: string, quiet = false) => {
-	const spinner = ora('Loading school list')
+export const getSchoolsByURL = async (url: string, froide = false, quiet = false) => {
+	const spinner = ora()
 
 	if (!(new URL(url).hostname == 'schulfinder.kultus-bw.de')) {
 		quitWithError(`Invalid URL: ${url}`)
 	}
 
-	if (!quiet) {
-		spinner.start()
-	}
-
 	url = url.trim()
 
 	const base64String = new URL(url).searchParams.get('q')
@@ -118,6 +116,28 @@ export const getSchoolsByURL = async (url: string, quiet = false) => {
 	} else {
 		const queryString = Buffer.from(base64String, 'base64').toString('utf-8')
 
+		if (froide) {
+			if (new URLSearchParams(queryString).get('outposts') == '1') {
+				spinner.warn('You have included outposts in your query. Importing outposts into Froide is highly discouraged.')
+
+				const answer = await enquirer.prompt({
+					type: 'confirm',
+					name: 'continue',
+					message: 'Do you want to continue?',
+					format: value => !!value ? 'yes' : 'no'
+				}) as {continue: boolean}
+
+				if (!answer.continue) {
+					spinner.fail('Aborted')
+					quit(1)
+				}
+			}
+		}
+
+		if (!quiet) {
+			spinner.start('Loading school list')
+		}
+
 		const schools = await getSchools(queryString)
 
 		if (!quiet) {

src/cli.ts

@@ -12,6 +12,8 @@ import {
 } from './api.js'
 import {formatToFroide} from './formats.js'
 
+export const quit = (statusCode: number) => process.exit(statusCode)
+
 const {unparse} = papaparse
 
 const cli = meow(`
@@ -76,7 +78,7 @@ export const quitWithError = (message: string) => {
 	let schoolsWithoutDetails
 
 	if (options.url) {
-		schoolsWithoutDetails = await getSchoolsByURL(options.url, options.quiet)
+		schoolsWithoutDetails = await getSchoolsByURL(options.url, options.froide, options.quiet)
 	} else {
 		const districts = await getDistricts(options.quiet)
 		schoolsWithoutDetails = await getSchoolsByDistricts(districts, options.quiet)

yarn.lock

@@ -1439,7 +1439,7 @@ enhanced-resolve@^0.9.1:
     memory-fs "^0.2.0"
     tapable "^0.1.8"
 
-enquirer@^2.3.5:
+enquirer@^2.3.5, enquirer@^2.3.6:
   version "2.3.6"
   resolved "https://registry.yarnpkg.com/enquirer/-/enquirer-2.3.6.tgz#2a7fe5dd634a1e4125a975ec994ff5456dc3734d"
   integrity sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==