Function parseOpenGraphProperty

packages/utils/src/internals/open_graph_parser.ts:358–388

(property: OpenGraphProperty, $: CheerioAPI)

const makeOpenGraphSelector = (name: string) => `meta[property="${name}"]`;

const parseOpenGraphProperty = (property: OpenGraphProperty, $: CheerioAPI): string | string[] | OpenGraphResult => {
    // Some OpenGraph properties can be added multiple times, such as with video:actor. We must handle this case.
    const values = [...$(makeOpenGraphSelector(property.name))].map((elem) => $(elem).attr('content'));

    // If there is more than 1 item, keep it a an array. Otherwise, return just the first value.
    const content = values.length <= 1 ? (values[0] as string) : (values as string[]);

    // If the property has no children, just return its value immediately.
    if (!property.children.length) return content;

    // Otherwise, return an object with the values for the property, along with the values for its children.
    return {
        // We do this, because for example, there can be a value under og:image which should still be parsed,
        // but there can also be child properties such as og:image:url or og:image:size
        // "Value" is appended to the end of the property name to make it more clear, and to prevent things such
        // as `videoInfo.actor.actor` to grab the actor's name.
        ...optionalSpread(`${property.outputName}Value`, content),
        ...property.children.reduce(
            (acc, curr) => {
                const parsed = parseOpenGraphProperty(curr, $);
                if (parsed === undefined) return acc;

                return {
                    ...acc,
                    ...optionalSpread(curr.outputName, parseOpenGraphProperty(curr, $)),
                };
            },
            {} as Dictionary<string | Dictionary>,
        ),
    };
};

/**
 * Easily parse all OpenGraph properties from a page with just a `CheerioAPI` object.