@logto/schemas 1.14.0 → 1.16.0

package/alterations-js/1.15.0-1711607772-remove-invite-member-scope-from-tenant-member-role.js

@@ -0,0 +1,16 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      delete from organization_role_scope_relations
+        where tenant_id = 'admin' and organization_role_id = 'member' and organization_scope_id = 'invite-member';
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      insert into organization_role_scope_relations (tenant_id, organization_role_id, organization_scope_id)
+        values ('admin', 'member', 'invite-member');
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.15.0-1711624564-add-read-member-scope-to-tenant-roles.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.15.0-1711624564-add-read-member-scope-to-tenant-roles.js

@@ -0,0 +1,21 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      insert into organization_scopes (tenant_id, id, name, description)
+        values ('admin', 'read-member', 'read:member', 'Read members of the tenant.');
+      insert into organization_role_scope_relations (tenant_id, organization_role_id, organization_scope_id)
+        values ('admin', 'admin', 'read-member'),
+               ('admin', 'member', 'read-member');
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      delete from organization_role_scope_relations
+        where tenant_id = 'admin' and organization_scope_id = 'read-member';
+      delete from organization_scopes
+        where tenant_id = 'admin' and id = 'read-member';
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.15.0-1711955211-organization-resource-scope.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.15.0-1711955211-organization-resource-scope.js

@@ -0,0 +1,32 @@
+import { sql } from '@silverhand/slonik';
+import { applyTableRls, dropTableRls } from './utils/1704934999-tables.js';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      create table organization_role_resource_scope_relations (
+        tenant_id varchar(21) not null
+          references tenants (id) on update cascade on delete cascade,
+        organization_role_id varchar(21) not null
+          references organization_roles (id) on update cascade on delete cascade,
+        scope_id varchar(21) not null
+          references scopes (id) on update cascade on delete cascade,
+        primary key (tenant_id, organization_role_id, scope_id)
+      );
+    `);
+        await applyTableRls(pool, 'organization_role_resource_scope_relations');
+    },
+    down: async (pool) => {
+        const result = await pool.maybeOne(sql `
+      select * from information_schema.tables 
+      where table_name = 'organization_role_resource_scope_relations'
+    `);
+        if (!result) {
+            return;
+        }
+        await dropTableRls(pool, 'organization_role_resource_scope_relations');
+        await pool.query(sql `
+      drop table organization_role_resource_scope_relations
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.15.0-1712041436-rename-organization-member-role-to-collaborator.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.15.0-1712041436-rename-organization-member-role-to-collaborator.js

@@ -0,0 +1,24 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      update organization_roles
+        set id = 'collaborator', name = 'collaborator', description = 'Collaborator of the tenant, who has permissions to operate the tenant data, but not the tenant settings.'
+        where tenant_id = 'admin' and id = 'member';
+      update organization_role_scope_relations
+        set organization_role_id = 'collaborator'
+        where tenant_id = 'admin' and organization_role_id = 'member';
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      update organization_roles
+        set id = 'member', name = 'member', description = 'Member of the tenant, who has permissions to operate the tenant data, but not the tenant settings.'
+        where tenant_id = 'admin' and id = 'collaborator';
+      update organization_role_scope_relations
+        set organization_role_id = 'member'
+        where tenant_id = 'admin' and organization_role_id = 'collaborator';
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.15.0-1712545011-fix-organization-resource-scope.d.ts

@@ -0,0 +1,8 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+/**
+ * The script `next-1711955211-organization-resource-scope` was merged after `next-1712041436-rename-organization-member-role-to-collaborator`,
+ * so the table `organization_role_resource_scope_relations` may not be created in the database.
+ * This script is to fix the issue, try to create the table if it is not exists.
+ */
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.15.0-1712545011-fix-organization-resource-scope.js

