@synergy-design-system/metadata 3.7.0 → 3.9.0

package/dist/intentPolicy/domains/action/patterns/submit.js

@@ -0,0 +1,58 @@
+export const actionSubmitPattern = {
+    description: 'Submit action with semantic submit type and filled emphasis.',
+    intent: 'action.submit',
+    notes: ['Do not combine submit intent with href-based navigation behavior.'],
+    structure: {
+        component: 'syn-button',
+        config: {
+            contentRules: [
+                {
+                    code: 'REQUIRED_CONTENT_BUTTON_LABEL',
+                    kind: 'requiredContent',
+                    message: 'syn-button must contain visible content (text and/or child nodes).',
+                    rationale: 'An empty button is inaccessible and provides no affordance to the user.',
+                    suggestedFix: 'Add a label, text, or child element such as syn-icon inside the button.',
+                },
+            ],
+            propRules: [
+                {
+                    code: 'REQUIRED_PROP_SUBMIT_TYPE',
+                    kind: 'requiredEquals',
+                    message: 'type property must be set to "submit" for submit action intent.',
+                    prop: 'type',
+                    rationale: 'The semantic submit type ensures proper form submission behavior.',
+                    suggestedFix: 'Set type property to "submit".',
+                    value: 'submit',
+                },
+                {
+                    code: 'REQUIRED_PROP_FILLED_VARIANT',
+                    kind: 'requiredEquals',
+                    message: 'variant property should be set to "filled" for action emphasis.',
+                    prop: 'variant',
+                    rationale: 'Filled variant provides clear visual priority for actions.',
+                    suggestedFix: 'Set variant property to "filled".',
+                    value: 'filled',
+                },
+                {
+                    code: 'FORBIDDEN_PROP_HREF',
+                    kind: 'forbidden',
+                    message: 'href property is not compatible with submit action intent.',
+                    prop: 'href',
+                    rationale: 'Submit intent uses form submission semantics, not navigation. Use action.navigation for link-based navigation.',
+                    suggestedFix: 'Remove href property and use a form or event handler for submission.',
+                },
+                {
+                    code: 'INTENT_TEMPORARILY_BLOCKED',
+                    kind: 'warnWhenEquals',
+                    message: 'Submit intent is currently blocked because the control is disabled.',
+                    prop: 'disabled',
+                    rationale: 'This can be intentional in gated flows where the control is enabled after form input becomes valid.',
+                    severity: 'warning',
+                    suggestedFix: 'Enable the control once the form becomes valid so users can complete submission.',
+                    value: true,
+                },
+            ],
+        },
+    },
+    target: { id: 'component:syn-button', kind: 'component', name: 'syn-button' },
+};

package/dist/intentPolicy/domains/assistance/capabilities.d.ts

@@ -0,0 +1,2 @@
+import type { IntentCapability } from '../../types.js';
+export declare const assistanceCapabilities: IntentCapability[];

package/dist/intentPolicy/domains/assistance/capabilities.js

@@ -0,0 +1,10 @@
+export const assistanceCapabilities = [
+    {
+        categories: ['assistance'],
+        target: { id: 'component:syn-tooltip', kind: 'component', name: 'syn-tooltip' },
+    },
+    {
+        categories: ['assistance'],
+        target: { id: 'component:syn-icon', kind: 'component', name: 'syn-icon' },
+    },
+];

package/dist/intentPolicy/domains/assistance/category.d.ts

@@ -0,0 +1,2 @@
+import type { IntentCategory } from '../../types.js';
+export declare const assistanceCategory: IntentCategory;

package/dist/intentPolicy/domains/assistance/category.js

@@ -0,0 +1,4 @@
+export const assistanceCategory = {
+    description: 'Contextual micro-guidance for nearby controls or content.',
+    id: 'assistance',
+};

package/dist/intentPolicy/domains/assistance/index.d.ts

@@ -0,0 +1,4 @@
+export { assistanceCapabilities } from './capabilities.js';
+export { assistanceCategory } from './category.js';
+export { assistanceIntents } from './intents.js';
+export { assistancePatterns } from './patterns.js';

package/dist/intentPolicy/domains/assistance/index.js

