@pixerate/editor 0.231.0 → 0.232.0

package/dist/effects/errors.d.ts

@@ -1,5 +1,5 @@
 import type { SchemaValidationError } from '../tools/schema.js';
-export type EffectErrorCode = 'unknown_effect' | 'invalid_values' | 'unsupported' | 'disposed' | 'no_provider';
+export type EffectErrorCode = 'unknown_effect' | 'invalid_values' | 'unsupported' | 'disposed' | 'no_provider' | 'unknown_template';
 export declare const EFFECT_ERROR_CODES: readonly EffectErrorCode[];
 /**
  * Base of every effects error. Check `code` (or use `isEffectError`) rather than `instanceof`
@@ -14,6 +14,11 @@ export declare class EffectError extends Error {
 export declare class UnknownEffectError extends EffectError {
     constructor(effectId: string, providerName?: string);
 }
+/** No sequence template has this id. */
+export declare class UnknownTemplateError extends EffectError {
+    readonly templateId: string;
+    constructor(templateId: string, providerName?: string);
+}
 /** Control values do not match the effect's control schema (unknown control, wrong type, out of range). */
 export declare class EffectControlError extends EffectError {
     readonly details: readonly SchemaValidationError[];

package/dist/effects/fake-templates.d.cts

@@ -0,0 +1,17 @@
+/**
+ * The fake provider's sequence templates (`createFakeEffectProvider({ templates: true })`), built
+ * only from its own effects, and a small reference of how a provider fills one: `{{slot}}` in any
+ * string (a whole-string placeholder takes the typed value), and `{ slot }` subjects.
+ *
+ * - `fake.title-sequence`: a gradient behind a title with a lower-third bar, then a crossfade to
+ *   a second shot with a caption. Text, colour and number slots.
+ * - `fake.picture-reveal`: a tinted picture, then a crossfade to the picture with a logo over it.
+ *   An image slot with a default and one without (left for the host when not given).
+ */
+import type { EffectTemplateDescription, EffectTemplateOptions, EffectTemplateResult, EffectTemplateSearchOptions, EffectTemplateSummary, EffectTemplateValues } from './types.cjs';
+/** The template methods of the fake provider. */
+export declare function fakeTemplateMethods(): {
+    listTemplates: (options?: EffectTemplateSearchOptions) => EffectTemplateSummary[];
+    describeTemplate: (id: string) => EffectTemplateDescription;
+    instantiateTemplate(id: string, values?: EffectTemplateValues, options?: EffectTemplateOptions): EffectTemplateResult;
+};

package/dist/effects/fake-templates.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The fake provider's sequence templates (`createFakeEffectProvider({ templates: true })`), built
+ * only from its own effects, and a small reference of how a provider fills one: `{{slot}}` in any
+ * string (a whole-string placeholder takes the typed value), and `{ slot }` subjects.
+ *
+ * - `fake.title-sequence`: a gradient behind a title with a lower-third bar, then a crossfade to
+ *   a second shot with a caption. Text, colour and number slots.
+ * - `fake.picture-reveal`: a tinted picture, then a crossfade to the picture with a logo over it.
+ *   An image slot with a default and one without (left for the host when not given).
+ */
+import type { EffectTemplateDescription, EffectTemplateOptions, EffectTemplateResult, EffectTemplateSearchOptions, EffectTemplateSummary, EffectTemplateValues } from './types.js';
+/** The template methods of the fake provider. */
+export declare function fakeTemplateMethods(): {
+    listTemplates: (options?: EffectTemplateSearchOptions) => EffectTemplateSummary[];
+    describeTemplate: (id: string) => EffectTemplateDescription;
+    instantiateTemplate(id: string, values?: EffectTemplateValues, options?: EffectTemplateOptions): EffectTemplateResult;
+};

package/dist/effects/fake.d.cts

@@ -12,6 +12,9 @@
  *
  * 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).
+ *
+ * With `templates: true` it also has two sequence templates (see `fake-templates.ts`):
+ * `fake.title-sequence` and `fake.picture-reveal`.
  */
 import type { EffectProvider, EffectProviderCapabilities, EffectRenderRequest } from './types.cjs';
 export interface FakeEffectProviderOptions {
@@ -23,6 +26,8 @@ export interface FakeEffectProviderOptions {
     authoring?: boolean;
     /** Adds the camera moves and `cameraView` / `sampleCameraMove` (default false). */
     camera?: boolean;
+    /** Adds two sequence templates and `listTemplates` / `describeTemplate` / `instantiateTemplate` (default false). */
+    templates?: boolean;
 }
-/** A deterministic CPU effects provider with seven effects, and three camera moves on request (see the module comment). */
+/** A deterministic CPU effects provider with seven effects, and camera moves and templates on request (see the module comment). */
 export declare function createFakeEffectProvider(options?: FakeEffectProviderOptions): EffectProvider;

package/dist/effects/fake.d.ts

@@ -12,6 +12,9 @@
  *
  * 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).
+ *
+ * With `templates: true` it also has two sequence templates (see `fake-templates.ts`):
+ * `fake.title-sequence` and `fake.picture-reveal`.
  */
 import type { EffectProvider, EffectProviderCapabilities, EffectRenderRequest } from './types.js';
 export interface FakeEffectProviderOptions {
@@ -23,6 +26,8 @@ export interface FakeEffectProviderOptions {
     authoring?: boolean;
     /** Adds the camera moves and `cameraView` / `sampleCameraMove` (default false). */
     camera?: boolean;
+    /** Adds two sequence templates and `listTemplates` / `describeTemplate` / `instantiateTemplate` (default false). */
+    templates?: boolean;
 }
-/** A deterministic CPU effects provider with seven effects, and three camera moves on request (see the module comment). */
+/** A deterministic CPU effects provider with seven effects, and camera moves and templates on request (see the module comment). */
 export declare function createFakeEffectProvider(options?: FakeEffectProviderOptions): EffectProvider;