@dereekb/dbx-components-mcp 13.11.13 → 13.11.15

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.
@@ -290,11 +290,11 @@
290
290
  {
291
291
  "name": "collection",
292
292
  "type": "DateCellCollection<B>",
293
- "description": "- The date cell collection containing timing and blocks to expand.",
293
+ "description": "- Collection whose timing and blocks should be expanded.",
294
294
  "optional": false
295
295
  }
296
296
  ],
297
- "returns": "An array of {@link DateCellDurationSpan } values with concrete start times and durations.",
297
+ "returns": "Duration spans with concrete start times for each block.",
298
298
  "tags": [
299
299
  "date",
300
300
  "cell",
@@ -322,17 +322,17 @@
322
322
  {
323
323
  "name": "timing",
324
324
  "type": "DateCellTiming",
325
- "description": "- The timing schedule providing start times and duration.",
325
+ "description": "- Schedule providing start times and duration.",
326
326
  "optional": false
327
327
  },
328
328
  {
329
329
  "name": "blocks",
330
330
  "type": "B[]",
331
- "description": "- The date cell blocks to expand into duration spans.",
331
+ "description": "- Blocks to expand into concrete duration spans.",
332
332
  "optional": false
333
333
  }
334
334
  ],
335
- "returns": "An array of {@link DateCellDurationSpan } values with concrete start times.",
335
+ "returns": "Duration spans with concrete start times.",
336
336
  "tags": [
337
337
  "date",
338
338
  "cell",
@@ -549,7 +549,7 @@
549
549
  {
550
550
  "name": "date",
551
551
  "type": "DateOrDateCellIndex",
552
- "description": "- A date or index to convert; defaults to the current date/time.",
552
+ "description": "- Moment to convert; defaults to the current date/time.",
553
553
  "optional": true
554
554
  }
555
555
  ],
@@ -770,7 +770,7 @@
770
770
  {
771
771
  "name": "input",
772
772
  "type": "DateOrDateCellIndex",
773
- "description": "- A date or day index to convert.",
773
+ "description": "- Moment or day-index to resolve to a calendar date.",
774
774
  "optional": false
775
775
  }
776
776
  ],
@@ -879,11 +879,11 @@
879
879
  {
880
880
  "name": "data",
881
881
  "type": "TimeDurationData",
882
- "description": "- The duration data to check",
882
+ "description": "- The duration data to check.",
883
883
  "optional": false
884
884
  }
885
885
  ],
886
- "returns": "True if empty",
886
+ "returns": "True if empty.",
887
887
  "tags": [
888
888
  "date",
889
889
  "duration",
@@ -914,11 +914,11 @@
914
914
  {
915
915
  "name": "data",
916
916
  "type": "TimeDurationData",
917
- "description": "- The duration data to convert",
917
+ "description": "- The duration data to convert.",
918
918
  "optional": false
919
919
  }
920
920
  ],
921
- "returns": "Total milliseconds",
921
+ "returns": "Total milliseconds.",
922
922
  "tags": [
923
923
  "date",
924
924
  "duration",
@@ -951,7 +951,7 @@
951
951
  {
952
952
  "name": "ms",
953
953
  "type": "Milliseconds",
954
- "description": "- The total milliseconds to decompose",
954
+ "description": "- The total milliseconds to decompose.",
955
955
  "optional": false
956
956
  },
957
957
  {
@@ -961,7 +961,7 @@
961
961
  "optional": true
962
962
  }
963
963
  ],
964
- "returns": "A TimeDurationData with the decomposed values",
964
+ "returns": "A TimeDurationData with the decomposed values.",
965
965
  "tags": [
966
966
  "date",
967
967
  "duration",
@@ -995,17 +995,17 @@
995
995
  {
996
996
  "name": "data",
997
997
  "type": "TimeDurationData",
998
- "description": "- The duration data",
998
+ "description": "- The duration data.",
999
999
  "optional": false
1000
1000
  },
1001
1001
  {
1002
1002
  "name": "unit",
1003
1003
  "type": "TimeUnit",
1004
- "description": "- The time unit to read",
1004
+ "description": "- The time unit to read.",
1005
1005
  "optional": false
1006
1006
  }
1007
1007
  ],
