@slopmachine/core 0.1.15 → 0.1.16

package/dist/index.d.mts

@@ -42,7 +42,21 @@ interface SlopImageOptions {
     baseUrl?: string;
 }
 declare function interpolatePrompt(prompt?: string, variables?: Record<string, string | number | undefined | null>): string;
+/**
+ * Builds a URL to render or retrieve an image from Slop Machine.
+ *
+ * @param options - Configuration options for the image generation.
+ * @returns A string containing the fully constructed URL.
+ */
 declare function buildImageUrl(options: SlopImageOptions): string;
+/**
+ * Preloads an image from Slop Machine into the browser's cache.
+ * Useful for ensuring images are ready before displaying them.
+ *
+ * @param options - Configuration options for the image generation.
+ * @returns A promise that resolves when the image has been loaded.
+ */
+declare function preloadImage(options: SlopImageOptions): Promise<void>;
 type VideoAspectRatio = "9:16" | "16:9";
 interface SlopVideoOptions {
     /**
@@ -91,7 +105,21 @@ interface SlopVideoOptions {
      */
     baseUrl?: string;
 }
+/**
+ * Builds a URL to render or retrieve a video from Slop Machine.
+ *
+ * @param options - Configuration options for the video generation.
+ * @returns A string containing the fully constructed URL.
+ */
 declare function buildVideoUrl(options: SlopVideoOptions): string;
+/**
+ * Preloads a video from Slop Machine into the browser's cache.
+ * Useful for ensuring videos are ready before displaying them.
+ *
+ * @param options - Configuration options for the video generation.
+ * @returns A promise that resolves when the video preload request has been initiated.
+ */
+declare function preloadVideo(options: SlopVideoOptions): Promise<void>;
 interface SlopTextOptions {
     /**
      * The unique identifier of your Slop Machine bucket.
@@ -123,6 +151,20 @@ interface SlopTextOptions {
      */
     baseUrl?: string;
 }
+/**
+ * Builds a URL to render or retrieve text from Slop Machine.
+ *
+ * @param options - Configuration options for the text generation.
+ * @returns A string containing the fully constructed URL.
+ */
 declare function buildTextUrl(options: SlopTextOptions): string;
+/**
+ * Preloads text from Slop Machine into the browser's cache.
+ * Useful for ensuring text is ready before displaying it.
+ *
+ * @param options - Configuration options for the text generation.
+ * @returns A promise that resolves when the text preload request has been initiated.
+ */
+declare function preloadText(options: SlopTextOptions): Promise<void>;
 
-export { type ImageAspectRatio, type SlopImageOptions, type SlopTextOptions, type SlopVideoOptions, type VideoAspectRatio, buildImageUrl, buildTextUrl, buildVideoUrl, interpolatePrompt };
+export { type ImageAspectRatio, type SlopImageOptions, type SlopTextOptions, type SlopVideoOptions, type VideoAspectRatio, buildImageUrl, buildTextUrl, buildVideoUrl, interpolatePrompt, preloadImage, preloadText, preloadVideo };

package/dist/index.d.ts

@@ -42,7 +42,21 @@ interface SlopImageOptions {
     baseUrl?: string;
 }
 declare function interpolatePrompt(prompt?: string, variables?: Record<string, string | number | undefined | null>): string;
+/**
+ * Builds a URL to render or retrieve an image from Slop Machine.
+ *
+ * @param options - Configuration options for the image generation.
+ * @returns A string containing the fully constructed URL.
+ */
 declare function buildImageUrl(options: SlopImageOptions): string;
+/**
+ * Preloads an image from Slop Machine into the browser's cache.
+ * Useful for ensuring images are ready before displaying them.
+ *
+ * @param options - Configuration options for the image generation.
+ * @returns A promise that resolves when the image has been loaded.
+ */
+declare function preloadImage(options: SlopImageOptions): Promise<void>;
 type VideoAspectRatio = "9:16" | "16:9";
 interface SlopVideoOptions {
     /**
@@ -91,7 +105,21 @@ interface SlopVideoOptions {
      */
     baseUrl?: string;
 }
+/**
+ * Builds a URL to render or retrieve a video from Slop Machine.
+ *
+ * @param options - Configuration options for the video generation.
+ * @returns A string containing the fully constructed URL.
+ */
 declare function buildVideoUrl(options: SlopVideoOptions): string;
+/**
+ * Preloads a video from Slop Machine into the browser's cache.
+ * Useful for ensuring videos are ready before displaying them.
+ *
+ * @param options - Configuration options for the video generation.
+ * @returns A promise that resolves when the video preload request has been initiated.
+ */
+declare function preloadVideo(options: SlopVideoOptions): Promise<void>;
 interface SlopTextOptions {
     /**
      * The unique identifier of your Slop Machine bucket.
@@ -123,6 +151,20 @@ interface SlopTextOptions {
      */
     baseUrl?: string;
 }
+/**
+ * Builds a URL to render or retrieve text from Slop Machine.
+ *
+ * @param options - Configuration options for the text generation.
+ * @returns A string containing the fully constructed URL.
+ */
 declare function buildTextUrl(options: SlopTextOptions): string;
+/**
+ * Preloads text from Slop Machine into the browser's cache.
+ * Useful for ensuring text is ready before displaying it.
+ *
+ * @param options - Configuration options for the text generation.
+ * @returns A promise that resolves when the text preload request has been initiated.
+ */
+declare function preloadText(options: SlopTextOptions): Promise<void>;
 
