@based/client 3.2.2 → 4.0.1

package/docs/files.md

@@ -1,66 +0,0 @@
-## Files
-
-Based provides a way to upload and serve user content without hassle using the `client.file()` API.  
-Assets uploaded through this tool are then served through a global CDN network, which allows for caching and fast content-delivery.
-
-An additional optimization step is executed when the user uploads a video or an image.
-Images are optimized and compressed, and served through an image specific CDN, while videos get transcoded to multiple resolutions, in HLS format.
-
-### Introduction
-
-Files can be uploaded using the Based client, which in addition to uploading the file, also sets a node of type `file` on the database, which can then be queried and referenced, like you would for any other node.
-
-This default type has several fields describing the file, including it's size, mime-type, timestamps for creation and update, progress status, and more. A crucial field is `src`, which contains a link that points to the file (through the appropriate CDN).
-
-> :exclamation: Video files will take longer to become available due to the transcoding process.
-
-### Usage
-
-#### Upload
-
-`client.file()` returns a promise that resolves with the new node's ID.
-
-```js
-import based from '@based/client'
-const client = based({
-  org: 'saulx',
-  project: 'test',
-  env: 'production',
-})
-
-const fileId = await client.file({
-  contents: 'This is a string I want to store as plain text!',
-  mimeType: 'text/plain',
-  name: 'my-file-name',
-})
-```
-
-The upload progress of the file can then be tracked by _observing_ the `progress` field of the resulting node.
-
-#### Accessing the file
-
-The file can be accessed by querying the database.
-
-```js
-const data = await client.get({
-  $id: fileId,
-  $all: true,
-})
-/*
-data = {
-  id: "fi6a535226",
-  name: "eb3f67a3bc65325bf739ebddd94403e5(1).png",
-  mimeType: "image/png",
-  version: "eb3f67a3bc65325bf739ebddd94403e5",
-  origin: "https://based-env-files-do-usproduction-enb-xz-apz--orn-t-v-...98446afcb87d.png",
-  src: "https://based-2129034536588.imgix.net/fi6a535226/84e62df3-75...98446afcb87d.png",
-  progress: 1,
-  size: 61901,
-  type: "file",
-  createdAt: 1650360875043,
-  updatedAt: 1650360882865,
-}
-*/
-```
-
-When using this API, one should always link to the file using the `src` field, since it's the one using the CDN. Pointing to the `origin` would lead to significantly higher data costs.

package/docs/get-started.md

@@ -1,60 +0,0 @@
-<div align="center">
-  <a href="javascript:void(0);" style="pointer-events: none;">
-        <img src="../../../.docs/assets/based-logo-black.svg#gh-light-mode-only" style="width: 350px; padding-bottom: 10px;" />
-        <img src="../../../.docs/assets/based.svg#gh-dark-mode-only" style="width: 350px; padding-bottom: 10px;" />
-
-  </a>
-</div>
-
-# Getting started
-
-The first step in getting started with using Based is creating a new project. To do so, after logging in, click the `+ New Project` button and type in a new project name.  
-Each project can have multiple environments (e.g. development and production).
-
-Go to the based [dashboard](https://based-website.vercel.app/dashboard)
-
-<!-- create-new-project video -->
-
-https://user-images.githubusercontent.com/16743760/164229679-0555beb5-4c56-4843-8fc6-266fa7f15ee4.mov
-
-In order to start adding data to the project, a **schema** is needed. The schema defines your data types, for examples the users of a chat app. To add a new type, click the `+ Create a new type` button.  
-Each type can have any number of fields that describe it, for example a user's email. These can be added in the schema editor using the `+ Add Type` button.
-
-<!-- add-user-type-to-schema video-->
-
-https://user-images.githubusercontent.com/16743760/164229696-83de5222-2d8c-4778-8769-a0c3eea1f239.mov
-
-Next, it's time to add some content! This can be done through the Dashboard using the built-in content editor.
-
-<!-- add-content video -->
-
-https://user-images.githubusercontent.com/16743760/164229707-bc9652a2-0823-44b7-825d-1efdcc080ce6.mov
-
-Once the environment is up and running, it is time to jump into the code side of things.
-
-```js
-import based from '@based/client'
-
-const client = based({
-  org: 'my-org',
-  project: 'chat',
-  env: 'production',
-})
-
-// observe some data
-await client.observe(
-  { $id: 'root', children: { $all: true, $list: true } },
-  (data) => {
-    console.log(data)
-  }
-)
-
-// set data
-await client.set({
-  type: 'user',
-  email: 'francesco@example.com',
-  favoriteThing: 'pizza',
-})
-```
-
-> [Click here to read more about the Javascript Based SDK](../README.md)