diff --git a/.changeset/cuddly-steaks-exist.md b/.changeset/cuddly-steaks-exist.md deleted file mode 100644 index 230ac0e67b..0000000000 --- a/.changeset/cuddly-steaks-exist.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/app': patch ---- - -Updates Javy to version 3.1.1 diff --git a/.changeset/hip-chefs-dance.md b/.changeset/hip-chefs-dance.md deleted file mode 100644 index 803ae4e91b..0000000000 --- a/.changeset/hip-chefs-dance.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/theme': patch ---- - -Fix Theme Access authentication on `shopify theme dev` and `shopify theme console` commands diff --git a/.changeset/metal-eggs-tap.md b/.changeset/metal-eggs-tap.md deleted file mode 100644 index 25ee24b358..0000000000 --- a/.changeset/metal-eggs-tap.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'@shopify/theme': patch -'@shopify/app': patch ---- - -Fixes a bug where some users were unable to intialize their app dev command with theme app extensions diff --git a/.changeset/nervous-sloths-wash.md b/.changeset/nervous-sloths-wash.md deleted file mode 100644 index adb8387c3d..0000000000 --- a/.changeset/nervous-sloths-wash.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/cli-kit': patch ---- - -Fix a bug when building empty theme assets diff --git a/docs/api/cli-kit/classes/node_abort.AbortController.html b/docs/api/cli-kit/classes/node_abort.AbortController.html index 4728fda600..e4de6ffb9a 100644 --- a/docs/api/cli-kit/classes/node_abort.AbortController.html +++ b/docs/api/cli-kit/classes/node_abort.AbortController.html @@ -4,5 +4,5 @@

This class is necessary because AbortController support was added to Node 15 and the minimum version that we support is Node 14.

-

Hierarchy

Constructors

constructor +

Hierarchy

  • AbortController
    • AbortController

Constructors

constructor

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_abort.AbortSignal.html b/docs/api/cli-kit/classes/node_abort.AbortSignal.html index fb5648244b..d12887054c 100644 --- a/docs/api/cli-kit/classes/node_abort.AbortSignal.html +++ b/docs/api/cli-kit/classes/node_abort.AbortSignal.html @@ -1,3 +1,3 @@ AbortSignal | @shopify/cli-kit

Class AbortSignal

The AbortSignal interface represents a signal object that allows you to communicate with a DOM request (such as a fetch request) and abort it if required via an AbortController object.

-

Hierarchy

  • AbortSignal
    • AbortSignal

Constructors

constructor +

Hierarchy

  • AbortSignal
    • AbortSignal

Constructors

constructor

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor
\ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_base_command.default.html b/docs/api/cli-kit/classes/node_base_command.default.html index c92e353afd..6de82e1e35 100644 --- a/docs/api/cli-kit/classes/node_base_command.default.html +++ b/docs/api/cli-kit/classes/node_base_command.default.html @@ -1,4 +1,4 @@ -default | @shopify/cli-kit

Class defaultAbstract

Hierarchy

  • Command
    • default

Constructors

constructor +default | @shopify/cli-kit

Class defaultAbstract

Hierarchy

  • Command
    • default

Constructors

constructor

Properties

baseFlags

Methods

catch environmentsFilename @@ -11,4 +11,4 @@ analyticsNameOverride analyticsStopCommand descriptionWithoutMarkdown -

Constructors

constructor

  • new default(argv, config): default

  • Parameters

    • argv: string[]
    • config: Config

    Returns default

Properties

Static baseFlags

baseFlags: FlagInput<{}> = {}

Type declaration

    Methods

    catch

    Protected environmentsFilename

    Protected exitWithTimestampWhenEnvVariablePresent

    Protected failMissingNonTTYFlags

    Protected init

    Protected parse

    Private resultWithEnvironment

    Protected showNpmFlagWarning

    Static analyticsNameOverride

    Static analyticsStopCommand

    Static descriptionWithoutMarkdown

    Settings

    Member Visibility

    Theme

    On This Page

    constructorbaseFlagscatchenvironmentsFilenameexitWithTimestampWhenEnvVariablePresentfailMissingNonTTYFlagsinitparseresultWithEnvironmentshowNpmFlagWarninganalyticsNameOverrideanalyticsStopCommanddescriptionWithoutMarkdown
    \ No newline at end of file +

    Constructors

    constructor

    • new default(argv, config): default

    • Parameters

      • argv: string[]
      • config: Config

      Returns default

    Properties

    Static baseFlags

    baseFlags: FlagInput<{}> = {}

    Type declaration

      Methods

      catch

      Protected environmentsFilename

      Protected exitWithTimestampWhenEnvVariablePresent

      Protected failMissingNonTTYFlags

      Protected init

      Protected parse

      Private resultWithEnvironment

      Protected showNpmFlagWarning

      Static analyticsNameOverride

      Static analyticsStopCommand

      Static descriptionWithoutMarkdown

      Settings

      Member Visibility

      Theme

      On This Page

      constructorbaseFlagscatchenvironmentsFilenameexitWithTimestampWhenEnvVariablePresentfailMissingNonTTYFlagsinitparseresultWithEnvironmentshowNpmFlagWarninganalyticsNameOverrideanalyticsStopCommanddescriptionWithoutMarkdown
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_custom_oclif_loader.ShopifyConfig.html b/docs/api/cli-kit/classes/node_custom_oclif_loader.ShopifyConfig.html index 39b3a231a4..f201fe631a 100644 --- a/docs/api/cli-kit/classes/node_custom_oclif_loader.ShopifyConfig.html +++ b/docs/api/cli-kit/classes/node_custom_oclif_loader.ShopifyConfig.html @@ -1,3 +1,3 @@ -ShopifyConfig | @shopify/cli-kit

      Class ShopifyConfig

      Hierarchy

      • Config
        • ShopifyConfig

      Constructors

      constructor +ShopifyConfig | @shopify/cli-kit

      Class ShopifyConfig

      Hierarchy

      • Config
        • ShopifyConfig

      Constructors

      constructor

      Methods

      customPriority -

      Constructors

      constructor

      Methods

      customPriority

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomPriority
      \ No newline at end of file +

      Constructors

      constructor

      Methods

      customPriority

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomPriority
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_error.AbortError.html b/docs/api/cli-kit/classes/node_error.AbortError.html index ef0f8d45e5..0955e1eee6 100644 --- a/docs/api/cli-kit/classes/node_error.AbortError.html +++ b/docs/api/cli-kit/classes/node_error.AbortError.html @@ -1,10 +1,10 @@ AbortError | @shopify/cli-kit

      Class AbortError

      An abort error is a fatal error that shouldn't be reported as a bug. Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      customSections? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type -

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_error.AbortSilentError.html b/docs/api/cli-kit/classes/node_error.AbortSilentError.html index b588a3ea0c..989373e23b 100644 --- a/docs/api/cli-kit/classes/node_error.AbortSilentError.html +++ b/docs/api/cli-kit/classes/node_error.AbortSilentError.html @@ -1,10 +1,10 @@ AbortSilentError | @shopify/cli-kit

      Class AbortSilentError

      A fatal error represents an error shouldn't be rescued and that causes the execution to terminate. There shouldn't be code that catches fatal errors.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      customSections? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type -

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_error.BugError.html b/docs/api/cli-kit/classes/node_error.BugError.html index 897dfcfe7f..cf6b735736 100644 --- a/docs/api/cli-kit/classes/node_error.BugError.html +++ b/docs/api/cli-kit/classes/node_error.BugError.html @@ -1,9 +1,9 @@ BugError | @shopify/cli-kit

      Class BugError

      A bug error is an error that represents a bug and therefore should be reported.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      customSections? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type -

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_error.CancelExecution.html b/docs/api/cli-kit/classes/node_error.CancelExecution.html index ce8e7ca53e..69e8670323 100644 --- a/docs/api/cli-kit/classes/node_error.CancelExecution.html +++ b/docs/api/cli-kit/classes/node_error.CancelExecution.html @@ -1,2 +1,2 @@ -CancelExecution | @shopify/cli-kit

      Class CancelExecution

      Hierarchy

      • Error
        • CancelExecution

      Constructors

      constructor +CancelExecution | @shopify/cli-kit

      Class CancelExecution

      Hierarchy

      • Error
        • CancelExecution

      Constructors

      constructor

      Constructors

      constructor

      • new CancelExecution(message?): CancelExecution

      • Parameters

        • Optional message: string

        Returns CancelExecution

      • new CancelExecution(message?, options?): CancelExecution

      • Parameters

        • Optional message: string
        • Optional options: ErrorOptions

        Returns CancelExecution

      Settings

      Member Visibility

      Theme

      On This Page

      constructor
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_error.ExternalError.html b/docs/api/cli-kit/classes/node_error.ExternalError.html index ed5ad5a510..d81403e53c 100644 --- a/docs/api/cli-kit/classes/node_error.ExternalError.html +++ b/docs/api/cli-kit/classes/node_error.ExternalError.html @@ -1,6 +1,6 @@ ExternalError | @shopify/cli-kit

      Class ExternalError

      An external error is similar to Abort but has extra command and args attributes. This is useful to represent errors coming from external commands, usually executed by execa.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      args command customSections? @@ -9,4 +9,4 @@ skipOclifErrorHandling tryMessage type -

      Constructors

      constructor

      Properties

      args

      args: string[]

      command

      command: string

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorargscommandcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      args

      args: string[]

      command

      command: string

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorargscommandcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_error.FatalError.html b/docs/api/cli-kit/classes/node_error.FatalError.html index 9ec5dcbed1..7c4cfedb40 100644 --- a/docs/api/cli-kit/classes/node_error.FatalError.html +++ b/docs/api/cli-kit/classes/node_error.FatalError.html @@ -1,6 +1,6 @@ FatalError | @shopify/cli-kit

      Class FatalErrorAbstract

      A fatal error represents an error shouldn't be rescued and that causes the execution to terminate. There shouldn't be code that catches fatal errors.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      customSections? formattedMessage? nextSteps? @@ -15,4 +15,4 @@ if you need to style the message inside the error Banner component.

    • Optional nextSteps: TokenItem<InlineToken>[]

      Message to show as "next steps" with suggestions to solve the issue.

    • Optional customSections: CustomSection[]

      Custom sections to show in the error banner. To be used if nextSteps is not enough.

      -

      • Returns FatalError

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Returns FatalError

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_git.GitDirectoryNotCleanError.html b/docs/api/cli-kit/classes/node_git.GitDirectoryNotCleanError.html index de3995b828..6c78898f9c 100644 --- a/docs/api/cli-kit/classes/node_git.GitDirectoryNotCleanError.html +++ b/docs/api/cli-kit/classes/node_git.GitDirectoryNotCleanError.html @@ -1,10 +1,10 @@ GitDirectoryNotCleanError | @shopify/cli-kit

      Class GitDirectoryNotCleanError

      An abort error is a fatal error that shouldn't be reported as a bug. Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      customSections? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type -

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_git.OutsideGitDirectoryError.html b/docs/api/cli-kit/classes/node_git.OutsideGitDirectoryError.html index b028c3faa3..2444d21b24 100644 --- a/docs/api/cli-kit/classes/node_git.OutsideGitDirectoryError.html +++ b/docs/api/cli-kit/classes/node_git.OutsideGitDirectoryError.html @@ -1,10 +1,10 @@ OutsideGitDirectoryError | @shopify/cli-kit

      Class OutsideGitDirectoryError

      An abort error is a fatal error that shouldn't be reported as a bug. Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      customSections? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type -

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_local_storage.LocalStorage.html b/docs/api/cli-kit/classes/node_local_storage.LocalStorage.html index 54edc245fa..e1869da5eb 100644 --- a/docs/api/cli-kit/classes/node_local_storage.LocalStorage.html +++ b/docs/api/cli-kit/classes/node_local_storage.LocalStorage.html @@ -1,18 +1,18 @@ LocalStorage | @shopify/cli-kit

      Class LocalStorage<T>

      A wrapper around the conf package that provides a strongly-typed interface for accessing the local storage.

      -

      Type Parameters

      • T extends {
            [key: string]: any;
        }

      Constructors

      constructor +

      Type Parameters

      • T extends {
            [key: string]: any;
        }

      Constructors

      constructor

      Properties

      config

      Methods

      clear delete get set -

      Constructors

      constructor

      Properties

      Private Readonly config

      config: default<T>

      Methods

      clear

      delete

      • delete<TKey>(key): void

      • Delete a value from the local storage.

        +

      Constructors

      constructor

      Properties

      Private Readonly config

      config: default<T>

      Methods

      clear

      delete

      get

      • get<TKey>(key): T[TKey]

      • Get a value from the local storage.

        +

      Returns void

      get

      set

      set

      Settings

      Member Visibility

      Theme

      On This Page

      constructorconfigcleardeletegetset
      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      constructorconfigcleardeletegetset
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_node_package_manager.FindUpAndReadPackageJsonNotFoundError.html b/docs/api/cli-kit/classes/node_node_package_manager.FindUpAndReadPackageJsonNotFoundError.html index 461767390b..cddc0291b4 100644 --- a/docs/api/cli-kit/classes/node_node_package_manager.FindUpAndReadPackageJsonNotFoundError.html +++ b/docs/api/cli-kit/classes/node_node_package_manager.FindUpAndReadPackageJsonNotFoundError.html @@ -2,11 +2,11 @@ hierarchy up can't find a package.json

      Param: directory

      The directory from which the traverse has been done

      Returns

      An abort error.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      • BugError
        • FindUpAndReadPackageJsonNotFoundError

      Constructors

      constructor

      Properties

      customSections? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type -

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_node_package_manager.PackageJsonNotFoundError.html b/docs/api/cli-kit/classes/node_node_package_manager.PackageJsonNotFoundError.html index 438a1997bb..503638f752 100644 --- a/docs/api/cli-kit/classes/node_node_package_manager.PackageJsonNotFoundError.html +++ b/docs/api/cli-kit/classes/node_node_package_manager.PackageJsonNotFoundError.html @@ -2,11 +2,11 @@ a package.json doesn't have it.

      Param: directory

      The path to the directory that should contain a package.json

      Returns

      An abort error.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      customSections? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type -

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_node_package_manager.UnknownPackageManagerError.html b/docs/api/cli-kit/classes/node_node_package_manager.UnknownPackageManagerError.html index 8b041c8233..25c99ec6b6 100644 --- a/docs/api/cli-kit/classes/node_node_package_manager.UnknownPackageManagerError.html +++ b/docs/api/cli-kit/classes/node_node_package_manager.UnknownPackageManagerError.html @@ -1,10 +1,10 @@ UnknownPackageManagerError | @shopify/cli-kit

      Class UnknownPackageManagerError

      Returns an abort error that's thrown when the package manager can't be determined.

      Returns

      An abort error.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      customSections? formattedMessage? nextSteps? skipOclifErrorHandling tryMessage type -

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Optional customSections

      customSections?: CustomSection[]

      Optional formattedMessage

      formattedMessage?: TokenItem

      Optional nextSteps

      nextSteps?: TokenItem<InlineToken>[]

      skipOclifErrorHandling

      skipOclifErrorHandling: boolean

      tryMessage

      tryMessage: null | TokenItem

      type

      type: FatalErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcustomSectionsformattedMessagenextStepsskipOclifErrorHandlingtryMessagetype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_output.TokenizedString.html b/docs/api/cli-kit/classes/node_output.TokenizedString.html index 86ac09a114..459e44e28b 100644 --- a/docs/api/cli-kit/classes/node_output.TokenizedString.html +++ b/docs/api/cli-kit/classes/node_output.TokenizedString.html @@ -1,3 +1,3 @@ -TokenizedString | @shopify/cli-kit

      Class TokenizedString

      Constructors

      constructor +TokenizedString | @shopify/cli-kit

      Class TokenizedString

      Constructors

      constructor

      Properties

      value -

      Constructors

      constructor

      Properties

      value

      value: string

      Settings

      Member Visibility

      Theme

      On This Page

      constructorvalue
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      value

      value: string

      Settings

      Member Visibility

      Theme

      On This Page

      constructorvalue
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_plugins_tunnel.TunnelError.html b/docs/api/cli-kit/classes/node_plugins_tunnel.TunnelError.html index 00cd146a46..8c6e47affe 100644 --- a/docs/api/cli-kit/classes/node_plugins_tunnel.TunnelError.html +++ b/docs/api/cli-kit/classes/node_plugins_tunnel.TunnelError.html @@ -1,3 +1,3 @@ -TunnelError | @shopify/cli-kit

      Class TunnelError

      Hierarchy

      • ExtendableError
        • TunnelError

      Constructors

      constructor +TunnelError | @shopify/cli-kit

      Class TunnelError

      Hierarchy

      • ExtendableError
        • TunnelError

      Constructors

      constructor

      Properties

      type -

      Constructors

      constructor

      Properties

      type

      type: TunnelErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructortype
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      type

      type: TunnelErrorType

      Settings

      Member Visibility

      Theme

      On This Page

      constructortype
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_result.Err.html b/docs/api/cli-kit/classes/node_result.Err.html index 071687477b..5ef6948df4 100644 --- a/docs/api/cli-kit/classes/node_result.Err.html +++ b/docs/api/cli-kit/classes/node_result.Err.html @@ -1,4 +1,4 @@ -Err | @shopify/cli-kit

      Class Err<TValue, TError>

      Type Parameters

      • TValue
      • TError

      Constructors

      constructor +Err | @shopify/cli-kit

      Class Err<TValue, TError>

      Type Parameters

      • TValue
      • TError

      Constructors

      constructor

      Properties

      error

      Methods

      doOnOk isErr @@ -6,17 +6,17 @@ mapError valueOrAbort valueOrBug -

      Constructors

      constructor

      Properties

      Readonly error

      error: TError

      Methods

      doOnOk

      • doOnOk(_handler): Result<TValue, TError>

      • Return an unaltered copy of the Error without doing anything.

        +

      Constructors

      constructor

      Properties

      Readonly error

      error: TError

      Methods

      doOnOk

      isErr

      isErr

      map

      map

      mapError

      mapError

      valueOrAbort

      valueOrBug

      Settings

      Member Visibility

      Theme

      On This Page

      constructorerrordoOnOkisErrmapmapErrorvalueOrAbortvalueOrBug
      \ No newline at end of file +

      valueOrAbort

      valueOrBug

      Settings

      Member Visibility

      Theme

      On This Page

      constructorerrordoOnOkisErrmapmapErrorvalueOrAbortvalueOrBug
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_result.Ok.html b/docs/api/cli-kit/classes/node_result.Ok.html index 5484dd5165..32b37cc702 100644 --- a/docs/api/cli-kit/classes/node_result.Ok.html +++ b/docs/api/cli-kit/classes/node_result.Ok.html @@ -1,4 +1,4 @@ -Ok | @shopify/cli-kit

      Class Ok<TValue, TError>

      Type Parameters

      • TValue
      • TError

      Constructors

      constructor +Ok | @shopify/cli-kit

      Class Ok<TValue, TError>

      Type Parameters

      • TValue
      • TError

      Constructors

      constructor

      Properties

      value

      Methods

      doOnOk isErr @@ -6,18 +6,18 @@ mapError valueOrAbort valueOrBug -

      Constructors

      constructor

      Properties

      Readonly value

      value: TValue

      Methods

      doOnOk

      • doOnOk(handler): Result<TValue, TError>

      • Runs the handler method an return the same an unaltered copy of the Result. It could be used to log an +

      Constructors

      constructor

      Properties

      Readonly value

      value: TValue

      Methods

      doOnOk

      isErr

      isErr

      map

      map

      mapError

      mapError

      valueOrAbort

      valueOrBug

      Settings

      Member Visibility

      Theme

      On This Page

      constructorvaluedoOnOkisErrmapmapErrorvalueOrAbortvalueOrBug
      \ No newline at end of file +

      valueOrAbort

      valueOrBug

      Settings

      Member Visibility

      Theme

      On This Page

      constructorvaluedoOnOkisErrmapmapErrorvalueOrAbortvalueOrBug
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_testing_ui.Stdin.html b/docs/api/cli-kit/classes/node_testing_ui.Stdin.html index 8524b9f18a..27e30fe26e 100644 --- a/docs/api/cli-kit/classes/node_testing_ui.Stdin.html +++ b/docs/api/cli-kit/classes/node_testing_ui.Stdin.html @@ -1,4 +1,4 @@ -Stdin | @shopify/cli-kit

      Class Stdin

      Hierarchy

      • EventEmitter
        • Stdin

      Constructors

      constructor +Stdin | @shopify/cli-kit

      Class Stdin

      Hierarchy

      • EventEmitter
        • Stdin

      Constructors

      constructor

      Properties

      data isTTY read @@ -7,4 +7,4 @@ setRawMode unref write -

      Constructors

      constructor

      Properties

      data

      data: null | string = null

      isTTY

      isTTY: boolean

      read

      read: (() => null | string) = ...

      Type declaration

        • (): null | string

        • Returns null | string

      Methods

      ref

      setEncoding

      setRawMode

      unref

      write

      Settings

      Member Visibility

      Theme

      On This Page

      constructordataisTTYreadrefsetEncodingsetRawModeunrefwrite
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      data

      data: null | string = null

      isTTY

      isTTY: boolean

      read

      read: (() => null | string) = ...

      Type declaration

        • (): null | string

        • Returns null | string

      Methods

      ref

      setEncoding

      setRawMode

      unref

      write

      Settings

      Member Visibility

      Theme

      On This Page

      constructordataisTTYreadrefsetEncodingsetRawModeunrefwrite
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_themes_theme_manager.ThemeManager.html b/docs/api/cli-kit/classes/node_themes_theme_manager.ThemeManager.html index 30e81612fd..b7954f7b2a 100644 --- a/docs/api/cli-kit/classes/node_themes_theme_manager.ThemeManager.html +++ b/docs/api/cli-kit/classes/node_themes_theme_manager.ThemeManager.html @@ -1,4 +1,4 @@ -ThemeManager | @shopify/cli-kit

      Class ThemeManagerAbstract

      Constructors

      constructor +ThemeManager | @shopify/cli-kit

      Class ThemeManagerAbstract

      Constructors

      constructor

      Properties

      adminSession context themeId @@ -8,4 +8,4 @@ generateThemeName removeTheme setTheme -

      Constructors

      constructor

      Properties

      Protected adminSession

      adminSession: AdminSession

      Protected Abstract context

      context: string

      Protected themeId

      themeId: undefined | string

      Methods

      create

      fetch

      findOrCreate

      generateThemeName

      Protected Abstract removeTheme

      Protected Abstract setTheme

      Settings

      Member Visibility

      Theme

      On This Page

      constructoradminSessioncontextthemeIdcreatefetchfindOrCreategenerateThemeNameremoveThemesetTheme
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Protected adminSession

      adminSession: AdminSession

      Protected Abstract context

      context: string

      Protected themeId

      themeId: undefined | string

      Methods

      create

      fetch

      findOrCreate

      generateThemeName

      Protected Abstract removeTheme

      Protected Abstract setTheme

      Settings

      Member Visibility

      Theme

      On This Page

      constructoradminSessioncontextthemeIdcreatefetchfindOrCreategenerateThemeNameremoveThemesetTheme
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_vendor_otel_js_export_InstantaneousMetricReader.InstantaneousMetricReader.html b/docs/api/cli-kit/classes/node_vendor_otel_js_export_InstantaneousMetricReader.InstantaneousMetricReader.html index 2ea217313d..41716e2d8a 100644 --- a/docs/api/cli-kit/classes/node_vendor_otel_js_export_InstantaneousMetricReader.InstantaneousMetricReader.html +++ b/docs/api/cli-kit/classes/node_vendor_otel_js_export_InstantaneousMetricReader.InstantaneousMetricReader.html @@ -1,5 +1,5 @@ -InstantaneousMetricReader | @shopify/cli-kit

      Class InstantaneousMetricReader

      Hierarchy

      • MetricReader
        • InstantaneousMetricReader

      Constructors

      constructor +InstantaneousMetricReader | @shopify/cli-kit

      Class InstantaneousMetricReader

      Hierarchy

      • MetricReader
        • InstantaneousMetricReader

      Constructors

      constructor

      Properties

      _exporter

      Methods

      onForceFlush onShutdown -

      Constructors

      constructor

      Properties

      Private Readonly _exporter

      _exporter: PushMetricExporter

      Methods

      Protected onForceFlush

      Protected onShutdown

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_exporteronForceFlushonShutdown
      \ No newline at end of file +

      Constructors

      constructor

      Properties

      Private Readonly _exporter

      _exporter: PushMetricExporter

      Methods

      Protected onForceFlush

      Protected onShutdown

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_exporteronForceFlushonShutdown
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.BaseOtelService.html b/docs/api/cli-kit/classes/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.BaseOtelService.html index 5b5434cc46..23804a72de 100644 --- a/docs/api/cli-kit/classes/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.BaseOtelService.html +++ b/docs/api/cli-kit/classes/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.BaseOtelService.html @@ -1,4 +1,4 @@ -BaseOtelService | @shopify/cli-kit

      Class BaseOtelService

      Hierarchy (view full)

      Implements

      Constructors

      constructor +BaseOtelService | @shopify/cli-kit

      Class BaseOtelService

      Hierarchy (view full)

      Implements

      Constructors

      constructor

      Properties

      meterProvider metrics prefixMetric @@ -14,6 +14,6 @@ removeOnRecord shutdown

      Constructors

      constructor

      Properties

      Protected Readonly meterProvider

      meterProvider: MeterProvider

      Protected Readonly metrics

      metrics: Map<string, RecordMetricFunction> = ...

      Readonly prefixMetric

      prefixMetric: boolean

      Protected Readonly recordListeners

      recordListeners: Set<OnRecordCallback> = ...

      Readonly serviceName

      serviceName: string

      Methods

      addOnRecord

      Properties

      Protected Readonly meterProvider

      meterProvider: MeterProvider

      Protected Readonly metrics

      metrics: Map<string, RecordMetricFunction> = ...

      Readonly prefixMetric

      prefixMetric: boolean

      Protected Readonly recordListeners

      recordListeners: Set<OnRecordCallback> = ...

      Readonly serviceName

      serviceName: string

      Methods

      addOnRecord

      addView

      getMeterProvider

      Protected notifyRecordListeners

      record

      register

      registerMetric

      removeOnRecord

      shutdown

      Settings

      Member Visibility

      Theme

      On This Page

      constructormeterProvidermetricsprefixMetricrecordListenersserviceNameaddOnRecordaddViewgetMeterProvidernotifyRecordListenersrecordregisterregisterMetricremoveOnRecordshutdown
      \ No newline at end of file +

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

      addView

      getMeterProvider

      Protected notifyRecordListeners

      record

      register

      registerMetric

      removeOnRecord

      shutdown

      Settings

      Member Visibility

      Theme

      On This Page

      constructormeterProvidermetricsprefixMetricrecordListenersserviceNameaddOnRecordaddViewgetMeterProvidernotifyRecordListenersrecordregisterregisterMetricremoveOnRecordshutdown
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.DefaultMeterProvider.html b/docs/api/cli-kit/classes/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.DefaultMeterProvider.html index 075fbeeb33..6177d98f2e 100644 --- a/docs/api/cli-kit/classes/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.DefaultMeterProvider.html +++ b/docs/api/cli-kit/classes/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.DefaultMeterProvider.html @@ -1,2 +1,2 @@ -DefaultMeterProvider | @shopify/cli-kit

      Class DefaultMeterProvider

      Hierarchy

      • MeterProvider
        • DefaultMeterProvider

      Constructors

      constructor -

      Constructors

      constructor

      Settings

      Member Visibility

      Theme

      On This Page

      constructor
      \ No newline at end of file +DefaultMeterProvider | @shopify/cli-kit

      Class DefaultMeterProvider

      Hierarchy

      • MeterProvider
        • DefaultMeterProvider

      Constructors

      constructor +

      Constructors

      constructor

      Settings

      Member Visibility

      Theme

      On This Page

      constructor
      \ No newline at end of file diff --git a/docs/api/cli-kit/classes/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.DefaultOtelService.html b/docs/api/cli-kit/classes/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.DefaultOtelService.html index 55d6712ce8..4cf725ff59 100644 --- a/docs/api/cli-kit/classes/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.DefaultOtelService.html +++ b/docs/api/cli-kit/classes/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.DefaultOtelService.html @@ -1,4 +1,4 @@ -DefaultOtelService | @shopify/cli-kit

      Class DefaultOtelService

      Hierarchy (view full)

      Constructors

      constructor +DefaultOtelService | @shopify/cli-kit

      Class DefaultOtelService

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      meterProvider metrics prefixMetric @@ -14,6 +14,6 @@ removeOnRecord shutdown

      Constructors

      constructor

      Properties

      Protected Readonly meterProvider

      meterProvider: MeterProvider

      Protected Readonly metrics

      metrics: Map<string, RecordMetricFunction> = ...

      Readonly prefixMetric

      prefixMetric: boolean

      Protected Readonly recordListeners

      recordListeners: Set<OnRecordCallback> = ...

      Readonly serviceName

      serviceName: string

      Methods

      addOnRecord

      Properties

      Protected Readonly meterProvider

      meterProvider: MeterProvider

      Protected Readonly metrics

      metrics: Map<string, RecordMetricFunction> = ...

      Readonly prefixMetric

      prefixMetric: boolean

      Protected Readonly recordListeners

      recordListeners: Set<OnRecordCallback> = ...

      Readonly serviceName

      serviceName: string

      Methods

      addOnRecord

      addView

      getMeterProvider

      Protected notifyRecordListeners

      record

      register

      registerMetric

      removeOnRecord

      shutdown

      Settings

      Member Visibility

      Theme

      On This Page

      constructormeterProvidermetricsprefixMetricrecordListenersserviceNameaddOnRecordaddViewgetMeterProvidernotifyRecordListenersrecordregisterregisterMetricremoveOnRecordshutdown
      \ No newline at end of file +

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

      addView

      getMeterProvider

      Protected notifyRecordListeners

      record

      register

      registerMetric

      removeOnRecord

      shutdown

      Settings

      Member Visibility

      Theme

      On This Page

      constructormeterProvidermetricsprefixMetricrecordListenersserviceNameaddOnRecordaddViewgetMeterProvidernotifyRecordListenersrecordregisterregisterMetricremoveOnRecordshutdown
      \ No newline at end of file diff --git a/docs/api/cli-kit/enums/node_error.FatalErrorType.html b/docs/api/cli-kit/enums/node_error.FatalErrorType.html index 77ff4c8c5a..d24e51adc2 100644 --- a/docs/api/cli-kit/enums/node_error.FatalErrorType.html +++ b/docs/api/cli-kit/enums/node_error.FatalErrorType.html @@ -1,4 +1,4 @@ -FatalErrorType | @shopify/cli-kit

      Enumeration FatalErrorType

      Enumeration Members

      Abort +FatalErrorType | @shopify/cli-kit

      Enumeration FatalErrorType

      Enumeration Members

      Abort AbortSilent Bug -

      Enumeration Members

      Abort

      Abort: 0

      AbortSilent

      AbortSilent: 1

      Bug

      Bug: 2

      Settings

      Member Visibility

      Theme

      On This Page

      AbortAbortSilentBug
      \ No newline at end of file +

      Enumeration Members

      Abort

      Abort: 0

      AbortSilent

      AbortSilent: 1

      Bug

      Bug: 2

      Settings

      Member Visibility

      Theme

      On This Page

      AbortAbortSilentBug
      \ No newline at end of file diff --git a/docs/api/cli-kit/enums/node_themes_types.Operation.html b/docs/api/cli-kit/enums/node_themes_types.Operation.html index f706e7974f..a8bc890ee1 100644 --- a/docs/api/cli-kit/enums/node_themes_types.Operation.html +++ b/docs/api/cli-kit/enums/node_themes_types.Operation.html @@ -1,3 +1,3 @@ -Operation | @shopify/cli-kit

      Enumeration Operation

      Enumeration Members

      Delete +Operation | @shopify/cli-kit

      Enumeration Operation

      Enumeration Members

      Delete Upload -

      Enumeration Members

      Delete

      Delete: "DELETE"

      Upload

      Upload: "UPLOAD"

      Settings

      Member Visibility

      Theme

      On This Page

      DeleteUpload
      \ No newline at end of file +

      Enumeration Members

      Delete

      Delete: "DELETE"

      Upload

      Upload: "UPLOAD"

      Settings

      Member Visibility

      Theme

      On This Page

      DeleteUpload
      \ No newline at end of file diff --git a/docs/api/cli-kit/enums/node_vendor_otel_js_service_types.MetricInstrumentType.html b/docs/api/cli-kit/enums/node_vendor_otel_js_service_types.MetricInstrumentType.html index eb73c1e797..01682d8b8c 100644 --- a/docs/api/cli-kit/enums/node_vendor_otel_js_service_types.MetricInstrumentType.html +++ b/docs/api/cli-kit/enums/node_vendor_otel_js_service_types.MetricInstrumentType.html @@ -1,4 +1,4 @@ -MetricInstrumentType | @shopify/cli-kit

      Enumeration MetricInstrumentType

      Enumeration Members

      Counter +MetricInstrumentType | @shopify/cli-kit

      Enumeration MetricInstrumentType

      Enumeration Members

      Counter Histogram UpDownCounter -

      Enumeration Members

      Counter

      Counter: "Counter"

      Histogram

      Histogram: "Histogram"

      UpDownCounter

      UpDownCounter: "UpDownCounter"

      Settings

      Member Visibility

      Theme

      On This Page

      CounterHistogramUpDownCounter
      \ No newline at end of file +

      Enumeration Members

      Counter

      Counter: "Counter"

      Histogram

      Histogram: "Histogram"

      UpDownCounter

      UpDownCounter: "UpDownCounter"

      Settings

      Member Visibility

      Theme

      On This Page

      CounterHistogramUpDownCounter
      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_array.difference.html b/docs/api/cli-kit/functions/common_array.difference.html index a3091bf980..f1b7a4ad60 100644 --- a/docs/api/cli-kit/functions/common_array.difference.html +++ b/docs/api/cli-kit/functions/common_array.difference.html @@ -3,4 +3,4 @@

      Type Parameters

      Parameters

      Returns T[]

      Returns the new array of filtered values.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_array.getArrayContainsDuplicates.html b/docs/api/cli-kit/functions/common_array.getArrayContainsDuplicates.html index 8a119b6d6c..82ff30590b 100644 --- a/docs/api/cli-kit/functions/common_array.getArrayContainsDuplicates.html +++ b/docs/api/cli-kit/functions/common_array.getArrayContainsDuplicates.html @@ -1,4 +1,4 @@ getArrayContainsDuplicates | @shopify/cli-kit

      Function getArrayContainsDuplicates

      • getArrayContainsDuplicates<T>(array): boolean

      • Returns true if an array contains duplicates.

        Type Parameters

        • T

        Parameters

        • array: T[]

          The array to check against.

        Returns boolean

        True if the array contains duplicates.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_array.getArrayRejectingUndefined.html b/docs/api/cli-kit/functions/common_array.getArrayRejectingUndefined.html index 700d804239..b2ff9a74e8 100644 --- a/docs/api/cli-kit/functions/common_array.getArrayRejectingUndefined.html +++ b/docs/api/cli-kit/functions/common_array.getArrayRejectingUndefined.html @@ -1,4 +1,4 @@ getArrayRejectingUndefined | @shopify/cli-kit

      Function getArrayRejectingUndefined

      • getArrayRejectingUndefined<T>(array): T[]

      • Returns a copy of the array deleting the elemements that are undefined.

        Type Parameters

        • T

        Parameters

        • array: (undefined | T)[]

          The array whose undefined will be deleted.

        Returns T[]

        A copy of the array with the undefined elements deleted.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_array.takeRandomFromArray.html b/docs/api/cli-kit/functions/common_array.takeRandomFromArray.html index 457d10a19f..6bb5c8ce3a 100644 --- a/docs/api/cli-kit/functions/common_array.takeRandomFromArray.html +++ b/docs/api/cli-kit/functions/common_array.takeRandomFromArray.html @@ -1,4 +1,4 @@ takeRandomFromArray | @shopify/cli-kit

      Function takeRandomFromArray

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_array.uniq.html b/docs/api/cli-kit/functions/common_array.uniq.html index 3302a28ff2..0d6eba73aa 100644 --- a/docs/api/cli-kit/functions/common_array.uniq.html +++ b/docs/api/cli-kit/functions/common_array.uniq.html @@ -1,4 +1,4 @@ uniq | @shopify/cli-kit

      Function uniq

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_array.uniqBy.html b/docs/api/cli-kit/functions/common_array.uniqBy.html index a73930faa7..ec5b8f4822 100644 --- a/docs/api/cli-kit/functions/common_array.uniqBy.html +++ b/docs/api/cli-kit/functions/common_array.uniqBy.html @@ -4,4 +4,4 @@

      Type Parameters

      Parameters

      Returns T[]

      Returns the new duplicate free array.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_collection.groupBy.html b/docs/api/cli-kit/functions/common_collection.groupBy.html index 275cb5741d..a8948d674c 100644 --- a/docs/api/cli-kit/functions/common_collection.groupBy.html +++ b/docs/api/cli-kit/functions/common_collection.groupBy.html @@ -4,4 +4,4 @@

      Type Parameters

      Parameters

      Returns {
          [index: string]: T[];
      }

      Returns the composed aggregate object.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_collection.partition.html b/docs/api/cli-kit/functions/common_collection.partition.html index 541c1a2b7d..ebc6840fb4 100644 --- a/docs/api/cli-kit/functions/common_collection.partition.html +++ b/docs/api/cli-kit/functions/common_collection.partition.html @@ -4,4 +4,4 @@

      Type Parameters

      Parameters

      Returns [T[], T[]]

      Returns the array of grouped elements.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_function.debounce.html b/docs/api/cli-kit/functions/common_function.debounce.html index 75702a29c6..765d3f7c95 100644 --- a/docs/api/cli-kit/functions/common_function.debounce.html +++ b/docs/api/cli-kit/functions/common_function.debounce.html @@ -10,4 +10,4 @@
    • Optional wait: number

      The number of milliseconds to delay.

    • Optional options: DebounceSettings

      The options object.

      • Returns DebouncedFunc<T>

      Returns the new debounced function.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_function.memoize.html b/docs/api/cli-kit/functions/common_function.memoize.html index 93959396d3..f219f2d733 100644 --- a/docs/api/cli-kit/functions/common_function.memoize.html +++ b/docs/api/cli-kit/functions/common_function.memoize.html @@ -5,4 +5,4 @@

      Type Parameters

      Parameters

      Returns T

      Returns the new memoizing function.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_lang.isEqual.html b/docs/api/cli-kit/functions/common_lang.isEqual.html index 803a8b8585..f5cf66253b 100644 --- a/docs/api/cli-kit/functions/common_lang.isEqual.html +++ b/docs/api/cli-kit/functions/common_lang.isEqual.html @@ -8,4 +8,4 @@

      Parameters

      Returns boolean

      Returns true if the values are equivalent, else false.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_object.compact.html b/docs/api/cli-kit/functions/common_object.compact.html index a7841b8134..93d650483e 100644 --- a/docs/api/cli-kit/functions/common_object.compact.html +++ b/docs/api/cli-kit/functions/common_object.compact.html @@ -1,4 +1,4 @@ compact | @shopify/cli-kit

      Function compact

      • compact(object): object

      • Removes the undefined elements.

        Parameters

        • object: object

          The object whose undefined will be deleted.

        Returns object

        A copy of the object with the undefined elements deleted.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_object.deepCompare.html b/docs/api/cli-kit/functions/common_object.deepCompare.html index 892890bc9b..5c356f8fb2 100644 --- a/docs/api/cli-kit/functions/common_object.deepCompare.html +++ b/docs/api/cli-kit/functions/common_object.deepCompare.html @@ -2,4 +2,4 @@

      Parameters

      Returns boolean

      True if the objects are equal, false otherwise.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_object.deepDifference.html b/docs/api/cli-kit/functions/common_object.deepDifference.html index 07d55a3dd4..6e5e9d6176 100644 --- a/docs/api/cli-kit/functions/common_object.deepDifference.html +++ b/docs/api/cli-kit/functions/common_object.deepDifference.html @@ -2,4 +2,4 @@

      Parameters

      Returns [object, object]

      Two objects containing the fields that are different, each one with the values of one object.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_object.deepMergeObjects.html b/docs/api/cli-kit/functions/common_object.deepMergeObjects.html index c72307427a..fad4adb818 100644 --- a/docs/api/cli-kit/functions/common_object.deepMergeObjects.html +++ b/docs/api/cli-kit/functions/common_object.deepMergeObjects.html @@ -4,4 +4,4 @@
    • arrayMergeStrategy: ((destinationArray, sourceArray) => unknown[]) = unionArrayStrategy

      Strategy used to merge the array typed fields. Union strategy is used by default to avoid duplicated elements.

      • Returns T1 & T2

      A Javascrip tobject with th emerged objects.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_object.getPathValue.html b/docs/api/cli-kit/functions/common_object.getPathValue.html index 406e9f04c8..8a8aaff640 100644 --- a/docs/api/cli-kit/functions/common_object.getPathValue.html +++ b/docs/api/cli-kit/functions/common_object.getPathValue.html @@ -4,4 +4,4 @@

      Returns T | undefined

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_object.isEmpty.html b/docs/api/cli-kit/functions/common_object.isEmpty.html index c1cd118c5d..016d5620c7 100644 --- a/docs/api/cli-kit/functions/common_object.isEmpty.html +++ b/docs/api/cli-kit/functions/common_object.isEmpty.html @@ -3,4 +3,4 @@

      Returns boolean

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_object.mapValues.html b/docs/api/cli-kit/functions/common_object.mapValues.html index 4c14dbc141..74651f4cf2 100644 --- a/docs/api/cli-kit/functions/common_object.mapValues.html +++ b/docs/api/cli-kit/functions/common_object.mapValues.html @@ -4,4 +4,4 @@

      Type Parameters

      Parameters

      Returns {
          [P in keyof T]: TResult
      }

      Returns the new mapped object.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_object.pickBy.html b/docs/api/cli-kit/functions/common_object.pickBy.html index 60df57176e..89c1922bd8 100644 --- a/docs/api/cli-kit/functions/common_object.pickBy.html +++ b/docs/api/cli-kit/functions/common_object.pickBy.html @@ -3,4 +3,4 @@

      Type Parameters

      Parameters

      Returns Dictionary<T>

      Returns the new object.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_object.setPathValue.html b/docs/api/cli-kit/functions/common_object.setPathValue.html index c7ca92bc83..ca90092551 100644 --- a/docs/api/cli-kit/functions/common_object.setPathValue.html +++ b/docs/api/cli-kit/functions/common_object.setPathValue.html @@ -5,4 +5,4 @@

      Returns object

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_retry.performActionWithRetryAfterRecovery.html b/docs/api/cli-kit/functions/common_retry.performActionWithRetryAfterRecovery.html index ef1020b12e..c641969d15 100644 --- a/docs/api/cli-kit/functions/common_retry.performActionWithRetryAfterRecovery.html +++ b/docs/api/cli-kit/functions/common_retry.performActionWithRetryAfterRecovery.html @@ -9,4 +9,4 @@ fails the first time.

    • retries: number = 1

      The number of times to retry the action if an error happens.

      • Returns Promise<T>

      The result of the action.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.camelize.html b/docs/api/cli-kit/functions/common_string.camelize.html index 5f361306a7..cc6d5dd75a 100644 --- a/docs/api/cli-kit/functions/common_string.camelize.html +++ b/docs/api/cli-kit/functions/common_string.camelize.html @@ -1,4 +1,4 @@ camelize | @shopify/cli-kit

      Function camelize

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.capitalize.html b/docs/api/cli-kit/functions/common_string.capitalize.html index d4e0100c27..82dbdf192c 100644 --- a/docs/api/cli-kit/functions/common_string.capitalize.html +++ b/docs/api/cli-kit/functions/common_string.capitalize.html @@ -1,4 +1,4 @@ capitalize | @shopify/cli-kit

      Function capitalize

      • capitalize(str): string

      • Given a string, it returns it with the first letter capitalized.

        Parameters

        • str: string

          String to capitalize.

        Returns string

        String with the first letter capitalized.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.constantize.html b/docs/api/cli-kit/functions/common_string.constantize.html index 120aeec85e..0a5ef6df6e 100644 --- a/docs/api/cli-kit/functions/common_string.constantize.html +++ b/docs/api/cli-kit/functions/common_string.constantize.html @@ -1,4 +1,4 @@ constantize | @shopify/cli-kit

      Function constantize

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.escapeRegExp.html b/docs/api/cli-kit/functions/common_string.escapeRegExp.html index c86580d358..11e074dd33 100644 --- a/docs/api/cli-kit/functions/common_string.escapeRegExp.html +++ b/docs/api/cli-kit/functions/common_string.escapeRegExp.html @@ -2,4 +2,4 @@ More info: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping.

      Parameters

      Returns string

      The escaped string.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.formatDate.html b/docs/api/cli-kit/functions/common_string.formatDate.html index 070849beaf..dd832d8fb8 100644 --- a/docs/api/cli-kit/functions/common_string.formatDate.html +++ b/docs/api/cli-kit/functions/common_string.formatDate.html @@ -1,4 +1,4 @@ formatDate | @shopify/cli-kit

      Function formatDate

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.formatLocalDate.html b/docs/api/cli-kit/functions/common_string.formatLocalDate.html index bea92cc4fd..2666442d8e 100644 --- a/docs/api/cli-kit/functions/common_string.formatLocalDate.html +++ b/docs/api/cli-kit/functions/common_string.formatLocalDate.html @@ -1,4 +1,4 @@ formatLocalDate | @shopify/cli-kit

      Function formatLocalDate

      • formatLocalDate(dateString): string

      • Given a date in UTC ISO String format, return a formatted string in local time like "2021-01-01 12:00:00".

        Parameters

        • dateString: string

          UTC ISO Date String.

        Returns string

        The transformed string in local system time.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.getRandomName.html b/docs/api/cli-kit/functions/common_string.getRandomName.html index cc04225136..35f7514f58 100644 --- a/docs/api/cli-kit/functions/common_string.getRandomName.html +++ b/docs/api/cli-kit/functions/common_string.getRandomName.html @@ -1,4 +1,4 @@ getRandomName | @shopify/cli-kit

      Function getRandomName

      • getRandomName(family?): string

      • Generates a random name by combining an adjective and noun.

        Parameters

        • family: RandomNameFamily = 'business'

          Theme to use for the random name (business or creative).

        Returns string

        A random name generated by combining an adjective and noun.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.hyphenate.html b/docs/api/cli-kit/functions/common_string.hyphenate.html index f0d002607a..4e08a9db4b 100644 --- a/docs/api/cli-kit/functions/common_string.hyphenate.html +++ b/docs/api/cli-kit/functions/common_string.hyphenate.html @@ -1,4 +1,4 @@ hyphenate | @shopify/cli-kit

      Function hyphenate

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.joinWithAnd.html b/docs/api/cli-kit/functions/common_string.joinWithAnd.html index 14a408dc87..c87490848d 100644 --- a/docs/api/cli-kit/functions/common_string.joinWithAnd.html +++ b/docs/api/cli-kit/functions/common_string.joinWithAnd.html @@ -3,4 +3,4 @@ For example: ["a", "b", "c"] returns "a", "b" and "c".

      Parameters

      Returns string

      The joined string.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.linesToColumns.html b/docs/api/cli-kit/functions/common_string.linesToColumns.html index 49c80b0b1d..bb8cfd65c3 100644 --- a/docs/api/cli-kit/functions/common_string.linesToColumns.html +++ b/docs/api/cli-kit/functions/common_string.linesToColumns.html @@ -1,4 +1,4 @@ linesToColumns | @shopify/cli-kit

      Function linesToColumns

      • linesToColumns(lines): string

      • Transforms a matrix of strings into a single string with the columns aligned.

        Parameters

        • lines: string[][]

          Array of rows, where each row is an array of strings (representing columns).

        Returns string

        A string with the columns aligned.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.normalizeDelimitedString.html b/docs/api/cli-kit/functions/common_string.normalizeDelimitedString.html index 907cfabcb1..1d1c2b5eea 100644 --- a/docs/api/cli-kit/functions/common_string.normalizeDelimitedString.html +++ b/docs/api/cli-kit/functions/common_string.normalizeDelimitedString.html @@ -3,4 +3,4 @@

      Parameters

      Returns string | undefined

      String with the normalized list of tokens.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.pascalize.html b/docs/api/cli-kit/functions/common_string.pascalize.html index 7f45b3cb2c..eeca460c8c 100644 --- a/docs/api/cli-kit/functions/common_string.pascalize.html +++ b/docs/api/cli-kit/functions/common_string.pascalize.html @@ -2,4 +2,4 @@ Eg: "pascal_case" returns "PascalCase".

      Parameters

      Returns string

      String with all the first letter capitalized with no spaces.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.pluralize.html b/docs/api/cli-kit/functions/common_string.pluralize.html index c4dd7973f5..97f9847d6d 100644 --- a/docs/api/cli-kit/functions/common_string.pluralize.html +++ b/docs/api/cli-kit/functions/common_string.pluralize.html @@ -4,4 +4,4 @@
    • singular: ((item) => TokenItem<TSingularToken>)

      Supplier used when the list of items has a single item.

    • Optional none: (() => TokenItem<TNoneToken>)

      Supplier used when the list has no items.

      • Returns TokenItem<TPluralToken | TSingularToken | TNoneToken> | string

      The TokenItem supplied by the plural, singular, or none functions.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.slugify.html b/docs/api/cli-kit/functions/common_string.slugify.html index 9ec730d3a9..c7ae93bd7b 100644 --- a/docs/api/cli-kit/functions/common_string.slugify.html +++ b/docs/api/cli-kit/functions/common_string.slugify.html @@ -1,4 +1,4 @@ slugify | @shopify/cli-kit

      Function slugify

      • slugify(str): string

      • Given a string, it transforms it to a slug (lowercase, hyphenated, no special chars, trimmed...).

        Parameters

        • str: string

          String to slugify.

        Returns string

        The slugified string.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.tryParseInt.html b/docs/api/cli-kit/functions/common_string.tryParseInt.html index 9042e63f1a..342dbc7310 100644 --- a/docs/api/cli-kit/functions/common_string.tryParseInt.html +++ b/docs/api/cli-kit/functions/common_string.tryParseInt.html @@ -1,4 +1,4 @@ tryParseInt | @shopify/cli-kit

      Function tryParseInt

      • tryParseInt(maybeInt): number | undefined

      • Try to convert a string to an int, falling back to undefined if unable to.

        Parameters

        • maybeInt: undefined | string

          String to convert to an int.

        Returns number | undefined

        The int if it was able to convert, otherwise undefined.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_string.underscore.html b/docs/api/cli-kit/functions/common_string.underscore.html index 68a07c6e04..3c1f6df31c 100644 --- a/docs/api/cli-kit/functions/common_string.underscore.html +++ b/docs/api/cli-kit/functions/common_string.underscore.html @@ -1,4 +1,4 @@ underscore | @shopify/cli-kit

      Function underscore

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_ts_json_narrowing.assertStringMap.html b/docs/api/cli-kit/functions/common_ts_json_narrowing.assertStringMap.html index c167793bd2..2a647e5271 100644 --- a/docs/api/cli-kit/functions/common_ts_json_narrowing.assertStringMap.html +++ b/docs/api/cli-kit/functions/common_ts_json_narrowing.assertStringMap.html @@ -1,4 +1,4 @@ assertStringMap | @shopify/cli-kit

      Function assertStringMap

      • assertStringMap(unknownBlob): asserts unknownBlob is {
            [key: string]: string;
        }

      • Asserts that the unknownBlob is a string map. Used to validate JSON objects received over the wire.

        Parameters

        • unknownBlob: unknown

          The unknown object to validate.

        Returns asserts unknownBlob is {
            [key: string]: string;
        }

        Throws

        BugError - Thrown if the unknownBlob is not a string map.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/common_url.isValidURL.html b/docs/api/cli-kit/functions/common_url.isValidURL.html index d86335667b..692456b620 100644 --- a/docs/api/cli-kit/functions/common_url.isValidURL.html +++ b/docs/api/cli-kit/functions/common_url.isValidURL.html @@ -2,4 +2,4 @@

      Parameters

      Returns boolean

      True if the URL is valid, false otherwise.

      Throws

      An error if URL's constructor throws an error other than TypeError.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_analytics.reportAnalyticsEvent.html b/docs/api/cli-kit/functions/node_analytics.reportAnalyticsEvent.html index 1eab3c81e0..b372d27bab 100644 --- a/docs/api/cli-kit/functions/node_analytics.reportAnalyticsEvent.html +++ b/docs/api/cli-kit/functions/node_analytics.reportAnalyticsEvent.html @@ -1,3 +1,3 @@ reportAnalyticsEvent | @shopify/cli-kit

      Function reportAnalyticsEvent

      • reportAnalyticsEvent(options): Promise<void>

      • Report an analytics event, sending it off to Monorail -- Shopify's internal analytics service.

        The payload for an event includes both generic data, and data gathered from installed plug-ins.

        -

        Parameters

        • options: ReportAnalyticsEventOptions

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_admin.adminRequest.html b/docs/api/cli-kit/functions/node_api_admin.adminRequest.html index c784b65bb3..a2dde05ecc 100644 --- a/docs/api/cli-kit/functions/node_api_admin.adminRequest.html +++ b/docs/api/cli-kit/functions/node_api_admin.adminRequest.html @@ -3,4 +3,4 @@
    • session: AdminSession

      Shopify admin session including token and Store FQDN.

    • Optional variables: GraphQLVariables

      GraphQL variables to pass to the query.

      • Returns Promise<T>

      The response of the query of generic type .

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_admin.adminUrl.html b/docs/api/cli-kit/functions/node_api_admin.adminUrl.html index c83352c62b..455c636ea4 100644 --- a/docs/api/cli-kit/functions/node_api_admin.adminUrl.html +++ b/docs/api/cli-kit/functions/node_api_admin.adminUrl.html @@ -4,4 +4,4 @@

      Returns string

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_admin.restRequest.html b/docs/api/cli-kit/functions/node_api_admin.restRequest.html index 628120df2d..e4552f8d70 100644 --- a/docs/api/cli-kit/functions/node_api_admin.restRequest.html +++ b/docs/api/cli-kit/functions/node_api_admin.restRequest.html @@ -8,4 +8,4 @@

      Returns Promise<RestResponse>

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_admin.supportedApiVersions.html b/docs/api/cli-kit/functions/node_api_admin.supportedApiVersions.html index baca7fd9a6..10644a478c 100644 --- a/docs/api/cli-kit/functions/node_api_admin.supportedApiVersions.html +++ b/docs/api/cli-kit/functions/node_api_admin.supportedApiVersions.html @@ -3,4 +3,4 @@

      Returns Promise<string[]>

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_app_dev.appDevRequest.html b/docs/api/cli-kit/functions/node_api_app_dev.appDevRequest.html index c2da91df4e..18b2963ca8 100644 --- a/docs/api/cli-kit/functions/node_api_app_dev.appDevRequest.html +++ b/docs/api/cli-kit/functions/node_api_app_dev.appDevRequest.html @@ -5,4 +5,4 @@
    • token: string

      Partners token.

    • Optional variables: TVariables

      GraphQL variables to pass to the query.

      • Returns Promise<TResult>

      The response of the query of generic type .

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_app_management.appManagementRequest.html b/docs/api/cli-kit/functions/node_api_app_management.appManagementRequest.html index 0942a683c9..cedc39d7b8 100644 --- a/docs/api/cli-kit/functions/node_api_app_management.appManagementRequest.html +++ b/docs/api/cli-kit/functions/node_api_app_management.appManagementRequest.html @@ -4,4 +4,4 @@
    • token: string

      Partners token.

    • Optional variables: GraphQLVariables

      GraphQL variables to pass to the query.

      • Returns Promise<T>

      The response of the query of generic type .

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_app_management.handleDeprecations.html b/docs/api/cli-kit/functions/node_api_app_management.handleDeprecations.html index 37249664c8..16e8feb45e 100644 --- a/docs/api/cli-kit/functions/node_api_app_management.handleDeprecations.html +++ b/docs/api/cli-kit/functions/node_api_app_management.handleDeprecations.html @@ -1,4 +1,4 @@ handleDeprecations | @shopify/cli-kit

      Function handleDeprecations

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformOrganizationsRequest.html b/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformOrganizationsRequest.html index 16ac205795..9869c3d4bf 100644 --- a/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformOrganizationsRequest.html +++ b/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformOrganizationsRequest.html @@ -4,4 +4,4 @@
    • organizationId: string

      Organization ID as a numeric (non-GID) value.

    • Optional variables: GraphQLVariables

      GraphQL variables to pass to the query.

      • Returns Promise<T>

      The response of the query of generic type .

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformOrganizationsRequestDoc.html b/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformOrganizationsRequestDoc.html index 66b95704f5..317f5b0977 100644 --- a/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformOrganizationsRequestDoc.html +++ b/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformOrganizationsRequestDoc.html @@ -4,4 +4,4 @@
    • organizationId: string

      Organization ID as a numeric value.

    • Optional variables: GraphQLVariables

      GraphQL variables to pass to the query.

      • Returns Promise<TResult>

      The response of the query of generic type .

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformRequest.html b/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformRequest.html index c9335b7881..e3860c4750 100644 --- a/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformRequest.html +++ b/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformRequest.html @@ -3,4 +3,4 @@
    • token: string

      Business Platform token.

    • Optional variables: GraphQLVariables

      GraphQL variables to pass to the query.

      • Returns Promise<T>

      The response of the query of generic type .

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformRequestDoc.html b/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformRequestDoc.html index ae5e48b88e..56da03d38b 100644 --- a/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformRequestDoc.html +++ b/docs/api/cli-kit/functions/node_api_business_platform.businessPlatformRequestDoc.html @@ -3,4 +3,4 @@
    • token: string

      Business Platform token.

    • Optional variables: TVariables

      GraphQL variables to pass to the query.

      • Returns Promise<TResult>

      The response of the query of generic type .

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_graphql.graphqlRequest.html b/docs/api/cli-kit/functions/node_api_graphql.graphqlRequest.html index d98371588b..0e086e53c7 100644 --- a/docs/api/cli-kit/functions/node_api_graphql.graphqlRequest.html +++ b/docs/api/cli-kit/functions/node_api_graphql.graphqlRequest.html @@ -1,4 +1,4 @@ graphqlRequest | @shopify/cli-kit

      Function graphqlRequest

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_graphql.graphqlRequestDoc.html b/docs/api/cli-kit/functions/node_api_graphql.graphqlRequestDoc.html index 4120c8a6f5..ba3c985c2b 100644 --- a/docs/api/cli-kit/functions/node_api_graphql.graphqlRequestDoc.html +++ b/docs/api/cli-kit/functions/node_api_graphql.graphqlRequestDoc.html @@ -1,4 +1,4 @@ graphqlRequestDoc | @shopify/cli-kit

      Function graphqlRequestDoc

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_partners.handleDeprecations.html b/docs/api/cli-kit/functions/node_api_partners.handleDeprecations.html index 7e306edd83..a824ef4a6d 100644 --- a/docs/api/cli-kit/functions/node_api_partners.handleDeprecations.html +++ b/docs/api/cli-kit/functions/node_api_partners.handleDeprecations.html @@ -1,4 +1,4 @@ handleDeprecations | @shopify/cli-kit

      Function handleDeprecations

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_partners.partnersRequest.html b/docs/api/cli-kit/functions/node_api_partners.partnersRequest.html index 51e06e8951..aeb1963a0c 100644 --- a/docs/api/cli-kit/functions/node_api_partners.partnersRequest.html +++ b/docs/api/cli-kit/functions/node_api_partners.partnersRequest.html @@ -3,4 +3,4 @@
    • token: string

      Partners token.

    • Optional variables: GraphQLVariables

      GraphQL variables to pass to the query.

      • Returns Promise<T>

      The response of the query of generic type .

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_partners.partnersRequestDoc.html b/docs/api/cli-kit/functions/node_api_partners.partnersRequestDoc.html index 1b91130f60..bad5051e4f 100644 --- a/docs/api/cli-kit/functions/node_api_partners.partnersRequestDoc.html +++ b/docs/api/cli-kit/functions/node_api_partners.partnersRequestDoc.html @@ -3,4 +3,4 @@
    • token: string

      Partners token.

    • Optional variables: TVariables

      GraphQL variables to pass to the query.

      • Returns Promise<TResult>

      The response of the query of generic type .

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_rest_api_throttler.delayAwareRetry.html b/docs/api/cli-kit/functions/node_api_rest_api_throttler.delayAwareRetry.html index b67eb98cb4..14024fde58 100644 --- a/docs/api/cli-kit/functions/node_api_rest_api_throttler.delayAwareRetry.html +++ b/docs/api/cli-kit/functions/node_api_rest_api_throttler.delayAwareRetry.html @@ -4,4 +4,4 @@

      Returns Promise<RestResponse>

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_rest_api_throttler.throttle.html b/docs/api/cli-kit/functions/node_api_rest_api_throttler.throttle.html index f52ee018b8..246fb835eb 100644 --- a/docs/api/cli-kit/functions/node_api_rest_api_throttler.throttle.html +++ b/docs/api/cli-kit/functions/node_api_rest_api_throttler.throttle.html @@ -4,4 +4,4 @@

      Returns Promise<T>

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_rest_api_throttler.updateApiCallLimitFromResponse.html b/docs/api/cli-kit/functions/node_api_rest_api_throttler.updateApiCallLimitFromResponse.html index 5ef96338f8..dfae2e33c0 100644 --- a/docs/api/cli-kit/functions/node_api_rest_api_throttler.updateApiCallLimitFromResponse.html +++ b/docs/api/cli-kit/functions/node_api_rest_api_throttler.updateApiCallLimitFromResponse.html @@ -1,3 +1,3 @@ updateApiCallLimitFromResponse | @shopify/cli-kit

      Function updateApiCallLimitFromResponse

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_archiver.zip.html b/docs/api/cli-kit/functions/node_archiver.zip.html index 0f036b65c7..d5cfb251d5 100644 --- a/docs/api/cli-kit/functions/node_archiver.zip.html +++ b/docs/api/cli-kit/functions/node_archiver.zip.html @@ -2,4 +2,4 @@ Even with forward-slash paths, zip files should still be able to be opened on Windows.

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_base_command.addFromParsedFlags.html b/docs/api/cli-kit/functions/node_base_command.addFromParsedFlags.html index 7d305aea9c..3f79f3e911 100644 --- a/docs/api/cli-kit/functions/node_base_command.addFromParsedFlags.html +++ b/docs/api/cli-kit/functions/node_base_command.addFromParsedFlags.html @@ -1 +1 @@ -addFromParsedFlags | @shopify/cli-kit

      Function addFromParsedFlags

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +addFromParsedFlags | @shopify/cli-kit

      Function addFromParsedFlags

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_cli.localCliPackage.html b/docs/api/cli-kit/functions/node_cli.localCliPackage.html index c8da7c37bd..a829a50bdb 100644 --- a/docs/api/cli-kit/functions/node_cli.localCliPackage.html +++ b/docs/api/cli-kit/functions/node_cli.localCliPackage.html @@ -1 +1 @@ -localCliPackage | @shopify/cli-kit

      Function localCliPackage

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +localCliPackage | @shopify/cli-kit

      Function localCliPackage

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_cli.runCLI.html b/docs/api/cli-kit/functions/node_cli.runCLI.html index c76dabe17b..7874cf3cc3 100644 --- a/docs/api/cli-kit/functions/node_cli.runCLI.html +++ b/docs/api/cli-kit/functions/node_cli.runCLI.html @@ -1,4 +1,4 @@ runCLI | @shopify/cli-kit

      Function runCLI

      • runCLI(options): Promise<void>

      • A function that abstracts away setting up the environment and running a CLI

        Parameters

        • options: RunCLIOptions

          Options.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_cli.runCreateCLI.html b/docs/api/cli-kit/functions/node_cli.runCreateCLI.html index 85b6b707d8..845622f43c 100644 --- a/docs/api/cli-kit/functions/node_cli.runCreateCLI.html +++ b/docs/api/cli-kit/functions/node_cli.runCreateCLI.html @@ -1,2 +1,2 @@ runCreateCLI | @shopify/cli-kit

      Function runCreateCLI

      • runCreateCLI(options): Promise<void>

      • A function for create-x CLIs that automatically runs the "init" command.

        -

        Parameters

        • options: RunCLIOptions

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_cli.useLocalCLIIfDetected.html b/docs/api/cli-kit/functions/node_cli.useLocalCLIIfDetected.html index 1f4141128d..c27385a024 100644 --- a/docs/api/cli-kit/functions/node_cli.useLocalCLIIfDetected.html +++ b/docs/api/cli-kit/functions/node_cli.useLocalCLIIfDetected.html @@ -1 +1 @@ -useLocalCLIIfDetected | @shopify/cli-kit

      Function useLocalCLIIfDetected

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +useLocalCLIIfDetected | @shopify/cli-kit

      Function useLocalCLIIfDetected

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_fqdn.appManagementFqdn.html b/docs/api/cli-kit/functions/node_context_fqdn.appManagementFqdn.html index 9d5c615136..92a0e6ea5c 100644 --- a/docs/api/cli-kit/functions/node_context_fqdn.appManagementFqdn.html +++ b/docs/api/cli-kit/functions/node_context_fqdn.appManagementFqdn.html @@ -1,3 +1,3 @@ appManagementFqdn | @shopify/cli-kit

      Function appManagementFqdn

      • appManagementFqdn(): Promise<string>

      • It returns the App Management API service we should interact with.

        Returns Promise<string>

        Fully-qualified domain of the App Management service we should interact with.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_fqdn.businessPlatformFqdn.html b/docs/api/cli-kit/functions/node_context_fqdn.businessPlatformFqdn.html index 91fb13de7a..0f5356c31d 100644 --- a/docs/api/cli-kit/functions/node_context_fqdn.businessPlatformFqdn.html +++ b/docs/api/cli-kit/functions/node_context_fqdn.businessPlatformFqdn.html @@ -1,3 +1,3 @@ businessPlatformFqdn | @shopify/cli-kit

      Function businessPlatformFqdn

      • businessPlatformFqdn(): Promise<string>

      • It returns the BusinessPlatform' API service we should interact with.

        Returns Promise<string>

        Fully-qualified domain of the partners service we should interact with.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_fqdn.developerDashboardFqdn.html b/docs/api/cli-kit/functions/node_context_fqdn.developerDashboardFqdn.html index 4620df9321..26b77642f1 100644 --- a/docs/api/cli-kit/functions/node_context_fqdn.developerDashboardFqdn.html +++ b/docs/api/cli-kit/functions/node_context_fqdn.developerDashboardFqdn.html @@ -1,3 +1,3 @@ developerDashboardFqdn | @shopify/cli-kit

      Function developerDashboardFqdn

      • developerDashboardFqdn(): Promise<string>

      • It returns the Developer Dashboard domain we should interact with.

        Returns Promise<string>

        Fully-qualified domain of the Developer Dashboard we should interact with.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_fqdn.identityFqdn.html b/docs/api/cli-kit/functions/node_context_fqdn.identityFqdn.html index 99977e4cc3..6f2ba515e2 100644 --- a/docs/api/cli-kit/functions/node_context_fqdn.identityFqdn.html +++ b/docs/api/cli-kit/functions/node_context_fqdn.identityFqdn.html @@ -1,3 +1,3 @@ identityFqdn | @shopify/cli-kit

      Function identityFqdn

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_fqdn.normalizeStoreFqdn.html b/docs/api/cli-kit/functions/node_context_fqdn.normalizeStoreFqdn.html index 6566e84d34..311babd421 100644 --- a/docs/api/cli-kit/functions/node_context_fqdn.normalizeStoreFqdn.html +++ b/docs/api/cli-kit/functions/node_context_fqdn.normalizeStoreFqdn.html @@ -3,4 +3,4 @@ It will add the spin domain if it's not present and we're in a Spin environment.

      Parameters

      Returns Promise<string>

      Normalized store name.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_fqdn.partnersFqdn.html b/docs/api/cli-kit/functions/node_context_fqdn.partnersFqdn.html index 17c25cda31..197265551c 100644 --- a/docs/api/cli-kit/functions/node_context_fqdn.partnersFqdn.html +++ b/docs/api/cli-kit/functions/node_context_fqdn.partnersFqdn.html @@ -1,3 +1,3 @@ partnersFqdn | @shopify/cli-kit

      Function partnersFqdn

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.alwaysLogAnalytics.html b/docs/api/cli-kit/functions/node_context_local.alwaysLogAnalytics.html index 2af422cd98..2e5b594aaf 100644 --- a/docs/api/cli-kit/functions/node_context_local.alwaysLogAnalytics.html +++ b/docs/api/cli-kit/functions/node_context_local.alwaysLogAnalytics.html @@ -1,4 +1,4 @@ alwaysLogAnalytics | @shopify/cli-kit

      Function alwaysLogAnalytics

      • alwaysLogAnalytics(env?): boolean

      • Returns true if reporting analytics should always happen, regardless of DEBUG mode etc.

        Parameters

        • env: ProcessEnv = process.env

          The environment variables from the environment of the current process.

        Returns boolean

        True if SHOPIFY_CLI_ALWAYS_LOG_ANALYTICS is truthy.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.alwaysLogMetrics.html b/docs/api/cli-kit/functions/node_context_local.alwaysLogMetrics.html index 0befa15d6c..e724e90562 100644 --- a/docs/api/cli-kit/functions/node_context_local.alwaysLogMetrics.html +++ b/docs/api/cli-kit/functions/node_context_local.alwaysLogMetrics.html @@ -1,4 +1,4 @@ alwaysLogMetrics | @shopify/cli-kit

      Function alwaysLogMetrics

      • alwaysLogMetrics(env?): boolean

      • Returns true if reporting metrics should always happen, regardless of DEBUG mode etc.

        Parameters

        • env: ProcessEnv = process.env

          The environment variables from the environment of the current process.

        Returns boolean

        True if SHOPIFY_CLI_ALWAYS_LOG_METRICS is truthy.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.analyticsDisabled.html b/docs/api/cli-kit/functions/node_context_local.analyticsDisabled.html index 82af9d1091..9aca9419dd 100644 --- a/docs/api/cli-kit/functions/node_context_local.analyticsDisabled.html +++ b/docs/api/cli-kit/functions/node_context_local.analyticsDisabled.html @@ -1,4 +1,4 @@ analyticsDisabled | @shopify/cli-kit

      Function analyticsDisabled

      • analyticsDisabled(env?): boolean

      • Returns true if reporting analytics is enabled.

        Parameters

        • env: ProcessEnv = process.env

          The environment variables from the environment of the current process.

        Returns boolean

        True unless SHOPIFY_CLI_NO_ANALYTICS is truthy or debug mode is enabled.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.ciPlatform.html b/docs/api/cli-kit/functions/node_context_local.ciPlatform.html index bbe15a933d..3ca5ad2104 100644 --- a/docs/api/cli-kit/functions/node_context_local.ciPlatform.html +++ b/docs/api/cli-kit/functions/node_context_local.ciPlatform.html @@ -1,4 +1,4 @@ ciPlatform | @shopify/cli-kit

      Function ciPlatform

      • ciPlatform(env?): {
            isCI: true;
            metadata: Metadata;
            name: string;
        } | {
            isCI: false;
            metadata?: undefined;
            name?: undefined;
        }

      • Gets info on the CI platform the CLI is running on, if applicable.

        Parameters

        • env: ProcessEnv = process.env

          The environment variables from the environment of the current process.

        Returns {
            isCI: true;
            metadata: Metadata;
            name: string;
        } | {
            isCI: false;
            metadata?: undefined;
            name?: undefined;
        }

        The CI platform info.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.cloudEnvironment.html b/docs/api/cli-kit/functions/node_context_local.cloudEnvironment.html index e0406fd71e..4b56f2b60a 100644 --- a/docs/api/cli-kit/functions/node_context_local.cloudEnvironment.html +++ b/docs/api/cli-kit/functions/node_context_local.cloudEnvironment.html @@ -2,4 +2,4 @@ them. Platform name 'localhost' is returned otherwise.

      Parameters

      Returns {
          editor: boolean;
          platform: "spin" | "codespaces" | "gitpod" | "cloudShell" | "localhost";
      }

      Cloud platform information.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.codespacePortForwardingDomain.html b/docs/api/cli-kit/functions/node_context_local.codespacePortForwardingDomain.html index e6d001a6d5..855beef7e7 100644 --- a/docs/api/cli-kit/functions/node_context_local.codespacePortForwardingDomain.html +++ b/docs/api/cli-kit/functions/node_context_local.codespacePortForwardingDomain.html @@ -2,4 +2,4 @@ Https://docs.github.com/en/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables.

      Parameters

      Returns string | undefined

      The codespace port forwarding domain.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.codespaceURL.html b/docs/api/cli-kit/functions/node_context_local.codespaceURL.html index 4d499847b2..30418cc2af 100644 --- a/docs/api/cli-kit/functions/node_context_local.codespaceURL.html +++ b/docs/api/cli-kit/functions/node_context_local.codespaceURL.html @@ -2,4 +2,4 @@ Https://docs.github.com/en/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables.

      Parameters

      Returns string | undefined

      The codespace URL.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.firstPartyDev.html b/docs/api/cli-kit/functions/node_context_local.firstPartyDev.html index 1135ee719a..16d6f5f238 100644 --- a/docs/api/cli-kit/functions/node_context_local.firstPartyDev.html +++ b/docs/api/cli-kit/functions/node_context_local.firstPartyDev.html @@ -1,4 +1,4 @@ firstPartyDev | @shopify/cli-kit

      Function firstPartyDev

      • firstPartyDev(env?): boolean

      • Returns true if the CLI User is 1P.

        Parameters

        • env: ProcessEnv = process.env

          The environment variables from the environment of the current process.

        Returns boolean

        True if SHOPIFY_CLI_1P is truthy.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.gitpodURL.html b/docs/api/cli-kit/functions/node_context_local.gitpodURL.html index addd043a48..1516b93149 100644 --- a/docs/api/cli-kit/functions/node_context_local.gitpodURL.html +++ b/docs/api/cli-kit/functions/node_context_local.gitpodURL.html @@ -2,4 +2,4 @@ Https://www.gitpod.io/docs/environment-variables#default-environment-variables.

      Parameters

      Returns string | undefined

      The gitpod URL.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.hasGit.html b/docs/api/cli-kit/functions/node_context_local.hasGit.html index 3c502604bf..532cc5a1b7 100644 --- a/docs/api/cli-kit/functions/node_context_local.hasGit.html +++ b/docs/api/cli-kit/functions/node_context_local.hasGit.html @@ -1,3 +1,3 @@ hasGit | @shopify/cli-kit

      Function hasGit

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.homeDirectory.html b/docs/api/cli-kit/functions/node_context_local.homeDirectory.html index 0b00300b6e..8211b03842 100644 --- a/docs/api/cli-kit/functions/node_context_local.homeDirectory.html +++ b/docs/api/cli-kit/functions/node_context_local.homeDirectory.html @@ -1,3 +1,3 @@ homeDirectory | @shopify/cli-kit

      Function homeDirectory

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.isCloudEnvironment.html b/docs/api/cli-kit/functions/node_context_local.isCloudEnvironment.html index f52b01984f..f2c6bc6864 100644 --- a/docs/api/cli-kit/functions/node_context_local.isCloudEnvironment.html +++ b/docs/api/cli-kit/functions/node_context_local.isCloudEnvironment.html @@ -1,4 +1,4 @@ isCloudEnvironment | @shopify/cli-kit

      Function isCloudEnvironment

      • isCloudEnvironment(env?): boolean

      • Checks if the CLI is run from a cloud environment.

        Parameters

        • env: ProcessEnv = process.env

          Environment variables used when the cli is launched.

        Returns boolean

        True in case the CLI is run from a cloud environment.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.isDevelopment.html b/docs/api/cli-kit/functions/node_context_local.isDevelopment.html index 09400c7f99..59fc88ef91 100644 --- a/docs/api/cli-kit/functions/node_context_local.isDevelopment.html +++ b/docs/api/cli-kit/functions/node_context_local.isDevelopment.html @@ -1,4 +1,4 @@ isDevelopment | @shopify/cli-kit

      Function isDevelopment

      • isDevelopment(env?): boolean

      • Returns true if the CLI is running in debug mode.

        Parameters

        • env: ProcessEnv = process.env

          The environment variables from the environment of the current process.

        Returns boolean

        True if SHOPIFY_ENV is development.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.isShopify.html b/docs/api/cli-kit/functions/node_context_local.isShopify.html index d03c5d75a1..5bf9267c8a 100644 --- a/docs/api/cli-kit/functions/node_context_local.isShopify.html +++ b/docs/api/cli-kit/functions/node_context_local.isShopify.html @@ -2,4 +2,4 @@ a local environment (where dev is present) or a cloud environment (spin).

      Parameters

      Returns Promise<boolean>

      True if the CLI is used in a Shopify environment.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.isTerminalInteractive.html b/docs/api/cli-kit/functions/node_context_local.isTerminalInteractive.html index 61ad5fc383..27d19fffb4 100644 --- a/docs/api/cli-kit/functions/node_context_local.isTerminalInteractive.html +++ b/docs/api/cli-kit/functions/node_context_local.isTerminalInteractive.html @@ -1,3 +1,3 @@ isTerminalInteractive | @shopify/cli-kit

      Function isTerminalInteractive

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.isUnitTest.html b/docs/api/cli-kit/functions/node_context_local.isUnitTest.html index d4c9f7c93d..0a047f3835 100644 --- a/docs/api/cli-kit/functions/node_context_local.isUnitTest.html +++ b/docs/api/cli-kit/functions/node_context_local.isUnitTest.html @@ -3,4 +3,4 @@ the standard streams.

      Parameters

      Returns boolean

      True if the SHOPIFY_UNIT_TEST environment variable is truthy.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.isVerbose.html b/docs/api/cli-kit/functions/node_context_local.isVerbose.html index 160ece5575..5672e0b700 100644 --- a/docs/api/cli-kit/functions/node_context_local.isVerbose.html +++ b/docs/api/cli-kit/functions/node_context_local.isVerbose.html @@ -1,4 +1,4 @@ isVerbose | @shopify/cli-kit

      Function isVerbose

      • isVerbose(env?): boolean

      • Returns true if the CLI is running in verbose mode.

        Parameters

        • env: ProcessEnv = process.env

          The environment variables from the environment of the current process.

        Returns boolean

        True if SHOPIFY_FLAG_VERBOSE is truthy or the flag --verbose has been passed.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.macAddress.html b/docs/api/cli-kit/functions/node_context_local.macAddress.html index 96ff703186..8d80aef7a7 100644 --- a/docs/api/cli-kit/functions/node_context_local.macAddress.html +++ b/docs/api/cli-kit/functions/node_context_local.macAddress.html @@ -1,3 +1,3 @@ macAddress | @shopify/cli-kit

      Function macAddress

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.opentelemetryDomain.html b/docs/api/cli-kit/functions/node_context_local.opentelemetryDomain.html index 217d117de7..644a6f7051 100644 --- a/docs/api/cli-kit/functions/node_context_local.opentelemetryDomain.html +++ b/docs/api/cli-kit/functions/node_context_local.opentelemetryDomain.html @@ -2,4 +2,4 @@

      It can be overridden via the SHOPIFY_CLI_OTEL_EXPORTER_OTLP_ENDPOINT environment variable.

      Parameters

      Returns string | undefined

      The domain to send OTEL metrics to.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.useDeviceAuth.html b/docs/api/cli-kit/functions/node_context_local.useDeviceAuth.html index d12aa89130..1f8a245124 100644 --- a/docs/api/cli-kit/functions/node_context_local.useDeviceAuth.html +++ b/docs/api/cli-kit/functions/node_context_local.useDeviceAuth.html @@ -2,4 +2,4 @@

      Device auth can be opted out by using SHOPIFY_CLI_ACCESS_CODE_AUTH.

      Parameters

      Returns boolean

      True if SHOPIFY_CLI_DEVICE_AUTH is truthy or the CLI is run from a cloud environment.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.useEmbeddedThemeCLI.html b/docs/api/cli-kit/functions/node_context_local.useEmbeddedThemeCLI.html index 25caa10a6b..f06b3d39f5 100644 --- a/docs/api/cli-kit/functions/node_context_local.useEmbeddedThemeCLI.html +++ b/docs/api/cli-kit/functions/node_context_local.useEmbeddedThemeCLI.html @@ -1,4 +1,4 @@ useEmbeddedThemeCLI | @shopify/cli-kit

      Function useEmbeddedThemeCLI

      • useEmbeddedThemeCLI(env?): boolean

      • Returns true if the embedded CLI will be used for theme commands.

        Parameters

        • env: ProcessEnv = process.env

          The environment variables from the environment of the current process.

        Returns boolean

        False if SHOPIFY_CLI_BUNDLED_THEME_CLI is truthy.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_local.useThemebundling.html b/docs/api/cli-kit/functions/node_context_local.useThemebundling.html index f7f8676377..215285284e 100644 --- a/docs/api/cli-kit/functions/node_context_local.useThemebundling.html +++ b/docs/api/cli-kit/functions/node_context_local.useThemebundling.html @@ -1,4 +1,4 @@ useThemebundling | @shopify/cli-kit

      Function useThemebundling

      • useThemebundling(env?): boolean

      • Returns true if the CLI should use theme bundling.

        Parameters

        • env: ProcessEnv = process.env

          The environment variables from the environment of the current process.

        Returns boolean

        False if SHOPIFY_CLI_NO_THEME_BUNDLING is truthy.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_spin.appHost.html b/docs/api/cli-kit/functions/node_context_spin.appHost.html index f1ad81da36..ac46faaef7 100644 --- a/docs/api/cli-kit/functions/node_context_spin.appHost.html +++ b/docs/api/cli-kit/functions/node_context_spin.appHost.html @@ -1,4 +1,4 @@ appHost | @shopify/cli-kit

      Function appHost

      • appHost(env?): string | undefined

      • Returns the value of the SPIN_APP_HOST environment variable.

        Parameters

        • env: ProcessEnv = process.env

          Environment variables.

        Returns string | undefined

        The value of the SPIN_APP_HOST environment variable.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_spin.appPort.html b/docs/api/cli-kit/functions/node_context_spin.appPort.html index 7a20ad2f27..415bfc8fe5 100644 --- a/docs/api/cli-kit/functions/node_context_spin.appPort.html +++ b/docs/api/cli-kit/functions/node_context_spin.appPort.html @@ -1,4 +1,4 @@ appPort | @shopify/cli-kit

      Function appPort

      • appPort(env?): number | undefined

      • Returns the value of the SERVER_PORT environment variable.

        Parameters

        • env: ProcessEnv = process.env

          Environment variables.

        Returns number | undefined

        The value of the SERVER_PORT environment variable.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_spin.fetchSpinPort.html b/docs/api/cli-kit/functions/node_context_spin.fetchSpinPort.html index 75e8fd8b68..104a74a188 100644 --- a/docs/api/cli-kit/functions/node_context_spin.fetchSpinPort.html +++ b/docs/api/cli-kit/functions/node_context_spin.fetchSpinPort.html @@ -3,4 +3,4 @@
    • portEnvName: string

      The name of the environment variable to fetch the port from.

    • basePath: string = '/run'

      The base path to look for the port file.

      • Returns Promise<number | undefined>

      The port number or undefined if the port could not be found.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_spin.instance.html b/docs/api/cli-kit/functions/node_context_spin.instance.html index b681096d7b..b9368e8a37 100644 --- a/docs/api/cli-kit/functions/node_context_spin.instance.html +++ b/docs/api/cli-kit/functions/node_context_spin.instance.html @@ -1,4 +1,4 @@ instance | @shopify/cli-kit

      Function instance

      • instance(env?): string | undefined

      • Returns the value of the SPIN_INSTANCE environment variable.

        Parameters

        • env: ProcessEnv = process.env

          Environment variables.

        Returns string | undefined

        The value of the SPIN_INSTANCE environment variable.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_spin.isSpin.html b/docs/api/cli-kit/functions/node_context_spin.isSpin.html index 290ffc9f4f..b1740869a7 100644 --- a/docs/api/cli-kit/functions/node_context_spin.isSpin.html +++ b/docs/api/cli-kit/functions/node_context_spin.isSpin.html @@ -1,4 +1,4 @@ isSpin | @shopify/cli-kit

      Function isSpin

      • isSpin(env?): boolean

      • Returns true if the CLI is running in a Spin environment.

        Parameters

        • env: ProcessEnv = process.env

          Environment variables.

        Returns boolean

        True if the CLI is running in a Spin environment.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_spin.isSpinEnvironment.html b/docs/api/cli-kit/functions/node_context_spin.isSpinEnvironment.html index 1491171101..3df593ef25 100644 --- a/docs/api/cli-kit/functions/node_context_spin.isSpinEnvironment.html +++ b/docs/api/cli-kit/functions/node_context_spin.isSpinEnvironment.html @@ -1,4 +1,4 @@ isSpinEnvironment | @shopify/cli-kit

      Function isSpinEnvironment

      • isSpinEnvironment(env?): boolean

      • Returns true if the CLI is running in a Spin environment.

        Parameters

        • env: ProcessEnv = process.env

          Environment variables.

        Returns boolean

        True if the CLI is running in a Spin environment.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_spin.show.html b/docs/api/cli-kit/functions/node_context_spin.show.html index 2090677f4a..015970eb80 100644 --- a/docs/api/cli-kit/functions/node_context_spin.show.html +++ b/docs/api/cli-kit/functions/node_context_spin.show.html @@ -3,4 +3,4 @@
    • env: ProcessEnv = process.env

      Environment variables.

      • Returns Promise<{
          fqdn: string;
      }>

      The JSON-parsed output of the Spin CLI.

      Throws

      Any error raised from the underlying Spin CLI.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_spin.spinFqdn.html b/docs/api/cli-kit/functions/node_context_spin.spinFqdn.html index 44079c2244..b8e9a2cd1b 100644 --- a/docs/api/cli-kit/functions/node_context_spin.spinFqdn.html +++ b/docs/api/cli-kit/functions/node_context_spin.spinFqdn.html @@ -3,4 +3,4 @@ To avoid multiple calls to readSync or show.

      Parameters

      Returns Promise<string>

      Fqdn of the Spin environment.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_utilities.isTruthy.html b/docs/api/cli-kit/functions/node_context_utilities.isTruthy.html index a90eef4a11..6481d6fd92 100644 --- a/docs/api/cli-kit/functions/node_context_utilities.isTruthy.html +++ b/docs/api/cli-kit/functions/node_context_utilities.isTruthy.html @@ -1,4 +1,4 @@ isTruthy | @shopify/cli-kit

      Function isTruthy

      • isTruthy(variable): boolean

      • Returns whether an environment variable value represents a truthy value.

        Parameters

        • variable: undefined | string

          Environment variable value to check.

        Returns boolean

        True when the value is truthy, e.g. '1', 'true', etc.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_crypto.base64URLEncode.html b/docs/api/cli-kit/functions/node_crypto.base64URLEncode.html index d2b9e6ca3c..ecdadfd0c3 100644 --- a/docs/api/cli-kit/functions/node_crypto.base64URLEncode.html +++ b/docs/api/cli-kit/functions/node_crypto.base64URLEncode.html @@ -1,4 +1,4 @@ base64URLEncode | @shopify/cli-kit

      Function base64URLEncode

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_crypto.fileHash.html b/docs/api/cli-kit/functions/node_crypto.fileHash.html index 0a9237a9d6..471f48d44a 100644 --- a/docs/api/cli-kit/functions/node_crypto.fileHash.html +++ b/docs/api/cli-kit/functions/node_crypto.fileHash.html @@ -1,4 +1,4 @@ fileHash | @shopify/cli-kit

      Function fileHash

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_crypto.hashString.html b/docs/api/cli-kit/functions/node_crypto.hashString.html index 7f19d79cd5..73b901888a 100644 --- a/docs/api/cli-kit/functions/node_crypto.hashString.html +++ b/docs/api/cli-kit/functions/node_crypto.hashString.html @@ -1,4 +1,4 @@ hashString | @shopify/cli-kit

      Function hashString

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_crypto.nonRandomUUID.html b/docs/api/cli-kit/functions/node_crypto.nonRandomUUID.html index 7a8e3afac7..895e2e1051 100644 --- a/docs/api/cli-kit/functions/node_crypto.nonRandomUUID.html +++ b/docs/api/cli-kit/functions/node_crypto.nonRandomUUID.html @@ -3,4 +3,4 @@ across different runs of the CLI.

      Parameters

      Returns string

      A non-random UUID string.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_crypto.randomBytes.html b/docs/api/cli-kit/functions/node_crypto.randomBytes.html index bccb7b499f..9160979ab1 100644 --- a/docs/api/cli-kit/functions/node_crypto.randomBytes.html +++ b/docs/api/cli-kit/functions/node_crypto.randomBytes.html @@ -1,4 +1,4 @@ randomBytes | @shopify/cli-kit

      Function randomBytes

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_crypto.randomHex.html b/docs/api/cli-kit/functions/node_crypto.randomHex.html index 0fb1e10120..9919770a7e 100644 --- a/docs/api/cli-kit/functions/node_crypto.randomHex.html +++ b/docs/api/cli-kit/functions/node_crypto.randomHex.html @@ -1,4 +1,4 @@ randomHex | @shopify/cli-kit

      Function randomHex

      • randomHex(size): string

      • Generate a random string in Hex format of the provided size.

        Parameters

        • size: number

          Number of bytes to be generated.

        Returns string

        A random string in Hex format.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_crypto.randomUUID.html b/docs/api/cli-kit/functions/node_crypto.randomUUID.html index c2e3020cd2..51c5da9fc6 100644 --- a/docs/api/cli-kit/functions/node_crypto.randomUUID.html +++ b/docs/api/cli-kit/functions/node_crypto.randomUUID.html @@ -1,3 +1,3 @@ randomUUID | @shopify/cli-kit

      Function randomUUID

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_crypto.sha256.html b/docs/api/cli-kit/functions/node_crypto.sha256.html index 6d07867692..30e3ba5d51 100644 --- a/docs/api/cli-kit/functions/node_crypto.sha256.html +++ b/docs/api/cli-kit/functions/node_crypto.sha256.html @@ -1,4 +1,4 @@ sha256 | @shopify/cli-kit

      Function sha256

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_dot_env.createDotEnvFileLine.html b/docs/api/cli-kit/functions/node_dot_env.createDotEnvFileLine.html index 8445efe468..e2409c868d 100644 --- a/docs/api/cli-kit/functions/node_dot_env.createDotEnvFileLine.html +++ b/docs/api/cli-kit/functions/node_dot_env.createDotEnvFileLine.html @@ -1 +1 @@ -createDotEnvFileLine | @shopify/cli-kit

      Function createDotEnvFileLine

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +createDotEnvFileLine | @shopify/cli-kit

      Function createDotEnvFileLine

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_dot_env.patchEnvFile.html b/docs/api/cli-kit/functions/node_dot_env.patchEnvFile.html index e19dfe7893..030aa6b879 100644 --- a/docs/api/cli-kit/functions/node_dot_env.patchEnvFile.html +++ b/docs/api/cli-kit/functions/node_dot_env.patchEnvFile.html @@ -2,4 +2,4 @@ without removing already existing lines.

      Parameters

      Returns string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_dot_env.readAndParseDotEnv.html b/docs/api/cli-kit/functions/node_dot_env.readAndParseDotEnv.html index c103100a60..fc26e52fe7 100644 --- a/docs/api/cli-kit/functions/node_dot_env.readAndParseDotEnv.html +++ b/docs/api/cli-kit/functions/node_dot_env.readAndParseDotEnv.html @@ -1,4 +1,4 @@ readAndParseDotEnv | @shopify/cli-kit

      Function readAndParseDotEnv

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_dot_env.writeDotEnv.html b/docs/api/cli-kit/functions/node_dot_env.writeDotEnv.html index 9ce72b8c5d..390d49d2be 100644 --- a/docs/api/cli-kit/functions/node_dot_env.writeDotEnv.html +++ b/docs/api/cli-kit/functions/node_dot_env.writeDotEnv.html @@ -1,3 +1,3 @@ writeDotEnv | @shopify/cli-kit

      Function writeDotEnv

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_environment.getBackendPort.html b/docs/api/cli-kit/functions/node_environment.getBackendPort.html index cca8e04016..bd0cea641f 100644 --- a/docs/api/cli-kit/functions/node_environment.getBackendPort.html +++ b/docs/api/cli-kit/functions/node_environment.getBackendPort.html @@ -1,3 +1,3 @@ getBackendPort | @shopify/cli-kit

      Function getBackendPort

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_environment.getEnvironmentVariables.html b/docs/api/cli-kit/functions/node_environment.getEnvironmentVariables.html index 73db4db159..0877ba228b 100644 --- a/docs/api/cli-kit/functions/node_environment.getEnvironmentVariables.html +++ b/docs/api/cli-kit/functions/node_environment.getEnvironmentVariables.html @@ -4,4 +4,4 @@ global variable which is discouraged via the no-process-env ESLint rule.

      Returns NodeJS.ProcessEnv

      Current process environment variables.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_environment.getIdentityTokenInformation.html b/docs/api/cli-kit/functions/node_environment.getIdentityTokenInformation.html index 9cadf5118f..7715328df0 100644 --- a/docs/api/cli-kit/functions/node_environment.getIdentityTokenInformation.html +++ b/docs/api/cli-kit/functions/node_environment.getIdentityTokenInformation.html @@ -1,3 +1,3 @@ getIdentityTokenInformation | @shopify/cli-kit

      Function getIdentityTokenInformation

      • getIdentityTokenInformation(): {
            accessToken: string;
            refreshToken: string;
            userId: string;
        } | undefined

      • Returns the information of the identity & refresh tokens, provided by environment variables.

        Returns {
            accessToken: string;
            refreshToken: string;
            userId: string;
        } | undefined

        The identity token information in case it exists.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_environment.getOrganization.html b/docs/api/cli-kit/functions/node_environment.getOrganization.html index f3e0d9d830..ebafc809ba 100644 --- a/docs/api/cli-kit/functions/node_environment.getOrganization.html +++ b/docs/api/cli-kit/functions/node_environment.getOrganization.html @@ -1,3 +1,3 @@ getOrganization | @shopify/cli-kit

      Function getOrganization

      • getOrganization(): string | undefined

      • Returns the value of the organization id from the environment variables.

        Returns string | undefined

        True if the current proccess is running using the partners token.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_environment.getPartnersToken.html b/docs/api/cli-kit/functions/node_environment.getPartnersToken.html index 1962001089..f66f8a16ad 100644 --- a/docs/api/cli-kit/functions/node_environment.getPartnersToken.html +++ b/docs/api/cli-kit/functions/node_environment.getPartnersToken.html @@ -1,3 +1,3 @@ getPartnersToken | @shopify/cli-kit

      Function getPartnersToken

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_environment.usePartnersToken.html b/docs/api/cli-kit/functions/node_environment.usePartnersToken.html index 6154264b08..733dc30aa5 100644 --- a/docs/api/cli-kit/functions/node_environment.usePartnersToken.html +++ b/docs/api/cli-kit/functions/node_environment.usePartnersToken.html @@ -1,3 +1,3 @@ usePartnersToken | @shopify/cli-kit

      Function usePartnersToken

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_environments.loadEnvironment.html b/docs/api/cli-kit/functions/node_environments.loadEnvironment.html index 302bd4bdf7..de226c0593 100644 --- a/docs/api/cli-kit/functions/node_environments.loadEnvironment.html +++ b/docs/api/cli-kit/functions/node_environments.loadEnvironment.html @@ -1,3 +1,3 @@ loadEnvironment | @shopify/cli-kit

      Function loadEnvironment

      • loadEnvironment(environmentName, fileName, options?): Promise<JsonMap | undefined>

      • Loads environments from a file.

        Parameters

        • environmentName: string
        • fileName: string
        • Optional options: LoadEnvironmentOptions

        Returns Promise<JsonMap | undefined>

        The loaded environments.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_error.cleanSingleStackTracePath.html b/docs/api/cli-kit/functions/node_error.cleanSingleStackTracePath.html index 5dce9b6eca..6ed385711a 100644 --- a/docs/api/cli-kit/functions/node_error.cleanSingleStackTracePath.html +++ b/docs/api/cli-kit/functions/node_error.cleanSingleStackTracePath.html @@ -1,4 +1,4 @@ cleanSingleStackTracePath | @shopify/cli-kit

      Function cleanSingleStackTracePath

      • cleanSingleStackTracePath(filePath): string

      • Stack traces usually have file:// - we strip that and also remove the Windows drive designation.

        Parameters

        • filePath: string

          Path to be cleaned.

        Returns string

        The cleaned path.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_error.errorMapper.html b/docs/api/cli-kit/functions/node_error.errorMapper.html index 4ba145ffc4..bc9fc6c2e7 100644 --- a/docs/api/cli-kit/functions/node_error.errorMapper.html +++ b/docs/api/cli-kit/functions/node_error.errorMapper.html @@ -1,4 +1,4 @@ errorMapper | @shopify/cli-kit

      Function errorMapper

      • errorMapper(error): Promise<unknown>

      • A function that maps an error to an Abort with the stack trace when coming from the CLI.

        Parameters

        • error: unknown

          Error to be mapped.

        Returns Promise<unknown>

        A promise that resolves with the new error object.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_error.handler.html b/docs/api/cli-kit/functions/node_error.handler.html index 54c645d810..9e36e9e946 100644 --- a/docs/api/cli-kit/functions/node_error.handler.html +++ b/docs/api/cli-kit/functions/node_error.handler.html @@ -1,4 +1,4 @@ handler | @shopify/cli-kit

      Function handler

      • handler(error): Promise<unknown>

      • A function that handles errors that blow up in the CLI.

        Parameters

        • error: unknown

          Error to be handled.

        Returns Promise<unknown>

        A promise that resolves with the error passed.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_error.shouldReportError.html b/docs/api/cli-kit/functions/node_error.shouldReportError.html index e550443f11..852ae86b82 100644 --- a/docs/api/cli-kit/functions/node_error.shouldReportError.html +++ b/docs/api/cli-kit/functions/node_error.shouldReportError.html @@ -1,4 +1,4 @@ shouldReportError | @shopify/cli-kit

      Function shouldReportError

      • shouldReportError(error): boolean

      • A function that checks if an error should be reported as unhandled.

        Parameters

        • error: unknown

          Error to be checked.

        Returns boolean

        A boolean indicating if the error should be reported.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_error_handler.addBugsnagMetadata.html b/docs/api/cli-kit/functions/node_error_handler.addBugsnagMetadata.html index 5583e89b0a..c4612d6bbf 100644 --- a/docs/api/cli-kit/functions/node_error_handler.addBugsnagMetadata.html +++ b/docs/api/cli-kit/functions/node_error_handler.addBugsnagMetadata.html @@ -1 +1 @@ -addBugsnagMetadata | @shopify/cli-kit

      Function addBugsnagMetadata

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +addBugsnagMetadata | @shopify/cli-kit

      Function addBugsnagMetadata

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_error_handler.cleanStackFrameFilePath.html b/docs/api/cli-kit/functions/node_error_handler.cleanStackFrameFilePath.html index 6a336458fd..ac017c83e1 100644 --- a/docs/api/cli-kit/functions/node_error_handler.cleanStackFrameFilePath.html +++ b/docs/api/cli-kit/functions/node_error_handler.cleanStackFrameFilePath.html @@ -1,4 +1,4 @@ cleanStackFrameFilePath | @shopify/cli-kit

      Function cleanStackFrameFilePath

      • cleanStackFrameFilePath(__namedParameters): string

      • If the given file path is within a node_modules folder, remove prefix up to and including the node_modules folder.

        This gives us very consistent paths for errors generated by the CLI.

        -

        Parameters

        • __namedParameters: {
              currentFilePath: string;
              pluginLocations: {
                  name: string;
                  pluginPath: string;
              }[];
              projectRoot: string;
          }
          • currentFilePath: string
          • pluginLocations: {
                name: string;
                pluginPath: string;
            }[]
          • projectRoot: string

        Returns string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_error_handler.errorHandler.html b/docs/api/cli-kit/functions/node_error_handler.errorHandler.html index 8a6f038a5d..13215c9d38 100644 --- a/docs/api/cli-kit/functions/node_error_handler.errorHandler.html +++ b/docs/api/cli-kit/functions/node_error_handler.errorHandler.html @@ -1 +1 @@ -errorHandler | @shopify/cli-kit

      Function errorHandler

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +errorHandler | @shopify/cli-kit

      Function errorHandler

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_error_handler.registerCleanBugsnagErrorsFromWithinPlugins.html b/docs/api/cli-kit/functions/node_error_handler.registerCleanBugsnagErrorsFromWithinPlugins.html index 1157a75497..6b7bd57ac4 100644 --- a/docs/api/cli-kit/functions/node_error_handler.registerCleanBugsnagErrorsFromWithinPlugins.html +++ b/docs/api/cli-kit/functions/node_error_handler.registerCleanBugsnagErrorsFromWithinPlugins.html @@ -1,2 +1,2 @@ registerCleanBugsnagErrorsFromWithinPlugins | @shopify/cli-kit

      Function registerCleanBugsnagErrorsFromWithinPlugins

      • registerCleanBugsnagErrorsFromWithinPlugins(config): Promise<void>

      • Register a Bugsnag error listener to clean up stack traces for errors within plugin code.

        -

        Parameters

        • config: Config

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_error_handler.sendErrorToBugsnag.html b/docs/api/cli-kit/functions/node_error_handler.sendErrorToBugsnag.html index a4fecd4194..e8f368fc32 100644 --- a/docs/api/cli-kit/functions/node_error_handler.sendErrorToBugsnag.html +++ b/docs/api/cli-kit/functions/node_error_handler.sendErrorToBugsnag.html @@ -1,3 +1,3 @@ sendErrorToBugsnag | @shopify/cli-kit

      Function sendErrorToBugsnag

      • sendErrorToBugsnag(error, exitMode): Promise<{
            error: unknown;
            reported: false;
            unhandled: unknown;
        } | {
            error: Error;
            reported: true;
            unhandled: boolean;
        }>

      • Sends an error to Bugsnag. This is configured automatically for uncaught errors from CLI commands, but can also be used to manually record an error.

        Parameters

        Returns Promise<{
            error: unknown;
            reported: false;
            unhandled: unknown;
        } | {
            error: Error;
            reported: true;
            unhandled: boolean;
        }>

        the reported error (this may have been tweaked for better reporting), and a bool to indicate if the error was actually submitted or not

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_framework.resolveFramework.html b/docs/api/cli-kit/functions/node_framework.resolveFramework.html index 36ccac4f6e..efdf7c48f9 100644 --- a/docs/api/cli-kit/functions/node_framework.resolveFramework.html +++ b/docs/api/cli-kit/functions/node_framework.resolveFramework.html @@ -2,4 +2,4 @@ specific directory.

      Parameters

      Returns Promise<string>

      The name of the framework used or 'unknown' otherwise

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.appendFile.html b/docs/api/cli-kit/functions/node_fs.appendFile.html index f417edbaa3..672d3f01b8 100644 --- a/docs/api/cli-kit/functions/node_fs.appendFile.html +++ b/docs/api/cli-kit/functions/node_fs.appendFile.html @@ -1,4 +1,4 @@ appendFile | @shopify/cli-kit

      Function appendFile

      • appendFile(path, content): Promise<void>

      • Appnds content to file at path.

        Parameters

        • path: string

          Path to the file to be appended.

        • content: string

          Content to be appended.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.appendFileSync.html b/docs/api/cli-kit/functions/node_fs.appendFileSync.html index c19b4249f3..fd9ac64903 100644 --- a/docs/api/cli-kit/functions/node_fs.appendFileSync.html +++ b/docs/api/cli-kit/functions/node_fs.appendFileSync.html @@ -1,4 +1,4 @@ appendFileSync | @shopify/cli-kit

      Function appendFileSync

      • appendFileSync(path, data): void

      • Synchronously appends content to file at path.

        Parameters

        • path: string

          Path to the file to be appended.

        • data: string

          Content to be appended.

          -

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.chmod.html b/docs/api/cli-kit/functions/node_fs.chmod.html index 602c85557b..c4a47f861f 100644 --- a/docs/api/cli-kit/functions/node_fs.chmod.html +++ b/docs/api/cli-kit/functions/node_fs.chmod.html @@ -1,4 +1,4 @@ chmod | @shopify/cli-kit

      Function chmod

      • chmod(path, mode): Promise<void>

      • Changes the permissions of a directory or file.

        Parameters

        • path: string

          Path to the file or directory whose permissions will be modified.

        • mode: string | number

          Permissions to set to the file or directory.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.copyFile.html b/docs/api/cli-kit/functions/node_fs.copyFile.html index 51add54618..9411196da3 100644 --- a/docs/api/cli-kit/functions/node_fs.copyFile.html +++ b/docs/api/cli-kit/functions/node_fs.copyFile.html @@ -1,4 +1,4 @@ copyFile | @shopify/cli-kit

      Function copyFile

      • copyFile(from, to): Promise<void>

      • Copies a file.

        Parameters

        • from: string

          Path to the directory or file to be copied.

        • to: string

          Destination path.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.createFileReadStream.html b/docs/api/cli-kit/functions/node_fs.createFileReadStream.html index b5f6c4a79f..40458b94c7 100644 --- a/docs/api/cli-kit/functions/node_fs.createFileReadStream.html +++ b/docs/api/cli-kit/functions/node_fs.createFileReadStream.html @@ -2,4 +2,4 @@

      Parameters

      Returns ReadStream

      A read stream for the file.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.createFileWriteStream.html b/docs/api/cli-kit/functions/node_fs.createFileWriteStream.html index 995952f2cb..7b3078f996 100644 --- a/docs/api/cli-kit/functions/node_fs.createFileWriteStream.html +++ b/docs/api/cli-kit/functions/node_fs.createFileWriteStream.html @@ -1,4 +1,4 @@ createFileWriteStream | @shopify/cli-kit

      Function createFileWriteStream

      • createFileWriteStream(path): WriteStream

      • Create a write stream for a file.

        Parameters

        • path: string

          Path to the file.

        Returns WriteStream

        A write stream for the file.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.fileExists.html b/docs/api/cli-kit/functions/node_fs.fileExists.html index 6230a36620..a8b3a130ee 100644 --- a/docs/api/cli-kit/functions/node_fs.fileExists.html +++ b/docs/api/cli-kit/functions/node_fs.fileExists.html @@ -1,4 +1,4 @@ fileExists | @shopify/cli-kit

      Function fileExists

      • fileExists(path): Promise<boolean>

      • Returns true if a file or directory exists.

        Parameters

        • path: string

          Path to the directory or file.

        Returns Promise<boolean>

        True if it exists.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.fileExistsSync.html b/docs/api/cli-kit/functions/node_fs.fileExistsSync.html index 0d453f5a1d..0059f92006 100644 --- a/docs/api/cli-kit/functions/node_fs.fileExistsSync.html +++ b/docs/api/cli-kit/functions/node_fs.fileExistsSync.html @@ -1 +1 @@ -fileExistsSync | @shopify/cli-kit

      Function fileExistsSync

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +fileExistsSync | @shopify/cli-kit

      Function fileExistsSync

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.fileHasExecutablePermissions.html b/docs/api/cli-kit/functions/node_fs.fileHasExecutablePermissions.html index 06c90f431b..a6c821f7cc 100644 --- a/docs/api/cli-kit/functions/node_fs.fileHasExecutablePermissions.html +++ b/docs/api/cli-kit/functions/node_fs.fileHasExecutablePermissions.html @@ -1,3 +1,3 @@ fileHasExecutablePermissions | @shopify/cli-kit

      Function fileHasExecutablePermissions

      • fileHasExecutablePermissions(path): Promise<boolean>

      • Checks if a file has executable permissions.

        Parameters

        • path: string

          Path to the file whose permissions will be checked.

          -

        Returns Promise<boolean>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<boolean>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.fileLastUpdated.html b/docs/api/cli-kit/functions/node_fs.fileLastUpdated.html index d71f4e5466..5100220e0f 100644 --- a/docs/api/cli-kit/functions/node_fs.fileLastUpdated.html +++ b/docs/api/cli-kit/functions/node_fs.fileLastUpdated.html @@ -1,4 +1,4 @@ fileLastUpdated | @shopify/cli-kit

      Function fileLastUpdated

      • fileLastUpdated(path): Promise<Date>

      • Returns the Date object for the last modification of a file.

        Parameters

        • path: string

          Path to the directory or file.

        Returns Promise<Date>

        A unix timestamp.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.fileLastUpdatedTimestamp.html b/docs/api/cli-kit/functions/node_fs.fileLastUpdatedTimestamp.html index a43b2d50bf..169f46bcc8 100644 --- a/docs/api/cli-kit/functions/node_fs.fileLastUpdatedTimestamp.html +++ b/docs/api/cli-kit/functions/node_fs.fileLastUpdatedTimestamp.html @@ -1,4 +1,4 @@ fileLastUpdatedTimestamp | @shopify/cli-kit

      Function fileLastUpdatedTimestamp

      • fileLastUpdatedTimestamp(path): Promise<number | undefined>

      • Returns the unix timestamp of the last modification of a file.

        Parameters

        • path: string

          Path to the directory or file.

        Returns Promise<number | undefined>

        A unix timestamp.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.fileRealPath.html b/docs/api/cli-kit/functions/node_fs.fileRealPath.html index d7f4fec678..1915c8d34d 100644 --- a/docs/api/cli-kit/functions/node_fs.fileRealPath.html +++ b/docs/api/cli-kit/functions/node_fs.fileRealPath.html @@ -1,4 +1,4 @@ fileRealPath | @shopify/cli-kit

      Function fileRealPath

      • fileRealPath(path): Promise<string>

      • Given a path, it determines the actual path. This is useful when working with paths that represent symlinks.

        Parameters

        • path: string

          Path whose real path will be returned.

          -

        Returns Promise<string>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<string>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.fileSize.html b/docs/api/cli-kit/functions/node_fs.fileSize.html index 7be4b409c7..7e7b13df1f 100644 --- a/docs/api/cli-kit/functions/node_fs.fileSize.html +++ b/docs/api/cli-kit/functions/node_fs.fileSize.html @@ -1,4 +1,4 @@ fileSize | @shopify/cli-kit

      Function fileSize

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.fileSizeSync.html b/docs/api/cli-kit/functions/node_fs.fileSizeSync.html index 61a9f1b718..870235edd1 100644 --- a/docs/api/cli-kit/functions/node_fs.fileSizeSync.html +++ b/docs/api/cli-kit/functions/node_fs.fileSizeSync.html @@ -1,4 +1,4 @@ fileSizeSync | @shopify/cli-kit

      Function fileSizeSync

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.findPathUp.html b/docs/api/cli-kit/functions/node_fs.findPathUp.html index 2e2d328ba6..5b85aacc04 100644 --- a/docs/api/cli-kit/functions/node_fs.findPathUp.html +++ b/docs/api/cli-kit/functions/node_fs.findPathUp.html @@ -2,4 +2,4 @@

      Parameters

      Returns ReturnType<typeof internalFindUp>

      The first path found that matches or undefined if none could be found.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.generateRandomNameForSubdirectory.html b/docs/api/cli-kit/functions/node_fs.generateRandomNameForSubdirectory.html index 930524c445..42e000bc3c 100644 --- a/docs/api/cli-kit/functions/node_fs.generateRandomNameForSubdirectory.html +++ b/docs/api/cli-kit/functions/node_fs.generateRandomNameForSubdirectory.html @@ -2,4 +2,4 @@ It ensures that the returned directory name doesn't exist.

      Parameters

      Returns Promise<string>

      It returns the name of the directory.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.glob.html b/docs/api/cli-kit/functions/node_fs.glob.html index 6f9cefdc48..fe2bd4635f 100644 --- a/docs/api/cli-kit/functions/node_fs.glob.html +++ b/docs/api/cli-kit/functions/node_fs.glob.html @@ -2,4 +2,4 @@

      Parameters

      Returns Promise<string[]>

      A promise that resolves to an array of pathnames that match the given pattern.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.inTemporaryDirectory.html b/docs/api/cli-kit/functions/node_fs.inTemporaryDirectory.html index 931e0b0669..b36777324a 100644 --- a/docs/api/cli-kit/functions/node_fs.inTemporaryDirectory.html +++ b/docs/api/cli-kit/functions/node_fs.inTemporaryDirectory.html @@ -1,3 +1,3 @@ inTemporaryDirectory | @shopify/cli-kit

      Function inTemporaryDirectory

      • inTemporaryDirectory<T>(callback): Promise<T>

      • Creates a temporary directory and ties its lifecycle to the lifecycle of the callback.

        Type Parameters

        • T

        Parameters

        • callback: ((tmpDir) => T | Promise<T>)

          The callback that receives the temporary directory.

          -
            • (tmpDir): T | Promise<T>

            • Parameters

              • tmpDir: string

              Returns T | Promise<T>

        Returns Promise<T>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<T>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.isDirectory.html b/docs/api/cli-kit/functions/node_fs.isDirectory.html index 7ebb859ba8..409ffe8906 100644 --- a/docs/api/cli-kit/functions/node_fs.isDirectory.html +++ b/docs/api/cli-kit/functions/node_fs.isDirectory.html @@ -1,4 +1,4 @@ isDirectory | @shopify/cli-kit

      Function isDirectory

      • isDirectory(path): Promise<boolean>

      • Check whether a path is a directory.

        Parameters

        • path: string

          Path to check.

        Returns Promise<boolean>

        True if the path is a directory, false otherwise.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.matchGlob.html b/docs/api/cli-kit/functions/node_fs.matchGlob.html index 99fb2245a6..07c58415be 100644 --- a/docs/api/cli-kit/functions/node_fs.matchGlob.html +++ b/docs/api/cli-kit/functions/node_fs.matchGlob.html @@ -3,4 +3,4 @@
    • pattern: string

      The glob pattern to match against.

    • options: MatchGlobOptions = ...

      The options to refine the matching approach.

      • Returns boolean

      true if the key matches the pattern, false otherwise.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.mkTmpDir.html b/docs/api/cli-kit/functions/node_fs.mkTmpDir.html index 63ac6ba25d..4cb4ec5702 100644 --- a/docs/api/cli-kit/functions/node_fs.mkTmpDir.html +++ b/docs/api/cli-kit/functions/node_fs.mkTmpDir.html @@ -1,3 +1,3 @@ mkTmpDir | @shopify/cli-kit

      Function mkTmpDir

      • mkTmpDir(): Promise<string>

      • Create a temporary directory within the OS provided location for temp directories

        Returns Promise<string>

        Path to the temporary directory.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.mkdir.html b/docs/api/cli-kit/functions/node_fs.mkdir.html index d19bdfb474..a673159db5 100644 --- a/docs/api/cli-kit/functions/node_fs.mkdir.html +++ b/docs/api/cli-kit/functions/node_fs.mkdir.html @@ -1,3 +1,3 @@ mkdir | @shopify/cli-kit

      Function mkdir

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.mkdirSync.html b/docs/api/cli-kit/functions/node_fs.mkdirSync.html index 8e4101ce7d..57449c0b04 100644 --- a/docs/api/cli-kit/functions/node_fs.mkdirSync.html +++ b/docs/api/cli-kit/functions/node_fs.mkdirSync.html @@ -1,3 +1,3 @@ mkdirSync | @shopify/cli-kit

      Function mkdirSync

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.moveFile.html b/docs/api/cli-kit/functions/node_fs.moveFile.html index 40f2ed543a..15883cb034 100644 --- a/docs/api/cli-kit/functions/node_fs.moveFile.html +++ b/docs/api/cli-kit/functions/node_fs.moveFile.html @@ -2,4 +2,4 @@

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.pathToFileURL.html b/docs/api/cli-kit/functions/node_fs.pathToFileURL.html index 134dbfddc8..03741dbf57 100644 --- a/docs/api/cli-kit/functions/node_fs.pathToFileURL.html +++ b/docs/api/cli-kit/functions/node_fs.pathToFileURL.html @@ -1,4 +1,4 @@ pathToFileURL | @shopify/cli-kit

      Function pathToFileURL

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.readFile.html b/docs/api/cli-kit/functions/node_fs.readFile.html index c307b1d96b..5c82848c60 100644 --- a/docs/api/cli-kit/functions/node_fs.readFile.html +++ b/docs/api/cli-kit/functions/node_fs.readFile.html @@ -3,9 +3,9 @@

      Parameters

      Returns Promise<string>

      A promise that resolves with the content of the file.

      -
    • readFile(path, options?): Promise<Buffer>

    • It reads a file and returns its content as a string. +

    • readFile(path, options?): Promise<Buffer>

    • It reads a file and returns its content as a string. Uses utf-8 encoding by default.

      Parameters

      Returns Promise<Buffer>

      A promise that resolves with the content of the file.

      -

      • Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.readFileSync.html b/docs/api/cli-kit/functions/node_fs.readFileSync.html index e6e18cb30b..96f7f87258 100644 --- a/docs/api/cli-kit/functions/node_fs.readFileSync.html +++ b/docs/api/cli-kit/functions/node_fs.readFileSync.html @@ -1,4 +1,4 @@ readFileSync | @shopify/cli-kit

      Function readFileSync

      • readFileSync(path): Buffer

      • Synchronously reads a file and returns its content as a buffer.

        Parameters

        • path: string

          Path to the file to read.

        Returns Buffer

        The content of the file.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.removeFile.html b/docs/api/cli-kit/functions/node_fs.removeFile.html index 8ce87f4c84..d5654847b7 100644 --- a/docs/api/cli-kit/functions/node_fs.removeFile.html +++ b/docs/api/cli-kit/functions/node_fs.removeFile.html @@ -1,3 +1,3 @@ removeFile | @shopify/cli-kit

      Function removeFile

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.removeFileSync.html b/docs/api/cli-kit/functions/node_fs.removeFileSync.html index 440431face..42b2424552 100644 --- a/docs/api/cli-kit/functions/node_fs.removeFileSync.html +++ b/docs/api/cli-kit/functions/node_fs.removeFileSync.html @@ -1,3 +1,3 @@ removeFileSync | @shopify/cli-kit

      Function removeFileSync

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.renameFile.html b/docs/api/cli-kit/functions/node_fs.renameFile.html index 3bb2469895..19702ca162 100644 --- a/docs/api/cli-kit/functions/node_fs.renameFile.html +++ b/docs/api/cli-kit/functions/node_fs.renameFile.html @@ -1,4 +1,4 @@ renameFile | @shopify/cli-kit

      Function renameFile

      • renameFile(from, to): Promise<void>

      • Renames a file.

        Parameters

        • from: string

          Path to the file to be renamed.

        • to: string

          New path for the file.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.rmdir.html b/docs/api/cli-kit/functions/node_fs.rmdir.html index 6690fa2452..eceb56cbfa 100644 --- a/docs/api/cli-kit/functions/node_fs.rmdir.html +++ b/docs/api/cli-kit/functions/node_fs.rmdir.html @@ -1,4 +1,4 @@ rmdir | @shopify/cli-kit

      Function rmdir

      • rmdir(path, options?): Promise<void>

      • Removes a directory at the given path.

        Parameters

        • path: string

          Path to the directory to be removed.

        • options: RmDirOptions = {}

          Options to remove the directory with.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.stripUpPath.html b/docs/api/cli-kit/functions/node_fs.stripUpPath.html index 77d0c335ac..3b7a51597c 100644 --- a/docs/api/cli-kit/functions/node_fs.stripUpPath.html +++ b/docs/api/cli-kit/functions/node_fs.stripUpPath.html @@ -2,4 +2,4 @@

      Parameters

      Returns string

      The stripped path.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.tempDirectory.html b/docs/api/cli-kit/functions/node_fs.tempDirectory.html index bacf8f10b4..c6cbaf74a5 100644 --- a/docs/api/cli-kit/functions/node_fs.tempDirectory.html +++ b/docs/api/cli-kit/functions/node_fs.tempDirectory.html @@ -2,4 +2,4 @@

      Returns string

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.touchFile.html b/docs/api/cli-kit/functions/node_fs.touchFile.html index 3af746ec91..c03789b1d6 100644 --- a/docs/api/cli-kit/functions/node_fs.touchFile.html +++ b/docs/api/cli-kit/functions/node_fs.touchFile.html @@ -1,3 +1,3 @@ touchFile | @shopify/cli-kit

      Function touchFile

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.touchFileSync.html b/docs/api/cli-kit/functions/node_fs.touchFileSync.html index 191565d45a..fca15a8256 100644 --- a/docs/api/cli-kit/functions/node_fs.touchFileSync.html +++ b/docs/api/cli-kit/functions/node_fs.touchFileSync.html @@ -1,3 +1,3 @@ touchFileSync | @shopify/cli-kit

      Function touchFileSync

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.unlinkFileSync.html b/docs/api/cli-kit/functions/node_fs.unlinkFileSync.html index d9879db830..7b61c7d4fb 100644 --- a/docs/api/cli-kit/functions/node_fs.unlinkFileSync.html +++ b/docs/api/cli-kit/functions/node_fs.unlinkFileSync.html @@ -1,4 +1,4 @@ unlinkFileSync | @shopify/cli-kit

      Function unlinkFileSync

      • unlinkFileSync(path): void

      • Unlink a file at the given path.

        Parameters

        • path: string

          Path to the file.

        Returns void

        A promise that resolves when the file is unlinked.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.writeFile.html b/docs/api/cli-kit/functions/node_fs.writeFile.html index a1d4b201f4..08eecc2583 100644 --- a/docs/api/cli-kit/functions/node_fs.writeFile.html +++ b/docs/api/cli-kit/functions/node_fs.writeFile.html @@ -2,4 +2,4 @@

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_fs.writeFileSync.html b/docs/api/cli-kit/functions/node_fs.writeFileSync.html index 72d37819de..6fbe848341 100644 --- a/docs/api/cli-kit/functions/node_fs.writeFileSync.html +++ b/docs/api/cli-kit/functions/node_fs.writeFileSync.html @@ -1,4 +1,4 @@ writeFileSync | @shopify/cli-kit

      Function writeFileSync

      • writeFileSync(path, data): void

      • Synchronously writes content to file at path.

        Parameters

        • path: string

          Path to the file to be written.

        • data: string

          Content to be written.

          -

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.addAllToGitFromDirectory.html b/docs/api/cli-kit/functions/node_git.addAllToGitFromDirectory.html index b35c04cc5f..ee6530c085 100644 --- a/docs/api/cli-kit/functions/node_git.addAllToGitFromDirectory.html +++ b/docs/api/cli-kit/functions/node_git.addAllToGitFromDirectory.html @@ -1,4 +1,4 @@ addAllToGitFromDirectory | @shopify/cli-kit

      Function addAllToGitFromDirectory

      • addAllToGitFromDirectory(directory?): Promise<void>

      • Add all files to the git index from the given directory.

        Parameters

        • Optional directory: string

          The directory where the git repository is located.

        Returns Promise<void>

        A promise that resolves when the files are added to the index.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.checkIfIgnoredInGitRepository.html b/docs/api/cli-kit/functions/node_git.checkIfIgnoredInGitRepository.html index 909206cbab..51b74132cb 100644 --- a/docs/api/cli-kit/functions/node_git.checkIfIgnoredInGitRepository.html +++ b/docs/api/cli-kit/functions/node_git.checkIfIgnoredInGitRepository.html @@ -4,4 +4,4 @@

      Parameters

      Returns Promise<string[]>

      Files ignored by the lockfile.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.createGitCommit.html b/docs/api/cli-kit/functions/node_git.createGitCommit.html index 2e991c76ae..40797310f9 100644 --- a/docs/api/cli-kit/functions/node_git.createGitCommit.html +++ b/docs/api/cli-kit/functions/node_git.createGitCommit.html @@ -2,4 +2,4 @@

      Parameters

      Returns Promise<string>

      The hash of the created commit.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.createGitIgnore.html b/docs/api/cli-kit/functions/node_git.createGitIgnore.html index 6924cf173f..591a92d4e6 100644 --- a/docs/api/cli-kit/functions/node_git.createGitIgnore.html +++ b/docs/api/cli-kit/functions/node_git.createGitIgnore.html @@ -1,4 +1,4 @@ createGitIgnore | @shopify/cli-kit

      Function createGitIgnore

      • createGitIgnore(directory, template): void

      • Create a .gitignore file in the given directory.

        Parameters

        • directory: string

          The directory where the .gitignore file will be created.

        • template: GitIgnoreTemplate

          The template to use to create the .gitignore file.

          -

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.downloadGitRepository.html b/docs/api/cli-kit/functions/node_git.downloadGitRepository.html index 0bcd63974d..2e5d78a60e 100644 --- a/docs/api/cli-kit/functions/node_git.downloadGitRepository.html +++ b/docs/api/cli-kit/functions/node_git.downloadGitRepository.html @@ -1,4 +1,4 @@ downloadGitRepository | @shopify/cli-kit

      Function downloadGitRepository

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.ensureGitIsPresentOrAbort.html b/docs/api/cli-kit/functions/node_git.ensureGitIsPresentOrAbort.html index 2ab568e445..42be25a852 100644 --- a/docs/api/cli-kit/functions/node_git.ensureGitIsPresentOrAbort.html +++ b/docs/api/cli-kit/functions/node_git.ensureGitIsPresentOrAbort.html @@ -1,3 +1,3 @@ ensureGitIsPresentOrAbort | @shopify/cli-kit

      Function ensureGitIsPresentOrAbort

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.ensureInsideGitDirectory.html b/docs/api/cli-kit/functions/node_git.ensureInsideGitDirectory.html index 57b301a51a..9577190997 100644 --- a/docs/api/cli-kit/functions/node_git.ensureInsideGitDirectory.html +++ b/docs/api/cli-kit/functions/node_git.ensureInsideGitDirectory.html @@ -1,4 +1,4 @@ ensureInsideGitDirectory | @shopify/cli-kit

      Function ensureInsideGitDirectory

      • ensureInsideGitDirectory(directory?): Promise<void>

      • If command run from outside a .git directory tree it throws an abort error.

        Parameters

        • Optional directory: string

          The directory to check.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.ensureIsClean.html b/docs/api/cli-kit/functions/node_git.ensureIsClean.html index 1e90236462..20fd749490 100644 --- a/docs/api/cli-kit/functions/node_git.ensureIsClean.html +++ b/docs/api/cli-kit/functions/node_git.ensureIsClean.html @@ -1,4 +1,4 @@ ensureIsClean | @shopify/cli-kit

      Function ensureIsClean

      • ensureIsClean(directory?): Promise<void>

      • If the .git directory tree is not clean (has uncommitted changes) it throws an abort error.

        Parameters

        • Optional directory: string

          The directory to check.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.getHeadSymbolicRef.html b/docs/api/cli-kit/functions/node_git.getHeadSymbolicRef.html index 45e15ff14a..c2e0ae3c89 100644 --- a/docs/api/cli-kit/functions/node_git.getHeadSymbolicRef.html +++ b/docs/api/cli-kit/functions/node_git.getHeadSymbolicRef.html @@ -1,4 +1,4 @@ getHeadSymbolicRef | @shopify/cli-kit

      Function getHeadSymbolicRef

      • getHeadSymbolicRef(directory?): Promise<string>

      • Get the HEAD symbolic reference of a git repository.

        Parameters

        • Optional directory: string

          The directory of the git repository.

        Returns Promise<string>

        The HEAD symbolic reference of the repository.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.getLatestGitCommit.html b/docs/api/cli-kit/functions/node_git.getLatestGitCommit.html index cc267c4923..7313c6e47e 100644 --- a/docs/api/cli-kit/functions/node_git.getLatestGitCommit.html +++ b/docs/api/cli-kit/functions/node_git.getLatestGitCommit.html @@ -1,4 +1,4 @@ getLatestGitCommit | @shopify/cli-kit

      Function getLatestGitCommit

      • getLatestGitCommit(directory?): Promise<DefaultLogFields & ListLogLine>

      • Get the latest commit of a git repository.

        Parameters

        • Optional directory: string

          The directory of the git repository.

        Returns Promise<DefaultLogFields & ListLogLine>

        The latest commit of the repository.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.initializeGitRepository.html b/docs/api/cli-kit/functions/node_git.initializeGitRepository.html index 75eb811bbc..ad09653192 100644 --- a/docs/api/cli-kit/functions/node_git.initializeGitRepository.html +++ b/docs/api/cli-kit/functions/node_git.initializeGitRepository.html @@ -1,4 +1,4 @@ initializeGitRepository | @shopify/cli-kit

      Function initializeGitRepository

      • initializeGitRepository(directory, initialBranch?): Promise<void>

      • Initialize a git repository at the given directory.

        Parameters

        • directory: string

          The directory where the git repository will be initialized.

        • initialBranch: string = 'main'

          The name of the initial branch.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_git.isClean.html b/docs/api/cli-kit/functions/node_git.isClean.html index 1eab68ec67..43e3402fbb 100644 --- a/docs/api/cli-kit/functions/node_git.isClean.html +++ b/docs/api/cli-kit/functions/node_git.isClean.html @@ -1,4 +1,4 @@ isClean | @shopify/cli-kit

      Function isClean

      • isClean(directory?): Promise<boolean>

      • Returns true if the .git directory tree is clean (no uncommitted changes).

        Parameters

        • Optional directory: string

          The directory to check.

        Returns Promise<boolean>

        True is the .git directory is clean.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_github.getLatestGitHubRelease.html b/docs/api/cli-kit/functions/node_github.getLatestGitHubRelease.html index 06b2a1a199..c21713c7e2 100644 --- a/docs/api/cli-kit/functions/node_github.getLatestGitHubRelease.html +++ b/docs/api/cli-kit/functions/node_github.getLatestGitHubRelease.html @@ -2,4 +2,4 @@

      Parameters

      Returns Promise<GithubRelease>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<GithubRelease>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_github.parseGitHubRepositoryReference.html b/docs/api/cli-kit/functions/node_github.parseGitHubRepositoryReference.html index cf9f4e71c1..16b6807afd 100644 --- a/docs/api/cli-kit/functions/node_github.parseGitHubRepositoryReference.html +++ b/docs/api/cli-kit/functions/node_github.parseGitHubRepositoryReference.html @@ -1,4 +1,4 @@ parseGitHubRepositoryReference | @shopify/cli-kit

      Function parseGitHubRepositoryReference

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns GithubRepositoryReference

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_github.parseGitHubRepositoryURL.html b/docs/api/cli-kit/functions/node_github.parseGitHubRepositoryURL.html index 4a7f7935b2..9ed404fa7d 100644 --- a/docs/api/cli-kit/functions/node_github.parseGitHubRepositoryURL.html +++ b/docs/api/cli-kit/functions/node_github.parseGitHubRepositoryURL.html @@ -1,3 +1,3 @@ parseGitHubRepositoryURL | @shopify/cli-kit

      Function parseGitHubRepositoryURL

      • parseGitHubRepositoryURL(url): Result<ParseRepositoryURLOutput, Error>

      • Given a GitHub repository URL, it parses it and returns its coomponents.

        Parameters

        • url: string

          The GitHub repository URL

          -

        Returns Result<ParseRepositoryURLOutput, Error>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Result<ParseRepositoryURLOutput, Error>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_hooks_deprecations.postrun.html b/docs/api/cli-kit/functions/node_hooks_deprecations.postrun.html index 73c924c124..f2a3152cfa 100644 --- a/docs/api/cli-kit/functions/node_hooks_deprecations.postrun.html +++ b/docs/api/cli-kit/functions/node_hooks_deprecations.postrun.html @@ -1,3 +1,3 @@ postrun | @shopify/cli-kit

      Function postrun

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_hooks_postrun.hook.html b/docs/api/cli-kit/functions/node_hooks_postrun.hook.html index 56b4c157b6..a8703903fa 100644 --- a/docs/api/cli-kit/functions/node_hooks_postrun.hook.html +++ b/docs/api/cli-kit/functions/node_hooks_postrun.hook.html @@ -1 +1 @@ -hook | @shopify/cli-kit

      Function hook

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +hook | @shopify/cli-kit

      Function hook

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_hooks_prerun.hook.html b/docs/api/cli-kit/functions/node_hooks_prerun.hook.html index 91da54ac3e..4867405599 100644 --- a/docs/api/cli-kit/functions/node_hooks_prerun.hook.html +++ b/docs/api/cli-kit/functions/node_hooks_prerun.hook.html @@ -1 +1 @@ -hook | @shopify/cli-kit

      Function hook

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +hook | @shopify/cli-kit

      Function hook

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_hooks_prerun.parseCommandContent.html b/docs/api/cli-kit/functions/node_hooks_prerun.parseCommandContent.html index fadd388f16..e370643dc9 100644 --- a/docs/api/cli-kit/functions/node_hooks_prerun.parseCommandContent.html +++ b/docs/api/cli-kit/functions/node_hooks_prerun.parseCommandContent.html @@ -1 +1 @@ -parseCommandContent | @shopify/cli-kit

      Function parseCommandContent

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +parseCommandContent | @shopify/cli-kit

      Function parseCommandContent

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_hooks_prerun.warnOnAvailableUpgrade.html b/docs/api/cli-kit/functions/node_hooks_prerun.warnOnAvailableUpgrade.html index 4a36155f0b..ca9e30d65b 100644 --- a/docs/api/cli-kit/functions/node_hooks_prerun.warnOnAvailableUpgrade.html +++ b/docs/api/cli-kit/functions/node_hooks_prerun.warnOnAvailableUpgrade.html @@ -1,2 +1,2 @@ warnOnAvailableUpgrade | @shopify/cli-kit

      Function warnOnAvailableUpgrade

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_hrtime.endHRTimeInMs.html b/docs/api/cli-kit/functions/node_hrtime.endHRTimeInMs.html index 9012993d70..247ab37c6a 100644 --- a/docs/api/cli-kit/functions/node_hrtime.endHRTimeInMs.html +++ b/docs/api/cli-kit/functions/node_hrtime.endHRTimeInMs.html @@ -1,4 +1,4 @@ endHRTimeInMs | @shopify/cli-kit

      Function endHRTimeInMs

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_hrtime.startHRTime.html b/docs/api/cli-kit/functions/node_hrtime.startHRTime.html index 952ba96f89..dbfd259cc3 100644 --- a/docs/api/cli-kit/functions/node_hrtime.startHRTime.html +++ b/docs/api/cli-kit/functions/node_hrtime.startHRTime.html @@ -1,3 +1,3 @@ startHRTime | @shopify/cli-kit

      Function startHRTime

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_http.downloadFile.html b/docs/api/cli-kit/functions/node_http.downloadFile.html index dc3ec337f3..30d345076d 100644 --- a/docs/api/cli-kit/functions/node_http.downloadFile.html +++ b/docs/api/cli-kit/functions/node_http.downloadFile.html @@ -4,4 +4,4 @@

      Returns Promise<string>

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_http.fetch.html b/docs/api/cli-kit/functions/node_http.fetch.html index 8a1f586eee..f457d8fbe0 100644 --- a/docs/api/cli-kit/functions/node_http.fetch.html +++ b/docs/api/cli-kit/functions/node_http.fetch.html @@ -7,4 +7,4 @@

      Parameters

      Returns Promise<Response>

      A promise that resolves with the response.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_http.formData.html b/docs/api/cli-kit/functions/node_http.formData.html index 3ce908e234..b3c52195bf 100644 --- a/docs/api/cli-kit/functions/node_http.formData.html +++ b/docs/api/cli-kit/functions/node_http.formData.html @@ -1,3 +1,3 @@ formData | @shopify/cli-kit

      Function formData

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_http.shopifyFetch.html b/docs/api/cli-kit/functions/node_http.shopifyFetch.html index b731435e01..3711e6a176 100644 --- a/docs/api/cli-kit/functions/node_http.shopifyFetch.html +++ b/docs/api/cli-kit/functions/node_http.shopifyFetch.html @@ -4,4 +4,4 @@

      Parameters

      Returns Promise<Response>

      A promise that resolves with the response.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_is_global.currentProcessIsGlobal.html b/docs/api/cli-kit/functions/node_is_global.currentProcessIsGlobal.html index 28208a355d..a3d590be0e 100644 --- a/docs/api/cli-kit/functions/node_is_global.currentProcessIsGlobal.html +++ b/docs/api/cli-kit/functions/node_is_global.currentProcessIsGlobal.html @@ -1,4 +1,4 @@ currentProcessIsGlobal | @shopify/cli-kit

      Function currentProcessIsGlobal

      • currentProcessIsGlobal(argv?): boolean

      • Returns true if the current process is running in a global context.

        Parameters

        • argv: string[] = process.argv

          The arguments passed to the process.

        Returns boolean

        true if the current process is running in a global context.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_is_global.inferPackageManagerForGlobalCLI.html b/docs/api/cli-kit/functions/node_is_global.inferPackageManagerForGlobalCLI.html index ca847fd776..a93d200ef5 100644 --- a/docs/api/cli-kit/functions/node_is_global.inferPackageManagerForGlobalCLI.html +++ b/docs/api/cli-kit/functions/node_is_global.inferPackageManagerForGlobalCLI.html @@ -1,4 +1,4 @@ inferPackageManagerForGlobalCLI | @shopify/cli-kit

      Function inferPackageManagerForGlobalCLI

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_is_global.installGlobalCLIPrompt.html b/docs/api/cli-kit/functions/node_is_global.installGlobalCLIPrompt.html index e15525ad33..b1c4b901d5 100644 --- a/docs/api/cli-kit/functions/node_is_global.installGlobalCLIPrompt.html +++ b/docs/api/cli-kit/functions/node_is_global.installGlobalCLIPrompt.html @@ -1,3 +1,3 @@ installGlobalCLIPrompt | @shopify/cli-kit

      Function installGlobalCLIPrompt

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_is_global.installGlobalShopifyCLI.html b/docs/api/cli-kit/functions/node_is_global.installGlobalShopifyCLI.html index b0930accdf..6715434477 100644 --- a/docs/api/cli-kit/functions/node_is_global.installGlobalShopifyCLI.html +++ b/docs/api/cli-kit/functions/node_is_global.installGlobalShopifyCLI.html @@ -1,3 +1,3 @@ installGlobalShopifyCLI | @shopify/cli-kit

      Function installGlobalShopifyCLI

      • installGlobalShopifyCLI(packageManager): Promise<void>

      • Installs the global Shopify CLI, using the provided package manager.

        Parameters

        • packageManager: "yarn" | "npm" | "pnpm" | "bun" | "unknown"

          The package manager to use.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_is_global.isGlobalCLIInstalled.html b/docs/api/cli-kit/functions/node_is_global.isGlobalCLIInstalled.html index 9d3119e35e..60b67b676a 100644 --- a/docs/api/cli-kit/functions/node_is_global.isGlobalCLIInstalled.html +++ b/docs/api/cli-kit/functions/node_is_global.isGlobalCLIInstalled.html @@ -1,3 +1,3 @@ isGlobalCLIInstalled | @shopify/cli-kit

      Function isGlobalCLIInstalled

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_json_schema.jsonSchemaValidate.html b/docs/api/cli-kit/functions/node_json_schema.jsonSchemaValidate.html index 736a0d13e7..23403e350d 100644 --- a/docs/api/cli-kit/functions/node_json_schema.jsonSchemaValidate.html +++ b/docs/api/cli-kit/functions/node_json_schema.jsonSchemaValidate.html @@ -3,4 +3,4 @@

      Parameters

      Returns ParseConfigurationResult<unknown> & {
          rawErrors?: AjvError[];
      }

      The result of the validation. If the state is 'error', the errors will be in a zod-like format.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_json_schema.normaliseJsonSchema.html b/docs/api/cli-kit/functions/node_json_schema.normaliseJsonSchema.html index 7fd3533dbb..710958630c 100644 --- a/docs/api/cli-kit/functions/node_json_schema.normaliseJsonSchema.html +++ b/docs/api/cli-kit/functions/node_json_schema.normaliseJsonSchema.html @@ -2,4 +2,4 @@

      We prefer to not use $ref elements in our schemas, so we inline them; it's easier then to process errors.

      Parameters

      Returns Promise<SchemaObject>

      The normalised JSON schema.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_liquid.recursiveLiquidTemplateCopy.html b/docs/api/cli-kit/functions/node_liquid.recursiveLiquidTemplateCopy.html index 788373806f..bc02676e87 100644 --- a/docs/api/cli-kit/functions/node_liquid.recursiveLiquidTemplateCopy.html +++ b/docs/api/cli-kit/functions/node_liquid.recursiveLiquidTemplateCopy.html @@ -5,4 +5,4 @@

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_liquid.renderLiquidTemplate.html b/docs/api/cli-kit/functions/node_liquid.renderLiquidTemplate.html index 0f9d6b2373..366ab0334e 100644 --- a/docs/api/cli-kit/functions/node_liquid.renderLiquidTemplate.html +++ b/docs/api/cli-kit/functions/node_liquid.renderLiquidTemplate.html @@ -2,4 +2,4 @@

      Parameters

      Returns Promise<string>

      Rendered template.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_logs.createLogsDir.html b/docs/api/cli-kit/functions/node_logs.createLogsDir.html index f2f76cae92..fede40dd22 100644 --- a/docs/api/cli-kit/functions/node_logs.createLogsDir.html +++ b/docs/api/cli-kit/functions/node_logs.createLogsDir.html @@ -1 +1 @@ -createLogsDir | @shopify/cli-kit

      Function createLogsDir

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +createLogsDir | @shopify/cli-kit

      Function createLogsDir

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_logs.getLogsDir.html b/docs/api/cli-kit/functions/node_logs.getLogsDir.html index e6c42b8c6f..f5b0e6806c 100644 --- a/docs/api/cli-kit/functions/node_logs.getLogsDir.html +++ b/docs/api/cli-kit/functions/node_logs.getLogsDir.html @@ -1 +1 @@ -getLogsDir | @shopify/cli-kit

      Function getLogsDir

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +getLogsDir | @shopify/cli-kit

      Function getLogsDir

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_logs.writeLog.html b/docs/api/cli-kit/functions/node_logs.writeLog.html index 91e1dcda7e..c230bb1e8c 100644 --- a/docs/api/cli-kit/functions/node_logs.writeLog.html +++ b/docs/api/cli-kit/functions/node_logs.writeLog.html @@ -1 +1 @@ -writeLog | @shopify/cli-kit

      Function writeLog

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +writeLog | @shopify/cli-kit

      Function writeLog

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_metadata.addPublicMetadata.html b/docs/api/cli-kit/functions/node_metadata.addPublicMetadata.html index 6efa05c35a..e18a49bcfb 100644 --- a/docs/api/cli-kit/functions/node_metadata.addPublicMetadata.html +++ b/docs/api/cli-kit/functions/node_metadata.addPublicMetadata.html @@ -1 +1 @@ -addPublicMetadata | @shopify/cli-kit

      Function addPublicMetadata

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +addPublicMetadata | @shopify/cli-kit

      Function addPublicMetadata

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_metadata.addSensitiveMetadata.html b/docs/api/cli-kit/functions/node_metadata.addSensitiveMetadata.html index c7b0ff0964..229e91218d 100644 --- a/docs/api/cli-kit/functions/node_metadata.addSensitiveMetadata.html +++ b/docs/api/cli-kit/functions/node_metadata.addSensitiveMetadata.html @@ -1 +1 @@ -addSensitiveMetadata | @shopify/cli-kit

      Function addSensitiveMetadata

      • addSensitiveMetadata(getData, onError?): Promise<void>

      • Parameters

        • getData: ProvideMetadata<{
              commandStartOptions: {
                  startArgs: string[];
                  startCommand: string;
                  startTime: number;
                  startTopic?: string;
              };
          } & {
              environmentFlags: string;
          }>
        • Optional onError: MetadataErrorHandling

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +addSensitiveMetadata | @shopify/cli-kit

      Function addSensitiveMetadata

      • addSensitiveMetadata(getData, onError?): Promise<void>

      • Parameters

        • getData: ProvideMetadata<{
              commandStartOptions: {
                  startArgs: string[];
                  startCommand: string;
                  startTime: number;
                  startTopic?: string;
              };
          } & {
              environmentFlags: string;
          }>
        • Optional onError: MetadataErrorHandling

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_metadata.createRuntimeMetadataContainer.html b/docs/api/cli-kit/functions/node_metadata.createRuntimeMetadataContainer.html index b3bb40ef90..40bf10b1b5 100644 --- a/docs/api/cli-kit/functions/node_metadata.createRuntimeMetadataContainer.html +++ b/docs/api/cli-kit/functions/node_metadata.createRuntimeMetadataContainer.html @@ -2,4 +2,4 @@ The container provides async-safe functions for extracting the gathered metadata, and for setting it.

      Type Parameters

      Parameters

      Returns RuntimeMetadataManager<TPublic, TSensitive>

      A container for the metadata.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_metadata.getAllPublicMetadata.html b/docs/api/cli-kit/functions/node_metadata.getAllPublicMetadata.html index ff94b65e47..2ee1ea1a84 100644 --- a/docs/api/cli-kit/functions/node_metadata.getAllPublicMetadata.html +++ b/docs/api/cli-kit/functions/node_metadata.getAllPublicMetadata.html @@ -1 +1 @@ -getAllPublicMetadata | @shopify/cli-kit

      Function getAllPublicMetadata

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +getAllPublicMetadata | @shopify/cli-kit

      Function getAllPublicMetadata

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_metadata.getAllSensitiveMetadata.html b/docs/api/cli-kit/functions/node_metadata.getAllSensitiveMetadata.html index 20ee60cdfe..ab7a36ea61 100644 --- a/docs/api/cli-kit/functions/node_metadata.getAllSensitiveMetadata.html +++ b/docs/api/cli-kit/functions/node_metadata.getAllSensitiveMetadata.html @@ -1 +1 @@ -getAllSensitiveMetadata | @shopify/cli-kit

      Function getAllSensitiveMetadata

      • getAllSensitiveMetadata(): Partial<{
            commandStartOptions: {
                startArgs: string[];
                startCommand: string;
                startTime: number;
                startTopic?: string;
            };
        } & {
            environmentFlags: string;
        }>

      • Returns Partial<{
            commandStartOptions: {
                startArgs: string[];
                startCommand: string;
                startTime: number;
                startTopic?: string;
            };
        } & {
            environmentFlags: string;
        }>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +getAllSensitiveMetadata | @shopify/cli-kit

      Function getAllSensitiveMetadata

      • getAllSensitiveMetadata(): Partial<{
            commandStartOptions: {
                startArgs: string[];
                startCommand: string;
                startTime: number;
                startTopic?: string;
            };
        } & {
            environmentFlags: string;
        }>

      • Returns Partial<{
            commandStartOptions: {
                startArgs: string[];
                startCommand: string;
                startTime: number;
                startTopic?: string;
            };
        } & {
            environmentFlags: string;
        }>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_metadata.runWithTimer.html b/docs/api/cli-kit/functions/node_metadata.runWithTimer.html index 0626e0d34d..20def3ddb2 100644 --- a/docs/api/cli-kit/functions/node_metadata.runWithTimer.html +++ b/docs/api/cli-kit/functions/node_metadata.runWithTimer.html @@ -1 +1 @@ -runWithTimer | @shopify/cli-kit

      Function runWithTimer

      • runWithTimer(field): (<T>(fn) => Promise<T>)

      • Parameters

        • field: NumericKeyOf<CmdFieldsFromMonorail>

        Returns (<T>(fn) => Promise<T>)

          • <T>(fn): Promise<T>

          • Type Parameters

            • T

            Parameters

            • fn: (() => Promise<T>)
                • (): Promise<T>

                • Returns Promise<T>

            Returns Promise<T>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +runWithTimer | @shopify/cli-kit

      Function runWithTimer

      • runWithTimer(field): (<T>(fn) => Promise<T>)

      • Parameters

        • field: NumericKeyOf<CmdFieldsFromMonorail>

        Returns (<T>(fn) => Promise<T>)

          • <T>(fn): Promise<T>

          • Type Parameters

            • T

            Parameters

            • fn: (() => Promise<T>)
                • (): Promise<T>

                • Returns Promise<T>

            Returns Promise<T>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_mimes.lookupMimeType.html b/docs/api/cli-kit/functions/node_mimes.lookupMimeType.html index f857c27a89..5a12717b4f 100644 --- a/docs/api/cli-kit/functions/node_mimes.lookupMimeType.html +++ b/docs/api/cli-kit/functions/node_mimes.lookupMimeType.html @@ -1,4 +1,4 @@ lookupMimeType | @shopify/cli-kit

      Function lookupMimeType

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_mimes.setMimeTypes.html b/docs/api/cli-kit/functions/node_mimes.setMimeTypes.html index 95201ac9be..014f8c3874 100644 --- a/docs/api/cli-kit/functions/node_mimes.setMimeTypes.html +++ b/docs/api/cli-kit/functions/node_mimes.setMimeTypes.html @@ -1,3 +1,3 @@ setMimeTypes | @shopify/cli-kit

      Function setMimeTypes

      • setMimeTypes(newTypes): void

      • Adds MIME type(s) to the dictionary.

        Parameters

        • newTypes: {
              [key: string]: string;
          }

          Object of key-values where key is extension and value is mime type.

          -
          • [key: string]: string

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_monorail.publishMonorailEvent.html b/docs/api/cli-kit/functions/node_monorail.publishMonorailEvent.html index cbd64b5a43..cdcaf81858 100644 --- a/docs/api/cli-kit/functions/node_monorail.publishMonorailEvent.html +++ b/docs/api/cli-kit/functions/node_monorail.publishMonorailEvent.html @@ -3,4 +3,4 @@
    • publicData: TPayload["public"]

      The public data to publish.

    • sensitiveData: TPayload["sensitive"]

      The sensitive data to publish.

      • Returns Promise<MonorailResult>

      A result indicating whether the event was successfully published.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependencies.html b/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependencies.html index 774d4c368f..40005fd363 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependencies.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependencies.html @@ -1 +1 @@ -addNPMDependencies | @shopify/cli-kit

      Function addNPMDependencies

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +addNPMDependencies | @shopify/cli-kit

      Function addNPMDependencies

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependenciesIfNeeded.html b/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependenciesIfNeeded.html index 4405773afa..3bfebc8fd8 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependenciesIfNeeded.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependenciesIfNeeded.html @@ -1,4 +1,4 @@ addNPMDependenciesIfNeeded | @shopify/cli-kit

      Function addNPMDependenciesIfNeeded

      • addNPMDependenciesIfNeeded(dependencies, options): Promise<void>

      • Adds dependencies to a Node project (i.e. a project that has a package.json)

        Parameters

        • dependencies: DependencyVersion[]

          List of dependencies to be added.

        • options: AddNPMDependenciesIfNeededOptions

          Options for adding dependencies.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependenciesWithoutVersionIfNeeded.html b/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependenciesWithoutVersionIfNeeded.html index 7fed540473..abd3dacaf2 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependenciesWithoutVersionIfNeeded.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.addNPMDependenciesWithoutVersionIfNeeded.html @@ -1 +1 @@ -addNPMDependenciesWithoutVersionIfNeeded | @shopify/cli-kit

      Function addNPMDependenciesWithoutVersionIfNeeded

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +addNPMDependenciesWithoutVersionIfNeeded | @shopify/cli-kit

      Function addNPMDependenciesWithoutVersionIfNeeded

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.addResolutionOrOverride.html b/docs/api/cli-kit/functions/node_node_package_manager.addResolutionOrOverride.html index 51746a3232..f1a5e21c97 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.addResolutionOrOverride.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.addResolutionOrOverride.html @@ -1 +1 @@ -addResolutionOrOverride | @shopify/cli-kit

      Function addResolutionOrOverride

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +addResolutionOrOverride | @shopify/cli-kit

      Function addResolutionOrOverride

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.checkForCachedNewVersion.html b/docs/api/cli-kit/functions/node_node_package_manager.checkForCachedNewVersion.html index ab1d209df4..38f8802335 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.checkForCachedNewVersion.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.checkForCachedNewVersion.html @@ -2,4 +2,4 @@

      Parameters

      Returns string | undefined

      A more recent version or undefined if there's no more recent version.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.checkForNewVersion.html b/docs/api/cli-kit/functions/node_node_package_manager.checkForNewVersion.html index 3bea1d4e5c..112f7cb877 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.checkForNewVersion.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.checkForNewVersion.html @@ -4,4 +4,4 @@
    • cacheExpiryInHours: {
          cacheExpiryInHours: undefined | number;
      } = {}

      If the last check was done more than this amount of hours ago, it will refresh the cache. Defaults to always refreshing.

      • Returns Promise<string | undefined>

      A promise that resolves with a more recent version or undefined if there's no more recent version.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.findUpAndReadPackageJson.html b/docs/api/cli-kit/functions/node_node_package_manager.findUpAndReadPackageJson.html index 683810b458..6c5f019779 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.findUpAndReadPackageJson.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.findUpAndReadPackageJson.html @@ -2,4 +2,4 @@ decodes the JSON, and returns its content as a Javascript object.

      Parameters

      Returns Promise<{
          content: PackageJson;
          path: string;
      }>

      If found, the promise resolves with the path to the package.json and its content. If not found, it throws a FindUpAndReadPackageJsonNotFoundError error.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.getDependencies.html b/docs/api/cli-kit/functions/node_node_package_manager.getDependencies.html index 41b5d4d765..35a80d8079 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.getDependencies.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.getDependencies.html @@ -1,4 +1,4 @@ getDependencies | @shopify/cli-kit

      Function getDependencies

      • getDependencies(packageJsonPath): Promise<{
            [key: string]: string;
        }>

      • Returns the list of production and dev dependencies of a package.json

        Parameters

        • packageJsonPath: string

          Path to the package.json file

        Returns Promise<{
            [key: string]: string;
        }>

        A promise that resolves with the list of dependencies.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.getPackageManager.html b/docs/api/cli-kit/functions/node_node_package_manager.getPackageManager.html index 2e6ba22bd9..0f93db05ee 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.getPackageManager.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.getPackageManager.html @@ -1,4 +1,4 @@ getPackageManager | @shopify/cli-kit

      Function getPackageManager

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.getPackageName.html b/docs/api/cli-kit/functions/node_node_package_manager.getPackageName.html index df997b5281..e1168e228a 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.getPackageName.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.getPackageName.html @@ -1,4 +1,4 @@ getPackageName | @shopify/cli-kit

      Function getPackageName

      • getPackageName(packageJsonPath): Promise<string | undefined>

      • Returns the name of the package configured in its package.json

        Parameters

        • packageJsonPath: string

          Path to the package.json file

        Returns Promise<string | undefined>

        A promise that resolves with the name.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.getPackageVersion.html b/docs/api/cli-kit/functions/node_node_package_manager.getPackageVersion.html index 386d1d035e..408b0e2467 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.getPackageVersion.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.getPackageVersion.html @@ -1,4 +1,4 @@ getPackageVersion | @shopify/cli-kit

      Function getPackageVersion

      • getPackageVersion(packageJsonPath): Promise<string | undefined>

      • Returns the version of the package configured in its package.json

        Parameters

        • packageJsonPath: string

          Path to the package.json file

        Returns Promise<string | undefined>

        A promise that resolves with the version.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.installNPMDependenciesRecursively.html b/docs/api/cli-kit/functions/node_node_package_manager.installNPMDependenciesRecursively.html index a0e386736c..a53374b42a 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.installNPMDependenciesRecursively.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.installNPMDependenciesRecursively.html @@ -2,4 +2,4 @@ and installs the dependencies if needed. To know if it's needed, it uses the "check" command provided by dependency managers.

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.installNodeModules.html b/docs/api/cli-kit/functions/node_node_package_manager.installNodeModules.html index 2b21747321..c941379cbe 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.installNodeModules.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.installNodeModules.html @@ -1 +1 @@ -installNodeModules | @shopify/cli-kit

      Function installNodeModules

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +installNodeModules | @shopify/cli-kit

      Function installNodeModules

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.packageManagerFromUserAgent.html b/docs/api/cli-kit/functions/node_node_package_manager.packageManagerFromUserAgent.html index 5244c70084..31bd0593d2 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.packageManagerFromUserAgent.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.packageManagerFromUserAgent.html @@ -1,4 +1,4 @@ packageManagerFromUserAgent | @shopify/cli-kit

      Function packageManagerFromUserAgent

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.readAndParsePackageJson.html b/docs/api/cli-kit/functions/node_node_package_manager.readAndParsePackageJson.html index 12bcdcc87e..44d3be4e0d 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.readAndParsePackageJson.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.readAndParsePackageJson.html @@ -3,4 +3,4 @@

      Returns Promise<PackageJson>

      An promise that resolves with an in-memory representation of the package.json or rejects with an error if the file is not found or the content is not decodable.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.usesWorkspaces.html b/docs/api/cli-kit/functions/node_node_package_manager.usesWorkspaces.html index 9452c8b00a..ce0c095a7b 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.usesWorkspaces.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.usesWorkspaces.html @@ -1,3 +1,3 @@ usesWorkspaces | @shopify/cli-kit

      Function usesWorkspaces

      • usesWorkspaces(appDirectory): Promise<boolean>

      • Returns true if the app uses workspaces, false otherwise.

        Parameters

        • appDirectory: string

        Returns Promise<boolean>

        A promise that resolves with true if the app uses workspaces, false otherwise.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.versionSatisfies.html b/docs/api/cli-kit/functions/node_node_package_manager.versionSatisfies.html index ef581b2924..ddb464f75c 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.versionSatisfies.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.versionSatisfies.html @@ -2,4 +2,4 @@

      Parameters

      Returns boolean

      A boolean indicating whether the version satisfies the requirements

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_node_package_manager.writePackageJSON.html b/docs/api/cli-kit/functions/node_node_package_manager.writePackageJSON.html index 3a5091a9e0..dd9f4a85a6 100644 --- a/docs/api/cli-kit/functions/node_node_package_manager.writePackageJSON.html +++ b/docs/api/cli-kit/functions/node_node_package_manager.writePackageJSON.html @@ -1,4 +1,4 @@ writePackageJSON | @shopify/cli-kit

      Function writePackageJSON

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_os.platformAndArch.html b/docs/api/cli-kit/functions/node_os.platformAndArch.html index 4d4a3144b7..f4537eef5d 100644 --- a/docs/api/cli-kit/functions/node_os.platformAndArch.html +++ b/docs/api/cli-kit/functions/node_os.platformAndArch.html @@ -1,3 +1,3 @@ platformAndArch | @shopify/cli-kit

      Function platformAndArch

      • platformAndArch(platform?, arch?): {
            arch: PlatformArch;
            platform: PlatformStrings;
        }

      • Returns the platform and architecture.

        Parameters

        • platform: Platform = process.platform
        • arch: Architecture = process.arch

        Returns {
            arch: PlatformArch;
            platform: PlatformStrings;
        }

        Returns the current platform and architecture.

        -
        • arch: PlatformArch
        • platform: PlatformStrings

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_os.username.html b/docs/api/cli-kit/functions/node_os.username.html index a5dec805a2..4c2da1dcd0 100644 --- a/docs/api/cli-kit/functions/node_os.username.html +++ b/docs/api/cli-kit/functions/node_os.username.html @@ -1,3 +1,3 @@ username | @shopify/cli-kit

      Function username

      • username(platform?): Promise<string | null>

      • Parameters

        • platform: Platform = process.platform

          The platform to get the username for. Defaults to the current platform.

        Returns Promise<string | null>

        The username of the current user.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.clearCollectedLogs.html b/docs/api/cli-kit/functions/node_output.clearCollectedLogs.html index 4668111aa1..1d07bdb4d4 100644 --- a/docs/api/cli-kit/functions/node_output.clearCollectedLogs.html +++ b/docs/api/cli-kit/functions/node_output.clearCollectedLogs.html @@ -1 +1 @@ -clearCollectedLogs | @shopify/cli-kit

      Function clearCollectedLogs

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +clearCollectedLogs | @shopify/cli-kit

      Function clearCollectedLogs

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.collectLog.html b/docs/api/cli-kit/functions/node_output.collectLog.html index e2d3eddbd1..670d318dc5 100644 --- a/docs/api/cli-kit/functions/node_output.collectLog.html +++ b/docs/api/cli-kit/functions/node_output.collectLog.html @@ -3,4 +3,4 @@ we will store them in a variable that can be accessed from the tests.

      Parameters

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.consoleError.html b/docs/api/cli-kit/functions/node_output.consoleError.html index aef298ed8a..1b92b8107b 100644 --- a/docs/api/cli-kit/functions/node_output.consoleError.html +++ b/docs/api/cli-kit/functions/node_output.consoleError.html @@ -1,3 +1,3 @@ consoleError | @shopify/cli-kit

      Function consoleError

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.consoleLog.html b/docs/api/cli-kit/functions/node_output.consoleLog.html index e238ed89c9..ff9ac48ca6 100644 --- a/docs/api/cli-kit/functions/node_output.consoleLog.html +++ b/docs/api/cli-kit/functions/node_output.consoleLog.html @@ -1,3 +1,3 @@ consoleLog | @shopify/cli-kit

      Function consoleLog

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.consoleWarn.html b/docs/api/cli-kit/functions/node_output.consoleWarn.html index 1fed9e9da8..b7ba5cc8aa 100644 --- a/docs/api/cli-kit/functions/node_output.consoleWarn.html +++ b/docs/api/cli-kit/functions/node_output.consoleWarn.html @@ -1,3 +1,3 @@ consoleWarn | @shopify/cli-kit

      Function consoleWarn

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.formatPackageManagerCommand.html b/docs/api/cli-kit/functions/node_output.formatPackageManagerCommand.html index d3db2bfbc3..b6a4e4f385 100644 --- a/docs/api/cli-kit/functions/node_output.formatPackageManagerCommand.html +++ b/docs/api/cli-kit/functions/node_output.formatPackageManagerCommand.html @@ -3,4 +3,4 @@
    • scriptName: string

      The name of the script to run.

    • Rest ...scriptArgs: string[]

      The arguments to pass to the script.

      • Returns string

      The formatted command.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.formatSection.html b/docs/api/cli-kit/functions/node_output.formatSection.html index ac2c6b6ef0..0dfd867963 100644 --- a/docs/api/cli-kit/functions/node_output.formatSection.html +++ b/docs/api/cli-kit/functions/node_output.formatSection.html @@ -2,4 +2,4 @@

      Parameters

      Returns string

      The formatted message.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.itemToString.html b/docs/api/cli-kit/functions/node_output.itemToString.html index a40584387d..fbac5df74d 100644 --- a/docs/api/cli-kit/functions/node_output.itemToString.html +++ b/docs/api/cli-kit/functions/node_output.itemToString.html @@ -1,4 +1,4 @@ itemToString | @shopify/cli-kit

      Function itemToString

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.outputCompleted.html b/docs/api/cli-kit/functions/node_output.outputCompleted.html index 986419c322..8f1cb3e088 100644 --- a/docs/api/cli-kit/functions/node_output.outputCompleted.html +++ b/docs/api/cli-kit/functions/node_output.outputCompleted.html @@ -3,4 +3,4 @@ Note: Completed messages are sent through the standard output.

      Parameters

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.outputContent.html b/docs/api/cli-kit/functions/node_output.outputContent.html index 85d7612505..8df9a21ea1 100644 --- a/docs/api/cli-kit/functions/node_output.outputContent.html +++ b/docs/api/cli-kit/functions/node_output.outputContent.html @@ -2,4 +2,4 @@

      Parameters

      Returns TokenizedString

      The tokenized string.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.outputDebug.html b/docs/api/cli-kit/functions/node_output.outputDebug.html index 055b981236..5d7fd2d743 100644 --- a/docs/api/cli-kit/functions/node_output.outputDebug.html +++ b/docs/api/cli-kit/functions/node_output.outputDebug.html @@ -3,4 +3,4 @@ Note: Debug messages are sent through the standard output.

      Parameters

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.outputInfo.html b/docs/api/cli-kit/functions/node_output.outputInfo.html index c9c8e158f1..761cec12ea 100644 --- a/docs/api/cli-kit/functions/node_output.outputInfo.html +++ b/docs/api/cli-kit/functions/node_output.outputInfo.html @@ -3,4 +3,4 @@ Note: Info messages are sent through the standard output.

      Parameters

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.outputNewline.html b/docs/api/cli-kit/functions/node_output.outputNewline.html index 37806e56dd..ac74a4ce7f 100644 --- a/docs/api/cli-kit/functions/node_output.outputNewline.html +++ b/docs/api/cli-kit/functions/node_output.outputNewline.html @@ -1,2 +1,2 @@ outputNewline | @shopify/cli-kit

      Function outputNewline

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.outputSuccess.html b/docs/api/cli-kit/functions/node_output.outputSuccess.html index 984ee5bf4c..2f62d1c1c1 100644 --- a/docs/api/cli-kit/functions/node_output.outputSuccess.html +++ b/docs/api/cli-kit/functions/node_output.outputSuccess.html @@ -3,4 +3,4 @@ Note: Success messages are sent through the standard output.

      Parameters

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.outputWarn.html b/docs/api/cli-kit/functions/node_output.outputWarn.html index 0359aed62b..9a723ecd0b 100644 --- a/docs/api/cli-kit/functions/node_output.outputWarn.html +++ b/docs/api/cli-kit/functions/node_output.outputWarn.html @@ -3,4 +3,4 @@ Note: Warning messages are sent through the standard output.

      Parameters

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.outputWhereAppropriate.html b/docs/api/cli-kit/functions/node_output.outputWhereAppropriate.html index 79e80f7591..7fd0cb62d3 100644 --- a/docs/api/cli-kit/functions/node_output.outputWhereAppropriate.html +++ b/docs/api/cli-kit/functions/node_output.outputWhereAppropriate.html @@ -3,4 +3,4 @@
    • logger: Logger

      The logger to use to output the message.

    • message: string

      The message to output.

    • options: OutputWhereAppropriateOptions = ...

      Additional options.

      -

      • Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.shouldDisplayColors.html b/docs/api/cli-kit/functions/node_output.shouldDisplayColors.html index beccb0121f..066a7c240a 100644 --- a/docs/api/cli-kit/functions/node_output.shouldDisplayColors.html +++ b/docs/api/cli-kit/functions/node_output.shouldDisplayColors.html @@ -1,4 +1,4 @@ shouldDisplayColors | @shopify/cli-kit

      Function shouldDisplayColors

      • shouldDisplayColors(_process?): boolean

      • Checks if the console outputs should display colors or not.

        Parameters

        • _process: Process = process

          Optional, the process-like object to use to check if the console should display colors. Defaults to the global process.

        Returns boolean

        True if the console outputs should display colors, false otherwise.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.stringifyMessage.html b/docs/api/cli-kit/functions/node_output.stringifyMessage.html index 1cd3b43528..5ef1e578aa 100644 --- a/docs/api/cli-kit/functions/node_output.stringifyMessage.html +++ b/docs/api/cli-kit/functions/node_output.stringifyMessage.html @@ -1,4 +1,4 @@ stringifyMessage | @shopify/cli-kit

      Function stringifyMessage

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.unstyled.html b/docs/api/cli-kit/functions/node_output.unstyled.html index 0aa767e0b5..b4c00745a2 100644 --- a/docs/api/cli-kit/functions/node_output.unstyled.html +++ b/docs/api/cli-kit/functions/node_output.unstyled.html @@ -1,4 +1,4 @@ unstyled | @shopify/cli-kit

      Function unstyled

      • unstyled(message): string

      • Returns a message without styles (colors or any ANSI escape codes).

        Parameters

        • message: string

          The message to remove styles from.

        Returns string

        The message without styles.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.basename.html b/docs/api/cli-kit/functions/node_path.basename.html index b1f5c876fa..fde7f87b8c 100644 --- a/docs/api/cli-kit/functions/node_path.basename.html +++ b/docs/api/cli-kit/functions/node_path.basename.html @@ -2,4 +2,4 @@

      Parameters

      Returns string

      Base name.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.cwd.html b/docs/api/cli-kit/functions/node_path.cwd.html index 5cae3cb152..6a852e3f61 100644 --- a/docs/api/cli-kit/functions/node_path.cwd.html +++ b/docs/api/cli-kit/functions/node_path.cwd.html @@ -4,4 +4,4 @@ process.cwd() to that folder, while the actual path is stored in the INIT_CWD environment variable (see here: https://docs.npmjs.com/cli/v9/commands/npm-run-script#description).

      Returns string

      The path to the current working directory.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.dirname.html b/docs/api/cli-kit/functions/node_path.dirname.html index 1e8d10206d..e93c446d9e 100644 --- a/docs/api/cli-kit/functions/node_path.dirname.html +++ b/docs/api/cli-kit/functions/node_path.dirname.html @@ -1,4 +1,4 @@ dirname | @shopify/cli-kit

      Function dirname

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.extname.html b/docs/api/cli-kit/functions/node_path.extname.html index 8290417005..9a83834f46 100644 --- a/docs/api/cli-kit/functions/node_path.extname.html +++ b/docs/api/cli-kit/functions/node_path.extname.html @@ -1,4 +1,4 @@ extname | @shopify/cli-kit

      Function extname

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.isAbsolutePath.html b/docs/api/cli-kit/functions/node_path.isAbsolutePath.html index a951621f32..ca3d85aa4f 100644 --- a/docs/api/cli-kit/functions/node_path.isAbsolutePath.html +++ b/docs/api/cli-kit/functions/node_path.isAbsolutePath.html @@ -1,4 +1,4 @@ isAbsolutePath | @shopify/cli-kit

      Function isAbsolutePath

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.isSubpath.html b/docs/api/cli-kit/functions/node_path.isSubpath.html index 9e87761a8d..babcc8c781 100644 --- a/docs/api/cli-kit/functions/node_path.isSubpath.html +++ b/docs/api/cli-kit/functions/node_path.isSubpath.html @@ -2,4 +2,4 @@

      Parameters

      Returns boolean

      Whether the subpath is a subpath of the main path.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.joinPath.html b/docs/api/cli-kit/functions/node_path.joinPath.html index bd126a87e1..c83902fe59 100644 --- a/docs/api/cli-kit/functions/node_path.joinPath.html +++ b/docs/api/cli-kit/functions/node_path.joinPath.html @@ -1,4 +1,4 @@ joinPath | @shopify/cli-kit

      Function joinPath

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.moduleDirectory.html b/docs/api/cli-kit/functions/node_path.moduleDirectory.html index 79a88138cd..2b50c4d757 100644 --- a/docs/api/cli-kit/functions/node_path.moduleDirectory.html +++ b/docs/api/cli-kit/functions/node_path.moduleDirectory.html @@ -1,4 +1,4 @@ moduleDirectory | @shopify/cli-kit

      Function moduleDirectory

      • moduleDirectory(moduleURL): string

      • Given a module's import.meta.url it returns the directory containing the module.

        Parameters

        • moduleURL: string | URL

          The value of import.meta.url in the context of the caller module.

        Returns string

        The path to the directory containing the caller module.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.normalizePath.html b/docs/api/cli-kit/functions/node_path.normalizePath.html index 887cc2d88b..7a6f32f006 100644 --- a/docs/api/cli-kit/functions/node_path.normalizePath.html +++ b/docs/api/cli-kit/functions/node_path.normalizePath.html @@ -1,4 +1,4 @@ normalizePath | @shopify/cli-kit

      Function normalizePath

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.relativePath.html b/docs/api/cli-kit/functions/node_path.relativePath.html index c1dbf54ffb..4c82583126 100644 --- a/docs/api/cli-kit/functions/node_path.relativePath.html +++ b/docs/api/cli-kit/functions/node_path.relativePath.html @@ -2,4 +2,4 @@

      Parameters

      Returns string

      Relative path.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.relativizePath.html b/docs/api/cli-kit/functions/node_path.relativizePath.html index 8b8c8e6ecd..3036d5b891 100644 --- a/docs/api/cli-kit/functions/node_path.relativizePath.html +++ b/docs/api/cli-kit/functions/node_path.relativizePath.html @@ -5,4 +5,4 @@

      Parameters

      Returns string

      Relativized path.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.resolvePath.html b/docs/api/cli-kit/functions/node_path.resolvePath.html index 39e63b72e4..286b6c2f77 100644 --- a/docs/api/cli-kit/functions/node_path.resolvePath.html +++ b/docs/api/cli-kit/functions/node_path.resolvePath.html @@ -1,4 +1,4 @@ resolvePath | @shopify/cli-kit

      Function resolvePath

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.sniffForJson.html b/docs/api/cli-kit/functions/node_path.sniffForJson.html index 70ac4cf6e4..a133090b4a 100644 --- a/docs/api/cli-kit/functions/node_path.sniffForJson.html +++ b/docs/api/cli-kit/functions/node_path.sniffForJson.html @@ -1,4 +1,4 @@ sniffForJson | @shopify/cli-kit

      Function sniffForJson

      • sniffForJson(argv?): boolean

      • Returns whether the --json flag is present in the arguments.

        Parameters

        • argv: string[] = process.argv

          The arguments to search for the --json flag.

        Returns boolean

        Whether the --json flag is present in the arguments.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_path.sniffForPath.html b/docs/api/cli-kit/functions/node_path.sniffForPath.html index ba017d1ffe..2e03d634cd 100644 --- a/docs/api/cli-kit/functions/node_path.sniffForPath.html +++ b/docs/api/cli-kit/functions/node_path.sniffForPath.html @@ -1,4 +1,4 @@ sniffForPath | @shopify/cli-kit

      Function sniffForPath

      • sniffForPath(argv?): string | undefined

      • Tries to get the value of the --path argument, if provided.

        Parameters

        • argv: string[] = process.argv

          The arguments to search for the --path argument.

        Returns string | undefined

        The value of the --path argument, if provided.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_plugins.fanoutHooks.html b/docs/api/cli-kit/functions/node_plugins.fanoutHooks.html index 6c1dc1c7f9..0c9fcaf313 100644 --- a/docs/api/cli-kit/functions/node_plugins.fanoutHooks.html +++ b/docs/api/cli-kit/functions/node_plugins.fanoutHooks.html @@ -6,4 +6,4 @@
    • options: TPluginMap[TEvent]["options"]

      The options to pass to the hook.

    • Optional timeout: number

      The timeout to use for the hook.

      • Returns Promise<Partial<TPluginMap[typeof event]["pluginReturns"]>>

      A dictionary of plug-in names to the response from the hook.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_plugins.getListOfTunnelPlugins.html b/docs/api/cli-kit/functions/node_plugins.getListOfTunnelPlugins.html index 0e6355255f..527a129bec 100644 --- a/docs/api/cli-kit/functions/node_plugins.getListOfTunnelPlugins.html +++ b/docs/api/cli-kit/functions/node_plugins.getListOfTunnelPlugins.html @@ -2,4 +2,4 @@ Fail if there are multiple plugins for the same provider.

      Parameters

      Returns Promise<{
          error?: string;
          plugins: string[];
      }>

      List of available tunnel plugins.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_plugins_tunnel.defineProvider.html b/docs/api/cli-kit/functions/node_plugins_tunnel.defineProvider.html index 5cae7f0bbb..a6788bb4ca 100644 --- a/docs/api/cli-kit/functions/node_plugins_tunnel.defineProvider.html +++ b/docs/api/cli-kit/functions/node_plugins_tunnel.defineProvider.html @@ -1 +1 @@ -defineProvider | @shopify/cli-kit

      Function defineProvider

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +defineProvider | @shopify/cli-kit

      Function defineProvider

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_plugins_tunnel.startTunnel.html b/docs/api/cli-kit/functions/node_plugins_tunnel.startTunnel.html index c37fc04cfa..1747535023 100644 --- a/docs/api/cli-kit/functions/node_plugins_tunnel.startTunnel.html +++ b/docs/api/cli-kit/functions/node_plugins_tunnel.startTunnel.html @@ -1 +1 @@ -startTunnel | @shopify/cli-kit

      Function startTunnel

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +startTunnel | @shopify/cli-kit

      Function startTunnel

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_promises.flushPromises.html b/docs/api/cli-kit/functions/node_promises.flushPromises.html index 1dcaa3fb1d..08e5088c7f 100644 --- a/docs/api/cli-kit/functions/node_promises.flushPromises.html +++ b/docs/api/cli-kit/functions/node_promises.flushPromises.html @@ -1,3 +1,3 @@ flushPromises | @shopify/cli-kit

      Function flushPromises

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_result.err-1.html b/docs/api/cli-kit/functions/node_result.err-1.html index 0592aebbb9..bbdbe4e08a 100644 --- a/docs/api/cli-kit/functions/node_result.err-1.html +++ b/docs/api/cli-kit/functions/node_result.err-1.html @@ -1,4 +1,4 @@ err | @shopify/cli-kit

      Function err

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_result.ok-1.html b/docs/api/cli-kit/functions/node_result.ok-1.html index 9bf6ddcce8..db21fe5c68 100644 --- a/docs/api/cli-kit/functions/node_result.ok-1.html +++ b/docs/api/cli-kit/functions/node_result.ok-1.html @@ -1,4 +1,4 @@ ok | @shopify/cli-kit

      Function ok

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ruby.bundleUserHome.html b/docs/api/cli-kit/functions/node_ruby.bundleUserHome.html index c4799fedae..aefbae8771 100644 --- a/docs/api/cli-kit/functions/node_ruby.bundleUserHome.html +++ b/docs/api/cli-kit/functions/node_ruby.bundleUserHome.html @@ -1,4 +1,4 @@ bundleUserHome | @shopify/cli-kit

      Function bundleUserHome

      • bundleUserHome(): string | undefined

      • It returns a custom BUNDLE_USER_HOME. This is required in Windows because bundler will instead crash if the username contains UTF-8 characters.

        Returns string | undefined

        The value of the environment variable.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ruby.execCLI2.html b/docs/api/cli-kit/functions/node_ruby.execCLI2.html index 9d3e136565..a207c0fc04 100644 --- a/docs/api/cli-kit/functions/node_ruby.execCLI2.html +++ b/docs/api/cli-kit/functions/node_ruby.execCLI2.html @@ -3,4 +3,4 @@ User must have a valid ruby+bundler environment to run any command.

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ruby.version.html b/docs/api/cli-kit/functions/node_ruby.version.html index cf0bf7a8bc..c5838351c6 100644 --- a/docs/api/cli-kit/functions/node_ruby.version.html +++ b/docs/api/cli-kit/functions/node_ruby.version.html @@ -1,3 +1,3 @@ version | @shopify/cli-kit

      Function version

      • version(): Promise<string | undefined>

      • It returns the Ruby version present in the envirronment.

        Returns Promise<string | undefined>

        The Ruby version, or undefined if it is not found.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_schema.deepStrict.html b/docs/api/cli-kit/functions/node_schema.deepStrict.html index af5287747c..ddc8085210 100644 --- a/docs/api/cli-kit/functions/node_schema.deepStrict.html +++ b/docs/api/cli-kit/functions/node_schema.deepStrict.html @@ -1,4 +1,4 @@ deepStrict | @shopify/cli-kit

      Function deepStrict

      • deepStrict<T>(schema): T

      • Returns a new schema that is the same as the input schema, but with all nested schemas set to strict.

        Type Parameters

        • T

        Parameters

        • schema: T

          The schema to make strict.

        Returns T

        The result strict schema.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_schema.errorsToString.html b/docs/api/cli-kit/functions/node_schema.errorsToString.html index ed7c1100a3..973f5a61db 100644 --- a/docs/api/cli-kit/functions/node_schema.errorsToString.html +++ b/docs/api/cli-kit/functions/node_schema.errorsToString.html @@ -1,4 +1,4 @@ errorsToString | @shopify/cli-kit

      Function errorsToString

      • errorsToString(errors): string

      • Returns a human-readable string of the list of zod errors.

        Parameters

        • errors: ZodIssueBase[]

          The list of zod errors.

        Returns string

        The human-readable string.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedAdmin.html b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedAdmin.html index 510f36e110..1d892dac78 100644 --- a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedAdmin.html +++ b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedAdmin.html @@ -4,4 +4,4 @@
    • forceRefresh: boolean = false

      Optional flag to force a refresh of the token.

    • options: EnsureAuthenticatedAdditionalOptions = {}

      Optional extra options to use.

      • Returns Promise<AdminSession>

      The access token for the Admin API.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedAppManagement.html b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedAppManagement.html index eee7789222..d84b431dfb 100644 --- a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedAppManagement.html +++ b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedAppManagement.html @@ -3,4 +3,4 @@
    • env: ProcessEnv = process.env

      Optional environment variables to use.

    • options: EnsureAuthenticatedAdditionalOptions = {}

      Optional extra options to use.

      • Returns Promise<{
          token: string;
          userId: string;
      }>

      The access token for the App Management API.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedBusinessPlatform.html b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedBusinessPlatform.html index 3f9c91c482..1dfc2fc36d 100644 --- a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedBusinessPlatform.html +++ b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedBusinessPlatform.html @@ -1,4 +1,4 @@ ensureAuthenticatedBusinessPlatform | @shopify/cli-kit

      Function ensureAuthenticatedBusinessPlatform

      • ensureAuthenticatedBusinessPlatform(scopes?): Promise<string>

      • Ensure that we have a valid session to access the Business Platform API.

        Parameters

        • scopes: string[] = []

          Optional array of extra scopes to authenticate with.

        Returns Promise<string>

        The access token for the Business Platform API.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedPartners.html b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedPartners.html index 09b0034bf6..2894eae7ff 100644 --- a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedPartners.html +++ b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedPartners.html @@ -5,4 +5,4 @@
    • env: ProcessEnv = process.env

      Optional environment variables to use.

    • options: EnsureAuthenticatedAdditionalOptions = {}

      Optional extra options to use.

      • Returns Promise<{
          token: string;
          userId: string;
      }>

      The access token for the Partners API.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedStorefront.html b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedStorefront.html index 598fc09772..331492c92d 100644 --- a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedStorefront.html +++ b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedStorefront.html @@ -3,4 +3,4 @@
    • password: undefined | string = undefined

      Optional password to use.

    • forceRefresh: boolean = false

      Optional flag to force a refresh of the token.

      • Returns Promise<string>

      The access token for the Storefront API.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedThemes.html b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedThemes.html index eb88a03790..29926b40b0 100644 --- a/docs/api/cli-kit/functions/node_session.ensureAuthenticatedThemes.html +++ b/docs/api/cli-kit/functions/node_session.ensureAuthenticatedThemes.html @@ -6,4 +6,4 @@
    • scopes: string[] = []

      Optional array of extra scopes to authenticate with.

    • forceRefresh: boolean = false

      Optional flag to force a refresh of the token.

      • Returns Promise<AdminSession>

      The access token and store.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_session.logout.html b/docs/api/cli-kit/functions/node_session.logout.html index 91b10cd348..546106add2 100644 --- a/docs/api/cli-kit/functions/node_session.logout.html +++ b/docs/api/cli-kit/functions/node_session.logout.html @@ -1,3 +1,3 @@ logout | @shopify/cli-kit

      Function logout

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_system.captureOutput.html b/docs/api/cli-kit/functions/node_system.captureOutput.html index d244ac5d54..5f17a24719 100644 --- a/docs/api/cli-kit/functions/node_system.captureOutput.html +++ b/docs/api/cli-kit/functions/node_system.captureOutput.html @@ -3,4 +3,4 @@
    • args: string[]

      Arguments to pass to the command.

    • Optional options: ExecOptions

      Optional settings for how to run the command.

      • Returns Promise<string>

      A promise that resolves with the aggregatted stdout of the command.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_system.exec.html b/docs/api/cli-kit/functions/node_system.exec.html index 3579bbef3f..4f565ed854 100644 --- a/docs/api/cli-kit/functions/node_system.exec.html +++ b/docs/api/cli-kit/functions/node_system.exec.html @@ -2,4 +2,4 @@

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_system.openURL.html b/docs/api/cli-kit/functions/node_system.openURL.html index 6fd0dbf8b9..80b90e6f11 100644 --- a/docs/api/cli-kit/functions/node_system.openURL.html +++ b/docs/api/cli-kit/functions/node_system.openURL.html @@ -1,3 +1,3 @@ openURL | @shopify/cli-kit

      Function openURL

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_system.sleep.html b/docs/api/cli-kit/functions/node_system.sleep.html index b0f797eea3..81bdb5c630 100644 --- a/docs/api/cli-kit/functions/node_system.sleep.html +++ b/docs/api/cli-kit/functions/node_system.sleep.html @@ -1,4 +1,4 @@ sleep | @shopify/cli-kit

      Function sleep

      • sleep(seconds): Promise<void>

      • Waits for a given number of seconds.

        Parameters

        • seconds: number

          Number of seconds to wait.

        Returns Promise<void>

        A Promise resolving after the number of seconds.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_system.terminalSupportsPrompting.html b/docs/api/cli-kit/functions/node_system.terminalSupportsPrompting.html index 07b65e76f0..d41c53133a 100644 --- a/docs/api/cli-kit/functions/node_system.terminalSupportsPrompting.html +++ b/docs/api/cli-kit/functions/node_system.terminalSupportsPrompting.html @@ -1,3 +1,3 @@ terminalSupportsPrompting | @shopify/cli-kit

      Function terminalSupportsPrompting

      • terminalSupportsPrompting(): boolean

      • Check if the standard input and output streams support prompting.

        Returns boolean

        True if the standard input and output streams support prompting.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_tcp.checkPortAvailability.html b/docs/api/cli-kit/functions/node_tcp.checkPortAvailability.html index 9c9770d4a5..e7228f39c9 100644 --- a/docs/api/cli-kit/functions/node_tcp.checkPortAvailability.html +++ b/docs/api/cli-kit/functions/node_tcp.checkPortAvailability.html @@ -1,4 +1,4 @@ checkPortAvailability | @shopify/cli-kit

      Function checkPortAvailability

      • checkPortAvailability(portNumber): Promise<boolean>

      • Checks if a port is available.

        Parameters

        • portNumber: number

          The port number to check.

        Returns Promise<boolean>

        A promise that resolves with a boolean indicating if the port is available.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_tcp.getAvailableTCPPort.html b/docs/api/cli-kit/functions/node_tcp.getAvailableTCPPort.html index 6237ba32e8..f0977d00d9 100644 --- a/docs/api/cli-kit/functions/node_tcp.getAvailableTCPPort.html +++ b/docs/api/cli-kit/functions/node_tcp.getAvailableTCPPort.html @@ -2,4 +2,4 @@

      Parameters

      Returns Promise<number>

      A promise that resolves with an availabe port.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_testing_output.mockAndCaptureOutput.html b/docs/api/cli-kit/functions/node_testing_output.mockAndCaptureOutput.html index f315a83dd8..24a6d80974 100644 --- a/docs/api/cli-kit/functions/node_testing_output.mockAndCaptureOutput.html +++ b/docs/api/cli-kit/functions/node_testing_output.mockAndCaptureOutput.html @@ -1,3 +1,3 @@ mockAndCaptureOutput | @shopify/cli-kit

      Function mockAndCaptureOutput

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_testing_ui.getLastFrameAfterUnmount.html b/docs/api/cli-kit/functions/node_testing_ui.getLastFrameAfterUnmount.html index 62068d6675..9640c7172f 100644 --- a/docs/api/cli-kit/functions/node_testing_ui.getLastFrameAfterUnmount.html +++ b/docs/api/cli-kit/functions/node_testing_ui.getLastFrameAfterUnmount.html @@ -1,3 +1,3 @@ getLastFrameAfterUnmount | @shopify/cli-kit

      Function getLastFrameAfterUnmount

      • getLastFrameAfterUnmount(renderInstance): undefined | string

      • Function that is useful when you want to check the last frame of a component that unmounted.

        The reason this function exists is that in CI Ink will clear the last frame on unmount.

        -

        Parameters

        • renderInstance: Instance

        Returns undefined | string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns undefined | string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_testing_ui.render.html b/docs/api/cli-kit/functions/node_testing_ui.render.html index 0054cf1d41..1ee40071ba 100644 --- a/docs/api/cli-kit/functions/node_testing_ui.render.html +++ b/docs/api/cli-kit/functions/node_testing_ui.render.html @@ -1 +1 @@ -render | @shopify/cli-kit

      Function render

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +render | @shopify/cli-kit

      Function render

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWait.html b/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWait.html index 19c8202488..aa9d294eaf 100644 --- a/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWait.html +++ b/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWait.html @@ -2,4 +2,4 @@

      Useful if you know some what will happen after input will take a certain amount of time and it will not cause any visible change so you can't use sendInputAndWaitForChange. This function can also be used if you want to test that nothing changes after some input has been sent.

      -

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWaitForChange.html b/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWaitForChange.html index ec61dbd55d..40a92829a0 100644 --- a/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWaitForChange.html +++ b/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWaitForChange.html @@ -1,4 +1,4 @@ sendInputAndWaitForChange | @shopify/cli-kit

      Function sendInputAndWaitForChange

      • sendInputAndWaitForChange(renderInstance, ...inputs): Promise<void>

      • Send input and wait for the last frame to change.

        Useful when you want to send some input and wait for anything to change in the interface. If you need to wait for a specific change instead, you can use sendInputAndWaitForContent.

        -

        Parameters

        • renderInstance: Instance
        • Rest ...inputs: string[]

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWaitForContent.html b/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWaitForContent.html index a5cd84da5c..04decf4bee 100644 --- a/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWaitForContent.html +++ b/docs/api/cli-kit/functions/node_testing_ui.sendInputAndWaitForContent.html @@ -1,4 +1,4 @@ sendInputAndWaitForContent | @shopify/cli-kit

      Function sendInputAndWaitForContent

      • sendInputAndWaitForContent(renderInstance, content, ...inputs): Promise<void>

      • Send input and wait for the last frame to contain specific text.

        Useful when you want to send some input and wait for a specific change to happen. If you need to wait for any change instead, you can use sendInputAndWaitForChange.

        -

        Parameters

        • renderInstance: Instance
        • content: string
        • Rest ...inputs: string[]

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_testing_ui.waitForContent.html b/docs/api/cli-kit/functions/node_testing_ui.waitForContent.html index 34d6da3a1e..6401de83bd 100644 --- a/docs/api/cli-kit/functions/node_testing_ui.waitForContent.html +++ b/docs/api/cli-kit/functions/node_testing_ui.waitForContent.html @@ -1,2 +1,2 @@ waitForContent | @shopify/cli-kit

      Function waitForContent

      • waitForContent(renderInstance, content, func?): Promise<void>

      • Wait for the last frame to contain specific text.

        -

        Parameters

        • renderInstance: Instance
        • content: string
        • func: (() => void) = ...
            • (): void

            • Returns void

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_testing_ui.waitForInputsToBeReady.html b/docs/api/cli-kit/functions/node_testing_ui.waitForInputsToBeReady.html index 5716d9df1e..4a1d93ffd7 100644 --- a/docs/api/cli-kit/functions/node_testing_ui.waitForInputsToBeReady.html +++ b/docs/api/cli-kit/functions/node_testing_ui.waitForInputsToBeReady.html @@ -1,2 +1,2 @@ waitForInputsToBeReady | @shopify/cli-kit

      Function waitForInputsToBeReady

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<unknown>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.bulkUploadThemeAssets.html b/docs/api/cli-kit/functions/node_themes_api.bulkUploadThemeAssets.html index 9a402950da..493019d96b 100644 --- a/docs/api/cli-kit/functions/node_themes_api.bulkUploadThemeAssets.html +++ b/docs/api/cli-kit/functions/node_themes_api.bulkUploadThemeAssets.html @@ -1 +1 @@ -bulkUploadThemeAssets | @shopify/cli-kit

      Function bulkUploadThemeAssets

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +bulkUploadThemeAssets | @shopify/cli-kit

      Function bulkUploadThemeAssets

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.createTheme.html b/docs/api/cli-kit/functions/node_themes_api.createTheme.html index f0ae65d69f..8bbf00aabf 100644 --- a/docs/api/cli-kit/functions/node_themes_api.createTheme.html +++ b/docs/api/cli-kit/functions/node_themes_api.createTheme.html @@ -1 +1 @@ -createTheme | @shopify/cli-kit

      Function createTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +createTheme | @shopify/cli-kit

      Function createTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.deleteTheme.html b/docs/api/cli-kit/functions/node_themes_api.deleteTheme.html index 05bd2e7085..75aea11cc7 100644 --- a/docs/api/cli-kit/functions/node_themes_api.deleteTheme.html +++ b/docs/api/cli-kit/functions/node_themes_api.deleteTheme.html @@ -1 +1 @@ -deleteTheme | @shopify/cli-kit

      Function deleteTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +deleteTheme | @shopify/cli-kit

      Function deleteTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.deleteThemeAsset.html b/docs/api/cli-kit/functions/node_themes_api.deleteThemeAsset.html index b42948247f..5e52ccd958 100644 --- a/docs/api/cli-kit/functions/node_themes_api.deleteThemeAsset.html +++ b/docs/api/cli-kit/functions/node_themes_api.deleteThemeAsset.html @@ -1 +1 @@ -deleteThemeAsset | @shopify/cli-kit

      Function deleteThemeAsset

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +deleteThemeAsset | @shopify/cli-kit

      Function deleteThemeAsset

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.fetchChecksums.html b/docs/api/cli-kit/functions/node_themes_api.fetchChecksums.html index 25afcc455b..2685ac2d93 100644 --- a/docs/api/cli-kit/functions/node_themes_api.fetchChecksums.html +++ b/docs/api/cli-kit/functions/node_themes_api.fetchChecksums.html @@ -1 +1 @@ -fetchChecksums | @shopify/cli-kit

      Function fetchChecksums

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +fetchChecksums | @shopify/cli-kit

      Function fetchChecksums

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.fetchTheme.html b/docs/api/cli-kit/functions/node_themes_api.fetchTheme.html index 7aa9fe0b16..fd66883950 100644 --- a/docs/api/cli-kit/functions/node_themes_api.fetchTheme.html +++ b/docs/api/cli-kit/functions/node_themes_api.fetchTheme.html @@ -1 +1 @@ -fetchTheme | @shopify/cli-kit

      Function fetchTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +fetchTheme | @shopify/cli-kit

      Function fetchTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.fetchThemeAsset.html b/docs/api/cli-kit/functions/node_themes_api.fetchThemeAsset.html index eaadb7ae0d..f5e5345e1e 100644 --- a/docs/api/cli-kit/functions/node_themes_api.fetchThemeAsset.html +++ b/docs/api/cli-kit/functions/node_themes_api.fetchThemeAsset.html @@ -1 +1 @@ -fetchThemeAsset | @shopify/cli-kit

      Function fetchThemeAsset

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +fetchThemeAsset | @shopify/cli-kit

      Function fetchThemeAsset

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.fetchThemes.html b/docs/api/cli-kit/functions/node_themes_api.fetchThemes.html index ae5ca026af..f7555d1977 100644 --- a/docs/api/cli-kit/functions/node_themes_api.fetchThemes.html +++ b/docs/api/cli-kit/functions/node_themes_api.fetchThemes.html @@ -1 +1 @@ -fetchThemes | @shopify/cli-kit

      Function fetchThemes

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +fetchThemes | @shopify/cli-kit

      Function fetchThemes

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.publishTheme.html b/docs/api/cli-kit/functions/node_themes_api.publishTheme.html index 1fd7ebdff4..d0621276d2 100644 --- a/docs/api/cli-kit/functions/node_themes_api.publishTheme.html +++ b/docs/api/cli-kit/functions/node_themes_api.publishTheme.html @@ -1 +1 @@ -publishTheme | @shopify/cli-kit

      Function publishTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +publishTheme | @shopify/cli-kit

      Function publishTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.updateTheme.html b/docs/api/cli-kit/functions/node_themes_api.updateTheme.html index c7b4989608..28e009ff7a 100644 --- a/docs/api/cli-kit/functions/node_themes_api.updateTheme.html +++ b/docs/api/cli-kit/functions/node_themes_api.updateTheme.html @@ -1 +1 @@ -updateTheme | @shopify/cli-kit

      Function updateTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +updateTheme | @shopify/cli-kit

      Function updateTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_api.upgradeTheme.html b/docs/api/cli-kit/functions/node_themes_api.upgradeTheme.html index b23d75b1d5..29ace0b1c6 100644 --- a/docs/api/cli-kit/functions/node_themes_api.upgradeTheme.html +++ b/docs/api/cli-kit/functions/node_themes_api.upgradeTheme.html @@ -1 +1 @@ -upgradeTheme | @shopify/cli-kit

      Function upgradeTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +upgradeTheme | @shopify/cli-kit

      Function upgradeTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_conf.getHostTheme.html b/docs/api/cli-kit/functions/node_themes_conf.getHostTheme.html index c0c9254bf4..f930d4f8f0 100644 --- a/docs/api/cli-kit/functions/node_themes_conf.getHostTheme.html +++ b/docs/api/cli-kit/functions/node_themes_conf.getHostTheme.html @@ -1 +1 @@ -getHostTheme | @shopify/cli-kit

      Function getHostTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +getHostTheme | @shopify/cli-kit

      Function getHostTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_conf.hostThemeLocalStorage.html b/docs/api/cli-kit/functions/node_themes_conf.hostThemeLocalStorage.html index 549e472b07..d8ac12371b 100644 --- a/docs/api/cli-kit/functions/node_themes_conf.hostThemeLocalStorage.html +++ b/docs/api/cli-kit/functions/node_themes_conf.hostThemeLocalStorage.html @@ -1 +1 @@ -hostThemeLocalStorage | @shopify/cli-kit

      Function hostThemeLocalStorage

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +hostThemeLocalStorage | @shopify/cli-kit

      Function hostThemeLocalStorage

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_conf.removeHostTheme.html b/docs/api/cli-kit/functions/node_themes_conf.removeHostTheme.html index d402f5afc0..36733cb4d1 100644 --- a/docs/api/cli-kit/functions/node_themes_conf.removeHostTheme.html +++ b/docs/api/cli-kit/functions/node_themes_conf.removeHostTheme.html @@ -1 +1 @@ -removeHostTheme | @shopify/cli-kit

      Function removeHostTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +removeHostTheme | @shopify/cli-kit

      Function removeHostTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_conf.setHostTheme.html b/docs/api/cli-kit/functions/node_themes_conf.setHostTheme.html index c670a0deab..b35be6e16c 100644 --- a/docs/api/cli-kit/functions/node_themes_conf.setHostTheme.html +++ b/docs/api/cli-kit/functions/node_themes_conf.setHostTheme.html @@ -1 +1 @@ -setHostTheme | @shopify/cli-kit

      Function setHostTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +setHostTheme | @shopify/cli-kit

      Function setHostTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_factories.buildBulkUploadResults.html b/docs/api/cli-kit/functions/node_themes_factories.buildBulkUploadResults.html index 51b8a3f795..6fdabfc028 100644 --- a/docs/api/cli-kit/functions/node_themes_factories.buildBulkUploadResults.html +++ b/docs/api/cli-kit/functions/node_themes_factories.buildBulkUploadResults.html @@ -1 +1 @@ -buildBulkUploadResults | @shopify/cli-kit

      Function buildBulkUploadResults

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +buildBulkUploadResults | @shopify/cli-kit

      Function buildBulkUploadResults

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_factories.buildChecksum.html b/docs/api/cli-kit/functions/node_themes_factories.buildChecksum.html index f30cd94485..51774118e9 100644 --- a/docs/api/cli-kit/functions/node_themes_factories.buildChecksum.html +++ b/docs/api/cli-kit/functions/node_themes_factories.buildChecksum.html @@ -1 +1 @@ -buildChecksum | @shopify/cli-kit

      Function buildChecksum

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +buildChecksum | @shopify/cli-kit

      Function buildChecksum

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_factories.buildTheme.html b/docs/api/cli-kit/functions/node_themes_factories.buildTheme.html index 682beb0231..2080fce753 100644 --- a/docs/api/cli-kit/functions/node_themes_factories.buildTheme.html +++ b/docs/api/cli-kit/functions/node_themes_factories.buildTheme.html @@ -1 +1 @@ -buildTheme | @shopify/cli-kit

      Function buildTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +buildTheme | @shopify/cli-kit

      Function buildTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_factories.buildThemeAsset.html b/docs/api/cli-kit/functions/node_themes_factories.buildThemeAsset.html index d71346d2bf..247187b11d 100644 --- a/docs/api/cli-kit/functions/node_themes_factories.buildThemeAsset.html +++ b/docs/api/cli-kit/functions/node_themes_factories.buildThemeAsset.html @@ -1 +1 @@ -buildThemeAsset | @shopify/cli-kit

      Function buildThemeAsset

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +buildThemeAsset | @shopify/cli-kit

      Function buildThemeAsset

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_urls.codeEditorUrl.html b/docs/api/cli-kit/functions/node_themes_urls.codeEditorUrl.html index 579b4c3499..c1946ea1a8 100644 --- a/docs/api/cli-kit/functions/node_themes_urls.codeEditorUrl.html +++ b/docs/api/cli-kit/functions/node_themes_urls.codeEditorUrl.html @@ -1 +1 @@ -codeEditorUrl | @shopify/cli-kit

      Function codeEditorUrl

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +codeEditorUrl | @shopify/cli-kit

      Function codeEditorUrl

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_urls.storeAdminUrl.html b/docs/api/cli-kit/functions/node_themes_urls.storeAdminUrl.html index 7c55cde674..95f01edc22 100644 --- a/docs/api/cli-kit/functions/node_themes_urls.storeAdminUrl.html +++ b/docs/api/cli-kit/functions/node_themes_urls.storeAdminUrl.html @@ -1 +1 @@ -storeAdminUrl | @shopify/cli-kit

      Function storeAdminUrl

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +storeAdminUrl | @shopify/cli-kit

      Function storeAdminUrl

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_urls.themeEditorUrl.html b/docs/api/cli-kit/functions/node_themes_urls.themeEditorUrl.html index f5fdd12753..1e1d7d7ba1 100644 --- a/docs/api/cli-kit/functions/node_themes_urls.themeEditorUrl.html +++ b/docs/api/cli-kit/functions/node_themes_urls.themeEditorUrl.html @@ -1 +1 @@ -themeEditorUrl | @shopify/cli-kit

      Function themeEditorUrl

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +themeEditorUrl | @shopify/cli-kit

      Function themeEditorUrl

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_urls.themePreviewUrl.html b/docs/api/cli-kit/functions/node_themes_urls.themePreviewUrl.html index 0b4b26c570..cc1cc89b16 100644 --- a/docs/api/cli-kit/functions/node_themes_urls.themePreviewUrl.html +++ b/docs/api/cli-kit/functions/node_themes_urls.themePreviewUrl.html @@ -1 +1 @@ -themePreviewUrl | @shopify/cli-kit

      Function themePreviewUrl

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +themePreviewUrl | @shopify/cli-kit

      Function themePreviewUrl

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_utils.isDevelopmentTheme.html b/docs/api/cli-kit/functions/node_themes_utils.isDevelopmentTheme.html index a7f0cb7e8d..1e92983243 100644 --- a/docs/api/cli-kit/functions/node_themes_utils.isDevelopmentTheme.html +++ b/docs/api/cli-kit/functions/node_themes_utils.isDevelopmentTheme.html @@ -1 +1 @@ -isDevelopmentTheme | @shopify/cli-kit

      Function isDevelopmentTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +isDevelopmentTheme | @shopify/cli-kit

      Function isDevelopmentTheme

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_themes_utils.promptThemeName.html b/docs/api/cli-kit/functions/node_themes_utils.promptThemeName.html index 4db7d47133..094b00533c 100644 --- a/docs/api/cli-kit/functions/node_themes_utils.promptThemeName.html +++ b/docs/api/cli-kit/functions/node_themes_utils.promptThemeName.html @@ -1 +1 @@ -promptThemeName | @shopify/cli-kit

      Function promptThemeName

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +promptThemeName | @shopify/cli-kit

      Function promptThemeName

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_toml.decodeToml.html b/docs/api/cli-kit/functions/node_toml.decodeToml.html index 5521e40d95..00dc86a728 100644 --- a/docs/api/cli-kit/functions/node_toml.decodeToml.html +++ b/docs/api/cli-kit/functions/node_toml.decodeToml.html @@ -1,4 +1,4 @@ decodeToml | @shopify/cli-kit

      Function decodeToml

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_toml.encodeToml.html b/docs/api/cli-kit/functions/node_toml.encodeToml.html index 5d390c3f05..363f13c32d 100644 --- a/docs/api/cli-kit/functions/node_toml.encodeToml.html +++ b/docs/api/cli-kit/functions/node_toml.encodeToml.html @@ -1,4 +1,4 @@ encodeToml | @shopify/cli-kit

      Function encodeToml

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_tree_kill.treeKill.html b/docs/api/cli-kit/functions/node_tree_kill.treeKill.html index 511e6897db..5bbb8e76a1 100644 --- a/docs/api/cli-kit/functions/node_tree_kill.treeKill.html +++ b/docs/api/cli-kit/functions/node_tree_kill.treeKill.html @@ -3,4 +3,4 @@
    • killSignal: string = 'SIGTERM'

      Type of kill signal to be used.

    • killRoot: boolean = true

      Whether to kill the root process.

    • Optional callback: AfterKillCallback

      Optional callback to run after killing the processes.

      -

      • Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.handleCtrlC.html b/docs/api/cli-kit/functions/node_ui.handleCtrlC.html index d3d29b4f9e..037aa3145d 100644 --- a/docs/api/cli-kit/functions/node_ui.handleCtrlC.html +++ b/docs/api/cli-kit/functions/node_ui.handleCtrlC.html @@ -1 +1 @@ -handleCtrlC | @shopify/cli-kit

      Function handleCtrlC

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +handleCtrlC | @shopify/cli-kit

      Function handleCtrlC

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.isTTY.html b/docs/api/cli-kit/functions/node_ui.isTTY.html index 88d5beda43..6bc5faac4b 100644 --- a/docs/api/cli-kit/functions/node_ui.isTTY.html +++ b/docs/api/cli-kit/functions/node_ui.isTTY.html @@ -1 +1 @@ -isTTY | @shopify/cli-kit

      Function isTTY

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +isTTY | @shopify/cli-kit

      Function isTTY

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.keypress.html b/docs/api/cli-kit/functions/node_ui.keypress.html index 6a6970c0fd..a2f9f8ae52 100644 --- a/docs/api/cli-kit/functions/node_ui.keypress.html +++ b/docs/api/cli-kit/functions/node_ui.keypress.html @@ -1,2 +1,2 @@ keypress | @shopify/cli-kit

      Function keypress

      • keypress(stdin?, uiDebugOptions?): Promise<unknown>

      • Waits for any key to be pressed except Ctrl+C which will terminate the process.

        -

        Parameters

        • stdin: ReadStream & {} = process.stdin
        • uiDebugOptions: UIDebugOptions = defaultUIDebugOptions

        Returns Promise<unknown>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<unknown>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.render.html b/docs/api/cli-kit/functions/node_ui.render.html index 33e2a05927..e748d4be9b 100644 --- a/docs/api/cli-kit/functions/node_ui.render.html +++ b/docs/api/cli-kit/functions/node_ui.render.html @@ -1 +1 @@ -render | @shopify/cli-kit

      Function render

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +render | @shopify/cli-kit

      Function render

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderAutocompletePrompt.html b/docs/api/cli-kit/functions/node_ui.renderAutocompletePrompt.html index 53adf2c886..a2d885f210 100644 --- a/docs/api/cli-kit/functions/node_ui.renderAutocompletePrompt.html +++ b/docs/api/cli-kit/functions/node_ui.renderAutocompletePrompt.html @@ -1,4 +1,4 @@ renderAutocompletePrompt | @shopify/cli-kit

      Function renderAutocompletePrompt

      • renderAutocompletePrompt<T>(__namedParameters, uiDebugOptions?): Promise<T>

      • Renders an autocomplete prompt to the console.

        Type Parameters

        • T

        Parameters

        Returns Promise<T>

        Example

        ?  Select a template:   Type to search...

           ┃  Info message title
           ┃
           ┃  Info message body

        >  first
           second
           third
           fourth
           fifth
           sixth
           seventh
           eighth
           ninth
           tenth
           eleventh
           twelfth
           thirteenth
           fourteenth
           fifteenth
           sixteenth
           seventeenth
           eighteenth
           nineteenth (disabled)
           twentieth
           twenty-first
           twenty-second
           twenty-third
           twenty-fourth
           twenty-fifth

           Press ↑↓ arrows to select, enter to confirm.
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderConcurrent.html b/docs/api/cli-kit/functions/node_ui.renderConcurrent.html index 13cb2cea14..40428b43c2 100644 --- a/docs/api/cli-kit/functions/node_ui.renderConcurrent.html +++ b/docs/api/cli-kit/functions/node_ui.renderConcurrent.html @@ -1,4 +1,4 @@ renderConcurrent | @shopify/cli-kit

      Function renderConcurrent

      • renderConcurrent(__namedParameters): Promise<unknown>

      • Renders output from concurrent processes to the terminal with ConcurrentOutput.

        Parameters

        Returns Promise<unknown>

        Example

        00:00:00 │  backend │ first backend message
        00:00:00 │  backend │ second backend message
        00:00:00 │  backend │ third backend message
        00:00:00 │ frontend │ first frontend message
        00:00:00 │ frontend │ second frontend message
        00:00:00 │ frontend │ third frontend message
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderConfirmationPrompt.html b/docs/api/cli-kit/functions/node_ui.renderConfirmationPrompt.html index 370a8de360..b83c93f82a 100644 --- a/docs/api/cli-kit/functions/node_ui.renderConfirmationPrompt.html +++ b/docs/api/cli-kit/functions/node_ui.renderConfirmationPrompt.html @@ -1,4 +1,4 @@ renderConfirmationPrompt | @shopify/cli-kit

      Function renderConfirmationPrompt

      • renderConfirmationPrompt(__namedParameters): Promise<boolean>

      • Renders a confirmation prompt to the console.

        Parameters

        Returns Promise<boolean>

        Example

        ?  Delete the following themes from the store?

           ┃  Info message title
           ┃
           ┃  Info message body
           ┃
           ┃  • first theme (#1)
           ┃  • second theme (#2)

        >  (y) Yes, confirm changes
           (n) Cancel

           Press ↑↓ arrows to select, enter or a shortcut to
           confirm.
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderDangerousConfirmationPrompt.html b/docs/api/cli-kit/functions/node_ui.renderDangerousConfirmationPrompt.html index 142cd02f6c..3f15dcbab7 100644 --- a/docs/api/cli-kit/functions/node_ui.renderDangerousConfirmationPrompt.html +++ b/docs/api/cli-kit/functions/node_ui.renderDangerousConfirmationPrompt.html @@ -2,4 +2,4 @@ type a confirmation string to proceed.

      Parameters

      Returns Promise<boolean>

      Example

      ?  Release a new version of nightly-app-2023-06-19?

         ┃  Includes:
         ┃  + web-px (new)
         ┃  + sub-ui-ext
         ┃  + theme-app-ext
         ┃  + paymentify (from Partner Dashboard)
         ┃
         ┃  Removes:
         ┃  - prod-discount-fun
         ┃
         ┃  This can permanently delete app user data.

         Type nightly-app-2023-06-19 to confirm, or press Escape
         to cancel.
      >  █
         ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderError.html b/docs/api/cli-kit/functions/node_ui.renderError.html index 95e830243c..ec01324b17 100644 --- a/docs/api/cli-kit/functions/node_ui.renderError.html +++ b/docs/api/cli-kit/functions/node_ui.renderError.html @@ -1,4 +1,4 @@ renderError | @shopify/cli-kit

      Function renderError

      • renderError(options): undefined | string

      • Renders an error banner to the console.

        Parameters

        Returns undefined | string

        Example

        ╭─ error ──────────────────────────────────────────────────╮
        │                                                          │
        │  Version couldn't be released.                           │
        │                                                          │
        │  This version needs to be submitted for review and       │
        │  approved by Shopify before it can be released.          │
        │                                                          │
        ╰──────────────────────────────────────────────────────────╯
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderFatalError.html b/docs/api/cli-kit/functions/node_ui.renderFatalError.html index 4da60cf00b..78372af31b 100644 --- a/docs/api/cli-kit/functions/node_ui.renderFatalError.html +++ b/docs/api/cli-kit/functions/node_ui.renderFatalError.html @@ -3,4 +3,4 @@

      Example

      Complete
      ╭─ error ──────────────────────────────────────────────────╮
      │                                                          │
      │  No Organization found                                   │
      │                                                          │
      │  Next steps                                              │
      │    • Have you created a Shopify Partners organization    │
      │      [1]?                                                │
      │    • Have you confirmed your accounts from the emails    │
      │      you received?                                       │
      │    • Need to connect to a different App or               │
      │      organization? Run the command again with `--reset`  │
      │                                                          │
      │  amortizable-marketplace-ext                             │
      │    • Some other error                                    │
      │  Validation errors                                       │
      │    • Missing expected key(s).                            │
      │                                                          │
      │  amortizable-marketplace-ext-2                           │
      │    • Something was not found                             │
      │                                                          │
      ╰──────────────────────────────────────────────────────────╯
      [1] https://partners.shopify.com/signup
      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderInfo.html b/docs/api/cli-kit/functions/node_ui.renderInfo.html index 1d55c8d02d..32588a19b4 100644 --- a/docs/api/cli-kit/functions/node_ui.renderInfo.html +++ b/docs/api/cli-kit/functions/node_ui.renderInfo.html @@ -3,4 +3,4 @@

      Example

      Complete
      ╭─ info ───────────────────────────────────────────────────╮
      │                                                          │
      │  my-app initialized and ready to build.                  │
      │                                                          │
      │  Next steps                                              │
      │    • Run `cd verification-app`                           │
      │    • To preview your project, run `npm app dev`          │
      │    • To add extensions, run `npm generate extension`     │
      │                                                          │
      │  Reference                                               │
      │    • Run `npm shopify help`                              │
      │    • Dev docs [1]                                        │
      │                                                          │
      │  Custom section                                          │
      │    • Item 1 [2]                                          │
      │    • Item 2                                              │
      │    • Item 3 [3]                                          │
      │                                                          │
      ╰──────────────────────────────────────────────────────────╯
      [1] https://shopify.dev
      [2] https://www.google.com/search?q=jh56t9l34kpo35tw8s28hn7s
      9s2xvzla01d8cn6j7yq&rlz=1C1GCEU_enUS832US832&oq=jh56t9l34kpo
      35tw8s28hn7s9s2xvzla01d8cn6j7yq&aqs=chrome.0.35i39l2j0l4j46j
      69i60.2711j0j7&sourceid=chrome&ie=UTF-8
      [3] https://shopify.com
      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderSelectPrompt.html b/docs/api/cli-kit/functions/node_ui.renderSelectPrompt.html index aeaef8f48c..5df76cf0ca 100644 --- a/docs/api/cli-kit/functions/node_ui.renderSelectPrompt.html +++ b/docs/api/cli-kit/functions/node_ui.renderSelectPrompt.html @@ -1,4 +1,4 @@ renderSelectPrompt | @shopify/cli-kit

      Function renderSelectPrompt

      • renderSelectPrompt<T>(__namedParameters, uiDebugOptions?): Promise<T>

      • Renders a select prompt to the console.

        Type Parameters

        • T

        Parameters

        Returns Promise<T>

        Example

        ?  Associate your project with the org Castile Ventures?

           ┃  Add
           ┃  • new-ext
           ┃
           ┃  Remove
           ┃  • integrated-demand-ext
           ┃  • order-discount

           Automations
           >  fifth
              sixth

           Merchant Admin
              eighth
              ninth

           Other
              first
              second
              third (limit reached)
              fourth
              seventh
              tenth

           Press ↑↓ arrows to select, enter to confirm.
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderSuccess.html b/docs/api/cli-kit/functions/node_ui.renderSuccess.html index b0052b5b19..cf2c37fa77 100644 --- a/docs/api/cli-kit/functions/node_ui.renderSuccess.html +++ b/docs/api/cli-kit/functions/node_ui.renderSuccess.html @@ -3,4 +3,4 @@

      Example

      Complete
      ╭─ success ────────────────────────────────────────────────╮
      │                                                          │
      │  Deployment successful.                                  │
      │                                                          │
      │  Your extensions have been uploaded to your Shopify      │
      │  Partners Dashboard.                                     │
      │                                                          │
      │  Next steps                                              │
      │    • See your deployment and set it live [1]             │
      │                                                          │
      ╰──────────────────────────────────────────────────────────╯
      [1] https://partners.shopify.com/1797046/apps/4523695/deploy
      ments
      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderTable.html b/docs/api/cli-kit/functions/node_ui.renderTable.html index acecc95df8..2af44aa366 100644 --- a/docs/api/cli-kit/functions/node_ui.renderTable.html +++ b/docs/api/cli-kit/functions/node_ui.renderTable.html @@ -1,4 +1,4 @@ renderTable | @shopify/cli-kit

      Function renderTable

      • renderTable<T>(__namedParameters): undefined | string

      • Renders a table to the console.

        Type Parameters

        • T extends default

        Parameters

        • __namedParameters: RenderTableOptions<T>

        Returns undefined | string

        Example

        ID  Name        email
        ──  ──────────  ─────────────
        1   John Doe    jon@doe.com
        2   Jane Doe    jane@doe.com
        3   John Smith  jon@smith.com
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderTasks.html b/docs/api/cli-kit/functions/node_ui.renderTasks.html index b88e6cd7bb..c8fc267ebf 100644 --- a/docs/api/cli-kit/functions/node_ui.renderTasks.html +++ b/docs/api/cli-kit/functions/node_ui.renderTasks.html @@ -1,4 +1,4 @@ renderTasks | @shopify/cli-kit

      Function renderTasks

      • renderTasks<TContext>(tasks, __namedParameters?): Promise<TContext>

      • Runs async tasks and displays their progress to the console.

        Type Parameters

        • TContext

        Parameters

        • tasks: Task<TContext>[]
        • __namedParameters: RenderTasksOptions = {}

        Returns Promise<TContext>

        Example

        ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
        Installing dependencies ...
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderText.html b/docs/api/cli-kit/functions/node_ui.renderText.html index 10efb13555..a29cecdd64 100644 --- a/docs/api/cli-kit/functions/node_ui.renderText.html +++ b/docs/api/cli-kit/functions/node_ui.renderText.html @@ -2,4 +2,4 @@ Using this function makes sure that correct spacing is applied among the various components.

      Parameters

      Returns string

      Example

      Hello world!
      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderTextPrompt.html b/docs/api/cli-kit/functions/node_ui.renderTextPrompt.html index f67f6d0ba5..4ef695e07f 100644 --- a/docs/api/cli-kit/functions/node_ui.renderTextPrompt.html +++ b/docs/api/cli-kit/functions/node_ui.renderTextPrompt.html @@ -1,4 +1,4 @@ renderTextPrompt | @shopify/cli-kit

      Function renderTextPrompt

      • renderTextPrompt(__namedParameters, uiDebugOptions?): Promise<string>

      • Renders a text prompt to the console.

        Parameters

        Returns Promise<string>

        Example

        ?  App project name (can be changed later):
        >  expansive commerce app
           ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui.renderWarning.html b/docs/api/cli-kit/functions/node_ui.renderWarning.html index dc9c31e057..96e2d9412b 100644 --- a/docs/api/cli-kit/functions/node_ui.renderWarning.html +++ b/docs/api/cli-kit/functions/node_ui.renderWarning.html @@ -3,4 +3,4 @@

      Example

      Complete
      ╭─ warning ────────────────────────────────────────────────╮
      │                                                          │
      │  Required access scope update.                           │
      │                                                          │
      │  The deadline for re-selecting your app scopes is May    │
      │  1, 2022.                                                │
      │                                                          │
      │  Reference                                               │
      │    • Dev docs [1]                                        │
      │                                                          │
      ╰──────────────────────────────────────────────────────────╯
      [1] https://shopify.dev/app/scopes
      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui_components.ConcurrentOutput.html b/docs/api/cli-kit/functions/node_ui_components.ConcurrentOutput.html index 32b2002127..fafc554048 100644 --- a/docs/api/cli-kit/functions/node_ui_components.ConcurrentOutput.html +++ b/docs/api/cli-kit/functions/node_ui_components.ConcurrentOutput.html @@ -7,4 +7,4 @@

      For example running shopify app dev:

      2022-10-10 13:11:03 | backend    | npm
      2022-10-10 13:11:03 | backend    |  WARN ignoring workspace config at ...
      2022-10-10 13:11:03 | backend    |
      2022-10-10 13:11:03 | backend    |
      2022-10-10 13:11:03 | backend    | > shopify-app-template-node@0.1.0 dev
      2022-10-10 13:11:03 | backend    | > cross-env NODE_ENV=development nodemon backend/index.js --watch ./backend
      2022-10-10 13:11:03 | backend    |
      2022-10-10 13:11:03 | backend    |
      2022-10-10 13:11:03 | frontend   |
      2022-10-10 13:11:03 | frontend   | > starter-react-frontend-app@0.1.0 dev
      2022-10-10 13:11:03 | frontend   | > cross-env NODE_ENV=development node vite-server.js
      2022-10-10 13:11:03 | frontend   |
      2022-10-10 13:11:03 | frontend   |
      2022-10-10 13:11:03 | backend    |
      2022-10-10 13:11:03 | backend    | [nodemon] to restart at any time, enter `rs`
      2022-10-10 13:11:03 | backend    | [nodemon] watching path(s): backend/
      2022-10-10 13:11:03 | backend    | [nodemon] watching extensions: js,mjs,json
      2022-10-10 13:11:03 | backend    | [nodemon] starting `node backend/index.js`
      2022-10-10 13:11:03 | backend    |
      -

      Parameters

      Returns null | ReactElement<any, any>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns null | ReactElement<any, any>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui_components.useConcurrentOutputContext.html b/docs/api/cli-kit/functions/node_ui_components.useConcurrentOutputContext.html index 2be5280a9d..58b764cbce 100644 --- a/docs/api/cli-kit/functions/node_ui_components.useConcurrentOutputContext.html +++ b/docs/api/cli-kit/functions/node_ui_components.useConcurrentOutputContext.html @@ -1 +1 @@ -useConcurrentOutputContext | @shopify/cli-kit

      Function useConcurrentOutputContext

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +useConcurrentOutputContext | @shopify/cli-kit

      Function useConcurrentOutputContext

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_ui_hooks.useAbortSignal.html b/docs/api/cli-kit/functions/node_ui_hooks.useAbortSignal.html index 8a2696715b..9c1f67312a 100644 --- a/docs/api/cli-kit/functions/node_ui_hooks.useAbortSignal.html +++ b/docs/api/cli-kit/functions/node_ui_hooks.useAbortSignal.html @@ -1 +1 @@ -useAbortSignal | @shopify/cli-kit

      Function useAbortSignal

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +useAbortSignal | @shopify/cli-kit

      Function useAbortSignal

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_upgrade.cliInstallCommand.html b/docs/api/cli-kit/functions/node_upgrade.cliInstallCommand.html index c3c42f5a3a..5b7b311dbb 100644 --- a/docs/api/cli-kit/functions/node_upgrade.cliInstallCommand.html +++ b/docs/api/cli-kit/functions/node_upgrade.cliInstallCommand.html @@ -1,4 +1,4 @@ cliInstallCommand | @shopify/cli-kit

      Function cliInstallCommand

      • cliInstallCommand(): string

      • Utility function for generating an install command for the user to run to install an updated version of Shopify CLI.

        Returns string

        A string with the command to run.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_upgrade.getOutputUpdateCLIReminder.html b/docs/api/cli-kit/functions/node_upgrade.getOutputUpdateCLIReminder.html index cab0ba8d1d..27bd295a38 100644 --- a/docs/api/cli-kit/functions/node_upgrade.getOutputUpdateCLIReminder.html +++ b/docs/api/cli-kit/functions/node_upgrade.getOutputUpdateCLIReminder.html @@ -1,4 +1,4 @@ getOutputUpdateCLIReminder | @shopify/cli-kit

      Function getOutputUpdateCLIReminder

      • getOutputUpdateCLIReminder(version): string

      • Generates a message to remind the user to update the CLI.

        Parameters

        • version: string

          The version to update to.

        Returns string

        The message to remind the user to update the CLI.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_vendor_otel_js_utils_throttle.throttle.html b/docs/api/cli-kit/functions/node_vendor_otel_js_utils_throttle.throttle.html index 444866a6aa..138fea5476 100644 --- a/docs/api/cli-kit/functions/node_vendor_otel_js_utils_throttle.throttle.html +++ b/docs/api/cli-kit/functions/node_vendor_otel_js_utils_throttle.throttle.html @@ -1 +1 @@ -throttle | @shopify/cli-kit

      Function throttle

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +throttle | @shopify/cli-kit

      Function throttle

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_vendor_otel_js_utils_validators.isValidMetricName.html b/docs/api/cli-kit/functions/node_vendor_otel_js_utils_validators.isValidMetricName.html index de07927b5c..fb7f13fb85 100644 --- a/docs/api/cli-kit/functions/node_vendor_otel_js_utils_validators.isValidMetricName.html +++ b/docs/api/cli-kit/functions/node_vendor_otel_js_utils_validators.isValidMetricName.html @@ -1 +1 @@ -isValidMetricName | @shopify/cli-kit

      Function isValidMetricName

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +isValidMetricName | @shopify/cli-kit

      Function isValidMetricName

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_vscode.addRecommendedExtensions.html b/docs/api/cli-kit/functions/node_vscode.addRecommendedExtensions.html index ea36e6700a..e975f1212f 100644 --- a/docs/api/cli-kit/functions/node_vscode.addRecommendedExtensions.html +++ b/docs/api/cli-kit/functions/node_vscode.addRecommendedExtensions.html @@ -1,4 +1,4 @@ addRecommendedExtensions | @shopify/cli-kit

      Function addRecommendedExtensions

      • addRecommendedExtensions(directory, recommendations): Promise<void>

      • Add VSCode extension recommendations.

        Parameters

        • directory: string

          Directory that contains the .vscode folder.

        • recommendations: string[]

          List of VSCode extensions to recommend.

          -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_vscode.isVSCode.html b/docs/api/cli-kit/functions/node_vscode.isVSCode.html index 6a93f2401d..260c567556 100644 --- a/docs/api/cli-kit/functions/node_vscode.isVSCode.html +++ b/docs/api/cli-kit/functions/node_vscode.isVSCode.html @@ -1,4 +1,4 @@ isVSCode | @shopify/cli-kit

      Function isVSCode

      • isVSCode(root?): Promise<boolean>

      • Check if user editor is VS Code.

        Parameters

        • root: string = ...

          Root directory to start searching for .vscode directory.

        Returns Promise<boolean>

        True if user editor is VS Code.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_api_admin.RestResponse.html b/docs/api/cli-kit/interfaces/node_api_admin.RestResponse.html index d06680106a..2ce96e05f7 100644 --- a/docs/api/cli-kit/interfaces/node_api_admin.RestResponse.html +++ b/docs/api/cli-kit/interfaces/node_api_admin.RestResponse.html @@ -1,8 +1,8 @@ RestResponse | @shopify/cli-kit

      Interface RestResponse

      Respose of a REST request.

      -
      interface RestResponse {
          headers: {
              [key: string]: string[];
          };
          json: any;
          status: number;
      }

      Properties

      headers +
      interface RestResponse {
          headers: {
              [key: string]: string[];
          };
          json: any;
          status: number;
      }

      Properties

      headers json status

      Properties

      headers

      headers: {
          [key: string]: string[];
      }

      HTTP response headers.

      -

      Type declaration

      • [key: string]: string[]

      json

      json: any

      REST JSON respose.

      -

      status

      status: number

      HTTP response status.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      headersjsonstatus
      \ No newline at end of file +

      Type declaration

      json

      json: any

      REST JSON respose.

      +

      status

      status: number

      HTTP response status.

      +

      Settings

      Member Visibility

      Theme

      On This Page

      headersjsonstatus
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLResponseOptions.html b/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLResponseOptions.html index dc3777035e..5a02f418d1 100644 --- a/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLResponseOptions.html +++ b/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLResponseOptions.html @@ -1,3 +1,3 @@ -GraphQLResponseOptions | @shopify/cli-kit

      Interface GraphQLResponseOptions<T>

      interface GraphQLResponseOptions<T> {
          handleErrors?: boolean;
          onResponse?: ((response) => void);
      }

      Type Parameters

      • T

      Properties

      handleErrors? +GraphQLResponseOptions | @shopify/cli-kit

      Interface GraphQLResponseOptions<T>

      interface GraphQLResponseOptions<T> {
          handleErrors?: boolean;
          onResponse?: ((response) => void);
      }

      Type Parameters

      • T

      Properties

      handleErrors? onResponse? -

      Properties

      Optional handleErrors

      handleErrors?: boolean

      Optional onResponse

      onResponse?: ((response) => void)

      Type declaration

        • (response): void

        • Parameters

          • response: Response<T>

          Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      handleErrorsonResponse
      \ No newline at end of file +

      Properties

      Optional handleErrors

      handleErrors?: boolean

      Optional onResponse

      onResponse?: ((response) => void)

      Type declaration

        • (response): void

        • Parameters

          • response: Response<T>

          Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      handleErrorsonResponse
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLVariables.html b/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLVariables.html index 22b0979300..1f0d22176e 100644 --- a/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLVariables.html +++ b/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLVariables.html @@ -1 +1 @@ -GraphQLVariables | @shopify/cli-kit

      Interface GraphQLVariables

      interface GraphQLVariables {
          [key: string]: any;
      }

      Indexable

      [key: string]: any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +GraphQLVariables | @shopify/cli-kit

      Interface GraphQLVariables

      interface GraphQLVariables {
          [key: string]: any;
      }

      Indexable

      [key: string]: any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_dot_env.DotEnvFile.html b/docs/api/cli-kit/interfaces/node_dot_env.DotEnvFile.html index ffa01a17c9..f5b5ab70ed 100644 --- a/docs/api/cli-kit/interfaces/node_dot_env.DotEnvFile.html +++ b/docs/api/cli-kit/interfaces/node_dot_env.DotEnvFile.html @@ -1,6 +1,6 @@ DotEnvFile | @shopify/cli-kit

      Interface DotEnvFile

      This interface represents a .env file.

      -
      interface DotEnvFile {
          path: string;
          variables: {
              [name: string]: string;
          };
      }

      Properties

      path +
      interface DotEnvFile {
          path: string;
          variables: {
              [name: string]: string;
          };
      }

      Properties

      path variables

      Properties

      path

      path: string

      Path to the .env file.

      -

      variables

      variables: {
          [name: string]: string;
      }

      Variables of the .env file.

      -

      Type declaration

      • [name: string]: string

      Settings

      Member Visibility

      Theme

      On This Page

      pathvariables
      \ No newline at end of file +

      variables

      variables: {
          [name: string]: string;
      }

      Variables of the .env file.

      +

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      pathvariables
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_environments.Environments.html b/docs/api/cli-kit/interfaces/node_environments.Environments.html index 8e4b24efec..06b21f2442 100644 --- a/docs/api/cli-kit/interfaces/node_environments.Environments.html +++ b/docs/api/cli-kit/interfaces/node_environments.Environments.html @@ -1 +1 @@ -Environments | @shopify/cli-kit

      Interface Environments

      interface Environments {
          [name: string]: JsonMap;
      }

      Indexable

      [name: string]: JsonMap

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Environments | @shopify/cli-kit

      Interface Environments

      interface Environments {
          [name: string]: JsonMap;
      }

      Indexable

      [name: string]: JsonMap

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_fs.MatchGlobOptions.html b/docs/api/cli-kit/interfaces/node_fs.MatchGlobOptions.html index 752f5de720..d3d81f7c71 100644 --- a/docs/api/cli-kit/interfaces/node_fs.MatchGlobOptions.html +++ b/docs/api/cli-kit/interfaces/node_fs.MatchGlobOptions.html @@ -1,2 +1,2 @@ -MatchGlobOptions | @shopify/cli-kit

      Interface MatchGlobOptions

      interface MatchGlobOptions {
          matchBase: boolean;
      }

      Properties

      matchBase -

      Properties

      matchBase

      matchBase: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      matchBase
      \ No newline at end of file +MatchGlobOptions | @shopify/cli-kit

      Interface MatchGlobOptions

      interface MatchGlobOptions {
          matchBase: boolean;
      }

      Properties

      matchBase +

      Properties

      matchBase

      matchBase: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      matchBase
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_fs.WriteOptions.html b/docs/api/cli-kit/interfaces/node_fs.WriteOptions.html index 9f0b8f5244..35fcff7afe 100644 --- a/docs/api/cli-kit/interfaces/node_fs.WriteOptions.html +++ b/docs/api/cli-kit/interfaces/node_fs.WriteOptions.html @@ -1,2 +1,2 @@ -WriteOptions | @shopify/cli-kit

      Interface WriteOptions

      interface WriteOptions {
          encoding: BufferEncoding;
      }

      Properties

      encoding -

      Properties

      encoding

      encoding: BufferEncoding

      Settings

      Member Visibility

      Theme

      On This Page

      encoding
      \ No newline at end of file +WriteOptions | @shopify/cli-kit

      Interface WriteOptions

      interface WriteOptions {
          encoding: BufferEncoding;
      }

      Properties

      encoding +

      Properties

      encoding

      encoding: BufferEncoding

      Settings

      Member Visibility

      Theme

      On This Page

      encoding
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_git.CreateGitCommitOptions.html b/docs/api/cli-kit/interfaces/node_git.CreateGitCommitOptions.html index 300176e2d3..1b74b51332 100644 --- a/docs/api/cli-kit/interfaces/node_git.CreateGitCommitOptions.html +++ b/docs/api/cli-kit/interfaces/node_git.CreateGitCommitOptions.html @@ -1,3 +1,3 @@ -CreateGitCommitOptions | @shopify/cli-kit

      Interface CreateGitCommitOptions

      interface CreateGitCommitOptions {
          author?: string;
          directory?: string;
      }

      Properties

      author? +CreateGitCommitOptions | @shopify/cli-kit

      Interface CreateGitCommitOptions

      interface CreateGitCommitOptions {
          author?: string;
          directory?: string;
      }

      Properties

      author? directory? -

      Properties

      Optional author

      author?: string

      Optional directory

      directory?: string

      Settings

      Member Visibility

      Theme

      On This Page

      authordirectory
      \ No newline at end of file +

      Properties

      Optional author

      author?: string

      Optional directory

      directory?: string

      Settings

      Member Visibility

      Theme

      On This Page

      authordirectory
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_git.GitCloneOptions.html b/docs/api/cli-kit/interfaces/node_git.GitCloneOptions.html index 42ede19293..d87fcd4d70 100644 --- a/docs/api/cli-kit/interfaces/node_git.GitCloneOptions.html +++ b/docs/api/cli-kit/interfaces/node_git.GitCloneOptions.html @@ -4,9 +4,9 @@

      Param: destination

      The directory where the repository will be cloned.

      Param: progressUpdater

      A function that will be called with the progress of the clone.

      Param: shallow

      Whether to clone the repository shallowly.

      Param: latestTag

      Whether to clone the latest tag instead of the default branch.

      -
      interface GitCloneOptions {
          destination: string;
          latestTag?: boolean;
          progressUpdater?: ((statusString) => void);
          repoUrl: string;
          shallow?: boolean;
      }

      Properties

      destination +
      interface GitCloneOptions {
          destination: string;
          latestTag?: boolean;
          progressUpdater?: ((statusString) => void);
          repoUrl: string;
          shallow?: boolean;
      }

      Properties

      destination latestTag? progressUpdater? repoUrl shallow? -

      Properties

      destination

      destination: string

      Optional latestTag

      latestTag?: boolean

      Optional progressUpdater

      progressUpdater?: ((statusString) => void)

      Type declaration

        • (statusString): void

        • Parameters

          • statusString: string

          Returns void

      repoUrl

      repoUrl: string

      Optional shallow

      shallow?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      destinationlatestTagprogressUpdaterrepoUrlshallow
      \ No newline at end of file +

      Properties

      destination

      destination: string

      Optional latestTag

      latestTag?: boolean

      Optional progressUpdater

      progressUpdater?: ((statusString) => void)

      Type declaration

        • (statusString): void

        • Parameters

          • statusString: string

          Returns void

      repoUrl

      repoUrl: string

      Optional shallow

      shallow?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      destinationlatestTagprogressUpdaterrepoUrlshallow
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_git.GitIgnoreTemplate.html b/docs/api/cli-kit/interfaces/node_git.GitIgnoreTemplate.html index 40d55e4cab..870eb5afc4 100644 --- a/docs/api/cli-kit/interfaces/node_git.GitIgnoreTemplate.html +++ b/docs/api/cli-kit/interfaces/node_git.GitIgnoreTemplate.html @@ -1 +1 @@ -GitIgnoreTemplate | @shopify/cli-kit

      Interface GitIgnoreTemplate

      interface GitIgnoreTemplate {
          [section: string]: string[];
      }

      Indexable

      [section: string]: string[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +GitIgnoreTemplate | @shopify/cli-kit

      Interface GitIgnoreTemplate

      interface GitIgnoreTemplate {
          [section: string]: string[];
      }

      Indexable

      [section: string]: string[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_github.GithubRelease.html b/docs/api/cli-kit/interfaces/node_github.GithubRelease.html index e672503552..87f123e3af 100644 --- a/docs/api/cli-kit/interfaces/node_github.GithubRelease.html +++ b/docs/api/cli-kit/interfaces/node_github.GithubRelease.html @@ -1,4 +1,4 @@ -GithubRelease | @shopify/cli-kit

      Interface GithubRelease

      interface GithubRelease {
          body: string;
          created_at: string;
          draft: boolean;
          id: number;
          name: string;
          prerelease: boolean;
          published_at: string;
          tag_name: string;
          tarball_url: string;
          url: string;
      }

      Properties

      body +GithubRelease | @shopify/cli-kit

      Interface GithubRelease

      interface GithubRelease {
          body: string;
          created_at: string;
          draft: boolean;
          id: number;
          name: string;
          prerelease: boolean;
          published_at: string;
          tag_name: string;
          tarball_url: string;
          url: string;
      }

      Properties

      body created_at draft id @@ -8,4 +8,4 @@ tag_name tarball_url url -

      Properties

      body

      body: string

      created_at

      created_at: string

      draft

      draft: boolean

      id

      id: number

      name

      name: string

      prerelease

      prerelease: boolean

      published_at

      published_at: string

      tag_name

      tag_name: string

      tarball_url

      tarball_url: string

      url

      url: string

      Settings

      Member Visibility

      Theme

      On This Page

      bodycreated_atdraftidnameprereleasepublished_attag_nametarball_urlurl
      \ No newline at end of file +

      Properties

      body

      body: string

      created_at

      created_at: string

      draft

      draft: boolean

      id

      id: number

      name

      name: string

      prerelease

      prerelease: boolean

      published_at

      published_at: string

      tag_name

      tag_name: string

      tarball_url

      tarball_url: string

      url

      url: string

      Settings

      Member Visibility

      Theme

      On This Page

      bodycreated_atdraftidnameprereleasepublished_attag_nametarball_urlurl
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_github.GithubRepositoryReference.html b/docs/api/cli-kit/interfaces/node_github.GithubRepositoryReference.html index 52ba35aa39..8c3758ba30 100644 --- a/docs/api/cli-kit/interfaces/node_github.GithubRepositoryReference.html +++ b/docs/api/cli-kit/interfaces/node_github.GithubRepositoryReference.html @@ -1,4 +1,4 @@ -GithubRepositoryReference | @shopify/cli-kit

      Interface GithubRepositoryReference

      interface GithubRepositoryReference {
          baseURL: string;
          branch?: string;
          filePath?: string;
      }

      Properties

      baseURL +GithubRepositoryReference | @shopify/cli-kit

      Interface GithubRepositoryReference

      interface GithubRepositoryReference {
          baseURL: string;
          branch?: string;
          filePath?: string;
      }

      Properties

      baseURL branch? filePath? -

      Properties

      baseURL

      baseURL: string

      Optional branch

      branch?: string

      Optional filePath

      filePath?: string

      Settings

      Member Visibility

      Theme

      On This Page

      baseURLbranchfilePath
      \ No newline at end of file +

      Properties

      baseURL

      baseURL: string

      Optional branch

      branch?: string

      Optional filePath

      filePath?: string

      Settings

      Member Visibility

      Theme

      On This Page

      baseURLbranchfilePath
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_hooks_prerun.CommandContent.html b/docs/api/cli-kit/interfaces/node_hooks_prerun.CommandContent.html index 0420476413..4302dcf4f4 100644 --- a/docs/api/cli-kit/interfaces/node_hooks_prerun.CommandContent.html +++ b/docs/api/cli-kit/interfaces/node_hooks_prerun.CommandContent.html @@ -1,4 +1,4 @@ -CommandContent | @shopify/cli-kit

      Interface CommandContent

      interface CommandContent {
          alias?: string;
          command: string;
          topic?: string;
      }

      Properties

      alias? +CommandContent | @shopify/cli-kit

      Interface CommandContent

      interface CommandContent {
          alias?: string;
          command: string;
          topic?: string;
      }

      Properties

      alias? command topic? -

      Properties

      Optional alias

      alias?: string

      command

      command: string

      Optional topic

      topic?: string

      Settings

      Member Visibility

      Theme

      On This Page

      aliascommandtopic
      \ No newline at end of file +

      Properties

      Optional alias

      alias?: string

      command

      command: string

      Optional topic

      topic?: string

      Settings

      Member Visibility

      Theme

      On This Page

      aliascommandtopic
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_is_global.InstallGlobalCLIPromptResult.html b/docs/api/cli-kit/interfaces/node_is_global.InstallGlobalCLIPromptResult.html index 59de6ea875..214f1e1eb0 100644 --- a/docs/api/cli-kit/interfaces/node_is_global.InstallGlobalCLIPromptResult.html +++ b/docs/api/cli-kit/interfaces/node_is_global.InstallGlobalCLIPromptResult.html @@ -1,3 +1,3 @@ -InstallGlobalCLIPromptResult | @shopify/cli-kit

      Interface InstallGlobalCLIPromptResult

      interface InstallGlobalCLIPromptResult {
          alreadyInstalled: boolean;
          install: boolean;
      }

      Properties

      alreadyInstalled +InstallGlobalCLIPromptResult | @shopify/cli-kit

      Interface InstallGlobalCLIPromptResult

      interface InstallGlobalCLIPromptResult {
          alreadyInstalled: boolean;
          install: boolean;
      }

      Properties

      alreadyInstalled install -

      Properties

      alreadyInstalled

      alreadyInstalled: boolean

      install

      install: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      alreadyInstalledinstall
      \ No newline at end of file +

      Properties

      alreadyInstalled

      alreadyInstalled: boolean

      install

      install: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      alreadyInstalledinstall
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_metadata.RuntimeMetadataManager.html b/docs/api/cli-kit/interfaces/node_metadata.RuntimeMetadataManager.html index f973ddda30..a56412f30d 100644 --- a/docs/api/cli-kit/interfaces/node_metadata.RuntimeMetadataManager.html +++ b/docs/api/cli-kit/interfaces/node_metadata.RuntimeMetadataManager.html @@ -1,12 +1,12 @@ -RuntimeMetadataManager | @shopify/cli-kit

      Interface RuntimeMetadataManager<TPublic, TSensitive>

      interface RuntimeMetadataManager<TPublic, TSensitive> {
          addPublicMetadata: ((getData, onError?) => Promise<void>);
          addSensitiveMetadata: ((getData, onError?) => Promise<void>);
          getAllPublicMetadata: (() => Partial<TPublic>);
          getAllSensitiveMetadata: (() => Partial<TSensitive>);
          runWithTimer: ((field) => (<T>(fn) => Promise<T>));
      }

      Type Parameters

      • TPublic extends AnyJson
      • TSensitive extends AnyJson

      Properties

      addPublicMetadata +RuntimeMetadataManager | @shopify/cli-kit

      Interface RuntimeMetadataManager<TPublic, TSensitive>

      interface RuntimeMetadataManager<TPublic, TSensitive> {
          addPublicMetadata: ((getData, onError?) => Promise<void>);
          addSensitiveMetadata: ((getData, onError?) => Promise<void>);
          getAllPublicMetadata: (() => Partial<TPublic>);
          getAllSensitiveMetadata: (() => Partial<TSensitive>);
          runWithTimer: ((field) => (<T>(fn) => Promise<T>));
      }

      Type Parameters

      • TPublic extends AnyJson
      • TSensitive extends AnyJson

      Properties

      addPublicMetadata addSensitiveMetadata getAllPublicMetadata getAllSensitiveMetadata runWithTimer

      Properties

      addPublicMetadata

      addPublicMetadata: ((getData, onError?) => Promise<void>)

      Add some public metadata -- this should not contain any PII.

      -

      Type declaration

        • (getData, onError?): Promise<void>

        • Parameters

          • getData: ProvideMetadata<TPublic>
          • Optional onError: MetadataErrorHandling

          Returns Promise<void>

      addSensitiveMetadata

      addSensitiveMetadata: ((getData, onError?) => Promise<void>)

      Add some potentially sensitive metadata -- this may include PII, but unnecessary data should never be tracked +

      Type declaration

        • (getData, onError?): Promise<void>

        • Parameters

          • getData: ProvideMetadata<TPublic>
          • Optional onError: MetadataErrorHandling

          Returns Promise<void>

      addSensitiveMetadata

      addSensitiveMetadata: ((getData, onError?) => Promise<void>)

      Add some potentially sensitive metadata -- this may include PII, but unnecessary data should never be tracked (this is a good fit for command args for instance).

      -

      Type declaration

        • (getData, onError?): Promise<void>

        • Parameters

          • getData: ProvideMetadata<TSensitive>
          • Optional onError: MetadataErrorHandling

          Returns Promise<void>

      getAllPublicMetadata

      getAllPublicMetadata: (() => Partial<TPublic>)

      Get a snapshot of the tracked public data.

      -

      Type declaration

      getAllSensitiveMetadata

      getAllSensitiveMetadata: (() => Partial<TSensitive>)

      Get a snapshot of the tracked sensitive data.

      -

      Type declaration

      runWithTimer

      runWithTimer: ((field) => (<T>(fn) => Promise<T>))

      Run a function, monitoring how long it takes, and adding the elapsed time to a running total.

      -

      Type declaration

        • (field): (<T>(fn) => Promise<T>)

        • Parameters

          Returns (<T>(fn) => Promise<T>)

            • <T>(fn): Promise<T>

            • Type Parameters

              • T

              Parameters

              • fn: (() => Promise<T>)
                  • (): Promise<T>

                  • Returns Promise<T>

              Returns Promise<T>

      Settings

      Member Visibility

      Theme

      On This Page

      addPublicMetadataaddSensitiveMetadatagetAllPublicMetadatagetAllSensitiveMetadatarunWithTimer
      \ No newline at end of file +

      Type declaration

        • (getData, onError?): Promise<void>

        • Parameters

          • getData: ProvideMetadata<TSensitive>
          • Optional onError: MetadataErrorHandling

          Returns Promise<void>

      getAllPublicMetadata

      getAllPublicMetadata: (() => Partial<TPublic>)

      Get a snapshot of the tracked public data.

      +

      Type declaration

      getAllSensitiveMetadata

      getAllSensitiveMetadata: (() => Partial<TSensitive>)

      Get a snapshot of the tracked sensitive data.

      +

      Type declaration

      runWithTimer

      runWithTimer: ((field) => (<T>(fn) => Promise<T>))

      Run a function, monitoring how long it takes, and adding the elapsed time to a running total.

      +

      Type declaration

        • (field): (<T>(fn) => Promise<T>)

        • Parameters

          Returns (<T>(fn) => Promise<T>)

            • <T>(fn): Promise<T>

            • Type Parameters

              • T

              Parameters

              • fn: (() => Promise<T>)
                  • (): Promise<T>

                  • Returns Promise<T>

              Returns Promise<T>

      Settings

      Member Visibility

      Theme

      On This Page

      addPublicMetadataaddSensitiveMetadatagetAllPublicMetadatagetAllSensitiveMetadatarunWithTimer
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_monorail.Schemas.html b/docs/api/cli-kit/interfaces/node_monorail.Schemas.html index b3512b4e64..bf1d7a49aa 100644 --- a/docs/api/cli-kit/interfaces/node_monorail.Schemas.html +++ b/docs/api/cli-kit/interfaces/node_monorail.Schemas.html @@ -1,2 +1,2 @@ -Schemas | @shopify/cli-kit

      Interface Schemas

      interface Schemas {
          app_cli3_command/1.12: {
              public: {
                  api_key?: Optional<string>;
                  app_extensions_any?: Optional<boolean>;
                  app_extensions_breakdown?: Optional<string>;
                  app_extensions_count?: Optional<number>;
                  app_extensions_custom_layout?: Optional<boolean>;
                  app_extensions_function_any?: Optional<boolean>;
                  app_extensions_function_count?: Optional<number>;
                  app_extensions_function_custom_layout?: Optional<boolean>;
                  app_extensions_theme_any?: Optional<boolean>;
                  app_extensions_theme_count?: Optional<number>;
                  app_extensions_theme_custom_layout?: Optional<boolean>;
                  app_extensions_ui_any?: Optional<boolean>;
                  app_extensions_ui_count?: Optional<number>;
                  app_extensions_ui_custom_layout?: Optional<boolean>;
                  app_name_hash?: Optional<string>;
                  app_path_hash?: Optional<string>;
                  app_scopes?: Optional<string>;
                  app_web_backend_any?: Optional<boolean>;
                  app_web_backend_count?: Optional<number>;
                  app_web_custom_layout?: Optional<boolean>;
                  app_web_framework?: Optional<string>;
                  app_web_frontend_any?: Optional<boolean>;
                  app_web_frontend_count?: Optional<number>;
                  cli_version: string;
                  cmd_all_alias_used?: Optional<string>;
                  cmd_all_exit?: Optional<string>;
                  cmd_all_force?: Optional<boolean>;
                  cmd_all_launcher?: Optional<string>;
                  cmd_all_path_override?: Optional<boolean>;
                  cmd_all_path_override_hash?: Optional<string>;
                  cmd_all_plugin?: Optional<string>;
                  cmd_all_timing_active_ms?: Optional<number>;
                  cmd_all_timing_network_ms?: Optional<number>;
                  cmd_all_timing_prompts_ms?: Optional<number>;
                  cmd_all_topic?: Optional<string>;
                  cmd_all_verbose?: Optional<boolean>;
                  cmd_app_all_configs_any?: Optional<boolean>;
                  cmd_app_all_configs_clients?: Optional<string>;
                  cmd_app_dependency_installation_skipped?: Optional<boolean>;
                  cmd_app_deployment_mode?: Optional<string>;
                  cmd_app_linked_config_git_tracked?: Optional<boolean>;
                  cmd_app_linked_config_name?: Optional<string>;
                  cmd_app_linked_config_source?: Optional<string>;
                  cmd_app_linked_config_used?: Optional<boolean>;
                  cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>;
                  cmd_app_reset_used?: Optional<boolean>;
                  cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>;
                  cmd_create_app_template?: Optional<string>;
                  cmd_create_app_template_url?: Optional<string>;
                  cmd_deploy_config_modules_added?: Optional<string>;
                  cmd_deploy_config_modules_breakdown?: Optional<string>;
                  cmd_deploy_config_modules_deleted?: Optional<string>;
                  cmd_deploy_config_modules_updated?: Optional<string>;
                  cmd_deploy_confirm_cancelled?: Optional<boolean>;
                  cmd_deploy_confirm_include_config_used?: Optional<boolean>;
                  cmd_deploy_confirm_new_registrations?: Optional<number>;
                  cmd_deploy_confirm_removed_registrations?: Optional<number>;
                  cmd_deploy_confirm_time_to_complete_ms?: Optional<number>;
                  cmd_deploy_confirm_updated_registrations?: Optional<number>;
                  cmd_deploy_flag_message_used?: Optional<boolean>;
                  cmd_deploy_flag_source_url_used?: Optional<boolean>;
                  cmd_deploy_flag_version_used?: Optional<boolean>;
                  cmd_deploy_include_config_used?: Optional<boolean>;
                  cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>;
                  cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>;
                  cmd_dev_dev_preview_toggle_used?: Optional<boolean>;
                  cmd_dev_graphiql_opened?: Optional<boolean>;
                  cmd_dev_preview_url_opened?: Optional<boolean>;
                  cmd_dev_tunnel_custom_hash?: Optional<string>;
                  cmd_dev_tunnel_type?: Optional<string>;
                  cmd_dev_urls_updated?: Optional<boolean>;
                  cmd_extensions_binary_from_source?: Optional<boolean>;
                  cmd_release_confirm_cancelled?: Optional<boolean>;
                  cmd_scaffold_required_auth?: Optional<boolean>;
                  cmd_scaffold_template_custom?: Optional<boolean>;
                  cmd_scaffold_template_flavor?: Optional<string>;
                  cmd_scaffold_type?: Optional<string>;
                  cmd_scaffold_type_category?: Optional<string>;
                  cmd_scaffold_type_gated?: Optional<boolean>;
                  cmd_scaffold_type_owner?: Optional<string>;
                  cmd_scaffold_used_prompts_for_type?: Optional<boolean>;
                  command: string;
                  env_ci?: Optional<boolean>;
                  env_ci_platform?: Optional<string>;
                  env_cloud?: Optional<string>;
                  env_device_id?: Optional<string>;
                  env_is_global?: Optional<boolean>;
                  env_package_manager?: Optional<string>;
                  env_package_manager_workspaces?: Optional<boolean>;
                  env_plugin_installed_any_custom?: Optional<boolean>;
                  env_plugin_installed_shopify?: Optional<string>;
                  env_shell?: Optional<string>;
                  env_web_ide?: Optional<string>;
                  is_employee: boolean;
                  node_version: string;
                  partner_id?: Optional<number>;
                  project_type?: Optional<string>;
                  ruby_version: string;
                  store_fqdn_hash?: Optional<string>;
                  success: boolean;
                  time_end: number;
                  time_start: number;
                  total_time: number;
                  uname: string;
              };
              sensitive: {
                  app_name?: Optional<string>;
                  args: string;
                  cmd_all_environment_flags?: Optional<string>;
                  cmd_dev_tunnel_custom?: Optional<string>;
                  env_plugin_installed_all?: Optional<string>;
                  error_message?: Optional<string>;
                  metadata?: Optional<string>;
                  store_fqdn?: Optional<string>;
              };
          };
          [schemaId: string]: {
              public: JsonMap;
              sensitive: JsonMap;
          };
      }

      Indexable

      [schemaId: string]: {
          public: JsonMap;
          sensitive: JsonMap;
      }
      • public: JsonMap
      • sensitive: JsonMap

      Properties

      app_cli3_command/1.12 -

      Properties

      app_cli3_command/1.12

      app_cli3_command/1.12: {
          public: {
              api_key?: Optional<string>;
              app_extensions_any?: Optional<boolean>;
              app_extensions_breakdown?: Optional<string>;
              app_extensions_count?: Optional<number>;
              app_extensions_custom_layout?: Optional<boolean>;
              app_extensions_function_any?: Optional<boolean>;
              app_extensions_function_count?: Optional<number>;
              app_extensions_function_custom_layout?: Optional<boolean>;
              app_extensions_theme_any?: Optional<boolean>;
              app_extensions_theme_count?: Optional<number>;
              app_extensions_theme_custom_layout?: Optional<boolean>;
              app_extensions_ui_any?: Optional<boolean>;
              app_extensions_ui_count?: Optional<number>;
              app_extensions_ui_custom_layout?: Optional<boolean>;
              app_name_hash?: Optional<string>;
              app_path_hash?: Optional<string>;
              app_scopes?: Optional<string>;
              app_web_backend_any?: Optional<boolean>;
              app_web_backend_count?: Optional<number>;
              app_web_custom_layout?: Optional<boolean>;
              app_web_framework?: Optional<string>;
              app_web_frontend_any?: Optional<boolean>;
              app_web_frontend_count?: Optional<number>;
              cli_version: string;
              cmd_all_alias_used?: Optional<string>;
              cmd_all_exit?: Optional<string>;
              cmd_all_force?: Optional<boolean>;
              cmd_all_launcher?: Optional<string>;
              cmd_all_path_override?: Optional<boolean>;
              cmd_all_path_override_hash?: Optional<string>;
              cmd_all_plugin?: Optional<string>;
              cmd_all_timing_active_ms?: Optional<number>;
              cmd_all_timing_network_ms?: Optional<number>;
              cmd_all_timing_prompts_ms?: Optional<number>;
              cmd_all_topic?: Optional<string>;
              cmd_all_verbose?: Optional<boolean>;
              cmd_app_all_configs_any?: Optional<boolean>;
              cmd_app_all_configs_clients?: Optional<string>;
              cmd_app_dependency_installation_skipped?: Optional<boolean>;
              cmd_app_deployment_mode?: Optional<string>;
              cmd_app_linked_config_git_tracked?: Optional<boolean>;
              cmd_app_linked_config_name?: Optional<string>;
              cmd_app_linked_config_source?: Optional<string>;
              cmd_app_linked_config_used?: Optional<boolean>;
              cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>;
              cmd_app_reset_used?: Optional<boolean>;
              cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>;
              cmd_create_app_template?: Optional<string>;
              cmd_create_app_template_url?: Optional<string>;
              cmd_deploy_config_modules_added?: Optional<string>;
              cmd_deploy_config_modules_breakdown?: Optional<string>;
              cmd_deploy_config_modules_deleted?: Optional<string>;
              cmd_deploy_config_modules_updated?: Optional<string>;
              cmd_deploy_confirm_cancelled?: Optional<boolean>;
              cmd_deploy_confirm_include_config_used?: Optional<boolean>;
              cmd_deploy_confirm_new_registrations?: Optional<number>;
              cmd_deploy_confirm_removed_registrations?: Optional<number>;
              cmd_deploy_confirm_time_to_complete_ms?: Optional<number>;
              cmd_deploy_confirm_updated_registrations?: Optional<number>;
              cmd_deploy_flag_message_used?: Optional<boolean>;
              cmd_deploy_flag_source_url_used?: Optional<boolean>;
              cmd_deploy_flag_version_used?: Optional<boolean>;
              cmd_deploy_include_config_used?: Optional<boolean>;
              cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>;
              cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>;
              cmd_dev_dev_preview_toggle_used?: Optional<boolean>;
              cmd_dev_graphiql_opened?: Optional<boolean>;
              cmd_dev_preview_url_opened?: Optional<boolean>;
              cmd_dev_tunnel_custom_hash?: Optional<string>;
              cmd_dev_tunnel_type?: Optional<string>;
              cmd_dev_urls_updated?: Optional<boolean>;
              cmd_extensions_binary_from_source?: Optional<boolean>;
              cmd_release_confirm_cancelled?: Optional<boolean>;
              cmd_scaffold_required_auth?: Optional<boolean>;
              cmd_scaffold_template_custom?: Optional<boolean>;
              cmd_scaffold_template_flavor?: Optional<string>;
              cmd_scaffold_type?: Optional<string>;
              cmd_scaffold_type_category?: Optional<string>;
              cmd_scaffold_type_gated?: Optional<boolean>;
              cmd_scaffold_type_owner?: Optional<string>;
              cmd_scaffold_used_prompts_for_type?: Optional<boolean>;
              command: string;
              env_ci?: Optional<boolean>;
              env_ci_platform?: Optional<string>;
              env_cloud?: Optional<string>;
              env_device_id?: Optional<string>;
              env_is_global?: Optional<boolean>;
              env_package_manager?: Optional<string>;
              env_package_manager_workspaces?: Optional<boolean>;
              env_plugin_installed_any_custom?: Optional<boolean>;
              env_plugin_installed_shopify?: Optional<string>;
              env_shell?: Optional<string>;
              env_web_ide?: Optional<string>;
              is_employee: boolean;
              node_version: string;
              partner_id?: Optional<number>;
              project_type?: Optional<string>;
              ruby_version: string;
              store_fqdn_hash?: Optional<string>;
              success: boolean;
              time_end: number;
              time_start: number;
              total_time: number;
              uname: string;
          };
          sensitive: {
              app_name?: Optional<string>;
              args: string;
              cmd_all_environment_flags?: Optional<string>;
              cmd_dev_tunnel_custom?: Optional<string>;
              env_plugin_installed_all?: Optional<string>;
              error_message?: Optional<string>;
              metadata?: Optional<string>;
              store_fqdn?: Optional<string>;
          };
      }

      Type declaration

      • public: {
            api_key?: Optional<string>;
            app_extensions_any?: Optional<boolean>;
            app_extensions_breakdown?: Optional<string>;
            app_extensions_count?: Optional<number>;
            app_extensions_custom_layout?: Optional<boolean>;
            app_extensions_function_any?: Optional<boolean>;
            app_extensions_function_count?: Optional<number>;
            app_extensions_function_custom_layout?: Optional<boolean>;
            app_extensions_theme_any?: Optional<boolean>;
            app_extensions_theme_count?: Optional<number>;
            app_extensions_theme_custom_layout?: Optional<boolean>;
            app_extensions_ui_any?: Optional<boolean>;
            app_extensions_ui_count?: Optional<number>;
            app_extensions_ui_custom_layout?: Optional<boolean>;
            app_name_hash?: Optional<string>;
            app_path_hash?: Optional<string>;
            app_scopes?: Optional<string>;
            app_web_backend_any?: Optional<boolean>;
            app_web_backend_count?: Optional<number>;
            app_web_custom_layout?: Optional<boolean>;
            app_web_framework?: Optional<string>;
            app_web_frontend_any?: Optional<boolean>;
            app_web_frontend_count?: Optional<number>;
            cli_version: string;
            cmd_all_alias_used?: Optional<string>;
            cmd_all_exit?: Optional<string>;
            cmd_all_force?: Optional<boolean>;
            cmd_all_launcher?: Optional<string>;
            cmd_all_path_override?: Optional<boolean>;
            cmd_all_path_override_hash?: Optional<string>;
            cmd_all_plugin?: Optional<string>;
            cmd_all_timing_active_ms?: Optional<number>;
            cmd_all_timing_network_ms?: Optional<number>;
            cmd_all_timing_prompts_ms?: Optional<number>;
            cmd_all_topic?: Optional<string>;
            cmd_all_verbose?: Optional<boolean>;
            cmd_app_all_configs_any?: Optional<boolean>;
            cmd_app_all_configs_clients?: Optional<string>;
            cmd_app_dependency_installation_skipped?: Optional<boolean>;
            cmd_app_deployment_mode?: Optional<string>;
            cmd_app_linked_config_git_tracked?: Optional<boolean>;
            cmd_app_linked_config_name?: Optional<string>;
            cmd_app_linked_config_source?: Optional<string>;
            cmd_app_linked_config_used?: Optional<boolean>;
            cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>;
            cmd_app_reset_used?: Optional<boolean>;
            cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>;
            cmd_create_app_template?: Optional<string>;
            cmd_create_app_template_url?: Optional<string>;
            cmd_deploy_config_modules_added?: Optional<string>;
            cmd_deploy_config_modules_breakdown?: Optional<string>;
            cmd_deploy_config_modules_deleted?: Optional<string>;
            cmd_deploy_config_modules_updated?: Optional<string>;
            cmd_deploy_confirm_cancelled?: Optional<boolean>;
            cmd_deploy_confirm_include_config_used?: Optional<boolean>;
            cmd_deploy_confirm_new_registrations?: Optional<number>;
            cmd_deploy_confirm_removed_registrations?: Optional<number>;
            cmd_deploy_confirm_time_to_complete_ms?: Optional<number>;
            cmd_deploy_confirm_updated_registrations?: Optional<number>;
            cmd_deploy_flag_message_used?: Optional<boolean>;
            cmd_deploy_flag_source_url_used?: Optional<boolean>;
            cmd_deploy_flag_version_used?: Optional<boolean>;
            cmd_deploy_include_config_used?: Optional<boolean>;
            cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>;
            cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>;
            cmd_dev_dev_preview_toggle_used?: Optional<boolean>;
            cmd_dev_graphiql_opened?: Optional<boolean>;
            cmd_dev_preview_url_opened?: Optional<boolean>;
            cmd_dev_tunnel_custom_hash?: Optional<string>;
            cmd_dev_tunnel_type?: Optional<string>;
            cmd_dev_urls_updated?: Optional<boolean>;
            cmd_extensions_binary_from_source?: Optional<boolean>;
            cmd_release_confirm_cancelled?: Optional<boolean>;
            cmd_scaffold_required_auth?: Optional<boolean>;
            cmd_scaffold_template_custom?: Optional<boolean>;
            cmd_scaffold_template_flavor?: Optional<string>;
            cmd_scaffold_type?: Optional<string>;
            cmd_scaffold_type_category?: Optional<string>;
            cmd_scaffold_type_gated?: Optional<boolean>;
            cmd_scaffold_type_owner?: Optional<string>;
            cmd_scaffold_used_prompts_for_type?: Optional<boolean>;
            command: string;
            env_ci?: Optional<boolean>;
            env_ci_platform?: Optional<string>;
            env_cloud?: Optional<string>;
            env_device_id?: Optional<string>;
            env_is_global?: Optional<boolean>;
            env_package_manager?: Optional<string>;
            env_package_manager_workspaces?: Optional<boolean>;
            env_plugin_installed_any_custom?: Optional<boolean>;
            env_plugin_installed_shopify?: Optional<string>;
            env_shell?: Optional<string>;
            env_web_ide?: Optional<string>;
            is_employee: boolean;
            node_version: string;
            partner_id?: Optional<number>;
            project_type?: Optional<string>;
            ruby_version: string;
            store_fqdn_hash?: Optional<string>;
            success: boolean;
            time_end: number;
            time_start: number;
            total_time: number;
            uname: string;
        }
        • Optional api_key?: Optional<string>
        • Optional app_extensions_any?: Optional<boolean>
        • Optional app_extensions_breakdown?: Optional<string>
        • Optional app_extensions_count?: Optional<number>
        • Optional app_extensions_custom_layout?: Optional<boolean>
        • Optional app_extensions_function_any?: Optional<boolean>
        • Optional app_extensions_function_count?: Optional<number>
        • Optional app_extensions_function_custom_layout?: Optional<boolean>
        • Optional app_extensions_theme_any?: Optional<boolean>
        • Optional app_extensions_theme_count?: Optional<number>
        • Optional app_extensions_theme_custom_layout?: Optional<boolean>
        • Optional app_extensions_ui_any?: Optional<boolean>
        • Optional app_extensions_ui_count?: Optional<number>
        • Optional app_extensions_ui_custom_layout?: Optional<boolean>
        • Optional app_name_hash?: Optional<string>
        • Optional app_path_hash?: Optional<string>
        • Optional app_scopes?: Optional<string>
        • Optional app_web_backend_any?: Optional<boolean>
        • Optional app_web_backend_count?: Optional<number>
        • Optional app_web_custom_layout?: Optional<boolean>
        • Optional app_web_framework?: Optional<string>
        • Optional app_web_frontend_any?: Optional<boolean>
        • Optional app_web_frontend_count?: Optional<number>
        • cli_version: string
        • Optional cmd_all_alias_used?: Optional<string>
        • Optional cmd_all_exit?: Optional<string>
        • Optional cmd_all_force?: Optional<boolean>
        • Optional cmd_all_launcher?: Optional<string>
        • Optional cmd_all_path_override?: Optional<boolean>
        • Optional cmd_all_path_override_hash?: Optional<string>
        • Optional cmd_all_plugin?: Optional<string>
        • Optional cmd_all_timing_active_ms?: Optional<number>
        • Optional cmd_all_timing_network_ms?: Optional<number>
        • Optional cmd_all_timing_prompts_ms?: Optional<number>
        • Optional cmd_all_topic?: Optional<string>
        • Optional cmd_all_verbose?: Optional<boolean>
        • Optional cmd_app_all_configs_any?: Optional<boolean>
        • Optional cmd_app_all_configs_clients?: Optional<string>
        • Optional cmd_app_dependency_installation_skipped?: Optional<boolean>
        • Optional cmd_app_deployment_mode?: Optional<string>
        • Optional cmd_app_linked_config_git_tracked?: Optional<boolean>
        • Optional cmd_app_linked_config_name?: Optional<string>
        • Optional cmd_app_linked_config_source?: Optional<string>
        • Optional cmd_app_linked_config_used?: Optional<boolean>
        • Optional cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>
        • Optional cmd_app_reset_used?: Optional<boolean>
        • Optional cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>
        • Optional cmd_create_app_template?: Optional<string>
        • Optional cmd_create_app_template_url?: Optional<string>
        • Optional cmd_deploy_config_modules_added?: Optional<string>
        • Optional cmd_deploy_config_modules_breakdown?: Optional<string>
        • Optional cmd_deploy_config_modules_deleted?: Optional<string>
        • Optional cmd_deploy_config_modules_updated?: Optional<string>
        • Optional cmd_deploy_confirm_cancelled?: Optional<boolean>
        • Optional cmd_deploy_confirm_include_config_used?: Optional<boolean>
        • Optional cmd_deploy_confirm_new_registrations?: Optional<number>
        • Optional cmd_deploy_confirm_removed_registrations?: Optional<number>
        • Optional cmd_deploy_confirm_time_to_complete_ms?: Optional<number>
        • Optional cmd_deploy_confirm_updated_registrations?: Optional<number>
        • Optional cmd_deploy_flag_message_used?: Optional<boolean>
        • Optional cmd_deploy_flag_source_url_used?: Optional<boolean>
        • Optional cmd_deploy_flag_version_used?: Optional<boolean>
        • Optional cmd_deploy_include_config_used?: Optional<boolean>
        • Optional cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>
        • Optional cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>
        • Optional cmd_dev_dev_preview_toggle_used?: Optional<boolean>
        • Optional cmd_dev_graphiql_opened?: Optional<boolean>
        • Optional cmd_dev_preview_url_opened?: Optional<boolean>
        • Optional cmd_dev_tunnel_custom_hash?: Optional<string>
        • Optional cmd_dev_tunnel_type?: Optional<string>
        • Optional cmd_dev_urls_updated?: Optional<boolean>
        • Optional cmd_extensions_binary_from_source?: Optional<boolean>
        • Optional cmd_release_confirm_cancelled?: Optional<boolean>
        • Optional cmd_scaffold_required_auth?: Optional<boolean>
        • Optional cmd_scaffold_template_custom?: Optional<boolean>
        • Optional cmd_scaffold_template_flavor?: Optional<string>
        • Optional cmd_scaffold_type?: Optional<string>
        • Optional cmd_scaffold_type_category?: Optional<string>
        • Optional cmd_scaffold_type_gated?: Optional<boolean>
        • Optional cmd_scaffold_type_owner?: Optional<string>
        • Optional cmd_scaffold_used_prompts_for_type?: Optional<boolean>
        • command: string
        • Optional env_ci?: Optional<boolean>
        • Optional env_ci_platform?: Optional<string>
        • Optional env_cloud?: Optional<string>
        • Optional env_device_id?: Optional<string>
        • Optional env_is_global?: Optional<boolean>
        • Optional env_package_manager?: Optional<string>
        • Optional env_package_manager_workspaces?: Optional<boolean>
        • Optional env_plugin_installed_any_custom?: Optional<boolean>
        • Optional env_plugin_installed_shopify?: Optional<string>
        • Optional env_shell?: Optional<string>
        • Optional env_web_ide?: Optional<string>
        • is_employee: boolean
        • node_version: string
        • Optional partner_id?: Optional<number>
        • Optional project_type?: Optional<string>
        • ruby_version: string
        • Optional store_fqdn_hash?: Optional<string>
        • success: boolean
        • time_end: number
        • time_start: number
        • total_time: number
        • uname: string
      • sensitive: {
            app_name?: Optional<string>;
            args: string;
            cmd_all_environment_flags?: Optional<string>;
            cmd_dev_tunnel_custom?: Optional<string>;
            env_plugin_installed_all?: Optional<string>;
            error_message?: Optional<string>;
            metadata?: Optional<string>;
            store_fqdn?: Optional<string>;
        }
        • Optional app_name?: Optional<string>
        • args: string
        • Optional cmd_all_environment_flags?: Optional<string>
        • Optional cmd_dev_tunnel_custom?: Optional<string>
        • Optional env_plugin_installed_all?: Optional<string>
        • Optional error_message?: Optional<string>
        • Optional metadata?: Optional<string>
        • Optional store_fqdn?: Optional<string>

      Settings

      Member Visibility

      Theme

      On This Page

      app_cli3_command/1.12
      \ No newline at end of file +Schemas | @shopify/cli-kit

      Interface Schemas

      interface Schemas {
          app_cli3_command/1.12: {
              public: {
                  api_key?: Optional<string>;
                  app_extensions_any?: Optional<boolean>;
                  app_extensions_breakdown?: Optional<string>;
                  app_extensions_count?: Optional<number>;
                  app_extensions_custom_layout?: Optional<boolean>;
                  app_extensions_function_any?: Optional<boolean>;
                  app_extensions_function_count?: Optional<number>;
                  app_extensions_function_custom_layout?: Optional<boolean>;
                  app_extensions_theme_any?: Optional<boolean>;
                  app_extensions_theme_count?: Optional<number>;
                  app_extensions_theme_custom_layout?: Optional<boolean>;
                  app_extensions_ui_any?: Optional<boolean>;
                  app_extensions_ui_count?: Optional<number>;
                  app_extensions_ui_custom_layout?: Optional<boolean>;
                  app_name_hash?: Optional<string>;
                  app_path_hash?: Optional<string>;
                  app_scopes?: Optional<string>;
                  app_web_backend_any?: Optional<boolean>;
                  app_web_backend_count?: Optional<number>;
                  app_web_custom_layout?: Optional<boolean>;
                  app_web_framework?: Optional<string>;
                  app_web_frontend_any?: Optional<boolean>;
                  app_web_frontend_count?: Optional<number>;
                  cli_version: string;
                  cmd_all_alias_used?: Optional<string>;
                  cmd_all_exit?: Optional<string>;
                  cmd_all_force?: Optional<boolean>;
                  cmd_all_launcher?: Optional<string>;
                  cmd_all_path_override?: Optional<boolean>;
                  cmd_all_path_override_hash?: Optional<string>;
                  cmd_all_plugin?: Optional<string>;
                  cmd_all_timing_active_ms?: Optional<number>;
                  cmd_all_timing_network_ms?: Optional<number>;
                  cmd_all_timing_prompts_ms?: Optional<number>;
                  cmd_all_topic?: Optional<string>;
                  cmd_all_verbose?: Optional<boolean>;
                  cmd_app_all_configs_any?: Optional<boolean>;
                  cmd_app_all_configs_clients?: Optional<string>;
                  cmd_app_dependency_installation_skipped?: Optional<boolean>;
                  cmd_app_deployment_mode?: Optional<string>;
                  cmd_app_linked_config_git_tracked?: Optional<boolean>;
                  cmd_app_linked_config_name?: Optional<string>;
                  cmd_app_linked_config_source?: Optional<string>;
                  cmd_app_linked_config_used?: Optional<boolean>;
                  cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>;
                  cmd_app_reset_used?: Optional<boolean>;
                  cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>;
                  cmd_create_app_template?: Optional<string>;
                  cmd_create_app_template_url?: Optional<string>;
                  cmd_deploy_config_modules_added?: Optional<string>;
                  cmd_deploy_config_modules_breakdown?: Optional<string>;
                  cmd_deploy_config_modules_deleted?: Optional<string>;
                  cmd_deploy_config_modules_updated?: Optional<string>;
                  cmd_deploy_confirm_cancelled?: Optional<boolean>;
                  cmd_deploy_confirm_include_config_used?: Optional<boolean>;
                  cmd_deploy_confirm_new_registrations?: Optional<number>;
                  cmd_deploy_confirm_removed_registrations?: Optional<number>;
                  cmd_deploy_confirm_time_to_complete_ms?: Optional<number>;
                  cmd_deploy_confirm_updated_registrations?: Optional<number>;
                  cmd_deploy_flag_message_used?: Optional<boolean>;
                  cmd_deploy_flag_source_url_used?: Optional<boolean>;
                  cmd_deploy_flag_version_used?: Optional<boolean>;
                  cmd_deploy_include_config_used?: Optional<boolean>;
                  cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>;
                  cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>;
                  cmd_dev_dev_preview_toggle_used?: Optional<boolean>;
                  cmd_dev_graphiql_opened?: Optional<boolean>;
                  cmd_dev_preview_url_opened?: Optional<boolean>;
                  cmd_dev_tunnel_custom_hash?: Optional<string>;
                  cmd_dev_tunnel_type?: Optional<string>;
                  cmd_dev_urls_updated?: Optional<boolean>;
                  cmd_extensions_binary_from_source?: Optional<boolean>;
                  cmd_release_confirm_cancelled?: Optional<boolean>;
                  cmd_scaffold_required_auth?: Optional<boolean>;
                  cmd_scaffold_template_custom?: Optional<boolean>;
                  cmd_scaffold_template_flavor?: Optional<string>;
                  cmd_scaffold_type?: Optional<string>;
                  cmd_scaffold_type_category?: Optional<string>;
                  cmd_scaffold_type_gated?: Optional<boolean>;
                  cmd_scaffold_type_owner?: Optional<string>;
                  cmd_scaffold_used_prompts_for_type?: Optional<boolean>;
                  command: string;
                  env_ci?: Optional<boolean>;
                  env_ci_platform?: Optional<string>;
                  env_cloud?: Optional<string>;
                  env_device_id?: Optional<string>;
                  env_is_global?: Optional<boolean>;
                  env_package_manager?: Optional<string>;
                  env_package_manager_workspaces?: Optional<boolean>;
                  env_plugin_installed_any_custom?: Optional<boolean>;
                  env_plugin_installed_shopify?: Optional<string>;
                  env_shell?: Optional<string>;
                  env_web_ide?: Optional<string>;
                  is_employee: boolean;
                  node_version: string;
                  partner_id?: Optional<number>;
                  project_type?: Optional<string>;
                  ruby_version: string;
                  store_fqdn_hash?: Optional<string>;
                  success: boolean;
                  time_end: number;
                  time_start: number;
                  total_time: number;
                  uname: string;
              };
              sensitive: {
                  app_name?: Optional<string>;
                  args: string;
                  cmd_all_environment_flags?: Optional<string>;
                  cmd_dev_tunnel_custom?: Optional<string>;
                  env_plugin_installed_all?: Optional<string>;
                  error_message?: Optional<string>;
                  metadata?: Optional<string>;
                  store_fqdn?: Optional<string>;
              };
          };
          [schemaId: string]: {
              public: JsonMap;
              sensitive: JsonMap;
          };
      }

      Indexable

      [schemaId: string]: {
          public: JsonMap;
          sensitive: JsonMap;
      }
      • public: JsonMap
      • sensitive: JsonMap

      Properties

      app_cli3_command/1.12 +

      Properties

      app_cli3_command/1.12

      app_cli3_command/1.12: {
          public: {
              api_key?: Optional<string>;
              app_extensions_any?: Optional<boolean>;
              app_extensions_breakdown?: Optional<string>;
              app_extensions_count?: Optional<number>;
              app_extensions_custom_layout?: Optional<boolean>;
              app_extensions_function_any?: Optional<boolean>;
              app_extensions_function_count?: Optional<number>;
              app_extensions_function_custom_layout?: Optional<boolean>;
              app_extensions_theme_any?: Optional<boolean>;
              app_extensions_theme_count?: Optional<number>;
              app_extensions_theme_custom_layout?: Optional<boolean>;
              app_extensions_ui_any?: Optional<boolean>;
              app_extensions_ui_count?: Optional<number>;
              app_extensions_ui_custom_layout?: Optional<boolean>;
              app_name_hash?: Optional<string>;
              app_path_hash?: Optional<string>;
              app_scopes?: Optional<string>;
              app_web_backend_any?: Optional<boolean>;
              app_web_backend_count?: Optional<number>;
              app_web_custom_layout?: Optional<boolean>;
              app_web_framework?: Optional<string>;
              app_web_frontend_any?: Optional<boolean>;
              app_web_frontend_count?: Optional<number>;
              cli_version: string;
              cmd_all_alias_used?: Optional<string>;
              cmd_all_exit?: Optional<string>;
              cmd_all_force?: Optional<boolean>;
              cmd_all_launcher?: Optional<string>;
              cmd_all_path_override?: Optional<boolean>;
              cmd_all_path_override_hash?: Optional<string>;
              cmd_all_plugin?: Optional<string>;
              cmd_all_timing_active_ms?: Optional<number>;
              cmd_all_timing_network_ms?: Optional<number>;
              cmd_all_timing_prompts_ms?: Optional<number>;
              cmd_all_topic?: Optional<string>;
              cmd_all_verbose?: Optional<boolean>;
              cmd_app_all_configs_any?: Optional<boolean>;
              cmd_app_all_configs_clients?: Optional<string>;
              cmd_app_dependency_installation_skipped?: Optional<boolean>;
              cmd_app_deployment_mode?: Optional<string>;
              cmd_app_linked_config_git_tracked?: Optional<boolean>;
              cmd_app_linked_config_name?: Optional<string>;
              cmd_app_linked_config_source?: Optional<string>;
              cmd_app_linked_config_used?: Optional<boolean>;
              cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>;
              cmd_app_reset_used?: Optional<boolean>;
              cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>;
              cmd_create_app_template?: Optional<string>;
              cmd_create_app_template_url?: Optional<string>;
              cmd_deploy_config_modules_added?: Optional<string>;
              cmd_deploy_config_modules_breakdown?: Optional<string>;
              cmd_deploy_config_modules_deleted?: Optional<string>;
              cmd_deploy_config_modules_updated?: Optional<string>;
              cmd_deploy_confirm_cancelled?: Optional<boolean>;
              cmd_deploy_confirm_include_config_used?: Optional<boolean>;
              cmd_deploy_confirm_new_registrations?: Optional<number>;
              cmd_deploy_confirm_removed_registrations?: Optional<number>;
              cmd_deploy_confirm_time_to_complete_ms?: Optional<number>;
              cmd_deploy_confirm_updated_registrations?: Optional<number>;
              cmd_deploy_flag_message_used?: Optional<boolean>;
              cmd_deploy_flag_source_url_used?: Optional<boolean>;
              cmd_deploy_flag_version_used?: Optional<boolean>;
              cmd_deploy_include_config_used?: Optional<boolean>;
              cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>;
              cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>;
              cmd_dev_dev_preview_toggle_used?: Optional<boolean>;
              cmd_dev_graphiql_opened?: Optional<boolean>;
              cmd_dev_preview_url_opened?: Optional<boolean>;
              cmd_dev_tunnel_custom_hash?: Optional<string>;
              cmd_dev_tunnel_type?: Optional<string>;
              cmd_dev_urls_updated?: Optional<boolean>;
              cmd_extensions_binary_from_source?: Optional<boolean>;
              cmd_release_confirm_cancelled?: Optional<boolean>;
              cmd_scaffold_required_auth?: Optional<boolean>;
              cmd_scaffold_template_custom?: Optional<boolean>;
              cmd_scaffold_template_flavor?: Optional<string>;
              cmd_scaffold_type?: Optional<string>;
              cmd_scaffold_type_category?: Optional<string>;
              cmd_scaffold_type_gated?: Optional<boolean>;
              cmd_scaffold_type_owner?: Optional<string>;
              cmd_scaffold_used_prompts_for_type?: Optional<boolean>;
              command: string;
              env_ci?: Optional<boolean>;
              env_ci_platform?: Optional<string>;
              env_cloud?: Optional<string>;
              env_device_id?: Optional<string>;
              env_is_global?: Optional<boolean>;
              env_package_manager?: Optional<string>;
              env_package_manager_workspaces?: Optional<boolean>;
              env_plugin_installed_any_custom?: Optional<boolean>;
              env_plugin_installed_shopify?: Optional<string>;
              env_shell?: Optional<string>;
              env_web_ide?: Optional<string>;
              is_employee: boolean;
              node_version: string;
              partner_id?: Optional<number>;
              project_type?: Optional<string>;
              ruby_version: string;
              store_fqdn_hash?: Optional<string>;
              success: boolean;
              time_end: number;
              time_start: number;
              total_time: number;
              uname: string;
          };
          sensitive: {
              app_name?: Optional<string>;
              args: string;
              cmd_all_environment_flags?: Optional<string>;
              cmd_dev_tunnel_custom?: Optional<string>;
              env_plugin_installed_all?: Optional<string>;
              error_message?: Optional<string>;
              metadata?: Optional<string>;
              store_fqdn?: Optional<string>;
          };
      }

      Type declaration

      • public: {
            api_key?: Optional<string>;
            app_extensions_any?: Optional<boolean>;
            app_extensions_breakdown?: Optional<string>;
            app_extensions_count?: Optional<number>;
            app_extensions_custom_layout?: Optional<boolean>;
            app_extensions_function_any?: Optional<boolean>;
            app_extensions_function_count?: Optional<number>;
            app_extensions_function_custom_layout?: Optional<boolean>;
            app_extensions_theme_any?: Optional<boolean>;
            app_extensions_theme_count?: Optional<number>;
            app_extensions_theme_custom_layout?: Optional<boolean>;
            app_extensions_ui_any?: Optional<boolean>;
            app_extensions_ui_count?: Optional<number>;
            app_extensions_ui_custom_layout?: Optional<boolean>;
            app_name_hash?: Optional<string>;
            app_path_hash?: Optional<string>;
            app_scopes?: Optional<string>;
            app_web_backend_any?: Optional<boolean>;
            app_web_backend_count?: Optional<number>;
            app_web_custom_layout?: Optional<boolean>;
            app_web_framework?: Optional<string>;
            app_web_frontend_any?: Optional<boolean>;
            app_web_frontend_count?: Optional<number>;
            cli_version: string;
            cmd_all_alias_used?: Optional<string>;
            cmd_all_exit?: Optional<string>;
            cmd_all_force?: Optional<boolean>;
            cmd_all_launcher?: Optional<string>;
            cmd_all_path_override?: Optional<boolean>;
            cmd_all_path_override_hash?: Optional<string>;
            cmd_all_plugin?: Optional<string>;
            cmd_all_timing_active_ms?: Optional<number>;
            cmd_all_timing_network_ms?: Optional<number>;
            cmd_all_timing_prompts_ms?: Optional<number>;
            cmd_all_topic?: Optional<string>;
            cmd_all_verbose?: Optional<boolean>;
            cmd_app_all_configs_any?: Optional<boolean>;
            cmd_app_all_configs_clients?: Optional<string>;
            cmd_app_dependency_installation_skipped?: Optional<boolean>;
            cmd_app_deployment_mode?: Optional<string>;
            cmd_app_linked_config_git_tracked?: Optional<boolean>;
            cmd_app_linked_config_name?: Optional<string>;
            cmd_app_linked_config_source?: Optional<string>;
            cmd_app_linked_config_used?: Optional<boolean>;
            cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>;
            cmd_app_reset_used?: Optional<boolean>;
            cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>;
            cmd_create_app_template?: Optional<string>;
            cmd_create_app_template_url?: Optional<string>;
            cmd_deploy_config_modules_added?: Optional<string>;
            cmd_deploy_config_modules_breakdown?: Optional<string>;
            cmd_deploy_config_modules_deleted?: Optional<string>;
            cmd_deploy_config_modules_updated?: Optional<string>;
            cmd_deploy_confirm_cancelled?: Optional<boolean>;
            cmd_deploy_confirm_include_config_used?: Optional<boolean>;
            cmd_deploy_confirm_new_registrations?: Optional<number>;
            cmd_deploy_confirm_removed_registrations?: Optional<number>;
            cmd_deploy_confirm_time_to_complete_ms?: Optional<number>;
            cmd_deploy_confirm_updated_registrations?: Optional<number>;
            cmd_deploy_flag_message_used?: Optional<boolean>;
            cmd_deploy_flag_source_url_used?: Optional<boolean>;
            cmd_deploy_flag_version_used?: Optional<boolean>;
            cmd_deploy_include_config_used?: Optional<boolean>;
            cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>;
            cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>;
            cmd_dev_dev_preview_toggle_used?: Optional<boolean>;
            cmd_dev_graphiql_opened?: Optional<boolean>;
            cmd_dev_preview_url_opened?: Optional<boolean>;
            cmd_dev_tunnel_custom_hash?: Optional<string>;
            cmd_dev_tunnel_type?: Optional<string>;
            cmd_dev_urls_updated?: Optional<boolean>;
            cmd_extensions_binary_from_source?: Optional<boolean>;
            cmd_release_confirm_cancelled?: Optional<boolean>;
            cmd_scaffold_required_auth?: Optional<boolean>;
            cmd_scaffold_template_custom?: Optional<boolean>;
            cmd_scaffold_template_flavor?: Optional<string>;
            cmd_scaffold_type?: Optional<string>;
            cmd_scaffold_type_category?: Optional<string>;
            cmd_scaffold_type_gated?: Optional<boolean>;
            cmd_scaffold_type_owner?: Optional<string>;
            cmd_scaffold_used_prompts_for_type?: Optional<boolean>;
            command: string;
            env_ci?: Optional<boolean>;
            env_ci_platform?: Optional<string>;
            env_cloud?: Optional<string>;
            env_device_id?: Optional<string>;
            env_is_global?: Optional<boolean>;
            env_package_manager?: Optional<string>;
            env_package_manager_workspaces?: Optional<boolean>;
            env_plugin_installed_any_custom?: Optional<boolean>;
            env_plugin_installed_shopify?: Optional<string>;
            env_shell?: Optional<string>;
            env_web_ide?: Optional<string>;
            is_employee: boolean;
            node_version: string;
            partner_id?: Optional<number>;
            project_type?: Optional<string>;
            ruby_version: string;
            store_fqdn_hash?: Optional<string>;
            success: boolean;
            time_end: number;
            time_start: number;
            total_time: number;
            uname: string;
        }
        • Optional api_key?: Optional<string>
        • Optional app_extensions_any?: Optional<boolean>
        • Optional app_extensions_breakdown?: Optional<string>
        • Optional app_extensions_count?: Optional<number>
        • Optional app_extensions_custom_layout?: Optional<boolean>
        • Optional app_extensions_function_any?: Optional<boolean>
        • Optional app_extensions_function_count?: Optional<number>
        • Optional app_extensions_function_custom_layout?: Optional<boolean>
        • Optional app_extensions_theme_any?: Optional<boolean>
        • Optional app_extensions_theme_count?: Optional<number>
        • Optional app_extensions_theme_custom_layout?: Optional<boolean>
        • Optional app_extensions_ui_any?: Optional<boolean>
        • Optional app_extensions_ui_count?: Optional<number>
        • Optional app_extensions_ui_custom_layout?: Optional<boolean>
        • Optional app_name_hash?: Optional<string>
        • Optional app_path_hash?: Optional<string>
        • Optional app_scopes?: Optional<string>
        • Optional app_web_backend_any?: Optional<boolean>
        • Optional app_web_backend_count?: Optional<number>
        • Optional app_web_custom_layout?: Optional<boolean>
        • Optional app_web_framework?: Optional<string>
        • Optional app_web_frontend_any?: Optional<boolean>
        • Optional app_web_frontend_count?: Optional<number>
        • cli_version: string
        • Optional cmd_all_alias_used?: Optional<string>
        • Optional cmd_all_exit?: Optional<string>
        • Optional cmd_all_force?: Optional<boolean>
        • Optional cmd_all_launcher?: Optional<string>
        • Optional cmd_all_path_override?: Optional<boolean>
        • Optional cmd_all_path_override_hash?: Optional<string>
        • Optional cmd_all_plugin?: Optional<string>
        • Optional cmd_all_timing_active_ms?: Optional<number>
        • Optional cmd_all_timing_network_ms?: Optional<number>
        • Optional cmd_all_timing_prompts_ms?: Optional<number>
        • Optional cmd_all_topic?: Optional<string>
        • Optional cmd_all_verbose?: Optional<boolean>
        • Optional cmd_app_all_configs_any?: Optional<boolean>
        • Optional cmd_app_all_configs_clients?: Optional<string>
        • Optional cmd_app_dependency_installation_skipped?: Optional<boolean>
        • Optional cmd_app_deployment_mode?: Optional<string>
        • Optional cmd_app_linked_config_git_tracked?: Optional<boolean>
        • Optional cmd_app_linked_config_name?: Optional<string>
        • Optional cmd_app_linked_config_source?: Optional<string>
        • Optional cmd_app_linked_config_used?: Optional<boolean>
        • Optional cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>
        • Optional cmd_app_reset_used?: Optional<boolean>
        • Optional cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>
        • Optional cmd_create_app_template?: Optional<string>
        • Optional cmd_create_app_template_url?: Optional<string>
        • Optional cmd_deploy_config_modules_added?: Optional<string>
        • Optional cmd_deploy_config_modules_breakdown?: Optional<string>
        • Optional cmd_deploy_config_modules_deleted?: Optional<string>
        • Optional cmd_deploy_config_modules_updated?: Optional<string>
        • Optional cmd_deploy_confirm_cancelled?: Optional<boolean>
        • Optional cmd_deploy_confirm_include_config_used?: Optional<boolean>
        • Optional cmd_deploy_confirm_new_registrations?: Optional<number>
        • Optional cmd_deploy_confirm_removed_registrations?: Optional<number>
        • Optional cmd_deploy_confirm_time_to_complete_ms?: Optional<number>
        • Optional cmd_deploy_confirm_updated_registrations?: Optional<number>
        • Optional cmd_deploy_flag_message_used?: Optional<boolean>
        • Optional cmd_deploy_flag_source_url_used?: Optional<boolean>
        • Optional cmd_deploy_flag_version_used?: Optional<boolean>
        • Optional cmd_deploy_include_config_used?: Optional<boolean>
        • Optional cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>
        • Optional cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>
        • Optional cmd_dev_dev_preview_toggle_used?: Optional<boolean>
        • Optional cmd_dev_graphiql_opened?: Optional<boolean>
        • Optional cmd_dev_preview_url_opened?: Optional<boolean>
        • Optional cmd_dev_tunnel_custom_hash?: Optional<string>
        • Optional cmd_dev_tunnel_type?: Optional<string>
        • Optional cmd_dev_urls_updated?: Optional<boolean>
        • Optional cmd_extensions_binary_from_source?: Optional<boolean>
        • Optional cmd_release_confirm_cancelled?: Optional<boolean>
        • Optional cmd_scaffold_required_auth?: Optional<boolean>
        • Optional cmd_scaffold_template_custom?: Optional<boolean>
        • Optional cmd_scaffold_template_flavor?: Optional<string>
        • Optional cmd_scaffold_type?: Optional<string>
        • Optional cmd_scaffold_type_category?: Optional<string>
        • Optional cmd_scaffold_type_gated?: Optional<boolean>
        • Optional cmd_scaffold_type_owner?: Optional<string>
        • Optional cmd_scaffold_used_prompts_for_type?: Optional<boolean>
        • command: string
        • Optional env_ci?: Optional<boolean>
        • Optional env_ci_platform?: Optional<string>
        • Optional env_cloud?: Optional<string>
        • Optional env_device_id?: Optional<string>
        • Optional env_is_global?: Optional<boolean>
        • Optional env_package_manager?: Optional<string>
        • Optional env_package_manager_workspaces?: Optional<boolean>
        • Optional env_plugin_installed_any_custom?: Optional<boolean>
        • Optional env_plugin_installed_shopify?: Optional<string>
        • Optional env_shell?: Optional<string>
        • Optional env_web_ide?: Optional<string>
        • is_employee: boolean
        • node_version: string
        • Optional partner_id?: Optional<number>
        • Optional project_type?: Optional<string>
        • ruby_version: string
        • Optional store_fqdn_hash?: Optional<string>
        • success: boolean
        • time_end: number
        • time_start: number
        • total_time: number
        • uname: string
      • sensitive: {
            app_name?: Optional<string>;
            args: string;
            cmd_all_environment_flags?: Optional<string>;
            cmd_dev_tunnel_custom?: Optional<string>;
            env_plugin_installed_all?: Optional<string>;
            error_message?: Optional<string>;
            metadata?: Optional<string>;
            store_fqdn?: Optional<string>;
        }
        • Optional app_name?: Optional<string>
        • args: string
        • Optional cmd_all_environment_flags?: Optional<string>
        • Optional cmd_dev_tunnel_custom?: Optional<string>
        • Optional env_plugin_installed_all?: Optional<string>
        • Optional error_message?: Optional<string>
        • Optional metadata?: Optional<string>
        • Optional store_fqdn?: Optional<string>

      Settings

      Member Visibility

      Theme

      On This Page

      app_cli3_command/1.12
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_node_package_manager.DependencyVersion.html b/docs/api/cli-kit/interfaces/node_node_package_manager.DependencyVersion.html index 2ed1504ba5..a06e49937c 100644 --- a/docs/api/cli-kit/interfaces/node_node_package_manager.DependencyVersion.html +++ b/docs/api/cli-kit/interfaces/node_node_package_manager.DependencyVersion.html @@ -1,12 +1,12 @@ DependencyVersion | @shopify/cli-kit

      Interface DependencyVersion

      An interface that represents a dependency name with its version

      -
      interface DependencyVersion {
          name: string;
          version: undefined | string;
      }

      Properties

      name +
      interface DependencyVersion {
          name: string;
          version: undefined | string;
      }

      Properties

      name version

      Properties

      name

      name: string

      The name of the NPM dependency as it's reflected in the package.json:

      Example

      In the example below name would be "react"

      {
        "react": "1.2.3"
      }
      -

      version

      version: undefined | string

      The version of the NPM dependency as it's reflected in the package.json:

      +

      version

      version: undefined | string

      The version of the NPM dependency as it's reflected in the package.json:

      Example

      In the example below version would be "1.2.3"

      {
        "react": "1.2.3"
      }
      -

      Settings

      Member Visibility

      Theme

      On This Page

      nameversion
      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      nameversion
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_node_package_manager.PackageJson.html b/docs/api/cli-kit/interfaces/node_node_package_manager.PackageJson.html index b7e9d69cde..c251784767 100644 --- a/docs/api/cli-kit/interfaces/node_node_package_manager.PackageJson.html +++ b/docs/api/cli-kit/interfaces/node_node_package_manager.PackageJson.html @@ -1,5 +1,5 @@ PackageJson | @shopify/cli-kit

      Interface PackageJson

      An interface that represents a package.json

      -
      interface PackageJson {
          author?: string;
          dependencies?: {
              [key: string]: string;
          };
          devDependencies?: {
              [key: string]: string;
          };
          name?: string;
          oclif?: {
              plugins?: string[];
          };
          overrides?: {
              [key: string]: string;
          };
          peerDependencies?: {
              [key: string]: string;
          };
          prettier?: string;
          private?: boolean;
          resolutions?: {
              [key: string]: string;
          };
          scripts?: {
              [key: string]: string;
          };
          version?: string;
          workspaces?: string[];
      }

      Properties

      author? +
      interface PackageJson {
          author?: string;
          dependencies?: {
              [key: string]: string;
          };
          devDependencies?: {
              [key: string]: string;
          };
          name?: string;
          oclif?: {
              plugins?: string[];
          };
          overrides?: {
              [key: string]: string;
          };
          peerDependencies?: {
              [key: string]: string;
          };
          prettier?: string;
          private?: boolean;
          resolutions?: {
              [key: string]: string;
          };
          scripts?: {
              [key: string]: string;
          };
          version?: string;
          workspaces?: string[];
      }

      Properties

      author? dependencies? devDependencies? name? @@ -13,17 +13,17 @@ version? workspaces?

      Properties

      Optional author

      author?: string

      The author attribute of the package.json

      -

      Optional dependencies

      dependencies?: {
          [key: string]: string;
      }

      The dependencies attribute of the package.json

      -

      Type declaration

      • [key: string]: string

      Optional devDependencies

      devDependencies?: {
          [key: string]: string;
      }

      The devDependencies attribute of the package.json

      -

      Type declaration

      • [key: string]: string

      Optional name

      name?: string

      The name attribute of the package.json

      -

      Optional oclif

      oclif?: {
          plugins?: string[];
      }

      The optional oclif settings attribute of the package.json

      -

      Type declaration

      • Optional plugins?: string[]

      Optional overrides

      overrides?: {
          [key: string]: string;
      }

      The overrides attribute of the package.json. Only useful when using npm o npmn as package managers

      -

      Type declaration

      • [key: string]: string

      Optional peerDependencies

      peerDependencies?: {
          [key: string]: string;
      }

      The peerDependencies attribute of the package.json

      -

      Type declaration

      • [key: string]: string

      Optional prettier

      prettier?: string

      The prettier attribute of the package.json

      -

      Optional private

      private?: boolean

      The private attribute of the package.json. +

      Optional dependencies

      dependencies?: {
          [key: string]: string;
      }

      The dependencies attribute of the package.json

      +

      Type declaration

      • [key: string]: string

      Optional devDependencies

      devDependencies?: {
          [key: string]: string;
      }

      The devDependencies attribute of the package.json

      +

      Type declaration

      • [key: string]: string

      Optional name

      name?: string

      The name attribute of the package.json

      +

      Optional oclif

      oclif?: {
          plugins?: string[];
      }

      The optional oclif settings attribute of the package.json

      +

      Type declaration

      • Optional plugins?: string[]

      Optional overrides

      overrides?: {
          [key: string]: string;
      }

      The overrides attribute of the package.json. Only useful when using npm o npmn as package managers

      +

      Type declaration

      • [key: string]: string

      Optional peerDependencies

      peerDependencies?: {
          [key: string]: string;
      }

      The peerDependencies attribute of the package.json

      +

      Type declaration

      • [key: string]: string

      Optional prettier

      prettier?: string

      The prettier attribute of the package.json

      +

      Optional private

      private?: boolean

      The private attribute of the package.json. https://docs.npmjs.com/cli/v9/configuring-npm/package-json#private

      -

      Optional resolutions

      resolutions?: {
          [key: string]: string;
      }

      The resolutions attribute of the package.json. Only useful when using yarn as package manager

      -

      Type declaration

      • [key: string]: string

      Optional scripts

      scripts?: {
          [key: string]: string;
      }

      The scripts attribute of the package.json

      -

      Type declaration

      • [key: string]: string

      Optional version

      version?: string

      The version attribute of the package.json

      -

      Optional workspaces

      workspaces?: string[]

      The workspaces attribute of the package.json

      -

      Settings

      Member Visibility

      Theme

      On This Page

      authordependenciesdevDependenciesnameoclifoverridespeerDependenciesprettierprivateresolutionsscriptsversionworkspaces
      \ No newline at end of file +

      Optional resolutions

      resolutions?: {
          [key: string]: string;
      }

      The resolutions attribute of the package.json. Only useful when using yarn as package manager

      +

      Type declaration

      Optional scripts

      scripts?: {
          [key: string]: string;
      }

      The scripts attribute of the package.json

      +

      Type declaration

      Optional version

      version?: string

      The version attribute of the package.json

      +

      Optional workspaces

      workspaces?: string[]

      The workspaces attribute of the package.json

      +

      Settings

      Member Visibility

      Theme

      On This Page

      authordependenciesdevDependenciesnameoclifoverridespeerDependenciesprettierprivateresolutionsscriptsversionworkspaces
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_output.OutputProcess.html b/docs/api/cli-kit/interfaces/node_output.OutputProcess.html index 5b9170a53a..bbb462fb8d 100644 --- a/docs/api/cli-kit/interfaces/node_output.OutputProcess.html +++ b/docs/api/cli-kit/interfaces/node_output.OutputProcess.html @@ -1,8 +1,8 @@ -OutputProcess | @shopify/cli-kit

      Interface OutputProcess

      interface OutputProcess {
          action: ((stdout, stderr, signal) => Promise<void>);
          prefix: string;
      }

      Properties

      action +OutputProcess | @shopify/cli-kit

      Interface OutputProcess

      interface OutputProcess {
          action: ((stdout, stderr, signal) => Promise<void>);
          prefix: string;
      }

      Properties

      action prefix

      Properties

      action

      action: ((stdout, stderr, signal) => Promise<void>)

      A callback to invoke the process. Stdout and stderr should be used to send standard output and error data that gets formatted with the right prefix.

      -

      Type declaration

        • (stdout, stderr, signal): Promise<void>

        • Parameters

          Returns Promise<void>

      prefix

      prefix: string

      The prefix to include in the logs +

      Type declaration

        • (stdout, stderr, signal): Promise<void>

        • Parameters

          Returns Promise<void>

      prefix

      prefix: string

      The prefix to include in the logs [vite] Output coming from Vite.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      actionprefix
      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      actionprefix
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_plugins.HookReturnsPerPlugin.html b/docs/api/cli-kit/interfaces/node_plugins.HookReturnsPerPlugin.html index 46835c59a5..96adcf6567 100644 --- a/docs/api/cli-kit/interfaces/node_plugins.HookReturnsPerPlugin.html +++ b/docs/api/cli-kit/interfaces/node_plugins.HookReturnsPerPlugin.html @@ -1,7 +1,7 @@ HookReturnsPerPlugin | @shopify/cli-kit

      Interface HookReturnsPerPlugin

      Tunnel Plugins types

      Any plugin that provides tunnel functionality should implement defineProviderand startTunnel

      -
      interface HookReturnsPerPlugin {
          public_command_metadata: {
              options: {
                  [key: string]: never;
              };
              pluginReturns: {
                  @shopify/app: Partial<AppSpecificMonorailFields>;
                  [pluginName: string]: JsonMap;
              };
          };
          sensitive_command_metadata: {
              options: {
                  [key: string]: never;
              };
              pluginReturns: {
                  @shopify/app: Partial<PickByPrefix<{
                      app_name?: Optional<string>;
                      args: string;
                      cmd_all_environment_flags?: Optional<string>;
                      cmd_dev_tunnel_custom?: Optional<string>;
                      env_plugin_installed_all?: Optional<string>;
                      error_message?: Optional<string>;
                      metadata?: Optional<string>;
                      store_fqdn?: Optional<string>;
                  }, "app_", never>>;
                  [pluginName: string]: JsonMap;
              };
          };
          tunnel_provider: {
              options: {
                  [key: string]: never;
              };
              pluginReturns: {
                  [pluginName: string]: {
                      name: string;
                  };
              };
          };
          tunnel_start: {
              options: {
                  port: number;
                  provider: string;
              };
              pluginReturns: {
                  [key: string]: Result<TunnelClient, TunnelError>;
              };
          };
          [hookName: string]: {
              options: {
                  [key: string]: unknown;
              };
              pluginReturns: {
                  [key: string]: unknown;
              };
          };
      }

      Hierarchy (view full)

      Indexable

      [hookName: string]: {
          options: {
              [key: string]: unknown;
          };
          pluginReturns: {
              [key: string]: unknown;
          };
      }
      • options: {
            [key: string]: unknown;
        }
        • [key: string]: unknown
      • pluginReturns: {
            [key: string]: unknown;
        }
        • [key: string]: unknown

      Properties

      public_command_metadata +
      interface HookReturnsPerPlugin {
          public_command_metadata: {
              options: {
                  [key: string]: never;
              };
              pluginReturns: {
                  @shopify/app: Partial<AppSpecificMonorailFields>;
                  [pluginName: string]: JsonMap;
              };
          };
          sensitive_command_metadata: {
              options: {
                  [key: string]: never;
              };
              pluginReturns: {
                  @shopify/app: Partial<PickByPrefix<{
                      app_name?: Optional<string>;
                      args: string;
                      cmd_all_environment_flags?: Optional<string>;
                      cmd_dev_tunnel_custom?: Optional<string>;
                      env_plugin_installed_all?: Optional<string>;
                      error_message?: Optional<string>;
                      metadata?: Optional<string>;
                      store_fqdn?: Optional<string>;
                  }, "app_", never>>;
                  [pluginName: string]: JsonMap;
              };
          };
          tunnel_provider: {
              options: {
                  [key: string]: never;
              };
              pluginReturns: {
                  [pluginName: string]: {
                      name: string;
                  };
              };
          };
          tunnel_start: {
              options: {
                  port: number;
                  provider: string;
              };
              pluginReturns: {
                  [key: string]: Result<TunnelClient, TunnelError>;
              };
          };
          [hookName: string]: {
              options: {
                  [key: string]: unknown;
              };
              pluginReturns: {
                  [key: string]: unknown;
              };
          };
      }

      Hierarchy (view full)

      Indexable

      [hookName: string]: {
          options: {
              [key: string]: unknown;
          };
          pluginReturns: {
              [key: string]: unknown;
          };
      }
      • options: {
            [key: string]: unknown;
        }
        • [key: string]: unknown
      • pluginReturns: {
            [key: string]: unknown;
        }
        • [key: string]: unknown

      Properties

      public_command_metadata sensitive_command_metadata tunnel_provider tunnel_start -

      Properties

      public_command_metadata

      public_command_metadata: {
          options: {
              [key: string]: never;
          };
          pluginReturns: {
              @shopify/app: Partial<AppSpecificMonorailFields>;
              [pluginName: string]: JsonMap;
          };
      }

      Type declaration

      • options: {
            [key: string]: never;
        }
        • [key: string]: never
      • pluginReturns: {
            @shopify/app: Partial<AppSpecificMonorailFields>;
            [pluginName: string]: JsonMap;
        }
        • [pluginName: string]: JsonMap
        • @shopify/app: Partial<AppSpecificMonorailFields>

      sensitive_command_metadata

      sensitive_command_metadata: {
          options: {
              [key: string]: never;
          };
          pluginReturns: {
              @shopify/app: Partial<PickByPrefix<{
                  app_name?: Optional<string>;
                  args: string;
                  cmd_all_environment_flags?: Optional<string>;
                  cmd_dev_tunnel_custom?: Optional<string>;
                  env_plugin_installed_all?: Optional<string>;
                  error_message?: Optional<string>;
                  metadata?: Optional<string>;
                  store_fqdn?: Optional<string>;
              }, "app_", never>>;
              [pluginName: string]: JsonMap;
          };
      }

      Type declaration

      • options: {
            [key: string]: never;
        }
        • [key: string]: never
      • pluginReturns: {
            @shopify/app: Partial<PickByPrefix<{
                app_name?: Optional<string>;
                args: string;
                cmd_all_environment_flags?: Optional<string>;
                cmd_dev_tunnel_custom?: Optional<string>;
                env_plugin_installed_all?: Optional<string>;
                error_message?: Optional<string>;
                metadata?: Optional<string>;
                store_fqdn?: Optional<string>;
            }, "app_", never>>;
            [pluginName: string]: JsonMap;
        }
        • [pluginName: string]: JsonMap
        • @shopify/app: Partial<PickByPrefix<{
              app_name?: Optional<string>;
              args: string;
              cmd_all_environment_flags?: Optional<string>;
              cmd_dev_tunnel_custom?: Optional<string>;
              env_plugin_installed_all?: Optional<string>;
              error_message?: Optional<string>;
              metadata?: Optional<string>;
              store_fqdn?: Optional<string>;
          }, "app_", never>>

      tunnel_provider

      tunnel_provider: {
          options: {
              [key: string]: never;
          };
          pluginReturns: {
              [pluginName: string]: {
                  name: string;
              };
          };
      }

      Type declaration

      • options: {
            [key: string]: never;
        }
        • [key: string]: never
      • pluginReturns: {
            [pluginName: string]: {
                name: string;
            };
        }
        • [pluginName: string]: {
              name: string;
          }
          • name: string

      tunnel_start

      tunnel_start: {
          options: {
              port: number;
              provider: string;
          };
          pluginReturns: {
              [key: string]: Result<TunnelClient, TunnelError>;
          };
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      public_command_metadatasensitive_command_metadatatunnel_providertunnel_start
      \ No newline at end of file +

      Properties

      public_command_metadata

      public_command_metadata: {
          options: {
              [key: string]: never;
          };
          pluginReturns: {
              @shopify/app: Partial<AppSpecificMonorailFields>;
              [pluginName: string]: JsonMap;
          };
      }

      Type declaration

      • options: {
            [key: string]: never;
        }
        • [key: string]: never
      • pluginReturns: {
            @shopify/app: Partial<AppSpecificMonorailFields>;
            [pluginName: string]: JsonMap;
        }
        • [pluginName: string]: JsonMap
        • @shopify/app: Partial<AppSpecificMonorailFields>

      sensitive_command_metadata

      sensitive_command_metadata: {
          options: {
              [key: string]: never;
          };
          pluginReturns: {
              @shopify/app: Partial<PickByPrefix<{
                  app_name?: Optional<string>;
                  args: string;
                  cmd_all_environment_flags?: Optional<string>;
                  cmd_dev_tunnel_custom?: Optional<string>;
                  env_plugin_installed_all?: Optional<string>;
                  error_message?: Optional<string>;
                  metadata?: Optional<string>;
                  store_fqdn?: Optional<string>;
              }, "app_", never>>;
              [pluginName: string]: JsonMap;
          };
      }

      Type declaration

      • options: {
            [key: string]: never;
        }
        • [key: string]: never
      • pluginReturns: {
            @shopify/app: Partial<PickByPrefix<{
                app_name?: Optional<string>;
                args: string;
                cmd_all_environment_flags?: Optional<string>;
                cmd_dev_tunnel_custom?: Optional<string>;
                env_plugin_installed_all?: Optional<string>;
                error_message?: Optional<string>;
                metadata?: Optional<string>;
                store_fqdn?: Optional<string>;
            }, "app_", never>>;
            [pluginName: string]: JsonMap;
        }
        • [pluginName: string]: JsonMap
        • @shopify/app: Partial<PickByPrefix<{
              app_name?: Optional<string>;
              args: string;
              cmd_all_environment_flags?: Optional<string>;
              cmd_dev_tunnel_custom?: Optional<string>;
              env_plugin_installed_all?: Optional<string>;
              error_message?: Optional<string>;
              metadata?: Optional<string>;
              store_fqdn?: Optional<string>;
          }, "app_", never>>

      tunnel_provider

      tunnel_provider: {
          options: {
              [key: string]: never;
          };
          pluginReturns: {
              [pluginName: string]: {
                  name: string;
              };
          };
      }

      Type declaration

      • options: {
            [key: string]: never;
        }
        • [key: string]: never
      • pluginReturns: {
            [pluginName: string]: {
                name: string;
            };
        }
        • [pluginName: string]: {
              name: string;
          }
          • name: string

      tunnel_start

      tunnel_start: {
          options: {
              port: number;
              provider: string;
          };
          pluginReturns: {
              [key: string]: Result<TunnelClient, TunnelError>;
          };
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      public_command_metadatasensitive_command_metadatatunnel_providertunnel_start
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_plugins.TunnelPluginError.html b/docs/api/cli-kit/interfaces/node_plugins.TunnelPluginError.html index 48d0240342..b14a9ffc29 100644 --- a/docs/api/cli-kit/interfaces/node_plugins.TunnelPluginError.html +++ b/docs/api/cli-kit/interfaces/node_plugins.TunnelPluginError.html @@ -1,4 +1,4 @@ -TunnelPluginError | @shopify/cli-kit

      Interface TunnelPluginError

      interface TunnelPluginError {
          message?: string;
          provider: string;
          type: "unknown" | "multiple-providers" | "handled-error" | "no-provider";
      }

      Properties

      message? +TunnelPluginError | @shopify/cli-kit

      Interface TunnelPluginError

      interface TunnelPluginError {
          message?: string;
          provider: string;
          type: "unknown" | "multiple-providers" | "handled-error" | "no-provider";
      }

      Properties

      message? provider type -

      Properties

      Optional message

      message?: string

      provider

      provider: string

      type

      type: "unknown" | "multiple-providers" | "handled-error" | "no-provider"

      Settings

      Member Visibility

      Theme

      On This Page

      messageprovidertype
      \ No newline at end of file +

      Properties

      Optional message

      message?: string

      provider

      provider: string

      type

      type: "unknown" | "multiple-providers" | "handled-error" | "no-provider"

      Settings

      Member Visibility

      Theme

      On This Page

      messageprovidertype
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_plugins_tunnel.HookReturnPerTunnelPlugin.html b/docs/api/cli-kit/interfaces/node_plugins_tunnel.HookReturnPerTunnelPlugin.html index 0fd2cc0b45..a72498cf63 100644 --- a/docs/api/cli-kit/interfaces/node_plugins_tunnel.HookReturnPerTunnelPlugin.html +++ b/docs/api/cli-kit/interfaces/node_plugins_tunnel.HookReturnPerTunnelPlugin.html @@ -1,5 +1,5 @@ HookReturnPerTunnelPlugin | @shopify/cli-kit

      Interface HookReturnPerTunnelPlugin

      Tunnel Plugins types

      Any plugin that provides tunnel functionality should implement defineProviderand startTunnel

      -
      interface HookReturnPerTunnelPlugin {
          tunnel_provider: {
              options: {
                  [key: string]: never;
              };
              pluginReturns: {
                  [pluginName: string]: {
                      name: string;
                  };
              };
          };
          tunnel_start: {
              options: {
                  port: number;
                  provider: string;
              };
              pluginReturns: {
                  [key: string]: Result<TunnelClient, TunnelError>;
              };
          };
      }

      Hierarchy (view full)

      Properties

      tunnel_provider +
      interface HookReturnPerTunnelPlugin {
          tunnel_provider: {
              options: {
                  [key: string]: never;
              };
              pluginReturns: {
                  [pluginName: string]: {
                      name: string;
                  };
              };
          };
          tunnel_start: {
              options: {
                  port: number;
                  provider: string;
              };
              pluginReturns: {
                  [key: string]: Result<TunnelClient, TunnelError>;
              };
          };
      }

      Hierarchy (view full)

      Properties

      tunnel_provider tunnel_start -

      Properties

      tunnel_provider

      tunnel_provider: {
          options: {
              [key: string]: never;
          };
          pluginReturns: {
              [pluginName: string]: {
                  name: string;
              };
          };
      }

      Type declaration

      • options: {
            [key: string]: never;
        }
        • [key: string]: never
      • pluginReturns: {
            [pluginName: string]: {
                name: string;
            };
        }
        • [pluginName: string]: {
              name: string;
          }
          • name: string

      tunnel_start

      tunnel_start: {
          options: {
              port: number;
              provider: string;
          };
          pluginReturns: {
              [key: string]: Result<TunnelClient, TunnelError>;
          };
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      tunnel_providertunnel_start
      \ No newline at end of file +

      Properties

      tunnel_provider

      tunnel_provider: {
          options: {
              [key: string]: never;
          };
          pluginReturns: {
              [pluginName: string]: {
                  name: string;
              };
          };
      }

      Type declaration

      • options: {
            [key: string]: never;
        }
        • [key: string]: never
      • pluginReturns: {
            [pluginName: string]: {
                name: string;
            };
        }
        • [pluginName: string]: {
              name: string;
          }
          • name: string

      tunnel_start

      tunnel_start: {
          options: {
              port: number;
              provider: string;
          };
          pluginReturns: {
              [key: string]: Result<TunnelClient, TunnelError>;
          };
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      tunnel_providertunnel_start
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_plugins_tunnel.TunnelClient.html b/docs/api/cli-kit/interfaces/node_plugins_tunnel.TunnelClient.html index 92cb6c3c1b..3065f2b4e0 100644 --- a/docs/api/cli-kit/interfaces/node_plugins_tunnel.TunnelClient.html +++ b/docs/api/cli-kit/interfaces/node_plugins_tunnel.TunnelClient.html @@ -1,5 +1,5 @@ -TunnelClient | @shopify/cli-kit

      Interface TunnelClient

      interface TunnelClient {
          getTunnelStatus: (() => TunnelStatusType);
          port: number;
          provider: string;
          stopTunnel: (() => void);
      }

      Properties

      getTunnelStatus +TunnelClient | @shopify/cli-kit

      Interface TunnelClient

      interface TunnelClient {
          getTunnelStatus: (() => TunnelStatusType);
          port: number;
          provider: string;
          stopTunnel: (() => void);
      }

      Properties

      getTunnelStatus port provider stopTunnel -

      Properties

      getTunnelStatus

      getTunnelStatus: (() => TunnelStatusType)

      Type declaration

      port

      port: number

      provider

      provider: string

      stopTunnel

      stopTunnel: (() => void)

      Type declaration

        • (): void

        • Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      getTunnelStatusportproviderstopTunnel
      \ No newline at end of file +

      Properties

      getTunnelStatus

      getTunnelStatus: (() => TunnelStatusType)

      Type declaration

      port

      port: number

      provider

      provider: string

      stopTunnel

      stopTunnel: (() => void)

      Type declaration

        • (): void

        • Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      getTunnelStatusportproviderstopTunnel
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_session.AdminSession.html b/docs/api/cli-kit/interfaces/node_session.AdminSession.html index 0769a59526..f5ba0f64d2 100644 --- a/docs/api/cli-kit/interfaces/node_session.AdminSession.html +++ b/docs/api/cli-kit/interfaces/node_session.AdminSession.html @@ -1,4 +1,4 @@ AdminSession | @shopify/cli-kit

      Interface AdminSession

      Session Object to access the Admin API, includes the token and the store FQDN.

      -
      interface AdminSession {
          storeFqdn: string;
          token: string;
      }

      Properties

      storeFqdn +
      interface AdminSession {
          storeFqdn: string;
          token: string;
      }

      Properties

      storeFqdn token -

      Properties

      storeFqdn

      storeFqdn: string

      token

      token: string

      Settings

      Member Visibility

      Theme

      On This Page

      storeFqdntoken
      \ No newline at end of file +

      Properties

      storeFqdn

      storeFqdn: string

      token

      token: string

      Settings

      Member Visibility

      Theme

      On This Page

      storeFqdntoken
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_system.ExecOptions.html b/docs/api/cli-kit/interfaces/node_system.ExecOptions.html index 1063277ea8..48d00d2312 100644 --- a/docs/api/cli-kit/interfaces/node_system.ExecOptions.html +++ b/docs/api/cli-kit/interfaces/node_system.ExecOptions.html @@ -1,4 +1,4 @@ -ExecOptions | @shopify/cli-kit

      Interface ExecOptions

      interface ExecOptions {
          cwd?: string;
          env?: {
              [key: string]: string | undefined;
          };
          externalErrorHandler?: ((error) => Promise<void>);
          input?: string;
          signal?: AbortSignal;
          stderr?: "inherit" | Writable;
          stdin?: Readable | "inherit";
          stdio?: "inherit";
          stdout?: "inherit" | Writable;
      }

      Properties

      cwd? +ExecOptions | @shopify/cli-kit

      Interface ExecOptions

      interface ExecOptions {
          cwd?: string;
          env?: {
              [key: string]: string | undefined;
          };
          externalErrorHandler?: ((error) => Promise<void>);
          input?: string;
          signal?: AbortSignal;
          stderr?: "inherit" | Writable;
          stdin?: Readable | "inherit";
          stdio?: "inherit";
          stdout?: "inherit" | Writable;
      }

      Properties

      cwd? env? externalErrorHandler? input? @@ -7,4 +7,4 @@ stdin? stdio? stdout? -

      Properties

      Optional cwd

      cwd?: string

      Optional env

      env?: {
          [key: string]: string | undefined;
      }

      Type declaration

      • [key: string]: string | undefined

      Optional externalErrorHandler

      externalErrorHandler?: ((error) => Promise<void>)

      Type declaration

        • (error): Promise<void>

        • Parameters

          • error: unknown

          Returns Promise<void>

      Optional input

      input?: string

      Optional signal

      signal?: AbortSignal

      Optional stderr

      stderr?: "inherit" | Writable

      Optional stdin

      stdin?: Readable | "inherit"

      Optional stdio

      stdio?: "inherit"

      Optional stdout

      stdout?: "inherit" | Writable

      Settings

      Member Visibility

      Theme

      On This Page

      cwdenvexternalErrorHandlerinputsignalstderrstdinstdiostdout
      \ No newline at end of file +

      Properties

      Optional cwd

      cwd?: string

      Optional env

      env?: {
          [key: string]: string | undefined;
      }

      Type declaration

      • [key: string]: string | undefined

      Optional externalErrorHandler

      externalErrorHandler?: ((error) => Promise<void>)

      Type declaration

        • (error): Promise<void>

        • Parameters

          • error: unknown

          Returns Promise<void>

      Optional input

      input?: string

      Optional signal

      signal?: AbortSignal

      Optional stderr

      stderr?: "inherit" | Writable

      Optional stdin

      stdin?: Readable | "inherit"

      Optional stdio

      stdio?: "inherit"

      Optional stdout

      stdout?: "inherit" | Writable

      Settings

      Member Visibility

      Theme

      On This Page

      cwdenvexternalErrorHandlerinputsignalstderrstdinstdiostdout
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_themes_factories.RemoteBulkUploadResponse.html b/docs/api/cli-kit/interfaces/node_themes_factories.RemoteBulkUploadResponse.html index 9d69a88d54..d65c2ef73a 100644 --- a/docs/api/cli-kit/interfaces/node_themes_factories.RemoteBulkUploadResponse.html +++ b/docs/api/cli-kit/interfaces/node_themes_factories.RemoteBulkUploadResponse.html @@ -1,3 +1,3 @@ -RemoteBulkUploadResponse | @shopify/cli-kit

      Interface RemoteBulkUploadResponse

      interface RemoteBulkUploadResponse {
          body: {
              asset?: RemoteAssetResponse;
              errors?: {
                  asset: string[];
              };
          };
          code: number;
      }

      Properties

      body +RemoteBulkUploadResponse | @shopify/cli-kit

      Interface RemoteBulkUploadResponse

      interface RemoteBulkUploadResponse {
          body: {
              asset?: RemoteAssetResponse;
              errors?: {
                  asset: string[];
              };
          };
          code: number;
      }

      Properties

      body code -

      Properties

      body

      body: {
          asset?: RemoteAssetResponse;
          errors?: {
              asset: string[];
          };
      }

      Type declaration

      • Optional asset?: RemoteAssetResponse
      • Optional errors?: {
            asset: string[];
        }
        • asset: string[]

      code

      code: number

      Settings

      Member Visibility

      Theme

      On This Page

      bodycode
      \ No newline at end of file +

      Properties

      body

      body: {
          asset?: RemoteAssetResponse;
          errors?: {
              asset: string[];
          };
      }

      Type declaration

      • Optional asset?: RemoteAssetResponse
      • Optional errors?: {
            asset: string[];
        }
        • asset: string[]

      code

      code: number

      Settings

      Member Visibility

      Theme

      On This Page

      bodycode
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_themes_types.Checksum.html b/docs/api/cli-kit/interfaces/node_themes_types.Checksum.html index 4cca521ce5..4b95f898ba 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.Checksum.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.Checksum.html @@ -1,6 +1,6 @@ Checksum | @shopify/cli-kit

      Interface Checksum

      Represents the remote checksum for a file in a theme.

      -
      interface Checksum {
          checksum: string;
          key: string;
      }

      Hierarchy (view full)

      Properties

      checksum +
      interface Checksum {
          checksum: string;
          key: string;
      }

      Hierarchy (view full)

      Properties

      checksum key

      Properties

      checksum

      checksum: string

      Represents the checksum value of the theme file.

      -

      key

      key: string

      Identifier of the theme file.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      checksumkey
      \ No newline at end of file +

      key

      key: string

      Identifier of the theme file.

      +

      Settings

      Member Visibility

      Theme

      On This Page

      checksumkey
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_themes_types.Result.html b/docs/api/cli-kit/interfaces/node_themes_types.Result.html index 0b297dcea5..35d6d189f7 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.Result.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.Result.html @@ -1,14 +1,14 @@ Result | @shopify/cli-kit

      Interface Result

      Represents a single result for an upload or delete operation on a single file Each result includes the unique identifier for the file, the type of the operation, the success status of the operation, any errors that occurred, and the asset value of the file.

      -
      interface Result {
          asset?: Omit<ThemeAsset, "stats">;
          errors?: {
              asset?: string[];
          };
          key: string;
          operation: Operation;
          success: boolean;
      }

      Properties

      asset? +
      interface Result {
          asset?: Omit<ThemeAsset, "stats">;
          errors?: {
              asset?: string[];
          };
          key: string;
          operation: Operation;
          success: boolean;
      }

      Properties

      asset? errors? key operation success

      Properties

      Optional asset

      asset?: Omit<ThemeAsset, "stats">

      The asset that was uploaded as part of the upload operation for this file.

      -

      Optional errors

      errors?: {
          asset?: string[];
      }

      Error message that was generated during the upload operation for this file.

      -

      Type declaration

      • Optional asset?: string[]

      key

      key: string

      The unique identifier for the file being uploaded.

      -

      operation

      operation: Operation

      The operation associated with the result.

      -

      success

      success: boolean

      Indicates whether the upload operation for this file was successful.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      asseterrorskeyoperationsuccess
      \ No newline at end of file +

      Optional errors

      errors?: {
          asset?: string[];
      }

      Error message that was generated during the upload operation for this file.

      +

      Type declaration

      key

      key: string

      The unique identifier for the file being uploaded.

      +

      operation

      operation: Operation

      The operation associated with the result.

      +

      success

      success: boolean

      Indicates whether the upload operation for this file was successful.

      +

      Settings

      Member Visibility

      Theme

      On This Page

      asseterrorskeyoperationsuccess
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_themes_types.Theme.html b/docs/api/cli-kit/interfaces/node_themes_types.Theme.html index 36e1925ece..76814bce8a 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.Theme.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.Theme.html @@ -1,14 +1,14 @@ Theme | @shopify/cli-kit

      Interface Theme

      Represents a theme.

      -
      interface Theme {
          createdAtRuntime: boolean;
          id: number;
          name: string;
          processing: boolean;
          role: string;
          src?: string;
      }

      Properties

      createdAtRuntime +
      interface Theme {
          createdAtRuntime: boolean;
          id: number;
          name: string;
          processing: boolean;
          role: string;
          src?: string;
      }

      Properties

      createdAtRuntime id name processing role src?

      Properties

      createdAtRuntime

      createdAtRuntime: boolean

      A boolean determining whether or not the theme was created at runtime.

      -

      id

      id: number

      The remote ID of the theme.

      -

      name

      name: string

      The remote name of the theme.

      -

      processing

      processing: boolean

      A boolean determining if the theme is processing at the theme library.

      -

      role

      role: string

      The remote role of the theme.

      -

      Optional src

      src?: string

      A public URL where Shopify can access the theme code.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      createdAtRuntimeidnameprocessingrolesrc
      \ No newline at end of file +

      id

      id: number

      The remote ID of the theme.

      +

      name

      name: string

      The remote name of the theme.

      +

      processing

      processing: boolean

      A boolean determining if the theme is processing at the theme library.

      +

      role

      role: string

      The remote role of the theme.

      +

      Optional src

      src?: string

      A public URL where Shopify can access the theme code.

      +

      Settings

      Member Visibility

      Theme

      On This Page

      createdAtRuntimeidnameprocessingrolesrc
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_themes_types.ThemeAsset.html b/docs/api/cli-kit/interfaces/node_themes_types.ThemeAsset.html index 2ba9faa23d..8b04c2c3ec 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.ThemeAsset.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.ThemeAsset.html @@ -1,12 +1,12 @@ ThemeAsset | @shopify/cli-kit

      Interface ThemeAsset

      Represents a theme or theme extension asset.

      -
      interface ThemeAsset {
          attachment?: string;
          checksum: string;
          key: string;
          stats?: {
              mtime: number;
              size: number;
          };
          value?: string;
      }

      Hierarchy (view full)

      Properties

      attachment? +
      interface ThemeAsset {
          attachment?: string;
          checksum: string;
          key: string;
          stats?: {
              mtime: number;
              size: number;
          };
          value?: string;
      }

      Hierarchy (view full)

      Properties

      attachment? checksum key stats? value?

      Properties

      Optional attachment

      attachment?: string

      A base64-encoded image.

      -

      checksum

      checksum: string

      Represents the checksum value of the theme file.

      -

      key

      key: string

      Identifier of the theme file.

      -

      Optional stats

      stats?: {
          mtime: number;
          size: number;
      }

      File stats at time of last modification. For attachments, this is the size of the base64 string.

      -

      Type declaration

      • mtime: number
      • size: number

      Optional value

      value?: string

      The text content of the asset, such as the HTML and Liquid markup of a template file.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      attachmentchecksumkeystatsvalue
      \ No newline at end of file +

      checksum

      checksum: string

      Represents the checksum value of the theme file.

      +

      key

      key: string

      Identifier of the theme file.

      +

      Optional stats

      stats?: {
          mtime: number;
          size: number;
      }

      File stats at time of last modification. For attachments, this is the size of the base64 string.

      +

      Type declaration

      Optional value

      value?: string

      The text content of the asset, such as the HTML and Liquid markup of a template file.

      +

      Settings

      Member Visibility

      Theme

      On This Page

      attachmentchecksumkeystatsvalue
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_themes_types.ThemeExtensionFileSystem.html b/docs/api/cli-kit/interfaces/node_themes_types.ThemeExtensionFileSystem.html index 4d3c264749..e1f135ca24 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.ThemeExtensionFileSystem.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.ThemeExtensionFileSystem.html @@ -1,5 +1,5 @@ ThemeExtensionFileSystem | @shopify/cli-kit

      Interface ThemeExtensionFileSystem

      Represents a theme on the file system.

      -
      interface ThemeExtensionFileSystem {
          addEventListener: (<T>(eventName, cb) => void);
          delete: ((fileKey) => Promise<void>);
          files: Map<string, ThemeAsset>;
          read: ((fileKey) => Promise<undefined | string | Buffer>);
          ready: (() => Promise<void>);
          root: string;
          startWatcher: (() => Promise<void>);
          unsyncedFileKeys: Set<string>;
          write: ((asset) => Promise<void>);
      }

      Hierarchy (view full)

      Properties

      addEventListener +
      interface ThemeExtensionFileSystem {
          addEventListener: (<T>(eventName, cb) => void);
          delete: ((fileKey) => Promise<void>);
          files: Map<string, ThemeAsset>;
          read: ((fileKey) => Promise<undefined | string | Buffer>);
          ready: (() => Promise<void>);
          root: string;
          startWatcher: (() => Promise<void>);
          unsyncedFileKeys: Set<string>;
          write: ((asset) => Promise<void>);
      }

      Hierarchy (view full)

      Properties

      addEventListener delete files read @@ -9,17 +9,17 @@ unsyncedFileKeys write

      Properties

      addEventListener

      addEventListener: (<T>(eventName, cb) => void)

      Add callbacks to run after certain events are fired.

      -

      Type declaration

      delete

      delete: ((fileKey) => Promise<void>)

      Removes a file from the local disk and updates the file system

      +

      Type declaration

      delete

      delete: ((fileKey) => Promise<void>)

      Removes a file from the local disk and updates the file system

      Type declaration

        • (fileKey): Promise<void>

        • Parameters

          • fileKey: string

            The key of the file to remove

            -

          Returns Promise<void>

      files

      files: Map<string, ThemeAsset>

      Local files.

      -

      read

      read: ((fileKey) => Promise<undefined | string | Buffer>)

      Reads a file from the local disk and updates the file system +

      Returns Promise<void>

      files

      files: Map<string, ThemeAsset>

      Local files.

      +

      read

      read: ((fileKey) => Promise<undefined | string | Buffer>)

      Reads a file from the local disk and updates the file system Returns a ThemeAsset representing the file that was read Returns undefined if the file does not exist

      Type declaration

        • (fileKey): Promise<undefined | string | Buffer>

        • Parameters

          • fileKey: string

            The key of the file to read

            -

          Returns Promise<undefined | string | Buffer>

      ready

      ready: (() => Promise<void>)

      Promise that resolves when all the initial files are found.

      -

      Type declaration

        • (): Promise<void>

        • Returns Promise<void>

      root

      root: string

      The root path of the theme.

      -

      startWatcher

      startWatcher: (() => Promise<void>)

      Starts a file watcher for the theme extension directory.

      -

      Type declaration

        • (): Promise<void>

        • Returns Promise<void>

      unsyncedFileKeys

      unsyncedFileKeys: Set<string>

      File keys that have been modified in memory and are not uploaded yet.

      -

      write

      write: ((asset) => Promise<void>)

      Writes a file to the local disk and updates the file system

      +

      Returns Promise<undefined | string | Buffer>

      ready

      ready: (() => Promise<void>)

      Promise that resolves when all the initial files are found.

      +

      Type declaration

      root

      root: string

      The root path of the theme.

      +

      startWatcher

      startWatcher: (() => Promise<void>)

      Starts a file watcher for the theme extension directory.

      +

      Type declaration

      unsyncedFileKeys

      unsyncedFileKeys: Set<string>

      File keys that have been modified in memory and are not uploaded yet.

      +

      write

      write: ((asset) => Promise<void>)

      Writes a file to the local disk and updates the file system

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      addEventListenerdeletefilesreadreadyrootstartWatcherunsyncedFileKeyswrite
      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      On This Page

      addEventListenerdeletefilesreadreadyrootstartWatcherunsyncedFileKeyswrite
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystem.html b/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystem.html index caafd5b5ed..d75e21d4c9 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystem.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystem.html @@ -1,5 +1,5 @@ ThemeFileSystem | @shopify/cli-kit

      Interface ThemeFileSystem

      Represents a theme on the file system.

      -
      interface ThemeFileSystem {
          addEventListener: (<T>(eventName, cb) => void);
          applyIgnoreFilters: (<T>(files) => T[]);
          delete: ((fileKey) => Promise<void>);
          files: Map<string, ThemeAsset>;
          read: ((fileKey) => Promise<undefined | string | Buffer>);
          ready: (() => Promise<void>);
          root: string;
          startWatcher: ((themeId, adminSession) => Promise<void>);
          unsyncedFileKeys: Set<string>;
          write: ((asset) => Promise<void>);
      }

      Hierarchy (view full)

      Properties

      addEventListener +
      interface ThemeFileSystem {
          addEventListener: (<T>(eventName, cb) => void);
          applyIgnoreFilters: (<T>(files) => T[]);
          delete: ((fileKey) => Promise<void>);
          files: Map<string, ThemeAsset>;
          read: ((fileKey) => Promise<undefined | string | Buffer>);
          ready: (() => Promise<void>);
          root: string;
          startWatcher: ((themeId, adminSession) => Promise<void>);
          unsyncedFileKeys: Set<string>;
          write: ((asset) => Promise<void>);
      }

      Hierarchy (view full)

      Properties

      addEventListener applyIgnoreFilters delete files @@ -10,21 +10,21 @@ unsyncedFileKeys write

      Properties

      addEventListener

      addEventListener: (<T>(eventName, cb) => void)

      Add callbacks to run after certain events are fired.

      -

      Type declaration

      applyIgnoreFilters

      applyIgnoreFilters: (<T>(files) => T[])

      Applies filters to ignore files from .shopifyignore file, --ignore and --only flags.

      -

      Type declaration

        • <T>(files): T[]

        • Type Parameters

          • T extends {
                key: string;
            }

          Parameters

          • files: T[]

          Returns T[]

      delete

      delete: ((fileKey) => Promise<void>)

      Removes a file from the local disk and updates the file system

      +

      Type declaration

      applyIgnoreFilters

      applyIgnoreFilters: (<T>(files) => T[])

      Applies filters to ignore files from .shopifyignore file, --ignore and --only flags.

      +

      Type declaration

        • <T>(files): T[]

        • Type Parameters

          • T extends {
                key: string;
            }

          Parameters

          • files: T[]

          Returns T[]

      delete

      delete: ((fileKey) => Promise<void>)

      Removes a file from the local disk and updates the file system

      Type declaration

        • (fileKey): Promise<void>

        • Parameters

          • fileKey: string

            The key of the file to remove

            -

          Returns Promise<void>

      files

      files: Map<string, ThemeAsset>

      Local files.

      -

      read

      read: ((fileKey) => Promise<undefined | string | Buffer>)

      Reads a file from the local disk and updates the file system +

      Returns Promise<void>

      files

      files: Map<string, ThemeAsset>

      Local files.

      +

      read

      read: ((fileKey) => Promise<undefined | string | Buffer>)

      Reads a file from the local disk and updates the file system Returns a ThemeAsset representing the file that was read Returns undefined if the file does not exist

      Type declaration

        • (fileKey): Promise<undefined | string | Buffer>

        • Parameters

          • fileKey: string

            The key of the file to read

            -

          Returns Promise<undefined | string | Buffer>

      ready

      ready: (() => Promise<void>)

      Promise that resolves when all the initial files are found.

      -

      Type declaration

        • (): Promise<void>

        • Returns Promise<void>

      root

      root: string

      The root path of the theme.

      -

      startWatcher

      startWatcher: ((themeId, adminSession) => Promise<void>)

      Starts a file watcher for the theme directory.

      +

      Returns Promise<undefined | string | Buffer>

      ready

      ready: (() => Promise<void>)

      Promise that resolves when all the initial files are found.

      +

      Type declaration

      root

      root: string

      The root path of the theme.

      +

      startWatcher

      startWatcher: ((themeId, adminSession) => Promise<void>)

      Starts a file watcher for the theme directory.

      Type declaration

      Returns

      A Promise that resolves to an FSWatcher instance.

      -

      unsyncedFileKeys

      unsyncedFileKeys: Set<string>

      File keys that have been modified in memory and are not uploaded yet.

      -

      write

      write: ((asset) => Promise<void>)

      Writes a file to the local disk and updates the file system

      +

      unsyncedFileKeys

      unsyncedFileKeys: Set<string>

      File keys that have been modified in memory and are not uploaded yet.

      +

      write

      write: ((asset) => Promise<void>)

      Writes a file to the local disk and updates the file system

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      addEventListenerapplyIgnoreFiltersdeletefilesreadreadyrootstartWatcherunsyncedFileKeyswrite
      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      On This Page

      addEventListenerapplyIgnoreFiltersdeletefilesreadreadyrootstartWatcherunsyncedFileKeyswrite
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystemOptions.html b/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystemOptions.html index de54b41dc0..400549315a 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystemOptions.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystemOptions.html @@ -1,3 +1,3 @@ -ThemeFileSystemOptions | @shopify/cli-kit

      Interface ThemeFileSystemOptions

      interface ThemeFileSystemOptions {
          filters?: {
              ignore?: string[];
              only?: string[];
          };
          notify?: string;
      }

      Properties

      filters? +ThemeFileSystemOptions | @shopify/cli-kit

      Interface ThemeFileSystemOptions

      interface ThemeFileSystemOptions {
          filters?: {
              ignore?: string[];
              only?: string[];
          };
          notify?: string;
      }

      Properties

      filters? notify? -

      Properties

      Optional filters

      filters?: {
          ignore?: string[];
          only?: string[];
      }

      Type declaration

      • Optional ignore?: string[]
      • Optional only?: string[]

      Optional notify

      notify?: string

      Settings

      Member Visibility

      Theme

      On This Page

      filtersnotify
      \ No newline at end of file +

      Properties

      Optional filters

      filters?: {
          ignore?: string[];
          only?: string[];
      }

      Type declaration

      • Optional ignore?: string[]
      • Optional only?: string[]

      Optional notify

      notify?: string

      Settings

      Member Visibility

      Theme

      On This Page

      filtersnotify
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_themes_types.VirtualFileSystem.html b/docs/api/cli-kit/interfaces/node_themes_types.VirtualFileSystem.html index f9e40f90c0..6996beaf92 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.VirtualFileSystem.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.VirtualFileSystem.html @@ -1,5 +1,5 @@ VirtualFileSystem | @shopify/cli-kit

      Interface VirtualFileSystem

      Represents a theme on the file system.

      -
      interface VirtualFileSystem {
          addEventListener: (<T>(eventName, cb) => void);
          delete: ((fileKey) => Promise<void>);
          files: Map<string, ThemeAsset>;
          read: ((fileKey) => Promise<undefined | string | Buffer>);
          ready: (() => Promise<void>);
          root: string;
          unsyncedFileKeys: Set<string>;
          write: ((asset) => Promise<void>);
      }

      Hierarchy (view full)

      Properties

      addEventListener +
      interface VirtualFileSystem {
          addEventListener: (<T>(eventName, cb) => void);
          delete: ((fileKey) => Promise<void>);
          files: Map<string, ThemeAsset>;
          read: ((fileKey) => Promise<undefined | string | Buffer>);
          ready: (() => Promise<void>);
          root: string;
          unsyncedFileKeys: Set<string>;
          write: ((asset) => Promise<void>);
      }

      Hierarchy (view full)

      Properties

      addEventListener delete files read @@ -8,16 +8,16 @@ unsyncedFileKeys write

      Properties

      addEventListener

      addEventListener: (<T>(eventName, cb) => void)

      Add callbacks to run after certain events are fired.

      -

      Type declaration

      delete

      delete: ((fileKey) => Promise<void>)

      Removes a file from the local disk and updates the file system

      +

      Type declaration

      delete

      delete: ((fileKey) => Promise<void>)

      Removes a file from the local disk and updates the file system

      Type declaration

        • (fileKey): Promise<void>

        • Parameters

          • fileKey: string

            The key of the file to remove

            -

          Returns Promise<void>

      files

      files: Map<string, ThemeAsset>

      Local files.

      -

      read

      read: ((fileKey) => Promise<undefined | string | Buffer>)

      Reads a file from the local disk and updates the file system +

      Returns Promise<void>

      files

      files: Map<string, ThemeAsset>

      Local files.

      +

      read

      read: ((fileKey) => Promise<undefined | string | Buffer>)

      Reads a file from the local disk and updates the file system Returns a ThemeAsset representing the file that was read Returns undefined if the file does not exist

      Type declaration

        • (fileKey): Promise<undefined | string | Buffer>

        • Parameters

          • fileKey: string

            The key of the file to read

            -

          Returns Promise<undefined | string | Buffer>

      ready

      ready: (() => Promise<void>)

      Promise that resolves when all the initial files are found.

      -

      Type declaration

        • (): Promise<void>

        • Returns Promise<void>

      root

      root: string

      The root path of the theme.

      -

      unsyncedFileKeys

      unsyncedFileKeys: Set<string>

      File keys that have been modified in memory and are not uploaded yet.

      -

      write

      write: ((asset) => Promise<void>)

      Writes a file to the local disk and updates the file system

      +

      Returns Promise<undefined | string | Buffer>

      ready

      ready: (() => Promise<void>)

      Promise that resolves when all the initial files are found.

      +

      Type declaration

      root

      root: string

      The root path of the theme.

      +

      unsyncedFileKeys

      unsyncedFileKeys: Set<string>

      File keys that have been modified in memory and are not uploaded yet.

      +

      write

      write: ((asset) => Promise<void>)

      Writes a file to the local disk and updates the file system

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      addEventListenerdeletefilesreadreadyrootunsyncedFileKeyswrite
      \ No newline at end of file +

      Returns Promise<void>

      Settings

      Member Visibility

      Theme

      On This Page

      addEventListenerdeletefilesreadreadyrootunsyncedFileKeyswrite
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.InfoTableSection.html b/docs/api/cli-kit/interfaces/node_ui.InfoTableSection.html index 569b15109b..aa5c9e510c 100644 --- a/docs/api/cli-kit/interfaces/node_ui.InfoTableSection.html +++ b/docs/api/cli-kit/interfaces/node_ui.InfoTableSection.html @@ -1,7 +1,7 @@ -InfoTableSection | @shopify/cli-kit

      Interface InfoTableSection

      interface InfoTableSection {
          bullet?: string;
          color?: LiteralUnion<(keyof ForegroundColor), string>;
          emptyItemsText?: string;
          header: string;
          helperText?: string;
          items: Items;
      }

      Properties

      bullet? +InfoTableSection | @shopify/cli-kit

      Interface InfoTableSection

      interface InfoTableSection {
          bullet?: string;
          color?: LiteralUnion<(keyof ForegroundColor), string>;
          emptyItemsText?: string;
          header: string;
          helperText?: string;
          items: Items;
      }

      Properties

      bullet? color? emptyItemsText? header helperText? items -

      Properties

      Optional bullet

      bullet?: string

      Optional color

      color?: LiteralUnion<(keyof ForegroundColor), string>

      Optional emptyItemsText

      emptyItemsText?: string

      header

      header: string

      Optional helperText

      helperText?: string

      items

      items: Items

      Settings

      Member Visibility

      Theme

      On This Page

      bulletcoloremptyItemsTextheaderhelperTextitems
      \ No newline at end of file +

      Properties

      Optional bullet

      bullet?: string

      Optional color

      color?: LiteralUnion<(keyof ForegroundColor), string>

      Optional emptyItemsText

      emptyItemsText?: string

      header

      header: string

      Optional helperText

      helperText?: string

      items

      items: Items

      Settings

      Member Visibility

      Theme

      On This Page

      bulletcoloremptyItemsTextheaderhelperTextitems
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.LinkToken.html b/docs/api/cli-kit/interfaces/node_ui.LinkToken.html index fb748882b5..eae36db00c 100644 --- a/docs/api/cli-kit/interfaces/node_ui.LinkToken.html +++ b/docs/api/cli-kit/interfaces/node_ui.LinkToken.html @@ -1,2 +1,2 @@ -LinkToken | @shopify/cli-kit

      Interface LinkToken

      interface LinkToken {
          link: {
              label?: string;
              url: string;
          };
      }

      Properties

      link -

      Properties

      link

      link: {
          label?: string;
          url: string;
      }

      Type declaration

      • Optional label?: string
      • url: string

      Settings

      Member Visibility

      Theme

      On This Page

      link
      \ No newline at end of file +LinkToken | @shopify/cli-kit

      Interface LinkToken

      interface LinkToken {
          link: {
              label?: string;
              url: string;
          };
      }

      Properties

      link +

      Properties

      link

      link: {
          label?: string;
          url: string;
      }

      Type declaration

      • Optional label?: string
      • url: string

      Settings

      Member Visibility

      Theme

      On This Page

      link
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.ListToken.html b/docs/api/cli-kit/interfaces/node_ui.ListToken.html index 131c53b793..a6ff730680 100644 --- a/docs/api/cli-kit/interfaces/node_ui.ListToken.html +++ b/docs/api/cli-kit/interfaces/node_ui.ListToken.html @@ -1,2 +1,2 @@ -ListToken | @shopify/cli-kit

      Interface ListToken

      interface ListToken {
          list: {
              items: TokenItem<InlineToken>[];
              ordered?: boolean;
              title?: TokenItem<InlineToken>;
          };
      }

      Properties

      list -

      Properties

      list

      list: {
          items: TokenItem<InlineToken>[];
          ordered?: boolean;
          title?: TokenItem<InlineToken>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      list
      \ No newline at end of file +ListToken | @shopify/cli-kit

      Interface ListToken

      interface ListToken {
          list: {
              items: TokenItem<InlineToken>[];
              ordered?: boolean;
              title?: TokenItem<InlineToken>;
          };
      }

      Properties

      list +

      Properties

      list

      list: {
          items: TokenItem<InlineToken>[];
          ordered?: boolean;
          title?: TokenItem<InlineToken>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      On This Page

      list
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.RenderAutocompleteOptions.html b/docs/api/cli-kit/interfaces/node_ui.RenderAutocompleteOptions.html index 4d9d57bb07..e17df24c34 100644 --- a/docs/api/cli-kit/interfaces/node_ui.RenderAutocompleteOptions.html +++ b/docs/api/cli-kit/interfaces/node_ui.RenderAutocompleteOptions.html @@ -1,4 +1,4 @@ -RenderAutocompleteOptions | @shopify/cli-kit

      Interface RenderAutocompleteOptions<T>

      interface RenderAutocompleteOptions<T> {
          abortSignal?: AbortSignal;
          choices: Item<T>[];
          hasMorePages?: boolean;
          infoMessage?: {
              body: TokenItem;
              title: {
                  color?: LiteralUnion<(keyof ForegroundColor), string>;
                  text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
              };
          };
          infoTable?: {
              [header: string]: Items;
          } | InfoTableSection[];
          message: Message;
          renderOptions?: RenderOptions;
          search?: ((term) => Promise<SearchResults<T>>);
      }

      Type Parameters

      • T

      Hierarchy

      • PartialBy<Omit<AutocompletePromptProps<T>, "onSubmit">, "search">
        • RenderAutocompleteOptions

      Properties

      abortSignal? +RenderAutocompleteOptions | @shopify/cli-kit

      Interface RenderAutocompleteOptions<T>

      interface RenderAutocompleteOptions<T> {
          abortSignal?: AbortSignal;
          choices: Item<T>[];
          hasMorePages?: boolean;
          infoMessage?: {
              body: TokenItem;
              title: {
                  color?: LiteralUnion<(keyof ForegroundColor), string>;
                  text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
              };
          };
          infoTable?: {
              [header: string]: Items;
          } | InfoTableSection[];
          message: Message;
          renderOptions?: RenderOptions;
          search?: ((term) => Promise<SearchResults<T>>);
      }

      Type Parameters

      • T

      Hierarchy

      • PartialBy<Omit<AutocompletePromptProps<T>, "onSubmit">, "search">
        • RenderAutocompleteOptions

      Properties

      abortSignal? choices hasMorePages? infoMessage? @@ -6,4 +6,4 @@ message renderOptions? search? -

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      choices

      choices: Item<T>[]

      Optional hasMorePages

      hasMorePages?: boolean

      Optional infoMessage

      infoMessage?: {
          body: TokenItem;
          title: {
              color?: LiteralUnion<(keyof ForegroundColor), string>;
              text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
          };
      }

      Type declaration

      • body: TokenItem
      • title: {
            color?: LiteralUnion<(keyof ForegroundColor), string>;
            text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
        }
        • Optional color?: LiteralUnion<(keyof ForegroundColor), string>
        • text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>

      Optional infoTable

      infoTable?: {
          [header: string]: Items;
      } | InfoTableSection[]

      Type declaration

      • [header: string]: Items

      message

      message: Message

      Optional renderOptions

      renderOptions?: RenderOptions

      Optional search

      search?: ((term) => Promise<SearchResults<T>>)

      Type declaration

        • (term): Promise<SearchResults<T>>

        • Parameters

          • term: string

          Returns Promise<SearchResults<T>>

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalchoiceshasMorePagesinfoMessageinfoTablemessagerenderOptionssearch
      \ No newline at end of file +

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      choices

      choices: Item<T>[]

      Optional hasMorePages

      hasMorePages?: boolean

      Optional infoMessage

      infoMessage?: {
          body: TokenItem;
          title: {
              color?: LiteralUnion<(keyof ForegroundColor), string>;
              text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
          };
      }

      Type declaration

      • body: TokenItem
      • title: {
            color?: LiteralUnion<(keyof ForegroundColor), string>;
            text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
        }
        • Optional color?: LiteralUnion<(keyof ForegroundColor), string>
        • text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>

      Optional infoTable

      infoTable?: {
          [header: string]: Items;
      } | InfoTableSection[]

      Type declaration

      • [header: string]: Items

      message

      message: Message

      Optional renderOptions

      renderOptions?: RenderOptions

      Optional search

      search?: ((term) => Promise<SearchResults<T>>)

      Type declaration

        • (term): Promise<SearchResults<T>>

        • Parameters

          • term: string

          Returns Promise<SearchResults<T>>

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalchoiceshasMorePagesinfoMessageinfoTablemessagerenderOptionssearch
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.RenderConcurrentOptions.html b/docs/api/cli-kit/interfaces/node_ui.RenderConcurrentOptions.html index 542ead1992..98938b11e0 100644 --- a/docs/api/cli-kit/interfaces/node_ui.RenderConcurrentOptions.html +++ b/docs/api/cli-kit/interfaces/node_ui.RenderConcurrentOptions.html @@ -1,7 +1,7 @@ -RenderConcurrentOptions | @shopify/cli-kit

      Interface RenderConcurrentOptions

      interface RenderConcurrentOptions {
          abortSignal?: AbortSignal;
          keepRunningAfterProcessesResolve?: boolean;
          prefixColumnSize?: number;
          processes: OutputProcess[];
          renderOptions?: RenderOptions;
          showTimestamps?: boolean;
      }

      Hierarchy

      • PartialBy<ConcurrentOutputProps, "abortSignal">
        • RenderConcurrentOptions

      Properties

      abortSignal? +RenderConcurrentOptions | @shopify/cli-kit

      Interface RenderConcurrentOptions

      interface RenderConcurrentOptions {
          abortSignal?: AbortSignal;
          keepRunningAfterProcessesResolve?: boolean;
          prefixColumnSize?: number;
          processes: OutputProcess[];
          renderOptions?: RenderOptions;
          showTimestamps?: boolean;
      }

      Hierarchy

      • PartialBy<ConcurrentOutputProps, "abortSignal">
        • RenderConcurrentOptions

      Properties

      abortSignal? keepRunningAfterProcessesResolve? prefixColumnSize? processes renderOptions? showTimestamps? -

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      Optional keepRunningAfterProcessesResolve

      keepRunningAfterProcessesResolve?: boolean

      Optional prefixColumnSize

      prefixColumnSize?: number

      processes

      processes: OutputProcess[]

      Optional renderOptions

      renderOptions?: RenderOptions

      Optional showTimestamps

      showTimestamps?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalkeepRunningAfterProcessesResolveprefixColumnSizeprocessesrenderOptionsshowTimestamps
      \ No newline at end of file +

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      Optional keepRunningAfterProcessesResolve

      keepRunningAfterProcessesResolve?: boolean

      Optional prefixColumnSize

      prefixColumnSize?: number

      processes

      processes: OutputProcess[]

      Optional renderOptions

      renderOptions?: RenderOptions

      Optional showTimestamps

      showTimestamps?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalkeepRunningAfterProcessesResolveprefixColumnSizeprocessesrenderOptionsshowTimestamps
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.RenderConfirmationPromptOptions.html b/docs/api/cli-kit/interfaces/node_ui.RenderConfirmationPromptOptions.html index 62c11704fb..5f8a65641f 100644 --- a/docs/api/cli-kit/interfaces/node_ui.RenderConfirmationPromptOptions.html +++ b/docs/api/cli-kit/interfaces/node_ui.RenderConfirmationPromptOptions.html @@ -1,4 +1,4 @@ -RenderConfirmationPromptOptions | @shopify/cli-kit

      Interface RenderConfirmationPromptOptions

      interface RenderConfirmationPromptOptions {
          abortSignal?: AbortSignal;
          cancellationMessage?: string;
          confirmationMessage?: string;
          defaultValue?: boolean;
          infoMessage?: {
              body: TokenItem;
              title: {
                  color?: LiteralUnion<(keyof ForegroundColor), string>;
                  text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
              };
          };
          infoTable?: {
              [header: string]: Items;
          } | InfoTableSection[];
          message: Message;
          renderOptions?: RenderOptions;
      }

      Hierarchy

      • Pick<SelectPromptProps<boolean>, "message" | "infoTable" | "infoMessage" | "abortSignal">
        • RenderConfirmationPromptOptions

      Properties

      abortSignal? +RenderConfirmationPromptOptions | @shopify/cli-kit

      Interface RenderConfirmationPromptOptions

      interface RenderConfirmationPromptOptions {
          abortSignal?: AbortSignal;
          cancellationMessage?: string;
          confirmationMessage?: string;
          defaultValue?: boolean;
          infoMessage?: {
              body: TokenItem;
              title: {
                  color?: LiteralUnion<(keyof ForegroundColor), string>;
                  text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
              };
          };
          infoTable?: {
              [header: string]: Items;
          } | InfoTableSection[];
          message: Message;
          renderOptions?: RenderOptions;
      }

      Hierarchy

      • Pick<SelectPromptProps<boolean>, "message" | "infoTable" | "infoMessage" | "abortSignal">
        • RenderConfirmationPromptOptions

      Properties

      abortSignal? cancellationMessage? confirmationMessage? defaultValue? @@ -6,4 +6,4 @@ infoTable? message renderOptions? -

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      Optional cancellationMessage

      cancellationMessage?: string

      Optional confirmationMessage

      confirmationMessage?: string

      Optional defaultValue

      defaultValue?: boolean

      Optional infoMessage

      infoMessage?: {
          body: TokenItem;
          title: {
              color?: LiteralUnion<(keyof ForegroundColor), string>;
              text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
          };
      }

      Type declaration

      • body: TokenItem
      • title: {
            color?: LiteralUnion<(keyof ForegroundColor), string>;
            text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
        }
        • Optional color?: LiteralUnion<(keyof ForegroundColor), string>
        • text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>

      Optional infoTable

      infoTable?: {
          [header: string]: Items;
      } | InfoTableSection[]

      Type declaration

      • [header: string]: Items

      message

      message: Message

      Optional renderOptions

      renderOptions?: RenderOptions

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalcancellationMessageconfirmationMessagedefaultValueinfoMessageinfoTablemessagerenderOptions
      \ No newline at end of file +

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      Optional cancellationMessage

      cancellationMessage?: string

      Optional confirmationMessage

      confirmationMessage?: string

      Optional defaultValue

      defaultValue?: boolean

      Optional infoMessage

      infoMessage?: {
          body: TokenItem;
          title: {
              color?: LiteralUnion<(keyof ForegroundColor), string>;
              text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
          };
      }

      Type declaration

      • body: TokenItem
      • title: {
            color?: LiteralUnion<(keyof ForegroundColor), string>;
            text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
        }
        • Optional color?: LiteralUnion<(keyof ForegroundColor), string>
        • text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>

      Optional infoTable

      infoTable?: {
          [header: string]: Items;
      } | InfoTableSection[]

      Type declaration

      • [header: string]: Items

      message

      message: Message

      Optional renderOptions

      renderOptions?: RenderOptions

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalcancellationMessageconfirmationMessagedefaultValueinfoMessageinfoTablemessagerenderOptions
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.RenderDangerousConfirmationPromptOptions.html b/docs/api/cli-kit/interfaces/node_ui.RenderDangerousConfirmationPromptOptions.html index 4404bfa69f..1066f64446 100644 --- a/docs/api/cli-kit/interfaces/node_ui.RenderDangerousConfirmationPromptOptions.html +++ b/docs/api/cli-kit/interfaces/node_ui.RenderDangerousConfirmationPromptOptions.html @@ -1,6 +1,6 @@ -RenderDangerousConfirmationPromptOptions | @shopify/cli-kit

      Interface RenderDangerousConfirmationPromptOptions

      interface RenderDangerousConfirmationPromptOptions {
          abortSignal?: AbortSignal;
          confirmation: string;
          infoTable?: {
              [header: string]: Items;
          } | InfoTableSection[];
          message: string;
          renderOptions?: RenderOptions;
      }

      Hierarchy

      • Omit<DangerousConfirmationPromptProps, "onSubmit">
        • RenderDangerousConfirmationPromptOptions

      Properties

      abortSignal? +RenderDangerousConfirmationPromptOptions | @shopify/cli-kit

      Interface RenderDangerousConfirmationPromptOptions

      interface RenderDangerousConfirmationPromptOptions {
          abortSignal?: AbortSignal;
          confirmation: string;
          infoTable?: {
              [header: string]: Items;
          } | InfoTableSection[];
          message: string;
          renderOptions?: RenderOptions;
      }

      Hierarchy

      • Omit<DangerousConfirmationPromptProps, "onSubmit">
        • RenderDangerousConfirmationPromptOptions

      Properties

      abortSignal? confirmation infoTable? message renderOptions? -

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      confirmation

      confirmation: string

      Optional infoTable

      infoTable?: {
          [header: string]: Items;
      } | InfoTableSection[]

      Type declaration

      • [header: string]: Items

      message

      message: string

      Optional renderOptions

      renderOptions?: RenderOptions

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalconfirmationinfoTablemessagerenderOptions
      \ No newline at end of file +

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      confirmation

      confirmation: string

      Optional infoTable

      infoTable?: {
          [header: string]: Items;
      } | InfoTableSection[]

      Type declaration

      • [header: string]: Items

      message

      message: string

      Optional renderOptions

      renderOptions?: RenderOptions

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalconfirmationinfoTablemessagerenderOptions
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.RenderSelectPromptOptions.html b/docs/api/cli-kit/interfaces/node_ui.RenderSelectPromptOptions.html index d24b809d13..902923648e 100644 --- a/docs/api/cli-kit/interfaces/node_ui.RenderSelectPromptOptions.html +++ b/docs/api/cli-kit/interfaces/node_ui.RenderSelectPromptOptions.html @@ -1,4 +1,4 @@ -RenderSelectPromptOptions | @shopify/cli-kit

      Interface RenderSelectPromptOptions<T>

      interface RenderSelectPromptOptions<T> {
          abortSignal?: AbortSignal;
          choices: Item<T>[];
          defaultValue?: T;
          infoMessage?: {
              body: TokenItem;
              title: {
                  color?: LiteralUnion<(keyof ForegroundColor), string>;
                  text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
              };
          };
          infoTable?: {
              [header: string]: Items;
          } | InfoTableSection[];
          isConfirmationPrompt?: boolean;
          message: Message;
          renderOptions?: RenderOptions;
      }

      Type Parameters

      • T

      Hierarchy

      • Omit<SelectPromptProps<T>, "onSubmit">
        • RenderSelectPromptOptions

      Properties

      abortSignal? +RenderSelectPromptOptions | @shopify/cli-kit

      Interface RenderSelectPromptOptions<T>

      interface RenderSelectPromptOptions<T> {
          abortSignal?: AbortSignal;
          choices: Item<T>[];
          defaultValue?: T;
          infoMessage?: {
              body: TokenItem;
              title: {
                  color?: LiteralUnion<(keyof ForegroundColor), string>;
                  text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
              };
          };
          infoTable?: {
              [header: string]: Items;
          } | InfoTableSection[];
          isConfirmationPrompt?: boolean;
          message: Message;
          renderOptions?: RenderOptions;
      }

      Type Parameters

      • T

      Hierarchy

      • Omit<SelectPromptProps<T>, "onSubmit">
        • RenderSelectPromptOptions

      Properties

      abortSignal? choices defaultValue? infoMessage? @@ -6,4 +6,4 @@ isConfirmationPrompt? message renderOptions? -

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      choices

      choices: Item<T>[]

      Optional defaultValue

      defaultValue?: T

      Optional infoMessage

      infoMessage?: {
          body: TokenItem;
          title: {
              color?: LiteralUnion<(keyof ForegroundColor), string>;
              text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
          };
      }

      Type declaration

      • body: TokenItem
      • title: {
            color?: LiteralUnion<(keyof ForegroundColor), string>;
            text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
        }
        • Optional color?: LiteralUnion<(keyof ForegroundColor), string>
        • text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>

      Optional infoTable

      infoTable?: {
          [header: string]: Items;
      } | InfoTableSection[]

      Type declaration

      • [header: string]: Items

      Optional isConfirmationPrompt

      isConfirmationPrompt?: boolean

      message

      message: Message

      Optional renderOptions

      renderOptions?: RenderOptions

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalchoicesdefaultValueinfoMessageinfoTableisConfirmationPromptmessagerenderOptions
      \ No newline at end of file +

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      choices

      choices: Item<T>[]

      Optional defaultValue

      defaultValue?: T

      Optional infoMessage

      infoMessage?: {
          body: TokenItem;
          title: {
              color?: LiteralUnion<(keyof ForegroundColor), string>;
              text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
          };
      }

      Type declaration

      • body: TokenItem
      • title: {
            color?: LiteralUnion<(keyof ForegroundColor), string>;
            text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
        }
        • Optional color?: LiteralUnion<(keyof ForegroundColor), string>
        • text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>

      Optional infoTable

      infoTable?: {
          [header: string]: Items;
      } | InfoTableSection[]

      Type declaration

      • [header: string]: Items

      Optional isConfirmationPrompt

      isConfirmationPrompt?: boolean

      message

      message: Message

      Optional renderOptions

      renderOptions?: RenderOptions

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalchoicesdefaultValueinfoMessageinfoTableisConfirmationPromptmessagerenderOptions
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.RenderTextPromptOptions.html b/docs/api/cli-kit/interfaces/node_ui.RenderTextPromptOptions.html index 169d79e12d..38913cbeb0 100644 --- a/docs/api/cli-kit/interfaces/node_ui.RenderTextPromptOptions.html +++ b/docs/api/cli-kit/interfaces/node_ui.RenderTextPromptOptions.html @@ -1,4 +1,4 @@ -RenderTextPromptOptions | @shopify/cli-kit

      Interface RenderTextPromptOptions

      interface RenderTextPromptOptions {
          abortSignal?: AbortSignal;
          allowEmpty?: boolean;
          defaultValue?: string;
          emptyDisplayedValue?: string;
          initialAnswer?: string;
          message: string;
          password?: boolean;
          preview?: ((value) => TokenItem<InlineToken>);
          renderOptions?: RenderOptions;
          validate?: ((value) => undefined | string);
      }

      Hierarchy

      • Omit<TextPromptProps, "onSubmit">
        • RenderTextPromptOptions

      Properties

      abortSignal? +RenderTextPromptOptions | @shopify/cli-kit

      Interface RenderTextPromptOptions

      interface RenderTextPromptOptions {
          abortSignal?: AbortSignal;
          allowEmpty?: boolean;
          defaultValue?: string;
          emptyDisplayedValue?: string;
          initialAnswer?: string;
          message: string;
          password?: boolean;
          preview?: ((value) => TokenItem<InlineToken>);
          renderOptions?: RenderOptions;
          validate?: ((value) => undefined | string);
      }

      Hierarchy

      • Omit<TextPromptProps, "onSubmit">
        • RenderTextPromptOptions

      Properties

      abortSignal? allowEmpty? defaultValue? emptyDisplayedValue? @@ -8,4 +8,4 @@ preview? renderOptions? validate? -

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      Optional allowEmpty

      allowEmpty?: boolean

      Optional defaultValue

      defaultValue?: string

      Optional emptyDisplayedValue

      emptyDisplayedValue?: string

      Optional initialAnswer

      initialAnswer?: string

      message

      message: string

      Optional password

      password?: boolean

      Optional preview

      preview?: ((value) => TokenItem<InlineToken>)

      Type declaration

      Optional renderOptions

      renderOptions?: RenderOptions

      Optional validate

      validate?: ((value) => undefined | string)

      Type declaration

        • (value): undefined | string

        • Parameters

          • value: string

          Returns undefined | string

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalallowEmptydefaultValueemptyDisplayedValueinitialAnswermessagepasswordpreviewrenderOptionsvalidate
      \ No newline at end of file +

      Properties

      Optional abortSignal

      abortSignal?: AbortSignal

      Optional allowEmpty

      allowEmpty?: boolean

      Optional defaultValue

      defaultValue?: string

      Optional emptyDisplayedValue

      emptyDisplayedValue?: string

      Optional initialAnswer

      initialAnswer?: string

      message

      message: string

      Optional password

      password?: boolean

      Optional preview

      preview?: ((value) => TokenItem<InlineToken>)

      Type declaration

      Optional renderOptions

      renderOptions?: RenderOptions

      Optional validate

      validate?: ((value) => undefined | string)

      Type declaration

        • (value): undefined | string

        • Parameters

          • value: string

          Returns undefined | string

      Settings

      Member Visibility

      Theme

      On This Page

      abortSignalallowEmptydefaultValueemptyDisplayedValueinitialAnswermessagepasswordpreviewrenderOptionsvalidate
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui.Task.html b/docs/api/cli-kit/interfaces/node_ui.Task.html index 84c07266e4..17d178072a 100644 --- a/docs/api/cli-kit/interfaces/node_ui.Task.html +++ b/docs/api/cli-kit/interfaces/node_ui.Task.html @@ -1,7 +1,7 @@ -Task | @shopify/cli-kit

      Interface Task<TContext>

      interface Task<TContext> {
          errors?: Error[];
          retry?: number;
          retryCount?: number;
          skip?: ((ctx) => boolean);
          task: ((ctx, task) => Promise<void | Task<TContext>[]>);
          title: string;
      }

      Type Parameters

      • TContext = unknown

      Properties

      errors? +Task | @shopify/cli-kit

      Interface Task<TContext>

      interface Task<TContext> {
          errors?: Error[];
          retry?: number;
          retryCount?: number;
          skip?: ((ctx) => boolean);
          task: ((ctx, task) => Promise<void | Task<TContext>[]>);
          title: string;
      }

      Type Parameters

      • TContext = unknown

      Properties

      errors? retry? retryCount? skip? task title -

      Properties

      Optional errors

      errors?: Error[]

      Optional retry

      retry?: number

      Optional retryCount

      retryCount?: number

      Optional skip

      skip?: ((ctx) => boolean)

      Type declaration

        • (ctx): boolean

        • Parameters

          Returns boolean

      task

      task: ((ctx, task) => Promise<void | Task<TContext>[]>)

      Type declaration

      title

      title: string

      Settings

      Member Visibility

      Theme

      On This Page

      errorsretryretryCountskiptasktitle
      \ No newline at end of file +

      Properties

      Optional errors

      errors?: Error[]

      Optional retry

      retry?: number

      Optional retryCount

      retryCount?: number

      Optional skip

      skip?: ((ctx) => boolean)

      Type declaration

        • (ctx): boolean

        • Parameters

          Returns boolean

      task

      task: ((ctx, task) => Promise<void | Task<TContext>[]>)

      Type declaration

      title

      title: string

      Settings

      Member Visibility

      Theme

      On This Page

      errorsretryretryCountskiptasktitle
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_ui_components.ConcurrentOutputContext.html b/docs/api/cli-kit/interfaces/node_ui_components.ConcurrentOutputContext.html index 719877630d..19d27a4776 100644 --- a/docs/api/cli-kit/interfaces/node_ui_components.ConcurrentOutputContext.html +++ b/docs/api/cli-kit/interfaces/node_ui_components.ConcurrentOutputContext.html @@ -1,3 +1,3 @@ -ConcurrentOutputContext | @shopify/cli-kit

      Interface ConcurrentOutputContext

      interface ConcurrentOutputContext {
          outputPrefix?: string;
          stripAnsi?: boolean;
      }

      Properties

      outputPrefix? +ConcurrentOutputContext | @shopify/cli-kit

      Interface ConcurrentOutputContext

      interface ConcurrentOutputContext {
          outputPrefix?: string;
          stripAnsi?: boolean;
      }

      Properties

      outputPrefix? stripAnsi? -

      Properties

      Optional outputPrefix

      outputPrefix?: string

      Optional stripAnsi

      stripAnsi?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      outputPrefixstripAnsi
      \ No newline at end of file +

      Properties

      Optional outputPrefix

      outputPrefix?: string

      Optional stripAnsi

      stripAnsi?: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      outputPrefixstripAnsi
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_vendor_otel_js_export_InstantaneousMetricReader.InstantaneousMetricReaderOptions.html b/docs/api/cli-kit/interfaces/node_vendor_otel_js_export_InstantaneousMetricReader.InstantaneousMetricReaderOptions.html index 25960f48be..d6ff022c46 100644 --- a/docs/api/cli-kit/interfaces/node_vendor_otel_js_export_InstantaneousMetricReader.InstantaneousMetricReaderOptions.html +++ b/docs/api/cli-kit/interfaces/node_vendor_otel_js_export_InstantaneousMetricReader.InstantaneousMetricReaderOptions.html @@ -1,5 +1,5 @@ -InstantaneousMetricReaderOptions | @shopify/cli-kit

      Interface InstantaneousMetricReaderOptions

      interface InstantaneousMetricReaderOptions {
          exporter: PushMetricExporter;
          throttleLimit: number;
      }

      Properties

      exporter +InstantaneousMetricReaderOptions | @shopify/cli-kit

      Interface InstantaneousMetricReaderOptions

      interface InstantaneousMetricReaderOptions {
          exporter: PushMetricExporter;
          throttleLimit: number;
      }

      Properties

      exporter throttleLimit

      Properties

      exporter

      exporter: PushMetricExporter

      The backing exporter for the metric reader.

      -

      throttleLimit

      throttleLimit: number

      How much the export should be throttled in milliseconds.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      exporterthrottleLimit
      \ No newline at end of file +

      throttleLimit

      throttleLimit: number

      How much the export should be throttled in milliseconds.

      +

      Settings

      Member Visibility

      Theme

      On This Page

      exporterthrottleLimit
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.BaseOtelServiceOptions.html b/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.BaseOtelServiceOptions.html index 08ba5b18bd..1da172c5e9 100644 --- a/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.BaseOtelServiceOptions.html +++ b/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.BaseOtelServiceOptions.html @@ -1,12 +1,12 @@ -BaseOtelServiceOptions | @shopify/cli-kit

      Interface BaseOtelServiceOptions

      interface BaseOtelServiceOptions {
          meterProvider?: MeterProvider;
          metrics?: MetricsConfig;
          onRecord?: OnRecordCallback;
          prefixMetric?: boolean;
          serviceName: string;
      }

      Hierarchy (view full)

      Properties

      meterProvider? +BaseOtelServiceOptions | @shopify/cli-kit

      Interface BaseOtelServiceOptions

      interface BaseOtelServiceOptions {
          meterProvider?: MeterProvider;
          metrics?: MetricsConfig;
          onRecord?: OnRecordCallback;
          prefixMetric?: boolean;
          serviceName: string;
      }

      Hierarchy (view full)

      Properties

      meterProvider? metrics? onRecord? prefixMetric? serviceName

      Properties

      Optional meterProvider

      meterProvider?: MeterProvider

      Override the default meter provider.

      -

      Optional metrics

      metrics?: MetricsConfig

      Metrics to register on startup.

      -

      Optional onRecord

      onRecord?: OnRecordCallback

      Called when a metric is recorded. addOnRecord can also be used to add +

      Optional metrics

      metrics?: MetricsConfig

      Metrics to register on startup.

      +

      Optional onRecord

      onRecord?: OnRecordCallback

      Called when a metric is recorded. addOnRecord can also be used to add listeners anytime.

      -

      Optional prefixMetric

      prefixMetric?: boolean

      If this is set to true then the service name is prefixed to every metric.

      -

      serviceName

      serviceName: string

      Service name is a unique name for an application/service.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      meterProvidermetricsonRecordprefixMetricserviceName
      \ No newline at end of file +

      Optional prefixMetric

      prefixMetric?: boolean

      If this is set to true then the service name is prefixed to every metric.

      +

      serviceName

      serviceName: string

      Service name is a unique name for an application/service.

      +

      Settings

      Member Visibility

      Theme

      On This Page

      meterProvidermetricsonRecordprefixMetricserviceName
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.DefaultOtelServiceOptions.html b/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.DefaultOtelServiceOptions.html index dae7b7f921..5de2d4a231 100644 --- a/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.DefaultOtelServiceOptions.html +++ b/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.DefaultOtelServiceOptions.html @@ -1,4 +1,4 @@ -DefaultOtelServiceOptions | @shopify/cli-kit

      Interface DefaultOtelServiceOptions

      interface DefaultOtelServiceOptions {
          env?: string;
          meterProvider?: MeterProvider;
          metrics?: MetricsConfig;
          onRecord?: OnRecordCallback;
          otelEndpoint: string;
          prefixMetric?: boolean;
          serviceName: string;
          throttleLimit?: number;
          useXhr?: boolean;
      }

      Hierarchy (view full)

      Properties

      env? +DefaultOtelServiceOptions | @shopify/cli-kit

      Interface DefaultOtelServiceOptions

      interface DefaultOtelServiceOptions {
          env?: string;
          meterProvider?: MeterProvider;
          metrics?: MetricsConfig;
          onRecord?: OnRecordCallback;
          otelEndpoint: string;
          prefixMetric?: boolean;
          serviceName: string;
          throttleLimit?: number;
          useXhr?: boolean;
      }

      Hierarchy (view full)

      Properties

      env? meterProvider? metrics? onRecord? @@ -8,12 +8,12 @@ throttleLimit? useXhr?

      Properties

      Optional env

      env?: string

      What environment is being deployed (production, staging)

      -

      Optional meterProvider

      meterProvider?: MeterProvider

      Override the default meter provider.

      -

      Optional metrics

      metrics?: MetricsConfig

      Metrics to register on startup.

      -

      Optional onRecord

      onRecord?: OnRecordCallback

      Called when a metric is recorded. addOnRecord can also be used to add +

      Optional meterProvider

      meterProvider?: MeterProvider

      Override the default meter provider.

      +

      Optional metrics

      metrics?: MetricsConfig

      Metrics to register on startup.

      +

      Optional onRecord

      onRecord?: OnRecordCallback

      Called when a metric is recorded. addOnRecord can also be used to add listeners anytime.

      -

      otelEndpoint

      otelEndpoint: string

      Optional prefixMetric

      prefixMetric?: boolean

      If this is set to true then the service name is prefixed to every metric.

      -

      serviceName

      serviceName: string

      Service name is a unique name for an application/service.

      -

      Optional throttleLimit

      throttleLimit?: number

      How much the export should be throttled in milliseconds.

      -

      Optional useXhr

      useXhr?: boolean

      Determines whether to send metrics via XHR or beacon. Defaults to false.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      envmeterProvidermetricsonRecordotelEndpointprefixMetricserviceNamethrottleLimituseXhr
      \ No newline at end of file +

      otelEndpoint

      otelEndpoint: string

      Optional prefixMetric

      prefixMetric?: boolean

      If this is set to true then the service name is prefixed to every metric.

      +

      serviceName

      serviceName: string

      Service name is a unique name for an application/service.

      +

      Optional throttleLimit

      throttleLimit?: number

      How much the export should be throttled in milliseconds.

      +

      Optional useXhr

      useXhr?: boolean

      Determines whether to send metrics via XHR or beacon. Defaults to false.

      +

      Settings

      Member Visibility

      Theme

      On This Page

      envmeterProvidermetricsonRecordotelEndpointprefixMetricserviceNamethrottleLimituseXhr
      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_types.MetricsConfig.html b/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_types.MetricsConfig.html index faabc8eef6..160b9ce40e 100644 --- a/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_types.MetricsConfig.html +++ b/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_types.MetricsConfig.html @@ -1 +1 @@ -MetricsConfig | @shopify/cli-kit

      Interface MetricsConfig

      interface MetricsConfig {
          [key: string]: MetricDescriptor;
      }

      Indexable

      [key: string]: MetricDescriptor

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +MetricsConfig | @shopify/cli-kit

      Interface MetricsConfig

      interface MetricsConfig {
          [key: string]: MetricDescriptor;
      }

      Indexable

      [key: string]: MetricDescriptor

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_types.OtelService.html b/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_types.OtelService.html index f7df7009fd..914ccea3a9 100644 --- a/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_types.OtelService.html +++ b/docs/api/cli-kit/interfaces/node_vendor_otel_js_service_types.OtelService.html @@ -1,4 +1,4 @@ -OtelService | @shopify/cli-kit

      Interface OtelService

      interface OtelService {
          serviceName: string;
          addOnRecord(onRecord): (() => void);
          addView(viewOptions): void;
          getMeterProvider(): MeterProvider;
          record<TAttributes>(...args): void;
          register(metrics): void;
          registerMetric(metricName, options): void;
          removeOnRecord(onRecord): void;
          shutdown(): Promise<void>;
      }

      Implemented by

      Properties

      serviceName +OtelService | @shopify/cli-kit

      Interface OtelService

      interface OtelService {
          serviceName: string;
          addOnRecord(onRecord): (() => void);
          addView(viewOptions): void;
          getMeterProvider(): MeterProvider;
          record<TAttributes>(...args): void;
          register(metrics): void;
          registerMetric(metricName, options): void;
          removeOnRecord(onRecord): void;
          shutdown(): Promise<void>;
      }

      Implemented by

      Properties

      serviceName

      Methods

      addOnRecord addView getMeterProvider @@ -7,6 +7,6 @@ registerMetric removeOnRecord shutdown -

      Properties

      Readonly serviceName

      serviceName: string

      Methods

      addOnRecord

      • addOnRecord(onRecord): (() => void)

      • onRecord callback is called when a metric is recorded. +

      Properties

      Readonly serviceName

      serviceName: string

      Methods

      addOnRecord

      addView

      getMeterProvider

      record

      register

      registerMetric

      removeOnRecord

      shutdown

      Settings

      Member Visibility

      Theme

      On This Page

      serviceNameaddOnRecordaddViewgetMeterProviderrecordregisterregisterMetricremoveOnRecordshutdown
      \ No newline at end of file +

      Parameters

      Returns (() => void)

      addView

      getMeterProvider

      record

      register

      registerMetric

      removeOnRecord

      shutdown

      Settings

      Member Visibility

      Theme

      On This Page

      serviceNameaddOnRecordaddViewgetMeterProviderrecordregisterregisterMetricremoveOnRecordshutdown
      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/common_array.html b/docs/api/cli-kit/modules/common_array.html index aa9061ebe4..4f190b4577 100644 --- a/docs/api/cli-kit/modules/common_array.html +++ b/docs/api/cli-kit/modules/common_array.html @@ -1,4 +1,4 @@ -common/array | @shopify/cli-kit

      Module common/array

      Index

      Functions

      difference +common/array | @shopify/cli-kit

      Module common/array

      Index

      Functions

      difference getArrayContainsDuplicates getArrayRejectingUndefined takeRandomFromArray diff --git a/docs/api/cli-kit/modules/common_collection.html b/docs/api/cli-kit/modules/common_collection.html index dca304ba1a..a0f4b9d88a 100644 --- a/docs/api/cli-kit/modules/common_collection.html +++ b/docs/api/cli-kit/modules/common_collection.html @@ -1,3 +1,3 @@ -common/collection | @shopify/cli-kit

      Module common/collection

      Index

      Functions

      groupBy +common/collection | @shopify/cli-kit

      Module common/collection

      Index

      Functions

      groupBy partition

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/common_function.html b/docs/api/cli-kit/modules/common_function.html index 8ca9c388b1..4e18bd50c1 100644 --- a/docs/api/cli-kit/modules/common_function.html +++ b/docs/api/cli-kit/modules/common_function.html @@ -1,3 +1,3 @@ -common/function | @shopify/cli-kit

      Module common/function

      Index

      Functions

      debounce +common/function | @shopify/cli-kit

      Module common/function

      Index

      Functions

      debounce memoize

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/common_lang.html b/docs/api/cli-kit/modules/common_lang.html index b48ebe69f0..d0ea7e0ff3 100644 --- a/docs/api/cli-kit/modules/common_lang.html +++ b/docs/api/cli-kit/modules/common_lang.html @@ -1,2 +1,2 @@ -common/lang | @shopify/cli-kit

      Module common/lang

      Index

      Functions

      isEqual +common/lang | @shopify/cli-kit

      Module common/lang

      Index

      Functions

      isEqual

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/common_object.html b/docs/api/cli-kit/modules/common_object.html index c2837aa0fd..910f5bf938 100644 --- a/docs/api/cli-kit/modules/common_object.html +++ b/docs/api/cli-kit/modules/common_object.html @@ -1,4 +1,4 @@ -common/object | @shopify/cli-kit

      Module common/object

      Index

      Functions

      compact +common/object | @shopify/cli-kit

      Module common/object

      Index

      Functions

      compact deepCompare deepDifference deepMergeObjects diff --git a/docs/api/cli-kit/modules/common_retry.html b/docs/api/cli-kit/modules/common_retry.html index e082ab6208..676567c687 100644 --- a/docs/api/cli-kit/modules/common_retry.html +++ b/docs/api/cli-kit/modules/common_retry.html @@ -1,2 +1,2 @@ -common/retry | @shopify/cli-kit

      Module common/retry

      Index

      Functions

      performActionWithRetryAfterRecovery +common/retry | @shopify/cli-kit

      Module common/retry

      Index

      Functions

      performActionWithRetryAfterRecovery

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/common_string.html b/docs/api/cli-kit/modules/common_string.html index 078aed40a5..1c3d350c64 100644 --- a/docs/api/cli-kit/modules/common_string.html +++ b/docs/api/cli-kit/modules/common_string.html @@ -1,4 +1,4 @@ -common/string | @shopify/cli-kit

      Module common/string

      Index

      Type Aliases

      RandomNameFamily +common/string | @shopify/cli-kit

      Module common/string

      Index

      Type Aliases

      RandomNameFamily

      Functions

      camelize capitalize constantize diff --git a/docs/api/cli-kit/modules/common_ts_deep_required.html b/docs/api/cli-kit/modules/common_ts_deep_required.html index cce61cf537..463a353ccb 100644 --- a/docs/api/cli-kit/modules/common_ts_deep_required.html +++ b/docs/api/cli-kit/modules/common_ts_deep_required.html @@ -1,2 +1,2 @@ -common/ts/deep-required | @shopify/cli-kit

      Module common/ts/deep-required

      Index

      Type Aliases

      DeepRequired +common/ts/deep-required | @shopify/cli-kit

      Module common/ts/deep-required

      Index

      Type Aliases

      DeepRequired

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/common_ts_json_narrowing.html b/docs/api/cli-kit/modules/common_ts_json_narrowing.html index bc6c082c3b..d7c01e8186 100644 --- a/docs/api/cli-kit/modules/common_ts_json_narrowing.html +++ b/docs/api/cli-kit/modules/common_ts_json_narrowing.html @@ -1,2 +1,2 @@ -common/ts/json-narrowing | @shopify/cli-kit

      Module common/ts/json-narrowing

      Index

      Functions

      assertStringMap +common/ts/json-narrowing | @shopify/cli-kit

      Module common/ts/json-narrowing

      Index

      Functions

      assertStringMap

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/common_ts_pick_by_prefix.html b/docs/api/cli-kit/modules/common_ts_pick_by_prefix.html index f7ba36190a..853a0d1e8c 100644 --- a/docs/api/cli-kit/modules/common_ts_pick_by_prefix.html +++ b/docs/api/cli-kit/modules/common_ts_pick_by_prefix.html @@ -1,2 +1,2 @@ -common/ts/pick-by-prefix | @shopify/cli-kit

      Module common/ts/pick-by-prefix

      Index

      Type Aliases

      PickByPrefix +common/ts/pick-by-prefix | @shopify/cli-kit

      Module common/ts/pick-by-prefix

      Index

      Type Aliases

      PickByPrefix

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/common_url.html b/docs/api/cli-kit/modules/common_url.html index 2e2f160e5b..083a4f2ae7 100644 --- a/docs/api/cli-kit/modules/common_url.html +++ b/docs/api/cli-kit/modules/common_url.html @@ -1,2 +1,2 @@ -common/url | @shopify/cli-kit

      Module common/url

      Index

      Functions

      isValidURL +common/url | @shopify/cli-kit

      Module common/url

      Index

      Functions

      isValidURL

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/common_version.html b/docs/api/cli-kit/modules/common_version.html index add5433ec8..0f1b5d6c60 100644 --- a/docs/api/cli-kit/modules/common_version.html +++ b/docs/api/cli-kit/modules/common_version.html @@ -1,2 +1,2 @@ -common/version | @shopify/cli-kit

      Module common/version

      Index

      Variables

      CLI_KIT_VERSION +common/version | @shopify/cli-kit

      Module common/version

      Index

      Variables

      CLI_KIT_VERSION

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_abort.html b/docs/api/cli-kit/modules/node_abort.html index 10557e1151..3d63b7ac24 100644 --- a/docs/api/cli-kit/modules/node_abort.html +++ b/docs/api/cli-kit/modules/node_abort.html @@ -1,3 +1,3 @@ -node/abort | @shopify/cli-kit

      Module node/abort

      Index

      Classes

      AbortController +node/abort | @shopify/cli-kit

      Module node/abort

      Index

      Classes

      AbortController AbortSignal

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_analytics.html b/docs/api/cli-kit/modules/node_analytics.html index 2177866c32..b44e1a54d1 100644 --- a/docs/api/cli-kit/modules/node_analytics.html +++ b/docs/api/cli-kit/modules/node_analytics.html @@ -1,3 +1,3 @@ -node/analytics | @shopify/cli-kit

      Module node/analytics

      Index

      Type Aliases

      CommandExitMode +node/analytics | @shopify/cli-kit

      Module node/analytics

      Index

      Type Aliases

      CommandExitMode

      Functions

      reportAnalyticsEvent

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_api_admin.html b/docs/api/cli-kit/modules/node_api_admin.html index dd4b2963d5..6e5874e803 100644 --- a/docs/api/cli-kit/modules/node_api_admin.html +++ b/docs/api/cli-kit/modules/node_api_admin.html @@ -1,4 +1,4 @@ -node/api/admin | @shopify/cli-kit

      Module node/api/admin

      Index

      Interfaces

      RestResponse +node/api/admin | @shopify/cli-kit

      Module node/api/admin

      Index

      Interfaces

      RestResponse

      Functions

      adminRequest adminUrl restRequest diff --git a/docs/api/cli-kit/modules/node_api_app_dev.html b/docs/api/cli-kit/modules/node_api_app_dev.html index 6fc1e0283e..aaf8c3d038 100644 --- a/docs/api/cli-kit/modules/node_api_app_dev.html +++ b/docs/api/cli-kit/modules/node_api_app_dev.html @@ -1,2 +1,2 @@ -node/api/app-dev | @shopify/cli-kit

      Module node/api/app-dev

      Index

      Functions

      appDevRequest +node/api/app-dev | @shopify/cli-kit

      Module node/api/app-dev

      Index

      Functions

      appDevRequest

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_api_app_management.html b/docs/api/cli-kit/modules/node_api_app_management.html index f87d4c08e7..ee1dcbe18d 100644 --- a/docs/api/cli-kit/modules/node_api_app_management.html +++ b/docs/api/cli-kit/modules/node_api_app_management.html @@ -1,3 +1,3 @@ -node/api/app-management | @shopify/cli-kit

      Module node/api/app-management

      Index

      Functions

      appManagementRequest +node/api/app-management | @shopify/cli-kit

      Module node/api/app-management

      Index

      Functions

      appManagementRequest handleDeprecations

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_api_business_platform.html b/docs/api/cli-kit/modules/node_api_business_platform.html index 1b22903ac3..ad6d78ec31 100644 --- a/docs/api/cli-kit/modules/node_api_business_platform.html +++ b/docs/api/cli-kit/modules/node_api_business_platform.html @@ -1,4 +1,4 @@ -node/api/business-platform | @shopify/cli-kit

      Module node/api/business-platform

      Index

      Functions

      businessPlatformOrganizationsRequest +node/api/business-platform | @shopify/cli-kit

      Module node/api/business-platform

      Index

      Functions

      businessPlatformOrganizationsRequest businessPlatformOrganizationsRequestDoc businessPlatformRequest businessPlatformRequestDoc diff --git a/docs/api/cli-kit/modules/node_api_graphql.html b/docs/api/cli-kit/modules/node_api_graphql.html index 2f3a091e9e..c78dee901a 100644 --- a/docs/api/cli-kit/modules/node_api_graphql.html +++ b/docs/api/cli-kit/modules/node_api_graphql.html @@ -1,4 +1,4 @@ -node/api/graphql | @shopify/cli-kit

      Module node/api/graphql

      Index

      Interfaces

      GraphQLResponseOptions +node/api/graphql | @shopify/cli-kit

      Module node/api/graphql

      Index

      Interfaces

      GraphQLResponseOptions GraphQLVariables

      Type Aliases

      Exact GraphQLRequestDocOptions diff --git a/docs/api/cli-kit/modules/node_api_http.html b/docs/api/cli-kit/modules/node_api_http.html index f214115fd0..7efa4cf448 100644 --- a/docs/api/cli-kit/modules/node_api_http.html +++ b/docs/api/cli-kit/modules/node_api_http.html @@ -1 +1 @@ -node/api/http | @shopify/cli-kit

      Module node/api/http

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +node/api/http | @shopify/cli-kit

      Module node/api/http

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_api_partners.html b/docs/api/cli-kit/modules/node_api_partners.html index ecc4cc3bf0..cc9b174198 100644 --- a/docs/api/cli-kit/modules/node_api_partners.html +++ b/docs/api/cli-kit/modules/node_api_partners.html @@ -1,4 +1,4 @@ -node/api/partners | @shopify/cli-kit

      Module node/api/partners

      Index

      Functions

      handleDeprecations +node/api/partners | @shopify/cli-kit

      Module node/api/partners

      Index

      Functions

      handleDeprecations partnersRequest partnersRequestDoc

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_api_rest_api_throttler.html b/docs/api/cli-kit/modules/node_api_rest_api_throttler.html index 8c438dac42..fe3378387d 100644 --- a/docs/api/cli-kit/modules/node_api_rest_api_throttler.html +++ b/docs/api/cli-kit/modules/node_api_rest_api_throttler.html @@ -1,4 +1,4 @@ -node/api/rest-api-throttler | @shopify/cli-kit

      Module node/api/rest-api-throttler

      Index

      Functions

      delayAwareRetry +node/api/rest-api-throttler | @shopify/cli-kit

      Module node/api/rest-api-throttler

      Index

      Functions

      delayAwareRetry throttle updateApiCallLimitFromResponse

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_archiver.html b/docs/api/cli-kit/modules/node_archiver.html index da7119d99a..fcf49112d9 100644 --- a/docs/api/cli-kit/modules/node_archiver.html +++ b/docs/api/cli-kit/modules/node_archiver.html @@ -1,2 +1,2 @@ -node/archiver | @shopify/cli-kit

      Module node/archiver

      Index

      Functions

      zip +node/archiver | @shopify/cli-kit

      Module node/archiver

      Index

      Functions

      zip

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_base_command.html b/docs/api/cli-kit/modules/node_base_command.html index 40f348fdf4..97df286aad 100644 --- a/docs/api/cli-kit/modules/node_base_command.html +++ b/docs/api/cli-kit/modules/node_base_command.html @@ -1,3 +1,3 @@ -node/base-command | @shopify/cli-kit

      Module node/base-command

      Index

      Classes

      default +node/base-command | @shopify/cli-kit

      Module node/base-command

      Index

      Classes

      default

      Functions

      addFromParsedFlags

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_cli.html b/docs/api/cli-kit/modules/node_cli.html index f618b3df9f..78deb515f9 100644 --- a/docs/api/cli-kit/modules/node_cli.html +++ b/docs/api/cli-kit/modules/node_cli.html @@ -1,4 +1,4 @@ -node/cli | @shopify/cli-kit

      Module node/cli

      Index

      Variables

      globalFlags +node/cli | @shopify/cli-kit

      Module node/cli

      Index

      Variables

      globalFlags

      Functions

      localCliPackage runCLI runCreateCLI diff --git a/docs/api/cli-kit/modules/node_colors.html b/docs/api/cli-kit/modules/node_colors.html index 3d236c27bf..4099f28c3e 100644 --- a/docs/api/cli-kit/modules/node_colors.html +++ b/docs/api/cli-kit/modules/node_colors.html @@ -1 +1 @@ -node/colors | @shopify/cli-kit

      Module node/colors

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +node/colors | @shopify/cli-kit

      Module node/colors

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_context_fqdn.html b/docs/api/cli-kit/modules/node_context_fqdn.html index 5a126162c7..079c2a6886 100644 --- a/docs/api/cli-kit/modules/node_context_fqdn.html +++ b/docs/api/cli-kit/modules/node_context_fqdn.html @@ -1,4 +1,4 @@ -node/context/fqdn | @shopify/cli-kit

      Module node/context/fqdn

      Index

      Variables

      CouldntObtainIdentitySpinFQDNError +node/context/fqdn | @shopify/cli-kit

      Module node/context/fqdn

      Index

      Variables

      CouldntObtainIdentitySpinFQDNError CouldntObtainPartnersSpinFQDNError CouldntObtainShopifySpinFQDNError NotProvidedStoreFQDNError diff --git a/docs/api/cli-kit/modules/node_context_local.html b/docs/api/cli-kit/modules/node_context_local.html index 835ea51692..bb578c3209 100644 --- a/docs/api/cli-kit/modules/node_context_local.html +++ b/docs/api/cli-kit/modules/node_context_local.html @@ -1,4 +1,4 @@ -node/context/local | @shopify/cli-kit

      Module node/context/local

      Index

      Type Aliases

      CIMetadata +node/context/local | @shopify/cli-kit

      Module node/context/local

      Index

      Type Aliases

      CIMetadata

      Functions

      alwaysLogAnalytics alwaysLogMetrics analyticsDisabled diff --git a/docs/api/cli-kit/modules/node_context_spin.html b/docs/api/cli-kit/modules/node_context_spin.html index 23c16eeb36..ca8a64ae8f 100644 --- a/docs/api/cli-kit/modules/node_context_spin.html +++ b/docs/api/cli-kit/modules/node_context_spin.html @@ -1,4 +1,4 @@ -node/context/spin | @shopify/cli-kit

      Module node/context/spin

      Index

      Variables

      spinVariables +node/context/spin | @shopify/cli-kit

      Module node/context/spin

      Index

      Variables

      spinVariables

      Functions

      appHost appPort fetchSpinPort diff --git a/docs/api/cli-kit/modules/node_context_utilities.html b/docs/api/cli-kit/modules/node_context_utilities.html index 6087791231..f526919f3d 100644 --- a/docs/api/cli-kit/modules/node_context_utilities.html +++ b/docs/api/cli-kit/modules/node_context_utilities.html @@ -1,2 +1,2 @@ -node/context/utilities | @shopify/cli-kit

      Module node/context/utilities

      Index

      Functions

      isTruthy +node/context/utilities | @shopify/cli-kit

      Module node/context/utilities

      Index

      Functions

      isTruthy

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_crypto.html b/docs/api/cli-kit/modules/node_crypto.html index 21cd5d29a9..491f780edd 100644 --- a/docs/api/cli-kit/modules/node_crypto.html +++ b/docs/api/cli-kit/modules/node_crypto.html @@ -1,4 +1,4 @@ -node/crypto | @shopify/cli-kit

      Module node/crypto

      Index

      Functions

      base64URLEncode +node/crypto | @shopify/cli-kit

      Module node/crypto

      Index

      Functions

      base64URLEncode fileHash hashString nonRandomUUID diff --git a/docs/api/cli-kit/modules/node_custom_oclif_loader.html b/docs/api/cli-kit/modules/node_custom_oclif_loader.html index 7f84c2af2b..1af6c71cc3 100644 --- a/docs/api/cli-kit/modules/node_custom_oclif_loader.html +++ b/docs/api/cli-kit/modules/node_custom_oclif_loader.html @@ -1,2 +1,2 @@ -node/custom-oclif-loader | @shopify/cli-kit

      Module node/custom-oclif-loader

      Index

      Classes

      ShopifyConfig +node/custom-oclif-loader | @shopify/cli-kit

      Module node/custom-oclif-loader

      Index

      Classes

      ShopifyConfig

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_dot_env.html b/docs/api/cli-kit/modules/node_dot_env.html index 67da15ed75..e012891052 100644 --- a/docs/api/cli-kit/modules/node_dot_env.html +++ b/docs/api/cli-kit/modules/node_dot_env.html @@ -1,4 +1,4 @@ -node/dot-env | @shopify/cli-kit

      Module node/dot-env

      Index

      Interfaces

      DotEnvFile +node/dot-env | @shopify/cli-kit

      Module node/dot-env

      Index

      Interfaces

      DotEnvFile

      Functions

      createDotEnvFileLine patchEnvFile readAndParseDotEnv diff --git a/docs/api/cli-kit/modules/node_environment.html b/docs/api/cli-kit/modules/node_environment.html index b9b0220c71..7ba0457288 100644 --- a/docs/api/cli-kit/modules/node_environment.html +++ b/docs/api/cli-kit/modules/node_environment.html @@ -1,4 +1,4 @@ -node/environment | @shopify/cli-kit

      Module node/environment

      Index

      Functions

      getBackendPort +node/environment | @shopify/cli-kit

      Module node/environment

      Index

      Functions

      getBackendPort getEnvironmentVariables getIdentityTokenInformation getOrganization diff --git a/docs/api/cli-kit/modules/node_environments.html b/docs/api/cli-kit/modules/node_environments.html index 7357ad6e7a..4c30cfc069 100644 --- a/docs/api/cli-kit/modules/node_environments.html +++ b/docs/api/cli-kit/modules/node_environments.html @@ -1,3 +1,3 @@ -node/environments | @shopify/cli-kit

      Module node/environments

      Index

      Interfaces

      Environments +node/environments | @shopify/cli-kit

      Module node/environments

      Index

      Interfaces

      Environments

      Functions

      loadEnvironment

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_error.html b/docs/api/cli-kit/modules/node_error.html index af32e0e1c9..3ab9daf9d2 100644 --- a/docs/api/cli-kit/modules/node_error.html +++ b/docs/api/cli-kit/modules/node_error.html @@ -1,4 +1,4 @@ -node/error | @shopify/cli-kit

      Module node/error

      Index

      Enumerations

      FatalErrorType +node/error | @shopify/cli-kit

      Module node/error

      Index

      Enumerations

      FatalErrorType

      Classes

      AbortError AbortSilentError BugError diff --git a/docs/api/cli-kit/modules/node_error_handler.html b/docs/api/cli-kit/modules/node_error_handler.html index df7a862c51..f5e3b84229 100644 --- a/docs/api/cli-kit/modules/node_error_handler.html +++ b/docs/api/cli-kit/modules/node_error_handler.html @@ -1,4 +1,4 @@ -node/error-handler | @shopify/cli-kit

      Module node/error-handler

      Index

      Functions

      addBugsnagMetadata +node/error-handler | @shopify/cli-kit

      Module node/error-handler

      Index

      Functions

      addBugsnagMetadata cleanStackFrameFilePath errorHandler registerCleanBugsnagErrorsFromWithinPlugins diff --git a/docs/api/cli-kit/modules/node_figures.html b/docs/api/cli-kit/modules/node_figures.html index c11f531d35..6abe89d893 100644 --- a/docs/api/cli-kit/modules/node_figures.html +++ b/docs/api/cli-kit/modules/node_figures.html @@ -1 +1 @@ -node/figures | @shopify/cli-kit

      Module node/figures

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +node/figures | @shopify/cli-kit

      Module node/figures

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_framework.html b/docs/api/cli-kit/modules/node_framework.html index a82f03bc27..9b7e0bf8e9 100644 --- a/docs/api/cli-kit/modules/node_framework.html +++ b/docs/api/cli-kit/modules/node_framework.html @@ -1,2 +1,2 @@ -node/framework | @shopify/cli-kit

      Module node/framework

      Index

      Functions

      resolveFramework +node/framework | @shopify/cli-kit

      Module node/framework

      Index

      Functions

      resolveFramework

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_fs.html b/docs/api/cli-kit/modules/node_fs.html index c21357f386..816ff732b7 100644 --- a/docs/api/cli-kit/modules/node_fs.html +++ b/docs/api/cli-kit/modules/node_fs.html @@ -1,4 +1,4 @@ -node/fs | @shopify/cli-kit

      Module node/fs

      Index

      Interfaces

      MatchGlobOptions +node/fs | @shopify/cli-kit

      Module node/fs

      Index

      Interfaces

      MatchGlobOptions WriteOptions

      Type Aliases

      ReadOptions

      Functions

      appendFile diff --git a/docs/api/cli-kit/modules/node_git.html b/docs/api/cli-kit/modules/node_git.html index cab447d3bd..5ca7d53d27 100644 --- a/docs/api/cli-kit/modules/node_git.html +++ b/docs/api/cli-kit/modules/node_git.html @@ -1,4 +1,4 @@ -node/git | @shopify/cli-kit

      Module node/git

      Index

      Classes

      GitDirectoryNotCleanError +node/git | @shopify/cli-kit

      Module node/git

      Index

      Classes

      GitDirectoryNotCleanError OutsideGitDirectoryError

      Interfaces

      CreateGitCommitOptions GitCloneOptions diff --git a/docs/api/cli-kit/modules/node_github.html b/docs/api/cli-kit/modules/node_github.html index 51cf82ccf6..ddd3f3aca3 100644 --- a/docs/api/cli-kit/modules/node_github.html +++ b/docs/api/cli-kit/modules/node_github.html @@ -1,4 +1,4 @@ -node/github | @shopify/cli-kit

      Module node/github

      Index

      Interfaces

      GithubRelease +node/github | @shopify/cli-kit

      Module node/github

      Index

      Interfaces

      GithubRelease GithubRepositoryReference

      Functions

      getLatestGitHubRelease parseGitHubRepositoryReference diff --git a/docs/api/cli-kit/modules/node_hooks_deprecations.html b/docs/api/cli-kit/modules/node_hooks_deprecations.html index 491552b8b4..b7077526a2 100644 --- a/docs/api/cli-kit/modules/node_hooks_deprecations.html +++ b/docs/api/cli-kit/modules/node_hooks_deprecations.html @@ -1,2 +1,2 @@ -node/hooks/deprecations | @shopify/cli-kit

      Module node/hooks/deprecations

      Index

      Functions

      postrun +node/hooks/deprecations | @shopify/cli-kit

      Module node/hooks/deprecations

      Index

      Functions

      postrun

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_hooks_postrun.html b/docs/api/cli-kit/modules/node_hooks_postrun.html index aa1734137c..c8d7366ce3 100644 --- a/docs/api/cli-kit/modules/node_hooks_postrun.html +++ b/docs/api/cli-kit/modules/node_hooks_postrun.html @@ -1,2 +1,2 @@ -node/hooks/postrun | @shopify/cli-kit

      Module node/hooks/postrun

      Index

      Functions

      hook +node/hooks/postrun | @shopify/cli-kit

      Module node/hooks/postrun

      Index

      Functions

      hook

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_hooks_prerun.html b/docs/api/cli-kit/modules/node_hooks_prerun.html index b06adbf9f9..ff40ecb0fb 100644 --- a/docs/api/cli-kit/modules/node_hooks_prerun.html +++ b/docs/api/cli-kit/modules/node_hooks_prerun.html @@ -1,4 +1,4 @@ -node/hooks/prerun | @shopify/cli-kit

      Module node/hooks/prerun

      Index

      Interfaces

      CommandContent +node/hooks/prerun | @shopify/cli-kit

      Module node/hooks/prerun

      Index

      Interfaces

      CommandContent

      Functions

      hook parseCommandContent warnOnAvailableUpgrade diff --git a/docs/api/cli-kit/modules/node_hrtime.html b/docs/api/cli-kit/modules/node_hrtime.html index 3e7b95868c..b246698531 100644 --- a/docs/api/cli-kit/modules/node_hrtime.html +++ b/docs/api/cli-kit/modules/node_hrtime.html @@ -1,4 +1,4 @@ -node/hrtime | @shopify/cli-kit

      Module node/hrtime

      Index

      Type Aliases

      StartTime +node/hrtime | @shopify/cli-kit

      Module node/hrtime

      Index

      Type Aliases

      StartTime

      Functions

      endHRTimeInMs startHRTime

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_http.html b/docs/api/cli-kit/modules/node_http.html index ac698d8f4f..df07eac8e4 100644 --- a/docs/api/cli-kit/modules/node_http.html +++ b/docs/api/cli-kit/modules/node_http.html @@ -1,4 +1,4 @@ -node/http | @shopify/cli-kit

      Module node/http

      Index

      Functions

      downloadFile +node/http | @shopify/cli-kit

      Module node/http

      Index

      Functions

      downloadFile fetch formData shopifyFetch diff --git a/docs/api/cli-kit/modules/node_ink.html b/docs/api/cli-kit/modules/node_ink.html index 4916b37ccc..e68d49f7a2 100644 --- a/docs/api/cli-kit/modules/node_ink.html +++ b/docs/api/cli-kit/modules/node_ink.html @@ -1 +1 @@ -node/ink | @shopify/cli-kit

      Module node/ink

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +node/ink | @shopify/cli-kit

      Module node/ink

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_is_global.html b/docs/api/cli-kit/modules/node_is_global.html index c03820a602..24f0043ae1 100644 --- a/docs/api/cli-kit/modules/node_is_global.html +++ b/docs/api/cli-kit/modules/node_is_global.html @@ -1,4 +1,4 @@ -node/is-global | @shopify/cli-kit

      Module node/is-global

      Index

      Interfaces

      InstallGlobalCLIPromptResult +node/is-global | @shopify/cli-kit

      Module node/is-global

      Index

      Interfaces

      InstallGlobalCLIPromptResult

      Functions

      currentProcessIsGlobal inferPackageManagerForGlobalCLI installGlobalCLIPrompt diff --git a/docs/api/cli-kit/modules/node_json_schema.html b/docs/api/cli-kit/modules/node_json_schema.html index 35ac3c0833..fbc4737c18 100644 --- a/docs/api/cli-kit/modules/node_json_schema.html +++ b/docs/api/cli-kit/modules/node_json_schema.html @@ -1,3 +1,3 @@ -node/json-schema | @shopify/cli-kit

      Module node/json-schema

      Index

      Functions

      jsonSchemaValidate +node/json-schema | @shopify/cli-kit

      Module node/json-schema

      Index

      Functions

      jsonSchemaValidate normaliseJsonSchema

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_liquid.html b/docs/api/cli-kit/modules/node_liquid.html index dbe7186078..156ec10ead 100644 --- a/docs/api/cli-kit/modules/node_liquid.html +++ b/docs/api/cli-kit/modules/node_liquid.html @@ -1,3 +1,3 @@ -node/liquid | @shopify/cli-kit

      Module node/liquid

      Index

      Functions

      recursiveLiquidTemplateCopy +node/liquid | @shopify/cli-kit

      Module node/liquid

      Index

      Functions

      recursiveLiquidTemplateCopy renderLiquidTemplate

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_local_storage.html b/docs/api/cli-kit/modules/node_local_storage.html index a0c74aadba..49f859a7a8 100644 --- a/docs/api/cli-kit/modules/node_local_storage.html +++ b/docs/api/cli-kit/modules/node_local_storage.html @@ -1,2 +1,2 @@ -node/local-storage | @shopify/cli-kit

      Module node/local-storage

      Index

      Classes

      LocalStorage +node/local-storage | @shopify/cli-kit

      Module node/local-storage

      Index

      Classes

      LocalStorage

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_logs.html b/docs/api/cli-kit/modules/node_logs.html index ef9e7181a5..7b06131cfc 100644 --- a/docs/api/cli-kit/modules/node_logs.html +++ b/docs/api/cli-kit/modules/node_logs.html @@ -1,4 +1,4 @@ -node/logs | @shopify/cli-kit

      Module node/logs

      Index

      Functions

      createLogsDir +node/logs | @shopify/cli-kit

      Module node/logs

      Index

      Functions

      createLogsDir getLogsDir writeLog

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_metadata.html b/docs/api/cli-kit/modules/node_metadata.html index b777c462fc..8d72b5015f 100644 --- a/docs/api/cli-kit/modules/node_metadata.html +++ b/docs/api/cli-kit/modules/node_metadata.html @@ -1,4 +1,4 @@ -node/metadata | @shopify/cli-kit

      Module node/metadata

      Index

      Interfaces

      RuntimeMetadataManager +node/metadata | @shopify/cli-kit

      Module node/metadata

      Index

      Interfaces

      RuntimeMetadataManager

      Type Aliases

      Public PublicSchema Sensitive diff --git a/docs/api/cli-kit/modules/node_mimes.html b/docs/api/cli-kit/modules/node_mimes.html index 016b1d22db..05f2dc38ff 100644 --- a/docs/api/cli-kit/modules/node_mimes.html +++ b/docs/api/cli-kit/modules/node_mimes.html @@ -1,3 +1,3 @@ -node/mimes | @shopify/cli-kit

      Module node/mimes

      Index

      Functions

      lookupMimeType +node/mimes | @shopify/cli-kit

      Module node/mimes

      Index

      Functions

      lookupMimeType setMimeTypes

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_monorail.html b/docs/api/cli-kit/modules/node_monorail.html index 55ae03b1f8..becc443608 100644 --- a/docs/api/cli-kit/modules/node_monorail.html +++ b/docs/api/cli-kit/modules/node_monorail.html @@ -1,4 +1,4 @@ -node/monorail | @shopify/cli-kit

      Module node/monorail

      References

      DeepRequired +node/monorail | @shopify/cli-kit

      Module node/monorail

      References

      DeepRequired

      Interfaces

      Schemas

      Type Aliases

      MonorailEventPublic MonorailEventSensitive diff --git a/docs/api/cli-kit/modules/node_node_package_manager.html b/docs/api/cli-kit/modules/node_node_package_manager.html index 9cb8f5e5af..fe32554e45 100644 --- a/docs/api/cli-kit/modules/node_node_package_manager.html +++ b/docs/api/cli-kit/modules/node_node_package_manager.html @@ -1,4 +1,4 @@ -node/node-package-manager | @shopify/cli-kit

      Module node/node-package-manager

      Index

      Classes

      FindUpAndReadPackageJsonNotFoundError +node/node-package-manager | @shopify/cli-kit

      Module node/node-package-manager

      Index

      Classes

      FindUpAndReadPackageJsonNotFoundError PackageJsonNotFoundError UnknownPackageManagerError

      Interfaces

      DependencyVersion diff --git a/docs/api/cli-kit/modules/node_os.html b/docs/api/cli-kit/modules/node_os.html index 5ff0dfe463..5ebb083230 100644 --- a/docs/api/cli-kit/modules/node_os.html +++ b/docs/api/cli-kit/modules/node_os.html @@ -1,3 +1,3 @@ -node/os | @shopify/cli-kit

      Module node/os

      Index

      Functions

      platformAndArch +node/os | @shopify/cli-kit

      Module node/os

      Index

      Functions

      platformAndArch username

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_output.html b/docs/api/cli-kit/modules/node_output.html index e6fcd46b13..45adeb4be8 100644 --- a/docs/api/cli-kit/modules/node_output.html +++ b/docs/api/cli-kit/modules/node_output.html @@ -1,4 +1,4 @@ -node/output | @shopify/cli-kit

      Module node/output

      Index

      Classes

      TokenizedString +node/output | @shopify/cli-kit

      Module node/output

      Index

      Classes

      TokenizedString

      Interfaces

      OutputProcess

      Type Aliases

      LogLevel Logger diff --git a/docs/api/cli-kit/modules/node_path.html b/docs/api/cli-kit/modules/node_path.html index 1f626f1720..320418c6b3 100644 --- a/docs/api/cli-kit/modules/node_path.html +++ b/docs/api/cli-kit/modules/node_path.html @@ -1,4 +1,4 @@ -node/path | @shopify/cli-kit

      Module node/path

      Index

      Functions

      basename +node/path | @shopify/cli-kit

      Module node/path

      Index

      Functions

      basename cwd dirname extname diff --git a/docs/api/cli-kit/modules/node_plugins.html b/docs/api/cli-kit/modules/node_plugins.html index 57f75c7952..2b7293e2e9 100644 --- a/docs/api/cli-kit/modules/node_plugins.html +++ b/docs/api/cli-kit/modules/node_plugins.html @@ -1,4 +1,4 @@ -node/plugins | @shopify/cli-kit

      Module node/plugins

      Index

      Interfaces

      HookReturnsPerPlugin +node/plugins | @shopify/cli-kit

      Module node/plugins

      Index

      Interfaces

      HookReturnsPerPlugin TunnelPluginError

      Type Aliases

      FanoutHookFunction PluginReturnsForHook diff --git a/docs/api/cli-kit/modules/node_plugins_tunnel.html b/docs/api/cli-kit/modules/node_plugins_tunnel.html index 687f03e46a..88a4eedbcb 100644 --- a/docs/api/cli-kit/modules/node_plugins_tunnel.html +++ b/docs/api/cli-kit/modules/node_plugins_tunnel.html @@ -1,4 +1,4 @@ -node/plugins/tunnel | @shopify/cli-kit

      Module node/plugins/tunnel

      Index

      Classes

      TunnelError +node/plugins/tunnel | @shopify/cli-kit

      Module node/plugins/tunnel

      Index

      Classes

      TunnelError

      Interfaces

      HookReturnPerTunnelPlugin TunnelClient

      Type Aliases

      TunnelErrorType diff --git a/docs/api/cli-kit/modules/node_promises.html b/docs/api/cli-kit/modules/node_promises.html index e34d9f6868..83d8678599 100644 --- a/docs/api/cli-kit/modules/node_promises.html +++ b/docs/api/cli-kit/modules/node_promises.html @@ -1,2 +1,2 @@ -node/promises | @shopify/cli-kit

      Module node/promises

      Index

      Functions

      flushPromises +node/promises | @shopify/cli-kit

      Module node/promises

      Index

      Functions

      flushPromises

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_result.html b/docs/api/cli-kit/modules/node_result.html index ce9927fffe..ac83a892c8 100644 --- a/docs/api/cli-kit/modules/node_result.html +++ b/docs/api/cli-kit/modules/node_result.html @@ -1,4 +1,4 @@ -node/result | @shopify/cli-kit

      Module node/result

      Index

      Classes

      Err +node/result | @shopify/cli-kit

      Module node/result

      Index

      Classes

      Err Ok

      Type Aliases

      Result

      Functions

      err diff --git a/docs/api/cli-kit/modules/node_ruby.html b/docs/api/cli-kit/modules/node_ruby.html index 45f5132edf..aef345e67d 100644 --- a/docs/api/cli-kit/modules/node_ruby.html +++ b/docs/api/cli-kit/modules/node_ruby.html @@ -1,4 +1,4 @@ -node/ruby | @shopify/cli-kit

      Module node/ruby

      Index

      Variables

      MinWdmWindowsVersion +node/ruby | @shopify/cli-kit

      Module node/ruby

      Index

      Variables

      MinWdmWindowsVersion RubyCLIVersion

      Functions

      bundleUserHome execCLI2 diff --git a/docs/api/cli-kit/modules/node_schema.html b/docs/api/cli-kit/modules/node_schema.html index f8e0bb74d0..38459683e9 100644 --- a/docs/api/cli-kit/modules/node_schema.html +++ b/docs/api/cli-kit/modules/node_schema.html @@ -1,4 +1,4 @@ -node/schema | @shopify/cli-kit

      Module node/schema

      Index

      Type Aliases

      ParseConfigurationResult +node/schema | @shopify/cli-kit

      Module node/schema

      Index

      Type Aliases

      ParseConfigurationResult ZodObjectOf

      Functions

      deepStrict errorsToString diff --git a/docs/api/cli-kit/modules/node_session.html b/docs/api/cli-kit/modules/node_session.html index 641ee2979f..a90f0c270e 100644 --- a/docs/api/cli-kit/modules/node_session.html +++ b/docs/api/cli-kit/modules/node_session.html @@ -1,4 +1,4 @@ -node/session | @shopify/cli-kit

      Module node/session

      Index

      Interfaces

      AdminSession +node/session | @shopify/cli-kit

      Module node/session

      Index

      Interfaces

      AdminSession

      Functions

      ensureAuthenticatedAdmin ensureAuthenticatedAppManagement ensureAuthenticatedBusinessPlatform diff --git a/docs/api/cli-kit/modules/node_system.html b/docs/api/cli-kit/modules/node_system.html index 30a5ed1681..96bb8984af 100644 --- a/docs/api/cli-kit/modules/node_system.html +++ b/docs/api/cli-kit/modules/node_system.html @@ -1,4 +1,4 @@ -node/system | @shopify/cli-kit

      Module node/system

      Index

      Interfaces

      ExecOptions +node/system | @shopify/cli-kit

      Module node/system

      Index

      Interfaces

      ExecOptions

      Functions

      captureOutput exec openURL diff --git a/docs/api/cli-kit/modules/node_tcp.html b/docs/api/cli-kit/modules/node_tcp.html index 7117312de0..9dcefe2f87 100644 --- a/docs/api/cli-kit/modules/node_tcp.html +++ b/docs/api/cli-kit/modules/node_tcp.html @@ -1,3 +1,3 @@ -node/tcp | @shopify/cli-kit

      Module node/tcp

      Index

      Functions

      checkPortAvailability +node/tcp | @shopify/cli-kit

      Module node/tcp

      Index

      Functions

      checkPortAvailability getAvailableTCPPort

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_testing_output.html b/docs/api/cli-kit/modules/node_testing_output.html index e78d92aa0a..f231e650e8 100644 --- a/docs/api/cli-kit/modules/node_testing_output.html +++ b/docs/api/cli-kit/modules/node_testing_output.html @@ -1,2 +1,2 @@ -node/testing/output | @shopify/cli-kit

      Module node/testing/output

      Index

      Functions

      mockAndCaptureOutput +node/testing/output | @shopify/cli-kit

      Module node/testing/output

      Index

      Functions

      mockAndCaptureOutput

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_testing_ui.html b/docs/api/cli-kit/modules/node_testing_ui.html index 141a4dd6ff..c93aa2dc04 100644 --- a/docs/api/cli-kit/modules/node_testing_ui.html +++ b/docs/api/cli-kit/modules/node_testing_ui.html @@ -1,4 +1,4 @@ -node/testing/ui | @shopify/cli-kit

      Module node/testing/ui

      Index

      Classes

      Stdin +node/testing/ui | @shopify/cli-kit

      Module node/testing/ui

      Index

      Classes

      Stdin

      Functions

      getLastFrameAfterUnmount render sendInputAndWait diff --git a/docs/api/cli-kit/modules/node_themes_api.html b/docs/api/cli-kit/modules/node_themes_api.html index ddbe352bc8..8525c1d61c 100644 --- a/docs/api/cli-kit/modules/node_themes_api.html +++ b/docs/api/cli-kit/modules/node_themes_api.html @@ -1,4 +1,4 @@ -node/themes/api | @shopify/cli-kit

      Module node/themes/api

      Index

      Type Aliases

      AssetParams +node/themes/api | @shopify/cli-kit

      Module node/themes/api

      Index

      Type Aliases

      AssetParams ThemeParams

      Functions

      bulkUploadThemeAssets createTheme diff --git a/docs/api/cli-kit/modules/node_themes_conf.html b/docs/api/cli-kit/modules/node_themes_conf.html index 49e0c11cda..d06df5b35b 100644 --- a/docs/api/cli-kit/modules/node_themes_conf.html +++ b/docs/api/cli-kit/modules/node_themes_conf.html @@ -1,4 +1,4 @@ -node/themes/conf | @shopify/cli-kit

      Module node/themes/conf

      Index

      Functions

      getHostTheme +node/themes/conf | @shopify/cli-kit

      Module node/themes/conf

      Index

      Functions

      getHostTheme hostThemeLocalStorage removeHostTheme setHostTheme diff --git a/docs/api/cli-kit/modules/node_themes_factories.html b/docs/api/cli-kit/modules/node_themes_factories.html index 1af9c936f4..3f8ac21772 100644 --- a/docs/api/cli-kit/modules/node_themes_factories.html +++ b/docs/api/cli-kit/modules/node_themes_factories.html @@ -1,4 +1,4 @@ -node/themes/factories | @shopify/cli-kit

      Module node/themes/factories

      Index

      Interfaces

      RemoteBulkUploadResponse +node/themes/factories | @shopify/cli-kit

      Module node/themes/factories

      Index

      Interfaces

      RemoteBulkUploadResponse

      Functions

      buildBulkUploadResults buildChecksum buildTheme diff --git a/docs/api/cli-kit/modules/node_themes_theme_manager.html b/docs/api/cli-kit/modules/node_themes_theme_manager.html index f790c274fe..3ecce9c9d9 100644 --- a/docs/api/cli-kit/modules/node_themes_theme_manager.html +++ b/docs/api/cli-kit/modules/node_themes_theme_manager.html @@ -1,2 +1,2 @@ -node/themes/theme-manager | @shopify/cli-kit

      Module node/themes/theme-manager

      Index

      Classes

      ThemeManager +node/themes/theme-manager | @shopify/cli-kit

      Module node/themes/theme-manager

      Index

      Classes

      ThemeManager

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_themes_types.html b/docs/api/cli-kit/modules/node_themes_types.html index 1ef23b2187..5ff29b63da 100644 --- a/docs/api/cli-kit/modules/node_themes_types.html +++ b/docs/api/cli-kit/modules/node_themes_types.html @@ -1,4 +1,4 @@ -node/themes/types | @shopify/cli-kit

      Module node/themes/types

      Index

      Enumerations

      Operation +node/themes/types | @shopify/cli-kit

      Module node/themes/types

      Index

      Enumerations

      Operation

      Interfaces

      Checksum Result Theme diff --git a/docs/api/cli-kit/modules/node_themes_urls.html b/docs/api/cli-kit/modules/node_themes_urls.html index 7cedab537d..da1476eca9 100644 --- a/docs/api/cli-kit/modules/node_themes_urls.html +++ b/docs/api/cli-kit/modules/node_themes_urls.html @@ -1,4 +1,4 @@ -node/themes/urls | @shopify/cli-kit

      Module node/themes/urls

      Index

      Functions

      codeEditorUrl +node/themes/urls | @shopify/cli-kit

      Module node/themes/urls

      Index

      Functions

      codeEditorUrl storeAdminUrl themeEditorUrl themePreviewUrl diff --git a/docs/api/cli-kit/modules/node_themes_utils.html b/docs/api/cli-kit/modules/node_themes_utils.html index ba5672b5f9..785206e9bd 100644 --- a/docs/api/cli-kit/modules/node_themes_utils.html +++ b/docs/api/cli-kit/modules/node_themes_utils.html @@ -1,4 +1,4 @@ -node/themes/utils | @shopify/cli-kit

      Module node/themes/utils

      Index

      Type Aliases

      Role +node/themes/utils | @shopify/cli-kit

      Module node/themes/utils

      Index

      Type Aliases

      Role

      Variables

      DEVELOPMENT_THEME_ROLE LIVE_THEME_ROLE UNPUBLISHED_THEME_ROLE diff --git a/docs/api/cli-kit/modules/node_toml.html b/docs/api/cli-kit/modules/node_toml.html index 2851c85e8d..d8c5e8b5fd 100644 --- a/docs/api/cli-kit/modules/node_toml.html +++ b/docs/api/cli-kit/modules/node_toml.html @@ -1,4 +1,4 @@ -node/toml | @shopify/cli-kit

      Module node/toml

      Index

      Type Aliases

      JsonMapType +node/toml | @shopify/cli-kit

      Module node/toml

      Index

      Type Aliases

      JsonMapType

      Functions

      decodeToml encodeToml

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_tree_kill.html b/docs/api/cli-kit/modules/node_tree_kill.html index b8a77a5a23..62b860bdaa 100644 --- a/docs/api/cli-kit/modules/node_tree_kill.html +++ b/docs/api/cli-kit/modules/node_tree_kill.html @@ -1,2 +1,2 @@ -node/tree-kill | @shopify/cli-kit

      Module node/tree-kill

      Index

      Functions

      treeKill +node/tree-kill | @shopify/cli-kit

      Module node/tree-kill

      Index

      Functions

      treeKill

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_ui.html b/docs/api/cli-kit/modules/node_ui.html index 7befe3b019..dc8a3b8ef3 100644 --- a/docs/api/cli-kit/modules/node_ui.html +++ b/docs/api/cli-kit/modules/node_ui.html @@ -1,4 +1,4 @@ -node/ui | @shopify/cli-kit

      Module node/ui

      Index

      Interfaces

      InfoTableSection +node/ui | @shopify/cli-kit

      Module node/ui

      Index

      Interfaces

      InfoTableSection LinkToken ListToken RenderAutocompleteOptions diff --git a/docs/api/cli-kit/modules/node_ui_components.html b/docs/api/cli-kit/modules/node_ui_components.html index c03387b383..82ec9e7e72 100644 --- a/docs/api/cli-kit/modules/node_ui_components.html +++ b/docs/api/cli-kit/modules/node_ui_components.html @@ -1,4 +1,4 @@ -node/ui/components | @shopify/cli-kit

      Module node/ui/components

      Index

      Interfaces

      ConcurrentOutputContext +node/ui/components | @shopify/cli-kit

      Module node/ui/components

      Index

      Interfaces

      ConcurrentOutputContext

      Functions

      ConcurrentOutput useConcurrentOutputContext

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_ui_hooks.html b/docs/api/cli-kit/modules/node_ui_hooks.html index 17c81734f2..4da50a2a98 100644 --- a/docs/api/cli-kit/modules/node_ui_hooks.html +++ b/docs/api/cli-kit/modules/node_ui_hooks.html @@ -1,2 +1,2 @@ -node/ui/hooks | @shopify/cli-kit

      Module node/ui/hooks

      Index

      Functions

      useAbortSignal +node/ui/hooks | @shopify/cli-kit

      Module node/ui/hooks

      Index

      Functions

      useAbortSignal

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_upgrade.html b/docs/api/cli-kit/modules/node_upgrade.html index ee9acc3eaa..d99eb77949 100644 --- a/docs/api/cli-kit/modules/node_upgrade.html +++ b/docs/api/cli-kit/modules/node_upgrade.html @@ -1,3 +1,3 @@ -node/upgrade | @shopify/cli-kit

      Module node/upgrade

      Index

      Functions

      cliInstallCommand +node/upgrade | @shopify/cli-kit

      Module node/upgrade

      Index

      Functions

      cliInstallCommand getOutputUpdateCLIReminder

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_vendor_otel_js_export_InstantaneousMetricReader.html b/docs/api/cli-kit/modules/node_vendor_otel_js_export_InstantaneousMetricReader.html index 942638dd32..1e65531dd6 100644 --- a/docs/api/cli-kit/modules/node_vendor_otel_js_export_InstantaneousMetricReader.html +++ b/docs/api/cli-kit/modules/node_vendor_otel_js_export_InstantaneousMetricReader.html @@ -1,3 +1,3 @@ -node/vendor/otel-js/export/InstantaneousMetricReader | @shopify/cli-kit

      Module node/vendor/otel-js/export/InstantaneousMetricReader

      Index

      Classes

      InstantaneousMetricReader +node/vendor/otel-js/export/InstantaneousMetricReader | @shopify/cli-kit

      Module node/vendor/otel-js/export/InstantaneousMetricReader

      Index

      Classes

      InstantaneousMetricReader

      Interfaces

      InstantaneousMetricReaderOptions

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.html b/docs/api/cli-kit/modules/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.html index 33847645b0..9a3e4de5a4 100644 --- a/docs/api/cli-kit/modules/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.html +++ b/docs/api/cli-kit/modules/node_vendor_otel_js_service_BaseOtelService_BaseOtelService.html @@ -1,3 +1,3 @@ -node/vendor/otel-js/service/BaseOtelService/BaseOtelService | @shopify/cli-kit

      Module node/vendor/otel-js/service/BaseOtelService/BaseOtelService

      Index

      Classes

      BaseOtelService +node/vendor/otel-js/service/BaseOtelService/BaseOtelService | @shopify/cli-kit

      Module node/vendor/otel-js/service/BaseOtelService/BaseOtelService

      Index

      Classes

      BaseOtelService

      Interfaces

      BaseOtelServiceOptions

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.html b/docs/api/cli-kit/modules/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.html index b512b52413..ac3e6fa401 100644 --- a/docs/api/cli-kit/modules/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.html +++ b/docs/api/cli-kit/modules/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.html @@ -1,3 +1,3 @@ -node/vendor/otel-js/service/DefaultOtelService/DefaultMeterProvider | @shopify/cli-kit

      Module node/vendor/otel-js/service/DefaultOtelService/DefaultMeterProvider

      Index

      Classes

      DefaultMeterProvider +node/vendor/otel-js/service/DefaultOtelService/DefaultMeterProvider | @shopify/cli-kit

      Module node/vendor/otel-js/service/DefaultOtelService/DefaultMeterProvider

      Index

      Classes

      DefaultMeterProvider

      Type Aliases

      Environment

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.html b/docs/api/cli-kit/modules/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.html index 8087ab0e7c..05bbd3a460 100644 --- a/docs/api/cli-kit/modules/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.html +++ b/docs/api/cli-kit/modules/node_vendor_otel_js_service_DefaultOtelService_DefaultOtelService.html @@ -1,3 +1,3 @@ -node/vendor/otel-js/service/DefaultOtelService/DefaultOtelService | @shopify/cli-kit

      Module node/vendor/otel-js/service/DefaultOtelService/DefaultOtelService

      Index

      Classes

      DefaultOtelService +node/vendor/otel-js/service/DefaultOtelService/DefaultOtelService | @shopify/cli-kit

      Module node/vendor/otel-js/service/DefaultOtelService/DefaultOtelService

      Index

      Classes

      DefaultOtelService

      Interfaces

      DefaultOtelServiceOptions

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_vendor_otel_js_service_types.html b/docs/api/cli-kit/modules/node_vendor_otel_js_service_types.html index cda923242c..7fe93dfb88 100644 --- a/docs/api/cli-kit/modules/node_vendor_otel_js_service_types.html +++ b/docs/api/cli-kit/modules/node_vendor_otel_js_service_types.html @@ -1,4 +1,4 @@ -node/vendor/otel-js/service/types | @shopify/cli-kit

      Module node/vendor/otel-js/service/types

      Index

      Enumerations

      MetricInstrumentType +node/vendor/otel-js/service/types | @shopify/cli-kit

      Module node/vendor/otel-js/service/types

      Index

      Enumerations

      MetricInstrumentType

      Interfaces

      MetricsConfig OtelService

      Type Aliases

      CustomMetricLabels diff --git a/docs/api/cli-kit/modules/node_vendor_otel_js_utils_throttle.html b/docs/api/cli-kit/modules/node_vendor_otel_js_utils_throttle.html index b1fab97dda..227af96293 100644 --- a/docs/api/cli-kit/modules/node_vendor_otel_js_utils_throttle.html +++ b/docs/api/cli-kit/modules/node_vendor_otel_js_utils_throttle.html @@ -1,2 +1,2 @@ -node/vendor/otel-js/utils/throttle | @shopify/cli-kit

      Module node/vendor/otel-js/utils/throttle

      Index

      Functions

      throttle +node/vendor/otel-js/utils/throttle | @shopify/cli-kit

      Module node/vendor/otel-js/utils/throttle

      Index

      Functions

      throttle

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_vendor_otel_js_utils_validators.html b/docs/api/cli-kit/modules/node_vendor_otel_js_utils_validators.html index dc9d744578..0f77eedb3d 100644 --- a/docs/api/cli-kit/modules/node_vendor_otel_js_utils_validators.html +++ b/docs/api/cli-kit/modules/node_vendor_otel_js_utils_validators.html @@ -1,2 +1,2 @@ -node/vendor/otel-js/utils/validators | @shopify/cli-kit

      Module node/vendor/otel-js/utils/validators

      Index

      Functions

      isValidMetricName +node/vendor/otel-js/utils/validators | @shopify/cli-kit

      Module node/vendor/otel-js/utils/validators

      Index

      Functions

      isValidMetricName

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_vscode.html b/docs/api/cli-kit/modules/node_vscode.html index 30e7013a29..579d7d4195 100644 --- a/docs/api/cli-kit/modules/node_vscode.html +++ b/docs/api/cli-kit/modules/node_vscode.html @@ -1,3 +1,3 @@ -node/vscode | @shopify/cli-kit

      Module node/vscode

      Index

      Functions

      addRecommendedExtensions +node/vscode | @shopify/cli-kit

      Module node/vscode

      Index

      Functions

      addRecommendedExtensions isVSCode

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/common_string.RandomNameFamily.html b/docs/api/cli-kit/types/common_string.RandomNameFamily.html index d0fb807d86..edde6aded0 100644 --- a/docs/api/cli-kit/types/common_string.RandomNameFamily.html +++ b/docs/api/cli-kit/types/common_string.RandomNameFamily.html @@ -1 +1 @@ -RandomNameFamily | @shopify/cli-kit

      Type alias RandomNameFamily

      RandomNameFamily: "business" | "creative"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +RandomNameFamily | @shopify/cli-kit

      Type alias RandomNameFamily

      RandomNameFamily: "business" | "creative"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/common_ts_deep_required.DeepRequired.html b/docs/api/cli-kit/types/common_ts_deep_required.DeepRequired.html index b38ec6807f..fb631685be 100644 --- a/docs/api/cli-kit/types/common_ts_deep_required.DeepRequired.html +++ b/docs/api/cli-kit/types/common_ts_deep_required.DeepRequired.html @@ -1,4 +1,4 @@ DeepRequired | @shopify/cli-kit

      Type alias DeepRequired<T>

      DeepRequired<T>: {
          [TKey in keyof Required<T>]: NonNullable<Required<T>[TKey]>
      }

      Converts a mapping type to be non-optional.

      type T = DeepRequired<{optionalKey?: string, nullableValue: string | null, undefinableValue: string | undefined}>
      T = {optionalKey: string, nullableValue: string, undefinableValue: string}
      -

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/common_ts_pick_by_prefix.PickByPrefix.html b/docs/api/cli-kit/types/common_ts_pick_by_prefix.PickByPrefix.html index cffbe4097b..159e3e7bda 100644 --- a/docs/api/cli-kit/types/common_ts_pick_by_prefix.PickByPrefix.html +++ b/docs/api/cli-kit/types/common_ts_pick_by_prefix.PickByPrefix.html @@ -1,4 +1,4 @@ PickByPrefix | @shopify/cli-kit

      Type alias PickByPrefix<TMapping, TPrefix, TKeys>

      PickByPrefix<TMapping, TPrefix, TKeys>: {
          [TKey in keyof TMapping as TKey extends `${TPrefix}${infer _TSuffix}` | TKeys
              ? TKey
              : never]: TMapping[TKey]
      }

      Produces a subset of a mapping type, where the keys either match some prefix string, or are in a list of exact matches.

      type T = PickByPrefix<{foo_1: number, foo_2: number, nope: string, included: string, also: number}, 'foo_', 'included' | 'also'>.

      T = {foo_1: number, foo_2: number, included: string, also: number}
      -

      Type Parameters

      • TMapping
      • TPrefix extends string
      • TKeys extends keyof TMapping = never

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      • TMapping
      • TPrefix extends string
      • TKeys extends keyof TMapping = never

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_analytics.CommandExitMode.html b/docs/api/cli-kit/types/node_analytics.CommandExitMode.html index d007b1e751..3cd2a179f9 100644 --- a/docs/api/cli-kit/types/node_analytics.CommandExitMode.html +++ b/docs/api/cli-kit/types/node_analytics.CommandExitMode.html @@ -1 +1 @@ -CommandExitMode | @shopify/cli-kit

      Type alias CommandExitMode

      CommandExitMode: "ok" | "unexpected_error" | "expected_error"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +CommandExitMode | @shopify/cli-kit

      Type alias CommandExitMode

      CommandExitMode: "ok" | "unexpected_error" | "expected_error"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_api_graphql.Exact.html b/docs/api/cli-kit/types/node_api_graphql.Exact.html index 3c508dbdfb..f9468e3271 100644 --- a/docs/api/cli-kit/types/node_api_graphql.Exact.html +++ b/docs/api/cli-kit/types/node_api_graphql.Exact.html @@ -1 +1 @@ -Exact | @shopify/cli-kit

      Type alias Exact<T>

      Exact<T>: {
          [K in keyof T]: T[K]
      }

      Type Parameters

      • T extends {
            [key: string]: unknown;
        }

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Exact | @shopify/cli-kit

      Type alias Exact<T>

      Exact<T>: {
          [K in keyof T]: T[K]
      }

      Type Parameters

      • T extends {
            [key: string]: unknown;
        }

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_api_graphql.GraphQLRequestDocOptions.html b/docs/api/cli-kit/types/node_api_graphql.GraphQLRequestDocOptions.html index cf6b93ba5c..cafb2c8679 100644 --- a/docs/api/cli-kit/types/node_api_graphql.GraphQLRequestDocOptions.html +++ b/docs/api/cli-kit/types/node_api_graphql.GraphQLRequestDocOptions.html @@ -1 +1 @@ -GraphQLRequestDocOptions | @shopify/cli-kit

      Type alias GraphQLRequestDocOptions<TResult, TVariables>

      GraphQLRequestDocOptions<TResult, TVariables>: GraphQLRequestBaseOptions<TResult> & {
          query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{
              [key: string]: never;
          }>>;
          variables?: TVariables;
      }

      Type Parameters

      • TResult
      • TVariables

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +GraphQLRequestDocOptions | @shopify/cli-kit

      Type alias GraphQLRequestDocOptions<TResult, TVariables>

      GraphQLRequestDocOptions<TResult, TVariables>: GraphQLRequestBaseOptions<TResult> & {
          query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{
              [key: string]: never;
          }>>;
          variables?: TVariables;
      }

      Type Parameters

      • TResult
      • TVariables

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_api_graphql.GraphQLRequestOptions.html b/docs/api/cli-kit/types/node_api_graphql.GraphQLRequestOptions.html index 5f3f19f965..cfcb57281b 100644 --- a/docs/api/cli-kit/types/node_api_graphql.GraphQLRequestOptions.html +++ b/docs/api/cli-kit/types/node_api_graphql.GraphQLRequestOptions.html @@ -1 +1 @@ -GraphQLRequestOptions | @shopify/cli-kit

      Type alias GraphQLRequestOptions<T>

      GraphQLRequestOptions<T>: GraphQLRequestBaseOptions<T> & {
          query: RequestDocument;
          variables?: Variables;
      }

      Type Parameters

      • T

      Type declaration

      • query: RequestDocument
      • Optional variables?: Variables

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +GraphQLRequestOptions | @shopify/cli-kit

      Type alias GraphQLRequestOptions<T>

      GraphQLRequestOptions<T>: GraphQLRequestBaseOptions<T> & {
          query: RequestDocument;
          variables?: Variables;
      }

      Type Parameters

      • T

      Type declaration

      • query: RequestDocument
      • Optional variables?: Variables

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_api_graphql.GraphQLResponse.html b/docs/api/cli-kit/types/node_api_graphql.GraphQLResponse.html index 5a84aaaade..c512937801 100644 --- a/docs/api/cli-kit/types/node_api_graphql.GraphQLResponse.html +++ b/docs/api/cli-kit/types/node_api_graphql.GraphQLResponse.html @@ -1 +1 @@ -GraphQLResponse | @shopify/cli-kit

      Type alias GraphQLResponse<T>

      GraphQLResponse<T>: Awaited<ReturnType<typeof rawRequest>>

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +GraphQLResponse | @shopify/cli-kit

      Type alias GraphQLResponse<T>

      GraphQLResponse<T>: Awaited<ReturnType<typeof rawRequest>>

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_context_local.CIMetadata.html b/docs/api/cli-kit/types/node_context_local.CIMetadata.html index 7851222d16..ae73af8d82 100644 --- a/docs/api/cli-kit/types/node_context_local.CIMetadata.html +++ b/docs/api/cli-kit/types/node_context_local.CIMetadata.html @@ -1 +1 @@ -CIMetadata | @shopify/cli-kit

      Type alias CIMetadata

      CIMetadata: Metadata

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +CIMetadata | @shopify/cli-kit

      Type alias CIMetadata

      CIMetadata: Metadata

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_fs.ReadOptions.html b/docs/api/cli-kit/types/node_fs.ReadOptions.html index 1caad0402e..a8a2fe2928 100644 --- a/docs/api/cli-kit/types/node_fs.ReadOptions.html +++ b/docs/api/cli-kit/types/node_fs.ReadOptions.html @@ -2,4 +2,4 @@ utf-8 encoding.

      Type declaration

      • Optional flag?: string

      Type declaration

      • encoding: BufferEncoding | string
      • Optional flag?: string

      Param: path

      Path to the file to read.

      Returns

      A promise that resolves with the content of the file.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_hrtime.StartTime.html b/docs/api/cli-kit/types/node_hrtime.StartTime.html index 0c2ba5a621..e7b10a462e 100644 --- a/docs/api/cli-kit/types/node_hrtime.StartTime.html +++ b/docs/api/cli-kit/types/node_hrtime.StartTime.html @@ -1 +1 @@ -StartTime | @shopify/cli-kit

      Type alias StartTime

      StartTime: [number, number]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +StartTime | @shopify/cli-kit

      Type alias StartTime

      StartTime: [number, number]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_metadata.Public.html b/docs/api/cli-kit/types/node_metadata.Public.html index ea69fae212..4792cdf21b 100644 --- a/docs/api/cli-kit/types/node_metadata.Public.html +++ b/docs/api/cli-kit/types/node_metadata.Public.html @@ -1 +1 @@ -Public | @shopify/cli-kit

      Type alias Public

      Public: PublicSchema<typeof coreData>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Public | @shopify/cli-kit

      Type alias Public

      Public: PublicSchema<typeof coreData>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_metadata.PublicSchema.html b/docs/api/cli-kit/types/node_metadata.PublicSchema.html index 5ff0e40198..d2419e2c59 100644 --- a/docs/api/cli-kit/types/node_metadata.PublicSchema.html +++ b/docs/api/cli-kit/types/node_metadata.PublicSchema.html @@ -1 +1 @@ -PublicSchema | @shopify/cli-kit

      Type alias PublicSchema<T>

      PublicSchema<T>: T extends RuntimeMetadataManager<infer TPublic, infer _TSensitive>
          ? TPublic
          : never

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +PublicSchema | @shopify/cli-kit

      Type alias PublicSchema<T>

      PublicSchema<T>: T extends RuntimeMetadataManager<infer TPublic, infer _TSensitive>
          ? TPublic
          : never

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_metadata.Sensitive.html b/docs/api/cli-kit/types/node_metadata.Sensitive.html index 6a1e46b8c4..78adf19748 100644 --- a/docs/api/cli-kit/types/node_metadata.Sensitive.html +++ b/docs/api/cli-kit/types/node_metadata.Sensitive.html @@ -1 +1 @@ -Sensitive | @shopify/cli-kit

      Type alias Sensitive

      Sensitive: SensitiveSchema<typeof coreData>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Sensitive | @shopify/cli-kit

      Type alias Sensitive

      Sensitive: SensitiveSchema<typeof coreData>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_metadata.SensitiveSchema.html b/docs/api/cli-kit/types/node_metadata.SensitiveSchema.html index 3c9badf542..485db9e4f1 100644 --- a/docs/api/cli-kit/types/node_metadata.SensitiveSchema.html +++ b/docs/api/cli-kit/types/node_metadata.SensitiveSchema.html @@ -1 +1 @@ -SensitiveSchema | @shopify/cli-kit

      Type alias SensitiveSchema<T>

      SensitiveSchema<T>: T extends RuntimeMetadataManager<infer _TPublic, infer TSensitive>
          ? TSensitive
          : never

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +SensitiveSchema | @shopify/cli-kit

      Type alias SensitiveSchema<T>

      SensitiveSchema<T>: T extends RuntimeMetadataManager<infer _TPublic, infer TSensitive>
          ? TSensitive
          : never

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_monorail.MonorailEventPublic.html b/docs/api/cli-kit/types/node_monorail.MonorailEventPublic.html index b033a5bbe0..cab8c168ee 100644 --- a/docs/api/cli-kit/types/node_monorail.MonorailEventPublic.html +++ b/docs/api/cli-kit/types/node_monorail.MonorailEventPublic.html @@ -1 +1 @@ -MonorailEventPublic | @shopify/cli-kit

      Type alias MonorailEventPublic

      MonorailEventPublic: DeepRequired<Schemas[typeof MONORAIL_COMMAND_TOPIC]["public"]>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +MonorailEventPublic | @shopify/cli-kit

      Type alias MonorailEventPublic

      MonorailEventPublic: DeepRequired<Schemas[typeof MONORAIL_COMMAND_TOPIC]["public"]>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_monorail.MonorailEventSensitive.html b/docs/api/cli-kit/types/node_monorail.MonorailEventSensitive.html index eb767287f5..1431e42fc0 100644 --- a/docs/api/cli-kit/types/node_monorail.MonorailEventSensitive.html +++ b/docs/api/cli-kit/types/node_monorail.MonorailEventSensitive.html @@ -1 +1 @@ -MonorailEventSensitive | @shopify/cli-kit

      Type alias MonorailEventSensitive

      MonorailEventSensitive: Schemas[typeof MONORAIL_COMMAND_TOPIC]["sensitive"]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +MonorailEventSensitive | @shopify/cli-kit

      Type alias MonorailEventSensitive

      MonorailEventSensitive: Schemas[typeof MONORAIL_COMMAND_TOPIC]["sensitive"]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_node_package_manager.DependencyType.html b/docs/api/cli-kit/types/node_node_package_manager.DependencyType.html index fb60b974b8..03d3c49846 100644 --- a/docs/api/cli-kit/types/node_node_package_manager.DependencyType.html +++ b/docs/api/cli-kit/types/node_node_package_manager.DependencyType.html @@ -4,4 +4,4 @@
    • prod: dependencies
    • peer: peerDependencies
      • -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_node_package_manager.Lockfile.html b/docs/api/cli-kit/types/node_node_package_manager.Lockfile.html index 7a5b7010ac..938b7e7d82 100644 --- a/docs/api/cli-kit/types/node_node_package_manager.Lockfile.html +++ b/docs/api/cli-kit/types/node_node_package_manager.Lockfile.html @@ -1 +1 @@ -Lockfile | @shopify/cli-kit

      Type alias Lockfile

      Lockfile: "yarn.lock" | "package-lock.json" | "pnpm-lock.yaml" | "bun.lockb"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Lockfile | @shopify/cli-kit

      Type alias Lockfile

      Lockfile: "yarn.lock" | "package-lock.json" | "pnpm-lock.yaml" | "bun.lockb"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_node_package_manager.PackageManager.html b/docs/api/cli-kit/types/node_node_package_manager.PackageManager.html index 36ec59c492..35e2e8eb8c 100644 --- a/docs/api/cli-kit/types/node_node_package_manager.PackageManager.html +++ b/docs/api/cli-kit/types/node_node_package_manager.PackageManager.html @@ -1 +1 @@ -PackageManager | @shopify/cli-kit

      Type alias PackageManager

      PackageManager: typeof packageManager[number]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +PackageManager | @shopify/cli-kit

      Type alias PackageManager

      PackageManager: typeof packageManager[number]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_output.LogLevel.html b/docs/api/cli-kit/types/node_output.LogLevel.html index ed09503489..9422eca142 100644 --- a/docs/api/cli-kit/types/node_output.LogLevel.html +++ b/docs/api/cli-kit/types/node_output.LogLevel.html @@ -1,2 +1,2 @@ LogLevel | @shopify/cli-kit

      Type alias LogLevel

      LogLevel: "fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent"

      Log levels.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_output.Logger.html b/docs/api/cli-kit/types/node_output.Logger.html index 79b6fc8a58..1769082327 100644 --- a/docs/api/cli-kit/types/node_output.Logger.html +++ b/docs/api/cli-kit/types/node_output.Logger.html @@ -1 +1 @@ -Logger | @shopify/cli-kit

      Type alias Logger

      Logger: Writable | ((message, logLevel?) => void)

      Type declaration

        • (message, logLevel?): void

        • Parameters

          • message: string
          • Optional logLevel: LogLevel

          Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Logger | @shopify/cli-kit

      Type alias Logger

      Logger: Writable | ((message, logLevel?) => void)

      Type declaration

        • (message, logLevel?): void

        • Parameters

          • message: string
          • Optional logLevel: LogLevel

          Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_output.OutputMessage.html b/docs/api/cli-kit/types/node_output.OutputMessage.html index 86163867d5..f2d152d336 100644 --- a/docs/api/cli-kit/types/node_output.OutputMessage.html +++ b/docs/api/cli-kit/types/node_output.OutputMessage.html @@ -1 +1 @@ -OutputMessage | @shopify/cli-kit

      Type alias OutputMessage

      OutputMessage: string | TokenizedString

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +OutputMessage | @shopify/cli-kit

      Type alias OutputMessage

      OutputMessage: string | TokenizedString

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_plugins.FanoutHookFunction.html b/docs/api/cli-kit/types/node_plugins.FanoutHookFunction.html index 8f8ca3d749..53766a7926 100644 --- a/docs/api/cli-kit/types/node_plugins.FanoutHookFunction.html +++ b/docs/api/cli-kit/types/node_plugins.FanoutHookFunction.html @@ -1 +1 @@ -FanoutHookFunction | @shopify/cli-kit

      Type alias FanoutHookFunction<TEvent, TPluginName, TPluginMap>

      FanoutHookFunction<TEvent, TPluginName, TPluginMap>: ((this, options) => Promise<PluginReturnsForHook<TEvent, TPluginName, TPluginMap>>)

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +FanoutHookFunction | @shopify/cli-kit

      Type alias FanoutHookFunction<TEvent, TPluginName, TPluginMap>

      FanoutHookFunction<TEvent, TPluginName, TPluginMap>: ((this, options) => Promise<PluginReturnsForHook<TEvent, TPluginName, TPluginMap>>)

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_plugins.PluginReturnsForHook.html b/docs/api/cli-kit/types/node_plugins.PluginReturnsForHook.html index e2a4cd50b4..2898d866d0 100644 --- a/docs/api/cli-kit/types/node_plugins.PluginReturnsForHook.html +++ b/docs/api/cli-kit/types/node_plugins.PluginReturnsForHook.html @@ -1 +1 @@ -PluginReturnsForHook | @shopify/cli-kit

      Type alias PluginReturnsForHook<TEvent, TPluginName, TPluginMap>

      PluginReturnsForHook<TEvent, TPluginName, TPluginMap>: TPluginMap[TEvent]["pluginReturns"][TPluginName]

      Type Parameters

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +PluginReturnsForHook | @shopify/cli-kit

      Type alias PluginReturnsForHook<TEvent, TPluginName, TPluginMap>

      PluginReturnsForHook<TEvent, TPluginName, TPluginMap>: TPluginMap[TEvent]["pluginReturns"][TPluginName]

      Type Parameters

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelErrorType.html b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelErrorType.html index 05a1e652a9..008d99060b 100644 --- a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelErrorType.html +++ b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelErrorType.html @@ -1 +1 @@ -TunnelErrorType | @shopify/cli-kit

      Type alias TunnelErrorType

      TunnelErrorType: "invalid-provider" | "tunnel-already-running" | "wrong-credentials" | "unknown"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +TunnelErrorType | @shopify/cli-kit

      Type alias TunnelErrorType

      TunnelErrorType: "invalid-provider" | "tunnel-already-running" | "wrong-credentials" | "unknown"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelProviderFunction.html b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelProviderFunction.html index 6dccf73d1f..8eb67f29be 100644 --- a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelProviderFunction.html +++ b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelProviderFunction.html @@ -1 +1 @@ -TunnelProviderFunction | @shopify/cli-kit

      Type alias TunnelProviderFunction

      TunnelProviderFunction: FanoutHookFunction<"tunnel_provider", "">

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +TunnelProviderFunction | @shopify/cli-kit

      Type alias TunnelProviderFunction

      TunnelProviderFunction: FanoutHookFunction<"tunnel_provider", "">

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartAction.html b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartAction.html index 9ab8ed29c2..c6509bdc95 100644 --- a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartAction.html +++ b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartAction.html @@ -1 +1 @@ -TunnelStartAction | @shopify/cli-kit

      Type alias TunnelStartAction

      TunnelStartAction: ((port) => Promise<TunnelStartReturn>)

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +TunnelStartAction | @shopify/cli-kit

      Type alias TunnelStartAction

      TunnelStartAction: ((port) => Promise<TunnelStartReturn>)

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartFunction.html b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartFunction.html index 9242929035..43fc28afea 100644 --- a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartFunction.html +++ b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartFunction.html @@ -1 +1 @@ -TunnelStartFunction | @shopify/cli-kit

      Type alias TunnelStartFunction

      TunnelStartFunction: FanoutHookFunction<"tunnel_start", "">

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +TunnelStartFunction | @shopify/cli-kit

      Type alias TunnelStartFunction

      TunnelStartFunction: FanoutHookFunction<"tunnel_start", "">

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartReturn.html b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartReturn.html index 2cca7ed65c..dc9f03ce69 100644 --- a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartReturn.html +++ b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStartReturn.html @@ -1 +1 @@ -TunnelStartReturn | @shopify/cli-kit

      Type alias TunnelStartReturn

      TunnelStartReturn: PluginReturnsForHook<"tunnel_start", "">

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +TunnelStartReturn | @shopify/cli-kit

      Type alias TunnelStartReturn

      TunnelStartReturn: PluginReturnsForHook<"tunnel_start", "">

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStatusType.html b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStatusType.html index 33eac53a82..13c01959ba 100644 --- a/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStatusType.html +++ b/docs/api/cli-kit/types/node_plugins_tunnel.TunnelStatusType.html @@ -1 +1 @@ -TunnelStatusType | @shopify/cli-kit

      Type alias TunnelStatusType

      TunnelStatusType: {
          status: "not-started";
      } | {
          status: "starting";
      } | {
          status: "connected";
          url: string;
      } | {
          message: TokenItem | OutputMessage;
          status: "error";
          tryMessage?: TokenItem | OutputMessage | null;
      }

      Type declaration

      • status: "not-started"

      Type declaration

      • status: "starting"

      Type declaration

      • status: "connected"
      • url: string

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +TunnelStatusType | @shopify/cli-kit

      Type alias TunnelStatusType

      TunnelStatusType: {
          status: "not-started";
      } | {
          status: "starting";
      } | {
          status: "connected";
          url: string;
      } | {
          message: TokenItem | OutputMessage;
          status: "error";
          tryMessage?: TokenItem | OutputMessage | null;
      }

      Type declaration

      • status: "not-started"

      Type declaration

      • status: "starting"

      Type declaration

      • status: "connected"
      • url: string

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_result.Result.html b/docs/api/cli-kit/types/node_result.Result.html index e923c38152..48374e7cb5 100644 --- a/docs/api/cli-kit/types/node_result.Result.html +++ b/docs/api/cli-kit/types/node_result.Result.html @@ -1 +1 @@ -Result | @shopify/cli-kit

      Type alias Result<TValue, TError>

      Result<TValue, TError>: Ok<TValue, TError> | Err<TValue, TError>

      Type Parameters

      • TValue
      • TError

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Result | @shopify/cli-kit

      Type alias Result<TValue, TError>

      Result<TValue, TError>: Ok<TValue, TError> | Err<TValue, TError>

      Type Parameters

      • TValue
      • TError

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_schema.ParseConfigurationResult.html b/docs/api/cli-kit/types/node_schema.ParseConfigurationResult.html index ffee94041c..23f3e6e6b3 100644 --- a/docs/api/cli-kit/types/node_schema.ParseConfigurationResult.html +++ b/docs/api/cli-kit/types/node_schema.ParseConfigurationResult.html @@ -1,4 +1,4 @@ ParseConfigurationResult | @shopify/cli-kit

      Type alias ParseConfigurationResult<TConfiguration>

      ParseConfigurationResult<TConfiguration>: {
          data: TConfiguration;
          errors: undefined;
          state: "ok";
      } | {
          data: undefined;
          errors: Pick<z.ZodIssueBase, "path" | "message">[];
          state: "error";
      }

      A neutral type for the result of a parsing/validation operation.

      As some validation can happen via JSON Schema, we prefer to use a type that isn't wholly dependent on Zod (or JSON Schema).

      -

      Type Parameters

      • TConfiguration

      Type declaration

      Type declaration

      • data: undefined
      • errors: Pick<z.ZodIssueBase, "path" | "message">[]
      • state: "error"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      • TConfiguration

      Type declaration

      Type declaration

      • data: undefined
      • errors: Pick<z.ZodIssueBase, "path" | "message">[]
      • state: "error"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_schema.ZodObjectOf.html b/docs/api/cli-kit/types/node_schema.ZodObjectOf.html index d9d55d73b0..6b309e3885 100644 --- a/docs/api/cli-kit/types/node_schema.ZodObjectOf.html +++ b/docs/api/cli-kit/types/node_schema.ZodObjectOf.html @@ -1,2 +1,2 @@ ZodObjectOf | @shopify/cli-kit

      Type alias ZodObjectOf<T>

      ZodObjectOf<T>: ZodObject<any, any, any, T>

      Type alias for a zod object schema that produces a given shape once parsed.

      -

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_themes_api.AssetParams.html b/docs/api/cli-kit/types/node_themes_api.AssetParams.html index 0037c5062f..820646b7d6 100644 --- a/docs/api/cli-kit/types/node_themes_api.AssetParams.html +++ b/docs/api/cli-kit/types/node_themes_api.AssetParams.html @@ -1 +1 @@ -AssetParams | @shopify/cli-kit

      Type alias AssetParams

      AssetParams: Pick<ThemeAsset, "key"> & Partial<Pick<ThemeAsset, "value" | "attachment">>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +AssetParams | @shopify/cli-kit

      Type alias AssetParams

      AssetParams: Pick<ThemeAsset, "key"> & Partial<Pick<ThemeAsset, "value" | "attachment">>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_themes_api.ThemeParams.html b/docs/api/cli-kit/types/node_themes_api.ThemeParams.html index c1065e55a1..90dae911f2 100644 --- a/docs/api/cli-kit/types/node_themes_api.ThemeParams.html +++ b/docs/api/cli-kit/types/node_themes_api.ThemeParams.html @@ -1 +1 @@ -ThemeParams | @shopify/cli-kit

      Type alias ThemeParams

      ThemeParams: Partial<Pick<Theme, "name" | "role" | "processing" | "src">>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +ThemeParams | @shopify/cli-kit

      Type alias ThemeParams

      ThemeParams: Partial<Pick<Theme, "name" | "role" | "processing" | "src">>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_themes_types.Key.html b/docs/api/cli-kit/types/node_themes_types.Key.html index 433eeb7f8d..64613be693 100644 --- a/docs/api/cli-kit/types/node_themes_types.Key.html +++ b/docs/api/cli-kit/types/node_themes_types.Key.html @@ -1,2 +1,2 @@ Key | @shopify/cli-kit

      Type alias Key

      Key: string

      Key represents the unique identifier of a file in a theme.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_themes_types.ThemeFSEventName.html b/docs/api/cli-kit/types/node_themes_types.ThemeFSEventName.html index 6bd44e231d..c1e1dec253 100644 --- a/docs/api/cli-kit/types/node_themes_types.ThemeFSEventName.html +++ b/docs/api/cli-kit/types/node_themes_types.ThemeFSEventName.html @@ -1 +1 @@ -ThemeFSEventName | @shopify/cli-kit

      Type alias ThemeFSEventName

      ThemeFSEventName: "add" | "change" | "unlink"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +ThemeFSEventName | @shopify/cli-kit

      Type alias ThemeFSEventName

      ThemeFSEventName: "add" | "change" | "unlink"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_themes_types.ThemeFSEventPayload.html b/docs/api/cli-kit/types/node_themes_types.ThemeFSEventPayload.html index 0a16a71308..24d5e0441a 100644 --- a/docs/api/cli-kit/types/node_themes_types.ThemeFSEventPayload.html +++ b/docs/api/cli-kit/types/node_themes_types.ThemeFSEventPayload.html @@ -1 +1 @@ -ThemeFSEventPayload | @shopify/cli-kit

      Type alias ThemeFSEventPayload<T>

      ThemeFSEventPayload<T>: (ThemeFSEvent & {
          type: T;
      })["payload"]

      Type Parameters

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +ThemeFSEventPayload | @shopify/cli-kit

      Type alias ThemeFSEventPayload<T>

      ThemeFSEventPayload<T>: (ThemeFSEvent & {
          type: T;
      })["payload"]

      Type Parameters

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_themes_utils.Role.html b/docs/api/cli-kit/types/node_themes_utils.Role.html index 8a95f80197..ed4be65645 100644 --- a/docs/api/cli-kit/types/node_themes_utils.Role.html +++ b/docs/api/cli-kit/types/node_themes_utils.Role.html @@ -1 +1 @@ -Role | @shopify/cli-kit

      Type alias Role

      Role: typeof DEVELOPMENT_THEME_ROLE | typeof LIVE_THEME_ROLE | typeof UNPUBLISHED_THEME_ROLE

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Role | @shopify/cli-kit

      Type alias Role

      Role: typeof DEVELOPMENT_THEME_ROLE | typeof LIVE_THEME_ROLE | typeof UNPUBLISHED_THEME_ROLE

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_toml.JsonMapType.html b/docs/api/cli-kit/types/node_toml.JsonMapType.html index 66ff35c595..d65c69a13b 100644 --- a/docs/api/cli-kit/types/node_toml.JsonMapType.html +++ b/docs/api/cli-kit/types/node_toml.JsonMapType.html @@ -1 +1 @@ -JsonMapType | @shopify/cli-kit

      Type alias JsonMapType

      JsonMapType: JsonMap

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +JsonMapType | @shopify/cli-kit

      Type alias JsonMapType

      JsonMapType: JsonMap

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_ui.AlertCustomSection.html b/docs/api/cli-kit/types/node_ui.AlertCustomSection.html index 1bac3fcd20..d9f497f65e 100644 --- a/docs/api/cli-kit/types/node_ui.AlertCustomSection.html +++ b/docs/api/cli-kit/types/node_ui.AlertCustomSection.html @@ -1 +1 @@ -AlertCustomSection | @shopify/cli-kit

      Type alias AlertCustomSection

      AlertCustomSection: CustomSection

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +AlertCustomSection | @shopify/cli-kit

      Type alias AlertCustomSection

      AlertCustomSection: CustomSection

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_ui.InfoMessage.html b/docs/api/cli-kit/types/node_ui.InfoMessage.html index 869b9ecc13..53610f802e 100644 --- a/docs/api/cli-kit/types/node_ui.InfoMessage.html +++ b/docs/api/cli-kit/types/node_ui.InfoMessage.html @@ -1 +1 @@ -InfoMessage | @shopify/cli-kit

      Type alias InfoMessage

      InfoMessage: InfoMessageProps["message"]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +InfoMessage | @shopify/cli-kit

      Type alias InfoMessage

      InfoMessage: InfoMessageProps["message"]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_ui.InlineToken.html b/docs/api/cli-kit/types/node_ui.InlineToken.html index 3c3a138782..e87fa511a9 100644 --- a/docs/api/cli-kit/types/node_ui.InlineToken.html +++ b/docs/api/cli-kit/types/node_ui.InlineToken.html @@ -1 +1 @@ -InlineToken | @shopify/cli-kit

      Type alias InlineToken

      InlineToken: Exclude<Token, ListToken>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +InlineToken | @shopify/cli-kit

      Type alias InlineToken

      InlineToken: Exclude<Token, ListToken>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_ui.Key.html b/docs/api/cli-kit/types/node_ui.Key.html index 20ff1549d8..e58dfaa23f 100644 --- a/docs/api/cli-kit/types/node_ui.Key.html +++ b/docs/api/cli-kit/types/node_ui.Key.html @@ -1 +1 @@ -Key | @shopify/cli-kit

      Type alias Key

      Key: InkKey

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Key | @shopify/cli-kit

      Type alias Key

      Key: InkKey

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_ui.RenderAlertOptions.html b/docs/api/cli-kit/types/node_ui.RenderAlertOptions.html index 871541aca2..e4ce25d390 100644 --- a/docs/api/cli-kit/types/node_ui.RenderAlertOptions.html +++ b/docs/api/cli-kit/types/node_ui.RenderAlertOptions.html @@ -1 +1 @@ -RenderAlertOptions | @shopify/cli-kit

      Type alias RenderAlertOptions

      RenderAlertOptions: Omit<AlertOptions, "type">

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +RenderAlertOptions | @shopify/cli-kit

      Type alias RenderAlertOptions

      RenderAlertOptions: Omit<AlertOptions, "type">

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_ui.TableColumn.html b/docs/api/cli-kit/types/node_ui.TableColumn.html index 3b40cf9cc5..9bdb7f5dbf 100644 --- a/docs/api/cli-kit/types/node_ui.TableColumn.html +++ b/docs/api/cli-kit/types/node_ui.TableColumn.html @@ -1 +1 @@ -TableColumn | @shopify/cli-kit

      Type alias TableColumn<T>

      TableColumn<T>: {
          [column in keyof T]: {
              color?: ForegroundColor | "dim";
              header?: string;
          }
      }

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +TableColumn | @shopify/cli-kit

      Type alias TableColumn<T>

      TableColumn<T>: {
          [column in keyof T]: {
              color?: ForegroundColor | "dim";
              header?: string;
          }
      }

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_ui.Token.html b/docs/api/cli-kit/types/node_ui.Token.html index 9c6ddddfb7..a216586c54 100644 --- a/docs/api/cli-kit/types/node_ui.Token.html +++ b/docs/api/cli-kit/types/node_ui.Token.html @@ -1 +1 @@ -Token | @shopify/cli-kit

      Type alias Token

      Token: string | CommandToken | LinkToken | CharToken | UserInputToken | SubduedToken | FilePathToken | ListToken | BoldToken | InfoToken | WarnToken | ErrorToken

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Token | @shopify/cli-kit

      Type alias Token

      Token: string | CommandToken | LinkToken | CharToken | UserInputToken | SubduedToken | FilePathToken | ListToken | BoldToken | InfoToken | WarnToken | ErrorToken

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_ui.TokenItem.html b/docs/api/cli-kit/types/node_ui.TokenItem.html index 057918a28c..fb00e4b1a6 100644 --- a/docs/api/cli-kit/types/node_ui.TokenItem.html +++ b/docs/api/cli-kit/types/node_ui.TokenItem.html @@ -1 +1 @@ -TokenItem | @shopify/cli-kit

      Type alias TokenItem<T>

      TokenItem<T>: T | T[]

      Type Parameters

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +TokenItem | @shopify/cli-kit

      Type alias TokenItem<T>

      TokenItem<T>: T | T[]

      Type Parameters

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.Environment.html b/docs/api/cli-kit/types/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.Environment.html index f8b88fa73c..2f3c6f0a37 100644 --- a/docs/api/cli-kit/types/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.Environment.html +++ b/docs/api/cli-kit/types/node_vendor_otel_js_service_DefaultOtelService_DefaultMeterProvider.Environment.html @@ -1 +1 @@ -Environment | @shopify/cli-kit

      Type alias Environment

      Environment: "production" | "staging" | "local"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +Environment | @shopify/cli-kit

      Type alias Environment

      Environment: "production" | "staging" | "local"

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.CustomMetricLabels.html b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.CustomMetricLabels.html index 39a4fe58b4..ce392a6fe2 100644 --- a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.CustomMetricLabels.html +++ b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.CustomMetricLabels.html @@ -1 +1 @@ -CustomMetricLabels | @shopify/cli-kit

      Type alias CustomMetricLabels<TLabels, TKeys>

      CustomMetricLabels<TLabels, TKeys>: {
          [P in TKeys]: TLabels[P] extends MetricAttributes
              ? TLabels[P]
              : never
      }

      Type Parameters

      • TLabels extends {
            [key in TKeys]: MetricAttributes
        }
      • TKeys extends string = keyof TLabels & string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +CustomMetricLabels | @shopify/cli-kit

      Type alias CustomMetricLabels<TLabels, TKeys>

      CustomMetricLabels<TLabels, TKeys>: {
          [P in TKeys]: TLabels[P] extends MetricAttributes
              ? TLabels[P]
              : never
      }

      Type Parameters

      • TLabels extends {
            [key in TKeys]: MetricAttributes
        }
      • TKeys extends string = keyof TLabels & string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricDescriptor.html b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricDescriptor.html index dd5f3aa18f..86a8ba0dda 100644 --- a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricDescriptor.html +++ b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricDescriptor.html @@ -1 +1 @@ -MetricDescriptor | @shopify/cli-kit

      Type alias MetricDescriptor

      MetricDescriptor: MetricOptions & ({
          boundaries: number[];
          type: Histogram;
      } | {
          type: Counter | UpDownCounter;
      })

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +MetricDescriptor | @shopify/cli-kit

      Type alias MetricDescriptor

      MetricDescriptor: MetricOptions & ({
          boundaries: number[];
          type: Histogram;
      } | {
          type: Counter | UpDownCounter;
      })

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricInstrument.html b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricInstrument.html index 45bb98c9a8..97990a7c1c 100644 --- a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricInstrument.html +++ b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricInstrument.html @@ -1 +1 @@ -MetricInstrument | @shopify/cli-kit

      Type alias MetricInstrument

      MetricInstrument: Histogram | Counter | UpDownCounter

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +MetricInstrument | @shopify/cli-kit

      Type alias MetricInstrument

      MetricInstrument: Histogram | Counter | UpDownCounter

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricRecording.html b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricRecording.html index 1549cbc4f4..b26a4660fb 100644 --- a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricRecording.html +++ b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.MetricRecording.html @@ -1 +1 @@ -MetricRecording | @shopify/cli-kit

      Type alias MetricRecording<TAttributes>

      MetricRecording<TAttributes>: [value: number, labels?: TAttributes]

      Type Parameters

      • TAttributes extends MetricAttributes = any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +MetricRecording | @shopify/cli-kit

      Type alias MetricRecording<TAttributes>

      MetricRecording<TAttributes>: [value: number, labels?: TAttributes]

      Type Parameters

      • TAttributes extends MetricAttributes = any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.OnRecordCallback.html b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.OnRecordCallback.html index 8236bc9fa2..252243509a 100644 --- a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.OnRecordCallback.html +++ b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.OnRecordCallback.html @@ -1 +1 @@ -OnRecordCallback | @shopify/cli-kit

      Type alias OnRecordCallback<TAttributes>

      OnRecordCallback<TAttributes>: ((metricName, ...args) => MetricRecording<TAttributes> | void)

      Type Parameters

      • TAttributes extends MetricAttributes = any

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +OnRecordCallback | @shopify/cli-kit

      Type alias OnRecordCallback<TAttributes>

      OnRecordCallback<TAttributes>: ((metricName, ...args) => MetricRecording<TAttributes> | void)

      Type Parameters

      • TAttributes extends MetricAttributes = any

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.RecordMetricFunction.html b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.RecordMetricFunction.html index 5b278cd95b..2130245ee8 100644 --- a/docs/api/cli-kit/types/node_vendor_otel_js_service_types.RecordMetricFunction.html +++ b/docs/api/cli-kit/types/node_vendor_otel_js_service_types.RecordMetricFunction.html @@ -1 +1 @@ -RecordMetricFunction | @shopify/cli-kit

      Type alias RecordMetricFunction<TAttributes>

      RecordMetricFunction<TAttributes>: ((...args) => void)

      Type Parameters

      • TAttributes extends MetricAttributes = any

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +RecordMetricFunction | @shopify/cli-kit

      Type alias RecordMetricFunction<TAttributes>

      RecordMetricFunction<TAttributes>: ((...args) => void)

      Type Parameters

      • TAttributes extends MetricAttributes = any

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/common_version.CLI_KIT_VERSION.html b/docs/api/cli-kit/variables/common_version.CLI_KIT_VERSION.html index 42817c3353..df3d764852 100644 --- a/docs/api/cli-kit/variables/common_version.CLI_KIT_VERSION.html +++ b/docs/api/cli-kit/variables/common_version.CLI_KIT_VERSION.html @@ -1 +1 @@ -CLI_KIT_VERSION | @shopify/cli-kit

      Variable CLI_KIT_VERSIONConst

      CLI_KIT_VERSION: "3.67.0" = '3.67.0'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +CLI_KIT_VERSION | @shopify/cli-kit

      Variable CLI_KIT_VERSIONConst

      CLI_KIT_VERSION: "3.67.1" = '3.67.1'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_cli.globalFlags.html b/docs/api/cli-kit/variables/node_cli.globalFlags.html index aa416c9566..8f19364ef7 100644 --- a/docs/api/cli-kit/variables/node_cli.globalFlags.html +++ b/docs/api/cli-kit/variables/node_cli.globalFlags.html @@ -1,3 +1,3 @@ globalFlags | @shopify/cli-kit

      Variable globalFlagsConst

      globalFlags: {
          no-color: BooleanFlag<boolean>;
          verbose: BooleanFlag<boolean>;
      } = ...

      An object that contains the flags that are shared across all the commands.

      -

      Type declaration

      • no-color: BooleanFlag<boolean>
      • verbose: BooleanFlag<boolean>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type declaration

      • no-color: BooleanFlag<boolean>
      • verbose: BooleanFlag<boolean>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainIdentitySpinFQDNError.html b/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainIdentitySpinFQDNError.html index 22043afd65..3e7c321354 100644 --- a/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainIdentitySpinFQDNError.html +++ b/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainIdentitySpinFQDNError.html @@ -1 +1 @@ -CouldntObtainIdentitySpinFQDNError | @shopify/cli-kit

      Variable CouldntObtainIdentitySpinFQDNErrorConst

      CouldntObtainIdentitySpinFQDNError: AbortError = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +CouldntObtainIdentitySpinFQDNError | @shopify/cli-kit

      Variable CouldntObtainIdentitySpinFQDNErrorConst

      CouldntObtainIdentitySpinFQDNError: AbortError = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainPartnersSpinFQDNError.html b/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainPartnersSpinFQDNError.html index d0ef72dd76..9de7002b6d 100644 --- a/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainPartnersSpinFQDNError.html +++ b/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainPartnersSpinFQDNError.html @@ -1 +1 @@ -CouldntObtainPartnersSpinFQDNError | @shopify/cli-kit

      Variable CouldntObtainPartnersSpinFQDNErrorConst

      CouldntObtainPartnersSpinFQDNError: AbortError = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +CouldntObtainPartnersSpinFQDNError | @shopify/cli-kit

      Variable CouldntObtainPartnersSpinFQDNErrorConst

      CouldntObtainPartnersSpinFQDNError: AbortError = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainShopifySpinFQDNError.html b/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainShopifySpinFQDNError.html index 0db129e4a5..01c5d1fa8f 100644 --- a/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainShopifySpinFQDNError.html +++ b/docs/api/cli-kit/variables/node_context_fqdn.CouldntObtainShopifySpinFQDNError.html @@ -1 +1 @@ -CouldntObtainShopifySpinFQDNError | @shopify/cli-kit

      Variable CouldntObtainShopifySpinFQDNErrorConst

      CouldntObtainShopifySpinFQDNError: AbortError = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +CouldntObtainShopifySpinFQDNError | @shopify/cli-kit

      Variable CouldntObtainShopifySpinFQDNErrorConst

      CouldntObtainShopifySpinFQDNError: AbortError = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_context_fqdn.NotProvidedStoreFQDNError.html b/docs/api/cli-kit/variables/node_context_fqdn.NotProvidedStoreFQDNError.html index 31ae7b675a..69f226bfd4 100644 --- a/docs/api/cli-kit/variables/node_context_fqdn.NotProvidedStoreFQDNError.html +++ b/docs/api/cli-kit/variables/node_context_fqdn.NotProvidedStoreFQDNError.html @@ -1 +1 @@ -NotProvidedStoreFQDNError | @shopify/cli-kit

      Variable NotProvidedStoreFQDNErrorConst

      NotProvidedStoreFQDNError: AbortError = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +NotProvidedStoreFQDNError | @shopify/cli-kit

      Variable NotProvidedStoreFQDNErrorConst

      NotProvidedStoreFQDNError: AbortError = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_context_spin.spinVariables.html b/docs/api/cli-kit/variables/node_context_spin.spinVariables.html index 5b45ede76d..4ef8fd5da8 100644 --- a/docs/api/cli-kit/variables/node_context_spin.spinVariables.html +++ b/docs/api/cli-kit/variables/node_context_spin.spinVariables.html @@ -1 +1 @@ -spinVariables | @shopify/cli-kit

      Variable spinVariablesConst

      spinVariables: {
          manualCliSpinPortName: string;
          partnersSpinService: string;
      } = ...

      Type declaration

      • manualCliSpinPortName: string
      • partnersSpinService: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +spinVariables | @shopify/cli-kit

      Variable spinVariablesConst

      spinVariables: {
          manualCliSpinPortName: string;
          partnersSpinService: string;
      } = ...

      Type declaration

      • manualCliSpinPortName: string
      • partnersSpinService: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_monorail.MONORAIL_COMMAND_TOPIC.html b/docs/api/cli-kit/variables/node_monorail.MONORAIL_COMMAND_TOPIC.html index 2bd3aacb9b..c9e62982e1 100644 --- a/docs/api/cli-kit/variables/node_monorail.MONORAIL_COMMAND_TOPIC.html +++ b/docs/api/cli-kit/variables/node_monorail.MONORAIL_COMMAND_TOPIC.html @@ -1 +1 @@ -MONORAIL_COMMAND_TOPIC | @shopify/cli-kit

      Variable MONORAIL_COMMAND_TOPICConst

      MONORAIL_COMMAND_TOPIC: "app_cli3_command/1.12" = 'app_cli3_command/1.12'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +MONORAIL_COMMAND_TOPIC | @shopify/cli-kit

      Variable MONORAIL_COMMAND_TOPICConst

      MONORAIL_COMMAND_TOPIC: "app_cli3_command/1.12" = 'app_cli3_command/1.12'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_node_package_manager.bunLockfile.html b/docs/api/cli-kit/variables/node_node_package_manager.bunLockfile.html index a92a7c44f7..5091ae2164 100644 --- a/docs/api/cli-kit/variables/node_node_package_manager.bunLockfile.html +++ b/docs/api/cli-kit/variables/node_node_package_manager.bunLockfile.html @@ -1,2 +1,2 @@ bunLockfile | @shopify/cli-kit

      Variable bunLockfileConst

      bunLockfile: "bun.lockb" = 'bun.lockb'

      The name of the bun lock file

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_node_package_manager.lockfiles.html b/docs/api/cli-kit/variables/node_node_package_manager.lockfiles.html index 7a0823c3a8..99a45ab04b 100644 --- a/docs/api/cli-kit/variables/node_node_package_manager.lockfiles.html +++ b/docs/api/cli-kit/variables/node_node_package_manager.lockfiles.html @@ -1,2 +1,2 @@ lockfiles | @shopify/cli-kit

      Variable lockfilesConst

      lockfiles: Lockfile[] = ...

      An array containing the lockfiles from all the package managers

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_node_package_manager.npmLockfile.html b/docs/api/cli-kit/variables/node_node_package_manager.npmLockfile.html index 8b8a7a5437..4663ea688a 100644 --- a/docs/api/cli-kit/variables/node_node_package_manager.npmLockfile.html +++ b/docs/api/cli-kit/variables/node_node_package_manager.npmLockfile.html @@ -1,2 +1,2 @@ npmLockfile | @shopify/cli-kit

      Variable npmLockfileConst

      npmLockfile: "package-lock.json" = 'package-lock.json'

      The name of the npm lock file

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_node_package_manager.packageManager-1.html b/docs/api/cli-kit/variables/node_node_package_manager.packageManager-1.html index ce58b5f159..d14095873b 100644 --- a/docs/api/cli-kit/variables/node_node_package_manager.packageManager-1.html +++ b/docs/api/cli-kit/variables/node_node_package_manager.packageManager-1.html @@ -1,2 +1,2 @@ packageManager | @shopify/cli-kit

      Variable packageManagerConst

      packageManager: readonly ["yarn", "npm", "pnpm", "bun", "unknown"] = ...

      A union that represents the package managers available.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_node_package_manager.pnpmLockfile.html b/docs/api/cli-kit/variables/node_node_package_manager.pnpmLockfile.html index 719ad4f3f0..6c301efa52 100644 --- a/docs/api/cli-kit/variables/node_node_package_manager.pnpmLockfile.html +++ b/docs/api/cli-kit/variables/node_node_package_manager.pnpmLockfile.html @@ -1,2 +1,2 @@ pnpmLockfile | @shopify/cli-kit

      Variable pnpmLockfileConst

      pnpmLockfile: "pnpm-lock.yaml" = 'pnpm-lock.yaml'

      The name of the pnpm lock file

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_node_package_manager.pnpmWorkspaceFile.html b/docs/api/cli-kit/variables/node_node_package_manager.pnpmWorkspaceFile.html index 12d76f6fb7..eda05424df 100644 --- a/docs/api/cli-kit/variables/node_node_package_manager.pnpmWorkspaceFile.html +++ b/docs/api/cli-kit/variables/node_node_package_manager.pnpmWorkspaceFile.html @@ -1,2 +1,2 @@ pnpmWorkspaceFile | @shopify/cli-kit

      Variable pnpmWorkspaceFileConst

      pnpmWorkspaceFile: "pnpm-workspace.yaml" = 'pnpm-workspace.yaml'

      The name of the pnpm workspace file

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_node_package_manager.yarnLockfile.html b/docs/api/cli-kit/variables/node_node_package_manager.yarnLockfile.html index 09ca0f9017..13412f85f5 100644 --- a/docs/api/cli-kit/variables/node_node_package_manager.yarnLockfile.html +++ b/docs/api/cli-kit/variables/node_node_package_manager.yarnLockfile.html @@ -1,2 +1,2 @@ yarnLockfile | @shopify/cli-kit

      Variable yarnLockfileConst

      yarnLockfile: "yarn.lock" = 'yarn.lock'

      The name of the Yarn lock file

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_output.collectedLogs.html b/docs/api/cli-kit/variables/node_output.collectedLogs.html index f6558d1155..ab7670e891 100644 --- a/docs/api/cli-kit/variables/node_output.collectedLogs.html +++ b/docs/api/cli-kit/variables/node_output.collectedLogs.html @@ -1 +1 @@ -collectedLogs | @shopify/cli-kit

      Variable collectedLogs

      collectedLogs: {
          [key: string]: string[];
      } = {}

      Type declaration

      • [key: string]: string[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +collectedLogs | @shopify/cli-kit

      Variable collectedLogs

      collectedLogs: {
          [key: string]: string[];
      } = {}

      Type declaration

      • [key: string]: string[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_output.outputToken.html b/docs/api/cli-kit/variables/node_output.outputToken.html index ce26615a58..bc6eb0ceab 100644 --- a/docs/api/cli-kit/variables/node_output.outputToken.html +++ b/docs/api/cli-kit/variables/node_output.outputToken.html @@ -1 +1 @@ -outputToken | @shopify/cli-kit

      Variable outputTokenConst

      outputToken: {
          cyan(value): ColorContentToken;
          errorText(value): ErrorContentToken;
          failIcon(): ErrorContentToken;
          genericShellCommand(value): CommandContentToken;
          gray(value): ColorContentToken;
          green(value): ColorContentToken;
          heading(value): HeadingContentToken;
          italic(value): ItalicContentToken;
          json(value): JsonContentToken;
          linesDiff(value): LinesDiffContentToken;
          link(value, link?, fallback?): LinkContentToken;
          magenta(value): ColorContentToken;
          packagejsonScript(packageManager, scriptName, ...scriptArgs): CommandContentToken;
          path(value): PathContentToken;
          raw(value): RawContentToken;
          subheading(value): SubHeadingContentToken;
          successIcon(): ColorContentToken;
          yellow(value): ColorContentToken;
      } = ...

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +outputToken | @shopify/cli-kit

      Variable outputTokenConst

      outputToken: {
          cyan(value): ColorContentToken;
          errorText(value): ErrorContentToken;
          failIcon(): ErrorContentToken;
          genericShellCommand(value): CommandContentToken;
          gray(value): ColorContentToken;
          green(value): ColorContentToken;
          heading(value): HeadingContentToken;
          italic(value): ItalicContentToken;
          json(value): JsonContentToken;
          linesDiff(value): LinesDiffContentToken;
          link(value, link?, fallback?): LinkContentToken;
          magenta(value): ColorContentToken;
          packagejsonScript(packageManager, scriptName, ...scriptArgs): CommandContentToken;
          path(value): PathContentToken;
          raw(value): RawContentToken;
          subheading(value): SubHeadingContentToken;
          successIcon(): ColorContentToken;
          yellow(value): ColorContentToken;
      } = ...

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_ruby.MinWdmWindowsVersion.html b/docs/api/cli-kit/variables/node_ruby.MinWdmWindowsVersion.html index c804f77488..c0e47eff28 100644 --- a/docs/api/cli-kit/variables/node_ruby.MinWdmWindowsVersion.html +++ b/docs/api/cli-kit/variables/node_ruby.MinWdmWindowsVersion.html @@ -1 +1 @@ -MinWdmWindowsVersion | @shopify/cli-kit

      Variable MinWdmWindowsVersionConst

      MinWdmWindowsVersion: "0.1.0" = '0.1.0'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +MinWdmWindowsVersion | @shopify/cli-kit

      Variable MinWdmWindowsVersionConst

      MinWdmWindowsVersion: "0.1.0" = '0.1.0'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_ruby.RubyCLIVersion.html b/docs/api/cli-kit/variables/node_ruby.RubyCLIVersion.html index cd38546f6e..5bafe36d1d 100644 --- a/docs/api/cli-kit/variables/node_ruby.RubyCLIVersion.html +++ b/docs/api/cli-kit/variables/node_ruby.RubyCLIVersion.html @@ -1 +1 @@ -RubyCLIVersion | @shopify/cli-kit

      Variable RubyCLIVersionConst

      RubyCLIVersion: "2.35.0" = '2.35.0'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +RubyCLIVersion | @shopify/cli-kit

      Variable RubyCLIVersionConst

      RubyCLIVersion: "2.35.0" = '2.35.0'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_themes_utils.DEVELOPMENT_THEME_ROLE.html b/docs/api/cli-kit/variables/node_themes_utils.DEVELOPMENT_THEME_ROLE.html index b700054c63..2948bbef32 100644 --- a/docs/api/cli-kit/variables/node_themes_utils.DEVELOPMENT_THEME_ROLE.html +++ b/docs/api/cli-kit/variables/node_themes_utils.DEVELOPMENT_THEME_ROLE.html @@ -1 +1 @@ -DEVELOPMENT_THEME_ROLE | @shopify/cli-kit

      Variable DEVELOPMENT_THEME_ROLEConst

      DEVELOPMENT_THEME_ROLE: "development" = 'development'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +DEVELOPMENT_THEME_ROLE | @shopify/cli-kit

      Variable DEVELOPMENT_THEME_ROLEConst

      DEVELOPMENT_THEME_ROLE: "development" = 'development'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_themes_utils.LIVE_THEME_ROLE.html b/docs/api/cli-kit/variables/node_themes_utils.LIVE_THEME_ROLE.html index cf6e8c1303..0639d26cff 100644 --- a/docs/api/cli-kit/variables/node_themes_utils.LIVE_THEME_ROLE.html +++ b/docs/api/cli-kit/variables/node_themes_utils.LIVE_THEME_ROLE.html @@ -1 +1 @@ -LIVE_THEME_ROLE | @shopify/cli-kit

      Variable LIVE_THEME_ROLEConst

      LIVE_THEME_ROLE: "live" = 'live'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +LIVE_THEME_ROLE | @shopify/cli-kit

      Variable LIVE_THEME_ROLEConst

      LIVE_THEME_ROLE: "live" = 'live'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_themes_utils.UNPUBLISHED_THEME_ROLE.html b/docs/api/cli-kit/variables/node_themes_utils.UNPUBLISHED_THEME_ROLE.html index 65374fcbc7..a8474de6f1 100644 --- a/docs/api/cli-kit/variables/node_themes_utils.UNPUBLISHED_THEME_ROLE.html +++ b/docs/api/cli-kit/variables/node_themes_utils.UNPUBLISHED_THEME_ROLE.html @@ -1 +1 @@ -UNPUBLISHED_THEME_ROLE | @shopify/cli-kit

      Variable UNPUBLISHED_THEME_ROLEConst

      UNPUBLISHED_THEME_ROLE: "unpublished" = 'unpublished'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +UNPUBLISHED_THEME_ROLE | @shopify/cli-kit

      Variable UNPUBLISHED_THEME_ROLEConst

      UNPUBLISHED_THEME_ROLE: "unpublished" = 'unpublished'

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/packages/app/CHANGELOG.md b/packages/app/CHANGELOG.md index 05cd0d5854..b0a730acec 100644 --- a/packages/app/CHANGELOG.md +++ b/packages/app/CHANGELOG.md @@ -1,5 +1,19 @@ # @shopify/app +## 3.67.1 + +### Patch Changes + +- b294b1596: Updates Javy to version 3.1.1 +- 28de21b0e: Fixes a bug where some users were unable to intialize their app dev command with theme app extensions +- Updated dependencies [72859c9cb] +- Updated dependencies [28de21b0e] +- Updated dependencies [926963590] + - @shopify/theme@3.67.1 + - @shopify/cli-kit@3.67.1 + - @shopify/create-app@3.67.1 + - @shopify/plugin-cloudflare@3.67.1 + ## 3.67.0 ### Minor Changes diff --git a/packages/app/package.json b/packages/app/package.json index 1df04e5f60..301d9a0256 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/app", - "version": "3.67.0", + "version": "3.67.1", "description": "Utilities for loading, building, and publishing apps.", "homepage": "https://github.com/shopify/cli#readme", "private": true, @@ -51,11 +51,11 @@ "@graphql-typed-document-node/core": "3.2.0", "@luckycatfactory/esbuild-graphql-loader": "3.8.1", "@oclif/core": "3.26.5", - "@shopify/cli-kit": "3.67.0", - "@shopify/create-app": "3.67.0", - "@shopify/theme": "3.67.0", + "@shopify/cli-kit": "3.67.1", + "@shopify/create-app": "3.67.1", + "@shopify/theme": "3.67.1", "@shopify/function-runner": "4.1.1", - "@shopify/plugin-cloudflare": "3.67.0", + "@shopify/plugin-cloudflare": "3.67.1", "@shopify/polaris": "12.10.0", "@shopify/polaris-icons": "8.0.0", "@shopify/theme-check-node": "2.9.0", diff --git a/packages/cli-kit/CHANGELOG.md b/packages/cli-kit/CHANGELOG.md index 5d3dd1381a..6df5427a44 100644 --- a/packages/cli-kit/CHANGELOG.md +++ b/packages/cli-kit/CHANGELOG.md @@ -1,5 +1,11 @@ # @shopify/cli-kit +## 3.67.1 + +### Patch Changes + +- 926963590: Fix a bug when building empty theme assets + ## 3.67.0 ### Minor Changes diff --git a/packages/cli-kit/package.json b/packages/cli-kit/package.json index 75dd01e6f2..16ce26fc96 100644 --- a/packages/cli-kit/package.json +++ b/packages/cli-kit/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/cli-kit", - "version": "3.67.0", + "version": "3.67.1", "private": false, "description": "A set of utilities, interfaces, and models that are common across all the platform features", "keywords": [ diff --git a/packages/cli-kit/src/public/common/version.ts b/packages/cli-kit/src/public/common/version.ts index 436700fc76..4a41280977 100644 --- a/packages/cli-kit/src/public/common/version.ts +++ b/packages/cli-kit/src/public/common/version.ts @@ -1 +1 @@ -export const CLI_KIT_VERSION = '3.67.0' +export const CLI_KIT_VERSION = '3.67.1' diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index d8f26981b0..1e6e272bb1 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -1,5 +1,7 @@ # @shopify/cli +## 3.67.1 + ## 3.67.0 ### Minor Changes diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json index dac703c70d..f9aa2b9d3d 100644 --- a/packages/cli/oclif.manifest.json +++ b/packages/cli/oclif.manifest.json @@ -6565,5 +6565,5 @@ "summary": "Trigger delivery of a sample webhook topic payload to a designated address." } }, - "version": "3.67.0" + "version": "3.67.1" } \ No newline at end of file diff --git a/packages/cli/package.json b/packages/cli/package.json index ad224ab7dd..e2915271fa 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/cli", - "version": "3.67.0", + "version": "3.67.1", "private": false, "description": "A CLI tool to build for the Shopify platform", "keywords": [ @@ -104,11 +104,11 @@ "@oclif/core": "3.26.5", "@oclif/plugin-commands": "3.3.2", "@oclif/plugin-plugins": "5.1.2", - "@shopify/app": "3.67.0", - "@shopify/cli-kit": "3.67.0", - "@shopify/plugin-cloudflare": "3.67.0", - "@shopify/plugin-did-you-mean": "3.67.0", - "@shopify/theme": "3.67.0", + "@shopify/app": "3.67.1", + "@shopify/cli-kit": "3.67.1", + "@shopify/plugin-cloudflare": "3.67.1", + "@shopify/plugin-did-you-mean": "3.67.1", + "@shopify/theme": "3.67.1", "@shopify/cli-hydrogen": "8.4.4", "@types/node": "18.19.3", "@vitest/coverage-istanbul": "^1.6.0", diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md index cd2baebbef..1ef88c554a 100644 --- a/packages/create-app/CHANGELOG.md +++ b/packages/create-app/CHANGELOG.md @@ -1,5 +1,7 @@ # @shopify/create-app +## 3.67.1 + ## 3.67.0 ## 3.66.0 diff --git a/packages/create-app/oclif.manifest.json b/packages/create-app/oclif.manifest.json index 9e87f485bb..e39847d31a 100644 --- a/packages/create-app/oclif.manifest.json +++ b/packages/create-app/oclif.manifest.json @@ -99,5 +99,5 @@ "summary": "Create a new app project" } }, - "version": "3.67.0" + "version": "3.67.1" } \ No newline at end of file diff --git a/packages/create-app/package.json b/packages/create-app/package.json index cfbe3812f3..279b2bbdb6 100644 --- a/packages/create-app/package.json +++ b/packages/create-app/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/create-app", - "version": "3.67.0", + "version": "3.67.1", "private": false, "description": "A CLI tool to create a new Shopify app.", "keywords": [ @@ -56,7 +56,7 @@ }, "devDependencies": { "@oclif/core": "3.26.5", - "@shopify/cli-kit": "3.67.0", + "@shopify/cli-kit": "3.67.1", "@types/node": "18.19.3", "esbuild-plugin-copy": "^2.1.1", "@vitest/coverage-istanbul": "^1.6.0" diff --git a/packages/plugin-cloudflare/CHANGELOG.md b/packages/plugin-cloudflare/CHANGELOG.md index 890994404d..3513e31e61 100644 --- a/packages/plugin-cloudflare/CHANGELOG.md +++ b/packages/plugin-cloudflare/CHANGELOG.md @@ -1,5 +1,12 @@ # @shopify/plugin-cloudflare +## 3.67.1 + +### Patch Changes + +- Updated dependencies [926963590] + - @shopify/cli-kit@3.67.1 + ## 3.67.0 ### Patch Changes diff --git a/packages/plugin-cloudflare/package.json b/packages/plugin-cloudflare/package.json index 0af76904c1..0bb58febca 100644 --- a/packages/plugin-cloudflare/package.json +++ b/packages/plugin-cloudflare/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/plugin-cloudflare", - "version": "3.67.0", + "version": "3.67.1", "description": "Enables the creation of Cloudflare tunnels from `shopify app dev`, allowing previews from any device", "keywords": [ "shopify", @@ -47,7 +47,7 @@ }, "dependencies": { "@oclif/core": "3.26.5", - "@shopify/cli-kit": "3.67.0" + "@shopify/cli-kit": "3.67.1" }, "devDependencies": { "@vitest/coverage-istanbul": "^1.6.0" diff --git a/packages/plugin-did-you-mean/CHANGELOG.md b/packages/plugin-did-you-mean/CHANGELOG.md index 3e425d15b7..bcb7dd9916 100644 --- a/packages/plugin-did-you-mean/CHANGELOG.md +++ b/packages/plugin-did-you-mean/CHANGELOG.md @@ -1,5 +1,12 @@ # @shopify/plugin-did-you-mean +## 3.67.1 + +### Patch Changes + +- Updated dependencies [926963590] + - @shopify/cli-kit@3.67.1 + ## 3.67.0 ### Patch Changes diff --git a/packages/plugin-did-you-mean/package.json b/packages/plugin-did-you-mean/package.json index 1a89a374d4..03a174ec63 100644 --- a/packages/plugin-did-you-mean/package.json +++ b/packages/plugin-did-you-mean/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/plugin-did-you-mean", - "version": "3.67.0", + "version": "3.67.1", "private": true, "bugs": { "url": "https://github.com/Shopify/cli/issues" @@ -42,7 +42,7 @@ }, "dependencies": { "@oclif/core": "3.26.5", - "@shopify/cli-kit": "3.67.0", + "@shopify/cli-kit": "3.67.1", "n-gram": "2.0.2" }, "devDependencies": { diff --git a/packages/theme/CHANGELOG.md b/packages/theme/CHANGELOG.md index 6b52c7f2be..47e715f9ec 100644 --- a/packages/theme/CHANGELOG.md +++ b/packages/theme/CHANGELOG.md @@ -1,5 +1,14 @@ # @shopify/theme +## 3.67.1 + +### Patch Changes + +- 72859c9cb: Fix Theme Access authentication on `shopify theme dev` and `shopify theme console` commands +- 28de21b0e: Fixes a bug where some users were unable to intialize their app dev command with theme app extensions +- Updated dependencies [926963590] + - @shopify/cli-kit@3.67.1 + ## 3.67.0 ### Minor Changes diff --git a/packages/theme/package.json b/packages/theme/package.json index 54c1ee957a..e65e5886fe 100644 --- a/packages/theme/package.json +++ b/packages/theme/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/theme", - "version": "3.67.0", + "version": "3.67.1", "private": true, "description": "Utilities for building and publishing themes", "homepage": "https://github.com/shopify/cli#readme", @@ -42,7 +42,7 @@ }, "dependencies": { "@oclif/core": "3.26.5", - "@shopify/cli-kit": "3.67.0", + "@shopify/cli-kit": "3.67.1", "@shopify/theme-check-node": "2.9.0", "@shopify/theme-language-server-node": "1.12.1", "chokidar": "3.5.3", diff --git a/packages/ui-extensions-dev-console/CHANGELOG.md b/packages/ui-extensions-dev-console/CHANGELOG.md index 8db0d9b987..73a3129502 100644 --- a/packages/ui-extensions-dev-console/CHANGELOG.md +++ b/packages/ui-extensions-dev-console/CHANGELOG.md @@ -1,5 +1,7 @@ # @shopify/ui-extensions-dev-console-app +## 3.67.1 + ## 3.67.0 ## 3.66.0 diff --git a/packages/ui-extensions-dev-console/package.json b/packages/ui-extensions-dev-console/package.json index a9636fdeac..16223de8f2 100644 --- a/packages/ui-extensions-dev-console/package.json +++ b/packages/ui-extensions-dev-console/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/ui-extensions-dev-console-app", - "version": "3.67.0", + "version": "3.67.1", "private": true, "scripts": { "build": "nx build", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2bd8386ce4..7510388727 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -153,16 +153,16 @@ importers: specifier: 3.26.5 version: 3.26.5 '@shopify/cli-kit': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../cli-kit '@shopify/create-app': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../create-app '@shopify/function-runner': specifier: 4.1.1 version: 4.1.1 '@shopify/plugin-cloudflare': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../plugin-cloudflare '@shopify/polaris': specifier: 12.10.0 @@ -171,7 +171,7 @@ importers: specifier: 8.0.0 version: 8.0.0 '@shopify/theme': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../theme '@shopify/theme-check-node': specifier: 2.9.0 @@ -278,22 +278,22 @@ importers: specifier: 5.1.2 version: 5.1.2 '@shopify/app': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../app '@shopify/cli-hydrogen': specifier: 8.4.4 version: 8.4.4(@graphql-codegen/cli@5.0.2)(react-dom@17.0.2)(react@17.0.2) '@shopify/cli-kit': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../cli-kit '@shopify/plugin-cloudflare': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../plugin-cloudflare '@shopify/plugin-did-you-mean': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../plugin-did-you-mean '@shopify/theme': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../theme '@types/node': specifier: 18.19.3 @@ -546,7 +546,7 @@ importers: specifier: 3.26.5 version: 3.26.5 '@shopify/cli-kit': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../cli-kit '@types/node': specifier: 18.19.3 @@ -670,7 +670,7 @@ importers: specifier: 3.26.5 version: 3.26.5 '@shopify/cli-kit': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../cli-kit devDependencies: '@vitest/coverage-istanbul': @@ -683,7 +683,7 @@ importers: specifier: 3.26.5 version: 3.26.5 '@shopify/cli-kit': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../cli-kit n-gram: specifier: 2.0.2 @@ -699,7 +699,7 @@ importers: specifier: 3.26.5 version: 3.26.5 '@shopify/cli-kit': - specifier: 3.67.0 + specifier: 3.67.1 version: link:../cli-kit '@shopify/theme-check-node': specifier: 2.9.0