@homeflare/distilled-opnsense 0.2.0

package/dist/services/routing_settings.js

@@ -0,0 +1,169 @@
+// 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.js";
+import { OpnsenseProtocol, } from "../protocol.js";
+import * as Retry from "../retry.js";
+export const GatewayItemIpprotocol = S.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" });
+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",
+});
+export const AddGatewayResult = S.String;
+export const AddGatewayResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
+    result: S.optional(AddGatewayResult),
+    uuid: S.optional(S.String),
+})).annotate({
+    identifier: "AddGatewayResponse",
+});
+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",
+});
+export const DelGatewayResult = S.String;
+export const DelGatewayResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
+    result: S.optional(DelGatewayResult),
+})).annotate({
+    identifier: "DelGatewayResponse",
+});
+export const GetRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/api/routing/settings/get", code: 200 }))).annotate({ identifier: "GetRequest" });
+export const ModelGateway_itemItemIpprotocol = S.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",
+});
+export const ModelGateway_itemItemMap = /*@__PURE__*/ S.Record(S.String, ModelGateway_itemItem);
+export const Model = /*@__PURE__*/ S.suspend(() => S.Struct({
+    gateway_item: S.optional(ModelGateway_itemItemMap),
+})).annotate({ identifier: "Model" });
+export const GetResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
+    gateways: S.optional(Model),
+})).annotate({ identifier: "GetResponse" });
+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" });
+export const SetResult = S.String;
+export const SetResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
+    result: S.optional(SetResult),
+})).annotate({ identifier: "SetResponse" });
+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",
+});
+export const SetGatewayResult = S.String;
+export const SetGatewayResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
+    result: S.optional(SetGatewayResult),
+})).annotate({
+    identifier: "SetGatewayResponse",
+});
+/** Add a new gateway_item item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const addGateway = /*@__PURE__*/ API.make(() => ({
+    input: AddGatewayRequest,
+    output: AddGatewayResponse,
+    errors: [],
+    protocol: OpnsenseProtocol,
+    retry: Retry.Retry,
+}));
+/** Delete a gateway_item item by uuid. */
+export const delGateway = /*@__PURE__*/ API.make(() => ({
+    input: DelGatewayRequest,
+    output: DelGatewayResponse,
+    errors: [],
+    protocol: OpnsenseProtocol,
+    retry: Retry.Retry,
+}));
+/** Fetch the entire model tree (every section and array collection). */
+export const get = /*@__PURE__*/ API.make(() => ({
+    input: GetRequest,
+    output: GetResponse,
+    errors: [],
+    protocol: OpnsenseProtocol,
+    retry: Retry.Retry,
+}));
+/** 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 = /*@__PURE__*/ API.make(() => ({
+    input: SetRequest,
+    output: SetResponse,
+    errors: [],
+    protocol: OpnsenseProtocol,
+    retry: Retry.Retry,
+}));
+/** Update an existing gateway_item item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const setGateway = /*@__PURE__*/ API.make(() => ({
+    input: SetGatewayRequest,
+    output: SetGatewayResponse,
+    errors: [],
+    protocol: OpnsenseProtocol,
+    retry: Retry.Retry,
+}));
+//# sourceMappingURL=routing_settings.js.map

