* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\AssetMapper\ImportMap; use Symfony\Component\AssetMapper\Exception\RuntimeException; use Symfony\Component\Filesystem\Path; use Symfony\Component\VarExporter\VarExporter; /** * Reads/Writes the importmap.php file and returns the list of entries. * * @author Ryan Weaver */ class ImportMapConfigReader { private ImportMapEntries $rootImportMapEntries; public function __construct( private readonly string $importMapConfigPath, private readonly RemotePackageStorage $remotePackageStorage, ) { } public function getEntries(): ImportMapEntries { if (isset($this->rootImportMapEntries)) { return $this->rootImportMapEntries; } $configPath = $this->importMapConfigPath; $importMapConfig = is_file($this->importMapConfigPath) ? (static fn () => include $configPath)() : []; $entries = new ImportMapEntries(); foreach ($importMapConfig ?? [] as $importName => $data) { $validKeys = ['path', 'version', 'type', 'entrypoint', 'package_specifier']; if ($invalidKeys = array_diff(array_keys($data), $validKeys)) { throw new \InvalidArgumentException(sprintf('The following keys are not valid for the importmap entry "%s": "%s". Valid keys are: "%s".', $importName, implode('", "', $invalidKeys), implode('", "', $validKeys))); } $type = isset($data['type']) ? ImportMapType::tryFrom($data['type']) : ImportMapType::JS; $isEntrypoint = $data['entrypoint'] ?? false; if (isset($data['path'])) { if (isset($data['version'])) { throw new RuntimeException(sprintf('The importmap entry "%s" cannot have both a "path" and "version" option.', $importName)); } if (isset($data['package_specifier'])) { throw new RuntimeException(sprintf('The importmap entry "%s" cannot have both a "path" and "package_specifier" option.', $importName)); } $entries->add(ImportMapEntry::createLocal($importName, $type, $data['path'], $isEntrypoint)); continue; } $version = $data['version'] ?? null; if (null === $version) { throw new RuntimeException(sprintf('The importmap entry "%s" must have either a "path" or "version" option.', $importName)); } $packageModuleSpecifier = $data['package_specifier'] ?? $importName; $entries->add($this->createRemoteEntry($importName, $type, $version, $packageModuleSpecifier, $isEntrypoint)); } return $this->rootImportMapEntries = $entries; } public function writeEntries(ImportMapEntries $entries): void { $this->rootImportMapEntries = $entries; $importMapConfig = []; foreach ($entries as $entry) { $config = []; if ($entry->isRemotePackage()) { $config['version'] = $entry->version; if ($entry->packageModuleSpecifier !== $entry->importName) { $config['package_specifier'] = $entry->packageModuleSpecifier; } } else { $config['path'] = $entry->path; } if (ImportMapType::JS !== $entry->type) { $config['type'] = $entry->type->value; } if ($entry->isEntrypoint) { $config['entrypoint'] = true; } $importMapConfig[$entry->importName] = $config; } $map = class_exists(VarExporter::class) ? VarExporter::export($importMapConfig) : var_export($importMapConfig, true); file_put_contents($this->importMapConfigPath, <<getEntries(); return $entries->has($moduleName) ? $entries->get($moduleName) : null; } public function createRemoteEntry(string $importName, ImportMapType $type, string $version, string $packageModuleSpecifier, bool $isEntrypoint): ImportMapEntry { $path = $this->remotePackageStorage->getDownloadPath($packageModuleSpecifier, $type); return ImportMapEntry::createRemote($importName, $type, $path, $version, $packageModuleSpecifier, $isEntrypoint); } /** * Converts the "path" string from an importmap entry to the filesystem path. * * The path may already be a filesystem path. But if it starts with ".", * then the path is relative and the root directory is prepended. */ public function convertPathToFilesystemPath(string $path): string { if (!str_starts_with($path, '.')) { return $path; } return Path::join($this->getRootDirectory(), $path); } /** * Converts a filesystem path to a relative path that can be used in the importmap. * * If no relative path could be created - e.g. because the path is not in * the same directory/subdirectory as the root importmap.php file - null is returned. */ public function convertFilesystemPathToPath(string $filesystemPath): ?string { $rootImportMapDir = realpath($this->getRootDirectory()); $filesystemPath = realpath($filesystemPath); if (!str_starts_with($filesystemPath, $rootImportMapDir)) { return null; } // remove the root directory, prepend "./" & normalize slashes return './'.str_replace('\\', '/', substr($filesystemPath, \strlen($rootImportMapDir) + 1)); } private function getRootDirectory(): string { return \dirname($this->importMapConfigPath); } /** * @deprecated since Symfony 7.1, use ImportMapEntry::splitPackageNameAndFilePath() instead */ public static function splitPackageNameAndFilePath(string $packageName): array { trigger_deprecation('symfony/asset-mapper', '7.1', 'The method "%s()" is deprecated and will be removed in 8.0. Use ImportMapEntry::splitPackageNameAndFilePath() instead.', __METHOD__); $filePath = ''; $i = strpos($packageName, '/'); if ($i && (!str_starts_with($packageName, '@') || $i = strpos($packageName, '/', $i + 1))) { // @vendor/package/filepath or package/filepath $filePath = substr($packageName, $i); $packageName = substr($packageName, 0, $i); } return [$packageName, $filePath]; } }