"]
readme = "README.md"
-homepage = "https://www.streamsync.cloud"
+homepage = "https://www.writer.com"
repository = "https://www.github.com/streamsync-cloud/streamsync"
documentation = "https://www.streamsync.cloud/getting-started.html"
keywords = ["data apps", "gui", "ui"]
@@ -21,12 +20,13 @@ classifiers = [
"Development Status :: 4 - Beta"
]
packages = [
- { include = "streamsync", from = "src" }
+ { include = "writer", from = "src" }
]
include = [
- "src/streamsync/*.py",
- "src/streamsync/static/**/*",
- "src/streamsync/app_templates/**/*"
+ "src/writer/*.py",
+ "src/writer/static/**/*",
+ "src/writer/templates/**/*",
+ "src/writer/app_templates/**/*"
]
[tool.poetry.dependencies]
@@ -36,10 +36,13 @@ fastapi = ">= 0.89.1, < 1"
websockets = ">= 12, < 13"
uvicorn = ">= 0.20.0, < 1"
watchdog = ">= 3.0.0, < 4"
-writer-sdk = "0.1.0a1"
-pandas = {version = ">= 2.2.0, < 3", optional = true}
-pyarrow = {version = ">= 15.0.0, < 16.0.0",optional = true}
-plotly = {version = ">= 5.18.0, < 6", optional = true}
+writer-sdk = "0.1.0a2"
+pandas = ">= 2.2.0, < 3"
+pyarrow = ">= 15.0.0, < 16.0.0"
+plotly = ">= 5.18.0, < 6"
+authlib = "^1.3.0"
+requests = "^2.31.0"
+jinja2 = "^3.1.4"
[tool.poetry.group.build]
@@ -59,17 +62,14 @@ alfred-cli = "^2.2.7"
polars = "^0.20.15"
ruff = "^0.3.4"
-[tool.poetry.extras]
-ds = ["pandas", "pyarrow", "plotly"]
-
[tool.poetry.scripts]
-streamsync = 'streamsync.command_line:main'
+writer = 'writer.command_line:main'
[tool.ruff]
exclude = [
"src/ui",
- "src/streamsync/ui.py",
+ "src/writer/ui.py",
"docs",
"tests/e2e",
".git",
diff --git a/src/ui/package.json b/src/ui/package.json
index 49918dc4a..04cf954d5 100644
--- a/src/ui/package.json
+++ b/src/ui/package.json
@@ -1,5 +1,5 @@
{
- "name": "streamsync-ui",
+ "name": "writer-ui",
"version": "0.0.0",
"type": "module",
"scripts": {
diff --git a/src/ui/src/ambientTypes.ts b/src/ui/src/ambientTypes.ts
index 12449a20a..f5f09f230 100644
--- a/src/ui/src/ambientTypes.ts
+++ b/src/ui/src/ambientTypes.ts
@@ -1,9 +1,9 @@
-import { StreamsyncComponentDefinition } from "./streamsyncTypes";
+import { WriterComponentDefinition } from "./writerTypes";
declare module "marked";
declare module "vue" {
interface ComponentCustomOptions {
- streamsync?: StreamsyncComponentDefinition;
+ writer?: WriterComponentDefinition;
}
}
diff --git a/src/ui/src/builder/BuilderApp.vue b/src/ui/src/builder/BuilderApp.vue
index 68bc65da7..4d6fb34c8 100644
--- a/src/ui/src/builder/BuilderApp.vue
+++ b/src/ui/src/builder/BuilderApp.vue
@@ -79,7 +79,7 @@
:prevent-settings-bar-overlap="true"
:instance-path="selectedInstancePath"
:vertical-offset-pixels="-48"
- data-streamsync-cage
+ data-writer-cage
@dragstart="handleRendererDragStart"
@dragend="handleRendererDragEnd"
>
@@ -106,8 +106,8 @@
>
{{
- ss.getComponentDefinition(
- ss.getComponentById(candidateId).type,
+ wf.getComponentDefinition(
+ wf.getComponentById(candidateId).type,
).name
}}
@@ -136,7 +136,7 @@ import BuilderInsertionOverlay from "./BuilderInsertionOverlay.vue";
import BuilderInsertionLabel from "./BuilderInsertionLabel.vue";
import { isPlatformMac } from "../core/detectPlatform";
-const ss = inject(injectionKeys.core);
+const wf = inject(injectionKeys.core);
const ssbm = inject(injectionKeys.builderManager);
const {
@@ -146,7 +146,7 @@ const {
dropComponent,
assignInsertionCandidacy,
removeInsertionCandidacy,
-} = useDragDropComponent(ss);
+} = useDragDropComponent(wf);
const {
createAndInsertComponent,
undo,
@@ -164,7 +164,7 @@ const {
copyComponent,
removeComponentSubtree,
goToParent,
-} = useComponentActions(ss, ssbm);
+} = useComponentActions(wf, ssbm);
const builderMode = computed(() => ssbm.getMode());
@@ -254,11 +254,11 @@ function handleRendererClick(ev: PointerEvent): void {
if (builderMode.value === "preview") return;
const targetEl: HTMLElement = (ev.target as HTMLElement).closest(
- "[data-streamsync-id]",
+ "[data-writer-id]",
);
if (!targetEl) return;
- const targetId = targetEl.dataset.streamsyncId;
- const targetInstancePath = targetEl.dataset.streamsyncInstancePath;
+ const targetId = targetEl.dataset.writerId;
+ const targetInstancePath = targetEl.dataset.writerInstancePath;
if (targetId !== ssbm.getSelectedId()) {
ev.preventDefault();
ev.stopPropagation();
@@ -270,14 +270,14 @@ const handleRendererDragStart = (ev: DragEvent) => {
if (builderMode.value === "preview") return;
const targetEl: HTMLElement = (ev.target as HTMLElement).closest(
- "[data-streamsync-id]",
+ "[data-writer-id]",
);
- const componentId = targetEl.dataset.streamsyncId;
- const { type } = ss.getComponentById(componentId);
+ const componentId = targetEl.dataset.writerId;
+ const { type } = wf.getComponentById(componentId);
ev.dataTransfer.setData(
- `application/json;streamsync=${type},${componentId}`,
+ `application/json;writer=${type},${componentId}`,
"{}",
);
};
diff --git a/src/ui/src/builder/BuilderComponentShortcuts.vue b/src/ui/src/builder/BuilderComponentShortcuts.vue
index 5aff4a7ae..29b72c2fb 100644
--- a/src/ui/src/builder/BuilderComponentShortcuts.vue
+++ b/src/ui/src/builder/BuilderComponentShortcuts.vue
@@ -3,7 +3,7 @@
v-if="shortcutsInfo"
:draggable="shortcutsInfo?.isDraggable"
class="BuilderComponentShortcuts"
- :data-streamsync-id="componentId"
+ :data-writer-id="componentId"
>
{{ shortcutsInfo?.componentTypeName }}
@@ -149,11 +149,11 @@
diff --git a/src/ui/src/builder/BuilderFieldsPadding.vue b/src/ui/src/builder/BuilderFieldsPadding.vue
index 81293575a..53b2967a5 100644
--- a/src/ui/src/builder/BuilderFieldsPadding.vue
+++ b/src/ui/src/builder/BuilderFieldsPadding.vue
@@ -135,16 +135,16 @@ import {
ref,
toRefs,
} from "vue";
-import { Component } from "../streamsyncTypes";
+import { Component } from "../writerTypes";
import { useComponentActions } from "./useComponentActions";
import injectionKeys from "../injectionKeys";
import BuilderSelect from "./BuilderSelect.vue";
import { languages } from "monaco-editor";
import css = languages.css;
-const ss = inject(injectionKeys.core);
+const wf = inject(injectionKeys.core);
const ssbm = inject(injectionKeys.builderManager);
-const { setContentValue } = useComponentActions(ss, ssbm);
+const { setContentValue } = useComponentActions(wf, ssbm);
const rootEl: Ref = ref(null);
const pickerEl: Ref = ref(null);
@@ -209,7 +209,7 @@ const props = defineProps<{
}>();
const { componentId, fieldKey } = toRefs(props);
-const component = computed(() => ss.getComponentById(componentId.value));
+const component = computed(() => wf.getComponentById(componentId.value));
const selectOptions = computed(() => {
return subModes.map((m) => {
diff --git a/src/ui/src/builder/BuilderFieldsShadow.vue b/src/ui/src/builder/BuilderFieldsShadow.vue
index 4ccadd0d1..6a38a2c58 100644
--- a/src/ui/src/builder/BuilderFieldsShadow.vue
+++ b/src/ui/src/builder/BuilderFieldsShadow.vue
@@ -135,13 +135,13 @@ import {
ref,
toRefs,
} from "vue";
-import { Component } from "../streamsyncTypes";
+import { Component } from "../writerTypes";
import { useComponentActions } from "./useComponentActions";
import injectionKeys from "../injectionKeys";
-const ss = inject(injectionKeys.core);
+const wf = inject(injectionKeys.core);
const ssbm = inject(injectionKeys.builderManager);
-const { setContentValue } = useComponentActions(ss, ssbm);
+const { setContentValue } = useComponentActions(wf, ssbm);
const rootEl: Ref = ref(null);
const freehandInputEl: Ref = ref(null);
@@ -164,7 +164,7 @@ const props = defineProps<{
fieldKey: string;
}>();
const { componentId, fieldKey } = toRefs(props);
-const component = computed(() => ss.getComponentById(componentId.value));
+const component = computed(() => wf.getComponentById(componentId.value));
const boxShadowRegex =
/^(?[0-9]+)px (?[0-9]+)px (?[0-9]+)px (?[0-9-]+)px (?#[A-Fa-f0-9]{6})$/;
diff --git a/src/ui/src/builder/BuilderFieldsText.vue b/src/ui/src/builder/BuilderFieldsText.vue
index 951309495..d7a96493b 100644
--- a/src/ui/src/builder/BuilderFieldsText.vue
+++ b/src/ui/src/builder/BuilderFieldsText.vue
@@ -56,23 +56,23 @@
diff --git a/src/ui/src/core_components/other/CoreReuse.vue b/src/ui/src/core_components/other/CoreReuse.vue
index a710dc5ec..46ac9e571 100644
--- a/src/ui/src/core_components/other/CoreReuse.vue
+++ b/src/ui/src/core_components/other/CoreReuse.vue
@@ -3,12 +3,12 @@
+
+*server_setup.py*
+```python
+import os
+import streamsync.serve
+import streamsync.auth
+
+oidc = streamsync.auth.Oidc(
+ client_id="1xxxxxxxxx-qxxxxxxxxxxxxxxx.apps.googleusercontent.com",
+ client_secret="GOxxxx-xxxxxxxxxxxxxxxxxxxxx",
+ host_url=os.getenv('HOST_URL', "http://localhost:5000"),
+ url_authorize="https://accounts.google.com/o/oauth2/auth",
+ url_oauthtoken="https://oauth2.googleapis.com/token",
+ url_userinfo='https://www.googleapis.com/oauth2/v1/userinfo?alt=json'
+)
+
+streamsync.serve.register_auth(oidc)
+```
+### Use pre-configured OIDC
+
+StreamSync provides pre-configured OIDC providers. You can use them directly in your application.
+
+| | Provider | Function | Description |
+|------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------------|
+| 
| Google | `streamsync.auth.Google` | Allow your users to login with their Google Account |
+| 
| Github | `streamsync.auth.Github` | Allow your users to login with their Github Account |
+| 
| Auth0 | `streamsync.auth.Auth0` | Allow your users to login with different providers or with login password through Auth0 |
+
+
+#### Google
+
+You have to register your application into [Google Cloud Console](https://console.cloud.google.com/).
+
+*server_setup.py*
+```python
+import os
+import streamsync.serve
+import streamsync.auth
+
+oidc = streamsync.auth.Google(
+ client_id="1xxxxxxxxx-qxxxxxxxxxxxxxxx.apps.googleusercontent.com",
+ client_secret="GOxxxx-xxxxxxxxxxxxxxxxxxxxx",
+ host_url=os.getenv('HOST_URL', "http://localhost:5000")
+)
+
+streamsync.serve.register_auth(oidc)
+```
+
+#### Github
+
+You have to register your application into [Github](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app#registering-a-github-app)
+
+*server_setup.py*
+```python
+import os
+import streamsync.serve
+import streamsync.auth
+
+oidc = streamsync.auth.Github(
+ client_id="xxxxxxx",
+ client_secret="xxxxxxxxxxxxx",
+ host_url=os.getenv('HOST_URL', "http://localhost:5000")
+)
+
+streamsync.serve.register_auth(oidc)
+```
+
+#### Auth0
+
+You have to register your application into [Auth0](https://auth0.com/).
+
+*server_setup.py*
+```python
+import os
+import streamsync.serve
+import streamsync.auth
+
+oidc = streamsync.auth.Auth0(
+ client_id="xxxxxxx",
+ client_secret="xxxxxxxxxxxxx",
+ domain="xxx-xxxxx.eu.auth0.com",
+ host_url=os.getenv('HOST_URL', "http://localhost:5000")
+)
+
+streamsync.serve.register_auth(oidc)
+```
+
+### Authentication workflow
+
+
+
+## User information in event handler
+
+When the `user_info` route is configured, user information will be accessible
+in the event handler through the `session` argument.
+
+```python
+def on_page_load(state, session):
+ email = session['userinfo'].get('email', None)
+ state['email'] = email
+```
+
+
+## Unauthorize access
+
+It is possible to reject a user who, for example, does not have the correct email address.
+
+::: tip you can also use userinfo inside app
+You can restrict access to certain pages inside the application by using the `session` object.
+See [User information in event handler](#user-information-in-event-handler)
+:::
+
+```python
+from fastapi import Request
+
+import streamsync.serve
+import streamsync.auth
+
+oidc = ...
+
+def callback(request: Request, session_id: str, userinfo: dict):
+ if userinfo['email'] not in ['nom.prenom123@example.com']:
+ raise streamsync.auth.Unauthorized(more_info="You can contact the administrator at support.example.com")
+
+streamsync.serve.register_auth(oidc, callback=callback)
+```
+
+The default authentication error page look like this:
+
+
+
+*streamsync.auth.Unauthorized*
+
+| Parameter | Description |
+|-----------|-------------|
+| status_code | HTTP status code |
+| message | Error message |
+| more_info | Additional information |
+
+## Modify user info
+
+User info can be modified in the callback.
+
+```python
+from fastapi import Request
+
+import streamsync.serve
+import streamsync.auth
+
+oidc = ...
+
+def callback(request: Request, session_id: str, userinfo: dict):
+ userinfo['group'] = []
+ if userinfo['email'] in ['fabien@example.com']:
+ userinfo['group'].append('admin')
+ userinfo['group'].append('user')
+ else:
+ userinfo['group'].append('user')
+
+streamsync.serve.register_auth(oidc, callback=callback)
+```
+from fastapi import Request
+
+## Custom unauthorized page
+
+You can customize the access denial page using your own template.
+
+```python
+import os
+
+from fastapi import Request, Response
+from fastapi.templating import Jinja2Templates
+
+import streamsync.serve
+import streamsync.auth
+
+oidc = ...
+
+def unauthorized(request: Request, exc: streamsync.auth.Unauthorized) -> Response:
+ templates = Jinja2Templates(directory=os.path.join(os.path.dirname(__file__), "templates"))
+ return templates.TemplateResponse(request=request, name="unauthorized.html", status_code=exc.status_code, context={
+ "status_code": exc.status_code,
+ "message": exc.message,
+ "more_info": exc.more_info
+ })
+
+streamsync.serve.register_auth(oidc, unauthorized_action=unauthorized)
+```
+
+## Enable in edit mode
+
+Authentication is disabled in edit mode. To activate it,
+you must trigger the loading of the server_setup module in edition mode.
+
+```bash
+streamsync edit --enable-server-setup
+```
+
diff --git a/docs/docs/components/component-list.md b/docs/docs/components/component-list.md
index 5b78e7052..81674ca3b 100644
--- a/docs/docs/components/component-list.md
+++ b/docs/docs/components/component-list.md
@@ -3,7 +3,7 @@ outline: [2, 2]
---
diff --git a/docs/docs/core.ts b/docs/docs/core.ts
index 9e8bca173..23c1e6e55 100644
--- a/docs/docs/core.ts
+++ b/docs/docs/core.ts
@@ -1,7 +1,7 @@
import hljs from 'highlight.js/lib/core';
import python from 'highlight.js/lib/languages/python';
import { marked } from 'marked';
-import components from "streamsync-ui/components.codegen.json" assert { type: "json" };
+import components from "writer-ui/components.codegen.json" assert { type: "json" };
// @ts-ignore
hljs.registerLanguage('python', python);
diff --git a/docs/docs/custom-server.md b/docs/docs/custom-server.md
index a5f7549fa..d6c4bd102 100644
--- a/docs/docs/custom-server.md
+++ b/docs/docs/custom-server.md
@@ -2,7 +2,37 @@
Streamsync uses Uvicorn and serves the app in the root path i.e. `/`. If you need to use another ASGI-compatible server or fine-tune Uvicorn, you can easily do so.
-## Getting the ASGI app
+## Configure webserver
+
+You can tune your server by adding a `server_setup.py` file to the root
+of your application, next to the `main.py` and `ui.json` files.
+
+This file is executed before starting streamsync. It allows you to configure [authentication](./authentication.md),
+add your own routes and middlewares on FastAPI.
+
+```python
+# server_setup.py
+import typing
+
+import streamsync.serve
+
+if typing.TYPE_CHECKING:
+ from fastapi import FastAPI
+
+# Returns the FastAPI application associated with the streamsync server.
+asgi_app: FastAPI = streamsync.serve.app
+
+@asgi_app.get("/probes/healthcheck")
+def hello():
+ return "1"
+```
+
+::: warning Use `server_setup.py` in `edit` mode
+If you want to use in `edit` mode,
+you can launch `streamsync edit --enable-server-setup