@becollective/utils 1.6.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
+---
+
+
+