@firecms/data_import_export 3.0.0-canary.240 → 3.0.0-canary.241
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -83
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,84 +1,4 @@
|
|
|
1
|
-
## FireCMS
|
|
1
|
+
## FireCMS Import/Export Plugin
|
|
2
2
|
|
|
3
|
-
This plugin
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
The ChatGPT plugin allows you to use the OpenAI API to generate content using
|
|
7
|
-
the latest GPT models. This plugin is able to understand the structure of your
|
|
8
|
-
data and generate content that fits your schema.
|
|
9
|
-
|
|
10
|
-
<p align="center">
|
|
11
|
-
<img src="https://firecms.co/img/data_import.png" width="800px" alt="Data enhancement UI" />
|
|
12
|
-
</p>
|
|
13
|
-
|
|
14
|
-
In order to be able to use this plugin you need to have a valid subscription.
|
|
15
|
-
|
|
16
|
-
You can get a subscription in
|
|
17
|
-
the [FireCMS dashboard](https://app.firecms.co/subscriptions).
|
|
18
|
-
|
|
19
|
-
You need to specify the Firebase project id you would like to use the plugin
|
|
20
|
-
with,
|
|
21
|
-
in the website. And that's it!
|
|
22
|
-
|
|
23
|
-
No need to add any subscription key or anything like that.
|
|
24
|
-
|
|
25
|
-
```tsx
|
|
26
|
-
import React from "react";
|
|
27
|
-
import { FirebaseCMSApp } from "@firecms/core";
|
|
28
|
-
import "typeface-rubik";
|
|
29
|
-
import "@fontsource/jetbrains-mono";
|
|
30
|
-
|
|
31
|
-
import { useDataImportPlugin } from "@firecms/data_import_export";
|
|
32
|
-
|
|
33
|
-
// TODO: Replace with your Firebase config
|
|
34
|
-
const firebaseConfig = {
|
|
35
|
-
apiKey: "",
|
|
36
|
-
authDomain: "",
|
|
37
|
-
projectId: "",
|
|
38
|
-
storageBucket: "",
|
|
39
|
-
messagingSenderId: "",
|
|
40
|
-
appId: ""
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
export default function App() {
|
|
44
|
-
|
|
45
|
-
const dataImportPlugin = useDataImportPlugin({
|
|
46
|
-
// Optional callback for defining which collections should be enhanced
|
|
47
|
-
getConfigForPath: ({ path }) => {
|
|
48
|
-
if (path === "books")
|
|
49
|
-
return true;
|
|
50
|
-
return false;
|
|
51
|
-
}
|
|
52
|
-
});
|
|
53
|
-
|
|
54
|
-
return <FirebaseCMSApp
|
|
55
|
-
name={"My Online Shop"}
|
|
56
|
-
plugins={[dataImportPlugin]}
|
|
57
|
-
authentication={myAuthenticator}
|
|
58
|
-
collections={[
|
|
59
|
-
//...
|
|
60
|
-
]}
|
|
61
|
-
firebaseConfig={firebaseConfig}
|
|
62
|
-
/>;
|
|
63
|
-
}
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
## How does it work?
|
|
67
|
-
|
|
68
|
-
This plugin uses the OpenAI API to generate content using the latest GPT models.
|
|
69
|
-
This plugin is able to understand the structure of your data and generate
|
|
70
|
-
content that fits your schema.
|
|
71
|
-
|
|
72
|
-
Some tips in order to get the best results:
|
|
73
|
-
|
|
74
|
-
- Make sure you select the **right data** type for your fields.
|
|
75
|
-
- The **field names** are used to generate the content and are usually enough to
|
|
76
|
-
generate good results. If you want to get even better results, you can
|
|
77
|
-
**add a description** to your fields. This will help the plugin understand the
|
|
78
|
-
context of your data and generate better results.
|
|
79
|
-
- The **collection name** is important as well.
|
|
80
|
-
- You can establish **relations between fields** and the plugin will pick it up.
|
|
81
|
-
e.g. if you have a field called `author` and another field called `book`, the
|
|
82
|
-
plugin will understand that the author is related to the book and will
|
|
83
|
-
generate content accordingly. You can use this for making **summaries, reviews,
|
|
84
|
-
translations, SEO content**, etc.
|
|
3
|
+
This plugin is DEPRECATED and will be removed in future versions.
|
|
4
|
+
Please use the @firecms/data_import and @firecms/data_export packages instead.
|
package/package.json
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@firecms/data_import_export",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "3.0.0-canary.
|
|
4
|
+
"version": "3.0.0-canary.241",
|
|
5
5
|
"access": "public",
|
|
6
6
|
"main": "./dist/index.umd.js",
|
|
7
7
|
"module": "./dist/index.es.js",
|
|
8
8
|
"types": "./dist/index.d.ts",
|
|
9
9
|
"source": "src/index.ts",
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"@firecms/core": "^3.0.0-canary.
|
|
12
|
-
"@firecms/data_export": "^3.0.0-canary.
|
|
13
|
-
"@firecms/data_import": "^3.0.0-canary.
|
|
11
|
+
"@firecms/core": "^3.0.0-canary.241",
|
|
12
|
+
"@firecms/data_export": "^3.0.0-canary.241",
|
|
13
|
+
"@firecms/data_import": "^3.0.0-canary.241"
|
|
14
14
|
},
|
|
15
15
|
"peerDependencies": {
|
|
16
16
|
"react": ">=18.0.0",
|
|
@@ -82,5 +82,5 @@
|
|
|
82
82
|
"publishConfig": {
|
|
83
83
|
"access": "public"
|
|
84
84
|
},
|
|
85
|
-
"gitHead": "
|
|
85
|
+
"gitHead": "5d3c3928250947d0363073d612a8c15f9bc10459"
|
|
86
86
|
}
|