@upstart.gg/sdk 0.0.135 → 0.0.137

package/src/shared/ai/types.ts

@@ -2,151 +2,153 @@
 import type { UIMessage } from "ai";
 import type { Theme } from "../theme";
 import type { Sitemap } from "../sitemap";
-import type { VersionedPage } from "../page";
+import type { Page, VersionedPage } from "../page";
 import type { PageAttributes, SiteAttributes } from "../attributes";
-import type { Brick, Section } from "../bricks";
-import type { AskUserChoiceInput, WaitingMessageSchema } from "./schemas";
-import type { Datarecord, InternalDatarecord } from "../datarecords/types";
+import type { Brick, Section, SectionSchemaNoBricks } from "../bricks";
+import type { AskUserChoiceInput, ToolInputWaitingMessageType, ToolInputInstructionsType } from "./schemas";
+import type { Datarecord } from "../datarecords/types";
 import type { InternalDatasource } from "../datasources/types";
 import type { ImageSearchResultsType } from "../images";
-import type { NavbarProps } from "../bricks/manifests/navbar.manifest";
-import type { FooterProps } from "../bricks/manifests/footer.manifest";
-// ... import your tool and data part types
+import type { Site } from "../site";
 
 export type Tools = {
+  setSitePrompt: {
+    input: { prompt: string };
+    output: string;
+  };
+  getBrickDocs: {
+    input: { type: string };
+    output: string; // The schema documentation in markdown format
+  };
   askUserChoice: {
     input: AskUserChoiceInput;
     output: string | string[] | null; // The user's choice(s
   };
+  editSiteAttributes: {
+    input: ToolInputWaitingMessageType & ToolInputInstructionsType;
+    output: SiteAttributes;
+  };
   generateImages: {
-    input: { prompt: string; count: number; aspectRatio: string };
+    input: ToolInputWaitingMessageType & { prompt: string; count: number; aspectRatio: string };
     output: ImageSearchResultsType;
   };
   listThemes: {
-    input: null; // Just type the waiting message for now
+    input: unknown;
     output: Theme[];
   };
   createSection: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
+    input: SectionSchemaNoBricks;
     output: Section;
   };
   editSection: {
-    input: { id: string } & WaitingMessageSchema; // Just type the waiting message for now
+    input: { id: string; data: Partial<SectionSchemaNoBricks> };
     output: Section;
   };
-  getSection: {
-    input: { id: string }; // Just type the waiting message for now
-    output: Section | string; // Error string if not found
+  deleteSection: {
+    input: { id: string };
+    output: { sections: Section[]; deleted: Section }; // Updated sections or error string if failed
   };
-  listSections: {
-    input: null; // Just type the waiting message for now
-    output: Section[];
+  getSection: {
+    input: { id: string };
+    output: Section; // Error string if not found
   };
   createThemes: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
+    input: ToolInputWaitingMessageType & ToolInputInstructionsType & { count: number };
     output: Theme[];
   };
   getCurrentTheme: {
-    input: null; // Just type the waiting message for now
+    input: unknown;
     output: Theme; // Theme or message if no theme applied yet
   };
-  createSitemap: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
-    output: Sitemap;
-  };
-  getSitemap: {
-    input: null; // Just type the waiting message for now
-    output: Sitemap;
-  };
+  // createSitemap: {
+  //   input: ToolInputWaitingMessageType & ToolInputInstructionsType;
+  //   output: Sitemap;
+  // };
   createPage: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
+    input: Pick<Page, "id" | "label"> &
+      Pick<PageAttributes, "path"> &
+      ToolInputWaitingMessageType &
+      ToolInputInstructionsType;
     output: VersionedPage;
   };
   editPage: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
+    input: ToolInputWaitingMessageType & ToolInputInstructionsType & Pick<Page, "id">;
     output: VersionedPage;
   };
+  undo: {
+    input: {
+      steps?: number;
+    };
+    output: boolean;
+  };
+  setSiteLabel: {
+    input: { label: string };
+    output: string;
+  };
   getCurrentPage: {
-    input: null; // Just type the waiting message for now
+    input: unknown;
     output: VersionedPage;
   };
