@shop-on/theme-runtime 0.5.0 → 0.7.0

package/dist/bytes.d.ts

@@ -0,0 +1,18 @@
+//#region src/bytes.d.ts
+/**
+ * Binary (1024-step) sizes, one decimal, with a bare `.0` trimmed off.
+ *
+ * The GB tier is not optional decoration: plan storage ceilings are 5 GiB and
+ * 50 GiB, and without it a plan card would advertise "5120.0 MB". The trim
+ * matches the API's own copy — `plan_limit_error` formats the same ceilings
+ * with `number_to_human_size`, which says "5 GB", so a "5.0 GB" here would
+ * contradict the refusal toast the merchant is reading it next to. A real
+ * fraction keeps its digit ("1.5 GB").
+ *
+ * The unit is picked from the ROUNDED value, not the raw one. Deciding the tier
+ * first lets any size within half a rounding step of a boundary print a unit
+ * that already carried: 1048575 B is under 1 MiB, but at one decimal it is
+ * "1024.0 KB" — a KB figure no one writes.
+ */
+export declare function formatBytes(bytes: number): string;
+//#endregion

package/dist/bytes.js

@@ -0,0 +1,33 @@
+//#region src/bytes.ts
+const BYTE_UNITS = [
+	"B",
+	"KB",
+	"MB",
+	"GB"
+];
+/**
+* Binary (1024-step) sizes, one decimal, with a bare `.0` trimmed off.
+*
+* The GB tier is not optional decoration: plan storage ceilings are 5 GiB and
+* 50 GiB, and without it a plan card would advertise "5120.0 MB". The trim
+* matches the API's own copy — `plan_limit_error` formats the same ceilings
+* with `number_to_human_size`, which says "5 GB", so a "5.0 GB" here would
+* contradict the refusal toast the merchant is reading it next to. A real
+* fraction keeps its digit ("1.5 GB").
+*
+* The unit is picked from the ROUNDED value, not the raw one. Deciding the tier
+* first lets any size within half a rounding step of a boundary print a unit
+* that already carried: 1048575 B is under 1 MiB, but at one decimal it is
+* "1024.0 KB" — a KB figure no one writes.
+*/
+function formatBytes(bytes) {
+	let value = bytes;
+	let unit = 0;
+	while (unit < BYTE_UNITS.length - 1 && Number(value.toFixed(1)) >= 1024) {
+		value /= 1024;
+		unit += 1;
+	}
+	return `${value.toFixed(1).replace(/\.0$/, "")} ${BYTE_UNITS[unit]}`;
+}
+//#endregion
+export { formatBytes };

package/dist/index.d.ts

@@ -12,7 +12,7 @@ import { isDefaultSingleVariant } from "./product-variants/is-default-single-var
 import { isVariantSelectable } from "./product-variants/is-variant-selectable.js";
 import { ResolvedVariant, resolveSelectedVariant } from "./product-variants/resolve-selected-variant.js";
 import { selectionKey } from "./product-variants/selection-key.js";
-import { ArticleSchemaSource, BlockInstance, BreadcrumbSchemaSource, ProductSchemaSource, SectionGroupConfig, TemplateJSON, TemplateSeoSource, WebsiteSchemaSource } from "./template-types.js";
+import { ArticleSchemaSource, BlockInstance, BreadcrumbSchemaSource, OrganizationSchemaSource, ProductSchemaSource, ReturnPolicySchemaSource, SectionGroupConfig, TemplateJSON, TemplateSeoSource, WebsiteSchemaSource } from "./template-types.js";
 import { staleVariantFlag } from "./product-variants/stale-variant.js";
 import { SwatchSource, isSwatchOption, swatchSource } from "./product-variants/swatch-source.js";
 import { VariantPriceRange, variantPriceRange } from "./product-variants/variant-price-range.js";
@@ -22,4 +22,4 @@ import { isOnSale, savePercent } from "./sale.js";
 import { BuildSeoHeadArgs, SEO_DESCRIPTION_MAX_LENGTH, SeoHead, buildSeoHead, canonicalPath, isNarrowedListing, truncateSeoDescription } from "./seo.js";
 import { stripPostAuthParams } from "./strip-handoff-url.js";
 import { thumbhashDataUrl } from "./thumbhash.js";
