@strivacity/sdk-next 3.0.3 → 4.0.0-beta.0

package/dist/types.d.ts

@@ -1,176 +1,2 @@
-import { IdTokenClaims, LoginFlowMessage, LoginFlowState, SDKOptions } from '@strivacity/sdk-core';
-import { PopupFlow } from '@strivacity/sdk-core/flows/PopupFlow';
-import { RedirectFlow } from '@strivacity/sdk-core/flows/RedirectFlow';
-import { NativeFlow } from '@strivacity/sdk-core/flows/NativeFlow';
-export type Children = React.ReactElement | React.ReactNode | Array<React.ReactElement | React.ReactNode>;
-/**
- * Represents the session state, including authentication details and token information.
- */
-export type Session = {
-    /**
-     * Indicates if the session is being loaded.
-     */
-    loading: boolean;
-    /**
-     * The SDK options used to configure the session.
-     */
-    options: SDKOptions;
-    /**
-     * Indicates whether the user is authenticated.
-     */
-    isAuthenticated: boolean;
-    /**
-     * Claims from the ID token or `null` if not available.
-     */
-    idTokenClaims: IdTokenClaims | null;
-    /**
-     * The access token or `null` if not available.
-     */
-    accessToken: string | null;
-    /**
-     * The refresh token or `null` if not available.
-     */
-    refreshToken: string | null;
-    /**
-     * Indicates if the access token has expired.
-     */
-    accessTokenExpired: boolean;
-    /**
-     * Expiration date of the access token or `null` if not set.
-     */
-    accessTokenExpirationDate: number | null;
-};
-/**
- * Represents the available authentication flows and operations for Popup-based interactions.
- */
-export type PopupSDK = {
-    /**
-     * Represents the SDK instance.
-     */
-    sdk: InstanceType<typeof PopupFlow>;
-    /**
-     * Initiates the login process.
-     */
-    login: InstanceType<typeof PopupFlow>['login'];
-    /**
-     * Registers a new user.
-     */
-    register: InstanceType<typeof PopupFlow>['register'];
-    /**
-     * Initiates the entry process.
-     */
-    entry: InstanceType<typeof PopupFlow>['entry'];
-    /**
-     * Refreshes the user's session.
-     */
-    refresh: InstanceType<typeof PopupFlow>['refresh'];
-    /**
-     * Revokes the current session tokens.
-     */
-    revoke: InstanceType<typeof PopupFlow>['revoke'];
-    /**
-     * Logs out the user.
-     */
-    logout: InstanceType<typeof PopupFlow>['logout'];
-    /**
-     * Handles the callback after authentication or token exchange.
-     */
-    handleCallback: InstanceType<typeof PopupFlow>['handleCallback'];
-};
-/**
- * Represents the available authentication flows and operations for Redirect-based interactions.
- */
-export type RedirectSDK = {
-    /**
-     * Represents the SDK instance.
-     */
-    sdk: InstanceType<typeof RedirectFlow>;
-    /**
-     * Initiates the login process.
-     */
-    login: InstanceType<typeof RedirectFlow>['login'];
-    /**
-     * Registers a new user.
-     */
-    register: InstanceType<typeof RedirectFlow>['register'];
-    /**
-     * Initiates the entry process.
-     */
-    entry: InstanceType<typeof RedirectFlow>['entry'];
-    /**
-     * Refreshes the user's session.
-     */
-    refresh: InstanceType<typeof RedirectFlow>['refresh'];
-    /**
-     * Revokes the current session tokens.
-     */
-    revoke: InstanceType<typeof RedirectFlow>['revoke'];
-    /**
-     * Logs out the user.
-     */
-    logout: InstanceType<typeof RedirectFlow>['logout'];
-    /**
-     * Handles the callback after authentication or token exchange.
-     */
-    handleCallback: InstanceType<typeof RedirectFlow>['handleCallback'];
-};
-/**
- * Represents the available authentication flows and operations for Native-based interactions.
- */
-export type NativeSDK = {
-    /**
-     * Represents the SDK instance.
-     */
-    sdk: InstanceType<typeof NativeFlow>;
-    /**
-     * Initiates the login process.
-     */
-    login: InstanceType<typeof NativeFlow>['login'];
-    /**
-     * Registers a new user.
-     */
-    register: InstanceType<typeof NativeFlow>['register'];
-    /**
-     * Initiates the entry process.
-     */
-    entry: InstanceType<typeof NativeFlow>['entry'];
-    /**
-     * Refreshes the user's session.
-     */
-    refresh: InstanceType<typeof NativeFlow>['refresh'];
-    /**
-     * Revokes the current session tokens.
-     */
-    revoke: InstanceType<typeof NativeFlow>['revoke'];
-    /**
-     * Logs out the user.
-     */
-    logout: InstanceType<typeof NativeFlow>['logout'];
-    /**
-     * Handles the callback after authentication or token exchange.
-     */
-    handleCallback: InstanceType<typeof NativeFlow>['handleCallback'];
-};
-/**
- * Represents a combined context for Popup-based flows, containing both the Popup SDK and the session state.
- */
-export type PopupContext = PopupSDK & Session;
-/**
- * Represents a combined context for Redirect-based flows, containing both the Redirect SDK and the session state.
- */
-export type RedirectContext = RedirectSDK & Session;
-/**
- * Represents a combined context for Native-based flows, containing both the Native SDK and the session state.
- */
-export type NativeContext = NativeSDK & Session;
-export type NativeFlowContextValue = {
-    loading: boolean;
-    forms: Record<string, Record<string, unknown>>;
-    messages: Record<string, Record<string, LoginFlowMessage>>;
-    state: Partial<LoginFlowState>;
-    submitForm: (formId: string) => Promise<void>;
-    triggerFallback: (hostedUrl?: string) => void;
-    triggerClose: () => void;
-    setFormValue: (formId: string, widgetId: string, value: unknown) => void;
-    setMessage: (formId: string, widgetId: string, value: LoginFlowMessage) => void;
-};
+export * from './client/types';
+export * from './server/types';

