brandbot 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,59 @@
+import type * as THREE from 'three';
+/** A CSS color string, e.g. "#13294b". */
+export type Color = string;
+/** Where the head watches the cursor. */
+export type TrackPointer = 'window' | 'element' | false;
+/** Options for the framework-agnostic engine, `createBrandbot`. */
+export interface BrandbotOptions {
+    /** Parsed glTF JSON (e.g. `import model from 'brandbot/model'`). */
+    gltf?: unknown;
+    /** ...or a URL to a .gltf/.glb, used if `gltf` is not given. */
+    modelUrl?: string | null;
+    /** What the head watches. Default `'window'`. */
+    trackPointer?: TrackPointer;
+    /** Soft ground shadow. Default `true`. */
+    shadow?: boolean;
+    /** `false` shows the upper body only. Default `true`. */
+    legs?: boolean;
+    /** `true` lets visitors drag to rotate (for demos). Default `false`. */
+    orbit?: boolean;
+    /** One-time zoom-in when the model loads. Default `true`. */
+    intro?: boolean;
+    /** Camera framing. */
+    camera?: {
+        position: [number, number, number];
+        target: [number, number, number];
+        fov: number;
+    };
+    primary?: Color;
+    accent?: Color;
+    visor?: Color;
+    hands?: Color;
+    eyes?: Color;
+    logoText?: string;
+    logoColor?: Color;
+    /** Image logo: URL, data URI, or object URL. Overrides `logoText`. */
+    logoImage?: string | null;
+}
+/** Live updates accepted by `robot.set(...)`. */
+export type BrandbotUpdate = Partial<Pick<BrandbotOptions, 'primary' | 'accent' | 'visor' | 'hands' | 'eyes' | 'logoText' | 'logoColor' | 'logoImage' | 'legs'>>;
+/** The handle returned by `createBrandbot`. */
+export interface BrandbotInstance {
+    /** Update colors / logo / legs live. */
+    set(update?: BrandbotUpdate): BrandbotInstance;
+    /** Do one full turn. */
+    spin(): void;
+    /** Replay the zoom-in intro. */
+    replay(): void;
+    /** Tear down: stops the loop, removes listeners, frees GPU resources. */
+    dispose(): void;
+    scene: THREE.Scene;
+    camera: THREE.PerspectiveCamera;
+    renderer: THREE.WebGLRenderer;
+}
+/** Imperative handle exposed via the React component's ref. */
+export interface BrandBotHandle {
+    spin(): void;
+    replay(): void;
+    set(update?: BrandbotUpdate): void;
+}

package/dist/types.js

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

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "brandbot",
+  "version": "0.1.0",
+  "description": "🤖 A 3D robot mascot you brand with your own logo and colors — a drop-in React component with cursor tracking, built on Three.js.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+    "./core": { "types": "./dist/robot-core.d.ts", "default": "./dist/robot-core.js" },
+    "./model": "./dist/nexbot-model.js"
+  },
+  "files": ["dist", "README.md", "LICENSE", "preview.png"],
+  "sideEffects": false,
+  "homepage": "https://aidan945.github.io/brandbot/demo/",
+  "repository": { "type": "git", "url": "https://github.com/Aidan945/brandbot.git" },
+  "bugs": { "url": "https://github.com/Aidan945/brandbot/issues" },
+  "author": "Aidan Zarski",
+  "scripts": {
+    "build": "tsc && cp src/nexbot-model.js dist/nexbot-model.js && cp src/nexbot-model.d.ts dist/nexbot-model.d.ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "react": ">=17",
+    "three": ">=0.150.0"
+  },
+  "peerDependenciesMeta": {
+    "react": { "optional": true }
+  },
+  "devDependencies": {
+    "typescript": "^5.4.5",
+    "@types/react": "^18.3.3",
+    "@types/three": "^0.160.0"
+  },
+  "keywords": ["robot", "mascot", "3d", "threejs", "react", "hero", "brand", "logo", "cursor", "spline", "typescript"],
+  "license": "MIT"
+}