browser

Documentation

Index

• Constants
• func DefaultFlagSet(ctx context.Context) (*flag.FlagSet, error)
• func Run(ctx context.Context, run_logger *log.Logger) error
• func RunWithFlagSet(ctx context.Context, fs *flag.FlagSet, logger *log.Logger) error
• func RunWithOptions(ctx context.Context, opts *RunOptions) error
• type AssetHandlerFunc
• type Config
  • func ConfigFromFlagSet(ctx context.Context, fs *flag.FlagSet) (*Config, error)
• type MiddlewareHandlerFunc
• type PointInPolygonOptions
• type RunOptions

Constants

const AuthenticatorURI string = "authenticator-uri"

const CORSAllowCredentialsDefault bool = false

const CORSAllowCredentialsFlag string = "cors-allow-credentials"

const CORSOriginFlag string = "cors-origin"

const CacheURIFlag string = "cache-uri"

const ConfigURIDefault string = ""

const ConfigURIFlag string = "config-uri"

const CustomChromeURIFlag string = "custom-chrome-uri"

const CustomEditPropertiesFlag string = "custom-edit-property"

const CustomEditValidationWasmDirDefault string = ""

const CustomEditValidationWasmDirFlag string = "custom-edit-validation-wasm-dir"

const CustomEditValidationWasmPathDefault string = ""

const CustomEditValidationWasmPathFlag string = "custom-edit-validation-wasm-path"

const DisableGeoJSONDefault bool = false

const DisableGeoJSONFlag string = "disable-geojson"

const DisableGeoJSONLDDefault bool = false

const DisableGeoJSONLDFlag string = "disable-geojsonld"

const DisableIdDefault bool = false

const DisableIdFlag string = "disable-id"

const DisableIndexDefault bool = false

const DisableIndexFlag string = "disable-index"

const DisableNavPlaceDefault bool = false

const DisableNavPlaceFlag string = "disable-navplace"

const DisablePNGDefault bool = false

const DisablePNGFlag string = "disable-png"

const DisableSPRDefault bool = false

const DisableSPRFlag string = "disable-spr"

const DisableSVGDefault bool = false

const DisableSVGFlag string = "disable-svg"

const DisableSearchDefault bool = false

const DisableSearchFlag string = "disable-search"

const DisableSelectDefault bool = false

const DisableSelectFlag string = "disable-select"

const DisableWebFingerDefault bool = false

const DisableWebFingerFlag string = "disable-webfinger"

const EnableAllFlag string = "enable-all"

const EnableCORSDefault bool = true

const EnableCORSFlag string = "enable-cors"

const EnableCustomEditValidationWasmDefault bool = false

const EnableCustomEditValidationWasmFlag string = "enable-custom-edit-validation-wasm"

const EnableDataFlag string = "enable-data"

const EnableEditAPIDefault bool = false

const EnableEditAPIFlag string = "enable-edit-api"

const EnableEditDefault bool = false

const EnableEditFlag string = "enable-edit"

const EnableEditUIDefault bool = false

const EnableEditUIFlag string = "enable-edit-ui"

const EnableGeoJSONFlag string = "enable-geojson"

const EnableGeoJSONLDFlag string = "enable-geojson-ld"

const EnableGraphicsFlag string = "enable-graphics"

const EnableHTMLDefault bool = false

const EnableHTMLFlag string = "enable-html"

const EnableIdDefault bool = true

const EnableIdFlag string = "enable-id"

const EnableIndexDefault bool = true

const EnableIndexFlag string = "enable-index"

const EnableNavPlaceFlag string = "enable-navplace"

const EnablePNGFlag string = "enable-png"

const EnablePointInPolygonAPIDefault bool = false

const EnablePointInPolygonAPIFlag string = "enable-point-in-polygon-api"

const EnablePointInPolygonDefault bool = false

const EnablePointInPolygonFlag string = "enable-point-in-polygon"

const EnableSPRFlag string = "enable-spr"

const EnableSVGFlag string = "enable-svg"

const EnableSearchAPIFlag string = "enable-search-api"

const EnableSearchAPIGeoJSONFlag string = "enable-search-api-geojson"

const EnableSearchFlag string = "enable-search"

