owasp-nest 0.3.0 → 0.3.1

package/src/models/snapshotissue.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 { State, State$inboundSchema } from "./state.js";
+
+/**
+ * Schema for Snapshot Issue (used in list endpoints).
+ */
+export type SnapshotIssue = {
+  createdAt: Date;
+  state: State;
+  title: string;
+  updatedAt: Date;
+  url: string;
+  organizationLogin: string | null;
+  repositoryName: string | null;
+};
+
+/** @internal */
+export const SnapshotIssue$inboundSchema: z.ZodType<
+  SnapshotIssue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  state: State$inboundSchema,
+  title: z.string(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  url: z.string(),
+  organization_login: z.nullable(z.string()),
+  repository_name: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+    "organization_login": "organizationLogin",
+    "repository_name": "repositoryName",
+  });
+});
+
+export function snapshotIssueFromJSON(
+  jsonString: string,
+): SafeParseResult<SnapshotIssue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SnapshotIssue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SnapshotIssue' from JSON`,
+  );
+}

package/src/models/snapshotrelease.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Schema for Snapshot Release (used in list endpoints).
+ */
+export type SnapshotRelease = {
+  createdAt: Date;
+  name: string;
+  publishedAt?: Date | null | undefined;
+  tagName: string;
+  organizationLogin: string | null;
+  repositoryName: string | null;
+};
+
+/** @internal */
+export const SnapshotRelease$inboundSchema: z.ZodType<
+  SnapshotRelease,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  name: z.string(),
+  published_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  tag_name: z.string(),
+  organization_login: z.nullable(z.string()),
+  repository_name: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "published_at": "publishedAt",
+    "tag_name": "tagName",
+    "organization_login": "organizationLogin",
+    "repository_name": "repositoryName",
+  });
+});
+
+export function snapshotReleaseFromJSON(
+  jsonString: string,
+): SafeParseResult<SnapshotRelease, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SnapshotRelease$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SnapshotRelease' from JSON`,
+  );
+}

package/src/models/sponsor.ts

@@ -34,50 +34,6 @@ export const Sponsor$inboundSchema: z.ZodType<Sponsor, z.ZodTypeDef, unknown> =
     });
   });
 
-/** @internal */
-export type Sponsor$Outbound = {
-  image_url: string;
-  key: string;
-  name: string;
-  sponsor_type: string;
-  url: string;
-};
-
-/** @internal */
-export const Sponsor$outboundSchema: z.ZodType<
-  Sponsor$Outbound,
-  z.ZodTypeDef,
-  Sponsor
-> = z.object({
-  imageUrl: z.string(),
-  key: z.string(),
-  name: z.string(),
-  sponsorType: z.string(),
-  url: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    imageUrl: "image_url",
-    sponsorType: "sponsor_type",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Sponsor$ {
-  /** @deprecated use `Sponsor$inboundSchema` instead. */
-  export const inboundSchema = Sponsor$inboundSchema;
-  /** @deprecated use `Sponsor$outboundSchema` instead. */
-  export const outboundSchema = Sponsor$outboundSchema;
-  /** @deprecated use `Sponsor$Outbound` instead. */
-  export type Outbound = Sponsor$Outbound;
-}
-
-export function sponsorToJSON(sponsor: Sponsor): string {
-  return JSON.stringify(Sponsor$outboundSchema.parse(sponsor));
-}
-
 export function sponsorFromJSON(
   jsonString: string,
 ): SafeParseResult<Sponsor, SDKValidationError> {

package/src/models/sponsordetail.ts

@@ -48,61 +48,6 @@ export const SponsorDetail$inboundSchema: z.ZodType<
   });
 });
 
