tryiton 1.0.0 → 1.1.1

package/README.md

@@ -60,8 +60,10 @@ Additional options (`mode` and `moderationLevel` for clothing; `numSamples` 1–
 // Hairstyle try-on (see the HAIRCUTS export for all supported values)
 await client.tryOnHairstyle({ faceImage, haircut: "BuzzCut", hairColor: "ash blonde" });
 
-// Tattoo try-on
+// Tattoo try-on — place it with free text...
 await client.tryOnTattoo({ bodyImage, designImage, placement: "on the right forearm, small" });
+// ...or pin the exact spot with a region box (normalized 0–1, from the image's top-left)
+await client.tryOnTattoo({ bodyImage, designImage, region: { x: 0.32, y: 0.18, w: 0.28, h: 0.34 } });
 
 // Poll a job manually, or check your credit balance
 const status = await client.getStatus(jobId);   // { status, output, error }

package/dist/index.cjs

@@ -134,6 +134,7 @@ var TryItOn = class {
       body_image: params.bodyImage,
       design_image: params.designImage,
       placement: params.placement,
+      region: params.region,
       num_samples: params.numSamples,
       output_format: params.outputFormat
     };

package/dist/index.d.cts

@@ -68,6 +68,20 @@ interface TryOnHairstyleParams {
     /** Output image format, "png" or "jpeg". Defaults to "png". */
     outputFormat?: OutputFormat;
 }
+/**
+ * Rectangle on the body image, normalized 0–1 from its TOP-LEFT corner.
+ * Each side must be at least 0.06 of the image.
+ */
+interface TattooRegion {
+    /** Left edge, 0–1. */
+    x: number;
+    /** Top edge, 0–1. */
+    y: number;
+    /** Width, 0–1. */
+    w: number;
+    /** Height, 0–1. */
+    h: number;
+}
 interface TryOnTattooParams {
     /** URL or base64 data URL — a close-up of bare skin. */
     bodyImage: string;
@@ -75,6 +89,12 @@ interface TryOnTattooParams {
     designImage: string;
     /** Optional free-text placement/size, max 140 chars. */
     placement?: string;
+    /**
+     * Optional exact spot for the ink, as a rectangle on the body image. Pins WHERE
+     * the tattoo goes, so `placement` then only describes size/style. Omit it and the
+     * placement text alone decides.
+     */
+    region?: TattooRegion;
     /** Number of output images, 1–4. Charged per image. */
     numSamples?: number;
     /** Output image format, "png" or "jpeg". Defaults to "png". */
@@ -128,4 +148,4 @@ declare class TryItOn {
     private request;
 }
 
-export { type Category, type Credits, type FetchLike, HAIRCUTS, type JobError, type JobStatus, type Mode, type ModerationLevel, type OutputFormat, type StatusResponse, TryItOn, TryItOnError, type TryItOnOptions, type TryOnClothesParams, type TryOnHairstyleParams, type TryOnTattooParams, type WaitOptions, TryItOn as default };
+export { type Category, type Credits, type FetchLike, HAIRCUTS, type JobError, type JobStatus, type Mode, type ModerationLevel, type OutputFormat, type StatusResponse, type TattooRegion, TryItOn, TryItOnError, type TryItOnOptions, type TryOnClothesParams, type TryOnHairstyleParams, type TryOnTattooParams, type WaitOptions, TryItOn as default };

package/dist/index.d.ts

@@ -68,6 +68,20 @@ interface TryOnHairstyleParams {
     /** Output image format, "png" or "jpeg". Defaults to "png". */
     outputFormat?: OutputFormat;
 }
+/**
+ * Rectangle on the body image, normalized 0–1 from its TOP-LEFT corner.
+ * Each side must be at least 0.06 of the image.
+ */
+interface TattooRegion {
+    /** Left edge, 0–1. */
+    x: number;
+    /** Top edge, 0–1. */
+    y: number;
+    /** Width, 0–1. */
+    w: number;
+    /** Height, 0–1. */
+    h: number;
+}
 interface TryOnTattooParams {
     /** URL or base64 data URL — a close-up of bare skin. */
     bodyImage: string;
@@ -75,6 +89,12 @@ interface TryOnTattooParams {
     designImage: string;
     /** Optional free-text placement/size, max 140 chars. */
     placement?: string;
+    /**
+     * Optional exact spot for the ink, as a rectangle on the body image. Pins WHERE
+     * the tattoo goes, so `placement` then only describes size/style. Omit it and the
+     * placement text alone decides.
+     */
+    region?: TattooRegion;
     /** Number of output images, 1–4. Charged per image. */
     numSamples?: number;
     /** Output image format, "png" or "jpeg". Defaults to "png". */
@@ -128,4 +148,4 @@ declare class TryItOn {
     private request;
 }
 
-export { type Category, type Credits, type FetchLike, HAIRCUTS, type JobError, type JobStatus, type Mode, type ModerationLevel, type OutputFormat, type StatusResponse, TryItOn, TryItOnError, type TryItOnOptions, type TryOnClothesParams, type TryOnHairstyleParams, type TryOnTattooParams, type WaitOptions, TryItOn as default };
+export { type Category, type Credits, type FetchLike, HAIRCUTS, type JobError, type JobStatus, type Mode, type ModerationLevel, type OutputFormat, type StatusResponse, type TattooRegion, TryItOn, TryItOnError, type TryItOnOptions, type TryOnClothesParams, type TryOnHairstyleParams, type TryOnTattooParams, type WaitOptions, TryItOn as default };

package/dist/index.js

@@ -107,6 +107,7 @@ var TryItOn = class {
       body_image: params.bodyImage,
       design_image: params.designImage,
       placement: params.placement,
+      region: params.region,
       num_samples: params.numSamples,
       output_format: params.outputFormat
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tryiton",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Official JavaScript/TypeScript SDK for the TryItOn virtual try-on API.",
   "keywords": [
     "tryiton",

package/src/index.ts

@@ -91,6 +91,21 @@ export interface TryOnHairstyleParams {
   outputFormat?: OutputFormat;
 }
 
+/**
+ * Rectangle on the body image, normalized 0–1 from its TOP-LEFT corner.
+ * Each side must be at least 0.06 of the image.
+ */
+export interface TattooRegion {
+  /** Left edge, 0–1. */
+  x: number;
+  /** Top edge, 0–1. */
+  y: number;
+  /** Width, 0–1. */
+  w: number;
+  /** Height, 0–1. */
+  h: number;
+}
+
 export interface TryOnTattooParams {
   /** URL or base64 data URL — a close-up of bare skin. */
   bodyImage: string;
@@ -98,6 +113,12 @@ export interface TryOnTattooParams {
   designImage: string;
   /** Optional free-text placement/size, max 140 chars. */
   placement?: string;
+  /**
+   * Optional exact spot for the ink, as a rectangle on the body image. Pins WHERE
+   * the tattoo goes, so `placement` then only describes size/style. Omit it and the
+   * placement text alone decides.
+   */
+  region?: TattooRegion;
   /** Number of output images, 1–4. Charged per image. */
   numSamples?: number;
   /** Output image format, "png" or "jpeg". Defaults to "png". */
@@ -213,6 +234,7 @@ export class TryItOn {
       body_image: params.bodyImage,
       design_image: params.designImage,
       placement: params.placement,
+      region: params.region,
       num_samples: params.numSamples,
       output_format: params.outputFormat,
     };