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

package/src/models/operations/get-proposal-resource.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6639bca49855
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+
+export type GetProposalResourceGlobals = {
+  playbookId?: string | undefined;
+};
+
+export type GetProposalResourceRequest = {
+  proposalId: string;
+  /**
+   * Opaque immutable Skill resource identifier.
+   */
+  resourceId: string;
+  /**
+   * Required opaque revision of the reviewed proposal. Pass its current revision unchanged; do not parse or synthesize it. A stale revision returns HTTP 412 revision-conflict. This resource read cannot omit the revision or select an unreviewed replacement candidate.
+   */
+  expectedRevision: string;
+};
+
+export type GetProposalResourceResponse = {
+  headers: { [k: string]: Array<string> };
+  result: ReadableStream<Uint8Array>;
+};
+
+/** @internal */
+export type GetProposalResourceRequest$Outbound = {
+  proposalId: string;
+  resourceId: string;
+  expectedRevision: string;
+};
+
+/** @internal */
+export const GetProposalResourceRequest$outboundSchema: z.ZodType<
+  GetProposalResourceRequest$Outbound,
+  z.ZodTypeDef,
+  GetProposalResourceRequest
+> = z.object({
+  proposalId: z.string(),
+  resourceId: z.string(),
+  expectedRevision: z.string(),
+});
+
+export function getProposalResourceRequestToJSON(
+  getProposalResourceRequest: GetProposalResourceRequest,
+): string {
+  return JSON.stringify(
+    GetProposalResourceRequest$outboundSchema.parse(getProposalResourceRequest),
+  );
+}
+
+/** @internal */
+export const GetProposalResourceResponse$inboundSchema: z.ZodType<
+  GetProposalResourceResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: z.instanceof(ReadableStream<Uint8Array>),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function getProposalResourceResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetProposalResourceResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetProposalResourceResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetProposalResourceResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -18,6 +18,8 @@ export * from "./dismiss-proposal.js";
 export * from "./get-faq-version.js";
 export * from "./get-faq.js";
 export * from "./get-playbook-health.js";
+export * from "./get-playbook-stats.js";
+export * from "./get-proposal-resource.js";
 export * from "./get-proposal.js";
 export * from "./get-skill-resource.js";
 export * from "./get-skill-version.js";

package/src/models/operations/list-faq-versions.ts

@@ -23,6 +23,9 @@ export type ListFaqVersionsRequest = {
    */
   createdBefore?: Date | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
 };
 

package/src/models/operations/list-faqs.ts

@@ -16,7 +16,7 @@ export type ListFaqsRequest = {
    */
   sortBy?: models.EntrySort | undefined;
   /**
-   * Defaults to desc. ID ties are always asc.
+   * Defaults to DESC. ID ties are always ASC.
    */
   sortOrder?: models.SortOrder | undefined;
   /**
@@ -32,6 +32,9 @@ export type ListFaqsRequest = {
    */
   published?: boolean | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
 };
 

package/src/models/operations/list-proposals.ts

@@ -17,13 +17,16 @@ export type ListProposalsRequest = {
    */
   sortBy?: models.ProposalSort | undefined;
   /**
-   * Defaults to asc for deadlines, desc otherwise. ID ties are always asc.
+   * Defaults to ASC for deadlines, DESC otherwise. ID ties are always ASC.
    */
   sortOrder?: models.SortOrder | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
   actionType?: models.ProposalActionType | undefined;
-  entryType?: models.EntryType | undefined;
+  entryKind?: models.EntryType | undefined;
 };
 
 /** @internal */
@@ -34,7 +37,7 @@ export type ListProposalsRequest$Outbound = {
   limit: number;
   cursor?: string | undefined;
   actionType?: string | undefined;
-  entryType?: string | undefined;
+  entryKind?: string | undefined;
 };
 
 /** @internal */
@@ -49,7 +52,7 @@ export const ListProposalsRequest$outboundSchema: z.ZodType<
   limit: z.number().int().default(50),
   cursor: z.string().optional(),
   actionType: models.ProposalActionType$outboundSchema.optional(),
