@teambit/api-reference 0.0.0-e156c538a2f5aeb096706400e76fd31ba0f0a77c → 0.0.0-e1b3278e4caed4ded05c8bff62cf83bfe598d425

package/api-compare.module.scss

@@ -0,0 +1,250 @@
+.apiCompareContainer {
+  display: flex;
+  flex-direction: column;
+  height: 100%;
+  overflow: auto;
+  padding: 24px;
+  gap: 16px;
+}
+
+.summary {
+  display: flex;
+  gap: 12px;
+  align-items: center;
+  padding: 12px 16px;
+  background: var(--bit-bg-dent, #f6f6f6);
+  border-radius: 8px;
+  font-size: 13px;
+}
+
+.summaryDivider {
+  opacity: 0.3;
+  color: var(--bit-text-color-light, #6c707c);
+}
+
+.summaryBadge {
+  display: inline-flex;
+  align-items: center;
+  gap: 4px;
+  padding: 3px 10px;
+  border-radius: 12px;
+  font-weight: 500;
+  font-size: 12px;
+  white-space: nowrap;
+}
+
+.addedBadge {
+  composes: summaryBadge;
+  background: color-mix(in srgb, var(--bit-color-added, #2ea043) 15%, transparent);
+  color: var(--bit-color-added, #2ea043);
+}
+
+.removedBadge {
+  composes: summaryBadge;
+  background: color-mix(in srgb, var(--bit-color-removed, #f85149) 15%, transparent);
+  color: var(--bit-color-removed, #f85149);
+}
+
+.modifiedBadge {
+  composes: summaryBadge;
+  background: color-mix(in srgb, var(--bit-color-modified, #d29922) 15%, transparent);
+  color: var(--bit-color-modified, #d29922);
+}
+
+.changeList {
+  display: flex;
+  flex-direction: column;
+  gap: 8px;
+}
+
+.sectionTitle {
+  margin: 16px 0 8px;
+  font-size: 12px;
+  font-weight: 600;
+  text-transform: uppercase;
+  letter-spacing: 0.5px;
+  color: var(--bit-text-color-light, #6c707c);
+}
+
+.diffEntry {
+  border: 1px solid var(--bit-border-color-lightest, #ededed);
+  border-radius: 8px;
+  overflow: hidden;
+}
+
+.diffEntryHeader {
+  display: flex;
+  align-items: center;
+  gap: 10px;
+  padding: 10px 16px;
+  cursor: pointer;
+  user-select: none;
+
+  &:hover {
+    background: var(--bit-bg-dent, #f6f6f6);
+  }
+}
+
+.statusBadge {
+  display: inline-flex;
+  align-items: center;
+  padding: 2px 8px;
+  border-radius: 4px;
+  font-weight: 600;
+  font-size: 11px;
+  text-transform: uppercase;
+  letter-spacing: 0.3px;
+  flex-shrink: 0;
+  white-space: nowrap;
+}
+
+.statusAdded {
+  composes: statusBadge;
+  background: color-mix(in srgb, var(--bit-color-added, #2ea043) 15%, transparent);
+  color: var(--bit-color-added, #2ea043);
+}
+
+.statusRemoved {
+  composes: statusBadge;
+  background: color-mix(in srgb, var(--bit-color-removed, #f85149) 15%, transparent);
+  color: var(--bit-color-removed, #f85149);
+}
+
+.statusModified {
+  composes: statusBadge;
+  background: color-mix(in srgb, var(--bit-color-modified, #d29922) 15%, transparent);
+  color: var(--bit-color-modified, #d29922);
+}
+
+.exportName {
+  font-weight: 600;
+  font-size: 14px;
+  font-family: var(--bit-font-mono, monospace);
+  color: var(--bit-text-color-heavy, #2b2b2b);
+}
+
+.schemaType {
+  color: var(--bit-text-color-light, #6c707c);
+  font-size: 12px;
+}
+
+.impactBadge {
+  composes: summaryBadge;
+  margin-left: auto;
+  font-size: 11px;
+}
+
+.expandIcon {
+  color: var(--bit-text-color-light, #6c707c);
+  font-size: 10px;
+  transition: transform 0.2s;
+  flex-shrink: 0;
+}
+
+.expandIconOpen {
+  composes: expandIcon;
+  transform: rotate(90deg);
+}
+
+.diffEntryBody {
+  padding: 0 16px 16px;
+  border-top: 1px solid var(--bit-border-color-lightest, #ededed);
+}
+
+.detailsList {
+  list-style: none;
+  padding: 12px 0 0;
+  margin: 0;
+  display: flex;
+  flex-direction: column;
+  gap: 8px;
+}
+
+.detailItem {
+  display: flex;
+  align-items: flex-start;
+  gap: 8px;
+  font-size: 13px;
+  line-height: 1.5;
+  color: var(--bit-text-color-heavy, #2b2b2b);
+}
+
+.detailDot {
+  width: 7px;
+  height: 7px;
+  min-width: 7px;
+  border-radius: 50%;
+  margin-top: 6px;
+  flex-shrink: 0;
+}
+
+.dotBreaking {
+  composes: detailDot;
+  background: var(--bit-color-removed, #f85149);
+}
+
+.dotNonBreaking {
+  composes: detailDot;
+  background: var(--bit-color-added, #2ea043);
+}
+
+.dotPatch {
+  composes: detailDot;
+  background: var(--bit-color-modified, #d29922);
+}
+
+.detailDescription {
+  color: var(--bit-text-color-heavy, #2b2b2b);
+}
+
+.signatureBlock {
+  margin-top: 12px;
+  padding: 12px;
+  background: var(--bit-bg-dent, #f6f6f6);
+  border-radius: 6px;
+  font-family: var(--bit-font-mono, monospace);
+  font-size: 12px;
+  white-space: pre-wrap;
+  word-break: break-word;
+  line-height: 1.6;
+  color: var(--bit-text-color-heavy, #2b2b2b);
+}
+
+.signatureLabel {
+  font-weight: 600;
+  color: var(--bit-text-color-light, #6c707c);
+  margin-top: 12px;
+  margin-bottom: 4px;
+  font-size: 11px;
+  text-transform: uppercase;
+  letter-spacing: 0.5px;
+}
+
+.signatureRemoved {
+  composes: signatureBlock;
+  text-decoration: line-through;
+  opacity: 0.6;
+}
+
+.emptyState {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  height: 100%;
+  color: var(--bit-text-color-light, #6c707c);
+  font-size: 14px;
+}
+
+.toggleSignatures {
+  background: none;
+  border: none;
+  color: var(--bit-accent-color, #0366d6);
+  font-size: 12px;
+  cursor: pointer;
+  padding: 4px 0;
+  margin-top: 12px;
+
+  &:hover {
+    text-decoration: underline;
+  }
+}

package/api-compare.section.tsx

@@ -0,0 +1,26 @@
+import React from 'react';
+import type { Section } from '@teambit/component';
+import type { TabItem } from '@teambit/component.ui.component-compare.models.component-compare-props';
+import type { ChangeType } from '@teambit/component.ui.component-compare.models.component-compare-change-type';
+import { APICompare } from './api-compare';
+
+// Use string cast since the external ChangeType enum doesn't have API yet
+const ChangeTypeAPI = 'API' as unknown as ChangeType;
+
+export class APICompareSection implements TabItem, Section {
+  navigationLink = {
+    href: 'api',
+    children: 'API',
+  };
+
+  props = this.navigationLink;
+
+  route = {
+    path: 'api/*',
+    element: <APICompare />,
+  };
+
+  order = 15;
+  changeType = ChangeTypeAPI;
+  id = 'api';
+}

package/api-compare.tsx

@@ -0,0 +1,202 @@
+import React from 'react';
+import { useComponentCompare } from '@teambit/component.ui.component-compare.context';
+import type { APIDiffResult, APIDiffChange, APIDiffDetail } from './api-compare.types';
+import styles from './api-compare.module.scss';
+
+export type { APIDiffResult, APIDiffChange, APIDiffDetail };
+
+function impactClass(impact: string): string {
+  switch (impact) {
+    case 'BREAKING':
+      return styles.removedBadge;
+    case 'NON_BREAKING':
+      return styles.addedBadge;
+    case 'PATCH':
+      return styles.modifiedBadge;
+    default:
+      return styles.summaryBadge;
+  }
+}
+
+function impactLabel(impact: string): string {
+  switch (impact) {
+    case 'BREAKING':
+      return 'Breaking';
+    case 'NON_BREAKING':
+      return 'Non-breaking';
+    case 'PATCH':
+      return 'Patch';
+    default:
+      return impact;
+  }
+}
+
+function getStatusClass(status: string): string {
+  switch (status) {
+    case 'ADDED':
+      return styles.statusAdded;
+    case 'REMOVED':
+      return styles.statusRemoved;
+    case 'MODIFIED':
+      return styles.statusModified;
+    default:
+      return styles.statusBadge;
+  }
+}
+
+function getStatusLabel(status: string): string {
+  switch (status) {
+    case 'ADDED':
+      return '+ Added';
+    case 'REMOVED':
+      return '- Removed';
+    case 'MODIFIED':
+      return '~ Modified';
+    default:
+      return status;
+  }
+}
+
+function dotClass(impact: string): string {
+  switch (impact) {
+    case 'BREAKING':
+      return styles.dotBreaking;
+    case 'NON_BREAKING':
+      return styles.dotNonBreaking;
+    default:
+      return styles.dotPatch;
+  }
+}
+
+function DetailItem({ detail }: { detail: APIDiffDetail }) {
+  return (
+    <li className={styles.detailItem}>
+      <span className={dotClass(detail.impact)} />
+      <span className={styles.detailDescription}>{detail.description}</span>
+    </li>
+  );
+}
+
+function APIDiffEntry({ change }: { change: APIDiffChange }) {
+  const [expanded, setExpanded] = React.useState(change.status === 'MODIFIED');
+  const [showSignatures, setShowSignatures] = React.useState(false);
+
+  const hasBody =
+    change.status === 'MODIFIED'
+      ? (change.changes && change.changes.length > 0) || change.baseSignature || change.compareSignature
+      : change.baseSignature || change.compareSignature;
+
+  return (
+    <div className={styles.diffEntry}>
+      <div
+        className={styles.diffEntryHeader}
+        onClick={() => hasBody && setExpanded(!expanded)}
+        role="button"
+        tabIndex={0}
+        aria-expanded={hasBody ? expanded : undefined}
+        onKeyDown={(e) => {
+          if (e.key === 'Enter' || e.key === ' ') {
+            e.preventDefault();
+            hasBody && setExpanded(!expanded);
+          }
+        }}
+      >
+        <span className={getStatusClass(change.status)}>{getStatusLabel(change.status)}</span>
+        <span className={styles.exportName}>{change.exportName}</span>
+        <span className={styles.schemaType}>{change.schemaType}</span>
+        <span className={`${impactClass(change.impact)} ${styles.impactBadge}`}>{impactLabel(change.impact)}</span>
+        {hasBody && <span className={expanded ? styles.expandIconOpen : styles.expandIcon}>▶</span>}
+      </div>
+      {expanded && hasBody && (
+        <div className={styles.diffEntryBody}>
+          {change.status === 'MODIFIED' && change.changes && change.changes.length > 0 && (
+            <ul className={styles.detailsList}>
+              {change.changes.map((detail, i) => (
+                <DetailItem key={`${detail.changeKind}-${i}`} detail={detail} />
+              ))}
+            </ul>
+          )}
+          {change.status === 'MODIFIED' && (change.baseSignature || change.compareSignature) && (
+            <>
+              <button className={styles.toggleSignatures} onClick={() => setShowSignatures(!showSignatures)}>
+                {showSignatures ? '▼ Hide signatures' : '▶ Show signatures'}
+              </button>
+              {showSignatures && (
+                <>
+                  {change.baseSignature && (
+                    <div>
+                      <div className={styles.signatureLabel}>Base</div>
+                      <div className={styles.signatureRemoved}>{change.baseSignature}</div>
+                    </div>
+                  )}
+                  {change.compareSignature && (
+                    <div>
+                      <div className={styles.signatureLabel}>Compare</div>
+                      <div className={styles.signatureBlock}>{change.compareSignature}</div>
+                    </div>
+                  )}
+                </>
+              )}
+            </>
+          )}
+          {change.status === 'ADDED' && change.compareSignature && (
+            <div className={styles.signatureBlock}>{change.compareSignature}</div>
+          )}
+          {change.status === 'REMOVED' && change.baseSignature && (
+            <div className={styles.signatureRemoved}>{change.baseSignature}</div>
+          )}
+        </div>
+      )}
+    </div>
+  );
+}
+
+function ChangeSection({ title, changes }: { title: string; changes: APIDiffChange[] }) {
+  if (changes.length === 0) return null;
+
+  const sorted = [...changes].sort((a, b) => {
+    const order: Record<string, number> = { REMOVED: 0, MODIFIED: 1, ADDED: 2 };
+    return (order[a.status] ?? 3) - (order[b.status] ?? 3);
+  });
+
+  return (
+    <>
+      <h3 className={styles.sectionTitle}>{title}</h3>
+      <div className={styles.changeList}>
+        {sorted.map((change) => (
+          <APIDiffEntry key={`${change.visibility}-${change.status}-${change.exportName}`} change={change} />
+        ))}
+      </div>
+    </>
+  );
+}
+
+export function APICompare() {
+  const compareContext = useComponentCompare();
+  const apiDiffResult: APIDiffResult | null | undefined = (compareContext as any)?.apiDiffResult;
+
+  if (apiDiffResult === undefined) {
+    return <div className={styles.emptyState}>Loading API diff...</div>;
+  }
+
+  if (!apiDiffResult || !apiDiffResult.hasChanges) {
+    return <div className={styles.emptyState}>No API changes between these versions</div>;
+  }
+
+  const { publicChanges, internalChanges, added, removed, modified, breaking, impact } = apiDiffResult;
+
+  return (
+    <div className={styles.apiCompareContainer}>
+      <div className={styles.summary}>
+        <span className={impactClass(impact)}>{impactLabel(impact)}</span>
+        <span className={styles.summaryDivider}>|</span>
+        {added > 0 && <span className={styles.addedBadge}>+{added} added</span>}
+        {removed > 0 && <span className={styles.removedBadge}>-{removed} removed</span>}
+        {modified > 0 && <span className={styles.modifiedBadge}>~{modified} modified</span>}
+        {breaking > 0 && <span className={styles.removedBadge}>{breaking} breaking</span>}
+      </div>
+      <ChangeSection title="Public API" changes={publicChanges} />
+      <ChangeSection title="Internal (non-exported)" changes={internalChanges} />
+    </div>
+  );
+}

package/api-reference.ui.runtime.tsx

@@ -1,35 +1,27 @@
 import React from 'react';
 import { flatten } from 'lodash';
-import { ComponentAspect, ComponentUI } from '@teambit/component';
+import type { ComponentUI } from '@teambit/component';
+import { ComponentAspect } from '@teambit/component';
 import { UIRuntime } from '@teambit/ui';
 import { APIRefPage } from '@teambit/api-reference.sections.api-reference-page';
 import { APIRefSection } from '@teambit/api-reference.sections.api-reference-section';
-import { Harmony, Slot, SlotRegistry } from '@teambit/harmony';
-import { APINodeRenderer } from '@teambit/api-reference.models.api-node-renderer';
-import { classRenderer } from '@teambit/api-reference.renderers.class';
-import { interfaceRenderer } from '@teambit/api-reference.renderers.interface';
-import { typeRenderer } from '@teambit/api-reference.renderers.type';
-import { functionRenderer } from '@teambit/api-reference.renderers.function';
-import { enumRenderer } from '@teambit/api-reference.renderers.enum';
-import { variableRenderer } from '@teambit/api-reference.renderers.variable';
-import { unresolvedRenderer } from '@teambit/api-reference.renderers.unresolved';
-import { typeRefRenderer } from '@teambit/api-reference.renderers.type-ref';
-import { typeUnionRenderer } from '@teambit/api-reference.renderers.type-union';
-import { typeIntersectionRenderer } from '@teambit/api-reference.renderers.type-intersection';
-import { typeLiteralRenderer } from '@teambit/api-reference.renderers.type-literal';
-import { parameterRenderer } from '@teambit/api-reference.renderers.parameter';
-import { inferenceTypeRenderer } from '@teambit/api-reference.renderers.inference-type';
-import { typeArrayRenderer } from '@teambit/api-reference.renderers.type-array';
-import { tupleTypeRenderer } from '@teambit/api-reference.renderers.tuple-type';
-import { thisRenderer } from '@teambit/api-reference.renderers.this';
+import type { Harmony, SlotRegistry } from '@teambit/harmony';
+import { Slot } from '@teambit/harmony';
+import type { APINodeRenderer } from '@teambit/api-reference.models.api-node-renderer';
+import { defaultNodeRenderers } from '@teambit/api-reference.renderers.default-node-renderers';
 import { APIRefRenderersProvider } from '@teambit/api-reference.hooks.use-api-renderers';
-import { decoratorRenderer } from '@teambit/api-reference.renderers.decorator';
-import { SchemaNodeConstructor, SchemaRegistry, Schemas } from '@teambit/semantics.entities.semantic-schema';
-import { CodeAspect, CodeUI } from '@teambit/code';
+import type { SchemaNodeConstructor } from '@teambit/semantics.entities.semantic-schema';
+import { SchemaRegistry, Schemas } from '@teambit/semantics.entities.semantic-schema';
+import type { CodeUI } from '@teambit/code';
+import { CodeAspect } from '@teambit/code';
 import { TaggedExports } from '@teambit/tagged-exports';
-import { WorkspaceAspect, WorkspaceUI } from '@teambit/workspace';
+import type { WorkspaceUI } from '@teambit/workspace';
+import { WorkspaceAspect } from '@teambit/workspace';
+import type { ComponentCompareUI } from '@teambit/component-compare';
+import { ComponentCompareAspect } from '@teambit/component-compare';
 
 import { APIReferenceAspect } from './api-reference.aspect';
+import { APICompareSection } from './api-compare.section';
 
 export type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>;
 export class APIReferenceUI {
@@ -38,9 +30,9 @@ export class APIReferenceUI {
     private apiNodeRendererSlot: APINodeRendererSlot,
     private code: CodeUI,
     private workspace: WorkspaceUI
-  ) { }
+  ) {}
 
-  static dependencies = [ComponentAspect, CodeAspect, WorkspaceAspect];
+  static dependencies = [ComponentAspect, CodeAspect, WorkspaceAspect, ComponentCompareAspect];
   static runtime = UIRuntime;
   static slots = [Slot.withType<APINodeRenderer[]>()];
 
@@ -61,7 +53,7 @@ export class APIReferenceUI {
     );
   };
 
-   /**
+  /**
    * @deprecated use registerSchemaClasses instead
    * registerSchemaClasses is better for performance as it lazy-loads the schemas.
    */
@@ -77,28 +69,10 @@ export class APIReferenceUI {
     this.apiNodeRendererSlot.register(apiNodeRenderers);
   }
 
-  apiNodeRenderers: APINodeRenderer[] = [
-    classRenderer,
-    typeRenderer,
-    interfaceRenderer,
-    variableRenderer,
-    functionRenderer,
-    enumRenderer,
-    unresolvedRenderer,
-    typeRefRenderer,
-    typeIntersectionRenderer,
-    typeUnionRenderer,
-    parameterRenderer,
-    typeLiteralRenderer,
-    inferenceTypeRenderer,
-    typeArrayRenderer,
-    thisRenderer,
-    decoratorRenderer,
-    tupleTypeRenderer
-  ];
+  apiNodeRenderers: APINodeRenderer[] = defaultNodeRenderers;
 
   static async provider(
-    [componentUI, codeUI, workspaceUI]: [ComponentUI, CodeUI, WorkspaceUI],
+    [componentUI, codeUI, workspaceUI, componentCompareUI]: [ComponentUI, CodeUI, WorkspaceUI, ComponentCompareUI],
     _,
     [apiNodeRendererSlot]: [APINodeRendererSlot],
     harmony: Harmony
@@ -113,6 +87,11 @@ export class APIReferenceUI {
     // register all default schema classes
     apiReferenceUI.registerSchemaClasses(() => Object.values(Schemas));
 
+    // register API compare tab in component compare
+    const apiCompareSection = new APICompareSection();
+    componentCompareUI.registerNavigation(apiCompareSection);
+    componentCompareUI.registerRoutes([apiCompareSection.route]);
+
     return apiReferenceUI;
   }
 }

package/dist/api-compare.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import type { APIDiffResult, APIDiffChange, APIDiffDetail } from './api-compare.types';
+export type { APIDiffResult, APIDiffChange, APIDiffDetail };
+export declare function APICompare(): React.JSX.Element;