Skip to main content
Home

@fathym/eac@0.2.136
Built and signed on GitHub Actions

This library contains the core types for Fathym's Everything as Code (EaC) framework.

This package works with Deno, BrowsersIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
This package works with Browsers
JSR Score
88%
Published
a week ago (0.2.136)

default

The core Everything as Code (EaC) types.

T
AllAnyTypes

Type representing whether to fetch all or any matches.

v
AllAnyTypesSchema

Schema for AllAnyTypes. Validates that the value is one of the AllAnyTypes union type values.

T
EaCAPIJWTPayload

Represents the JWT payload structure for EaC API requests.

v
EaCAPIJWTPayloadSchema

Schema for EaCAPIJWTPayload. Validates the JWT payload structure, ensuring specific keys like EnterpriseLookup, JWT, and Username are of the correct types while allowing additional metadata through dynamic keys.

T
EaCDetails

Everything as Code (EaC) details.

v
EaCDetailsSchema

Schema for EaCDetails. Validates the structure for Everything as Code (EaC) details, focusing on the Details field which captures vertex-specific properties and supports metadata extensibility.

T
EaCEnterpriseDetails

EaC enterprise details.

v
EaCEnterpriseDetailsSchema

Schema for EaCEnterpriseDetails. Validates the structure for enterprise details, inheriting all properties from EaCVertexDetailsSchema.

T
EaCMetadataBase

The base type for Everything as Code (EaC) to create open EaC types. This represents an extensible metadata structure with arbitrary keys and values.

v
EaCMetadataBaseSchema

Schema for EaCMetadataBase. Validates that the object is an extensible metadata structure with arbitrary keys and values.

T
EaCModuleActuator

EaC module actuator for use in EaC processing.

T
EaCModuleActuators

Represents a collection of EaC module actuators for use in EaC processing.

v
EaCModuleActuatorSchema

Schema for EaCModuleActuator. This schema validates a configuration for handling a specific EaC module, ensuring consistency for API paths and processing order.

v
EaCModuleActuatorsSchema

Schema for EaCModuleActuators. Validates a collection of EaC module actuators with a $Force flag and dynamic keys mapping to individual EaCModuleActuator configurations.

T
EaCUserRecord

Represents a user record in the Everything as Code (EaC) framework.

v
EaCUserRecordSchema

Schema for EaCUserRecord. This schema validates user records, ensuring a consistent structure for enterprise-related user data.

T
EaCVertexDetails

Details about a vertex in the Everything as Code (EaC) graph.

v
EaCVertexDetailsSchema

Schema for EaCVertexDetails. This schema validates the essential details of a vertex in the EaC graph.

T
EverythingAsCode

Everything as Code (EaC).

v
EverythingAsCodeSchema

Schema for EverythingAsCode. Validates the structure of an EaC node, ensuring consistency in identification, configuration, and hierarchical linking properties.

f
isAllAnyType

Type guard for AllAnyTypes. Validates if the given value is a valid AllAnyTypes value.

f
isEaCAPIJWTPayload

Type guard for EaCAPIJWTPayload. Validates if the given object conforms to the EaCAPIJWTPayload structure.

f
isEaCDetails

Type guard for EaCDetails. Validates if the given object conforms to the EaCDetails structure.

f
isEaCEnterpriseDetails

Type guard for EaCEnterpriseDetails. Validates if the given object conforms to the EaCEnterpriseDetails structure.

f
isEaCMetadataBase

Type guard for EaCMetadataBase. Validates if the given object conforms to the EaCMetadataBase structure.

f
isEaCModuleActuator

Type guard for EaCModuleActuator. Validates if the given object conforms to the EaCModuleActuator structure.

f
isEaCModuleActuators

Type guard for EaCModuleActuators. Validates if the given object conforms to the EaCModuleActuators structure.

f
isEaCUserRecord

Type guard for EaCUserRecord. Validates if the given object conforms to the EaCUserRecord structure.

f
isEaCVertexDetails

Type guard for EaCVertexDetails. Validates if the given object conforms to the EaCVertexDetails structure.

f
isEverythingAsCode

Type guard for EverythingAsCode. Validates if the given object conforms to the EverythingAsCode structure.

f
parseAllAnyType

Validates and parses a value as AllAnyTypes.

f
parseEaCAPIJWTPayload

Validates and parses an object as EaCAPIJWTPayload.

f
parseEaCDetails

Validates and parses an object as EaCDetails.

f
parseEaCEnterpriseDetails

Validates and parses an object as EaCEnterpriseDetails.

f
parseEaCMetadataBase

Validates and parses an object as EaCMetadataBase.

