@tutorialkit-rb/types 0.1.4 → 0.1.6

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/dist/schemas/chapter.d.ts +3 -0
  2. package/dist/schemas/common.d.ts +9 -0
  3. package/dist/schemas/common.js +6 -0
  4. package/dist/schemas/content.d.ts +12 -0
  5. package/dist/schemas/lesson.d.ts +3 -0
  6. package/dist/schemas/part.d.ts +3 -0
  7. package/dist/schemas/tutorial.d.ts +3 -0
  8. package/package.json +1 -1
package/dist/schemas/chapter.d.ts CHANGED
@@ -20,6 +20,7 @@ export declare const chapterSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
20
20
  title: string;
21
21
  command: string;
22
22
  }>]>, "many">>;
23
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
23
24
  }, {
24
25
  meta: z.ZodOptional<z.ZodObject<{
25
26
  image: z.ZodOptional<z.ZodString>;
@@ -233,6 +234,7 @@ export declare const chapterSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
233
234
  title: string;
234
235
  command: string;
235
236
  })[] | undefined;
237
+ terminalBlockingPrepareCommandsCount?: number | undefined;
236
238
  terminal?: boolean | {
237
239
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
238
240
  type: "output" | "terminal";
@@ -310,6 +312,7 @@ export declare const chapterSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
310
312
  title: string;
311
313
  command: string;
312
314
  })[] | undefined;
315
+ terminalBlockingPrepareCommandsCount?: number | undefined;
313
316
  terminal?: boolean | {
314
317
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
315
318
  type: "output" | "terminal";
package/dist/schemas/common.d.ts CHANGED
@@ -31,6 +31,7 @@ export declare const commandsSchema: z.ZodObject<{
31
31
  title: string;
32
32
  command: string;
33
33
  }>]>, "many">>;
34
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
34
35
  }, "strip", z.ZodTypeAny, {
35
36
  mainCommand?: string | [string, string] | {
36
37
  title: string;
@@ -40,6 +41,7 @@ export declare const commandsSchema: z.ZodObject<{
40
41
  title: string;
41
42
  command: string;
42
43
  })[] | undefined;
44
+ terminalBlockingPrepareCommandsCount?: number | undefined;
43
45
  }, {
44
46
  mainCommand?: string | [string, string] | {
45
47
  title: string;
@@ -49,6 +51,7 @@ export declare const commandsSchema: z.ZodObject<{
49
51
  title: string;
50
52
  command: string;
51
53
  })[] | undefined;
54
+ terminalBlockingPrepareCommandsCount?: number | undefined;
52
55
  }>;
53
56
  export type CommandsSchema = z.infer<typeof commandsSchema>;
54
57
  export declare const previewSchema: z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodTuple<[z.ZodNumber, z.ZodString], null>, z.ZodTuple<[z.ZodNumber, z.ZodString, z.ZodString], null>, z.ZodObject<{
@@ -178,6 +181,7 @@ export declare const webcontainerSchema: z.ZodObject<z.objectUtil.extendShape<{
178
181
  title: string;
179
182
  command: string;
180
183
  }>]>, "many">>;
184
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
181
185
  }, {
182
186
  meta: z.ZodOptional<z.ZodObject<{
183
187
  image: z.ZodOptional<z.ZodString>;
@@ -383,6 +387,7 @@ export declare const webcontainerSchema: z.ZodObject<z.objectUtil.extendShape<{
383
387
  title: string;
384
388
  command: string;
385
389
  })[] | undefined;
390
+ terminalBlockingPrepareCommandsCount?: number | undefined;
386
391
  terminal?: boolean | {
387
392
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
388
393
  type: "output" | "terminal";
@@ -456,6 +461,7 @@ export declare const webcontainerSchema: z.ZodObject<z.objectUtil.extendShape<{
456
461
  title: string;
457
462
  command: string;
458
463
  })[] | undefined;
464
+ terminalBlockingPrepareCommandsCount?: number | undefined;
459
465
  terminal?: boolean | {
460
466
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
461
467
  type: "output" | "terminal";
@@ -541,6 +547,7 @@ export declare const baseSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUt
541
547
  title: string;
542
548
  command: string;
543
549
  }>]>, "many">>;
550
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
544
551
  }, {
545
552
  meta: z.ZodOptional<z.ZodObject<{
546
553
  image: z.ZodOptional<z.ZodString>;
@@ -750,6 +757,7 @@ export declare const baseSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUt
750
757
  title: string;
751
758
  command: string;
752
759
  })[] | undefined;
