Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apostrophecms/piece-type-exporter
https://github.com/apostrophecms/piece-type-exporter
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/apostrophecms/piece-type-exporter
- Owner: apostrophecms
- License: mit
- Created: 2021-10-18T17:00:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T18:51:32.000Z (6 months ago)
- Last Synced: 2024-11-02T16:06:58.838Z (about 2 months ago)
- Language: JavaScript
- Size: 48.8 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://circleci.com/gh/apostrophecms/piece-type-exporter/tree/main)
[](https://chat.apostrophecms.org)
# Apostrophe Pieces Exporter
> ⚠️ **NOTE:** This module is deprecated, its functionality has been incorporated into [@apostrophecms/import-export](https://github.com/apostrophecms/import-export).
This module adds an optional export feature to all piece type modules in an [Apostrophe](https://apostrophecms.com) project. This feature enables exporting *published* pieces of piece types where it is configured. Requires Apostrophe 3.
## Installation
```bash
npm install @apostrophecms/piece-type-exporter
```
## Use
### Initialization
Configure `@apostrophecms/piece-type-exporter` and the form widgets in `app.js`.
```javascript
require('apostrophe')({
shortName: 'my-project',
modules: {
// The exporter module
'@apostrophecms/piece-type-exporter': {},
// A piece type that you want to make exportable
'article': {
options: {
export: true
}
}
}
});
```
The Pieces Exporter module improves all piece types in the site to add export functionality to them. To enable that functionality, **you must add the `export: true` option on the appropriate piece type(s)**. The example above demonstrates doing this in the `app.js` file. More often it will be preferable to set this option in the module's `index.js` file.
```javascript
// modules/article/index.js
module.exports = {
extend: '@apostrophecms/piece-type',
options: {
label: 'Article',
pluralLabel: 'Articles',
export: true // 👈 Adding the export option.
},
// Other properties...
}
```
### Additional options
#### `omitFields`
You can specify properties to omit from exported documents with this option. The `export` option on the exportable piece type becomes an object with an `omitFields` property. `omitFields` takes an array of field names to omit.
For example, if you wanted to exclude the `archive` field from the export, you would configure your piece like this:
```javascript
// modules/article/index.js
module.exports = {
extend: '@apostrophecms/piece-type',
options: {
label: 'Article',
pluralLabel: 'Articles',
export: {
omitFields: [ 'archive' ]
}
},
// Other properties...
}
```
#### `expiration`
By default, exported files are automatically deleted after one hour. You can change this time span by setting an `expiration` property on the `export` option. It should be set to an integer representing the number of milliseconds until expiration.
```javascript
// modules/article/index.js
module.exports = {
extend: '@apostrophecms/piece-type',
options: {
label: 'Article',
pluralLabel: 'Articles',
export: {
// 👇 Set to expire after two hours. Tip: Writing as an expression can
// help make it clearer to other people.
expiration: 1000 * 60 * 120
}
},
// Other properties...
}
```
#### Export areas as plain text with `exportPlainText`
By default, this module exports areas as rich text. You will receive simple HTML markup corresponding to any rich text widgets present in those areas.
If you prefer, you can set the `exportPlainText: true` option *on an `area` schema field* to export it as plain text. In this case, tags are stripped and entities are un-escaped.
```javascript
// modules/article/index.js
module.exports = {
extend: '@apostrophecms/piece-type',
options: {
label: 'Article',
pluralLabel: 'Articles',
export: true
},
fields: {
add: {
textArea: {
type: 'area',
widgets: {
'@apostrophecms/rich-text': {}
},
options: {
// 👇 The option set to export this area as plain text.
exportPlainText: true
}
}
}
}
}
```