package/dist/types.mjs

@@ -1,2 +1 @@
-
-//# sourceMappingURL=types.mjs.map
+import"./client/types.mjs";import"./server/types.mjs";export*from"@strivacity/sdk-react/types";export*from"@strivacity/sdk-core/types";

package/package.json

@@ -1,27 +1,65 @@
 {
   "name": "@strivacity/sdk-next",
-  "version": "3.0.3",
-  "license": "MIT",
+  "version": "4.0.0-beta.0",
   "description": "Strivacity Next.js SDK client",
+  "license": "MIT",
   "author": "strivacity <opensource@strivacity.com>",
   "repository": {
     "type": "git",
     "url": "https://github.com/Strivacity/sdk-js"
   },
-  "dependencies": {
-    "@strivacity/sdk-core": "3.0.3"
-  },
-  "peerDependencies": {
-    "next": ">=13"
-  },
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "main": "./dist/client.cjs",
+  "types": "./dist/types.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs",
       "default": "./dist/index.mjs"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.mjs",
+      "require": "./dist/client/index.cjs",
+      "default": "./dist/client/index.mjs"
+    },
+    "./client/*": {
+      "types": "./dist/client/*.d.ts",
+      "import": "./dist/client/*.mjs",
+      "require": "./dist/client/*.cjs",
+      "default": "./dist/client/*.mjs"
+    },
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "import": "./dist/server/index.mjs",
+      "require": "./dist/server/index.cjs",
+      "default": "./dist/server/index.mjs"
+    },
+    "./server/*": {
+      "types": "./dist/server/*.d.ts",
+      "import": "./dist/server/*.mjs",
+      "require": "./dist/server/*.cjs",
+      "default": "./dist/server/*.mjs"
+    },
+    "./errors": {
+      "types": "./dist/errors.d.ts",
+      "import": "./dist/errors.mjs",
+      "require": "./dist/errors.cjs",
+      "default": "./dist/errors.mjs"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.mjs",
+      "require": "./dist/types.cjs",
+      "default": "./dist/types.mjs"
     }
