@teambit/api-reference 0.0.1

package/api-reference.aspect.ts

@@ -0,0 +1,5 @@
+import { Aspect } from '@teambit/harmony';
+
+export const APIReferenceAspect = Aspect.create({
+  id: 'teambit.api-reference/api-reference',
+});

package/api-reference.ui.runtime.tsx

@@ -0,0 +1,77 @@
+import React from 'react';
+import ComponentAspect, { ComponentUI } 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 { APIReferenceAspect } from './api-reference.aspect';
+
+export type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>;
+export class APIReferenceUI {
+  static dependencies = [ComponentAspect];
+  static runtime = UIRuntime;
+  static slots = [Slot.withType<APINodeRenderer[]>()];
+
+  getAPIPage() {
+    return <APIRefPage host={this.host} rendererSlot={this.apiNodeRendererSlot} />;
+  }
+
+  apiNodeRenderers: APINodeRenderer[] = [
+    classRenderer,
+    typeRenderer,
+    interfaceRenderer,
+    variableRenderer,
+    functionRenderer,
+    enumRenderer,
+    unresolvedRenderer,
+    typeRefRenderer,
+    typeIntersectionRenderer,
+    typeUnionRenderer,
+    parameterRenderer,
+    typeLiteralRenderer,
+    inferenceTypeRenderer,
+    typeArrayRenderer,
+  ];
+
+  static async provider(
+    [componentUI]: [ComponentUI],
+    _,
+    [apiNodeRendererSlot]: [APINodeRendererSlot],
+    harmony: Harmony
+  ) {
+    const { config } = harmony;
+    const host = String(config.get('teambit.harmony/bit'));
+    const apiReferenceUI = new APIReferenceUI(host, apiNodeRendererSlot);
+    apiReferenceUI.registerAPINodeRenderer(apiReferenceUI.apiNodeRenderers);
+    const apiReferenceSection = new APIRefSection(apiReferenceUI);
+    componentUI.registerNavigation(apiReferenceSection.navigationLink, apiReferenceSection.order);
+    componentUI.registerRoute(apiReferenceSection.route);
+    return apiReferenceUI;
+  }
+
+  registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]) {
+    this.apiNodeRendererSlot.register(apiNodeRenderers);
+  }
+
+  constructor(private host: string, private apiNodeRendererSlot: APINodeRendererSlot) {}
+}
+
+export default APIReferenceUI;
+
+APIReferenceAspect.addRuntime(APIReferenceUI);

package/dist/api-reference.aspect.d.ts

@@ -0,0 +1,2 @@
+import { Aspect } from '@teambit/harmony';
+export declare const APIReferenceAspect: Aspect;

package/dist/api-reference.aspect.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIReferenceAspect = void 0;
+const harmony_1 = require("@teambit/harmony");
+exports.APIReferenceAspect = harmony_1.Aspect.create({
+    id: 'teambit.api-reference/api-reference',
+});
+//# sourceMappingURL=api-reference.aspect.js.map

package/dist/api-reference.aspect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-reference.aspect.js","sourceRoot":"","sources":["../api-reference.aspect.ts"],"names":[],"mappings":";;;AAAA,8CAA0C;AAE7B,QAAA,kBAAkB,GAAG,gBAAM,CAAC,MAAM,CAAC;IAC9C,EAAE,EAAE,qCAAqC;CAC1C,CAAC,CAAC"}

package/dist/api-reference.ui.runtime.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import { ComponentUI } from '@teambit/component';
+import { Harmony, SlotRegistry } from '@teambit/harmony';
+import { APINodeRenderer } from '@teambit/api-reference.models.api-node-renderer';
+export declare type APINodeRendererSlot = SlotRegistry<APINodeRenderer[]>;
+export declare class APIReferenceUI {
+    private host;
+    private apiNodeRendererSlot;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static slots: ((registerFn: () => string) => SlotRegistry<APINodeRenderer[]>)[];
+    getAPIPage(): JSX.Element;
+    apiNodeRenderers: APINodeRenderer[];
+    static provider([componentUI]: [ComponentUI], _: any, [apiNodeRendererSlot]: [APINodeRendererSlot], harmony: Harmony): Promise<APIReferenceUI>;
+    registerAPINodeRenderer(apiNodeRenderers: APINodeRenderer[]): void;
+    constructor(host: string, apiNodeRendererSlot: APINodeRendererSlot);
+}
+export default APIReferenceUI;

