From 67fa4ef33eaafb628caed2c23bca522d1b84f7ee Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 12 Feb 2024 16:14:04 +0000 Subject: [PATCH] Version Packages --- .changeset/khaki-waves-worry.md | 5 -- .../classes/node_abort.AbortController.html | 2 +- .../classes/node_abort.AbortSignal.html | 2 +- .../classes/node_base_command.default.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 +- ...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 +- .../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.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 +- .../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 +- ...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 +- .../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 +- .../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.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 +- ...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 +- .../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.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 +- .../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 +- .../node_themes_types.BulkUploadResult.html | 10 +-- .../node_themes_types.Checksum.html | 6 +- .../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 +- 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 +- 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_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_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 +- .../variables/node_cli.globalFlags.html | 2 +- ...dn.CouldntObtainIdentitySpinFQDNError.html | 2 +- ...dn.CouldntObtainPartnersSpinFQDNError.html | 2 +- ...qdn.CouldntObtainShopifySpinFQDNError.html | 2 +- ...ontext_fqdn.NotProvidedStoreFQDNError.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 +- packages/app/CHANGELOG.md | 8 ++ packages/app/oclif.manifest.json | 2 +- packages/app/package.json | 6 +- packages/cli-kit/CHANGELOG.md | 2 + packages/cli-kit/package.json | 2 +- packages/cli-kit/src/public/common/version.ts | 2 +- packages/cli/CHANGELOG.md | 7 ++ packages/cli/README.md | 74 +++++++++---------- packages/cli/oclif.manifest.json | 2 +- packages/cli/package.json | 10 +-- packages/create-app/CHANGELOG.md | 6 ++ packages/create-app/oclif.manifest.json | 2 +- packages/create-app/package.json | 4 +- packages/plugin-cloudflare/CHANGELOG.md | 6 ++ .../plugin-cloudflare/oclif.manifest.json | 2 +- packages/plugin-cloudflare/package.json | 4 +- packages/plugin-did-you-mean/CHANGELOG.md | 6 ++ .../plugin-did-you-mean/oclif.manifest.json | 2 +- packages/plugin-did-you-mean/package.json | 4 +- packages/theme/CHANGELOG.md | 6 ++ packages/theme/oclif.manifest.json | 2 +- packages/theme/package.json | 4 +- .../ui-extensions-dev-console/CHANGELOG.md | 2 + .../ui-extensions-dev-console/package.json | 2 +- pnpm-lock.yaml | 20 ++--- 557 files changed, 776 insertions(+), 738 deletions(-) delete mode 100644 .changeset/khaki-waves-worry.md diff --git a/.changeset/khaki-waves-worry.md b/.changeset/khaki-waves-worry.md deleted file mode 100644 index 529745428e..0000000000 --- a/.changeset/khaki-waves-worry.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/app': patch ---- - -Remove Default Examples for Customer Privacy Settings diff --git a/docs/api/cli-kit/classes/node_abort.AbortController.html b/docs/api/cli-kit/classes/node_abort.AbortController.html index 7cc9124da2..f5fb5caa45 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 a5359d2e6a..a1c946235d 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 e323d0efad..abb76a6a61 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 @@ -9,4 +9,4 @@ showNpmFlagWarning analyticsNameOverride analyticsStopCommand -

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

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

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 7742c4e139..16ce6255ef 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 0c8e71fde2..6fdb942744 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 626928e072..7f6b05ca58 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 ee50a79295..c502836c54 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 9772320f82..8439ef6e18 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 17a3125d49..38f105198a 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 6202537280..bd62902ac1 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 e8a868e9a0..5bfe99f752 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 effd7308c0..68993b2a1c 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 3d534b2c84..4611f07420 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 38452e90ae..1d0cf0dc7f 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 619be44eef..19f44888cd 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 5e11528623..a774df82b8 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 3065719b30..c80f839125 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 d2cef56785..6254cd1c5c 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 5132cfaa6b..c578009c5a 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 207ed0a23e..b1fc99a6fc 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 2506d0ff8b..1cf079308c 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

    Private 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

    Private 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 5abef8b614..a9988af7f2 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 d00166fc26..7a479108c4 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 1b8c7061a3..19d848c115 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 a4316eaec4..d6edd4fbeb 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 17321849e7..0a36caa6ac 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_vendor_otel_js_service_types.MetricInstrumentType.html b/docs/api/cli-kit/enums/node_vendor_otel_js_service_types.MetricInstrumentType.html index 3421bf32f6..70f86a8b01 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 5199149da4..9a8d598630 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 8270cf7627..0849fa531d 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 645d8f6fce..17c64c6752 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 4f4704931c..3cc9026067 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.uniqBy.html b/docs/api/cli-kit/functions/common_array.uniqBy.html index a32622f3cc..91026cde06 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 9a1503e8c1..a567674673 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 6643800123..326c267564 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 d453f198cd..5edf660e18 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 330d7527a7..e25f3fbe3c 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 9c6c037119..9cf6de8374 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.deepCompare.html b/docs/api/cli-kit/functions/common_object.deepCompare.html index 663236a907..59e9eca00d 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 d83e612cc5..4d6b6a2c91 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 e37694df79..f9b9cbe0e5 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 dcb2f99f7f..0d5331246b 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 4ee55459f9..07ac44e471 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 8f40a38032..613f6a5527 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 e3b6914172..453dc5047a 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<S>

    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 bace2822f2..a92c300009 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 f25bd4e086..7c6323ae95 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 092e897e34..ed8723adf8 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 ae169bdc85..e3edc6e288 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 4538da6cc1..63b572ddf4 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 e145a01a26..614d3f8743 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 f382cd5c25..2440d490a6 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 62b50e9a26..296703b386 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 8240576076..efb6ceabd0 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 0c5fcc5d02..1661e9c2a9 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 29d203776e..0ecdfe265d 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 4442918d39..0796c8f620 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 04d25ac437..130f8fe8ec 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 80c1dc2424..ed19575e6a 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 f34dc92a15..57fa336a22 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 59db9bf3eb..426f036745 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 75dc1062be..4f55649f1e 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 8c97c66ad8..072693397f 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 9526755765..e0bea038db 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 a9d95555b7..f5715428d4 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 98bb773bfc..7a2717c716 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 d18267a57d..ad4e7305e7 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 38be32a609..79cc1934b2 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 85c43dfa89..0af5ba6b42 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 7c8cb0a555..3783c80ed4 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 57a7b80a7a..dbcbc4260d 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 e5735e4abc..4e2fe2d74c 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 825197b39d..bbe3a5175f 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_archiver.zip.html b/docs/api/cli-kit/functions/node_archiver.zip.html index 51279a8039..c0fc7c0fc8 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 fa3224ea8a..4a29bd153f 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 5dd284b02a..7a81e05358 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 27e18b7207..ab0915b1a9 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 dd0b221cb8..e7a07c44f7 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 70de6027db..305084a26e 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 ad73d83ae0..9f2aaf7fd3 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 83f3e9a10f..db789b8f34 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 802d62b45d..9dfee3ef3d 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 a7165af6fd..a6708bbeab 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_local.alwaysLogAnalytics.html b/docs/api/cli-kit/functions/node_context_local.alwaysLogAnalytics.html index d953aa440c..257b9e8ddb 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 fe80884a8e..6ff516451e 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 a7423be84c..2d25f78afb 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 d18c0ff532..b050dcbf3a 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 0a585fff92..961200c558 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 011b6bd067..2ae4866983 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 2a40047ed3..498bfaf031 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 ccf7555ca4..acbc00e37b 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 eea4825e82..647a265738 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 c27809a3bf..f3b39eef22 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 353000b734..bdfed9fbf8 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 6af1338f48..1e3d638d44 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 940c174909..8381b3aa31 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 946f237171..0dfce0660a 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 3c1add4d0c..73aa7f8826 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 8065fc8a77..847fbd226f 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 1eb77ed6ed..3034d167c2 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 6939dd3776..a3a182c13b 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 2a06bb3b13..5c31b906b5 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 c2b32c9c15..7c120c69b2 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 31471857bb..24e148301c 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 80e6804fb8..21bff7ba95 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 7cf4544cb5..674e0a255f 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 767ab81e0f..8e9986d963 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.instance.html b/docs/api/cli-kit/functions/node_context_spin.instance.html index 2dc3dbea18..b948d1bb72 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 2ad3920c30..eceebd434d 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 510c9d4da5..624203cb8f 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 1ae2f7bf53..a78ca57891 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 80a3f6ddad..282414685c 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 c41a306c0c..3c195c6eab 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 1e5306e5d8..bd4a59e332 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 19ffd2b357..f32cb19624 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 ef16b9b7db..a9a46e3048 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 46d1de2f98..59dfa5dc1c 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 8ce25508a5..e95f6123c1 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 ff58517ac9..95dc64395e 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 226cda1e38..e5cfbb8666 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.patchEnvFile.html b/docs/api/cli-kit/functions/node_dot_env.patchEnvFile.html index 7d95e56b9a..b7fa7cb324 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 12f0cce17e..1f7176fe7f 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 924ba39d1a..774fc927bc 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 4930d6a4d3..36ea3ec6c1 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 f337f104af..417f0bd832 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 d25e08c268..1483b0bb6b 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 33492aaaa9..71d0c47e2b 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 72f3771a6a..9b633528ef 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 d8eed40f2c..aab385cf07 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 889868cf5f..fa7263c062 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 7bfaeff66a..6f6692c6ce 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 c202a73d30..983ddfc173 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 4b5cf73fa2..bae0b71d64 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 44d5ad916d..ca57ed4f7c 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 9c77e7dd19..7acc49f3ea 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 d61c4ce06c..239d2975b5 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 d683c81c79..f80cb3efe0 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 86cb145e79..7d98d827d6 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 666e90e6d4..3e1e178446 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 1f331ac5c9..b844133f5b 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 44170a0ac4..ce69ddccde 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 43dd52386c..5aec1d628a 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 c2e7ce4407..2900435dd0 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 e95bf27151..2851b2dd5a 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 4c0111e2f9..c4eb696997 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 458ba39672..109ae3a750 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 8c2f0d0599..16f8fcb3d6 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 aa2e2b13f4..096cf917fa 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 590f1b9adf..c4429e1644 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 a1796fc911..bc5d2f4749 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 c11019d857..2d897356a8 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 b6ff0e8965..eda6a32fe5 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 0bdf460b8a..e005d773ea 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 d66fc48f10..d48ac56e19 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 49ee1dc341..e905ee12e7 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 64c61d2211..dd407558df 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 72a8cf33fd..32941a690c 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 a175f0823a..24e7d05f70 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 df23ebed66..28e23eee9e 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.mkTmpDir.html b/docs/api/cli-kit/functions/node_fs.mkTmpDir.html index 01dc837b79..752bc21264 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 ef2636be4f..ad7d8c9e5b 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 1147a9c213..b3aa61a32e 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 7373c64f09..9e3c46181e 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 600812b512..9175d4c3de 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 0c23da445d..3b2e81686c 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 eff7ebd1d0..62b1d3afe1 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 c65c0a5834..972a357815 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 a954e61274..0f8523842b 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 fb8fba4f90..274f3e2c84 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 3ae045c070..ac71f568c8 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 f0812da288..ec4a7023b5 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 c3fc089a61..2f3ac76107 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 5896e99074..7b4a62af9c 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 8849b944ac..8dee473792 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 38c1e0d623..0699700d50 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 a7033e58a3..62be8e0480 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 acf253cc21..36854f6b24 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 36016bb8e9..12640d6e44 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 9b8b89f71a..0e0aaa4da3 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 b81bc1f834..a9933d7825 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 fb7b33ba8b..bc786c74ad 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 9278a453cd..2689d4f201 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 f270a39b8f..505d102259 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 253553ecfc..11bbea77e9 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 b5833eb686..6d0fb12c4b 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 44034f400e..dd575f0f99 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 086a0e2f00..205d3f3624 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 d76ab00bb3..a8772f8826 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 79662b685a..6b3548c1a1 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 32b4d4426e..55496a54f1 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 9ef9ea4b37..0ef56380d0 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 675b3981f7..120961c842 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 bff11c0fe5..fb5de251c2 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 e199592e7d..118776f10b 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 d12e2ad595..5b1ee72549 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 87a176fa69..0094584835 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 e834e320e1..16651b4976 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 9be77b9e79..3480b38fd7 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 3d5c6354ff..66e554bbcc 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_liquid.recursiveLiquidTemplateCopy.html b/docs/api/cli-kit/functions/node_liquid.recursiveLiquidTemplateCopy.html index 92e4b8015c..e37701c9c2 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 519d58a17b..765520d0f9 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 eabc37799c..8851f6f3a4 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 a0f94a90b6..86d3da73d2 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 e8076af702..f7c2ca4e92 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 94e642993a..b38d820b84 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 6a28052b2e..fe04788fd7 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 a16f3b2273..8adb8d888f 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 cd4be10031..adc940b08e 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 95fdb5ad49..2e4d800915 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 dd08e63805..e8f164c11e 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 e514a9c70b..5189c9875f 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 03eb3fa700..955499cbb2 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 0ec87d7519..629e22f2fa 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 c5c426936d..0250556924 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 602eb8728a..8da24033d8 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 4f202f4964..541fed73f7 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 e0776e4e06..3c37deb7dc 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 dc7583d619..82f12df9cd 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 76f97ca221..049c5c48d6 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 aff4c7f757..08731e6485 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 1940bddf69..be6c03562a 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 9cfe6ed285..c2d50693ef 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 ac46f7dc2c..1b1a1c83f0 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 3e226546c0..2298830e6e 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 c5d4b317b6..371e66ec3b 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 d9ba30a2f8..3c51ce38b8 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 7c510fd615..f5b9ea84df 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 9f4b32c142..b5cbdfb676 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 a7ebabba0a..731d36c2ab 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 a1c9574d16..354eedb55a 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 006080ce70..4ec3f0b54f 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 0dc422aa74..778447ed08 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 39581ab98a..a632131eb4 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 fd028426e8..6643f6407f 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 376829fd63..3ac3c96131 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 b8f41f95fd..e217318a26 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 922df11e44..8e2c193346 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 1a74650aa5..52dffa7d38 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 ca23debf4c..1518867eb0 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 c232125e49..8ab7a204f9 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 dc862f9399..b110a3df76 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 b8f6178656..940244758a 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 b15d56709c..cafa28ed7d 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 a8607a7c79..c5f3ba4f26 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 e659b57227..b3a84bbf7c 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 dbde55e851..25594ba653 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 894c21c092..3d78d05d93 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 207471a415..f8f54cc1d9 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 9bb0d14d02..686c9cc877 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 0385c0bbbb..25790e9419 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 27aa4d6f05..235fc278f0 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 878c47da30..7f21a15b26 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 43b8a89114..a86878dfcc 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 1da8b6188a..0383c07e6a 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 dc2c5b4c27..003aa63e4b 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 181806b784..af1a130fea 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 946141a811..c1a0e1f2f2 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 83e779c72a..d2170b3910 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 8807af59ac..231fca0b62 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 28328c094f..686a51532e 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 9c8f474d5f..5b264f38c8 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 135954ac1d..e05adac0cc 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 e2b73171d4..b8aceec575 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 287736b185..5b5b9b9f6e 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 0d24ec543d..368ca2c308 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 699e827210..cee76f0446 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 1fad07b6e7..9648443a72 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 3819cfd5b5..b7170c7748 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 a1081880c1..68f288e86f 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 8c1882b12f..776e8e353a 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 8908622173..f5ccdf6790 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 dbc8595890..8606214fff 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 b3f84bef5f..40f2a69d2e 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 57586f2a5b..fbb9225954 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 ec5ce8619d..47b80130d4 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 b6f569841f..8eb3aa6353 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 7b081cdbaf..6f93b62386 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 a1749142b1..8e584db158 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 909201fd19..d18b03d37d 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 1f6589c64e..3526c75e04 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 3b6f42521f..913dab3346 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 41de4abf7f..44fa5118ca 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 b053f95e04..53cd6b4251 100644 --- a/docs/api/cli-kit/functions/node_tcp.getAvailableTCPPort.html +++ b/docs/api/cli-kit/functions/node_tcp.getAvailableTCPPort.html @@ -2,4 +2,4 @@

    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 916ab4dc2e..42ae2053fe 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 dbc61b9350..a3cac0ada9 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 f39bce219c..eefcaf047f 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 6a6bbb7975..889436bcb6 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 cec941c45c..ae101b0aa1 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 295be59266..0c8e6fb134 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 9f3d11b69b..3284645ebd 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 e6133557bc..9970170b00 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 af30c00cd7..9cf9a2f60a 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 fc29eb3b95..6aa175280b 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 e9c7914ce0..abcf69014f 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 63db2f8114..853964e1dd 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 09d064d03a..3d71cc0e84 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 6422126e8b..c98cb21add 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 3f801c4046..055a8f38f1 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 5399df4ff1..efc084539f 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 0a2db4c7a9..379ac998ea 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 49c08c7643..df93bcacf5 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 877db60fb7..4121e974bf 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 f64601b50e..d6c07ef649 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 305cee84d6..9232f57896 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 7de8c8adae..432914cf20 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 866576027e..c2f0e4b55d 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 aafa3532b6..473218bb17 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 98faabc7d9..292b263205 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 d67274e515..88df90fe97 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 8b5b5ce222..41f865597a 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 364b79452d..2e92485728 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 97c81a3f8c..b831c7a44b 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 a74831c0ab..4fe471be31 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 976f37042f..e2dd01bb48 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 d4c2dae09e..50f8c396b2 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_toml.decodeToml.html b/docs/api/cli-kit/functions/node_toml.decodeToml.html index 2f52772251..214ef2f16b 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 429dd99317..41be2afd38 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 d5c4ebfc09..de841a94b3 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 7f9b3ea79f..746d624ab4 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 c946e7bea8..ceae96a441 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 98062ec240..37a2a97a13 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 de229a5139..64e516118e 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 69f20883da..75b63ba8e1 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 dffd1625b4..7edf071c45 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 4b73ce5581..6a0d9fb1eb 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 2b0e2e1d3d..9cf4202959 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 de966f8359..bd089330c7 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 ad0d1e8969..ee92a70628 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 434048ceff..a46051d6ea 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 0300049fa2..dfcf507983 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 67b3821052..a762c86528 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 fcff699f18..3f3ad7450a 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 436114c8e4..5f29fad697 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 746f6747c6..2ede1fdf53 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 f27d7c2f90..1d965c52c4 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 586ed012de..393fd6cd5b 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 94f05f3763..716b867ec1 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 22854a8bb5..39ebefabe5 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 92c3eea9dd..40cb5e0af3 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 3df4f8b219..db6565cb4a 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 4290b19bc8..ec70daf4a9 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 81b89e06bf..7a4f21c86e 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 72d60c3aa6..39e7e3c08e 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 b550f83fbd..51f9f0c71f 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 61d23ee411..0631f51c7c 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 084f933b01..00b830d772 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 d2c845063e..44df9e5bcb 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 2f9d06d868..fc4d28659f 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.WriteOptions.html b/docs/api/cli-kit/interfaces/node_fs.WriteOptions.html index 5143081ad3..9b61386010 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 c1dff6b153..23d0f7b25c 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 2142083f9c..4ad5077a22 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 51e39ba3e4..e6943da802 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 2467f1748b..39962c889d 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 f8d613524f..a2bf973875 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 a851ac1929..9e947497ea 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_metadata.RuntimeMetadataManager.html b/docs/api/cli-kit/interfaces/node_metadata.RuntimeMetadataManager.html index cebd0dba44..98c55e5e1d 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 e1623f24f9..1f38f072e1 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.11: {
            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_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.11 -

    Properties

    app_cli3_command/1.11

    app_cli3_command/1.11: {
        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_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_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_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.11: {
            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_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.11 +

    Properties

    app_cli3_command/1.11

    app_cli3_command/1.11: {
        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_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_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_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 28afd95ed2..c7d236bea0 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 235b55990f..58c2eb34a0 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 2783942d6a..f1e6e48cd0 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 c8138a660b..6a68044245 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 dcc08c7faa..d54901348a 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 deeeb6b955..9475a4f2cd 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 2fa7937d8c..b72a222664 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 bff3e32018..1d999df857 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 bf5ed7288f..f465e64b39 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_types.BulkUploadResult.html b/docs/api/cli-kit/interfaces/node_themes_types.BulkUploadResult.html index 43cba554ce..323ab3d5fa 100644 --- a/docs/api/cli-kit/interfaces/node_themes_types.BulkUploadResult.html +++ b/docs/api/cli-kit/interfaces/node_themes_types.BulkUploadResult.html @@ -1,12 +1,12 @@ BulkUploadResult | @shopify/cli-kit

    Interface BulkUploadResult

    Represents a single result returned within the response of a bulk upload operation. Each result includes the unique identifier for the file being uploaded, the status of the upload operation, any errors that occurred, and the asset that was uploaded.

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

    Properties

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

    Properties

    asset errors? key success

    Properties

    asset

    asset: ThemeAsset

    The asset that was uploaded as part of the upload operation for this file.

    -

    Optional errors

    errors?: string[]

    An array of error messages that were generated during the upload operation for this file.

    -

    key

    key: string

    The unique identifier for the file being uploaded.

    -

    success

    success: boolean

    Indicates whether the upload operation for this file was successful.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional errors

    errors?: string[]

    An array of error messages that were generated during the upload operation for this file.

    +

    key

    key: string

    The unique identifier for the file being uploaded.

    +

    success

    success: boolean

    Indicates whether the upload operation for this file was successful.

    +

    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 c2a9e57ac3..3a21a96ffe 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.Theme.html b/docs/api/cli-kit/interfaces/node_themes_types.Theme.html index 0ed60cb5fa..5a388b0182 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 21e74c15f3..fb645d57a2 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 48579d555f..086c88a5b2 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 27450972a1..45172d6d0c 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 9642c0daf6..e1695b5dea 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 5e2a4fb91b..092dc0962d 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 206057ec23..0679b9f13a 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>[];
        gitDiff?: {
            baselineContent: string;
            updatedContent: string;
        };
        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>[];
        gitDiff?: {
            baselineContent: string;
            updatedContent: string;
        };
        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 gitDiff? hasMorePages? @@ -7,4 +7,4 @@ message renderOptions? search? -

    Properties

    Optional abortSignal

    abortSignal?: AbortSignal

    choices

    choices: Item<T>[]

    Optional gitDiff

    gitDiff?: {
        baselineContent: string;
        updatedContent: string;
    }

    Type declaration

    • baselineContent: string
    • updatedContent: string

    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 gitDiff

    gitDiff?: {
        baselineContent: string;
        updatedContent: string;
    }

    Type declaration

    • baselineContent: string
    • updatedContent: string

    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 f85aba9fcf..d6599e9278 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 a9949b8c6f..620471b5ee 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;
        gitDiff?: {
            baselineContent: string;
            updatedContent: string;
        };
        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" | "gitDiff" | "abortSignal">
      • RenderConfirmationPromptOptions

    Properties

    abortSignal? +RenderConfirmationPromptOptions | @shopify/cli-kit

    Interface RenderConfirmationPromptOptions

    interface RenderConfirmationPromptOptions {
        abortSignal?: AbortSignal;
        cancellationMessage?: string;
        confirmationMessage?: string;
        defaultValue?: boolean;
        gitDiff?: {
            baselineContent: string;
            updatedContent: string;
        };
        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" | "gitDiff" | "abortSignal">
      • RenderConfirmationPromptOptions

    Properties

    abortSignal? cancellationMessage? confirmationMessage? defaultValue? @@ -7,4 +7,4 @@ infoTable? message renderOptions? -

    Properties

    Optional abortSignal

    abortSignal?: AbortSignal

    Optional cancellationMessage

    cancellationMessage?: string

    Optional confirmationMessage

    confirmationMessage?: string

    Optional defaultValue

    defaultValue?: boolean

    Optional gitDiff

    gitDiff?: {
        baselineContent: string;
        updatedContent: string;
    }

    Type declaration

    • baselineContent: string
    • updatedContent: string

    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 gitDiff

    gitDiff?: {
        baselineContent: string;
        updatedContent: string;
    }

    Type declaration

    • baselineContent: string
    • updatedContent: string

    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 9400eba39f..6bd6669d47 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 c94e91ce6a..206ffa28aa 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;
        gitDiff?: {
            baselineContent: string;
            updatedContent: string;
        };
        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;
        gitDiff?: {
            baselineContent: string;
            updatedContent: string;
        };
        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? gitDiff? @@ -7,4 +7,4 @@ isConfirmationPrompt? message renderOptions? -

    Properties

    Optional abortSignal

    abortSignal?: AbortSignal

    choices

    choices: Item<T>[]

    Optional defaultValue

    defaultValue?: T

    Optional gitDiff

    gitDiff?: {
        baselineContent: string;
        updatedContent: string;
    }

    Type declaration

    • baselineContent: string
    • updatedContent: string

    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 gitDiff

    gitDiff?: {
        baselineContent: string;
        updatedContent: string;
    }

    Type declaration

    • baselineContent: string
    • updatedContent: string

    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 2222d621a9..5b76b32246 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 b1c17966c8..682e0b2c6a 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 8efa2d6531..deeaf50ce2 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 8f2fba854f..da86e3b987 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 7098f9fce2..1580674621 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 fb2e1c29a0..aa366accb0 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 c0fb436833..68829b9a9d 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 d859f73311..2f0bc29e43 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 ab0e5d0a82..3d3f17b15d 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 972e2009a7..f2f8b5ef75 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 d17db32d1c..63d0c50396 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 df6d4e0178..a93939f205 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

    deepCompare +common/object | @shopify/cli-kit

    Module common/object

    Index

    Functions

    deepCompare deepDifference deepMergeObjects getPathValue diff --git a/docs/api/cli-kit/modules/common_retry.html b/docs/api/cli-kit/modules/common_retry.html index 278045279a..307fbd7bce 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 7cc15ef557..bbe4d54e03 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 1b936af012..04b2310d68 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 9e2c321a45..4b69ce96d1 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 f421ae6da5..2810cb72c6 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 6d5f9f9094..aaf5494502 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 db01cd1ecb..d4c7936df6 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 e9cc8b5d8e..4059a07a37 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 806473879f..6957474b39 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 6386162ed1..9b0033fb00 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 f2bac6719a..59fcae90fc 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 1ed71fe00b..376d2d056a 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 3b3f8d51ef..2b4f11b3d4 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

    Functions

    getFunctionUploadUrl handleDeprecations partnersRequest diff --git a/docs/api/cli-kit/modules/node_archiver.html b/docs/api/cli-kit/modules/node_archiver.html index 4499673047..f8adf18036 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 19b1833a34..0859a20415 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 7006411b8b..1956cd9031 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

    References

    default +node/cli | @shopify/cli-kit

    Module node/cli

    References

    default

    Variables

    globalFlags

    Functions

    localCliPackage runCLI diff --git a/docs/api/cli-kit/modules/node_colors.html b/docs/api/cli-kit/modules/node_colors.html index 5932000443..8e00987488 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 81a6032843..7f908f7e93 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 0e1cf6000b..610c6d3aad 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 63e75c2538..9e6b95ab29 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

    Functions

    appHost +node/context/spin | @shopify/cli-kit

    Module node/context/spin

    Index

    Functions

    appHost appPort instance isSpin diff --git a/docs/api/cli-kit/modules/node_context_utilities.html b/docs/api/cli-kit/modules/node_context_utilities.html index 07b3e862d2..605b1b43d6 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 d32d29ac15..8043dce16d 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_dot_env.html b/docs/api/cli-kit/modules/node_dot_env.html index 18c9c2be23..8d01cee3e4 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

    patchEnvFile readAndParseDotEnv writeDotEnv diff --git a/docs/api/cli-kit/modules/node_environment.html b/docs/api/cli-kit/modules/node_environment.html index 549b8d5d94..3f84082a69 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 7419137386..f5d2bda24f 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 515d7313da..5d9df71ee6 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 3ff5bb5fe5..535baa8859 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 c1f1a4c112..cdda18220c 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 82c41380e3..eb1bfa240f 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 a1a74344f4..b68ace4bf3 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

    WriteOptions +node/fs | @shopify/cli-kit

    Module node/fs

    Index

    Interfaces

    WriteOptions

    Type Aliases

    ReadOptions

    Functions

    appendFile appendFileSync diff --git a/docs/api/cli-kit/modules/node_git.html b/docs/api/cli-kit/modules/node_git.html index 0a86b8e889..03162d213b 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 2475640a9b..745924b981 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 2a07f42b4a..cb7a66dab7 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 1482e34c88..39714b161f 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 c0e8deb7d0..9f9e3aece8 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 a4d14095f1..e56a7635af 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_liquid.html b/docs/api/cli-kit/modules/node_liquid.html index a9f02bdb67..90a26b311d 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 f84e451e85..26ca7bd3bf 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 06bf70571f..a62feb576a 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 d651c95fd3..dd5e254032 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 b1d3283f19..8ffd8a5fa5 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 70201cfa4e..8f9555e1f1 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 090a7ea6b3..3e9cfad561 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 521dd95171..92664cbbeb 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 b273d5ad97..e27f03f360 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 1c6c797d80..dcd30688f1 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 054f38792c..6e0d3245b9 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 bea14e91c1..3498fff8df 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 6d8427dc9d..f0186048ef 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 4aa4aba206..79f0c10c25 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 585b4ca222..880680860e 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 8e3db54857..3627288319 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 5fd8df8353..3c5bf639c2 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 2890f80019..1072960013 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 39ba680c07..f4a6581958 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 2953dbc1c1..dc330500b2 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 993137716f..ed04585b03 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 8fe578383a..aee48647ab 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

    Functions

    buildBulkUploadResults +node/themes/factories | @shopify/cli-kit

    Module node/themes/factories

    Index

    Functions

    buildBulkUploadResults buildChecksum buildTheme buildThemeAsset 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 65d20080fc..cab46db387 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 5f50dbab97..7863f71729 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

    Interfaces

    BulkUploadResult +node/themes/types | @shopify/cli-kit

    Module node/themes/types

    Index

    Interfaces

    BulkUploadResult Checksum Theme ThemeAsset diff --git a/docs/api/cli-kit/modules/node_themes_urls.html b/docs/api/cli-kit/modules/node_themes_urls.html index 61e979d43a..d5730f22e8 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 e4dd4f608a..315d7a450d 100644 --- a/docs/api/cli-kit/modules/node_themes_utils.html +++ b/docs/api/cli-kit/modules/node_themes_utils.html @@ -1,3 +1,3 @@ -node/themes/utils | @shopify/cli-kit

    Module node/themes/utils

    Index

    Variables

    DEVELOPMENT_THEME_ROLE +node/themes/utils | @shopify/cli-kit

    Module node/themes/utils

    Index

    Variables

    DEVELOPMENT_THEME_ROLE

    Functions

    isDevelopmentTheme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/api/cli-kit/modules/node_toml.html b/docs/api/cli-kit/modules/node_toml.html index 74ac910708..7837195b81 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 619daadffb..b0c5c1d58d 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 084b1d24d7..6da0d34a20 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 6520be7813..2c6ff79dad 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 908f99d630..a56d539c3f 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 9e7b57e951..efe2ba1fe4 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 2e8c723725..9ed1458aed 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 24f278ff7f..ce35d84670 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 e403d6f536..e8e0e710f2 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 ec62d4f2b6..57d47071cc 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 1c93e52cb5..79b68608f9 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 ff8e9b642d..8481797e29 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 fddb1921f8..7248deaee9 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 fc807189e8..ceded8a29b 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 0da43180b2..dffb6a6b9f 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 1cb02d6c31..de8c71beef 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 7f489a0447..82cc45c7f7 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 898d140d29..2f641c2c67 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 98c0387ce6..20b08ddce2 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 55c4f98ceb..2bedc169c9 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 2197441d3b..cd3d96d982 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 507fa97b9d..94bed28b0e 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 6e74b8d32f..12a67b7690 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 f8686c8615..fb29b09000 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 f35b585866..173b14d4c7 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 e7337cbabc..8a312ec79a 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 4d2b205545..fc6c54afb7 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 f0e2ceb720..be1a37fe51 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 1955fd8c07..79a4ed9d77 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 6034320215..8bdbea99d8 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 d72ada5980..ce9bc21c77 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 6ea3a24d11..76b65dafe2 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 cd5c2b3022..bee8f69728 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 72a5400c57..3e8cf57d82 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 828f43805f..cde0f55bd0 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 a4522cd0f7..b1d9ce4102 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 c5675ecdea..627eda59c8 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 de176826a1..54f52cfba5 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 931b0846cf..20223c38ba 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 4f76c95ada..4417f96327 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 f55eafecbc..fdfafcbf10 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 d396be6555..27b8336e73 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 626cd6c1cf..41a12caf05 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: Partial<Pick<ThemeAsset, "key" | "value">>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias AssetParams

    AssetParams: Partial<Pick<ThemeAsset, "key" | "value">>

    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 b72b9d6090..dd2a134c1d 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 6de5732194..be6cda0b59 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_toml.JsonMapType.html b/docs/api/cli-kit/types/node_toml.JsonMapType.html index f8e3ce9f83..d4a50a06eb 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 47da668027..d4f71c1876 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 ededfd7d18..5814e61152 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 c22f639ce0..ec5aef5aac 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 0a2d4992b7..39b1cb89da 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 ad8b5815d1..192bd5d9a9 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 4dc7a49cc3..2ffa511e5e 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 78af9aa6e3..3686e6c3d2 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 341dd1441c..778d49c82f 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 452b8914f0..0a8b8c0be2 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 9911bce471..214a20d415 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 b69ff2af01..0a2a96877c 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 42c1ea2d66..fbad51e2d2 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 e364ab98fe..810e9464a3 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 ed816f1a51..357e7db451 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 08ff96c73a..7340e1b43a 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.56.0" = '3.56.0'

    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.56.1" = '3.56.1'

    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 1d2a47123f..a979c6f47b 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 bec541a2a8..bcc1dcb563 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 fa5e495315..d228d19c4b 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 835f75c754..48548b1855 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 713e5bb1f3..7aa39363f5 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_monorail.MONORAIL_COMMAND_TOPIC.html b/docs/api/cli-kit/variables/node_monorail.MONORAIL_COMMAND_TOPIC.html index 70253a519b..e5ee311b53 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.11" = ...

    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.11" = ...

    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 924260a950..42d935eecd 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 d01ff68e62..8b2ab791a9 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 6abbee871c..ba5634916d 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 9da01930ca..283e2ef89c 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 9ca4784bb9..5fc4b23e85 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 e6c2fc8e23..b1bef3084a 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 f406b1ea63..705f86471b 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 e1f890a36a..d401274f18 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 f6d3196de3..3a7b70a1a8 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 abda7f7aeb..4f43e86dac 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 2d720faac7..74080137a5 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 fc8a840dfa..3a5d03981a 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/packages/app/CHANGELOG.md b/packages/app/CHANGELOG.md index d828e4e7ed..a8792f3215 100644 --- a/packages/app/CHANGELOG.md +++ b/packages/app/CHANGELOG.md @@ -1,5 +1,13 @@ # @shopify/app +## 3.56.1 + +### Patch Changes + +- a62002a61: Remove Default Examples for Customer Privacy Settings + - @shopify/cli-kit@3.56.1 + - @shopify/plugin-cloudflare@3.56.1 + ## 3.56.0 ### Minor Changes diff --git a/packages/app/oclif.manifest.json b/packages/app/oclif.manifest.json index acd0e04e18..508cefbaad 100644 --- a/packages/app/oclif.manifest.json +++ b/packages/app/oclif.manifest.json @@ -1963,5 +1963,5 @@ "strict": true } }, - "version": "3.56.0" + "version": "3.56.1" } \ No newline at end of file diff --git a/packages/app/package.json b/packages/app/package.json index 32ff1fdab4..74f714c11a 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/app", - "version": "3.56.0", + "version": "3.56.1", "description": "Utilities for loading, building, and publishing apps.", "homepage": "https://github.com/shopify/cli#readme", "bugs": { @@ -43,9 +43,9 @@ "dependencies": { "@luckycatfactory/esbuild-graphql-loader": "3.8.1", "@oclif/core": "3.15.1", - "@shopify/cli-kit": "3.56.0", + "@shopify/cli-kit": "3.56.1", "@shopify/function-runner": "4.1.1", - "@shopify/plugin-cloudflare": "3.56.0", + "@shopify/plugin-cloudflare": "3.56.1", "@shopify/polaris": "12.10.0", "@shopify/polaris-icons": "8.0.0", "@shopify/theme-check-node": "2.0.1", diff --git a/packages/cli-kit/CHANGELOG.md b/packages/cli-kit/CHANGELOG.md index aa6dcff999..065f4cc16d 100644 --- a/packages/cli-kit/CHANGELOG.md +++ b/packages/cli-kit/CHANGELOG.md @@ -1,5 +1,7 @@ # @shopify/cli-kit +## 3.56.1 + ## 3.56.0 ### Minor Changes diff --git a/packages/cli-kit/package.json b/packages/cli-kit/package.json index f5afae3bd8..05d7285cda 100644 --- a/packages/cli-kit/package.json +++ b/packages/cli-kit/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/cli-kit", - "version": "3.56.0", + "version": "3.56.1", "private": false, "description": "A set of utilities, interfaces, and models that are common across all the platform features", "keywords": [ diff --git a/packages/cli-kit/src/public/common/version.ts b/packages/cli-kit/src/public/common/version.ts index 7b9319080e..4bbc90c501 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.56.0' +export const CLI_KIT_VERSION = '3.56.1' diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index 9a4210b737..658360ef96 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -1,5 +1,12 @@ # @shopify/cli +## 3.56.1 + +### Patch Changes + +- @shopify/cli-kit@3.56.1 +- @shopify/plugin-did-you-mean@3.56.1 + ## 3.56.0 ### Minor Changes diff --git a/packages/cli/README.md b/packages/cli/README.md index 16debc0a5a..d39b8cd6da 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -72,7 +72,7 @@ DESCRIPTION Build the app. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/build.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/build.js)_ ## `shopify app config link` @@ -93,7 +93,7 @@ DESCRIPTION Fetch your app configuration from the Partner Dashboard. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/config/link.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/config/link.js)_ ## `shopify app config use [CONFIG]` @@ -116,7 +116,7 @@ DESCRIPTION Activate an app configuration. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/config/use.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/config/use.js)_ ## `shopify app deploy` @@ -146,7 +146,7 @@ DESCRIPTION Deploy your Shopify app. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/deploy.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/deploy.js)_ ## `shopify app dev` @@ -184,7 +184,7 @@ DESCRIPTION Run the app. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/dev.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/dev.js)_ ## `shopify app env pull` @@ -205,7 +205,7 @@ DESCRIPTION Pull app and extensions environment variables. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/env/pull.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/env/pull.js)_ ## `shopify app env show` @@ -225,7 +225,7 @@ DESCRIPTION Display app and extensions environment variables. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/env/show.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/env/show.js)_ ## `shopify app function build` @@ -245,7 +245,7 @@ DESCRIPTION Compile a function to wasm. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/function/build.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/function/build.js)_ ## `shopify app function run` @@ -268,7 +268,7 @@ DESCRIPTION Run a function locally for testing. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/function/run.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/function/run.js)_ ## `shopify app function schema` @@ -290,7 +290,7 @@ DESCRIPTION Fetch the latest GraphQL schema for a function. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/function/schema.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/function/schema.js)_ ## `shopify app function typegen` @@ -310,7 +310,7 @@ DESCRIPTION Generate GraphQL types for a JavaScript function. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/function/typegen.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/function/typegen.js)_ ## `shopify app generate extension [FILE]` @@ -342,7 +342,7 @@ EXAMPLES $ shopify app generate extension ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/generate/extension.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/generate/extension.js)_ ## `shopify app generate schema` @@ -364,7 +364,7 @@ DESCRIPTION Fetch the latest GraphQL schema for a function. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/generate/schema.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/generate/schema.js)_ ## `shopify app import-flow-legacy-extensions` @@ -386,7 +386,7 @@ DESCRIPTION Import dashboard-managed flow extensions into your app. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/import-flow-legacy-extensions.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/import-flow-legacy-extensions.js)_ ## `shopify app info` @@ -408,7 +408,7 @@ DESCRIPTION Print basic information about your app and extensions. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/info.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/info.js)_ ## `shopify app release` @@ -433,7 +433,7 @@ DESCRIPTION Release an app version. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/release.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/release.js)_ ## `shopify app versions list [FILE]` @@ -459,7 +459,7 @@ EXAMPLES $ shopify app versions list ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/app/versions/list.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/app/versions/list.js)_ ## `shopify auth logout` @@ -473,7 +473,7 @@ DESCRIPTION Logout from Shopify. ``` -_See code: [dist/cli/commands/auth/logout.js](https://github.com/Shopify/cli/edit/main/packages/cli/blob/v3.56.0/dist/cli/commands/auth/logout.js)_ +_See code: [dist/cli/commands/auth/logout.js](https://github.com/Shopify/cli/edit/main/packages/cli/blob/v3.56.1/dist/cli/commands/auth/logout.js)_ ## `shopify commands` @@ -798,7 +798,7 @@ DESCRIPTION Starts a search on shopify.dev. ``` -_See code: [dist/cli/commands/search.js](https://github.com/Shopify/cli/edit/main/packages/cli/blob/v3.56.0/dist/cli/commands/search.js)_ +_See code: [dist/cli/commands/search.js](https://github.com/Shopify/cli/edit/main/packages/cli/blob/v3.56.1/dist/cli/commands/search.js)_ ## `shopify theme check` @@ -832,7 +832,7 @@ DESCRIPTION Validate the theme. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/check.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/check.js)_ ## `shopify theme console` @@ -857,7 +857,7 @@ DESCRIPTION Shopify Liquid REPL (read-eval-print loop) tool ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/console.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/console.js)_ ## `shopify theme delete` @@ -884,7 +884,7 @@ DESCRIPTION Delete remote themes from the connected store. This command can't be undone. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/delete.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/delete.js)_ ## `shopify theme dev` @@ -959,7 +959,7 @@ DESCRIPTION your terminal. While running, changes will push to the store in real time. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/dev.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/dev.js)_ ## `shopify theme info` @@ -977,7 +977,7 @@ DESCRIPTION Print basic information about your theme environment. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/info.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/info.js)_ ## `shopify theme init [NAME]` @@ -1002,7 +1002,7 @@ DESCRIPTION Clones a Git repository to use as a starting point for building a new theme. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/init.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/init.js)_ ## `shopify theme language-server` @@ -1020,7 +1020,7 @@ DESCRIPTION Start a Language Server Protocol server. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/language-server.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/language-server.js)_ ## `shopify theme list` @@ -1048,7 +1048,7 @@ DESCRIPTION Lists your remote themes. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/list.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/list.js)_ ## `shopify theme open` @@ -1075,7 +1075,7 @@ DESCRIPTION Opens the preview of your remote theme. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/open.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/open.js)_ ## `shopify theme package` @@ -1094,7 +1094,7 @@ DESCRIPTION Package your theme into a .zip file, ready to upload to the Online Store. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/package.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/package.js)_ ## `shopify theme publish` @@ -1118,7 +1118,7 @@ DESCRIPTION Set a remote theme as the live theme. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/publish.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/publish.js)_ ## `shopify theme pull` @@ -1148,7 +1148,7 @@ DESCRIPTION Download your remote theme files locally. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/pull.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/pull.js)_ ## `shopify theme push` @@ -1182,7 +1182,7 @@ DESCRIPTION Uploads your local theme files to the connected store, overwriting the remote version if specified. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/push.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/push.js)_ ## `shopify theme rename` @@ -1209,7 +1209,7 @@ DESCRIPTION Renames an existing theme. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/rename.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/rename.js)_ ## `shopify theme share` @@ -1233,7 +1233,7 @@ DESCRIPTION `shopify theme push -u -t=RANDOMIZED_NAME`. ``` -_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.0/dist/cli/commands/theme/share.js)_ +_See code: [@shopify/theme](https://github.com/Shopify/cli/edit/main/packages/theme/blob/v3.56.1/dist/cli/commands/theme/share.js)_ ## `shopify upgrade` @@ -1250,7 +1250,7 @@ DESCRIPTION Upgrade the Shopify CLI. ``` -_See code: [dist/cli/commands/upgrade.js](https://github.com/Shopify/cli/edit/main/packages/cli/blob/v3.56.0/dist/cli/commands/upgrade.js)_ +_See code: [dist/cli/commands/upgrade.js](https://github.com/Shopify/cli/edit/main/packages/cli/blob/v3.56.1/dist/cli/commands/upgrade.js)_ ## `shopify version` @@ -1264,7 +1264,7 @@ DESCRIPTION Shopify CLI version. ``` -_See code: [dist/cli/commands/version.js](https://github.com/Shopify/cli/edit/main/packages/cli/blob/v3.56.0/dist/cli/commands/version.js)_ +_See code: [dist/cli/commands/version.js](https://github.com/Shopify/cli/edit/main/packages/cli/blob/v3.56.1/dist/cli/commands/version.js)_ ## `shopify webhook trigger` @@ -1309,5 +1309,5 @@ DESCRIPTION Trigger delivery of a sample webhook topic payload to a designated address. ``` -_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.0/dist/cli/commands/webhook/trigger.js)_ +_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.56.1/dist/cli/commands/webhook/trigger.js)_ diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json index b770e93548..053d357a8c 100644 --- a/packages/cli/oclif.manifest.json +++ b/packages/cli/oclif.manifest.json @@ -409,5 +409,5 @@ "strict": true } }, - "version": "3.56.0" + "version": "3.56.1" } \ No newline at end of file diff --git a/packages/cli/package.json b/packages/cli/package.json index 4cdd0ce97a..21936d6739 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/cli", - "version": "3.56.0", + "version": "3.56.1", "private": false, "description": "A CLI tool to build for the Shopify platform", "keywords": [ @@ -98,13 +98,13 @@ "@oclif/plugin-commands": "2.2.24", "@oclif/plugin-help": "5.2.18", "@oclif/plugin-plugins": "3.1.8", - "@shopify/cli-kit": "3.56.0", - "@shopify/plugin-did-you-mean": "3.56.0", + "@shopify/cli-kit": "3.56.1", + "@shopify/plugin-did-you-mean": "3.56.1", "zod-to-json-schema": "3.21.4" }, "devDependencies": { - "@shopify/app": "3.56.0", - "@shopify/theme": "3.56.0", + "@shopify/app": "3.56.1", + "@shopify/theme": "3.56.1", "@types/node": "18.19.3", "@vitest/coverage-istanbul": "^0.34.3", "vite": "^4.4.9", diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md index 8adf48cad1..886800f1a0 100644 --- a/packages/create-app/CHANGELOG.md +++ b/packages/create-app/CHANGELOG.md @@ -1,5 +1,11 @@ # @shopify/create-app +## 3.56.1 + +### Patch Changes + +- @shopify/cli-kit@3.56.1 + ## 3.56.0 ### Patch Changes diff --git a/packages/create-app/oclif.manifest.json b/packages/create-app/oclif.manifest.json index e89e1faced..d71ca44269 100644 --- a/packages/create-app/oclif.manifest.json +++ b/packages/create-app/oclif.manifest.json @@ -98,5 +98,5 @@ "strict": true } }, - "version": "3.56.0" + "version": "3.56.1" } \ No newline at end of file diff --git a/packages/create-app/package.json b/packages/create-app/package.json index 8ecb3c3a03..1270e36ad6 100644 --- a/packages/create-app/package.json +++ b/packages/create-app/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/create-app", - "version": "3.56.0", + "version": "3.56.1", "private": false, "description": "A CLI tool to create a new Shopify app.", "keywords": [ @@ -50,7 +50,7 @@ }, "dependencies": { "@oclif/core": "3.15.1", - "@shopify/cli-kit": "3.56.0" + "@shopify/cli-kit": "3.56.1" }, "devDependencies": { "@types/node": "18.19.3", diff --git a/packages/plugin-cloudflare/CHANGELOG.md b/packages/plugin-cloudflare/CHANGELOG.md index b444d779b7..d97225769c 100644 --- a/packages/plugin-cloudflare/CHANGELOG.md +++ b/packages/plugin-cloudflare/CHANGELOG.md @@ -1,5 +1,11 @@ # @shopify/plugin-cloudflare +## 3.56.1 + +### Patch Changes + +- @shopify/cli-kit@3.56.1 + ## 3.56.0 ### Patch Changes diff --git a/packages/plugin-cloudflare/oclif.manifest.json b/packages/plugin-cloudflare/oclif.manifest.json index 9dd7945ecd..f1b6100754 100644 --- a/packages/plugin-cloudflare/oclif.manifest.json +++ b/packages/plugin-cloudflare/oclif.manifest.json @@ -1,5 +1,5 @@ { "commands": { }, - "version": "3.56.0" + "version": "3.56.1" } \ No newline at end of file diff --git a/packages/plugin-cloudflare/package.json b/packages/plugin-cloudflare/package.json index ce63b02ebe..54cde8567b 100644 --- a/packages/plugin-cloudflare/package.json +++ b/packages/plugin-cloudflare/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/plugin-cloudflare", - "version": "3.56.0", + "version": "3.56.1", "description": "Enables the creation of Cloudflare tunnels from `shopify app dev`, allowing previews from any device", "keywords": [ "shopify", @@ -38,7 +38,7 @@ }, "dependencies": { "@oclif/core": "3.15.1", - "@shopify/cli-kit": "3.56.0", + "@shopify/cli-kit": "3.56.1", "node-fetch": "3.3.2", "semver": "7.5.4" }, diff --git a/packages/plugin-did-you-mean/CHANGELOG.md b/packages/plugin-did-you-mean/CHANGELOG.md index 8430d5fcc8..5fe8614f4f 100644 --- a/packages/plugin-did-you-mean/CHANGELOG.md +++ b/packages/plugin-did-you-mean/CHANGELOG.md @@ -1,5 +1,11 @@ # @shopify/plugin-did-you-mean +## 3.56.1 + +### Patch Changes + +- @shopify/cli-kit@3.56.1 + ## 3.56.0 ### Patch Changes diff --git a/packages/plugin-did-you-mean/oclif.manifest.json b/packages/plugin-did-you-mean/oclif.manifest.json index d8328a6c48..dcdf70a7de 100644 --- a/packages/plugin-did-you-mean/oclif.manifest.json +++ b/packages/plugin-did-you-mean/oclif.manifest.json @@ -76,5 +76,5 @@ "strict": true } }, - "version": "3.56.0" + "version": "3.56.1" } \ No newline at end of file diff --git a/packages/plugin-did-you-mean/package.json b/packages/plugin-did-you-mean/package.json index d72eb33695..9daab7f632 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.56.0", + "version": "3.56.1", "bugs": { "url": "https://github.com/Shopify/cli/issues" }, @@ -30,7 +30,7 @@ }, "dependencies": { "@oclif/core": "3.15.1", - "@shopify/cli-kit": "3.56.0", + "@shopify/cli-kit": "3.56.1", "n-gram": "2.0.2" }, "devDependencies": { diff --git a/packages/theme/CHANGELOG.md b/packages/theme/CHANGELOG.md index 847be936ef..72070bd516 100644 --- a/packages/theme/CHANGELOG.md +++ b/packages/theme/CHANGELOG.md @@ -1,5 +1,11 @@ # @shopify/theme +## 3.56.1 + +### Patch Changes + +- @shopify/cli-kit@3.56.1 + ## 3.56.0 ### Patch Changes diff --git a/packages/theme/oclif.manifest.json b/packages/theme/oclif.manifest.json index 5ecde55256..3ff511b5b8 100644 --- a/packages/theme/oclif.manifest.json +++ b/packages/theme/oclif.manifest.json @@ -1819,5 +1819,5 @@ "strict": true } }, - "version": "3.56.0" + "version": "3.56.1" } \ No newline at end of file diff --git a/packages/theme/package.json b/packages/theme/package.json index d29588bb0c..8ea3ecdb21 100644 --- a/packages/theme/package.json +++ b/packages/theme/package.json @@ -1,6 +1,6 @@ { "name": "@shopify/theme", - "version": "3.56.0", + "version": "3.56.1", "private": false, "description": "Utilities for building and publishing themes", "homepage": "https://github.com/shopify/cli#readme", @@ -34,7 +34,7 @@ }, "dependencies": { "@oclif/core": "3.15.1", - "@shopify/cli-kit": "3.56.0", + "@shopify/cli-kit": "3.56.1", "@shopify/theme-check-node": "2.0.1", "@shopify/theme-language-server-node": "1.7.4", "yaml": "2.3.2" diff --git a/packages/ui-extensions-dev-console/CHANGELOG.md b/packages/ui-extensions-dev-console/CHANGELOG.md index cad8e3eecf..71b13e6f27 100644 --- a/packages/ui-extensions-dev-console/CHANGELOG.md +++ b/packages/ui-extensions-dev-console/CHANGELOG.md @@ -1,5 +1,7 @@ # @shopify/ui-extensions-dev-console-app +## 3.56.1 + ## 3.56.0 ## 3.55.0 diff --git a/packages/ui-extensions-dev-console/package.json b/packages/ui-extensions-dev-console/package.json index 7fdcc91b16..40de882983 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.56.0", + "version": "3.56.1", "private": true, "scripts": { "build": "nx build", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 00e4f18091..882b365560 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -161,13 +161,13 @@ importers: specifier: 3.15.1 version: 3.15.1(typescript@5.2.2) '@shopify/cli-kit': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../cli-kit '@shopify/function-runner': specifier: 4.1.1 version: 4.1.1 '@shopify/plugin-cloudflare': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../plugin-cloudflare '@shopify/polaris': specifier: 12.10.0 @@ -291,20 +291,20 @@ importers: specifier: 3.1.8 version: 3.1.8(typescript@5.2.2) '@shopify/cli-kit': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../cli-kit '@shopify/plugin-did-you-mean': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../plugin-did-you-mean zod-to-json-schema: specifier: 3.21.4 version: 3.21.4(zod@3.22.3) devDependencies: '@shopify/app': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../app '@shopify/theme': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../theme '@types/node': specifier: 18.19.3 @@ -572,7 +572,7 @@ importers: specifier: 3.15.1 version: 3.15.1(typescript@5.2.2) '@shopify/cli-kit': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../cli-kit devDependencies: '@types/node': @@ -694,7 +694,7 @@ importers: specifier: 3.15.1 version: 3.15.1(typescript@5.2.2) '@shopify/cli-kit': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../cli-kit node-fetch: specifier: 3.3.2 @@ -716,7 +716,7 @@ importers: specifier: 3.15.1 version: 3.15.1(typescript@5.2.2) '@shopify/cli-kit': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../cli-kit n-gram: specifier: 2.0.2 @@ -735,7 +735,7 @@ importers: specifier: 3.15.1 version: 3.15.1(typescript@5.2.2) '@shopify/cli-kit': - specifier: 3.56.0 + specifier: 3.56.1 version: link:../cli-kit '@shopify/theme-check-node': specifier: 2.0.1