@weiyentan/opencode-plugin-awx 0.2.0

package/dist/contracts/job-detail.js

@@ -0,0 +1,98 @@
+/**
+ * AWX Job Detail Output Contract — v1.0
+ *
+ * Canonical TypeScript representation of the `awx_job_detail.py` v1.0 output schema.
+ * Every job-related tool MUST return output matching this contract.
+ *
+ * This file provides **both**:
+ * - Zod schemas for runtime validation (e.g., API response parsing)
+ * - Inferred TypeScript types for static type checking
+ *
+ * The contract has been verified against fixture snapshots in `tests/contracts/__snapshots__/`.
+ *
+ * ## Schema Fields
+ *
+ * - **schema_version**: Always "1.0"
+ * - **job**: Core job metadata (id, name, status, timestamps, etc.)
+ * - **related**: Resolved names (not URLs) for related AWX resources
+ * - **host_status_counts**: Count of hosts in each Ansible state — NOT `host_summary`
+ * - **derived**: Boolean flags computed from raw data — NOT `extra_vars_summary`
+ * - **warnings / errors**: String arrays for user-facing messages
+ * - **stdout** (optional): Full job stdout text
+ * - **raw_events** (optional): Raw AWX job events array
+ *
+ * ## Field Naming Convention
+ *
+ * - Use `host_status_counts` — NOT `host_summary`
+ * - Use `derived` — NOT `extra_vars_summary`
+ * - `related` fields are resolved names, not raw URLs
+ * - `job.limit` is the AWX job limit (host pattern), not a pagination value
+ *
+ * ## Snapshot Testing
+ *
+ * Fixture JSON files in `tests/fixtures/` serve as contract snapshots.
+ * When the Python `awx_job_detail.py` v1.0 output contract changes,
+ * regenerate the fixtures (see README.md for instructions) and re-run
+ * tests to verify schema compatibility.
+ *
+ * ## Regeneration
+ *
+ * To regenerate the contract snapshots after fixture changes:
+ * ```bash
+ * python3 scripts/generate-snapshots.py
+ * ```
+ */
+import { z } from "zod";
+// ─── Sub-schemas ───────────────────────────────────────────
+export const JobCoreSchema = z.object({
+    id: z.number().int().positive(),
+    name: z.string(),
+    status: z.string(),
+    failed: z.boolean(),
+    job_type: z.string(),
+    playbook: z.string(),
+    created: z.string(),
+    started: z.string().nullable(),
+    finished: z.string().nullable(),
+    elapsed: z.number().nullable(),
+    execution_node: z.string(),
+    controller_node: z.string(),
+    scm_branch: z.string(),
+    verbosity: z.number().int().min(0),
+    forks: z.number().int().min(0).nullable(),
+    limit: z.string(),
+});
+export const RelatedSchema = z.object({
+    inventory_name: z.string(),
+    project_name: z.string(),
+    job_template_name: z.string(),
+    instance_group_name: z.string(),
+    created_by: z.string(),
+    credential_names: z.array(z.string()),
+    label_names: z.array(z.string()),
+});
+export const HostStatusCountsSchema = z.object({
+    ok: z.number().int().min(0),
+    failed: z.number().int().min(0),
+    skipped: z.number().int().min(0),
+    changed: z.number().int().min(0),
+    unreachable: z.number().int().min(0),
+});
+export const DerivedSchema = z.object({
+    is_successful: z.boolean(),
+    is_failed: z.boolean(),
+    has_unreachable_hosts: z.boolean(),
+});
+// ─── Top-level schema ──────────────────────────────────────
+export const JobDetailOutputSchema = z.object({
+    schema_version: z.literal("1.0"),
+    job: JobCoreSchema,
+    related: RelatedSchema,
+    host_status_counts: HostStatusCountsSchema,
+    derived: DerivedSchema,
+    warnings: z.array(z.string()),
+    errors: z.array(z.string()),
+    stdout: z.string().optional(),
+    raw_events: z.array(z.unknown()).optional(),
+});
+//# sourceMappingURL=job-detail.js.map