package/dist/api-reference.ui.runtime.js

@@ -0,0 +1,83 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIReferenceUI = void 0;
+const react_1 = __importDefault(require("react"));
+const component_1 = __importDefault(require("@teambit/component"));
+const ui_1 = require("@teambit/ui");
+const api_reference_sections_api_reference_page_1 = require("@teambit/api-reference.sections.api-reference-page");
+const api_reference_sections_api_reference_section_1 = require("@teambit/api-reference.sections.api-reference-section");
+const harmony_1 = require("@teambit/harmony");
+const api_reference_renderers_class_1 = require("@teambit/api-reference.renderers.class");
+const api_reference_renderers_interface_1 = require("@teambit/api-reference.renderers.interface");
+const api_reference_renderers_type_1 = require("@teambit/api-reference.renderers.type");
+const api_reference_renderers_function_1 = require("@teambit/api-reference.renderers.function");
+const api_reference_renderers_enum_1 = require("@teambit/api-reference.renderers.enum");
+const api_reference_renderers_variable_1 = require("@teambit/api-reference.renderers.variable");
+const api_reference_renderers_unresolved_1 = require("@teambit/api-reference.renderers.unresolved");
+const api_reference_renderers_type_ref_1 = require("@teambit/api-reference.renderers.type-ref");
+const api_reference_renderers_type_union_1 = require("@teambit/api-reference.renderers.type-union");
+const api_reference_renderers_type_intersection_1 = require("@teambit/api-reference.renderers.type-intersection");
+const api_reference_renderers_type_literal_1 = require("@teambit/api-reference.renderers.type-literal");
+const api_reference_renderers_parameter_1 = require("@teambit/api-reference.renderers.parameter");
+const api_reference_renderers_inference_type_1 = require("@teambit/api-reference.renderers.inference-type");
+const api_reference_renderers_type_array_1 = require("@teambit/api-reference.renderers.type-array");
+const api_reference_aspect_1 = require("./api-reference.aspect");
+class APIReferenceUI {
+    constructor(host, apiNodeRendererSlot) {
+        this.host = host;
+        this.apiNodeRendererSlot = apiNodeRendererSlot;
+        this.apiNodeRenderers = [
+            api_reference_renderers_class_1.classRenderer,
+            api_reference_renderers_type_1.typeRenderer,
+            api_reference_renderers_interface_1.interfaceRenderer,
+            api_reference_renderers_variable_1.variableRenderer,
+            api_reference_renderers_function_1.functionRenderer,
+            api_reference_renderers_enum_1.enumRenderer,
+            api_reference_renderers_unresolved_1.unresolvedRenderer,
+            api_reference_renderers_type_ref_1.typeRefRenderer,
+            api_reference_renderers_type_intersection_1.typeIntersectionRenderer,
+            api_reference_renderers_type_union_1.typeUnionRenderer,
+            api_reference_renderers_parameter_1.parameterRenderer,
+            api_reference_renderers_type_literal_1.typeLiteralRenderer,
+            api_reference_renderers_inference_type_1.inferenceTypeRenderer,
+            api_reference_renderers_type_array_1.typeArrayRenderer,
+        ];
+    }
+    getAPIPage() {
+        return react_1.default.createElement(api_reference_sections_api_reference_page_1.APIRefPage, { host: this.host, rendererSlot: this.apiNodeRendererSlot });
+    }
+    static provider([componentUI], _, [apiNodeRendererSlot], harmony) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { config } = harmony;
+            const host = String(config.get('teambit.harmony/bit'));
+            const apiReferenceUI = new APIReferenceUI(host, apiNodeRendererSlot);
+            apiReferenceUI.registerAPINodeRenderer(apiReferenceUI.apiNodeRenderers);
+            const apiReferenceSection = new api_reference_sections_api_reference_section_1.APIRefSection(apiReferenceUI);
+            componentUI.registerNavigation(apiReferenceSection.navigationLink, apiReferenceSection.order);
+            componentUI.registerRoute(apiReferenceSection.route);
+            return apiReferenceUI;
+        });
+    }
+    registerAPINodeRenderer(apiNodeRenderers) {
+        this.apiNodeRendererSlot.register(apiNodeRenderers);
+    }
+}
+exports.APIReferenceUI = APIReferenceUI;
+APIReferenceUI.dependencies = [component_1.default];
+APIReferenceUI.runtime = ui_1.UIRuntime;
+APIReferenceUI.slots = [harmony_1.Slot.withType()];
+exports.default = APIReferenceUI;
+api_reference_aspect_1.APIReferenceAspect.addRuntime(APIReferenceUI);
+//# sourceMappingURL=api-reference.ui.runtime.js.map