f
parseEaCModuleActuator

Validates and parses an object as EaCModuleActuator.

f
parseEaCModuleActuators

Validates and parses an object as EaCModuleActuators.

f
parseEaCUserRecord

Validates and parses an object as EaCUserRecord.

f
parseEaCVertexDetails

Validates and parses an object as EaCVertexDetails.

f
parseEverythingAsCode

Validates and parses an object as EverythingAsCode.

dfs

The core Everything as Code (EaC) Distributed File System types.

T
DistributedFileSystemOptions

Represents options for configuring a Distributed File System (DFS).

v
DistributedFileSystemOptionsSchema

Schema for DistributedFileSystemOptions. Ensures that DFS-specific options conform to expected types.

T
EaCAzureBlobStorageDistributedFileSystemDetails

Represents details for an Azure Blob Storage-backed Distributed File System (DFS) in Everything as Code (EaC).

v
EaCAzureBlobStorageDistributedFileSystemDetailsSchema

Schema for EaCAzureBlobStorageDistributedFileSystemDetails. Ensures Type is explicitly "AzureBlobStorage" while extending EaCDistributedFileSystemDetailsSchema.

T
EaCDenoKVDistributedFileSystemDetails

Represents details for a Deno KV-backed Distributed File System (DFS) in Everything as Code (EaC).

v
EaCDenoKVDistributedFileSystemDetailsSchema

Schema for EaCDenoKVDistributedFileSystemDetails. Ensures Type is explicitly "DenoKV" while extending EaCDistributedFileSystemDetailsSchema.

T
EaCDistributedFileSystemAsCode

Represents an Everything as Code (EaC) Distributed File System (DFS).

v
EaCDistributedFileSystemAsCodeSchema

Schema for EaCDistributedFileSystemAsCode. Ensures that Details conforms to EaCDistributedFileSystemDetailsSchema.

T
EaCDistributedFileSystemDetails

Represents details for a Distributed File System (DFS) in Everything as Code (EaC).

v
EaCDistributedFileSystemDetailsSchema

Schema for EaCDistributedFileSystemDetails. Ensures that DFS-specific properties conform to expected types while extending EaCVertexDetailsSchema.

T
EaCESMDistributedFileSystemDetails

Represents details for an ESM-backed Distributed File System (DFS) in Everything as Code (EaC).

v
EaCESMDistributedFileSystemDetailsSchema

Schema for EaCESMDistributedFileSystemDetails. Ensures Type is explicitly "ESM" while extending EaCDistributedFileSystemDetailsSchema.

T
EaCJSRDistributedFileSystemDetails

Represents details for a JSR-backed Distributed File System (DFS) in Everything as Code (EaC).

v
EaCJSRDistributedFileSystemDetailsSchema

Schema for EaCJSRDistributedFileSystemDetails. Ensures Type is explicitly "JSR" while extending EaCDistributedFileSystemDetailsSchema.

T
EaCLocalDistributedFileSystemDetails

Represents details for a Local File System-backed Distributed File System (DFS) in Everything as Code (EaC).

v
EaCLocalDistributedFileSystemDetailsSchema

Schema for EaCLocalDistributedFileSystemDetails. Ensures Type is explicitly "Local" while extending EaCDistributedFileSystemDetailsSchema.

T
EaCNPMDistributedFileSystemDetails

Represents details for an NPM-backed Distributed File System (DFS) in Everything as Code (EaC).

v
EaCNPMDistributedFileSystemDetailsSchema

Schema for EaCNPMDistributedFileSystemDetails. Ensures Type is explicitly "NPM" while extending EaCDistributedFileSystemDetailsSchema.

T
EaCRemoteDistributedFileSystemDetails

Represents details for a Remote-backed Distributed File System (DFS) in Everything as Code (EaC).

v
EaCRemoteDistributedFileSystemDetailsSchema

Schema for EaCRemoteDistributedFileSystemDetails. Ensures Type is explicitly "Remote" while extending EaCDistributedFileSystemDetailsSchema.

T
EverythingAsCodeDFS

Represents the Everything as Code (EaC) Distributed File System (DFS) structure.

v
EverythingAsCodeDFSSchema

Schema for EverythingAsCodeDFS.

f
isDistributedFileSystemOptions

Type guard for DistributedFileSystemOptions. Validates if the given object conforms to the DistributedFileSystemOptions structure.

f
isEaCAzureBlobStorageDistributedFileSystemDetails

Type guard for EaCAzureBlobStorageDistributedFileSystemDetails. Validates if the given object conforms to the EaCAzureBlobStorageDistributedFileSystemDetails structure.

