From 873f4b85fc2076c76e7843d8a08abc8ad50226c5 Mon Sep 17 00:00:00 2001 From: Richard Steinmetz Date: Tue, 17 Oct 2023 14:32:46 +0200 Subject: chore: add type changes Those changes were generated using the recommended node and npm version by running `npm run build`. Signed-off-by: Richard Steinmetz --- src/models/circle.d.ts | 297 +++++++++++++++++++++++----------------------- src/models/constants.d.ts | 39 +++--- src/models/member.d.ts | 137 ++++++++++----------- src/services/circles.d.ts | 43 +++---- 4 files changed, 262 insertions(+), 254 deletions(-) diff --git a/src/models/circle.d.ts b/src/models/circle.d.ts index 326d2a50..0ea37902 100644 --- a/src/models/circle.d.ts +++ b/src/models/circle.d.ts @@ -19,157 +19,162 @@ * along with this program. If not, see . * */ -import Member from './member' +import Member from './member'; type MemberList = Record; export default class Circle { - - _data: any - _members: MemberList - _owner: Member - _initiator: Member - /** - * Creates an instance of Circle - */ - constructor(data: object); - /** - * Update inner circle data, owner and initiator - */ - updateData(data: any): void; - /** - * Circle id - */ - get id(): string; - /** - * Formatted display name - */ - get displayName(): string; - /** - * Set the display name - */ - set displayName(text: string); - /** - * Circle creation date - */ - get creation(): number; - /** - * Circle description - */ - get description(): string; - /** - * Circle description - */ - set description(text: string); - /** - * Circle member count - */ - get population(): any; - /** - * Circle ini_initiator the current - * user info for this circle - * null if not a member - */ - get initiator(): Member | null; - /** - * Set new circle initiator - * null if not a member - */ - set initiator(initiator: Member | null); - /** - * Circle ownership - */ - get owner(): Member; - /** - * Set new circle owner - */ - set owner(owner: Member); - /** - * Circle members - */ - get members(): MemberList; - /** - * Define members circle - */ - set members(members: MemberList); - /** - * Add a member to this circle - */ - addMember(member: Member): void; - /** - * Remove a member from this circle - */ - deleteMember(member: Member): void; - get settings(): any; - /** - * Circle config - */ - get config(): number; - /** - * Define circle config - */ - set config(config: number); - /** - * Circle is personal - */ - get isPersonal(): boolean; - /** - * Circle requires invite to be confirmed by moderator or above - */ - get requireJoinAccept(): boolean; - /** - * Circle can be requested to join - */ - get canJoin(): boolean; - /** - * Circle is visible to others - */ - get isVisible(): boolean; - /** - * Circle requires invite to be accepted by the member - */ - get requireInviteAccept(): boolean; - /** - * Can the initiator add members to this circle? - */ - get isOwner(): boolean; - /** - * Is the initiator an admin of this circle? - */ - get isAdmin(): boolean; - /** - * Is the initiator a member of this circle? - */ - get isMember(): boolean | 0 | undefined; - /** - * Is the initiator a pending member of this circle? - */ - get isPendingMember(): boolean; - /** - * Can the initiator delete this circle? - */ - get canDelete(): boolean; - /** - * Can the initiator leave this circle? - */ - get canLeave(): boolean | 0 | undefined; - /** - * Can the initiator add/remove members to this circle? - */ - get canManageMembers(): boolean; - /** - * Vue router param - */ - get router(): { + _data: any; + _members: MemberList; + _owner: Member; + _initiator: Member; + /** + * Creates an instance of Circle + * + * @param data + */ + constructor(data: object); + /** + * Update inner circle data, owner and initiator + * + * @param data + */ + updateData(data: any): void; + /** + * Circle id + */ + get id(): string; + /** + * Formatted display name + */ + get displayName(): string; + /** + * Set the display name + */ + set displayName(text: string); + /** + * Circle creation date + */ + get creation(): number; + /** + * Circle description + */ + get description(): string; + /** + * Circle description + */ + set description(text: string); + /** + * Circle member count + */ + get population(): any; + /** + * Circle ini_initiator the current + * user info for this circle + * null if not a member + */ + get initiator(): Member | null; + /** + * Set new circle initiator + * null if not a member + */ + set initiator(initiator: Member | null); + /** + * Circle ownership + */ + get owner(): Member; + /** + * Set new circle owner + */ + set owner(owner: Member); + /** + * Circle members + */ + get members(): MemberList; + /** + * Define members circle + */ + set members(members: MemberList); + /** + * Add a member to this circle + * + * @param member + */ + addMember(member: Member): void; + /** + * Remove a member from this circle + * + * @param member + */ + deleteMember(member: Member): void; + get settings(): any; + /** + * Circle config + */ + get config(): number; + /** + * Define circle config + */ + set config(config: number); + /** + * Circle is personal + */ + get isPersonal(): boolean; + /** + * Circle requires invite to be confirmed by moderator or above + */ + get requireJoinAccept(): boolean; + /** + * Circle can be requested to join + */ + get canJoin(): boolean; + /** + * Circle is visible to others + */ + get isVisible(): boolean; + /** + * Circle requires invite to be accepted by the member + */ + get requireInviteAccept(): boolean; + /** + * Can the initiator add members to this circle? + */ + get isOwner(): boolean; + /** + * Is the initiator an admin of this circle? + */ + get isAdmin(): boolean; + /** + * Is the initiator a member of this circle? + */ + get isMember(): boolean | 0 | undefined; + /** + * Is the initiator a pending member of this circle? + */ + get isPendingMember(): boolean; + /** + * Can the initiator delete this circle? + */ + get canDelete(): boolean; + /** + * Can the initiator leave this circle? + */ + get canLeave(): boolean | 0 | undefined; + /** + * Can the initiator add/remove members to this circle? + */ + get canManageMembers(): boolean; + /** + * Vue router param + */ + get router(): { name: string; params: { selectedCircle: string; }; }; - - /** - * Default javascript fallback - * Used for sorting as well - */ - toString(): string; - + /** + * Default javascript fallback + * Used for sorting as well + */ + toString(): string; } -export {} +export {}; diff --git a/src/models/constants.d.ts b/src/models/constants.d.ts index 8d28b2da..5fc1c9c5 100644 --- a/src/models/constants.d.ts +++ b/src/models/constants.d.ts @@ -19,41 +19,40 @@ * along with this program. If not, see . * */ -import { Type } from '@nextcloud/sharing' +import { Type } from '@nextcloud/sharing'; export type DefaultGroup = string; export type DefaultChart = string; export type CircleConfig = number; export type MemberLevel = number; export type MemberType = number; -export declare const LIST_SIZE = 60 -export declare const GROUP_ALL_CONTACTS: DefaultGroup -export declare const GROUP_NO_GROUP_CONTACTS: DefaultGroup -export declare const GROUP_RECENTLY_CONTACTED: DefaultGroup -export declare const CHART_ALL_CONTACTS: DefaultChart -export declare const ROUTE_CIRCLE = 'circle' -export declare const ROUTE_CHART = 'chart' -export declare const CONTACTS_SETTINGS: DefaultGroup -export declare const ELLIPSIS_COUNT = 5 -export declare const CIRCLE_DESC: string +export declare const LIST_SIZE = 60; +export declare const GROUP_ALL_CONTACTS: DefaultGroup; +export declare const GROUP_NO_GROUP_CONTACTS: DefaultGroup; +export declare const GROUP_RECENTLY_CONTACTED: DefaultGroup; +export declare const CHART_ALL_CONTACTS: DefaultChart; +export declare const ROUTE_CIRCLE = "circle"; +export declare const ROUTE_CHART = "chart"; +export declare const CONTACTS_SETTINGS: DefaultGroup; +export declare const ELLIPSIS_COUNT = 5; +export declare const CIRCLE_DESC: string; export declare const CIRCLES_MEMBER_TYPES: { [x: number]: string; -} +}; export declare const CIRCLES_MEMBER_LEVELS: { [x: number]: string; -} +}; export declare const PUBLIC_CIRCLE_CONFIG: { [x: string]: { [x: number]: string; }; -} +}; export declare const CIRCLES_MEMBER_GROUPING: { id: string; label: string; share: Type; type: number; -}[] -// eslint-disable-next-line @typescript-eslint/ban-types -export declare const SHARES_TYPES_MEMBER_MAP: {} +}[]; +export declare const SHARES_TYPES_MEMBER_MAP: {}; export declare enum MemberLevels { NONE, MEMBER, @@ -86,7 +85,7 @@ export declare enum CircleConfigs { FEDERATED } export declare enum MemberStatus { - INVITED = 'Invited', - MEMBER = 'Member', - REQUESTING = 'Requesting' + INVITED = "Invited", + MEMBER = "Member", + REQUESTING = "Requesting" } diff --git a/src/models/member.d.ts b/src/models/member.d.ts index a49ee186..59e4015e 100644 --- a/src/models/member.d.ts +++ b/src/models/member.d.ts @@ -19,73 +19,74 @@ * along with this program. If not, see . * */ -import { MemberLevel, MemberType } from './constants' -import Circle from './circle' +import { MemberLevel, MemberType } from './constants'; +import Circle from './circle'; export default class Member { - - _data: any - _circle: Circle - /** - * Creates an instance of Member - */ - constructor(data: any, circle: Circle); - /** - * Get the circle of this member - */ - get circle(): Circle; - /** - * Set the circle of this member - */ - set circle(circle: Circle); - /** - * Member id - */ - get id(): string; - /** - * Single uid - */ - get singleId(): string; - /** - * Formatted display name - */ - get displayName(): string; - /** - * Member userId - */ - get userId(): string; - /** - * Member type - */ - get userType(): MemberType; - /** - * Member based on source - */ - get basedOn(): any; - /** - * Member level - * - */ - get level(): MemberLevel; - /** - * Set member level - */ - set level(level: MemberLevel); - /** - * Member request status - * - */ - get status(): string; - /** - * Is the current member a user? - */ - get isUser(): boolean; - /** - * Is the current member without a circle? - */ - get isOrphan(): boolean; - /** - * Delete this member and any reference from its circle - */ - delete(): void; - + _data: any; + _circle: Circle; + /** + * Creates an instance of Member + * + * @param data + * @param circle + */ + constructor(data: any, circle: Circle); + /** + * Get the circle of this member + */ + get circle(): Circle; + /** + * Set the circle of this member + */ + set circle(circle: Circle); + /** + * Member id + */ + get id(): string; + /** + * Single uid + */ + get singleId(): string; + /** + * Formatted display name + */ + get displayName(): string; + /** + * Member userId + */ + get userId(): string; + /** + * Member type + */ + get userType(): MemberType; + /** + * Member based on source + */ + get basedOn(): any; + /** + * Member level + * + */ + get level(): MemberLevel; + /** + * Set member level + */ + set level(level: MemberLevel); + /** + * Member request status + * + */ + get status(): string; + /** + * Is the current member a user? + */ + get isUser(): boolean; + /** + * Is the current member without a circle? + */ + get isOrphan(): boolean; + /** + * Delete this member and any reference from its circle + */ + delete(): void; } diff --git a/src/services/circles.d.ts b/src/services/circles.d.ts index 38caca71..56674901 100644 --- a/src/services/circles.d.ts +++ b/src/services/circles.d.ts @@ -19,17 +19,17 @@ * along with this program. If not, see . * */ -import { MemberLevel, MemberType } from '../models/constants' +import { MemberLevel, MemberType } from '../models/constants'; interface MemberPairs { id: string; type: MemberType; } type CircleEditType = 'name' | 'description' | 'settings' | 'config'; export declare enum CircleEdit { - Name = 'name', - Description = 'description', - Settings = 'settings', - Config = 'config' + Name = "name", + Description = "description", + Settings = "settings", + Config = "config" } interface CircleSetting { setting: string; @@ -40,65 +40,68 @@ interface CircleSetting { * * @return {Array} */ -export declare const getCircles: () => Promise +export declare const getCircles: () => Promise; /** * Get a specific circle * * @param {string} circleId * @return {object} */ -export declare const getCircle: (circleId: string) => Promise +export declare const getCircle: (circleId: string) => Promise; /** * Create a new circle * * @param {string} name the circle name + * @param personal + * @param local * @return {object} */ -export declare const createCircle: (name: string, personal: boolean, local: boolean) => Promise +export declare const createCircle: (name: string, personal: boolean, local: boolean) => Promise; /** * Delete an existing circle * * @param {string} circleId the circle id * @return {object} */ -export declare const deleteCircle: (circleId: string) => Promise +export declare const deleteCircle: (circleId: string) => Promise; /** * Edit an existing circle * * @param {string} circleId the circle id * @param {CircleEditType} type the edit type * @param {any} data the data + * @param value * @return {object} */ -export declare const editCircle: (circleId: string, type: CircleEditType, value: any) => Promise +export declare const editCircle: (circleId: string, type: CircleEditType, value: any) => Promise; /** * Join a circle * * @param {string} circleId the circle id * @return {Array} */ -export declare const joinCircle: (circleId: string) => Promise +export declare const joinCircle: (circleId: string) => Promise; /** * Leave a circle * * @param {string} circleId the circle id * @return {Array} */ -export declare const leaveCircle: (circleId: string) => Promise +export declare const leaveCircle: (circleId: string) => Promise; /** * Get the circle members without the members * * @param {string} circleId the circle id * @return {Array} */ -export declare const getCircleMembers: (circleId: string) => Promise +export declare const getCircleMembers: (circleId: string) => Promise; /** * Search a potential circle member * * @param {string} term the search query * @return {Array} */ -export declare const searchMember: (term: string) => Promise +export declare const searchMember: (term: string) => Promise; /** * Add a circle member * @@ -106,7 +109,7 @@ export declare const searchMember: (term: string) => Promise * @param {string} members the member id * @return {Array} */ -export declare const addMembers: (circleId: string, members: Array) => Promise +export declare const addMembers: (circleId: string, members: Array) => Promise; /** * Delete a circle member * @@ -114,7 +117,7 @@ export declare const addMembers: (circleId: string, members: Array) * @param {string} memberId the member id * @return {Array} */ -export declare const deleteMember: (circleId: string, memberId: string) => Promise +export declare const deleteMember: (circleId: string, memberId: string) => Promise; /** * change a member level * @@ -125,7 +128,7 @@ export declare const deleteMember: (circleId: string, memberId: string) => Promi * @param {number} level the new member level * @return {Array} */ -export declare const changeMemberLevel: (circleId: string, memberId: string, level: MemberLevel) => Promise +export declare const changeMemberLevel: (circleId: string, memberId: string, level: MemberLevel) => Promise; /** * Accept a circle member request * @@ -133,6 +136,6 @@ export declare const changeMemberLevel: (circleId: string, memberId: string, lev * @param {string} memberId the member id * @return {Array} */ -export declare const acceptMember: (circleId: string, memberId: string) => Promise -export declare const editCircleSetting: (circleId: string, setting: CircleSetting) => Promise -export {} +export declare const acceptMember: (circleId: string, memberId: string) => Promise; +export declare const editCircleSetting: (circleId: string, setting: CircleSetting) => Promise; +export {}; -- cgit v1.2.3