@crustjs/store 0.0.1 → 0.0.3

package/dist/index.js

@@ -1,231 +1,4 @@
 // @bun
-// src/errors.ts
-class CrustStoreError extends Error {
-  code;
-  details;
-  cause;
-  constructor(code, message, details) {
-    super(message);
-    this.name = "CrustStoreError";
-    this.code = code;
-    this.details = details;
-  }
-  is(code) {
-    return this.code === code;
-  }
-  withCause(cause) {
-    this.cause = cause;
-    return this;
-  }
-}
-// src/path.ts
-import { homedir } from "os";
-import { join } from "path";
-var DEFAULT_STORE_NAME = "config";
-function getRuntimeEnv() {
-  return {
-    platform: process.platform,
-    env: process.env,
-    homedir: homedir()
-  };
-}
-function validateAppName(appName) {
-  if (!appName || appName.trim().length === 0) {
-    throw new CrustStoreError("PATH", "appName must be a non-empty string", {
-      path: appName ?? ""
-    });
-  }
-  if (appName.includes("/") || appName.includes("\\")) {
-    throw new CrustStoreError("PATH", "appName must not contain path separators", {
-      path: appName
-    });
-  }
-}
-function validateName(name) {
-  if (!name || name.trim().length === 0) {
-    throw new CrustStoreError("PATH", "name must be a non-empty string", {
-      path: name ?? ""
-    });
-  }
-  if (name.includes("/") || name.includes("\\")) {
-    throw new CrustStoreError("PATH", "name must not contain path separators", {
-      path: name
-    });
-  }
-  if (name.endsWith(".json")) {
-    throw new CrustStoreError("PATH", "name must not include the .json extension", {
-      path: name
-    });
-  }
-}
-function validateDirPath(dirPath) {
-  if (!dirPath || dirPath.trim().length === 0) {
-    throw new CrustStoreError("PATH", "dirPath must be a non-empty string", {
-      path: dirPath ?? ""
-    });
-  }
-  const isAbsolute = dirPath.startsWith("/") || /^[A-Za-z]:[/\\]/.test(dirPath);
-  if (!isAbsolute) {
-    throw new CrustStoreError("PATH", "dirPath must be an absolute path", {
-      path: dirPath
-    });
-  }
-  if (dirPath.endsWith(".json")) {
-    throw new CrustStoreError("PATH", "dirPath must be a directory path, not a file path (should not end with .json)", {
-      path: dirPath
-    });
-  }
-}
-function configDir(appName, env) {
-  validateAppName(appName);
-  const resolvedEnv = env ?? getRuntimeEnv();
-  switch (resolvedEnv.platform) {
-    case "linux": {
-      const xdgConfig = resolvedEnv.env.XDG_CONFIG_HOME;
-      const base = xdgConfig && xdgConfig.trim().length > 0 ? xdgConfig : join(resolvedEnv.homedir, ".config");
-      return join(base, appName);
-    }
-    case "darwin": {
-      return join(resolvedEnv.homedir, "Library", "Application Support", appName);
-    }
-    case "win32": {
-      const appData = resolvedEnv.env.APPDATA;
-      const base = appData && appData.trim().length > 0 ? appData : join(resolvedEnv.homedir, "AppData", "Roaming");
-      return join(base, appName);
-    }
-    default:
-      throw new CrustStoreError("PATH", `Unsupported platform: ${resolvedEnv.platform}`, {
-        path: resolvedEnv.platform
-      });
-  }
-}
-function resolveStorePath(dirPath, name) {
-  validateDirPath(dirPath);
-  const storeName = name ?? DEFAULT_STORE_NAME;
-  if (name !== undefined) {
-    validateName(name);
-  }
-  return join(dirPath, `${storeName}.json`);
-}
-// src/merge.ts
-function applyFieldDefaults(persisted, fields) {
-  const result = {};
-  for (const [key, def] of Object.entries(fields)) {
-    if (persisted && key in persisted) {
-      result[key] = persisted[key];
-    } else if ("default" in def && def.default !== undefined) {
-      result[key] = Array.isArray(def.default) ? [...def.default] : def.default;
-    }
-  }
-  return result;
-}
-
-// src/persistence.ts
-import { randomUUID } from "crypto";
-import {
-  mkdir,
-  readFile,
-  rename,
-  rm,
-  unlink,
-  writeFile
-} from "fs/promises";
-import { dirname, join as join2 } from "path";
-async function readJson(filePath) {
-  let raw;
-  try {
-    raw = await readFile(filePath, "utf-8");
-  } catch (err) {
-    if (isEnoent(err)) {
-      return;
-    }
-    throw new CrustStoreError("IO", `Failed to read config file: ${filePath}`, {
-      path: filePath,
-      operation: "read"
-    }).withCause(err);
-  }
-  try {
-    return JSON.parse(raw);
-  } catch (err) {
-    throw new CrustStoreError("PARSE", `Malformed JSON in config file: ${filePath}`, { path: filePath }).withCause(err);
-  }
-}
-async function writeJson(filePath, data) {
-  const dir = dirname(filePath);
-  const tempPath = join2(dir, `.config-${randomUUID()}.tmp`);
-  try {
-    await mkdir(dir, { recursive: true });
-  } catch (err) {
-    throw new CrustStoreError("IO", `Failed to create config directory: ${dir}`, {
-      path: filePath,
-      operation: "write"
-    }).withCause(err);
-  }
-  try {
-    const json = JSON.stringify(data, null, "\t");
-    await writeFile(tempPath, json, "utf-8");
-  } catch (err) {
-    await cleanupTempFile(tempPath);
-    throw new CrustStoreError("IO", `Failed to write config file: ${filePath}`, {
-      path: filePath,
-      operation: "write"
-    }).withCause(err);
-  }
-  try {
-    await rename(tempPath, filePath);
-  } catch (err) {
-    await cleanupTempFile(tempPath);
-    throw new CrustStoreError("IO", `Failed to finalize config file: ${filePath}`, {
-      path: filePath,
-      operation: "write"
-    }).withCause(err);
-  }
-}
-async function deleteJson(filePath) {
-  try {
-    await unlink(filePath);
-  } catch (err) {
-    if (isEnoent(err)) {
-      return;
-    }
-    throw new CrustStoreError("IO", `Failed to delete config file: ${filePath}`, {
-      path: filePath,
-      operation: "delete"
-    }).withCause(err);
-  }
-}
-function isEnoent(err) {
-  return err !== null && typeof err === "object" && "code" in err && err.code === "ENOENT";
-}
-async function cleanupTempFile(tempPath) {
-  try {
-    await rm(tempPath, { force: true });
-  } catch {}
-}
-
-// src/store.ts
-function createStore(options) {
-  const { dirPath, name, fields } = options;
-  const filePath = resolveStorePath(dirPath, name);
-  async function read() {
-    const persisted = await readJson(filePath);
-    return applyFieldDefaults(persisted, fields);
-  }
-  async function write(config) {
-    await writeJson(filePath, config);
-  }
-  async function update(updater) {
-    const current = await read();
-    const updated = updater(current);
-    await writeJson(filePath, updated);
-  }
-  async function reset() {
-    await deleteJson(filePath);
-  }
-  return { read, write, update, reset };
-}
-export {
-  createStore,
-  configDir,
-  CrustStoreError
-};
+class K extends Error{code;details;cause;constructor(q,B,z){super(B);this.name="CrustStoreError",this.code=q,this.details=z}is(q){return this.code===q}withCause(q){return this.cause=q,this}}import{homedir as f}from"os";import{join as Q}from"path";var P="config";function _(){return{platform:process.platform,env:process.env,homedir:f()}}function T(q){if(!q||q.trim().length===0)throw new K("PATH","appName must be a non-empty string",{path:q??""});if(q.includes("/")||q.includes("\\"))throw new K("PATH","appName must not contain path separators",{path:q})}function h(q){if(!q||q.trim().length===0)throw new K("PATH","name must be a non-empty string",{path:q??""});if(q.includes("/")||q.includes("\\"))throw new K("PATH","name must not contain path separators",{path:q});if(q.endsWith(".json"))throw new K("PATH","name must not include the .json extension",{path:q})}function v(q){if(!q||q.trim().length===0)throw new K("PATH","dirPath must be a non-empty string",{path:q??""});if(!(q.startsWith("/")||/^[A-Za-z]:[/\\]/.test(q)))throw new K("PATH","dirPath must be an absolute path",{path:q});if(q.endsWith(".json"))throw new K("PATH","dirPath must be a directory path, not a file path (should not end with .json)",{path:q})}function F(q,B,z,G){let H=q.env[B],W=H&&H.trim().length>0?H:Q(q.homedir,...z);return Q(W,G)}function O(q){throw new K("PATH",`Unsupported platform: ${q}`,{path:q})}function m(q,B){T(q);let z=B??_();switch(z.platform){case"linux":case"darwin":return F(z,"XDG_CONFIG_HOME",[".config"],q);case"win32":{let G=z.env.APPDATA,H=G&&G.trim().length>0?G:Q(z.homedir,"AppData","Roaming");return Q(H,q)}default:O(z.platform)}}function u(q,B){T(q);let z=B??_();switch(z.platform){case"linux":case"darwin":return F(z,"XDG_DATA_HOME",[".local","share"],q);case"win32":{let G=z.env.LOCALAPPDATA,H=G&&G.trim().length>0?G:Q(z.homedir,"AppData","Local");return Q(H,q,"Data")}default:O(z.platform)}}function d(q,B){T(q);let z=B??_();switch(z.platform){case"linux":case"darwin":return F(z,"XDG_STATE_HOME",[".local","state"],q);case"win32":{let G=z.env.LOCALAPPDATA,H=G&&G.trim().length>0?G:Q(z.homedir,"AppData","Local");return Q(H,q,"State")}default:O(z.platform)}}function o(q,B){T(q);let z=B??_();switch(z.platform){case"linux":case"darwin":return F(z,"XDG_CACHE_HOME",[".cache"],q);case"win32":{let G=z.env.LOCALAPPDATA,H=G&&G.trim().length>0?G:Q(z.homedir,"AppData","Local");return Q(H,q,"Cache")}default:O(z.platform)}}function b(q,B){v(q);let z=B??P;if(B!==void 0)h(B);return Q(q,`${z}.json`)}function V(q){return q!==null&&typeof q==="object"&&!Array.isArray(q)}function x(q){if(Array.isArray(q))return[...q];if(V(q)){let B={};for(let[z,G]of Object.entries(q))B[z]=x(G);return B}return q}function J(q,B,z=!0){let G={};for(let[H,W]of Object.entries(B))if(q!==void 0&&H in q){let X=q[H];if(V(W)&&V(X))G[H]=J(X,W,z);else G[H]=x(X)}else G[H]=x(W);if(!z&&q!==void 0){for(let[H,W]of Object.entries(q))if(!(H in B))G[H]=x(W)}return G}import{randomUUID as s}from"crypto";import{mkdir as i,readFile as p,rename as n,rm as l,unlink as t,writeFile as r}from"fs/promises";import{dirname as a,join as e}from"path";async function j(q){let B;try{B=await p(q,"utf-8")}catch(z){if(D(z))return;throw new K("IO",`Failed to read config file: ${q}`,{path:q,operation:"read"}).withCause(z)}try{return JSON.parse(B)}catch(z){throw new K("PARSE",`Malformed JSON in config file: ${q}`,{path:q}).withCause(z)}}async function R(q,B){let z=a(q),G=e(z,`.config-${s()}.tmp`);try{await i(z,{recursive:!0})}catch(H){throw new K("IO",`Failed to create config directory: ${z}`,{path:q,operation:"write"}).withCause(H)}try{let H=JSON.stringify(B,null,"\t");await r(G,H,"utf-8")}catch(H){throw await U(G),new K("IO",`Failed to write config file: ${q}`,{path:q,operation:"write"}).withCause(H)}try{await n(G,q)}catch(H){throw await U(G),new K("IO",`Failed to finalize config file: ${q}`,{path:q,operation:"write"}).withCause(H)}}async function A(q){try{await t(q)}catch(B){if(D(B))return;throw new K("IO",`Failed to delete config file: ${q}`,{path:q,operation:"delete"}).withCause(B)}}function D(q){return q!==null&&typeof q==="object"&&"code"in q&&q.code==="ENOENT"}async function U(q){try{await l(q,{force:!0})}catch{}}function qq(q){let{dirPath:B,name:z,defaults:G,validator:H,pruneUnknown:W}=q,X=b(B,z),C=W??!0;async function M(L,Y){if(!H)return L;let Z=await H(L);if(Z.ok)return Z.value;let I=Z.issues.map(($)=>({message:$.message,path:$.path})),y=I.map(($)=>$.path?`  - ${$.path}: ${$.message}`:`  - ${$.message}`),N=y.length>0?`Store validation failed (${Y})
+${y.join(`
+`)}`:`Store validation failed (${Y})`;throw new K("VALIDATION",N,{operation:Y,issues:I})}async function S(){let L=await j(X);return J(L,G,C)}async function k(){let L=await S();return M(L,"read")}async function g(L){let Y=await M(L,"write");await R(X,Y)}async function c(L){let Y=await S(),Z=L(Y),I=await M(Z,"update");await R(X,I)}async function w(L){let Y=await S(),Z=J(L,Y,!1),I=await M(Z,"patch");await R(X,I)}async function E(){await A(X)}return{read:k,write:g,update:c,patch:w,reset:E}}export{d as stateDir,u as dataDir,qq as createStore,m as configDir,o as cacheDir,K as CrustStoreError};

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@crustjs/store",
-	"version": "0.0.1",
-	"description": "Minimal, type-safe config persistence for CLI apps",
+	"version": "0.0.3",
+	"description": "DX-first, typed persistence for CLI apps with config/data/state/cache separation",
 	"type": "module",
 	"license": "MIT",
 	"author": "chenxin-yan",
@@ -17,8 +17,12 @@
 	"keywords": [
 		"cli",
 		"config",
+		"data",
+		"state",
+		"cache",
 		"store",
 		"persistence",
+		"xdg",
 		"bun",
 		"typescript"
 	],