@teambit/schema 1.0.228 → 1.0.229

package/dist/exceptions/index.d.ts

@@ -0,0 +1 @@
+export { ParserNotFound } from './parser-not-found';

package/dist/exceptions/parser-not-found.d.ts

@@ -0,0 +1,4 @@
+export declare class ParserNotFound extends Error {
+    readonly filePath: string;
+    constructor(filePath: string);
+}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { SchemaAspect } from './schema.aspect';
+export type { Parser } from './parser';
+export type { SchemaExtractor } from './schema-extractor';
+export type { SchemaExtractorOptions } from './schema-extractor';
+export { SchemaTask, SCHEMA_ARTIFACT_NAME, SCHEMA_TASK_NAME, getSchemaArtifactDef, getSchemaArtifactPath, } from './schema.task';
+export type { SchemaEnv } from './schema-env';
+export type { SchemaMain } from './schema.main.runtime';
+export default SchemaAspect;
+export { SchemaAspect };

package/dist/mock/button/button.composition.d.ts

@@ -0,0 +1,10 @@
+export declare const BasicButton: () => import("react/jsx-runtime").JSX.Element;
+/**
+ * example of passing a JSX Element as a parameter
+ */
+export declare function Footer({ children }: {
+    children?: import("react/jsx-runtime").JSX.Element | undefined;
+}): import("react/jsx-runtime").JSX.Element;
+export declare const ButtonWithCustomStyles: () => import("react/jsx-runtime").JSX.Element;
+export declare const ButtonWithIcon: () => import("react/jsx-runtime").JSX.Element;
+export declare const ButtonAsALink: () => import("react/jsx-runtime").JSX.Element;

package/dist/mock/button/button.d.ts

@@ -0,0 +1,20 @@
+import React, { ReactNode } from 'react';
+export type ButtonElementType = 'a' | 'button';
+export type ButtonProps = {
+    /**
+     * children of the Button.
+     */
+    children: ReactNode;
+    /**
+     * link to target page. once href is used, Button is considered an A tag.
+     */
+    href?: string;
+    /**
+     * class names to inject.
+     */
+    className?: string;
+} & React.ButtonHTMLAttributes<HTMLButtonElement>;
+export declare function Button(props: ButtonProps): import("react/jsx-runtime").JSX.Element;
+export declare class Bar {
+    foo(): void;
+}

package/dist/mock/button/index.d.ts

