# safe-auth-sequelize

> Sequelize storage backend for safe-auth.

Latest version **0.1.4** (published 2019-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install safe-auth-sequelize
pnpm add safe-auth-sequelize
yarn add safe-auth-sequelize
bun add safe-auth-sequelize
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2019-05-12 |
| First published | 2019-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 24.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Evenset |
| Maintainers | sassanhe |
| Keywords | authentication, javascript, js, typescript, ts |

## Links

- npm: https://www.npmjs.com/package/safe-auth-sequelize
- Repository: https://github.com/evenset/safe-auth-sequelize
- Homepage: https://github.com/evenset/safe-auth-sequelize#readme
- Issues: https://github.com/evenset/safe-auth-sequelize/issues
- npm.io page: https://npm.io/package/safe-auth-sequelize

## Dependencies (1)

- [safe-auth](https://npm.io/package/safe-auth.md) 0.2.x

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.1.4 (latest) — 2019-05-12
- 0.1.3 — 2019-05-12
- 0.1.2 — 2019-05-11
- 0.1.1 — 2019-05-11
- 0.1.0 — 2019-05-11

## README

[![Build Status](https://travis-ci.com/evenset/safe-auth-sequelize.svg?branch=development)](https://travis-ci.com/evenset/safe-auth-sequelize)
[![codecov](https://codecov.io/gh/evenset/safe-auth-sequelize/branch/development/graph/badge.svg)](https://codecov.io/gh/evenset/safe-auth-sequelize)
[![npm version](https://badge.fury.io/js/safe-auth-sequelize.svg)](https://badge.fury.io/js/safe-auth-sequelize)

# What's safe-auth-sequelize
It's [Sequelize](https://github.com/sequelize/sequelize) adapter for
[safe-auth](https://github.com/evenset/safe-auth). So it enables Postgres,
MySQL, MariaDB, SQLite and Microsoft SQL Server database engines for safe-auth
as its storage backend.
It's written in TypeScript with %100 test code coverage.

# Requirements

safe-auth-sequelize needs and is tested against Sequelize 5.1 or higher

# How to use

It provides a function that should be called with an instance of sequelize:

```typescript
import {SequelizeAccessToken, SequelizeUser} from 'safe-auth-sequelize';
```

Models should get initialized (like any other sequelize model) before being
used. Initialization can be done explicitly:

```typescript
SequelizeUser.init({}, {sequelize});
SequelizeAccessToken.init({}, {sequelize});
SequelizeUser.associate(sequelize.models);
SequelizeAccessToken.associate(sequelize.models);
```

or if there's a script that automates this process for all sequelize models, it
should work for these two models too and manual initialization won't be
required.

## Extending models

Most of the time it's needed to extend the `SequelizeUser` model (or even the
`SequelizeAccessToken` model), to do so new classes should be defined extending
the code classes of safe-auth-sequelize. Also the core class shouldn't get
initialized and the initialization should happen for the inherited class
instead.

For example here a `User` class is inheriting from the core `SequelizeUser`
class. It's connected to a `Organization` model.

```typescript
import {SequelizeAccessToken, SequelizeUser} from 'safe-auth-sequelize';

class Organization extends Sequelize.Model {
    public id!: number;
    public name!: string;
}
Organization.init({
    id: {
        type: DataTypes.INTEGER,
        autoIncrement: true,
        primaryKey: true,
        allowNull: false,
    },
    name: {
        type: new DataTypes.STRING(128),
        allowNull: false,
    },
}, {sequelize})
// Organization doesn't have an associate method

class User extends SequelizeUser {
    public firstname!: string;
    public lastname!: string;
    public organization!: Organization // A class in your codebase

    public static associate(models: {
        User?: typeof SequelizeUser;
        AccessToken?: typeof SequelizeAccessToken;
    }): void {
        super.associate();
        SequelizeAccessToken.belongsTo(Organization, {
            as: 'organization',
            foreignKey: 'organizationId',
            targetKey: 'id',
        });
    }
}

User.init({
    firstname: {
        type: new DataTypes.STRING(128),
        allowNull: false,
    },
    lastname: {
        type: new DataTypes.STRING(128),
        allowNull: false,
    },
}, {sequelize})
SequelizeAccessToken.init({}, {sequelize});
User.associate(sequelize.models);
SequelizeAccessToken.associate(sequelize.models);
```

Note that you don't need to define internal fields of safe-auth-sequelize,
you just need to define your own custom fields in the `init` function call
(here `firstname` and `lastname`).

### Migrations

We provide a sample migration in the github repository, you can download it to
your migrations directory.
You need to modify it in case you're extending (inheriting from) the default
models.


# Reporting bugs

You can report issues/bugs in the github repository of the project:
https://github.com/evenset/safe-auth-sequelize/issues

---
_Source: https://npm.io/package/safe-auth-sequelize · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._