@unified-api/typescript-sdk 2.9.3 → 2.9.5

package/src/lib/primitives.ts

@@ -58,3 +58,65 @@ export function remap<
 
   return out;
 }
+
+export function combineSignals(
+  ...signals: Array<AbortSignal | null | undefined>
+): AbortSignal | null {
+  const filtered: AbortSignal[] = [];
+  for (const signal of signals) {
+    if (signal) {
+      filtered.push(signal);
+    }
+  }
+
+  switch (filtered.length) {
+    case 0:
+    case 1:
+      return filtered[0] || null;
+    default:
+      if ("any" in AbortSignal && typeof AbortSignal.any === "function") {
+        return AbortSignal.any(filtered);
+      }
+      return abortSignalAny(filtered);
+  }
+}
+
+export function abortSignalAny(signals: AbortSignal[]): AbortSignal {
+  const controller = new AbortController();
+  const result = controller.signal;
+  if (!signals.length) {
+    return controller.signal;
+  }
+
+  if (signals.length === 1) {
+    return signals[0] || controller.signal;
+  }
+
+  for (const signal of signals) {
+    if (signal.aborted) {
+      return signal;
+    }
+  }
+
+  function abort(this: AbortSignal) {
+    controller.abort(this.reason);
+    clean();
+  }
+
+  const signalRefs: WeakRef<AbortSignal>[] = [];
+  function clean() {
+    for (const signalRef of signalRefs) {
+      const signal = signalRef.deref();
+      if (signal) {
+        signal.removeEventListener("abort", abort);
+      }
+    }
+  }
+
+  for (const signal of signals) {
+    signalRefs.push(new WeakRef(signal));
+    signal.addEventListener("abort", abort);
+  }
+
+  return result;
+}

package/src/sdk/models/shared/index.ts

@@ -77,6 +77,7 @@ export * from "./integration.js";
 export * from "./integrationsupport.js";
 export * from "./issue.js";
 export * from "./kmspage.js";
+export * from "./kmspagemetadata.js";
 export * from "./kmsspace.js";
 export * from "./lmsclass.js";
 export * from "./lmscourse.js";

package/src/sdk/models/shared/kmspage.ts

