@newskit-render/feed 0.20.0 → 0.21.0-alpha.0

package/dist/esm/rss/helpers/buildLists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildLists.js","sourceRoot":"","sources":["../../../../src/rss/helpers/buildLists.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC9E,OAAO,EAA8B,aAAa,EAAY,MAAM,UAAU,CAAA;AAE9E,MAAM,CAAC,IAAM,mBAAmB,GAAG,UAAC,aAA4B;IAC9D,OAAA,SAAO,aAAa,CAAC,KAAK;SACvB,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,SAAO,iBAAiB,CAAC,IAAI,CAAC,UAAO,EAArC,CAAqC,CAAC;SACpD,IAAI,CAAC,EAAE,CAAC,UAAO;AAFlB,CAEkB,CAAA;AAEpB,MAAM,CAAC,IAAM,iBAAiB,GAAG,UAAC,WAAwB;IACxD,OAAA,SAAO,WAAW,CAAC,KAAK;SACrB,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,SAAO,iBAAiB,CAAC,IAAI,CAAC,UAAO,EAArC,CAAqC,CAAC;SACpD,IAAI,CAAC,EAAE,CAAC,UAAO;AAFlB,CAEkB,CAAA;AAEpB,MAAM,CAAC,IAAM,iBAAiB,GAAG,UAAC,IAAc;IAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,aAAa,CAAC,IAAI;YACrB,OAAO,eAAe,CAAC,IAAI,CAAC,CAAA;QAC9B,KAAK,aAAa,CAAC,SAAS;YAC1B,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,KAAK,aAAa,CAAC,aAAa;YAC9B,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAA;QAClC,KAAK,aAAa,CAAC,WAAW;YAC5B,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAChC;YACE,OAAO,EAAE,CAAA;KACZ;AACH,CAAC,CAAA"}

package/dist/esm/rss/helpers/index.d.ts

@@ -1 +1,3 @@
 export * from './articleHelper';
+export * from './buildLists';
+export * from './buildBodyDataTypesMap';

package/dist/esm/rss/helpers/index.js

@@ -1,2 +1,4 @@
 export * from './articleHelper';
+export * from './buildLists';
+export * from './buildBodyDataTypesMap';
 //# sourceMappingURL=index.js.map

package/dist/esm/rss/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/rss/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/rss/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,yBAAyB,CAAA"}

package/dist/esm/rss/queries/getArticleList.js

@@ -3,6 +3,6 @@ var __makeTemplateObject = (this && this.__makeTemplateObject) || function (cook
     return cooked;
 };
 import { gql } from '@apollo/client';