1008
- "returns": "The value for that unit, or 0 if not set",
1008
+ "returns": "The value for that unit, or 0 if not set.",
1009
1009
  "tags": [
1010
1010
  "date",
1011
1011
  "duration",
@@ -1036,23 +1036,23 @@
1036
1036
  {
1037
1037
  "name": "data",
1038
1038
  "type": "TimeDurationData",
1039
- "description": "- The original duration data",
1039
+ "description": "- The original duration data.",
1040
1040
  "optional": false
1041
1041
  },
1042
1042
  {
1043
1043
  "name": "unit",
1044
1044
  "type": "TimeUnit",
1045
- "description": "- The time unit to set",
1045
+ "description": "- The time unit to set.",
1046
1046
  "optional": false
1047
1047
  },
1048
1048
  {
1049
1049
  "name": "value",
1050
1050
  "type": "number",
1051
- "description": "- The new value",
1051
+ "description": "- The new value.",
1052
1052
  "optional": false
1053
1053
  }
1054
1054
  ],
1055
- "returns": "A new TimeDurationData with the updated value",
1055
+ "returns": "A new TimeDurationData with the updated value.",
1056
1056
  "tags": [
1057
1057
  "date",
1058
1058
  "duration",
@@ -1084,11 +1084,11 @@
1084
1084
  {
1085
1085
  "name": "input",
1086
1086
  "type": "string",
1087
- "description": "- The duration string to parse",
1087
+ "description": "- The duration string to parse.",
1088
1088
  "optional": false
1089
1089
  }
1090
1090
  ],
1091
- "returns": "A TimeDurationData object with the parsed values",
1091
+ "returns": "A TimeDurationData object with the parsed values.",
1092
1092
  "tags": [
1093
1093
  "date",
1094
1094
  "duration",
@@ -1120,11 +1120,11 @@
1120
1120
  {
1121
1121
  "name": "input",
1122
1122
  "type": "string",
1123
- "description": "- The duration string to parse",
1123
+ "description": "- The duration string to parse.",
1124
1124
  "optional": false
1125
1125
  }
1126
1126
  ],
1127
- "returns": "Total milliseconds",
1127
+ "returns": "Total milliseconds.",
1128
1128
  "tags": [
1129
1129
  "date",
1130
1130
  "duration",
@@ -1156,11 +1156,11 @@
1156
1156
  {
1157
1157
  "name": "data",
1158
1158
  "type": "TimeDurationData",
1159
- "description": "- The duration data to format",
1159
+ "description": "- The duration data to format.",
1160
1160
  "optional": false
1161
1161
  }
1162
1162
  ],
1163
- "returns": "A compact duration string",
1163
+ "returns": "A compact duration string.",
1164
1164
  "tags": [
1165
1165
  "date",
1166
1166
  "duration",
@@ -1191,11 +1191,11 @@
1191
1191
  {
1192
1192
  "name": "data",
1193
1193
  "type": "TimeDurationData",
1194
- "description": "- The duration data to format",
1194
+ "description": "- The duration data to format.",
1195
1195
  "optional": false
1196
1196
  }
1197
1197
  ],
1198
- "returns": "A human-readable duration string",
1198
+ "returns": "A human-readable duration string.",
1199
1199
  "tags": [
1200
1200
  "date",
1201
1201
  "duration",
@@ -1227,11 +1227,11 @@
1227
1227
  {
1228
1228
  "name": "span",
1229
1229
  "type": "DateDurationSpan",
1230
- "description": "- the duration span to compute the end for",
1230
+ "description": "- Span whose end date should be computed.",
1231
1231
  "optional": false
1232
1232
  }
1233
1233
  ],
