@koine/utils 1.0.85 → 1.0.86

package/getMediaQueryWidthResolvers.d.ts

@@ -0,0 +1,10 @@
+export declare type GetMediaQueryWidthResolversBreakpoints = Record<string, number>;
+export declare function getMediaQueryWidthResolvers<TBreakpointsConfig extends GetMediaQueryWidthResolversBreakpoints>(customBreakpoints: TBreakpointsConfig): {
+    max: (br: Extract<keyof TBreakpointsConfig, string>) => string;
+    min: (br: Extract<keyof TBreakpointsConfig, string>) => string;
+    down: (br: Extract<keyof TBreakpointsConfig, string>) => string;
+    up: (br: Extract<keyof TBreakpointsConfig, string>) => string;
+    between: (br1: Extract<keyof TBreakpointsConfig, string>, br2?: Extract<keyof TBreakpointsConfig, string> | undefined) => string;
+    only: (br: Extract<keyof TBreakpointsConfig, string>) => string;
+};
+export default getMediaQueryWidthResolvers;

package/getMediaQueryWidthResolvers.js

@@ -0,0 +1,67 @@
+import { __assign } from "tslib";
+export function getMediaQueryWidthResolvers(customBreakpoints) {
+    var breakpoints = __assign({ xs: 0 }, customBreakpoints);
+    var sortedBreakpointsNames = Object.keys(breakpoints).map(function (key) {
+        var br = key;
+        return [br, breakpoints[br]];
+    })
+        .sort(function (a, b) { return a[1] - b[1]; })
+        .map(function (item) { return item[0]; });
+    var getNextBreakpoint = function (breakpoint) {
+        var index = sortedBreakpointsNames.indexOf(breakpoint);
+        return sortedBreakpointsNames[index + 1];
+    };
+    /**
+     * It behaves the same as `(min-width: ${value}px)`
+     * where value is the given breakpoint value.
+     * For ease of use this can be used both as a function `min("md")` and as an
+     * object literal `min.md`.
+     */
+    var min = function (br) { return "(min-width: ".concat(breakpoints[br], "px)"); };
+    /**
+     * It behaves the same as `(max-width: ${value}px)`
+     * where value is the given breakpoint value.
+     * For ease of use this can be used both as a function `max("md")` and as an
+     * object literal `max.md`.
+     */
+    var max = function (br) { return "(max-width: ".concat(breakpoints[br] - 0.02, "px)"); };
+    /**
+     * It behaves the same as `min`
+     * @inheritdoc {max}
+     */
+    var up = min;
+    /**
+     * It behaves similarly to `max` but you will use the "next" breakpoint,
+     * specifying CSS that will apply from the given breakpoint and down.
+     */
+    var down = function (br) {
+        var brNext = getNextBreakpoint(br);
+        // TODO: if br does not exists otherwise throw Error
+        return brNext && "(max-width: ".concat(breakpoints[brNext] - 0.02, "px)");
+    };
+    /**
+     * Media query between the two given breakpoints
+     */
+    var between = function (br1, br2) {
+        return br2
+            ? "(min-width: ".concat(breakpoints[br1], "px) and (max-width: ").concat(breakpoints[br2] - 0.02, "px)")
+            : min(br1);
+    };
+    /**
+     * Media query to apply from the given breakpoint until the next, just for its
+     * full range
+     */
+    var only = function (br) {
+        var brNext = getNextBreakpoint(br);
+        return brNext ? between(br, brNext) : min(br);
+    };
+    return {
+        max: max,
+        min: min,
+        down: down,
+        up: up,
+        between: between,
+        only: only,
+    };
+}
+export default getMediaQueryWidthResolvers;

package/index.d.ts

@@ -20,6 +20,7 @@ export * from "./ensureInt";
 export * from "./findDuplicatedIndexes";
 export * from "./getEmptyArray";
 export * from "./getKeys";
