@teambit/semantics.entities.semantic-schema 0.0.0-e4ef0e951da794f03096a5cc407420f4cde8b878

package/schemas/variable-like.ts

@@ -0,0 +1,76 @@
+import chalk from 'chalk';
+import { SchemaLocation, SchemaNode } from '../schema-node';
+import { DocSchema } from './docs';
+import { SchemaRegistry } from '../schema-registry';
+
+/**
+ * can be also a property or property-signature
+ */
+export class VariableLikeSchema extends SchemaNode {
+  type: SchemaNode;
+  readonly doc?: DocSchema;
+  readonly displaySchemaName = 'Variables';
+
+  constructor(
+    readonly location: SchemaLocation,
+    readonly name: string,
+    readonly signature: string,
+    type: SchemaNode,
+    readonly isOptional: boolean,
+    doc?: DocSchema,
+    readonly defaultValue?: string
+  ) {
+    super();
+    this.type = type;
+    this.doc = doc;
+  }
+
+  getNodes() {
+    return [this.type];
+  }
+
+  toString(options?: { color?: boolean }) {
+    const bold = options?.color ? chalk.bold : (str: string) => str;
+    return `${bold(this.name)}${this.isOptional ? '?' : ''}: ${this.type.toString(options)}`;
+  }
+
+  toFullSignature(options?: { showDocs?: boolean }): string {
+    const namePart = `${this.name}${this.isOptional ? '?' : ''}`;
+    const typeSignature = this.type.toFullSignature(options);
+    let signature = `${namePart}: ${typeSignature}`;
+
+    if (this.defaultValue !== undefined) {
+      signature += ` = ${this.defaultValue}`;
+    }
+
+    if (options?.showDocs && this.doc) {
+      const docString = this.doc.toFullSignature();
+      signature = `${docString}\n${signature}`;
+    }
+
+    return signature;
+  }
+
+  toObject() {
+    return {
+      ...super.toObject(),
+      name: this.name,
+      signature: this.signature,
+      type: this.type.toObject(),
+      isOptional: this.isOptional,
+      doc: this.doc?.toObject(),
+      defaultValue: this.defaultValue,
+    };
+  }
+
+  static fromObject(obj: Record<string, any>): VariableLikeSchema {
+    const location = obj.location;
+    const name = obj.name;
+    const signature = obj.signature;
+    const type = SchemaRegistry.fromObject(obj.type);
+    const isOptional = obj.isOptional;
+    const doc = obj.doc ? DocSchema.fromObject(obj.doc) : undefined;
+    const defaultValue = obj.defaultValue;
+    return new VariableLikeSchema(location, name, signature, type, isOptional, doc, defaultValue);
+  }
+}

package/semantic-schema.docs.md

@@ -0,0 +1,6 @@
+---
+description: Describes the API schema for a component.
+labels: ['api', 'schema', 'semantic']
+---
+
+...

package/type.ts

@@ -0,0 +1 @@
+export type TypeRef = {};

package/types/asset.d.ts

@@ -0,0 +1,41 @@
+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;
+}
+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;
+}
+declare module '*.otf' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff2' {
+  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;
+}

package/unknown-schema-factory.ts

@@ -0,0 +1,10 @@
+import { SchemaLocation } from './schema-node';
+
+export class UnknownSchemaFactory {
+  static create(location: SchemaLocation, name: string, schemaObj: Record<string, any>): any {
+    // dynamic require() to import UnknownSchema at runtime when it's needed, which breaks the circular dependency.
+    // eslint-disable-next-line global-require
+    const { UnknownSchema } = require('./schemas/unknown-schema');
+    return new UnknownSchema(location, name, schemaObj);
+  }
+}