package/dist/services/routing_settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing_settings.js","sourceRoot":"","sources":["../../src/services/routing_settings.ts"],"names":[],"mappings":"AAAA,yGAAyG;AACzG,OAAO,KAAK,CAAC,MAAM,8BAA8B,CAAC;AAClD,OAAO,KAAK,GAAG,MAAM,2BAA2B,CAAC;AACjD,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,EACL,gBAAgB,GAGjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,KAAK,MAAM,aAAa,CAAC;AAKrC,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;AAwD9C,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CACtD,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC1B,QAAQ,EAAE,CAAC,CAAC,MAAM;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM;IACd,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,UAAU,EAAE,qBAAqB;IACjC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7B,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC/B,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3B,eAAe,EAAE,CAAC,CAAC,MAAM;IACzB,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACrC,kBAAkB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACxC,2BAA2B,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7B,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC5B,QAAQ,EAAE,CAAC,CAAC,MAAM;IAClB,MAAM,EAAE,CAAC,CAAC,MAAM;IAChB,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAChC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7B,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC9B,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC9B,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACjC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACnC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;CAClC,CAAC,CACH,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,CAAiC,CAAC;AAK1E,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAC5D,CAAC,CAAC,MAAM,CAAC;IACP,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;CACtC,CAAC,CAAC,IAAI,CACL,CAAC,CAAC,IAAI,CAAC;IACL,MAAM,EAAE,MAAM;IACd,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,GAAG;CACV,CAAC,CACH,CACF,CAAC,QAAQ,CAAC;IACT,UAAU,EAAE,mBAAmB;CAChC,CAAuC,CAAC;AAGzC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;AAOzC,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAC7D,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACpC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;CAC3B,CAAC,CACH,CAAC,QAAQ,CAAC;IACT,UAAU,EAAE,oBAAoB;CACjC,CAAwC,CAAC;AAK1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAC5D,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;CAC/B,CAAC,CAAC,IAAI,CACL,CAAC,CAAC,IAAI,CAAC;IACL,MAAM,EAAE,MAAM;IACd,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,GAAG;CACV,CAAC,CACH,CACF,CAAC,QAAQ,CAAC;IACT,UAAU,EAAE,mBAAmB;CAChC,CAAuC,CAAC;AAGzC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;AAKzC,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAC7D,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;CACrC,CAAC,CACH,CAAC,QAAQ,CAAC;IACT,UAAU,EAAE,oBAAoB;CACjC,CAAwC,CAAC;AAG1C,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CACrD,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,2BAA2B,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CACvE,CACF,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,YAAY,EAAE,CAAgC,CAAC;AAGxE,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;AAwDxD,MAAM,CAAC,MAAM,qBAAqB,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAChE,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC1B,QAAQ,EAAE,CAAC,CAAC,MAAM;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM;IACd,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,UAAU,EAAE,+BAA+B;IAC3C,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7B,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC/B,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3B,eAAe,EAAE,CAAC,CAAC,MAAM;IACzB,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACrC,kBAAkB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACxC,2BAA2B,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7B,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC5B,QAAQ,EAAE,CAAC,CAAC,MAAM;IAClB,MAAM,EAAE,CAAC,CAAC,MAAM;IAChB,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAChC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7B,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC9B,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAC9B,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACjC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACnC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;CAClC,CAAC,CACH,CAAC,QAAQ,CAAC;IACT,UAAU,EAAE,uBAAuB;CACpC,CAA2C,CAAC;AAK7C,MAAM,CAAC,MAAM,wBAAwB,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAC5D,CAAC,CAAC,MAAM,EACR,qBAAqB,CACuB,CAAC;AAK/C,MAAM,CAAC,MAAM,KAAK,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAChD,CAAC,CAAC,MAAM,CAAC;IACP,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC;CACnD,CAAC,CACH,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,CAA2B,CAAC;AAK9D,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CACtD,CAAC,CAAC,MAAM,CAAC;IACP,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;CAC5B,CAAC,CACH,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,CAAiC,CAAC;AAK1E,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CACrD,CAAC,CAAC,MAAM,CAAC;IACP,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;CAC5B,CAAC,CAAC,IAAI,CACL,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,2BAA2B,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CACxE,CACF,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,YAAY,EAAE,CAAgC,CAAC;AAGxE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;AAKlC,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CACtD,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;CAC9B,CAAC,CACH,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,CAAiC,CAAC;AAM1E,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAC5D,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAC9B,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;CACtC,CAAC,CAAC,IAAI,CACL,CAAC,CAAC,IAAI,CAAC;IACL,MAAM,EAAE,MAAM;IACd,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,GAAG;CACV,CAAC,CACH,CACF,CAAC,QAAQ,CAAC;IACT,UAAU,EAAE,mBAAmB;CAChC,CAAuC,CAAC;AAGzC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;AAKzC,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAC7D,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;CACrC,CAAC,CACH,CAAC,QAAQ,CAAC;IACT,UAAU,EAAE,oBAAoB;CACjC,CAAwC,CAAC;AAG1C,mIAAmI;AACnI,MAAM,CAAC,MAAM,UAAU,GAKnB,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAChC,KAAK,EAAE,iBAAiB;IACxB,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,gBAAgB;IAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;CACnB,CAAC,CAAC,CAAC;AAGJ,0CAA0C;AAC1C,MAAM,CAAC,MAAM,UAAU,GAKnB,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAChC,KAAK,EAAE,iBAAiB;IACxB,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,gBAAgB;IAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;CACnB,CAAC,CAAC,CAAC;AAGJ,wEAAwE;AACxE,MAAM,CAAC,MAAM,GAAG,GAKZ,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAChC,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,gBAAgB;IAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;CACnB,CAAC,CAAC,CAAC;AAGJ,iJAAiJ;AACjJ,MAAM,CAAC,MAAM,GAAG,GAKZ,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAChC,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,gBAAgB;IAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;CACnB,CAAC,CAAC,CAAC;AAGJ,4IAA4I;AAC5I,MAAM,CAAC,MAAM,UAAU,GAKnB,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAChC,KAAK,EAAE,iBAAiB;IACxB,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,gBAAgB;IAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;CACnB,CAAC,CAAC,CAAC"}

