@websimai/client-api-types 0.0.5 → 0.0.7

package/dist/index.d.mts

@@ -4,89 +4,89 @@ import { WebsimComment } from "@websimai/shared-types";
 type ChatCompletionsMessageRole = "system" | "user" | "assistant" | "tool";
 type ChatCompletionsMessageContent = {
   /**
-   * The type of content part.
-   */
+  * The type of content part.
+  */
   type: "text";
   /**
-   * The text content.
-   */
+  * The text content.
+  */
   text: string;
 } | {
   /**
-   * The type of content part.
-   */
+  * The type of content part.
+  */
   type: "image_url";
   /**
-   * An object containing the base64 encoded image data URL.
-   */
+  * An object containing the base64 encoded image data URL.
+  */
   image_url: {
     /**
-     * A base64 encoded image data URL.
-     */
+    * A base64 encoded image data URL.
+    */
     url: string;
   };
 };
 /**
- * Represents a single message in the conversation history.
- */
+* Represents a single message in the conversation history.
+*/
 type ChatCompletionsMessage = {
   /**
-   * The role of the message sender.
-   */
+  * The role of the message sender.
+  */
   role: ChatCompletionsMessageRole;
   /**
-   * The message content.
-   * Can be plain text or an array for multimodal inputs.
-   */
+  * 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`.
-   */
+  * 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.
-   */
+  * 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`.
-   */
+  * 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`.
-   */
+  * 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.
-   */
+  * 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.
-   */
+  * 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.
-   */
+  * The maximum number of tokens to generate in the chat completion.
+  */
   max_tokens?: number;
 };
 type ChatCompletionResult = {
   /**
-   * The generated text content from the assistant.
-   */
+  * 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.
-   */
+  * The role of the message sender, which will always be "assistant" for the model's response.
+  */
   readonly role: "assistant";
 };
 declare namespace ChatCompletions {
@@ -106,51 +106,51 @@ declare class Chat {
 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.
-   */
+  * 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.
-   */
+  * 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`.
-   */
+  * 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`.
-   */
+  * 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`.
-   */
+  * 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.
-   */
+  * 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.
-   */
+  * 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.
-   */
+  * The URL of the generated image.
+  * This URL can be used to display the image.
+  */
   readonly url: `https://${string}/${string}`;
 };
 declare namespace ImageGen {
@@ -162,33 +162,33 @@ declare namespace ImageGen {
 //#region src/types/text-to-speech.d.ts
 type TextToSpeechOptions = {
   /**
-   * The text string to synthesize to speech.
-   */
+  * The text string to synthesize to speech.
+  */
   text: string;
   /**
-   * Voice identifier (e.g., "en-male") or ElevenLabs voice ID for a specific voice.
-   */
+  * Voice identifier (e.g., "en-male") or ElevenLabs voice ID for a specific voice.
+  */
   voice?: string;
   /**
-   * Desired audio format.
-   * Defaults to "mp3".
-   */
+  * Desired audio format.
+  * Defaults to "mp3".
+  */
   format?: "mp3" | "wav";
   /**
-   * Playback speed multiplier.
-   * Typical range 0.5 - 2.0.
-   */
+  * Playback speed multiplier.
+  * Typical range 0.5 - 2.0.
+  */
   speed?: number;
   /**
-   * Pitch adjustment in semitones.
-   * Typical range -12 to 12.
-   */
+  * Pitch adjustment in semitones.
+  * Typical range -12 to 12.
+  */
   pitch?: number;
 };
 type TextToSpeechResult = {
   /**
-   * A public URL pointing to the generated audio file.
-   */
+  * A public URL pointing to the generated audio file.
+  */
   readonly url: `https://${string}/${string}`;
 };
 //#endregion
@@ -253,19 +253,19 @@ interface WebsimClientAPI {
     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
-       */
+      * 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.
-       */
+      * 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>;
     };
   };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@websimai/client-api-types",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Type declarations for the `window.websim` object",
   "type": "module",
-  "author": "GameRoMan",
+  "author": "gameroman",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -22,24 +22,21 @@
   ],
   "scripts": {
     "build": "bunx --bun tsdown",
-    "npm:publish": "bun run build && bun publish"
+    "prepublishOnly": "bun run build"
   },
   "files": [
     "dist/**/*",
-    "README.md",
-    "LICENSE"
+    "README.md"
   ],
-  "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": "0.0.1"
+    "@websimai/shared-types": "0.0.5"
   },
   "devDependencies": {
-    "tsdown": "^0.18.2"
+    "tsdown": "^0.20.1"
   }
 }