@platformatic/foundation 3.0.0-alpha.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,13 @@
+ Copyright 2022 Platformatic
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.

package/eslint.config.js

@@ -0,0 +1,64 @@
+import neostandard from 'neostandard'
+
+const noInternalPackages = {
+  meta: {
+    type: 'problem',
+    docs: { description: 'Disallow internal dependencies in package.json', category: 'Best Practices' }
+  },
+  create (context) {
+    return {
+      Program (node) {
+        const json = JSON.parse(
+          context
+            .getSourceCode()
+            .getText()
+            .replace(/^export default /, '')
+        )
+
+        for (const section of ['dependencies', 'devDependencies']) {
+          const deps = Object.keys(json[section])
+
+          let pkg
+
+          if (deps.includes('platformatic')) {
+            pkg = 'platformatic'
+          } else if (deps.includes('wattpm')) {
+            pkg = 'wattpm'
+          } else {
+            pkg = deps.find(d => d.startsWith('@platformatic/'))
+          }
+
+          if (pkg) {
+            context.report({ node, message: `@platformatic/foundation cannot depend on ${pkg} (${section})` })
+          }
+        }
+      }
+    }
+  }
+}
+
+export default [
+  ...neostandard({}),
+  {
+    files: ['./package.json'],
+    processor: {
+      preprocess (text) {
+        // Make it parse as Javascript
+        return [`export default ${text}`]
+      },
+      postprocess (messages) {
+        return messages[0].filter(m => m.ruleId === 'custom/no-internal-packages')
+      }
+    },
+    plugins: {
+      custom: {
+        rules: {
+          'no-internal-packages': noInternalPackages
+        }
+      }
+    },
+    rules: {
+      'custom/no-internal-packages': ['error']
+    }
+  }
+]

package/index.d.ts

