@meshmakers/octo-services 3.3.450 → 3.3.470

package/README.md

@@ -2,17 +2,78 @@
 
 Angular library providing services for interacting with OctoMesh backend APIs.
 
+Part of the [@meshmakers](https://www.npmjs.com/org/meshmakers) package ecosystem.
+
 ## Features
 
-- **HTTP Services** - REST API clients for Asset Repository, Identity Service, Bot Service
+- **HTTP Services** - REST API clients for Asset Repository, Identity Service, Bot Service, Communication Controller
 - **GraphQL Services** - Construction Kit queries for types, attributes, and models
 - **Job Management** - Background job execution with progress tracking
+- **TUS Upload** - Resumable file uploads for large database restores
 - **Error Handling** - Apollo Link for GraphQL error handling with user notifications
 
-## Documentation
+## Build & Test
+
+```bash
+# Build
+npm run build:octo-services
+
+# Lint
+npm run lint:octo-services
+
+# Run tests
+npm test -- --project=@meshmakers/octo-services --watch=false
+```
+
+## Architecture
+
+```
+octo-services/
+├── src/
+│   ├── public-api.ts
+│   └── lib/
+│       ├── services/
+│       │   ├── health.service.ts            # Backend health checks
+│       │   ├── asset-repo.service.ts        # Tenant and model management
+│       │   ├── identity-service.ts          # User, role, client management
+│       │   ├── bot-service.ts               # Background job execution
+│       │   ├── job-management.service.ts    # Job progress tracking with UI
+│       │   ├── communication.service.ts     # Adapter and pipeline management
+│       │   ├── tus-upload.service.ts        # Resumable file uploads (TUS)
+│       │   ├── ck-type-selector.service.ts  # Query CK types (GraphQL)
+│       │   ├── ck-type-attribute.service.ts # Query CK type attributes (GraphQL)
+│       │   ├── ck-model.service.ts          # Check model availability (GraphQL)
+│       │   ├── attribute-selector.service.ts # Query columns (GraphQL)
+│       │   ├── configuration.service.ts     # Configuration injection token
+│       │   └── tenant-provider.ts           # Tenant ID injection token
+│       ├── graphQL/                         # GraphQL queries and generated types
+│       ├── shared/                          # DTOs, models, and utilities
+│       ├── options/                         # Configuration options
+│       └── compat/                          # Backward compatibility exports
+```
+
+## Services
+
+### HTTP Services
+
+| Service | Description |
+|---------|-------------|
+| `HealthService` | Backend health checks (Asset Repo, Identity, Bot, Communication, Mesh Adapter) |
+| `AssetRepoService` | Tenant management, model import/export, user merging |
+| `IdentityService` | User, role, and OAuth client management |
+| `BotService` | Background job execution (fixup scripts, dump/restore) |
+| `JobManagementService` | Job progress tracking with UI dialogs |
+| `CommunicationService` | Adapter deployment, pipeline execution, and debugging |
+| `TusUploadService` | Resumable file uploads via TUS protocol |
 
-- [Developer Documentation](docs/README.md) - Complete API reference and usage examples
-- [AI Context](CLAUDE.md) - Guidelines for AI-assisted development
+### GraphQL Services
+
+| Service | Description |
+|---------|-------------|
+| `CkTypeSelectorService` | Query CK types with filtering, pagination, and derived types |
+| `CkTypeAttributeService` | Query CK type and record attributes |
+| `CkModelService` | Check model availability and versions |
+| `AttributeSelectorService` | Query available query columns for a CK type |
 
 ## Quick Start
 
@@ -71,35 +132,26 @@ export class MyComponent {
 }
 ```
 
-## Available Services
-
-| Service | Description |
-|---------|-------------|
-| `HealthService` | Backend health checks |
-| `AssetRepoService` | Tenant and model management |
-| `IdentityService` | User, role, and client management |
-| `BotService` | Background job execution |
-| `JobManagementService` | Job progress tracking with UI |
-| `CkTypeSelectorService` | Query CK types |
-| `CkTypeAttributeService` | Query CK type/record attributes |
-| `CkModelService` | Check model availability and versions |
-| `AttributeSelectorService` | Query available query columns |
+## Detailed Documentation
 
-## Build
+See [docs/README.md](docs/README.md) for complete API reference with all method signatures and usage examples.
 
-```bash
-# From frontend-libraries directory
-npm run build:octo-services
-```
+See [CLAUDE.md](CLAUDE.md) for development guidelines, CK ID types, GraphQL utilities, and testing patterns.
 
-## Test
+## Dependencies
 
-```bash
-npm test -- --project=@meshmakers/octo-services --watch=false
-```
+- **Angular 21** (core, common/http)
+- **Apollo Angular** / **@apollo/client** (GraphQL client)
+- **tus-js-client** (resumable uploads)
+- **@meshmakers/shared-auth** (AuthorizeService for TUS uploads)
+- **@meshmakers/shared-services** (MessageService, PagedResultDto)
+- **@meshmakers/shared-ui** (ProgressWindowService for job tracking)
 
-## Lint
+## Documentation and Testing Standards
 
-```bash
-npx ng lint @meshmakers/octo-services
-```
+- **All developer documentation must be written in English**
+- **Every code change must include updated documentation** — update README.md, CLAUDE.md, docs/README.md, or inline docs when adding, modifying, or removing features
+- **Unit tests and integration tests must be executed** after every code change
+- **Existing tests must be updated** when the behavior of tested code changes
+- **New tests must be added** when new features, components, or services are implemented
+- Never commit code with failing tests