@bepalo/spine 1.5.17 → 2.7.19

package/dist/generator.d.ts

@@ -1,10 +1,23 @@
+import { MimeType } from "./types.ts";
 import { DirWalkNode } from "./utils.ts";
+export interface GenerateStaticRoutesParams {
+    routesPath: string;
+    importRoot: string;
+    usePathForIdGeneration?: boolean;
+    importExtensions?: boolean | {
+        (name: string): string;
+    };
+    pattern?: RegExp;
+    dirPattern?: RegExp;
+    processName?: (name: string) => string;
+    onError?: (error: Error | unknown, node: DirWalkNode) => boolean | void;
+}
 /**
  * Generate static import for file-structure defined routes.
  * This is useful for integration with frameworks such as Nexts and cloudflare
  * and production in general.
  *
- * @param options Options for static routes import generator. eg. './routes'
+ * @param {object} options Options for static routes import generator. eg. './routes'
  * @param {string} options.routesPath The root path of the routes.
  * @param {string} options.importRoot The import root-prefix to use in the generated imports.
  *   `importRoot: ''` -> `import ... from 'api/index.ts';`
@@ -23,10 +36,10 @@ import { DirWalkNode } from "./utils.ts";
  * @example
  *
  * ```
- *  import { generateStaticRoutesImporter } from "@bepalo/spine";
+ *  import { generateStaticRoutes } from "@bepalo/spine";
  *  import { hash } from "node:crypto";
  *
- *  await generateStaticRoutesImporter({
+ *  await generateStaticRoutes({
  *    routesPath: "./routes",
  *    importRoot: "./routes/",
  *    pattern: /route\.(?:ts|js|mjs)$/, // match only routes ending with .route.ts...
@@ -39,29 +52,139 @@ import { DirWalkNode } from "./utils.ts";
  *    // update generated import file if the hash changed.
  *    const f = Bun.file(output);
  *    if (await f.exists()) {
- *      if (hash("sha1", c, "hex") != hash("sha1", await f.text(), "hex")) {
+ *      if (hash("md5", c, "hex") != hash("md5", await f.text(), "hex")) {
  *        Bun.write(output, c);
- *        console.log(new Date().getTime(), "[SPINE-GEN]", c.length, `'${output}'`);
+ *        console.log(timestamp(), "[SPINE-GEN]", c.length, `'${output}'`);
  *      }
  *    } else {
  *      Bun.write(output, c);
- *      console.log(new Date().getTime(), "[SPINE-GEN]", c.length, `'${output}'`);
+ *      console.log(timestamp(), "[SPINE-GEN]", c.length, `'${output}'`);
  *    }
  *  });
  *  ```
  *
  */
