@homeflare/distilled-openbao 0.2.0

package/src/services/rate.ts

@@ -0,0 +1,303 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-openbao, generated — see fetch-specs.ts). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as T from "../traits.ts";
+import {
+  OpenBaoProtocol,
+  type OpenBaoOpError,
+  type OpenBaoOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { OpenBaoOpError, OpenBaoOpContext };
+
+export interface DeleteRateLimitQuotasRequest {
+  /** Name of the quota rule. */
+  name: string;
+}
+export const DeleteRateLimitQuotasRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    name: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      uri: "/sys/quotas/rate-limit/{name}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DeleteRateLimitQuotasRequest",
+}) as any as S.Schema<DeleteRateLimitQuotasRequest>;
+
+export interface DeleteRateLimitQuotasResponse {}
+export const DeleteRateLimitQuotasResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "DeleteRateLimitQuotasResponse",
+}) as any as S.Schema<DeleteRateLimitQuotasResponse>;
+
+export type ListRateLimitQuotasRequestList = "true";
+export const ListRateLimitQuotasRequestList = S.String;
+
+export interface ListRateLimitQuotasRequest {
+  /** Must be set to `true` */
+  list: ListRateLimitQuotasRequestList | (string & {});
+}
+export const ListRateLimitQuotasRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    list: ListRateLimitQuotasRequestList.pipe(T.Query()),
+  }).pipe(T.Http({ method: "GET", uri: "/sys/quotas/rate-limit", code: 200 })),
+).annotate({
+  identifier: "ListRateLimitQuotasRequest",
+}) as any as S.Schema<ListRateLimitQuotasRequest>;
+
+export type RateLimitQuotasListResponseKeysList = Array<string>;
+export const RateLimitQuotasListResponseKeysList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<RateLimitQuotasListResponseKeysList>;
+
+export interface RateLimitQuotasListResponse {
+  keys?: RateLimitQuotasListResponseKeysList;
+}
+export const RateLimitQuotasListResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    keys: S.optional(RateLimitQuotasListResponseKeysList),
+  }),
+).annotate({
+  identifier: "RateLimitQuotasListResponse",
+}) as any as S.Schema<RateLimitQuotasListResponse>;
+
+/** Specifies the list of exempt paths from all rate limit quotas. If empty no paths will be exempt. */
+export type RateLimitQuotasConfigureRequestRateLimitExemptPathsList =
+  Array<string>;
+export const RateLimitQuotasConfigureRequestRateLimitExemptPathsList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<RateLimitQuotasConfigureRequestRateLimitExemptPathsList>;
+
+export interface RateLimitQuotasConfigureRequest {
+  /** If set, starts audit logging of requests that get rejected due to rate limit quota rule violations. */
+  enable_rate_limit_audit_logging?: boolean;
+  /** If set, additional rate limit quota HTTP headers will be added to responses. */
+  enable_rate_limit_response_headers?: boolean;
+  /** Specifies the list of exempt paths from all rate limit quotas. If empty no paths will be exempt. */
+  rate_limit_exempt_paths?: RateLimitQuotasConfigureRequestRateLimitExemptPathsList;
+}
+export const RateLimitQuotasConfigureRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    enable_rate_limit_audit_logging: S.optional(S.Boolean),
+    enable_rate_limit_response_headers: S.optional(S.Boolean),
+    rate_limit_exempt_paths: S.optional(
+      RateLimitQuotasConfigureRequestRateLimitExemptPathsList,
+    ),
+  }).pipe(T.Http({ method: "POST", uri: "/sys/quotas/config", code: 200 })),
+).annotate({
+  identifier: "RateLimitQuotasConfigureRequest",
+}) as any as S.Schema<RateLimitQuotasConfigureRequest>;
+
+export interface RateLimitQuotasConfigureResponse {}
+export const RateLimitQuotasConfigureResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "RateLimitQuotasConfigureResponse",
+}) as any as S.Schema<RateLimitQuotasConfigureResponse>;
+
+export interface RateLimitQuotasReadConfigurationRequest {}
+export const RateLimitQuotasReadConfigurationRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({}).pipe(
+      T.Http({ method: "GET", uri: "/sys/quotas/config", code: 200 }),
+    ),
+).annotate({
+  identifier: "RateLimitQuotasReadConfigurationRequest",
+}) as any as S.Schema<RateLimitQuotasReadConfigurationRequest>;
+
+export type RateLimitQuotasReadConfigurationResponseRateLimitExemptPathsList =
+  Array<string>;
+export const RateLimitQuotasReadConfigurationResponseRateLimitExemptPathsList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<RateLimitQuotasReadConfigurationResponseRateLimitExemptPathsList>;
+
+export interface RateLimitQuotasReadConfigurationResponse {
+  enable_rate_limit_audit_logging?: boolean;
+  enable_rate_limit_response_headers?: boolean;
+  rate_limit_exempt_paths?: RateLimitQuotasReadConfigurationResponseRateLimitExemptPathsList;
+}
+export const RateLimitQuotasReadConfigurationResponse = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      enable_rate_limit_audit_logging: S.optional(S.Boolean),
+      enable_rate_limit_response_headers: S.optional(S.Boolean),
+      rate_limit_exempt_paths: S.optional(
+        RateLimitQuotasReadConfigurationResponseRateLimitExemptPathsList,
+      ),
+    }),
+).annotate({
+  identifier: "RateLimitQuotasReadConfigurationResponse",
+}) as any as S.Schema<RateLimitQuotasReadConfigurationResponse>;
+
+export interface RateLimitQuotasWriteRequest {
+  /** Name of the quota rule. */
+  name: string;
+  /** If set, when a client reaches a rate limit threshold, the client will be prohibited from any further requests until after the 'block_interval' has elapsed. */
+  block_interval?: number;
+  /** If set to true, child namespaces will use this quota, unless another more specific quota exists. Can only be set on namespace quotas. A quota on the root namespace will by default be inheritable. */
+  inheritable?: boolean;
+  /** The duration to enforce rate limiting for (default '1s'). */
+  interval?: number;
+  /** Path of the mount or namespace to apply the quota. A blank path configures a global quota. For example namespace1/ adds a quota to a full namespace, namespace1/auth/userpass adds a quota to userpass in namespace1. */
+  path?: string;
+  /** The maximum number of requests in a given interval to be allowed by the quota rule. The 'rate' must be positive. */
+  rate?: number;
+  /** Login role to apply this quota to. Note that when set, path must be configured to a valid auth method with a concept of roles. */
+  role?: string;
+  /** Type of the quota rule. */
+  type?: string;
+}
+export const RateLimitQuotasWriteRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    name: S.String.pipe(T.Label()),
+    block_interval: S.optional(S.Number),
+    inheritable: S.optional(S.Boolean),
+    interval: S.optional(S.Number),
+    path: S.optional(S.String),
+    rate: S.optional(S.Number),
+    role: S.optional(S.String),
+    type: S.optional(S.String),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/sys/quotas/rate-limit/{name}", code: 200 }),
+  ),
+).annotate({
+  identifier: "RateLimitQuotasWriteRequest",
+}) as any as S.Schema<RateLimitQuotasWriteRequest>;
+
+export interface RateLimitQuotasWriteResponse {}
+export const RateLimitQuotasWriteResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "RateLimitQuotasWriteResponse",
+}) as any as S.Schema<RateLimitQuotasWriteResponse>;
+
+export interface ReadRateLimitQuotasRequest {
+  /** Name of the quota rule. */
+  name: string;
+}
+export const ReadRateLimitQuotasRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    name: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({ method: "GET", uri: "/sys/quotas/rate-limit/{name}", code: 200 }),
+  ),
+).annotate({
+  identifier: "ReadRateLimitQuotasRequest",
+}) as any as S.Schema<ReadRateLimitQuotasRequest>;
+
+export interface RateLimitQuotasReadResponse {
+  block_interval?: number;
+  inheritable?: boolean;
+  interval?: number;
+  name?: string;
+  path?: string;
+  rate?: number;
+  role?: string;
+  type?: string;
+}
+export const RateLimitQuotasReadResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    block_interval: S.optional(S.Number),
+    inheritable: S.optional(S.Boolean),
+    interval: S.optional(S.Number),
+    name: S.optional(S.String),
+    path: S.optional(S.String),
+    rate: S.optional(S.Number),
+    role: S.optional(S.String),
+    type: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "RateLimitQuotasReadResponse",
+}) as any as S.Schema<RateLimitQuotasReadResponse>;
+
+export type DeleteRateLimitQuotasError = OpenBaoOpError;
+export const deleteRateLimitQuotas: API.OperationMethod<
+  DeleteRateLimitQuotasRequest,
+  DeleteRateLimitQuotasResponse,
+  DeleteRateLimitQuotasError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeleteRateLimitQuotasRequest,
+  output: DeleteRateLimitQuotasResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListRateLimitQuotasError = OpenBaoOpError;
+export const listRateLimitQuotas: API.OperationMethod<
+  ListRateLimitQuotasRequest,
+  RateLimitQuotasListResponse,
+  ListRateLimitQuotasError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListRateLimitQuotasRequest,
+  output: RateLimitQuotasListResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RateLimitQuotasConfigureError = OpenBaoOpError;
+export const rateLimitQuotasConfigure: API.OperationMethod<
+  RateLimitQuotasConfigureRequest,
+  RateLimitQuotasConfigureResponse,
+  RateLimitQuotasConfigureError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RateLimitQuotasConfigureRequest,
+  output: RateLimitQuotasConfigureResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RateLimitQuotasReadConfigurationError = OpenBaoOpError;
+export const rateLimitQuotasReadConfiguration: API.OperationMethod<
+  RateLimitQuotasReadConfigurationRequest,
+  RateLimitQuotasReadConfigurationResponse,
+  RateLimitQuotasReadConfigurationError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RateLimitQuotasReadConfigurationRequest,
+  output: RateLimitQuotasReadConfigurationResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RateLimitQuotasWriteError = OpenBaoOpError;
+export const rateLimitQuotasWrite: API.OperationMethod<
+  RateLimitQuotasWriteRequest,
+  RateLimitQuotasWriteResponse,
+  RateLimitQuotasWriteError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RateLimitQuotasWriteRequest,
+  output: RateLimitQuotasWriteResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ReadRateLimitQuotasError = OpenBaoOpError;
+export const readRateLimitQuotas: API.OperationMethod<
+  ReadRateLimitQuotasRequest,
+  RateLimitQuotasReadResponse,
+  ReadRateLimitQuotasError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReadRateLimitQuotasRequest,
+  output: RateLimitQuotasReadResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));