-export var GET_ARTICLE_LIST = gql(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n  query getArticleList(\n    $publisher: Publisher!\n    $from: Date\n    $to: Date\n    $cursor: String\n  ) {\n    articleList(\n      publisher: $publisher\n      from: $from\n      to: $to\n      cursor: $cursor\n      limit: 20\n    ) {\n      pageCursors {\n        next\n      }\n      data {\n        categories {\n          slug\n        }\n        bylines {\n          ... on AuthorByline {\n            name\n          }\n        }\n        publisher\n        publishedDateTime\n        updatedDateTime\n        headline\n        id\n        body {\n          ... on ImageBlock {\n            alt\n            caption\n            credit\n            height\n            width\n            type\n            url\n          }\n          ... on ParagraphBlock {\n            children {\n              ... on TextBlock {\n                bold\n                italic\n                monospace\n                text\n                type\n                underline\n              }\n              ... on HyperlinkBlock {\n                text\n                type\n                url\n              }\n            }\n            type\n          }\n        }\n      }\n      meta {\n        countTotal\n      }\n    }\n  }\n"], ["\n  query getArticleList(\n    $publisher: Publisher!\n    $from: Date\n    $to: Date\n    $cursor: String\n  ) {\n    articleList(\n      publisher: $publisher\n      from: $from\n      to: $to\n      cursor: $cursor\n      limit: 20\n    ) {\n      pageCursors {\n        next\n      }\n      data {\n        categories {\n          slug\n        }\n        bylines {\n          ... on AuthorByline {\n            name\n          }\n        }\n        publisher\n        publishedDateTime\n        updatedDateTime\n        headline\n        id\n        body {\n          ... on ImageBlock {\n            alt\n            caption\n            credit\n            height\n            width\n            type\n            url\n          }\n          ... on ParagraphBlock {\n            children {\n              ... on TextBlock {\n                bold\n                italic\n                monospace\n                text\n                type\n                underline\n              }\n              ... on HyperlinkBlock {\n                text\n                type\n                url\n              }\n            }\n            type\n          }\n        }\n      }\n      meta {\n        countTotal\n      }\n    }\n  }\n"])));
+export var GET_ARTICLE_LIST = gql(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n  query getArticleList(\n    $publisher: Publisher!\n    $from: Date\n    $to: Date\n    $cursor: String\n  ) {\n    articleList(\n      publisher: $publisher\n      from: $from\n      to: $to\n      cursor: $cursor\n      limit: 20\n    ) {\n      pageCursors {\n        next\n      }\n      data {\n        categories {\n          slug\n        }\n        bylines {\n          ... on AuthorByline {\n            name\n          }\n        }\n        publisher\n        publishedDateTime\n        updatedDateTime\n        headline\n        id\n        body {\n          ... on ImageBlock {\n            alt\n            caption\n            credit\n            height\n            width\n            type\n            url\n          }\n          ... on ParagraphBlock {\n            paragraphs: children {\n              ... on TextBlock {\n                bold\n                italic\n                monospace\n                text\n                type\n                underline\n              }\n              ... on HyperlinkBlock {\n                text\n                type\n                url\n              }\n            }\n            type\n          }\n          ... on TextBlock {\n            type\n            text\n            bold\n            italic\n          }\n          ... on HeadingBlock {\n            type\n            level\n          }\n          ... on FormStackBlock {\n            type\n            id\n          }\n          ... on TweetBlock {\n            type\n            id\n          }\n          ... on InstagramBlock {\n            type\n            id\n          }\n          ... on YoutubeBlock {\n            type\n            id\n          }\n          ... on VideoBrightcoveBlock {\n            type\n            id\n            accountId\n            playerId\n          }\n          ... on OrderedListBlock {\n            type\n            items {\n              ... on HyperlinkBlock {\n                type\n                url\n                text\n              }\n              ... on TextBlock {\n                type\n                text\n                bold\n                italic\n              }\n            }\n          }\n          ... on UnorderedListBlock {\n            type\n            items {\n              ... on HyperlinkBlock {\n                type\n                url\n                text\n              }\n              ... on TextBlock {\n                type\n                text\n                bold\n                italic\n              }\n            }\n          }\n          ... on EmbedBlock {\n            type\n            url\n          }\n          ... on HeadingBlock {\n            type\n            level\n            children {\n              ... on TextBlock {\n                type\n                text\n                bold\n                italic\n              }\n            }\n          }\n        }\n      }\n      meta {\n        countTotal\n      }\n    }\n  }\n"], ["\n  query getArticleList(\n    $publisher: Publisher!\n    $from: Date\n    $to: Date\n    $cursor: String\n  ) {\n    articleList(\n      publisher: $publisher\n      from: $from\n      to: $to\n      cursor: $cursor\n      limit: 20\n    ) {\n      pageCursors {\n        next\n      }\n      data {\n        categories {\n          slug\n        }\n        bylines {\n          ... on AuthorByline {\n            name\n          }\n        }\n        publisher\n        publishedDateTime\n        updatedDateTime\n        headline\n        id\n        body {\n          ... on ImageBlock {\n            alt\n            caption\n            credit\n            height\n            width\n            type\n            url\n          }\n          ... on ParagraphBlock {\n            paragraphs: children {\n              ... on TextBlock {\n                bold\n                italic\n                monospace\n                text\n                type\n                underline\n              }\n              ... on HyperlinkBlock {\n                text\n                type\n                url\n              }\n            }\n            type\n          }\n          ... on TextBlock {\n            type\n            text\n            bold\n            italic\n          }\n          ... on HeadingBlock {\n            type\n            level\n          }\n          ... on FormStackBlock {\n            type\n            id\n          }\n          ... on TweetBlock {\n            type\n            id\n          }\n          ... on InstagramBlock {\n            type\n            id\n          }\n          ... on YoutubeBlock {\n            type\n            id\n          }\n          ... on VideoBrightcoveBlock {\n            type\n            id\n            accountId\n            playerId\n          }\n          ... on OrderedListBlock {\n            type\n            items {\n              ... on HyperlinkBlock {\n                type\n                url\n                text\n              }\n              ... on TextBlock {\n                type\n                text\n                bold\n                italic\n              }\n            }\n          }\n          ... on UnorderedListBlock {\n            type\n            items {\n              ... on HyperlinkBlock {\n                type\n                url\n                text\n              }\n              ... on TextBlock {\n                type\n                text\n                bold\n                italic\n              }\n            }\n          }\n          ... on EmbedBlock {\n            type\n            url\n          }\n          ... on HeadingBlock {\n            type\n            level\n            children {\n              ... on TextBlock {\n                type\n                text\n                bold\n                italic\n              }\n            }\n          }\n        }\n      }\n      meta {\n        countTotal\n      }\n    }\n  }\n"])));
 var templateObject_1;
 //# sourceMappingURL=getArticleList.js.map

package/dist/esm/rss/queries/getArticleList.js.map

@@ -1 +1 @@
-{"version":3,"file":"getArticleList.js","sourceRoot":"","sources":["../../../../src/rss/queries/getArticleList.ts"],"names":[],"mappings":";;;;AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AAEpC,MAAM,CAAC,IAAM,gBAAgB,GAAG,GAAG,wxCAAA,qtCAkElC,IAAA,CAAA"}
+{"version":3,"file":"getArticleList.js","sourceRoot":"","sources":["../../../../src/rss/queries/getArticleList.ts"],"names":[],"mappings":";;;;AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AAEpC,MAAM,CAAC,IAAM,gBAAgB,GAAG,GAAG,u+FAAA,o6FAkJlC,IAAA,CAAA"}

package/dist/esm/rss/types.d.ts

@@ -1,5 +1,6 @@
 import { NextApiResponse } from 'next';
 import { Publisher } from '@newskit-render/api';
+import { VideoBrightcoveBlock } from 'helpers/types';
 export declare type UpdatePeriod = 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly';
 export declare type TiteAttributes = {
     title: string;
@@ -33,7 +34,12 @@ export declare type HyperlinkBlock = {
 export declare type ParagraphBlockChildren = TextBlock | HyperlinkBlock;
 export declare type ParagraphBlock = {
     type: 'paragraph';
-    children: ParagraphBlockChildren[];
+    paragraphs: ParagraphBlockChildren[];
+};
+export declare type HeadingBlock = {
+    type: 'heading';
+    level: number;
+    children: TextBlock[];
 };
 export declare type ImageBlock = {
     alt: string;
@@ -44,18 +50,70 @@ export declare type ImageBlock = {
     url: string;
     type: 'image';
 };
-export declare type Body = ParagraphBlock | ImageBlock;
+export declare type TweetBlock = {
+    id: string;
+    type: 'tweet';
+};
+export declare type FormStackBlock = {
+    id: string;
+    type: string;
+};
+export declare type EmbedBlock = {
+    type: 'embed';
+    url: string;
+};
+export declare type InstagramBlock = {
+    id: string;
+    type: 'instagram';
+};
+export declare type YoutubeBlock = {
+    id: 'youtube';
+    type: string;
+};
+export declare type Body = TextBlock | ParagraphBlock | ImageBlock | HeadingBlock | EmbedBlock | FormStackBlock | InstagramBlock | VideoBrightcoveBlock | UnorderedList | OrderedList;
 export declare type Summary = {
     children: {
         text: string;
     }[];
 };
+export declare type ListItem = UnorderedList | OrderedList | TextBlock | HyperlinkBlock;
+export declare enum ListTypes {
+    UnorderedList = "unordered-list",
+    OrderedList = "ordered-list"
+}
+export declare type UnorderedList = {
+    type: 'unordered-list';
+    items: [ListItem];
+};
+export declare type OrderedList = {
+    type: 'ordered-list';
+    items: [ListItem];
+};
+export declare enum ListItemTypes {
+    UnorderedList = "unordered-list",
+    OrderedList = "ordered-list",
+    Text = "text",
+    Hyperlink = "hyperlink"
+}
+/**
+ * the Category type, as returned from the API has the following shape:
+ * {
+  id: string
+  parentId: string
+  slug: string
+  title: string
+  type: 'category'
+}
+we're cirrently only using slug, but we might need to use more in the future.
+I have exported the type as it is used now to be able to type an argument in the code properly
+ */
+export declare type ArticleCategory = {
+    slug: string;
+};
 export declare type Article = {
     id: string | number;
     headline: string;
-    categories: {
-        slug: string;
-    }[];
+    categories: ArticleCategory[];
     bylines?: {
         name: string;
     }[];
@@ -65,3 +123,27 @@ export declare type Article = {
     body: Body[];
 };
 export declare type ArticleList = Article[];
+export declare enum BodyBlockTypes {
+    Paragraph = "paragraph",
+    Image = "image",
+    Heading = "heading",
+    Tweet = "tweet",
+    Youtube = "youtube",
+    Instagram = "instagram",
+    Embed = "embed",
+    VideoBrightcove = "video-brightcove",
+    UnorderedListBlock = "unordered-list",
+    OrderedListBlock = "ordered-list"
+}
+export declare type BodyDataTypesMap = {
+    [BodyBlockTypes.Paragraph]: (data: ParagraphBlock) => string;
+    [BodyBlockTypes.Image]: (data: ImageBlock, imageSourceSizes?: string[]) => string;
+    [BodyBlockTypes.UnorderedListBlock]: (list: UnorderedList) => string;
+    [BodyBlockTypes.OrderedListBlock]: (list: OrderedList) => string;
+    [BodyBlockTypes.Heading]: (data: HeadingBlock) => string;
+    [BodyBlockTypes.Tweet]: (data: TweetBlock) => string;
+    [BodyBlockTypes.Youtube]: (data: YoutubeBlock) => string;
+    [BodyBlockTypes.Instagram]: (data: InstagramBlock) => string;
+    [BodyBlockTypes.VideoBrightcove]: (data: VideoBrightcoveBlock) => string;
+    [BodyBlockTypes.Embed]: (data: EmbedBlock) => string;
+};

package/dist/esm/rss/types.js

@@ -1,2 +1,26 @@
-export {};
+export var ListTypes;
+(function (ListTypes) {
+    ListTypes["UnorderedList"] = "unordered-list";
+    ListTypes["OrderedList"] = "ordered-list";
+})(ListTypes || (ListTypes = {}));
+export var ListItemTypes;
+(function (ListItemTypes) {
+    ListItemTypes["UnorderedList"] = "unordered-list";
+    ListItemTypes["OrderedList"] = "ordered-list";
+    ListItemTypes["Text"] = "text";
+    ListItemTypes["Hyperlink"] = "hyperlink";
+})(ListItemTypes || (ListItemTypes = {}));
+export var BodyBlockTypes;
+(function (BodyBlockTypes) {
+    BodyBlockTypes["Paragraph"] = "paragraph";
+    BodyBlockTypes["Image"] = "image";
+    BodyBlockTypes["Heading"] = "heading";
+    BodyBlockTypes["Tweet"] = "tweet";
+    BodyBlockTypes["Youtube"] = "youtube";
+    BodyBlockTypes["Instagram"] = "instagram";
+    BodyBlockTypes["Embed"] = "embed";
+    BodyBlockTypes["VideoBrightcove"] = "video-brightcove";
+    BodyBlockTypes["UnorderedListBlock"] = "unordered-list";
+    BodyBlockTypes["OrderedListBlock"] = "ordered-list";
+})(BodyBlockTypes || (BodyBlockTypes = {}));
 //# sourceMappingURL=types.js.map

package/dist/esm/rss/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/rss/types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/rss/types.ts"],"names":[],"mappings":"AAuGA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,6CAAgC,CAAA;IAChC,yCAA4B,CAAA;AAC9B,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAUD,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,iDAAgC,CAAA;IAChC,6CAA4B,CAAA;IAC5B,8BAAa,CAAA;IACb,wCAAuB,CAAA;AACzB,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AA8BD,MAAM,CAAN,IAAY,cAWX;AAXD,WAAY,cAAc;IACxB,yCAAuB,CAAA;IACvB,iCAAe,CAAA;IACf,qCAAmB,CAAA;IACnB,iCAAe,CAAA;IACf,qCAAmB,CAAA;IACnB,yCAAuB,CAAA;IACvB,iCAAe,CAAA;IACf,sDAAoC,CAAA;IACpC,uDAAqC,CAAA;IACrC,mDAAiC,CAAA;AACnC,CAAC,EAXW,cAAc,KAAd,cAAc,QAWzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newskit-render/feed",
-  "version": "0.20.0",
+  "version": "0.21.0-alpha.0",
   "description": "Newskit Render - Feed package",
   "author": "",
   "module": "dist/esm/index.js",
@@ -18,13 +18,14 @@
     "build:watch": "tsc -b tsconfig.build.json -w",
     "test:unit": "jest --coverage",
     "test:unit:watch": "jest --watch",
+    "test:unit:ci": "JEST_JUNIT_OUTPUT_NAME=feed.xml node --max_old_space_size=4096 --expose-gc ./node_modules/.bin/jest --ci --coverage --reporters=default --reporters=jest-junit --runInBand --logHeapUsage",
     "lint": "eslint --ext .js,.jsx,.ts,.tsx src --color",
     "lint:fix": "eslint --ext .js,.ts src --color --fix && prettier --write 'src/**/*.{js,ts,json}'",
     "clean": "rm -rf node_modules & rm -f package-lock.json & rm -f yarn.lock"
   },
   "dependencies": {
     "@apollo/client": "3.3.7",
-    "@newskit-render/api": "^0.32.0",
+    "@newskit-render/api": "^0.32.1-alpha.2",
     "cross-fetch": "3.1.5",
     "graphql": "15.6.0",
     "lodash.escape": "4.0.1",
@@ -46,6 +47,7 @@
     "eslint-config-prettier": "7.1.0",
     "eslint-plugin-prettier": "3.3.1",
     "jest": "27.4.7",
+    "jest-junit": "12.0.0",
     "next": "12.1.0",
     "prettier": "2.2.1",
     "ts-jest": "27.1.3",