[AAE-8713] feat: create api registry with factories support (#7649)

Co-authored-by: Andras Popovics <popovics@ndras.hu>
Co-authored-by: Michal Dobkiewicz <michal.dobkiewicz@hyland.com>
Co-authored-by: Michał Dobkiewicz <ddohcim@users.noreply.github.com>

lib/core/api-factories/legacy-api-client.factory.ts

@@ -0,0 +1,29 @@
+/*!
+ * @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 { ApiClientFactory, Constructor } from '@alfresco/adf-core/api';
+import { Injectable } from '@angular/core';
+import { AlfrescoApiService } from '../services/alfresco-api.service';
+
+@Injectable()
+export class LegacyClientFactory implements ApiClientFactory {
+    constructor(private alfrescoApiService: AlfrescoApiService) { }
+
+    create<T>(apiClass: Constructor<T>): T {
+        return new apiClass(this.alfrescoApiService.getInstance());
+    }
+}

lib/core/api-factories/legacy-api-client.module.ts

@@ -0,0 +1,11 @@
+import { NgModule } from '@angular/core';
+import { API_CLIENT_FACTORY_TOKEN } from '@alfresco/adf-core/api';
+import { LegacyClientFactory } from './legacy-api-client.factory';
+
+
+@NgModule({
+    providers: [
+        { provide: API_CLIENT_FACTORY_TOKEN, useClass: LegacyClientFactory }
+    ]
+})
+export class LegacyApiClientModule { }

lib/core/api/api-client.factory.ts

@@ -0,0 +1,25 @@
+/*!
+ * @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');

lib/core/api/api-clients.service.spec.ts

@@ -0,0 +1,66 @@
+/*!
+ * @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);
+    });
+
+});

lib/core/api/api-clients.service.ts

@@ -0,0 +1,54 @@
+/*!
+ * @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<AlfrescoCore.ApiRegistry> = {};
+
+    get<T extends keyof AlfrescoCore.ApiRegistry>(apiName: T): AlfrescoCore.ApiRegistry[T] {
+
+        const apiClass = this.registry[apiName];
+
+        if (!apiClass) {
+            throw new Error(`Api not registred: ${apiName}`);
+        }
+
+        return this.instances[apiName] as AlfrescoCore.ApiRegistry[T] ?? this.instantiateApi(apiName);
+    }
+
+
+    register<T extends keyof AlfrescoCore.ApiRegistry>(apiName: T, api: Constructor<AlfrescoCore.ApiRegistry[T]>): void {
+        this.registry[apiName] = api;
+    }
+
+    private instantiateApi<T extends keyof AlfrescoCore.ApiRegistry>(apiName: T): AlfrescoCore.ApiRegistry[T] {
+        const apiClass = this.registry[apiName];
+        const instance = this.apiCreateFactory.create<AlfrescoCore.ApiRegistry[T]>(apiClass);
+        this.instances[apiName] = instance;
+
+        return instance;
+    }
+}
+

lib/core/api/clients/activiti/activiti-client.module.ts

@@ -0,0 +1,28 @@
+/*!
+ * @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';
+
+@NgModule()
+export class ActivitiClientModule {
+    constructor(private apiClientsService: ApiClientsService) {
+        this.apiClientsService.register('ActivitiClient.about', AboutApi);
+        this.apiClientsService.register('ActivitiClient.system-properties', SystemPropertiesApi);
+    }
+}

lib/core/api/clients/activiti/activiti-client.types.ts

@@ -0,0 +1,29 @@
+/*!
+ * @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';
+
+declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
+    namespace AlfrescoCore {
+        interface ApiRegistry {
+            ['ActivitiClient.about']: AboutApi;
+            ['ActivitiClient.system-properties']: SystemPropertiesApi;
+        }
+    }
+}
+

lib/core/api/clients/alfresco-js-clients.module.ts

@@ -0,0 +1,32 @@
+/*!
+ * @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 { ApiClientsService } from '../api-clients.service';
+import { ActivitiClientModule } from './activiti/activiti-client.module';
+import { DiscoveryClientModule } from './discovery/discovery-client.module';
+
+@NgModule({
+    imports: [
+        ActivitiClientModule,
+        DiscoveryClientModule
+    ],
+    providers: [
+        ApiClientsService
+    ]
+})
+export class AlfrescoJsClientsModule { }

lib/core/api/clients/discovery/discovery-client.module.ts

@@ -0,0 +1,27 @@
+/*!
+ * @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';
+
+@NgModule()
+export class DiscoveryClientModule {
+    constructor(private apiClientsService: ApiClientsService) {
+        this.apiClientsService.register('DiscoveryClient.discovery', DiscoveryApi);
+    }
+}

lib/core/api/clients/discovery/discovery-client.types.ts

@@ -0,0 +1,27 @@
+/*!
+ * @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';
+
+declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
+    namespace AlfrescoCore {
+        interface ApiRegistry {
+            ['DiscoveryClient.discovery']: DiscoveryApi;
+        }
+    }
+}

lib/core/api/clients/index.ts

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

lib/core/api/index.ts

@@ -0,0 +1,2 @@
+export * from './public-api';
+

lib/core/api/ng-package.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
+  "lib": {
+    "entryFile": "public-api.ts",
+    "umdModuleIds": {
+      "@alfresco/js-api": "@alfresco/js-api"
+    }
+  }
+}

lib/core/api/public-api.ts

@@ -0,0 +1,4 @@
+export * from './api-client.factory';
+export * from './api-clients.service';
+export * from './clients/index';
+export * from './types';

lib/core/api/types.ts

@@ -0,0 +1,22 @@
+/*!
+ * @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;

lib/core/core.module.ts

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

lib/core/services/discovery-api.service.ts

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

lib/tsconfig.json

@@ -27,6 +27,7 @@
       "@alfresco/adf-content-services": ["./content-services/"],
       "@alfresco/adf-extensions": ["./extensions/"],
       "@alfresco/adf-core": ["./core/"],
+      "@alfresco/adf-core/*": ["./core/*/public-api.ts"],
       "@alfresco/adf-insights": ["./analytics"]
     },
     "lib": ["es2018", "esnext.array", "esnext.asynciterable", "dom"],