package/dist/api-reference.ui.runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-reference.ui.runtime.js","sourceRoot":"","sources":["../api-reference.ui.runtime.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,mEAAkE;AAClE,oCAAwC;AACxC,kHAAgF;AAChF,wHAAsF;AACtF,8CAA+D;AAE/D,0FAAuE;AACvE,kGAA+E;AAC/E,wFAAqE;AACrE,gGAA6E;AAC7E,wFAAqE;AACrE,gGAA6E;AAC7E,oGAAiF;AACjF,gGAA4E;AAC5E,oGAAgF;AAChF,kHAA8F;AAC9F,wGAAoF;AACpF,kGAA+E;AAC/E,4GAAwF;AACxF,oGAAgF;AAEhF,iEAA4D;AAG5D,MAAa,cAAc;IA8CzB,YAAoB,IAAY,EAAU,mBAAwC;QAA9D,SAAI,GAAJ,IAAI,CAAQ;QAAU,wBAAmB,GAAnB,mBAAmB,CAAqB;QArClF,qBAAgB,GAAsB;YACpC,6CAAa;YACb,2CAAY;YACZ,qDAAiB;YACjB,mDAAgB;YAChB,mDAAgB;YAChB,2CAAY;YACZ,uDAAkB;YAClB,kDAAe;YACf,oEAAwB;YACxB,sDAAiB;YACjB,qDAAiB;YACjB,0DAAmB;YACnB,8DAAqB;YACrB,sDAAiB;SAClB,CAAC;IAsBmF,CAAC;IAzCtF,UAAU;QACR,OAAO,8BAAC,sDAAU,IAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,mBAAmB,GAAI,CAAC;IACjF,CAAC;IAmBD,MAAM,CAAO,QAAQ,CACnB,CAAC,WAAW,CAAgB,EAC5B,CAAC,EACD,CAAC,mBAAmB,CAAwB,EAC5C,OAAgB;;YAEhB,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;YAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC;YACvD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;YACrE,cAAc,CAAC,uBAAuB,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;YACxE,MAAM,mBAAmB,GAAG,IAAI,4DAAa,CAAC,cAAc,CAAC,CAAC;YAC9D,WAAW,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,cAAc,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;YAC9F,WAAW,CAAC,aAAa,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YACrD,OAAO,cAAc,CAAC;QACxB,CAAC;KAAA;IAED,uBAAuB,CAAC,gBAAmC;QACzD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IACtD,CAAC;;AA5CH,wCA+CC;AA9CQ,2BAAY,GAAG,CAAC,mBAAe,CAAC,CAAC;AACjC,sBAAO,GAAG,cAAS,CAAC;AACpB,oBAAK,GAAG,CAAC,cAAI,CAAC,QAAQ,EAAqB,CAAC,CAAC;AA8CtD,kBAAe,cAAc,CAAC;AAE9B,yCAAkB,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { APIReferenceAspect } from './api-reference.aspect';
+export type { APIReferenceUI, APINodeRendererSlot } from './api-reference.ui.runtime';
+export default APIReferenceAspect;
+export { APIReferenceAspect };

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIReferenceAspect = void 0;
+const api_reference_aspect_1 = require("./api-reference.aspect");
+Object.defineProperty(exports, "APIReferenceAspect", { enumerable: true, get: function () { return api_reference_aspect_1.APIReferenceAspect; } });
+exports.default = api_reference_aspect_1.APIReferenceAspect;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,iEAA4D;AAInD,mGAJA,yCAAkB,OAIA;AAD3B,kBAAe,yCAAkB,CAAC"}

package/dist/tsconfig.json

@@ -0,0 +1,32 @@
+{
+    "compilerOptions": {
+        "lib": [
+            "es2019",
+            "DOM",
+            "ES6",
+            "DOM.Iterable"
+        ],
+        "target": "es2015",
+        "module": "CommonJS",
+        "jsx": "react",
+        "allowJs": true,
+        "composite": true,
+        "declaration": true,
+        "sourceMap": true,
+        "skipLibCheck": true,
+        "experimentalDecorators": true,
+        "outDir": "dist",
+        "moduleResolution": "node",
+        "esModuleInterop": true,
+        "rootDir": ".",
+        "resolveJsonModule": true
+    },
+    "exclude": [
+        "dist",
+        "package.json"
+    ],
+    "include": [
+        "**/*",
+        "**/*.json"
+    ]
+}

