@guardian/content-api-models 4.0.0

package/crier/event/v1/retrievableContent.js

@@ -0,0 +1,145 @@
+"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.RetrievableContentSerde = void 0;
+var thrift_1 = require("thrift");
+var aliasPath_1 = require("../../../v1/aliasPath");
+var RetrievableContentSerde = /** @class */ (function () {
+    function RetrievableContentSerde() {
+    }
+    RetrievableContentSerde.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.id = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 2:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.capiUrl = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 3:
+                    if (ftype === thrift_1.Thrift.Type.I64) {
+                        var value1 = protocol.readI64();
+                        result.lastModifiedDate = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 4:
+                    if (ftype === thrift_1.Thrift.Type.I32) {
+                        var value1 = protocol.readI32();
+                        result.internalRevision = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 5:
+                    if (ftype === thrift_1.Thrift.Type.I32) {
+                        var value1 = protocol.readI32();
+                        result.contentType = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 7:
+                    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 = aliasPath_1.AliasPathSerde.read(protocol);
+                                value1.push(value2);
+                            }
+                        }
+                        protocol.readListEnd();
+                        result.aliasPaths = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                default:
+                    protocol.skip(ftype);
+            }
+            protocol.readFieldEnd();
+        }
+        protocol.readStructEnd();
+        // @ts-ignore
+        return result;
+    };
+    RetrievableContentSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('RetrievableContent');
+        if (value0.id !== null && value0.id !== undefined) {
+            var value1 = value0.id;
+            protocol.writeFieldBegin('id', thrift_1.Thrift.Type.STRING, 1);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.capiUrl !== null && value0.capiUrl !== undefined) {
+            var value1 = value0.capiUrl;
+            protocol.writeFieldBegin('capiUrl', thrift_1.Thrift.Type.STRING, 2);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.lastModifiedDate !== null && value0.lastModifiedDate !== undefined) {
+            var value1 = value0.lastModifiedDate;
+            protocol.writeFieldBegin('lastModifiedDate', thrift_1.Thrift.Type.I64, 3);
+            protocol.writeI64(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.internalRevision !== null && value0.internalRevision !== undefined) {
+            var value1 = value0.internalRevision;
+            protocol.writeFieldBegin('internalRevision', thrift_1.Thrift.Type.I32, 4);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.contentType !== null && value0.contentType !== undefined) {
+            var value1 = value0.contentType;
+            protocol.writeFieldBegin('contentType', thrift_1.Thrift.Type.I32, 5);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.aliasPaths !== null && value0.aliasPaths !== undefined) {
+            var value1 = value0.aliasPaths;
+            protocol.writeFieldBegin('aliasPaths', thrift_1.Thrift.Type.LIST, 7);
+            protocol.writeListBegin(thrift_1.Thrift.Type.STRUCT, value1.length);
+            value1.forEach(function (value2) {
+                aliasPath_1.AliasPathSerde.write(protocol, value2);
+            });
+            protocol.writeListEnd();
+            protocol.writeFieldEnd();
+        }
+        protocol.writeFieldStop();
+        protocol.writeStructEnd();
+    };
+    return RetrievableContentSerde;
+}());
+exports.RetrievableContentSerde = RetrievableContentSerde;

package/fastly/event/v1/contentDecachedEvent.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+import { TProtocol } from 'thrift';
+import Int64 from 'node-int64';
+import { ContentType } from '../../../v1/contentType';
+import { EventType } from './eventType';
+export interface ContentDecachedEvent {
+    contentPath: string;
+    eventType: EventType;
+    contentType?: ContentType;
+    eventPublished?: Int64;
+}
+export declare class ContentDecachedEventSerde {
+    static read(protocol: TProtocol): ContentDecachedEvent;
+    static write(protocol: TProtocol, value0: ContentDecachedEvent): void;
+}

package/fastly/event/v1/contentDecachedEvent.js

