@logto/schemas 1.40.1 → 1.42.0

package/alterations/1.41.0-1779864280-add-password-expiration-policy.ts

@@ -0,0 +1,23 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      alter table users
+        add column password_updated_at timestamptz;
+
+      alter table sign_in_experiences
+        add column password_expiration jsonb not null default '{}'::jsonb;
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      alter table users drop column password_updated_at;
+      alter table sign_in_experiences drop column password_expiration;
+    `);
+  },
+};
+
+export default alteration;

package/alterations/1.41.0-1779864281-add-is-password-expired-to-users.ts

@@ -0,0 +1,18 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      alter table users add column is_password_expired boolean not null default false;
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      alter table users drop column is_password_expired;
+    `);
+  },
+};
+
+export default alteration;

package/alterations/1.41.0-1780358400-drop-oidc-model-instances-legacy-grant-id-index.ts

@@ -0,0 +1,25 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  beforeUp: async (pool) => {
+    await pool.query(sql`
+      drop index concurrently if exists oidc_model_instances__model_name_payload_grant_id;
+    `);
+  },
+  up: async () => {
+    /** `concurrently` cannot be used inside a transaction. */
+  },
+  beforeDown: async (pool) => {
+    await pool.query(sql`
+      create index concurrently if not exists oidc_model_instances__model_name_payload_grant_id
+        on oidc_model_instances (tenant_id, model_name, (payload->>'grantId'));
+    `);
+  },
+  down: async () => {
+    /** `concurrently` cannot be used inside a transaction. */
+  },
+};
+
+export default alteration;

package/alterations/1.41.0-1780381219-add-username-policy.ts

@@ -0,0 +1,41 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  // `create index concurrently` cannot run in a transaction; the runner wraps up/down in one.
+  beforeUp: async (pool) => {
+    await pool.query(sql`
+      create index concurrently users__tenant_lower_username
+        on users (tenant_id, lower(username))
+        where username is not null;
+    `);
+  },
+  up: async (pool) => {
+    // The default must be inlined: DDL cannot use bound parameters.
+    await pool.query(sql`
+      alter table sign_in_experiences
+        add column username_policy jsonb not null default '{
+          "caseSensitive": true,
+          "minLength": 1,
+          "maxLength": 128,
+          "allowedChars": {
+            "lowercase": true,
+            "uppercase": true,
+            "numbers": true,
+            "underscore": true
+          }
+        }'::jsonb;
+    `);
+  },
+  beforeDown: async (pool) => {
+    await pool.query(sql`drop index concurrently users__tenant_lower_username;`);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      alter table sign_in_experiences drop column username_policy;
+    `);
+  },
+};
+
+export default alteration;

package/alterations/1.41.0-1780643665-set-sign-up-profile-fields-default.ts

@@ -0,0 +1,20 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      alter table sign_in_experiences
+        alter column sign_up_profile_fields set default '[]'::jsonb;
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      alter table sign_in_experiences
+        alter column sign_up_profile_fields drop default;
+    `);
+  },
+};
+
+export default alteration;

package/alterations/1.41.0-1780906060-add-verification-code-policy.ts

@@ -0,0 +1,19 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      alter table sign_in_experiences
+        add column if not exists verification_code_policy jsonb not null default '{}'::jsonb;
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      alter table sign_in_experiences drop column if exists verification_code_policy;
+    `);
+  },
+};
+
+export default alteration;

package/alterations/1.41.0-1781689400-add-sentinel-activities-created-at-index.ts

@@ -0,0 +1,25 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  beforeUp: async (pool) => {
+    await pool.query(sql`
+      create index concurrently if not exists sentinel_activities__created_at
+        on sentinel_activities (created_at);
+    `);
+  },
+  up: async () => {
+    /** `concurrently` cannot be used inside a transaction. */
+  },
+  beforeDown: async (pool) => {
+    await pool.query(sql`
+      drop index concurrently if exists sentinel_activities__created_at;
+    `);
+  },
+  down: async () => {
+    /** `concurrently` cannot be used inside a transaction. */
+  },
+};
+
+export default alteration;

package/alterations/1.41.0-1782354362-set-admin-account-center-profile-fields.ts

@@ -0,0 +1,28 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const adminTenantId = 'admin';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      update account_centers
+      set profile_fields = '[{"name": "name"}, {"name": "avatar"}]'::jsonb
+      where tenant_id = ${adminTenantId}
+        and id = 'default'
+        and profile_fields is null
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      update account_centers
+      set profile_fields = null
+      where tenant_id = ${adminTenantId}
+        and id = 'default'
+        and profile_fields = '[{"name": "name"}, {"name": "avatar"}]'::jsonb
+    `);
+  },
+};
+
+export default alteration;