760
+ terminalBlockingPrepareCommandsCount?: number | undefined;
753
761
  terminal?: boolean | {
754
762
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
755
763
  type: "output" | "terminal";
@@ -825,6 +833,7 @@ export declare const baseSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUt
825
833
  title: string;
826
834
  command: string;
827
835
  })[] | undefined;
836
+ terminalBlockingPrepareCommandsCount?: number | undefined;
828
837
  terminal?: boolean | {
829
838
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
830
839
  type: "output" | "terminal";
package/dist/schemas/common.js CHANGED
@@ -17,6 +17,12 @@ export const commandsSchema = z.object({
17
17
  .array()
18
18
  .optional()
19
19
  .describe('List of commands to be executed to prepare the environment in WebContainer. Each command executed and its status will be shown in the Prepare Environment section.'),
20
+ terminalBlockingPrepareCommandsCount: z
21
+ .number()
22
+ .int()
23
+ .min(0)
24
+ .optional()
25
+ .describe('Number of prepare commands that should block terminal input. If set, only the first N prepare commands will block the terminal. If not set, terminal is not blocked during prepare commands.'),
20
26
  });
21
27
  export const previewSchema = z.union([
22
28
  // `false` if you want to disable the preview entirely
package/dist/schemas/content.d.ts CHANGED
@@ -20,6 +20,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
20
20
  title: string;
21
21
  command: string;
22
22
  }>]>, "many">>;
23
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
23
24
  }, {
24
25
  meta: z.ZodOptional<z.ZodObject<{
25
26
  image: z.ZodOptional<z.ZodString>;
@@ -231,6 +232,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
231
232
  title: string;
232
233
  command: string;
233
234
  })[] | undefined;
235
+ terminalBlockingPrepareCommandsCount?: number | undefined;
234
236
  terminal?: boolean | {
235
237
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
236
238
  type: "output" | "terminal";
@@ -308,6 +310,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
308
310
  title: string;
309
311
  command: string;
310
312
  })[] | undefined;
313
+ terminalBlockingPrepareCommandsCount?: number | undefined;
311
314
  terminal?: boolean | {
312
315
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
313
316
  type: "output" | "terminal";
@@ -395,6 +398,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
395
398
  title: string;
396
399
  command: string;
397
400
  }>]>, "many">>;
401
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
398
402
  }, {
399
403
  meta: z.ZodOptional<z.ZodObject<{
400
404
  image: z.ZodOptional<z.ZodString>;
@@ -609,6 +613,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
609
613
  title: string;
610
614
  command: string;
611
615
  })[] | undefined;
616
+ terminalBlockingPrepareCommandsCount?: number | undefined;
612
617
  terminal?: boolean | {
613
618
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
614
619
  type: "output" | "terminal";
@@ -687,6 +692,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
687
692
  title: string;
688
693
  command: string;
689
694
  })[] | undefined;
695
+ terminalBlockingPrepareCommandsCount?: number | undefined;
690
696
  terminal?: boolean | {
691
697
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
692
698
  type: "output" | "terminal";
@@ -774,6 +780,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
774
780
  title: string;
775
781
  command: string;
776
782
  }>]>, "many">>;
783
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
777
784
  }, {
778
785
  meta: z.ZodOptional<z.ZodObject<{
779
786
  image: z.ZodOptional<z.ZodString>;
@@ -987,6 +994,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
987
994
  title: string;
988
995
  command: string;
989
996
  })[] | undefined;
997
+ terminalBlockingPrepareCommandsCount?: number | undefined;
990
998
  terminal?: boolean | {
991
999
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
992
1000
  type: "output" | "terminal";
@@ -1064,6 +1072,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
1064
1072
  title: string;
1065
1073
  command: string;
1066
1074
  })[] | undefined;
1075
+ terminalBlockingPrepareCommandsCount?: number | undefined;
1067
1076
  terminal?: boolean | {
1068
1077
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
1069
1078
  type: "output" | "terminal";
@@ -1150,6 +1159,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
1150
1159
  title: string;
1151
1160
  command: string;
1152
1161
  }>]>, "many">>;
1162
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
1153
1163
  }, {
1154
1164
  meta: z.ZodOptional<z.ZodObject<{
1155
1165
  image: z.ZodOptional<z.ZodString>;
@@ -1364,6 +1374,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
1364
1374
  title: string;
1365
1375
  command: string;
1366
1376
  })[] | undefined;
