From f5cf7b0e13039097715f34562f1a7ee74addf4f7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 30 Apr 2024 09:56:41 +0000 Subject: [PATCH] Version Packages --- .changeset/clean-badgers-deny.md | 5 ---- .changeset/curvy-crabs-rule.md | 5 ---- .changeset/giant-drinks-applaud.md | 5 ---- .changeset/good-fireants-wonder.md | 12 -------- .changeset/late-flowers-yell.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.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 +- .../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 +- ...ness_platform.businessPlatformRequest.html | 2 +- .../node_api_graphql.graphqlRequest.html | 2 +- ...ode_api_partners.getFunctionUploadUrl.html | 2 +- .../node_api_partners.handleDeprecations.html | 2 +- .../node_api_partners.partnersRequest.html | 2 +- ...shopify_developers.handleDeprecations.html | 2 +- ...ers.orgScopedShopifyDevelopersRequest.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 +- ...ode_context_fqdn.businessPlatformFqdn.html | 2 +- .../node_context_fqdn.identityFqdn.html | 2 +- .../node_context_fqdn.normalizeStoreFqdn.html | 2 +- .../node_context_fqdn.partnersFqdn.html | 2 +- ...de_context_fqdn.shopifyDevelopersFqdn.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.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 +- .../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 +- .../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 +- ...de_liquid.recursiveLiquidTemplateCopy.html | 2 +- .../node_liquid.renderLiquidTemplate.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 +- ...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.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 +- ...ode_output.getOutputUpdateCLIReminder.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 +- .../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_plugins.fanoutHooks.html | 2 +- .../node_plugins.getListOfTunnelPlugins.html | 2 +- .../node_plugins_tunnel.defineProvider.html | 2 +- .../node_plugins_tunnel.startTunnel.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 +- ...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.terminalSupportsRawMode.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 +- .../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 +- .../node_ui_hooks.useAbortSignal.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 +++--- ...ode_api_graphql.GraphQLRequestOptions.html | 4 +-- ...de_api_graphql.GraphQLResponseOptions.html | 4 +-- .../node_api_graphql.GraphQLVariables.html | 2 +- ...ers.FunctionUploadUrlGenerateResponse.html | 4 +-- .../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 | 10 +++---- .../interfaces/node_themes_types.Theme.html | 12 ++++---- .../node_themes_types.ThemeAsset.html | 10 +++---- .../node_themes_types.ThemeFileSystem.html | 6 ++-- .../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 +-- ...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_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 +- .../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_shopify_developers.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_http.html | 2 +- docs/api/cli-kit/modules/node_ink.html | 2 +- docs/api/cli-kit/modules/node_is_global.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_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_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 +- ...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 +- .../node_api_graphql.GraphQLResponse.html | 2 +- .../types/node_context_local.CIMetadata.html | 2 +- .../cli-kit/types/node_fs.ReadOptions.html | 2 +- .../api/cli-kit/types/node_http.Response.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 +- .../types/node_themes_api.AssetParams.html | 2 +- .../types/node_themes_api.ThemeParams.html | 2 +- .../cli-kit/types/node_themes_types.Key.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.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 +- ...ers.FunctionUploadUrlGenerateMutation.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 | 10 +++++++ packages/app/package.json | 8 +++--- 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 | 16 +++++++++++ packages/cli/oclif.manifest.json | 2 +- packages/cli/package.json | 16 +++++------ packages/create-app/CHANGELOG.md | 8 ++++++ packages/create-app/oclif.manifest.json | 2 +- packages/create-app/package.json | 4 +-- packages/plugin-cloudflare/CHANGELOG.md | 8 ++++++ packages/plugin-cloudflare/package.json | 4 +-- packages/plugin-did-you-mean/CHANGELOG.md | 8 ++++++ packages/plugin-did-you-mean/package.json | 4 +-- packages/theme/CHANGELOG.md | 11 ++++++++ packages/theme/package.json | 4 +-- .../ui-extensions-dev-console/CHANGELOG.md | 6 ++++ .../ui-extensions-dev-console/package.json | 2 +- pnpm-lock.yaml | 24 ++++++++-------- 584 files changed, 804 insertions(+), 763 deletions(-) delete mode 100644 .changeset/clean-badgers-deny.md delete mode 100644 .changeset/curvy-crabs-rule.md delete mode 100644 .changeset/giant-drinks-applaud.md delete mode 100644 .changeset/good-fireants-wonder.md delete mode 100644 .changeset/late-flowers-yell.md diff --git a/.changeset/clean-badgers-deny.md b/.changeset/clean-badgers-deny.md deleted file mode 100644 index 44e233e97da..00000000000 --- a/.changeset/clean-badgers-deny.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/theme': patch ---- - -- Fix the `shopify theme dev` proxy to use the development theme, even when users have a browser session with the live theme loaded diff --git a/.changeset/curvy-crabs-rule.md b/.changeset/curvy-crabs-rule.md deleted file mode 100644 index 0ebf2920f12..00000000000 --- a/.changeset/curvy-crabs-rule.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/theme': patch ---- - -Fix unpublished themes being marked as development themes diff --git a/.changeset/giant-drinks-applaud.md b/.changeset/giant-drinks-applaud.md deleted file mode 100644 index 35f684dc2e5..00000000000 --- a/.changeset/giant-drinks-applaud.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/cli': patch ---- - -Add clean & build steps to stable shipit config diff --git a/.changeset/good-fireants-wonder.md b/.changeset/good-fireants-wonder.md deleted file mode 100644 index c99b79f8fb2..00000000000 --- a/.changeset/good-fireants-wonder.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -'@shopify/ui-extensions-dev-console-app': patch -'@shopify/plugin-did-you-mean': patch -'@shopify/plugin-cloudflare': patch -'@shopify/create-app': patch -'@shopify/cli-kit': patch -'@shopify/theme': patch -'@shopify/app': patch -'@shopify/cli': patch ---- - -Fix react version mismatch error diff --git a/.changeset/late-flowers-yell.md b/.changeset/late-flowers-yell.md deleted file mode 100644 index 0bb104d5777..00000000000 --- a/.changeset/late-flowers-yell.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/theme': patch ---- - -Fix issue that prevents `shopify theme console` from evaluating results when another 'preview_theme_id' is set diff --git a/docs/api/cli-kit/classes/node_abort.AbortController.html b/docs/api/cli-kit/classes/node_abort.AbortController.html index 3cec34465ce..a6f741fd010 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

Generated using TypeDoc

\ 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 ca7a21bffe8..b7b7e56c89e 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

Generated using TypeDoc

\ 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 21f8aa74a46..81612cf31a7 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

Methods

catch environmentsFilename exitWithTimestampWhenEnvVariablePresent @@ -10,4 +10,4 @@ analyticsNameOverride analyticsStopCommand descriptionWithoutMarkdown -

Constructors

constructor

  • new default(argv, config): default

  • Parameters

    • argv: string[]
    • config: Config

    Returns default

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

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new default(argv, config): default

  • Parameters

    • argv: string[]
    • config: Config

    Returns default

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

Generated using TypeDoc

\ 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 cb6b5653f46..d69d8c39ebd 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

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

customPriority

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ 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 892a145da44..d7a334dfff8 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ 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 896bb982b55..c7930409558 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ 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 bba68306d59..3f173ead8d6 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ 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 aa082baff6a..6cf95ee6c09 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

Generated using TypeDoc

