@shopify/shopify-app-remix 1.0.0-rc.0

package/build/ts/config-types.d.ts

@@ -0,0 +1,325 @@
+import { ConfigParams as ApiConfigArg, ConfigInterface as ApiConfig, ShopifyRestResources, Session, ApiVersion, WebhookHandler } from '@shopify/shopify-api';
+import { SessionStorage } from '@shopify/shopify-app-session-storage';
+import type { GraphqlQueryFunction } from './auth/admin/graphql-client';
+import type { RemixRestClient } from './auth/admin/rest-client';
+import { AppDistribution } from './types';
+export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRestResources, Storage extends SessionStorage = SessionStorage> extends Omit<ApiConfigArg<Resources>, 'hostName' | 'hostScheme' | 'isEmbeddedApp' | 'apiVersion' | 'isCustomStoreApp'> {
+    /**
+     * The URL your app is running on.
+     *
+     * The `@shopify/cli` provides this URL as `process.env.SHOPIFY_APP_URL`.  For development this is probably a tunnel URL that points to your local machine.  If production this is your production URL.
+     */
+    appUrl: string;
+    /**
+     * An adaptor for storing sessions in your database of choice.
+     *
+     * Shopify provides multiple session storage adaptors and you can create your own. {@link https://github.com/Shopify/shopify-app-js/blob/main/README.md#session-storage-options}
+     *
+     * @example
+     * Using Prisma
+     * ```ts
+     * import { shopifyApp } from "@shopify/shopify-app-remix";
+     * import { PrismaSessionStorage } from "@shopify/shopify-app-session-storage-prisma";
+     *
+     * import prisma from "~/db.server";
+     *
+     * export const shopify = shopifyApp({
+     *   // ... etc
+     *   sessionStorage: new PrismaSessionStorage(prisma),
+     * });
+     * ```
+     */
+    sessionStorage: Storage;
+    /**
+     * Does your app use online or just offline tokens.
+     *
+     * If your app uses online tokens both online and offline tokens will be saved to your database.  This ensures your app can perform background jobs
+     *
+     * {@link https://shopify.dev/docs/apps/auth/oauth/access-modes}
+     *
+     * @defaultValue `false`
+     */
+    useOnlineTokens?: boolean;
+    /**
+     * The config for the webhook topics your app would like to subscribe to.
+     *
+     * {@link https://shopify.dev/docs/apps/webhooks}
+     *
+     * This can be in used in conjunction with the afterAuth hook to register webhook topics when a user installs your app.  Or you can use this function in other processes such as background jobs.
+     *
+     * @example
+     * Registering for a webhook when a merchant uninstalls your app.
+     * ```ts
+     * // app/shopify.server.ts
+     * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix";
+     *
+     * export const shopify = shopifyApp({
+     *   webhooks: {
+     *     APP_UNINSTALLED: {
+     *       deliveryMethod: DeliveryMethod.Http,
+     *        callbackUrl: "/webhooks",
+     *     },
+     *   },
+     *   hooks: {
+     *     afterAuth: async ({ session }) => {
+     *       shopify.registerWebhooks({ session });
+     *     }
+     *   },
+     *   // ...etc
+     * });
+     *
+     * // app/routes/webhooks.jsx
+     * import { ActionArgs } from "@remix-run/node";
+     *
+     * import { shopify } from "../shopify.server";
+     * import db from "../db.server";
+     *
+     * export const action = async ({ request }: ActionArgs) => {
+     *   const { topic, shop } = await shopify.authenticate.webhook(request);
+     *
+     *   switch (topic) {
+     *     case "APP_UNINSTALLED":
+     *       await db.session.deleteMany({ where: { shop } });
+     *       break;
+     *     case "CUSTOMERS_DATA_REQUEST":
+     *     case "CUSTOMERS_REDACT":
+     *     case "SHOP_REDACT":
+     *     default:
+     *       throw new Response("Unhandled webhook topic", { status: 404 });
+     *   }
+     *   throw new Response();
+     * };
+     * ```
+     */
+    webhooks?: WebhookConfig;
+    /**
+     * Functions to call at key places during your apps lifecycle.
+     *
+     * These functions are called in the context of the request that triggered them.  This means you can access the session.
+     *
+     * @example
+     * Seeding your database custom data when a merchant installs your app.
+     * ```ts
+     * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix";
+     * import { seedStoreData } from "~/db/seeds"
+     *
+     * export const shopify = shopifyApp({
+     *   hooks: {
+     *     afterAuth: async ({ session }) => {
+     *       seedStoreData({session})
+     *     }
+     *   },
+     *   // ...etc
+     * });
+     * ```
+     */
+    hooks?: HooksConfig;
+    /**
+     * Does your app render embedded inside the Shopify Admin or on its own.
+     *
+     * Unless you have very specific needs, this should be true.
+     *
+     * @defaultValue `true`
+     */
+    isEmbeddedApp?: boolean;
+    /**
+     * How your app is distributed. Defaults to app store.
+     *
+     * {@link https://shopify.dev/docs/apps/distribution}
+     */
+    distribution?: AppDistribution;
+    /**
+     * What version of Shopify's Admin API's would you like to use.
+     *
+     * {@link https://shopify.dev/docs/api/}
+     *
+     * @defaultValue `LATEST_API_VERSION` from `@shopify/shopify-app-remix`
+     *
+     * @example
+     * Using the latest API Version (Recommended)
+     * ```ts
+     * import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix";
+     *
+     * export const shopify = shopifyApp({
+     *   // ...etc
+     *   apiVersion: LATEST_API_VERSION,
+     * });
+     * ```
+     */
+    apiVersion?: ApiVersion;
+    /**
+     * A path that Shopify can reserve for auth related endpoints.
+     *
+     * This must match a $ route in your Remix app.  That route must export a loader function that calls `shopify.authenticate.admin(request)`.
+     *
+     * @default `"/auth"`
+     *
+     * @example
+     * Using the latest API Version (Recommended)
+     * ```ts
+     * // app/shopify.server.ts
+     * import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix";
+     *
+     * export const shopify = shopifyApp({
+     *   // ...etc
+     *   apiVersion: LATEST_API_VERSION,
+     * });
+     *
+     * // app/routes/auth/$.jsx
+     * import { LoaderArgs } from "@remix-run/node";
+     * import { shopify } from "../../shopify.server";
+     *
+     * export async function loader({ request }: LoaderArgs) {
+     *   await shopify.authenticate.admin(request);
+     *
+     *   return null
+     * }
+     * ```
+     */
+    authPathPrefix?: string;
+}
+export interface AppConfig<Storage extends SessionStorage = SessionStorage> extends ApiConfig {
+    canUseLoginForm: boolean;
+    appUrl: string;
+    auth: AuthConfig;
+    sessionStorage: Storage;
+    useOnlineTokens: boolean;
+    hooks: HooksConfig;
+}
+interface AuthConfig {
+    path: string;
+    callbackPath: string;
+    exitIframePath: string;
+    patchSessionTokenPath: string;
+    loginPath: string;
+}
+export interface WebhookConfig {
+    [key: string]: WebhookHandler | WebhookHandler[];
+}
+interface HooksConfig {
+    /**
+     * A function to call after a merchant installs your app
+     *
+     * @param context - An object with context about the request that triggered the hook.
+     * @param context.session - The session of the merchant that installed your app. This is the output of sessionStorage.loadSession in case people want to load their own.
+     * @param context.admin - An object with access to the Shopify Admin API's.
+     *
+     * @example
+     * Registering webhooks and seeding data when a merchant installs your app.
+     * ```ts
+     * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix";
+     * import { seedStoreData } from "~/db/seeds"
+     *
+     * export const shopify = shopifyApp({
+     *   hooks: {
+     *     afterAuth: async ({ session }) => {
+     *       shopify.registerWebhooks({ session });
+     *       seedStoreData({session})
+     *     }
+     *   },
+     *   webhooks: {
+     *     APP_UNINSTALLED: {
+     *       deliveryMethod: DeliveryMethod.Http,
+     *        callbackUrl: "/webhooks",
+     *     },
+     *   },
+     *   // ...etc
+     * });
+     * ```
+     */
+    afterAuth?: (options: AfterAuthOptions) => void | Promise<void>;
+}
+export interface AfterAuthOptions<R extends ShopifyRestResources = ShopifyRestResources> {
+    session: Session;
+    admin: AdminApiContext<R>;
+}
+export interface AdminApiContext<Resources extends ShopifyRestResources = ShopifyRestResources> {
+    /**
+     * Methods for interacting with the Shopify Admin REST API
+     *
+     * There are methods for interacting with individual REST resources. You can also make plain `GET`, `POST`, `PUT` and `DELETE` requests should the REST resources not meet your needs.
+     *
+     * {@link https://shopify.dev/docs/api/admin-rest}
+     *
+     * @example
+     * Getting the number of orders in a store using rest resources
+     * ```ts
+     * // app/shopify.server.ts
+     * import { shopifyApp } from "@shopify/shopify-app-remix";
+     * import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
+     *
+     * export const shopify = shopifyApp({
+     *   restResources,
+     *   // ...etc
+     * });
+     *
+     * // app/routes/**\/.ts
+     * import { LoaderArgs, json } from "@remix-run/node";
+     * import { shopify } from "../shopify.server";
+     *
+     * export const loader = async ({ request }: LoaderArgs) => {
+     *   const { admin, session } = await shopify.authenticate.admin(request);
+     *   return json(admin.rest.resources.Order.count({ session }));
+     * };
+     * ```
+     *
+     * @example
+     * Making a GET request to the REST API
+     * ```ts
+     * // app/shopify.server.ts
+     * import { shopifyApp } from "@shopify/shopify-app-remix";
+     * import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
+     *
+     * export const shopify = shopifyApp({
+     *   restResources,
+     *   // ...etc
+     * });
+     *
+     * // app/routes/**\/.ts
+     * import { LoaderArgs, json } from "@remix-run/node";
+     * import { shopify } from "../shopify.server";
+     *
+     * export const loader = async ({ request }: LoaderArgs) => {
+     *   const response = await admin.rest.get({ path: "/customers/count.json" });
+     *   const customers = await response.json();
+     *   return json({ customers });
+     * };
+     * ```
+     */
+    rest: RemixRestClient<Resources>;
+    /**
+     * Methods for interacting with the Shopify Admin GraphQL API
+     *
+     * {@link https://shopify.dev/docs/api/admin-graphql}
+     * {@link https://github.com/Shopify/shopify-api-js/blob/main/docs/reference/clients/Graphql.md}
+     *
+     * @example
+     * Creating a new product
+     * ```ts
+     * import { ActionArgs } from "@remix-run/node";
+     * import { shopify } from "../shopify.server";
+     *
+     * export async function action({ request }: ActionArgs) {
+     *   const { admin } = await shopify.authenticate.admin(request);
+     *
+     *   const response = await admin.graphql(
+     *     `#graphql
+     *     mutation populateProduct($input: ProductInput!) {
+     *       productCreate(input: $input) {
+     *         product {
+     *           id
+     *         }
+     *       }
+     *     }`,
+     *     { variables: { input: { title: "Product Name" } } }
+     *   );
+     *
+     *   const productData = await response.json();
+     *   return json({ data: productData.data });
+     * }
+     * ```
+     */
+    graphql: GraphqlQueryFunction;
+}
+export {};
+//# sourceMappingURL=config-types.d.ts.map