1234
- "returns": "the date when the span ends",
1234
+ "returns": "Moment when the span ends.",
1235
1235
  "tags": [
1236
1236
  "date",
1237
1237
  "duration",
@@ -1260,11 +1260,11 @@
1260
1260
  {
1261
1261
  "name": "span",
1262
1262
  "type": "DateDurationSpan",
1263
- "description": "- the duration span to convert",
1263
+ "description": "- Span to project onto a start/end date range.",
1264
1264
  "optional": false
1265
1265
  }
1266
1266
  ],
1267
- "returns": "a date range from startsAt to startsAt + duration",
1267
+ "returns": "Range from startsAt to startsAt + duration.",
1268
1268
  "tags": [
1269
1269
  "date",
1270
1270
  "duration",
@@ -1292,11 +1292,11 @@
1292
1292
  {
1293
1293
  "name": "dateRange",
1294
1294
  "type": "DateRange",
1295
- "description": "- the date range to convert",
1295
+ "description": "- Range to project onto a duration span.",
1296
1296
  "optional": false
1297
1297
  }
1298
1298
  ],
1299
- "returns": "a duration span with the range's start as startsAt",
1299
+ "returns": "Span anchored at the range's start with duration measured to its end.",
1300
1300
  "tags": [
1301
1301
  "date",
1302
1302
  "duration",
@@ -1325,11 +1325,11 @@
1325
1325
  {
1326
1326
  "name": "inputConfig",
1327
1327
  "type": "FormatDateRangeFunctionConfigInput",
1328
- "description": "- format function or full configuration",
1328
+ "description": "- Format function or full configuration.",
1329
1329
  "optional": false
1330
1330
  }
1331
1331
  ],
1332
- "returns": "a reusable function that formats date ranges into strings",
1332
+ "returns": "A reusable function that formats date ranges into strings.",
1333
1333
  "tags": [
1334
1334
  "date",
1335
1335
  "format",
@@ -1358,23 +1358,23 @@
1358
1358
  {
1359
1359
  "name": "range",
1360
1360
  "type": "DateRange",
1361
- "description": "- date range to format",
1361
+ "description": "- Date range to format.",
1362
1362
  "optional": false
1363
1363
  },
1364
1364
  {
1365
1365
  "name": "inputConfig",
1366
1366
  "type": "FormatDateRangeFunctionConfigInput",
1367
- "description": "- format function or full configuration",
1367
+ "description": "- Format function or full configuration.",
1368
1368
  "optional": false
1369
1369
  },
1370
1370
  {
1371
1371
  "name": "separator",
1372
1372
  "type": "string",
1373
- "description": "- optional separator override when inputConfig is a function",
1373
+ "description": "- Optional separator override when inputConfig is a function.",
1374
1374
  "optional": true
1375
1375
  }
1376
1376
  ],
1377
- "returns": "the formatted date range string",
1377
+ "returns": "The formatted date range string.",
1378
1378
  "tags": [
1379
1379
  "date",
1380
1380
  "format",
@@ -1402,17 +1402,17 @@
1402
1402
  {
1403
1403
  "name": "range",
1404
1404
  "type": "DateRange",
1405
- "description": "- date range to compute distance for",
1405
+ "description": "- Date range to compute distance for.",
1406
1406
  "optional": false
1407
1407
  },
1408
1408
  {
1409
1409
  "name": "inputConfig",
1410
1410
  "type": "FormatDateRangeDistanceFunctionConfig",
1411
- "description": "- optional distance formatting configuration",
1411
+ "description": "- Optional distance formatting configuration.",
1412
1412
  "optional": true
1413
1413
  }
1414
1414
  ],