@@ -0,0 +1,100 @@
+"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.ContentDecachedEventSerde = void 0;
+var thrift_1 = require("thrift");
+var ContentDecachedEventSerde = /** @class */ (function () {
+    function ContentDecachedEventSerde() {
+    }
+    ContentDecachedEventSerde.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.contentPath = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 2:
+                    if (ftype === thrift_1.Thrift.Type.I32) {
+                        var value1 = protocol.readI32();
+                        result.eventType = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 3:
+                    if (ftype === thrift_1.Thrift.Type.I32) {
+                        var value1 = protocol.readI32();
+                        result.contentType = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 5:
+                    if (ftype === thrift_1.Thrift.Type.I64) {
+                        var value1 = protocol.readI64();
+                        result.eventPublished = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                default:
+                    protocol.skip(ftype);
+            }
+            protocol.readFieldEnd();
+        }
+        protocol.readStructEnd();
+        // @ts-ignore
+        return result;
+    };
+    ContentDecachedEventSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('ContentDecachedEvent');
+        if (value0.contentPath !== null && value0.contentPath !== undefined) {
+            var value1 = value0.contentPath;
+            protocol.writeFieldBegin('contentPath', thrift_1.Thrift.Type.STRING, 1);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.eventType !== null && value0.eventType !== undefined) {
+            var value1 = value0.eventType;
+            protocol.writeFieldBegin('eventType', thrift_1.Thrift.Type.I32, 2);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.contentType !== null && value0.contentType !== undefined) {
+            var value1 = value0.contentType;
+            protocol.writeFieldBegin('contentType', thrift_1.Thrift.Type.I32, 3);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.eventPublished !== null && value0.eventPublished !== undefined) {
+            var value1 = value0.eventPublished;
+            protocol.writeFieldBegin('eventPublished', thrift_1.Thrift.Type.I64, 5);
+            protocol.writeI64(value1);
+            protocol.writeFieldEnd();
+        }
+        protocol.writeFieldStop();
+        protocol.writeStructEnd();
+    };
+    return ContentDecachedEventSerde;
+}());
+exports.ContentDecachedEventSerde = ContentDecachedEventSerde;

package/fastly/event/v1/eventType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+export declare enum EventType {
+    UPDATE = 1,
+    DELETE = 2
+}

package/fastly/event/v1/eventType.js

@@ -0,0 +1,13 @@
+"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.EventType = void 0;
+var EventType;
+(function (EventType) {
+    EventType[EventType["UPDATE"] = 1] = "UPDATE";
+    EventType[EventType["DELETE"] = 2] = "DELETE";
+})(EventType || (exports.EventType = EventType = {}));

package/package.json

@@ -0,0 +1,24 @@
+
+{
+  "name": "@guardian/content-api-models",
+  "version": "4.0.0",
+  "description": "Typescript library built from the content api thrift definitions",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "devDependencies": {
+"typescript": "^5.2.2"
+},
+  "dependencies": {
+"@guardian/story-packages-model": "^2.2.0",
+"@guardian/content-entity-model": "^2.2.1",
+"@types/thrift": "^0.10.11",
+"thrift": "^0.15.0",
+"@guardian/content-atom-model": "^4.0.0",
+"@types/node-int64": "^0.4.29",
+"node-int64": "^0.4.0"
+}
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    // this is to disable searching in ../node_modules as it can trigger compilation errors unrelated to this
+    // self contained project
+    "typeRoots": ["./node_modules/@types"],
+  }
+}

package/v1/aliasPath.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 { CapiDateTime } from './capiDateTime';
+export interface AliasPath {
+    path: string;
+    ceasedToBeCanonicalAt: CapiDateTime;
+}
+export declare class AliasPathSerde {
+    static read(protocol: TProtocol): AliasPath;
+    static write(protocol: TProtocol, value0: AliasPath): void;
+}

package/v1/aliasPath.js

@@ -0,0 +1,71 @@
+"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.AliasPathSerde = void 0;
+var thrift_1 = require("thrift");
+var capiDateTime_1 = require("./capiDateTime");
+var AliasPathSerde = /** @class */ (function () {
+    function AliasPathSerde() {
+    }
+    AliasPathSerde.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.path = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 2:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = capiDateTime_1.CapiDateTimeSerde.read(protocol);
+                        result.ceasedToBeCanonicalAt = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                default:
+                    protocol.skip(ftype);
+            }
+            protocol.readFieldEnd();
+        }
+        protocol.readStructEnd();
+        // @ts-ignore
+        return result;
+    };
+    AliasPathSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('AliasPath');
+        if (value0.path !== null && value0.path !== undefined) {
+            var value1 = value0.path;
+            protocol.writeFieldBegin('path', thrift_1.Thrift.Type.STRING, 1);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.ceasedToBeCanonicalAt !== null && value0.ceasedToBeCanonicalAt !== undefined) {
+            var value1 = value0.ceasedToBeCanonicalAt;
+            protocol.writeFieldBegin('ceasedToBeCanonicalAt', thrift_1.Thrift.Type.STRUCT, 2);
+            capiDateTime_1.CapiDateTimeSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
+        protocol.writeFieldStop();
+        protocol.writeStructEnd();
+    };
+    return AliasPathSerde;
+}());
+exports.AliasPathSerde = AliasPathSerde;

