@sharadox/globe-web-library 0.0.0-stage → 0.1.0

package/distribution/world/index.js

@@ -0,0 +1,38 @@
+"use client";
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+import { useFrame } from "@react-three/fiber";
+import { useMemo, useRef } from "react";
+import { AdditiveBlending, BackSide, MathUtils, NormalBlending, ShaderMaterial } from "three";
+import { Arc } from "@sharadox/globe-web-library/arc";
+import { Dots } from "@sharadox/globe-web-library/dots";
+import { Marker } from "@sharadox/globe-web-library/marker";
+import { ATMOSPHERE_SHADER } from "@sharadox/globe-web-library/shader/atmosphere";
+import { BODY_SHADER } from "@sharadox/globe-web-library/shader/body";
+/** The planet scene: body, atmosphere, land dots, arcs from home and markers. Rotation comes from the drag controller. */
+export function World({ data, drag, colors, home, destinations }) {
+    const group = useRef(null);
+    useFrame((_, deltaSeconds) => {
+        const planet = group.current;
+        if (!planet)
+            return;
+        const target = drag.step(deltaSeconds);
+        planet.rotation.y = MathUtils.damp(planet.rotation.y, target.y, 6, deltaSeconds);
+        planet.rotation.x = MathUtils.damp(planet.rotation.x, target.x, 6, deltaSeconds);
+    });
+    const body = useMemo(() => new ShaderMaterial({
+        vertexShader: BODY_SHADER.vertex,
+        fragmentShader: BODY_SHADER.fragment,
+        uniforms: { base: { value: colors.body }, rimColor: { value: colors.rim } },
+    }), [colors]);
+    const atmosphere = useMemo(() => new ShaderMaterial({
+        vertexShader: ATMOSPHERE_SHADER.vertex,
+        fragmentShader: ATMOSPHERE_SHADER.fragment,
+        uniforms: { strength: { value: colors.additive ? 0.42 : 0.2 }, color: { value: colors.ink } },
+        side: BackSide,
+        transparent: true,
+        blending: colors.additive ? AdditiveBlending : NormalBlending,
+        depthWrite: false,
+    }), [colors]);
+    return (_jsxs(_Fragment, { children: [_jsx("mesh", { scale: 1.16, material: atmosphere, children: _jsx("sphereGeometry", { args: [1, 64, 64] }) }), _jsxs("group", { ref: group, children: [_jsx("mesh", { material: body, children: _jsx("sphereGeometry", { args: [0.995, 96, 96] }) }), _jsx(Dots, { data: data, colors: colors }), destinations.map((place, index) => (_jsx(Arc, { from: home, to: [place.latitude, place.longitude], offset: index / destinations.length, colors: colors }, index))), destinations.map((place, index) => (_jsx(Marker, { latitude: place.latitude, longitude: place.longitude, color: colors.inkHex }, `marker${index}`))), _jsx(Marker, { latitude: home.latitude, longitude: home.longitude, color: colors.inkHex, home: true })] })] }));
+}
+//# sourceMappingURL=index.js.map

package/distribution/world/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/world/index.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AACb,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,cAAc,EAAE,cAAc,EAAc,MAAM,OAAO,CAAC;AAC1G,OAAO,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,kCAAkC,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAGtE,0HAA0H;AAC1H,MAAM,UAAU,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAmB;IAC/E,MAAM,KAAK,GAAG,MAAM,CAAQ,IAAI,CAAC,CAAC;IAClC,QAAQ,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE;QAC3B,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,MAAM;YAAE,OAAO;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;QACjF,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,OAAO,CAClB,GAAG,EAAE,CACH,IAAI,cAAc,CAAC;QACjB,YAAY,EAAE,WAAW,CAAC,MAAM;QAChC,cAAc,EAAE,WAAW,CAAC,QAAQ;QACpC,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE;KAC5E,CAAC,EACJ,CAAC,MAAM,CAAC,CACT,CAAC;IACF,MAAM,UAAU,GAAG,OAAO,CACxB,GAAG,EAAE,CACH,IAAI,cAAc,CAAC;QACjB,YAAY,EAAE,iBAAiB,CAAC,MAAM;QACtC,cAAc,EAAE,iBAAiB,CAAC,QAAQ;QAC1C,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE;QAC7F,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,IAAI;QACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,cAAc;QAC7D,UAAU,EAAE,KAAK;KAClB,CAAC,EACJ,CAAC,MAAM,CAAC,CACT,CAAC;IACF,OAAO,CACL,8BACE,eAAM,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,YACrC,yBAAgB,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAI,GAChC,EACP,iBAAO,GAAG,EAAE,KAAK,aACf,eAAM,QAAQ,EAAE,IAAI,YAClB,yBAAgB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,GAAI,GACpC,EACP,KAAC,IAAI,IAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAI,EACnC,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAClC,KAAC,GAAG,IAEF,IAAI,EAAE,IAAI,EACV,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,EACrC,MAAM,EAAE,KAAK,GAAG,YAAY,CAAC,MAAM,EACnC,MAAM,EAAE,MAAM,IAJT,KAAK,CAKV,CACH,CAAC,EACD,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAClC,KAAC,MAAM,IAAwB,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,IAA5F,SAAS,KAAK,EAAE,CAAgF,CAC9G,CAAC,EACF,KAAC,MAAM,IAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,SAAG,IACnF,IACP,CACJ,CAAC;AACJ,CAAC"}

package/distribution/world/type.d.ts