package/build/ts/config-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-types.d.ts","sourceRoot":"","sources":["../../src/config-types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,eAAe,IAAI,SAAS,EAC5B,oBAAoB,EACpB,OAAO,EACP,UAAU,EACV,cAAc,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAEpE,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,YAAY,CAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,EAC7D,OAAO,SAAS,cAAc,GAAG,cAAc,CAC/C,SAAQ,IAAI,CACV,YAAY,CAAC,SAAS,CAAC,EACrB,UAAU,GACV,YAAY,GACZ,eAAe,GACf,YAAY,GACZ,kBAAkB,CACrB;IACD;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IAEpB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,YAAY,CAAC,EAAE,eAAe,CAAC;IAE/B;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,SAAS,CAAC,OAAO,SAAS,cAAc,GAAG,cAAc,CACxE,SAAQ,SAAS;IACjB,eAAe,EAAE,OAAO,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,cAAc,EAAE,OAAO,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,UAAU,UAAU;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,cAAc,EAAE,CAAC;CAClD;AAED,UAAU,WAAW;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,gBAAgB,CAC/B,CAAC,SAAS,oBAAoB,GAAG,oBAAoB;IAErD,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe,CAC9B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,OAAO,EAAE,oBAAoB,CAAC;CAC/B"}

package/build/ts/config-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=config-types.js.map