-  entryType: models.EntryType$outboundSchema.optional(),
+  entryKind: models.EntryType$outboundSchema.optional(),
 });
 
 export function listProposalsRequestToJSON(

package/src/models/operations/list-skill-versions.ts

@@ -23,6 +23,9 @@ export type ListSkillVersionsRequest = {
    */
   createdBefore?: Date | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
 };
 

package/src/models/operations/list-skills.ts

@@ -16,7 +16,7 @@ export type ListSkillsRequest = {
    */
   sortBy?: models.EntrySort | undefined;
   /**
-   * Defaults to desc. ID ties are always asc.
+   * Defaults to DESC. ID ties are always ASC.
    */
   sortOrder?: models.SortOrder | undefined;
   /**
@@ -32,6 +32,9 @@ export type ListSkillsRequest = {
    */
   published?: boolean | undefined;
   limit?: number | undefined;
+  /**
+   * Opaque position in a list, returned as `nextCursor` and passed back as `cursor`.
+   */
   cursor?: string | undefined;
 };
 

package/src/models/pinned-playbook-preview-entry.ts

@@ -15,7 +15,7 @@ import {
 } from "./skill-preview-content.js";
 
 /**
- * Flat preview wire shape. Exactly one of faq or skill is present and matches entryType.
+ * Flat preview wire shape. Exactly one of faq or skill is present and matches kind.
  */
 export type PinnedPlaybookPreviewEntry = {
   /**
@@ -26,8 +26,11 @@ export type PinnedPlaybookPreviewEntry = {
    * Optional Playbook-unique immutable human-readable entry key.
    */
   entryKey?: string | undefined;
-  entryType: EntryType;
+  kind: EntryType;
   version: number;
+  /**
+   * Zero through five unique intent strings. Each intent contains 1 through 2,048 characters after normalization. Invalid lists return HTTP 400 with an errors entry pointing to the invalid intents member.
+   */
   intents: Array<string>;
   faq?: FaqContent | undefined;
   skill?: SkillPreviewContent | undefined;
@@ -41,7 +44,7 @@ export const PinnedPlaybookPreviewEntry$inboundSchema: z.ZodType<
 > = z.object({
   entryId: z.string(),
   entryKey: z.string().optional(),
-  entryType: EntryType$inboundSchema,
+  kind: EntryType$inboundSchema,
   version: z.number().int(),
   intents: z.array(z.string()),
   faq: FaqContent$inboundSchema.optional(),

package/src/models/precondition-failed-error-type.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 740fd0e6bbb7
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Problem type URI for a write whose expected revision is no longer current. A write guarded by an If-Match header on an HTTP entity tag uses a different type; see the Identity Service API.
+ */
+export const PreconditionFailedErrorType = {
+  RootErrorsRevisionConflict: "/errors/revision-conflict",
+} as const;
+/**
+ * Problem type URI for a write whose expected revision is no longer current. A write guarded by an If-Match header on an HTTP entity tag uses a different type; see the Identity Service API.
+ */
+export type PreconditionFailedErrorType = ClosedEnum<
+  typeof PreconditionFailedErrorType
+>;
+
+/** @internal */
+export const PreconditionFailedErrorType$inboundSchema: z.ZodNativeEnum<
+  typeof PreconditionFailedErrorType
+> = z.nativeEnum(PreconditionFailedErrorType);

package/src/models/proposal-action-input.ts

@@ -28,7 +28,7 @@ export const ProposalActionInputAdd$outboundSchema: z.ZodType<
   ProposalActionInputAdd
 > = z.object({
   add: AddProposalActionInput$outboundSchema,
-});
+}).strict();
 
 export function proposalActionInputAddToJSON(
   proposalActionInputAdd: ProposalActionInputAdd,

package/src/models/proposal-action-type.ts

@@ -7,7 +7,7 @@ import * as z from "zod/v3";
 import { ClosedEnum } from "../types/enums.js";
 
 export const ProposalActionType = {
-  Add: "add",
+  Add: "ADD",
 } as const;
 export type ProposalActionType = ClosedEnum<typeof ProposalActionType>;
 

package/src/models/proposal-candidate-input.ts

@@ -11,7 +11,7 @@ import {
 } from "./proposal-input-content.js";
 
 /**
- * Launch proposal authoring accepts FAQ content only.
+ * Proposal authoring accepts FAQ content or a complete Skill ZIP.
  */
 export type ProposalCandidateInput = {
   /**

package/src/models/proposal-candidate.ts

@@ -6,20 +6,20 @@
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
 import { Result as SafeParseResult } from "../types/fp.js";
-import {
-  AuthoredContent,
-  AuthoredContent$inboundSchema,
-} from "./authored-content.js";
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import {
+  ProposalContent,
+  ProposalContent$inboundSchema,
+} from "./proposal-content.js";
 
 /**
- * Complete suggested authored content. Resource URIs are derived on output.
+ * Complete normalized candidate. Proposal resources have no entry-version URI.
  */
 export type ProposalCandidate = {
   /**
-   * Complete normalized authored content. Responses emit empty intents/attributes collections.
+   * Author-provided context shared by FAQ, Skill and proposal authoring.
    */
-  content: AuthoredContent;
+  content: ProposalContent;
 };
 
 /** @internal */
@@ -28,7 +28,7 @@ export const ProposalCandidate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  content: AuthoredContent$inboundSchema,
+  content: ProposalContent$inboundSchema,
 });
 
 export function proposalCandidateFromJSON(

package/src/models/proposal-content.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7ee84addebfd
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import {
+  ProposalPayload,
+  ProposalPayload$inboundSchema,
+} from "./proposal-payload.js";
+
+/**
+ * Author-provided context shared by FAQ, Skill and proposal authoring.
+ */
+export type ProposalContent = {
+  /**
+   * At most five unique intents, each 1 through 2,048 characters after normalization. Omission is an empty list. Validation failures identify this member in the HTTP 400 errors array.
+   */
+  intents?: Array<string> | undefined;
+  /**
+   * Exact-match attributes. Values are typed scalars or nonempty lists of typed scalars.
+   */
+  attributes?: { [k: string]: any } | undefined;
+  /**
+   * Author-provided JSON metadata. Its normalized JSON encoding must not exceed 65,536 bytes or nesting depth 16; deployments may enforce lower limits. Exceeding the byte limit returns payload-too-large, while excessive nesting returns invalid-data.
+   */
+  metadata?: any | undefined;
+  payload: ProposalPayload;
+};
+
+/** @internal */
+export const ProposalContent$inboundSchema: z.ZodType<
+  ProposalContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  intents: z.array(z.string()).optional(),
+  attributes: z.record(z.any()).optional(),
+  metadata: z.any().optional(),
+  payload: ProposalPayload$inboundSchema,
+});
+
+export function proposalContentFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalContent' from JSON`,
+  );
+}

