@gemmology/mineral-data 1.0.0

package/index.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @gemmology/mineral-data
+ *
+ * Pre-built SQLite database of 94+ mineral presets with CDL,
+ * gemmological properties, and pre-generated 3D models.
+ */
+
+/**
+ * Absolute path to the minerals.db SQLite database file.
+ * Use this for Node.js SQLite libraries like better-sqlite3.
+ */
+export const dbPath: string;
+
+/**
+ * Load the database as an ArrayBuffer for use with sql.js in browsers.
+ *
+ * @returns Promise resolving to database file as ArrayBuffer
+ */
+export function dbBuffer(): Promise<ArrayBuffer>;
+
+/**
+ * Load the database synchronously as a Buffer.
+ *
+ * @returns Database file as Node.js Buffer
+ */
+export function dbBufferSync(): Buffer;
+
+/**
+ * Database schema interface for the minerals table.
+ */
+export interface MineralRecord {
+  id: string;
+  name: string;
+  cdl: string;
+  system: string;
+  point_group: string;
+  chemistry: string;
+  hardness: string | null;
+  description: string | null;
+  sg: string | null;
+  ri: string | null;
+  birefringence: number | null;
+  optical_character: string | null;
+  dispersion: number | null;
+  lustre: string | null;
+  cleavage: string | null;
+  fracture: string | null;
+  pleochroism: string | null;
+  twin_law: string | null;
+  phenomenon: string | null;
+  note: string | null;
+  localities_json: string | null;
+  forms_json: string | null;
+  colors_json: string | null;
+  treatments_json: string | null;
+  inclusions_json: string | null;
+  /** Pre-generated SVG markup */
+  model_svg: string | null;
+  /** Pre-generated binary STL data */
+  model_stl: ArrayBuffer | null;
+  /** Pre-generated glTF JSON */
+  model_gltf: string | null;
+  /** ISO timestamp when models were generated */
+  models_generated_at: string | null;
+}

package/index.js

@@ -0,0 +1,51 @@
+/**
+ * @gemmology/mineral-data
+ *
+ * Pre-built SQLite database of 94+ mineral presets with CDL (Crystal Description Language),
+ * gemmological properties, and pre-generated 3D models (SVG, STL, glTF).
+ *
+ * Usage:
+ *   import { dbPath, dbBuffer } from '@gemmology/mineral-data';
+ *
+ *   // For Node.js file-based access
+ *   const db = new Database(dbPath);
+ *
+ *   // For browser/sql.js usage
+ *   const buffer = await dbBuffer();
+ *   const db = new SQL.Database(new Uint8Array(buffer));
+ */
+
+const path = require('path');
+const fs = require('fs');
+
+/**
+ * Absolute path to the minerals.db SQLite database file.
+ * Use this for Node.js SQLite libraries like better-sqlite3.
+ *
+ * @type {string}
+ */
+const dbPath = path.join(__dirname, 'minerals.db');
+
+/**
+ * Load the database as an ArrayBuffer for use with sql.js in browsers.
+ *
+ * @returns {Promise<ArrayBuffer>} Database file as ArrayBuffer
+ */
+async function dbBuffer() {
+  return fs.promises.readFile(dbPath).then(buf => buf.buffer);
+}
+
+/**
+ * Load the database synchronously as a Buffer.
+ *
+ * @returns {Buffer} Database file as Node.js Buffer
+ */
+function dbBufferSync() {
+  return fs.readFileSync(dbPath);
+}
+
+module.exports = {
+  dbPath,
+  dbBuffer,
+  dbBufferSync,
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@gemmology/mineral-data",
+  "version": "1.0.0",
+  "description": "Pre-built SQLite database of 94+ mineral presets with CDL, properties, and 3D models for crystal visualization",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "minerals.db"
+  ],
+  "keywords": [
+    "crystal",
+    "mineralogy",
+    "gemmology",
+    "cdl",
+    "sqlite",
+    "3d-models",
+    "svg",
+    "stl",
+    "gltf"
+  ],
+  "author": "Fabian Schuh <fabian@gemmology.dev>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gemmology-dev/mineral-database.git"
+  },
+  "homepage": "https://gemmology.dev",
+  "bugs": {
+    "url": "https://github.com/gemmology-dev/mineral-database/issues"
+  },
+  "engines": {
+    "node": ">=16"
+  }
+}