[ACS-6630] Added ExtensionManagerService and ExtensionInfoModel to ADF. Renamed ExtensionConfig to ExtensionComposition

This commit is contained in:
swapnil.verma
2024-04-25 12:42:36 +05:30
parent 9b9d73f799
commit d855328efc
11 changed files with 217 additions and 22 deletions

View File

@@ -17,10 +17,9 @@
import { BaseApi } from './base.api';
import { throwIfNotDefined } from '../../../assert';
import { ExtensionConfig } from '../model/extensionConfig';
import { ExtensionConfigEntry } from '../model/extensionConfigEntry';
import { ExtensionComposition } from '../model/extensionComposition';
import { ExtensionCompositionEntry } from '../model/extensionCompositionEntry';
export class SettingsApi extends BaseApi {
/**
* Gets the published extension configuration from
* the database
@@ -28,7 +27,7 @@ export class SettingsApi extends BaseApi {
* @param instanceId Unique ID for a running instance of ADW
* for which configuration is to be fetched
*/
getSavedExtensionState(instanceId: string): Promise<ExtensionConfigEntry> {
getSavedExtensionState(instanceId: string): Promise<ExtensionCompositionEntry> {
throwIfNotDefined(instanceId, 'instanceId');
const pathParams = {
@@ -50,7 +49,7 @@ export class SettingsApi extends BaseApi {
* @param extensionConfig Extension configuration that is to
* be saved
*/
publishExtensionConfig(instanceId: string, extensionConfig: ExtensionConfig): Promise<void> {
publishExtensionConfig(instanceId: string, extensionConfig: ExtensionComposition): Promise<void> {
throwIfNotDefined(instanceId, 'instanceId');
throwIfNotDefined(extensionConfig, 'extensionConfig');

View File

@@ -19,9 +19,9 @@ Gets the extension configuration saved on the backend
|----------------|--------|----------------------------------------------|-------|
| **instanceId** | string | The identifier of a running instance of ADW. | |
**Return type**: [ExtensionConfigEntry](#ExtensionConfigEntry)
**Return type**: [ExtensionCompositionEntry](#ExtensionCompositionEntry)
## publishExtensionConfig
## publishExtensionComposition
Saves an extension configuration on the backend
@@ -30,7 +30,7 @@ Saves an extension configuration on the backend
| Name | Type | Description |
|---------------------|-------------------------------------|----------------------------------------------|
| **instanceId** | string | The identifier of a running instance of ADW. |
| **extensionConfig** | [ExtensionConfig](#ExtensionConfig) | The extension configuration to be saved. |
| **extensionConfig** | [ExtensionComposition](#ExtensionComposition) | The extension configuration to be saved. |
**Example**
@@ -40,7 +40,7 @@ import {AlfrescoApi, SitesApi} from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const settingsApi = new SettingsApi(alfrescoApi);
const extensionConfig = new ExtensionConfig();
const extensionConfig = new ExtensionComposition();
extensionConfig = {
appConfig: {},
features: {},
@@ -56,15 +56,15 @@ settingsApi.publishExtensionConfig(`<instanceId>`, extensionConfig).then(() => {
# Models
## ExtensionConfigEntry
## ExtensionCompositionEntry
**Properties**
| Name | Type |
|-----------|-------------------------------------|
| **entry** | [ExtensionConfig](#ExtensionConfig) |
| **entry** | [ExtensionComposition](#ExtensionComposition) |
## ExtensionConfig
## ExtensionComposition
**Properties**

View File

@@ -20,12 +20,12 @@ import { RuleRef } from './ruleRef';
import { RouteRef } from './routeRef';
import { ActionRef } from './actionRef';
export class ExtensionConfig {
export class ExtensionComposition {
appConfig: AppConfigPluginRef;
rules?: Array<RuleRef>;
routes?: Array<RouteRef>;
actions?: Array<ActionRef>;
rules?: Array<RuleRef> = [];
routes?: Array<RouteRef> = [];
actions?: Array<ActionRef> = [];
features?: {
[key: string]: any;
};
} = {};
}

View File

@@ -0,0 +1,22 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { ExtensionComposition } from './extensionComposition';
export class ExtensionCompositionEntry {
entry: ExtensionComposition;
}

View File

@@ -81,8 +81,8 @@ export * from './download-status';
export * from './downloadBodyCreate';
export * from './downloadEntry';
export * from './errorError';
export * from './extensionConfig';
export * from './extensionConfigEntry';
export * from './extensionComposition';
export * from './extensionCompositionEntry';
export * from './favorite';
export * from './favoriteBodyCreate';
export * from './favoriteEntry';