@@ -0,0 +1,4 @@
+export { assistanceCapabilities } from './capabilities.js';
+export { assistanceCategory } from './category.js';
+export { assistanceIntents } from './intents.js';
+export { assistancePatterns } from './patterns.js';

package/dist/intentPolicy/domains/assistance/intents.d.ts

@@ -0,0 +1,2 @@
+import type { IntentDefinition } from '../../types.js';
+export declare const assistanceIntents: IntentDefinition[];

package/dist/intentPolicy/domains/assistance/intents.js

@@ -0,0 +1,14 @@
+export const assistanceIntents = [
+    {
+        category: 'assistance',
+        description: 'Use tooltip guidance for short, non-critical contextual help.',
+        id: 'assistance.tooltip.contextual',
+        userGoal: 'Clarify a nearby control or value with concise supplemental text.',
+    },
+    {
+        category: 'assistance',
+        description: 'Use contextual icons to visually support meaning near controls or status text.',
+        id: 'assistance.icon.contextual',
+        userGoal: 'Improve scannability and comprehension with compact visual cues.',
+    },
+];

package/dist/intentPolicy/domains/assistance/patterns.d.ts

@@ -0,0 +1,2 @@
+import type { IntentUsagePattern } from '../../types.js';
+export declare const assistancePatterns: IntentUsagePattern[];

package/dist/intentPolicy/domains/assistance/patterns.js

@@ -0,0 +1,13 @@
+export const assistancePatterns = [
+    {
+        description: 'Short non-critical contextual help tied to a nearby trigger.',
+        intent: 'assistance.tooltip.contextual',
+        target: { id: 'component:syn-tooltip', kind: 'component', name: 'syn-tooltip' },
+    },
+    {
+        description: 'Contextual icon used as a compact visual hint near related content.',
+        intent: 'assistance.icon.contextual',
+        notes: ['Use alongside text or tooltips when meaning is not universally obvious.'],
+        target: { id: 'component:syn-icon', kind: 'component', name: 'syn-icon' },
+    },
+];

package/dist/intentPolicy/domains/disclosure/capabilities.d.ts

@@ -0,0 +1,2 @@
+import type { IntentCapability } from '../../types.js';
+export declare const disclosureCapabilities: IntentCapability[];

package/dist/intentPolicy/domains/disclosure/capabilities.js

@@ -0,0 +1,14 @@
+export const disclosureCapabilities = [
+    {
+        categories: ['disclosure'],
+        target: { id: 'component:syn-details', kind: 'component', name: 'syn-details' },
+    },
+    {
+        categories: ['disclosure'],
+        target: { id: 'component:syn-accordion', kind: 'component', name: 'syn-accordion' },
+    },
+    {
+        categories: ['disclosure'],
+        target: { id: 'component:syn-popup', kind: 'component', name: 'syn-popup' },
+    },
+];

package/dist/intentPolicy/domains/disclosure/category.d.ts

@@ -0,0 +1,2 @@
+import type { IntentCategory } from '../../types.js';
+export declare const disclosureCategory: IntentCategory;

package/dist/intentPolicy/domains/disclosure/category.js

@@ -0,0 +1,4 @@
+export const disclosureCategory = {
+    description: 'Progressive disclosure of secondary information.',
+    id: 'disclosure',
+};

package/dist/intentPolicy/domains/disclosure/index.d.ts

@@ -0,0 +1,4 @@
+export { disclosureCapabilities } from './capabilities.js';
+export { disclosureCategory } from './category.js';
+export { disclosureIntents } from './intents.js';
+export { disclosurePatterns } from './patterns.js';

package/dist/intentPolicy/domains/disclosure/index.js

@@ -0,0 +1,4 @@
+export { disclosureCapabilities } from './capabilities.js';
+export { disclosureCategory } from './category.js';
+export { disclosureIntents } from './intents.js';
+export { disclosurePatterns } from './patterns.js';

package/dist/intentPolicy/domains/disclosure/intents.d.ts

@@ -0,0 +1,2 @@
+import type { IntentDefinition } from '../../types.js';
+export declare const disclosureIntents: IntentDefinition[];

