@logto/schemas 1.10.0 → 1.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. package/alterations/1.10.1-1695647183-update-private-key-type.ts +108 -0
  2. package/alterations/1.10.1-1696657546-organization-tables.ts +150 -0
  3. package/alterations/1.10.1-1697683802-add-sso-connectors-table.ts +66 -0
  4. package/alterations/1.10.1-1698646271-add-organization-created-flag.ts +75 -0
  5. package/alterations/1.10.1-1698820410-add-user-sso-identities-table.ts +61 -0
  6. package/alterations/1.10.1-1698910485-user-logto-data.ts +20 -0
  7. package/alterations/1.11.0-1699422979-add-sso-connector-id-col-to-user-sso-identities-table.ts +18 -0
  8. package/alterations/1.11.0-1699598903-remove-sso-only-column-in-sso-connectors-table.ts +18 -0
  9. package/alterations-js/1.10.1-1695647183-update-private-key-type.d.ts +3 -0
  10. package/alterations-js/1.10.1-1695647183-update-private-key-type.js +50 -0
  11. package/alterations-js/1.10.1-1696657546-organization-tables.d.ts +3 -0
  12. package/alterations-js/1.10.1-1696657546-organization-tables.js +136 -0
  13. package/alterations-js/1.10.1-1697683802-add-sso-connectors-table.d.ts +3 -0
  14. package/alterations-js/1.10.1-1697683802-add-sso-connectors-table.js +58 -0
  15. package/alterations-js/1.10.1-1698646271-add-organization-created-flag.d.ts +3 -0
  16. package/alterations-js/1.10.1-1698646271-add-organization-created-flag.js +26 -0
  17. package/alterations-js/1.10.1-1698820410-add-user-sso-identities-table.d.ts +4 -0
  18. package/alterations-js/1.10.1-1698820410-add-user-sso-identities-table.js +53 -0
  19. package/alterations-js/1.10.1-1698910485-user-logto-data.d.ts +3 -0
  20. package/alterations-js/1.10.1-1698910485-user-logto-data.js +16 -0
  21. package/alterations-js/1.11.0-1699422979-add-sso-connector-id-col-to-user-sso-identities-table.d.ts +3 -0
  22. package/alterations-js/1.11.0-1699422979-add-sso-connector-id-col-to-user-sso-identities-table.js +14 -0
  23. package/alterations-js/1.11.0-1699598903-remove-sso-only-column-in-sso-connectors-table.d.ts +3 -0
  24. package/alterations-js/1.11.0-1699598903-remove-sso-only-column-in-sso-connectors-table.js +14 -0
  25. package/lib/db-entries/application.d.ts +7 -1
  26. package/lib/db-entries/application.js +1 -0
  27. package/lib/db-entries/applications-role.d.ts +7 -1
  28. package/lib/db-entries/applications-role.js +1 -0
  29. package/lib/db-entries/connector.d.ts +7 -1
  30. package/lib/db-entries/connector.js +1 -0
  31. package/lib/db-entries/custom-phrase.d.ts +7 -1
  32. package/lib/db-entries/custom-phrase.js +1 -0
  33. package/lib/db-entries/daily-active-user.d.ts +7 -1
  34. package/lib/db-entries/daily-active-user.js +1 -0
  35. package/lib/db-entries/domain.d.ts +7 -1
  36. package/lib/db-entries/domain.js +1 -0
  37. package/lib/db-entries/hook.d.ts +7 -1
  38. package/lib/db-entries/hook.js +1 -0
  39. package/lib/db-entries/index.d.ts +8 -0
  40. package/lib/db-entries/index.js +8 -0
  41. package/lib/db-entries/log.d.ts +7 -1
  42. package/lib/db-entries/log.js +1 -0
  43. package/lib/db-entries/logto-config.d.ts +10 -4
  44. package/lib/db-entries/logto-config.js +4 -3
  45. package/lib/db-entries/oidc-model-instance.d.ts +7 -1
  46. package/lib/db-entries/oidc-model-instance.js +1 -0
  47. package/lib/db-entries/organization-role-scope-relation.d.ts +20 -0
  48. package/lib/db-entries/organization-role-scope-relation.js +29 -0
  49. package/lib/db-entries/organization-role-user-relation.d.ts +22 -0
  50. package/lib/db-entries/organization-role-user-relation.js +33 -0
  51. package/lib/db-entries/organization-role.d.ts +28 -0
  52. package/lib/db-entries/organization-role.js +33 -0
  53. package/lib/db-entries/organization-scope.d.ts +28 -0
  54. package/lib/db-entries/organization-scope.js +33 -0
  55. package/lib/db-entries/organization-user-relation.d.ts +20 -0
  56. package/lib/db-entries/organization-user-relation.js +29 -0
  57. package/lib/db-entries/organization.d.ts +32 -0
  58. package/lib/db-entries/organization.js +37 -0
  59. package/lib/db-entries/passcode.d.ts +7 -1
  60. package/lib/db-entries/passcode.js +1 -0
  61. package/lib/db-entries/resource.d.ts +7 -1
  62. package/lib/db-entries/resource.js +1 -0
  63. package/lib/db-entries/role.d.ts +7 -1
  64. package/lib/db-entries/role.js +1 -0
  65. package/lib/db-entries/roles-scope.d.ts +7 -1
  66. package/lib/db-entries/roles-scope.js +1 -0
  67. package/lib/db-entries/scope.d.ts +7 -1
  68. package/lib/db-entries/scope.js +1 -0
  69. package/lib/db-entries/sentinel-activity.d.ts +7 -1
  70. package/lib/db-entries/sentinel-activity.js +1 -0
  71. package/lib/db-entries/service-log.d.ts +7 -1
  72. package/lib/db-entries/service-log.js +1 -0
  73. package/lib/db-entries/sign-in-experience.d.ts +7 -1
  74. package/lib/db-entries/sign-in-experience.js +1 -0
  75. package/lib/db-entries/sso-connector.d.ts +46 -0
  76. package/lib/db-entries/sso-connector.js +54 -0
  77. package/lib/db-entries/system.d.ts +7 -1
  78. package/lib/db-entries/system.js +1 -0
  79. package/lib/db-entries/user-sso-identity.d.ts +32 -0
  80. package/lib/db-entries/user-sso-identity.js +50 -0
  81. package/lib/db-entries/user.d.ts +9 -1
  82. package/lib/db-entries/user.js +5 -0
  83. package/lib/db-entries/users-role.d.ts +7 -1
  84. package/lib/db-entries/users-role.js +1 -0
  85. package/lib/db-entries/verification-status.d.ts +7 -1
  86. package/lib/db-entries/verification-status.js +1 -0
  87. package/lib/foundations/index.d.ts +1 -1
  88. package/lib/foundations/index.js +1 -1
  89. package/lib/foundations/jsonb-types/custom-domain.d.ts +134 -0
  90. package/lib/foundations/jsonb-types/custom-domain.js +36 -0
  91. package/lib/foundations/jsonb-types/hooks.d.ts +32 -0
  92. package/lib/foundations/jsonb-types/hooks.js +24 -0
  93. package/lib/foundations/jsonb-types/index.d.ts +15 -0
  94. package/lib/foundations/jsonb-types/index.js +16 -0
  95. package/lib/foundations/jsonb-types/logs.d.ts +106 -0
  96. package/lib/foundations/jsonb-types/logs.js +20 -0
  97. package/lib/foundations/jsonb-types/oidc-module.d.ts +80 -0
  98. package/lib/foundations/jsonb-types/oidc-module.js +54 -0
  99. package/lib/foundations/jsonb-types/phrases.d.ts +5 -0
  100. package/lib/foundations/jsonb-types/phrases.js +2 -0
  101. package/lib/foundations/jsonb-types/sentinel.d.ts +27 -0
  102. package/lib/foundations/jsonb-types/sentinel.js +28 -0
  103. package/lib/foundations/jsonb-types/sign-in-experience.d.ts +118 -0
  104. package/lib/foundations/jsonb-types/sign-in-experience.js +56 -0
  105. package/lib/foundations/jsonb-types/sso-connector.d.ts +14 -0
  106. package/lib/foundations/jsonb-types/sso-connector.js +6 -0
  107. package/lib/foundations/jsonb-types/users.d.ts +285 -0
  108. package/lib/foundations/jsonb-types/users.js +47 -0
  109. package/lib/foundations/schemas.d.ts +11 -13
  110. package/lib/models/tenants.d.ts +8 -16
  111. package/lib/models/tenants.js +1 -6
  112. package/lib/seeds/logto-config.js +1 -0
  113. package/lib/types/application.d.ts +51 -1
  114. package/lib/types/application.js +7 -1
  115. package/lib/types/connector.d.ts +516 -2360
  116. package/lib/types/domain.d.ts +65 -27
  117. package/lib/types/hook.d.ts +15 -16
  118. package/lib/types/index.d.ts +4 -0
  119. package/lib/types/index.js +4 -0
  120. package/lib/types/interactions.d.ts +502 -10
  121. package/lib/types/interactions.js +83 -5
  122. package/lib/types/log/interaction.d.ts +4 -3
  123. package/lib/types/log/interaction.js +1 -0
  124. package/lib/types/logto-config.d.ts +74 -2
  125. package/lib/types/logto-config.js +38 -3
  126. package/lib/types/mfa.d.ts +211 -0
  127. package/lib/types/mfa.js +62 -0
  128. package/lib/types/organization.d.ts +48 -0
  129. package/lib/types/organization.js +21 -0
  130. package/lib/types/role.d.ts +5 -3
  131. package/lib/types/scope.d.ts +12 -27
  132. package/lib/types/sso-connector.d.ts +137 -0
  133. package/lib/types/sso-connector.js +24 -0
  134. package/lib/types/system.d.ts +26 -7
  135. package/lib/types/system.js +8 -0
  136. package/lib/types/tenant.d.ts +5 -0
  137. package/lib/types/tenant.js +6 -0
  138. package/lib/types/user-assets.d.ts +2 -2
  139. package/lib/types/user.d.ts +209 -66
  140. package/lib/types/user.js +8 -2
  141. package/package.json +7 -7
  142. package/tables/logto_configs.sql +1 -1
  143. package/tables/organization_role_scope_relations.sql +12 -0
  144. package/tables/organization_role_user_relations.sql +14 -0
  145. package/tables/organization_roles.sql +19 -0
  146. package/tables/organization_scopes.sql +19 -0
  147. package/tables/organization_user_relations.sql +12 -0
  148. package/tables/organizations.sql +19 -0
  149. package/tables/sso_connectors.sql +28 -0
  150. package/tables/user_sso_identities.sql +20 -0
  151. package/tables/users.sql +1 -0
  152. package/lib/foundations/jsonb-types.d.ts +0 -673
  153. package/lib/foundations/jsonb-types.js +0 -260