package/src/services/raw.ts

@@ -0,0 +1,244 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-openbao, generated — see fetch-specs.ts). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as T from "../traits.ts";
+import {
+  OpenBaoProtocol,
+  type OpenBaoOpError,
+  type OpenBaoOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { OpenBaoOpError, OpenBaoOpContext };
+
+export interface DeleteRawRequest {}
+export const DeleteRawRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(T.Http({ method: "DELETE", uri: "/sys/raw", code: 200 })),
+).annotate({
+  identifier: "DeleteRawRequest",
+}) as any as S.Schema<DeleteRawRequest>;
+
+export interface DeleteRawResponse {}
+export const DeleteRawResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "DeleteRawResponse",
+}) as any as S.Schema<DeleteRawResponse>;
+
+export interface RawDeletePathRequest {
+  path: string;
+}
+export const RawDeletePathRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+  }).pipe(T.Http({ method: "DELETE", uri: "/sys/raw/{path}", code: 200 })),
+).annotate({
+  identifier: "RawDeletePathRequest",
+}) as any as S.Schema<RawDeletePathRequest>;
+
+export interface RawDeletePathResponse {}
+export const RawDeletePathResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "RawDeletePathResponse",
+}) as any as S.Schema<RawDeletePathResponse>;
+
+export interface RawReadPathRequest {
+  path: string;
+  /** Return a list if `true` */
+  list?: string;
+}
+export const RawReadPathRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+    list: S.optional(S.String.pipe(T.Query())),
+  }).pipe(T.Http({ method: "GET", uri: "/sys/raw/{path}", code: 200 })),
+).annotate({
+  identifier: "RawReadPathRequest",
+}) as any as S.Schema<RawReadPathRequest>;
+
+export interface RawReadPathResponse {
+  value?: string;
+}
+export const RawReadPathResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    value: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "RawReadPathResponse",
+}) as any as S.Schema<RawReadPathResponse>;
+
+export interface RawWriteRequest {
+  /** Optional entry to list begin listing after, not required to exist. Only used in list operations. */
+  after?: string;
+  compressed?: boolean;
+  compression_type?: string;
+  encoding?: string;
+  /** Optional number of entries to return; defaults to all entries. Only used in list operations. */
+  limit?: number;
+  path?: string;
+  value?: string;
+}
+export const RawWriteRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    after: S.optional(S.String),
+    compressed: S.optional(S.Boolean),
+    compression_type: S.optional(S.String),
+    encoding: S.optional(S.String),
+    limit: S.optional(S.Number),
+    path: S.optional(S.String),
+    value: S.optional(S.String),
+  }).pipe(T.Http({ method: "POST", uri: "/sys/raw", code: 200 })),
+).annotate({
+  identifier: "RawWriteRequest",
+}) as any as S.Schema<RawWriteRequest>;
+
+export interface RawWriteResponse {}
+export const RawWriteResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "RawWriteResponse",
+}) as any as S.Schema<RawWriteResponse>;
+
+export interface RawWritePathRequest {
+  path: string;
+  /** Optional entry to list begin listing after, not required to exist. Only used in list operations. */
+  after?: string;
+  compressed?: boolean;
+  compression_type?: string;
+  encoding?: string;
+  /** Optional number of entries to return; defaults to all entries. Only used in list operations. */
+  limit?: number;
+  value?: string;
+}
+export const RawWritePathRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+    after: S.optional(S.String),
+    compressed: S.optional(S.Boolean),
+    compression_type: S.optional(S.String),
+    encoding: S.optional(S.String),
+    limit: S.optional(S.Number),
+    value: S.optional(S.String),
+  }).pipe(T.Http({ method: "POST", uri: "/sys/raw/{path}", code: 200 })),
+).annotate({
+  identifier: "RawWritePathRequest",
+}) as any as S.Schema<RawWritePathRequest>;
+
+export interface RawWritePathResponse {}
+export const RawWritePathResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "RawWritePathResponse",
+}) as any as S.Schema<RawWritePathResponse>;
+
+export interface ReadRawRequest {
+  /** Return a list if `true` */
+  list?: string;
+}
+export const ReadRawRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    list: S.optional(S.String.pipe(T.Query())),
+  }).pipe(T.Http({ method: "GET", uri: "/sys/raw", code: 200 })),
+).annotate({ identifier: "ReadRawRequest" }) as any as S.Schema<ReadRawRequest>;
+
+export interface RawReadResponse {
+  value?: string;
+}
+export const RawReadResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    value: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "RawReadResponse",
+}) as any as S.Schema<RawReadResponse>;
+
+export type DeleteRawError = OpenBaoOpError;
+/** Delete the key with given path. */
+export const deleteRaw: API.OperationMethod<
+  DeleteRawRequest,
+  DeleteRawResponse,
+  DeleteRawError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeleteRawRequest,
+  output: DeleteRawResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RawDeletePathError = OpenBaoOpError;
+/** Delete the key with given path. */
+export const rawDeletePath: API.OperationMethod<
+  RawDeletePathRequest,
+  RawDeletePathResponse,
+  RawDeletePathError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RawDeletePathRequest,
+  output: RawDeletePathResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RawReadPathError = OpenBaoOpError;
+/** Read the value of the key at the given path. */
+export const rawReadPath: API.OperationMethod<
+  RawReadPathRequest,
+  RawReadPathResponse,
+  RawReadPathError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RawReadPathRequest,
+  output: RawReadPathResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RawWriteError = OpenBaoOpError;
+/** Update the value of the key at the given path. */
+export const rawWrite: API.OperationMethod<
+  RawWriteRequest,
+  RawWriteResponse,
+  RawWriteError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RawWriteRequest,
+  output: RawWriteResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RawWritePathError = OpenBaoOpError;
+/** Update the value of the key at the given path. */
+export const rawWritePath: API.OperationMethod<
+  RawWritePathRequest,
+  RawWritePathResponse,
+  RawWritePathError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RawWritePathRequest,
+  output: RawWritePathResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ReadRawError = OpenBaoOpError;
+/** Read the value of the key at the given path. */
+export const readRaw: API.OperationMethod<
+  ReadRawRequest,
+  RawReadResponse,
+  ReadRawError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReadRawRequest,
+  output: RawReadResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));