@octostar/map-component 0.1.2

package/LICENSE

@@ -0,0 +1,18 @@
+PROPRIETARY LICENSE
+
+Copyright (c) 2025 Octostar Limited. All rights reserved.
+
+This software and associated documentation files (the "Software") are the
+proprietary property of Octostar Limited. Unauthorized copying, modification,
+distribution, or use of this Software, via any medium, is strictly prohibited.
+
+The Software is provided to authorized users only under separate agreement.
+No license, express or implied, is granted to any party except as explicitly
+provided in writing by Octostar Limited.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+OCTOSTAR LIMITED BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
+OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,110 @@
+# @octostar/map-component
+
+A powerful MapLibre-based map editor component for React applications. Provides drawing tools, layer management, timeline filtering, and more.
+
+> **⚠️ Proprietary Software**: This package is proprietary to Octostar Limited. Unauthorized use is prohibited.
+
+## Prerequisites
+
+- Node.js 20+ (see `.nvmrc`)
+- pnpm 9+
+- GitHub account with access to the octostar organization
+
+### Using nvm
+
+If you use [nvm](https://github.com/nvm-sh/nvm) to manage Node.js versions:
+
+```bash
+# Install the correct Node.js version
+nvm install
+
+# Use the correct Node.js version
+nvm use
+```
+
+## Development Setup
+
+Clone the repo and install dependencies:
+
+```bash
+pnpm install
+```
+
+Start the development server with the demo app:
+
+```bash
+pnpm dev
+```
+
+## Building
+
+```bash
+pnpm build:lib
+```
+
+This outputs:
+- `dist/index.mjs` - ES module
+- `dist/index.cjs` - CommonJS module
+- `dist/types/` - TypeScript declarations
+- `dist/styles.css` - Component styles
+
+## Usage (as a package)
+
+```tsx
+import { MapEditorCanvas } from '@octostar/map-component';
+import '@octostar/map-component/styles.css';
+
+function App() {
+  return (
+    <MapEditorCanvas
+      enableDrawing
+      enableLayers
+      initialCenter={[-0.1276, 51.5074]} // London
+      initialZoom={10}
+      onFeatureCreate={(feature) => console.log('Created:', feature)}
+      onFeatureSelect={(features) => console.log('Selected:', features)}
+    />
+  );
+}
+```
+
+## Main Components
+
+| Component | Description |
+|-----------|-------------|
+| `MapEditorCanvas` | Main map component with drawing, selection, and layer support |
+| `LayersPanel` | UI panel for managing map layers |
+| `DrawingToolbar` | Toolbar with drawing and selection tools |
+| `PropertiesPanel` | Panel for editing feature properties |
+| `Timebar` | Timeline component for temporal filtering |
+
+## Configuration Options
+
+```tsx
+<MapEditorCanvas
+  // Feature flags
+  enableDrawing={true}
+  enableLayers={true}
+  enableTimeline={true}
+  enableMeasurement={true}
+  enableSelection={true}
+  
+  // Initial state
+  initialCenter={[lng, lat]}
+  initialZoom={10}
+  baseMapStyle="streets" // 'streets' | 'satellite' | 'terrain' | 'dark'
+  
+  // Callbacks
+  onFeatureCreate={(feature) => {}}
+  onFeatureUpdate={(feature) => {}}
+  onFeatureDelete={(featureIds) => {}}
+  onFeatureSelect={(features) => {}}
+  onLayerChange={(layers) => {}}
+  onViewportChange={(viewport) => {}}
+  onMapReady={() => {}}
+/>
+```
+
+## License
+
+Proprietary - Octostar Limited. See [LICENSE](./LICENSE) for details.