@@ -0,0 +1,137 @@
1
+ import { z } from 'zod';
2
+ /**
3
+ * SSO Connector data type that are returned to the experience client for sign-in use.
4
+ */
5
+ export declare const ssoConnectorMetadataGuard: z.ZodObject<{
6
+ id: z.ZodString;
7
+ connectorName: z.ZodString;
8
+ logo: z.ZodString;
9
+ darkLogo: z.ZodOptional<z.ZodString>;
10
+ }, "strip", z.ZodTypeAny, {
11
+ id: string;
12
+ logo: string;
13
+ connectorName: string;
14
+ darkLogo?: string | undefined;
15
+ }, {
16
+ id: string;
17
+ logo: string;
18
+ connectorName: string;
19
+ darkLogo?: string | undefined;
20
+ }>;
21
+ export type SsoConnectorMetadata = z.infer<typeof ssoConnectorMetadataGuard>;
22
+ declare const ssoConnectorFactoryDetailGuard: z.ZodObject<{
23
+ providerName: z.ZodString;
24
+ logo: z.ZodString;
25
+ description: z.ZodString;
26
+ }, "strip", z.ZodTypeAny, {
27
+ logo: string;
28
+ description: string;
29
+ providerName: string;
30
+ }, {
31
+ logo: string;
32
+ description: string;
33
+ providerName: string;
34
+ }>;
35
+ export type SsoConnectorFactoryDetail = z.infer<typeof ssoConnectorFactoryDetailGuard>;
36
+ export declare const ssoConnectorFactoriesResponseGuard: z.ZodObject<{
37
+ standardConnectors: z.ZodArray<z.ZodObject<{
38
+ providerName: z.ZodString;
39
+ logo: z.ZodString;
40
+ description: z.ZodString;
41
+ }, "strip", z.ZodTypeAny, {
42
+ logo: string;
43
+ description: string;
44
+ providerName: string;
45
+ }, {
46
+ logo: string;
47
+ description: string;
48
+ providerName: string;
49
+ }>, "many">;
50
+ providerConnectors: z.ZodArray<z.ZodObject<{
51
+ providerName: z.ZodString;
52
+ logo: z.ZodString;
53
+ description: z.ZodString;
54
+ }, "strip", z.ZodTypeAny, {
55
+ logo: string;
56
+ description: string;
57
+ providerName: string;
58
+ }, {
59
+ logo: string;
60
+ description: string;
61
+ providerName: string;
62
+ }>, "many">;
63
+ }, "strip", z.ZodTypeAny, {
64
+ standardConnectors: {
65
+ logo: string;
66
+ description: string;
67
+ providerName: string;
68
+ }[];
69
+ providerConnectors: {
70
+ logo: string;
71
+ description: string;
72
+ providerName: string;
73
+ }[];
74
+ }, {
75
+ standardConnectors: {
76
+ logo: string;
77
+ description: string;
78
+ providerName: string;
79
+ }[];
80
+ providerConnectors: {
81
+ logo: string;
82
+ description: string;
83
+ providerName: string;
84
+ }[];
85
+ }>;
86
+ export type SsoConnectorFactoriesResponse = z.infer<typeof ssoConnectorFactoriesResponseGuard>;
87
+ export declare const ssoConnectorWithProviderConfigGuard: z.ZodObject<{
88
+ id: z.ZodType<string, z.ZodTypeDef, string>;
89
+ tenantId: z.ZodType<string, z.ZodTypeDef, string>;
90
+ createdAt: z.ZodType<number, z.ZodTypeDef, number>;
91
+ syncProfile: z.ZodType<boolean, z.ZodTypeDef, boolean>;
92
+ config: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
93
+ domains: z.ZodType<string[], z.ZodTypeDef, string[]>;
94
+ branding: z.ZodType<{
95
+ logo?: string | undefined;
96
+ darkLogo?: string | undefined;
97
+ }, z.ZodTypeDef, {
98
+ logo?: string | undefined;
99
+ darkLogo?: string | undefined;
100
+ }>;
101
+ providerName: z.ZodType<string, z.ZodTypeDef, string>;
102
+ connectorName: z.ZodType<string, z.ZodTypeDef, string>;
103
+ providerLogo: z.ZodString;
104
+ providerConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
105
+ }, "strip", z.ZodTypeAny, {
106
+ id: string;
107
+ tenantId: string;
108
+ createdAt: number;
109
+ syncProfile: boolean;
110
+ config: import("@withtyped/server").JsonObject;
111
+ domains: string[];
112
+ branding: {
113
+ logo?: string | undefined;
114
+ darkLogo?: string | undefined;
115
+ };
116
+ providerName: string;
117
+ connectorName: string;
118
+ providerLogo: string;
119
+ providerConfig?: Record<string, unknown> | undefined;
120
+ }, {
121
+ id: string;
122
+ tenantId: string;
123
+ createdAt: number;
124
+ syncProfile: boolean;
125
+ config: import("@withtyped/server").JsonObject;
126
+ domains: string[];
127
+ branding: {
128
+ logo?: string | undefined;
129
+ darkLogo?: string | undefined;
130
+ };
131
+ providerName: string;
132
+ connectorName: string;
133
+ providerLogo: string;
134
+ providerConfig?: Record<string, unknown> | undefined;
135
+ }>;
136
+ export type SsoConnectorWithProviderConfig = z.infer<typeof ssoConnectorWithProviderConfigGuard>;
137
+ export {};
@@ -0,0 +1,24 @@
1
+ import { z } from 'zod';
2
+ import { SsoConnectors } from '../db-entries/sso-connector.js';
3
+ /**
4
+ * SSO Connector data type that are returned to the experience client for sign-in use.
5
+ */
6
+ export const ssoConnectorMetadataGuard = z.object({
7
+ id: z.string(),
8
+ connectorName: z.string(),
9
+ logo: z.string(),
10
+ darkLogo: z.string().optional(),
11
+ });
12
+ const ssoConnectorFactoryDetailGuard = z.object({
13
+ providerName: z.string(),
14
+ logo: z.string(),
15
+ description: z.string(),
16
+ });
17
+ export const ssoConnectorFactoriesResponseGuard = z.object({
18
+ standardConnectors: z.array(ssoConnectorFactoryDetailGuard),
19
+ providerConnectors: z.array(ssoConnectorFactoryDetailGuard),
20
+ });
21
+ export const ssoConnectorWithProviderConfigGuard = SsoConnectors.guard.merge(z.object({
22
+ providerLogo: z.string(),
23
+ providerConfig: z.record(z.unknown()).optional(),
24
+ }));
@@ -15,7 +15,8 @@ export declare const alterationStateGuard: Readonly<{
15
15
  }>;