@@ -8,6 +8,12 @@ import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  KmsPageMetadata,
+  KmsPageMetadata$inboundSchema,
+  KmsPageMetadata$Outbound,
+  KmsPageMetadata$outboundSchema,
+} from "./kmspagemetadata.js";
 
 export const KmsPageType = {
   Html: "HTML",
@@ -19,8 +25,10 @@ export type KmsPageType = ClosedEnum<typeof KmsPageType>;
 export type KmsPage = {
   createdAt?: Date | undefined;
   downloadUrl: string;
+  hasChildren?: boolean | undefined;
   id?: string | undefined;
   isActive?: boolean | undefined;
+  metadata?: Array<KmsPageMetadata> | undefined;
   parentPageId?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   spaceId: string;
@@ -56,8 +64,10 @@ export const KmsPage$inboundSchema: z.ZodType<KmsPage, z.ZodTypeDef, unknown> =
       new Date(v)
     ).optional(),
     download_url: z.string(),
+    has_children: z.boolean().optional(),
     id: z.string().optional(),
     is_active: z.boolean().optional(),
+    metadata: z.array(KmsPageMetadata$inboundSchema).optional(),
     parent_page_id: z.string().optional(),
     raw: z.record(z.any()).optional(),
     space_id: z.string(),
@@ -71,6 +81,7 @@ export const KmsPage$inboundSchema: z.ZodType<KmsPage, z.ZodTypeDef, unknown> =
     return remap$(v, {
       "created_at": "createdAt",
       "download_url": "downloadUrl",
+      "has_children": "hasChildren",
       "is_active": "isActive",
       "parent_page_id": "parentPageId",
       "space_id": "spaceId",
@@ -83,8 +94,10 @@ export const KmsPage$inboundSchema: z.ZodType<KmsPage, z.ZodTypeDef, unknown> =
 export type KmsPage$Outbound = {
   created_at?: string | undefined;
   download_url: string;
+  has_children?: boolean | undefined;
   id?: string | undefined;
   is_active?: boolean | undefined;
+  metadata?: Array<KmsPageMetadata$Outbound> | undefined;
   parent_page_id?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   space_id: string;
@@ -102,8 +115,10 @@ export const KmsPage$outboundSchema: z.ZodType<
 > = z.object({
   createdAt: z.date().transform(v => v.toISOString()).optional(),
   downloadUrl: z.string(),
+  hasChildren: z.boolean().optional(),
   id: z.string().optional(),
   isActive: z.boolean().optional(),
+  metadata: z.array(KmsPageMetadata$outboundSchema).optional(),
   parentPageId: z.string().optional(),
   raw: z.record(z.any()).optional(),
   spaceId: z.string(),
@@ -115,6 +130,7 @@ export const KmsPage$outboundSchema: z.ZodType<
   return remap$(v, {
     createdAt: "created_at",
     downloadUrl: "download_url",
+    hasChildren: "has_children",
     isActive: "is_active",
     parentPageId: "parent_page_id",
     spaceId: "space_id",

package/src/sdk/models/shared/kmspagemetadata.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type KmsPageMetadata = {
+  name: string;
+  type?: string | undefined;
+  value?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const KmsPageMetadata$inboundSchema: z.ZodType<
+  KmsPageMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  type: z.string().optional(),
+  value: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type KmsPageMetadata$Outbound = {
+  name: string;
+  type?: string | undefined;
+  value?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const KmsPageMetadata$outboundSchema: z.ZodType<
+  KmsPageMetadata$Outbound,
+  z.ZodTypeDef,
+  KmsPageMetadata
+> = z.object({
+  name: z.string(),
+  type: z.string().optional(),
+  value: z.record(z.any()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace KmsPageMetadata$ {
+  /** @deprecated use `KmsPageMetadata$inboundSchema` instead. */
+  export const inboundSchema = KmsPageMetadata$inboundSchema;
+  /** @deprecated use `KmsPageMetadata$outboundSchema` instead. */
+  export const outboundSchema = KmsPageMetadata$outboundSchema;
+  /** @deprecated use `KmsPageMetadata$Outbound` instead. */
+  export type Outbound = KmsPageMetadata$Outbound;
+}
+
+export function kmsPageMetadataToJSON(
+  kmsPageMetadata: KmsPageMetadata,
+): string {
+  return JSON.stringify(KmsPageMetadata$outboundSchema.parse(kmsPageMetadata));
+}
+
+export function kmsPageMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<KmsPageMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => KmsPageMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'KmsPageMetadata' from JSON`,
+  );
+}

package/src/sdk/models/shared/kmsspace.ts

@@ -14,6 +14,7 @@ export type KmsSpace = {
   id?: string | undefined;
   isActive?: boolean | undefined;
   name: string;
+  parentPageId?: string | undefined;
   parentSpaceId?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   updatedAt?: Date | undefined;
@@ -32,6 +33,7 @@ export const KmsSpace$inboundSchema: z.ZodType<
   id: z.string().optional(),
   is_active: z.boolean().optional(),
   name: z.string(),
+  parent_page_id: z.string().optional(),
   parent_space_id: z.string().default("sp"),
   raw: z.record(z.any()).optional(),
   updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
@@ -41,6 +43,7 @@ export const KmsSpace$inboundSchema: z.ZodType<
   return remap$(v, {
     "created_at": "createdAt",
     "is_active": "isActive",
+    "parent_page_id": "parentPageId",
     "parent_space_id": "parentSpaceId",
     "updated_at": "updatedAt",
     "user_id": "userId",
@@ -54,6 +57,7 @@ export type KmsSpace$Outbound = {
   id?: string | undefined;
   is_active?: boolean | undefined;
   name: string;
+  parent_page_id?: string | undefined;
   parent_space_id: string;
   raw?: { [k: string]: any } | undefined;
   updated_at?: string | undefined;
@@ -71,6 +75,7 @@ export const KmsSpace$outboundSchema: z.ZodType<
   id: z.string().optional(),
   isActive: z.boolean().optional(),
   name: z.string(),
+  parentPageId: z.string().optional(),
   parentSpaceId: z.string().default("sp"),
   raw: z.record(z.any()).optional(),
   updatedAt: z.date().transform(v => v.toISOString()).optional(),
@@ -79,6 +84,7 @@ export const KmsSpace$outboundSchema: z.ZodType<
   return remap$(v, {
     createdAt: "created_at",
     isActive: "is_active",
+    parentPageId: "parent_page_id",
     parentSpaceId: "parent_space_id",
     updatedAt: "updated_at",
     userId: "user_id",

package/src/sdk/models/shared/security.ts

@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Security = {
-  jwt?: string | undefined;
+  jwt: string;
 };
 
 /** @internal */
@@ -17,12 +17,12 @@ export const Security$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  jwt: z.string().optional(),
+  jwt: z.string(),
 });
 
 /** @internal */
 export type Security$Outbound = {
-  jwt?: string | undefined;
+  jwt: string;
 };
 
 /** @internal */
@@ -31,7 +31,7 @@ export const Security$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Security
 > = z.object({
-  jwt: z.string().optional(),
+  jwt: z.string(),
 });
 
 /**

package/src/sdk/types/operations.ts

@@ -6,9 +6,10 @@ import { Result } from "./fp.js";
 
 export type Paginator<V> = () => Promise<V & { next: Paginator<V> }> | null;
 
-export type PageIterator<V> = V & {
+export type PageIterator<V, PageState = unknown> = V & {
   next: Paginator<V>;
   [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+  "~next"?: PageState | undefined;
 };
 
 export function createPageIterator<V>(
@@ -40,7 +41,9 @@ export function createPageIterator<V>(
  * terminates. It is useful in paginated SDK functions that have early return
  * paths when things go wrong.
  */
-export function haltIterator<V extends object>(v: V): PageIterator<V> {
+export function haltIterator<V extends object>(
+  v: V,
+): PageIterator<V, undefined> {
   return {
     ...v,
     next: () => null,
@@ -54,9 +57,9 @@ export function haltIterator<V extends object>(v: V): PageIterator<V> {
  * Converts an async iterator of `Result<V, E>` into an async iterator of `V`.
  * When error results occur, the underlying error value is thrown.
  */
-export async function unwrapResultIterator<V>(
-  iteratorPromise: Promise<PageIterator<Result<V, unknown>>>,
-): Promise<PageIterator<V>> {
+export async function unwrapResultIterator<V, PageState>(
+  iteratorPromise: Promise<PageIterator<Result<V, unknown>, PageState>>,
+): Promise<PageIterator<V, PageState>> {
   const resultIter = await iteratorPromise;
 
   if (!resultIter.ok) {
@@ -66,6 +69,7 @@ export async function unwrapResultIterator<V>(
   return {
     ...resultIter.value,
     next: unwrapPaginator(resultIter.next),
+    "~next": resultIter["~next"],
     [Symbol.asyncIterator]: async function* paginator() {
       for await (const page of resultIter) {
         if (!page.ok) {
@@ -97,3 +101,5 @@ function unwrapPaginator<V>(
     });
   };
 }
+
+export const URL_OVERRIDE = Symbol("URL_OVERRIDE");