@scenography/plugin-model 0.2.0

package/dist/data-CHJeJEc2.mjs

@@ -0,0 +1,21 @@
+import { existsProp, isFiniteNumber, isVec3, propIs, validate } from "@scenography/scene";
+//#region src/data/validate.ts
+const validateModel = (model) => validate([
+	existsProp("id", "Model is missing an id."),
+	existsProp("src", "Model is missing a src."),
+	propIs("position", isVec3, "position must be a [x, y, z] triple."),
+	propIs("rotation", isVec3, "rotation must be a [x, y, z] triple."),
+	propIs("scale", (v) => isFiniteNumber(v) || isVec3(v), "scale must be a number or a [x, y, z] triple.")
+])(model);
+//#endregion
+//#region src/data/plugin.ts
+/** The data half of the model plugin: owns the `models` scene key (a collection). */
+const modelData = {
+	kind: "models",
+	cardinality: "many",
+	validate: (model) => validateModel(model)
+};
+//#endregion
+export { validateModel as n, modelData as t };
+
+//# sourceMappingURL=data-CHJeJEc2.mjs.map

package/dist/data-CHJeJEc2.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-CHJeJEc2.mjs","names":[],"sources":["../src/data/validate.ts","../src/data/plugin.ts"],"sourcesContent":["import {\n  existsProp,\n  isFiniteNumber,\n  isVec3,\n  propIs,\n  validate,\n  type ValidationResult,\n} from \"@scenography/scene\";\n\nimport type { Model } from \"./model\";\n\nexport const validateModel = (model: Model): ValidationResult =>\n  validate<Model>([\n    existsProp(\"id\", \"Model is missing an id.\"),\n    existsProp(\"src\", \"Model is missing a src.\"),\n    propIs(\"position\", isVec3, \"position must be a [x, y, z] triple.\"),\n    propIs(\"rotation\", isVec3, \"rotation must be a [x, y, z] triple.\"),\n    propIs(\n      \"scale\",\n      (v) => isFiniteNumber(v) || isVec3(v),\n      \"scale must be a number or a [x, y, z] triple.\",\n    ),\n  ])(model);\n","import type { DataPlugin } from \"@scenography/scene\";\n\nimport { validateModel } from \"./validate\";\nimport type { Model } from \"./model\";\n\n/** The data half of the model plugin: owns the `models` scene key (a collection). */\nexport const modelData: DataPlugin<Model> = {\n  kind: \"models\",\n  cardinality: \"many\",\n  validate: (model) => validateModel(model),\n};\n"],"mappings":";;AAWA,MAAa,iBAAiB,UAC5B,SAAgB;CACd,WAAW,MAAM,yBAAyB;CAC1C,WAAW,OAAO,yBAAyB;CAC3C,OAAO,YAAY,QAAQ,sCAAsC;CACjE,OAAO,YAAY,QAAQ,sCAAsC;CACjE,OACE,UACC,MAAM,eAAe,CAAC,KAAK,OAAO,CAAC,GACpC,+CACF;AACF,CAAC,CAAC,CAAC,KAAK;;;;AChBV,MAAa,YAA+B;CAC1C,MAAM;CACN,aAAa;CACb,WAAW,UAAU,cAAc,KAAK;AAC1C"}

package/dist/data-tK2hlhyq.cjs

