owasp-nest 0.0.3

package/src/lib/security.ts

@@ -0,0 +1,264 @@
+/*
+ * 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?.apiKeyAuth ?? env().NEST_API_KEY_AUTH,
+      },
+    ],
+  );
+}
+
+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/chapterschema.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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/sdkvalidationerror.js";
+
+/**
+ * Schema for Chapter.
+ */
+export type ChapterSchema = {
+  country: string;
+  createdAt: Date;
+  name: string;
+  region: string;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const ChapterSchema$inboundSchema: z.ZodType<
+  ChapterSchema,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  country: z.string(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  name: z.string(),
+  region: z.string(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+/** @internal */
+export type ChapterSchema$Outbound = {
+  country: string;
+  created_at: string;
+  name: string;
+  region: string;
+  updated_at: string;
+};
+
+/** @internal */
+export const ChapterSchema$outboundSchema: z.ZodType<
+  ChapterSchema$Outbound,
+  z.ZodTypeDef,
+  ChapterSchema
+> = z.object({
+  country: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  name: z.string(),
+  region: z.string(),
+  updatedAt: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    updatedAt: "updated_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChapterSchema$ {
+  /** @deprecated use `ChapterSchema$inboundSchema` instead. */
+  export const inboundSchema = ChapterSchema$inboundSchema;
+  /** @deprecated use `ChapterSchema$outboundSchema` instead. */
+  export const outboundSchema = ChapterSchema$outboundSchema;
+  /** @deprecated use `ChapterSchema$Outbound` instead. */
+  export type Outbound = ChapterSchema$Outbound;
+}
+
+export function chapterSchemaToJSON(chapterSchema: ChapterSchema): string {
+  return JSON.stringify(ChapterSchema$outboundSchema.parse(chapterSchema));
+}
+
+export function chapterSchemaFromJSON(
+  jsonString: string,
+): SafeParseResult<ChapterSchema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChapterSchema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChapterSchema' from JSON`,
+  );
+}

package/src/models/committeeschema.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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/sdkvalidationerror.js";
+
+/**
+ * Schema for Committee.
+ */
+export type CommitteeSchema = {
+  name: string;
+  description: string;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const CommitteeSchema$inboundSchema: z.ZodType<
+  CommitteeSchema,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+/** @internal */
+export type CommitteeSchema$Outbound = {
+  name: string;
+  description: string;
+  created_at: string;
+  updated_at: string;
+};
+
+/** @internal */
+export const CommitteeSchema$outboundSchema: z.ZodType<
+  CommitteeSchema$Outbound,
+  z.ZodTypeDef,
+  CommitteeSchema
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  updatedAt: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    updatedAt: "updated_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommitteeSchema$ {
+  /** @deprecated use `CommitteeSchema$inboundSchema` instead. */
+  export const inboundSchema = CommitteeSchema$inboundSchema;
+  /** @deprecated use `CommitteeSchema$outboundSchema` instead. */
+  export const outboundSchema = CommitteeSchema$outboundSchema;
+  /** @deprecated use `CommitteeSchema$Outbound` instead. */
+  export type Outbound = CommitteeSchema$Outbound;
+}
+
+export function committeeSchemaToJSON(
+  committeeSchema: CommitteeSchema,
+): string {
+  return JSON.stringify(CommitteeSchema$outboundSchema.parse(committeeSchema));
+}
+
+export function committeeSchemaFromJSON(
+  jsonString: string,
+): SafeParseResult<CommitteeSchema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommitteeSchema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommitteeSchema' from JSON`,
+  );
+}

package/src/models/errors/chaptererrorresponse.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { NestError } from "./nesterror.js";
+
+/**
+ * Chapter error response schema.
+ */
+export type ChapterErrorResponseData = {
+  message: string;
+};
+
+/**
+ * Chapter error response schema.
+ */
+export class ChapterErrorResponse extends NestError {
+  /** The original data that was passed to this error instance. */
+  data$: ChapterErrorResponseData;
+
+  constructor(
+    err: ChapterErrorResponseData,
+    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 = "ChapterErrorResponse";
+  }
+}
+
+/** @internal */
+export const ChapterErrorResponse$inboundSchema: z.ZodType<
+  ChapterErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ChapterErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type ChapterErrorResponse$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const ChapterErrorResponse$outboundSchema: z.ZodType<
+  ChapterErrorResponse$Outbound,
+  z.ZodTypeDef,
+  ChapterErrorResponse
+> = z.instanceof(ChapterErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChapterErrorResponse$ {
+  /** @deprecated use `ChapterErrorResponse$inboundSchema` instead. */
+  export const inboundSchema = ChapterErrorResponse$inboundSchema;
+  /** @deprecated use `ChapterErrorResponse$outboundSchema` instead. */
+  export const outboundSchema = ChapterErrorResponse$outboundSchema;
+  /** @deprecated use `ChapterErrorResponse$Outbound` instead. */
+  export type Outbound = ChapterErrorResponse$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,10 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./chaptererrorresponse.js";
+export * from "./httpclienterrors.js";
+export * from "./membererrorresponse.js";
+export * from "./nestapierror.js";
+export * from "./responsevalidationerror.js";
+export * from "./sdkvalidationerror.js";

package/src/models/errors/membererrorresponse.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { NestError } from "./nesterror.js";
+
+/**
+ * Member error response schema.
+ */
+export type MemberErrorResponseData = {
+  message: string;
+};
+
+/**
+ * Member error response schema.
+ */
+export class MemberErrorResponse extends NestError {
+  /** The original data that was passed to this error instance. */
+  data$: MemberErrorResponseData;
+
+  constructor(
+    err: MemberErrorResponseData,
+    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 = "MemberErrorResponse";
+  }
+}
+
+/** @internal */
+export const MemberErrorResponse$inboundSchema: z.ZodType<
+  MemberErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new MemberErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type MemberErrorResponse$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const MemberErrorResponse$outboundSchema: z.ZodType<
+  MemberErrorResponse$Outbound,
+  z.ZodTypeDef,
+  MemberErrorResponse
+> = z.instanceof(MemberErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MemberErrorResponse$ {
+  /** @deprecated use `MemberErrorResponse$inboundSchema` instead. */
+  export const inboundSchema = MemberErrorResponse$inboundSchema;
+  /** @deprecated use `MemberErrorResponse$outboundSchema` instead. */
+  export const outboundSchema = MemberErrorResponse$outboundSchema;
+  /** @deprecated use `MemberErrorResponse$Outbound` instead. */
+  export type Outbound = MemberErrorResponse$Outbound;
+}