@pixerate/editor-react 0.15.0 → 0.17.0

package/dist/generation/index.d.cts

@@ -0,0 +1,124 @@
+import { GenerationRequest, ModelCapabilities, PlanOptions, GenerationPlan, JobProgressEstimate, PlanStrategy, ReferenceRole, GenerationReference, AssetInfo, AssetRoleOption, AssetMentionChip, GenerationRecord, RecreateOptions, AssetLookup, RecreateMode, RecreateResult, GenerationRecordStore, GenerationRecordFilter } from '@pixerate/editor/generation';
+import React__default from 'react';
+
+/**
+ * Plans `request` against `capabilities` (see `planGenerationRequest`) and
+ * returns the adjusted request, adjustments and errors. Recomputed only when
+ * the request, capabilities or options change by value, so inline objects are fine.
+ */
+declare function useGenerationPlan(request: GenerationRequest, capabilities: ModelCapabilities, options?: PlanOptions): GenerationPlan;
+interface UseJobProgressOptions {
+    startedAt: number | Date | string;
+    expectedMs?: number;
+    done?: boolean;
+    /** Fixed current time (disables ticking; useful for SSR and tests). */
+    now?: number | Date | string;
+    /** Re-render interval while running in ms (default 1000). */
+    intervalMs?: number;
+}
+/** Ticking `estimateJobProgress` for a running job; stops ticking when `done`. */
+declare function useJobProgress(options: UseJobProgressOptions): JobProgressEstimate;
+
+interface GenerationSettingsProps {
+    capabilities: ModelCapabilities;
+    /** The request being edited (controlled). */
+    value: GenerationRequest;
+    onChange: (next: GenerationRequest) => void;
+    /** A plan computed elsewhere; otherwise one is computed with `strategy`. */
+    plan?: GenerationPlan;
+    /** Strategy for the built-in plan (default `nearest`). */
+    strategy?: PlanStrategy;
+    /** List plan adjustments and errors under the controls (default `true`). */
+    showAdjustments?: boolean;
+    /** Shows an "Add" button per reference role; you pick the asset and call `onChange`. */
+    onAddReference?: (role: ReferenceRole) => void;
+    /** Custom rendering of a reference chip (default: its id). */
+    renderReference?: (reference: GenerationReference) => React__default.ReactNode;
+    className?: string;
+}
+/**
+ * Headless-styled settings form generated from a model's capabilities:
+ * selects for choices, sliders/number inputs for ranges, text areas for
+ * negative/system prompts, checkboxes for boolean params, reference slots by
+ * role, and the plan's adjustments and errors. Controlled via `value` / `onChange`.
+ */
+declare const GenerationSettings: React__default.FC<GenerationSettingsProps>;
+
+interface JobProgressProps extends UseJobProgressOptions {
+    /** Text shown before the time label, e.g. the model name. */
+    title?: string;
+    /** Extra classes for the root. */
+    className?: string;
+}
+/**
+ * Headless-styled progress bar for a generation job that reports no progress
+ * of its own: time-based percent (held at 95% until `done`) with a
+ * "~2m left" / "Almost done…" label. Exposes `role="progressbar"`.
+ */
+declare const JobProgress: React__default.FC<JobProgressProps>;
+
+interface AssetMentionChipsProps {
+    /** Prompt text containing `@asset` / `@asset:role` mentions. */
+    content: string;
+    /** Called with the text after a role is picked (`@fox` → `@fox:style_ref`). */
+    onChange: (next: string) => void;
+    /** Mentionable assets; mentions that match none (by id or label) are not shown. */
+    assets: readonly AssetInfo[];
+    /** The selected model: its roles are offered and mentions are checked against it. */
+    capabilities?: ModelCapabilities;
+    /** Role options (default: the model's roles, else the built-in roles). */
+    roles?: readonly AssetRoleOption[];
+    /** Custom chip content (default: the asset label). */
+    renderAsset?: (chip: AssetMentionChip) => React__default.ReactNode;
+    className?: string;
+}
+/**
+ * The asset mentions of a prompt as chips with role badges. Clicking a chip
+ * opens a role picker popover; picking a role rewrites the mention's `:role`
+ * suffix in the text. Chips with problems for the model (unsupported role,
+ * wrong media type, too many for the role) are flagged.
+ */
+declare const AssetMentionChips: React__default.FC<AssetMentionChipsProps>;
+
+type Template = NonNullable<RecreateOptions['templates']>[number];
+interface UseGenerationRecordsResult {
+    records: GenerationRecord[];
+    loading: boolean;
+    error: unknown;
+    refresh: () => Promise<void>;
+}
+/**
+ * Loads records from a `GenerationRecordStore` (newest first) and reloads
+ * whenever the store changes. `filter` is compared by value.
+ */
+declare function useGenerationRecords(store: GenerationRecordStore | null | undefined, filter?: GenerationRecordFilter): UseGenerationRecordsResult;
+interface GenerationHistoryProps {
+    records: readonly GenerationRecord[];
+    /** Current templates (drift detection, and resolution in `latest` mode). */
+    templates?: readonly Template[];
+    /** Current models (capability drift and re-planning). */
+    capabilities?: ModelCapabilities | readonly ModelCapabilities[];
+    /** Current assets (missing / changed asset drift). */
+    assets?: AssetLookup;
+    /** Recreate mode (controlled); otherwise a toggle starting at `exact`. */
+    mode?: RecreateMode;
+    onModeChange?: (mode: RecreateMode) => void;
+    /** "Recreate": receives the rebuilt request and drift report. */
+    onRecreate?: (result: RecreateResult, record: GenerationRecord) => void;
+    /** "Variation": same request with a new seed. */
+    onVariation?: (result: RecreateResult, record: GenerationRecord) => void;
+    onRemove?: (record: GenerationRecord) => void;
+    /** Extra content per record (e.g. output thumbnails). */
+    renderPreview?: (record: GenerationRecord) => React__default.ReactNode;
+    emptyText?: string;
+    className?: string;
+}
+/**
+ * Generation history: one entry per record with its model, prompt, asset
+ * role badges and the drift since it was made (templates edited, model
+ * capabilities changed, settings no longer supported, assets missing), plus
+ * Recreate and Variation buttons. Recreate is disabled when drift blocks it.
+ */
+declare const GenerationHistory: React__default.FC<GenerationHistoryProps>;
+
+export { AssetMentionChips, type AssetMentionChipsProps, GenerationHistory, type GenerationHistoryProps, GenerationSettings, type GenerationSettingsProps, JobProgress, type JobProgressProps, type UseGenerationRecordsResult, type UseJobProgressOptions, useGenerationPlan, useGenerationRecords, useJobProgress };