+  },
+  "dependencies": {
+    "@strivacity/sdk-core": "4.0.0-beta.0",
+    "@strivacity/sdk-react": "4.0.0-beta.0"
+  },
+  "peerDependencies": {
+    "next": ">=15"
   }
 }

package/testing/tests/client/components.spec.ts

@@ -0,0 +1,10 @@
+import { test, expect } from 'vitest';
+import * as nextComponents from '../../../src/client/components';
+import * as reactComponents from '@strivacity/sdk-react/components';
+
+test('re-exports components from the react sdk', () => {
+	const reactKeys = Object.keys(reactComponents);
+
+	expect(reactKeys.length).toBeGreaterThan(0);
+	expect(Object.keys(nextComponents).sort()).toEqual(reactKeys.sort());
+});

package/testing/tests/client/hooks.spec.ts

@@ -0,0 +1,10 @@
+import { test, expect } from 'vitest';
+import * as nextHooks from '../../../src/client/hooks';
+import * as reactHooks from '@strivacity/sdk-react/hooks';
+
+test('re-exports hooks from the react sdk', () => {
+	const reactKeys = Object.keys(reactHooks);
+
+	expect(reactKeys.length).toBeGreaterThan(0);
+	expect(Object.keys(nextHooks).sort()).toEqual(reactKeys.sort());
+});

package/testing/tests/client/index.spec.ts

@@ -0,0 +1,106 @@
+import { test, expect } from 'vitest';
+import * as clientIndex from '../../../src/client/index';
+
+test('should export the correct things', () => {
+	const expectedExports = [
+		'AlgorithmTypeList',
+		'BACKCHANNEL_LOGOUT_EVENT',
+		'COOKIE_CHUNK_SIZE',
+		'COOKIE_CONTEXT',
+		'ConfigurationError',
+		'DEFAULT_COOKIE_MAX_AGE',
+		'DISALLOWED_PROXY_HEADERS',
+		'FallbackError',
+		'GrantTypeList',
+		'InternalError',
+		'NetworkError',
+		'OidcError',
+		'PopupBlockedError',
+		'PopupClosedError',
+		'ProtocolError',
+		'RETURN_TO_COOKIE',
+		'ResponseModeList',
+		'ResponseTypeList',
+		'STRIVACITY_SDK',
+		'ServerError',
+		'SessionExpiredError',
+		'StyAuthProvider',
+		'SubjectTypeList',
+		'TokenEndpointAuthMethodList',
+		'UnsupportedFlowError',
+		'assertWebAuthnCredential',
+		'buildAuthorizationUrl',
+		'buildCookieString',
+		'buildEndSessionUrl',
+		'createBaseFlow',
+		'createCacheAPIStorage',
+		'createDefaultLogging',
+		'createEmbeddedFlow',
+		'createEncryptedCookieStorage',
+		'createHttpClient',
+		'createIndexedDBStorage',
+		'createLocalStorage',
+		'createMemoryStorage',
+		'createNativeFlow',
+		'createPopupFlow',
+		'createRedirectFlow',
+		'createServerMemoryStorage',
+		'createServerStateStorage',
+		'createSession',
+		'createSessionIdCookieStorage',
+		'createSessionStorage',
+		'createState',
+		'createWebAuthnCredential',
+		'createWorkerStorage',
+		'decodeBase64URL',
+		'decodeJwt',
+		'decryptString',
+		'defaultOptions',
+		'encodeBase64URL',
+		'encryptString',
+		'exchangeCode',
+		'fetchFlowEntry',
+		'finalizeLoginSession',
+		'flushSetCookies',
+		'generateCodeChallenge',
+		'generateCodeVerifier',
+		'generateJwt',
+		'generateRandomHex',
+		'getDefaultFlowState',
+		'getDiscoveryDocument',
+		'getSDKOptions',
+		'getServerSDKOptions',
+		'handleWorkerStorageRequests',
+		'injectScript',
+		'isSessionExpired',
+		'loadSession',
+		'parseCookieHeader',
+		'parseState',
+		'popupCallbackHandler',
+		'popupUrlHandler',
+		'proxyResponse',
+		'pushSetCookie',
+		'redirectCallbackHandler',
+		'redirectUrlHandler',
+		'refreshToken',
+		'revokeToken',
+		'serializeCookie',
+		'serializeSession',
+		'serializeState',
+		'submitLoginForm',
+		'throwHttpError',
+		'throwTokenEndpointError',
+		'timestamp',
+		'toSafeRedirect',
+		'unflattenObject',
+		'useNativeLogin',
+		'useNativeLoginContext',
+		'useStrivacity',
+		'verifyIdToken',
+		'verifyJwt',
+		'withAuthGuard',
+	];
+
+	expect(Object.keys(clientIndex)).toHaveLength(expectedExports.length);
+	expect(Object.keys(clientIndex).sort()).toEqual(expectedExports.sort());
+});

