com.liferay.frontend.js.loader.modules.extender.npm.JSPackage Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.frontend.js.loader.modules.extender.npm;
import java.net.URL;
import java.util.Collection;
/**
* Represents an NPM package inside a {@link JSBundle}.
*
*
* {@link JSModule}s belong to a {@link JSPackage} and {@link JSPackage}s belong
* to a {@link JSBundle}.
*
*
* @author Iván Zaera
*/
public interface JSPackage extends JSBundleObject {
/**
* Returns the NPM package's bundle.
*
* @return the NPM package's bundle
*/
public JSBundle getJSBundle();
public Collection getJSModuleAliases();
/**
* Returns the NPM modules contained inside the NPM package.
*
* @return the NPM modules
*/
public Collection getJSModules();
/**
* Returns the dependencies (i.e., other NPM packages) declared by the NPM
* package.
*
* @return the NPM package dependencies
*/
public Collection getJSPackageDependencies();
/**
* Returns the NPM package's dependency (i.e., another NPM package) with the
* package name.
*
* @param packageName the package name
* @return the package dependency or null if no dependency with
* the name exists
*/
public JSPackageDependency getJSPackageDependency(String packageName);
/**
* Returns the default module's name declared by the NPM package.
*
* @return the default module's name
*/
public String getMainModuleName();
public String getResolvedId();
/**
* Returns the resource's URL residing in the NPM package.
*
* @param location the resource's path
* @return the resource's URL
*/
public URL getResourceURL(String location);
/**
* Returns the package's NPM version.
*
* @return the package's NPM version
*/
public String getVersion();
}