@picked/config 0.0.1-dev.1789541668638 → 0.0.1-dev.1793756239746

package/dist/cjs/index.js

@@ -1,5 +1,5 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require("node:fs"),t=require("node:fs/promises"),n=require("node:path"),r=require("jiti"),i=require("node:crypto");function a(e){return e}var o=`manifest.json`,s=`schema.json`,c=`schema-manifest.json`,l=`
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require("node:fs"),t=require("node:fs/promises"),n=require("node:path"),r=require("jiti"),i=require("node:crypto"),a=require("@picked/delivery-api-client");function o(e){return e}var s=`manifest.json`,c=`schema.json`,l=`schema-manifest.json`,u=`
 # Picked codegen intermediates
 .picked/
-`;function u(e){let t=(0,n.join)(e,`.picked`);return{pickedDir:t,manifestPath:(0,n.join)(t,o),schemaPath:(0,n.join)(t,s),codegenManifestPath:(0,n.join)(t,c)}}function d(e){return(0,i.createHash)(`sha256`).update(e).digest(`hex`)}function f(e){return typeof e!=`object`||!e?!1:`schemaHash`in e&&typeof e.schemaHash==`string`}async function p(n){if(!(0,e.existsSync)(n))return null;let r=await(0,t.readFile)(n,`utf8`),i=JSON.parse(r);return f(i)?i:null}async function m(e){let n=u(e.projectRoot);await(0,t.mkdir)(n.pickedDir,{recursive:!0}),await(0,t.writeFile)(n.schemaPath,e.schemaJson,`utf8`),await(0,t.writeFile)(n.codegenManifestPath,`${JSON.stringify(e.manifest,null,2)}\n`,`utf8`)}async function h(r){let i=(0,n.join)(r,`.gitignore`);if(!(0,e.existsSync)(i)){await(0,t.writeFile)(i,`.picked/
-`,`utf8`);return}(await(0,t.readFile)(i,`utf8`)).includes(`.picked/`)||await(0,t.appendFile)(i,l,`utf8`)}function g(e){let t;try{t=new URL(e)}catch{throw Error(`Invalid Picked API URL: ${e}`)}let n=t.hostname===`localhost`||t.hostname===`127.0.0.1`||t.hostname===`[::1]`;if(t.protocol!==`https:`&&!n)throw Error(`Refusing to use a non-HTTPS Picked API URL (${e}); tokens must not be sent over cleartext.`);return e}function _(e){return new URL(g(e)).origin}var v=`settings.json`,y=384;function b(e){return(0,n.join)(e,`.picked`,v)}function x(e){return!(typeof e!=`object`||!e||!(`id`in e)||typeof e.id!=`string`||!(`name`in e)||typeof e.name!=`string`||!(`status`in e)||typeof e.status!=`string`||!(`source`in e)||e.source!==`published`&&e.source!==`preview`)}function S(e){return typeof e!=`object`||!e||!(`projectId`in e)||typeof e.projectId!=`string`?!1:!(`workspace`in e)||e.workspace===void 0||x(e.workspace)}function C(e){return typeof e!=`object`||!e?!1:Object.values(e).every(S)}async function w(n){let r=b(n);if(!(0,e.existsSync)(r))return{};try{let e=JSON.parse(await(0,t.readFile)(r,`utf8`));return C(e)?e:{}}catch{return{}}}async function T(e,t){return(await w(e))[_(t)]??null}async function E(e,r,i){let a=b(e),o={...await w(e),[_(r)]:i};await(0,t.mkdir)((0,n.dirname)(a),{recursive:!0}),await h(e),await(0,t.writeFile)(a,`${JSON.stringify(o,null,2)}\n`,{encoding:`utf8`,mode:y}),await(0,t.chmod)(a,y)}var D=`https://api.picked.app`,O=`./src/picked-env.d.ts`,k=[`picked.config.ts`,`picked.config.js`,`picked.config.json`];function A(e){return typeof e==`object`&&!!e}function j(e){return A(e)&&typeof e.projectId==`string`&&e.projectId.length>0}function M(e){return e===`preview`?`preview`:`published`}function N(e,t,r){let i=process.env.PICKED_PREVIEW_TOKEN??null,a=process.env.PICKED_PROJECT_ID,o={apiUrl:g(e.apiUrl??D),typesOutput:(0,n.resolve)(t,e.typesOutput??O),projectRoot:t,telemetry:e.telemetry??!1};if(r){let t=a??r.projectId;if(r.workspace?.source===`preview`){let n=i??r.workspace.previewToken??e.previewToken??null;return{...o,projectId:t,source:`preview`,previewToken:n}}return{...o,projectId:t,source:`published`,previewToken:null}}let s=M(e.source),c=s===`preview`?i??e.previewToken??null:null;return{...o,projectId:a??e.projectId,source:s,previewToken:c}}async function P(i=process.cwd()){for(let a of k){let o=(0,n.join)(i,a);if(!(0,e.existsSync)(o))continue;if(a.endsWith(`.json`)){let e=await(0,t.readFile)(o,`utf8`),n=JSON.parse(e);if(j(n))return n;throw Error(`Invalid picked.config.json at ${o}`)}let s=await(0,r.createJiti)({}.url,{interopDefault:!0}).import(o),c=A(s)&&`default`in s?s.default:s;if(j(c))return c;throw Error(`Invalid ${a} at ${o}`)}return null}function F(e,t){let n=e?.projectId??t?.projectId;return n===void 0||n.length===0?null:{...t,...e,projectId:n,apiUrl:e?.apiUrl??t?.apiUrl}}async function I(e=process.cwd(),t){let n=F(await P(e),t);return n?N(n,e,await T(e,n.apiUrl??D)):null}var L={VERCEL:`vercel`,NETLIFY:`netlify`,CF_PAGES:`cloudflare-pages`,GITHUB_ACTIONS:`github-actions`,GITLAB_CI:`gitlab-ci`,CIRCLECI:`circleci`,BITBUCKET_BUILD_NUMBER:`bitbucket-pipelines`};function R(){let e=!!process.env.CI;for(let[e,t]of Object.entries(L))if(process.env[e])return{provider:t,ci:!0};return{provider:e?`unknown`:`local`,ci:e}}var z=new Set([`1`,`true`]),B=new Set([`0`,`false`]);function V(e){let t=e?.trim().toLowerCase();if(t!==void 0){if(z.has(t))return!0;if(B.has(t))return!1}}function H(){return V(process.env.PICKED_TELEMETRY)===!1||V(process.env.DO_NOT_TRACK)===!0}function U(e,t){return H()?!1:t===void 0?V(process.env.PICKED_TELEMETRY)===!0||e.telemetry:t}exports.appendPickedGitignore=h,exports.assertSecureApiUrl=g,exports.defineConfig=a,exports.detectHostEnvironment=R,exports.hashSchemaJson=d,exports.isTelemetryEnabled=U,exports.isTelemetryForcedOffByEnvironment=H,exports.loadPickedConfig=P,exports.loadResolvedPickedConfig=I,exports.normalizeApiUrl=_,exports.readActiveSelection=T,exports.readCodegenManifest=p,exports.resolvePickedConfig=N,exports.resolvePickedPaths=u,exports.resolveSettingsPath=b,exports.writeActiveSelection=E,exports.writeCodegenArtifacts=m;
+`;function d(e){let t=(0,n.join)(e,`.picked`);return{pickedDir:t,manifestPath:(0,n.join)(t,s),schemaPath:(0,n.join)(t,c),codegenManifestPath:(0,n.join)(t,l)}}function f(e){return(0,i.createHash)(`sha256`).update(e).digest(`hex`)}function p(e){return typeof e!=`object`||!e?!1:`schemaHash`in e&&typeof e.schemaHash==`string`}async function m(n){if(!(0,e.existsSync)(n))return null;let r=await(0,t.readFile)(n,`utf8`),i=JSON.parse(r);return p(i)?i:null}async function h(e){let n=d(e.projectRoot);await(0,t.mkdir)(n.pickedDir,{recursive:!0}),await(0,t.writeFile)(n.schemaPath,e.schemaJson,`utf8`),await(0,t.writeFile)(n.codegenManifestPath,`${JSON.stringify(e.manifest,null,2)}\n`,`utf8`)}async function g(r){let i=(0,n.join)(r,`.gitignore`);(0,e.existsSync)(i)?(await(0,t.readFile)(i,`utf8`)).includes(`.picked/`)||await(0,t.appendFile)(i,u,`utf8`):await(0,t.writeFile)(i,`.picked/
+`,`utf8`)}function _(e){let t;try{t=new URL(e)}catch{throw Error(`Invalid Picked API URL: ${e}`)}let n=t.hostname===`localhost`||t.hostname===`127.0.0.1`||t.hostname===`[::1]`;if(t.protocol!==`https:`&&!n)throw Error(`Refusing to use a non-HTTPS Picked API URL (${e}); tokens must not be sent over cleartext.`);return e}function v(e){return new URL(_(e)).origin}var y=`settings.json`,b=384;function x(e){return(0,n.join)(e,`.picked`,y)}function ee(e){return!(typeof e!=`object`||!e||!(`id`in e)||typeof e.id!=`string`||!(`name`in e)||typeof e.name!=`string`||!(`status`in e)||typeof e.status!=`string`||!(`source`in e)||e.source!==`published`&&e.source!==`preview`)}function te(e){return typeof e!=`object`||!e||!(`projectId`in e)||typeof e.projectId!=`string`?!1:!(`workspace`in e)||e.workspace===void 0||ee(e.workspace)}function ne(e){return typeof e!=`object`||!e?!1:Object.values(e).every(te)}async function S(n){let r=x(n);if(!(0,e.existsSync)(r))return{};try{let e=JSON.parse(await(0,t.readFile)(r,`utf8`));return ne(e)?e:{}}catch{return{}}}async function C(e,t){return(await S(e))[v(t)]??null}async function w(e,r,i){let a=x(e),o={...await S(e),[v(r)]:i};await(0,t.mkdir)((0,n.dirname)(a),{recursive:!0}),await g(e),await(0,t.writeFile)(a,`${JSON.stringify(o,null,2)}\n`,{encoding:`utf8`,mode:b}),await(0,t.chmod)(a,b)}var T=`https://api.picked.app`,E=`./src/picked-env.d.ts`,D=[`picked.config.ts`,`picked.config.js`,`picked.config.json`];function O(e){return typeof e==`object`&&!!e}function k(e){return O(e)&&typeof e.projectId==`string`&&e.projectId.length>0}function re(e){return e===`preview`?`preview`:`published`}var ie=new Set([`bundle`,`api`,`snapshot`]);function A(e){return typeof e==`string`&&ie.has(e)}function ae(e){let t=process.env.PICKED_DATA;if(t!==void 0&&t!==``){if(!A(t))throw Error(`PICKED_DATA is "${t}"; it takes 'bundle', 'api' or 'snapshot'.`);return t}if(e===void 0)return`bundle`;if(!A(e))throw Error(`picked.config \`data\` is ${JSON.stringify(e)}; it takes 'bundle', 'api' or 'snapshot'.`);return e}function j(e,t,r){let i=process.env.PICKED_PREVIEW_TOKEN??null,a=process.env.PICKED_PROJECT_ID,o={apiUrl:_(e.apiUrl??T),typesOutput:(0,n.resolve)(t,e.typesOutput??E),projectRoot:t,telemetry:e.telemetry??!1,data:ae(e.data)};if(r){let t=a??r.projectId;if(r.workspace?.source===`preview`){let n=i??r.workspace.previewToken??e.previewToken??null;return{...o,projectId:t,source:`preview`,previewToken:n}}return{...o,projectId:t,source:`published`,previewToken:null}}let s=re(e.source),c=s===`preview`?i??e.previewToken??null:null;return{...o,projectId:a??e.projectId,source:s,previewToken:c}}async function M(i=process.cwd()){for(let a of D){let o=(0,n.join)(i,a);if(!(0,e.existsSync)(o))continue;if(a.endsWith(`.json`)){let e=await(0,t.readFile)(o,`utf8`),n=JSON.parse(e);if(k(n))return n;throw Error(`Invalid picked.config.json at ${o}`)}let s=await(0,r.createJiti)({}.url,{interopDefault:!0}).import(o),c=O(s)&&`default`in s?s.default:s;if(k(c))return c;throw Error(`Invalid ${a} at ${o}`)}return null}function N(e,t){let n=e?.projectId??t?.projectId;return n===void 0||n.length===0?null:{...t,...e,projectId:n,apiUrl:e?.apiUrl??t?.apiUrl,data:e?.data??t?.data}}async function P(e=process.cwd(),t){let n=N(await M(e),t);return n?j(n,e,await C(e,n.apiUrl??T)):null}var F={VERCEL:`vercel`,NETLIFY:`netlify`,CF_PAGES:`cloudflare-pages`,GITHUB_ACTIONS:`github-actions`,GITLAB_CI:`gitlab-ci`,CIRCLECI:`circleci`,BITBUCKET_BUILD_NUMBER:`bitbucket-pipelines`};function I(){let e=!!process.env.CI;for(let[e,t]of Object.entries(F))if(process.env[e])return{provider:t,ci:!0};return{provider:e?`unknown`:`local`,ci:e}}var L=new Set([`1`,`true`]),R=new Set([`0`,`false`]);function z(e){let t=e?.trim().toLowerCase();if(t!==void 0){if(L.has(t))return!0;if(R.has(t))return!1}}function B(){return z(process.env.PICKED_TELEMETRY)===!1||z(process.env.DO_NOT_TRACK)===!0}function V(e,t){return B()?!1:t===void 0?z(process.env.PICKED_TELEMETRY)===!0||e.telemetry:t}var H=`picked.snapshot.json`,U=1,W="Run `picked pull` to write a fresh one.";function G(e){return(0,n.join)(e,H)}function K(e){let t=new Set;for(let n of e.steps)n.layoutContentId&&t.add(n.id);return t.size===0?[]:e.experiences.filter(e=>e.nodes.some(e=>e.type===`step`&&t.has(e.stepId))).map(e=>e.id)}function q(e,t){return e===t?0:e<t?-1:1}function J(e){let t={};for(let n of Object.keys(e.experiences).sort(q)){let r=e.experiences[n];r!==void 0&&(t[n]=r)}let n={snapshotVersion:e.snapshotVersion,projectId:e.projectId,workspaceId:e.workspaceId,projectVersionId:e.projectVersionId,source:e.source,schema:e.schema,projectConfig:e.projectConfig,experiences:t};return`${JSON.stringify(n,null,2)}\n`}function Y(e){return typeof e==`object`&&!!e}function oe(e){return Y(e)&&typeof e.id==`string`&&Array.isArray(e.features)&&Array.isArray(e.experiences)&&Array.isArray(e.steps)}function se(e){return Y(e)&&Object.values(e).every(e=>Y(e)&&typeof e.experienceId==`string`&&Array.isArray(e.content))}function ce(e){return Y(e)&&typeof e.snapshotVersion==`number`&&typeof e.projectId==`string`&&typeof e.workspaceId==`string`&&(typeof e.projectVersionId==`string`||e.projectVersionId===null)&&(e.source===`published`||e.source===`preview`)&&(0,a.isWorkspaceSchema)(e.schema)&&oe(e.projectConfig)&&se(e.experiences)}async function X(n){let r=G(n);if(!(0,e.existsSync)(r))return null;let i;try{i=JSON.parse(await(0,t.readFile)(r,`utf8`))}catch{throw Error(`${r} is not valid JSON. ${W}`)}if(Y(i)&&typeof i.snapshotVersion==`number`&&i.snapshotVersion!==1)throw Error(`${r} is in snapshot format ${i.snapshotVersion.toString()}, and this SDK reads format 1. ${W}`);if(!ce(i))throw Error(`${r} is not a Picked snapshot. ${W}`);return i}async function Z(e){let t=await X(e.projectRoot);if(!t)throw Error(`picked.config sets \`data: 'snapshot'\`, and there is no ${H} in ${e.projectRoot}. Run \`picked pull\` to write one.`);if(t.projectId!==e.projectId)throw Error(`${H} holds project "${t.projectId}", and the project in force is "${e.projectId}". ${W}`);return t}async function le(e,n){await(0,t.writeFile)(G(e),J(n),`utf8`)}async function Q(e,t){let n=[],r=await t(e=>{n.push(e)});if(r===null){let t=n.at(-1)??`no response`;throw Error(`Could not fetch ${e}: ${t}`)}return r}function $(e,t,n){if(e!==null&&t!==null&&t!==e)throw Error(`The workspace was published while pulling: the project config is at version ${e} and ${n} at ${t}. Run \`picked pull\` again.`)}async function ue(e){let{apiUrl:t,projectId:n,source:r,previewToken:i,headers:o}=e,s={previewToken:i,headers:o},c=await Q(`the workspace schema for "${n}" from ${t}`,e=>(0,a.fetchSchema)(t,n,{...s,onWarn:e})),l=await Q(`the project config for "${n}" from ${t}`,e=>(0,a.fetchProject)(t,n,{...s,onWarn:e})),u=l.versionId;$(u,c[`x-picked-version-id`],`the workspace schema`);let d=await Promise.all(K(l).map(async e=>[e,await Q(`content for experience "${e}"`,r=>(0,a.fetchExperienceContent)(t,n,e,{...s,onWarn:r}))])),f={};for(let[e,t]of d)$(u,t.versionId,`content for experience "${e}"`),f[e]=t;return{snapshotVersion:1,projectId:n,workspaceId:l.workspaceId,projectVersionId:u,source:r,schema:c,projectConfig:l,experiences:f}}exports.SNAPSHOT_FILENAME=H,exports.SNAPSHOT_VERSION=U,exports.appendPickedGitignore=g,exports.assertSecureApiUrl=_,exports.collectCmsExperienceIds=K,exports.defineConfig=o,exports.detectHostEnvironment=I,exports.fetchSnapshot=ue,exports.hashSchemaJson=f,exports.isTelemetryEnabled=V,exports.isTelemetryForcedOffByEnvironment=B,exports.loadPickedConfig=M,exports.loadResolvedPickedConfig=P,exports.normalizeApiUrl=v,exports.readActiveSelection=C,exports.readCodegenManifest=m,exports.readSnapshot=X,exports.requireSnapshot=Z,exports.resolvePickedConfig=j,exports.resolvePickedPaths=d,exports.resolveSettingsPath=x,exports.resolveSnapshotPath=G,exports.serializeSnapshot=J,exports.writeActiveSelection=w,exports.writeCodegenArtifacts=h,exports.writeSnapshot=le;