package/dist/intentPolicy/domains/disclosure/intents.js

@@ -0,0 +1,20 @@
+export const disclosureIntents = [
+    {
+        category: 'disclosure',
+        description: 'Use details to progressively reveal one block of optional content.',
+        id: 'disclosure.details.on-demand',
+        userGoal: 'Show extra information only when requested by the user.',
+    },
+    {
+        category: 'disclosure',
+        description: 'Use accordions to reveal grouped sections and reduce information overload.',
+        id: 'disclosure.accordion.grouped',
+        userGoal: 'Organize larger content into scannable, expandable sections.',
+    },
+    {
+        category: 'disclosure',
+        description: 'Use popups to reveal related secondary content on demand near a trigger.',
+        id: 'disclosure.popup.on-demand',
+        userGoal: 'Show contextual secondary content without navigating away.',
+    },
+];

package/dist/intentPolicy/domains/disclosure/patterns.d.ts

@@ -0,0 +1,2 @@
+import type { IntentUsagePattern } from '../../types.js';
+export declare const disclosurePatterns: IntentUsagePattern[];

package/dist/intentPolicy/domains/disclosure/patterns.js

@@ -0,0 +1,23 @@
+export const disclosurePatterns = [
+    {
+        description: 'On-demand disclosure for one optional information block.',
+        intent: 'disclosure.details.on-demand',
+        target: { id: 'component:syn-details', kind: 'component', name: 'syn-details' },
+    },
+    {
+        description: 'Grouped progressive disclosure for multiple related sections.',
+        intent: 'disclosure.accordion.grouped',
+        preset: {
+            props: {
+                'close-others': true,
+            },
+        },
+        target: { id: 'component:syn-accordion', kind: 'component', name: 'syn-accordion' },
+    },
+    {
+        description: 'On-demand popup disclosure anchored to a trigger element.',
+        intent: 'disclosure.popup.on-demand',
+        notes: ['Keep popup content concise and directly related to the trigger context.'],
+        target: { id: 'component:syn-popup', kind: 'component', name: 'syn-popup' },
+    },
+];

package/dist/intentPolicy/domains/feedback/capabilities.d.ts

@@ -0,0 +1,2 @@
+import type { IntentCapability } from '../../types.js';
+export declare const feedbackCapabilities: IntentCapability[];

package/dist/intentPolicy/domains/feedback/capabilities.js

@@ -0,0 +1,42 @@
+export const feedbackCapabilities = [
+    {
+        categories: ['feedback'],
+        target: {
+            id: 'component:syn-alert',
+            kind: 'component',
+            name: 'syn-alert',
+        },
+    },
+    {
+        categories: ['feedback'],
+        target: {
+            id: 'component:syn-badge',
+            kind: 'component',
+            name: 'syn-badge',
+        },
+    },
+    {
+        categories: ['feedback'],
+        target: {
+            id: 'component:syn-tag',
+            kind: 'component',
+            name: 'syn-tag',
+        },
+    },
+    {
+        categories: ['feedback'],
+        target: {
+            id: 'component:syn-tag-group',
+            kind: 'component',
+            name: 'syn-tag-group',
+        },
+    },
+    {
+        categories: ['feedback'],
+        target: {
+            id: 'component:syn-validate',
+            kind: 'component',
+            name: 'syn-validate',
+        },
+    },
+];

package/dist/intentPolicy/domains/feedback/category.d.ts

@@ -0,0 +1,2 @@
+import type { IntentCategory } from '../../types.js';
+export declare const feedbackCategory: IntentCategory;

package/dist/intentPolicy/domains/feedback/category.js

@@ -0,0 +1,4 @@
+export const feedbackCategory = {
+    description: 'Contextual user feedback such as inline or toast notifications.',
+    id: 'feedback',
+};

package/dist/intentPolicy/domains/feedback/index.d.ts

@@ -0,0 +1,4 @@
+export { feedbackCapabilities } from './capabilities.js';
+export { feedbackCategory } from './category.js';
+export { feedbackIntents } from './intents.js';
+export { feedbackPatterns } from './patterns.js';

package/dist/intentPolicy/domains/feedback/index.js