package/index.ts

@@ -0,0 +1,5 @@
+import { APIReferenceAspect } from './api-reference.aspect';
+
+export type { APIReferenceUI, APINodeRendererSlot } from './api-reference.ui.runtime';
+export default APIReferenceAspect;
+export { APIReferenceAspect };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@teambit/api-reference",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "componentId": {
+    "scope": "teambit.api-reference",
+    "name": "api-reference",
+    "version": "0.0.1"
+  },
+  "dependencies": {
+    "@teambit/harmony": "0.3.3",
+    "@teambit/api-reference.models.api-node-renderer": "0.0.1",
+    "@teambit/api-reference.renderers.class": "0.0.1",
+    "@teambit/api-reference.renderers.enum": "0.0.1",
+    "@teambit/api-reference.renderers.function": "0.0.1",
+    "@teambit/api-reference.renderers.inference-type": "0.0.1",
+    "@teambit/api-reference.renderers.interface": "0.0.1",
+    "@teambit/api-reference.renderers.parameter": "0.0.1",
+    "@teambit/api-reference.renderers.type-array": "0.0.1",
+    "@teambit/api-reference.renderers.type-intersection": "0.0.1",
+    "@teambit/api-reference.renderers.type-literal": "0.0.1",
+    "@teambit/api-reference.renderers.type-ref": "0.0.1",
+    "@teambit/api-reference.renderers.type-union": "0.0.1",
+    "@teambit/api-reference.renderers.type": "0.0.1",
+    "@teambit/api-reference.renderers.unresolved": "0.0.1",
+    "@teambit/api-reference.renderers.variable": "0.0.1",
+    "@teambit/api-reference.sections.api-reference-page": "0.0.1",
+    "@teambit/api-reference.sections.api-reference-section": "0.0.1"
+  },
+  "devDependencies": {
+    "@types/react": "17.0.8",
+    "@types/mocha": "9.1.0",
+    "@babel/runtime": "7.20.0",
+    "@types/node": "12.20.4",
+    "@types/jest": "26.0.20"
+  },
+  "peerDependencies": {
+    "react": "17.0.2",
+    "@teambit/legacy": "1.0.382"
+  },
+  "license": "Apache-2.0",
+  "private": false,
+  "engines": {
+    "node": ">=12.22.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teambit/bit"
+  },
+  "keywords": [
+    "bit",
+    "bit-aspect",
+    "components",
+    "collaboration",
+    "web",
+    "react",
+    "react-components",
+    "angular",
+    "angular-components"
+  ]
+}

package/preview-1667965305919.js

@@ -0,0 +1,7 @@
+;
+;
+
+export const compositions = [];
+export const overview = [];
+
+export const compositions_metadata = {"compositions":[]};

package/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "es2019",
+      "DOM",
+      "ES6",
+      "DOM.Iterable"
+    ],
+    "target": "es2015",
+    "module": "CommonJS",
+    "jsx": "react",
+    "allowJs": true,
+    "composite": true,
+    "declaration": true,
+    "sourceMap": true,
+    "skipLibCheck": true,
+    "experimentalDecorators": true,
+    "outDir": "dist",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "rootDir": ".",
+    "resolveJsonModule": true
+  },
+  "exclude": [
+    "dist",
+    "package.json"
+  ],
+  "include": [
+    "**/*",
+    "**/*.json"
+  ]
+}

package/types/asset.d.ts

@@ -0,0 +1,29 @@
+declare module '*.png' {
+  const value: any;
+  export = value;
+}
+declare module '*.svg' {
+  import type { FunctionComponent, SVGProps } from 'react';
+
+  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  const src: string;
+  export default src;
+}
+
+// @TODO Gilad
+declare module '*.jpg' {
+  const value: any;
+  export = value;
+}
+declare module '*.jpeg' {
+  const value: any;
+  export = value;
+}
+declare module '*.gif' {
+  const value: any;
+  export = value;
+}
+declare module '*.bmp' {
+  const value: any;
+  export = value;
+}

package/types/style.d.ts

@@ -0,0 +1,42 @@
+declare module '*.module.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.module.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.mdx' {
+  const component: any;
+  export default component;
+}