inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[AE-11486] move search service in alfresco content (#8086)

Browse Source 
* [ci:force] move search service in alfresco content

* fix

* fix md

* fix dep

* fix demo shell

* fix lint
This commit is contained in:
Eugenio Romano
2023-01-03 12:20:59 +01:00
committed by GitHub
parent b48248fae7
commit df340f2bb2
34 changed files with 52 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
lib/core/src/lib/auth/index.ts
View File

@@ -49,3 +49,5 @@ export * from './models/identity-group.model';
export * from './models/identity-user.model';
export * from './models/identity-role.model';
export * from './interface/authentication.interface';

0
lib/core/src/lib/interface/authentication.interface.ts → lib/core/src/lib/auth/interface/authentication.interface.ts
View File

2
lib/core/src/lib/interface/public-api.ts
View File

@@ -15,6 +15,4 @@
* limitations under the License.
*/
export * from './authentication.interface';
export * from './injection.tokens';
export * from './search-configuration.interface';

1
lib/core/src/lib/mock/public-api.ts
View File

@@ -22,7 +22,6 @@ export * from './cookie.service.mock';
export * from './ecm-user.service.mock';
export * from './event.mock';
export * from './renditions-service.mock';
export * from './search.service.mock';
export * from './translation.service.mock';
export * from './alfresco-api.service.mock';

61
lib/core/src/lib/mock/search.service.mock.ts
View File

@@ -1,61 +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 const fakeSearch = {
list: {
pagination: {
count: 1,
hasMoreItems: false,
totalItems: 1,
skipCount: 0,
maxItems: 100
},
entries: [
{
entry: {
id: '123',
name: 'MyDoc',
content: {
mimetype: 'text/plain'
},
createdByUser: {
displayName: 'John Doe'
},
modifiedByUser: {
displayName: 'John Doe'
}
}
}
]
}
};
export const mockError = {
error: {
errorKey: 'Search failed',
statusCode: 400,
briefSummary: '08220082 search failed',
stackTrace: 'For security reasons the stack trace is no longer displayed, but the property is kept for previous versions.',
descriptionURL: 'https://api-explorer.alfresco.com'
}
};
export const searchMockApi: any = {
findNodes: () => Promise.resolve(fakeSearch)
};

0
lib/core/src/lib/interface/search-configuration.interface.ts → lib/core/src/lib/search-text/interfaces/search-configuration.interface.ts
View File

2
lib/core/src/lib/search-text/public-api.ts
View File

@@ -19,3 +19,5 @@ export * from './animations';
export * from './search-text-input.component';
export * from './search-trigger.directive';
export * from './search-text-input.module';
export * from './interfaces/search-configuration.interface';

2
lib/core/src/lib/search-text/search-trigger.directive.ts
View File

@@ -33,7 +33,7 @@ import { ControlValueAccessor, NG_VALUE_ACCESSOR } from '@angular/forms';
import { DOCUMENT } from '@angular/common';
import { Observable, Subject, Subscription, merge, of, fromEvent } from 'rxjs';
import { filter, switchMap, takeUntil } from 'rxjs/operators';
import { SearchComponentInterface } from '../interface/search-configuration.interface';
import { SearchComponentInterface } from './interfaces/search-configuration.interface';
export const SEARCH_AUTOCOMPLETE_VALUE_ACCESSOR: any = {
provide: NG_VALUE_ACCESSOR,

2
lib/core/src/lib/services/public-api.ts
View File

@@ -30,11 +30,9 @@ export * from './favorites-api.service';
export * from './nodes-api.service';
export * from './people-content.service';
export * from './people-process.service';
export * from './search.service';
export * from './shared-links-api.service';
export * from './discovery-api.service';
export * from './comment-process.service';
export * from './search-configuration.service';
export * from './comment-content.service';
export * from './login-dialog.service';
export * from './external-alfresco-api.service';

55
lib/core/src/lib/services/search-configuration.service.ts
View File

@@ -1,55 +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 { QueryBody } from '@alfresco/js-api';
import { SearchConfigurationInterface } from '../interface/search-configuration.interface';
@Injectable({
providedIn: 'root'
})
export class SearchConfigurationService implements SearchConfigurationInterface {
constructor() {
}
/**
* Generates a QueryBody object with custom search parameters.
*
* @param searchTerm Term text to search for
* @param maxResults Maximum number of search results to show in a page
* @param skipCount The offset of the start of the page within the results list
* @returns Query body defined by the parameters
*/
generateQueryBody(searchTerm: string, maxResults: number, skipCount: number): QueryBody {
const defaultQueryBody: QueryBody = {
query: {
query: searchTerm ? `'${searchTerm}*' OR name:'${searchTerm}*'` : searchTerm
},
include: ['path', 'allowableOperations'],
paging: {
maxItems: maxResults,
skipCount
},
filterQueries: [
{ query: `TYPE:'cm:folder' OR TYPE:'cm:content'` },
{ query: 'NOT cm:creator:System' }]
};
return defaultQueryBody;
}
}

79
lib/core/src/lib/services/search.service.spec.ts
View File

@@ -1,79 +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 { TestBed } from '@angular/core/testing';
import { mockError, fakeSearch } from '../mock/search.service.mock';
import { SearchService } from './search.service';
import { setupTestBed } from '../testing/setup-test-bed';
import { CoreTestingModule } from '../testing/core.testing.module';
import { TranslateModule } from '@ngx-translate/core';
import { NodePaging } from '@alfresco/js-api';
describe('SearchService', () => {
let service: SearchService;
setupTestBed({
imports: [
TranslateModule.forRoot(),
CoreTestingModule
]
});
beforeEach(() => {
service = TestBed.inject(SearchService);
});
it('should call search API with no additional options', (done) => {
const searchTerm = 'searchTerm63688';
spyOn(service.queriesApi, 'findNodes').and.returnValue(Promise.resolve(new NodePaging(fakeSearch)));
service.getNodeQueryResults(searchTerm).subscribe(
() => {
expect(service.queriesApi.findNodes).toHaveBeenCalledWith(searchTerm, undefined);
done();
}
);
});
it('should call search API with additional options', (done) => {
const searchTerm = 'searchTerm63688';
const options = {
include: [ 'path' ],
rootNodeId: '-root-',
nodeType: 'cm:content'
};
spyOn(service.queriesApi, 'findNodes').and.returnValue(Promise.resolve(new NodePaging(fakeSearch)));
service.getNodeQueryResults(searchTerm, options).subscribe(
() => {
expect(service.queriesApi.findNodes).toHaveBeenCalledWith(searchTerm, options);
done();
}
);
});
it('should notify errors returned from the API', (done) => {
spyOn(service.queriesApi, 'findNodes').and.returnValue(Promise.reject(mockError));
service.getNodeQueryResults('').subscribe(
() => {},
(res: any) => {
expect(res).toBeDefined();
expect(res).toEqual(mockError);
done();
}
);
});
});

140
lib/core/src/lib/services/search.service.ts
View File

@@ -1,140 +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 { NodePaging, QueriesApi, QueryBody, ResultSetPaging, SearchApi } from '@alfresco/js-api';
import { Observable, Subject, from, throwError } from 'rxjs';
import { AlfrescoApiService } from './alfresco-api.service';
import { SearchConfigurationService } from './search-configuration.service';
@Injectable({
providedIn: 'root'
})
export class SearchService {
dataLoaded: Subject<ResultSetPaging> = new Subject();
private _queriesApi: QueriesApi;
get queriesApi(): QueriesApi {
this._queriesApi = this._queriesApi ?? new QueriesApi(this.apiService.getInstance());
return this._queriesApi;
}
private _searchApi: SearchApi;
get searchApi(): SearchApi {
this._searchApi = this._searchApi ?? new SearchApi(this.apiService.getInstance());
return this._searchApi;
}
constructor(private apiService: AlfrescoApiService,
private searchConfigurationService: SearchConfigurationService) {
}
/**
* Gets a list of nodes that match the given search criteria.
*
* @param term Term to search for
* @param options Options for delivery of the search results
* @returns List of nodes resulting from the search
*/
getNodeQueryResults(term: string, options?: SearchOptions): Observable<NodePaging> {
const promise = this.queriesApi.findNodes(term, options);
promise.then((nodePaging: NodePaging) => {
this.dataLoaded.next(nodePaging);
}).catch((err) => this.handleError(err));
return from(promise);
}
/**
* Performs a search.
*
* @param searchTerm Term to search for
* @param maxResults Maximum number of items in the list of results
* @param skipCount Number of higher-ranked items to skip over in the list
* @returns List of search results
*/
search(searchTerm: string, maxResults: number, skipCount: number): Observable<ResultSetPaging> {
const searchQuery = Object.assign(this.searchConfigurationService.generateQueryBody(searchTerm, maxResults, skipCount));
const promise = this.searchApi.search(searchQuery);
promise.then((nodePaging: NodePaging) => {
this.dataLoaded.next(nodePaging);
}).catch((err) => this.handleError(err));
return from(promise);
}
/**
* Performs a search with its parameters supplied by a QueryBody object.
*
* @param queryBody Object containing the search parameters
* @returns List of search results
*/
searchByQueryBody(queryBody: QueryBody): Observable<ResultSetPaging> {
const promise = this.searchApi.search(queryBody);
promise.then((nodePaging: NodePaging) => {
this.dataLoaded.next(nodePaging);
}).catch((err) => this.handleError(err));
return from(promise);
}
private handleError(error: any): Observable<any> {
return throwError(error || 'Server error');
}
}
export interface SearchOptions {
/** The number of entities that exist in the collection before those included in this list. */
skipCount?: number;
/** The maximum number of items to return in the list. */
maxItems?: number;
/** The id of the node to start the search from. Supports the aliases -my-, -root- and -shared-. */
rootNodeId?: string;
/** Restrict the returned results to only those of the given node type and its sub-types. */
nodeType?: string;
/**
* Return additional information about the node. The available optional fields are:
* `allowableOperations`, `aspectNames`, `isLink`, `isLocked`, `path` and `properties`.
*/
include?: string[];
/**
* String to control the order of the entities returned in a list. You can use this
* parameter to sort the list by one or more fields. Each field has a default sort order,
* which is normally ascending order (but see the JS-API docs to check if any fields used
* in a method have a descending default search order). To sort the entities in a specific
* order, you can use the "ASC" and "DESC" keywords for any field.
*/
orderBy?: string;
/**
* List of field names. You can use this parameter to restrict the fields returned within
* a response if, for example, you want to save on overall bandwidth. The list applies to a
* returned individual entity or entries within a collection. If the API method also supports
* the `include` parameter, then the fields specified in the include parameter are returned in
* addition to those specified in the fields parameter.
*/
fields?: string[];
}