love-ecommerce-template 1.0.0 · SDK 1.2.0

API reference

Command line

Start

CommandDescription
create <name> [--from storefront|blank|<installed template>|<folder>]new template project
import <folder|package.zip|installed-name> [dest] [--in-place]open an existing template
init [dir]add the "node sdk" launchers to a template folder you already have
starterslist starters

Develop

CommandDescription
dev [dir]Studio: visual editor, code editor, live preview, sample data [--port 4400] [--dataset normal] [--no-open] [--offline] use the local CDN copies [--online] always use the real CDN
preview [dir]preview server only (live reload on save) [--port] [--dataset]
datasets [dir]list sample datasets (or: datasets show <id>)

Check

CommandDescription
validate [dir]validate against the application's template rules [--json] [--quiet]
test [dir]run template tests in the real application + a headless browser [--dataset a,b] [--quick] [--no-browser] [--filter text] [--json]

Ship

CommandDescription
build [dir]validate + test + copy the template files to dist/<name>/ [--skip-tests] [--quick]
package [dir]build + zip into dist/<name>-<version>.zip and verify it [--no-build] [--skip-tests] [--quick] [--out file]
verify <zip>check that a package can be installed
install <zip|dir>(store owner) install into the store's templates/ folder --app <frontend> [--force] [--name] [--url http://store --cookie "love.sid=…" --activate]
export [dir]export the project source [--format zip|folder] [--out]

Reference

CommandDescription
docsgenerate the HTML documentation [--out folder] [--open]
contractprint the template rules (from the store, built into the SDK) [--json] [--out file]
doctorcheck Node, the built-in storefront runtime, demo data and browser
cdn fetch|import <folder|manifest.json>|statuslocal copies of the CDN files pages load (offline use) Store owner (needs the store's frontend folder; template developers never use these)
verify <zip> --app <frontend>check a package against the live store
install <zip|dir> --app <frontend>install a template package into the store's templates/ folder
runtime info | update --app <frontend>show / refresh the storefront runtime built into this SDK

Node API

const sdk = require('/path/to/template-sdk');   // the SDK folder (lib/index.js)
const appRoot = sdk.resolveAppRoot({ app: '/path/to/frontend' });
const contract = sdk.getContract(appRoot);
const project = sdk.Project.open('my-template');
const result = sdk.validate(project, { appRoot, contract });
const report = await sdk.runTests({ project, appRoot, contract, datasets: ['normal'] });
const pkg = await sdk.packageTemplate(project, { appRoot, contract });

Exports: resolveAppRoot appInfo appFingerprint Project getContract clientContract validate formatDiagnostics runTests formatReport create listStarters importTemplate analyze exportProject build packageTemplate verifyPackage install listDatasets resolveDataset loadDataset summarizeDataset embedRuntime runtimeInfo packOf PreviewRuntime CdnCache findBrowser Browser watchProject openUrl openApp generateDocs startStudio

Studio HTTP API

Local only (127.0.0.1), token-protected (X-TSDK-Token header). Routes under /__studio/api/: project files file file/new file/rename asset raw validate logs dataset routing runtime/restart inspect test build package export analyze. Events stream at /__studio/events.

Storefront engine

See StorefrontTheme, Storefront, data-action and engine hooks.

Application endpoints used by the engine

See Data.

Generated 2026-10-01 11:59 UTC from the application source (contract 7075c14c24bbaf06).