busroot-sdk 0.0.8-dev.2732686340 → 0.0.8-dev.2732994359

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 (3) hide show
  1. package/build/index.d.ts +21 -0
  2. package/build/index.js +8 -2
  3. package/package.json +1 -1
package/build/index.d.ts CHANGED
@@ -195,6 +195,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
195
195
  pattern: string;
196
196
  availableBeforeDeadlineMinutes?: number | undefined;
197
197
  }>]>>;
198
+ requireNotes: z.ZodOptional<z.ZodBoolean>;
198
199
  }, "strict", z.ZodTypeAny, {
199
200
  code: string;
200
201
  title: string;
@@ -206,10 +207,12 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
206
207
  pattern: string;
207
208
  availableBeforeDeadlineMinutes?: number | undefined;
208
209
  };
210
+ requireNotes?: boolean | undefined;
209
211
  }, {
210
212
  code: string;
211
213
  title: string;
212
214
  description: string;
215
+ requireNotes?: boolean | undefined;
213
216
  frequency?: {
214
217
  type: "schedule";
215
218
  } | {
@@ -952,6 +955,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
952
955
  pattern: string;
953
956
  availableBeforeDeadlineMinutes?: number | undefined;
954
957
  };
958
+ requireNotes?: boolean | undefined;
955
959
  }[] | undefined;
956
960
  skus?: {
957
961
  code: string;
@@ -1118,6 +1122,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1118
1122
  code: string;
1119
1123
  title: string;
1120
1124
  description: string;
1125
+ requireNotes?: boolean | undefined;
1121
1126
  frequency?: {
1122
1127
  type: "schedule";
1123
1128
  } | {
@@ -1300,6 +1305,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1300
1305
  pattern: string;
1301
1306
  availableBeforeDeadlineMinutes?: number | undefined;
1302
1307
  };
1308
+ requireNotes?: boolean | undefined;
1303
1309
  }[] | undefined;
1304
1310
  skus?: {
1305
1311
  code: string;
@@ -1469,6 +1475,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1469
1475
  code: string;
1470
1476
  title: string;
1471
1477
  description: string;
1478
+ requireNotes?: boolean | undefined;
1472
1479
  frequency?: {
1473
1480
  type: "schedule";
1474
1481
  } | {
@@ -1652,6 +1659,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1652
1659
  pattern: string;
1653
1660
  availableBeforeDeadlineMinutes?: number | undefined;
1654
1661
  };
1662
+ requireNotes?: boolean | undefined;
1655
1663
  }[] | undefined;
1656
1664
  skus?: {
1657
1665
  code: string;
@@ -1821,6 +1829,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1821
1829
  code: string;
1822
1830
  title: string;
1823
1831
  description: string;
1832
+ requireNotes?: boolean | undefined;
1824
1833
  frequency?: {
1825
1834
  type: "schedule";
1826
1835
  } | {
@@ -2008,6 +2017,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
2008
2017
  pattern: string;
2009
2018
  availableBeforeDeadlineMinutes?: number | undefined;
2010
2019
  };
2020
+ requireNotes?: boolean | undefined;
2011
2021
  }[] | undefined;
