@redis-iris/agent-playbook 0.1.0-alpha.4 → 0.1.0-beta.2

package/src/controlplane/sdk/sdk.ts

@@ -24,7 +24,7 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
-export class PlaybookService extends ClientSDK {
+export class AgentPlaybooksService extends ClientSDK {
   /**
    * Cloud only: list account databases
    *
@@ -71,7 +71,7 @@ export class PlaybookService extends ClientSDK {
   }
 
   /**
-   * Lists the account's Playbooks. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT. If a selected database is unavailable, its Playbook remains listed without endpoint, database name or accessCidrs enrichment.
+   * Lists the account's Playbooks. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT. If a selected database is unavailable, its Playbook remains listed with state=unavailable and without endpoint, database name or accessCidrs enrichment for recognized missing/deleted database or metadata connection failures. Other inventory enrichment failures retain the saved state.
    */
   async listPlaybooks(
     options?: RequestOptions,
@@ -108,7 +108,7 @@ export class PlaybookService extends ClientSDK {
   }
 
   /**
-   * Reads one Playbook. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT.
+   * Reads one Playbook. Cloud requests require JSESSIONID and X-CSRF-Token in addition to the operator JWT. A missing or deleted database, or a recognized metadata connection failure, returns saved configuration with state=unavailable and without endpoints, databaseBinding.name, or databaseBinding.accessCidrs. This effective read state is not persisted and is not a mutation input. It reports unavailable live database information, not confirmed deletion or a content Redis health probe. Authorization, certificate-verification, cancellation/deadline, malformed-response, and unrelated service errors still fail the request.
    */
   async getPlaybook(
     playbookId: string,
@@ -165,7 +165,7 @@ export class PlaybookService extends ClientSDK {
   }
 
   /**
-   * Registers a client-supplied RAM store reference and FAQ policy. Returns preparing and enabled=false. The control plane asynchronously provisions extraction-worker RAM source read and Playbook destination read/propose grants; both accepted grants make the binding ready, refused grants make it blocked, and dependency outages remain pending for retry. The worker validates live RAM access when extraction runs. Poll GET until ready, then PATCH to enable.
+   * Validates caller management consent, exact same-account RAM source ownership, destination readiness and execution scope synchronously. Success returns ready and enabled=false. Every explicit enable revalidates with the current caller. Pause/delete require destination management only and make no source or grant-administration request. A foreign or missing source is refused without revealing its metadata.
    */
   async createExtractionBinding(
     playbookId: string,
@@ -225,7 +225,7 @@ export class PlaybookService extends ClientSDK {
   }
 
   /**
-   * Returns tenant-scoped deployment-configured store suggestions, which may be empty. A client may submit another syntactically valid storeId. No RAM call or approval check occurs.
+   * Returns tenant-scoped store suggestions, which may be empty. A suggestion does not approve a store. A client may submit another syntactically valid storeId; CreateExtractionBinding checks the caller's access to the store.
    */
   async listExtractionStores(
     playbookId: string,

package/src/index.ts

@@ -5,5 +5,5 @@ export * as files from "./lib/files.js";
 export { HTTPClient } from "./lib/http.js";
 export type { Fetcher, HTTPClientOptions } from "./lib/http.js";
 export * from "./sdk/sdk.js";
-export { PlaybookService } from "./controlplane/sdk/sdk.js";
-export type { SDKOptions as PlaybookServiceOptions } from "./controlplane/lib/config.js";
+export { AgentPlaybooksService } from "./controlplane/sdk/sdk.js";
+export type { SDKOptions as AgentPlaybooksServiceOptions } from "./controlplane/lib/config.js";

package/src/lib/config.ts

@@ -49,8 +49,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.1.0-alpha.4",
+  sdkVersion: "0.1.0-beta.2",
   genVersion: "2.948.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.4 2.948.4 1.0.0 @redis-iris/agent-playbook",
+    "speakeasy-sdk/typescript 0.1.0-beta.2 2.948.4 1.0.0 @redis-iris/agent-playbook",
 } as const;

package/src/lib/env.ts

@@ -7,22 +7,22 @@ import * as z from "zod/v3";
 import { SDKOptions } from "./config.js";
 
 export interface Env {
-  PLAYBOOK_API_KEY?: string | undefined;
+  AGENT_PLAYBOOKS_API_KEY?: string | undefined;
 
   /**
    * Sets the playbookId parameter for all supported operations
    */
-  PLAYBOOK_PLAYBOOK_ID?: string | undefined;
+  AGENT_PLAYBOOKS_PLAYBOOK_ID?: string | undefined;
 
-  PLAYBOOK_DEBUG?: boolean | undefined;
+  AGENT_PLAYBOOKS_DEBUG?: boolean | undefined;
 }
 
 export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
-  PLAYBOOK_API_KEY: z.string().optional(),
+  AGENT_PLAYBOOKS_API_KEY: z.string().optional(),
 
-  PLAYBOOK_PLAYBOOK_ID: z.string().optional(),
+  AGENT_PLAYBOOKS_PLAYBOOK_ID: z.string().optional(),
 
-  PLAYBOOK_DEBUG: z.coerce.boolean().optional(),
+  AGENT_PLAYBOOKS_DEBUG: z.coerce.boolean().optional(),
 });
 
 /**
@@ -58,7 +58,13 @@ export function env(): Env {
     envObject = globals.process?.env ?? {};
   }
 
-  envMemo = envSchema.parse(envObject);
+  // Current names take precedence over legacy aliases, including empty values.
+  envMemo = envSchema.parse({
+    ...envObject,
+    AGENT_PLAYBOOKS_API_KEY: envObject["AGENT_PLAYBOOKS_API_KEY"] ?? envObject["PLAYBOOK_API_KEY"],
+    AGENT_PLAYBOOKS_PLAYBOOK_ID: envObject["AGENT_PLAYBOOKS_PLAYBOOK_ID"] ?? envObject["PLAYBOOK_PLAYBOOK_ID"],
+    AGENT_PLAYBOOKS_DEBUG: envObject["AGENT_PLAYBOOKS_DEBUG"] ?? envObject["PLAYBOOK_DEBUG"],
+  });
   return envMemo;
 }
 
@@ -77,8 +83,8 @@ export function fillGlobals(options: SDKOptions): SDKOptions {
 
   const envVars = env();
 
-  if (typeof envVars.PLAYBOOK_PLAYBOOK_ID !== "undefined") {
-    clone.playbookId ??= envVars.PLAYBOOK_PLAYBOOK_ID;
+  if (typeof envVars.AGENT_PLAYBOOKS_PLAYBOOK_ID !== "undefined") {
+    clone.playbookId ??= envVars.AGENT_PLAYBOOKS_PLAYBOOK_ID;
   }
 
   return clone;

package/src/lib/sdks.ts

@@ -112,7 +112,7 @@ export class ClientSDK {
     this._options = { ...fillGlobals(options), hooks: this.#hooks };
 
     this.#logger = this._options.debugLogger;
-    if (!this.#logger && env().PLAYBOOK_DEBUG) {
+    if (!this.#logger && env().AGENT_PLAYBOOKS_DEBUG) {
       this.#logger = console;
     }
   }

package/src/lib/security.ts

@@ -253,7 +253,7 @@ export function resolveGlobalSecurity(
       {
         fieldName: "Authorization",
         type: "http:bearer",
-        value: security?.apiKey ?? env().PLAYBOOK_API_KEY,
+        value: security?.apiKey ?? env().AGENT_PLAYBOOKS_API_KEY,
       },
     ],
   ];

package/dist/commonjs/controlplane/models/errors/playbook-service-error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"playbook-service-error.d.ts","sourceRoot":"","sources":["../../../../../src/controlplane/models/errors/playbook-service-error.ts"],"names":[],"mappings":"AAIA,kDAAkD;AAClD,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,uBAAuB;IACvB,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,gBAAgB;IAChB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,mBAAmB;IACnB,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,wBAAwB;IACxB,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,mBAAmB;IACnB,SAAgB,WAAW,EAAE,QAAQ,CAAC;IAEtC,YACE,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE;QACR,QAAQ,EAAE,QAAQ,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;KACd,EAUF;CACF"}

package/dist/commonjs/controlplane/models/errors/playbook-service-error.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"playbook-service-error.js","sourceRoot":"","sources":["../../../../../src/controlplane/models/errors/playbook-service-error.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,kDAAkD;AAClD,0BAAkC,SAAQ,KAAK;IAC7C,uBAAuB;IACP,UAAU,CAAS;IACnC,gBAAgB;IACA,IAAI,CAAS;IAC7B,mBAAmB;IACH,OAAO,CAAU;IACjC,wBAAwB;IACR,WAAW,CAAS;IACpC,mBAAmB;IACH,WAAW,CAAW;IAEtC,YACE,OAAe,EACf,QAIC,EACD;QACA,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QACvE,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAErC,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IAAA,CACpC;CACF"}

package/dist/esm/controlplane/models/errors/playbook-service-error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"playbook-service-error.d.ts","sourceRoot":"","sources":["../../../../../src/controlplane/models/errors/playbook-service-error.ts"],"names":[],"mappings":"AAIA,kDAAkD;AAClD,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,uBAAuB;IACvB,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,gBAAgB;IAChB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,mBAAmB;IACnB,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,wBAAwB;IACxB,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,mBAAmB;IACnB,SAAgB,WAAW,EAAE,QAAQ,CAAC;IAEtC,YACE,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE;QACR,QAAQ,EAAE,QAAQ,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;KACd,EAUF;CACF"}

package/dist/esm/controlplane/models/errors/playbook-service-error.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"playbook-service-error.js","sourceRoot":"","sources":["../../../../../src/controlplane/models/errors/playbook-service-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,kDAAkD;AAClD,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC7C,uBAAuB;IACP,UAAU,CAAS;IACnC,gBAAgB;IACA,IAAI,CAAS;IAC7B,mBAAmB;IACH,OAAO,CAAU;IACjC,wBAAwB;IACR,WAAW,CAAS;IACpC,mBAAmB;IACH,WAAW,CAAW;IAEtC,YACE,OAAe,EACf,QAIC,EACD;QACA,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QACvE,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAErC,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IAAA,CACpC;CACF"}