@joist/element 4.2.3-next.13 → 4.2.3-next.2

package/src/lib/templating/bind.ts

@@ -0,0 +1,40 @@
+import { instanceMetadataStore, observe } from "@joist/observable";
+
+export function bind() {
+  return function bindDecorator<This extends HTMLElement, Value>(
+    base: ClassAccessorDecoratorTarget<This, Value>,
+    ctx: ClassAccessorDecoratorContext<This, Value>,
+  ): ClassAccessorDecoratorResult<This, Value> {
+    const internalObserve = observe()(base, ctx);
+
+    return {
+      init(value) {
+        this.addEventListener("joist::value", (e) => {
+          if (e.token.bindTo === ctx.name) {
+            const instanceMeta = instanceMetadataStore.read<This>(this);
+
+            e.stopPropagation();
+
+            e.update({ oldValue: null, newValue: ctx.access.get(this) });
+
+            instanceMeta.bindings.add((changes) => {
+              const key = ctx.name as keyof This;
+              const res = changes.get(key);
+
+              if (res) {
+                e.update(res);
+              }
+            });
+          }
+        });
+
+        if (internalObserve.init) {
+          return internalObserve.init.call(this, value);
+        }
+
+        return value;
+      },
+      set: internalObserve.set,
+    };
+  };
+}

package/src/lib/templating/define.ts

@@ -0,0 +1,5 @@
+import "./elements/async.element.js";
+import "./elements/for.element.js";
+import "./elements/if.element.js";
+import "./elements/props.element.js";
+import "./elements/value.element.js";

package/src/lib/templating/elements/async.element.test.ts

@@ -0,0 +1,90 @@
+import "./async.element.js";
+
+import { fixtureSync, html } from "@open-wc/testing";
+import { assert } from "chai";
+
+import type { JoistValueEvent } from "../events.js";
+
+it("should show loading template when promise is pending", async () => {
+  const element = fixtureSync(html`
+    <div
+      @joist::value=${(e: JoistValueEvent) => {
+        e.update({ oldValue: null, newValue: new Promise(() => {}) });
+      }}
+    >
+      <j-async bind="test">
+        <template loading>Loading...</template>
+        <template success>Success!</template>
+        <template error>Error!</template>
+      </j-async>
+    </div>
+  `);
+
+  assert.equal(element.textContent?.trim(), "Loading...");
+});
+
+it("should show success template when promise resolves", async () => {
+  const element = fixtureSync(html`
+    <div
+      @joist::value=${(e: JoistValueEvent) => {
+        e.update({ oldValue: null, newValue: Promise.resolve("data") });
+      }}
+    >
+      <j-async bind="test">
+        <template loading>Loading...</template>
+        <template success>Success!</template>
+        <template error>Error!</template>
+      </j-async>
+    </div>
+  `);
+
+  // Wait for promise to resolve
+  await new Promise((resolve) => setTimeout(resolve, 0));
+  assert.equal(element.textContent?.trim(), "Success!");
+});
+
+it("should show error template when promise rejects", async () => {
+  const element = fixtureSync(html`
+    <div
+      @joist::value=${(e: JoistValueEvent) => {
+        e.update({ oldValue: null, newValue: Promise.reject("error") });
+      }}
+    >
+      <j-async bind="test">
+        <template loading>Loading...</template>
+        <template success>Success!</template>
+        <template error>Error!</template>
+      </j-async>
+    </div>
+  `);
+
+  // Wait for promise to reject
+  await new Promise((resolve) => setTimeout(resolve, 0));
+  assert.equal(element.textContent?.trim(), "Error!");
+});
+
+it("should handle state transitions", async () => {
+  const element = fixtureSync(html`
+    <div
+      @joist::value=${(e: JoistValueEvent) => {
+        const promise = new Promise((resolve) => {
+          setTimeout(() => resolve("data"), 100);
+        });
+        e.update({ oldValue: null, newValue: promise });
+      }}
+    >
+      <j-async bind="test">
+        <template loading>Loading...</template>
+        <template success>Success!</template>
+        <template error>Error!</template>
+      </j-async>
+    </div>
+  `);
+
+  // Initially should show loading
+  assert.equal(element.textContent?.trim(), "Loading...");
+
+  // Wait for promise to resolve
+  await new Promise((resolve) => setTimeout(resolve, 150));
+  assert.equal(element.textContent?.trim(), "Success!");
+});

package/src/lib/templating/elements/async.element.ts

