@weareconceptstudio/account 2.1.12 → 2.1.14

package/package.json

@@ -1,28 +1,51 @@
 {
 	"name": "@weareconceptstudio/account",
-	"version": "2.1.12",
+	"version": "2.1.14",
 	"description": "Concept Studio Account",
 	"author": "Concept Studio",
 	"license": "ISC",
 	"main": "dist/index.js",
-	"sideEffects": false,
+	"sideEffects": [
+		"**/AccountProvider.js",
+		"**/user/UserProvider.js"
+	],
+	"bin": {
+		"account-init": "./cli/init-config.js"
+	},
 	"files": [
-		"dist"
+		"dist",
+		"cli",
+		"templates"
 	],
 	"exports": {
 		".": {
 			"types": "./dist/index.d.ts",
 			"default": "./dist/index.js"
+		},
+		"./config": {
+			"types": "./dist/config.d.ts",
+			"default": "./dist/config.js"
+		},
+		"./server": {
+			"types": "./dist/server.d.ts",
+			"default": "./dist/server.js"
+		},
+		"./user": {
+			"types": "./dist/user/index.d.ts",
+			"default": "./dist/user/index.js"
 		}
 	},
 	"scripts": {
 		"build": "tsc -m es6",
-		"watch": "tsc -m es6 --watch"
+		"watch": "tsc -m es6 --watch",
+		"init-config": "node ./cli/init-config.js",
+		"test:user-integration": "npm run build && node ./cli/test-user-integration.mjs",
+		"postinstall": "node ./cli/postinstall.js"
 	},
 	"dependencies": {
-		"@weareconceptstudio/cart": "^0.0.18",
-		"@weareconceptstudio/core": "^0.4.13",
-		"@weareconceptstudio/form": "^0.5.12",
+		"@weareconceptstudio/cart": "^0.0.19",
+		"@weareconceptstudio/core": "^0.4.14",
+		"@weareconceptstudio/form": "^0.5.13",
 		"react-helmet": "6.1.0",
 		"payment": "2.4.6"
 	},

package/templates/README.md

@@ -0,0 +1,41 @@
+# Account package config examples
+
+Generated by `npx account-init` from `@weareconceptstudio/account`.
+
+## Files
+
+| File | Purpose |
+|------|---------|
+| `routes.config.ts` | Auth + private customer routes |
+| `integrations.config.ts` | API endpoints (account, cart, checkout, order) |
+| `user.config.ts` | `UserProvider` props (`userIntegration`, hooks) |
+| `account.config.ts` | `AccountProvider` overrides (`globalSettings`, cart, checkout, …) |
+| `address.config.ts` | Address form field definitions |
+| `index.ts` | Barrel export |
+
+## Layout usage (Next.js)
+
+```tsx
+import { AccountProvider, UserProvider, useUser } from '@weareconceptstudio/account';
+import { accountProviderConfig } from '@/config/account/account.config';
+import { userProviderConfig } from '@/config/account/user.config';
+import { integrationsConfig } from '@/config/account/integrations.config';
+
+<UserProvider {...userProviderConfig} initialUser={userData.newState}>
+  <AccountProvider
+    {...accountProviderConfig}
+    useUser={useUser}
+    orderIntegration={integrationsConfig.order}
+  />
+</UserProvider>
+```
+
+## Custom user methods (e.g. `toggleSubscribe`)
+
+Define in a client component wrapper or pass `createMethods` when supported — methods that call `setState` cannot live in static config files.
+
+## Re-run
+
+```bash
+npx account-init --out src/config/account --all --force
+```

package/templates/account.config.example.ts

@@ -0,0 +1,77 @@
+/**
+ * AccountProvider overrides — merged with package defaults in @weareconceptstudio/account.
+ *
+ * Import createAccountButtonEntry from '@weareconceptstudio/account/config'
+ * and pass your project Button component in layout or here.
+ */
+import type { UserIntegrationConfig } from '@weareconceptstudio/account';
+
+export const accountProviderConfig = {
+	currency: 'USD',
+	fontFamily: 'core_Font',
+	shopUrl: '/',
+	productUrlPrefix: '/products/',
+
+	auth: {
+		social: {
+			google: true,
+		},
+	},
+
+	globalSettings: {
+		hasShippingCost: true,
+		hasAddresses: true,
+		hasAddressType: false,
+		supportsGuestCart: true,
+		allowGuestCheckout: true,
+		hasBalanceSystem: false,
+		hasVoucherSystem: false,
+		hasPromoCodeSystem: false,
+		hasGiftSystem: false,
+		hasUtensilsSystem: false,
+		hasFreeShippingSystem: false,
+		hasCommentSystem: false,
+		hasSubscriptionSystem: false,
+		hasSubtotal: true,
+	},
+
+	order: {
+		hasReorder: true,
+		hasReview: true,
+		hasQty: true,
+		hasSubtotal: true,
+	},
+
+	cart: {
+		showShopLinks: true,
+		item: {
+			edit: { item: false, list: false, mode: 'url' as const },
+			remove: true,
+		},
+	},
+
+	checkout: {
+		abandonPaymentEndpoint: null,
+		hideInternalPayment: false,
+		paymentPlacement: 'review' as const,
+	},
+
+	/** Same shape as UserProvider userIntegration — optional duplicate for reference */
+	userIntegration: null as UserIntegrationConfig | null,
+
+	/**
+	 * button: {
+	 *   auth: createAccountButtonEntry(Button, 'auth', { btnType: 'primary' }),
+	 *   form: createAccountButtonEntry(Button, 'form', { btnType: 'primary' }),
+	 *   checkout: createAccountButtonEntry(Button, 'checkout', { btnType: 'primary' }),
+	 * },
+	 */
+	button: {},
+
+	/** import { addressFormFields } from './address.config' */
+	addressFormFields: null,
+	addressFormFieldsShipping: null,
+	addressFormFieldsBilling: null,
+};
+
+export type AccountProviderConfig = typeof accountProviderConfig;

package/templates/address.config.example.ts

@@ -0,0 +1,55 @@
+/**
+ * FormBuilder field configs for AddressProvider / account address screens.
+ * Pass to AccountProvider as addressFormFields (and optionally shipping/billing variants).
+ *
+ * @see https://github.com/weareconceptstudio/cs-dev-hub — form package field schema
+ */
+export const addressFormFields = [
+	{
+		fieldType: 'input',
+		labelProps: {
+			label: 'account.address_management.firstName',
+			name: 'first_name',
+		},
+		fieldProps: {
+			placeholder: 'account.address_management.firstNamePlaceholder',
+		},
+		rules: [{ required: true }],
+	},
+	{
+		fieldType: 'input',
+		labelProps: {
+			label: 'account.address_management.lastName',
+			name: 'last_name',
+		},
+		fieldProps: {
+			placeholder: 'account.address_management.lastNamePlaceholder',
+		},
+		rules: [{ required: true }],
+	},
+	{
+		fieldType: 'input',
+		labelProps: {
+			label: 'account.address_management.phone',
+			name: 'phone',
+		},
+		fieldProps: {
+			placeholder: 'account.address_management.phonePlaceholder',
+		},
+	},
+	{
+		fieldType: 'input',
+		labelProps: {
+			label: 'account.address_management.address',
+			name: 'address',
+		},
+		fieldProps: {
+			placeholder: 'account.address_management.addressPlaceholder',
+		},
+		rules: [{ required: true }],
+	},
+];
+
+/** Use when shipping and billing need different fields */
+export const addressFormFieldsShipping = null;
+export const addressFormFieldsBilling = null;

package/templates/index.example.ts

@@ -0,0 +1,24 @@
+/**
+ * Barrel file — re-export account config modules for your app.
+ * Generated by: npx account-init
+ */
+export { routesConfig } from './routes.config';
+export { integrationsConfig } from './integrations.config';
+export { userProviderConfig } from './user.config';
+export { accountProviderConfig } from './account.config';
+export {
+	addressFormFields,
+	addressFormFieldsShipping,
+	addressFormFieldsBilling,
+} from './address.config';
+
+import { routesConfig } from './routes.config';
+import { integrationsConfig } from './integrations.config';
+
+/** Full app config shape — extend with your site-specific routes */
+const config = {
+	routes: routesConfig,
+	integrations: integrationsConfig,
+};
+
+export default config;

package/templates/integrations.config.example.ts

@@ -0,0 +1,28 @@
+/**
+ * API endpoint map for account, cart, checkout, and orders.
+ * Wire the same values into UserProvider userIntegration where applicable.
+ */
+export const integrationsConfig = {
+	account: {
+		currentUserEndpoint: 'current-user',
+		updateAccountEndpoint: 'update-account',
+		updatePasswordEndpoint: 'update-password',
+		logoutEndpoint: 'logout',
+	},
+	cart: {
+		getCartEndpoint: 'cart',
+		addItemEndpoint: 'toggle-cart-item',
+		removeItemEndpoint: 'delete-cart-item',
+		clearCartEndpoint: 'clear-cart',
+	},
+	checkout: {
+		checkoutEndpoint: 'checkout',
+	},
+	order: {
+		getOrdersEndpoint: 'orders',
+		getOrderEndpoint: 'orders',
+		reviewOrderEndpoint: 'order-review',
+	},
+};
+
+export type IntegrationsConfig = typeof integrationsConfig;

package/templates/routes.config.example.ts

@@ -0,0 +1,56 @@
+/**
+ * App routes used by UserProvider guards and account navigation.
+ * Copy to your project and adjust paths / private flags.
+ */
+export const routesConfig = {
+	home: {
+		path: '/',
+		name: 'pages.home.name',
+	},
+
+	// ======================== Auth ======================== //
+	signIn: {
+		path: '/sign-in/',
+		name: 'pages.signIn.name',
+	},
+	signUp: {
+		path: '/sign-up/',
+		name: 'pages.signUp.name',
+	},
+	forgotPassword: {
+		path: '/forgot-password/',
+		name: 'pages.forgotPassword.name',
+	},
+	resetPassword: {
+		path: '/reset-password/',
+		name: 'pages.resetPassword.name',
+	},
+
+	// ======================== Customer (private) ======================== //
+	account: {
+		path: '/account/',
+		name: 'account',
+		private: true,
+	},
+	accountAddresses: {
+		path: '/account/addresses/',
+		name: 'addresses',
+		private: true,
+	},
+	orderHistory: {
+		path: '/account/order-history/',
+		name: 'orderHistory',
+		private: true,
+	},
+	cart: {
+		path: '/cart/',
+		name: 'cart',
+	},
+	checkout: {
+		path: '/checkout/',
+		name: 'checkout',
+		private: true,
+	},
+};
+
+export type RoutesConfig = typeof routesConfig;

package/templates/user.config.example.ts

@@ -0,0 +1,45 @@
+import type { UserIntegrationConfig, UserProviderHooks } from '@weareconceptstudio/account';
+import { integrationsConfig } from './integrations.config';
+import { routesConfig } from './routes.config';
+
+/**
+ * Props for <UserProvider /> from @weareconceptstudio/account
+ */
+export const userProviderConfig = {
+	routes: routesConfig,
+	userIntegration: {
+		endpoints: {
+			login: 'login',
+			register: 'register',
+			logout: integrationsConfig.account.logoutEndpoint,
+			forgotPassword: 'forgot-password',
+			resetPassword: 'reset-password',
+			checkPasswordToken: 'check-password-token',
+			currentUser: integrationsConfig.account.currentUserEndpoint,
+			updateAccount: integrationsConfig.account.updateAccountEndpoint,
+			updatePassword: integrationsConfig.account.updatePasswordEndpoint,
+		},
+		cookieKey: 'accessToken',
+		postAuthRedirectRouteKey: 'account',
+		signOutRedirectRouteKey: 'home',
+		useFullPageReloadOnAuth: false,
+		defaultLocale: process.env.NEXT_PUBLIC_DEFAULT_LOCALE || 'en',
+		socialRedirectCookieKey: 'socialRedirectUrl',
+	} satisfies UserIntegrationConfig,
+
+	/** Optional project-specific auth hooks */
+	hooks: {
+		// formatPrevRoute: (pathname, lang) => `/${lang}${pathname}`,
+		// mapSignUpUser: (user, response) => user,
+	} satisfies UserProviderHooks,
+
+	/**
+	 * Optional extra methods (e.g. toggleSubscribe, custom API actions).
+	 * For methods that need setState, use createMethods in layout — see README.
+	 */
+	methods: {},
+
+	methodOverrides: {},
+};
+
+export type UserProviderConfig = typeof userProviderConfig;