@meshmakers / octo-services

Angular库提供与OctoMesh后端api交互的服务。

部分 @meshmakers 包的生态系统。

功能

• HTTP服务 -资产存储库，身份服务，Bot服务，通信控制器的REST API客户端
• GraphQL服务 - Construction Kit查询类型、属性和模型
• 作业管理 -后台作业执行与进度跟踪
• 摘要上传 —对于大型数据库恢复，支持文件上传
• 错误处理 Apollo Link用于GraphQL错误处理和用户通知

构建和测试

# Build
npm run build:octo-services

# Lint
npm run lint:octo-services

# Run tests
npm run test:octo-services

体系结构

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

服务

HTTP服务

GraphQL服务

快速入门

1. 实现配置服务

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. 注册供应商

import { CONFIGURATION_SERVICE } from '@meshmakers/octo-services';
import { AppConfigurationService } from './services/app-configuration.service';

export const appConfig: ApplicationConfig = {
  providers: [
    { provide: CONFIGURATION_SERVICE, useClass: AppConfigurationService }
  ]
};

3. 使用服务

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));
  }
}

详细的文档

看到 文档/ README.md 获取完整的API参考，包括所有方法签名和使用示例。

看到 CLAUDE.md 用于开发指南、CK ID类型、GraphQL实用程序和测试模式。

依赖关系

• 角21 (核心,常见/ http)
• 阿波罗角 (同行的依赖, ^14.0.0）
• @apollo /客户端 (同行的依赖, ^4.1.0 ——最老的x行包含这里使用的所有API，所以在apollo-angular 14.1 / @apollo/client 4.1上的主机继续安装；在运行时导入： InMemoryCache， ApolloLink，错误链接)
• graphql (同行的依赖, ^16.0.0 || ^17.0.0 比如apollo-angular / @apollo/client；只有 DocumentNode 类型（由公共API公开）。
• tus-js-client (可恢复的上传)
• @meshmakers / shared-auth （AuthorizeService用于TUS上传）
• @meshmakers /共享服务 (MessageService PagedResultDto)
• @meshmakers /共享的ui （ProgressWindowService用于作业跟踪）

文件和测试标准

• 所有开发人员文档必须用英语编写
• 每次代码更改都必须包含更新的文档 -更新自述文件。医学博士,克劳德。医学博士,文档/ README。在添加、修改或删除功能时使用
• 必须执行单元测试和集成测试 每次代码更改之后
• 必须更新现有的测试 当被测试代码的行为发生变化时
• 必须添加新的测试 当实现新的特性、组件或服务时
• 永远不要提交测试失败的代码