const EnableSearchHTMLFlag string = "enable-search-html"

const EnableSelect string = "enable-select"

const EnableWebFingerFlag string = "enable-webfinger"

const ExporterURIFlag string = "exporter-uri"

const GitHubAccessTokenURIDefault string = ""

const GitHubAccessTokenURIFlag string = "github-accesstoken-uri"

const GitHubReaderAccessTokenURIDefault string = ""

const GitHubReaderAccessTokenURIFlag string = "github-reader-accesstoken-uri"

const GitHubWriterAccessTokenURIDefault string = ""

const GitHubWriterAccessTokenURIFlag string = "github-writer-accesstoken-uri"

const PathAPICessateFeatureDefault string = "/api/cessate/"

const PathAPICessateFeatureFlag string = "path-api-cessate-feature"

const PathAPICreateFeatureDefault string = "/api/create/"

const PathAPICreateFeatureFlag string = "path-api-create-feature"

const PathAPIDeprecateFeatureDefault string = "/api/deprecate/"

const PathAPIDeprecateFeatureFlag string = "path-api-deprecate-feature"

const PathAPIEditGeometryDefault string = "/api/geometry/"

const PathAPIEditGeometryFlag string = "path-api-edit-geometry"

const PathCreateFeatureDefault string = "/create/"

const PathCreateFeatureFlag string = "path-create-feature"

const PathEditGeometryDefault string = "/geometry/"

const PathEditGeometryFlag string = "path-edit-geometry"

const PathPingDefault string = "/ping"

const PathPingFlag string = "path-ping"

const PathPointInPolygonAPIDefault string = "/api/point-in-polygon"

const PathPointInPolygonAPIFlag string = "path-point-in-polygon-api"

const PathPointInPolygonDefault string = "/point-in-polygon"

const PathPointInPolygonFlag string = "path-point-in-polygon"

const PathSearchAPIDefault string = "/api/search/"

const PathSearchDefault string = "/search/"

const PlacetypesDefinitionURIDefault string = "whosonfirst://"

const PlacetypesDefinitionURIFlag string = "placetypes-definition-uri"

const PointInPolygonSkipPlacetypeFilterDefault bool = false

const PointInPolygonSkipPlacetypeFilterFlag string = "point-in-polygon-skip-placetype-filter"

const ReaderURIFlag string = "reader-uri"

const SearchDatabaseURIDefault string = "null://"

const SearchDatabaseURIFlag string = "search-database-uri"

const SelectPatternFlag string = "select-pattern"

const ServerURIFlag string = "server-uri"

const SpatialDatabaseURIFlag string = "spatial-database-uri"

const StaticPrefixFlag string = "static-prefix"

const VerboseDefault bool = false

const VerboseFlag string = "verbose"

const WebFingerHostname string = "webfinger-hostname"

const WriterURIFlag string = "writer-uri"

Functions

func DefaultFlagSet

func DefaultFlagSet(ctx context.Context) (*flag.FlagSet, error)

DefaultFlagSet returns a `flag.FlagSet` instance with flags and defaults values assigned for use with `app`.

func Run

func Run(ctx context.Context, run_logger *log.Logger) error

func RunWithFlagSet

func RunWithFlagSet(ctx context.Context, fs *flag.FlagSet, logger *log.Logger) error

func RunWithOptions

func RunWithOptions(ctx context.Context, opts *RunOptions) error

Types

type AssetHandlerFunc

type AssetHandlerFunc func(*http.ServeMux, string) error

type Config

