@greensecurity/javascript-sdk 0.16.0 → 0.18.0

package/src/funcs/vendorsListVendorJobTitles.ts

@@ -3,6 +3,7 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -22,6 +23,12 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
 
 /**
  * List vendor job titles
@@ -34,17 +41,20 @@ export function vendorsListVendorJobTitles(
   request: operations.ListVendorJobTitlesRequest,
   options?: RequestOptions,
 ): APIPromise<
-  Result<
-    operations.ListVendorJobTitlesListVendorJobTitlesOk,
-    | errors.ApiErrorResponse
-    | errors.ApiErrorResponse
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
+  PageIterator<
+    Result<
+      operations.ListVendorJobTitlesResponse,
+      | errors.ApiErrorResponse
+      | errors.ApiErrorResponse
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    { page: number }
   >
 > {
   return new APIPromise($do(
@@ -60,17 +70,20 @@ async function $do(
   options?: RequestOptions,
 ): Promise<
   [
-    Result<
-      operations.ListVendorJobTitlesListVendorJobTitlesOk,
-      | errors.ApiErrorResponse
-      | errors.ApiErrorResponse
-      | APIError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | ConnectionError
+    PageIterator<
+      Result<
+        operations.ListVendorJobTitlesResponse,
+        | errors.ApiErrorResponse
+        | errors.ApiErrorResponse
+        | APIError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+      >,
+      { page: number }
     >,
     APICall,
   ]
@@ -82,7 +95,7 @@ async function $do(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
+    return [haltIterator(parsed), { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -125,7 +138,7 @@ async function $do(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
+    return [haltIterator(requestRes), { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -136,7 +149,7 @@ async function $do(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req }];
+    return [haltIterator(doResult), { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -144,8 +157,8 @@ async function $do(
     HttpMeta: { Response: response, Request: req },
   };
 
-  const [result] = await M.match<
-    operations.ListVendorJobTitlesListVendorJobTitlesOk,
+  const [result, raw] = await M.match<
+    operations.ListVendorJobTitlesResponse,
     | errors.ApiErrorResponse
     | errors.ApiErrorResponse
     | APIError
@@ -156,18 +169,73 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(
-      200,
-      operations.ListVendorJobTitlesListVendorJobTitlesOk$inboundSchema,
-    ),
+    M.json(200, operations.ListVendorJobTitlesResponse$inboundSchema, {
+      key: "Result",
+    }),
     M.jsonErr(403, errors.ApiErrorResponse$inboundSchema),
     M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return [result, { status: "complete", request: req, response }];
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
   }
 
-  return [result, { status: "complete", request: req, response }];
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListVendorJobTitlesResponse,
+        | errors.ApiErrorResponse
+        | errors.ApiErrorResponse
+        | APIError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
+    const page = request?.page ?? 1;
+    const nextPage = page + 1;
+
+    if (!responseData) {
+      return { next: () => null };
+    }
+    const results = dlv(responseData, "items");
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.itemsPerPage ?? 0;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      vendorsListVendorJobTitles(
+        client,
+        {
+          ...request,
+          page: nextPage,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { page: nextPage } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
 }

package/src/lib/config.ts

@@ -72,8 +72,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.3",
-  sdkVersion: "0.16.0",
-  genVersion: "2.541.0",
+  sdkVersion: "0.18.0",
+  genVersion: "2.545.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.16.0 2.541.0 0.0.3 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.18.0 2.545.4 0.0.3 @greensecurity/javascript-sdk",
 } as const;

package/src/mcp-server/extensions.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ZodRawShape } from "zod";
+import { ResourceDefinition, ResourceTemplateDefinition } from "./resources.js";
+import { ToolDefinition } from "./tools.js";
+
+export type Register = {
+  tool: <A extends ZodRawShape | undefined>(def: ToolDefinition<A>) => void;
+  resource: (def: ResourceDefinition) => void;
+  resourceTemplate: (def: ResourceTemplateDefinition) => void;
+};

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.16.0",
+    currentVersion: "0.18.0",
   },
 });
 

package/src/mcp-server/resources.ts

@@ -2,12 +2,16 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
+import {
+  McpServer,
+  ResourceMetadata,
+  ResourceTemplate,
+} from "@modelcontextprotocol/sdk/server/mcp.js";
 import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import { Variables } from "@modelcontextprotocol/sdk/shared/uriTemplate.js";
 import { ReadResourceResult } from "@modelcontextprotocol/sdk/types.js";
 import { GreenSecurityCore } from "../core.js";
-import { Result } from "../types/fp.js";
+import { ConsoleLogger } from "./console-logger.js";
 import { MCPScope } from "./scopes.js";
 import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
 
@@ -19,7 +23,8 @@ export type ReadResourceCallback = (
 
 export type ResourceDefinition = {
   name: string;
-  description: string;
+  description?: string;
+  metadata?: ResourceMetadata;
   scopes?: MCPScope[];
   resource: string;
   read: ReadResourceCallback;
@@ -35,30 +40,27 @@ export type ReadResourceTemplateCallback = (
 export type ResourceTemplateDefinition = {
   name: string;
   description: string;
+  metadata?: ResourceMetadata;
   scopes?: MCPScope[];
   resource: ResourceTemplate;
   read: ReadResourceTemplateCallback;
 };
 
 export async function formatResult(
-  result: Result<unknown, Error>,
+  value: unknown,
   uri: URL,
-  init: { response?: Response | undefined },
+  init: { mimeType?: string | undefined; response?: Response | undefined },
 ): Promise<ReadResourceResult> {
-  if (!result.ok) {
-    throw result.error;
-  }
-
-  const { value } = result;
   if (typeof value === "undefined") {
     return { contents: [] };
   }
 
-  const { response } = init;
-  const mimeType = response?.headers.get("content-type") ?? "";
   let contents: ReadResourceResult["contents"] = [];
 
-  if (mimeType.search(/\bjson\b/g)) {
+  const mimeType = init.mimeType ?? init.response?.headers.get("content-type")
+    ?? "";
+
+  if (mimeType.search(/\bjson\b/g) !== -1) {
     contents = [{ uri: uri.toString(), mimeType, text: JSON.stringify(value) }];
   } else if (
     mimeType.startsWith("text/event-stream")
@@ -71,7 +73,10 @@ export async function formatResult(
         text: await stringifySSEToJSON(value),
       },
     ];
-  } else if (mimeType.startsWith("text/") && typeof value === "string") {
+  } else if (
+    (mimeType.startsWith("text/") || mimeType.startsWith("application/"))
+    && typeof value === "string"
+  ) {
     contents = [{ uri: uri.toString(), mimeType, text: value }];
   } else if (isBinaryData(value)) {
     const blob = await valueToBase64(value);
@@ -94,3 +99,59 @@ async function stringifySSEToJSON(
 
   return JSON.stringify(payloads);
 }
+
+export function createRegisterResource(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: GreenSecurityCore,
+  allowedScopes: Set<MCPScope>,
+): (resource: ResourceDefinition) => void {
+  return (resource: ResourceDefinition): void => {
+    const scopes = resource.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    const metadata: ResourceMetadata = {
+      ...resource.metadata,
+      description: resource.description,
+    };
+
+    server.resource(
+      resource.name,
+      resource.resource,
+      metadata,
+      async (uri, ctx) => resource.read(sdk, uri, ctx),
+    );
+
+    logger.debug("Registered resource", { name: resource.name });
+  };
+}
+
+export function createRegisterResourceTemplate(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: GreenSecurityCore,
+  allowedScopes: Set<MCPScope>,
+): (resource: ResourceTemplateDefinition) => void {
+  return (resource: ResourceTemplateDefinition): void => {
+    const scopes = resource.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    const metadata: ResourceMetadata = {
+      ...resource.metadata,
+      description: resource.description,
+    };
+
+    server.resource(
+      resource.name,
+      resource.resource,
+      metadata,
+      async (uri, vars, ctx) => resource.read(sdk, uri, vars, ctx),
+    );
+
+    logger.debug("Registered resource template", { name: resource.name });
+  };
+}

package/src/mcp-server/server.ts

@@ -6,6 +6,10 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { GreenSecurityCore } from "../core.js";
 import { SDKOptions } from "../lib/config.js";
 import type { ConsoleLogger } from "./console-logger.js";
+import {
+  createRegisterResource,
+  createRegisterResourceTemplate,
+} from "./resources.js";
 import { MCPScope, mcpScopes } from "./scopes.js";
 import { createRegisterTool } from "./tools.js";
 import { tool$organizationsGetFacility } from "./tools/organizationsGetFacility.js";
@@ -19,7 +23,9 @@ import { tool$usersMagiclink } from "./tools/usersMagiclink.js";
 import { tool$usersPassword } from "./tools/usersPassword.js";
 import { tool$usersPasswordResetRequest } from "./tools/usersPasswordResetRequest.js";
 import { tool$vendorsCreateVendorRegistration } from "./tools/vendorsCreateVendorRegistration.js";
+import { tool$vendorsExpediteTimeRemaining } from "./tools/vendorsExpediteTimeRemaining.js";
 import { tool$vendorsListVendorCredentials } from "./tools/vendorsListVendorCredentials.js";
+import { tool$vendorsListVendorInvoices } from "./tools/vendorsListVendorInvoices.js";
 import { tool$vendorsListVendorJobTitles } from "./tools/vendorsListVendorJobTitles.js";
 
 export function createMCPServer(deps: {
@@ -32,7 +38,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "GreenSecurity",
-    version: "0.16.0",
+    version: "0.18.0",
   });
 
   const client = new GreenSecurityCore({
@@ -40,7 +46,9 @@ export function createMCPServer(deps: {
     serverURL: deps.serverURL,
     serverIdx: deps.serverIdx,
   });
+
   const scopes = new Set(deps.scopes ?? mcpScopes);
+
   const allowedTools = deps.allowedTools && new Set(deps.allowedTools);
   const tool = createRegisterTool(
     deps.logger,
@@ -49,10 +57,21 @@ export function createMCPServer(deps: {
     scopes,
     allowedTools,
   );
+  const resource = createRegisterResource(deps.logger, server, client, scopes);
+  const resourceTemplate = createRegisterResourceTemplate(
+    deps.logger,
+    server,
+    client,
+    scopes,
+  );
+  const register = { tool, resource, resourceTemplate };
+  void register; // suppress unused warnings
 
   tool(tool$vendorsCreateVendorRegistration);
   tool(tool$vendorsListVendorJobTitles);
   tool(tool$vendorsListVendorCredentials);
+  tool(tool$vendorsExpediteTimeRemaining);
+  tool(tool$vendorsListVendorInvoices);
   tool(tool$usersGetCurrentUser);
   tool(tool$usersGetUserById);
   tool(tool$usersLogsUserIntoTheSystem);

package/src/mcp-server/tools/organizationsListOrSearchFacilities.ts

@@ -45,7 +45,7 @@ Available \`expand\` scopes are:
       };
     }
 
-    const value = result.value;
+    const value = result.value.result;
 
     return formatResult(value, apiCall);
   },

package/src/mcp-server/tools/supportArticlesListOrSearchSupportArticles.ts

@@ -32,7 +32,7 @@ List or search support articles for FAQ.`,
       };
     }
 
-    const value = result.value;
+    const value = result.value.result;
 
     return formatResult(value, apiCall);
   },

package/src/mcp-server/tools/vendorsExpediteTimeRemaining.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { vendorsExpediteTimeRemaining } from "../../funcs/vendorsExpediteTimeRemaining.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ExpediteTimeRemainingRequest$inboundSchema,
+};
+
+export const tool$vendorsExpediteTimeRemaining: ToolDefinition<typeof args> = {
+  name: "vendors_expedite-time-remaining",
+  description: `Expedite time remaining
+
+For vendors who have a paid 24-hour expedite credentials invoice, get the remaining time (in seconds) for which submitted credentials will be expedited.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await vendorsExpediteTimeRemaining(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/vendorsListVendorInvoices.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { vendorsListVendorInvoices } from "../../funcs/vendorsListVendorInvoices.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListVendorInvoicesRequest$inboundSchema,
+};
+
+export const tool$vendorsListVendorInvoices: ToolDefinition<typeof args> = {
+  name: "vendors_list-vendor-invoices",
+  description: `List vendor invoices
+
+List invoices for Vendors
+
+Available \`expand\` scopes are:
+
+invoice.line_items`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await vendorsListVendorInvoices(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/vendorsListVendorJobTitles.ts

@@ -30,7 +30,7 @@ List valid job titles for Vendors. This can be used during sign up or in a filte
       };
     }
 
-    const value = result.value;
+    const value = result.value.result;
 
     return formatResult(value, apiCall);
   },

package/src/models/components/expand.ts

@@ -30,6 +30,7 @@ export const Expand = {
   SupportArticlePublished: "support_article.published",
   SupportArticleNotes: "support_article.notes",
   SupportArticleSupportCategory: "support_article.support_category",
+  InvoiceLineItems: "invoice.line_items",
 } as const;
 /**
  * An expansion scope that is valid for the object being requested.

package/src/models/components/index.ts

@@ -12,6 +12,8 @@ export * from "./expand.js";
 export * from "./facility.js";
 export * from "./facilitysummary.js";
 export * from "./imageset.js";
+export * from "./invoice.js";
+export * from "./invoiceitem.js";
 export * from "./loginemailandpassword.js";
 export * from "./loginrequirementsfromemail.js";
 export * from "./mfarequiredresponse.js";

package/src/models/components/invoice.ts

@@ -0,0 +1,99 @@
+/*
+ * 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";
+import {
+  InvoiceItem,
+  InvoiceItem$inboundSchema,
+  InvoiceItem$Outbound,
+  InvoiceItem$outboundSchema,
+} from "./invoiceitem.js";
+
+/**
+ * A simplified representation of an Invoice
+ */
+export type Invoice = {
+  id: number;
+  invoiceNumber?: string | null | undefined;
+  amount?: number | null | undefined;
+  status?: string | null | undefined;
+  financialStatus?: string | null | undefined;
+  items?: Array<InvoiceItem> | undefined;
+};
+
+/** @internal */
+export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.number().int(),
+    invoice_number: z.nullable(z.string()).optional(),
+    amount: z.nullable(z.number().int()).optional(),
+    status: z.nullable(z.string()).optional(),
+    financial_status: z.nullable(z.string()).optional(),
+    items: z.array(InvoiceItem$inboundSchema).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "invoice_number": "invoiceNumber",
+      "financial_status": "financialStatus",
+    });
+  });
+
+/** @internal */
+export type Invoice$Outbound = {
+  id: number;
+  invoice_number?: string | null | undefined;
+  amount?: number | null | undefined;
+  status?: string | null | undefined;
+  financial_status?: string | null | undefined;
+  items?: Array<InvoiceItem$Outbound> | undefined;
+};
+
+/** @internal */
+export const Invoice$outboundSchema: z.ZodType<
+  Invoice$Outbound,
+  z.ZodTypeDef,
+  Invoice
+> = z.object({
+  id: z.number().int(),
+  invoiceNumber: z.nullable(z.string()).optional(),
+  amount: z.nullable(z.number().int()).optional(),
+  status: z.nullable(z.string()).optional(),
+  financialStatus: z.nullable(z.string()).optional(),
+  items: z.array(InvoiceItem$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    invoiceNumber: "invoice_number",
+    financialStatus: "financial_status",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Invoice$ {
+  /** @deprecated use `Invoice$inboundSchema` instead. */
+  export const inboundSchema = Invoice$inboundSchema;
+  /** @deprecated use `Invoice$outboundSchema` instead. */
+  export const outboundSchema = Invoice$outboundSchema;
+  /** @deprecated use `Invoice$Outbound` instead. */
+  export type Outbound = Invoice$Outbound;
+}
+
+export function invoiceToJSON(invoice: Invoice): string {
+  return JSON.stringify(Invoice$outboundSchema.parse(invoice));
+}
+
+export function invoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<Invoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Invoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Invoice' from JSON`,
+  );
+}