@factify/sdk 1.0.1 → 1.1.0-rc.10

package/src/models/components/qcrv1alphablock.ts

@@ -0,0 +1,613 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  QcrV1alphaCodeBlockData,
+  QcrV1alphaCodeBlockData$inboundSchema,
+} from "./qcrv1alphacodeblockdata.js";
+import {
+  QcrV1alphaFootnoteData,
+  QcrV1alphaFootnoteData$inboundSchema,
+} from "./qcrv1alphafootnotedata.js";
+import {
+  QcrV1alphaHeadingData,
+  QcrV1alphaHeadingData$inboundSchema,
+} from "./qcrv1alphaheadingdata.js";
+import {
+  QcrV1alphaListData,
+  QcrV1alphaListData$inboundSchema,
+} from "./qcrv1alphalistdata.js";
+import {
+  QcrV1alphaParagraphData,
+  QcrV1alphaParagraphData$inboundSchema,
+} from "./qcrv1alphaparagraphdata.js";
+import {
+  QcrV1alphaQuoteData,
+  QcrV1alphaQuoteData$inboundSchema,
+} from "./qcrv1alphaquotedata.js";
+import {
+  QcrV1alphaRasterImageData,
+  QcrV1alphaRasterImageData$inboundSchema,
+} from "./qcrv1alpharasterimagedata.js";
+import {
+  QcrV1alphaSectionData,
+  QcrV1alphaSectionData$inboundSchema,
+} from "./qcrv1alphasectiondata.js";
+import {
+  QcrV1alphaTableData,
+  QcrV1alphaTableData$inboundSchema,
+} from "./qcrv1alphatabledata.js";
+import {
+  QcrV1alphaThematicBreakData,
+  QcrV1alphaThematicBreakData$inboundSchema,
+} from "./qcrv1alphathematicbreakdata.js";
+import {
+  QcrV1alphaVectorImageData,
+  QcrV1alphaVectorImageData$inboundSchema,
+} from "./qcrv1alphavectorimagedata.js";
+import { Value, Value$inboundSchema } from "./value.js";
+
+export type ThematicBreak = {
+  /**
+   * Explicit authorial boundary (e.g. markdown `---`). Leaf block, no children.
+   */
+  thematicBreak: QcrV1alphaThematicBreakData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+export type QcrV1alphaBlockTable = {
+  table: QcrV1alphaTableData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+export type CodeBlock = {
+  codeBlock: QcrV1alphaCodeBlockData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+export type Figure = {
+  /**
+   * VectorImageData represents a vector graphic (SVG, diagram, chart).
+   */
+  figure: QcrV1alphaVectorImageData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+export type Footnote = {
+  footnote: QcrV1alphaFootnoteData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+export type Heading = {
+  heading: QcrV1alphaHeadingData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+export type Image = {
+  /**
+   * RasterImageData represents a raster image (PNG, JPEG, WebP, etc.).
+   */
+  image: QcrV1alphaRasterImageData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+export type List = {
+  list: QcrV1alphaListData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+export type Paragraph = {
+  paragraph: QcrV1alphaParagraphData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+export type Quote = {
+  quote: QcrV1alphaQuoteData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+/**
+ * Block is the unit of document content. Each block carries exactly one
+ *
+ * @remarks
+ *  type-specific payload via oneof. Blocks do not nest generically — only
+ *  SectionData can contain child blocks, enforcing valid containment at the
+ *  schema level.
+ */
+export type QcrV1alphaBlock =
+  | CodeBlock
+  | Figure
+  | Footnote
+  | Heading
+  | Image
+  | List
+  | Paragraph
+  | Quote
+  | Section
+  | QcrV1alphaBlockTable
+  | ThematicBreak;
+
+export type Section = {
+  /**
+   * Section groups blocks under a logical heading. Only sections can nest blocks.
+   */
+  section: QcrV1alphaSectionData;
+  /**
+   * `Struct` represents a structured data value, consisting of fields
+   *
+   * @remarks
+   *  which map to dynamically typed values. In some languages, `Struct`
+   *  might be supported by a native representation. For example, in
+   *  scripting languages like JS a struct is represented as an
+   *  object. The details of that representation are described together
+   *  with the proto support for the language.
+   *
+   *  The JSON representation for `Struct` is JSON object.
+   */
+  attributes?: { [k: string]: Value | null } | undefined;
+  /**
+   * Optional stable ID for external references (claim anchoring, annotations).
+   *
+   * @remarks
+   *  Not used for layout addressing — positional paths serve that purpose.
+   */
+  id?: string | undefined;
+};
+
+/** @internal */
+export const ThematicBreak$inboundSchema: z.ZodMiniType<
+  ThematicBreak,
+  unknown
+> = z.pipe(
+  z.object({
+    thematic_break: QcrV1alphaThematicBreakData$inboundSchema,
+    attributes: types.optional(
+      z.record(z.string(), types.nullable(Value$inboundSchema)),
+    ),
+    id: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "thematic_break": "thematicBreak",
+    });
+  }),
+);
+
+export function thematicBreakFromJSON(
+  jsonString: string,
+): SafeParseResult<ThematicBreak, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ThematicBreak$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ThematicBreak' from JSON`,
+  );
+}
+
+/** @internal */
+export const QcrV1alphaBlockTable$inboundSchema: z.ZodMiniType<
+  QcrV1alphaBlockTable,
+  unknown
+> = z.object({
+  table: QcrV1alphaTableData$inboundSchema,
+  attributes: types.optional(
+    z.record(z.string(), types.nullable(Value$inboundSchema)),
+  ),
+  id: types.optional(types.string()),
+});
+
+export function qcrV1alphaBlockTableFromJSON(
+  jsonString: string,
+): SafeParseResult<QcrV1alphaBlockTable, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QcrV1alphaBlockTable$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QcrV1alphaBlockTable' from JSON`,
+  );
+}
+
+/** @internal */
+export const CodeBlock$inboundSchema: z.ZodMiniType<CodeBlock, unknown> = z
+  .pipe(
+    z.object({
+      code_block: QcrV1alphaCodeBlockData$inboundSchema,
+      attributes: types.optional(
+        z.record(z.string(), types.nullable(Value$inboundSchema)),
+      ),
+      id: types.optional(types.string()),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        "code_block": "codeBlock",
+      });
+    }),
+  );
+
+export function codeBlockFromJSON(
+  jsonString: string,
+): SafeParseResult<CodeBlock, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CodeBlock$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CodeBlock' from JSON`,
+  );
+}
+
+/** @internal */
+export const Figure$inboundSchema: z.ZodMiniType<Figure, unknown> = z.object({
+  figure: QcrV1alphaVectorImageData$inboundSchema,
+  attributes: types.optional(
+    z.record(z.string(), types.nullable(Value$inboundSchema)),
+  ),
+  id: types.optional(types.string()),
+});
+
+export function figureFromJSON(
+  jsonString: string,
+): SafeParseResult<Figure, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Figure$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Figure' from JSON`,
+  );
+}
+
+/** @internal */
+export const Footnote$inboundSchema: z.ZodMiniType<Footnote, unknown> = z
+  .object({
+    footnote: QcrV1alphaFootnoteData$inboundSchema,
+    attributes: types.optional(
+      z.record(z.string(), types.nullable(Value$inboundSchema)),
+    ),
+    id: types.optional(types.string()),
+  });
+
+export function footnoteFromJSON(
+  jsonString: string,
+): SafeParseResult<Footnote, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Footnote$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Footnote' from JSON`,
+  );
+}
+
+/** @internal */
+export const Heading$inboundSchema: z.ZodMiniType<Heading, unknown> = z.object({
+  heading: QcrV1alphaHeadingData$inboundSchema,
+  attributes: types.optional(
+    z.record(z.string(), types.nullable(Value$inboundSchema)),
+  ),
+  id: types.optional(types.string()),
+});
+
+export function headingFromJSON(
+  jsonString: string,
+): SafeParseResult<Heading, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Heading$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Heading' from JSON`,
+  );
+}
+
+/** @internal */
+export const Image$inboundSchema: z.ZodMiniType<Image, unknown> = z.object({
+  image: QcrV1alphaRasterImageData$inboundSchema,
+  attributes: types.optional(
+    z.record(z.string(), types.nullable(Value$inboundSchema)),
+  ),
+  id: types.optional(types.string()),
+});
+
+export function imageFromJSON(
+  jsonString: string,
+): SafeParseResult<Image, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Image$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Image' from JSON`,
+  );
+}
+
+/** @internal */
+export const List$inboundSchema: z.ZodMiniType<List, unknown> = z.object({
+  list: QcrV1alphaListData$inboundSchema,
+  attributes: types.optional(
+    z.record(z.string(), types.nullable(Value$inboundSchema)),
+  ),
+  id: types.optional(types.string()),
+});
+
+export function listFromJSON(
+  jsonString: string,
+): SafeParseResult<List, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => List$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'List' from JSON`,
+  );
+}
+
+/** @internal */
+export const Paragraph$inboundSchema: z.ZodMiniType<Paragraph, unknown> = z
+  .object({
+    paragraph: QcrV1alphaParagraphData$inboundSchema,
+    attributes: types.optional(
+      z.record(z.string(), types.nullable(Value$inboundSchema)),
+    ),
+    id: types.optional(types.string()),
+  });
+
+export function paragraphFromJSON(
+  jsonString: string,
+): SafeParseResult<Paragraph, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Paragraph$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Paragraph' from JSON`,
+  );
+}
+
+/** @internal */
+export const Quote$inboundSchema: z.ZodMiniType<Quote, unknown> = z.object({
+  quote: QcrV1alphaQuoteData$inboundSchema,
+  attributes: types.optional(
+    z.record(z.string(), types.nullable(Value$inboundSchema)),
+  ),
+  id: types.optional(types.string()),
+});
+
+export function quoteFromJSON(
+  jsonString: string,
+): SafeParseResult<Quote, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Quote$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Quote' from JSON`,
+  );
+}
+
+/** @internal */
+export const QcrV1alphaBlock$inboundSchema: z.ZodMiniType<
+  QcrV1alphaBlock,
+  unknown
+> = smartUnion([
+  z.lazy(() => CodeBlock$inboundSchema),
+  z.lazy(() => Figure$inboundSchema),
+  z.lazy(() => Footnote$inboundSchema),
+  z.lazy(() => Heading$inboundSchema),
+  z.lazy(() => Image$inboundSchema),
+  z.lazy(() => List$inboundSchema),
+  z.lazy(() => Paragraph$inboundSchema),
+  z.lazy(() => Quote$inboundSchema),
+  z.lazy(() => Section$inboundSchema),
+  z.lazy(() => QcrV1alphaBlockTable$inboundSchema),
+  z.lazy(() => ThematicBreak$inboundSchema),
+]);
+
+export function qcrV1alphaBlockFromJSON(
+  jsonString: string,
+): SafeParseResult<QcrV1alphaBlock, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QcrV1alphaBlock$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QcrV1alphaBlock' from JSON`,
+  );
+}
+
+/** @internal */
+export const Section$inboundSchema: z.ZodMiniType<Section, unknown> = z.object({
+  section: z.lazy(() => QcrV1alphaSectionData$inboundSchema),
+  attributes: types.optional(
+    z.record(z.string(), types.nullable(Value$inboundSchema)),
+  ),
+  id: types.optional(types.string()),
+});
+
+export function sectionFromJSON(
+  jsonString: string,
+): SafeParseResult<Section, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Section$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Section' from JSON`,
+  );
+}