@@ -0,0 +1,4 @@
+export { feedbackCapabilities } from './capabilities.js';
+export { feedbackCategory } from './category.js';
+export { feedbackIntents } from './intents.js';
+export { feedbackPatterns } from './patterns.js';

package/dist/intentPolicy/domains/feedback/intents.d.ts

@@ -0,0 +1,2 @@
+import type { IntentDefinition } from '../../types.js';
+export declare const feedbackIntents: IntentDefinition[];

package/dist/intentPolicy/domains/feedback/intents.js

@@ -0,0 +1,32 @@
+export const feedbackIntents = [
+    {
+        category: 'feedback',
+        description: 'Use when contextual feedback should remain near the affected content.',
+        id: 'feedback.inline',
+        userGoal: 'Explain outcome directly in the current workflow context.',
+    },
+    {
+        category: 'feedback',
+        description: 'Use when a short, non-blocking overlay notification is sufficient.',
+        id: 'feedback.toast',
+        userGoal: 'Acknowledge an event without interrupting the current task.',
+    },
+    {
+        category: 'feedback',
+        description: 'Use badges to communicate compact status or count information inline.',
+        id: 'feedback.badge.status',
+        userGoal: 'Expose concise status signals without interrupting surrounding content.',
+    },
+    {
+        category: 'feedback',
+        description: 'Use tag labels to communicate categorization or state in compact form.',
+        id: 'feedback.tag.label',
+        userGoal: 'Help users identify and scan categories or states quickly.',
+    },
+    {
+        category: 'feedback',
+        description: 'Use generic validation feedback to explain invalid or missing input.',
+        id: 'feedback.validation.generic',
+        userGoal: 'Guide users to correct invalid form input with clear feedback.',
+    },
+];

package/dist/intentPolicy/domains/feedback/patterns.d.ts

@@ -0,0 +1,2 @@
+import type { IntentUsagePattern } from '../../types.js';
+export declare const feedbackPatterns: IntentUsagePattern[];

package/dist/intentPolicy/domains/feedback/patterns.js

@@ -0,0 +1,44 @@
+export const feedbackPatterns = [
+    {
+        description: 'Inline alert for contextual feedback near related content.',
+        intent: 'feedback.inline',
+        preset: {
+            props: {
+                duration: 0,
+                variant: 'warning',
+            },
+        },
+        target: { id: 'component:syn-alert', kind: 'component', name: 'syn-alert' },
+    },
+    {
+        description: 'Toast alert for brief, non-blocking status acknowledgement.',
+        intent: 'feedback.toast',
+        preset: {
+            props: {
+                duration: 4000,
+                variant: 'success',
+            },
+        },
+        target: { id: 'component:syn-alert', kind: 'component', name: 'syn-alert' },
+    },
+    {
+        description: 'Compact status or count feedback using badge visuals.',
+        intent: 'feedback.badge.status',
+        target: { id: 'component:syn-badge', kind: 'component', name: 'syn-badge' },
+    },
+    {
+        description: 'Compact categorical or state labeling using tags.',
+        intent: 'feedback.tag.label',
+        target: { id: 'component:syn-tag', kind: 'component', name: 'syn-tag' },
+    },
+    {
+        description: 'Grouped tags for concise display of multiple labels or states.',
+        intent: 'feedback.tag.label',
+        target: { id: 'component:syn-tag-group', kind: 'component', name: 'syn-tag-group' },
+    },
+    {
+        description: 'Generic validation feedback for incorrect or missing user input.',
+        intent: 'feedback.validation.generic',
+        target: { id: 'component:syn-validate', kind: 'component', name: 'syn-validate' },
+    },
+];

package/dist/intentPolicy/domains/input/capabilities.d.ts

@@ -0,0 +1,2 @@
+import type { IntentCapability } from '../../types.js';
+export declare const inputCapabilities: IntentCapability[];

package/dist/intentPolicy/domains/input/capabilities.js

