@logto/schemas 1.0.0-beta.12 → 1.0.0-beta.14

package/alterations/1.0.0_beta.14-1665300135-sign-in-sign-up.ts

@@ -0,0 +1,174 @@
+import { sql } from 'slonik';
+
+import type { AlterationScript } from '../lib/types/alteration';
+
+enum SignInMethodState {
+  Primary = 'primary',
+  Secondary = 'secondary',
+  Disabled = 'disabled',
+}
+
+enum SignInMethodKey {
+  Username = 'username',
+  Email = 'email',
+  Sms = 'sms',
+  Social = 'social',
+}
+
+type SignInExperience = {
+  signInMethods: {
+    [SignInMethodKey.Username]: SignInMethodState;
+    [SignInMethodKey.Email]: SignInMethodState;
+    [SignInMethodKey.Sms]: SignInMethodState;
+    [SignInMethodKey.Social]: SignInMethodState;
+  };
+};
+
+enum SignUpIdentifier {
+  Email = 'email',
+  Sms = 'sms',
+  Username = 'username',
+  EmailOrSms = 'emailOrSms',
+  None = 'none',
+}
+
+enum SignInIdentifier {
+  Email = 'email',
+  Sms = 'Sms',
+  Username = 'username',
+}
+
+type SignIn = {
+  methods: Array<{
+    identifier: SignInIdentifier;
+    password: boolean;
+    verificationCode: boolean;
+    isPasswordPrimary: boolean;
+  }>;
+};
+
+type SignUp = {
+  identifier: SignUpIdentifier;
+  password: boolean;
+  verify: boolean;
+};
+
+const parseSignInMethodToSignInIdentifier = (
+  method: SignInMethodKey
+): SignInIdentifier | undefined => {
+  if (method === SignInMethodKey.Username) {
+    return SignInIdentifier.Username;
+  }
+
+  if (method === SignInMethodKey.Email) {
+    return SignInIdentifier.Email;
+  }
+
+  if (method === SignInMethodKey.Sms) {
+    return SignInIdentifier.Sms;
+  }
+};
+
+const parseSignInMethodToSignUpIdentifier = (method?: SignInMethodKey): SignUpIdentifier => {
+  if (method === SignInMethodKey.Username) {
+    return SignUpIdentifier.Username;
+  }
+
+  if (method === SignInMethodKey.Email) {
+    return SignUpIdentifier.Email;
+  }
+
+  if (method === SignInMethodKey.Sms) {
+    return SignUpIdentifier.Sms;
+  }
+
+  return SignUpIdentifier.None;
+};
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      alter table sign_in_experiences add column sign_in jsonb
+    `);
+    await pool.query(sql`
+      alter table sign_in_experiences add column sign_up jsonb
+    `);
+    await pool.query(sql`
+      alter table sign_in_experiences add column forgot_password boolean not null default false
+    `);
+
+    const id = 'default';
+    const data = await pool.maybeOne<SignInExperience>(
+      sql`select * from sign_in_experiences where id = ${id}`
+    );
+
+    /* eslint-disable @silverhand/fp/no-mutating-methods */
+    if (data) {
+      const { signInMethods } = data;
+      const methodKeys = Object.values(SignInMethodKey);
+      const primaryMethod = methodKeys.find(
+        (key) => signInMethods[key] === SignInMethodState.Primary
+      );
+      const secondaryMethods = methodKeys.filter(
+        (key) => signInMethods[key] === SignInMethodState.Secondary
+      );
+      const signIn: SignIn = {
+        methods: [],
+      };
+
+      const methods = [primaryMethod, ...secondaryMethods];
+
+      for (const method of methods) {
+        if (!method) {
+          continue;
+        }
+
+        const identifier = parseSignInMethodToSignInIdentifier(method);
+
+        if (identifier) {
+          signIn.methods.push({
+            identifier,
+            password: identifier === SignInIdentifier.Username,
+            verificationCode: identifier !== SignInIdentifier.Username,
+            isPasswordPrimary: false,
+          });
+        }
+      }
+
+      const signUpIdentifier = parseSignInMethodToSignUpIdentifier(primaryMethod);
+      const signUp: SignUp = {
+        identifier: signUpIdentifier,
+        verify: true,
+        password: signUpIdentifier === SignUpIdentifier.Username,
+      };
+
+      await pool.query(sql`
+        update sign_in_experiences set sign_in = ${JSON.stringify(signIn)} where id = ${id}
+      `);
+      await pool.query(sql`
+        update sign_in_experiences set sign_up = ${JSON.stringify(signUp)} where id = ${id}
+      `);
+    }
+    /* eslint-enable @silverhand/fp/no-mutating-methods */
+
+    await pool.query(sql`
+      alter table sign_in_experiences alter column sign_in set not null
+    `);
+    await pool.query(sql`
+      alter table sign_in_experiences alter column sign_up set not null
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      alter table sign_in_experiences drop column sign_in
+    `);
+    await pool.query(sql`
+      alter table sign_in_experiences drop column sign_up
+    `);
+    await pool.query(sql`
+      alter table sign_in_experiences drop column forgot_password
+    `);
+  },
+};
+
+export default alteration;

package/alterations/1.0.0_beta.14-1667283640-remove-forgot-password.ts

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

package/alterations/1.0.0_beta.14-1667292082-remove-sign-in-method.ts

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

package/alterations/1.0.0_beta.14-1667374974-user-suspend.ts

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

package/alterations/1.0.0_beta.14-1667900481-add-passcode-type-continue.ts

@@ -0,0 +1,19 @@
+import { sql } from 'slonik';
+
+import type { AlterationScript } from '../lib/types/alteration';
+
+const alteration: AlterationScript = {
+  up: async (pool) => {
+    await pool.query(sql`
+      alter type passcode_type add value 'Continue'
+    `);
+  },
+  down: async (pool) => {
+    await pool.query(sql`
+      drop type passcode_type
+      create type passcode_type as enum ('SignIn', 'Register', 'ForgotPassword');
+    `);
+  },
+};
+
+export default alteration;

package/alterations/README.md

@@ -1,4 +1,4 @@
-# Database Alteration
+# Database alteration
 
 The folder for all alteration files.
 
@@ -10,6 +10,10 @@ As for development, the `version` is "next" until the package is released.
 
 Note that, you SHOULD NOT change the content of the alteration files after they are created. If you need to change the alteration, you should create a new alteration file with the new content.
 
+## Deploy unreleased alterations
+
+To deploy scripts with the `next` version, run `pnpm alteration deploy next`. This is helpful if you want to test your alteration scripts.
+
 ## Typing
 
 ```ts
