@synergy-design-system/metadata 1.0.0 → 3.0.1

package/data/layers/interface/component/component:syn-validate.json

@@ -0,0 +1,226 @@
+{
+  "attributes": [
+    {
+      "default": "''",
+      "description": "Custom validation message to be displayed when the input is invalid.\nWill override the default browser validation message.\nSet to an empty string to reset the validation message.",
+      "fieldName": "customValidationMessage",
+      "name": "custom-validation-message",
+      "reflects": false,
+      "type": "string"
+    },
+    {
+      "default": "false",
+      "description": "Set this to true to validate the input immediately when it is rendered.\nBest used with a `variant` of `inline`.\nWhen setting eager, the input will not be focused automatically.\n\nWhen using a `variant` of `native` the browser will focus\nthe last eager field as it is using a tooltip.\nIn this case it is better to just provide one eager field.",
+      "fieldName": "eager",
+      "name": "eager",
+      "reflects": false,
+      "type": "boolean"
+    },
+    {
+      "default": "false",
+      "description": "Do not show the error icon when using the inline variant validation",
+      "fieldName": "hideIcon",
+      "name": "hide-icon",
+      "reflects": true,
+      "type": "boolean"
+    },
+    {
+      "default": "''",
+      "description": "Defines the events that trigger the validation.\n`invalid` will always automatically be included.\nYou may also use the `live` keyword to validate on every input change.\n`live` will make sure to listen to the `invalid`, `input` and `blur` events.\n\nPlease have a look at the [documentation for native form validation](https://developer.mozilla.org/en-US/docs/Learn/Forms/Form_validation)\nand [the use of form invalid events](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event) for further information.",
+      "fieldName": "on",
+      "name": "on",
+      "reflects": true,
+      "type": "string"
+    },
+    {
+      "default": "'native'",
+      "description": "The variant that should be used to show validation alerts.\n\nThe following variants are supported:\n- **native** (default): Uses the native browser validation, usually a browser tooltip.\n- **tooltip**: Show the validation message as a tooltip using a `<syn-tooltip>`.\n- **inline**: Show the validation message underneath the element, using a `<syn-alert>`",
+      "fieldName": "variant",
+      "name": "variant",
+      "reflects": true,
+      "type": "'native' | 'tooltip' | 'inline'"
+    }
+  ],
+  "cssParts": [
+    {
+      "description": "The syn-alert that is shown when the variant is set to \"inline\".",
+      "name": "alert"
+    },
+    {
+      "description": "The container that wraps the alert.",
+      "name": "alert__base"
+    },
+    {
+      "description": "The container that wraps the alert icon.",
+      "name": "alert__icon"
+    },
+    {
+      "description": "The container that wraps the alert message.",
+      "name": "alert__message"
+    },
+    {
+      "description": "The component's base wrapper.",
+      "name": "base"
+    },
+    {
+      "description": "The container that wraps the form field.",
+      "name": "input-wrapper"
+    },
+    {
+      "description": "The syn-tooltip that is shown when the variant is set to \"tooltip\".",
+      "name": "tooltip"
+    },
+    {
+      "description": "The container that wraps the tooltip arrow.",
+      "name": "tooltip__arrow"
+    },
+    {
+      "description": "The container that wraps the tooltip.",
+      "name": "tooltip__base"
+    },
+    {
+      "description": "The container that wraps the tooltip body.",
+      "name": "tooltip__body"
+    },
+    {
+      "description": "The container that wraps the tooltip popup.",
+      "name": "tooltip__popup"
+    }
+  ],
+  "dependencies": [
+    "syn-alert",
+    "syn-tooltip"
+  ],
+  "documentation": "https://synergy-design-system.github.io/?path=/docs/components-syn-validate--docs",
+  "events": [],
+  "figmaComponentId": "41310-284767",
+  "methods": [
+    {
+      "description": "Returns the validity state of the input component.\n`true` for valid and `false` for invalid.",
+      "name": "getValidity",
+      "parameters": []
+    },
+    {
+      "description": "",
+      "name": "handleCustomValidationMessageChange",
+      "parameters": []
+    },
+    {
+      "description": "",
+      "name": "handleEagerChange",
+      "parameters": []
+    },
+    {
+      "description": "",
+      "name": "handleListenerChange",
+      "parameters": []
+    }
+  ],
+  "properties": [
+    {
+      "access": "public",
+      "description": "",
+      "name": "alertSize",
+      "type": "SynInput['size'] | undefined"
+    },
+    {
+      "access": "public",
+      "default": "new AbortController()",
+      "description": "",
+      "name": "controller"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "Custom validation message to be displayed when the input is invalid.\nWill override the default browser validation message.\nSet to an empty string to reset the validation message.",
+      "name": "customValidationMessage",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "Set this to true to validate the input immediately when it is rendered.\nBest used with a `variant` of `inline`.\nWhen setting eager, the input will not be focused automatically.\n\nWhen using a `variant` of `native` the browser will focus\nthe last eager field as it is using a tooltip.\nIn this case it is better to just provide one eager field.",
+      "name": "eager",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "true",
+      "description": "",
+      "name": "eagerFirstMount",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "",
+      "name": "hasFocus",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "Do not show the error icon when using the inline variant validation",
+      "name": "hideIcon",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "false",
+      "description": "",
+      "name": "isInternalTriggeredInvalid",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "default": "true",
+      "description": "",
+      "name": "isValid",
+      "type": "boolean"
+    },
+    {
+      "access": "public",
+      "description": "",
+      "name": "observer",
+      "type": "MutationObserver"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "Defines the events that trigger the validation.\n`invalid` will always automatically be included.\nYou may also use the `live` keyword to validate on every input change.\n`live` will make sure to listen to the `invalid`, `input` and `blur` events.\n\nPlease have a look at the [documentation for native form validation](https://developer.mozilla.org/en-US/docs/Learn/Forms/Form_validation)\nand [the use of form invalid events](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event) for further information.",
+      "name": "on",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "description": "",
+      "name": "sizeObserver",
+      "type": "MutationObserver"
+    },
+    {
+      "access": "public",
+      "default": "''",
+      "description": "",
+      "name": "validationMessage",
+      "type": "string"
+    },
+    {
+      "access": "public",
+      "default": "'native'",
+      "description": "The variant that should be used to show validation alerts.\n\nThe following variants are supported:\n- **native** (default): Uses the native browser validation, usually a browser tooltip.\n- **tooltip**: Show the validation message as a tooltip using a `<syn-tooltip>`.\n- **inline**: Show the validation message underneath the element, using a `<syn-alert>`",
+      "name": "variant",
+      "type": "'native' | 'tooltip' | 'inline'"
+    }
+  ],
+  "since": "unknown",
+  "slots": [
+    {
+      "description": "The form field that should be validated. Avoid slotting in more than one element, as subsequent ones will be ignored.",
+      "name": ""
+    }
+  ],
+  "sourceModulePath": "components/validate/validate.js",
+  "status": "stable",
+  "summary": "Validate provides form field validation messages in a unified way.\nIt does this by using [the native browser validation](https://developer.mozilla.org/en-US/docs/Learn/Forms/Form_validation)\nand showing the validation message in a consistent, user defined way.",
+  "tagName": "syn-validate"
+}