package/build/ts/config-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-types.js","sourceRoot":"","sources":["../../src/config-types.ts"],"names":[],"mappings":""}

package/build/ts/index.d.ts

@@ -0,0 +1,29 @@
+import '@shopify/shopify-api/adapters/web-api';
+import { ShopifyRestResources } from '@shopify/shopify-api';
+import { SessionStorage } from '@shopify/shopify-app-session-storage';
+import { type AppConfigArg } from './config-types';
+import { type ShopifyApp } from './types';
+export type { ShopifyApp, LoginError } from './types';
+export { LoginErrorType, AppDistribution } from './types';
+export { LATEST_API_VERSION, LogSeverity, DeliveryMethod, BillingInterval, } from '@shopify/shopify-api';
+/**
+ * Creates an object your app will use to interact with Shopify.
+ *
+ * @param appConfig Configuration options for your shopify app.  For example, the scopes your app needs.
+ * @returns `ShopifyApp` An object constructed using your appConfig.  It has methods for interacting with Shopify.
+ *
+ * @example
+ * The minimum viable configuration
+ * ```ts
+ * import { shopifyApp } from "@shopify/shopify-app-remix";
+ *
+ * export const shopify = shopifyApp({
+ *   apiKey: process.env.SHOPIFY_API_KEY!,
+ *   apiSecretKey: process.env.SHOPIFY_API_SECRET!,
+ *   scopes: process.env.SCOPES?.split(",")!,
+ *   appUrl: process.env.SHOPIFY_APP_URL!,
+ * });
+ * ```
+ */
+export declare function shopifyApp<Config extends AppConfigArg<Resources, Storage>, Resources extends ShopifyRestResources, Storage extends SessionStorage>(appConfig: Config): ShopifyApp<Config>;
+//# sourceMappingURL=index.d.ts.map

