@pipl-csui/sso-ui.js 0.0.0-stage → 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,132 @@
+/**
+ * * `"1.0"`: `/validate`
+ * * `"2.0"`: `/serviceValidate`
+ * * `"3.0"`: `/p3/serviceValidate`
+ */
+type CASVersion = "1.0" | "2.0" | "3.0";
+/**
+ * the vocabulary for kd_org field
+ */
+interface OrgDetails {
+    /** Faculty name in id. e.g. Fakultas Ilmu Komputer */
+    fakultas: string;
+    /** Faculty name in en. e.g. Faculty of Computer Science */
+    faculty: string;
+    /** Short name in id. e.g. Fasilkom, FT, FK; vernacular names */
+    fak: string;
+    /** Short name in en. e.g. CS, SCI; based on faculty homepage subdomain */
+    fac: string;
+    /** Department name in id, based on the faculty. e.g. Departemen Matematika */
+    departemen: string;
+    /** Department name in en, based on the faculty. e.g. Department of Mathematics */
+    department: string;
+    /** Department short name. e.g. DTE, MATH */
+    dep: string;
+    /** Major name in id. e.g. Sarjana Ilmu Komputer */
+    prodi: string;
+    /** Major name in en. e.g. Bachelor of Computer Science */
+    major: string;
+    /** Alias for {@linkcode prodi} */
+    studyProgram?: string;
+    /** jenjang */
+    educationalProgram?: string;
+}
+/**
+ * user but normalized
+ */
+interface SSOUser {
+    /** SSO username */
+    username: string;
+    /** Full name */
+    name: string;
+    role: "mahasiswa" | "staff" | string;
+    /** NPM if {@linkcode role} is `"mahasiswa"` */
+    npm?: string;
+    /** NPM if {@linkcode role} is `"staff"` */
+    nip?: string;
+    /** Organization code; `kd_org` */
+    orgCode?: string;
+    organization?: OrgDetails;
+    /** Common name for LDAP */
+    ldapCn?: string;
+    /** Raw attributes */
+    rawAttributes: Record<string, string>;
+}
+interface SSOConfig {
+    /**
+    * base url
+    * @default "https://sso.ui.ac.id/cas2"
+    */
+    casUrl?: string;
+    /**
+    * @default "2.0"
+    */
+    version?: CASVersion;
+    /**
+    * callback url for your app
+    */
+    serviceUrl?: string;
+    /**
+    * @default 10000
+    */
+    timeoutMs?: number;
+    fetch?: typeof globalThis.fetch;
+}
+interface LoginUrlOptions {
+    /** URL to redirect after the login */
+    serviceUrl?: string;
+    renew?: boolean;
+    gateway?: boolean;
+}
+interface LogoutUrlOptions {
+    serviceUrl?: string;
+    url?: string;
+}
+interface ValidateTicketOptions {
+    serviceUrl?: string;
+    version?: CASVersion;
+    signal?: AbortSignal;
+    fetchOptions?: RequestInit;
+}
+type res = {
+    success: true;
+    user: SSOUser;
+    error?: never;
+} | {
+    success: false;
+    user?: never;
+    error: Error;
+};
+
+declare const DEFAULT_CAS_URL = "https://sso.ui.ac.id/cas2";
+declare function normalize(url?: string): string;
+declare function LoginURL(casUrl: string, serviceUrl?: string, options?: LoginUrlOptions): string;
+declare function LogoutURL(casUrl: string, options?: LogoutUrlOptions): string;
+declare function ValidateURL(casUrl: string, serviceUrl: string, ticket: string, version?: CASVersion): string;
+
+interface RawOrgEntry {
+    faculty: string;
+    shortFaculty: string;
+    major: string;
+    program: string;
+}
+declare const ORG_CODES: Record<string, RawOrgEntry>;
+
+declare function lookupOrgCode(code?: string): OrgDetails | undefined;
+
+declare function parseResponse(body: string, version?: CASVersion): SSOUser;
+declare class SSO {
+    casUrl: string;
+    serviceUrl?: string;
+    version: CASVersion;
+    timeoutMs: number;
+    fetchFn: typeof globalThis.fetch;
+    constructor(config?: SSOConfig);
+    loginUrl(serviceUrl?: string, options?: LoginUrlOptions): string;
+    logoutUrl(options?: LogoutUrlOptions | string): string;
+    validate(ticket: string, options?: ValidateTicketOptions | string): Promise<SSOUser>;
+    validateSafe(ticket: string, options?: ValidateTicketOptions | string): Promise<res>;
+}
+
+export { DEFAULT_CAS_URL, LoginURL, LogoutURL, ORG_CODES, SSO, ValidateURL, SSO as default, lookupOrgCode, normalize, parseResponse };
+export type { CASVersion, LoginUrlOptions, LogoutUrlOptions, OrgDetails, RawOrgEntry, SSOConfig, SSOUser, ValidateTicketOptions, res };

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+/**
+ * * `"1.0"`: `/validate`
+ * * `"2.0"`: `/serviceValidate`
+ * * `"3.0"`: `/p3/serviceValidate`
+ */
+type CASVersion = "1.0" | "2.0" | "3.0";
+/**
+ * the vocabulary for kd_org field
+ */
+interface OrgDetails {
+    /** Faculty name in id. e.g. Fakultas Ilmu Komputer */
+    fakultas: string;
+    /** Faculty name in en. e.g. Faculty of Computer Science */
+    faculty: string;
+    /** Short name in id. e.g. Fasilkom, FT, FK; vernacular names */
+    fak: string;
+    /** Short name in en. e.g. CS, SCI; based on faculty homepage subdomain */
+    fac: string;
+    /** Department name in id, based on the faculty. e.g. Departemen Matematika */
+    departemen: string;
+    /** Department name in en, based on the faculty. e.g. Department of Mathematics */
+    department: string;
+    /** Department short name. e.g. DTE, MATH */
+    dep: string;
+    /** Major name in id. e.g. Sarjana Ilmu Komputer */
+    prodi: string;
+    /** Major name in en. e.g. Bachelor of Computer Science */
+    major: string;
+    /** Alias for {@linkcode prodi} */
+    studyProgram?: string;
+    /** jenjang */
+    educationalProgram?: string;
+}
+/**
+ * user but normalized
+ */
+interface SSOUser {
+    /** SSO username */
+    username: string;
+    /** Full name */
+    name: string;
+    role: "mahasiswa" | "staff" | string;
+    /** NPM if {@linkcode role} is `"mahasiswa"` */
+    npm?: string;
+    /** NPM if {@linkcode role} is `"staff"` */
+    nip?: string;
+    /** Organization code; `kd_org` */
+    orgCode?: string;
+    organization?: OrgDetails;
+    /** Common name for LDAP */
+    ldapCn?: string;
+    /** Raw attributes */
+    rawAttributes: Record<string, string>;
+}
+interface SSOConfig {
+    /**
+    * base url
+    * @default "https://sso.ui.ac.id/cas2"
+    */
+    casUrl?: string;
+    /**
+    * @default "2.0"
+    */
+    version?: CASVersion;
+    /**
+    * callback url for your app
+    */
+    serviceUrl?: string;
+    /**
+    * @default 10000
+    */
+    timeoutMs?: number;
+    fetch?: typeof globalThis.fetch;
+}
+interface LoginUrlOptions {
+    /** URL to redirect after the login */
+    serviceUrl?: string;
+    renew?: boolean;
+    gateway?: boolean;
+}
+interface LogoutUrlOptions {
+    serviceUrl?: string;
+    url?: string;
+}
+interface ValidateTicketOptions {
+    serviceUrl?: string;
+    version?: CASVersion;
+    signal?: AbortSignal;
+    fetchOptions?: RequestInit;
+}
+type res = {
+    success: true;
+    user: SSOUser;
+    error?: never;
+} | {
+    success: false;
+    user?: never;
+    error: Error;
+};
+
+declare const DEFAULT_CAS_URL = "https://sso.ui.ac.id/cas2";
+declare function normalize(url?: string): string;
+declare function LoginURL(casUrl: string, serviceUrl?: string, options?: LoginUrlOptions): string;
+declare function LogoutURL(casUrl: string, options?: LogoutUrlOptions): string;
+declare function ValidateURL(casUrl: string, serviceUrl: string, ticket: string, version?: CASVersion): string;
+
+interface RawOrgEntry {
+    faculty: string;
+    shortFaculty: string;
+    major: string;
+    program: string;
+}
+declare const ORG_CODES: Record<string, RawOrgEntry>;
+
+declare function lookupOrgCode(code?: string): OrgDetails | undefined;
+
+declare function parseResponse(body: string, version?: CASVersion): SSOUser;
+declare class SSO {
+    casUrl: string;
+    serviceUrl?: string;
+    version: CASVersion;
+    timeoutMs: number;
+    fetchFn: typeof globalThis.fetch;
+    constructor(config?: SSOConfig);
+    loginUrl(serviceUrl?: string, options?: LoginUrlOptions): string;
+    logoutUrl(options?: LogoutUrlOptions | string): string;
+    validate(ticket: string, options?: ValidateTicketOptions | string): Promise<SSOUser>;
+    validateSafe(ticket: string, options?: ValidateTicketOptions | string): Promise<res>;
+}
+
+export { DEFAULT_CAS_URL, LoginURL, LogoutURL, ORG_CODES, SSO, ValidateURL, SSO as default, lookupOrgCode, normalize, parseResponse };
+export type { CASVersion, LoginUrlOptions, LogoutUrlOptions, OrgDetails, RawOrgEntry, SSOConfig, SSOUser, ValidateTicketOptions, res };