@logto/schemas 1.0.0-beta.11

package/lib/types/log.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logTypeGuard = exports.tokenTypeGuard = exports.TokenType = exports.baseLogPayloadGuard = exports.logResultGuard = exports.LogResult = void 0;
+const zod_1 = require("zod");
+var LogResult;
+(function (LogResult) {
+    LogResult["Success"] = "Success";
+    LogResult["Error"] = "Error";
+})(LogResult = exports.LogResult || (exports.LogResult = {}));
+exports.logResultGuard = zod_1.z.nativeEnum(LogResult);
+exports.baseLogPayloadGuard = zod_1.z.object({
+    result: exports.logResultGuard.optional(),
+    error: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
+    ip: zod_1.z.string().optional(),
+    userAgent: zod_1.z.string().optional(),
+    applicationId: zod_1.z.string().optional(),
+    sessionId: zod_1.z.string().optional(),
+});
+const arbitraryLogPayloadGuard = zod_1.z.record(zod_1.z.string(), zod_1.z.unknown());
+const registerUsernamePasswordLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({ userId: zod_1.z.string().optional(), username: zod_1.z.string().optional() }));
+const registerEmailSendPasscodeLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({ email: zod_1.z.string().optional(), connectorId: zod_1.z.string().optional() }));
+const registerEmailLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    email: zod_1.z.string().optional(),
+    code: zod_1.z.string().optional(),
+    userId: zod_1.z.string().optional(),
+}));
+const registerSmsSendPasscodeLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    phone: zod_1.z.string().optional(),
+    connectorId: zod_1.z.string().optional(),
+}));
+const registerSmsLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    phone: zod_1.z.string().optional(),
+    code: zod_1.z.string().optional(),
+    userId: zod_1.z.string().optional(),
+}));
+const registerSocialBindLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    connectorId: zod_1.z.string().optional(),
+    userId: zod_1.z.string().optional(),
+    userInfo: zod_1.z.unknown().optional(),
+}));
+const registerSocialLogPayloadGuard = registerSocialBindLogPayloadGuard.and(zod_1.z.object({
+    code: zod_1.z.string().optional(),
+    state: zod_1.z.string().optional(),
+    redirectUri: zod_1.z.string().optional(),
+    redirectTo: zod_1.z.string().optional(),
+}));
+const signInUsernamePasswordLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    userId: zod_1.z.string().optional(),
+    username: zod_1.z.string().optional(),
+}));
+const signInEmailSendPasscodeLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    email: zod_1.z.string().optional(),
+    connectorId: zod_1.z.string().optional(),
+}));
+const signInEmailLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    email: zod_1.z.string().optional(),
+    code: zod_1.z.string().optional(),
+    userId: zod_1.z.string().optional(),
+}));
+const signInSmsSendPasscodeLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    phone: zod_1.z.string().optional(),
+    connectorId: zod_1.z.string().optional(),
+}));
+const signInSmsLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    phone: zod_1.z.string().optional(),
+    code: zod_1.z.string().optional(),
+    userId: zod_1.z.string().optional(),
+}));
+const signInSocialBindLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    connectorId: zod_1.z.string().optional(),
+    userId: zod_1.z.string().optional(),
+    userInfo: zod_1.z.unknown().optional(),
+}));
+const signInSocialLogPayloadGuard = signInSocialBindLogPayloadGuard.and(zod_1.z.object({
+    code: zod_1.z.string().optional(),
+    state: zod_1.z.string().optional(),
+    redirectUri: zod_1.z.string().optional(),
+    redirectTo: zod_1.z.string().optional(),
+}));
+const forgotPasswordSmsSendPasscodeLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    phone: zod_1.z.string().optional(),
+    connectorId: zod_1.z.string().optional(),
+}));
+const forgotPasswordSmsLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    phone: zod_1.z.string().optional(),
+    code: zod_1.z.string().optional(),
+    userId: zod_1.z.string().optional(),
+}));
+const forgotPasswordEmailSendPasscodeLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    email: zod_1.z.string().optional(),
+    connectorId: zod_1.z.string().optional(),
+}));
+const forgotPasswordEmailLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    email: zod_1.z.string().optional(),
+    code: zod_1.z.string().optional(),
+    userId: zod_1.z.string().optional(),
+}));
+const forgotPasswordResetLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    userId: zod_1.z.string().optional(),
+}));
+var TokenType;
+(function (TokenType) {
+    TokenType["AccessToken"] = "AccessToken";
+    TokenType["RefreshToken"] = "RefreshToken";
+    TokenType["IdToken"] = "IdToken";
+})(TokenType = exports.TokenType || (exports.TokenType = {}));
+exports.tokenTypeGuard = zod_1.z.nativeEnum(TokenType);
+const exchangeTokenLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    userId: zod_1.z.string().optional(),
+    params: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
+    issued: exports.tokenTypeGuard.array().optional(),
+    scope: zod_1.z.string().optional(),
+}));
+const revokeTokenLogPayloadGuard = arbitraryLogPayloadGuard.and(zod_1.z.object({
+    userId: zod_1.z.string().optional(),
+    params: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
+    tokenType: exports.tokenTypeGuard.optional(),
+    grantId: zod_1.z.string().optional(),
+}));
+const logPayloadsGuard = zod_1.z.object({
+    RegisterUsernamePassword: registerUsernamePasswordLogPayloadGuard,
+    RegisterEmailSendPasscode: registerEmailSendPasscodeLogPayloadGuard,
+    RegisterEmail: registerEmailLogPayloadGuard,
+    RegisterSmsSendPasscode: registerSmsSendPasscodeLogPayloadGuard,
+    RegisterSms: registerSmsLogPayloadGuard,
+    RegisterSocialBind: registerSocialBindLogPayloadGuard,
+    RegisterSocial: registerSocialLogPayloadGuard,
+    SignInUsernamePassword: signInUsernamePasswordLogPayloadGuard,
+    SignInEmailSendPasscode: signInEmailSendPasscodeLogPayloadGuard,
+    SignInEmail: signInEmailLogPayloadGuard,
+    SignInSmsSendPasscode: signInSmsSendPasscodeLogPayloadGuard,
+    SignInSms: signInSmsLogPayloadGuard,
+    SignInSocialBind: signInSocialBindLogPayloadGuard,
+    SignInSocial: signInSocialLogPayloadGuard,
+    ForgotPasswordSmsSendPasscode: forgotPasswordSmsSendPasscodeLogPayloadGuard,
+    ForgotPasswordSms: forgotPasswordSmsLogPayloadGuard,
+    ForgotPasswordEmailSendPasscode: forgotPasswordEmailSendPasscodeLogPayloadGuard,
+    ForgotPasswordEmail: forgotPasswordEmailLogPayloadGuard,
+    ForgotPasswordReset: forgotPasswordResetLogPayloadGuard,
+    CodeExchangeToken: exchangeTokenLogPayloadGuard,
+    RefreshTokenExchangeToken: exchangeTokenLogPayloadGuard,
+    RevokeToken: revokeTokenLogPayloadGuard,
+});
+exports.logTypeGuard = logPayloadsGuard.keyof();