package/src/models/proposal-evidence-disposition.ts

@@ -8,8 +8,8 @@ import * as openEnums from "../types/enums.js";
 import { OpenEnum } from "../types/enums.js";
 
 export const ProposalEvidenceDisposition = {
-  Added: "added",
-  AlreadyPresent: "alreadyPresent",
+  Added: "ADDED",
+  AlreadyPresent: "ALREADY_PRESENT",
 } as const;
 export type ProposalEvidenceDisposition = OpenEnum<
   typeof ProposalEvidenceDisposition

package/src/models/proposal-evidence.ts

@@ -43,9 +43,8 @@ export type ProposalEvidence = {
    * On evidence this describes an additional observation relevant to the same need.
    * Reference locates the input; content preserves the submitter's observation or
    * excerpt. Both, when present, must be JSON objects. Their fields are source-specific.
-   * RAM extraction uses agent-memory-session or agent-memory-summary references and
+   * Agent Memory extraction uses agent-memory-session or agent-memory-summary references and
    * questionAnswer content; its question/answer are model-derived, not verbatim events.
-   * See docs/specs/MOD-18196-playbook-extraction-readiness-follow-up.md for that contract.
    */
   source: ProposalSource;
   /**

package/src/models/proposal-input-content.ts

@@ -14,6 +14,9 @@ import {
  * Proposal input owns its payload independently of normalized read content.
  */
 export type ProposalInputContent = {
+  /**
+   * At most five unique intents, each 1 through 2,048 characters after normalization. Omission is an empty list. Validation failures identify this member in the HTTP 400 errors array.
+   */
   intents?: Array<string> | undefined;
   /**
    * Exact-match attributes. Values are typed scalars or nonempty lists of typed scalars.
@@ -23,9 +26,6 @@ export type ProposalInputContent = {
    * Author-provided JSON metadata. Its normalized JSON encoding must not exceed 65,536 bytes or nesting depth 16; deployments may enforce lower limits. Exceeding the byte limit returns payload-too-large, while excessive nesting returns invalid-data.
    */
   metadata?: any | undefined;
-  /**
-   * Launch accepts FAQ only; future package inputs add their own members.
-   */
   payload: ProposalInputPayload;
 };
 

package/src/models/proposal-input-payload.ts

@@ -9,15 +9,39 @@ import {
   FaqContent$Outbound,
   FaqContent$outboundSchema,
 } from "./faq-content.js";
+import {
+  ProposalSkillPackage,
+  ProposalSkillPackage$Outbound,
+  ProposalSkillPackage$outboundSchema,
+} from "./proposal-skill-package.js";
+
+export type SkillPackage = {
+  skillPackage: ProposalSkillPackage;
+};
 
 export type ProposalInputPayloadFaq = {
   faq: FaqContent;
 };
 
-/**
- * Launch accepts FAQ only; future package inputs add their own members.
- */
-export type ProposalInputPayload = ProposalInputPayloadFaq;
+export type ProposalInputPayload = ProposalInputPayloadFaq | SkillPackage;
+
+/** @internal */
+export type SkillPackage$Outbound = {
+  skillPackage: ProposalSkillPackage$Outbound;
+};
+
+/** @internal */
+export const SkillPackage$outboundSchema: z.ZodType<
+  SkillPackage$Outbound,
+  z.ZodTypeDef,
+  SkillPackage
+> = z.object({
+  skillPackage: ProposalSkillPackage$outboundSchema,
+}).strict();
+
+export function skillPackageToJSON(skillPackage: SkillPackage): string {
+  return JSON.stringify(SkillPackage$outboundSchema.parse(skillPackage));
+}
 
 /** @internal */
 export type ProposalInputPayloadFaq$Outbound = {
@@ -31,7 +55,7 @@ export const ProposalInputPayloadFaq$outboundSchema: z.ZodType<
   ProposalInputPayloadFaq
 > = z.object({
   faq: FaqContent$outboundSchema,
-});
+}).strict();
 
 export function proposalInputPayloadFaqToJSON(
   proposalInputPayloadFaq: ProposalInputPayloadFaq,
@@ -42,14 +66,19 @@ export function proposalInputPayloadFaqToJSON(
 }
 
 /** @internal */
-export type ProposalInputPayload$Outbound = ProposalInputPayloadFaq$Outbound;
+export type ProposalInputPayload$Outbound =
+  | ProposalInputPayloadFaq$Outbound
+  | SkillPackage$Outbound;
 
 /** @internal */
 export const ProposalInputPayload$outboundSchema: z.ZodType<
   ProposalInputPayload$Outbound,
   z.ZodTypeDef,
   ProposalInputPayload
-> = z.lazy(() => ProposalInputPayloadFaq$outboundSchema);
+> = z.union([
+  z.lazy(() => ProposalInputPayloadFaq$outboundSchema),
+  z.lazy(() => SkillPackage$outboundSchema),
+]);
 
 export function proposalInputPayloadToJSON(
   proposalInputPayload: ProposalInputPayload,

package/src/models/proposal-payload.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9229af89ba92
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import { FaqContent, FaqContent$inboundSchema } from "./faq-content.js";
+import {
+  ProposalSkillContent,
+  ProposalSkillContent$inboundSchema,
+} from "./proposal-skill-content.js";
+
+export type ProposalPayloadSkill = {
+  skill: ProposalSkillContent;
+};
+
+export type ProposalPayloadFaq = {
+  faq: FaqContent;
+};
+
+export type ProposalPayload = ProposalPayloadFaq | ProposalPayloadSkill;
+
+/** @internal */
+export const ProposalPayloadSkill$inboundSchema: z.ZodType<
+  ProposalPayloadSkill,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skill: ProposalSkillContent$inboundSchema,
+});
+
+export function proposalPayloadSkillFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalPayloadSkill, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalPayloadSkill$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalPayloadSkill' from JSON`,
+  );
+}
+
+/** @internal */
+export const ProposalPayloadFaq$inboundSchema: z.ZodType<
+  ProposalPayloadFaq,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  faq: FaqContent$inboundSchema,
+});
+
+export function proposalPayloadFaqFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalPayloadFaq, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalPayloadFaq$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalPayloadFaq' from JSON`,
+  );
+}
+
+/** @internal */
+export const ProposalPayload$inboundSchema: z.ZodType<
+  ProposalPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => ProposalPayloadFaq$inboundSchema),
+  z.lazy(() => ProposalPayloadSkill$inboundSchema),
+]);
+
+export function proposalPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalPayload' from JSON`,
+  );
+}

