@stackshift-ui/newsletter 6.0.3 → 6.0.5-beta.0

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@stackshift-ui/newsletter",
   "description": "",
-  "version": "6.0.3",
+  "version": "6.0.5-beta.0",
   "private": false,
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist/**"
+    "dist/**",
+    "src"
   ],
   "author": "WebriQ <info@webriq.com>",
   "devDependencies": {
@@ -28,29 +29,29 @@
     "typescript": "^5.6.2",
     "vite-tsconfig-paths": "^5.0.1",
     "vitest": "^2.1.1",
-    "@stackshift-ui/eslint-config": "6.0.2",
-    "@stackshift-ui/typescript-config": "6.0.2"
+    "@stackshift-ui/eslint-config": "6.0.3-beta.0",
+    "@stackshift-ui/typescript-config": "6.0.3-beta.0"
   },
   "dependencies": {
-    "@stackshift-ui/scripts": "6.0.2",
-    "@stackshift-ui/button": "6.0.2",
-    "@stackshift-ui/system": "6.0.2",
-    "@stackshift-ui/form": "6.0.2",
-    "@stackshift-ui/heading": "6.0.2",
-    "@stackshift-ui/image": "6.0.2",
-    "@stackshift-ui/input": "6.0.3",
-    "@stackshift-ui/link": "6.0.2",
-    "@stackshift-ui/section": "6.0.2",
-    "@stackshift-ui/container": "6.0.2",
-    "@stackshift-ui/flex": "6.0.2",
-    "@stackshift-ui/text": "6.0.2"
+    "@stackshift-ui/system": "6.0.4-beta.0",
+    "@stackshift-ui/form": "6.0.4-beta.0",
+    "@stackshift-ui/scripts": "6.0.3-beta.0",
+    "@stackshift-ui/button": "6.0.4-beta.0",
+    "@stackshift-ui/image": "6.0.4-beta.0",
+    "@stackshift-ui/text": "6.0.4-beta.0",
+    "@stackshift-ui/heading": "6.0.4-beta.0",
+    "@stackshift-ui/link": "6.0.4-beta.0",
+    "@stackshift-ui/container": "6.0.4-beta.0",
+    "@stackshift-ui/flex": "6.0.4-beta.0",
+    "@stackshift-ui/input": "6.0.5-beta.0",
+    "@stackshift-ui/section": "6.0.4-beta.0"
   },
   "peerDependencies": {
     "@types/react": "16.8 - 19",
     "next": "10 - 14",
     "react": "16.8 - 19",
     "react-dom": "16.8 - 19",
-    "@stackshift-ui/system": ">=0.0.0"
+    "@stackshift-ui/system": ">=6.0.4-beta.0"
   },
   "peerDependenciesMeta": {
     "next": {

package/src/helper/index.ts

@@ -0,0 +1,42 @@
+import { Logo } from "../types";
+
+// WebriQ form redirect thank you page on successful submission
+export const thankYouPageLink = (link: any) => {
+  if (!link) {
+    return "/thank-you";
+  } else {
+    if (link?.linkType === "linkInternal") {
+      return `/${link?.internalLink}`;
+    } else {
+      return link?.externalLink;
+    }
+  }
+};
+
+export function getInputType(
+  type?: string | undefined,
+): "text" | "email" | "password" | "number" | undefined {
+  switch (type) {
+    case "inputEmail":
+      return "email";
+    case "inputPassword":
+      return "password";
+    case "inputNumber":
+      return "number";
+    default:
+      return "text";
+  }
+}
+
+export const logoLink = (logo: Logo) => {
+  if (logo?.internalLink && logo?.type === "linkInternal") {
+    if (logo?.internalLink?.toLowerCase()?.includes("home")) {
+      return "/";
+    }
+    return `/${logo.internalLink}`;
+  } else if (logo?.externalLink && logo?.type === "linkExternal") {
+    return logo?.externalLink ?? "/";
+  } else {
+    return "/";
+  }
+};

package/src/index.ts

@@ -0,0 +1,6 @@
+"use client";
+
+// component exports
+export * from "./newsletter";
+export * from "./newsletter_a";
+export * from "./newsletter_b";

package/src/newsletter.test.tsx

@@ -0,0 +1,13 @@
+import { cleanup, render, screen } from "@testing-library/react";
+import { afterEach, describe, test } from "vitest";
+import { Newsletter } from "./newsletter";
+
+describe.concurrent("newsletter", () => {
+  afterEach(cleanup);
+
+  test.skip("Dummy test - test if renders without errors", ({ expect }) => {
+    const clx = "my-class";
+    render(<Newsletter />);
+    expect(screen.getByTestId("{ kebabCase name }}").classList).toContain(clx);
+  });
+});

package/src/newsletter.tsx

@@ -0,0 +1,32 @@
+import React, { lazy } from "react";
+import { Form, Logo, SectionsProps } from "./types";
+
+const Variants = {
+  variant_a: lazy(() => import("./newsletter_a")),
+  variant_b: lazy(() => import("./newsletter_b")),
+};
+
+export interface NewsletterProps {
+  logo?: Logo | null;
+  title?: string | null;
+  description?: string | null;
+  form?: Form | null;
+}
+
+const displayName = "Newsletter";
+
+export const Newsletter: React.FC<SectionsProps> = ({ data }) => {
+  const variant = data?.variant;
+  const Variant = variant && Variants?.[variant as keyof typeof Variants];
+
+  const props = {
+    logo: data?.variants?.logo,
+    title: data?.variants?.title,
+    description: data?.variants?.description,
+    form: data?.variants?.form,
+  };
+
+  return Variant ? <Variant {...props} /> : null;
+};
+
+Newsletter.displayName = displayName;

package/src/newsletter_a.tsx

@@ -0,0 +1,125 @@
+import React from "react";
+import { Button } from "@stackshift-ui/button";
+import { Form } from "@stackshift-ui/form";
+import { Heading } from "@stackshift-ui/heading";
+import { Image } from "@stackshift-ui/image";
+import { Input } from "@stackshift-ui/input";
+import { Text } from "@stackshift-ui/text";
+import { Link } from "@stackshift-ui/link";
+import { Section } from "@stackshift-ui/section";
+import { Container } from "@stackshift-ui/container";
+import { Flex } from "@stackshift-ui/flex";
+
+import { Form as FormFields, Logo } from "./types";
+import { getInputType, logoLink, thankYouPageLink } from "./helper";
+import { NewsletterProps } from ".";
+
+export default function Newsletter_A({
+  logo,
+  title,
+  description,
+  form,
+}: NewsletterProps): React.JSX.Element {
+  return (
+    <Section className="py-20 bg-background">
+      <Container maxWidth={1280}>
+        <Container maxWidth={576} className="text-center">
+          <LogoSection logo={logo} />
+          <TitleAndDescriptionText title={title} description={description} />
+          <NewsletterForm
+            id={form?.id ?? undefined}
+            fields={form?.fields}
+            buttonLabel={form?.buttonLabel}
+            thankYouPage={form?.thankYouPage}
+          />
+        </Container>
+      </Container>
+    </Section>
+  );
+}
+
+function LogoSection({ logo }: { logo?: Logo | null }) {
+  if (!logo) return null;
+
+  return (
+    <Link
+      aria-label={logoLink(logo) === "/" ? "Go to home page" : `Go to ${logoLink(logo)}`}
+      className="inline-block mb-6 text-3xl font-bold leading-none"
+      href={logoLink(logo)}
+      target={logo?.linkTarget}
+      rel={logo?.linkTarget === "_blank" ? "noopener noreferrer" : ""}>
+      <Image
+        src={logo?.image}
+        alt={logo.alt ?? "newsletter-logo"}
+        width={48}
+        height={48}
+        className="inline-block mb-6 text-3xl font-bold leading-none"
+      />
+    </Link>
+  );
+}
+
+function TitleAndDescriptionText({
+  title,
+  description,
+}: {
+  title?: string | null;
+  description?: string | null;
+}) {
+  return (
+    <React.Fragment>
+      {title && (
+        <Heading fontSize="2xl" className="mb-3 text-primary">
+          {title}
+        </Heading>
+      )}
+      {description && (
+        <Text muted className="my-4">
+          {description}
+        </Text>
+      )}
+    </React.Fragment>
+  );
+}
+
+function NewsletterForm({ id, fields, thankYouPage, buttonLabel }: FormFields) {
+  const hasFields = Array.isArray(fields) && fields.length > 0;
+
+  if (!hasFields) return null;
+
+  return (
+    <Form
+      id={id ?? undefined}
+      name="NewsletterA-Form"
+      className="form-newsletter"
+      thankyouPage={thankYouPageLink(thankYouPage)}>
+      <Flex align="center" gap={2} className="max-w-md mx-auto">
+        <Input
+          variant="outline"
+          noLabel
+          ariaLabel={fields[0]?.placeholder ?? fields[0]?.name}
+          className="flex-grow w-full"
+          type={getInputType(fields[0]?.type)}
+          placeholder={fields[0]?.placeholder}
+          name={fields[0]?.name}
+          required={fields[0]?.isRequired}
+        />
+
+        <div>
+          <div className="webriq-recaptcha" />
+        </div>
+        {buttonLabel && (
+          <Button
+            as="button"
+            ariaLabel={buttonLabel ?? "Newsletter form submit button"}
+            type="submit"
+            className="w-1/2 text-white">
+            {buttonLabel}
+          </Button>
+        )}
+      </Flex>
+    </Form>
+  );
+}
+
+export { Newsletter_A };

package/src/newsletter_b.tsx

@@ -0,0 +1,137 @@
+import { Button } from "@stackshift-ui/button";
+import { Form } from "@stackshift-ui/form";
+import { Heading } from "@stackshift-ui/heading";
+import { Image } from "@stackshift-ui/image";
+import { Input } from "@stackshift-ui/input";
+import { Text } from "@stackshift-ui/text";
+import { Link } from "@stackshift-ui/link";
+import { Section } from "@stackshift-ui/section";
+import { Container } from "@stackshift-ui/container";
+import { Flex } from "@stackshift-ui/flex";
+import React from "react";
+
+import { Form as FormFields, Logo } from "./types";
+import { getInputType, logoLink, thankYouPageLink } from "./helper";
+import { NewsletterProps } from ".";
+
+export default function Newsletter_B({
+  logo,
+  title,
+  description,
+  form,
+}: NewsletterProps): React.JSX.Element {
+  return (
+    <Section className="mx-auto w-full py-20 bg-background">
+      <Container maxWidth={1280}>
+        <Flex wrap align="center">
+          <div className="w-full mb-4 text-center lg:mr-8 lg:w-auto">
+            <Flex align="center" justify="center" className="mx-auto">
+              <LogoSection logo={logo} />
+            </Flex>
+          </div>
+          <Container
+            maxWidth={412}
+            className="mx-auto px-4 w-full mb-6 text-center lg:ml-0 lg:text-left">
+            <TitleAndDescriptionText title={title} description={description} />
+          </Container>
+          <div className="w-full lg:w-[35%]">
+            <NewsletterForm
+              {...{
+                id: form?.id,
+                fields: form?.fields,
+                thankYouPage: form?.thankYouPage,
+                buttonLabel: form?.buttonLabel,
+              }}
+            />
+          </div>
+        </Flex>
+      </Container>
+    </Section>
+  );
+}
+
+function LogoSection({ logo }: { logo?: Logo | null }) {
+  if (!logo) return null;
+
+  return (
+    <Link
+      aria-label={logoLink(logo) === "/" ? "Go to home page" : `Go to ${logoLink(logo)}`}
+      className="inline-block mb-6 text-3xl font-bold leading-none"
+      href={logoLink(logo)}
+      target={logo?.linkTarget}
+      rel={logo?.linkTarget === "_blank" ? "noopener noreferrer" : ""}>
+      <Image
+        src={logo?.image}
+        alt={logo.alt ?? "newsletter-logo"}
+        width={48}
+        height={48}
+        className="inline-block mb-6 text-3xl font-bold leading-none"
+      />
+    </Link>
+  );
+}
+
+function TitleAndDescriptionText({
+  title,
+  description,
+}: {
+  title?: string | null;
+  description?: string | null;
+}) {
+  return (
+    <React.Fragment>
+      {title && (
+        <Heading fontSize="2xl" className="text-primary">
+          {title}
+        </Heading>
+      )}
+      {description && (
+        <Text className="my-4 leading-loose" muted>
+          {description}
+        </Text>
+      )}
+    </React.Fragment>
+  );
+}
+
+function NewsletterForm({ id, fields, thankYouPage, buttonLabel }: FormFields) {
+  const hasFields = Array.isArray(fields) && fields.length > 0;
+
+  if (!hasFields) return null;
+
+  return (
+    <Form
+      id={id ?? undefined}
+      name="NewsletterB-Form"
+      className="form-newsletter"
+      thankyouPage={thankYouPageLink(thankYouPage)}>
+      <Flex align="center" gap={2} className="max-w-md mx-auto">
+        <Input
+          variant="outline"
+          noLabel
+          ariaLabel={fields[0]?.placeholder ?? fields[0]?.name}
+          className="flex-grow w-full"
+          type={getInputType(fields[0]?.type)}
+          placeholder={fields[0]?.placeholder}
+          name={fields[0]?.name}
+          required={fields[0]?.isRequired}
+        />
+
+        <div>
+          <div className="webriq-recaptcha" />
+        </div>
+        {buttonLabel && (
+          <Button
+            as="button"
+            ariaLabel={buttonLabel ?? "Newsletter form submit button"}
+            type="submit"
+            className="w-1/2 text-white">
+            {buttonLabel}
+          </Button>
+        )}
+      </Flex>
+    </Form>
+  );
+}
+
+export { Newsletter_B };

package/src/types.ts

@@ -0,0 +1,412 @@
+export type StyleVariants<T extends string> = Record<T, string>;
+
+export type Socials = "facebook" | "instagram" | "youtube" | "linkedin" | "twitter";
+export interface MainImage {
+  image: string;
+  alt?: string;
+}
+
+export interface LabeledRoute extends ConditionalLink {
+  ariaLabel?: string;
+  label?: string;
+  linkTarget?: string;
+  linkType?: string;
+  _type?: string;
+  linkInternal?: any;
+}
+export interface ConditionalLink {
+  type?: string;
+  internalLink?: string | null;
+  externalLink?: string | null;
+}
+
+export interface StatItems {
+  label?: string;
+  mainImage?: MainImage;
+  value?: string;
+  _key?: string;
+  _type?: string;
+}
+
+export interface Logo extends ConditionalLink {
+  alt?: string;
+  linkTarget?: string;
+  image?: string;
+}
+
+export interface Images {
+  image?: string;
+  _key?: string;
+  _type?: string;
+  alt?: string;
+}
+
+export interface ContactDetails {
+  addressInfo?: string;
+  contactInfo?: string;
+  emailInfo?: string;
+  _key?: string;
+}
+
+export interface SocialLink {
+  socialMedia?: string | null;
+  socialMediaLink?: string | null;
+  _key?: string | null;
+  _type?: string | null;
+  socialMediaIcon?: {
+    alt?: string;
+    image?: string;
+  } | null;
+  socialMediaPlatform?: string | null;
+}
+
+export interface LabeledRouteWithKey extends LabeledRoute {
+  _key?: string;
+}
+
+export interface ArrayOfImageTitleAndText {
+  mainImage?: {
+    alt?: string;
+    image?: string;
+  };
+  plainText?: string;
+  title?: string;
+  _key?: string;
+  _type?: string;
+}
+
+export interface FeaturedItem {
+  description?: string;
+  mainImage?: MainImage;
+  title?: string;
+  subtitle?: string;
+  _key?: string;
+  _type?: string;
+}
+
+export interface ArrayOfTitleAndText {
+  _key?: string;
+  plainText?: string;
+  title?: string;
+}
+
+export interface BlogPost extends SanityBody {
+  authors?: Author[] | null;
+  body?: any;
+  categories?: Category[] | null;
+  excerpt?: string | null;
+  link?: string | null;
+  mainImage?: string | null;
+  publishedAt?: string;
+  seo?: Seo | null;
+  slug?: SanitySlug | null;
+  title?: string;
+}
+
+export interface Seo {
+  _type?: string;
+  seoTitle?: string;
+  seoDescription?: string;
+  seoImage?: string;
+  seoKeywords?: string;
+  seoSynonyms?: string;
+}
+
+export interface SanitySlug {
+  current?: string;
+  _type?: "slug";
+}
+
+export interface SanityBody {
+  _createdAt?: string;
+  _id?: string;
+  _rev?: string;
+  _type?: string;
+  _updatedAt?: string;
+}
+
+export interface Author extends SanityBody {
+  link?: string | null;
+  bio?: string | null;
+  name?: string | null;
+  slug?: SanitySlug | null;
+  image?: string | null;
+  profile?: {
+    alt: string;
+    image: string;
+  } | null;
+}
+
+export interface Category extends SanityBody {
+  title?: string;
+}
+
+export interface Form {
+  id?: string | null;
+  buttonLabel?: string | null;
+  name?: string | null;
+  subtitle?: string | null;
+  fields?: FormFields[] | null;
+  thankYouPage?: ThankYouPage | null;
+}
+
+export interface FormFields {
+  name?: string;
+  placeholder?: string;
+  pricingType?: string;
+  type?: FormTypes;
+  _key?: string;
+  _type?: string;
+  isRequired?: boolean;
+  label?: string;
+  items?: string[];
+}
+
+export type FormTypes =
+  | "inputText"
+  | "inputEmail"
+  | "inputPassword"
+  | "inputNumber"
+  | "textarea"
+  | "inputFile"
+  | "inputRadio"
+  | "inputCheckbox"
+  | "inputSelect";
+
+export interface ThankYouPage {
+  externalLink?: string | null;
+  internalLink?: string | null;
+  linkInternal?: any;
+  linkTarget?: string;
+  linkType?: string;
+  type?: string;
+}
+
+//Used on different sections
+export interface SectionsProps {
+  template?: Template;
+  data?: Sections;
+  variant?: string | null | undefined;
+  schema?: Variants;
+}
+
+export interface Sections extends SanityBody {
+  label?: string;
+  variant?: string;
+  variants?: Variants;
+  _key?: string;
+}
+
+//*EDIT THIS SECTION WHEN CREATING/UPDATING SCHEMAS ON STUDIO */
+export interface Variants {
+  template?: Template;
+  multipleMenus?: any;
+  arrayOfTitleAndText?: ArrayOfTitleAndText[] | null;
+  logo?: Logo | null;
+  primaryButton?: LabeledRoute | null;
+  secondaryButton?: LabeledRoute | null;
+  routes?: LabeledRouteWithKey[] | null;
+  menu?: LabeledRouteWithKey[] | null;
+  plans?: Plans[] | null;
+  formLinks?: LabeledRouteWithKey[] | null;
+  portfolios?: Portfolios[] | null;
+  portfoliosWithCategories?: PortfoliosWithCategories[] | null;
+  length?: number;
+  signInLink?: LabeledRoute | null;
+  signinLink?: LabeledRoute | null;
+  tags?: string[] | null;
+  posts?: BlogPost[] | null;
+  blogsPerPage?: number | null;
+  form?: Form | null;
+  collections?: Collection | null;
+  products?: CollectionProduct | null;
+  allProducts?: Collection[];
+  subtitle?: string | null;
+  caption?: string | null;
+  title?: string | null;
+  plainText?: string | null;
+  contactDescription?: string | null;
+  officeInformation?: string | null;
+  contactEmail?: string | null;
+  contactNumber?: string | null;
+  socialLinks?: SocialLink[] | null;
+  block?: any;
+  heading?: string | null;
+  acceptButtonLabel?: string | null;
+  declineButtonLabel?: string | null;
+  faqsWithCategories?: FaqsWithCategory[] | null;
+  faqs?: AskedQuestion[] | null;
+  arrayOfImageTitleAndText?: ArrayOfImageTitleAndText[] | null;
+  description?: string | null;
+  featuredItems?: FeaturedItem[] | null;
+  images?: Images[] | null;
+  contactDetails?: ContactDetails[] | null;
+  copyright?: string | null;
+  mainImage?: MainImage | null;
+  youtubeLink?: string | null;
+  banner?: any;
+  stats?: StatItems[] | null;
+  teams?: Team[] | null;
+  testimonials?: Testimonial[] | null;
+  selectStripeAccount?: string;
+  annualBilling?: string;
+  monthlyBilling?: string;
+  productDetails?: ProductDetail[];
+  btnLabel?: string;
+  selectAccount?: string;
+  hashtags?: string[];
+  numberOfPosts?: number;
+  text?: string;
+  button?: LabeledRoute;
+  features?: string[];
+  config?: {
+    enableAnalytics: boolean;
+    cookiePolicy?: {
+      siteName: string;
+      cookiePolicyPage: Reference;
+    };
+    consentModalPosition?: string;
+  };
+  contactLink?: LabeledRoute;
+}
+
+export interface Template {
+  bg?: string;
+  color?: string;
+}
+
+export type Plans = {
+  _key?: string | null;
+  _type?: "planItems" | null;
+  checkoutButtonName?: string | null;
+  description?: string | null;
+  monthlyPrice?: string | null;
+  planType?: string | null;
+  yearlyPrice?: string | null;
+  planIncludes?: string[] | null;
+  primaryButton?: LabeledRoute | null;
+} & Record<string, string>;
+
+export interface Portfolios {
+  dateAdded?: string | null;
+  mainImage?: {
+    image?: string | null;
+    alt?: string | null;
+  } | null;
+  primaryButton?: LabeledRoute | null;
+  title?: string | null;
+  _key?: string | null;
+  _type?: string | null;
+}
+
+export interface PortfoliosWithCategories {
+  category?: string | null;
+  content?: Content[] | null;
+  primaryButton?: LabeledRoute | null;
+  _key?: string | null;
+  _type?: string | null;
+}
+
+export interface Content extends Portfolios {
+  description?: string | null;
+  subtitle?: string | null;
+}
+
+export interface Collection extends SanityBody {
+  collectionInfoVariant?: {
+    variant?: string;
+  } | null;
+  name?: string | null;
+  products?: CollectionProduct[] | null;
+  sections?: any; //todo
+  seo?: Seo | null;
+  slug?: SanitySlug | null;
+}
+
+export interface CollectionProduct extends SanityBody {
+  compareToPrice?: number | null;
+  description?: string | null;
+  ecwidProductId?: number | null;
+  name?: string | null;
+  price?: number | null;
+  productInfo?: ProductInfo | null;
+  productInfoVariant?: {
+    variant?: string;
+  } | null;
+  sections?: any; //todo
+  seo?: Seo | null;
+  slug?: SanitySlug | null;
+}
+
+//TODO, RECHECK PRODUCT INFO DATA FROM SANITY
+interface ProductInfo {
+  btnLabel?: string | null;
+  images?: ProductInfoImage[] | null;
+  productDetails?: ProductDetail[] | null;
+  socialLinks?: SocialLink[] | null;
+  subtitle?: string | null;
+}
+
+//TODO, RECHECK PRODUCT INFO DATA FROM SANITY
+export interface ProductDetail {
+  blockContent?: any;
+  contentType?: string;
+  tabName?: string;
+  _key?: string;
+  [key: string]: any;
+}
+interface ProductInfoImage {
+  alt?: string | null;
+  _key: string;
+  _type: string;
+  image?: string | null;
+}
+
+export interface FaqsWithCategory {
+  askedQuestions?: AskedQuestion[] | null;
+  category?: string | null;
+  _key?: string;
+  _type?: string;
+}
+
+export interface AskedQuestion {
+  answer?: string | null;
+  question?: string | null;
+  hidden?: boolean;
+  _key?: string;
+  _type?: string;
+}
+
+export interface Team {
+  jobTitle?: string;
+  mainImage?: MainImage;
+  name?: string;
+  plainText?: string;
+  _key?: string;
+  _type?: string;
+}
+
+export interface Testimonial {
+  jobTitle?: string;
+  mainImage?: MainImage;
+  name?: string;
+  rating?: string;
+  testimony?: string;
+  _key?: string;
+  _type?: string;
+}
+
+export declare interface Reference {
+  _type: string;
+  _ref: string;
+  _key?: string;
+  _weak?: boolean;
+  _strengthenOnPublish?: {
+    type: string;
+    weak?: boolean;
+    template?: {
+      id: string;
+      params: Record<string, string | number | boolean>;
+    };
+  };
+}