the-moby-effect 1.45.0-alpha.2 → 1.45.0-alpha.21

package/src/schemas/Int8.ts

@@ -0,0 +1,45 @@
+/**
+ * 8bit signed integer schema.
+ *
+ * @since 1.0.0
+ */
+
+import * as Brand from "effect/Brand";
+import * as Function from "effect/Function";
+import * as Schema from "effect/Schema";
+
+/**
+ * @since 1.0.0
+ * @category Branded types
+ */
+export type Int8Brand = number & Brand.Brand<"Int8">;
+
+/**
+ * @since 1.0.0
+ * @category Branded constructors
+ */
+export const Int8Brand: Brand.Brand.Constructor<Int8Brand> = Brand.nominal<Int8Brand>();
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $Int8 extends Schema.Annotable<$Int8, Int8Brand, Brand.Brand.Unbranded<Int8Brand>, never> {}
+
+/**
+ * 8bit signed integer.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const Int8: $Int8 = Function.pipe(
+    Schema.Int,
+    Schema.greaterThanOrEqualTo(-(2 ** 7)),
+    Schema.lessThanOrEqualTo(2 ** 7 - 1),
+    Schema.fromBrand(Int8Brand),
+    Schema.annotations({
+        identifier: "Int8",
+        title: "8-bit signed integer",
+        description: "An 8-bit signed integer.",
+    })
+);

package/src/schemas/Mac.ts

@@ -0,0 +1,52 @@
+/**
+ * Mac Address schema.
+ *
+ * @since 1.0.0
+ */
+
+import * as Brand from "effect/Brand";
+import * as Function from "effect/Function";
+import * as Schema from "effect/Schema";
+
+/**
+ * @since 1.0.0
+ * @category Regular expressions
+ * @see https://stackoverflow.com/questions/4260467/what-is-a-regular-expression-for-a-mac-address
+ */
+export const MacAddressRegex = new RegExp("^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$");
+
+/**
+ * @since 1.0.0
+ * @category Branded types
+ */
+export type MacAddressBrand = string & Brand.Brand<"MacAddress">;
+
+/**
+ * @since 1.0.0
+ * @category Branded constructors
+ */
+export const MacAddressBrand = Brand.nominal<MacAddressBrand>();
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface MacAddress
+    extends Schema.Annotable<MacAddress, MacAddressBrand, Brand.Brand.Unbranded<MacAddressBrand>, never> {}
+
+/**
+ * A Mac Address.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const MacAddress: MacAddress = Function.pipe(
+    Schema.String,
+    Schema.pattern(MacAddressRegex),
+    Schema.fromBrand(MacAddressBrand),
+    Schema.annotations({
+        identifier: "MacAddress",
+        title: "A MacAddress",
+        description: "A network interface's MacAddress",
+    })
+);

package/src/schemas/Port.ts

@@ -0,0 +1,158 @@
+/**
+ * Operating system port schema.
+ *
+ * @since 1.0.0
+ */
+
+import * as Brand from "effect/Brand";
+import * as Function from "effect/Function";
+import * as Schema from "effect/Schema";
+
+/**
+ * @since 1.0.0
+ * @category Branded types
+ */
+export type PortBrand = number & Brand.Brand<"Port">;
+
+/**
+ * @since 1.0.0
+ * @category Branded constructors
+ */
+export const PortBrand = Brand.nominal<PortBrand>();
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $Port extends Schema.Annotable<$Port, PortBrand, Brand.Brand.Unbranded<PortBrand>, never> {}
+
+/**
+ * An operating system port number.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ * @example
+ *     import * as Schema from "effect/Schema";
+ *     import { Port } from "the-moby-effect/schemas/index.js";
+ *
+ *     const decodePort = Schema.decodeSync(Port);
+ *     assert.strictEqual(decodePort(8080), 8080);
+ *
+ *     assert.throws(() => decodePort(65536));
+ *     assert.doesNotThrow(() => decodePort(8080));
+ */
+export const Port: $Port = Function.pipe(
+    Schema.Int,
+    Schema.between(0, 2 ** 16 - 1),
+    Schema.fromBrand(PortBrand),
+    Schema.annotations({
+        identifier: "Port",
+        title: "An OS port number",
+        description: "An operating system's port number between 0 and 65535 (inclusive)",
+    })
+);
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $PortWithMaybeProtocol
+    extends Schema.Union<
+        [
+            Schema.TemplateLiteral<`${number}`>,
+            Schema.TemplateLiteral<`${number}/tcp`>,
+            Schema.TemplateLiteral<`${number}/udp`>,
+        ]
+    > {}
+
+/**
+ * An operating system port number with an optional protocol.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const PortWithMaybeProtocol: $PortWithMaybeProtocol = Schema.Union(
+    Schema.TemplateLiteral(Schema.Number),
+    Schema.TemplateLiteral(Schema.Number, "/", Schema.Literal("tcp")),
+    Schema.TemplateLiteral(Schema.Number, "/", Schema.Literal("udp"))
+).annotations({
+    identifier: "PortWithMaybeProtocol",
+    title: "An OS port number with an optional protocol",
+    description: "An operating system's port number with an optional protocol",
+});
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $PortSet extends Schema.Record$<$PortWithMaybeProtocol, typeof Schema.Object> {}
+
+/**
+ * A set of operating system ports.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ * @see https://github.com/docker/go-connections/blob/5df8d2b30ca886f2d94740ce3c54abd58a5bb2c9/nat/nat.go#L23
+ */
+export const PortSet: $PortSet = Schema.Record({
+    key: PortWithMaybeProtocol,
+    // FIXME: What is this type?
+    value: Schema.Object,
+}).annotations({
+    identifier: "PortSet",
+    title: "A set of OS ports",
+    description: "A set of operating system ports",
+});
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $PortBinding
+    extends Schema.Struct<{
+        HostIp: Schema.optionalWith<
+            typeof Schema.String,
+            {
+                nullable: true;
+            }
+        >;
+        HostPort: typeof Schema.String;
+    }> {}
+
+/**
+ * A port binding between the exposed port (container) and the host.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ * @see https://github.com/docker/go-connections/blob/5df8d2b30ca886f2d94740ce3c54abd58a5bb2c9/nat/nat.go#L11-L17
+ */
+export const PortBinding: $PortBinding = Schema.Struct({
+    HostPort: Schema.String,
+    HostIp: Schema.optionalWith(Schema.String, { nullable: true }),
+}).annotations({
+    identifier: "PortBinding",
+    title: "nat.PortBinding",
+    description: "A port binding between the exposed port (container) and the host",
+});
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $PortMap extends Schema.Record$<typeof PortWithMaybeProtocol, Schema.Array$<$PortBinding>> {}
+
+/**
+ * Port mapping between the exposed port (container) and the host.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ * @see https://github.com/docker/go-connections/blob/5df8d2b30ca886f2d94740ce3c54abd58a5bb2c9/nat/nat.go#L20
+ */
+export const PortMap: $PortMap = Schema.Record({
+    key: PortWithMaybeProtocol,
+    value: Schema.Array(PortBinding),
+}).annotations({
+    identifier: "PortMap",
+    title: "nat.PortMap",
+    description: "Port mapping between the exposed port (container) and the host",
+});

