@logto/js 1.1.0 → 2.0.0

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@logto/js",
-  "version": "1.1.0",
-  "source": "./src/index.ts",
-  "main": "./lib/index.js",
+  "version": "2.0.0",
+  "type": "module",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "exports": {
-    "require": "./lib/index.js",
-    "import": "./lib/module.mjs"
+    "types": "./lib/index.d.ts",
+    "require": "./lib/index.cjs",
+    "import": "./lib/index.js"
   },
-  "module": "./lib/module.mjs",
-  "types": "./lib/index.d.ts",
   "files": [
     "lib"
   ],
@@ -18,43 +19,29 @@
     "url": "https://github.com/logto-io/js.git",
     "directory": "packages/js"
   },
-  "scripts": {
-    "dev:tsc": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
-    "precommit": "lint-staged",
-    "check": "tsc --noEmit",
-    "build": "rm -rf lib/ && pnpm check && parcel build && cp lib/index.d.ts lib/module.d.mts",
-    "lint": "eslint --ext .ts src",
-    "test": "jest",
-    "test:coverage": "jest --silent --env=jsdom && jest --silent --coverage",
-    "prepack": "pnpm test"
-  },
   "dependencies": {
-    "@silverhand/essentials": "^1.2.1",
+    "@silverhand/essentials": "^2.6.2",
     "camelcase-keys": "^7.0.1",
-    "jose": "^4.3.8",
-    "lodash.get": "^4.4.2"
+    "jose": "^4.13.2"
   },
   "devDependencies": {
-    "@jest/types": "^27.5.1",
-    "@parcel/core": "^2.8.3",
-    "@parcel/packager-ts": "^2.8.3",
-    "@parcel/transformer-typescript-types": "^2.8.3",
-    "@silverhand/eslint-config": "^2.0.0",
-    "@silverhand/ts-config": "^1.0.0",
-    "@types/jest": "^27.4.1",
-    "@types/lodash.get": "^4.4.6",
+    "@silverhand/eslint-config": "^3.0.1",
+    "@silverhand/ts-config": "^3.0.0",
+    "@swc/core": "^1.3.50",
+    "@swc/jest": "^0.2.24",
+    "@types/jest": "^29.5.1",
     "@types/node": "^18.0.0",
-    "eslint": "^8.23.0",
-    "jest": "^27.5.1",
+    "eslint": "^8.38.0",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
     "jest-matcher-specific-error": "^1.0.0",
     "lint-staged": "^13.0.0",
-    "nock": "^13.1.3",
-    "parcel": "^2.8.3",
-    "prettier": "^2.7.1",
+    "nock": "^13.3.0",
+    "prettier": "^2.8.7",
+    "rollup": "^3.20.2",
     "text-encoder": "^0.0.4",
-    "ts-jest": "^27.0.4",
     "type-fest": "^3.0.0",
-    "typescript": "4.9.5"
+    "typescript": "^5.0.0"
   },
   "eslintConfig": {
     "extends": "@silverhand"
@@ -63,5 +50,13 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f24174a6f840b8db968ad3886878d1b6e92b1b9d"
-}
+  "scripts": {
+    "dev:tsc": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
+    "precommit": "lint-staged",
+    "check": "tsc --noEmit",
+    "build": "rm -rf lib/ && tsc -p tsconfig.build.json --noEmit && rollup -c",
+    "lint": "eslint --ext .ts src",
+    "test": "jest",
+    "test:coverage": "jest --silent --env=jsdom && jest --silent"
+  }
+}

package/lib/index.d.ts

