katalyst-koi 4.5.0 → 4.5.2

data/app/assets/javascripts/koi/controllers/clipboard_controller.js

@@ -0,0 +1,23 @@
+import { Controller } from "@hotwired/stimulus";
+
+export default class ClipboardController extends Controller {
+  static targets = ["source"];
+
+  static classes = ["supported"];
+
+  connect() {
+    if ("clipboard" in navigator) {
+      this.element.classList.add(this.supportedClass);
+    }
+  }
+
+  copy(event) {
+    event.preventDefault();
+    navigator.clipboard.writeText(this.sourceTarget.value);
+
+    this.element.classList.add("copied");
+    setTimeout(() => {
+      this.element.classList.remove("copied");
+    }, 2000);
+  }
+}

data/app/assets/stylesheets/koi/components/_clipboard.scss

@@ -0,0 +1,46 @@
+.copy-to-clipboard {
+  position: relative;
+
+  .copy-to-clipboard-feedback {
+    animation: ease-in-out 0.5s;
+    display: none;
+    position: absolute;
+    top: 0;
+    right: 0;
+    left: 0;
+    margin-top: -1em;
+    z-index: 10;
+    white-space: nowrap;
+    text-align: center;
+
+    &:after {
+      content: "Link copied to your clipboard!";
+      display: inline-block;
+      padding: 0.33em 1em 0.33em 1em;
+      border-radius: 3rem;
+      color: white;
+      background-color: black;
+    }
+  }
+
+  &.copied .copy-to-clipboard-feedback {
+    display: block;
+  }
+
+  .clipboard-button {
+    display: none;
+  }
+
+  &.clipboard--supported .clipboard-button {
+    display: initial;
+  }
+}
+
+.actions .action.copy-to-clipboard {
+  display: flex;
+  flex: auto;
+
+  input[type="text"] {
+    flex: auto;
+  }
+}

data/app/assets/stylesheets/koi/components/_index.scss

@@ -1,4 +1,5 @@
 @use "actions-group";
+@use "clipboard";
 @use "document-field";
 @use "image-field";
 @use "index-actions";

data/app/assets/stylesheets/koi/layouts/_navigation.scss

@@ -4,7 +4,6 @@ $separator: rgba(255, 255, 255, 0.2);
 %subheading {
   color: $heading;
   font-size: 0.8rem;
-  text-transform: uppercase;
   font-weight: 400;
   margin: 0;
 }

data/app/assets/stylesheets/koi/pages/_login.scss

@@ -1,4 +1,5 @@
 @use "../layouts/navigation" as nav;