package/lib/types/logto-config.d.ts

@@ -0,0 +1,32 @@
+import { ZodType } from 'zod';
+export declare enum AlterationStateKey {
+    AlterationState = "alterationState"
+}
+export declare type AlterationState = {
+    timestamp: number;
+    updatedAt?: string;
+};
+export declare type AlterationStateType = {
+    [AlterationStateKey.AlterationState]: AlterationState;
+};
+export declare const alterationStateGuard: Readonly<{
+    [key in AlterationStateKey]: ZodType<AlterationStateType[key]>;
+}>;
+export declare enum LogtoOidcConfigKey {
+    PrivateKeys = "oidc.privateKeys",
+    CookieKeys = "oidc.cookieKeys",
+    RefreshTokenReuseInterval = "oidc.refreshTokenReuseInterval"
+}
+export declare type LogtoOidcConfigType = {
+    [LogtoOidcConfigKey.PrivateKeys]: string[];
+    [LogtoOidcConfigKey.CookieKeys]: string[];
+    [LogtoOidcConfigKey.RefreshTokenReuseInterval]: number;
+};
+export declare const logtoOidcConfigGuard: Readonly<{
+    [key in LogtoOidcConfigKey]: ZodType<LogtoOidcConfigType[key]>;
+}>;
+export declare type LogtoConfigKey = AlterationStateKey | LogtoOidcConfigKey;
+export declare type LogtoConfigType = AlterationStateType | LogtoOidcConfigType;
+export declare type LogtoConfigGuard = typeof alterationStateGuard & typeof logtoOidcConfigGuard;
+export declare const logtoConfigKeys: readonly LogtoConfigKey[];
+export declare const logtoConfigGuards: LogtoConfigGuard;

