@kubb/core 5.6.0 → 5.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -367,6 +367,33 @@ export declare const cacheStorage: (options?: CacheStorageOptions | undefined) =
367
367
  */
368
368
  export declare const fsStorage: (options?: Record<string, never> | undefined) => Storage;
369
369
  //#endregion
370
+ //#region src/storages/kubbStorage.d.ts
371
+ type KubbStorageOptions = {
372
+ /**
373
+ * Folder inside the Kubb home, or an absolute path such as `<cwd>/.kubb`.
374
+ */
375
+ base?: string;
376
+ };
377
+ /**
378
+ * Folder Kubb keeps its own files in, created with mode 0700. `base` resolves inside `KUBB_HOME`
379
+ * (default `~/.kubb`). When that folder is not writable, it falls back to a folder in the OS temp directory.
380
+ *
381
+ * @example
382
+ * `resolveKubbDir('cache') // '/home/me/.kubb/cache'`
383
+ */
384
+ export declare function resolveKubbDir(base?: string): string;
385
+ /**
386
+ * unstorage on the fs driver, rooted at {@link resolveKubbDir}. The fs driver cannot set a file
387
+ * mode, so the 0700 folder keeps files such as a stored token private.
388
+ *
389
+ * @example
390
+ * ```ts
391
+ * const storage = kubbStorage({ base: 'cache' })
392
+ * await storage.setItem('machine-secret', secret)
393
+ * ```
394
+ */
395
+ export declare function kubbStorage({ base }?: KubbStorageOptions): import("unstorage").Storage<import("unstorage").StorageValue>;
396
+ //#endregion
370
397
  //#region src/storages/memoryStorage.d.ts
371
398
  /**
372
399
  * In-memory storage driver. Useful for testing and dry-run scenarios where
package/dist/index.js CHANGED
@@ -8,9 +8,11 @@ import { glob, readFile, rm } from "node:fs/promises";
8
8
  import path, { join, relative, resolve } from "node:path";
9
9
  import { ast, collectImportedRefNames, collectUsedSchemaNames, composeMacros, operationDef, schemaDef, transform } from "@kubb/ast";
10
10
  import { hash, randomUUID } from "node:crypto";
11
- import { existsSync } from "node:fs";
12
- import { tmpdir } from "node:os";
11
+ import { chmodSync, existsSync, mkdirSync } from "node:fs";
12
+ import { homedir, tmpdir } from "node:os";
13
13
  import { createInterface } from "node:readline";
14
+ import { createStorage as createStorage$1 } from "unstorage";
15
+ import fsDriver from "unstorage/drivers/fs";
14
16
  import { fileURLToPath } from "node:url";
15
17
  //#region src/createAdapter.ts
16
18
  /**
@@ -238,7 +240,7 @@ function formatMs(ms) {
238
240
  }
239
241
  //#endregion
240
242
  //#region package.json
241
- var version = "5.6.0";
243
+ var version = "5.6.1";
242
244
  //#endregion
243
245
  //#region src/constants.ts
244
246
  /**
@@ -2897,6 +2899,44 @@ function createCliReporter({ render = consoleRenderer } = {}) {
2897
2899
  */
2898
2900
  const cliReporter = createCliReporter();
2899
2901
  //#endregion
2902
+ //#region src/storages/kubbStorage.ts
2903
+ function ensurePrivateDir(dir) {
2904
+ mkdirSync(dir, {
2905
+ recursive: true,
2906
+ mode: 448
2907
+ });
2908
+ chmodSync(dir, 448);
2909
+ return dir;
2910
+ }
2911
+ /**
2912
+ * Folder Kubb keeps its own files in, created with mode 0700. `base` resolves inside `KUBB_HOME`
2913
+ * (default `~/.kubb`). When that folder is not writable, it falls back to a folder in the OS temp directory.
2914
+ *
2915
+ * @example
2916
+ * `resolveKubbDir('cache') // '/home/me/.kubb/cache'`
2917
+ */
2918
+ function resolveKubbDir(base = "") {
2919
+ const dir = resolve(process$1.env.KUBB_HOME ?? join(homedir(), ".kubb"), base);
2920
+ try {
2921
+ return ensurePrivateDir(dir);
2922
+ } catch {
2923
+ return ensurePrivateDir(join(tmpdir(), "kubb", hash("sha256", dir).slice(0, 16)));
2924
+ }
2925
+ }
2926
+ /**
2927
+ * unstorage on the fs driver, rooted at {@link resolveKubbDir}. The fs driver cannot set a file
2928
+ * mode, so the 0700 folder keeps files such as a stored token private.
2929
+ *
2930
+ * @example
2931
+ * ```ts
2932
+ * const storage = kubbStorage({ base: 'cache' })
2933
+ * await storage.setItem('machine-secret', secret)
2934
+ * ```
2935
+ */
2936
+ function kubbStorage({ base } = {}) {
2937
+ return createStorage$1({ driver: fsDriver({ base: resolveKubbDir(base) }) });
2938
+ }
2939
+ //#endregion
2900
2940
  //#region src/reporters/fileReporter.ts