@@ -0,0 +1,38 @@
+export const inputCapabilities = [
+    {
+        categories: ['input'],
+        target: { id: 'component:syn-input', kind: 'component', name: 'syn-input' },
+    },
+    {
+        categories: ['input'],
+        target: { id: 'component:syn-textarea', kind: 'component', name: 'syn-textarea' },
+    },
+    {
+        categories: ['input'],
+        target: { id: 'component:syn-select', kind: 'component', name: 'syn-select' },
+    },
+    {
+        categories: ['input'],
+        target: { id: 'component:syn-combobox', kind: 'component', name: 'syn-combobox' },
+    },
+    {
+        categories: ['input'],
+        target: { id: 'component:syn-checkbox', kind: 'component', name: 'syn-checkbox' },
+    },
+    {
+        categories: ['input'],
+        target: { id: 'component:syn-switch', kind: 'component', name: 'syn-switch' },
+    },
+    {
+        categories: ['input'],
+        target: { id: 'component:syn-radio-group', kind: 'component', name: 'syn-radio-group' },
+    },
+    {
+        categories: ['input'],
+        target: { id: 'component:syn-file', kind: 'component', name: 'syn-file' },
+    },
+    {
+        categories: ['input'],
+        target: { id: 'component:syn-range', kind: 'component', name: 'syn-range' },
+    },
+];

package/dist/intentPolicy/domains/input/category.d.ts

@@ -0,0 +1,2 @@
+import type { IntentCategory } from '../../types.js';
+export declare const inputCategory: IntentCategory;

package/dist/intentPolicy/domains/input/category.js

@@ -0,0 +1,4 @@
+export const inputCategory = {
+    description: 'Data-entry and selection intents for forms and controls.',
+    id: 'input',
+};

package/dist/intentPolicy/domains/input/index.d.ts

@@ -0,0 +1,4 @@
+export { inputCapabilities } from './capabilities.js';
+export { inputCategory } from './category.js';
+export { inputIntents } from './intents.js';
+export { inputPatterns } from './patterns.js';

package/dist/intentPolicy/domains/input/index.js

@@ -0,0 +1,4 @@
+export { inputCapabilities } from './capabilities.js';
+export { inputCategory } from './category.js';
+export { inputIntents } from './intents.js';
+export { inputPatterns } from './patterns.js';

package/dist/intentPolicy/domains/input/intents.d.ts

@@ -0,0 +1,2 @@
+import type { IntentDefinition } from '../../types.js';
+export declare const inputIntents: IntentDefinition[];

package/dist/intentPolicy/domains/input/intents.js

@@ -0,0 +1,62 @@
+export const inputIntents = [
+    {
+        category: 'input',
+        description: 'Use when a user should provide short, single-line text input.',
+        id: 'input.text.short',
+        userGoal: 'Capture compact textual or numeric values in a form field.',
+    },
+    {
+        category: 'input',
+        description: 'Use when a user should provide longer, multi-line input.',
+        id: 'input.text.long',
+        userGoal: 'Capture detailed comments, descriptions, or narrative responses.',
+    },
+    {
+        category: 'input',
+        description: 'Use when one option should be selected from predefined choices.',
+        id: 'input.selection.single',
+        userGoal: 'Make one explicit selection from a known set.',
+    },
+    {
+        category: 'input',
+        description: 'Use when multiple options should be selected from predefined choices.',
+        id: 'input.selection.multiple',
+        userGoal: 'Select multiple relevant options in one control.',
+    },
+    {
+        category: 'input',
+        description: 'Use when options are numerous and should be filtered by typing.',
+        id: 'input.selection.searchable',
+        userGoal: 'Find and select options quickly through live filtering.',
+    },
+    {
+        category: 'input',
+        description: 'Use for binary choices that apply immediately on toggle.',
+        id: 'input.binary.immediate',
+        userGoal: 'Enable or disable a setting with instant effect.',
+    },
+    {
+        category: 'input',
+        description: 'Use for binary choices that are submitted later with the form.',
+        id: 'input.binary.deferred',
+        userGoal: 'Record a binary preference without immediate side effects.',
+    },
+    {
+        category: 'input',
+        description: 'Use when files or folders must be attached or uploaded.',
+        id: 'input.file.upload',
+        userGoal: 'Provide one or more local files for processing.',
+    },
+    {
+        category: 'input',
+        description: 'Use sliders when selecting a numeric value within a bounded range.',
+        id: 'input.range.slider',
+        userGoal: 'Pick a value quickly with immediate visual feedback across a range.',
+    },
+    {
+        category: 'input',
+        description: 'Use grouped options to organize long option lists into logical clusters.',
+        id: 'input.selection.grouped-options',
+        userGoal: 'Find and choose options faster through labeled option groupings.',
+    },
+];

