@websimai/client-api-types 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Roman A
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @websimai/client-api-types
+
+Type declarations for `window.websim` object

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@websimai/client-api-types",
+  "version": "0.0.1",
+  "description": "Type declarations for `window.websim` object",
+  "author": "GameRoMan",
+  "license": "MIT",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts"
+    },
+    "./client": {
+      "types": "./src/client.d.ts"
+    }
+  },
+  "scripts": {
+    "publish": "bun publish --access public"
+  },
+  "keywords": [
+    "websim",
+    "client",
+    "api",
+    "types",
+    "typescript"
+  ],
+  "peerDependencies": {
+    "typescript": "^5.9.2"
+  }
+}

package/src/client.d.ts

@@ -0,0 +1,106 @@
+export type ChatCompletionsMessageContent =
+  | { type: "text"; text: string }
+  | { type: "image_url"; image_url: { url: string } };
+
+export type ChatCompletionsMessage = {
+  role: "assistant" | "user" | "system";
+  content: string | ChatCompletionsMessageContent[];
+};
+
+export type AnonymousWebsimUser = {
+  id: "1";
+  username: "anonymous";
+  avatar_url: null;
+};
+
+export type WebsimUser = {
+  id: string;
+  username: string;
+  avatar_url: `https://${string}/${string}` | null;
+};
+
+export type WebsimUserOrAnonymous = WebsimUser | AnonymousWebsimUser;
+
+export interface WebsimClientAPI {
+  getUser(): Promise<WebsimUserOrAnonymous>;
+  /** Alias for getUser */
+  getCurrentUser(): Promise<WebsimUserOrAnonymous>;
+  /** @deprecated Use getBootstrap instead */
+  getDistinctId(): Promise<string>;
+  getBootstrap(): Promise<{
+    distinct_id: string;
+    session_id: string;
+  }>;
+  getCreatedBy(): Promise<WebsimUser>;
+  getCreator(): Promise<WebsimUser>;
+  getCurrentProject(): Promise<{
+    id: string;
+    title: string;
+    description: string;
+  }>;
+  getColorScheme(): Promise<"light" | "dark">;
+
+  postComment({
+    content,
+    credits,
+  }: {
+    content: string;
+    credits: number;
+  }): Promise<{} | { error: "User has not interacted with the page" }>;
+
+  addEventListener(
+    eventType: "comment:created",
+    callback: (data: any) => void
+  ): () => void;
+
+  upload: (file: File) => Promise<string>;
+
+  chat: {
+    completions: {
+      create: ({
+        messages,
+        json,
+      }: {
+        messages: ChatCompletionsMessage[];
+        json?: boolean;
+      }) => Promise<{ role: "assistant"; content: string }>;
+    };
+  };
+
+  imageGen: (args: {
+    prompt: string;
+    aspect_ratio?: string;
+    width?: number;
+    height?: number;
+    seed?: number;
+    transparent?: boolean;
+  }) => Promise<{ url: string }>;
+
+  textToSpeech: (args: {
+    text: string;
+    voice?: string;
+    voice_sample?: string;
+  }) => Promise<{ url: string }>;
+
+  experimental: {
+    v0: {
+      login: () => Promise<void>;
+
+      /**
+       * Saves the given htmlContent to a new websim site.
+       * @param htmlContent html content to save
+       * @returns object with id of the saved site
+       */
+      save(htmlContent: string): Promise<{ id: string }>;
+
+      /**
+       * Returns the HTML for the given siteId. Defaults to the current websimsite.
+       * @param siteId
+       * @returns HTML for the given siteId.
+       */
+      getHTML(siteId?: string): Promise<string>;
+    };
+  };
+
+  internal_only_experimental: {};
+}

package/src/index.d.ts

@@ -0,0 +1,9 @@
+import type { WebsimClientAPI } from "./client";
+
+declare global {
+  interface Window {
+    readonly websim: WebsimClientAPI;
+  }
+
+  declare const websim: WebsimClientAPI;
+}

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "esnext",
+    "module": "preserve",
+    "moduleDetection": "force",
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+
+    // Max strictness
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "forceConsistentCasingInFileNames": true,
+    "verbatimModuleSyntax": true
+  }
+}