@@ -0,0 +1,120 @@
+/**
+ * General comment of the myFunc
+ * @deprecate example of deprecation tag
+ * @param a { number } this is A
+ * @param b this is B
+ * @returns { number } results of adding a to b
+ */
+export declare function myFunc(a?: number, b?: number): number;
+export * from './button';
+export declare function Hi(): void;
+export declare const a = 4, b: 5;
+export * as Compositions from './button.composition';
+export declare const HiThere = "HiThere";
+export declare const Function: () => void;
+export declare const Array: string[];
+declare class Foo {
+}
+declare class ClassSomething {
+    readonly da: 'dsa';
+    app: string;
+    constructor(da: 'dsa');
+    a(): Foo;
+    get getter(): string;
+    set setter(a: boolean);
+}
+export { ClassSomething };
+export type IndexSig = {
+    [key: string]: boolean;
+};
+export interface Hello {
+    propertySig: () => void;
+    methodSig(): string;
+}
+declare const obj: {
+    a: number;
+    b: number;
+};
+export declare const a1: typeof obj;
+export type TypeOperator = keyof typeof obj;
+declare class Bar {
+    foo(): void;
+}
+export declare const getBar: (bar: Bar) => Bar;
+export declare const tuple: ([a, b, c]: [string, Function, Record<string, any>]) => void;
+export declare enum Food {
+    Falafel = 0,
+    Hummus = 1,
+    Tahini = 2
+}
+export declare function getPromise(): Promise<string>;
+declare class T1 {
+}
+declare class T2 {
+}
+declare class T3<T, K> {
+}
+export type TypeRefWithArgs = T3<T1, T2>;
+export type ParenthesizedType = (T1 | T2)[];
+export declare function typePredicateFn(str: any): str is string;
+export declare function typePredicateNoTypeFn(condition: any, msg?: string): asserts condition;
+export declare function objectBindingElements({ prop }: {
+    prop?: number | undefined;
+}): Promise<number>;
+export declare function arrayBindingElements([prop]: [string]): Promise<string>;
+interface config {
+    someField: {
+        a: string;
+        b: boolean;
+    };
+}
+export type IndexedAccessType = config['someField'];
+declare const computedName = "str";
+export interface ComputedNameWithType {
+    [computedName]: boolean;
+}
+export interface ComputedNameNoType {
+    [computedName]: any;
+}
+type World1 = 'world1-a' | 'world1-b';
+type World2 = 'world2';
+export type templateLiteralType = `hello ${World1} hi ${World2}`;
+export interface CallSignatureWithTypeParams {
+    <T>(a: string): T;
+}
+/**
+ * Conditional Generic Type
+ */
+export type If<T, U, Y, N> = T extends U ? Y : N;
+export declare function genericFunction<T>(a: T): <T_1>(a: T_1) => void;
+export declare const gfnc2: <T>(a: T) => void;
+export declare function LogMethod(message: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+export declare function CustomClassDecorator(config: {
+    name: string;
+    description: string;
+    fn?: () => string;
+    class?: ClassSomething;
+    arr?: [
+        string,
+        number,
+        boolean,
+        boolean,
+        number | undefined,
+        (a: string) => void,
+        {
+            a: string;
+            b: number;
+        },
+        ClassSomething
+    ];
+}): (target: any) => void;
+export declare class ExampleDecoratorOne {
+    exampleMethod(): void;
+}
+export declare function ValidateArgs(config: {
+    type: string;
+    required: boolean;
+}): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+export declare class ExampleDecoratorTwo {
+    exampleMethod(input: string): void;
+}

package/dist/parser.d.ts

@@ -0,0 +1,11 @@
+import { Export } from '@teambit/semantics.entities.semantic-schema';
+export interface Parser {
+    /**
+     * regex to apply on which components compiler applies.
+     */
+    extension: RegExp;
+    /**
+     * parse a module.
+     */
+    parseModule(modulePath: string, content?: string): Export[];
+}

package/dist/{preview-1712805335812.js → preview-1712822929999.js}

@@ -1,6 +1,6 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_schema@1.0.228/dist/schema.composition.js';
-import * as compositions_1 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_schema@1.0.228/dist/mock/button/button.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_schema@1.0.228/dist/schema.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_schema@1.0.229/dist/schema.composition.js';
+import * as compositions_1 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_schema@1.0.229/dist/mock/button/button.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_schema@1.0.229/dist/schema.docs.mdx';
 
 export const compositions = [compositions_0, compositions_1];
 export const overview = [overview_0];

package/dist/schema-env.d.ts

@@ -0,0 +1,9 @@
+import { EnvHandler } from '@teambit/envs';
+import { SchemaExtractor } from './schema-extractor';
+/**
+ * define a schema extractor to extract type information
+ * and docs for your components.
+ */
+export interface SchemaEnv {
+    schemaExtractor(): EnvHandler<SchemaExtractor>;
+}

package/dist/schema-extractor.d.ts

@@ -0,0 +1,22 @@
+import { Component } from '@teambit/component';
+import { APISchema } from '@teambit/semantics.entities.semantic-schema';
+import { Formatter } from '@teambit/formatter';
+export interface SchemaExtractor {
+    /**
+     * extract a semantic schema from a component.
+     */
+    extract(component: Component, options?: SchemaExtractorOptions): Promise<APISchema>;
+    /**
+     * release resources if no schemas are needed for this process.
+     * for typescript, this will kill the tsserver process.
+     * for performance reasons, this is not automatically run after "extract". otherwise, running extract on multiple
+     * components will be very slow.
+     */
+    dispose(): void;
+}
+export type SchemaExtractorOptions = {
+    formatter?: Formatter;
+    tsserverPath?: string;
+    contextPath?: string;
+    skipInternals?: boolean;
+};

package/dist/schema.aspect.d.ts

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

package/dist/schema.cmd.d.ts

@@ -0,0 +1,18 @@
+import { Command, CommandOptions } from '@teambit/cli';
+import { ComponentMain } from '@teambit/component';
+import { Logger } from '@teambit/logger';
+import type { SchemaMain } from './schema.main.runtime';
+export declare class SchemaCommand implements Command {
+    private schema;
+    private component;
+    private logger;
+    name: string;
+    description: string;
+    extendedDescription: string;
+    group: string;
+    options: CommandOptions;
+    constructor(schema: SchemaMain, component: ComponentMain, logger: Logger);
+    report([pattern]: [string]): Promise<string>;
+    json([pattern]: [string]): Promise<Record<string, any>>;
+    private getSchemas;
+}

package/dist/schema.composition.d.ts

@@ -0,0 +1 @@
+export declare const Logo: () => import("react/jsx-runtime").JSX.Element;

package/dist/schema.graphql.d.ts

@@ -0,0 +1,3 @@
+import { Schema } from '@teambit/graphql';
+import { SchemaMain } from './schema.main.runtime';
+export declare function schemaSchema(schema: SchemaMain): Schema;

package/dist/schema.main.runtime.d.ts

@@ -0,0 +1,92 @@
+import { CLIMain } from '@teambit/cli';
+import { Component, ComponentMain } from '@teambit/component';
+import { SlotRegistry } from '@teambit/harmony';
+import { GraphqlMain } from '@teambit/graphql';
+import { EnvsMain } from '@teambit/envs';
+import { Logger, LoggerMain } from '@teambit/logger';
+import { APISchema, Export, SchemaNodeConstructor } from '@teambit/semantics.entities.semantic-schema';
+import { BuilderMain } from '@teambit/builder';
+import { Workspace } from '@teambit/workspace';
+import { ScopeMain } from '@teambit/scope';
+import { SchemaNodeTransformer, SchemaTransformer } from '@teambit/typescript';
+import { Parser } from './parser';
+import { SchemaExtractor } from './schema-extractor';
+export type ParserSlot = SlotRegistry<Parser>;
+export type SchemaConfig = {
+    /**
+     * default parser
+     */
+    defaultParser: string;
+    /**
+     * disable extracting schema
+     */
+    disabled?: boolean;
+};
+/**
+ * extension for extracting component schemas.
+ */
+export declare class SchemaMain {
+    /**
+     * parsers slot.
+     */
+    private parserSlot;
+    private envs;
+    private config;
+    private builder;
+    private workspace;
+    private logger;
+    constructor(
+    /**
+     * parsers slot.
+     */
+    parserSlot: ParserSlot, envs: EnvsMain, config: SchemaConfig, builder: BuilderMain, workspace: Workspace, logger: Logger);
+    /**
+     * get the default parser.
+     */
+    getDefaultParser(): Parser;
+    registerSchemaClass(schema: SchemaNodeConstructor): void;
+    /**
+     * parse a module into a component schema.
+     */
+    parseModule(path: string, content?: string): Export[];
+    getSchemaExtractor(component: Component, tsserverPath?: string, contextPath?: string): SchemaExtractor;
+    /**
+     * get a schema of a component.
+     * @param component target component.
+     * @param shouldDisposeResourcesOnceDone for long-running processes, such as bit-start/bit-watch, this is not
+     * relevant. for calling the API only to get a schema for one component, this is needed to ensure the ts-server is
+     * not kept alive. otherwise, the process will never end.
+     *
+     */
+    getSchema(component: Component, shouldDisposeResourcesOnceDone?: boolean, alwaysRunExtractor?: boolean, tsserverPath?: string, contextPath?: string, skipInternals?: boolean, schemaTransformers?: SchemaTransformer[], apiTransformers?: SchemaNodeTransformer[]): Promise<APISchema>;
+    getSchemaFromObject(obj: Record<string, any>): APISchema;
+    /**
+     * register a new parser.
+     */
+    registerParser(parser: Parser): SchemaMain;
+    calcSchemaData(): Promise<{
+        disabled?: boolean;
+    }>;
+    getSchemaData(component: Component): {
+        [key: string]: any;
+    } | undefined;
+    isSchemaTaskDisabled(component: Component): any;
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static slots: ((registerFn: () => string) => SlotRegistry<Parser>)[];
+    static defaultConfig: {
+        defaultParser: string;
+        disabled: boolean;
+    };
+    static provider([envs, cli, component, graphql, loggerMain, builder, workspace, scope]: [
+        EnvsMain,
+        CLIMain,
+        ComponentMain,
+        GraphqlMain,
+        LoggerMain,
+        BuilderMain,
+        Workspace,
+        ScopeMain
+    ], config: SchemaConfig, [parserSlot]: [ParserSlot]): Promise<SchemaMain>;
+}
+export default SchemaMain;

package/dist/schema.service.d.ts

@@ -0,0 +1,14 @@
+import { EnvService, ExecutionContext, Env, EnvContext, ServiceTransformationMap } from '@teambit/envs';
+import { SchemaExtractor } from './schema-extractor';
+type SchemaTransformationMap = ServiceTransformationMap & {
+    getSchemaExtractor: () => SchemaExtractor;
+};
+export declare class SchemaService implements EnvService<{}> {
+    name: string;
+    run(context: ExecutionContext): Promise<{
+        errors: never[];
+        context: ExecutionContext;
+    }>;
+    transform(env: Env, context: EnvContext): SchemaTransformationMap | undefined;
+}
+export {};

package/dist/schema.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/schema.task.d.ts

@@ -0,0 +1,20 @@
+import { BuildContext, BuiltTaskResult, BuildTask, TaskLocation, ArtifactDefinition } from '@teambit/builder';
+import { Logger } from '@teambit/logger';
+import { SchemaMain } from './schema.main.runtime';
+export declare const SCHEMA_TASK_NAME = "ExtractSchema";
+export declare const SCHEMA_ARTIFACT_NAME = "schema";
+/**
+ * extract and persist the component schema as a json file
+ */
+export declare class SchemaTask implements BuildTask {
+    readonly aspectId: string;
+    private schema;
+    private logger;
+    readonly name = "ExtractSchema";
+    readonly location: TaskLocation;
+    readonly description = "extract api schema for a set of components";
+    constructor(aspectId: string, schema: SchemaMain, logger: Logger);
+    execute(context: BuildContext): Promise<BuiltTaskResult>;
+}
+export declare function getSchemaArtifactPath(): string;
+export declare function getSchemaArtifactDef(): ArtifactDefinition;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/schema",
-  "version": "1.0.228",
+  "version": "1.0.229",
   "homepage": "https://bit.cloud/teambit/semantics/schema",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.semantics",
     "name": "schema",
-    "version": "1.0.228"
+    "version": "1.0.229"
   },
   "dependencies": {
     "p-map-series": "2.1.0",
@@ -15,17 +15,17 @@
     "fs-extra": "10.0.0",
     "@teambit/harmony": "0.4.6",
     "@teambit/semantics.entities.semantic-schema": "0.0.68",
-    "@teambit/envs": "1.0.228",
-    "@teambit/component": "1.0.228",
-    "@teambit/formatter": "1.0.228",
-    "@teambit/cli": "0.0.861",
-    "@teambit/logger": "0.0.954",
-    "@teambit/graphql": "1.0.228",
-    "@teambit/builder": "1.0.228",
+    "@teambit/envs": "1.0.229",
+    "@teambit/component": "1.0.229",
+    "@teambit/formatter": "1.0.229",
+    "@teambit/cli": "0.0.862",
+    "@teambit/logger": "0.0.955",
+    "@teambit/graphql": "1.0.229",
+    "@teambit/builder": "1.0.229",
     "@teambit/defender.prettier.config-mutator": "0.0.100",
-    "@teambit/scope": "1.0.228",
-    "@teambit/typescript": "1.0.228",
-    "@teambit/workspace": "1.0.228"
+    "@teambit/scope": "1.0.229",
+    "@teambit/typescript": "1.0.229",
+    "@teambit/workspace": "1.0.229"
   },
   "devDependencies": {
     "@types/chai": "4.2.15",
@@ -34,9 +34,9 @@
     "chai": "4.3.0",
     "@types/mocha": "9.1.0",
     "@teambit/component-id": "1.2.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.30",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.33",
     "@teambit/harmony.testing.load-aspect": "0.0.190",
-    "@teambit/tracker": "1.0.228",
+    "@teambit/tracker": "1.0.229",
     "@teambit/workspace.testing.mock-workspace": "0.0.27"
   },
   "peerDependencies": {

package/tsconfig.json

@@ -20,8 +20,7 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "composite": true
+    "noImplicitAny": false
   },
   "exclude": [
     "artifacts",
@@ -36,40 +35,5 @@
   "include": [
     "**/*",
     "**/*.json"
-  ],
-  "references": [
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.861"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.954"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_graphql@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pipelines_builder@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.scope_scope@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.typescript_typescript@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_tracker@1.0.228"
-    }
   ]
 }