lunchboxjs 2.0.0-beta.2 → 2.0.0-beta.3

package/dist/cypress/e2e/camera.cy.d.ts

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

package/dist/cypress/e2e/core-events.cy.d.ts

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

package/dist/cypress/e2e/core.cy.d.ts

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

package/dist/cypress/e2e/disposal.cy.d.ts

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

package/dist/cypress/e2e/extend.cy.d.ts

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

package/dist/cypress/e2e/vue.cy.d.ts

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

package/dist/cypress/support/e2e.d.ts

@@ -0,0 +1 @@
+

package/dist/cypress.config.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="cypress" />
+declare const _default: Cypress.ConfigOptions<any>;
+export default _default;

package/dist/demo.d.ts

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

package/dist/src/auto-components.d.ts

@@ -0,0 +1,3 @@
+import * as THREE from 'three';
+/** All components that will automatically be registered when Lunchbox is initialized. */
+export declare const autoComponents: Partial<keyof typeof THREE>[];

package/dist/src/index.d.ts

@@ -0,0 +1,66 @@
+import { autoComponents } from './auto-components';
+import { IsClass } from './utils';
+
+import * as THREE from '../node_modules/@types/three';
+export * from './three-lunchbox';
+/** Every component in a Lunchbox scene is of the Lunchbox type - it contains its ThreeJS instance
+ * as a property called `instance`.
+ *
+ *
+ * ## Basic example
+ *
+ * HTML:
+ *
+ * ```html
+ * <three-mesh></three-mesh>
+ * ```
+ *
+ * TS:
+ *
+ * ```ts
+ * const mesh = document.querySelector<Lunchbox<THREE.Mesh>>('three-mesh');
+ * mesh?.instance; // this is typed as a THREE.Mesh, so you can do things like move it up:
+ * mesh?.instance.position.set(0, 1, 0); // - or anything else you can do with a mesh
+ * ```
+ */
+export type Lunchbox<T> = Element & {
+    instance: T;
+};
+/** Options for initializing Lunchbox. */
+interface LunchboxOptions {
+    /** Add THREE class names that should be registered first here. */
+    prependList?: string[];
+}
+/** Initialize Lunchbox. Required to register Lunchbox components. */
+export declare const initLunchbox: ({ prependList, }?: LunchboxOptions) => void;
+/** Create and register a custom Lunchbox component. For example:
+ *
+ * ```ts
+ * import { CustomGeometry } from 'your-custom-geometry-source';
+ * import { extend } from 'lunchboxjs';
+ *
+ * extend('custom-geometry', CustomGeometry);
+ * ```
+ *
+ * Now in your HTML, you can do:
+ *
+ * ```html
+ * <three-lunchbox>
+ *      <custom-geometry args="[0, 1, 2]"></custom-geometry>
+ * </three-lunchbox>
+ * ```
+ */
+export declare const extend: (name: string, classDefinition: IsClass, targetWindow?: Window & typeof globalThis) => void;
+export declare const THREE_POINTER_MOVE_EVENT_NAME = "threepointermove";
+export declare const THREE_MOUSE_MOVE_EVENT_NAME = "threemousemove";
+export declare const THREE_CLICK_EVENT_NAME = "threeclick";
+export type ThreeIntersectEvent = {
+    intersect: THREE.Intersection<THREE.Object3D<THREE.Object3DEventMap>>;
+    element: Element | null;
+};
+export interface InstanceEvent<T = unknown> {
+    instance: T;
+}
+export { autoComponents };
+/** The kebab-cased name of the ThreeJS web components automatically registered in Lunchbox. */
+export declare const webComponentNames: string[];

package/dist/src/parseAttributeValue.d.ts

@@ -0,0 +1 @@
+export declare const parseAttributeValue: (targetValue: unknown, element: HTMLElement) => unknown;

package/dist/src/setThreeProperty.d.ts

@@ -0,0 +1 @@
+export declare const setThreeProperty: <T extends object>(target: T, split: string[], parsedValue: unknown) => void;

package/dist/src/three-lunchbox.d.ts

