@greensecurity/javascript-sdk 0.9.1

package/src/lib/security.ts

@@ -0,0 +1,260 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as components from "../models/components/index.js";
+import { env } from "./env.js";
+type OAuth2PasswordFlow = {
+  username: string;
+  password?: string | undefined;
+  clientID: string;
+  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
+    | undefined;
+};
+
+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") {
+        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}`;
+  }
+
+  state.headers[spec.fieldName] = value;
+}
+
+export function resolveGlobalSecurity(
+  security: Partial<components.Security> | null | undefined,
+): SecurityState | null {
+  return resolveSecurity(
+    [
+      {
+        fieldName: "token",
+        type: "apiKey:query",
+        value: security?.token ?? env().GREEN_SECURITY_TOKEN,
+      },
+    ],
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.bearerJwt ?? env().GREEN_SECURITY_BEARER_JWT,
+      },
+    ],
+  );
+}
+
+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/components/contact.ts

@@ -0,0 +1,268 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  DepartmentSummary,
+  DepartmentSummary$inboundSchema,
+  DepartmentSummary$Outbound,
+  DepartmentSummary$outboundSchema,
+} from "./departmentsummary.js";
+import {
+  FacilitySummary,
+  FacilitySummary$inboundSchema,
+  FacilitySummary$Outbound,
+  FacilitySummary$outboundSchema,
+} from "./facilitysummary.js";
+import {
+  SystemSummary,
+  SystemSummary$inboundSchema,
+  SystemSummary$Outbound,
+  SystemSummary$outboundSchema,
+} from "./systemsummary.js";
+
+export type ContactFacility = FacilitySummary | number;
+
+export type System = SystemSummary | number;
+
+export const ContactStatus = {
+  Active: "Active",
+  Inactive: "Inactive",
+  Deleted: "Deleted",
+} as const;
+export type ContactStatus = ClosedEnum<typeof ContactStatus>;
+
+export type Department = DepartmentSummary | number;
+
+/**
+ * This object represents a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
+ */
+export type Contact = {
+  facility?: FacilitySummary | number | undefined;
+  system?: SystemSummary | number | undefined;
+  status: ContactStatus;
+  position?: string | null | undefined;
+  department?: DepartmentSummary | number | null | undefined;
+};
+
+/** @internal */
+export const ContactFacility$inboundSchema: z.ZodType<
+  ContactFacility,
+  z.ZodTypeDef,
+  unknown
+> = z.union([FacilitySummary$inboundSchema, z.number().int()]);
+
+/** @internal */
+export type ContactFacility$Outbound = FacilitySummary$Outbound | number;
+
+/** @internal */
+export const ContactFacility$outboundSchema: z.ZodType<
+  ContactFacility$Outbound,
+  z.ZodTypeDef,
+  ContactFacility
+> = z.union([FacilitySummary$outboundSchema, z.number().int()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ContactFacility$ {
+  /** @deprecated use `ContactFacility$inboundSchema` instead. */
+  export const inboundSchema = ContactFacility$inboundSchema;
+  /** @deprecated use `ContactFacility$outboundSchema` instead. */
+  export const outboundSchema = ContactFacility$outboundSchema;
+  /** @deprecated use `ContactFacility$Outbound` instead. */
+  export type Outbound = ContactFacility$Outbound;
+}
+
+export function contactFacilityToJSON(
+  contactFacility: ContactFacility,
+): string {
+  return JSON.stringify(ContactFacility$outboundSchema.parse(contactFacility));
+}
+
+export function contactFacilityFromJSON(
+  jsonString: string,
+): SafeParseResult<ContactFacility, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ContactFacility$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ContactFacility' from JSON`,
+  );
+}
+
+/** @internal */
+export const System$inboundSchema: z.ZodType<System, z.ZodTypeDef, unknown> = z
+  .union([SystemSummary$inboundSchema, z.number().int()]);
+
+/** @internal */
+export type System$Outbound = SystemSummary$Outbound | number;
+
+/** @internal */
+export const System$outboundSchema: z.ZodType<
+  System$Outbound,
+  z.ZodTypeDef,
+  System
+> = z.union([SystemSummary$outboundSchema, z.number().int()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace System$ {
+  /** @deprecated use `System$inboundSchema` instead. */
+  export const inboundSchema = System$inboundSchema;
+  /** @deprecated use `System$outboundSchema` instead. */
+  export const outboundSchema = System$outboundSchema;
+  /** @deprecated use `System$Outbound` instead. */
+  export type Outbound = System$Outbound;
+}
+
+export function systemToJSON(system: System): string {
+  return JSON.stringify(System$outboundSchema.parse(system));
+}
+
+export function systemFromJSON(
+  jsonString: string,
+): SafeParseResult<System, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => System$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'System' from JSON`,
+  );
+}
+
+/** @internal */
+export const ContactStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ContactStatus
+> = z.nativeEnum(ContactStatus);
+
+/** @internal */
+export const ContactStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ContactStatus
+> = ContactStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ContactStatus$ {
+  /** @deprecated use `ContactStatus$inboundSchema` instead. */
+  export const inboundSchema = ContactStatus$inboundSchema;
+  /** @deprecated use `ContactStatus$outboundSchema` instead. */
+  export const outboundSchema = ContactStatus$outboundSchema;
+}
+
+/** @internal */
+export const Department$inboundSchema: z.ZodType<
+  Department,
+  z.ZodTypeDef,
+  unknown
+> = z.union([DepartmentSummary$inboundSchema, z.number().int()]);
+
+/** @internal */
+export type Department$Outbound = DepartmentSummary$Outbound | number;
+
+/** @internal */
+export const Department$outboundSchema: z.ZodType<
+  Department$Outbound,
+  z.ZodTypeDef,
+  Department
+> = z.union([DepartmentSummary$outboundSchema, z.number().int()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Department$ {
+  /** @deprecated use `Department$inboundSchema` instead. */
+  export const inboundSchema = Department$inboundSchema;
+  /** @deprecated use `Department$outboundSchema` instead. */
+  export const outboundSchema = Department$outboundSchema;
+  /** @deprecated use `Department$Outbound` instead. */
+  export type Outbound = Department$Outbound;
+}
+
+export function departmentToJSON(department: Department): string {
+  return JSON.stringify(Department$outboundSchema.parse(department));
+}
+
+export function departmentFromJSON(
+  jsonString: string,
+): SafeParseResult<Department, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Department$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Department' from JSON`,
+  );
+}
+
+/** @internal */
+export const Contact$inboundSchema: z.ZodType<Contact, z.ZodTypeDef, unknown> =
+  z.object({
+    facility: z.union([FacilitySummary$inboundSchema, z.number().int()])
+      .optional(),
+    system: z.union([SystemSummary$inboundSchema, z.number().int()]).optional(),
+    status: ContactStatus$inboundSchema,
+    position: z.nullable(z.string()).optional(),
+    department: z.nullable(
+      z.union([DepartmentSummary$inboundSchema, z.number().int()]),
+    ).optional(),
+  });
+
+/** @internal */
+export type Contact$Outbound = {
+  facility?: FacilitySummary$Outbound | number | undefined;
+  system?: SystemSummary$Outbound | number | undefined;
+  status: string;
+  position?: string | null | undefined;
+  department?: DepartmentSummary$Outbound | number | null | undefined;
+};
+
+/** @internal */
+export const Contact$outboundSchema: z.ZodType<
+  Contact$Outbound,
+  z.ZodTypeDef,
+  Contact
+> = z.object({
+  facility: z.union([FacilitySummary$outboundSchema, z.number().int()])
+    .optional(),
+  system: z.union([SystemSummary$outboundSchema, z.number().int()]).optional(),
+  status: ContactStatus$outboundSchema,
+  position: z.nullable(z.string()).optional(),
+  department: z.nullable(
+    z.union([DepartmentSummary$outboundSchema, z.number().int()]),
+  ).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Contact$ {
+  /** @deprecated use `Contact$inboundSchema` instead. */
+  export const inboundSchema = Contact$inboundSchema;
+  /** @deprecated use `Contact$outboundSchema` instead. */
+  export const outboundSchema = Contact$outboundSchema;
+  /** @deprecated use `Contact$Outbound` instead. */
+  export type Outbound = Contact$Outbound;
+}
+
+export function contactToJSON(contact: Contact): string {
+  return JSON.stringify(Contact$outboundSchema.parse(contact));
+}
+
+export function contactFromJSON(
+  jsonString: string,
+): SafeParseResult<Contact, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Contact$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Contact' from JSON`,
+  );
+}

