@guardian/content-api-models 17.6.2 → 17.7.0-beta.0

package/package.json

@@ -1,7 +1,7 @@
 
 {
   "name": "@guardian/content-api-models",
-  "version": "17.6.2",
+  "version": "17.7.0-beta.0",
   "description": "Typescript library built from the content api thrift definitions",
   "repository": {
     "type": "git",

package/v1/assetFields.d.ts

@@ -6,6 +6,7 @@
 import { TProtocol } from 'thrift';
 import Int64 from 'node-int64';
 import { CapiDateTime } from './capiDateTime';
+import { CartoonVariant } from './cartoonVariant';
 export interface AssetFields {
     aspectRatio?: string;
     altText?: string;
@@ -75,6 +76,8 @@ export interface AssetFields {
     start?: CapiDateTime;
     end?: CapiDateTime;
     safeEmbedCode?: boolean;
+    isMandatory?: boolean;
+    cartoonVariants?: CartoonVariant[];
 }
 export declare class AssetFieldsSerde {
     static read(protocol: TProtocol): AssetFields;

package/v1/assetFields.js

@@ -8,10 +8,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetFieldsSerde = void 0;
 var thrift_1 = require("thrift");
 var capiDateTime_1 = require("./capiDateTime");
+var cartoonVariant_1 = require("./cartoonVariant");
 var AssetFieldsSerde = /** @class */ (function () {
     function AssetFieldsSerde() {
     }
     AssetFieldsSerde.read = function (protocol) {
+        var _a;
         protocol.readStructBegin();
         var result = {};
         while (true) {
@@ -634,6 +636,33 @@ var AssetFieldsSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
+                case 69:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.isMandatory = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 70:
+                    if (ftype === thrift_1.Thrift.Type.LIST) {
+                        var listInfo1 = protocol.readListBegin();
+                        var listSize1 = (_a = listInfo1.size) !== null && _a !== void 0 ? _a : 0;
+                        var value1 = [];
+                        if (listInfo1.etype === thrift_1.Thrift.Type.STRUCT) {
+                            for (var i = 0; i < listSize1; i++) {
+                                var value2 = cartoonVariant_1.CartoonVariantSerde.read(protocol);
+                                value1.push(value2);
+                            }
+                        }
+                        protocol.readListEnd();
+                        result.cartoonVariants = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -1053,6 +1082,22 @@ var AssetFieldsSerde = /** @class */ (function () {
             protocol.writeBool(value1);
             protocol.writeFieldEnd();
         }
+        if (value0.isMandatory !== null && value0.isMandatory !== undefined) {
+            var value1 = value0.isMandatory;
+            protocol.writeFieldBegin('isMandatory', thrift_1.Thrift.Type.BOOL, 69);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.cartoonVariants !== null && value0.cartoonVariants !== undefined) {
+            var value1 = value0.cartoonVariants;
+            protocol.writeFieldBegin('cartoonVariants', thrift_1.Thrift.Type.LIST, 70);
+            protocol.writeListBegin(thrift_1.Thrift.Type.STRUCT, value1.length);
+            value1.forEach(function (value2) {
+                cartoonVariant_1.CartoonVariantSerde.write(protocol, value2);
+            });
+            protocol.writeListEnd();
+            protocol.writeFieldEnd();
+        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/assetType.d.ts

@@ -8,5 +8,6 @@ export declare enum AssetType {
     VIDEO = 1,
     AUDIO = 2,
     EMBED = 3,
-    TWEET = 4
+    TWEET = 4,
+    CARTOON = 5
 }

package/v1/assetType.js

@@ -13,4 +13,5 @@ var AssetType;
     AssetType[AssetType["AUDIO"] = 2] = "AUDIO";
     AssetType[AssetType["EMBED"] = 3] = "EMBED";
     AssetType[AssetType["TWEET"] = 4] = "TWEET";
+    AssetType[AssetType["CARTOON"] = 5] = "CARTOON";
 })(AssetType = exports.AssetType || (exports.AssetType = {}));

package/v1/blockElement.d.ts

@@ -7,6 +7,7 @@ import { TProtocol } from 'thrift';
 import { Asset } from './asset';
 import { AudioElementFields } from './audioElementFields';
 import { CalloutElementFields } from './calloutElementFields';
+import { CartoonElementFields } from './cartoonElementFields';
 import { CodeElementFields } from './codeElementFields';
 import { CommentElementFields } from './commentElementFields';
 import { ContentAtomElementFields } from './contentAtomElementFields';
@@ -49,6 +50,7 @@ export interface BlockElement {
     tracking?: EmbedTracking;
     codeTypeData?: CodeElementFields;
     calloutTypeData?: CalloutElementFields;
+    cartoonTypeData?: CartoonElementFields;
 }
 export declare class BlockElementSerde {
     static read(protocol: TProtocol): BlockElement;

package/v1/blockElement.js

@@ -10,6 +10,7 @@ var thrift_1 = require("thrift");
 var asset_1 = require("./asset");
 var audioElementFields_1 = require("./audioElementFields");
 var calloutElementFields_1 = require("./calloutElementFields");
+var cartoonElementFields_1 = require("./cartoonElementFields");
 var codeElementFields_1 = require("./codeElementFields");
 var commentElementFields_1 = require("./commentElementFields");
 var contentAtomElementFields_1 = require("./contentAtomElementFields");
@@ -258,6 +259,15 @@ var BlockElementSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
+                case 24:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = cartoonElementFields_1.CartoonElementFieldsSerde.read(protocol);
+                        result.cartoonTypeData = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -411,6 +421,12 @@ var BlockElementSerde = /** @class */ (function () {
             calloutElementFields_1.CalloutElementFieldsSerde.write(protocol, value1);
             protocol.writeFieldEnd();
         }
+        if (value0.cartoonTypeData !== null && value0.cartoonTypeData !== undefined) {
+            var value1 = value0.cartoonTypeData;
+            protocol.writeFieldBegin('cartoonTypeData', thrift_1.Thrift.Type.STRUCT, 24);
+            cartoonElementFields_1.CartoonElementFieldsSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/cartoonElementFields.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+import { TProtocol } from 'thrift';
+import { CartoonVariant } from './cartoonVariant';
+export interface CartoonElementFields {
+    variants?: CartoonVariant[];
+    role?: string;
+    credit?: string;
+    caption?: string;
+    alt?: string;
+    source?: string;
+    displayCredit?: boolean;
+}
+export declare class CartoonElementFieldsSerde {
+    static read(protocol: TProtocol): CartoonElementFields;
+    static write(protocol: TProtocol, value0: CartoonElementFields): void;
+}

package/v1/cartoonElementFields.js

@@ -0,0 +1,160 @@
+"use strict";
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CartoonElementFieldsSerde = void 0;
+var thrift_1 = require("thrift");
+var cartoonVariant_1 = require("./cartoonVariant");
+var CartoonElementFieldsSerde = /** @class */ (function () {
+    function CartoonElementFieldsSerde() {
+    }
+    CartoonElementFieldsSerde.read = function (protocol) {
+        var _a;
+        protocol.readStructBegin();
+        var result = {};
+        while (true) {
+            var ret = protocol.readFieldBegin();
+            var ftype = ret.ftype;
+            var fid = ret.fid;
+            if (ftype === thrift_1.Thrift.Type.STOP) {
+                break;
+            }
+            switch (fid) {
+                case 1:
+                    if (ftype === thrift_1.Thrift.Type.LIST) {
+                        var listInfo1 = protocol.readListBegin();
+                        var listSize1 = (_a = listInfo1.size) !== null && _a !== void 0 ? _a : 0;
+                        var value1 = [];
+                        if (listInfo1.etype === thrift_1.Thrift.Type.STRUCT) {
+                            for (var i = 0; i < listSize1; i++) {
+                                var value2 = cartoonVariant_1.CartoonVariantSerde.read(protocol);
+                                value1.push(value2);
+                            }
+                        }
+                        protocol.readListEnd();
+                        result.variants = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 2:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.role = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 3:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.credit = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 4:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.caption = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 5:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.alt = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 6:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.source = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 7:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.displayCredit = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                default:
+                    protocol.skip(ftype);
+            }
+            protocol.readFieldEnd();
+        }
+        protocol.readStructEnd();
+        // @ts-ignore
+        return result;
+    };
+    CartoonElementFieldsSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('CartoonElementFields');
+        if (value0.variants !== null && value0.variants !== undefined) {
+            var value1 = value0.variants;
+            protocol.writeFieldBegin('variants', thrift_1.Thrift.Type.LIST, 1);
+            protocol.writeListBegin(thrift_1.Thrift.Type.STRUCT, value1.length);
+            value1.forEach(function (value2) {
+                cartoonVariant_1.CartoonVariantSerde.write(protocol, value2);
+            });
+            protocol.writeListEnd();
+            protocol.writeFieldEnd();
+        }
+        if (value0.role !== null && value0.role !== undefined) {
+            var value1 = value0.role;
+            protocol.writeFieldBegin('role', thrift_1.Thrift.Type.STRING, 2);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.credit !== null && value0.credit !== undefined) {
+            var value1 = value0.credit;
+            protocol.writeFieldBegin('credit', thrift_1.Thrift.Type.STRING, 3);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.caption !== null && value0.caption !== undefined) {
+            var value1 = value0.caption;
+            protocol.writeFieldBegin('caption', thrift_1.Thrift.Type.STRING, 4);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.alt !== null && value0.alt !== undefined) {
+            var value1 = value0.alt;
+            protocol.writeFieldBegin('alt', thrift_1.Thrift.Type.STRING, 5);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.source !== null && value0.source !== undefined) {
+            var value1 = value0.source;
+            protocol.writeFieldBegin('source', thrift_1.Thrift.Type.STRING, 6);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.displayCredit !== null && value0.displayCredit !== undefined) {
+            var value1 = value0.displayCredit;
+            protocol.writeFieldBegin('displayCredit', thrift_1.Thrift.Type.BOOL, 7);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
+        protocol.writeFieldStop();
+        protocol.writeStructEnd();
+    };
+    return CartoonElementFieldsSerde;
+}());
+exports.CartoonElementFieldsSerde = CartoonElementFieldsSerde;

package/v1/cartoonImage.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+import { TProtocol } from 'thrift';
+export interface CartoonImage {
+    mimeType: string;
+    file: string;
+    width?: number;
+    height?: number;
+    mediaId?: string;
+}
+export declare class CartoonImageSerde {
+    static read(protocol: TProtocol): CartoonImage;
+    static write(protocol: TProtocol, value0: CartoonImage): void;
+}

package/v1/cartoonImage.js

@@ -0,0 +1,115 @@
+"use strict";
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CartoonImageSerde = void 0;
+var thrift_1 = require("thrift");
+var CartoonImageSerde = /** @class */ (function () {
+    function CartoonImageSerde() {
+    }
+    CartoonImageSerde.read = function (protocol) {
+        protocol.readStructBegin();
+        var result = {};
+        while (true) {
+            var ret = protocol.readFieldBegin();
+            var ftype = ret.ftype;
+            var fid = ret.fid;
+            if (ftype === thrift_1.Thrift.Type.STOP) {
+                break;
+            }
+            switch (fid) {
+                case 1:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.mimeType = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 2:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.file = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 3:
+                    if (ftype === thrift_1.Thrift.Type.I32) {
+                        var value1 = protocol.readI32();
+                        result.width = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 4:
+                    if (ftype === thrift_1.Thrift.Type.I32) {
+                        var value1 = protocol.readI32();
+                        result.height = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 5:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.mediaId = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                default:
+                    protocol.skip(ftype);
+            }
+            protocol.readFieldEnd();
+        }
+        protocol.readStructEnd();
+        // @ts-ignore
+        return result;
+    };
+    CartoonImageSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('CartoonImage');
+        if (value0.mimeType !== null && value0.mimeType !== undefined) {
+            var value1 = value0.mimeType;
+            protocol.writeFieldBegin('mimeType', thrift_1.Thrift.Type.STRING, 1);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.file !== null && value0.file !== undefined) {
+            var value1 = value0.file;
+            protocol.writeFieldBegin('file', thrift_1.Thrift.Type.STRING, 2);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.width !== null && value0.width !== undefined) {
+            var value1 = value0.width;
+            protocol.writeFieldBegin('width', thrift_1.Thrift.Type.I32, 3);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.height !== null && value0.height !== undefined) {
+            var value1 = value0.height;
+            protocol.writeFieldBegin('height', thrift_1.Thrift.Type.I32, 4);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.mediaId !== null && value0.mediaId !== undefined) {
+            var value1 = value0.mediaId;
+            protocol.writeFieldBegin('mediaId', thrift_1.Thrift.Type.STRING, 5);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        protocol.writeFieldStop();
+        protocol.writeStructEnd();
+    };
+    return CartoonImageSerde;
+}());
+exports.CartoonImageSerde = CartoonImageSerde;

package/v1/cartoonVariant.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+import { TProtocol } from 'thrift';
+import { CartoonImage } from './cartoonImage';
+export interface CartoonVariant {
+    viewportSize: string;
+    images: CartoonImage[];
+}
+export declare class CartoonVariantSerde {
+    static read(protocol: TProtocol): CartoonVariant;
+    static write(protocol: TProtocol, value0: CartoonVariant): void;
+}

package/v1/cartoonVariant.js

@@ -0,0 +1,85 @@
+"use strict";
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CartoonVariantSerde = void 0;
+var thrift_1 = require("thrift");
+var cartoonImage_1 = require("./cartoonImage");
+var CartoonVariantSerde = /** @class */ (function () {
+    function CartoonVariantSerde() {
+    }
+    CartoonVariantSerde.read = function (protocol) {
+        var _a;
+        protocol.readStructBegin();
+        var result = {};
+        while (true) {
+            var ret = protocol.readFieldBegin();
+            var ftype = ret.ftype;
+            var fid = ret.fid;
+            if (ftype === thrift_1.Thrift.Type.STOP) {
+                break;
+            }
+            switch (fid) {
+                case 1:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.viewportSize = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 2:
+                    if (ftype === thrift_1.Thrift.Type.LIST) {
+                        var listInfo1 = protocol.readListBegin();
+                        var listSize1 = (_a = listInfo1.size) !== null && _a !== void 0 ? _a : 0;
+                        var value1 = [];
+                        if (listInfo1.etype === thrift_1.Thrift.Type.STRUCT) {
+                            for (var i = 0; i < listSize1; i++) {
+                                var value2 = cartoonImage_1.CartoonImageSerde.read(protocol);
+                                value1.push(value2);
+                            }
+                        }
+                        protocol.readListEnd();
+                        result.images = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                default:
+                    protocol.skip(ftype);
+            }
+            protocol.readFieldEnd();
+        }
+        protocol.readStructEnd();
+        // @ts-ignore
+        return result;
+    };
+    CartoonVariantSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('CartoonVariant');
+        if (value0.viewportSize !== null && value0.viewportSize !== undefined) {
+            var value1 = value0.viewportSize;
+            protocol.writeFieldBegin('viewportSize', thrift_1.Thrift.Type.STRING, 1);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.images !== null && value0.images !== undefined) {
+            var value1 = value0.images;
+            protocol.writeFieldBegin('images', thrift_1.Thrift.Type.LIST, 2);
+            protocol.writeListBegin(thrift_1.Thrift.Type.STRUCT, value1.length);
+            value1.forEach(function (value2) {
+                cartoonImage_1.CartoonImageSerde.write(protocol, value2);
+            });
+            protocol.writeListEnd();
+            protocol.writeFieldEnd();
+        }
+        protocol.writeFieldStop();
+        protocol.writeStructEnd();
+    };
+    return CartoonVariantSerde;
+}());
+exports.CartoonVariantSerde = CartoonVariantSerde;

package/v1/elementType.d.ts

@@ -24,5 +24,6 @@ export declare enum ElementType {
     INSTAGRAM = 17,
     CONTENTATOM = 18,
     VINE = 19,
-    CALLOUT = 20
+    CALLOUT = 20,
+    CARTOON = 21
 }

package/v1/elementType.js

@@ -29,4 +29,5 @@ var ElementType;
     ElementType[ElementType["CONTENTATOM"] = 18] = "CONTENTATOM";
     ElementType[ElementType["VINE"] = 19] = "VINE";
     ElementType[ElementType["CALLOUT"] = 20] = "CALLOUT";
+    ElementType[ElementType["CARTOON"] = 21] = "CARTOON";
 })(ElementType = exports.ElementType || (exports.ElementType = {}));