@@ -0,0 +1,122 @@
+import { attr } from "../../attr.js";
+import { element } from "../../element.js";
+import { queryAll } from "../../query-all.js";
+import { css, html } from "../../tags.js";
+import { bind } from "../bind.js";
+
+import { JoistValueEvent } from "../events.js";
+import { JToken } from "../token.js";
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "j-async": JoistAsyncElement;
+  }
+}
+
+export type AsyncState<T = unknown, E = unknown> = {
+  status: "loading" | "error" | "success";
+  data?: T;
+  error?: E;
+};
+
+@element({
+  tagName: "j-async",
+  // prettier-ignore
+  shadowDom: [css`:host{display: contents;}`, html`<slot></slot>`],
+})
+export class JoistAsyncElement extends HTMLElement {
+  @attr()
+  accessor bind = "";
+
+  @bind()
+  accessor state: AsyncState | null = null;
+
+  #templates = queryAll<HTMLTemplateElement>("template", this);
+  #currentNodes: Node[] = [];
+  #cachedTemplates: {
+    loading?: HTMLTemplateElement;
+    error?: HTMLTemplateElement;
+    success?: HTMLTemplateElement;
+  } = {
+    loading: undefined,
+    error: undefined,
+    success: undefined,
+  };
+
+  connectedCallback(): void {
+    this.#clean();
+
+    // Cache all templates
+    const templates = Array.from(this.#templates());
+
+    this.#cachedTemplates = {
+      loading: templates.find((t) => t.hasAttribute("loading")),
+      error: templates.find((t) => t.hasAttribute("error")),
+      success: templates.find((t) => t.hasAttribute("success")),
+    };
+
+    const token = new JToken(this.bind);
+
+    this.dispatchEvent(
+      new JoistValueEvent(token, ({ newValue, oldValue }) => {
+        if (newValue !== oldValue) {
+          if (newValue instanceof Promise) {
+            this.#handlePromise(newValue);
+          } else {
+            console.warn("j-async bind value must be a Promise or AsyncState");
+          }
+        }
+      }),
+    );
+  }
+
+  async #handlePromise(promise: Promise<unknown>): Promise<void> {
+    try {
+      this.#handleState({ status: "loading" });
+      const data = await promise;
+      this.#handleState({ status: "success", data });
+    } catch (error) {
+      this.#handleState({ status: "error", error });
+    }
+  }
+
+  #handleState(state: AsyncState): void {
+    this.#clean();
+
+    let template: HTMLTemplateElement | undefined = undefined;
+
+    this.state = state;
+
+    switch (state.status) {
+      case "loading":
+        template = this.#cachedTemplates.loading;
+        break;
+
+      case "error":
+        template = this.#cachedTemplates.error;
+        break;
+
+      case "success":
+        template = this.#cachedTemplates.success;
+        break;
+    }
+
+    if (template) {
+      const content = document.importNode(template.content, true);
+      const nodes = Array.from(content.childNodes);
+      this.appendChild(content);
+      this.#currentNodes = nodes;
+    }
+  }
+
+  #clean(): void {
+    for (const node of this.#currentNodes) {
+      node.parentNode?.removeChild(node);
+    }
+    this.#currentNodes = [];
+  }
+
+  disconnectedCallback(): void {
+    this.#clean();
+  }
+}

package/src/lib/templating/elements/for.element.test.ts

