@greensecurity/javascript-sdk 0.9.1 → 0.11.0

package/src/models/operations/password.ts

@@ -0,0 +1,140 @@
+/*
+ * 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";
+
+export type PasswordRequestBody = {
+  paswordResetToken: string;
+  password: string;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type PasswordResponseBody = {
+  success?: boolean | null | undefined;
+};
+
+/** @internal */
+export const PasswordRequestBody$inboundSchema: z.ZodType<
+  PasswordRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pasword_reset_token: z.string(),
+  password: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "pasword_reset_token": "paswordResetToken",
+  });
+});
+
+/** @internal */
+export type PasswordRequestBody$Outbound = {
+  pasword_reset_token: string;
+  password: string;
+};
+
+/** @internal */
+export const PasswordRequestBody$outboundSchema: z.ZodType<
+  PasswordRequestBody$Outbound,
+  z.ZodTypeDef,
+  PasswordRequestBody
+> = z.object({
+  paswordResetToken: z.string(),
+  password: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    paswordResetToken: "pasword_reset_token",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PasswordRequestBody$ {
+  /** @deprecated use `PasswordRequestBody$inboundSchema` instead. */
+  export const inboundSchema = PasswordRequestBody$inboundSchema;
+  /** @deprecated use `PasswordRequestBody$outboundSchema` instead. */
+  export const outboundSchema = PasswordRequestBody$outboundSchema;
+  /** @deprecated use `PasswordRequestBody$Outbound` instead. */
+  export type Outbound = PasswordRequestBody$Outbound;
+}
+
+export function passwordRequestBodyToJSON(
+  passwordRequestBody: PasswordRequestBody,
+): string {
+  return JSON.stringify(
+    PasswordRequestBody$outboundSchema.parse(passwordRequestBody),
+  );
+}
+
+export function passwordRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PasswordRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PasswordRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PasswordRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const PasswordResponseBody$inboundSchema: z.ZodType<
+  PasswordResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.nullable(z.boolean()).optional(),
+});
+
+/** @internal */
+export type PasswordResponseBody$Outbound = {
+  success?: boolean | null | undefined;
+};
+
+/** @internal */
+export const PasswordResponseBody$outboundSchema: z.ZodType<
+  PasswordResponseBody$Outbound,
+  z.ZodTypeDef,
+  PasswordResponseBody
+> = z.object({
+  success: z.nullable(z.boolean()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PasswordResponseBody$ {
+  /** @deprecated use `PasswordResponseBody$inboundSchema` instead. */
+  export const inboundSchema = PasswordResponseBody$inboundSchema;
+  /** @deprecated use `PasswordResponseBody$outboundSchema` instead. */
+  export const outboundSchema = PasswordResponseBody$outboundSchema;
+  /** @deprecated use `PasswordResponseBody$Outbound` instead. */
+  export type Outbound = PasswordResponseBody$Outbound;
+}
+
+export function passwordResponseBodyToJSON(
+  passwordResponseBody: PasswordResponseBody,
+): string {
+  return JSON.stringify(
+    PasswordResponseBody$outboundSchema.parse(passwordResponseBody),
+  );
+}
+
+export function passwordResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PasswordResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PasswordResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PasswordResponseBody' from JSON`,
+  );
+}

package/src/models/operations/passwordresetrequest.ts

@@ -0,0 +1,131 @@
+/*
+ * 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 PasswordResetRequestRequestBody = {
+  email: string;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type PasswordResetRequestResponseBody = {
+  success: boolean;
+};
+
+/** @internal */
+export const PasswordResetRequestRequestBody$inboundSchema: z.ZodType<
+  PasswordResetRequestRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.string(),
+});
+
+/** @internal */
+export type PasswordResetRequestRequestBody$Outbound = {
+  email: string;
+};
+
+/** @internal */
+export const PasswordResetRequestRequestBody$outboundSchema: z.ZodType<
+  PasswordResetRequestRequestBody$Outbound,
+  z.ZodTypeDef,
+  PasswordResetRequestRequestBody
+> = z.object({
+  email: 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 PasswordResetRequestRequestBody$ {
+  /** @deprecated use `PasswordResetRequestRequestBody$inboundSchema` instead. */
+  export const inboundSchema = PasswordResetRequestRequestBody$inboundSchema;
+  /** @deprecated use `PasswordResetRequestRequestBody$outboundSchema` instead. */
+  export const outboundSchema = PasswordResetRequestRequestBody$outboundSchema;
+  /** @deprecated use `PasswordResetRequestRequestBody$Outbound` instead. */
+  export type Outbound = PasswordResetRequestRequestBody$Outbound;
+}
+
+export function passwordResetRequestRequestBodyToJSON(
+  passwordResetRequestRequestBody: PasswordResetRequestRequestBody,
+): string {
+  return JSON.stringify(
+    PasswordResetRequestRequestBody$outboundSchema.parse(
+      passwordResetRequestRequestBody,
+    ),
+  );
+}
+
+export function passwordResetRequestRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PasswordResetRequestRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PasswordResetRequestRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PasswordResetRequestRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const PasswordResetRequestResponseBody$inboundSchema: z.ZodType<
+  PasswordResetRequestResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean(),
+});
+
+/** @internal */
+export type PasswordResetRequestResponseBody$Outbound = {
+  success: boolean;
+};
+
+/** @internal */
+export const PasswordResetRequestResponseBody$outboundSchema: z.ZodType<
+  PasswordResetRequestResponseBody$Outbound,
+  z.ZodTypeDef,
+  PasswordResetRequestResponseBody
+> = z.object({
+  success: z.boolean(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PasswordResetRequestResponseBody$ {
+  /** @deprecated use `PasswordResetRequestResponseBody$inboundSchema` instead. */
+  export const inboundSchema = PasswordResetRequestResponseBody$inboundSchema;
+  /** @deprecated use `PasswordResetRequestResponseBody$outboundSchema` instead. */
+  export const outboundSchema = PasswordResetRequestResponseBody$outboundSchema;
+  /** @deprecated use `PasswordResetRequestResponseBody$Outbound` instead. */
+  export type Outbound = PasswordResetRequestResponseBody$Outbound;
+}
+
+export function passwordResetRequestResponseBodyToJSON(
+  passwordResetRequestResponseBody: PasswordResetRequestResponseBody,
+): string {
+  return JSON.stringify(
+    PasswordResetRequestResponseBody$outboundSchema.parse(
+      passwordResetRequestResponseBody,
+    ),
+  );
+}
+
+export function passwordResetRequestResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PasswordResetRequestResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PasswordResetRequestResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PasswordResetRequestResponseBody' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -10,5 +10,8 @@ export * from "./organizationsListOrSearchFacilities.js";
 export * from "./userGetCurrentUser.js";
 export * from "./userGetUserById.js";
 export * from "./userLogsUserIntoTheSystem.js";
+export * from "./userMagiclink.js";
+export * from "./userPassword.js";
+export * from "./userPasswordResetRequest.js";
 export * from "./vendorsCreateVendorRegistration.js";
 export * from "./vendorsListVendorJobTitles.js";

package/src/react-query/userMagiclink.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { userMagiclink } from "../funcs/userMagiclink.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type UserMagiclinkMutationVariables = {
+  request: operations.MagiclinkRequestBody;
+  options?: RequestOptions;
+};
+
+export type UserMagiclinkMutationData = operations.MagiclinkResponseBody;
+
+/**
+ * Magic link
+ *
+ * @remarks
+ * It sends an email with a magic link to allow the user to log in.
+ */
+export function useUserMagiclinkMutation(
+  options?: MutationHookOptions<
+    UserMagiclinkMutationData,
+    Error,
+    UserMagiclinkMutationVariables
+  >,
+): UseMutationResult<
+  UserMagiclinkMutationData,
+  Error,
+  UserMagiclinkMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildUserMagiclinkMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyUserMagiclink(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "user", "magiclink"];
+}
+
+export function buildUserMagiclinkMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: UserMagiclinkMutationVariables,
+  ) => Promise<UserMagiclinkMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyUserMagiclink(),
+    mutationFn: function userMagiclinkMutationFn({
+      request,
+      options,
+    }): Promise<UserMagiclinkMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(userMagiclink(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/userPassword.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { userPassword } from "../funcs/userPassword.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type UserPasswordMutationVariables = {
+  request: operations.PasswordRequestBody;
+  options?: RequestOptions;
+};
+
+export type UserPasswordMutationData = operations.PasswordResponseBody;
+
+/**
+ * Password reset
+ *
+ * @remarks
+ * Resets the a user's password using a password_reset_id that was sent to them via email.
+ * See /users/passwordresetrequest to initiate a password reset flow.
+ */
+export function useUserPasswordMutation(
+  options?: MutationHookOptions<
+    UserPasswordMutationData,
+    Error,
+    UserPasswordMutationVariables
+  >,
+): UseMutationResult<
+  UserPasswordMutationData,
+  Error,
+  UserPasswordMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildUserPasswordMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyUserPassword(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "user", "password"];
+}
+
+export function buildUserPasswordMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: UserPasswordMutationVariables,
+  ) => Promise<UserPasswordMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyUserPassword(),
+    mutationFn: function userPasswordMutationFn({
+      request,
+      options,
+    }): Promise<UserPasswordMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(userPassword(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/userPasswordResetRequest.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { userPasswordResetRequest } from "../funcs/userPasswordResetRequest.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type UserPasswordResetRequestMutationVariables = {
+  request: operations.PasswordResetRequestRequestBody;
+  options?: RequestOptions;
+};
+
+export type UserPasswordResetRequestMutationData =
+  operations.PasswordResetRequestResponseBody;
+
+/**
+ * Password reset request
+ *
+ * @remarks
+ * It sends an email with a link for resetting a user's password.
+ */
+export function useUserPasswordResetRequestMutation(
+  options?: MutationHookOptions<
+    UserPasswordResetRequestMutationData,
+    Error,
+    UserPasswordResetRequestMutationVariables
+  >,
+): UseMutationResult<
+  UserPasswordResetRequestMutationData,
+  Error,
+  UserPasswordResetRequestMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildUserPasswordResetRequestMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyUserPasswordResetRequest(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "user", "passwordResetRequest"];
+}
+
+export function buildUserPasswordResetRequestMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: UserPasswordResetRequestMutationVariables,
+  ) => Promise<UserPasswordResetRequestMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyUserPasswordResetRequest(),
+    mutationFn: function userPasswordResetRequestMutationFn({
+      request,
+      options,
+    }): Promise<UserPasswordResetRequestMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(userPasswordResetRequest(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/sdk/user.ts

@@ -5,6 +5,9 @@
 import { userGetCurrentUser } from "../funcs/userGetCurrentUser.js";
 import { userGetUserById } from "../funcs/userGetUserById.js";
 import { userLogsUserIntoTheSystem } from "../funcs/userLogsUserIntoTheSystem.js";
+import { userMagiclink } from "../funcs/userMagiclink.js";
+import { userPassword } from "../funcs/userPassword.js";
+import { userPasswordResetRequest } from "../funcs/userPasswordResetRequest.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -89,4 +92,56 @@ export class User extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Magic link
+   *
+   * @remarks
+   * It sends an email with a magic link to allow the user to log in.
+   */
+  async magiclink(
+    request: operations.MagiclinkRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.MagiclinkResponseBody> {
+    return unwrapAsync(userMagiclink(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Password reset request
+   *
+   * @remarks
+   * It sends an email with a link for resetting a user's password.
+   */
+  async passwordResetRequest(
+    request: operations.PasswordResetRequestRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PasswordResetRequestResponseBody> {
+    return unwrapAsync(userPasswordResetRequest(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Password reset
+   *
+   * @remarks
+   * Resets the a user's password using a password_reset_id that was sent to them via email.
+   * See /users/passwordresetrequest to initiate a password reset flow.
+   */
+  async password(
+    request: operations.PasswordRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PasswordResponseBody> {
+    return unwrapAsync(userPassword(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/types/async.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type APICall =
+  | {
+      status: "complete";
+      request: Request;
+      response: Response;
+    }
+  | {
+      status: "request-error";
+      request: Request;
+      response?: undefined;
+    }
+  | {
+      status: "invalid";
+      request?: undefined;
+      response?: undefined;
+    };
+
+export class APIPromise<T> implements Promise<T> {
+  readonly #promise: Promise<[T, APICall]>;
+  readonly #unwrapped: Promise<T>;
+
+  readonly [Symbol.toStringTag] = "APIPromise";
+
+  constructor(p: [T, APICall] | Promise<[T, APICall]>) {
+    this.#promise = p instanceof Promise ? p : Promise.resolve(p);
+    this.#unwrapped =
+      p instanceof Promise
+        ? this.#promise.then(([value]) => value)
+        : Promise.resolve(p[0]);
+  }
+
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?:
+      | ((value: T) => TResult1 | PromiseLike<TResult1>)
+      | null
+      | undefined,
+    onrejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | null
+      | undefined,
+  ): Promise<TResult1 | TResult2> {
+    return this.#promise.then(
+      onfulfilled ? ([value]) => onfulfilled(value) : void 0,
+      onrejected,
+    );
+  }
+
+  catch<TResult = never>(
+    onrejected?:
+      | ((reason: any) => TResult | PromiseLike<TResult>)
+      | null
+      | undefined,
+  ): Promise<T | TResult> {
+    return this.#unwrapped.catch(onrejected);
+  }
+
+  finally(onfinally?: (() => void) | null | undefined): Promise<T> {
+    return this.#unwrapped.finally(onfinally);
+  }
+
+  $inspect(): Promise<[T, APICall]> {
+    return this.#promise;
+  }
+}

package/types/async.d.ts

@@ -0,0 +1,23 @@
+export type APICall = {
+    status: "complete";
+    request: Request;
+    response: Response;
+} | {
+    status: "request-error";
+    request: Request;
+    response?: undefined;
+} | {
+    status: "invalid";
+    request?: undefined;
+    response?: undefined;
+};
+export declare class APIPromise<T> implements Promise<T> {
+    #private;
+    readonly [Symbol.toStringTag] = "APIPromise";
+    constructor(p: [T, APICall] | Promise<[T, APICall]>);
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null | undefined): Promise<T | TResult>;
+    finally(onfinally?: (() => void) | null | undefined): Promise<T>;
+    $inspect(): Promise<[T, APICall]>;
+}
+//# sourceMappingURL=async.d.ts.map