Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add JSON preview for objects in the admin dashboard (#13171)

Damian Legawiec611448ffd394
diff --git a/admin/app/assets/stylesheets/spree/admin/application.scss b/admin/app/assets/stylesheets/spree/admin/application.scss
index 63d953d707..9b015aaacc 100644
--- a/admin/app/assets/stylesheets/spree/admin/application.scss
+++ b/admin/app/assets/stylesheets/spree/admin/application.scss
@@ -35,6 +35,7 @@
@import url('https://esm.sh/@uppy/[email protected]/dist/style.min.css');
@import url('https://esm.sh/[email protected]/animate.min.css');
@import url('https://esm.sh/@simonwep/[email protected]/dist/themes/classic.min.css');
+@import url('https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/github-dark.min.css');
@import 'plugins/uppy_fixes';
diff --git a/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss b/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss
index 8d5c1cc12e..1785add8c3 100644
--- a/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss
+++ b/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss
@@ -58,8 +58,8 @@ dialog:open {
top: 0;
right: 0;
left: auto;
- height: calc(100vh - 2rem);
- max-height: calc(100vh - 2rem);
+ height: calc(100dvh - 2rem);
+ max-height: calc(100dvh - 2rem);
width: calc(100vw - 2rem);
max-width: 600px;
min-width: 320px;
diff --git a/admin/app/controllers/spree/admin/json_previews_controller.rb b/admin/app/controllers/spree/admin/json_previews_controller.rb
new file mode 100644
index 0000000000..1f129cfff8
--- /dev/null
+++ b/admin/app/controllers/spree/admin/json_previews_controller.rb
@@ -0,0 +1,38 @@
+module Spree
+ module Admin
+ class JsonPreviewsController < BaseController
+ before_action :load_resource
+
+ def show
+ @api_type = params[:api_type].presence&.to_sym || :storefront
+ end
+
+ private
+
+ def load_resource
+ raise ActiveRecord::RecordNotFound if params[:resource_type].blank?
+ raise ActiveRecord::RecordNotFound if resource_type.blank?
+
+ @resource = if resource_type.respond_to?(:friendly)
+ resource_type.friendly.find(params[:id])
+ else
+ resource_type.find(params[:id])
+ end
+ end
+
+ def resource_type
+ @resource_type ||= begin
+ klass_name = params[:resource_type]
+ # Ensure all Spree models are loaded so that descendants is complete
+ Rails.application.eager_load! unless Rails.application.config.eager_load
+ klass = Spree.base_class.descendants.find { |spree_klass| spree_klass.name.to_s == klass_name }
+ klass ||= Spree.user_class if klass_name == Spree.user_class.to_s
+ klass ||= Spree.admin_user_class if klass_name == Spree.admin_user_class.to_s
+ klass
+ rescue NameError
+ nil
+ end
+ end
+ end
+ end
+end
diff --git a/admin/app/helpers/spree/admin/json_preview_helper.rb b/admin/app/helpers/spree/admin/json_preview_helper.rb
new file mode 100644
index 0000000000..474c6858f7
--- /dev/null
+++ b/admin/app/helpers/spree/admin/json_preview_helper.rb
@@ -0,0 +1,73 @@
+module Spree
+ module Admin
+ module JsonPreviewHelper
+ def link_to_show_json(record, options = {})
+ return unless json_serializers_available?(record)
+ return unless can?(:read, record)
+
+ options[:class] ||= 'dropdown-item'
+ options[:data] ||= { action: 'drawer#open', turbo_frame: :drawer }
+
+ link_to_with_icon(
+ 'code',
+ Spree.t('admin.show_json'),
+ spree.admin_json_preview_resource_path(record, resource_type: record.class.to_s),
+ options
+ )
+ end
+
+ def json_serializers_available?(record)
+ storefront_serializer_exists?(record) || platform_serializer_exists?(record)
+ end
+
+ def storefront_serializer_exists?(record)
+ serializer_class_name = "Spree::V2::Storefront::#{record.class.name.demodulize}Serializer"
+ serializer_class_name.safe_constantize.present?
+ end
+
+ def platform_serializer_exists?(record)
+ serializer_class_name = "Spree::Api::V2::Platform::#{record.class.name.demodulize}Serializer"
+ serializer_class_name.safe_constantize.present?
+ end
+
+ def serialize_to_json(record, api_type: :storefront)
+ return unless record
+
+ serializer = case api_type.to_sym
+ when :storefront
+ storefront_serializer_for(record)
+ when :platform
+ platform_serializer_for(record)
+ end
+
+ return nil unless serializer
+
+ serializable_hash = serializer.new(
+ record,
+ params: serializer_params(record)
+ ).serializable_hash
+
+ JSON.pretty_generate(serializable_hash)
+ end
+
+ private
+
+ def storefront_serializer_for(record)
+ serializer_class_name = "Spree::V2::Storefront::#{record.class.name.demodulize}Serializer"
+ serializer_class_name.safe_constantize
+ end
+
+ def platform_serializer_for(record)
+ serializer_class_name = "Spree::Api::V2::Platform::#{record.class.name.demodulize}Serializer"
+ serializer_class_name.safe_constantize
+ end
+
+ def serializer_params(record)
+ params = {}
+ params[:store] = current_store if defined?(current_store) && current_store.present?
+ params[:currency] = current_currency if defined?(current_currency) && current_currency.present?
+ params
+ end
+ end
+ end
+end
diff --git a/admin/app/javascript/spree/admin/application.js b/admin/app/javascript/spree/admin/application.js
index fde45572fa..50643bf90a 100644
--- a/admin/app/javascript/spree/admin/application.js
+++ b/admin/app/javascript/spree/admin/application.js
@@ -60,6 +60,7 @@ import ColorPickerController from 'spree/admin/controllers/color_picker_controll
import DrawerController from 'spree/admin/controllers/drawer_controller'
import FiltersController from 'spree/admin/controllers/filters_controller'
import FontPickerController from 'spree/admin/controllers/font_picker_controller'
+import HighlightController from 'spree/admin/controllers/highlight_controller'
import MediaFormController from 'spree/admin/controllers/media_form_controller'
import MultiInputController from 'spree/admin/controllers/multi_input_controller'
import MultiTomSelectController from 'spree/admin/controllers/multi_tom_select_controller'
@@ -115,6 +116,7 @@ application.register('dropdown', Dropdown)
application.register('enable-button', EnableButtonController)
application.register('filters', FiltersController)
application.register('font-picker', FontPickerController)
+application.register('highlight', HighlightController)
application.register('media-form', MediaFormController)
application.register('multi-input', MultiInputController)
application.register('multi-tom-select', MultiTomSelectController)
diff --git a/admin/app/javascript/spree/admin/controllers/highlight_controller.js b/admin/app/javascript/spree/admin/controllers/highlight_controller.js
new file mode 100644
index 0000000000..a5ead18e6b
--- /dev/null
+++ b/admin/app/javascript/spree/admin/controllers/highlight_controller.js
@@ -0,0 +1,17 @@
+import { Controller } from '@hotwired/stimulus'
+import hljs from '@highlightjs/cdn-assets/es/core.min.js'
+import json from '@highlightjs/cdn-assets/es/languages/json.min.js'
+
+export default class extends Controller {
+ static targets = ['code']
+
+ connect() {
+ // Register the JSON language
+ hljs.registerLanguage('json', json)
+
+ // Highlight all code blocks
+ this.codeTargets.forEach((block) => {
+ hljs.highlightElement(block)
+ })
+ }
+}
diff --git a/admin/app/views/spree/admin/json_previews/show.html.erb b/admin/app/views/spree/admin/json_previews/show.html.erb
new file mode 100644
index 0000000000..508b2b3095
--- /dev/null
+++ b/admin/app/views/spree/admin/json_previews/show.html.erb
@@ -0,0 +1,29 @@
+<%= turbo_frame_tag :drawer do %>
+ <%= drawer_header(Spree.t('admin.show_json')) %>
+ <div class="drawer-body">
+ <ul class="nav nav-pills">
+ <%= nav_item(
+ Spree.t('apis.storefront'),
+ spree.admin_json_preview_resource_path(@resource, resource_type: @resource.class.to_s, api_type: :storefront),
+ active: (@api_type == :storefront)
+ ) %>
+ <%= nav_item(
+ Spree.t('apis.platform'),
+ spree.admin_json_preview_resource_path(@resource, resource_type: @resource.class.to_s, api_type: :platform),
+ active: (@api_type == :platform)
+ ) %>
+ </ul>
+ </div>
+ <div class="drawer-body pt-0" data-controller="highlight">
+ <% if @api_type == :storefront && storefront_serializer_exists?(@resource) || @api_type == :platform && platform_serializer_exists?(@resource) %>
+ <pre class="m-0"><code data-highlight-target="code" class="language-json d-block overflow-auto" style="height: calc(100dvh - 11rem);"><%= serialize_to_json(@resource, api_type: @api_type) %></code></pre>
+ <% else %>
+ <div class="text-muted p-5 d-flex align-items-center w-100 justify-content-center flex-column">
+ <%= icon 'map-search', class: 'mb-3 opacity-50', style: 'font-size: 2rem;' %>
+ <p>
+ <%= Spree.t('admin.json_preview.no_api_response') %>
+ </p>
+ </div>
+ <% end %>
+ </div>
+<% end %>
diff --git a/admin/app/views/spree/admin/shared/_content_header.html.erb b/admin/app/views/spree/admin/shared/_content_header.html.erb
index 6ff686b7b7..37fcb599ae 100644
--- a/admin/app/views/spree/admin/shared/_content_header.html.erb
+++ b/admin/app/views/spree/admin/shared/_content_header.html.erb
@@ -31,6 +31,7 @@
<% if record && record.persisted? %>
<%= link_to_edit_metafields(record) %>
<%= link_to_edit_translations(record) %>
+ <%= link_to_show_json(record) %>
<% if record.respond_to?(:audits) && spree.respond_to?(:admin_audits_path) && defined?(Audited) && can?(:read, Audited.audit_class) %>
<a href="<%= spree.admin_audits_path(q: { auditable_id_eq: record.id, auditable_type_eq: record.class.to_s }) %>" target="_blank" class="dropdown-item">
diff --git a/admin/config/importmap.rb b/admin/config/importmap.rb
index c03438603d..94c5ec51bb 100644
--- a/admin/config/importmap.rb
+++ b/admin/config/importmap.rb
@@ -162,6 +162,10 @@ pin "crelt" # @1.0.6
pin "style-mod" # @4.1.2
pin "w3c-keyname" # @2.2.8
+# Highlight.js
+pin "@highlightjs/cdn-assets/es/core.min.js", to: "@highlightjs--cdn-assets--es--core.min.js.js" # @11.11.1
+pin "@highlightjs/cdn-assets/es/languages/json.min.js", to: "@highlightjs--cdn-assets--es--languages--json.min.js.js" # @11.11.1
+
pin_all_from Spree::Admin::Engine.root.join('app/javascript/spree/admin/controllers'),
under: 'spree/admin/controllers',
to: 'spree/admin/controllers',
diff --git a/admin/config/locales/en.yml b/admin/config/locales/en.yml
index 6742ed1bd0..2c4e80944c 100644
--- a/admin/config/locales/en.yml
+++ b/admin/config/locales/en.yml
@@ -94,6 +94,8 @@ en:
integrations:
invalid_integration_type: This integration is not allowed
page_subtitle: Connect your store to third-party services to enhance customer experience.
+ json_preview:
+ no_api_response: No API response found for this resource
manage_currencies: Manage Currencies
manage_properties: Manage Properties
manage_stock_locations: Manage Stock Locations
@@ -214,6 +216,7 @@ en:
please_provide_tracking_details: Before marking shipment as shipped please provide tracking details
shipment_transfer:
wrong_destination: Wrong destination
+ show_json: Show JSON
stock_transfers:
add_products_tip: You need to select a destination location first
store_credit:
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index 8d31284a6c..e63984956b 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -140,6 +140,9 @@ Spree::Core::Engine.add_routes do
resources :metafields, only: [:edit, :update], path: '/metafields/:resource_type'
resources :metafield_definitions, except: :show
+ # json preview
+ resources :json_previews, only: [:show], path: '/json_preview/:resource_type', as: :json_preview_resource
+
# audit log
resources :exports, only: [:index, :new, :create, :show]
diff --git a/admin/spec/controllers/spree/admin/json_previews_controller_spec.rb b/admin/spec/controllers/spree/admin/json_previews_controller_spec.rb
new file mode 100644
index 0000000000..5a602d857f
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/json_previews_controller_spec.rb
@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::JsonPreviewsController, type: :controller do
+ stub_authorization!
+ render_views
+
+ let(:product) { create(:product) }
+ let(:resource_type) { 'Spree::Product' }
+
+ describe 'GET #show' do
+ it 'assigns @resource and renders the show template' do
+ get :show, params: { resource_type: resource_type, id: product.slug }
+ expect(response).to render_template(:show)
+ expect(assigns(:resource)).to eq(product)
+ expect(assigns(:api_type)).to eq(:storefront)
+ end
+
+ context 'with api_type param' do
+ it 'assigns @api_type as symbol' do
+ get :show, params: { resource_type: resource_type, id: product.slug, api_type: 'platform' }
+ expect(assigns(:api_type)).to eq(:platform)
+ end
+ end
+
+ context 'when resource_type is missing' do
+ it 'raises ActiveRecord::RecordNotFound' do
+ expect {
+ get :show, params: { id: product.slug, resource_type: '' }
+ }.to raise_error(ActiveRecord::RecordNotFound)
+ end
+ end
+
+ context 'when resource_type is invalid' do
+ it 'raises ActiveRecord::RecordNotFound' do
+ expect {
+ get :show, params: { resource_type: 'InvalidType', id: product.slug }
+ }.to raise_error(ActiveRecord::RecordNotFound)
+ end
+ end
+ end
+end
diff --git a/admin/vendor/javascript/@highlightjs--cdn-assets--es--core.min.js.js b/admin/vendor/javascript/@highlightjs--cdn-assets--es--core.min.js.js
new file mode 100644
index 0000000000..8e2a05ac9b
--- /dev/null
+++ b/admin/vendor/javascript/@highlightjs--cdn-assets--es--core.min.js.js
@@ -0,0 +1,308 @@
+// @highlightjs/cdn-assets/es/[email protected] downloaded from https://cdn.jsdelivr.net/npm/@highlightjs/[email protected]/es/core.min.js
+
+/*!
+ Highlight.js v11.11.1 (git: 08cb242e7d)
+ (c) 2006-2024 Josh Goebel <[email protected]> and other contributors
+ License: BSD-3-Clause
+ */
+function e(t){return t instanceof Map?t.clear=t.delete=t.set=()=>{
+throw Error("map is read-only")}:t instanceof Set&&(t.add=t.clear=t.delete=()=>{
+throw Error("set is read-only")
+}),Object.freeze(t),Object.getOwnPropertyNames(t).forEach((n=>{
+const i=t[n],s=typeof i;"object"!==s&&"function"!==s||Object.isFrozen(i)||e(i)
+})),t}class t{constructor(e){
+void 0===e.data&&(e.data={}),this.data=e.data,this.isMatchIgnored=!1}
+ignoreMatch(){this.isMatchIgnored=!0}}function n(e){
+return e.replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;").replace(/"/g,"&quot;").replace(/'/g,"&#x27;")
+}function i(e,...t){const n=Object.create(null);for(const t in e)n[t]=e[t]
+;return t.forEach((e=>{for(const t in e)n[t]=e[t]})),n}const s=e=>!!e.scope
+;class r{constructor(e,t){
+this.buffer="",this.classPrefix=t.classPrefix,e.walk(this)}addText(e){
+this.buffer+=n(e)}openNode(e){if(!s(e))return;const t=((e,{prefix:t})=>{
+if(e.startsWith("language:"))return e.replace("language:","language-")
+;if(e.includes(".")){const n=e.split(".")
+;return[`${t}${n.shift()}`,...n.map(((e,t)=>`${e}${"_".repeat(t+1)}`))].join(" ")
+}return`${t}${e}`})(e.scope,{prefix:this.classPrefix});this.span(t)}
+closeNode(e){s(e)&&(this.buffer+="</span>")}value(){return this.buffer}span(e){
+this.buffer+=`<span class="${e}">`}}const o=(e={})=>{const t={children:[]}
+;return Object.assign(t,e),t};class a{constructor(){
+this.rootNode=o(),this.stack=[this.rootNode]}get top(){
+return this.stack[this.stack.length-1]}get root(){return this.rootNode}add(e){
+this.top.children.push(e)}openNode(e){const t=o({scope:e})
+;this.add(t),this.stack.push(t)}closeNode(){
+if(this.stack.length>1)return this.stack.pop()}closeAllNodes(){
+for(;this.closeNode(););}toJSON(){return JSON.stringify(this.rootNode,null,4)}
+walk(e){return this.constructor._walk(e,this.rootNode)}static _walk(e,t){
+return"string"==typeof t?e.addText(t):t.children&&(e.openNode(t),
+t.children.forEach((t=>this._walk(e,t))),e.closeNode(t)),e}static _collapse(e){
+"string"!=typeof e&&e.children&&(e.children.every((e=>"string"==typeof e))?e.children=[e.children.join("")]:e.children.forEach((e=>{
+a._collapse(e)})))}}class c extends a{constructor(e){super(),this.options=e}
+addText(e){""!==e&&this.add(e)}startScope(e){this.openNode(e)}endScope(){
+this.closeNode()}__addSublanguage(e,t){const n=e.root
+;t&&(n.scope="language:"+t),this.add(n)}toHTML(){
+return new r(this,this.options).value()}finalize(){
+return this.closeAllNodes(),!0}}function l(e){
+return e?"string"==typeof e?e:e.source:null}function g(e){return h("(?=",e,")")}
+function u(e){return h("(?:",e,")*")}function d(e){return h("(?:",e,")?")}
+function h(...e){return e.map((e=>l(e))).join("")}function f(...e){const t=(e=>{
+const t=e[e.length-1]
+;return"object"==typeof t&&t.constructor===Object?(e.splice(e.length-1,1),t):{}
+})(e);return"("+(t.capture?"":"?:")+e.map((e=>l(e))).join("|")+")"}
+function p(e){return RegExp(e.toString()+"|").exec("").length-1}
+const b=/\[(?:[^\\\]]|\\.)*\]|\(\??|\\([1-9][0-9]*)|\\./
+;function m(e,{joinWith:t}){let n=0;return e.map((e=>{n+=1;const t=n
+;let i=l(e),s="";for(;i.length>0;){const e=b.exec(i);if(!e){s+=i;break}
+s+=i.substring(0,e.index),
+i=i.substring(e.index+e[0].length),"\\"===e[0][0]&&e[1]?s+="\\"+(Number(e[1])+t):(s+=e[0],
+"("===e[0]&&n++)}return s})).map((e=>`(${e})`)).join(t)}
+const E="[a-zA-Z]\\w*",x="[a-zA-Z_]\\w*",_="\\b\\d+(\\.\\d+)?",y="(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",w="\\b(0b[01]+)",O={
+begin:"\\\\[\\s\\S]",relevance:0},k={scope:"string",begin:"'",end:"'",
+illegal:"\\n",contains:[O]},v={scope:"string",begin:'"',end:'"',illegal:"\\n",
+contains:[O]},N=(e,t,n={})=>{const s=i({scope:"comment",begin:e,end:t,
+contains:[]},n);s.contains.push({scope:"doctag",
+begin:"[ ]*(?=(TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):)",
+end:/(TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):/,excludeBegin:!0,relevance:0})
+;const r=f("I","a","is","so","us","to","at","if","in","it","on",/[A-Za-z]+['](d|ve|re|ll|t|s|n)/,/[A-Za-z]+[-][a-z]+/,/[A-Za-z][a-z]{2,}/)
+;return s.contains.push({begin:h(/[ ]+/,"(",r,/[.]?[:]?([.][ ]|[ ])/,"){3}")}),s
+},S=N("//","$"),M=N("/\\*","\\*/"),R=N("#","$");var A=Object.freeze({
+__proto__:null,APOS_STRING_MODE:k,BACKSLASH_ESCAPE:O,BINARY_NUMBER_MODE:{
+scope:"number",begin:w,relevance:0},BINARY_NUMBER_RE:w,COMMENT:N,
+C_BLOCK_COMMENT_MODE:M,C_LINE_COMMENT_MODE:S,C_NUMBER_MODE:{scope:"number",
+begin:y,relevance:0},C_NUMBER_RE:y,END_SAME_AS_BEGIN:e=>Object.assign(e,{
+"on:begin":(e,t)=>{t.data._beginMatch=e[1]},"on:end":(e,t)=>{
+t.data._beginMatch!==e[1]&&t.ignoreMatch()}}),HASH_COMMENT_MODE:R,IDENT_RE:E,
+MATCH_NOTHING_RE:/\b\B/,METHOD_GUARD:{begin:"\\.\\s*"+x,relevance:0},
+NUMBER_MODE:{scope:"number",begin:_,relevance:0},NUMBER_RE:_,
+PHRASAL_WORDS_MODE:{
+begin:/\b(a|an|the|are|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such|will|you|your|they|like|more)\b/
+},QUOTE_STRING_MODE:v,REGEXP_MODE:{scope:"regexp",begin:/\/(?=[^/\n]*\/)/,
+end:/\/[gimuy]*/,contains:[O,{begin:/\[/,end:/\]/,relevance:0,contains:[O]}]},
+RE_STARTERS_RE:"!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~",
+SHEBANG:(e={})=>{const t=/^#![ ]*\//
+;return e.binary&&(e.begin=h(t,/.*\b/,e.binary,/\b.*/)),i({scope:"meta",begin:t,
+end:/$/,relevance:0,"on:begin":(e,t)=>{0!==e.index&&t.ignoreMatch()}},e)},
+TITLE_MODE:{scope:"title",begin:E,relevance:0},UNDERSCORE_IDENT_RE:x,
+UNDERSCORE_TITLE_MODE:{scope:"title",begin:x,relevance:0}});function j(e,t){
+"."===e.input[e.index-1]&&t.ignoreMatch()}function I(e,t){
+void 0!==e.className&&(e.scope=e.className,delete e.className)}function T(e,t){
+t&&e.beginKeywords&&(e.begin="\\b("+e.beginKeywords.split(" ").join("|")+")(?!\\.)(?=\\b|\\s)",
+e.__beforeBegin=j,e.keywords=e.keywords||e.beginKeywords,delete e.beginKeywords,
+void 0===e.relevance&&(e.relevance=0))}function L(e,t){
+Array.isArray(e.illegal)&&(e.illegal=f(...e.illegal))}function B(e,t){
+if(e.match){
+if(e.begin||e.end)throw Error("begin & end are not supported with match")
+;e.begin=e.match,delete e.match}}function P(e,t){
+void 0===e.relevance&&(e.relevance=1)}const D=(e,t)=>{if(!e.beforeMatch)return
+;if(e.starts)throw Error("beforeMatch cannot be used with starts")
+;const n=Object.assign({},e);Object.keys(e).forEach((t=>{delete e[t]
+})),e.keywords=n.keywords,e.begin=h(n.beforeMatch,g(n.begin)),e.starts={
+relevance:0,contains:[Object.assign(n,{endsParent:!0})]
+},e.relevance=0,delete n.beforeMatch
+},H=["of","and","for","in","not","or","if","then","parent","list","value"]
+;function C(e,t,n="keyword"){const i=Object.create(null)
+;return"string"==typeof e?s(n,e.split(" ")):Array.isArray(e)?s(n,e):Object.keys(e).forEach((n=>{
+Object.assign(i,C(e[n],t,n))})),i;function s(e,n){
+t&&(n=n.map((e=>e.toLowerCase()))),n.forEach((t=>{const n=t.split("|")
+;i[n[0]]=[e,$(n[0],n[1])]}))}}function $(e,t){
+return t?Number(t):(e=>H.includes(e.toLowerCase()))(e)?0:1}const U={},z=e=>{
+console.error(e)},W=(e,...t)=>{console.log("WARN: "+e,...t)},X=(e,t)=>{
+U[`${e}/${t}`]||(console.log(`Deprecated as of ${e}. ${t}`),U[`${e}/${t}`]=!0)
+},G=Error();function K(e,t,{key:n}){let i=0;const s=e[n],r={},o={}
+;for(let e=1;e<=t.length;e++)o[e+i]=s[e],r[e+i]=!0,i+=p(t[e-1])
+;e[n]=o,e[n]._emit=r,e[n]._multi=!0}function F(e){(e=>{
+e.scope&&"object"==typeof e.scope&&null!==e.scope&&(e.beginScope=e.scope,
+delete e.scope)})(e),"string"==typeof e.beginScope&&(e.beginScope={
+_wrap:e.beginScope}),"string"==typeof e.endScope&&(e.endScope={_wrap:e.endScope
+}),(e=>{if(Array.isArray(e.begin)){
+if(e.skip||e.excludeBegin||e.returnBegin)throw z("skip, excludeBegin, returnBegin not compatible with beginScope: {}"),
+G
+;if("object"!=typeof e.beginScope||null===e.beginScope)throw z("beginScope must be object"),
+G;K(e,e.begin,{key:"beginScope"}),e.begin=m(e.begin,{joinWith:""})}})(e),(e=>{
+if(Array.isArray(e.end)){
+if(e.skip||e.excludeEnd||e.returnEnd)throw z("skip, excludeEnd, returnEnd not compatible with endScope: {}"),
+G
+;if("object"!=typeof e.endScope||null===e.endScope)throw z("endScope must be object"),
+G;K(e,e.end,{key:"endScope"}),e.end=m(e.end,{joinWith:""})}})(e)}function Z(e){
+function t(t,n){
+return RegExp(l(t),"m"+(e.case_insensitive?"i":"")+(e.unicodeRegex?"u":"")+(n?"g":""))
+}class n{constructor(){
+this.matchIndexes={},this.regexes=[],this.matchAt=1,this.position=0}
+addRule(e,t){
+t.position=this.position++,this.matchIndexes[this.matchAt]=t,this.regexes.push([t,e]),
+this.matchAt+=p(e)+1}compile(){0===this.regexes.length&&(this.exec=()=>null)
+;const e=this.regexes.map((e=>e[1]));this.matcherRe=t(m(e,{joinWith:"|"
+}),!0),this.lastIndex=0}exec(e){this.matcherRe.lastIndex=this.lastIndex
+;const t=this.matcherRe.exec(e);if(!t)return null
+;const n=t.findIndex(((e,t)=>t>0&&void 0!==e)),i=this.matchIndexes[n]
+;return t.splice(0,n),Object.assign(t,i)}}class s{constructor(){
+this.rules=[],this.multiRegexes=[],
+this.count=0,this.lastIndex=0,this.regexIndex=0}getMatcher(e){
+if(this.multiRegexes[e])return this.multiRegexes[e];const t=new n
+;return this.rules.slice(e).forEach((([e,n])=>t.addRule(e,n))),
+t.compile(),this.multiRegexes[e]=t,t}resumingScanAtSamePosition(){
+return 0!==this.regexIndex}considerAll(){this.regexIndex=0}addRule(e,t){
+this.rules.push([e,t]),"begin"===t.type&&this.count++}exec(e){
+const t=this.getMatcher(this.regexIndex);t.lastIndex=this.lastIndex
+;let n=t.exec(e)
+;if(this.resumingScanAtSamePosition())if(n&&n.index===this.lastIndex);else{
+const t=this.getMatcher(0);t.lastIndex=this.lastIndex+1,n=t.exec(e)}
+return n&&(this.regexIndex+=n.position+1,
+this.regexIndex===this.count&&this.considerAll()),n}}
+if(e.compilerExtensions||(e.compilerExtensions=[]),
+e.contains&&e.contains.includes("self"))throw Error("ERR: contains `self` is not supported at the top-level of a language. See documentation.")
+;return e.classNameAliases=i(e.classNameAliases||{}),function n(r,o){const a=r
+;if(r.isCompiled)return a
+;[I,B,F,D].forEach((e=>e(r,o))),e.compilerExtensions.forEach((e=>e(r,o))),
+r.__beforeBegin=null,[T,L,P].forEach((e=>e(r,o))),r.isCompiled=!0;let c=null
+;return"object"==typeof r.keywords&&r.keywords.$pattern&&(r.keywords=Object.assign({},r.keywords),
+c=r.keywords.$pattern,
+delete r.keywords.$pattern),c=c||/\w+/,r.keywords&&(r.keywords=C(r.keywords,e.case_insensitive)),
+a.keywordPatternRe=t(c,!0),
+o&&(r.begin||(r.begin=/\B|\b/),a.beginRe=t(a.begin),r.end||r.endsWithParent||(r.end=/\B|\b/),
+r.end&&(a.endRe=t(a.end)),
+a.terminatorEnd=l(a.end)||"",r.endsWithParent&&o.terminatorEnd&&(a.terminatorEnd+=(r.end?"|":"")+o.terminatorEnd)),
+r.illegal&&(a.illegalRe=t(r.illegal)),
+r.contains||(r.contains=[]),r.contains=[].concat(...r.contains.map((e=>(e=>(e.variants&&!e.cachedVariants&&(e.cachedVariants=e.variants.map((t=>i(e,{
+variants:null},t)))),e.cachedVariants?e.cachedVariants:V(e)?i(e,{
+starts:e.starts?i(e.starts):null
+}):Object.isFrozen(e)?i(e):e))("self"===e?r:e)))),r.contains.forEach((e=>{n(e,a)
+})),r.starts&&n(r.starts,o),a.matcher=(e=>{const t=new s
+;return e.contains.forEach((e=>t.addRule(e.begin,{rule:e,type:"begin"
+}))),e.terminatorEnd&&t.addRule(e.terminatorEnd,{type:"end"
+}),e.illegal&&t.addRule(e.illegal,{type:"illegal"}),t})(a),a}(e)}function V(e){
+return!!e&&(e.endsWithParent||V(e.starts))}class q extends Error{
+constructor(e,t){super(e),this.name="HTMLInjectionError",this.html=t}}
+const J=n,Y=i,Q=Symbol("nomatch"),ee=n=>{
+const i=Object.create(null),s=Object.create(null),r=[];let o=!0
+;const a="Could not find the language '{}', did you forget to load/include a language module?",l={
+disableAutodetect:!0,name:"Plain text",contains:[]};let p={
+ignoreUnescapedHTML:!1,throwUnescapedHTML:!1,noHighlightRe:/^(no-?highlight)$/i,
+languageDetectRe:/\blang(?:uage)?-([\w-]+)\b/i,classPrefix:"hljs-",
+cssSelector:"pre code",languages:null,__emitter:c};function b(e){
+return p.noHighlightRe.test(e)}function m(e,t,n){let i="",s=""
+;"object"==typeof t?(i=e,
+n=t.ignoreIllegals,s=t.language):(X("10.7.0","highlight(lang, code, ...args) has been deprecated."),
+X("10.7.0","Please use highlight(code, options) instead.\nhttps://github.com/highlightjs/highlight.js/issues/2277"),
+s=e,i=t),void 0===n&&(n=!0);const r={code:i,language:s};N("before:highlight",r)
+;const o=r.result?r.result:E(r.language,r.code,n)
+;return o.code=r.code,N("after:highlight",o),o}function E(e,n,s,r){
+const c=Object.create(null);function l(){if(!N.keywords)return void M.addText(R)
+;let e=0;N.keywordPatternRe.lastIndex=0;let t=N.keywordPatternRe.exec(R),n=""
+;for(;t;){n+=R.substring(e,t.index)
+;const s=w.case_insensitive?t[0].toLowerCase():t[0],r=(i=s,N.keywords[i]);if(r){
+const[e,i]=r
+;if(M.addText(n),n="",c[s]=(c[s]||0)+1,c[s]<=7&&(A+=i),e.startsWith("_"))n+=t[0];else{
+const n=w.classNameAliases[e]||e;u(t[0],n)}}else n+=t[0]
+;e=N.keywordPatternRe.lastIndex,t=N.keywordPatternRe.exec(R)}var i
+;n+=R.substring(e),M.addText(n)}function g(){null!=N.subLanguage?(()=>{
+if(""===R)return;let e=null;if("string"==typeof N.subLanguage){
+if(!i[N.subLanguage])return void M.addText(R)
+;e=E(N.subLanguage,R,!0,S[N.subLanguage]),S[N.subLanguage]=e._top
+}else e=x(R,N.subLanguage.length?N.subLanguage:null)
+;N.relevance>0&&(A+=e.relevance),M.__addSublanguage(e._emitter,e.language)
+})():l(),R=""}function u(e,t){
+""!==e&&(M.startScope(t),M.addText(e),M.endScope())}function d(e,t){let n=1
+;const i=t.length-1;for(;n<=i;){if(!e._emit[n]){n++;continue}
+const i=w.classNameAliases[e[n]]||e[n],s=t[n];i?u(s,i):(R=s,l(),R=""),n++}}
+function h(e,t){
+return e.scope&&"string"==typeof e.scope&&M.openNode(w.classNameAliases[e.scope]||e.scope),
+e.beginScope&&(e.beginScope._wrap?(u(R,w.classNameAliases[e.beginScope._wrap]||e.beginScope._wrap),
+R=""):e.beginScope._multi&&(d(e.beginScope,t),R="")),N=Object.create(e,{parent:{
+value:N}}),N}function f(e,n,i){let s=((e,t)=>{const n=e&&e.exec(t)
+;return n&&0===n.index})(e.endRe,i);if(s){if(e["on:end"]){const i=new t(e)
+;e["on:end"](n,i),i.isMatchIgnored&&(s=!1)}if(s){
+for(;e.endsParent&&e.parent;)e=e.parent;return e}}
+if(e.endsWithParent)return f(e.parent,n,i)}function b(e){
+return 0===N.matcher.regexIndex?(R+=e[0],1):(T=!0,0)}function m(e){
+const t=e[0],i=n.substring(e.index),s=f(N,e,i);if(!s)return Q;const r=N
+;N.endScope&&N.endScope._wrap?(g(),
+u(t,N.endScope._wrap)):N.endScope&&N.endScope._multi?(g(),
+d(N.endScope,e)):r.skip?R+=t:(r.returnEnd||r.excludeEnd||(R+=t),
+g(),r.excludeEnd&&(R=t));do{
+N.scope&&M.closeNode(),N.skip||N.subLanguage||(A+=N.relevance),N=N.parent
+}while(N!==s.parent);return s.starts&&h(s.starts,e),r.returnEnd?0:t.length}
+let _={};function y(i,r){const a=r&&r[0];if(R+=i,null==a)return g(),0
+;if("begin"===_.type&&"end"===r.type&&_.index===r.index&&""===a){
+if(R+=n.slice(r.index,r.index+1),!o){const t=Error(`0 width match regex (${e})`)
+;throw t.languageName=e,t.badRule=_.rule,t}return 1}
+if(_=r,"begin"===r.type)return(e=>{
+const n=e[0],i=e.rule,s=new t(i),r=[i.__beforeBegin,i["on:begin"]]
+;for(const t of r)if(t&&(t(e,s),s.isMatchIgnored))return b(n)
+;return i.skip?R+=n:(i.excludeBegin&&(R+=n),
+g(),i.returnBegin||i.excludeBegin||(R=n)),h(i,e),i.returnBegin?0:n.length})(r)
+;if("illegal"===r.type&&!s){
+const e=Error('Illegal lexeme "'+a+'" for mode "'+(N.scope||"<unnamed>")+'"')
+;throw e.mode=N,e}if("end"===r.type){const e=m(r);if(e!==Q)return e}
+if("illegal"===r.type&&""===a)return R+="\n",1
+;if(I>1e5&&I>3*r.index)throw Error("potential infinite loop, way more iterations than matches")
+;return R+=a,a.length}const w=O(e)
+;if(!w)throw z(a.replace("{}",e)),Error('Unknown language: "'+e+'"')
+;const k=Z(w);let v="",N=r||k;const S={},M=new p.__emitter(p);(()=>{const e=[]
+;for(let t=N;t!==w;t=t.parent)t.scope&&e.unshift(t.scope)
+;e.forEach((e=>M.openNode(e)))})();let R="",A=0,j=0,I=0,T=!1;try{
+if(w.__emitTokens)w.__emitTokens(n,M);else{for(N.matcher.considerAll();;){
+I++,T?T=!1:N.matcher.considerAll(),N.matcher.lastIndex=j
+;const e=N.matcher.exec(n);if(!e)break;const t=y(n.substring(j,e.index),e)
+;j=e.index+t}y(n.substring(j))}return M.finalize(),v=M.toHTML(),{language:e,
+value:v,relevance:A,illegal:!1,_emitter:M,_top:N}}catch(t){
+if(t.message&&t.message.includes("Illegal"))return{language:e,value:J(n),
+illegal:!0,relevance:0,_illegalBy:{message:t.message,index:j,
+context:n.slice(j-100,j+100),mode:t.mode,resultSoFar:v},_emitter:M};if(o)return{
+language:e,value:J(n),illegal:!1,relevance:0,errorRaised:t,_emitter:M,_top:N}
+;throw t}}function x(e,t){t=t||p.languages||Object.keys(i);const n=(e=>{
+const t={value:J(e),illegal:!1,relevance:0,_top:l,_emitter:new p.__emitter(p)}
+;return t._emitter.addText(e),t})(e),s=t.filter(O).filter(v).map((t=>E(t,e,!1)))
+;s.unshift(n);const r=s.sort(((e,t)=>{
+if(e.relevance!==t.relevance)return t.relevance-e.relevance
+;if(e.language&&t.language){if(O(e.language).supersetOf===t.language)return 1
+;if(O(t.language).supersetOf===e.language)return-1}return 0})),[o,a]=r,c=o
+;return c.secondBest=a,c}function _(e){let t=null;const n=(e=>{
+let t=e.className+" ";t+=e.parentNode?e.parentNode.className:""
+;const n=p.languageDetectRe.exec(t);if(n){const t=O(n[1])
+;return t||(W(a.replace("{}",n[1])),
+W("Falling back to no-highlight mode for this block.",e)),t?n[1]:"no-highlight"}
+return t.split(/\s+/).find((e=>b(e)||O(e)))})(e);if(b(n))return
+;if(N("before:highlightElement",{el:e,language:n
+}),e.dataset.highlighted)return void console.log("Element previously highlighted. To highlight again, first unset `dataset.highlighted`.",e)
+;if(e.children.length>0&&(p.ignoreUnescapedHTML||(console.warn("One of your code blocks includes unescaped HTML. This is a potentially serious security risk."),
+console.warn("https://github.com/highlightjs/highlight.js/wiki/security"),
+console.warn("The element with unescaped HTML:"),
+console.warn(e)),p.throwUnescapedHTML))throw new q("One of your code blocks includes unescaped HTML.",e.innerHTML)
+;t=e;const i=t.textContent,r=n?m(i,{language:n,ignoreIllegals:!0}):x(i)
+;e.innerHTML=r.value,e.dataset.highlighted="yes",((e,t,n)=>{const i=t&&s[t]||n
+;e.classList.add("hljs"),e.classList.add("language-"+i)
+})(e,n,r.language),e.result={language:r.language,re:r.relevance,
+relevance:r.relevance},r.secondBest&&(e.secondBest={
+language:r.secondBest.language,relevance:r.secondBest.relevance
+}),N("after:highlightElement",{el:e,result:r,text:i})}let y=!1;function w(){
+if("loading"===document.readyState)return y||window.addEventListener("DOMContentLoaded",(()=>{
+w()}),!1),void(y=!0);document.querySelectorAll(p.cssSelector).forEach(_)}
+function O(e){return e=(e||"").toLowerCase(),i[e]||i[s[e]]}
+function k(e,{languageName:t}){"string"==typeof e&&(e=[e]),e.forEach((e=>{
+s[e.toLowerCase()]=t}))}function v(e){const t=O(e)
+;return t&&!t.disableAutodetect}function N(e,t){const n=e;r.forEach((e=>{
+e[n]&&e[n](t)}))}Object.assign(n,{highlight:m,highlightAuto:x,highlightAll:w,
+highlightElement:_,
+highlightBlock:e=>(X("10.7.0","highlightBlock will be removed entirely in v12.0"),
+X("10.7.0","Please use highlightElement now."),_(e)),configure:e=>{p=Y(p,e)},
+initHighlighting:()=>{
+w(),X("10.6.0","initHighlighting() deprecated. Use highlightAll() now.")},
+initHighlightingOnLoad:()=>{
+w(),X("10.6.0","initHighlightingOnLoad() deprecated. Use highlightAll() now.")
+},registerLanguage:(e,t)=>{let s=null;try{s=t(n)}catch(t){
+if(z("Language definition for '{}' could not be registered.".replace("{}",e)),
+!o)throw t;z(t),s=l}
+s.name||(s.name=e),i[e]=s,s.rawDefinition=t.bind(null,n),s.aliases&&k(s.aliases,{
+languageName:e})},unregisterLanguage:e=>{delete i[e]
+;for(const t of Object.keys(s))s[t]===e&&delete s[t]},
+listLanguages:()=>Object.keys(i),getLanguage:O,registerAliases:k,
+autoDetection:v,inherit:Y,addPlugin:e=>{(e=>{
+e["before:highlightBlock"]&&!e["before:highlightElement"]&&(e["before:highlightElement"]=t=>{
+e["before:highlightBlock"](Object.assign({block:t.el},t))
+}),e["after:highlightBlock"]&&!e["after:highlightElement"]&&(e["after:highlightElement"]=t=>{
+e["after:highlightBlock"](Object.assign({block:t.el},t))})})(e),r.push(e)},
+removePlugin:e=>{const t=r.indexOf(e);-1!==t&&r.splice(t,1)}}),n.debugMode=()=>{
+o=!1},n.safeMode=()=>{o=!0},n.versionString="11.11.1",n.regex={concat:h,
+lookahead:g,either:f,optional:d,anyNumberOfTimes:u}
+;for(const t in A)"object"==typeof A[t]&&e(A[t]);return Object.assign(n,A),n
+},te=ee({});te.newInstance=()=>ee({});export{te as default};
\ No newline at end of file
diff --git a/admin/vendor/javascript/@highlightjs--cdn-assets--es--languages--json.min.js.js b/admin/vendor/javascript/@highlightjs--cdn-assets--es--languages--json.min.js.js
new file mode 100644
index 0000000000..2d7d733908
--- /dev/null
+++ b/admin/vendor/javascript/@highlightjs--cdn-assets--es--languages--json.min.js.js
@@ -0,0 +1,10 @@
+// @highlightjs/cdn-assets/es/languages/[email protected] downloaded from https://cdn.jsdelivr.net/npm/@highlightjs/[email protected]/es/languages/json.min.js
+
+/*! `json` grammar compiled for Highlight.js 11.11.1 */
+var hljsGrammar=(()=>{"use strict";return e=>{
+const a=["true","false","null"],r={scope:"literal",beginKeywords:a.join(" ")}
+;return{name:"JSON",aliases:["jsonc"],keywords:{literal:a},contains:[{
+className:"attr",begin:/"(\\.|[^\\"\r\n])*"(?=\s*:)/,relevance:1.01},{
+match:/[{}[\],:]/,className:"punctuation",relevance:0
+},e.QUOTE_STRING_MODE,r,e.C_NUMBER_MODE,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE],
+illegal:"\\S"}}})();export default hljsGrammar;
\ No newline at end of file
diff --git a/api/app/serializers/spree/v2/storefront/cart_serializer.rb b/api/app/serializers/spree/v2/storefront/cart_serializer.rb
index 87ee88499b..eea245dcb0 100644
--- a/api/app/serializers/spree/v2/storefront/cart_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/cart_serializer.rb
@@ -44,7 +44,7 @@ module Spree
has_many :line_items, serializer: Spree::Api::Dependencies.storefront_line_item_serializer.constantize
has_many :variants, serializer: Spree::Api::Dependencies.storefront_variant_serializer.constantize
- has_many :promotions, serializer: Spree::Api::Dependencies.storefront_promotion_serializer.constantize, object_method_name: :valid_promotions, id_method_name: :valid_promotion_ids
+ has_many :promotions, serializer: Spree::Api::Dependencies.storefront_order_promotion_serializer.constantize, object_method_name: :valid_promotions, id_method_name: :valid_promotion_ids
has_many :payments, serializer: Spree::Api::Dependencies.storefront_payment_serializer.constantize do |cart|
cart.payments.valid
end
diff --git a/api/app/serializers/spree/v2/storefront/promotion_serializer.rb b/api/app/serializers/spree/v2/storefront/order_promotion_serializer.rb
similarity index 86%
rename from api/app/serializers/spree/v2/storefront/promotion_serializer.rb
rename to api/app/serializers/spree/v2/storefront/order_promotion_serializer.rb
index ae0bc6532b..f0cb724817 100644
--- a/api/app/serializers/spree/v2/storefront/promotion_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/order_promotion_serializer.rb
@@ -3,7 +3,7 @@
module Spree
module V2
module Storefront
- class PromotionSerializer < BaseSerializer
+ class OrderPromotionSerializer < BaseSerializer
set_id :promotion_id
set_type :promotion
diff --git a/api/lib/spree/api/dependencies.rb b/api/lib/spree/api/dependencies.rb
index 94413a8523..8812a5b4ca 100644
--- a/api/lib/spree/api/dependencies.rb
+++ b/api/lib/spree/api/dependencies.rb
@@ -75,7 +75,7 @@ module Spree
storefront_post_category_serializer: 'Spree::V2::Storefront::PostCategorySerializer',
storefront_post_serializer: 'Spree::V2::Storefront::PostSerializer',
storefront_product_property_serializer: 'Spree::V2::Storefront::ProductPropertySerializer',
- storefront_promotion_serializer: 'Spree::V2::Storefront::PromotionSerializer',
+ storefront_order_promotion_serializer: 'Spree::V2::Storefront::OrderPromotionSerializer',
storefront_shipping_method_serializer: 'Spree::V2::Storefront::ShippingMethodSerializer',
storefront_shipping_rate_serializer: 'Spree::V2::Storefront::ShippingRateSerializer',
storefront_stock_location_serializer: 'Spree::V2::Storefront::StockLocationSerializer',
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 2010475e71..8e527fe7db 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -685,6 +685,9 @@ en:
analytics: Analytics
and: and
api_keys: API keys
+ apis:
+ platform: Platform API
+ storefront: Storefront API
apply: Apply
apply_only_on_full_priced_items: Apply only on full priced items
apply_store_credit: Apply Store Credit