• Default Repositories
  • Database Schema
    • Users
    • Social Links
  • How to Use
  • Available Methods

#Default Repositories

SDK includes default repositories for accessing and saving data in resource server.

These repositories link to your database using the SDK's Datasource. Some repositories have dependencies on other repositories.

Since the SDK does not run any database migrations, you need to make sure that the following database structures are applied.

#Database Schema

#Users

#Social Links

#How to Use

Start by establishing a connection to the database. The complete list of supported connections may be found in the Datasource manual.

import { Datasource } from "@ssofy/node-sdk";
import mysql from "mysql2/promise";
...
const pool = mysql.createPool({
    host: 'localhost',
    port: 3306,
    user: 'root',
    password: 'root',
    database: 'db',
    waitForConnections: true,
    connectionLimit: 10,
    maxIdle: 10,
    idleTimeout: 60000,
    queueLimit: 0,
    enableKeepAlive: true,
    keepAliveInitialDelay: 0
});

const connection = new Datasource.MySQLPoolConnection(pool)

We may also need a temporary or persistent storage for keeping our temporary user tokens and otp codes.

import { Storage } from "@ssofy/node-sdk";
...
const storage = new Storage.MemoryStorage();

We need a user transformer too.

import { Transformers } from "@ssofy/node-sdk";
...
const userTranformer = new Transformers.DefaultUserTransformer();

Repositories:

import { Repositories, Models } from "@ssofy/node-sdk";
...
const socialLinkRepository = new Repositories.DefaultSocialLinkRepository(
    connection, 
    'social_links', // table name (or object when using ORM)
    { // custom column names map
        // identifier: 'provider_id' 
    }
);

const userRepository = new Repositories.DefaultUserRepository(
    connection,
    'users', // table name (or object when using ORM)
    storage,
    socialLinkRepository,
    userTransformer,
    { // custom column names map
        phone: 'phone_number'
    }
);

const clientRepository = new Repositories.DefaultClientRepository([
    <Models.ClientEntity>{
        id: 'test',
        name: 'Test',
        secret: 'test',
        redirect_uris: ['*'],
    },
]);

const scopeRepository = new Repositories.DefaultScopeRepository([
    <Models.ScopeEntity>{
        id: '*',
        title: 'All profile data',
    },
]);

const otpRepository = new Repositories.DefaultOTPRepository(
    storage,
    userRepository
);

#Available Methods

Checkout the repository interfaces for the list of available repository methods.

• ClientRepository Interface
• ScopeRepository Interface
• UserRepository Interface
• SocialLinkRepository Interface
• OTPRepository Interface