@openframe-org/criteria-set-protocol 2.1.2 → 2.1.4

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 (14) hide show
  1. package/dist/v1/schemas/criteria-set.d.ts +0 -6
  2. package/dist/v1/schemas/criteria-set.js +0 -7
  3. package/dist/v1/schemas/criteria-tree.d.ts +24 -236
  4. package/dist/v1/schemas/criterion.d.ts +5 -63
  5. package/dist/v1/schemas/criterion.js +0 -14
  6. package/dist/v1/schemas/task-group.d.ts +4 -47
  7. package/dist/v1/schemas/task-group.js +3 -11
  8. package/dist/v1/schemas/task.d.ts +0 -14
  9. package/dist/v1/schemas/task.js +0 -7
  10. package/dist/v1/schemas/theme.d.ts +7 -87
  11. package/dist/v1/schemas/theme.js +0 -14
  12. package/dist/v1/utils.d.ts +4 -0
  13. package/dist/v1/utils.js +6 -1
  14. package/package.json +1 -1
package/dist/v1/schemas/theme.d.ts CHANGED
@@ -50,14 +50,6 @@ export declare const themeStyleSchema: z.ZodObject<{
50
50
  };
51
51
  }>;
52
52
  export declare const themeOptionsSchema: z.ZodObject<{
53
- /**
54
- * @deprecated use breadcrumbTextFormat instead, where breadcrumbTextFormat = hideCode === true ? ':code:' : ':title:'
55
- */
56
- hideCode: z.ZodOptional<z.ZodBoolean>;
57
- /**
58
- * @deprecated use hideFromBreadcrumbs, hideFromDocumentTree and hideCodeInReport instead
59
- */
60
- hideFromHierarchy: z.ZodOptional<z.ZodBoolean>;
61
53
  breadcrumbTextFormat: z.ZodDefault<z.ZodOptional<z.ZodString>>;
62
54
  hideFromBreadcrumbs: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
63
55
  documentTreeFolderTextFormat: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -69,13 +61,9 @@ export declare const themeOptionsSchema: z.ZodObject<{
69
61
  hideFromBreadcrumbs: boolean;
70
62
  hideFromDocumentTree: boolean;
71
63
  hideCodeInReport: boolean;
72
- hideCode?: boolean | undefined;
73
- hideFromHierarchy?: boolean | undefined;
74
64
  }, {
75
- hideCode?: boolean | undefined;
76
65
  breadcrumbTextFormat?: string | undefined;
77
66
  documentTreeFolderTextFormat?: string | undefined;
78
- hideFromHierarchy?: boolean | undefined;
79
67
  hideFromBreadcrumbs?: boolean | undefined;
80
68
  hideFromDocumentTree?: boolean | undefined;
81
69
  hideCodeInReport?: boolean | undefined;
@@ -927,7 +915,6 @@ export declare const themeSchema: z.ZodObject<{
927
915
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
928
916
  }>>, "many">;
929
917
  options: z.ZodOptional<z.ZodObject<{
930
- hideCode: z.ZodOptional<z.ZodBoolean>;
931
918
  breadcrumbTextFormat: z.ZodDefault<z.ZodOptional<z.ZodString>>;
932
919
  documentTreeFolderTextFormat: z.ZodDefault<z.ZodOptional<z.ZodString>>;
933
920
  showCodeAsIndicatorTaskViewTitle: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
@@ -935,9 +922,7 @@ export declare const themeSchema: z.ZodObject<{
935
922
  breadcrumbTextFormat: string;
936
923
  documentTreeFolderTextFormat: string;
937
924
  showCodeAsIndicatorTaskViewTitle: boolean;
938
- hideCode?: boolean | undefined;
939
925
  }, {
940
- hideCode?: boolean | undefined;
941
926
  breadcrumbTextFormat?: string | undefined;
942
927
  documentTreeFolderTextFormat?: string | undefined;
943
928
  showCodeAsIndicatorTaskViewTitle?: boolean | undefined;
@@ -1048,7 +1033,6 @@ export declare const themeSchema: z.ZodObject<{
1048
1033
  breadcrumbTextFormat: string;
1049
1034
  documentTreeFolderTextFormat: string;
1050
1035
  showCodeAsIndicatorTaskViewTitle: boolean;
1051
- hideCode?: boolean | undefined;
1052
1036
  } | undefined;
1053
1037
  description?: string | undefined;
1054
1038
  longFormTitle?: string | undefined;
@@ -1172,7 +1156,6 @@ export declare const themeSchema: z.ZodObject<{
1172
1156
  readOnly?: boolean | undefined;
1173
1157
  } | undefined;
1174
1158
  options?: {
1175
- hideCode?: boolean | undefined;
1176
1159
  breadcrumbTextFormat?: string | undefined;
1177
1160
  documentTreeFolderTextFormat?: string | undefined;
1178
1161
  showCodeAsIndicatorTaskViewTitle?: boolean | undefined;
@@ -1197,16 +1180,7 @@ export declare const themeSchema: z.ZodObject<{
1197
1180
  })[] | undefined;
1198
1181
  sortOrder?: number | undefined;
1199
1182
  }>>, "many">;
1200
- options: z.ZodOptional<z.ZodObject<{
1201
- hideCode: z.ZodOptional<z.ZodBoolean>;
1202
- hideFromHierarchy: z.ZodOptional<z.ZodBoolean>;
1203
- }, "strip", z.ZodTypeAny, {
1204
- hideCode?: boolean | undefined;
1205
- hideFromHierarchy?: boolean | undefined;
1206
- }, {
1207
- hideCode?: boolean | undefined;
1208
- hideFromHierarchy?: boolean | undefined;
1209
- }>>;
1183
+ options: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
1210
1184
  }, "strip", z.ZodTypeAny, {
1211
1185
  code: string;
1212
1186
  type: "task-group";
@@ -1317,7 +1291,6 @@ export declare const themeSchema: z.ZodObject<{
1317
1291
  breadcrumbTextFormat: string;
1318
1292
  documentTreeFolderTextFormat: string;
1319
1293
  showCodeAsIndicatorTaskViewTitle: boolean;
1320
- hideCode?: boolean | undefined;
1321
1294
  } | undefined;
1322
1295
  description?: string | undefined;
1323
1296
  longFormTitle?: string | undefined;
@@ -1351,10 +1324,7 @@ export declare const themeSchema: z.ZodObject<{
1351
1324
  step?: number | undefined;
1352
1325
  readOnly?: boolean | undefined;
1353
1326
  } | undefined;
1354
- options?: {
1355
- hideCode?: boolean | undefined;
1356
- hideFromHierarchy?: boolean | undefined;
1357
- } | undefined;
1327
+ options?: {} | undefined;
1358
1328
  description?: string | undefined;
1359
1329
  longFormTitle?: string | undefined;
1360
1330
  tags?: string[] | undefined;
@@ -1482,7 +1452,6 @@ export declare const themeSchema: z.ZodObject<{
1482
1452
  readOnly?: boolean | undefined;
1483
1453
  } | undefined;
1484
1454
  options?: {
1485
- hideCode?: boolean | undefined;
1486
1455
  breadcrumbTextFormat?: string | undefined;
1487
1456
  documentTreeFolderTextFormat?: string | undefined;
1488
1457
  showCodeAsIndicatorTaskViewTitle?: boolean | undefined;
@@ -1519,10 +1488,7 @@ export declare const themeSchema: z.ZodObject<{
1519
1488
  step?: number | undefined;
1520
1489
  readOnly?: boolean | undefined;
1521
1490
  } | undefined;
1522
- options?: {
1523
- hideCode?: boolean | undefined;
1524
- hideFromHierarchy?: boolean | undefined;
1525
- } | undefined;
1491
+ options?: {} | undefined;
1526
1492
  description?: string | undefined;
1527
1493
  longFormTitle?: string | undefined;
1528
1494
  tags?: string[] | undefined;
@@ -1545,8 +1511,6 @@ export declare const themeSchema: z.ZodObject<{
1545
1511
  category?: string | undefined;
1546
1512
  }>>, "many">;
1547
1513
  options: z.ZodOptional<z.ZodObject<{
1548
- hideCode: z.ZodOptional<z.ZodBoolean>;
1549
- hideFromHierarchy: z.ZodOptional<z.ZodBoolean>;
1550
1514
  breadcrumbTextFormat: z.ZodDefault<z.ZodOptional<z.ZodString>>;
1551
1515
  documentTreeFolderTextFormat: z.ZodDefault<z.ZodOptional<z.ZodString>>;
1552
1516
  hideFromBreadcrumbs: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
@@ -1558,13 +1522,9 @@ export declare const themeSchema: z.ZodObject<{
1558
1522
  hideFromBreadcrumbs: boolean;
1559
1523
  hideFromDocumentTree: boolean;
1560
1524
  hideCodeInReport: boolean;
1561
- hideCode?: boolean | undefined;
1562
- hideFromHierarchy?: boolean | undefined;
1563
1525
  }, {
1564
- hideCode?: boolean | undefined;
1565
1526
  breadcrumbTextFormat?: string | undefined;
1566
1527
  documentTreeFolderTextFormat?: string | undefined;
1567
- hideFromHierarchy?: boolean | undefined;
1568
1528
  hideFromBreadcrumbs?: boolean | undefined;
1569
1529
  hideFromDocumentTree?: boolean | undefined;
1570
1530
  hideCodeInReport?: boolean | undefined;
@@ -1683,7 +1643,6 @@ export declare const themeSchema: z.ZodObject<{
1683
1643
  breadcrumbTextFormat: string;
1684
1644
  documentTreeFolderTextFormat: string;
1685
1645
  showCodeAsIndicatorTaskViewTitle: boolean;
1686
- hideCode?: boolean | undefined;
1687
1646
  } | undefined;
1688
1647
  description?: string | undefined;
1689
1648
  longFormTitle?: string | undefined;
@@ -1717,10 +1676,7 @@ export declare const themeSchema: z.ZodObject<{
1717
1676
  step?: number | undefined;
1718
1677
  readOnly?: boolean | undefined;
1719
1678
  } | undefined;
1720
- options?: {
1721
- hideCode?: boolean | undefined;
1722
- hideFromHierarchy?: boolean | undefined;
1723
- } | undefined;
1679
+ options?: {} | undefined;
1724
1680
  description?: string | undefined;
1725
1681
  longFormTitle?: string | undefined;
1726
1682
  tags?: string[] | undefined;
@@ -1760,8 +1716,6 @@ export declare const themeSchema: z.ZodObject<{
1760
1716
  hideFromBreadcrumbs: boolean;
1761
1717
  hideFromDocumentTree: boolean;
1762
1718
  hideCodeInReport: boolean;
1763
- hideCode?: boolean | undefined;
1764
- hideFromHierarchy?: boolean | undefined;
1765
1719
  } | undefined;
1766
1720
  longFormTitle?: string | undefined;
1767
1721
  tags?: string[] | undefined;
@@ -1892,7 +1846,6 @@ export declare const themeSchema: z.ZodObject<{
1892
1846
  readOnly?: boolean | undefined;
1893
1847
  } | undefined;
1894
1848
  options?: {
1895
- hideCode?: boolean | undefined;
1896
1849
  breadcrumbTextFormat?: string | undefined;
1897
1850
  documentTreeFolderTextFormat?: string | undefined;
1898
1851
  showCodeAsIndicatorTaskViewTitle?: boolean | undefined;
@@ -1929,10 +1882,7 @@ export declare const themeSchema: z.ZodObject<{
1929
1882
  step?: number | undefined;
1930
1883
  readOnly?: boolean | undefined;
1931
1884
  } | undefined;
1932
- options?: {
1933
- hideCode?: boolean | undefined;
1934
- hideFromHierarchy?: boolean | undefined;
1935
- } | undefined;
1885
+ options?: {} | undefined;
1936
1886
  description?: string | undefined;
1937
1887
  longFormTitle?: string | undefined;
1938
1888
  tags?: string[] | undefined;
@@ -1967,10 +1917,8 @@ export declare const themeSchema: z.ZodObject<{
1967
1917
  readOnly?: boolean | undefined;
1968
1918
  } | undefined;
1969
1919
  options?: {
1970
- hideCode?: boolean | undefined;
1971
1920
  breadcrumbTextFormat?: string | undefined;
1972
1921
  documentTreeFolderTextFormat?: string | undefined;
1973
- hideFromHierarchy?: boolean | undefined;
1974
1922
  hideFromBreadcrumbs?: boolean | undefined;
1975
1923
  hideFromDocumentTree?: boolean | undefined;
1976
1924
  hideCodeInReport?: boolean | undefined;
@@ -1995,14 +1943,6 @@ export declare const themeSchema: z.ZodObject<{
1995
1943
  sortOrder?: number | undefined;
1996
1944
  }>, "many">;
1997
1945
  options: z.ZodOptional<z.ZodObject<{
1998
- /**
1999
- * @deprecated use breadcrumbTextFormat instead, where breadcrumbTextFormat = hideCode === true ? ':code:' : ':title:'
2000
- */
2001
- hideCode: z.ZodOptional<z.ZodBoolean>;
2002
- /**
2003
- * @deprecated use hideFromBreadcrumbs, hideFromDocumentTree and hideCodeInReport instead
2004
- */
2005
- hideFromHierarchy: z.ZodOptional<z.ZodBoolean>;
2006
1946
  breadcrumbTextFormat: z.ZodDefault<z.ZodOptional<z.ZodString>>;
2007
1947
  hideFromBreadcrumbs: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
2008
1948
  documentTreeFolderTextFormat: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -2014,13 +1954,9 @@ export declare const themeSchema: z.ZodObject<{
2014
1954
  hideFromBreadcrumbs: boolean;
2015
1955
  hideFromDocumentTree: boolean;
2016
1956
  hideCodeInReport: boolean;
2017
- hideCode?: boolean | undefined;
2018
- hideFromHierarchy?: boolean | undefined;
2019
1957
  }, {
2020
- hideCode?: boolean | undefined;
2021
1958
  breadcrumbTextFormat?: string | undefined;
2022
1959
  documentTreeFolderTextFormat?: string | undefined;
2023
- hideFromHierarchy?: boolean | undefined;
2024
1960
  hideFromBreadcrumbs?: boolean | undefined;
2025
1961
  hideFromDocumentTree?: boolean | undefined;
2026
1962
  hideCodeInReport?: boolean | undefined;
@@ -2143,7 +2079,6 @@ export declare const themeSchema: z.ZodObject<{
2143
2079
  breadcrumbTextFormat: string;
2144
2080
  documentTreeFolderTextFormat: string;
2145
2081
  showCodeAsIndicatorTaskViewTitle: boolean;
2146
- hideCode?: boolean | undefined;
2147
2082
  } | undefined;
2148
2083
  description?: string | undefined;
2149
2084
  longFormTitle?: string | undefined;
@@ -2177,10 +2112,7 @@ export declare const themeSchema: z.ZodObject<{
2177
2112
  step?: number | undefined;
2178
2113
  readOnly?: boolean | undefined;
2179
2114
  } | undefined;
2180
- options?: {
2181
- hideCode?: boolean | undefined;
2182
- hideFromHierarchy?: boolean | undefined;
2183
- } | undefined;
2115
+ options?: {} | undefined;
2184
2116
  description?: string | undefined;
2185
2117
  longFormTitle?: string | undefined;
2186
2118
  tags?: string[] | undefined;
@@ -2220,8 +2152,6 @@ export declare const themeSchema: z.ZodObject<{
2220
2152
  hideFromBreadcrumbs: boolean;
2221
2153
  hideFromDocumentTree: boolean;
2222
2154
  hideCodeInReport: boolean;
2223
- hideCode?: boolean | undefined;
2224
- hideFromHierarchy?: boolean | undefined;
2225
2155
  } | undefined;
2226
2156
  longFormTitle?: string | undefined;
2227
2157
  tags?: string[] | undefined;
@@ -2272,8 +2202,6 @@ export declare const themeSchema: z.ZodObject<{
2272
2202
  hideFromBreadcrumbs: boolean;
2273
2203
  hideFromDocumentTree: boolean;
2274
2204
  hideCodeInReport: boolean;
2275
- hideCode?: boolean | undefined;
2276
- hideFromHierarchy?: boolean | undefined;
2277
2205
  } | undefined;
2278
2206
  longFormTitle?: string | undefined;
2279
2207
  tags?: string[] | undefined;
@@ -2408,7 +2336,6 @@ export declare const themeSchema: z.ZodObject<{
2408
2336
  readOnly?: boolean | undefined;
2409
2337
  } | undefined;
2410
2338
  options?: {
2411
- hideCode?: boolean | undefined;
2412
2339
  breadcrumbTextFormat?: string | undefined;
2413
2340
  documentTreeFolderTextFormat?: string | undefined;
2414
2341
  showCodeAsIndicatorTaskViewTitle?: boolean | undefined;
@@ -2445,10 +2372,7 @@ export declare const themeSchema: z.ZodObject<{
2445
2372
  step?: number | undefined;
2446
2373
  readOnly?: boolean | undefined;
2447
2374
  } | undefined;
2448
- options?: {
2449
- hideCode?: boolean | undefined;
2450
- hideFromHierarchy?: boolean | undefined;
2451
- } | undefined;
2375
+ options?: {} | undefined;
2452
2376
  description?: string | undefined;
2453
2377
  longFormTitle?: string | undefined;
2454
2378
  tags?: string[] | undefined;
@@ -2483,10 +2407,8 @@ export declare const themeSchema: z.ZodObject<{
2483
2407
  readOnly?: boolean | undefined;
2484
2408
  } | undefined;
2485
2409
  options?: {
2486
- hideCode?: boolean | undefined;
2487
2410
  breadcrumbTextFormat?: string | undefined;
2488
2411
  documentTreeFolderTextFormat?: string | undefined;
2489
- hideFromHierarchy?: boolean | undefined;
2490
2412
  hideFromBreadcrumbs?: boolean | undefined;
2491
2413
  hideFromDocumentTree?: boolean | undefined;
2492
2414
  hideCodeInReport?: boolean | undefined;
@@ -2535,10 +2457,8 @@ export declare const themeSchema: z.ZodObject<{
2535
2457
  };
2536
2458
  } | undefined;
2537
2459
  options?: {
2538
- hideCode?: boolean | undefined;
2539
2460
  breadcrumbTextFormat?: string | undefined;
2540
2461
  documentTreeFolderTextFormat?: string | undefined;
2541
- hideFromHierarchy?: boolean | undefined;
2542
2462
  hideFromBreadcrumbs?: boolean | undefined;
2543
2463
  hideFromDocumentTree?: boolean | undefined;
2544
2464
  hideCodeInReport?: boolean | undefined;
package/dist/v1/schemas/theme.js CHANGED
@@ -12,20 +12,6 @@ exports.themeStyleSchema = zod_1.z
12
12
  .describe("ThemeStyle - Style configuration for the theme's visual appearance");
13
13
  exports.themeOptionsSchema = zod_1.z
14
14
  .object({
15
- /**
16
- * @deprecated use breadcrumbTextFormat instead, where breadcrumbTextFormat = hideCode === true ? ':code:' : ':title:'
17
- */
18
- hideCode: zod_1.z
19
- .boolean()
20
- .optional()
21
- .describe(`Deprecated. Use breadcrumbTextFormat instead, where breadcrumbTextFormat = hideCode === true ? ':code:' : ':title:'`),
22
- /**
23
- * @deprecated use hideFromBreadcrumbs, hideFromDocumentTree and hideCodeInReport instead
24
- */
25
- hideFromHierarchy: zod_1.z
26
- .boolean()
27
- .optional()
28
- .describe("Deprecated. Use hideFromBreadcrumbs, hideFromDocumentTree and hideCodeInReport instead"),
29
15
  breadcrumbTextFormat: zod_1.z
30
16
  .string()
31
17
  .optional()
package/dist/v1/utils.d.ts CHANGED
@@ -12,3 +12,7 @@ export declare const toColorHexString: (color: Color) => string;
12
12
  * Find an element in the criteria tree by its code
13
13
  */
14
14
  export declare const findInTree: (tree: CriteriaTree, code: string) => CriteriaTreeElement | null;
15
+ /**
16
+ * Apply the text formatting used in document tree folder and breadcrumb naming
17
+ */
18
+ export declare const applyTextFormattingPlaceholders: (documentTreeTextFormat: string, element: Exclude<CriteriaTreeElement, TaskItem>) => string;
package/dist/v1/utils.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.findInTree = exports.toColorHexString = exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isTheme = void 0;
3
+ exports.applyTextFormattingPlaceholders = exports.findInTree = exports.toColorHexString = exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isTheme = void 0;
4
4
  const isTheme = (element) => element.type === "theme";
5
5
  exports.isTheme = isTheme;
6
6
  const isCriterion = (element) => element.type === "criterion";
@@ -42,3 +42,8 @@ const findInTree = (tree, code) => {
42
42
  return searchElements(tree.themes);
43
43
  };
44
44
  exports.findInTree = findInTree;
45
+ /**
46
+ * Apply the text formatting used in document tree folder and breadcrumb naming
47
+ */
48
+ const applyTextFormattingPlaceholders = (documentTreeTextFormat, element) => documentTreeTextFormat.replace(/:code:/g, element.code).replace(/:title:/g, element.title);
49
+ exports.applyTextFormattingPlaceholders = applyTextFormattingPlaceholders;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openframe-org/criteria-set-protocol",
3
- "version": "2.1.2",
3
+ "version": "2.1.4",
4
4
  "description": "A protocol and tools for defining and working with criteria sets",
5
5
  "private": false,
6
6
  "author": "Andrés Angulo <aa@openframe.org>",