@magda/authentication-plugin-sdk 5.0.0-alpha.0 → 5.0.0-alpha.1

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import AuthApiClient from '@magda/auth-api-client';
 import { CookieOptions as CookieOptions_3 } from 'express';
 import express from 'express';
 import passport from 'passport';
@@ -5,147 +6,12 @@ import { QueryDataMap } from 'urijs';
 import { Request as Request_2 } from 'express';
 import { Response as Response_2 } from 'express';
 import { Router } from 'express';
-
-declare class ApiClient {
-    private jwt;
-    private requestInitOption;
-    private baseUrl;
-    constructor(baseUrl: string, jwtSecret?: string, userId?: string);
-    getMergeRequestInitOption(extraOptions?: RequestInit): RequestInit;
-    processJsonResponse<T = any>(res: Response): Promise<T>;
-    /**
-     * Get the data of a user.
-     *
-     * @param {string} userId
-     * @returns {Promise<Maybe<User>>}
-     * @memberof ApiClient
-     */
-    getUser(userId: string): Promise<Maybe<RequiredKeys<User, "id">>>;
-    /**
-     * Lookup user by source (identity provider) & sourceId (identity ID)
-     *
-     * @param {string} source
-     * @param {string} sourceId
-     * @returns {Promise<Maybe<User>>}
-     * @memberof ApiClient
-     */
-    lookupUser(source: string, sourceId: string): Promise<Maybe<RequiredKeys<User, "id">>>;
-    /**
-     * create a user
-     *
-     * @param {CreateUserData} user
-     * @returns {Promise<UserRecord>}
-     * @memberof ApiClient
-     */
-    createUser(user: CreateUserData): Promise<UserRecord>;
-    /**
-     * Add Roles to a user.
-     * Returns a list of current role ids of the user.
-     *
-     * @param {string} userId
-     * @param {string[]} roleIds
-     * @returns {Promise<string[]>}
-     * @memberof ApiClient
-     */
-    addUserRoles(userId: string, roleIds: string[]): Promise<string[]>;
-    /**
-     * Remove a list roles from a user.
-     *
-     * @param {string} userId
-     * @param {string[]} roleIds
-     * @returns {Promise<void>}
-     * @memberof ApiClient
-     */
-    deleteUserRoles(userId: string, roleIds: string[]): Promise<void>;
-    /**
-     * Get all roles of a user
-     *
-     * @param {string} userId
-     * @returns {Promise<Role[]>}
-     * @memberof ApiClient
-     */
-    getUserRoles(userId: string): Promise<Role[]>;
-    /**
-     * Get all permissions of a user
-     *
-     * @param {string} userId
-     * @returns {Promise<Permission[]>}
-     * @memberof ApiClient
-     */
-    getUserPermissions(userId: string): Promise<Permission[]>;
-    /**
-     * Get all permissions of a role
-     *
-     * @param {string} roleId
-     * @returns {Promise<Permission[]>}
-     * @memberof ApiClient
-     */
-    getRolePermissions(roleId: string): Promise<Permission[]>;
-    /**
-     * List OrgUnits at certain org tree level.
-     * Optionally provide a test Org Unit Id that will be used to test the relationship with each of returned orgUnit item.
-     * Possible Value: 'ancestor', 'descendant', 'equal', 'unrelated'
-     *
-     * @param {string} orgLevel The level number (starts from 1) where org Units of the tree are taken horizontally.
-     * @param {string} [relationshipOrgUnitId] Optional; The org unit id that is used to test the relationship with each of returned orgUnit item.
-     * @returns {Promise<OrgUnit[]>}
-     * @memberof ApiClient
-     */
-    getOrgUnitsByLevel(orgLevel: number, relationshipOrgUnitId?: string): Promise<OrgUnit[]>;
-    /**
-     * Get orgunits by name
-     *
-     * @param {string} nodeName
-     * @param {boolean} [leafNodesOnly=false] Whether only leaf nodes should be returned
-     * @param {string} [relationshipOrgUnitId] Optional; The org unit id that is used to test the relationship with each of returned orgUnit item.
-     * @returns {Promise<OrgUnit[]>}
-     * @memberof ApiClient
-     */
-    getOrgUnitsByName(nodeName: string, leafNodesOnly?: boolean, relationshipOrgUnitId?: string): Promise<OrgUnit[]>;
-    /**
-     * Gets the root organisation unit (top of the tree).
-     *
-     * @returns {Promise<OrgUnit>}
-     * @memberof ApiClient
-     */
-    getRootOrgUnit(): Promise<OrgUnit>;
-    /**
-     * Gets the details of the node with its id.
-     *
-     * @param {string} nodeId
-     * @returns {Promise<OrgUnit>}
-     * @memberof ApiClient
-     */
-    getOrgUnitById(nodeId: string): Promise<OrgUnit>;
-    /**
-     * Gets all the children immediately below the requested node. If the node doesn't exist, returns an empty list.
-     *
-     * @param {string} nodeId
-     * @returns {Promise<OrgUnit[]>}
-     * @memberof ApiClient
-     */
-    getImmediateOrgUnitChildren(nodeId: string): Promise<OrgUnit[]>;
-    /**
-     * Gets all the children below the requested node recursively. If node doesn't exist, returns an empty list.
-     *
-     * @param {string} nodeId
-     * @returns {Promise<OrgUnit[]>}
-     * @memberof ApiClient
-     */
-    getAllOrgUnitChildren(nodeId: string): Promise<OrgUnit[]>;
-    createOrgNode(parentNodeId: string, node: Partial<Omit<OrgUnitRecord, "id" | "createBy" | "createTime" | "editBy" | "editTime" | "left" | "right">>): Promise<OrgUnit>;
-    createRole(name: string, desc?: string): Promise<Role>;
-    createRolePermission(roleId: string, permissionData: CreateRolePermissionInputData): Promise<PermissionRecord>;
-    createPermission(permissionData: CreateRolePermissionInputData): Promise<PermissionRecord>;
-    updatePermission(id: string, permissionData: UpdateRolePermissionInputData): Promise<PermissionRecord>;
-    getOperationByUri(opUri: string): Promise<OperationRecord>;
-    getResourceByUri(resUri: string): Promise<ResourceRecord>;
-    private handleGetResult;
-}
+import { User } from '@magda/auth-api-client';
+import { UserToken } from '@magda/auth-api-client';
 
 /**
  * Different type of AuthenticationMethod:
- * - IDP-URI-REDIRECTION: the plugin will rediredct user agent to idp (identity provider) for authentication. e.g. Google & fackebook oauth etc.
+ * - IDP-URI-REDIRECTION: the plugin will redirect user agent to idp (identity provider) for authentication. e.g. Google & fackebook oauth etc.
  *   - This is the default method.
  * - PASSWORD: the plugin expect frontend do a form post that contains username & password to the plugin for authentication
  * - QR-CODE: the plugin offers a url that is used by the frontend to request auth challenge data. The data will be encoded into a QR-code image and expect the user scan the QR code with a mobile app to complete the authentication request.
@@ -220,17 +86,7 @@ export declare function createMagdaSessionRouter(options: MagdaSessionRouterOpti
  *
  * @returns {Promise<UserToken>}
  */