@@ -0,0 +1,221 @@
+import "./for.element.js";
+import "./value.element.js";
+
+import { fixtureSync, html } from "@open-wc/testing";
+import { assert } from "chai";
+
+import type { JoistValueEvent } from "../events.js";
+
+it("should iterate over an iterable", () => {
+  const element = fixtureSync(html`
+    <div
+      @joist::value=${(e: JoistValueEvent) => {
+        e.update({
+          oldValue: null,
+          newValue: new Set([
+            { id: "123", label: "Hello" },
+            { id: "456", label: "World" },
+          ]),
+        });
+      }}
+    >
+      <ul>
+        <j-for bind="items" key="id">
+          <template>
+            <li>
+              <j-value bind="each.value.label"></j-value>
+            </li>
+          </template>
+        </j-for>
+      </ul>
+    </div>
+  `);
+
+  const listItems = element.querySelectorAll("li");
+
+  assert.equal(listItems.length, 2);
+  assert.equal(listItems[0].textContent?.trim(), "Hello");
+  assert.equal(listItems[1].textContent?.trim(), "World");
+});
+
+it("should handle empty arrays", () => {
+  const element = fixtureSync(html`
+    <div
+      @joist::value=${(e: JoistValueEvent) => {
+        e.update({
+          oldValue: null,
+          newValue: [],
+        });
+      }}
+    >
+      <j-for bind="items">
+        <template>
+          <div>Item</div>
+        </template>
+      </j-for>
+    </div>
+  `);
+
+  assert.equal(element.querySelectorAll("div").length, 0);
+});
+
+it("should update when items are added or removed", () => {
+  const element = fixtureSync(html`
+    <div
+      @joist::value=${(e: JoistValueEvent) => {
+        // Initial items
+        e.update({
+          oldValue: null,
+          newValue: [
+            { id: "1", text: "First" },
+            { id: "2", text: "Second" },
+          ],
+        });
+
+        // Add an item
+        e.update({
+          oldValue: null,
+          newValue: [
+            { id: "1", text: "First" },
+            { id: "2", text: "Second" },
+            { id: "3", text: "Third" },
+          ],
+        });
+
+        // Remove an item
+        e.update({
+          oldValue: null,
+          newValue: [
+            { id: "1", text: "First" },
+            { id: "3", text: "Third" },
+          ],
+        });
+      }}
+    >
+      <j-for bind="items" key="id">
+        <template>
+          <j-value bind="each.value.text"></j-value>
+        </template>
+      </j-for>
+    </div>
+  `);
+
+  const items = element.querySelectorAll("j-value");
+  assert.equal(items.length, 2);
+  assert.equal(items[0].textContent?.trim(), "First");
+  assert.equal(items[1].textContent?.trim(), "Third");
+});
+
+it("should provide index and position information", () => {
+  const element = fixtureSync(html`
+    <div
+      @joist::value=${(e: JoistValueEvent) => {
+        e.update({
+          oldValue: null,
+          newValue: ["A", "B", "C"],
+        });
+      }}
+    >
+      <j-for bind="items">
+        <template>
+          <j-value bind="each.value"></j-value>
+          (index: <j-value bind="each.index"></j-value>,
+          position: <j-value bind="each.position"></j-value>)
+        </template>
+      </j-for>
+    </div>
+  `);
+
+  const items = element.querySelectorAll("j-for-scope");
+  assert.equal(items.length, 3);
+  assert.equal(
+    items[0].textContent?.trim().replaceAll("\n", "").replaceAll(" ", ""),
+    "A(index:0,position:1)",
+  );
+  assert.equal(
+    items[1].textContent?.trim().replaceAll("\n", "").replaceAll(" ", ""),
+    "B(index:1,position:2)",
+  );
+  assert.equal(
+    items[2].textContent?.trim().replaceAll("\n", "").replaceAll(" ", ""),
+    "C(index:2,position:3)",
+  );
+});
+
+// it("should handle nested j-for elements", () => {
+//   const element = fixtureSync(html`
+//     <div
+//       @joist::value=${(e: JoistValueEvent) => {
+//         e.update({
+//           oldValue: null,
+//           newValue: [
+//             { id: "1", items: ["A", "B"] },
+//             { id: "2", items: ["C", "D"] },
+//           ],
+//         });
+//       }}
+//     >
+//       <j-for bind="groups" key="id">
+//         <template>
+//           <div class="group">
+//             <j-for bind="each.value.items">
+//               <template>
+//                 <j-value class="child" bind="each.value"></j-value>
+//               </template>
+//             </j-for>
+//           </div>
+//         </template>
+//       </j-for>
+//     </div>
+//   `);
+
+//   const groups = element.querySelectorAll(".group");
+//   assert.equal(groups.length, 2);
+
+//   const items = element.querySelectorAll(".child");
+//   assert.equal(items.length, 4);
+//   assert.equal(items[0].textContent?.trim(), "A");
+//   assert.equal(items[1].textContent?.trim(), "B");
+//   assert.equal(items[2].textContent?.trim(), "C");
+//   assert.equal(items[3].textContent?.trim(), "D");
+// });
+
+it("should maintain DOM order when items are reordered", () => {
+  const element = fixtureSync(html`
+    <div
+      @joist::value=${(e: JoistValueEvent) => {
+        // Initial order
+        e.update({
+          oldValue: null,
+          newValue: [
+            { id: "1", text: "First" },
+            { id: "2", text: "Second" },
+            { id: "3", text: "Third" },
+          ],
+        });
+
+        // Reorder items
+        e.update({
+          oldValue: null,
+          newValue: [
+            { id: "3", text: "Third" },
+            { id: "1", text: "First" },
+            { id: "2", text: "Second" },
+          ],
+        });
+      }}
+    >
+      <j-for bind="items" key="id">
+        <template>
+          <j-value bind="each.value.text"></j-value>
+        </template>
+      </j-for>
+    </div>
+  `);
+
+  const items = element.querySelectorAll("j-value");
+  assert.equal(items.length, 3);
+  assert.equal(items[0].textContent?.trim(), "Third");
+  assert.equal(items[1].textContent?.trim(), "First");
+  assert.equal(items[2].textContent?.trim(), "Second");
+});

package/src/lib/templating/elements/for.element.ts

