Merge remote-tracking branch 'origin/main' into fix/updating-bard-con…

…figs-in-fieldsets

CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 
-### 1.1.2 (2024-11-06)
+## 1.2.0 (2024-11-08)
+
+### What's new
+* UX Improvements #24 by @duncanmcclean
+* Added "CSV Delimiter" option #29 by @duncanmcclean
+* You can now import publish states (& toggle fields) #30 by @duncanmcclean
+
+
+
+## 1.1.2 (2024-11-06)
 
 ### What's fixed
 * Fixed validation error when creating an import in a multi-site #27 by @duncanmcclean

DOCUMENTATION.md

@@ -137,12 +137,15 @@ The importer includes a few transformers out of the box for Core fieldtypes, but
     use App\ImportTransformers\YourTransformer;
     use Illuminate\Support\ServiceProvider;
     use Statamic\Importer\Importer;
+    use Statamic\Statamic;
 
     class AppServiceProvider extends ServiceProvider
     {
         public function boot(): void
         {
-            Importer::registerTransformer('fieldtype', YourTransformer::class);
+            Statamic::booted(function () {
+                Importer::registerTransformer('fieldtype', YourTransformer::class);
+            });
         }
     }
     ```

resources/js/components/EditImportForm.vue

@@ -72,16 +72,6 @@ export default {
         }
     },
 
-    computed: {
-        hasErrors() {
-            return this.error || Object.keys(this.errors).length;
-        },
-
-        isDirty() {
-            return this.$dirty.has(this.publishContainer);
-        },
-    },
-
     mounted() {
         this.quickSaveKeyBinding = this.$keys.bindGlobal(['mod+s'], e => {
             e.preventDefault();

resources/js/components/Fieldtypes/ImportMappingsFieldtype.vue

@@ -46,18 +46,18 @@
 </template>
 
 <style>
-.field-mappings-table .form-group {
-    padding-top: 16px;
-    padding-bottom: 16px;
-}
+    .field-mappings-table .form-group {
+        padding-top: 16px;
+        padding-bottom: 16px;
+    }
 
-.field-mappings-table .form-group:first-child {
-    padding-top: 0;
-}
+    .field-mappings-table .form-group:first-child {
+        padding-top: 0;
+    }
 
-.field-mappings-table .form-group:last-child {
-    padding-bottom: 0;
-}
+    .field-mappings-table .form-group:last-child {
+        padding-bottom: 0;
+    }
 </style>
 
 <script>

src/Fieldtypes/ImportMappingsFieldtype.php

@@ -21,7 +21,7 @@ public function preload()
     {
         return [
             'fields' => $this->fields()->map(function (Fields $fields, string $handle) {
-                $field = $this->field()->parent()->destinationBlueprint()->field($handle);
+                $field = $this->field()->parent()->mappingFields()->get($handle);
 
                 return [
                     'type' => $field->type(),
@@ -39,9 +39,7 @@ public function preload()
     public function preProcess($data): array
     {
         return $this->fields()->map(function (Fields $fields, string $handle) use ($data) {
-            $field = $this->field()->parent()->destinationBlueprint()->field($handle);
-
-            return $fields->addValues(Arr::get($data, $field->handle(), []))->preProcess()->values()->all();
+            return $fields->addValues(Arr::get($data, $handle, []))->preProcess()->values()->all();
         })->all();
     }
 
@@ -90,18 +88,17 @@ private function fields(): Collection
         $import = $this->field()->parent();
 
         $row = match ($import->get('type')) {
-            'csv' => (new Csv($import))->getItems($import->get('path'), [])->first(),
-            'xml' => (new Xml($import))->getItems($import->get('path'), [])->first(),
+            'csv' => (new Csv($import))->getItems($import->get('path'))->first(),
+            'xml' => (new Xml($import))->getItems($import->get('path'))->first(),
         };
 
-        return $import->destinationBlueprint()->fields()->all()
+        return $import->mappingFields()->all()
             ->reject(function (Field $field) {
                 $transformer = Importer::getTransformer($field->type());
 
-                return in_array($field->type(), ['section', 'grid', 'replicator', 'group'])
-                    && ! $transformer;
+                return in_array($field->type(), ['section', 'grid', 'replicator', 'group', 'array']) && ! $transformer;
             })
-            ->mapWithKeys(function (Field $field) use ($row) {
+            ->mapWithKeys(function (Field $field) use ($import, $row) {
                 $fields = [];
 
                 if ($transformer = Importer::getTransformer($field->type())) {
@@ -119,7 +116,7 @@ private function fields(): Collection
                         'clearable' => true,
                     ],
                     ...$fields,
-                ])->setHandle('mappings-'.$field->handle());
+                ])->setHandle("import-mappings-{$field->handle()}".md5($import->config()->toJson()));
 
                 return [$field->handle() => $blueprint->fields()];
             });

src/Http/Controllers/ExtractFromImportFields.php

@@ -4,9 +4,15 @@
 
 trait ExtractFromImportFields
 {
-    protected function extractFromFields($import, $fields)
+    protected function extractFromFields($import, $blueprint)
     {
-        $fields = $fields->preProcess();
+        $fields = $blueprint
+            ->fields()
+            ->setParent($import)
+            ->addValues($import->config()->merge([
+                'name' => $import->name(),
+            ])->all())
+            ->preProcess();
 
         $values = $fields->values();
 

src/Http/Controllers/ImportController.php

@@ -172,6 +172,7 @@ public function update(Request $request, Import $import)
                 'path' => $path,
                 'destination' => collect($values['destination'])->filter()->all(),
                 'strategy' => $values['strategy'],
+                'source' => $values['source'],
                 'mappings' => $values['mappings'],
                 'unique_field' => $values['unique_field'],
             ]));
@@ -185,7 +186,7 @@ public function update(Request $request, Import $import)
         // We need to refresh the blueprint after saving, so the field conditions are up-to-date.
         $blueprint = $import->blueprint();
 
-        [$values, $meta] = $this->extractFromFields($import, $fields);
+        [$values, $meta] = $this->extractFromFields($import, $blueprint);
 
         return [
             'data' => array_merge((new ImportResource($import->fresh()))->resolve()['data'], [

src/Imports/Blueprint.php

@@ -8,6 +8,8 @@
 use Statamic\Facades;
 use Statamic\Facades\Collection;
 use Statamic\Facades\Site;
+use Statamic\Importer\Sources\Csv;
+use Statamic\Importer\Sources\Xml;
 
 class Blueprint
 {
@@ -78,7 +80,7 @@ function (string $attribute, mixed $value, Closure $fail) {
                                                 'field' => [
                                                     'type' => 'button_group',
                                                     'display' => __('Data Type'),
-                                                    'instructions' => __('Choose what type of data are you importing'),
+                                                    'instructions' => __('Choose what type of data are you importing.'),
                                                     'width' => 50,
                                                     'options' => [
                                                         ['key' => 'entries', 'value' => __('Entries')],
@@ -159,6 +161,7 @@ function (string $attribute, mixed $value, Closure $fail) {
                             'display' => __('Configuration'),
                             'instructions' => __('importer::messages.configuration_instructions'),
                             'fields' => [
+                                ...static::getSourceFields($import),
                                 [
                                     'handle' => 'mappings',
                                     'field' => [
@@ -206,6 +209,33 @@ function (string $attribute, mixed $value, Closure $fail) {
         ]);
     }
 
+    private static function getSourceFields(?Import $import = null): array
+    {
+        if (! $import) {
+            return [];
+        }
+
+        $fields = match ($import->get('type')) {
+            'csv' => (new Csv($import))->fields(),
+            'xml' => (new Xml($import))->fields(),
+        };
+
+        if ($fields->items()->isEmpty()) {
+            return [];
+        }
+
+        return [[
+            'handle' => 'source',
+            'field' => [
+                'type' => 'group',
+                'hide_display' => true,
+                'fullscreen' => false,
+                'border' => false,
+                'fields' => $fields->items()->all(),
+            ],
+        ]];
+    }
+
     private static function buildFieldConditions(Import $import): array
     {
         $conditions = [

src/Imports/Import.php

@@ -7,6 +7,8 @@
 use Statamic\Facades\Collection;
 use Statamic\Facades\Taxonomy;
 use Statamic\Facades\User;
+use Statamic\Fields\Blueprint as StatamicBlueprint;
+use Statamic\Fields\Fields;
 use Statamic\Importer\Facades\Import as ImportFacade;
 use Statamic\Importer\Importer;
 use Statamic\Support\Traits\FluentlyGetsAndSets;
@@ -124,23 +126,39 @@ public function deleteUrl(): string
         return cp_route('utilities.importer.destroy', $this->id());
     }
 
-    public function blueprint(): \Statamic\Fields\Blueprint
+    public function blueprint(): StatamicBlueprint
     {
         return Blueprint::getBlueprint($this);
     }
 
-    public function destinationBlueprint(): \Statamic\Fields\Blueprint
+    /**
+     * Returns the blueprint of the destination collection, taxonomy, or user.
+     */
+    public function destinationBlueprint(): StatamicBlueprint
     {
-        if ($this->get('destination.type') === 'entries') {
-            return Collection::find($this->get('destination.collection'))->entryBlueprint();
-        }
+        return match ($this->get('destination.type')) {
+            'entries' => Collection::find($this->get('destination.collection'))->entryBlueprint(),
+            'terms' => Taxonomy::find($this->get('destination.taxonomy'))->termBlueprint(),
+            'users' => User::blueprint(),
+        };
+    }
 
-        if ($this->get('destination.type') === 'terms') {
-            return Taxonomy::find($this->get('destination.taxonomy'))->termBlueprint();
-        }
+    /**
+     * Returns a Fields instance of the fields available for mapping.
+     * Sometimes, additional fields will be appended, like "Published" for
+     * entries, which doesn't exist as a blueprint field.
+     */
+    public function mappingFields(): Fields
+    {
+        $blueprint = clone $this->destinationBlueprint();
 
-        if ($this->get('destination.type') === 'users') {
-            return User::blueprint();
+        if ($this->get('destination.type') === 'entries') {
+            $blueprint->ensureField('published', [
+                'type' => 'toggle',
+                'display' => __('Published'),
+            ]);
         }
+
+        return $blueprint->fields();
     }
 }

src/Jobs/ImportItemJob.php

@@ -14,10 +14,8 @@
 use Statamic\Facades\Collection;
 use Statamic\Facades\Entry;
 use Statamic\Facades\Site;
-use Statamic\Facades\Taxonomy;
 use Statamic\Facades\Term;
 use Statamic\Facades\User;
-use Statamic\Fields\Blueprint;
 use Statamic\Importer\Importer;
 use Statamic\Importer\Imports\Import;
 
@@ -29,13 +27,14 @@ public function __construct(public Import $import, public array $item) {}
 
     public function handle(): void
     {
-        $blueprint = $this->getBlueprint();
+        $fields = $this->import->mappingFields();
+        $blueprint = $this->import->destinationBlueprint();
 
         $data = collect($this->import->get('mappings'))
             ->reject(fn (array $mapping) => empty($mapping['key']))
-            ->mapWithKeys(function (array $mapping, string $fieldHandle) use ($blueprint) {
+            ->mapWithKeys(function (array $mapping, string $fieldHandle) use ($fields, $blueprint) {
+                $field = $fields->get($fieldHandle);
                 $value = Arr::get($this->item, $mapping['key']);
-                $field = $blueprint->field($fieldHandle);
 
                 if (! $value) {
                     return [$fieldHandle => null];
@@ -47,7 +46,7 @@ public function handle(): void
 
                 return [$fieldHandle => $value];
             })
-            ->filter()
+            ->reject(fn ($value) => is_null($value))
             ->all();
 
         match ($this->import->get('destination.type')) {
@@ -57,21 +56,6 @@ public function handle(): void
         };
     }
 
-    protected function getBlueprint(): Blueprint
-    {
-        if ($this->import->get('destination.type') === 'entries') {
-            return Collection::find($this->import->get('destination.collection'))->entryBlueprint();
-        }
-
-        if ($this->import->get('destination.type') === 'terms') {
-            return Taxonomy::find($this->import->get('destination.taxonomy'))->termBlueprint();
-        }
-
-        if ($this->import->get('destination.type') === 'users') {
-            return User::blueprint();
-        }
-    }
-
     protected function findOrCreateEntry(array $data): void
     {
         $collection = Collection::find($this->import->get('destination.collection'));

src/ServiceProvider.php

@@ -17,6 +17,7 @@ class ServiceProvider extends AddonServiceProvider
         'date' => Transformers\DateTransformer::class,
         'entries' => Transformers\EntriesTransformer::class,
         'terms' => Transformers\TermsTransformer::class,
+        'toggle' => Transformers\ToggleTransformer::class,
         'users' => Transformers\UsersTransformer::class,
     ];
 

src/Sources/AbstractSource.php

@@ -2,10 +2,31 @@
 
 namespace Statamic\Importer\Sources;
 
+use Illuminate\Support\Arr;
+use Illuminate\Support\LazyCollection;
+use Statamic\Extend\HasFields;
 use Statamic\Importer\Contracts\Source;
 use Statamic\Importer\Imports\Import;
 
 abstract class AbstractSource implements Source
 {
+    use HasFields;
+
     public function __construct(public ?Import $import = null) {}
+
+    abstract public function getItems(string $path): LazyCollection;
+
+    public function fieldItems(): array
+    {
+        return [];
+    }
+
+    protected function config(?string $key = null, $default = null): mixed
+    {
+        if (is_null($key)) {
+            return collect($this->import->get('source'));
+        }
+
+        return Arr::get($this->import->get('source'), $key, $default);
+    }
 }