@moneylion/react-native-offer-carousel 1.0.0 → 1.0.2

package/src/builder/builder.ts

@@ -0,0 +1,500 @@
+import type { ProductTypes } from "../capabilities/offer-catalog/src";
+import type { Stat } from "../capabilities/offer-catalog/src/utils/stats";
+
+type BaseLayout = {
+	productTypes: ProductTypes[];
+};
+
+export type DefaultOfferCard = BaseLayout & {
+	layout: "defaultOfferCard";
+	topStats: Stat[];
+	stats: Stat[];
+};
+
+export type CreditCardOfferCard = BaseLayout & {
+	layout: "creditCardOfferCard";
+	stats: Stat[];
+};
+
+export type HeadlineWithDescriptionCard = BaseLayout & {
+	layout: "headlineWithDescriptionCard";
+	headlineField?: string;
+	descriptionField?: string;
+	descriptionPointsField?: string;
+};
+
+export type ProductTypeBuilder = Array<
+	DefaultOfferCard | CreditCardOfferCard | HeadlineWithDescriptionCard
+>;
+
+export const productTypeBuilder: ProductTypeBuilder = [
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["HomeEquityLoan", "HomeEquityLineOfCredit"],
+		topStats: [
+			{
+				format: "rangeCurrency",
+				label: "Loan Amount",
+				initialFieldName: "amountCentsMin",
+				endFieldName: "amountCentsMax",
+			},
+		],
+		stats: [
+			{
+				format: "common",
+				label: "Min. Credit Score",
+				fieldName: "minCreditScore",
+				defaultValue: "No minimum",
+			},
+			{
+				format: "rangeMonths",
+				label: "Term Length",
+				initialFieldName: "termLengthMonthsMin",
+				endFieldName: "termLengthMonthsMax",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["AutomobileRefinance", "AutomobileLoan"],
+		topStats: [
+			{
+				format: "rangeCurrency",
+				label: "Loan Amount",
+				initialFieldName: "amountCentsMin",
+				endFieldName: "amountCentsMax",
+			},
+		],
+		stats: [
+			{
+				format: "rangePercent",
+				label:
+					'${dynamicLabelValue} <abbr title="Annual Percentage Rate">APR</abbr>',
+				initialFieldName: "annualPercentageRateBasisPointsMin",
+				endFieldName: "annualPercentageRateBasisPointsMax",
+				dynamicLabelValue: "annualPercentageRateType",
+			},
+			{
+				format: "rangeMonths",
+				label: "Term Length",
+				initialFieldName: "termLengthMonthsMin",
+				endFieldName: "termLengthMonthsMax",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["StudentLoan", "StudentLoanRefinance"],
+		topStats: [
+			{
+				format: "rangeCurrency",
+				label: "Loan Amount",
+				initialFieldName: "amountCentsMin",
+				endFieldName: "amountCentsMax",
+			},
+		],
+		stats: [
+			{
+				format: "rangePercent",
+				label:
+					'${dynamicLabelValue} <abbr title="Annual Percentage Rate">APR</abbr>',
+				initialFieldName: "annualPercentageRateBasisPointsMin",
+				endFieldName: "annualPercentageRateBasisPointsMax",
+				dynamicLabelValue: "annualPercentageRateType",
+			},
+			{
+				format: "rangeMonths",
+				label: "Term Length",
+				initialFieldName: "termLengthMonthsMin",
+				endFieldName: "termLengthMonthsMax",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["BudgetingTools"],
+		topStats: [
+			{
+				label: "Monthly Fee",
+				format: "rangeCurrency",
+				initialFieldName: "monthlyFeeCentsMin",
+				endFieldName: "monthlyFeeCentsMax",
+			},
+		],
+		stats: [
+			{
+				format: "boolean",
+				label: "Free Version",
+				fieldName: "freeVersion",
+				trueValue: "Yes",
+				falseValue: "No",
+			},
+			{
+				format: "freeTrial",
+				label: "Free Trial Days",
+			},
+		],
+	},
+	{
+		layout: "headlineWithDescriptionCard",
+		productTypes: ["IncomeOpportunities"],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: [
+			"BusinessLineOfCredit",
+			"BusinessLendingMarketplace",
+			"RevenueBasedFinancing",
+		],
+		topStats: [
+			{
+				format: "rangeCurrency",
+				label: "Amount",
+				initialFieldName: "amountCentsMin",
+				endFieldName: "amountCentsMax",
+			},
+		],
+		stats: [
+			{
+				format: "monthlyOrAnnualCurrency",
+				label: "Min. Monthly Revenue",
+				monthlyFieldName: "minMonthlyRevenueCents",
+				annualFieldName: "minMonthlyRevenueCents",
+			},
+			{
+				format: "common",
+				label: "Min. Credit Score",
+				fieldName: "minCreditScore",
+				defaultValue: "No minimum",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["TaxFiling"],
+		topStats: [
+			{
+				format: "rangeCurrency",
+				label: "Federal Filing Fee ",
+				initialFieldName: "federalFilingFeeCentsMin",
+				endFieldName: "federalFilingFeeCentsMax",
+			},
+		],
+		stats: [
+			{
+				format: "rangeCurrency",
+				label: "State Filing Fee",
+				initialFieldName: "stateFilingFeeCentsMin",
+				endFieldName: "stateFilingFeeCentsMax",
+			},
+			{
+				format: "listStringWithAnd",
+				label: "Free Filing",
+				fieldName: "freeTier",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: [
+			"CreditBuilderLoan",
+			"CreditBuilderSecuredCreditCard",
+			"CreditBuilderDebitCard",
+			"RentUtilityBillReporting",
+		],
+		topStats: [
+			{
+				label: "Monthly Payments",
+				format: "rangeCurrency",
+				initialFieldName: "monthlyPaymentCentsMin",
+				endFieldName: "monthlyPaymentCentsMax",
+			},
+		],
+		stats: [
+			{
+				format: "BureausStat",
+				label: "Credit Bureau Reporting",
+				fieldName: "creditBureauReporting",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["CashAdvance", "EarnedWageAccess", "OverdraftProtection"],
+		topStats: [
+			{
+				label: "Amount",
+				format: "rangeCurrencyUnabbreviated",
+				initialFieldName: "amountCentsMin",
+				endFieldName: "amountCentsMax",
+			},
+		],
+		stats: [
+			{
+				label: "Monthly Payment",
+				format: "rangeCurrency",
+				initialFieldName: "monthlyFeeCentsMin",
+				endFieldName: "monthlyFeeCentsMax",
+			},
+			{
+				label: "Fast Transfer Fee",
+				format: "rangeCurrencyOrBasis",
+				initialFieldNameCurrency: "fastTransferFeeCentsMin",
+				endFieldNameCurrency: "fastTransferFeeCentsMax",
+				initialFieldNameBasisPoints: "fastTransferFeeBasisPointsMin",
+				endFieldNameBasisPoints: "fastTransferFeeBasisPointsMax",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["CreditMonitoring"],
+		topStats: [
+			{
+				label: "Monthly Payments",
+				format: "rangeCurrency",
+				initialFieldName: "monthlyPaymentCentsMin",
+				endFieldName: "monthlyPaymentCentsMax",
+			},
+		],
+		stats: [
+			{
+				label: "Supported Credit Bureaus",
+				format: "BureausStat",
+				fieldName: "supportedCreditBureaus",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["RoboInvesting"],
+		topStats: [
+			{
+				label: "Fees",
+				format: "rangeCurrencyByTime",
+				initialFieldNameByMonths: "monthlyFeeCentsMin",
+				endFieldNameByMonths: "monthlyFeeCentsMax",
+				initialFieldNameByYears: "annualAdvisoryFeeBasisPointsMin",
+				endFieldNameByYears: "annualAdvisoryFeeBasisPointsMax",
+			},
+		],
+		stats: [
+			{
+				label: "Min Amount to Open",
+				format: "currency",
+				fieldName: "minAmountToOpenCents",
+				raw: true,
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["BankingAccount", "CheckingAccount"],
+		topStats: [
+			{
+				label: "Monthly Fee",
+				format: "rangeCurrency",
+				initialFieldName: "monthlyFeeCentsMin",
+				endFieldName: "monthlyFeeCentsMax",
+			},
+		],
+		stats: [
+			{
+				label: "Out of Network ATM Fee",
+				format: "currency",
+				fieldName: "outOfNetworkAtmUsageFeeCents",
+			},
+			{
+				label: '<abbr title="Annual Percentage Yield">APY</abbr>',
+				format: "percentage",
+				fieldName: "annualPercentageYieldBasisPoints",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["CancellationServices"],
+		topStats: [
+			{
+				format: "rangeCurrency",
+				label: "Monthly Payment",
+				initialFieldName: "monthlyPaymentCentsMin",
+				endFieldName: "monthlyPaymentCentsMax",
+			},
+		],
+		stats: [
+			{
+				format: "freeTrial",
+				label: "Free Trial Days",
+			},
+			{
+				format: "listStringWithAnd",
+				label: "Supported Platforms",
+				fieldName: "supportedPlatforms",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["BrokerageAccount"],
+		topStats: [
+			{
+				format: "currency",
+				label: "Min Opening Amount",
+				fieldName: "minAmountToOpenCents",
+				raw: true,
+			},
+		],
+		stats: [
+			{
+				format: "currency",
+				label: "Stock Trading Fee",
+				fieldName: "domesticOnlineStockTradingFeeCents",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["CreditRepair"],
+		topStats: [
+			{
+				format: "rangeCurrency",
+				label: "Setup Fee",
+				initialFieldName: "setupFeeCentsMin",
+				endFieldName: "setupFeeCentsMax",
+			},
+		],
+		stats: [
+			{
+				label: "Monthly Fee",
+				format: "rangeCurrency",
+				initialFieldName: "monthlyFeeCentsMin",
+				endFieldName: "monthlyFeeCentsMax",
+			},
+			{
+				format: "boolean",
+				label: "Unlimited Disputes",
+				fieldName: "unlimitedDisputes",
+				trueValue: "Yes",
+				falseValue: "No",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["CashRewards"],
+		topStats: [
+			{
+				format: "rangeCurrency",
+				initialFieldName: "monthlyFeeCentsMin",
+				endFieldName: "monthlyFeeCentsMax",
+				label: "Monthly Fee",
+			},
+		],
+		stats: [
+			{
+				format: "listStringWithAnd",
+				label: "Categories",
+				fieldName: "categories",
+			},
+			{
+				format: "listStringWithAnd",
+				label: "Payout Method",
+				fieldName: "payoutMethod",
+			},
+		],
+	},
+	{
+		layout: "defaultOfferCard",
+		productTypes: ["DebtSettlement"],
+		topStats: [
+			{
+				format: "rangePercent",
+				label: "Debt Enrollment Fee",
+				initialFieldName: "enrollmentFeeBasisPointsMin",
+				endFieldName: "enrollmentFeeBasisPointsMax",
+			},
+		],
+		stats: [
+			{
+				format: "currency",
+				label: "Minimum Debt Amount",
+				fieldName: "debtAmountCentsMin",
+			},
+			{
+				format: "listStringWithAnd",
+				label: "State Exclusions",
+				fieldName: "stateExclusions",
+			},
+		],
+	},
+	{
+		productTypes: [
+			"UnsecuredPersonalLoan",
+			"SecuredPersonalLoan",
+			"UnsecuredLineOfCredit",
+		],
+		layout: "defaultOfferCard",
+		topStats: [
+			{
+				format: "rangeCurrency",
+				label: "Loan Amount",
+				initialFieldName: "amountCentsMin",
+				endFieldName: "amountCentsMax",
+			},
+		],
+		stats: [
+			{
+				format: "rangePercent",
+				label: " APR Range:",
+				initialFieldName: "annualPercentageRateBasisPointsMin",
+				endFieldName: "annualPercentageRateBasisPointsMax",
+			},
+			{
+				format: "common",
+				label: "Rate Type:",
+				capitalized: true,
+				fieldName: "annualPercentageRateType",
+			},
+			{
+				format: "rangeMonths",
+				label: "Term Length:",
+				initialFieldName: "termLengthMonthsMin",
+				endFieldName: "termLengthMonthsMax",
+			},
+		],
+	},
+	{
+		layout: "creditCardOfferCard",
+		productTypes: ["UnsecuredCreditCard", "SecuredCreditCard"],
+		stats: [
+			{
+				format: "annualFee",
+				label: "Annual Fee:",
+				minAnnualFeeField: "annualFeeCentsMin",
+				maxAnnualFeeField: "annualFeeCentsMax",
+				annualIntroFeeField: "annualIntroFee",
+				annualIntroFeeTermField: "annualFeeIntroTerm",
+				raw: true,
+			},
+			{
+				format: "purchaseApr",
+				label: "APR:",
+				purchaseAprTextField: "purchaseAnnualPercentageRateDescription",
+				minPurchaseAprField: "purchaseAnnualPercentageRateBasisPointsMin",
+				maxPurchaseAprField: "purchaseAnnualPercentageRateBasisPointsMax",
+				aprTypeField: "annualPercentageRateType",
+			},
+			{
+				format: "rewardsDisplay",
+				label: "Bonus:",
+				fieldName: "rewardsDescription",
+			},
+			{
+				format: "recommendedCredit",
+				label: "Recommended Credit:",
+				fieldName: "recommendedCreditRatings",
+			},
+		],
+	},
+];

package/src/builder/config/types.ts

@@ -0,0 +1,107 @@
+/**
+ * Copied from : https://github.com/EVENFinancial/cnf-services/blob/main/packages/app-utils/src/payload/payload-types.generated.ts
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "media".
+ */
+export interface Media {
+	id: string;
+	autoCrop?: boolean | null;
+	alt?: string | null;
+	aiInference?:
+		| {
+				[k: string]: unknown;
+		  }
+		| unknown[]
+		| string
+		| number
+		| boolean
+		| null;
+	updatedAt: string;
+	createdAt: string;
+	url?: string | null;
+	filename?: string | null;
+	mimeType?: string | null;
+	filesize?: number | null;
+	width?: number | null;
+	height?: number | null;
+}
+
+/**
+ * Copied from : https://github.com/EVENFinancial/cnf-services/blob/main/packages/app-utils/src/payload/payload-types.generated.ts
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "brands".
+ */
+export interface Brand {
+	id: string;
+	displayName: string;
+	domain: string;
+	type: "business" | "product" | "individual";
+	logos?: {
+		horizontal?: string | Media | null;
+		icon?: string | Media | null;
+	};
+	palette?: {
+		promotional?: string | null;
+		generation?: ("generate" | "provided") | null;
+		colorScheme?: ("balanced" | "light" | "dark") | null;
+		positive?: string | null;
+		critical?: string | null;
+		highlight?: string | null;
+		neutral?: string | null;
+	};
+	isLicensed?: boolean | null;
+	licensedBrand?: (string | null) | Brand;
+	allowedMarks: {
+		logo: boolean;
+		name: boolean;
+	};
+	hideLicensedLogo?: boolean | null;
+	font?: {
+		family?:
+			| (
+					| "nunito"
+					| "lato"
+					| "sourceSans3"
+					| "openSans"
+					| "roboto"
+					| "arimo"
+					| "montserrat"
+			  )
+			| null;
+	};
+	links?: {
+		home?: string | null;
+		terms?: string | null;
+		support?: string | null;
+		privacy?: string | null;
+	};
+	ctaRoundness?: {
+		small?: number | null;
+		medium?: number | null;
+		large?: number | null;
+	};
+	updatedAt: string;
+	createdAt: string;
+}
+
+export type OverridePartnerPage = {
+	productTypeSlug?: string;
+	partnerPageUrl?: string;
+};
+
+export type Config = {
+	dynamicOffer?: {
+		title?: string;
+		hostURL?: string;
+		defaultProductType?: string;
+		overridePartnerPage?: OverridePartnerPage[];
+		subAccountToken?: string;
+		isDev: boolean;
+		cnfAppBaseUrl: string;
+		cnfBaseUrl: string;
+		tags: string;
+	};
+	brand?: {
+		palette: Brand["palette"];
+	};
+};

package/src/builder/index.ts

@@ -0,0 +1,2 @@
+export * from "./builder";
+export * from "./config/types";

package/src/capabilities/configuration/src/brands/checkVisualEligibility.ts

@@ -0,0 +1,29 @@
+import { get } from "radash";
+import { enhanceType, type Brand } from "./types";
+import { match, P } from "ts-pattern";
+
+/**
+ * A UI centric concept that prioritizes brands for visual use, both by the data available and the preferences of the brand.
+ */
+export type VisualBrandKind = "primary" | "secondary" | "none";
+
+/**
+ * Determines the highest visual eligibility a Brand supports.
+ * Used to rank a primary eligible brand highest if no brand prefers primary, such as a licensed brand
+ * @param brand
+ */
+export const checkVisualBrandEligibility = (brand: Brand) =>
+	match([enhanceType(brand), get(brand, "allowedMarks"), brand?.isLicensed])
+		.returnType<VisualBrandKind>()
+		.with(
+			[P._, P._, true],
+			["business", { logo: true, name: true }, P.any],
+			["product", { logo: true, name: true }, P.any],
+			() => "primary"
+		)
+		.with(
+			["individual", P._, P.any],
+			["business", { name: true, logo: false }, P.any],
+			() => "secondary"
+		)
+		.otherwise(() => "none");

package/src/capabilities/configuration/src/brands/createDerivedBrands.ts

@@ -0,0 +1,39 @@
+import { isObject, sift } from "radash";
+import type { Brand } from "../../../../builder";
+import { P, match } from "ts-pattern";
+import { enhanceType } from "./types";
+import { checkVisualBrandEligibility } from "./checkVisualEligibility";
+
+/**
+ * Extracts and normalizes a brand into -
+ * LicensedBrand - The brand to be used for terms, legal and other compliance needs
+ * VisualBrands - The brands to be shown to the user
+ * @param brand
+ */
+export const createDerivedBrands = (brand: Brand) => {
+	// Determine the licensed brand for this brand, keeping in mind that this brand may be the licensed brand
+	const licensedBrand = match([
+		enhanceType(brand),
+		brand?.isLicensed || brand?.licensedBrand,
+	])
+		// Ensure we get back a brand at the end
+		.returnType<Brand>()
+		// If the type is licensed, return this brand
+		.with(["licensed", P._], () => brand)
+		// If the type is not licensed, but there is a cobrand setup, use that to get the licensed brand
+		.with(
+			[P.not("licensed"), P.select("licensedBrandObj")],
+			({ licensedBrandObj }) => {
+				if (isObject(licensedBrandObj)) return licensedBrandObj;
+				// Throw if no licensed brand is able to be found
+				throw new Error("Missing Licensed Brand");
+			}
+		)
+		.otherwise(() => {
+			throw new Error("Missing Licensed Brand");
+		});
+
+	// Determine the set of visual brands which should be displayed on the page
+	const brandCanBeShown = checkVisualBrandEligibility(brand) !== "none";
+	return Array.from(new Set(sift([licensedBrand, brandCanBeShown && brand])));
+};

package/src/capabilities/configuration/src/brands/index.ts

@@ -0,0 +1,2 @@
+export { enhanceType } from "./types";
+export { checkVisualBrandEligibility } from "./checkVisualEligibility";

package/src/capabilities/configuration/src/brands/types.ts

@@ -0,0 +1,8 @@
+import { isObject } from "radash";
+import type { Brand } from "../../../../builder";
+
+export const enhanceType = (brand: Brand) => {
+	if (isObject(brand)) return brand?.isLicensed ? "licensed" : brand.type;
+	return undefined;
+};
+export type { Brand };

package/src/capabilities/core/src/domain/third-party-search/index.ts

@@ -0,0 +1 @@
+export * from "./orderProductTypesByRankUtils";