@algolia/wizard 0.9.0-rc.75.65 → 0.9.0-rc.77.67

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/main.js CHANGED
@@ -1003,7 +1003,7 @@ var accessItems = [
1003
1003
  {
1004
1004
  tag: "READ",
1005
1005
  title: "Project files",
1006
- description: "reads your dependency manifests (package.json, pyproject.toml\u2026), configs & source to detect your stack. Read-only; nothing is uploaded."
1006
+ description: "reads your dependency manifests (package.json, pyproject.toml, Gemfile\u2026), configs & source to detect your stack. Read-only; nothing is uploaded."
1007
1007
  },
1008
1008
  {
1009
1009
  tag: "WRITE",
@@ -2389,6 +2389,73 @@ var LANGUAGE_PROFILES = {
2389
2389
  "build",
2390
2390
  "htmlcov"
2391
2391
  ]
2392
+ },
2393
+ ruby: {
2394
+ id: "ruby",
2395
+ displayName: "Ruby",
2396
+ aliases: ["ruby", "rb", "rails", "ruby on rails", "rubyonrails"],
2397
+ manifests: ["Gemfile", "*.gemspec"],
2398
+ packageManagers: [
2399
+ {
2400
+ id: "bundler",
2401
+ dependency: { mode: "agent-declares", file: "Gemfile" },
2402
+ installSteps: [{ argv: ["bundle", "install"] }],
2403
+ ingest: {
2404
+ kind: "auto",
2405
+ argv: ["bundle", "exec", "ruby", ENTRYPOINT_TOKEN],
2406
+ entrypointExtensions: [".rb"]
2407
+ }
2408
+ }
2409
+ ],
2410
+ sdk: { packageName: "algolia", versionPin: "~> 3.0", docKey: "ruby" },
2411
+ ingestEntrypointExample: `${INGEST_DIR}/ingest.rb`,
2412
+ // Ruby has no directory-level syntax check (`ruby -c` is one file at a
2413
+ // time), so verification relies on the agent's own review here.
2414
+ verification: [],
2415
+ envReadInstruction: "Read them from `ENV.fetch('NAME')`.",
2416
+ skipDirs: ["vendor", "tmp", "log", "coverage"]
2417
+ },
2418
+ php: {
2419
+ id: "php",
2420
+ displayName: "PHP",
2421
+ aliases: ["php", "laravel", "symfony"],
2422
+ manifests: ["composer.json"],
2423
+ packageManagers: [
2424
+ {
2425
+ id: "composer",
2426
+ // `composer require` both declares and installs, and unlike editing
2427
+ // composer.json by hand it can't leave composer.lock out of date (which
2428
+ // makes a later `composer install` refuse to run).
2429
+ dependency: { mode: "wizard-installs" },
2430
+ installSteps: [
2431
+ {
2432
+ argv: [
2433
+ "composer",
2434
+ "require",
2435
+ "algolia/algoliasearch-client-php:^4",
2436
+ "--no-interaction",
2437
+ // Repo post-install scripts are the project's code, not ours to
2438
+ // trigger; Laravel's package:discover also fails in a bare tree.
2439
+ "--no-scripts"
2440
+ ]
2441
+ }
2442
+ ],
2443
+ ingest: {
2444
+ kind: "auto",
2445
+ argv: ["php", ENTRYPOINT_TOKEN],
2446
+ entrypointExtensions: [".php"]
2447
+ }
2448
+ }
2449
+ ],
2450
+ sdk: {
2451
+ packageName: "algolia/algoliasearch-client-php",
2452
+ versionPin: "^4",
2453
+ docKey: "php"
2454
+ },
2455
+ ingestEntrypointExample: `${INGEST_DIR}/ingest.php`,
2456
+ verification: [],
2457
+ envReadInstruction: "Read them from `getenv('NAME')`.",
2458
+ skipDirs: ["vendor", "node_modules"]
2392
2459
  }
2393
2460
  };
2394
2461
  var DEFAULT_LANGUAGE_ID = "javascript";
