@laboratoria/sdk-js v7.5.0
Laboratoria JavaScript (browser) SDK
:warning: This tool is still in draft stage and is likely to change without notice.
Installation
npm i --save @laboratoria/sdk-js
Usage
import { createApp } from '@laboratoria/sdk-js';
const app = createApp();
With options:
const app = createApp({
firebaseApiKey: '',
firebaseProject: '',
coreApiUrl: '',
jobsApiUrl: '',
});
API
Auth
app.auth.onChange(({ authUser, user }) => {
// `authUser` is the Firebase Auth user
// `user` is the user profile stored in Laboratoria Core
});
app.auth.signIn(email, password);
app.auth.signOut();
Models
The app
object exposes data models used to access data. Each model represents
a type of object, which is stored in a database table.
All models have the following methods and properties.
CRUD methods
create
delete
findById
findMany
update
upsert
Other methods
parse
stats
validate
validateAttr
Properties
relations
schema
Model Schema
Each model has a schema (model.schema
) that describes the shape of the
data, what properties (columns) it has, what data types these columns are,
whether they are required or not, etc.
The model.schema
is an object with the following properties:
inputProps
: An array listing properties to be taken into account when building input UI or sending data (viamodel.create
,model.update
, etc).primaryKey
: Primary key in the underlying table.properties
: An object with the model properties. Each property is described by an object having the following keys:type
: It can be:boolean
,integer
,string
,date
o una referncia a un modelo, en cuyo caso el string será el nombre del modelo de prisma.default
enum
format
:date-time
$ref
anyOf
items
inputType
isRequired
isScalar
isRef
type
: The schema for the whole model will always be of typeobject
.
Users
app.user.findMany({
where: { name: { contains: 'foo' } },
include: { students: true },
take: 10,
skip: 0,
});
app.user.findById('some-firebase-uid', {
include: { gigs: true },
});
app.user.update({
where: { uid: 'some-firebase-uid' },
data: {
name: 'OMG',
},
});
app.user.delete('some-firebase-uid');
app.user.create({
data: {
name: 'OMG',
email: 'omg@omg.omg',
password: 'secret',
},
});
Cohorts
app.cohort.findMany({
where: {
end: { gt: new Date() },
stage: { name: 'bootcamp' },
},
include: {
program: true,
stage: true,
students: true,
dropouts: true,
},
})
Students
WIP
Dropouts
WIP
Projects
app.project.findMany();
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
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
app.learningObjective.findMany();
app.learningObjective.findMany({ tag: 'v3.0.0' });
17 days ago
16 days ago
17 days ago
18 days ago
18 days ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
5 months ago
9 months ago
10 months ago
10 months ago
9 months ago
6 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
7 months ago
7 months ago
10 months ago
10 months ago
8 months ago
6 months ago
6 months ago
6 months ago
6 months ago
11 months ago
11 months ago
1 year ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago