feat: migrate format from @guardian/types

README.md

@@ -13,6 +13,7 @@
 
 - [Modules](#modules)
   - [`cookies`](#cookies)
+  - [`format`](#format)
   - [`getLocale`](#getlocale)
   - [`getSwitches`](#getswitches)
   - [`isBoolean`](#isboolean)
@@ -39,6 +40,10 @@ The following modules are available:
 
 API over `document.cookies`.
 
+### [`format`](./src/format.README.md)
+
+Types and enums related to editorial formats.
+
 ### [`getLocale`](./src/getLocale.README.md)
 
 Get the user’s current location.

src/format.README.md

@@ -0,0 +1,10 @@
+# `format`
+
+Types and enums related to editorial formats.
+
+### Usage
+
+```js
+import type { Theme, Format } from '@guardian/libs';
+import { Pillar, Special, Design, Display } from '@guardian/libs';
+```

src/format.test.ts

@@ -0,0 +1,17 @@
+import { Design, Display, Pillar, Special } from './format';
+
+it('Design enum contains Article', () => {
+	expect(Design.Article).toBeDefined();
+});
+
+it('Display enum contains Standard', () => {
+	expect(Display.Standard).toBeDefined();
+});
+
+it('Pillar enum contains News', () => {
+	expect(Pillar.News).toBe(0);
+});
+
+it('Special enum contains SpecialReport', () => {
+	expect(Special.SpecialReport).toBe(5);
+});

src/format.ts

@@ -0,0 +1,54 @@
+// ----- Types ----- //
+
+enum Pillar {
+	News = 0,
+	Opinion = 1,
+	Sport = 2,
+	Culture = 3,
+	Lifestyle = 4,
+}
+
+enum Special {
+	SpecialReport = 5,
+	Labs = 6,
+}
+
+type Theme = Pillar | Special;
+
+enum Design {
+	Article,
+	Media,
+	Review,
+	Analysis,
+	Comment,
+	Letter,
+	Feature,
+	LiveBlog,
+	DeadBlog,
+	Recipe,
+	MatchReport,
+	Interview,
+	Editorial,
+	Quiz,
+	Interactive,
+	PhotoEssay,
+	PrintShop,
+}
+
+enum Display {
+	Standard,
+	Immersive,
+	Showcase,
+	NumberedList,
+}
+
+interface Format {
+	theme: Theme;
+	design: Design;
+	display: Display;
+}
+
+// ----- Exports ----- //
+
+export type { Theme, Format };
+export { Pillar, Special, Design, Display };

src/index.ts

@@ -6,6 +6,8 @@ export {
 	setCookie,
 	setSessionCookie,
 } from './cookies';
+export type { Theme, Format } from './format';
+export { Pillar, Special, Design, Display } from './format';
 export { getLocale } from './getLocale';
 export { getSwitches } from './getSwitches';
 export { isBoolean } from './isBoolean';