@functional-systems/lambdadb 0.1.3

package/src/lib/security.ts

@@ -0,0 +1,261 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as models from "../models/index.js";
+import { env } from "./env.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<models.Security> | null | undefined,
+): SecurityState | null {
+  return resolveSecurity(
+    [
+      {
+        fieldName: "x-api-key",
+        type: "apiKey:header",
+        value: security?.projectApiKey ?? env().LAMBDADB_PROJECT_API_KEY,
+      },
+    ],
+  );
+}
+
+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_]+?)\}/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/collectionresponse.ts

@@ -0,0 +1,126 @@
+/*
+ * 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";
+import {
+  IndexConfigsUnion,
+  IndexConfigsUnion$inboundSchema,
+  IndexConfigsUnion$Outbound,
+  IndexConfigsUnion$outboundSchema,
+} from "./indexconfigsunion.js";
+import {
+  Status,
+  Status$inboundSchema,
+  Status$outboundSchema,
+} from "./status.js";
+
+export type CollectionResponse = {
+  /**
+   * Project name.
+   */
+  projectName: string;
+  /**
+   * Collection name.
+   */
+  collectionName: string;
+  indexConfigs: { [k: string]: IndexConfigsUnion };
+  /**
+   * Total number of documents.
+   */
+  numDocs: number;
+  /**
+   * Source project name.
+   */
+  sourceProjectName?: string | undefined;
+  /**
+   * Source collection name.
+   */
+  sourceCollectionName?: string | undefined;
+  /**
+   * Source collection version.
+   */
+  sourceCollectionVersionId?: string | undefined;
+  /**
+   * Status
+   */
+  collectionStatus: Status;
+};
+
+/** @internal */
+export const CollectionResponse$inboundSchema: z.ZodType<
+  CollectionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  projectName: z.string(),
+  collectionName: z.string(),
+  indexConfigs: z.record(IndexConfigsUnion$inboundSchema),
+  numDocs: z.number().int(),
+  sourceProjectName: z.string().optional(),
+  sourceCollectionName: z.string().optional(),
+  sourceCollectionVersionId: z.string().optional(),
+  collectionStatus: Status$inboundSchema,
+});
+
+/** @internal */
+export type CollectionResponse$Outbound = {
+  projectName: string;
+  collectionName: string;
+  indexConfigs: { [k: string]: IndexConfigsUnion$Outbound };
+  numDocs: number;
+  sourceProjectName?: string | undefined;
+  sourceCollectionName?: string | undefined;
+  sourceCollectionVersionId?: string | undefined;
+  collectionStatus: string;
+};
+
+/** @internal */
+export const CollectionResponse$outboundSchema: z.ZodType<
+  CollectionResponse$Outbound,
+  z.ZodTypeDef,
+  CollectionResponse
+> = z.object({
+  projectName: z.string(),
+  collectionName: z.string(),
+  indexConfigs: z.record(IndexConfigsUnion$outboundSchema),
+  numDocs: z.number().int(),
+  sourceProjectName: z.string().optional(),
+  sourceCollectionName: z.string().optional(),
+  sourceCollectionVersionId: z.string().optional(),
+  collectionStatus: Status$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CollectionResponse$ {
+  /** @deprecated use `CollectionResponse$inboundSchema` instead. */
+  export const inboundSchema = CollectionResponse$inboundSchema;
+  /** @deprecated use `CollectionResponse$outboundSchema` instead. */
+  export const outboundSchema = CollectionResponse$outboundSchema;
+  /** @deprecated use `CollectionResponse$Outbound` instead. */
+  export type Outbound = CollectionResponse$Outbound;
+}
+
+export function collectionResponseToJSON(
+  collectionResponse: CollectionResponse,
+): string {
+  return JSON.stringify(
+    CollectionResponse$outboundSchema.parse(collectionResponse),
+  );
+}
+
+export function collectionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CollectionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CollectionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CollectionResponse' from JSON`,
+  );
+}