1377
+ terminalBlockingPrepareCommandsCount?: number | undefined;
1367
1378
  terminal?: boolean | {
1368
1379
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
1369
1380
  type: "output" | "terminal";
@@ -1442,6 +1453,7 @@ export declare const contentSchema: z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodObj
1442
1453
  title: string;
1443
1454
  command: string;
1444
1455
  })[] | undefined;
1456
+ terminalBlockingPrepareCommandsCount?: number | undefined;
1445
1457
  terminal?: boolean | {
1446
1458
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
1447
1459
  type: "output" | "terminal";
package/dist/schemas/lesson.d.ts CHANGED
@@ -20,6 +20,7 @@ export declare const lessonSchema: z.ZodObject<z.objectUtil.extendShape<z.object
20
20
  title: string;
21
21
  command: string;
22
22
  }>]>, "many">>;
23
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
23
24
  }, {
24
25
  meta: z.ZodOptional<z.ZodObject<{
25
26
  image: z.ZodOptional<z.ZodString>;
@@ -234,6 +235,7 @@ export declare const lessonSchema: z.ZodObject<z.objectUtil.extendShape<z.object
234
235
  title: string;
235
236
  command: string;
236
237
  })[] | undefined;
238
+ terminalBlockingPrepareCommandsCount?: number | undefined;
237
239
  terminal?: boolean | {
238
240
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
239
241
  type: "output" | "terminal";
@@ -312,6 +314,7 @@ export declare const lessonSchema: z.ZodObject<z.objectUtil.extendShape<z.object
312
314
  title: string;
313
315
  command: string;
314
316
  })[] | undefined;
317
+ terminalBlockingPrepareCommandsCount?: number | undefined;
315
318
  terminal?: boolean | {
316
319
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
317
320
  type: "output" | "terminal";
package/dist/schemas/part.d.ts CHANGED
@@ -20,6 +20,7 @@ export declare const partSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUt
20
20
  title: string;
21
21
  command: string;
22
22
  }>]>, "many">>;
23
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
23
24
  }, {
24
25
  meta: z.ZodOptional<z.ZodObject<{
25
26
  image: z.ZodOptional<z.ZodString>;
@@ -234,6 +235,7 @@ export declare const partSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUt
234
235
  title: string;
235
236
  command: string;
236
237
  })[] | undefined;
238
+ terminalBlockingPrepareCommandsCount?: number | undefined;
237
239
  terminal?: boolean | {
238
240
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
239
241
  type: "output" | "terminal";
@@ -312,6 +314,7 @@ export declare const partSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUt
312
314
  title: string;
313
315
  command: string;
314
316
  })[] | undefined;
317
+ terminalBlockingPrepareCommandsCount?: number | undefined;
315
318
  terminal?: boolean | {
316
319
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
317
320
  type: "output" | "terminal";
package/dist/schemas/tutorial.d.ts CHANGED
@@ -20,6 +20,7 @@ export declare const tutorialSchema: z.ZodObject<z.objectUtil.extendShape<z.obje
20
20
  title: string;
21
21
  command: string;
22
22
  }>]>, "many">>;
23
+ terminalBlockingPrepareCommandsCount: z.ZodOptional<z.ZodNumber>;
23
24
  }, {
24
25
  meta: z.ZodOptional<z.ZodObject<{
25
26
  image: z.ZodOptional<z.ZodString>;
@@ -231,6 +232,7 @@ export declare const tutorialSchema: z.ZodObject<z.objectUtil.extendShape<z.obje
231
232
  title: string;
232
233
  command: string;
233
234
  })[] | undefined;
235
+ terminalBlockingPrepareCommandsCount?: number | undefined;
234
236
  terminal?: boolean | {
235
237
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
236
238
  type: "output" | "terminal";
@@ -308,6 +310,7 @@ export declare const tutorialSchema: z.ZodObject<z.objectUtil.extendShape<z.obje
308
310
  title: string;
309
311
  command: string;
310
312
  })[] | undefined;
313
+ terminalBlockingPrepareCommandsCount?: number | undefined;
311
314
  terminal?: boolean | {
312
315
  panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
313
316
  type: "output" | "terminal";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tutorialkit-rb/types",
3
- "version": "0.1.4",
3
+ "version": "0.1.6",
4
4
  "description": "Types for TutorialKit",
5
5
  "author": "StackBlitz Inc.",
6
6
  "type": "module",