Files

Shahed Nasser 914d773d3a api-ref: custom API reference (#4770 )

* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies

2023-08-15 18:07:54 +03:00

7.9 KiB

Raw Blame History

Class: AuthService

Can authenticate a user based on email password combination

Hierarchy

TransactionBaseService

↳ AuthService

Constructors

constructor

• new AuthService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`InjectedDependencies`

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/auth.ts:22

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

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

medusa/src/services/auth.ts:20

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

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

userService_

• Protected Readonly userService_: UserService

Defined in

medusa/src/services/auth.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

authenticate

▸ authenticate(email, password): Promise<AuthenticateResult>

Authenticates a given user based on an email, password combination. Uses scrypt to match password with hashed value.

Parameters

Name	Type	Description
`email`	`string`	the email of the user
`password`	`string`	the password of the user

Returns

Promise<AuthenticateResult>

success: whether authentication succeeded user: the user document if authentication succeded error: a string with the error message

Defined in

medusa/src/services/auth.ts:95

authenticateAPIToken

▸ authenticateAPIToken(token): Promise<AuthenticateResult>

Authenticates a given user with an API token

Parameters

Name	Type	Description
`token`	`string`	the api_token of the user to authenticate

Returns

Promise<AuthenticateResult>

success: whether authentication succeeded user: the user document if authentication succeded error: a string with the error message

Defined in

medusa/src/services/auth.ts:52

authenticateCustomer

▸ authenticateCustomer(email, password): Promise<AuthenticateResult>

Authenticates a customer based on an email, password combination. Uses scrypt to match password with hashed value.

Parameters

Name	Type	Description
`email`	`string`	the email of the user
`password`	`string`	the password of the user

Returns

Promise<AuthenticateResult>

success: whether authentication succeeded user: the user document if authentication succeded error: a string with the error message

Defined in

medusa/src/services/auth.ts:144

comparePassword_

▸ Protected comparePassword_(password, hash): Promise<boolean>

Verifies if a password is valid given the provided password hash

Parameters

Name	Type	Description
`password`	`string`	the raw password to check
`hash`	`string`	the hash to compare against

Returns

Promise<boolean>

the result of the comparison

Defined in

medusa/src/services/auth.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

withTransaction

▸ withTransaction(transactionManager?): AuthService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

AuthService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

7.9 KiB Raw Blame History

Class: AuthService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

__configModule__

Inherited from

Defined in

__container__

Inherited from

Defined in

__moduleDeclaration__

Inherited from

Defined in

customerService_

Defined in

manager_

Inherited from

Defined in

transactionManager_

Inherited from

Defined in

userService_

Defined in

Accessors

activeManager_

Returns

Inherited from

Defined in

Methods

atomicPhase_

Type parameters

Parameters

Returns

Inherited from

Defined in

authenticate

Parameters

Returns

Defined in

authenticateAPIToken

Parameters

Returns

Defined in

authenticateCustomer

Parameters

Returns

Defined in

comparePassword_

Parameters

Returns

Defined in

shouldRetryTransaction_

Parameters

Returns

Inherited from

Defined in

withTransaction

Parameters

Returns

Inherited from

Defined in

7.9 KiB

Raw Blame History

configModule

container

moduleDeclaration