inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revert "[AAE-8713] feat: create api registry with factories support (… (#7647)

Browse Source 
* Revert "[AAE-8713] feat: create api registry with factories support (#7634)"

This reverts commit 226a6548a1fbaecad9f340e0ac688ef334ab4049.
This commit is contained in:
Mikołaj Serwicki 2022-05-24 15:18:56 +02:00 committed by GitHub
parent dbbfa11f50
commit f11ae24d7a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 6 additions and 351 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
lib/core/api/api-client.factory.ts
View File

@ -1,25 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { InjectionToken } from '@angular/core';
import { Constructor } from './types';
export interface ApiClientFactory {
create<T>(apiClass: Constructor<T>): T;
}
export const API_CLIENT_FACTORY_TOKEN = new InjectionToken<ApiClientFactory>('api-client-factory');

66
lib/core/api/api-clients.service.spec.ts
View File

@ -1,66 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AboutApi } from '@alfresco/js-api';
import { TestBed } from '@angular/core/testing';
import { ApiClientFactory, API_CLIENT_FACTORY_TOKEN } from './api-client.factory';
import { ApiClientsService } from './api-clients.service';
import { Constructor } from './types';
class MockApiClientFactory implements ApiClientFactory {
create<T>(apiClass: Constructor<T>): T {
return new apiClass();
}
}
describe('ApiService', () => {
let apiService: ApiClientsService;
beforeEach(() => {
TestBed.configureTestingModule({
providers: [
ApiClientsService,
{ provide: API_CLIENT_FACTORY_TOKEN, useClass: MockApiClientFactory }
]
});
apiService = TestBed.inject(ApiClientsService);
});
it('should add api to registry', () => {
apiService.register('ActivitiClient.about', AboutApi);
expect(apiService.get('ActivitiClient.about') instanceof AboutApi).toBeTruthy();
});
it('should throw error if we try to get unregisterd API', () => {
expect(() => apiService.get('ActivitiClient.about')).toThrowError();
apiService.register('ActivitiClient.about', AboutApi);
expect(() => apiService.get('ActivitiClient.about')).not.toThrowError();
});
it('should create only single instance of API', () => {
apiService.register('ActivitiClient.about', AboutApi);
const a = apiService.get('ActivitiClient.about');
const b = apiService.get('ActivitiClient.about');
expect(a).toBe(b);
});
});

54
lib/core/api/api-clients.service.ts
View File

@ -1,54 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Inject, Injectable } from '@angular/core';
import { ApiClientFactory, API_CLIENT_FACTORY_TOKEN } from './api-client.factory';
import { Constructor, Dictionary } from './types';
@Injectable()
export class ApiClientsService {
constructor(@Inject(API_CLIENT_FACTORY_TOKEN) private apiCreateFactory: ApiClientFactory) { }
private registry: Dictionary<Constructor<any>> = {};
private instances: Partial<Api.ApiRegistry> = {};
get<T extends keyof Api.ApiRegistry>(apiName: T): Api.ApiRegistry[T] {
const ApiClass = this.registry[apiName];
if (!ApiClass) {
throw new Error(`Api not registred: ${apiName}`);
}
return this.instances[apiName] as Api.ApiRegistry[T] ?? this.instantiateApi(apiName);
}
register<T extends keyof Api.ApiRegistry>(apiName: T, api: Constructor<Api.ApiRegistry[T]>): void {
this.registry[apiName] = api;
}
private instantiateApi<T extends keyof Api.ApiRegistry>(apiName: T): Api.ApiRegistry[T] {
const ApiClass = this.registry[apiName];
const instance = this.apiCreateFactory.create<Api.ApiRegistry[T]>(ApiClass);
this.instances[apiName] = instance;
return instance;
}
}

29
lib/core/api/api.module.ts
View File

