@meshmakers/octo-services 3.3.34 → 3.3.380

package/README.md

@@ -1,24 +1,105 @@
-# OctoServices
+# @meshmakers/octo-services
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.2.0.
+Angular library providing services for interacting with OctoMesh backend APIs.
 
-## Code scaffolding
+## Features
 
-Run `ng generate component component-name --project octo-services` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project octo-services`.
-> Note: Don't forget to add `--project octo-services` or else it will be added to the default project in your `angular.json` file. 
+- **HTTP Services** - REST API clients for Asset Repository, Identity Service, Bot Service
+- **GraphQL Services** - Construction Kit queries for types, attributes, and models
+- **Job Management** - Background job execution with progress tracking
+- **Error Handling** - Apollo Link for GraphQL error handling with user notifications
 
-## Build
+## Documentation
+
+- [Developer Documentation](docs/README.md) - Complete API reference and usage examples
+- [AI Context](CLAUDE.md) - Guidelines for AI-assisted development
+
+## Quick Start
+
+### 1. Implement Configuration Service
+
+```typescript
+import { Injectable } from '@angular/core';
+import { IConfigurationService, AddInConfiguration } from '@meshmakers/octo-services';
+
+@Injectable({ providedIn: 'root' })
+export class AppConfigurationService implements IConfigurationService {
+  private _config: AddInConfiguration = {} as AddInConfiguration;
+
+  get config(): AddInConfiguration {
+    return this._config;
+  }
+
+  async loadConfigAsync(): Promise<void> {
+    this._config = await fetch('/assets/config.json').then(r => r.json());
+  }
+}
+```
+
+### 2. Register Providers
 
-Run `ng build octo-services` to build the project. The build artifacts will be stored in the `dist/` directory.
+```typescript
+import { CONFIGURATION_SERVICE } from '@meshmakers/octo-services';
+import { AppConfigurationService } from './services/app-configuration.service';
 
-## Publishing
+export const appConfig: ApplicationConfig = {
+  providers: [
+    { provide: CONFIGURATION_SERVICE, useClass: AppConfigurationService }
+  ]
+};
+```
+
+### 3. Use Services
+
+```typescript
+import { HealthService, CkTypeSelectorService } from '@meshmakers/octo-services';
+
+@Component({ ... })
+export class MyComponent {
+  private readonly healthService = inject(HealthService);
+  private readonly ckTypeSelector = inject(CkTypeSelectorService);
+
+  async checkHealth(): Promise<void> {
+    const health = await this.healthService.getAssetRepoServiceHealthAsync();
+    console.log('Status:', health?.status);
+  }
+
+  loadTypes(): void {
+    this.ckTypeSelector.getCkTypes({ searchText: 'Customer' })
+      .subscribe(result => console.log('Types:', result.items));
+  }
+}
+```
+
+## 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 |
+
+## Build
 
-After building your library with `ng build octo-services`, go to the dist folder `cd dist/octo-services` and run `npm publish`.
+```bash
+# From frontend-libraries directory
+npm run build:octo-services
+```
 
-## Running unit tests
+## Test
 
-Run `ng test octo-services` to execute the unit tests via [Karma](https://karma-runner.github.io).
+```bash
+npm test -- --project=@meshmakers/octo-services --watch=false
+```
 
-## Further help
+## Lint
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+```bash
+npx ng lint @meshmakers/octo-services
+```