@shopify/shopify-app-remix 2.0.2 → 2.2.0

package/build/cjs/server/version.js

@@ -2,6 +2,6 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const SHOPIFY_REMIX_LIBRARY_VERSION = '2.0.2';
+const SHOPIFY_REMIX_LIBRARY_VERSION = '2.2.0';
 
 exports.SHOPIFY_REMIX_LIBRARY_VERSION = SHOPIFY_REMIX_LIBRARY_VERSION;

package/build/ts/server/__test-helpers/test-config.d.ts

@@ -1,11 +1,41 @@
+/// <reference types="jest" />
+import { LogSeverity, ShopifyRestResources } from '@shopify/shopify-api';
+import { SessionStorage } from '@shopify/shopify-app-session-storage';
+import { MemorySessionStorage } from '@shopify/shopify-app-session-storage-memory';
 import type { AppConfigArg } from '../config-types';
-import type { FutureFlags } from '../future/flags';
-type DefaultedFutureFlag<Overrides extends Partial<AppConfigArg>, Flag extends keyof FutureFlags> = Overrides['future'] extends FutureFlags ? Overrides['future'][Flag] : true;
-type TestConfig<Overrides extends Partial<AppConfigArg>> = Omit<AppConfigArg, 'billing'> & Overrides & {
-    future: {
-        v3_webhookAdminContext: DefaultedFutureFlag<Overrides, 'v3_webhookAdminContext'>;
+import type { FutureFlagOptions } from '../future/flags';
+declare const TEST_CONFIG: {
+    readonly apiKey: "testApiKey";
+    readonly apiSecretKey: "testApiSecretKey";
+    readonly scopes: any;
+    readonly apiVersion: import("@shopify/shopify-api").ApiVersion.October23;
+    readonly appUrl: "https://my-test-app.myshopify.io";
+    readonly logger: {
+        readonly log: jest.Mock<any, any, any>;
+        readonly level: LogSeverity.Debug;
     };
+    readonly isEmbeddedApp: true;
+    readonly sessionStorage: MemorySessionStorage;
+    readonly future: Required<{
+        v3_webhookAdminContext?: true | undefined;
+        v3_authenticatePublic?: true | undefined;
+    }>;
+};
+export declare function testConfig<Overrides extends TestOverridesArg<Future>, Future extends FutureFlagOptions>({ future, ...overrides }?: Overrides & {
+    future?: Future;
+}): TestConfig<Overrides, Future>;
+type Modify<Type1, Type2> = {
+    [key in keyof Type2 as Type2[key] extends undefined ? never : key]: Type2[key];
+} & {
+    [key in keyof Type1 as key extends keyof Type2 ? never : key]: Type1[key];
+};
+type DefaultedFutureFlags<Future> = Modify<typeof TEST_CONFIG.future, Future>;
+type TestOverrides<Future> = Partial<Omit<AppConfigArg<ShopifyRestResources, SessionStorage, DefaultedFutureFlags<Future>>, 'future'> & {
+    future: Partial<DefaultedFutureFlags<Future>>;
+}>;
+type TestOverridesArg<Future> = undefined | TestOverrides<Future>;
+type TestConfig<Overrides extends TestOverridesArg<Future>, Future> = Modify<typeof TEST_CONFIG, Overrides> & {
+    future: Modify<typeof TEST_CONFIG.future, Future>;
 };
-export declare function testConfig<Overrides extends Partial<AppConfigArg>>(overrides?: Overrides): TestConfig<Overrides>;
 export {};
 //# sourceMappingURL=test-config.d.ts.map

package/build/ts/server/__test-helpers/test-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-config.d.ts","sourceRoot":"","sources":["../../../../src/server/__test-helpers/test-config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAIjD,KAAK,mBAAmB,CACtB,SAAS,SAAS,OAAO,CAAC,YAAY,CAAC,EACvC,IAAI,SAAS,MAAM,WAAW,IAC5B,SAAS,CAAC,QAAQ,CAAC,SAAS,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAE/E,KAAK,UAAU,CAAC,SAAS,SAAS,OAAO,CAAC,YAAY,CAAC,IAErD,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,GAC3B,SAAS,GAAG;IAEV,MAAM,EAAE;QACN,sBAAsB,EAAE,mBAAmB,CACzC,SAAS,EACT,wBAAwB,CACzB,CAAC;KACH,CAAC;CACH,CAAC;AAEN,wBAAgB,UAAU,CAAC,SAAS,SAAS,OAAO,CAAC,YAAY,CAAC,EAChE,SAAS,GAAE,SAA2B,GACrC,UAAU,CAAC,SAAS,CAAC,CAmBvB"}
+{"version":3,"file":"test-config.d.ts","sourceRoot":"","sources":["../../../../src/server/__test-helpers/test-config.ts"],"names":[],"mappings":";AAAA,OAAO,EAEL,WAAW,EACX,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAC,oBAAoB,EAAC,MAAM,6CAA6C,CAAC;AAEjF,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAC,iBAAiB,EAAc,MAAM,iBAAiB,CAAC;AAgBpE,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;CAaP,CAAC;AAQX,wBAAgB,UAAU,CACxB,SAAS,SAAS,gBAAgB,CAAC,MAAM,CAAC,EAC1C,MAAM,SAAS,iBAAiB,EAEhC,EAAC,MAAM,EAAE,GAAG,SAAS,EAAC,GAAE,SAAS,GAAG;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAEnD,GACA,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAa/B;AASD,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,IAAI;KACzB,GAAG,IAAI,MAAM,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,SAAS,GAC/C,KAAK,GACL,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;CACrB,GAAG;KACD,GAAG,IAAI,MAAM,KAAK,IAAI,GAAG,SAAS,MAAM,KAAK,GAAG,KAAK,GAAG,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;CAC1E,CAAC;AAEF,KAAK,oBAAoB,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAM9E,KAAK,aAAa,CAAC,MAAM,IAAI,OAAO,CAClC,IAAI,CACF,YAAY,CACV,oBAAoB,EACpB,cAAc,EACd,oBAAoB,CAAC,MAAM,CAAC,CAC7B,EACD,QAAQ,CACT,GAAG;IACF,MAAM,EAAE,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;CAC/C,CACF,CAAC;AAEF,KAAK,gBAAgB,CAAC,MAAM,IAAI,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAElE,KAAK,UAAU,CAAC,SAAS,SAAS,gBAAgB,CAAC,MAAM,CAAC,EAAE,MAAM,IAAI,MAAM,CAC1E,OAAO,WAAW,EAClB,SAAS,CACV,GAAG;IACF,MAAM,EAAE,MAAM,CAAC,OAAO,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnD,CAAC"}

package/build/ts/server/__test-helpers/test-config.js

@@ -5,12 +5,40 @@ var tslib_1 = require("tslib");
 var shopify_api_1 = require("@shopify/shopify-api");
 var shopify_app_session_storage_memory_1 = require("@shopify/shopify-app-session-storage-memory");
 var const_1 = require("./const");
-function testConfig(overrides) {
-    if (overrides === void 0) { overrides = {}; }
-    return tslib_1.__assign(tslib_1.__assign({ apiKey: const_1.API_KEY, apiSecretKey: const_1.API_SECRET_KEY, scopes: ['testScope'], apiVersion: shopify_api_1.LATEST_API_VERSION, appUrl: const_1.APP_URL, logger: {
-            log: jest.fn(),
-            level: shopify_api_1.LogSeverity.Debug,
-        }, isEmbeddedApp: true, sessionStorage: new shopify_app_session_storage_memory_1.MemorySessionStorage() }, overrides), { future: tslib_1.__assign({ v3_webhookAdminContext: true }, overrides.future) });
+/*
+ * This object mandates that all existing future flags be activated for tests. If a new flag is added, this object must
+ * be updated to include it, which will also cause all tests to use the new behaviour by default (and likely fail).
+ *
+ * This way, we'll always ensure our tests are covering all future flags. Please make sure to also have tests for the
+ * old behaviour.
+ */
+var TEST_FUTURE_FLAGS = {
+    v3_authenticatePublic: true,
+    v3_webhookAdminContext: true,
+};
+var TEST_CONFIG = {
+    apiKey: const_1.API_KEY,
+    apiSecretKey: const_1.API_SECRET_KEY,
+    scopes: ['testScope'],
+    apiVersion: shopify_api_1.LATEST_API_VERSION,
+    appUrl: const_1.APP_URL,
+    logger: {
+        log: jest.fn(),
+        level: shopify_api_1.LogSeverity.Debug,
+    },
+    isEmbeddedApp: true,
+    sessionStorage: new shopify_app_session_storage_memory_1.MemorySessionStorage(),
+    future: TEST_FUTURE_FLAGS,
+};
+// Reset the config object before each test
+beforeEach(function () {
+    TEST_CONFIG.logger.log.mockReset();
+    TEST_CONFIG.sessionStorage = new shopify_app_session_storage_memory_1.MemorySessionStorage();
+});
+function testConfig(_a) {
+    if (_a === void 0) { _a = {}; }
+    var future = _a.future, overrides = tslib_1.__rest(_a, ["future"]);
+    return tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, TEST_CONFIG), overrides), { logger: tslib_1.__assign(tslib_1.__assign({}, TEST_CONFIG.logger), overrides.logger), future: tslib_1.__assign(tslib_1.__assign({}, TEST_CONFIG.future), future) });
 }
 exports.testConfig = testConfig;
 //# sourceMappingURL=test-config.js.map