@@ -0,0 +1,32 @@
+let _scenography_scene = require("@scenography/scene");
+//#region src/data/validate.ts
+const validateModel = (model) => (0, _scenography_scene.validate)([
+	(0, _scenography_scene.existsProp)("id", "Model is missing an id."),
+	(0, _scenography_scene.existsProp)("src", "Model is missing a src."),
+	(0, _scenography_scene.propIs)("position", _scenography_scene.isVec3, "position must be a [x, y, z] triple."),
+	(0, _scenography_scene.propIs)("rotation", _scenography_scene.isVec3, "rotation must be a [x, y, z] triple."),
+	(0, _scenography_scene.propIs)("scale", (v) => (0, _scenography_scene.isFiniteNumber)(v) || (0, _scenography_scene.isVec3)(v), "scale must be a number or a [x, y, z] triple.")
+])(model);
+//#endregion
+//#region src/data/plugin.ts
+/** The data half of the model plugin: owns the `models` scene key (a collection). */
+const modelData = {
+	kind: "models",
+	cardinality: "many",
+	validate: (model) => validateModel(model)
+};
+//#endregion
+Object.defineProperty(exports, "modelData", {
+	enumerable: true,
+	get: function() {
+		return modelData;
+	}
+});
+Object.defineProperty(exports, "validateModel", {
+	enumerable: true,
+	get: function() {
+		return validateModel;
+	}
+});
+
+//# sourceMappingURL=data-tK2hlhyq.cjs.map

package/dist/data-tK2hlhyq.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-tK2hlhyq.cjs","names":["isVec3"],"sources":["../src/data/validate.ts","../src/data/plugin.ts"],"sourcesContent":["import {\n  existsProp,\n  isFiniteNumber,\n  isVec3,\n  propIs,\n  validate,\n  type ValidationResult,\n} from \"@scenography/scene\";\n\nimport type { Model } from \"./model\";\n\nexport const validateModel = (model: Model): ValidationResult =>\n  validate<Model>([\n    existsProp(\"id\", \"Model is missing an id.\"),\n    existsProp(\"src\", \"Model is missing a src.\"),\n    propIs(\"position\", isVec3, \"position must be a [x, y, z] triple.\"),\n    propIs(\"rotation\", isVec3, \"rotation must be a [x, y, z] triple.\"),\n    propIs(\n      \"scale\",\n      (v) => isFiniteNumber(v) || isVec3(v),\n      \"scale must be a number or a [x, y, z] triple.\",\n    ),\n  ])(model);\n","import type { DataPlugin } from \"@scenography/scene\";\n\nimport { validateModel } from \"./validate\";\nimport type { Model } from \"./model\";\n\n/** The data half of the model plugin: owns the `models` scene key (a collection). */\nexport const modelData: DataPlugin<Model> = {\n  kind: \"models\",\n  cardinality: \"many\",\n  validate: (model) => validateModel(model),\n};\n"],"mappings":";;AAWA,MAAa,iBAAiB,WAAA,GAAA,mBAAA,SAAA,CACZ;oCACH,MAAM,yBAAyB;oCAC/B,OAAO,yBAAyB;gCACpC,YAAYA,mBAAAA,QAAQ,sCAAsC;gCAC1D,YAAYA,mBAAAA,QAAQ,sCAAsC;gCAE/D,UACC,OAAA,GAAA,mBAAA,eAAA,CAAqB,CAAC,MAAA,GAAA,mBAAA,OAAA,CAAY,CAAC,GACpC,+CACF;AACF,CAAC,CAAC,CAAC,KAAK;;;;AChBV,MAAa,YAA+B;CAC1C,MAAM;CACN,aAAa;CACb,WAAW,UAAU,cAAc,KAAK;AAC1C"}

package/dist/data.cjs

@@ -0,0 +1,4 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_data = require("./data-tK2hlhyq.cjs");
+exports.modelData = require_data.modelData;
+exports.validateModel = require_data.validateModel;

package/dist/data.d.cts

@@ -0,0 +1,2 @@
+import { n as validateModel, r as Model, t as modelData } from "./index-B1oVLmLG.cjs";
+export { type Model, modelData, validateModel };

package/dist/data.d.mts

@@ -0,0 +1,2 @@
+import { n as validateModel, r as Model, t as modelData } from "./index-B1oVLmLG.mjs";
+export { type Model, modelData, validateModel };

package/dist/data.mjs