package/alterations/1.41.0-1782375106-cover-service-logs-tenant-type-index-with-created-at.ts

@@ -0,0 +1,36 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  beforeUp: async (pool) => {
+    // Cover the windowed hosted-email usage count (`where tenant_id=? and type=? and created_at>=?`) by
+    // adding `created_at` to the existing `(tenant_id, type)` index, then drop the now-redundant
+    // 2-column index (a left-prefix subset of the new one). `concurrently` keeps the write path
+    // unlocked — this unbounded table is written on every send.
+    await pool.query(sql`
+      create index concurrently if not exists service_logs__tenant_id__type__created_at
+        on service_logs (tenant_id, type, created_at);
+    `);
+    await pool.query(sql`
+      drop index concurrently if exists service_logs__tenant_id__type;
+    `);
+  },
+  up: async () => {
+    /** `concurrently` cannot be used inside a transaction. */
+  },
+  beforeDown: async (pool) => {
+    await pool.query(sql`
+      create index concurrently if not exists service_logs__tenant_id__type
+        on service_logs (tenant_id, type);
+    `);
+    await pool.query(sql`
+      drop index concurrently if exists service_logs__tenant_id__type__created_at;
+    `);
+  },
+  down: async () => {
+    /** `concurrently` cannot be used inside a transaction. */
+  },
+};
+
+export default alteration;

package/alterations/1.42.0-1783916980-add-domain-verification-files.ts

@@ -0,0 +1,20 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      alter table domains
+        add column verification_files jsonb not null default '[]'::jsonb;
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      alter table domains
+        drop column verification_files;
+    `);
+  },
+};
+
+export default alteration;

package/alterations/1.42.0-1784619793-add-service-logs-created-at-index.ts

@@ -0,0 +1,33 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  beforeUp: async (pool) => {
+    // Support the age-based `service_logs` retention prune's global oldest-first scan
+    // (`where created_at < ? order by created_at asc limit ?`). The existing
+    // `(tenant_id, type, created_at)` index leads with `tenant_id`, so it can't drive a
+    // tenant-agnostic time-range scan. `concurrently` keeps the write path unlocked — this
+    // unbounded table is written on every send.
+    //
+    // No `if not exists`: fail loud if the index already exists (e.g. a leftover invalid build from a
+    // prior failed concurrent creation) instead of silently skipping.
+    await pool.query(sql`
+      create index concurrently service_logs__created_at
+        on service_logs (created_at);
+    `);
+  },
+  up: async () => {
+    /** `concurrently` cannot be used inside a transaction. */
+  },
+  beforeDown: async (pool) => {
+    await pool.query(sql`
+      drop index concurrently if exists service_logs__created_at;
+    `);
+  },
+  down: async () => {
+    /** `concurrently` cannot be used inside a transaction. */
+  },
+};
+
+export default alteration;

package/alterations/1.42.0-1784620000-add-saml-sso-connector-signing-keys-table.ts

@@ -0,0 +1,38 @@
+import { sql } from '@silverhand/slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+import { applyTableRls, dropTableRls } from './utils/1704934999-tables.js';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      create table saml_sso_connector_signing_keys (
+        id varchar(21) not null,
+        tenant_id varchar(21) not null
+          references tenants (id) on update cascade on delete cascade,
+        sso_connector_id varchar(128) not null
+          references sso_connectors (id) on update cascade on delete cascade,
+        private_key text not null,
+        certificate text not null,
+        created_at timestamptz not null default now(),
+        expires_at timestamptz not null,
+        active boolean not null,
+        primary key (tenant_id, sso_connector_id, id)
+      );
+
+      create unique index saml_sso_connector_signing_keys__unique_active
+        on saml_sso_connector_signing_keys (tenant_id, sso_connector_id, active)
+        where active;
+    `);
+    await applyTableRls(pool, 'saml_sso_connector_signing_keys');
+  },
+  down: async (pool) => {
+    await dropTableRls(pool, 'saml_sso_connector_signing_keys');
+    await pool.query(sql`
+      drop table saml_sso_connector_signing_keys;
+    `);
+  },
+};
+
+export default alteration;

package/alterations/utils/1704934999-tables.ts

@@ -2,12 +2,33 @@ import { type CommonQueryMethods, sql } from '@silverhand/slonik';
 
 const getId = (value: string) => sql.identifier([value]);
 
