@laboratoria/sdk-js 0.0.0 → 1.0.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/README.md

@@ -1,5 +1,7 @@
 ## Laboratoria JavaScript (browser) SDK
 
+[![Node.js CI](https://github.com/Laboratoria/sdk-js/actions/workflows/node.js.yml/badge.svg)](https://github.com/Laboratoria/sdk-js/actions/workflows/node.js.yml)
+
 :warning: This tool is still in draft stage and is likely to change without
 notice.
 
@@ -25,7 +27,6 @@ const app = createApp({
   firebaseApiKey: '',
   firebaseProject: '',
   coreApiUrl: '',
-  teamApiUrl: '',
   jobsApiUrl: '',
 });
 ```
@@ -79,7 +80,6 @@ app.user.create({
 ### Cohorts
 
 ```js
-// Cohorts API
 app.cohort.findMany({
   where: {
     end: { gt: new Date() },
@@ -96,13 +96,50 @@ app.cohort.findMany({
 
 ### Students
 
+WIP
+
 ### Dropouts
 
+WIP
 
 ### Projects
 
 ```js
 app.project.findMany();
 
-// app.learningObjectives.
+app.project.findMany({ tag: 'v3.0.0' });
+
+app.project.findMany({
+  locale: 'es-ES',
+  track: 'js',
+});
+
+app.project.findById('cipher');
+
+app.project.findById('cipher', { tag: 'v3.0.0' });
 ```
+
+### Topics
+
+```js
+app.topic.findMany();
+
+app.topic.findMany({ tag: 'v3.0.0' });
+
+app.topic.findMany({
+  locale: 'es-ES',
+  track: 'js',
+});
+
+app.topic.findById('javascript');
+
+app.topic.findById('javascript', { tag: 'v3.0.0' });
+```
+
+### Learning Objectives
+
+```js
+app.learningObjective.findMany();
+
+app.learningObjective.findMany({ tag: 'v3.0.0' });
+```

package/index.js

@@ -5,16 +5,14 @@ import {
   signInWithEmailAndPassword,
   signOut,
 } from 'firebase/auth';
-import { createClient } from './lib/client';
 import { createAPI as createCoreAPI } from './lib/core';
+import { createAPI as createCurriculumAPI } from './lib/curriculum';
 import { createAPI as createJobsAPI } from './lib/jobs';
-import { createAPI as createTeamAPI } from './lib/team';
 
 export const createApp = ({
   firebaseApiKey = 'AIzaSyAXbaEbpq8NOfn0r8mIrcoHvoGRkJThwdc',
   firebaseProject = 'laboratoria-la',
   coreApiUrl = 'https://us-central1-outpost-272720.cloudfunctions.net/core-api',
-  teamApiUrl = 'https://us-central1-outpost-272720.cloudfunctions.net/team-api',
   jobsApiUrl = 'https://us-central1-outpost-272720.cloudfunctions.net/jobs-api',
 } = {}) => {
   const firebaseApp = initializeApp({
@@ -26,31 +24,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 jobsAPI = createJobsAPI(jobsApiUrl, state);
+  const curriculumAPI = createCurriculumAPI();
 
   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);
         });
     }),
@@ -63,9 +55,9 @@ export const createApp = ({
   };
 
   return {
+    ...jobsAPI,
+    ...curriculumAPI,
+    ...coreAPI,
     auth: authAPI,
-    ...createCoreAPI(coreApiUrl, state),
-    ...createJobsAPI(jobsApiUrl, state),
-    ...createTeamAPI(teamApiUrl, state),
   };
 };

package/index.spec.js

@@ -5,10 +5,16 @@ import {
   signInWithEmailAndPassword,
   signOut,
 } from 'firebase/auth';
-import { createClient } from './lib/client.js';
+import { createAPI as createCoreAPI } from './lib/core';
 import { createApp } from './index.js';
 
-jest.mock('./lib/client.js');
+jest.mock('./lib/core.js', () => ({
+  createAPI: jest.fn().mockReturnValue({
+    user: {
+      findById: jest.fn().mockResolvedValue({}),
+    },
+  }),
+}));
 
 beforeEach(() => {
   initializeApp.mockClear();
@@ -40,7 +46,7 @@ describe('app.auth.onChange', () => {
     });
   });
 
-  it('should fetch user from db when authenticated and add isStaff, isManager, etc', (done) => {
+  it('should fetch user from db when authenticated using coreAPI', (done) => {
     const { auth } = createApp();
     const mockAuthUser = { uid: 'xxx', getIdToken: () => 'token' };
     const userMock = { uid: 'xxx', email: 'foo@bar.baz' };
@@ -50,17 +56,11 @@ describe('app.auth.onChange', () => {
       return () => { };
     });
 
-    createClient().mockResolvedValueOnce(userMock);
+    createCoreAPI().user.findById.mockResolvedValue(userMock);
 
     auth.onChange(({ authUser, user }) => {
       expect(authUser).toEqual(mockAuthUser);
-      expect(user).toEqual({
-        ...userMock,
-        isStaff: false,
-        isManager: false,
-        isFinance: false,
-        isAdmin: false,
-      });
+      expect(user).toEqual(userMock);
       done();
     });
   });
@@ -76,7 +76,7 @@ describe('app.auth.onChange', () => {
       return () => { };
     });
 
-    createClient().mockRejectedValueOnce(error);
+    createCoreAPI().user.findById.mockRejectedValueOnce(error);
 
     auth.onChange(({ authUser, user }) => {
       expect(authUser).toBeNull();

package/lib/core.js

@@ -1,14 +1,20 @@
+import md5 from 'blueimp-md5';
+import currencies from './currencies';
+import roles from './roles';
 import { createModels, extendSchemaDefinitions } from './model';
 import schema from '../schemas/core.json';
 
 const extended = {
+  Country: {
+    plural: 'countries',
+  },
   User: {
     primaryKey: 'uid',
     inputProps: [
       'firstName',
       'lastName',
       'email',
-      'locale',
+      'lang',
       'github',
       'linkedin',
       'bio',
@@ -16,17 +22,41 @@ const extended = {
       'signupCohort',
       'disabled',
     ],
+    searchProps: ['firstName', 'lastName', 'email'],
+    getOptionLabel: ({ firstName, lastName, email }) => `${firstName} ${lastName} (${email})`,
     properties: {
       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',
+      };
+    },
+  },
+  Track: {
+    searchProps: ['name'],
+  },
+  Program: {
+    searchProps: ['name'],
+  },
+  Stage: {
+    searchProps: ['name'],
   },
   Cohort: {
     inputProps: [
@@ -37,13 +67,37 @@ const extended = {
       'end',
       'legacySlug',
     ],
-    properties: {
-      program: {
-
-      },
+    searchProps: ['name'],
+    getOptionLabel: ({ id, name, stage }) => (
+      `${name}${!stage ? '' : ` - ${stage.name}`} (id: ${id})`
+    ),
+    properties: {},
+    parse: (props) => {
+      const now = Date.now();
+      // TODO: Handle case where start and/or end have not been  selected in query
+      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: {},
+  Student: {
+    inputProps: [],
+    searchProps: [],
+  },
   Dropout: {
     inputProps: [
       'cohort',
@@ -51,12 +105,56 @@ const extended = {
       'date',
       'reason',
       'reasonDetail',
-      'project',
-      'stage',
+      'lastProject',
+      'completedProjects',
       'notes',
       'staffSad',
       'covidRelated',
     ],
+    searchProps: [
+      'user.uid',
+      'user.firstName',
+      'user.lastName',
+      'user.email',
+      'cohort.name',
+    ],
+  },
+  Contract: {
+    inputProps: [
+      'user',
+      'countryCode',
+      'currency',
+      'isEmployment',
+      'feeBasis',
+      'feeAmount',
+      'hoursPerWeek',
+      'start',
+      'end',
+    ],
+    properties: {
+      countryCode: {
+        enum: ['BR', 'CL', 'CO', 'MX', 'PE'],
+      },
+      currency: {
+        enum: currencies,
+      },
+    },
+  },
+  Gig: {
+    inputProps: [
+      // 'contract',
+      'cohort',
+      'user',
+      'role',
+      'hoursPerWeek',
+      'start',
+      'end',
+    ],
+    properties: {
+      role: {
+        enum: roles,
+      },
+    },
   },
 };
 
@@ -65,4 +163,7 @@ export const createAPI = (url, state) => createModels(url, state, {
   definitions: extendSchemaDefinitions(schema, extended),
 });
 
-// const { delete: _, ...userAPI } = createModel(coreApiUrl, state, 'users', schemas.user);
+// const {
+//   delete: _,
+//   ...userAPI,
+// } = createModel(coreApiUrl, state, 'users', schemas.user);

package/lib/curriculum.js

@@ -0,0 +1,59 @@
+const releasesUrl = 'https://api.github.com/repos/Laboratoria/bootcamp/releases';
+const rawUrl = 'https://raw.githubusercontent.com/Laboratoria/bootcamp';
+
+const getLatestVersion = () => fetch(`${releasesUrl}/latest`)
+  .then(resp => resp.json())
+  .then(({ tag_name }) => tag_name);
+
+const fetchProjects = async tag => (
+  fetch(`${rawUrl}/${tag || await getLatestVersion()}/dist/projects.json`)
+    .then(resp => resp.json())
+);
+
+const fetchProject = async (slug, tag) => (
+  fetch(`${rawUrl}/${tag || await getLatestVersion()}/dist/projects/${slug}.json`)
+    .then(resp => resp.json())
+);
+
+const fetchTopics = async tag => (
+  fetch(`${rawUrl}/${tag || await getLatestVersion()}/dist/topics.json`)
+    .then(resp => resp.json())
+);
+
+const fetchTopic = async (slug, tag) => (
+  fetch(`${rawUrl}/${tag || await getLatestVersion()}/dist/topics/${slug}.json`)
+    .then(resp => resp.json())
+);
+
+const fetchLearningObjectives = async tag => (
+  fetch(`${rawUrl}/${tag || await getLatestVersion()}/dist/learning-objectives.json`)
+    .then(resp => resp.json())
+);
+
+const filterByLocaleAndTrack = opts => arr => arr.filter((obj) => {
+  if (opts.locale && opts.locale !== obj.locale) {
+    return false;
+  }
+  if (opts.track && opts.track !== obj.track) {
+    return false;
+  }
+  return true;
+});
+
+export const createAPI = () => {
+  return {
+    projects: {
+      findMany: (opts = {}) => fetchProjects(opts.tag)
+        .then(filterByLocaleAndTrack(opts)),
+      findById: (slug, opts = {}) => fetchProject(slug, opts.tag),
+    },
+    topics: {
+      findMany: (opts = {}) => fetchTopics(opts.tag)
+        .then(filterByLocaleAndTrack(opts)),
+      findById: (slug, opts = {}) => fetchTopic(slug, opts.tag),
+    },
+    learningObjectives: {
+      findMany: (opts = {}) => fetchLearningObjectives(opts.tag),
+    },
+  };
+};

package/lib/curriculum.spec.js

@@ -0,0 +1,194 @@
+import { createAPI } from './curriculum';
+
+describe('projects', () => {
+  describe('findMany', () => {
+    // TODO: errores HTTP, GitHub caido, repo borrado, etc...
+
+    it('sends request to get latest version and then corresponding json', () => {
+      global.fetch = jest.fn().mockImplementation(async url => ({
+        status: 200,
+        json: jest.fn().mockResolvedValue(
+          url.startsWith('https://api.')
+            ? { tag_name: 'v4.0.0' }
+            : []
+        ),
+      }));
+
+      return createAPI().projects.findMany()
+        .then((projects) => {
+          expect(projects).toEqual([]);
+          expect(global.fetch).toHaveBeenCalledTimes(2);
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            1,
+            'https://api.github.com/repos/Laboratoria/bootcamp/releases/latest',
+          );
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            2,
+            'https://raw.githubusercontent.com/Laboratoria/bootcamp/v4.0.0/dist/projects.json',
+          );
+        });
+    });
+
+    it('gets projects in specific tag when passed as option', () => {
+      global.fetch = jest.fn().mockImplementation(async url => ({
+        status: 200,
+        json: jest.fn().mockResolvedValue(
+          url.startsWith('https://api.')
+            ? { tag_name: 'v4.0.0' }
+            : []
+        ),
+      }));
+
+      return createAPI().projects.findMany({ tag: 'v3.0.0' })
+        .then((projects) => {
+          expect(projects).toEqual([]);
+          expect(global.fetch).toHaveBeenCalledTimes(1);
+          expect(global.fetch).toHaveBeenCalledWith(
+            'https://raw.githubusercontent.com/Laboratoria/bootcamp/v3.0.0/dist/projects.json',
+          );
+        });
+    });
+
+    it('gets projects in specific tag when passed as option', () => {
+      global.fetch = jest.fn().mockImplementation(async url => ({
+        status: 200,
+        json: jest.fn().mockResolvedValue(
+          url.startsWith('https://api.')
+            ? { tag_name: 'v4.0.0' }
+            : [
+              { locale: 'es-ES', track: 'ux' },
+              { locale: 'es-ES', track: 'js' },
+              { locale: 'pt-BR', track: 'ux' },
+            ]
+        ),
+      }));
+
+      return createAPI().projects.findMany({
+        tag: 'v3.0.0',
+        locale: 'es-ES',
+        track: 'ux',
+      })
+        .then((projects) => {
+          expect(projects).toEqual([{ locale: 'es-ES', track: 'ux' }]);
+          expect(global.fetch).toHaveBeenCalledTimes(1);
+          expect(global.fetch).toHaveBeenCalledWith(
+            'https://raw.githubusercontent.com/Laboratoria/bootcamp/v3.0.0/dist/projects.json',
+          );
+        });
+    });
+
+    // it should filter by tag, locale and track...
+  });
+
+  describe('findById', () => {
+    it('sends request to get latest version and then corresponding json', () => {
+      global.fetch = jest.fn().mockImplementation(async url => ({
+        status: 200,
+        json: jest.fn().mockResolvedValue(
+          url.startsWith('https://api.')
+            ? { tag_name: 'v4.0.0' }
+            : {}
+        ),
+      }));
+
+      return createAPI().projects.findById('cipher')
+        .then((project) => {
+          expect(project).toEqual({});
+          expect(global.fetch).toHaveBeenCalledTimes(2);
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            1,
+            'https://api.github.com/repos/Laboratoria/bootcamp/releases/latest',
+          );
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            2,
+            'https://raw.githubusercontent.com/Laboratoria/bootcamp/v4.0.0/dist/projects/cipher.json',
+          );
+        });
+    });
+  });
+});
+
+describe('topics', () => {
+  describe('findMany', () => {
+    it('sends request to get latest version and then corresponding json', () => {
+      global.fetch = jest.fn().mockImplementation(async url => ({
+        status: 200,
+        json: jest.fn().mockResolvedValue(
+          url.startsWith('https://api.')
+            ? { tag_name: 'v4.0.0' }
+            : []
+        ),
+      }));
+
+      return createAPI().topics.findMany()
+        .then((topics) => {
+          expect(topics).toEqual([]);
+          expect(global.fetch).toHaveBeenCalledTimes(2);
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            1,
+            'https://api.github.com/repos/Laboratoria/bootcamp/releases/latest',
+          );
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            2,
+            'https://raw.githubusercontent.com/Laboratoria/bootcamp/v4.0.0/dist/topics.json',
+          );
+        });
+    });
+  });
+
+  describe('findById', () => {
+    it('sends request to get latest version and then corresponding json', () => {
+      global.fetch = jest.fn().mockImplementation(async url => ({
+        status: 200,
+        json: jest.fn().mockResolvedValue(
+          url.startsWith('https://api.')
+            ? { tag_name: 'v4.0.0' }
+            : {}
+        ),
+      }));
+
+      return createAPI().topics.findById('javascript')
+        .then((topic) => {
+          expect(topic).toEqual({});
+          expect(global.fetch).toHaveBeenCalledTimes(2);
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            1,
+            'https://api.github.com/repos/Laboratoria/bootcamp/releases/latest',
+          );
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            2,
+            'https://raw.githubusercontent.com/Laboratoria/bootcamp/v4.0.0/dist/topics/javascript.json',
+          );
+        });
+    });
+  });
+});
+
+describe('learningObjectives', () => {
+  describe('findMany', () => {
+    it('sends request to get latest version and then corresponding json', () => {
+      global.fetch = jest.fn().mockImplementation(async url => ({
+        status: 200,
+        json: jest.fn().mockResolvedValue(
+          url.startsWith('https://api.')
+            ? { tag_name: 'v4.0.0' }
+            : []
+        ),
+      }));
+
+      return createAPI().learningObjectives.findMany()
+        .then((learningObjectives) => {
+          expect(learningObjectives).toEqual([]);
+          expect(global.fetch).toHaveBeenCalledTimes(2);
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            1,
+            'https://api.github.com/repos/Laboratoria/bootcamp/releases/latest',
+          );
+          expect(global.fetch).toHaveBeenNthCalledWith(
+            2,
+            'https://raw.githubusercontent.com/Laboratoria/bootcamp/v4.0.0/dist/learning-objectives.json',
+          );
+        });
+    });
+  });
+});

package/lib/jobs.js

@@ -1,4 +1,22 @@
-import { createModels } from './model';
-import jobsSchema from '../schemas/jobs.json';
+import { createModels, extendSchemaDefinitions } from './model';
+import schema from '../schemas/jobs.json';
 
-export const createAPI = (url, state) => createModels(url, state, jobsSchema);
+const extended = {
+  Country: {
+    plural: 'countries',
+  },
+  Job: {
+    // inputProps: [],
+    // properties: {},
+  },
+  Company: {
+    plural: 'companies',
+    // inputProps: [],
+    // properties: {},
+  },
+};
+
+export const createAPI = (url, state) => createModels(url, state, {
+  ...schema,
+  definitions: extendSchemaDefinitions(schema, extended),
+});