Skip to content

Commit

Permalink
[AAE-26767] - Fixed lint
Browse files Browse the repository at this point in the history
  • Loading branch information
VitoAlbano committed Jan 22, 2025
1 parent 692b8de commit 444327a
Show file tree
Hide file tree
Showing 183 changed files with 846 additions and 44 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export class AgentService {

/**
* Gets all agents from cache. If cache is empty, fetches agents from backend.
*
* @returns Agent[] list containing agents.
*/
getAgents(): Observable<Agent[]> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { AlfrescoApiService } from '../services/alfresco-api.service';

/**
* Create a factory to resolve an api service instance
*
* @param angularAlfrescoApiService loader service
* @returns factory function
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import { ContentAuthLoaderService } from './content-auth-loader.service';

/**
* Create a content auth factory
*
* @param authLoaderService service dependency
* @returns factory function
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ export class DropdownBreadcrumbComponent extends BreadcrumbComponent implements

/**
* Check if route has more than one element (means: we are not in the root directory)
*
* @returns `true` if there are previous nodes, otherwise `false`
*/
hasPreviousNodes(): boolean {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Get no categories message
*
* @returns message text
*/
function getNoCategoriesMessage(): string {
Expand All @@ -76,6 +77,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Get assigned categories list
*
* @returns list of native elements
*/
function getAssignedCategoriesList(): HTMLSpanElement[] {
Expand All @@ -84,6 +86,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Get the exiting categories list
*
* @returns list of material option element
*/
function getExistingCategoriesList(): HTMLElement[] {
Expand All @@ -92,6 +95,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Create new category
*
* @param name name of the category
* @param addUsingEnter use Enter key
* @param typingTimeout typing timeout in milliseconds (default 300)
Expand All @@ -111,6 +115,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Get first error
*
* @returns error text
*/
function getFirstError(): string {
Expand All @@ -119,6 +124,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Get selection list
*
* @returns material selection list
*/
function getSelectionList(): MatList {
Expand All @@ -127,6 +133,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Get remove category buttons
*
* @returns list of native elements
*/
function getRemoveCategoryButtons(): HTMLButtonElement[] {
Expand All @@ -137,6 +144,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Get category control input
*
* @returns native input element
*/
function getCategoryControlInput(): HTMLInputElement {
Expand All @@ -145,6 +153,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Get create category label
*
* @returns native element
*/
function getCreateCategoryLabel(): HTMLSpanElement {
Expand All @@ -153,6 +162,7 @@ describe('CategoriesManagementComponent', () => {

/**
* Type new category
*
* @param name name of the category
* @param timeout typing timeout in milliseconds (default 300)
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ export class CategoriesManagementComponent implements OnInit, OnDestroy {
/**
* Decides if categoryNameControl should be visible. Sets also existing categories panel visibility
* and scrolls control into view when visible.
*
* @param categoryNameControlVisible control visibility.
*/
@Input()
Expand Down Expand Up @@ -258,6 +259,7 @@ export class CategoriesManagementComponent implements OnInit, OnDestroy {

/**
* Adds existing category to categories list and removes it from existing categories list.
*
* @param category - selection list change containing selected category
*/
addCategoryToAssign(category: Category) {
Expand All @@ -272,6 +274,7 @@ export class CategoriesManagementComponent implements OnInit, OnDestroy {

/**
* Removes the category from categories list and adds it to existing categories list in ASSIGN mode.
*
* @param category - category to remove
*/
removeCategory(category: Category) {
Expand Down
10 changes: 10 additions & 0 deletions lib/content-services/src/lib/category/services/category.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export class CategoryService {

/**
* Get subcategories of a given parent category
*
* @param parentCategoryId The identifier of a parent category.
* @param skipCount Number of top categories to skip.
* @param maxItems Maximum number of subcategories returned from Observable.
Expand All @@ -64,6 +65,7 @@ export class CategoryService {

/**
* Get a category by ID
*
* @param categoryId The identifier of a category.
* @param opts Optional parameters.
* @param opts.fields A list of field names.
Expand All @@ -78,6 +80,7 @@ export class CategoryService {

/**
* Creates subcategories under category with provided categoryId
*
* @param parentCategoryId The identifier of a parent category.
* @param payload List of categories to be created.
* @returns Observable<CategoryPaging | CategoryEntry>
Expand All @@ -88,6 +91,7 @@ export class CategoryService {

/**
* Updates category
*
* @param categoryId The identifier of a category.
* @param payload Updated category body
* @returns Observable<CategoryEntry>
Expand All @@ -98,6 +102,7 @@ export class CategoryService {

/**
* Deletes category
*
* @param categoryId The identifier of a category.
* @returns Observable<void>
*/
Expand All @@ -107,6 +112,7 @@ export class CategoryService {

/**
* Searches categories by their name.
*
* @param name Value for name which should be used during searching categories.
* @param skipCount Specify how many first results should be skipped. Default 0.
* @param maxItems Specify max number of returned categories. Default is specified by UserPreferencesService.
Expand All @@ -131,6 +137,7 @@ export class CategoryService {

/**
* List of categories that node is assigned to
*
* @param nodeId The identifier of a node.
* @returns Observable<CategoryPaging> Categories that node is assigned to
*/
Expand All @@ -140,6 +147,7 @@ export class CategoryService {

/**
* Unlink category from a node
*
* @param nodeId The identifier of a node.
* @param categoryId The identifier of a category.
* @returns Observable<void>
Expand All @@ -150,6 +158,7 @@ export class CategoryService {

/**
* Link node to a category
*
* @param nodeId The identifier of a node.
* @param categoryLinkBodyCreate Array of a categories that node will be linked to.
* @returns Observable<CategoryEntry>
Expand All @@ -160,6 +169,7 @@ export class CategoryService {

/**
* Checks if categories plugin is enabled.
*
* @returns boolean true if categories plugin is enabled, false otherwise.
*/
areCategoriesEnabled(): boolean {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import { SearchRequest } from '@alfresco/js-api';
export interface SearchConfigurationInterface {
/**
* Generates a query 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ export class ContentService {

/**
* Gets a content URL for the given node.
*
* @param node Node or Node ID to get URL for.
* @param attachment Toggles whether to retrieve content as an attachment for download
* @param ticket Custom ticket to use for authentication
Expand Down Expand Up @@ -75,6 +76,7 @@ export class ContentService {

/**
* Checks if the user has permission on that node
*
* @param node Node to check permissions
* @param permission Required permission type
* @param userId Optional current user id will be taken by default
Expand Down Expand Up @@ -108,6 +110,7 @@ export class ContentService {

/**
* Checks if the user has permissions on that node
*
* @param node Node to check allowableOperations
* @param allowableOperation Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
* @returns True if the user has the required permissions, false otherwise
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export class DiscoveryApiService {

/**
* Gets product information for Content Services.
*
* @returns ProductVersionModel containing product details
*/
getEcmProductInfo(): Observable<RepositoryInfo> {
Expand All @@ -63,6 +64,7 @@ export class DiscoveryApiService {

/**
* Gets product information for Process Services.
*
* @returns ProductVersionModel containing product details
*/
getBpmProductInfo(): Observable<BpmProductVersionModel> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ export class FavoritesApiService {

/**
* Gets the favorites for a user.
*
* @param personId ID of the user
* @param options Options supported by JS-API
* @returns List of favorites
Expand Down
12 changes: 12 additions & 0 deletions lib/content-services/src/lib/common/services/nodes-api.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ export class NodesApiService {

/**
* Gets the stored information about a node.
*
* @param nodeId ID of the target node
* @param options Optional parameters supported by JS-API
* @returns Node information
Expand All @@ -81,6 +82,7 @@ export class NodesApiService {

/**
* Gets the items contained in a folder node.
*
* @param nodeId ID of the target node
* @param options Optional parameters supported by JS-API
* @returns List of child items from the folder
Expand All @@ -98,6 +100,7 @@ export class NodesApiService {

/**
* Creates a new document node inside a folder.
*
* @param parentNodeId ID of the parent folder node
* @param nodeBody Data for the new node
* @param options Optional parameters supported by JS-API
Expand All @@ -112,6 +115,7 @@ export class NodesApiService {

/**
* Creates a new folder node inside a parent folder.
*
* @param parentNodeId ID of the parent folder node
* @param nodeBody Data for the new folder
* @param options Optional parameters supported by JS-API
Expand All @@ -124,6 +128,7 @@ export class NodesApiService {

/**
* Updates the information about a node.
*
* @param nodeId ID of the target node
* @param nodeBody New data for the node
* @param options Optional parameters supported by JS-API
Expand All @@ -143,6 +148,7 @@ export class NodesApiService {

/**
* Moves a node to the trashcan.
*
* @param nodeId ID of the target node
* @param options Optional parameters supported by JS-API
* @returns Empty result that notifies when the deletion is complete
Expand All @@ -153,6 +159,7 @@ export class NodesApiService {

/**
* Restores a node previously moved to the trashcan.
*
* @param nodeId ID of the node to restore
* @returns Details of the restored node
*/
Expand All @@ -165,6 +172,7 @@ export class NodesApiService {

/**
* Get the metadata and the nodeType for a nodeId cleaned by the prefix.
*
* @param nodeId ID of the target node
* @returns Node metadata
*/
Expand All @@ -174,6 +182,7 @@ export class NodesApiService {

/**
* Gets the list of holds assigned to the node.
*
* @param nodeId ID of the target node
* @param options Optional parameters supported by JS-API
* @param options.includeSource Also include **source** (in addition to **entries**) with folder information on **nodeId**
Expand All @@ -200,6 +209,7 @@ export class NodesApiService {

/**
* Gets content for the given node.
*
* @param nodeId ID of the target node
* @returns Content data
*/
Expand All @@ -209,6 +219,7 @@ export class NodesApiService {

/**
* Create a new Node inside `-root-` folder
*
* @param name Node name
* @param nodeType Node type
* @param properties Node body properties
Expand All @@ -227,6 +238,7 @@ export class NodesApiService {

/**
* Create a new Node from form metadata.
*
* @param nodeType Node type
* @param nameSpace Namespace for properties
* @param data Property data to store in the node under namespace
Expand Down
Loading

0 comments on commit 444327a

Please sign in to comment.