algolia-codegen 0.1.0

package/README.md

@@ -0,0 +1,129 @@
+# Algolia Type Generator
+
+This script automatically generates TypeScript types from your Algolia index by fetching a sample record and analyzing its structure.
+
+**Repository**: [https://github.com/nightlightmare/algolia-codegen](https://github.com/nightlightmare/algolia-codegen)
+
+## Prerequisites
+
+Make sure you have the following environment variables set in your `.env` file:
+
+- `ALGOLIA_APP_ID` - Your Algolia Application ID
+- `ALGOLIA_SEARCH_KEY` - Your Algolia Search API Key
+- `ALGOLIA_INDEX_NAME` - Your Algolia Index Name
+
+The script will automatically check for `.env`, `.env.local`, and `.env.development.local` files in the current directory.
+
+## Installation
+
+Install the package globally or locally:
+
+```bash
+# Global installation
+npm install -g algolia-codegen
+
+# Or local installation
+npm install algolia-codegen
+# or
+pnpm add algolia-codegen
+# or
+yarn add algolia-codegen
+```
+
+## Usage
+
+### CLI Usage
+
+After installation, you can use the CLI command:
+
+```bash
+algolia-codegen
+```
+
+Or if installed locally:
+
+```bash
+npx algolia-codegen
+```
+
+### Programmatic Usage
+
+You can also import and use the package programmatically:
+
+```typescript
+import { main } from 'algolia-codegen';
+
+main();
+```
+
+## How It Works
+
+1. **Connects to Algolia**: Uses your configured Algolia credentials to connect to your index
+2. **Fetches Sample Record**: Retrieves one record from your Algolia index
+3. **Analyzes Structure**: Recursively analyzes the JSON structure to infer TypeScript types
+4. **Generates Types**: Creates TypeScript interface files in the specified output directory
+5. **Handles Special Cases**:
+   - Detects `AlgoliaIdValue` patterns (objects with `id` and `value` properties)
+   - Handles nested objects and arrays
+   - Preserves optional fields (null/undefined values)
+   - Generates proper imports between types
+
+## Generated Files
+
+The script generates TypeScript interface files in the output directory (default: `src/shared/algolia/`).
+
+Each type gets its own file (e.g., `AlgoliaCampground.ts`, `AlgoliaAddress.ts`), and an `index.ts` file exports all types.
+
+## Notes
+
+- The script analyzes a single sample record, so make sure your index has at least one record
+- If your data structure varies significantly between records, you may need to manually adjust some types
+- The script will overwrite existing type files, so make sure to commit your changes before running
+- Consider running this script as part of your CI/CD pipeline to keep types in sync with your Algolia index
+
+## Customization
+
+You can modify `generate-types.ts` to:
+- Adjust type naming conventions
+- Add custom type inference logic
+- Change the output directory
+- Add additional type transformations
+
+For contributions and feature requests, please visit the [GitHub repository](https://github.com/nightlightmare/algolia-codegen).
+
+## Publishing
+
+This package is automatically published to npm when changes are merged into the `main` branch via GitHub Actions.
+
+### Setting up NPM_TOKEN
+
+To enable automatic publishing, you need to configure the `NPM_TOKEN` secret in your GitHub repository:
+
+1. Go to your GitHub repository
+2. Navigate to **Settings** → **Secrets and variables** → **Actions**
+3. Click **New repository secret**
+4. Name: `NPM_TOKEN`
+5. Value: Your npm access token (create one at https://www.npmjs.com/settings/YOUR_USERNAME/tokens)
+6. Make sure the token has **Automation** or **Publish** permissions
+7. Click **Add secret**
+
+The workflow will automatically:
+- Build the package
+- Publish to npm when PRs are merged into `main`
+- Use provenance for enhanced security
+
+### Manual Publishing
+
+To publish manually:
+
+```bash
+pnpm build
+pnpm publish
+```
+
+## Repository
+
+- **GitHub**: [https://github.com/nightlightmare/algolia-codegen](https://github.com/nightlightmare/algolia-codegen)
+- **Issues**: [https://github.com/nightlightmare/algolia-codegen/issues](https://github.com/nightlightmare/algolia-codegen/issues)
+- **npm**: [https://www.npmjs.com/package/algolia-codegen](https://www.npmjs.com/package/algolia-codegen)
+

package/dist/chunk-U33HDFDI.js

@@ -0,0 +1,8 @@
+// src/index.ts
+var main = () => {
+  console.log("Main!");
+};
+
+export {
+  main
+};

package/dist/cli.cjs

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+"use strict";
+
+// src/cli.ts
+var import_commander = require("commander");
+
+// src/index.ts
+var main = () => {
+  console.log("Main!");
+};
+
+// src/cli.ts
+var program = new import_commander.Command();
+program.name("algolia-codegen").description("Generate TypeScript types from Algolia index").option("-c, --config <path>", "Config file path").action(() => {
+  main();
+}).parse();

package/dist/cli.d.cts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import {
+  main
+} from "./chunk-U33HDFDI.js";
+
+// src/cli.ts
+import { Command } from "commander";
+var program = new Command();
+program.name("algolia-codegen").description("Generate TypeScript types from Algolia index").option("-c, --config <path>", "Config file path").action(() => {
+  main();
+}).parse();

package/dist/index.cjs

@@ -0,0 +1,32 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  main: () => main
+});
+module.exports = __toCommonJS(src_exports);
+var main = () => {
+  console.log("Main!");
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  main
+});

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+declare const main: () => void;
+
+export { main };

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+declare const main: () => void;
+
+export { main };

package/dist/index.js

@@ -0,0 +1,6 @@
+import {
+  main
+} from "./chunk-U33HDFDI.js";
+export {
+  main
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "algolia-codegen",
+  "version": "0.1.0",
+  "description": "Generate TypeScript types from Algolia indices",
+  "license": "MIT",
+  "author": "nightlightmare",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nightlightmare/algolia-codegen.git"
+  },
+  "homepage": "https://github.com/nightlightmare/algolia-codegen#readme",
+  "bugs": {
+    "url": "https://github.com/nightlightmare/algolia-codegen/issues"
+  },
+  "keywords": [
+    "algolia",
+    "typescript",
+    "codegen",
+    "type-generation",
+    "algolia-types",
+    "code-generation",
+    "typescript-generator"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "bin": {
+    "algolia-codegen": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "algoliasearch": "^4.24.0",
+    "commander": "^12.0.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.4.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist"
+  }
+}