@firecms/data_import_export 3.0.0-3.0.0-beta.4.pre.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 FireCMS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,87 @@
+## FireCMS Data enhancement plugin
+
+This plugin allows you to enhance data in your [FireCMS](https://firecms.co)
+project, using ChatGPT.
+
+The ChatGPT plugin allows you to use the OpenAI API to generate content using
+the latest GPT models. This plugin is able to understand the structure of your
+data and generate content that fits your schema.
+
+<p align="center">
+    <img src="https://firecms.co/img/data_import.png" width="800px" alt="Data enhancement UI" />
+</p>
+
+In order to be able to use this plugin you need to have a valid subscription.
+
+You can get a subscription in
+the [FireCMS dashboard](https://app.firecms.co/subscriptions).
+
+You need to specify the Firebase project id you would like to use the plugin
+with,
+in the website. And that's it!
+
+No need to add any subscription key or anything like that.
+
+```tsx
+import React from "react";
+import { FirebaseCMSApp } from "@firecms/core";
+import "typeface-rubik";
+import "@fontsource/ibm-plex-mono";
+
+import { useDataImportPlugin } from "@firecms/data_import_export";
+
+// TODO: Replace with your Firebase config
+const firebaseConfig = {
+    apiKey: "",
+    authDomain: "",
+    projectId: "",
+    storageBucket: "",
+    messagingSenderId: "",
+    appId: ""
+};
+
+export default function App() {
+
+    const dataImportPlugin = useDataImportPlugin({
+        // Optional callback for defining which collections should be enhanced
+        getConfigForPath: ({ path }) => {
+            if (path === "books")
+                return true;
+            return false;
+        }
+    });
+
+    return <FirebaseCMSApp
+        name={"My Online Shop"}
+        plugins={[dataImportPlugin]}
+        authentication={myAuthenticator}
+        collections={[
+            //...
+        ]}
+        firebaseConfig={firebaseConfig}
+    />;
+}
+```
+
+## How does it work?
+
+This plugin uses the OpenAI API to generate content using the latest GPT models.
+This plugin is able to understand the structure of your data and generate
+content that fits your schema.
+
+Some tips in order to get the best results:
+
+- Make sure you select the **right data** type for your fields.
+- The **field names** are used to generate the content and are usually enough to
+  generate good results. If you want to get even better results, you can
+  **add a description** to your fields. This will help the plugin understand the
+  context of your data and generate better results.
+- The **collection name** is important as well.
+- You can establish **relations between fields** and the plugin will pick it up.
+  e.g. if you have a field called `author` and another field called `book`, the
+  plugin will understand that the author is related to the book and will
+  generate content accordingly. You can use this for making **summaries, reviews,
+  translations, SEO content**, etc.
+
+## Current limitations
+- Markdown fields work but do not get the enhanced content highlighted.

package/dist/components/DataNewPropertiesMapping.d.ts

@@ -0,0 +1,15 @@
+import { Property } from "@firecms/core";
+export interface DataPropertyMappingProps {
+    idColumn?: string;
+    headersMapping: Record<string, string | null>;
+    originProperties: Record<string, Property>;
+    destinationProperties: Record<string, Property>;
+    onIdPropertyChanged: (value: string | null) => void;
+    buildPropertyView?: (props: {
+        isIdColumn: boolean;
+        property: Property | null;
+        propertyKey: string | null;
+        importKey: string;
+    }) => React.ReactNode;
+}
+export declare function DataNewPropertiesMapping({ idColumn, headersMapping, originProperties, destinationProperties, onIdPropertyChanged, buildPropertyView, }: DataPropertyMappingProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/ImportFileUpload.d.ts

@@ -0,0 +1,3 @@
+export declare function ImportFileUpload({ onDataAdded }: {
+    onDataAdded: (data: object[]) => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/ImportNewPropertyFieldPreview.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { Property } from "@firecms/core";
+export declare function ImportNewPropertyFieldPreview({ propertyKey, property, onEditClick, includeName, onPropertyNameChanged, propertyTypeView }: {
+    propertyKey: string | null;
+    property: Property | null;
+    includeName?: boolean;
+    onEditClick?: () => void;
+    onPropertyNameChanged?: (propertyKey: string, value: string) => void;
+    propertyTypeView?: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/ImportSaveInProgress.d.ts

@@ -0,0 +1,8 @@
+import { EntityCollection } from "@firecms/core";
+import { ImportConfig } from "../types";
+export declare function ImportSaveInProgress<C extends EntityCollection>({ path, importConfig, collection, onImportSuccess }: {
+    path: string;
+    importConfig: ImportConfig;
+    collection: C;
+    onImportSuccess: (collection: C) => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./DataNewPropertiesMapping";
+export * from "./ImportFileUpload";
+export * from "./ImportNewPropertyFieldPreview";
+export * from "./ImportSaveInProgress";

package/dist/export_import/ExportCollectionAction.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+import { CollectionActionsProps, EntityCollection, User } from "@firecms/core";
+export declare function ExportCollectionAction<M extends Record<string, any>, UserType extends User>({ collection: inputCollection, path: inputPath, collectionEntitiesCount, exportAllowed, notAllowedView }: CollectionActionsProps<M, UserType, EntityCollection<M, any>> & {
+    exportAllowed?: (props: {
+        collectionEntitiesCount: number;
+        path: string;
+        collection: EntityCollection;
+    }) => boolean;
+    notAllowedView?: React.ReactNode;
+    onAnalyticsEvent?: (event: string, params?: any) => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/export_import/ImportCollectionAction.d.ts

@@ -0,0 +1,15 @@
+import { CollectionActionsProps, Property, ResolvedProperties, User } from "@firecms/core";
+import { ImportConfig } from "../types";
+export declare function ImportCollectionAction<M extends Record<string, any>, UserType extends User>({ collection, path, collectionEntitiesCount, onAnalyticsEvent }: CollectionActionsProps<M, UserType> & {
+    onAnalyticsEvent?: (event: string, params?: any) => void;
+}): import("react/jsx-runtime").JSX.Element | null;
+export declare function PropertySelectEntry({ propertyKey, property, level }: {
+    propertyKey: string;
+    property: Property;
+    level?: number;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function ImportDataPreview<M extends Record<string, any>>({ importConfig, properties, propertiesOrder }: {
+    importConfig: ImportConfig;
+    properties: ResolvedProperties<M>;
+    propertiesOrder: Extract<keyof M, string>[];
+}): import("react/jsx-runtime").JSX.Element;

package/dist/export_import/export.d.ts

@@ -0,0 +1,10 @@
+import { Entity, ResolvedEntityCollection, ResolvedProperties } from "@firecms/core";
+interface Header {
+    key: string;
+    label: string;
+}
+export declare function downloadExport<M extends Record<string, any>>(data: Entity<M>[], additionalData: Record<string, any>[] | undefined, collection: ResolvedEntityCollection<M>, flattenArrays: boolean, additionalHeaders: string[] | undefined, exportType: "csv" | "json", dateExportType: "timestamp" | "string"): void;
+export declare function getCSVExportableData(data: Entity<any>[], additionalData: Record<string, any>[] | undefined, properties: ResolvedProperties, headers: Header[], dateExportType: "timestamp" | "string"): any[][];
+export declare function getJsonExportableData(data: Entity<any>[], additionalData: Record<string, any>[] | undefined, properties: ResolvedProperties, dateExportType: "timestamp" | "string"): any[];
+export declare function downloadBlob(content: BlobPart[], filename: string, contentType: string): void;
+export {};

package/dist/hooks/index.d.ts

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

package/dist/hooks/useImportConfig.d.ts

@@ -0,0 +1,2 @@
+import { ImportConfig } from "../types";
+export declare const useImportConfig: () => ImportConfig;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./useImportExportPlugin";
+export * from "./components";
+export * from "./types";
+export * from "./utils";
+export * from "./hooks";