@upstart.gg/sdk/src/shared/bricks/props/dynamic.ts

You can test the CLI without recompiling by running:

import { type ObjectOptions, Type, type Static } from "@sinclair/typebox";
import { queryFilter } from "~/shared/datasources/types";

export function queryUse() {
  return Type.Object(
    {
      queryId: Type.String({
        description: "The Site Query ID to use.",
      }),
      alias: Type.String({
        title: "Alias",
        minLength: 1,
        maxLength: 100,
        pattern: "^[a-zA-Z0-9_]+$",
        description:
          "Alias for the query results, used in dynamic content. Use a simple keyword without spaces or special characters. Aliases are unique across the page.",
        "ai:instructions":
          "Use a simple keyword without spaces or special characters. Aliases are unique across the page. You can use the same query several times with different aliases in order to, for example, apply different parameters to the same query.",
      }),
      params: Type.Optional(
        Type.Array(queryFilter, {
          description:
            "Additional query parameters/filters to apply to the query. One can use placeholders in values like ':slug' to reference URL parameters.",
          title: "Query Parameters",
          examples: [
            { field: "$slug", op: "eq", value: ":slug" },
            { field: "category", op: "eq", value: ":category" },
          ],
        }),
      ),
    },
    {
      title: "Query",
      description:
        "When set, this brick will loop through the results of the query and render the content for each item.",
      // $id: "content:queryUse",
      "ui:field": "query",
      metadata: {
        category: "content",
      },
      examples: [
        { queryId: "get-latest-posts", alias: "latestPosts" },
        {
          queryId: "get-user-profile",
          alias: "userProfile",
          params: [{ field: "userId", op: "eq", value: ":slug" }],
        },
        {
          queryId: "get-posts-by-category",
          alias: "postsByCategory",
          params: [{ field: "category", op: "eq", value: ":slug" }],
        },
      ],
    },
  );
}

export type QueryUseSettings = Static<ReturnType<typeof queryUse>>;

export function loop(options: ObjectOptions = {}) {
  return Type.Object(
    {
      over: Type.String({
        title: "Over",
        description: "The query alias to loop over. If not set, the brick will be rendered only once.",
        "ai:instructions": "Specify the Query Alias to loop over the results.",
      }),
      overrideLimit: Type.Optional(
        Type.Number({
          minimum: 1,
          description:
            "Override the limit of items to loop through. If not set, it will use the default limit of the query. If set to 1, it will not loop and will render only the first item.",
        }),
      ),
    },
    {
      // $id: "content:loop",
      title: "Repeat over",
      description: "Repeat this brick for each item in the specified query results.",
      "ui:field": "loop",
      "ui:hidden-if": "no-page-queries",
      metadata: {
        category: "content",
      },
      examples: [
        {
          over: "latestBlogPosts",
          overrideLimit: 5,
        },
        {
          over: "featuredProducts",
          overrideLimit: 3,
        },
        {
          over: "popularProducts",
        },
      ],
      ...options,
    },
  );
}

export type LoopSettings = Static<ReturnType<typeof loop>>;