package/dist/traits.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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";
+//# sourceMappingURL=traits.d.ts.map

package/dist/traits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traits.d.ts","sourceRoot":"","sources":["../src/traits.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EACL,IAAI,EACJ,MAAM,EACN,KAAK,EACL,KAAK,EACL,IAAI,EACJ,YAAY,EACZ,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,UAAU,EACV,YAAY,EACZ,WAAW,EACX,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,6BAA6B,CAAC"}

package/dist/traits.js

@@ -0,0 +1,11 @@
+/**
+ * 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, bodySymbol, headerSymbol, querySymbol, labelSymbol, httpSymbol, responseCodeSymbol, httpBodySymbol, formDataFileSymbol, keyDictionarySymbol, unionCasesSymbol, errorMatchersSymbol, } from "@distilled.cloud/core/trait";
+//# sourceMappingURL=traits.js.map

package/dist/traits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traits.js","sourceRoot":"","sources":["../src/traits.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EACL,IAAI,EACJ,MAAM,EACN,KAAK,EACL,KAAK,EACL,IAAI,EACJ,YAAY,EACZ,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAGhB,UAAU,EACV,YAAY,EACZ,WAAW,EACX,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,6BAA6B,CAAC"}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@homeflare/distilled-opnsense",
+  "version": "0.2.0",
+  "description": "Interim npm home for @distilled.cloud/opnsense — see docs/distilled-interim.md. Not published upstream yet; the kit aliases @distilled.cloud/opnsense onto this package until it is.",
+  "homepage": "https://github.com/taslabs-net/homeflare-kit/tree/main/packages/distilled-opnsense#readme",
+  "bugs": "https://github.com/taslabs-net/homeflare-kit/issues",
+  "license": "Apache-2.0",
+  "author": "Timothy Schneider",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/taslabs-net/homeflare-kit.git",
+    "directory": "packages/distilled-opnsense"
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "bun": "./src/index.ts",
+      "worker": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./Credentials": {
+      "types": "./dist/credentials.d.ts",
+      "bun": "./src/credentials.ts",
+      "worker": "./src/credentials.ts",
+      "default": "./dist/credentials.js"
+    },
+    "./Errors": {
+      "types": "./dist/errors.d.ts",
+      "bun": "./src/errors.ts",
+      "worker": "./src/errors.ts",
+      "default": "./dist/errors.js"
+    },
+    "./Traits": {
+      "types": "./dist/traits.d.ts",
+      "bun": "./src/traits.ts",
+      "worker": "./src/traits.ts",
+      "default": "./dist/traits.js"
+    },
+    "./Protocol": {
+      "types": "./dist/protocol.d.ts",
+      "bun": "./src/protocol.ts",
+      "worker": "./src/protocol.ts",
+      "default": "./dist/protocol.js"
+    },
+    "./Retry": {
+      "types": "./dist/retry.d.ts",
+      "bun": "./src/retry.ts",
+      "worker": "./src/retry.ts",
+      "default": "./dist/retry.js"
+    },
+    "./*": {
+      "types": "./dist/services/*.d.ts",
+      "bun": "./src/services/*.ts",
+      "worker": "./src/services/*.ts",
+      "default": "./dist/services/*.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@distilled.cloud/core": "1.0.0-rc.12"
+  },
+  "peerDependencies": {
+    "effect": "4.0.0-rc.115"
+  }
+}

package/src/credentials.ts

@@ -0,0 +1,111 @@
+/**
+ * OPNsense credentials — hand-written.
+ *
+ * OPNsense authenticates its `/api/*` surface with a key/secret pair sent
+ * as HTTP Basic auth: `Authorization: Basic base64(key:secret)` — verified
+ * both in source (`ApiControllerBase::beforeExecuteRoute`, mirrored at
+ * `specs/core/models/Base/ApiControllerBase.php`: it splits the decoded
+ * Basic-auth payload on `:` into `apiKey`/`apiSecret`, and works with ANY
+ * scheme word before the base64 blob, not just literally `Basic`) and in
+ * the vendor's own docs (`opnsense/docs`, `source/development/how-tos/
+ * api.rst`: a `curl -u <api-key>:<api-secret>` example against `.../api/...`,
+ * and the Python sample's `requests.get(..., auth=(api_key, api_secret))` — `requests`'
+ * `auth=` tuple IS HTTP Basic). The secret is generated once per key in the
+ * user manager and cannot be re-downloaded, so it is credential-shaped, not
+ * password-shaped — `Redacted` like a token, never compared or logged.
+ *
+ * Self-hosted, like Forgejo: there is no default host, so the edge/router's
+ * origin is part of the credential, not a hardcoded base URL.
+ */
+import * as EffectConfig from "effect/Config";
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+import { ConfigError } from "@distilled.cloud/core/errors";
+
+/**
+ * OPNsense's own path prefix; every generated route's `T.Http({ uri })`
+ * already carries it (e.g. `/api/quagga/general/get` — see any
+ * `src/services/*.ts`), because it is the vendor's own real wire path, not
+ * an artifact of this converter. `buildRequest` in
+ * `@distilled.cloud/core/protocol-http` concatenates `baseUrl + uri`
+ * verbatim with no de-duplication, so `apiBaseUrl` MUST be the bare origin
+ * — appending `API_PATH` here as well produced a real, smoke-test-caught
+ * `/api/api/...` request (see `../scripts/smoke.ts` and
+ * `../README.md`'s "Known limitations"). `normalizeBaseUrl` therefore
+ * STRIPS a trailing `/api` a caller may have included (the doc comment on
+ * `Config.apiBaseUrl` below used to invite exactly that input), rather than
+ * adding one.
+ */
+export const API_PATH = "/api";
+
+/** Normalize an OPNsense origin (or an already-complete `/api` root, accepted for caller convenience) down to the bare origin every generated route's own `uri` already assumes. */
+export const normalizeBaseUrl = (baseUrl: string): string => {
+  // A loop, not a trailing-slash regex: that backtracks polynomially on a long
+  // run of "/" (CodeQL js/polynomial-redos), the same fix as distilled-netbox's.
+  let end = baseUrl.length;
+  while (end > 0 && baseUrl.charCodeAt(end - 1) === 47) end--;
+  const trimmed = baseUrl.slice(0, end);
+  return trimmed.endsWith(API_PATH)
+    ? trimmed.slice(0, -API_PATH.length)
+    : trimmed;
+};
+
+export interface Config {
+  readonly apiKey: string;
+  readonly apiSecret: Redacted.Redacted<string>;
+  /** Bare origin, e.g. `https://edge.homeflare.dev` or `https://10.20.10.1` — a trailing `/api` is accepted and stripped, never doubled with a route's own `/api/...` prefix. */
+  readonly apiBaseUrl: string;
+}
+
+export class Credentials extends Context.Service<
+  Credentials,
+  Effect.Effect<Config>
+>()("OpnsenseCredentials") {}
+
+const envConfig = EffectConfig.all({
+  // No vendor-standard env var names exist for OPNsense's API (unlike
+  // Forgejo's own `FORGEJO_URL`/`FORGEJO_TOKEN`) — these follow this SDK's
+  // own naming.
+  apiKey: EffectConfig.String("OPNSENSE_API_KEY"),
+  apiSecret: EffectConfig.String("OPNSENSE_API_SECRET"),
+  baseUrl: EffectConfig.String("OPNSENSE_URL"),
+});
+
+export const CredentialsFromEnv = Layer.succeed(
+  Credentials,
+  envConfig.pipe(
+    Effect.mapError(
+      () =>
+        new ConfigError({
+          message:
+            "OPNSENSE_URL, OPNSENSE_API_KEY and OPNSENSE_API_SECRET environment variables are required",
+        }),
+    ),
+    Effect.map(({ apiKey, apiSecret, baseUrl }) => ({
+      apiKey,
+      apiSecret: Redacted.make(apiSecret),
+      apiBaseUrl: normalizeBaseUrl(baseUrl),
+    })),
+    Effect.orDie,
+  ),
+);
+
+/** Convenience layer from a plain key/secret and the box's origin (or API root). */
+export const credentials = (config: {
+  readonly apiKey: string;
+  readonly apiSecret: string | Redacted.Redacted<string>;
+  readonly baseUrl: string;
+}): Layer.Layer<Credentials> =>
+  Layer.succeed(
+    Credentials,
+    Effect.succeed({
+      apiKey: config.apiKey,
+      apiSecret:
+        typeof config.apiSecret === "string"
+          ? Redacted.make(config.apiSecret)
+          : config.apiSecret,
+      apiBaseUrl: normalizeBaseUrl(config.baseUrl),
+    }),
+  );