-export declare function createOrGetUserToken(authApi: ApiClient, profile: passport.Profile, source: string, beforeUserCreated?: (authApiClient: ApiClient, userData: User, profile: passport.Profile) => Promise<User>, afterUserCreated?: (authApiClient: ApiClient, user: User, profile: passport.Profile) => Promise<void>): Promise<UserToken>;
-
-declare interface CreateRolePermissionInputData extends Omit<PermissionRecord, "id" | "owner_id" | "create_by" | "create_time" | "edit_by" | "edit_time" | "allow_exemption" | "resource_id"> {
-    operationIds?: string[];
-    operationUris?: string[];
-    resource_id?: string;
-    resourceUri?: string;
-    allow_exemption?: boolean;
-}
-
-declare type CreateUserData = Partial<Omit<UserRecord, "email" | "displayName" | "id">> & Pick<UserRecord, "displayName" | "email">;
+export declare function createOrGetUserToken(authApi: AuthApiClient, profile: passport.Profile, source: string, beforeUserCreated?: (authApiClient: AuthApiClient, userData: User, profile: passport.Profile) => Promise<User>, afterUserCreated?: (authApiClient: AuthApiClient, user: User, profile: passport.Profile) => Promise<void>): Promise<UserToken>;
 
 export declare const DEFAULT_SESSION_COOKIE_NAME: string;
 
@@ -263,16 +119,6 @@ export declare const destroySession: typeof destroySession_2;
  */
 declare function destroySession_2(req: express.Request): Promise<void>;
 
