@firecms/collection_editor 3.0.1 → 3.1.0-canary.9e89e98

package/dist/ConfigControllerProvider.d.ts

@@ -4,6 +4,7 @@ import { User } from "@firecms/core";
 import { CollectionEditorController } from "./types/collection_editor_controller";
 import { CollectionEditorPermissionsBuilder } from "./types/config_permissions";
 import { CollectionInference } from "./types/collection_inference";
+import { CollectionGenerationCallback } from "./api/generateCollectionApi";
 export declare const ConfigControllerContext: React.Context<CollectionsConfigController>;
 export declare const CollectionEditorContext: React.Context<CollectionEditorController>;
 export interface ConfigControllerProviderProps {
@@ -33,5 +34,10 @@ export interface ConfigControllerProviderProps {
     getUser?: (uid: string) => User | null;
     getData?: (path: string, parentPaths: string[]) => Promise<object[]>;
     onAnalyticsEvent?: (event: string, params?: object) => void;
+    /**
+     * Callback function for generating/modifying collections.
+     * The plugin is API-agnostic - the consumer provides the implementation.
+     */
+    generateCollection?: CollectionGenerationCallback;
 }
 export declare const ConfigControllerProvider: React.NamedExoticComponent<React.PropsWithChildren<ConfigControllerProviderProps>>;

package/dist/api/generateCollectionApi.d.ts

@@ -0,0 +1,71 @@
+import { EntityCollection } from "@firecms/core";
+export interface GenerateCollectionRequest {
+    /** User's natural language description of what they want */
+    prompt: string;
+    /** Other collections in the project (for context/relationships). Limit to 30. */
+    existingCollections: Partial<EntityCollection>[];
+    /** Optional for generate, required for modifications. If provided, modifies this collection */
+    existingCollection?: Partial<EntityCollection>;
+}
+/** Operation types for modifying a collection */
+export type CollectionOperationType = "add" | "modify" | "delete";
+/** A single operation describing what changed */
+export interface CollectionOperation {
+    op: CollectionOperationType;
+    path: string;
+    value?: any;
+}
+/** Result from collection generation, including optional delta operations */
+export interface GenerateCollectionResult {
+    collection: EntityCollection;
+    operations?: CollectionOperation[];
+}
+/**
+ * Callback type for generating or modifying a collection.
+ * The plugin is API-agnostic - consumers implement the actual API call.
+ */
+export type CollectionGenerationCallback = (request: GenerateCollectionRequest) => Promise<GenerateCollectionResult>;
+export declare class CollectionGenerationApiError extends Error {
+    code?: string;
+    constructor(message: string, code?: string);
+}
+/**
+ * Default endpoint for AI collection generation
+ */
+export declare const DEFAULT_COLLECTION_GENERATION_ENDPOINT = "https://api.firecms.co/collections/generate";
+/**
+ * Props for building a collection generation callback
+ */
+export interface BuildCollectionGenerationCallbackProps {
+    /**
+     * Function to get the auth token (e.g., from Firebase Auth)
+     * This is typically `authController.getAuthToken` from `@firecms/firebase`
+     */
+    getAuthToken: () => Promise<string>;
+    /**
+     * Optional custom API endpoint for collection generation.
+     * Defaults to the FireCMS SaaS API endpoint.
+     */
+    apiEndpoint?: string;
+}
+/**
+ * Build a callback for AI collection generation.
+ * This helper allows self-hosted FireCMS users to enable the AI collection
+ * generation feature.
+ *
+ * @example
+ * ```typescript
+ * import { useCollectionEditorPlugin, buildCollectionGenerationCallback } from "@firecms/collection_editor";
+ * import { useFirebaseAuthController } from "@firecms/firebase";
+ *
+ * const authController = useFirebaseAuthController({ firebaseApp });
+ *
+ * const collectionEditorPlugin = useCollectionEditorPlugin({
+ *     // ... other props
+ *     generateCollection: buildCollectionGenerationCallback({
+ *         getAuthToken: authController.getAuthToken
+ *     })
+ * });
+ * ```
+ */
+export declare function buildCollectionGenerationCallback({ getAuthToken, apiEndpoint }: BuildCollectionGenerationCallbackProps): CollectionGenerationCallback;

package/dist/api/index.d.ts

@@ -0,0 +1 @@
+export * from "./generateCollectionApi";

package/dist/index.d.ts

@@ -3,10 +3,14 @@ export { useCollectionEditorController } from "./useCollectionEditorController";
 export { useCollectionsConfigController } from "./useCollectionsConfigController";
 export { editableProperty, removeNonEditableProperties } from "./utils/entities";
 export * from "./utils/collections";
-export type { CollectionsConfigController, DeleteCollectionParams, SaveCollectionParams, UpdateCollectionParams, CollectionsSetupInfo } from "./types/config_controller";
+export { validateCollectionJson, type CollectionValidationError, type CollectionValidationResult } from "./utils/validateCollectionJson";
+export type { CollectionsConfigController, DeleteCollectionParams, SaveCollectionParams, UpdateCollectionParams, CollectionsSetupInfo, UpdatePropertiesOrderParams, UpdateKanbanColumnsOrderParams } from "./types/config_controller";
 export type { CollectionEditorController } from "./types/collection_editor_controller";
 export type { CollectionEditorPermissions, CollectionEditorPermissionsBuilder } from "./types/config_permissions";
 export type { PersistedCollection } from "./types/persisted_collection";
 export type { CollectionInference } from "./types/collection_inference";
+export { buildCollectionGenerationCallback, CollectionGenerationApiError, DEFAULT_COLLECTION_GENERATION_ENDPOINT } from "./api/generateCollectionApi";
+export type { CollectionGenerationCallback, GenerateCollectionRequest, GenerateCollectionResult, CollectionOperation, CollectionOperationType, BuildCollectionGenerationCallbackProps } from "./api/generateCollectionApi";
 export { MissingReferenceWidget } from "./ui/MissingReferenceWidget";
 export * from "./ui/collection_editor/util";
+export { PropertyForm, PropertyFormDialog, type PropertyFormProps, type OnPropertyChangedParams } from "./ui/collection_editor/PropertyEditView";