@factify/sdk 0.3.6

package/src/lib/security.ts

@@ -0,0 +1,263 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as components from "../models/components/index.js";
+
+type OAuth2PasswordFlow = {
+  username: string;
+  password: string;
+  clientID?: string | undefined;
+  clientSecret?: string | undefined;
+  tokenURL: string;
+};
+
+export enum SecurityErrorCode {
+  Incomplete = "incomplete",
+  UnrecognisedSecurityType = "unrecognized_security_type",
+}
+
+export class SecurityError extends Error {
+  constructor(
+    public code: SecurityErrorCode,
+    message: string,
+  ) {
+    super(message);
+    this.name = "SecurityError";
+  }
+
+  static incomplete(): SecurityError {
+    return new SecurityError(
+      SecurityErrorCode.Incomplete,
+      "Security requirements not met in order to perform the operation",
+    );
+  }
+  static unrecognizedType(type: string): SecurityError {
+    return new SecurityError(
+      SecurityErrorCode.UnrecognisedSecurityType,
+      `Unrecognised security type: ${type}`,
+    );
+  }
+}
+
+export type SecurityState = {
+  basic: { username?: string | undefined; password?: string | undefined };
+  headers: Record<string, string>;
+  queryParams: Record<string, string>;
+  cookies: Record<string, string>;
+  oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" };
+};
+
+type SecurityInputBasic = {
+  type: "http:basic";
+  value:
+    | { username?: string | undefined; password?: string | undefined }
+    | null
+    | undefined;
+};
+
+type SecurityInputBearer = {
+  type: "http:bearer";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputAPIKey = {
+  type: "apiKey:header" | "apiKey:query" | "apiKey:cookie";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOIDC = {
+  type: "openIdConnect";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOAuth2 = {
+  type: "oauth2";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOAuth2ClientCredentials = {
+  type: "oauth2:client_credentials";
+  value:
+    | {
+      clientID?: string | undefined;
+      clientSecret?: string | undefined;
+    }
+    | null
+    | string
+    | undefined;
+  fieldName?: string;
+};
+
+type SecurityInputOAuth2PasswordCredentials = {
+  type: "oauth2:password";
+  value:
+    | string
+    | null
+    | undefined;
+  fieldName?: string;
+};
+
+type SecurityInputCustom = {
+  type: "http:custom";
+  value: any | null | undefined;
+  fieldName?: string;
+};
+
+export type SecurityInput =
+  | SecurityInputBasic
+  | SecurityInputBearer
+  | SecurityInputAPIKey
+  | SecurityInputOAuth2
+  | SecurityInputOAuth2ClientCredentials
+  | SecurityInputOAuth2PasswordCredentials
+  | SecurityInputOIDC
+  | SecurityInputCustom;
+
+export function resolveSecurity(
+  ...options: SecurityInput[][]
+): SecurityState | null {
+  const state: SecurityState = {
+    basic: {},
+    headers: {},
+    queryParams: {},
+    cookies: {},
+    oauth2: { type: "none" },
+  };
+
+  const option = options.find((opts) => {
+    return opts.every((o) => {
+      if (o.value == null) {
+        return false;
+      } else if (o.type === "http:basic") {
+        return o.value.username != null || o.value.password != null;
+      } else if (o.type === "http:custom") {
+        return null;
+      } else if (o.type === "oauth2:password") {
+        return (
+          typeof o.value === "string" && !!o.value
+        );
+      } else if (o.type === "oauth2:client_credentials") {
+        if (typeof o.value == "string") {
+          return !!o.value;
+        }
+        return o.value.clientID != null || o.value.clientSecret != null;
+      } else if (typeof o.value === "string") {
+        return !!o.value;
+      } else {
+        throw new Error(
+          `Unrecognized security type: ${o.type} (value type: ${typeof o
+            .value})`,
+        );
+      }
+    });
+  });
+  if (option == null) {
+    return null;
+  }
+
+  option.forEach((spec) => {
+    if (spec.value == null) {
+      return;
+    }
+
+    const { type } = spec;
+
+    switch (type) {
+      case "apiKey:header":
+        state.headers[spec.fieldName] = spec.value;
+        break;
+      case "apiKey:query":
+        state.queryParams[spec.fieldName] = spec.value;
+        break;
+      case "apiKey:cookie":
+        state.cookies[spec.fieldName] = spec.value;
+        break;
+      case "http:basic":
+        applyBasic(state, spec);
+        break;
+      case "http:custom":
+        break;
+      case "http:bearer":
+        applyBearer(state, spec);
+        break;
+      case "oauth2":
+        applyBearer(state, spec);
+        break;
+      case "oauth2:password":
+        applyBearer(state, spec);
+        break;
+      case "oauth2:client_credentials":
+        break;
+      case "openIdConnect":
+        applyBearer(state, spec);
+        break;
+      default:
+        spec satisfies never;
+        throw SecurityError.unrecognizedType(type);
+    }
+  });
+
+  return state;
+}
+
+function applyBasic(
+  state: SecurityState,
+  spec: SecurityInputBasic,
+) {
+  if (spec.value == null) {
+    return;
+  }
+
+  state.basic = spec.value;
+}
+
+function applyBearer(
+  state: SecurityState,
+  spec:
+    | SecurityInputBearer
+    | SecurityInputOAuth2
+    | SecurityInputOIDC
+    | SecurityInputOAuth2PasswordCredentials,
+) {
+  if (typeof spec.value !== "string" || !spec.value) {
+    return;
+  }
+
+  let value = spec.value;
+  if (value.slice(0, 7).toLowerCase() !== "bearer ") {
+    value = `Bearer ${value}`;
+  }
+
+  if (spec.fieldName !== undefined) {
+    state.headers[spec.fieldName] = value;
+  }
+}
+
+export function resolveGlobalSecurity(
+  security: Partial<components.Security> | null | undefined,
+): SecurityState | null {
+  return resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.bearerAuth,
+      },
+    ],
+  );
+}
+
+export async function extractSecurity<
+  T extends string | Record<string, unknown>,
+>(sec: T | (() => Promise<T>) | undefined): Promise<T | undefined> {
+  if (sec == null) {
+    return;
+  }
+
+  return typeof sec === "function" ? sec() : sec;
+}

package/src/lib/url.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+const hasOwn = Object.prototype.hasOwnProperty;
+
+export type Params = Partial<Record<string, string | number>>;
+
+export function pathToFunc(
+  pathPattern: string,
+  options?: { charEncoding?: "percent" | "none" },
+): (params?: Params) => string {
+  const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
+
+  return function buildURLPath(params: Record<string, unknown> = {}): string {
+    return pathPattern.replace(paramRE, function (_, placeholder) {
+      if (!hasOwn.call(params, placeholder)) {
+        throw new Error(`Parameter '${placeholder}' is required`);
+      }
+
+      const value = params[placeholder];
+      if (typeof value !== "string" && typeof value !== "number") {
+        throw new Error(
+          `Parameter '${placeholder}' must be a string or number`,
+        );
+      }
+
+      return options?.charEncoding === "percent"
+        ? encodeURIComponent(`${value}`)
+        : `${value}`;
+    });
+  };
+}

package/src/models/components/accesslevel.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const AccessLevel = {
+  Private: "private",
+  Organization: "organization",
+  Public: "public",
+} as const;
+export type AccessLevel = OpenEnum<typeof AccessLevel>;
+
+/** @internal */
+export const AccessLevel$inboundSchema: z.ZodMiniType<AccessLevel, unknown> =
+  openEnums.inboundSchema(AccessLevel);
+/** @internal */
+export const AccessLevel$outboundSchema: z.ZodMiniType<string, AccessLevel> =
+  openEnums.outboundSchema(AccessLevel);

package/src/models/components/createdocumentrequest.ts

@@ -0,0 +1,99 @@
+/*
+ * 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 { blobLikeSchema } from "../../types/blobs.js";
+import { AccessLevel, AccessLevel$outboundSchema } from "./accesslevel.js";
+
+export type CreateDocumentRequestPayload = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/**
+ * CreateDocumentRequest contains the file and metadata for creating a document.
+ */
+export type CreateDocumentRequest = {
+  accessLevel?: AccessLevel | undefined;
+  /**
+   * Optional document description.
+   */
+  description?: string | null | undefined;
+  /**
+   * PDF file to upload
+   */
+  payload: CreateDocumentRequestPayload | Blob;
+  /**
+   * Document title.
+   */
+  title: string;
+};
+
+/** @internal */
+export type CreateDocumentRequestPayload$Outbound = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/** @internal */
+export const CreateDocumentRequestPayload$outboundSchema: z.ZodMiniType<
+  CreateDocumentRequestPayload$Outbound,
+  CreateDocumentRequestPayload
+> = z.object({
+  fileName: z.string(),
+  content: z.union([
+    z.custom<ReadableStream<Uint8Array>>(x => x instanceof ReadableStream),
+    z.custom<Blob>(x => x instanceof Blob),
+    z.custom<ArrayBuffer>(x => x instanceof ArrayBuffer),
+    z.custom<Uint8Array>(x => x instanceof Uint8Array),
+  ]),
+});
+
+export function createDocumentRequestPayloadToJSON(
+  createDocumentRequestPayload: CreateDocumentRequestPayload,
+): string {
+  return JSON.stringify(
+    CreateDocumentRequestPayload$outboundSchema.parse(
+      createDocumentRequestPayload,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateDocumentRequest$Outbound = {
+  access_level?: string | undefined;
+  description?: string | null | undefined;
+  payload: CreateDocumentRequestPayload$Outbound | Blob;
+  title: string;
+};
+
+/** @internal */
+export const CreateDocumentRequest$outboundSchema: z.ZodMiniType<
+  CreateDocumentRequest$Outbound,
+  CreateDocumentRequest
+> = z.pipe(
+  z.object({
+    accessLevel: z.optional(AccessLevel$outboundSchema),
+    description: z.optional(z.nullable(z.string())),
+    payload: z.union([
+      z.lazy(() => CreateDocumentRequestPayload$outboundSchema),
+      blobLikeSchema,
+    ]),
+    title: z.string(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      accessLevel: "access_level",
+    });
+  }),
+);
+
+export function createDocumentRequestToJSON(
+  createDocumentRequest: CreateDocumentRequest,
+): string {
+  return JSON.stringify(
+    CreateDocumentRequest$outboundSchema.parse(createDocumentRequest),
+  );
+}

package/src/models/components/createdocumentresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 { Document, Document$inboundSchema } from "./document.js";
+
+/**
+ * CreateDocumentResponse contains the newly created document.
+ */
+export type CreateDocumentResponse = {
+  /**
+   * Document represents a Factify document.
+   */
+  document?: Document | undefined;
+};
+
+/** @internal */
+export const CreateDocumentResponse$inboundSchema: z.ZodMiniType<
+  CreateDocumentResponse,
+  unknown
+> = z.object({
+  document: types.optional(Document$inboundSchema),
+});
+
+export function createDocumentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateDocumentResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateDocumentResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateDocumentResponse' from JSON`,
+  );
+}

package/src/models/components/createversionrequest.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 { blobLikeSchema } from "../../types/blobs.js";
+
+export type CreateVersionRequestPayload = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/**
+ * CreateVersionRequest contains the file and metadata for creating a version.
+ */
+export type CreateVersionRequest = {
+  /**
+   * Description of changes in this version.
+   */
+  description?: string | null | undefined;
+  /**
+   * Document ID to create version for.
+   *
+   * @remarks
+   *  Pattern: doc_[0-9a-hjkmnp-tv-z]{26}
+   */
+  documentId?: string | undefined;
+  /**
+   * PDF file for new version
+   */
+  payload: CreateVersionRequestPayload | Blob;
+  /**
+   * Optional version title.
+   */
+  title?: string | null | undefined;
+};
+
+/** @internal */
+export type CreateVersionRequestPayload$Outbound = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/** @internal */
+export const CreateVersionRequestPayload$outboundSchema: z.ZodMiniType<
+  CreateVersionRequestPayload$Outbound,
+  CreateVersionRequestPayload
+> = z.object({
+  fileName: z.string(),
+  content: z.union([
+    z.custom<ReadableStream<Uint8Array>>(x => x instanceof ReadableStream),
+    z.custom<Blob>(x => x instanceof Blob),
+    z.custom<ArrayBuffer>(x => x instanceof ArrayBuffer),
+    z.custom<Uint8Array>(x => x instanceof Uint8Array),
+  ]),
+});
+
+export function createVersionRequestPayloadToJSON(
+  createVersionRequestPayload: CreateVersionRequestPayload,
+): string {
+  return JSON.stringify(
+    CreateVersionRequestPayload$outboundSchema.parse(
+      createVersionRequestPayload,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateVersionRequest$Outbound = {
+  description?: string | null | undefined;
+  document_id?: string | undefined;
+  payload: CreateVersionRequestPayload$Outbound | Blob;
+  title?: string | null | undefined;
+};
+
+/** @internal */
+export const CreateVersionRequest$outboundSchema: z.ZodMiniType<
+  CreateVersionRequest$Outbound,
+  CreateVersionRequest
+> = z.pipe(
+  z.object({
+    description: z.optional(z.nullable(z.string())),
+    documentId: z.optional(z.string()),
+    payload: z.union([
+      z.lazy(() => CreateVersionRequestPayload$outboundSchema),
+      blobLikeSchema,
+    ]),
+    title: z.optional(z.nullable(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      documentId: "document_id",
+    });
+  }),
+);
+
+export function createVersionRequestToJSON(
+  createVersionRequest: CreateVersionRequest,
+): string {
+  return JSON.stringify(
+    CreateVersionRequest$outboundSchema.parse(createVersionRequest),
+  );
+}

package/src/models/components/document.ts

@@ -0,0 +1,90 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { AccessLevel, AccessLevel$inboundSchema } from "./accesslevel.js";
+import {
+  ProcessingStatus,
+  ProcessingStatus$inboundSchema,
+} from "./processingstatus.js";
+import { User, User$inboundSchema } from "./user.js";
+import { VersionRef, VersionRef$inboundSchema } from "./versionref.js";
+
+/**
+ * Document represents a Factify document.
+ */
+export type Document = {
+  accessLevel: AccessLevel;
+  /**
+   * Timestamp when document was created.
+   */
+  createdAt: Date;
+  /**
+   * User represents a user or service account.
+   */
+  createdBy: User;
+  /**
+   * VersionRef is a lightweight reference to a version.
+   */
+  currentVersion?: VersionRef | undefined;
+  /**
+   * Optional document description.
+   */
+  description?: string | null | undefined;
+  /**
+   * Unique ID for the document.
+   *
+   * @remarks
+   *  Pattern: doc_[0-9a-hjkmnp-tv-z]{26}
+   */
+  id: string;
+  processingStatus: ProcessingStatus;
+  /**
+   * Document title.
+   */
+  title: string;
+  /**
+   * URL for accessing the document on Factify.
+   */
+  url: string;
+};
+
+/** @internal */
+export const Document$inboundSchema: z.ZodMiniType<Document, unknown> = z.pipe(
+  z.object({
+    access_level: AccessLevel$inboundSchema,
+    created_at: types.date(),
+    created_by: User$inboundSchema,
+    current_version: types.optional(VersionRef$inboundSchema),
+    description: z.optional(z.nullable(types.string())),
+    id: types.string(),
+    processing_status: ProcessingStatus$inboundSchema,
+    title: types.string(),
+    url: types.string(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "access_level": "accessLevel",
+      "created_at": "createdAt",
+      "created_by": "createdBy",
+      "current_version": "currentVersion",
+      "processing_status": "processingStatus",
+    });
+  }),
+);
+
+export function documentFromJSON(
+  jsonString: string,
+): SafeParseResult<Document, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Document$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Document' from JSON`,
+  );
+}