@@ -0,0 +1,2 @@
+import { n as validateModel, t as modelData } from "./data-CHJeJEc2.mjs";
+export { modelData, validateModel };

package/dist/index-B1oVLmLG.d.cts

@@ -0,0 +1,39 @@
+import { DataPlugin, ValidationResult, Vec3 } from "@scenography/scene";
+
+//#region src/data/model.d.ts
+/**
+ * An external 3D model placed in the space — a glTF/GLB asset (chairs, plinths,
+ * sculptures…). Pure data: the URL plus a transform. The runtime loads the file
+ * and materializes it; relative URIs inside the glTF (`.bin`, textures) resolve
+ * against `src`.
+ *
+ * Note on units: glTF files are authored in meters, while scenes here use
+ * centimeter-ish world units. Use `scale` (e.g. `100`) to bridge the two.
+ */
+interface Model {
+  id: string;
+  /** URL of the glTF/GLB file. */
+  src: string;
+  /** World position `[x, y, z]`. Defaults to the origin. */
+  position?: Vec3;
+  /** Rotation in radians `[x, y, z]`. Defaults to no rotation. */
+  rotation?: Vec3;
+  /** Uniform scale (number) or per-axis `[x, y, z]`. Defaults to `1`. */
+  scale?: number | Vec3;
+}
+declare module "@scenography/scene" {
+  interface Scene {
+    /** External 3D models (glTF/GLB) placed in the space — from `@scenography/plugin-model`. */
+    models?: Model[];
+  }
+}
+//#endregion
+//#region src/data/validate.d.ts
+declare const validateModel: (model: Model) => ValidationResult;
+//#endregion
+//#region src/data/plugin.d.ts
+/** The data half of the model plugin: owns the `models` scene key (a collection). */
+declare const modelData: DataPlugin<Model>;
+//#endregion
+export { validateModel as n, Model as r, modelData as t };
+//# sourceMappingURL=index-B1oVLmLG.d.cts.map

package/dist/index-B1oVLmLG.d.mts

@@ -0,0 +1,39 @@
+import { DataPlugin, ValidationResult, Vec3 } from "@scenography/scene";
+
+//#region src/data/model.d.ts
+/**
+ * An external 3D model placed in the space — a glTF/GLB asset (chairs, plinths,
+ * sculptures…). Pure data: the URL plus a transform. The runtime loads the file
+ * and materializes it; relative URIs inside the glTF (`.bin`, textures) resolve
+ * against `src`.
+ *
+ * Note on units: glTF files are authored in meters, while scenes here use
+ * centimeter-ish world units. Use `scale` (e.g. `100`) to bridge the two.
+ */
+interface Model {
+  id: string;
+  /** URL of the glTF/GLB file. */
+  src: string;
+  /** World position `[x, y, z]`. Defaults to the origin. */
+  position?: Vec3;
+  /** Rotation in radians `[x, y, z]`. Defaults to no rotation. */
+  rotation?: Vec3;
+  /** Uniform scale (number) or per-axis `[x, y, z]`. Defaults to `1`. */
+  scale?: number | Vec3;
+}
+declare module "@scenography/scene" {
+  interface Scene {
+    /** External 3D models (glTF/GLB) placed in the space — from `@scenography/plugin-model`. */
+    models?: Model[];
+  }
+}
+//#endregion
+//#region src/data/validate.d.ts
+declare const validateModel: (model: Model) => ValidationResult;
+//#endregion
+//#region src/data/plugin.d.ts
+/** The data half of the model plugin: owns the `models` scene key (a collection). */
+declare const modelData: DataPlugin<Model>;
+//#endregion
+export { validateModel as n, Model as r, modelData as t };
+//# sourceMappingURL=index-B1oVLmLG.d.mts.map

package/dist/index.cjs

