@pixerate/editor 0.223.9 → 0.224.1

package/dist/effects/fake.d.cts

@@ -9,6 +9,9 @@
  * - `crossfade` (transition)
  * - `fade-in` (motion, vector only)
  * - `badge` (a vector effect with its own picture: a disc that fades in; vector only)
+ *
+ * With `camera: true` it also has camera moves (no pixels): `glide` and `whip` (transitions; the
+ * whip cuts halfway) and `drift` (a hold that zooms in slowly).
  */
 import type { EffectProvider, EffectProviderCapabilities, EffectRenderRequest } from './types.cjs';
 export interface FakeEffectProviderOptions {
@@ -18,6 +21,8 @@ export interface FakeEffectProviderOptions {
     onRender?: (effectId: string, request: EffectRenderRequest) => void;
     /** Whether authoring is supported (default true). */
     authoring?: boolean;
+    /** Adds the camera moves and `cameraView` / `sampleCameraMove` (default false). */
+    camera?: boolean;
 }
-/** A deterministic CPU effects provider with six effects (see the module comment). */
+/** A deterministic CPU effects provider with seven effects, and three camera moves on request (see the module comment). */
 export declare function createFakeEffectProvider(options?: FakeEffectProviderOptions): EffectProvider;

package/dist/effects/fake.d.ts

@@ -9,6 +9,9 @@
  * - `crossfade` (transition)
  * - `fade-in` (motion, vector only)
  * - `badge` (a vector effect with its own picture: a disc that fades in; vector only)
+ *
+ * With `camera: true` it also has camera moves (no pixels): `glide` and `whip` (transitions; the
+ * whip cuts halfway) and `drift` (a hold that zooms in slowly).
  */
 import type { EffectProvider, EffectProviderCapabilities, EffectRenderRequest } from './types.js';
 export interface FakeEffectProviderOptions {
@@ -18,6 +21,8 @@ export interface FakeEffectProviderOptions {
     onRender?: (effectId: string, request: EffectRenderRequest) => void;
     /** Whether authoring is supported (default true). */
     authoring?: boolean;
+    /** Adds the camera moves and `cameraView` / `sampleCameraMove` (default false). */
+    camera?: boolean;
 }
-/** A deterministic CPU effects provider with six effects (see the module comment). */
+/** A deterministic CPU effects provider with seven effects, and three camera moves on request (see the module comment). */
 export declare function createFakeEffectProvider(options?: FakeEffectProviderOptions): EffectProvider;

package/dist/effects/helpers.d.cts

@@ -3,7 +3,7 @@
  * and a provider slot editors hold.
  */
 import { type SchemaValidationError } from '../tools/schema.cjs';
-import type { EffectDescription, EffectImageSource, EffectPixels, EffectProvider, EffectSearchOptions, EffectSummary, EffectValues } from './types.cjs';
+import type { CameraMoveSample, CameraMoveSampleRequest, CameraView, EffectDescription, EffectImageSource, EffectPixels, EffectProvider, EffectSearchOptions, EffectSummary, EffectUse, EffectValues } from './types.cjs';
 /** Problems with `values` against an effect's control schema (unknown controls, types, ranges). Partial values are fine. */
 export declare function effectValueErrors(description: Pick<EffectDescription, 'controls'>, values: unknown): SchemaValidationError[];
 /**
@@ -12,6 +12,12 @@ export declare function effectValueErrors(description: Pick<EffectDescription, '
  * it before saving values.
  */
 export declare function resolveEffectValues(description: Pick<EffectDescription, 'id' | 'controls' | 'defaults'>, values?: EffectValues): Record<string, EffectValues[string]>;
+/**
+ * Whether an editor offering `uses` should offer `e` (in a picker or an `effect` enum). Motion
+ * and camera effects draw no picture of their own, so they are offered only where `uses` names
+ * them (`motion`, `camera`); with no `uses`, every other effect is.
+ */
+export declare function effectOffered(e: Pick<EffectSummary, 'kind' | 'uses'>, uses?: readonly EffectUse[]): boolean;
 /** A tag as tags are compared: trimmed, lower case, spaces and underscores as single hyphens (`"Game Boy"` → `game-boy`). */
 export declare function normaliseEffectTag(tag: string): string;
 /** True when the effect carries every one of `tags` (compared with `normaliseEffectTag`). */
@@ -59,3 +65,20 @@ export declare class EffectsSlot {
     require(): EffectProvider;
     subscribe(listener: (provider: EffectProvider | null) => void): () => void;
 }
+/** True for a `CameraView` with a positive zoom and finite numbers throughout. */
+export declare function isCameraView(view: unknown): view is CameraView;
+/**
+ * Keys `view` (u 0–1 → view) at `fps` across `ms`, with the two keys of a cut at `cut` (0–1).
+ * Providers can implement `sampleCameraMove` with it; `sampleEffectCameraMove` falls back to it.
+ */
+export declare function sampleCameraViews(view: (u: number) => CameraView, options: {
+    ms: number;
+    fps: number;
+    cut?: number;
+}): CameraMoveSample;
+/**
+ * A camera move as keyframes: the provider's own `sampleCameraMove` when it has one, else its
+ * `cameraView` keyed per frame (with the move's `cut` from `describe`). Throws
+ * `EffectUnsupportedError` when the provider has no camera support.
+ */
+export declare function sampleEffectCameraMove(provider: EffectProvider, id: string, request: CameraMoveSampleRequest): Promise<CameraMoveSample>;

package/dist/effects/helpers.d.ts

@@ -3,7 +3,7 @@
  * and a provider slot editors hold.
  */
 import { type SchemaValidationError } from '../tools/schema.js';
-import type { EffectDescription, EffectImageSource, EffectPixels, EffectProvider, EffectSearchOptions, EffectSummary, EffectValues } from './types.js';
+import type { CameraMoveSample, CameraMoveSampleRequest, CameraView, EffectDescription, EffectImageSource, EffectPixels, EffectProvider, EffectSearchOptions, EffectSummary, EffectUse, EffectValues } from './types.js';
 /** Problems with `values` against an effect's control schema (unknown controls, types, ranges). Partial values are fine. */
 export declare function effectValueErrors(description: Pick<EffectDescription, 'controls'>, values: unknown): SchemaValidationError[];
 /**
@@ -12,6 +12,12 @@ export declare function effectValueErrors(description: Pick<EffectDescription, '
  * it before saving values.
  */
 export declare function resolveEffectValues(description: Pick<EffectDescription, 'id' | 'controls' | 'defaults'>, values?: EffectValues): Record<string, EffectValues[string]>;
+/**
+ * Whether an editor offering `uses` should offer `e` (in a picker or an `effect` enum). Motion
+ * and camera effects draw no picture of their own, so they are offered only where `uses` names
+ * them (`motion`, `camera`); with no `uses`, every other effect is.
+ */
+export declare function effectOffered(e: Pick<EffectSummary, 'kind' | 'uses'>, uses?: readonly EffectUse[]): boolean;
 /** A tag as tags are compared: trimmed, lower case, spaces and underscores as single hyphens (`"Game Boy"` → `game-boy`). */
 export declare function normaliseEffectTag(tag: string): string;
 /** True when the effect carries every one of `tags` (compared with `normaliseEffectTag`). */
@@ -59,3 +65,20 @@ export declare class EffectsSlot {
     require(): EffectProvider;
     subscribe(listener: (provider: EffectProvider | null) => void): () => void;
 }
+/** True for a `CameraView` with a positive zoom and finite numbers throughout. */
+export declare function isCameraView(view: unknown): view is CameraView;
+/**
+ * Keys `view` (u 0–1 → view) at `fps` across `ms`, with the two keys of a cut at `cut` (0–1).
+ * Providers can implement `sampleCameraMove` with it; `sampleEffectCameraMove` falls back to it.
+ */
+export declare function sampleCameraViews(view: (u: number) => CameraView, options: {
+    ms: number;
+    fps: number;
+    cut?: number;
+}): CameraMoveSample;
+/**
+ * A camera move as keyframes: the provider's own `sampleCameraMove` when it has one, else its
+ * `cameraView` keyed per frame (with the move's `cut` from `describe`). Throws
+ * `EffectUnsupportedError` when the provider has no camera support.
+ */
+export declare function sampleEffectCameraMove(provider: EffectProvider, id: string, request: CameraMoveSampleRequest): Promise<CameraMoveSample>;