@becollective/utils 1.7.1 → 1.7.2

package/.semaphore/utils.yml

@@ -0,0 +1,44 @@
+version: v1.0
+name: @becollective/utils
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+blocks:
+  - name: Test
+    task:
+      secrets:
+        - name: NPM
+        - name: BUILD_DEPRECATED
+      prologue:
+        commands:
+          - checkout
+          - export AWS_ACCESS_KEY_ID=$AWS_BUILD_DEPRECATED_ACCESS_KEY
+          - export AWS_SECRET_ACCESS_KEY=$AWS_BUILD_DEPRECATED_SECRET_ACCESS_KEY
+      jobs:
+        - name: Test
+          commands:
+            - cd ./packages/utils
+            - npm ci
+            - npm run test
+  - name: Publish
+    skip:
+      when: "branch != 'master'"
+    task:
+      secrets:
+        - name: NPM
+        - name: BUILD_DEPRECATED
+      env_vars:
+        - name: PACKAGE_DIR
+          value: ./packages/utils
+      prologue:
+        commands:
+          - checkout
+          - export AWS_ACCESS_KEY_ID=$AWS_BUILD_DEPRECATED_ACCESS_KEY
+          - export AWS_SECRET_ACCESS_KEY=$AWS_BUILD_DEPRECATED_SECRET_ACCESS_KEY
+      jobs:
+        - name: Publish
+          commands:
+            - echo "deploying @becollective/utils"
+            - sh ./.semaphore/deployer.sh
+

package/README.md

