@tanstack/ai-worldlabs 0.0.0 → 0.1.2

package/dist/esm/index.d.ts

@@ -0,0 +1,5 @@
+export { WorldLabsWorldAdapter, worldlabsWorld, createWorldLabsWorld, } from './adapters/world.js';
+export type { WorldLabsClientConfig } from './adapters/world.js';
+export { WORLDLABS_WORLD_MODELS, isWorldLabsWorldModel } from './model-meta.js';
+export type { WorldLabsWorldModel, WorldLabsWorldProviderOptions, WorldLabsWorldModelProviderOptionsByName, WorldLabsMediaRef, WorldLabsLocatedImageRef, } from './model-meta.js';
+export { DEFAULT_WORLDLABS_API_URL, getWorldLabsApiKeyFromEnv, } from './utils/client.js';

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+import { DEFAULT_WORLDLABS_API_URL, getWorldLabsApiKeyFromEnv } from "./utils/client.js";
+import { WorldLabsWorldAdapter, createWorldLabsWorld, worldlabsWorld } from "./adapters/world.js";
+import { WORLDLABS_WORLD_MODELS, isWorldLabsWorldModel } from "./model-meta.js";
+export { DEFAULT_WORLDLABS_API_URL, WORLDLABS_WORLD_MODELS, WorldLabsWorldAdapter, createWorldLabsWorld, getWorldLabsApiKeyFromEnv, isWorldLabsWorldModel, worldlabsWorld };

package/dist/esm/model-meta.d.ts

@@ -0,0 +1,63 @@
+/**
+ * World Labs Marble model ids for `worldlabsWorld('marble-1.1')`.
+ */
+export declare const WORLDLABS_WORLD_MODELS: readonly ["marble-1.1-plus", "marble-1.1", "marble-1.0", "marble-1.0-draft"];
+export type WorldLabsWorldModel = (typeof WORLDLABS_WORLD_MODELS)[number];
+export declare function isWorldLabsWorldModel(model: string): model is WorldLabsWorldModel;
+export interface WorldLabsMediaRef {
+    /** Public URL for the media. */
+    uri?: string;
+    /** Id from a previous media-asset upload. */
+    mediaAssetId?: string;
+    /** Base64-encoded file bytes. */
+    dataBase64?: string;
+    /** File extension without a dot, used with `dataBase64`. */
+    extension?: string;
+}
+export interface WorldLabsLocatedImageRef extends WorldLabsMediaRef {
+    /** Horizontal angle in degrees. 0 is front, 90 is right, 180 is back. */
+    azimuth?: number;
+}
+/**
+ * Provider options for World Labs world generation.
+ *
+ * `createWorld` sends these on the generate request. Image, multi-image, and
+ * video inputs select the matching World Labs prompt type. Text-only calls
+ * use `generateWorld({ prompt })`.
+ */
+export interface WorldLabsWorldProviderOptions {
+    /** Optional title stored on the world. Max 64 characters. */
+    displayName?: string;
+    /** Random seed for generation. */
+    seed?: number;
+    /** Optional tags. Max 10 tags, each up to 32 characters. */
+    tags?: Array<string>;
+    /** If true, use the text prompt as-is without recaptioning. */
+    disableRecaption?: boolean;
+    /**
+     * How to treat a single image as a panorama. `auto` detects equirectangular
+     * panos. `true` always treats the image as a pano. `false` treats it as a
+     * standard image.
+     */
+    isPano?: 'auto' | true | false;
+    /** Single image input. Do not combine with `images` or `video`. */
+    image?: WorldLabsMediaRef;
+    /** Multiple images of the same scene. Do not combine with `image` or `video`. */
+    images?: Array<WorldLabsLocatedImageRef>;
+    /** Video input. Do not combine with `image` or `images`. */
+    video?: WorldLabsMediaRef;
+    /** World visibility. Default is private. */
+    permission?: {
+        public?: boolean;
+    };
+    /**
+     * When false, return after the generate call with `status: 'waiting'` and
+     * `operationId`. Default is true: poll until the world is ready.
+     */
+    wait?: boolean;
+    /** Poll interval in milliseconds when `wait` is true. Default 2000. */
+    pollIntervalMs?: number;
+}
+export type WorldLabsWorldModelProviderOptionsByName = {
+    [M in WorldLabsWorldModel]: WorldLabsWorldProviderOptions;
+};

