@logto/schemas 1.7.0 → 1.8.0

package/alterations/1.8.0-1692088012-add-is-suspend-column-to-tenants-table.ts

@@ -0,0 +1,18 @@
+import { sql } from 'slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      alter table tenants add column is_suspended boolean not null default false;
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      alter table tenants drop column is_suspended;
+    `);
+  },
+};
+
+export default alteration;

package/alterations/1.8.0-1692194751-add-affiliate-scopes.ts

@@ -0,0 +1,57 @@
+import { generateStandardId } from '@logto/shared/universal';
+import { sql } from 'slonik';
+
+import type { AlterationScript } from '../lib/types/alteration.js';
+
+const adminTenantId = 'admin';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    // Get `resourceId` of the admin tenant's resource whose indicator is `https://cloud.logto.io/api`.
+    const { id: resourceId } = await pool.one<{ id: string }>(sql`
+      select id from resources
+      where tenant_id = ${adminTenantId}
+      and indicator = 'https://cloud.logto.io/api'
+    `);
+
+    const { id: roleId } = await pool.one<{ id: string }>(sql`
+      select id from roles
+      where tenant_id = ${adminTenantId}
+      and name = 'admin:admin'
+    `);
+
+    const createAffiliateId = generateStandardId();
+    const manageAffiliateId = generateStandardId();
+
+    await pool.query(sql`
+      insert into scopes (tenant_id, id, name, description, resource_id)
+        values (
+          ${adminTenantId},
+          ${createAffiliateId},
+          'create:affiliate',
+          'Allow creating new affiliates and logs.',
+          ${resourceId}
+        ), (
+          ${adminTenantId},
+          ${manageAffiliateId},
+          'manage:affiliate',
+          'Allow managing affiliates, including create, update, and delete.',
+          ${resourceId}
+        );
+    `);
+
+    await pool.query(sql`
+      insert into roles_scopes (tenant_id, id, role_id, scope_id) values
+        (${adminTenantId}, ${generateStandardId()}, ${roleId}, ${createAffiliateId}),
+        (${adminTenantId}, ${generateStandardId()}, ${roleId}, ${manageAffiliateId});
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      delete from scopes
+      where tenant_id = ${adminTenantId} and name = any(array['create:affiliate', 'manage:affiliate']);
+    `);
+  },
+};
+
+export default alteration;

package/alterations-js/1.8.0-1692088012-add-is-suspend-column-to-tenants-table.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.8.0-1692088012-add-is-suspend-column-to-tenants-table.js

@@ -0,0 +1,14 @@
+import { sql } from 'slonik';
+const alteration = {
+    up: async (pool) => {
+        await pool.query(sql `
+      alter table tenants add column is_suspended boolean not null default false;
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      alter table tenants drop column is_suspended;
+    `);
+    },
+};
+export default alteration;

package/alterations-js/1.8.0-1692194751-add-affiliate-scopes.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.8.0-1692194751-add-affiliate-scopes.js

@@ -0,0 +1,48 @@
+import { generateStandardId } from '@logto/shared/universal';
+import { sql } from 'slonik';
+const adminTenantId = 'admin';
+const alteration = {
+    up: async (pool) => {
+        // Get `resourceId` of the admin tenant's resource whose indicator is `https://cloud.logto.io/api`.
+        const { id: resourceId } = await pool.one(sql `
+      select id from resources
+      where tenant_id = ${adminTenantId}
+      and indicator = 'https://cloud.logto.io/api'
+    `);
+        const { id: roleId } = await pool.one(sql `
+      select id from roles
+      where tenant_id = ${adminTenantId}
+      and name = 'admin:admin'
+    `);
+        const createAffiliateId = generateStandardId();
+        const manageAffiliateId = generateStandardId();
+        await pool.query(sql `
+      insert into scopes (tenant_id, id, name, description, resource_id)
+        values (
+          ${adminTenantId},
+          ${createAffiliateId},
+          'create:affiliate',
+          'Allow creating new affiliates and logs.',
+          ${resourceId}
+        ), (
+          ${adminTenantId},
+          ${manageAffiliateId},
+          'manage:affiliate',
+          'Allow managing affiliates, including create, update, and delete.',
+          ${resourceId}
+        );
+    `);
+        await pool.query(sql `
+      insert into roles_scopes (tenant_id, id, role_id, scope_id) values
+        (${adminTenantId}, ${generateStandardId()}, ${roleId}, ${createAffiliateId}),
+        (${adminTenantId}, ${generateStandardId()}, ${roleId}, ${manageAffiliateId});
+    `);
+    },
+    down: async (pool) => {
+        await pool.query(sql `
+      delete from scopes
+      where tenant_id = ${adminTenantId} and name = any(array['create:affiliate', 'manage:affiliate']);
+    `);
+    },
+};
+export default alteration;

package/lib/foundations/jsonb-types.js

