@spica-devkit/auth 0.18.10 → 0.18.11

package/dist/index.d.ts

@@ -1 +1,127 @@
-export * from "./src/index";
+interface User {
+    _id: string;
+    username: string;
+    password: string;
+    policies: string[];
+    lastLogin?: Date;
+    failedAttempts?: Date[];
+}
+type UserCreate = Omit<User, "_id" | "lastLogin" | "failedAttempts" | "policies">;
+type UserGet = Omit<User, "password">;
+type UserUpdate = Pick<User, "password">;
+type TokenScheme = {
+    token: string;
+};
+type VerificationStrategy = "Otp" | "MagicLink";
+type Provider = "email" | "phone";
+interface VerificationStartResponse {
+    message: string;
+    value: string;
+    metadata: Record<string, any>;
+}
+interface VerificationCompleteResponse {
+    message: string;
+    provider: string;
+    destination: string;
+}
+interface PasswordResetStartResponse {
+    message: string;
+}
+interface PasswordResetCompleteResponse {
+    message: string;
+}
+interface PasswordlessLoginStartResponse {
+    message: string;
+    metadata?: Record<string, any>;
+}
+interface PasswordlessLoginCompleteResponse {
+    token: string;
+    scheme: string;
+    issuer: string;
+}
+interface VerifiedToken {
+    _id: string;
+    username: string;
+    [key: string]: any;
+}
+
+interface HttpService {
+    baseUrl: string;
+    setBaseUrl(url: string): void;
+    setAuthorization(authorization: string): void;
+    getAuthorization(): string;
+    setWriteDefaults(writeDefaults: {
+        headers: {
+            [key: string]: string;
+        };
+    }): void;
+    get<T>(url: string, options?: any): Promise<T>;
+    post<T>(url: string, body: any, options?: any): Promise<T>;
+    put<T>(url: string, body: any, options?: any): Promise<T>;
+    patch<T>(url: string, body: any, options?: any): Promise<T>;
+    delete(url: string, options?: any): any;
+    request<T>(options: any): Promise<T>;
+}
+interface PublicInitialization {
+    publicUrl?: string;
+}
+interface ApikeyInitialization extends PublicInitialization {
+    apikey: string;
+}
+interface IdentityInitialization extends PublicInitialization {
+    identity: string;
+}
+interface UserInitialization extends PublicInitialization {
+    user: string;
+}
+
+declare class UserSession {
+    private _token;
+    private readonly _userId;
+    private readonly _username;
+    private readonly _service;
+    constructor(params: {
+        token: string;
+        userId: string;
+        username: string;
+        service: HttpService;
+    });
+    get token(): string;
+    get userId(): string;
+    get username(): string;
+    private getAuthHeaders;
+    get(headers?: object): Promise<UserGet>;
+    updatePassword(password: string, headers?: object): Promise<UserGet>;
+    refreshAccessToken(headers?: object): Promise<string>;
+    addEmail(value: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationStartResponse>;
+    verifyEmail(code: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationCompleteResponse>;
+    addPhoneNumber(value: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationStartResponse>;
+    verifyPhoneNumber(code: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationCompleteResponse>;
+    completePasswordReset(code: string, newPassword: string, provider: Provider, headers?: object): Promise<PasswordResetCompleteResponse>;
+}
+
+type UserSelfUpdate = {
+    password: string;
+};
+
+declare function initialize(options: ApikeyInitialization | IdentityInitialization | UserInitialization | PublicInitialization): void;
+declare function verifyToken(token: string, headers?: object): Promise<unknown>;
+declare function signIn(username: string, password: string, tokenLifeSpan?: number, headers?: object): Promise<UserSession>;
+declare function signUp(user: UserCreate, headers?: object): Promise<UserGet>;
+declare function get(id: string, headers?: object): Promise<UserGet>;
+declare function updatePassword(id: string, user: UserSelfUpdate, headers?: object): Promise<UserGet>;
+declare function refreshAccessToken(accessToken: string, headers?: object): Promise<string>;
+declare function updateUsername(id: string, username: string, headers?: object): Promise<UserGet>;
+declare function ban(id: string, bannedUntil: Date, headers?: object): Promise<UserGet>;
+declare function deactivateUserTokens(id: string, deactivateJwtsBefore: Date, headers?: object): Promise<UserGet>;
+declare function addEmail(id: string, value: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationStartResponse>;
+declare function verifyEmail(id: string, code: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationCompleteResponse>;
+declare function addPhoneNumber(id: string, value: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationStartResponse>;
+declare function verifyPhoneNumber(id: string, code: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationCompleteResponse>;
+declare function requestPasswordReset(username: string, provider: Provider, headers?: object): Promise<PasswordResetStartResponse>;
+declare function completePasswordReset(username: string, code: string, newPassword: string, provider: Provider, headers?: object): Promise<PasswordResetCompleteResponse>;
+declare function passwordlessLogin(username: string, provider: Provider, headers?: object): Promise<PasswordlessLoginStartResponse>;
+declare function completePasswordlessLogin(username: string, code: string, provider: Provider, headers?: object): Promise<UserSession>;
+
+export { UserSession, addEmail, addPhoneNumber, ban, completePasswordReset, completePasswordlessLogin, deactivateUserTokens, get, initialize, passwordlessLogin, refreshAccessToken, requestPasswordReset, signIn, signUp, updatePassword, updateUsername, verifyEmail, verifyPhoneNumber, verifyToken };
+export type { PasswordResetCompleteResponse, PasswordResetStartResponse, PasswordlessLoginCompleteResponse, PasswordlessLoginStartResponse, Provider, TokenScheme, UserCreate, UserGet, UserUpdate, VerificationCompleteResponse, VerificationStartResponse, VerificationStrategy, VerifiedToken };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spica-devkit/auth",
   "license": "AGPLv3",
-  "version": "0.18.10",
+  "version": "0.18.11",
   "description": "Auth package for Spica.",
   "author": "spica",
   "keywords": [

package/dist/src/auth.d.ts

@@ -1,22 +0,0 @@
-import { UserCreate, UserGet, VerificationStrategy, Provider, VerificationStartResponse, VerificationCompleteResponse, PasswordResetStartResponse, PasswordResetCompleteResponse, PasswordlessLoginStartResponse } from "./interface";
-import { UserSession } from "./user-session";
-import { ApikeyInitialization, IdentityInitialization, PublicInitialization, UserInitialization } from "@spica-server/interface/function/packages";
-import { UserSelfUpdate } from "@spica-server/interface/passport/user";
-export declare function initialize(options: ApikeyInitialization | IdentityInitialization | UserInitialization | PublicInitialization): void;
-export declare function verifyToken(token: string, headers?: object): Promise<unknown>;
-export declare function signIn(username: string, password: string, tokenLifeSpan?: number, headers?: object): Promise<UserSession>;
-export declare function signUp(user: UserCreate, headers?: object): Promise<UserGet>;
-export declare function get(id: string, headers?: object): Promise<UserGet>;
-export declare function updatePassword(id: string, user: UserSelfUpdate, headers?: object): Promise<UserGet>;
-export declare function refreshAccessToken(accessToken: string, headers?: object): Promise<string>;
-export declare function updateUsername(id: string, username: string, headers?: object): Promise<UserGet>;
-export declare function ban(id: string, bannedUntil: Date, headers?: object): Promise<UserGet>;
-export declare function deactivateUserTokens(id: string, deactivateJwtsBefore: Date, headers?: object): Promise<UserGet>;
-export declare function addEmail(id: string, value: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationStartResponse>;
-export declare function verifyEmail(id: string, code: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationCompleteResponse>;
-export declare function addPhoneNumber(id: string, value: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationStartResponse>;
-export declare function verifyPhoneNumber(id: string, code: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationCompleteResponse>;
-export declare function requestPasswordReset(username: string, provider: Provider, headers?: object): Promise<PasswordResetStartResponse>;
-export declare function completePasswordReset(username: string, code: string, newPassword: string, provider: Provider, headers?: object): Promise<PasswordResetCompleteResponse>;
-export declare function passwordlessLogin(username: string, provider: Provider, headers?: object): Promise<PasswordlessLoginStartResponse>;
-export declare function completePasswordlessLogin(username: string, code: string, provider: Provider, headers?: object): Promise<UserSession>;

package/dist/src/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./auth";
-export * from "./interface";
-export { UserSession } from "./user-session";

package/dist/src/interface.d.ts

@@ -1,47 +0,0 @@
-interface User {
-    _id: string;
-    username: string;
-    password: string;
-    policies: string[];
-    lastLogin?: Date;
-    failedAttempts?: Date[];
-}
-export type UserCreate = Omit<User, "_id" | "lastLogin" | "failedAttempts" | "policies">;
-export type UserGet = Omit<User, "password">;
-export type UserUpdate = Pick<User, "password">;
-export type TokenScheme = {
-    token: string;
-};
-export type VerificationStrategy = "Otp" | "MagicLink";
-export type Provider = "email" | "phone";
-export interface VerificationStartResponse {
-    message: string;
-    value: string;
-    metadata: Record<string, any>;
-}
-export interface VerificationCompleteResponse {
-    message: string;
-    provider: string;
-    destination: string;
-}
-export interface PasswordResetStartResponse {
-    message: string;
-}
-export interface PasswordResetCompleteResponse {
-    message: string;
-}
-export interface PasswordlessLoginStartResponse {
-    message: string;
-    metadata?: Record<string, any>;
-}
-export interface PasswordlessLoginCompleteResponse {
-    token: string;
-    scheme: string;
-    issuer: string;
-}
-export interface VerifiedToken {
-    _id: string;
-    username: string;
-    [key: string]: any;
-}
-export {};

package/dist/src/user-session.d.ts

@@ -1,26 +0,0 @@
-import { UserGet, VerificationStrategy, Provider, VerificationStartResponse, VerificationCompleteResponse, PasswordResetCompleteResponse } from "./interface";
-import { HttpService } from "@spica-server/interface/function/packages";
-export declare class UserSession {
-    private _token;
-    private readonly _userId;
-    private readonly _username;
-    private readonly _service;
-    constructor(params: {
-        token: string;
-        userId: string;
-        username: string;
-        service: HttpService;
-    });
-    get token(): string;
-    get userId(): string;
-    get username(): string;
-    private getAuthHeaders;
-    get(headers?: object): Promise<UserGet>;
-    updatePassword(password: string, headers?: object): Promise<UserGet>;
-    refreshAccessToken(headers?: object): Promise<string>;
-    addEmail(value: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationStartResponse>;
-    verifyEmail(code: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationCompleteResponse>;
-    addPhoneNumber(value: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationStartResponse>;
-    verifyPhoneNumber(code: string, strategy: VerificationStrategy, headers?: object): Promise<VerificationCompleteResponse>;
-    completePasswordReset(code: string, newPassword: string, provider: Provider, headers?: object): Promise<PasswordResetCompleteResponse>;
-}