@sudobility/screenwriter_types 0.1.2 → 0.1.4

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.
Files changed (8) hide show
  1. package/CLAUDE.md +4 -0
  2. package/dist/ai/actions.d.ts +691 -0
  3. package/dist/api/routes.d.ts +4 -0
  4. package/dist/index.d.ts +1 -0
  5. package/dist/index.js +232 -1
  6. package/dist/index.js.map +1 -1
  7. package/dist/templates/index.d.ts +18 -9
  8. package/package.json +1 -1
package/dist/templates/index.d.ts CHANGED
@@ -14,8 +14,16 @@ export interface TemplateSummary {
14
14
  latestVersion: number;
15
15
  /** A first-page thumbnail was rendered (`template.thumbnail` job). Built-ins use static assets, so this is false for them. */
16
16
  hasThumbnail: boolean;
17
+ /**
18
+ * BCP-47 (writing_core's `TemplateJSON.locale`), set only for `scope: 'builtin'` — the catalogue's language
19
+ * variants (screenplay-standard, tv-one-hour, ...) each carry one. `user`/`workspace` templates have no locale
20
+ * concept (they're the caller's own authored content, not language variants of a catalog) and never set this.
21
+ */
22
+ locale?: string;
17
23
  }
18
- /** `GET /templates` query: user templates always; `workspaceId` adds that workspace's; `scope` narrows. */
24
+ /** `GET /templates` query: user templates always; `workspaceId` adds that workspace's; `scope` narrows.
25
+ * `locale` filters built-ins to one BCP-47 language (e.g. the app's current UI language); user/workspace templates
26
+ * are never filtered by it, since they have no locale of their own. */
19
27
  export declare const templateListQuerySchema: z.ZodObject<{
20
28
  category: z.ZodOptional<z.ZodString>;
21
29
  workspaceId: z.ZodOptional<z.ZodString>;
@@ -24,6 +32,7 @@ export declare const templateListQuerySchema: z.ZodObject<{
24
32
  builtin: "builtin";
25
33
  user: "user";
26
34
  }>>;
35
+ locale: z.ZodOptional<z.ZodString>;
27
36
  }, z.core.$strip>;
28
37
  export type TemplateListQuery = z.infer<typeof templateListQuerySchema>;
29
38
  /** `GET /templates/:tid?version=`: an older version of a user/workspace template (immutable). */
@@ -90,7 +99,7 @@ export declare const templateCreateSchema: z.ZodObject<{
90
99
  id: import("@sudobility/writing_core").StyleId;
91
100
  name: string;
92
101
  nameKey: string | null;
93
- role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "synopsis" | "parenthetical" | "normal" | "sceneHeading" | "transition" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
102
+ role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "parenthetical" | "transition" | "synopsis" | "normal" | "sceneHeading" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
94
103
  basedOn: import("@sudobility/writing_core").StyleId | null;
95
104
  shortcut: number | null;
96
105
  font: {
@@ -158,7 +167,7 @@ export declare const templateCreateSchema: z.ZodObject<{
158
167
  id: import("@sudobility/writing_core").StyleId;
159
168
  name: string;
160
169
  nameKey: string | null;
161
- role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "synopsis" | "parenthetical" | "normal" | "sceneHeading" | "transition" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
170
+ role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "parenthetical" | "transition" | "synopsis" | "normal" | "sceneHeading" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
162
171
  basedOn: import("@sudobility/writing_core").StyleId | null;
163
172
  shortcut: number | null;
164
173
  font: {
@@ -490,7 +499,7 @@ export declare const templateCreateSchema: z.ZodObject<{
490
499
  id: import("@sudobility/writing_core").StyleId;
491
500
  name: string;
492
501
  nameKey: string | null;
493
- role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "synopsis" | "parenthetical" | "normal" | "sceneHeading" | "transition" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
502
+ role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "parenthetical" | "transition" | "synopsis" | "normal" | "sceneHeading" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
494
503
  basedOn: import("@sudobility/writing_core").StyleId | null;
495
504
  shortcut: number | null;
496
505
  font: {
@@ -558,7 +567,7 @@ export declare const templateCreateSchema: z.ZodObject<{
558
567
  id: import("@sudobility/writing_core").StyleId;
559
568
  name: string;
560
569
  nameKey: string | null;
561
- role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "synopsis" | "parenthetical" | "normal" | "sceneHeading" | "transition" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
570
+ role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "parenthetical" | "transition" | "synopsis" | "normal" | "sceneHeading" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
562
571
  basedOn: import("@sudobility/writing_core").StyleId | null;
563
572
  shortcut: number | null;
564
573
  font: {
@@ -894,7 +903,7 @@ export declare const templateVersionCreateSchema: z.ZodObject<{
894
903
  id: import("@sudobility/writing_core").StyleId;
895
904
  name: string;
896
905
  nameKey: string | null;
897
- role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "synopsis" | "parenthetical" | "normal" | "sceneHeading" | "transition" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
906
+ role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "parenthetical" | "transition" | "synopsis" | "normal" | "sceneHeading" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
898
907
  basedOn: import("@sudobility/writing_core").StyleId | null;
899
908
  shortcut: number | null;
900
909
  font: {
@@ -962,7 +971,7 @@ export declare const templateVersionCreateSchema: z.ZodObject<{
962
971
  id: import("@sudobility/writing_core").StyleId;
963
972
  name: string;
964
973
  nameKey: string | null;
965
- role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "synopsis" | "parenthetical" | "normal" | "sceneHeading" | "transition" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
974
+ role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "parenthetical" | "transition" | "synopsis" | "normal" | "sceneHeading" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
966
975
  basedOn: import("@sudobility/writing_core").StyleId | null;
967
976
  shortcut: number | null;
968
977
  font: {
@@ -1294,7 +1303,7 @@ export declare const templateVersionCreateSchema: z.ZodObject<{
1294
1303
  id: import("@sudobility/writing_core").StyleId;
1295
1304
  name: string;
1296
1305
  nameKey: string | null;
1297
- role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "synopsis" | "parenthetical" | "normal" | "sceneHeading" | "transition" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
1306
+ role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "parenthetical" | "transition" | "synopsis" | "normal" | "sceneHeading" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
1298
1307
  basedOn: import("@sudobility/writing_core").StyleId | null;
1299
1308
  shortcut: number | null;
1300
1309
  font: {
@@ -1362,7 +1371,7 @@ export declare const templateVersionCreateSchema: z.ZodObject<{
1362
1371
  id: import("@sudobility/writing_core").StyleId;
1363
1372
  name: string;
1364
1373
  nameKey: string | null;
1365
- role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "synopsis" | "parenthetical" | "normal" | "sceneHeading" | "transition" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
1374
+ role: "outline" | "action" | "character" | "dialogue" | "page" | "note" | "shot" | "parenthetical" | "transition" | "synopsis" | "normal" | "sceneHeading" | "lyrics" | "castList" | "actStart" | "actEnd" | "sequence" | "notation" | "soundCue" | "panel" | "chapter" | "paragraph" | "subheading" | "quotation" | "blockText" | "chapterEnd" | "titleText";
1366
1375
  basedOn: import("@sudobility/writing_core").StyleId | null;
1367
1376
  shortcut: number | null;
1368
1377
  font: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sudobility/screenwriter_types",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "description": "Shared TypeScript types and Zod schemas for the Fadewright frontend and backend",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",