package/build/ts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,uCAAuC,CAAC;AAC/C,OAAO,EAML,oBAAoB,EAErB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAEpE,OAAO,EAAiB,KAAK,YAAY,EAAC,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAIL,KAAK,UAAU,EAChB,MAAM,SAAS,CAAC;AAajB,YAAY,EAAC,UAAU,EAAE,UAAU,EAAC,MAAM,SAAS,CAAC;AACpD,OAAO,EAAC,cAAc,EAAE,eAAe,EAAC,MAAM,SAAS,CAAC;AAExD,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAM9B;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,UAAU,CACxB,MAAM,SAAS,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,EAC/C,SAAS,SAAS,oBAAoB,EACtC,OAAO,SAAS,cAAc,EAC9B,SAAS,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CA6BvC"}

package/build/ts/index.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shopifyApp = exports.BillingInterval = exports.DeliveryMethod = exports.LogSeverity = exports.LATEST_API_VERSION = exports.AppDistribution = exports.LoginErrorType = void 0;
+var tslib_1 = require("tslib");
+require("@shopify/shopify-api/adapters/web-api");
+var shopify_api_1 = require("@shopify/shopify-api");
+var runtime_1 = require("@shopify/shopify-api/runtime");
+var types_1 = require("./types");
+var version_1 = require("./version");
+var webhooks_1 = require("./auth/webhooks");
+var authenticate_1 = require("./auth/admin/authenticate");
+var authenticate_2 = require("./auth/webhooks/authenticate");
+var authenticate_3 = require("./auth/public/authenticate");
+var override_logger_1 = require("./override-logger");
+var add_response_headers_1 = require("./auth/helpers/add-response-headers");
+var login_1 = require("./auth/login/login");
+var types_2 = require("./types");
+Object.defineProperty(exports, "LoginErrorType", { enumerable: true, get: function () { return types_2.LoginErrorType; } });
+Object.defineProperty(exports, "AppDistribution", { enumerable: true, get: function () { return types_2.AppDistribution; } });
+var shopify_api_2 = require("@shopify/shopify-api");
+Object.defineProperty(exports, "LATEST_API_VERSION", { enumerable: true, get: function () { return shopify_api_2.LATEST_API_VERSION; } });
+Object.defineProperty(exports, "LogSeverity", { enumerable: true, get: function () { return shopify_api_2.LogSeverity; } });
+Object.defineProperty(exports, "DeliveryMethod", { enumerable: true, get: function () { return shopify_api_2.DeliveryMethod; } });
+Object.defineProperty(exports, "BillingInterval", { enumerable: true, get: function () { return shopify_api_2.BillingInterval; } });
+(0, runtime_1.setAbstractRuntimeString)(function () {
+    return "Remix";
+});
+/**
+ * Creates an object your app will use to interact with Shopify.
+ *
+ * @param appConfig Configuration options for your shopify app.  For example, the scopes your app needs.
+ * @returns `ShopifyApp` An object constructed using your appConfig.  It has methods for interacting with Shopify.
+ *
+ * @example
+ * The minimum viable configuration
+ * ```ts
+ * import { shopifyApp } from "@shopify/shopify-app-remix";
+ *
+ * export const shopify = shopifyApp({
+ *   apiKey: process.env.SHOPIFY_API_KEY!,
+ *   apiSecretKey: process.env.SHOPIFY_API_SECRET!,
+ *   scopes: process.env.SCOPES?.split(",")!,
+ *   appUrl: process.env.SHOPIFY_APP_URL!,
+ * });
+ * ```
+ */
+function shopifyApp(appConfig) {
+    var api = deriveApi(appConfig);
+    var config = deriveConfig(appConfig, api.config);
+    var logger = (0, override_logger_1.overrideLogger)(api.logger);
+    (0, add_response_headers_1.installGlobalResponseHeaders)(config.isEmbeddedApp);
+    if (appConfig.webhooks) {
+        api.webhooks.addHandlers(appConfig.webhooks);
+    }
+    var params = { api: api, config: config, logger: logger };
+    var oauth = new authenticate_1.AuthStrategy(params);
+    return {
+        sessionStorage: config.sessionStorage,
+        canUseLoginForm: config.canUseLoginForm,
+        addResponseHeaders: (0, add_response_headers_1.addResponseHeadersFactory)(params),
+        registerWebhooks: (0, webhooks_1.registerWebhooksFactory)(params),
+        login: (0, login_1.loginFactory)(params),
+        authenticate: {
+            admin: oauth.authenticateAdmin.bind(oauth),
+            public: (0, authenticate_3.authenticatePublicFactory)(params),
+            webhook: (0, authenticate_2.authenticateWebhookFactory)(params),
+        },
+    };
+}
+exports.shopifyApp = shopifyApp;
+function deriveApi(appConfig) {
+    var _a, _b;
+    var appUrl;
+    try {
+        appUrl = new URL(appConfig.appUrl);
+    }
+    catch (error) {
+        throw new shopify_api_1.ShopifyError('Invalid appUrl provided. Please provide a valid URL.');
+    }
+    /* eslint-disable no-process-env */
+    if (appUrl.hostname === 'localhost' && !appUrl.port && process.env.PORT) {
+        appUrl.port = process.env.PORT;
+    }
+    /* eslint-enable no-process-env */
+    appConfig.appUrl = appUrl.origin;
+    var userAgentPrefix = "Shopify Remix Library v".concat(version_1.SHOPIFY_REMIX_LIBRARY_VERSION);
+    if (appConfig.userAgentPrefix) {
+        userAgentPrefix = "".concat(appConfig.userAgentPrefix, " | ").concat(userAgentPrefix);
+    }
+    var cleanApiConfig = tslib_1.__assign(tslib_1.__assign({}, appConfig), { hostName: appUrl.host, hostScheme: appUrl.protocol.replace(':', ''), userAgentPrefix: userAgentPrefix, isEmbeddedApp: (_a = appConfig.isEmbeddedApp) !== null && _a !== void 0 ? _a : true, apiVersion: (_b = appConfig.apiVersion) !== null && _b !== void 0 ? _b : shopify_api_1.LATEST_API_VERSION, isCustomStoreApp: appConfig.distribution === types_1.AppDistribution.ShopifyAdmin });
+    return (0, shopify_api_1.shopifyApi)(cleanApiConfig);
+}
+function deriveConfig(appConfig, apiConfig) {
+    var _a, _b, _c;
+    if (!appConfig.sessionStorage) {
+        throw new shopify_api_1.ShopifyError('Please provide a valid session storage. See https://github.com/Shopify/shopify-app-js/blob/main/README.md#session-storage-options for options.');
+    }
+    var authPathPrefix = appConfig.authPathPrefix || '/auth';
+    var distribution = (_a = appConfig.distribution) !== null && _a !== void 0 ? _a : types_1.AppDistribution.AppStore;
+    return tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, appConfig), apiConfig), { canUseLoginForm: distribution !== types_1.AppDistribution.ShopifyAdmin, useOnlineTokens: (_b = appConfig.useOnlineTokens) !== null && _b !== void 0 ? _b : false, hooks: (_c = appConfig.hooks) !== null && _c !== void 0 ? _c : {}, sessionStorage: appConfig.sessionStorage, auth: {
+            path: authPathPrefix,
+            callbackPath: "".concat(authPathPrefix, "/callback"),
+            patchSessionTokenPath: "".concat(authPathPrefix, "/session-token"),
+            exitIframePath: "".concat(authPathPrefix, "/exit-iframe"),
+            loginPath: "".concat(authPathPrefix, "/login"),
+        } });
+}
+//# sourceMappingURL=index.js.map

