Renames PrerenderResource.of() to PrerenderResource.fromHtml().

Refs #71.

This more accurately reflects its actual usage and semantics now that `fromText()` and `fromBinary()` exist.

common/models/prerender_resource.mts

@@ -30,7 +30,8 @@ export class PrerenderResource {
      * @param contents A {@link SafeHtml} object to encode as a UTF-8 string.
      * @returns A {@link PrerenderResource} object representing the resource.
      */
-    public static of(path: string, contents: SafeHtml): PrerenderResource {
+    public static fromHtml(path: string, contents: SafeHtml):
+            PrerenderResource {
         if (!isSafeHtml(contents)) {
             throw new Error(`Only \`SafeHtml\` objects can be used in \`*.html\` or \`*.htm\` files. Use a rendering engine like \`@rules_prerender/preact\` to render to \`SafeHtml\`.`);
         }
@@ -49,7 +50,7 @@ export class PrerenderResource {
      * 
      * @param path The path the file will be generated at relative to the final
      *     generated site. Must begin with a `/` character. Must *not* end in 
-     *     `.html` or `.htm`. Use {@link PrerenderResource.of} with
+     *     `.html` or `.htm`. Use {@link PrerenderResource.fromHtml} with
      *     {@link SafeHtml} to generate HTML content.
      * @param contents A UTF-8 encoded string to output at the given path.
      * @returns A {@link PrerenderResource} object representing the resource.
@@ -60,7 +61,7 @@ export class PrerenderResource {
         // constructed and there could be injection attacks within it.
         if (path.endsWith('.html') || path.endsWith('.htm')) {
             throw new Error(`Cannot generate a \`*.html\` or \`*.htm\` file (${
-                path}) from a raw string (this would be unsafe!). HTML content should be rendered to \`SafeHtml\` first, and then written to a file in \`PrerenderResource.of()\`.`);
+                path}) from a raw string (this would be unsafe!). HTML content should be rendered to \`SafeHtml\` first, and then written to a file in \`PrerenderResource.fromHtml()\`.`);
         }
 
         return new PrerenderResource({
@@ -75,7 +76,7 @@ export class PrerenderResource {
      * 
      * @param path The path the file will be generated at relative to the final
      *     generated site. Must begin with a `/` character. Must *not* end in 
-     *     `.html` or `.htm`. Use {@link PrerenderResource.of} with
+     *     `.html` or `.htm`. Use {@link PrerenderResource.fromHtml} with
      *     {@link SafeHtml} to generate HTML content.
      * @param contents Binary content to associate with the given path.
      * @returns A {@link PrerenderResource} object representing the resource.
@@ -89,7 +90,7 @@ export class PrerenderResource {
         // constructed and there could be injection attacks within it.
         if (path.endsWith('.html') || path.endsWith('.htm')) {
             throw new Error(`Cannot generate a \`*.html\` or \`*.htm\` file (${
-                path}) from a raw string (this would be unsafe!). HTML content should be rendered to \`SafeHtml\` first, and then written to a file in \`PrerenderResource.of()\`.`);
+                path}) from a raw string (this would be unsafe!). HTML content should be rendered to \`SafeHtml\` first, and then written to a file in \`PrerenderResource.fromHtml()\`.`);
         }
 
         return new PrerenderResource({

common/models/prerender_resource_test.mts

@@ -4,27 +4,27 @@ import { PrerenderResource } from './prerender_resource.mjs';
 describe('PrerenderResource', () => {
     describe('of()', () => {
         it('returns a `PrerenderResource` from `SafeHtml` data', () => {
-            const res = PrerenderResource.of(
+            const res = PrerenderResource.fromHtml(
                 '/foo/bar.html', safe`<div></div>`);
 
             expect(res.path).toBe('/foo/bar.html');
             expect(new TextDecoder().decode(res.contents)).toBe('<div></div>');
         });
 
         it('throws when given non-`SafeHtml` input', () => {
-            expect(() => PrerenderResource.of(
+            expect(() => PrerenderResource.fromHtml(
                 '/foo/bar.html',
                 'unsafe HTML content' as unknown as SafeHtml,
             )).toThrowError(/Only `SafeHtml` objects can be used in `\*.html` or `\*.htm` files\./);
 
-            expect(() => PrerenderResource.of(
+            expect(() => PrerenderResource.fromHtml(
                 '/foo/bar.html',
                 { getHtmlAsString: () => 'unsafe HTML content' } as SafeHtml,
             )).toThrowError(/Only `SafeHtml` objects can be used in `\*.html` or `\*.htm` files\./);
         });
 
         it('throws when given an invalid URL path', () => {
-            expect(() => PrerenderResource.of(
+            expect(() => PrerenderResource.fromHtml(
                 'does/not/start/with/a/slash.ext',
                 safe`Hello, World!`,
             )).toThrowError(/must start with a "\/"/);

examples/components/site.tsx

@@ -3,7 +3,7 @@ import { Component } from './component.js';
 
 /** Renders a page using components. */
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Components</title>

examples/data/site.tsx

@@ -11,7 +11,7 @@ export default async function*():
     const files = entries.filter((entry) => entry.isFile());
 
     // Generate an index page which links to all posts.
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Data</title>
@@ -40,7 +40,7 @@ export default async function*():
             encoding: 'utf8',
         });
 
-        yield PrerenderResource.of(`/posts/${baseName}.html`, renderToHtml(
+        yield PrerenderResource.fromHtml(`/posts/${baseName}.html`, renderToHtml(
             <html>
                 <head>
                     <title>{baseName}</title>

examples/declarative_shadow_dom/site.tsx

@@ -2,7 +2,7 @@ import { PrerenderResource, renderToHtml } from '@rules_prerender/preact';
 import { Component } from './component.js';
 
 export default async function*(): AsyncGenerator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Declarative Shadow DOM</title>

examples/external/site.mts

@@ -5,7 +5,9 @@ export default function*(): Generator<PrerenderResource, void, void> {
     // TODO: Migrate to Preact once we figure out how to handle
     // `@rules_prerender/preact`'s peer dep in an external repository with
     // manual `npm_link_package()` dependencies.
-    yield PrerenderResource.of('/index.html', unsafeTreatStringAsSafeHtml(`
+    yield PrerenderResource.fromHtml(
+        '/index.html',
+        unsafeTreatStringAsSafeHtml(`
 <!DOCTYPE html>
 <html>
     <head>
@@ -18,5 +20,6 @@ export default function*(): Generator<PrerenderResource, void, void> {
         ${renderComponent()}
     </body>
 </html>
-    `.trim()));
+        `.trim()),
+    );
 }

examples/javascript/site.mjs

@@ -4,7 +4,7 @@ import { Component } from './component/component.mjs';
 
 /* Renders the page. */
 export default function* () {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         h('html', {}, [
             h('head', {}, [
                 h('meta', { charSet: 'utf8' }),

examples/minimal/site.tsx

@@ -3,7 +3,7 @@ import { PrerenderResource, renderToHtml } from '@rules_prerender/preact';
 
 /** Renders the page. */
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Minimal</title>

examples/multi_page/site.tsx

@@ -2,7 +2,7 @@ import { PrerenderResource, includeScript, inlineStyle, renderToHtml } from '@ru
 import { ComponentChildren, VNode } from 'preact';
 
 export default function* (): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <Page>
             <h2>Multi-Page</h2>
             <img src="/logo.png" />
@@ -16,17 +16,17 @@ export default function* (): Generator<PrerenderResource, void, void> {
         </Page>,
     ));
 
-    yield PrerenderResource.of('/foo.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/foo.html', renderToHtml(
         <Page>
             <h2>Foo</h2>
         </Page>,
     ));
-    yield PrerenderResource.of('/bar.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/bar.html', renderToHtml(
         <Page>
             <h2>Bar</h2>
         </Page>,
     ));
-    yield PrerenderResource.of('/hello/world.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/hello/world.html', renderToHtml(
         <Page>
             <h2>Hello, World!</h2>
         </Page>,

examples/preact/site.tsx

@@ -2,7 +2,7 @@ import { PrerenderResource, renderToHtml } from '@rules_prerender/preact';
 import { Component } from './component/component.js';
 
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Preact</title>

examples/resources/site.tsx

@@ -3,7 +3,7 @@ import { Component } from './component/component.js';
 import { Transitive } from './transitive/transitive.js';
 
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Resources</title>

examples/script_isolation/site.tsx

@@ -1,7 +1,7 @@
 import { PrerenderResource, includeScript, renderToHtml } from '@rules_prerender/preact';
 
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Script Isolation</title>
@@ -16,7 +16,7 @@ export default function*(): Generator<PrerenderResource, void, void> {
         </html>
     ));
 
-    yield PrerenderResource.of('/foo.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/foo.html', renderToHtml(
         <html>
             <head>
                 <title>Script Isolation</title>
@@ -30,7 +30,7 @@ export default function*(): Generator<PrerenderResource, void, void> {
         </html>
     ));
 
-    yield PrerenderResource.of('/bar.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/bar.html', renderToHtml(
         <html>
             <head>
                 <title>Script Isolation</title>

examples/scripts/site.tsx

@@ -3,7 +3,7 @@ import { Component } from './component/component.js';
 
 /** Render some HTML with a `<script />` tag. */
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Scripts</title>

examples/shared_chunks/site.tsx

@@ -1,7 +1,7 @@
 import { PrerenderResource, includeScript, renderToHtml } from '@rules_prerender/preact';
 
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Shared Chunks</title>
@@ -16,7 +16,7 @@ export default function*(): Generator<PrerenderResource, void, void> {
         </html>
     ));
 
-    yield PrerenderResource.of('/hello.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/hello.html', renderToHtml(
         <html>
             <head>
                 <title>Shared Chunks</title>
@@ -29,7 +29,7 @@ export default function*(): Generator<PrerenderResource, void, void> {
         </html>
     ));
 
-    yield PrerenderResource.of('/goodbye.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/goodbye.html', renderToHtml(
         <html>
             <head>
                 <title>Shared Chunks</title>

examples/site/about/about.tsx

@@ -5,7 +5,7 @@ import { srcLink } from '../common/links.mjs';
 
 /** Renders the about page. */
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of(
+    yield PrerenderResource.fromHtml(
         '/about/index.html',
         renderToHtml(baseLayout('About',
             <article>

examples/site/blog/blog.tsx

@@ -47,7 +47,7 @@ export default async function*():
 
 /** Generate and return a resource with the list of posts at the given path. */
 function generatePostList(path: string, posts: PostMeta[]): PrerenderResource {
-    return PrerenderResource.of(path, renderToHtml(baseLayout('Blog', 
+    return PrerenderResource.fromHtml(path, renderToHtml(baseLayout('Blog', 
         <article>
             <Template shadowroot='open'>
                 {polyfillDeclarativeShadowDom()}
@@ -76,7 +76,7 @@ async function generatePost({ urlPath, title, fileName }: PostMeta):
     });
     const link = srcLink(`/examples/site/blog/posts/${fileName}`);
 
-    return PrerenderResource.of(urlPath, renderToHtml(baseLayout(title, 
+    return PrerenderResource.fromHtml(urlPath, renderToHtml(baseLayout(title, 
         <article>
             <Template shadowroot='open'>
                 {polyfillDeclarativeShadowDom()}

examples/site/components/counter/counter_test_cases.tsx

@@ -4,7 +4,7 @@ import { Counter } from './counter_prerender.js';
 /** Generates prerendered test cases of the counter. */
 export default function* (): Generator<PrerenderResource, void, void> {
     // Prerendered counter with an initial value of zero.
-    yield PrerenderResource.of('/zero.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/zero.html', renderToHtml(
         <html>
             <head>
                 <title>Zero</title>
@@ -16,7 +16,7 @@ export default function* (): Generator<PrerenderResource, void, void> {
     ));
 
     // Prerendered counter with a positive initial value (4).
-    yield PrerenderResource.of('/positive.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/positive.html', renderToHtml(
         <html>
             <head>
                 <title>Positive</title>
@@ -28,7 +28,7 @@ export default function* (): Generator<PrerenderResource, void, void> {
     ));
 
     // Prerendered counter with a negative initial value (-7).
-    yield PrerenderResource.of('/negative.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/negative.html', renderToHtml(
         <html>
             <head>
                 <title>Negative</title>

examples/site/counter/counter.tsx

@@ -6,7 +6,7 @@ import { Counter } from '../components/counter/counter_prerender.js';
 
 /** Renders the counter page. */
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of(
+    yield PrerenderResource.fromHtml(
         '/counter/index.html',
         renderToHtml(baseLayout('Counter',
             <article>

examples/site/home/home.tsx

@@ -5,7 +5,8 @@ import { repo, srcLink } from '../common/links.mjs';
 
 /** Renders the entire home page. */
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(baseLayout('Home',
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(baseLayout(
+        'Home',
         <article>
             <Template shadowroot='open'>
                 {polyfillDeclarativeShadowDom()}
@@ -78,6 +79,6 @@ export default function*(): Generator<PrerenderResource, void, void> {
                     of <code>rules_prerender</code>!
                 </p>
             </Template>
-        </article>
+        </article>,
     )));
 }

examples/styles/site.tsx

@@ -2,7 +2,7 @@ import { PrerenderResource, Template, inlineStyle, renderToHtml } from '@rules_p
 
 /** Generates a page with an inline style in a declarative shadow root. */
 export default function* (): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Inline Styles</title>

examples/testonly/site.tsx

@@ -2,7 +2,7 @@ import { PrerenderResource, Template, inlineStyle, includeScript, renderToHtml }
 import { Component } from './component/component.js';
 
 export default function*(): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>Testonly</title>

examples/tsconfig/site.tsx

@@ -7,7 +7,7 @@ import { PrerenderResource, renderToHtml } from '@rules_prerender/preact';
  *     tsconfig file used to compile this file.
  */
 export default function*(foo): Generator<PrerenderResource, void, void> {
-    yield PrerenderResource.of('/index.html', renderToHtml(
+    yield PrerenderResource.fromHtml('/index.html', renderToHtml(
         <html>
             <head>
                 <title>tsconfig</title>