From 862bfccf8fddb5d5ce1c4a86f5006b8159b1d5dc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 25 Sep 2024 17:41:57 +0000 Subject: [PATCH] Version Packages --- .changeset/metal-plants-chew.md | 5 ---- .changeset/nervous-coins-admire.md | 5 ---- .../classes/node_abort.AbortController.html | 2 +- .../classes/node_abort.AbortSignal.html | 2 +- .../classes/node_base_command.default.html | 4 +-- ...ode_custom_oclif_loader.ShopifyConfig.html | 4 +-- .../classes/node_error.AbortError.html | 4 +-- .../classes/node_error.AbortSilentError.html | 4 +-- .../cli-kit/classes/node_error.BugError.html | 4 +-- .../classes/node_error.CancelExecution.html | 2 +- .../classes/node_error.ExternalError.html | 4 +-- .../classes/node_error.FatalError.html | 4 +-- .../node_git.GitDirectoryNotCleanError.html | 4 +-- .../node_git.OutsideGitDirectoryError.html | 4 +-- .../node_local_storage.LocalStorage.html | 12 ++++---- ...FindUpAndReadPackageJsonNotFoundError.html | 4 +-- ...kage_manager.PackageJsonNotFoundError.html | 4 +-- ...ge_manager.UnknownPackageManagerError.html | 4 +-- .../classes/node_output.TokenizedString.html | 4 +-- .../node_plugins_tunnel.TunnelError.html | 4 +-- docs/api/cli-kit/classes/node_result.Err.html | 16 +++++------ docs/api/cli-kit/classes/node_result.Ok.html | 16 +++++------ .../classes/node_testing_ui.Stdin.html | 4 +-- ...ode_themes_theme_manager.ThemeManager.html | 4 +-- ...etricReader.InstantaneousMetricReader.html | 4 +-- ...rvice_BaseOtelService.BaseOtelService.html | 6 ++-- ...ultMeterProvider.DefaultMeterProvider.html | 4 +-- ...DefaultOtelService.DefaultOtelService.html | 6 ++-- .../enums/node_error.FatalErrorType.html | 4 +-- .../enums/node_themes_types.Operation.html | 4 +-- ...js_service_types.MetricInstrumentType.html | 4 +-- .../functions/common_array.difference.html | 2 +- ...mmon_array.getArrayContainsDuplicates.html | 2 +- ...mmon_array.getArrayRejectingUndefined.html | 2 +- .../common_array.takeRandomFromArray.html | 2 +- .../cli-kit/functions/common_array.uniq.html | 2 +- .../functions/common_array.uniqBy.html | 2 +- .../functions/common_collection.groupBy.html | 2 +- .../common_collection.partition.html | 2 +- .../functions/common_function.debounce.html | 2 +- .../functions/common_function.memoize.html | 2 +- .../functions/common_lang.isEqual.html | 2 +- .../functions/common_object.compact.html | 2 +- .../functions/common_object.deepCompare.html | 2 +- .../common_object.deepDifference.html | 2 +- .../common_object.deepMergeObjects.html | 2 +- .../functions/common_object.getPathValue.html | 2 +- .../functions/common_object.isEmpty.html | 2 +- .../functions/common_object.mapValues.html | 2 +- .../functions/common_object.pickBy.html | 2 +- .../functions/common_object.setPathValue.html | 2 +- ...y.performActionWithRetryAfterRecovery.html | 2 +- .../functions/common_string.camelize.html | 2 +- .../functions/common_string.capitalize.html | 2 +- .../functions/common_string.constantize.html | 2 +- .../functions/common_string.escapeRegExp.html | 2 +- .../functions/common_string.formatDate.html | 2 +- .../common_string.formatLocalDate.html | 2 +- .../common_string.getRandomName.html | 2 +- .../functions/common_string.hyphenate.html | 2 +- .../functions/common_string.joinWithAnd.html | 2 +- .../common_string.linesToColumns.html | 2 +- ...ommon_string.normalizeDelimitedString.html | 2 +- .../functions/common_string.pascalize.html | 2 +- .../functions/common_string.pluralize.html | 2 +- .../functions/common_string.slugify.html | 2 +- .../functions/common_string.tryParseInt.html | 2 +- .../functions/common_string.underscore.html | 2 +- ...mon_ts_json_narrowing.assertStringMap.html | 2 +- .../functions/common_url.isValidURL.html | 2 +- .../node_analytics.reportAnalyticsEvent.html | 2 +- .../node_api_admin.adminRequest.html | 2 +- .../functions/node_api_admin.adminUrl.html | 2 +- .../functions/node_api_admin.restRequest.html | 2 +- .../node_api_admin.supportedApiVersions.html | 2 +- .../node_api_app_dev.appDevRequest.html | 2 +- ...i_app_management.appManagementRequest.html | 2 +- ...api_app_management.handleDeprecations.html | 2 +- ....businessPlatformOrganizationsRequest.html | 2 +- ...sinessPlatformOrganizationsRequestDoc.html | 2 +- ...ness_platform.businessPlatformRequest.html | 2 +- ...s_platform.businessPlatformRequestDoc.html | 2 +- .../node_api_graphql.graphqlRequest.html | 2 +- .../node_api_graphql.graphqlRequestDoc.html | 2 +- .../node_api_partners.handleDeprecations.html | 2 +- .../node_api_partners.partnersRequest.html | 2 +- .../node_api_partners.partnersRequestDoc.html | 2 +- ...pi_rest_api_throttler.delayAwareRetry.html | 2 +- .../node_api_rest_api_throttler.throttle.html | 2 +- ...ottler.updateApiCallLimitFromResponse.html | 2 +- .../cli-kit/functions/node_archiver.zip.html | 2 +- .../node_base_command.addFromParsedFlags.html | 2 +- .../functions/node_cli.localCliPackage.html | 2 +- .../cli-kit/functions/node_cli.runCLI.html | 2 +- .../functions/node_cli.runCreateCLI.html | 2 +- .../node_cli.useLocalCLIIfDetected.html | 2 +- .../node_context_fqdn.appManagementFqdn.html | 2 +- ...ode_context_fqdn.businessPlatformFqdn.html | 2 +- ...e_context_fqdn.developerDashboardFqdn.html | 2 +- .../node_context_fqdn.identityFqdn.html | 2 +- .../node_context_fqdn.normalizeStoreFqdn.html | 2 +- .../node_context_fqdn.partnersFqdn.html | 2 +- ...node_context_local.alwaysLogAnalytics.html | 2 +- .../node_context_local.alwaysLogMetrics.html | 2 +- .../node_context_local.analyticsDisabled.html | 2 +- .../node_context_local.ciPlatform.html | 2 +- .../node_context_local.cloudEnvironment.html | 2 +- ...t_local.codespacePortForwardingDomain.html | 2 +- .../node_context_local.codespaceURL.html | 2 +- .../node_context_local.firstPartyDev.html | 2 +- .../node_context_local.gitpodURL.html | 2 +- .../functions/node_context_local.hasGit.html | 2 +- .../node_context_local.homeDirectory.html | 2 +- ...node_context_local.isCloudEnvironment.html | 2 +- .../node_context_local.isDevelopment.html | 2 +- .../node_context_local.isShopify.html | 2 +- ...e_context_local.isTerminalInteractive.html | 2 +- .../node_context_local.isUnitTest.html | 2 +- .../node_context_local.isVerbose.html | 2 +- .../node_context_local.macAddress.html | 2 +- ...ode_context_local.opentelemetryDomain.html | 2 +- .../node_context_local.useDeviceAuth.html | 2 +- ...ode_context_local.useEmbeddedThemeCLI.html | 2 +- .../node_context_local.useThemebundling.html | 2 +- .../functions/node_context_spin.appHost.html | 2 +- .../functions/node_context_spin.appPort.html | 2 +- .../node_context_spin.fetchSpinPort.html | 2 +- .../functions/node_context_spin.instance.html | 2 +- .../functions/node_context_spin.isSpin.html | 2 +- .../node_context_spin.isSpinEnvironment.html | 2 +- .../functions/node_context_spin.show.html | 2 +- .../functions/node_context_spin.spinFqdn.html | 2 +- .../node_context_utilities.isTruthy.html | 2 +- .../node_crypto.base64URLEncode.html | 2 +- .../functions/node_crypto.fileHash.html | 2 +- .../functions/node_crypto.hashString.html | 2 +- .../functions/node_crypto.nonRandomUUID.html | 2 +- .../functions/node_crypto.randomBytes.html | 2 +- .../functions/node_crypto.randomHex.html | 2 +- .../functions/node_crypto.randomUUID.html | 2 +- .../cli-kit/functions/node_crypto.sha256.html | 2 +- .../node_dot_env.createDotEnvFileLine.html | 2 +- .../functions/node_dot_env.patchEnvFile.html | 2 +- .../node_dot_env.readAndParseDotEnv.html | 2 +- .../functions/node_dot_env.writeDotEnv.html | 2 +- .../node_environment.getBackendPort.html | 2 +- ...e_environment.getEnvironmentVariables.html | 2 +- ...vironment.getIdentityTokenInformation.html | 2 +- .../node_environment.getOrganization.html | 2 +- .../node_environment.getPartnersToken.html | 2 +- .../node_environment.usePartnersToken.html | 2 +- .../node_environments.loadEnvironment.html | 2 +- .../node_error.cleanSingleStackTracePath.html | 2 +- .../functions/node_error.errorMapper.html | 2 +- .../cli-kit/functions/node_error.handler.html | 2 +- .../node_error.shouldReportError.html | 2 +- ...node_error_handler.addBugsnagMetadata.html | 2 +- ...error_handler.cleanStackFrameFilePath.html | 2 +- .../node_error_handler.errorHandler.html | 2 +- ...erCleanBugsnagErrorsFromWithinPlugins.html | 2 +- ...node_error_handler.sendErrorToBugsnag.html | 2 +- .../node_framework.resolveFramework.html | 2 +- .../cli-kit/functions/node_fs.appendFile.html | 2 +- .../functions/node_fs.appendFileSync.html | 2 +- docs/api/cli-kit/functions/node_fs.chmod.html | 2 +- .../cli-kit/functions/node_fs.copyFile.html | 2 +- .../node_fs.createFileReadStream.html | 2 +- .../node_fs.createFileWriteStream.html | 2 +- .../cli-kit/functions/node_fs.fileExists.html | 2 +- .../functions/node_fs.fileExistsSync.html | 2 +- .../node_fs.fileHasExecutablePermissions.html | 2 +- .../functions/node_fs.fileLastUpdated.html | 2 +- .../node_fs.fileLastUpdatedTimestamp.html | 2 +- .../functions/node_fs.fileRealPath.html | 2 +- .../cli-kit/functions/node_fs.fileSize.html | 2 +- .../functions/node_fs.fileSizeSync.html | 2 +- .../cli-kit/functions/node_fs.findPathUp.html | 2 +- ..._fs.generateRandomNameForSubdirectory.html | 2 +- docs/api/cli-kit/functions/node_fs.glob.html | 2 +- .../node_fs.inTemporaryDirectory.html | 2 +- .../functions/node_fs.isDirectory.html | 2 +- .../cli-kit/functions/node_fs.matchGlob.html | 2 +- .../cli-kit/functions/node_fs.mkTmpDir.html | 2 +- docs/api/cli-kit/functions/node_fs.mkdir.html | 2 +- .../cli-kit/functions/node_fs.mkdirSync.html | 2 +- .../cli-kit/functions/node_fs.moveFile.html | 2 +- .../functions/node_fs.pathToFileURL.html | 2 +- .../cli-kit/functions/node_fs.readFile.html | 4 +-- .../functions/node_fs.readFileSync.html | 2 +- .../cli-kit/functions/node_fs.removeFile.html | 2 +- .../functions/node_fs.removeFileSync.html | 2 +- .../cli-kit/functions/node_fs.renameFile.html | 2 +- docs/api/cli-kit/functions/node_fs.rmdir.html | 2 +- .../functions/node_fs.stripUpPath.html | 2 +- .../functions/node_fs.tempDirectory.html | 2 +- .../cli-kit/functions/node_fs.touchFile.html | 2 +- .../functions/node_fs.touchFileSync.html | 2 +- .../functions/node_fs.unlinkFileSync.html | 2 +- .../cli-kit/functions/node_fs.writeFile.html | 2 +- .../functions/node_fs.writeFileSync.html | 2 +- .../node_git.addAllToGitFromDirectory.html | 2 +- ...ode_git.checkIfIgnoredInGitRepository.html | 2 +- .../functions/node_git.createGitCommit.html | 2 +- .../functions/node_git.createGitIgnore.html | 2 +- .../node_git.downloadGitRepository.html | 2 +- .../node_git.ensureGitIsPresentOrAbort.html | 2 +- .../node_git.ensureInsideGitDirectory.html | 2 +- .../functions/node_git.ensureIsClean.html | 2 +- .../node_git.getHeadSymbolicRef.html | 2 +- .../node_git.getLatestGitCommit.html | 2 +- .../node_git.initializeGitRepository.html | 2 +- .../cli-kit/functions/node_git.isClean.html | 2 +- .../node_github.getLatestGitHubRelease.html | 2 +- ...github.parseGitHubRepositoryReference.html | 2 +- .../node_github.parseGitHubRepositoryURL.html | 2 +- .../node_hooks_deprecations.postrun.html | 2 +- .../functions/node_hooks_postrun.hook.html | 2 +- .../functions/node_hooks_prerun.hook.html | 2 +- ...node_hooks_prerun.parseCommandContent.html | 2 +- ...e_hooks_prerun.warnOnAvailableUpgrade.html | 2 +- .../functions/node_hrtime.endHRTimeInMs.html | 2 +- .../functions/node_hrtime.startHRTime.html | 2 +- .../functions/node_http.downloadFile.html | 2 +- .../cli-kit/functions/node_http.fetch.html | 2 +- .../cli-kit/functions/node_http.formData.html | 2 +- .../functions/node_http.shopifyFetch.html | 2 +- ...node_is_global.currentProcessIsGlobal.html | 2 +- ...lobal.inferPackageManagerForGlobalCLI.html | 2 +- ...node_is_global.installGlobalCLIPrompt.html | 2 +- ...ode_is_global.installGlobalShopifyCLI.html | 2 +- .../node_is_global.isGlobalCLIInstalled.html | 2 +- .../node_json_schema.jsonSchemaValidate.html | 2 +- .../node_json_schema.normaliseJsonSchema.html | 2 +- ...de_liquid.recursiveLiquidTemplateCopy.html | 2 +- .../node_liquid.renderLiquidTemplate.html | 2 +- .../functions/node_logs.createLogsDir.html | 2 +- .../functions/node_logs.getLogsDir.html | 2 +- .../cli-kit/functions/node_logs.writeLog.html | 2 +- .../node_metadata.addPublicMetadata.html | 2 +- .../node_metadata.addSensitiveMetadata.html | 2 +- ...tadata.createRuntimeMetadataContainer.html | 2 +- .../node_metadata.getAllPublicMetadata.html | 2 +- ...node_metadata.getAllSensitiveMetadata.html | 2 +- .../functions/node_metadata.runWithTimer.html | 2 +- .../functions/node_mimes.lookupMimeType.html | 2 +- .../functions/node_mimes.setMimeTypes.html | 2 +- .../node_monorail.publishMonorailEvent.html | 2 +- ...de_package_manager.addNPMDependencies.html | 2 +- ...ge_manager.addNPMDependenciesIfNeeded.html | 2 +- ...NPMDependenciesWithoutVersionIfNeeded.html | 2 +- ...ckage_manager.addResolutionOrOverride.html | 2 +- ...kage_manager.checkForCachedNewVersion.html | 2 +- ...de_package_manager.checkForNewVersion.html | 2 +- ...kage_manager.findUpAndReadPackageJson.html | 2 +- ..._node_package_manager.getDependencies.html | 2 +- ...ode_package_manager.getPackageManager.html | 2 +- ...e_node_package_manager.getPackageName.html | 2 +- ...ode_package_manager.getPackageVersion.html | 2 +- ...ger.installNPMDependenciesRecursively.html | 2 +- ...de_package_manager.installNodeModules.html | 2 +- ...e_manager.packageManagerFromUserAgent.html | 2 +- ...ckage_manager.readAndParsePackageJson.html | 2 +- ...e_node_package_manager.usesWorkspaces.html | 2 +- ...node_package_manager.versionSatisfies.html | 2 +- ...node_package_manager.writePackageJSON.html | 2 +- .../functions/node_os.platformAndArch.html | 2 +- .../cli-kit/functions/node_os.username.html | 2 +- .../node_output.clearCollectedLogs.html | 2 +- .../functions/node_output.collectLog.html | 2 +- .../functions/node_output.consoleError.html | 2 +- .../functions/node_output.consoleLog.html | 2 +- .../functions/node_output.consoleWarn.html | 2 +- ...de_output.formatPackageManagerCommand.html | 2 +- .../functions/node_output.formatSection.html | 2 +- .../functions/node_output.itemToString.html | 2 +- .../node_output.outputCompleted.html | 2 +- .../functions/node_output.outputContent.html | 2 +- .../functions/node_output.outputDebug.html | 2 +- .../functions/node_output.outputInfo.html | 2 +- .../functions/node_output.outputNewline.html | 2 +- .../functions/node_output.outputSuccess.html | 2 +- .../functions/node_output.outputWarn.html | 2 +- .../node_output.outputWhereAppropriate.html | 2 +- .../node_output.shouldDisplayColors.html | 2 +- .../node_output.stringifyMessage.html | 2 +- .../functions/node_output.unstyled.html | 2 +- .../cli-kit/functions/node_path.basename.html | 2 +- docs/api/cli-kit/functions/node_path.cwd.html | 2 +- .../cli-kit/functions/node_path.dirname.html | 2 +- .../cli-kit/functions/node_path.extname.html | 2 +- .../functions/node_path.isAbsolutePath.html | 2 +- .../functions/node_path.isSubpath.html | 2 +- .../cli-kit/functions/node_path.joinPath.html | 2 +- .../functions/node_path.moduleDirectory.html | 2 +- .../functions/node_path.normalizePath.html | 2 +- .../functions/node_path.relativePath.html | 2 +- .../functions/node_path.relativizePath.html | 2 +- .../functions/node_path.resolvePath.html | 2 +- .../functions/node_path.sniffForJson.html | 2 +- .../functions/node_path.sniffForPath.html | 2 +- .../functions/node_plugins.fanoutHooks.html | 2 +- .../node_plugins.getListOfTunnelPlugins.html | 2 +- .../node_plugins_tunnel.defineProvider.html | 2 +- .../node_plugins_tunnel.startTunnel.html | 2 +- .../node_promises.flushPromises.html | 2 +- .../cli-kit/functions/node_result.err-1.html | 2 +- .../cli-kit/functions/node_result.ok-1.html | 2 +- .../functions/node_ruby.bundleUserHome.html | 2 +- .../cli-kit/functions/node_ruby.execCLI2.html | 2 +- .../cli-kit/functions/node_ruby.version.html | 2 +- .../functions/node_schema.deepStrict.html | 2 +- .../functions/node_schema.errorsToString.html | 2 +- ...node_session.ensureAuthenticatedAdmin.html | 2 +- ...sion.ensureAuthenticatedAppManagement.html | 2 +- ...n.ensureAuthenticatedBusinessPlatform.html | 2 +- ...e_session.ensureAuthenticatedPartners.html | 2 +- ...session.ensureAuthenticatedStorefront.html | 2 +- ...ode_session.ensureAuthenticatedThemes.html | 2 +- .../functions/node_session.logout.html | 2 +- .../functions/node_system.captureOutput.html | 2 +- .../cli-kit/functions/node_system.exec.html | 2 +- .../functions/node_system.openURL.html | 2 +- .../cli-kit/functions/node_system.sleep.html | 2 +- ...node_system.terminalSupportsPrompting.html | 2 +- .../node_tcp.checkPortAvailability.html | 2 +- .../node_tcp.getAvailableTCPPort.html | 2 +- ...e_testing_output.mockAndCaptureOutput.html | 2 +- ...e_testing_ui.getLastFrameAfterUnmount.html | 2 +- .../functions/node_testing_ui.render.html | 2 +- .../node_testing_ui.sendInputAndWait.html | 2 +- ..._testing_ui.sendInputAndWaitForChange.html | 2 +- ...testing_ui.sendInputAndWaitForContent.html | 2 +- .../node_testing_ui.waitForContent.html | 2 +- ...ode_testing_ui.waitForInputsToBeReady.html | 2 +- ...node_themes_api.bulkUploadThemeAssets.html | 2 +- .../node_themes_api.createTheme.html | 2 +- .../node_themes_api.deleteTheme.html | 2 +- .../node_themes_api.deleteThemeAsset.html | 2 +- .../node_themes_api.fetchChecksums.html | 2 +- .../functions/node_themes_api.fetchTheme.html | 2 +- .../node_themes_api.fetchThemeAsset.html | 2 +- .../node_themes_api.fetchThemes.html | 2 +- .../node_themes_api.publishTheme.html | 2 +- .../node_themes_api.updateTheme.html | 2 +- .../node_themes_api.upgradeTheme.html | 2 +- .../node_themes_conf.getHostTheme.html | 2 +- ...ode_themes_conf.hostThemeLocalStorage.html | 2 +- .../node_themes_conf.removeHostTheme.html | 2 +- .../node_themes_conf.setHostTheme.html | 2 +- ...emes_factories.buildBulkUploadResults.html | 2 +- .../node_themes_factories.buildChecksum.html | 2 +- .../node_themes_factories.buildTheme.html | 2 +- ...node_themes_factories.buildThemeAsset.html | 2 +- .../node_themes_urls.codeEditorUrl.html | 2 +- .../node_themes_urls.storeAdminUrl.html | 2 +- .../node_themes_urls.themeEditorUrl.html | 2 +- .../node_themes_urls.themePreviewUrl.html | 2 +- .../node_themes_utils.isDevelopmentTheme.html | 2 +- .../node_themes_utils.promptThemeName.html | 2 +- .../functions/node_toml.decodeToml.html | 2 +- .../functions/node_toml.encodeToml.html | 2 +- .../functions/node_tree_kill.treeKill.html | 2 +- .../functions/node_ui.handleCtrlC.html | 2 +- docs/api/cli-kit/functions/node_ui.isTTY.html | 2 +- .../cli-kit/functions/node_ui.keypress.html | 2 +- .../api/cli-kit/functions/node_ui.render.html | 2 +- .../node_ui.renderAutocompletePrompt.html | 2 +- .../functions/node_ui.renderConcurrent.html | 2 +- .../node_ui.renderConfirmationPrompt.html | 2 +- ..._ui.renderDangerousConfirmationPrompt.html | 2 +- .../functions/node_ui.renderError.html | 2 +- .../functions/node_ui.renderFatalError.html | 2 +- .../cli-kit/functions/node_ui.renderInfo.html | 2 +- .../functions/node_ui.renderSelectPrompt.html | 2 +- .../functions/node_ui.renderSuccess.html | 2 +- .../functions/node_ui.renderTable.html | 2 +- .../functions/node_ui.renderTasks.html | 2 +- .../cli-kit/functions/node_ui.renderText.html | 2 +- .../functions/node_ui.renderTextPrompt.html | 2 +- .../functions/node_ui.renderWarning.html | 2 +- .../node_ui_components.ConcurrentOutput.html | 2 +- ...components.useConcurrentOutputContext.html | 2 +- .../node_ui_hooks.useAbortSignal.html | 2 +- .../node_upgrade.cliInstallCommand.html | 2 +- ...de_upgrade.getOutputUpdateCLIReminder.html | 2 +- ...endor_otel_js_utils_throttle.throttle.html | 2 +- ...js_utils_validators.isValidMetricName.html | 2 +- .../node_vscode.addRecommendedExtensions.html | 2 +- .../functions/node_vscode.isVSCode.html | 2 +- .../node_api_admin.RestResponse.html | 8 +++--- ...de_api_graphql.GraphQLResponseOptions.html | 4 +-- .../node_api_graphql.GraphQLVariables.html | 2 +- .../interfaces/node_dot_env.DotEnvFile.html | 6 ++-- .../node_environments.Environments.html | 2 +- .../interfaces/node_fs.MatchGlobOptions.html | 4 +-- .../interfaces/node_fs.WriteOptions.html | 4 +-- .../node_git.CreateGitCommitOptions.html | 4 +-- .../interfaces/node_git.GitCloneOptions.html | 4 +-- .../node_git.GitIgnoreTemplate.html | 2 +- .../interfaces/node_github.GithubRelease.html | 4 +-- ...node_github.GithubRepositoryReference.html | 4 +-- .../node_hooks_prerun.CommandContent.html | 4 +-- ...s_global.InstallGlobalCLIPromptResult.html | 4 +-- .../node_metadata.RuntimeMetadataManager.html | 12 ++++---- .../interfaces/node_monorail.Schemas.html | 4 +-- ...ode_package_manager.DependencyVersion.html | 6 ++-- ...node_node_package_manager.PackageJson.html | 28 +++++++++---------- .../interfaces/node_output.OutputProcess.html | 6 ++-- .../node_plugins.HookReturnsPerPlugin.html | 4 +-- .../node_plugins.TunnelPluginError.html | 4 +-- ...gins_tunnel.HookReturnPerTunnelPlugin.html | 4 +-- .../node_plugins_tunnel.TunnelClient.html | 4 +-- .../interfaces/node_session.AdminSession.html | 4 +-- .../interfaces/node_system.ExecOptions.html | 4 +-- ...es_factories.RemoteBulkUploadResponse.html | 4 +-- .../node_themes_types.Checksum.html | 6 ++-- .../interfaces/node_themes_types.Result.html | 12 ++++---- .../interfaces/node_themes_types.Theme.html | 14 +++++----- .../node_themes_types.ThemeAsset.html | 12 ++++---- ...themes_types.ThemeExtensionFileSystem.html | 20 ++++++------- .../node_themes_types.ThemeFileSystem.html | 22 +++++++-------- ...e_themes_types.ThemeFileSystemOptions.html | 4 +-- .../node_themes_types.VirtualFileSystem.html | 18 ++++++------ .../interfaces/node_ui.InfoTableSection.html | 4 +-- .../cli-kit/interfaces/node_ui.LinkToken.html | 4 +-- .../cli-kit/interfaces/node_ui.ListToken.html | 4 +-- .../node_ui.RenderAutocompleteOptions.html | 4 +-- .../node_ui.RenderConcurrentOptions.html | 4 +-- ...de_ui.RenderConfirmationPromptOptions.html | 4 +-- ...derDangerousConfirmationPromptOptions.html | 4 +-- .../node_ui.RenderSelectPromptOptions.html | 4 +-- .../node_ui.RenderTextPromptOptions.html | 4 +-- docs/api/cli-kit/interfaces/node_ui.Task.html | 4 +-- ...ui_components.ConcurrentOutputContext.html | 4 +-- ...ader.InstantaneousMetricReaderOptions.html | 6 ++-- ...aseOtelService.BaseOtelServiceOptions.html | 12 ++++---- ...OtelService.DefaultOtelServiceOptions.html | 18 ++++++------ ...r_otel_js_service_types.MetricsConfig.html | 2 +- ...dor_otel_js_service_types.OtelService.html | 6 ++-- docs/api/cli-kit/modules/common_array.html | 2 +- .../cli-kit/modules/common_collection.html | 2 +- docs/api/cli-kit/modules/common_function.html | 2 +- docs/api/cli-kit/modules/common_lang.html | 2 +- docs/api/cli-kit/modules/common_object.html | 2 +- docs/api/cli-kit/modules/common_retry.html | 2 +- docs/api/cli-kit/modules/common_string.html | 2 +- .../modules/common_ts_deep_required.html | 2 +- .../modules/common_ts_json_narrowing.html | 2 +- .../modules/common_ts_pick_by_prefix.html | 2 +- docs/api/cli-kit/modules/common_url.html | 2 +- docs/api/cli-kit/modules/common_version.html | 2 +- docs/api/cli-kit/modules/node_abort.html | 2 +- docs/api/cli-kit/modules/node_analytics.html | 2 +- docs/api/cli-kit/modules/node_api_admin.html | 2 +- .../api/cli-kit/modules/node_api_app_dev.html | 2 +- .../modules/node_api_app_management.html | 2 +- .../modules/node_api_business_platform.html | 2 +- .../api/cli-kit/modules/node_api_graphql.html | 2 +- docs/api/cli-kit/modules/node_api_http.html | 2 +- .../cli-kit/modules/node_api_partners.html | 2 +- .../modules/node_api_rest_api_throttler.html | 2 +- docs/api/cli-kit/modules/node_archiver.html | 2 +- .../cli-kit/modules/node_base_command.html | 2 +- docs/api/cli-kit/modules/node_cli.html | 2 +- docs/api/cli-kit/modules/node_colors.html | 2 +- .../cli-kit/modules/node_context_fqdn.html | 2 +- .../cli-kit/modules/node_context_local.html | 2 +- .../cli-kit/modules/node_context_spin.html | 2 +- .../modules/node_context_utilities.html | 2 +- docs/api/cli-kit/modules/node_crypto.html | 2 +- .../modules/node_custom_oclif_loader.html | 2 +- docs/api/cli-kit/modules/node_dot_env.html | 2 +- .../api/cli-kit/modules/node_environment.html | 2 +- .../cli-kit/modules/node_environments.html | 2 +- docs/api/cli-kit/modules/node_error.html | 2 +- .../cli-kit/modules/node_error_handler.html | 2 +- docs/api/cli-kit/modules/node_figures.html | 2 +- docs/api/cli-kit/modules/node_framework.html | 2 +- docs/api/cli-kit/modules/node_fs.html | 2 +- docs/api/cli-kit/modules/node_git.html | 2 +- docs/api/cli-kit/modules/node_github.html | 2 +- .../modules/node_hooks_deprecations.html | 2 +- .../cli-kit/modules/node_hooks_postrun.html | 2 +- .../cli-kit/modules/node_hooks_prerun.html | 2 +- docs/api/cli-kit/modules/node_hrtime.html | 2 +- docs/api/cli-kit/modules/node_http.html | 2 +- docs/api/cli-kit/modules/node_ink.html | 2 +- docs/api/cli-kit/modules/node_is_global.html | 2 +- .../api/cli-kit/modules/node_json_schema.html | 2 +- docs/api/cli-kit/modules/node_liquid.html | 2 +- .../cli-kit/modules/node_local_storage.html | 2 +- docs/api/cli-kit/modules/node_logs.html | 2 +- docs/api/cli-kit/modules/node_metadata.html | 2 +- docs/api/cli-kit/modules/node_mimes.html | 2 +- docs/api/cli-kit/modules/node_monorail.html | 2 +- .../modules/node_node_package_manager.html | 2 +- docs/api/cli-kit/modules/node_os.html | 2 +- docs/api/cli-kit/modules/node_output.html | 2 +- docs/api/cli-kit/modules/node_path.html | 2 +- docs/api/cli-kit/modules/node_plugins.html | 2 +- .../cli-kit/modules/node_plugins_tunnel.html | 2 +- docs/api/cli-kit/modules/node_promises.html | 2 +- docs/api/cli-kit/modules/node_result.html | 2 +- docs/api/cli-kit/modules/node_ruby.html | 2 +- docs/api/cli-kit/modules/node_schema.html | 2 +- docs/api/cli-kit/modules/node_session.html | 2 +- docs/api/cli-kit/modules/node_system.html | 2 +- docs/api/cli-kit/modules/node_tcp.html | 2 +- .../cli-kit/modules/node_testing_output.html | 2 +- docs/api/cli-kit/modules/node_testing_ui.html | 2 +- docs/api/cli-kit/modules/node_themes_api.html | 2 +- .../api/cli-kit/modules/node_themes_conf.html | 2 +- .../modules/node_themes_factories.html | 2 +- .../modules/node_themes_theme_manager.html | 2 +- .../cli-kit/modules/node_themes_types.html | 2 +- .../api/cli-kit/modules/node_themes_urls.html | 2 +- .../cli-kit/modules/node_themes_utils.html | 2 +- docs/api/cli-kit/modules/node_toml.html | 2 +- docs/api/cli-kit/modules/node_tree_kill.html | 2 +- docs/api/cli-kit/modules/node_ui.html | 2 +- .../cli-kit/modules/node_ui_components.html | 2 +- docs/api/cli-kit/modules/node_ui_hooks.html | 2 +- docs/api/cli-kit/modules/node_upgrade.html | 2 +- ...l_js_export_InstantaneousMetricReader.html | 2 +- ...rvice_BaseOtelService_BaseOtelService.html | 2 +- ...faultOtelService_DefaultMeterProvider.html | 2 +- ...DefaultOtelService_DefaultOtelService.html | 2 +- .../node_vendor_otel_js_service_types.html | 2 +- .../node_vendor_otel_js_utils_throttle.html | 2 +- .../node_vendor_otel_js_utils_validators.html | 2 +- docs/api/cli-kit/modules/node_vscode.html | 2 +- .../types/common_string.RandomNameFamily.html | 2 +- .../common_ts_deep_required.DeepRequired.html | 2 +- ...common_ts_pick_by_prefix.PickByPrefix.html | 2 +- .../types/node_analytics.CommandExitMode.html | 2 +- .../cli-kit/types/node_api_graphql.Exact.html | 2 +- ..._api_graphql.GraphQLRequestDocOptions.html | 2 +- ...ode_api_graphql.GraphQLRequestOptions.html | 2 +- .../node_api_graphql.GraphQLResponse.html | 2 +- .../types/node_context_local.CIMetadata.html | 2 +- .../cli-kit/types/node_fs.ReadOptions.html | 2 +- .../cli-kit/types/node_hrtime.StartTime.html | 2 +- .../cli-kit/types/node_metadata.Public.html | 2 +- .../types/node_metadata.PublicSchema.html | 2 +- .../types/node_metadata.Sensitive.html | 2 +- .../types/node_metadata.SensitiveSchema.html | 2 +- .../node_monorail.MonorailEventPublic.html | 2 +- .../node_monorail.MonorailEventSensitive.html | 2 +- ...e_node_package_manager.DependencyType.html | 2 +- .../node_node_package_manager.Lockfile.html | 2 +- ...e_node_package_manager.PackageManager.html | 2 +- .../cli-kit/types/node_output.LogLevel.html | 2 +- .../api/cli-kit/types/node_output.Logger.html | 2 +- .../types/node_output.OutputMessage.html | 2 +- .../node_plugins.FanoutHookFunction.html | 2 +- .../node_plugins.PluginReturnsForHook.html | 2 +- .../node_plugins_tunnel.TunnelErrorType.html | 2 +- ...plugins_tunnel.TunnelProviderFunction.html | 2 +- ...node_plugins_tunnel.TunnelStartAction.html | 2 +- ...de_plugins_tunnel.TunnelStartFunction.html | 2 +- ...node_plugins_tunnel.TunnelStartReturn.html | 2 +- .../node_plugins_tunnel.TunnelStatusType.html | 2 +- .../api/cli-kit/types/node_result.Result.html | 2 +- .../node_schema.ParseConfigurationResult.html | 2 +- .../types/node_schema.ZodObjectOf.html | 2 +- .../types/node_themes_api.AssetParams.html | 2 +- .../types/node_themes_api.ThemeParams.html | 2 +- .../cli-kit/types/node_themes_types.Key.html | 2 +- .../node_themes_types.ThemeFSEventName.html | 2 +- ...node_themes_types.ThemeFSEventPayload.html | 2 +- .../cli-kit/types/node_themes_utils.Role.html | 2 +- .../cli-kit/types/node_toml.JsonMapType.html | 2 +- .../types/node_ui.AlertCustomSection.html | 2 +- .../cli-kit/types/node_ui.InfoMessage.html | 2 +- .../cli-kit/types/node_ui.InlineToken.html | 2 +- docs/api/cli-kit/types/node_ui.Key.html | 2 +- .../types/node_ui.RenderAlertOptions.html | 2 +- .../cli-kit/types/node_ui.TableColumn.html | 2 +- docs/api/cli-kit/types/node_ui.Token.html | 2 +- docs/api/cli-kit/types/node_ui.TokenItem.html | 2 +- ...vice_DefaultMeterProvider.Environment.html | 2 +- ...l_js_service_types.CustomMetricLabels.html | 2 +- ...tel_js_service_types.MetricDescriptor.html | 2 +- ...tel_js_service_types.MetricInstrument.html | 2 +- ...otel_js_service_types.MetricRecording.html | 2 +- ...tel_js_service_types.OnRecordCallback.html | 2 +- ...js_service_types.RecordMetricFunction.html | 2 +- .../common_version.CLI_KIT_VERSION.html | 2 +- .../variables/node_cli.globalFlags.html | 2 +- ...dn.CouldntObtainIdentitySpinFQDNError.html | 2 +- ...dn.CouldntObtainPartnersSpinFQDNError.html | 2 +- ...qdn.CouldntObtainShopifySpinFQDNError.html | 2 +- ...ontext_fqdn.NotProvidedStoreFQDNError.html | 2 +- .../node_context_spin.spinVariables.html | 2 +- .../node_monorail.MONORAIL_COMMAND_TOPIC.html | 2 +- ...node_node_package_manager.bunLockfile.html | 2 +- .../node_node_package_manager.lockfiles.html | 2 +- ...node_node_package_manager.npmLockfile.html | 2 +- ...node_package_manager.packageManager-1.html | 2 +- ...ode_node_package_manager.pnpmLockfile.html | 2 +- ...ode_package_manager.pnpmWorkspaceFile.html | 2 +- ...ode_node_package_manager.yarnLockfile.html | 2 +- .../variables/node_output.collectedLogs.html | 2 +- .../variables/node_output.outputToken.html | 2 +- .../node_ruby.MinWdmWindowsVersion.html | 2 +- .../variables/node_ruby.RubyCLIVersion.html | 2 +- ...e_themes_utils.DEVELOPMENT_THEME_ROLE.html | 2 +- .../node_themes_utils.LIVE_THEME_ROLE.html | 2 +- ...e_themes_utils.UNPUBLISHED_THEME_ROLE.html | 2 +- packages/app/CHANGELOG.md | 11 ++++++++ packages/app/package.json | 10 +++---- packages/cli-kit/CHANGELOG.md | 6 ++++ packages/cli-kit/package.json | 2 +- packages/cli-kit/src/public/common/version.ts | 2 +- packages/cli/CHANGELOG.md | 2 ++ packages/cli/oclif.manifest.json | 2 +- packages/cli/package.json | 12 ++++---- packages/create-app/CHANGELOG.md | 2 ++ packages/create-app/oclif.manifest.json | 2 +- packages/create-app/package.json | 4 +-- packages/plugin-cloudflare/CHANGELOG.md | 7 +++++ packages/plugin-cloudflare/package.json | 4 +-- packages/plugin-did-you-mean/CHANGELOG.md | 7 +++++ packages/plugin-did-you-mean/package.json | 4 +-- packages/theme/CHANGELOG.md | 7 +++++ packages/theme/package.json | 4 +-- .../ui-extensions-dev-console/CHANGELOG.md | 2 ++ .../ui-extensions-dev-console/package.json | 2 +- pnpm-lock.yaml | 26 ++++++++--------- 629 files changed, 851 insertions(+), 817 deletions(-) delete mode 100644 .changeset/metal-plants-chew.md delete mode 100644 .changeset/nervous-coins-admire.md diff --git a/.changeset/metal-plants-chew.md b/.changeset/metal-plants-chew.md deleted file mode 100644 index 927bdeded17..00000000000 --- a/.changeset/metal-plants-chew.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/app': patch ---- - -Remove duplicated slashes when deploying privacy compliance webhooks with relative URIs diff --git a/.changeset/nervous-coins-admire.md b/.changeset/nervous-coins-admire.md deleted file mode 100644 index 23a3e814dc5..00000000000 --- a/.changeset/nervous-coins-admire.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/cli-kit': patch ---- - -Avoid outputContent errors with undefined variables diff --git a/docs/api/cli-kit/classes/node_abort.AbortController.html b/docs/api/cli-kit/classes/node_abort.AbortController.html index e4de6ffb9a7..b286b63afcc 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 d12887054c3..b03812c5516 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 6de82e1e355..73e9b279a32 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 f201fe631a3..76d7cb9b6e5 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 0955e1eee68..0dea96dd339 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 989373e23b2..44b82e70599 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 cf6b735736f..f2ff0483266 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 69e8670323f..3ae3f8f98fc 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 d81403e53cf..7de40bbf330 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 7c4cfedb401..4ad84432744 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 6c78898f9c2..b872a4eff2c 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 2444d21b24e..512a78c7989 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 e1869da5eb2..61de5c2f5c7 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 cddc0291b4d..6e5e2665205 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 503638f7528..62b78629541 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 25c99ec6b6e..a3be3d0df1a 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 459e44e28bb..16e4f01dc6b 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 8c6e47affed..70232329a42 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 5ef6948df42..9aeb07b2025 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 32b37cc7020..0017ec93494 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 27e30fe26e3..63d1a90a075 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 b7954f7b2ad..e98c6ebc50f 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 41716e2d8ae..2621fae9df2 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 23804a72de1..ea4433f275c 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 6177d98f2ef..a42493e2e7f 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 4cf725ff59f..2d1f8c3d361 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 d24e51adc28..f5645fdd23b 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 a8bc890ee12..6a63b20693f 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 01682d8b8c6..85dd599d09a 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 f1b7a4ad609..ba801275f8e 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 82ff30590b0..2a273dacda5 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 b2ff9a74e8c..e9c700e4fd7 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 6bb5c8ce3a6..6ebaa1511bc 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 0d6eba73aab..06fd0be4bba 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 ec5b8f48221..371a8023bbc 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 a8948d674c1..93f380e3e3d 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 ebc6840fb49..80728c2660c 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 765d3f7c953..4af135b66be 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 f219f2d733d..f37ccbbf707 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 f5cf66253b4..97b3140e6f2 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 93d650483ea..263f9d150cb 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 5c356f8fb25..f5180615894 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 6e5e9d6176f..d5501bc4d58 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 fad4adb8189..738eb4c052f 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 8a8aaff6401..2a6c1097a30 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 016d5620c76..0274fea5d89 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 74651f4cf21..6ad4a339c68 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 89c1922bd80..f768482cdb8 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 ca900925511..6b820930852 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 c641969d154..5254f8ae6f7 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 cc6d5dd75ac..b7168bf023b 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 82dbdf192c4..f41b1dc80a0 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 0a5ef6df6e7..f718777cac5 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 11e074dd33a..f7ed8e7199b 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 dd832d8fb83..08e0ffe90c3 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 2666442d8e9..ae44b978b4a 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 35f7514f58d..942ea03dbcf 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 4e08a9db4b0..a3c58aaa8de 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 c87490848db..1c6aa0d6a7c 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 bb8cfd65c39..8b78c411c03 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 1d1c2b5eea3..848317afd3c 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 eeca460c8c0..2f25e5171c7 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 97f9847d6d7..993e4ea76e2 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 c7ae93bd7b2..7f8e3d265e9 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 342dbc73108..ba8e1bb3043 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 3c1f6df31c0..c2887e824ef 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 2a647e5271e..d7d6e83a153 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 692456b620c..2af2546c009 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 b372d27bab0..e3c58ca5762 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 a2dde05ecc9..1f6cfb3b7a6 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 455c636ea4e..57f072fb54b 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 e4552f8d70d..840f696346f 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 10644a478c7..ca7071891e8 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 18b2963ca82..86aee308d28 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 cedc39d7b84..28b0d7c3969 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 16e8feb45e9..174af826a66 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 9869c3d4bfe..9ed4626dfa3 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 317f5b09770..603e3abacad 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 e3860c47500..e5b51ef922d 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 56da03d38b1..e4369a84d95 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 0e086e53c76..9fe5f49c32e 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 ba3c985c2b2..9236d86f52a 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 a824ef4a6d1..433c35ff574 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 aeb1963a0ca..c88a908e0d6 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 bad5051e4f2..c893f159c34 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 14024fde58c..2ca5916f3d8 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 246fb835eb7..8c8a08ce010 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 dfae2e33c0c..a8d0044631f 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 d5cfb251d5f..0896509e8be 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 3f79f3e9114..85e938924cd 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 a829a50bdb9..84ba13940e1 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 7874cf3cc39..b4691132050 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 845622f43c7..9b85b943f24 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 c27385a0247..cfd72601e99 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 92a0e6ea5cf..7d76937b72d 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 0f5356c31db..63278ba96c3 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 26b77642f19..0d7c32cc843 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 6f2ba515e29..1b5a38f04a0 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 311babd4210..bffb907ac27 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 197265551cf..027781bc430 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 2e5b594aaf0..41ea72f54c4 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 e724e905621..ac99708e4a0 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 9aca9419ddd..ba3588f5187 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 3ca5ad21044..d1b27da8345 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 4b56f2b60ab..25cdb95575b 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 855beef7e72..0f2b3052fb2 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 30418cc2afd..525b289cf19 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 16d6f5f2383..55dd65003ed 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 1516b931492..28b3ff95797 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 532cc5a1b7c..db324f38173 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 8211b038422..80cd3be0a05 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 f2c6bc6864b..1dd2e15c50f 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 59fc88ef91b..25a398cc3cb 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 5bf9267c8aa..199ad2a3e3b 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 27d19fffb4d..82d0a692f27 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 0a047f38355..9453d5e879f 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 5672e0b7001..28d2bca93d7 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 8d80aef7a74..dd2cf57b935 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 644a6f7051a..98ace730c9b 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 1f8a2451240..31c64bfcf05 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 f06b3d39f52..8bd50e2dc9f 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 215285284e6..e20dde31be2 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 ac46faaef7b..b783794c48f 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 415bfc8fe55..9be4b70a5ee 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 104a74a1885..3ed017500ad 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 b9368e8a370..de0b1ce0ff8 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 b1740869a73..360a9f9d997 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 3df593ef25d..613c8d71b86 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 015970eb80c..e2aa0a9f555 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 b8e9a2cd1b5..e369995a9fa 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 6481d6fd921..d836c3cfd22 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 ecdadfd0c34..bc3ab3f8d85 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 471f48d44a0..2074ee27dd7 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 73b901888a8..b18b3e32bbf 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 895e2e10517..e3970a03ecf 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 9160979ab1b..91d41327d53 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 9919770a7e1..4d1cdc00bf4 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 51c5da9fc62..51c8e80f08c 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 30e3ba5d51e..8f09fbf30c4 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 e2409c868d5..a29cda7c64c 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 030aa6b8793..f93eea0e4c6 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 fc26e52fe73..a8e3fcf718e 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 390d49d2be3..c10f89746ba 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 bd0cea641f4..999dd6b4bcd 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 0877ba228be..bbacb082605 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 7715328df0e..7428abc9e8a 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 ebafc809ba7..a1764cce369 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 f66f8a16add..5469b3f8a73 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 733dc30aa5a..4c1fb314a02 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 de226c05938..99cd55acaa1 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 6ed385711ae..6d3a44b50b2 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 bc9fc6c2e7d..c4b27a665ad 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 9e36e9e9469..fa0d86219f5 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 852ae86b82d..0c89f8c57bb 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 c4612d6bbf6..45315616a69 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 ac017c83e1e..2a7f8a96062 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 13215c9d38e..a734ccd93ab 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 6b7bd57ac4c..4b86091b0b9 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 e8f368fc320..1f3128c83fb 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 efdf7c48f91..54781e24680 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 672d3f01b83..b65158ba8bf 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 fd9ac649036..89fb4e72d30 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 c4a47f861f5..2db43ca76c9 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 9411196da39..2beee9ed9d7 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 40458b94c70..834bf5ca7ec 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 7b3078f996a..a58607ec86a 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 a8b3a130ee0..4ae4c5d5eb9 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 0059f92006f..8da9e05647a 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 a6c821f7cc5..c57e11eaddb 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 5100220e0fd..1bea566b9b5 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 169f46bcc8f..d7092bdc612 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 1915c8d34d7..fe9e43b8b1b 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 7e7b13df1fe..abfd999a99f 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 870235edd18..59b33b19309 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 5b85aacc046..44530ec0be5 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 42e000bc3cb..5dbdec425ba 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 fe2bd4635f3..0faab2d0357 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 b36777324a0..8d914020fb1 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 409ffe89069..c75d8db492d 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 07c58415be8..7d533b4ac44 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 4cb4ec57021..e5fd60e0542 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 a673159db5a..51faa8d9343 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 57449c0b048..38d5d00fef6 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 15883cb034d..5d43b9df3ec 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 03741dbf574..af755d69aa7 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 5c82848c60f..29131c09831 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

      • path: string

        Path to the file to read.

      • Optional options: ReadOptions

        Options to read the file with (defaults to utf-8 encoding).

      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 96f7f87258c..23e8bc62124 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 d5654847b7c..6dd2ebc585d 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 42b2424552f..7073b600caf 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 19702ca1623..2ac8fbdf28b 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 eceb56cbfa0..70ec093a459 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 3b7a51597c1..1c6748ef065 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 c6cbaf74a58..b4bd3fa392a 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 c03789b1d61..a0775fc7233 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 fca15a82566..da2d75dab57 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 7b61c7d4fb4..62a3f72541a 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 08eecc2583a..4818f709fc7 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 6fbe848341d..ff9f2014cfc 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 ee6530c0852..39a0022e0f8 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 51b74132cbc..b0e914c7572 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 40797310f97..78ac7ad4e4a 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 591a92d4e66..980c5b95051 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 2e5d78a60ec..fe3a9983cf3 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 42be25a852e..44620e0d9c8 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 95771909970..7ae369f2167 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 20fd749490c..56e7ae21b3d 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 c2e0ae3c894..16cf04cd7e7 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 7313c6e47e5..86e696cf9a0 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 ad096531921..e62077f6e11 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 43e3402fbb8..7bce0cf8897 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 c21713c7e28..2c7d5af8213 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 16b6807afd2..1f953ad4ef6 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 9ed404fa7df..3933b21f0c1 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 f2a3152cfac..0957ca40513 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 a8703903fa8..c9477629b7b 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 48674055996..e7b037e6fc5 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 e370643dc9f..d8b44205cd4 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 ca9e30d65b7..d43c94e3859 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 247ab37c6a8..b8561471d3d 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 dbfd259cc39..96d451acd67 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 30d345076d4..c5ab89c1ad6 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 f457d8fbe00..90a299c6638 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 b3c52195bf0..cf7afc9ec52 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 3711e6a1763..59ebf7e62dd 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 a3d590be0eb..57cc4740ce9 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 a93d200ef53..53582ef55dd 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 b1c4b901d5a..33708640d68 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 67154344775..811ad381975 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 60b67b676a2..651104776be 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 23403e350d0..463ca8fb26f 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 710958630c7..6e925d4d3b4 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 bc02676e870..f73716a1818 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 366ab0334e7..8392df55df5 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 fede40dd222..d4a8aa20bbd 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 f5b0e6806ce..d1dba4763c6 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 c230bb1e8c1..050a412f688 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 e18a49bcfbf..11ff2bd262d 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 229e91218db..9d8b4854297 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 40bf10b1b54..cdfeb318554 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 2ee1ea1a84d..15d261d601f 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 ab7a36ea615..775edca1785 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 20def3ddb28..4c17567ea81 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 5a12717b4f4..4e83baa18a7 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 014f8c3874c..5f0265705d1 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 cdcaf818583..d363438af4a 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 40005fd363c..244b647ee46 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 3bfebc8fd89..069df546b5e 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 abd3dacaf23..e16f6db507e 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 f1a5e21c973..259c0201388 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 38f8802335a..4b6e0821d34 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 112f7cb8775..3b980c8c27c 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 6c5f0197797..b992cb106c5 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 35a80d80793..4625ce25f36 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 0f93db05ee5..3986690249e 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 e1168e228ad..7a7e8ce1b3d 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 408b0e24676..4d2b504017d 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 a53374b42a8..453d02f2456 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 c941379cbeb..ca2d3ade35e 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 31bd0593d27..43d2753b95e 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 44d3be4e0d4..4775bf587f0 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 ce0c095a7bc..149c284bedf 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 ddb464f75c6..908c2ff612e 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 dd9f4a85a61..dc16c684bfb 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 f4537eef5d6..3bacebc24ff 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 4c2da1dcd0e..d3c8f16692b 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 1d07bdb4d46..a982b7d954c 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 670d318dc58..f96750661c6 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 1b92b8107bf..d5b4bc3dd08 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 ff9ac48ca60..7f50f547bd4 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 b7ba5cc8aa2..389b35427e4 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 b6a4e4f3858..8ba44c87083 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 0dfd8679635..a3c8ce0327b 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 fbac5df74d3..bbc1c96a09e 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 8f1cb3e0881..68c98b94c7b 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 8df9a21ea13..38e0a45a37d 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 5d7fd2d7433..4f566f6583b 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 761cec12eae..c3253e34b1e 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 ac74a4ce7f5..54da4699ba7 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 2f62d1c1c18..1019e44e2de 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 9a723ecd0b3..9be0be318d2 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 7fd0cb62d31..fa25dd564e9 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 066a7c240a1..172437776be 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 5ef1e578aaf..fcc8cca8f18 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 b4c00745a2f..5f69509d69f 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 fde7f87b8c6..a9c792587e4 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 6a852e3f618..9f027852670 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 e93c446d9eb..9002b9ea1c7 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 9a83834f46c..782f33f309f 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 ca3d85aa4f5..5fa7838bd67 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 babcc8c7816..c0e16a47ecf 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 c83902fe594..be0881d255e 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 2b50c4d7573..108dde388c1 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 7a6f32f006d..e43313feb01 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 4c825831268..f5ab3b5afc3 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 3036d5b8910..6a593add19f 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 286b6c2f77a..89b4110939e 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 a133090b4a1..f81b0c50701 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 2e03d634cd5..10df474f43a 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 0c9fcaf3135..b6be9194013 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 527a129becb..869191e3de2 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 a6788bb4ca7..14a21a72f9c 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 17475350235..eb49af970c9 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 08e5088c7fb..6c89e4b41a5 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 bbdbe4e08ae..c13afabefa2 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 db21fe5c683..26700eab6f1 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 aefbae87711..4dad63d77b5 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 a207c0fc040..1c951bc6bad 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 c5838351c6a..bee745114e7 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 ddc80852108..6e0e065b064 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 973f5a61db2..c4d76d92e25 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 1d892dac783..830982d212b 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 d84b431dfb9..9c6a341f1fe 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 1dfc2fc36d4..c951ad1f2b5 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 2894eae7ffb..42941815480 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 331492c92d6..a1a18e068ef 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 29926b40b05..bf825483887 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 546106add2f..2e013a6d11d 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 5f17a247199..cef2b22f679 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 4f565ed854c..d435c74b490 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 80b90e6f118..1915a23932f 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 81bdb5c630f..f18f9386b0f 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 d41c53133a3..2e995d3a119 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 e7228f39c9c..bbfefb86ad1 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 f0977d00d99..6e11fdc2476 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 24a6d809749..bbb9abbd2b1 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 9640c7172f7..9881310b80a 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 1ee40071ba3..eec56ea1e64 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 aa9d294eaf1..b92b2b126a3 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 40a92829a0d..199d48ef656 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 04decf4beea..13e2864c24d 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 6401de83bd4..01e361d9496 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 4a1d93ffd7b..548c0e3bc48 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 493019d96b2..c0c8ca6bec3 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 8bbf00aabf1..1231957ecab 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 75aea11cc71..9f840ed49ac 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 5e52ccd958d..2e48e61e76d 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 2685ac2d931..b0a97391dc3 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 fd66883950c..13c9b93754d 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 f5e5345e1ee..3e3f8e7d2f8 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 f7555d19770..539c97beed3 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 d0621276d29..29685eb4b25 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 28e009ff7a8..d296515ed88 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 29ace0b1c6f..491b96a766b 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 f930d4f8f0d..79132f9f88d 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 d8ac12371b8..e1ba4c0bb8c 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 36733cb4d1d..88981d5b9f7 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 b35be6e16ca..80bce23d4c2 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 6fdabfc0283..ceb42aa3760 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 51774118e9c..9446618ef57 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 2080fce753a..c1890527e7c 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 247187b11d3..4a5bde4258e 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 c1946ea1a82..d792e60ded4 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 95f01edc227..e61a6b8d788 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 1e1d7d7ba15..62166a5c213 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 cc1cc89b16c..ad386e018b1 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 1e92983243f..0efc94ec065 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 094b00533c8..79bdbdb176e 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 00dc86a728d..77eca302d64 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 363f13c32d0..8af849bf9fc 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 5bbb8e76a16..1cc761b33ad 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 037aa3145da..63e0a91e887 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 6bc5faac4bf..4e7d620b22c 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 a2f9f8ae528..799d77b0d5a 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 e748d4be9be..bcf44283bea 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 a2d885f210b..0c905ef138c 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 40428b43c27..66acf46a04c 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 b83c93f82ae..61dcf22e2ad 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 3f15dcbab78..f107fe2128a 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 ec01324b171..a1fca0a34e2 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 78372af31b8..38b86f6a844 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 32588a19b40..76cc7440d8f 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 5df76cf0ca6..0b56b7d965f 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 cf2c37fa773..e3e487bad53 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 2af44aa3668..3790a63fa37 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 c8fc267ebf7..dcb96027929 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 a29cecdd643..423d8455fba 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 4ef695e07f7..fd4db6da204 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 96e2d9412be..439ec64c756 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 fafc5540480..1d354e15166 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 58b764cbcec..3c02c0779aa 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 9c1f67312ab..15e288d2885 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

      • useAbortSignal(abortSignal?, onAbort?): {
            isAborted: boolean;
        }

      • Parameters

        • Optional abortSignal: AbortSignal
        • onAbort: ((error?) => Promise<void>) = noop
            • (error?): Promise<void>

            • Parameters

              • Optional error: unknown

              Returns Promise<void>

        Returns {
            isAborted: boolean;
        }

        • isAborted: boolean

      Settings

      Member Visibility

      Theme

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

      Function useAbortSignal

      • useAbortSignal(abortSignal?, onAbort?): {
            isAborted: boolean;
        }

      • Parameters

        • Optional abortSignal: AbortSignal
        • onAbort: ((error?) => Promise<void>) = noop
            • (error?): Promise<void>

            • Parameters

              • Optional error: unknown

              Returns Promise<void>

        Returns {
            isAborted: boolean;
        }

        • isAborted: boolean

      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 5b7b311dbb7..49d56a24706 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 27bd295a38a..c5630f777ea 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 138fea5476d..e39299d70ee 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 fb7f13fb85e..96ecc2fd5ab 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 e975f1212fd..119da9f6a62 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 260c5675561..3c0fc13fe2e 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 2ce96e05f7d..dbc4beb2c17 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 5a02f418d13..40976c52dff 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 1f0d22176e5..c26b0729c04 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 f5b5ab70ed9..64faafb24ee 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

      • [name: string]: string

      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 06b21f24428..6160af52d64 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 d3d81f7c71b..b6f0f470b69 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 35fcff7afe7..ea1a9e2c302 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 1b74b513322..2710c55a031 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 d87fcd4d705..fcfb511184f 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 870eb5afc43..0933b836efd 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 87f123e3af6..263b5930022 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 8c3758ba30d..5ca673f181d 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 4302dcf4f4f..e43154288c4 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 214f1e1eb08..747834b7ee6 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 a56412f30d5..223bdfdcb98 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 bf1d7a49aa0..e6813acf7a3 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 a06e49937cf..6e7c8986bbd 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 c251784767b..8a818836d79 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

      • [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 diff --git a/docs/api/cli-kit/interfaces/node_output.OutputProcess.html b/docs/api/cli-kit/interfaces/node_output.OutputProcess.html index bbb462fb8d3..d85ae39d653 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 96adcf65672..691f31a7502 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 b14a9ffc29e..9a281b1b865 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 a72498cf630..0427397b78b 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 3065f2b4e03..26dee3cc029 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 f5ba0f64d2e..cfe9637be92 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 48d00d23121..9da523c3e86 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 d65c2ef73ad..49f747b04b9 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 4b95f898baf..c8ca43570e9 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 35d6d189f7f..5bdd60bbfa0 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

      • 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 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 76814bce8a8..1053a3a2f8d 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 8b04c2c3ece..33cb5c2eeef 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

      • 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 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 e1f135ca242..f2992bded7c 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

        • (): 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

      Type declaration

        • (asset): Promise<void>

        • Parameters

          • asset: ThemeAsset

            The ThemeAsset representing the file to write

            -

          Returns Promise<void>

      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 d75e21d4c91..bf8b2a8db7e 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

        • (): 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.

      Type declaration

        • (themeId, adminSession): Promise<void>

        • Parameters

          • themeId: string

            The ID of the theme being watched.

          • adminSession: AdminSession

            The admin session for API communication.

          Returns Promise<void>

      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

        • (asset): Promise<void>

        • Parameters

          • asset: ThemeAsset

            The ThemeAsset representing the file to write

            -

          Returns Promise<void>

      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 400549315ae..acb73b0128c 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 6996beaf92d..1a4a100a9f4 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

        • (): 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

      Type declaration

        • (asset): Promise<void>

        • Parameters

          • asset: ThemeAsset

            The ThemeAsset representing the file to write

            -

          Returns Promise<void>

      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 aa5c9e510cd..57950fd3d01 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 eae36db00c1..2b1a6e6f2a1 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 a6ff730680c..9577e20f0a3 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 e17df24c34e..eff07eb37f8 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 98938b11e01..6071d28315f 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 5f8a65641f1..46c45690319 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 1066f64446d..04ca7efb71c 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 902923648e9..c8dcc6219e5 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 38913cbeb00..a15b8ad2047 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 17d178072a9..285cb5fe2af 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 19d27a47767..65c42611c93 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 d6ff022c461..f95d4e54cd5 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 1da172c5e99..9ee264e11f7 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 5de2d4a231d..a61b57f5fd9 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 160b9ce40e1..d04ccb5cbd5 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 914ccea3a97..dd59f94cc6a 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 4f190b45772..daed6a423b4 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 a0f4b9d88a6..98e8c7e6970 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 4e18bd50c1f..bb0d87333ac 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 d0ea7e0ff3b..71f4c793dcc 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 910f5bf9380..21acdea73ae 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 676567c687f..cc8bba17b07 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 1c3d350c64a..2bbac933ac7 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 463a353ccbf..7132fee8661 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 d7c01e8186a..9bf9986723c 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 853a0d1e8cc..7861b97dc3e 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 083a4f2ae78..a1de73d2e40 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 0f1b5d6c603..e83931d60a0 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 3d63b7ac240..dba539dba93 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 b44e1a54d12..b6cfcc16b9a 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 6e5874e8038..cf240d92480 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 aaf8c3d0384..3b9d8f409e8 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 ee1dcbe18dc..d315988d1b0 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 ad6d78ec313..49486b547f2 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 c78dee901a7..848c07f34c6 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 7efa4cf4487..523e53d9c1e 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 cc9b174198b..ee53c459cf1 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 fe3378387d7..2d808f6869d 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 fcf49112d95..ef9d1a4ef17 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 97df286aadf..1616e6c7dab 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 78deb515f92..7cd2a177582 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 4099f28c3e8..757e305ce73 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 079c2a6886c..f32a7df7729 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 bb578c3209e..03da399a077 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 ca8a64ae8fc..ac6c2d15c37 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 f526919f3df..e986937e49b 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 491f780edd3..7fd47731002 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 1af6c71cc3f..b563f942fca 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 e012891052f..0223142fd94 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 7ba04572888..76b8ea4d09d 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 4c30cfc0691..de0d14ef679 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 3ab9daf9d2c..4e310510d40 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 f5e3b84229a..fb162815ab4 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 6abe89d893c..022143dc3a4 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 9b7e0bf8e9c..202da936092 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 816ff732b78..3d4bf91c64a 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 5ca7d53d27f..1b5779cc028 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 ddd3f3aca35..feaa00e12ef 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 b7077526a26..f755833119a 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 c8d7366ce3e..a02b2d7e3ad 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 ff40ecb0fbb..87b74e415d1 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 b2466985311..c70502f9d1b 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 df07eac8e4f..88734141abb 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 e68d49f7a23..a64d24779bd 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 24f0043ae10..de9ac5141f0 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 fbc4737c186..ddc23eee5d4 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 156ec10ead7..2c656c85671 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 49f859a7a8c..6c90b9d8f22 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 7b06131cfcb..ba5036a95d9 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 8d72b5015ff..5a8fdf095a6 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 05f2dc38ff0..b93ef547ca3 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 becc443608e..a99b314e0c9 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 fe32554e45f..fae0a92f8a8 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 5ebb0832306..519256543e7 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 45adeb4be8d..454d9be78e4 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 320418c6b3d..188cf7fa78c 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 2b7293e2e90..5f074fa6d97 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 88a4eedbcbd..e2fe8b464af 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 83d86785994..c03ecd38d11 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 ac83a892c8e..6b76de33486 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 aef345e67d9..05d5ec9927d 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 38459683e9e..55e244bd4cc 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 a90f0c270e0..0ab5b299526 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 96bb8984aff..8b38da09cc8 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 9dcefe2f87e..88150a182f2 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 f231e650e89..aa89fdd1fef 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 c93aa2dc040..a00e969e626 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 8525c1d61ce..16a8a66f7ff 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 d06df5b35be..e10b3bdecca 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 3f8ac217726..47510c4ad33 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 3ecce9c9d9e..5e747449b7b 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 5ff29b63da5..2b7055c23ea 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 da1476eca96..6b5f393a9e5 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 785206e9bd9..2a10ff9dacf 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 d8c5e8b5fda..bb77024a38b 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 62b860bdaa5..6a65fae6f27 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 dc8a3b8ef31..749e0201c2a 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 82ec9e7e722..1e397b5e142 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 4da50a2a98e..1760c567e39 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 d99eb779491..dd45433e7e9 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 1e65531dd65..15d74377ad2 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 9a3e4de5a47..8c1c5e8c225 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 ac3e6fa4011..658829b5368 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 05bbd3a4601..c58c95329ba 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 7fe93dfb88a..47043d887fa 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 227af96293c..a32b1082a61 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 0f77eedb3df..31a11f93452 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 579d7d41959..f386f28f5f3 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 edde6aded0f..9111d750781 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 fb631685be7..9d45122553b 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 159e3e7bda0..0981511a54e 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 3cd2a179f96..17c41661133 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 f9468e32714..4cae5dac24b 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 cafb2c8679a..0b8171e6057 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 cfcb57281b1..a370490912d 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 c5129378016..e55a13ff9cf 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 ae73af8d821..dd2a841fbd4 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 a8a2fe29284..386ad50b99c 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 e7b10a462e0..4cf5ce43823 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 4792cdf21ba..e38b2ec5544 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 d2419e2c592..8affc6160cb 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 78adf197486..729b549d37e 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 485db9e4f15..b04e91c5074 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 cab8c168eeb..a98917ccfa2 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 1431e42fc01..ae269ad2cd2 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 03d3c498461..c6510fb3487 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 938b7e7d82d..a7fbad1b245 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 35e2e8eb8cd..550d298e4e3 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 9422eca142a..0e7e6abd4f4 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 17690823272..ec309780bb1 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 f2d152d3369..a45d6792f4e 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 53766a79264..86e7e7e5531 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 2898d866d09..8c6c84c54d2 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 008d99060b4..f25f510644b 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 8eb67f29bed..ee846784a95 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 c6509bdc959..06d4501f0f9 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 43fc28afeaf..fc7bbc1e84f 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 dc9f03ce69b..f23f871731b 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 13c01959baa..434065b709d 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 48374e7cb5b..e93a222ea0e 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 23f3e6e6b32..6a760ce368b 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 6b309e3885b..4be35b946c8 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 820646b7d6b..a96f0c777bb 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 90dae911f22..da7c31cd612 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 64613be6934..0822551e588 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 c1e1dec2535..db1058863a6 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 24d5e0441ab..ff663fdddd4 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 ed4be656451..aa290cd6472 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 d65c69a13b8..0604318d861 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 d9f497f65ec..5eb54015510 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 53610f802e3..53d95badb6d 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 e87fa511a95..6c73afb55d3 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 e58dfaa23f6..be677a13204 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 e4ce25d3902..3b3c19bf445 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 9bdb7f5dbfb..3f4653b132e 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 a216586c549..a3ba6580c81 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 fb00e4b1a69..420721863b0 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 2f3c6f0a379..0c5e62dc29e 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 ce392a6fe2e..dd85580d814 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 86a8ba0dda8..d2d7b0b23e3 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 97990a7c1ce..e035b3c4c03 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 b26a4660fbf..8ba285f386d 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 252243509ac..1455fb754f0 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 2130245ee81..34f129468d3 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 df3d764852b..bab433f8dbe 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.1" = '3.67.1'

      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.2" = '3.67.2'

      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 8f19364ef79..982b6bd218d 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 3e7c321354d..3cdfcc2b9bb 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 9de7002b6de..1d45299053b 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 01c5d1fa8f7..1c19b24e0e2 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 69f226bfd41..f66b10371d4 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 4ef8fd5da88..5a37f17e093 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 c9e62982e19..4eec34cc819 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 5091ae21646..1b80e76ae29 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 99a45ab04b5..95d29e9ef6a 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 4663ea688a5..e62cf050799 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 d14095873b2..5b3fc451895 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 6c301efa527..a3693e15c05 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 eda05424dfb..aa2daf139e2 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 13412f85f5d..d0bd44c1c19 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 ab7670e8919..c2481b7b212 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 bc6eb0ceab6..e2a88536cfa 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 c0e47eff289..3eff5e6afba 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 5bafe36d1df..6361020a5bd 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 2948bbef325..3187c600bd6 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 0639d26cff6..7c369b45b11 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 a8474de6f13..36fd2ddd24c 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 b0a730acec2..b82f47ca0d1 100644 --- a/packages/app/CHANGELOG.md +++ b/packages/app/CHANGELOG.md @@ -1,5 +1,16 @@ # @shopify/app +## 3.67.2 + +### Patch Changes + +- 27c345b81: Remove duplicated slashes when deploying privacy compliance webhooks with relative URIs +- Updated dependencies [cf73ca498] + - @shopify/cli-kit@3.67.2 + - @shopify/create-app@3.67.2 + - @shopify/plugin-cloudflare@3.67.2 + - @shopify/theme@3.67.2 + ## 3.67.1 ### Patch Changes diff --git a/packages/app/package.json b/packages/app/package.json index 301d9a0256d..d54630c0631 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/app", - "version": "3.67.1", + "version": "3.67.2", "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.1", - "@shopify/create-app": "3.67.1", - "@shopify/theme": "3.67.1", + "@shopify/cli-kit": "3.67.2", + "@shopify/create-app": "3.67.2", + "@shopify/theme": "3.67.2", "@shopify/function-runner": "4.1.1", - "@shopify/plugin-cloudflare": "3.67.1", + "@shopify/plugin-cloudflare": "3.67.2", "@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 6df5427a444..5b0c54c0f00 100644 --- a/packages/cli-kit/CHANGELOG.md +++ b/packages/cli-kit/CHANGELOG.md @@ -1,5 +1,11 @@ # @shopify/cli-kit +## 3.67.2 + +### Patch Changes + +- cf73ca498: Avoid outputContent errors with undefined variables + ## 3.67.1 ### Patch Changes diff --git a/packages/cli-kit/package.json b/packages/cli-kit/package.json index dc42ccd2ce0..21c7b60c558 100644 --- a/packages/cli-kit/package.json +++ b/packages/cli-kit/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/cli-kit", - "version": "3.67.1", + "version": "3.67.2", "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 4a412809779..5dff18d1dd0 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.1' +export const CLI_KIT_VERSION = '3.67.2' diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index 1e6e272bb1a..802f7e65696 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -1,5 +1,7 @@ # @shopify/cli +## 3.67.2 + ## 3.67.1 ## 3.67.0 diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json index f9aa2b9d3db..14104d68c53 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.1" + "version": "3.67.2" } \ No newline at end of file diff --git a/packages/cli/package.json b/packages/cli/package.json index e2915271fa4..be5d8711db8 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/cli", - "version": "3.67.1", + "version": "3.67.2", "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.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/app": "3.67.2", + "@shopify/cli-kit": "3.67.2", + "@shopify/plugin-cloudflare": "3.67.2", + "@shopify/plugin-did-you-mean": "3.67.2", + "@shopify/theme": "3.67.2", "@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 1ef88c554a1..883d7c4521c 100644 --- a/packages/create-app/CHANGELOG.md +++ b/packages/create-app/CHANGELOG.md @@ -1,5 +1,7 @@ # @shopify/create-app +## 3.67.2 + ## 3.67.1 ## 3.67.0 diff --git a/packages/create-app/oclif.manifest.json b/packages/create-app/oclif.manifest.json index e39847d31a6..8a67eaa28f2 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.1" + "version": "3.67.2" } \ No newline at end of file diff --git a/packages/create-app/package.json b/packages/create-app/package.json index 279b2bbdb6a..e6cdc10af88 100644 --- a/packages/create-app/package.json +++ b/packages/create-app/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/create-app", - "version": "3.67.1", + "version": "3.67.2", "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.1", + "@shopify/cli-kit": "3.67.2", "@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 3513e31e614..65d72f17cd0 100644 --- a/packages/plugin-cloudflare/CHANGELOG.md +++ b/packages/plugin-cloudflare/CHANGELOG.md @@ -1,5 +1,12 @@ # @shopify/plugin-cloudflare +## 3.67.2 + +### Patch Changes + +- Updated dependencies [cf73ca498] + - @shopify/cli-kit@3.67.2 + ## 3.67.1 ### Patch Changes diff --git a/packages/plugin-cloudflare/package.json b/packages/plugin-cloudflare/package.json index 0bb58febcaf..b128840070c 100644 --- a/packages/plugin-cloudflare/package.json +++ b/packages/plugin-cloudflare/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/plugin-cloudflare", - "version": "3.67.1", + "version": "3.67.2", "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.1" + "@shopify/cli-kit": "3.67.2" }, "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 bcb7dd99166..0874229d1c1 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.2 + +### Patch Changes + +- Updated dependencies [cf73ca498] + - @shopify/cli-kit@3.67.2 + ## 3.67.1 ### Patch Changes diff --git a/packages/plugin-did-you-mean/package.json b/packages/plugin-did-you-mean/package.json index 03a174ec63a..5a7207b0609 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.1", + "version": "3.67.2", "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.1", + "@shopify/cli-kit": "3.67.2", "n-gram": "2.0.2" }, "devDependencies": { diff --git a/packages/theme/CHANGELOG.md b/packages/theme/CHANGELOG.md index 47e715f9ec1..72116226f62 100644 --- a/packages/theme/CHANGELOG.md +++ b/packages/theme/CHANGELOG.md @@ -1,5 +1,12 @@ # @shopify/theme +## 3.67.2 + +### Patch Changes + +- Updated dependencies [cf73ca498] + - @shopify/cli-kit@3.67.2 + ## 3.67.1 ### Patch Changes diff --git a/packages/theme/package.json b/packages/theme/package.json index e65e5886fe9..7643a1694c6 100644 --- a/packages/theme/package.json +++ b/packages/theme/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/theme", - "version": "3.67.1", + "version": "3.67.2", "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.1", + "@shopify/cli-kit": "3.67.2", "@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 73a31295026..0f90f5c3aec 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.2 + ## 3.67.1 ## 3.67.0 diff --git a/packages/ui-extensions-dev-console/package.json b/packages/ui-extensions-dev-console/package.json index 16223de8f26..978af7d4dd5 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.1", + "version": "3.67.2", "private": true, "scripts": { "build": "nx build", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 8681364440a..6f088666e0f 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.1 + specifier: 3.67.2 version: link:../cli-kit '@shopify/create-app': - specifier: 3.67.1 + specifier: 3.67.2 version: link:../create-app '@shopify/function-runner': specifier: 4.1.1 version: 4.1.1 '@shopify/plugin-cloudflare': - specifier: 3.67.1 + specifier: 3.67.2 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.1 + specifier: 3.67.2 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.1 + specifier: 3.67.2 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.1 + specifier: 3.67.2 version: link:../cli-kit '@shopify/plugin-cloudflare': - specifier: 3.67.1 + specifier: 3.67.2 version: link:../plugin-cloudflare '@shopify/plugin-did-you-mean': - specifier: 3.67.1 + specifier: 3.67.2 version: link:../plugin-did-you-mean '@shopify/theme': - specifier: 3.67.1 + specifier: 3.67.2 version: link:../theme '@types/node': specifier: 18.19.3 @@ -540,7 +540,7 @@ importers: specifier: 3.26.5 version: 3.26.5 '@shopify/cli-kit': - specifier: 3.67.1 + specifier: 3.67.2 version: link:../cli-kit '@types/node': specifier: 18.19.3 @@ -664,7 +664,7 @@ importers: specifier: 3.26.5 version: 3.26.5 '@shopify/cli-kit': - specifier: 3.67.1 + specifier: 3.67.2 version: link:../cli-kit devDependencies: '@vitest/coverage-istanbul': @@ -677,7 +677,7 @@ importers: specifier: 3.26.5 version: 3.26.5 '@shopify/cli-kit': - specifier: 3.67.1 + specifier: 3.67.2 version: link:../cli-kit n-gram: specifier: 2.0.2 @@ -693,7 +693,7 @@ importers: specifier: 3.26.5 version: 3.26.5 '@shopify/cli-kit': - specifier: 3.67.1 + specifier: 3.67.2 version: link:../cli-kit '@shopify/theme-check-node': specifier: 2.9.0