algolia-codegen 0.1.2 → 0.1.3

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 nightlightmare
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -1,12 +1,20 @@
 # Algolia Type Generator
 
+[![npm version](https://img.shields.io/npm/v/algolia-codegen.svg?style=flat-square)](https://www.npmjs.com/package/algolia-codegen)
+[![npm downloads](https://img.shields.io/npm/dm/algolia-codegen.svg?style=flat-square)](https://www.npmjs.com/package/algolia-codegen)
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/algolia-codegen?style=flat-square)](https://bundlephobia.com/package/algolia-codegen)
+[![GitHub stars](https://img.shields.io/github/stars/nightlightmare/algolia-codegen.svg?style=flat-square&logo=github)](https://github.com/nightlightmare/algolia-codegen)
+[![GitHub issues](https://img.shields.io/github/issues/nightlightmare/algolia-codegen.svg?style=flat-square&logo=github)](https://github.com/nightlightmare/algolia-codegen/issues)
+[![GitHub license](https://img.shields.io/github/license/nightlightmare/algolia-codegen.svg?style=flat-square)](https://github.com/nightlightmare/algolia-codegen/blob/main/LICENSE)
+[![Node.js version](https://img.shields.io/node/v/algolia-codegen.svg?style=flat-square)](https://nodejs.org/)
+
 This script automatically generates TypeScript types from your Algolia indices by fetching sample records and analyzing their structure. It supports multiple indices and flexible configuration through a config file.
 
 **Repository**: [https://github.com/nightlightmare/algolia-codegen](https://github.com/nightlightmare/algolia-codegen)
 
 ## Prerequisites
 
-- Node.js >= 18
+- Node.js >= 20
 - Algolia account with at least one index
 
 ## Installation
@@ -30,17 +38,17 @@ yarn add algolia-codegen
 1. Create a configuration file named `algolia-codegen.ts` (or `.js`) in your project root:
 
 ```typescript
-import type { AlgoliaCodegenConfig } from "algolia-codegen";
+import type { AlgoliaCodegenConfig } from 'algolia-codegen';
 
 const config: AlgoliaCodegenConfig = {
   overwrite: true,
   generates: {
-    "src/algolia/types.ts": {
-      appId: "YOUR_APP_ID",
-      searchKey: "YOUR_SEARCH_API_KEY",
-      indexName: "products",
-      prefix: "Algolia", // Optional
-      postfix: "Type", // Optional
+    'src/algolia/types.ts': {
+      appId: 'YOUR_APP_ID',
+      searchKey: 'YOUR_SEARCH_API_KEY',
+      indexName: 'products',
+      prefix: 'Algolia', // Optional
+      postfix: 'Type', // Optional
     },
   },
 };
@@ -65,17 +73,17 @@ npx algolia-codegen
 Create a configuration file named `algolia-codegen.ts` (or `.js`) in your project root. The config file should export a default object with the following structure:
 
 ```typescript
-import type { AlgoliaCodegenConfig } from "algolia-codegen";
+import type { AlgoliaCodegenConfig } from 'algolia-codegen';
 
 const config: AlgoliaCodegenConfig = {
   overwrite: true,
   generates: {
-    "src/algolia/types.ts": {
-      appId: "YOUR_APP_ID",
-      searchKey: "YOUR_SEARCH_API_KEY",
-      indexName: "products",
-      prefix: "Algolia", // Optional
-      postfix: "Type", // Optional
+    'src/algolia/types.ts': {
+      appId: 'YOUR_APP_ID',
+      searchKey: 'YOUR_SEARCH_API_KEY',
+      indexName: 'products',
+      prefix: 'Algolia', // Optional
+      postfix: 'Type', // Optional
     },
   },
 };
@@ -91,15 +99,15 @@ You can generate types for multiple indices:
 const config: AlgoliaCodegenConfig = {
   overwrite: true,
   generates: {
-    "src/algolia/products.ts": {
-      appId: "YOUR_APP_ID",
-      searchKey: "YOUR_SEARCH_API_KEY",
-      indexName: "products",
+    'src/algolia/products.ts': {
+      appId: 'YOUR_APP_ID',
+      searchKey: 'YOUR_SEARCH_API_KEY',
+      indexName: 'products',
     },
-    "src/algolia/users.ts": {
-      appId: "YOUR_APP_ID",
-      searchKey: "YOUR_SEARCH_API_KEY",
-      indexName: "users",
+    'src/algolia/users.ts': {
+      appId: 'YOUR_APP_ID',
+      searchKey: 'YOUR_SEARCH_API_KEY',
+      indexName: 'users',
     },
   },
 };
@@ -114,17 +122,17 @@ const config: AlgoliaCodegenConfig = {
   overwrite: true,
   generates: [
     {
-      "src/algolia/products.ts": {
-        appId: "YOUR_APP_ID",
-        searchKey: "YOUR_SEARCH_API_KEY",
-        indexName: "products",
+      'src/algolia/products.ts': {
+        appId: 'YOUR_APP_ID',
+        searchKey: 'YOUR_SEARCH_API_KEY',
+        indexName: 'products',
       },
     },
     {
-      "src/algolia/users.ts": {
-        appId: "YOUR_APP_ID",
-        searchKey: "YOUR_SEARCH_API_KEY",
-        indexName: "users",
+      'src/algolia/users.ts': {
+        appId: 'YOUR_APP_ID',
+        searchKey: 'YOUR_SEARCH_API_KEY',
+        indexName: 'users',
       },
     },
   ],
@@ -187,13 +195,13 @@ type AlgoliaCodegenGeneratorConfig = {
    - Fetches a sample record from the specified index
    - Analyzes the record structure and generates TypeScript types
    - Creates a single TypeScript file containing all types found in the index
-3. **Type Generation**: The generator automatically:
+4. **Type Generation**: The generator automatically:
    - Infers types from the sample record structure
    - Handles nested objects, arrays, and complex types
    - Detects and generates generic `IdValue<T>` types for Algolia's id-value pattern arrays
    - Generates proper TypeScript interfaces with JSDoc comments
    - Sorts types by dependencies for correct ordering
-4. **Error Handling**: Continues processing other files even if one fails, with detailed error messages
+5. **Error Handling**: Continues processing other files even if one fails, with detailed error messages
 
 Each generated file contains all types found in the index, including nested types, properly organized and sorted by dependencies.
 
@@ -213,44 +221,11 @@ Each generated file contains all types found in the index, including nested type
 
 ## Examples
 
-### Generated Type Example
-
-Given an Algolia record like:
-
-```json
-{
-  "objectID": "123",
-  "name": "Product Name",
-  "price": 99.99,
-  "tags": ["tag1", "tag2"],
-  "metadata": {
-    "category": "electronics",
-    "rating": 4.5
-  }
-}
-```
-
-The generator will create TypeScript types:
-
-```typescript
-/**
- * Generated TypeScript types for Algolia index: products
- * This file is auto-generated. Do not edit manually.
- */
-
-export interface AlgoliaHitType {
-  metadata: AlgoliaMetadataType;
-  name: string;
-  objectID: string;
-  price: number;
-  tags: string[];
-}
-
-export interface AlgoliaMetadataType {
-  category: string;
-  rating: number;
-}
-```
+See the [examples directory](./examples/) for comprehensive examples including:
+- Framework integrations (Next.js, React, Vue)
+- CI/CD integration (GitHub Actions)
+- Custom prefixes/postfixes
+- Multiple indices configuration
 
 ## Repository
 

package/dist/{chunk-R66ECGLW.js → chunk-4T5DZK75.js}

@@ -11,7 +11,7 @@ async function loadTypeScriptConfig(resolvedPath) {
   const result = esbuild.transformSync(source, {
     loader: "ts",
     format: "esm",
-    target: "node18",
+    target: "node20",
     sourcefile: resolvedPath
   });
   if (!result.code) {
@@ -25,10 +25,8 @@ async function loadTypeScriptConfig(resolvedPath) {
 // src/utils/validations/generator-config.ts
 function validateGeneratorConfig(config, path) {
   if (typeof config !== "object" || config === null || Array.isArray(config)) {
-    throw new Error(
-      `Invalid generator config: must be an object
-Path: ${path}`
-    );
+    throw new Error(`Invalid generator config: must be an object
+Path: ${path}`);
   }
   const cfg = config;
   const requiredFields = [
@@ -70,10 +68,8 @@ Received: ${typeof cfg.postfix}`
 // src/utils/validations/url-schema.ts
 function validateUrlSchema(urlSchema, path) {
   if (typeof urlSchema !== "object" || urlSchema === null || Array.isArray(urlSchema)) {
-    throw new Error(
-      `Invalid generates entry: must be an object
-Path: ${path}`
-    );
+    throw new Error(`Invalid generates entry: must be an object
+Path: ${path}`);
   }
   const schema = urlSchema;
   for (const [filePath, generatorConfig] of Object.entries(schema)) {
@@ -90,10 +86,8 @@ Path: ${path}[${filePath}]`
 // src/utils/validations/config.ts
 function validateConfig(config, configPath) {
   if (typeof config !== "object" || config === null || Array.isArray(config)) {
-    throw new Error(
-      `Invalid config: must be an object
-Config file: ${configPath}`
-    );
+    throw new Error(`Invalid config: must be an object
+Config file: ${configPath}`);
   }
   const cfg = config;
   if (!("overwrite" in cfg)) {
@@ -174,10 +168,8 @@ Make sure esbuild is installed as a dependency.`
       configModule = await import(configUrl);
     } catch (importError) {
       const errorMessage = importError instanceof Error ? importError.message : String(importError);
-      throw new Error(
-        `Failed to import config file: ${resolvedPath}
-Error: ${errorMessage}`
-      );
+      throw new Error(`Failed to import config file: ${resolvedPath}
+Error: ${errorMessage}`);
     }
   }
   if (!configModule.default) {
@@ -306,7 +298,7 @@ var TypeGenerator = class {
       return `${this.prefix}Hit${this.postfix}`;
     }
     const lastPart = path[path.length - 1];
-    const parts = lastPart.replace(/[\[\]]/g, "").split(/[-_\s]+/).filter(Boolean);
+    const parts = lastPart.replace(/[[\]]/g, "").split(/[-_\s]+/).filter(Boolean);
     const pascalCase = parts.map((part) => part.charAt(0).toUpperCase() + part.slice(1).toLowerCase()).join("");
     if (path.length > 1) {
       const parent = path[path.length - 2];
@@ -472,10 +464,7 @@ Set overwrite: true in config to allow overwriting existing files.`
   console.log(`App ID: ${generatorConfig.appId}`);
   let client;
   try {
-    client = algoliasearch(
-      generatorConfig.appId,
-      generatorConfig.searchKey
-    );
+    client = algoliasearch(generatorConfig.appId, generatorConfig.searchKey);
   } catch (error) {
     throw new Error(
       `Failed to initialize Algolia client: ${error instanceof Error ? error.message : String(error)}`

package/dist/cli.cjs

@@ -42,7 +42,7 @@ async function loadTypeScriptConfig(resolvedPath) {
   const result = esbuild.transformSync(source, {
     loader: "ts",
     format: "esm",
-    target: "node18",
+    target: "node20",
     sourcefile: resolvedPath
   });
   if (!result.code) {
@@ -56,10 +56,8 @@ async function loadTypeScriptConfig(resolvedPath) {
 // src/utils/validations/generator-config.ts
 function validateGeneratorConfig(config, path) {
   if (typeof config !== "object" || config === null || Array.isArray(config)) {
-    throw new Error(
-      `Invalid generator config: must be an object
-Path: ${path}`
-    );
+    throw new Error(`Invalid generator config: must be an object
+Path: ${path}`);
   }
   const cfg = config;
   const requiredFields = [
@@ -101,10 +99,8 @@ Received: ${typeof cfg.postfix}`
 // src/utils/validations/url-schema.ts
 function validateUrlSchema(urlSchema, path) {
   if (typeof urlSchema !== "object" || urlSchema === null || Array.isArray(urlSchema)) {
-    throw new Error(
-      `Invalid generates entry: must be an object
-Path: ${path}`
-    );
+    throw new Error(`Invalid generates entry: must be an object
+Path: ${path}`);
   }
   const schema = urlSchema;
   for (const [filePath, generatorConfig] of Object.entries(schema)) {
@@ -121,10 +117,8 @@ Path: ${path}[${filePath}]`
 // src/utils/validations/config.ts
 function validateConfig(config, configPath) {
   if (typeof config !== "object" || config === null || Array.isArray(config)) {
-    throw new Error(
-      `Invalid config: must be an object
-Config file: ${configPath}`
-    );
+    throw new Error(`Invalid config: must be an object
+Config file: ${configPath}`);
   }
   const cfg = config;
   if (!("overwrite" in cfg)) {
@@ -205,10 +199,8 @@ Make sure esbuild is installed as a dependency.`
       configModule = await import(configUrl);
     } catch (importError) {
       const errorMessage = importError instanceof Error ? importError.message : String(importError);
-      throw new Error(
-        `Failed to import config file: ${resolvedPath}
-Error: ${errorMessage}`
-      );
+      throw new Error(`Failed to import config file: ${resolvedPath}
+Error: ${errorMessage}`);
     }
   }
   if (!configModule.default) {
@@ -337,7 +329,7 @@ var TypeGenerator = class {
       return `${this.prefix}Hit${this.postfix}`;
     }
     const lastPart = path[path.length - 1];
-    const parts = lastPart.replace(/[\[\]]/g, "").split(/[-_\s]+/).filter(Boolean);
+    const parts = lastPart.replace(/[[\]]/g, "").split(/[-_\s]+/).filter(Boolean);
     const pascalCase = parts.map((part) => part.charAt(0).toUpperCase() + part.slice(1).toLowerCase()).join("");
     if (path.length > 1) {
       const parent = path[path.length - 2];
@@ -503,10 +495,7 @@ Set overwrite: true in config to allow overwriting existing files.`
   console.log(`App ID: ${generatorConfig.appId}`);
   let client;
   try {
-    client = (0, import_algoliasearch.algoliasearch)(
-      generatorConfig.appId,
-      generatorConfig.searchKey
-    );
+    client = (0, import_algoliasearch.algoliasearch)(generatorConfig.appId, generatorConfig.searchKey);
   } catch (error) {
     throw new Error(
       `Failed to initialize Algolia client: ${error instanceof Error ? error.message : String(error)}`

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   main
-} from "./chunk-R66ECGLW.js";
+} from "./chunk-4T5DZK75.js";
 
 // src/cli.ts
 import { config as loadDotenv } from "dotenv";

package/dist/index.cjs

@@ -50,7 +50,7 @@ async function loadTypeScriptConfig(resolvedPath) {
   const result = esbuild.transformSync(source, {
     loader: "ts",
     format: "esm",
-    target: "node18",
+    target: "node20",
     sourcefile: resolvedPath
   });
   if (!result.code) {
@@ -64,10 +64,8 @@ async function loadTypeScriptConfig(resolvedPath) {
 // src/utils/validations/generator-config.ts
 function validateGeneratorConfig(config, path) {
   if (typeof config !== "object" || config === null || Array.isArray(config)) {
-    throw new Error(
-      `Invalid generator config: must be an object
-Path: ${path}`
-    );
+    throw new Error(`Invalid generator config: must be an object
+Path: ${path}`);
   }
   const cfg = config;
   const requiredFields = [
@@ -109,10 +107,8 @@ Received: ${typeof cfg.postfix}`
 // src/utils/validations/url-schema.ts
 function validateUrlSchema(urlSchema, path) {
   if (typeof urlSchema !== "object" || urlSchema === null || Array.isArray(urlSchema)) {
-    throw new Error(
-      `Invalid generates entry: must be an object
-Path: ${path}`
-    );
+    throw new Error(`Invalid generates entry: must be an object
+Path: ${path}`);
   }
   const schema = urlSchema;
   for (const [filePath, generatorConfig] of Object.entries(schema)) {
@@ -129,10 +125,8 @@ Path: ${path}[${filePath}]`
 // src/utils/validations/config.ts
 function validateConfig(config, configPath) {
   if (typeof config !== "object" || config === null || Array.isArray(config)) {
-    throw new Error(
-      `Invalid config: must be an object
-Config file: ${configPath}`
-    );
+    throw new Error(`Invalid config: must be an object
+Config file: ${configPath}`);
   }
   const cfg = config;
   if (!("overwrite" in cfg)) {
@@ -213,10 +207,8 @@ Make sure esbuild is installed as a dependency.`
       configModule = await import(configUrl);
     } catch (importError) {
       const errorMessage = importError instanceof Error ? importError.message : String(importError);
-      throw new Error(
-        `Failed to import config file: ${resolvedPath}
-Error: ${errorMessage}`
-      );
+      throw new Error(`Failed to import config file: ${resolvedPath}
+Error: ${errorMessage}`);
     }
   }
   if (!configModule.default) {
@@ -345,7 +337,7 @@ var TypeGenerator = class {
       return `${this.prefix}Hit${this.postfix}`;
     }
     const lastPart = path[path.length - 1];
-    const parts = lastPart.replace(/[\[\]]/g, "").split(/[-_\s]+/).filter(Boolean);
+    const parts = lastPart.replace(/[[\]]/g, "").split(/[-_\s]+/).filter(Boolean);
     const pascalCase = parts.map((part) => part.charAt(0).toUpperCase() + part.slice(1).toLowerCase()).join("");
     if (path.length > 1) {
       const parent = path[path.length - 2];
@@ -511,10 +503,7 @@ Set overwrite: true in config to allow overwriting existing files.`
   console.log(`App ID: ${generatorConfig.appId}`);
   let client;
   try {
-    client = (0, import_algoliasearch.algoliasearch)(
-      generatorConfig.appId,
-      generatorConfig.searchKey
-    );
+    client = (0, import_algoliasearch.algoliasearch)(generatorConfig.appId, generatorConfig.searchKey);
   } catch (error) {
     throw new Error(
       `Failed to initialize Algolia client: ${error instanceof Error ? error.message : String(error)}`

package/dist/index.js

@@ -3,7 +3,7 @@ import {
   validateConfig,
   validateGeneratorConfig,
   validateUrlSchema
-} from "./chunk-R66ECGLW.js";
+} from "./chunk-4T5DZK75.js";
 export {
   main,
   validateConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algolia-codegen",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Generate TypeScript types from Algolia indices",
   "license": "MIT",
   "author": "nightlightmare",
@@ -45,11 +45,17 @@
   },
   "devDependencies": {
     "@types/node": "^25.0.3",
+    "@vitest/coverage-v8": "^2.1.8",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "prettier": "^3.7.4",
     "tsup": "^8.0.0",
-    "typescript": "^5.4.0"
+    "typescript": "^5.4.0",
+    "typescript-eslint": "^8.50.1",
+    "vitest": "^2.1.8"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "publishConfig": {
     "access": "public"
@@ -58,6 +64,13 @@
     "build": "tsup",
     "dev": "tsup --watch",
     "clean": "rm -rf dist",
-    "type-check": "tsc --noEmit"
+    "type-check": "tsc --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
   }
 }