Merge branch 'main' into simplify-updating-bard-configs-in-fieldsets

Author: duncanmcclean

CHANGELOG.md

@@ -1,5 +1,78 @@
 # Changelog
 
+## 1.7.3 (2025-01-29)
+
+### What's fixed
+* Fixed issue where deeply nested images in Bard fields were not being imported correctly #85 by @tdondich
+
+
+
+## 1.7.2 (2025-01-14)
+
+### What's fixed
+* Fixed taxonomy terms not being imported correctly #83 by @duncanmcclean
+
+
+
+## 1.7.1 (2025-01-09)
+
+### What's fixed
+* Fixed formatting issues when importing Classic Editor content from WordPress #81 by @duncanmcclean
+* Reverted "Fix import issue with Bard" #79 by @duncanmcclean
+
+
+
+## 1.7.0 (2025-01-07)
+
+### What's new
+* Added support for the List fieldtype #75 by @carstenjaksch
+* Added support for importing date ranges #78 by @duncanmcclean
+* Added support for importing alt text for multiple assets at once #74 by @carstenjaksch
+* Now, only the Bard buttons used by your content will be enabled #77 by @duncanmcclean
+* Added note to the docs about importing multiple values #70 by @carstenjaksch
+
+### What's fixed
+* Fixed existing assets check when using the "Folder" option #73 by @carstenjaksch
+
+
+
+## 1.6.0 (2024-12-20)
+
+### What's new
+- Multi-site taxonomy support #67 by @duncanmcclean
+- Added "Blueprint" option when configuring entry & term imports #64 by @duncanmcclean
+- Downloaded assets can now be processed using your asset container's source preset #59 by @duncanmcclean
+- Added a progress indicator when saving / running an import by @duncanmcclean
+- Added a tooltip when hovering over a field name in the mappings table by @duncanmcclean
+- The "Unique Field" option has been removed from term & user imports. The Slug and Email will be used instead #66 by @duncanmcclean
+
+### What's fixed
+- Fixed import issue with Bard #65 by @duncanmcclean
+
+
+
+## 1.5.1 (2024-12-10)
+
+### What's fixed
+* Fixed error when importing structured collection without mapping "Parent" field #58 by @duncanmcclean
+* A banner will now be displayed when a database hasn't been configured #56 by @duncanmcclean
+
+
+
+## 1.5.0 (2024-11-29)
+
+### What's new
+* You can now import asset alt text #50 by @duncanmcclean
+* The current file is now shown in the edit form #47 by @duncanmcclean
+* PHP 8.4 Support #41 by @duncanmcclean
+
+### What's fixed
+* Null values are now filtered out when saving mappings #48 by @duncanmcclean
+* Bumped `cross-spawn` from 7.0.3 to 7.0.6 #46 by @dependabot[bot]
+* Fixed error when updating Bard configs inside fieldsets #22 by @duncanmcclean
+
+
+
 ## 1.4.1 (2024-11-21)
 
 ### What's fixed

DOCUMENTATION.md

@@ -1,5 +1,8 @@
 ## Installation
 