package/src/errors.ts

@@ -0,0 +1,115 @@
+/**
+ * OPNsense-specific error types — hand-written.
+ *
+ * OPNsense is a 200-with-failure vendor (see `protocol.ts`'s module doc):
+ * most of what a caller needs to `catchTag` on never reaches an HTTP error
+ * status at all. This module's classes are read directly off
+ * `src/opnsense/www/api.php` (the `/api/*` front controller — mirrored at
+ * `specs/core/models/Base/` is the controller CONTRACT those bodies come
+ * from; `api.php` itself is not mirrored, since it is not model/controller
+ * source the converter reads, but its four `catch` clauses are exactly the
+ * four non-2xx/vendor-exception shapes below):
+ *
+ *   catch UserException            → getHttpCode() (500 unless a subclass
+ *                                     overrides it) + {errorMessage,
+ *                                     errorTitle, errorLevel} — a real
+ *                                     business-rule denial (Alias/Category/
+ *                                     Group's "in use" checks, Filter's
+ *                                     "cannot move" checks), NOT a server
+ *                                     fault: never retried.
+ *   catch DispatchException        → 404 {errorMessage} (route/controller/
+ *                                     action not found — e.g. a plugin
+ *                                     module that isn't installed).
+ *   catch Error|Exception          → 500 {errorMessage: "Unexpected error,
+ *                                     check log for details"} (a PHP fault).
+ *   (not sent)                     → the ORIGINAL response, when none of
+ *                                     the above threw — this is everything
+ *                                     else: the 401/403/400 auth/CSRF/JSON
+ *                                     shapes from `ApiControllerBase::before
+ *                                     ExecuteRoute` ({status:<code>,
+ *                                     message}, `status` a NUMBER — do not
+ *                                     confuse with the unrelated string
+ *                                     `status` OPNsense's OWN operations
+ *                                     return, e.g. service status/
+ *                                     reconfigure) and the 200
+ *                                     `{result:"failed", validations?}`
+ *                                     shape every `ApiMutableModelController
+ *                                     Base` mutation can answer with.
+ */
+import * as Schema from "effect/Schema";
+import * as Category from "@distilled.cloud/core/category";
+import {
+  ConfigError,
+  Unauthorized,
+  Forbidden,
+  BadRequest,
+  NotFound,
+  InternalServerError,
+} from "@distilled.cloud/core/errors";
+export {
+  ConfigError,
+  Unauthorized,
+  Forbidden,
+  BadRequest,
+  NotFound,
+  InternalServerError,
+};
+
+/** `{"result":"failed", validations?: {...}}` from `ApiMutableModelControllerBase::validate()`/`setBase`/`addBase`/`delBase`/`toggleBase` — always HTTP 200. `validations` is absent for a non-field failure (bad uuid, wrong verb); present and keyed `<prefix>.<field>` → one message or several for a real field error. */
+export class ValidationFailed extends Schema.TaggedError<ValidationFailed>()(
+  "ValidationFailed",
+  {
+    validations: Schema.Record(
+      Schema.String,
+      Schema.Union([Schema.String, Schema.Array(Schema.String)]),
+    ),
+  },
+).pipe(Category.withBadRequestError) {}
+
+/** A plain `UserException` (`errorLevel: "error"`, default HTTP 500) — a business-rule denial such as "Alias in use" or "cannot move to the same spot", not a server fault: `Category.withBadRequestError`, never retried. */
+export class OpnsenseUserError extends Schema.TaggedError<OpnsenseUserError>()(
+  "OpnsenseUserError",
+  { title: Schema.optional(Schema.String), message: Schema.String },
+).pipe(Category.withBadRequestError) {}
+
+/** A `UserWarningException` — HTTP 200, but the request did NOT do what was asked (`UserWarningException::getHttpCode()` is hard-coded 200). */
+export class OpnsenseUserWarning extends Schema.TaggedError<OpnsenseUserWarning>()(
+  "OpnsenseUserWarning",
+  { title: Schema.optional(Schema.String), message: Schema.String },
+).pipe(Category.withBadRequestError) {}
+
+/** A `UserInformationalException` — HTTP 200, an informational abort (e.g. "nothing to do"). */
+export class OpnsenseUserNotice extends Schema.TaggedError<OpnsenseUserNotice>()(
+  "OpnsenseUserNotice",
+  { title: Schema.optional(Schema.String), message: Schema.String },
+).pipe(Category.withBadRequestError) {}
+
+/** Unmapped failure — a response this SDK's protocol layer could not classify into any of the above (non-JSON body, a shape none of the known cases match). Carries the raw body for later cataloging. */
+export class UnknownOpnsenseError extends Schema.TaggedError<UnknownOpnsenseError>()(
+  "UnknownOpnsenseError",
+  { status: Schema.Number, body: Schema.Unknown },
+).pipe(Category.withServerError) {}
+
+/** Schema parse error wrapper. */
+export class OpnsenseParseError extends Schema.TaggedError<OpnsenseParseError>()(
+  "OpnsenseParseError",
+  { body: Schema.Unknown, cause: Schema.Unknown },
+).pipe(Category.withParseError) {}
+
+export type ClientErrors =
+  | ValidationFailed
+  | OpnsenseUserError
+  | OpnsenseUserWarning
+  | OpnsenseUserNotice
+  | UnknownOpnsenseError
+  | OpnsenseParseError;
+
+/** Default errors every generated OPNsense operation carries — see the module doc for where each one comes from. */
+export type DefaultErrors =
+  | Unauthorized
+  | Forbidden
+  | BadRequest
+  | NotFound
+  | InternalServerError
+  | ConfigError
+  | ClientErrors;