package/lib/types/logto-config.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logtoConfigGuards = exports.logtoConfigKeys = exports.logtoOidcConfigGuard = exports.LogtoOidcConfigKey = exports.alterationStateGuard = exports.AlterationStateKey = void 0;
+const zod_1 = require("zod");
+// Alteration state
+var AlterationStateKey;
+(function (AlterationStateKey) {
+    AlterationStateKey["AlterationState"] = "alterationState";
+})(AlterationStateKey = exports.AlterationStateKey || (exports.AlterationStateKey = {}));
+exports.alterationStateGuard = Object.freeze({
+    [AlterationStateKey.AlterationState]: zod_1.z.object({
+        timestamp: zod_1.z.number(),
+        updatedAt: zod_1.z.string().optional(),
+    }),
+});
+// Logto OIDC config
+var LogtoOidcConfigKey;
+(function (LogtoOidcConfigKey) {
+    LogtoOidcConfigKey["PrivateKeys"] = "oidc.privateKeys";
+    LogtoOidcConfigKey["CookieKeys"] = "oidc.cookieKeys";
+    LogtoOidcConfigKey["RefreshTokenReuseInterval"] = "oidc.refreshTokenReuseInterval";
+})(LogtoOidcConfigKey = exports.LogtoOidcConfigKey || (exports.LogtoOidcConfigKey = {}));
+exports.logtoOidcConfigGuard = Object.freeze({
+    [LogtoOidcConfigKey.PrivateKeys]: zod_1.z.string().array(),
+    [LogtoOidcConfigKey.CookieKeys]: zod_1.z.string().array(),
+    /**
+     * This interval helps to avoid concurrency issues when exchanging the rotating refresh token multiple times within a given timeframe.
+     * During the leeway window (in seconds), the consumed refresh token will be considered as valid.
+     * This is useful for distributed apps and serverless apps like Next.js, in which there is no shared memory.
+     */
+    [LogtoOidcConfigKey.RefreshTokenReuseInterval]: zod_1.z.number().gte(3),
+});
+exports.logtoConfigKeys = Object.freeze([
+    ...Object.values(AlterationStateKey),
+    ...Object.values(LogtoOidcConfigKey),
+]);
+exports.logtoConfigGuards = Object.freeze({
+    ...exports.alterationStateGuard,
+    ...exports.logtoOidcConfigGuard,
+});

package/lib/types/oidc-config.d.ts

@@ -0,0 +1,12 @@
+import { KeysToCamelCase } from '@silverhand/essentials';
+export declare type SnakeCaseOidcConfig = {
+    authorization_endpoint: string;
+    userinfo_endpoint: string;
+    token_endpoint: string;
+};
+export declare type OidcConfig = KeysToCamelCase<SnakeCaseOidcConfig>;
+export declare enum GrantType {
+    AuthorizationCode = "authorization_code",
+    RefreshToken = "refresh_token",
+    ClientCredentials = "client_credentials"
+}

