@homeflare/distilled-opnsense 0.2.0

package/src/services/quagga_general.ts

@@ -0,0 +1,132 @@
+// 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 interface GetRequest {}
+export const GetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/api/quagga/general/get", code: 200 }),
+  ),
+).annotate({ identifier: "GetRequest" }) as any as S.Schema<GetRequest>;
+
+export type ModelDaemons = "bfd" | "bgp" | "ospf" | "ospf6" | "rip" | "static";
+export const ModelDaemons = S.String;
+
+export type ModelProfile = "traditional" | "datacenter";
+export const ModelProfile = S.String;
+
+export type ModelSysloglevel =
+  | "critical"
+  | "emergencies"
+  | "errors"
+  | "alerts"
+  | "warnings"
+  | "notifications"
+  | "informational"
+  | "debugging";
+export const ModelSysloglevel = S.String;
+
+export interface Model {
+  /** OPNsense FieldType: BooleanField */
+  enabled: string;
+  /** OPNsense FieldType: .\EnableDaemonField; multi-select: wire value is a single comma-joined string, not a JSON array */
+  daemons?: ModelDaemons | (string & {});
+  /** OPNsense FieldType: BooleanField */
+  manual_config: string;
+  /** OPNsense FieldType: OptionField */
+  profile: ModelProfile | (string & {});
+  /** OPNsense FieldType: BooleanField */
+  enablecarp: string;
+  /** OPNsense FieldType: BooleanField */
+  enablesyslog: string;
+  /** OPNsense FieldType: BooleanField */
+  enablesnmp: string;
+  /** OPNsense FieldType: OptionField */
+  sysloglevel: ModelSysloglevel | (string & {});
+  /** OPNsense FieldType: BooleanField */
+  fwrules: string;
+}
+export const Model = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    enabled: S.String,
+    daemons: S.optional(ModelDaemons),
+    manual_config: S.String,
+    profile: ModelProfile,
+    enablecarp: S.String,
+    enablesyslog: S.String,
+    enablesnmp: S.String,
+    sysloglevel: ModelSysloglevel,
+    fwrules: S.String,
+  }),
+).annotate({ identifier: "Model" }) as any as S.Schema<Model>;
+
+export interface GetResponse {
+  general?: Model;
+}
+export const GetResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    general: S.optional(Model),
+  }),
+).annotate({ identifier: "GetResponse" }) as any as S.Schema<GetResponse>;
+
+export interface SetRequest {
+  general?: Model;
+}
+export const SetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    general: S.optional(Model),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/api/quagga/general/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 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,
+}));

package/src/services/quagga_service.ts

@@ -0,0 +1,182 @@
+// 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 interface ReconfigureRequest {}
+export const ReconfigureRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/quagga/service/reconfigure",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "ReconfigureRequest",
+}) as any as S.Schema<ReconfigureRequest>;
+
+export interface ReconfigureResponse {
+  /** "ok" — a non-ok outcome fails the call as a typed error instead. */
+  status?: string;
+}
+export const ReconfigureResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    status: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "ReconfigureResponse",
+}) as any as S.Schema<ReconfigureResponse>;
+
+export interface RestartRequest {}
+export const RestartRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "POST", uri: "/api/quagga/service/restart", code: 200 }),
+  ),
+).annotate({ identifier: "RestartRequest" }) as any as S.Schema<RestartRequest>;
+
+export interface RestartResponse {
+  /** Raw configd output. */
+  response?: string;
+}
+export const RestartResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    response: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "RestartResponse",
+}) as any as S.Schema<RestartResponse>;
+
+export interface StartRequest {}
+export const StartRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "POST", uri: "/api/quagga/service/start", code: 200 }),
+  ),
+).annotate({ identifier: "StartRequest" }) as any as S.Schema<StartRequest>;
+
+export interface StartResponse {
+  /** Raw configd output. */
+  response?: string;
+}
+export const StartResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    response: S.optional(S.String),
+  }),
+).annotate({ identifier: "StartResponse" }) as any as S.Schema<StartResponse>;
+
+export interface StatusRequest {}
+export const StatusRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/api/quagga/service/status", code: 200 }),
+  ),
+).annotate({ identifier: "StatusRequest" }) as any as S.Schema<StatusRequest>;
+
+export interface StatusResponse {
+  /** One of "running", "stopped", "disabled", "unknown". */
+  status?: string;
+}
+export const StatusResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    status: S.optional(S.String),
+  }),
+).annotate({ identifier: "StatusResponse" }) as any as S.Schema<StatusResponse>;
+
+export interface StopRequest {}
+export const StopRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "POST", uri: "/api/quagga/service/stop", code: 200 }),
+  ),
+).annotate({ identifier: "StopRequest" }) as any as S.Schema<StopRequest>;
+
+export interface StopResponse {
+  /** Raw configd output. */
+  response?: string;
+}
+export const StopResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    response: S.optional(S.String),
+  }),
+).annotate({ identifier: "StopResponse" }) as any as S.Schema<StopResponse>;
+
+export type ReconfigureError = OpnsenseOpError;
+/** Regenerate config and reload/restart as needed. */
+export const reconfigure: API.OperationMethod<
+  ReconfigureRequest,
+  ReconfigureResponse,
+  ReconfigureError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReconfigureRequest,
+  output: ReconfigureResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RestartError = OpnsenseOpError;
+/** Restart the daemon. */
+export const restart: API.OperationMethod<
+  RestartRequest,
+  RestartResponse,
+  RestartError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RestartRequest,
+  output: RestartResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type StartError = OpnsenseOpError;
+/** Start the daemon. */
+export const start: API.OperationMethod<
+  StartRequest,
+  StartResponse,
+  StartError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: StartRequest,
+  output: StartResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type StatusError = OpnsenseOpError;
+/** Current daemon status. */
+export const status: API.OperationMethod<
+  StatusRequest,
+  StatusResponse,
+  StatusError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: StatusRequest,
+  output: StatusResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type StopError = OpnsenseOpError;
+/** Stop the daemon. */
+export const stop: API.OperationMethod<
+  StopRequest,
+  StopResponse,
+  StopError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: StopRequest,
+  output: StopResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));