@financial-times/cp-content-pipeline-schema 0.3.4 → 0.3.5

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.3.5](https://github.com/Financial-Times/cp-content-pipeline/compare/cp-content-pipeline-schema-v0.3.4...cp-content-pipeline-schema-v0.3.5) (2022-11-01)
+
+
+### Features
+
+* create a new Flourish tag class ([95b7e9e](https://github.com/Financial-Times/cp-content-pipeline/commit/95b7e9e2962914679019938e9f4670d54b033cba))
+* use the new Flourish tag in the schema and article query ([5e87745](https://github.com/Financial-Times/cp-content-pipeline/commit/5e87745e8d0ad0df51adbf4cf4790127e03f758d))
+
 ## [0.3.4](https://github.com/Financial-Times/cp-content-pipeline/compare/cp-content-pipeline-schema-v0.3.3...cp-content-pipeline-schema-v0.3.4) (2022-10-27)
 
 

package/lib/tags/Flourish.d.ts

@@ -0,0 +1,24 @@
+import type { TagConstructor } from './index.js';
+import type * as hast from 'hast';
+import { QueryContext } from '../index.js';
+import { Flourish as FlourishModel } from './model/Flourish.js';
+declare class Flourish {
+    id: string;
+    model: FlourishModel;
+    static selector: string;
+    constructor(node: hast.Element);
+    static resolve: {
+        id: (parent: Flourish) => string;
+        type: (parent: Flourish) => string;
+        description: (parent: Flourish) => string;
+        fullGrid: (parent: Flourish) => boolean;
+        fallbackImage: (parent: Flourish, _args: any, context: QueryContext) => Promise<{
+            url: string;
+            width: number;
+            height: number;
+        }>;
+    };
+    static typeDef: import("graphql").DocumentNode;
+}
+declare const FlourishClass: TagConstructor<Flourish>;
+export { FlourishClass as Flourish };

package/lib/tags/Flourish.js

@@ -0,0 +1,37 @@
+var _a;
+import { gql } from 'graphql-tag';
+import { Flourish as FlourishModel } from './model/Flourish.js';
+class Flourish {
+    constructor(node) {
+        var _b;
+        if (typeof ((_b = node.properties) === null || _b === void 0 ? void 0 : _b.id) !== 'string') {
+            throw new Error('Flourish is missing a href');
+        }
+        this.id = node.properties.id;
+        // Adding the model to the instance is required until we refactor how the resolve method integrates
+        this.model = new FlourishModel(node, this.id);
+    }
+}
+_a = Flourish;
+Flourish.selector = '[data-asset-type="flourish"]';
+Flourish.resolve = {
+    id: (parent) => parent.id,
+    type: (parent) => parent.model.type(),
+    description: (parent) => parent.model.description(),
+    fullGrid: (parent) => parent.model.fullGrid(),
+    fallbackImage: async (parent, _args, context) => parent.model.fallbackImage(context),
+};
+Flourish.typeDef = gql `
+    type Flourish {
+      id: String!
+      type: String!
+      fullGrid: Boolean!
+      description: String
+      fallbackImage: FlourishFallback
+    }
+
+    ${FlourishModel.typedef}
+  `;
+const FlourishClass = Flourish;
+export { FlourishClass as Flourish };
+//# sourceMappingURL=Flourish.js.map

package/lib/tags/Flourish.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Flourish.js","sourceRoot":"","sources":["../../src/tags/Flourish.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAIjC,OAAO,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAE/D,MAAM,QAAQ;IAMZ,YAAY,IAAkB;;QAC5B,IAAI,OAAO,CAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,EAAE,CAAA,KAAK,QAAQ,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;SAC9C;QAED,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAA;QAE5B,mGAAmG;QACnG,IAAI,CAAC,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;IAC/C,CAAC;;;AAXM,iBAAQ,GAAG,8BAA8B,CAAA;AAazC,gBAAO,GAAG;IACf,EAAE,EAAE,CAAC,MAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE;IACnC,IAAI,EAAE,CAAC,MAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE;IAC/C,WAAW,EAAE,CAAC,MAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE;IAC7D,QAAQ,EAAE,CAAC,MAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE;IACvD,aAAa,EAAE,KAAK,EAClB,MAAgB,EAChB,KAAU,EACV,OAAqB,EACrB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC;CACzC,CAAA;AAEM,gBAAO,GAAG,GAAG,CAAA;;;;;;;;;MAShB,aAAa,CAAC,OAAO;GACxB,CAAA;AAGH,MAAM,aAAa,GAA6B,QAAQ,CAAA;AAExD,OAAO,EAAE,aAAa,IAAI,QAAQ,EAAE,CAAA"}

package/lib/tags/index.js

@@ -4,6 +4,7 @@ import { ImageSet } from './ImageSet.js';
 import { PullQuote } from './PullQuote.js';
 import { Recommended } from './Recommended.js';
 import { Tweet } from './Tweet.js';
+import { Flourish } from './Flourish.js';
 import { gql } from 'graphql-tag';
 function createTagWithoutReference(name, selector) {
     var _a;
@@ -38,6 +39,7 @@ export const tags = {
     Emphasis: createTagWithoutReference('Emphasis', 'em'),
     Strong: createTagWithoutReference('Strong', 'strong'),
     Strikethrough: createTagWithoutReference('Strikethrough', 's'),
+    Flourish,
 };
 const tagEntries = Object.entries(tags);
 const tagsWithReferences = tagEntries.filter(([, tag]) => tag.typeDef);

package/lib/tags/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tags/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAWjC,SAAS,yBAAyB,CAChC,IAAY,EACZ,QAAgB;;IAEhB,MAAM,GAAG,SAAG;SAEX;QADQ,WAAQ,GAAG,QAAQ;WAC3B,CAAA;IAED,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAEnD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,MAAM,CAAC,MAAM,IAAI,GAAmC;IAClD,IAAI;IACJ,YAAY,EAAE,yBAAyB,CAAC,cAAc,EAAE,cAAc,CAAC;IACvE,QAAQ;IACR,WAAW;IACX,gBAAgB,EAAE,yBAAyB,CACzC,kBAAkB,EAClB,mBAAmB,CACpB;IACD,SAAS,EAAE,yBAAyB,CAAC,WAAW,EAAE,GAAG,CAAC;IACtD,aAAa,EAAE,yBAAyB,CAAC,eAAe,EAAE,IAAI,CAAC;IAC/D,WAAW,EAAE,yBAAyB,CAAC,aAAa,EAAE,IAAI,CAAC;IAC3D,QAAQ,EAAE,yBAAyB,CAAC,UAAU,EAAE,IAAI,CAAC;IACrD,MAAM,EAAE,yBAAyB,CAAC,QAAQ,EAAE,4BAA4B,CAAC;IACzE,eAAe,EAAE,yBAAyB,CACxC,iBAAiB,EACjB,iDAAiD,CAClD;IACD,UAAU,EAAE,yBAAyB,CACnC,YAAY,EACZ,uCAAuC,CACxC;IACD,WAAW;IACX,SAAS;IACT,aAAa,EAAE,yBAAyB,CAAC,eAAe,EAAE,iBAAiB,CAAC;IAC5E,eAAe,EAAE,yBAAyB,CACxC,eAAe,EACf,mBAAmB,CACpB;IACD,UAAU,EAAE,yBAAyB,CAAC,YAAY,EAAE,YAAY,CAAC;IACjE,KAAK;IACL,SAAS,EAAE,yBAAyB,CAAC,WAAW,EAAE,IAAI,CAAC;IACvD,cAAc,EAAE,yBAAyB,CAAC,gBAAgB,EAAE,IAAI,CAAC;IACjE,QAAQ,EAAE,yBAAyB,CAAC,UAAU,EAAE,IAAI,CAAC;IACrD,MAAM,EAAE,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,CAAC;IACrD,aAAa,EAAE,yBAAyB,CAAC,eAAe,EAAE,GAAG,CAAC;CAC/D,CAAA;AAED,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AACvC,MAAM,kBAAkB,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;AAEtE,MAAM,CAAC,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAC/C,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,OAAuB,CAC7C,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAA,qBAAqB,kBAAkB;KACtE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC;KACvB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAA;AAEhB,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CACzC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAC9E,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tags/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAWjC,SAAS,yBAAyB,CAChC,IAAY,EACZ,QAAgB;;IAEhB,MAAM,GAAG,SAAG;SAEX;QADQ,WAAQ,GAAG,QAAQ;WAC3B,CAAA;IAED,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAEnD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,MAAM,CAAC,MAAM,IAAI,GAAmC;IAClD,IAAI;IACJ,YAAY,EAAE,yBAAyB,CAAC,cAAc,EAAE,cAAc,CAAC;IACvE,QAAQ;IACR,WAAW;IACX,gBAAgB,EAAE,yBAAyB,CACzC,kBAAkB,EAClB,mBAAmB,CACpB;IACD,SAAS,EAAE,yBAAyB,CAAC,WAAW,EAAE,GAAG,CAAC;IACtD,aAAa,EAAE,yBAAyB,CAAC,eAAe,EAAE,IAAI,CAAC;IAC/D,WAAW,EAAE,yBAAyB,CAAC,aAAa,EAAE,IAAI,CAAC;IAC3D,QAAQ,EAAE,yBAAyB,CAAC,UAAU,EAAE,IAAI,CAAC;IACrD,MAAM,EAAE,yBAAyB,CAAC,QAAQ,EAAE,4BAA4B,CAAC;IACzE,eAAe,EAAE,yBAAyB,CACxC,iBAAiB,EACjB,iDAAiD,CAClD;IACD,UAAU,EAAE,yBAAyB,CACnC,YAAY,EACZ,uCAAuC,CACxC;IACD,WAAW;IACX,SAAS;IACT,aAAa,EAAE,yBAAyB,CAAC,eAAe,EAAE,iBAAiB,CAAC;IAC5E,eAAe,EAAE,yBAAyB,CACxC,eAAe,EACf,mBAAmB,CACpB;IACD,UAAU,EAAE,yBAAyB,CAAC,YAAY,EAAE,YAAY,CAAC;IACjE,KAAK;IACL,SAAS,EAAE,yBAAyB,CAAC,WAAW,EAAE,IAAI,CAAC;IACvD,cAAc,EAAE,yBAAyB,CAAC,gBAAgB,EAAE,IAAI,CAAC;IACjE,QAAQ,EAAE,yBAAyB,CAAC,UAAU,EAAE,IAAI,CAAC;IACrD,MAAM,EAAE,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,CAAC;IACrD,aAAa,EAAE,yBAAyB,CAAC,eAAe,EAAE,GAAG,CAAC;IAC9D,QAAQ;CACT,CAAA;AAED,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AACvC,MAAM,kBAAkB,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;AAEtE,MAAM,CAAC,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAC/C,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,OAAuB,CAC7C,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAA,qBAAqB,kBAAkB;KACtE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC;KACvB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAA;AAEhB,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CACzC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAC9E,CAAA"}

package/lib/tags/model/Flourish.d.ts

@@ -0,0 +1,16 @@
+import type * as hast from 'hast';
+import { QueryContext } from '../../index.js';
+export declare class Flourish {
+    private node;
+    private id;
+    constructor(node: hast.Element, id: string);
+    type(): string;
+    description(): string;
+    fullGrid(): boolean;
+    fallbackImage(context: QueryContext): Promise<{
+        url: string;
+        width: number;
+        height: number;
+    }>;
+    static typedef: string;
+}

package/lib/tags/model/Flourish.js

@@ -0,0 +1,54 @@
+import imageServiceUrl from '../../helpers/imageService.js';
+export class Flourish {
+    constructor(node, id) {
+        this.node = node;
+        this.id = id;
+    }
+    type() {
+        var _a;
+        // Default to visulisation for backwards compatibility
+        return typeof ((_a = this.node.properties) === null || _a === void 0 ? void 0 : _a.dataFlourishType) === 'string'
+            ? this.node.properties.dataFlourishType
+            : 'visulisation';
+    }
+    description() {
+        var _a;
+        return typeof ((_a = this.node.properties) === null || _a === void 0 ? void 0 : _a.description) === 'string'
+            ? this.node.properties.description
+            : '';
+    }
+    fullGrid() {
+        var _a;
+        return ((_a = this.node.properties) === null || _a === void 0 ? void 0 : _a.dataLayoutWidth) === 'full-grid' ? true : false;
+    }
+    async fallbackImage(context) {
+        var _a, _b;
+        // Some magic numbers that exist in the current code base and I don't know why these numbers
+        const DEFAULT_WIDTH = 2626;
+        const DEFAULT_HEIGHT = 1459;
+        const type = this.type();
+        const timestamp = typeof ((_a = this.node.properties) === null || _a === void 0 ? void 0 : _a.dataTimeStamp) === 'string'
+            ? (_b = this.node.properties) === null || _b === void 0 ? void 0 : _b.dataTimeStamp
+            : false;
+        const flourishUrl = `https://public.flourish.studio/${type}/${this.id}/thumbnail${timestamp ? '?cacheBuster=' + timestamp : ''}`;
+        const imageMetadata = await context.dataSources.origami.getImageMetadata(flourishUrl);
+        const imageServiceWrappedUrl = imageServiceUrl({
+            url: flourishUrl,
+            systemCode: context.systemCode,
+            width: (imageMetadata === null || imageMetadata === void 0 ? void 0 : imageMetadata.width) || DEFAULT_WIDTH,
+        });
+        return {
+            url: imageServiceWrappedUrl,
+            width: (imageMetadata === null || imageMetadata === void 0 ? void 0 : imageMetadata.width) ? imageMetadata === null || imageMetadata === void 0 ? void 0 : imageMetadata.width : DEFAULT_WIDTH,
+            height: (imageMetadata === null || imageMetadata === void 0 ? void 0 : imageMetadata.height) ? imageMetadata === null || imageMetadata === void 0 ? void 0 : imageMetadata.height : DEFAULT_HEIGHT,
+        };
+    }
+}
+Flourish.typedef = `
+        type FlourishFallback {
+            url: String
+            width: Int
+            height: Int
+        }
+    `;
+//# sourceMappingURL=Flourish.js.map

package/lib/tags/model/Flourish.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Flourish.js","sourceRoot":"","sources":["../../../src/tags/model/Flourish.ts"],"names":[],"mappings":"AACA,OAAO,eAAe,MAAM,+BAA+B,CAAA;AAG3D,MAAM,OAAO,QAAQ;IACnB,YAAoB,IAAkB,EAAU,EAAU;QAAtC,SAAI,GAAJ,IAAI,CAAc;QAAU,OAAE,GAAF,EAAE,CAAQ;IAAG,CAAC;IAE9D,IAAI;;QACF,sDAAsD;QACtD,OAAO,OAAO,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,UAAU,0CAAE,gBAAgB,CAAA,KAAK,QAAQ;YAC/D,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB;YACvC,CAAC,CAAC,cAAc,CAAA;IACpB,CAAC;IAED,WAAW;;QACT,OAAO,OAAO,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAA,KAAK,QAAQ;YAC1D,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW;YAClC,CAAC,CAAC,EAAE,CAAA;IACR,CAAC;IAED,QAAQ;;QACN,OAAO,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,UAAU,0CAAE,eAAe,MAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;IAC7E,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAqB;;QACvC,4FAA4F;QAC5F,MAAM,aAAa,GAAG,IAAI,CAAA;QAC1B,MAAM,cAAc,GAAG,IAAI,CAAA;QAE3B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;QACxB,MAAM,SAAS,GACb,OAAO,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,UAAU,0CAAE,aAAa,CAAA,KAAK,QAAQ;YACrD,CAAC,CAAC,MAAA,IAAI,CAAC,IAAI,CAAC,UAAU,0CAAE,aAAa;YACrC,CAAC,CAAC,KAAK,CAAA;QAEX,MAAM,WAAW,GAAG,kCAAkC,IAAI,IAAI,IAAI,CAAC,EAAE,aAAa,SAAS,CAAC,CAAC,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAChI,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,gBAAgB,CACtE,WAAW,CACZ,CAAA;QAED,MAAM,sBAAsB,GAAG,eAAe,CAAC;YAC7C,GAAG,EAAE,WAAW;YAChB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK,KAAI,aAAa;SAC7C,CAAC,CAAA;QAEF,OAAO;YACL,GAAG,EAAE,sBAAsB;YAC3B,KAAK,EAAE,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK,EAAC,CAAC,CAAC,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK,CAAC,CAAC,CAAC,aAAa;YAClE,MAAM,EAAE,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,EAAC,CAAC,CAAC,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,CAAC,CAAC,CAAC,cAAc;SACvE,CAAA;IACH,CAAC;;AAEM,gBAAO,GAAG;;;;;;KAMd,CAAA"}

package/lib/tags/model/Flourish.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/tags/model/Flourish.test.js

@@ -0,0 +1,208 @@
+import { h as hastscript } from 'hastscript';
+import { jest } from '@jest/globals';
+import { Flourish as FlourishModel } from './Flourish.js';
+function createNode(tagname, properties) {
+    return hastscript(tagname, properties);
+}
+describe('Flourish Model', () => {
+    const origamiGetImageMetadataMock = jest.fn();
+    const context = {
+        systemCode: 'example-system',
+        dataSources: {
+            origami: {
+                getImageMetadata: origamiGetImageMetadataMock,
+            },
+        },
+    };
+    afterEach(() => {
+        jest.resetAllMocks();
+    });
+    describe('.type()', () => {
+        describe('the flourish type exists', () => {
+            it('returns the type', () => {
+                const node = createNode('ft-content', {
+                    dataAssetType: 'flourish',
+                    id: 'example-id',
+                    dataFlourishType: 'example-type',
+                    dataLayoutWidth: 'full-grid',
+                    dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                    alt: 'Example alt',
+                    description: 'Example description',
+                });
+                const model = new FlourishModel(node, 'example-id');
+                expect(model.type()).toBe('example-type');
+            });
+        });
+        describe('the flourish type is missing', () => {
+            it('returns the backwards compatible fallback', () => {
+                const node = createNode('ft-content', {
+                    dataAssetType: 'flourish',
+                    id: 'example-id',
+                    dataLayoutWidth: 'full-grid',
+                    dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                    alt: 'Example alt',
+                    description: 'Example description',
+                });
+                const model = new FlourishModel(node, 'example-id');
+                expect(model.type()).toBe('visulisation');
+            });
+        });
+    });
+    describe('.fullGrid()', () => {
+        it('returns true when the graphic is full grid', () => {
+            const node = createNode('ft-content', {
+                dataAssetType: 'flourish',
+                id: 'example-id',
+                dataFlourishType: 'example-type',
+                dataLayoutWidth: 'full-grid',
+                dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                alt: 'Example alt',
+                description: 'Example description',
+            });
+            const model = new FlourishModel(node, 'example-id');
+            expect(model.fullGrid()).toBe(true);
+        });
+        it('returns false when the graphic is NOT full grid', () => {
+            const node = createNode('ft-content', {
+                dataAssetType: 'flourish',
+                id: 'example-id',
+                dataFlourishType: 'example-type',
+                dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                alt: 'Example alt',
+                description: 'Example description',
+            });
+            const model = new FlourishModel(node, 'example-id');
+            expect(model.fullGrid()).toBe(false);
+        });
+    });
+    describe('.description()', () => {
+        it('returns the description when one is provided', () => {
+            const node = createNode('ft-content', {
+                dataAssetType: 'flourish',
+                id: 'example-id',
+                dataFlourishType: 'example-type',
+                dataLayoutWidth: 'full-grid',
+                dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                alt: 'Example alt',
+                description: 'Example description',
+            });
+            const model = new FlourishModel(node, 'example-id');
+            expect(model.description()).toBe('Example description');
+        });
+        it('returns empty string when no description is provided', () => {
+            const node = createNode('ft-content', {
+                dataAssetType: 'flourish',
+                id: 'example-id',
+                dataFlourishType: 'example-type',
+                dataLayoutWidth: 'full-grid',
+                dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                alt: 'Example alt',
+            });
+            const model = new FlourishModel(node, 'example-id');
+            expect(model.description()).toBe('');
+        });
+    });
+    describe('.fallbackImage()', () => {
+        describe('url', () => {
+            it('The Flourish base image url is used', async () => {
+                const node = createNode('ft-content', {
+                    dataAssetType: 'flourish',
+                    id: 'example-id',
+                    dataFlourishType: 'example-type',
+                    dataLayoutWidth: 'full-grid',
+                    dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                    alt: 'Example alt',
+                    description: 'Example description',
+                });
+                const model = new FlourishModel(node, 'example-id');
+                const fallbackResponse = await model.fallbackImage(context);
+                // Regex checks for flourish url whilst leaving spaces for arguments
+                // https://public.flourish.studio/{type}/{id}/thumbnail
+                const flourishImageUrlRegex = new RegExp(/https:\/\/public.flourish.studio\/.*\/.*\/thumbnail/);
+                expect(decodeURIComponent(fallbackResponse.url)).toMatch(flourishImageUrlRegex);
+            });
+            it('The Flourish id is included in the flourish image url', async () => {
+                const node = createNode('ft-content', {
+                    dataAssetType: 'flourish',
+                    id: 'example-id',
+                    dataFlourishType: 'example-type',
+                    dataLayoutWidth: 'full-grid',
+                    dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                    alt: 'Example alt',
+                    description: 'Example description',
+                });
+                const model = new FlourishModel(node, 'example-id');
+                const fallbackResponse = await model.fallbackImage(context);
+                const flourishImageUrlRegex = new RegExp(/https:\/\/public.flourish.studio\/.*\/example-id/);
+                expect(decodeURIComponent(fallbackResponse.url)).toMatch(flourishImageUrlRegex);
+            });
+            describe('the flourish type exists', () => {
+                it('The Flourish graphic type is included in the flourish image url', async () => {
+                    const node = createNode('ft-content', {
+                        dataAssetType: 'flourish',
+                        id: 'example-id',
+                        dataFlourishType: 'example-type',
+                        dataLayoutWidth: 'full-grid',
+                        dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                        alt: 'Example alt',
+                        description: 'Example description',
+                    });
+                    const model = new FlourishModel(node, 'example-id');
+                    const fallbackResponse = await model.fallbackImage(context);
+                    const flourishImageUrl = 'https://public.flourish.studio/example-type';
+                    expect(fallbackResponse.url).toContain(encodeURIComponent(flourishImageUrl));
+                });
+            });
+            describe('the flourish type is missing', () => {
+                it('The Flourish graphic type fallback is included in the flourish image url', async () => {
+                    const node = createNode('ft-content', {
+                        dataAssetType: 'flourish',
+                        id: 'example-id',
+                        dataLayoutWidth: 'full-grid',
+                        dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                        alt: 'Example alt',
+                        description: 'Example description',
+                    });
+                    const model = new FlourishModel(node, 'example-id');
+                    const fallbackResponse = await model.fallbackImage(context);
+                    const flourishImageUrl = 'https://public.flourish.studio/visulisation';
+                    expect(fallbackResponse.url).toContain(encodeURIComponent(flourishImageUrl));
+                });
+            });
+            describe('the flourish timestamp exists', () => {
+                it('The Flourish cache buster is appended to the flourish image url', async () => {
+                    const node = createNode('ft-content', {
+                        dataAssetType: 'flourish',
+                        id: 'example-id',
+                        dataFlourishType: 'example-type',
+                        dataLayoutWidth: 'full-grid',
+                        dataTimeStamp: '2022-01-06T14:41:01.102Z',
+                        alt: 'Example alt',
+                        description: 'Example description',
+                    });
+                    const model = new FlourishModel(node, 'example-id');
+                    const fallbackResponse = await model.fallbackImage(context);
+                    const flourishImageCacheBuster = '?cacheBuster=2022-01-06T14:41:01.102Z';
+                    expect(fallbackResponse.url).toContain(encodeURIComponent(flourishImageCacheBuster));
+                });
+            });
+            describe('the flourish timestamp is missing', () => {
+                it('The Flourish cache buster is not appended to the flourish image url', async () => {
+                    const node = createNode('ft-content', {
+                        dataAssetType: 'flourish',
+                        id: 'example-id',
+                        dataFlourishType: 'example-type',
+                        dataLayoutWidth: 'full-grid',
+                        alt: 'Example alt',
+                        description: 'Example description',
+                    });
+                    const model = new FlourishModel(node, 'example-id');
+                    const fallbackResponse = await model.fallbackImage(context);
+                    const flourishImageCacheBuster = '?cacheBuster=';
+                    expect(fallbackResponse.url).not.toContain(encodeURIComponent(flourishImageCacheBuster));
+                });
+            });
+        });
+    });
+});
+//# sourceMappingURL=Flourish.test.js.map

package/lib/tags/model/Flourish.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Flourish.test.js","sourceRoot":"","sources":["../../../src/tags/model/Flourish.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,IAAI,UAAU,EAA+B,MAAM,YAAY,CAAA;AACxE,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AAEpC,OAAO,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,eAAe,CAAA;AAGzD,SAAS,UAAU,CAAC,OAAe,EAAE,UAA2B;IAC/D,OAAO,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;AACvC,CAAC;AAED,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC/B,MAAM,2BAA2B,GAAG,IAAI,CAAC,EAAE,EAAE,CAAA;IAE7C,MAAM,OAAO,GAAG;QACf,UAAU,EAAE,gBAAgB;QAC5B,WAAW,EAAE;YACZ,OAAO,EAAE;gBACR,gBAAgB,EAAE,2BAA2B;aAC7C;SACD;KAC0B,CAAA;IAE5B,SAAS,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAA;IACrB,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACxB,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACzC,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;gBAC3B,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;oBACrC,aAAa,EAAE,UAAU;oBACzB,EAAE,EAAE,YAAY;oBAChB,gBAAgB,EAAE,cAAc;oBAChC,eAAe,EAAE,WAAW;oBAC5B,aAAa,EAAE,0BAA0B;oBACzC,GAAG,EAAE,aAAa;oBAClB,WAAW,EAAE,qBAAqB;iBAClC,CAAC,CAAA;gBAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;gBACnD,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YAC1C,CAAC,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;QACF,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;YAC7C,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;gBACpD,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;oBACrC,aAAa,EAAE,UAAU;oBACzB,EAAE,EAAE,YAAY;oBAChB,eAAe,EAAE,WAAW;oBAC5B,aAAa,EAAE,0BAA0B;oBACzC,GAAG,EAAE,aAAa;oBAClB,WAAW,EAAE,qBAAqB;iBAClC,CAAC,CAAA;gBAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;gBACnD,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YAC1C,CAAC,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;IAGF,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACrD,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;gBACrC,aAAa,EAAE,UAAU;gBACzB,EAAE,EAAE,YAAY;gBAChB,gBAAgB,EAAE,cAAc;gBAChC,eAAe,EAAE,WAAW;gBAC5B,aAAa,EAAE,0BAA0B;gBACzC,GAAG,EAAE,aAAa;gBAClB,WAAW,EAAE,qBAAqB;aAClC,CAAC,CAAA;YAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;YAEnD,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpC,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YAC1D,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;gBACrC,aAAa,EAAE,UAAU;gBACzB,EAAE,EAAE,YAAY;gBAChB,gBAAgB,EAAE,cAAc;gBAChC,aAAa,EAAE,0BAA0B;gBACzC,GAAG,EAAE,aAAa;gBAClB,WAAW,EAAE,qBAAqB;aAClC,CAAC,CAAA;YAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;YAEnD,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACvD,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;gBACrC,aAAa,EAAE,UAAU;gBACzB,EAAE,EAAE,YAAY;gBAChB,gBAAgB,EAAE,cAAc;gBAChC,eAAe,EAAE,WAAW;gBAC5B,aAAa,EAAE,0BAA0B;gBACzC,GAAG,EAAE,aAAa;gBAClB,WAAW,EAAE,qBAAqB;aAClC,CAAC,CAAA;YAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;YACnD,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;QACxD,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC/D,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;gBACrC,aAAa,EAAE,UAAU;gBACzB,EAAE,EAAE,YAAY;gBAChB,gBAAgB,EAAE,cAAc;gBAChC,eAAe,EAAE,WAAW;gBAC5B,aAAa,EAAE,0BAA0B;gBACzC,GAAG,EAAE,aAAa;aAClB,CAAC,CAAA;YAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;YACnD,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QACjC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE;YACpB,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;gBACpD,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;oBACrC,aAAa,EAAE,UAAU;oBACzB,EAAE,EAAE,YAAY;oBAChB,gBAAgB,EAAE,cAAc;oBAChC,eAAe,EAAE,WAAW;oBAC5B,aAAa,EAAE,0BAA0B;oBACzC,GAAG,EAAE,aAAa;oBAClB,WAAW,EAAE,qBAAqB;iBAClC,CAAC,CAAA;gBAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;gBACnD,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;gBAE3D,oEAAoE;gBACpE,uDAAuD;gBACvD,MAAM,qBAAqB,GAAG,IAAI,MAAM,CAAC,qDAAqD,CAAC,CAAA;gBAE/F,MAAM,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;YAEhF,CAAC,CAAC,CAAA;YAEF,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;gBACtE,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;oBACrC,aAAa,EAAE,UAAU;oBACzB,EAAE,EAAE,YAAY;oBAChB,gBAAgB,EAAE,cAAc;oBAChC,eAAe,EAAE,WAAW;oBAC5B,aAAa,EAAE,0BAA0B;oBACzC,GAAG,EAAE,aAAa;oBAClB,WAAW,EAAE,qBAAqB;iBAClC,CAAC,CAAA;gBAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;gBACnD,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;gBAE3D,MAAM,qBAAqB,GAAG,IAAI,MAAM,CAAC,kDAAkD,CAAC,CAAA;gBAE5F,MAAM,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;YAEhF,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;gBACzC,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;oBAChF,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;wBACrC,aAAa,EAAE,UAAU;wBACzB,EAAE,EAAE,YAAY;wBAChB,gBAAgB,EAAE,cAAc;wBAChC,eAAe,EAAE,WAAW;wBAC5B,aAAa,EAAE,0BAA0B;wBACzC,GAAG,EAAE,aAAa;wBAClB,WAAW,EAAE,qBAAqB;qBAClC,CAAC,CAAA;oBAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;oBACnD,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;oBAE3D,MAAM,gBAAgB,GAAG,6CAA6C,CAAA;oBAEtE,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,CAAA;gBAE7E,CAAC,CAAC,CAAA;YACH,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;gBAC7C,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;oBACzF,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;wBACrC,aAAa,EAAE,UAAU;wBACzB,EAAE,EAAE,YAAY;wBAChB,eAAe,EAAE,WAAW;wBAC5B,aAAa,EAAE,0BAA0B;wBACzC,GAAG,EAAE,aAAa;wBAClB,WAAW,EAAE,qBAAqB;qBAClC,CAAC,CAAA;oBAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;oBACnD,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;oBAE3D,MAAM,gBAAgB,GAAG,6CAA6C,CAAA;oBAEtE,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,CAAA;gBAE7E,CAAC,CAAC,CAAA;YACH,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;gBAC9C,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;oBAChF,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;wBACrC,aAAa,EAAE,UAAU;wBACzB,EAAE,EAAE,YAAY;wBAChB,gBAAgB,EAAE,cAAc;wBAChC,eAAe,EAAE,WAAW;wBAC5B,aAAa,EAAE,0BAA0B;wBACzC,GAAG,EAAE,aAAa;wBAClB,WAAW,EAAE,qBAAqB;qBAClC,CAAC,CAAA;oBAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;oBACnD,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;oBAE3D,MAAM,wBAAwB,GAAG,uCAAuC,CAAA;oBAExE,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAA;gBAErF,CAAC,CAAC,CAAA;YACH,CAAC,CAAC,CAAA;YAEF,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;gBAClD,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;oBACpF,MAAM,IAAI,GAAG,UAAU,CAAC,YAAY,EAAE;wBACrC,aAAa,EAAE,UAAU;wBACzB,EAAE,EAAE,YAAY;wBAChB,gBAAgB,EAAE,cAAc;wBAChC,eAAe,EAAE,WAAW;wBAC5B,GAAG,EAAE,aAAa;wBAClB,WAAW,EAAE,qBAAqB;qBAClC,CAAC,CAAA;oBAEF,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;oBACnD,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;oBAE3D,MAAM,wBAAwB,GAAG,eAAe,CAAA;oBAEhD,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAA;gBAEzF,CAAC,CAAC,CAAA;YACH,CAAC,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@financial-times/cp-content-pipeline-schema",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "",
   "main": "lib/index.js",
   "type": "module",

package/src/tags/Flourish.ts

@@ -0,0 +1,51 @@
+import { gql } from 'graphql-tag'
+import type { TagConstructor } from './index.js'
+import type * as hast from 'hast'
+import { QueryContext } from '../index.js'
+import { Flourish as FlourishModel } from './model/Flourish.js'
+
+class Flourish {
+  id: string
+  model: FlourishModel
+
+  static selector = '[data-asset-type="flourish"]'
+
+  constructor(node: hast.Element) {
+    if (typeof node.properties?.id !== 'string') {
+      throw new Error('Flourish is missing a href')
+    }
+
+    this.id = node.properties.id
+
+    // Adding the model to the instance is required until we refactor how the resolve method integrates
+    this.model = new FlourishModel(node, this.id)
+  }
+
+  static resolve = {
+    id: (parent: Flourish) => parent.id,
+    type: (parent: Flourish) => parent.model.type(),
+    description: (parent: Flourish) => parent.model.description(),
+    fullGrid: (parent: Flourish) => parent.model.fullGrid(),
+    fallbackImage: async (
+      parent: Flourish,
+      _args: any,
+      context: QueryContext
+    ) => parent.model.fallbackImage(context),
+  }
+
+  static typeDef = gql`
+    type Flourish {
+      id: String!
+      type: String!
+      fullGrid: Boolean!
+      description: String
+      fallbackImage: FlourishFallback
+    }
+
+    ${FlourishModel.typedef}
+  `
+}
+
+const FlourishClass: TagConstructor<Flourish> = Flourish
+
+export { FlourishClass as Flourish }

package/src/tags/index.ts

@@ -9,6 +9,7 @@ import { ImageSet } from './ImageSet.js'
 import { PullQuote } from './PullQuote.js'
 import { Recommended } from './Recommended.js'
 import { Tweet } from './Tweet.js'
+import { Flourish } from './Flourish.js'
 import { gql } from 'graphql-tag'
 
 export type Tag = object
@@ -69,6 +70,7 @@ export const tags: Record<string, TagConstructor> = {
   Emphasis: createTagWithoutReference('Emphasis', 'em'),
   Strong: createTagWithoutReference('Strong', 'strong'),
   Strikethrough: createTagWithoutReference('Strikethrough', 's'),
+  Flourish,
 }
 
 const tagEntries = Object.entries(tags)