1415
- "returns": "the human-readable distance string",
1415
+ "returns": "The human-readable distance string.",
1416
1416
  "tags": [
1417
1417
  "date",
1418
1418
  "format",
@@ -1489,11 +1489,11 @@
1489
1489
  {
1490
1490
  "name": "dateRange",
1491
1491
  "type": "DateRange",
1492
- "description": "- the date range to measure",
1492
+ "description": "- Range to measure.",
1493
1493
  "optional": false
1494
1494
  }
1495
1495
  ],
1496
- "returns": "the number of days in the range, inclusive",
1496
+ "returns": "Inclusive count of calendar days covered by the range.",
1497
1497
  "tags": [
1498
1498
  "date",
1499
1499
  "range",
@@ -1523,11 +1523,11 @@
1523
1523
  {
1524
1524
  "name": "input",
1525
1525
  "type": "unknown",
1526
- "description": "- the value to check",
1526
+ "description": "- The value to check.",
1527
1527
  "optional": false
1528
1528
  }
1529
1529
  ],
1530
- "returns": "true if the value has valid Date `start` and `end` properties",
1530
+ "returns": "True if the value has valid Date `start` and `end` properties.",
1531
1531
  "tags": [
1532
1532
  "date",
1533
1533
  "range",
@@ -1556,17 +1556,17 @@
1556
1556
  {
1557
1557
  "name": "a",
1558
1558
  "type": "Maybe<Partial<DateRange>>",
1559
- "description": "- first date range to compare",
1559
+ "description": "- First date range to compare.",
1560
1560
  "optional": false
1561
1561
  },
1562
1562
  {
1563
1563
  "name": "b",
1564
1564
  "type": "Maybe<Partial<DateRange>>",
1565
- "description": "- second date range to compare",
1565
+ "description": "- Second date range to compare.",
1566
1566
  "optional": false
1567
1567
  }
1568
1568
  ],
1569
- "returns": "true if both ranges are equal or both are nullish",
1569
+ "returns": "True if both ranges are equal or both are nullish.",
1570
1570
  "tags": [
1571
1571
  "date",
1572
1572
  "range",
@@ -1596,11 +1596,11 @@
1596
1596
  {
1597
1597
  "name": "input",
1598
1598
  "type": "unknown",
1599
- "description": "- value to check",
1599
+ "description": "- Value to check.",
1600
1600
  "optional": false
1601
1601
  }
1602
1602
  ],
1603
- "returns": "whether the input is a Date",
1603
+ "returns": "Whether the input is a Date.",
1604
1604
  "tags": [
1605
1605
  "date",
1606
1606
  "type-guard",
@@ -1624,11 +1624,11 @@
1624
1624
  {
1625
1625
  "name": "milliseconds",
1626
1626
  "type": "number",
1627
- "description": "- duration in milliseconds",
1627
+ "description": "- Duration in milliseconds.",
1628
1628
  "optional": false
1629
1629
  }
1630
1630
  ],
1631
- "returns": "equivalent duration in minutes",
1631
+ "returns": "Equivalent duration in minutes.",
1632
1632
  "tags": [
1633
1633
  "date",
1634
1634
  "time",
@@ -1660,11 +1660,11 @@
1660
1660
  {
1661
1661
  "name": "milliseconds",
1662
1662
  "type": "number",
1663
- "description": "- duration in milliseconds",
1663
+ "description": "- Duration in milliseconds.",
1664
1664
  "optional": false
1665
1665
  }
1666
1666
  ],
1667
- "returns": "equivalent duration in seconds",
1667
+ "returns": "Equivalent duration in seconds.",
1668
1668
  "tags": [
1669
1669
  "date",
1670
1670
  "time",
@@ -1696,11 +1696,11 @@
1696
1696
  {
1697
1697
  "name": "hours",
1698
1698
  "type": "number",
1699
- "description": "- number of hours (defaults to 1)",
1699
+ "description": "- Number of hours (defaults to 1)",
1700
1700
  "optional": true
1701
1701
  }
1702
1702
  ],