package/build/ts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAAA,iDAA+C;AAC/C,oDAQ8B;AAC9B,wDAAsE;AAItE,iCAKiB;AACjB,qCAAwD;AACxD,4CAAwD;AACxD,0DAAuD;AACvD,6DAAwE;AACxE,2DAAqE;AACrE,qDAAiD;AACjD,4EAG6C;AAC7C,4CAAgD;AAGhD,iCAAwD;AAAhD,uGAAA,cAAc,OAAA;AAAE,wGAAA,eAAe,OAAA;AAEvC,oDAK8B;AAJ5B,iHAAA,kBAAkB,OAAA;AAClB,0GAAA,WAAW,OAAA;AACX,6GAAA,cAAc,OAAA;AACd,8GAAA,eAAe,OAAA;AAGjB,IAAA,kCAAwB,EAAC;IACvB,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,UAAU,CAIxB,SAAiB;IACjB,IAAM,GAAG,GAAG,SAAS,CAAY,SAAS,CAAC,CAAC;IAC5C,IAAM,MAAM,GAAG,YAAY,CAAU,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5D,IAAM,MAAM,GAAG,IAAA,gCAAc,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAE1C,IAAA,mDAA4B,EAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAEnD,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;KAC9C;IAED,IAAM,MAAM,GAAgB,EAAC,GAAG,KAAA,EAAE,MAAM,QAAA,EAAE,MAAM,QAAA,EAAC,CAAC;IAClD,IAAM,KAAK,GAAG,IAAI,2BAAY,CAAoB,MAAM,CAAC,CAAC;IAE1D,OAAO;QACL,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,kBAAkB,EAAE,IAAA,gDAAyB,EAAC,MAAM,CAAC;QACrD,gBAAgB,EAAE,IAAA,kCAAuB,EAAC,MAAM,CAAC;QACjD,KAAK,EAAE,IAAA,oBAAY,EAAC,MAAM,CAAC;QAC3B,YAAY,EAAE;YACZ,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1C,MAAM,EAAE,IAAA,wCAAyB,EAAC,MAAM,CAAC;YACzC,OAAO,EAAE,IAAA,yCAA0B,EAGjC,MAAM,CAAC;SACV;KACF,CAAC;AACJ,CAAC;AAjCD,gCAiCC;AAED,SAAS,SAAS,CAChB,SAAuB;;IAEvB,IAAI,MAAW,CAAC;IAChB,IAAI;QACF,MAAM,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KACpC;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,0BAAY,CACpB,sDAAsD,CACvD,CAAC;KACH;IAED,mCAAmC;IACnC,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;KAChC;IACD,kCAAkC;IAClC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAEjC,IAAI,eAAe,GAAG,iCAA0B,uCAA6B,CAAE,CAAC;IAChF,IAAI,SAAS,CAAC,eAAe,EAAE;QAC7B,eAAe,GAAG,UAAG,SAAS,CAAC,eAAe,gBAAM,eAAe,CAAE,CAAC;KACvE;IAED,IAAM,cAAc,yCACf,SAAS,KACZ,QAAQ,EAAE,MAAM,CAAC,IAAI,EACrB,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAqB,EAChE,eAAe,iBAAA,EACf,aAAa,EAAE,MAAA,SAAS,CAAC,aAAa,mCAAI,IAAI,EAC9C,UAAU,EAAE,MAAA,SAAS,CAAC,UAAU,mCAAI,gCAAkB,EACtD,gBAAgB,EAAE,SAAS,CAAC,YAAY,KAAK,uBAAe,CAAC,YAAY,GAC1E,CAAC;IAEF,OAAO,IAAA,wBAAU,EAAY,cAAc,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,YAAY,CACnB,SAAuB,EACvB,SAAoB;;IAEpB,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE;QAC7B,MAAM,IAAI,0BAAY,CACpB,gJAAgJ,CACjJ,CAAC;KACH;IAED,IAAM,cAAc,GAAG,SAAS,CAAC,cAAc,IAAI,OAAO,CAAC;IAC3D,IAAM,YAAY,GAAG,MAAA,SAAS,CAAC,YAAY,mCAAI,uBAAe,CAAC,QAAQ,CAAC;IAExE,8DACK,SAAS,GACT,SAAS,KACZ,eAAe,EAAE,YAAY,KAAK,uBAAe,CAAC,YAAY,EAC9D,eAAe,EAAE,MAAA,SAAS,CAAC,eAAe,mCAAI,KAAK,EACnD,KAAK,EAAE,MAAA,SAAS,CAAC,KAAK,mCAAI,EAAE,EAC5B,cAAc,EAAE,SAAS,CAAC,cAAyB,EACnD,IAAI,EAAE;YACJ,IAAI,EAAE,cAAc;YACpB,YAAY,EAAE,UAAG,cAAc,cAAW;YAC1C,qBAAqB,EAAE,UAAG,cAAc,mBAAgB;YACxD,cAAc,EAAE,UAAG,cAAc,iBAAc;YAC/C,SAAS,EAAE,UAAG,cAAc,WAAQ;SACrC,IACD;AACJ,CAAC"}