@@ -0,0 +1,43 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_data = require("./data-tK2hlhyq.cjs");
+let three = require("three");
+//#region src/buildModel.ts
+/**
+* Build the three.js object for an external `Model`. Returns an empty `Group`
+* with the transform applied immediately; the glTF/GLB is fetched async and its
+* scene added once ready (same pattern as texture loading). `GLTFLoader` is
+* imported on demand so it only ships in the bundle when a scene uses models.
+*/
+function buildModel(model) {
+	const group = new three.Group();
+	group.name = `model:${model.id}`;
+	group.userData.scenographyId = model.id;
+	if (model.position) group.position.set(...model.position);
+	if (model.rotation) group.rotation.set(...model.rotation);
+	if (model.scale !== void 0) if (typeof model.scale === "number") group.scale.setScalar(model.scale);
+	else group.scale.set(...model.scale);
+	import("three/examples/jsm/loaders/GLTFLoader.js").then(({ GLTFLoader }) => {
+		new GLTFLoader().load(model.src, (gltf) => {
+			gltf.scene.traverse((child) => {
+				child.castShadow = true;
+				child.receiveShadow = true;
+			});
+			group.add(gltf.scene);
+		});
+	});
+	return group;
+}
+//#endregion
+//#region src/plugin.ts
+/** The model plugin: places each external glTF/GLB `Model` in the scene. */
+const model = () => ({
+	data: require_data.modelData,
+	build: (definition) => ({ object: buildModel(definition) })
+});
+//#endregion
+exports.buildModel = buildModel;
+exports.model = model;
+exports.modelData = require_data.modelData;
+exports.validateModel = require_data.validateModel;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["Group","modelData"],"sources":["../src/buildModel.ts","../src/plugin.ts"],"sourcesContent":["import { Group, type Object3D } from \"three\";\n\nimport type { Model } from \"./data\";\n\n/**\n * Build the three.js object for an external `Model`. Returns an empty `Group`\n * with the transform applied immediately; the glTF/GLB is fetched async and its\n * scene added once ready (same pattern as texture loading). `GLTFLoader` is\n * imported on demand so it only ships in the bundle when a scene uses models.\n */\nexport function buildModel(model: Model): Object3D {\n  const group = new Group();\n  group.name = `model:${model.id}`;\n  group.userData.scenographyId = model.id;\n\n  if (model.position) group.position.set(...model.position);\n  if (model.rotation) group.rotation.set(...model.rotation);\n  if (model.scale !== undefined) {\n    if (typeof model.scale === \"number\") group.scale.setScalar(model.scale);\n    else group.scale.set(...model.scale);\n  }\n\n  void import(\"three/examples/jsm/loaders/GLTFLoader.js\").then(({ GLTFLoader }) => {\n    new GLTFLoader().load(model.src, (gltf) => {\n      gltf.scene.traverse((child) => {\n        child.castShadow = true;\n        child.receiveShadow = true;\n      });\n      group.add(gltf.scene);\n    });\n  });\n\n  return group;\n}\n","import type { EnginePlugin } from \"@scenography/engine\";\n\nimport { buildModel } from \"./buildModel\";\nimport { modelData, type Model } from \"./data\";\n\n/** The model plugin: places each external glTF/GLB `Model` in the scene. */\nexport const model = (): EnginePlugin<Model> => ({\n  data: modelData,\n  build: (definition) => ({ object: buildModel(definition) }),\n});\n"],"mappings":";;;;;;;;;;AAUA,SAAgB,WAAW,OAAwB;CACjD,MAAM,QAAQ,IAAIA,MAAAA,MAAM;CACxB,MAAM,OAAO,SAAS,MAAM;CAC5B,MAAM,SAAS,gBAAgB,MAAM;CAErC,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,KAAA,GAClB,IAAI,OAAO,MAAM,UAAU,UAAU,MAAM,MAAM,UAAU,MAAM,KAAK;MACjE,MAAM,MAAM,IAAI,GAAG,MAAM,KAAK;CAGrC,OAAY,2CAA2C,CAAC,MAAM,EAAE,iBAAiB;EAC/E,IAAI,WAAW,CAAC,CAAC,KAAK,MAAM,MAAM,SAAS;GACzC,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,aAAa;IACnB,MAAM,gBAAgB;GACxB,CAAC;GACD,MAAM,IAAI,KAAK,KAAK;EACtB,CAAC;CACH,CAAC;CAED,OAAO;AACT;;;;AC3BA,MAAa,eAAoC;CAC/C,MAAMC,aAAAA;CACN,QAAQ,gBAAgB,EAAE,QAAQ,WAAW,UAAU,EAAE;AAC3D"}