@@ -0,0 +1,248 @@
+import { FastifyError } from '@fastify/error'
+import { JSONSchemaType } from 'ajv'
+import { EventEmitter } from 'node:events'
+import { Logger } from 'pino'
+
+// Configuration types
+export declare const kMetadata: unique symbol
+export declare const envVariablePattern: RegExp
+export declare const knownConfigurationFilesExtensions: string[]
+export declare const knownConfigurationFilesSchemas: RegExp[]
+
+export type RawConfiguration = Record<string, unknown>
+
+export interface ValidationError {
+  path: string
+  message: string
+}
+
+export type ConfigurationOptions = Partial<{
+  validate: boolean
+  validationOptions: object
+  transform: (config: RawConfiguration) => Promise<RawConfiguration> | RawConfiguration
+  upgrade: (logger: Logger, config: RawConfiguration, version: string) => Promise<RawConfiguration> | RawConfiguration
+  env: Record<string, string>
+  ignoreProcessEnv: boolean
+  replaceEnv: boolean
+  replaceEnvIgnore: string[]
+  onMissingEnv: (key: string) => string | undefined
+  fixPaths: boolean
+  logger: Logger
+  root: string
+  skipMetadata: boolean
+}> &
+  RawConfiguration
+
+export interface ModuleWithVersion {
+  module: string
+  version?: string
+}
+
+export type Configuration<Config = {}> = Config & {
+  [kMetadata]: {
+    root: string
+    path: string | null
+    env: Record<string, string>
+    module: { module: string; version: string } | null
+  }
+}
+
+export declare function getParser (path: string): (raw: string, ...args: any[]) => any
+export declare function getStringifier (path: string): (data: any) => string
+export declare function stringifyJSON (data: any): string
+export declare function stringifyJSON5 (data: any): string
+
+export declare function printValidationErrors (err: { validation: Array<ValidationError> }): void
+export declare function listRecognizedConfigurationFiles (
+  suffixes?: string | string[] | null,
+  extensions?: string | string[]
+): string[]
+export declare function extractModuleFromSchemaUrl (
+  config: RawConfiguration | ModuleWithVersion,
+  throwOnMissing?: boolean
+): ModuleWithVersion | null
+export declare function findConfigurationFile (
+  root: string,
+  suffixes?: string | string[],
+  extensions?: string | string[],
+  candidates?: string[]
+): Promise<string | null>
+export declare function findConfigurationFileRecursive (
+  root: string,
+  configurationFile?: string,
+  schemas?: string | string[],
+  suffixes?: string | string[]
+): Promise<string | null>
+export declare function findRuntimeConfigurationFile (
+  logger: Logger,
+  root: string,
+  configurationFile: string,
+  fallback?: boolean,
+  throwOnError?: boolean,
+  verifyPackages?: boolean
+): Promise<string | null>
+export declare function loadConfigurationFile (configurationFile: string): Promise<RawConfiguration>
+export declare function saveConfigurationFile (configurationFile: string, config: RawConfiguration): Promise<void>
+export declare function createValidator (
+  schema: JSONSchemaType<any>,
+  validationOptions?: object,
+  context?: ConfigurationOptions
+): (data: any) => boolean
+export declare function loadEnv (root: string): Promise<Record<string, string>>
+export declare function replaceEnv (
+  config: RawConfiguration,
+  env: Record<string, string>,
+  onMissingEnv?: (key: string) => string | undefined,
+  ignore?: string[]
+): RawConfiguration
+export declare function loadConfiguration (
+  source: string | RawConfiguration,
+  schema?: any,
+  options?: ConfigurationOptions
+): Promise<Configuration>
+export declare function loadConfigurationModule (root: string, config: RawConfiguration | ModuleWithVersion): any
+
+// Error types
+export declare const ERROR_PREFIX: string
+export declare function ensureLoggableError (error: Error): Error
+
+export declare const PathOptionRequiredError: FastifyError
+export declare const NoConfigFileFoundError: FastifyError
+export declare const InvalidConfigFileExtensionError: FastifyError
+export declare const AddAModulePropertyToTheConfigOrAddAKnownSchemaError: FastifyError
+export declare const CannotParseConfigFileError: FastifyError
+export declare const SourceMissingError: FastifyError
+export declare const RootMissingError: FastifyError
+export declare const SchemaMustBeDefinedError: FastifyError
+export declare const ConfigurationDoesNotValidateAgainstSchemaError: FastifyError
+
+// Execution types
+export declare const kTimeout: unique symbol
+export declare function executeWithTimeout<T> (promise: Promise<T>, timeout: number, timeoutValue?: any): Promise<T>
+
+// File system types
+export declare function removeDotSlash (path: string): string
+export declare function generateDashedName (): string
+export declare function isFileAccessible (filename: string, directory?: string): Promise<boolean>
+export declare function createDirectory (path: string, empty?: boolean): Promise<string | undefined>
+export declare function createTemporaryDirectory (prefix: string): Promise<string>
+export declare function safeRemove (path: string): Promise<void>
+export declare function searchFilesWithExtensions (
+  root: string,
+  extensions: string | string[],
+  globOptions?: object
+): Promise<string[]>
+export declare function searchJavascriptFiles (projectDir: string, globOptions?: object): Promise<string[]>
+export declare function hasFilesWithExtensions (
+  root: string,
+  extensions: string | string[],
+  globOptions?: object
+): Promise<boolean>
+export declare function hasJavascriptFiles (projectDir: string, globOptions?: object): Promise<boolean>
+
+export interface FileWatcherOptions {
+  path: string
+  allowToWatch?: string[]
+  watchIgnore?: string[]
+}
+
+export declare class FileWatcher extends EventEmitter {
+  constructor (opts: FileWatcherOptions)
+  path: string
+  allowToWatch: string[] | null
+  watchIgnore: string[] | null
+  isWatching: boolean
+  startWatching (): void
+  stopWatching (): Promise<void>
+  shouldFileBeWatched (fileName: string): boolean
+  isFileAllowed (fileName: string): boolean
+  isFileIgnored (fileName: string): boolean
+}
+
+// Logger types
+export declare function setPinoFormatters (options: any): void
+export declare function buildPinoFormatters (formatters: { path: string }): object
+export declare function setPinoTimestamp (options: any): void
+export declare function buildPinoTimestamp (timestamp: string): Function
+export declare function buildPinoOptions (
+  loggerConfig: any,
+  serverConfig: any,
+  serviceId?: string,
+  workerId?: string,
+  context?: any,
+  root?: string
+): object
+export declare function loadFormatters (require: NodeRequire, file: string): any
+export declare function disablePinoDirectWrite (): void
+export declare function noop (): void
+
+export declare const abstractLogger: Logger
+export declare const stdTimeFunctions: {
+  epochTime: Function
+  unixTime: Function
+  nullTime: Function
+  isoTime: Function
+}
+
+// Module types
+export declare const kFailedImport: unique symbol
+export declare const defaultPackageManager: string
+
+export declare function getLatestNpmVersion (pkg: string): Promise<string | null>
+export declare function getPkgManager (): string
+export declare function getPackageManager (root: string, defaultManager?: string, search?: boolean): Promise<string>
+export declare function getPlatformaticVersion (): Promise<string>
+export declare function hasDependency (packageJson: any, dependency: string): any
+export declare function splitModuleFromVersion (module: string): { module?: string; version?: string }
+export declare function detectApplicationType (
+  root: string,
+  packageJson?: any
+): Promise<{ name: string; label: string } | null>
+export declare function loadModule (require: NodeRequire, path: string): Promise<any>
+
+// Node types
+export declare function checkNodeVersionForServices (): void
+export declare const features: {
+  node: {
+    reusePort: boolean
+    worker: {
+      getHeapStatistics: boolean
+    }
+  }
+}
+
+// Object types
+export declare const deepmerge: (target: any, source: any) => any
+export declare function isKeyEnabled (key: string, config: any): boolean
+export declare function getPrivateSymbol (obj: any, name: string): symbol | undefined
+
+// Schema types
+export declare function overridableValue (spec: any, defaultValue?: any): any
+export declare function removeDefaults (schema: any): any
+export declare function omitProperties (obj: any, properties: string | string[]): any
+
+export declare const env: JSONSchemaType<Record<string, string>>
+export declare const workers: JSONSchemaType<number | string>
+export declare const preload: JSONSchemaType<string | string[]>
+export declare const watch: JSONSchemaType<object>
+export declare const cors: JSONSchemaType<object>
+export declare const logger: JSONSchemaType<object>
+export declare const server: JSONSchemaType<object>
+export declare const fastifyServer: JSONSchemaType<object>
+export declare const undiciInterceptor: JSONSchemaType<object>
+export declare const health: JSONSchemaType<object>
+export declare const healthWithoutDefaults: JSONSchemaType<object>
+export declare const telemetryExporter: JSONSchemaType<object>
+export declare const telemetry: JSONSchemaType<object>
+export declare const services: JSONSchemaType<object[]>
+export declare const runtimeUnwrappablePropertiesList: string[]
+export declare const runtimeProperties: JSONSchemaType<object>
+export declare const wrappedRuntimeProperties: JSONSchemaType<object>
+export declare const wrappedRuntime: JSONSchemaType<object>
+export declare const schemaComponents: Record<string, JSONSchemaType<any>>
+
+// String types
+export declare function findNearestString (strings: string[], target: string): string | null
+export declare function match (actual: any, expected: any): boolean
+export declare function escapeRegexp (raw: string): string
+export declare function parseMemorySize (size: string): number

package/index.js

@@ -0,0 +1,12 @@
+export * from './lib/cli.js'
+export * from './lib/configuration.js'
+export * from './lib/errors.js'
+export * as errors from './lib/errors.js'
+export * from './lib/execution.js'
+export * from './lib/file-system.js'
+export * from './lib/logger.js'
+export * from './lib/module.js'
+export * from './lib/node.js'
+export * from './lib/object.js'
+export * from './lib/schema.js'
+export * from './lib/string.js'