Symbols generated FileSystem tree

[nikoloza]

smbls.create function takes two argument objects, app and options.

In App we pass the root object.

In options we pass the {} of parameters: some options are needed for DOMQL context, some for editor sync and a few ones just as flags. options can be passed from the codebase that is merged with file at node_modules/@symbo.ls/init/dynamic.json (implementation).

smbls CLI tools such as sync and fetch are responsible to fetch API data locally. Currently they replace data in dynamic.json file and is read by DOMQL in runtime (implementation). The passed object has higher priority during merge than dynamic file.

Requirement is that users should be able to specify the folder path in their ~/symbols.json (reference) file where we can create files at the given directory.

dynamic.json data might have a few or all of these properties:

- designSystem
- state
- data
- components
- pages
- functions
- utils
- secrets
- integrations
- dependencies
- settings

Those fields are described in based.io schema as well.

This JSON data is single source of truth for any app and is equivalent to the data on platform:

---

There are a few ways to get this data from API:

• Fetching https://api.symbols.app/get/ and pass the key in headers or use the @symbo.ls/fetch wrapper.
• Connect https://socket.symbols.app/ using @symbo.ls/socket.
• Get the bundled js file over the cdn: https://api.symbols.app/cdn/demo.js

CLI:

• sync realtime connection
• fetch one time fetching

Filesystem:

fs should have following structure:

|_ designSystem
|_ state
|_ data
|_ components
|_ pages
|_ functions
|_ utils
|_ index.js 
|_ package.json

fs-reversing - the process of sending data back to the api. TBA.
Running index.js code in nodejs runtime shall be giving the data object in memory. Babel might be required.

---

https://app.excalidraw.com/s/6FkfI99TECe/8RFVSqqVxkF