Migrate themeCreate to GraphQL #5249
Open
+236
−217
Conversation
This file contains 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
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success2045 tests passing in 913 suites. Report generated by 🧪jest coverage report action from 4a3895c |
lucyxiang
force-pushed
the
migrate-theme-create-to-gql
branch
3 times, most recently
from
f0c0b74 to
2a64370
Compare
This comment has been minimized.
This comment has been minimized.
lucyxiang
force-pushed
the
migrate-theme-create-to-gql
branch
from
2a64370 to
dcb5814
Compare
lucyxiang
commented
Feb 6, 2025
| @@ -406,135 +419,10 @@ export async function passwordProtected(session: AdminSession): Promise<boolean> | |||
| return passwordProtection.enabled | |||
| } | |||
|
|
|||
| async function request<T>( | |||
lucyxiang
force-pushed
the
migrate-theme-create-to-gql
branch
from
dcb5814 to
1fa637d
Compare
lucyxiang
commented
Feb 6, 2025
| source: themeSource, | ||
| role: (params.role ?? DEVELOPMENT_THEME_ROLE).toUpperCase() as ThemeRole, | ||
| }, | ||
| '2025-04', |
There was a problem hiding this comment.
To remove post RC 2025-04. role argument was recently added and is only in 2025-04
There was a problem hiding this comment.
How will we remember to do this?
There was a problem hiding this comment.
Currently I just have it as a cal reminder for april 1st 😅 Unless there's a remind me / todo func in the CLI repo?
There was a problem hiding this comment.
You may be able to schedule an issue via a workflow but that feels like overkill 🤷🏼
lucyxiang
force-pushed
the
migrate-theme-create-to-gql
branch
from
1fa637d to
3a3dc8e
Compare
catlee
approved these changes
Feb 10, 2025
| import {GetThemeFileChecksums} from '../../../cli/api/graphql/admin/generated/get_theme_file_checksums.js' | ||
| import {ThemeFilesUpsert} from '../../../cli/api/graphql/admin/generated/theme_files_upsert.js' | ||
| import {ThemeFilesDelete} from '../../../cli/api/graphql/admin/generated/theme_files_delete.js' | ||
| import {OnlineStoreThemeFileBodyInputType} from '../../../cli/api/graphql/admin/generated/types.js' | ||
| import {GetThemes} from '../../../cli/api/graphql/admin/generated/get_themes.js' | ||
| import {GetTheme} from '../../../cli/api/graphql/admin/generated/get_theme.js' | ||
| import {test, vi, expect, describe} from 'vitest' | ||
| import {adminRequestDoc, restRequest, supportedApiVersions} from '@shopify/cli-kit/node/api/admin' |
| source: themeSource, | ||
| role: (params.role ?? DEVELOPMENT_THEME_ROLE).toUpperCase() as ThemeRole, | ||
| }, | ||
| '2025-04', |
There was a problem hiding this comment.
How will we remember to do this?
jamesmengo
approved these changes
Feb 11, 2025
EvilGenius13
approved these changes
Feb 11, 2025
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/cli/api/graphql/admin/generated/theme_create.d.tsimport * as Types from './types.js';
import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
export type ThemeCreateMutationVariables = Types.Exact<{
name: Types.Scalars['String']['input'];
source: Types.Scalars['URL']['input'];
role: Types.ThemeRole;
}>;
export type ThemeCreateMutation = {
themeCreate?: {
theme?: {
id: string;
name: string;
role: Types.ThemeRole;
} | null;
userErrors: {
field?: string[] | null;
message: string;
}[];
} | null;
};
export declare const ThemeCreate: DocumentNode<ThemeCreateMutation, ThemeCreateMutationVariables>;
Existing type declarationspackages/cli-kit/dist/public/node/themes/api.d.ts@@ -5,7 +5,7 @@ export type ThemeParams = Partial<Pick<Theme, 'name' | 'role' | 'processing' | '
export type AssetParams = Pick<ThemeAsset, 'key'> & Partial<Pick<ThemeAsset, 'value' | 'attachment'>>;
export declare function fetchTheme(id: number, session: AdminSession): Promise<Theme | undefined>;
export declare function fetchThemes(session: AdminSession): Promise<Theme[]>;
-export declare function createTheme(params: ThemeParams, session: AdminSession): Promise<Theme | undefined>;
+export declare function themeCreate(params: ThemeParams, session: AdminSession): Promise<Theme | undefined>;
export declare function fetchThemeAssets(id: number, filenames: Key[], session: AdminSession): Promise<ThemeAsset[]>;
export declare function deleteThemeAssets(id: number, filenames: Key[], session: AdminSession): Promise<Result[]>;
export declare function bulkUploadThemeAssets(id: number, assets: AssetParams[], session: AdminSession): Promise<Result[]>;
|
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?
Migrate theme create to use GraphQL
themeCreatemutation. Use skeleton theme (minimal theme that contains onlytheme.liquid,password.liquid, andsettings_schema.json) created my @jamesmengoHow to test your changes?
shopify theme devorshopify theme pushHow do we know this change was effective? Please choose one:
Checklist