@openfairygui/functions 0.2.0-alpha.2 → 0.2.0-alpha.21

package/dist/restore-BeWaJNjR.d.cts

@@ -0,0 +1,288 @@
+import { l as PublishFileSystem, r as AtlasRasterBackend, t as AtlasOptions } from "./atlas-CHsu2Y8i.cjs";
+import { Component, Document, FileSystem, Package, ProjectSettings, PublishSettings, Transform } from "@openfairygui/core";
+
+//#region src/publish/options.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;
+  /**
+   * Raster backend for atlas image compositing.
+   * Required when a filesystem-backed publish has packable resources.
+   * Without a filesystem, publish remains an explicit layout-only transform.
+   */
+  encoder?: AtlasRasterBackend;
+  /**
+   * 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. Calling publish with a resolved output
+   * directory but no filesystem is rejected; omit output entirely for a
+   * layout-only transform.
+   */
+  fs?: PublishFileSystem;
+  /**
+   * Active branch name used when branchProcessing is "主干合并活跃分支".
+   * Empty or omitted means publishing the main branch.
+   */
+  branch?: string;
+  /**
+   * Publish hooks supplied by the host adapter.
+   *
+   * Node adapters load project plugins. Browser adapters pass an empty list.
+   */
+  plugins?: LoadedPlugin[];
+  /**
+   * Run generic code generation after runtime artifacts. Default: true.
+   */
+  codeGeneration?: boolean;
+}
+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;
+//#endregion
+//#region src/publish.d.ts
+/**
+ * Publishes a FairyGUI project.
+ *
+ * Orchestrates:
+ * 1. Atlas packing (MaxRects layout + optional raster compositing)
+ * 2. Per-package .fui binary serialization
+ * 3. File writing to the output directory
+ *
+ * This is the capability-injected core. Standard hosts should use
+ * `publishNode()` or `publishBrowser()` through their dedicated entries.
+ *
+ * ```ts
+ * import { NodeIO } from '@openfairygui/core/node';
+ * import { publishNode } from '@openfairygui/functions/node';
+ * const doc = await new NodeIO().readProject('./project.fairy');
+ *
+ * await publishNode({
+ *   document: doc,
+ *   output: './release/',
+ *   compressed: true,
+ *   assetsPath: './assets/',
+ *   fileExtension: 'bytes',
+ * });
+ * ```
+ */
+declare function publish(options: PublishOptions): 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;
+}
+//#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>;
+}
+interface LoadedPlugin {
+  name: string;
+  plugin: Plugin;
+}
+type PluginModule = Plugin & {
+  default?: 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>;
+  rename(from: string, to: string): 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
+export { ExtrasMap as A, ResolvedPublishOptions as B, MaybePromise as C, CliAtlasSettings as D, PluginModule as E, RootProjectSettings as F, publish as I, PublishOptions as L, HasOptionalSrc as M, HasOptionalUrl as N, CliCodeGenerationSettings as O, PublishDependency as P, ResolvePublishOptionsOverrides as R, LoadedPlugin as S, PluginManifest as T, resolvePublishOptions as V, encodeText as _, RestoreImageExtractor as a, CodeWriter as b, restore as c, CodegenMember as d, CodegenReferencedComponent as f, decodeText as g, buildCodegenClasses as h, RestoreImageExtractInput as i, HasOptionalFont as j, CliPublishSettings as k, AUTO_GENERATED_CODE_MARK as l, ResolvedPackageCodegenPlan as m, RestoreImageCropInput as n, RestoreOptions as o, PublishCodeGenerationOptions as p, RestoreImageCropper as r, RestoreResult as s, RestoreFileSystem as t, CodegenClass as u, publishCodeGeneration as v, Plugin as w, ICodeWriterConfig as x, resolvePackageCodegenPlan as y, ResolvedPublishAtlasOptions as z };