-  createNavbar: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
-    output: NavbarProps;
-  };
-  createFooter: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
-    output: FooterProps;
+  analyzeUrl: {
+    input: {
+      url: string;
+      prompt: string;
+    };
+    output: string;
   };
   createBrick: {
-    input: WaitingMessageSchema & { sectionId: string; index: number }; // Just type the waiting message for now
+    input: {
+      instructions: string;
+      otherBrickTypes: string[];
+      sectionId: string;
+      id: string;
+      type: string;
+      insertAt: { type: "section"; index: number } | { type: "brick"; id: string; index: number };
+    };
     output: Brick;
   };
   editBrick: {
-    input: WaitingMessageSchema & { id: string }; // Just type the waiting message for now
+    input: { id: string; instructions: string; otherBrickTypes: string[] };
     output: Brick;
   };
   listImages: {
-    input: null; // Just type the waiting message for now
+    input: unknown;
     output: ImageSearchResultsType;
   };
-  listSiteQueries: {
-    input: null; // Just type the waiting message for now
-    output: NonNullable<SiteAttributes["queries"]>;
-  };
-  createSiteQueries: {
-    input: WaitingMessageSchema & { instructions: string }; // Just type the waiting message for now
-    output: NonNullable<SiteAttributes["queries"]>;
-  };
-  editSiteQueries: {
-    input: WaitingMessageSchema & { instructions: string }; // Just type the waiting message for now
-    output: NonNullable<SiteAttributes["queries"]>;
-  };
-  createPageQueries: {
-    input: WaitingMessageSchema & { instructions: string }; // Just type the waiting message for now
-    output: NonNullable<PageAttributes["queries"]>;
-  };
-  editPageQueries: {
-    input: WaitingMessageSchema & { instructions: string }; // Just type the waiting message for now
-    output: NonNullable<PageAttributes["queries"]>;
-  };
-  createSiteAttributes: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
-    output: SiteAttributes;
-  };
-  getSiteAttributes: {
-    input: null; // Just type the waiting message for now
-    output: SiteAttributes;
+  setTheme: {
+    input: { id: string };
+    output: Theme;
   };
   createDatasource: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
+    input: ToolInputWaitingMessageType & ToolInputInstructionsType & { id: string };
     output: InternalDatasource;
   };
   listDatasources: {
-    input: null; // Just type the waiting message for now
+    input: unknown;
     output: InternalDatasource[];
   };
   createDatarecord: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
+    input: ToolInputWaitingMessageType & ToolInputInstructionsType & { id: string };
     output: Datarecord;
   };
   listDatarecords: {
-    input: null; // Just type the waiting message for now
+    input: unknown;
     output: Datarecord[];
   };
   searchImages: {
-    input: WaitingMessageSchema & { query: string }; // Just type the waiting message for now
+    input: ToolInputWaitingMessageType & { query: string };
     output: ImageSearchResultsType;
   };
   deleteBrick: {
-    input: { id: string; waitingMessage: string }; // Just type the waiting message for now
-    output: boolean | string; // true if deleted, error message if failed
+    input: { id: string };
+    output: Brick;
   };
 };
 
 type Metadata = {
-  creditsUsed: number;
-  userLanguage: string; // ISO code of the user's language, e.g. "en", "fr", "es"
+  init?: boolean;
+  creditsUsed?: number;
+  userLanguage?: string; // ISO code of the user's language, e.g. "en", "fr", "es"
 };
 
 // For now, let's keep it simple

package/src/shared/attributes.ts

@@ -3,15 +3,14 @@ import type { JSONSchemaType } from "ajv";
 import { getSchemaDefaults } from "../shared/utils/schema";
 import { manifest as navbarManifest } from "./bricks/manifests/navbar.manifest";
 import { manifest as footerManifest } from "./bricks/manifests/footer.manifest";
-import { string } from "./bricks/props/string";
 import { boolean } from "./bricks/props/boolean";
 import { datetime } from "./bricks/props/date";
-import { imageRef } from "./bricks/props/image";
-import { colorPresetRef } from "./bricks/props/color-preset";
-import { queryUseRef, type QueryUseSettings } from "./bricks/props/dynamic";
+import { image } from "./bricks/props/image";
+import { colorPreset } from "./bricks/props/color-preset";
+import { queryUse, type QueryUseSettings } from "./bricks/props/dynamic";
 import { querySchema } from "./datasources/types";
 import { StringEnum } from "./utils/string-enum";
-import { backgroundRef } from "./bricks/props/background";
+import { background } from "./bricks/props/background";
 import { toLLMSchema } from "./utils/llm";
 
 export type { JSONSchemaType };