package/testing/tests/client/storages.spec.ts

@@ -0,0 +1,10 @@
+import { test, expect } from 'vitest';
+import * as nextStorages from '../../../src/client/storages';
+import * as reactStorages from '@strivacity/sdk-react/storages';
+
+test('re-exports storages from the react sdk', () => {
+	const reactKeys = Object.keys(reactStorages);
+
+	expect(reactKeys.length).toBeGreaterThan(0);
+	expect(Object.keys(nextStorages).sort()).toEqual(reactKeys.sort());
+});

package/testing/tests/client/utils.spec.ts

@@ -0,0 +1,10 @@
+import { test, expect } from 'vitest';
+import * as nextUtils from '../../../src/client/utils';
+import * as reactUtils from '@strivacity/sdk-react/utils';
+
+test('re-exports utilities from the react sdk', () => {
+	const reactKeys = Object.keys(reactUtils);
+
+	expect(reactKeys.length).toBeGreaterThan(0);
+	expect(Object.keys(nextUtils).sort()).toEqual(reactKeys.sort());
+});

package/testing/tests/server/handlers/api.spec.ts

@@ -0,0 +1,110 @@
+import type { Mock } from 'vitest';
+import { describe, test, expect, vi } from 'vitest';
+import { NextRequest, NextResponse } from 'next/server';
+import { createMockBaseServerSDK } from '@strivacity/testing/mocks/sdk';
+import { apiAppRouteHandlerFactory, apiPageRouteHandlerFactory } from '../../../../src/server/handlers/api';
+import type { BaseServerSDK, PagesRouterRequest } from '../../../../src/server/types';
+
+describe('apiAppRouteHandlerFactory', () => {
+	test('returns a 401 response and does not call the route when there is no session', async () => {
+		const sdk = createMockBaseServerSDK<BaseServerSDK<NextRequest | Request | PagesRouterRequest | undefined>>();
+		const apiRoute = vi.fn();
+		const handler = apiAppRouteHandlerFactory(sdk)(apiRoute);
+
+		const response = await handler(new NextRequest('https://brandtegrity.io/api/secret'), {});
+
+		expect(response.status).toBe(401);
+		await expect(response.json()).resolves.toEqual({
+			error: 'not_authenticated',
+			description: 'The user does not have an active session or is not authenticated',
+		});
+		expect(apiRoute).not.toHaveBeenCalled();
+	});
+
+	test('calls the route with the request and params when there is a session', async () => {
+		const sdk = createMockBaseServerSDK<BaseServerSDK<NextRequest | Request | PagesRouterRequest | undefined>>({ getSession: vi.fn().mockResolvedValue({}) });
+		const apiRoute = vi.fn().mockResolvedValue(NextResponse.json({ ok: true }));
+		const handler = apiAppRouteHandlerFactory(sdk)(apiRoute);
+		const req = new NextRequest('https://brandtegrity.io/api/secret');
+		const params = { params: Promise.resolve({ id: '1' }) };
+
+		await handler(req, params);
+
+		expect(apiRoute).toHaveBeenCalledWith(req, params);
+		expect(sdk.getSession).toHaveBeenCalledWith(req);
+	});
+
+	test('returns the route NextResponse unchanged', async () => {
+		const sdk = createMockBaseServerSDK<BaseServerSDK<NextRequest | Request | PagesRouterRequest | undefined>>({ getSession: vi.fn().mockResolvedValue({}) });
+		const routeResponse = NextResponse.json({ ok: true });
+		const apiRoute = vi.fn().mockResolvedValue(routeResponse);
+		const handler = apiAppRouteHandlerFactory(sdk)(apiRoute);
+
+		const response = await handler(new NextRequest('https://brandtegrity.io/api/secret'), {});
+
+		expect(response).toBe(routeResponse);
+	});
+
+	test('wraps a plain Response returned by the route into a NextResponse', async () => {
+		const sdk = createMockBaseServerSDK<BaseServerSDK<NextRequest | Request | PagesRouterRequest | undefined>>({ getSession: vi.fn().mockResolvedValue({}) });
+		const apiRoute = vi.fn().mockResolvedValue(new Response('plain body', { status: 201, headers: { 'x-custom': 'yes' } }));
+		const handler = apiAppRouteHandlerFactory(sdk)(apiRoute);
+
+		const response = await handler(new NextRequest('https://brandtegrity.io/api/secret'), {});
+
+		expect(response).toBeInstanceOf(NextResponse);
+		expect(response.status).toBe(201);
+		expect(response.headers.get('x-custom')).toBe('yes');
+		await expect(response.text()).resolves.toBe('plain body');
+	});
+
+	test('converts a plain Request to a NextRequest before checking the session and calling the route', async () => {
+		const sdk = createMockBaseServerSDK<BaseServerSDK<NextRequest | Request | PagesRouterRequest | undefined>>({ getSession: vi.fn().mockResolvedValue({}) });
+		const apiRoute = vi.fn().mockResolvedValue(NextResponse.json({ ok: true }));
+		const handler = apiAppRouteHandlerFactory(sdk)(apiRoute);
+		const req = new Request('https://brandtegrity.io/api/secret');
+
+		await handler(req, {});
+
+		const usedRequest = (sdk.getSession as Mock).mock.calls[0][0] as NextRequest;
+		expect(usedRequest).toBeInstanceOf(NextRequest);
+		expect(usedRequest.url).toBe(req.url);
+		expect(apiRoute).toHaveBeenCalledWith(usedRequest, {});
+	});
+});
+
+describe('apiPageRouteHandlerFactory', () => {
+	function createFakeRes() {
+		const json = vi.fn();
+		const status = vi.fn().mockReturnValue({ json });
+
+		return { status, json };
+	}
+
+	test('responds with 401 and does not call the route when there is no session', async () => {
+		const sdk = createMockBaseServerSDK<BaseServerSDK<NextRequest | Request | PagesRouterRequest | undefined>>();
+		const apiRoute = vi.fn();
+		const handler = apiPageRouteHandlerFactory(sdk)(apiRoute);
+		const req = {} as PagesRouterRequest;
+		const res = createFakeRes();
+
+		await handler(req, res as never);
+
+		expect(res.status).toHaveBeenCalledWith(401);
+		expect(res.json).toHaveBeenCalledWith({ error: 'not_authenticated', description: 'The user does not have an active session or is not authenticated' });
+		expect(apiRoute).not.toHaveBeenCalled();
+	});
+
+	test('calls the route with the request and response when there is a session', async () => {
+		const sdk = createMockBaseServerSDK<BaseServerSDK<NextRequest | Request | PagesRouterRequest | undefined>>({ getSession: vi.fn().mockResolvedValue({}) });
+		const apiRoute = vi.fn();
+		const handler = apiPageRouteHandlerFactory(sdk)(apiRoute);
+		const req = {} as PagesRouterRequest;
+		const res = createFakeRes();
+
+		await handler(req, res as never);
+
+		expect(apiRoute).toHaveBeenCalledWith(req, res);
+		expect(res.status).not.toHaveBeenCalled();
+	});
+});