@websimai/core-api-types 0.0.0 → 0.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websimai/core-api-types",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Core Websim API type declarations",
   "author": "GameRoMan",
   "license": "MIT",

package/src/types/index.ts

@@ -0,0 +1,6 @@
+export * from "./project-asset";
+export * from "./project-revision";
+export * from "./project";
+export * from "./screenshot";
+export * from "./site";
+export * from "./user";

package/src/types/project-asset.ts

@@ -0,0 +1,42 @@
+import type { Expand } from "../utils";
+
+import type { User } from "./user";
+
+type ProjectAssetMetaByContentType =
+  | {
+      meta: { version: "1"; in_generation: true };
+      content_type: "text/javascript" | "text/css" | "text/html";
+    }
+  | {
+      meta: {
+        version: "1";
+        description: string;
+        title: string;
+        transparent?: boolean;
+        aspect?: "square";
+        in_generation?: false;
+        in_generation_asset?: true;
+      };
+      content_type: "image/png";
+    }
+  | {
+      meta: { version: "1"; duration: number };
+      content_type: "audio/mpeg";
+    };
+
+export type ProjectAsset = Expand<
+  {
+    _type: "project_asset";
+    id: string;
+    project_id: string;
+    path: string;
+    state: "done";
+    created_at: string;
+    created_by: User;
+    updated_at: string;
+    bucket_key: string;
+    project_version: number;
+    size: number;
+    is_liked: boolean;
+  } & ProjectAssetMetaByContentType
+>;

package/src/types/project-revision.ts

@@ -0,0 +1,23 @@
+import type { User } from "./user";
+
+export type ProjectRevision = {
+  _type: "project_revision";
+  id: string;
+  version: number;
+  created_at: string;
+  visited_at: null;
+  parent_id: string | null;
+  parent_revision_version: number | null;
+  parent_revision_project_id: string | null;
+  created_by: User;
+  meta: { version: string };
+  project_id: string;
+  updated_at: string;
+  deleted_at: null;
+  stats: { multiplayer_count: number };
+  draft: boolean;
+  site_id: string;
+  chat_session_id: null;
+  chat_session_run_index: null;
+  current_screenshot_url: `https://${string}/${string}` | null;
+};

package/src/types/project.ts

@@ -0,0 +1,30 @@
+import type { User } from "./user";
+
+export type Project = {
+  _type: "project";
+  id: string;
+  created_at: string;
+  updated_at: string;
+  title: string | null;
+  visibility: "public";
+  slug: string | null;
+  created_by: User | null;
+  current_version: number | null;
+  last_posted_version: number | null;
+  parent_id: string | null;
+  parent_version: number | null;
+  deleted_at: null;
+  posted: boolean;
+  stats: { views: number; likes: number; comments: number };
+  auto_set_current: boolean;
+  description: string | null;
+  comments_mode: "open" | "closed";
+  enable_chat: boolean;
+  from_template: boolean | null;
+  domains: [{ name: string }] | { name: string }[];
+  thumbnail: {
+    moderation_state: "ok" | "bad";
+    url: `https://${string}/${string}` | null;
+  } | null;
+  video: { url: `https://${string}/${string}` } | null;
+};

package/src/types/screenshot.ts

@@ -0,0 +1,14 @@
+export type Screenshot = {
+  _type: "screenshot";
+  id: string;
+  project_id: string;
+  project_version: number;
+  created_at: string;
+  state: "done";
+  height: number;
+  width: number;
+  content_type: "image/webp";
+  moderation_state: "ok";
+  source: "user" | "server";
+  url: `https://${string}/${string}`;
+};

package/src/types/site.ts

@@ -0,0 +1,48 @@
+import type { User } from "./user";
+
+export type WebsimPromptType =
+  | { type: "plaintext"; text: string }
+  | { type: "manual-edit"; text: "" }
+  | { type: "refactor"; text: string }
+  | { type: "fix"; text: string }
+  | { type: "get"; text: string }
+  | { type: "tweak-edit"; text: ""; data: null };
+
+export type SiteLoreAttachment = {
+  id: string;
+  mediaType: string;
+  filename: string;
+  description: string;
+  useVision: boolean;
+};
+
+export type SiteLore = {
+  version: 1;
+  attachments: SiteLoreAttachment[];
+  enableApi?: boolean;
+  enableMobilePrompt?: boolean;
+  enableDB?: boolean;
+  enableMultiplayer_v2?: boolean;
+  enableDB_v2_1?: boolean;
+  enableLLM2?: boolean;
+  enableTweaks?: boolean;
+  enableComments?: boolean;
+};
+
+export type Site = {
+  _type: "site";
+  id: string;
+  parent_id: string | null;
+  created_at: string;
+  state: "initial" | "generating" | "done" | "failed";
+  model: string;
+  lore: SiteLore | null;
+  title: string | null;
+  url: string | null;
+  prompt: WebsimPromptType;
+  owner: User;
+  link_url: `/p/${string}`;
+  versioned_link_url: `/p/${string}/${number}`;
+  deleted_at: string | null;
+  yapping: string | null;
+};

package/src/types/user.ts

@@ -0,0 +1,10 @@
+export type User = {
+  _type: "user";
+  id: string;
+  created_at: string;
+  username: string;
+  discord_id: string | null;
+  discord_username: string | null;
+  avatar_url: `https://${string}/${string}` | null;
+  is_admin: boolean;
+};