@@ -19,9 +18,9 @@ export type { JSONSchemaType };
 // Default attributes
 export const pageAttributesSchema = Type.Object(
   {
-    backgroundImage: Type.Optional(backgroundRef()),
+    backgroundImage: Type.Optional(background()),
     colorPreset: Type.Optional(
-      colorPresetRef({
+      colorPreset({
         examples: [
           { color: "base-100" },
           { color: "primary-500" },
@@ -29,16 +28,17 @@ export const pageAttributesSchema = Type.Object(
         ],
       }),
     ),
-    tags: Type.Optional(
-      Type.Array(string("Tag"), {
-        title: "Tags",
-        description:
-          "Use tags to organize, group and filter pages in navigation elements and in the dashboard. By default, the navbar element display pages having the 'navbar' tag, while the sidebar displays the pages with the tag 'sidebar'.",
-        "ui:field": "tags",
-        examples: [["navbar", "navbar"], ["navbar", "sidebar"], ["sidebar"]],
-      }),
-    ),
-    path: string("URL path", {
+    tags: Type.Array(Type.String({ description: "A tag for the page. Should be url-safe." }), {
+      title: "Tags",
+      description:
+        "Use tags to organize, group and filter pages in navigation elements and in the dashboard. By default, the navbar element display pages having the 'navbar' tag, while the sidebar displays the pages with the tag 'sidebar'.",
+      "ui:field": "tags",
+      examples: [["navbar", "important"], ["navbar", "sidebar"], ["sidebar"], ["campaign-landing-20250610"]],
+      maxItems: 8,
+      default: [],
+    }),
+    path: Type.String({
+      title: "URL path",
       default: "/",
       description: "The URL path of the page. Use placeholders like :id or :slug for dynamic paths.",
       "ai:instructions": "Never put language codes in the path.",
@@ -46,24 +46,25 @@ export const pageAttributesSchema = Type.Object(
       pattern: "^/[a-z0-9-:/]*$",
       examples: ["/", "/about", "/products/:id"],
     }),
-    queries: Type.Optional(
-      Type.Array(queryUseRef(), {
-        title: "Page Queries",
-        description:
-          "List of queries to use in this page. All listed queries will be executed when the page loads.",
-        "ai:instructions": "Reference Query IDs to use at the page level.",
-        "ui:field": "page-queries",
-        maxItems: 5,
-      }),
-    ),
-    title: string("Title", {
+    queries: Type.Array(queryUse(), {
+      title: "Page Queries",
+      description:
+        "List of queries to use in this page. All listed queries will be executed when the page loads.",
+      "ai:instructions": "Reference Query IDs to use at the page level.",
+      "ui:field": "page-queries",
+      maxItems: 8,
+      default: [],
+    }),
+    title: Type.String({
+      title: "Title",
       default: "Untitled",
       "ui:group": "meta",
       "ui:group:title": "Meta tags",
       description: "The title of the page. Appears in the browser tab and search results",
       "ui:placeholder": "Page title",
     }),
-    description: string("Description", {
+    description: Type.String({
+      title: "Description",
       "ui:widget": "textarea",
       "ui:group": "meta",
       "ui:group:title": "Meta tags",
@@ -73,7 +74,8 @@ export const pageAttributesSchema = Type.Object(
       default: "",
       "ui:placeholder": "A brief description of the page",
     }),
-    keywords: string("Keywords", {
+    keywords: Type.String({
+      title: "Keywords",
       "ui:group": "meta",
       "ui:group:title": "Meta tags",
       description: "Keywords related to the page. Used by search engines",
@@ -81,9 +83,8 @@ export const pageAttributesSchema = Type.Object(
       default: "",
       "ui:placeholder": "keyword1, keyword2, keyword3",
     }),
-
     ogImage: Type.Optional(
-      imageRef({
+      image({
         title: "Social share image",
         description: "Image shown when this page is shared on social media",
         "ui:group": "meta",
@@ -96,7 +97,9 @@ export const pageAttributesSchema = Type.Object(
       }),
     ),
     robotsIndexing: Type.Optional(
-      boolean("Allow search engines to index this page", true, {
+      Type.Boolean({
+        title: "Allow search engines to index this page",
+        default: true,
         description: "Disabling this will prevent search engines from indexing this page",
         "ai:hidden": true,
         "ui:group": "meta",
@@ -187,16 +190,21 @@ export const pageAttributesSchema = Type.Object(
             }),
           ),
         },
-        { "ui:group": "meta" },
+        { "ui:group": "meta", "ai:hidden": true },
       ),
     ),
-
-    noNavbar: Type.Optional(boolean("Hide navbar", false, { "ui:group": "layout" })),
-    noFooter: Type.Optional(boolean("Hide footer", false, { "ui:group": "layout" })),
-    lastUpdated: Type.Optional(
-      datetime("Last updated", {
-        "ui:hidden": true,
-        "ai:hidden": true,
+    noNavbar: Type.Optional(
+      Type.Boolean({
+        title: "Hide navbar",
+        default: false,
+        "ui:group": "layout",
+      }),
+    ),
+    noFooter: Type.Optional(
+      Type.Boolean({
+        title: "Hide footer",
+        default: false,
+        "ui:group": "layout",
       }),
     ),
   },
@@ -208,7 +216,7 @@ export const pageAttributesSchema = Type.Object(
   },
 );
 
-export const pageQueriesSchema = Type.Array(queryUseRef(), {
+export const pageQueriesSchema = Type.Array(queryUse(), {
   title: "Page Queries",
   description: `List of page queries in use in this page. All listed queries will be executed when the page loads. Aliases must be unique and camelCase'd.
 The queryId must reference an existing site query ID.`,
@@ -283,9 +291,9 @@ export const siteAttributesSchema = Type.Object(
           "Choose a value based on the site description. If the site is in multiple languages, use 'en'.",
       },
     ),
-    backgroundImage: Type.Optional(backgroundRef()),
+    backgroundImage: Type.Optional(background()),
     colorPreset: Type.Optional(
-      colorPresetRef({
+      colorPreset({
         examples: [
           { color: "base-100" },
           { color: "primary-500" },
@@ -319,7 +327,7 @@ export const siteAttributesSchema = Type.Object(
       }),
     ),
     ogImage: Type.Optional(
-      imageRef({
+      image({
         title: "Social share image",
         description: "Image shown when this site is shared on social media",
         "ai:hidden": true,
@@ -379,13 +387,15 @@ export const siteAttributesSchema = Type.Object(
   },
 );
 
-export const siteAttributesNowQueriesSchema = Type.Omit(siteAttributesSchema, ["queries"]);
+export const siteAttributesNoQueriesSchema = Type.Omit(siteAttributesSchema, ["queries"]);
 export const pageAttributesNoQueriesSchema = Type.Omit(pageAttributesSchema, ["queries"]);
 export const siteQueriesSchema = Type.Array(querySchema);
 export const siteQueriesSchemaLLM = toLLMSchema(siteQueriesSchema);
 
 export type PageAttributes = Static<typeof pageAttributesSchema>;
 export type SiteAttributes = Static<typeof siteAttributesSchema>;
+export type SiteAttributesNoQueries = Static<typeof siteAttributesNoQueriesSchema>;
+export type PageAttributesNoQueries = Static<typeof pageAttributesNoQueriesSchema>;
 
 export function resolvePageAttributes(data: Partial<PageAttributes> = {}) {
   const defaultAttrValues = getSchemaDefaults(pageAttributesSchema);

package/src/shared/brick-manifest.ts

@@ -1,11 +1,10 @@
-import type { TObject, TProperties, TArray } from "@sinclair/typebox";
-import type { IconBase, IconType } from "react-icons/lib";
+import type { TObject, TProperties } from "@sinclair/typebox";
+import type { IconType } from "react-icons/lib";
 import { getSchemaDefaults } from "./utils/schema";
-import type { ReactNode } from "react";
 
 export type BrickCategory = "layout" | "basic" | "media" | "widgets" | "container";
 
-type BrickManifestProps<BProps extends TProperties, DSSchema extends TObject | TArray<TObject>> = {
+type BrickManifestProps<BProps extends TProperties> = {
   type: string;
   category?: BrickCategory;
   name: string;
@@ -64,7 +63,7 @@ type BrickManifestProps<BProps extends TProperties, DSSchema extends TObject | T
   aiInstructions?: string;
 };
 
-export function defineBrickManifest<BProps extends TProperties, DSSchema extends TObject | TArray<TObject>>({
+export function defineBrickManifest<BProps extends TProperties>({
   props,
   defaultHeight,
   defaultWidth,
@@ -79,7 +78,7 @@ export function defineBrickManifest<BProps extends TProperties, DSSchema extends
   defaultInspectorTab = "preset",
   icon,
   ...rest
-}: BrickManifestProps<BProps, DSSchema>) {
+}: BrickManifestProps<BProps>) {
   return {
     ...rest,
     icon,

package/src/shared/bricks/manifests/_types.ts

@@ -0,0 +1,9 @@
+import type { BrickManifest } from "~/shared/brick-manifest";
+import type { BrickProps } from "../props/types";
+
+export type BrickExample<Manifest extends BrickManifest> = {
+  description: string;
+  type: string;
+  props: BrickProps<Manifest>["brick"]["props"];
+  mobileProps?: Partial<BrickProps<Manifest>["brick"]["props"]>;
+};