@websimai/client-api-types 0.0.2 → 0.0.4

package/README.md

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

package/dist/index.d.mts

@@ -0,0 +1,282 @@
+import { WebsimComment } from "@websimai/shared-types";
+
+//#region src/types/chat.d.ts
+type ChatCompletionsMessageRole = "system" | "user" | "assistant" | "tool";
+type ChatCompletionsMessageContent = {
+  /**
+   * The type of content part.
+   */
+  type: "text";
+  /**
+   * The text content.
+   */
+  text: string;
+} | {
+  /**
+   * The type of content part.
+   */
+  type: "image_url";
+  /**
+   * An object containing the base64 encoded image data URL.
+   */
+  image_url: {
+    /**
+     * A base64 encoded image data URL.
+     */
+    url: string;
+  };
+};
+/**
+ * Represents a single message in the conversation history.
+ */
+type ChatCompletionsMessage = {
+  /**
+   * The role of the message sender.
+   */
+  role: ChatCompletionsMessageRole;
+  /**
+   * The message content.
+   * Can be plain text or an array for multimodal inputs.
+   */
+  content: string | ChatCompletionsMessageContent[];
+};
+type ChatCompletionOptions = {
+  /**
+   * A list of messages comprising the conversation so far.
+   * Each message includes a `role` (system, user, assistant, tool) and `content`.
+   */
+  messages: ChatCompletionsMessage[];
+  /**
+   * ID of the model to use.
+   * If not specified, websim uses its default model.
+   */
+  model?: string;
+  /**
+   * If `true`, the model will attempt to generate a JSON object.
+   * The response content will be a string that you will need to parse.
+   * Defaults to `false`.
+   */
+  json?: boolean;
+  /**
+   * If `true`, the response will be streamed back incrementally.
+   * Defaults to `false`.
+   */
+  stream?: boolean;
+  /**
+   * What sampling temperature to use, between 0 and 2.
+   * Higher values (e.g., 0.8) make the output more random; lower values (e.g., 0.2) make it more focused.
+   * Defaults to 1.
+   */
+  temperature?: number;
+  /**
+   * An alternative to sampling with temperature, where the model considers tokens with top_p probability mass.
+   * E.g., 0.1 means only tokens comprising the top 10% probability mass are considered.
+   * Defaults to 1.
+   */
+  top_p?: number;
+  /**
+   * The maximum number of tokens to generate in the chat completion.
+   */
+  max_tokens?: number;
+};
+type ChatCompletionResult = {
+  /**
+   * The generated text content from the assistant.
+   */
+  readonly content: string;
+  /**
+   * The role of the message sender, which will always be "assistant" for the model's response.
+   */
+  readonly role: "assistant";
+};
+declare namespace ChatCompletions {
+  type MessageRole = ChatCompletionsMessageRole;
+  type ContentPart = ChatCompletionsMessageContent;
+  type Message = ChatCompletionsMessage;
+  type Options = ChatCompletionOptions;
+  type Result = ChatCompletionResult;
+}
+declare class Chat {
+  readonly completions: {
+    create(args: ChatCompletionOptions): Promise<ChatCompletionResult>;
+  };
+}
+//#endregion
+//#region src/types/image-gen.d.ts
+type ImageGenAspectRatio = "1:1" | "16:9" | "21:9" | "3:2" | "2:3" | "4:5" | "5:4" | "3:4" | "4:3" | "9:16" | "9:21";
+type ImageGenOptions = {
+  /**
+   * The primary text prompt describing the image to generate.
+   * This is a required parameter.
+   */
+  prompt: string;
+  /**
+   * Optional aspect ratio for the generated image.
+   * Defaults to "1:1".
+   * If `width` and `height` are provided, this parameter will be ignored.
+   */
+  aspect_ratio?: ImageGenAspectRatio;
+  /**
+   * Optional width of the generated image in pixels.
+   * If provided along with `height`, it overrides `aspect_ratio`.
+   */
+  width?: number;
+  /**
+   * Optional height of the generated image in pixels.
+   * If provided along with `width`, it overrides `aspect_ratio`.
+   */
+  height?: number;
+  /**
+   * Optional boolean.
+   * If `true`, the generated image will have a transparent background.
+   * Defaults to `false`.
+   */
+  transparent?: boolean;
+  /**
+   * Optional array of image inputs.
+   * Each object in the array should have a `url` property, which is a base64 encoded image data URL.
+   * Supports 1-4 input images for image-to-image generation.
+   */
+  image_inputs?: {
+    url: string;
+  }[];
+  /**
+   * Optional seed for the image generation process.
+   * Using the same prompt and seed will produce variations of the same output, useful for consistent results or exploring variations.
+   */
+  seed?: number;
+};
+type ImageGenResult = {
+  /**
+   * The URL of the generated image.
+   * This URL can be used to display the image.
+   */
+  readonly url: `https://${string}/${string}`;
+};
+declare namespace ImageGen {
+  type AspectRatio = ImageGenAspectRatio;
+  type Options = ImageGenOptions;
+  type Result = ImageGenResult;
+}
+//#endregion
+//#region src/types/text-to-speech.d.ts
+type TextToSpeechOptions = {
+  /**
+   * The text string to synthesize to speech.
+   */
+  text: string;
+  /**
+   * Voice identifier (e.g., "en-male") or ElevenLabs voice ID for a specific voice.
+   */
+  voice?: string;
+  /**
+   * Desired audio format.
+   * Defaults to "mp3".
+   */
+  format?: "mp3" | "wav";
+  /**
+   * Playback speed multiplier.
+   * Typical range 0.5 - 2.0.
+   */
+  speed?: number;
+  /**
+   * Pitch adjustment in semitones.
+   * Typical range -12 to 12.
+   */
+  pitch?: number;
+};
+type TextToSpeechResult = {
+  /**
+   * A public URL pointing to the generated audio file.
+   */
+  readonly url: `https://${string}/${string}`;
+};
+//#endregion
+//#region src/types/user.d.ts
+type AnonymousWebsimUser = {
+  readonly id: "1";
+  readonly username: "anonymous";
+  readonly avatar_url: null;
+};
+type WebsimUser = {
+  readonly id: string;
+  readonly username: string;
+  readonly avatar_url: `https://${string}/${string}` | null;
+};
+type WebsimUserOrAnonymous = WebsimUser | AnonymousWebsimUser;
+//#endregion
+//#region src/client-api.d.ts
+interface WebsimClientAPI {
+  getUser(): Promise<WebsimUserOrAnonymous>;
+  /** Alias for getUser */
+  getCurrentUser(): Promise<WebsimUserOrAnonymous>;
+  /** @deprecated Use getBootstrap instead */
+  getDistinctId(): Promise<string>;
+  getBootstrap(): Promise<{
+    readonly distinct_id: string;
+    readonly session_id: string;
+  }>;
+  getCreatedBy(): Promise<WebsimUser>;
+  /** Alias for getCreatedBy */
+  getCreator(): Promise<WebsimUser>;
+  getCurrentProject(): Promise<{
+    readonly id: string;
+    readonly title: string;
+    readonly description: string;
+  }>;
+  getColorScheme(): Promise<"light" | "dark">;
+  postComment(args: {
+    content: string;
+    credits?: number;
+    images?: string[];
+  }): Promise<{
+    readonly error?: "User has not interacted with the page";
+  }>;
+  renderVideo(args: {
+    composition: string;
+    inputProps?: Record<string, unknown>;
+    options?: unknown;
+    onProgress?: (progress: unknown) => void;
+  }): Promise<{
+    url: string;
+    renderId: string;
+  }>;
+  addEventListener(eventType: "comment:created", callback: (data: {
+    readonly comment: WebsimComment;
+    readonly cursor: string;
+  }) => void): () => void;
+  upload(file: File): Promise<string>;
+  readonly chat: Chat;
+  imageGen(args: ImageGenOptions): Promise<ImageGenResult>;
+  textToSpeech(args: TextToSpeechOptions): Promise<TextToSpeechResult>;
+  readonly experimental?: {
+    readonly 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>;
+    };
+  };
+}
+//#endregion
+//#region src/globals.d.ts
+declare global {
+  interface Window {
+    readonly websim: WebsimClientAPI;
+  }
+  const websim: WebsimClientAPI;
+}
+//#endregion
+export { AnonymousWebsimUser, Chat, ChatCompletionOptions, ChatCompletionResult, ChatCompletions, ChatCompletionsMessage, ChatCompletionsMessageContent, ChatCompletionsMessageRole, ImageGen, ImageGenAspectRatio, ImageGenOptions, ImageGenResult, TextToSpeechOptions, TextToSpeechResult, type WebsimClientAPI, WebsimUser, WebsimUserOrAnonymous };

