@logto/schemas 1.12.0 → 1.13.0

package/lib/db-entries/application-user-consent-user-scope.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(),
+    applicationId: z.string().min(1).max(21),
+    userScope: z.string().min(1).max(64),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    applicationId: z.string().min(1).max(21),
+    userScope: z.string().min(1).max(64),
+});
+export const ApplicationUserConsentUserScopes = Object.freeze({
+    table: 'application_user_consent_user_scopes',
+    tableSingular: 'application_user_consent_user_scope',
+    fields: {
+        tenantId: 'tenant_id',
+        applicationId: 'application_id',
+        userScope: 'user_scope',
+    },
+    fieldKeys: [
+        'tenantId',
+        'applicationId',
+        'userScope',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

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

@@ -1,4 +1,4 @@
-import { OidcClientMetadata, CustomClientMetadata, GeneratedSchema } from './../foundations/index.js';
+import { OidcClientMetadata, CustomClientMetadata, ProtectedAppMetadata, GeneratedSchema } from './../foundations/index.js';
 import { ApplicationType } from './custom-types.js';
 /**
  *
@@ -14,6 +14,8 @@ export type CreateApplication = {
     type: ApplicationType;
     oidcClientMetadata: OidcClientMetadata;
     customClientMetadata?: CustomClientMetadata;
+    protectedAppMetadata?: ProtectedAppMetadata | null;
+    isThirdParty?: boolean;
     createdAt?: number;
 };
 export type Application = {
@@ -25,7 +27,9 @@ export type Application = {
     type: ApplicationType;
     oidcClientMetadata: OidcClientMetadata;
     customClientMetadata: CustomClientMetadata;
+    protectedAppMetadata: ProtectedAppMetadata | null;
+    isThirdParty: boolean;
     createdAt: number;
 };
-export type ApplicationKeys = 'tenantId' | 'id' | 'name' | 'secret' | 'description' | 'type' | 'oidcClientMetadata' | 'customClientMetadata' | 'createdAt';
+export type ApplicationKeys = 'tenantId' | 'id' | 'name' | 'secret' | 'description' | 'type' | 'oidcClientMetadata' | 'customClientMetadata' | 'protectedAppMetadata' | 'isThirdParty' | 'createdAt';
 export declare const Applications: GeneratedSchema<ApplicationKeys, CreateApplication, Application, 'applications', 'application'>;

package/lib/db-entries/application.js

@@ -1,6 +1,6 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 import { z } from 'zod';
-import { oidcClientMetadataGuard, customClientMetadataGuard } from './../foundations/index.js';
+import { oidcClientMetadataGuard, customClientMetadataGuard, protectedAppMetadataGuard } from './../foundations/index.js';
 import { ApplicationType } from './custom-types.js';
 const createGuard = z.object({
     tenantId: z.string().max(21).optional(),
@@ -11,6 +11,8 @@ const createGuard = z.object({
     type: z.nativeEnum(ApplicationType),
     oidcClientMetadata: oidcClientMetadataGuard,
     customClientMetadata: customClientMetadataGuard.optional(),
+    protectedAppMetadata: protectedAppMetadataGuard.nullable().optional(),
+    isThirdParty: z.boolean().optional(),
     createdAt: z.number().optional(),
 });
 const guard = z.object({
@@ -22,6 +24,8 @@ const guard = z.object({
     type: z.nativeEnum(ApplicationType),
     oidcClientMetadata: oidcClientMetadataGuard,
     customClientMetadata: customClientMetadataGuard,
+    protectedAppMetadata: protectedAppMetadataGuard.nullable(),
+    isThirdParty: z.boolean(),
     createdAt: z.number(),
 });
 export const Applications = Object.freeze({
@@ -36,6 +40,8 @@ export const Applications = Object.freeze({
         type: 'type',
         oidcClientMetadata: 'oidc_client_metadata',
         customClientMetadata: 'custom_client_metadata',
+        protectedAppMetadata: 'protected_app_metadata',
+        isThirdParty: 'is_third_party',
         createdAt: 'created_at',
     },
     fieldKeys: [
@@ -47,6 +53,8 @@ export const Applications = Object.freeze({
         'type',
         'oidcClientMetadata',
         'customClientMetadata',
+        'protectedAppMetadata',
+        'isThirdParty',
         'createdAt',
     ],
     createGuard,

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

@@ -2,7 +2,14 @@ export declare enum ApplicationType {
     Native = "Native",
     SPA = "SPA",
     Traditional = "Traditional",
-    MachineToMachine = "MachineToMachine"
+    MachineToMachine = "MachineToMachine",
+    Protected = "Protected"
+}
+export declare enum OrganizationInvitationStatus {
+    Pending = "Pending",
+    Accepted = "Accepted",
+    Expired = "Expired",
+    Revoked = "Revoked"
 }
 export declare enum RoleType {
     User = "User",

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

@@ -5,7 +5,15 @@ export var ApplicationType;
     ApplicationType["SPA"] = "SPA";
     ApplicationType["Traditional"] = "Traditional";
     ApplicationType["MachineToMachine"] = "MachineToMachine";
+    ApplicationType["Protected"] = "Protected";
 })(ApplicationType || (ApplicationType = {}));
+export var OrganizationInvitationStatus;
+(function (OrganizationInvitationStatus) {
+    OrganizationInvitationStatus["Pending"] = "Pending";
+    OrganizationInvitationStatus["Accepted"] = "Accepted";
+    OrganizationInvitationStatus["Expired"] = "Expired";
+    OrganizationInvitationStatus["Revoked"] = "Revoked";
+})(OrganizationInvitationStatus || (OrganizationInvitationStatus = {}));
 export var RoleType;
 (function (RoleType) {
     RoleType["User"] = "User";

package/lib/db-entries/daily-token-usage.d.ts

@@ -0,0 +1,20 @@
+import { GeneratedSchema } from './../foundations/index.js';
+/**
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link DailyTokenUsage} for the original type.
+ */
+export type CreateDailyTokenUsage = {
+    id: string;
+    tenantId?: string;
+    usage?: number;
+    date: number;
+};
+export type DailyTokenUsage = {
+    id: string;
+    tenantId: string;
+    usage: number;
+    date: number;
+};
+export type DailyTokenUsageKeys = 'id' | 'tenantId' | 'usage' | 'date';
+export declare const DailyTokenUsage: GeneratedSchema<DailyTokenUsageKeys, CreateDailyTokenUsage, DailyTokenUsage, 'daily_token_usage', 'daily_token_usage'>;

package/lib/db-entries/daily-token-usage.js

@@ -0,0 +1,33 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+import { z } from 'zod';
+const createGuard = z.object({
+    id: z.string().min(1).max(21),
+    tenantId: z.string().max(21).optional(),
+    usage: z.number().optional(),
+    date: z.number(),
+});
+const guard = z.object({
+    id: z.string().min(1).max(21),
+    tenantId: z.string().max(21),
+    usage: z.number(),
+    date: z.number(),
+});
+export const DailyTokenUsage = Object.freeze({
+    table: 'daily_token_usage',
+    tableSingular: 'daily_token_usage',
+    fields: {
+        id: 'id',
+        tenantId: 'tenant_id',
+        usage: 'usage',
+        date: 'date',
+    },
+    fieldKeys: [
+        'id',
+        'tenantId',
+        'usage',
+        'date',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

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

@@ -3,16 +3,24 @@ export * from './-after-all.js';
 export * from './-after-each.js';
 export * from './-before-all.js';
 export * from './-function.js';
+export * from './application-sign-in-experience.js';
+export * from './application-user-consent-organization-scope.js';
+export * from './application-user-consent-organization.js';
+export * from './application-user-consent-resource-scope.js';
+export * from './application-user-consent-user-scope.js';
 export * from './application.js';
 export * from './applications-role.js';
 export * from './connector.js';
 export * from './custom-phrase.js';
 export * from './daily-active-user.js';
+export * from './daily-token-usage.js';
 export * from './domain.js';
 export * from './hook.js';
 export * from './log.js';
 export * from './logto-config.js';
 export * from './oidc-model-instance.js';
+export * from './organization-invitation-role-relation.js';
+export * from './organization-invitation.js';
 export * from './organization-role-scope-relation.js';
 export * from './organization-role-user-relation.js';
 export * from './organization-role.js';

package/lib/db-entries/index.js

@@ -4,16 +4,24 @@ export * from './-after-all.js';
 export * from './-after-each.js';
 export * from './-before-all.js';
 export * from './-function.js';
+export * from './application-sign-in-experience.js';
+export * from './application-user-consent-organization-scope.js';
+export * from './application-user-consent-organization.js';
+export * from './application-user-consent-resource-scope.js';
+export * from './application-user-consent-user-scope.js';
 export * from './application.js';
 export * from './applications-role.js';
 export * from './connector.js';
 export * from './custom-phrase.js';
 export * from './daily-active-user.js';
+export * from './daily-token-usage.js';
 export * from './domain.js';
 export * from './hook.js';
 export * from './log.js';
 export * from './logto-config.js';
 export * from './oidc-model-instance.js';
+export * from './organization-invitation-role-relation.js';
+export * from './organization-invitation.js';
 export * from './organization-role-scope-relation.js';
 export * from './organization-role-user-relation.js';
 export * from './organization-role.js';

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

@@ -0,0 +1,24 @@
+import { GeneratedSchema } from './../foundations/index.js';
+/**
+ * The organization roles that will be assigned to a user when they accept an invitation.
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link OrganizationInvitationRoleRelation} for the original type.
+ */
+export type CreateOrganizationInvitationRoleRelation = {
+    tenantId?: string;
+    /** The ID of the invitation. */
+    organizationInvitationId: string;
+    /** The ID of the organization role. */
+    organizationRoleId: string;
+};
+/** The organization roles that will be assigned to a user when they accept an invitation. */
+export type OrganizationInvitationRoleRelation = {
+    tenantId: string;
+    /** The ID of the invitation. */
+    organizationInvitationId: string;
+    /** The ID of the organization role. */
+    organizationRoleId: string;
+};
+export type OrganizationInvitationRoleRelationKeys = 'tenantId' | 'organizationInvitationId' | 'organizationRoleId';
+export declare const OrganizationInvitationRoleRelations: GeneratedSchema<OrganizationInvitationRoleRelationKeys, CreateOrganizationInvitationRoleRelation, OrganizationInvitationRoleRelation, 'organization_invitation_role_relations', 'organization_invitation_role_relation'>;

package/lib/db-entries/organization-invitation-role-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(),
+    organizationInvitationId: z.string().min(1).max(21),
+    organizationRoleId: z.string().min(1).max(21),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    organizationInvitationId: z.string().min(1).max(21),
+    organizationRoleId: z.string().min(1).max(21),
+});
+export const OrganizationInvitationRoleRelations = Object.freeze({
+    table: 'organization_invitation_role_relations',
+    tableSingular: 'organization_invitation_role_relation',
+    fields: {
+        tenantId: 'tenant_id',
+        organizationInvitationId: 'organization_invitation_id',
+        organizationRoleId: 'organization_role_id',
+    },
+    fieldKeys: [
+        'tenantId',
+        'organizationInvitationId',
+        'organizationRoleId',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});

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

@@ -0,0 +1,53 @@
+import { GeneratedSchema } from './../foundations/index.js';
+import { OrganizationInvitationStatus } from './custom-types.js';
+/**
+ * The invitation entry defined in RFC 0003. It stores the invitation information for a user to join an organization.
+ *
+ * @remarks This is a type for database creation.
+ * @see {@link OrganizationInvitation} for the original type.
+ */
+export type CreateOrganizationInvitation = {
+    tenantId?: string;
+    /** The unique identifier of the invitation. */
+    id: string;
+    /** The user ID who sent the invitation. */
+    inviterId?: string | null;
+    /** The email address or other identifier of the invitee. */
+    invitee: string;
+    /** The user ID of who accepted the invitation. */
+    acceptedUserId?: string | null;
+    /** The ID of the organization to which the invitee is invited. */
+    organizationId: string;
+    /** The status of the invitation. */
+    status: OrganizationInvitationStatus;
+    /** The time when the invitation was created. */
+    createdAt?: number;
+    /** The time when the invitation status was last updated. */
+    updatedAt?: number;
+    /** The time when the invitation expires. */
+    expiresAt: number;
+};
+/** The invitation entry defined in RFC 0003. It stores the invitation information for a user to join an organization. */
+export type OrganizationInvitation = {
+    tenantId: string;
+    /** The unique identifier of the invitation. */
+    id: string;
+    /** The user ID who sent the invitation. */
+    inviterId: string | null;
+    /** The email address or other identifier of the invitee. */
+    invitee: string;
+    /** The user ID of who accepted the invitation. */
+    acceptedUserId: string | null;
+    /** The ID of the organization to which the invitee is invited. */
+    organizationId: string;
+    /** The status of the invitation. */
+    status: OrganizationInvitationStatus;
+    /** The time when the invitation was created. */
+    createdAt: number;
+    /** The time when the invitation status was last updated. */
+    updatedAt: number;
+    /** The time when the invitation expires. */
+    expiresAt: number;
+};
+export type OrganizationInvitationKeys = 'tenantId' | 'id' | 'inviterId' | 'invitee' | 'acceptedUserId' | 'organizationId' | 'status' | 'createdAt' | 'updatedAt' | 'expiresAt';
+export declare const OrganizationInvitations: GeneratedSchema<OrganizationInvitationKeys, CreateOrganizationInvitation, OrganizationInvitation, 'organization_invitations', 'organization_invitation'>;

package/lib/db-entries/organization-invitation.js

@@ -0,0 +1,58 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+import { z } from 'zod';
+import { OrganizationInvitationStatus } from './custom-types.js';
+const createGuard = z.object({
+    tenantId: z.string().max(21).optional(),
+    id: z.string().min(1).max(21),
+    inviterId: z.string().max(21).nullable().optional(),
+    invitee: z.string().min(1).max(256),
+    acceptedUserId: z.string().max(21).nullable().optional(),
+    organizationId: z.string().min(1).max(21),
+    status: z.nativeEnum(OrganizationInvitationStatus),
+    createdAt: z.number().optional(),
+    updatedAt: z.number().optional(),
+    expiresAt: z.number(),
+});
+const guard = z.object({
+    tenantId: z.string().max(21),
+    id: z.string().min(1).max(21),
+    inviterId: z.string().max(21).nullable(),
+    invitee: z.string().min(1).max(256),
+    acceptedUserId: z.string().max(21).nullable(),
+    organizationId: z.string().min(1).max(21),
+    status: z.nativeEnum(OrganizationInvitationStatus),
+    createdAt: z.number(),
+    updatedAt: z.number(),
+    expiresAt: z.number(),
+});
+export const OrganizationInvitations = Object.freeze({
+    table: 'organization_invitations',
+    tableSingular: 'organization_invitation',
+    fields: {
+        tenantId: 'tenant_id',
+        id: 'id',
+        inviterId: 'inviter_id',
+        invitee: 'invitee',
+        acceptedUserId: 'accepted_user_id',
+        organizationId: 'organization_id',
+        status: 'status',
+        createdAt: 'created_at',
+        updatedAt: 'updated_at',
+        expiresAt: 'expires_at',
+    },
+    fieldKeys: [
+        'tenantId',
+        'id',
+        'inviterId',
+        'invitee',
+        'acceptedUserId',
+        'organizationId',
+        'status',
+        'createdAt',
+        'updatedAt',
+        'expiresAt',
+    ],
+    createGuard,
+    guard,
+    updateGuard: guard.partial(),
+});