@@ -0,0 +1,35 @@
+import { sql } from '@silverhand/slonik';
+import { applyTableRls } from './utils/1704934999-tables.js';
+/**
+ * The script `next-1711955211-organization-resource-scope` was merged after `next-1712041436-rename-organization-member-role-to-collaborator`,
+ * so the table `organization_role_resource_scope_relations` may not be created in the database.
+ * This script is to fix the issue, try to create the table if it is not exists.
+ */
+const alteration = {
+    up: async (pool) => {
+        const result = await pool.maybeOne(sql `
+      select * from information_schema.tables 
+      where table_name = 'organization_role_resource_scope_relations'
+    `);
+        if (result) {
+            // The table already exists, do nothing
+            return;
+        }
+        await pool.query(sql `
+      create table organization_role_resource_scope_relations (
+        tenant_id varchar(21) not null
+          references tenants (id) on update cascade on delete cascade,
+        organization_role_id varchar(21) not null
+          references organization_roles (id) on update cascade on delete cascade,
+        scope_id varchar(21) not null
+          references scopes (id) on update cascade on delete cascade,
+        primary key (tenant_id, organization_role_id, scope_id)
+      );
+    `);
+        await applyTableRls(pool, 'organization_role_resource_scope_relations');
+    },
+    down: async () => {
+        // Do nothing
+    },
+};
+export default alteration;

package/alterations-js/1.15.0-1712559358-fix-down-organization-resource-scope.d.ts

@@ -0,0 +1,8 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+/**
+ * The script `next-1711955211-organization-resource-scope` was merged after `next-1712041436-rename-organization-member-role-to-collaborator`,
+ * so the table `organization_role_resource_scope_relations` may not be created in the database.
+ * This script is to fix the issue, try to create the table if it is not exists.
+ */
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.15.0-1712559358-fix-down-organization-resource-scope.js