package/src/index.ts

@@ -0,0 +1,32 @@
+/**
+ * @distilled.cloud/opnsense — OPNsense firewall API SDK for Effect.
+ *
+ * `./services` is generated by `scripts/generate.ts` from the Smithy models
+ * in `.generated-specs` (written by `scripts/convert.ts` from OPNsense's own
+ * model XML + API controller PHP, mirrored under `specs/`). Everything else
+ * in this folder is hand-written.
+ *
+ * One module per API controller in scope — `firewall_alias`,
+ * `firewall_category`, `firewall_group`, `firewall_filter`,
+ * `routing_settings`, `quagga_general`, `quagga_bgp`, `quagga_service` — see
+ * the package README for what each one covers and what was left out.
+ *
+ * @example
+ * ```ts
+ * import * as Opnsense from "@distilled.cloud/opnsense";
+ *
+ * const alias = yield* Opnsense.Services.firewall_alias.addAlias({
+ *   alias: { name: "homeflare_edge", type: "host", content: "10.20.10.1" },
+ * });
+ * ```
+ */
+export * from "./credentials.ts";
+export * from "./errors.ts";
+export * as T from "./traits.ts";
+export {
+  OpnsenseProtocol,
+  type OpnsenseOpError,
+  type OpnsenseOpContext,
+} from "./protocol.ts";
+export * as Retry from "./retry.ts";
+export * as Services from "./services/index.ts";