@logto/schemas 1.2.2 → 1.3.0

package/lib/types/connector.js

@@ -1 +1,23 @@
+import { ConnectorType, connectorMetadataGuard } from '@logto/connector-kit';
+import { z } from 'zod';
+import { Connectors } from '../db-entries/index.js';
 export { ConnectorType, ConnectorPlatform } from '@logto/connector-kit';
+export const connectorResponseGuard = Connectors.guard
+    .pick({
+    id: true,
+    syncProfile: true,
+    config: true,
+    metadata: true,
+    connectorId: true,
+})
+    .merge(connectorMetadataGuard)
+    .merge(z.object({
+    type: z.nativeEnum(ConnectorType),
+    isDemo: z.boolean().optional(),
+}));
+export const connectorFactoryResponseGuard = z
+    .object({
+    type: z.nativeEnum(ConnectorType),
+    isDemo: z.boolean().optional(),
+})
+    .merge(connectorMetadataGuard);

package/lib/types/dashboard.d.ts

@@ -0,0 +1,116 @@
+export declare const getNewUsersResponseGuard: import("zod").ZodObject<{
+    today: import("zod").ZodObject<{
+        count: import("zod").ZodNumber;
+        delta: import("zod").ZodNumber;
+    }, "strip", import("zod").ZodTypeAny, {
+        count: number;
+        delta: number;
+    }, {
+        count: number;
+        delta: number;
+    }>;
+    last7Days: import("zod").ZodObject<{
+        count: import("zod").ZodNumber;
+        delta: import("zod").ZodNumber;
+    }, "strip", import("zod").ZodTypeAny, {
+        count: number;
+        delta: number;
+    }, {
+        count: number;
+        delta: number;
+    }>;
+}, "strip", import("zod").ZodTypeAny, {
+    today: {
+        count: number;
+        delta: number;
+    };
+    last7Days: {
+        count: number;
+        delta: number;
+    };
+}, {
+    today: {
+        count: number;
+        delta: number;
+    };
+    last7Days: {
+        count: number;
+        delta: number;
+    };
+}>;
+export declare const getActiveUsersResponseGuard: import("zod").ZodObject<{
+    dauCurve: import("zod").ZodArray<import("zod").ZodObject<{
+        date: import("zod").ZodString;
+        count: import("zod").ZodNumber;
+    }, "strip", import("zod").ZodTypeAny, {
+        date: string;
+        count: number;
+    }, {
+        date: string;
+        count: number;
+    }>, "many">;
+    dau: import("zod").ZodObject<{
+        count: import("zod").ZodNumber;
+        delta: import("zod").ZodNumber;
+    }, "strip", import("zod").ZodTypeAny, {
+        count: number;
+        delta: number;
+    }, {
+        count: number;
+        delta: number;
+    }>;
+    wau: import("zod").ZodObject<{
+        count: import("zod").ZodNumber;
+        delta: import("zod").ZodNumber;
+    }, "strip", import("zod").ZodTypeAny, {
+        count: number;
+        delta: number;
+    }, {
+        count: number;
+        delta: number;
+    }>;
+    mau: import("zod").ZodObject<{
+        count: import("zod").ZodNumber;
+        delta: import("zod").ZodNumber;
+    }, "strip", import("zod").ZodTypeAny, {
+        count: number;
+        delta: number;
+    }, {
+        count: number;
+        delta: number;
+    }>;
+}, "strip", import("zod").ZodTypeAny, {
+    dauCurve: {
+        date: string;
+        count: number;
+    }[];
+    dau: {
+        count: number;
+        delta: number;
+    };
+    wau: {
+        count: number;
+        delta: number;
+    };
+    mau: {
+        count: number;
+        delta: number;
+    };
+}, {
+    dauCurve: {
+        date: string;
+        count: number;
+    }[];
+    dau: {
+        count: number;
+        delta: number;
+    };
+    wau: {
+        count: number;
+        delta: number;
+    };
+    mau: {
+        count: number;
+        delta: number;
+    };
+}>;

package/lib/types/dashboard.js

@@ -0,0 +1,18 @@
+import { number, object, array, string } from 'zod';
+const dashboardUsersDataGuard = object({
+    count: number(),
+    delta: number(),
+});
+export const getNewUsersResponseGuard = object({
+    today: dashboardUsersDataGuard,
+    last7Days: dashboardUsersDataGuard,
+});
+export const getActiveUsersResponseGuard = object({
+    dauCurve: array(object({
+        date: string(),
+        count: number(),
+    })),
+    dau: dashboardUsersDataGuard,
+    wau: dashboardUsersDataGuard,
+    mau: dashboardUsersDataGuard,
+});