@@ -1,224 +0,0 @@
-import { KeysToCamelCase, NormalizeKeyPaths, Nullable } from "@silverhand/essentials";
-import { JWTVerifyGetKey } from "jose";
-export const ContentType: {
-    formUrlEncoded: {
-        'Content-Type': string;
-    };
-};
-export enum TokenGrantType {
-    AuthorizationCode = "authorization_code",
-    RefreshToken = "refresh_token"
-}
-export enum QueryKey {
-    ClientId = "client_id",
-    Code = "code",
-    CodeChallenge = "code_challenge",
-    CodeChallengeMethod = "code_challenge_method",
-    CodeVerifier = "code_verifier",
-    Error = "error",
-    ErrorDescription = "error_description",
-    GrantType = "grant_type",
-    IdToken = "id_token",
-    IdTokenHint = "id_token_hint",
-    PostLogoutRedirectUri = "post_logout_redirect_uri",
-    Prompt = "prompt",
-    RedirectUri = "redirect_uri",
-    RefreshToken = "refresh_token",
-    Resource = "resource",
-    ResponseType = "response_type",
-    Scope = "scope",
-    State = "state",
-    Token = "token",
-    InteractionMode = "interaction_mode"
-}
-export enum Prompt {
-    Consent = "consent",
-    Login = "login"
-}
-export enum ReservedScope {
-    OpenId = "openid",
-    OfflineAccess = "offline_access"
-}
-/**
- * Scopes for ID Token and Userinfo Endpoint.
- */
-export enum UserScope {
-    /**
-     * Scope for basic user info.
-     *
-     * See {@link idTokenClaims} for mapped claims in ID Token and {@link userinfoClaims} for additional claims in Userinfo Endpoint.
-     */
-    Profile = "profile",
-    /**
-     * Scope for user email address.
-     *
-     * See {@link idTokenClaims} for mapped claims in ID Token and {@link userinfoClaims} for additional claims in Userinfo Endpoint.
-     */
-    Email = "email",
-    /**
-     * Scope for user phone number.
-     *
-     * See {@link idTokenClaims} for mapped claims in ID Token and {@link userinfoClaims} for additional claims in Userinfo Endpoint.
-     */
-    Phone = "phone",
-    /**
-     * Scope for user's custom data.
-     *
-     * See {@link idTokenClaims} for mapped claims in ID Token and {@link userinfoClaims} for additional claims in Userinfo Endpoint.
-     */
-    CustomData = "custom_data",
-    /**
-     * Scope for user's social identity details.
-     *
-     * See {@link idTokenClaims} for mapped claims in ID Token and {@link userinfoClaims} for additional claims in Userinfo Endpoint.
-     */
-    Identities = "identities"
-}
-export type LogtoRequestErrorBody = {
-    code: string;
-    message: string;
-};
-export type Requester = <T>(...args: Parameters<typeof fetch>) => Promise<T>;
-export type InteractionMode = 'signIn' | 'signUp';
-export type FetchTokenByAuthorizationCodeParameters = {
-    clientId: string;
-    tokenEndpoint: string;
-    redirectUri: string;
-    codeVerifier: string;
-    code: string;
-    resource?: string;
-};
-export type FetchTokenByRefreshTokenParameters = {
-    clientId: string;
-    tokenEndpoint: string;
-    refreshToken: string;
-    resource?: string;
-    scopes?: string[];
-};
-type SnakeCaseCodeTokenResponse = {
-    access_token: string;
-    refresh_token?: string;
-    id_token: string;
-    scope: string;
-    expires_in: number;
-};
-export type CodeTokenResponse = KeysToCamelCase<SnakeCaseCodeTokenResponse>;
-type SnakeCaseRefreshTokenTokenResponse = {
-    access_token: string;
-    refresh_token: string;
-    id_token?: string;
-    scope: string;
-    expires_in: number;
-};
-export type RefreshTokenTokenResponse = KeysToCamelCase<SnakeCaseRefreshTokenTokenResponse>;
-export const fetchTokenByAuthorizationCode: ({ clientId, tokenEndpoint, redirectUri, codeVerifier, code, resource, }: FetchTokenByAuthorizationCodeParameters, requester: Requester) => Promise<CodeTokenResponse>;
-export const fetchTokenByRefreshToken: ({ clientId, tokenEndpoint, refreshToken, resource, scopes }: FetchTokenByRefreshTokenParameters, requester: Requester) => Promise<RefreshTokenTokenResponse>;
-type OidcConfigSnakeCaseResponse = {
-    authorization_endpoint: string;
-    token_endpoint: string;
-    userinfo_endpoint: string;
-    end_session_endpoint: string;
-    revocation_endpoint: string;
-    jwks_uri: string;
-    issuer: string;
-};
-export const discoveryPath = "/oidc/.well-known/openid-configuration";
-export type OidcConfigResponse = KeysToCamelCase<OidcConfigSnakeCaseResponse>;
-export const fetchOidcConfig: (endpoint: string, requester: Requester) => Promise<OidcConfigResponse>;
-export const revoke: (revocationEndpoint: string, clientId: string, token: string, requester: Requester) => Promise<void>;
-export const isArbitraryObject: (data: unknown) => data is Record<string, unknown>;
-declare const logtoErrorCodes: Readonly<{
-    id_token: {
-        invalid_iat: string;
-        invalid_token: string;
-    };
-    callback_uri_verification: {
-        redirect_uri_mismatched: string;
-        error_found: string;
-        missing_state: string;
-        state_mismatched: string;
-        missing_code: string;
-    };
-    crypto_subtle_unavailable: "Crypto.subtle is unavailable in insecure contexts (non-HTTPS).";
-    unexpected_response_error: "Unexpected response error from the server.";
-}>;
-export type LogtoErrorCode = NormalizeKeyPaths<typeof logtoErrorCodes>;
-export class LogtoError extends Error {
-    code: LogtoErrorCode;
-    data: unknown;
-    constructor(code: LogtoErrorCode, data?: unknown);
-}
-export const isLogtoRequestError: (data: unknown) => data is {
-    code: string;
-    message: string;
-};
-export class LogtoRequestError extends Error {
-    code: string;
-    constructor(code: string, message: string);
-}
-export class OidcError {
-    error: string;
-    errorDescription?: string | undefined;
-    constructor(error: string, errorDescription?: string | undefined);
-}
-export const parseUriParameters: (uri: string) => URLSearchParams;
-export const verifyAndParseCodeFromCallbackUri: (callbackUri: string, redirectUri: string, state: string) => string;
-export type IdTokenClaims = {
-    iss: string;
-    sub: string;
-    aud: string;
-    exp: number;
-    iat: number;
-    at_hash?: Nullable<string>;
-    name?: Nullable<string>;
-    username?: Nullable<string>;
-    picture?: Nullable<string>;
-    email?: Nullable<string>;
-    email_verified?: boolean;
-    phone_number?: Nullable<string>;
-    phone_number_verified?: boolean;
-};
-export const verifyIdToken: (idToken: string, clientId: string, issuer: string, jwks: JWTVerifyGetKey) => Promise<void>;
-export const decodeIdToken: (token: string) => IdTokenClaims;
-/**
- * @param originalScopes
- * @return scopes should contain all default scopes (`openid`, `offline_access` and `profile`)
- */
-export const withDefaultScopes: (originalScopes?: string[]) => string;
-export type SignInUriParameters = {
-    authorizationEndpoint: string;
-    clientId: string;
-    redirectUri: string;
-    codeChallenge: string;
-    state: string;
-    scopes?: string[];
-    resources?: string[];
-    prompt?: Prompt;
-    interactionMode?: InteractionMode;
-};
-export const generateSignInUri: ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, interactionMode, }: SignInUriParameters) => string;
-type SignOutUriParameters = {
-    endSessionEndpoint: string;
-    clientId: string;
-    postLogoutRedirectUri?: string;
-};
-export const generateSignOutUri: ({ endSessionEndpoint, clientId, postLogoutRedirectUri, }: SignOutUriParameters) => string;
-type Identity = {
-    userId: string;
-    details?: Record<string, unknown>;
-};
-export type UserInfoResponse = {
-    sub: string;
-    name?: Nullable<string>;
-    username?: Nullable<string>;
-    picture?: Nullable<string>;
-    email?: Nullable<string>;
-    email_verified?: boolean;
-    phone_number?: Nullable<string>;
-    phone_number_verified?: boolean;
-    custom_data?: unknown;
-    identities?: Record<string, Identity>;
-};
-export const fetchUserInfo: (userInfoEndpoint: string, accessToken: string, requester: Requester) => Promise<UserInfoResponse>;
-
-//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"mappings":";;AAAA,OAAO,MAAM;;;;CAEZ,CAAC;AAEF;IACE,iBAAiB,uBAAuB;IACxC,YAAY,kBAAkB;CAC/B;AAED;IACE,QAAQ,cAAc;IACtB,IAAI,SAAS;IACb,aAAa,mBAAmB;IAChC,mBAAmB,0BAA0B;IAC7C,YAAY,kBAAkB;IAC9B,KAAK,UAAU;IACf,gBAAgB,sBAAsB;IACtC,SAAS,eAAe;IACxB,OAAO,aAAa;IACpB,WAAW,kBAAkB;IAC7B,qBAAqB,6BAA6B;IAClD,iBAAiB;IACjB,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,QAAQ,aAAa;IACrB,YAAY,kBAAkB;IAC9B,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IAEf,eAAe,qBAAqB;CACrC;AAED;IACE,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAGD;IACE,MAAM,WAAW;IACjB,aAAa,mBAAmB;CACjC;AAED;;GAEG;AACH;IACE;;;;OAIG;IACH,OAAO,YAAY;IACnB;;;;OAIG;IACH,KAAK,UAAU;IACf;;;;OAIG;IACH,KAAK,UAAU;IACf;;;;OAIG;IACH,UAAU,gBAAgB;IAC1B;;;;OAIG;IACH,UAAU,eAAe;CAC1B;AC9ED,oCAAoC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,wBAAwB,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAG7E,8BAA8B,QAAQ,GAAG,QAAQ,CAAC;ACFlD,sDAAsD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,iDAAiD;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,kCAAkC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,gCAAgC,gBAAgB,0BAA0B,CAAC,CAAC;AAE5E,0CAA0C;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,wCAAwC,gBAAgB,kCAAkC,CAAC,CAAC;AAE5F,OAAO,MAAM,yGAQR,uCAAuC,aAC/B,SAAS,KACnB,QAAQ,iBAAiB,CAmB3B,CAAC;AAEF,OAAO,MAAM,wFACkD,kCAAkC,aACpF,SAAS,KACnB,QAAQ,yBAAyB,CAwBnC,CAAC;AChGF,mCAAmC;IACjC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,OAAO,MAAM,wDAAwD,CAAC;AAEtE,iCAAiC,gBAAgB,2BAA2B,CAAC,CAAC;AAE9E,OAAO,MAAM,4BACD,MAAM,aACL,SAAS,KACnB,QAAQ,kBAAkB,CAC0C,CAAC;ACpBxE,OAAO,MAAM,6BACS,MAAM,YAChB,MAAM,SACT,MAAM,aACF,SAAS,KACnB,QAAQ,IAAI,CAQX,CAAC;AChBL,OAAO,MAAM,0BAA2B,OAAO,oCACJ,CAAC;ACI5C,QAAA,MAAM;;;;;;;;;;;;;;EAcJ,CAAC;AAEH,6BAA6B,kBAAkB,sBAAsB,CAAC,CAAC;AAavE,uBAAwB,SAAQ,KAAK;IACnC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,OAAO,CAAC;gBAEF,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,EAAE,OAAO;CAKjD;AAED,OAAO,MAAM,4BAA6B,OAAO;UAAmB,MAAM;aAAW,MAAM;CAM1F,CAAC;AAEF,8BAA+B,SAAQ,KAAK;IAC1C,IAAI,EAAE,MAAM,CAAC;gBAED,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAI1C;AAED;IACqB,KAAK,EAAE,MAAM;IAAS,gBAAgB,CAAC;gBAAvC,KAAK,EAAE,MAAM,EAAS,gBAAgB,CAAC,oBAAQ;CACnE;AC3DD,OAAO,MAAM,0BAA2B,MAAM,oBAI7C,CAAC;AAEF,OAAO,MAAM,iDACE,MAAM,eACN,MAAM,SACZ,MAAM,WAkCd,CAAC;ACtCF,4BAA4B;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IAC3B,IAAI,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IACxB,QAAQ,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IAC5B,OAAO,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IAC3B,KAAK,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IAChC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AA6CF,OAAO,MAAM,yBACF,MAAM,YACL,MAAM,UACR,MAAM,QACR,eAAe,kBAOtB,CAAC;AAEF,OAAO,MAAM,uBAAwB,MAAM,KAAG,aAY7C,CAAC;AC5FF;;;GAGG;AACH,OAAO,MAAM,qCAAsC,MAAM,EAAE,KAAG,MAK7D,CAAC;AEJF,kCAAkC;IAChC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC;AAEF,OAAO,MAAM,yIAUV,mBAAmB,WAsBrB,CAAC;ACjDF,4BAA4B;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,OAAO,MAAM,+EAIV,oBAAoB,WAQtB,CAAC;AChBF,gBAAgB;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF,+BAA+B;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IACxB,QAAQ,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IAC5B,OAAO,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IAC3B,KAAK,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,SAAS,MAAM,CAAC,CAAC;IAChC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CACvC,CAAC;AAEF,OAAO,MAAM,kCACO,MAAM,eACX,MAAM,aACR,SAAS,KACnB,QAAQ,gBAAgB,CAGvB,CAAC","sources":["packages/js/src/src/consts/index.ts","packages/js/src/src/types/index.ts","packages/js/src/src/core/fetch-token.ts","packages/js/src/src/core/oidc-config.ts","packages/js/src/src/core/revoke.ts","packages/js/src/src/utils/arbitrary-object.ts","packages/js/src/src/utils/errors.ts","packages/js/src/src/utils/callback-uri.ts","packages/js/src/src/utils/id-token.ts","packages/js/src/src/utils/scopes.ts","packages/js/src/src/utils/index.ts","packages/js/src/src/core/sign-in.ts","packages/js/src/src/core/sign-out.ts","packages/js/src/src/core/user-info.ts","packages/js/src/src/core/index.ts","packages/js/src/src/index.ts","packages/js/src/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,"/* istanbul ignore file */\nexport * from './core';\nexport * from './utils';\nexport * from './consts';\nexport * from './types';\n"],"names":[],"version":3,"file":"index.d.ts.map"}