@ -1,29 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { NgModule } from '@angular/core';
import { API_CLIENT_FACTORY_TOKEN } from './api-client.factory';
import { ApiClientsService } from './api-clients.service';
import { LegacyClientFactory } from './legacy-api-client.factory';
@NgModule({
providers: [
ApiClientsService,
{ provide: API_CLIENT_FACTORY_TOKEN, useClass: LegacyClientFactory }
]
})
export class ApiModule { }

38
lib/core/api/clients/activiti/activiti-client.module.ts
View File

@ -1,38 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AboutApi, SystemPropertiesApi } from '@alfresco/js-api';
import { NgModule } from '@angular/core';
import { ApiClientsService } from '../../api-clients.service';
declare global {
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace Api {
interface ApiRegistry {
['ActivitiClient.about']: AboutApi;
['ActivitiClient.system-properties']: SystemPropertiesApi;
}
}
}
@NgModule({})
export class ActivitiClientModule {
constructor(private apiClientsService: ApiClientsService) {
this.apiClientsService.register('ActivitiClient.about', AboutApi);
this.apiClientsService.register('ActivitiClient.system-properties', SystemPropertiesApi);
}
}

28
lib/core/api/clients/alfresco-js-clients.module.ts
View File

@ -1,28 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { NgModule } from '@angular/core';
import { ActivitiClientModule } from './activiti/activiti-client.module';
import { DiscoveryClientModule } from './discovery/discovery-client.module';
@NgModule({
imports: [
ActivitiClientModule,
DiscoveryClientModule
]
})
export class AlfrescoJsClientsModule { }

36
lib/core/api/clients/discovery/discovery-client.module.ts
View File

@ -1,36 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { DiscoveryApi } from '@alfresco/js-api';
import { NgModule } from '@angular/core';
import { ApiClientsService } from '../../api-clients.service';
declare global {
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace Api {
interface ApiRegistry {
['DiscoveryClient.discovery']: DiscoveryApi;
}
}
}
@NgModule({})
export class DiscoveryClientModule {
constructor(private apiClientsService: ApiClientsService) {
this.apiClientsService.register('DiscoveryClient.discovery', DiscoveryApi);
}
}

2
lib/core/api/clients/index.ts
View File

@ -1,2 +0,0 @@
export * from './activiti/activiti-client.module';
export * from './alfresco-js-clients.module';

5
lib/core/api/index.ts
View File

@ -1,5 +0,0 @@
export * from './api-client.factory';
export * from './api-clients.service';
export * from './api.module';
export * from './clients';

30
lib/core/api/legacy-api-client.factory.ts
View File

@ -1,30 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Injectable } from '@angular/core';
import { AlfrescoApiService } from '../services/alfresco-api.service';
import { ApiClientFactory } from './api-client.factory';
import { Constructor } from './types';
@Injectable()
export class LegacyClientFactory implements ApiClientFactory {
constructor(private alfrescoApiService: AlfrescoApiService) { }
create<T>(apiClass: Constructor<T>): T {
return new apiClass(this.alfrescoApiService.getInstance());
}
}

22
lib/core/api/types.ts
View File

@ -1,22 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface Dictionary<T> {
[key: string]: T;
};
export type Constructor<T> = new (...args: any[]) => T;

7
lib/core/core.module.ts
View File