16
16
  export declare enum StorageProvider {
17
17
  AzureStorage = "AzureStorage",
18
- S3Storage = "S3Storage"
18
+ S3Storage = "S3Storage",
19
+ GoogleStorage = "GoogleStorage"
19
20
  }
20
21
  export declare const storageProviderDataGuard: z.ZodDiscriminatedUnion<"provider", [z.ZodObject<{
21
22
  publicUrl: z.ZodOptional<z.ZodString>;
@@ -23,15 +24,15 @@ export declare const storageProviderDataGuard: z.ZodDiscriminatedUnion<"provider
23
24
  connectionString: z.ZodString;
24
25
  container: z.ZodString;
25
26
  }, "strip", z.ZodTypeAny, {
26
- publicUrl?: string | undefined;
27
27
  provider: StorageProvider.AzureStorage;
28
28
  connectionString: string;
29
29
  container: string;
30
- }, {
31
30
  publicUrl?: string | undefined;
31
+ }, {
32
32
  provider: StorageProvider.AzureStorage;
33
33
  connectionString: string;
34
34
  container: string;
35
+ publicUrl?: string | undefined;
35
36
  }>, z.ZodObject<{
36
37
  publicUrl: z.ZodOptional<z.ZodString>;
37
38
  provider: z.ZodLiteral<StorageProvider.S3Storage>;
@@ -41,21 +42,39 @@ export declare const storageProviderDataGuard: z.ZodDiscriminatedUnion<"provider
41
42
  accessKeyId: z.ZodString;
42
43
  accessSecretKey: z.ZodString;
43
44
  }, "strip", z.ZodTypeAny, {
44
- publicUrl?: string | undefined;
45
- endpoint?: string | undefined;
46
- region?: string | undefined;
47
45
  provider: StorageProvider.S3Storage;
48
46
  bucket: string;
49
47
  accessKeyId: string;
50
48
  accessSecretKey: string;
51
- }, {
52
49
  publicUrl?: string | undefined;
53
50
  endpoint?: string | undefined;
54
51
  region?: string | undefined;
52
+ }, {
55
53
  provider: StorageProvider.S3Storage;
56
54
  bucket: string;
57
55
  accessKeyId: string;
58
56
  accessSecretKey: string;
57
+ publicUrl?: string | undefined;
58
+ endpoint?: string | undefined;
59
+ region?: string | undefined;
60
+ }>, z.ZodObject<{
61
+ publicUrl: z.ZodOptional<z.ZodString>;
62
+ provider: z.ZodLiteral<StorageProvider.GoogleStorage>;
63
+ projectId: z.ZodString;
64
+ keyFilename: z.ZodString;
65
+ bucketName: z.ZodString;
66
+ }, "strip", z.ZodTypeAny, {
67
+ provider: StorageProvider.GoogleStorage;
68
+ projectId: string;
69
+ keyFilename: string;
70
+ bucketName: string;
71
+ publicUrl?: string | undefined;
72
+ }, {
73
+ provider: StorageProvider.GoogleStorage;
74
+ projectId: string;
75
+ keyFilename: string;
76
+ bucketName: string;
77
+ publicUrl?: string | undefined;
59
78
  }>]>;
