pageflow 16.0.0 → 16.1.0

data/entry_types/scrolled/config/routes.rb

@@ -11,6 +11,10 @@ PageflowScrolled::Engine.routes.draw do
             put :order
           end
 
+          member do
+            post :duplicate
+          end
+
           resources :content_elements do
             collection do
               put :batch

data/entry_types/scrolled/lib/generators/pageflow_scrolled/install/install_generator.rb

@@ -30,10 +30,71 @@ module PageflowScrolled
       end
 
       def install_packages
-        run 'yarn add postcss-url@^8.0.0 @fontsource/source-sans-pro'
+        if defined?(Shakapacker)
+          run 'yarn add css-loader style-loader' \
+              ' mini-css-extract-plugin css-minimizer-webpack-plugin' \
+              ' postcss postcss-preset-env postcss-loader' \
+              ' postcss-import postcss-url postcss-flexbugs-fixes' \
+              ' @fontsource/source-sans-pro'
+        else
+          run 'yarn add postcss-url@^8.0.0 @fontsource/source-sans-pro'
+        end
+      end
+
+      def webpack_config
+        return unless defined?(Shakapacker)
+
+        gsub_file(
+          'config/webpack/webpack.config.js',
+          "const { generateWebpackConfig } = require('shakapacker')",
+          "const { generateWebpackConfig, merge, mergeWithRules } = require('shakapacker')"
+        )
+
+        gsub_file(
+          'config/webpack/webpack.config.js',
+          'const webpackConfig = generateWebpackConfig()',
+          <<~JS
+            const webpackConfig = merge(
+              generateWebpackConfig({
+                resolve: {
+                  extensions: ['.css']
+                }
+              }),
+              require('pageflow/config/webpack5'),
+              require('pageflow-scrolled/config/webpack')
+            )
+          JS
+        )
+
+        gsub_file(
+          'config/webpack/webpack.config.js',
+          'module.exports = webpackConfig',
+          <<~JS
+            // Extend file rule to include mp3 extension
+            module.exports = mergeWithRules({
+              module: {
+                rules: {
+                  test: 'replace',
+                  type: 'match'
+                },
+              },
+            })(webpackConfig, {
+              module: {
+                rules: [
+                  {
+                    test: /\.(bmp|gif|jpe?g|png|tiff|ico|avif|webp|eot|otf|ttf|woff|woff2|svg|mp3)$/,
+                    type: 'asset/resource'
+                  }
+                ]
+              }
+            })
+          JS
+        )
       end
 
       def webpack_environment
+        return if defined?(Shakapacker)
+
         inject_into_file('config/webpack/environment.js',
                          before: "module.exports = environment\n") do
           "environment.config.merge(require('pageflow/config/webpack'))\n" \
@@ -53,6 +114,8 @@ module PageflowScrolled
       end
 
       def webpacker_yml
+        return if defined?(Shakapacker)
+
         gsub_file('config/webpacker.yml',
                   'extract_css: false',
                   'extract_css: true')
@@ -64,10 +127,29 @@ module PageflowScrolled
       end
 
       def postcss_config
-        inject_into_file('postcss.config.js',
-                         after: "require('postcss-import'),\n") do
-          "    // Make relative urls in fontsource packages work\n" \
-          "    require('postcss-url')({url: 'rebase'}),\n"
+        if defined?(Shakapacker)
+          create_file 'postcss.config.js', <<~JS
+            module.exports = {
+              plugins: [
+                require('postcss-import'),
+                // Make relative urls in fontsource packages work
+                require('postcss-url')({url: 'rebase'}),
+                require('postcss-flexbugs-fixes'),
+                require('postcss-preset-env')({
+                  autoprefixer: {
+                    flexbox: 'no-2009'
+                  },
+                  stage: 3
+                })
+              ]
+            }
+          JS
+        else
+          inject_into_file('postcss.config.js',
+                           after: "require('postcss-import'),\n") do
+            "    // Make relative urls in fontsource packages work\n" \
+            "    require('postcss-url')({url: 'rebase'}),\n"
+          end
         end
       end
 
@@ -96,6 +178,7 @@ module PageflowScrolled
           import 'pageflow-scrolled/frontend-server';
           import 'pageflow-scrolled/contentElements-frontend';
           import 'pageflow-scrolled/widgets/defaultNavigation';
+          import 'pageflow-scrolled/widgets/consentBar';
         JS
       end
 
@@ -108,6 +191,15 @@ module PageflowScrolled
         JS
       end
 
+      def consent_bar_widget_packs
+        widget_dir = 'app/javascript/packs/pageflow-scrolled/widgets'
+
+        create_file File.join(widget_dir, 'consentBar.js'), <<-JS
+          import 'pageflow-scrolled/widgets/consentBar';
+          import 'pageflow-scrolled/widgets/consentBar.css';
+        JS
+      end
+
       def default_font_pack
         create_file 'app/javascript/packs/fonts/sourceSansPro.css', <<-CSS
           @import "@fontsource/source-sans-pro/400.css";