package-lock.json

@@ -40359,6 +40359,12 @@
       "resolved": "https://registry.npmjs.org/next-tick/-/next-tick-1.0.0.tgz",
       "integrity": "sha1-yobR/ogoFpsBICCOPchCS524NCw="
     },
+    "ng-mocks": {
+      "version": "10.5.4",
+      "resolved": "https://registry.npmjs.org/ng-mocks/-/ng-mocks-10.5.4.tgz",
+      "integrity": "sha512-NeuvW1XeIAdwxtepWusqiHM5L/BfjWB4mvBxLmyo41pUaFRw41KuQdxxVVO6hXvvHsvyQ9mSLdHrfCrLB86Hew==",
+      "dev": true
+    },
     "ng-packagr": {
       "version": "10.1.2",
       "resolved": "https://registry.npmjs.org/ng-packagr/-/ng-packagr-10.1.2.tgz",

package.json

@@ -169,6 +169,7 @@
     "lite-server": "^2.6.1",
     "mini-css-extract-plugin": "^1.6.0",
     "nconf": "^0.11.1",
+    "ng-mocks": "^10.5.4",
     "ng-packagr": "^10.1.2",
     "node-sass": "^4.14.1",
     "postcss": "^8.4.5",

tsconfig.json

@@ -31,7 +31,8 @@
     "paths": {
       "@alfresco/js-api": ["node_modules/@alfresco/js-api"],
       "@alfresco/adf-extensions": ["lib/extensions"],
-      "@alfresco/adf-core": ["lib/core"],
+      "@alfresco/adf-core": ["lib/core/public-api.ts"],
+      "@alfresco/adf-core/*": ["lib/core/*/public-api.ts"],
       "@alfresco/adf-content-services": ["lib/content-services"],
       "@alfresco/adf-process-services": ["lib/process-services"],
       "@alfresco/adf-insights": ["lib/insights"],