diff --git a/library/modules/supabase/README.md b/library/modules/supabase/README.md index 92effd7..a966559 100644 --- a/library/modules/supabase/README.md +++ b/library/modules/supabase/README.md @@ -7,4 +7,15 @@ hide_title: true > This is currently a private extension to Fluxscape. The documentation is still under development and will be improved over time. -Fluxscape's Supabase integration provides a first-class way to sync data, authenticate users, and trigger serverless workflows directly from within Fluxscape apps. +Fluxscape’s Supabase integration provides a first-class way to sync data, authenticate users, and trigger serverless workflows directly from within Fluxscape apps. + +The integration is designed for teams building production-grade applications that require a robust backend, strong data modeling, row-level security, and scalable serverless functions, all while staying inside the Fluxscape visual workflow. + +### Access to the Supabase integration + +The Supabase integration is currently available by request. + +If you are interested in using it or evaluating it for your team or customers, please contact the Fluxscape team via +https://fluxscape.io/contact + +We use this process to ensure proper onboarding, feedback. \ No newline at end of file diff --git a/library/modules/supabase/fs-sb-call-broadcast-realtime.png b/library/modules/supabase/fs-sb-call-broadcast-realtime.png new file mode 100644 index 0000000..84868f1 Binary files /dev/null and b/library/modules/supabase/fs-sb-call-broadcast-realtime.png differ diff --git a/library/modules/supabase/fs-sb-call-function.png b/library/modules/supabase/fs-sb-call-function.png new file mode 100644 index 0000000..3777bd8 Binary files /dev/null and b/library/modules/supabase/fs-sb-call-function.png differ diff --git a/library/modules/supabase/fs-sb-client-create-record.png b/library/modules/supabase/fs-sb-client-create-record.png new file mode 100644 index 0000000..74f5a21 Binary files /dev/null and b/library/modules/supabase/fs-sb-client-create-record.png differ diff --git a/library/modules/supabase/fs-sb-client-delete-record.png b/library/modules/supabase/fs-sb-client-delete-record.png new file mode 100644 index 0000000..7377146 Binary files /dev/null and b/library/modules/supabase/fs-sb-client-delete-record.png differ diff --git a/library/modules/supabase/fs-sb-client-update-record.png b/library/modules/supabase/fs-sb-client-update-record.png new file mode 100644 index 0000000..ad5a72c Binary files /dev/null and b/library/modules/supabase/fs-sb-client-update-record.png differ diff --git a/library/modules/supabase/fs-sb-create-record.png b/library/modules/supabase/fs-sb-create-record.png new file mode 100644 index 0000000..465a16e Binary files /dev/null and b/library/modules/supabase/fs-sb-create-record.png differ diff --git a/library/modules/supabase/fs-sb-delete-files.png b/library/modules/supabase/fs-sb-delete-files.png new file mode 100644 index 0000000..bcf34e4 Binary files /dev/null and b/library/modules/supabase/fs-sb-delete-files.png differ diff --git a/library/modules/supabase/fs-sb-download-file.png b/library/modules/supabase/fs-sb-download-file.png new file mode 100644 index 0000000..3519cc0 Binary files /dev/null and b/library/modules/supabase/fs-sb-download-file.png differ diff --git a/library/modules/supabase/fs-sb-login.png b/library/modules/supabase/fs-sb-login.png new file mode 100644 index 0000000..05708c2 Binary files /dev/null and b/library/modules/supabase/fs-sb-login.png differ diff --git a/library/modules/supabase/fs-sb-logout.png b/library/modules/supabase/fs-sb-logout.png new file mode 100644 index 0000000..84596a4 Binary files /dev/null and b/library/modules/supabase/fs-sb-logout.png differ diff --git a/library/modules/supabase/fs-sb-resumable-upload.png b/library/modules/supabase/fs-sb-resumable-upload.png new file mode 100644 index 0000000..0e4112e Binary files /dev/null and b/library/modules/supabase/fs-sb-resumable-upload.png differ diff --git a/library/modules/supabase/fs-sb-retrieve-public-file-url.png b/library/modules/supabase/fs-sb-retrieve-public-file-url.png new file mode 100644 index 0000000..b088358 Binary files /dev/null and b/library/modules/supabase/fs-sb-retrieve-public-file-url.png differ diff --git a/library/modules/supabase/fs-sb-set-presence.png b/library/modules/supabase/fs-sb-set-presence.png new file mode 100644 index 0000000..5d31cbb Binary files /dev/null and b/library/modules/supabase/fs-sb-set-presence.png differ diff --git a/library/modules/supabase/fs-sb-subscribe-channel.png b/library/modules/supabase/fs-sb-subscribe-channel.png new file mode 100644 index 0000000..e95673a Binary files /dev/null and b/library/modules/supabase/fs-sb-subscribe-channel.png differ diff --git a/library/modules/supabase/fs-sb-update-record.png b/library/modules/supabase/fs-sb-update-record.png new file mode 100644 index 0000000..cec0737 Binary files /dev/null and b/library/modules/supabase/fs-sb-update-record.png differ diff --git a/library/modules/supabase/fs-sb-upload-file.png b/library/modules/supabase/fs-sb-upload-file.png new file mode 100644 index 0000000..e3c340c Binary files /dev/null and b/library/modules/supabase/fs-sb-upload-file.png differ diff --git a/library/modules/supabase/fs-sb-user.png b/library/modules/supabase/fs-sb-user.png new file mode 100644 index 0000000..f867dc9 Binary files /dev/null and b/library/modules/supabase/fs-sb-user.png differ diff --git a/library/modules/supabase/nodes/auth/log-in.md b/library/modules/supabase/nodes/auth/log-in.md index f0106e4..3ed5a80 100644 --- a/library/modules/supabase/nodes/auth/log-in.md +++ b/library/modules/supabase/nodes/auth/log-in.md @@ -5,9 +5,16 @@ hide_title: true {/*##head##*/} # Log In +
+Logs in an existing user using an email and password or a phone number and password. -Log in an existing user with an email and password or phone and password. +
+![Log In node](../../fs-sb-login.png) +
-{/*##head##*/} +This node authenticates the user against your connected Supabase project and, on success, creates an active user session. The session can then be used by other Supabase nodes in the app to access protected data, apply row-level security policies, and perform authenticated operations. + +The Log In node is typically used as part of an authentication flow together with input fields for credentials and conditional logic to handle successful and failed login attempts. -This is based on the [Supabase Client SDK - Sign in a user](https://supabase.com/docs/reference/javascript/auth-signinwithpassword). +This functionality is based on the Supabase Client SDK sign-in method. For implementation details and behavior, see +[Supabase Client SDK – Sign in a user](https://supabase.com/docs/reference/javascript/auth-signinwithpassword). diff --git a/library/modules/supabase/nodes/auth/log-out.md b/library/modules/supabase/nodes/auth/log-out.md index 2794b46..337560f 100644 --- a/library/modules/supabase/nodes/auth/log-out.md +++ b/library/modules/supabase/nodes/auth/log-out.md @@ -5,9 +5,17 @@ hide_title: true {/*##head##*/} # Log Out +
+Logs out the currently authenticated user from the connected Supabase project. -Log in an existing user with an email and password or phone and password. +
+![Log Out node](../../fs-sb-logout.png) +
+ +This node clears the active user session and removes the user’s authentication state from the app. After logging out, any subsequent Supabase operations will be executed without an authenticated user until a new login occurs. + +The Log Out node is typically used in navigation flows, account menus, or security-related actions where the user explicitly ends their session. -{/*##head##*/} -This is based on the [Supabase Client SDK - Sign out a user](https://supabase.com/docs/reference/javascript/auth-signout). +This functionality is based on the Supabase Client SDK sign-out method. For reference, see +[Supabase Client SDK – Sign out a user](https://supabase.com/docs/reference/javascript/auth-signout). \ No newline at end of file diff --git a/library/modules/supabase/nodes/auth/user.md b/library/modules/supabase/nodes/auth/user.md index 80c2c03..b6d06e6 100644 --- a/library/modules/supabase/nodes/auth/user.md +++ b/library/modules/supabase/nodes/auth/user.md @@ -5,5 +5,17 @@ hide_title: true {/*##head##*/} # User +
+Returns the currently authenticated user from the active Supabase session. + +
+ ![User node](../../fs-sb-user.png) +
+ +This node provides access to the user object associated with the current session. The returned data includes identifiers and metadata such as the user ID, email address, phone number, and any custom user metadata defined in Supabase. + +The User node is commonly used to display account information, personalize the UI, or drive conditional logic based on whether a user is logged in or not. If no active session exists, the node returns `null`. + +The returned user data reflects the authentication state managed by Supabase and automatically updates as the session changes. {/*##head##*/} diff --git a/library/modules/supabase/nodes/data/call-a-postgres-function.md b/library/modules/supabase/nodes/data/call-a-postgres-function.md index 8b0a124..a4023c1 100644 --- a/library/modules/supabase/nodes/data/call-a-postgres-function.md +++ b/library/modules/supabase/nodes/data/call-a-postgres-function.md @@ -2,10 +2,15 @@ hide_title: true --- -{/*##head##*/} +# Supabase Call a Postgres Function +
+Calls a Postgres function (RPC) defined in your Supabase database. -# Supabase Call a Postgres function +The Supabase Call a Postgres Function node allows you to execute a Postgres function directly on the database. This is commonly used for encapsulating complex queries, enforcing business logic close to the data, or performing operations that are difficult or inefficient to express using standard CRUD nodes. -{/*##head##*/} +Postgres functions are executed within the database context and can return scalar values, records, or sets of rows. This makes them well suited for aggregations, computed results, permission-aware queries, and reusable backend logic. -This is based on the [Supabase Client SDK - Call a Postgres function](https://supabase.com/docs/reference/javascript/rpc). +The node returns the raw result of the function execution. If the function returns multiple rows, the result will be an array. If no active session exists or permissions are insufficient, the call will fail according to your Supabase security and RLS configuration. + +This functionality is based on the Supabase Client SDK RPC method. For reference, see +[Supabase Client SDK – Call a Postgres function](https://supabase.com/docs/reference/javascript/rpc). \ No newline at end of file diff --git a/library/modules/supabase/nodes/data/create-new-record.md b/library/modules/supabase/nodes/data/create-new-record.md index 96069f7..d00decd 100644 --- a/library/modules/supabase/nodes/data/create-new-record.md +++ b/library/modules/supabase/nodes/data/create-new-record.md @@ -2,27 +2,32 @@ hide_title: true --- -{/*##head##*/} - # Create New Record +
+Creates a new record in a specified Supabase table. + +
+ ![Create New Record node](../../fs-sb-create-record.png) +
-The Create New Record node creates a new record in a specified table. You can define its field values and optionally set access control rules to manage who can read or write the record. +The Create New Record node inserts a new row into a selected table in your connected Supabase database. You define the field values either directly in the property panel or dynamically by connecting inputs from other nodes. -{/*##head##*/} +This node is commonly used for creating application data such as users, orders, content items, or any custom domain objects defined in your database schema. Insert operations respect Supabase Row Level Security (RLS) policies and the authentication context of the current user. -This is based on the [Supabase Client SDK - Insert data](https://supabase.com/docs/reference/javascript/insert). +This functionality is based on the Supabase Client SDK insert method. For reference, see +[Supabase Client SDK – Insert data](https://supabase.com/docs/reference/javascript/insert). ## Inputs
-| Data | Type | Description | -| -------------------------------------------- | ---- | --------------------------------- | -| Table Name | enum | List of all the available tables. | +| Data | Type | Description | +| -------------------------------------------- | ---- | ----------- | +| Table Name | enum | The table where the new record will be created. |
-Under the group "Data" all the table fields will be, and are designed to both be exist dynamically in the property panel (for supported types) and by making a connection. +Under the **Data** group, all available fields for the selected table are exposed. These fields can be set directly in the property panel for supported types or populated dynamically through node connections. ## Outputs @@ -30,15 +35,15 @@ Under the group "Data" all the table fields will be, and are designed to both be | Data | Type | Description | | --------------------------------------------- | ------- | ----------- | -| Object ID | string | | -| Success | signal | | -| Failure | signal | | -| Finally | signal | | -| Is Fetching | boolean | | -| Is Fetched | boolean | | -| Status | string | | -| Is Success | boolean | | -| Is Error | boolean | | -| Error Text | string | | - - +| Object ID | string | Internal identifier for this insert operation. | +| Success | signal | Triggered when the record is successfully created. | +| Failure | signal | Triggered if the insert operation fails. | +| Finally | signal | Triggered after the operation completes, regardless of outcome. | +| Is Fetching | boolean | True while the insert request is in progress. | +| Is Fetched | boolean | True once the request has completed. | +| Status | string | Status returned from the insert operation. | +| Is Success | boolean | True if the record was created successfully. | +| Is Error | boolean | True if an error occurred. | +| Error Text | string | Error message returned by Supabase, if any. | + + \ No newline at end of file diff --git a/library/modules/supabase/nodes/edge-functions/call-edge-function.md b/library/modules/supabase/nodes/edge-functions/call-edge-function.md index a2fc72d..f50557e 100644 --- a/library/modules/supabase/nodes/edge-functions/call-edge-function.md +++ b/library/modules/supabase/nodes/edge-functions/call-edge-function.md @@ -2,15 +2,18 @@ hide_title: true --- -{/*##head##*/} - # Call Edge Function +
+Calls a specific Supabase Edge Function by name and sends an optional request body. -The Call Edge Function node calls a specific Supabase Edge Function. You provide the unique function name, and the request body. +
+ ![Call Edge Function node](../../fs-sb-call-function.png) +
-{/*##head##*/} +The Call Edge Function node invokes a Supabase Edge Function deployed in your Supabase project. Provide the function name and an optional payload, and Fluxscape will execute the request and return the response object. -This is based on the [Supabase Client SDK - Invokes a Supabase Edge Function](https://supabase.com/docs/reference/javascript/functions-invoke). +This node is based on the Supabase Client SDK invoke method. For reference, see +[Supabase Client SDK – Invokes a Supabase Edge Function](https://supabase.com/docs/reference/javascript/functions-invoke). ## Inputs @@ -18,44 +21,23 @@ This is based on the [Supabase Client SDK - Invokes a Supabase Edge Function](ht | Data | Type | Description | | ----------------------------------------------- | ---------- | ----------- | -| Function Name | string | | -| Options | javascript | | +| Function Name | string | The name of the Edge Function to invoke (without a URL). | +| Options | javascript | A script that returns an options object for the request. | -Similar to how the Function node works, you can use `Inputs.Value` inside the Options script to create a custom request. +Similar to how other scriptable nodes work, you can use `Inputs.Value` inside the Options script to build a dynamic request. ### Options ```js -// Write your query script here, check out the reference documentation for examples +// Return an options object for the Edge Function invocation. +// Examples: headers, method, responseType, body, etc. return { // headers: { - // "my-custom-header": 'my-custom-header-value', + // "my-custom-header": "my-custom-header-value", // }, - // method: 'POST', - // responseType: 'text', + // method: "POST", + // responseType: "text", body: JSON.stringify(Inputs.Data), -}; -``` - -## Outputs - -> The response you get back is a pure object, and will not be converted to a Noodl Object. - -
- -| Data | Type | Description | -| --------------------------------------------- | ------- | ----------- | -| Object ID | string | | -| Success | signal | | -| Failure | signal | | -| Finally | signal | | -| Is Fetching | boolean | | -| Is Fetched | boolean | | -| Status | string | | -| Is Success | boolean | | -| Is Error | boolean | | -| Error Text | string | | - -
+}; \ No newline at end of file diff --git a/library/modules/supabase/nodes/events/create-record.md b/library/modules/supabase/nodes/events/create-record.md index afdb121..f665270 100644 --- a/library/modules/supabase/nodes/events/create-record.md +++ b/library/modules/supabase/nodes/events/create-record.md @@ -2,23 +2,27 @@ hide_title: true --- -{/*##head##*/} - # Supabase Client Event Create Record +
+Emits a signal when a record is created by the client in Supabase. + +
+ ![Supabase Client Event Create Record node](../../fs-sb-client-create-record.png) +
-This node is used to receive a signal when a Supabase record is created by the client. Similiar to the [Receive Event node](/nodes/events/receive-event), just the Send Event node is built into the Create Record node. +This node listens for record creation events triggered by client-side actions in Supabase. It allows your app to react immediately when new data is created, such as updating UI state, triggering workflows, or chaining additional logic. -{/*##head##*/} +It works similarly to the [Receive Event node](/nodes/events/receive-event), but in this case the event emission is built directly into the Create Record flow, removing the need for a separate Send Event node. ## Inputs
-| Data | Type | Description | -| ------------------------------------------------ | ------- | ----------------------------------------------------------------------------------- | -| Enable | boolean | Allow filtering on a specific table events, otherwise this will receive all events. | -| Table Name | string | Visible when "Enable" is true. | -| Data Object ID | string | | +| Data | Type | Description | +| ------------------------------------------------ | ------- | ----------- | +| Enable | boolean | Enables filtering by a specific table. When disabled, events from all tables are received. | +| Table Name | string | The table to listen to. Only visible when **Enable** is true. | +| Data Object ID | string | Optional identifier used to scope or correlate the event. |
@@ -28,8 +32,8 @@ This node is used to receive a signal when a Supabase record is created by the c | Data | Type | Description | | -------------------------------------------- | ------ | ----------- | -| On | signal | | -| Table Name | string | | -| Record ID | string | | +| On | signal | Triggered when a matching record creation event is received. | +| Table Name | string | The name of the table where the record was created. | +| Record ID | string | The identifier of the newly created record. | - + \ No newline at end of file diff --git a/library/modules/supabase/nodes/events/delete-records.md b/library/modules/supabase/nodes/events/delete-records.md index 0af7c2d..d12bf1d 100644 --- a/library/modules/supabase/nodes/events/delete-records.md +++ b/library/modules/supabase/nodes/events/delete-records.md @@ -2,22 +2,26 @@ hide_title: true --- -{/*##head##*/} - # Supabase Client Event Delete Records +
+Emits a signal when one or more records are deleted by the client in Supabase. + +
+ ![Supabase Client Event Delete Records node](../../fs-sb-client-delete-record.png) +
-This node is used to receive a signal when a Supabase record is deleted by the client. Similiar to the [Receive Event node](/nodes/events/receive-event), just the Send Event node is built into the Delete Records node. +This node listens for record deletion events triggered by client-side actions in Supabase. It allows your app to react immediately when records are removed, such as updating lists, refreshing views, or triggering follow-up workflows. -{/*##head##*/} +It works similarly to the [Receive Event node](/nodes/events/receive-event), but in this case the event emission is built directly into the Delete Records flow, removing the need for a separate Send Event node. ## Inputs
-| Data | Type | Description | -| -------------------------------------------- | ------- | ----------------------------------------------------------------------------------- | -| Enable | boolean | Allow filtering on a specific table events, otherwise this will receive all events. | -| Table Name | string | Visible when "Enable" is true. | +| Data | Type | Description | +| -------------------------------------------- | ------- | ----------- | +| Enable | boolean | Enables filtering by a specific table. When disabled, events from all tables are received. | +| Table Name | string | The table to listen to. Only visible when **Enable** is true. |
@@ -27,7 +31,7 @@ This node is used to receive a signal when a Supabase record is deleted by the c | Data | Type | Description | | -------------------------------------------- | ------ | ----------- | -| On | signal | | -| Table Name | string | | +| On | signal | Triggered when a matching record deletion event is received. | +| Table Name | string | The name of the table where records were deleted. | - + \ No newline at end of file diff --git a/library/modules/supabase/nodes/events/update-records.md b/library/modules/supabase/nodes/events/update-records.md index 4f74489..ac3a781 100644 --- a/library/modules/supabase/nodes/events/update-records.md +++ b/library/modules/supabase/nodes/events/update-records.md @@ -2,23 +2,27 @@ hide_title: true --- -{/*##head##*/} - # Supabase Client Event Update Records +
+Emits a signal when one or more records are updated by the client in Supabase. + +
+ ![Supabase Client Event Update Records node](../../fs-sb-client-update-record.png) +
-This node is used to receive a signal when a Supabase record is updated by the client. Similiar to the [Receive Event node](/nodes/events/receive-event), just the Send Event node is built into the Update Records node. +This node listens for record update events triggered by client-side actions in Supabase. It allows your app to react immediately when existing data changes, such as refreshing views, recalculating derived state, or triggering follow-up workflows. -{/*##head##*/} +It works similarly to the [Receive Event node](/nodes/events/receive-event), but in this case the event emission is built directly into the Update Records flow, removing the need for a separate Send Event node. ## Inputs
-| Data | Type | Description | -| ------------------------------------------------ | ------- | ----------------------------------------------------------------------------------- | -| Enable | boolean | Allow filtering on a specific table events, otherwise this will receive all events. | -| Table Name | string | Visible when "Enable" is true. | -| Data Object ID | string | | +| Data | Type | Description | +| ------------------------------------------------ | ------- | ----------- | +| Enable | boolean | Enables filtering by a specific table. When disabled, events from all tables are received. | +| Table Name | string | The table to listen to. Only visible when **Enable** is true. | +| Data Object ID | string | Optional identifier used to scope or correlate the event. |
@@ -28,7 +32,7 @@ This node is used to receive a signal when a Supabase record is updated by the c | Data | Type | Description | | -------------------------------------------- | ------ | ----------- | -| On | signal | | -| Table Name | string | | +| On | signal | Triggered when a matching record update event is received. | +| Table Name | string | The name of the table where records were updated. | - + \ No newline at end of file diff --git a/library/modules/supabase/nodes/realtime/broadcast-message.md b/library/modules/supabase/nodes/realtime/broadcast-message.md index 1b2b169..4f0cbb4 100644 --- a/library/modules/supabase/nodes/realtime/broadcast-message.md +++ b/library/modules/supabase/nodes/realtime/broadcast-message.md @@ -2,10 +2,17 @@ hide_title: true --- -{/*##head##*/} - # Supabase Realtime Broadcast Message +
+Broadcasts a message to a Supabase Realtime channel so other connected clients can react immediately. + +
+ ![Realtime Broadcast Message node](../../fs-sb-call-broadcast-realtime.png) +
+ +The Supabase Realtime Broadcast Message node sends an event payload to a Supabase Realtime channel using broadcast messaging. This is useful for lightweight real-time signaling between connected clients, such as notifying other users that something has changed, triggering UI updates, or coordinating collaborative interactions. -{/*##head##*/} +Broadcast messages are ephemeral and are not persisted in the database. Only clients that are actively subscribed to the channel at the time of sending will receive the message. If you require persistence or guaranteed processing, consider using database changes or Edge Functions instead. -This is based on the [Supabase Client SDK - Broadcast a message](https://supabase.com/docs/reference/javascript/broadcastmessage). +This functionality is based on the Supabase Client SDK broadcast message method. For reference, see +[Supabase Client SDK – Broadcast a message](https://supabase.com/docs/reference/javascript/broadcastmessage). \ No newline at end of file diff --git a/library/modules/supabase/nodes/realtime/set-presence.md b/library/modules/supabase/nodes/realtime/set-presence.md index 16f30e9..4a8babc 100644 --- a/library/modules/supabase/nodes/realtime/set-presence.md +++ b/library/modules/supabase/nodes/realtime/set-presence.md @@ -2,8 +2,19 @@ hide_title: true --- -{/*##head##*/} - # Supabase Realtime Set Presence +
+Sets the presence state for the current user on a Supabase Realtime channel. + +
+ ![Realtime Set Presence node](../../fs-sb-set-presence.png) +
+ +The Supabase Realtime Set Presence node updates the presence information for the currently authenticated user on a specified Realtime channel. Presence data is commonly used to track which users are online, active, or participating in a shared context such as a room, document, or collaborative session. + +Presence state is ephemeral and exists only while the client is connected to the channel. When a user disconnects or leaves the channel, their presence is automatically removed. This makes it suitable for real-time indicators such as online users, cursors, activity status, or collaboration awareness. + +This functionality is based on the Supabase Realtime presence API. Presence updates are broadcast to all clients subscribed to the same channel, allowing UIs to stay in sync as users join, update their state, or leave. -{/*##head##*/} +For reference, see +[Supabase Realtime – Presence](https://supabase.com/docs/guides/realtime/presence). \ No newline at end of file diff --git a/library/modules/supabase/nodes/realtime/subscribe-to-channel.md b/library/modules/supabase/nodes/realtime/subscribe-to-channel.md index fb48c33..3f52579 100644 --- a/library/modules/supabase/nodes/realtime/subscribe-to-channel.md +++ b/library/modules/supabase/nodes/realtime/subscribe-to-channel.md @@ -2,10 +2,18 @@ hide_title: true --- -{/*##head##*/} - # Supabase Realtime Subscribe To Channel +
+Subscribes the client to a Supabase Realtime channel to receive real-time events. + +
+ ![Realtime Subscribe To Channel node](../../fs-sb-subscribe-channel.png) +
+ +The Supabase Realtime Subscribe To Channel node connects the client to a specified Realtime channel. Once subscribed, the client can receive broadcast messages, presence updates, and other real-time events published on that channel. + +This node is typically used as the entry point for real-time features such as live updates, collaborative experiences, activity feeds, or presence-aware interfaces. It is commonly paired with nodes like **Broadcast Message** and **Set Presence** to build complete real-time workflows. -{/*##head##*/} +Subscriptions are active as long as the client remains connected. When the client disconnects or unsubscribes, it will stop receiving events from the channel. -This is based on the [Supabase Client SDK - Subscribe to channel](https://supabase.com/docs/reference/javascript/subscribe). +This functionality is based on the Supabase Client SDK channel subscription method. For reference, see [Supabase Client SDK – Subscribe to channel](https://supabase.com/docs/reference/javascript/subscribe). \ No newline at end of file diff --git a/library/modules/supabase/nodes/storage/delete-files.md b/library/modules/supabase/nodes/storage/delete-files.md index 91a15fc..7646d55 100644 --- a/library/modules/supabase/nodes/storage/delete-files.md +++ b/library/modules/supabase/nodes/storage/delete-files.md @@ -2,23 +2,30 @@ hide_title: true --- -{/*##head##*/} - # Supabase Delete Files +
+Deletes one or more files from a Supabase Storage bucket. + +
+ ![Supabase Delete Files node](../../fs-sb-delete-files.png) +
-{/*##head##*/} +This node removes files from the specified Supabase Storage bucket based on the provided file paths. It is commonly used for cleanup operations, user-initiated file removal, or managing stored assets within an application. -This is based on the [Supabase Client SDK - Delete files in a bucket](https://supabase.com/docs/reference/javascript/storage-from-remove). +Delete operations respect Supabase Storage access policies and the authentication context of the current user. + +This functionality is based on the Supabase Client SDK method for deleting files from a bucket. For reference, see +[Supabase Client SDK – Delete files in a bucket](https://supabase.com/docs/reference/javascript/storage-from-remove). ## Inputs
-| Data | Type | Description | -| ------------------------------------------------- | ------------- | ----------- | -| Delete | signal | | -| Bucket | string | | -| Paths to Delete | array of string | | +| Data | Type | Description | +| ------------------------------------------------- | --------------- | ----------- | +| Delete | signal | Triggers the delete operation. | +| Bucket | string | The Storage bucket name. | +| Paths to Delete | array of string | One or more file paths to remove from the bucket. |
@@ -26,17 +33,17 @@ This is based on the [Supabase Client SDK - Delete files in a bucket](https://su
-| Data | Type | Description | -| ----------------------------------------------- | ------------- | ----------- | -| Deleted Paths | array of string | | -| Is Deleting | boolean | | -| Is Deleted | boolean | | -| Status | string | | -| Is Success | boolean | | -| Is Error | boolean | | -| Error Text | string | | -| Success | signal | | -| Failure | signal | | -| Finally | signal | | - -
+| Data | Type | Description | +| ----------------------------------------------- | --------------- | ----------- | +| Deleted Paths | array of string | The file paths that were successfully deleted. | +| Is Deleting | boolean | True while the delete operation is in progress. | +| Is Deleted | boolean | True once the delete operation has completed. | +| Status | string | Status returned from the delete operation. | +| Is Success | boolean | True if the files were deleted successfully. | +| Is Error | boolean | True if an error occurred. | +| Error Text | string | Error message returned by Supabase, if any. | +| Success | signal | Triggered when the operation completes successfully. | +| Failure | signal | Triggered if the operation fails. | +| Finally | signal | Triggered after the operation completes, regardless of outcome. | + + \ No newline at end of file diff --git a/library/modules/supabase/nodes/storage/download-file.md b/library/modules/supabase/nodes/storage/download-file.md index c4c6002..45984bf 100644 --- a/library/modules/supabase/nodes/storage/download-file.md +++ b/library/modules/supabase/nodes/storage/download-file.md @@ -2,13 +2,20 @@ hide_title: true --- -{/*##head##*/} - # Download File +
+Downloads a file from a Supabase Storage bucket. + +
+ ![Supabase Download File node](../../fs-sb-download-file.png) +
-{/*##head##*/} +This node retrieves a file stored in Supabase Storage and makes its contents available to the app. It can be used to download assets such as images, documents, or data files for display, processing, or client-side handling. -This is based on the [Supabase Client SDK - Download a file](https://supabase.com/docs/reference/javascript/storage-from-download). +The downloaded file can be accessed in multiple formats depending on your use case, including a raw Blob, text, or an ArrayBuffer. + +This functionality is based on the Supabase Client SDK method for downloading files from Storage. For reference, see +[Supabase Client SDK – Download a file](https://supabase.com/docs/reference/javascript/storage-from-download). ## Inputs @@ -16,9 +23,9 @@ This is based on the [Supabase Client SDK - Download a file](https://supabase.co | Data | Type | Description | | ------------------------------------------------------ | ------ | ----------- | -| Download | signal | | -| Bucket | string | | -| Path (within bucket) | string | | +| Download | signal | Triggers the download operation. | +| Bucket | string | The Storage bucket name. | +| Path (within bucket) | string | The file path inside the bucket. | @@ -28,17 +35,17 @@ This is based on the [Supabase Client SDK - Download a file](https://supabase.co | Data | Type | Description | | --------------------------------------------------- | ------- | ----------- | -| File Blob | \* | | -| File Text | string | | -| File Array Buffer | \* | | -| Is Downloading | boolean | | -| Is Downloaded | boolean | | -| Status | string | | -| Is Success | boolean | | -| Is Error | boolean | | -| Error Text | string | | -| Success | signal | | -| Failure | signal | | -| Finally | signal | | - - +| File Blob | * | The downloaded file as a binary Blob. | +| File Text | string | The file contents as text, when applicable. | +| File Array Buffer | * | The file contents as an ArrayBuffer. | +| Is Downloading | boolean | True while the download is in progress. | +| Is Downloaded | boolean | True once the download has completed. | +| Status | string | Status returned from the download operation. | +| Is Success | boolean | True if the file was downloaded successfully. | +| Is Error | boolean | True if an error occurred. | +| Error Text | string | Error message returned by Supabase, if any. | +| Success | signal | Triggered when the operation completes successfully. | +| Failure | signal | Triggered if the operation fails. | +| Finally | signal | Triggered after the operation completes, regardless of outcome. | + + \ No newline at end of file diff --git a/library/modules/supabase/nodes/storage/retrieve-public-file-urls.md b/library/modules/supabase/nodes/storage/retrieve-public-file-urls.md index 907061e..a730827 100644 --- a/library/modules/supabase/nodes/storage/retrieve-public-file-urls.md +++ b/library/modules/supabase/nodes/storage/retrieve-public-file-urls.md @@ -2,13 +2,18 @@ hide_title: true --- -{/*##head##*/} - # Supabase Retrieve Public File URLs +
+Generates public URLs for one or more files stored in a Supabase Storage bucket. + +
+ ![Supabase Retrieve Public File URLs node](../../fs-sb-retrieve-public-file-url.png) +
+This node is useful when you want to display images, link to documents, or render media that is stored in Supabase Storage. The result is a list of URLs corresponding to the provided file paths. -{/*##head##*/} +Depending on your bucket configuration, the generated URLs may be publicly accessible or time-limited. Expiration can be configured to control how long the URLs remain valid. -This is based on the [Supabase Client SDK - Retrieve public URL](https://supabase.com/docs/reference/javascript/storage-from-getpublicurl). +This functionality is based on the Supabase Client SDK method for retrieving a public URL. For reference, see [Supabase Client SDK – Retrieve public URL](https://supabase.com/docs/reference/javascript/storage-from-getpublicurl). ## Inputs @@ -16,10 +21,10 @@ This is based on the [Supabase Client SDK - Retrieve public URL](https://supabas | Data | Type | Description | | ---------------------------------------------------------- | --------------- | ----------- | -| Fetch | signal | | -| Bucket | string | | -| Paths (array of strings) | array of string | | -| Expires In (seconds) | number | | +| Fetch | signal | Triggers the URL generation. | +| Bucket | string | The Storage bucket name. | +| Paths (array of strings) | array of string | One or more file paths inside the bucket. | +| Expires In (seconds) | number | Optional. Used when generating time-limited URLs. | @@ -29,15 +34,15 @@ This is based on the [Supabase Client SDK - Retrieve public URL](https://supabas | Data | Type | Description | | --------------------------------------------- | --------------- | ----------- | -| Signed URLs | array of string | | -| Is Fetching | boolean | | -| Is Fetched | boolean | | -| Is Success | boolean | | -| Is Error | boolean | | -| Status | string | | -| Error Text | string | | -| Success | signal | | -| Failure | signal | | -| Finally | signal | | - - +| Signed URLs | array of string | The resulting URLs, in the same order as the input paths. | +| Is Fetching | boolean | True while the request is in progress. | +| Is Fetched | boolean | True once the request has completed. | +| Is Success | boolean | True if URLs were generated successfully. | +| Is Error | boolean | True if an error occurred. | +| Status | string | Status returned from the operation. | +| Error Text | string | Error message returned by Supabase, if any. | +| Success | signal | Triggered when the operation completes successfully. | +| Failure | signal | Triggered if the operation fails. | +| Finally | signal | Triggered after the operation completes, regardless of outcome. | + + \ No newline at end of file diff --git a/library/modules/supabase/nodes/storage/upload-file-resumable.md b/library/modules/supabase/nodes/storage/upload-file-resumable.md index e473f11..75a73ed 100644 --- a/library/modules/supabase/nodes/storage/upload-file-resumable.md +++ b/library/modules/supabase/nodes/storage/upload-file-resumable.md @@ -2,13 +2,20 @@ hide_title: true --- -{/*##head##*/} - # Supabase Upload File (Resumable) +
+Uploads a file to Supabase Storage using resumable upload support. + +
+ ![Supabase Upload File (Resumable) node](../../fs-sb-resumable-upload.png) +
-{/*##head##*/} +This node allows you to upload large files reliably to Supabase Storage. Resumable uploads make it possible to pause, resume, or cancel an upload, which is especially useful for unstable network conditions or large file transfers. -This is based on the [Resumable Uploads](https://supabase.com/docs/guides/storage/uploads/resumable-uploads). +The upload is performed against a specified Storage bucket and path. When enabled, upsert allows an existing file at the same path to be overwritten. + +This functionality is based on Supabase’s resumable upload support. For reference, see +[Supabase – Resumable Uploads](https://supabase.com/docs/guides/storage/uploads/resumable-uploads). ## Inputs @@ -16,14 +23,14 @@ This is based on the [Resumable Uploads](https://supabase.com/docs/guides/storag | Data | Type | Description | | ------------------------------------------------------ | ----------- | ----------- | -| Upload | signal | | -| Bucket | string | | -| Path (within bucket) | string | | -| Upsert | boolean | | -| File | Blob / File | | -| Pause Upload | signal | | -| Resume Upload | signal | | -| Cancel Upload | signal | | +| Upload | signal | Starts the upload process. | +| Bucket | string | The Storage bucket name. | +| Path (within bucket) | string | The destination file path inside the bucket. | +| Upsert | boolean | Whether to overwrite an existing file at the same path. | +| File | Blob / File | The file or blob to upload. | +| Pause Upload | signal | Pauses an ongoing upload. | +| Resume Upload | signal | Resumes a paused upload. | +| Cancel Upload | signal | Cancels the upload operation. | @@ -31,18 +38,18 @@ This is based on the [Resumable Uploads](https://supabase.com/docs/guides/storag
-| Data | Type | Description | -| ------------------------------------------------- | ------- | --------------------------------------------- | -| Upload Progress | number | | -| Public Url | string | | -| Is Uploading | boolean | | -| Is Uploaded | boolean | | -| Status | string | "idle" or "uploading" or "success" or "error" | -| Is Success | boolean | | -| Is Error | boolean | | -| Error Text | string | | -| Success | signal | | -| Failure | signal | | -| Finally | signal | | - -
+| Data | Type | Description | +| ------------------------------------------------- | ------- | ----------- | +| Upload Progress | number | Upload progress as a percentage value. | +| Public Url | string | Public URL of the uploaded file, if applicable. | +| Is Uploading | boolean | True while the upload is in progress. | +| Is Uploaded | boolean | True once the upload has completed successfully. | +| Status | string | Current upload status: `idle`, `uploading`, `success`, or `error`. | +| Is Success | boolean | True if the upload completed successfully. | +| Is Error | boolean | True if an error occurred. | +| Error Text | string | Error message returned by Supabase, if any. | +| Success | signal | Triggered when the upload completes successfully. | +| Failure | signal | Triggered if the upload fails. | +| Finally | signal | Triggered after the upload completes, regardless of outcome. | + + \ No newline at end of file diff --git a/library/modules/supabase/nodes/storage/upload-file.md b/library/modules/supabase/nodes/storage/upload-file.md index 8911df3..34218f1 100644 --- a/library/modules/supabase/nodes/storage/upload-file.md +++ b/library/modules/supabase/nodes/storage/upload-file.md @@ -2,15 +2,20 @@ hide_title: true --- -{/*##head##*/} - # Supabase Upload File +
+Uploads a file to an existing Supabase Storage bucket. + +
+ ![Supabase Upload File node](../../fs-sb-upload-file.png) +
-Uploads a file to an existing bucket. +This node uploads a file directly to Supabase Storage at the specified bucket and path. It is best suited for smaller files or situations where resumable uploads are not required. -{/*##head##*/} +When enabled, the upsert option allows an existing file at the same path to be overwritten. Upload operations respect Supabase Storage access policies and are executed in the context of the current user. -This is based on the [Supabase Client SDK - Upload a file](https://supabase.com/docs/reference/javascript/storage-from-upload). +This functionality is based on the Supabase Client SDK upload method. For reference, see +[Supabase Client SDK – Upload a file](https://supabase.com/docs/reference/javascript/storage-from-upload). ## Inputs @@ -18,11 +23,11 @@ This is based on the [Supabase Client SDK - Upload a file](https://supabase.com/ | Data | Type | Description | | ------------------------------------------------------ | ----------- | ----------- | -| Upload | signal | | -| Bucket | string | | -| Path (within bucket) | string | | -| Upsert | boolean | | -| File | Blob / File | | +| Upload | signal | Triggers the upload operation. | +| Bucket | string | The Storage bucket name. | +| Path (within bucket) | string | The destination file path inside the bucket. | +| Upsert | boolean | Whether to overwrite an existing file at the same path. | +| File | Blob / File | The file or blob to upload. | @@ -30,20 +35,20 @@ This is based on the [Supabase Client SDK - Upload a file](https://supabase.com/
-| Data | Type | Description | -| ------------------------------------------------ | ------- | --------------------------------------------- | -| File ID | string | | -| File Path | string | | -| File Full Path | string | | -| Public Url | string | | -| Is Uploading | boolean | | -| Is Uploaded | boolean | | -| Status | string | "idle" or "uploading" or "success" or "error" | -| Is Success | boolean | | -| Is Error | boolean | | -| Error Text | string | | -| Success | signal | | -| Failure | signal | | -| Finally | signal | | - -
+| Data | Type | Description | +| ------------------------------------------------ | ------- | ----------- | +| File ID | string | Identifier returned for the uploaded file, if available. | +| File Path | string | The file path within the bucket. | +| File Full Path | string | The full resolved path to the uploaded file. | +| Public Url | string | Public URL of the uploaded file, if applicable. | +| Is Uploading | boolean | True while the upload is in progress. | +| Is Uploaded | boolean | True once the upload has completed successfully. | +| Status | string | Current upload status: `idle`, `uploading`, `success`, or `error`. | +| Is Success | boolean | True if the upload completed successfully. | +| Is Error | boolean | True if an error occurred. | +| Error Text | string | Error message returned by Supabase, if any. | +| Success | signal | Triggered when the upload completes successfully. | +| Failure | signal | Triggered if the upload fails. | +| Finally | signal | Triggered after the upload completes, regardless of outcome. | + + \ No newline at end of file diff --git a/library/modules/supabase/release-notes.md b/library/modules/supabase/release-notes.md index 9b27463..576e4e8 100644 --- a/library/modules/supabase/release-notes.md +++ b/library/modules/supabase/release-notes.md @@ -3,6 +3,7 @@ title: Release Notes hide_title: true --- -# Release Notes +# Release Notes - TBA Version 1.0 [yyyy-mm-dd] +