@homeflare/distilled-opnsense 0.2.0

package/src/services/routing_settings.ts

@@ -0,0 +1,419 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-opnsense). 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 {
+  OpnsenseProtocol,
+  type OpnsenseOpError,
+  type OpnsenseOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { OpnsenseOpError, OpnsenseOpContext };
+
+export type GatewayItemIpprotocol = "inet" | "inet6";
+export const GatewayItemIpprotocol = S.String;
+
+export interface GatewayItem {
+  /** Item id, assigned by OPNsense on creation. */
+  uuid?: string;
+  /** OPNsense FieldType: BooleanField */
+  disabled: string;
+  /** OPNsense FieldType: TextField; pattern /^[a-zA-Z0-9_\-]{1,32}$/ */
+  name: string;
+  /** OPNsense FieldType: DescriptionField */
+  descr?: string;
+  /** OPNsense FieldType: InterfaceField */
+  interface: string;
+  /** OPNsense FieldType: OptionField */
+  ipprotocol: GatewayItemIpprotocol | (string & {});
+  /** OPNsense FieldType: TextField */
+  gateway?: string;
+  /** OPNsense FieldType: BooleanField */
+  defaultgw?: string;
+  /** OPNsense FieldType: BooleanField */
+  fargw?: string;
+  /** OPNsense FieldType: BooleanField */
+  monitor_disable: string;
+  /** OPNsense FieldType: BooleanField */
+  monitor_noroute?: string;
+  /** OPNsense FieldType: BooleanField */
+  monitor_killstates?: string;
+  /** OPNsense FieldType: BooleanField */
+  monitor_killstates_priority?: string;
+  /** OPNsense FieldType: TextField */
+  monitor?: string;
+  /** OPNsense FieldType: BooleanField */
+  force_down?: string;
+  /** OPNsense FieldType: BooleanField */
+  nosync?: string;
+  /** OPNsense FieldType: IntegerField; range 0..255 (as text) */
+  priority: string;
+  /** OPNsense FieldType: IntegerField; range 1..10 (as text) */
+  weight: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  latencylow?: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  latencyhigh?: string;
+  /** OPNsense FieldType: IntegerField; range 1..99 (as text) */
+  losslow?: string;
+  /** OPNsense FieldType: IntegerField; range 1..100 (as text) */
+  losshigh?: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  interval?: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  time_period?: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  loss_interval?: string;
+  /** OPNsense FieldType: IntegerField; range 0..+inf (as text) */
+  data_length?: string;
+}
+export const GatewayItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.optional(S.String),
+    disabled: S.String,
+    name: S.String,
+    descr: S.optional(S.String),
+    interface: S.String,
+    ipprotocol: GatewayItemIpprotocol,
+    gateway: S.optional(S.String),
+    defaultgw: S.optional(S.String),
+    fargw: S.optional(S.String),
+    monitor_disable: S.String,
+    monitor_noroute: S.optional(S.String),
+    monitor_killstates: S.optional(S.String),
+    monitor_killstates_priority: S.optional(S.String),
+    monitor: S.optional(S.String),
+    force_down: S.optional(S.String),
+    nosync: S.optional(S.String),
+    priority: S.String,
+    weight: S.String,
+    latencylow: S.optional(S.String),
+    latencyhigh: S.optional(S.String),
+    losslow: S.optional(S.String),
+    losshigh: S.optional(S.String),
+    interval: S.optional(S.String),
+    time_period: S.optional(S.String),
+    loss_interval: S.optional(S.String),
+    data_length: S.optional(S.String),
+  }),
+).annotate({ identifier: "GatewayItem" }) as any as S.Schema<GatewayItem>;
+
+export interface AddGatewayRequest {
+  gateway_item?: GatewayItem;
+}
+export const AddGatewayRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    gateway_item: S.optional(GatewayItem),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/routing/settings/addGateway",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "AddGatewayRequest",
+}) as any as S.Schema<AddGatewayRequest>;
+
+export type AddGatewayResult = "saved";
+export const AddGatewayResult = S.String;
+
+export interface AddGatewayResponse {
+  result?: AddGatewayResult;
+  /** The new item's uuid. */
+  uuid?: string;
+}
+export const AddGatewayResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(AddGatewayResult),
+    uuid: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "AddGatewayResponse",
+}) as any as S.Schema<AddGatewayResponse>;
+
+export interface DelGatewayRequest {
+  uuid: string;
+}
+export const DelGatewayRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/routing/settings/delGateway/{uuid}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DelGatewayRequest",
+}) as any as S.Schema<DelGatewayRequest>;
+
+export type DelGatewayResult = "deleted" | "not found";
+export const DelGatewayResult = S.String;
+
+export interface DelGatewayResponse {
+  result?: DelGatewayResult;
+}
+export const DelGatewayResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(DelGatewayResult),
+  }),
+).annotate({
+  identifier: "DelGatewayResponse",
+}) as any as S.Schema<DelGatewayResponse>;
+
+export interface GetRequest {}
+export const GetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/api/routing/settings/get", code: 200 }),
+  ),
+).annotate({ identifier: "GetRequest" }) as any as S.Schema<GetRequest>;
+
+export type ModelGateway_itemItemIpprotocol = "inet" | "inet6";
+export const ModelGateway_itemItemIpprotocol = S.String;
+
+export interface ModelGateway_itemItem {
+  /** Item id, assigned by OPNsense on creation. */
+  uuid?: string;
+  /** OPNsense FieldType: BooleanField */
+  disabled: string;
+  /** OPNsense FieldType: TextField; pattern /^[a-zA-Z0-9_\-]{1,32}$/ */
+  name: string;
+  /** OPNsense FieldType: DescriptionField */
+  descr?: string;
+  /** OPNsense FieldType: InterfaceField */
+  interface: string;
+  /** OPNsense FieldType: OptionField */
+  ipprotocol: ModelGateway_itemItemIpprotocol | (string & {});
+  /** OPNsense FieldType: TextField */
+  gateway?: string;
+  /** OPNsense FieldType: BooleanField */
+  defaultgw?: string;
+  /** OPNsense FieldType: BooleanField */
+  fargw?: string;
+  /** OPNsense FieldType: BooleanField */
+  monitor_disable: string;
+  /** OPNsense FieldType: BooleanField */
+  monitor_noroute?: string;
+  /** OPNsense FieldType: BooleanField */
+  monitor_killstates?: string;
+  /** OPNsense FieldType: BooleanField */
+  monitor_killstates_priority?: string;
+  /** OPNsense FieldType: TextField */
+  monitor?: string;
+  /** OPNsense FieldType: BooleanField */
+  force_down?: string;
+  /** OPNsense FieldType: BooleanField */
+  nosync?: string;
+  /** OPNsense FieldType: IntegerField; range 0..255 (as text) */
+  priority: string;
+  /** OPNsense FieldType: IntegerField; range 1..10 (as text) */
+  weight: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  latencylow?: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  latencyhigh?: string;
+  /** OPNsense FieldType: IntegerField; range 1..99 (as text) */
+  losslow?: string;
+  /** OPNsense FieldType: IntegerField; range 1..100 (as text) */
+  losshigh?: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  interval?: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  time_period?: string;
+  /** OPNsense FieldType: IntegerField; range 1..+inf (as text) */
+  loss_interval?: string;
+  /** OPNsense FieldType: IntegerField; range 0..+inf (as text) */
+  data_length?: string;
+}
+export const ModelGateway_itemItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.optional(S.String),
+    disabled: S.String,
+    name: S.String,
+    descr: S.optional(S.String),
+    interface: S.String,
+    ipprotocol: ModelGateway_itemItemIpprotocol,
+    gateway: S.optional(S.String),
+    defaultgw: S.optional(S.String),
+    fargw: S.optional(S.String),
+    monitor_disable: S.String,
+    monitor_noroute: S.optional(S.String),
+    monitor_killstates: S.optional(S.String),
+    monitor_killstates_priority: S.optional(S.String),
+    monitor: S.optional(S.String),
+    force_down: S.optional(S.String),
+    nosync: S.optional(S.String),
+    priority: S.String,
+    weight: S.String,
+    latencylow: S.optional(S.String),
+    latencyhigh: S.optional(S.String),
+    losslow: S.optional(S.String),
+    losshigh: S.optional(S.String),
+    interval: S.optional(S.String),
+    time_period: S.optional(S.String),
+    loss_interval: S.optional(S.String),
+    data_length: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "ModelGateway_itemItem",
+}) as any as S.Schema<ModelGateway_itemItem>;
+
+export type ModelGateway_itemItemMap = {
+  [key: string]: ModelGateway_itemItem | undefined;
+};
+export const ModelGateway_itemItemMap = /*@__PURE__*/ S.Record(
+  S.String,
+  ModelGateway_itemItem,
+) as any as S.Schema<ModelGateway_itemItemMap>;
+
+export interface Model {
+  gateway_item?: ModelGateway_itemItemMap;
+}
+export const Model = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    gateway_item: S.optional(ModelGateway_itemItemMap),
+  }),
+).annotate({ identifier: "Model" }) as any as S.Schema<Model>;
+
+export interface GetResponse {
+  gateways?: Model;
+}
+export const GetResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    gateways: S.optional(Model),
+  }),
+).annotate({ identifier: "GetResponse" }) as any as S.Schema<GetResponse>;
+
+export interface SetRequest {
+  gateways?: Model;
+}
+export const SetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    gateways: S.optional(Model),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/api/routing/settings/set", code: 200 }),
+  ),
+).annotate({ identifier: "SetRequest" }) as any as S.Schema<SetRequest>;
+
+export type SetResult = "saved";
+export const SetResult = S.String;
+
+export interface SetResponse {
+  result?: SetResult;
+}
+export const SetResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(SetResult),
+  }),
+).annotate({ identifier: "SetResponse" }) as any as S.Schema<SetResponse>;
+
+export interface SetGatewayRequest {
+  uuid: string;
+  gateway_item?: GatewayItem;
+}
+export const SetGatewayRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.String.pipe(T.Label()),
+    gateway_item: S.optional(GatewayItem),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/routing/settings/setGateway/{uuid}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "SetGatewayRequest",
+}) as any as S.Schema<SetGatewayRequest>;
+
+export type SetGatewayResult = "saved";
+export const SetGatewayResult = S.String;
+
+export interface SetGatewayResponse {
+  result?: SetGatewayResult;
+}
+export const SetGatewayResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(SetGatewayResult),
+  }),
+).annotate({
+  identifier: "SetGatewayResponse",
+}) as any as S.Schema<SetGatewayResponse>;
+
+export type AddGatewayError = OpnsenseOpError;
+/** Add a new gateway_item item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const addGateway: API.OperationMethod<
+  AddGatewayRequest,
+  AddGatewayResponse,
+  AddGatewayError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AddGatewayRequest,
+  output: AddGatewayResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DelGatewayError = OpnsenseOpError;
+/** Delete a gateway_item item by uuid. */
+export const delGateway: API.OperationMethod<
+  DelGatewayRequest,
+  DelGatewayResponse,
+  DelGatewayError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DelGatewayRequest,
+  output: DelGatewayResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetError = OpnsenseOpError;
+/** Fetch the entire model tree (every section and array collection). */
+export const get: API.OperationMethod<
+  GetRequest,
+  GetResponse,
+  GetError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetRequest,
+  output: GetResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SetError = OpnsenseOpError;
+/** Replace the entire model tree in one call. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const set: API.OperationMethod<
+  SetRequest,
+  SetResponse,
+  SetError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SetRequest,
+  output: SetResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SetGatewayError = OpnsenseOpError;
+/** Update an existing gateway_item item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const setGateway: API.OperationMethod<
+  SetGatewayRequest,
+  SetGatewayResponse,
+  SetGatewayError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SetGatewayRequest,
+  output: SetGatewayResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));

package/src/traits.ts

@@ -0,0 +1,36 @@
+/**
+ * OPNsense SDK trait surface — hand-written.
+ *
+ * Re-exports the generic protocol traits from core so generated operations
+ * import everything from one place. OPNsense's request/response shapes need
+ * nothing beyond the generic label/query/header/body bindings `protocol.ts`
+ * already builds on — no sensitive-value wrapping, no bare-array responses,
+ * no provider-specific traits.
+ */
+export {
+  Body,
+  Header,
+  Query,
+  Label,
+  Http,
+  ResponseCode,
+  HttpBody,
+  FormDataFile,
+  KeyDictionary,
+  UnionCases,
+  applyErrorMatchers,
+  getErrorMatchers,
+  type HttpTrait,
+  type ErrorMatcher,
+  bodySymbol,
+  headerSymbol,
+  querySymbol,
+  labelSymbol,
+  httpSymbol,
+  responseCodeSymbol,
+  httpBodySymbol,
+  formDataFileSymbol,
+  keyDictionarySymbol,
+  unionCasesSymbol,
+  errorMatchersSymbol,
+} from "@distilled.cloud/core/trait";