Repository navigation
[stable/4.9] Release only the tested Version Packages head, and only the versions a push changed - #9169
Merged
craigmichaelmartin merged 1 commit intoNov 18, 2026
Conversation
…a push changed Backport of the main change, so this line publishes with the same rules: only from the merge of its Version Packages pull request whose files equal the tested head, only the versions the push changed, and never a version npm already has. Adds the manual workflow that builds a release tarball for testing. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Differences in type declarationsWe detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:
New type declarationspackages/cli-kit/dist/private/node/ui/components/TextAnimation.d.tsimport React from 'react';
interface TextAnimationProps {
text: string;
maxWidth?: number;
}
/**
* `TextAnimation` applies a rainbow animation to text.
*/
declare const TextAnimation: React.MemoExoticComponent<({ text, maxWidth }: TextAnimationProps) => JSX.Element>;
export { TextAnimation };
Existing type declarationspackages/cli-kit/dist/private/node/api.d.ts@@ -1,24 +1,14 @@
import { Headers } from 'form-data';
-import { ClientError } from 'graphql-request';
export type API = 'admin' | 'storefront-renderer' | 'partners' | 'business-platform' | 'app-management';
export declare const allAPIs: API[];
-interface CommonRetryBehaviour {
- recordCommandRetries?: boolean;
- /**
- * Retry, with backoff, requests that fail with a transient server-side error: a GraphQL
- * `INTERNAL_SERVER_ERROR` (usually on an HTTP 200) or an HTTP 502, 503, 504 or 520 to 524.
- *
- * Only enable this for requests that are safe to repeat. GraphQL requests only honour it for
- * queries; mutations are never retried on these errors.
- */
- retryTransientServerErrors?: boolean;
-}
-export type NetworkRetryBehaviour = ({
+export type NetworkRetryBehaviour = {
useNetworkLevelRetry: true;
maxRetryTimeMs: number;
-} & CommonRetryBehaviour) | ({
+ recordCommandRetries?: boolean;
+} | {
useNetworkLevelRetry: false;
-} & CommonRetryBehaviour);
+ recordCommandRetries?: boolean;
+};
type RequestOptions<T> = {
request: () => Promise<T>;
url: string;
@@ -62,15 +52,6 @@ export declare function isNetworkError(error: unknown): boolean;
* @returns A boolean indicating if the request was aborted.
*/
export declare function isAbortedFetchError(error: unknown): boolean;
-/**
- * Checks whether an error is a transient server-side failure that is likely to succeed if retried:
- * a GraphQL `INTERNAL_SERVER_ERROR` (Shopify APIs usually return it on an HTTP 200), or an HTTP
- * 502, 503, 504 or 520 to 524.
- *
- * @param error - The error to check.
- * @returns Whether the error is a transient server-side failure.
- */
-export declare function isTransientServerError(error: unknown): error is ClientError;
export declare function simpleRequestWithDebugLog<T extends {
headers: Headers;
status: number;
@@ -79,8 +60,6 @@ export declare function simpleRequestWithDebugLog<T extends {
* Makes a HTTP request to some API, retrying if response headers indicate a retryable error.
*
* If a request fails with a 429, the retry-after header determines a delay before an automatic retry is performed.
- * Without a valid header, rate-limit retries use exponential backoff with jitter, capped at 8 seconds per delay.
- * No new rate-limit retry starts after 30 seconds. A server-requested delay beyond that budget is not shortened.
*
* If unauthorizedHandler is provided, then it will be called in the case of a 401 and a retry performed. This allows
* for a token refresh for instance.
packages/cli-kit/dist/private/node/conf-store.d.ts@@ -73,7 +73,7 @@ export declare function cacheStore(key: ExportedKey, value: string, config?: Loc
/**
* Fetch from cache if already populated, otherwise return undefined.
* @param key - The key to use for the cache.
- * @returns The cache element.
+ * @returns The chache element.
*/
export declare function cacheRetrieve(key: ExportedKey, config?: LocalStorage<ConfSchema>): CacheValue<string> | undefined;
export declare function cacheClear(config?: LocalStorage<ConfSchema>): void;
packages/cli-kit/dist/private/node/constants.d.ts@@ -8,8 +8,6 @@ export declare const environmentVariables: {
env: string;
noAnalytics: string;
optOutInstrumentation: string;
- doNotTrack: string;
- serviceAccountToken: string;
appAutomationToken: string;
partnersToken: string;
runAsUser: string;
packages/cli-kit/dist/private/node/json-error.d.ts@@ -1,3 +1,16 @@
+interface FatalErrorLike {
+ type?: number;
+ message?: unknown;
+ formattedMessage?: unknown;
+ tryMessage?: unknown;
+ nextSteps?: unknown;
+ customSections?: unknown;
+ stack?: unknown;
+ command?: unknown;
+ args?: unknown;
+ details?: unknown;
+ code?: unknown;
+}
/**
* Writes the public JSON representation of a fatal error to stdout.
*
@@ -6,4 +19,5 @@
*
* @param error - Fatal error to serialize.
*/
-export declare function renderFatalErrorAsJson(error: unknown): void;
\ No newline at end of file
+export declare function renderFatalErrorAsJson(error: FatalErrorLike): void;
+export {};
\ No newline at end of file
packages/cli-kit/dist/private/node/session.d.ts@@ -61,7 +61,7 @@ export interface OAuthSession {
appManagement?: string;
userId: string;
}
-type AuthMethod = 'partners_token' | 'service_account_token' | 'device_auth' | 'theme_access_token' | 'custom_app_token' | 'none';
+type AuthMethod = 'partners_token' | 'device_auth' | 'theme_access_token' | 'custom_app_token' | 'none';
/**
* Retrieves a stable user identifier for analytics, or `'unknown'` if none applies.
*
@@ -82,8 +82,7 @@ export declare function setLastSeenUserIdAfterAuth(id: string): void;
* This function checks for the authentication method in the following order:
* 1. Returns the cached auth method if it's not 'none'.
* 2. Checks for a cached session, which implies 'device_auth' was used.
- * 3. Checks for an automation token in the environment: `service_account_token` for SHOPIFY_SERVICE_ACCOUNT_TOKEN,
- * `partners_token` for the app and Partner variables.
+ * 3. Checks for a partners token in the environment.
* 4. Checks for a theme password in the environment.
* 5. If none of the above are true, returns 'none'.
*
packages/cli-kit/dist/public/common/command-events.d.ts@@ -1,4 +1,4 @@
-import { z } from 'zod/v3';
+import { z } from 'zod';
/** Schema for a diagnostic emitted while a command executes. */
export declare const commandDiagnosticEventSchema: z.ZodObject<{
type: z.ZodLiteral<"diagnostic">;
packages/cli-kit/dist/public/common/json-output-schema.d.ts@@ -1,5 +1,4 @@
-import { z } from 'zod/v3';
-export declare const jsonOutputStoreDomainSchema: z.ZodString;
+import { z } from 'zod';
/** UTC instants in CLI-owned JSON use whole seconds and the Z timezone marker. */
export declare const jsonOutputTimestampSchema: z.ZodString;
/**
packages/cli-kit/dist/public/common/version.d.ts@@ -1 +1 @@
-export declare const CLI_KIT_VERSION = "5.0.0";
\ No newline at end of file
+export declare const CLI_KIT_VERSION = "4.9.6";
\ No newline at end of file
packages/cli-kit/dist/public/node/base-command.d.ts@@ -1,5 +1,4 @@
import { type JsonOutputSchema } from './json-output-schema.js';
-import { JsonMap } from '../../private/common/json.js';
import { Command } from '@oclif/core';
import { OutputFlags, Input, ParserOutput, FlagInput, OutputArgs } from '@oclif/core/parser';
export type ArgOutput = OutputArgs<any>;
@@ -13,7 +12,7 @@ export interface NonTTYFlagRequirement {
declare abstract class BaseCommand extends Command {
static baseFlags: FlagInput<{}>;
static descriptionWithMarkdown?: string;
- static jsonOutputSchema?: JsonOutputSchema;
+ static get jsonOutputSchema(): JsonOutputSchema | undefined;
static get requiresSyncAnalytics(): boolean;
static nonTTYFlagRequirements(_flags: FlagOutput): NonTTYFlagRequirement[];
static descriptionForHelp(): string | undefined;
@@ -21,14 +20,12 @@ declare abstract class BaseCommand extends Command {
static descriptionWithoutMarkdown(): string | undefined;
static analyticsNameOverride(): string | undefined;
static analyticsStopCommand(): string | undefined;
- private jsonOutputFromFlags;
catch(error: Error & {
skipOclifErrorHandling: boolean;
}): Promise<void>;
protected _run<T>(): Promise<T>;
protected init(): Promise<unknown>;
protected showNpmFlagWarning(): void;
- protected showDeprecatedAutomationTokenVariableWarning(): Promise<void>;
protected exitWithTimestampWhenEnvVariablePresent(): void;
protected parse<TFlags extends FlagOutput & {
path?: string;
@@ -37,12 +34,7 @@ declare abstract class BaseCommand extends Command {
}, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(options?: Input<TFlags, TGlobalFlags, TArgs>, argv?: string[]): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & {
argv: string[];
}>;
- protected runWithParsedOutput<T>(flags: FlagOutput, execute: () => T): T;
protected environmentsFilename(): string | undefined;
- /** Filters configuration flags before they are applied, validated, or reported. */
- protected filterEnvironmentFlags(environment: FlagOutput): FlagOutput;
- protected parseEnvironmentFlags<TFlags extends FlagOutput, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(environment: JsonMap, options: Input<TFlags, TGlobalFlags, TArgs>, explicitFlags: FlagOutput): Promise<FlagOutput>;
- protected validateNonTTYFlags(flags: FlagOutput): void;
protected failMissingNonTTYFlags(flags: FlagOutput, requiredFlags: string[]): void;
private failMissingNonTTYFlagRequirements;
private applicableNonTTYFlagRequirements;
packages/cli-kit/dist/public/node/command-events.d.ts@@ -8,13 +8,13 @@ export { commandEventOutputMode, emitCommandEvent, runWithCommandEvents, type Co
* @returns The result of the command lifecycle.
*/
export declare function runWithCommandEventsForCommand<TResult>(argv: string[], execute: () => TResult): TResult;
-export declare const commandEventOutputSchema: import("./json-output-schema.js").JsonOutputSchema<import("zod/v3").ZodDiscriminatedUnion<"type", [import("zod/v3").ZodObject<{
- type: import("zod/v3").ZodLiteral<"diagnostic">;
- timestamp: import("zod/v3").ZodString;
- level: import("zod/v3").ZodEnum<["debug", "info", "warning", "error"]>;
- message: import("zod/v3").ZodString;
- code: import("zod/v3").ZodOptional<import("zod/v3").ZodString>;
-}, "strict", import("zod/v3").ZodTypeAny, {
+export declare const commandEventOutputSchema: import("./json-output-schema.js").JsonOutputSchema<import("zod").ZodDiscriminatedUnion<"type", [import("zod").ZodObject<{
+ type: import("zod").ZodLiteral<"diagnostic">;
+ timestamp: import("zod").ZodString;
+ level: import("zod").ZodEnum<["debug", "info", "warning", "error"]>;
+ message: import("zod").ZodString;
+ code: import("zod").ZodOptional<import("zod").ZodString>;
+}, "strict", import("zod").ZodTypeAny, {
type: "diagnostic";
message: string;
timestamp: string;
@@ -26,15 +26,15 @@ export declare const commandEventOutputSchema: import("./json-output-schema.js")
timestamp: string;
level: "info" | "error" | "debug" | "warning";
code?: string | undefined;
-}>, import("zod/v3").ZodObject<{
- type: import("zod/v3").ZodLiteral<"progress">;
- timestamp: import("zod/v3").ZodString;
- status: import("zod/v3").ZodEnum<["started", "updated", "retrying", "completed", "failed"]>;
- operation: import("zod/v3").ZodString;
- message: import("zod/v3").ZodOptional<import("zod/v3").ZodString>;
- current: import("zod/v3").ZodOptional<import("zod/v3").ZodNumber>;
- total: import("zod/v3").ZodOptional<import("zod/v3").ZodNumber>;
-}, "strict", import("zod/v3").ZodTypeAny, {
+}>, import("zod").ZodObject<{
+ type: import("zod").ZodLiteral<"progress">;
+ timestamp: import("zod").ZodString;
+ status: import("zod").ZodEnum<["started", "updated", "retrying", "completed", "failed"]>;
+ operation: import("zod").ZodString;
+ message: import("zod").ZodOptional<import("zod").ZodString>;
+ current: import("zod").ZodOptional<import("zod").ZodNumber>;
+ total: import("zod").ZodOptional<import("zod").ZodNumber>;
+}, "strict", import("zod").ZodTypeAny, {
type: "progress";
status: "started" | "updated" | "retrying" | "completed" | "failed";
timestamp: string;
packages/cli-kit/dist/public/node/environment.d.ts@@ -10,13 +10,10 @@
*/
export declare function getEnvironmentVariables(): NodeJS.ProcessEnv;
/**
- * Returns the automation token the CLI authenticates with, from the first of these variables that is set:
- * SHOPIFY_SERVICE_ACCOUNT_TOKEN, or the deprecated SHOPIFY_APP_AUTOMATION_TOKEN and SHOPIFY_CLI_PARTNERS_TOKEN.
+ * Returns the value of the SHOPIFY_APP_AUTOMATION_TOKEN environment variable,
+ * falling back to the deprecated SHOPIFY_CLI_PARTNERS_TOKEN.
*
- * Returns undefined when the variables can't be used (an empty value, or the service account variable set alongside
- * another one). Callers then fall back to the login flow, which reports the problem instead of logging in.
- *
- * @returns The automation token, or undefined if there is no usable one.
+ * @returns The app automation token value, or undefined if neither env var is set.
*/
export declare function getAppAutomationToken(): string | undefined;
/**
packages/cli-kit/dist/public/node/is-global.d.ts@@ -12,13 +12,6 @@ export declare function currentProcessIsGlobal(argv?: string[]): boolean;
* @param packageManager - The package manager to use.
*/
export declare function installGlobalShopifyCLI(packageManager: PackageManager): Promise<void>;
-/**
- * Returns the Homebrew formula that installed the running CLI.
- *
- * @param env - Environment variables set by the Homebrew wrapper.
- * @returns The wrapper's formula name, or the unversioned formula for older installs.
- */
-export declare function getHomebrewCLIFormula(env?: NodeJS.ProcessEnv): string;
export interface InstallGlobalCLIPromptResult {
install: boolean;
alreadyInstalled: boolean;
packages/cli-kit/dist/public/node/json-output-schema.d.ts@@ -1,6 +1,6 @@
import { zodToJsonSchema } from 'zod-to-json-schema';
-import type { ZodTypeAny, z } from 'zod/v3';
-export { formatJsonOutputTimestamp, jsonOutputTimestampSchema, jsonOutputStoreDomainSchema, } from '../common/json-output-schema.js';
+import type { ZodTypeAny, z } from 'zod';
+export { formatJsonOutputTimestamp, jsonOutputTimestampSchema } from '../common/json-output-schema.js';
interface JsonOutputSchemaDefinition<TSchema extends ZodTypeAny = ZodTypeAny> {
readonly name: string;
readonly schema: TSchema;
packages/cli-kit/dist/public/node/node-package-manager.d.ts@@ -137,16 +137,13 @@ export declare function usesWorkspaces(appDirectory: string): Promise<boolean>;
* @param currentVersion - The current version.
* @param cacheExpiryInHours - If the last check was done more than this amount of hours ago, it will
* refresh the cache. Defaults to always refreshing.
- * @param versionRange - An optional semver range that limits the versions considered.
* @returns A promise that resolves with a more recent version or undefined if there's no more recent version.
*/
-export declare function checkForNewVersion(dependency: string, currentVersion: string, { cacheExpiryInHours, versionRange }?: {
+export declare function checkForNewVersion(dependency: string, currentVersion: string, { cacheExpiryInHours }?: {
cacheExpiryInHours?: number | undefined;
- versionRange?: string;
}): Promise<string | undefined>;
/**
* Given an NPM dependency, it checks if there's a cached more recent version, and if there is, it returns its value.
- * For Shopify CLI, reads only fresh entries from the registry resolved by an earlier version lookup.
* @param dependency - The dependency name (e.g. react)
* @param currentVersion - The current version.
* @returns A more recent version or undefined if there's no more recent version.
packages/cli-kit/dist/public/node/notifications-system.d.ts@@ -26,7 +26,7 @@ declare const NotificationSchema: zod.ZodObject<{
id: string;
type: "info" | "error" | "warning";
message: string;
- frequency: "once" | "always" | "once_a_day" | "once_a_week";
+ frequency: "always" | "once" | "once_a_day" | "once_a_week";
ownerChannel: string;
title?: string | undefined;
cta?: {
@@ -43,7 +43,7 @@ declare const NotificationSchema: zod.ZodObject<{
id: string;
type: "info" | "error" | "warning";
message: string;
- frequency: "once" | "always" | "once_a_day" | "once_a_week";
+ frequency: "always" | "once" | "once_a_day" | "once_a_week";
ownerChannel: string;
title?: string | undefined;
cta?: {
@@ -86,7 +86,7 @@ declare const NotificationsSchema: zod.ZodObject<{
id: string;
type: "info" | "error" | "warning";
message: string;
- frequency: "once" | "always" | "once_a_day" | "once_a_week";
+ frequency: "always" | "once" | "once_a_day" | "once_a_week";
ownerChannel: string;
title?: string | undefined;
cta?: {
@@ -103,7 +103,7 @@ declare const NotificationsSchema: zod.ZodObject<{
id: string;
type: "info" | "error" | "warning";
message: string;
- frequency: "once" | "always" | "once_a_day" | "once_a_week";
+ frequency: "always" | "once" | "once_a_day" | "once_a_week";
ownerChannel: string;
title?: string | undefined;
cta?: {
@@ -122,7 +122,7 @@ declare const NotificationsSchema: zod.ZodObject<{
id: string;
type: "info" | "error" | "warning";
message: string;
- frequency: "once" | "always" | "once_a_day" | "once_a_week";
+ frequency: "always" | "once" | "once_a_day" | "once_a_week";
ownerChannel: string;
title?: string | undefined;
cta?: {
@@ -141,7 +141,7 @@ declare const NotificationsSchema: zod.ZodObject<{
id: string;
type: "info" | "error" | "warning";
message: string;
- frequency: "once" | "always" | "once_a_day" | "once_a_week";
+ frequency: "always" | "once" | "once_a_day" | "once_a_week";
ownerChannel: string;
title?: string | undefined;
cta?: {
@@ -172,7 +172,7 @@ export declare function showNotificationsIfNeeded(currentSurfaces?: string[], en
*/
export declare function getNotifications(): Promise<Notifications>;
/**
- * Fetch notifications from the CDN and cache them.
+ * Fetch notifications from the CDN and chache them.
*
* @returns A string with the notifications.
*/
packages/cli-kit/dist/public/node/path.d.ts@@ -1,7 +1,4 @@
import type { URL } from 'url';
-interface IsSubpathOptions {
- native?: boolean;
-}
/**
* Joins a list of paths together.
*
@@ -93,25 +90,13 @@ export declare function commonParentDirectory(first: string, second: string): st
*/
export declare function relativizePath(path: string, dir?: string): string;
/**
- * Given 2 paths, it returns whether the second path is inside or equal to the first path.
- *
- * By default, paths are compared with pathe, which treats `\` as a separator
- * on every platform. This behaviour is kept for backward compatibility.
- *
- * When `native` is true, paths are compared with the current OS's native path
- * semantics, so literal backslashes on POSIX are preserved as filename
- * characters. Use `native: true` for security or containment checks on
- * resolved filesystem paths.
- *
- * Symbolic links are not resolved; use fileRealPath from the fs module first
- * when checking physical containment.
+ * Given 2 paths, it returns whether the second path is a subpath of the first path.
*
* @param mainPath - The main path.
* @param subpath - The subpath.
- * @param options - Comparison options. Set `native` to true to use the OS's native path semantics. Defaults to false.
- * @returns Whether the subpath is inside or equal to the main path.
+ * @returns Whether the subpath is a subpath of the main path.
*/
-export declare function isSubpath(mainPath: string, subpath: string, options?: IsSubpathOptions): boolean;
+export declare function isSubpath(mainPath: string, subpath: string): boolean;
/**
* Given a module's import.meta.url it returns the directory containing the module.
*
@@ -153,5 +138,4 @@ export declare function sniffForJson(argv?: string[]): boolean;
* @param warn - Called with a human-readable warning when traversal segments are removed.
* @returns The sanitized path (may be an empty string if all segments were traversal).
*/
-export declare function sanitizeRelativePath(input: string, warn: (msg: string) => void): string;
-export {};
\ No newline at end of file
+export declare function sanitizeRelativePath(input: string, warn: (msg: string) => void): string;
\ No newline at end of file
packages/cli-kit/dist/public/node/schema.d.ts@@ -1,5 +1,5 @@
-import { ZodObject, z } from 'zod/v3';
-export { z as zod } from 'zod/v3';
+import { ZodObject, z } from 'zod';
+export { z as zod } from 'zod';
/**
* Type alias for a zod object schema that produces a given shape once parsed.
*/
packages/cli-kit/dist/public/node/session.d.ts@@ -121,10 +121,6 @@ export declare function ensureAuthenticatedAdmin(store: string, scopes?: AdminAP
* If a password is provided, that token will be used against Theme Access API.
* Otherwise, it will ensure that the user is authenticated with the Admin API.
*
- * Theme Access passwords only work with the store's permanent `.myshopify.com` domain, so when the password is a
- * Theme Access password the returned session uses the permanent domain of `store`, even if `store` is another of the
- * store's domains.
- *
* @param store - Store fqdn to request auth for.
* @param password - Password generated from Theme Access app.
* @param scopes - Optional array of extra scopes to authenticate with.
@@ -132,44 +128,14 @@ export declare function ensureAuthenticatedAdmin(store: string, scopes?: AdminAP
* @returns The access token and store.
*/
export declare function ensureAuthenticatedThemes(store: string, password: string | undefined, scopes?: AdminAPIScope[], options?: EnsureAuthenticatedAdditionalOptions): Promise<AdminSession>;
-/**
- * Options for `ensureAuthenticatedBusinessPlatform`.
- */
-export interface EnsureAuthenticatedBusinessPlatformOptions extends EnsureAuthenticatedAdditionalOptions {
- /**
- * Authenticate with the automation token set in the environment, when there is one, instead of the
- * logged-in user. Only commands that support automation tokens opt in; other callers, such as
- * Hydrogen's login, keep using the user's session.
- */
- allowAutomationToken?: boolean;
-}
/**
* Ensure that we have a valid session to access the Business Platform API.
*
- * @param scopes - Optional array of extra scopes to authenticate with. Ignored when an automation token is used.
+ * @param scopes - Optional array of extra scopes to authenticate with.
* @param options - Optional extra options to use.
* @returns The access token for the Business Platform API.
*/
-export declare function ensureAuthenticatedBusinessPlatform(scopes?: BusinessPlatformScope[], options?: EnsureAuthenticatedBusinessPlatformOptions): Promise<string>;
-/**
- * Whether SHOPIFY_SERVICE_ACCOUNT_TOKEN is set, which makes it the automation token the CLI authenticates with.
- *
- * True even when it's empty or set together with another automation token variable. Commands use this to skip logins
- * saved on this machine, and authentication then reports any problem with the variables.
- *
- * @returns True when SHOPIFY_SERVICE_ACCOUNT_TOKEN is set.
- */
-export declare function isServiceAccountTokenSet(): boolean;
-/**
- * Fails when SHOPIFY_SERVICE_ACCOUNT_TOKEN is set, for commands that can't run with that token.
- *
- * Service account tokens can't log in as a user or call a store's Admin API, so commands that need either
- * refuse to run instead of quietly using the person's own login. `ensureAuthenticated` runs this check before any
- * login. Commands that run on a login saved by `shopify store auth` call it before loading that login.
- *
- * @throws AbortError when SHOPIFY_SERVICE_ACCOUNT_TOKEN is set.
- */
-export declare function ensureNoServiceAccountToken(): void;
+export declare function ensureAuthenticatedBusinessPlatform(scopes?: BusinessPlatformScope[], options?: EnsureAuthenticatedAdditionalOptions): Promise<string>;
/**
* Logout from Shopify.
*
@@ -181,8 +147,7 @@ export declare function logout(): Promise<void>;
*
* See `ensureAuthenticatedAdmin` for access on behalf of a user.
*
- * @param storeFqdn - Store handle or domain, normalized with `normalizeStoreFqdn`. Unsupported URL components are
- * rejected before the client secret is sent.
+ * @param storeFqdn - Store fqdn to request auth for.
* @param clientId - Client ID of the app.
* @param clientSecret - Client secret of the app.
* @returns The access token for the Admin API.
packages/cli-kit/dist/public/node/system.d.ts@@ -8,8 +8,6 @@ export interface ExecOptions {
stderr?: Writable | 'inherit';
stdio?: 'inherit';
input?: string;
- /** Whether to remove the final newline from captured stdout/stderr (default: true). */
- stripFinalNewline?: boolean;
signal?: AbortSignal;
externalErrorHandler?: (error: unknown) => Promise<void>;
background?: boolean;
@@ -44,7 +42,6 @@ export interface CaptureOutputResult {
/**
* Runs a command asynchronously and returns stdout, stderr, and exit code.
* Unlike captureOutput, this function does NOT throw on non-zero exit codes.
- * Startup failures and signal termination still throw an ExternalError.
*
* @param command - Command to be executed.
* @param args - Arguments to pass to the command.
@@ -64,7 +61,6 @@ export declare function captureOutputWithExitCode(command: string, args: string[
* Runs a command string asynchronously and returns stdout, stderr, and exit code.
* Parses the command string into command and arguments (handles quoted strings).
* Unlike captureOutput, this function does NOT throw on non-zero exit codes.
- * Startup failures and signal termination still throw an ExternalError.
*
* @param command - Full command string to be executed (e.g., 'ls -la "my folder"').
* @param options - Optional settings for how to run the command.
packages/cli-kit/dist/public/node/ui.d.ts@@ -325,9 +325,9 @@ export interface RenderSingleTaskOptions<T> {
renderOptions?: RenderOptions;
}
/**
- * Awaits a single task and displays a loading indicator while it's in progress. The task's result is returned.
+ * Awaits a single task and displays a loading bar while it's in progress. The task's result is returned.
* @param options - Configuration object
- * @param options.title - The initial title to display with the loading indicator
+ * @param options.title - The initial title to display with the loading bar
* @param options.task - The async task to execute. Receives an updateStatus callback to change the displayed title.
* @param options.retry - The number of additional attempts after a failure. Defaults to zero.
* @param options.renderOptions - Optional render configuration
@@ -375,30 +375,10 @@ export interface RenderDangerousConfirmationPromptOptions extends Omit<Dangerous
*
*/
export declare function renderDangerousConfirmationPrompt({ renderOptions, ...props }: RenderDangerousConfirmationPromptOptions, uiDebugOptions?: UIDebugOptions): Promise<boolean>;
-interface KeypressOptions {
- /**
- * The keys that end the wait, for example `['\r']` for Enter. Other keys are ignored.
- * Without this option, any key ends the wait.
- */
- keys?: string[];
-}
-/**
- * Waits for a key to be pressed. Ctrl+C rejects with AbortSilentError, which terminates the process.
- *
- * Raw mode is set back to the state it had before the call. A command that keeps stdin raw for
- * its own single-key shortcuts (for example `theme dev`) keeps them.
- *
- * Chunks are read as text: an active Ink renderer calls `stdin.setEncoding('utf8')`, and then
- * stdin emits strings instead of Buffers.
- *
- * @param stdin - The stream to read from.
- * @param uiDebugOptions - Debug options; `skipTTYCheck` allows a non-TTY stdin.
- * @param options - The keys that end the wait.
- * @returns A promise that resolves when an accepted key is pressed.
- */
+/** Waits for any key to be pressed except Ctrl+C which will terminate the process. */
export declare const keypress: (stdin?: NodeJS.ReadStream & {
fd: 0;
-}, uiDebugOptions?: UIDebugOptions, { keys }?: KeypressOptions) => Promise<void>;
+}, uiDebugOptions?: UIDebugOptions) => Promise<unknown>;
interface IsTTYOptions {
stdin?: NodeJS.ReadStream;
uiDebugOptions?: UIDebugOptions;
packages/cli-kit/dist/public/node/upgrade.d.ts@@ -1,15 +1,12 @@
import { getAutoUpgradeEnabled, setAutoUpgradeEnabled } from '../../private/node/conf-store.js';
-import type { UpgradeResult } from './upgrade/types.js';
export { getAutoUpgradeEnabled, setAutoUpgradeEnabled };
/**
* Utility function for generating an install command for the user to run
* to install an updated version of Shopify CLI.
*
- * @param version - The version or dist-tag to install. Homebrew can't
- * install a specific version, so it always upgrades to the formula's current version.
* @returns A string with the command to run, or undefined if the package manager cannot be determined.
*/
-export declare function cliInstallCommand(version: string): string | undefined;
+export declare function cliInstallCommand(): string | undefined;
/**
* Options for {@link runCLIUpgrade}.
*/
@@ -21,13 +18,6 @@ export interface RunCLIUpgradeOptions {
* their `package.json` / lockfile in the background.
*/
autoupgrade?: boolean;
- /**
- * The exact version to install. The auto-upgrade hook passes the version it already
- * vetted, such as one that isn't a major version change, so the install can't drift to
- * whatever `latest` points at by the time the package manager runs. When omitted, the
- * CLI installs `latest`.
- */
- version?: string;
}
/**
* Runs the CLI upgrade using the appropriate package manager.
@@ -38,14 +28,7 @@ export interface RunCLIUpgradeOptions {
*/
export declare function runCLIUpgrade(options?: RunCLIUpgradeOptions): Promise<void>;
/**
- * Upgrades the CLI and returns the outcome independently of final presentation.
- *
- * @param options - Whether the upgrade was triggered automatically.
- * @returns The verified global version, local dependency update, or skip reason.
- */
-export declare function upgradeCLI(options?: RunCLIUpgradeOptions): Promise<UpgradeResult>;
-/**
- * Reads a fresh cached stable release in the current major, or skips automatic upgrades.
+ * Returns the version to auto-upgrade to, or undefined if auto-upgrade should be skipped.
* Auto-upgrade is enabled by default and can be disabled via `setAutoUpgradeEnabled(false)`.
* Also skips for CI, pre-release versions, or when no newer version is available.
*
@@ -65,9 +48,9 @@ export declare function versionToAutoUpgrade(): string | undefined;
*/
export declare function hasBlockingAutoUpgradeNotification(): Promise<boolean>;
/**
- * Shows a daily notice for a new major, independently of automatic same-major upgrades.
- * When auto-upgrade is disabled, also shows notices for minor and patch releases.
- * Skipped in CI and for pre-release versions.
+ * Shows a daily upgrade-available warning for users who have not enabled auto-upgrade.
+ * Skipped in CI and for pre-release versions. When auto-upgrade is enabled this is a no-op
+ * because the postrun hook will handle the upgrade directly.
*/
export declare function warnIfUpgradeAvailable(): Promise<void>;
/**
packages/cli-kit/dist/public/node/version.d.ts@@ -8,16 +8,9 @@ export declare function localCLIVersion(directory: string): Promise<string | und
/**
* Returns the version of the globally installed CLI, only if it's greater than 3.59.0 (when the global CLI was introduced).
*
- * @param binary - The CLI command to locate and run.
* @returns The version of the CLI if it is globally installed or undefined.
*/
-export declare function globalCLIVersion(binary?: string): Promise<string | undefined>;
-/**
- * Refreshes Homebrew metadata and returns the stable version of the running CLI's formula.
- *
- * @returns The available version, or undefined when the refresh fails or takes too long, or the formula cannot be read.
- */
-export declare function availableHomebrewCLIVersion(): Promise<string | undefined>;
+export declare function globalCLIVersion(): Promise<string | undefined>;
/**
* Returns true if the given version is a pre-release version.
* Meaning is a `nightly`, `snapshot`, or `experimental` version.
packages/cli-kit/dist/private/node/analytics/graphql-error-codes.d.ts@@ -36,11 +36,4 @@ export declare function isPermissionCode(code: string | undefined): boolean;
* @param errors - The `errors` value from a GraphQL response.
* @returns True when a rate-limit code is present in any error.
*/
-export declare function hasRateLimitCode(errors: unknown): boolean;
-/**
- * Whether any GraphQL error carries a transient server-side failure code.
- *
- * @param errors - The `errors` value from a GraphQL response.
- * @returns True when a transient server code is present in any error.
- */
-export declare function hasTransientServerCode(errors: unknown): boolean;
\ No newline at end of file
+export declare function hasRateLimitCode(errors: unknown): boolean;
\ No newline at end of file
packages/cli-kit/dist/private/node/api/graphql.d.ts@@ -1,4 +1,4 @@
-import { ClientError, Variables } from 'graphql-request';
+import { Variables } from 'graphql-request';
export declare function debugLogRequestInfo(api: string, query: string, url: string, variables?: Variables, headers?: Record<string, string>): void;
export declare function sanitizeVariables(variables: Variables): string;
/**
@@ -11,5 +11,4 @@ export declare function sanitizeVariables(variables: Variables): string;
* the full JSON representation if no messages can be extracted.
*/
export declare function extractGraphQLErrorMessages(errors: any[] | undefined): string | undefined;
-export declare function errorHandler(api: string): (error: unknown, requestId?: string) => unknown;
-export declare function extractGraphQLErrors(error: unknown): NonNullable<ClientError['response']['errors']>;
\ No newline at end of file
+export declare function errorHandler(api: string): (error: unknown, requestId?: string) => unknown;
\ No newline at end of file
packages/cli-kit/dist/private/node/api/status-checks.d.ts@@ -2,6 +2,6 @@
* Checks whether an HTTP status indicates a gateway-level failure.
*
* @param status - The HTTP status to check.
- * @returns Whether the status is 502, 503, 504, or a Cloudflare edge error from 520 to 524.
+ * @returns Whether the status is 502, 503, or 504.
*/
export declare function isGatewayErrorStatus(status: number | undefined): boolean;
\ No newline at end of file
packages/cli-kit/dist/private/node/session/exchange.d.ts@@ -4,9 +4,6 @@ import { Result } from '../../../public/node/result.js';
export declare class InvalidGrantError extends Error {
}
export declare class InvalidRequestError extends Error {
- /** Identity's `error_description`, when it sent one. Says what about the request was invalid. */
- readonly description: string;
- constructor(description?: string);
}
export interface ExchangeScopes {
admin: string[];
@@ -48,10 +45,9 @@ export declare function exchangeAppAutomationTokenForAppManagementAccessToken(to
/**
* Given a custom app automation token passed as ENV variable, request a valid Business Platform API token.
* @param token - The app automation token passed as ENV variable `SHOPIFY_APP_AUTOMATION_TOKEN`
- * @param scopes - The scopes to request. An empty list makes Identity issue every Business Platform scope the token holds.
* @returns An instance with the application access tokens.
*/
-export declare function exchangeAppAutomationTokenForBusinessPlatformAccessToken(token: string, scopes?: string[]): Promise<{
+export declare function exchangeAppAutomationTokenForBusinessPlatformAccessToken(token: string): Promise<{
accessToken: string;
userId: string;
}>;
packages/cli-kit/dist/public/node/context/local.d.ts@@ -52,7 +52,7 @@ export declare function isUnitTest(env?: NodeJS.ProcessEnv): boolean;
* Returns true if reporting analytics is enabled.
*
* @param env - The environment variables from the environment of the current process.
- * @returns True unless SHOPIFY_CLI_NO_ANALYTICS, OPT_OUT_INSTRUMENTATION or DO_NOT_TRACK is truthy, or debug mode is enabled.
+ * @returns True unless SHOPIFY_CLI_NO_ANALYTICS or OPT_OUT_INSTRUMENTATION is truthy, or debug mode is enabled.
*/
export declare function analyticsDisabled(env?: NodeJS.ProcessEnv): boolean;
/**
packages/cli-kit/dist/public/node/error/schema.d.ts@@ -30,24 +30,24 @@ export declare const JsonAbortErrorSchema: zod.ZodObject<{
type: "abort";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}, {
type: "abort";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}>;
export declare const JsonBugErrorSchema: zod.ZodObject<{
stack: zod.ZodOptional<zod.ZodString>;
@@ -71,7 +71,6 @@ export declare const JsonBugErrorSchema: zod.ZodObject<{
type: "bug";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
stack?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
@@ -79,11 +78,11 @@ export declare const JsonBugErrorSchema: zod.ZodObject<{
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}, {
type: "bug";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
stack?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
@@ -91,6 +90,7 @@ export declare const JsonBugErrorSchema: zod.ZodObject<{
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}>;
export declare const JsonExternalErrorSchema: zod.ZodObject<{
command: zod.ZodString;
@@ -117,26 +117,26 @@ export declare const JsonExternalErrorSchema: zod.ZodObject<{
command: string;
args: string[];
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}, {
type: "external";
message: string;
command: string;
args: string[];
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}>;
export declare const JsonErrorSchema: zod.ZodUnion<[zod.ZodObject<{
message: zod.ZodString;
@@ -159,24 +159,24 @@ export declare const JsonErrorSchema: zod.ZodUnion<[zod.ZodObject<{
type: "abort";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}, {
type: "abort";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}>, zod.ZodObject<{
stack: zod.ZodOptional<zod.ZodString>;
message: zod.ZodString;
@@ -199,7 +199,6 @@ export declare const JsonErrorSchema: zod.ZodUnion<[zod.ZodObject<{
type: "bug";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
stack?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
@@ -207,11 +206,11 @@ export declare const JsonErrorSchema: zod.ZodUnion<[zod.ZodObject<{
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}, {
type: "bug";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
stack?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
@@ -219,6 +218,7 @@ export declare const JsonErrorSchema: zod.ZodUnion<[zod.ZodObject<{
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}>, zod.ZodObject<{
command: zod.ZodString;
args: zod.ZodArray<zod.ZodString, "many">;
@@ -244,26 +244,26 @@ export declare const JsonErrorSchema: zod.ZodUnion<[zod.ZodObject<{
command: string;
args: string[];
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}, {
type: "external";
message: string;
command: string;
args: string[];
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}>]>;
export declare const jsonErrorOutputSchema: import("../json-output-schema.js").JsonOutputSchema<zod.ZodObject<{
error: zod.ZodUnion<[zod.ZodObject<{
@@ -287,24 +287,24 @@ export declare const jsonErrorOutputSchema: import("../json-output-schema.js").J
type: "abort";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}, {
type: "abort";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}>, zod.ZodObject<{
stack: zod.ZodOptional<zod.ZodString>;
message: zod.ZodString;
@@ -327,7 +327,6 @@ export declare const jsonErrorOutputSchema: import("../json-output-schema.js").J
type: "bug";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
stack?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
@@ -335,11 +334,11 @@ export declare const jsonErrorOutputSchema: import("../json-output-schema.js").J
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}, {
type: "bug";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
stack?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
@@ -347,6 +346,7 @@ export declare const jsonErrorOutputSchema: import("../json-output-schema.js").J
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}>, zod.ZodObject<{
command: zod.ZodString;
args: zod.ZodArray<zod.ZodString, "many">;
@@ -372,44 +372,43 @@ export declare const jsonErrorOutputSchema: import("../json-output-schema.js").J
command: string;
args: string[];
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}, {
type: "external";
message: string;
command: string;
args: string[];
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
}>]>;
}, "strict", zod.ZodTypeAny, {
error: {
type: "abort";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
} | {
type: "bug";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
stack?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
@@ -417,37 +416,37 @@ export declare const jsonErrorOutputSchema: import("../json-output-schema.js").J
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
} | {
type: "external";
message: string;
command: string;
args: string[];
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
};
}, {
error: {
type: "abort";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
} | {
type: "bug";
message: string;
code?: string | undefined;
- tryMessage?: string | undefined;
stack?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
@@ -455,18 +454,19 @@ export declare const jsonErrorOutputSchema: import("../json-output-schema.js").J
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
} | {
type: "external";
message: string;
command: string;
args: string[];
code?: string | undefined;
- tryMessage?: string | undefined;
nextSteps?: string[] | undefined;
customSections?: {
body: string | string[][];
title?: string | undefined;
}[] | undefined;
details?: unknown;
+ tryMessage?: string | undefined;
};
}>>;
\ No newline at end of file
packages/cli-kit/dist/public/node/error/types.d.ts@@ -1,5 +1,5 @@
import type { JsonAbortErrorSchema, JsonBugErrorSchema, JsonErrorCustomSectionSchema, JsonErrorSchema, JsonExternalErrorSchema, jsonErrorOutputSchema } from './schema.js';
-import type { z } from 'zod/v3';
+import type { z } from 'zod';
export type JsonErrorCustomSection = z.infer<typeof JsonErrorCustomSectionSchema>;
export type JsonAbortError = z.infer<typeof JsonAbortErrorSchema>;
export type JsonBugError = z.infer<typeof JsonBugErrorSchema>;
packages/cli-kit/dist/public/node/graphiql/server.d.ts@@ -27,14 +27,13 @@ export declare function resolveGraphiQLKey(providedKey: string | undefined, apiS
* - `getToken` may return a cached token; the proxy calls it for every request.
* - `refreshToken` (optional) is invoked when the upstream Admin API returns 401.
* When omitted, the proxy falls back to calling `getToken` again on 401.
- * - Both operations receive a cancellation signal to pass to token requests.
*
* Implementations must throw `TokenRefreshError` (or any thrown error) when the
* token cannot be obtained; the proxy renders the unauthorized template in that case.
*/
export interface TokenProvider {
- getToken: (signal?: AbortSignal) => Promise<string>;
- refreshToken?: (signal?: AbortSignal) => Promise<string>;
+ getToken: () => Promise<string>;
+ refreshToken?: () => Promise<string>;
}
/**
* Optional app-specific context, used to render the app pill and scopes note in the
@@ -66,10 +65,6 @@ export interface SetupGraphiQLServerOptions {
* interactive UI.
*/
protectMutations?: boolean;
- /** Called for request failures that leave the server available for subsequent requests. */
- onRequestError?: (message: string) => void;
- /** Routes diagnostics through command events and leaves readiness output to the session. */
- json?: boolean;
}
export declare const MUTATIONS_BLOCKED_MESSAGE = "Mutations are disabled. Re-run with --allow-mutations to enable mutations.";
/**
packages/cli-kit/dist/public/node/graphiql/session.d.ts@@ -22,7 +22,6 @@ export interface RunGraphiQLSessionOptions {
additionalReadyMessages?: OutputMessage[];
abortSignal?: AbortSignal;
stdout?: Writable;
- outputFormat?: 'text' | 'json';
}
/**
* Generates a random key suitable for authenticating a single local GraphiQL session.
packages/cli-kit/dist/public/node/hooks/postrun.d.ts@@ -22,9 +22,8 @@ export declare function postRunHookHasCompleted(): boolean;
export declare function waitForPostRunHookAndExit(): void;
export declare const hook: Hook.Postrun;
/**
- * Checks release notices and auto-upgrades the CLI after a command completes.
- * Notices have their own daily limit. Upgrade attempts run once per day unless forced
- * via SHOPIFY_CLI_FORCE_AUTO_UPGRADE.
+ * Auto-upgrades the CLI after a command completes, if a newer version is available.
+ * The entire flow is rate-limited to once per day unless forced via SHOPIFY_CLI_FORCE_AUTO_UPGRADE.
*
* @returns Resolves when the upgrade attempt (or fallback warning) is complete.
*/
packages/cli-kit/dist/public/node/hooks/prerun.d.ts@@ -11,7 +11,7 @@ export declare function parseCommandContent(cmdInfo: {
pluginAlias?: string;
}): CommandContent;
/**
- * Starts a shared background lookup for release notices, manual-upgrade hints and automatic upgrades.
- * The postrun hook reads fresh cached versions without waiting for an in-flight lookup.
+ * Triggers a background check for a newer CLI version (non-blocking).
+ * The result is cached and consumed by the postrun hook for auto-upgrade.
*/
export declare function checkForNewVersionInBackground(): Promise<void>;
\ No newline at end of file
packages/cli-kit/dist/public/node/themes/api.d.ts@@ -34,15 +34,6 @@ export declare function metafieldDefinitionsByOwnerType(type: MetafieldOwnerType
};
}[]>;
export declare function passwordProtected(session: AdminSession): Promise<boolean>;
-/**
- * Whether the error ends a Trust Battery challenge on a theme request. A caller that
- * retries theme requests must rethrow it, or the user is asked to verify again for
- * each attempt.
- *
- * @param error - The error to check.
- * @returns True when the error ends a Trust Battery challenge.
- */
-export declare function isTrustChallengeError(error: unknown): boolean;
type OnlineStoreThemeFileBody = {
__typename: 'OnlineStoreThemeFileBodyBase64';
contentBase64: string;
packages/cli-kit/dist/public/node/themes/theme-manager.d.ts@@ -11,12 +11,5 @@ export declare abstract class ThemeManager {
findOrCreate(name?: string, role?: Role): Promise<Theme>;
fetch(name?: string, role?: Role): Promise<Theme | undefined>;
generateThemeName(context: string): string;
- create(themeRole?: Role, themeName?: string): Promise<{
- createdAtRuntime: boolean;
- id: number;
- name: string;
- processing: boolean;
- role: string;
- src?: string;
- }>;
+ create(themeRole?: Role, themeName?: string): Promise<Theme>;
}
\ No newline at end of file
packages/cli-kit/dist/public/node/ui/components.d.ts@@ -1,5 +1,4 @@
export { ConcurrentOutput, ConcurrentOutputContext, useConcurrentOutputContext, } from '../../../private/node/ui/components/ConcurrentOutput.js';
export { Alert } from '../../../private/node/ui/components/Alert.js';
export { Link } from '../../../private/node/ui/components/Link.js';
-export { LoadingIndicator } from '../../../private/node/ui/components/LoadingIndicator.js';
export { TabularData } from '../../../private/node/ui/components/TabularData.js';
\ No newline at end of file
packages/cli-kit/dist/private/node/ui/components/ConcurrentOutput.d.ts@@ -1,4 +1,3 @@
-import { ConcurrentOutputContext, getConcurrentOutputContext, useConcurrentOutputContext } from '../../output-context.js';
import { type OutputProcess } from '../../../../public/node/output.js';
import { AbortSignal } from '../../../../public/node/abort.js';
import { FunctionComponent } from 'react';
@@ -14,6 +13,12 @@ export interface ConcurrentOutputProps {
keepRunningAfterProcessesResolve?: boolean;
useAlternativeColorPalette?: boolean;
}
+interface ConcurrentOutputContext {
+ outputPrefix?: string;
+ /** Controls ANSI stripping for terminal output. JSON diagnostics are always unstyled. */
+ stripAnsi?: boolean;
+}
+declare function useConcurrentOutputContext<T>(context: ConcurrentOutputContext, callback: () => T): T;
/** Runs finite processes concurrently and routes their output through the shared diagnostic context. */
export declare function runConcurrentProcessesForJson({ processes, abortSignal, }: Pick<ConcurrentOutputProps, 'processes' | 'abortSignal'>): Promise<void>;
/**
@@ -50,4 +55,4 @@ export declare function runConcurrentProcessesForJson({ processes, abortSignal,
* ```
*/
declare const ConcurrentOutput: FunctionComponent<ConcurrentOutputProps>;
-export { ConcurrentOutput, ConcurrentOutputContext, getConcurrentOutputContext, useConcurrentOutputContext };
\ No newline at end of file
+export { ConcurrentOutput, ConcurrentOutputContext, useConcurrentOutputContext };
\ No newline at end of file
packages/cli-kit/dist/cli/api/graphql/admin/generated/metafield_definitions_by_owner_type.d.ts@@ -2,14 +2,9 @@ import * as Types from './types.js';
import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
export type MetafieldDefinitionsByOwnerTypeQueryVariables = Types.Exact<{
ownerType: Types.MetafieldOwnerType;
- after?: Types.InputMaybe<Types.Scalars['String']['input']>;
}>;
export type MetafieldDefinitionsByOwnerTypeQuery = {
metafieldDefinitions: {
- pageInfo: {
- hasNextPage: boolean;
- endCursor?: string | null;
- };
nodes: {
key: string;
name: string;
packages/cli-kit/dist/private/node/ui/components/Table/Table.d.ts@@ -11,13 +11,5 @@ export interface TableProps<T extends ScalarDict> {
rows: T[];
columns: TableColumn<T>;
}
-/**
- * The width the table needs to show every cell on one line: the widest value or header of each column, plus the
- * gap between columns.
- *
- * @param props - The table's rows and columns.
- * @returns The width in characters.
- */
-export declare function tableWidth<T extends ScalarDict>(props: TableProps<T>): number;
declare function Table<T extends ScalarDict>({ rows, columns: columnsConfiguration }: TableProps<T>): React.JSX.Element;
export { Table };
\ No newline at end of file
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Backport of #9165 to
stable/4.9. Each line publishes with its own copy of the release workflow, so this line needs the same rules asmain.WHAT is this pull request doing?
Brings
.github/workflows/release.ymland.github/workflows/release-qa-package.ymlto their #9165 versions, keeping this line's Node 24.12.0. Pushes to this line then publish only from the merge of its Version Packages pull request, and only when the merged files equal that pull request's tested head. A push publishes only the versions it changed, and Version Packages refuses a version npm already has.How to manually test your changes?
Compare the two files with
main's:git diff origin/main -- .github/workflows/release.yml .github/workflows/release-qa-package.ymlshows only the Node version.🤖 Generated with Claude Code