+export * from "./getMediaQueryWidthResolvers";
 export * from "./getNonce";
 export * from "./getParamAmong";
 export * from "./getParamAsInt";

package/index.js

@@ -21,6 +21,7 @@ export * from "./ensureInt";
 export * from "./findDuplicatedIndexes";
 export * from "./getEmptyArray";
 export * from "./getKeys";
+export * from "./getMediaQueryWidthResolvers";
 export * from "./getNonce";
 export * from "./getParamAmong";
 export * from "./getParamAsInt";

package/invariant.d.ts

@@ -0,0 +1,19 @@
+/**
+ * FIXME: invariant calls do not get tree shaked in minified output of projects
+ * using it. Let's not use it internally and not export it from `@koine/utils`
+ * until we find a tree-shakeable way of doing this. For now just wrapping
+ * the logging code into `if (process.env["NODE_ENV"] !== "production") {}`
+ * works better despite it is more verbose.
+ *
+ * @resources
+ * - https://github.com/alexreardon/tiny-invariant
+ * - https://github.com/zertosh/invariant
+ * - https://stackoverflow.com/q/39055159/1938970
+ *
+ * @param condition The condition that, if `true` will throw the error during development
+ * @param message A string or a function that returns a string
+ * @param lib The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ * @param prefix The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ */
+export declare function invariant(condition: any, message?: string | (() => string), lib?: string, prefix?: string): asserts condition;
+export default invariant;

package/invariant.js

@@ -0,0 +1,34 @@
+/**
+ * FIXME: invariant calls do not get tree shaked in minified output of projects
+ * using it. Let's not use it internally and not export it from `@koine/utils`
+ * until we find a tree-shakeable way of doing this. For now just wrapping
+ * the logging code into `if (process.env["NODE_ENV"] !== "production") {}`
+ * works better despite it is more verbose.
+ *
+ * @resources
+ * - https://github.com/alexreardon/tiny-invariant
+ * - https://github.com/zertosh/invariant
+ * - https://stackoverflow.com/q/39055159/1938970
+ *
+ * @param condition The condition that, if `true` will throw the error during development
+ * @param message A string or a function that returns a string
+ * @param lib The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ * @param prefix The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ */
+export function invariant(condition, message, lib, prefix) {
+    if (process.env["NODE_ENV"] !== "production") {
+        if (condition) {
+            return;
+        }
+        var msgProvided = typeof message === "function" ? message() : message;
+        var msgPrefix = "";
+        if (lib && prefix) {
+            msgPrefix = "[".concat(lib, ":").concat(prefix, "] ");
+        }
+        else if (lib) {
+            msgPrefix = "[".concat(lib, "] ");
+        }
+        throw new Error(msgPrefix + msgProvided);
+    }
+}
+export default invariant;

