@rebasepro/studio 0.0.1-canary.09e5ec5

package/LICENSE

@@ -0,0 +1,114 @@
+Business Source License 1.1
+
+Parameters
+
+Licensor:             Rebase S.L.
+Licensed Work:        Rebase CMS packages:
+                      cli
+                      collection_editor
+                      collection_editor_firebase
+                      data_enhancement
+                      data_export
+                      data_export
+                      editor
+                      rebase_cloud
+                      schema_inference
+                      user_management
+
+                      The Licensed Work is (c) 2024 Rebase S.L
+Additional Use Grant: You may make use of the Licensed Work, provided that
+                      you may not use the Licensed Work for a CMS Data Enhancement
+                      Service.
+
+                      A “CMS package” is a commercial offering that
+                      allows third parties (other than your employees and
+                      contractors) to access the functionality of the
+                      Licensed Work by using software to extend the base features of
+                      content management system controlled by such third parties.
+
+Change Date:         Four years from the date the Licensed Work is published.
+
+Change License:      MIT
+
+For information about alternative licensing arrangements for the Software,
+please visit: https://rebase.pro
+
+Notice
+
+The Business Source License (this document, or the “License”) is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+“Business Source License” is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark “Business Source License”,
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.

package/README.md

@@ -0,0 +1,159 @@
+# Rebase Collection Editor Plugin
+
+This plugin enables creating and managing Firestore collections directly from your Rebase interface. It adds a visual
+collection editor that allows you to create, edit, and delete collections without writing code.
+
+## Installation
+
+```bash
+npm install @rebasepro/collection_editor
+# or
+yarn add @rebasepro/collection_editor
+```
+
+For Firebase integration, also install:
+
+```bash
+npm install @rebasepro/collection_editor_firebase
+# or
+yarn add @rebasepro/collection_editor_firebase
+```
+
+## Features
+
+- Create and edit collections through a visual interface
+- Define properties, validations, and display options
+- Organize collections with groups and subcollections
+- Merge UI-defined collections with code-defined collections
+- Persist collection configurations in Firestore
+- Control permissions for collection editing operations
+
+## Basic Usage
+
+```tsx
+import React from "react";
+import { RebaseCMS } from "@rebasepro/admin";
+import { useFirestoreCollectionsConfigController } from "@rebasepro/collection_editor_firebase";
+
+export default function App() {
+    // Controller to save collection configs in Firestore
+    const collectionConfigController = useFirestoreCollectionsConfigController({
+        firebaseApp
+    });
+    
+    return <RebaseCMS
+        name={"My CMS"}
+        authentication={myAuthenticator}
+        firebaseConfig={firebaseConfig}
+        collectionEditor={{
+            collectionConfigController
+        }}
+    />;
+}
+```
+
+## Advanced Configuration
+
+You can customize collection editor behavior with these options using the `collectionEditor` prop on `RebaseCMS`:
+
+```tsx
+<RebaseCMS
+    collectionEditor={{
+        collectionConfigController, // Required: controller that handles persistence
+        
+        // Define permissions for collection operations
+        configPermissions: ({ user }) => ({
+            createCollections: user.roles?.includes("admin") ?? false,
+            editCollections: user.roles?.includes("admin") ?? false,
+            deleteCollections: user.roles?.includes("admin") ?? false
+        }),
+        
+        // Prevent these group names from being used
+        reservedGroups: ["admin", "system"],
+        
+        // Optional custom view to add to the editor
+        extraView: {
+            View: MyCustomView,
+            icon: <CustomIcon />
+        },
+        
+        // Function to infer collection structure from existing data
+        collectionInference: async ({ path }) => {
+            // Return inferred schema based on data at path
+        },
+        
+        // Function to get sample data for a collection
+        getData: async (path, parentPaths) => {
+            // Return sample data for the specified path
+        },
+        
+        // Track collection editor events
+        onAnalyticsEvent: (event, params) => {
+            console.log("Collection editor event:", event, params);
+        },
+        
+        // Include introduction widget when no collections exist
+        includeIntroView: true
+    }}
+/>
+```
+
+## Integration with Code-Defined Collections
+
+You can combine collections defined in code with those created in the UI:
+
+```tsx
+import { mergeCollections } from "@rebasepro/admin/collection_editor";
+
+
+const collectionsBuilder = useCallback(() => {
+    // Collections defined in code
+    const codeCollections = [productsCollection, ordersCollection];
+    
+    // Merge with collections from the editor UI
+    return mergeCollections(codeCollections, collectionConfigController.collections ?? []);
+}, [collectionConfigController.collections]);
+
+const navigationController = useBuildNavigationStateController({
+    collections: collectionsBuilder,
+    // Other options
+});
+```
+
+## Firestore Configuration Controller
+
+To persist collections in Firestore:
+
+```tsx
+const collectionConfigController = useFirestoreCollectionsConfigController({
+    firebaseApp,
+    
+    // Optional: specify where to save configs (default: "__REBASE/config/collections")
+    configPath: "custom/config/path",
+    
+    // Optional: define permissions for collections
+    permissions: ({ user }) => ({
+        // Your permissions logic
+    }),
+    
+    // Optional: custom property configurations
+    propertyConfigs: [
+        // Custom property types
+    ]
+});
+```
+
+## Additional Notes
+
+- Collections created through the editor are stored in Firestore and loaded dynamically
+- The plugin automatically adds UI elements for creating and managing collections
+- For a complete solution, consider using alongside other plugins like data import/export
+
+## Related Plugins
+
+Rebase offers several complementary plugins:
+
+- Data Import: Import data from CSV or JSON into Firestore collections
+- Data Export: Export collection data to CSV or JSON formats
+- Data Enhancement: Generate content using AI for your collections
+- Entity History: Track changes to your collection entities