@xylabs/sdk-meta 5.0.80 → 5.0.81

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from './html/index.ts'
-export * from './lib/index.ts'
-export * from './meta/index.ts'
-export * from './models/index.ts'

package/src/lib/getMetaAsDict.ts

@@ -1,22 +0,0 @@
-import { isString } from '@xylabs/typeof'
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type StringIndexable = { [key: string]: any }
-
-const propertyDelimiter = ':'
-
-export const getMetaAsDict = (obj: StringIndexable, parentKey?: string): Record<string, string> => {
-  let flatRecord: StringIndexable = {}
-  for (const key in obj) {
-    if (typeof obj[key] === 'object' && obj[key] !== null) {
-      // If the value is another object, we want to iterate through its keys as well.
-      const childRecord = getMetaAsDict(obj[key] as StringIndexable, `${isString(parentKey) ? parentKey : ''}${key}${propertyDelimiter}`)
-      flatRecord = { ...flatRecord, ...childRecord }
-    } else {
-      // Concatenate the key with its parent key.
-      const newKey = isString(parentKey) ? `${parentKey}${key}` : key
-      const trimmed = newKey.endsWith(propertyDelimiter) ? newKey.slice(0, -1) : newKey
-      flatRecord[trimmed] = `${obj[key]}`
-    }
-  }
-  return flatRecord
-}

package/src/lib/index.ts

@@ -1 +0,0 @@
-export * from './getMetaAsDict.ts'

package/src/meta/builder.ts

@@ -1,53 +0,0 @@
-import { isString } from '@xylabs/typeof'
-import type { CheerioAPI } from 'cheerio'
-import { load } from 'cheerio'
-
-import { getMetaAsDict } from '../lib/index.ts'
-import type { Meta } from '../models/index.ts'
-
-/* test change */
-
-const addMetaToHead = ($: CheerioAPI, name: string, value: string | object) => {
-  if (typeof value === 'string') {
-    const newMeta = `<meta property="${name}" content="${value}" />`
-    const existingMeta = $(`head meta[property="${name}"]`)
-    if ((existingMeta?.length ?? 0) > 0) {
-      existingMeta.replaceWith(newMeta)
-    } else {
-      $('head').append(newMeta)
-    }
-  } else if (Array.isArray(value)) {
-    for (const item of value) addMetaToHead($, `${name}`, item)
-  } else if (typeof value === 'object') {
-    for (let [key, v] of Object.entries(value)) {
-      if (key === 'url') {
-        addMetaToHead($, name, v)
-      } else {
-        addMetaToHead($, `${name}:${key}`, v)
-      }
-    }
-  } else {
-    throw new TypeError(`Invalid item type [${name}, ${typeof value}]`)
-  }
-}
-
-export const metaBuilder = (html: string, meta: Meta, handler?: string) => {
-  const $ = load(html)
-  // NOTE: This assumes unique meta properties (no duplicates)
-  // which is generally the case, but not always (you can have
-  // multiple og:video:tag tags, for example)
-  const metaProperties = getMetaAsDict(meta)
-  for (const [key, value] of Object.entries(metaProperties)) {
-    addMetaToHead($, key, value)
-  }
-  if (isString(meta.description)) {
-    addMetaToHead($, 'description', meta.description)
-  }
-  if (isString(meta.title)) {
-    $('title').text(meta.title)
-  }
-  if (isString(handler)) {
-    addMetaToHead($, 'meta-handler', handler)
-  }
-  return $.html()
-}

package/src/meta/index.ts

@@ -1 +0,0 @@
-export * from './builder.ts'

package/src/models/Meta.ts

@@ -1,9 +0,0 @@
-import type { OpenGraphMeta } from './OpenGraph/index.ts'
-import type { TwitterMeta } from './Twitter/index.ts'
-
-export interface Meta {
-  description?: string
-  og?: OpenGraphMeta
-  title?: string
-  twitter?: TwitterMeta
-}

package/src/models/OpenGraph/OpenGraphMeta.ts

@@ -1,17 +0,0 @@
-import type { OpenGraphStructuredProperty } from './OpenGraphStructuredProperty.ts'
-
-// TODO: There is slightly different fields for video/image/audio and we should create
-// separate interfaces for each
-
-export interface OpenGraphMeta {
-  audio?: OpenGraphStructuredProperty
-  description?: string
-  determiner?: string
-  image?: OpenGraphStructuredProperty
-  locale?: string | string[]
-  site_name?: string
-  title?: string
-  type?: string
-  url?: string
-  video?: OpenGraphStructuredProperty
-}

package/src/models/OpenGraph/OpenGraphStructured.ts

@@ -1,9 +0,0 @@
-export interface OpenGraphStructured {
-  ''?: string
-  'alt'?: string
-  'height'?: number
-  'secure_url'?: string
-  'type'?: string
-  'url'?: string
-  'width'?: number
-}

package/src/models/OpenGraph/OpenGraphStructuredProperty.ts

@@ -1,3 +0,0 @@
-import type { OpenGraphStructured } from './OpenGraphStructured.ts'
-
-export type OpenGraphStructuredProperty = string | OpenGraphStructured | (string | OpenGraphStructured)[]

package/src/models/OpenGraph/index.ts

@@ -1,3 +0,0 @@
-export * from './OpenGraphMeta.ts'
-export * from './OpenGraphStructured.ts'
-export * from './OpenGraphStructuredProperty.ts'

package/src/models/Twitter/Twitter.ts

