Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
294 changes: 294 additions & 0 deletions .bitmap
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@
*/

{
"api-reference": {
"name": "api-reference",
"scope": "teambit.api-reference",
"version": "1.0.1095",
"mainFile": "index.ts",
"rootDir": "components/api-reference"
},
"explorer/api-reference-explorer": {
"name": "explorer/api-reference-explorer",
"scope": "teambit.api-reference",
"version": "0.0.39",
"mainFile": "index.ts",
"rootDir": "components/explorer/api-reference-explorer"
},
"greeting": {
"name": "greeting",
"scope": "",
Expand All @@ -17,5 +31,285 @@
"mainFile": "index.ts",
"rootDir": "components/greeting"
},
"hooks/use-api": {
"name": "hooks/use-api",
"scope": "teambit.api-reference",
"version": "0.0.57",
"mainFile": "index.ts",
"rootDir": "components/hooks/use-api"
},
"hooks/use-api-ref-url": {
"name": "hooks/use-api-ref-url",
"scope": "teambit.api-reference",
"version": "0.0.25",
"mainFile": "index.ts",
"rootDir": "components/hooks/use-api-ref-url"
},
"hooks/use-api-renderers": {
"name": "hooks/use-api-renderers",
"scope": "teambit.api-reference",
"version": "0.0.37",
"mainFile": "index.ts",
"rootDir": "components/hooks/use-api-renderers"
},
"hooks/use-schema": {
"name": "hooks/use-schema",
"scope": "teambit.api-reference",
"version": "0.0.35",
"mainFile": "index.ts",
"rootDir": "components/hooks/use-schema"
},
"models/api-node-renderer": {
"name": "models/api-node-renderer",
"scope": "teambit.api-reference",
"version": "0.0.53",
"mainFile": "index.ts",
"rootDir": "components/models/api-node-renderer"
},
"models/api-reference-model": {
"name": "models/api-reference-model",
"scope": "teambit.api-reference",
"version": "0.0.53",
"mainFile": "index.ts",
"rootDir": "components/models/api-reference-model"
},
"overview/api-reference-table-of-contents": {
"name": "overview/api-reference-table-of-contents",
"scope": "teambit.api-reference",
"version": "0.0.41",
"mainFile": "index.ts",
"rootDir": "components/overview/api-reference-table-of-contents"
},
"overview/renderers/grouped-schema-nodes-overview-summary": {
"name": "overview/renderers/grouped-schema-nodes-overview-summary",
"scope": "teambit.api-reference",
"version": "0.0.69",
"mainFile": "index.ts",
"rootDir": "components/overview/renderers/grouped-schema-nodes-overview-summary"
},
"renderers/api-node-details": {
"name": "renderers/api-node-details",
"scope": "teambit.api-reference",
"version": "0.0.84",
"mainFile": "index.ts",
"rootDir": "components/renderers/api-node-details"
},
"renderers/class": {
"name": "renderers/class",
"scope": "teambit.api-reference",
"version": "0.0.86",
"mainFile": "index.ts",
"rootDir": "components/renderers/class"
},
"renderers/decorator": {
"name": "renderers/decorator",
"scope": "teambit.api-reference",
"version": "0.0.40",
"mainFile": "index.ts",
"rootDir": "components/renderers/decorator"
},
"renderers/default-node-renderers": {
"name": "renderers/default-node-renderers",
"scope": "teambit.api-reference",
"version": "0.0.22",
"mainFile": "index.ts",
"rootDir": "components/renderers/default-node-renderers"
},
"renderers/enum": {
"name": "renderers/enum",
"scope": "teambit.api-reference",
"version": "0.0.84",
"mainFile": "index.ts",
"rootDir": "components/renderers/enum"
},
"renderers/function": {
"name": "renderers/function",
"scope": "teambit.api-reference",
"version": "0.0.88",
"mainFile": "index.ts",
"rootDir": "components/renderers/function"
},
"renderers/grouped-schema-nodes-summary": {
"name": "renderers/grouped-schema-nodes-summary",
"scope": "teambit.api-reference",
"version": "0.0.82",
"mainFile": "index.ts",
"rootDir": "components/renderers/grouped-schema-nodes-summary"
},
"renderers/inference-type": {
"name": "renderers/inference-type",
"scope": "teambit.api-reference",
"version": "0.0.66",
"mainFile": "index.ts",
"rootDir": "components/renderers/inference-type"
},
"renderers/interface": {
"name": "renderers/interface",
"scope": "teambit.api-reference",
"version": "0.0.84",
"mainFile": "index.ts",
"rootDir": "components/renderers/interface"
},
"renderers/parameter": {
"name": "renderers/parameter",
"scope": "teambit.api-reference",
"version": "0.0.69",
"mainFile": "index.ts",
"rootDir": "components/renderers/parameter"
},
"renderers/react": {
"name": "renderers/react",
"scope": "teambit.api-reference",
"version": "0.0.69",
"mainFile": "index.ts",
"rootDir": "components/renderers/react"
},
"renderers/schema-node-member-summary": {
"name": "renderers/schema-node-member-summary",
"scope": "teambit.api-reference",
"version": "0.0.80",
"mainFile": "index.ts",
"rootDir": "components/renderers/schema-node-member-summary"
},
"renderers/schema-nodes-index": {
"name": "renderers/schema-nodes-index",
"scope": "teambit.api-reference",
"version": "0.0.72",
"mainFile": "index.ts",
"rootDir": "components/renderers/schema-nodes-index"
},
"renderers/this": {
"name": "renderers/this",
"scope": "teambit.api-reference",
"version": "0.0.71",
"mainFile": "index.ts",
"rootDir": "components/renderers/this"
},
"renderers/tuple-type": {
"name": "renderers/tuple-type",
"scope": "teambit.api-reference",
"version": "0.0.33",
"mainFile": "index.ts",
"rootDir": "components/renderers/tuple-type"
},
"renderers/type": {
"name": "renderers/type",
"scope": "teambit.api-reference",
"version": "0.0.82",
"mainFile": "index.ts",
"rootDir": "components/renderers/type"
},
"renderers/type-array": {
"name": "renderers/type-array",
"scope": "teambit.api-reference",
"version": "0.0.55",
"mainFile": "index.ts",
"rootDir": "components/renderers/type-array"
},
"renderers/type-intersection": {
"name": "renderers/type-intersection",
"scope": "teambit.api-reference",
"version": "0.0.55",
"mainFile": "index.ts",
"rootDir": "components/renderers/type-intersection"
},
"renderers/type-literal": {
"name": "renderers/type-literal",
"scope": "teambit.api-reference",
"version": "0.0.75",
"mainFile": "index.ts",
"rootDir": "components/renderers/type-literal"
},
"renderers/type-ref": {
"name": "renderers/type-ref",
"scope": "teambit.api-reference",
"version": "0.0.101",
"mainFile": "index.ts",
"rootDir": "components/renderers/type-ref"
},
"renderers/type-union": {
"name": "renderers/type-union",
"scope": "teambit.api-reference",
"version": "0.0.55",
"mainFile": "index.ts",
"rootDir": "components/renderers/type-union"
},
"renderers/unresolved": {
"name": "renderers/unresolved",
"scope": "teambit.api-reference",
"version": "0.0.82",
"mainFile": "index.ts",
"rootDir": "components/renderers/unresolved"
},
"renderers/variable": {
"name": "renderers/variable",
"scope": "teambit.api-reference",
"version": "0.0.82",
"mainFile": "index.ts",
"rootDir": "components/renderers/variable"
},
"sections/api-reference-page": {
"name": "sections/api-reference-page",
"scope": "teambit.api-reference",
"version": "0.0.120",
"mainFile": "index.ts",
"rootDir": "components/sections/api-reference-page"
},
"sections/api-reference-section": {
"name": "sections/api-reference-section",
"scope": "teambit.api-reference",
"version": "0.0.16",
"mainFile": "index.ts",
"rootDir": "components/sections/api-reference-section"
},
"tagged-exports": {
"name": "tagged-exports",
"scope": "teambit.api-reference",
"version": "0.0.53",
"mainFile": "index.ts",
"rootDir": "components/tagged-exports"
},
"utils/code-editor-options": {
"name": "utils/code-editor-options",
"scope": "teambit.api-reference",
"version": "0.0.16",
"mainFile": "index.ts",
"rootDir": "components/utils/code-editor-options"
},
"utils/copy-schema-node": {
"name": "utils/copy-schema-node",
"scope": "teambit.api-reference",
"version": "0.0.45",
"mainFile": "index.ts",
"rootDir": "components/utils/copy-schema-node"
},
"utils/custom-prism-syntax-highlighter-theme": {
"name": "utils/custom-prism-syntax-highlighter-theme",
"scope": "teambit.api-reference",
"version": "0.0.16",
"mainFile": "index.ts",
"rootDir": "components/utils/custom-prism-syntax-highlighter-theme"
},
"utils/group-schema-node-by-signature": {
"name": "utils/group-schema-node-by-signature",
"scope": "teambit.api-reference",
"version": "0.0.45",
"mainFile": "index.ts",
"rootDir": "components/utils/group-schema-node-by-signature"
},
"utils/schema-node-signature-transform": {
"name": "utils/schema-node-signature-transform",
"scope": "teambit.api-reference",
"version": "0.0.47",
"mainFile": "index.ts",
"rootDir": "components/utils/schema-node-signature-transform"
},
"utils/sort-api-nodes": {
"name": "utils/sort-api-nodes",
"scope": "teambit.api-reference",
"version": "0.0.53",
"mainFile": "index.ts",
"rootDir": "components/utils/sort-api-nodes"
},
"$schema-version": "17.0.0"
}
8 changes: 8 additions & 0 deletions components/api-reference/api-compare.module.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.apiCompareContainer {
display: flex;
flex-direction: column;
height: 100%;
overflow: auto;
padding: 16px 24px;
max-width: 980px;
}
33 changes: 33 additions & 0 deletions components/api-reference/api-compare.section.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
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 type { ApiDiffInsight } from '@teambit/semantics.ui.api-diff-view';
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 {
route: { path: string; element: React.ReactNode };

constructor(getInsights?: () => ApiDiffInsight[]) {
// built in the constructor (not a field initializer) so the element captures the
// getter regardless of class-field initialization order.
this.route = {
path: 'api/*',
element: <APICompare getInsights={getInsights} />,
};
}

navigationLink = {
href: 'api',
children: 'API',
};

props = this.navigationLink;

order = 15;
changeType = ChangeTypeAPI;
id = 'api';
}
Loading