f
isEaCDenoKVDistributedFileSystemDetails

Type guard for EaCDenoKVDistributedFileSystemDetails. Validates if the given object conforms to the EaCDenoKVDistributedFileSystemDetails structure.

f
isEaCDistributedFileSystemAsCode

Type guard for EaCDistributedFileSystemAsCode. Validates if the given object conforms to the EaCDistributedFileSystemAsCode structure.

f
isEaCDistributedFileSystemDetails

Type guard for EaCDistributedFileSystemDetails. Validates if the given object conforms to the EaCDistributedFileSystemDetails structure.

f
isEaCESMDistributedFileSystemDetails

Type guard for EaCESMDistributedFileSystemDetails. Validates if the given object conforms to the EaCESMDistributedFileSystemDetails structure.

f
isEaCJSRDistributedFileSystemDetails

Type guard for EaCJSRDistributedFileSystemDetails. Validates if the given object conforms to the EaCJSRDistributedFileSystemDetails structure.

f
isEaCLocalDistributedFileSystemDetails

Type guard for EaCLocalDistributedFileSystemDetails. Validates if the given object conforms to the EaCLocalDistributedFileSystemDetails structure.

f
isEaCNPMDistributedFileSystemDetails

Type guard for EaCNPMDistributedFileSystemDetails. Validates if the given object conforms to the EaCNPMDistributedFileSystemDetails structure.

f
isEaCRemoteDistributedFileSystemDetails

Type guard for EaCRemoteDistributedFileSystemDetails. Validates if the given object conforms to the EaCRemoteDistributedFileSystemDetails structure.

f
isEverythingAsCodeDFS

Type guard for EverythingAsCodeDFS. Validates if the given object conforms to the EverythingAsCodeDFS structure.

f
parseDistributedFileSystemOptions

Validates and parses an object as DistributedFileSystemOptions.

f
parseEaCAzureBlobStorageDistributedFileSystemDetails

Validates and parses an object as EaCAzureBlobStorageDistributedFileSystemDetails.

f
parseEaCDenoKVDistributedFileSystemDetails

Validates and parses an object as EaCDenoKVDistributedFileSystemDetails.

f
parseEaCDistributedFileSystemAsCode

Validates and parses an object as EaCDistributedFileSystemAsCode.

f
parseEaCDistributedFileSystemDetails

Validates and parses an object as EaCDistributedFileSystemDetails.

f
parseEaCESMDistributedFileSystemDetails

Validates and parses an object as EaCESMDistributedFileSystemDetails.

f
parseEaCJSRDistributedFileSystemDetails

Validates and parses an object as EaCJSRDistributedFileSystemDetails.

f
parseEaCLocalDistributedFileSystemDetails

Validates and parses an object as EaCLocalDistributedFileSystemDetails.

f
parseEaCNPMDistributedFileSystemDetails

Validates and parses an object as EaCNPMDistributedFileSystemDetails.

f
parseEaCRemoteDistributedFileSystemDetails

Validates and parses an object as EaCRemoteDistributedFileSystemDetails.

f
parseEverythingAsCodeDFS

Validates and parses an object as EverythingAsCodeDFS.

c
DFSFileHandler

Abstract base class implementing IDFSFileHandler. Concrete implementations must provide method implementations.

T
DFSFileHandlerResolver
No documentation available
c
FetchDFSFileHandler

Implements DFSFileHandler using HTTP(S) and local file fetching.

I
IDFSFileHandler

Interface defining methods for a Distributed File System (DFS) File Handler.

c
JSRFetchDFSFileHandler

Specialized DFS handler for JSR-backed file systems. Handles version resolution and file retrieval from jsr.io.

c
LocalDFSFileHandler

Implements DFSFileHandler for local file system storage.

c
NPMFetchDFSFileHandler

Implements DFSFileHandler for NPM-based file storage via Skypack CDN.

c
WorkerDFSFileHandler

Implements DFSFileHandler for worker-based DFS execution.

c
DefaultDFSFileHandlerResolver
No documentation available
v
EaCAzureBlobStorageDistributedFileSystemHandlerResolver

Resolver for Azure Blob Storage Distributed File Systems (DFS).

v
v
EaCESMDistributedFileSystemHandlerResolver

Resolver for ESM-based Distributed File Systems (DFS).

v
EaCJSRDistributedFileSystemHandlerResolver

Resolver for JSR-based Distributed File Systems (DFS).

v
EaCLocalDistributedFileSystemHandlerResolver

Resolver for Local Distributed File Systems (DFS).

v
EaCNPMDistributedFileSystemHandlerResolver