package/v1/asset.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+import { TProtocol } from 'thrift';
+import { AssetFields } from './assetFields';
+import { AssetType } from './assetType';
+export interface Asset {
+    type: AssetType;
+    mimeType?: string;
+    file?: string;
+    typeData?: AssetFields;
+}
+export declare class AssetSerde {
+    static read(protocol: TProtocol): Asset;
+    static write(protocol: TProtocol, value0: Asset): void;
+}

package/v1/asset.js

@@ -0,0 +1,101 @@
+"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.AssetSerde = void 0;
+var thrift_1 = require("thrift");
+var assetFields_1 = require("./assetFields");
+var AssetSerde = /** @class */ (function () {
+    function AssetSerde() {
+    }
+    AssetSerde.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.I32) {
+                        var value1 = protocol.readI32();
+                        result.type = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 2:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.mimeType = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 3:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.file = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 4:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = assetFields_1.AssetFieldsSerde.read(protocol);
+                        result.typeData = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                default:
+                    protocol.skip(ftype);
+            }
+            protocol.readFieldEnd();
+        }
+        protocol.readStructEnd();
+        // @ts-ignore
+        return result;
+    };
+    AssetSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('Asset');
+        if (value0.type !== null && value0.type !== undefined) {
+            var value1 = value0.type;
+            protocol.writeFieldBegin('type', thrift_1.Thrift.Type.I32, 1);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.mimeType !== null && value0.mimeType !== undefined) {
+            var value1 = value0.mimeType;
+            protocol.writeFieldBegin('mimeType', thrift_1.Thrift.Type.STRING, 2);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.file !== null && value0.file !== undefined) {
+            var value1 = value0.file;
+            protocol.writeFieldBegin('file', thrift_1.Thrift.Type.STRING, 3);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.typeData !== null && value0.typeData !== undefined) {
+            var value1 = value0.typeData;
+            protocol.writeFieldBegin('typeData', thrift_1.Thrift.Type.STRUCT, 4);
+            assetFields_1.AssetFieldsSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
+        protocol.writeFieldStop();
+        protocol.writeStructEnd();
+    };
+    return AssetSerde;
+}());
+exports.AssetSerde = AssetSerde;

package/v1/assetFields.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+import { TProtocol } from 'thrift';
+import Int64 from 'node-int64';
+import { CapiDateTime } from './capiDateTime';
+import { CartoonVariant } from './cartoonVariant';
+export interface AssetFields {
+    aspectRatio?: string;
+    altText?: string;
+    isInappropriateForAdverts?: boolean;
+    caption?: string;
+    credit?: string;
+    embeddable?: boolean;
+    photographer?: string;
+    source?: string;
+    stillImageUrl?: string;
+    width?: number;
+    height?: number;
+    name?: string;
+    secureFile?: string;
+    isMaster?: boolean;
+    sizeInBytes?: Int64;
+    durationMinutes?: number;
+    durationSeconds?: number;
+    displayCredit?: boolean;
+    thumbnailUrl?: string;
+    role?: string;
+    mediaId?: string;
+    iframeUrl?: string;
+    scriptName?: string;
+    scriptUrl?: string;
+    blockAds?: boolean;
+    html?: string;
+    embedType?: string;
+    explicit?: boolean;
+    clean?: boolean;
+    thumbnailImageUrl?: string;
+    linkText?: string;
+    linkPrefix?: string;
+    shortUrl?: string;
+    imageType?: string;
+    suppliersReference?: string;
+    mediaApiUri?: string;
+    copyright?: string;
+    mimeType?: string;
+    url?: string;
+    originalUrl?: string;
+    id?: string;
+    attribution?: string;
+    description?: string;
+    title?: string;
+    contentAuthSystem?: string;
+    alt?: string;
+    picdarUrn?: string;
+    comment?: string;
+    witnessEmbedType?: string;
+    authorName?: string;
+    authorUsername?: string;
+    authorWitnessProfileUrl?: string;
+    authorGuardianProfileUrl?: string;
+    apiUrl?: string;
+    dateCreated?: CapiDateTime;
+    youtubeUrl?: string;
+    youtubeSource?: string;
+    youtubeTitle?: string;
+    youtubeDescription?: string;
+    youtubeAuthorName?: string;
+    youtubeHtml?: string;
+    venue?: string;
+    location?: string;
+    identifier?: string;
+    price?: string;
+    start?: CapiDateTime;
+    end?: CapiDateTime;
+    safeEmbedCode?: boolean;
+    isMandatory?: boolean;
+    cartoonVariants?: CartoonVariant[];
+}
+export declare class AssetFieldsSerde {
+    static read(protocol: TProtocol): AssetFields;
+    static write(protocol: TProtocol, value0: AssetFields): void;
+}