package/lib/types/index.d.ts

@@ -17,3 +17,4 @@ export * from './hook.js';
 export * from './service-log.js';
 export * from './theme.js';
 export * from './cookie.js';
+export * from './dashboard.js';

package/lib/types/index.js

@@ -17,3 +17,4 @@ export * from './hook.js';
 export * from './service-log.js';
 export * from './theme.js';
 export * from './cookie.js';
+export * from './dashboard.js';

package/lib/types/interactions.d.ts

@@ -38,13 +38,13 @@ export declare const phonePasswordPayloadGuard: z.ZodObject<{
 export type PhonePasswordPayload = z.infer<typeof phonePasswordPayloadGuard>;
 export declare const socialConnectorPayloadGuard: z.ZodObject<{
     connectorId: z.ZodString;
-    connectorData: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    connectorData: z.ZodRecord<z.ZodString, z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
 }, "strip", z.ZodTypeAny, {
     connectorId: string;
-    connectorData: Record<string, unknown>;
+    connectorData: Record<string, import("@withtyped/server").Json>;
 }, {
     connectorId: string;
-    connectorData: Record<string, unknown>;
+    connectorData: Record<string, import("@withtyped/server").Json>;
 }>;
 export type SocialConnectorPayload = z.infer<typeof socialConnectorPayloadGuard>;
 export declare const socialEmailPayloadGuard: z.ZodObject<{
@@ -123,13 +123,13 @@ export declare const identifierPayloadGuard: z.ZodUnion<[z.ZodObject<{
     verificationCode: string;
 }>, z.ZodObject<{
     connectorId: z.ZodString;
-    connectorData: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    connectorData: z.ZodRecord<z.ZodString, z.ZodType<import("@withtyped/server").Json, z.ZodTypeDef, import("@withtyped/server").Json>>;
 }, "strip", z.ZodTypeAny, {
     connectorId: string;
-    connectorData: Record<string, unknown>;
+    connectorData: Record<string, import("@withtyped/server").Json>;
 }, {
     connectorId: string;
-    connectorData: Record<string, unknown>;
+    connectorData: Record<string, import("@withtyped/server").Json>;
 }>, z.ZodObject<{
     connectorId: z.ZodString;
     email: z.ZodString;

package/lib/types/interactions.js

@@ -1,6 +1,6 @@
 import { emailRegEx, phoneRegEx, usernameRegEx, passwordRegEx } from '@logto/core-kit';
 import { z } from 'zod';
-import { arbitraryObjectGuard } from '../foundations/index.js';
+import { jsonObjectGuard } from '../foundations/index.js';
 import { emailVerificationCodePayloadGuard, phoneVerificationCodePayloadGuard, } from './verification-code.js';
 /**
  * Detailed Identifier Methods guard
@@ -19,7 +19,7 @@ export const phonePasswordPayloadGuard = z.object({
 });
 export const socialConnectorPayloadGuard = z.object({
     connectorId: z.string(),
-    connectorData: arbitraryObjectGuard,
+    connectorData: jsonObjectGuard,
 });
 export const socialEmailPayloadGuard = z.object({
     connectorId: z.string(),

package/lib/types/scope.d.ts

@@ -1,4 +1,40 @@
-import type { Resource, Scope } from '../db-entries/index.js';
-export type ScopeResponse = Scope & {
-    resource: Resource;
-};
+import { type z } from 'zod';
+export declare const scopeResponseGuard: z.ZodObject<z.extendShape<{
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    resourceId: z.ZodType<string, z.ZodTypeDef, string>;
+    name: z.ZodType<string, z.ZodTypeDef, string>;
+    description: z.ZodType<string, z.ZodTypeDef, string>;
+    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+}, {
+    resource: import("../index.js").Guard<import("../db-entries/resource.js").Resource>;
+}>, "strip", z.ZodTypeAny, {
+    tenantId: string;
+    id: string;
+    name: string;
+    description: string;
+    createdAt: number;
+    resource: {
+        tenantId: string;
+        id: string;
+        name: string;
+        indicator: string;
+        accessTokenTtl: number;
+    };
+    resourceId: string;
+}, {
+    tenantId: string;
+    id: string;
+    name: string;
+    description: string;
+    createdAt: number;
+    resource: {
+        tenantId: string;
+        id: string;
+        name: string;
+        indicator: string;
+        accessTokenTtl: number;
+    };
+    resourceId: string;
+}>;
+export type ScopeResponse = z.infer<typeof scopeResponseGuard>;

package/lib/types/scope.js

@@ -1 +1,4 @@
-export {};
+import { Resources, Scopes } from '../db-entries/index.js';
+export const scopeResponseGuard = Scopes.guard.extend({
+    resource: Resources.guard,
+});

package/lib/types/user.d.ts

@@ -1,9 +1,133 @@
-import type { CreateUser } from '../db-entries/index.js';
+import { z } from 'zod';
 export declare const userInfoSelectFields: readonly ["id", "username", "primaryEmail", "primaryPhone", "name", "avatar", "customData", "identities", "lastSignInAt", "createdAt", "applicationId", "isSuspended"];
-export type UserInfo<Keys extends keyof CreateUser = (typeof userInfoSelectFields)[number]> = Pick<CreateUser, Keys>;
-export type UserProfileResponse = UserInfo & {
-    hasPassword?: boolean;
-};
+export declare const userInfoGuard: z.ZodObject<Pick<{
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    username: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    primaryEmail: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    primaryPhone: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    passwordEncrypted: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    passwordEncryptionMethod: z.ZodType<import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null, z.ZodTypeDef, import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null>;
+    name: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    avatar: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    applicationId: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    identities: z.ZodType<Record<string, {
+        details?: {} | undefined;
+        userId: string;
+    }>, z.ZodTypeDef, Record<string, {
+        details?: {} | undefined;
+        userId: string;
+    }>>;
+    customData: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
+    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: string;
+    username: string | null;
+    applicationId: string | null;
+    id: string;
+    name: string | null;
+    createdAt: number;
+    primaryEmail: string | null;
+    primaryPhone: string | null;
+    passwordEncrypted: string | null;
+    passwordEncryptionMethod: import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null;
+    avatar: string | null;
+    identities: Record<string, {
+        details?: {} | undefined;
+        userId: string;
+    }>;
+    customData: import("@withtyped/server").JsonObject;
+    isSuspended: boolean;
+    lastSignInAt: number | null;
+}, {
+    tenantId: string;
+    username: string | null;
+    applicationId: string | null;
+    id: string;
+    name: string | null;
+    createdAt: number;
+    primaryEmail: string | null;
+    primaryPhone: string | null;
+    passwordEncrypted: string | null;
+    passwordEncryptionMethod: import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null;
+    avatar: string | null;
+    identities: Record<string, {
+        details?: {} | undefined;
+        userId: string;
+    }>;
+    customData: import("@withtyped/server").JsonObject;
+    isSuspended: boolean;
+    lastSignInAt: number | null;
+}>;
+export type UserInfo = z.infer<typeof userInfoGuard>;
+export declare const userProfileResponseGuard: z.ZodObject<z.extendShape<Pick<{
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    username: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    primaryEmail: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    primaryPhone: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    passwordEncrypted: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    passwordEncryptionMethod: z.ZodType<import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null, z.ZodTypeDef, import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null>;
+    name: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    avatar: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    applicationId: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    identities: z.ZodType<Record<string, {
+        details?: {} | undefined;
+        userId: string;
+    }>, z.ZodTypeDef, Record<string, {
+        details?: {} | undefined;
+        userId: string;
+    }>>;
+    customData: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
+    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">, {
+    hasPassword: z.ZodOptional<z.ZodBoolean>;
+}>, "strip", z.ZodTypeAny, {
+    hasPassword?: boolean | undefined;
+    tenantId: string;
+    username: string | null;
+    applicationId: string | null;
+    id: string;
+    name: string | null;
+    createdAt: number;
+    primaryEmail: string | null;
+    primaryPhone: string | null;
+    passwordEncrypted: string | null;
+    passwordEncryptionMethod: import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null;
+    avatar: string | null;
+    identities: Record<string, {
+        details?: {} | undefined;
+        userId: string;
+    }>;
+    customData: import("@withtyped/server").JsonObject;
+    isSuspended: boolean;
+    lastSignInAt: number | null;
+}, {
+    hasPassword?: boolean | undefined;
+    tenantId: string;
+    username: string | null;
+    applicationId: string | null;
+    id: string;
+    name: string | null;
+    createdAt: number;
+    primaryEmail: string | null;
+    primaryPhone: string | null;
+    passwordEncrypted: string | null;
+    passwordEncryptionMethod: import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null;
+    avatar: string | null;
+    identities: Record<string, {
+        details?: {} | undefined;
+        userId: string;
+    }>;
+    customData: import("@withtyped/server").JsonObject;
+    isSuspended: boolean;
+    lastSignInAt: number | null;
+}>;
+export type UserProfileResponse = z.infer<typeof userProfileResponseGuard>;
 /** Internal read-only roles for user tenants. */
 export declare enum InternalRole {
     /**

package/lib/types/user.js

@@ -1,3 +1,5 @@
+import { z } from 'zod';
+import { Users } from '../db-entries/index.js';
 export const userInfoSelectFields = Object.freeze([
     'id',
     'username',
@@ -12,6 +14,10 @@ export const userInfoSelectFields = Object.freeze([
     'applicationId',
     'isSuspended',
 ]);
+export const userInfoGuard = Users.guard.pick(Object.fromEntries(userInfoSelectFields.map((key) => [key, true])));
+export const userProfileResponseGuard = userInfoGuard.extend({
+    hasPassword: z.boolean().optional(),
+});
 /** Internal read-only roles for user tenants. */
 export var InternalRole;
 (function (InternalRole) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/schemas",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "license": "MPL-2.0",
   "type": "module",

package/tables/connectors.sql

@@ -4,7 +4,7 @@ create table connectors (
   id varchar(128) not null,
   sync_profile boolean not null default FALSE,
   connector_id varchar(128) not null,
-  config jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  config jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   metadata jsonb /* @use ConfigurableConnectorMetadata */ not null default '{}'::jsonb,
   created_at timestamptz not null default(now()),
   primary key (id)

package/tables/hooks.sql

@@ -1,13 +1,15 @@
 create table hooks (
-    tenant_id varchar(21) not null
-      references tenants (id) on update cascade on delete cascade,
-    id varchar(21) not null,
-    event varchar(128) /* @use HookEvent */ not null,
-    config jsonb /* @use HookConfig */ not null,
-    created_at timestamptz not null default(now()),
-    primary key (id)
-  );
+  tenant_id varchar(21) not null
+    references tenants (id) on update cascade on delete cascade,
+  id varchar(21) not null,
+  name varchar(256) not null default '',
+  event varchar(128) /* @use HookEvent */,
+  events jsonb /* @use HookEvents */ not null default '[]'::jsonb,
+  config jsonb /* @use HookConfig */ not null,
+  signing_key varchar(64) not null default '',
+  enabled boolean not null default true,
+  created_at timestamptz not null default(now()),
+  primary key (id)
+);
 
-  create index hooks__id on hooks (tenant_id, id);
-
-  create index hooks__event on hooks (tenant_id, event);
+create index hooks__id on hooks (tenant_id, id);

package/tables/logto_configs.sql

@@ -2,6 +2,6 @@ create table logto_configs (
   tenant_id varchar(21) not null
     references tenants (id) on update cascade on delete cascade,
   key varchar(256) not null,
-  value jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  value jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   primary key (tenant_id, key)
 );

package/tables/service_logs.sql

@@ -3,7 +3,7 @@ create table service_logs (
   tenant_id varchar(21) not null
     references tenants (id) on update cascade on delete cascade,
   type varchar(64) not null,
-  payload jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  payload jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   created_at timestamptz not null default(now()),
   primary key (id)
 );

package/tables/systems.sql

@@ -1,6 +1,6 @@
 create table systems (
   key varchar(256) not null,
-  value jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  value jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   primary key (key)
 );
 

package/tables/users.sql

@@ -15,7 +15,7 @@ create table users (
   avatar varchar(2048),
   application_id varchar(21),
   identities jsonb /* @use Identities */ not null default '{}'::jsonb,
-  custom_data jsonb /* @use ArbitraryObject */ not null default '{}'::jsonb,
+  custom_data jsonb /* @use JsonObject */ not null default '{}'::jsonb,
   is_suspended boolean not null default false,
   last_sign_in_at timestamptz,
   created_at timestamptz not null default (now()),