-export declare const generateStaticRoutesImporter: ({ routesPath, importRoot, usePathForIdGeneration, importExtensions, pattern, dirPattern, processName, onError, }: {
-    routesPath: string;
-    importRoot: string;
-    usePathForIdGeneration?: boolean;
-    importExtensions?: boolean | {
-        (name: string): string;
-    };
-    pattern?: RegExp;
-    dirPattern?: RegExp;
-    processName?: (name: string) => string;
-    onError?: (error: Error | unknown, node: DirWalkNode) => boolean | void;
-}) => Promise<string>;
-export default generateStaticRoutesImporter;
+export declare const generateStaticRoutes: ({ routesPath, importRoot, usePathForIdGeneration, importExtensions, pattern, dirPattern, processName, onError, }: GenerateStaticRoutesParams) => Promise<string>;
+export type GenerateStaticRoutesWatcherParams = {
+    read: (filename: string) => Promise<string> | string;
+    write: (filename: string, content: string) => Promise<void | unknown> | void | unknown;
+    output: string;
+    abortSignal?: AbortSignal;
+    generateDelay?: number;
+    timestamp?: () => string | number | unknown;
+    logger?: (...args: any[]) => unknown;
+} & GenerateStaticRoutesParams;
+/**
+ *
+ * @param {object} options Options include `generateStaticRoutes` options too.
+ * @param {output} [options.output='./routes.ts'] Output file path. deafult: `'./routes.ts'`
+ * @param {number} [options.generateDelay=1000] Time in milliseconds to delay generation on change. default: `1000` -> 1s
+ * @param {AbortSignal} options.abortSignal Abort signal.
+ * @param {(filename:string)=>Promise<string>|string} options.read Function to read from file.
+ * @param {(filename:string,content:string)=>Promise<void|unknown>|void|unknown} options.write Function to write to file.
+ * @param {()=>string|number|unknown} options.timestamp Override default log timestamp.
+ * @param {(...args:any[])=>unknown} options.logger Override logger.
+ *
+ * @example
+ * generateStaticRoutesWatcher({
+ *   routesPath: "./routes",
+ *   importRoot: "./routes/",
+ *   output: "./routes.ts",
+ *   abortSignal: abortController.signal,
+ *   read: (filepath) => readFile(filepath, { encoding: "utf-8" }),
+ *   write: (filepath, content) =>
+ *     writeFile(filepath, content, { encoding: "utf-8" }),
+ *   // generateDelay: 1000,
+ * });
+ *
+ */
+export declare const generateStaticRoutesWatcher: ({ read, write, abortSignal, generateDelay, output, timestamp, logger, pattern, dirPattern, ...params }: GenerateStaticRoutesWatcherParams) => Promise<void>;
+export interface StaticAssetsManifestFile {
+    pathname: string;
+    name: string;
+    ext: string;
+    path: string;
+    relativePath: string;
+    size: number;
+    mtime: number;
+    contentType: string;
+}
+export interface StaticAssetsManifest {
+    version: string;
+    generatedAt: string;
+    files: Record<string, StaticAssetsManifestFile>;
+}
+export interface GenerateStaticAssetsManifestFileInfo {
+    name: string;
+    ext: string;
+    relativePath: string;
+    parent: string;
+    size: number;
+    mtime: number;
+    contentType: MimeType;
+}
+export interface GenerateStaticAssetsParams {
+    assetsPath: string;
+    sortOrder?: -1 | 1;
+    exclude?: (fileInfo: GenerateStaticAssetsManifestFileInfo) => boolean | void;
+    transformPathname?: (fileInfo: GenerateStaticAssetsManifestFileInfo) => string;
+}
+export declare const defaultPathnameTransformer: ({ name, ext, relativePath, }: GenerateStaticAssetsManifestFileInfo) => string;
+/**
+ * Static assets manifest generator. Primarily intended for use with static file serving.
+ *
+ * @description Generates an asset manifest of static assets under the given path.
+ * It gathers the name, extension, paths, size, modification-time and content-type of the assets.
+ *
+ * @param {object} options Options for the static assets manifest generator.
+ * @param {string} options.assetsPath Root path of the static assets.
+ * @param {-1|1|undefined} options.sortOrder Enable and set the sort order of file entries by their pathname.
+ * @param {(fileInfo:GenerateStaticAssetsManifestFileInfo)=>boolean|void} options.exclude Function to exclude files. Returning `true` means skip file.
+ * @param {(fileInfo: GenerateStaticAssetsManifestFileInfo)=>string} options.transformPathname Override function to transform the pathname.
+ * @returns {Promise<StaticAssetsManifest>} The generated static asset manifest.
+ *
+ * @example
+ * generateStaticAssetsManifest({
+ *   assetsPath: "./public",
+ *   // exclude: ({ name, ext }) => !name || ext === ".private",
+ *   // transformPathname: ({ name, parent }) =>
+ *   //    name === index && ext == ".html" ? `/${parent}` : `/${parent}/${name}`
+ * });
+ */
+export declare const generateStaticAssetsManifest: ({ assetsPath, sortOrder, exclude, transformPathname, }: GenerateStaticAssetsParams) => Promise<StaticAssetsManifest>;
+export type GenerateStaticAssetsManifestWatcherParams = {
+    read: (filename: string) => Promise<string> | string;
+    write: (filename: string, content: string) => Promise<void | unknown> | void | unknown;
+    output: string;
+    abortSignal?: AbortSignal;
+    generateDelay?: number;
+    timestamp?: () => string | number | unknown;
+    logger?: (...args: any[]) => unknown;
+} & GenerateStaticAssetsParams;
+/**
+ *
+ * @param options Options include `generateStaticAssets` options too.
+ * @param {output} [options.output='./static-assets.json'] Output file path. default: `'./static-assets.json'`
+ * @param {number} [options.generateDelay=1000] Time in milliseconds to delay generation on change. default: `1000` -> 1s
+ * @param {AbortSignal} options.abortSignal Abort signal.
+ * @param {(filename:string)=>Promise<string>|string} options.read Function to read from file.
+ * @param {(filename:string,content:string)=>Promise<void|unknown>|void|unknown} options.write Function to write to file.
+ * @param {()=>string|number|unknown} options.timestamp Override default log timestamp.
+ * @param {(...args:any[])=>unknown} options.logger Override logger.
+ *
+ * @example
+ * generateStaticAssetsManifestWatcher({
+ *   assetsPath: "./public",
+ *   output: "./static-assets.json",
+ *   // sortOrder: 1,
+ *   // exclude: ({ name, ext }) => !name || ext === ".private",
+ *   // generateDelay: 1000,
+ *   read: (filepath) => readFile(filepath, { encoding: "utf-8" }),
+ *   write: (filepath, content) =>
+ *     writeFile(filepath, content, { encoding: "utf-8" }),
+ *   abortSignal: abortController.signal,
+ * });
+ *
+ */
+export declare const generateStaticAssetsManifestWatcher: ({ read, write, abortSignal, generateDelay, output, timestamp, logger, exclude, ...params }: GenerateStaticAssetsManifestWatcherParams) => Promise<void>;
 //# sourceMappingURL=generator.d.ts.map