package/dist/esm/model-meta.js

@@ -0,0 +1,17 @@
+//#region src/model-meta.ts
+/**
+* World Labs Marble model ids for `worldlabsWorld('marble-1.1')`.
+*/
+var WORLDLABS_WORLD_MODELS = [
+	"marble-1.1-plus",
+	"marble-1.1",
+	"marble-1.0",
+	"marble-1.0-draft"
+];
+function isWorldLabsWorldModel(model) {
+	return WORLDLABS_WORLD_MODELS.includes(model);
+}
+//#endregion
+export { WORLDLABS_WORLD_MODELS, isWorldLabsWorldModel };
+
+//# sourceMappingURL=model-meta.js.map

package/dist/esm/model-meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-meta.js","names":[],"sources":["../../src/model-meta.ts"],"sourcesContent":["/**\n * World Labs Marble model ids for `worldlabsWorld('marble-1.1')`.\n */\n\nexport const WORLDLABS_WORLD_MODELS = [\n  'marble-1.1-plus',\n  'marble-1.1',\n  'marble-1.0',\n  'marble-1.0-draft',\n] as const\n\nexport type WorldLabsWorldModel = (typeof WORLDLABS_WORLD_MODELS)[number]\n\nexport function isWorldLabsWorldModel(\n  model: string,\n): model is WorldLabsWorldModel {\n  return (WORLDLABS_WORLD_MODELS as ReadonlyArray<string>).includes(model)\n}\n\nexport interface WorldLabsMediaRef {\n  /** Public URL for the media. */\n  uri?: string\n  /** Id from a previous media-asset upload. */\n  mediaAssetId?: string\n  /** Base64-encoded file bytes. */\n  dataBase64?: string\n  /** File extension without a dot, used with `dataBase64`. */\n  extension?: string\n}\n\nexport interface WorldLabsLocatedImageRef extends WorldLabsMediaRef {\n  /** Horizontal angle in degrees. 0 is front, 90 is right, 180 is back. */\n  azimuth?: number\n}\n\n/**\n * Provider options for World Labs world generation.\n *\n * `createWorld` sends these on the generate request. Image, multi-image, and\n * video inputs select the matching World Labs prompt type. Text-only calls\n * use `generateWorld({ prompt })`.\n */\nexport interface WorldLabsWorldProviderOptions {\n  /** Optional title stored on the world. Max 64 characters. */\n  displayName?: string\n  /** Random seed for generation. */\n  seed?: number\n  /** Optional tags. Max 10 tags, each up to 32 characters. */\n  tags?: Array<string>\n  /** If true, use the text prompt as-is without recaptioning. */\n  disableRecaption?: boolean\n  /**\n   * How to treat a single image as a panorama. `auto` detects equirectangular\n   * panos. `true` always treats the image as a pano. `false` treats it as a\n   * standard image.\n   */\n  isPano?: 'auto' | true | false\n  /** Single image input. Do not combine with `images` or `video`. */\n  image?: WorldLabsMediaRef\n  /** Multiple images of the same scene. Do not combine with `image` or `video`. */\n  images?: Array<WorldLabsLocatedImageRef>\n  /** Video input. Do not combine with `image` or `images`. */\n  video?: WorldLabsMediaRef\n  /** World visibility. Default is private. */\n  permission?: {\n    public?: boolean\n  }\n  /**\n   * When false, return after the generate call with `status: 'waiting'` and\n   * `operationId`. Default is true: poll until the world is ready.\n   */\n  wait?: boolean\n  /** Poll interval in milliseconds when `wait` is true. Default 2000. */\n  pollIntervalMs?: number\n}\n\nexport type WorldLabsWorldModelProviderOptionsByName = {\n  [M in WorldLabsWorldModel]: WorldLabsWorldProviderOptions\n}\n"],"mappings":";;;;AAIA,IAAa,yBAAyB;CACpC;CACA;CACA;CACA;AACF;AAIA,SAAgB,sBACd,OAC8B;CAC9B,OAAQ,uBAAiD,SAAS,KAAK;AACzE"}