@@ -0,0 +1,38 @@
+import { sql } from '@silverhand/slonik';
+import { applyTableRls, dropTableRls } from './utils/1704934999-tables.js';
+/**
+ * The script `next-1711955211-organization-resource-scope` was merged after `next-1712041436-rename-organization-member-role-to-collaborator`,
+ * so the table `organization_role_resource_scope_relations` may not be created in the database.
+ * This script is to fix the issue, try to create the table if it is not exists.
+ */
+const alteration = {
+    up: async (pool) => {
+        const result = await pool.maybeOne(sql `
+      select * from information_schema.tables 
+      where table_name = 'organization_role_resource_scope_relations'
+    `);
+        if (result) {
+            // The table already exists, do nothing
+            return;
+        }
+        await pool.query(sql `
+      create table organization_role_resource_scope_relations (
+        tenant_id varchar(21) not null
+          references tenants (id) on update cascade on delete cascade,
+        organization_role_id varchar(21) not null
+          references organization_roles (id) on update cascade on delete cascade,
+        scope_id varchar(21) not null
+          references scopes (id) on update cascade on delete cascade,
+        primary key (tenant_id, organization_role_id, scope_id)
+      );
+    `);
+        await applyTableRls(pool, 'organization_role_resource_scope_relations');
+    },
+    down: async (pool) => {
+        await dropTableRls(pool, 'organization_role_resource_scope_relations');
+        await pool.query(sql `
+      drop table organization_role_resource_scope_relations
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.16.0-1712912361-delete-jwt-customier-with-empty-script.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.16.0-1712912361-delete-jwt-customier-with-empty-script.js

@@ -0,0 +1,17 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    // We are making the jwt-customizer script field mandatory
+    // Delete the records in logto_configs where key is jwt.accessToken or jwt.clientCredentials and value jsonb's script field is undefined
+    up: async (pool) => {
+        await pool.query(sql `
+        delete from logto_configs 
+        where key in ('jwt.accessToken', 'jwt.clientCredentials')
+        and value->>'script' is null
+      `);
+    },
+    down: async () => {
+        // No down script available, this is a non-reversible operation
+        // It is fine since we have not released this feature yet
+    },
+};
+export default alteration;

package/alterations-js/1.16.0-1713942039-add-organization-custom-data.d.ts

@@ -0,0 +1,4 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+/** The alteration script to add the `custom_data` field to the `organizations` table. */
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.16.0-1713942039-add-organization-custom-data.js

@@ -0,0 +1,17 @@
+import { sql } from '@silverhand/slonik';
+/** The alteration script to add the `custom_data` field to the `organizations` table. */
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+        alter table organizations
+        add column custom_data jsonb not null default '{}'::jsonb;
+      `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+        alter table organizations
+        drop column custom_data;
+      `);
+    },
+};
+export default alteration;

package/alterations-js/1.16.0-1714270244-application-org-resource-scope.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.16.0-1714270244-application-org-resource-scope.js

@@ -0,0 +1,27 @@
+import { sql } from '@silverhand/slonik';
+import { applyTableRls, dropTableRls } from './utils/1704934999-tables.js';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      create table application_user_consent_organization_resource_scopes (
+        tenant_id varchar(21) not null
+          references tenants (id) on update cascade on delete cascade,
+        /** The globally unique identifier of the application. */
+        application_id varchar(21) not null
+          references applications (id) on update cascade on delete cascade,
+        /** The globally unique identifier of the resource scope. */
+        scope_id varchar(21) not null
+          references scopes (id) on update cascade on delete cascade,
+        primary key (application_id, scope_id)
+      );
+    `);
+        await applyTableRls(pool, 'application_user_consent_organization_resource_scopes');
+    },
+    down: async (pool) => {
+        await dropTableRls(pool, 'application_user_consent_organization_resource_scopes');
+        await pool.query(sql `
+      drop table application_user_consent_organization_resource_scopes
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.2.0-1681267285-fix-get-started-passwordless-status.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const adminConsoleConfigKey = 'adminConsole';
 const alteration = {
     up: async (pool) => {

package/alterations-js/1.3.0-1683292832-update-hooks.js

@@ -1,5 +1,5 @@
 import { generateStandardId } from '@logto/shared';
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 var HookEvent;
 (function (HookEvent) {
     HookEvent["PostRegister"] = "PostRegister";

package/alterations-js/1.5.0-1684382842-add-name-tag-created-at-for-tenants-table.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const alteration = {
     up: async (pool) => {
         // Add new tenant columns for name, tag, and created_at.

package/alterations-js/1.5.0-1684739802-create-hook-id-index-for-logs.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const alteration = {
     up: async (pool) => {
         await pool.query(sql `

package/alterations-js/1.5.0-1684822341-init-domains.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const getId = (value) => sql.identifier([value]);
 const getDatabaseName = async (pool) => {
     const { currentDatabase } = await pool.one(sql `

package/alterations-js/1.5.0-1684837981-add-manage-tenant-self-scope-to-user-role.js

@@ -1,5 +1,5 @@
 import { generateStandardId } from '@logto/shared/universal';
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const adminTenantId = 'admin';
 const alteration = {
     up: async (pool) => {

package/alterations-js/1.5.0-1685285719-support-default-resource.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const alteration = {
     up: async (pool) => {
         await pool.query(sql `

package/alterations-js/1.6.0-1685691718-domain-unique.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const alteration = {
     up: async (pool) => {
         await pool.query(sql `

package/alterations-js/1.7.0-1688375200-sync-cloud-m2m-to-logto-config.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const adminTenantId = 'admin';
 const cloudServiceApplicationName = 'Cloud Service';
 const cloudConnectionResourceIndicator = 'https://cloud.logto.io/api';

package/alterations-js/1.7.0-1688613459-remove-m2m-credentials-from-existing-logto-email-connector-config.js

@@ -1,6 +1,6 @@
 import { GlobalValues } from '@logto/shared';
 import { appendPath } from '@silverhand/essentials';
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 var ServiceConnector;
 (function (ServiceConnector) {
     ServiceConnector["Email"] = "logto-email";

package/alterations-js/1.7.0-1688627407-daily-active-users.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const getId = (value) => sql.identifier([value]);
 const getDatabaseName = async (pool) => {
     const { currentDatabase } = await pool.one(sql `

package/alterations-js/1.8.0-1692088012-add-is-suspend-column-to-tenants-table.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const alteration = {
     up: async (pool) => {
         await pool.query(sql `

package/alterations-js/1.8.0-1692194751-add-affiliate-scopes.js

@@ -1,5 +1,5 @@
 import { generateStandardId } from '@logto/shared/universal';
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const adminTenantId = 'admin';
 const alteration = {
     up: async (pool) => {

package/alterations-js/1.9.0-1693554904-add-possword-policy.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 /** The alteration script for adding `password_policy` column to the sign-in experience table. */
 const alteration = {
     up: async (pool) => {

package/alterations-js/1.9.0-1694399696-add-type-col-to-roles-table.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 var InternalRole;
 (function (InternalRole) {
     InternalRole["Admin"] = "#internal:admin";

package/alterations-js/1.9.0-1694418765-specify-check-role-type-function-to-be-public-schema.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 /**
  * This alteration is a fix on `check_role_type` function, since this function could be called by
  * cloud (at the time the DB schema is `cloud` and can not find `public` functions/tables).

package/alterations-js/1.9.0-1694484927-remove-deprecated-challenge-flag.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const adminConsoleConfigKey = 'adminConsole';
 const alterAdminConsoleData = async (logtoConfig, pool) => {
     const { tenantId, value: oldAdminConsoleConfig } = logtoConfig;

package/alterations-js/1.9.0-1694487524-sie-mfa.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const alteration = {
     up: async (pool) => {
         await pool.query(sql `

package/alterations-js/1.9.0-1694509714-keep-existing-password-policy.js

@@ -1,5 +1,5 @@
 import { yes } from '@silverhand/essentials';
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 // In the alteration testing environment, we do not want to run this alteration
 // script since it alters the existing data which does not match the new policy.
 const isAlterationTesting = yes(process.env.ALTERATION_TEST);

package/alterations-js/1.9.0-1694746763-user-verifications.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const alteration = {
     up: async (pool) => {
         await pool.query(sql `

package/alterations-js/1.9.2-1694854226-init-sentinel.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const getDatabaseName = async (pool) => {
     const { currentDatabase } = await pool.one(sql `
     select current_database();

package/alterations-js/1.9.2-1695198741-remove-m2m-app-admin-access-switch.js

@@ -1,6 +1,6 @@
 import { generateStandardId } from '@logto/shared/universal';
 import { deduplicate } from '@silverhand/essentials';
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 var InternalRole;
 (function (InternalRole) {
     InternalRole["Admin"] = "#internal:admin";

package/alterations-js/utils/1704934999-tables.d.ts

@@ -1,4 +1,4 @@
-import { type CommonQueryMethods } from 'slonik';
+import { type CommonQueryMethods } from '@silverhand/slonik';
 /**
  * A function to call after the table is created. It will apply the necessary row-level security
  * policies and triggers to the table.

package/alterations-js/utils/1704934999-tables.js

@@ -1,4 +1,4 @@
-import { sql } from 'slonik';
+import { sql } from '@silverhand/slonik';
 const getId = (value) => sql.identifier([value]);
 const getDatabaseName = async (pool) => {
     const { currentDatabase } = await pool.one(sql `

package/lib/consts/experience.d.ts

@@ -0,0 +1,8 @@
+export declare const experience: Readonly<{
+    routes: Readonly<{
+        signIn: "sign-in";
+        register: "register";
+        sso: "single-sign-on";
+        consent: "consent";
+    }>;
+}>;

package/lib/consts/experience.js

@@ -0,0 +1,9 @@
+const routes = Object.freeze({
+    signIn: 'sign-in',
+    register: 'register',
+    sso: 'single-sign-on',
+    consent: 'consent',
+});
+export const experience = Object.freeze({
+    routes,
+});

package/lib/consts/index.d.ts

@@ -4,3 +4,4 @@ export * from './oidc.js';
 export * from './date.js';
 export * from './tenant.js';
 export * from './subscriptions.js';
+export * from './experience.js';

package/lib/consts/index.js

@@ -4,3 +4,4 @@ export * from './oidc.js';
 export * from './date.js';
 export * from './tenant.js';
 export * from './subscriptions.js';
+export * from './experience.js';

package/lib/consts/oidc.d.ts

@@ -1,6 +1,54 @@
+import { z } from 'zod';
 export declare const tenantIdKey = "tenant_id";
 export declare const customClientMetadataDefault: Readonly<{
     readonly idTokenTtl: number;
     readonly refreshTokenTtlInDays: 14;
     readonly rotateRefreshToken: true;
 }>;
+export declare enum ExtraParamsKey {
+    /**
+     * @deprecated Use {@link FirstScreen} instead.
+     * @see {@link InteractionMode} for the available values.
+     */
+    InteractionMode = "interaction_mode",
+    /**
+     * The first screen to show for the user.
+     *
+     * @see {@link FirstScreen} for the available values.
+     */
+    FirstScreen = "first_screen",
+    /**
+     * Directly sign in via the specified method. Note that the method must be properly configured
+     * in Logto.
+     *
+     * @remark
+     * The format of the value for this key is one of the following:
+     *
+     * - `social:<target>` (Use a social connector with the specified target, e.g. `social:google`)
+     * - `sso:<connector-id>` (Use the specified SSO connector, e.g. `sso:123456`)
+     */
+    DirectSignIn = "direct_sign_in"
+}
+/** @deprecated Use {@link FirstScreen} instead. */
+export declare enum InteractionMode {
+    SignIn = "signIn",
+    SignUp = "signUp"
+}
+export declare enum FirstScreen {
+    SignIn = "signIn",
+    Register = "register"
+}
+export declare const extraParamsObjectGuard: z.ZodObject<{
+    interaction_mode: z.ZodOptional<z.ZodNativeEnum<typeof InteractionMode>>;
+    first_screen: z.ZodOptional<z.ZodNativeEnum<typeof FirstScreen>>;
+    direct_sign_in: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    interaction_mode?: InteractionMode | undefined;
+    first_screen?: FirstScreen | undefined;
+    direct_sign_in?: string | undefined;
+}, {
+    interaction_mode?: InteractionMode | undefined;
+    first_screen?: FirstScreen | undefined;
+    direct_sign_in?: string | undefined;
+}>;
+export type ExtraParamsObject = z.infer<typeof extraParamsObjectGuard>;

package/lib/consts/oidc.js

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { inSeconds } from './date.js';
 export const tenantIdKey = 'tenant_id';
 export const customClientMetadataDefault = Object.freeze({
@@ -5,3 +6,46 @@ export const customClientMetadataDefault = Object.freeze({
     refreshTokenTtlInDays: 14,
     rotateRefreshToken: true,
 });
+export var ExtraParamsKey;
+(function (ExtraParamsKey) {
+    /**
+     * @deprecated Use {@link FirstScreen} instead.
+     * @see {@link InteractionMode} for the available values.
+     */
+    ExtraParamsKey["InteractionMode"] = "interaction_mode";
+    /**
+     * The first screen to show for the user.
+     *
+     * @see {@link FirstScreen} for the available values.
+     */
+    ExtraParamsKey["FirstScreen"] = "first_screen";
+    /**
+     * Directly sign in via the specified method. Note that the method must be properly configured
+     * in Logto.
+     *
+     * @remark
+     * The format of the value for this key is one of the following:
+     *
+     * - `social:<target>` (Use a social connector with the specified target, e.g. `social:google`)
+     * - `sso:<connector-id>` (Use the specified SSO connector, e.g. `sso:123456`)
+     */
+    ExtraParamsKey["DirectSignIn"] = "direct_sign_in";
+})(ExtraParamsKey || (ExtraParamsKey = {}));
+/** @deprecated Use {@link FirstScreen} instead. */
+export var InteractionMode;
+(function (InteractionMode) {
+    InteractionMode["SignIn"] = "signIn";
+    InteractionMode["SignUp"] = "signUp";
+})(InteractionMode || (InteractionMode = {}));
+export var FirstScreen;
+(function (FirstScreen) {
+    FirstScreen["SignIn"] = "signIn";
+    FirstScreen["Register"] = "register";
+})(FirstScreen || (FirstScreen = {}));
+export const extraParamsObjectGuard = z
+    .object({
+    [ExtraParamsKey.InteractionMode]: z.nativeEnum(InteractionMode),
+    [ExtraParamsKey.FirstScreen]: z.nativeEnum(FirstScreen),
+    [ExtraParamsKey.DirectSignIn]: z.string(),
+})
+    .partial();

package/lib/consts/subscriptions.d.ts

@@ -1,6 +1,29 @@
+/**
+ * Logto-provided predefined subscription plan IDs.
+ *
+ * In theory, the subscription plan ID will be a random string,
+ * but Logto provides some predefined subscription plans and their IDs are reserved plan IDs.
+ */
 export declare enum ReservedPlanId {
     Free = "free",
+    /**
+     * @deprecated
+     * In recent refactoring, the `hobby` plan is now treated as the `pro` plan.
+     * Only use this plan ID to check if a plan is a `pro` plan or not.
+     * This plan ID will be renamed to `pro` after legacy Stripe data is migrated by @darcyYe
+     *
+     * Todo @darcyYe:
+     * - LOG-7846: Rename `hobby` to `pro` and `pro` to `legacy-pro`
+     * - LOG-8339: Migrate legacy Stripe data
+     */
     Hobby = "hobby",
+    /**
+     * @deprecated
+     * Now this `pro` ID is not used anymore, we use `hobby` as the `pro` plan ID.
+     * Only use this `pro` value when displaying the plan ID to the user.
+     *
+     * Todo @darcyYe see `Hobby` todo
+     */
     Pro = "pro",
     Development = "dev"
 }