/*!
 * Copyright 2022, Staffbase GmbH and contributors.
 * 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.
 */
import { BaseBlock } from "./base-block";
import { WidgetApi } from "./widget-api";
/**
 * Factory for the custom widgets.
 *
 * @param Base base class for the custom widgets to inherit from.
 * The class itself is a subclass of `HTMLElement` of the relevant `window` object,
 * with additional functionality.
 *
 * @param widgetApi API providing methods for additional information by the Staffbase framework
 *
 * @example
 *   const factory: BlockFactory = Base => {
 *
 *     return class CustomBlock extends Base {
 *       constructor() {
 *         super();
 *       }
 *
 *       // widget implementation follows ...
 *     }
 *   };
 */
export type BlockFactory = (Base: new () => BaseBlock, widgetApi: WidgetApi) => CustomElementConstructor;