@shopify/shop-minis-platform 0.0.9 → 0.0.11

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shopify/shop-minis-platform",
   "license": "SEE LICENSE IN LICENSE.txt",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Shared type definitions for Shop Minis Platform",
   "main": "src/index.ts",
   "exports": {

package/src/actions/actions.ts

@@ -86,6 +86,7 @@ import {
   CreateContentResponse,
   GetContentParams,
   GetContentResponse,
+  GenerateUserTokenResponse,
 } from './params'
 import {ShopAction, SnakeToCamelCase} from './shared'
 
@@ -214,4 +215,5 @@ export interface ShopActionEvents {
   PREVIEW_PRODUCT_IN_AR: ShopAction<PreviewProductInARParams, void>
   CREATE_CONTENT: ShopAction<CreateContentParams, CreateContentResponse>
   GET_CONTENT: ShopAction<GetContentParams, GetContentResponse>
+  GENERATE_USER_TOKEN: ShopAction<void, GenerateUserTokenResponse>
 }

package/src/actions/params.ts

@@ -15,6 +15,8 @@ import {
   Content,
   ContentCreateUserErrors,
   ContentIdentifierInput,
+  UserTokenGenerateUserErrors,
+  GeneratedTokenData,
 } from '../types'
 
 export interface FavoriteParams {
@@ -630,3 +632,8 @@ export interface GetContentParams {
 export interface GetContentResponse {
   data: Content[]
 }
+
+export interface GenerateUserTokenResponse {
+  data: GeneratedTokenData
+  userErrors?: UserTokenGenerateUserErrors[]
+}

package/src/types/content.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @shopify/typescript/prefer-pascal-case-enums */
-export interface Image {
+export interface ImageType {
   url: string
   altText?: string | null
   height?: number | null
@@ -16,6 +16,8 @@ export interface ContentImage {
   url: string
   width?: number | null
   height?: number | null
+  thumbhash?: string | null
+  altText?: string | null
 }
 
 export interface ContentProduct {

package/src/types/shop.ts

@@ -1,4 +1,4 @@
-import type {Image} from './content'
+import type {ImageType} from './content'
 import type {ProductImage} from './product'
 
 export interface Shop {
@@ -19,8 +19,8 @@ export interface Shop {
 
 export interface VisualTheme {
   id: string
-  logoImage?: Image | null
-  featuredImages: Image[]
+  logoImage?: ImageType | null
+  featuredImages: ImageType[]
   description?: string | null
   brandSettings?: BrandSettings | null
 }
@@ -45,14 +45,14 @@ export interface ColorTheme {
 
 export interface LogoTheme {
   id: string
-  logoImage?: Image | null
+  logoImage?: ImageType | null
 }
 
 export interface HeaderTheme {
   id: string
-  coverImage?: Image | null
-  thumbnailImage?: Image | null
-  wordmark?: Image | null
+  coverImage?: ImageType | null
+  thumbnailImage?: ImageType | null
+  wordmark?: ImageType | null
   videoUrl?: string | null
   startingScrimColor?: string | null
   endingScrimColor?: string | null

package/src/types/user.ts

@@ -1,4 +1,4 @@
-export interface UserProfile {
+/* eslint-disable @shopify/typescript/prefer-pascal-case-enums */ export interface UserProfile {
   displayName?: string | null
   avatarImage?: {
     url: string
@@ -17,3 +17,36 @@ export interface TaxonomyCategory {
   name: string
   ancestors?: TaxonomyCategory[]
 }
+
+export enum UserTokenGenerateUserErrorCode {
+  MINI_NOT_FOUND = 'MINI_NOT_FOUND',
+  USER_NOT_FOUND = 'USER_NOT_FOUND',
+}
+
+export enum UserState {
+  GUEST = 'GUEST',
+  VERIFIED = 'VERIFIED',
+}
+
+export type ISO8601DateTime = string
+
+export interface UserTokenGenerateUserErrors {
+  code: UserTokenGenerateUserErrorCode
+  message: string
+  field?: string[] | null
+}
+
+export interface GeneratedTokenData {
+  /**
+   * A temporary token for the user.
+   */
+  token?: string | null
+  /**
+   * The expiration time of the token.
+   */
+  expiresAt?: ISO8601DateTime | null
+  /**
+   * Whether the user is verified or a guest.
+   */
+  userState?: UserState | null
+}