package/src/models/proposal-preview.ts

@@ -12,21 +12,30 @@ import {
   ProposalActionPreview$inboundSchema,
 } from "./proposal-action-preview.js";
 import {
-  ProposalStatus,
-  ProposalStatus$inboundSchema,
-} from "./proposal-status.js";
+  ProposalState,
+  ProposalState$inboundSchema,
+} from "./proposal-state.js";
 
 /**
  * Compact management projection; GET the proposal for the complete candidate.
  */
 export type ProposalPreview = {
   proposalId: string;
-  status: ProposalStatus;
+  state: ProposalState;
   /**
    * Present for actions that author content; absent for candidate-free actions.
    */
   contentDigest?: string | undefined;
-  proposalRevision: number;
+  /**
+   * Resource revision. Opaque: each change to a resource's own configuration writes a
+   *
+   * @remarks
+   * new value, and a resource never gets a value it had before. Compare for equality
+   * only; its format is the service's, so only its length is constrained. Returned as
+   * `revision`; sent back as `expectedRevision` to make a write conditional. Omitting
+   * `expectedRevision` makes the write unconditional.
+   */
+  revision: string;
   /**
    * Attached records only, excluding creation source; not distinct sessions or confidence.
    */
@@ -62,9 +71,9 @@ export const ProposalPreview$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   proposalId: z.string(),
-  status: ProposalStatus$inboundSchema,
+  state: ProposalState$inboundSchema,
   contentDigest: z.string().optional(),
-  proposalRevision: z.number().int(),
+  revision: z.string(),
   evidenceCount: z.number().int(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),

package/src/models/proposal-resource.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e5e3820cfb48
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type ProposalResource = {
+  resourceId: string;
+  path: string;
+  /**
+   * SHA-256 digest of exact resource bytes in sha256:<lowercase-hex> form.
+   */
+  digest: string;
+  sizeBytes: number;
+  mimeType: string;
+  executable: boolean;
+};
+
+/** @internal */
+export const ProposalResource$inboundSchema: z.ZodType<
+  ProposalResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceId: z.string(),
+  path: z.string(),
+  digest: z.string(),
+  sizeBytes: z.number().int(),
+  mimeType: z.string(),
+  executable: z.boolean(),
+});
+
+export function proposalResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalResource' from JSON`,
+  );
+}