package/lib/types/oidc-config.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GrantType = void 0;
+var GrantType;
+(function (GrantType) {
+    GrantType["AuthorizationCode"] = "authorization_code";
+    GrantType["RefreshToken"] = "refresh_token";
+    GrantType["ClientCredentials"] = "client_credentials";
+})(GrantType = exports.GrantType || (exports.GrantType = {}));

package/lib/types/user.d.ts

@@ -0,0 +1,6 @@
+import { CreateUser } from '../db-entries';
+export declare const userInfoSelectFields: readonly ["id", "username", "primaryEmail", "primaryPhone", "name", "avatar", "roleNames", "customData", "identities", "lastSignInAt", "createdAt", "applicationId"];
+export declare type UserInfo<Keys extends keyof CreateUser = typeof userInfoSelectFields[number]> = Pick<CreateUser, Keys>;
+export declare enum UserRole {
+    Admin = "admin"
+}

package/lib/types/user.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserRole = exports.userInfoSelectFields = void 0;
+exports.userInfoSelectFields = Object.freeze([
+    'id',
+    'username',
+    'primaryEmail',
+    'primaryPhone',
+    'name',
+    'avatar',
+    'roleNames',
+    'customData',
+    'identities',
+    'lastSignInAt',
+    'createdAt',
+    'applicationId',
+]);
+var UserRole;
+(function (UserRole) {
+    UserRole["Admin"] = "admin";
+})(UserRole = exports.UserRole || (exports.UserRole = {}));

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@logto/schemas",
+  "version": "1.0.0-beta.11",
+  "main": "lib/index.js",
+  "author": "Silverhand Inc. <contact@silverhand.io>",
+  "license": "MPL-2.0",
+  "files": [
+    "lib",
+    "alterations"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": "^16.0.0"
+  },
+  "devDependencies": {
+    "@silverhand/eslint-config": "1.2.0",
+    "@silverhand/essentials": "^1.3.0",
+    "@silverhand/jest-config": "1.2.2",
+    "@silverhand/ts-config": "1.2.1",
+    "@types/jest": "^29.1.2",
+    "@types/lodash.uniq": "^4.5.6",
+    "@types/node": "^16.0.0",
+    "@types/pluralize": "^0.0.29",
+    "camelcase": "^6.2.0",
+    "eslint": "^8.21.0",
+    "jest": "^29.1.2",
+    "lint-staged": "^13.0.0",
+    "lodash.uniq": "^4.5.0",
+    "pluralize": "^8.0.0",
+    "prettier": "^2.7.1",
+    "slonik": "^30.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  },
+  "eslintConfig": {
+    "extends": "@silverhand",
+    "rules": {
+      "@typescript-eslint/ban-types": "off"
+    },
+    "overrides": [
+      {
+        "files": [
+          "alterations/*.ts"
+        ],
+        "rules": {
+          "unicorn/filename-case": "off"
+        }
+      }
+    ]
+  },
+  "prettier": "@silverhand/eslint-config/.prettierrc",
+  "dependencies": {
+    "@logto/connector-kit": "1.0.0-beta.18",
+    "@logto/core-kit": "1.0.0-beta.18",
+    "@logto/language-kit": "1.0.0-beta.19",
+    "@logto/phrases": "^1.0.0-beta.11",
+    "@logto/phrases-ui": "^1.0.0-beta.11",
+    "zod": "^3.18.0"
+  },
+  "scripts": {
+    "precommit": "lint-staged",
+    "version": "./update-next.sh && git add alterations/",
+    "generate": "rm -rf src/db-entries && ts-node src/gen/index.ts && eslint \"src/db-entries/**\" --fix",
+    "build:alterations": "rm -rf alterations-js && tsc -p tsconfig.build.alterations.json",
+    "build": "pnpm generate && rm -rf lib/ && tsc -p tsconfig.build.json && pnpm build:alterations",
+    "dev": "tsc -p tsconfig.build.json --watch --preserveWatchOutput --incremental",
+    "lint": "eslint --ext .ts src",
+    "lint:report": "pnpm lint --format json --output-file report.json",
+    "test": "jest",
+    "test:ci": "jest"
+  }
+}