@openfairygui/functions 0.2.0-alpha.11 → 0.2.0-alpha.13

package/dist/index.d.cts

@@ -1,5 +1,7 @@
+import { a as AtlasRasterInput, c as AtlasRasterResolvedBuffer, d as PublishSourceFileSystem, i as AtlasRasterCompositeInput, l as PublishFileSystem, n as atlas, o as AtlasRasterMetadata, r as AtlasRasterBackend, s as AtlasRasterPipeline, t as AtlasOptions, u as PublishOutputFileSystem } from "./atlas-CHsu2Y8i.cjs";
+import { A as ResolvedPublishAtlasOptions, C as HasOptionalFont, D as RootProjectSettings, E as PublishDependency, M as publish, N as resolvePublishOptions, O as PublishOptions, S as ExtrasMap, T as HasOptionalUrl, _ as PluginManifest, a as PublishCodeGenerationOptions, b as CliCodeGenerationSettings, c as decodeText, d as resolvePackageCodegenPlan, f as CodeWriter, g as Plugin, h as MaybePromise, i as CodegenReferencedComponent, j as ResolvedPublishOptions, k as ResolvePublishOptionsOverrides, l as encodeText, m as LoadedPlugin, n as CodegenClass, o as ResolvedPackageCodegenPlan, p as ICodeWriterConfig, r as CodegenMember, s as buildCodegenClasses, t as AUTO_GENERATED_CODE_MARK, u as publishCodeGeneration, v as PluginModule, w as HasOptionalSrc, x as CliPublishSettings, y as CliAtlasSettings } from "./codegen-C7PPZrB3.cjs";
 import { ApplyUamTransactionAppDiagnostic, ApplyUamTransactionAppError, ApplyUamTransactionAppInput, ApplyUamTransactionAppResult, applyUamTransactionApp } from "./uam-transaction.cjs";
-import { Component, Document, FileSystem, Package, ProjectSettings, PublishSettings, Transform } from "@openfairygui/core";
+import { Document, FileSystem, Transform } from "@openfairygui/core";
 
 //#region src/inspect.d.ts
 /**
@@ -166,341 +168,6 @@ interface RenameOptions {
  */
 declare function rename(options: RenameOptions): Transform;
 //#endregion