package/build/ts/override-logger.d.ts

@@ -0,0 +1,3 @@
+import { Shopify } from '@shopify/shopify-api';
+export declare function overrideLogger(logger: Shopify['logger']): Shopify['logger'];
+//# sourceMappingURL=override-logger.d.ts.map

package/build/ts/override-logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"override-logger.d.ts","sourceRoot":"","sources":["../../src/override-logger.ts"],"names":[],"mappings":"AACA,OAAO,EAAyB,OAAO,EAAC,MAAM,sBAAsB,CAAC;AAOrE,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAiC3E"}

package/build/ts/override-logger.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.overrideLogger = void 0;
+var tslib_1 = require("tslib");
+var semver_1 = tslib_1.__importDefault(require("semver"));
+var shopify_api_1 = require("@shopify/shopify-api");
+var version_1 = require("./version");
+// eslint-disable-next-line no-warning-comments
+// TODO This has been copied from shopify-app-express, it should be extracted into a shared package
+// https://github.com/orgs/Shopify/projects/6899/views/1?pane=issue&itemId=28358070
+function overrideLogger(logger) {
+    var baseContext = { package: 'shopify-app' };
+    var warningFunction = function (message, context) {
+        if (context === void 0) { context = {}; }
+        return logger.warning(message, tslib_1.__assign(tslib_1.__assign({}, baseContext), context));
+    };
+    function deprecated(warningFunction) {
+        return function (version, message) {
+            if (semver_1.default.gte(version_1.SHOPIFY_REMIX_LIBRARY_VERSION, version)) {
+                throw new shopify_api_1.FeatureDeprecatedError("Feature was deprecated in version ".concat(version));
+            }
+            return warningFunction("[Deprecated | ".concat(version, "] ").concat(message));
+        };
+    }
+    return tslib_1.__assign(tslib_1.__assign({}, logger), { log: function (severity, message, context) {
+            if (context === void 0) { context = {}; }
+            return logger.log(severity, message, tslib_1.__assign(tslib_1.__assign({}, baseContext), context));
+        }, debug: function (message, context) {
+            if (context === void 0) { context = {}; }
+            return logger.debug(message, tslib_1.__assign(tslib_1.__assign({}, baseContext), context));
+        }, info: function (message, context) {
+            if (context === void 0) { context = {}; }
+            return logger.info(message, tslib_1.__assign(tslib_1.__assign({}, baseContext), context));
+        }, warning: warningFunction, error: function (message, context) {
+            if (context === void 0) { context = {}; }
+            return logger.error(message, tslib_1.__assign(tslib_1.__assign({}, baseContext), context));
+        }, deprecated: deprecated(warningFunction) });
+}
+exports.overrideLogger = overrideLogger;
+//# sourceMappingURL=override-logger.js.map