\ 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 af39f297b91..8ea0ebc8a72 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ 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 942ff7d99c1..03c8483ab64 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 81a6dcf1104..9cab0ae3980 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 c0901470fa2..afef9b78c15 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 3dd39513a13..e5182c4f470 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 4bf92d5a58c..2c5a82493b7 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 4fa72ad8ae9..fb4a52e2543 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 fe548836769..bd3edd0dc53 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 86b08c3ca8b..de9c76055ef 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

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 e5902b37397..8f2aa175e14 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

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    type

    type: TunnelErrorType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 75715820a69..a46c200cc62 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

    Generated using TypeDoc

    \ No newline at end of file +

    valueOrAbort

    valueOrBug

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 b4dc90c953f..a141ae67aa4 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

    Generated using TypeDoc

    \ No newline at end of file +

    valueOrAbort

    valueOrBug

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 eadeef34b00..592d8882343 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 19188183a71..b4cb23c9105 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 @@ -7,4 +7,4 @@ findOrCreate removeTheme setTheme -

    Constructors

    constructor

    Properties

    Protected adminSession

    adminSession: AdminSession

    Protected Abstract context

    context: string

    Protected themeId

    themeId: undefined | string

    Methods

    create

    fetch

    findOrCreate

    Protected Abstract removeTheme

    Protected Abstract setTheme

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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

    Protected Abstract removeTheme

    Protected Abstract setTheme

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 2e438964dac..d8e00c8b8c4 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 9ae79636f12..c6dce0e2e01 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 516b0d5276e..8211bcfd6ef 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 d7a50aa6196..dc26276c888 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 c7c89962a9b..ce4c06b41d7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Abort

    Abort: 0

    AbortSilent

    AbortSilent: 1

    Bug

    Bug: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 5f2a210d2ab..126989e7980 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

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Delete

    Delete: "DELETE"

    Upload

    Upload: "UPLOAD"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 12a3058fdeb..88243f07f5f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Counter

    Counter: "Counter"

    Histogram

    Histogram: "Histogram"

    UpDownCounter

    UpDownCounter: "UpDownCounter"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 d9ed5b3886e..db65a4afc7d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9a960a73406..f6b1e9a1e42 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 de958e5ca29..5300dcff0b9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c3993ab3460..690c6227696 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e12c78e3b01..6a66fc4fdd2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 dbbc9aba815..3683a0db53c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d53b0ee9afa..975164dfa9b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0c350d6c864..0b6d0894891 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 478db21f952..cde50a52acd 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0a0a8a433ec..a3f710a68d6 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b3dc03aa047..3be69587340 100644 --- a/docs/api/cli-kit/functions/common_lang.isEqual.html +++ b/docs/api/cli-kit/functions/common_lang.isEqual.html @@ -10,4 +10,4 @@

    Returns boolean

    Returns true if the values are equivalent, else false.

    Example
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ef0168eef56..6f066b0034b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 424649d8ee4..7821e94731b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3c9f47aa22e..cb5e93a7f8b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e8c33d73730..42e326913c9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a48e0306334..8c68a70406b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 14bca9c706a..805b4a4fa2f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d62f0820f63..cd6b3a0eb38 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ab78ac0667e..7f80201219c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a35d41e210f..bcdde54a10c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 636bd8075ac..bc27ceec2bc 100644 --- a/docs/api/cli-kit/functions/common_retry.performActionWithRetryAfterRecovery.html +++ b/docs/api/cli-kit/functions/common_retry.performActionWithRetryAfterRecovery.html @@ -7,4 +7,4 @@

    Type Parameters

    Parameters

    Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d23ab19d3b9..a7ae6a5ecf8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 62c82c42184..4c387e25391 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9033cde0b5f..a812bab873c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 16ae88865f5..383922a3872 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5b97ee2a4ef..5c748ce0054 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 7948eac351b..669812a7ca9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 32fad7a8b66..52da8d6788a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 fef03498d23..2a826eeec70 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 60b362b1860..8b226e9dfca 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9a27fc590af..38ba03802d0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 832f9081b69..4d96c2a75ad 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 93714834f31..0efe8b67809 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 f62cfc68243..4c75bdaf51f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 90f0598cfcb..fd7736600e5 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 8d1e6747637..305ee02b0ad 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e43dd0f7de4..e9377d60c75 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 f58cb958b02..136fa638c6c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a74206c1309..33604ab3daa 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6c51490a789..8ac3dec11f2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c9a7ee55e22..3e1a31ec7c4 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b6a048fba09..d530d30226d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 60e9e9f1dfa..807f9dd2670 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b9cf989bcab..34b9f797574 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_partners.getFunctionUploadUrl.html b/docs/api/cli-kit/functions/node_api_partners.getFunctionUploadUrl.html index 41f5ba81ece..434fbc70124 100644 --- a/docs/api/cli-kit/functions/node_api_partners.getFunctionUploadUrl.html +++ b/docs/api/cli-kit/functions/node_api_partners.getFunctionUploadUrl.html @@ -1,4 +1,4 @@ getFunctionUploadUrl | @shopify/cli-kit

    Function getFunctionUploadUrl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ec4f4a36a1d..6cda2f404e8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 080e2d73f29..83ef2190b81 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_shopify_developers.handleDeprecations.html b/docs/api/cli-kit/functions/node_api_shopify_developers.handleDeprecations.html index 08468b2281c..09229138c98 100644 --- a/docs/api/cli-kit/functions/node_api_shopify_developers.handleDeprecations.html +++ b/docs/api/cli-kit/functions/node_api_shopify_developers.handleDeprecations.html @@ -1,4 +1,4 @@ handleDeprecations | @shopify/cli-kit

    Function handleDeprecations

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_api_shopify_developers.orgScopedShopifyDevelopersRequest.html b/docs/api/cli-kit/functions/node_api_shopify_developers.orgScopedShopifyDevelopersRequest.html index 5f68406fe3a..7ed752825b0 100644 --- a/docs/api/cli-kit/functions/node_api_shopify_developers.orgScopedShopifyDevelopersRequest.html +++ b/docs/api/cli-kit/functions/node_api_shopify_developers.orgScopedShopifyDevelopersRequest.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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 948c7d511c5..7d88b46a362 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 8427238f161..d036140eed6 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

    Generated using TypeDoc

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

    Function addFromParsedFlags

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3bf18efd08a..c214c29f5fc 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

    Generated using TypeDoc

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

    Function localCliPackage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 56542b0f6e6..7a36b790434 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0727229a062..cd52e04feb3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1e9f8c93956..50de23932e1 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

    Generated using TypeDoc

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

    Function useLocalCLIIfDetected

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ec3b4735294..eb0576db979 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ef527f770c7..850176c9f7c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 2c04d7782a8..d88ff0f6a38 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 8e2bf6e42f8..21d319ace35 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_context_fqdn.shopifyDevelopersFqdn.html b/docs/api/cli-kit/functions/node_context_fqdn.shopifyDevelopersFqdn.html index 5264123b04f..2cd3efa6cf4 100644 --- a/docs/api/cli-kit/functions/node_context_fqdn.shopifyDevelopersFqdn.html +++ b/docs/api/cli-kit/functions/node_context_fqdn.shopifyDevelopersFqdn.html @@ -1,3 +1,3 @@ shopifyDevelopersFqdn | @shopify/cli-kit

    Function shopifyDevelopersFqdn

    • shopifyDevelopersFqdn(): Promise<string>

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

      Returns Promise<string>

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4526df8358e..5285c8114af 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 fcb439dc62b..76040f53790 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6301625316e..ab411520aa6 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a8daaa87045..f23972bc4ed 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 333fac6d4fb..4cae44f984b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 52014ffcae9..44bdacdc641 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ad83328690f..6bf3edaabbd 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 51b4b34a013..3bfa4271fac 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1cdd983c368..c2d24a2d6fe 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 649bf3031a4..35c91c4b959 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 27b97d71ce1..2e38d38836a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 42bd8d74612..bdf03980388 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0854a5364f1..d2df7d05faf 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 56b540b7d19..1686cbdd26a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 90ae1e5f14f..032e8446e74 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4220d12dc07..0903060f1b7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5faf2e773aa..39b4b77a48c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 555f1510ef3..e8e94377f05 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 27d71cea7aa..3090e51645c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9ad2d546b22..34b5cb376bf 100644 --- a/docs/api/cli-kit/functions/node_context_local.useDeviceAuth.html +++ b/docs/api/cli-kit/functions/node_context_local.useDeviceAuth.html @@ -1,4 +1,4 @@ useDeviceAuth | @shopify/cli-kit

    Function useDeviceAuth

    • useDeviceAuth(env?): boolean

    • Returns true if the CLI should use device auth.

      Parameters

      • env: ProcessEnv = process.env

        The environment variables from the environment of the current process.

      Returns boolean

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e7888adc615..385c3550add 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 906b4f4b9fd..904cfce4297 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 887ab69b2d6..614b3c87006 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ecaf64119ac..2f55f0c1fb1 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 7bde6521e37..80815cdfdb1 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0671d51c082..0cd038a8f9f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e23aa53cd9b..c0ef393df98 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 08543c990c7..5d217528b71 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 32d3baca574..96e753ef381 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 56d98443d02..09125f3f511 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b5af1476a45..f7c17758d3d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1076f76d1c0..7b8a60e5ea4 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a60bd94d1e2..d501c9f865b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0c8977dc6c0..5e388a33de3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e37410b53d0..80072232e58 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b5ce0bf8d86..cd184cdb737 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4a1b0789f65..f69f488d3d5 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9ec1e201f03..0609fd4a96e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0e81a2b2e63..921b404e968 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

    Generated using TypeDoc

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

    Function createDotEnvFileLine

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c735254c8ec..4b259aa587b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d6aceb097ba..9f25e1fcc21 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 518fea50856..befd83c45e4 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5db3fa5ecdf..f92c2fe3d3b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9b0c770373a..30f89339d21 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 36b770df738..915f9614a08 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;
      } | undefined

    • Returns the information of the identity token.

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

      The identity token information in case it exists.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d1a1593ee87..382c1c348bb 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 79311d219ca..f82a9789403 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 95dddb65601..1d64f971ae7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 52a2df1bf7b..b3b9fabc799 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 001cdae6d14..e7e1c15330a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d1cbab6b978..0479608f600 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 dfccfc56a99..af133017ba8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 727aa676acf..ec28b9f42cf 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e47c4f45c63..d23ae1a7715 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

    Generated using TypeDoc

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

    Function addBugsnagMetadata

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 297ad7112f2..cc0774acf4b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 7613d9ac05b..4933e9d0fd2 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

    Generated using TypeDoc

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

    Function errorHandler

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6a4930f96d6..c6f865ea4b5 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a7584cd08e3..0c591141aca 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a858503d25e..296fba170c2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a0bf36b4460..2d63a4d434e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ddd6881351b..49df9245447 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6659338882c..9bccceb23e2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ba7950d3524..6192f2f6ae0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 f7293ff4f09..cd5b9e99532 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ef650e647cd..90914d5b4be 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 981a03a6ac5..f6f227c53ae 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4ef002c862c..081d7456db5 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

    Generated using TypeDoc

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

    Function fileExistsSync

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 07cb9c19239..d1b69f44c11 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 09cc5013ed3..6e6ff5bdb84 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 69ff2cdc920..2a1efee8b84 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 907aa7e669b..922a3214f14 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 dd1093b228e..9d13ec20faa 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 98592f96a5d..1b3553c1e0f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e8deb1c4c31..f605ce6cbdd 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 210fc187f14..72a42c91e01 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 73836abbc35..6d250008918 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 40e2fced1fc..63f659a57c8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<T>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4092d443e3f..1668ccd474d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c47314cc783..6337857eb3e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 35957204df8..ea8271943a6 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ee4de93b931..371d45de52b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 33e8a0eaf1a..3e89f9efb93 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5c6564801e6..bed1eaf63b8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 74264d294bb..256418b0030 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3f7fe14b8cc..07d82ad9544 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 46bc21cb0a8..e958e60feba 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0f1a8aaaf3d..1fec5f6e68f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 304e68d4b18..effb73cf44f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e85265b0e82..d4067702ca4 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 f9d7363928e..b075c6daa42 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 7d0087e6e68..226b938dbd6 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 068e4ac0eb6..d264c7c753e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 30be6601fdf..b33828836a3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 20fc2c5b60a..52eeac69bc6 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 af2001384b7..91710ab5f60 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5818b65b303..b3eee14ff0f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 65addf2d91c..977cccb2c68 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 73b035a6d72..39c4eff0097 100644 --- a/docs/api/cli-kit/functions/node_git.checkIfIgnoredInGitRepository.html +++ b/docs/api/cli-kit/functions/node_git.checkIfIgnoredInGitRepository.html @@ -3,4 +3,4 @@ by the .gitignore.

    Parameters

    Returns Promise<string[]>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<string[]>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 772551ceb78..84968ced4c0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 f1bd951bc7f..bd7ad4c03d1 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6f316eee8ff..6bc6d34ef27 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ac9f30face8..ffbe04bde8a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 de2acf6dee3..ec6526d7bc5 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e3e6044caa7..d22bf77e1ab 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3c600e8ac86..443ac1ef485 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c7a3a619088..4bbc13b2a74 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9fb0c7ac8fe..669ba50f5e4 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ea241bb64b2..9217d1c0ee2 100644 --- a/docs/api/cli-kit/functions/node_git.isClean.html +++ b/docs/api/cli-kit/functions/node_git.isClean.html @@ -1,3 +1,3 @@ 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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 747736e145e..420350136de 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<GithubRelease>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d4b6d4dd2f1..1229a95d7b7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns GithubRepositoryReference

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c45fd05fc5e..7d781f47854 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Result<ParseRepositoryURLOutput, Error>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 93a30298b27..5e14779cdfa 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 71295c15b15..34ac2dde2a5 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

    Generated using TypeDoc

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

    Function hook

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ceb00f06c35..1d1507fc656 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

    Generated using TypeDoc

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

    Function hook

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c5010b1a3b7..d0679a538af 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

    Generated using TypeDoc

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

    Function parseCommandContent

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 7cc6f590315..cf601dc5f88 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e5da3877796..44b0d50a11f 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 Response

    A promise that resolves with the response.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 bd0d3031a9b..349d037a7e2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 94d0297e669..f8d4cd28936 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 Response

    A promise that resolves with the response.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 71bf757bfc7..593392b9e7a 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(env?): boolean

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

      Parameters

      • env: ProcessEnv = process.env

        The environment to check. Defaults to process.env.

      Returns boolean

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 439d43d0d2f..3b31ea53ee6 100644 --- a/docs/api/cli-kit/functions/node_is_global.inferPackageManagerForGlobalCLI.html +++ b/docs/api/cli-kit/functions/node_is_global.inferPackageManagerForGlobalCLI.html @@ -2,4 +2,4 @@

    Parameters

    Returns PackageManager

    The package manager used by the global CLI.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 42f68bb302e..2f2ce609bdf 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5404f7a6518..925bb5d7a6d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d21f9bb8d0b..d52fb590c7c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b791422b386..556e50db47b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0486d7f397d..7963376c0a2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 582bb1ec3d2..a758e4fa334 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

    Generated using TypeDoc

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

    Function addPublicMetadata

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e29c4c84e94..c3900d26561 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 72213a93a18..2acb327e015 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e679f09d9e6..03ecb025bf4 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

    Generated using TypeDoc

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

    Function getAllPublicMetadata

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1582c2d5df4..a4708039eca 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 6411d0f44da..1e4a7aec4ac 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 bb6054fc974..0fa0ae47ca0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1d568d716da..c72c9103572 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1950dbb2655..ed1587b46a9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c9364557710..d7b9ec9b926 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

    Generated using TypeDoc

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

    Function addNPMDependencies

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 95ecf5cfcba..5cd52568868 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 457206b8a17..80ebb3a3e3c 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

    Generated using TypeDoc

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

    Function addNPMDependenciesWithoutVersionIfNeeded

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 217aa69c610..aa3f622324d 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

    Generated using TypeDoc

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

    Function addResolutionOrOverride

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 861cb9cf10f..05f1c6464d1 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 @@ -2,4 +2,4 @@

    Parameters

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e08eaa21e99..18c649cd68a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1bd93aa1d3f..4f68baf16d9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 720985e01fa..08a1fbcad1d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 2f4b0c33aba..00cfe137bc8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 99ed1e23690..ab47a936e2e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 29cd7ee880b..dc56d779e44 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b974ef0c550..6943f055bae 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

    Generated using TypeDoc

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

    Function installNodeModules

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e79cc78feda..0dfbd01ab5d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1d85b418679..34231f1fc4c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d96c9258380..50d7ce340c7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0ae2ac0339f..d63d2dcaec5 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 607b63c2eb6..5c35f20c255 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d782684e42d..26e3324c802 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e64a845cacf..1935973a332 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

    Generated using TypeDoc

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

    Function clearCollectedLogs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3861fd9fe69..111f460a48a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 637c4f40937..acad235c7f5 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ce4afd96dc1..47219f7525a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c63fe8a6336..48e5d8e1bc7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 f4543a2ad38..23b8f72b318 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1bbe621ec52..dc7b79fe5c5 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_output.getOutputUpdateCLIReminder.html b/docs/api/cli-kit/functions/node_output.getOutputUpdateCLIReminder.html index 7b301876f0b..53042388534 100644 --- a/docs/api/cli-kit/functions/node_output.getOutputUpdateCLIReminder.html +++ b/docs/api/cli-kit/functions/node_output.getOutputUpdateCLIReminder.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    The message to remind the user to update the CLI.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a7b61e2e563..5aea163654a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ccbccc057c9..ad8f83a69c6 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 83e4e2e0f5e..fd621af6760 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 af582506240..44274db968d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 88fd1f25a87..7d8f5f58d6e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 59bbb298c26..e9c07974843 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0a920096e6c..295c803d10a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 48b06b902cf..4a3315871fa 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 84f48fb1681..2e39e92cad3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6fc91b899e8..a69b0eef128 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ee919035977..898e214834c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d41068228c9..45cb13a4421 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9c9c0e5289b..4001cee4d19 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 22614a57572..67c030437ed 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 cd465269b66..7ba6b47ff25 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5ecf86d4fc7..de1c73870f6 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 2efba35a406..c3dc8837d15 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c44b22a6910..0b8792cba5b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c9363ec3229..33346c2affb 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e284ba216d6..eff9a04347d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3446946e281..8cd2ca5d46f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 063c50d41dc..67c0438f2cf 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ccf91215a61..211715b4178 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0ec680aaa17..527c1aeaabe 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 55e56b5dea3..64c508c8335 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 eeb92099e6a..306aac799fd 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

    Generated using TypeDoc

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

    Function defineProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c498aed2d93..e7d29fa56c7 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

    Generated using TypeDoc

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

    Function startTunnel

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c2b30953ef5..fd86579446c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c682b69302e..769a92a8d16 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 491b3155891..595b9e20c14 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 643b78d6ba3..6c2e671d08c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3e6eb75c3aa..e6d8e07ae59 100644 --- a/docs/api/cli-kit/functions/node_ruby.version.html +++ b/docs/api/cli-kit/functions/node_ruby.version.html @@ -1,2 +1,2 @@ version | @shopify/cli-kit

    Function version

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<string | undefined>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6825e2b5f59..83ab7e35078 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(schema): ZodTypeAny

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

      Parameters

      • schema: ZodTypeAny

        The schema to make strict.

      Returns ZodTypeAny

      The result strict schema.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 34626d4905f..09749d1aa9c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 f5db73c944e..5b8fda2909d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 782920f3f16..fc846a3e67d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 89bcdd1e6d2..05200b5405b 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<string>

    The access token for the Partners API.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9e49122d018..3e794b6bb46 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c7bce784e6c..9667f7e49e3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1a1797b200e..d39ca7a2032 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 955ed991e7f..604eea5b857 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3611aa0aa69..3e30fabf843 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 962ee468918..6f23e6b8d81 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 00ee10aa462..46b50e016ae 100644 --- a/docs/api/cli-kit/functions/node_system.sleep.html +++ b/docs/api/cli-kit/functions/node_system.sleep.html @@ -1,3 +1,3 @@ sleep | @shopify/cli-kit

    Function sleep

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/functions/node_system.terminalSupportsRawMode.html b/docs/api/cli-kit/functions/node_system.terminalSupportsRawMode.html index 17744e16a72..428f69b28e1 100644 --- a/docs/api/cli-kit/functions/node_system.terminalSupportsRawMode.html +++ b/docs/api/cli-kit/functions/node_system.terminalSupportsRawMode.html @@ -2,4 +2,4 @@ will be used.

    Parameters

    Returns boolean

    True in the selected input stream support raw mode.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 f15ee24d55f..e500b738daa 100644 --- a/docs/api/cli-kit/functions/node_tcp.checkPortAvailability.html +++ b/docs/api/cli-kit/functions/node_tcp.checkPortAvailability.html @@ -1,3 +1,3 @@ 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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 25faebb1a7e..226ebee1b45 100644 --- a/docs/api/cli-kit/functions/node_tcp.getAvailableTCPPort.html +++ b/docs/api/cli-kit/functions/node_tcp.getAvailableTCPPort.html @@ -4,4 +4,4 @@

    Returns Promise<number>

    A promise that resolves with an availabe port.

    Example
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a0b09362095..a1eb76c5996 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 eaf16e01fa1..fcc5ac82414 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns undefined | string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 92ae4d591a8..cb822e2c029 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

    Generated using TypeDoc

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

    Function render

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 2a248106163..b26e2b9b884 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 fdf26c26001..1ff5c60bb16 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ac78c0f8430..d0e59e38fd7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9b9ea2c28e1..ff8332e3ff9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c35ad43daac..4550b4993c9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<unknown>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 44dd8c5a055..2cd8383b385 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

    Generated using TypeDoc

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

    Function bulkUploadThemeAssets

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6a4b2b12896..6d11aa4c0f6 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

    Generated using TypeDoc

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

    Function createTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3ef62ce925f..e250e9ff9f0 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

    Generated using TypeDoc

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

    Function deleteTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1747d680af2..1d79ce03826 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

    Generated using TypeDoc

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

    Function deleteThemeAsset

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5b0e12474a5..f075c264777 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

    Generated using TypeDoc

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

    Function fetchChecksums

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 42eb10d03e4..3a8b912c9d1 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

    Generated using TypeDoc

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

    Function fetchTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ff5af2a05c7..de481e42261 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

    Generated using TypeDoc

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

    Function fetchThemeAsset

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b7c0ca612ff..44d46506b7f 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

    Generated using TypeDoc

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

    Function fetchThemes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0417aeec55e..22cecadaad9 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

    Generated using TypeDoc

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

    Function publishTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 85864513e1e..625194ada02 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

    Generated using TypeDoc

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

    Function updateTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 fafb30539a2..4dbda13aaef 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

    Generated using TypeDoc

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

    Function upgradeTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 be8b325a141..9e5c13da91a 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

    Generated using TypeDoc

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

    Function getHostTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 2dc3367a0c4..a5f075f742b 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

    Generated using TypeDoc

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

    Function hostThemeLocalStorage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 8120b2f2a70..ad7ae3c8b9b 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

    Generated using TypeDoc

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

    Function removeHostTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 2c81f9c3d2a..57055b8ec23 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

    Generated using TypeDoc

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

    Function setHostTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0c366b2362f..c9365efa6f8 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

    Generated using TypeDoc

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

    Function buildBulkUploadResults

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5d3779c6813..a2f620f244f 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

    Generated using TypeDoc

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

    Function buildChecksum

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 87777608fa8..35342304a82 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

    Generated using TypeDoc

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

    Function buildTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4ce933f7475..fe26febcb1b 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

    Generated using TypeDoc

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

    Function buildThemeAsset

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d04c22b6bcc..65e3ee65198 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

    Generated using TypeDoc

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

    Function codeEditorUrl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b10b2c630a5..431790a3214 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

    Generated using TypeDoc

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

    Function storeAdminUrl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b2b473ad995..79932efee5c 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

    Generated using TypeDoc

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

    Function themeEditorUrl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3eef6ac4290..bc4e2545ad3 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

    Generated using TypeDoc

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

    Function themePreviewUrl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 751cb409986..d1efe218273 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

    Generated using TypeDoc

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

    Function isDevelopmentTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 452aa94417f..d997fe057b7 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

    Generated using TypeDoc

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

    Function promptThemeName

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 06e8046ab61..e6a2075f77e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4a544db4e03..af43e80eb13 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 cb52a8d64ba..9451bd34452 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 7905d350acf..5f30eb62a82 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

    Generated using TypeDoc

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

    Function handleCtrlC

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 745ff44818e..1e523106b22 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<unknown>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 9931022d7fc..d4322f45ffc 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

    Generated using TypeDoc

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

    Function render

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 25d267ae683..95c261e67da 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 19490f5d089..09129d2eba8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3fad90e3563..0318c3d28cf 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 2edb1a29135..19a9288acb0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 8014f70fbe7..2bb78bd3055 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4b1a7c620e3..72f1ced1d8c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a8c84174113..0dd5cb2ad3c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d306accb43c..37e6d8d9779 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a45d764804f..6258941c9f8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5fb1f01d97f..66cef972bc8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 397bb01110a..aeb95fbe576 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 44ff1c9eeff..2595b5fe16b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 929b3ff388c..d02fa158961 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c9796cc8273..738327aeb73 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 362ce13eb68..1b419348e48 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns null | ReactElement<any, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1acf0aa7033..3d763bcf734 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 a1b58ab4204..251230d7128 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

    Generated using TypeDoc

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

    Function throttle

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 bccfa7ead84..3e8cdb33629 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

    Generated using TypeDoc

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

    Function isValidMetricName

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 cd35914ff4b..0cf0328db16 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5e0c4e2c67c..4218cb4687f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 2744e993c19..af303fdacd9 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLRequestOptions.html b/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLRequestOptions.html index cda70a854bf..7b8bdd12f74 100644 --- a/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLRequestOptions.html +++ b/docs/api/cli-kit/interfaces/node_api_graphql.GraphQLRequestOptions.html @@ -1,8 +1,8 @@ -GraphQLRequestOptions | @shopify/cli-kit

    Interface GraphQLRequestOptions<T>

    interface GraphQLRequestOptions<T> {
        addedHeaders?: {
            [header: string]: string;
        };
        api: string;
        query: RequestDocument;
        responseOptions?: GraphQLResponseOptions<T>;
        token?: string;
        url: string;
        variables?: Variables;
    }

    Type Parameters

    • T

    Properties

    addedHeaders? +GraphQLRequestOptions | @shopify/cli-kit

    Interface GraphQLRequestOptions<T>

    interface GraphQLRequestOptions<T> {
        addedHeaders?: {
            [header: string]: string;
        };
        api: string;
        query: RequestDocument;
        responseOptions?: GraphQLResponseOptions<T>;
        token?: string;
        url: string;
        variables?: Variables;
    }

    Type Parameters

    • T

    Properties

    addedHeaders? api query responseOptions? token? url variables? -

    Properties

    Optional addedHeaders

    addedHeaders?: {
        [header: string]: string;
    }

    Type declaration

    • [header: string]: string

    api

    api: string

    query

    query: RequestDocument

    Optional responseOptions

    responseOptions?: GraphQLResponseOptions<T>

    Optional token

    token?: string

    url

    url: string

    Optional variables

    variables?: Variables

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional addedHeaders

    addedHeaders?: {
        [header: string]: string;
    }

    Type declaration

    • [header: string]: string

    api

    api: string

    query

    query: RequestDocument

    Optional responseOptions

    responseOptions?: GraphQLResponseOptions<T>

    Optional token

    token?: string

    url

    url: string

    Optional variables

    variables?: Variables

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 115228ebdf3..3e9c59a1d46 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 9a1ed28bb78..b3a7a293953 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/interfaces/node_api_partners.FunctionUploadUrlGenerateResponse.html b/docs/api/cli-kit/interfaces/node_api_partners.FunctionUploadUrlGenerateResponse.html index a855a9b3085..8b3c8ed3b26 100644 --- a/docs/api/cli-kit/interfaces/node_api_partners.FunctionUploadUrlGenerateResponse.html +++ b/docs/api/cli-kit/interfaces/node_api_partners.FunctionUploadUrlGenerateResponse.html @@ -1,2 +1,2 @@ -FunctionUploadUrlGenerateResponse | @shopify/cli-kit

    Interface FunctionUploadUrlGenerateResponse

    interface FunctionUploadUrlGenerateResponse {
        functionUploadUrlGenerate: {
            generatedUrlDetails: {
                headers: {
                    [key: string]: string;
                };
                maxBytes: number;
                maxSize: string;
                moduleId: string;
                url: string;
            };
        };
    }

    Properties

    functionUploadUrlGenerate -

    Properties

    functionUploadUrlGenerate

    functionUploadUrlGenerate: {
        generatedUrlDetails: {
            headers: {
                [key: string]: string;
            };
            maxBytes: number;
            maxSize: string;
            moduleId: string;
            url: string;
        };
    }

    Type declaration

    • generatedUrlDetails: {
          headers: {
              [key: string]: string;
          };
          maxBytes: number;
          maxSize: string;
          moduleId: string;
          url: string;
      }
      • headers: {
            [key: string]: string;
        }
        • [key: string]: string
      • maxBytes: number
      • maxSize: string
      • moduleId: string
      • url: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface FunctionUploadUrlGenerateResponse

    interface FunctionUploadUrlGenerateResponse {
        functionUploadUrlGenerate: {
            generatedUrlDetails: {
                headers: {
                    [key: string]: string;
                };
                maxBytes: number;
                maxSize: string;
                moduleId: string;
                url: string;
            };
        };
    }

    Properties

    functionUploadUrlGenerate +

    Properties

    functionUploadUrlGenerate

    functionUploadUrlGenerate: {
        generatedUrlDetails: {
            headers: {
                [key: string]: string;
            };
            maxBytes: number;
            maxSize: string;
            moduleId: string;
            url: string;
        };
    }

    Type declaration

    • generatedUrlDetails: {
          headers: {
              [key: string]: string;
          };
          maxBytes: number;
          maxSize: string;
          moduleId: string;
          url: string;
      }
      • headers: {
            [key: string]: string;
        }
        • [key: string]: string
      • maxBytes: number
      • maxSize: string
      • moduleId: string
      • url: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 cc4a32edaa3..f408e25edfb 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 02ec08f26a8..cdc05459033 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 a36d9fd89b4..220bfb78476 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 715a37c1fab..3e5a4ce209f 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 32be9ace1eb..a03cc3105e3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional author

    author?: string

    Optional directory

    directory?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 54b595b5a42..ea345b40a34 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 560200d4d83..60c8d51ee16 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 c3057c44e55..d8f32559a9a 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 0cd060b4a2a..78ecaa5fbfe 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 bb9aae375d0..d2321fcb704 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 f6de0a47d90..d7175ba81cf 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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    alreadyInstalled

    alreadyInstalled: boolean

    install

    install: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 525f098cd24..3982cf69d7c 100644 --- a/docs/api/cli-kit/interfaces/node_metadata.RuntimeMetadataManager.html +++ b/docs/api/cli-kit/interfaces/node_metadata.RuntimeMetadataManager.html @@ -1,18 +1,18 @@ -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>

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

        -

        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 +

    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>

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

        -

        Parameters

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

        Returns Promise<void>

    getAllPublicMetadata

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

    Get a snapshot of the tracked public data.

    +

    Parameters

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

    Returns Promise<void>

    getAllPublicMetadata

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

    Get a snapshot of the tracked public data.

    Type declaration

      • (): Partial<TPublic>

      • Get a snapshot of the tracked public data.

        -

        Returns Partial<TPublic>

    getAllSensitiveMetadata

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

    Get a snapshot of the tracked sensitive data.

    +

    Returns Partial<TPublic>

    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.

    +

    Returns Partial<TSensitive>

    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>)

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

        -

        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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 ddcf9535c68..844bc69d4f3 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 b55351c39b3..255869d40e7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 2fe869fc7ab..1ce098812cd 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 b4f0bef234e..fb6c1ea0ce3 100644 --- a/docs/api/cli-kit/interfaces/node_output.OutputProcess.html +++ b/docs/api/cli-kit/interfaces/node_output.OutputProcess.html @@ -1,4 +1,4 @@ -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 @@ -6,6 +6,6 @@

    Type declaration

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

        -

        Parameters

        Returns Promise<void>

    prefix

    prefix: string

    The prefix to include in the logs +

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 0615e278ee0..7f81af43440 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 f2fa4f91466..4596ed9fb74 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 580b1f597c3..65c9d276ffb 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 8af814fc58a..439ac430ebe 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 83aa965a248..a42539c2d8f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    storeFqdn

    storeFqdn: string

    token

    token: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 75ab2302d3f..8de9207970a 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 0c00ac958d1..bec31a65833 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 65c322432d9..e351704d5ab 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

    Reresents the checksum value of the theme file.

    -

    key

    key: string

    Identifier of the theme file.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    key

    key: string

    Identifier of the theme file.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 d8bfd186c1e..ed52399e439 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.Result.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.Result.html @@ -1,12 +1,12 @@ Result | @shopify/cli-kit

    Interface Result

    Represents a single result for a upload or delete operation on a single file Each result includes the unique identifier for the file, the type of the operation, the sucesss status of the operation, any errors that occurred, and the asset value of the file.

    -
    interface Result {
        asset?: ThemeAsset;
        errors?: {
            asset?: string[];
        };
        key: string;
        operation: Operation;
        success: boolean;
    }

    Properties

    asset? +
    interface Result {
        asset?: ThemeAsset;
        errors?: {
            asset?: string[];
        };
        key: string;
        operation: Operation;
        success: boolean;
    }

    Properties

    asset? errors? key operation success -

    Properties

    Optional asset

    asset?: ThemeAsset

    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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional asset

    asset?: ThemeAsset

    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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 71f94cc84c2..9a3f9bd8567 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.Theme.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.Theme.html @@ -1,12 +1,12 @@ Theme | @shopify/cli-kit

    Interface Theme

    Represents a theme.

    -
    interface Theme {
        createdAtRuntime: boolean;
        id: number;
        name: string;
        processing: boolean;
        role: string;
    }

    Properties

    createdAtRuntime +
    interface Theme {
        createdAtRuntime: boolean;
        id: number;
        name: string;
        processing: boolean;
        role: string;
    }

    Properties

    createdAtRuntime id name processing role

    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.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 af81980c72c..12f7cea2df0 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.ThemeAsset.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.ThemeAsset.html @@ -1,10 +1,10 @@ ThemeAsset | @shopify/cli-kit

    Interface ThemeAsset

    Represents a file in a theme.

    -
    interface ThemeAsset {
        attachment?: string;
        checksum: string;
        key: string;
        value?: string;
    }

    Hierarchy (view full)

    Properties

    attachment? +
    interface ThemeAsset {
        attachment?: string;
        checksum: string;
        key: string;
        value?: string;
    }

    Hierarchy (view full)

    Properties

    attachment? checksum key value?

    Properties

    Optional attachment

    attachment?: string

    A base64-encoded image.

    -

    checksum

    checksum: string

    Reresents the checksum value of the theme file.

    -

    key

    key: string

    Identifier of the theme file.

    -

    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

    Generated using TypeDoc

    \ No newline at end of file +

    checksum

    checksum: string

    Reresents the checksum value of the theme file.

    +

    key

    key: string

    Identifier of the theme file.

    +

    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

    Generated using TypeDoc

    \ 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 395c499773e..6863ff72d3e 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystem.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.ThemeFileSystem.html @@ -1,6 +1,6 @@ ThemeFileSystem | @shopify/cli-kit

    Interface ThemeFileSystem

    Represents a theme on the file system.

    -
    interface ThemeFileSystem {
        files: Map<string, ThemeAsset>;
        root: string;
    }

    Properties

    files +
    interface ThemeFileSystem {
        files: Map<string, ThemeAsset>;
        root: string;
    }

    Properties

    files root

    Properties

    files

    files: Map<string, ThemeAsset>

    Local theme files.

    -

    root

    root: string

    The root path of the theme.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    root

    root: string

    The root path of the theme.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 204e7d866a7..f4e0156b683 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 195887f41c4..2979e6bbfda 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 2ab59592eca..cd6167f1cd2 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 790e938b020..a862f68acda 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 e86af33760b..63123305d44 100644 --- a/docs/api/cli-kit/interfaces/node_ui.RenderConcurrentOptions.html +++ b/docs/api/cli-kit/interfaces/node_ui.RenderConcurrentOptions.html @@ -1,6 +1,6 @@ -RenderConcurrentOptions | @shopify/cli-kit

    Interface RenderConcurrentOptions

    interface RenderConcurrentOptions {
        abortSignal?: AbortSignal;
        keepRunningAfterProcessesResolve?: boolean;
        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;
        processes: OutputProcess[];
        renderOptions?: RenderOptions;
        showTimestamps?: boolean;
    }

    Hierarchy

    • PartialBy<ConcurrentOutputProps, "abortSignal">
      • RenderConcurrentOptions

    Properties

    abortSignal? keepRunningAfterProcessesResolve? processes renderOptions? showTimestamps? -

    Properties

    Optional abortSignal

    abortSignal?: AbortSignal

    Optional keepRunningAfterProcessesResolve

    keepRunningAfterProcessesResolve?: boolean

    processes

    processes: OutputProcess[]

    Optional renderOptions

    renderOptions?: RenderOptions

    Optional showTimestamps

    showTimestamps?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional abortSignal

    abortSignal?: AbortSignal

    Optional keepRunningAfterProcessesResolve

    keepRunningAfterProcessesResolve?: boolean

    processes

    processes: OutputProcess[]

    Optional renderOptions

    renderOptions?: RenderOptions

    Optional showTimestamps

    showTimestamps?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 bf8f6f8eabb..af73fd04552 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 4a2b502bd0d..3ffd5ef495b 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 77a38f95434..22379799eb0 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 5b41634b8c3..150953d34ad 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;
        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;
        message: string;
        password?: boolean;
        preview?: ((value) => TokenItem<InlineToken>);
        renderOptions?: RenderOptions;
        validate?: ((value) => undefined | string);
    }

    Hierarchy

    • Omit<TextPromptProps, "onSubmit">
      • RenderTextPromptOptions

    Properties

    abortSignal? allowEmpty? defaultValue? emptyDisplayedValue? @@ -7,4 +7,4 @@ preview? renderOptions? validate? -

    Properties

    Optional abortSignal

    abortSignal?: AbortSignal

    Optional allowEmpty

    allowEmpty?: boolean

    Optional defaultValue

    defaultValue?: string

    Optional emptyDisplayedValue

    emptyDisplayedValue?: 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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional abortSignal

    abortSignal?: AbortSignal

    Optional allowEmpty

    allowEmpty?: boolean

    Optional defaultValue

    defaultValue?: string

    Optional emptyDisplayedValue

    emptyDisplayedValue?: 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

    Generated using TypeDoc

    \ 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 b836c5ddd75..61d5f5fbcff 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 d864ceea6de..35b1849e5c0 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 b75eb586e5b..2d24e99ea35 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 f8aa3baff33..63788a88c16 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 2a7376508c7..51cba4d5515 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 86682488aa9..8442697bd91 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns (() => void)

    addView

    getMeterProvider

    record

    register

    registerMetric

    removeOnRecord

    shutdown

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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 41518f46afa..36560b60e84 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 d35b69b909b..cd561760162 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

    Generated using TypeDoc

    \ 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 bbf7095bb6d..18e961c8bbe 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

    Generated using TypeDoc

    \ 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 b5ef24bd3fd..142e7655fc2 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

    Generated using TypeDoc

    \ 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 b7a851c6ed2..ebd055f6c90 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 43384cd2d87..92ad294cc95 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

    Generated using TypeDoc

    \ 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 5fc42605d9f..4e5e3a838ff 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 9f959b4eb60..5ec27456d8d 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

    Generated using TypeDoc

    \ 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 3d7855ee070..6aeeb037e85 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

    Generated using TypeDoc

    \ 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 4eba7050c78..4aa96752c76 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

    Generated using TypeDoc

    \ 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 2685a2808ac..d9baffffce9 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

    Generated using TypeDoc

    \ 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 5e1ff0c0827..dac2c3c29bd 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

    Generated using TypeDoc

    \ 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 0918efce296..02b53ba5fc9 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

    Generated using TypeDoc

    \ 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 7c86adf75a5..c08edefda4c 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_business_platform.html b/docs/api/cli-kit/modules/node_api_business_platform.html index 2707caba149..fe2be4fc437 100644 --- a/docs/api/cli-kit/modules/node_api_business_platform.html +++ b/docs/api/cli-kit/modules/node_api_business_platform.html @@ -1,2 +1,2 @@ -node/api/business-platform | @shopify/cli-kit

    Module node/api/business-platform

    Index

    Functions

    businessPlatformRequest +node/api/business-platform | @shopify/cli-kit

    Module node/api/business-platform

    Index

    Functions

    businessPlatformRequest

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_api_graphql.html b/docs/api/cli-kit/modules/node_api_graphql.html index 08a73fd1357..6f2e64b8d97 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

    GraphQLRequestOptions +node/api/graphql | @shopify/cli-kit

    Module node/api/graphql

    Index

    Interfaces

    GraphQLRequestOptions GraphQLResponseOptions GraphQLVariables

    Type Aliases

    GraphQLResponse diff --git a/docs/api/cli-kit/modules/node_api_http.html b/docs/api/cli-kit/modules/node_api_http.html index 444ff278b4e..07fdd3211e7 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

    Generated using TypeDoc

    \ No newline at end of file +node/api/http | @shopify/cli-kit

    Module node/api/http

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1823d3b7f15..3d21c0c6f1e 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

    Interfaces

    FunctionUploadUrlGenerateResponse +node/api/partners | @shopify/cli-kit

    Module node/api/partners

    Index

    Interfaces

    FunctionUploadUrlGenerateResponse

    Variables

    FunctionUploadUrlGenerateMutation

    Functions

    getFunctionUploadUrl handleDeprecations diff --git a/docs/api/cli-kit/modules/node_api_shopify_developers.html b/docs/api/cli-kit/modules/node_api_shopify_developers.html index 5ece364b51b..ed279f8a52e 100644 --- a/docs/api/cli-kit/modules/node_api_shopify_developers.html +++ b/docs/api/cli-kit/modules/node_api_shopify_developers.html @@ -1,3 +1,3 @@ -node/api/shopify-developers | @shopify/cli-kit

    Module node/api/shopify-developers

    Index

    Functions

    handleDeprecations +node/api/shopify-developers | @shopify/cli-kit

    Module node/api/shopify-developers

    Index

    Functions

    handleDeprecations orgScopedShopifyDevelopersRequest

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e139f3ed17b..e86b4580c7c 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

    Generated using TypeDoc

    \ 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 85f102280b1..a6eefed2031 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

    Generated using TypeDoc

    \ 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 9c0efb2f4e7..80f1b46420f 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 fdcaf914925..73e0c6d54eb 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

    Generated using TypeDoc

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

    Module node/colors

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ab81f4cf0de..9e2769df306 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 359bcbcf22f..ca29076ad48 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 f1134d07892..671dee1c2c1 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 701ffcde534..82a8780ba1b 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

    Generated using TypeDoc

    \ 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 0efa8c1e7a2..1f740a914a2 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 randomBytes 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 e4a932aa298..86ebc0ca5fd 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

    Generated using TypeDoc

    \ 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 50d0a2f431f..442cb242f52 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 baf8eb840f8..1bc1064929b 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 eb6dea2af17..749f0c08f2a 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

    Generated using TypeDoc

    \ 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 980c249bed7..d5ea8ca3ba4 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 30f81586f7d..829f2fcc923 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 df103a984f1..51f19ce7bbd 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

    Generated using TypeDoc

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

    Module node/figures

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 076add503ba..8eb72c71764 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

    Generated using TypeDoc

    \ 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 b65867fd87b..b1abe09ca0f 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 f4734d8ff5b..db9f720d7c4 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 22999a7a181..e7f5e25d20a 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 d6a431e09ca..697ab332f9a 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

    Generated using TypeDoc

    \ 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 8a2d2107ae8..b1ed4448eb0 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

    Generated using TypeDoc

    \ 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 64a51ba0f48..17872e42c19 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 f97fcdd2f72..292a4b22d16 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

    Type Aliases

    Response +node/http | @shopify/cli-kit

    Module node/http

    Index

    Type Aliases

    Response

    Functions

    downloadFile fetch formData diff --git a/docs/api/cli-kit/modules/node_ink.html b/docs/api/cli-kit/modules/node_ink.html index 11530ec4404..19ca0e002d9 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

    Generated using TypeDoc

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

    Module node/ink

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d9cabdab50b..8a98ddfabe3 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_liquid.html b/docs/api/cli-kit/modules/node_liquid.html index 4a778f54b4e..3981343771c 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

    Generated using TypeDoc

    \ 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 d0f264ced0b..4b2d395de2a 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

    Generated using TypeDoc

    \ 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 37227c2ec7c..4a9cecd536e 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 e0a052d873f..82f2879052a 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

    Generated using TypeDoc

    \ 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 8b8fed173eb..fc29774359d 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 08117dcfa23..3bc55b2a49f 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 15a0bc9d707..e467c8d86c1 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

    Generated using TypeDoc

    \ 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 66462b8dc05..32b37df3f05 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 58ee2ded491..d9dd7df4ca0 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 2d3d8944235..d028a183063 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 db59ad77a2a..bf7f2baf18a 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_result.html b/docs/api/cli-kit/modules/node_result.html index 2c5a892fda8..e3364db43a7 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 44c47706660..afacb1b902e 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 cb7fb5123a7..e735da2eb9f 100644 --- a/docs/api/cli-kit/modules/node_schema.html +++ b/docs/api/cli-kit/modules/node_schema.html @@ -1,3 +1,3 @@ -node/schema | @shopify/cli-kit

    Module node/schema

    Index

    Functions

    deepStrict +node/schema | @shopify/cli-kit

    Module node/schema

    Index

    Functions

    deepStrict errorsToString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_session.html b/docs/api/cli-kit/modules/node_session.html index f45b0c97c61..d030e7678f1 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 ensureAuthenticatedBusinessPlatform ensureAuthenticatedPartners diff --git a/docs/api/cli-kit/modules/node_system.html b/docs/api/cli-kit/modules/node_system.html index 98dcc8a4962..7596f500a11 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 851a6bcc612..8a98e1f697b 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

    Generated using TypeDoc

    \ 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 f9f152bb090..6fcf4cc97e1 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

    Generated using TypeDoc

    \ 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 10746a0984a..48a67636654 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 88e6d5f3439..0bc33271f05 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 50ff1bb7db1..9d52960db09 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 3150c19c76f..743a7dcd77f 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 33e05fbb958..501438b081c 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

    Generated using TypeDoc

    \ 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 d60e214242c..d8e892dd64d 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 1b4bfe50a6a..c89410ad634 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 388220433aa..8ff9836862b 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 c5af1c03b5b..7b76e2ddc41 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

    Generated using TypeDoc

    \ 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 41fa8ba2274..e65f4b8b610 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

    Generated using TypeDoc

    \ 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 0eda7408d9c..9c63a5583c0 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 89aed39598e..eb9598b7e04 100644 --- a/docs/api/cli-kit/modules/node_ui_components.html +++ b/docs/api/cli-kit/modules/node_ui_components.html @@ -1,2 +1,2 @@ -node/ui/components | @shopify/cli-kit

    Module node/ui/components

    Index

    Functions

    ConcurrentOutput +node/ui/components | @shopify/cli-kit

    Module node/ui/components

    Index

    Functions

    ConcurrentOutput

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 659ad56389a..f9c6b7f7e9c 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

    Generated using TypeDoc

    \ 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 c5f41cca9f8..88e13d822b3 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

    Generated using TypeDoc

    \ 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 bb979bd750e..abbd7152691 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

    Generated using TypeDoc

    \ 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 6eb84eddcc4..16301fcd6b1 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

    Generated using TypeDoc

    \ 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 ad164a55faf..acad7964668 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

    Generated using TypeDoc

    \ 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 3b88f3d4980..84297837e0d 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 8f8b05890a7..acb0121fc19 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

    Generated using TypeDoc

    \ 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 77375a8c998..1c17f9278dd 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

    Generated using TypeDoc

    \ 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 bbe2f767b31..1a753ed5a18 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

    Generated using TypeDoc

    \ 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 fd8376aadf5..9ca606f2de2 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

    Generated using TypeDoc

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

    Type alias RandomNameFamily

    RandomNameFamily: "business" | "creative"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 8525ef95ba5..a8b0ec31829 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 @@ -2,4 +2,4 @@ 
    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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 34fa8d7502e..4c9f35610f4 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 @@ -2,4 +2,4 @@ 
    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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TMapping

    • TPrefix extends string

    • TKeys extends keyof TMapping = never

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 fb5faffd65c..9f96c95c348 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

    Generated using TypeDoc

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

    Type alias CommandExitMode

    CommandExitMode: "ok" | "unexpected_error" | "expected_error"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0f6c6e86898..be8d2eb9678 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 08dac213edc..293370e2cf9 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

    Generated using TypeDoc

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

    Type alias CIMetadata

    CIMetadata: Metadata

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1bebff8d101..5185b78fcec 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/types/node_http.Response.html b/docs/api/cli-kit/types/node_http.Response.html index 2d69f53266d..2d0b1896ef4 100644 --- a/docs/api/cli-kit/types/node_http.Response.html +++ b/docs/api/cli-kit/types/node_http.Response.html @@ -1 +1 @@ -Response | @shopify/cli-kit

    Type alias Response

    Response: ReturnType<typeof nodeFetch>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Response

    Response: ReturnType<typeof nodeFetch>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a6401d856ab..3b1cd60de93 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

    Generated using TypeDoc

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

    Type alias Public

    Public: PublicSchema<typeof coreData>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 b85c75cd73a..5d6c836dd73 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 0c3d1fcfb49..597bf466750 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

    Generated using TypeDoc

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

    Type alias Sensitive

    Sensitive: SensitiveSchema<typeof coreData>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3996d9f3b0d..191ca9fe5ac 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 d89ac0cd7f8..f501e975828 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 6cbd63270f1..f1f4ff4ae55 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

    Generated using TypeDoc

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

    Type alias MonorailEventSensitive

    MonorailEventSensitive: Schemas[typeof MONORAIL_COMMAND_TOPIC]["sensitive"]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 357fc762999..51279a8e663 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 21ff2688053..dd290053c4e 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 a70759664e0..9f0cb41f61c 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

    Generated using TypeDoc

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

    Type alias PackageManager

    PackageManager: typeof packageManager[number]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 47a56a48110..d011a95603f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d971a031a0c..6b77e7170b3 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 e3936eb07f0..31253d7f316 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

    Generated using TypeDoc

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

    Type alias OutputMessage

    OutputMessage: string | TokenizedString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 44fcadf2443..f43a339ad1e 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 981f52c6dc1..e2adf06b95c 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 fef860752af..68dd12c84cc 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 0d728558afc..2dc8e0eb4e1 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

    Generated using TypeDoc

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

    Type alias TunnelProviderFunction

    TunnelProviderFunction: FanoutHookFunction<"tunnel_provider", "">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 93389b579ae..b3fd7716239 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

    Generated using TypeDoc

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

    Type alias TunnelStartAction

    TunnelStartAction: ((port) => Promise<TunnelStartReturn>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 0c6e9d981cb..69ffe2cfd9c 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

    Generated using TypeDoc

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

    Type alias TunnelStartFunction

    TunnelStartFunction: FanoutHookFunction<"tunnel_start", "">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 07ce4412938..daf9e413017 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

    Generated using TypeDoc

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

    Type alias TunnelStartReturn

    TunnelStartReturn: PluginReturnsForHook<"tunnel_start", "">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ad6947eab2c..c8268e70c5e 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 4844c51e356..8dcb131be68 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 f7fe9976e74..9c97e995ab2 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 c60fe525ea2..b7bc46a3c37 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">>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ThemeParams

    ThemeParams: Partial<Pick<Theme, "name" | "role" | "processing">>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 d13b353d9c9..dc59ed07179 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 096a2a73eda..de1b8dab279 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 32b9ef1ce79..7e3208dc84f 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

    Generated using TypeDoc

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

    Type alias JsonMapType

    JsonMapType: JsonMap

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 ed9f941b8ba..93dc12f4934 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

    Generated using TypeDoc

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

    Type alias AlertCustomSection

    AlertCustomSection: CustomSection

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 adffa378d2f..d76d7d51f23 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

    Generated using TypeDoc

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

    Type alias InfoMessage

    InfoMessage: InfoMessageProps["message"]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 80ffd8cc557..fb4eb1c18f7 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

    Generated using TypeDoc

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

    Type alias InlineToken

    InlineToken: Exclude<Token, ListToken>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 477db63c76d..50e6daea626 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

    Generated using TypeDoc

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

    Type alias Key

    Key: InkKey

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 2940d41e901..658af7408a1 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

    Generated using TypeDoc

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

    Type alias RenderAlertOptions

    RenderAlertOptions: Omit<AlertOptions, "type">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 44117dac5ae..9968e357a8b 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 6ac1a220bb7..d1f939f82a4 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

    • T extends Token = Token

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TokenItem<T>

    TokenItem<T>: T | T[]

    Type Parameters

    • T extends Token = Token

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 3f529eb1186..14214f8d30e 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

    Generated using TypeDoc

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

    Type alias Environment

    Environment: "production" | "staging" | "local"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 578f545b578..95fe16afc40 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 e9e2c97ecdf..45118e11b55 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 35a87930c6b..5dbd8086e91 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

    Generated using TypeDoc

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

    Type alias MetricInstrument

    MetricInstrument: Histogram | Counter | UpDownCounter

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 84dd1dc3652..a8701d14f8f 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 5530c77b6ff..16af467c13a 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 38c9380f682..4a7a7e9eb80 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 dd0062d5315..4d1d8c32d1d 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.59.1" = '3.59.1'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable CLI_KIT_VERSIONConst

    CLI_KIT_VERSION: "3.59.2" = '3.59.2'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/variables/node_api_partners.FunctionUploadUrlGenerateMutation.html b/docs/api/cli-kit/variables/node_api_partners.FunctionUploadUrlGenerateMutation.html index 01acaee8ec8..65d423d1ae7 100644 --- a/docs/api/cli-kit/variables/node_api_partners.FunctionUploadUrlGenerateMutation.html +++ b/docs/api/cli-kit/variables/node_api_partners.FunctionUploadUrlGenerateMutation.html @@ -1 +1 @@ -FunctionUploadUrlGenerateMutation | @shopify/cli-kit

    Variable FunctionUploadUrlGenerateMutationConst

    FunctionUploadUrlGenerateMutation: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable FunctionUploadUrlGenerateMutationConst

    FunctionUploadUrlGenerateMutation: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 8fa06bce698..b3c95be5ae0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • no-color: BooleanFlag<boolean>
    • verbose: BooleanFlag<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 299ade3fc9e..2a2bc5a951c 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

    Generated using TypeDoc

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

    Variable CouldntObtainIdentitySpinFQDNErrorConst

    CouldntObtainIdentitySpinFQDNError: AbortError = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 43e031fd781..a8c7455596c 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

    Generated using TypeDoc

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

    Variable CouldntObtainPartnersSpinFQDNErrorConst

    CouldntObtainPartnersSpinFQDNError: AbortError = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1c9cdb6ec91..eb9ed7a457a 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

    Generated using TypeDoc

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

    Variable CouldntObtainShopifySpinFQDNErrorConst

    CouldntObtainShopifySpinFQDNError: AbortError = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 62e0b5fae6d..7523f402db8 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

    Generated using TypeDoc

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

    Variable NotProvidedStoreFQDNErrorConst

    NotProvidedStoreFQDNError: AbortError = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6fb6a30dcd7..f8ee6d888fd 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 27f65825ee8..d5d5f8ad2f6 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" = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable MONORAIL_COMMAND_TOPICConst

    MONORAIL_COMMAND_TOPIC: "app_cli3_command/1.12" = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e3be1069de2..736285ef55c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 789023ee9d2..e58775d3491 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 a7db7982d0b..fea0e4df67f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 8e1a75c4935..ad462a2f42b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 048952f8332..c4ed10a941d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 e6531ecc295..0e8ac896c58 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 62ba4d19484..834c7c41baf 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 1a07fd6d4cf..de482d0a8c8 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 f1443915c18..006df2b956b 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;
        green(value): ColorContentToken;
        heading(value): HeadingContentToken;
        italic(value): ItalicContentToken;
        json(value): JsonContentToken;
        linesDiff(value): LinesDiffContentToken;
        link(value, link): 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

    Generated using TypeDoc

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

    Variable outputTokenConst

    outputToken: {
        cyan(value): ColorContentToken;
        errorText(value): ErrorContentToken;
        failIcon(): ErrorContentToken;
        genericShellCommand(value): CommandContentToken;
        green(value): ColorContentToken;
        heading(value): HeadingContentToken;
        italic(value): ItalicContentToken;
        json(value): JsonContentToken;
        linesDiff(value): LinesDiffContentToken;
        link(value, link): 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

    Generated using TypeDoc

    \ 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 a7c4330e3f7..7e8c26ccbcb 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

    Generated using TypeDoc

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

    Variable MinWdmWindowsVersionConst

    MinWdmWindowsVersion: "0.1.0" = '0.1.0'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 80b8c0225a6..1054d3166e6 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

    Generated using TypeDoc

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

    Variable RubyCLIVersionConst

    RubyCLIVersion: "2.35.0" = '2.35.0'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 c65117ea5e9..a794b1c635a 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 f8de356cdb0..4e83614d588 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 c5d97a2a13f..118b12352d9 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/app/CHANGELOG.md b/packages/app/CHANGELOG.md index 2fb46cdc55c..c0b2bac9489 100644 --- a/packages/app/CHANGELOG.md +++ b/packages/app/CHANGELOG.md @@ -1,5 +1,15 @@ # @shopify/app +## 3.59.2 + +### Patch Changes + +- 4a22b9e49: Fix react version mismatch error +- Updated dependencies [4a22b9e49] + - @shopify/plugin-cloudflare@3.59.2 + - @shopify/create-app@3.59.2 + - @shopify/cli-kit@3.59.2 + ## 3.59.1 ### Patch Changes diff --git a/packages/app/package.json b/packages/app/package.json index ff2bb06797d..2a4cce795b2 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/app", - "version": "3.59.1", + "version": "3.59.2", "description": "Utilities for loading, building, and publishing apps.", "homepage": "https://github.com/shopify/cli#readme", "private": true, @@ -49,10 +49,10 @@ "dependencies": { "@luckycatfactory/esbuild-graphql-loader": "3.8.1", "@oclif/core": "3.23.0", - "@shopify/cli-kit": "3.59.1", - "@shopify/create-app": "3.59.1", + "@shopify/cli-kit": "3.59.2", + "@shopify/create-app": "3.59.2", "@shopify/function-runner": "4.1.1", - "@shopify/plugin-cloudflare": "3.59.1", + "@shopify/plugin-cloudflare": "3.59.2", "@shopify/polaris": "12.10.0", "@shopify/polaris-icons": "8.0.0", "@shopify/theme-check-node": "2.5.0", diff --git a/packages/cli-kit/CHANGELOG.md b/packages/cli-kit/CHANGELOG.md index 6afa3092217..63430f1eb23 100644 --- a/packages/cli-kit/CHANGELOG.md +++ b/packages/cli-kit/CHANGELOG.md @@ -1,5 +1,11 @@ # @shopify/cli-kit +## 3.59.2 + +### Patch Changes + +- 4a22b9e49: Fix react version mismatch error + ## 3.59.1 ## 3.59.0 diff --git a/packages/cli-kit/package.json b/packages/cli-kit/package.json index 341825fa5ba..7d3972fba6a 100644 --- a/packages/cli-kit/package.json +++ b/packages/cli-kit/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/cli-kit", - "version": "3.59.1", + "version": "3.59.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 e260a5b8332..e8e36189f64 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.59.1' +export const CLI_KIT_VERSION = '3.59.2' diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index 02ae9a3e9ad..617d50491c9 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -1,5 +1,21 @@ # @shopify/cli +## 3.59.2 + +### Patch Changes + +- d82d4a46b: Add clean & build steps to stable shipit config +- 4a22b9e49: Fix react version mismatch error +- Updated dependencies [a5c2d79f4] +- Updated dependencies [bdefb650b] +- Updated dependencies [4a22b9e49] +- Updated dependencies [ddff21db0] + - @shopify/theme@3.59.2 + - @shopify/plugin-did-you-mean@3.59.2 + - @shopify/plugin-cloudflare@3.59.2 + - @shopify/cli-kit@3.59.2 + - @shopify/app@3.59.2 + ## 3.59.1 ### Patch Changes diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json index 7c40eb30002..8acd9cec6bc 100644 --- a/packages/cli/oclif.manifest.json +++ b/packages/cli/oclif.manifest.json @@ -4375,5 +4375,5 @@ "summary": "Trigger delivery of a sample webhook topic payload to a designated address." } }, - "version": "3.59.1" + "version": "3.59.2" } \ No newline at end of file diff --git a/packages/cli/package.json b/packages/cli/package.json index ad6bf4b6400..0ab8be5ad43 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/cli", - "version": "3.59.1", + "version": "3.59.2", "private": false, "description": "A CLI tool to build for the Shopify platform", "keywords": [ @@ -98,17 +98,17 @@ "@oclif/core": "3.23.0", "@oclif/plugin-commands": "3.3.0", "@oclif/plugin-plugins": "4.3.8", - "@shopify/app": "3.59.1", - "@shopify/cli-kit": "3.59.1", - "@shopify/plugin-cloudflare": "3.59.1", - "@shopify/plugin-did-you-mean": "3.59.1", - "@shopify/theme": "3.59.1", + "@shopify/app": "3.59.2", + "@shopify/cli-kit": "3.59.2", + "@shopify/plugin-cloudflare": "3.59.2", + "@shopify/plugin-did-you-mean": "3.59.2", + "@shopify/theme": "3.59.2", "esbuild": "0.19.8", "zod-to-json-schema": "3.21.4" }, "devDependencies": { - "@shopify/app": "3.59.1", - "@shopify/theme": "3.59.1", + "@shopify/app": "3.59.2", + "@shopify/theme": "3.59.2", "@types/node": "18.19.3", "@vitest/coverage-istanbul": "^0.34.3", "@chialab/esbuild-plugin-require-resolve": "^0.18.0", diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md index f371dadc56e..41886e4894d 100644 --- a/packages/create-app/CHANGELOG.md +++ b/packages/create-app/CHANGELOG.md @@ -1,5 +1,13 @@ # @shopify/create-app +## 3.59.2 + +### Patch Changes + +- 4a22b9e49: Fix react version mismatch error +- Updated dependencies [4a22b9e49] + - @shopify/cli-kit@3.59.2 + ## 3.59.1 ### Patch Changes diff --git a/packages/create-app/oclif.manifest.json b/packages/create-app/oclif.manifest.json index 42804dc96be..ca7318cc4c6 100644 --- a/packages/create-app/oclif.manifest.json +++ b/packages/create-app/oclif.manifest.json @@ -98,5 +98,5 @@ "summary": "Create a new app project" } }, - "version": "3.59.1" + "version": "3.59.2" } \ No newline at end of file diff --git a/packages/create-app/package.json b/packages/create-app/package.json index 26560a019d9..ce179c74a14 100644 --- a/packages/create-app/package.json +++ b/packages/create-app/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/create-app", - "version": "3.59.1", + "version": "3.59.2", "private": false, "description": "A CLI tool to create a new Shopify app.", "keywords": [ @@ -55,7 +55,7 @@ }, "dependencies": { "@oclif/core": "3.23.0", - "@shopify/cli-kit": "3.59.1" + "@shopify/cli-kit": "3.59.2" }, "devDependencies": { "@types/node": "18.19.3", diff --git a/packages/plugin-cloudflare/CHANGELOG.md b/packages/plugin-cloudflare/CHANGELOG.md index 97becb7ae00..c6db04ce6af 100644 --- a/packages/plugin-cloudflare/CHANGELOG.md +++ b/packages/plugin-cloudflare/CHANGELOG.md @@ -1,5 +1,13 @@ # @shopify/plugin-cloudflare +## 3.59.2 + +### Patch Changes + +- 4a22b9e49: Fix react version mismatch error +- Updated dependencies [4a22b9e49] + - @shopify/cli-kit@3.59.2 + ## 3.59.1 ### Patch Changes diff --git a/packages/plugin-cloudflare/package.json b/packages/plugin-cloudflare/package.json index 6ec3c43877f..64cfa9971bc 100644 --- a/packages/plugin-cloudflare/package.json +++ b/packages/plugin-cloudflare/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/plugin-cloudflare", - "version": "3.59.1", + "version": "3.59.2", "description": "Enables the creation of Cloudflare tunnels from `shopify app dev`, allowing previews from any device", "keywords": [ "shopify", @@ -42,7 +42,7 @@ }, "dependencies": { "@oclif/core": "3.23.0", - "@shopify/cli-kit": "3.59.1" + "@shopify/cli-kit": "3.59.2" }, "devDependencies": { "@vitest/coverage-istanbul": "^0.34.3", diff --git a/packages/plugin-did-you-mean/CHANGELOG.md b/packages/plugin-did-you-mean/CHANGELOG.md index 4d07458d55b..68ff4f25c87 100644 --- a/packages/plugin-did-you-mean/CHANGELOG.md +++ b/packages/plugin-did-you-mean/CHANGELOG.md @@ -1,5 +1,13 @@ # @shopify/plugin-did-you-mean +## 3.59.2 + +### Patch Changes + +- 4a22b9e49: Fix react version mismatch error +- Updated dependencies [4a22b9e49] + - @shopify/cli-kit@3.59.2 + ## 3.59.1 ### Patch Changes diff --git a/packages/plugin-did-you-mean/package.json b/packages/plugin-did-you-mean/package.json index 73a349e8f26..3c7e6a557a2 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.59.1", + "version": "3.59.2", "private": true, "bugs": { "url": "https://github.com/Shopify/cli/issues" @@ -37,7 +37,7 @@ }, "dependencies": { "@oclif/core": "3.23.0", - "@shopify/cli-kit": "3.59.1", + "@shopify/cli-kit": "3.59.2", "n-gram": "2.0.2" }, "devDependencies": { diff --git a/packages/theme/CHANGELOG.md b/packages/theme/CHANGELOG.md index c2f4ed94798..670bf2416eb 100644 --- a/packages/theme/CHANGELOG.md +++ b/packages/theme/CHANGELOG.md @@ -1,5 +1,16 @@ # @shopify/theme +## 3.59.2 + +### Patch Changes + +- a5c2d79f4: - Fix the `shopify theme dev` proxy to use the development theme, even when users have a browser session with the live theme loaded +- bdefb650b: Fix unpublished themes being marked as development themes +- 4a22b9e49: Fix react version mismatch error +- ddff21db0: Fix issue that prevents `shopify theme console` from evaluating results when another 'preview_theme_id' is set +- Updated dependencies [4a22b9e49] + - @shopify/cli-kit@3.59.2 + ## 3.59.1 ### Patch Changes diff --git a/packages/theme/package.json b/packages/theme/package.json index 986d6b5de42..60672eb449d 100644 --- a/packages/theme/package.json +++ b/packages/theme/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/theme", - "version": "3.59.1", + "version": "3.59.2", "private": true, "description": "Utilities for building and publishing themes", "homepage": "https://github.com/shopify/cli#readme", @@ -40,7 +40,7 @@ }, "dependencies": { "@oclif/core": "3.23.0", - "@shopify/cli-kit": "3.59.1", + "@shopify/cli-kit": "3.59.2", "@shopify/theme-check-node": "2.5.0", "@shopify/theme-language-server-node": "1.11.0", "yaml": "2.3.2" diff --git a/packages/ui-extensions-dev-console/CHANGELOG.md b/packages/ui-extensions-dev-console/CHANGELOG.md index 8f92965cde7..9fdeb0d3620 100644 --- a/packages/ui-extensions-dev-console/CHANGELOG.md +++ b/packages/ui-extensions-dev-console/CHANGELOG.md @@ -1,5 +1,11 @@ # @shopify/ui-extensions-dev-console-app +## 3.59.2 + +### Patch Changes + +- 4a22b9e49: Fix react version mismatch error + ## 3.59.1 ## 3.59.0 diff --git a/packages/ui-extensions-dev-console/package.json b/packages/ui-extensions-dev-console/package.json index 8f46f194dee..70704d76256 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.59.1", + "version": "3.59.2", "private": true, "scripts": { "build": "nx build", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 96589e25c7d..2bcd8348d08 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -135,16 +135,16 @@ importers: specifier: 3.23.0 version: 3.23.0 '@shopify/cli-kit': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../cli-kit '@shopify/create-app': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../create-app '@shopify/function-runner': specifier: 4.1.1 version: 4.1.1 '@shopify/plugin-cloudflare': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../plugin-cloudflare '@shopify/polaris': specifier: 12.10.0 @@ -244,19 +244,19 @@ importers: specifier: 4.3.8 version: 4.3.8 '@shopify/app': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../app '@shopify/cli-kit': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../cli-kit '@shopify/plugin-cloudflare': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../plugin-cloudflare '@shopify/plugin-did-you-mean': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../plugin-did-you-mean '@shopify/theme': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../theme esbuild: specifier: 0.19.8 @@ -504,7 +504,7 @@ importers: specifier: 3.23.0 version: 3.23.0 '@shopify/cli-kit': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../cli-kit devDependencies: '@types/node': @@ -629,7 +629,7 @@ importers: specifier: 3.23.0 version: 3.23.0 '@shopify/cli-kit': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../cli-kit devDependencies: '@vitest/coverage-istanbul': @@ -645,7 +645,7 @@ importers: specifier: 3.23.0 version: 3.23.0 '@shopify/cli-kit': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../cli-kit n-gram: specifier: 2.0.2 @@ -664,7 +664,7 @@ importers: specifier: 3.23.0 version: 3.23.0 '@shopify/cli-kit': - specifier: 3.59.1 + specifier: 3.59.2 version: link:../cli-kit '@shopify/theme-check-node': specifier: 2.5.0