busroot-sdk 0.0.8-dev.2756254166 → 0.0.8-dev.2758108576

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/build/index.d.ts CHANGED
@@ -173,7 +173,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
173
173
  tasks: z.ZodOptional<z.ZodArray<z.ZodObject<{
174
174
  code: z.ZodString;
175
175
  title: z.ZodString;
176
- description: z.ZodString;
176
+ description: z.ZodOptional<z.ZodString>;
177
177
  frequency: z.ZodDefault<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
178
178
  type: z.ZodLiteral<"schedule">;
179
179
  }, "strict", z.ZodTypeAny, {
@@ -198,7 +198,6 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
198
198
  }, "strict", z.ZodTypeAny, {
199
199
  code: string;
200
200
  title: string;
201
- description: string;
202
201
  frequency: {
203
202
  type: "schedule";
204
203
  } | {
@@ -206,12 +205,13 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
206
205
  pattern: string;
207
206
  availableBeforeDeadlineMinutes?: number | undefined;
208
207
  };
208
+ description?: string | undefined;
209
209
  requireNotes?: boolean | undefined;
210
210
  taskListCodes?: string[] | undefined;
211
211
  }, {
212
212
  code: string;
213
213
  title: string;
214
- description: string;
214
+ description?: string | undefined;
215
215
  requireNotes?: boolean | undefined;
216
216
  frequency?: {
217
217
  type: "schedule";
@@ -225,15 +225,15 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
225
225
  taskLists: z.ZodOptional<z.ZodArray<z.ZodObject<{
226
226
  code: z.ZodString;
227
227
  name: z.ZodString;
228
- description: z.ZodString;
228
+ description: z.ZodOptional<z.ZodString>;
229
229
  }, "strict", z.ZodTypeAny, {
230
230
  code: string;
231
231
  name: string;
232
- description: string;
232
+ description?: string | undefined;
233
233
  }, {
234
234
  code: string;
235
235
  name: string;
236
- description: string;
236
+ description?: string | undefined;
237
237
  }>, "many">>;
238
238
  skus: z.ZodOptional<z.ZodArray<z.ZodObject<{
239
239
  code: z.ZodString;
@@ -942,7 +942,6 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
942
942
  tasks?: {
943
943
  code: string;
944
944
  title: string;
945
- description: string;
946
945
  frequency: {
947
946
  type: "schedule";
948
947
  } | {
@@ -950,13 +949,14 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
950
949
  pattern: string;
951
950
  availableBeforeDeadlineMinutes?: number | undefined;
952
951
  };
952
+ description?: string | undefined;
953
953
  requireNotes?: boolean | undefined;
954
954
  taskListCodes?: string[] | undefined;
955
955
  }[] | undefined;
956
956
  taskLists?: {
957
957
  code: string;
958
958
  name: string;
959
- description: string;
959
+ description?: string | undefined;
960
960
  }[] | undefined;
961
961
  skus?: {
962
962
  code: string;
@@ -1118,7 +1118,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1118
1118
  tasks?: {
1119
1119
  code: string;
1120
1120
  title: string;
1121
- description: string;
1121
+ description?: string | undefined;
1122
1122
  requireNotes?: boolean | undefined;
1123
1123
  frequency?: {
1124
1124
  type: "schedule";
@@ -1132,7 +1132,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1132
1132
  taskLists?: {
1133
1133
  code: string;
1134
1134
  name: string;
1135
- description: string;
1135
+ description?: string | undefined;
1136
1136
  }[] | undefined;
1137
1137
  skus?: {
1138
1138
  code: string;
@@ -1296,7 +1296,6 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1296
1296
  tasks?: {
1297
1297
  code: string;
1298
1298
  title: string;
1299
- description: string;
1300
1299
  frequency: {
1301
1300
  type: "schedule";
1302
1301
  } | {
@@ -1304,13 +1303,14 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1304
1303
  pattern: string;
1305
1304
  availableBeforeDeadlineMinutes?: number | undefined;
1306
1305
  };
1306
+ description?: string | undefined;
1307
1307
  requireNotes?: boolean | undefined;
1308
1308
  taskListCodes?: string[] | undefined;
1309
1309
  }[] | undefined;
1310
1310
  taskLists?: {
1311
1311
  code: string;
1312
1312
  name: string;
1313
- description: string;
1313
+ description?: string | undefined;
1314
1314
  }[] | undefined;
1315
1315
  skus?: {
1316
1316
  code: string;
@@ -1475,7 +1475,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1475
1475
  tasks?: {
1476
1476
  code: string;
1477
1477
  title: string;
1478
- description: string;
1478
+ description?: string | undefined;
1479
1479
  requireNotes?: boolean | undefined;
1480
1480
  frequency?: {
1481
1481
  type: "schedule";
@@ -1489,7 +1489,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1489
1489
  taskLists?: {
1490
1490
  code: string;
1491
1491
  name: string;
1492
- description: string;
1492
+ description?: string | undefined;
1493
1493
  }[] | undefined;
1494
1494
  skus?: {
1495
1495
  code: string;
@@ -1654,7 +1654,6 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1654
1654
  tasks?: {
1655
1655
  code: string;
1656
1656
  title: string;
1657
- description: string;
1658
1657
  frequency: {
1659
1658
  type: "schedule";
1660
1659
  } | {
@@ -1662,13 +1661,14 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1662
1661
  pattern: string;
1663
1662
  availableBeforeDeadlineMinutes?: number | undefined;
1664
1663
  };
1664
+ description?: string | undefined;
1665
1665
  requireNotes?: boolean | undefined;
1666
1666
  taskListCodes?: string[] | undefined;
1667
1667
  }[] | undefined;
1668
1668
  taskLists?: {
1669
1669
  code: string;
1670
1670
  name: string;
1671
- description: string;
1671
+ description?: string | undefined;
1672
1672
  }[] | undefined;
1673
1673
  skus?: {
1674
1674
  code: string;
@@ -1833,7 +1833,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1833
1833
  tasks?: {
1834
1834
  code: string;
1835
1835
  title: string;
1836
- description: string;
1836
+ description?: string | undefined;
1837
1837
  requireNotes?: boolean | undefined;
1838
1838
  frequency?: {
1839
1839
  type: "schedule";
@@ -1847,7 +1847,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
1847
1847
  taskLists?: {
1848
1848
  code: string;
1849
1849
  name: string;
1850
- description: string;
1850
+ description?: string | undefined;
1851
1851
  }[] | undefined;
1852
1852
  skus?: {
1853
1853
  code: string;
@@ -2016,7 +2016,6 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
2016
2016
  tasks?: {
2017
2017
  code: string;
2018
2018
  title: string;
2019
- description: string;
2020
2019
  frequency: {
2021
2020
  type: "schedule";
2022
2021
  } | {
@@ -2024,13 +2023,14 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
2024
2023
  pattern: string;
2025
2024
  availableBeforeDeadlineMinutes?: number | undefined;
2026
2025
  };
2026
+ description?: string | undefined;
2027
2027
  requireNotes?: boolean | undefined;
2028
2028
  taskListCodes?: string[] | undefined;
2029
2029
  }[] | undefined;
2030
2030
  taskLists?: {
2031
2031
  code: string;
2032
2032
  name: string;
2033
- description: string;
2033
+ description?: string | undefined;
2034
2034
  }[] | undefined;
2035
2035
  skus?: {
2036
2036
  code: string;
@@ -2228,7 +2228,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
2228
2228
  tasks?: {
2229
2229
  code: string;
2230
2230
  title: string;
2231
- description: string;
2231
+ description?: string | undefined;
2232
2232
  requireNotes?: boolean | undefined;
2233
2233
  frequency?: {
2234
2234
  type: "schedule";
@@ -2242,7 +2242,7 @@ declare const PublicAccountViewModel: z.ZodObject<Omit<{
2242
2242
  taskLists?: {
2243
2243
  code: string;
2244
2244
  name: string;
2245
- description: string;
2245
+ description?: string | undefined;
2246
2246
  }[] | undefined;
2247
2247
  skus?: {
2248
2248
  code: string;
@@ -2593,7 +2593,7 @@ declare class BusrootClient {
2593
2593
  tasks?: {
2594
2594
  code: string;
2595
2595
  title: string;
2596
- description: string;
2596
+ description?: string | undefined;
2597
2597
  requireNotes?: boolean | undefined;
2598
2598
  frequency?: {
2599
2599
  type: "schedule";
@@ -2607,7 +2607,7 @@ declare class BusrootClient {
2607
2607
  taskLists?: {
2608
2608
  code: string;
2609
2609
  name: string;
2610
- description: string;
2610
+ description?: string | undefined;
2611
2611
  }[] | undefined;
2612
2612
  skus?: {
2613
2613
  code: string;
@@ -2811,7 +2811,7 @@ declare class BusrootClient {
2811
2811
  tasks?: {
2812
2812
  code: string;
2813
2813
  title: string;
2814
- description: string;
2814
+ description?: string | undefined;
2815
2815
  requireNotes?: boolean | undefined;
2816
2816
  frequency?: {
2817
2817
  type: "schedule";
@@ -2825,7 +2825,7 @@ declare class BusrootClient {
2825
2825
  taskLists?: {
2826
2826
  code: string;
2827
2827
  name: string;
2828
- description: string;
2828
+ description?: string | undefined;
2829
2829
  }[] | undefined;
2830
2830
  skus?: {
2831
2831
  code: string;
@@ -3300,7 +3300,7 @@ declare class BusrootClient {
3300
3300
  requiredTasks?: {
3301
3301
  code: string;
3302
3302
  title: string;
3303
- description: string;
3303
+ description?: string | undefined;
3304
3304
  requireNotes?: boolean | undefined;
3305
3305
  frequency?: {
3306
3306
  type: "schedule";
@@ -3863,7 +3863,6 @@ declare class BusrootClient {
3863
3863
  "task.createUpdate": (args_0: {
3864
3864
  code: string;
3865
3865
  title: string;
3866
- description: string;
3867
3866
  frequency: {
3868
3867
  type: "schedule";
3869
3868
  } | {
@@ -3871,12 +3870,13 @@ declare class BusrootClient {
3871
3870
  pattern: string;
3872
3871
  availableBeforeDeadlineMinutes?: number | undefined;
3873
3872
  };
3873
+ description?: string | undefined;
3874
3874
  requireNotes?: boolean | undefined;
3875
3875
  taskListCodes?: string[] | undefined;
3876
3876
  }, ...args: unknown[]) => Promise<{
3877
3877
  code: string;
3878
3878
  title: string;
3879
- description: string;
3879
+ description?: string | undefined;
3880
3880
  requireNotes?: boolean | undefined;
3881
3881
  frequency?: {
3882
3882
  type: "schedule";
@@ -5983,7 +5983,7 @@ declare const StationViewModel: z.ZodObject<{
5983
5983
  requiredTasks: z.ZodOptional<z.ZodArray<z.ZodObject<{
5984
5984
  code: z.ZodString;
5985
5985
  title: z.ZodString;
5986
- description: z.ZodString;
5986
+ description: z.ZodOptional<z.ZodString>;
5987
5987
  frequency: z.ZodDefault<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
5988
5988
  type: z.ZodLiteral<"schedule">;
5989
5989
  }, "strict", z.ZodTypeAny, {
@@ -6013,7 +6013,6 @@ declare const StationViewModel: z.ZodObject<{
6013
6013
  }, "strict", z.ZodTypeAny, {
6014
6014
  code: string;
6015
6015
  title: string;
6016
- description: string;
6017
6016
  frequency: {
6018
6017
  type: "schedule";
6019
6018
  } | {
@@ -6021,6 +6020,7 @@ declare const StationViewModel: z.ZodObject<{
6021
6020
  pattern: string;
6022
6021
  availableBeforeDeadlineMinutes?: number | undefined;
6023
6022
  };
6023
+ description?: string | undefined;
6024
6024
  requireNotes?: boolean | undefined;
6025
6025
  taskListCodes?: string[] | undefined;
6026
6026
  completedAt?: string | null | undefined;
@@ -6030,7 +6030,7 @@ declare const StationViewModel: z.ZodObject<{
6030
6030
  }, {
6031
6031
  code: string;
6032
6032
  title: string;
6033
- description: string;
6033
+ description?: string | undefined;
6034
6034
  requireNotes?: boolean | undefined;
6035
6035
  frequency?: {
6036
6036
  type: "schedule";
@@ -6190,7 +6190,6 @@ declare const StationViewModel: z.ZodObject<{
6190
6190
  requiredTasks?: {
6191
6191
  code: string;
6192
6192
  title: string;
6193
- description: string;
6194
6193
  frequency: {
6195
6194
  type: "schedule";
6196
6195
  } | {
@@ -6198,6 +6197,7 @@ declare const StationViewModel: z.ZodObject<{
6198
6197
  pattern: string;
6199
6198
  availableBeforeDeadlineMinutes?: number | undefined;
6200
6199
  };
6200
+ description?: string | undefined;
6201
6201
  requireNotes?: boolean | undefined;
6202
6202
  taskListCodes?: string[] | undefined;
6203
6203
  completedAt?: string | null | undefined;
@@ -6350,7 +6350,7 @@ declare const StationViewModel: z.ZodObject<{
6350
6350
  requiredTasks?: {
6351
6351
  code: string;
6352
6352
  title: string;
6353
- description: string;
6353
+ description?: string | undefined;
6354
6354
  requireNotes?: boolean | undefined;
6355
6355
  frequency?: {
6356
6356
  type: "schedule";
package/build/index.js CHANGED
@@ -153,7 +153,7 @@ var require_task = __commonJS({
153
153
  "../../packages/common/build/schemas/task.js"(exports2) {
154
154
  "use strict";
155
155
  Object.defineProperty(exports2, "__esModule", { value: true });
156
- exports2.TaskSchema = exports2.TaskListSchema = exports2.TaskFrequencySchema = exports2.TASK_FREQUENCY_TYPE_CRON = exports2.TASK_FREQUENCY_TYPE_SCHEDULE = void 0;
156
+ exports2.TaskSchema = exports2.TaskListSchema = exports2.TaskDescriptionSchema = exports2.TaskNameSchema = exports2.TaskCodeSchema = exports2.TaskFrequencySchema = exports2.TASK_FREQUENCY_TYPE_CRON = exports2.TASK_FREQUENCY_TYPE_SCHEDULE = void 0;
157
157
  var zod_1 = require("zod");
158
158
  exports2.TASK_FREQUENCY_TYPE_SCHEDULE = "schedule";
159
159
  exports2.TASK_FREQUENCY_TYPE_CRON = "cron";
@@ -170,15 +170,24 @@ var require_task = __commonJS({
170
170
  availableBeforeDeadlineMinutes: zod_1.z.number().int().positive().optional().describe("How many minutes before the deadline (the cron fire) this Task becomes available to complete on the tablet. Required for cron Tasks; must be shorter than the smallest gap between consecutive cron fires.")
171
171
  }).strict()
172
172
  ]).describe("How often this Task must be completed. 'schedule' = once per production schedule; 'cron' = every cron interval.");
173
+ exports2.TaskCodeSchema = zod_1.z.string().trim().min(1).max(32).regex(/^([a-zA-Z0-9-_]+)$/, {
174
+ message: "Only allowed 0-9, A-Z, and -_"
175
+ });
176
+ exports2.TaskNameSchema = zod_1.z.string().trim().min(1).max(128);
177
+ exports2.TaskDescriptionSchema = zod_1.z.string().trim().max(300).optional();
173
178
  exports2.TaskListSchema = zod_1.z.object({
174
179
  code: zod_1.z.string().min(1).describe("Unique Task list code used to reference this list (e.g., 'DAILY-CHECKS'). Must be unique within the account."),
175
180
  name: zod_1.z.string().describe("Human-readable name of the Task list (e.g., 'Daily Checks')"),
176
- description: zod_1.z.string().describe("Detailed description of what this Task list groups together")
181
+ // Optional at the schema level so a list saved without one still parses. Lengths and the
182
+ // required-ness of `name`/`code` are enforced on the write path — see `TaskCodeSchema`.
183
+ description: zod_1.z.string().optional().describe("Detailed description of what this Task list groups together")
177
184
  }).strict();
178
185
  exports2.TaskSchema = zod_1.z.object({
179
186
  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."),
180
187
  title: zod_1.z.string().describe("Human-readable title of the Task (e.g., 'Machine Startup Checklist', 'Quality Inspection Procedure')"),
181
- description: zod_1.z.string().describe("Detailed description of the Task and its purpose"),
188
+ // Optional at the schema level so a Task saved without one still parses. Lengths and the
189
+ // required-ness of `title`/`code` are enforced on the write path — see `TaskCodeSchema`.
190
+ description: zod_1.z.string().optional().describe("Detailed description of the Task and its purpose"),
182
191
  frequency: exports2.TaskFrequencySchema.default({ type: exports2.TASK_FREQUENCY_TYPE_SCHEDULE }),
183
192
  // Optional at the schema level so pre-existing Tasks (written before this field existed) still
184
193
  // parse — absent means notes are not required, the pre-feature behaviour.
@@ -6544,7 +6553,11 @@ var require_task2 = __commonJS({
6544
6553
  exports2.TaskDeleteRequest = exports2.TaskPostRequest = void 0;
6545
6554
  var zod_1 = require("zod");
6546
6555
  var task_1 = require_task();
6547
- exports2.TaskPostRequest = task_1.TaskSchema;
6556
+ exports2.TaskPostRequest = task_1.TaskSchema.extend({
6557
+ code: task_1.TaskCodeSchema.describe("Unique Task code used to reference this procedure (e.g., 'TASK-001', 'STARTUP-CHECK'). Must be unique within the account."),
6558
+ title: task_1.TaskNameSchema.describe("Human-readable title of the Task (e.g., 'Machine Startup Checklist', 'Quality Inspection Procedure')"),
6559
+ description: task_1.TaskDescriptionSchema.describe("Detailed description of the Task and its purpose")
6560
+ });
6548
6561
  exports2.TaskDeleteRequest = zod_1.z.object({
6549
6562
  code: zod_1.z.string()
6550
6563
  });
@@ -6559,7 +6572,11 @@ var require_task_list = __commonJS({
6559
6572
  exports2.TaskListDeleteRequest = exports2.TaskListPostRequest = void 0;
6560
6573
  var zod_1 = require("zod");
6561
6574
  var task_1 = require_task();
6562
- exports2.TaskListPostRequest = task_1.TaskListSchema;
6575
+ exports2.TaskListPostRequest = task_1.TaskListSchema.extend({
6576
+ code: task_1.TaskCodeSchema.describe("Unique Task list code used to reference this list (e.g., 'DAILY-CHECKS'). Must be unique within the account."),
6577
+ name: task_1.TaskNameSchema.describe("Human-readable name of the Task list (e.g., 'Daily Checks')"),
6578
+ description: task_1.TaskDescriptionSchema.describe("Detailed description of what this Task list groups together")
6579
+ });
6563
6580
  exports2.TaskListDeleteRequest = zod_1.z.object({
6564
6581
  code: zod_1.z.string()
6565
6582
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "busroot-sdk",
3
- "version": "0.0.8-dev.2756254166",
3
+ "version": "0.0.8-dev.2758108576",
4
4
  "description": "An SDK for accessing Busroot from output.industries",
5
5
  "homepage": "https://www.output.industries",
6
6
  "main": "./build/index.js",