@softure-ai/marketing-kit 0.34.0 → 0.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/NOTICE +6 -0
- package/README.md +26 -0
- package/dist/config/schema.d.ts +8 -0
- package/dist/config/schema.d.ts.map +1 -1
- package/dist/config/schema.js +1 -1
- package/dist/config/schema.js.map +1 -1
- package/dist/footage/compose.d.ts +2 -1
- package/dist/footage/compose.d.ts.map +1 -1
- package/dist/footage/compose.js +16 -3
- package/dist/footage/compose.js.map +1 -1
- package/dist/footage/draft-overlays.d.ts +6 -0
- package/dist/footage/draft-overlays.d.ts.map +1 -1
- package/dist/footage/draft-overlays.js +188 -4
- package/dist/footage/draft-overlays.js.map +1 -1
- package/dist/footage/draft.d.ts +11 -0
- package/dist/footage/draft.d.ts.map +1 -1
- package/dist/footage/draft.js +45 -3
- package/dist/footage/draft.js.map +1 -1
- package/dist/footage/drawn-transitions.d.ts +63 -0
- package/dist/footage/drawn-transitions.d.ts.map +1 -0
- package/dist/footage/drawn-transitions.js +177 -0
- package/dist/footage/drawn-transitions.js.map +1 -0
- package/dist/footage/edl.d.ts +16 -0
- package/dist/footage/edl.d.ts.map +1 -1
- package/dist/footage/edl.js +24 -1
- package/dist/footage/edl.js.map +1 -1
- package/dist/footage/film.d.ts +4 -3
- package/dist/footage/film.d.ts.map +1 -1
- package/dist/footage/film.js +3 -2
- package/dist/footage/film.js.map +1 -1
- package/dist/footage/hand-font.d.ts +16 -0
- package/dist/footage/hand-font.d.ts.map +1 -0
- package/dist/footage/hand-font.js +43 -0
- package/dist/footage/hand-font.js.map +1 -0
- package/dist/footage/overlay-html.d.ts +1 -0
- package/dist/footage/overlay-html.d.ts.map +1 -1
- package/dist/footage/overlay-html.js +134 -8
- package/dist/footage/overlay-html.js.map +1 -1
- package/dist/footage/overlay-motion.d.ts +35 -0
- package/dist/footage/overlay-motion.d.ts.map +1 -1
- package/dist/footage/overlay-motion.js +45 -0
- package/dist/footage/overlay-motion.js.map +1 -1
- package/dist/footage/overlay-schema.d.ts +48 -6
- package/dist/footage/overlay-schema.d.ts.map +1 -1
- package/dist/footage/overlay-schema.js +71 -18
- package/dist/footage/overlay-schema.js.map +1 -1
- package/dist/footage/overlays.d.ts +125 -1
- package/dist/footage/overlays.d.ts.map +1 -1
- package/dist/footage/overlays.js +260 -8
- package/dist/footage/overlays.js.map +1 -1
- package/dist/footage/picture.d.ts +5 -2
- package/dist/footage/picture.d.ts.map +1 -1
- package/dist/footage/picture.js +30 -8
- package/dist/footage/picture.js.map +1 -1
- package/dist/footage/pipeline.d.ts.map +1 -1
- package/dist/footage/pipeline.js +7 -1
- package/dist/footage/pipeline.js.map +1 -1
- package/dist/footage/tools.d.ts +1 -1
- package/dist/footage/tools.d.ts.map +1 -1
- package/dist/footage/tools.js +1 -1
- package/dist/footage/tools.js.map +1 -1
- package/dist/index.d.ts +5 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -3
- package/dist/index.js.map +1 -1
- package/fonts/Caveat-SemiBold-Latin.ttf +0 -0
- package/fonts/LICENSE-Caveat.txt +93 -0
- package/fonts/README.md +14 -0
- package/package.json +1 -1
- package/schema/edl.schema.json +38 -11
- package/schema/marketing.schema.json +10 -2
- package/src/config/schema.ts +1 -1
- package/src/footage/compose.ts +14 -3
- package/src/footage/draft-overlays.ts +217 -2
- package/src/footage/draft.ts +54 -3
- package/src/footage/drawn-transitions.ts +214 -0
- package/src/footage/edl.ts +21 -1
- package/src/footage/film.ts +3 -2
- package/src/footage/hand-font.ts +47 -0
- package/src/footage/overlay-html.ts +141 -7
- package/src/footage/overlay-motion.ts +49 -0
- package/src/footage/overlay-schema.ts +78 -19
- package/src/footage/overlays.ts +306 -10
- package/src/footage/picture.ts +35 -10
- package/src/footage/pipeline.ts +7 -1
- package/src/footage/tools.ts +1 -1
- package/src/index.ts +32 -0
|
@@ -15,9 +15,11 @@ import { CORNER_RADII, type CornerRadius } from "./brand-style.js";
|
|
|
15
15
|
* hook's question or title at the top of the frame, one or two lines, with an optional place label (a drawn pin and
|
|
16
16
|
* "City, Country") above it; it may stay across cuts. `search_bar`: a rounded search field whose text types in.
|
|
17
17
|
* `place_card`: a big place title with a one-line subtitle. `counter`: a number with a unit counting up to its value.
|
|
18
|
-
* `date_stamp`: a day or a date with a place, small, in a corner of the top band.
|
|
18
|
+
* `date_stamp`: a day or a date with a place, small, in a corner of the top band. `note`: a paper note (a handwritten
|
|
19
|
+
* card whose words appear as they are said, or a torn strip that grows in and types its text). `end_word`: one big
|
|
20
|
+
* handwritten word at the top over the film's last moment.
|
|
19
21
|
*/
|
|
20
|
-
export const OVERLAY_KINDS = ["punch_in", "keyword", "lower_third", "list", "arrow", "highlight", "hook_title", "search_bar", "place_card", "counter", "date_stamp"] as const;
|
|
22
|
+
export const OVERLAY_KINDS = ["punch_in", "keyword", "lower_third", "list", "arrow", "highlight", "hook_title", "search_bar", "place_card", "counter", "date_stamp", "note", "end_word"] as const;
|
|
21
23
|
|
|
22
24
|
export type OverlayKind = (typeof OVERLAY_KINDS)[number];
|
|
23
25
|
|
|
@@ -54,9 +56,10 @@ export const OVERLAY_ALIGNED_KINDS: readonly OverlayKind[] = ["hook_title", "pla
|
|
|
54
56
|
* simply there), `pop` (grows from 92 % to 100 % while it fades in, eased out, never past its size), `rise` (up from
|
|
55
57
|
* 5 % of the frame's height while it fades in), `blur` (from a slight blur to sharp) or `wipe` (its card revealed from
|
|
56
58
|
* the left in the accent colour, then its text). Without one, the kind's own entrance. Never a bounce or an overshoot:
|
|
57
|
-
* the reel stays natural (`overlay-motion.ts`).
|
|
59
|
+
* the reel stays natural (`overlay-motion.ts`). `drop` (a hook title, a keyword, an end word): its letters fall into
|
|
60
|
+
* place one by one, eased out, never below their line.
|
|
58
61
|
*/
|
|
59
|
-
export const OVERLAY_ENTRANCES = ["fade", "slide", "type", "none", "pop", "rise", "blur", "wipe"] as const;
|
|
62
|
+
export const OVERLAY_ENTRANCES = ["fade", "slide", "type", "none", "pop", "rise", "blur", "wipe", "drop"] as const;
|
|
60
63
|
|
|
61
64
|
export type OverlayEntrance = (typeof OVERLAY_ENTRANCES)[number];
|
|
62
65
|
|
|
@@ -88,11 +91,33 @@ export const OVERLAY_LIST_LAYOUTS = ["stack", "chips", "auto"] as const;
|
|
|
88
91
|
|
|
89
92
|
export type OverlayListLayout = (typeof OVERLAY_LIST_LAYOUTS)[number];
|
|
90
93
|
|
|
94
|
+
/**
|
|
95
|
+
* What a hook title's or a keyword's text sits on: `card` (its card, the default) or `highlight` (each line on its own
|
|
96
|
+
* tight box in the card colour, without shadow; typed in, the box grows with the letters).
|
|
97
|
+
*/
|
|
98
|
+
export const OVERLAY_BACKDROPS = ["card", "highlight"] as const;
|
|
99
|
+
|
|
100
|
+
export type OverlayBackdrop = (typeof OVERLAY_BACKDROPS)[number];
|
|
101
|
+
|
|
102
|
+
/** The kinds that take a `backdrop`. */
|
|
103
|
+
export const OVERLAY_BACKDROP_KINDS: readonly OverlayKind[] = ["hook_title", "keyword"];
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* A note's shape: `card` (a slightly tilted paper card with a torn foot, its words handwritten as they are said) or
|
|
107
|
+
* `strip` (a paper strip with a torn top that grows in, then types its text in capitals).
|
|
108
|
+
*/
|
|
109
|
+
export const OVERLAY_NOTE_STYLES = ["card", "strip"] as const;
|
|
110
|
+
|
|
111
|
+
export type OverlayNoteStyle = (typeof OVERLAY_NOTE_STYLES)[number];
|
|
112
|
+
|
|
91
113
|
/** The longest a place card's subtitle waits after its title, in seconds. */
|
|
92
114
|
export const MAX_OVERLAY_SUBTITLE_DELAY = 0.6;
|
|
93
115
|
|
|
94
116
|
/** The shortest an overlay stays on screen: shorter does not read. */
|
|
95
117
|
export const MIN_OVERLAY_SECONDS = 1;
|
|
118
|
+
/** The shortest and longest an `end_word` stays: the film's last moment. */
|
|
119
|
+
export const MIN_END_WORD_SECONDS = 0.5;
|
|
120
|
+
export const MAX_END_WORD_SECONDS = 2;
|
|
96
121
|
/** The longest an overlay stays on screen (a `hook_title` may stay up to `MAX_HOOK_TITLE_SECONDS`). */
|
|
97
122
|
export const MAX_OVERLAY_SECONDS = 8;
|
|
98
123
|
/** The longest a `hook_title` stays on screen: up to a whole short film. */
|
|
@@ -115,6 +140,10 @@ export const MAX_OVERLAY_PLACE_TITLE_LENGTH = 28;
|
|
|
115
140
|
export const MAX_OVERLAY_SUBTITLE_LENGTH = 40;
|
|
116
141
|
/** The longest `date_stamp` text. */
|
|
117
142
|
export const MAX_OVERLAY_DATE_LENGTH = 24;
|
|
143
|
+
/** The longest `note` text. */
|
|
144
|
+
export const MAX_OVERLAY_NOTE_LENGTH = 72;
|
|
145
|
+
/** The longest `end_word` text. */
|
|
146
|
+
export const MAX_OVERLAY_END_WORD_LENGTH = 16;
|
|
118
147
|
/** The longest `counter` unit. */
|
|
119
148
|
export const MAX_OVERLAY_UNIT_LENGTH = 12;
|
|
120
149
|
/** The largest `counter` value. */
|
|
@@ -177,6 +206,12 @@ export interface EdlOverlayStyle {
|
|
|
177
206
|
pin?: OverlayPin;
|
|
178
207
|
/** A keyword's accent bar drawn under the word after it enters. */
|
|
179
208
|
underline?: boolean;
|
|
209
|
+
/** What a hook title's or a keyword's text sits on (`card` without it). */
|
|
210
|
+
backdrop?: OverlayBackdrop;
|
|
211
|
+
/** A note's shape (`card` without it). */
|
|
212
|
+
note_style?: OverlayNoteStyle;
|
|
213
|
+
/** A note's hand-drawn tick after its last word. */
|
|
214
|
+
tick?: boolean;
|
|
180
215
|
}
|
|
181
216
|
|
|
182
217
|
export interface EdlOverlay {
|
|
@@ -187,7 +222,7 @@ export interface EdlOverlay {
|
|
|
187
222
|
at?: number;
|
|
188
223
|
/** Seconds on screen (`MIN_OVERLAY_SECONDS` to `MAX_OVERLAY_SECONDS`; a `hook_title` up to `MAX_HOOK_TITLE_SECONDS`). */
|
|
189
224
|
duration: number;
|
|
190
|
-
/** The text of a `keyword`, `lower_third`, `hook_title`, `search_bar`, `place_card` (its title) or `
|
|
225
|
+
/** The text of a `keyword`, `lower_third`, `hook_title`, `search_bar`, `place_card` (its title), `date_stamp`, `note` or `end_word`. */
|
|
191
226
|
text?: string;
|
|
192
227
|
/** The `list` points (2 to 4). */
|
|
193
228
|
items?: string[];
|
|
@@ -237,6 +272,8 @@ const KIND_FIELDS: Record<OverlayKind, KindFields> = {
|
|
|
237
272
|
place_card: { ...TEXT_ONLY, subtitle: true },
|
|
238
273
|
counter: { ...NO_FIELDS, counter: true },
|
|
239
274
|
date_stamp: { ...TEXT_ONLY, place: true },
|
|
275
|
+
note: TEXT_ONLY,
|
|
276
|
+
end_word: TEXT_ONLY,
|
|
240
277
|
};
|
|
241
278
|
|
|
242
279
|
const TEXT_LIMITS: Partial<Record<OverlayKind, number>> = {
|
|
@@ -246,10 +283,12 @@ const TEXT_LIMITS: Partial<Record<OverlayKind, number>> = {
|
|
|
246
283
|
search_bar: MAX_OVERLAY_SEARCH_LENGTH,
|
|
247
284
|
place_card: MAX_OVERLAY_PLACE_TITLE_LENGTH,
|
|
248
285
|
date_stamp: MAX_OVERLAY_DATE_LENGTH,
|
|
286
|
+
note: MAX_OVERLAY_NOTE_LENGTH,
|
|
287
|
+
end_word: MAX_OVERLAY_END_WORD_LENGTH,
|
|
249
288
|
};
|
|
250
289
|
|
|
251
290
|
/** The kinds that take a side. */
|
|
252
|
-
export const OVERLAY_SIDED_KINDS: readonly OverlayKind[] = ["keyword", "lower_third", "list", "date_stamp"];
|
|
291
|
+
export const OVERLAY_SIDED_KINDS: readonly OverlayKind[] = ["keyword", "lower_third", "list", "date_stamp", "note"];
|
|
253
292
|
|
|
254
293
|
/** The positions a kind may take (none: its place is fixed). */
|
|
255
294
|
export const OVERLAY_POSITIONS_BY_KIND: Partial<Record<OverlayKind, readonly OverlayPosition[]>> = {
|
|
@@ -259,6 +298,7 @@ export const OVERLAY_POSITIONS_BY_KIND: Partial<Record<OverlayKind, readonly Ove
|
|
|
259
298
|
search_bar: ["top", "middle", "bottom"],
|
|
260
299
|
place_card: ["top", "middle", "bottom"],
|
|
261
300
|
counter: ["top", "middle", "bottom"],
|
|
301
|
+
note: ["top", "middle"],
|
|
262
302
|
};
|
|
263
303
|
|
|
264
304
|
const TEXT_ENTRANCES: readonly OverlayEntrance[] = ["fade", "slide", "type", "none", "pop", "rise", "blur", "wipe"];
|
|
@@ -267,22 +307,24 @@ const BLOCK_ENTRANCES: readonly OverlayEntrance[] = ["fade", "slide", "none", "p
|
|
|
267
307
|
/** The entrances a kind may take (none listed: it takes no entrance). */
|
|
268
308
|
export const OVERLAY_ENTRANCES_BY_KIND: Record<OverlayKind, readonly OverlayEntrance[]> = {
|
|
269
309
|
punch_in: [],
|
|
270
|
-
keyword: TEXT_ENTRANCES,
|
|
310
|
+
keyword: [...TEXT_ENTRANCES, "drop"],
|
|
271
311
|
lower_third: TEXT_ENTRANCES,
|
|
272
312
|
list: BLOCK_ENTRANCES,
|
|
273
313
|
arrow: ["fade", "none"],
|
|
274
314
|
highlight: ["fade", "none"],
|
|
275
|
-
hook_title: TEXT_ENTRANCES,
|
|
315
|
+
hook_title: [...TEXT_ENTRANCES, "drop"],
|
|
276
316
|
search_bar: TEXT_ENTRANCES,
|
|
277
317
|
place_card: TEXT_ENTRANCES,
|
|
278
318
|
counter: BLOCK_ENTRANCES,
|
|
279
319
|
date_stamp: TEXT_ENTRANCES,
|
|
320
|
+
note: ["fade", "pop", "none"],
|
|
321
|
+
end_word: ["drop", "pop", "fade", "rise", "none"],
|
|
280
322
|
};
|
|
281
323
|
|
|
282
|
-
/** Whether an overlay types its text in: the `type` entrance,
|
|
324
|
+
/** Whether an overlay types its text in: the `type` entrance, a search bar without another entrance, or a note strip. */
|
|
283
325
|
export function isTypedOverlay(overlay: Pick<EdlOverlay, "kind" | "style">): boolean {
|
|
284
326
|
const entrance = overlay.style?.entrance;
|
|
285
|
-
return entrance === "type" || (overlay.kind === "search_bar" && entrance === undefined);
|
|
327
|
+
return entrance === "type" || (overlay.kind === "search_bar" && entrance === undefined) || (overlay.kind === "note" && overlay.style?.note_style === "strip");
|
|
286
328
|
}
|
|
287
329
|
|
|
288
330
|
const overlayText = z.string().trim().min(1, "is empty");
|
|
@@ -296,7 +338,11 @@ function checkOverlayFields(overlay: EdlOverlay, issue: (path: string[], message
|
|
|
296
338
|
const { kind } = overlay;
|
|
297
339
|
const fields = KIND_FIELDS[kind];
|
|
298
340
|
if ((overlay.at_word === undefined) === (overlay.at === undefined)) issue([], "needs exactly one of at_word and at");
|
|
299
|
-
if (kind
|
|
341
|
+
if (kind === "end_word") {
|
|
342
|
+
// Below MIN_END_WORD_SECONDS the field's own minimum refuses it.
|
|
343
|
+
if (overlay.duration > MAX_END_WORD_SECONDS) issue(["duration"], `an end_word stays ${MIN_END_WORD_SECONDS} to ${MAX_END_WORD_SECONDS} s`);
|
|
344
|
+
} else if (overlay.duration < MIN_OVERLAY_SECONDS) issue(["duration"], `${article(kind)} stays at least ${MIN_OVERLAY_SECONDS} s (only an end_word stays shorter)`);
|
|
345
|
+
else if (kind !== "hook_title" && overlay.duration > MAX_OVERLAY_SECONDS) issue(["duration"], `${article(kind)} stays at most ${MAX_OVERLAY_SECONDS} s (only a hook_title stays longer)`);
|
|
300
346
|
if (fields.text === "required" && overlay.text === undefined) issue(["text"], `${article(kind)} needs its text`);
|
|
301
347
|
if (fields.text === "none" && overlay.text !== undefined) issue(["text"], `${article(kind)} draws no text; leave it out`);
|
|
302
348
|
const limit = TEXT_LIMITS[kind];
|
|
@@ -339,7 +385,7 @@ function checkOverlayStyle(overlay: EdlOverlay, issue: (path: string[], message:
|
|
|
339
385
|
if (style.entrance !== undefined && !entrances.includes(style.entrance)) {
|
|
340
386
|
issue(["style", "entrance"], entrances.length === 0 ? `${article(kind)} has no entrance; leave it out` : `${article(kind)} enters by ${entrances.join(", ")}`);
|
|
341
387
|
}
|
|
342
|
-
if (style.typing_speed !== undefined && !isTypedOverlay(overlay)) issue(["style", "typing_speed"], "only a typed entrance
|
|
388
|
+
if (style.typing_speed !== undefined && !isTypedOverlay(overlay)) issue(["style", "typing_speed"], "only a typed entrance, a search bar or a note strip has a typing speed");
|
|
343
389
|
if (style.corner_radius !== undefined && (kind === "punch_in" || kind === "arrow" || kind === "highlight")) issue(["style", "corner_radius"], `${article(kind)} draws no card; leave corner_radius out`);
|
|
344
390
|
if (style.align !== undefined) {
|
|
345
391
|
if (kind === "keyword") {
|
|
@@ -353,6 +399,10 @@ function checkOverlayStyle(overlay: EdlOverlay, issue: (path: string[], message:
|
|
|
353
399
|
if (style.stagger !== undefined && kind !== "list") issue(["style", "stagger"], "only a list has points to stagger; leave stagger out");
|
|
354
400
|
if (style.list_layout !== undefined && kind !== "list") issue(["style", "list_layout"], "only a list lays out points; leave list_layout out");
|
|
355
401
|
if (style.underline !== undefined && kind !== "keyword") issue(["style", "underline"], "only a keyword is underlined; leave underline out");
|
|
402
|
+
if (style.backdrop !== undefined && !OVERLAY_BACKDROP_KINDS.includes(kind)) issue(["style", "backdrop"], "only a hook_title or a keyword takes a backdrop; leave it out");
|
|
403
|
+
if (style.backdrop === "highlight" && style.underline === true) issue(["style", "backdrop"], "a highlighted keyword draws no underline; give backdrop highlight or underline, not both");
|
|
404
|
+
if (style.note_style !== undefined && kind !== "note") issue(["style", "note_style"], "only a note has a note_style; leave it out");
|
|
405
|
+
if (style.tick !== undefined && kind !== "note") issue(["style", "tick"], "only a note draws a tick; leave it out");
|
|
356
406
|
if ((style.exit !== undefined || style.easing !== undefined) && kind === "punch_in") issue(["style", style.exit === undefined ? "easing" : "exit"], "a punch_in eases the picture itself; leave exit and easing out");
|
|
357
407
|
if (style.colors === undefined) return;
|
|
358
408
|
if (kind === "punch_in") issue(["style", "colors"], "a punch_in draws nothing to colour; leave colors out");
|
|
@@ -365,7 +415,7 @@ export const overlaySchema = z
|
|
|
365
415
|
.strictObject({
|
|
366
416
|
kind: z
|
|
367
417
|
.enum(OVERLAY_KINDS)
|
|
368
|
-
.describe("punch_in (an emphasis zoom on a word), keyword, lower_third, list, arrow, highlight, hook_title, search_bar, place_card, counter or
|
|
418
|
+
.describe("punch_in (an emphasis zoom on a word), keyword, lower_third, list, arrow, highlight, hook_title, search_bar, place_card, counter, date_stamp, note or end_word."),
|
|
369
419
|
at_word: z
|
|
370
420
|
.strictObject({
|
|
371
421
|
text: overlayText.describe("The word as the transcript has it; compared without case and punctuation."),
|
|
@@ -376,13 +426,13 @@ export const overlaySchema = z
|
|
|
376
426
|
at: z.number().min(0).optional().describe("The film second the overlay starts at; give this or at_word."),
|
|
377
427
|
duration: z
|
|
378
428
|
.number()
|
|
379
|
-
.min(
|
|
429
|
+
.min(MIN_END_WORD_SECONDS)
|
|
380
430
|
.max(MAX_HOOK_TITLE_SECONDS)
|
|
381
|
-
.describe(`Seconds on screen (${MIN_OVERLAY_SECONDS}-${MAX_OVERLAY_SECONDS}; a hook_title up to ${MAX_HOOK_TITLE_SECONDS}).`),
|
|
431
|
+
.describe(`Seconds on screen (${MIN_OVERLAY_SECONDS}-${MAX_OVERLAY_SECONDS}; a hook_title up to ${MAX_HOOK_TITLE_SECONDS}; an end_word ${MIN_END_WORD_SECONDS}-${MAX_END_WORD_SECONDS}).`),
|
|
382
432
|
text: overlayText
|
|
383
433
|
.optional()
|
|
384
434
|
.describe(
|
|
385
|
-
`The text: keyword (up to ${MAX_OVERLAY_KEYWORD_LENGTH} characters), lower_third (${MAX_OVERLAY_LOWER_THIRD_LENGTH}), hook_title (${MAX_OVERLAY_HOOK_TITLE_LENGTH}, one or two lines), search_bar (${MAX_OVERLAY_SEARCH_LENGTH}), place_card title (${MAX_OVERLAY_PLACE_TITLE_LENGTH})
|
|
435
|
+
`The text: keyword (up to ${MAX_OVERLAY_KEYWORD_LENGTH} characters), lower_third (${MAX_OVERLAY_LOWER_THIRD_LENGTH}), hook_title (${MAX_OVERLAY_HOOK_TITLE_LENGTH}, one or two lines), search_bar (${MAX_OVERLAY_SEARCH_LENGTH}), place_card title (${MAX_OVERLAY_PLACE_TITLE_LENGTH}), date_stamp (${MAX_OVERLAY_DATE_LENGTH}), note (${MAX_OVERLAY_NOTE_LENGTH}) or end_word (${MAX_OVERLAY_END_WORD_LENGTH}, one line).`,
|
|
386
436
|
),
|
|
387
437
|
items: z
|
|
388
438
|
.array(overlayText.max(MAX_OVERLAY_LIST_ITEM_LENGTH, `is longer than ${MAX_OVERLAY_LIST_ITEM_LENGTH} characters`))
|
|
@@ -433,16 +483,16 @@ export const overlaySchema = z
|
|
|
433
483
|
style: z
|
|
434
484
|
.strictObject({
|
|
435
485
|
size: z.enum(OVERLAY_SIZES).optional().describe("s, m (the default) or l: the punch-in's zoom (108, 112, 115 %) or the type size."),
|
|
436
|
-
side: z.enum(OVERLAY_SIDES).optional().describe("The side a keyword, lower third, list
|
|
486
|
+
side: z.enum(OVERLAY_SIDES).optional().describe("The side a keyword, lower third, list, date stamp or note sits on."),
|
|
437
487
|
position: z
|
|
438
488
|
.enum(OVERLAY_POSITIONS)
|
|
439
489
|
.optional()
|
|
440
|
-
.describe("top, middle or bottom of the room above the captions: keyword, search_bar, place_card, counter (any), lower_third (top or bottom), list (top or middle)."),
|
|
490
|
+
.describe("top, middle or bottom of the room above the captions: keyword, search_bar, place_card, counter (any), lower_third (top or bottom), list and note (top or middle)."),
|
|
441
491
|
entrance: z
|
|
442
492
|
.enum(OVERLAY_ENTRANCES)
|
|
443
493
|
.optional()
|
|
444
494
|
.describe(
|
|
445
|
-
"fade, slide, type (text typed in letter by letter), none, pop (92 % to 100 %, no overshoot), rise (up from 5 % of the height), blur (blurred to sharp)
|
|
495
|
+
"fade, slide, type (text typed in letter by letter), none, pop (92 % to 100 %, no overshoot), rise (up from 5 % of the height), blur (blurred to sharp), wipe (card revealed from the left in the accent, then the text) or drop (hook_title, keyword, end_word: letters fall into place one by one, never below their line); without it the kind's own. Never a bounce.",
|
|
446
496
|
),
|
|
447
497
|
exit: z.enum(OVERLAY_EXITS).optional().describe("auto (the default: mirrors the entrance), fade, slide (down and out) or none."),
|
|
448
498
|
easing: z.enum(OVERLAY_EASINGS).optional().describe("smooth (the default) or snappy: the curve of the entrance and the exit."),
|
|
@@ -486,6 +536,15 @@ export const overlaySchema = z
|
|
|
486
536
|
.describe(`A place_card only: seconds its subtitle waits after its title (0-${MAX_OVERLAY_SUBTITLE_DELAY}).`),
|
|
487
537
|
pin: z.enum(OVERLAY_PINS).optional().describe("A place_card only: none (the default), static or drop (an accent pin above the title that falls a little and stops)."),
|
|
488
538
|
underline: z.boolean().optional().describe("A keyword only: an accent bar drawn under the word after it enters."),
|
|
539
|
+
backdrop: z
|
|
540
|
+
.enum(OVERLAY_BACKDROPS)
|
|
541
|
+
.optional()
|
|
542
|
+
.describe("A hook_title or keyword only: card (the default) or highlight (each line on its own tight box in the card colour; typed in, the box grows with the letters)."),
|
|
543
|
+
note_style: z
|
|
544
|
+
.enum(OVERLAY_NOTE_STYLES)
|
|
545
|
+
.optional()
|
|
546
|
+
.describe("A note only: card (the default: a tilted paper card, handwritten words appearing as they are said) or strip (a torn paper strip that grows in, then types its text in capitals)."),
|
|
547
|
+
tick: z.boolean().optional().describe("A note only: a hand-drawn tick after its last word."),
|
|
489
548
|
})
|
|
490
549
|
.optional()
|
|
491
550
|
.describe("The overlay's look: size, side, position, entrance, typing speed and colours; fonts are the brand's."),
|