@logto/schemas 1.10.0 → 1.10.1

package/alterations-js/1.10.1-1697683802-add-sso-connectors-table.js

@@ -0,0 +1,58 @@
+import { sql } from 'slonik';
+const getId = (value) => sql.identifier([value]);
+const getDatabaseName = async (pool) => {
+    const { currentDatabase } = await pool.one(sql `
+    select current_database();
+  `);
+    return currentDatabase.replaceAll('-', '_');
+};
+const alteration = {
+    up: async (pool) => {
+        const database = await getDatabaseName(pool);
+        const baseRoleId = getId(`logto_tenant_${database}`);
+        await pool.query(sql `
+      create table sso_connectors (
+        tenant_id varchar(21) not null
+          references tenants (id) on update cascade on delete cascade,
+        id varchar(128) not null,
+        provider_name varchar(128) not null,
+        connector_name varchar(128) not null,
+        config jsonb not null default '{}'::jsonb,
+        domains jsonb not null default '[]'::jsonb,
+        branding jsonb not null default '{}'::jsonb,
+        sync_profile boolean not null default FALSE,
+        sso_only boolean not null default FALSE,
+        created_at timestamptz not null default(now()),
+        primary key (id)
+      );
+
+      create index sso_connectors__id
+        on sso_connectors (tenant_id, id);
+
+      create index sso_connectors__id__provider_name
+        on sso_connectors (tenant_id, id, provider_name);
+
+      create trigger set_tenant_id before insert on sso_connectors
+        for each row execute procedure set_tenant_id();
+
+      alter table sso_connectors enable row level security;
+
+      create policy sso_connectors_tenant_id on sso_connectors
+        as restrictive
+        using (tenant_id = (select id from tenants where db_user = current_user));
+
+      create policy sso_connectors_modification on sso_connectors
+        using (true);
+
+      grant select, insert, update, delete on sso_connectors to ${baseRoleId};
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      drop policy sso_connectors_modification on sso_connectors;
+      drop policy sso_connectors_tenant_id on sso_connectors;
+      drop table sso_connectors;
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.10.1-1698646271-add-organization-created-flag.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.10.1-1698646271-add-organization-created-flag.js

@@ -0,0 +1,26 @@
+import { sql } from 'slonik';
+const adminConsoleConfigKey = 'adminConsole';
+const alterAdminConsoleData = async (logtoConfig, pool) => {
+    const { tenantId, value: oldAdminConsoleConfig } = logtoConfig;
+    const newAdminConsoleData = {
+        ...oldAdminConsoleConfig,
+        organizationCreated: false,
+    };
+    await pool.query(sql `update logto_configs set value = ${JSON.stringify(newAdminConsoleData)} where tenant_id = ${tenantId} and key = ${adminConsoleConfigKey}`);
+};
+const rollbackAdminConsoleData = async (logtoConfig, pool) => {
+    const { tenantId, value: newAdminConsoleConfig } = logtoConfig;
+    const { organizationCreated, ...oldAdminConsoleData } = newAdminConsoleConfig;
+    await pool.query(sql `update logto_configs set value = ${JSON.stringify(oldAdminConsoleData)} where tenant_id = ${tenantId} and key = ${adminConsoleConfigKey}`);
+};
+const alteration = {
+    up: async (pool) => {
+        const rows = await pool.many(sql `select * from logto_configs where key = ${adminConsoleConfigKey}`);
+        await Promise.all(rows.map(async (row) => alterAdminConsoleData(row, pool)));
+    },
+    down: async (pool) => {
+        const rows = await pool.many(sql `select * from logto_configs where key = ${adminConsoleConfigKey}`);
+        await Promise.all(rows.map(async (row) => rollbackAdminConsoleData(row, pool)));
+    },
+};
+export default alteration;

package/alterations-js/1.10.1-1698820410-add-user-sso-identities-table.d.ts

@@ -0,0 +1,4 @@
+import type { AlterationScript } from '../lib/types/alteration.js';
+/** The alteration script for adding `sso_identities` column to the users table. */
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.10.1-1698820410-add-user-sso-identities-table.js

@@ -0,0 +1,53 @@
+import { sql } from 'slonik';
+const getId = (value) => sql.identifier([value]);
+const getDatabaseName = async (pool) => {
+    const { currentDatabase } = await pool.one(sql `
+    select current_database();
+  `);
+    return currentDatabase.replaceAll('-', '_');
+};
+/** The alteration script for adding `sso_identities` column to the users table. */
+const alteration = {
+    up: async (pool) => {
+        const database = await getDatabaseName(pool);
+        const baseRoleId = getId(`logto_tenant_${database}`);
+        await pool.query(sql `
+      create table user_sso_identities (
+        tenant_id varchar(21) not null
+          references tenants (id) on update cascade on delete cascade,
+        id varchar(21) not null,
+        user_id varchar(12) not null
+          references users (id) on update cascade on delete cascade,
+        issuer varchar(256) not null,
+        identity_id varchar(128) not null,
+        detail jsonb not null default '{}'::jsonb,
+        created_at timestamp not null default(now()),
+        primary key (id),
+        constraint user_sso_identities__issuer__identity_id
+          unique (tenant_id, issuer, identity_id)
+      );
+
+      create trigger set_tenant_id before insert on user_sso_identities
+        for each row execute procedure set_tenant_id();
+
+      alter table user_sso_identities enable row level security;
+
+      create policy user_sso_identities_tenant_id on user_sso_identities
+        as restrictive
+        using (tenant_id = (select id from tenants where db_user = current_user));
+
+      create policy user_sso_identities_modification on user_sso_identities
+        using (true);
+
+      grant select, insert, update, delete on user_sso_identities to ${baseRoleId};
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      drop policy user_sso_identities_modification on user_sso_identities;
+      drop policy user_sso_identities_tenant_id on user_sso_identities;
+      drop table user_sso_identities;
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.10.1-1698910485-user-logto-data.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.10.1-1698910485-user-logto-data.js

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

package/lib/db-entries/application.d.ts

@@ -1,5 +1,10 @@
 import { OidcClientMetadata, CustomClientMetadata, GeneratedSchema } from './../foundations/index.js';
 import { ApplicationType } from './custom-types.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Application} for the original type.
+ */
 export type CreateApplication = {
     tenantId?: string;
     id: string;
@@ -22,4 +27,5 @@ export type Application = {
     customClientMetadata: CustomClientMetadata;
     createdAt: number;
 };
-export declare const Applications: GeneratedSchema<CreateApplication, Application>;
+export type ApplicationKeys = 'tenantId' | 'id' | 'name' | 'secret' | 'description' | 'type' | 'oidcClientMetadata' | 'customClientMetadata' | 'createdAt';
+export declare const Applications: GeneratedSchema<ApplicationKeys, CreateApplication, Application, 'applications', 'application'>;

package/lib/db-entries/application.js

@@ -51,4 +51,5 @@ export const Applications = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/applications-role.d.ts

@@ -1,4 +1,9 @@
 import { GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link ApplicationsRole} for the original type.
+ */
 export type CreateApplicationsRole = {
     tenantId?: string;
     id: string;
@@ -11,4 +16,5 @@ export type ApplicationsRole = {
     applicationId: string;
     roleId: string;
 };
-export declare const ApplicationsRoles: GeneratedSchema<CreateApplicationsRole, ApplicationsRole>;
+export type ApplicationsRoleKeys = 'tenantId' | 'id' | 'applicationId' | 'roleId';
+export declare const ApplicationsRoles: GeneratedSchema<ApplicationsRoleKeys, CreateApplicationsRole, ApplicationsRole, 'applications_roles', 'applications_role'>;

package/lib/db-entries/applications-role.js

@@ -29,4 +29,5 @@ export const ApplicationsRoles = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/connector.d.ts

@@ -1,4 +1,9 @@
 import { JsonObject, ConfigurableConnectorMetadata, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Connector} for the original type.
+ */
 export type CreateConnector = {
     tenantId?: string;
     id: string;
@@ -17,4 +22,5 @@ export type Connector = {
     metadata: ConfigurableConnectorMetadata;
     createdAt: number;
 };
-export declare const Connectors: GeneratedSchema<CreateConnector, Connector>;
+export type ConnectorKeys = 'tenantId' | 'id' | 'syncProfile' | 'connectorId' | 'config' | 'metadata' | 'createdAt';
+export declare const Connectors: GeneratedSchema<ConnectorKeys, CreateConnector, Connector, 'connectors', 'connector'>;

package/lib/db-entries/connector.js

@@ -42,4 +42,5 @@ export const Connectors = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/custom-phrase.d.ts

@@ -1,4 +1,9 @@
 import { Translation, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link CustomPhrase} for the original type.
+ */
 export type CreateCustomPhrase = {
     tenantId?: string;
     id: string;
@@ -11,4 +16,5 @@ export type CustomPhrase = {
     languageTag: string;
     translation: Translation;
 };
-export declare const CustomPhrases: GeneratedSchema<CreateCustomPhrase, CustomPhrase>;
+export type CustomPhraseKeys = 'tenantId' | 'id' | 'languageTag' | 'translation';
+export declare const CustomPhrases: GeneratedSchema<CustomPhraseKeys, CreateCustomPhrase, CustomPhrase, 'custom_phrases', 'custom_phrase'>;

package/lib/db-entries/custom-phrase.js

@@ -30,4 +30,5 @@ export const CustomPhrases = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/daily-active-user.d.ts

@@ -1,4 +1,9 @@
 import { GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link DailyActiveUser} for the original type.
+ */
 export type CreateDailyActiveUser = {
     id: string;
     tenantId?: string;
@@ -11,4 +16,5 @@ export type DailyActiveUser = {
     userId: string;
     date: number;
 };
-export declare const DailyActiveUsers: GeneratedSchema<CreateDailyActiveUser, DailyActiveUser>;
+export type DailyActiveUserKeys = 'id' | 'tenantId' | 'userId' | 'date';
+export declare const DailyActiveUsers: GeneratedSchema<DailyActiveUserKeys, CreateDailyActiveUser, DailyActiveUser, 'daily_active_users', 'daily_active_user'>;

package/lib/db-entries/daily-active-user.js

@@ -29,4 +29,5 @@ export const DailyActiveUsers = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/domain.d.ts

@@ -1,4 +1,9 @@
 import { DomainStatus, DomainDnsRecords, CloudflareData, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Domain} for the original type.
+ */
 export type CreateDomain = {
     tenantId?: string;
     id: string;
@@ -21,4 +26,5 @@ export type Domain = {
     updatedAt: number;
     createdAt: number;
 };
-export declare const Domains: GeneratedSchema<CreateDomain, Domain>;
+export type DomainKeys = 'tenantId' | 'id' | 'domain' | 'status' | 'errorMessage' | 'dnsRecords' | 'cloudflareData' | 'updatedAt' | 'createdAt';
+export declare const Domains: GeneratedSchema<DomainKeys, CreateDomain, Domain, 'domains', 'domain'>;

package/lib/db-entries/domain.js

@@ -50,4 +50,5 @@ export const Domains = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/hook.d.ts

@@ -1,4 +1,9 @@
 import { HookEvent, HookEvents, HookConfig, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Hook} for the original type.
+ */
 export type CreateHook = {
     tenantId?: string;
     id: string;
@@ -21,4 +26,5 @@ export type Hook = {
     enabled: boolean;
     createdAt: number;
 };
-export declare const Hooks: GeneratedSchema<CreateHook, Hook>;
+export type HookKeys = 'tenantId' | 'id' | 'name' | 'event' | 'events' | 'config' | 'signingKey' | 'enabled' | 'createdAt';
+export declare const Hooks: GeneratedSchema<HookKeys, CreateHook, Hook, 'hooks', 'hook'>;

package/lib/db-entries/hook.js

@@ -50,4 +50,5 @@ export const Hooks = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/index.d.ts

@@ -13,6 +13,12 @@ export * from './hook.js';
 export * from './log.js';
 export * from './logto-config.js';
 export * from './oidc-model-instance.js';
+export * from './organization-role-scope-relation.js';
+export * from './organization-role-user-relation.js';
+export * from './organization-role.js';
+export * from './organization-scope.js';
+export * from './organization-user-relation.js';
+export * from './organization.js';
 export * from './passcode.js';
 export * from './resource.js';
 export * from './role.js';
@@ -21,7 +27,9 @@ export * from './scope.js';
 export * from './sentinel-activity.js';
 export * from './service-log.js';
 export * from './sign-in-experience.js';
+export * from './sso-connector.js';
 export * from './system.js';
+export * from './user-sso-identity.js';
 export * from './user.js';
 export * from './users-role.js';
 export * from './verification-status.js';

package/lib/db-entries/index.js

@@ -14,6 +14,12 @@ export * from './hook.js';
 export * from './log.js';
 export * from './logto-config.js';
 export * from './oidc-model-instance.js';
+export * from './organization-role-scope-relation.js';
+export * from './organization-role-user-relation.js';
+export * from './organization-role.js';
+export * from './organization-scope.js';
+export * from './organization-user-relation.js';
+export * from './organization.js';
 export * from './passcode.js';
 export * from './resource.js';
 export * from './role.js';
@@ -22,7 +28,9 @@ export * from './scope.js';
 export * from './sentinel-activity.js';
 export * from './service-log.js';
 export * from './sign-in-experience.js';
+export * from './sso-connector.js';
 export * from './system.js';
+export * from './user-sso-identity.js';
 export * from './user.js';
 export * from './users-role.js';
 export * from './verification-status.js';

package/lib/db-entries/log.d.ts

@@ -1,4 +1,9 @@
 import { LogContextPayload, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Log} for the original type.
+ */
 export type CreateLog = {
     tenantId?: string;
     id: string;
@@ -13,4 +18,5 @@ export type Log = {
     payload: LogContextPayload;
     createdAt: number;
 };
-export declare const Logs: GeneratedSchema<CreateLog, Log>;
+export type LogKeys = 'tenantId' | 'id' | 'key' | 'payload' | 'createdAt';
+export declare const Logs: GeneratedSchema<LogKeys, CreateLog, Log, 'logs', 'log'>;

package/lib/db-entries/log.js

@@ -34,4 +34,5 @@ export const Logs = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/logto-config.d.ts

@@ -1,12 +1,18 @@
-import { JsonObject, GeneratedSchema } from './../foundations/index.js';
+import { Json, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link LogtoConfig} for the original type.
+ */
 export type CreateLogtoConfig = {
     tenantId?: string;
     key: string;
-    value?: JsonObject;
+    value?: Json;
 };
 export type LogtoConfig = {
     tenantId: string;
     key: string;
-    value: JsonObject;
+    value: Json;
 };
-export declare const LogtoConfigs: GeneratedSchema<CreateLogtoConfig, LogtoConfig>;
+export type LogtoConfigKeys = 'tenantId' | 'key' | 'value';
+export declare const LogtoConfigs: GeneratedSchema<LogtoConfigKeys, CreateLogtoConfig, LogtoConfig, 'logto_configs', 'logto_config'>;

package/lib/db-entries/logto-config.js

@@ -1,15 +1,15 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 import { z } from 'zod';
-import { jsonObjectGuard } from './../foundations/index.js';
+import { jsonGuard } from './../foundations/index.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
     key: z.string().min(1).max(256),
-    value: jsonObjectGuard.optional(),
+    value: jsonGuard.optional(),
 });
 const guard = z.object({
     tenantId: z.string().max(21),
     key: z.string().min(1).max(256),
-    value: jsonObjectGuard,
+    value: jsonGuard,
 });
 export const LogtoConfigs = Object.freeze({
     table: 'logto_configs',
@@ -26,4 +26,5 @@ export const LogtoConfigs = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/oidc-model-instance.d.ts

@@ -1,4 +1,9 @@
 import { OidcModelInstancePayload, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link OidcModelInstance} for the original type.
+ */
 export type CreateOidcModelInstance = {
     tenantId?: string;
     modelName: string;
@@ -15,4 +20,5 @@ export type OidcModelInstance = {
     expiresAt: number;
     consumedAt: number | null;
 };
-export declare const OidcModelInstances: GeneratedSchema<CreateOidcModelInstance, OidcModelInstance>;
+export type OidcModelInstanceKeys = 'tenantId' | 'modelName' | 'id' | 'payload' | 'expiresAt' | 'consumedAt';
+export declare const OidcModelInstances: GeneratedSchema<OidcModelInstanceKeys, CreateOidcModelInstance, OidcModelInstance, 'oidc_model_instances', 'oidc_model_instance'>;

package/lib/db-entries/oidc-model-instance.js

@@ -38,4 +38,5 @@ export const OidcModelInstances = Object.freeze({
     ],
     createGuard,
     guard,
+    updateGuard: guard.partial(),
 });

package/lib/db-entries/organization-role-scope-relation.d.ts

@@ -0,0 +1,20 @@
+import { GeneratedSchema } from './../foundations/index.js';
+/**
+ * The relations between organization roles and organization scopes. It indicates which organization scopes are available to which organization roles.
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link OrganizationRoleScopeRelation} for the original type.
+ */
+export type CreateOrganizationRoleScopeRelation = {
+    tenantId?: string;
+    organizationRoleId: string;
+    organizationScopeId: string;
+};
+/** The relations between organization roles and organization scopes. It indicates which organization scopes are available to which organization roles. */
+export type OrganizationRoleScopeRelation = {
+    tenantId: string;
+    organizationRoleId: string;
+    organizationScopeId: string;
+};
+export type OrganizationRoleScopeRelationKeys = 'tenantId' | 'organizationRoleId' | 'organizationScopeId';
+export declare const OrganizationRoleScopeRelations: GeneratedSchema<OrganizationRoleScopeRelationKeys, CreateOrganizationRoleScopeRelation, OrganizationRoleScopeRelation, 'organization_role_scope_relations', 'organization_role_scope_relation'>;

package/lib/db-entries/organization-role-scope-relation.js

@@ -0,0 +1,29 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+import { z } from 'zod';
+const createGuard = z.object({
+    tenantId: z.string().max(21).optional(),
+    organizationRoleId: z.string().min(1).max(21),
+    organizationScopeId: z.string().min(1).max(21),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    organizationRoleId: z.string().min(1).max(21),
+    organizationScopeId: z.string().min(1).max(21),
+});
+export const OrganizationRoleScopeRelations = Object.freeze({
+    table: 'organization_role_scope_relations',
+    tableSingular: 'organization_role_scope_relation',
+    fields: {
+        tenantId: 'tenant_id',
+        organizationRoleId: 'organization_role_id',
+        organizationScopeId: 'organization_scope_id',
+    },
+    fieldKeys: [
+        'tenantId',
+        'organizationRoleId',
+        'organizationScopeId',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

package/lib/db-entries/organization-role-user-relation.d.ts

@@ -0,0 +1,22 @@
+import { GeneratedSchema } from './../foundations/index.js';
+/**
+ * The relations between organizations, organization roles, and users. A relation means that a user has a role in an organization.
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link OrganizationRoleUserRelation} for the original type.
+ */
+export type CreateOrganizationRoleUserRelation = {
+    tenantId?: string;
+    organizationId: string;
+    organizationRoleId: string;
+    userId: string;
+};
+/** The relations between organizations, organization roles, and users. A relation means that a user has a role in an organization. */
+export type OrganizationRoleUserRelation = {
+    tenantId: string;
+    organizationId: string;
+    organizationRoleId: string;
+    userId: string;
+};
+export type OrganizationRoleUserRelationKeys = 'tenantId' | 'organizationId' | 'organizationRoleId' | 'userId';
+export declare const OrganizationRoleUserRelations: GeneratedSchema<OrganizationRoleUserRelationKeys, CreateOrganizationRoleUserRelation, OrganizationRoleUserRelation, 'organization_role_user_relations', 'organization_role_user_relation'>;

package/lib/db-entries/organization-role-user-relation.js

@@ -0,0 +1,33 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+import { z } from 'zod';
+const createGuard = z.object({
+    tenantId: z.string().max(21).optional(),
+    organizationId: z.string().min(1).max(21),
+    organizationRoleId: z.string().min(1).max(21),
+    userId: z.string().min(1).max(21),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    organizationId: z.string().min(1).max(21),
+    organizationRoleId: z.string().min(1).max(21),
+    userId: z.string().min(1).max(21),
+});
+export const OrganizationRoleUserRelations = Object.freeze({
+    table: 'organization_role_user_relations',
+    tableSingular: 'organization_role_user_relation',
+    fields: {
+        tenantId: 'tenant_id',
+        organizationId: 'organization_id',
+        organizationRoleId: 'organization_role_id',
+        userId: 'user_id',
+    },
+    fieldKeys: [
+        'tenantId',
+        'organizationId',
+        'organizationRoleId',
+        'userId',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

package/lib/db-entries/organization-role.d.ts

@@ -0,0 +1,28 @@
+import { GeneratedSchema } from './../foundations/index.js';
+/**
+ * The roles defined by the organization template.
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link OrganizationRole} for the original type.
+ */
+export type CreateOrganizationRole = {
+    tenantId?: string;
+    /** The globally unique identifier of the organization role. */
+    id: string;
+    /** The organization role's name, unique within the organization template. */
+    name: string;
+    /** A brief description of the organization role. */
+    description?: string | null;
+};
+/** The roles defined by the organization template. */
+export type OrganizationRole = {
+    tenantId: string;
+    /** The globally unique identifier of the organization role. */
+    id: string;
+    /** The organization role's name, unique within the organization template. */
+    name: string;
+    /** A brief description of the organization role. */
+    description: string | null;
+};
+export type OrganizationRoleKeys = 'tenantId' | 'id' | 'name' | 'description';
+export declare const OrganizationRoles: GeneratedSchema<OrganizationRoleKeys, CreateOrganizationRole, OrganizationRole, 'organization_roles', 'organization_role'>;