@shop-on/theme-contract 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -8,4 +8,5 @@ import { ARTICLE_ATTRIBUTE_KEYS, ArticleAttributeKey, BLOG_ATTRIBUTE_KEYS, BlogA
 import { metaobjectGid, metaobjectIdFromGid } from "./metaobject-gid.js";
 import { RICHTEXT_ALLOWED_TAGS, RichtextTag } from "./richtext.js";
 import { isNodeIdToken, nodeGid } from "./node-id.js";
-export { ARTICLE_ATTRIBUTE_KEYS, ArticleAttributeKey, BLOCK_PATH_SEPARATOR, BLOG_ATTRIBUTE_KEYS, BlockDefinition, BlockSchema, BlogAttributeKey, COLLECTION_ATTRIBUTE_KEYS, COLLECTION_INLINE_ATTRIBUTE_KEYS, CollectedTypes, CollectionAttributeBindingSources, CollectionAttributeKey, CollectionInlineAttributeKey, EDITOR_COMMANDS, EditorCommand, EditorKeyInput, FieldSource, InlineSegment, InlineSources, LayoutGroupDef, MAX_PALETTE_COLORS, MIN_PALETTE_COLORS, PAGE_ATTRIBUTE_KEYS, PALETTE_FALLBACK_COLOR, PALETTE_GROUP_TYPE, PALETTE_PREFIX, PALETTE_REF_PREFIX, PRODUCT_ATTRIBUTE_KEYS, PageAttributeKey, PaletteColor, ProductAttributeKey, RICHTEXT_ALLOWED_TAGS, ResolverCtx, ResolverScope, ResolverShape, ResolverSpec, RichtextTag, SKIP, SchemaSetting, SectionGroup, SectionGroupData, SectionPreset, SectionSchema, SeedMissingStaticsReport, SelectedSection, SettingBinding, SettingBindings, SettingValue, SettingsData, SettingsSchema, SettingsSchemaSection, Skip, Template, TemplateBlock, TemplateSection, TemplateShape, WholeValueBindingOpts, applyCollectionAttributeBindings, applyInlineSources, applyMetafieldBindings, applyMetaobjectFieldBindings, blockPathsEqual, buildBlockInstance, buildDisabledAncestorSet, buildParentMap, buildSectionInstance, buildStaticChildren, collectCollectionAttributeBindings, collectMetaobjectEntryIds, collectTraversedEntryIds, collectTypes, comparePaletteIds, decodeStorefrontMetafield, defaultSettings, editorCommand, encodeSourceToken, escapeInertHtmlText, hasPaletteRefs, isBlockPathPrefix, isEditorCommand, isNodeIdToken, joinBlockPath, metafieldDefinitionFitsSetting, metafieldTypeSupportsInlineToken, metafieldTypeToSettingTypes, metaobjectGid, metaobjectIdFromGid, nodeGid, normalizeBlockPath, paletteKey, paletteRef, paletteValues, parsePalette, parsePaletteRef, parseSourceDescriptor, resolveContainerAtPath, resolveField, resolvePaletteRefs, resolvePaletteValue, resolveThemeSettingsPalette, seedMissingStatics, selectRenderableChildren, selectRenderableSections, serializeSourceDescriptor, settingTypeSupportsBinding, shortcutKey, splitBlockPath, splitInlineTokens, staticBlockId, staticChildId, stripInlineTokenSentinels, stripStaticFromBlockOrder, undoHotkey, walkBlocks, walkSections };
+import { INSTALL_ID_RE, STORE_SLUG_RE } from "./store-path.js";
+export { ARTICLE_ATTRIBUTE_KEYS, ArticleAttributeKey, BLOCK_PATH_SEPARATOR, BLOG_ATTRIBUTE_KEYS, BlockDefinition, BlockSchema, BlogAttributeKey, COLLECTION_ATTRIBUTE_KEYS, COLLECTION_INLINE_ATTRIBUTE_KEYS, CollectedTypes, CollectionAttributeBindingSources, CollectionAttributeKey, CollectionInlineAttributeKey, EDITOR_COMMANDS, EditorCommand, EditorKeyInput, FieldSource, INSTALL_ID_RE, InlineSegment, InlineSources, LayoutGroupDef, MAX_PALETTE_COLORS, MIN_PALETTE_COLORS, PAGE_ATTRIBUTE_KEYS, PALETTE_FALLBACK_COLOR, PALETTE_GROUP_TYPE, PALETTE_PREFIX, PALETTE_REF_PREFIX, PRODUCT_ATTRIBUTE_KEYS, PageAttributeKey, PaletteColor, ProductAttributeKey, RICHTEXT_ALLOWED_TAGS, ResolverCtx, ResolverScope, ResolverShape, ResolverSpec, RichtextTag, SKIP, STORE_SLUG_RE, SchemaSetting, SectionGroup, SectionGroupData, SectionPreset, SectionSchema, SeedMissingStaticsReport, SelectedSection, SettingBinding, SettingBindings, SettingValue, SettingsData, SettingsSchema, SettingsSchemaSection, Skip, Template, TemplateBlock, TemplateSection, TemplateShape, WholeValueBindingOpts, applyCollectionAttributeBindings, applyInlineSources, applyMetafieldBindings, applyMetaobjectFieldBindings, blockPathsEqual, buildBlockInstance, buildDisabledAncestorSet, buildParentMap, buildSectionInstance, buildStaticChildren, collectCollectionAttributeBindings, collectMetaobjectEntryIds, collectTraversedEntryIds, collectTypes, comparePaletteIds, decodeStorefrontMetafield, defaultSettings, editorCommand, encodeSourceToken, escapeInertHtmlText, hasPaletteRefs, isBlockPathPrefix, isEditorCommand, isNodeIdToken, joinBlockPath, metafieldDefinitionFitsSetting, metafieldTypeSupportsInlineToken, metafieldTypeToSettingTypes, metaobjectGid, metaobjectIdFromGid, nodeGid, normalizeBlockPath, paletteKey, paletteRef, paletteValues, parsePalette, parsePaletteRef, parseSourceDescriptor, resolveContainerAtPath, resolveField, resolvePaletteRefs, resolvePaletteValue, resolveThemeSettingsPalette, seedMissingStatics, selectRenderableChildren, selectRenderableSections, serializeSourceDescriptor, settingTypeSupportsBinding, shortcutKey, splitBlockPath, splitInlineTokens, staticBlockId, staticChildId, stripInlineTokenSentinels, stripStaticFromBlockOrder, undoHotkey, walkBlocks, walkSections };

package/dist/index.js

@@ -8,4 +8,5 @@ import { metaobjectGid, metaobjectIdFromGid } from "./metaobject-gid.js";
 import { ARTICLE_ATTRIBUTE_KEYS, BLOG_ATTRIBUTE_KEYS, COLLECTION_ATTRIBUTE_KEYS, COLLECTION_INLINE_ATTRIBUTE_KEYS, PAGE_ATTRIBUTE_KEYS, PRODUCT_ATTRIBUTE_KEYS, applyCollectionAttributeBindings, applyInlineSources, applyMetafieldBindings, applyMetaobjectFieldBindings, collectCollectionAttributeBindings, collectMetaobjectEntryIds, collectTraversedEntryIds, decodeStorefrontMetafield, encodeSourceToken, escapeInertHtmlText, metafieldDefinitionFitsSetting, metafieldTypeSupportsInlineToken, metafieldTypeToSettingTypes, parseSourceDescriptor, serializeSourceDescriptor, settingTypeSupportsBinding, splitInlineTokens, stripInlineTokenSentinels } from "./metafield-binding.js";
 import { RICHTEXT_ALLOWED_TAGS } from "./richtext.js";
 import { isNodeIdToken, nodeGid } from "./node-id.js";
-export { ARTICLE_ATTRIBUTE_KEYS, BLOCK_PATH_SEPARATOR, BLOG_ATTRIBUTE_KEYS, BlockDefinition, BlockSchema, COLLECTION_ATTRIBUTE_KEYS, COLLECTION_INLINE_ATTRIBUTE_KEYS, EDITOR_COMMANDS, MAX_PALETTE_COLORS, MIN_PALETTE_COLORS, PAGE_ATTRIBUTE_KEYS, PALETTE_FALLBACK_COLOR, PALETTE_GROUP_TYPE, PALETTE_PREFIX, PALETTE_REF_PREFIX, PRODUCT_ATTRIBUTE_KEYS, RICHTEXT_ALLOWED_TAGS, SKIP, SchemaSetting, SectionGroup, SectionPreset, SectionSchema, SettingBinding, SettingBindings, SettingsData, SettingsSchema, SettingsSchemaSection, Template, TemplateBlock, TemplateSection, applyCollectionAttributeBindings, applyInlineSources, applyMetafieldBindings, applyMetaobjectFieldBindings, blockPathsEqual, buildBlockInstance, buildDisabledAncestorSet, buildParentMap, buildSectionInstance, buildStaticChildren, collectCollectionAttributeBindings, collectMetaobjectEntryIds, collectTraversedEntryIds, collectTypes, comparePaletteIds, decodeStorefrontMetafield, defaultSettings, editorCommand, encodeSourceToken, escapeInertHtmlText, hasPaletteRefs, isBlockPathPrefix, isEditorCommand, isNodeIdToken, joinBlockPath, metafieldDefinitionFitsSetting, metafieldTypeSupportsInlineToken, metafieldTypeToSettingTypes, metaobjectGid, metaobjectIdFromGid, nodeGid, normalizeBlockPath, paletteKey, paletteRef, paletteValues, parsePalette, parsePaletteRef, parseSourceDescriptor, resolveContainerAtPath, resolveField, resolvePaletteRefs, resolvePaletteValue, resolveThemeSettingsPalette, seedMissingStatics, selectRenderableChildren, selectRenderableSections, serializeSourceDescriptor, settingTypeSupportsBinding, shortcutKey, splitBlockPath, splitInlineTokens, staticBlockId, staticChildId, stripInlineTokenSentinels, stripStaticFromBlockOrder, undoHotkey, walkBlocks, walkSections };
+import { INSTALL_ID_RE, STORE_SLUG_RE } from "./store-path.js";
+export { ARTICLE_ATTRIBUTE_KEYS, BLOCK_PATH_SEPARATOR, BLOG_ATTRIBUTE_KEYS, BlockDefinition, BlockSchema, COLLECTION_ATTRIBUTE_KEYS, COLLECTION_INLINE_ATTRIBUTE_KEYS, EDITOR_COMMANDS, INSTALL_ID_RE, MAX_PALETTE_COLORS, MIN_PALETTE_COLORS, PAGE_ATTRIBUTE_KEYS, PALETTE_FALLBACK_COLOR, PALETTE_GROUP_TYPE, PALETTE_PREFIX, PALETTE_REF_PREFIX, PRODUCT_ATTRIBUTE_KEYS, RICHTEXT_ALLOWED_TAGS, SKIP, STORE_SLUG_RE, SchemaSetting, SectionGroup, SectionPreset, SectionSchema, SettingBinding, SettingBindings, SettingsData, SettingsSchema, SettingsSchemaSection, Template, TemplateBlock, TemplateSection, applyCollectionAttributeBindings, applyInlineSources, applyMetafieldBindings, applyMetaobjectFieldBindings, blockPathsEqual, buildBlockInstance, buildDisabledAncestorSet, buildParentMap, buildSectionInstance, buildStaticChildren, collectCollectionAttributeBindings, collectMetaobjectEntryIds, collectTraversedEntryIds, collectTypes, comparePaletteIds, decodeStorefrontMetafield, defaultSettings, editorCommand, encodeSourceToken, escapeInertHtmlText, hasPaletteRefs, isBlockPathPrefix, isEditorCommand, isNodeIdToken, joinBlockPath, metafieldDefinitionFitsSetting, metafieldTypeSupportsInlineToken, metafieldTypeToSettingTypes, metaobjectGid, metaobjectIdFromGid, nodeGid, normalizeBlockPath, paletteKey, paletteRef, paletteValues, parsePalette, parsePaletteRef, parseSourceDescriptor, resolveContainerAtPath, resolveField, resolvePaletteRefs, resolvePaletteValue, resolveThemeSettingsPalette, seedMissingStatics, selectRenderableChildren, selectRenderableSections, serializeSourceDescriptor, settingTypeSupportsBinding, shortcutKey, splitBlockPath, splitInlineTokens, staticBlockId, staticChildId, stripInlineTokenSentinels, stripStaticFromBlockOrder, undoHotkey, walkBlocks, walkSections };

package/dist/preset-materializer.d.ts

@@ -0,0 +1,9 @@
+//#region src/preset-materializer.d.ts
+export declare function materializePreset(opts: {
+  configDir: string;
+  presetHandle: string;
+}): Promise<void>;
+/** Deep-merges each of a listing's overridable dirs over `configDir`'s copy;
+ * a file only the listing has lands as is. Leaves settings-data alone. */
+export declare function overlayPresetListing(listingDir: string, configDir: string): Promise<void>;
+//#endregion

package/dist/preset-materializer.js

@@ -0,0 +1,70 @@
+import { LISTING_DIRS, PRESET_HANDLE_RE, mergePresetJson, normalizePresetKey } from "./preset-listing.js";
+import { mkdir, readFile, readdir, stat, writeFile } from "node:fs/promises";
+import path from "node:path";
+//#region src/preset-materializer.ts
+function isPlainObject(value) {
+	return Boolean(value) && typeof value === "object" && !Array.isArray(value);
+}
+async function readJson(filePath) {
+	try {
+		return JSON.parse(await readFile(filePath, "utf-8"));
+	} catch (err) {
+		if (err instanceof Error && err.code === "ENOENT") return null;
+		throw err;
+	}
+}
+async function dirExists(dir) {
+	try {
+		return (await stat(dir)).isDirectory();
+	} catch {
+		return false;
+	}
+}
+async function materializeJsonOverrides(sourceDir, targetDir) {
+	if (!await dirExists(sourceDir)) return;
+	await mkdir(targetDir, { recursive: true });
+	const entries = await readdir(sourceDir, { withFileTypes: true });
+	for (const entry of entries) {
+		const sourcePath = path.join(sourceDir, entry.name);
+		const targetPath = path.join(targetDir, entry.name);
+		if (entry.isDirectory()) {
+			await materializeJsonOverrides(sourcePath, targetPath);
+			continue;
+		}
+		if (!entry.isFile() || !entry.name.endsWith(".json") || entry.name.startsWith("._")) continue;
+		const override = await readJson(sourcePath);
+		if (override === null) continue;
+		const base = await readJson(targetPath);
+		const output = base === null ? override : mergePresetJson(base, override);
+		await writeFile(targetPath, `${JSON.stringify(output, null, 2)}\n`, "utf-8");
+	}
+}
+async function flattenSettingsData(configDir, presetHandle) {
+	const settingsPath = path.join(configDir, "settings-data.json");
+	const data = await readJson(settingsPath);
+	if (!isPlainObject(data)) return;
+	const presets = data.presets;
+	if (!isPlainObject(presets)) return;
+	const currentPreset = isPlainObject(data.current) ? data.current.preset : null;
+	const keys = Object.keys(presets);
+	const selectedKey = keys.find((key) => key === presetHandle) ?? keys.find((key) => normalizePresetKey(key) === presetHandle) ?? (typeof currentPreset === "string" && normalizePresetKey(currentPreset) === presetHandle ? currentPreset : null);
+	if (!selectedKey) throw new Error(`settings-data.json does not contain selected preset "${presetHandle}" in presets wrapper`);
+	const selected = presets[selectedKey];
+	if (!isPlainObject(selected) || !isPlainObject(selected.settings)) throw new Error(`settings-data.json preset "${selectedKey}" is missing a settings object`);
+	await writeFile(settingsPath, `${JSON.stringify(selected.settings, null, 2)}\n`, "utf-8");
+}
+async function materializePreset(opts) {
+	const presetHandle = opts.presetHandle.trim();
+	if (!PRESET_HANDLE_RE.test(presetHandle)) throw new Error(`invalid preset handle "${opts.presetHandle}"`);
+	const listingDir = path.join(opts.configDir, "listings", presetHandle);
+	if (!await dirExists(listingDir)) throw new Error(`selected preset "${presetHandle}" not found at config/listings/${presetHandle}`);
+	await flattenSettingsData(opts.configDir, presetHandle);
+	await overlayPresetListing(listingDir, opts.configDir);
+}
+/** Deep-merges each of a listing's overridable dirs over `configDir`'s copy;
+* a file only the listing has lands as is. Leaves settings-data alone. */
+async function overlayPresetListing(listingDir, configDir) {
+	for (const dir of LISTING_DIRS) await materializeJsonOverrides(path.join(listingDir, dir), path.join(configDir, dir));
+}
+//#endregion
+export { materializePreset, overlayPresetListing };

package/dist/store-path.d.ts

@@ -0,0 +1,4 @@
+//#region src/store-path.d.ts
+export declare const STORE_SLUG_RE: RegExp;
+export declare const INSTALL_ID_RE: RegExp;
+//#endregion

package/dist/store-path.js

@@ -0,0 +1,5 @@
+//#region src/store-path.ts
+const STORE_SLUG_RE = /^[a-z0-9][a-z0-9-]{0,62}$/;
+const INSTALL_ID_RE = /^[a-z0-9_-]{4,32}$/;
+//#endregion
+export { INSTALL_ID_RE, STORE_SLUG_RE };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shop-on/theme-contract",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "license": "SEE LICENSE IN dist/LICENSE.md",
   "files": [
     "dist"
@@ -10,12 +10,14 @@
   "exports": {
     ".": "./dist/index.js",
     "./preset-listing": "./dist/preset-listing.js",
+    "./preset-materializer": "./dist/preset-materializer.js",
     "./package.json": "./package.json"
   },
   "dependencies": {
     "zod": "4.6.7"
   },
   "devDependencies": {
+    "@types/node": "26.6.5",
     "typescript": "7.0.2",
     "vitest": "5.0.5"
   },