Class BaseOrganizationsService<O>

The organizations service is responsible for managing organizations.

Type Parameters

O extends BaseOrganization

Constructors

constructor

new BaseOrganizationsService<O extends BaseOrganization>(): BaseOrganizationsService<
O,
>
Type Parameters
- O extends BaseOrganization
Returns BaseOrganizationsService<O>

Properties

`Protected` `Readonly`dataSource

dataSource: DataSource

`Protected` `Readonly`eventEmitter

eventEmitter: EventEmitter2

`Protected` `Readonly`idService

idService: IdService

`Protected` `Readonly`imagesService

imagesService: BaseImagesService

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

Accessors

repository

get repository(): Repository<O>
Returns Repository<O>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:66

Methods

`Protected`applyFilterToQuery

applyFilterToQuery(
    query: SelectQueryBuilder<O>,
    filter: OrganizationsFilter,
    ctx: BaseServiceMethodContext,
): void
Parameters
- query: SelectQueryBuilder<O>
- filter: OrganizationsFilter
- ctx: BaseServiceMethodContext
Returns void
- Defined in libs/core/src/modules/organizations/organizations.service.ts:240

`Protected`applyOrderByToQuery

applyOrderByToQuery(
query: SelectQueryBuilder<O>,
orderBy: OrganizationsOrderBy,
): void
Parameters
- query: SelectQueryBuilder<O>
- orderBy: OrganizationsOrderBy
Returns void
- Defined in libs/core/src/modules/organizations/organizations.service.ts:377

create

create(
opts: CreateOrganizationOptions,
ctx: BaseServiceMethodContext,
): Promise<O>
Create organization.
Parameters
- opts: CreateOrganizationOptions
- ctx: BaseServiceMethodContext
Returns Promise<O>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:407

delete

delete(id: string, ctx: BaseServiceMethodContext): Promise<void>
Soft delete organization by id.
Parameters
- id: string
  organization id
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<void>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:559

fetchUserOrganizations

fetchUserOrganizations(userId: string): Promise<O[]>
Get organizations list for user.
Parameters
- userId: string
  user id
Returns Promise<O[]>
organizations list for user
- Defined in libs/core/src/modules/organizations/organizations.service.ts:387

generateCode

generateCode(
opts: GenerateOrganizationOptions,
): Promise<GenerateOrganizationResult>
Parameters
- opts: GenerateOrganizationOptions
Returns Promise<GenerateOrganizationResult>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:76

`Protected`generateEntityId

generateEntityId(): string
Returns string
- Defined in libs/core/src/modules/organizations/organizations.service.ts:400

getMany

getMany(
__namedParameters: FetchOrganizationsOptions,
ctx: BaseServiceMethodContext,
): Promise<[O[], ListMeta]>
Get organizations list.
Parameters
- __namedParameters: FetchOrganizationsOptions
- ctx: BaseServiceMethodContext
Returns Promise<[O[], ListMeta]>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:214

getOne

getOne(id: string): Promise<MaybeNull<O>>
Get one organization by id.
Parameters
- id: string
  The organization id.
Returns Promise<MaybeNull<O>>
The organization if exists or null.
- Defined in libs/core/src/modules/organizations/organizations.service.ts:122

getOneBy

getOneBy(opts: FetchOrganizationByOptions): Promise<MaybeNull<O>>
Get one organization by materialId or code & groupId.
Parameters
- opts: FetchOrganizationByOptions
  The options to fetch organization.
Returns Promise<MaybeNull<O>>
The organization if exists or null.
- Defined in libs/core/src/modules/organizations/organizations.service.ts:134

getOneByMaterialIdOrFail

getOneByMaterialIdOrFail(
materialId: string,
ctx: BaseServiceMethodContext,
): Promise<O>
Parameters
- materialId: string
- ctx: BaseServiceMethodContext
Returns Promise<O>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:191

getOneOrFail

getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise<O>
Get organization by id or throw an error if not found.
Parameters
- id: string
  The organization id.
- ctx: BaseServiceMethodContext
  The service method context.
Returns Promise<O>
The organization if exists or throws an error.
- Defined in libs/core/src/modules/organizations/organizations.service.ts:173

isUniqueOrganizationCode

isUniqueOrganizationCode(
__namedParameters: IsUniqueOrganizationCodeOptions,
): Promise<boolean>
Parameters
- __namedParameters: IsUniqueOrganizationCodeOptions
Returns Promise<boolean>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:100

onModuleInit

onModuleInit(): void
Returns void
- Defined in libs/core/src/modules/organizations/organizations.service.ts:70

sync

sync(
__namedParameters: SyncOrganizationOptions,
ctx: BaseServiceMethodContext,
): Promise<O>
Sync organization from remote service.
Parameters
- __namedParameters: SyncOrganizationOptions
- ctx: BaseServiceMethodContext
Returns Promise<O>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:507

toggleFeature

toggleFeature(
opts: ToggleOrganizationFeatureOptions,
ctx: BaseServiceMethodContext,
): Promise<O>
Parameters
- opts: ToggleOrganizationFeatureOptions
- ctx: BaseServiceMethodContext
Returns Promise<O>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:488

update

update(
__namedParameters: UpdateOrganizationOptions,
ctx: BaseServiceMethodContext,
): Promise<O>
Update organization.
Parameters
- __namedParameters: UpdateOrganizationOptions
- ctx: BaseServiceMethodContext
Returns Promise<O>
- Defined in libs/core/src/modules/organizations/organizations.service.ts:446