@@ -0,0 +1,42 @@
+import { LitElement } from 'lit';
+
+import * as THREE from 'three';
+/** Wrapper element for ThreeLunchbox. */
+export declare class ThreeLunchbox extends LitElement {
+    private scratchV2;
+    three: {
+        scene: THREE.Scene;
+        camera: THREE.Camera | null;
+        renderer: THREE.WebGLRenderer;
+    };
+    background: THREE.ColorRepresentation | null;
+    dpr: number;
+    /** ResizeObserver to handle container sizing */
+    resizeObserver: ResizeObserver;
+    constructor();
+    /** To run on start. */
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    handleDefaultSlotChange(evt: {
+        target: HTMLSlotElement;
+    }): void;
+    raycaster: THREE.Raycaster;
+    raycastPool: THREE.Object3D[];
+    runRaycast(evt: {
+        clientX: number;
+        clientY: number;
+    }): {
+        intersect: THREE.Intersection<THREE.Object3D<THREE.Object3DEventMap>>;
+        element: Element | null;
+    }[];
+    onPointerMove(evt: PointerEvent | MouseEvent): void;
+    onClick(evt: TouchEvent | MouseEvent): void;
+    /** Container styles */
+    static styles: import('lit').CSSResult;
+    /** Render loop */
+    frame: number;
+    updateLoop(): void;
+    /** Render the 3D scene */
+    renderThree(): void;
+    render(): import('lit-html').TemplateResult<1>;
+}

package/dist/src/utils.d.ts

@@ -0,0 +1,12 @@
+/** Get potentially nested property in object */
+export declare const get: <T = unknown>(obj: any, path: string | string[], defValue?: T) => T | Record<string, any> | undefined;
+/** Check if `obj` contains a constructor */
+export declare function isClass(obj: any): obj is IsClass;
+export type IsClass<T = unknown> = {
+    new (...args: any[]): T;
+};
+/** Check if a given value is a number */
+export declare const isNumber: (value: any) => value is number;
+/** Set a potentially-nested property to a given value */
+export declare const set: (obj: Record<string, any>, path: string | string[], value: unknown) => void;
+export declare const THREE_UUID_ATTRIBUTE_NAME = "data-three-uuid";

package/dist/types.d.ts

@@ -0,0 +1,14 @@
+import { InstanceEvent, ThreeIntersectEvent } from './src/index';
+
+interface ElementEventMap {
+    'instancecreated': CustomEvent<InstanceEvent>;
+    'threepointermove': CustomEvent<ThreeIntersectEvent>;
+    'threeclick': CustomEvent<ThreeIntersectEvent>;
+}
+declare global {
+    interface HTMLElement {
+        addEventListener<K extends keyof ElementEventMap>(type: K, listener: (this: Document, ev: ElementEventMap[K]) => void): void;
+        dispatchEvent<K extends keyof ElementEventMap>(ev: ElementEventMap[K]): void;
+    }
+}
+export {};

package/dist/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vite').UserConfig;
+export default _default;

package/package.json

@@ -8,31 +8,32 @@
   "exports": {
     ".": {
       "import": "./dist/lunchboxjs.js",
-      "require": "./dist/lunchboxjs.umd.cjs"
+      "require": "./dist/lunchboxjs.umd.cjs",
+      "types": "./dist/src/index.d.ts"
     }
   },
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "type": "module",
-  "types": "./types.ts",
+  "types": "./dist/src/index.d.ts",
   "scripts": {
     "dev": "vite",
-    "build": "tsc && vite build && npm run dts",
-    "dts": "echo \"export * from '../src/';\" > ./dist/lunchboxjs.d.ts",
+    "build": "tsc && vite build",
     "preview": "vite preview",
     "cy:open": "cypress open",
     "test": "cypress run"
   },
   "dependencies": {
     "json5": "^2.2.3",
-    "lit": "^3.1.2",
-    "three": "^0.164.1"
+    "lit": "^3.1.2"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.12.7",
     "@types/three": "^0.164.0",
     "cypress": "^13.9.0",
+    "three": "^0.164.1",
     "typescript": "^5.2.2",
-    "vite": "^5.2.0"
+    "vite": "^5.2.0",
+    "vite-plugin-dts": "^3.9.1"
   }
-}
+}

package/dist/lunchboxjs.d.ts

@@ -1 +0,0 @@
-export * from '../src/';