identityName: nonEmptyString()

in libs/newsletters-data-client/src/lib/schemas/legacy-newsletter-type.ts [18:86]

• 67 lines of code
• 1 McCabe index (conditional complexity)

	identityName: nonEmptyString().describe('the unique id for the newsletter'),
	name: nonEmptyString().describe('the public name of the newsletter'),
	cancelled: z
		.boolean()
		.describe(
			'if true, the newsletter has been permanently discontinued, but must be retained on the list for data analysis and historical reports',
		),
	restricted: z
		.boolean()
		.describe(
			"The exact semantic meaning is not defined - believed to indicate the newsletter required payment or otherwise cannot be freely subscribed to by all users. Restricted newsletters don't appear on the all newsletters page and in-article promotions for them will not be rendered.",
		),
	paused: z
		.boolean()
		.describe(
			"Indicates the newsletter is not being sent currently, but may be (re)started in future. Paused newsletters don't appear on the all newsletters page and in-article promotions for them will not be rendered.",
		),
	emailConfirmation: z
		.boolean()
		.describe(
			'whether a confirmation email is sent to verify the subscription after a user submits a sign-up form',
		),
	brazeNewsletterName: z.string().optional(),
	brazeSubscribeAttributeName: z.string().optional(),
	brazeSubscribeEventNamePrefix: z.string().optional(),
	theme: themeLegacyEnumSchema,
	group: nonEmptyString().describe(
		'the name of the section of the newsletters page the newsletter will be listed under',
	),
	description: z
		.string()
		.optional()
		.describe('a short description of the newsletter to display to users'),
	regionFocus: z
		.string()
		.optional()
		.describe('Which region (AU, UK, US, EUR) the newsletter is targetted at'),
	frequency: z
		.string()
		.optional()
		.describe('how often the newsletter is sent.'),
	listId: z.number().describe('a unique reference number for the newsletter'),
	listIdV1: z
		.number()
		.describe(
			'a legacy reference number - no longer needed, but retained on older newsletters for reference.',
		),
	emailEmbed: emailEmbedSchema.optional(),
	campaignName: z.string().optional(),
	campaignCode: z.string().optional(),
	brazeSubscribeAttributeNameAlternate: z.array(z.string()).optional(),
	signupPage: z
		.string()
		.optional()
		.describe('the relative link to the sign-up page on theguardian.com'),
	exampleUrl: z
		.string()
		.optional()
		.describe(
			'a relative link to a page on theguardian.com rendering an example chapter of the newsletter',
		),
	illustration: illustrationSchema.optional(),
});

type Base = z.infer<typeof baseLegacyNewsletterSchema>;
export const getPropertyDescription = (key: keyof Base): string =>
	baseLegacyNewsletterSchema.shape[key].description ?? '';

export const legacyNewsletterSchema = baseLegacyNewsletterSchema.extend({