1703
- "returns": "equivalent duration in milliseconds",
1703
+ "returns": "Equivalent duration in milliseconds.",
1704
1704
  "tags": [
1705
1705
  "date",
1706
1706
  "time",
@@ -1731,11 +1731,11 @@
1731
1731
  {
1732
1732
  "name": "minutes",
1733
1733
  "type": "number",
1734
- "description": "- number of minutes (defaults to 1)",
1734
+ "description": "- Number of minutes (defaults to 1)",
1735
1735
  "optional": true
1736
1736
  }
1737
1737
  ],
1738
- "returns": "equivalent duration in milliseconds",
1738
+ "returns": "Equivalent duration in milliseconds.",
1739
1739
  "tags": [
1740
1740
  "date",
1741
1741
  "time",
@@ -1766,11 +1766,11 @@
1766
1766
  {
1767
1767
  "name": "days",
1768
1768
  "type": "number",
1769
- "description": "- number of days (defaults to 1)",
1769
+ "description": "- Number of days (defaults to 1)",
1770
1770
  "optional": true
1771
1771
  }
1772
1772
  ],
1773
- "returns": "equivalent duration in minutes",
1773
+ "returns": "Equivalent duration in minutes.",
1774
1774
  "tags": [
1775
1775
  "date",
1776
1776
  "time",
@@ -1800,11 +1800,11 @@
1800
1800
  {
1801
1801
  "name": "date",
1802
1802
  "type": "Date",
1803
- "description": "- date to check",
1803
+ "description": "- Date to check.",
1804
1804
  "optional": false
1805
1805
  }
1806
1806
  ],
1807
- "returns": "whether the date is the max future sentinel",
1807
+ "returns": "Whether the date is the max future sentinel.",
1808
1808
  "tags": [
1809
1809
  "date",
1810
1810
  "sentinel",
@@ -1833,11 +1833,11 @@
1833
1833
  {
1834
1834
  "name": "time",
1835
1835
  "type": "Date",
1836
- "description": "- date to truncate (defaults to now)",
1836
+ "description": "- Date to truncate (defaults to now)",
1837
1837
  "optional": true
1838
1838
  }
1839
1839
  ],
1840
- "returns": "date rounded down to the start of the minute",
1840
+ "returns": "Date rounded down to the start of the minute.",
1841
1841
  "tags": [
1842
1842
  "date",
1843
1843
  "minute",
@@ -1863,11 +1863,11 @@
1863
1863
  {
1864
1864
  "name": "input",
1865
1865
  "type": "DateOrDateString",
1866
- "description": "- date or date string to convert",
1866
+ "description": "- Date or date string to convert.",
1867
1867
  "optional": false
1868
1868
  }
1869
1869
  ],