package/dist/contracts/job-detail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-detail.js","sourceRoot":"","sources":["../../src/contracts/job-detail.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,8DAA8D;AAE9D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACrC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CACjC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE;IAC1B,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE;CACnC,CAAC,CAAC;AAEH,8DAA8D;AAE9D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAChC,GAAG,EAAE,aAAa;IAClB,OAAO,EAAE,aAAa;IACtB,kBAAkB,EAAE,sBAAsB;IAC1C,OAAO,EAAE,aAAa;IACtB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC7B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC"}

package/dist/contracts/sync-project.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Sync Project Output Contract
+ *
+ * Canonical schema for the `awx-sync-project` tool's return value.
+ * Defines both:
+ * - Zod schema for runtime validation
+ * - Inferred TypeScript types for static type checking
+ *
+ * ## Schema Fields
+ *
+ * - **project_update_id**: The AWX project update record ID
+ * - **status**: Status of the triggered sync (e.g., "running", "successful", "failed")
+ * - **project_name**: Resolved name of the AWX project
+ * - **project_id**: The AWX project ID (echoed from input)
+ * - **url**: API URL of the project
+ * - **scm_type**: SCM type (e.g., "git", "svn")
+ * - **last_updated**: Timestamp of last project update
+ */
+import { z } from "zod";
+export declare const ProjectSyncOutputSchema: z.ZodObject<{
+    project_update_id: z.ZodNumber;
+    status: z.ZodString;
+    project_name: z.ZodString;
+    project_id: z.ZodNumber;
+    url: z.ZodString;
+    scm_type: z.ZodString;
+    last_updated: z.ZodString;
+}, z.core.$strip>;
+/** Structured output returned by the awx-sync-project tool */
+export type ProjectSyncOutput = z.infer<typeof ProjectSyncOutputSchema>;
+//# sourceMappingURL=sync-project.d.ts.map

package/dist/contracts/sync-project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-project.d.ts","sourceRoot":"","sources":["../../src/contracts/sync-project.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,uBAAuB;;;;;;;;iBAQlC,CAAC;AAIH,8DAA8D;AAC9D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}

package/dist/contracts/sync-project.js

@@ -0,0 +1,30 @@
+/**
+ * Sync Project Output Contract
+ *
+ * Canonical schema for the `awx-sync-project` tool's return value.
+ * Defines both:
+ * - Zod schema for runtime validation
+ * - Inferred TypeScript types for static type checking
+ *
+ * ## Schema Fields
+ *
+ * - **project_update_id**: The AWX project update record ID
+ * - **status**: Status of the triggered sync (e.g., "running", "successful", "failed")
+ * - **project_name**: Resolved name of the AWX project
+ * - **project_id**: The AWX project ID (echoed from input)
+ * - **url**: API URL of the project
+ * - **scm_type**: SCM type (e.g., "git", "svn")
+ * - **last_updated**: Timestamp of last project update
+ */
+import { z } from "zod";
+// ─── Top-level schema ──────────────────────────────────────
+export const ProjectSyncOutputSchema = z.object({
+    project_update_id: z.number().int().positive(),
+    status: z.string(),
+    project_name: z.string(),
+    project_id: z.number().int().positive(),
+    url: z.string(),
+    scm_type: z.string(),
+    last_updated: z.string(),
+});
+//# sourceMappingURL=sync-project.js.map

package/dist/contracts/sync-project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-project.js","sourceRoot":"","sources":["../../src/contracts/sync-project.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,8DAA8D;AAE9D,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACvC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import type { PluginModule } from "@opencode-ai/plugin";
+/** Plugin-specific configuration from opencode.jsonc */
+export interface AwxPluginOptions {
+    /**
+     * Base URL of the AAP/AWX instance.
+     * Must include protocol (https://) and hostname.
+     * Example: "https://example.com"
+     */
+    baseUrl?: string;
+}
+/**
+ * Plugin module — the default export consumed by the OpenCode plugin server.
+ */
+declare const pluginModule: PluginModule;
+export default pluginModule;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAqBA,OAAO,KAAK,EAAsB,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAmC5E,wDAAwD;AACxD,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAsyBD;;GAEG;AACH,QAAA,MAAM,YAAY,EAAE,YAGnB,CAAC;AAEF,eAAe,YAAY,CAAC"}