@revealui/core 0.0.1-pre.0 → 0.0.1-pre.2

package/dist/core/renderer/prerender/utils.ts

@@ -1,22 +0,0 @@
-import { assertIsNotBrowser } from "../../gaurds/assertions/assertIsNotBrowser/index.js";
-
-assertIsNotBrowser();
-
-export * from "../../gaurds/validators/isCallable.js";
-export * from "../../gaurds/validators/hasProp.js";
-export * from "../../gaurds/validators/isArray.js";
-export * from "../../gaurds/validators/isFilePathAbsoluteFilesystem.js";
-export * from "../../gaurds/validators/isObjectWithKeys.js";
-export * from "../../gaurds/validators/isPlainObject.js";
-export * from "../../gaurds/validators/isPropertyGetter.js";
-export * from "../../globals/versions/projectInfo.js";
-export * from "../../processing/getters/getOutDirs.js";
-export * from "../../targets/url/urlToFile.js";
-export * from "../../gaurds/assertions/assert/index.js";
-export * from "../../gaurds/assertions/assertWarning/index.js";
-export * from "../../gaurds/assertions/assertUsage/index.js";
-export * from "../../gaurds/assertions/assertNodeEnv/index.js";
-export * from "../../utils/async/pLimit.js";
-export * from "../../files/file-system/filesystemPath.js";
-export * from "../../utils/object/changeEnumerable.js";
-export * from "../../utils/object/objectAssign.js";

package/dist/core/renderer/stream/html.ts