@ -60,9 +60,6 @@ import { DirectionalityConfigService } from './services/directionality-config.se
import { SearchTextModule } from './search-text/search-text-input.module'; import { SearchTextModule } from './search-text/search-text-input.module';
import { versionCompatibilityFactory } from './services/version-compatibility-factory'; import { versionCompatibilityFactory } from './services/version-compatibility-factory';
import { VersionCompatibilityService } from './services/version-compatibility.service'; import { VersionCompatibilityService } from './services/version-compatibility.service';
import { ApiModule } from './api/api.module';
import { AlfrescoJsClientsModule } from './api/clients/alfresco-js-clients.module';
@NgModule({ @NgModule({
imports: [ imports: [
TranslateModule, TranslateModule,
@ -97,9 +94,7 @@ import { AlfrescoJsClientsModule } from './api/clients/alfresco-js-clients.modul
SortingPickerModule, SortingPickerModule,
NotificationHistoryModule, NotificationHistoryModule,
SearchTextModule, SearchTextModule,
BlankPageModule, BlankPageModule
ApiModule,
AlfrescoJsClientsModule
], ],
exports: [ exports: [
AboutModule, AboutModule,

1
lib/core/index.ts
View File

@ -53,5 +53,4 @@ export * from './mock/index';
export * from './testing'; export * from './testing';
export * from './material.module'; export * from './material.module';
export * from './api';
export * from './core.module'; export * from './core.module';

14
lib/core/services/discovery-api.service.ts
View File

@ -18,13 +18,11 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { from, Observable, throwError, Subject } from 'rxjs'; import { from, Observable, throwError, Subject } from 'rxjs';
import { catchError, map, switchMap, filter, take } from 'rxjs/operators'; import { catchError, map, switchMap, filter, take } from 'rxjs/operators';
import { RepositoryInfo, SystemPropertiesRepresentation } from '@alfresco/js-api'; import { AboutApi, DiscoveryApi, RepositoryInfo, SystemPropertiesApi, SystemPropertiesRepresentation } from '@alfresco/js-api';
import { BpmProductVersionModel } from '../models/product-version.model'; import { BpmProductVersionModel } from '../models/product-version.model';
import { AlfrescoApiService } from './alfresco-api.service'; import { AlfrescoApiService } from './alfresco-api.service';
import { AuthenticationService } from './authentication.service'; import { AuthenticationService } from './authentication.service';
import { ApiClientsService } from '../api';
@Injectable({ @Injectable({
providedIn: 'root' providedIn: 'root'
@ -38,8 +36,7 @@ export class DiscoveryApiService {
constructor( constructor(
private apiService: AlfrescoApiService, private apiService: AlfrescoApiService,
private authenticationService: AuthenticationService, private authenticationService: AuthenticationService) {
private apiClientsService: ApiClientsService) {
this.authenticationService.onLogin this.authenticationService.onLogin
.pipe( .pipe(
@ -50,14 +47,13 @@ export class DiscoveryApiService {
.subscribe((info) => this.ecmProductInfo$.next(info)); .subscribe((info) => this.ecmProductInfo$.next(info));
} }
/** /**
* Gets product information for Content Services. * Gets product information for Content Services.
* *
* @returns ProductVersionModel containing product details * @returns ProductVersionModel containing product details
*/ */
getEcmProductInfo(): Observable<RepositoryInfo> { getEcmProductInfo(): Observable<RepositoryInfo> {
const discoveryApi = this.apiClientsService.get('DiscoveryClient.discovery'); const discoveryApi = new DiscoveryApi(this.apiService.getInstance());
return from(discoveryApi.getRepositoryInformation()) return from(discoveryApi.getRepositoryInformation())
.pipe( .pipe(
@ -72,7 +68,7 @@ export class DiscoveryApiService {
* @returns ProductVersionModel containing product details * @returns ProductVersionModel containing product details
*/ */
getBpmProductInfo(): Observable<BpmProductVersionModel> { getBpmProductInfo(): Observable<BpmProductVersionModel> {
const aboutApi = this.apiClientsService.get('ActivitiClient.about'); const aboutApi = new AboutApi(this.apiService.getInstance());
return from(aboutApi.getAppVersion()) return from(aboutApi.getAppVersion())
.pipe( .pipe(
@ -82,7 +78,7 @@ export class DiscoveryApiService {
} }
getBPMSystemProperties(): Observable<SystemPropertiesRepresentation> { getBPMSystemProperties(): Observable<SystemPropertiesRepresentation> {
const systemPropertiesApi = this.apiClientsService.get('ActivitiClient.system-properties'); const systemPropertiesApi = new SystemPropertiesApi(this.apiService.getInstance());
return from(systemPropertiesApi.getProperties()) return from(systemPropertiesApi.getProperties())
.pipe( .pipe(