@imj_media/ui 1.11.4 → 1.12.0

package/catalog/semantic-catalog.json

@@ -0,0 +1,187 @@
+{
+  "schemaVersion": "1.0.0",
+  "entries": [
+    {
+      "id": "table-data-registry",
+      "moduleId": "Table",
+      "exportName": "Table",
+      "displayName": "Table",
+      "importPath": "@imj_media/ui",
+      "importSymbol": "Table",
+      "replacesGeneric": ["DataTable", "ReferenceTable", "OrbitDataGrid"],
+      "semantic": {
+        "classification": ["DataRegistry", "Configuration", "AuditLog"],
+        "capabilities": ["search", "pagination", "advancedFilter", "export", "selection"]
+      },
+      "dataBinding": {
+        "kind": "rest",
+        "rowsProp": "rows",
+        "columnsProp": "columns",
+        "toolbarSearchProp": "toolbar.showSearch",
+        "paginationProp": "pagination"
+      },
+      "entityHints": {
+        "preferredKeyFields": ["id", "name", "created_at", "status"],
+        "statusFieldCandidates": ["status", "state", "estado"]
+      }
+    },
+    {
+      "id": "table-workflow-fallback",
+      "moduleId": "Table",
+      "exportName": "Table",
+      "displayName": "Table",
+      "importPath": "@imj_media/ui",
+      "importSymbol": "Table",
+      "replacesGeneric": ["KanbanBoard", "KanbanOrderBoard", "OrbitKanban"],
+      "semantic": {
+        "classification": ["WorkflowProcess"],
+        "capabilities": ["stateTracking", "search", "pagination"]
+      },
+      "dataBinding": {
+        "kind": "stateMachine",
+        "rowsProp": "rows",
+        "columnsProp": "columns",
+        "stateField": "status",
+        "lifecycleToColumn": true
+      },
+      "entityHints": {
+        "preferredKeyFields": ["id", "status", "name", "updated_at"],
+        "statusFieldCandidates": ["status", "state", "estado"]
+      },
+      "limitations": ["no_native_drag_drop", "use_table_with_status_column"]
+    },
+    {
+      "id": "ghantt-timeline",
+      "moduleId": "Ghantt",
+      "exportName": "Ghantt",
+      "displayName": "Ghantt",
+      "importPath": "@imj_media/ui",
+      "importSymbol": "Ghantt",
+      "replacesGeneric": ["GanttChart", "TimelineBoard"],
+      "semantic": {
+        "classification": ["TimelineEntity"],
+        "capabilities": ["timeline", "search", "pagination"]
+      },
+      "dataBinding": {
+        "kind": "rest",
+        "rowsProp": "rows",
+        "columnsProp": "columns"
+      },
+      "entityHints": {
+        "preferredKeyFields": ["id", "start_date", "end_date", "name"]
+      }
+    },
+    {
+      "id": "lists-master",
+      "moduleId": "Lists",
+      "exportName": "Lists",
+      "displayName": "Lists",
+      "importPath": "@imj_media/ui",
+      "importSymbol": "Lists",
+      "replacesGeneric": ["ListView", "MasterListView"],
+      "semantic": {
+        "classification": ["MasterList"],
+        "capabilities": ["search", "selection"]
+      },
+      "dataBinding": {
+        "kind": "rest",
+        "itemsProp": "list.items"
+      },
+      "entityHints": {
+        "preferredKeyFields": ["id", "title", "name"]
+      }
+    },
+    {
+      "id": "lists-notification-feed",
+      "moduleId": "Lists",
+      "exportName": "Lists",
+      "displayName": "Lists",
+      "importPath": "@imj_media/ui",
+      "importSymbol": "Lists",
+      "replacesGeneric": ["FeedList", "NotificationList"],
+      "semantic": {
+        "classification": ["NotificationFeed"],
+        "capabilities": ["notification", "search"]
+      },
+      "dataBinding": {
+        "kind": "rest",
+        "itemsProp": "list.items"
+      },
+      "entityHints": {
+        "preferredKeyFields": ["id", "message", "created_at", "read"]
+      }
+    },
+    {
+      "id": "filters-bar",
+      "moduleId": "Filters",
+      "exportName": "Filters",
+      "displayName": "Filters",
+      "importPath": "@imj_media/ui",
+      "importSymbol": "Filters",
+      "replacesGeneric": ["SearchBar", "FilterPanel"],
+      "semantic": {
+        "classification": ["FilterBar"],
+        "capabilities": ["advancedFilter", "search"]
+      },
+      "dataBinding": {
+        "kind": "static",
+        "filtersProp": "filters"
+      }
+    },
+    {
+      "id": "header-filter-bar",
+      "moduleId": "Header",
+      "exportName": "Header",
+      "displayName": "Header",
+      "importPath": "@imj_media/ui",
+      "importSymbol": "Header",
+      "replacesGeneric": ["PageHeader", "FilterHeader"],
+      "semantic": {
+        "classification": ["FilterBar"],
+        "capabilities": ["advancedFilter", "search"]
+      },
+      "dataBinding": {
+        "kind": "static",
+        "filtersProp": "filters"
+      }
+    },
+    {
+      "id": "form-entity-stack",
+      "moduleId": "Modal",
+      "exportName": "Modal",
+      "displayName": "Modal",
+      "importPath": "@imj_media/ui",
+      "importSymbol": "Modal",
+      "replacesGeneric": ["EntityForm", "EditDialog"],
+      "semantic": {
+        "classification": ["FormEntity"],
+        "capabilities": ["formFields"]
+      },
+      "dataBinding": {
+        "kind": "composition",
+        "compositionModules": ["Modal", "Input", "Dropdown", "Button"]
+      },
+      "limitations": ["compose_modal_with_input_dropdown_button"]
+    },
+    {
+      "id": "datepicker-form-field",
+      "moduleId": "DatePicker",
+      "exportName": "DatePicker",
+      "displayName": "DatePicker",
+      "importPath": "@imj_media/ui",
+      "importSymbol": "DatePicker",
+      "replacesGeneric": ["DateInput", "DateRangePicker"],
+      "semantic": {
+        "classification": ["FormEntity", "DateField"],
+        "capabilities": ["formFields", "dateRange"]
+      },
+      "dataBinding": {
+        "kind": "static",
+        "valueProp": "selectedDate"
+      },
+      "entityHints": {
+        "preferredKeyFields": ["date", "start_date", "end_date"]
+      }
+    }
+  ]
+}

