@eik/common 4.0.9 → 4.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [4.1.0](https://github.com/eik-lib/common/compare/v4.0.9...v4.1.0) (2024-08-14)
+
+
+### Features
+
+* add support for Eik image type ([75a5830](https://github.com/eik-lib/common/commit/75a5830df7bf59f7ef627b8d143cda5c0bbbba1b))
+
 ## [4.0.9](https://github.com/eik-lib/common/compare/v4.0.8...v4.0.9) (2024-08-13)
 
 

package/eikjson.d.ts

@@ -20,9 +20,9 @@ export interface EikjsonSchema {
    */
   version: string;
   /**
-   * The type of the Eik package. Must be one of 'package', 'npm' or 'map'. Setting this value changes the URL publish namespace between '/pkg' (default), '/npm' and '/map', use 'npm' when publishing NPM packages. Use 'map' when publishing import maps.
+   * The type of the Eik package. Must be one of 'package', 'npm', 'map' or 'image'. Setting this value changes the URL publish namespace between '/pkg' (default), '/npm', '/map' and '/img', use 'npm' when publishing NPM packages. Use 'image' when publishing images. Use 'map' when publishing import maps.
    */
-  type?: "package" | "npm" | "map";
+  type?: "package" | "npm" | "map" | "image";
   /**
    * File mapping definition for the package. Keys represent files or paths to be created on the Eik Server. Values represent paths to local files to be published.
    */

package/lib/helpers/type-slug.js

@@ -6,5 +6,6 @@
  */
 export default (type) => {
     if (type === 'package') return 'pkg';
+    if (type === 'image') return 'img';
     return type;
 };

package/lib/helpers/type-title.js

@@ -6,5 +6,6 @@
 export default (type) => {
     if (type === 'package') return 'PACKAGE';
     if (type === 'npm') return 'NPM';
+    if (type === 'image') return 'IMAGE';
     return 'MAP';
 };

package/lib/schemas/assert.js

@@ -32,7 +32,7 @@ const assert = (validate, message) => (value) => {
             .map((err) => {
                 let msg = err.message;
                 if (err.params && err.params.allowedValues) {
-                    msg += ` ("${err.params.allowedValues.join('", ')}")`;
+                    msg += ` ("${err.params.allowedValues.join('", "')}")`;
                 }
                 return msg;
             })

package/lib/schemas/eikjson.schema.json

@@ -24,9 +24,9 @@
       "minLength": 1
     },
     "type": {
-      "description": "The type of the Eik package. Must be one of 'package', 'npm' or 'map'. Setting this value changes the URL publish namespace between '/pkg' (default), '/npm' and '/map', use 'npm' when publishing NPM packages. Use 'map' when publishing import maps.",
+      "description": "The type of the Eik package. Must be one of 'package', 'npm', 'map' or 'image'. Setting this value changes the URL publish namespace between '/pkg' (default), '/npm', '/map' and '/img', use 'npm' when publishing NPM packages. Use 'image' when publishing images. Use 'map' when publishing import maps.",
       "type": "string",
-      "enum": ["package", "npm", "map"],
+      "enum": ["package", "npm", "map", "image"],
       "default": "package"
     },
     "files": {

package/lib/validators/index.js

@@ -77,7 +77,12 @@ export const alias = (value) => {
  * @throws {Error} if the value is not a valid Eik package type
  */
 export const type = (value) => {
-    if (value === 'pkg' || value === 'map' || value === 'npm') {
+    if (
+        value === 'pkg' ||
+        value === 'map' ||
+        value === 'npm' ||
+        value === 'img'
+    ) {
         return value;
     }
     throw new Error(`Parameter "type" is not valid - Value: ${value}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/common",
-  "version": "4.0.9",
+  "version": "4.1.0",
   "description": "Common utilities for Eik modules",
   "main": "lib/index.js",
   "types": "types/index.d.ts",

package/types/classes/eik-config.d.ts

@@ -17,7 +17,7 @@ export default class EikConfig {
     /** @type {EikjsonSchema["version"]} */
     get version(): string;
     /** @type {EikjsonSchema["type"]} */
-    get type(): "map" | "npm" | "package";
+    get type(): "map" | "npm" | "package" | "image";
     /** @type {string} */
     get server(): string;
     /** @type {[string, string][]} */

package/types/helpers/type-title.d.ts

@@ -1,2 +1,2 @@
-declare function _default(type: string): "PACKAGE" | "NPM" | "MAP";
+declare function _default(type: string): "PACKAGE" | "NPM" | "MAP" | "IMAGE";
 export default _default;