2012
2022
  skus?: {
2013
2023
  code: string;
@@ -2211,6 +2221,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
2211
2221
  code: string;
2212
2222
  title: string;
2213
2223
  description: string;
2224
+ requireNotes?: boolean | undefined;
2214
2225
  frequency?: {
2215
2226
  type: "schedule";
2216
2227
  } | {
@@ -2574,6 +2585,7 @@ declare class BusrootClient {
2574
2585
  code: string;
2575
2586
  title: string;
2576
2587
  description: string;
2588
+ requireNotes?: boolean | undefined;
2577
2589
  frequency?: {
2578
2590
  type: "schedule";
2579
2591
  } | {
@@ -2790,6 +2802,7 @@ declare class BusrootClient {
2790
2802
  code: string;
2791
2803
  title: string;
2792
2804
  description: string;
2805
+ requireNotes?: boolean | undefined;
2793
2806
  frequency?: {
2794
2807
  type: "schedule";
2795
2808
  } | {
@@ -3280,6 +3293,7 @@ declare class BusrootClient {
3280
3293
  code: string;
3281
3294
  title: string;
3282
3295
  description: string;
3296
+ requireNotes?: boolean | undefined;
3283
3297
  frequency?: {
3284
3298
  type: "schedule";
3285
3299
  } | {
@@ -3851,10 +3865,12 @@ declare class BusrootClient {
3851
3865
  pattern: string;
3852
3866
  availableBeforeDeadlineMinutes?: number | undefined;
3853
3867
  };
3868
+ requireNotes?: boolean | undefined;
3854
3869
  }, ...args: unknown[]) => Promise<{
3855
3870
  code: string;
3856
3871
  title: string;
3857
3872
  description: string;
3873
+ requireNotes?: boolean | undefined;
3858
3874
  frequency?: {
3859
3875
  type: "schedule";
3860
3876
  } | {
@@ -6009,6 +6025,7 @@ declare const StationViewModel: z.ZodObject<{
6009
6025
  pattern: string;
6010
6026
  availableBeforeDeadlineMinutes?: number | undefined;
6011
6027
  }>]>>;
6028
+ requireNotes: z.ZodOptional<z.ZodBoolean>;
6012
6029
  } & {
6013
6030
  completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
6014
6031
  completedOperatorInitials: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -6025,6 +6042,7 @@ declare const StationViewModel: z.ZodObject<{
6025
6042
  pattern: string;
6026
6043
  availableBeforeDeadlineMinutes?: number | undefined;
6027
6044
  };
6045
+ requireNotes?: boolean | undefined;
6028
6046
  completedAt?: string | null | undefined;
6029
6047
  completedOperatorInitials?: string | null | undefined;
6030
6048
  periodStartAt?: string | null | undefined;
@@ -6033,6 +6051,7 @@ declare const StationViewModel: z.ZodObject<{
6033
6051
  code: string;
6034
6052
  title: string;
6035
6053
  description: string;
6054
+ requireNotes?: boolean | undefined;
6036
6055
  frequency?: {
6037
6056
  type: "schedule";
6038
6057
  } | {
@@ -6198,6 +6217,7 @@ declare const StationViewModel: z.ZodObject<{
6198
6217
  pattern: string;
6199
6218
  availableBeforeDeadlineMinutes?: number | undefined;
6200
6219
  };
6220
+ requireNotes?: boolean | undefined;
6201
6221
  completedAt?: string | null | undefined;
6202
6222
  completedOperatorInitials?: string | null | undefined;
6203
6223
  periodStartAt?: string | null | undefined;
@@ -6349,6 +6369,7 @@ declare const StationViewModel: z.ZodObject<{
6349
6369
  code: string;
6350
6370
  title: string;
6351
6371
  description: string;
6372
+ requireNotes?: boolean | undefined;
6352
6373
  frequency?: {
6353
6374
  type: "schedule";
6354
6375
  } | {
package/build/index.js CHANGED
@@ -174,7 +174,10 @@ var require_task = __commonJS({
174
174
  code: zod_1.z.string().describe("Unique Task code used to reference this procedure (e.g., 'TASK-001', 'STARTUP-CHECK'). Must be unique within the account."),
175
175
  title: zod_1.z.string().describe("Human-readable title of the Task (e.g., 'Machine Startup Checklist', 'Quality Inspection Procedure')"),
176
176
  description: zod_1.z.string().describe("Detailed description of the Task and its purpose"),
177
- frequency: exports2.TaskFrequencySchema.default({ type: exports2.TASK_FREQUENCY_TYPE_SCHEDULE })
177
+ frequency: exports2.TaskFrequencySchema.default({ type: exports2.TASK_FREQUENCY_TYPE_SCHEDULE }),
178
+ // Optional at the schema level so pre-existing Tasks (written before this field existed) still
179
+ // parse — absent means notes are not required, the pre-feature behaviour.
180
+ requireNotes: zod_1.z.boolean().optional().describe("When enabled, operators must enter notes before this Task can be confirmed as complete.")
178
181
  }).strict();
179
182
  }
180
183
  });
@@ -2549,7 +2552,10 @@ var require_task_completion = __commonJS({
2549
2552
  expectedAt: zod_1.z.string(),
2550
2553
  completedAt: zod_1.z.string().nullish(),
2551
2554
  completedUserId: zod_1.z.number().nullish(),
2552
- completedOperatorInitials: zod_1.z.string().nullish()
2555
+ completedOperatorInitials: zod_1.z.string().nullish(),
2556
+ // Free-text detail recorded at completion time. Mandatory when the Task has `requireNotes` —
2557
+ // enforced at the completion API, not here, so expectation rows can be written noteless.
2558
+ note: zod_1.z.string().nullish()
2553
2559
  }).refine((v) => v.scheduleId == null !== (v.periodStartAt == null), "Exactly one of scheduleId or periodStartAt must be set on a Task completion");
2554
2560
  }
2555
2561
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "busroot-sdk",
3
- "version": "0.0.8-dev.2732686340",
3
+ "version": "0.0.8-dev.2732994359",
4
4
  "description": "An SDK for accessing Busroot from output.industries",
5
5
  "homepage": "https://www.output.industries",
6
6
  "main": "./build/index.js",