type Config struct {
	AuthenticatorURI               string   `json:"authenticator_uri"`
	CacheURI                       string   `json:"cache_uri"`
	CORSOrigins                    []string `json:"cors_origins,omitempty"`
	CORSAllowCredentials           bool     `json:"cors_allow_credentials,omitempty"`
	CustomChromeURI                string   `json:"custom_chrome_uri,omitempty"`
	CustomEditProperties           []string `json:"custom_edit_properties,omitempty"`
	CustomEditValidationWasmDir    string   `json:"custom_edit_validation_wasm_dir"`
	CustomEditValidationWasmPath   string   `json:"custom_edit_validation_wasm_path"`
	DisableGeoJSON                 bool     `json:"disable_geojson,omitempty"`
	DisableGeoJSONLD               bool     `json:"disable_geojsonld,omitempty"`
	DisableId                      bool     `json:"disable_id,omitempty"`
	DisableIndex                   bool     `json:"disable_index,omitempty"`
	DisableNavPlace                bool     `json:"disable_navplace,omitempty"`
	DisablePNG                     bool     `json:"disable_png,omitempty"`
	DisableSearch                  bool     `json:"disable_search,omitempty"`
	DisableSelect                  bool     `json:"disable_select"`
	DisableSPR                     bool     `json:"disable_spr"`
	DisableSVG                     bool     `json:"disable_svg,omitempty"`
	DisableWebFinger               bool     `json:"disable_webfinger"`
	EnableAll                      bool     `json:"enable_all,omitempty"`
	EnableCORS                     bool     `json:"enable_cors,omitempty"`
	EnableCustomEditValidationWasm bool     `json:"enable_custom_edit_validation_wasm"`
	EnableData                     bool     `json:"enable_data,omitempty"`
	EnableEdit                     bool     `json:"enable_edit,omitempty"`
	EnableEditAPI                  bool     `json:"enable_edit_api,omitempty"`
	EnableEditUI                   bool     `json:"enable_edit_ui,omitempty"`
	EnableGeoJSON                  bool     `json:"enable_geojson,omitempty"`
	EnableGeoJSONLD                bool     `json:"enable_geojsonld,omitempty"`
	EnableGraphics                 bool     `json:"enable_graphics"`
	EnableHTML                     bool     `json:"enable_html,omitempty"`
	EnableId                       bool     `json:"enable_id,omitempty"`
	EnableIndex                    bool     `json:"enable_index,omitempty"`
	EnableNavPlace                 bool     `json:"enable_navplace,omitempty"`
	EnablePointInPolygon           bool     `json:"enable_point_in_polygon,omitempty"`
	EnablePointInPolygonAPI        bool     `json:"enable_point_in_polygon_api,omitempty"`
	EnablePNG                      bool     `json:"enable_png,omitempty"`
	EnableSearch                   bool     `json:"enable_search,omitempty"`
	EnableSearchAPI                bool     `json:"enable_search_api,omitempty"`
	EnableSelect                   bool     `json:"enable_select,omitempty"`
	EnableSPR                      bool     `json:"enable_spr,omitempty"`
	EnableSVG                      bool     `json:"enable_svg,omitempty"`
	EnableWebFinger                bool     `json:"enable_webfinger,omitempty"`
	// A valid whosonfirst/go-whosonfirst-export/v2 URI used to export feature records that are updated.
	ExporterURI                string   `json:"exporter_uri,omitempty"`
	JavaScriptAtEOF            bool     `json:"javascript_at_eof"`
	GitHubAccessTokenURI       string   `json:"github_accesstoken_uri,omitempty"`
	GitHubReaderAccessTokenURI string   `json:"github_reader_accesstoken_uri,omitempty"`
	GitHubWriterAccessTokenURI string   `json:"github_writer_accesstoken_uri,omitempty"`
	MapProviderURI             string   `json:"map_provider_uri"`
	NavPlaceMaxFeatures        int      `json:"navplace_max_features,omitempty"`
	PathCreateFeature          string   `json:"path_create_feature,omitempty"`
	PathCreateFeatureAPI       string   `json:"path_create_feature_api,omitempty"`
	PathCessateFeatureAPI      string   `json:"path_cessate_feature_api,omitempty"`
	PathDeprecateFeatureAPI    string   `json:"path_deprecate_feature_api,omitempty"`
	PathEditGeometry           string   `json:"path_edit_geometry,omitempty"`
	PathEditGeometryAPI        string   `json:"path_edit_geometry_api,omitempty"`
	PathGeoJSON                string   `json:"path_geojson,omitempty"`
	PathGeoJSONAlt             []string `json:"path_geojson_alt,omitempty"`
	PathGeoJSONLD              string   `json:"path_geojsonld,omitempty"`
	PathGeoJSONLDAlt           []string `json:"path_geojsonld_alt,omitempty"`
	PathIndex                  string   `json:"path_index,omitempty"`
	PathId                     string   `json:"path_id,omitempty"`
	PathNavPlace               string   `json:"path_navplace,omitempty"`
	PathNavPlaceAlt            []string `json:"path_navplace_alt,omitempty"`
	PathPing                   string   `json:"path_ping,omitempty"`
	PathPNG                    string   `json:"path_png,omitempty"`
	PathPNGAlt                 []string `json:"path_png_alt,omitempty"`
	PathPointInPolygon         string   `json:"path_point_in_polygon,omitempty"`
	PathPointInPolygonAPI      string   `json:"path_point_in_polygon_api,omitempty"`
	PathSearch                 string   `json:"path_search,omitempty"`
	PathSearchAPI              string   `json:"path_search_api,omitempty"`
	PathSelect                 string   `json:"path_select,omitempty"`
	PathSelectAlt              []string `json:"path_select_alt,omitempty"`
	PathSPR                    string   `json:"path_spr,omitempty"`
	PathSPRAlt                 []string `json:"path_spr,omitempty"`
	PathSVG                    string   `json:"path_svg,omitempty"`
	PathSVGAlt                 []string `json:"path_svg_alt,omitempty"`
	PathWebFinger              string   `json:"path_webfinger,omitempty"`
	PathWebFingerAlt           []string `json:"path_webfinger_alt,omitempty"`
	PlacetypesDefinitionURI    string   `json:"placetypes_definition_uri,omitempty"`
	// An optional boolean flag signaling that the point-in-polygon hierarchy resolver should skip placetype filters. If
	// true it is expected that your code will deal with that as needed elsewhere.
	PointInPolygonSkipPlacetypeFilter bool `json:"point_in_polygon_skip_placetype_filter"`
	// One or more valid whosonfirst/go-reader URIs
	ReaderURIs []string `json:"reader_uris"`
	// An optional boolean flag signaling whether JavaScript and CSS assets should be combined and minified.
	RollupAssets      bool   `json:"rollup_assets"`
	SearchDatabaseURI string `json:"search_database_uri,omitempty"`
	SelectPattern     string `json:"select_pattern,omitempty"`
	// A valid aaronland/go-http-server URI
	ServerURI string `json:"server_uri"`
	// A valid whosonfirst/go-whosonfirst-spatial.Database URI
	SpatialDatabaseURI string `json:"spatial_database_uri,omitempty"`
	URIPrefix          string `json:"uri_prefix,omitempty"`
	// Enable verbose logging
	Verbose bool `json:"verbose,omitempty"`
	// The hostname to use for WebFinger output
	WebFingerHostname string `json:"webfinger_hostname,omitempty"`
	// One or more valid whosonfirst/go-writer/v3 URIs
	WriterURIs []string `json:"writer_uris,omitempty"`
	Templates  []fs.FS  `json:"templates,omitempty"`
}

func ConfigFromFlagSet

func ConfigFromFlagSet(ctx context.Context, fs *flag.FlagSet) (*Config, error)

type MiddlewareHandlerFunc

type MiddlewareHandlerFunc func(http.Handler) http.Handler

type PointInPolygonOptions

type PointInPolygonOptions struct {
	ResultsCallback          wof_hierarchy.PointInPolygonHierarchyResolverUpdateCallback
	UpdateCallback           wof_hierarchy.PointInPolygonHierarchyResolverUpdateCallback
	ToCopyFromParentOnUpdate []string
}

type RunOptions

type RunOptions struct {
	Logger    *log.Logger
	Config    *Config
	Templates []fs.FS

	CustomURIs              map[string]string
	CustomChrome            chrome.Chrome
	CustomRouteHandlerFuncs map[string]handler.RouteHandlerFunc
	// CustomMiddlewareHandlers    map[string][]MiddlewareHandlerFunc
	CustomAssetHandlerFunctions []AssetHandlerFunc
	CustomEditProperties        []properties.CustomProperty
	CustomEditValidationFunc    custom.CustomValidationFunc
	CustomEditValidationWasm    *custom.CustomValidationWasm
	PointInPolygonOptions       *PointInPolygonOptions
}