Files
medusa-store/www/apps/docs/content/references/services/classes/OauthService.md
Shahed Nasser fa7c94b4cc docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
2023-09-21 20:57:15 +03:00

8.5 KiB

Class: OauthService

Hierarchy

  • TransactionBaseService

    OauthService

Constructors

constructor

new OauthService(cradle)

Parameters

Name Type
cradle InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/oauth.ts:28

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14


__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13


__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15


container_

Protected container_: InjectedDependencies

Defined in

medusa/src/services/oauth.ts:24


eventBus_

Protected eventBus_: EventBusService

Defined in

medusa/src/services/oauth.ts:26


manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5


oauthRepository_

Protected oauthRepository_: Repository<Oauth>

Defined in

medusa/src/services/oauth.ts:25


transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6


Events

Static Events: Object

Type declaration

Name Type
TOKEN_GENERATED string
TOKEN_REFRESHED string

Defined in

medusa/src/services/oauth.ts:19

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

atomicPhase_

Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
TResult
TError

Parameters

Name Type Description
work (transactionManager: EntityManager) => Promise<TResult> the transactional work to be done
isolationOrErrorHandler? IsolationLevel | (error: TError) => Promise<void | TResult> the isolation level to be used for the work.
maybeErrorHandlerOrDontFail? (error: TError) => Promise<void | TResult> Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56


create

create(data): Promise<Oauth>

Parameters

Name Type
data CreateOauthInput

Returns

Promise<Oauth>

Defined in

medusa/src/services/oauth.ts:87


generateToken

generateToken(appName, code, state): Promise<Oauth>

Parameters

Name Type
appName string
code string
state string

Returns

Promise<Oauth>

Defined in

medusa/src/services/oauth.ts:121


list

list(selector): Promise<Oauth[]>

Parameters

Name Type
selector Selector<Oauth>

Returns

Promise<Oauth[]>

Defined in

medusa/src/services/oauth.ts:79


refreshToken

refreshToken(appName): Promise<Oauth>

Parameters

Name Type
appName string

Returns

Promise<Oauth>

Defined in

medusa/src/services/oauth.ts:155


registerOauthApp

registerOauthApp(appDetails): Promise<Oauth>

Parameters

Name Type
appDetails CreateOauthInput

Returns

Promise<Oauth>

Defined in

medusa/src/services/oauth.ts:111


retrieve

retrieve(oauthId): Promise<Oauth>

Parameters

Name Type
oauthId string

Returns

Promise<Oauth>

Defined in

medusa/src/services/oauth.ts:54


retrieveByName

retrieveByName(appName): Promise<Oauth>

Parameters

Name Type
appName string

Returns

Promise<Oauth>

Defined in

medusa/src/services/oauth.ts:36


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37


update

update(id, update): Promise<Oauth>

Parameters

Name Type
id string
update UpdateOauthInput

Returns

Promise<Oauth>

Defined in

medusa/src/services/oauth.ts:100


withTransaction

withTransaction(transactionManager?): OauthService

Parameters

Name Type
transactionManager? EntityManager

Returns

OauthService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20