@json-layout/vocabulary - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

package.json

 {
   "name": "@json-layout/vocabulary",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Main JSON Layout vocabulary as JSON schemas and Typescript types. Also contains some small utility functions to validate and normalize annotations.",
@@ -5,0 +5,0 @@ "type": "module",

src/components/types.ts

@@ -19,3 +19,3 @@ import type {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -96,3 +96,3 @@ });
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -122,3 +122,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -141,3 +141,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -160,3 +160,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -182,3 +182,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -193,3 +193,3 @@ });
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -204,3 +204,3 @@ });
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -220,3 +220,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -236,3 +236,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -251,3 +251,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -266,3 +266,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -277,3 +277,3 @@ });
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -305,3 +305,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -333,3 +333,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -361,3 +361,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -394,3 +394,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -417,3 +417,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -440,3 +440,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -457,3 +457,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -483,3 +483,3 @@ }) &
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -486,0 +486,0 @@ }) & {

src/layout-keyword/schema.js

@@ -57,2 +57,8 @@
         },
+        "hint": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
         "title": {
@@ -59,0 +65,0 @@ "type": [

src/layout-keyword/schema.json

@@ -35,2 +35,3 @@ {
         "label": {"type": "string"},
+        "hint": {"type": ["string", "null"]},
         "title": {"type": ["string", "null"]},
@@ -37,0 +38,0 @@ "subtitle": {"type": ["string", "null"]},

src/layout-keyword/types.ts

@@ -135,2 +135,3 @@ /**
   label?: string;
+  hint?: string | null;
   title?: string | null;
@@ -137,0 +138,0 @@ subtitle?: string | null;

src/normalize.js

@@ -467,5 +467,9 @@ import { validateLayoutKeyword, isComponentName, isPartialCompObject, isPartialChildren, isPartialSwitch, isPartialGetItemsExpr, isPartialGetItemsObj, isPartialSlotMarkdown, isPartialGetItemsFetch, isPartialChildComposite } from './layout-keyword/index.js'
     } else if (!component.composite && useDescription.includes('hint')) {
-      partial.hint = schemaFragment.description
-    } else if (partial.help === undefined && schemaChild !== 'oneOf' && useDescription.includes('help')) {
-      partial.help = schemaFragment.description
+      if (partial.hint === undefined) {
+        partial.hint = schemaFragment.description
+      }
+    } else if (schemaChild !== 'oneOf' && useDescription.includes('help')) {
+      if (partial.help === undefined) {
+        partial.help = schemaFragment.description
+      }
     }
@@ -472,0 +476,0 @@ }

src/normalized-layout/schema.js

@@ -153,3 +153,6 @@
             "hint": {
-              "type": "string"
+              "type": [
+                "string",
+                "null"
+              ]
             }
@@ -156,0 +159,0 @@ }

src/normalized-layout/schema.json

@@ -81,3 +81,3 @@ {
             "label": {"type": "string"},
-            "hint": {"type": "string"}
+            "hint": {"type": ["string", "null"]}
           }
@@ -84,0 +84,0 @@ }

src/normalized-layout/types.ts

@@ -79,3 +79,3 @@ /**
   label?: string;
-  hint?: string;
+  hint?: string | null;
   [k: string]: unknown;
@@ -82,0 +82,0 @@ };

types/components/types.d.ts

@@ -8,3 +8,3 @@ import type { BaseCompObject, Expression, Children, GetItems, SelectItems } from '../normalized-layout/types.js';
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -78,3 +78,3 @@ });
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -103,3 +103,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -120,3 +120,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -137,3 +137,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -157,3 +157,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -167,3 +167,3 @@ });
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -177,3 +177,3 @@ });
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -192,3 +192,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -207,3 +207,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -221,3 +221,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -235,3 +235,3 @@ }) & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -245,3 +245,3 @@ });
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -269,3 +269,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -293,3 +293,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -317,3 +317,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -346,3 +346,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -366,3 +366,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -386,3 +386,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -401,3 +401,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -424,3 +424,3 @@ }) & (BaseCompObject & {
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -427,0 +427,0 @@ }) & {

types/layout-keyword/schema.d.ts

@@ -42,2 +42,5 @@ declare namespace _default {
                 };
+                hint: {
+                    type: string[];
+                };
                 title: {
@@ -44,0 +47,0 @@ type: string[];

types/layout-keyword/types.d.ts

@@ -128,2 +128,3 @@ /**
     label?: string;
+    hint?: string | null;
     title?: string | null;
@@ -130,0 +131,0 @@ subtitle?: string | null;

types/normalized-layout/schema.d.ts

@@ -132,3 +132,3 @@ declare namespace _default {
                     hint: {
-                        type: string;
+                        type: string[];
                     };
@@ -135,0 +135,0 @@ };

types/normalized-layout/types.d.ts

@@ -76,3 +76,3 @@ /**
     label?: string;
-    hint?: string;
+    hint?: string | null;
     [k: string]: unknown;
@@ -79,0 +79,0 @@ };

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

200143

increased by0.51%

Lines of code

5708

increased by0.33%

No dependency changes