@squiz/optimization-utils 3.0.0 → 3.1.0

package/dist/array/__tests__/chunkify.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/array/__tests__/chunkify.test.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chunkify_1 = require("../chunkify");
+describe('Chunkify Function', () => {
+    it('should chunk array into smaller arrays', () => {
+        const input = [1, 2, 3, 4, 5];
+        const size = 2;
+        const expectedOutput = [[1, 2], [3, 4], [5]];
+        expect((0, chunkify_1.chunkify)(input, size)).toEqual(expectedOutput);
+    });
+    it('should return single chunk if size is greater than array length', () => {
+        const input = [1, 2, 3];
+        const size = 5;
+        const expectedOutput = [[1, 2, 3]];
+        expect((0, chunkify_1.chunkify)(input, size)).toEqual(expectedOutput);
+    });
+    it('should return empty array if input is empty', () => {
+        const input = [];
+        const size = 2;
+        const expectedOutput = [];
+        expect((0, chunkify_1.chunkify)(input, size)).toEqual(expectedOutput);
+    });
+    it('should throw error if size is less than 1', () => {
+        const input = [1, 2, 3];
+        const size = 0;
+        expect(() => (0, chunkify_1.chunkify)(input, size)).toThrow('Size must be greater than 0');
+    });
+});
+//# sourceMappingURL=chunkify.test.js.map

