@laboratoria/sdk-js 0.1.1 → 0.2.0

package/.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

package/index.js

@@ -5,7 +5,6 @@ import {
   signInWithEmailAndPassword,
   signOut,
 } from 'firebase/auth';
-import { createClient } from './lib/client';
 import { createAPI as createCoreAPI } from './lib/core';
 import { createAPI as createJobsAPI } from './lib/jobs';
 import { createAPI as createTeamAPI } from './lib/team';
@@ -26,31 +25,25 @@ export const createApp = ({
 
   const firebaseAuth = getAuth(firebaseApp);
   const state = { authUser: undefined, user: undefined };
-
-  const setState = (authUser, user) => {
-    Object.assign(state, { authUser, user });
-  };
+  const coreAPI = createCoreAPI(coreApiUrl, state);
+  const teamAPI = createTeamAPI(teamApiUrl, state);
+  const jobsAPI = createJobsAPI(jobsApiUrl, state);
 
   const authAPI = {
     onChange: fn => onAuthStateChanged(firebaseAuth, (authUser) => {
       if (!authUser) {
-        setState(null, null);
+        Object.assign(state, { authUser: null, user: null });
         return fn(state);
       }
-      createClient(coreApiUrl, authUser)(`/users/${authUser.uid}`)
+      Object.assign(state, { authUser });
+      coreAPI.user.findById(authUser.uid)
         .then((user) => {
-          Object.assign(user, {
-            isStaff: ['staff', 'manager', 'finance', 'admin'].includes(user.role),
-            isManager: ['manager', 'finance', 'admin'].includes(user.role),
-            isFinance: ['finance', 'admin'].includes(user.role),
-            isAdmin: user.role === 'admin',
-          });
-          setState(authUser, user);
+          Object.assign(state, { user });
           fn(state);
         })
         .catch((err) => {
           console.error(err);
-          setState(null, null)
+          Object.assign(state, { authUser: null, user: null });
           fn(state);
         });
     }),
@@ -64,8 +57,8 @@ export const createApp = ({
 
   return {
     auth: authAPI,
-    ...createJobsAPI(jobsApiUrl, state),
-    ...createTeamAPI(teamApiUrl, state),
-    ...createCoreAPI(coreApiUrl, state),
+    ...jobsAPI,
+    ...teamAPI,
+    ...coreAPI,
   };
 };

package/lib/core.js

@@ -1,3 +1,4 @@
+import md5 from 'blueimp-md5';
 import { createModels, extendSchemaDefinitions } from './model';
 import schema from '../schemas/core.json';
 
@@ -8,7 +9,7 @@ const extended = {
       'firstName',
       'lastName',
       'email',
-      'locale',
+      'lang',
       'github',
       'linkedin',
       'bio',
@@ -22,17 +23,24 @@ const extended = {
       email: {
         inputType: 'email',
       },
-      locale: {
-        enum: ['es-ES', 'pt-BR'],
-      },
       bio: {
         inputType: 'textarea',
       },
     },
     parse: (props) => {
+      const avatar = (
+        props.github
+          ? `https://github.com/${props.github}.png?size=`
+          : `https://www.gravatar.com/avatar/${md5(props.email)}?s=`
+      )
       return {
         ...props,
         fullName: `${props.firstName} ${props.lastName}`,
+        avatar: size => `${avatar}${size}`,
+        isStaff: ['staff', 'manager', 'finance', 'admin'].includes(props.role),
+        isManager: ['manager', 'finance', 'admin'].includes(props.role),
+        isFinance: ['finance', 'admin'].includes(props.role),
+        isAdmin: props.role === 'admin',
       };
     },
   },
@@ -59,6 +67,26 @@ const extended = {
       `${name}${!stage ? '' : ` - ${stage.name}`} (id: ${id})`
     ),
     properties: {},
+    parse: (props) => {
+      const now = Date.now();
+      const status = (
+        props.start > now
+          ? 'upcoming'
+          : props.end < now
+            ? 'past'
+            : 'active'
+      );
+      const size = (
+        status === 'upcoming' && props.vacancies
+          ? props.vacancies
+          : props._count?.students || props.students?.length || 0
+      );
+      return {
+        ...props,
+        status,
+        size,
+      };
+    },
   },
   Student: {
     inputProps: [],
@@ -71,8 +99,8 @@ const extended = {
       'date',
       'reason',
       'reasonDetail',
-      'project',
-      'stage',
+      'lastProject',
+      'completedProjects',
       'notes',
       'staffSad',
       'covidRelated',

package/lib/model.js

@@ -1,13 +1,21 @@
 import { createClient } from './client.js';
 
+
 const createValidator = (schema) => {
   const properties = schema.properties || {};
   const inputProps = schema.inputProps || Object.keys(properties);
 
   const validateAttr = (key, value) => {
     const attrSchema = properties[key] || {};
-    const type = Array.isArray(attrSchema.type) ? attrSchema.type[0] : attrSchema.type;
-    const isRequired = !Array.isArray(attrSchema.type) || !attrSchema.type.includes('null');
+    const type = (
+      Array.isArray(attrSchema.type)
+        ? attrSchema.type[0]
+        : attrSchema.type
+    );
+    const isRequired = (
+      !Array.isArray(attrSchema.type)
+      || !attrSchema.type.includes('null')
+    );
 
     if (attrSchema.enum) {
       if (!isRequired && !value) {
@@ -85,7 +93,44 @@ const buildDefaultInclude = schema => Object.keys(schema.properties || {}).reduc
 );
 
 
-const createModel = (baseUrl, state, collectionName, schema = {}) => {
+const serializeData = (data, schema) => {
+  const hasInputProps = Array.isArray(schema.inputProps);
+  const payload = Object.keys(data).reduce(
+    (memo, key) => {
+      if (hasInputProps && !schema.inputProps.includes(key)) {
+        return memo;
+      }
+      const prop = (schema.properties || {})[key];
+      const isOptionalRelation = (
+        prop
+        && Array.isArray(prop.anyOf)
+        && prop.anyOf[0].$ref
+        && prop.anyOf[1]
+        && prop.anyOf[1].type === 'null'
+      );
+      if (isOptionalRelation && data[key] === null) {
+        return memo;
+      }
+      return {
+        ...memo,
+        [key]: data[key],
+      };
+    },
+    {},
+  );
+
+  // {
+  //   signupCohort: {
+  //     connect: { id: signupCohort.id },
+  //   },
+  // }
+
+  return payload;
+};
+
+
+export const createModel = (baseUrl, state, collectionName, schema = {}) => {
+  const primaryKey = schema.primaryKey || 'id';
   const validator = createValidator(schema);
   const buildURL = createBuildURL(collectionName);
   const defaultInclude = buildDefaultInclude(schema);
@@ -93,12 +138,12 @@ const createModel = (baseUrl, state, collectionName, schema = {}) => {
   const req = (...args) => createClient(baseUrl, state.authUser)(...args);
   const create = q => req(buildURL(), {
     method: 'POST',
-    body: buildQuery(q),
+    body: buildQuery(Object.assign(q, { data: serializeData(q.data, schema) })),
   });
 
-  const put = q => req(buildURL(q.where.id), {
+  const put = q => req(buildURL(q.where[primaryKey]), {
     method: 'PUT',
-    body: buildQuery(q),
+    body: buildQuery(Object.assign(q, { data: serializeData(q.data, schema) })),
   });
 
   const parse = data => {
@@ -139,7 +184,7 @@ const createModel = (baseUrl, state, collectionName, schema = {}) => {
     create,
     update: put,
     upsert: opts => (
-      !opts.where.id
+      !opts.where[primaryKey]
         ? create({ data: opts.create })
         : put({ where: opts.where, data: opts.update })
     ),
@@ -147,9 +192,6 @@ const createModel = (baseUrl, state, collectionName, schema = {}) => {
   };
 };
 
-
-export default createModel;
-
 export const createModels = (url, state, schema) => {
   return Object.keys(schema.properties).reduce(
     (prev, key) => {

package/lib/model.spec.js

@@ -1,4 +1,4 @@
-import createModel from './model.js';
+import { createModel } from './model.js';
 import { createClient } from './client.js';
 
 jest.mock('./client.js');
@@ -78,6 +78,34 @@ describe('model.update(options)', () => {
       method: 'PUT',
     });
   });
+
+  it('should exclude null values for optional relation props', async () => {
+    const client = createClient().mockResolvedValue({});
+    const schema = {
+      properties: {
+        signupCohort: {
+          anyOf: [
+            { '$ref': '#/definitions/Cohort' },
+            { type: 'null' },
+          ],
+        },
+      },
+    };
+    const model = createModel('http://1.2.3.4', {}, 'foo', schema);
+    expect(await model.update({
+      where: { id: 1 },
+      data: { signupCohort: null },
+    })).toEqual({});
+    expect(client).toHaveBeenCalledTimes(1);
+    expect(client).toHaveBeenCalledWith('/foo/1', {
+      body: {
+        where: { id: 1 },
+        data: {},
+        include: { signupCohort: true },
+      },
+      method: 'PUT',
+    });
+  });
 });
 
 describe('model.upsert(options)', () => {

package/package.json

@@ -1,23 +1,24 @@
 {
   "name": "@laboratoria/sdk-js",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Laboratoria JavaScript (browser) SDK",
   "scripts": {
     "test": "jest --verbose --coverage"
   },
   "license": "MIT",
   "dependencies": {
-    "firebase": "^9.5.0"
+    "blueimp-md5": "^2.19.0",
+    "firebase": "^9.6.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.16.0",
-    "@babel/plugin-transform-modules-commonjs": "^7.16.0",
-    "babel-jest": "^27.4.2",
-    "jest": "^27.4.3",
-    "webpack": "^5.64.4",
+    "@babel/core": "^7.16.7",
+    "@babel/plugin-transform-modules-commonjs": "^7.16.8",
+    "babel-jest": "^27.4.6",
+    "jest": "^27.4.7",
+    "webpack": "^5.65.0",
     "webpack-cli": "^4.9.1"
   },
   "jest": {
     "testEnvironment": "jsdom"
   }
-}
+}

package/schemas/core.json

@@ -75,7 +75,8 @@
           ]
         },
         "disabled": {
-          "type": "boolean"
+          "type": "boolean",
+          "default": false
         },
         "students": {
           "type": "array",
@@ -228,6 +229,29 @@
           "type": "string",
           "format": "date-time"
         },
+        "vacancies": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        },
+        "publicAdmission": {
+          "type": "boolean",
+          "default": false
+        },
+        "placementStart": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "format": "date-time"
+        },
+        "placementDuration": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        },
         "program": {
           "$ref": "#/definitions/Program"
         },
@@ -255,7 +279,7 @@
         "legacySlug": {
           "type": "string"
         },
-        "signupUser": {
+        "signupUsers": {
           "type": "array",
           "items": {
             "$ref": "#/definitions/User"
@@ -346,15 +370,27 @@
           "format": "date-time"
         },
         "reason": {
-          "type": "string"
+          "type": "string",
+          "enum": [
+            "dropout",
+            "noShow",
+            "invitedToLeave",
+            "changeCohort"
+          ]
         },
         "reasonDetail": {
-          "type": "string"
+          "type": [
+            "string",
+            "null"
+          ]
         },
-        "project": {
-          "type": "string"
+        "lastProject": {
+          "type": [
+            "string",
+            "null"
+          ]
         },
-        "stage": {
+        "completedProjects": {
           "type": "integer"
         },
         "notes": {