alizarin 1.0.0 → 2.0.0-alpha.87

package/README.md

@@ -2,8 +2,126 @@
 
 # Alizarin
 
-This is a pure JS/TS implementation of [AORM](https://github.com/flaxandteal/arches-orm/)
-for front or backend.
+A high-performance TypeScript/JavaScript SDK for working with [Arches](https://www.archesproject.org/) data management systems. Alizarin provides a sophisticated object-relational mapping (ORM) layer that enables seamless interaction with Arches' graph-based data models.
+
+This is a pure JS/TS implementation of [AORM](https://github.com/flaxandteal/arches-orm/) for front or backend.
+
+## Features
+
+- **Universal Compatibility**: Works in both browser and Node.js environments
+- **Type-Safe**: Full TypeScript support with comprehensive type definitions
+- **Lazy Loading**: Optimized data fetching with on-demand tile loading
+- **Graph-Based ORM**: Intuitive API for working with Arches' complex graph structures
+- **Multiple Data Sources**: Support for remote servers, static JSON files, and local data
+- **Internationalization**: Built-in support for multilingual content
+- **Schema Manipulation**: Programmatically create and modify graph schemas
+- **Caching**: Intelligent caching for improved performance
+
+## Goals
+
+Alizarin aims to:
+
+1. **Simplify Arches Development**: Provide an intuitive, developer-friendly interface to Arches' complex data models
+2. **Enable Modern Web Applications**: Support building reactive, performant front-end applications with Arches data
+3. **Maintain Flexibility**: Work with any Arches instance without requiring server-side modifications
+4. **Ensure Type Safety**: Leverage TypeScript to catch errors early and improve developer experience
+5. **Optimize Performance**: Minimize network requests and memory usage through intelligent caching and lazy loading
+
+## Installation
+
+```bash
+npm install alizarin
+```
+
+## Quick Start
+
+### Basic Usage
+
+```typescript
+import { ArchesClientRemote, GraphManager } from 'alizarin';
+
+// Connect to an Arches instance
+const client = new ArchesClientRemote('https://your-arches-instance.org');
+const graphManager = new GraphManager(client);
+
+// Load a resource model
+const MonumentModel = await graphManager.loadGraph('Monument');
+
+// Query all monuments
+const monuments = await MonumentModel.all();
+
+// Access monument data
+for (const monument of monuments) {
+  console.log(monument.name);
+  console.log(monument.constructionDate);
+  console.log(monument.heritage_status?.prefLabel);
+}
+```
+
+### Working with Static Data
+
+```typescript
+import { ArchesClientRemoteStatic, GraphManager } from 'alizarin';
+
+// Load from static JSON exports
+const client = new ArchesClientRemoteStatic('/data/exports');
+const graphManager = new GraphManager(client);
+
+// Usage is identical to remote client
+const PersonModel = await graphManager.loadGraph('Person');
+```
+
+### Creating Resources
+
+```typescript
+const PersonModel = await graphManager.loadGraph('Person');
+
+// Create a new person
+const newPerson = PersonModel.create();
+newPerson.forename = "Jane";
+newPerson.surname = "Smith";
+newPerson.birthDate = new Date(1990, 5, 15);
+```
+
+## API Reference
+
+### Client Classes
+
+- `ArchesClient` - Abstract base class for all clients
+- `ArchesClientRemote` - Connect to live Arches servers
+- `ArchesClientRemoteStatic` - Load from static JSON files
+- `ArchesClientLocal` - Load from local filesystem (Node.js)
+
+### Core Classes
+
+- `GraphManager` - Central manager for graphs and resources
+- `ResourceModelWrapper` - ORM wrapper for resource models
+- `ResourceInstanceViewModel` - View model for resource instances
+- `GraphMutator` - Tool for modifying graph schemas
+
+### View Model Types
+
+- `StringViewModel` - String values
+- `NumberViewModel` - Numeric values
+- `DateViewModel` - Date/time values
+- `ConceptValueViewModel` - Controlled vocabulary concepts
+- `GeojsonFeatureCollectionViewModel` - Geographic data
+- `ResourceInstanceListViewModel` - Related resources
+- `SemanticViewModel` - Complex nested structures
+
+## Development
+
+### Running Tests
+
+```bash
+npm test
+```
+
+### Linting
+
+```bash
+npm run lint
+```
 
 ### CI
 

package/dist/_wasm.d.ts

@@ -0,0 +1,23 @@
+import { StaticNode as WasmStaticNode, StaticGraphMeta as WasmStaticGraphMeta, WasmRdmCache, parseSkosXml, parseSkosXmlToCollection, collectionToSkosXml, collectionsToSkosXml, registerExtensionHandler } from "../pkg/alizarin";
+export declare function setWasmURL(url: string): void;
+/**
+ * Get the global WASM RDM cache singleton.
+ * Creates the cache on first access (after WASM initialization).
+ * @throws Error if WASM is not yet initialized
+ */
+export declare function getGlobalWasmRdmCache(): WasmRdmCache;
+/**
+ * Check if the global WASM RDM cache is available.
+ */
+export declare function hasGlobalWasmRdmCache(): boolean;
+/**
+ * Ensure the WASM RDM cache is initialized and ready.
+ * This can be awaited early in the application lifecycle to ensure
+ * the cache is available before any hierarchy methods are called.
+ * @returns The initialized WasmRdmCache
+ */
+export declare function ensureWasmRdmCache(): Promise<WasmRdmCache>;
+export declare function initWasm(): Promise<void>;
+export { WasmStaticNode, WasmStaticGraphMeta, WasmRdmCache };
+export { parseSkosXml, parseSkosXmlToCollection, collectionToSkosXml, collectionsToSkosXml };
+export { registerExtensionHandler };