DocsHelper.ts

/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * <http://www.mongodb.com/licensing/server-side-public-license>.
 */

import URI from 'urijs';

import AppConfig from 'util/AppConfig';

const defaultDocsUrl = 'https://go2docs.graylog.org/current';

const defaultPages = {
  ALERTS: 'interacting_with_your_log_data/alerts.html',
  AUDIT_LOG: 'interacting_with_your_log_data/audit_log.html',
  AUTHENTICATORS: 'setting_up_graylog/user_authentication.htm',
  AWS_KINESIS_CLOUDWATCH_INPUT: 'getting_in_log_data/aws_kinesis_cloudwatch_input.html',
  CHANGELOG: 'changelogs/changelog.html',
  CLUSTER_STATUS_EXPLAINED: 'setting_up_graylog/opensearch.htm#ClusterStatusExplained',
  COLLECTOR: 'getting_in_log_data/graylog_sidecar.html',
  COLLECTOR_SIDECAR: 'getting_in_log_data/graylog_sidecar.html',
  COLLECTOR_STATUS: 'getting_in_log_data/getting_started_with_graylog_sidecar.htm#ViewSidecarStatus',
  CONFIGURING_ES: 'setting_up_graylog/opensearch.htm#GraylogConfigurationSettings',
  DASHBOARDS: 'interacting_with_your_log_data/dashboards.html',
  DECORATORS: 'interacting_with_your_log_data/decorators.html',
  ENTERPRISE_SETUP: 'downloading_and_installing_graylog/installing_graylog.html',
  ES_CLUSTER_STATUS_RED: 'setting_up_graylog/opensearch.htm#ClusterStatusExplained',
  ES_CLUSTER_UNAVAILABLE: 'setting_up_graylog/opensearch.htm#GraylogConfigurationSettings',
  ES_OPEN_FILE_LIMITS: 'setting_up_graylog/opensearch.htm#GraylogConfigurationSettings',
  EVENT_PROCEDURES: 'what_more_can_graylog_do_for_me/event_procedures.htm',
  EXTRACTORS: 'making_sense_of_your_log_data/extractors.htm',
  GRAYLOG_DATA_NODE: 'downloading_and_installing_graylog/install_graylog_data_node.htm',
  INDEXER_FAILURES: 'getting_in_log_data/indexer_failures.html',
  INDEX_MODEL: 'setting_up_graylog/index_model.html',
  LICENSE: 'setting_up_graylog/operations_license_management.html',
  LICENSE_MANAGEMENT: 'setting_up_graylog/operations_license_management.html',
  LOAD_BALANCERS: 'setting_up_graylog/load_balancer_integration.html',
  LOOKUPTABLES: 'making_sense_of_your_log_data/lookup_tables.html',
  INPUTS: 'getting_in_log_data/inputs.html',
  OPERATIONS_CHANGELOG: 'changelogs/operations_changelog.html',
  OPEN_SEARCH_SETUP: 'setting_up_graylog/opensearch.htm#InstallingOpenSearch',
  PAGE_FLEXIBLE_DATE_CONVERTER: 'making_sense_of_your_log_data/extractors.htm#Normalization',
  PAGE_STANDARD_DATE_CONVERTER: 'making_sense_of_your_log_data/extractors.htm#Normalization',
  PERMISSIONS: 'setting_up_graylog/permission_management.html',
  PIPELINE_FUNCTIONS: 'making_sense_of_your_log_data/functions.html',
  PIPELINE_RULES: 'making_sense_of_your_log_data/pipeline_usage.html',
  PIPELINES: 'making_sense_of_your_log_data/pipelines.html',
  REPORTING: 'interacting_with_your_log_data/reporting.html',
  ROLLING_ES_UPGRADE: 'setting_up_graylog/opensearch.htm#UpgradingtoOpenSearch',
  SEARCH_FILTERS: 'making_sense_of_your_log_data/search_filters.htm',
  SEARCH_QUERY_ERRORS: 'making_sense_of_your_log_data/writing_search_queries.html#ErrorTypes',
  SEARCH_QUERY_LANGUAGE: 'making_sense_of_your_log_data/writing_search_queries.html',
  SECURITY_EVENTS: 'what_more_can_graylog_do_for_me/security_events.htm',
  STREAMS: 'making_sense_of_your_log_data/streams.html',
  STREAM_PROCESSING_RUNTIME_LIMITS: 'making_sense_of_your_log_data/stream_processing.htm#StreamProcessingRuntimeLimits',
  TIME_FRAME_SELECTOR: 'making_sense_of_your_log_data/time_frame_selector.html',
  UPGRADE_GUIDE: 'upgrading_graylog/upgrading_graylog.html',
  USERS_ROLES: 'setting_up_graylog/users_teams.htm',
  DATA_LAKE: 'setting_up_graylog/data_lake.htm',
  DATA_LAKE_PREVIEW: 'setting_up_graylog/data_lake_preview.htm',
  WELCOME: '', // Welcome page to the documentation
  DATA_TIERING: 'setting_up_graylog/data_tiering.htm',
  DATA_TIERING_WARM_TIER_SETUP: 'setting_up_graylog/data_tiering.htm#PrepareYourEnvironmentforaWarmTier',
  SERVER_UNAVAILABLE: 'https://www.graylog.org/community-support',
  MCP_SERVER: 'setting_up_graylog/graylog_mcp.htm',
} as const;

type Pages = Record<keyof typeof defaultPages, string>;

const overridePages = (pages: Pages, overrides: Partial<Pages>) =>
  new Proxy(pages, {
    get: (target: Pages, prop: keyof Pages) => overrides[prop] ?? target[prop],
  });

const isAbsolute = (url: string) => new URI(url).is('absolute');

const docsHelper = {
  PAGES: overridePages(defaultPages, AppConfig.branding?.()?.help_pages ?? {}),

  toString(path: string) {
    if (isAbsolute(path)) {
      return path;
    }
    const baseUrl = AppConfig.branding?.()?.help_url ?? defaultDocsUrl;

    return path === '' ? baseUrl : `${baseUrl}/${path}`;
  },

  versionedDocsHomePage() {
    return this.toString('');
  },
} as const;

export default docsHelper;