package/build/ts/server/__test-helpers/test-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"test-config.js","sourceRoot":"","sources":["../../../../src/server/__test-helpers/test-config.ts"],"names":[],"mappings":";;;;AAAA,oDAAqE;AACrE,kGAAiF;AAKjF,iCAAyD;AAoBzD,SAAgB,UAAU,CACxB,SAAsC;IAAtC,0BAAA,EAAA,YAAuB,EAAe;IAEtC,2CACE,MAAM,EAAE,eAAO,EACf,YAAY,EAAE,sBAAc,EAC5B,MAAM,EAAE,CAAC,WAAW,CAAC,EACrB,UAAU,EAAE,gCAAkB,EAC9B,MAAM,EAAE,eAAO,EACf,MAAM,EAAE;YACN,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YACd,KAAK,EAAE,yBAAW,CAAC,KAAK;SACzB,EACD,aAAa,EAAE,IAAI,EACnB,cAAc,EAAE,IAAI,yDAAoB,EAAE,IACvC,SAAS,KACZ,MAAM,qBACJ,sBAAsB,EAAE,IAAI,IACxB,SAAS,CAAC,MAA8B,KAE9C;AACJ,CAAC;AArBD,gCAqBC"}
+{"version":3,"file":"test-config.js","sourceRoot":"","sources":["../../../../src/server/__test-helpers/test-config.ts"],"names":[],"mappings":";;;;AAAA,oDAI8B;AAE9B,kGAAiF;AAKjF,iCAAyD;AAEzD;;;;;;GAMG;AACH,IAAM,iBAAiB,GAAiD;IACtE,qBAAqB,EAAE,IAAI;IAC3B,sBAAsB,EAAE,IAAI;CACpB,CAAC;AAEX,IAAM,WAAW,GAAG;IAClB,MAAM,EAAE,eAAO;IACf,YAAY,EAAE,sBAAc;IAC5B,MAAM,EAAE,CAAC,WAAW,CAAQ;IAC5B,UAAU,EAAE,gCAAkB;IAC9B,MAAM,EAAE,eAAO;IACf,MAAM,EAAE;QACN,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;QACd,KAAK,EAAE,yBAAW,CAAC,KAAK;KACzB;IACD,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,IAAI,yDAAoB,EAAE;IAC1C,MAAM,EAAE,iBAAiB;CACjB,CAAC;AAEX,2CAA2C;AAC3C,UAAU,CAAC;IACT,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;IAClC,WAAmB,CAAC,cAAc,GAAG,IAAI,yDAAoB,EAAE,CAAC;AACnE,CAAC,CAAC,CAAC;AAEH,SAAgB,UAAU,CAIxB,EAEC;IAFD,mBAAA,EAAA,KAAwD,EAEvD;IAFA,IAAA,MAAM,YAAA,EAAK,SAAS,sBAArB,UAAsB,CAAD;IAIrB,OAAO,uDACF,WAAW,GACX,SAAS,KACZ,MAAM,wCACD,WAAW,CAAC,MAAM,GACjB,SAAoC,CAAC,MAAM,GAEjD,MAAM,wCACD,WAAW,CAAC,MAAM,GAClB,MAAM,IAEL,CAAC;AACX,CAAC;AApBD,gCAoBC"}

