App Management API authentication #3834
Merged
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
|
Thanks for your contribution! Depending on what you are working on, you may want to request a review from a Shopify team:
|
Coverage report
Show files with reduced coverage 🔻
Test suite run success1633 tests passing in 763 suites. Report generated by 🧪jest coverage report action from a9fc086 |
|
We detected some changes at either packages/*/src or packages/cli-kit/assets/cli-ruby/** and there are no updates in the .changeset. |
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 declarationsWe found no new type declarations in this PR Existing type declarationspackages/cli-kit/dist/private/node/api.d.ts@@ -1,5 +1,5 @@
import { Headers } from 'form-data';
-export type API = 'admin' | 'storefront-renderer' | 'partners' | 'business-platform';
+export type API = 'admin' | 'storefront-renderer' | 'partners' | 'business-platform' | 'app-management';
export declare const allAPIs: API[];
interface RequestOptions<T> {
request: Promise<T>;
packages/cli-kit/dist/private/node/session.d.ts@@ -21,6 +21,14 @@ interface PartnersAPIOAuthOptions {
/** List of scopes to request permissions for. */
scopes: PartnersAPIScope[];
}
+/**
+ * A scope supported by the Developer Platform API.
+ */
+type AppManagementAPIScope = 'https://api.shopify.com/auth/organization.apps.manage' | string;
+interface AppManagementAPIOauthOptions {
+ /** List of scopes to request permissions for. */
+ scopes: AppManagementAPIScope[];
+}
/**
* A scope supported by the Storefront Renderer API.
*/
@@ -44,12 +52,14 @@ export interface OAuthApplications {
storefrontRendererApi?: StorefrontRendererAPIOAuthOptions;
partnersApi?: PartnersAPIOAuthOptions;
businessPlatformApi?: BusinessPlatformAPIOAuthOptions;
+ appManagementApi?: AppManagementAPIOauthOptions;
}
export interface OAuthSession {
admin?: AdminSession;
partners?: string;
storefront?: string;
businessPlatform?: string;
+ appManagement?: string;
}
/**
* This method ensures that we have a valid session to authenticate against the given applications using the provided scopes.
packages/cli-kit/dist/public/node/session.d.ts@@ -20,6 +20,15 @@ interface EnsureAuthenticatedAdditionalOptions {
* @returns The access token for the Partners API.
*/
export declare function ensureAuthenticatedPartners(scopes?: string[], env?: NodeJS.ProcessEnv, options?: EnsureAuthenticatedAdditionalOptions): Promise<string>;
+/**
+ * Ensure that we have a valid session to access the App Management API.
+ *
+ * @param scopes - Optional array of extra scopes to authenticate with.
+ * @param env - Optional environment variables to use.
+ * @param options - Optional extra options to use.
+ * @returns The access token for the App Management API.
+ */
+export declare function ensureAuthenticatedAppManagement(scopes?: string[], env?: NodeJS.ProcessEnv, options?: EnsureAuthenticatedAdditionalOptions): Promise<string>;
/**
* Ensure that we have a valid session to access the Storefront API.
*
packages/cli-kit/dist/private/node/session/exchange.d.ts@@ -11,6 +11,7 @@ export interface ExchangeScopes {
partners: string[];
storefront: string[];
businessPlatform: string[];
+ appManagement: string[];
}
/**
* Given a valid authorization code, request an identity access token.
|
amcaplan
approved these changes
May 16, 2024
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?
Related to https://github.com/Shopify/develop-app-management/issues/1752
WHAT is this pull request doing?
Authenticate against App Management API when
USE_SHOPIFY_DEVELOPERS_CLIENTis enabledHow to test your changes?
With and without
USE_SHOPIFY_DEVELOPERS_CLIENT=1:bin/spin p shopify auth logoutbin/spin p shopify app config link --verboseMeasuring impact
How do we know this change was effective? Please choose one:
Checklist
devordeployhave been reflected in the internal flowchart.