[![npm](https://img.shields.io/npm/v/pmcf.svg)](https://www.npmjs.com/package/pmcf) [![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html) [![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org) [![bundlejs](https://deno.bundlejs.com/?q=pmcf\&badge=detailed)](https://bundlejs.com/?q=pmcf) [![downloads](http://img.shields.io/npm/dm/pmcf.svg?style=flat-square)](https://npmjs.org/package/pmcf) [![GitHub Issues](https://img.shields.io/github/issues/arlac77/pmcf.svg?style=flat-square)](https://github.com/arlac77/pmcf/issues) [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fpmcf%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/pmcf/goto) [![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Known Vulnerabilities](https://snyk.io/test/github/arlac77/pmcf/badge.svg)](https://snyk.io/test/github/arlac77/pmcf) # pmcf ## Poor mans configuration management Generates system packages from config blueprint. supported linux derivates: * arch linux * debian * rpm based systems generates config packages for: * systemd * networkd * timesyncd * resolverd * kea * bind * mosquitto * influxdb * iwd * chrony # API ### Table of Contents * [Base](#base) * [Parameters](#parameters) * [walkDirections](#walkdirections) * [Parameters](#parameters-1) * [extendedAttribute](#extendedattribute) * [Parameters](#parameters-2) * [propertyIterator](#propertyiterator) * [Parameters](#parameters-3) * [getProperties](#getproperties) * [Parameters](#parameters-4) * [priority](#priority) * [expression](#expression) * [Parameters](#parameters-5) * [findService](#findservice) * [Parameters](#parameters-6) * [templateContent](#templatecontent) * [Parameters](#parameters-7) * [property](#property) * [Parameters](#parameters-8) * [expand](#expand) * [Parameters](#parameters-9) * [PortEndpoint](#portendpoint) * [Parameters](#parameters-10) * [port](#port) * [socketAddress](#socketaddress) * [HTTPEndpoint](#httpendpoint) * [Parameters](#parameters-11) * [port](#port-1) * [SkeletonNetworkInterface](#skeletonnetworkinterface) * [networkAddresses](#networkaddresses) * [Parameters](#parameters-12) * [SystemdJournalRemoteService](#systemdjournalremoteservice) * [Properties](#properties) * [systemdConfigs](#systemdconfigs) * [Parameters](#parameters-13) * [SystemdJournalUploadService](#systemdjournaluploadservice) * [Properties](#properties-1) * [systemdConfigs](#systemdconfigs-1) * [Parameters](#parameters-14) * [NetworkAddress](#networkaddress) * [Parameters](#parameters-15) * [subnet](#subnet) * [networkInterface](#networkinterface) * [address](#address) * [addresses](#addresses) * [Parameters](#parameters-16) * [cidrAddresses](#cidraddresses) * [Parameters](#parameters-17) * [isTemplate](#istemplate) * [named](#named) * [Parameters](#parameters-18) * [serviceEndpoints](#serviceendpoints) * [Parameters](#parameters-19) * [domainName](#domainname) * [Parameters](#parameters-20) * [domainFromDominName](#domainfromdominname) * [Parameters](#parameters-21) * [sectionLines](#sectionlines) * [Parameters](#parameters-22) * [asArray](#asarray) * [Parameters](#parameters-23) * [asIterator](#asiterator) * [Parameters](#parameters-24) ## Base attributes: essential values properties: use defined values to support attribute value definitions ### Parameters * `owner` **[Base](#base)** * `data` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** ### walkDirections Walk the object graph in some directions and deliver seen nodes. #### Parameters * `directions` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** (optional, default `["this","extends","owner"]`) Returns **Iterable<[Base](#base)>** ### extendedAttribute #### Parameters * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Returns **any** ### propertyIterator Retrive attribute values from an object. #### Parameters * `filter` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** Returns **Iterable<\[[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), any]>** values ### getProperties Retrive attribute values from an object. #### Parameters * `filter` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** (optional, default `filterPublic`) Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** values ### priority Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** ### expression #### Parameters * `expression` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** * `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Returns **any** ### findService #### Parameters * `filter` **any** Returns **any** service with the highest priority ### templateContent #### Parameters * `entryProperties` **any** * `directoryProperties` **any** Returns **AsyncIterable\** ### property #### Parameters * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Returns **any** ### expand #### Parameters * `object` **any** Returns **any** ## PortEndpoint **Extends BaseEndpoint** Endpoint with an ip port ### Parameters * `service` * `data` ### port Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** ### socketAddress Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** ## HTTPEndpoint **Extends BaseEndpoint** Endpoint based on http ### Parameters * `service` **Service** * `address` **any** * `data` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### port Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** ## SkeletonNetworkInterface **Extends ServiceOwner** ### networkAddresses #### Parameters * `filter` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `n=>true`) Returns **Iterable<[NetworkAddress](#networkaddress)>** ## SystemdJournalRemoteService **Extends Service** ### Properties * `ServerCertificateFile` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** * `ServerKeyFile` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** ### systemdConfigs #### Parameters * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ## SystemdJournalUploadService **Extends Service** ### Properties * `URL` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** * `ServerCertificateFile` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** * `ServerKeyFile` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** ### systemdConfigs #### Parameters * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ## NetworkAddress ### Parameters * `networkInterface` **NetworkInterface** * `address` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | [Uint16Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array))** * `subnet` **Subnet** ### subnet Type: Subnet ### networkInterface Type: NetworkInterface ### address Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | [Uint16Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array)) ## addresses ### Parameters * `sources` **Iterable<(Owner | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))>** * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** * `options.aggregate` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** * `options.filter` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Returns **Iterable<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** addresses ## cidrAddresses ### Parameters * `networkAddresses` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[NetworkAddress](#networkaddress)>** Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** ## isTemplate Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** ## named ### Parameters * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Returns **(Service | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** ## serviceEndpoints ### Parameters * `sources` **any** * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** (optional, default `{}`) * `options.services` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** filter for services * `options.endpoints` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** filter for endpoints * `options.select` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** mapper from Endpoint into result * `options.limit` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** upper limit of # result items * `options.join` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** join result(s) into a string Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | any)** ## domainName Appends default domain if name does not already have a domain. ### Parameters * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** * `defaultDomain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** ## domainFromDominName Extracts domain name from a name. ### Parameters * `domainName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** * `defaultDomain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** ## sectionLines ### Parameters * `sectionName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** * `values` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** ## asArray ### Parameters * `value` **any** Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\** ## asIterator ### Parameters * `value` **any** Returns **Iterable\** # install With [npm](http://npmjs.org) do: ```shell npm install pmcf ```