io.kestros.commons.uilibraries.api.services.UiLibraryCompilationService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kestros-sling-ui-libraries-api Show documentation
Provides UI Libraries to Sling instances, which are used for maintaining and rendering CSS and JavaScript.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.
 */

package io.kestros.commons.uilibraries.api.services;

import io.kestros.commons.osgiserviceutils.services.ManagedService;
import io.kestros.commons.structuredslingmodels.exceptions.InvalidResourceTypeException;
import io.kestros.commons.uilibraries.api.exceptions.NoMatchingCompilerException;
import io.kestros.commons.uilibraries.api.models.FrontendLibrary;
import io.kestros.commons.uilibraries.api.models.ScriptType;
import io.kestros.commons.uilibraries.api.models.UiLibrary;
import java.util.List;
import javax.annotation.Nonnull;
import org.apache.sling.api.resource.ResourceResolver;

/**
 * Compiles CSS and JS for {@link UiLibrary}.
 */
public interface UiLibraryCompilationService extends ManagedService {

  /**
   * All registered script types.
   *
   * @return All registered script types.
   */
  @Nonnull
  List getAllRegisteredScriptTypes();

  /**
   * All registered CSS script types.
   *
   * @return All registered CSS script types.
   */
  @Nonnull
  List getRegisteredCssScriptTypes();

  /**
   * All registered JavaScript script types.
   *
   * @return All registered JavaScript script types.
   */
  @Nonnull
  List getRegisteredJavaScriptScriptTypes();

  /**
   * All registered CSS compilers.
   *
   * @return All registered CSS compilers.
   */
  @Nonnull
  List getCssCompilers();

  /**
   * All registered JavaScript compilers.
   *
   * @return All registered JavaScript compilers.
   */
  @Nonnull
  List getJavaScriptCompilers();

  /**
   * Registered compiler services.
   *
   * @return Registered compiler services.
   */
  @Nonnull
  List getCompilers();

  /**
   * Retrieves a specified ScriptType compiler.
   *
   * @param scriptTypes ScriptType to get the compiler for.
   * @param registeredCompilers Compilers to search from.
   * @param  Extends ScriptTypeCompiler.
   *
   * @return Specified ScriptType compiler.
   *
   * @throws NoMatchingCompilerException No compiler could be found for the specified
   *         {@link ScriptType}.
   */
  @Nonnull
   ScriptTypeCompiler getCompiler(
          @Nonnull List scriptTypes,
          @Nonnull List registeredCompilers) throws NoMatchingCompilerException;

  /**
   * Returns the uncached ScriptType output.
   *
   * @param library UI Library to retrieve output for.
   * @param scriptType ScriptType to retrieve.
   * @param resourceResolver ResourceResolver.
   *
   * @return The uncached ScriptType output.
   *
   * @throws NoMatchingCompilerException No compiler could be found for the specified
   *         {@link ScriptType}.
   * @throws InvalidResourceTypeException Thrown when a referenced dependency could not be
   *         adapted to UiLibrary.
   */
  @Nonnull
  String getUiLibraryOutput(@Nonnull FrontendLibrary library, @Nonnull ScriptType scriptType,
          @Nonnull ResourceResolver resourceResolver)
          throws InvalidResourceTypeException, NoMatchingCompilerException;

  /**
   * Returns the uncached ScriptType output.
   *
   * @param library UI Library to retrieve output for.
   * @param scriptType ScriptType to retrieve.
   *
   * @return The uncached ScriptType output.
   *
   * @throws NoMatchingCompilerException No compiler could be found for the specified
   *         {@link ScriptType}.
   * @throws InvalidResourceTypeException Thrown when a referenced dependency could not be
   *         adapted to UiLibrary.
   */
  @Nonnull
  @Deprecated(forRemoval = true)
  String getUiLibraryOutput(@Nonnull FrontendLibrary library, @Nonnull ScriptType scriptType)
          throws InvalidResourceTypeException, NoMatchingCompilerException;

  /**
   * Returns the library's source content.
   *
   * @param library UI Library to retrieve output for.
   * @param scriptType ScriptType to retrieve.
   * @param resourceResolver ResourceResolver.
   *
   * @return The library's source content.
   *
   * @throws NoMatchingCompilerException No compiler could be found for the specified
   *         {@link ScriptType}.
   * @throws InvalidResourceTypeException Thrown when a referenced dependency could not be
   *         adapted to UiLibrary.
   */
  @Nonnull
  String getUiLibrarySource(@Nonnull FrontendLibrary library, @Nonnull ScriptType scriptType,
          @Nonnull ResourceResolver resourceResolver)
          throws InvalidResourceTypeException, NoMatchingCompilerException;

  /**
   * Returns the library's source content.
   *
   * @param library UI Library to retrieve output for.
   * @param scriptType ScriptType to retrieve.
   *
   * @return The library's source content.
   *
   * @throws NoMatchingCompilerException No compiler could be found for the specified
   *         {@link ScriptType}.
   * @throws InvalidResourceTypeException Thrown when a referenced dependency could not be
   *         adapted to UiLibrary.
   */
  @Nonnull
  @Deprecated(forRemoval = true)
  String getUiLibrarySource(@Nonnull FrontendLibrary library, @Nonnull ScriptType scriptType)
          throws InvalidResourceTypeException, NoMatchingCompilerException;


  /**
   * Retrieves all ScriptTypes within a specified FrontendLibrary's script folder.
   *
   * @param library UI Library to retrieve scriptTypes for.
   * @param folderName Folder name.
   *
   * @return All ScriptTypes within a specified FrontendLibrary's script folder.
   */
  @Nonnull
  List getLibraryScriptTypes(@Nonnull FrontendLibrary library,
          @Nonnull String folderName);

}