docker-composer 3.1.13 → 4.0.3

package/README.md

@@ -4,7 +4,7 @@ Generate Docker Compose descriptor from a JSON document.
 
 ![Node.js CI](https://github.com/tudvari/docker-composer/workflows/Node.js%20CI/badge.svg)
 [![npm version](https://badge.fury.io/js/docker-composer.svg)](https://badge.fury.io/js/docker-composer)
-
+[![CodeQL](https://github.com/tudvari/docker-composer/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/tudvari/docker-composer/actions/workflows/codeql-analysis.yml)
 ## About the package
 
 The reason behind this package is support the Docker Compose descriptor generation from Javascript. You are able to use all Docker Compose keyword to describe your containers and services.
@@ -14,13 +14,7 @@ Docker Compose Reference is [HERE](https://docs.docker.com/compose/compose-file/
 
 ###  Changes of the Latest Release
 
-## Version 3.1.13 (23.10.2020)
-- Maintenance release, dependency updates
-
-## Version 3.1.12 (17.10.2020)
-- Maintenance release, dependency updates
-
-## Version 3.1.11 (11.10.2020)
+## Version 4.0.3 (18.01.2022)
 - Maintenance release, dependency updates
 
 You can find all Release Notes [HERE](https://github.com/tudvari/docker-composer/blob/master/ReleaseNotes.md).

package/ReleaseNotes.md

@@ -1,5 +1,17 @@
 # Release Notes
 
+## Version 4.0.3 (18.01.2022)
+- Maintenance release, dependency updates
+
+## Version 4.0.2 (27.09.2021)
+- Maintenance release, dependency updates
+
+## Version 4.0.1 (31.03.2021)
+- Maintenance release, dependency updates
+
+## Version 4.0.0 (31.12.2020)
+- Typescript type definitions
+
 ## Version 3.1.13 (23.10.2020)
 - Maintenance release, dependency updates
 

package/index.d.ts

@@ -0,0 +1,270 @@
+export type DefinitionsDeployment = {
+  mode?: string;
+  replicas?: number;
+  labels?: Labels;
+  update_config?: {
+    parallelism?: number;
+    delay?: string;
+    failure_action?: string;
+    monitor?: string;
+    max_failure_ratio?: number;
+  };
+  resources?: {
+    limits?: DefinitionsResource;
+    reservations?: DefinitionsResource;
+  };
+  restart_policy?: {
+    condition?: string;
+    delay?: string;
+    max_attempts?: number;
+    window?: string;
+  };
+  placement?: {
+    constraints?: string[];
+  };
+} & ({
+  mode?: string;
+  replicas?: number;
+  labels?: Labels;
+  update_config?: {
+    parallelism?: number;
+    delay?: string;
+    failure_action?: string;
+    monitor?: string;
+    max_failure_ratio?: number;
+  };
+  resources?: {
+    limits?: DefinitionsResource;
+    reservations?: DefinitionsResource;
+  };
+  restart_policy?: {
+    condition?: string;
+    delay?: string;
+    max_attempts?: number;
+    window?: string;
+  };
+  placement?: {
+    constraints?: string[];
+  };
+} | null);
+export type Labels =
+  | {
+      /**
+       * This interface was referenced by `undefined`'s JSON-Schema definition
+       * via the `patternProperty` ".+".
+       */
+      [k: string]: string;
+    }
+  | string[];
+export type ListOrDict =
+  | {
+      /**
+       * This interface was referenced by `undefined`'s JSON-Schema definition
+       * via the `patternProperty` ".+".
+       */
+      [k: string]: string | number | null;
+    }
+  | string[];
+export type ListOfStrings = string[];
+export type StringOrList = string | ListOfStrings;
+/**
+ * This interface was referenced by `PropertiesNetworks`'s JSON-Schema definition
+ * via the `patternProperty` "^[a-zA-Z0-9._-]+$".
+ */
+export type DefinitionsNetwork = {
+  driver?: string;
+  driver_opts?: {
+    /**
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^.+$".
+     */
+    [k: string]: string | number;
+  };
+  ipam?: {
+    driver?: string;
+    config?: {
+      subnet?: string;
+    }[];
+  };
+  external?:
+    | boolean
+    | {
+        name?: string;
+      };
+  internal?: boolean;
+  labels?: Labels;
+} & ({
+  driver?: string;
+  driver_opts?: {
+    /**
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^.+$".
+     */
+    [k: string]: string | number;
+  };
+  ipam?: {
+    driver?: string;
+    config?: {
+      subnet?: string;
+    }[];
+  };
+  external?:
+    | boolean
+    | {
+        name?: string;
+      };
+  internal?: boolean;
+  labels?: Labels;
+} | null);
+/**
+ * This interface was referenced by `PropertiesVolumes`'s JSON-Schema definition
+ * via the `patternProperty` "^[a-zA-Z0-9._-]+$".
+ */
+export type DefinitionsVolume = {
+  driver?: string;
+  driver_opts?: {
+    /**
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^.+$".
+     */
+    [k: string]: string | number;
+  };
+  external?:
+    | boolean
+    | {
+        name?: string;
+      };
+  labels?: Labels;
+} & ({
+  driver?: string;
+  driver_opts?: {
+    /**
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^.+$".
+     */
+    [k: string]: string | number;
+  };
+  external?:
+    | boolean
+    | {
+        name?: string;
+      };
+  labels?: Labels;
+} | null);
+
+export interface ConfigSchemaV30Json {
+  version: string;
+  services?: PropertiesServices;
+  networks?: PropertiesNetworks;
+  volumes?: PropertiesVolumes;
+}
+export interface PropertiesServices {
+  [k: string]: DefinitionsService;
+}
+/**
+ * This interface was referenced by `PropertiesServices`'s JSON-Schema definition
+ * via the `patternProperty` "^[a-zA-Z0-9._-]+$".
+ */
+export interface DefinitionsService {
+  deploy?: DefinitionsDeployment;
+  build?:
+    | string
+    | {
+        context?: string;
+        dockerfile?: string;
+        args?: ListOrDict;
+      };
+  cap_add?: string[];
+  cap_drop?: string[];
+  cgroup_parent?: string;
+  command?: string | string[];
+  container_name?: string;
+  depends_on?: ListOfStrings;
+  devices?: string[];
+  dns?: StringOrList;
+  dns_search?: StringOrList;
+  domainname?: string;
+  entrypoint?: string | string[];
+  env_file?: StringOrList;
+  environment?: ListOrDict;
+  expose?: (string | number)[];
+  external_links?: string[];
+  extra_hosts?: ListOrDict;
+  healthcheck?: DefinitionsHealthcheck;
+  hostname?: string;
+  image?: string;
+  ipc?: string;
+  labels?: Labels;
+  links?: string[];
+  logging?: {
+    driver?: string;
+    options?: {
+      /**
+       * This interface was referenced by `undefined`'s JSON-Schema definition
+       * via the `patternProperty` "^.+$".
+       */
+      [k: string]: string | number | null;
+    };
+  };
+  mac_address?: string;
+  network_mode?: string;
+  networks?:
+    | ListOfStrings
+    | {
+        /**
+         * This interface was referenced by `undefined`'s JSON-Schema definition
+         * via the `patternProperty` "^[a-zA-Z0-9._-]+$".
+         */
+        [k: string]: {
+          aliases?: ListOfStrings;
+          ipv4_address?: string;
+          ipv6_address?: string;
+        } | null;
+      };
+  pid?: string | null;
+  ports?: (string | number)[];
+  privileged?: boolean;
+  read_only?: boolean;
+  restart?: string;
+  security_opt?: string[];
+  shm_size?: number | string;
+  sysctls?: ListOrDict;
+  stdin_open?: boolean;
+  stop_grace_period?: string;
+  stop_signal?: string;
+  tmpfs?: StringOrList;
+  tty?: boolean;
+  ulimits?: {
+    /**
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^[a-z]+$".
+     */
+    [k: string]:
+      | number
+      | {
+          hard: number;
+          soft: number;
+        };
+  };
+  user?: string;
+  userns_mode?: string;
+  volumes?: string[];
+  working_dir?: string;
+}
+export interface DefinitionsResource {
+  cpus?: string;
+  memory?: string;
+}
+export interface DefinitionsHealthcheck {
+  disable?: boolean;
+  interval?: string;
+  retries?: number;
+  test?: string | string[];
+  timeout?: string;
+}
+export interface PropertiesNetworks {
+  [k: string]: DefinitionsNetwork;
+}
+export interface PropertiesVolumes {
+  [k: string]: DefinitionsVolume;
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "docker-composer",
-  "version": "3.1.13",
+  "version": "4.0.3",
   "description": "NodeJS module for generating docker-compose.yml from a json document.",
   "main": "index.js",
   "scripts": {
     "test": "./node_modules/mocha/bin/mocha *Test.js",
-    "coverage": "nyc npm run test"
+    "coverage": "nyc npm run test",
+    "generate-ts-types": "./node_modules/gulp-cli/bin/gulp.js"
   },
   "keywords": [
     "gulp",
@@ -34,12 +35,18 @@
     "jsonschema": "^1.4.0"
   },
   "devDependencies": {
+    "ansi-regex": "^6.0.1",
     "atob": ">=2.1.2",
-    "eslint": "7.11.0",
-    "js-yaml": "^3.14.0",
+    "copy-props": "^2.0.5",
+    "eslint": "8.7.0",
+    "gulp": "^4.0.2",
+    "gulp-cli": "^2.3.0",
+    "js-yaml": "^4.0.0",
+    "json-schema-to-typescript": "^10.1.4",
     "mixin-deep": ">=2.0.1",
-    "mocha": "8.2.0",
+    "mocha": "9.1.4",
     "nyc": "^15.1.0",
+    "set-value": "^4.0.1",
     "should": "13.2.3"
   },
   "nyc": {