+@use "../layouts/flash";
 
 .admin-login {
   display: flex;
@@ -38,3 +39,8 @@
 .admin-login .button--primary {
   flex: 1;
 }
+
+.admin-login .govuk-error-summary {
+  padding: 15px;
+  margin-bottom: 30px;
+}

data/app/assets/stylesheets/koi/themes/_content.scss

@@ -3,3 +3,41 @@
 [data-controller="content--editor--container"] {
   --heading--h4: 1rem;
 }
+
+[data-controller="content--editor--table"] {
+  .content--editor--table-editor {
+    // ensure the table editor is easy to target when empty
+    &:not(:has(table)) {
+      min-height: 4rem !important;
+    }
+
+    // tight wrap the table editor around the table and use table borders
+    &:has(table) {
+      border: none !important;
+      padding: 0 !important;
+    }
+
+    table {
+      width: 100%;
+    }
+
+    table,
+    th,
+    td {
+      border: 2px solid black;
+    }
+  }
+
+  // restore webkit spinners, hidden by govuk
+  // these are not ideal, but spinners are much easier to work with for this
+  // use case than the default number input, because we submit the form on
+  // change to implement the live preview
+  input[type="number"]::-webkit-inner-spin-button {
+    position: relative;
+    right: -1px;
+    margin-top: -2px;
+    margin-bottom: -4px;
+    -webkit-appearance: inner-spin-button !important;
+    opacity: 1 !important;
+  }
+}

data/app/components/koi/content/editor/item_form_component.html.erb

@@ -1,4 +1,4 @@
-<%= form_with model:, scope: :item, url:, builder: do |form| %>
+<%= form_with model:, scope: :item, url:, builder:, **html_attributes do |form| %>
   <%= form.hidden_field :container_type %>
   <%= form.hidden_field :container_id %>
   <%= form.hidden_field :type %>

data/app/components/koi/content/editor/item_form_component.rb

@@ -4,10 +4,12 @@ module Koi
   module Content
     module Editor
       class ItemFormComponent < ViewComponent::Base
+        include Katalyst::HtmlAttributes
+
         attr_reader :model, :url, :builder, :form
 
-        def initialize(model:, url:, builder: Koi::FormBuilder)
-          super()
+        def initialize(model:, url:, builder: Koi::FormBuilder, **)
+          super(**)
 
           @model   = model
           @url     = url

data/app/controllers/admin/tokens_controller.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Admin
+  class TokensController < ApplicationController
+    include Koi::Controller::JsonWebToken
+
+    skip_before_action :authenticate_admin, only: %i[show update]
+    before_action :set_token, only: %i[show update]
+
+    def create
+      admin = Admin::User.find(params[:id])
+      token = encode_token(admin_id: admin.id, exp: 5.minutes.from_now.to_i, iat: Time.current.to_i)
+
+      render locals: { token: }
+    end
+
+    def update
+      return redirect_to admin_dashboard_path, status: :see_other if admin_signed_in?
+
+      return redirect_to new_admin_session_path, status: :see_other, notice: "invalid token" if @token.blank?
+
+      admin = Admin::User.find(@token[:admin_id])
+      sign_in_admin(admin)
+
+      redirect_to admin_admin_user_path(admin)
+    end
+
+    def show
+      return redirect_to new_admin_session_path, notice: "Token invalid or consumed already" if @token.blank?
+
+      admin = Admin::User.find(@token[:admin_id])
+
+      if token_utilised?(admin, @token)
+        return redirect_to new_admin_session_path, notice: "Token invalid or consumed already"
+      end
+
+      render locals: { admin:, token: params[:token] }, layout: "koi/login"
+    end
+
+    private
+
+    def set_token
+      @token = decode_token(params[:token])
+    end
+
+    def token_utilised?(admin, token)
+      admin.current_sign_in_at.present? || (admin.last_sign_in_at.present? && admin.last_sign_in_at.to_i > token[:iat])
+    end
+
+    def sign_in_admin(admin)
+      admin.current_sign_in_at = Time.current
+      admin.current_sign_in_ip = request.remote_ip
+      admin.sign_in_count      = 1
+
+      # disable validations to allow saving without password or passkey credentials
+      admin.save!(validate: false)
+      session[:admin_user_id] = admin.id
+    end
+  end
+end

data/app/controllers/concerns/koi/controller/json_web_token.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Koi
+  module Controller
+    module JsonWebToken
+      extend ActiveSupport::Concern
+
+      SECRET_KEY = Rails.application.secret_key_base
+
+      def encode_token(**payload)
+        JWT.encode(payload, SECRET_KEY)
+      end
+
+      def decode_token(token)
+        payload = JWT.decode(token, SECRET_KEY)[0]
+        HashWithIndifferentAccess.new(payload)
+      rescue JWT::DecodeError
+        nil
+      end
+    end
+  end
+end

data/app/models/admin/user.rb

@@ -8,7 +8,8 @@ module Admin
       ActiveModel::Name.new(self, nil, "Admin")
     end
 
-    has_secure_password :password
+    # disable validations for password_digest
+    has_secure_password validations: false
 
     has_many :credentials, inverse_of: :admin, class_name: "Admin::Credential", dependent: :destroy
 

data/app/views/admin/admin_users/show.html.erb

@@ -2,12 +2,12 @@
   <%= render Koi::Header::ShowComponent.new(resource: admin) %>
 <% end %>
 
-<%= definition_list(class: "item-table") do |builder| %>
-  <%= builder.item admin, :name %>
-  <%= builder.item admin, :email %>
-  <%= builder.item admin, :created_at %>
-  <%= builder.item admin, :last_sign_in_at, label: { text: "Last sign in" } %>
-  <%= builder.item admin, :archived? %>
+<%= render Koi::SummaryListComponent.new(model: admin, class: "item-table") do |builder| %>
+  <%= builder.text :name %>
+  <%= builder.text :email %>
+  <%= builder.datetime :created_at %>
+  <%= builder.datetime :last_sign_in_at, label: { text: "Last sign in" } %>
+  <%= builder.boolean :archived? %>
 <% end %>
 
 <div class="actions">
@@ -17,6 +17,7 @@
                   method: :delete,
                   form:   { data: { turbo_confirm: "Are you sure?" } } %>
   <% end %>
+  <%= button_to "Generate login link", invite_admin_admin_user_path(admin), class: "button button--primary", form: { id: "invite" } %>
 </div>
 
 <h2>Authentication</h2>

data/app/views/admin/sessions/new.html.erb

@@ -7,6 +7,15 @@
         webauthn_authentication_options_value: { publicKey: webauthn_auth_options },
       },
     ) do |f| %>
