@openfairygui/functions 0.1.0 → 0.1.1

package/src/index.ts

@@ -1,9 +1,19 @@
-export { inspect, type InspectReport, type InspectCategoryReport } from './inspect.js';
-export { validate, type ValidateOptions, type ValidationResult, type ValidationIssue, ValidationSeverity } from './validate.js';
-export { prune, type PruneOptions } from './prune.js';
+export { inspect, type InspectReport, type InspectCategoryReport } from './inspect.js';
+export { validate, type ValidateOptions, type ValidationResult, type ValidationIssue, ValidationSeverity } from './validate.js';
+export { prune, type PruneOptions } from './prune.js';
 export { rename, type RenameOptions } from './rename.js';
 export { atlas, type AtlasOptions } from './atlas.js';
 export { publishCodeGeneration, AUTO_GENERATED_CODE_MARK, type PublishCodeGenerationOptions } from './codegen.js';
+export {
+	restore,
+	type RestoreFileSystem,
+	type RestoreImageCropInput,
+	type RestoreImageCropper,
+	type RestoreImageExtractInput,
+	type RestoreImageExtractor,
+	type RestoreOptions,
+	type RestoreResult,
+} from './restore.js';
 export {
 	publish,
 	resolvePublishOptions,

package/src/inspect.ts

@@ -1,50 +1,50 @@
 import type { Document, Package } from '@openfairygui/core';
-
-/**
- * Summary report for a single resource category.
- */
-export interface InspectCategoryReport {
-	count: number;
-	details: Array<{ name: string; id: string; path?: string; exported?: boolean }>;
-}
-
-/**
- * Full inspection report for a FairyGUI project.
- */
+
+/**
+ * Summary report for a single resource category.
+ */
+export interface InspectCategoryReport {
+	count: number;
+	details: Array<{ name: string; id: string; path?: string; exported?: boolean }>;
+}
+
+/**
+ * Full inspection report for a FairyGUI project.
+ */
 export interface InspectReport {
-	projectId: string;
-	projectType: number;
-	version: string;
-	packages: Array<{
-		name: string;
-		id: string;
-		publishName: string;
-		resources: {
-			images: InspectCategoryReport;
-			sounds: InspectCategoryReport;
-			fonts: InspectCategoryReport;
-			movieClips: InspectCategoryReport;
-			components: InspectCategoryReport;
-		};
-		componentDetails: Array<{
-			name: string;
-			id: string;
-			childCount: number;
-			controllerCount: number;
-			transitionCount: number;
-		}>;
-	}>;
-	totals: {
-		packages: number;
-		images: number;
-		sounds: number;
-		fonts: number;
-		movieClips: number;
-		components: number;
-		displayObjects: number;
-		gears: number;
-		controllers: number;
-		transitions: number;
+	projectId: string;
+	projectType: number;
+	version: string;
+	packages: Array<{
+		name: string;
+		id: string;
+		publishName: string;
+		resources: {
+			images: InspectCategoryReport;
+			sounds: InspectCategoryReport;
+			fonts: InspectCategoryReport;
+			movieClips: InspectCategoryReport;
+			components: InspectCategoryReport;
+		};
+		componentDetails: Array<{
+			name: string;
+			id: string;
+			childCount: number;
+			controllerCount: number;
+			transitionCount: number;
+		}>;
+	}>;
+	totals: {
+		packages: number;
+		images: number;
+		sounds: number;
+		fonts: number;
+		movieClips: number;
+		components: number;
+		displayObjects: number;
+		gears: number;
+		controllers: number;
+		transitions: number;
 	};
 }
 
@@ -84,38 +84,38 @@ function mapComponentDetail(
 		transitionCount: transitions.length,
 	};
 }
-
-/**
- * Generates a detailed report of the project contents.
- *
- * Unlike other transforms, `inspect()` does NOT modify the document —
- * it returns a structured report.
- *
- * ```ts
- * const report = inspect(doc);
- * console.log(`${report.totals.packages} packages, ${report.totals.components} components`);
- * ```
- */
-export function inspect(doc: Document): InspectReport {
-	const root = doc.getRoot();
-	const totals = {
-		packages: 0, images: 0, sounds: 0, fonts: 0,
-		movieClips: 0, components: 0, displayObjects: 0,
-		gears: 0, controllers: 0, transitions: 0,
-	};
-
-	const packages = root.listPackages().map((pkg) => {
-		totals.packages++;
-		const resources = pkg.listResources();
-
-		const images = resources.filter((r) => r.propertyType === 'ImageResource');
-		const sounds = resources.filter((r) => r.propertyType === 'SoundResource');
-		const fonts = resources.filter((r) => r.propertyType === 'FontResource');
-		const movieClips = resources.filter((r) => r.propertyType === 'MovieClipResource');
-		const components = pkg.listComponents();
-
-		totals.images += images.length;
-		totals.sounds += sounds.length;
+
+/**
+ * Generates a detailed report of the project contents.
+ *
+ * Unlike other transforms, `inspect()` does NOT modify the document —
+ * it returns a structured report.
+ *
+ * ```ts
+ * const report = inspect(doc);
+ * console.log(`${report.totals.packages} packages, ${report.totals.components} components`);
+ * ```
+ */
+export function inspect(doc: Document): InspectReport {
+	const root = doc.getRoot();
+	const totals = {
+		packages: 0, images: 0, sounds: 0, fonts: 0,
+		movieClips: 0, components: 0, displayObjects: 0,
+		gears: 0, controllers: 0, transitions: 0,
+	};
+
+	const packages = root.listPackages().map((pkg) => {
+		totals.packages++;
+		const resources = pkg.listResources();
+
+		const images = resources.filter((r) => r.propertyType === 'ImageResource');
+		const sounds = resources.filter((r) => r.propertyType === 'SoundResource');
+		const fonts = resources.filter((r) => r.propertyType === 'FontResource');
+		const movieClips = resources.filter((r) => r.propertyType === 'MovieClipResource');
+		const components = pkg.listComponents();
+
+		totals.images += images.length;
+		totals.sounds += sounds.length;
 		totals.fonts += fonts.length;
 		totals.movieClips += movieClips.length;
 		totals.components += components.length;
@@ -123,24 +123,24 @@ export function inspect(doc: Document): InspectReport {
 
 		return {
 			name: pkg.getName(),
-			id: pkg.getId(),
-			publishName: pkg.getPublishName() || pkg.getName(),
-			resources: {
-				images: { count: images.length, details: images.map(mapResource) },
-				sounds: { count: sounds.length, details: sounds.map(mapResource) },
-				fonts: { count: fonts.length, details: fonts.map(mapResource) },
-				movieClips: { count: movieClips.length, details: movieClips.map(mapResource) },
-				components: { count: components.length, details: components.map(mapResource) },
-			},
-			componentDetails,
-		};
-	});
-
-	return {
-		projectId: root.getProjectId(),
-		projectType: root.getProjectType(),
-		version: root.getVersion(),
-		packages,
-		totals,
-	};
-}
+			id: pkg.getId(),
+			publishName: pkg.getPublishName() || pkg.getName(),
+			resources: {
+				images: { count: images.length, details: images.map(mapResource) },
+				sounds: { count: sounds.length, details: sounds.map(mapResource) },
+				fonts: { count: fonts.length, details: fonts.map(mapResource) },
+				movieClips: { count: movieClips.length, details: movieClips.map(mapResource) },
+				components: { count: components.length, details: components.map(mapResource) },
+			},
+			componentDetails,
+		};
+	});
+
+	return {
+		projectId: root.getProjectId(),
+		projectType: root.getProjectType(),
+		version: root.getVersion(),
+		packages,
+		totals,
+	};
+}

package/src/rename.ts

@@ -1,66 +1,66 @@
-import type { Document, Transform } from '@openfairygui/core';
-import { createTransform } from './utils.js';
-
-export interface RenameOptions {
-	/** Package name to rename from. Required. */
-	packageName: string;
-	/** Resource name to rename from. Required. */
-	resourceName: string;
-	/** New name for the resource. Required. */
-	newName: string;
-	/** If true, also update all `ui://` references pointing to this resource. Default: true. */
-	updateReferences?: boolean;
-}
-
-/**
- * Renames a resource and optionally updates all references to it.
- *
- * This searches all display objects' `src` attributes across all packages
- * for `ui://` URLs that point to the renamed resource, and updates them
- * to reflect the new name (the resource ID doesn't change, so references
- * are already valid — but the name stored in package.xml is updated).
- *
- * ```ts
- * await doc.transform(rename({
- *   packageName: 'Basics',
- *   resourceName: 'Button',
- *   newName: 'PrimaryButton',
- * }));
- * ```
- */
-export function rename(options: RenameOptions): Transform {
-	const updateReferences = options.updateReferences ?? true;
-
-	return createTransform('rename', (doc: Document): void => {
-		const root = doc.getRoot();
-		const logger = doc.getLogger();
-		const pkg = root.listPackages().find((p) => p.getName() === options.packageName);
-
-		if (!pkg) {
-			logger.warn(`rename: Package "${options.packageName}" not found.`);
-			return;
-		}
-
-		// Find the resource
-		const resource = pkg.listResources().find((r) => r.getName() === options.resourceName)
-			|| pkg.listComponents().find((c) => c.getName() === options.resourceName);
-
-		if (!resource) {
-			logger.warn(`rename: Resource "${options.resourceName}" not found in package "${options.packageName}".`);
-			return;
-		}
-
-		const oldName = resource.getName();
-		resource.setName(options.newName);
-		logger.info(`rename: Renamed "${oldName}" → "${options.newName}" in package "${options.packageName}".`);
-
-		// If this is a component resource, we don't need to update src references
-		// because src references use resource IDs (not names)
-		if (updateReferences) {
-			// Resource IDs are stable, so ui:// references don't need updating
-			// unless the consumer relies on name-based lookups.
-			// The primary rename is the resource name itself.
-			logger.info(`rename: References use resource IDs — no src updates needed.`);
-		}
-	});
-}
+import type { Document, Transform } from '@openfairygui/core';
+import { createTransform } from './utils.js';
+
+export interface RenameOptions {
+	/** Package name to rename from. Required. */
+	packageName: string;
+	/** Resource name to rename from. Required. */
+	resourceName: string;
+	/** New name for the resource. Required. */
+	newName: string;
+	/** If true, also update all `ui://` references pointing to this resource. Default: true. */
+	updateReferences?: boolean;
+}
+
+/**
+ * Renames a resource and optionally updates all references to it.
+ *
+ * This searches all display objects' `src` attributes across all packages
+ * for `ui://` URLs that point to the renamed resource, and updates them
+ * to reflect the new name (the resource ID doesn't change, so references
+ * are already valid — but the name stored in package.xml is updated).
+ *
+ * ```ts
+ * await doc.transform(rename({
+ *   packageName: 'Basics',
+ *   resourceName: 'Button',
+ *   newName: 'PrimaryButton',
+ * }));
+ * ```
+ */
+export function rename(options: RenameOptions): Transform {
+	const updateReferences = options.updateReferences ?? true;
+
+	return createTransform('rename', (doc: Document): void => {
+		const root = doc.getRoot();
+		const logger = doc.getLogger();
+		const pkg = root.listPackages().find((p) => p.getName() === options.packageName);
+
+		if (!pkg) {
+			logger.warn(`rename: Package "${options.packageName}" not found.`);
+			return;
+		}
+
+		// Find the resource
+		const resource = pkg.listResources().find((r) => r.getName() === options.resourceName)
+			|| pkg.listComponents().find((c) => c.getName() === options.resourceName);
+
+		if (!resource) {
+			logger.warn(`rename: Resource "${options.resourceName}" not found in package "${options.packageName}".`);
+			return;
+		}
+
+		const oldName = resource.getName();
+		resource.setName(options.newName);
+		logger.info(`rename: Renamed "${oldName}" → "${options.newName}" in package "${options.packageName}".`);
+
+		// If this is a component resource, we don't need to update src references
+		// because src references use resource IDs (not names)
+		if (updateReferences) {
+			// Resource IDs are stable, so ui:// references don't need updating
+			// unless the consumer relies on name-based lookups.
+			// The primary rename is the resource name itself.
+			logger.info(`rename: References use resource IDs — no src updates needed.`);
+		}
+	});
+}