Add .d.ts files
This commit is contained in:
Benjamin Toby
Vendored
+71
@@ -0,0 +1,71 @@
|
||||
export = localGithubAuth;
|
||||
/**
|
||||
* SERVER FUNCTION: Login with google Function
|
||||
* ==============================================================================
|
||||
*
|
||||
* @async
|
||||
*
|
||||
* @param {object} params - main params object
|
||||
* @param {http.ServerResponse} params.res - HTTPS response object
|
||||
* @param {string} params.code
|
||||
* @param {string} [params.email]
|
||||
* @param {string} params.clientId
|
||||
* @param {string} params.clientSecret
|
||||
* @param {object} [params.additionalFields]
|
||||
* @param {import("../../../package-shared/types").DSQL_DatabaseSchemaType} params.dbSchema
|
||||
*/
|
||||
declare function localGithubAuth({ res, code, email, clientId, clientSecret, additionalFields, dbSchema, }: {
|
||||
res: http.ServerResponse;
|
||||
code: string;
|
||||
email?: string;
|
||||
clientId: string;
|
||||
clientSecret: string;
|
||||
additionalFields?: object;
|
||||
dbSchema: import("../../../package-shared/types").DSQL_DatabaseSchemaType;
|
||||
}): Promise<{
|
||||
success: boolean;
|
||||
msg: string;
|
||||
} | {
|
||||
dsqlUserId: string;
|
||||
/**
|
||||
* - Did the operation complete successfully or not?
|
||||
*/
|
||||
success: boolean;
|
||||
/**
|
||||
* - User payload object: or "null"
|
||||
*/
|
||||
user: {
|
||||
id: number;
|
||||
first_name: string;
|
||||
last_name: string;
|
||||
} | null;
|
||||
/**
|
||||
* - Message
|
||||
*/
|
||||
msg?: string;
|
||||
/**
|
||||
* - Error Message
|
||||
*/
|
||||
error?: string;
|
||||
/**
|
||||
* - Social Id
|
||||
*/
|
||||
social_id?: string | number;
|
||||
/**
|
||||
* - Social Platform
|
||||
*/
|
||||
social_platform?: string;
|
||||
/**
|
||||
* - Payload
|
||||
*/
|
||||
payload?: object;
|
||||
/**
|
||||
* - Alert
|
||||
*/
|
||||
alert?: boolean;
|
||||
/**
|
||||
* - New User
|
||||
*/
|
||||
newUser?: any;
|
||||
}>;
|
||||
import http = require("http");
|
||||
Vendored
+28
@@ -0,0 +1,28 @@
|
||||
export = localGoogleAuth;
|
||||
/**
|
||||
* SERVER FUNCTION: Login with google Function
|
||||
* ==============================================================================
|
||||
*
|
||||
* @async
|
||||
*
|
||||
* @param {object} params - main params object
|
||||
* @param {string} params.token - Google access token gotten from the client side
|
||||
* @param {string} params.clientId - Google client id
|
||||
* @param {http.ServerResponse} params.response - HTTPS response object
|
||||
* @param {object} [params.additionalFields] - Additional Fields to be added to the user object
|
||||
* @param {import("../../../package-shared/types").DSQL_DatabaseSchemaType} [params.dbSchema] - Database Schema
|
||||
*
|
||||
* @returns { Promise<FunctionReturn> }
|
||||
*/
|
||||
declare function localGoogleAuth({ dbSchema, token, clientId, response, additionalFields, }: {
|
||||
token: string;
|
||||
clientId: string;
|
||||
response: http.ServerResponse;
|
||||
additionalFields?: object;
|
||||
dbSchema?: import("../../../package-shared/types").DSQL_DatabaseSchemaType;
|
||||
}): Promise<FunctionReturn>;
|
||||
declare namespace localGoogleAuth {
|
||||
export { FunctionReturn };
|
||||
}
|
||||
import http = require("http");
|
||||
type FunctionReturn = object | null;
|
||||
+182
@@ -0,0 +1,182 @@
|
||||
export = githubLogin;
|
||||
/**
|
||||
*
|
||||
* @typedef {object} GithubUserPayload
|
||||
* @property {string} login - Full name merged eg. "JohnDoe"
|
||||
* @property {number} id - github user id
|
||||
* @property {string} node_id - Some other id
|
||||
* @property {string} avatar_url - profile picture
|
||||
* @property {string} gravatar_id - some other id
|
||||
* @property {string} url - Github user URL
|
||||
* @property {string} html_url - User html URL - whatever that means
|
||||
* @property {string} followers_url - Followers URL
|
||||
* @property {string} following_url - Following URL
|
||||
* @property {string} gists_url - Gists URL
|
||||
* @property {string} starred_url - Starred URL
|
||||
* @property {string} subscriptions_url - Subscriptions URL
|
||||
* @property {string} organizations_url - Organizations URL
|
||||
* @property {string} repos_url - Repositories URL
|
||||
* @property {string} received_events_url - Received Events URL
|
||||
* @property {string} type - Common value => "User"
|
||||
* @property {boolean} site_admin - Is site admin or not? Boolean
|
||||
* @property {string} name - More like "username"
|
||||
* @property {string} company - User company
|
||||
* @property {string} blog - User blog URL
|
||||
* @property {string} location - User Location
|
||||
* @property {string} email - User Email
|
||||
* @property {string} hireable - Is user hireable
|
||||
* @property {string} bio - User bio
|
||||
* @property {string} twitter_username - User twitter username
|
||||
* @property {number} public_repos - Number of public repositories
|
||||
* @property {number} public_gists - Number of public gists
|
||||
* @property {number} followers - Number of followers
|
||||
* @property {number} following - Number of following
|
||||
* @property {string} created_at - Date created
|
||||
* @property {string} updated_at - Date updated
|
||||
*/
|
||||
/**
|
||||
* Login/signup a github user
|
||||
* ==============================================================================
|
||||
* @async
|
||||
*
|
||||
* @param {Object} params - foundUser if any
|
||||
* @param {string} params.code - github auth token
|
||||
* @param {string} params.clientId - github client Id
|
||||
* @param {string} params.clientSecret - github client Secret
|
||||
*
|
||||
* @returns {Promise<GithubUserPayload|null>}
|
||||
*/
|
||||
declare function githubLogin({ code, clientId, clientSecret }: {
|
||||
code: string;
|
||||
clientId: string;
|
||||
clientSecret: string;
|
||||
}): Promise<GithubUserPayload | null>;
|
||||
declare namespace githubLogin {
|
||||
export { GithubUserPayload };
|
||||
}
|
||||
type GithubUserPayload = {
|
||||
/**
|
||||
* - Full name merged eg. "JohnDoe"
|
||||
*/
|
||||
login: string;
|
||||
/**
|
||||
* - github user id
|
||||
*/
|
||||
id: number;
|
||||
/**
|
||||
* - Some other id
|
||||
*/
|
||||
node_id: string;
|
||||
/**
|
||||
* - profile picture
|
||||
*/
|
||||
avatar_url: string;
|
||||
/**
|
||||
* - some other id
|
||||
*/
|
||||
gravatar_id: string;
|
||||
/**
|
||||
* - Github user URL
|
||||
*/
|
||||
url: string;
|
||||
/**
|
||||
* - User html URL - whatever that means
|
||||
*/
|
||||
html_url: string;
|
||||
/**
|
||||
* - Followers URL
|
||||
*/
|
||||
followers_url: string;
|
||||
/**
|
||||
* - Following URL
|
||||
*/
|
||||
following_url: string;
|
||||
/**
|
||||
* - Gists URL
|
||||
*/
|
||||
gists_url: string;
|
||||
/**
|
||||
* - Starred URL
|
||||
*/
|
||||
starred_url: string;
|
||||
/**
|
||||
* - Subscriptions URL
|
||||
*/
|
||||
subscriptions_url: string;
|
||||
/**
|
||||
* - Organizations URL
|
||||
*/
|
||||
organizations_url: string;
|
||||
/**
|
||||
* - Repositories URL
|
||||
*/
|
||||
repos_url: string;
|
||||
/**
|
||||
* - Received Events URL
|
||||
*/
|
||||
received_events_url: string;
|
||||
/**
|
||||
* - Common value => "User"
|
||||
*/
|
||||
type: string;
|
||||
/**
|
||||
* - Is site admin or not? Boolean
|
||||
*/
|
||||
site_admin: boolean;
|
||||
/**
|
||||
* - More like "username"
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* - User company
|
||||
*/
|
||||
company: string;
|
||||
/**
|
||||
* - User blog URL
|
||||
*/
|
||||
blog: string;
|
||||
/**
|
||||
* - User Location
|
||||
*/
|
||||
location: string;
|
||||
/**
|
||||
* - User Email
|
||||
*/
|
||||
email: string;
|
||||
/**
|
||||
* - Is user hireable
|
||||
*/
|
||||
hireable: string;
|
||||
/**
|
||||
* - User bio
|
||||
*/
|
||||
bio: string;
|
||||
/**
|
||||
* - User twitter username
|
||||
*/
|
||||
twitter_username: string;
|
||||
/**
|
||||
* - Number of public repositories
|
||||
*/
|
||||
public_repos: number;
|
||||
/**
|
||||
* - Number of public gists
|
||||
*/
|
||||
public_gists: number;
|
||||
/**
|
||||
* - Number of followers
|
||||
*/
|
||||
followers: number;
|
||||
/**
|
||||
* - Number of following
|
||||
*/
|
||||
following: number;
|
||||
/**
|
||||
* - Date created
|
||||
*/
|
||||
created_at: string;
|
||||
/**
|
||||
* - Date updated
|
||||
*/
|
||||
updated_at: string;
|
||||
};
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
export = handleSocialDb;
|
||||
/**
|
||||
* Handle Social User Auth on Datasquirel Database
|
||||
* ==============================================================================
|
||||
*
|
||||
* @description This function handles all social login logic after the social user
|
||||
* has been authenticated and userpayload is present. The payload MUST contain the
|
||||
* specified fields because this funciton will create a new user if the authenticated
|
||||
* user does not exist.
|
||||
*
|
||||
* @param {{
|
||||
* database: string|null|undefined,
|
||||
* social_id: string|number,
|
||||
* email: string,
|
||||
* social_platform: string,
|
||||
* payload: {
|
||||
* social_id: string | number,
|
||||
* email: string,
|
||||
* social_platform: string,
|
||||
* first_name: string,
|
||||
* last_name: string,
|
||||
* image: string,
|
||||
* image_thumbnail: string,
|
||||
* username: string,
|
||||
* },
|
||||
* res: http.ServerResponse,
|
||||
* supEmail?: string | null,
|
||||
* additionalFields?: object,
|
||||
* dbSchema: import("../../../../package-shared/types").DSQL_DatabaseSchemaType | undefined
|
||||
* }} params - function parameters inside an object
|
||||
*
|
||||
* @returns {Promise<FunctionReturn>} - Response object
|
||||
*/
|
||||
declare function handleSocialDb({ social_id, email, social_platform, payload, res, supEmail, additionalFields, dbSchema, }: {
|
||||
database: string | null | undefined;
|
||||
social_id: string | number;
|
||||
email: string;
|
||||
social_platform: string;
|
||||
payload: {
|
||||
social_id: string | number;
|
||||
email: string;
|
||||
social_platform: string;
|
||||
first_name: string;
|
||||
last_name: string;
|
||||
image: string;
|
||||
image_thumbnail: string;
|
||||
username: string;
|
||||
};
|
||||
res: http.ServerResponse;
|
||||
supEmail?: string | null;
|
||||
additionalFields?: object;
|
||||
dbSchema: import("../../../../package-shared/types").DSQL_DatabaseSchemaType | undefined;
|
||||
}): Promise<FunctionReturn>;
|
||||
declare namespace handleSocialDb {
|
||||
export { FunctionReturn };
|
||||
}
|
||||
import http = require("http");
|
||||
type FunctionReturn = {
|
||||
/**
|
||||
* - Did the operation complete successfully or not?
|
||||
*/
|
||||
success: boolean;
|
||||
/**
|
||||
* - User payload object: or "null"
|
||||
*/
|
||||
user: {
|
||||
id: number;
|
||||
first_name: string;
|
||||
last_name: string;
|
||||
} | null;
|
||||
/**
|
||||
* - Message
|
||||
*/
|
||||
msg?: string;
|
||||
/**
|
||||
* - Error Message
|
||||
*/
|
||||
error?: string;
|
||||
/**
|
||||
* - Social Id
|
||||
*/
|
||||
social_id?: string | number;
|
||||
/**
|
||||
* - Social Platform
|
||||
*/
|
||||
social_platform?: string;
|
||||
/**
|
||||
* - Payload
|
||||
*/
|
||||
payload?: object;
|
||||
/**
|
||||
* - Alert
|
||||
*/
|
||||
alert?: boolean;
|
||||
/**
|
||||
* - New User
|
||||
*/
|
||||
newUser?: any;
|
||||
};
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
export = httpsRequest;
|
||||
/**
|
||||
* Main Function
|
||||
* ==============================================================================
|
||||
* @param {{
|
||||
* url?: string,
|
||||
* method: string,
|
||||
* hostname: string,
|
||||
* path?: string,
|
||||
* href?: string,
|
||||
* headers?: object,
|
||||
* body?: object,
|
||||
* }} params - params
|
||||
*/
|
||||
declare function httpsRequest({ url, method, hostname, path, href, headers, body }: {
|
||||
url?: string;
|
||||
method: string;
|
||||
hostname: string;
|
||||
path?: string;
|
||||
href?: string;
|
||||
headers?: object;
|
||||
body?: object;
|
||||
}): Promise<any>;
|
||||
Reference in New Issue
Block a user