60
79
  export type StorageProviderData = z.infer<typeof storageProviderDataGuard>;
61
80
  export declare enum StorageProviderKey {
@@ -15,6 +15,7 @@ export var StorageProvider;
15
15
  (function (StorageProvider) {
16
16
  StorageProvider["AzureStorage"] = "AzureStorage";
17
17
  StorageProvider["S3Storage"] = "S3Storage";
18
+ StorageProvider["GoogleStorage"] = "GoogleStorage";
18
19
  })(StorageProvider || (StorageProvider = {}));
19
20
  const basicConfig = {
20
21
  publicUrl: z.string().optional(),
@@ -35,6 +36,13 @@ export const storageProviderDataGuard = z.discriminatedUnion('provider', [
35
36
  accessSecretKey: z.string(),
36
37
  ...basicConfig,
37
38
  }),
39
+ z.object({
40
+ provider: z.literal(StorageProvider.GoogleStorage),
41
+ projectId: z.string(),
42
+ keyFilename: z.string(),
43
+ bucketName: z.string(),
44
+ ...basicConfig,
45
+ }),
38
46
  ]);
39
47
  export var StorageProviderKey;
40
48
  (function (StorageProviderKey) {
@@ -0,0 +1,5 @@
1
+ export declare enum TenantTag {
2
+ Development = "development",
3
+ Staging = "staging",
4
+ Production = "production"
5
+ }
@@ -0,0 +1,6 @@
1
+ export var TenantTag;
2
+ (function (TenantTag) {
3
+ TenantTag["Development"] = "development";
4
+ TenantTag["Staging"] = "staging";
5
+ TenantTag["Production"] = "production";
6
+ })(TenantTag || (TenantTag = {}));
@@ -8,13 +8,13 @@ export declare const userAssetsServiceStatusGuard: z.ZodObject<{
8
8
  allowUploadMimeTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<["image/jpeg", "image/png", "image/gif", "image/vnd.microsoft.icon", "image/svg+xml", "image/tiff", "image/webp", "image/bmp"]>, "many">>;
9
9
  maxUploadFileSize: z.ZodOptional<z.ZodNumber>;
10
10
  }, "strip", z.ZodTypeAny, {
11
+ status: "ready" | "not_configured";
11
12
  allowUploadMimeTypes?: ("image/jpeg" | "image/png" | "image/gif" | "image/vnd.microsoft.icon" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/bmp")[] | undefined;
12
13
  maxUploadFileSize?: number | undefined;
13
- status: "ready" | "not_configured";
14
14
  }, {
15
+ status: "ready" | "not_configured";
15
16
  allowUploadMimeTypes?: ("image/jpeg" | "image/png" | "image/gif" | "image/vnd.microsoft.icon" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/bmp")[] | undefined;
16
17
  maxUploadFileSize?: number | undefined;
17
- status: "ready" | "not_configured";
18
18
  }>;
19
19
  export type UserAssetsServiceStatus = z.infer<typeof userAssetsServiceStatusGuard>;
20
20
  export declare const userAssetsGuard: z.ZodObject<{