@@ -3071,7 +3138,7 @@ var detectLanguageSchema = z16.object({
3071
3138
  var detectLanguage = () => runAgent({
3072
3139
  instructions: [
3073
3140
  "Analyze the codebase and determine the programming languages and frameworks used",
3074
- "Start from the dependency manifests: package.json, pyproject.toml, requirements.txt.",
3141
+ "Start from the dependency manifests: package.json, pyproject.toml, requirements.txt, Gemfile, composer.json.",
3075
3142
  "List the language that owns the backend/data code first \u2014 that is the one an ingestion script will be written in.",
3076
3143
  "If a superset language is found, exclude the subset language. TS-over-JS.",
3077
3144
  "If a meta-framework is used, exclude the framework. Next-over-React.",
@@ -3124,7 +3191,7 @@ var MODE_CONFIG = {
3124
3191
  "Analyze the codebase to find the data entities (models) that should be ingested into Algolia.",
3125
3192
  "For each entity, return its name, the file path(s) where it is defined, and its indexable attribute keys (the fields a user would search or filter on).",
3126
3193
  "Inspect the source of each entity to extract real field names for attributes \u2014 do not guess or leave attributes empty.",
3127
- "Entities live wherever the stack keeps them: TypeScript interfaces or a Prisma schema, Django models.py, Pydantic models.",
3194
+ "Entities live wherever the stack keeps them: TypeScript interfaces or a Prisma schema, Django models.py, Rails app/models, Laravel Eloquent models, Pydantic models.",
3128
3195
  "Prefer domain models (e.g. Document, Product, User) over framework or infrastructure types.",
3129
3196
  "Use as few tools as possible, but do not guess. If you cannot find any entities, return an empty array.",
3130
3197
  "Ignore directories that may be related to testing, like `/fixtures`, `/tests`, etc",
@@ -3147,7 +3214,7 @@ var MODE_CONFIG = {
3147
3214
  verification: {
3148
3215
  instructions: [
3149
3216
  "Analyze the codebase to determine which code-quality tools are available to validate changes.",
3150
- "Look at the dependency manifest and config files for the project's languages: package.json scripts with tsconfig/eslint/prettier, pyproject.toml or setup.cfg (ruff, mypy, black).",
3217
+ "Look at the dependency manifest and config files for the project's languages: package.json scripts with tsconfig/eslint/prettier, pyproject.toml or setup.cfg (ruff, mypy, black), Gemfile with .rubocop.yml, composer.json scripts (phpstan, pint).",
3151
3218
  'Return the tool names as an array, e.g. ["eslint", "prettier", "tsc"] or ["ruff", "mypy"].',
3152
3219
  "Use as few tools as possible, but do not guess. If you cannot find any, return an empty array.",
3153
3220
  "Ignore directories that may be related to testing, like `/fixtures`, `/tests`, etc",
@@ -3175,7 +3242,7 @@ async function runAnalysis(mode, extraInstructions = []) {
3175
3242
  // package.json
3176
3243
  var package_default = {
3177
3244
  name: "@algolia/wizard",
3178
- version: "0.9.0-rc.75.65",
3245
+ version: "0.9.0-rc.77.67",
3179
3246
  description: "Magically implement Algolia functionality in your codebase",
3180
3247
  type: "module",
3181
3248
  engines: {
@@ -17,6 +17,8 @@ Install the latest stable within the major; never pin an exact patch.
17
17
  | --- | --- | --- |
18
18
  | JavaScript/TypeScript | `algoliasearch` | `^5` |
19
19
  | Python | `algoliasearch` | `>=4,<5` |
20
+ | Ruby | `algolia` | `~> 3.0` |
21
+ | PHP | `algolia/algoliasearch-client-php` | `^4` |
20
22
 
21
23
  ## Search UI
22
24
 
@@ -0,0 +1,50 @@
1
+ # Save records (algoliasearch-client-php v4)
2
+
3
+ Adds records to an index. Write op — use a **write key**, server-side only.
4
+
5
+ Dependency: `algolia/algoliasearch-client-php` `^4` — the wizard runs
6
+ `composer require` for you; do not hand-edit `composer.json`.
7
+
8
+ `require 'vendor/autoload.php'` before anything else, or the class won't resolve
9
+ (from `.algolia-wizard/` the path is `__DIR__.'/../vendor/autoload.php'`).
10
+
11
+ ```php
12
+ <?php
13
+
14
+ require __DIR__.'/../vendor/autoload.php';
15
+
16
+ use Algolia\AlgoliaSearch\Api\SearchClient;
17
+
18
+ $appId = getenv('ALGOLIA_APPLICATION_ID');
19
+ $apiKey = getenv('ALGOLIA_WRITE_API_KEY');
20
+ $indexName = 'playlists';
21
+
22
+ $client = SearchClient::create($appId, $apiKey);
23
+ $records = [['objectID' => '1', 'name' => 'Hot 100', 'visibility' => 'public']];
24
+
25
+ $responses = $client->saveObjects($indexName, $records, true);
26
+ ```
27
+
28
+ ```php
29
+ saveObjects(
30
+ string $indexName, // required
31
+ array $objects, // required
32
+ bool $waitForTasks = false,
33
+ int $batchSize = 1000,
34
+ array $requestOptions = []
35
+ ) // => array of batch responses, one per 1,000-record batch
36
+ ```
37
+
38
+ Unlike the typed clients, PHP returns **plain associative arrays**, not objects:
39
+ `$responses[0]['taskID']`, `$responses[0]['objectIDs']`. Always an array of them —
40
+ never treat it as one response.
41
+
42
+ Read records from a JSON file:
43
+
44
+ ```php
45
+ $records = json_decode(file_get_contents($recordsPath), true);
46
+ ```
47
+
48
+ After a successful ingest, print `ALGOLIA_WIZARD_RECORD_COUNT=<n>` as the last
49
+ stdout line (`echo 'ALGOLIA_WIZARD_RECORD_COUNT='.count($records)."\n";`), with no
50
+ other output after it.
@@ -0,0 +1,48 @@
1
+ # Save records (algolia v3)
2
+
3
+ Adds records to an index. Write op — use a **write key**, server-side only.
4
+
5
+ Dependency: gem `algolia`, `~> 3.0` (`gem 'algolia', '~> 3.0'`).
6
+
7
+ `require "algolia"` (gem name is `algolia`, not `algoliasearch`). Build the client
8
+ with `Algolia::SearchClient.create`.
9
+
10
+ ```ruby
11
+ require "algolia"
12
+
13
+ app_id = ENV.fetch("ALGOLIA_APPLICATION_ID")
14
+ api_key = ENV.fetch("ALGOLIA_WRITE_API_KEY")
15
+ index_name = "playlists"
16
+
17
+ client = Algolia::SearchClient.create(app_id, api_key)
18
+
19
+ records = [{ "objectID" => "1", "name" => "Hot 100", "visibility" => "public" }]
20
+
21
+ responses = client.save_objects(index_name, records, true)
22
+ ```
23
+
24
+ ```ruby
25
+ save_objects(
26
+ index_name, # String, required
27
+ objects, # Array<Hash>, required
28
+ wait_for_tasks = false,
29
+ batch_size = 1000,
30
+ request_options = {}
31
+ ) # => Array<Algolia::Search::BatchResponse>, one entry per 1,000-record batch
32
+ ```
33
+
34
+ Args are **positional**, and every method/field is **snake_case**: read
35
+ `r.task_id` and `r.object_ids`, not `taskID`/`objectIDs`. The return value is an
36
+ array — never treat it as one object.
37
+
38
+ Read records from a JSON file:
39
+
40
+ ```ruby
41
+ require "json"
42
+
43
+ records = JSON.parse(File.read(records_path))
44
+ ```
45
+
46
+ After a successful ingest, print `ALGOLIA_WIZARD_RECORD_COUNT=<n>` as the last
47
+ stdout line (`puts "ALGOLIA_WIZARD_RECORD_COUNT=#{records.length}"`), with no
48
+ other output after it.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@algolia/wizard",
3
- "version": "0.9.0-rc.75.65",
3
+ "version": "0.9.0-rc.77.67",
4
4
  "description": "Magically implement Algolia functionality in your codebase",
5
5
  "type": "module",
6
6
  "engines": {