package/dist/index.mjs

@@ -0,0 +1 @@
+export {  };

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@websimai/client-api-types",
-  "version": "0.0.2",
-  "description": "Type declarations for `window.websim` object",
+  "version": "0.0.4",
+  "description": "Type declarations for the `window.websim` object",
+  "type": "module",
   "author": "GameRoMan",
   "license": "MIT",
-  "types": "./src/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./src/index.d.ts"
-    }
+  "publishConfig": {
+    "access": "public"
   },
-  "scripts": {
-    "publish": "bun publish --access public"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/websimnpm/websim.git",
+    "directory": "packages/client-api-types"
   },
   "keywords": [
     "websim",
@@ -20,7 +20,26 @@
     "types",
     "typescript"
   ],
-  "peerDependencies": {
-    "typescript": "^5.9.2"
+  "scripts": {
+    "build": "bunx --bun tsdown",
+    "npm:publish": "bun run build && bun publish"
+  },
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@websimai/shared-types": "workspace:*"
+  },
+  "devDependencies": {
+    "tsdown": "catalog:"
   }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-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/src/client-api.d.ts

@@ -1,74 +0,0 @@
-import type { WebsimUser, WebsimUserOrAnonymous } from "./types";
-
-import type { ChatCompletionOptions, ChatCompletionResult } from "./types";
-
-import type { ImageGenOptions, ImageGenResult } from "./types";
-
-import type { TextToSpeechOptions, TextToSpeechResult } from "./types";
-
-export interface WebsimClientAPI {
-  getUser(): Promise<WebsimUserOrAnonymous>;
-  /** Alias for getUser */
-  getCurrentUser(): Promise<WebsimUserOrAnonymous>;
-  /** @deprecated Use getBootstrap instead */
-  getDistinctId(): Promise<string>;
-  getBootstrap(): Promise<{
-    readonly distinct_id: string;
-    readonly session_id: string;
-  }>;
-  getCreatedBy(): Promise<WebsimUser>;
-  /** Alias for getCreatedBy */
-  getCreator(): Promise<WebsimUser>;
-  getCurrentProject(): Promise<{
-    readonly id: string;
-    readonly title: string;
-    readonly description: string;
-  }>;
-  getColorScheme(): Promise<"light" | "dark">;
-
-  postComment(args: {
-    content: string;
-    credits?: number;
-    images?: string[];
-  }): Promise<{ readonly error?: "User has not interacted with the page" }>;
-
-  addEventListener(
-    eventType: "comment:created",
-    callback: (data: any) => void
-  ): () => void;
-
-  upload: (file: File) => Promise<string>;
-
-  readonly chat: {
-    readonly completions: {
-      create: (args: ChatCompletionOptions) => Promise<ChatCompletionResult>;
-    };
-  };
-
-  imageGen: (args: ImageGenOptions) => Promise<ImageGenResult>;
-
-  textToSpeech: (args: TextToSpeechOptions) => Promise<TextToSpeechResult>;
-
-  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/globals.d.ts

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

package/src/index.d.ts

@@ -1,4 +0,0 @@
-export type { WebsimClientAPI } from "./client-api";
-export type * from "./types";
-
-export type * from "./globals";

package/src/types/chat.d.ts

@@ -1,106 +0,0 @@
-export type ChatCompletionsMessageRole =
-  | "system"
-  | "user"
-  | "assistant"
-  | "tool";
-
-export type ChatCompletionsMessageContent =
-  | {
-      /**
-       * The type of content part.
-       */
-      type: "text";
-      /**
-       * The text content.
-       */
-      text: string;
-    }
-  | {
-      /**
-       * The type of content part.
-       */
-      type: "image_url";
-      /**
-       * An object containing the base64 encoded image data URL.
-       */
-      image_url: {
-        /**
-         * A base64 encoded image data URL.
-         */
-        url: string;
-      };
-    };
-
-/**
- * Represents a single message in the conversation history.
- */
-export type ChatCompletionsMessage = {
-  /**
-   * The role of the message sender.
-   */
-  role: ChatCompletionsMessageRole;
-  /**
-   * The message content.
-   * Can be plain text or an array for multimodal inputs.
-   */
-  content: string | ChatCompletionsMessageContent[];
-};
-
-export type ChatCompletionOptions = {
-  /**
-   * A list of messages comprising the conversation so far.
-   * Each message includes a `role` (system, user, assistant, tool) and `content`.
-   */
-  messages: ChatCompletionsMessage[];
-  /**
-   * ID of the model to use.
-   * If not specified, websim uses its default model.
-   */
-  model?: string;
-  /**
-   * If `true`, the model will attempt to generate a JSON object.
-   * The response content will be a string that you will need to parse.
-   * Defaults to `false`.
-   */
-  json?: boolean;
-  /**
-   * If `true`, the response will be streamed back incrementally.
-   * Defaults to `false`.
-   */
-  stream?: boolean;
-  /**
-   * What sampling temperature to use, between 0 and 2.
-   * Higher values (e.g., 0.8) make the output more random; lower values (e.g., 0.2) make it more focused.
-   * Defaults to 1.
-   */
-  temperature?: number;
-  /**
-   * An alternative to sampling with temperature, where the model considers tokens with top_p probability mass.
-   * E.g., 0.1 means only tokens comprising the top 10% probability mass are considered.
-   * Defaults to 1.
-   */
-  top_p?: number;
-  /**
-   * The maximum number of tokens to generate in the chat completion.
-   */
-  max_tokens?: number;
-};
-
-export type ChatCompletionResult = {
-  /**
-   * The generated text content from the assistant.
-   */
-  readonly content: string;
-  /**
-   * The role of the message sender, which will always be "assistant" for the model's response.
-   */
-  readonly role: "assistant";
-};
-
-export namespace ChatCompletions {
-  export type MessageRole = ChatCompletionsMessageRole;
-  export type ContentPart = ChatCompletionsMessageContent;
-  export type Message = ChatCompletionsMessage;
-  export type Options = ChatCompletionOptions;
-  export type Result = ChatCompletionResult;
-}

package/src/types/image-gen.d.ts

@@ -1,67 +0,0 @@
-export type ImageGenAspectRatio =
-  | "1:1"
-  | "16:9"
-  | "21:9"
-  | "3:2"
-  | "2:3"
-  | "4:5"
-  | "5:4"
-  | "3:4"
-  | "4:3"
-  | "9:16"
-  | "9:21";
-
-export type ImageGenOptions = {
-  /**
-   * The primary text prompt describing the image to generate.
-   * This is a required parameter.
-   */
-  prompt: string;
-  /**
-   * Optional aspect ratio for the generated image.
-   * Defaults to "1:1".
-   * If `width` and `height` are provided, this parameter will be ignored.
-   */
-  aspect_ratio?: ImageGenAspectRatio;
-  /**
-   * Optional width of the generated image in pixels.
-   * If provided along with `height`, it overrides `aspect_ratio`.
-   */
-  width?: number;
-  /**
-   * Optional height of the generated image in pixels.
-   * If provided along with `width`, it overrides `aspect_ratio`.
-   */
-  height?: number;
-  /**
-   * Optional boolean.
-   * If `true`, the generated image will have a transparent background.
-   * Defaults to `false`.
-   */
-  transparent?: boolean;
-  /**
-   * Optional array of image inputs.
-   * Each object in the array should have a `url` property, which is a base64 encoded image data URL.
-   * Supports 1-4 input images for image-to-image generation.
-   */
-  image_inputs?: { url: string }[];
-  /**
-   * Optional seed for the image generation process.
-   * Using the same prompt and seed will produce variations of the same output, useful for consistent results or exploring variations.
-   */
-  seed?: number;
-};
-
-export type ImageGenResult = {
-  /**
-   * The URL of the generated image.
-   * This URL can be used to display the image.
-   */
-  readonly url: `https://${string}/${string}`;
-};
-
-export namespace ImageGen {
-  export type AspectRatio = ImageGenAspectRatio;
-  export type Options = ImageGenOptions;
-  export type Result = ImageGenResult;
-}

package/src/types/index.d.ts

@@ -1,4 +0,0 @@
-export type * from "./chat";
-export type * from "./image-gen";
-export type * from "./user";
-export type * from "./text-to-speech";

package/src/types/text-to-speech.d.ts

@@ -1,32 +0,0 @@
-export type TextToSpeechOptions = {
-  /**
-   * The text string to synthesize to speech.
-   */
-  text: string;
-  /**
-   * Voice identifier (e.g., "en-male") or ElevenLabs voice ID for a specific voice.
-   */
-  voice?: string;
-  /**
-   * Desired audio format.
-   * Defaults to "mp3".
-   */
-  format?: "mp3" | "wav";
-  /**
-   * Playback speed multiplier.
-   * Typical range 0.5 - 2.0.
-   */
-  speed?: number;
-  /**
-   * Pitch adjustment in semitones.
-   * Typical range -12 to 12.
-   */
-  pitch?: number;
-};
-
-export type TextToSpeechResult = {
-  /**
-   * A public URL pointing to the generated audio file.
-   */
-  readonly url: `https://${string}/${string}`;
-};

package/src/types/user.d.ts

@@ -1,13 +0,0 @@
-export type AnonymousWebsimUser = {
-  readonly id: "1";
-  readonly username: "anonymous";
-  readonly avatar_url: null;
-};
-
-export type WebsimUser = {
-  readonly id: string;
-  readonly username: string;
-  readonly avatar_url: `https://${string}/${string}` | null;
-};
-
-export type WebsimUserOrAnonymous = WebsimUser | AnonymousWebsimUser;

package/tsconfig.json

@@ -1,28 +0,0 @@
-{
-  "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
-  }
-}