package/dist/esm/index.js

@@ -3,48 +3,45 @@ import { appendFile as t, chmod as n, mkdir as r, readFile as i, writeFile as a
 import { dirname as o, join as s, resolve as c } from "node:path";
 import { createJiti as l } from "jiti";
 import { createHash as u } from "node:crypto";
+import { fetchExperienceContent as ee, fetchProject as te, fetchSchema as d, isWorkspaceSchema as f } from "@picked/delivery-api-client";
 //#region src/config.ts
-function d(e) {
+function ne(e) {
 	return e;
 }
 //#endregion
 //#region src/manifest.ts
-var f = "manifest.json", p = "schema.json", m = "schema-manifest.json", h = "\n# Picked codegen intermediates\n.picked/\n";
-function g(e) {
+var re = "manifest.json", ie = "schema.json", ae = "schema-manifest.json", oe = "\n# Picked codegen intermediates\n.picked/\n";
+function p(e) {
 	let t = s(e, ".picked");
 	return {
 		pickedDir: t,
-		manifestPath: s(t, f),
-		schemaPath: s(t, p),
-		codegenManifestPath: s(t, m)
+		manifestPath: s(t, re),
+		schemaPath: s(t, ie),
+		codegenManifestPath: s(t, ae)
 	};
 }
-function _(e) {
+function m(e) {
 	return u("sha256").update(e).digest("hex");
 }
-function v(e) {
+function h(e) {
 	return typeof e != "object" || !e ? !1 : "schemaHash" in e && typeof e.schemaHash == "string";
 }
-async function y(t) {
+async function g(t) {
 	if (!e(t)) return null;
 	let n = await i(t, "utf8"), r = JSON.parse(n);
-	return v(r) ? r : null;
+	return h(r) ? r : null;
 }
-async function b(e) {
-	let t = g(e.projectRoot);
+async function _(e) {
+	let t = p(e.projectRoot);
 	await r(t.pickedDir, { recursive: !0 }), await a(t.schemaPath, e.schemaJson, "utf8"), await a(t.codegenManifestPath, `${JSON.stringify(e.manifest, null, 2)}\n`, "utf8");
 }
-async function x(n) {
+async function v(n) {
 	let r = s(n, ".gitignore");
-	if (!e(r)) {
-		await a(r, ".picked/\n", "utf8");
-		return;
-	}
-	(await i(r, "utf8")).includes(".picked/") || await t(r, h, "utf8");
+	e(r) ? (await i(r, "utf8")).includes(".picked/") || await t(r, oe, "utf8") : await a(r, ".picked/\n", "utf8");
 }
 //#endregion
 //#region src/url-safety.ts
-function S(e) {
+function y(e) {
 	let t;
 	try {
 		t = new URL(e);
@@ -55,69 +52,88 @@ function S(e) {
 	if (t.protocol !== "https:" && !n) throw Error(`Refusing to use a non-HTTPS Picked API URL (${e}); tokens must not be sent over cleartext.`);
 	return e;
 }
-function C(e) {
-	return new URL(S(e)).origin;
+function b(e) {
+	return new URL(y(e)).origin;
 }
 //#endregion
 //#region src/settings.ts
-var w = "settings.json", T = 384;
-function E(e) {
-	return s(e, ".picked", w);
+var se = "settings.json", x = 384;
+function S(e) {
+	return s(e, ".picked", se);
 }
-function D(e) {
+function ce(e) {
 	return !(typeof e != "object" || !e || !("id" in e) || typeof e.id != "string" || !("name" in e) || typeof e.name != "string" || !("status" in e) || typeof e.status != "string" || !("source" in e) || e.source !== "published" && e.source !== "preview");
 }
-function O(e) {
-	return typeof e != "object" || !e || !("projectId" in e) || typeof e.projectId != "string" ? !1 : !("workspace" in e) || e.workspace === void 0 || D(e.workspace);
+function le(e) {
+	return typeof e != "object" || !e || !("projectId" in e) || typeof e.projectId != "string" ? !1 : !("workspace" in e) || e.workspace === void 0 || ce(e.workspace);
 }
-function k(e) {
-	return typeof e != "object" || !e ? !1 : Object.values(e).every(O);
+function ue(e) {
+	return typeof e != "object" || !e ? !1 : Object.values(e).every(le);
 }
-async function A(t) {
-	let n = E(t);
+async function C(t) {
+	let n = S(t);
 	if (!e(n)) return {};
 	try {
 		let e = JSON.parse(await i(n, "utf8"));
-		return k(e) ? e : {};
+		return ue(e) ? e : {};
 	} catch {
 		return {};
 	}
 }
-async function j(e, t) {
-	return (await A(e))[C(t)] ?? null;
+async function w(e, t) {
+	return (await C(e))[b(t)] ?? null;
 }
-async function M(e, t, i) {
-	let s = E(e), c = {
-		...await A(e),
-		[C(t)]: i
+async function de(e, t, i) {
+	let s = S(e), c = {
+		...await C(e),
+		[b(t)]: i
 	};
-	await r(o(s), { recursive: !0 }), await x(e), await a(s, `${JSON.stringify(c, null, 2)}\n`, {
+	await r(o(s), { recursive: !0 }), await v(e), await a(s, `${JSON.stringify(c, null, 2)}\n`, {
 		encoding: "utf8",
-		mode: T
-	}), await n(s, T);
+		mode: x
+	}), await n(s, x);
 }
 //#endregion
 //#region src/load-config.ts
-var N = "https://api.picked.app", P = "./src/picked-env.d.ts", F = [
+var T = "https://api.picked.app", E = "./src/picked-env.d.ts", D = [
 	"picked.config.ts",
 	"picked.config.js",
 	"picked.config.json"
 ];
-function I(e) {
+function O(e) {
 	return typeof e == "object" && !!e;
 }
-function L(e) {
-	return I(e) && typeof e.projectId == "string" && e.projectId.length > 0;
+function k(e) {
+	return O(e) && typeof e.projectId == "string" && e.projectId.length > 0;
 }
-function R(e) {
+function A(e) {
 	return e === "preview" ? "preview" : "published";
 }
-function z(e, t, n) {
+var j = /* @__PURE__ */ new Set([
+	"bundle",
+	"api",
+	"snapshot"
+]);
+function M(e) {
+	return typeof e == "string" && j.has(e);
+}
+function N(e) {
+	let t = process.env.PICKED_DATA;
+	if (t !== void 0 && t !== "") {
+		if (!M(t)) throw Error(`PICKED_DATA is "${t}"; it takes 'bundle', 'api' or 'snapshot'.`);
+		return t;
+	}
+	if (e === void 0) return "bundle";
+	if (!M(e)) throw Error(`picked.config \`data\` is ${JSON.stringify(e)}; it takes 'bundle', 'api' or 'snapshot'.`);
+	return e;
+}
+function P(e, t, n) {
 	let r = process.env.PICKED_PREVIEW_TOKEN ?? null, i = process.env.PICKED_PROJECT_ID, a = {
-		apiUrl: S(e.apiUrl ?? N),
-		typesOutput: c(t, e.typesOutput ?? P),
+		apiUrl: y(e.apiUrl ?? T),
+		typesOutput: c(t, e.typesOutput ?? E),
 		projectRoot: t,
-		telemetry: e.telemetry ?? !1
+		telemetry: e.telemetry ?? !1,
+		data: N(e.data)
 	};
 	if (n) {
 		let t = i ?? n.projectId;
@@ -137,7 +153,7 @@ function z(e, t, n) {
 			previewToken: null
 		};
 	}
-	let o = R(e.source), s = o === "preview" ? r ?? e.previewToken ?? null : null;
+	let o = A(e.source), s = o === "preview" ? r ?? e.previewToken ?? null : null;
 	return {
 		...a,
 		projectId: i ?? e.projectId,
@@ -145,37 +161,38 @@ function z(e, t, n) {
 		previewToken: s
 	};
 }
-async function B(t = process.cwd()) {
-	for (let n of F) {
+async function F(t = process.cwd()) {
+	for (let n of D) {
 		let r = s(t, n);
 		if (!e(r)) continue;
 		if (n.endsWith(".json")) {
 			let e = await i(r, "utf8"), t = JSON.parse(e);
-			if (L(t)) return t;
+			if (k(t)) return t;
 			throw Error(`Invalid picked.config.json at ${r}`);
 		}
-		let a = await l(import.meta.url, { interopDefault: !0 }).import(r), o = I(a) && "default" in a ? a.default : a;
-		if (L(o)) return o;
+		let a = await l(import.meta.url, { interopDefault: !0 }).import(r), o = O(a) && "default" in a ? a.default : a;
+		if (k(o)) return o;
 		throw Error(`Invalid ${n} at ${r}`);
 	}
 	return null;
 }
-function V(e, t) {
+function I(e, t) {
 	let n = e?.projectId ?? t?.projectId;
 	return n === void 0 || n.length === 0 ? null : {
 		...t,
 		...e,
 		projectId: n,
-		apiUrl: e?.apiUrl ?? t?.apiUrl
+		apiUrl: e?.apiUrl ?? t?.apiUrl,
+		data: e?.data ?? t?.data
 	};
 }
-async function H(e = process.cwd(), t) {
-	let n = V(await B(e), t);
-	return n ? z(n, e, await j(e, n.apiUrl ?? N)) : null;
+async function L(e = process.cwd(), t) {
+	let n = I(await F(e), t);
+	return n ? P(n, e, await w(e, n.apiUrl ?? T)) : null;
 }
 //#endregion
 //#region src/host-environment.ts
-var U = {
+var R = {
 	VERCEL: "vercel",
 	NETLIFY: "netlify",
 	CF_PAGES: "cloudflare-pages",
@@ -184,9 +201,9 @@ var U = {
 	CIRCLECI: "circleci",
 	BITBUCKET_BUILD_NUMBER: "bitbucket-pipelines"
 };
-function W() {
+function z() {
 	let e = !!process.env.CI;
-	for (let [e, t] of Object.entries(U)) if (process.env[e]) return {
+	for (let [e, t] of Object.entries(R)) if (process.env[e]) return {
 		provider: t,
 		ci: !0
 	};
@@ -197,19 +214,126 @@ function W() {
 }
 //#endregion
 //#region src/telemetry-config.ts
-var G = /* @__PURE__ */ new Set(["1", "true"]), K = /* @__PURE__ */ new Set(["0", "false"]);
-function q(e) {
+var B = /* @__PURE__ */ new Set(["1", "true"]), V = /* @__PURE__ */ new Set(["0", "false"]);
+function H(e) {
 	let t = e?.trim().toLowerCase();
 	if (t !== void 0) {
-		if (G.has(t)) return !0;
-		if (K.has(t)) return !1;
+		if (B.has(t)) return !0;
+		if (V.has(t)) return !1;
+	}
+}
+function U() {
+	return H(process.env.PICKED_TELEMETRY) === !1 || H(process.env.DO_NOT_TRACK) === !0;
+}
+function fe(e, t) {
+	return U() ? !1 : t === void 0 ? H(process.env.PICKED_TELEMETRY) === !0 || e.telemetry : t;
+}
+//#endregion
+//#region src/snapshot.ts
+var W = "picked.snapshot.json", pe = 1, G = "Run `picked pull` to write a fresh one.";
+function K(e) {
+	return s(e, W);
+}
+function q(e) {
+	let t = /* @__PURE__ */ new Set();
+	for (let n of e.steps) n.layoutContentId && t.add(n.id);
+	return t.size === 0 ? [] : e.experiences.filter((e) => e.nodes.some((e) => e.type === "step" && t.has(e.stepId))).map((e) => e.id);
+}
+function me(e, t) {
+	return e === t ? 0 : e < t ? -1 : 1;
+}
+function J(e) {
+	let t = {};
+	for (let n of Object.keys(e.experiences).sort(me)) {
+		let r = e.experiences[n];
+		r !== void 0 && (t[n] = r);
 	}
+	let n = {
+		snapshotVersion: e.snapshotVersion,
+		projectId: e.projectId,
+		workspaceId: e.workspaceId,
+		projectVersionId: e.projectVersionId,
+		source: e.source,
+		schema: e.schema,
+		projectConfig: e.projectConfig,
+		experiences: t
+	};
+	return `${JSON.stringify(n, null, 2)}\n`;
+}
+function Y(e) {
+	return typeof e == "object" && !!e;
 }
-function J() {
-	return q(process.env.PICKED_TELEMETRY) === !1 || q(process.env.DO_NOT_TRACK) === !0;
+function he(e) {
+	return Y(e) && typeof e.id == "string" && Array.isArray(e.features) && Array.isArray(e.experiences) && Array.isArray(e.steps);
 }
-function Y(e, t) {
-	return J() ? !1 : t === void 0 ? q(process.env.PICKED_TELEMETRY) === !0 || e.telemetry : t;
+function ge(e) {
+	return Y(e) && Object.values(e).every((e) => Y(e) && typeof e.experienceId == "string" && Array.isArray(e.content));
+}
+function _e(e) {
+	return Y(e) && typeof e.snapshotVersion == "number" && typeof e.projectId == "string" && typeof e.workspaceId == "string" && (typeof e.projectVersionId == "string" || e.projectVersionId === null) && (e.source === "published" || e.source === "preview") && f(e.schema) && he(e.projectConfig) && ge(e.experiences);
+}
+async function X(t) {
+	let n = K(t);
+	if (!e(n)) return null;
+	let r;
+	try {
+		r = JSON.parse(await i(n, "utf8"));
+	} catch {
+		throw Error(`${n} is not valid JSON. ${G}`);
+	}
+	if (Y(r) && typeof r.snapshotVersion == "number" && r.snapshotVersion !== 1) throw Error(`${n} is in snapshot format ${r.snapshotVersion.toString()}, and this SDK reads format 1. ${G}`);
+	if (!_e(r)) throw Error(`${n} is not a Picked snapshot. ${G}`);
+	return r;
+}
+async function ve(e) {
+	let t = await X(e.projectRoot);
+	if (!t) throw Error(`picked.config sets \`data: 'snapshot'\`, and there is no ${W} in ${e.projectRoot}. Run \`picked pull\` to write one.`);
+	if (t.projectId !== e.projectId) throw Error(`${W} holds project "${t.projectId}", and the project in force is "${e.projectId}". ${G}`);
+	return t;
+}
+async function Z(e, t) {
+	await a(K(e), J(t), "utf8");
+}
+async function Q(e, t) {
+	let n = [], r = await t((e) => {
+		n.push(e);
+	});
+	if (r === null) {
+		let t = n.at(-1) ?? "no response";
+		throw Error(`Could not fetch ${e}: ${t}`);
+	}
+	return r;
+}
+function $(e, t, n) {
+	if (e !== null && t !== null && t !== e) throw Error(`The workspace was published while pulling: the project config is at version ${e} and ${n} at ${t}. Run \`picked pull\` again.`);
+}
+async function ye(e) {
+	let { apiUrl: t, projectId: n, source: r, previewToken: i, headers: a } = e, o = {
+		previewToken: i,
+		headers: a
+	}, s = await Q(`the workspace schema for "${n}" from ${t}`, (e) => d(t, n, {
+		...o,
+		onWarn: e
+	})), c = await Q(`the project config for "${n}" from ${t}`, (e) => te(t, n, {
+		...o,
+		onWarn: e
+	})), l = c.versionId;
+	$(l, s["x-picked-version-id"], "the workspace schema");
+	let u = await Promise.all(q(c).map(async (e) => [e, await Q(`content for experience "${e}"`, (r) => ee(t, n, e, {
+		...o,
+		onWarn: r
+	}))])), f = {};
+	for (let [e, t] of u) $(l, t.versionId, `content for experience "${e}"`), f[e] = t;
+	return {
+		snapshotVersion: 1,
+		projectId: n,
+		workspaceId: c.workspaceId,
+		projectVersionId: l,
+		source: r,
+		schema: s,
+		projectConfig: c,
+		experiences: f
+	};
 }
 //#endregion
-export { x as appendPickedGitignore, S as assertSecureApiUrl, d as defineConfig, W as detectHostEnvironment, _ as hashSchemaJson, Y as isTelemetryEnabled, J as isTelemetryForcedOffByEnvironment, B as loadPickedConfig, H as loadResolvedPickedConfig, C as normalizeApiUrl, j as readActiveSelection, y as readCodegenManifest, z as resolvePickedConfig, g as resolvePickedPaths, E as resolveSettingsPath, M as writeActiveSelection, b as writeCodegenArtifacts };
+export { W as SNAPSHOT_FILENAME, pe as SNAPSHOT_VERSION, v as appendPickedGitignore, y as assertSecureApiUrl, q as collectCmsExperienceIds, ne as defineConfig, z as detectHostEnvironment, ye as fetchSnapshot, m as hashSchemaJson, fe as isTelemetryEnabled, U as isTelemetryForcedOffByEnvironment, F as loadPickedConfig, L as loadResolvedPickedConfig, b as normalizeApiUrl, w as readActiveSelection, g as readCodegenManifest, X as readSnapshot, ve as requireSnapshot, P as resolvePickedConfig, p as resolvePickedPaths, S as resolveSettingsPath, K as resolveSnapshotPath, J as serializeSnapshot, de as writeActiveSelection, _ as writeCodegenArtifacts, Z as writeSnapshot };

package/dist/types/config.d.ts

@@ -1,6 +1,12 @@
 /** @file Configuration types for Picked tooling. */
 /** Schema source for codegen — published or live preview. */
 export type PickedConfigSource = 'published' | 'preview';
+/**
+ * Where a build's project config and CMS content come from. `'bundle'` fetches them on every
+ * build and embeds them; `'api'` embeds nothing and leaves the SDK to fetch at runtime;
+ * `'snapshot'` embeds the committed `picked.snapshot.json` and fetches nothing.
+ */
+export type PickedDataMode = 'bundle' | 'api' | 'snapshot';
 /** User-facing picked.config shape. */
 export interface PickedConfig {
     /** Picked project that schema and content are read from. */
@@ -24,6 +30,11 @@ export interface PickedConfig {
      * `1`/`0` or `true`/`false`.
      */
     telemetry?: boolean;
+    /**
+     * Where a build's project config and CMS content come from. Defaults to `'bundle'`.
+     * Overridden for one run by `PICKED_DATA`.
+     */
+    data?: PickedDataMode;
 }
 /** Fully resolved configuration with defaults applied. */
 export interface ResolvedPickedConfig {
@@ -41,6 +52,8 @@ export interface ResolvedPickedConfig {
     projectRoot: string;
     /** The committed telemetry setting, as read through `isTelemetryEnabled`. */
     telemetry: boolean;
+    /** Where a build's project config and CMS content come from, after `PICKED_DATA`. */
+    data: PickedDataMode;
 }
 /** Manifest written under `.picked/` after a schema fetch. */
 export interface PickedCodegenManifest {

package/dist/types/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,oDAAoD;AAEpD,6DAA6D;AAC7D,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,SAAS,CAAA;AAExD,uCAAuC;AACvC,MAAM,WAAW,YAAY;IAC3B,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAA;IACjB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sEAAsE;IACtE,MAAM,CAAC,EAAE,kBAAkB,CAAA;IAC3B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,0DAA0D;AAC1D,MAAM,WAAW,oBAAoB;IACnC,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAA;IACjB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAA;IACnB,sEAAsE;IACtE,MAAM,EAAE,kBAAkB,CAAA;IAC1B,8EAA8E;IAC9E,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,wFAAwF;IACxF,WAAW,EAAE,MAAM,CAAA;IACnB,6EAA6E;IAC7E,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,8DAA8D;AAC9D,MAAM,WAAW,qBAAqB;IACpC,oFAAoF;IACpF,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kFAAkF;IAClF,UAAU,EAAE,MAAM,CAAA;IAClB,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAA;IACjB,0CAA0C;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,oEAAoE;IACpE,MAAM,EAAE,kBAAkB,CAAA;IAC1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,CAE/D"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,oDAAoD;AAEpD,6DAA6D;AAC7D,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,SAAS,CAAA;AAExD;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,KAAK,GAAG,UAAU,CAAA;AAE1D,uCAAuC;AACvC,MAAM,WAAW,YAAY;IAC3B,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAA;IACjB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sEAAsE;IACtE,MAAM,CAAC,EAAE,kBAAkB,CAAA;IAC3B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,CAAA;CACtB;AAED,0DAA0D;AAC1D,MAAM,WAAW,oBAAoB;IACnC,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAA;IACjB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAA;IACnB,sEAAsE;IACtE,MAAM,EAAE,kBAAkB,CAAA;IAC1B,8EAA8E;IAC9E,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,wFAAwF;IACxF,WAAW,EAAE,MAAM,CAAA;IACnB,6EAA6E;IAC7E,SAAS,EAAE,OAAO,CAAA;IAClB,qFAAqF;IACrF,IAAI,EAAE,cAAc,CAAA;CACrB;AAED,8DAA8D;AAC9D,MAAM,WAAW,qBAAqB;IACpC,oFAAoF;IACpF,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kFAAkF;IAClF,UAAU,EAAE,MAAM,CAAA;IAClB,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAA;IACjB,0CAA0C;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,oEAAoE;IACpE,MAAM,EAAE,kBAAkB,CAAA;IAC1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,CAE/D"}

package/dist/types/index.d.ts

@@ -1,6 +1,6 @@
 /** @file Public exports for `\@picked/config`. */
 export { defineConfig } from './config';
-export type { PickedCodegenManifest, PickedConfig, PickedConfigSource, ResolvedPickedConfig, } from './config';
+export type { PickedCodegenManifest, PickedConfig, PickedConfigSource, PickedDataMode, ResolvedPickedConfig, } from './config';
 export { loadPickedConfig, loadResolvedPickedConfig, resolvePickedConfig } from './load-config';
 export { appendPickedGitignore, hashSchemaJson, readCodegenManifest, resolvePickedPaths, writeCodegenArtifacts, } from './manifest';
 export { detectHostEnvironment } from './host-environment';
@@ -9,4 +9,6 @@ export { isTelemetryEnabled, isTelemetryForcedOffByEnvironment } from './telemet
 export { readActiveSelection, resolveSettingsPath, writeActiveSelection } from './settings';
 export type { ActiveSelection, ActiveWorkspaceSelection, WorkspaceStatus } from './settings';
 export { assertSecureApiUrl, normalizeApiUrl } from './url-safety';
+export { SNAPSHOT_FILENAME, SNAPSHOT_VERSION, collectCmsExperienceIds, fetchSnapshot, readSnapshot, requireSnapshot, resolveSnapshotPath, serializeSnapshot, writeSnapshot, } from './snapshot';
+export type { FetchSnapshotOptions, PickedSnapshot } from './snapshot';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,YAAY,EACV,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAC/F,OAAO,EACL,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,YAAY,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,kBAAkB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAA;AAC1F,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAC3F,YAAY,EAAE,eAAe,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5F,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,YAAY,EACV,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,oBAAoB,GACrB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAC/F,OAAO,EACL,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,YAAY,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,kBAAkB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAA;AAC1F,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAC3F,YAAY,EAAE,eAAe,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5F,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAClE,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,uBAAuB,EACvB,aAAa,EACb,YAAY,EACZ,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,GACd,MAAM,YAAY,CAAA;AACnB,YAAY,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA"}

package/dist/types/load-config.d.ts

@@ -4,7 +4,8 @@ import type { ActiveSelection } from './settings';
  * Resolves a user config with defaults, an optional persisted selection, and env overrides.
  *
  * Precedence: an active selection (`.picked/settings.json`) overrides `projectId`/`source`;
- * `PICKED_PROJECT_ID` / `PICKED_PREVIEW_TOKEN` env vars override on top for CI/headless.
+ * `PICKED_PROJECT_ID` / `PICKED_PREVIEW_TOKEN` / `PICKED_DATA` env vars override on top for
+ * CI/headless.
  * The preview token resolves env first, then the selected workspace's token, then the
  * config's own `previewToken`, so a committed default stays in force until a developer
  * selects a workspace or a CI run supplies its own.
@@ -13,6 +14,7 @@ import type { ActiveSelection } from './settings';
  * @param {string} projectRoot - Absolute project root directory.
  * @param {ActiveSelection | null} [selection] - Persisted active selection, if any.
  * @returns {ResolvedPickedConfig} Fully resolved configuration.
+ * @throws {Error} When `data` or `PICKED_DATA` names no mode, or the API URL is insecure.
  * @example
  * resolvePickedConfig({ projectId: 'p1' }, process.cwd())
  */
@@ -30,8 +32,9 @@ export declare function loadPickedConfig(projectRoot?: string): Promise<PickedCo
  * Loads and resolves `picked.config` from the project root.
  *
  * `fallback` supplies the fields the config file omits, which lets a caller that already
- * holds project identity — the Vite plugin's deprecated `projectId` and `apiUrl` options —
- * resolve through the same precedence as everything else, config file included.
+ * holds project identity or a data mode — the Vite plugin's deprecated `projectId`, `apiUrl`
+ * and `mode` options — resolve through the same precedence as everything else, config file
+ * included.
  *
  * @param {string} [projectRoot] - Directory to search; defaults to `process.cwd()`.
  * @param {Partial<PickedConfig>} [fallback] - Values to use for the fields the file omits.

package/dist/types/load-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"load-config.d.ts","sourceRoot":"","sources":["../../src/load-config.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAsB,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAEtF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AA4CjD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,MAAM,EACnB,SAAS,CAAC,EAAE,eAAe,GAAG,IAAI,GACjC,oBAAoB,CAyBtB;AAED;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CAAC,WAAW,SAAgB,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CA6BhG;AAgCD;;;;;;;;;;;;GAYG;AACH,wBAAsB,wBAAwB,CAC5C,WAAW,SAAgB,EAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAC/B,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAQtC"}
+{"version":3,"file":"load-config.d.ts","sourceRoot":"","sources":["../../src/load-config.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,YAAY,EAGZ,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAEjB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AA0FjD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,MAAM,EACnB,SAAS,CAAC,EAAE,eAAe,GAAG,IAAI,GACjC,oBAAoB,CA0BtB;AAED;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CAAC,WAAW,SAAgB,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CA6BhG;AAiCD;;;;;;;;;;;;;GAaG;AACH,wBAAsB,wBAAwB,CAC5C,WAAW,SAAgB,EAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAC/B,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAQtC"}

package/dist/types/snapshot.d.ts

@@ -0,0 +1,110 @@
+import { type ExperienceContentResponse, type ProjectConfig, type WorkspaceSchema } from '@picked/delivery-api-client';
+import type { PickedConfigSource, ResolvedPickedConfig } from './config';
+/** File name of the snapshot, in the directory holding `picked.config`. */
+export declare const SNAPSHOT_FILENAME = "picked.snapshot.json";
+/** Format version written to `snapshotVersion`. A reader refuses any other. */
+export declare const SNAPSHOT_VERSION = 1;
+/** The contents of `picked.snapshot.json`. */
+export interface PickedSnapshot {
+    /** Format version; see {@link SNAPSHOT_VERSION}. */
+    snapshotVersion: number;
+    /** Project the snapshot was pulled from. */
+    projectId: string;
+    /** Workspace the snapshot was pulled from. */
+    workspaceId: string;
+    /** Workspace version every payload was served at; `null` for preview data, which has none. */
+    projectVersionId: string | null;
+    /** Whether the snapshot holds published or preview data. */
+    source: PickedConfigSource;
+    /** The workspace schema that type generation reads. */
+    schema: WorkspaceSchema;
+    /** The project config the SDK runs on. */
+    projectConfig: ProjectConfig;
+    /** Content for every experience whose steps reference CMS content, keyed by experience id. */
+    experiences: Record<string, ExperienceContentResponse>;
+}
+/**
+ * Returns the absolute path of `picked.snapshot.json` in a project root.
+ *
+ * @param {string} projectRoot - Directory holding `picked.config`.
+ * @returns {string} Absolute snapshot path.
+ * @example
+ * resolveSnapshotPath('/app') // '/app/picked.snapshot.json'
+ */
+export declare function resolveSnapshotPath(projectRoot: string): string;
+/**
+ * Returns the ids of experiences whose steps reference CMS content, in config order.
+ *
+ * @param {ProjectConfig} config - Project config to walk.
+ * @returns {string[]} Ids of the CMS-using experiences.
+ * @example
+ * collectCmsExperienceIds(config) // ['exp-a', 'exp-b']
+ */
+export declare function collectCmsExperienceIds(config: ProjectConfig): string[];
+/**
+ * Serialises a snapshot: top-level fields in a fixed order, experiences by id, two-space
+ * indentation and a trailing newline. Payloads keep the key order the API served them in, so
+ * unchanged data serialises to the same bytes.
+ *
+ * @param {PickedSnapshot} snapshot - Snapshot to serialise.
+ * @returns {string} The file contents.
+ * @example
+ * await writeFile(path, serializeSnapshot(snapshot))
+ */
+export declare function serializeSnapshot(snapshot: PickedSnapshot): string;
+/**
+ * Reads `picked.snapshot.json` from a project root.
+ *
+ * @param {string} projectRoot - Directory holding `picked.config`.
+ * @returns {Promise<PickedSnapshot | null>} The snapshot, or `null` when the file does not exist.
+ * @throws {Error} When the file is not JSON, is in another format version, or lacks a field.
+ * @example
+ * const snapshot = await readSnapshot('/app')
+ */
+export declare function readSnapshot(projectRoot: string): Promise<PickedSnapshot | null>;
+/**
+ * Reads the snapshot a `data: 'snapshot'` run builds from, and checks it is for the project in
+ * force.
+ *
+ * @param {Pick<ResolvedPickedConfig, 'projectRoot' | 'projectId'>} config - The resolved config.
+ * @returns {Promise<PickedSnapshot>} The snapshot.
+ * @throws {Error} When the snapshot is missing, unreadable, or for another project.
+ * @example
+ * const snapshot = await requireSnapshot(resolvedConfig)
+ */
+export declare function requireSnapshot(config: Pick<ResolvedPickedConfig, 'projectRoot' | 'projectId'>): Promise<PickedSnapshot>;
+/**
+ * Writes `picked.snapshot.json` to a project root.
+ *
+ * @param {string} projectRoot - Directory holding `picked.config`.
+ * @param {PickedSnapshot} snapshot - Snapshot to write.
+ * @returns {Promise<void>} Resolves once the file is written.
+ * @example
+ * await writeSnapshot('/app', snapshot)
+ */
+export declare function writeSnapshot(projectRoot: string, snapshot: PickedSnapshot): Promise<void>;
+/** Options for {@link fetchSnapshot}. */
+export interface FetchSnapshotOptions {
+    /** Origin of the Picked API. */
+    apiUrl: string;
+    /** Project to pull. */
+    projectId: string;
+    /** Whether the pull reads published or preview data. Recorded in the snapshot. */
+    source: PickedConfigSource;
+    /** Workspace preview token, sent with every request and never written to the snapshot. */
+    previewToken?: string;
+    /** Headers to send with every request, such as `Picked-Client`. */
+    headers?: Record<string, string>;
+}
+/**
+ * Fetches a snapshot from the delivery API: the workspace schema, the project config, and the
+ * content of every experience whose steps reference CMS content.
+ *
+ * @param {FetchSnapshotOptions} options - What to pull, and from where.
+ * @returns {Promise<PickedSnapshot>} The snapshot.
+ * @throws {Error} When a request fails, or the payloads come from different versions.
+ * @example
+ * const snapshot = await fetchSnapshot({ apiUrl, projectId, source: 'published' })
+ */
+export declare function fetchSnapshot(options: FetchSnapshotOptions): Promise<PickedSnapshot>;
+//# sourceMappingURL=snapshot.d.ts.map