package/src/schemas/UInt16.ts

@@ -0,0 +1,45 @@
+/**
+ * 16bit unsigned integer schema.
+ *
+ * @since 1.0.0
+ */
+
+import * as Brand from "effect/Brand";
+import * as Function from "effect/Function";
+import * as Schema from "effect/Schema";
+
+/**
+ * @since 1.0.0
+ * @category Branded types
+ */
+export type UInt16Brand = number & Brand.Brand<"UInt16">;
+
+/**
+ * @since 1.0.0
+ * @category Branded constructors
+ */
+export const UInt16Brand: Brand.Brand.Constructor<UInt16Brand> = Brand.nominal<UInt16Brand>();
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $UInt16 extends Schema.Annotable<$UInt16, UInt16Brand, Brand.Brand.Unbranded<UInt16Brand>, never> {}
+
+/**
+ * 16bit unsigned integer.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const UInt16: $UInt16 = Function.pipe(
+    Schema.Int,
+    Schema.greaterThanOrEqualTo(0),
+    Schema.lessThanOrEqualTo(2 ** 16 - 1),
+    Schema.fromBrand(UInt16Brand),
+    Schema.annotations({
+        identifier: "UInt16",
+        title: "16-bit unsigned integer",
+        description: "A 16-bit unsigned integer.",
+    })
+);

package/src/schemas/UInt32.ts

@@ -0,0 +1,45 @@
+/**
+ * 32bit unsigned integer schema.
+ *
+ * @since 1.0.0
+ */
+
+import * as Brand from "effect/Brand";
+import * as Function from "effect/Function";
+import * as Schema from "effect/Schema";
+
+/**
+ * @since 1.0.0
+ * @category Branded types
+ */
+export type UInt32Brand = number & Brand.Brand<"UInt32">;
+
+/**
+ * @since 1.0.0
+ * @category Branded constructors
+ */
+export const UInt32Brand: Brand.Brand.Constructor<UInt32Brand> = Brand.nominal<UInt32Brand>();
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $UInt32 extends Schema.Annotable<$UInt32, UInt32Brand, Brand.Brand.Unbranded<UInt32Brand>, never> {}
+
+/**
+ * 32bit unsigned integer.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const UInt32: $UInt32 = Function.pipe(
+    Schema.Int,
+    Schema.greaterThanOrEqualTo(0),
+    Schema.lessThanOrEqualTo(2 ** 32 - 1),
+    Schema.fromBrand(UInt32Brand),
+    Schema.annotations({
+        identifier: "UInt32",
+        title: "32-bit unsigned integer",
+        description: "A 32-bit unsigned integer.",
+    })
+);

package/src/schemas/UInt64.ts

@@ -0,0 +1,45 @@
+/**
+ * 64bit unsigned integer schema.
+ *
+ * @since 1.0.0
+ */
+
+import * as Brand from "effect/Brand";
+import * as Function from "effect/Function";
+import * as Schema from "effect/Schema";
+
+/**
+ * @since 1.0.0
+ * @category Branded types
+ */
+export type UInt64Brand = number & Brand.Brand<"UInt64">;
+
+/**
+ * @since 1.0.0
+ * @category Branded constructors
+ */
+export const UInt64Brand: Brand.Brand.Constructor<UInt64Brand> = Brand.nominal<UInt64Brand>();
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $UInt64 extends Schema.Annotable<$UInt64, UInt64Brand, Brand.Brand.Unbranded<UInt64Brand>, never> {}
+
+/**
+ * 64bit unsigned integer.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const UInt64: $UInt64 = Function.pipe(
+    Schema.Number,
+    Schema.greaterThanOrEqualTo(0),
+    Schema.lessThanOrEqualTo(2 ** 64 - 1),
+    Schema.fromBrand(UInt64Brand),
+    Schema.annotations({
+        identifier: "UInt64",
+        title: "64-bit unsigned integer",
+        description: "A 64-bit unsigned integer.",
+    })
+);

package/src/schemas/UInt8.ts

@@ -0,0 +1,45 @@
+/**
+ * 8bit unsigned integer schema.
+ *
+ * @since 1.0.0
+ */
+
+import * as Brand from "effect/Brand";
+import * as Function from "effect/Function";
+import * as Schema from "effect/Schema";
+
+/**
+ * @since 1.0.0
+ * @category Branded types
+ */
+export type UInt8Brand = number & Brand.Brand<"UInt8">;
+
+/**
+ * @since 1.0.0
+ * @category Branded constructors
+ */
+export const UInt8Brand: Brand.Brand.Constructor<UInt8Brand> = Brand.nominal<UInt8Brand>();
+
+/**
+ * @since 1.0.0
+ * @category Api interface
+ */
+export interface $UInt8 extends Schema.Annotable<$UInt8, UInt8Brand, Brand.Brand.Unbranded<UInt8Brand>, never> {}
+
+/**
+ * 8bit unsigned integer.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const UInt8: $UInt8 = Function.pipe(
+    Schema.Int,
+    Schema.greaterThanOrEqualTo(0),
+    Schema.lessThanOrEqualTo(2 ** 8 - 1),
+    Schema.fromBrand(UInt8Brand),
+    Schema.annotations({
+        identifier: "UInt8",
+        title: "8-bit unsigned integer",
+        description: "An 8-bit unsigned integer.",
+    })
+);

package/src/schemas/index.ts

@@ -0,0 +1,40 @@
+export * as AddressSchemas from "./Address.js";
+export * as CidrBlockSchemas from "./CidrBlock.js";
+export * as CidrBlockMaskSchemas from "./CidrBlockMask.js";
+export * as FamilySchemas from "./Family.js";
+export * as Int16Schemas from "./Int16.js";
+export * as Int32Schemas from "./Int32.js";
+export * as Int64Schemas from "./Int64.js";
+export * as Int8Schemas from "./Int8.js";
+export * as IPv4Schemas from "./IPv4.js";
+export * as IPv6Schemas from "./IPv6.js";
+export * as MacSchemas from "./Mac.js";
+export * as PortSchemas from "./Port.js";
+export * as UInt16Schemas from "./UInt16.js";
+export * as UInt32Schemas from "./UInt32.js";
+export * as UInt64Schemas from "./UInt64.js";
+export * as UInt8Schemas from "./UInt8.js";
+
+export { Address, AddressBigint, AddressString } from "./Address.js";
+export {
+    CidrBlock,
+    CidrBlockFromString,
+    IPv4CidrBlock,
+    IPv4CidrBlockFromString,
+    IPv6CidrBlock,
+    IPv6CidrBlockFromString,
+} from "./CidrBlock.js";
+export { IPv4CidrMask, IPv6CidrMask } from "./CidrBlockMask.js";
+export { Family } from "./Family.js";
+export { Int16 } from "./Int16.js";
+export { Int32 } from "./Int32.js";
+export { Int64 } from "./Int64.js";
+export { Int8 } from "./Int8.js";
+export { IPv4, IPv4Bigint, IPv4String } from "./IPv4.js";
+export { IPv6, IPv6Bigint, IPv6String } from "./IPv6.js";
+export { MacAddress } from "./Mac.js";
+export { Port } from "./Port.js";
+export { UInt16 } from "./UInt16.js";
+export { UInt32 } from "./UInt32.js";
+export { UInt64 } from "./UInt64.js";
+export { UInt8 } from "./UInt8.js";

package/Agent/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Agent.js",
-  "module": "../dist/esm/Agent.js",
-  "types": "../dist/dts/Agent.d.ts",
-  "sideEffects": []
-}

package/Configs/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Configs.js",
-  "module": "../dist/esm/Configs.js",
-  "types": "../dist/dts/Configs.d.ts",
-  "sideEffects": []
-}

package/Containers/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Containers.js",
-  "module": "../dist/esm/Containers.js",
-  "types": "../dist/dts/Containers.d.ts",
-  "sideEffects": []
-}

package/Demux/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Demux.js",
-  "module": "../dist/esm/Demux.js",
-  "types": "../dist/dts/Demux.d.ts",
-  "sideEffects": []
-}

package/Distribution/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Distribution.js",
-  "module": "../dist/esm/Distribution.js",
-  "types": "../dist/dts/Distribution.d.ts",
-  "sideEffects": []
-}

package/Docker/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Docker.js",
-  "module": "../dist/esm/Docker.js",
-  "types": "../dist/dts/Docker.d.ts",
-  "sideEffects": []
-}

package/Execs/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Execs.js",
-  "module": "../dist/esm/Execs.js",
-  "types": "../dist/dts/Execs.d.ts",
-  "sideEffects": []
-}

package/Images/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Images.js",
-  "module": "../dist/esm/Images.js",
-  "types": "../dist/dts/Images.d.ts",
-  "sideEffects": []
-}

package/Moby/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Moby.js",
-  "module": "../dist/esm/Moby.js",
-  "types": "../dist/dts/Moby.d.ts",
-  "sideEffects": []
-}

package/Networks/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Networks.js",
-  "module": "../dist/esm/Networks.js",
-  "types": "../dist/dts/Networks.d.ts",
-  "sideEffects": []
-}

package/Nodes/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Nodes.js",
-  "module": "../dist/esm/Nodes.js",
-  "types": "../dist/dts/Nodes.d.ts",
-  "sideEffects": []
-}

package/Plugins/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Plugins.js",
-  "module": "../dist/esm/Plugins.js",
-  "types": "../dist/dts/Plugins.d.ts",
-  "sideEffects": []
-}

package/Requests/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Requests.js",
-  "module": "../dist/esm/Requests.js",
-  "types": "../dist/dts/Requests.d.ts",
-  "sideEffects": []
-}

package/Schemas/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Schemas.js",
-  "module": "../dist/esm/Schemas.js",
-  "types": "../dist/dts/Schemas.d.ts",
-  "sideEffects": []
-}

package/Schemas2/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Schemas2.js",
-  "module": "../dist/esm/Schemas2.js",
-  "types": "../dist/dts/Schemas2.d.ts",
-  "sideEffects": []
-}

package/Secrets/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Secrets.js",
-  "module": "../dist/esm/Secrets.js",
-  "types": "../dist/dts/Secrets.d.ts",
-  "sideEffects": []
-}

package/Services/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Services.js",
-  "module": "../dist/esm/Services.js",
-  "types": "../dist/dts/Services.d.ts",
-  "sideEffects": []
-}

package/Session/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Session.js",
-  "module": "../dist/esm/Session.js",
-  "types": "../dist/dts/Session.d.ts",
-  "sideEffects": []
-}

package/Swarm/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Swarm.js",
-  "module": "../dist/esm/Swarm.js",
-  "types": "../dist/dts/Swarm.d.ts",
-  "sideEffects": []
-}

package/System/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/System.js",
-  "module": "../dist/esm/System.js",
-  "types": "../dist/dts/System.d.ts",
-  "sideEffects": []
-}

package/Tasks/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Tasks.js",
-  "module": "../dist/esm/Tasks.js",
-  "types": "../dist/dts/Tasks.d.ts",
-  "sideEffects": []
-}

package/Volumes/package.json

@@ -1,6 +0,0 @@
-{
-  "main": "../dist/cjs/Volumes.js",
-  "module": "../dist/esm/Volumes.js",
-  "types": "../dist/dts/Volumes.d.ts",
-  "sideEffects": []
-}