-declare interface Eq<T> {
-    equals(t: T): boolean;
-}
-
-declare interface Functor<T> {
-    fmap<U>(f: (t: T) => U): Functor<U>;
-    lift<U>(f: (t: T) => U): Functor<U>;
-    map<U>(f: (t: T) => U): Functor<U>;
-}
-
 /**
  * Join `url` with `baseUrl` if `url` is not an absolute (full) url string
  *
@@ -297,175 +143,10 @@ export declare type MagdaSessionRouterOptions = {
     sessionDBName?: string;
 };
 
-declare class Maybe<T> implements Monad<T>, Functor<T>, Eq<Maybe<T>> {
-    private type;
-    private value?;
-    constructor(type: MaybeType, value?: T);
-    static sequence<T>(t: {
-        [k: string]: Maybe<T>;
-    }): Maybe<{
-        [k: string]: T;
-    }>;
-    static all: (t: {
-        [k: string]: Maybe<any>;
-    }) => Maybe<{
-        [k: string]: any;
-    }>;
-    static maybe<T>(t?: T | null): Maybe<T>;
-    static just<T>(t: T): Maybe<T>;
-    static nothing<T>(): Maybe<T>;
-    static isJust<T>(t: Maybe<T>): boolean;
-    static isNothing<T>(t: Maybe<T>): boolean;
-    unit<U>(u: U): Maybe<U>;
-    bind<U>(f: (t: T) => Maybe<U>): Maybe<U>;
-    of: <U>(u: U) => Maybe<U>;
-    chain: <U>(f: (t: T) => Maybe<U>) => Maybe<U>;
-    fmap<U>(f: (t: T) => U): Maybe<U>;
-    lift: <U>(f: (t: T) => U) => Maybe<U>;
-    map: <U>(f: (t: T) => U) => Maybe<U>;
-    caseOf<U>(patterns: MaybePatterns<T, U>): U;
-    defaulting(defaultValue: T): Maybe<T>;
-    equals(other: Maybe<T>): any;
-    valueOr<U extends T>(defaultValue: U): T | U;
-    valueOrCompute<U extends T>(defaultValueFunction: () => U): T | U;
-    valueOrThrow(error?: Error): T;
-    do(patterns?: Partial<MaybePatterns<T, void>>): Maybe<T>;
-}
-
-declare interface MaybePatterns<T, U> {
-    just: (t: T) => U;
-    nothing: () => U;
-}
-
-declare enum MaybeType {
-    Nothing = 0,
-    Just = 1
-}
-
-declare interface Monad<T> {
-    unit<U>(t: U): Monad<U>;
-    bind<U>(f: (t: T) => Monad<U>): Monad<U>;
-    of<U>(t: U): Monad<U>;
-    chain<U>(f: (t: T) => Monad<U>): Monad<U>;
-}
-
-declare interface Operation {
-    id: string;
-    uri: string;
-    name: string;
-    description?: string;
-}
-
-declare type OperationRecord = {
-    id: string;
-    uri: string;
-    name: string;
-    description: string;
-    resource_id: string;
-};
-
-declare type OrgUnit = Partial<OrgUnitRecord> & {
-    relationship?: OrgUnitRelationshipType;
-};
-
-declare interface OrgUnitRecord {
-    id: string;
-    name: string;
-    description: string;
-    left: number;
-    right: number;
-    createBy: string;
-    createTime: Date;
-    editBy: string;
-    editTime: Date;
-}
-
-declare type OrgUnitRelationshipType = "ancestor" | "descendant" | "equal" | "unrelated";
-
-declare interface Permission {
-    id: string;
-    name: string;
-    description?: string;
-    resourceId: string;
-    resourceUri: string;
-    userOwnershipConstraint: boolean;
-    orgUnitOwnershipConstraint: boolean;
-    preAuthorisedConstraint: boolean;
-    operations: Operation[];
-    createBy?: string;
-    createTime?: Date;
-    editBy?: string;
-    editTime?: Date;
-    allowExemption: boolean;
-}
-
-declare interface PermissionRecord {
-    id: string;
-    name: string;
-    description: string;
-    resource_id: string;
-    user_ownership_constraint: boolean;
-    org_unit_ownership_constraint: boolean;
-    pre_authorised_constraint: boolean;
-    owner_id: string;
-    create_time: string;
-    create_by: string;
-    edit_time: string;
-    edit_by: string;
-    allow_exemption: boolean;
-}
-
-declare type PublicUser = Partial<Pick<UserRecord, "id" | "photoURL" | "orgUnitId">> & Omit<UserRecord, "id" | "photoURL" | "orgUnitId" | "email" | "source" | "sourceId"> & {
-    roles?: Role[];
-    permissions?: Permission[];
-    managingOrgUnitIds?: string[];
-    orgUnit?: OrgUnit;
-};
-
 export declare function redirectOnError(err: any, toURL: string, req: Request_2, res: Response_2): void;
 
 export declare function redirectOnSuccess(toURL: string, req: Request_2, res: Response_2): void;
 
-declare type RequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
-
-declare type ResourceRecord = {
-    id: string;
-    uri: string;
-    name: string;
-    description: string;
-};
-
-declare interface Role {
-    id: string;
-    name: string;
-    permissionIds: string[];
-    description?: string;
-    createBy?: string;
-    createTime?: Date;
-    editBy?: string;
-    editTime?: Date;
-}
-
 export declare type SessionCookieOptions = CookieOptions_2;
 
-declare interface UpdateRolePermissionInputData extends Partial<CreateRolePermissionInputData> {
-}
-
-declare type User = PublicUser & Pick<UserRecord, "email" | "source" | "sourceId">;
-
-declare interface UserRecord {
-    id: string;
-    displayName: string;
-    photoURL: string;
-    isAdmin: boolean;
-    orgUnitId: string;
-    email: string;
-    source: string;
-    sourceId: string;
-}
-
-declare interface UserToken {
-    id: string;
-}
-
 export { }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magda/authentication-plugin-sdk",
   "description": "MAGDA Authentication Plugin SDK",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-alpha.1",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
@@ -23,8 +23,8 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "devDependencies": {
-    "@magda/auth-api-client": "^5.0.0-alpha.0",
-    "@magda/typescript-common": "^5.0.0-alpha.0",
+    "@magda/auth-api-client": "^5.0.0-alpha.1",
+    "@magda/typescript-common": "^5.0.0-alpha.1",
     "@types/express-session": "^1.18.1",
     "@types/lodash": "^4.14.74",
     "@types/pg": "^8.6.5",