package/dist/intentPolicy/domains/input/patterns.d.ts

@@ -0,0 +1,2 @@
+import type { IntentUsagePattern } from '../../types.js';
+export declare const inputPatterns: IntentUsagePattern[];

package/dist/intentPolicy/domains/input/patterns.js

@@ -0,0 +1,99 @@
+export const inputPatterns = [
+    {
+        description: 'Single-line input for compact text or numeric values.',
+        intent: 'input.text.short',
+        preset: {
+            props: {
+                type: 'text',
+            },
+        },
+        target: { id: 'component:syn-input', kind: 'component', name: 'syn-input' },
+    },
+    {
+        description: 'Multiline text entry for detailed user-provided information.',
+        intent: 'input.text.long',
+        preset: {
+            props: {
+                resize: 'vertical',
+            },
+        },
+        target: { id: 'component:syn-textarea', kind: 'component', name: 'syn-textarea' },
+    },
+    {
+        description: 'Single selection from a predefined options list.',
+        intent: 'input.selection.single',
+        preset: {
+            props: {
+                multiple: false,
+            },
+        },
+        target: { id: 'component:syn-select', kind: 'component', name: 'syn-select' },
+    },
+    {
+        description: 'Multiple selection from a predefined options list.',
+        intent: 'input.selection.multiple',
+        preset: {
+            props: {
+                multiple: true,
+            },
+        },
+        target: { id: 'component:syn-select', kind: 'component', name: 'syn-select' },
+    },
+    {
+        description: 'Searchable selection with real-time filtering for larger option sets.',
+        intent: 'input.selection.searchable',
+        preset: {
+            props: {
+                autocomplete: 'list',
+            },
+        },
+        target: { id: 'component:syn-combobox', kind: 'component', name: 'syn-combobox' },
+    },
+    {
+        description: 'Binary toggle that applies changes immediately.',
+        intent: 'input.binary.immediate',
+        preset: {
+            props: {
+                checked: false,
+            },
+        },
+        target: { id: 'component:syn-switch', kind: 'component', name: 'syn-switch' },
+    },
+    {
+        description: 'Binary selection captured as part of a later form submit.',
+        intent: 'input.binary.deferred',
+        preset: {
+            props: {
+                checked: false,
+            },
+        },
+        target: { id: 'component:syn-checkbox', kind: 'component', name: 'syn-checkbox' },
+    },
+    {
+        description: 'Single required choice among related options.',
+        intent: 'input.selection.single',
+        notes: ['Provide one default selected option as recommended in component usage rules.'],
+        target: { id: 'component:syn-radio-group', kind: 'component', name: 'syn-radio-group' },
+    },
+    {
+        description: 'File attachment or upload control with optional multi-file mode.',
+        intent: 'input.file.upload',
+        preset: {
+            props: {
+                multiple: false,
+            },
+        },
+        target: { id: 'component:syn-file', kind: 'component', name: 'syn-file' },
+    },
+    {
+        description: 'Bounded numeric selection through a slider control.',
+        intent: 'input.range.slider',
+        target: { id: 'component:syn-range', kind: 'component', name: 'syn-range' },
+    },
+    {
+        description: 'Grouped select options organized through optgroup labels.',
+        intent: 'input.selection.grouped-options',
+        notes: ['Use syn-optgroup to cluster related syn-option entries under clear labels.'],
+        target: { id: 'component:syn-select', kind: 'component', name: 'syn-select' },
+    },
+];

package/dist/intentPolicy/domains/navigation/capabilities.d.ts

@@ -0,0 +1,2 @@
+import type { IntentCapability } from '../../types.js';
+export declare const navigationCapabilities: IntentCapability[];