-export { ArticleSchemaSource, BlockInstance, BreadcrumbSchemaSource, BuildSeoHeadArgs, Embed, EmbedKind, type LinkedMetafieldRef, type LinkedMetaobject, type LinkedMetaobjectField, Money, type OptionAvailability, PlayerEmbed, type ProductForVariantState, type ProductOption, type ProductOptionValue, ProductSchemaSource, type ProductVariant, type ResolvedVariant, SEO_DESCRIPTION_MAX_LENGTH, SectionGroupConfig, type SelectedOption, SeoHead, type SwatchSource, type SwatchVariant, TemplateJSON, TemplateSeoSource, type VariantPriceRange, type VariantState, WebsiteSchemaSource, buildAvailabilityIndex, buildSeoHead, buildVariantState, canonicalPath, currencySymbol, defaultPriceMaxBound, embedBackgroundSrc, escapeForScriptTag, findClosestVariant, formatMoney, formatMoneyWithCurrency, initials, isDefaultSingleVariant, isNarrowedListing, isOnSale, isSwatchOption, isVariantSelectable, pageCursor, parseEmbedUrl, productHref, resolveSelectedVariant, savePercent, selectionKey, staleVariantFlag, stripPostAuthParams, swatchSource, thumbhashDataUrl, truncateSeoDescription, variantPriceRange };
+export { ArticleSchemaSource, BlockInstance, BreadcrumbSchemaSource, BuildSeoHeadArgs, Embed, EmbedKind, type LinkedMetafieldRef, type LinkedMetaobject, type LinkedMetaobjectField, Money, type OptionAvailability, OrganizationSchemaSource, PlayerEmbed, type ProductForVariantState, type ProductOption, type ProductOptionValue, ProductSchemaSource, type ProductVariant, type ResolvedVariant, ReturnPolicySchemaSource, SEO_DESCRIPTION_MAX_LENGTH, SectionGroupConfig, type SelectedOption, SeoHead, type SwatchSource, type SwatchVariant, TemplateJSON, TemplateSeoSource, type VariantPriceRange, type VariantState, WebsiteSchemaSource, buildAvailabilityIndex, buildSeoHead, buildVariantState, canonicalPath, currencySymbol, defaultPriceMaxBound, embedBackgroundSrc, escapeForScriptTag, findClosestVariant, formatMoney, formatMoneyWithCurrency, initials, isDefaultSingleVariant, isNarrowedListing, isOnSale, isSwatchOption, isVariantSelectable, pageCursor, parseEmbedUrl, productHref, resolveSelectedVariant, savePercent, selectionKey, staleVariantFlag, stripPostAuthParams, swatchSource, thumbhashDataUrl, truncateSeoDescription, variantPriceRange };

package/dist/template-types.d.ts

@@ -61,6 +61,9 @@ export interface ProductSchemaSource {
   description: string;
   images: string[];
   sku: string | null;
+  /** The default variant's GTIN (EAN/UPC), only when its barcode passes the
+   * GS1 check digit. Absent or null emits no `gtin`. */
+  gtin?: string | null;
   vendor: string | null;
   price: number;
   currency: string;
@@ -82,6 +85,40 @@ export interface ProductSchemaSource {
     high: number;
     offerCount: number;
   };
+  /** The shop's saved return policy, as it applies to THIS product (a
+   * final-sale product reads `NotPermitted`). Absent until the merchant saves
+   * one under Settings → Returns. */
+  returnPolicy?: ReturnPolicySchemaSource;
+}
+/** Schema.org MerchantReturnPolicy source — rides `<ProductJsonLd>`'s offer and
+ * `<OrganizationJsonLd>`. Built by `@shop-on/theme-server/structured-data` from
+ * the merchant's saved policy; never from the column defaults an unconfigured
+ * shop reads back, which are no promise the merchant made. */
+export interface ReturnPolicySchemaSource {
+  /** ISO 3166-1 alpha-2 — Google requires `applicableCountry`. */
+  country: string;
+  category: "FiniteReturnWindow" | "UnlimitedWindow" | "NotPermitted";
+  /** Set for `FiniteReturnWindow` only. */
+  days?: number;
+  /** Who pays to send it back. Absent for `NotPermitted`. */
+  fees?: "FreeReturn" | "ReturnFeesCustomerResponsibility" | "ReturnShippingFees";
+  /** Set for `ReturnShippingFees` only. */
+  shippingFee?: {
+    amount: number;
+    currency: string;
+  };
+  /** Percent of the price withheld, when the merchant set one above zero. */
+  restockingFeePercent?: number;
+  /** Absolute URL of the shop's written refund policy, when it has one. */
+  url?: string;
+}
+/** Schema.org Organization source — feeds `<OrganizationJsonLd>` on the
+ * homepage: who sells here, their logo, and their return policy. */
+export interface OrganizationSchemaSource {
+  name: string;
+  url: string;
+  logo?: string;
+  returnPolicy?: ReturnPolicySchemaSource;
 }
 /** Schema.org BreadcrumbList source — feeds `<BreadcrumbJsonLd>`. Items are
  * ordered root→current and the component assigns the 1-based `position`. URLs
@@ -131,6 +168,8 @@ export interface TemplateJSON {
   breadcrumbSchema?: BreadcrumbSchemaSource;
   /** Set by `getHomeTemplate` so the homepage can render `<WebsiteJsonLd>`. */
   websiteSchema?: WebsiteSchemaSource;
+  /** Set by `getHomeTemplate` so the homepage can render `<OrganizationJsonLd>`. */
+  organizationSchema?: OrganizationSchemaSource;
   /** Search-console ownership proofs, set by `getHomeTemplate`. Homepage only:
    * Google's and Bing's meta-tag verification methods both look at the site
    * root, so carrying these site-wide would be two dead tags per page. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shop-on/theme-runtime",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "license": "SEE LICENSE IN dist/LICENSE.md",
   "files": [
     "dist"
@@ -9,6 +9,7 @@
   "exports": {
     ".": "./dist/index.js",
     "./badge-tags": "./dist/badge-tags.js",
+    "./bytes": "./dist/bytes.js",
     "./cart-discounts": "./dist/cart-discounts.js",
     "./cart-note": "./dist/cart-note.js",
     "./color": "./dist/color.js",
@@ -35,7 +36,7 @@
   },
   "dependencies": {
     "thumbhash": "0.1.1",
-    "@shop-on/theme-contract": "0.5.0"
+    "@shop-on/theme-contract": "0.7.0"
   },
   "devDependencies": {
     "@types/node": "26.6.5",