package/dist/array/__tests__/chunkify.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chunkify.test.js","sourceRoot":"","sources":["../../../src/array/__tests__/chunkify.test.ts"],"names":[],"mappings":";;AAAA,0CAAuC;AAEvC,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,MAAM,IAAI,GAAG,CAAC,CAAC;QACf,MAAM,cAAc,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE7C,MAAM,CAAC,IAAA,mBAAQ,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACxB,MAAM,IAAI,GAAG,CAAC,CAAC;QACf,MAAM,cAAc,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAEnC,MAAM,CAAC,IAAA,mBAAQ,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,CAAC,CAAC;QACf,MAAM,cAAc,GAAyB,EAAE,CAAC;QAEhD,MAAM,CAAC,IAAA,mBAAQ,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACxB,MAAM,IAAI,GAAG,CAAC,CAAC;QAEf,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,mBAAQ,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/array/chunkify.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.chunkify = void 0;
 const chunkify = (input, size) => {
+    if (size === 0) {
+        throw new RangeError(`Size must be greater than 0`);
+    }
     const result = [];
     for (let i = 0; i < input.length; i += size) {
         result.push(input.slice(i, i + size));

package/dist/array/chunkify.js.map

@@ -1 +1 @@
-{"version":3,"file":"chunkify.js","sourceRoot":"","sources":["../../src/array/chunkify.ts"],"names":[],"mappings":";;;AAAO,MAAM,QAAQ,GAAG,CAAI,KAAe,EAAE,IAAY,EAAmB,EAAE;IAC5E,MAAM,MAAM,GAAoB,EAAE,CAAC;IAEnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AARW,QAAA,QAAQ,YAQnB"}
+{"version":3,"file":"chunkify.js","sourceRoot":"","sources":["../../src/array/chunkify.ts"],"names":[],"mappings":";;;AAAO,MAAM,QAAQ,GAAG,CAAI,KAAe,EAAE,IAAY,EAAmB,EAAE;IAC5E,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;QACf,MAAM,IAAI,UAAU,CAAC,6BAA6B,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,MAAM,GAAoB,EAAE,CAAC;IAEnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAZW,QAAA,QAAQ,YAYnB"}

package/dist/array/index.d.ts

@@ -0,0 +1,2 @@
+export * from './chunkify';
+export * from './uniqueWith';

package/dist/array/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./chunkify"), exports);
+__exportStar(require("./uniqueWith"), exports);
+//# sourceMappingURL=index.js.map

package/dist/array/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/array/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,+CAA6B"}

package/dist/data-structures/Result.d.ts

@@ -0,0 +1,22 @@
+export declare class Result<T, TError = Error> {
+    readonly type: 'success' | 'failure';
+    readonly data?: T;
+    readonly error?: TError;
+    private constructor();
+    static success<U>(data?: U): Result<U, never>;
+    static failure<TError>(error: TError): Result<never, TError>;
+    isSuccess(): this is Result<T, never> & {
+        type: 'success';
+        data: T;
+    };
+    isFailure(): this is Result<never, TError> & {
+        type: 'failure';
+        error: TError;
+    };
+    throw(): never | void;
+    unwrap(): T;
+    match<TResult, TErrorResult>(handlers: {
+        success: (data: T, resultThis: Result<T, TError>) => TResult;
+        failure: (error: TError, resultThis: Result<T, TError>) => TErrorResult;
+    }): TResult | TErrorResult;
+}

package/dist/data-structures/Result.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Result = void 0;
+class Result {
+    type;
+    data;
+    error;
+    constructor(type, data, error) {
+        this.type = type;
+        this.data = data;
+        this.error = error;
+    }
+    static success(data) {
+        return new Result('success', data, undefined);
+    }
+    static failure(error) {
+        return new Result('failure', undefined, error);
+    }
+    isSuccess() {
+        return this.type === 'success';
+    }
+    isFailure() {
+        return this.type === 'failure';
+    }
+    throw() {
+        if (this.error) {
+            throw this.error;
+        }
+    }
+    unwrap() {
+        if (this.isFailure()) {
+            throw this.error;
+        }
+        else {
+            return this.data;
+        }
+    }
+    match(handlers) {
+        if (this.isSuccess()) {
+            return handlers.success(this.data, this);
+        }
+        else {
+            return handlers.failure(this.error, this);
+        }
+    }
+}
+exports.Result = Result;
+//# sourceMappingURL=Result.js.map

package/dist/data-structures/Result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Result.js","sourceRoot":"","sources":["../../src/data-structures/Result.ts"],"names":[],"mappings":";;;AAAA,MAAa,MAAM;IACD,IAAI,CAAwB;IAC5B,IAAI,CAAK;IACT,KAAK,CAAU;IAE/B,YAAoB,IAA2B,EAAE,IAAQ,EAAE,KAAc;QACvE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,OAAO,CAAI,IAAQ;QACxB,OAAO,IAAI,MAAM,CAAW,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;IAED,MAAM,CAAC,OAAO,CAAS,KAAa;QAClC,OAAO,IAAI,MAAM,CAAgB,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACjC,CAAC;IAED,SAAS;QAIP,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACjC,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,KAAK,CAAC;QACnB,CAAC;IACH,CAAC;IAED,MAAM;QACJ,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACrB,MAAM,IAAI,CAAC,KAAK,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,IAAK,CAAC;QACpB,CAAC;IACH,CAAC;IAED,KAAK,CAAwB,QAG5B;QACC,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAK,EAAE,IAAI,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAM,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;CACF;AAtDD,wBAsDC"}

package/dist/data-structures/index.d.ts

@@ -0,0 +1 @@
+export * from './Result';

package/dist/data-structures/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Result"), exports);
+//# sourceMappingURL=index.js.map

package/dist/data-structures/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data-structures/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB"}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export * from './types/utilities';
-export * from './object/getProperty';
-export * from './array/uniqueWith';
-export * from './array/chunkify';
+export * from './data-structures';
+export * from './array';
+export * from './object';
+export * from './types';

package/dist/index.js

@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types/utilities"), exports);
-__exportStar(require("./object/getProperty"), exports);
-__exportStar(require("./array/uniqueWith"), exports);
-__exportStar(require("./array/chunkify"), exports);
+__exportStar(require("./data-structures"), exports);
+__exportStar(require("./array"), exports);
+__exportStar(require("./object"), exports);
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAElC,uDAAqC;AAErC,qDAAmC;AACnC,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,0CAAwB;AACxB,2CAAyB;AACzB,0CAAwB"}

package/dist/object/index.d.ts

@@ -0,0 +1 @@
+export * from './getProperty';

package/dist/object/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./getProperty"), exports);
+//# sourceMappingURL=index.js.map

package/dist/object/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/object/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B"}

package/dist/types/{utilities.js → class-utilities-types.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=utilities.js.map
+//# sourceMappingURL=class-utilities-types.js.map

package/dist/types/class-utilities-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"class-utilities-types.js","sourceRoot":"","sources":["../../src/types/class-utilities-types.ts"],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './class-utilities-types';

package/dist/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./class-utilities-types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/optimization-utils",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,6 +9,27 @@
     "build": "tsc",
     "build:check": "tsc --noEmit"
   },
+  "exports": {
+    ".": {
+      "default": "./dist/index.js"
+    },
+    "./array": {
+      "default": "./dist/array/index.js",
+      "types": "./dist/array/index.d.ts"
+    },
+    "./object": {
+      "default": "./dist/object/index.js",
+      "types": "./dist/object/index.d.ts"
+    },
+    "./data-structures": {
+      "default": "./dist/data-structures/index.js",
+      "types": "./dist/data-structures/index.d.ts"
+    },
+    "./types": {
+      "default": "./dist/types/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
   "dependencies": {},
   "devDependencies": {},
   "author": "",

package/dist/types/utilities.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../../src/types/utilities.ts"],"names":[],"mappings":""}