package/src/models/components/qcrv1alphablockpath.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  QcrV1alphaPathSegment,
+  QcrV1alphaPathSegment$inboundSchema,
+} from "./qcrv1alphapathsegment.js";
+
+/**
+ * BlockPath addresses an element within the record's typed containment
+ *
+ * @remarks
+ *  hierarchy. Each segment steps into a specific typed child collection.
+ *
+ *  Examples:
+ *    [block(2)]                                → blocks[2]
+ *    [block(2), block(0)]                      → blocks[2].section.blocks[0]
+ *    [block(4), row(1), cell(0)]               → blocks[4].table.rows[1].cells[0]
+ *    [block(3), item(2)]                       → blocks[3].list.items[2]
+ *    [block(3), item(2), item(0)]              → nested sub-list item
+ *
+ *  The path is unambiguous because each segment type implies which child
+ *  collection to descend into (blocks for sections, rows for tables, etc.).
+ */
+export type QcrV1alphaBlockPath = {
+  segments?: Array<QcrV1alphaPathSegment> | undefined;
+};
+
+/** @internal */
+export const QcrV1alphaBlockPath$inboundSchema: z.ZodMiniType<
+  QcrV1alphaBlockPath,
+  unknown
+> = z.object({
+  segments: types.optional(z.array(QcrV1alphaPathSegment$inboundSchema)),
+});
+
+export function qcrV1alphaBlockPathFromJSON(
+  jsonString: string,
+): SafeParseResult<QcrV1alphaBlockPath, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QcrV1alphaBlockPath$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QcrV1alphaBlockPath' from JSON`,
+  );
+}