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

package/dist/index.d.cts

@@ -1,4 +1,5 @@
-import { Document, FileSystem, Package, ProjectSettings, PublishSettings, Transform, UamProject, UamTransactionErrorCode, UamTransactionOperation, UamTransactionSupportIssue, UamValidationIssue } from "@openfairygui/core";
+import { ApplyUamTransactionAppDiagnostic, ApplyUamTransactionAppError, ApplyUamTransactionAppInput, ApplyUamTransactionAppResult, applyUamTransactionApp } from "./uam-transaction.cjs";
+import { Component, Document, FileSystem, Package, ProjectSettings, PublishSettings, Transform } from "@openfairygui/core";
 
 //#region src/inspect.d.ts
 /**
@@ -167,6 +168,11 @@ 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.
@@ -313,65 +319,13 @@ type PublishFileSystem = Pick<FileSystem, 'join' | 'mkdir' | 'writeFileRaw'> & {
   readFileRaw?: FileSystem['readFileRaw'];
 };
 //#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[];
-}
-declare function publishCodeGeneration(doc: Document, options: PublishCodeGenerationOptions): Promise<void>;
-//#endregion
-//#region src/restore.d.ts
-interface RestoreImageCropInput {
-  sourcePath: string;
-  outputPath: string;
-  left: number;
-  top: number;
-  width: number;
-  height: number;
-  rotated: boolean;
-  offsetX: number;
-  offsetY: number;
-  expectedWidth: number;
-  expectedHeight: number;
-}
-type RestoreImageCropper = (input: RestoreImageCropInput) => Promise<void>;
-type RestoreImageExtractInput = Omit<RestoreImageCropInput, 'outputPath'>;
-type RestoreImageExtractor = (input: RestoreImageExtractInput) => Promise<Uint8Array>;
-interface RestoreResult {
-  document: Document;
-  projectPath: string;
-  warnings: string[];
-}
-interface RestoreFileSystem extends Pick<FileSystem, 'readFile' | 'readFileRaw' | 'writeFile' | 'writeFileRaw' | 'mkdir' | 'exists' | 'join' | 'dirname'> {
-  readdir(path: string): Promise<string[]>;
-  isFile(path: string): Promise<boolean>;
-  resolvePath(path: string): string | Promise<string>;
-  rm?: (path: string, options?: {
-    recursive?: boolean;
-    force?: boolean;
-  }) => Promise<void>;
-}
-interface RestoreOptions {
-  inputDir: string;
-  output: string;
-  fs: RestoreFileSystem;
-  packages?: string[];
-  force?: boolean;
-  projectType?: number;
-  cropImage?: RestoreImageCropper;
-  extractImage?: RestoreImageExtractor;
-}
-declare function restore(options: RestoreOptions): Promise<RestoreResult>;
-//#endregion
 //#region src/publish.d.ts
 interface PublishOptions {
   /**
-   * Output directory for published files (.fui + atlas PNGs).
-   * Required.
+   * Output directory override for published files (.fui + atlas PNGs).
+   * When omitted, publish uses package-level or project-level publish paths.
    */
-  output: string;
+  output?: string;
   /**
    * Compress the binary data with zlib raw deflate. Default: false.
    */