package/src/models/errors/badrequesterror.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { LambdaDBError } from "./lambdadberror.js";
+
+export type BadRequestErrorData = {
+  message?: string | undefined;
+};
+
+export class BadRequestError extends LambdaDBError {
+  /** The original data that was passed to this error instance. */
+  data$: BadRequestErrorData;
+
+  constructor(
+    err: BadRequestErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "BadRequestError";
+  }
+}
+
+/** @internal */
+export const BadRequestError$inboundSchema: z.ZodType<
+  BadRequestError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new BadRequestError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type BadRequestError$Outbound = {
+  message?: string | undefined;
+};
+
+/** @internal */
+export const BadRequestError$outboundSchema: z.ZodType<
+  BadRequestError$Outbound,
+  z.ZodTypeDef,
+  BadRequestError
+> = z.instanceof(BadRequestError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string().optional(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BadRequestError$ {
+  /** @deprecated use `BadRequestError$inboundSchema` instead. */
+  export const inboundSchema = BadRequestError$inboundSchema;
+  /** @deprecated use `BadRequestError$outboundSchema` instead. */
+  export const outboundSchema = BadRequestError$outboundSchema;
+  /** @deprecated use `BadRequestError$Outbound` instead. */
+  export type Outbound = BadRequestError$Outbound;
+}

package/src/models/errors/httpclienterrors.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Base class for all HTTP errors.
+ */
+export class HTTPClientError extends Error {
+  /** The underlying cause of the error. */
+  override readonly cause: unknown;
+  override name = "HTTPClientError";
+  constructor(message: string, opts?: { cause?: unknown }) {
+    let msg = message;
+    if (opts?.cause) {
+      msg += `: ${opts.cause}`;
+    }
+
+    super(msg, opts);
+    // In older runtimes, the cause field would not have been assigned through
+    // the super() call.
+    if (typeof this.cause === "undefined") {
+      this.cause = opts?.cause;
+    }
+  }
+}
+
+/**
+ * An error to capture unrecognised or unexpected errors when making HTTP calls.
+ */
+export class UnexpectedClientError extends HTTPClientError {
+  override name = "UnexpectedClientError";
+}
+
+/**
+ * An error that is raised when any inputs used to create a request are invalid.
+ */
+export class InvalidRequestError extends HTTPClientError {
+  override name = "InvalidRequestError";
+}
+
+/**
+ * An error that is raised when a HTTP request was aborted by the client error.
+ */
+export class RequestAbortedError extends HTTPClientError {
+  override readonly name = "RequestAbortedError";
+}
+
+/**
+ * An error that is raised when a HTTP request timed out due to an AbortSignal
+ * signal timeout.
+ */
+export class RequestTimeoutError extends HTTPClientError {
+  override readonly name = "RequestTimeoutError";
+}
+
+/**
+ * An error that is raised when a HTTP client is unable to make a request to
+ * a server.
+ */
+export class ConnectionError extends HTTPClientError {
+  override readonly name = "ConnectionError";
+}

package/src/models/errors/index.ts

@@ -0,0 +1,14 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./badrequesterror.js";
+export * from "./httpclienterrors.js";
+export * from "./internalservererror.js";
+export * from "./lambdadbdefaulterror.js";
+export * from "./resourcealreadyexistserror.js";
+export * from "./resourcenotfounderror.js";
+export * from "./responsevalidationerror.js";
+export * from "./sdkvalidationerror.js";
+export * from "./toomanyrequestserror.js";
+export * from "./unauthenticatederror.js";

package/src/models/errors/internalservererror.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { LambdaDBError } from "./lambdadberror.js";
+
+export type InternalServerErrorData = {
+  message?: string | undefined;
+};
+
+export class InternalServerError extends LambdaDBError {
+  /** The original data that was passed to this error instance. */
+  data$: InternalServerErrorData;
+
+  constructor(
+    err: InternalServerErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "InternalServerError";
+  }
+}
+
+/** @internal */
+export const InternalServerError$inboundSchema: z.ZodType<
+  InternalServerError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new InternalServerError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type InternalServerError$Outbound = {
+  message?: string | undefined;
+};
+
+/** @internal */
+export const InternalServerError$outboundSchema: z.ZodType<
+  InternalServerError$Outbound,
+  z.ZodTypeDef,
+  InternalServerError
+> = z.instanceof(InternalServerError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string().optional(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InternalServerError$ {
+  /** @deprecated use `InternalServerError$inboundSchema` instead. */
+  export const inboundSchema = InternalServerError$inboundSchema;
+  /** @deprecated use `InternalServerError$outboundSchema` instead. */
+  export const outboundSchema = InternalServerError$outboundSchema;
+  /** @deprecated use `InternalServerError$Outbound` instead. */
+  export type Outbound = InternalServerError$Outbound;
+}

package/src/models/errors/lambdadbdefaulterror.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { LambdaDBError } from "./lambdadberror.js";
+
+/** The fallback error class if no more specific error class is matched */
+export class LambdaDBDefaultError extends LambdaDBError {
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : ". ";
+    let bodyDisplay = body;
+    if (body.length > 10000) {
+      const truncated = body.substring(0, 10000);
+      const remaining = body.length - 10000;
+      bodyDisplay = `${truncated}...and ${remaining} more chars`;
+    }
+    message += `Body: ${bodyDisplay}`;
+    message = message.trim();
+    super(message, httpMeta);
+    this.name = "LambdaDBDefaultError";
+  }
+}