@eluvio/elv-client-js 3.1.73 → 3.1.77

package/typeSpecs/DropEventSite.js

@@ -1,10 +1,12 @@
 const imageTypes = ["gif", "jpg", "jpeg", "png", "svg", "webp"];
 const languageOptions = require("./LanguageCodes");
+const countryOptions = Object.values(require("country-codes-list").customList("countryNameEn", "{countryCode}: {countryNameEn}")).sort();
+const currencyOptions = [...new Set(Object.values(require("country-codes-list").customList("countryNameEn", "{currencyCode}")))].filter(c => c).sort();
 
 const eventSiteSpec = {
   "profile": {
-    name: "Eluvio LIVE Drop Event Site",
-    version: "0.1",
+    name: "Eluvio LIVE Event Site",
+    version: "0.2",
   },
   manageApp: "default",
   associate_permissions: true,
@@ -20,8 +22,28 @@ const eventSiteSpec = {
   localization: {
     localizations: Object.keys(languageOptions)
   },
-  associated_assets: [],
+  associated_assets: [
+    {
+      name: "promos",
+      label: "Promos (Apple TV)",
+      indexed: true,
+      slugged: true,
+      defaultable: true,
+      orderable: true
+    },
+    {
+      name: "channels",
+      label: "Channels (Apple TV)",
+      indexed: true,
+      defaultable: true
+    },
+  ],
   info_fields: [
+    {
+      "label": "Basic Info",
+      "name": "header_basic_info",
+      "type": "header"
+    },
     {
       "name": "tenant_id",
       "label": "Tenant ID",
@@ -40,12 +62,6 @@ const eventSiteSpec = {
       "hash_only": true,
       "no_localize": true
     },
-    {
-      "name": "type",
-      "type": "text",
-      "default_value": "drop_event",
-      "readonly": true
-    },
     {
       "name": "state",
       "type": "select",
@@ -58,6 +74,11 @@ const eventSiteSpec = {
       "default_value": "Inaccessible",
       "hint": "Specify the current state of the event. Inaccessible and ended events will not be visible to users."
     },
+    {
+      "label": "Accessible (Apple TV)",
+      "name": "accessible",
+      "type": "checkbox"
+    },
     {
       "name": "theme",
       "type": "select",
@@ -75,6 +96,15 @@ const eventSiteSpec = {
       "hint": "Additional languages to support",
       "options": Object.keys(languageOptions)
     },
+
+
+
+
+    {
+      "label": "Event Info",
+      "name": "header_event_info",
+      "type": "header"
+    },
     {
       "fields": [
         {
@@ -96,6 +126,7 @@ const eventSiteSpec = {
         {
           "name": "feature_button",
           "type": "subsection",
+          "hint": "This section configures the button linking to this event when shown on the main site as a featured event.",
           "fields": [
             {
               "name": "text",
@@ -302,18 +333,28 @@ const eventSiteSpec = {
               "name": "type",
               "type": "select",
               "options": [
+                "drop",
                 "marketplace",
                 "link"
               ],
-              "default_value": "marketplace"
+              "default_value": "marketplace",
+              "hint": "Specify what happens when clicking on the banner. The banner can link to a URL or a drop, or it can open the marketplace view."
             },
             {
               "name": "marketplace_filters",
-              "type": "list"
+              "type": "list",
+              "hint": "If the banner links to the marketplace, you can specify filters to apply when the marketplace is opened via the banner."
             },
             {
               "name": "link",
-              "type": "text"
+              "type": "text",
+              "hint": "If the banner is a link, specify the URL to link to."
+            },
+            {
+              "label": "Drop UUID",
+              "name": "drop_uuid",
+              "type": "text",
+              "hint": "If the banner links to a drop, you can specify a specific drop to link to. If not specified, the banner will link to the next upcoming drop."
             }
           ]
         }
@@ -332,6 +373,25 @@ const eventSiteSpec = {
         }
       ]
     },
+    {
+      "fields": [
+        {
+          "name": "title",
+          "type": "text"
+        },
+        {
+          "name": "description",
+          "type": "textarea"
+        },
+        {
+          "name": "location",
+          "type": "text"
+        }
+      ],
+      "label": "Calendar Event",
+      "name": "calendar",
+      "type": "subsection"
+    },
     {
       "name": "sponsor_tagline",
       "type": "text",
@@ -364,6 +424,92 @@ const eventSiteSpec = {
       "name": "sponsors",
       "type": "list"
     },
+    {
+      "name": "social_media_links",
+      "type": "subsection",
+      "fields": [
+        {
+          "name": "youtube",
+          "type": "text"
+        },
+        {
+          "name": "instagram",
+          "type": "text"
+        },
+        {
+          "name": "twitter",
+          "type": "text"
+        },
+        {
+          "name": "website",
+          "type": "text"
+        },
+        {
+          "name": "facebook",
+          "type": "text"
+        },
+        {
+          "name": "soundcloud",
+          "type": "text"
+        },
+        {
+          "name": "apple_music",
+          "type": "text"
+        },
+        {
+          "name": "spotify",
+          "type": "text"
+        }
+      ]
+    },
+    {
+      "fields": [
+        {
+          "name": "name",
+          "type": "text"
+        },
+        {
+          "fields": [
+            {
+              "hint": "A description displayed next to the 'Next' button when viewing the previous page.",
+              "name": "page_title",
+              "type": "text"
+            },
+            {
+              "extensions": imageTypes,
+              "name": "image",
+              "type": "file"
+            },
+            {
+              "name": "text_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#000000",
+                "label": "Black"
+              }
+            },
+            {
+              "name": "background_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#FFFFFF",
+                "label": "White"
+              }
+            },
+            {
+              "name": "text",
+              "type": "rich_text"
+            }
+          ],
+          "name": "pages",
+          "type": "list"
+        }
+      ],
+      "name": "event_descriptions",
+      "type": "list"
+    },
     {
       "fields": [
         {
@@ -383,54 +529,503 @@ const eventSiteSpec = {
           "extensions": imageTypes
         },
         {
-          "name": "header_text",
-          "type": "text"
+          "name": "header_text",
+          "type": "text"
+        },
+        {
+          "name": "show_countdown",
+          "type": "checkbox",
+          "default_value": true
+        },
+        {
+          "name": "message_1",
+          "type": "textarea",
+          "hint": "Message above the countdown. Default: 'Your Code is Redeemed. Drop Begins In'"
+        },
+        {
+          "name": "message_2",
+          "type": "textarea",
+          "hint": "Message below the countdown. Default: 'Use the link in your code email to return here at the time of the drop.'"
+        }
+      ],
+      "name": "event_landing_page",
+      "type": "subsection"
+    },
+    {
+      "fields": [
+        {
+          "name": "subheader",
+          "type": "text"
+        },
+        {
+          "name": "header",
+          "type": "text"
+        },
+        {
+          "name": "stream",
+          "type": "fabric_link",
+          "video_preview": true
+        },
+      ],
+      "name": "stream_page",
+      "type": "subsection"
+    },
+    {
+      "name": "footer_links",
+      "type": "list",
+      "hint": "Specify links to include in the footer of the event, such as privacy or terms policies. Each item can either be specified as a URL, rich text, or an HTML document. The two latter options will be shown in a modal when clicked.",
+      "fields": [
+        {
+          "name": "text",
+          "type": "text"
+        },
+        {
+          "name": "url",
+          "label": "URL Link",
+          "type": "text"
+        },
+        {
+          "label": "Content (Rich Text)",
+          "name": "content_rich_text",
+          "type": "rich_text"
+        },
+        {
+          "label": "Content (HTML)",
+          "name": "content_html",
+          "type": "file",
+          "extensions": ["html"]
+        }
+      ]
+    },
+    {
+      "name": "branding",
+      "label": "Custom Branding",
+      "type": "subsection",
+      "fields": [
+        {
+          "name": "get_started",
+          "label": "'Get Started' Button",
+          "type": "subsection",
+          "fields": [
+            {
+              "name": "text",
+              "type": "text",
+              "default_value": "Get Started"
+            },
+            {
+              "name": "text_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#000000"
+              }
+            },
+            {
+              "name": "background_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#d7bb73"
+              }
+            }
+          ]
+        },
+        {
+          "name": "join_drop",
+          "label": "'Join the Drop' Button",
+          "type": "subsection",
+          "fields": [
+            {
+              "name": "text",
+              "type": "text",
+              "default_value": "Join the Drop"
+            },
+            {
+              "name": "text_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#000000"
+              }
+            },
+            {
+              "name": "background_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#d7bb73"
+              }
+            }
+          ]
+        },
+        {
+          "name": "buy_tickets",
+          "label": "'Buy Tickets' Button",
+          "type": "subsection",
+          "fields": [
+            {
+              "name": "text",
+              "type": "text",
+              "default_value": "Buy Tickets"
+            },
+            {
+              "name": "text_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#FFFFFF"
+              }
+            },
+            {
+              "name": "background_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#000000"
+              }
+            }
+          ]
+        },
+        {
+          "name": "watch_promo",
+          "label": "'Watch Promo' Button",
+          "type": "subsection",
+          "fields": [
+            {
+              "name": "text",
+              "type": "text",
+              "default_value": "Watch Promo"
+            },
+            {
+              "name": "text_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#000000"
+              }
+            },
+            {
+              "name": "background_color",
+              "type": "color",
+              "no_label": true,
+              "default_value": {
+                "color": "#d7bb73"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "show_faq",
+      "label": "Show FAQ",
+      "type": "checkbox",
+      "default_value": true
+    },
+    {
+      "name": "faq",
+      "label": "FAQ",
+      "hint": "Specify a custom FAQ. If blank, the default FAQ will be displayed",
+      "type": "list",
+      "fields": [
+        {
+          "name": "question",
+          "type": "text"
+        },
+        {
+          "name": "answer",
+          "type": "textarea"
+        }
+      ]
+    },
+
+
+
+
+    {
+      "label": "Tickets, Products and Coupons",
+      "name": "header_tickets_products_coupons",
+      "type": "header"
+    },
+    {
+      "name": "shipping_countries",
+      "type": "multiselect",
+      "no_localize": true,
+      "hint": "Countries to which merchandise shipment is available",
+      "default_value": ["US: United States of America"],
+      "options": countryOptions
+    },
+    {
+      "name": "payment_currencies",
+      "type": "multiselect",
+      "no_localize": true,
+      "hint": "List of accepted currencies for tickets and merchandise",
+      "default_value": ["USD"],
+      "options": currencyOptions
+    },
+    {
+      "name": "free",
+      "type": "checkbox",
+      "no_localize": true,
+      "hint": "If specified, the event is free for all users and tickets will not be necessary."
+    },
+    {
+      "fields": [
+        {
+          "name": "coupon_mode",
+          "type": "checkbox",
+          "no_localize": true,
+          "hint": "If specified, coupon redemption will be available"
+        },
+        {
+          "name": "redemption_message",
+          "type": "text",
+          "hint": "Text to be displayed on coupon redemption page"
+        },
+        {
+          "name": "event_page_message_1",
+          "type": "text",
+          "hint": "Text to be displayed on event page after redemption"
+        },
+        {
+          "name": "event_page_message_2",
+          "type": "text",
+          "hint": "Text to be displayed on event page after redemption"
+        }
+      ],
+      "name": "coupon_redemption",
+      "type": "subsection"
+    },
+    {
+      "fields": [
+        {
+          "name": "name",
+          "type": "text"
+        },
+        {
+          "label": "Item ID",
+          "name": "uuid",
+          "no_localize": true,
+          "type": "uuid"
+        },
+        {
+          "name": "hidden",
+          "type": "checkbox",
+          "no_localize": true,
+          "hint": "If checked, this ticket class will not be displayed and won't be available for purchase."
+        },
+        {
+          "name": "release_date",
+          "type": "datetime",
+          "no_localize": true,
+          "hint": "If the tickets should not be available for purchase immediately, specify a release date"
+        },
+        {
+          "name": "requires_shipping",
+          "type": "checkbox",
+          "no_localize": true,
+          "hint": "If checked, shipping information and taxes will be collected for purchases of this ticket class."
+        },
+        {
+          "name": "description",
+          "type": "textarea"
+        },
+        {
+          "extensions": imageTypes,
+          "name": "image",
+          "type": "file"
+        },
+        {
+          "fields": [
+            {
+              "name": "label",
+              "type": "text"
+            },
+            {
+              "label": "Item ID",
+              "name": "uuid",
+              "type": "uuid",
+              "no_localize": true,
+            },
+            {
+              "name": "hidden",
+              "type": "checkbox",
+              "no_localize": true,
+              "hint": "If checked, this ticket SKU will not be displayed and won't be available for purchase."
+            },
+            {
+              "label": "NTP ID",
+              "name": "otp_id",
+              "no_localize": true,
+              "type": "ntp_id"
+            },
+            {
+              "name": "start_time",
+              "type": "datetime",
+              "no_localize": true,
+            },
+            {
+              "label": "Start Time (Text)",
+              "hint": "This label will be displayed in emails where time zone localization is not possible.",
+              "name": "start_time_text",
+              "type": "text"
+            },
+            {
+              "name": "end_time",
+              "type": "datetime",
+              "no_localize": true,
+            },
+            {
+              "name": "price",
+              "type": "reference_subsection",
+              "no_localize": true,
+              "reference": "/payment_currencies",
+              "value_type": "number",
+              "hint": "Available price currencies are based on the 'Payment Currencies' field above",
+            },
+            {
+              "name": "external_url",
+              "hint": "External URL from which to purchase this ticket. If specified, the payment information below is not required."
+            }
+          ],
+          "label": "SKUs",
+          "name": "skus",
+          "type": "list"
+        }
+      ],
+      "name": "tickets",
+      "type": "list"
+    },
+    {
+      "fields": [
+        {
+          "name": "type",
+          "options": [
+            "merchandise",
+            "donation"
+          ],
+          "type": "select",
+          "no_localize": true,
+        },
+        {
+          "name": "name",
+          "type": "text"
+        },
+        {
+          "label": "Item ID",
+          "name": "uuid",
+          "type": "uuid",
+          "no_localize": true,
+        },
+        {
+          "name": "description",
+          "type": "textarea"
+        },
+        {
+          "fields": [
+            {
+              "extensions": imageTypes,
+              "name": "image",
+              "type": "file"
+            }
+          ],
+          "name": "images",
+          "type": "list"
+        },
+        {
+          "name": "price",
+          "type": "reference_subsection",
+          "no_localize": true,
+          "reference": "/payment_currencies",
+          "value_type": "number",
+          "hint": "Available price currencies are based on the 'Payment Currencies' field above",
         },
         {
-          "name": "show_countdown",
+          "name": "featured",
           "type": "checkbox",
-          "default_value": true
+          "no_localize": true,
+          "hint": "A featured item will be shown at checkout."
         },
         {
-          "name": "message_1",
-          "type": "textarea",
-          "hint": "Message above the countdown. Default: 'Your Code is Redeemed. Drop Begins In'"
+          "fields": [
+            {
+              "name": "name",
+            },
+            {
+              "name": "type",
+              "type": "select",
+              "options": [
+                "text",
+                "color",
+                "number"
+              ]
+            }
+          ],
+          "hint": "Specify the characteristics each variation of this product has, for example 'Size' and 'Color'",
+          "name": "option_fields",
+          "no_localize": true,
+          "type": "list"
         },
         {
-          "name": "message_2",
-          "type": "textarea",
-          "hint": "Message below the countdown. Default: 'Use the link in your code email to return here at the time of the drop.'"
+          "name": "product_options",
+          "type": "reference_list",
+          "no_localize": true,
+          "reference": "./option_fields",
+          "fields": [
+            {
+              "label": "SKU ID",
+              "name": "uuid",
+              "type": "uuid"
+            }
+          ]
         }
       ],
-      "name": "event_landing_page",
-      "type": "subsection"
+      "name": "products",
+      "type": "list"
     },
     {
-      "name": "footer_links",
-      "type": "list",
-      "hint": "Specify links to include in the footer of the event, such as privacy or terms policies. Each item can either be specified as a URL, rich text, or an HTML document. The two latter options will be shown in a modal when clicked.",
       "fields": [
         {
-          "name": "text",
+          "name": "title",
           "type": "text"
         },
         {
-          "name": "url",
-          "label": "URL Link",
-          "type": "text"
+          "name": "description",
+          "type": "textarea"
         },
         {
-          "label": "Content (Rich Text)",
-          "name": "content_rich_text",
-          "type": "rich_text"
+          "name": "release_date",
+          "type": "datetime",
+          "no_localize": true,
         },
         {
-          "label": "Content (HTML)",
-          "name": "content_html",
-          "type": "file",
-          "extensions": ["html"]
+          "extensions": imageTypes,
+          "name": "image",
+          "type": "file"
+        },
+        {
+          "name": "package",
+          "type": "fabric_link",
+          "no_localize": true,
         }
-      ]
+      ],
+      "name": "extras",
+      "type": "list"
+    },
+
+
+
+
+
+    {
+      "label": "Drops",
+      "name": "header_drops",
+      "type": "header"
+    },
+    {
+      "name": "hide_upcoming_events",
+      "type": "checkbox",
+      "default_value": false
     },
     {
       "name": "marketplace_drops",
@@ -500,6 +1095,11 @@ const eventSiteSpec = {
           "type": "checkbox",
           "default_value": true
         },
+        {
+          "name": "requires_ticket",
+          "type": "checkbox",
+          "default_value": false
+        },
         {
           "name": "event_header",
           "type": "text",
@@ -915,166 +1515,34 @@ const eventSiteSpec = {
         }
       ]
     },
+
+
+
+
+
     {
-      "name": "branding",
-      "label": "Custom Branding",
-      "type": "subsection",
-      "fields": [
-        {
-          "name": "get_started",
-          "label": "'Get Started' Button",
-          "type": "subsection",
-          "fields": [
-            {
-              "name": "text",
-              "type": "text",
-              "default_value": "Get Started"
-            },
-            {
-              "name": "text_color",
-              "type": "color",
-              "no_label": true,
-              "default_value": {
-                "color": "#000000"
-              }
-            },
-            {
-              "name": "background_color",
-              "type": "color",
-              "no_label": true,
-              "default_value": {
-                "color": "#d7bb73"
-              }
-            }
-          ]
-        },
-        {
-          "name": "join_drop",
-          "label": "'Join the Drop' Button",
-          "type": "subsection",
-          "fields": [
-            {
-              "name": "text",
-              "type": "text",
-              "default_value": "Join the Drop"
-            },
-            {
-              "name": "text_color",
-              "type": "color",
-              "no_label": true,
-              "default_value": {
-                "color": "#000000"
-              }
-            },
-            {
-              "name": "background_color",
-              "type": "color",
-              "no_label": true,
-              "default_value": {
-                "color": "#d7bb73"
-              }
-            }
-          ]
-        },
-        {
-          "name": "watch_promo",
-          "label": "'Watch Promo' Button",
-          "type": "subsection",
-          "fields": [
-            {
-              "name": "text",
-              "type": "text",
-              "default_value": "Watch Promo"
-            },
-            {
-              "name": "text_color",
-              "type": "color",
-              "no_label": true,
-              "default_value": {
-                "color": "#FFFFFF"
-              }
-            },
-            {
-              "name": "background_color",
-              "type": "color",
-              "no_label": true,
-              "default_value": {
-                "color": "#000000"
-              }
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "name": "show_faq",
-      "label": "Show FAQ",
-      "type": "checkbox",
-      "default_value": true
+      "label": "Search and Analytics",
+      "name": "header_search_and_analytics",
+      "type": "header"
     },
     {
-      "name": "faq",
-      "label": "FAQ",
-      "hint": "Specify a custom FAQ. If blank, the default FAQ will be displayed",
-      "type": "list",
       "fields": [
         {
-          "name": "question",
+          "name": "name",
           "type": "text"
         },
         {
-          "name": "answer",
+          "name": "description",
           "type": "textarea"
-        }
-      ]
-    },
-    {
-      "name": "social_media_links",
-      "type": "subsection",
-      "fields": [
-        {
-          "name": "youtube",
-          "type": "text"
-        },
-        {
-          "name": "instagram",
-          "type": "text"
         },
         {
-          "name": "twitter",
-          "type": "text"
-        },
-        {
-          "name": "website",
-          "type": "text"
-        },
-        {
-          "name": "facebook",
-          "type": "text"
-        },
-        {
-          "name": "soundcloud",
-          "type": "text"
-        },
-        {
-          "name": "apple_music",
-          "type": "text"
-        },
-        {
-          "name": "spotify",
-          "type": "text"
-        }
-      ]
-    },
-    {
-      "fields": [
-        {
-          "name": "name",
+          "name": "location",
           "type": "text"
         },
         {
-          "name": "description",
-          "type": "textarea"
+          "name": "type",
+          "type": "select",
+          "options": ["Online Only", "Online and In-Person"]
         },
         {
           "name": "images",
@@ -1085,6 +1553,26 @@ const eventSiteSpec = {
             "extensions": imageTypes
           }]
         },
+        {
+          "name": "performers",
+          "type": "list",
+          "fields": [
+            {
+              "name": "name",
+              "type": "text"
+            },
+            {
+              "name": "url",
+              "label": "URL",
+              "type": "text"
+            },
+            {
+              "name": "image",
+              "type": "file",
+              "extensions": imageTypes
+            }
+          ]
+        },
         {
           "name": "organizers",
           "type": "list",
@@ -1104,6 +1592,25 @@ const eventSiteSpec = {
               "extensions": imageTypes
             }
           ]
+        },
+        {
+          "name": "showings",
+          "type": "list",
+          "fields": [
+            {
+              "name": "name",
+              "type": "text"
+            },
+            {
+              "name": "start_time",
+              "type": "datetime",
+              "hint": "Make sure this time exactly matches the corresponding ticket SKU start times"
+            },
+            {
+              "name": "end_time",
+              "type": "datetime"
+            }
+          ]
         }
       ],
       "label": "Search Listing Info",