@@ -0,0 +1,15 @@
+import type { GlobeColors } from "@sharadox/globe-web-library/color/type";
+import type { GlobeDragController } from "@sharadox/globe-web-library/drag-controller/type";
+import type { Place } from "@sharadox/globe-web-library/place/type";
+export interface WorldProperties {
+    /** Float32 [latitude, longitude] land pairs. */
+    data: Float32Array;
+    /** Supplies the rotation each frame. */
+    drag: GlobeDragController;
+    colors: GlobeColors;
+    /** Where arcs start, marked with a pulsing ring. */
+    home: Place;
+    /** Where arcs go. */
+    destinations: readonly Place[];
+}
+//# sourceMappingURL=type.d.ts.map

package/distribution/world/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../source/world/type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kDAAkD,CAAC;AAC5F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wCAAwC,CAAC;AAEpE,MAAM,WAAW,eAAe;IAC9B,gDAAgD;IAChD,IAAI,EAAE,YAAY,CAAC;IACnB,wCAAwC;IACxC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,MAAM,EAAE,WAAW,CAAC;IACpB,oDAAoD;IACpD,IAAI,EAAE,KAAK,CAAC;IACZ,qBAAqB;IACrB,YAAY,EAAE,SAAS,KAAK,EAAE,CAAC;CAChC"}

package/distribution/world/type.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type.js.map

package/distribution/world/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../source/world/type.ts"],"names":[],"mappings":""}

package/llms.txt

@@ -0,0 +1,10 @@
+# @sharadox/globe-web-library
+
+> Interactive 3D dot globe for React (three.js + @react-three/fiber), client-only.
+
+- /globe: <Globe palette={{ ink, body, rim, dark }} home={{ latitude, longitude }} destinations={[...]} landPoints="/globe/land.bin" label className /> — fills positioned parent; load with next/dynamic ssr:false
+- Generate land dots: `globe-land-points public/globe/land.bin` (bin) or landPoints(topology, samples=42000, southernLimit=-60)
+- /drag-controller createDragController(initial, autoRotate) (pure); /globe-drag useGlobeDrag; /land-points useLandPoints(url)
+- /world <World> scene for custom Canvas; /color globeColors(palette)
+- CSS vars: --globe-glow, --globe-surface
+- Peer: react, react-dom. Licence: Sharadox Open Source Licence 0.1.0

package/package.json

@@ -1,6 +1,106 @@
 {
   "name": "@sharadox/globe-web-library",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "An interactive 3D dot globe for React (three.js): land dots, arcs with travelling pulses, markers, drag with inertia, auto-rotation, colours from the page, plus the land dots generator.",
+  "private": false,
+  "license": "SEE LICENSE IN LICENCA.md",
+  "author": "Sharadox <contact@sharadox.com>",
+  "type": "module",
+  "exports": {
+    "./*/type": {
+      "sharadox-source": "./source/*/type.ts",
+      "types": "./distribution/*/type.d.ts"
+    },
+    "./*": {
+      "sharadox-source": [
+        "./source/*/index.ts",
+        "./source/*/index.tsx"
+      ],
+      "types": "./distribution/*/index.d.ts",
+      "default": "./distribution/*/index.js"
+    }
+  },
+  "files": [
+    "distribution",
+    "LICENCA.md",
+    "LICENSE.md",
+    "NOTICE.md",
+    "llms.txt"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,mjs,cjs}": [
+      "prettier --write",
+      "eslint --fix --max-warnings=0"
+    ],
+    "*.{json,md,yml,yaml,scss}": "prettier --write"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Sharadox/globe-web-library.git"
+  },
+  "homepage": "https://github.com/Sharadox/globe-web-library#readme",
+  "devDependencies": {
+    "@sharadox/es-lint-configuration-web-library": "^0.1.1",
+    "@sharadox/library-build-web-library": "^0.1.1",
+    "@sharadox/prettier-configuration-web-library": "^0.1.0",
+    "@sharadox/turborepo-configuration-web-library": "^0.1.0",
+    "@sharadox/type-script-configuration-web-library": "^0.2.0",
+    "@sharadox/vitest-configuration-web-library": "^0.1.2",
+    "@testing-library/dom": "^10.4.2",
+    "@testing-library/react": "^16.3.3",
+    "@types/d3-geo": "^3.1.1",
+    "@types/node": "^24.19.2",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "@types/three": "^0.187.0",
+    "@types/topojson-client": "^3.1.5",
+    "@types/topojson-specification": "^1.0.5",
+    "@vitest/coverage-v8": "^5.1.0",
+    "eslint": "9.39.5",
+    "happy-dom": "^21.0.4",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.6.0",
+    "prettier": "^3.10.0",
+    "react": "^19.3.1",
+    "react-dom": "^19.3.1",
+    "turbo": "^2.11.10",
+    "typedoc": "^0.28.20",
+    "typescript": "6.0.3",
+    "vitest": "^5.1.0"
+  },
+  "dependencies": {
+    "@react-three/fiber": "^9.8.2",
+    "@sharadox/web-library": "^0.5.0",
+    "d3-geo": "^3.1.2",
+    "three": "^0.180.0",
+    "topojson-client": "^3.1.0",
+    "world-atlas": "^2.0.2"
+  },
+  "peerDependencies": {
+    "react": ">=19",
+    "react-dom": ">=19"
+  },
+  "bin": {
+    "globe-land-points": "./distribution/land-point-generator/entry/index.js"
+  },
+  "scripts": {
+    "build": "library-build",
+    "lint": "eslint --max-warnings=0 .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "type-check": "tsc --noEmit",
+    "test:unit": "vitest run --coverage",
+    "documentation": "typedoc",
+    "verify": "turbo run format:check lint type-check test:unit build",
+    "test:benchmark": "vitest bench --run --passWithNoTests"
+  }
 }