package/catalog/semantic-catalog.schema.json

@@ -0,0 +1,130 @@
+{
+  "title": "IMJ UI Semantic Catalog",
+  "type": "object",
+  "required": ["schemaVersion", "entries"],
+  "additionalProperties": false,
+  "properties": {
+    "schemaVersion": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$" },
+    "entries": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#/$defs/semanticEntry" }
+    }
+  },
+  "$defs": {
+    "classification": {
+      "type": "string",
+      "enum": [
+        "DataRegistry",
+        "Configuration",
+        "AuditLog",
+        "WorkflowProcess",
+        "TimelineEntity",
+        "MasterList",
+        "NotificationFeed",
+        "FilterBar",
+        "FormEntity",
+        "DateField"
+      ]
+    },
+    "capability": {
+      "type": "string",
+      "enum": [
+        "search",
+        "pagination",
+        "advancedFilter",
+        "export",
+        "selection",
+        "stateTracking",
+        "timeline",
+        "dragDrop",
+        "formFields",
+        "dateRange",
+        "notification"
+      ]
+    },
+    "dataBinding": {
+      "type": "object",
+      "required": ["kind"],
+      "properties": {
+        "kind": { "type": "string", "enum": ["rest", "stateMachine", "static", "composition"] },
+        "rowsProp": { "type": "string" },
+        "columnsProp": { "type": "string" },
+        "toolbarSearchProp": { "type": "string" },
+        "paginationProp": { "type": "string" },
+        "stateField": { "type": ["string", "null"] },
+        "lifecycleToColumn": { "type": "boolean" },
+        "valueProp": { "type": "string" },
+        "itemsProp": { "type": "string" },
+        "filtersProp": { "type": "string" },
+        "compositionModules": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      },
+      "additionalProperties": false
+    },
+    "entityHints": {
+      "type": "object",
+      "properties": {
+        "preferredKeyFields": {
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "statusFieldCandidates": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      },
+      "additionalProperties": false
+    },
+    "semanticEntry": {
+      "type": "object",
+      "required": [
+        "id",
+        "moduleId",
+        "exportName",
+        "displayName",
+        "importPath",
+        "importSymbol",
+        "semantic",
+        "dataBinding"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "moduleId": { "type": "string", "minLength": 1 },
+        "exportName": { "type": "string", "minLength": 1 },
+        "displayName": { "type": "string", "minLength": 1 },
+        "importPath": { "type": "string", "const": "@imj_media/ui" },
+        "importSymbol": { "type": "string", "minLength": 1 },
+        "replacesGeneric": {
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "semantic": {
+          "type": "object",
+          "required": ["classification", "capabilities"],
+          "properties": {
+            "classification": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/classification" },
+              "minItems": 1
+            },
+            "capabilities": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/capability" }
+            }
+          },
+          "additionalProperties": false
+        },
+        "dataBinding": { "$ref": "#/$defs/dataBinding" },
+        "entityHints": { "$ref": "#/$defs/entityHints" },
+        "limitations": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      }
+    }
+  }
+}