@@ -456,29 +410,139 @@ declare function resolvePublishOptions(doc: Document, overrides?: ResolvePublish
  */
 declare function publish(options: PublishOptions): Transform;
 //#endregion
-//#region src/uam-transaction.d.ts
-interface ApplyUamTransactionAppInput {
-  project: UamProject;
-  operations: UamTransactionOperation[];
-}
-interface ApplyUamTransactionAppError {
-  code: UamTransactionErrorCode;
-  stage: 'preflight' | 'execution' | 'postflight';
-  message: string;
-  opIndex?: number;
-  opId?: string;
-  opKind?: UamTransactionOperation['kind'];
-  selector?: Record<string, unknown>;
-  issues?: UamValidationIssue[] | UamTransactionSupportIssue[];
-}
-type ApplyUamTransactionAppResult = {
-  ok: true;
-  project: UamProject;
-} | {
-  ok: false;
-  error: ApplyUamTransactionAppError;
+//#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;
 };
-declare function applyUamTransactionApp(input: ApplyUamTransactionAppInput): ApplyUamTransactionAppResult;
+//#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;
+  outputPath: string;
+  left: number;
+  top: number;
+  width: number;
+  height: number;
+  rotated: boolean;
+  offsetX: number;
+  offsetY: number;
+  expectedWidth: number;
+  expectedHeight: number;
+}
+type RestoreImageCropper = (input: RestoreImageCropInput) => Promise<void>;
+type RestoreImageExtractInput = Omit<RestoreImageCropInput, 'outputPath'>;
+type RestoreImageExtractor = (input: RestoreImageExtractInput) => Promise<Uint8Array>;
+interface RestoreResult {
+  document: Document;
+  projectPath: string;
+  warnings: string[];
+}
+interface RestoreFileSystem extends Pick<FileSystem, 'readFile' | 'readFileRaw' | 'writeFile' | 'writeFileRaw' | 'mkdir' | 'exists' | 'join' | 'dirname'> {
+  readdir(path: string): Promise<string[]>;
+  isFile(path: string): Promise<boolean>;
+  resolvePath(path: string): string | Promise<string>;
+  rm?: (path: string, options?: {
+    recursive?: boolean;
+    force?: boolean;
+  }) => Promise<void>;
+}
+interface RestoreOptions {
+  inputDir: string;
+  output: string;
+  fs: RestoreFileSystem;
+  packages?: string[];
+  force?: boolean;
+  projectType?: number;
+  cropImage?: RestoreImageCropper;
+  extractImage?: RestoreImageExtractor;
+}
+declare function restore(options: RestoreOptions): Promise<RestoreResult>;
 //#endregion
 //#region src/utils.d.ts
 /**
@@ -486,4 +550,4 @@ declare function applyUamTransactionApp(input: ApplyUamTransactionAppInput): App
  */
 declare function createTransform(name: string, fn: Transform): Transform;
 //#endregion
-export { AUTO_GENERATED_CODE_MARK, type ApplyUamTransactionAppError, type ApplyUamTransactionAppInput, type ApplyUamTransactionAppResult, type AtlasOptions, type CliAtlasSettings, type CliPublishSettings, type ExtrasMap, type HasOptionalFont, type HasOptionalSrc, type HasOptionalUrl, type InspectCategoryReport, type InspectReport, type PruneOptions, type PublishCodeGenerationOptions, type PublishDependency, type PublishFileSystem, type PublishOptions, type RenameOptions, type ResolvePublishOptionsOverrides, 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, createTransform, inspect, prune, publish, publishCodeGeneration, rename, resolvePublishOptions, restore, validate };
+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 };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { Document, FileSystem, Package, ProjectSettings, PublishSettings, Transform, UamProject, UamTransactionErrorCode, UamTransactionOperation, UamTransactionSupportIssue, UamValidationIssue } from "@openfairygui/core";
+import { ApplyUamTransactionAppDiagnostic, ApplyUamTransactionAppError, ApplyUamTransactionAppInput, ApplyUamTransactionAppResult, applyUamTransactionApp } from "./uam-transaction.js";
+import { Component, Document, FileSystem, Package, ProjectSettings, PublishSettings, Transform } from "@openfairygui/core";
 
 //#region src/inspect.d.ts
 /**
@@ -167,6 +168,11 @@ 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.
@@ -313,65 +319,13 @@ type PublishFileSystem = Pick<FileSystem, 'join' | 'mkdir' | 'writeFileRaw'> & {
   readFileRaw?: FileSystem['readFileRaw'];
 };
 //#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[];
-}
-declare function publishCodeGeneration(doc: Document, options: PublishCodeGenerationOptions): Promise<void>;
-//#endregion
-//#region src/restore.d.ts
-interface RestoreImageCropInput {
-  sourcePath: string;
-  outputPath: string;
-  left: number;
-  top: number;
-  width: number;
-  height: number;
-  rotated: boolean;
-  offsetX: number;
-  offsetY: number;
-  expectedWidth: number;
-  expectedHeight: number;
-}
-type RestoreImageCropper = (input: RestoreImageCropInput) => Promise<void>;
-type RestoreImageExtractInput = Omit<RestoreImageCropInput, 'outputPath'>;
-type RestoreImageExtractor = (input: RestoreImageExtractInput) => Promise<Uint8Array>;
-interface RestoreResult {
-  document: Document;
-  projectPath: string;
-  warnings: string[];
-}
-interface RestoreFileSystem extends Pick<FileSystem, 'readFile' | 'readFileRaw' | 'writeFile' | 'writeFileRaw' | 'mkdir' | 'exists' | 'join' | 'dirname'> {
-  readdir(path: string): Promise<string[]>;
-  isFile(path: string): Promise<boolean>;
-  resolvePath(path: string): string | Promise<string>;
-  rm?: (path: string, options?: {
-    recursive?: boolean;
-    force?: boolean;
-  }) => Promise<void>;
-}
-interface RestoreOptions {
-  inputDir: string;
-  output: string;
-  fs: RestoreFileSystem;
-  packages?: string[];
-  force?: boolean;
-  projectType?: number;
-  cropImage?: RestoreImageCropper;
-  extractImage?: RestoreImageExtractor;
-}
-declare function restore(options: RestoreOptions): Promise<RestoreResult>;
-//#endregion
 //#region src/publish.d.ts
 interface PublishOptions {
   /**
-   * Output directory for published files (.fui + atlas PNGs).
-   * Required.
+   * Output directory override for published files (.fui + atlas PNGs).
+   * When omitted, publish uses package-level or project-level publish paths.
    */