package/dist/esm/utils/client.d.ts

@@ -0,0 +1,16 @@
+import { Client } from '../generated/client/index.js';
+export declare const DEFAULT_WORLDLABS_API_URL = "https://api.worldlabs.ai";
+export interface WorldLabsClientConfig {
+    apiKey?: string;
+    baseUrl?: string;
+    fetch?: typeof fetch;
+    defaultHeaders?: Record<string, string>;
+}
+export declare function getWorldLabsApiKeyFromEnv(): string;
+export declare function resolveWorldLabsApiKey(config?: WorldLabsClientConfig): string;
+export declare function resolveWorldLabsApiUrl(config?: WorldLabsClientConfig): string;
+export declare function createWorldLabsClient(config?: WorldLabsClientConfig): {
+    client: Client;
+    apiKey: string;
+    baseUrl: string;
+};

package/dist/esm/utils/client.js

@@ -0,0 +1,35 @@
+import { createConfig } from "../generated/client/utils.gen.js";
+import { createClient } from "../generated/client/client.gen.js";
+import "../generated/client/index.js";
+import { getApiKeyFromEnv } from "@tanstack/ai-utils";
+//#region src/utils/client.ts
+var DEFAULT_WORLDLABS_API_URL = "https://api.worldlabs.ai";
+function getWorldLabsApiKeyFromEnv() {
+	return getApiKeyFromEnv("WORLDLABS_API_KEY");
+}
+function resolveWorldLabsApiKey(config) {
+	return config?.apiKey ?? getWorldLabsApiKeyFromEnv();
+}
+function resolveWorldLabsApiUrl(config) {
+	return (config?.baseUrl ?? "https://api.worldlabs.ai").replace(/\/+$/, "");
+}
+function createWorldLabsClient(config = {}) {
+	const apiKey = resolveWorldLabsApiKey(config);
+	const baseUrl = resolveWorldLabsApiUrl(config);
+	const fetchImpl = config.fetch ?? globalThis.fetch;
+	if (typeof fetchImpl !== "function") throw new Error("global fetch is not available. Pass `fetch` in the World Labs adapter config.");
+	return {
+		client: createClient(createConfig({
+			baseUrl,
+			auth: apiKey,
+			fetch: fetchImpl,
+			headers: config.defaultHeaders
+		})),
+		apiKey,
+		baseUrl
+	};
+}
+//#endregion
+export { DEFAULT_WORLDLABS_API_URL, createWorldLabsClient, getWorldLabsApiKeyFromEnv, resolveWorldLabsApiKey, resolveWorldLabsApiUrl };
+
+//# sourceMappingURL=client.js.map