1870
- "returns": "the ISO 8601 string representation",
1870
+ "returns": "The ISO 8601 string representation.",
1871
1871
  "tags": [
1872
1872
  "date",
1873
1873
  "iso",
@@ -1895,7 +1895,7 @@
1895
1895
  "signature": "guessCurrentTimezone(): TimezoneString | undefined",
1896
1896
  "description": "Guesses the current system's timezone using the Intl API.",
1897
1897
  "params": [],
1898
- "returns": "the IANA timezone string (e.g. \"America/Chicago\"), or undefined if detection fails",
1898
+ "returns": "The IANA timezone string (e.g. \"America/Chicago\"), or undefined if detection fails.",
1899
1899
  "tags": [
1900
1900
  "date",
1901
1901
  "timezone",
@@ -1921,7 +1921,7 @@
1921
1921
  "signature": "requireCurrentTimezone(): TimezoneString",
1922
1922
  "description": "Returns the current system's timezone, throwing if detection fails.\n\nConvenience wrapper around {@link guessCurrentTimezone} for contexts where a timezone is required.",
1923
1923
  "params": [],
1924
- "returns": "the IANA timezone string",
1924
+ "returns": "The IANA timezone string.",
1925
1925
  "tags": [
1926
1926
  "date",
1927
1927
  "timezone",
@@ -1950,11 +1950,11 @@
1950
1950
  {
1951
1951
  "name": "input",
1952
1952
  "type": "Maybe<DateOrDateString | UTCDateString>",
1953
- "description": "- date, date string, or null/undefined",
1953
+ "description": "- Date, date string, or null/undefined.",
1954
1954
  "optional": false
1955
1955
  }
1956
1956
  ],
1957
- "returns": "the parsed Date or undefined if input was nullish",
1957
+ "returns": "The parsed Date or undefined if input was nullish.",
1958
1958
  "tags": [
1959
1959
  "date",
1960
1960
  "parse",
@@ -1985,11 +1985,11 @@
1985
1985
  {
1986
1986
  "name": "input",
1987
1987
  "type": "DateOrDateString | UTCDateString | UnixDateTimeMillisecondsNumber",
1988
- "description": "- value to convert",
1988
+ "description": "- Value to convert.",
1989
1989
  "optional": false
1990
1990
  }
1991
1991
  ],
1992
- "returns": "the parsed Date",
1992
+ "returns": "The parsed Date.",
1993
1993
  "tags": [
1994
1994
  "date",
1995
1995
  "parse",
@@ -2022,11 +2022,11 @@
2022
2022
  {
2023
2023
  "name": "input",
2024
2024
  "type": "ISO8601DateString | UTCDateString | UnixDateTimeMillisecondsNumber",
2025
- "description": "- ISO 8601 string, UTC date string, or unix milliseconds",
2025
+ "description": "- ISO 8601 string, UTC date string, or unix milliseconds.",
2026
2026
  "optional": false
2027
2027
  }
2028
2028
  ],
2029
- "returns": "the parsed Date, or undefined if invalid",
2029
+ "returns": "The parsed Date, or undefined if invalid.",
2030
2030
  "tags": [
2031
2031
  "date",
2032
2032
  "parse",
@@ -2326,11 +2326,11 @@
2326
2326
  {
2327
2327
  "name": "date",
2328
2328
  "type": "Date",
2329
- "description": "- date to round (defaults to now)",
2329
+ "description": "- Moment to round; defaults to the current date/time.",
2330
2330
  "optional": true
2331
2331
  }
2332
2332
  ],
2333
- "returns": "the date with seconds and milliseconds set to zero",
2333
+ "returns": "Copy of the input with seconds and milliseconds set to zero.",
2334
2334
  "tags": [
2335
2335
  "date",
2336
2336
  "round",
@@ -2362,11 +2362,11 @@
2362
2362
  {
2363
2363
  "name": "date",
2364
2364
  "type": "Date",
2365
- "description": "- date to round (defaults to now)",
2365
+ "description": "- Moment to round; defaults to the current date/time.",
2366
2366
  "optional": true
2367
2367
  }
2368
2368
  ],
2369
- "returns": "the date with minutes, seconds, and milliseconds set to zero",
2369
+ "returns": "Copy of the input with minutes, seconds, and milliseconds set to zero.",
2370
2370
  "tags": [
2371
2371
  "date",
2372
2372
  "round",
@@ -118,7 +118,7 @@
118
118
  "source"
119
119
  ],
120
120
  "skillRefs": [
121
- "dbx__ref__dbx-component-patterns"
121
+ "dbx-component-patterns"
122
122
  ]
123
123
  },
124
124
  {
@@ -2173,7 +2173,7 @@
2173
2173
  {
2174
2174
  "name": "tone",
2175
2175
  "type": "Maybe<DbxColorTone>",
2176
- "description": "Background tone level for tonal appearance. Defaults to {@link DBX_CHIP_DEFAULT_TONE}.\n\nSet to `100` for fully opaque background.",
2176
+ "description": "Background tone level for tonal appearance. Defaults to {@link DEFAULT_DBX_CHIP_TONE}.\n\nSet to `100` for fully opaque background.",
2177
2177
  "required": false
2178
2178
  }
2179
2179
  ],