@@ -28,15 +32,15 @@ The `down` function is designed for the future downgrade feature.
 ```ts
 export const up = async (connection) => {
   await connection.query(`
-    ALTER TABLE "user"
-    ADD COLUMN "email" VARCHAR(255) NOT NULL;
+    alter table "user"
+    add column "email" varchar(255) not null;
   `);
 };
 
 export const down = async (connection) => {
   await connection.query(`
-    ALTER TABLE "user"
-    DROP COLUMN "email";
+    alter table "user"
+    drop column "email";
   `);
 };
 ```

package/alterations-js/1.0.0_beta.14-1665300135-sign-in-sign-up.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.0.0_beta.14-1665300135-sign-in-sign-up.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const slonik_1 = require("slonik");
+var SignInMethodState;
+(function (SignInMethodState) {
+    SignInMethodState["Primary"] = "primary";
+    SignInMethodState["Secondary"] = "secondary";
+    SignInMethodState["Disabled"] = "disabled";
+})(SignInMethodState || (SignInMethodState = {}));
+var SignInMethodKey;
+(function (SignInMethodKey) {
+    SignInMethodKey["Username"] = "username";
+    SignInMethodKey["Email"] = "email";
+    SignInMethodKey["Sms"] = "sms";
+    SignInMethodKey["Social"] = "social";
+})(SignInMethodKey || (SignInMethodKey = {}));
+var SignUpIdentifier;
+(function (SignUpIdentifier) {
+    SignUpIdentifier["Email"] = "email";
+    SignUpIdentifier["Sms"] = "sms";
+    SignUpIdentifier["Username"] = "username";
+    SignUpIdentifier["EmailOrSms"] = "emailOrSms";
+    SignUpIdentifier["None"] = "none";
+})(SignUpIdentifier || (SignUpIdentifier = {}));
+var SignInIdentifier;
+(function (SignInIdentifier) {
+    SignInIdentifier["Email"] = "email";
+    SignInIdentifier["Sms"] = "Sms";
+    SignInIdentifier["Username"] = "username";
+})(SignInIdentifier || (SignInIdentifier = {}));
+const parseSignInMethodToSignInIdentifier = (method) => {
+    if (method === SignInMethodKey.Username) {
+        return SignInIdentifier.Username;
+    }
+    if (method === SignInMethodKey.Email) {
+        return SignInIdentifier.Email;
+    }
+    if (method === SignInMethodKey.Sms) {
+        return SignInIdentifier.Sms;
+    }
+};
+const parseSignInMethodToSignUpIdentifier = (method) => {
+    if (method === SignInMethodKey.Username) {
+        return SignUpIdentifier.Username;
+    }
+    if (method === SignInMethodKey.Email) {
+        return SignUpIdentifier.Email;
+    }
+    if (method === SignInMethodKey.Sms) {
+        return SignUpIdentifier.Sms;
+    }
+    return SignUpIdentifier.None;
+};
+const alteration = {
+    up: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences add column sign_in jsonb
+    `);
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences add column sign_up jsonb
+    `);
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences add column forgot_password boolean not null default false
+    `);
+        const id = 'default';
+        const data = await pool.maybeOne((0, slonik_1.sql) `select * from sign_in_experiences where id = ${id}`);
+        /* eslint-disable @silverhand/fp/no-mutating-methods */
+        if (data) {
+            const { signInMethods } = data;
+            const methodKeys = Object.values(SignInMethodKey);
+            const primaryMethod = methodKeys.find((key) => signInMethods[key] === SignInMethodState.Primary);
+            const secondaryMethods = methodKeys.filter((key) => signInMethods[key] === SignInMethodState.Secondary);
+            const signIn = {
+                methods: [],
+            };
+            const methods = [primaryMethod, ...secondaryMethods];
+            for (const method of methods) {
+                if (!method) {
+                    continue;
+                }
+                const identifier = parseSignInMethodToSignInIdentifier(method);
+                if (identifier) {
+                    signIn.methods.push({
+                        identifier,
+                        password: identifier === SignInIdentifier.Username,
+                        verificationCode: identifier !== SignInIdentifier.Username,
+                        isPasswordPrimary: false,
+                    });
+                }
+            }
+            const signUpIdentifier = parseSignInMethodToSignUpIdentifier(primaryMethod);
+            const signUp = {
+                identifier: signUpIdentifier,
+                verify: true,
+                password: signUpIdentifier === SignUpIdentifier.Username,
+            };
+            await pool.query((0, slonik_1.sql) `
+        update sign_in_experiences set sign_in = ${JSON.stringify(signIn)} where id = ${id}
+      `);
+            await pool.query((0, slonik_1.sql) `
+        update sign_in_experiences set sign_up = ${JSON.stringify(signUp)} where id = ${id}
+      `);
+        }
+        /* eslint-enable @silverhand/fp/no-mutating-methods */
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences alter column sign_in set not null
+    `);
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences alter column sign_up set not null
+    `);
+    },
+    down: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences drop column sign_in
+    `);
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences drop column sign_up
+    `);
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences drop column forgot_password
+    `);
+    },
+};
+exports.default = alteration;