package/node/getMediaQueryWidthResolvers.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMediaQueryWidthResolvers = void 0;
+var tslib_1 = require("tslib");
+function getMediaQueryWidthResolvers(customBreakpoints) {
+    var breakpoints = tslib_1.__assign({ xs: 0 }, customBreakpoints);
+    var sortedBreakpointsNames = Object.keys(breakpoints).map(function (key) {
+        var br = key;
+        return [br, breakpoints[br]];
+    })
+        .sort(function (a, b) { return a[1] - b[1]; })
+        .map(function (item) { return item[0]; });
+    var getNextBreakpoint = function (breakpoint) {
+        var index = sortedBreakpointsNames.indexOf(breakpoint);
+        return sortedBreakpointsNames[index + 1];
+    };
+    /**
+     * It behaves the same as `(min-width: ${value}px)`
+     * where value is the given breakpoint value.
+     * For ease of use this can be used both as a function `min("md")` and as an
+     * object literal `min.md`.
+     */
+    var min = function (br) { return "(min-width: ".concat(breakpoints[br], "px)"); };
+    /**
+     * It behaves the same as `(max-width: ${value}px)`
+     * where value is the given breakpoint value.
+     * For ease of use this can be used both as a function `max("md")` and as an
+     * object literal `max.md`.
+     */
+    var max = function (br) { return "(max-width: ".concat(breakpoints[br] - 0.02, "px)"); };
+    /**
+     * It behaves the same as `min`
+     * @inheritdoc {max}
+     */
+    var up = min;
+    /**
+     * It behaves similarly to `max` but you will use the "next" breakpoint,
+     * specifying CSS that will apply from the given breakpoint and down.
+     */
+    var down = function (br) {
+        var brNext = getNextBreakpoint(br);
+        // TODO: if br does not exists otherwise throw Error
+        return brNext && "(max-width: ".concat(breakpoints[brNext] - 0.02, "px)");
+    };
+    /**
+     * Media query between the two given breakpoints
+     */
+    var between = function (br1, br2) {
+        return br2
+            ? "(min-width: ".concat(breakpoints[br1], "px) and (max-width: ").concat(breakpoints[br2] - 0.02, "px)")
+            : min(br1);
+    };
+    /**
+     * Media query to apply from the given breakpoint until the next, just for its
+     * full range
+     */
+    var only = function (br) {
+        var brNext = getNextBreakpoint(br);
+        return brNext ? between(br, brNext) : min(br);
+    };
+    return {
+        max: max,
+        min: min,
+        down: down,
+        up: up,
+        between: between,
+        only: only,
+    };
+}
+exports.getMediaQueryWidthResolvers = getMediaQueryWidthResolvers;
+exports.default = getMediaQueryWidthResolvers;

package/node/index.js

@@ -24,6 +24,7 @@ tslib_1.__exportStar(require("./ensureInt"), exports);
 tslib_1.__exportStar(require("./findDuplicatedIndexes"), exports);
 tslib_1.__exportStar(require("./getEmptyArray"), exports);
 tslib_1.__exportStar(require("./getKeys"), exports);
+tslib_1.__exportStar(require("./getMediaQueryWidthResolvers"), exports);
 tslib_1.__exportStar(require("./getNonce"), exports);
 tslib_1.__exportStar(require("./getParamAmong"), exports);
 tslib_1.__exportStar(require("./getParamAsInt"), exports);

package/node/invariant.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invariant = void 0;
+/**
+ * FIXME: invariant calls do not get tree shaked in minified output of projects
+ * using it. Let's not use it internally and not export it from `@koine/utils`
+ * until we find a tree-shakeable way of doing this. For now just wrapping
+ * the logging code into `if (process.env["NODE_ENV"] !== "production") {}`
+ * works better despite it is more verbose.
+ *
+ * @resources
+ * - https://github.com/alexreardon/tiny-invariant
+ * - https://github.com/zertosh/invariant
+ * - https://stackoverflow.com/q/39055159/1938970
+ *
+ * @param condition The condition that, if `true` will throw the error during development
+ * @param message A string or a function that returns a string
+ * @param lib The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ * @param prefix The library name to show in the error message prefix. When `lib` is also specified it outputs `[lib:prefix]: the message`, otherwise just `[lib|prefix]: the message`)
+ */
+function invariant(condition, message, lib, prefix) {
+    if (process.env["NODE_ENV"] !== "production") {
+        if (condition) {
+            return;
+        }
+        var msgProvided = typeof message === "function" ? message() : message;
+        var msgPrefix = "";
+        if (lib && prefix) {
+            msgPrefix = "[".concat(lib, ":").concat(prefix, "] ");
+        }
+        else if (lib) {
+            msgPrefix = "[".concat(lib, "] ");
+        }
+        throw new Error(msgPrefix + msgProvided);
+    }
+}
+exports.invariant = invariant;
+exports.default = invariant;

package/package.json

@@ -9,7 +9,7 @@
     "tslib": "^2.4.0"
   },
   "peerDependencies": {},
-  "version": "1.0.85",
+  "version": "1.0.86",
   "module": "./index.js",
   "types": "./index.d.ts"
 }