@shopify/shopify-app-remix 3.4.0 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/server/authenticate/admin/authenticate.js +21 -13
- package/dist/cjs/server/authenticate/admin/authenticate.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/billing/helpers.js +1 -1
- package/dist/cjs/server/authenticate/admin/billing/helpers.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/helpers/create-admin-api-context.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/helpers/handle-client-error.js +2 -1
- package/dist/cjs/server/authenticate/admin/helpers/handle-client-error.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/helpers/redirect.js +1 -1
- package/dist/cjs/server/authenticate/admin/helpers/redirect.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/helpers/trigger-after-auth-hook.js +3 -2
- package/dist/cjs/server/authenticate/admin/helpers/trigger-after-auth-hook.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/helpers/validate-shop-and-host-params.js +1 -0
- package/dist/cjs/server/authenticate/admin/helpers/validate-shop-and-host-params.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/scope/client/fetch-scopes-details.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/scope/client/revoke-scopes.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/scope/factory.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/scope/query.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/scope/request.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/scope/revoke.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/strategies/auth-code-flow.js +5 -3
- package/dist/cjs/server/authenticate/admin/strategies/auth-code-flow.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/strategies/merchant-custom-app.js +8 -3
- package/dist/cjs/server/authenticate/admin/strategies/merchant-custom-app.js.map +1 -1
- package/dist/cjs/server/authenticate/admin/strategies/token-exchange.js +7 -4
- package/dist/cjs/server/authenticate/admin/strategies/token-exchange.js.map +1 -1
- package/dist/cjs/server/authenticate/flow/authenticate.js.map +1 -1
- package/dist/cjs/server/authenticate/fulfillment-service/authenticate.js.map +1 -1
- package/dist/cjs/server/authenticate/helpers/create-or-load-offline-session.js +4 -2
- package/dist/cjs/server/authenticate/helpers/create-or-load-offline-session.js.map +1 -1
- package/dist/cjs/server/authenticate/helpers/get-shop-from-request.js +9 -0
- package/dist/cjs/server/authenticate/helpers/get-shop-from-request.js.map +1 -0
- package/dist/cjs/server/authenticate/helpers/invalidate-access-token.js +3 -1
- package/dist/cjs/server/authenticate/helpers/invalidate-access-token.js.map +1 -1
- package/dist/cjs/server/authenticate/helpers/respond-to-invalid-session-token.js.map +1 -1
- package/dist/cjs/server/authenticate/helpers/validate-session-token.js +9 -3
- package/dist/cjs/server/authenticate/helpers/validate-session-token.js.map +1 -1
- package/dist/cjs/server/authenticate/public/appProxy/authenticate.js +5 -4
- package/dist/cjs/server/authenticate/public/appProxy/authenticate.js.map +1 -1
- package/dist/cjs/server/authenticate/public/customer-account/authenticate.js.map +1 -1
- package/dist/cjs/server/authenticate/public/extension/authenticate.js +7 -2
- package/dist/cjs/server/authenticate/public/extension/authenticate.js.map +1 -1
- package/dist/cjs/server/authenticate/public/factory.js.map +1 -1
- package/dist/cjs/server/authenticate/webhooks/authenticate.js.map +1 -1
- package/dist/cjs/server/clients/admin/factory.js +5 -0
- package/dist/cjs/server/clients/admin/factory.js.map +1 -1
- package/dist/cjs/server/clients/admin/rest.js +8 -0
- package/dist/cjs/server/clients/admin/rest.js.map +1 -1
- package/dist/cjs/server/future/flags.js +0 -3
- package/dist/cjs/server/future/flags.js.map +1 -1
- package/dist/cjs/server/shopify-app.js.map +1 -1
- package/dist/cjs/server/unauthenticated/admin/factory.js.map +1 -1
- package/dist/cjs/server/version.js +1 -1
- package/dist/esm/server/authenticate/admin/authenticate.mjs +21 -13
- package/dist/esm/server/authenticate/admin/authenticate.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/billing/helpers.mjs +1 -1
- package/dist/esm/server/authenticate/admin/billing/helpers.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/helpers/create-admin-api-context.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/helpers/handle-client-error.mjs +2 -1
- package/dist/esm/server/authenticate/admin/helpers/handle-client-error.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/helpers/redirect.mjs +1 -1
- package/dist/esm/server/authenticate/admin/helpers/redirect.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/helpers/trigger-after-auth-hook.mjs +3 -2
- package/dist/esm/server/authenticate/admin/helpers/trigger-after-auth-hook.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/helpers/validate-shop-and-host-params.mjs +1 -0
- package/dist/esm/server/authenticate/admin/helpers/validate-shop-and-host-params.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/scope/client/fetch-scopes-details.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/scope/client/revoke-scopes.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/scope/factory.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/scope/query.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/scope/request.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/scope/revoke.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/strategies/auth-code-flow.mjs +5 -3
- package/dist/esm/server/authenticate/admin/strategies/auth-code-flow.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/strategies/merchant-custom-app.mjs +8 -3
- package/dist/esm/server/authenticate/admin/strategies/merchant-custom-app.mjs.map +1 -1
- package/dist/esm/server/authenticate/admin/strategies/token-exchange.mjs +7 -4
- package/dist/esm/server/authenticate/admin/strategies/token-exchange.mjs.map +1 -1
- package/dist/esm/server/authenticate/flow/authenticate.mjs.map +1 -1
- package/dist/esm/server/authenticate/fulfillment-service/authenticate.mjs.map +1 -1
- package/dist/esm/server/authenticate/helpers/create-or-load-offline-session.mjs +4 -2
- package/dist/esm/server/authenticate/helpers/create-or-load-offline-session.mjs.map +1 -1
- package/dist/esm/server/authenticate/helpers/get-shop-from-request.mjs +7 -0
- package/dist/esm/server/authenticate/helpers/get-shop-from-request.mjs.map +1 -0
- package/dist/esm/server/authenticate/helpers/invalidate-access-token.mjs +3 -1
- package/dist/esm/server/authenticate/helpers/invalidate-access-token.mjs.map +1 -1
- package/dist/esm/server/authenticate/helpers/respond-to-invalid-session-token.mjs.map +1 -1
- package/dist/esm/server/authenticate/helpers/validate-session-token.mjs +9 -3
- package/dist/esm/server/authenticate/helpers/validate-session-token.mjs.map +1 -1
- package/dist/esm/server/authenticate/public/appProxy/authenticate.mjs +5 -4
- package/dist/esm/server/authenticate/public/appProxy/authenticate.mjs.map +1 -1
- package/dist/esm/server/authenticate/public/customer-account/authenticate.mjs.map +1 -1
- package/dist/esm/server/authenticate/public/extension/authenticate.mjs +7 -2
- package/dist/esm/server/authenticate/public/extension/authenticate.mjs.map +1 -1
- package/dist/esm/server/authenticate/public/factory.mjs.map +1 -1
- package/dist/esm/server/authenticate/webhooks/authenticate.mjs.map +1 -1
- package/dist/esm/server/clients/admin/factory.mjs +5 -0
- package/dist/esm/server/clients/admin/factory.mjs.map +1 -1
- package/dist/esm/server/clients/admin/rest.mjs +8 -0
- package/dist/esm/server/clients/admin/rest.mjs.map +1 -1
- package/dist/esm/server/future/flags.mjs +0 -3
- package/dist/esm/server/future/flags.mjs.map +1 -1
- package/dist/esm/server/shopify-app.mjs.map +1 -1
- package/dist/esm/server/unauthenticated/admin/factory.mjs.map +1 -1
- package/dist/esm/server/version.mjs +1 -1
- package/dist/ts/server/authenticate/admin/authenticate.admin.doc.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/authenticate.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/helpers/create-admin-api-context.d.ts +2 -1
- package/dist/ts/server/authenticate/admin/helpers/create-admin-api-context.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/helpers/handle-client-error.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/helpers/trigger-after-auth-hook.d.ts +2 -1
- package/dist/ts/server/authenticate/admin/helpers/trigger-after-auth-hook.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/helpers/validate-shop-and-host-params.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/scope/authenticate.admin.scopes.doc.d.ts +4 -0
- package/dist/ts/server/authenticate/admin/scope/authenticate.admin.scopes.doc.d.ts.map +1 -0
- package/dist/ts/server/authenticate/admin/scope/client/fetch-scopes-details.d.ts +2 -1
- package/dist/ts/server/authenticate/admin/scope/client/fetch-scopes-details.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/scope/client/revoke-scopes.d.ts +2 -1
- package/dist/ts/server/authenticate/admin/scope/client/revoke-scopes.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/scope/factory.d.ts +2 -1
- package/dist/ts/server/authenticate/admin/scope/factory.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/scope/query.d.ts +2 -1
- package/dist/ts/server/authenticate/admin/scope/query.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/scope/request.d.ts +2 -1
- package/dist/ts/server/authenticate/admin/scope/request.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/scope/revoke.d.ts +2 -1
- package/dist/ts/server/authenticate/admin/scope/revoke.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/scope/types.d.ts +148 -8
- package/dist/ts/server/authenticate/admin/scope/types.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/strategies/auth-code-flow.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/strategies/merchant-custom-app.d.ts +5 -5
- package/dist/ts/server/authenticate/admin/strategies/merchant-custom-app.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/strategies/token-exchange.d.ts.map +1 -1
- package/dist/ts/server/authenticate/admin/types.d.ts +3 -4
- package/dist/ts/server/authenticate/admin/types.d.ts.map +1 -1
- package/dist/ts/server/authenticate/flow/authenticate.d.ts +2 -1
- package/dist/ts/server/authenticate/flow/authenticate.d.ts.map +1 -1
- package/dist/ts/server/authenticate/flow/types.d.ts +6 -6
- package/dist/ts/server/authenticate/flow/types.d.ts.map +1 -1
- package/dist/ts/server/authenticate/fulfillment-service/authenticate.d.ts +2 -1
- package/dist/ts/server/authenticate/fulfillment-service/authenticate.d.ts.map +1 -1
- package/dist/ts/server/authenticate/fulfillment-service/types.d.ts +11 -44
- package/dist/ts/server/authenticate/fulfillment-service/types.d.ts.map +1 -1
- package/dist/ts/server/authenticate/helpers/create-or-load-offline-session.d.ts.map +1 -1
- package/dist/ts/server/authenticate/helpers/get-shop-from-request.d.ts +2 -0
- package/dist/ts/server/authenticate/helpers/get-shop-from-request.d.ts.map +1 -0
- package/dist/ts/server/authenticate/helpers/index.d.ts +1 -0
- package/dist/ts/server/authenticate/helpers/index.d.ts.map +1 -1
- package/dist/ts/server/authenticate/helpers/invalidate-access-token.d.ts.map +1 -1
- package/dist/ts/server/authenticate/helpers/respond-to-invalid-session-token.d.ts +1 -1
- package/dist/ts/server/authenticate/helpers/respond-to-invalid-session-token.d.ts.map +1 -1
- package/dist/ts/server/authenticate/helpers/validate-session-token.d.ts.map +1 -1
- package/dist/ts/server/authenticate/public/appProxy/authenticate.d.ts +2 -1
- package/dist/ts/server/authenticate/public/appProxy/authenticate.d.ts.map +1 -1
- package/dist/ts/server/authenticate/public/appProxy/types.d.ts +5 -4
- package/dist/ts/server/authenticate/public/appProxy/types.d.ts.map +1 -1
- package/dist/ts/server/authenticate/public/customer-account/authenticate.d.ts +1 -1
- package/dist/ts/server/authenticate/public/customer-account/authenticate.d.ts.map +1 -1
- package/dist/ts/server/authenticate/public/extension/authenticate.d.ts +1 -1
- package/dist/ts/server/authenticate/public/extension/authenticate.d.ts.map +1 -1
- package/dist/ts/server/authenticate/public/factory.d.ts +2 -1
- package/dist/ts/server/authenticate/public/factory.d.ts.map +1 -1
- package/dist/ts/server/authenticate/public/types.d.ts +4 -3
- package/dist/ts/server/authenticate/public/types.d.ts.map +1 -1
- package/dist/ts/server/authenticate/webhooks/authenticate.d.ts +2 -1
- package/dist/ts/server/authenticate/webhooks/authenticate.d.ts.map +1 -1
- package/dist/ts/server/authenticate/webhooks/types.d.ts +5 -4
- package/dist/ts/server/authenticate/webhooks/types.d.ts.map +1 -1
- package/dist/ts/server/clients/admin/factory.d.ts +2 -1
- package/dist/ts/server/clients/admin/factory.d.ts.map +1 -1
- package/dist/ts/server/clients/admin/rest.d.ts +8 -0
- package/dist/ts/server/clients/admin/rest.d.ts.map +1 -1
- package/dist/ts/server/clients/admin/types.d.ts +109 -102
- package/dist/ts/server/clients/admin/types.d.ts.map +1 -1
- package/dist/ts/server/config-types.d.ts +5 -5
- package/dist/ts/server/config-types.d.ts.map +1 -1
- package/dist/ts/server/future/flags.d.ts +15 -2
- package/dist/ts/server/future/flags.d.ts.map +1 -1
- package/dist/ts/server/shopify-app.d.ts.map +1 -1
- package/dist/ts/server/types-contexts.d.ts +8 -8
- package/dist/ts/server/types-contexts.d.ts.map +1 -1
- package/dist/ts/server/types.d.ts +21 -39
- package/dist/ts/server/types.d.ts.map +1 -1
- package/dist/ts/server/unauthenticated/admin/factory.d.ts +2 -1
- package/dist/ts/server/unauthenticated/admin/factory.d.ts.map +1 -1
- package/dist/ts/server/unauthenticated/admin/types.d.ts +4 -40
- package/dist/ts/server/unauthenticated/admin/types.d.ts.map +1 -1
- package/dist/ts/server/unauthenticated/types.d.ts +5 -5
- package/dist/ts/server/unauthenticated/types.d.ts.map +1 -1
- package/dist/ts/server/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +5 -5
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { RegisterReturn, Shopify, ShopifyRestResources } from '@shopify/shopify-api';
|
|
2
2
|
import { SessionStorage } from '@shopify/shopify-app-session-storage';
|
|
3
|
-
import type { AppConfig, AppConfigArg } from './config-types';
|
|
4
|
-
import type { AuthenticateWebhook, RegisterWebhooksOptions } from './authenticate/webhooks/types';
|
|
5
|
-
import type { AuthenticatePublic } from './authenticate/public/types';
|
|
6
3
|
import type { AuthenticateAdmin } from './authenticate/admin/types';
|
|
7
|
-
import type { Unauthenticated } from './unauthenticated/types';
|
|
8
4
|
import type { AuthenticateFlow } from './authenticate/flow/types';
|
|
9
|
-
import type { ApiConfigWithFutureFlags, ApiFutureFlags, FutureFlagOptions } from './future/flags';
|
|
10
5
|
import { AuthenticateFulfillmentService } from './authenticate/fulfillment-service/types';
|
|
6
|
+
import type { AuthenticatePublic } from './authenticate/public/types';
|
|
7
|
+
import type { AuthenticateWebhook, RegisterWebhooksOptions } from './authenticate/webhooks/types';
|
|
8
|
+
import type { AppConfig, AppConfigArg } from './config-types';
|
|
9
|
+
import type { ApiConfigWithFutureFlags, ApiFutureFlags, FutureFlagOptions } from './future/flags';
|
|
10
|
+
import type { Unauthenticated } from './unauthenticated/types';
|
|
11
11
|
export interface BasicParams<Future extends FutureFlagOptions = FutureFlagOptions> {
|
|
12
12
|
api: Shopify<ApiConfigWithFutureFlags<Future>, ShopifyRestResources, ApiFutureFlags<Future>>;
|
|
13
13
|
config: AppConfig;
|
|
@@ -47,17 +47,16 @@ interface Authenticate<Config extends AppConfigArg> {
|
|
|
47
47
|
*
|
|
48
48
|
* export async function loader({ request }: LoaderFunctionArgs) {
|
|
49
49
|
* const {admin, session, sessionToken, billing} = authenticate.admin(request);
|
|
50
|
+
* const response = await admin.graphql(`{ shop { name } }`)
|
|
50
51
|
*
|
|
51
|
-
* return json(await
|
|
52
|
+
* return json(await response.json());
|
|
52
53
|
* }
|
|
53
54
|
* ```
|
|
54
55
|
* ```ts
|
|
55
56
|
* // /app/shopify.server.ts
|
|
56
57
|
* import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix/server";
|
|
57
|
-
* import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
|
|
58
58
|
*
|
|
59
59
|
* const shopify = shopifyApp({
|
|
60
|
-
* restResources,
|
|
61
60
|
* // ...etc
|
|
62
61
|
* });
|
|
63
62
|
* export default shopify;
|
|
@@ -92,17 +91,15 @@ interface Authenticate<Config extends AppConfigArg> {
|
|
|
92
91
|
* ```ts
|
|
93
92
|
* // /app/shopify.server.ts
|
|
94
93
|
* import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix/server";
|
|
95
|
-
* import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
|
|
96
94
|
*
|
|
97
95
|
* const shopify = shopifyApp({
|
|
98
|
-
* restResources,
|
|
99
96
|
* // ...etc
|
|
100
97
|
* });
|
|
101
98
|
* export default shopify;
|
|
102
99
|
* export const authenticate = shopify.authenticate;
|
|
103
100
|
* ```
|
|
104
101
|
*/
|
|
105
|
-
flow: AuthenticateFlow<RestResourcesType<Config>>;
|
|
102
|
+
flow: AuthenticateFlow<Config, RestResourcesType<Config>>;
|
|
106
103
|
/**
|
|
107
104
|
* Authenticate a request from a fulfillment service and get back an authenticated context.
|
|
108
105
|
*
|
|
@@ -115,28 +112,15 @@ interface Authenticate<Config extends AppConfigArg> {
|
|
|
115
112
|
* import { authenticate } from "../shopify.server";
|
|
116
113
|
*
|
|
117
114
|
* export async function action({ request }: ActionFunctionArgs) {
|
|
118
|
-
* const { admin } = await authenticate.fulfillmentService(request);
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* fulfillmentOrderAcceptFulfillmentRequest(
|
|
124
|
-
* id: "gid://shopify/FulfillmentOrder/5014440902678",
|
|
125
|
-
* message: "Reminder that tomorrow is a holiday. We won't be able to ship this until Monday."){
|
|
126
|
-
* fulfillmentOrder {
|
|
127
|
-
* status
|
|
128
|
-
* requestStatus
|
|
129
|
-
* }
|
|
130
|
-
* }
|
|
131
|
-
* }
|
|
132
|
-
* );
|
|
133
|
-
*
|
|
134
|
-
* const productData = await response.json();
|
|
135
|
-
* return json({ data: productData.data });
|
|
115
|
+
* const { admin, session } = await authenticate.fulfillmentService(request);
|
|
116
|
+
*
|
|
117
|
+
* console.log(session.id)
|
|
118
|
+
*
|
|
119
|
+
* return new Response();
|
|
136
120
|
* }
|
|
137
121
|
* ```
|
|
138
122
|
* */
|
|
139
|
-
fulfillmentService: AuthenticateFulfillmentService<RestResourcesType<Config>>;
|
|
123
|
+
fulfillmentService: AuthenticateFulfillmentService<Config, RestResourcesType<Config>>;
|
|
140
124
|
/**
|
|
141
125
|
* Authenticate a public request and get back a session token.
|
|
142
126
|
*
|
|
@@ -156,7 +140,7 @@ interface Authenticate<Config extends AppConfigArg> {
|
|
|
156
140
|
* }
|
|
157
141
|
* ```
|
|
158
142
|
*/
|
|
159
|
-
public: AuthenticatePublic
|
|
143
|
+
public: AuthenticatePublic<Config>;
|
|
160
144
|
/**
|
|
161
145
|
* Authenticate a Shopify webhook request, get back an authenticated admin context and details on the webhook request
|
|
162
146
|
*
|
|
@@ -225,7 +209,7 @@ interface Authenticate<Config extends AppConfigArg> {
|
|
|
225
209
|
* });
|
|
226
210
|
* ```
|
|
227
211
|
*/
|
|
228
|
-
webhook: AuthenticateWebhook<RestResourcesType<Config>, string>;
|
|
212
|
+
webhook: AuthenticateWebhook<Config, RestResourcesType<Config>, string>;
|
|
229
213
|
}
|
|
230
214
|
export interface ShopifyAppBase<Config extends AppConfigArg> {
|
|
231
215
|
/**
|
|
@@ -339,10 +323,8 @@ export interface ShopifyAppBase<Config extends AppConfigArg> {
|
|
|
339
323
|
* ```ts
|
|
340
324
|
* // /app/shopify.server.ts
|
|
341
325
|
* import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix/server";
|
|
342
|
-
* import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
|
|
343
326
|
*
|
|
344
327
|
* const shopify = shopifyApp({
|
|
345
|
-
* restResources,
|
|
346
328
|
* // ...etc
|
|
347
329
|
* });
|
|
348
330
|
* export default shopify;
|
|
@@ -354,8 +336,9 @@ export interface ShopifyAppBase<Config extends AppConfigArg> {
|
|
|
354
336
|
*
|
|
355
337
|
* export async function loader({ request }: LoaderFunctionArgs) {
|
|
356
338
|
* const {admin, session, sessionToken, billing} = shopify.authenticate.admin(request);
|
|
339
|
+
* const response = admin.graphql(`{ shop { name } }`)
|
|
357
340
|
*
|
|
358
|
-
* return json(await
|
|
341
|
+
* return json(await response.json());
|
|
359
342
|
* }
|
|
360
343
|
* ```
|
|
361
344
|
*/
|
|
@@ -369,10 +352,8 @@ export interface ShopifyAppBase<Config extends AppConfigArg> {
|
|
|
369
352
|
* ```ts
|
|
370
353
|
* // /app/shopify.server.ts
|
|
371
354
|
* import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix/server";
|
|
372
|
-
* import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
|
|
373
355
|
*
|
|
374
356
|
* const shopify = shopifyApp({
|
|
375
|
-
* restResources,
|
|
376
357
|
* // ...etc
|
|
377
358
|
* });
|
|
378
359
|
* export default shopify;
|
|
@@ -386,12 +367,13 @@ export interface ShopifyAppBase<Config extends AppConfigArg> {
|
|
|
386
367
|
* export async function loader({ request }: LoaderFunctionArgs) {
|
|
387
368
|
* const shop = await authenticateExternal(request)
|
|
388
369
|
* const {admin} = await shopify.unauthenticated.admin(shop);
|
|
370
|
+
* const response = admin.graphql(`{ shop { currencyCode } }`)
|
|
389
371
|
*
|
|
390
|
-
* return json(await
|
|
372
|
+
* return json(await response.json());
|
|
391
373
|
* }
|
|
392
374
|
* ```
|
|
393
375
|
*/
|
|
394
|
-
unauthenticated: Unauthenticated<RestResourcesType<Config>>;
|
|
376
|
+
unauthenticated: Unauthenticated<Config, RestResourcesType<Config>>;
|
|
395
377
|
}
|
|
396
378
|
export interface ShopifyAppLogin {
|
|
397
379
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/server/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,OAAO,EACP,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAEpE,OAAO,KAAK,EAAC,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/server/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,OAAO,EACP,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAEpE,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAC,8BAA8B,EAAC,MAAM,0CAA0C,CAAC;AACxF,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,6BAA6B,CAAC;AACpE,OAAO,KAAK,EACV,mBAAmB,EACnB,uBAAuB,EACxB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAC,SAAS,EAAE,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5D,OAAO,KAAK,EACV,wBAAwB,EACxB,cAAc,EACd,iBAAiB,EAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAE7D,MAAM,WAAW,WAAW,CAC1B,MAAM,SAAS,iBAAiB,GAAG,iBAAiB;IAEpD,GAAG,EAAE,OAAO,CACV,wBAAwB,CAAC,MAAM,CAAC,EAChC,oBAAoB,EACpB,cAAc,CAAC,MAAM,CAAC,CACvB,CAAC;IACF,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC3B;AAID,oBAAY,eAAe;IACzB,QAAQ,cAAc;IACtB,cAAc,oBAAoB;IAClC,YAAY,kBAAkB;CAC/B;AAED,KAAK,gBAAgB,GAAG,CACtB,OAAO,EAAE,uBAAuB,KAC7B,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;AAEpC,oBAAY,cAAc;IACxB,WAAW,iBAAiB;IAC5B,WAAW,iBAAiB;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB;AAED,KAAK,KAAK,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,CAAC;AAE/D,KAAK,0BAA0B,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAE/E,KAAK,iBAAiB,CAAC,MAAM,SAAS,YAAY,IAChD,MAAM,CAAC,eAAe,CAAC,SAAS,oBAAoB,GAChD,MAAM,CAAC,eAAe,CAAC,GACvB,oBAAoB,CAAC;AAE3B,KAAK,kBAAkB,CAAC,MAAM,SAAS,YAAY,IACjD,MAAM,CAAC,gBAAgB,CAAC,SAAS,cAAc,GAC3C,MAAM,CAAC,gBAAgB,CAAC,GACxB,cAAc,CAAC;AAErB,UAAU,YAAY,CAAC,MAAM,SAAS,YAAY;IAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,EAAE,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,EAAE,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;SAmBK;IACL,kBAAkB,EAAE,8BAA8B,CAChD,MAAM,EACN,iBAAiB,CAAC,MAAM,CAAC,CAC1B,CAAC;IAEF;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmEG;IACH,OAAO,EAAE,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;CACzE;AAED,MAAM,WAAW,cAAc,CAAC,MAAM,SAAS,YAAY;IACzD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,0BAA0B,EAAE,0BAA0B,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,YAAY,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,eAAe,EAAE,eAAe,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmEG;IACH,KAAK,EAAE,KAAK,CAAC;CACd;AAED,MAAM,MAAM,QAAQ,CAAC,MAAM,SAAS,YAAY,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;AAC3E,MAAM,MAAM,iBAAiB,CAAC,MAAM,SAAS,YAAY,IACvD,cAAc,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC;AAC3C,MAAM,MAAM,WAAW,CAAC,MAAM,SAAS,YAAY,IAAI,cAAc,CAAC,MAAM,CAAC,GAC3E,eAAe,CAAC;AAElB,KAAK,qBAAqB,CAAC,MAAM,SAAS,YAAY,EAAE,IAAI,IAAI,IAAI,GAAG;IACrE,cAAc,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,MAAM,SAAS,YAAY,IAChD,MAAM,CAAC,cAAc,CAAC,SAAS,eAAe,CAAC,YAAY,GACvD,QAAQ,CAAC,MAAM,CAAC,GAChB,MAAM,CAAC,cAAc,CAAC,SAAS,eAAe,CAAC,cAAc,GAC3D,qBAAqB,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,GACxD,MAAM,CAAC,cAAc,CAAC,SAAS,eAAe,CAAC,QAAQ,GACrD,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,GAClD,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { ShopifyRestResources } from '@shopify/shopify-api';
|
|
2
|
+
import { AppConfigArg } from '../../config-types';
|
|
2
3
|
import { BasicParams } from '../../types';
|
|
3
4
|
import { UnauthenticatedAdminContext } from './types';
|
|
4
|
-
export declare function unauthenticatedAdminContextFactory<Resources extends ShopifyRestResources>(params: BasicParams): (shop: string) => Promise<UnauthenticatedAdminContext<Resources>>;
|
|
5
|
+
export declare function unauthenticatedAdminContextFactory<ConfigArg extends AppConfigArg, Resources extends ShopifyRestResources>(params: BasicParams): (shop: string) => Promise<UnauthenticatedAdminContext<ConfigArg, Resources>>;
|
|
5
6
|
//# sourceMappingURL=factory.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/admin/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/admin/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAGhD,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAGxC,OAAO,EAAC,2BAA2B,EAAC,MAAM,SAAS,CAAC;AAEpD,wBAAgB,kCAAkC,CAChD,SAAS,SAAS,YAAY,EAC9B,SAAS,SAAS,oBAAoB,EACtC,MAAM,EAAE,WAAW,UAEX,MAAM,KACX,OAAO,CAAC,2BAA2B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAc9D"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Session, ShopifyRestResources } from '@shopify/shopify-api';
|
|
2
|
+
import { AppConfigArg } from '../../config-types';
|
|
2
3
|
import { AdminApiContext } from '../../clients';
|
|
3
|
-
export interface UnauthenticatedAdminContext<Resources extends ShopifyRestResources> {
|
|
4
|
+
export interface UnauthenticatedAdminContext<ConfigArg extends AppConfigArg, Resources extends ShopifyRestResources> {
|
|
4
5
|
/**
|
|
5
6
|
* The session for the given shop.
|
|
6
7
|
*
|
|
@@ -29,42 +30,6 @@ export interface UnauthenticatedAdminContext<Resources extends ShopifyRestResour
|
|
|
29
30
|
* Methods for interacting with the GraphQL / REST Admin APIs for the given store.
|
|
30
31
|
*
|
|
31
32
|
* @example
|
|
32
|
-
* <caption>Performing a GET request to the REST API.</caption>
|
|
33
|
-
* <description>Use `admin.rest.get` to make custom requests to make a request to to the `customer/count` endpoint</description>
|
|
34
|
-
*
|
|
35
|
-
* ```ts
|
|
36
|
-
* // /app/routes/**\/*.ts
|
|
37
|
-
* import { LoaderFunctionArgs, json } from "@remix-run/node";
|
|
38
|
-
* import { unauthenticated } from "../shopify.server";
|
|
39
|
-
*
|
|
40
|
-
* export const loader = async ({ request }: LoaderFunctionArgs) => {
|
|
41
|
-
* const { admin, session } = await unauthenticated.admin(request);
|
|
42
|
-
*
|
|
43
|
-
* const response = await admin.rest.get(
|
|
44
|
-
* {
|
|
45
|
-
* path: "/customers/count.json"
|
|
46
|
-
* }
|
|
47
|
-
* );
|
|
48
|
-
* const customers = await response.json();
|
|
49
|
-
*
|
|
50
|
-
* return json({ customers });
|
|
51
|
-
* };
|
|
52
|
-
* ```
|
|
53
|
-
*
|
|
54
|
-
* ```ts
|
|
55
|
-
* // /app/shopify.server.ts
|
|
56
|
-
* import { shopifyApp } from "@shopify/shopify-app-remix/server";
|
|
57
|
-
* import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
|
|
58
|
-
*
|
|
59
|
-
* const shopify = shopifyApp({
|
|
60
|
-
* restResources,
|
|
61
|
-
* // ...etc
|
|
62
|
-
* });
|
|
63
|
-
*
|
|
64
|
-
* export default shopify;
|
|
65
|
-
* export const unauthenticated = shopify.unauthenticated;
|
|
66
|
-
* ```
|
|
67
|
-
* @example
|
|
68
33
|
* <caption>Querying the GraphQL API.</caption>
|
|
69
34
|
* <description>Use `admin.graphql` to make query / mutation requests.</description>
|
|
70
35
|
* ```ts
|
|
@@ -97,14 +62,13 @@ export interface UnauthenticatedAdminContext<Resources extends ShopifyRestResour
|
|
|
97
62
|
* import { shopifyApp } from "@shopify/shopify-app-remix/server";
|
|
98
63
|
*
|
|
99
64
|
* const shopify = shopifyApp({
|
|
100
|
-
* restResources,
|
|
101
65
|
* // ...etc
|
|
102
66
|
* });
|
|
103
67
|
* export default shopify;
|
|
104
68
|
* export const unauthenticated = shopify.unauthenticated;
|
|
105
69
|
* ```
|
|
106
70
|
*/
|
|
107
|
-
admin: AdminApiContext<Resources>;
|
|
71
|
+
admin: AdminApiContext<ConfigArg, Resources>;
|
|
108
72
|
}
|
|
109
|
-
export type GetUnauthenticatedAdminContext<Resources extends ShopifyRestResources> = (shop: string) => Promise<UnauthenticatedAdminContext<Resources>>;
|
|
73
|
+
export type GetUnauthenticatedAdminContext<ConfigArg extends AppConfigArg, Resources extends ShopifyRestResources> = (shop: string) => Promise<UnauthenticatedAdminContext<ConfigArg, Resources>>;
|
|
110
74
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/admin/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAEnE,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAE9C,MAAM,WAAW,2BAA2B,CAC1C,SAAS,SAAS,oBAAoB;IAEtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/admin/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAEnE,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAE9C,MAAM,WAAW,2BAA2B,CAC1C,SAAS,SAAS,YAAY,EAC9B,SAAS,SAAS,oBAAoB;IAEtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,EAAE,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;CAC9C;AAED,MAAM,MAAM,8BAA8B,CACxC,SAAS,SAAS,YAAY,EAC9B,SAAS,SAAS,oBAAoB,IACpC,CACF,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,2BAA2B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC"}
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import type { ShopifyRestResources } from '@shopify/shopify-api';
|
|
2
|
+
import type { AppConfigArg } from '../config-types';
|
|
2
3
|
import type { GetUnauthenticatedAdminContext } from './admin/types';
|
|
3
4
|
import type { GetUnauthenticatedStorefrontContext } from './storefront/types';
|
|
4
|
-
export interface Unauthenticated<Resources extends ShopifyRestResources> {
|
|
5
|
+
export interface Unauthenticated<ConfigArg extends AppConfigArg, Resources extends ShopifyRestResources> {
|
|
5
6
|
/**
|
|
6
7
|
* Get an admin context by passing a shop
|
|
7
8
|
*
|
|
@@ -14,10 +15,8 @@ export interface Unauthenticated<Resources extends ShopifyRestResources> {
|
|
|
14
15
|
* ```ts
|
|
15
16
|
* // /app/shopify.server.ts
|
|
16
17
|
* import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix/server";
|
|
17
|
-
* import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
|
|
18
18
|
*
|
|
19
19
|
* const shopify = shopifyApp({
|
|
20
|
-
* restResources,
|
|
21
20
|
* // ...etc
|
|
22
21
|
* });
|
|
23
22
|
* export default shopify;
|
|
@@ -31,12 +30,13 @@ export interface Unauthenticated<Resources extends ShopifyRestResources> {
|
|
|
31
30
|
* export async function loader({ request }: LoaderFunctionArgs) {
|
|
32
31
|
* const shop = await authenticateExternal(request)
|
|
33
32
|
* const {admin} = await shopify.unauthenticated.admin(shop);
|
|
33
|
+
* const response = await admin.graphql("{ shop { name} }")
|
|
34
34
|
*
|
|
35
|
-
* return json(await
|
|
35
|
+
* return json(await response.json());
|
|
36
36
|
* }
|
|
37
37
|
* ```
|
|
38
38
|
*/
|
|
39
|
-
admin: GetUnauthenticatedAdminContext<Resources>;
|
|
39
|
+
admin: GetUnauthenticatedAdminContext<ConfigArg, Resources>;
|
|
40
40
|
/**
|
|
41
41
|
* Get a storefront context by passing a shop
|
|
42
42
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/server/unauthenticated/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE/D,OAAO,KAAK,EAAC,8BAA8B,EAAC,MAAM,eAAe,CAAC;AAClE,OAAO,KAAK,EAAC,mCAAmC,EAAC,MAAM,oBAAoB,CAAC;AAE5E,MAAM,WAAW,eAAe,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/server/unauthenticated/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE/D,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAC,8BAA8B,EAAC,MAAM,eAAe,CAAC;AAClE,OAAO,KAAK,EAAC,mCAAmC,EAAC,MAAM,oBAAoB,CAAC;AAE5E,MAAM,WAAW,eAAe,CAC9B,SAAS,SAAS,YAAY,EAC9B,SAAS,SAAS,oBAAoB;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,EAAE,8BAA8B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,EAAE,mCAAmC,CAAC;CACjD"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const SHOPIFY_REMIX_LIBRARY_VERSION = "3.
|
|
1
|
+
export declare const SHOPIFY_REMIX_LIBRARY_VERSION = "3.5.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|