+  <% unless flash.empty? %>
+    <div class="govuk-error-summary">
+      <ul class="govuk-error-summary__list">
+        <% flash.each do |_, message| %>
+          <%= tag.li message %>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
   <%= f.govuk_fieldset legend: nil do %>
     <%= f.govuk_email_field :email, autofocus: true, autocomplete: "email" %>
     <%= f.govuk_password_field :password, autocomplete: "current-password" %>

data/app/views/admin/tokens/create.turbo_stream.erb

@@ -0,0 +1,9 @@
+<%= turbo_stream.replace "invite" do %>
+  <div class="action copy-to-clipboard govuk-input__wrapper" data-controller="clipboard" data-clipboard-supported-class="clipboard--supported">
+    <%= text_field_tag :invite_link, admin_token_url(token), readonly: true, data: { clipboard_target: "source" } %>
+    <button class="govuk-input__suffix clipboard-button" aria-hidden="true" data-action="clipboard#copy">
+      Copy link
+    </button>
+    <div class="copy-to-clipboard-feedback" role="alert"></div>
+  </div>
+<% end %>

data/app/views/admin/tokens/show.html.erb

@@ -0,0 +1,13 @@
+<%= render "layouts/koi/navigation_header" %>
+
+<%= form_with(url: accept_admin_session_path) do |form| %>
+  <%= tag.input name: :token, type: :hidden, value: token %>
+  <p>Welcome to Koi Admin</p>
+  <%= render Koi::SummaryListComponent.new(model: admin, class: "item-table") do |builder| %>
+    <%= builder.text :name %>
+    <%= builder.text :email %>
+  <% end %>
+  <div class="actions-group">
+    <%= form.admin_save "Sign in" %>
+  </div>
+<% end %>

data/app/views/katalyst/content/tables/_table.html+form.erb

@@ -0,0 +1,41 @@
+<%= render Koi::Content::Editor::ItemFormComponent.new(model: table, url: path, data: { controller: "content--editor--table" }) do |form| %>
+  <%= form.content_heading_fieldset %>
+
+  <div class="govuk-form-group">
+    <label for="item-content-field" class="govuk-label govuk-label--s">Content</label>
+    <% content = sanitize_content_table(normalize_content_table(form.object, heading: false)) %>
+    <div class="govuk-textarea content--editor--table-editor"
+         contenteditable="true"
+         data-content--editor--table-target="content"
+         data-action="paste->content--editor--table#paste"
+         id="item-content-field">
+      <%= content %>
+    </div>
+    <%= form.hidden_field :content, value: content, data: { content__editor__table_target: "input" } %>
+  </div>
+
+  <%# hidden button to receive <Enter> events (HTML-default is to click first button in form) %>
+  <%= form.button "Save", hidden: "" %>
+
+  <%# hidden button to submit the table for re-rendering %>
+  <%= form.button "Update",
+                  formaction: table.persisted? ? content_routes.table_path : content_routes.tables_path,
+                  hidden:     "",
+                  data:       { content__editor__table_target: "update" } %>
+
+  <%= form.govuk_number_field :heading_rows,
+                              label:       { text: "Heading rows" },
+                              width:       2,
+                              placeholder: 0,
+                              min:         0,
+                              data:        { content__editor__table_target: "headerRows",
+                                             action:                        "input->content--editor--table#update" } %>
+
+  <%= form.govuk_number_field :heading_columns,
+                              label:       { text: "Heading columns" },
+                              width:       2,
+                              placeholder: 0,
+                              min:         0,
+                              data:        { content__editor__table_target: "headerColumns",
+                                             action:                        "input->content--editor--table#update" } %>
+<% end %>

data/app/views/layouts/koi/_navigation.html.erb

@@ -2,7 +2,7 @@
      data-action="shortcut:go@document->navigation#focus
      navigation:toggle@document->navigation#toggle
      shortcut:nav-toggle@document->navigation#toggle">
-  <%= render "layouts/koi/navigation_header" %>
+  <%= render "layouts/koi/navigation_header", admin: current_admin %>
   <div class="filter">
     <input type="search" placeholder="Filter menu" autocomplete="off"
            data-navigation-target="filter"

data/app/views/layouts/koi/_navigation_header.html.erb

@@ -1,6 +1,11 @@
 <header>
   <h2 class="site-name"><%= URI.parse(root_url).host %></h2>
