config.ts

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 *
 * Any modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import { schema, TypeOf } from '@osd/config-schema';

export const configSchema = schema.object({
  enhancements: schema.object({
    supportedAppNames: schema.arrayOf(schema.string(), {
      defaultValue: ['discover'],
    }),
  }),
  autocomplete: schema.object({
    querySuggestions: schema.object({
      enabled: schema.boolean({ defaultValue: true }),
    }),
    valueSuggestions: schema.object({
      enabled: schema.boolean({ defaultValue: true }),
    }),
  }),
  search: schema.object({
    aggs: schema.object({
      shardDelay: schema.object({
        // Whether or not to register the shard_delay (which is only available in snapshot versions
        // of OpenSearch) agg type/expression function to make it available in the UI for either
        // functional or manual testing
        enabled: schema.boolean({ defaultValue: false }),
      }),
    }),
    usageTelemetry: schema.object({
      enabled: schema.boolean({ defaultValue: false }),
    }),
  }),
  savedQueriesNewUI: schema.object({
    enabled: schema.boolean({ defaultValue: false }),
  }),
});

export type ConfigSchema = TypeOf<typeof configSchema>;