@greensecurity/javascript-sdk 0.15.1 → 0.17.0

package/REACT_QUERY.md

@@ -22,7 +22,11 @@ import { GreenSecurityCore } from "@greensecurity/javascript-sdk";
 import { GreenSecurityProvider } from "@greensecurity/javascript-sdk/react-query";
 
 const queryClient = new QueryClient();
-const greenSecurity = new GreenSecurityCore();
+const greenSecurity = new GreenSecurityCore({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
 
 // Retries are handled by the underlying SDK.
 queryClient.setQueryDefaults(["@greensecurity/javascript-sdk"], { retry: false });
@@ -48,14 +52,11 @@ from TanStack Query.
 [use-query]: https://tanstack.com/query/v5/docs/framework/react/reference/useQuery
 
 ```tsx
-import { useVendorsListVendorJobTitles } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorJobTitles.js";
+import { useVendorsListVendorCredentials } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
 
 export function Example() {
-  const { data, error, status } = useVendorsListVendorJobTitles({
-    sort: "job",
-    desc: true,
-    itemsPerPage: 25,
-    jobLike: "job",
+  const { data, error, status } = useVendorsListVendorCredentials({
+    vendorId: 327408,
   });
 
   // Render the UI here...
@@ -69,16 +70,13 @@ more options provided by the query hooks to control these behaviors.
 
 ```tsx
 import { useState } from "react";
-import { useVendorsListVendorJobTitles } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorJobTitles.js";
+import { useVendorsListVendorCredentials } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
 
 export function ExampleWithOptions() {
   const [enabled, setEnabled] = useState(true);
-  const { data, error, status } = useVendorsListVendorJobTitles(
+  const { data, error, status } = useVendorsListVendorCredentials(
     {
-      sort: "job",
-      desc: true,
-      itemsPerPage: 25,
-      jobLike: "job",
+      vendorId: 327408,
     },
     {
       // TanStack Query options:
@@ -186,7 +184,7 @@ query hook there are two functions that help invalidate cached data:
 
 ```tsx
 import { useQueryClient } from "@tanstack/react-query";
-import { invalidateVendorsListVendorJobTitles, invalidateAllVendorsListVendorJobTitles } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorJobTitles.js";
+import { invalidateVendorsListVendorCredentials, invalidateAllVendorsListVendorCredentials } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
 // Replace this with a real mutation
 import { useExampleMutation } from "@greensecurity/javascript-sdk/react-query/example.js";
 
@@ -204,9 +202,9 @@ export function Example() {
         mutate(formData, {
           onSuccess: () => {
             // Invalidate a single cache entry:
-            invalidateVendorsListVendorJobTitles(queryClient, /* ... arguments ... */);
+            invalidateVendorsListVendorCredentials(queryClient, /* ... arguments ... */);
             // OR, invalidate all cache entries for the query targets:
-            invalidateAllVendorsListVendorJobTitles(queryClient);
+            invalidateAllVendorsListVendorCredentials(queryClient);
           },
         });
       }}
@@ -220,6 +218,44 @@ export function Example() {
 ```
 
 
+## Pagination
+
+Certain queries may have pagination enabled if the underlying API supports it.
+In these cases, additional "infinite" query hooks are exposed to help build
+infinite scrolling and "load more" user interfaces.
+
+> [!NOTE]
+>
+> The original query hooks will still be available and if you are building a
+> more explicit pagination UI with page numbers and next/previous buttons then
+> those hooks may be more suitable.
+
+```tsx
+import { useVendorsListVendorJobTitlesInfinite } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorJobTitles.js";
+
+export function Example() {
+  const { data, error, status, fetchNextPage, hasNextPage } = useVendorsListVendorJobTitlesInfinite({
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+    jobLike: "job",
+  });
+
+  return (
+    <div>
+      {/* Render pages here... */}
+
+      {hasNextPage ? (
+        <div>
+          <button onClick={() => fetchNextPage()}>Load more</button>
+        </div>
+      ) : null}
+    </div>
+  );
+}
+```
+
+
 ## Integration with React Suspense
 
 TanStack Query predates React Suspense and out of the box it does a great job at
@@ -234,10 +270,14 @@ import { ErrorBoundary } from "react-error-boundary";
 
 import { GreenSecurityCore } from "@greensecurity/javascript-sdk";
 import { GreenSecurityProvider } from "@greensecurity/javascript-sdk/react-query";
-import { useVendorsListVendorJobTitlesSuspense } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorJobTitles.js";
+import { useVendorsListVendorCredentialsSuspense } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
 
 const queryClient = new QueryClient();
-const greenSecurity = new GreenSecurityCore();
+const greenSecurity = new GreenSecurityCore({
+  security: {
+    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+  },
+});
 
 export function App() {
   return (
@@ -267,11 +307,8 @@ export function App() {
 }
 
 function Example() {
-  const { data } = useVendorsListVendorJobTitlesSuspense({
-    sort: "job",
-    desc: true,
-    itemsPerPage: 25,
-    jobLike: "job",
+  const { data } = useVendorsListVendorCredentialsSuspense({
+    vendorId: 327408,
   });
 
   // Render the UI here...
@@ -292,17 +329,18 @@ import {
   QueryClient,
 } from "@tanstack/react-query";
 import { GreenSecurityCore } from "@greensecurity/javascript-sdk";
-import { prefetchVendorsListVendorJobTitles } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorJobTitles.js";
+import { prefetchVendorsListVendorCredentials } from "@greensecurity/javascript-sdk/react-query/vendorsListVendorCredentials.js";
 
 export default async function Page() {
   const queryClient = new QueryClient();
-  const greenSecurity = new GreenSecurityCore();
+  const greenSecurity = new GreenSecurityCore({
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
+    },
+  });
 
-  await prefetchVendorsListVendorJobTitles(queryClient, greenSecurity, {
-    sort: "job",
-    desc: true,
-    itemsPerPage: 25,
-    jobLike: "job",
+  await prefetchVendorsListVendorCredentials(queryClient, greenSecurity, {
+    vendorId: 327408,
   });
 
   return (

package/README.md

@@ -40,6 +40,7 @@ Some useful links:
   * [Available Resources and Operations](#available-resources-and-operations)
   * [Standalone functions](#standalone-functions)
   * [React hooks with TanStack Query](#react-hooks-with-tanstack-query)
+  * [Pagination](#pagination)
   * [Retries](#retries)
   * [Error Handling](#error-handling)
   * [Server Selection](#server-selection)
@@ -233,19 +234,27 @@ run();
 * [listOrSearchFacilities](docs/sdks/organizations/README.md#listorsearchfacilities) - List or search facilities
 * [getFacility](docs/sdks/organizations/README.md#getfacility) - Get facility
 
-### [user](docs/sdks/user/README.md)
+### [supportArticles](docs/sdks/supportarticles/README.md)
 
-* [getCurrentUser](docs/sdks/user/README.md#getcurrentuser) - Get current user
-* [getUserById](docs/sdks/user/README.md#getuserbyid) - Get user by id
-* [logsUserIntoTheSystem](docs/sdks/user/README.md#logsuserintothesystem) - Logs user into the system
-* [magiclink](docs/sdks/user/README.md#magiclink) - Magic link
-* [passwordResetRequest](docs/sdks/user/README.md#passwordresetrequest) - Password reset request
-* [password](docs/sdks/user/README.md#password) - Password reset
+* [listOrSearchSupportArticles](docs/sdks/supportarticles/README.md#listorsearchsupportarticles) - List or search support articles
+* [getSupportArticle](docs/sdks/supportarticles/README.md#getsupportarticle) - Get support article
+
+### [users](docs/sdks/users/README.md)
+
+* [getCurrentUser](docs/sdks/users/README.md#getcurrentuser) - Get current user
+* [getUserById](docs/sdks/users/README.md#getuserbyid) - Get user by id
+* [logsUserIntoTheSystem](docs/sdks/users/README.md#logsuserintothesystem) - Logs user into the system
+* [magiclink](docs/sdks/users/README.md#magiclink) - Magic link
+* [passwordResetRequest](docs/sdks/users/README.md#passwordresetrequest) - Password reset request
+* [password](docs/sdks/users/README.md#password) - Password reset
 
 ### [vendors](docs/sdks/vendors/README.md)
 
 * [createVendorRegistration](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
 * [listVendorJobTitles](docs/sdks/vendors/README.md#listvendorjobtitles) - List vendor job titles
+* [listVendorCredentials](docs/sdks/vendors/README.md#listvendorcredentials) - List Vendor Credentials
+* [expediteTimeRemaining](docs/sdks/vendors/README.md#expeditetimeremaining) - Expedite time remaining
+* [listVendorInvoices](docs/sdks/vendors/README.md#listvendorinvoices) - List vendor invoices
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -267,13 +276,18 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 - [`organizationsGetFacility`](docs/sdks/organizations/README.md#getfacility) - Get facility
 - [`organizationsListOrSearchFacilities`](docs/sdks/organizations/README.md#listorsearchfacilities) - List or search facilities
-- [`userGetCurrentUser`](docs/sdks/user/README.md#getcurrentuser) - Get current user
-- [`userGetUserById`](docs/sdks/user/README.md#getuserbyid) - Get user by id
-- [`userLogsUserIntoTheSystem`](docs/sdks/user/README.md#logsuserintothesystem) - Logs user into the system
-- [`userMagiclink`](docs/sdks/user/README.md#magiclink) - Magic link
-- [`userPassword`](docs/sdks/user/README.md#password) - Password reset
-- [`userPasswordResetRequest`](docs/sdks/user/README.md#passwordresetrequest) - Password reset request
+- [`supportArticlesGetSupportArticle`](docs/sdks/supportarticles/README.md#getsupportarticle) - Get support article
+- [`supportArticlesListOrSearchSupportArticles`](docs/sdks/supportarticles/README.md#listorsearchsupportarticles) - List or search support articles
+- [`usersGetCurrentUser`](docs/sdks/users/README.md#getcurrentuser) - Get current user
+- [`usersGetUserById`](docs/sdks/users/README.md#getuserbyid) - Get user by id
+- [`usersLogsUserIntoTheSystem`](docs/sdks/users/README.md#logsuserintothesystem) - Logs user into the system
+- [`usersMagiclink`](docs/sdks/users/README.md#magiclink) - Magic link
+- [`usersPassword`](docs/sdks/users/README.md#password) - Password reset
+- [`usersPasswordResetRequest`](docs/sdks/users/README.md#passwordresetrequest) - Password reset request
 - [`vendorsCreateVendorRegistration`](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
+- [`vendorsExpediteTimeRemaining`](docs/sdks/vendors/README.md#expeditetimeremaining) - Expedite time remaining
+- [`vendorsListVendorCredentials`](docs/sdks/vendors/README.md#listvendorcredentials) - List Vendor Credentials
+- [`vendorsListVendorInvoices`](docs/sdks/vendors/README.md#listvendorinvoices) - List vendor invoices
 - [`vendorsListVendorJobTitles`](docs/sdks/vendors/README.md#listvendorjobtitles) - List vendor job titles
 
 </details>
@@ -303,18 +317,59 @@ To learn about this feature and how to get started, check
 
 - [`useOrganizationsGetFacility`](docs/sdks/organizations/README.md#getfacility) - Get facility
 - [`useOrganizationsListOrSearchFacilities`](docs/sdks/organizations/README.md#listorsearchfacilities) - List or search facilities
-- [`useUserGetCurrentUser`](docs/sdks/user/README.md#getcurrentuser) - Get current user
-- [`useUserGetUserById`](docs/sdks/user/README.md#getuserbyid) - Get user by id
-- [`useUserLogsUserIntoTheSystemMutation`](docs/sdks/user/README.md#logsuserintothesystem) - Logs user into the system
-- [`useUserMagiclinkMutation`](docs/sdks/user/README.md#magiclink) - Magic link
-- [`useUserPasswordMutation`](docs/sdks/user/README.md#password) - Password reset
-- [`useUserPasswordResetRequestMutation`](docs/sdks/user/README.md#passwordresetrequest) - Password reset request
+- [`useSupportArticlesGetSupportArticle`](docs/sdks/supportarticles/README.md#getsupportarticle) - Get support article
+- [`useSupportArticlesListOrSearchSupportArticles`](docs/sdks/supportarticles/README.md#listorsearchsupportarticles) - List or search support articles
+- [`useUsersGetCurrentUser`](docs/sdks/users/README.md#getcurrentuser) - Get current user
+- [`useUsersGetUserById`](docs/sdks/users/README.md#getuserbyid) - Get user by id
+- [`useUsersLogsUserIntoTheSystemMutation`](docs/sdks/users/README.md#logsuserintothesystem) - Logs user into the system
+- [`useUsersMagiclinkMutation`](docs/sdks/users/README.md#magiclink) - Magic link
+- [`useUsersPasswordMutation`](docs/sdks/users/README.md#password) - Password reset
+- [`useUsersPasswordResetRequestMutation`](docs/sdks/users/README.md#passwordresetrequest) - Password reset request
 - [`useVendorsCreateVendorRegistrationMutation`](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
+- [`useVendorsExpediteTimeRemaining`](docs/sdks/vendors/README.md#expeditetimeremaining) - Expedite time remaining
+- [`useVendorsListVendorCredentials`](docs/sdks/vendors/README.md#listvendorcredentials) - List Vendor Credentials
+- [`useVendorsListVendorInvoices`](docs/sdks/vendors/README.md#listvendorinvoices) - List vendor invoices
 - [`useVendorsListVendorJobTitles`](docs/sdks/vendors/README.md#listvendorjobtitles) - List vendor job titles
 
 </details>
 <!-- End React hooks with TanStack Query [react-query] -->
 
+<!-- Start Pagination [pagination] -->
+## Pagination
+
+Some of the endpoints in this SDK support pagination. To use pagination, you
+make your SDK calls as usual, but the returned response object will also be an
+async iterable that can be consumed using the [`for await...of`][for-await-of]
+syntax.
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+
+Here's an example of one such pagination call:
+
+```typescript
+import { GreenSecurity } from "@greensecurity/javascript-sdk";
+
+const greenSecurity = new GreenSecurity();
+
+async function run() {
+  const result = await greenSecurity.vendors.listVendorJobTitles({
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+    jobLike: "job",
+  });
+
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
+}
+
+run();
+
+```
+<!-- End Pagination [pagination] -->
+
 <!-- Start Retries [retries] -->
 ## Retries