+/**
+ * Returns the suffix used in the base Logto role name for the current database
+ * (`logto_tenant_<suffix>`).
+ *
+ * Historically the suffix was the raw database name (which may contain hyphens). A later
+ * convention normalised it by replacing hyphens with underscores. To remain compatible with
+ * both conventions we probe `pg_roles` for the normalised name first and fall back to the
+ * raw database name for legacy installations.
+ */
 const getDatabaseName = async (pool: CommonQueryMethods) => {
   const { currentDatabase } = await pool.one<{ currentDatabase: string }>(sql`
     select current_database();
   `);
 
-  return currentDatabase.replaceAll('-', '_');
+  const normalized = currentDatabase.replaceAll('-', '_');
+
+  if (normalized === currentDatabase) {
+    return currentDatabase;
+  }
+
+  const { exists } = await pool.one<{ exists: boolean }>(sql`
+    select exists(
+      select 1 from pg_roles where rolname = ${'logto_tenant_' + normalized}
+    ) as exists;
+  `);
+
+  return exists ? normalized : currentDatabase;
 };
 
 /**

package/alterations-js/1.41.0-1779864280-add-password-expiration-policy.js

@@ -0,0 +1,19 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      alter table users
+        add column password_updated_at timestamptz;
+
+      alter table sign_in_experiences
+        add column password_expiration jsonb not null default '{}'::jsonb;
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      alter table users drop column password_updated_at;
+      alter table sign_in_experiences drop column password_expiration;
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.41.0-1779864281-add-is-password-expired-to-users.js

@@ -0,0 +1,14 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      alter table users add column is_password_expired boolean not null default false;
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      alter table users drop column is_password_expired;
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.41.0-1780358400-drop-oidc-model-instances-legacy-grant-id-index.js

@@ -0,0 +1,21 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    beforeUp: async (pool) => {
+        await pool.query(sql `
+      drop index concurrently if exists oidc_model_instances__model_name_payload_grant_id;
+    `);
+    },
+    up: async () => {
+        /** `concurrently` cannot be used inside a transaction. */
+    },
+    beforeDown: async (pool) => {
+        await pool.query(sql `
+      create index concurrently if not exists oidc_model_instances__model_name_payload_grant_id
+        on oidc_model_instances (tenant_id, model_name, (payload->>'grantId'));
+    `);
+    },
+    down: async () => {
+        /** `concurrently` cannot be used inside a transaction. */
+    },
+};
+export default alteration;

package/alterations-js/1.41.0-1780381219-add-username-policy.js

@@ -0,0 +1,37 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    // `create index concurrently` cannot run in a transaction; the runner wraps up/down in one.
+    beforeUp: async (pool) => {
+        await pool.query(sql `
+      create index concurrently users__tenant_lower_username
+        on users (tenant_id, lower(username))
+        where username is not null;
+    `);
+    },
+    up: async (pool) => {
+        // The default must be inlined: DDL cannot use bound parameters.
+        await pool.query(sql `
+      alter table sign_in_experiences
+        add column username_policy jsonb not null default '{
+          "caseSensitive": true,
+          "minLength": 1,
+          "maxLength": 128,
+          "allowedChars": {
+            "lowercase": true,
+            "uppercase": true,
+            "numbers": true,
+            "underscore": true
+          }
+        }'::jsonb;
+    `);
+    },
+    beforeDown: async (pool) => {
+        await pool.query(sql `drop index concurrently users__tenant_lower_username;`);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      alter table sign_in_experiences drop column username_policy;
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.41.0-1780643665-set-sign-up-profile-fields-default.js

@@ -0,0 +1,16 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      alter table sign_in_experiences
+        alter column sign_up_profile_fields set default '[]'::jsonb;
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      alter table sign_in_experiences
+        alter column sign_up_profile_fields drop default;
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.41.0-1780906060-add-verification-code-policy.js

@@ -0,0 +1,15 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      alter table sign_in_experiences
+        add column if not exists verification_code_policy jsonb not null default '{}'::jsonb;
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      alter table sign_in_experiences drop column if exists verification_code_policy;
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.41.0-1781689400-add-sentinel-activities-created-at-index.js

@@ -0,0 +1,21 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    beforeUp: async (pool) => {
+        await pool.query(sql `
+      create index concurrently if not exists sentinel_activities__created_at
+        on sentinel_activities (created_at);
+    `);
+    },
+    up: async () => {
+        /** `concurrently` cannot be used inside a transaction. */
+    },
+    beforeDown: async (pool) => {
+        await pool.query(sql `
+      drop index concurrently if exists sentinel_activities__created_at;
+    `);
+    },
+    down: async () => {
+        /** `concurrently` cannot be used inside a transaction. */
+    },
+};
+export default alteration;

package/alterations-js/1.41.0-1782354362-set-admin-account-center-profile-fields.js

