Shahed Nasser
f132535056
* docs: added cart conceptual guide * changed link of idempotency key * apply suggestions from code review Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com> * tiny change * Used correct entity name representation * small fixes in totals section --------- Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
120 lines
3.0 KiB
TypeScript
120 lines
3.0 KiB
TypeScript
import {
|
|
BeforeInsert,
|
|
Column,
|
|
CreateDateColumn,
|
|
Entity,
|
|
Index,
|
|
PrimaryColumn,
|
|
} from "typeorm"
|
|
import { DbAwareColumn, resolveDbType } from "../utils/db-aware-column"
|
|
|
|
import { generateEntityId } from "../utils/generate-entity-id"
|
|
|
|
@Entity()
|
|
export class IdempotencyKey {
|
|
@PrimaryColumn()
|
|
id: string
|
|
|
|
@Index({ unique: true })
|
|
@Column()
|
|
idempotency_key: string
|
|
|
|
@CreateDateColumn({ type: resolveDbType("timestamptz") })
|
|
created_at: Date
|
|
|
|
@DbAwareColumn({ type: "timestamptz", nullable: true })
|
|
locked_at: Date
|
|
|
|
@Column({ nullable: true })
|
|
request_method: string
|
|
|
|
@DbAwareColumn({ type: "jsonb", nullable: true })
|
|
request_params: Record<string, unknown>
|
|
|
|
@Column({ nullable: true })
|
|
request_path: string
|
|
|
|
@Column({ type: "int", nullable: true })
|
|
response_code: number
|
|
|
|
@DbAwareColumn({ type: "jsonb", nullable: true })
|
|
response_body: Record<string, unknown>
|
|
|
|
@Column({ default: "started" })
|
|
recovery_point: string
|
|
|
|
@BeforeInsert()
|
|
private beforeInsert(): void {
|
|
this.id = generateEntityId(this.id, "ikey")
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @schema IdempotencyKey
|
|
* title: "Idempotency Key"
|
|
* description: "Idempotency Key is used to continue a process in case of any failure that might occur."
|
|
* type: object
|
|
* required:
|
|
* - created_at
|
|
* - id
|
|
* - idempotency_key
|
|
* - locked_at
|
|
* - recovery_point
|
|
* - response_code
|
|
* - response_body
|
|
* - request_method
|
|
* - request_params
|
|
* - request_path
|
|
* properties:
|
|
* id:
|
|
* description: The idempotency key's ID
|
|
* type: string
|
|
* example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A
|
|
* idempotency_key:
|
|
* description: The unique randomly generated key used to determine the state of a process.
|
|
* type: string
|
|
* externalDocs:
|
|
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
|
* description: Learn more how to use the idempotency key.
|
|
* created_at:
|
|
* description: Date which the idempotency key was locked.
|
|
* type: string
|
|
* format: date-time
|
|
* locked_at:
|
|
* description: Date which the idempotency key was locked.
|
|
* nullable: true
|
|
* type: string
|
|
* format: date-time
|
|
* request_method:
|
|
* description: The method of the request
|
|
* nullable: true
|
|
* type: string
|
|
* example: POST
|
|
* request_params:
|
|
* description: The parameters passed to the request
|
|
* nullable: true
|
|
* type: object
|
|
* example:
|
|
* id: cart_01G8ZH853Y6TFXWPG5EYE81X63
|
|
* request_path:
|
|
* description: The request's path
|
|
* nullable: true
|
|
* type: string
|
|
* example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete
|
|
* response_code:
|
|
* description: The response's code.
|
|
* nullable: true
|
|
* type: string
|
|
* example: 200
|
|
* response_body:
|
|
* description: The response's body
|
|
* nullable: true
|
|
* type: object
|
|
* example:
|
|
* id: cart_01G8ZH853Y6TFXWPG5EYE81X63
|
|
* recovery_point:
|
|
* description: Where to continue from.
|
|
* type: string
|
|
* default: started
|
|
*/
|