/**
 * Copyright 2023 Comcast Cable Communications Management, LLC
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

import lng from '@lightningjs/core';
import Base from '../Base/Base';
import type { Color, StylePartial } from '../../types/lui';

export type SurfaceStyle = {
  animation: lng.types.TransitionSettings;
  backgroundColor: Color;
  radius: lng.Tools.CornerRadius;
  scale: number;
};

declare namespace Surface {
  export interface TemplateSpec extends Base.TemplateSpec {
    // TODO we may actually not want to include this here
    Background: typeof lng.Component<lng.Component.TemplateSpecLoose>; // TemplateSpecLoose allows us to patch in any arbitrary lng.Component
  }
}

declare class Surface<
  TemplateSpec extends Surface.TemplateSpec = Surface.TemplateSpec,
  TypeConfig extends lng.Component.TypeConfig = lng.Component.TypeConfig
> extends Base<TemplateSpec, TypeConfig> {
  /**
   * alias for this.h
   */
  get innerH(): number;

  /**
   * alias for this.w
   */
  get innerW(): number;

  get style(): SurfaceStyle;
  set style(v: StylePartial<SurfaceStyle>);

  // tags
  get _Background(): lng.Component;
}

export default Surface;