package/dist/generation/index.d.ts

@@ -0,0 +1,124 @@
+import { GenerationRequest, ModelCapabilities, PlanOptions, GenerationPlan, JobProgressEstimate, PlanStrategy, ReferenceRole, GenerationReference, AssetInfo, AssetRoleOption, AssetMentionChip, GenerationRecord, RecreateOptions, AssetLookup, RecreateMode, RecreateResult, GenerationRecordStore, GenerationRecordFilter } from '@pixerate/editor/generation';
+import React__default from 'react';
+
+/**
+ * Plans `request` against `capabilities` (see `planGenerationRequest`) and
+ * returns the adjusted request, adjustments and errors. Recomputed only when
+ * the request, capabilities or options change by value, so inline objects are fine.
+ */
+declare function useGenerationPlan(request: GenerationRequest, capabilities: ModelCapabilities, options?: PlanOptions): GenerationPlan;
+interface UseJobProgressOptions {
+    startedAt: number | Date | string;
+    expectedMs?: number;
+    done?: boolean;
+    /** Fixed current time (disables ticking; useful for SSR and tests). */
+    now?: number | Date | string;
+    /** Re-render interval while running in ms (default 1000). */
+    intervalMs?: number;
+}
+/** Ticking `estimateJobProgress` for a running job; stops ticking when `done`. */
+declare function useJobProgress(options: UseJobProgressOptions): JobProgressEstimate;
+
+interface GenerationSettingsProps {
+    capabilities: ModelCapabilities;
+    /** The request being edited (controlled). */
+    value: GenerationRequest;
+    onChange: (next: GenerationRequest) => void;
+    /** A plan computed elsewhere; otherwise one is computed with `strategy`. */
+    plan?: GenerationPlan;
+    /** Strategy for the built-in plan (default `nearest`). */
+    strategy?: PlanStrategy;
+    /** List plan adjustments and errors under the controls (default `true`). */
+    showAdjustments?: boolean;
+    /** Shows an "Add" button per reference role; you pick the asset and call `onChange`. */
+    onAddReference?: (role: ReferenceRole) => void;
+    /** Custom rendering of a reference chip (default: its id). */
+    renderReference?: (reference: GenerationReference) => React__default.ReactNode;
+    className?: string;
+}
+/**
+ * Headless-styled settings form generated from a model's capabilities:
+ * selects for choices, sliders/number inputs for ranges, text areas for
+ * negative/system prompts, checkboxes for boolean params, reference slots by
+ * role, and the plan's adjustments and errors. Controlled via `value` / `onChange`.
+ */
+declare const GenerationSettings: React__default.FC<GenerationSettingsProps>;
+
+interface JobProgressProps extends UseJobProgressOptions {
+    /** Text shown before the time label, e.g. the model name. */
+    title?: string;
+    /** Extra classes for the root. */
+    className?: string;
+}
+/**
+ * Headless-styled progress bar for a generation job that reports no progress
+ * of its own: time-based percent (held at 95% until `done`) with a
+ * "~2m left" / "Almost done…" label. Exposes `role="progressbar"`.
+ */
+declare const JobProgress: React__default.FC<JobProgressProps>;
+
+interface AssetMentionChipsProps {
+    /** Prompt text containing `@asset` / `@asset:role` mentions. */
+    content: string;
+    /** Called with the text after a role is picked (`@fox` → `@fox:style_ref`). */
+    onChange: (next: string) => void;
+    /** Mentionable assets; mentions that match none (by id or label) are not shown. */
+    assets: readonly AssetInfo[];
+    /** The selected model: its roles are offered and mentions are checked against it. */
+    capabilities?: ModelCapabilities;
+    /** Role options (default: the model's roles, else the built-in roles). */
+    roles?: readonly AssetRoleOption[];
+    /** Custom chip content (default: the asset label). */
+    renderAsset?: (chip: AssetMentionChip) => React__default.ReactNode;
+    className?: string;
+}
+/**
+ * The asset mentions of a prompt as chips with role badges. Clicking a chip
+ * opens a role picker popover; picking a role rewrites the mention's `:role`
+ * suffix in the text. Chips with problems for the model (unsupported role,
+ * wrong media type, too many for the role) are flagged.
+ */
+declare const AssetMentionChips: React__default.FC<AssetMentionChipsProps>;
+
+type Template = NonNullable<RecreateOptions['templates']>[number];
+interface UseGenerationRecordsResult {
+    records: GenerationRecord[];
+    loading: boolean;
+    error: unknown;
+    refresh: () => Promise<void>;
+}
+/**
+ * Loads records from a `GenerationRecordStore` (newest first) and reloads
+ * whenever the store changes. `filter` is compared by value.
+ */
+declare function useGenerationRecords(store: GenerationRecordStore | null | undefined, filter?: GenerationRecordFilter): UseGenerationRecordsResult;
+interface GenerationHistoryProps {
+    records: readonly GenerationRecord[];
+    /** Current templates (drift detection, and resolution in `latest` mode). */
+    templates?: readonly Template[];
+    /** Current models (capability drift and re-planning). */
+    capabilities?: ModelCapabilities | readonly ModelCapabilities[];
+    /** Current assets (missing / changed asset drift). */
+    assets?: AssetLookup;
+    /** Recreate mode (controlled); otherwise a toggle starting at `exact`. */
+    mode?: RecreateMode;
+    onModeChange?: (mode: RecreateMode) => void;
+    /** "Recreate": receives the rebuilt request and drift report. */
+    onRecreate?: (result: RecreateResult, record: GenerationRecord) => void;
+    /** "Variation": same request with a new seed. */
+    onVariation?: (result: RecreateResult, record: GenerationRecord) => void;
+    onRemove?: (record: GenerationRecord) => void;
+    /** Extra content per record (e.g. output thumbnails). */
+    renderPreview?: (record: GenerationRecord) => React__default.ReactNode;
+    emptyText?: string;
+    className?: string;
+}
+/**
+ * Generation history: one entry per record with its model, prompt, asset
+ * role badges and the drift since it was made (templates edited, model
+ * capabilities changed, settings no longer supported, assets missing), plus
+ * Recreate and Variation buttons. Recreate is disabled when drift blocks it.
+ */
+declare const GenerationHistory: React__default.FC<GenerationHistoryProps>;
+
+export { AssetMentionChips, type AssetMentionChipsProps, GenerationHistory, type GenerationHistoryProps, GenerationSettings, type GenerationSettingsProps, JobProgress, type JobProgressProps, type UseGenerationRecordsResult, type UseJobProgressOptions, useGenerationPlan, useGenerationRecords, useJobProgress };

package/dist/generation/index.js

@@ -0,0 +1,19 @@
+import {
+  AssetMentionChips,
+  GenerationHistory,
+  GenerationSettings,
+  JobProgress,
+  useGenerationPlan,
+  useGenerationRecords,
+  useJobProgress
+} from "../chunk-I3E4KSA2.js";
+export {
+  AssetMentionChips,
+  GenerationHistory,
+  GenerationSettings,
+  JobProgress,
+  useGenerationPlan,
+  useGenerationRecords,
+  useJobProgress
+};
+//# sourceMappingURL=index.js.map

package/dist/generation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}