/*
 * Copyright 2025 Elyra Authors
 *
 * Licensed 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.
 */
/**
 * This file was automatically generated by json-schema-to-typescript.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
 * and run the ../script/generateTS.sh script to regenerate all TS files.
 */
/* eslint-disable */

/**
 * External name of category
 */
export type ResourceDefinition = {
  [k: string]: unknown;
} & {
  default?: string;
  resource_key?: string;
  [k: string]: unknown;
};
/**
 * User-readable name of function
 */
export type ResourceDefinition1 = (
  | {
      [k: string]: unknown;
    }
  | {
      [k: string]: unknown;
    }
) & {
  default?: string;
  resource_key?: string;
  [k: string]: unknown;
};
/**
 * User-readable name of parameter
 */
export type ResourceDefinition2 = (
  | {
      [k: string]: unknown;
    }
  | {
      [k: string]: unknown;
    }
) & {
  default?: string;
  resource_key?: string;
  [k: string]: unknown;
};
/**
 * Translatable data type name of what is returned from the function. If this is not provided, default to return_type
 */
export type ResourceDefinition3 = (
  | {
      [k: string]: unknown;
    }
  | {
      [k: string]: unknown;
    }
) & {
  default?: string;
  resource_key?: string;
  [k: string]: unknown;
};
/**
 * The help text for the function.
 */
export type ResourceDefinition4 = (
  | {
      [k: string]: unknown;
    }
  | {
      [k: string]: unknown;
    }
) & {
  default?: string;
  resource_key?: string;
  [k: string]: unknown;
};
/**
 * User-readable name of field category
 */
export type ResourceDefinition5 = {
  [k: string]: unknown;
} & {
  default?: string;
  resource_key?: string;
  [k: string]: unknown;
};
/**
 * Localizable string resource
 */
export type ResourceDefinition6 = {
  [k: string]: unknown;
} & {
  default?: string;
  resource_key?: string;
  [k: string]: unknown;
};
/**
 * Array of categories for the field dropdown menu
 *
 * @minItems 0
 */
export type FieldCategoriesDef = FieldCategoriesItemDef[];
/**
 * Array of table contents for each field category
 *
 * @minItems 0
 */
export type FieldTableInfoDef = FieldTableInfoItemDef[];

/**
 * Expression Info Schema for the Common Properties editor
 */
export interface ExpressionInfo {
  functions?: FunctionList;
  /**
   * Metadata and content for field and value tables
   */
  fields?: {
    field_categories?: FieldCategoriesDef;
    field_table_info?: FieldTableInfoDef;
    [k: string]: unknown;
  };
  /**
   * Map of string resources.
   */
  resources?: {
    [k: string]: unknown;
  };
  /**
   * Controls if the validate schema link is shown
   */
  validateLink?: boolean;
  [k: string]: unknown;
}
/**
 * Function List Schema for the Common Properties editor
 */
export interface FunctionList {
  /**
   * Array of categories of functions
   *
   * @minItems 0
   */
  function_categories: FunctionCategoriesDef[];
  /**
   * Array of refs to functions that will be displayed as operators.
   *
   * @minItems 1
   */
  operator_refs?: [string, ...string[]];
  /**
   * Array of function information
   *
   * @minItems 1
   */
  function_info: [FunctionDef, ...FunctionDef[]];
  [k: string]: unknown;
}
/**
 * Definition of a information about a function
 */
export interface FunctionCategoriesDef {
  /**
   * Unique string to reference this category
   */
  id?: string;
  label: ResourceDefinition;
  /**
   * Array of function ids that are part of this fuction category
   *
   * @minItems 1
   */
  function_refs: [string, ...string[]];
}
/**
 * Definition of a information about a function
 */
export interface FunctionDef {
  /**
   * Unique string to reference this function
   */
  id: string;
  label: ResourceDefinition1;
  /**
   * Array of parameter information
   *
   * @minItems 0
   */
  parameters?: FunctionParameterDef[];
  return_type_label?: ResourceDefinition3;
  /**
   * The data type name of what is returned from the function.
   */
  return_type: string;
  description?: ResourceDefinition4;
}
/**
 * Definition of a information about a functions parameters.
 */
export interface FunctionParameterDef {
  label: ResourceDefinition2;
  /**
   * The type of the parameter.
   */
  type?: string;
  [k: string]: unknown;
}
/**
 * Metadata of a field dropdown menu item
 */
export interface FieldCategoriesItemDef {
  /**
   * Unique string to reference this category
   */
  id: string;
  label?: ResourceDefinition5;
  /**
   * Title of the field column
   */
  field_columns: {
    field_column_info: ColumnHeaderLabel;
    value_column_info: ColumnHeaderLabel;
    additional_column_info?: AdditionalInfoHeaderLabel;
    [k: string]: unknown;
  };
  [k: string]: unknown;
}
/**
 * Info about columns headers
 */
export interface ColumnHeaderLabel {
  label?: ResourceDefinition6;
  description?: ResourceDefinition6;
  [k: string]: unknown;
}
/**
 * Info about info columns headers
 */
export interface AdditionalInfoHeaderLabel {
  /**
   * Unique string to reference this info column
   */
  id: {
    [k: string]: unknown;
  };
  label?: ResourceDefinition6;
  [k: string]: unknown;
}
/**
 * Wrapper for all the field/value groups of a single category
 */
export interface FieldTableInfoItemDef {
  /**
   * Unique string to reference this category
   */
  field_category_ref: string;
  /**
   * Array of all the field/value groups of a single category
   *
   * @minItems 0
   */
  field_value_groups?: FieldValueGroupsItemDef[];
  [k: string]: unknown;
}
/**
 * A field entry, and all associated values and informational columns
 */
export interface FieldValueGroupsItemDef {
  /**
   * Unique identifier for this field entry
   */
  id: string;
  /**
   * A list of all values that are associated with this field
   *
   * @minItems 0
   */
  values?: ValueDef[];
  /**
   * Value type that will be used in the value array. Can be a primitive type (string, integer, double, date, time, timestamp, binary, boolean, or other)
   */
  value_type?: string;
  /**
   * A list of all informational column entries that are associated with this field
   *
   * @minItems 0
   */
  additional_column_entries?: AdditionalInfoItem[];
  /**
   * Object/primitive type used in the info array (string, integer, double, date, time, timestamp, binary, boolean, or custom types)
   */
  additional_column_type?: string;
  [k: string]: unknown;
}
/**
 * A wrapper a value of any basic type
 */
export interface ValueDef {
  value:
    | string
    | number
    | boolean
    | {
        [k: string]: unknown;
      }
    | unknown[]
    | null;
  [k: string]: unknown;
}
/**
 * A wrapper a value of any basic type and a column id
 */
export interface AdditionalInfoItem {
  /**
   * A string that uniquely identifies this column,
   */
  id: string;
  value:
    | string
    | number
    | boolean
    | {
        [k: string]: unknown;
      }
    | unknown[]
    | null;
  [k: string]: unknown;
}