@sparted/shared-library 1.1.8 → 1.2.0

package/.circleci/config.yml

@@ -0,0 +1,40 @@
+# Javascript Node CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-javascript/ for more details
+#
+version: 2.1
+jobs:
+  test:
+    docker:
+      - image: cimg/node:18.10.0
+
+    steps:
+      - checkout
+
+      - run:
+          name: Set npm token
+          command: 'echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc'
+
+      - run:
+          name: Install node modules
+          command: yarn
+
+      - run:
+          name: Check lint
+          command: yarn lint
+
+      - run:
+          name: Run tests
+          # Limit resources as the default parameters overload the CPU of the machine and makes tests hang
+          command: yarn test --maxWorkers=50%
+
+      - run:
+          name: Build
+          command: yarn build
+
+workflows:
+  version: 2
+
+  autodeploy:
+    jobs:
+      - test

package/.eslintignore

@@ -0,0 +1 @@
+dist/

package/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "env": {
+    "es2021": true,
+    "node": true
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "prettier",
+    "import"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "prettier"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "rules": {
+    "prettier/prettier": "warn",
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/ban-types": "warn",
+    "@typescript-eslint/ban-ts-comment": "warn"
+  }
+}

package/.gitignore

@@ -0,0 +1,37 @@
+*.dat
+*.iml
+*.log
+*.out
+*.pid
+*.seed
+*.sublime-*
+*.swo
+*.swp
+*.tgz
+*.xml
+.tmp
+.env
+doc/*.json
+
+# Mac Related files
+.DS_Store
+
+# IDE Related Files
+.idea
+.project
+
+# eslint
+.eslintcache
+
+# jest
+jest-stare
+
+# JS Related files
+bower_components
+npm-debug.log
+node_modules
+nestjs/node_modules
+.npmrc
+
+# Build
+dist

package/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

package/.idea/codeStyles/Project.xml

@@ -0,0 +1,35 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <JSCodeStyleSettings version="0">
+      <option name="VAR_DECLARATION_WRAP" value="2" />
+      <option name="OBJECT_LITERAL_WRAP" value="2" />
+    </JSCodeStyleSettings>
+    <TypeScriptCodeStyleSettings version="0">
+      <option name="VAR_DECLARATION_WRAP" value="2" />
+      <option name="OBJECT_LITERAL_WRAP" value="2" />
+    </TypeScriptCodeStyleSettings>
+    <codeStyleSettings language="JavaScript">
+      <option name="BLOCK_COMMENT_ADD_SPACE" value="true" />
+      <option name="KEEP_BLANK_LINES_IN_CODE" value="1" />
+      <option name="METHOD_CALL_CHAIN_WRAP" value="2" />
+      <option name="IF_BRACE_FORCE" value="1" />
+      <option name="DOWHILE_BRACE_FORCE" value="1" />
+      <option name="WHILE_BRACE_FORCE" value="1" />
+      <option name="FOR_BRACE_FORCE" value="1" />
+    </codeStyleSettings>
+    <codeStyleSettings language="TypeScript">
+      <option name="BLOCK_COMMENT_ADD_SPACE" value="true" />
+      <option name="KEEP_BLANK_LINES_IN_CODE" value="1" />
+      <option name="METHOD_CALL_CHAIN_WRAP" value="2" />
+      <option name="IF_BRACE_FORCE" value="1" />
+      <option name="DOWHILE_BRACE_FORCE" value="1" />
+      <option name="WHILE_BRACE_FORCE" value="1" />
+      <option name="FOR_BRACE_FORCE" value="1" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/jsLinters/eslint.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="EslintConfiguration">
+    <option name="fix-on-save" value="true" />
+  </component>
+</project>

package/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/shared-library.iml" filepath="$PROJECT_DIR$/.idea/shared-library.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/shared-library.iml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/dist" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/.idea/workspace.xml

@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AutoImportSettings">
+    <option name="autoReloadType" value="SELECTIVE" />
+  </component>
+  <component name="ChangeListManager">
+    <list default="true" id="9c51afc7-3a2a-462c-a7b1-b3e0ca474b0c" name="Changes" comment="" />
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="GoLibraries">
+    <option name="indexEntireGoPath" value="true" />
+  </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectId" id="2LBBaAUnkGvlewEioyoXgDTb3Rx" />
+  <component name="ProjectLevelVcsManager">
+    <ConfirmationsSetting value="2" id="Add" />
+  </component>
+  <component name="ProjectViewState">
+    <option name="autoscrollFromSource" value="true" />
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.go.formatter.settings.were.checked&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.go.migrated.go.modules.settings&quot;: &quot;true&quot;,
+    &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
+    &quot;dart.analysis.tool.window.visible&quot;: &quot;false&quot;,
+    &quot;git-widget-placeholder&quot;: &quot;master&quot;,
+    &quot;go.import.settings.migrated&quot;: &quot;true&quot;,
+    &quot;last_opened_file_path&quot;: &quot;/Users/cchampou/dev/shared-library&quot;,
+    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
+    &quot;node.js.detected.package.standard&quot;: &quot;true&quot;,
+    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
+    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
+    &quot;node.js.selected.package.standard&quot;: &quot;&quot;,
+    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
+    &quot;nodejs_package_manager_path&quot;: &quot;yarn&quot;,
+    &quot;settings.editor.selected.configurable&quot;: &quot;settings.javascript.linters.eslint&quot;,
+    &quot;show.migrate.to.gradle.popup&quot;: &quot;false&quot;,
+    &quot;ts.external.directory.path&quot;: &quot;/Users/cchampou/dev/shared-library/node_modules/typescript/lib&quot;,
+    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
+  }
+}</component>
+  <component name="RecentsManager">
+    <key name="MoveFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/src/business/types" />
+      <recent name="$PROJECT_DIR$/src/types/business" />
+      <recent name="$PROJECT_DIR$/src/business" />
+      <recent name="$PROJECT_DIR$/src/types" />
+    </key>
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="9c51afc7-3a2a-462c-a7b1-b3e0ca474b0c" name="Changes" comment="" />
+      <created>1675334656680</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1675334656680</updated>
+      <workItem from="1675334657881" duration="9370000" />
+      <workItem from="1675413502042" duration="3448000" />
+      <workItem from="1675777811478" duration="2023000" />
+      <workItem from="1676048809145" duration="1369000" />
+      <workItem from="1676285644197" duration="9643000" />
+      <workItem from="1676390431531" duration="720000" />
+      <workItem from="1677080847564" duration="1233000" />
+      <workItem from="1679044878990" duration="2004000" />
+      <workItem from="1689058230559" duration="5032000" />
+      <workItem from="1692285159365" duration="2040000" />
+      <workItem from="1692345932803" duration="2572000" />
+      <workItem from="1692883384801" duration="809000" />
+      <workItem from="1704897952885" duration="6308000" />
+      <workItem from="1704980905659" duration="3963000" />
+      <workItem from="1705481044854" duration="2558000" />
+      <workItem from="1706005322333" duration="2222000" />
+      <workItem from="1706026800654" duration="819000" />
+      <workItem from="1706094026619" duration="442000" />
+      <workItem from="1706107680964" duration="290000" />
+      <workItem from="1706632221330" duration="2165000" />
+      <workItem from="1706773691160" duration="3871000" />
+      <workItem from="1707832197097" duration="500000" />
+      <workItem from="1709718260290" duration="1103000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+  <component name="VgoProject">
+    <integration-enabled>false</integration-enabled>
+    <settings-migrated>true</settings-migrated>
+  </component>
+  <component name="XSLT-Support.FileAssociations.UIState">
+    <expand />
+    <select />
+  </component>
+</project>

package/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 120
+}

package/CHANGELOG.md

@@ -0,0 +1,130 @@
+## 1.2.0
+- Add campaign type
+
+## 1.1.8
+- Add swiping cards direction type
+
+## 1.1.7
+- Change default quality in cdn
+
+## 1.1.6
+- Add Partial Gameplay typeguards
+
+## 1.1.5
+- Add isLanguageCode typeguard 
+
+## 1.1.4
+- Fix: bad publication
+
+## 1.1.3
+- Fix multilingual type adding partial
+
+## 1.1.2
+- Add Gameplay type guards
+
+## 1.1.1
+- Fix publication issue
+
+## 1.1.0
+- Add business entities types
+
+## 1.0.29
+- Add `getContrastColor` function
+
+## 1.0.28
+- Fix `twicpicsTransformationQueries` function to have integer values
+
+## 1.0.27
+- Add `isStringLengthWithinRange` function
+
+## 1.0.26
+- Add `innerJoin` to `index.ts`
+
+## 1.0.25
+- Add `innerJoin` function for arrays
+- Modify `leftOutterJoin` function implementation
+
+## 1.0.24
+- Add `leftOutterJoin` function for arrays
+
+## 1.0.23
+- Add ability to define constructor params in `ClassType`
+
+## 1.0.22
+- Fix `stripPropertiesFromObject` issue with null values
+
+## 1.0.21
+- Fix exports from `object` directory
+
+## 1.0.20
+- Add `stripPropertiesFromObject` function
+
+## 1.0.19
+- Fix export `median` function
+
+## 1.0.18
+- Add math `median` function 
+
+## 1.0.17
+- Handle device pixel ratio (DPR) in Twicpics transformations
+
+## 1.0.16
+- Set twicpics image quality to 90 
+
+## 1.0.15
+- Handle only width or only height in twicpics transformations
+
+## 1.0.14
+- Fix: bad tarball published 
+
+## 1.0.13
+- Add output format query param
+
+## 1.0.12
+- Add cache version query param
+
+## 1.0.11
+- Add valueOf type
+
+## 1.0.10
+
+## 1.0.9
+- Add option to remove image compression
+
+## 1.0.8
+- Fix crash when passing undefined to extractInfoFromUrl function
+
+## 1.0.7
+- Fix Twicpics resizing
+
+## 1.0.6
+- Add current map to `dataModifier` function on `arrayToMap`
+
+## 1.0.5
+- CDN abstraction for Imgix and Twicpics
+
+## 1.0.0
+- Breaking change: rename date folder into time
+- Export convertion functions from time
+
+## 0.0.18
+- Change update behavior to fully replace updated items
+
+## 0.0.17
+- Remove error thrown when not every items have been visisted
+
+## 0.0.16
+- Fix an issue when initializing an empty linked list
+
+## 0.0.15
+- Rollback target version, change output format
+
+## 0.0.14
+- Bump target version in tsconfig
+
+## 0.0.13
+- Bring most utilities from the back-office, mobile-app and nest to this package (#32q6ude)
+
+## 0.0.1
+- Library initialisation (#2ykhvcg)
+- Fix files taken as packaged

package/README.md

@@ -0,0 +1,26 @@
+# Shared-library
+
+Regroup low levels utils to share across Sparted's projects. Nothing should be platform specific and it should ideally not depend on any external library.
+
+# Publishing
+
+Since we want to be able to do the following sub imports when using the library:
+
+```ts
+import { function1, function2 } from '@sparted/shared-library/array';
+import { function3, function4 } from '@sparted/shared-library/strings';
+```
+
+While also being able to import everything from the root.
+
+We'll need to do some rollup/npm trickery to keep everything tree-shakable and intuitive.
+
+To do so, we copy the package.json inside the generated dist folder when building the library. Then we run `npm publish` from inside the dist folder.
+
+What this do, is take everything inside the dist folder and publish as its standalone package. This enables us to import directly from `@sparted/shared-library/array` without adding `dist` since `dist/array` becomes a root folder. If we do not do this and instead run `npm publish` in the root directory, the package would keep the folder structure and we would need to add `dist` in imports. eg: `@sparted/shared-library/dist/array`.
+
+## How to publish
+
+1. Update the `package.json` version
+2. Run `yarn build-and-publish` (this command assumes the `package.json` version was not already published)
+3. The new version should be commited and pushed

package/dist/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@sparted/shared-library",
+  "version": "1.1.8",
+  "repository": "git@github.com:Sparted/shared-library.git",
+  "author": {
+    "name": "Sparted",
+    "email": "developer@sparted.com",
+    "url": "https://www.sparted.com"
+  },
+  "license": "MIT",
+  "module": "index.js",
+  "main": "index.js",
+  "files": [
+    "**/*",
+    "**/**"
+  ],
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint .",
+    "clean": "rm -rf ./dist",
+    "build": "yarn clean && rollup --config rollup.config.ts --configPlugin typescript2 && cp package.json ./dist/package.json",
+    "build-and-publish": "yarn test && yarn build && (cd ./dist && yarn publish)"
+  },
+  "devDependencies": {
+    "@types/glob": "^8.0.0",
+    "@types/jest": "^29.0.3",
+    "@types/ungap__structured-clone": "^0.3.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "glob": "^8.0.3",
+    "jest": "^29.6.1",
+    "jest-environment-jsdom": "^29.0.3",
+    "jest-extended": "^3.1.0",
+    "jest-fetch-mock": "^3.0.3",
+    "prettier": "2",
+    "rollup": "^2.79.1",
+    "rollup-plugin-typescript2": "^0.34.0",
+    "ts-jest": "^29.0.2",
+    "tslib": "^2.4.0",
+    "typescript": "^4.8.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "ts"
+    ],
+    "setupFilesAfterEnv": [
+      "jest-extended/all"
+    ],
+    "rootDir": ".",
+    "testRegex": [
+      ".*\\.test\\.ts$"
+    ],
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    }
+  },
+  "dependencies": {
+    "@ungap/structured-clone": "^1.2.0",
+    "ts-essentials": "^9.4.1"
+  }
+}

