@pixerate/editor 0.233.0 → 0.235.0

package/dist/effects/index.cjs

@@ -24,7 +24,11 @@ var _chunkA7PQNIBXcjs = require('../chunk-A7PQNIBX.cjs');
 
 
 
-var _chunk6RZVFYGJcjs = require('../chunk-6RZVFYGJ.cjs');
+
+
+
+
+var _chunkJWCKJNDRcjs = require('../chunk-JWCKJNDR.cjs');
 
 
 var _chunkPY4GWSE2cjs = require('../chunk-PY4GWSE2.cjs');
@@ -223,14 +227,14 @@ function checkSlot(templateId, slot, issues) {
   if (!slot || typeof slot.name !== "string" || !/^[A-Za-z][\w-]*$/.test(slot.name)) return at('needs a name of letters, digits, "-" and "_", starting with a letter');
   if (!_chunkJAOSL334cjs.EFFECT_TEMPLATE_SLOT_TYPES.includes(slot.type)) return at(`type "${slot.type}" is not one of ${_chunkJAOSL334cjs.EFFECT_TEMPLATE_SLOT_TYPES.join(", ")}`);
   if (typeof slot.label !== "string" || !slot.label) at("needs a label");
-  if (_chunk6RZVFYGJcjs.isSubjectTemplateSlot.call(void 0, slot)) {
+  if (_chunkJWCKJNDRcjs.isSubjectTemplateSlot.call(void 0, slot)) {
     if (typeof slot.hasDefault !== "boolean") at("a subject slot needs hasDefault (a boolean)");
     if ("default" in slot) at("a subject slot describes hasDefault, not its default");
     return;
   }
   const fallback = slot.default;
   if (fallback === void 0) return at("needs a default");
-  const problem = _chunk6RZVFYGJcjs.templateValueProblem.call(void 0, slot, fallback);
+  const problem = _chunkJWCKJNDRcjs.templateValueProblem.call(void 0, slot, fallback);
   if (problem) at(`its default does not fit: ${problem}`);
   if (slot.type === "number" && slot.min !== void 0 && slot.max !== void 0 && slot.min > slot.max) at("min is above max");
 }
@@ -276,11 +280,11 @@ async function checkTemplates(provider, list, issues) {
       const result = await provider.instantiateTemplate(id);
       if (!result.ok) at(`instantiateTemplate with the defaults failed: ${result.errors.join(" ")}`);
       else {
-        for (const p of _chunk6RZVFYGJcjs.checkEffectSequence.call(void 0, result.sequence, list)) at(`with the defaults, ${p}`);
+        for (const p of _chunkJWCKJNDRcjs.checkEffectSequence.call(void 0, result.sequence, list)) at(`with the defaults, ${p}`);
         if (_optionalChain([result, 'access', _15 => _15.sequence, 'optionalAccess', _16 => _16.shots, 'optionalAccess', _17 => _17.length]) !== summary.shots) at(`listTemplates says ${summary.shots} shots; the sequence has ${_optionalChain([result, 'access', _18 => _18.sequence, 'optionalAccess', _19 => _19.shots, 'optionalAccess', _20 => _20.length])}`);
         if (!Array.isArray(result.openSlots) || !Array.isArray(result.notes)) at("instantiateTemplate needs openSlots and notes lists");
         else {
-          const open = Array.isArray(_optionalChain([result, 'access', _21 => _21.sequence, 'optionalAccess', _22 => _22.shots])) ? _chunk6RZVFYGJcjs.effectSequenceSlots.call(void 0, result.sequence) : [];
+          const open = Array.isArray(_optionalChain([result, 'access', _21 => _21.sequence, 'optionalAccess', _22 => _22.shots])) ? _chunkJWCKJNDRcjs.effectSequenceSlots.call(void 0, result.sequence) : [];
           if (open.some((s) => !result.openSlots.includes(s))) at(`openSlots ${JSON.stringify(result.openSlots)} misses slots the sequence leaves open (${open.join(", ")})`);
         }
       }
@@ -498,7 +502,7 @@ function fill(t, values) {
   const slots = new Map(t.slots.map((s) => [s.name, s]));
   const valueOf = (name) => {
     const s = slots.get(name);
-    return _nullishCoalesce(values[name], () => ( (_chunk6RZVFYGJcjs.isSubjectTemplateSlot.call(void 0, s) ? s.subjectDefault : s.default)));
+    return _nullishCoalesce(values[name], () => ( (_chunkJWCKJNDRcjs.isSubjectTemplateSlot.call(void 0, s) ? s.subjectDefault : s.default)));
   };
   const walk = (v, key) => {
     if (typeof v === "string") {
@@ -525,16 +529,16 @@ function fakeTemplateMethods() {
     return t;
   };
   return {
-    listTemplates: (options) => _chunk6RZVFYGJcjs.searchTemplateSummaries.call(void 0, TEMPLATES.map((t) => t.summary), options).map((s) => structuredClone(s)),
+    listTemplates: (options) => _chunkJWCKJNDRcjs.searchTemplateSummaries.call(void 0, TEMPLATES.map((t) => t.summary), options).map((s) => structuredClone(s)),
     describeTemplate: (id) => structuredClone(describeOf(get(id))),
     instantiateTemplate(id, values = {}, options = {}) {
       const t = get(id);
-      const errors = _chunk6RZVFYGJcjs.checkTemplateValues.call(void 0, describeOf(t).slots, values);
-      if (options.name !== void 0 && (typeof options.name !== "string" || !_chunk6RZVFYGJcjs.EFFECT_SEQUENCE_NAME.test(options.name))) errors.push(`The sequence name is lowercase words and dashes (like "${t.summary.id.replace(/^fake\./, "")}").`);
+      const errors = _chunkJWCKJNDRcjs.checkTemplateValues.call(void 0, describeOf(t).slots, values);
+      if (options.name !== void 0 && (typeof options.name !== "string" || !_chunkJWCKJNDRcjs.EFFECT_SEQUENCE_NAME.test(options.name))) errors.push(`The sequence name is lowercase words and dashes (like "${t.summary.id.replace(/^fake\./, "")}").`);
       if (errors.length) return { ok: false, errors };
       const sequence = fill(t, values);
       if (options.name) sequence.name = options.name;
-      return { ok: true, sequence, openSlots: _chunk6RZVFYGJcjs.effectSequenceSlots.call(void 0, sequence), notes: [] };
+      return { ok: true, sequence, openSlots: _chunkJWCKJNDRcjs.effectSequenceSlots.call(void 0, sequence), notes: [] };
     }
   };
 }
@@ -1607,4 +1611,8 @@ function createEffectAuthoringToolProvider(host, options) {
 
 
 
-exports.CAMERA_MOVE_MAX_MS = _chunkJAOSL334cjs.CAMERA_MOVE_MAX_MS; exports.CAMERA_MOVE_ROLES = _chunkJAOSL334cjs.CAMERA_MOVE_ROLES; exports.EFFECT_ERROR_CODES = _chunkJAOSL334cjs.EFFECT_ERROR_CODES; exports.EFFECT_KINDS = _chunkJAOSL334cjs.EFFECT_KINDS; exports.EFFECT_LAYER_ROLES = _chunkJAOSL334cjs.EFFECT_LAYER_ROLES; exports.EFFECT_LAYER_USES = _chunk6RZVFYGJcjs.EFFECT_LAYER_USES; exports.EFFECT_SEQUENCE_NAME = _chunk6RZVFYGJcjs.EFFECT_SEQUENCE_NAME; exports.EFFECT_SUBJECT_KINDS = _chunkJAOSL334cjs.EFFECT_SUBJECT_KINDS; exports.EFFECT_TEMPLATE_SLOT_TYPES = _chunkJAOSL334cjs.EFFECT_TEMPLATE_SLOT_TYPES; exports.EFFECT_TRANSITION_MS = _chunkJAOSL334cjs.EFFECT_TRANSITION_MS; exports.EFFECT_USES = _chunkJAOSL334cjs.EFFECT_USES; exports.EFFECT_USE_LABELS = EFFECT_USE_LABELS; exports.EffectControlError = _chunkJAOSL334cjs.EffectControlError; exports.EffectDisposedError = _chunkJAOSL334cjs.EffectDisposedError; exports.EffectError = _chunkJAOSL334cjs.EffectError; exports.EffectRendererPool = _chunkPY4GWSE2cjs.EffectRendererPool; exports.EffectUnsupportedError = _chunkJAOSL334cjs.EffectUnsupportedError; exports.EffectsSlot = _chunkJAOSL334cjs.EffectsSlot; exports.NoEffectsProviderError = _chunkJAOSL334cjs.NoEffectsProviderError; exports.UnknownEffectError = _chunkJAOSL334cjs.UnknownEffectError; exports.UnknownTemplateError = _chunkJAOSL334cjs.UnknownTemplateError; exports.applyEffectMask = _chunkJAOSL334cjs.applyEffectMask; exports.cameraBoxOfView = _chunkJAOSL334cjs.cameraBoxOfView; exports.cameraMoveField = _chunkJAOSL334cjs.cameraMoveField; exports.cameraMoveIdList = _chunkJAOSL334cjs.cameraMoveIdList; exports.cameraMoveParts = _chunkJAOSL334cjs.cameraMoveParts; exports.cameraMovesFor = _chunkJAOSL334cjs.cameraMovesFor; exports.cameraViewOfBox = _chunkJAOSL334cjs.cameraViewOfBox; exports.checkEffectProvider = checkEffectProvider; exports.checkEffectSequence = _chunk6RZVFYGJcjs.checkEffectSequence; exports.checkTemplateValues = _chunk6RZVFYGJcjs.checkTemplateValues; exports.countEffectTags = _chunkJAOSL334cjs.countEffectTags; exports.createEffectAuthoringSession = _chunkA7PQNIBXcjs.createEffectAuthoringSession; exports.createEffectAuthoringToolProvider = createEffectAuthoringToolProvider; exports.createEffectPixels = _chunkJAOSL334cjs.createEffectPixels; exports.createEffectToolProvider = _chunkJAOSL334cjs.createEffectToolProvider; exports.createFakeEffectProvider = createFakeEffectProvider; exports.effectControlField = effectControlField; exports.effectFieldValue = effectFieldValue; exports.effectFontFamilies = effectFontFamilies; exports.effectLayerInput = _chunk6RZVFYGJcjs.effectLayerInput; exports.effectLayerOffered = _chunk6RZVFYGJcjs.effectLayerOffered; exports.effectLayerRole = _chunk6RZVFYGJcjs.effectLayerRole; exports.effectOffered = _chunkJAOSL334cjs.effectOffered; exports.effectParameterFields = effectParameterFields; exports.effectSampleInputs = effectSampleInputs; exports.effectSamplePicture = effectSamplePicture; exports.effectSequenceEffects = _chunk6RZVFYGJcjs.effectSequenceEffects; exports.effectSequenceSlots = _chunk6RZVFYGJcjs.effectSequenceSlots; exports.effectSubjectKind = _chunk6RZVFYGJcjs.effectSubjectKind; exports.effectSubjectProblem = _chunk6RZVFYGJcjs.effectSubjectProblem; exports.effectValueErrors = _chunkJAOSL334cjs.effectValueErrors; exports.encodeEffectFloat = _chunkJAOSL334cjs.encodeEffectFloat; exports.groupEffectsByCategory = groupEffectsByCategory; exports.hasEffectTags = _chunkJAOSL334cjs.hasEffectTags; exports.isCameraView = _chunkJAOSL334cjs.isCameraView; exports.isEffectError = _chunkJAOSL334cjs.isEffectError; exports.isEffectFontControl = isEffectFontControl; exports.isEffectPixels = _chunkJAOSL334cjs.isEffectPixels; exports.isSubjectTemplateSlot = _chunk6RZVFYGJcjs.isSubjectTemplateSlot; exports.linearToSrgb = _chunkJAOSL334cjs.linearToSrgb; exports.normaliseEffectTag = _chunkJAOSL334cjs.normaliseEffectTag; exports.renderEffectThumbnail = renderEffectThumbnail; exports.resolveCameraMoveSpec = _chunkJAOSL334cjs.resolveCameraMoveSpec; exports.resolveEffectValues = _chunkJAOSL334cjs.resolveEffectValues; exports.sampleCameraViews = _chunkJAOSL334cjs.sampleCameraViews; exports.sampleEffectCameraMove = _chunkJAOSL334cjs.sampleEffectCameraMove; exports.searchEffectSummaries = _chunkJAOSL334cjs.searchEffectSummaries; exports.searchTemplateSummaries = _chunk6RZVFYGJcjs.searchTemplateSummaries; exports.srgbToLinear = _chunkJAOSL334cjs.srgbToLinear; exports.templateDefaultValues = _chunk6RZVFYGJcjs.templateDefaultValues; exports.templateSlotSchema = _chunk6RZVFYGJcjs.templateSlotSchema; exports.templateSlotSummary = _chunk6RZVFYGJcjs.templateSlotSummary; exports.templateSlotTakes = _chunk6RZVFYGJcjs.templateSlotTakes; exports.templateValueProblem = _chunk6RZVFYGJcjs.templateValueProblem; exports.templateValuesSchema = _chunk6RZVFYGJcjs.templateValuesSchema;
+
+
+
+
+exports.CAMERA_MOVE_MAX_MS = _chunkJAOSL334cjs.CAMERA_MOVE_MAX_MS; exports.CAMERA_MOVE_ROLES = _chunkJAOSL334cjs.CAMERA_MOVE_ROLES; exports.EFFECT_ERROR_CODES = _chunkJAOSL334cjs.EFFECT_ERROR_CODES; exports.EFFECT_KINDS = _chunkJAOSL334cjs.EFFECT_KINDS; exports.EFFECT_LAYER_ROLES = _chunkJAOSL334cjs.EFFECT_LAYER_ROLES; exports.EFFECT_LAYER_USES = _chunkJWCKJNDRcjs.EFFECT_LAYER_USES; exports.EFFECT_SEQUENCE_NAME = _chunkJWCKJNDRcjs.EFFECT_SEQUENCE_NAME; exports.EFFECT_SUBJECT_KINDS = _chunkJAOSL334cjs.EFFECT_SUBJECT_KINDS; exports.EFFECT_TEMPLATE_SLOT_TYPES = _chunkJAOSL334cjs.EFFECT_TEMPLATE_SLOT_TYPES; exports.EFFECT_TRANSITION_MS = _chunkJAOSL334cjs.EFFECT_TRANSITION_MS; exports.EFFECT_USES = _chunkJAOSL334cjs.EFFECT_USES; exports.EFFECT_USE_LABELS = EFFECT_USE_LABELS; exports.EffectControlError = _chunkJAOSL334cjs.EffectControlError; exports.EffectDisposedError = _chunkJAOSL334cjs.EffectDisposedError; exports.EffectError = _chunkJAOSL334cjs.EffectError; exports.EffectRendererPool = _chunkPY4GWSE2cjs.EffectRendererPool; exports.EffectUnsupportedError = _chunkJAOSL334cjs.EffectUnsupportedError; exports.EffectsSlot = _chunkJAOSL334cjs.EffectsSlot; exports.NoEffectsProviderError = _chunkJAOSL334cjs.NoEffectsProviderError; exports.UnknownEffectError = _chunkJAOSL334cjs.UnknownEffectError; exports.UnknownTemplateError = _chunkJAOSL334cjs.UnknownTemplateError; exports.applyEffectMask = _chunkJAOSL334cjs.applyEffectMask; exports.cameraBoxOfView = _chunkJAOSL334cjs.cameraBoxOfView; exports.cameraMoveField = _chunkJAOSL334cjs.cameraMoveField; exports.cameraMoveIdList = _chunkJAOSL334cjs.cameraMoveIdList; exports.cameraMoveParts = _chunkJAOSL334cjs.cameraMoveParts; exports.cameraMovesFor = _chunkJAOSL334cjs.cameraMovesFor; exports.cameraViewOfBox = _chunkJAOSL334cjs.cameraViewOfBox; exports.checkEffectProvider = checkEffectProvider; exports.checkEffectSequence = _chunkJWCKJNDRcjs.checkEffectSequence; exports.checkTemplateValues = _chunkJWCKJNDRcjs.checkTemplateValues; exports.countEffectTags = _chunkJAOSL334cjs.countEffectTags; exports.createEffectAuthoringSession = _chunkA7PQNIBXcjs.createEffectAuthoringSession; exports.createEffectAuthoringToolProvider = createEffectAuthoringToolProvider; exports.createEffectPixels = _chunkJAOSL334cjs.createEffectPixels; exports.createEffectToolProvider = _chunkJAOSL334cjs.createEffectToolProvider; exports.createFakeEffectProvider = createFakeEffectProvider; exports.effectControlField = effectControlField; exports.effectFieldValue = effectFieldValue; exports.effectFontFamilies = effectFontFamilies; exports.effectLayerInput = _chunkJWCKJNDRcjs.effectLayerInput; exports.effectLayerOffered = _chunkJWCKJNDRcjs.effectLayerOffered; exports.effectLayerRole = _chunkJWCKJNDRcjs.effectLayerRole; exports.effectLayerSpan = _chunkJWCKJNDRcjs.effectLayerSpan; exports.effectOffered = _chunkJAOSL334cjs.effectOffered; exports.effectParameterFields = effectParameterFields; exports.effectSampleInputs = effectSampleInputs; exports.effectSamplePicture = effectSamplePicture; exports.effectSequenceEffects = _chunkJWCKJNDRcjs.effectSequenceEffects; exports.effectSequenceSlots = _chunkJWCKJNDRcjs.effectSequenceSlots; exports.effectSequenceTiming = _chunkJWCKJNDRcjs.effectSequenceTiming; exports.effectSubjectKind = _chunkJWCKJNDRcjs.effectSubjectKind; exports.effectSubjectProblem = _chunkJWCKJNDRcjs.effectSubjectProblem; exports.effectTemplateTools = _chunkJWCKJNDRcjs.effectTemplateTools; exports.effectValueErrors = _chunkJAOSL334cjs.effectValueErrors; exports.encodeEffectFloat = _chunkJAOSL334cjs.encodeEffectFloat; exports.fillEffectTemplate = _chunkJWCKJNDRcjs.fillEffectTemplate; exports.groupEffectsByCategory = groupEffectsByCategory; exports.hasEffectTags = _chunkJAOSL334cjs.hasEffectTags; exports.isCameraView = _chunkJAOSL334cjs.isCameraView; exports.isEffectError = _chunkJAOSL334cjs.isEffectError; exports.isEffectFontControl = isEffectFontControl; exports.isEffectPixels = _chunkJAOSL334cjs.isEffectPixels; exports.isSubjectTemplateSlot = _chunkJWCKJNDRcjs.isSubjectTemplateSlot; exports.linearToSrgb = _chunkJAOSL334cjs.linearToSrgb; exports.normaliseEffectTag = _chunkJAOSL334cjs.normaliseEffectTag; exports.renderEffectThumbnail = renderEffectThumbnail; exports.resolveCameraMoveSpec = _chunkJAOSL334cjs.resolveCameraMoveSpec; exports.resolveEffectValues = _chunkJAOSL334cjs.resolveEffectValues; exports.sampleCameraViews = _chunkJAOSL334cjs.sampleCameraViews; exports.sampleEffectCameraMove = _chunkJAOSL334cjs.sampleEffectCameraMove; exports.searchEffectSummaries = _chunkJAOSL334cjs.searchEffectSummaries; exports.searchTemplateSummaries = _chunkJWCKJNDRcjs.searchTemplateSummaries; exports.srgbToLinear = _chunkJAOSL334cjs.srgbToLinear; exports.templateDefaultValues = _chunkJWCKJNDRcjs.templateDefaultValues; exports.templateSlotSchema = _chunkJWCKJNDRcjs.templateSlotSchema; exports.templateSlotSummary = _chunkJWCKJNDRcjs.templateSlotSummary; exports.templateSlotTakes = _chunkJWCKJNDRcjs.templateSlotTakes; exports.templateValueProblem = _chunkJWCKJNDRcjs.templateValueProblem; exports.templateValuesSchema = _chunkJWCKJNDRcjs.templateValuesSchema;

package/dist/effects/index.d.cts

@@ -11,6 +11,7 @@ export * from './templates.cjs';
 export * from './conformance.cjs';
 export * from './fake.cjs';
 export * from './tools.cjs';
+export * from './template-tools.cjs';
 export * from './ui.cjs';
 export * from './pool.cjs';
 export * from './authoring.cjs';

package/dist/effects/index.d.ts

@@ -11,6 +11,7 @@ export * from './templates.js';
 export * from './conformance.js';
 export * from './fake.js';
 export * from './tools.js';
+export * from './template-tools.js';
 export * from './ui.js';
 export * from './pool.js';
 export * from './authoring.js';

package/dist/effects/index.js

@@ -12,10 +12,14 @@ import {
   effectLayerInput,
   effectLayerOffered,
   effectLayerRole,
+  effectLayerSpan,
   effectSequenceEffects,
   effectSequenceSlots,
+  effectSequenceTiming,
   effectSubjectKind,
   effectSubjectProblem,
+  effectTemplateTools,
+  fillEffectTemplate,
   isSubjectTemplateSlot,
   searchTemplateSummaries,
   templateDefaultValues,
@@ -24,7 +28,7 @@ import {
   templateSlotTakes,
   templateValueProblem,
   templateValuesSchema
-} from "../chunk-I277KJLQ.js";
+} from "../chunk-G3RUKJ5C.js";
 import {
   EffectRendererPool
 } from "../chunk-EHLOCVWB.js";
@@ -1574,16 +1578,20 @@ export {
   effectLayerInput,
   effectLayerOffered,
   effectLayerRole,
+  effectLayerSpan,
   effectOffered,
   effectParameterFields,
   effectSampleInputs,
   effectSamplePicture,
   effectSequenceEffects,
   effectSequenceSlots,
+  effectSequenceTiming,
   effectSubjectKind,
   effectSubjectProblem,
+  effectTemplateTools,
   effectValueErrors,
   encodeEffectFloat,
+  fillEffectTemplate,
   groupEffectsByCategory,
   hasEffectTags,
   isCameraView,

package/dist/effects/template-tools.d.cts

@@ -0,0 +1,25 @@
+/**
+ * Agent tools for the provider's sequence templates, shared by the editors that can load an
+ * `EffectSequence`: `list_templates`, `describe_template` and `fill_template`. An editor gives
+ * them to its effect tool provider (`extraTools`) with an `EffectTemplateToolHost` that says what
+ * filling makes there and does it as one undo step.
+ */
+import type { AgentTool } from '../tools/registry.cjs';
+import type { JsonSchema } from '../tools/schema.cjs';
+import type { EffectToolContext } from './tools.cjs';
+import type { EffectProvider } from './types.cjs';
+export interface EffectTemplateToolHost {
+    /** The current provider, or `null`. */
+    provider(): EffectProvider | null;
+    /** Added to `fill_template`'s description: what filling makes in this editor and what it returns. */
+    fillDetails: string;
+    /** Arguments `fill_template` takes in this editor besides `template`, `values` and `name`. */
+    fillOptions?: Record<string, JsonSchema>;
+    /** Fills the template and loads it as one undo step; returns what it made. Throws a sentence when it cannot. */
+    fill(template: string, values: Record<string, unknown>, options: {
+        name?: string;
+        [option: string]: unknown;
+    }): Promise<Record<string, unknown>>;
+}
+/** The template tools (see the module comment). */
+export declare function effectTemplateTools(host: EffectTemplateToolHost, ctx: EffectToolContext): AgentTool[];

package/dist/effects/template-tools.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Agent tools for the provider's sequence templates, shared by the editors that can load an
+ * `EffectSequence`: `list_templates`, `describe_template` and `fill_template`. An editor gives
+ * them to its effect tool provider (`extraTools`) with an `EffectTemplateToolHost` that says what
+ * filling makes there and does it as one undo step.
+ */
+import type { AgentTool } from '../tools/registry.js';
+import type { JsonSchema } from '../tools/schema.js';
+import type { EffectToolContext } from './tools.js';
+import type { EffectProvider } from './types.js';
+export interface EffectTemplateToolHost {
+    /** The current provider, or `null`. */
+    provider(): EffectProvider | null;
+    /** Added to `fill_template`'s description: what filling makes in this editor and what it returns. */
+    fillDetails: string;
+    /** Arguments `fill_template` takes in this editor besides `template`, `values` and `name`. */
+    fillOptions?: Record<string, JsonSchema>;
+    /** Fills the template and loads it as one undo step; returns what it made. Throws a sentence when it cannot. */
+    fill(template: string, values: Record<string, unknown>, options: {
+        name?: string;
+        [option: string]: unknown;
+    }): Promise<Record<string, unknown>>;
+}
+/** The template tools (see the module comment). */
+export declare function effectTemplateTools(host: EffectTemplateToolHost, ctx: EffectToolContext): AgentTool[];

package/dist/effects/templates.d.cts

@@ -4,7 +4,7 @@
  * a sequence before loading it, and which input a layer's subject feeds. Dependency-free.
  */
 import type { JsonSchema } from '../tools/schema.cjs';
-import { type EffectDescription, type EffectLayer, type EffectLayerRole, type EffectSequence, type EffectSubjectKind, type EffectSummary, type EffectTemplateSearchOptions, type EffectTemplateSlot, type EffectTemplateSummary } from './types.cjs';
+import { type EffectDescription, type EffectProvider, type EffectTemplateDescription, type EffectTemplateOptions, type EffectLayer, type EffectLayerRole, type EffectSequence, type EffectSubjectKind, type EffectSummary, type EffectTemplateSearchOptions, type EffectTemplateSlot, type EffectTemplateSummary } from './types.cjs';
 export declare const EFFECT_SEQUENCE_NAME: RegExp;
 /** True for a subject slot (`image`, `video`, `svg`). */
 export declare const isSubjectTemplateSlot: (slot: Pick<EffectTemplateSlot, "type">) => boolean;
@@ -54,3 +54,32 @@ export declare function checkEffectSequence(sequence: unknown, catalog?: readonl
 export declare function effectSequenceEffects(sequence: EffectSequence): string[];
 /** Subject slots a sequence leaves for the host (`{ slot }` subjects), each once. */
 export declare function effectSequenceSlots(sequence: EffectSequence): string[];
+/** A filled template, checked and ready for an editor to load. */
+export interface FilledEffectTemplate {
+    template: EffectTemplateDescription;
+    sequence: EffectSequence;
+    openSlots: string[];
+    notes: string[];
+}
+/**
+ * Fills a provider template for an editor: checks the provider has templates, checks `values`
+ * against the slots first (every problem at once, as sentences), fills it, and checks the
+ * sequence against the provider's catalog before anything is loaded. Throws an `Error` whose
+ * message says what is wrong and what to call instead; never returns a sequence that names
+ * effects the provider does not list.
+ */
+export declare function fillEffectTemplate(provider: EffectProvider | null | undefined, id: string, values?: unknown, options?: EffectTemplateOptions): Promise<FilledEffectTemplate>;
+/** Where a layer of a sequence shows, in ms from the sequence's start, given each shot's start and the total length. */
+export declare function effectLayerSpan(layer: Pick<EffectLayer, 'from' | 'until'>, shotIndex: number, shotStarts: readonly number[], total: number): {
+    start: number;
+    end: number;
+};
+/**
+ * When each shot of a sequence starts and how long it all lasts (ms): a shot plays its lead-in (the
+ * longer of its transition and its camera move in, when the move says its `ms`) and then holds.
+ */
+export declare function effectSequenceTiming(sequence: EffectSequence): {
+    starts: number[];
+    leadIns: number[];
+    total: number;
+};

package/dist/effects/templates.d.ts

@@ -4,7 +4,7 @@
  * a sequence before loading it, and which input a layer's subject feeds. Dependency-free.
  */
 import type { JsonSchema } from '../tools/schema.js';
-import { type EffectDescription, type EffectLayer, type EffectLayerRole, type EffectSequence, type EffectSubjectKind, type EffectSummary, type EffectTemplateSearchOptions, type EffectTemplateSlot, type EffectTemplateSummary } from './types.js';
+import { type EffectDescription, type EffectProvider, type EffectTemplateDescription, type EffectTemplateOptions, type EffectLayer, type EffectLayerRole, type EffectSequence, type EffectSubjectKind, type EffectSummary, type EffectTemplateSearchOptions, type EffectTemplateSlot, type EffectTemplateSummary } from './types.js';
 export declare const EFFECT_SEQUENCE_NAME: RegExp;
 /** True for a subject slot (`image`, `video`, `svg`). */
 export declare const isSubjectTemplateSlot: (slot: Pick<EffectTemplateSlot, "type">) => boolean;
@@ -54,3 +54,32 @@ export declare function checkEffectSequence(sequence: unknown, catalog?: readonl
 export declare function effectSequenceEffects(sequence: EffectSequence): string[];
 /** Subject slots a sequence leaves for the host (`{ slot }` subjects), each once. */
 export declare function effectSequenceSlots(sequence: EffectSequence): string[];
+/** A filled template, checked and ready for an editor to load. */
+export interface FilledEffectTemplate {
+    template: EffectTemplateDescription;
+    sequence: EffectSequence;
+    openSlots: string[];
+    notes: string[];
+}
+/**
+ * Fills a provider template for an editor: checks the provider has templates, checks `values`
+ * against the slots first (every problem at once, as sentences), fills it, and checks the
+ * sequence against the provider's catalog before anything is loaded. Throws an `Error` whose
+ * message says what is wrong and what to call instead; never returns a sequence that names
+ * effects the provider does not list.
+ */
+export declare function fillEffectTemplate(provider: EffectProvider | null | undefined, id: string, values?: unknown, options?: EffectTemplateOptions): Promise<FilledEffectTemplate>;
+/** Where a layer of a sequence shows, in ms from the sequence's start, given each shot's start and the total length. */
+export declare function effectLayerSpan(layer: Pick<EffectLayer, 'from' | 'until'>, shotIndex: number, shotStarts: readonly number[], total: number): {
+    start: number;
+    end: number;
+};
+/**
+ * When each shot of a sequence starts and how long it all lasts (ms): a shot plays its lead-in (the
+ * longer of its transition and its camera move in, when the move says its `ms`) and then holds.
+ */
+export declare function effectSequenceTiming(sequence: EffectSequence): {
+    starts: number[];
+    leadIns: number[];
+    total: number;
+};

package/dist/video-editor/controller.d.cts

@@ -52,6 +52,22 @@ export interface VideoEditorOptions {
 }
 /** What `applyClipEffect` and the other effect edits return: the edit result plus what they made or changed. */
 /** What setting or clearing a clip's camera move did: its camera now, the keys baked per property, any cuts and when each move plays (clip ms). */
+/** What filling a template did (see `fillTemplate`). */
+export type VideoTemplateResult = {
+    ok: true;
+    template: string;
+    tracks: string[];
+    clips: string[];
+    assets: string[];
+    start: number;
+    end: number;
+    placeholders: Record<string, string[]>;
+    openSlots: string[];
+    notes: string[];
+} | {
+    ok: false;
+    error: string;
+};
 export type VideoCameraMoveResult = {
     ok: true;
     clip: string;
@@ -257,6 +273,16 @@ export declare class VideoEditorController {
     useEffects(provider: EffectProvider): () => void;
     /** The provider's description of an effect, checked for `place` (rejects without a provider or for an unknown id). */
     describeEffect(effect: string, place?: VideoEffectPlace): Promise<EffectDescription>;
+    /**
+     * Fills a provider sequence template and puts it on the timeline at `at` (default the end), on
+     * new tracks above the others (see `videoEditsFromSequence`). Values are checked first and every
+     * problem is refused at once. One undo step. Returns the new tracks, clips and assets, where it
+     * starts and ends, the placeholder clips standing in for open slots, and notes.
+     */
+    fillTemplate(template: string, values?: Record<string, unknown>, options?: {
+        name?: string;
+        at?: number;
+    }): Promise<VideoTemplateResult>;
     private refused;
     private effectEdit;
     private clipOrThrow;

package/dist/video-editor/controller.d.ts

@@ -52,6 +52,22 @@ export interface VideoEditorOptions {
 }
 /** What `applyClipEffect` and the other effect edits return: the edit result plus what they made or changed. */
 /** What setting or clearing a clip's camera move did: its camera now, the keys baked per property, any cuts and when each move plays (clip ms). */
+/** What filling a template did (see `fillTemplate`). */
+export type VideoTemplateResult = {
+    ok: true;
+    template: string;
+    tracks: string[];
+    clips: string[];
+    assets: string[];
+    start: number;
+    end: number;
+    placeholders: Record<string, string[]>;
+    openSlots: string[];
+    notes: string[];
+} | {
+    ok: false;
+    error: string;
+};
 export type VideoCameraMoveResult = {
     ok: true;
     clip: string;
@@ -257,6 +273,16 @@ export declare class VideoEditorController {
     useEffects(provider: EffectProvider): () => void;
     /** The provider's description of an effect, checked for `place` (rejects without a provider or for an unknown id). */
     describeEffect(effect: string, place?: VideoEffectPlace): Promise<EffectDescription>;
+    /**
+     * Fills a provider sequence template and puts it on the timeline at `at` (default the end), on
+     * new tracks above the others (see `videoEditsFromSequence`). Values are checked first and every
+     * problem is refused at once. One undo step. Returns the new tracks, clips and assets, where it
+     * starts and ends, the placeholder clips standing in for open slots, and notes.
+     */
+    fillTemplate(template: string, values?: Record<string, unknown>, options?: {
+        name?: string;
+        at?: number;
+    }): Promise<VideoTemplateResult>;
     private refused;
     private effectEdit;
     private clipOrThrow;