package/alterations-js/1.0.0_beta.14-1667283640-remove-forgot-password.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.0.0_beta.14-1667283640-remove-forgot-password.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const slonik_1 = require("slonik");
+const alteration = {
+    up: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences drop column forgot_password
+    `);
+    },
+    down: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences add column forgot_password boolean not null default false
+    `);
+    },
+};
+exports.default = alteration;

package/alterations-js/1.0.0_beta.14-1667292082-remove-sign-in-method.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.0.0_beta.14-1667292082-remove-sign-in-method.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const slonik_1 = require("slonik");
+const alteration = {
+    up: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences drop column sign_in_methods
+    `);
+    },
+    down: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      alter table sign_in_experiences add column sign_in_methods jsonb not null default '{}'::jsonb,
+    `);
+    },
+};
+exports.default = alteration;

package/alterations-js/1.0.0_beta.14-1667374974-user-suspend.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.0.0_beta.14-1667374974-user-suspend.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const slonik_1 = require("slonik");
+const alteration = {
+    up: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      alter table users add column is_suspended boolean not null default false;
+    `);
+    },
+    down: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      alter table users drop column is_suspended;
+    `);
+    },
+};
+exports.default = alteration;

package/alterations-js/1.0.0_beta.14-1667900481-add-passcode-type-continue.d.ts