@@ -65,7 +65,7 @@ export var CustomClientMetadataKey;
     CustomClientMetadataKey["RotateRefreshToken"] = "rotateRefreshToken";
 })(CustomClientMetadataKey || (CustomClientMetadataKey = {}));
 export const customClientMetadataGuard = z.object({
-    [CustomClientMetadataKey.CorsAllowedOrigins]: z.string().url().array().optional(),
+    [CustomClientMetadataKey.CorsAllowedOrigins]: z.string().min(1).array().optional(),
     [CustomClientMetadataKey.IdTokenTtl]: z.number().optional(),
     [CustomClientMetadataKey.RefreshTokenTtl]: z.number().optional(),
     [CustomClientMetadataKey.RefreshTokenTtlInDays]: z.number().int().min(1).max(90).optional(),

package/lib/models/tenants.d.ts

@@ -12,11 +12,9 @@ export declare const Tenants: import("@withtyped/server/model").default<"tenants
     name: string;
     tag: TenantTag;
     createdAt: Date;
-}, "name" | "createdAt" | "tag", "createdAt">;
+    isSuspended: boolean;
+}, "name" | "createdAt" | "isSuspended" | "tag", "createdAt">;
 export type TenantModel = InferModelType<typeof Tenants>;
-export type TenantInfo = Pick<TenantModel, 'id' | 'name' | 'tag'> & {
-    indicator: string;
-};
 export declare const tenantInfoGuard: z.ZodObject<z.extendShape<Pick<{
     id: z.ZodType<string, z.ZodTypeDef, string>;
     dbUser: z.ZodType<string | null, z.ZodTypeDef, string | null>;
@@ -24,16 +22,20 @@ export declare const tenantInfoGuard: z.ZodObject<z.extendShape<Pick<{
     name: z.ZodType<string, z.ZodTypeDef, string>;
     tag: z.ZodType<TenantTag, z.ZodTypeDef, TenantTag>;
     createdAt: z.ZodType<Date, z.ZodTypeDef, Date>;
-}, "name" | "id" | "tag">, {
+    isSuspended: z.ZodType<boolean, z.ZodTypeDef, boolean>;
+}, "name" | "id" | "isSuspended" | "tag">, {
     indicator: z.ZodString;
 }>, "strip", z.ZodTypeAny, {
     name: string;
     id: string;
     indicator: string;
+    isSuspended: boolean;
     tag: TenantTag;
 }, {
     name: string;
     id: string;
     indicator: string;
+    isSuspended: boolean;
     tag: TenantTag;
 }>;
+export type TenantInfo = z.infer<typeof tenantInfoGuard>;

package/lib/models/tenants.js

@@ -16,6 +16,7 @@ export const Tenants = createModel(
     name varchar(128) not null default 'My Project',
     tag varchar(64) not null default '${TenantTag.Development}',
     created_at timestamptz not null default(now()),
+    is_suspended boolean not null default false,
     primary key (id),
     constraint tenants__db_user
       unique (db_user)
@@ -25,5 +26,5 @@ export const Tenants = createModel(
     .extend('tag', z.nativeEnum(TenantTag))
     .extend('createdAt', { readonly: true });
 export const tenantInfoGuard = Tenants.guard('model')
-    .pick({ id: true, name: true, tag: true })
+    .pick({ id: true, name: true, tag: true, isSuspended: true })
     .extend({ indicator: z.string() });

package/lib/seeds/cloud-api.js

@@ -47,6 +47,8 @@ export const createCloudApi = () => {
         buildScope(CloudScope.ManageTenant, 'Allow managing existing tenants, including create without limitation, update, and delete.'),
         buildScope(CloudScope.SendEmail, 'Allow sending emails. This scope is only available to M2M application.'),
         buildScope(CloudScope.SendSms, 'Allow sending SMS. This scope is only available to M2M application.'),
+        buildScope(CloudScope.CreateAffiliate, 'Allow creating new affiliates and logs.'),
+        buildScope(CloudScope.ManageAffiliate, 'Allow managing affiliates, including create, update, and delete.'),
     ]);
 };
 export const createTenantApplicationRole = () => ({

package/lib/types/log/index.d.ts

@@ -6,6 +6,8 @@ export * as token from './token.js';
 export * as hook from './hook.js';
 /** Fallback for empty or unrecognized log keys. */
 export declare const LogKeyUnknown = "Unknown";
+export type AuditLogKey = typeof LogKeyUnknown | interaction.LogKey | token.LogKey;
+export type WebhookLogKey = hook.LogKey;
 /**
  * The union type of all available log keys.
  * Note duplicate keys are allowed but should be avoided.
@@ -13,4 +15,4 @@ export declare const LogKeyUnknown = "Unknown";
  * @see {@link interaction.LogKey} for interaction log keys.
  * @see {@link token.LogKey} for token log keys.
  **/
-export type LogKey = typeof LogKeyUnknown | interaction.LogKey | token.LogKey | hook.LogKey;
+export type LogKey = AuditLogKey | WebhookLogKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/schemas",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "license": "MPL-2.0",
   "type": "module",
@@ -31,11 +31,11 @@
     "@types/jest": "^29.4.0",
     "@types/node": "^18.11.18",
     "@types/pluralize": "^0.0.29",
-    "camelcase": "^7.0.0",
+    "camelcase": "^8.0.0",
     "chalk": "^5.0.0",
     "eslint": "^8.44.0",
     "jest": "^29.5.0",
-    "lint-staged": "^13.0.0",
+    "lint-staged": "^14.0.0",
     "pluralize": "^8.0.0",
     "prettier": "^3.0.0",
     "roarr": "^7.11.0",
@@ -70,7 +70,7 @@
     "@logto/phrases": "^1.4.1",
     "@logto/phrases-ui": "^1.2.0",
     "@logto/shared": "^2.0.0",
-    "@withtyped/server": "^0.12.8"
+    "@withtyped/server": "^0.12.9"
   },
   "peerDependencies": {
     "zod": "^3.20.2"