@@ -0,0 +1,189 @@
+import { attr } from "../../attr.js";
+import { element } from "../../element.js";
+import { query } from "../../query.js";
+import { css, html } from "../../tags.js";
+
+import { bind } from "../bind.js";
+import { JoistValueEvent } from "../events.js";
+import { JToken } from "../token.js";
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "j-for": JositForElement;
+    "j-for-scope": JForScope;
+  }
+}
+
+export interface EachCtx<T> {
+  value: T | null;
+  index: number | null;
+  position: number | null;
+}
+
+@element({
+  tagName: "j-for-scope",
+  // prettier-ignore
+  shadowDom: [css`:host{display: contents;}`, html`<slot></slot>`],
+})
+export class JForScope<T = unknown> extends HTMLElement {
+  @bind()
+  accessor each: EachCtx<T> = {
+    value: null,
+    index: null,
+    position: null,
+  };
+
+  @attr()
+  accessor key = "";
+}
+
+@element({
+  tagName: "j-for",
+  // prettier-ignore
+  shadowDom: [css`:host{display:contents;}`, html`<slot></slot>`],
+})
+export class JositForElement extends HTMLElement {
+  @attr()
+  accessor bind = "";
+
+  @attr()
+  accessor key = "";
+
+  #template = query("template", this);
+  #items: Iterable<unknown> = [];
+  #scopes = new Map<unknown, JForScope>();
+
+  connectedCallback(): void {
+    const template = this.#template();
+
+    if (this.firstElementChild !== template) {
+      throw new Error("The first Node in j-for needs to be a template");
+    }
+
+    let currentScope: Element | null = this.firstElementChild;
+
+    while (currentScope instanceof JForScope) {
+      this.#scopes.set(currentScope.key, currentScope);
+      currentScope = currentScope.nextElementSibling;
+    }
+
+    const token = new JToken(this.bind);
+
+    this.dispatchEvent(
+      new JoistValueEvent(token, ({ newValue, oldValue }) => {
+        if (newValue !== oldValue) {
+          if (isIterable(newValue)) {
+            this.#items = newValue;
+          } else {
+            this.#items = [];
+          }
+
+          // If there are no existing items in the DOM (template is the only child),
+          // create all items from scratch
+          if (template.nextSibling === null) {
+            this.createFromEmpty();
+          } else {
+            // Otherwise update existing items, reusing DOM nodes where possible
+            this.updateItems();
+          }
+        }
+      }),
+    );
+  }
+
+  // Updates the DOM by either inserting new scopes or moving existing ones
+  // to their correct positions based on the current iteration order
+  createFromEmpty(): void {
+    const template = this.#template();
+    const fragment = document.createDocumentFragment();
+
+    let index = 0;
+
+    for (const value of this.#items) {
+      const key = hasProperty(value, this.key) ? value[this.key] : index;
+
+      const scope = new JForScope();
+      scope.append(document.importNode(template.content, true));
+      scope.key = String(key);
+      scope.each = { position: index + 1, index, value };
+
+      fragment.appendChild(scope);
+      this.#scopes.set(key, scope);
+
+      index++;
+    }
+
+    this.append(fragment);
+  }
+
+  // Updates the DOM by either inserting new scopes or moving existing ones
+  // to their correct positions based on the current iteration order
+  updateItems(): void {
+    const template = this.#template();
+    const leftoverScopes = new Map<unknown, JForScope>(this.#scopes);
+
+    let index = 0;
+
+    for (const value of this.#items) {
+      const key = hasProperty(value, this.key) ? value[this.key] : index;
+
+      let scope = leftoverScopes.get(key);
+
+      if (!scope) {
+        scope = new JForScope();
+        scope.append(document.importNode(template.content, true));
+        this.#scopes.set(key, scope);
+      } else {
+        leftoverScopes.delete(key); // Remove from map to track unused scopes
+      }
+
+      scope.key = String(key);
+      scope.each = { position: index + 1, index, value };
+
+      const child = this.children[index + 1]; // skip the first child since it's the template
+
+      index++;
+
+      // If scope is already in the correct position, no need to move it
+      // This optimization prevents unnecessary DOM operations
+      if (child === scope) {
+        continue;
+      }
+
+      // If there's a child element and either:
+      // 1. The scope isn't connected to the DOM yet, or
+      // 2. The child isn't the same as our scope
+      // Then insert the scope before the child
+      if (child && (!scope.isConnected || child !== scope)) {
+        child.before(scope);
+      } else {
+        // Otherwise append the scope to the end of this element
+        this.append(scope);
+      }
+    }
+
+    // Remove unused scopes
+    for (const scope of leftoverScopes.values()) {
+      scope.remove();
+    }
+  }
+
+  disconnectedCallback(): void {
+    for (const scope of this.#scopes.values()) {
+      scope.remove();
+    }
+
+    this.#scopes.clear();
+    this.#items = [];
+  }
+}
+
+function isIterable<T = unknown>(obj: any): obj is Iterable<T> {
+  return obj != null && typeof obj[Symbol.iterator] === "function";
+}
+function hasProperty(
+  item: unknown,
+  key: string,
+): item is Record<string, unknown> {
+  return Object.prototype.hasOwnProperty.call(item, key);
+}