package/dist/index.d.cts

@@ -0,0 +1,19 @@
+import { n as validateModel, r as Model, t as modelData } from "./index-B1oVLmLG.cjs";
+import { EnginePlugin } from "@scenography/engine";
+import { Object3D } from "three";
+
+//#region src/plugin.d.ts
+/** The model plugin: places each external glTF/GLB `Model` in the scene. */
+declare const model: () => EnginePlugin<Model>;
+//#endregion
+//#region src/buildModel.d.ts
+/**
+ * Build the three.js object for an external `Model`. Returns an empty `Group`
+ * with the transform applied immediately; the glTF/GLB is fetched async and its
+ * scene added once ready (same pattern as texture loading). `GLTFLoader` is
+ * imported on demand so it only ships in the bundle when a scene uses models.
+ */
+declare function buildModel(model: Model): Object3D;
+//#endregion
+export { type Model, buildModel, model, modelData, validateModel };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -0,0 +1,19 @@
+import { n as validateModel, r as Model, t as modelData } from "./index-B1oVLmLG.mjs";
+import { Object3D } from "three";
+import { EnginePlugin } from "@scenography/engine";
+
+//#region src/plugin.d.ts
+/** The model plugin: places each external glTF/GLB `Model` in the scene. */
+declare const model: () => EnginePlugin<Model>;
+//#endregion
+//#region src/buildModel.d.ts
+/**
+ * Build the three.js object for an external `Model`. Returns an empty `Group`
+ * with the transform applied immediately; the glTF/GLB is fetched async and its
+ * scene added once ready (same pattern as texture loading). `GLTFLoader` is
+ * imported on demand so it only ships in the bundle when a scene uses models.
+ */
+declare function buildModel(model: Model): Object3D;
+//#endregion
+export { type Model, buildModel, model, modelData, validateModel };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,39 @@
+import { n as validateModel, t as modelData } from "./data-CHJeJEc2.mjs";
+import { Group } from "three";
+//#region src/buildModel.ts
+/**
+* Build the three.js object for an external `Model`. Returns an empty `Group`
+* with the transform applied immediately; the glTF/GLB is fetched async and its
+* scene added once ready (same pattern as texture loading). `GLTFLoader` is
+* imported on demand so it only ships in the bundle when a scene uses models.
+*/
+function buildModel(model) {
+	const group = new Group();
+	group.name = `model:${model.id}`;
+	group.userData.scenographyId = model.id;
+	if (model.position) group.position.set(...model.position);
+	if (model.rotation) group.rotation.set(...model.rotation);
+	if (model.scale !== void 0) if (typeof model.scale === "number") group.scale.setScalar(model.scale);
+	else group.scale.set(...model.scale);
+	import("three/examples/jsm/loaders/GLTFLoader.js").then(({ GLTFLoader }) => {
+		new GLTFLoader().load(model.src, (gltf) => {
+			gltf.scene.traverse((child) => {
+				child.castShadow = true;
+				child.receiveShadow = true;
+			});
+			group.add(gltf.scene);
+		});
+	});
+	return group;
+}
+//#endregion
+//#region src/plugin.ts
+/** The model plugin: places each external glTF/GLB `Model` in the scene. */
+const model = () => ({
+	data: modelData,
+	build: (definition) => ({ object: buildModel(definition) })
+});
+//#endregion
+export { buildModel, model, modelData, validateModel };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/buildModel.ts","../src/plugin.ts"],"sourcesContent":["import { Group, type Object3D } from \"three\";\n\nimport type { Model } from \"./data\";\n\n/**\n * Build the three.js object for an external `Model`. Returns an empty `Group`\n * with the transform applied immediately; the glTF/GLB is fetched async and its\n * scene added once ready (same pattern as texture loading). `GLTFLoader` is\n * imported on demand so it only ships in the bundle when a scene uses models.\n */\nexport function buildModel(model: Model): Object3D {\n  const group = new Group();\n  group.name = `model:${model.id}`;\n  group.userData.scenographyId = model.id;\n\n  if (model.position) group.position.set(...model.position);\n  if (model.rotation) group.rotation.set(...model.rotation);\n  if (model.scale !== undefined) {\n    if (typeof model.scale === \"number\") group.scale.setScalar(model.scale);\n    else group.scale.set(...model.scale);\n  }\n\n  void import(\"three/examples/jsm/loaders/GLTFLoader.js\").then(({ GLTFLoader }) => {\n    new GLTFLoader().load(model.src, (gltf) => {\n      gltf.scene.traverse((child) => {\n        child.castShadow = true;\n        child.receiveShadow = true;\n      });\n      group.add(gltf.scene);\n    });\n  });\n\n  return group;\n}\n","import type { EnginePlugin } from \"@scenography/engine\";\n\nimport { buildModel } from \"./buildModel\";\nimport { modelData, type Model } from \"./data\";\n\n/** The model plugin: places each external glTF/GLB `Model` in the scene. */\nexport const model = (): EnginePlugin<Model> => ({\n  data: modelData,\n  build: (definition) => ({ object: buildModel(definition) }),\n});\n"],"mappings":";;;;;;;;;AAUA,SAAgB,WAAW,OAAwB;CACjD,MAAM,QAAQ,IAAI,MAAM;CACxB,MAAM,OAAO,SAAS,MAAM;CAC5B,MAAM,SAAS,gBAAgB,MAAM;CAErC,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,KAAA,GAClB,IAAI,OAAO,MAAM,UAAU,UAAU,MAAM,MAAM,UAAU,MAAM,KAAK;MACjE,MAAM,MAAM,IAAI,GAAG,MAAM,KAAK;CAGrC,OAAY,2CAA2C,CAAC,MAAM,EAAE,iBAAiB;EAC/E,IAAI,WAAW,CAAC,CAAC,KAAK,MAAM,MAAM,SAAS;GACzC,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,aAAa;IACnB,MAAM,gBAAgB;GACxB,CAAC;GACD,MAAM,IAAI,KAAK,KAAK;EACtB,CAAC;CACH,CAAC;CAED,OAAO;AACT;;;;AC3BA,MAAa,eAAoC;CAC/C,MAAM;CACN,QAAQ,gBAAgB,EAAE,QAAQ,WAAW,UAAU,EAAE;AAC3D"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@scenography/plugin-model",
+  "version": "0.2.0",
+  "description": "Model plugin for scenography: external glTF/GLB models placed in the space.",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./data": {
+      "import": {
+        "types": "./dist/data.d.mts",
+        "default": "./dist/data.mjs"
+      },
+      "require": {
+        "types": "./dist/data.d.cts",
+        "default": "./dist/data.cjs"
+      }
+    }
+  },
+  "dependencies": {
+    "@scenography/scene": "0.2.0"
+  },
+  "devDependencies": {
+    "@types/three": "^0.160.0",
+    "three": "^0.160.0",
+    "@scenography/engine": "0.2.0"
+  },
+  "peerDependencies": {
+    "three": ">=0.160.0",
+    "@scenography/engine": "0.2.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}