@aglyn/plugins-commerce 1.0.0-beta.218 → 1.0.0-beta.220

package/src/lib/starter-templates.js

@@ -0,0 +1,157 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ import { buildStarterNodes, starterHeroSection, starterSection, starterText } from "@aglyn/aglyn/app-utils/starter-template-nodes";
+import { SCREEN_ROOT_PATH } from "@aglyn/aglyn/app-utils/screen-route";
+import { BUNDLE_ID } from "./constants/bundle-common.js";
+/**
+ * The shop starters (AGL-300): storefront sites built around this plugin's
+ * elements — the product grid, the product page, the cart and the customer
+ * account.
+ *
+ * Declared under `starterTemplates` in plugins.config.json; the manifest
+ * generator calls {@link commerceStarterTemplates} and compiles what it
+ * returns into core's `plugin-starter-templates.generated.ts`, after the
+ * platform's own starters. The gallery, the seed route and the AI plugin's
+ * examples read that list, so none of them loads this plugin to offer a shop.
+ *
+ * PERSISTED IDENTIFIERS: the starter ids, the screen keys and every node id
+ * below appear in stored documents — seeded template ids are derived from
+ * the first two — so none is ever renamed.
+ */ /** One of this plugin's elements, placed on a starter page. */ const commerceBlock = (id, componentId, props)=>({
+        id,
+        componentId,
+        pluginId: BUNDLE_ID,
+        props
+    });
+/** The pages both shop starters share. */ function shopScreens(prefix, digital) {
+    return [
+        {
+            key: 'home',
+            displayName: 'Home',
+            // The site root, spelled the way the routing map spells it. `''` here
+            // read as "no address" everywhere downstream and put the shop's home
+            // page at `/home` (AGL-1575).
+            slug: SCREEN_ROOT_PATH,
+            seo: {
+                title: digital ? 'Digital shop' : 'Shop',
+                description: 'Browse our products.'
+            },
+            nodes: buildStarterNodes([
+                starterHeroSection(`${prefix}h_`, digital ? 'Downloads that level you up' : 'Gear you can trust', digital ? 'Instant delivery. Lifetime updates.' : 'Quality parts, shipped fast.'),
+                starterSection(`${prefix}h_gridSection`, 'xl', 6, [
+                    commerceBlock(`${prefix}h_grid`, 'product-grid', {
+                        source: 'all',
+                        sort: 'newest',
+                        columns: 3,
+                        maxItems: 6
+                    })
+                ]),
+                // A newsletter capture is a short text-led band, not a gallery.
+                starterSection(`${prefix}h_newsSection`, 'md', 6, [
+                    commerceBlock(`${prefix}h_news`, 'newsletter-signup', {
+                        heading: 'Get updates and offers'
+                    })
+                ])
+            ])
+        },
+        {
+            key: 'shop',
+            displayName: 'Shop',
+            slug: 'shop',
+            seo: {
+                title: 'All products'
+            },
+            nodes: buildStarterNodes([
+                starterSection(`${prefix}s_section`, 'xl', 6, [
+                    starterText(`${prefix}s_title`, 'h3', 'All products'),
+                    commerceBlock(`${prefix}s_grid`, 'product-grid', {
+                        source: 'all',
+                        columns: 4,
+                        showFilters: true
+                    })
+                ])
+            ])
+        },
+        {
+            key: 'product',
+            displayName: 'Product page',
+            slug: 'product',
+            seo: {
+                title: 'Product'
+            },
+            nodes: buildStarterNodes([
+                starterSection(`${prefix}p_section`, 'xl', 6, [
+                    commerceBlock(`${prefix}p_detail`, 'product-detail', {})
+                ])
+            ])
+        },
+        {
+            key: 'cart',
+            displayName: 'Cart',
+            slug: 'cart',
+            seo: {
+                title: 'Your cart'
+            },
+            // LG, the deliberate middle case: a cart is a wide table but it is read
+            // line by line, so a full XL band spreads it further than the eye
+            // tracks. Same for the account screen below.
+            nodes: buildStarterNodes([
+                starterSection(`${prefix}c_section`, 'lg', 6, [
+                    starterText(`${prefix}c_title`, 'h3', 'Your cart'),
+                    commerceBlock(`${prefix}c_cart`, 'cart', {
+                        variant: 'inline',
+                        showCoupon: true
+                    })
+                ])
+            ])
+        },
+        {
+            key: 'account',
+            displayName: 'Account',
+            slug: 'account',
+            seo: {
+                title: 'Your account'
+            },
+            nodes: buildStarterNodes([
+                starterSection(`${prefix}a_section`, 'lg', 6, [
+                    commerceBlock(`${prefix}a_account`, 'customer-account', {
+                        signedOutHeading: 'Your account'
+                    })
+                ])
+            ])
+        }
+    ];
+}
+/** This plugin's starters, as the manifest generator compiles them. */ export function commerceStarterTemplates() {
+    return [
+        {
+            id: 'physical-shop',
+            displayName: 'Shop (physical products)',
+            description: 'Storefront starter: home with featured products, filterable shop, ' + 'product page, cart, and customer accounts. After applying, set the ' + 'Product page as the product template in Store settings.',
+            category: 'Commerce',
+            screens: shopScreens('ps_', false)
+        },
+        {
+            id: 'digital-shop',
+            displayName: 'Shop (digital products)',
+            description: 'Digital storefront starter: downloads-focused home, shop, product ' + 'page, cart, and accounts with a newsletter capture. Set the Product ' + 'page as the product template in Store settings after applying.',
+            category: 'Commerce',
+            screens: shopScreens('ds_', true)
+        }
+    ];
+}
+
+//# sourceMappingURL=starter-templates.js.map

