@logto/schemas 1.3.0 → 1.6.0

package/lib/types/system.js

@@ -1,3 +1,4 @@
+import { verificationCodeTypeGuard } from '@logto/connector-kit';
 import { z } from 'zod';
 // Alteration state
 export var AlterationStateKey;
@@ -42,6 +43,44 @@ export var StorageProviderKey;
 export const storageProviderGuard = Object.freeze({
     [StorageProviderKey.StorageProvider]: storageProviderDataGuard,
 });
+// Email service provider
+export var EmailServiceProvider;
+(function (EmailServiceProvider) {
+    EmailServiceProvider["SendGrid"] = "SendGrid";
+})(EmailServiceProvider || (EmailServiceProvider = {}));
+/**
+ * `General` is now used as a fallback scenario.
+ * This will be extended in the future since we will send different emails for
+ * different purposes (such as webhook that inform users of suspicious account activities).
+ */
+export var OtherEmailTemplate;
+(function (OtherEmailTemplate) {
+    OtherEmailTemplate["General"] = "General";
+})(OtherEmailTemplate || (OtherEmailTemplate = {}));
+export const otherEmailTemplateGuard = z.nativeEnum(OtherEmailTemplate);
+const emailServiceBasicConfig = {
+    fromName: z.string(),
+    fromEmail: z.string(),
+    templates: z.record(verificationCodeTypeGuard.or(otherEmailTemplateGuard), z.object({
+        subject: z.string(),
+        content: z.string(),
+    })),
+};
+export const sendgridEmailServiceDataGuard = z.object({
+    provider: z.literal(EmailServiceProvider.SendGrid),
+    apiKey: z.string(),
+    ...emailServiceBasicConfig,
+});
+export const emailServiceDataGuard = z.discriminatedUnion('provider', [
+    sendgridEmailServiceDataGuard,
+]);
+export var EmailServiceProviderKey;
+(function (EmailServiceProviderKey) {
+    EmailServiceProviderKey["EmailServiceProvider"] = "EmailServiceProvider";
+})(EmailServiceProviderKey || (EmailServiceProviderKey = {}));
+export const emailServiceProviderGuard = Object.freeze({
+    [EmailServiceProviderKey.EmailServiceProvider]: emailServiceDataGuard,
+});
 // Demo social connectors
 export var DemoSocialProvider;
 (function (DemoSocialProvider) {
@@ -65,13 +104,29 @@ export var DemoSocialKey;
 export const demoSocialGuard = Object.freeze({
     [DemoSocialKey.DemoSocial]: demoSocialDataGuard,
 });
+// Cloudflare Hostnames
+export const hostnameProviderDataGuard = z.object({
+    zoneId: z.string(),
+    apiToken: z.string(), // Requires zone permission for "SSL and Certificates Edit"
+});
+export var CloudflareKey;
+(function (CloudflareKey) {
+    CloudflareKey["HostnameProvider"] = "cloudflareHostnameProvider";
+})(CloudflareKey || (CloudflareKey = {}));
+export const cloudflareGuard = Object.freeze({
+    [CloudflareKey.HostnameProvider]: hostnameProviderDataGuard,
+});
 export const systemKeys = Object.freeze([
     ...Object.values(AlterationStateKey),
     ...Object.values(StorageProviderKey),
     ...Object.values(DemoSocialKey),
+    ...Object.values(CloudflareKey),
+    ...Object.values(EmailServiceProviderKey),
 ]);
 export const systemGuards = Object.freeze({
     ...alterationStateGuard,
     ...storageProviderGuard,
     ...demoSocialGuard,
+    ...cloudflareGuard,
+    ...emailServiceProviderGuard,
 });

package/lib/types/user.d.ts

@@ -22,12 +22,12 @@ export declare const userInfoGuard: z.ZodObject<Pick<{
     isSuspended: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     lastSignInAt: z.ZodType<number | null, z.ZodTypeDef, number | null>;
     createdAt: z.ZodType<number, z.ZodTypeDef, number>;
-}, "tenantId" | "username" | "applicationId" | "id" | "name" | "createdAt" | "primaryEmail" | "primaryPhone" | "passwordEncrypted" | "passwordEncryptionMethod" | "avatar" | "identities" | "customData" | "isSuspended" | "lastSignInAt">, "strip", z.ZodTypeAny, {
+}, "tenantId" | "username" | "applicationId" | "name" | "id" | "createdAt" | "primaryEmail" | "primaryPhone" | "passwordEncrypted" | "passwordEncryptionMethod" | "avatar" | "identities" | "customData" | "isSuspended" | "lastSignInAt">, "strip", z.ZodTypeAny, {
     tenantId: string;
     username: string | null;
     applicationId: string | null;
-    id: string;
     name: string | null;
+    id: string;
     createdAt: number;
     primaryEmail: string | null;
     primaryPhone: string | null;
@@ -45,8 +45,8 @@ export declare const userInfoGuard: z.ZodObject<Pick<{
     tenantId: string;
     username: string | null;
     applicationId: string | null;
-    id: string;
     name: string | null;
+    id: string;
     createdAt: number;
     primaryEmail: string | null;
     primaryPhone: string | null;
@@ -84,15 +84,15 @@ export declare const userProfileResponseGuard: z.ZodObject<z.extendShape<Pick<{
     isSuspended: z.ZodType<boolean, z.ZodTypeDef, boolean>;
     lastSignInAt: z.ZodType<number | null, z.ZodTypeDef, number | null>;
     createdAt: z.ZodType<number, z.ZodTypeDef, number>;
-}, "tenantId" | "username" | "applicationId" | "id" | "name" | "createdAt" | "primaryEmail" | "primaryPhone" | "passwordEncrypted" | "passwordEncryptionMethod" | "avatar" | "identities" | "customData" | "isSuspended" | "lastSignInAt">, {
+}, "tenantId" | "username" | "applicationId" | "name" | "id" | "createdAt" | "primaryEmail" | "primaryPhone" | "passwordEncrypted" | "passwordEncryptionMethod" | "avatar" | "identities" | "customData" | "isSuspended" | "lastSignInAt">, {
     hasPassword: z.ZodOptional<z.ZodBoolean>;
 }>, "strip", z.ZodTypeAny, {
     hasPassword?: boolean | undefined;
     tenantId: string;
     username: string | null;
     applicationId: string | null;
-    id: string;
     name: string | null;
+    id: string;
     createdAt: number;
     primaryEmail: string | null;
     primaryPhone: string | null;
@@ -111,8 +111,8 @@ export declare const userProfileResponseGuard: z.ZodObject<z.extendShape<Pick<{
     tenantId: string;
     username: string | null;
     applicationId: string | null;
-    id: string;
     name: string | null;
+    id: string;
     createdAt: number;
     primaryEmail: string | null;
     primaryPhone: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/schemas",
-  "version": "1.3.0",
+  "version": "1.6.0",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "license": "MPL-2.0",
   "type": "module",
@@ -65,12 +65,14 @@
   "prettier": "@silverhand/eslint-config/.prettierrc",
   "dependencies": {
     "@logto/connector-kit": "^1.1.1",
-    "@logto/core-kit": "^2.0.0",
+    "@logto/core-kit": "^2.0.1",
     "@logto/language-kit": "^1.0.0",
-    "@logto/phrases": "^1.2.0",
+    "@logto/phrases": "^1.4.1",
     "@logto/phrases-ui": "^1.2.0",
     "@logto/shared": "^2.0.0",
-    "@withtyped/server": "^0.9.0",
+    "@withtyped/server": "^0.11.1"
+  },
+  "peerDependencies": {
     "zod": "^3.20.2"
   },
   "scripts": {

package/tables/domains.sql

@@ -0,0 +1,17 @@
+create table domains (
+  tenant_id varchar(21) not null
+    references tenants (id) on update cascade on delete cascade,
+  id varchar(21) not null,
+  domain varchar(256) not null,
+  status varchar(32) /* @use DomainStatus */ not null default('PendingVerification'),
+  error_message varchar(1024),
+  dns_records jsonb /* @use DomainDnsRecords */ not null default '[]'::jsonb,
+  cloudflare_data jsonb /* @use CloudflareData */,
+  updated_at timestamptz not null default(now()),
+  created_at timestamptz not null default(now()),
+  primary key (id),
+  constraint domains__domain
+    unique (tenant_id, domain)
+);
+
+create index domains__id on domains (tenant_id, id);

package/tables/logs.sql

@@ -19,3 +19,6 @@ create index logs__user_id
 
 create index logs__application_id
   on logs (tenant_id, (payload->>'applicationId'));
+
+create index logs__hook_id
+  on logs (tenant_id, (payload->>'hookId'));

package/tables/resources.sql

@@ -6,6 +6,7 @@ create table resources (
   id varchar(21) not null,
   name text not null,
   indicator text not null, /* resource indicator also used as audience */
+  is_default boolean not null default (false),
   access_token_ttl bigint not null default(3600), /* expiration value in seconds, default is 1h */
   primary key (id),
   constraint resources__indicator
@@ -14,3 +15,7 @@ create table resources (
 
 create index resources__id
   on resources (tenant_id, id);
+
+create unique index resources__is_default_true
+  on resources (tenant_id)
+  where is_default = true;

package/lib/types/tenant.d.ts

@@ -1,4 +0,0 @@
-export type TenantInfo = {
-    id: string;
-    indicator: string;
-};

package/lib/types/tenant.js

@@ -1 +0,0 @@
-export {};