-export { type ImageAspectRatio, type SlopImageOptions, type SlopTextOptions, type SlopVideoOptions, type VideoAspectRatio, buildImageUrl, buildTextUrl, buildVideoUrl, interpolatePrompt };
+export { type ImageAspectRatio, type SlopImageOptions, type SlopTextOptions, type SlopVideoOptions, type VideoAspectRatio, buildImageUrl, buildTextUrl, buildVideoUrl, interpolatePrompt, preloadImage, preloadText, preloadVideo };

package/dist/index.js

@@ -23,7 +23,10 @@ __export(index_exports, {
   buildImageUrl: () => buildImageUrl,
   buildTextUrl: () => buildTextUrl,
   buildVideoUrl: () => buildVideoUrl,
-  interpolatePrompt: () => interpolatePrompt
+  interpolatePrompt: () => interpolatePrompt,
+  preloadImage: () => preloadImage,
+  preloadText: () => preloadText,
+  preloadVideo: () => preloadVideo
 });
 module.exports = __toCommonJS(index_exports);
 function interpolatePrompt(prompt, variables) {
@@ -73,6 +76,18 @@ function buildImageUrl(options) {
   }
   return `${baseUrl}?${params.toString()}`;
 }
+function preloadImage(options) {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      resolve();
+      return;
+    }
+    const img = new Image();
+    img.onload = () => resolve();
+    img.onerror = (err) => reject(err);
+    img.src = buildImageUrl(options);
+  });
+}
 function buildVideoUrl(options) {
   const {
     bucketId,
@@ -106,6 +121,15 @@ function buildVideoUrl(options) {
   }
   return `${baseUrl}?${params.toString()}`;
 }
+function preloadVideo(options) {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      resolve();
+      return;
+    }
+    fetch(buildVideoUrl(options), { mode: "no-cors" }).then(() => resolve()).catch((err) => reject(err));
+  });
+}
 function buildTextUrl(options) {
   const {
     bucketId,
@@ -131,11 +155,23 @@ function buildTextUrl(options) {
   }
   return `${baseUrl}?${params.toString()}`;
 }
+function preloadText(options) {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      resolve();
+      return;
+    }
+    fetch(buildTextUrl(options), { mode: "no-cors" }).then(() => resolve()).catch((err) => reject(err));
+  });
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   buildImageUrl,
   buildTextUrl,
   buildVideoUrl,