-//#region src/atlas.d.ts
-interface AtlasOptions {
-  /**
-   * Limit atlas generation to specific package names.
-   * When omitted, all packages are processed.
-   */
-  packages?: string[];
-  /**
-   * Sharp module instance, injected by the caller.
-   * Required for actual image compositing and trimImage.
-   *
-   * ```ts
-   * import sharp from 'sharp';
-   * await doc.transform(atlas({ encoder: sharp }));
-   * ```
-   */
-  encoder?: unknown;
-  /** Maximum atlas texture size (width and height). Default: 2048. */
-  maxSize?: number;
-  /** Whether to use the fast editor-compatible packing heuristics. Default: true. */
-  fast?: boolean;
-  /** Allow rotating sprites 90° for better packing. Default: true. */
-  allowRotation?: boolean;
-  /** Pixel padding between sprites. Default: 1. */
-  padding?: number;
-  /** Constrain atlas dimensions to powers of two. Default: false. */
-  powerOfTwo?: boolean;
-  /** Force square atlas (width === height). Default: false. */
-  square?: boolean;
-  /** Allow spilling into multiple atlas pages. Default: true. */
-  multiPage?: boolean;
-  /**
-   * Trim transparent pixels from image edges before packing.
-   * Requires encoder (sharp). Stores offset/originalSize in Sprite nodes.
-   * Default: false.
-   */
-  trimImage?: boolean;
-  /**
-   * Base path for reading source images. If not set, images must have
-   * their pixel data stored in extras._imageData as Uint8Array.
-   */
-  basePath?: string;
-  /**
-   * Output directory for generated atlas PNGs.
-   * Required when encoder is provided.
-   */
-  outputPath?: string;
-  /**
-   * Optional mkdir function to ensure output directory exists.
-   * If not provided, the outputPath directory must already exist.
-   */
-  mkdir?: (path: string) => Promise<void>;
-  /**
-   * Optional raw file reader for reading .jta MovieClip files.
-   * Required for MovieClip frame atlas packing.
-   */
-  readFileRaw?: (path: string) => Promise<Uint8Array>;
-  /**
-   * Keep original input order when MaxRects tie-break scores are equal.
-   * This is an internal publish detail used to mirror editor/CLI behavior.
-   */
-  preserveInputOrderOnTie?: boolean;
-  /**
-   * Internal publish detail used by Unity binary output:
-   * allow single untrimmed PNG image packages to bypass the packer and
-   * write atlas0 directly, matching the reference CLI behavior.
-   */
-  directSingleImageOutput?: boolean;
-  /**
-   * Internal publish detail used by the direct-image-output path.
-   * When extractAlpha is enabled, the direct output shortcut must be disabled.
-   */
-  extractAlpha?: boolean;
-  /**
-   * When branchProcessing keeps branch resources, publish branch images into
-   * separate atlas pages/files per branch instead of mixing them with main.
-   */
-  separatedAtlasForBranch?: boolean;
-}
-/**
- * Packs image resources into texture atlases.
- *
- * This transform performs MaxRects bin-packing on all ImageResource items
- * within each package, creating Atlas and Sprite property nodes. When an
- * `encoder` (sharp) is provided, it also composites the actual PNG files.
- *
- * When `trimImage` is enabled and encoder is available, transparent pixels
- * at image edges are trimmed before packing. The trimmed offset and original
- * dimensions are stored in the Sprite nodes for runtime reconstruction.
- *
- * ```ts
- * import sharp from 'sharp';
- * await doc.transform(atlas({
- *   encoder: sharp,
- *   maxSize: 2048,
- *   trimImage: true,
- *   basePath: './assets/',
- *   outputPath: './dist/',
- * }));
- * ```
- */
-declare function atlas(_options?: AtlasOptions): Transform;
-//#endregion
-//#region src/shared-types.d.ts
-type ExtrasMap = Record<string, unknown>;
-interface CliCodeGenerationSettings extends NonNullable<PublishSettings['codeGeneration']> {
-  allowGenCode?: boolean;
-  classNamePrefix?: string;
-  codePath?: string;
-  codeType?: string;
-  getMemberByName?: boolean;
-  ignoreNoname?: boolean;
-  memberNamePrefix?: string;
-  packageName?: string;
-}
-interface CliAtlasSettings extends NonNullable<PublishSettings['atlasSetting']> {
-  maxSize?: number;
-  paging?: boolean;
-  sizeOption?: string;
-  forceSquare?: boolean;
-  fast?: boolean;
-  allowRotation?: boolean;
-  padding?: number;
-  trimImage?: boolean;
-  extractAlpha?: boolean;
-}
-interface CliPublishSettings extends PublishSettings {
-  atlasSetting?: CliAtlasSettings;
-  codeGeneration?: CliCodeGenerationSettings;
-}
-type RootProjectSettings = ProjectSettings & {
-  publish?: CliPublishSettings;
-};
-interface PublishDependency {
-  id: string;
-  name: string;
-}
-interface HasOptionalFont {
-  getFont?(): string | string[] | null | undefined;
-}
-interface HasOptionalSrc {
-  getSrc?(): string | undefined;
-}
-interface HasOptionalUrl {
-  getUrl?(): string | undefined;
-}
-type PublishFileSystem = Pick<FileSystem, 'join' | 'mkdir' | 'writeFileRaw'> & {
-  deleteFile?: (path: string) => Promise<void>;
-  exists?: FileSystem['exists'];
-  readdir?: FileSystem['readdir'];
-  readFileRaw?: FileSystem['readFileRaw'];
-};
-//#endregion
-//#region src/publish.d.ts
-interface PublishOptions {
-  /**
-   * Output directory override for published files (.fui + atlas PNGs).
-   * When omitted, publish uses package-level or project-level publish paths.
-   */
-  output?: string;
-  /**
-   * Compress the binary data with zlib raw deflate. Default: false.
-   */
-  compressed?: boolean;
-  /**
-   * File extension for the binary output. Default: 'fui'.
-   * Unity projects typically use 'bytes'.
-   */
-  fileExtension?: string;
-  /**
-   * Sharp module instance for atlas image compositing.
-   * If not provided, atlas packing only computes layout (no PNGs generated).
-   */
-  encoder?: unknown;
-  /**
-   * Base path for reading source images (project assets root).
-   * Required when encoder is provided.
-   */
-  basePath?: string;
-  /**
-   * Atlas packing options.
-   */
-  atlas?: Omit<AtlasOptions, 'encoder' | 'basePath' | 'outputPath'>;
-  /**
-   * Filter which packages to publish by name. If not set, all packages are published.
-   */
-  packages?: string[];
-  /**
-   * FileSystem abstraction for writing output files.
-   * Required for actual file output. Without it, only the Document model
-   * is updated (atlas layout computed, sprite nodes created).
-   */
-  fs?: PublishFileSystem;
-  /**
-   * Active branch name used when branchProcessing is "主干合并活跃分支".
-   * Empty or omitted means publishing the main branch.
-   */
-  branch?: string;
-}
-interface ResolvedPublishAtlasOptions extends Pick<AtlasOptions, 'maxSize' | 'fast' | 'allowRotation' | 'padding' | 'powerOfTwo' | 'square' | 'multiPage' | 'trimImage' | 'extractAlpha'> {}
-interface ResolvePublishOptionsOverrides {
-  compressed?: boolean;
-  fileExtension?: string;
-  packages?: string[];
-  atlas?: Partial<ResolvedPublishAtlasOptions>;
-}
-interface ResolvedPublishOptions {
-  compressed: boolean;
-  fileExtension: string;
-  packages?: string[];
-  atlas: ResolvedPublishAtlasOptions;
-}
-/**
- * Resolve publish defaults from the document's project settings.
- *
- * This keeps the editor-aligned publish rules reusable across environments,
- * while callers still provide environment-specific concerns such as fs/encoder/basePath.
- */
-declare function resolvePublishOptions(doc: Document, overrides?: ResolvePublishOptionsOverrides): ResolvedPublishOptions;
-/**
- * Publishes a FairyGUI project.
- *
- * Orchestrates:
- * 1. Atlas packing (MaxRects layout + optional sharp compositing)
- * 2. Per-package .fui binary serialization
- * 3. File writing to the output directory
- *
- * ```ts
- * import sharp from 'sharp';
- * const io = new NodeIO();
- * const doc = await io.readProject('./project.fairy');
- *
- * await doc.transform(publish({
- *   output: './release/',
- *   compressed: true,
- *   encoder: sharp,
- *   basePath: './assets/',
- *   fileExtension: 'bytes',
- *   fs: io.createFileSystem(),
- * }));
- * ```
- */
-declare function publish(options: PublishOptions): Transform;
-//#endregion
-//#region src/plugins/types.d.ts
-type MaybePromise<T> = T | Promise<T>;
-interface PluginManifest {
-  name: string;
-  displayName?: string;
-  description?: string;
-  version?: string;
-  author?: {
-    name?: string;
-  };
-  icon?: string;
-  main: string;
-}
-interface ICodeWriterConfig {
-  blockStart?: string;
-  blockEnd?: string;
-  blockFromNewLine?: boolean;
-  usingTabs?: boolean;
-  endOfLine?: string;
-  fileMark?: string;
-}
-interface CodeWriter {
-  writeMark(): void;
-  writeln(fmt?: string, ...args: any[]): CodeWriter;
-  startBlock(): CodeWriter;
-  endBlock(): CodeWriter;
-  incIndent(): CodeWriter;
-  decIndent(): CodeWriter;
-  reset(): void;
-  toString(): string;
-  save(filePath: string): void;
-}
-interface Plugin {
-  genCode?: (doc: Document, settings: Required<CliCodeGenerationSettings>, options: PublishCodeGenerationOptions) => MaybePromise<void>;
-  onPublishStart?: (doc: Document, options: PublishOptions) => MaybePromise<void>;
-  onPublishEnd?: (doc: Document, options: PublishOptions) => MaybePromise<void>;
-}
-type PluginModule = Plugin & {
-  default?: Plugin;
-};
-//#endregion
-//#region src/plugins/loader.d.ts
-interface LoadedPlugin {
-  name: string;
-  plugin: Plugin;
-}
-//#endregion
-//#region src/codegen.d.ts
-declare const AUTO_GENERATED_CODE_MARK = "/** This is an automatically generated class by FairyGUI. Please do not modify it. **/";
-interface PublishCodeGenerationOptions {
-  basePath?: string;
-  fs: PublishFileSystem;
-  packages: Package[];
-  plugins?: LoadedPlugin[];
-}
-interface ResolvedPackageCodegenPlan {
-  outputDir: string;
-  packageFolderName: string;
-  packageNamespace: string;
-  binderClassName: string;
-  settings: CliCodeGenerationSettings;
-}
-interface CodegenMember {
-  index: number;
-  kind: 'child' | 'controller' | 'transition';
-  name: string;
-  originalName: string;
-  type: string;
-  ignored: boolean;
-  referencedComponent?: CodegenReferencedComponent;
-}
-interface CodegenReferencedComponent {
-  component: Component;
-  package: Package;
-}
-interface CodegenClass {
-  classId: string;
-  className: string;
-  encodedClassName: string;
-  componentType: string;
-  componentName: string;
-  packageName: string;
-  url: string;
-  members: CodegenMember[];
-}
-declare function publishCodeGeneration(doc: Document, options: PublishCodeGenerationOptions): Promise<void>;
-declare function resolvePackageCodegenPlan(pkg: Package, settings: CliCodeGenerationSettings, options: PublishCodeGenerationOptions): ResolvedPackageCodegenPlan | null;
-declare function buildCodegenClasses(doc: Document, pkg: Package, plan: ResolvedPackageCodegenPlan): CodegenClass[];
-declare function encodeText(value: string): Uint8Array;
-declare function decodeText(value: Uint8Array): string;
-//#endregion
 //#region src/restore.d.ts
 interface RestoreImageCropInput {
   sourcePath: string;
@@ -550,4 +217,4 @@ declare function restore(options: RestoreOptions): Promise<RestoreResult>;
  */
 declare function createTransform(name: string, fn: Transform): Transform;
 //#endregion
-export { AUTO_GENERATED_CODE_MARK, type ApplyUamTransactionAppDiagnostic, type ApplyUamTransactionAppError, type ApplyUamTransactionAppInput, type ApplyUamTransactionAppResult, type AtlasOptions, type CliAtlasSettings, type CliCodeGenerationSettings, type CliPublishSettings, type CodeWriter, type CodegenClass, type CodegenMember, type CodegenReferencedComponent, type ExtrasMap, type HasOptionalFont, type HasOptionalSrc, type HasOptionalUrl, type ICodeWriterConfig, type InspectCategoryReport, type InspectReport, type MaybePromise, type Plugin, type PluginManifest, type PluginModule, type PruneOptions, type PublishCodeGenerationOptions, type PublishDependency, type PublishFileSystem, type PublishOptions, type RenameOptions, type ResolvePublishOptionsOverrides, type ResolvedPackageCodegenPlan, type ResolvedPublishAtlasOptions, type ResolvedPublishOptions, type RestoreFileSystem, type RestoreImageCropInput, type RestoreImageCropper, type RestoreImageExtractInput, type RestoreImageExtractor, type RestoreOptions, type RestoreResult, type RootProjectSettings, type ValidateOptions, type ValidationIssue, type ValidationResult, ValidationSeverity, applyUamTransactionApp, atlas, buildCodegenClasses, createTransform, decodeText, encodeText, inspect, prune, publish, publishCodeGeneration, rename, resolvePackageCodegenPlan, resolvePublishOptions, restore, validate };
+export { AUTO_GENERATED_CODE_MARK, type ApplyUamTransactionAppDiagnostic, type ApplyUamTransactionAppError, type ApplyUamTransactionAppInput, type ApplyUamTransactionAppResult, type AtlasOptions, type AtlasRasterBackend, type AtlasRasterCompositeInput, type AtlasRasterInput, type AtlasRasterMetadata, type AtlasRasterPipeline, type AtlasRasterResolvedBuffer, type CliAtlasSettings, type CliCodeGenerationSettings, type CliPublishSettings, type CodeWriter, type CodegenClass, type CodegenMember, type CodegenReferencedComponent, type ExtrasMap, type HasOptionalFont, type HasOptionalSrc, type HasOptionalUrl, type ICodeWriterConfig, type InspectCategoryReport, type InspectReport, type LoadedPlugin, type MaybePromise, type Plugin, type PluginManifest, type PluginModule, type PruneOptions, type PublishCodeGenerationOptions, type PublishDependency, type PublishFileSystem, type PublishOptions, type PublishOutputFileSystem, type PublishSourceFileSystem, type RenameOptions, type ResolvePublishOptionsOverrides, type ResolvedPackageCodegenPlan, type ResolvedPublishAtlasOptions, type ResolvedPublishOptions, type RestoreFileSystem, type RestoreImageCropInput, type RestoreImageCropper, type RestoreImageExtractInput, type RestoreImageExtractor, type RestoreOptions, type RestoreResult, type RootProjectSettings, type ValidateOptions, type ValidationIssue, type ValidationResult, ValidationSeverity, applyUamTransactionApp, atlas, buildCodegenClasses, createTransform, decodeText, encodeText, inspect, prune, publish, publishCodeGeneration, rename, resolvePackageCodegenPlan, resolvePublishOptions, restore, validate };