package/src/lib/starter-templates.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../libs/plugins/commerce/src/lib/starter-templates.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  buildStarterNodes,\n  starterHeroSection,\n  starterSection,\n  starterText,\n  type StarterNodeSpec,\n  type StarterTemplate,\n  type StarterTemplateScreen,\n} from '@aglyn/aglyn/app-utils/starter-template-nodes'\nimport { SCREEN_ROOT_PATH } from '@aglyn/aglyn/app-utils/screen-route'\nimport { BUNDLE_ID } from './constants/bundle-common'\n\n/**\n * The shop starters (AGL-300): storefront sites built around this plugin's\n * elements — the product grid, the product page, the cart and the customer\n * account.\n *\n * Declared under `starterTemplates` in plugins.config.json; the manifest\n * generator calls {@link commerceStarterTemplates} and compiles what it\n * returns into core's `plugin-starter-templates.generated.ts`, after the\n * platform's own starters. The gallery, the seed route and the AI plugin's\n * examples read that list, so none of them loads this plugin to offer a shop.\n *\n * PERSISTED IDENTIFIERS: the starter ids, the screen keys and every node id\n * below appear in stored documents — seeded template ids are derived from\n * the first two — so none is ever renamed.\n */\n\n/** One of this plugin's elements, placed on a starter page. */\nconst commerceBlock = (\n  id: string,\n  componentId: string,\n  props?: Record<string, unknown>,\n): StarterNodeSpec => ({ id, componentId, pluginId: BUNDLE_ID, props })\n\n/** The pages both shop starters share. */\nfunction shopScreens(prefix: string, digital: boolean): StarterTemplateScreen[] {\n  return [\n    {\n      key: 'home',\n      displayName: 'Home',\n      // The site root, spelled the way the routing map spells it. `''` here\n      // read as \"no address\" everywhere downstream and put the shop's home\n      // page at `/home` (AGL-1575).\n      slug: SCREEN_ROOT_PATH,\n      seo: {\n        title: digital ? 'Digital shop' : 'Shop',\n        description: 'Browse our products.',\n      },\n      nodes: buildStarterNodes([\n        starterHeroSection(\n          `${prefix}h_`,\n          digital ? 'Downloads that level you up' : 'Gear you can trust',\n          digital\n            ? 'Instant delivery. Lifetime updates.'\n            : 'Quality parts, shipped fast.',\n        ),\n        starterSection(`${prefix}h_gridSection`, 'xl', 6, [\n          commerceBlock(`${prefix}h_grid`, 'product-grid', {\n            source: 'all',\n            sort: 'newest',\n            columns: 3,\n            maxItems: 6,\n          }),\n        ]),\n        // A newsletter capture is a short text-led band, not a gallery.\n        starterSection(`${prefix}h_newsSection`, 'md', 6, [\n          commerceBlock(`${prefix}h_news`, 'newsletter-signup', {\n            heading: 'Get updates and offers',\n          }),\n        ]),\n      ]),\n    },\n    {\n      key: 'shop',\n      displayName: 'Shop',\n      slug: 'shop',\n      seo: { title: 'All products' },\n      nodes: buildStarterNodes([\n        starterSection(`${prefix}s_section`, 'xl', 6, [\n          starterText(`${prefix}s_title`, 'h3', 'All products'),\n          commerceBlock(`${prefix}s_grid`, 'product-grid', {\n            source: 'all',\n            columns: 4,\n            showFilters: true,\n          }),\n        ]),\n      ]),\n    },\n    {\n      key: 'product',\n      displayName: 'Product page',\n      slug: 'product',\n      seo: { title: 'Product' },\n      nodes: buildStarterNodes([\n        starterSection(`${prefix}p_section`, 'xl', 6, [\n          commerceBlock(`${prefix}p_detail`, 'product-detail', {}),\n        ]),\n      ]),\n    },\n    {\n      key: 'cart',\n      displayName: 'Cart',\n      slug: 'cart',\n      seo: { title: 'Your cart' },\n      // LG, the deliberate middle case: a cart is a wide table but it is read\n      // line by line, so a full XL band spreads it further than the eye\n      // tracks. Same for the account screen below.\n      nodes: buildStarterNodes([\n        starterSection(`${prefix}c_section`, 'lg', 6, [\n          starterText(`${prefix}c_title`, 'h3', 'Your cart'),\n          commerceBlock(`${prefix}c_cart`, 'cart', {\n            variant: 'inline',\n            showCoupon: true,\n          }),\n        ]),\n      ]),\n    },\n    {\n      key: 'account',\n      displayName: 'Account',\n      slug: 'account',\n      seo: { title: 'Your account' },\n      nodes: buildStarterNodes([\n        starterSection(`${prefix}a_section`, 'lg', 6, [\n          commerceBlock(`${prefix}a_account`, 'customer-account', {\n            signedOutHeading: 'Your account',\n          }),\n        ]),\n      ]),\n    },\n  ]\n}\n\n/** This plugin's starters, as the manifest generator compiles them. */\nexport function commerceStarterTemplates(): StarterTemplate[] {\n  return [\n    {\n      id: 'physical-shop',\n      displayName: 'Shop (physical products)',\n      description:\n        'Storefront starter: home with featured products, filterable shop, ' +\n        'product page, cart, and customer accounts. After applying, set the ' +\n        'Product page as the product template in Store settings.',\n      category: 'Commerce',\n      screens: shopScreens('ps_', false),\n    },\n    {\n      id: 'digital-shop',\n      displayName: 'Shop (digital products)',\n      description:\n        'Digital storefront starter: downloads-focused home, shop, product ' +\n        'page, cart, and accounts with a newsletter capture. Set the Product ' +\n        'page as the product template in Store settings after applying.',\n      category: 'Commerce',\n      screens: shopScreens('ds_', true),\n    },\n  ]\n}\n"],"names":["buildStarterNodes","starterHeroSection","starterSection","starterText","SCREEN_ROOT_PATH","BUNDLE_ID","commerceBlock","id","componentId","props","pluginId","shopScreens","prefix","digital","key","displayName","slug","seo","title","description","nodes","source","sort","columns","maxItems","heading","showFilters","variant","showCoupon","signedOutHeading","commerceStarterTemplates","category","screens"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SACEA,iBAAiB,EACjBC,kBAAkB,EAClBC,cAAc,EACdC,WAAW,QAIN,gDAA+C;AACtD,SAASC,gBAAgB,QAAQ,sCAAqC;AACtE,SAASC,SAAS,QAAQ,+BAA2B;AAErD;;;;;;;;;;;;;;CAcC,GAED,6DAA6D,GAC7D,MAAMC,gBAAgB,CACpBC,IACAC,aACAC,QACqB,CAAA;QAAEF;QAAIC;QAAaE,UAAUL;QAAWI;IAAM,CAAA;AAErE,wCAAwC,GACxC,SAASE,YAAYC,MAAc,EAAEC,OAAgB;IACnD,OAAO;QACL;YACEC,KAAK;YACLC,aAAa;YACb,sEAAsE;YACtE,qEAAqE;YACrE,8BAA8B;YAC9BC,MAAMZ;YACNa,KAAK;gBACHC,OAAOL,UAAU,iBAAiB;gBAClCM,aAAa;YACf;YACAC,OAAOpB,kBAAkB;gBACvBC,mBACE,GAAGW,OAAO,EAAE,CAAC,EACbC,UAAU,gCAAgC,sBAC1CA,UACI,wCACA;gBAENX,eAAe,GAAGU,OAAO,aAAa,CAAC,EAAE,MAAM,GAAG;oBAChDN,cAAc,GAAGM,OAAO,MAAM,CAAC,EAAE,gBAAgB;wBAC/CS,QAAQ;wBACRC,MAAM;wBACNC,SAAS;wBACTC,UAAU;oBACZ;iBACD;gBACD,gEAAgE;gBAChEtB,eAAe,GAAGU,OAAO,aAAa,CAAC,EAAE,MAAM,GAAG;oBAChDN,cAAc,GAAGM,OAAO,MAAM,CAAC,EAAE,qBAAqB;wBACpDa,SAAS;oBACX;iBACD;aACF;QACH;QACA;YACEX,KAAK;YACLC,aAAa;YACbC,MAAM;YACNC,KAAK;gBAAEC,OAAO;YAAe;YAC7BE,OAAOpB,kBAAkB;gBACvBE,eAAe,GAAGU,OAAO,SAAS,CAAC,EAAE,MAAM,GAAG;oBAC5CT,YAAY,GAAGS,OAAO,OAAO,CAAC,EAAE,MAAM;oBACtCN,cAAc,GAAGM,OAAO,MAAM,CAAC,EAAE,gBAAgB;wBAC/CS,QAAQ;wBACRE,SAAS;wBACTG,aAAa;oBACf;iBACD;aACF;QACH;QACA;YACEZ,KAAK;YACLC,aAAa;YACbC,MAAM;YACNC,KAAK;gBAAEC,OAAO;YAAU;YACxBE,OAAOpB,kBAAkB;gBACvBE,eAAe,GAAGU,OAAO,SAAS,CAAC,EAAE,MAAM,GAAG;oBAC5CN,cAAc,GAAGM,OAAO,QAAQ,CAAC,EAAE,kBAAkB,CAAC;iBACvD;aACF;QACH;QACA;YACEE,KAAK;YACLC,aAAa;YACbC,MAAM;YACNC,KAAK;gBAAEC,OAAO;YAAY;YAC1B,wEAAwE;YACxE,kEAAkE;YAClE,6CAA6C;YAC7CE,OAAOpB,kBAAkB;gBACvBE,eAAe,GAAGU,OAAO,SAAS,CAAC,EAAE,MAAM,GAAG;oBAC5CT,YAAY,GAAGS,OAAO,OAAO,CAAC,EAAE,MAAM;oBACtCN,cAAc,GAAGM,OAAO,MAAM,CAAC,EAAE,QAAQ;wBACvCe,SAAS;wBACTC,YAAY;oBACd;iBACD;aACF;QACH;QACA;YACEd,KAAK;YACLC,aAAa;YACbC,MAAM;YACNC,KAAK;gBAAEC,OAAO;YAAe;YAC7BE,OAAOpB,kBAAkB;gBACvBE,eAAe,GAAGU,OAAO,SAAS,CAAC,EAAE,MAAM,GAAG;oBAC5CN,cAAc,GAAGM,OAAO,SAAS,CAAC,EAAE,oBAAoB;wBACtDiB,kBAAkB;oBACpB;iBACD;aACF;QACH;KACD;AACH;AAEA,qEAAqE,GACrE,OAAO,SAASC;IACd,OAAO;QACL;YACEvB,IAAI;YACJQ,aAAa;YACbI,aACE,uEACA,wEACA;YACFY,UAAU;YACVC,SAASrB,YAAY,OAAO;QAC9B;QACA;YACEJ,IAAI;YACJQ,aAAa;YACbI,aACE,uEACA,yEACA;YACFY,UAAU;YACVC,SAASrB,YAAY,OAAO;QAC9B;KACD;AACH"}

package/src/lib/tenant-emails.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { TenantEmailEntry } from '@aglyn/shared-util-email';
+/**
+ * The emails a site sends its own customers through Commerce (AGL-769/770).
+ *
+ * Declared here, by the plugin that sends them, and compiled into the
+ * platform's tenant email catalog (`TENANT_EMAILS` in
+ * `@aglyn/shared-util-email`) by `tools/scripts/generate-plugin-manifests.mjs`
+ * (AGL-3080): the catalog's readers include the send path, which loads no
+ * plugin code, so a runtime registry it had not filled would quietly send
+ * the text card in place of the site's designed email. Regenerate after
+ * changing an entry; `--check` refuses a stale catalog.
+ *
+ * Most commerce sends are designable in the email besigner; a `fixed` entry
+ * flips to `besigner` when its send site is wired to `renderHostEmail`
+ * (AGL-770).
+ */
+export declare function commerceTenantEmails(): readonly TenantEmailEntry[];