package/global.d.ts

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/no-extraneous-dependencies -- only needed during development
+import 'jest-extended';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sparted/shared-library",
-  "version": "1.1.8",
+  "version": "1.2.0",
   "repository": "git@github.com:Sparted/shared-library.git",
   "author": {
     "name": "Sparted",

package/rollup.config.ts

@@ -0,0 +1,19 @@
+import { glob } from 'glob';
+import typescript from 'rollup-plugin-typescript2';
+
+export default {
+  input: glob.sync('./src/**/index.ts'),
+  plugins: [
+    typescript({
+      exclude: ['**/__tests__', '**/*.test.ts'],
+    }),
+  ],
+  output: [
+    {
+      dir: 'dist',
+      format: 'cjs',
+      sourcemap: true,
+      preserveModules: true, // Keep directory structure and files
+    },
+  ],
+};

package/src/array/__tests__/array-to-map.test.ts

@@ -0,0 +1,50 @@
+import { arrayToMap } from '../array-to-map';
+
+type Item = {
+  id: string,
+  bar: number,
+};
+
+describe('arrayToMap', () => {
+  it('should convert array to map with item containing one key', () => {
+    const array = [{ id: 'toto' }, { id: 'bonjour' }];
+    const map = arrayToMap(array, { selectKey: ({ id }) => id });
+
+    expect(map).toStrictEqual({
+      bonjour: { id: 'bonjour' },
+      toto: { id: 'toto' },
+    });
+  });
+
+  it('should convert array to map and select right key in item', () => {
+    const array = [{ id: 'toto', bar: 1 }, { id: 'bonjour', bar: 2 }];
+    const map = arrayToMap(array, { selectKey: ({ bar }) => bar.toString() });
+
+    expect(map).toStrictEqual({
+      1: { id: 'toto', bar: 1 },
+      2: { id: 'bonjour', bar: 2 },
+    });
+  });
+
+  it('should handle data transformation', () => {
+    const item1: Item = { id: 'toto', bar: 1 };
+    const item2: Item = { id: 'bonjour', bar: 2 };
+    const array = [item1, item2];
+
+    const modifierFn = jest.fn();
+    const map = arrayToMap<Item, string>(array, {
+      selectKey: ({ bar }) => bar.toString(),
+      dataModifier: ({ id }, currentMap) => {
+        modifierFn(currentMap);
+        return id;
+      },
+    });
+
+    expect(modifierFn).toHaveBeenNthCalledWith(1, {});
+    expect(modifierFn).toHaveBeenNthCalledWith(2, { 1: 'toto' });
+    expect(map).toStrictEqual({
+      1: 'toto',
+      2: 'bonjour',
+    });
+  });
+});

package/src/array/__tests__/get-values-from-keys.test.ts

@@ -0,0 +1,14 @@
+import { valuesFromKeys } from '../get-values-from-keys';
+
+describe('valuesFromKeys', () => {
+  it('should transform a map to an array with only selected keys', () => {
+    const map = {
+      uno: 1,
+      dos: 2,
+      tres: 3,
+      quatro: 4,
+    };
+
+    expect(valuesFromKeys(['uno', 'tres'], map)).toStrictEqual([1, 3]);
+  });
+});