UNPKG

@shopify/cli-kit

Version:

A set of utilities, interfaces, and models that are common across all the platform features

github.com/Shopify/cli

Shopify/cli

62 lines (61 loc) • 2.3 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
import { AbortError } from '../error.js'; export declare const NotProvidedStoreFQDNError: AbortError; /** * It returns the Partners' API service we should interact with. * * @returns Fully-qualified domain of the partners service we should interact with. */ export declare function partnersFqdn(): Promise<string>; /** * It returns the Admin service we should interact with. * * @returns Fully-qualified domain of the Admin service we should interact with. */ export declare function adminFqdn(): Promise<string>; /** * It returns the App Management API service we should interact with. * * @returns Fully-qualified domain of the App Management service we should interact with. */ export declare function appManagementFqdn(): Promise<string>; /** * It returns the App Dev API service we should interact with. * * @param storeFqdn - The store FQDN. * @returns Fully-qualified domain of the App Dev service we should interact with. */ export declare function appDevFqdn(storeFqdn: string): Promise<string>; /** * It returns the Developer Dashboard domain we should interact with. * * @returns Fully-qualified domain of the Developer Dashboard we should interact with. */ export declare function developerDashboardFqdn(): Promise<string>; /** * It returns the BusinessPlatform' API service we should interact with. * * @returns Fully-qualified domain of the partners service we should interact with. */ export declare function businessPlatformFqdn(): Promise<string>; /** * It returns the Identity service we should interact with. * * @returns Fully-qualified domain of the Identity service we should interact with. */ export declare function identityFqdn(): Promise<string>; /** * Normalize the store name to be used in the CLI. * It will add the .myshopify.com domain if it's not present. * * @param store - Store name. * @returns Normalized store name. */ export declare function normalizeStoreFqdn(store: string): string; /** * Convert a store FQDN to the admin URL pattern for local development. * In local mode, transforms \{store\}.my.shop.dev to admin.shop.dev/store/\{store\}. * * @param storeFqdn - Normalized store FQDN. * @returns Store admin URL base (without protocol or path). */ export declare function storeAdminUrl(storeFqdn: string): string;