@@ -0,0 +1,3 @@
+import type { AlterationScript } from '../lib/types/alteration';
+declare const alteration: AlterationScript;
+export default alteration;

package/alterations-js/1.0.0_beta.14-1667900481-add-passcode-type-continue.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const slonik_1 = require("slonik");
+const alteration = {
+    up: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      alter type passcode_type add value 'Continue'
+    `);
+    },
+    down: async (pool) => {
+        await pool.query((0, slonik_1.sql) `
+      drop type passcode_type
+      create type passcode_type as enum ('SignIn', 'Register', 'ForgotPassword');
+    `);
+    },
+};
+exports.default = alteration;

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

@@ -1,4 +1,4 @@
-import { OidcClientMetadata, CustomClientMetadata, RoleNames, GeneratedSchema } from '../foundations';
+import type { OidcClientMetadata, CustomClientMetadata, RoleNames, GeneratedSchema } from '../foundations';
 import { ApplicationType } from './custom-types';
 export declare type CreateApplication = {
     id: string;

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

@@ -1,4 +1,4 @@
-import { ArbitraryObject, GeneratedSchema } from '../foundations';
+import type { ArbitraryObject, GeneratedSchema } from '../foundations';
 export declare type CreateConnector = {
     id: string;
     enabled?: boolean;

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

@@ -1,4 +1,4 @@
-import { Translation, GeneratedSchema } from '../foundations';
+import type { Translation, GeneratedSchema } from '../foundations';
 export declare type CreateCustomPhrase = {
     languageTag: string;
     translation: Translation;

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

@@ -7,7 +7,8 @@ export declare enum ApplicationType {
 export declare enum PasscodeType {
     SignIn = "SignIn",
     Register = "Register",
-    ForgotPassword = "ForgotPassword"
+    ForgotPassword = "ForgotPassword",
+    Continue = "Continue"
 }
 export declare enum SignInMode {
     SignIn = "SignIn",

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

@@ -14,6 +14,7 @@ var PasscodeType;
     PasscodeType["SignIn"] = "SignIn";
     PasscodeType["Register"] = "Register";
     PasscodeType["ForgotPassword"] = "ForgotPassword";
+    PasscodeType["Continue"] = "Continue";
 })(PasscodeType = exports.PasscodeType || (exports.PasscodeType = {}));
 var SignInMode;
 (function (SignInMode) {

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

@@ -1,4 +1,4 @@
-import { ArbitraryObject, GeneratedSchema } from '../foundations';
+import type { ArbitraryObject, GeneratedSchema } from '../foundations';
 export declare type CreateLog = {
     id: string;
     type: string;

package/lib/db-entries/logto-config.d.ts

@@ -1,4 +1,4 @@
-import { ArbitraryObject, GeneratedSchema } from '../foundations';
+import type { ArbitraryObject, GeneratedSchema } from '../foundations';
 export declare type CreateLogtoConfig = {
     key: string;
     value?: ArbitraryObject;

package/lib/db-entries/oidc-model-instance.d.ts

@@ -1,4 +1,4 @@
-import { OidcModelInstancePayload, GeneratedSchema } from '../foundations';
+import type { OidcModelInstancePayload, GeneratedSchema } from '../foundations';
 export declare type CreateOidcModelInstance = {
     modelName: string;
     id: string;

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

@@ -1,4 +1,4 @@
-import { GeneratedSchema } from '../foundations';
+import type { GeneratedSchema } from '../foundations';
 import { PasscodeType } from './custom-types';
 export declare type CreatePasscode = {
     id: string;

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

@@ -1,4 +1,4 @@
-import { GeneratedSchema } from '../foundations';
+import type { GeneratedSchema } from '../foundations';
 export declare type CreateResource = {
     id: string;
     name: string;

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

@@ -1,4 +1,4 @@
-import { GeneratedSchema } from '../foundations';
+import type { GeneratedSchema } from '../foundations';
 export declare type CreateRole = {
     name: string;
     description: string;

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

@@ -1,4 +1,4 @@
-import { AdminConsoleConfig, GeneratedSchema } from '../foundations';
+import type { AdminConsoleConfig, GeneratedSchema } from '../foundations';
 export declare type CreateSetting = {
     id: string;
     adminConsole: AdminConsoleConfig;

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

@@ -1,4 +1,4 @@
-import { Color, Branding, LanguageInfo, TermsOfUse, SignInMethods, ConnectorTargets, GeneratedSchema } from '../foundations';
+import type { Color, Branding, LanguageInfo, TermsOfUse, SignIn, SignUp, ConnectorTargets, GeneratedSchema } from '../foundations';
 import { SignInMode } from './custom-types';
 export declare type CreateSignInExperience = {
     id: string;
@@ -6,7 +6,8 @@ export declare type CreateSignInExperience = {
     branding: Branding;
     languageInfo: LanguageInfo;
     termsOfUse: TermsOfUse;
-    signInMethods: SignInMethods;
+    signIn: SignIn;
+    signUp: SignUp;
     socialSignInConnectorTargets?: ConnectorTargets;
     signInMode?: SignInMode;
 };
@@ -16,7 +17,8 @@ export declare type SignInExperience = {
     branding: Branding;
     languageInfo: LanguageInfo;
     termsOfUse: TermsOfUse;
-    signInMethods: SignInMethods;
+    signIn: SignIn;
+    signUp: SignUp;
     socialSignInConnectorTargets: ConnectorTargets;
     signInMode: SignInMode;
 };

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

@@ -11,7 +11,8 @@ const createGuard = zod_1.z.object({
     branding: foundations_1.brandingGuard,
     languageInfo: foundations_1.languageInfoGuard,
     termsOfUse: foundations_1.termsOfUseGuard,
-    signInMethods: foundations_1.signInMethodsGuard,
+    signIn: foundations_1.signInGuard,
+    signUp: foundations_1.signUpGuard,
     socialSignInConnectorTargets: foundations_1.connectorTargetsGuard.optional(),
     signInMode: zod_1.z.nativeEnum(custom_types_1.SignInMode).optional(),
 });
@@ -21,7 +22,8 @@ const guard = zod_1.z.object({
     branding: foundations_1.brandingGuard,
     languageInfo: foundations_1.languageInfoGuard,
     termsOfUse: foundations_1.termsOfUseGuard,
-    signInMethods: foundations_1.signInMethodsGuard,
+    signIn: foundations_1.signInGuard,
+    signUp: foundations_1.signUpGuard,
     socialSignInConnectorTargets: foundations_1.connectorTargetsGuard,
     signInMode: zod_1.z.nativeEnum(custom_types_1.SignInMode),
 });
@@ -34,7 +36,8 @@ exports.SignInExperiences = Object.freeze({
         branding: 'branding',
         languageInfo: 'language_info',
         termsOfUse: 'terms_of_use',
-        signInMethods: 'sign_in_methods',
+        signIn: 'sign_in',
+        signUp: 'sign_up',
         socialSignInConnectorTargets: 'social_sign_in_connector_targets',
         signInMode: 'sign_in_mode',
     },
@@ -44,7 +47,8 @@ exports.SignInExperiences = Object.freeze({
         'branding',
         'languageInfo',
         'termsOfUse',
-        'signInMethods',
+        'signIn',
+        'signUp',
         'socialSignInConnectorTargets',
         'signInMode',
     ],