@salesforce/metadata-plugins 1.0.0

package/dist/plugins/schema/types/SchemaERDData.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Copyright (c) 2025, Salesforce, Inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ **/
+/**
+ * Type definitions for Schema (Data Model) ERD visualization.
+ *
+ * SchemaERDData is the top-level data structure produced by SchemaParser
+ * and consumed by SchemaRenderer to generate an interactive ERD diagram.
+ */
+/**
+ * A single field on an object, enriched with relationship metadata.
+ */
+export interface SchemaField {
+    /** API name of the field, e.g. "Asset__c" */
+    apiName: string;
+    /** Human-readable label */
+    label: string;
+    /** Display type string, e.g. "Lookup", "MasterDetail", "Text(255)", "Date" */
+    dataType: string;
+    /** Whether this field is a relationship (Lookup or MasterDetail) */
+    isRelationship: boolean;
+    /** For relationship fields: the target object API name */
+    referenceTo?: string;
+    /** For relationship fields: "Lookup" | "MasterDetail" */
+    relationshipType?: 'Lookup' | 'MasterDetail';
+    /** Optional description from the XML */
+    description?: string;
+    /** Optional help text from the XML */
+    helpText?: string;
+    /** Whether the field is required */
+    required?: boolean;
+    /** Field length for text fields */
+    length?: number;
+}
+/**
+ * A single object node in the ERD.
+ */
+export interface ObjectNode {
+    /** API name, e.g. "Maintenance_Plan__c" or "Account" */
+    apiName: string;
+    /** Human-readable label */
+    label: string;
+    /** "standard" or "custom" */
+    type: 'standard' | 'custom';
+    /** Name field type: "Text" or "AutoNumber" */
+    nameFieldType: 'Text' | 'AutoNumber';
+    /** Custom + relationship fields parsed from XML */
+    fields: SchemaField[];
+    /** Whether this node corresponds to the currently active file */
+    isActive?: boolean;
+    /** Whether this node should be dimmed (spotlight effect) */
+    isInactive?: boolean;
+}
+/**
+ * A relationship edge in the ERD.
+ */
+export interface RelationshipEdge {
+    /** Source object API name (the object that has the field) */
+    sourceObject: string;
+    /** Target object API name (the object being referenced) */
+    targetObject: string;
+    /** The field API name that creates this relationship */
+    fieldApiName: string;
+    /** "Lookup" or "MasterDetail" */
+    type: 'Lookup' | 'MasterDetail';
+}
+/**
+ * Top-level data structure for the Schema ERD visualization.
+ * Produced by SchemaParser.parse(), consumed by SchemaRenderer.render().
+ */
+export interface SchemaERDData {
+    /** All object nodes to display */
+    objects: ObjectNode[];
+    /** All relationship edges to display */
+    relationships: RelationshipEdge[];
+    /** Metadata about the parse */
+    metadata: {
+        /** Total object count */
+        objectCount: number;
+        /** Total relationship count */
+        relationshipCount: number;
+        /** Root directory of the objects folder */
+        objectsRoot: string;
+        /** Timestamp of the parse */
+        parsedAt: string;
+    };
+}
+//# sourceMappingURL=SchemaERDData.d.ts.map

package/dist/plugins/schema/types/SchemaERDData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaERDData.d.ts","sourceRoot":"","sources":["../../../../src/plugins/schema/types/SchemaERDData.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAEJ;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,8EAA8E;IAC9E,QAAQ,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,cAAc,EAAE,OAAO,CAAC;IACxB,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,QAAQ,GAAG,cAAc,CAAC;IAC7C,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;IAC5B,8CAA8C;IAC9C,aAAa,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,mDAAmD;IACnD,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,6DAA6D;IAC7D,YAAY,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,YAAY,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,IAAI,EAAE,QAAQ,GAAG,cAAc,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,kCAAkC;IAClC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,wCAAwC;IACxC,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC,+BAA+B;IAC/B,QAAQ,EAAE;QACR,yBAAyB;QACzB,WAAW,EAAE,MAAM,CAAC;QACpB,+BAA+B;QAC/B,iBAAiB,EAAE,MAAM,CAAC;QAC1B,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAC;QACpB,6BAA6B;QAC7B,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH"}

package/dist/plugins/schema/types/SchemaERDData.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2025, Salesforce, Inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ **/
+export {};