2901
2941
  /**
2902
2942
  * Builds the `## Summary` section: the same counts the cli and json reporters expose, as a list of
@@ -2973,12 +3013,12 @@ const fileReporter = createReporter({
2973
3013
  const content = stripVTControlCharacters([header, ...sections.map((section) => section.join("\n"))].join("\n\n"));
2974
3014
  const baseName = `${[
2975
3015
  "kubb",
2976
- config.name,
3016
+ config.name?.replace(/[^a-zA-Z0-9_-]+/g, "-").replace(/^-+|-+$/g, ""),
2977
3017
  Date.now()
2978
3018
  ].filter(Boolean).join("-")}.log`;
2979
- const pathName = resolve(process$1.cwd(), ".kubb", baseName);
2980
- await write(pathName, `${content}\n`);
2981
- console.error(`Debug log written to ${relative(process$1.cwd(), pathName)}`);
3019
+ const dir = resolveKubbDir(resolve(process$1.cwd(), ".kubb"));
3020
+ await kubbStorage({ base: dir }).setItem(baseName, `${content}\n`);
3021
+ console.error(`Debug log written to ${relative(process$1.cwd(), join(dir, baseName))}`);
2982
3022
  }
2983
3023
  });
2984
3024
  //#endregion
@@ -3020,15 +3060,16 @@ const htmlReporter = createReporter({
3020
3060
  result.config.name?.replace(/[^a-zA-Z0-9_-]+/g, "-").replace(/^-+|-+$/g, ""),
3021
3061
  Date.now()
3022
3062
  ].filter(Boolean).join("-");
3023
- const pathName = resolve(process.cwd(), ".kubb", baseName);
3063
+ const dir = resolveKubbDir(resolve(process.cwd(), ".kubb"));
3064
+ const storage = kubbStorage({ base: dir });
3024
3065
  const assets = new URL("./html/", import.meta.url);
3025
3066
  const [html, ui] = await Promise.all([read(fileURLToPath(new URL("index.html", assets))), read(fileURLToPath(new URL("ui.iife.js", assets)))]);
3026
3067
  await Promise.all([
3027
- write(resolve(pathName, "index.html"), html),
3028
- write(resolve(pathName, "ui.iife.js"), ui),
3029
- write(resolve(pathName, "data.js"), serializeReport(result))
3068
+ storage.setItem(`${baseName}/index.html`, html),
3069
+ storage.setItem(`${baseName}/ui.iife.js`, ui),
3070
+ storage.setItem(`${baseName}/data.js`, serializeReport(result))
3030
3071
  ]);
3031
- const reportPath = resolve(pathName, "index.html");
3072
+ const reportPath = join(dir, baseName, "index.html");
3032
3073
  console.error(`HTML report written to ${relative(process.cwd(), reportPath)}`);
3033
3074
  openInBrowser(reportPath);
3034
3075
  }
@@ -3183,6 +3224,6 @@ const memoryStorage = createStorage(() => {
3183
3224
  };
3184
3225
  });
3185
3226
  //#endregion
3186
- export { Diagnostics, Hookable, KubbDriver, Resolver, applyConfigDefaults, cacheStorage, cliReporter, createAdapter, createCliReporter, createKubb, createRenderer, createReporter, createResolver, createStorage, defineGenerator, defineParser, definePlugin, fileReporter, fsStorage, getInputKind, htmlReporter, jsonReporter, logLevel, memoryStorage, resolveCacheDir, runHook, runOutputPasses };
3227
+ export { Diagnostics, Hookable, KubbDriver, Resolver, applyConfigDefaults, cacheStorage, cliReporter, createAdapter, createCliReporter, createKubb, createRenderer, createReporter, createResolver, createStorage, defineGenerator, defineParser, definePlugin, fileReporter, fsStorage, getInputKind, htmlReporter, jsonReporter, kubbStorage, logLevel, memoryStorage, resolveCacheDir, resolveKubbDir, runHook, runOutputPasses };
3187
3228
 
3188
3229
  //# sourceMappingURL=index.js.map