data/entry_types/scrolled/lib/pageflow_scrolled/additional_seed_data.rb

@@ -32,7 +32,7 @@ module PageflowScrolled
           entry.revision,
           content_element_type_names
         ),
-        options
+        **options
       )
     end
 

data/entry_types/scrolled/lib/pageflow_scrolled/configuration.rb

@@ -44,12 +44,108 @@ module PageflowScrolled
     # @since 15.7
     attr_reader :additional_frontend_seed_data
 
+    # Determine which vendors a content element will require consent
+    # for. Based on the vendor name returned here, the following
+    # translations will be used in consent UI components.
+    #
+    #     pageflow_scrolled.consent_vendors.#{name}.name
+    #     pageflow_scrolled.consent_vendors.#{name}.description
+    #     pageflow_scrolled.consent_vendors.#{name}.opt_in_prompt
+    #
+    # @example
+    #
+    #     config.content_element_consent_vendors.register(
+    #       lambda |configuration:| do
+    #         if configuration['provider'] == 'youtube'
+    #           'youtube'
+    #         else
+    #           'vimeo'
+    #         end
+    #       end,
+    #       content_element_type_name: 'videoEmbed'
+    #     )
+    #
+    # @return [ContentElementConsentVendors]
+    # @since 16.1
+    attr_reader :content_element_consent_vendors
+
+    # Mapping from URL hosts to consent vendor names. Used for iframe
+    # embed opt-in.
+    #
+    # @exmaple
+    #
+    #     entry_type_config.consent_vendor_host_matchers = {
+    #       /\.some-vendor\.com$/ => 'someVendor'
+    #     }
+    #
+    # @return [Hash<RegExp, String>]
+    # @since 16.1
+    attr_accessor :consent_vendor_host_matchers
+
+    # Migrate typography variants to palette colors. Before palette
+    # colors for text blocks and headings were introduced, it was
+    # already possible to color text by defining typography variants
+    # that only differ by text color. Now that color can be configured
+    # independently, those typography variants have become
+    # redundant. This option allows mapping each of those legacy
+    # typography variants to a palette color and a different
+    # typography variant that does not change color. Legacy typography
+    # variants are not displayed in the editor typography variant list
+    # box. When an element that uses a legacy typography variant is
+    # selected in the editor, the typography variant and palette color
+    # from the mapping can be shown as currently selected instead. To
+    # make this work, the corresponding Backbome model needs to be
+    # wrapped using Entry#createLegacyTypographyVariantDelegator.
+    #
+    # @example
+    #
+    #     config.themes.register(
+    #       :custom,
+    #       typography: {
+    #         # Replaced by default variant and palette color
+    #         'textBlock-paragraph-accent' => {
+    #           color: 'var(--theme-accent-color)'
+    #         },
+    #         'textBlock-paragraph-lg' => {
+    #           font_size: '28px',
+    #         },
+    #         # Replaced by lg variant and palette color
+    #         'textBlock-paragraph-lgAccent' => {
+    #           font_size: '28px',
+    #           color: 'var(--theme-accent-color)'
+    #         },
+    #       },
+    #       properties: {
+    #         root: {
+    #           accent_color: '#e10028',
+    #           palette_color_accent: 'var(--theme-accent-color)'
+    #         }
+    #       }
+    #     )
+    #
+    #     config.legacy_typography_variants = {
+    #       'accent' => {
+    #         palette_color: 'accent'
+    #       },
+    #       'lgAccent' => {
+    #         variant: 'lg',
+    #         palette_color: 'accent'
+    #       }
+    #     }
+    #
+    # @since 16.1
+    attr_accessor :legacy_typography_variants
+
     def initialize(*)
       super
       @additional_frontend_packs = AdditionalPacks.new
       @additional_editor_packs = AdditionalPacks.new
 
       @additional_frontend_seed_data = AdditionalSeedData.new
+      @content_element_consent_vendors = ContentElementConsentVendors.new
+      @consent_vendor_host_matchers = {}
+
+      @legacy_typography_variants = {}
     end
   end
 end

data/entry_types/scrolled/lib/pageflow_scrolled/content_element_consent_vendors.rb