Resolver for NPM Distributed File Systems (DFS) using Skypack CDN.

v
EaCRemoteDistributedFileSystemHandlerResolver

Resolver for Remote Distributed File Systems (DFS).

v
EaCWorkerDistributedFileSystemHandlerResolver

Resolver for Worker-based Distributed File Systems (DFS).

f
convertFilePathToMatch
No documentation available
f
convertFilePathToPattern
No documentation available
f
denoKvCacheReadableStream
No documentation available
c
DenoKVFileStream
No documentation available
T
DenoKVFileStreamData
No documentation available
f
denoKvReadReadableStreamCache
No documentation available
f
executePathMatch
No documentation available
f
getFileCheckPathsToProcess
No documentation available
f
importDFSTypescriptModule
No documentation available
f
loadDFSFileHandler
No documentation available
f
loadEaCRuntimeHandlers
No documentation available
f
loadFileHandler
No documentation available
f
loadMiddleware
No documentation available
f
loadRequestPathPatterns
No documentation available
v
pathToPatternRegexes
No documentation available
f
withDFSCache
No documentation available
f
eacFluentBuilder
No documentation available
T
EverythingAsCodeTags

EverythingAsCodeTags<T> is a recursive type that applies tags to all properties of type T.

f
defineEaCConfig
No documentation available
f
EAC_RUNTIME_DEV
No documentation available
T
EaCRuntimeConfig
No documentation available
T
EaCRuntimePluginConfig
No documentation available
T
EaCRuntimeServer
No documentation available
T
v
fathymGreen
No documentation available
f
GenericEaCConfig
No documentation available
v
IS_BUILDING
No documentation available
f
IS_DENO_DEPLOY
No documentation available
f
SUPPORTS_WORKERS
No documentation available
v
IS_BROWSER
No documentation available
c
ExecutionContext
No documentation available
c
ExecutionHandler
No documentation available
c
ExecutionPattern
No documentation available
c
DenoServeProtocolGateway
No documentation available
T
ProtocolGateway
No documentation available
c
EaCLoggingProvider
No documentation available
T
EaCRuntimePlugin
No documentation available
T
EaCRuntimePluginDef
No documentation available
T
EaCRuntimePluginDefs
No documentation available
f
findAvailablePort

Function to find an available port in the given range

f
resolvePort

Generalized function for resolving ports

f
start
No documentation available
f
startServer
No documentation available
T
EaCCommitCheckRequest
No documentation available
T
EaCCommitRequest
No documentation available
T
EaCDeleteRequest
No documentation available
c
EaCSteward
No documentation available
f
isEaCCommitCheckRequest
No documentation available
f
isEaCCommitRequest
No documentation available
f
isEaCCommitResponse
No documentation available
f
isEaCDeleteRequest
No documentation available
T
EaCActuatorCheckRequest
No documentation available
T
EaCActuatorConnectionsResponse
No documentation available
T
EaCActuatorErrorResponse
No documentation available
T
f
isEaCActuatorCheckResponse
No documentation available
f
isEaCActuatorConnectionsRequest
No documentation available
f
isEaCActuatorConnectionsResponse
No documentation available
f
isEaCActuatorErrorResponse
No documentation available
f
isEaCActuatorRequest
No documentation available
f
isEaCActuatorResponse
No documentation available
c
EaCActuatorsClient
No documentation available
c
EaCBaseClient
No documentation available
c
EaCInformantsClient
No documentation available
c
EaCStewardClient
No documentation available
f
loadEaCStewardSvc
No documentation available

steward/status

Helpers for interacting with and managing the EaC commit status.

E
EaCStatusProcessingTypes
No documentation available
f
waitForStatus
No documentation available
f
waitForStatusWithFreshJwt
No documentation available
f
waitOnProcessing
No documentation available
f
withStatusCheck
No documentation available
f
callEaCActuator
No documentation available
f
callEaCActuatorCheck
No documentation available
f
callEaCActuatorConnections

Executes a connection request for a specific EaC handler.

f
callEaCActuatorDelete
No documentation available
f
eacExists

Checks if a given EaC entry exists in the key-value store.

f
invalidateProcessing

Invalidates processing for a specific EaC entry if it exceeds the maximum runtime.

f
markEaCProcessed

Marks an EaC entry as processed by deleting relevant keys.

f
waitOnEaCProcessing

Waits for EaC processing to complete with a specific handler.

types

Supporting types for working with the EaC.

T
EaCAsCodeDetails
No documentation available
T
HasDetailsProperty
No documentation available
T
Indexable
No documentation available
T
IsRequiredProperty
No documentation available
T
OptionalProperties
No documentation available

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.