package/data/layers/interface/component/component:syn-validate.md

@@ -0,0 +1,102 @@
+# syn-validate
+
+## Summary
+
+Validate provides form field validation messages in a unified way.
+It does this by using [the native browser validation](https://developer.mozilla.org/en-US/docs/Learn/Forms/Form_validation)
+and showing the validation message in a consistent, user defined way.
+
+## Documentation
+
+- [Component Documentation](https://synergy-design-system.github.io/?path=/docs/components-syn-validate--docs)
+- [Figma Design](https://www.figma.com/file/bZFqk9urD3NlghGUKrkKCR/Synergy-Digital-Design-System?type=design&node-id=41310-284767)
+
+## Class Information
+
+- **Tag Name:** `syn-validate`
+- **Import Example:** `import SynValidate from '@synergy-design-system/components/components/validate/validate.js';`
+
+## Usage Information
+
+- **Status:** stable
+- **Since:** unknown
+
+## Available Slots
+
+- `(default)`: The form field that should be validated. Avoid slotting in more than one element, as subsequent ones will be ignored.
+
+## Available Properties
+
+### customValidationMessage
+
+attribute: `custom-validation-message`
+reflects: no
+type: `string`
+default: `''`
+
+Custom validation message to be displayed when the input is invalid. Will override the default browser validation message. Set to an empty string to reset the validation message.
+
+### eager
+
+attribute: `eager`
+reflects: no
+type: `boolean`
+default: `false`
+
+Set this to true to validate the input immediately when it is rendered. Best used with a `variant` of `inline`. When setting eager, the input will not be focused automatically. When using a `variant` of `native` the browser will focus the last eager field as it is using a tooltip. In this case it is better to just provide one eager field.
+
+### hideIcon
+
+attribute: `hide-icon`
+reflects: yes
+type: `boolean`
+default: `false`
+
+Do not show the error icon when using the inline variant validation
+
+### on
+
+attribute: `on`
+reflects: yes
+type: `string`
+default: `''`
+
+Defines the events that trigger the validation. `invalid` will always automatically be included. You may also use the `live` keyword to validate on every input change. `live` will make sure to listen to the `invalid`, `input` and `blur` events. Please have a look at the [documentation for native form validation](https://developer.mozilla.org/en-US/docs/Learn/Forms/Form_validation) and [the use of form invalid events](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event) for further information.
+
+### variant
+
+attribute: `variant`
+reflects: yes
+type: `'native' | 'tooltip' | 'inline'`
+default: `'native'`
+
+The variant that should be used to show validation alerts. The following variants are supported: - **native** (default): Uses the native browser validation, usually a browser tooltip. - **tooltip**: Show the validation message as a tooltip using a `<syn-tooltip>`. - **inline**: Show the validation message underneath the element, using a `<syn-alert>`
+
+## Available Methods
+
+### getValidity()
+
+parameters: -
+returns: `void`
+
+Returns the validity state of the input component.
+`true` for valid and `false` for invalid.
+
+## Available CSS Parts
+
+- `alert`: The syn-alert that is shown when the variant is set to "inline".
+- `alert__base`: The container that wraps the alert.
+- `alert__icon`: The container that wraps the alert icon.
+- `alert__message`: The container that wraps the alert message.
+- `base`: The component's base wrapper.
+- `input-wrapper`: The container that wraps the form field.
+- `tooltip`: The syn-tooltip that is shown when the variant is set to "tooltip".
+- `tooltip__arrow`: The container that wraps the tooltip arrow.
+- `tooltip__base`: The container that wraps the tooltip.
+- `tooltip__body`: The container that wraps the tooltip body.
+- `tooltip__popup`: The container that wraps the tooltip popup.
+
+## Dependencies
+
+- `syn-alert`
+- `syn-tooltip`

package/data/manifest.json

@@ -0,0 +1,47 @@
+{
+  "builtAt": "2026-04-28T09:14:39.906Z",
+  "sources": [
+    {
+      "entityCount": 4,
+      "source": "angular",
+      "status": "success"
+    },
+    {
+      "entityCount": 8,
+      "source": "assets",
+      "status": "success"
+    },
+    {
+      "entityCount": 56,
+      "source": "components",
+      "status": "success"
+    },
+    {
+      "entityCount": 2,
+      "source": "fonts",
+      "status": "success"
+    },
+    {
+      "entityCount": 1,
+      "source": "react",
+      "status": "success"
+    },
+    {
+      "entityCount": 8,
+      "source": "styles",
+      "status": "success"
+    },
+    {
+      "entityCount": 12,
+      "source": "tokens",
+      "status": "success"
+    },
+    {
+      "entityCount": 1,
+      "source": "vue",
+      "status": "success"
+    }
+  ],
+  "synergyVersion": "local",
+  "version": "1.0.0"
+}

package/data/schemas/core-entity.schema.json

@@ -0,0 +1,130 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "custom": {
+      "additionalProperties": {},
+      "propertyNames": {
+        "type": "string"
+      },
+      "type": "object"
+    },
+    "id": {
+      "type": "string"
+    },
+    "kind": {
+      "enum": [
+        "asset",
+        "component",
+        "style",
+        "setup",
+        "template",
+        "token",
+        "utility"
+      ],
+      "type": "string"
+    },
+    "layers": {
+      "additionalProperties": {
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "layer": {
+              "enum": [
+                "examples",
+                "interface",
+                "full"
+              ],
+              "type": "string"
+            },
+            "path": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "layer",
+            "path"
+          ],
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "default": {},
+      "propertyNames": {
+        "type": "string"
+      },
+      "type": "object"
+    },
+    "name": {
+      "type": "string"
+    },
+    "package": {
+      "type": "string"
+    },
+    "relations": {
+      "default": [],
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "dependsOn",
+              "usedBy",
+              "partOf",
+              "relates"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "type"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "since": {
+      "type": "string"
+    },
+    "sources": {
+      "default": [],
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "status": {
+      "enum": [
+        "stable",
+        "beta",
+        "experimental",
+        "deprecated"
+      ],
+      "type": "string"
+    },
+    "tags": {
+      "default": [],
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "id",
+    "kind",
+    "layers",
+    "name",
+    "package",
+    "relations",
+    "since",
+    "sources",
+    "status",
+    "tags"
+  ],
+  "type": "object"
+}

package/data/schemas/layer-ref.schema.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "layer": {
+      "enum": [
+        "examples",
+        "interface",
+        "full"
+      ],
+      "type": "string"
+    },
+    "path": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "layer",
+    "path"
+  ],
+  "type": "object"
+}

package/data/schemas/manifest.schema.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "buildInfo": {
+      "additionalProperties": false,
+      "properties": {
+        "branch": {
+          "type": "string"
+        },
+        "ci": {
+          "type": "boolean"
+        },
+        "commit": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "builtAt": {
+      "format": "date-time",
+      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+      "type": "string"
+    },
+    "checksums": {
+      "additionalProperties": {
+        "type": "string"
+      },
+      "propertyNames": {
+        "type": "string"
+      },
+      "type": "object"
+    },
+    "sources": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "entityCount": {
+            "type": "number"
+          },
+          "error": {
+            "type": "string"
+          },
+          "source": {
+            "type": "string"
+          },
+          "status": {
+            "enum": [
+              "success",
+              "partial",
+              "failed"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "source",
+          "status"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "synergyVersion": {
+      "type": "string"
+    },
+    "version": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "builtAt",
+    "version"
+  ],
+  "type": "object"
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Public package entrypoint.
+ * Internal collectors/pipeline/CLI modules are intentionally not exported.
+ */
+export * from './public/index.js';

package/dist/index.js

@@ -0,0 +1,5 @@
+/**
+ * Public package entrypoint.
+ * Internal collectors/pipeline/CLI modules are intentionally not exported.
+ */
+export * from './public/index.js';

package/dist/public/domains/assets.d.ts

@@ -0,0 +1,34 @@
+import { type AssetCustom, type IconSearchQuery, type IconSearchResult, type MetadataEntity, type MetadataStoreOptions, type PublicRequestOptions, type PublicResponse } from '../types.js';
+/** Query options for listing or resolving asset entities. */
+export type AssetQueryOptions = PublicRequestOptions & {
+    status?: string;
+    tags?: string[];
+};
+/** Pagination controls for icon search results. */
+export type IconSearchOptions = {
+    limit?: number;
+    offset?: number;
+};
+/**
+ * List all available asset entities, optionally filtered by status and/or tags.
+ * @param options The query options to filter and paginate the results.
+ * @param storeOptions Options for configuring the metadata store instance used to fetch the data.
+ * @returns A public response containing the list of asset entities matching the query, along with metadata about the request and any errors or warnings.
+ */
+export declare const listAssets: (options?: AssetQueryOptions, storeOptions?: MetadataStoreOptions) => Promise<PublicResponse<MetadataEntity<AssetCustom>[]>>;
+/**
+ * Get metadata for a specific asset entity by its name or ID.
+ * @param nameOrId The name or ID of the asset entity to retrieve.
+ * @param options The query options to filter and paginate the results.
+ * @param storeOptions Options for configuring the metadata store instance used to fetch the data.
+ * @returns A public response containing the asset entity metadata, along with metadata about the request and any errors or warnings.
+ */
+export declare const getAssetMetadata: (nameOrId: string, options?: AssetQueryOptions, storeOptions?: MetadataStoreOptions) => Promise<PublicResponse<MetadataEntity<AssetCustom> | null>>;
+/**
+ * Search icons across asset icon sets using name/category/tag filters.
+ * @param query Filter criteria for icon names, categories, tags, and optional icon-set scope.
+ * @param options Pagination controls for result slicing.
+ * @param storeOptions Optional metadata store configuration.
+ * @returns Matching icons and standard response metadata.
+ */
+export declare const searchIcons: (query: IconSearchQuery, options?: IconSearchOptions, storeOptions?: MetadataStoreOptions) => Promise<PublicResponse<IconSearchResult[]>>;