@@ -0,0 +1,38 @@
+module PageflowScrolled
+  # Register consent vendors based on content element configuration
+  # data.
+  class ContentElementConsentVendors
+    # @api private
+    def initialize
+      @callables = {}
+    end
+
+    # Register callable to determine consent vendor from configuration
+    # attributes for a content element type.
+    #
+    # @param callable [#call]
+    #   Receives configuration keyword argument and returns
+    # @param content_element_type_name [String]
+    def register(callable, content_element_type_name:)
+      @callables[content_element_type_name] = callable
+    end
+
+    # @api private
+    def by_content_element_id(entry)
+      content_elements_with_consent_vendor(entry).each_with_object({}) { |content_element, result|
+        next unless @callables[content_element.type_name]
+
+        result[content_element.id] = @callables[content_element.type_name].call(
+          entry: entry,
+          configuration: content_element.configuration
+        )
+      }.compact
+    end
+
+    private
+
+    def content_elements_with_consent_vendor(entry)
+      ContentElement.all_for_revision(entry.revision).where(type_name: @callables.keys)
+    end
+  end
+end

data/entry_types/scrolled/lib/pageflow_scrolled/engine.rb

@@ -1,11 +1,27 @@
 require 'rails'
+require 'pageflow/rails_version'
 
 module PageflowScrolled
   # Rails integration
   class Engine < ::Rails::Engine
     isolate_namespace PageflowScrolled
 
-    config.paths.add('lib', eager_load: true)
+    if Pageflow::RailsVersion.experimental?
+      lib = root.join('lib')
+
+      config.autoload_paths << lib
+      config.eager_load_paths << lib
+
+      initializer 'pageflow_scrolled.autoloading' do
+        Rails.autoloaders.main.ignore(
+          lib.join('generators'),
+          lib.join('tasks')
+        )
+      end
+    else
+      config.paths.add('lib', eager_load: true)
+    end
+
     config.i18n.load_path += Dir[config.root.join('config', 'locales', '**', '*.yml').to_s]
 
     initializer 'pageflow_scrolled.assets.precompile' do |app|

data/entry_types/scrolled/lib/pageflow_scrolled/plugin.rb

@@ -10,25 +10,49 @@ module PageflowScrolled
         c.file_types.register(Pageflow::BuiltInFileType.image)
         c.file_types.register(Pageflow::BuiltInFileType.video)
         c.file_types.register(Pageflow::BuiltInFileType.audio)
+        c.file_types.register(Pageflow::BuiltInFileType.other)
 
         c.revision_components.register(Storyline)
 
         c.widget_types.register(ReactWidgetType.new(name: 'defaultNavigation',
                                                     role: 'header'),
                                 default: true)
+        c.widget_types.register(ReactWidgetType.new(name: 'consentBar',
+                                                    role: 'consent'),
+                                default: true)
 
         c.features.register('datawrapper_chart_embed_opt_in')
         c.features.enable_by_default('datawrapper_chart_embed_opt_in')
         c.features.register('iframe_embed_content_element')
+        c.features.register('image_gallery_content_element')
         c.features.register('frontend_v2')
+        c.features.register('scrolled_entry_fragment_caching')
 
         c.additional_frontend_seed_data.register(
           'frontendVersion',
           FRONTEND_VERSION_SEED_DATA
         )
+
+        c.content_element_consent_vendors.register(
+          IFRAME_EMBED_CONSENT_VENDOR,
+          content_element_type_name: 'iframeEmbed'
+        )
       end
     end
 
+    IFRAME_EMBED_CONSENT_VENDOR = lambda do |configuration:, entry:, **|
+      return unless configuration['requireConsent']
+
+      uri = URI.parse(configuration['source'])
+      host_matchers = Pageflow.config_for(entry).consent_vendor_host_matchers
+
+      host_matchers.detect do |matcher, _|
+        uri.host =~ matcher
+      end&.last
+    rescue URI::InvalidURIError
+      nil
+    end
+
     FRONTEND_VERSION_SEED_DATA = lambda do |request:, entry:, **|
       if request.params[:frontend] == 'v2' || entry.feature_state('frontend_v2')
         2

data/entry_types/scrolled/lib/pageflow_scrolled/react_widget_type.rb

@@ -8,9 +8,10 @@ module PageflowScrolled
   #
   # @since 15.7
   class ReactWidgetType < Pageflow::WidgetType
-    def initialize(role:, name:)
+    def initialize(role:, name:, enabled_in_editor: true)
       @role = role
       @name = name
+      @enabled_in_editor = enabled_in_editor
     end
 
     attr_reader :name
@@ -23,6 +24,10 @@ module PageflowScrolled
       [@role]
     end
 
+    def enabled_in_editor?
+      @enabled_in_editor
+    end
+
     def render(*)
       ''
     end

data/entry_types/scrolled/lib/tasks/pageflow_scrolled/storybook.rake

@@ -33,8 +33,7 @@ namespace :pageflow_scrolled do
 
         account = seeds.account(name: 'storybook-seed') do |account_in_progress|
           account_in_progress.features_configuration =
-            account_in_progress.features_configuration.merge('scrolled_entry_type' => true,
-                                                             'frontend_v2' => true)
+            account_in_progress.features_configuration.merge('scrolled_entry_type' => true)
         end
 
         seeds.sample_scrolled_entry(