@@ -1,67 +0,0 @@
-import type { TwitterApp } from './TwitterApp.ts'
-import type { TwitterPlayer } from './TwitterPlayer.ts'
-
-/**
- * https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/markup
- */
-export interface TwitterMeta {
-  app?: TwitterApp
-  /**
-   * The card type. Used with all cards. Fallback: og:type.
-   * If an og:type, og:title and og:description exist in the markup but
-   * twitter:card is absent, then a summary card may be rendered.
-   */
-  card?: 'summary' | 'summary_large_image' | 'app' | 'player'
-
-  creator?: {
-    /**
-     * The @username of content creator. Used with summary_large_image cards
-     */
-    ''?: string
-    /**
-     * Twitter user ID of content creator. Used with summary,
-     * summary_large_image cards
-     */
-    'id'?: string
-  }
-  /**
-   * Description of content (maximum 200 characters). Used with summary,
-   * summary_large_image, player cards. Fallback: og:description.
-   */
-  description?: string
-  image?: {
-    /**
-     * URL of image to use in the card. Images must be less than 5MB in size.
-     * JPG, PNG, WEBP and GIF formats are supported. Only the first frame of
-     * an animated GIF will be used. SVG is not supported. Used with summary,
-     * summary_large_image, player cards. Fallback: og:image
-     */
-    ''?: string
-    /**
-     * A text description of the image conveying the essential nature of
-     * an image to users who are visually impaired. Maximum 420
-     * characters. Used with summary, summary_large_image, player cards
-     */
-    'alt'?: string
-  }
-  player?: TwitterPlayer
-  /**
-   * The @username of website. Either twitter:site or twitter:site:id is
-   * required. Used with summary, summary_large_image, app, player
-   * cards
-   */
-  site?: {
-    ''?: string
-    /**
-     * Same as twitter:site, but the user’s Twitter ID. Either
-     * twitter:site or twitter:site:id is required. Used with
-     * summary, summary_large_image, player cards
-     */
-    'id'?: string
-  }
-  /**
-   * Title of content (max 70 characters). Used with summary,
-   * summary_large_image, player cards. Fallback: og:title.
-   */
-  title?: string
-}

package/src/models/Twitter/TwitterApp.ts

@@ -1,17 +0,0 @@
-export interface TwitterApp {
-  id?: {
-    googleplay?: string
-    ipad?: string
-    iphone?: string
-  }
-  name?: {
-    googleplay?: string
-    ipad?: string
-    iphone?: string
-  }
-  url?: {
-    googleplay?: string
-    ipad?: string
-    iphone?: string
-  }
-}

package/src/models/Twitter/TwitterPlayer.ts

@@ -1,23 +0,0 @@
-/**
- * https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/player-card
- */
-export interface TwitterPlayer {
-  /**
-   * HTTPS URL to iFrame player. This must be a HTTPS URL which does not
-   * generate active mixed content warnings in a web browser. The audio or
-   * video player must not require plugins such as Adobe Flash.
-   */
-  '': string
-  /**
-   * Height of iframe in pixels. Used with player card
-   */
-  'height'?: number
-  /**
-   * URL to raw video or audio stream. Used with player card
-   */
-  'stream'?: string
-  /**
-   * Width of iframe in pixels. Used with player card
-   */
-  'width'?: number
-}

package/src/models/Twitter/index.ts

@@ -1,3 +0,0 @@
-export * from './Twitter.ts'
-export * from './TwitterApp.ts'
-export * from './TwitterPlayer.ts'

package/src/models/index.ts

@@ -1,3 +0,0 @@
-export * from './Meta.ts'
-export * from './OpenGraph/index.ts'
-export * from './Twitter/index.ts'

package/src/spec/template.html

@@ -1,42 +0,0 @@
-<!doctype html>
-<html lang="en">
-
-<head>
-  <meta charset="utf-8" />
-  <link rel="icon" href="/favicon.ico" />
-  <meta name="viewport" content="width=device-width,initial-scale=1" />
-  <meta name="theme-color" content="#000000" />
-  <meta name="description" content="Own your piece of XYO's Decentralized Digital World!" />
-  <link rel="apple-touch-icon" href="/apple-touch-icon.png" />
-  <link rel="manifest" href="/manifest.json" />
-  <title>XYO 2.0</title>
-  <link href="https://fonts.googleapis.com/css?family=Nunito+Sans|Lexend+Deca|Rock+Salt|Source+Code+Pro&display=swap"
-    rel="stylesheet">
-  <script async src="https://www.googletagmanager.com/gtag/js?id=G-795QBPW744"></script>
-  <script>function gtag() { dataLayer.push(arguments) } window.dataLayer = window.dataLayer || [], gtag("js", new Date), gtag("config", "G-795QBPW744")</script>
-  <style>
-    html {
-      overflow-y: auto;
-      overflow-x: hidden
-    }
-
-    #root,
-    body {
-      height: 100%;
-      width: 100%;
-      margin: 0;
-      padding: 0
-    }
-  </style>
-  <script defer="defer" src="/static/js/main.ae7f7033.js"></script>
-  <link href="/static/css/main.026e3fe6.css" rel="stylesheet">
-</head>
-
-<body style="padding:0;margin:0;overflow-x:hidden"><noscript><iframe
-      src="https://www.googletagmanager.com/ns.html?id=GTM-W2TFNXL" height="0" width="0"
-      style="display:none;visibility:hidden"></iframe></noscript><noscript>You need to enable JavaScript to run this
-    app.</noscript>
-  <div id="root"></div>
-</body>
-
-</html>