@logto/schemas 1.10.0 → 1.10.1

package/lib/db-entries/organization-role.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(),
+    id: z.string().min(1).max(21),
+    name: z.string().min(1).max(128),
+    description: z.string().max(256).nullable().optional(),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    id: z.string().min(1).max(21),
+    name: z.string().min(1).max(128),
+    description: z.string().max(256).nullable(),
+});
+export const OrganizationRoles = Object.freeze({
+    table: 'organization_roles',
+    tableSingular: 'organization_role',
+    fields: {
+        tenantId: 'tenant_id',
+        id: 'id',
+        name: 'name',
+        description: 'description',
+    },
+    fieldKeys: [
+        'tenantId',
+        'id',
+        'name',
+        'description',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

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

@@ -0,0 +1,28 @@
+import { GeneratedSchema } from './../foundations/index.js';
+/**
+ * The scopes (permissions) defined by the organization template.
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link OrganizationScope} for the original type.
+ */
+export type CreateOrganizationScope = {
+    tenantId?: string;
+    /** The globally unique identifier of the organization scope. */
+    id: string;
+    /** The organization scope's name, unique within the organization template. */
+    name: string;
+    /** A brief description of the organization scope. */
+    description?: string | null;
+};
+/** The scopes (permissions) defined by the organization template. */
+export type OrganizationScope = {
+    tenantId: string;
+    /** The globally unique identifier of the organization scope. */
+    id: string;
+    /** The organization scope's name, unique within the organization template. */
+    name: string;
+    /** A brief description of the organization scope. */
+    description: string | null;
+};
+export type OrganizationScopeKeys = 'tenantId' | 'id' | 'name' | 'description';
+export declare const OrganizationScopes: GeneratedSchema<OrganizationScopeKeys, CreateOrganizationScope, OrganizationScope, 'organization_scopes', 'organization_scope'>;

package/lib/db-entries/organization-scope.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(),
+    id: z.string().min(1).max(21),
+    name: z.string().min(1).max(128),
+    description: z.string().max(256).nullable().optional(),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    id: z.string().min(1).max(21),
+    name: z.string().min(1).max(128),
+    description: z.string().max(256).nullable(),
+});
+export const OrganizationScopes = Object.freeze({
+    table: 'organization_scopes',
+    tableSingular: 'organization_scope',
+    fields: {
+        tenantId: 'tenant_id',
+        id: 'id',
+        name: 'name',
+        description: 'description',
+    },
+    fieldKeys: [
+        'tenantId',
+        'id',
+        'name',
+        'description',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

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

@@ -0,0 +1,20 @@
+import { GeneratedSchema } from './../foundations/index.js';
+/**
+ * The relations between organizations and users. It indicates membership of users in organizations.
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link OrganizationUserRelation} for the original type.
+ */
+export type CreateOrganizationUserRelation = {
+    tenantId?: string;
+    organizationId: string;
+    userId: string;
+};
+/** The relations between organizations and users. It indicates membership of users in organizations. */
+export type OrganizationUserRelation = {
+    tenantId: string;
+    organizationId: string;
+    userId: string;
+};
+export type OrganizationUserRelationKeys = 'tenantId' | 'organizationId' | 'userId';
+export declare const OrganizationUserRelations: GeneratedSchema<OrganizationUserRelationKeys, CreateOrganizationUserRelation, OrganizationUserRelation, 'organization_user_relations', 'organization_user_relation'>;

package/lib/db-entries/organization-user-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(),
+    organizationId: 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),
+    userId: z.string().min(1).max(21),
+});
+export const OrganizationUserRelations = Object.freeze({
+    table: 'organization_user_relations',
+    tableSingular: 'organization_user_relation',
+    fields: {
+        tenantId: 'tenant_id',
+        organizationId: 'organization_id',
+        userId: 'user_id',
+    },
+    fieldKeys: [
+        'tenantId',
+        'organizationId',
+        'userId',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

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

@@ -0,0 +1,32 @@
+import { GeneratedSchema } from './../foundations/index.js';
+/**
+ * Organizations defined by [RFC 0001](https://github.com/logto-io/rfcs/blob/HEAD/active/0001-organization.md).
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Organization} for the original type.
+ */
+export type CreateOrganization = {
+    tenantId?: string;
+    /** The globally unique identifier of the organization. */
+    id: string;
+    /** The organization's name for display. */
+    name: string;
+    /** A brief description of the organization. */
+    description?: string | null;
+    /** When the organization was created. */
+    createdAt?: number;
+};
+/** Organizations defined by [RFC 0001](https://github.com/logto-io/rfcs/blob/HEAD/active/0001-organization.md). */
+export type Organization = {
+    tenantId: string;
+    /** The globally unique identifier of the organization. */
+    id: string;
+    /** The organization's name for display. */
+    name: string;
+    /** A brief description of the organization. */
+    description: string | null;
+    /** When the organization was created. */
+    createdAt: number;
+};
+export type OrganizationKeys = 'tenantId' | 'id' | 'name' | 'description' | 'createdAt';
+export declare const Organizations: GeneratedSchema<OrganizationKeys, CreateOrganization, Organization, 'organizations', 'organization'>;

package/lib/db-entries/organization.js

@@ -0,0 +1,37 @@
+// 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(),
+    id: z.string().min(1).max(21),
+    name: z.string().min(1).max(128),
+    description: z.string().max(256).nullable().optional(),
+    createdAt: z.number().optional(),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    id: z.string().min(1).max(21),
+    name: z.string().min(1).max(128),
+    description: z.string().max(256).nullable(),
+    createdAt: z.number(),
+});
+export const Organizations = Object.freeze({
+    table: 'organizations',
+    tableSingular: 'organization',
+    fields: {
+        tenantId: 'tenant_id',
+        id: 'id',
+        name: 'name',
+        description: 'description',
+        createdAt: 'created_at',
+    },
+    fieldKeys: [
+        'tenantId',
+        'id',
+        'name',
+        'description',
+        'createdAt',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

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

@@ -1,4 +1,9 @@
 import { GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Passcode} for the original type.
+ */
 export type CreatePasscode = {
     tenantId?: string;
     id: string;
@@ -23,4 +28,5 @@ export type Passcode = {
     tryCount: number;
     createdAt: number;
 };
-export declare const Passcodes: GeneratedSchema<CreatePasscode, Passcode>;
+export type PasscodeKeys = 'tenantId' | 'id' | 'interactionJti' | 'phone' | 'email' | 'type' | 'code' | 'consumed' | 'tryCount' | 'createdAt';
+export declare const Passcodes: GeneratedSchema<PasscodeKeys, CreatePasscode, Passcode, 'passcodes', 'passcode'>;

package/lib/db-entries/passcode.js

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

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

@@ -1,4 +1,9 @@
 import { GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Resource} for the original type.
+ */
 export type CreateResource = {
     tenantId?: string;
     id: string;
@@ -15,4 +20,5 @@ export type Resource = {
     isDefault: boolean;
     accessTokenTtl: number;
 };
-export declare const Resources: GeneratedSchema<CreateResource, Resource>;
+export type ResourceKeys = 'tenantId' | 'id' | 'name' | 'indicator' | 'isDefault' | 'accessTokenTtl';
+export declare const Resources: GeneratedSchema<ResourceKeys, CreateResource, Resource, 'resources', 'resource'>;

package/lib/db-entries/resource.js

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

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

@@ -1,5 +1,10 @@
 import { GeneratedSchema } from './../foundations/index.js';
 import { RoleType } from './custom-types.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Role} for the original type.
+ */
 export type CreateRole = {
     tenantId?: string;
     id: string;
@@ -14,4 +19,5 @@ export type Role = {
     description: string;
     type: RoleType;
 };
-export declare const Roles: GeneratedSchema<CreateRole, Role>;
+export type RoleKeys = 'tenantId' | 'id' | 'name' | 'description' | 'type';
+export declare const Roles: GeneratedSchema<RoleKeys, CreateRole, Role, 'roles', 'role'>;

package/lib/db-entries/role.js

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

package/lib/db-entries/roles-scope.d.ts

@@ -1,4 +1,9 @@
 import { GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link RolesScope} for the original type.
+ */
 export type CreateRolesScope = {
     tenantId?: string;
     id: string;
@@ -11,4 +16,5 @@ export type RolesScope = {
     roleId: string;
     scopeId: string;
 };
-export declare const RolesScopes: GeneratedSchema<CreateRolesScope, RolesScope>;
+export type RolesScopeKeys = 'tenantId' | 'id' | 'roleId' | 'scopeId';
+export declare const RolesScopes: GeneratedSchema<RolesScopeKeys, CreateRolesScope, RolesScope, 'roles_scopes', 'roles_scope'>;

package/lib/db-entries/roles-scope.js

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

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

@@ -1,4 +1,9 @@
 import { GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link Scope} for the original type.
+ */
 export type CreateScope = {
     tenantId?: string;
     id: string;
@@ -15,4 +20,5 @@ export type Scope = {
     description: string;
     createdAt: number;
 };
-export declare const Scopes: GeneratedSchema<CreateScope, Scope>;
+export type ScopeKeys = 'tenantId' | 'id' | 'resourceId' | 'name' | 'description' | 'createdAt';
+export declare const Scopes: GeneratedSchema<ScopeKeys, CreateScope, Scope, 'scopes', 'scope'>;

package/lib/db-entries/scope.js

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

package/lib/db-entries/sentinel-activity.d.ts

@@ -1,5 +1,10 @@
 import { SentinelActivityTargetType, SentinelActivityAction, SentinelActivityPayload, GeneratedSchema } from './../foundations/index.js';
 import { SentinelActionResult, SentinelDecision } from './custom-types.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link SentinelActivity} for the original type.
+ */
 export type CreateSentinelActivity = {
     tenantId?: string;
     id: string;
@@ -40,4 +45,5 @@ export type SentinelActivity = {
     /** The time the activity was created. */
     createdAt: number;
 };
-export declare const SentinelActivities: GeneratedSchema<CreateSentinelActivity, SentinelActivity>;
+export type SentinelActivityKeys = 'tenantId' | 'id' | 'targetType' | 'targetHash' | 'action' | 'actionResult' | 'payload' | 'decision' | 'decisionExpiresAt' | 'createdAt';
+export declare const SentinelActivities: GeneratedSchema<SentinelActivityKeys, CreateSentinelActivity, SentinelActivity, 'sentinel_activities', 'sentinel_activity'>;

package/lib/db-entries/sentinel-activity.js

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

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

@@ -1,4 +1,9 @@
 import { JsonObject, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link ServiceLog} for the original type.
+ */
 export type CreateServiceLog = {
     id: string;
     tenantId?: string;
@@ -13,4 +18,5 @@ export type ServiceLog = {
     payload: JsonObject;
     createdAt: number;
 };
-export declare const ServiceLogs: GeneratedSchema<CreateServiceLog, ServiceLog>;
+export type ServiceLogKeys = 'id' | 'tenantId' | 'type' | 'payload' | 'createdAt';
+export declare const ServiceLogs: GeneratedSchema<ServiceLogKeys, CreateServiceLog, ServiceLog, 'service_logs', 'service_log'>;

package/lib/db-entries/service-log.js

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

package/lib/db-entries/sign-in-experience.d.ts

@@ -1,5 +1,10 @@
 import { Color, Branding, LanguageInfo, SignIn, SignUp, ConnectorTargets, CustomContent, PartialPasswordPolicy, Mfa, GeneratedSchema } from './../foundations/index.js';
 import { SignInMode } from './custom-types.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link SignInExperience} for the original type.
+ */
 export type CreateSignInExperience = {
     tenantId?: string;
     id: string;
@@ -34,4 +39,5 @@ export type SignInExperience = {
     passwordPolicy: PartialPasswordPolicy;
     mfa: Mfa;
 };
-export declare const SignInExperiences: GeneratedSchema<CreateSignInExperience, SignInExperience>;
+export type SignInExperienceKeys = 'tenantId' | 'id' | 'color' | 'branding' | 'languageInfo' | 'termsOfUseUrl' | 'privacyPolicyUrl' | 'signIn' | 'signUp' | 'socialSignInConnectorTargets' | 'signInMode' | 'customCss' | 'customContent' | 'passwordPolicy' | 'mfa';
+export declare const SignInExperiences: GeneratedSchema<SignInExperienceKeys, CreateSignInExperience, SignInExperience, 'sign_in_experiences', 'sign_in_experience'>;

package/lib/db-entries/sign-in-experience.js

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

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

@@ -0,0 +1,50 @@
+import { JsonObject, SsoDomains, SsoBranding, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link SsoConnector} for the original type.
+ */
+export type CreateSsoConnector = {
+    tenantId?: string;
+    /** The globally unique identifier of the SSO connector. */
+    id: string;
+    /** The connector factory name of the SSO provider. */
+    providerName: string;
+    /** The name of the SSO provider for display. */
+    connectorName: string;
+    /** The connector configuration. Different schemas for different provide type */
+    config?: JsonObject;
+    /** The SSO email domains. */
+    domains?: SsoDomains;
+    /** The SSO branding. */
+    branding?: SsoBranding;
+    /** Determines whether to synchronize the user's profile on each login. */
+    syncProfile?: boolean;
+    /** Determines whether SSO is the restricted sign-in method for users with the SSO registered email domains */
+    ssoOnly?: boolean;
+    /** When the SSO connector was created. */
+    createdAt?: number;
+};
+export type SsoConnector = {
+    tenantId: string;
+    /** The globally unique identifier of the SSO connector. */
+    id: string;
+    /** The connector factory name of the SSO provider. */
+    providerName: string;
+    /** The name of the SSO provider for display. */
+    connectorName: string;
+    /** The connector configuration. Different schemas for different provide type */
+    config: JsonObject;
+    /** The SSO email domains. */
+    domains: SsoDomains;
+    /** The SSO branding. */
+    branding: SsoBranding;
+    /** Determines whether to synchronize the user's profile on each login. */
+    syncProfile: boolean;
+    /** Determines whether SSO is the restricted sign-in method for users with the SSO registered email domains */
+    ssoOnly: boolean;
+    /** When the SSO connector was created. */
+    createdAt: number;
+};
+export type SsoConnectorKeys = 'tenantId' | 'id' | 'providerName' | 'connectorName' | 'config' | 'domains' | 'branding' | 'syncProfile' | 'ssoOnly' | 'createdAt';
+export declare const SsoConnectors: GeneratedSchema<SsoConnectorKeys, CreateSsoConnector, SsoConnector, 'sso_connectors', 'sso_connector'>;

package/lib/db-entries/sso-connector.js

@@ -0,0 +1,58 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+import { z } from 'zod';
+import { jsonObjectGuard, ssoDomainsGuard, ssoBrandingGuard } from './../foundations/index.js';
+const createGuard = z.object({
+    tenantId: z.string().max(21).optional(),
+    id: z.string().min(1).max(128),
+    providerName: z.string().min(1).max(128),
+    connectorName: z.string().min(1).max(128),
+    config: jsonObjectGuard.optional(),
+    domains: ssoDomainsGuard.optional(),
+    branding: ssoBrandingGuard.optional(),
+    syncProfile: z.boolean().optional(),
+    ssoOnly: z.boolean().optional(),
+    createdAt: z.number().optional(),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    id: z.string().min(1).max(128),
+    providerName: z.string().min(1).max(128),
+    connectorName: z.string().min(1).max(128),
+    config: jsonObjectGuard,
+    domains: ssoDomainsGuard,
+    branding: ssoBrandingGuard,
+    syncProfile: z.boolean(),
+    ssoOnly: z.boolean(),
+    createdAt: z.number(),
+});
+export const SsoConnectors = Object.freeze({
+    table: 'sso_connectors',
+    tableSingular: 'sso_connector',
+    fields: {
+        tenantId: 'tenant_id',
+        id: 'id',
+        providerName: 'provider_name',
+        connectorName: 'connector_name',
+        config: 'config',
+        domains: 'domains',
+        branding: 'branding',
+        syncProfile: 'sync_profile',
+        ssoOnly: 'sso_only',
+        createdAt: 'created_at',
+    },
+    fieldKeys: [
+        'tenantId',
+        'id',
+        'providerName',
+        'connectorName',
+        'config',
+        'domains',
+        'branding',
+        'syncProfile',
+        'ssoOnly',
+        'createdAt',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

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

@@ -1,4 +1,9 @@
 import { JsonObject, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link System} for the original type.
+ */
 export type CreateSystem = {
     key: string;
     value?: JsonObject;
@@ -7,4 +12,5 @@ export type System = {
     key: string;
     value: JsonObject;
 };
-export declare const Systems: GeneratedSchema<CreateSystem, System>;
+export type SystemKeys = 'key' | 'value';
+export declare const Systems: GeneratedSchema<SystemKeys, CreateSystem, System, 'systems', 'system'>;

package/lib/db-entries/system.js

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

package/lib/db-entries/user-sso-identity.d.ts

@@ -0,0 +1,30 @@
+import { JsonObject, GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link UserSsoIdentity} for the original type.
+ */
+export type CreateUserSsoIdentity = {
+    tenantId?: string;
+    id: string;
+    userId: string;
+    /** Unique provider identifier. Issuer of the OIDC connectors, entityId of the SAML providers */
+    issuer: string;
+    /** Provider user identity id */
+    identityId: string;
+    detail?: JsonObject;
+    createdAt?: number;
+};
+export type UserSsoIdentity = {
+    tenantId: string;
+    id: string;
+    userId: string;
+    /** Unique provider identifier. Issuer of the OIDC connectors, entityId of the SAML providers */
+    issuer: string;
+    /** Provider user identity id */
+    identityId: string;
+    detail: JsonObject;
+    createdAt: number;
+};
+export type UserSsoIdentityKeys = 'tenantId' | 'id' | 'userId' | 'issuer' | 'identityId' | 'detail' | 'createdAt';
+export declare const UserSsoIdentities: GeneratedSchema<UserSsoIdentityKeys, CreateUserSsoIdentity, UserSsoIdentity, 'user_sso_identities', 'user_sso_identity'>;

package/lib/db-entries/user-sso-identity.js

@@ -0,0 +1,46 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+import { z } from 'zod';
+import { jsonObjectGuard } from './../foundations/index.js';
+const createGuard = z.object({
+    tenantId: z.string().max(21).optional(),
+    id: z.string().min(1).max(21),
+    userId: z.string().min(1).max(12),
+    issuer: z.string().min(1).max(256),
+    identityId: z.string().min(1).max(128),
+    detail: jsonObjectGuard.optional(),
+    createdAt: z.number().optional(),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    id: z.string().min(1).max(21),
+    userId: z.string().min(1).max(12),
+    issuer: z.string().min(1).max(256),
+    identityId: z.string().min(1).max(128),
+    detail: jsonObjectGuard,
+    createdAt: z.number(),
+});
+export const UserSsoIdentities = Object.freeze({
+    table: 'user_sso_identities',
+    tableSingular: 'user_sso_identity',
+    fields: {
+        tenantId: 'tenant_id',
+        id: 'id',
+        userId: 'user_id',
+        issuer: 'issuer',
+        identityId: 'identity_id',
+        detail: 'detail',
+        createdAt: 'created_at',
+    },
+    fieldKeys: [
+        'tenantId',
+        'id',
+        'userId',
+        'issuer',
+        'identityId',
+        'detail',
+        'createdAt',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});