+> **Note:**
+> Before installing the importer addon, please ensure your project has a database configured. The importer uses a database to keep track of import progress. If you created your site using the [Statamic CLI](https://github.com/statamic/cli), a SQLite database will have been setup for you. You can confirm by running `php artisan migrate`.
+
 1. You can install the Importer addon via Composer:
 
    ```bash
@@ -17,6 +20,7 @@ Before importing, you will need to do some preparation:
 * Ensure you have either a CSV or XML file to import.
   * You will need to produce separate files for each type of content you wish to import. For example: one file for Page entries, one for Blog entries, another for Users, etc.
   * When you're uploading a CSV, the CSV needs to have a header row.
+  * Some fields allow importing multiple values. In this case, values should be separated by a pipe (`|`).
   * When you're coming from WordPress, please see the [WordPress](#wordpress) section below.
 * Create the necessary collections and taxonomies in Statamic.
 * Configure the necessary blueprints for those collections and taxonomies.
@@ -29,13 +33,14 @@ Before importing, you will need to do some preparation:
 3. You can then map fields from your blueprint to fields/columns in your file.
     * Depending on the fieldtype, some fields may have additional options, like "Related Key" or "Create when missing". You can read more about these below.
     * Mapping is disabled for some fieldtypes, like the [Replicator fieldtype](https://statamic.dev/fieldtypes/replicator#content). If you wish to import these fields, you will need to build a [custom transformer](#transformers).
-4. You will also need to specify a "Unique Field". This field will be used to determine if an item already exists in Statamic.
+    * When you're importing taxonomy terms into a non-default site (eg. not the _first_ site you created) and the slugs differ between sites, you can map the "Slug in Default Site" field to the slug of the term in the default site in order for the importer to match up the terms correctly.
+4. If you're importing entries, you will also need to specify a "Unique Field". This field will be used to determine if an entry already exists in Statamic.
 5. Then, run the import and watch the magic happen! ✨
 
 You can run the importer as many times as you like as you tweak the mappings. It'll update existing content and create new content as needed.
 
 #### Queueing
-If you're importing a lot of content, you may want to consider running a queue worker to handle the import in the background.
+If you're importing a lot of content or downloading a lot of assets, you may want to consider running a queue worker to handle the import in the background.
 
 Assuming you have Redis installed, you can update the `QUEUE_CONNECTION` in your `.env` file to `redis` and then run:
 
@@ -56,8 +61,12 @@ When you're configuring mappings for an Assets field, or a Bard field, a few add
 * **Download when missing?**
     * By default, when the importer comes across an asset it can't find in Statamic, it will skip it.
     * However, if you wish, the importer can download any missing assets for you into the configured asset container.
+* **Process downloaded images?**
+    * Determine whether downloaded images should be processed using the asset container's [source preset](https://statamic.dev/image-manipulation#process-source-images).
 * **Folder**
     * By default, downloaded assets will use same folder structure as the original URL. If you'd like to download them into a specific folder, you can select one here.
+* **Alt Text**
+    * Determine which field in the row contains the alt text for the asset. This option will only be shown when the Asset blueprint has an `alt` field.
 
 When importing a Bard field, assets will only be imported when the "Container" config option has been set in the blueprint.
 
@@ -80,6 +89,9 @@ While you *can* use WordPress' built-in export tool, it doesn't contain all the
 
 Instead, we recommend using a plugin like [WP All Export](https://wordpress.org/plugins/wp-all-export/) to export your content. It allows you to customize the columns included in the export (like ACF fields, featured images, etc.) and it'll give you a CSV.
 
+### Classic Editor
+If you're importing content from the Classic Editor into a [Bard field](https://statamic.dev/fieldtypes/bard#overview), you will likely want to enable the "WordPress: Replace double line-breaks with <p> tags" option, which will wrap any unwrapped text in `<p>` tags before importing it into Bard.
+
 ### Gutenberg
 Statamic's [Bard fieldtype](https://statamic.dev/fieldtypes/bard#overview) is the closest equivalent to WordPress' Gutenberg editor.
 

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Statamic Rad Pack
+Copyright (c) Statamic
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -19,6 +19,9 @@ composer require statamic/importer
 
 You can find the Importer addon in the Control Panel under `Utilities > Importer`.
 
+> **Note:**
+> Before installing the importer addon, please ensure your project has a database configured. The importer uses a database to keep track of import progress. If you created your site using the [Statamic CLI](https://github.com/statamic/cli), a SQLite database will have been setup for you. You can confirm by running `php artisan migrate`.
+
 <!-- statamic:hide -->
 ## Documentation
 

composer.json

@@ -21,7 +21,8 @@
     "require-dev": {
         "laravel/pint": "^1.18",
         "orchestra/testbench": "^8.28 || ^9.6.1",
-        "phpunit/phpunit": "^10.5.35"
+        "phpunit/phpunit": "^10.5.35",
+        "spatie/laravel-ray": "^1.39"
     },
     "config": {
         "allow-plugins": {

lang/en/messages.php

@@ -5,21 +5,26 @@
     'utility_description' => 'Import entries, taxonomies, and users from XML and CSV files.',
 
     'configuration_instructions' => 'You can add or modify your Blueprint fields to customize what data is imported and what fieldtype it will be stored in. You can save, refresh, and come back to this import config later until it\'s ready to run.',
+    'destination_blueprint_instructions' => 'Select which blueprint should be used for imported content.',
     'destination_collection_instructions' => 'Select the collection to import entries into.',
     'destination_site_instructions' => 'Which site should the entries be imported into?',
     'destination_taxonomy_instructions' => 'Select the taxonomy to import terms into.',
     'destination_type_instructions' => 'Choose what type of data are you importing.',
-    'import_file_instructions' => 'Upload a CSV or XML file to import. This will replace the current file.',
-    'import_file_instructions_create' => 'Upload a CSV or XML file to import.',
+    'import_file_instructions' => 'Upload a CSV or XML file to import.',
     'import_name_instructions' => 'Name this import so you can identify it later.',
     'mapping_instructions' => 'Map the fields from your import to the fields in your blueprint.',
     'strategy_instructions' => 'Choose what should happen when importing.',
     'unique_field_instructions' => 'Select a "unique field" to determine if an item already exists.',
 
+    'assets_alt_instructions' => 'Which field should be used for the alt text?',
     'assets_base_url_instructions' => 'The base URL to prepend to the path.',
     'assets_download_when_missing_instructions' => 'If the asset can\'t be found in the asset container, should it be downloaded?',
     'assets_folder_instructions' => 'By default, downloaded assets will use same folder structure as the original URL. You can specify a different folder here.',
     'assets_related_field_instructions' => 'Which field does the data reference?',
+    'assets_process_downloaded_images_instructions' => 'Should downloaded images be processed using the asset container\'s source preset?',
+    'bard_wp_auto_p_instructions' => "You may want to enable this if you're importing from the Classic Editor.",
+    'date_start_date_instructions' => 'Which field should be used for the start date?',
+    'date_end_date_instructions' => 'Which field should be used for the end date?',
     'entries_create_when_missing_instructions' => 'Create the entry if it doesn\'t exist.',
     'entries_related_field_instructions' => 'Which field does the data reference?',
     'terms_create_when_missing_instructions' => 'Create the term if it doesn\'t exist.',

lang/en/validation.php

@@ -2,8 +2,11 @@
 
 return [
     'file_type_not_allowed' => 'Only CSV and XML files can be imported at this time.',
+    'mappings_email_missing' => 'The Email field must be mapped on user imports.',
     'mappings_not_provided' => 'You must map at least one field.',
+    'mappings_slug_missing' => 'The Slug field must be mapped on taxonomy term imports.',
     'site_not_configured_in_collection' => 'The chosen collection is not available on this site.',
+    'site_not_configured_in_taxonomy' => 'The chosen taxonomy is not available on this site.',
     'unique_field_without_mapping' => 'Please configure a mapping for this field.',
     'uploaded_file_not_found' => 'The uploaded file could not be found.',
 ];

package-lock.json

@@ -11,7 +11,7 @@
             </div>
         </div>
 
-        <div v-if="batchesTableMissing" class="text-xs border border-yellow-dark rounded p-4 bg-yellow dark:bg-dark-blue-100 dark:border-none">
+        <div v-if="batchesTableMissing" class="text-xs border border-yellow-dark rounded p-4 bg-yellow dark:bg-dark-blue-100 dark:border-none mb-6">
             <div class="font-bold mb-2">{{ __('Please run your migrations.') }}</div>
             <p v-html="__('importer::messages.migrations_needed')"></p>
         </div>
@@ -135,5 +135,11 @@ export default {
             }
         },
     },
+
+    watch: {
+        saving(saving) {
+            this.$progress.loading(`${this.publishContainer}-import-edit-form`, saving);
+        },
+    }
 }
 </script>

resources/js/components/EditImportForm.vue

@@ -0,0 +1,63 @@
+<template>
+    <v-select
+        searchable
+        :options="options"
+        :get-option-label="(option) => option.title"
+        :get-option-key="(option) => option.handle"
+        :value="value"
+        :reduce="opt => opt.handle"
+        @input="update($event)"
+    />
+</template>
+
+<script>
+export default {
+    mixins: [Fieldtype],
+
+    inject: ['storeName'],
+
+    mounted() {
+        if (! this.value && this.type && (this.collection || this.taxonomy)) {
+            this.$emit('input', this.options[0].handle);
+        }
+    },
+
+    computed: {
+        type() {
+            return this.$store.state.publish[this.storeName].values.destination.type;
+        },
+
+        collection() {
+            return this.$store.state.publish[this.storeName].values.destination.collection[0];
+        },
+
+        taxonomy() {
+            return this.$store.state.publish[this.storeName].values.destination.taxonomy[0];
+        },
+
+        options() {
+            if (this.type === 'entries') {
+                return this.meta.collectionBlueprints[this.collection];
+            }
+
+            if (this.type === 'terms') {
+                return this.meta.taxonomyBlueprints[this.taxonomy];
+            }
+        },
+    },
+
+    watch: {
+        type() {
+            this.$emit('input', null);
+        },
+
+        collection() {
+            this.$emit('input', this.options[0].handle);
+        },
+
+        taxonomy() {
+            this.$emit('input', this.options[0].handle);
+        },
+    }
+}
+</script>