@@ -0,0 +1,133 @@
+# @becollective/utils
+
+## Description
+---
+A collection of helper methods for handling regional issues, feature-flags and password checking functionality.
+
+These include:
+- Age, underSixteen and date diff checks
+- Turns shift dates into readable text
+- Fetch feature-flags from feature flag service
+- Get a tagged home location from a list of locations
+- Money formatting strings
+- Password checks
+
+## :computer: Pre-requisites
+---
+Some projects have different node versions I would recommend using:
+[nvm](https://github.com/nvm-sh/nvm/blob/master/README.md)
+
+node version for api: `node:14-alpine`
+
+Ensure you have done the following in the [confluence](https://becollective.atlassian.net/wiki/spaces/ENGINEERIN/pages/1605849/Setup+Local+Development+Environment) link
+
+- `Setup Local Development Environment`
+
+- `Dependency services for local Be Collective Services`
+
+## :wave: Getting started
+---
+- Clone the repository
+
+```
+git clone  <https://github.com/tickboxAU/becollective-npm.git>
+```
+
+```
+cd becollective-npm
+```
+```
+cd packages/utils
+```
+
+```
+bcDocker
+```
+- `bcDocker` [confluence](https://becollective.atlassian.net/wiki/spaces/ENGINEERIN/pages/1605849/1+-+Setup+Local+Development+Environment#Dependency-services-for-local-Be-Collective-Services)
+
+- Install dependencies
+```
+npm install
+```
+
+- how to run tests
+```
+npm run test
+```
+
+- how to build
+```
+npm run build
+```
+
+## Project Structure
+---
+The folder structure of this project is explained below:
+
+| Name                    | Description                                         |
+|-------------------------|-----------------------------------------------------|
+| **node_modules**        | Contains all  npm dependencies                      |
+| **.semaphore**          | Contains the deployment yml for semaphore           |
+| **src/date-time**       | Date-time helper methods                            |
+| **src/FeatureFlag**     | Feature flag helper methods                         |
+| **src/locality**        | Location helper methods                             |
+| **src/money**           | Money string helper methods                         |
+| **src/opportunity**     | Opportunity types                                   |
+| **src/opportunityUser** | Opportunity time helper methods                     |
+| **src/password**        | Password validation helper methods                  |
+| **tests**               | Contain all tests                                   |
+| **jestconfig.js**       | Test configuration                                  |      
+| **package.json**        | Contains npm dependencies as well as build scripts  |    
+| **rollup.config.js**    | config for babel and rollup combination             |
+| **setup.ts**            | Test setup script                                   |    
+| **tsconfig.json**       | Config settings for TS transpiling                  |
+| **tslint.json**         | Config settings for TSLint code style checking      |
+
+### :sparkles: Guidelines
+---
+Remember that these packages will be consumed by other services, many of which are lambda's that have strict size restrictions.
+Please be mindful of any packages you add here, as they could potentially cause inoperable deployments of ingesting services.
+*Basically, only import if you really, really need it*
+
+## Import and usage syntax
+```
+import {
+    isUnderSixteen,
+    FeatureFlag,
+    getAge,
+    getCurrencyFromCurrencyCode 
+    makeMoneyString,
+    password
+} from '@becollective/utils';
+
+const isUnderSixteen = isUnderSixteen(birthdate);
+
+const featureFlag = new FeatureFlag();
+const isFeatureActive = await featureFlag.isFeatureActive(
+  'this-is-a-feature-key',
+  { env: process.env.APP_ENV },
+);
+
+const ageInYears = getAge(birthdate);
+
+const currency = getCurrencyFromCurrencyCode('AUD');
+
+const dollarDollarBills = makeMoneyString({ amount: 100, currencyCode: 'AUD' });
+
+const isValid = password.isValid('this-is-a-password');
+```
+
+---
+### Running npm scripts
+
+| Npm Script        | Description                                |
+|-------------------|--------------------------------------------|
+| `npm run test`    | Run the tests                              |
+| `npm run build`   | runs rollup                                |
+| `npm run prepare` | runs build (not sure why this is required) |                                                                                                                                                                                                
+
+### :red_circle: Common Issues & FAQ
+---
+
+
+

package/bundle.js

@@ -35,7 +35,7 @@ var password = {
   validate: function validate(input) {
     if (typeof input !== 'string') {
       throw new Error('not-string');
-    } else if (input.length < 8) {
+    } else if (input.length < 12) {
       throw new Error('invalid-length');
     }
 
@@ -2843,54 +2843,38 @@ var followRedirects = wrap({ http: http__default['default'], https: https__defau
 var wrap_1 = wrap;
 followRedirects.wrap = wrap_1;
 
-var _args = [
-	[
-		"axios@0.21.1",
-		"/codefresh/volume/becollective-npm/packages/utils"
-	]
-];
-var _from = "axios@0.21.1";
-var _id = "axios@0.21.1";
-var _inBundle = false;
-var _integrity = "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==";
-var _location = "/axios";
-var _phantomChildren = {
+var name = "axios";
+var version = "0.21.1";
+var description = "Promise based HTTP client for the browser and node.js";
+var main = "index.js";
+var scripts = {
+	test: "grunt test && bundlesize",
+	start: "node ./sandbox/server.js",
+	build: "NODE_ENV=production grunt build",
+	preversion: "npm test",
+	version: "npm run build && grunt version && git add -A dist && git add CHANGELOG.md bower.json package.json",
+	postversion: "git push && git push --tags",
+	examples: "node ./examples/server.js",
+	coveralls: "cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
+	fix: "eslint --fix lib/**/*.js"
 };
-var _requested = {
-	type: "version",
-	registry: true,
-	raw: "axios@0.21.1",
-	name: "axios",
-	escapedName: "axios",
-	rawSpec: "0.21.1",
-	saveSpec: null,
-	fetchSpec: "0.21.1"
+var repository = {
+	type: "git",
+	url: "https://github.com/axios/axios.git"
 };
-var _requiredBy = [
-	"/"
+var keywords = [
+	"xhr",
+	"http",
+	"ajax",
+	"promise",
+	"node"
 ];
-var _resolved = "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz";
-var _spec = "0.21.1";
-var _where = "/codefresh/volume/becollective-npm/packages/utils";
-var author = {
-	name: "Matt Zabriskie"
-};
-var browser = {
-	"./lib/adapters/http.js": "./lib/adapters/xhr.js"
-};
+var author = "Matt Zabriskie";
+var license = "MIT";
 var bugs = {
 	url: "https://github.com/axios/axios/issues"
 };
-var bundlesize = [
-	{
-		path: "./dist/axios.min.js",
-		threshold: "5kB"
-	}
-];
-var dependencies = {
-	"follow-redirects": "^1.10.0"
-};
-var description = "Promise based HTTP client for the browser and node.js";
+var homepage = "https://github.com/axios/axios";
 var devDependencies = {
 	bundlesize: "^0.17.0",
 	coveralls: "^3.0.0",
@@ -2928,67 +2912,40 @@ var devDependencies = {
 	webpack: "^1.13.1",
 	"webpack-dev-server": "^1.14.1"
 };
-var homepage = "https://github.com/axios/axios";
-var jsdelivr = "dist/axios.min.js";
-var keywords = [
-	"xhr",
-	"http",
-	"ajax",
-	"promise",
-	"node"
-];
-var license = "MIT";
-var main = "index.js";
-var name = "axios";
-var repository = {
-	type: "git",
-	url: "git+https://github.com/axios/axios.git"
-};
-var scripts = {
-	build: "NODE_ENV=production grunt build",
-	coveralls: "cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
-	examples: "node ./examples/server.js",
-	fix: "eslint --fix lib/**/*.js",
-	postversion: "git push && git push --tags",
-	preversion: "npm test",
-	start: "node ./sandbox/server.js",
-	test: "grunt test && bundlesize",
-	version: "npm run build && grunt version && git add -A dist && git add CHANGELOG.md bower.json package.json"
+var browser = {
+	"./lib/adapters/http.js": "./lib/adapters/xhr.js"
 };
-var typings = "./index.d.ts";
+var jsdelivr = "dist/axios.min.js";
 var unpkg = "dist/axios.min.js";
-var version = "0.21.1";
+var typings = "./index.d.ts";
+var dependencies = {
+	"follow-redirects": "^1.10.0"
+};
+var bundlesize = [
+	{
+		path: "./dist/axios.min.js",
+		threshold: "5kB"
+	}
+];
 var pkg = {
-	_args: _args,
-	_from: _from,
-	_id: _id,
-	_inBundle: _inBundle,
-	_integrity: _integrity,
-	_location: _location,
-	_phantomChildren: _phantomChildren,
-	_requested: _requested,
-	_requiredBy: _requiredBy,
-	_resolved: _resolved,
-	_spec: _spec,
-	_where: _where,
+	name: name,
+	version: version,
+	description: description,
+	main: main,
+	scripts: scripts,
+	repository: repository,
+	keywords: keywords,
 	author: author,
-	browser: browser,
+	license: license,
 	bugs: bugs,
-	bundlesize: bundlesize,
-	dependencies: dependencies,
-	description: description,
-	devDependencies: devDependencies,
 	homepage: homepage,
+	devDependencies: devDependencies,
+	browser: browser,
 	jsdelivr: jsdelivr,
-	keywords: keywords,
-	license: license,
-	main: main,
-	name: name,
-	repository: repository,
-	scripts: scripts,
-	typings: typings,
 	unpkg: unpkg,
-	version: version
+	typings: typings,
+	dependencies: dependencies,
+	bundlesize: bundlesize
 };
 
 var httpFollow = followRedirects.http;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@becollective/utils",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "description": "Common utilities",
   "main": "bundle.js",
   "scripts": {

package/src/password.js

@@ -11,7 +11,7 @@ export const password = {
   validate: (input) => {
     if(typeof input !== 'string') {
       throw new Error('not-string');
-    } else if(input.length < 8) {
+    } else if(input.length < 12) {
       throw new Error('invalid-length');
     }
 

package/tests/password.test.js

@@ -2,7 +2,7 @@ const util = require('../bundle.js');
 
 describe('password.valiate', () => {
   test('validate a valid password', async () => {
-    const password = 'Password123';
+    const password = 'Password123456';
     let result;
     try {
       result = util.password.validate(password);
@@ -18,13 +18,13 @@ describe('password.valiate', () => {
     }).toThrow('invalid-length');
   }, 1000);
   test('validate a one rule password', async () => {
-    const password = 'foobarab';
+    const password = 'foobarabpcip';
     expect(() => {
       util.password.validate(password);
     }).toThrow('invalid-minimum-rules');
   }, 1000);
   test('validate a two rule password', async () => {
-    const password = 'foobar123';
+    const password = 'foobarpcip123';
     expect(() => {
       util.password.validate(password);
     }).toThrow('invalid-minimum-rules');