@greensecurity/javascript-sdk 0.9.1 → 0.10.2

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

package/types/async.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"async.d.ts","sourceRoot":"","sources":["../src/types/async.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GACf;IACE,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;CACpB,GACD;IACE,MAAM,EAAE,eAAe,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,GACD;IACE,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,CAAC;AAEN,qBAAa,UAAU,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;;IAI9C,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB;gBAEjC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAQnD,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EACjC,WAAW,CAAC,EACR,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAChD,IAAI,GACJ,SAAS,EACb,UAAU,CAAC,EACP,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACnD,IAAI,GACJ,SAAS,GACZ,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAO/B,KAAK,CAAC,OAAO,GAAG,KAAK,EACnB,UAAU,CAAC,EACP,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,GACjD,IAAI,GACJ,SAAS,GACZ,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC;IAIvB,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC;IAIhE,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;CAGlC"}

package/types/async.js

@@ -0,0 +1,44 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _APIPromise_promise, _APIPromise_unwrapped, _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIPromise = void 0;
+class APIPromise {
+    constructor(p) {
+        _APIPromise_promise.set(this, void 0);
+        _APIPromise_unwrapped.set(this, void 0);
+        this[_a] = "APIPromise";
+        __classPrivateFieldSet(this, _APIPromise_promise, p instanceof Promise ? p : Promise.resolve(p), "f");
+        __classPrivateFieldSet(this, _APIPromise_unwrapped, p instanceof Promise
+            ? __classPrivateFieldGet(this, _APIPromise_promise, "f").then(([value]) => value)
+            : Promise.resolve(p[0]), "f");
+    }
+    then(onfulfilled, onrejected) {
+        return __classPrivateFieldGet(this, _APIPromise_promise, "f").then(onfulfilled ? ([value]) => onfulfilled(value) : void 0, onrejected);
+    }
+    catch(onrejected) {
+        return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").catch(onrejected);
+    }
+    finally(onfinally) {
+        return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").finally(onfinally);
+    }
+    $inspect() {
+        return __classPrivateFieldGet(this, _APIPromise_promise, "f");
+    }
+}
+exports.APIPromise = APIPromise;
+_APIPromise_promise = new WeakMap(), _APIPromise_unwrapped = new WeakMap(), _a = Symbol.toStringTag;
+//# sourceMappingURL=async.js.map

package/types/async.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async.js","sourceRoot":"","sources":["../src/types/async.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;AAmBH,MAAa,UAAU;IAMrB,YAAY,CAAuC;QAL1C,sCAAgC;QAChC,wCAAuB;QAEvB,QAAoB,GAAG,YAAY,CAAC;QAG3C,uBAAA,IAAI,uBAAY,CAAC,YAAY,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAA,CAAC;QAC9D,uBAAA,IAAI,yBACF,CAAC,YAAY,OAAO;YAClB,CAAC,CAAC,uBAAA,IAAI,2BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC;YACxC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAA,CAAC;IAC9B,CAAC;IAED,IAAI,CACF,WAGa,EACb,UAGa;QAEb,OAAO,uBAAA,IAAI,2BAAS,CAAC,IAAI,CACvB,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EACtD,UAAU,CACX,CAAC;IACJ,CAAC;IAED,KAAK,CACH,UAGa;QAEb,OAAO,uBAAA,IAAI,6BAAW,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,CAAC,SAA2C;QACjD,OAAO,uBAAA,IAAI,6BAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,QAAQ;QACN,OAAO,uBAAA,IAAI,2BAAS,CAAC;IACvB,CAAC;CACF;AA9CD,gCA8CC;iFA1CW,MAAM,CAAC,WAAW"}

package/.devcontainer/README.md

@@ -1,35 +0,0 @@
-
-<div align="center">
-    <a href="https://codespaces.new/repconnex/repconnex.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
-</div>
-<br>
-
-> **Remember to shutdown a GitHub Codespace when it is not in use!**
-
-# Dev Containers Quick Start
-
-The default location for usage snippets is the `samples` directory.
-
-## Running a Usage Sample
-
-A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
-
-```
-ts-node root.ts
-```
-
-## Generating Additional Usage Samples
-
-The speakeasy CLI allows you to generate more usage snippets. Here's how:
-
-- To generate a sample for a specific operation by providing an operation ID, use:
-
-```
-speakeasy generate usage -s https://example.com/OVERWRITE_WHEN_SAMPLE_SPEC_IS_WRITTEN -l typescript -i {INPUT_OPERATION_ID} -o ./samples
-```
-
-- To generate samples for an entire namespace (like a tag or group name), use:
-
-```
-speakeasy generate usage -s https://example.com/OVERWRITE_WHEN_SAMPLE_SPEC_IS_WRITTEN -l typescript -n {INPUT_TAG_NAME} -o ./samples
-```

package/docs/sdks/greensecurity/README.md

@@ -1,14 +0,0 @@
-# GreenSecurity SDK
-
-## Overview
-
-API Reference: The Green Security API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). 
-Our API has predictable resource-oriented URLs, accepts [JSON-encoded](http://www.json.org/) request bodies, 
-returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
-
-The API is updated frequently, so be sure to check back often for the latest information.
-
-Some useful links:
-- [OpenAPI Reference](https://www.speakeasy.com/openapi)
-
-### Available Operations