@upstart.gg/sdk 0.0.135 → 0.0.136

package/src/shared/ai/schemas.ts

@@ -1,4 +1,5 @@
 import { type Static, Type } from "@sinclair/typebox";
+import { StringEnum } from "../utils/string-enum";
 
 export const waitingMessageSchema = Type.Object({
   waitingMessage: Type.String({
@@ -7,18 +8,21 @@ export const waitingMessageSchema = Type.Object({
   }),
 });
 
-export type WaitingMessageSchema = Static<typeof waitingMessageSchema>;
+export type ToolInputWaitingMessageType = { waitingMessage: string };
+export type ToolInputInstructionsType = { instructions: string };
 
 export const askUserChoiceInput = Type.Object({
-  question: Type.String({
-    description:
-      "The question to ask the user, in the user language. Example: 'Do you want a blog page?' or 'Do you want me to generate some images?'",
-  }),
-  choices: Type.Array(Type.String(), {
-    description: "The list of choices to present to the user. Can be a maximum of 6 choices.",
-    maxItems: 6,
-    minItems: 2,
-  }),
+  choices: Type.Array(
+    Type.String({
+      minLength: 2,
+      maxLength: 60,
+    }),
+    {
+      description: "The list of choices to present to the user. Minimum 2 choices, max 6.",
+      maxItems: 6,
+      minItems: 2,
+    },
+  ),
   allowMultiple: Type.Optional(
     Type.Boolean({
       description: "Whether to allow multiple choices to be selected by the user. Default to false.",
@@ -27,3 +31,35 @@ export const askUserChoiceInput = Type.Object({
 });
 
 export type AskUserChoiceInput = Static<typeof askUserChoiceInput>;
+
+export const getDocInput = Type.Object(
+  {
+    entityType: StringEnum(
+      [
+        "site-attributes",
+        "page-attributes",
+        "datasource",
+        "datarecord",
+        "site-query",
+        "page-query",
+        "section",
+        "brick-type",
+      ],
+      {
+        description: "The type of entity to get the schema documentation for.",
+      },
+    ),
+    // Only used when entityType is brick-type
+    brickType: Type.Optional(
+      Type.String({
+        description:
+          "The brick type to get the schema documentation for. Required if entityType is 'brick-type'.",
+      }),
+    ),
+  },
+  {
+    additionalProperties: false,
+  },
+);
+
+export type GetDocInput = Static<typeof getDocInput>;

package/src/shared/ai/types.ts

@@ -1,146 +1,214 @@
 // Define your custom message type once
 import type { UIMessage } from "ai";
 import type { Theme } from "../theme";
-import type { Sitemap } from "../sitemap";
-import type { VersionedPage } from "../page";
-import type { PageAttributes, SiteAttributes } from "../attributes";
-import type { Brick, Section } from "../bricks";
-import type { AskUserChoiceInput, WaitingMessageSchema } from "./schemas";
+import type { Sitemap, SitemapWithPlans } from "../sitemap";
+import type { Page, VersionedPage } from "../page";
+import type {
+  PageAttributes,
+  PageAttributesNoQueries,
+  SiteAttributes,
+  SiteAttributesNoQueries,
+} from "../attributes";
+import type { Brick, Section, SectionSchemaNoBricks } from "../bricks";
+import type {
+  AskUserChoiceInput,
+  ToolInputWaitingMessageType,
+  ToolInputInstructionsType,
+  GetDocInput,
+} from "./schemas";
 import type { Datarecord, InternalDatarecord } 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 type { Site } from "../site";
 // ... import your tool and data part types
 
 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
   };
+  setSiteAttributes: {
+    input: SiteAttributesNoQueries;
+    output: SiteAttributesNoQueries;
+  };
+  setPageAttributes: {
+    input: PageAttributesNoQueries;
+    output: PageAttributesNoQueries;
+  };
   generateImages: {
-    input: { prompt: string; count: number; aspectRatio: string };
+    input: ToolInputWaitingMessageType & { prompt: string; count: number; aspectRatio: string };
     output: ImageSearchResultsType;
   };
+  getCurrentSite: {
+    input: unknown;
+    output: Site;
+  };
   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;
   };
+  deleteSection: {
+    input: { id: string };
+    output: { sections: Section[]; deleted: Section }; // Updated sections or error string if failed
+  };
   getSection: {
-    input: { id: string }; // Just type the waiting message for now
-    output: Section | string; // Error string if not found
+    input: { id: string };
+    output: Section; // Error string if not found
   };
   listSections: {
-    input: null; // Just type the waiting message for now
+    input: unknown;
     output: Section[];
   };
   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;
+    input: ToolInputWaitingMessageType & ToolInputInstructionsType;
+    output: SitemapWithPlans;
   };
   createPage: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
+    input: Omit<Page, "sections">;
     output: VersionedPage;
   };
-  editPage: {
-    input: WaitingMessageSchema; // Just type the waiting message for now
-    output: VersionedPage;
+  undo: {
+    input: {
+      steps?: number;
+    };
+    output: boolean;
+  };
+  setSiteLabel: {
+    input: { label: string };
+    output: string;
+  };
+  // editPage: {
+  //   input: ToolInputWaitingMessageType;
+  //   output: VersionedPage;
+  // };
+  listPages: {
+    input: unknown;
+    output: Sitemap;
   };
   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
+    input: unknown;
     output: NonNullable<SiteAttributes["queries"]>;
   };
+  listPageQueries: {
+    input: unknown;
+    output: NonNullable<PageAttributes["queries"]>;
+  };
   createSiteQueries: {
-    input: WaitingMessageSchema & { instructions: string }; // Just type the waiting message for now
+    input: ToolInputWaitingMessageType & { instructions: string };
     output: NonNullable<SiteAttributes["queries"]>;
   };
-  editSiteQueries: {
-    input: WaitingMessageSchema & { instructions: string }; // Just type the waiting message for now
-    output: NonNullable<SiteAttributes["queries"]>;
+  setTheme: {
+    input: { id: string };
+    output: Theme;
   };
+  // editSiteQueries: {
+  //   input: ToolInputWaitingMessageType & { instructions: string };
+  //   output: NonNullable<SiteAttributes["queries"]>;
+  // };
   createPageQueries: {
-    input: WaitingMessageSchema & { instructions: string }; // Just type the waiting message for now
+    input: ToolInputWaitingMessageType & { instructions: string };
     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;
-  };
+  // editPageQueries: {
+  //   input: ToolInputWaitingMessageType & { instructions: string };
+  //   output: NonNullable<PageAttributes["queries"]>;
+  // };
+  // createSiteAttributes: {
+  //   input: ToolInputWaitingMessageType;
+  //   output: SiteAttributes;
+  // };
+  // getSiteAttributes: {
+  //   input: unknown;
+  //   output: SiteAttributes;
+  // };
+
   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;
+  };
+  deleteSiteQuery: {
+    input: { id: string };
+    output: NonNullable<SiteAttributes["queries"]>; // Updated queries or error message if failed
+  };
+  deletePageQuery: {
+    input: { alias: string };
+    output: NonNullable<PageAttributes["queries"]>; // Updated queries or error message if failed
   };
 };
 

package/src/shared/attributes.ts

@@ -30,12 +30,18 @@ export const pageAttributesSchema = Type.Object(
       }),
     ),
     tags: Type.Optional(
-      Type.Array(string("Tag"), {
+      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", "navbar"], ["navbar", "sidebar"], ["sidebar"]],
+        examples: [
+          ["navbar", "important"],
+          ["navbar", "sidebar"],
+          ["sidebar"],
+          ["campaign-landing-20250610"],
+        ],
+        maxItems: 8,
       }),
     ),
     path: string("URL path", {
@@ -379,13 +385,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/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"]>;
+};