@@ -1,408 +0,0 @@
-export {
-  dangerouslySkipEscape,
-  escapeInject,
-  getHtmlString,
-  isDocumentHtml,
-  renderDocumentHtml,
-}
-export type { DocumentHtml, HtmlPart, HtmlRender }
-// This export is needed even though it's not used anywhere, see https://github.com/revealjs/reveal/issues/511
-export type { TemplateWrapped }
-
-import pc from "@brillout/picocolors"
-import {
-  injectHtmlTagsToStream,
-  injectHtmlTagsToString,
-  PageContextInjectAssets,
-} from "../../assets/index.js"
-import { getGlobalContext } from "../../globals/contexts/globalContext/index.js"
-import { PreloadFilter } from "../../processing/getters/getHtmlTags.js"
-import type { PageAsset } from "../../processing/getters/getPageAssets.js"
-import {
-  isStream,
-  processStream,
-  StreamProviderAny,
-  StreamProviderNormalized,
-  streamToString,
-  StreamTypePatch,
-} from "./index.js"
-import {
-  isStreamFromReactStreamingPackage,
-  StreamFromReactStreamingPackage,
-} from "./react-streaming.js"
-import {
-  assert,
-  assertUsage,
-  assertWarning,
-  checkType,
-  escapeHtml,
-  hasProp,
-  isHtml,
-  isPromise,
-  objectAssign,
-} from "./utils.js"
-
-type DocumentHtml = TemplateWrapped | EscapedString | StreamProviderAny
-type HtmlRender = string | StreamProviderNormalized
-
-type TemplateStrings = TemplateStringsArray
-type TemplateVariable =
-  | string
-  | EscapedString
-  | StreamProviderAny
-  | TemplateWrapped
-type TemplateWrapped = {
-  _template: TemplateContent
-}
-type TemplateContent = {
-  templateStrings: TemplateStrings
-  templateVariables: TemplateVariable[]
-}
-
-function isDocumentHtml(something: unknown): something is DocumentHtml {
-  if (
-    isTemplateWrapped(something) ||
-    isEscapedString(something) ||
-    isStream(something)
-  ) {
-    checkType<DocumentHtml>(something)
-    return true
-  }
-  return false
-}
-
-async function renderDocumentHtml(
-  documentHtml: DocumentHtml,
-  pageContext: PageContextInjectAssets,
-  onErrorWhileStreaming: (err: unknown) => void,
-  injectFilter: PreloadFilter
-): Promise<HtmlRender> {
-  if (isEscapedString(documentHtml)) {
-    objectAssign(pageContext, { _isStream: false as const })
-    let htmlString = getEscapedString(documentHtml)
-    htmlString = await injectHtmlTagsToString(
-      [htmlString],
-      pageContext,
-      injectFilter
-    )
-    return htmlString
-  }
-  if (isStream(documentHtml)) {
-    objectAssign(pageContext, { _isStream: true as const })
-    const stream = documentHtml
-    const streamWrapper = await renderHtmlStream(
-      stream,
-      null,
-      pageContext,
-      onErrorWhileStreaming,
-      injectFilter
-    )
-    return streamWrapper
-  }
-  if (isTemplateWrapped(documentHtml)) {
-    const templateContent = documentHtml._template
-    const render = await renderTemplate(templateContent, pageContext)
-    if (!("htmlStream" in render)) {
-      objectAssign(pageContext, { _isStream: false as const })
-      const { htmlPartsAll } = render
-      const htmlString = await injectHtmlTagsToString(
-        htmlPartsAll,
-        pageContext,
-        injectFilter
-      )
-      return htmlString
-    } else {
-      objectAssign(pageContext, { _isStream: true as const })
-      const { htmlStream } = render
-      const streamWrapper = await renderHtmlStream(
-        htmlStream,
-        {
-          htmlPartsBegin: render.htmlPartsBegin,
-          htmlPartsEnd: render.htmlPartsEnd,
-        },
-        pageContext,
-        onErrorWhileStreaming,
-        injectFilter
-      )
-      return streamWrapper
-    }
-  }
-  checkType<never>(documentHtml)
-  assert(false)
-}
-
-async function renderHtmlStream(
-  streamOriginal: StreamProviderAny & { injectionBuffer?: string[] },
-  injectString: null | { htmlPartsBegin: HtmlPart[]; htmlPartsEnd: HtmlPart[] },
-  pageContext: PageContextInjectAssets & {
-    enableEagerStreaming?: boolean
-    _isStream: true
-  },
-  onErrorWhileStreaming: (err: unknown) => void,
-  injectFilter: PreloadFilter
-) {
-  const processStreamOptions: Parameters<typeof processStream>[1] = {
-    onErrorWhileStreaming,
-    enableEagerStreaming: pageContext.enableEagerStreaming,
-  }
-  if (injectString) {
-    let streamFromReactStreamingPackage: null | StreamFromReactStreamingPackage =
-      null
-    if (
-      isStreamFromReactStreamingPackage(streamOriginal) &&
-      !streamOriginal.disabled
-    ) {
-      streamFromReactStreamingPackage = streamOriginal
-    }
-    const {
-      injectAtStreamBegin,
-      injectAtStreamAfterFirstChunk,
-      injectAtStreamEnd,
-    } = injectHtmlTagsToStream(
-      pageContext,
-      streamFromReactStreamingPackage,
-      injectFilter
-    )
-    processStreamOptions.injectStringAtBegin = async () => {
-      return await injectAtStreamBegin(injectString.htmlPartsBegin)
-    }
-    processStreamOptions.injectStringAtEnd = async () => {
-      return await injectAtStreamEnd(injectString.htmlPartsEnd)
-    }
-    processStreamOptions.injectStringAfterFirstChunk = () => {
-      return injectAtStreamAfterFirstChunk()
-    }
-  }
-  const streamWrapper = await processStream(
-    streamOriginal,
-    processStreamOptions
-  )
-  return streamWrapper
-}
-
-function isTemplateWrapped(something: unknown): something is TemplateWrapped {
-  return hasProp(something, "_template")
-}
-function isEscapedString(something: unknown): something is EscapedString {
-  const result = hasProp(something, "_escaped")
-  if (result) {
-    assert(hasProp(something, "_escaped", "string"))
-    checkType<EscapedString>(something)
-  }
-  return result
-}
-
-function getEscapedString(escapedString: EscapedString): string {
-  let htmlString: string
-  assert(hasProp(escapedString, "_escaped"))
-  htmlString = escapedString._escaped
-  assert(typeof htmlString === "string")
-  return htmlString
-}
-
-function escapeInject(
-  templateStrings: TemplateStrings,
-  ...templateVariables: (TemplateVariable | StreamTypePatch)[]
-): TemplateWrapped {
-  assertUsage(
-    templateStrings.length === templateVariables.length + 1 &&
-      templateStrings.every((str) => typeof str === "string"),
-    `You're using ${pc.cyan("escapeInject")} as a function, but ${pc.cyan(
-      "escapeInject"
-    )} is a string template tag, see https://reveal.dev/escapeInject`,
-    { showStackTrace: true }
-  )
-  return {
-    _template: {
-      templateStrings,
-      templateVariables: templateVariables as TemplateVariable[],
-    },
-  }
-}
-type EscapedString = { _escaped: string }
-function dangerouslySkipEscape(alreadyEscapedString: string): EscapedString {
-  return _dangerouslySkipEscape(alreadyEscapedString)
-}
-function _dangerouslySkipEscape(arg: unknown): EscapedString {
-  if (hasProp(arg, "_escaped")) {
-    assert(isEscapedString(arg))
-    return arg
-  }
-  assertUsage(
-    !isPromise(arg),
-    `[dangerouslySkipEscape(${pc.cyan("str")})] Argument ${pc.cyan(
-      "str"
-    )} is a promise. It should be a string instead (or a stream). Make sure to ${pc.cyan("await str")}.`,
-    { showStackTrace: true }
-  )
-  if (typeof arg === "string") {
-    return { _escaped: arg }
-  }
-  assertWarning(
-    false,
-    `[dangerouslySkipEscape(${pc.cyan("str")})] Argument ${pc.cyan("str")} should be a string but we got ${pc.cyan(
-      `typeof str === "${typeof arg}"`
-    )}.`,
-    {
-      onlyOnce: false,
-      showStackTrace: true,
-    }
-  )
-  return { _escaped: String(arg) }
-}
-
-// Currently, `HtmlPart` is always a `string`. But we may need string-returning-functions for advanced stream integrations such as RSC.
-type HtmlPart = string | ((pageAssets: PageAsset[]) => string)
-
-async function renderTemplate(
-  templateContent: TemplateContent,
-  pageContext: PageContextInjectAssets
-): Promise<
-  | { htmlPartsAll: HtmlPart[] }
-  | {
-      htmlStream: StreamProviderAny
-      htmlPartsBegin: HtmlPart[]
-      htmlPartsEnd: HtmlPart[]
-    }
-> {
-  const htmlPartsBegin: HtmlPart[] = []
-  const htmlPartsEnd: HtmlPart[] = []
-  let htmlStream: null | StreamProviderAny = null
-
-  const addHtmlPart = (htmlPart: HtmlPart) => {
-    if (htmlStream === null) {
-      htmlPartsBegin.push(htmlPart)
-    } else {
-      htmlPartsEnd.push(htmlPart)
-    }
-  }
-
-  const setStream = (stream: StreamProviderAny) => {
-    const { hookName, hookFilePath } = pageContext._renderHook
-    assertUsage(
-      !htmlStream,
-      `Injecting two streams in ${pc.cyan(
-        "escapeInject"
-      )} template tag of ${hookName}() hook defined by ${hookFilePath}. Inject only one stream instead.`
-    )
-    htmlStream = stream
-  }
-
-  const { templateStrings, templateVariables } = templateContent
-  for (let i = 0; i < templateVariables.length; i++) {
-    addHtmlPart(templateStrings[i]!)
-    let templateVar = templateVariables[i]
-
-    // Process `dangerouslySkipEscape()`
-    if (isEscapedString(templateVar)) {
-      const htmlString = getEscapedString(templateVar)
-      // User used `dangerouslySkipEscape()` so we assume the string to be safe
-      addHtmlPart(htmlString)
-      continue
-    }
-
-    // Process `escapeInject` fragments
-    if (isTemplateWrapped(templateVar)) {
-      const templateContentInner = templateVar._template
-      const result = await renderTemplate(templateContentInner, pageContext)
-      if (!("htmlStream" in result)) {
-        result.htmlPartsAll.forEach(addHtmlPart)
-      } else {
-        result.htmlPartsBegin.forEach(addHtmlPart)
-        setStream(result.htmlStream)
-        result.htmlPartsEnd.forEach(addHtmlPart)
-      }
-      continue
-    }
-
-    if (isStream(templateVar)) {
-      setStream(templateVar)
-      continue
-    }
-
-    const getErrMsg = (msg: `${string}.` | `${string}?`) => {
-      const { hookName, hookFilePath } = pageContext._renderHook
-      const nth: string =
-        (i === 0 && "1st") ||
-        (i === 1 && "2nd") ||
-        (i === 2 && "3rd") ||
-        `${i}-th`
-      return [
-        `The ${nth} HTML variable is ${msg}`,
-        `The HTML was provided by the ${hookName}() hook at ${hookFilePath}.`,
-      ]
-        .filter(Boolean)
-        .join(" ")
-    }
-
-    assertUsage(
-      !isPromise(templateVar),
-      getErrMsg(`a promise, did you forget to ${pc.cyan("await")} the promise?`)
-    )
-
-    if (templateVar === undefined || templateVar === null) {
-      const msgVal = pc.cyan(String(templateVar))
-      const msgEmptyString = pc.cyan("''")
-      const msg =
-        `${msgVal} which will be converted to an empty string. Pass the empty string ${msgEmptyString} instead of ${msgVal} to remove this warning.` as const
-      assertWarning(false, getErrMsg(msg), { onlyOnce: false })
-      templateVar = ""
-    }
-
-    {
-      const varType = typeof templateVar
-      if (varType !== "string") {
-        const msgType = pc.cyan(
-          `typeof htmlVariable === "${varType as string}"`
-        )
-        const msg =
-          `${msgType} but a string or stream (https://reveal.dev/streaming) is expected instead.` as const
-        assertUsage(false, getErrMsg(msg))
-      }
-    }
-
-    {
-      const { isProduction } = getGlobalContext()
-      if (
-        isHtml(templateVar) &&
-        // We don't show this warning in production because it's expected that some users may (un)willingly do some XSS injection: we avoid flooding the production logs.
-        !isProduction
-      ) {
-        const msgVal = pc.cyan(String(templateVar))
-        const msg =
-          `${msgVal} which seems to be HTML code. Did you forget to wrap the value with dangerouslySkipEscape()?` as const
-        assertWarning(false, getErrMsg(msg), { onlyOnce: false })
-      }
-    }
-
-    // Escape untrusted template variable
-    addHtmlPart(escapeHtml(templateVar))
-  }
-
-  assert(templateStrings.length === templateVariables.length + 1)
-  addHtmlPart(templateStrings[templateStrings.length - 1]!)
-
-  if (htmlStream === null) {
-    assert(htmlPartsEnd.length === 0)
-    return {
-      htmlPartsAll: htmlPartsBegin,
-    }
-  }
-
-  return {
-    htmlStream,
-    htmlPartsBegin,
-    htmlPartsEnd,
-  }
-}
-
-async function getHtmlString(htmlRender: HtmlRender): Promise<string> {
-  if (typeof htmlRender === "string") {
-    return htmlRender
-  }
-  if (isStream(htmlRender)) {
-    return streamToString(htmlRender)
-  }
-  checkType<never>(htmlRender)
-  assert(false)
-}