package/build/ts/server/authenticate/admin/authenticate.d.ts

@@ -1,28 +1,11 @@
-import { Shopify, ShopifyRestResources } from '@shopify/shopify-api';
+import { ShopifyRestResources } from '@shopify/shopify-api';
 import type { BasicParams } from '../../types';
-import type { AppConfig, AppConfigArg } from '../../config-types';
-import type { AdminContext } from './types';
-export declare class AuthStrategy<Config extends AppConfigArg, Resources extends ShopifyRestResources = ShopifyRestResources> {
-    protected api: Shopify;
-    protected config: AppConfig;
-    protected logger: Shopify['logger'];
-    constructor({ api, config, logger }: BasicParams);
-    authenticateAdmin(request: Request): Promise<AdminContext<Config, Resources>>;
-    private authenticateAndGetSessionContext;
-    private handleAuthBeginRequest;
-    private handleAuthCallbackRequest;
-    private validateUrlParams;
-    private ensureInstalledOnShop;
-    private testSession;
-    private ensureValidShopParam;
-    private ensureAppIsEmbeddedIfRequired;
-    private ensureSessionTokenSearchParamIfRequired;
-    private ensureSessionExists;
-    private validateAuthenticatedSession;
-    private loadSession;
-    private redirectToShopifyOrAppRoot;
-    private redirectToBouncePage;
-    private createBillingContext;
-    private createAdminApiContext;
+import type { AppConfigArg } from '../../config-types';
+import type { AuthenticateAdmin } from './types';
+import { AuthorizationStrategy } from './strategies/types';
+interface AuthStrategyParams extends BasicParams {
+    strategy: AuthorizationStrategy;
 }
+export declare function authStrategyFactory<ConfigArg extends AppConfigArg, Resources extends ShopifyRestResources = ShopifyRestResources>({ strategy, ...params }: AuthStrategyParams): AuthenticateAdmin<ConfigArg, Resources>;
+export {};
 //# sourceMappingURL=authenticate.d.ts.map

package/build/ts/server/authenticate/admin/authenticate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"authenticate.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/admin/authenticate.ts"],"names":[],"mappings":"AACA,OAAO,EAQL,OAAO,EACP,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAC,SAAS,EAAE,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAehE,OAAO,KAAK,EACV,YAAY,EAGb,MAAM,SAAS,CAAC;AAiBjB,qBAAa,YAAY,CACvB,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB;IAE7D,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC;IAC5B,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAEjB,EAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAC,EAAE,WAAW;IAMxC,iBAAiB,CAC5B,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAuC7B,gCAAgC;YA8ChC,sBAAsB;YAqBtB,yBAAyB;YAsDzB,iBAAiB;YAuBjB,qBAAqB;YAqFrB,WAAW;IAkBzB,OAAO,CAAC,oBAAoB;YAcd,6BAA6B;YAY7B,uCAAuC;YAgBvC,mBAAmB;YAsCnB,4BAA4B;YAoB5B,WAAW;YAwBX,0BAA0B;IAiBxC,OAAO,CAAC,oBAAoB;IAgB5B,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,qBAAqB;CAgB9B"}
+{"version":3,"file":"authenticate.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/admin/authenticate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE/E,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAerD,OAAO,KAAK,EAEV,iBAAiB,EAGlB,MAAM,SAAS,CAAC;AASjB,OAAO,EAAC,qBAAqB,EAAsB,MAAM,oBAAoB,CAAC;AAE9E,UAAU,kBAAmB,SAAQ,WAAW;IAC9C,QAAQ,EAAE,qBAAqB,CAAC;CACjC;AAED,wBAAgB,mBAAmB,CACjC,SAAS,SAAS,YAAY,EAC9B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,EAC7D,EACA,QAAQ,EACR,GAAG,MAAM,EACV,EAAE,kBAAkB,GAAG,iBAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,CAwG9D"}