-  interpolatePrompt
+  interpolatePrompt,
+  preloadImage,
+  preloadText,
+  preloadVideo
 });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type ImageAspectRatio =\n  | \"1:1\"\n  | \"2:3\"\n  | \"3:2\"\n  | \"3:4\"\n  | \"4:3\"\n  | \"4:5\"\n  | \"5:4\"\n  | \"9:16\"\n  | \"16:9\"\n  | \"21:9\";\n\nexport interface SlopImageOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated image\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The aspect ratio of the generated image. Defaults to \"1:1\".\n   * Common values: \"1:1\", \"16:9\", \"9:16\", \"4:3\", \"3:4\".\n   */\n  aspectRatio?: ImageAspectRatio;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: \"gemini\" | \"gemini-flash\" | \"gemini-pro\" | \"imagen\";\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A photo of a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The target quality (\"fast\" or \"high\"). Only affects new generations and is ignored for caching.\n   * Ignored if `model` is provided.\n   * Defaults to \"fast\".\n   */\n  quality?: \"fast\" | \"high\";\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\nexport function interpolatePrompt(\n  prompt?: string,\n  variables?: Record<string, string | number | undefined | null>,\n): string {\n  if (!prompt) return \"\";\n  let text = prompt;\n  if (!variables) return text;\n\n  Object.keys(variables).forEach((key) => {\n    const value = variables[key];\n    if (value !== undefined && value !== null) {\n      text = text.replace(new RegExp(`\\\\{${key}\\\\}`, \"g\"), String(value));\n    }\n  });\n  return text;\n}\n\nexport function buildImageUrl(options: SlopImageOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    aspectRatio = \"1:1\",\n    model,\n    quality = \"fast\",\n    variables = {},\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderImage\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (aspectRatio) {\n    params.set(\"aspectRatio\", aspectRatio);\n  }\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  }\n  if (quality && quality !== \"fast\") {\n    params.set(\"quality\", quality);\n  } else if (quality === \"fast\") {\n    params.set(\"quality\", \"fast\");\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\nexport type VideoAspectRatio = \"9:16\" | \"16:9\";\n\nexport interface SlopVideoOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated video\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The aspect ratio of the generated video. Defaults to \"16:9\".\n   * Common values: \"1:1\", \"16:9\", \"9:16\", \"4:3\", \"3:4\".\n   */\n  aspectRatio?: VideoAspectRatio;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: string;\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A video of a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The duration of the generated video in seconds.\n   * Must be between 4 and 8. Defaults to 4.\n   */\n  duration?: number;\n  /**\n   * The target quality (\"fast\" or \"high\"). Only affects new generations and is ignored for caching.\n   * Ignored if `model` is provided.\n   * Defaults to \"fast\".\n   */\n  quality?: \"fast\" | \"high\";\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\nexport function buildVideoUrl(options: SlopVideoOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    aspectRatio = \"16:9\",\n    model,\n    quality = \"fast\",\n    variables = {},\n    duration = 4,\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderVideo\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (aspectRatio) {\n    params.set(\"aspectRatio\", aspectRatio);\n  }\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  } else {\n    params.set(\"quality\", \"fast\");\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\nexport interface SlopTextOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated text\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: string;\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A story about a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\nexport function buildTextUrl(options: SlopTextOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    model,\n    variables = {},\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderText\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAuDO,SAAS,kBACd,QACA,WACQ;AACR,MAAI,CAAC,OAAQ,QAAO;AACpB,MAAI,OAAO;AACX,MAAI,CAAC,UAAW,QAAO;AAEvB,SAAO,KAAK,SAAS,EAAE,QAAQ,CAAC,QAAQ;AACtC,UAAM,QAAQ,UAAU,GAAG;AAC3B,QAAI,UAAU,UAAa,UAAU,MAAM;AACzC,aAAO,KAAK,QAAQ,IAAI,OAAO,MAAM,GAAG,OAAO,GAAG,GAAG,OAAO,KAAK,CAAC;AAAA,IACpE;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAEO,SAAS,cAAc,SAAmC;AAC/D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA,UAAU;AAAA,IACV,YAAY,CAAC;AAAA,IACb,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,aAAa;AACf,WAAO,IAAI,eAAe,WAAW;AAAA,EACvC;AAEA,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC;AACA,MAAI,WAAW,YAAY,QAAQ;AACjC,WAAO,IAAI,WAAW,OAAO;AAAA,EAC/B,WAAW,YAAY,QAAQ;AAC7B,WAAO,IAAI,WAAW,MAAM;AAAA,EAC9B;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AAoDO,SAAS,cAAc,SAAmC;AAC/D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA,UAAU;AAAA,IACV,YAAY,CAAC;AAAA,IACb,WAAW;AAAA,IACX,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,aAAa;AACf,WAAO,IAAI,eAAe,WAAW;AAAA,EACvC;AAEA,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC,OAAO;AACL,WAAO,IAAI,WAAW,MAAM;AAAA,EAC9B;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AAkCO,SAAS,aAAa,SAAkC;AAC7D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,YAAY,CAAC;AAAA,IACb,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type ImageAspectRatio =\n  | \"1:1\"\n  | \"2:3\"\n  | \"3:2\"\n  | \"3:4\"\n  | \"4:3\"\n  | \"4:5\"\n  | \"5:4\"\n  | \"9:16\"\n  | \"16:9\"\n  | \"21:9\";\n\nexport interface SlopImageOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated image\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The aspect ratio of the generated image. Defaults to \"1:1\".\n   * Common values: \"1:1\", \"16:9\", \"9:16\", \"4:3\", \"3:4\".\n   */\n  aspectRatio?: ImageAspectRatio;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: \"gemini\" | \"gemini-flash\" | \"gemini-pro\" | \"imagen\";\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A photo of a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The target quality (\"fast\" or \"high\"). Only affects new generations and is ignored for caching.\n   * Ignored if `model` is provided.\n   * Defaults to \"fast\".\n   */\n  quality?: \"fast\" | \"high\";\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\nexport function interpolatePrompt(\n  prompt?: string,\n  variables?: Record<string, string | number | undefined | null>,\n): string {\n  if (!prompt) return \"\";\n  let text = prompt;\n  if (!variables) return text;\n\n  Object.keys(variables).forEach((key) => {\n    const value = variables[key];\n    if (value !== undefined && value !== null) {\n      text = text.replace(new RegExp(`\\\\{${key}\\\\}`, \"g\"), String(value));\n    }\n  });\n  return text;\n}\n\n/**\n * Builds a URL to render or retrieve an image from Slop Machine.\n *\n * @param options - Configuration options for the image generation.\n * @returns A string containing the fully constructed URL.\n */\nexport function buildImageUrl(options: SlopImageOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    aspectRatio = \"1:1\",\n    model,\n    quality = \"fast\",\n    variables = {},\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderImage\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (aspectRatio) {\n    params.set(\"aspectRatio\", aspectRatio);\n  }\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  }\n  if (quality && quality !== \"fast\") {\n    params.set(\"quality\", quality);\n  } else if (quality === \"fast\") {\n    params.set(\"quality\", \"fast\");\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\n/**\n * Preloads an image from Slop Machine into the browser's cache.\n * Useful for ensuring images are ready before displaying them.\n *\n * @param options - Configuration options for the image generation.\n * @returns A promise that resolves when the image has been loaded.\n */\nexport function preloadImage(options: SlopImageOptions): Promise<void> {\n  return new Promise((resolve, reject) => {\n    if (typeof window === \"undefined\") {\n      resolve();\n      return;\n    }\n\n    const img = new Image();\n    img.onload = () => resolve();\n    img.onerror = (err) => reject(err);\n    img.src = buildImageUrl(options);\n  });\n}\n\nexport type VideoAspectRatio = \"9:16\" | \"16:9\";\n\nexport interface SlopVideoOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated video\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The aspect ratio of the generated video. Defaults to \"16:9\".\n   * Common values: \"1:1\", \"16:9\", \"9:16\", \"4:3\", \"3:4\".\n   */\n  aspectRatio?: VideoAspectRatio;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: string;\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A video of a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The duration of the generated video in seconds.\n   * Must be between 4 and 8. Defaults to 4.\n   */\n  duration?: number;\n  /**\n   * The target quality (\"fast\" or \"high\"). Only affects new generations and is ignored for caching.\n   * Ignored if `model` is provided.\n   * Defaults to \"fast\".\n   */\n  quality?: \"fast\" | \"high\";\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\n/**\n * Builds a URL to render or retrieve a video from Slop Machine.\n *\n * @param options - Configuration options for the video generation.\n * @returns A string containing the fully constructed URL.\n */\nexport function buildVideoUrl(options: SlopVideoOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    aspectRatio = \"16:9\",\n    model,\n    quality = \"fast\",\n    variables = {},\n    duration = 4,\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderVideo\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (aspectRatio) {\n    params.set(\"aspectRatio\", aspectRatio);\n  }\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  } else {\n    params.set(\"quality\", \"fast\");\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\n/**\n * Preloads a video from Slop Machine into the browser's cache.\n * Useful for ensuring videos are ready before displaying them.\n *\n * @param options - Configuration options for the video generation.\n * @returns A promise that resolves when the video preload request has been initiated.\n */\nexport function preloadVideo(options: SlopVideoOptions): Promise<void> {\n  return new Promise((resolve, reject) => {\n    if (typeof window === \"undefined\") {\n      resolve();\n      return;\n    }\n\n    // We can just fetch the URL to preload it into the browser's cache.\n    // We use no-cors to avoid CORS errors for simple preloads\n    fetch(buildVideoUrl(options), { mode: \"no-cors\" })\n      .then(() => resolve())\n      .catch((err) => reject(err));\n  });\n}\n\nexport interface SlopTextOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated text\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: string;\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A story about a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\n/**\n * Builds a URL to render or retrieve text from Slop Machine.\n *\n * @param options - Configuration options for the text generation.\n * @returns A string containing the fully constructed URL.\n */\nexport function buildTextUrl(options: SlopTextOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    model,\n    variables = {},\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderText\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\n/**\n * Preloads text from Slop Machine into the browser's cache.\n * Useful for ensuring text is ready before displaying it.\n *\n * @param options - Configuration options for the text generation.\n * @returns A promise that resolves when the text preload request has been initiated.\n */\nexport function preloadText(options: SlopTextOptions): Promise<void> {\n  return new Promise((resolve, reject) => {\n    if (typeof window === \"undefined\") {\n      resolve();\n      return;\n    }\n\n    // Fetch the URL to preload it into the browser's cache.\n    // We use no-cors to avoid CORS errors for simple preloads\n    fetch(buildTextUrl(options), { mode: \"no-cors\" })\n      .then(() => resolve())\n      .catch((err) => reject(err));\n  });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAuDO,SAAS,kBACd,QACA,WACQ;AACR,MAAI,CAAC,OAAQ,QAAO;AACpB,MAAI,OAAO;AACX,MAAI,CAAC,UAAW,QAAO;AAEvB,SAAO,KAAK,SAAS,EAAE,QAAQ,CAAC,QAAQ;AACtC,UAAM,QAAQ,UAAU,GAAG;AAC3B,QAAI,UAAU,UAAa,UAAU,MAAM;AACzC,aAAO,KAAK,QAAQ,IAAI,OAAO,MAAM,GAAG,OAAO,GAAG,GAAG,OAAO,KAAK,CAAC;AAAA,IACpE;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAQO,SAAS,cAAc,SAAmC;AAC/D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA,UAAU;AAAA,IACV,YAAY,CAAC;AAAA,IACb,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,aAAa;AACf,WAAO,IAAI,eAAe,WAAW;AAAA,EACvC;AAEA,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC;AACA,MAAI,WAAW,YAAY,QAAQ;AACjC,WAAO,IAAI,WAAW,OAAO;AAAA,EAC/B,WAAW,YAAY,QAAQ;AAC7B,WAAO,IAAI,WAAW,MAAM;AAAA,EAC9B;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AASO,SAAS,aAAa,SAA0C;AACrE,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,QAAI,OAAO,WAAW,aAAa;AACjC,cAAQ;AACR;AAAA,IACF;AAEA,UAAM,MAAM,IAAI,MAAM;AACtB,QAAI,SAAS,MAAM,QAAQ;AAC3B,QAAI,UAAU,CAAC,QAAQ,OAAO,GAAG;AACjC,QAAI,MAAM,cAAc,OAAO;AAAA,EACjC,CAAC;AACH;AA0DO,SAAS,cAAc,SAAmC;AAC/D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA,UAAU;AAAA,IACV,YAAY,CAAC;AAAA,IACb,WAAW;AAAA,IACX,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,aAAa;AACf,WAAO,IAAI,eAAe,WAAW;AAAA,EACvC;AAEA,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC,OAAO;AACL,WAAO,IAAI,WAAW,MAAM;AAAA,EAC9B;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AASO,SAAS,aAAa,SAA0C;AACrE,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,QAAI,OAAO,WAAW,aAAa;AACjC,cAAQ;AACR;AAAA,IACF;AAIA,UAAM,cAAc,OAAO,GAAG,EAAE,MAAM,UAAU,CAAC,EAC9C,KAAK,MAAM,QAAQ,CAAC,EACpB,MAAM,CAAC,QAAQ,OAAO,GAAG,CAAC;AAAA,EAC/B,CAAC;AACH;AAwCO,SAAS,aAAa,SAAkC;AAC7D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,YAAY,CAAC;AAAA,IACb,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AASO,SAAS,YAAY,SAAyC;AACnE,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,QAAI,OAAO,WAAW,aAAa;AACjC,cAAQ;AACR;AAAA,IACF;AAIA,UAAM,aAAa,OAAO,GAAG,EAAE,MAAM,UAAU,CAAC,EAC7C,KAAK,MAAM,QAAQ,CAAC,EACpB,MAAM,CAAC,QAAQ,OAAO,GAAG,CAAC;AAAA,EAC/B,CAAC;AACH;","names":[]}

