@openremote/or-scheduler 1.12.0-snapshot.20251212165311

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.
@@ -0,0 +1,632 @@
1
+ {
2
+ "schemaVersion": "1.0.0",
3
+ "readme": "",
4
+ "modules": [
5
+ {
6
+ "kind": "javascript-module",
7
+ "path": "src/index.ts",
8
+ "declarations": [
9
+ {
10
+ "kind": "class",
11
+ "description": "",
12
+ "name": "OrSchedulerChangedEvent",
13
+ "members": [
14
+ {
15
+ "kind": "field",
16
+ "name": "NAME",
17
+ "type": {
18
+ "text": "string"
19
+ },
20
+ "privacy": "public",
21
+ "static": true,
22
+ "readonly": true,
23
+ "default": "\"or-scheduler-changed\""
24
+ }
25
+ ],
26
+ "superclass": {
27
+ "name": "CustomEvent",
28
+ "module": "src/index.ts"
29
+ }
30
+ },
31
+ {
32
+ "kind": "class",
33
+ "description": "",
34
+ "name": "OrScheduler",
35
+ "members": [
36
+ {
37
+ "kind": "field",
38
+ "name": "defaultSchedule",
39
+ "type": {
40
+ "text": "CalendarEvent | undefined"
41
+ },
42
+ "privacy": "public",
43
+ "attribute": "defaultSchedule"
44
+ },
45
+ {
46
+ "kind": "field",
47
+ "name": "defaultEventTypeLabel",
48
+ "type": {
49
+ "text": "string"
50
+ },
51
+ "privacy": "public",
52
+ "default": "\"default\"",
53
+ "attribute": "defaultEventTypeLabel"
54
+ },
55
+ {
56
+ "kind": "field",
57
+ "name": "disabledFrequencies",
58
+ "type": {
59
+ "text": "Frequency[]"
60
+ },
61
+ "privacy": "public",
62
+ "default": "[]",
63
+ "attribute": "disabledFrequencies"
64
+ },
65
+ {
66
+ "kind": "field",
67
+ "name": "disabledRRuleParts",
68
+ "type": {
69
+ "text": "RulePartKey[]"
70
+ },
71
+ "privacy": "public",
72
+ "default": "[]",
73
+ "attribute": "disabledRRuleParts"
74
+ },
75
+ {
76
+ "kind": "field",
77
+ "name": "header",
78
+ "type": {
79
+ "text": "string"
80
+ },
81
+ "privacy": "public",
82
+ "default": "\"scheduleActivity\"",
83
+ "attribute": "header"
84
+ },
85
+ {
86
+ "kind": "field",
87
+ "name": "isAllDay",
88
+ "type": {
89
+ "text": "boolean"
90
+ },
91
+ "privacy": "public",
92
+ "default": "true",
93
+ "attribute": "isAllDay"
94
+ },
95
+ {
96
+ "kind": "field",
97
+ "name": "schedule",
98
+ "type": {
99
+ "text": "CalendarEvent | undefined"
100
+ },
101
+ "privacy": "public",
102
+ "attribute": "schedule"
103
+ },
104
+ {
105
+ "kind": "field",
106
+ "name": "timezoneOffset",
107
+ "type": {
108
+ "text": "number"
109
+ },
110
+ "privacy": "public",
111
+ "default": "0",
112
+ "attribute": "timezoneOffset"
113
+ },
114
+ {
115
+ "kind": "field",
116
+ "name": "_ends",
117
+ "type": {
118
+ "text": "keyof typeof rruleEnds"
119
+ },
120
+ "privacy": "protected",
121
+ "default": "\"never\""
122
+ },
123
+ {
124
+ "kind": "field",
125
+ "name": "_normalizedSchedule",
126
+ "privacy": "protected"
127
+ },
128
+ {
129
+ "kind": "field",
130
+ "name": "_rrule",
131
+ "type": {
132
+ "text": "RRule | undefined"
133
+ },
134
+ "privacy": "protected"
135
+ },
136
+ {
137
+ "kind": "field",
138
+ "name": "dialog",
139
+ "type": {
140
+ "text": "OrMwcDialog | undefined"
141
+ },
142
+ "privacy": "protected"
143
+ },
144
+ {
145
+ "kind": "field",
146
+ "name": "_byRRuleParts",
147
+ "type": {
148
+ "text": "RulePartKey[] | undefined"
149
+ },
150
+ "privacy": "protected"
151
+ },
152
+ {
153
+ "kind": "field",
154
+ "name": "_count",
155
+ "type": {
156
+ "text": "number"
157
+ },
158
+ "privacy": "protected",
159
+ "default": "1"
160
+ },
161
+ {
162
+ "kind": "field",
163
+ "name": "_dialog",
164
+ "type": {
165
+ "text": "OrMwcDialog | undefined"
166
+ },
167
+ "privacy": "protected"
168
+ },
169
+ {
170
+ "kind": "field",
171
+ "name": "_eventType",
172
+ "type": {
173
+ "text": "EventTypes"
174
+ },
175
+ "privacy": "protected"
176
+ },
177
+ {
178
+ "kind": "field",
179
+ "name": "_eventTypes",
180
+ "type": {
181
+ "text": "LabeledEventTypes"
182
+ },
183
+ "privacy": "protected",
184
+ "default": "EventTypes"
185
+ },
186
+ {
187
+ "kind": "field",
188
+ "name": "_until",
189
+ "privacy": "protected"
190
+ },
191
+ {
192
+ "kind": "method",
193
+ "name": "getRRule",
194
+ "privacy": "protected",
195
+ "return": {
196
+ "type": {
197
+ "text": ""
198
+ }
199
+ },
200
+ "parameters": [
201
+ {
202
+ "name": "rrule",
203
+ "default": "this._rrule",
204
+ "description": "The recurrence rule to normalize."
205
+ }
206
+ ],
207
+ "description": "Converts the recurrence rule to string and normalizes it.\n\nThe UTC timezone offset 'Z' for the UNTIL rule part is removed,\nbecause the backend uses a `LocalDateTime` object to compare."
208
+ },
209
+ {
210
+ "kind": "method",
211
+ "name": "setRRuleValue",
212
+ "privacy": "protected",
213
+ "parameters": [
214
+ {
215
+ "name": "value",
216
+ "type": {
217
+ "text": "any"
218
+ }
219
+ },
220
+ {
221
+ "name": "key",
222
+ "type": {
223
+ "text": "keyof RuleParts | \"start\" | \"end\" | \"start-time\" | \"end-time\" | \"all-day\" | \"recurrence-ends\""
224
+ }
225
+ }
226
+ ]
227
+ },
228
+ {
229
+ "kind": "method",
230
+ "name": "timeLabel",
231
+ "privacy": "protected",
232
+ "return": {
233
+ "type": {
234
+ "text": "string | undefined"
235
+ }
236
+ }
237
+ },
238
+ {
239
+ "kind": "method",
240
+ "name": "setCalendarEventType",
241
+ "privacy": "protected",
242
+ "parameters": [
243
+ {
244
+ "name": "value",
245
+ "type": {
246
+ "text": "any"
247
+ }
248
+ }
249
+ ]
250
+ },
251
+ {
252
+ "kind": "method",
253
+ "name": "applyTimezoneOffset",
254
+ "privacy": "protected",
255
+ "return": {
256
+ "type": {
257
+ "text": ""
258
+ }
259
+ },
260
+ "parameters": [
261
+ {
262
+ "name": "schedule",
263
+ "optional": true,
264
+ "type": {
265
+ "text": "CalendarEvent"
266
+ },
267
+ "description": "The schedule for which to add/substract the offset"
268
+ },
269
+ {
270
+ "name": "substract",
271
+ "default": "false",
272
+ "description": "Whether to substract the offset"
273
+ }
274
+ ],
275
+ "description": "Apply the timezone offset to the calendarEvent"
276
+ },
277
+ {
278
+ "kind": "method",
279
+ "name": "showDialog",
280
+ "privacy": "protected"
281
+ },
282
+ {
283
+ "kind": "method",
284
+ "name": "getDialogContent",
285
+ "privacy": "protected",
286
+ "return": {
287
+ "type": {
288
+ "text": "TemplateResult"
289
+ }
290
+ }
291
+ },
292
+ {
293
+ "kind": "method",
294
+ "name": "isAllowedFrequency",
295
+ "privacy": "protected",
296
+ "parameters": [
297
+ {
298
+ "name": "freq",
299
+ "type": {
300
+ "text": "Frequency"
301
+ },
302
+ "description": "The frequency to check"
303
+ }
304
+ ],
305
+ "description": "Check if this frequency is allowed",
306
+ "return": {
307
+ "type": {
308
+ "text": ""
309
+ }
310
+ }
311
+ },
312
+ {
313
+ "kind": "method",
314
+ "name": "getRepeatTemplate",
315
+ "privacy": "protected",
316
+ "return": {
317
+ "type": {
318
+ "text": ""
319
+ }
320
+ },
321
+ "description": "Displays the interval, frequency and BY_XXX RRule part fields\n\nApplicable rule parts\n- `interval`\n- `freq`\n- `bysecond`\n- `byminute`\n- `byhour`\n- `byweekday`\n- `bymonthday`\n- `byyearday`\n- `byweekno`\n- `bymonth`\n\nEvaluation order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE and BYSECOND."
322
+ },
323
+ {
324
+ "kind": "method",
325
+ "name": "getByRulePart",
326
+ "privacy": "protected",
327
+ "return": {
328
+ "type": {
329
+ "text": ""
330
+ }
331
+ },
332
+ "parameters": [
333
+ {
334
+ "name": "part",
335
+ "type": {
336
+ "text": "RulePartKey"
337
+ }
338
+ },
339
+ {
340
+ "name": "type",
341
+ "type": {
342
+ "text": "InputType"
343
+ }
344
+ },
345
+ {
346
+ "name": "options",
347
+ "type": {
348
+ "text": "T[]"
349
+ }
350
+ }
351
+ ],
352
+ "description": "Displays the BY_XXX RRule part fields if allowed by the frequency"
353
+ },
354
+ {
355
+ "kind": "method",
356
+ "name": "getPeriodTemplate",
357
+ "privacy": "protected",
358
+ "return": {
359
+ "type": {
360
+ "text": ""
361
+ }
362
+ },
363
+ "parameters": [
364
+ {
365
+ "name": "calendar",
366
+ "type": {
367
+ "text": "CalendarEvent"
368
+ },
369
+ "description": "The specified calendar event"
370
+ }
371
+ ],
372
+ "description": "Displays the fields that define when and how long the particular event is"
373
+ },
374
+ {
375
+ "kind": "method",
376
+ "name": "getEndsTemplate",
377
+ "privacy": "protected",
378
+ "return": {
379
+ "type": {
380
+ "text": ""
381
+ }
382
+ },
383
+ "description": "Displays the fields that define how a recurring event should end\n\nApplicable rule parts\n- `until`\n- `count`"
384
+ }
385
+ ],
386
+ "events": [
387
+ {
388
+ "name": "schedule",
389
+ "type": {
390
+ "text": "OrSchedulerChangedEvent"
391
+ }
392
+ }
393
+ ],
394
+ "attributes": [
395
+ {
396
+ "name": "defaultSchedule",
397
+ "type": {
398
+ "text": "CalendarEvent | undefined"
399
+ },
400
+ "fieldName": "defaultSchedule"
401
+ },
402
+ {
403
+ "name": "defaultEventTypeLabel",
404
+ "type": {
405
+ "text": "string"
406
+ },
407
+ "default": "\"default\"",
408
+ "fieldName": "defaultEventTypeLabel"
409
+ },
410
+ {
411
+ "name": "disabledFrequencies",
412
+ "type": {
413
+ "text": "Frequency[]"
414
+ },
415
+ "default": "[]",
416
+ "fieldName": "disabledFrequencies"
417
+ },
418
+ {
419
+ "name": "disabledRRuleParts",
420
+ "type": {
421
+ "text": "RulePartKey[]"
422
+ },
423
+ "default": "[]",
424
+ "fieldName": "disabledRRuleParts"
425
+ },
426
+ {
427
+ "name": "header",
428
+ "type": {
429
+ "text": "string"
430
+ },
431
+ "default": "\"scheduleActivity\"",
432
+ "fieldName": "header"
433
+ },
434
+ {
435
+ "name": "isAllDay",
436
+ "type": {
437
+ "text": "boolean"
438
+ },
439
+ "default": "true",
440
+ "fieldName": "isAllDay"
441
+ },
442
+ {
443
+ "name": "schedule",
444
+ "type": {
445
+ "text": "CalendarEvent | undefined"
446
+ },
447
+ "fieldName": "schedule"
448
+ },
449
+ {
450
+ "name": "timezoneOffset",
451
+ "type": {
452
+ "text": "number"
453
+ },
454
+ "default": "0",
455
+ "fieldName": "timezoneOffset"
456
+ }
457
+ ],
458
+ "mixins": [
459
+ {
460
+ "name": "translate(i18next)",
461
+ "module": "src/index.ts"
462
+ }
463
+ ],
464
+ "superclass": {
465
+ "name": "LitElement",
466
+ "package": "lit"
467
+ },
468
+ "tagName": "or-scheduler",
469
+ "customElement": true,
470
+ "modulePath": "src/index.ts",
471
+ "definitionPath": "src/index.ts"
472
+ }
473
+ ],
474
+ "exports": [
475
+ {
476
+ "kind": "js",
477
+ "name": "RuleParts",
478
+ "declaration": {
479
+ "name": "RuleParts",
480
+ "module": "src/index.ts"
481
+ }
482
+ },
483
+ {
484
+ "kind": "js",
485
+ "name": "RulePartKey",
486
+ "declaration": {
487
+ "name": "RulePartKey",
488
+ "module": "src/index.ts"
489
+ }
490
+ },
491
+ {
492
+ "kind": "js",
493
+ "name": "Frequency",
494
+ "declaration": {
495
+ "name": "Frequency",
496
+ "module": "src/index.ts"
497
+ }
498
+ },
499
+ {
500
+ "kind": "js",
501
+ "name": "LabeledEventTypes",
502
+ "declaration": {
503
+ "name": "LabeledEventTypes",
504
+ "module": "src/index.ts"
505
+ }
506
+ },
507
+ {
508
+ "kind": "js",
509
+ "name": "*",
510
+ "declaration": {
511
+ "name": "*",
512
+ "package": "\"./util\""
513
+ }
514
+ },
515
+ {
516
+ "kind": "js",
517
+ "name": "OrSchedulerChangedEvent",
518
+ "declaration": {
519
+ "name": "OrSchedulerChangedEvent",
520
+ "module": "src/index.ts"
521
+ }
522
+ },
523
+ {
524
+ "kind": "js",
525
+ "name": "OrScheduler",
526
+ "declaration": {
527
+ "name": "OrScheduler",
528
+ "module": "src/index.ts"
529
+ }
530
+ },
531
+ {
532
+ "kind": "custom-element-definition",
533
+ "name": "or-scheduler",
534
+ "declaration": {
535
+ "name": "OrScheduler",
536
+ "module": "src/index.ts"
537
+ }
538
+ }
539
+ ]
540
+ },
541
+ {
542
+ "kind": "javascript-module",
543
+ "path": "src/types.ts",
544
+ "declarations": [],
545
+ "exports": []
546
+ },
547
+ {
548
+ "kind": "javascript-module",
549
+ "path": "src/util.ts",
550
+ "declarations": [
551
+ {
552
+ "kind": "variable",
553
+ "name": "FREQUENCIES",
554
+ "default": "{ YEARLY: \"rrule.frequency.YEARLY\", MONTHLY: \"rrule.frequency.MONTHLY\", WEEKLY: \"rrule.frequency.WEEKLY\", DAILY: \"rrule.frequency.DAILY\", HOURLY: \"rrule.frequency.HOURLY\", MINUTELY: \"rrule.frequency.MINUTELY\", SECONDLY: \"rrule.frequency.SECONDLY\", }"
555
+ },
556
+ {
557
+ "kind": "variable",
558
+ "name": "BY_RRULE_PARTS",
559
+ "type": {
560
+ "text": "[\n \"bymonth\",\n \"byweekno\",\n \"byyearday\",\n \"bymonthday\",\n \"byweekday\",\n \"byhour\",\n \"byminute\",\n \"bysecond\",\n]"
561
+ },
562
+ "default": "[ \"bymonth\", \"byweekno\", \"byyearday\", \"bymonthday\", \"byweekday\", \"byhour\", \"byminute\", \"bysecond\", ]",
563
+ "description": "Evaluation order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE and BYSECOND.\nAs per https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 page 44"
564
+ },
565
+ {
566
+ "kind": "variable",
567
+ "name": "NOT_APPLICABLE_BY_RRULE_PARTS",
568
+ "default": "{ SECONDLY: [\"BYWEEKNO\"], MINUTELY: [\"BYWEEKNO\"], HOURLY: [\"BYWEEKNO\"], DAILY: [\"BYWEEKNO\", \"BYYEARDAY\"], WEEKLY: [\"BYWEEKNO\", \"BYYEARDAY\", \"BYMONTHDAY\"], MONTHLY: [\"BYWEEKNO\", \"BYYEARDAY\"], }",
569
+ "description": "Dependency of by rule parts table\nAs per https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 page 44"
570
+ },
571
+ {
572
+ "kind": "variable",
573
+ "name": "MONTHS",
574
+ "type": {
575
+ "text": "object"
576
+ },
577
+ "default": "{ 1: \"JAN\", 2: \"FEB\", 3: \"MAR\", 4: \"APR\", 5: \"MAY\", 6: \"JUN\", 7: \"JUL\", 8: \"AUG\", 9: \"SEP\", 10: \"OCT\", 11: \"NOV\", 12: \"DEC\", }"
578
+ },
579
+ {
580
+ "kind": "variable",
581
+ "name": "rruleEnds",
582
+ "type": {
583
+ "text": "object"
584
+ },
585
+ "default": "{ never: \"never\", until: \"schedule.ends.until\", count: \"schedule.ends.count\", }"
586
+ }
587
+ ],
588
+ "exports": [
589
+ {
590
+ "kind": "js",
591
+ "name": "FREQUENCIES",
592
+ "declaration": {
593
+ "name": "FREQUENCIES",
594
+ "module": "src/util.ts"
595
+ }
596
+ },
597
+ {
598
+ "kind": "js",
599
+ "name": "BY_RRULE_PARTS",
600
+ "declaration": {
601
+ "name": "BY_RRULE_PARTS",
602
+ "module": "src/util.ts"
603
+ }
604
+ },
605
+ {
606
+ "kind": "js",
607
+ "name": "NOT_APPLICABLE_BY_RRULE_PARTS",
608
+ "declaration": {
609
+ "name": "NOT_APPLICABLE_BY_RRULE_PARTS",
610
+ "module": "src/util.ts"
611
+ }
612
+ },
613
+ {
614
+ "kind": "js",
615
+ "name": "MONTHS",
616
+ "declaration": {
617
+ "name": "MONTHS",
618
+ "module": "src/util.ts"
619
+ }
620
+ },
621
+ {
622
+ "kind": "js",
623
+ "name": "rruleEnds",
624
+ "declaration": {
625
+ "name": "rruleEnds",
626
+ "module": "src/util.ts"
627
+ }
628
+ }
629
+ ]
630
+ }
631
+ ]
632
+ }