package/build/ts/override-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"override-logger.js","sourceRoot":"","sources":["../../src/override-logger.ts"],"names":[],"mappings":";;;;AAAA,0DAA4B;AAC5B,oDAAqE;AAErE,qCAAwD;AAExD,+CAA+C;AAC/C,mGAAmG;AACnG,mFAAmF;AACnF,SAAgB,cAAc,CAAC,MAAyB;IACtD,IAAM,WAAW,GAAG,EAAC,OAAO,EAAE,aAAa,EAAC,CAAC;IAE7C,IAAM,eAAe,GAAiC,UACpD,OAAO,EACP,OAAY;QAAZ,wBAAA,EAAA,YAAY;QACT,OAAA,MAAM,CAAC,OAAO,CAAC,OAAO,wCAAM,WAAW,GAAK,OAAO,EAAE;IAArD,CAAqD,CAAC;IAE3D,SAAS,UAAU,CAAC,eAA6C;QAC/D,OAAO,UAAU,OAAe,EAAE,OAAe;YAC/C,IAAI,gBAAM,CAAC,GAAG,CAAC,uCAA6B,EAAE,OAAO,CAAC,EAAE;gBACtD,MAAM,IAAI,oCAAsB,CAC9B,4CAAqC,OAAO,CAAE,CAC/C,CAAC;aACH;YAED,OAAO,eAAe,CAAC,wBAAiB,OAAO,eAAK,OAAO,CAAE,CAAC,CAAC;QACjE,CAAC,CAAC;IACJ,CAAC;IAED,6CACK,MAAM,KACT,GAAG,EAAE,UAAC,QAAQ,EAAE,OAAO,EAAE,OAAY;YAAZ,wBAAA,EAAA,YAAY;YACnC,OAAA,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,wCAAM,WAAW,GAAK,OAAO,EAAE;QAA3D,CAA2D,EAC7D,KAAK,EAAE,UAAC,OAAO,EAAE,OAAY;YAAZ,wBAAA,EAAA,YAAY;YAC3B,OAAA,MAAM,CAAC,KAAK,CAAC,OAAO,wCAAM,WAAW,GAAK,OAAO,EAAE;QAAnD,CAAmD,EACrD,IAAI,EAAE,UAAC,OAAO,EAAE,OAAY;YAAZ,wBAAA,EAAA,YAAY;YAC1B,OAAA,MAAM,CAAC,IAAI,CAAC,OAAO,wCAAM,WAAW,GAAK,OAAO,EAAE;QAAlD,CAAkD,EACpD,OAAO,EAAE,eAAe,EACxB,KAAK,EAAE,UAAC,OAAO,EAAE,OAAY;YAAZ,wBAAA,EAAA,YAAY;YAC3B,OAAA,MAAM,CAAC,KAAK,CAAC,OAAO,wCAAM,WAAW,GAAK,OAAO,EAAE;QAAnD,CAAmD,EACrD,UAAU,EAAE,UAAU,CAAC,eAAe,CAAC,IACvC;AACJ,CAAC;AAjCD,wCAiCC"}