package/dist/index.mjs

@@ -46,6 +46,18 @@ function buildImageUrl(options) {
   }
   return `${baseUrl}?${params.toString()}`;
 }
+function preloadImage(options) {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      resolve();
+      return;
+    }
+    const img = new Image();
+    img.onload = () => resolve();
+    img.onerror = (err) => reject(err);
+    img.src = buildImageUrl(options);
+  });
+}
 function buildVideoUrl(options) {
   const {
     bucketId,
@@ -79,6 +91,15 @@ function buildVideoUrl(options) {
   }
   return `${baseUrl}?${params.toString()}`;
 }
+function preloadVideo(options) {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      resolve();
+      return;
+    }
+    fetch(buildVideoUrl(options), { mode: "no-cors" }).then(() => resolve()).catch((err) => reject(err));
+  });
+}
 function buildTextUrl(options) {
   const {
     bucketId,
@@ -104,10 +125,22 @@ function buildTextUrl(options) {
   }
   return `${baseUrl}?${params.toString()}`;
 }
+function preloadText(options) {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      resolve();
+      return;
+    }
+    fetch(buildTextUrl(options), { mode: "no-cors" }).then(() => resolve()).catch((err) => reject(err));
+  });
+}
 export {
   buildImageUrl,
   buildTextUrl,
   buildVideoUrl,
-  interpolatePrompt
+  interpolatePrompt,
+  preloadImage,
+  preloadText,
+  preloadVideo
 };
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type ImageAspectRatio =\n  | \"1:1\"\n  | \"2:3\"\n  | \"3:2\"\n  | \"3:4\"\n  | \"4:3\"\n  | \"4:5\"\n  | \"5:4\"\n  | \"9:16\"\n  | \"16:9\"\n  | \"21:9\";\n\nexport interface SlopImageOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated image\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The aspect ratio of the generated image. Defaults to \"1:1\".\n   * Common values: \"1:1\", \"16:9\", \"9:16\", \"4:3\", \"3:4\".\n   */\n  aspectRatio?: ImageAspectRatio;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: \"gemini\" | \"gemini-flash\" | \"gemini-pro\" | \"imagen\";\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A photo of a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The target quality (\"fast\" or \"high\"). Only affects new generations and is ignored for caching.\n   * Ignored if `model` is provided.\n   * Defaults to \"fast\".\n   */\n  quality?: \"fast\" | \"high\";\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\nexport function interpolatePrompt(\n  prompt?: string,\n  variables?: Record<string, string | number | undefined | null>,\n): string {\n  if (!prompt) return \"\";\n  let text = prompt;\n  if (!variables) return text;\n\n  Object.keys(variables).forEach((key) => {\n    const value = variables[key];\n    if (value !== undefined && value !== null) {\n      text = text.replace(new RegExp(`\\\\{${key}\\\\}`, \"g\"), String(value));\n    }\n  });\n  return text;\n}\n\nexport function buildImageUrl(options: SlopImageOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    aspectRatio = \"1:1\",\n    model,\n    quality = \"fast\",\n    variables = {},\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderImage\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (aspectRatio) {\n    params.set(\"aspectRatio\", aspectRatio);\n  }\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  }\n  if (quality && quality !== \"fast\") {\n    params.set(\"quality\", quality);\n  } else if (quality === \"fast\") {\n    params.set(\"quality\", \"fast\");\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\nexport type VideoAspectRatio = \"9:16\" | \"16:9\";\n\nexport interface SlopVideoOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated video\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The aspect ratio of the generated video. Defaults to \"16:9\".\n   * Common values: \"1:1\", \"16:9\", \"9:16\", \"4:3\", \"3:4\".\n   */\n  aspectRatio?: VideoAspectRatio;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: string;\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A video of a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The duration of the generated video in seconds.\n   * Must be between 4 and 8. Defaults to 4.\n   */\n  duration?: number;\n  /**\n   * The target quality (\"fast\" or \"high\"). Only affects new generations and is ignored for caching.\n   * Ignored if `model` is provided.\n   * Defaults to \"fast\".\n   */\n  quality?: \"fast\" | \"high\";\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\nexport function buildVideoUrl(options: SlopVideoOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    aspectRatio = \"16:9\",\n    model,\n    quality = \"fast\",\n    variables = {},\n    duration = 4,\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderVideo\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (aspectRatio) {\n    params.set(\"aspectRatio\", aspectRatio);\n  }\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  } else {\n    params.set(\"quality\", \"fast\");\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\nexport interface SlopTextOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated text\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: string;\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A story about a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\nexport function buildTextUrl(options: SlopTextOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    model,\n    variables = {},\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderText\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n"],"mappings":";AAuDO,SAAS,kBACd,QACA,WACQ;AACR,MAAI,CAAC,OAAQ,QAAO;AACpB,MAAI,OAAO;AACX,MAAI,CAAC,UAAW,QAAO;AAEvB,SAAO,KAAK,SAAS,EAAE,QAAQ,CAAC,QAAQ;AACtC,UAAM,QAAQ,UAAU,GAAG;AAC3B,QAAI,UAAU,UAAa,UAAU,MAAM;AACzC,aAAO,KAAK,QAAQ,IAAI,OAAO,MAAM,GAAG,OAAO,GAAG,GAAG,OAAO,KAAK,CAAC;AAAA,IACpE;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAEO,SAAS,cAAc,SAAmC;AAC/D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA,UAAU;AAAA,IACV,YAAY,CAAC;AAAA,IACb,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,aAAa;AACf,WAAO,IAAI,eAAe,WAAW;AAAA,EACvC;AAEA,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC;AACA,MAAI,WAAW,YAAY,QAAQ;AACjC,WAAO,IAAI,WAAW,OAAO;AAAA,EAC/B,WAAW,YAAY,QAAQ;AAC7B,WAAO,IAAI,WAAW,MAAM;AAAA,EAC9B;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AAoDO,SAAS,cAAc,SAAmC;AAC/D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA,UAAU;AAAA,IACV,YAAY,CAAC;AAAA,IACb,WAAW;AAAA,IACX,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,aAAa;AACf,WAAO,IAAI,eAAe,WAAW;AAAA,EACvC;AAEA,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC,OAAO;AACL,WAAO,IAAI,WAAW,MAAM;AAAA,EAC9B;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AAkCO,SAAS,aAAa,SAAkC;AAC7D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,YAAY,CAAC;AAAA,IACb,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type ImageAspectRatio =\n  | \"1:1\"\n  | \"2:3\"\n  | \"3:2\"\n  | \"3:4\"\n  | \"4:3\"\n  | \"4:5\"\n  | \"5:4\"\n  | \"9:16\"\n  | \"16:9\"\n  | \"21:9\";\n\nexport interface SlopImageOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated image\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The aspect ratio of the generated image. Defaults to \"1:1\".\n   * Common values: \"1:1\", \"16:9\", \"9:16\", \"4:3\", \"3:4\".\n   */\n  aspectRatio?: ImageAspectRatio;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: \"gemini\" | \"gemini-flash\" | \"gemini-pro\" | \"imagen\";\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A photo of a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The target quality (\"fast\" or \"high\"). Only affects new generations and is ignored for caching.\n   * Ignored if `model` is provided.\n   * Defaults to \"fast\".\n   */\n  quality?: \"fast\" | \"high\";\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\nexport function interpolatePrompt(\n  prompt?: string,\n  variables?: Record<string, string | number | undefined | null>,\n): string {\n  if (!prompt) return \"\";\n  let text = prompt;\n  if (!variables) return text;\n\n  Object.keys(variables).forEach((key) => {\n    const value = variables[key];\n    if (value !== undefined && value !== null) {\n      text = text.replace(new RegExp(`\\\\{${key}\\\\}`, \"g\"), String(value));\n    }\n  });\n  return text;\n}\n\n/**\n * Builds a URL to render or retrieve an image from Slop Machine.\n *\n * @param options - Configuration options for the image generation.\n * @returns A string containing the fully constructed URL.\n */\nexport function buildImageUrl(options: SlopImageOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    aspectRatio = \"1:1\",\n    model,\n    quality = \"fast\",\n    variables = {},\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderImage\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (aspectRatio) {\n    params.set(\"aspectRatio\", aspectRatio);\n  }\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  }\n  if (quality && quality !== \"fast\") {\n    params.set(\"quality\", quality);\n  } else if (quality === \"fast\") {\n    params.set(\"quality\", \"fast\");\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\n/**\n * Preloads an image from Slop Machine into the browser's cache.\n * Useful for ensuring images are ready before displaying them.\n *\n * @param options - Configuration options for the image generation.\n * @returns A promise that resolves when the image has been loaded.\n */\nexport function preloadImage(options: SlopImageOptions): Promise<void> {\n  return new Promise((resolve, reject) => {\n    if (typeof window === \"undefined\") {\n      resolve();\n      return;\n    }\n\n    const img = new Image();\n    img.onload = () => resolve();\n    img.onerror = (err) => reject(err);\n    img.src = buildImageUrl(options);\n  });\n}\n\nexport type VideoAspectRatio = \"9:16\" | \"16:9\";\n\nexport interface SlopVideoOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated video\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The aspect ratio of the generated video. Defaults to \"16:9\".\n   * Common values: \"1:1\", \"16:9\", \"9:16\", \"4:3\", \"3:4\".\n   */\n  aspectRatio?: VideoAspectRatio;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: string;\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A video of a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The duration of the generated video in seconds.\n   * Must be between 4 and 8. Defaults to 4.\n   */\n  duration?: number;\n  /**\n   * The target quality (\"fast\" or \"high\"). Only affects new generations and is ignored for caching.\n   * Ignored if `model` is provided.\n   * Defaults to \"fast\".\n   */\n  quality?: \"fast\" | \"high\";\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\n/**\n * Builds a URL to render or retrieve a video from Slop Machine.\n *\n * @param options - Configuration options for the video generation.\n * @returns A string containing the fully constructed URL.\n */\nexport function buildVideoUrl(options: SlopVideoOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    aspectRatio = \"16:9\",\n    model,\n    quality = \"fast\",\n    variables = {},\n    duration = 4,\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderVideo\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (aspectRatio) {\n    params.set(\"aspectRatio\", aspectRatio);\n  }\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  } else {\n    params.set(\"quality\", \"fast\");\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\n/**\n * Preloads a video from Slop Machine into the browser's cache.\n * Useful for ensuring videos are ready before displaying them.\n *\n * @param options - Configuration options for the video generation.\n * @returns A promise that resolves when the video preload request has been initiated.\n */\nexport function preloadVideo(options: SlopVideoOptions): Promise<void> {\n  return new Promise((resolve, reject) => {\n    if (typeof window === \"undefined\") {\n      resolve();\n      return;\n    }\n\n    // We can just fetch the URL to preload it into the browser's cache.\n    // We use no-cors to avoid CORS errors for simple preloads\n    fetch(buildVideoUrl(options), { mode: \"no-cors\" })\n      .then(() => resolve())\n      .catch((err) => reject(err));\n  });\n}\n\nexport interface SlopTextOptions {\n  /**\n   * The unique identifier of your Slop Machine bucket.\n   */\n  bucketId: string;\n  /**\n   * The specific version of the prompt/settings to use.\n   * If omitted, the latest version will be used.\n   */\n  version?: number;\n  /**\n   * Result ID to retrieve a specific previously generated text\n   * instead of generating a new one.\n   */\n  resultId?: string;\n  /**\n   * The AI model to use for generation.\n   * Overrides the default model specified in the bucket settings.\n   */\n  model?: string;\n  /**\n   * Dynamic variables to interpolate into the prompt.\n   * E.g., if prompt is \"A story about a {color} dog\", pass { color: \"brown\" }.\n   */\n  variables?: Record<string, string | number | undefined | null>;\n  /**\n   * The base URL for the Slop Machine API.\n   * Defaults to the production URL. Useful for testing against local deployments.\n   */\n  baseUrl?: string;\n}\n\n/**\n * Builds a URL to render or retrieve text from Slop Machine.\n *\n * @param options - Configuration options for the text generation.\n * @returns A string containing the fully constructed URL.\n */\nexport function buildTextUrl(options: SlopTextOptions): string {\n  const {\n    bucketId,\n    version,\n    resultId,\n    model,\n    variables = {},\n    baseUrl = \"https://us-central1-slopmachine-12bfb.cloudfunctions.net/renderText\",\n  } = options;\n\n  const params = new URLSearchParams();\n  params.set(\"bucketId\", bucketId);\n\n  if (model) {\n    params.set(\"model\", model);\n  }\n  if (version) {\n    params.set(\"version\", String(version));\n  }\n  if (resultId) {\n    params.set(\"resultId\", resultId);\n  }\n\n  if (Object.keys(variables).length > 0) {\n    params.set(\"variables\", JSON.stringify(variables));\n  }\n\n  return `${baseUrl}?${params.toString()}`;\n}\n\n/**\n * Preloads text from Slop Machine into the browser's cache.\n * Useful for ensuring text is ready before displaying it.\n *\n * @param options - Configuration options for the text generation.\n * @returns A promise that resolves when the text preload request has been initiated.\n */\nexport function preloadText(options: SlopTextOptions): Promise<void> {\n  return new Promise((resolve, reject) => {\n    if (typeof window === \"undefined\") {\n      resolve();\n      return;\n    }\n\n    // Fetch the URL to preload it into the browser's cache.\n    // We use no-cors to avoid CORS errors for simple preloads\n    fetch(buildTextUrl(options), { mode: \"no-cors\" })\n      .then(() => resolve())\n      .catch((err) => reject(err));\n  });\n}\n"],"mappings":";AAuDO,SAAS,kBACd,QACA,WACQ;AACR,MAAI,CAAC,OAAQ,QAAO;AACpB,MAAI,OAAO;AACX,MAAI,CAAC,UAAW,QAAO;AAEvB,SAAO,KAAK,SAAS,EAAE,QAAQ,CAAC,QAAQ;AACtC,UAAM,QAAQ,UAAU,GAAG;AAC3B,QAAI,UAAU,UAAa,UAAU,MAAM;AACzC,aAAO,KAAK,QAAQ,IAAI,OAAO,MAAM,GAAG,OAAO,GAAG,GAAG,OAAO,KAAK,CAAC;AAAA,IACpE;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAQO,SAAS,cAAc,SAAmC;AAC/D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA,UAAU;AAAA,IACV,YAAY,CAAC;AAAA,IACb,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,aAAa;AACf,WAAO,IAAI,eAAe,WAAW;AAAA,EACvC;AAEA,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC;AACA,MAAI,WAAW,YAAY,QAAQ;AACjC,WAAO,IAAI,WAAW,OAAO;AAAA,EAC/B,WAAW,YAAY,QAAQ;AAC7B,WAAO,IAAI,WAAW,MAAM;AAAA,EAC9B;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AASO,SAAS,aAAa,SAA0C;AACrE,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,QAAI,OAAO,WAAW,aAAa;AACjC,cAAQ;AACR;AAAA,IACF;AAEA,UAAM,MAAM,IAAI,MAAM;AACtB,QAAI,SAAS,MAAM,QAAQ;AAC3B,QAAI,UAAU,CAAC,QAAQ,OAAO,GAAG;AACjC,QAAI,MAAM,cAAc,OAAO;AAAA,EACjC,CAAC;AACH;AA0DO,SAAS,cAAc,SAAmC;AAC/D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA,UAAU;AAAA,IACV,YAAY,CAAC;AAAA,IACb,WAAW;AAAA,IACX,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,aAAa;AACf,WAAO,IAAI,eAAe,WAAW;AAAA,EACvC;AAEA,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC,OAAO;AACL,WAAO,IAAI,WAAW,MAAM;AAAA,EAC9B;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AASO,SAAS,aAAa,SAA0C;AACrE,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,QAAI,OAAO,WAAW,aAAa;AACjC,cAAQ;AACR;AAAA,IACF;AAIA,UAAM,cAAc,OAAO,GAAG,EAAE,MAAM,UAAU,CAAC,EAC9C,KAAK,MAAM,QAAQ,CAAC,EACpB,MAAM,CAAC,QAAQ,OAAO,GAAG,CAAC;AAAA,EAC/B,CAAC;AACH;AAwCO,SAAS,aAAa,SAAkC;AAC7D,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,YAAY,CAAC;AAAA,IACb,UAAU;AAAA,EACZ,IAAI;AAEJ,QAAM,SAAS,IAAI,gBAAgB;AACnC,SAAO,IAAI,YAAY,QAAQ;AAE/B,MAAI,OAAO;AACT,WAAO,IAAI,SAAS,KAAK;AAAA,EAC3B;AACA,MAAI,SAAS;AACX,WAAO,IAAI,WAAW,OAAO,OAAO,CAAC;AAAA,EACvC;AACA,MAAI,UAAU;AACZ,WAAO,IAAI,YAAY,QAAQ;AAAA,EACjC;AAEA,MAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,WAAO,IAAI,aAAa,KAAK,UAAU,SAAS,CAAC;AAAA,EACnD;AAEA,SAAO,GAAG,OAAO,IAAI,OAAO,SAAS,CAAC;AACxC;AASO,SAAS,YAAY,SAAyC;AACnE,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,QAAI,OAAO,WAAW,aAAa;AACjC,cAAQ;AACR;AAAA,IACF;AAIA,UAAM,aAAa,OAAO,GAAG,EAAE,MAAM,UAAU,CAAC,EAC7C,KAAK,MAAM,QAAQ,CAAC,EACpB,MAAM,CAAC,QAAQ,OAAO,GAAG,CAAC;AAAA,EAC/B,CAAC;AACH;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slopmachine/core",
-  "version": "0.1.15",
+  "version": "0.1.16",
   "description": "The official Core / VanillaJS SDK for Slop Machine",
   "llms": "https://slopmachine-dev.github.io/slopmachine-sdk/llms.txt",
   "llmsFull": "https://slopmachine-dev.github.io/slopmachine-sdk/llms-full.txt",