package/src/models/components/departmentsummary.ts

@@ -0,0 +1,73 @@
+/*
+ * 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";
+
+/**
+ * A simplified representation of a Department, typically used in list views.
+ */
+export type DepartmentSummary = {
+  id: number;
+  name: string;
+};
+
+/** @internal */
+export const DepartmentSummary$inboundSchema: z.ZodType<
+  DepartmentSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  name: z.string(),
+});
+
+/** @internal */
+export type DepartmentSummary$Outbound = {
+  id: number;
+  name: string;
+};
+
+/** @internal */
+export const DepartmentSummary$outboundSchema: z.ZodType<
+  DepartmentSummary$Outbound,
+  z.ZodTypeDef,
+  DepartmentSummary
+> = z.object({
+  id: z.number().int(),
+  name: 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 DepartmentSummary$ {
+  /** @deprecated use `DepartmentSummary$inboundSchema` instead. */
+  export const inboundSchema = DepartmentSummary$inboundSchema;
+  /** @deprecated use `DepartmentSummary$outboundSchema` instead. */
+  export const outboundSchema = DepartmentSummary$outboundSchema;
+  /** @deprecated use `DepartmentSummary$Outbound` instead. */
+  export type Outbound = DepartmentSummary$Outbound;
+}
+
+export function departmentSummaryToJSON(
+  departmentSummary: DepartmentSummary,
+): string {
+  return JSON.stringify(
+    DepartmentSummary$outboundSchema.parse(departmentSummary),
+  );
+}
+
+export function departmentSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<DepartmentSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DepartmentSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DepartmentSummary' from JSON`,
+  );
+}

package/src/models/components/desc.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 Desc = boolean | number;
+
+/** @internal */
+export const Desc$inboundSchema: z.ZodType<Desc, z.ZodTypeDef, unknown> = z
+  .union([z.boolean(), z.number().int()]);
+
+/** @internal */
+export type Desc$Outbound = boolean | number;
+
+/** @internal */
+export const Desc$outboundSchema: z.ZodType<Desc$Outbound, z.ZodTypeDef, Desc> =
+  z.union([z.boolean(), z.number().int()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Desc$ {
+  /** @deprecated use `Desc$inboundSchema` instead. */
+  export const inboundSchema = Desc$inboundSchema;
+  /** @deprecated use `Desc$outboundSchema` instead. */
+  export const outboundSchema = Desc$outboundSchema;
+  /** @deprecated use `Desc$Outbound` instead. */
+  export type Outbound = Desc$Outbound;
+}
+
+export function descToJSON(desc: Desc): string {
+  return JSON.stringify(Desc$outboundSchema.parse(desc));
+}
+
+export function descFromJSON(
+  jsonString: string,
+): SafeParseResult<Desc, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Desc$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Desc' from JSON`,
+  );
+}