-  output: string;
+  output?: string;
   /**
    * Compress the binary data with zlib raw deflate. Default: false.
    */
@@ -456,29 +410,139 @@ declare function resolvePublishOptions(doc: Document, overrides?: ResolvePublish
  */
 declare function publish(options: PublishOptions): Transform;
 //#endregion
-//#region src/uam-transaction.d.ts
-interface ApplyUamTransactionAppInput {
-  project: UamProject;
-  operations: UamTransactionOperation[];
-}
-interface ApplyUamTransactionAppError {
-  code: UamTransactionErrorCode;
-  stage: 'preflight' | 'execution' | 'postflight';
-  message: string;
-  opIndex?: number;
-  opId?: string;
-  opKind?: UamTransactionOperation['kind'];
-  selector?: Record<string, unknown>;
-  issues?: UamValidationIssue[] | UamTransactionSupportIssue[];
-}
-type ApplyUamTransactionAppResult = {
-  ok: true;
-  project: UamProject;
-} | {
-  ok: false;
-  error: ApplyUamTransactionAppError;
+//#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;
 };
-declare function applyUamTransactionApp(input: ApplyUamTransactionAppInput): ApplyUamTransactionAppResult;
+//#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;
+  outputPath: string;
+  left: number;
+  top: number;
+  width: number;
+  height: number;
+  rotated: boolean;
+  offsetX: number;
+  offsetY: number;
+  expectedWidth: number;
+  expectedHeight: number;
+}
+type RestoreImageCropper = (input: RestoreImageCropInput) => Promise<void>;
+type RestoreImageExtractInput = Omit<RestoreImageCropInput, 'outputPath'>;
+type RestoreImageExtractor = (input: RestoreImageExtractInput) => Promise<Uint8Array>;
+interface RestoreResult {
+  document: Document;
+  projectPath: string;
+  warnings: string[];
+}
+interface RestoreFileSystem extends Pick<FileSystem, 'readFile' | 'readFileRaw' | 'writeFile' | 'writeFileRaw' | 'mkdir' | 'exists' | 'join' | 'dirname'> {
+  readdir(path: string): Promise<string[]>;
+  isFile(path: string): Promise<boolean>;
+  resolvePath(path: string): string | Promise<string>;
+  rm?: (path: string, options?: {
+    recursive?: boolean;
+    force?: boolean;
+  }) => Promise<void>;
+}
+interface RestoreOptions {
+  inputDir: string;
+  output: string;
+  fs: RestoreFileSystem;
+  packages?: string[];
+  force?: boolean;
+  projectType?: number;
+  cropImage?: RestoreImageCropper;
+  extractImage?: RestoreImageExtractor;
+}
+declare function restore(options: RestoreOptions): Promise<RestoreResult>;
 //#endregion
 //#region src/utils.d.ts
 /**
@@ -486,4 +550,4 @@ declare function applyUamTransactionApp(input: ApplyUamTransactionAppInput): App
  */
 declare function createTransform(name: string, fn: Transform): Transform;
 //#endregion
-export { AUTO_GENERATED_CODE_MARK, type ApplyUamTransactionAppError, type ApplyUamTransactionAppInput, type ApplyUamTransactionAppResult, type AtlasOptions, type CliAtlasSettings, type CliPublishSettings, type ExtrasMap, type HasOptionalFont, type HasOptionalSrc, type HasOptionalUrl, type InspectCategoryReport, type InspectReport, type PruneOptions, type PublishCodeGenerationOptions, type PublishDependency, type PublishFileSystem, type PublishOptions, type RenameOptions, type ResolvePublishOptionsOverrides, 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, createTransform, inspect, prune, publish, publishCodeGeneration, rename, resolvePublishOptions, restore, validate };
+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 };