-/** @internal */
-export type SponsorDetail$Outbound = {
-  image_url: string;
-  key: string;
-  name: string;
-  sponsor_type: string;
-  url: string;
-  description: string;
-  is_member: boolean;
-  job_url: string;
-  member_type: string;
-};
-
-/** @internal */
-export const SponsorDetail$outboundSchema: z.ZodType<
-  SponsorDetail$Outbound,
-  z.ZodTypeDef,
-  SponsorDetail
-> = z.object({
-  imageUrl: z.string(),
-  key: z.string(),
-  name: z.string(),
-  sponsorType: z.string(),
-  url: z.string(),
-  description: z.string(),
-  isMember: z.boolean(),
-  jobUrl: z.string(),
-  memberType: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    imageUrl: "image_url",
-    sponsorType: "sponsor_type",
-    isMember: "is_member",
-    jobUrl: "job_url",
-    memberType: "member_type",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace SponsorDetail$ {
-  /** @deprecated use `SponsorDetail$inboundSchema` instead. */
-  export const inboundSchema = SponsorDetail$inboundSchema;
-  /** @deprecated use `SponsorDetail$outboundSchema` instead. */
-  export const outboundSchema = SponsorDetail$outboundSchema;
-  /** @deprecated use `SponsorDetail$Outbound` instead. */
-  export type Outbound = SponsorDetail$Outbound;
-}
-
-export function sponsorDetailToJSON(sponsorDetail: SponsorDetail): string {
-  return JSON.stringify(SponsorDetail$outboundSchema.parse(sponsorDetail));
-}
-
 export function sponsorDetailFromJSON(
   jsonString: string,
 ): SafeParseResult<SponsorDetail, SDKValidationError> {

package/src/models/state.ts

@@ -15,18 +15,6 @@ export type State = ClosedEnum<typeof State>;
 export const State$inboundSchema: z.ZodNativeEnum<typeof State> = z.nativeEnum(
   State,
 );
-
 /** @internal */
 export const State$outboundSchema: z.ZodNativeEnum<typeof State> =
   State$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace State$ {
-  /** @deprecated use `State$inboundSchema` instead. */
-  export const inboundSchema = State$inboundSchema;
-  /** @deprecated use `State$outboundSchema` instead. */
-  export const outboundSchema = State$outboundSchema;
-}

package/src/sdk/community.ts

@@ -4,8 +4,15 @@
 
 import { communityGetMember } from "../funcs/communityGetMember.js";
 import { communityGetOrganization } from "../funcs/communityGetOrganization.js";
+import { communityGetSnapshot } from "../funcs/communityGetSnapshot.js";
 import { communityListMembers } from "../funcs/communityListMembers.js";
 import { communityListOrganizations } from "../funcs/communityListOrganizations.js";
+import { communityListSnapshotChapters } from "../funcs/communityListSnapshotChapters.js";
+import { communityListSnapshotIssues } from "../funcs/communityListSnapshotIssues.js";
+import { communityListSnapshotMembers } from "../funcs/communityListSnapshotMembers.js";
+import { communityListSnapshotProjects } from "../funcs/communityListSnapshotProjects.js";
+import { communityListSnapshotReleases } from "../funcs/communityListSnapshotReleases.js";
+import { communityListSnapshots } from "../funcs/communityListSnapshots.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
@@ -79,4 +86,123 @@ export class Community extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List snapshots
+   *
+   * @remarks
+   * Retrieve a paginated list of OWASP snapshots.
+   */
+  async listSnapshots(
+    request?: operations.ListSnapshotsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.PagedSnapshot> {
+    return unwrapAsync(communityListSnapshots(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get snapshot
+   *
+   * @remarks
+   * Retrieve snapshot details.
+   */
+  async getSnapshot(
+    request: operations.GetSnapshotRequest,
+    options?: RequestOptions,
+  ): Promise<models.SnapshotDetail> {
+    return unwrapAsync(communityGetSnapshot(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List new chapters in snapshot
+   *
+   * @remarks
+   * Retrieve a paginated list of new chapters in a snapshot.
+   */
+  async listSnapshotChapters(
+    request: operations.ListSnapshotChaptersRequest,
+    options?: RequestOptions,
+  ): Promise<models.PagedChapter> {
+    return unwrapAsync(communityListSnapshotChapters(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List new issues in snapshot
+   *
+   * @remarks
+   * Retrieve a paginated list of new issues in a snapshot.
+   */
+  async listSnapshotIssues(
+    request: operations.ListSnapshotIssuesRequest,
+    options?: RequestOptions,
+  ): Promise<models.PagedSnapshotIssue> {
+    return unwrapAsync(communityListSnapshotIssues(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List new members in snapshot
+   *
+   * @remarks
+   * Retrieve a paginated list of new members in a snapshot.
+   */
+  async listSnapshotMembers(
+    request: operations.ListSnapshotMembersRequest,
+    options?: RequestOptions,
+  ): Promise<models.PagedMember> {
+    return unwrapAsync(communityListSnapshotMembers(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List new projects in snapshot
+   *
+   * @remarks
+   * Retrieve a paginated list of new projects in a snapshot.
+   */
+  async listSnapshotProjects(
+    request: operations.ListSnapshotProjectsRequest,
+    options?: RequestOptions,
+  ): Promise<models.PagedProject> {
+    return unwrapAsync(communityListSnapshotProjects(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List new releases in snapshot
+   *
+   * @remarks
+   * Retrieve a paginated list of new releases in a snapshot.
+   */
+  async listSnapshotReleases(
+    request: operations.ListSnapshotReleasesRequest,
+    options?: RequestOptions,
+  ): Promise<models.PagedSnapshotRelease> {
+    return unwrapAsync(communityListSnapshotReleases(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/types/enums.ts

@@ -2,15 +2,64 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import * as z from "zod/v3";
+
 declare const __brand: unique symbol;
 export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+export type ClosedEnum<T extends Readonly<Record<string, string | number>>> =
+  T[keyof T];
+export type OpenEnum<T extends Readonly<Record<string, string | number>>> =
+  | T[keyof T]
+  | Unrecognized<T[keyof T] extends number ? number : string>;
 
-export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+function unrecognized<T>(value: T): Unrecognized<T> {
+  unrecognizedCount++;
   return value as Unrecognized<T>;
 }
 
-type Prettify<T> = { [K in keyof T]: T[K] } & {};
-export type ClosedEnum<T> = T[keyof T];
-export type OpenEnum<T> =
-  | Prettify<T[keyof T]>
-  | Unrecognized<T[keyof T] extends number ? number : string>;
+let unrecognizedCount = 0;
+let refCount = 0;
+export function unrecognizedCounter() {
+  refCount++;
+  const start = unrecognizedCount;
+  return {
+    count: () => {
+      const count = unrecognizedCount - start;
+      if (--refCount === 0) unrecognizedCount = 0;
+      return count;
+    },
+  };
+}
+
+export function inboundSchema<T extends Record<string, string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  const options = Object.values(enumObj);
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.string().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function inboundSchemaInt<T extends Record<string, number | string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  // For numeric enums, Object.values returns both numbers and string keys
+  const options = Object.values(enumObj).filter(v => typeof v === "number");
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.number().int().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function outboundSchema<T extends Record<string, string>>(
+  _: T,
+): z.ZodType<string, z.ZodTypeDef, OpenEnum<T>> {
+  return z.string() as any;
+}
+
+export function outboundSchemaInt<T extends Record<string, number | string>>(
+  _: T,
+): z.ZodType<number, z.ZodTypeDef, OpenEnum<T>> {
+  return z.number().int() as any;
+}

package/src/types/index.ts

@@ -3,7 +3,6 @@
  */
 
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export { catchUnrecognizedEnum } from "./enums.js";
 export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
 export type { Result } from "./fp.js";
 export type { PageIterator, Paginator } from "./operations.js";

package/docs/sdks/chapters/README.md

@@ -1,156 +0,0 @@
-# Chapters
-(*chapters*)
-
-## Overview
-
-### Available Operations
-
-* [listChapters](#listchapters) - List chapters
-* [getChapter](#getchapter) - Get chapter
-
-## listChapters
-
-Retrieve a paginated list of OWASP chapters.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list_chapters" method="get" path="/api/v0/chapters/" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.chapters.listChapters({
-    country: "India",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { chaptersListChapters } from "owasp-nest/funcs/chaptersListChapters.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await chaptersListChapters(nest, {
-    country: "India",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("chaptersListChapters failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListChaptersRequest](../../models/operations/listchaptersrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.PagedChapter](../../models/pagedchapter.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |
-
-## getChapter
-
-Retrieve chapter details.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="get_chapter" method="get" path="/api/v0/chapters/{chapter_id}" -->
-```typescript
-import { Nest } from "owasp-nest";
-
-const nest = new Nest({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await nest.chapters.getChapter({
-    chapterId: "London",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NestCore } from "owasp-nest/core.js";
-import { chaptersGetChapter } from "owasp-nest/funcs/chaptersGetChapter.js";
-
-// Use `NestCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const nest = new NestCore({
-  apiKey: process.env["NEST_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await chaptersGetChapter(nest, {
-    chapterId: "London",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("chaptersGetChapter failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetChapterRequest](../../models/operations/getchapterrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[models.ChapterDetail](../../models/chapterdetail.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.ChapterError | 404                 | application/json    |
-| errors.NestApiError | 4XX, 5XX            | \*/\*               |