package/src/index.ts

@@ -70,6 +70,12 @@ export function interpolatePrompt(
   return text;
 }
 
+/**
+ * Builds a URL to render or retrieve an image from Slop Machine.
+ *
+ * @param options - Configuration options for the image generation.
+ * @returns A string containing the fully constructed URL.
+ */
 export function buildImageUrl(options: SlopImageOptions): string {
   const {
     bucketId,
@@ -111,6 +117,27 @@ export function buildImageUrl(options: SlopImageOptions): string {
   return `${baseUrl}?${params.toString()}`;
 }
 
+/**
+ * Preloads an image from Slop Machine into the browser's cache.
+ * Useful for ensuring images are ready before displaying them.
+ *
+ * @param options - Configuration options for the image generation.
+ * @returns A promise that resolves when the image has been loaded.
+ */
+export function preloadImage(options: SlopImageOptions): Promise<void> {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      resolve();
+      return;
+    }
+
+    const img = new Image();
+    img.onload = () => resolve();
+    img.onerror = (err) => reject(err);
+    img.src = buildImageUrl(options);
+  });
+}
+
 export type VideoAspectRatio = "9:16" | "16:9";
 
 export interface SlopVideoOptions {
@@ -161,6 +188,12 @@ export interface SlopVideoOptions {
   baseUrl?: string;
 }
 
+/**
+ * Builds a URL to render or retrieve a video from Slop Machine.
+ *
+ * @param options - Configuration options for the video generation.
+ * @returns A string containing the fully constructed URL.
+ */
 export function buildVideoUrl(options: SlopVideoOptions): string {
   const {
     bucketId,
@@ -200,6 +233,28 @@ export function buildVideoUrl(options: SlopVideoOptions): string {
   return `${baseUrl}?${params.toString()}`;
 }
 
+/**
+ * Preloads a video from Slop Machine into the browser's cache.
+ * Useful for ensuring videos are ready before displaying them.
+ *
+ * @param options - Configuration options for the video generation.
+ * @returns A promise that resolves when the video preload request has been initiated.
+ */
+export function preloadVideo(options: SlopVideoOptions): Promise<void> {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      resolve();
+      return;
+    }
+
+    // We can just fetch the URL to preload it into the browser's cache.
+    // We use no-cors to avoid CORS errors for simple preloads
+    fetch(buildVideoUrl(options), { mode: "no-cors" })
+      .then(() => resolve())
+      .catch((err) => reject(err));
+  });
+}
+
 export interface SlopTextOptions {
   /**
    * The unique identifier of your Slop Machine bucket.
@@ -232,6 +287,12 @@ export interface SlopTextOptions {
   baseUrl?: string;
 }
 
+/**
+ * Builds a URL to render or retrieve text from Slop Machine.
+ *
+ * @param options - Configuration options for the text generation.
+ * @returns A string containing the fully constructed URL.
+ */
 export function buildTextUrl(options: SlopTextOptions): string {
   const {
     bucketId,
@@ -261,3 +322,25 @@ export function buildTextUrl(options: SlopTextOptions): string {
 
   return `${baseUrl}?${params.toString()}`;
 }
+
+/**
+ * Preloads text from Slop Machine into the browser's cache.
+ * Useful for ensuring text is ready before displaying it.
+ *
+ * @param options - Configuration options for the text generation.
+ * @returns A promise that resolves when the text preload request has been initiated.
+ */
+export function preloadText(options: SlopTextOptions): Promise<void> {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      resolve();
+      return;
+    }
+
+    // Fetch the URL to preload it into the browser's cache.
+    // We use no-cors to avoid CORS errors for simple preloads
+    fetch(buildTextUrl(options), { mode: "no-cors" })
+      .then(() => resolve())
+      .catch((err) => reject(err));
+  });
+}