teleporthq/teleport-lib-js

teleport-lib-js's Issues

Teleport Intermediary Representation

Finalize the Teleport Intermediary Representation

• define and document target structure
• define and document content.props structure

find a solution for "complex" primitive elements such as `<Link href="url"><a>My Link</a></Link>`

add a solution to accept body/inline `script tags`.

concrete case: supporting github code gists

<script src="https://gist.github.com/crissmoldovan/49375169aee3b9f287d5e1602c84a7c0.js"></script>

add 100% code coverage

Make optional object optional when generating project

`target.map(source, type)`should return an `ElementMapping`

`use` method is error prone in its current format

The use of use method is error prone: if you forget to call with wrapped with async/await the libraries are not loaded properly.

Proposal: remove readPluginDefinitionFromUrl from it and make it sync. Keep readPluginDefinitionFromUrl as a standalone method.

export typescript definition files in build

test

should we allow the use of void elements as root element of a Component?

In the case of Next.js for example, an component with a root element img will trigger a React error because of the attempte to insert the <style jsx> tag as child of the <img> tag.

To avoid this error, we could check for the type of element rendered, and if it is a root and void element we could insert the style data inline.

Component, Page and Content type definitions do not match the teleport api format

export interface Page {
  name: string
  content: Content
  url?: string
  children?: Component[] | string //Page api does not contain children
}

export interface Component {
  name: string
  content: Content
  children?: Component[] | string //Component does not contain children
  editableProps?: {
    [key: string]: ComponentEditableProp
  }
}

export interface Content {
  type: string
  source: string
  name: string
  style: {
    [key: string]: string
  }
// Content contains children 
}

add basic information and documentation in readme file

remove readPluginDefinitionFromFile() utility method

simplify the library and delegate the loading mechanism