@gtkx/cli 1.6.0 → 2.0.0-beta.1

package/dist/vite-plugins/resources.js

@@ -1,15 +1,14 @@
-import { createConfigLoader, resolveFuture, resourceBasePath } from "@gtkx/config/internal";
-import { error, info, isRecord, sortStrings } from "@gtkx/utils";
+import { createConfigLoader, resourceBasePath } from "@gtkx/config/internal";
+import { error, info, isPathInside, isRecord, sortStrings, toPosixPath } from "@gtkx/utils";
 import { copyFileSync, existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
 import { basename, dirname, extname, isAbsolute, join, posix, relative, sep } from "node:path";
 import { parseSync } from "vite";
-import { resolveDataDir } from "../internal/data-dir.js";
-import { listFilesRecursive } from "../internal/list-files.js";
+import { withExclusiveLoad } from "../internal/module-loads.js";
 import { runCliTool } from "../internal/run-cli-tool.js";
 import { parseRuntimeImportsIn, sourceLanguage } from "../internal/source-imports.js";
 import { createRetainedStagingDir, withStagingDir } from "../internal/staging-dir.js";
 import { ASSET_RE } from "./asset-extensions.js";
-import { DATA_PREFIX, isBareRelativeAsset, isDataAsset, parseIconSpecifier, parseResourceSpecifier, } from "./asset-specifier.js";
+import { isBareRelativeAsset, parseIconSpecifier, parseResourceSpecifier, } from "./asset-specifier.js";
 import { renderInitModule } from "./resource-init-module.js";
 import { BUNDLE_FILENAME, escapeXml, fromVirtualId, ICON_NAME_SEPARATOR, isVirtual, REFRESH_EXPORT, REGISTER_REFRESH_EXPORT, REL_SEPARATOR, RESOURCE_PATH_EXPORT, toVirtualId, VIRTUAL_INIT, } from "./resource-shared.js";
 import { stripQuery } from "./strip-query.js";
@@ -17,6 +16,7 @@ const RESOURCE_COMPILER = "glib-compile-resources";
 const MANIFEST_PREFIX = "/";
 const DEV_STAGING_PREFIX = "resources-dev";
 const MANIFEST_FILENAME = "package.json";
+const DATA_PREFIX = "#data/";
 const BUNDLED_QUERY_MENTION_RE = /[?&](?:icon|resource)(?:[=&]|$)/;
 const ICON_EXTENSIONS = new Set([".png", ".svg", ".xpm"]);
 const ICON_CONTEXTS = new Set([
@@ -49,12 +49,7 @@ const STOCK_ICON_CONTEXTS = new Set([
 ]);
 const ICON_SIZE_RE = /^([1-9]\d*)x\1(?:@[1-9]\d*)?$/;
 const RESERVED_ICON_NAMES = new Set(["", ".", ".."]);
-const toForwardSlashes = (value) => value.replaceAll(/[/\\]/g, "/");
-const isWithin = (root, path) => {
-    const rel = relative(root, path);
-    return rel.length > 0 && !isAbsolute(rel) && rel !== ".." && !rel.startsWith(`..${sep}`);
-};
-const isDependencyFile = (root, path) => isWithin(root, path) && relative(root, path).split(sep).includes("node_modules");
+const isDependencyFile = (root, path) => isPathInside(root, path) && relative(root, path).split(sep).includes("node_modules");
 const packageIdentityIn = (dir) => {
     try {
         const manifest = JSON.parse(readFileSync(join(dir, MANIFEST_FILENAME), "utf8"));
@@ -84,14 +79,14 @@ const validateResourcePath = (resourcePath) => {
     return resourcePath;
 };
 const derivedResourcePath = (state, sourcePath) => {
-    if (isWithin(state.root, sourcePath) && !isDependencyFile(state.root, sourcePath)) {
-        return validateResourcePath(`${state.prefix}/${toForwardSlashes(relative(state.root, sourcePath))}`);
+    if (isPathInside(state.root, sourcePath) && !isDependencyFile(state.root, sourcePath)) {
+        return validateResourcePath(`${state.prefix}/${toPosixPath(relative(state.root, sourcePath))}`);
     }
     const owner = packageForFile(sourcePath);
-    if (owner === null || !isWithin(owner.dir, sourcePath)) {
+    if (owner === null || !isPathInside(owner.dir, sourcePath)) {
         throw new Error(`${sourcePath} is outside the application and does not belong to a named package`);
     }
-    const packagePath = toForwardSlashes(relative(owner.dir, sourcePath));
+    const packagePath = toPosixPath(relative(owner.dir, sourcePath));
     return validateResourcePath(`${state.prefix}/${owner.name}/${packagePath}`);
 };
 const iconExtension = (sourcePath) => {
@@ -134,7 +129,7 @@ const iconLayoutInParts = (parts, beforeIndex) => {
     return isIconLayout(layout) ? layout.join("/") : iconLayoutInParts(parts, index - 1);
 };
 const iconLayoutFromTree = (sourcePath) => {
-    const parts = toForwardSlashes(sourcePath).split("/");
+    const parts = toPosixPath(sourcePath).split("/");
     return iconLayoutInParts(parts, parts.length - 2);
 };
 const derivedIconEntry = (state, sourcePath, requestedName) => {
@@ -159,7 +154,7 @@ const hasSideEffectIconImport = (code, id) => {
     }
     return parsed.module.staticImports.some((statement) => statement.entries.length === 0 && parseIconSpecifier(statement.moduleRequest.value) !== null);
 };
-const retainSideEffectIconImport = (state, code, id) => state.isV2 && hasSideEffectIconImport(code, id)
+const retainSideEffectIconImport = (code, id) => hasSideEffectIconImport(code, id)
     ? { code, moduleSideEffects: true }
     : null;
 const compileBundle = (state, outputPath) => withStagingDir("resources", (dir) => {
@@ -225,16 +220,6 @@ const refreshRegisteredDevBundle = (state) => {
         refresh();
     }
 };
-const scanDataAssets = (dataDir) => listFilesRecursive(dataDir, (name) => ASSET_RE.test(name));
-const primeLegacyDevBundle = (state) => {
-    if (state.dataDir === null) {
-        return;
-    }
-    for (const { absPath, rel } of scanDataAssets(state.dataDir)) {
-        registerEntry(state, absPath, rel);
-    }
-    compileDevBundle(state);
-};
 const registerDevAsset = (state) => {
     if (entriesSignature(state) !== state.compiledSignature) {
         compileDevBundle(state);
@@ -268,7 +253,7 @@ const activateEntry = (state, entry) => {
     state.sourcePaths.add(entry.sourcePath);
     return entry;
 };
-const isDeclarativeImporter = (state, importer) => !state.isBuild && state.isV2 && importer !== undefined;
+const isDeclarativeImporter = (state, importer) => !state.isBuild && importer !== undefined;
 const setSourceAvailability = (state, file, isAvailable) => {
     if (isAvailable) {
         state.missingSourcePaths.delete(file);
@@ -394,17 +379,6 @@ const resolveIconEntry = async (ctx, state, request) => {
         iconName: derived.iconName,
     };
 };
-const resolveLegacyAssetEntry = async (ctx, state, request) => {
-    const resolved = await ctx.resolve(request.source, request.importer, { ...request.options, skipSelf: true });
-    if (!resolved || resolved.external) {
-        return undefined;
-    }
-    const sourcePath = stripQuery(resolved.id);
-    if (!isAbsolute(sourcePath)) {
-        return undefined;
-    }
-    return registerEntry(state, sourcePath, request.source.slice(DATA_PREFIX.length));
-};
 const loadInitModule = (state) => {
     if (state.isBuild) {
         if (state.bundleReferenceId === null) {
@@ -479,8 +453,7 @@ const loadAssetModule = (state, virtualId) => {
     const { absPath, iconName, rel } = virtualAssetMetadata(virtualId);
     const resourcePath = validateResourcePath(rel);
     const { entry, isRegistered } = loadedResourceEntry(state, absPath, resourcePath);
-    const uri = `resource://${entry.resourcePath}`;
-    const defaultValue = iconName ?? (state.isV2 ? entry.resourcePath : uri);
+    const defaultValue = iconName ?? entry.resourcePath;
     compileLoadedDevAsset(state, isRegistered);
     return [
         ...assetModuleImports(iconName),
@@ -524,17 +497,17 @@ const bundledSpecifiersIn = (imports) => new Set(imports
     .map((entry) => entry.source));
 const isSourceModule = (file) => sourceLanguage(file) !== undefined;
 const isBundledSource = (source) => parseResourceSpecifier(source) !== null || parseIconSpecifier(source) !== null;
-const validateUnbundledV2Source = (source) => {
+const validateUnbundledSource = (source) => {
     if (isLegacyDataSpecifier(source)) {
         throw new Error(`${JSON.stringify(source)} uses the legacy #data asset form`);
     }
-    rejectInvalidV2Specifier(source);
+    rejectInvalidSpecifier(source);
 };
 const resolvedModuleDependency = async (ctx, source, importer) => {
     if (isBundledSource(source)) {
         return null;
     }
-    validateUnbundledV2Source(source);
+    validateUnbundledSource(source);
     const resolved = await ctx.resolve(source, importer, { skipSelf: true });
     if (resolved === null) {
         throw new Error(`${JSON.stringify(source)} could not be resolved from ${importer}`);
@@ -554,7 +527,7 @@ const resolvedModuleDependencies = async (ctx, imports, importer) => {
 const importerReconciliation = async (ctx, state, id) => {
     const file = stripQuery(id);
     const key = importerKey(file);
-    if (!state.isV2 || state.isBuild || !isSourceModule(file)) {
+    if (state.isBuild || !isSourceModule(file)) {
         return null;
     }
     const imports = parseRuntimeImportsIn(file);
@@ -708,27 +681,14 @@ const forgetImporterDeclarations = (state, importer) => {
     state.declaredEntries.delete(importer);
     state.declaredIcons.delete(importer);
 };
-const cloneStringSetMap = (source) => {
-    const clone = new Map();
-    for (const [key, values] of source) {
-        clone.set(key, new Set(values));
-    }
-    return clone;
-};
-const cloneDeclarationMap = (source) => {
-    const clone = new Map();
-    for (const [key, declarations] of source) {
-        clone.set(key, new Map(declarations));
-    }
-    return clone;
-};
+const cloneMapValues = (source, clone) => new Map([...source].map(([key, value]) => [key, clone(value)]));
 const reconciliationCandidate = (state) => ({
     ...state,
-    bundledSpecifiers: cloneStringSetMap(state.bundledSpecifiers),
-    moduleDependencies: cloneStringSetMap(state.moduleDependencies),
-    prunedDependencies: cloneStringSetMap(state.prunedDependencies),
-    declaredEntries: cloneDeclarationMap(state.declaredEntries),
-    declaredIcons: cloneDeclarationMap(state.declaredIcons),
+    bundledSpecifiers: cloneMapValues(state.bundledSpecifiers, (values) => new Set(values)),
+    moduleDependencies: cloneMapValues(state.moduleDependencies, (values) => new Set(values)),
+    prunedDependencies: cloneMapValues(state.prunedDependencies, (values) => new Set(values)),
+    declaredEntries: cloneMapValues(state.declaredEntries, (entries) => new Map(entries)),
+    declaredIcons: cloneMapValues(state.declaredIcons, (entries) => new Map(entries)),
     missingSourcePaths: new Set(state.missingSourcePaths),
 });
 const storeBundledSpecifiers = (state, importer, specifiers) => {
@@ -808,7 +768,7 @@ const commitReconciliation = (state, candidate) => {
     state.sourcePaths = candidate.sourcePaths;
     state.iconOwners = candidate.iconOwners;
 };
-const reconcileV2Importer = async (ctx, state, id) => {
+const reconcileImporter = async (ctx, state, id) => {
     const reconciliation = await importerReconciliation(ctx, state, id);
     if (reconciliation === null) {
         return;
@@ -824,7 +784,6 @@ const resolveResourceConfig = async (state, config, loadConfig) => {
     const loaded = await loadConfig.load(config.root ?? process.cwd());
     state.prefix = resourceBasePath(loaded.config.applicationId);
     state.root = loaded.root;
-    state.isV2 = resolveFuture(loaded.config.future).isResourceImported;
     return {
         assetsInclude: [ASSET_RE],
     };
@@ -882,12 +841,6 @@ const attachResourceWatcher = (state, server) => {
 const applyResolvedConfig = (state, config) => {
     state.isBuild = config.command === "build";
     state.root = config.root;
-    state.dataDir = null;
-    if (state.isBuild || state.isV2) {
-        return;
-    }
-    const relativeDataDir = resolveDataDir(config.root);
-    state.dataDir = relativeDataDir === null ? null : join(config.root, relativeDataDir);
 };
 const loadResourceModule = (state, id) => {
     if (id === VIRTUAL_INIT) {
@@ -899,7 +852,7 @@ const loadResourceModule = (state, id) => {
     return loadAssetModule(state, id);
 };
 const isLegacyDataSpecifier = (source) => source.startsWith(DATA_PREFIX) && ASSET_RE.test(stripQuery(source));
-const rejectInvalidV2Specifier = (source) => {
+const rejectInvalidSpecifier = (source) => {
     if (BUNDLED_QUERY_MENTION_RE.test(source)) {
         throw new Error(`${JSON.stringify(source)} is not a valid bundled asset import; use ?resource, ` +
             "?resource=/absolute/path, ?icon, or ?icon=name");
@@ -937,7 +890,7 @@ const resolveIconResourceId = async (ctx, state, request) => {
         ? undefined
         : { id: virtualIconId(resolved), moduleSideEffects: true };
 };
-const resolveV2ResourceId = async (ctx, state, request) => {
+const resolveBundledResourceId = async (ctx, state, request) => {
     if (isLegacyDataSpecifier(request.source)) {
         throw new Error(`${JSON.stringify(request.source)} uses the legacy #data asset form; import it relatively with ` +
             "?resource or ?url");
@@ -952,30 +905,14 @@ const resolveV2ResourceId = async (ctx, state, request) => {
         trackBundledSpecifier(state, request.importer, request.source);
         return resolved;
     }
-    rejectInvalidV2Specifier(request.source);
+    rejectInvalidSpecifier(request.source);
     return undefined;
 };
-const resolveLegacyResourceId = async (ctx, state, request) => {
-    if (BUNDLED_QUERY_MENTION_RE.test(request.source)) {
-        throw new Error(`${JSON.stringify(request.source)} requires future.v2ResourceImports`);
-    }
-    if (!isDataAsset(request.source)) {
-        return undefined;
-    }
-    const entry = await resolveLegacyAssetEntry(ctx, state, request);
-    return entry === undefined ? undefined : virtualAssetId(entry);
-};
 const resolveResourceId = (ctx, state, request) => {
     if (request.source === VIRTUAL_INIT) {
         return Promise.resolve(VIRTUAL_INIT);
     }
-    return state.isV2
-        ? resolveV2ResourceId(ctx, state, request)
-        : resolveLegacyResourceId(ctx, state, request);
-};
-const configureResourceServer = (state, server) => {
-    attachResourceWatcher(state, server);
-    primeLegacyDevBundle(state);
+    return resolveBundledResourceId(ctx, state, request);
 };
 const createResourcesPlugin = (state, loadConfig) => ({
     name: "gtkx:resources",
@@ -986,7 +923,7 @@ const createResourcesPlugin = (state, loadConfig) => ({
         applyResolvedConfig(state, config);
     },
     configureServer: (server) => {
-        configureResourceServer(state, server);
+        attachResourceWatcher(state, server);
     },
     buildStart() {
         if (state.isBuild && state.bundleReferenceId === null) {
@@ -1004,8 +941,8 @@ const createResourcesPlugin = (state, loadConfig) => ({
         return loadResourceModule(state, id);
     },
     async transform(code, id) {
-        await reconcileV2Importer(this, state, id);
-        return retainSideEffectIconImport(state, code, id);
+        await withExclusiveLoad(state, () => reconcileImporter(this, state, id));
+        return retainSideEffectIconImport(code, id);
     },
     generateBundle(_options, bundle) {
         finalizeBuildBundle(this, bundle, state);
@@ -1019,7 +956,6 @@ function gtkxResources(loadConfig = createConfigLoader(), entryPath) {
         prefix: "",
         root: "",
         isBuild: false,
-        isV2: false,
         entries: new Map(),
         bundledSpecifiers: new Map(),
         moduleDependencies: new Map(),
@@ -1033,7 +969,6 @@ function gtkxResources(loadConfig = createConfigLoader(), entryPath) {
         devBundlePath: "",
         server: null,
         compiledSignature: "",
-        dataDir: null,
         bundleReferenceId: null,
         iconOwners: new Map(),
     };