-  <h3 class="admin-name">Koi Admin</h3>
+  <%# show username on nav header and Koi Admin on login page %>
+  <% if local_assigns[:admin].present? %>
+    <%= link_to admin.name, main_app.admin_admin_user_path(admin), class: "admin-name" %>
+  <% else %>
+    <h3 class="admin-name">Koi Admin</h3>
+  <% end %>
   <%# default, prefer using an icon in a Koi override %>
   <span class="site-icon"><%= URI.parse(root_url).host[0] %></span>
 </header>

data/config/routes.rb

@@ -2,13 +2,20 @@
 
 Rails.application.routes.draw do
   namespace :admin do
-    resource :session, only: %i[new create destroy]
+    resource :session, only: %i[new create destroy] do
+      post :accept, to: "tokens#update"
+    end
 
     resources :url_rewrites
     resources :admin_users do
       resources :credentials, only: %i[new create destroy]
+      post :invite, on: :member, to: "tokens#create"
     end
 
+    # JWT tokens have dots(represents the 3 parts of data) in them, so we need to allow them in the URL
+    # can by pass if we use token as a query param
+    get "token/:token", to: "tokens#show", as: :token, token: /[^\/]+/
+
     resource :cache, only: %i[destroy]
     resource :dashboard, only: %i[show]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-koi
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.5.2
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -204,6 +204,7 @@ files:
 - Upgrade.md
 - app/assets/builds/koi/admin.css
 - app/assets/builds/koi/admin.css.map
+- app/assets/builds/koi/assets.css
 - app/assets/builds/koi/nav_items.css
 - app/assets/config/koi.js
 - app/assets/images/koi/application/chevron-right.svg
@@ -236,6 +237,7 @@ files:
 - app/assets/images/koi/application/sort-descending.png
 - app/assets/javascripts/koi/admin.js
 - app/assets/javascripts/koi/controllers/application.js
+- app/assets/javascripts/koi/controllers/clipboard_controller.js
 - app/assets/javascripts/koi/controllers/document_field_controller.js
 - app/assets/javascripts/koi/controllers/file_field_controller.js
 - app/assets/javascripts/koi/controllers/flash_controller.js
@@ -260,6 +262,7 @@ files:
 - app/assets/stylesheets/koi/base/_list.scss
 - app/assets/stylesheets/koi/base/_typography.scss
 - app/assets/stylesheets/koi/components/_actions-group.scss
+- app/assets/stylesheets/koi/components/_clipboard.scss
 - app/assets/stylesheets/koi/components/_document-field.scss
 - app/assets/stylesheets/koi/components/_image-field.scss
 - app/assets/stylesheets/koi/components/_index-actions.scss
@@ -326,10 +329,12 @@ files:
 - app/controllers/admin/credentials_controller.rb
 - app/controllers/admin/dashboards_controller.rb
 - app/controllers/admin/sessions_controller.rb
+- app/controllers/admin/tokens_controller.rb
 - app/controllers/admin/url_rewrites_controller.rb
 - app/controllers/concerns/koi/controller/has_admin_users.rb
 - app/controllers/concerns/koi/controller/has_webauthn.rb
 - app/controllers/concerns/koi/controller/is_admin_controller.rb
+- app/controllers/concerns/koi/controller/json_web_token.rb
 - app/helpers/koi/application_helper.rb
 - app/helpers/koi/date_helper.rb
 - app/helpers/koi/definition_list_helper.rb
@@ -357,6 +362,8 @@ files:
 - app/views/admin/shared/icons/_cross.html.erb
 - app/views/admin/shared/icons/_menu.html.erb
 - app/views/admin/shared/icons/_refresh.html.erb
+- app/views/admin/tokens/create.turbo_stream.erb
+- app/views/admin/tokens/show.html.erb
 - app/views/admin/url_rewrites/_fields.html.erb
 - app/views/admin/url_rewrites/_url_rewrite.html+row.erb
 - app/views/admin/url_rewrites/edit.html.erb
@@ -370,6 +377,7 @@ files:
 - app/views/katalyst/content/groups/_group.html+form.erb
 - app/views/katalyst/content/items/_item.html+form.erb
 - app/views/katalyst/content/sections/_section.html+form.erb
+- app/views/katalyst/content/tables/_table.html+form.erb
 - app/views/katalyst/navigation/items/_button.html.erb
 - app/views/katalyst/navigation/items/_heading.html.erb
 - app/views/katalyst/navigation/items/_link.html.erb