@openfairygui/functions 0.3.0-alpha.4 → 0.3.1

package/src/publish/package-context.ts

@@ -9,6 +9,7 @@ import {
 	ProjectType,
 	type SoundResource,
 	type SpineResource,
+	type SwfResource,
 } from '@openfairygui/core';
 import type { AtlasRasterBackend } from './contracts.js';
 import { collectPackageResourceReferences } from './resource-references.js';
@@ -69,6 +70,12 @@ export function isSoundResource(resource: ReturnType<Package['listResources']>[n
 	return resource.propertyType === 'SoundResource';
 }
 
+export function isSwfResource(
+	resource: ReturnType<Package['listResources']>[number],
+): resource is SwfResource {
+	return resource.propertyType === 'SwfResource';
+}
+
 function isSpineResource(resource: ReturnType<Package['listResources']>[number]): resource is SpineResource {
 	return resource.propertyType === 'SpineResource';
 }
@@ -132,10 +139,15 @@ export function extname(fileName: string): string {
 }
 
 function resolvePublishedMiscFileName(resource: MiscResource, projectType: number): string {
-	const file = resource.getFile();
-	if (projectType !== UNITY_PROJECT_TYPE) return file;
-	if (file.toLowerCase().endsWith('.atlas')) return `${file}.txt`;
-	return file;
+	const fileName = `${getPublishedId(resource)}${extname(resource.getFile())}`;
+	if (projectType === UNITY_PROJECT_TYPE && fileName.toLowerCase().endsWith('.atlas')) {
+		return `${fileName}.txt`;
+	}
+	return fileName;
+}
+
+function resolvePublishedSwfFileName(resource: SwfResource): string {
+	return `${getPublishedId(resource)}${extname(resource.getFile()) || '.swf'}`;
 }
 
 function resolvePublishedSkeletonFileName(resource: SpineResource | DragonBonesResource, projectType: number): string {
@@ -235,18 +247,19 @@ function collectHighResolutionItemIds(
 	resources: ReturnType<Package['listResources']>,
 	publishedResourceIds: Set<string>,
 	includeHighResolution: number,
+	excludedResourceIds: Set<string>,
 ): Map<string, Array<string | null>> {
 	const result = new Map<string, Array<string | null>>();
 	if (includeHighResolution <= 0) return result;
 
 	const highResolutionResourceByKey = new Map<string, ImageResource | MovieClipResource>();
 	for (const resource of resources) {
-		if (!isHighResolutionResource(resource)) continue;
+		if (!isHighResolutionResource(resource) || excludedResourceIds.has(resource.getId())) continue;
 		highResolutionResourceByKey.set(buildHighResolutionResourceKey(resource), resource);
 	}
 
 	for (const resource of resources) {
-		if (!isHighResolutionResource(resource)) continue;
+		if (!isHighResolutionResource(resource) || excludedResourceIds.has(resource.getId())) continue;
 		if (!publishedResourceIds.has(resource.getId())) continue;
 		if (isHighResolutionVariantName(resource.getName())) continue;
 
@@ -290,6 +303,7 @@ function collectPackagePublishContext(
 	},
 ): PackagePublishContext {
 	const resources = pkg.listResources();
+	const excludedResourceIds = new Set(pkg.getSourceAtlasSettings().excludedResourceIds);
 	const resourceMap = new Map(resources.map((resource) => [resource.getId(), resource]));
 	const referencedIds = collectPackageResourceReferences(pkg).localResourceIds;
 	const pixelHitTestImageIds = new Set<string>();
@@ -304,10 +318,15 @@ function collectPackagePublishContext(
 		while (changed) {
 			changed = false;
 			for (const resourceId of [...exportedResourceIds]) {
+				if (excludedResourceIds.has(resourceId)) {
+					exportedResourceIds.delete(resourceId);
+					changed = true;
+					continue;
+				}
 				const resource = resourcesById.get(resourceId);
 				if (!resource || !isSkeletonResource(resource)) continue;
 				for (const requiredId of resource.getRequireIds()) {
-					if (!requiredId || exportedResourceIds.has(requiredId)) continue;
+					if (!requiredId || excludedResourceIds.has(requiredId) || exportedResourceIds.has(requiredId)) continue;
 					exportedResourceIds.add(requiredId);
 					changed = true;
 				}
@@ -318,7 +337,7 @@ function collectPackagePublishContext(
 
 	for (const atlas of pkg.listAtlases()) {
 		for (const sprite of atlas.listSprites()) {
-			spriteItemIds.add(sprite.getItemId());
+			if (!excludedResourceIds.has(sprite.getItemId())) spriteItemIds.add(sprite.getItemId());
 		}
 	}
 
@@ -331,8 +350,8 @@ function collectPackagePublishContext(
 		const hitTest = component.getHitTest?.()?.trim();
 		if (hitTest && !hitTest.includes(',')) {
 			const targetChild = childMap.get(hitTest);
-			const sourceId = targetChild?.getSrc?.();
-			if (sourceId) {
+		const sourceId = (targetChild as { getSrc?(): string } | undefined)?.getSrc?.();
+			if (sourceId && !excludedResourceIds.has(sourceId)) {
 				const sourceResource = resourceMap.get(sourceId);
 				if (sourceResource && isImageResource(sourceResource)) {
 					pixelHitTestImageIds.add(sourceId);
@@ -344,7 +363,7 @@ function collectPackagePublishContext(
 	const publishedResourceIds = new Set<string>(spriteItemIds);
 	for (const resource of resources) {
 		const resourceId = resource.getId();
-		if (!resourceId) continue;
+		if (!resourceId || excludedResourceIds.has(resourceId)) continue;
 		if (isComponentResource(resource)) {
 			if (resource.getExported() || referencedIds.has(resourceId)) {
 				publishedResourceIds.add(resourceId);
@@ -390,6 +409,7 @@ function collectPackagePublishContext(
 		resources,
 		publishedResourceIds,
 		options.includeHighResolution,
+		excludedResourceIds,
 	);
 
 	if (!options.includeBranches) {
@@ -576,6 +596,10 @@ export async function annotatePackagePublishArtifacts(
 			setPublishedFileExtra(resource, resolvePublishedMiscFileName(resource, options.projectType));
 			continue;
 		}
+		if (isSwfResource(resource)) {
+			setPublishedFileExtra(resource, resolvePublishedSwfFileName(resource));
+			continue;
+		}
 		if (isSkeletonResource(resource)) {
 			setPublishedFileExtra(resource, resolvePublishedSkeletonFileName(resource, options.projectType));
 		}

package/src/publish/resource-references.ts

@@ -3,7 +3,9 @@ import type { HasOptionalFont } from '../shared-types.js';
 
 interface ReferenceItem {
 	icon?: string | null;
+	selectedIcon?: string | null;
 	url?: string | null;
+	propertyOverrides?: Array<{ value: string }>;
 }
 
 interface ReferenceGear {
@@ -24,6 +26,7 @@ interface ReferenceChild extends HasOptionalFont {
 	getPackageId?(): string;
 	getSrc?(): string;
 	getUrl?(): string;
+	getClearOnPublish?(): boolean;
 	getInstanceSound?(): string;
 	getDefaultItem?(): string;
 	getIcon?(): string;
@@ -31,6 +34,7 @@ interface ReferenceChild extends HasOptionalFont {
 	getDropdown?(): string;
 	getSound?(): string;
 	getText?(): string;
+	getAutoClearText?(): boolean;
 	getInstanceIcon?(): string;
 	getInstanceSelectedIcon?(): string;
 	getVtScrollBarRes?(): string;
@@ -38,7 +42,10 @@ interface ReferenceChild extends HasOptionalFont {
 	getHeaderRes?(): string;
 	getFooterRes?(): string;
 	getInstanceComboItems?(): Array<{ icon: string | null }>;
+	getInstanceAutoClearItems?(): boolean;
 	getListItems?(): ReferenceItem[];
+	getAutoClearItems?(): boolean;
+	getPropertyOverrides?(): Array<{ value: string }>;
 	listGears?(): ReferenceGear[];
 }
 
@@ -130,7 +137,7 @@ function collectComponentReferences(
 	ownerPackageId: string,
 	component: Component,
 ): void {
-	const referenceComponent = component as Component & ReferenceComponent;
+	const referenceComponent = component as unknown as ReferenceComponent;
 	for (const child of referenceComponent.listChildren()) {
 		const sourceId = child.getSrc?.();
 		if (sourceId) {
@@ -141,9 +148,9 @@ function collectComponentReferences(
 		if (sourcePackageId && sourcePackageId !== ownerPackageId) target.packageIds.add(sourcePackageId);
 
 		addFontReferences(target, ownerPackageId, child.getFont?.());
-		addTextReferences(target, ownerPackageId, child.getText?.());
+		if (!child.getAutoClearText?.()) addTextReferences(target, ownerPackageId, child.getText?.());
 		for (const reference of [
-			child.getUrl?.(),
+			child.getClearOnPublish?.() ? undefined : child.getUrl?.(),
 			child.getDefaultItem?.(),
 			child.getIcon?.(),
 			child.getSelectedIcon?.(),
@@ -159,13 +166,20 @@ function collectComponentReferences(
 		]) {
 			addUiReference(target, ownerPackageId, reference);
 		}
-		for (const item of child.getInstanceComboItems?.() ?? []) {
+		for (const item of child.getInstanceAutoClearItems?.() ? [] : (child.getInstanceComboItems?.() ?? [])) {
 			addUiReference(target, ownerPackageId, item.icon);
 		}
-		for (const item of child.getListItems?.() ?? []) {
+		for (const item of child.getAutoClearItems?.() ? [] : (child.getListItems?.() ?? [])) {
 			addUiReference(target, ownerPackageId, item.icon);
+			addUiReference(target, ownerPackageId, item.selectedIcon);
 			addUiReference(target, ownerPackageId, item.url);
+			addUnknownReferences(target, ownerPackageId, item.propertyOverrides?.map((property) => property.value));
 		}
+		addUnknownReferences(
+			target,
+			ownerPackageId,
+			child.getPropertyOverrides?.().map((property) => property.value),
+		);
 		for (const gear of child.listGears?.() ?? []) {
 			addUnknownReferences(target, ownerPackageId, gear.getValues?.());
 			addUnknownReferences(target, ownerPackageId, gear.getDefaultValue?.());
@@ -201,8 +215,9 @@ export function collectPackageResourceReferences(pkg: Package): PackageResourceR
 		localResourceIds: new Set<string>(),
 		packageIds: new Set<string>(),
 	};
+	const excludedResourceIds = new Set(pkg.getSourceAtlasSettings().excludedResourceIds);
 	for (const resource of pkg.listResources()) {
-		if (resource.propertyType === 'Component') {
+		if (resource.propertyType === 'Component' && !excludedResourceIds.has(resource.getId())) {
 			collectComponentReferences(references, pkg.getId(), resource);
 		}
 	}

package/src/publish.ts

@@ -5,6 +5,7 @@ import {
 	type FileSystem,
 	type MovieClipResource,
 	type Package,
+	ProjectType,
 	type Transform,
 } from '@openfairygui/core';
 import { atlas } from './atlas.js';
@@ -12,7 +13,7 @@ import { prepareMovieClipResource } from './atlas/inputs.js';
 import type { PreparedJtaData } from './atlas/jta.js';
 import { publishCodeGeneration, resolveProjectBasePath } from './codegen.js';
 import { dirname, isAbsolutePathLike, trimTrailingSlashes } from './path-utils.js';
-import { formatPluginError, type LoadedPlugin } from './plugins/types.js';
+import { formatPluginError, type LoadedPlugin, shouldAbortPluginFailure } from './plugins/types.js';
 import type { PublishFileSystem } from './publish/contracts.js';
 import {
 	annotatePackagePublishArtifacts,
@@ -74,7 +75,9 @@ async function runPublishPluginHook(
 		try {
 			await fn(doc, options);
 		} catch (error) {
-			logger.warn(`publish: Plugin "${plugin.name}" ${hook} failed: ${formatPluginError(error)}`);
+			const message = `publish: Plugin "${plugin.name}" ${hook} failed: ${formatPluginError(error)}`;
+			if (shouldAbortPluginFailure(plugin)) throw new Error(message);
+			logger.warn(message);
 		}
 	}
 }
@@ -194,6 +197,26 @@ export function publish(options: PublishOptions): Transform {
 				}
 			}
 			const publishName = pkg.getPublishName() || pkg.getName();
+			const sourceAtlas = pkg.getSourceAtlasSettings();
+			const usePackageAtlas = !sourceAtlas.useGlobal;
+			const atlas: ResolvedPublishAtlasOptions = {
+				...config.atlas,
+				maxSize: options.atlas?.maxSize ?? (usePackageAtlas ? sourceAtlas.maxSize : config.atlas.maxSize),
+				allowRotation: config.projectType === ProjectType.LayaBox
+					? false
+					: (options.atlas?.allowRotation ?? (usePackageAtlas ? sourceAtlas.allowRotation : config.atlas.allowRotation)),
+				powerOfTwo: options.atlas?.powerOfTwo
+					?? (usePackageAtlas ? sourceAtlas.sizeOption === 'pot' : config.atlas.powerOfTwo),
+				maxAtlasIndex: options.atlas?.maxAtlasIndex ?? sourceAtlas.maxIndex,
+				multipleOfFour: options.atlas?.multipleOfFour
+					?? (usePackageAtlas ? sourceAtlas.sizeOption === 'mof' : config.atlas.multipleOfFour),
+				square: options.atlas?.square ?? (usePackageAtlas ? sourceAtlas.forceSquare : config.atlas.square),
+				multiPage: options.atlas?.multiPage ?? (usePackageAtlas ? sourceAtlas.paging : config.atlas.multiPage),
+				extractAlpha: config.projectType === ProjectType.Unity && (
+					options.atlas?.extractAlpha
+					?? (usePackageAtlas || sourceAtlas.extractAlpha ? sourceAtlas.extractAlpha : config.atlas.extractAlpha)
+				),
+			};
 
 			return {
 				pkg,
@@ -206,7 +229,7 @@ export function publish(options: PublishOptions): Transform {
 				activeBranch: config.activeBranch,
 				includeHighResolution: config.includeHighResolution,
 				separatedAtlasForBranch: config.separatedAtlasForBranch,
-				atlas: config.atlas,
+				atlas,
 			};
 		};
 
@@ -255,7 +278,6 @@ export function publish(options: PublishOptions): Transform {
 			const atlasRuntimeOptions = resolvePublishAtlasRuntimeOptions(plan.fileExtension);
 			await atlas({
 				...plan.atlas,
-				...(options.atlas ?? {}),
 				separatedAtlasForBranch: plan.separatedAtlasForBranch,
 				encoder: options.encoder,
 				basePath: options.basePath,

package/src/utils.ts

@@ -13,7 +13,7 @@ export function createTransform(name: string, fn: Transform): Transform {
 	return fn;
 }
 
-export function parseTextureSetMode(value: string | null | undefined): TextureSetMode {
+export function parseTextureSetMode(value: string | null | undefined, maxAtlasIndex = 10): TextureSetMode {
 	const raw = value?.trim() ?? '';
 	if (!raw) {
 		return { kind: 'auto', raw: '' };
@@ -29,7 +29,7 @@ export function parseTextureSetMode(value: string | null | undefined): TextureSe
 	}
 	if (/^\d+$/.test(raw)) {
 		const pageIndex = Number(raw);
-		if (pageIndex >= 0 && pageIndex <= 10) {
+		if (pageIndex >= 0 && pageIndex <= maxAtlasIndex) {
 			return { kind: 'page', raw, pageIndex };
 		}
 	}