package/dist/esm/utils/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","names":[],"sources":["../../../src/utils/client.ts"],"sourcesContent":["import { getApiKeyFromEnv } from '@tanstack/ai-utils'\nimport { createClient, createConfig } from '../generated/client/index'\nimport type { Client } from '../generated/client/index'\n\nexport const DEFAULT_WORLDLABS_API_URL = 'https://api.worldlabs.ai'\n\nexport interface WorldLabsClientConfig {\n  apiKey?: string\n  baseUrl?: string\n  fetch?: typeof fetch\n  defaultHeaders?: Record<string, string>\n}\n\nexport function getWorldLabsApiKeyFromEnv(): string {\n  return getApiKeyFromEnv('WORLDLABS_API_KEY')\n}\n\nexport function resolveWorldLabsApiKey(config?: WorldLabsClientConfig): string {\n  return config?.apiKey ?? getWorldLabsApiKeyFromEnv()\n}\n\nexport function resolveWorldLabsApiUrl(config?: WorldLabsClientConfig): string {\n  return (config?.baseUrl ?? DEFAULT_WORLDLABS_API_URL).replace(/\\/+$/, '')\n}\n\nexport function createWorldLabsClient(config: WorldLabsClientConfig = {}): {\n  client: Client\n  apiKey: string\n  baseUrl: string\n} {\n  const apiKey = resolveWorldLabsApiKey(config)\n  const baseUrl = resolveWorldLabsApiUrl(config)\n  const fetchImpl = config.fetch ?? globalThis.fetch\n  if (typeof fetchImpl !== 'function') {\n    throw new Error(\n      'global fetch is not available. Pass `fetch` in the World Labs adapter config.',\n    )\n  }\n\n  const client = createClient(\n    createConfig({\n      baseUrl,\n      auth: apiKey,\n      fetch: fetchImpl,\n      headers: config.defaultHeaders,\n    }),\n  )\n\n  return { client, apiKey, baseUrl }\n}\n"],"mappings":";;;;;AAIA,IAAa,4BAA4B;AASzC,SAAgB,4BAAoC;CAClD,OAAO,iBAAiB,mBAAmB;AAC7C;AAEA,SAAgB,uBAAuB,QAAwC;CAC7E,OAAO,QAAQ,UAAU,0BAA0B;AACrD;AAEA,SAAgB,uBAAuB,QAAwC;CAC7E,QAAQ,QAAQ,WAAA,2BAAA,CAAsC,QAAQ,QAAQ,EAAE;AAC1E;AAEA,SAAgB,sBAAsB,SAAgC,CAAC,GAIrE;CACA,MAAM,SAAS,uBAAuB,MAAM;CAC5C,MAAM,UAAU,uBAAuB,MAAM;CAC7C,MAAM,YAAY,OAAO,SAAS,WAAW;CAC7C,IAAI,OAAO,cAAc,YACvB,MAAM,IAAI,MACR,+EACF;CAYF,OAAO;EAAE,QATM,aACb,aAAa;GACX;GACA,MAAM;GACN,OAAO;GACP,SAAS,OAAO;EAClB,CAAC,CAGM;EAAQ;EAAQ;CAAQ;AACnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai-worldlabs",
-  "version": "0.0.0",
+  "version": "0.1.2",
   "description": "World Labs adapter for TanStack AI world generation (Marble).",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -13,11 +13,60 @@
   "bugs": {
     "url": "https://github.com/TanStack/ai/issues"
   },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "type": "module",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js"
+    },
+    "./byok": {
+      "types": "./dist/esm/byok.d.ts",
+      "import": "./dist/esm/byok.js"
+    }
+  },
   "files": [
-    "README.md"
+    "dist",
+    "src"
+  ],
+  "keywords": [
+    "ai",
+    "ai-sdk",
+    "typescript",
+    "tanstack",
+    "worldlabs",
+    "world labs",
+    "marble",
+    "adapter",
+    "world-generation"
   ],
-  "publishConfig": {
-    "access": "public",
-    "provenance": false
+  "dependencies": {
+    "@tanstack/ai-utils": "^0.4.1"
+  },
+  "devDependencies": {
+    "@hey-api/openapi-ts": "^0.99.0",
+    "@vitest/coverage-v8": "4.1.10",
+    "vite": "^8.2.1",
+    "@tanstack/ai": "0.63.0"
+  },
+  "peerDependencies": {
+    "@tanstack/ai": "^0.63.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "clean": "premove ./build ./dist",
+    "generate:client": "openapi-ts",
+    "lint:fix": "oxlint src --type-aware --fix",
+    "test:build": "publint --strict",
+    "test:oxlint": "oxlint src --type-aware",
+    "test:coverage": "vitest run --coverage --coverage.include='src/**' --coverage.reporter=text-summary --coverage.reporter=json-summary",
+    "test:lib": "vitest run",
+    "test:lib:dev": "pnpm test:lib --watch",
+    "test:types": "tsc"
   }
-}
+}