@@ -0,0 +1,23 @@
+import { sql } from '@silverhand/slonik';
+const adminTenantId = 'admin';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      update account_centers
+      set profile_fields = '[{"name": "name"}, {"name": "avatar"}]'::jsonb
+      where tenant_id = ${adminTenantId}
+        and id = 'default'
+        and profile_fields is null
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      update account_centers
+      set profile_fields = null
+      where tenant_id = ${adminTenantId}
+        and id = 'default'
+        and profile_fields = '[{"name": "name"}, {"name": "avatar"}]'::jsonb
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.41.0-1782375106-cover-service-logs-tenant-type-index-with-created-at.js

@@ -0,0 +1,32 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    beforeUp: async (pool) => {
+        // Cover the windowed hosted-email usage count (`where tenant_id=? and type=? and created_at>=?`) by
+        // adding `created_at` to the existing `(tenant_id, type)` index, then drop the now-redundant
+        // 2-column index (a left-prefix subset of the new one). `concurrently` keeps the write path
+        // unlocked — this unbounded table is written on every send.
+        await pool.query(sql `
+      create index concurrently if not exists service_logs__tenant_id__type__created_at
+        on service_logs (tenant_id, type, created_at);
+    `);
+        await pool.query(sql `
+      drop index concurrently if exists service_logs__tenant_id__type;
+    `);
+    },
+    up: async () => {
+        /** `concurrently` cannot be used inside a transaction. */
+    },
+    beforeDown: async (pool) => {
+        await pool.query(sql `
+      create index concurrently if not exists service_logs__tenant_id__type
+        on service_logs (tenant_id, type);
+    `);
+        await pool.query(sql `
+      drop index concurrently if exists service_logs__tenant_id__type__created_at;
+    `);
+    },
+    down: async () => {
+        /** `concurrently` cannot be used inside a transaction. */
+    },
+};
+export default alteration;

package/alterations-js/1.42.0-1783916980-add-domain-verification-files.js

@@ -0,0 +1,16 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      alter table domains
+        add column verification_files jsonb not null default '[]'::jsonb;
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      alter table domains
+        drop column verification_files;
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.42.0-1784619793-add-service-logs-created-at-index.js

@@ -0,0 +1,29 @@
+import { sql } from '@silverhand/slonik';
+const alteration = {
+    beforeUp: async (pool) => {
+        // Support the age-based `service_logs` retention prune's global oldest-first scan
+        // (`where created_at < ? order by created_at asc limit ?`). The existing
+        // `(tenant_id, type, created_at)` index leads with `tenant_id`, so it can't drive a
+        // tenant-agnostic time-range scan. `concurrently` keeps the write path unlocked — this
+        // unbounded table is written on every send.
+        //
+        // No `if not exists`: fail loud if the index already exists (e.g. a leftover invalid build from a
+        // prior failed concurrent creation) instead of silently skipping.
+        await pool.query(sql `
+      create index concurrently service_logs__created_at
+        on service_logs (created_at);
+    `);
+    },
+    up: async () => {
+        /** `concurrently` cannot be used inside a transaction. */
+    },
+    beforeDown: async (pool) => {
+        await pool.query(sql `
+      drop index concurrently if exists service_logs__created_at;
+    `);
+    },
+    down: async () => {
+        /** `concurrently` cannot be used inside a transaction. */
+    },
+};
+export default alteration;

package/alterations-js/1.42.0-1784620000-add-saml-sso-connector-signing-keys-table.js

@@ -0,0 +1,33 @@
+import { sql } from '@silverhand/slonik';
+import { applyTableRls, dropTableRls } from './utils/1704934999-tables.js';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      create table saml_sso_connector_signing_keys (
+        id varchar(21) not null,
+        tenant_id varchar(21) not null
+          references tenants (id) on update cascade on delete cascade,
+        sso_connector_id varchar(128) not null
+          references sso_connectors (id) on update cascade on delete cascade,
+        private_key text not null,
+        certificate text not null,
+        created_at timestamptz not null default now(),
+        expires_at timestamptz not null,
+        active boolean not null,
+        primary key (tenant_id, sso_connector_id, id)
+      );
+
+      create unique index saml_sso_connector_signing_keys__unique_active
+        on saml_sso_connector_signing_keys (tenant_id, sso_connector_id, active)
+        where active;
+    `);
+        await applyTableRls(pool, 'saml_sso_connector_signing_keys');
+    },
+    down: async (pool) => {
+        await dropTableRls(pool, 'saml_sso_connector_signing_keys');
+        await pool.query(sql `
+      drop table saml_sso_connector_signing_keys;
+    `);
+    },
+};
+export default alteration;