package/dist/generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAwFzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,eAAO,MAAM,4BAA4B,GAAU,kHAShD;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,gBAAgB,CAAC,EAAE,OAAO,GAAG;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACvC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,GAAG,IAAI,CAAC;CACzE,KAAG,OAAO,CAAC,MAAM,CA2GjB,CAAC;AAEF,eAAe,4BAA4B,CAAC"}
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AAEA,OAAO,EAOL,QAAQ,EAGT,MAAM,YAAY,CAAC;AAOpB,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAKzC,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,gBAAgB,CAAC,EAAE,OAAO,GAAG;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACvC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,GAAG,IAAI,CAAC;CACzE;AAoGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,eAAO,MAAM,oBAAoB,GAAU,kHASxC,0BAA0B,KAAG,OAAO,CAAC,MAAM,CA8G7C,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IACrD,KAAK,EAAE,CACL,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,KACZ,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAC5C,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC;CACtC,GAAG,0BAA0B,CAAC;AAE/B;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,2BAA2B,GAAU,wGAW/C,iCAAiC,KAAG,OAAO,CAAC,IAAI,CA+ElD,CAAC;AAIF,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,QAAQ,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,oCAAoC,KAAK,OAAO,GAAG,IAAI,CAAC;IAC7E,iBAAiB,CAAC,EAAE,CAClB,QAAQ,EAAE,oCAAoC,KAC3C,MAAM,CAAC;CACb;AAED,eAAO,MAAM,0BAA0B,GAAI,8BAIxC,oCAAoC,WAMtC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,4BAA4B,GAAU,wDAKhD,0BAA0B,KAAG,OAAO,CAAC,oBAAoB,CAmE3D,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IACrD,KAAK,EAAE,CACL,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,KACZ,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAC5C,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC;CACtC,GAAG,0BAA0B,CAAC;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,mCAAmC,GAAU,4FAUvD,yCAAyC,KAAG,OAAO,CAAC,IAAI,CAoH1D,CAAC"}