Merge branch '12.0'

rishabhpoddar · rishabhpoddar · commit 224e47ac5e6b · 2022-10-14T11:17:27.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [12.0.4] - 2022-10-14
+
+### Changed:
+
+-   Removed default defaultMaxAge from session claim base classes
+-   Added a 5 minute defaultMaxAge to UserRoleClaim, PermissionClaim and EmailVerificationClaim
+
 ## [12.0.3] - 2022-09-29
 
 ### Refactor:
diff --git a/lib/build/recipe/emailverification/emailVerificationClaim.js b/lib/build/recipe/emailverification/emailVerificationClaim.js
@@ -58,10 +58,11 @@ class EmailVerificationClaimClass extends claims_1.BooleanClaim {
                     }
                 });
             },
+            defaultMaxAgeInSeconds: 300,
         });
         this.validators = Object.assign(Object.assign({}, this.validators), {
             isVerified: (refetchTimeOnFalseInSeconds = 10, maxAgeInSeconds = 300) =>
-                Object.assign(Object.assign({}, this.validators.hasValue(true)), {
+                Object.assign(Object.assign({}, this.validators.hasValue(true, maxAgeInSeconds)), {
                     shouldRefetch: (payload, userContext) => {
                         const value = this.getValueFromPayload(payload, userContext);
                         return (
diff --git a/lib/build/recipe/session/claimBaseClasses/primitiveArrayClaim.d.ts b/lib/build/recipe/session/claimBaseClasses/primitiveArrayClaim.d.ts
@@ -3,17 +3,17 @@ import { JSONPrimitive } from "../../../types";
 import { SessionClaim, SessionClaimValidator } from "../types";
 export declare class PrimitiveArrayClaim<T extends JSONPrimitive> extends SessionClaim<T[]> {
     readonly fetchValue: (userId: string, userContext: any) => Promise<T[] | undefined> | T[] | undefined;
-    readonly defaultMaxAgeInSeconds: number;
+    readonly defaultMaxAgeInSeconds: number | undefined;
     constructor(config: { key: string; fetchValue: SessionClaim<T[]>["fetchValue"]; defaultMaxAgeInSeconds?: number });
     addToPayload_internal(payload: any, value: T[], _userContext: any): any;
     removeFromPayloadByMerge_internal(payload: any, _userContext?: any): any;
     removeFromPayload(payload: any, _userContext?: any): any;
     getValueFromPayload(payload: any, _userContext?: any): T[] | undefined;
     getLastRefetchTime(payload: any, _userContext?: any): number | undefined;
     validators: {
-        includes: (val: T, maxAgeInSeconds?: number, id?: string | undefined) => SessionClaimValidator;
-        excludes: (val: T, maxAgeInSeconds?: number, id?: string | undefined) => SessionClaimValidator;
-        includesAll: (val: T[], maxAgeInSeconds?: number, id?: string | undefined) => SessionClaimValidator;
-        excludesAll: (val: T[], maxAgeInSeconds?: number, id?: string | undefined) => SessionClaimValidator;
+        includes: (val: T, maxAgeInSeconds?: number | undefined, id?: string | undefined) => SessionClaimValidator;
+        excludes: (val: T, maxAgeInSeconds?: number | undefined, id?: string | undefined) => SessionClaimValidator;
+        includesAll: (val: T[], maxAgeInSeconds?: number | undefined, id?: string | undefined) => SessionClaimValidator;
+        excludesAll: (val: T[], maxAgeInSeconds?: number | undefined, id?: string | undefined) => SessionClaimValidator;
     };
 }
diff --git a/lib/build/recipe/session/claimBaseClasses/primitiveArrayClaim.js b/lib/build/recipe/session/claimBaseClasses/primitiveArrayClaim.js
@@ -216,7 +216,7 @@ class PrimitiveArrayClaim extends types_1.SessionClaim {
             },
         };
         this.fetchValue = config.fetchValue;
-        this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds === undefined ? 300 : config.defaultMaxAgeInSeconds;
+        this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds;
     }
     addToPayload_internal(payload, value, _userContext) {
         return Object.assign(Object.assign({}, payload), {
diff --git a/lib/build/recipe/session/claimBaseClasses/primitiveClaim.d.ts b/lib/build/recipe/session/claimBaseClasses/primitiveClaim.d.ts
@@ -3,14 +3,14 @@ import { JSONPrimitive } from "../../../types";
 import { SessionClaim, SessionClaimValidator } from "../types";
 export declare class PrimitiveClaim<T extends JSONPrimitive> extends SessionClaim<T> {
     readonly fetchValue: (userId: string, userContext: any) => Promise<T | undefined> | T | undefined;
-    readonly defaultMaxAgeInSeconds: number;
+    readonly defaultMaxAgeInSeconds: number | undefined;
     constructor(config: { key: string; fetchValue: SessionClaim<T>["fetchValue"]; defaultMaxAgeInSeconds?: number });
     addToPayload_internal(payload: any, value: T, _userContext: any): any;
     removeFromPayloadByMerge_internal(payload: any, _userContext?: any): any;
     removeFromPayload(payload: any, _userContext?: any): any;
     getValueFromPayload(payload: any, _userContext?: any): T | undefined;
     getLastRefetchTime(payload: any, _userContext?: any): number | undefined;
     validators: {
-        hasValue: (val: T, maxAgeInSeconds?: number, id?: string | undefined) => SessionClaimValidator;
+        hasValue: (val: T, maxAgeInSeconds?: number | undefined, id?: string | undefined) => SessionClaimValidator;
     };
 }
diff --git a/lib/build/recipe/session/claimBaseClasses/primitiveClaim.js b/lib/build/recipe/session/claimBaseClasses/primitiveClaim.js
@@ -80,7 +80,7 @@ class PrimitiveClaim extends types_1.SessionClaim {
             },
         };
         this.fetchValue = config.fetchValue;
-        this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds === undefined ? 300 : config.defaultMaxAgeInSeconds;
+        this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds;
     }
     addToPayload_internal(payload, value, _userContext) {
         return Object.assign(Object.assign({}, payload), {
diff --git a/lib/build/recipe/userroles/permissionClaim.js b/lib/build/recipe/userroles/permissionClaim.js
@@ -64,6 +64,7 @@ class PermissionClaimClass extends primitiveArrayClaim_1.PrimitiveArrayClaim {
                     return Array.from(userPermissions);
                 });
             },
+            defaultMaxAgeInSeconds: 300,
         });
     }
 }
diff --git a/lib/build/recipe/userroles/userRoleClaim.js b/lib/build/recipe/userroles/userRoleClaim.js
@@ -50,6 +50,7 @@ class UserRoleClaimClass extends primitiveArrayClaim_1.PrimitiveArrayClaim {
                     return res.roles;
                 });
             },
+            defaultMaxAgeInSeconds: 300,
         });
     }
 }
diff --git a/lib/build/version.d.ts b/lib/build/version.d.ts
diff --git a/lib/build/version.js b/lib/build/version.js
diff --git a/lib/ts/recipe/emailverification/emailVerificationClaim.ts b/lib/ts/recipe/emailverification/emailVerificationClaim.ts
@@ -22,12 +22,13 @@ export class EmailVerificationClaimClass extends BooleanClaim {
                     throw new Error("UNKNOWN_USER_ID");
                 }
             },
+            defaultMaxAgeInSeconds: 300,
         });
 
         this.validators = {
             ...this.validators,
             isVerified: (refetchTimeOnFalseInSeconds: number = 10, maxAgeInSeconds: number = 300) => ({
-                ...this.validators.hasValue(true),
+                ...this.validators.hasValue(true, maxAgeInSeconds),
                 shouldRefetch: (payload, userContext) => {
                     const value = this.getValueFromPayload(payload, userContext);
                     return (
diff --git a/lib/ts/recipe/session/claimBaseClasses/primitiveArrayClaim.ts b/lib/ts/recipe/session/claimBaseClasses/primitiveArrayClaim.ts
@@ -3,12 +3,12 @@ import { SessionClaim, SessionClaimValidator } from "../types";
 
 export class PrimitiveArrayClaim<T extends JSONPrimitive> extends SessionClaim<T[]> {
     public readonly fetchValue: (userId: string, userContext: any) => Promise<T[] | undefined> | T[] | undefined;
-    public readonly defaultMaxAgeInSeconds: number;
+    public readonly defaultMaxAgeInSeconds: number | undefined;
 
     constructor(config: { key: string; fetchValue: SessionClaim<T[]>["fetchValue"]; defaultMaxAgeInSeconds?: number }) {
         super(config.key);
         this.fetchValue = config.fetchValue;
-        this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds === undefined ? 300 : config.defaultMaxAgeInSeconds;
+        this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds;
     }
 
     addToPayload_internal(payload: any, value: T[], _userContext: any): any {
@@ -49,7 +49,7 @@ export class PrimitiveArrayClaim<T extends JSONPrimitive> extends SessionClaim<T
     validators = {
         includes: (
             val: T,
-            maxAgeInSeconds: number = this.defaultMaxAgeInSeconds,
+            maxAgeInSeconds: number | undefined = this.defaultMaxAgeInSeconds,
             id?: string
         ): SessionClaimValidator => {
             return {
@@ -90,7 +90,7 @@ export class PrimitiveArrayClaim<T extends JSONPrimitive> extends SessionClaim<T
         },
         excludes: (
             val: T,
-            maxAgeInSeconds: number = this.defaultMaxAgeInSeconds,
+            maxAgeInSeconds: number | undefined = this.defaultMaxAgeInSeconds,
             id?: string
         ): SessionClaimValidator => {
             return {
@@ -135,7 +135,7 @@ export class PrimitiveArrayClaim<T extends JSONPrimitive> extends SessionClaim<T
         },
         includesAll: (
             val: T[],
-            maxAgeInSeconds: number = this.defaultMaxAgeInSeconds,
+            maxAgeInSeconds: number | undefined = this.defaultMaxAgeInSeconds,
             id?: string
         ): SessionClaimValidator => {
             return {
@@ -177,7 +177,7 @@ export class PrimitiveArrayClaim<T extends JSONPrimitive> extends SessionClaim<T
         },
         excludesAll: (
             val: T[],
-            maxAgeInSeconds: number = this.defaultMaxAgeInSeconds,
+            maxAgeInSeconds: number | undefined = this.defaultMaxAgeInSeconds,
             id?: string
         ): SessionClaimValidator => {
             return {
diff --git a/lib/ts/recipe/session/claimBaseClasses/primitiveClaim.ts b/lib/ts/recipe/session/claimBaseClasses/primitiveClaim.ts
@@ -3,12 +3,12 @@ import { SessionClaim, SessionClaimValidator } from "../types";
 
 export class PrimitiveClaim<T extends JSONPrimitive> extends SessionClaim<T> {
     public readonly fetchValue: (userId: string, userContext: any) => Promise<T | undefined> | T | undefined;
-    public readonly defaultMaxAgeInSeconds: number;
+    public readonly defaultMaxAgeInSeconds: number | undefined;
 
     constructor(config: { key: string; fetchValue: SessionClaim<T>["fetchValue"]; defaultMaxAgeInSeconds?: number }) {
         super(config.key);
         this.fetchValue = config.fetchValue;
-        this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds === undefined ? 300 : config.defaultMaxAgeInSeconds;
+        this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds;
     }
 
     addToPayload_internal(payload: any, value: T, _userContext: any): any {
@@ -49,7 +49,7 @@ export class PrimitiveClaim<T extends JSONPrimitive> extends SessionClaim<T> {
     validators = {
         hasValue: (
             val: T,
-            maxAgeInSeconds: number = this.defaultMaxAgeInSeconds,
+            maxAgeInSeconds: number | undefined = this.defaultMaxAgeInSeconds,
             id?: string
         ): SessionClaimValidator => {
             return {
diff --git a/lib/ts/recipe/userroles/permissionClaim.ts b/lib/ts/recipe/userroles/permissionClaim.ts
@@ -33,6 +33,7 @@ export class PermissionClaimClass extends PrimitiveArrayClaim<string> {
 
                 return Array.from(userPermissions);
             },
+            defaultMaxAgeInSeconds: 300,
         });
     }
 }
diff --git a/lib/ts/recipe/userroles/userRoleClaim.ts b/lib/ts/recipe/userroles/userRoleClaim.ts
@@ -16,6 +16,7 @@ export class UserRoleClaimClass extends PrimitiveArrayClaim<string> {
                 });
                 return res.roles;
             },
+            defaultMaxAgeInSeconds: 300,
         });
     }
 }
diff --git a/lib/ts/version.ts b/lib/ts/version.ts
@@ -12,7 +12,7 @@
  * License for the specific language governing permissions and limitations
  * under the License.
  */
-export const version = "12.0.3";
+export const version = "12.0.4";
 
 export const cdiSupported = ["2.8", "2.9", "2.10", "2.11", "2.12", "2.13", "2.14", "2.15"];
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "supertokens-node",
-    "version": "12.0.3",
+    "version": "12.0.4",
     "description": "NodeJS driver for SuperTokens core",
     "main": "index.js",
     "scripts": {
diff --git a/test/session/claims/primitiveArrayClaim.test.js b/test/session/claims/primitiveArrayClaim.test.js
@@ -327,7 +327,7 @@ describe(`sessionClaims/primitiveArrayClaim: ${printPath(
                 });
             });
 
-            it("should not validate values older than default defaultMaxAge", async () => {
+            it("should validate old values with default defaultMaxAge", async () => {
                 const now = Date.now();
                 const clock = sinon.useFakeTimers(now);
 
@@ -338,12 +338,7 @@ describe(`sessionClaims/primitiveArrayClaim: ${printPath(
 
                 const res = await claim.validators.includes(includedItem).validate(payload, {});
                 assert.deepStrictEqual(res, {
-                    isValid: false,
-                    reason: {
-                        ageInSeconds: 604800,
-                        maxAgeInSeconds: 300,
-                        message: "expired",
-                    },
+                    isValid: true,
                 });
             });
 
@@ -543,7 +538,7 @@ describe(`sessionClaims/primitiveArrayClaim: ${printPath(
                 });
             });
 
-            it("should not validate values older than default defaultMaxAge", async () => {
+            it("should validate old values with default defaultMaxAge", async () => {
                 const now = Date.now();
                 const clock = sinon.useFakeTimers(now);
 
@@ -552,14 +547,9 @@ describe(`sessionClaims/primitiveArrayClaim: ${printPath(
                 // advance clock by one week
                 clock.tick(6.048e8);
 
-                const res = await claim.validators.excludes(includedItem).validate(payload, {});
+                const res = await claim.validators.excludes(notIncludedItem).validate(payload, {});
                 assert.deepStrictEqual(res, {
-                    isValid: false,
-                    reason: {
-                        ageInSeconds: 604800,
-                        maxAgeInSeconds: 300,
-                        message: "expired",
-                    },
+                    isValid: true,
                 });
             });
 
@@ -765,7 +755,7 @@ describe(`sessionClaims/primitiveArrayClaim: ${printPath(
                 });
             });
 
-            it("should refetch if value is older than default defaultMaxAge", async () => {
+            it("should not refetch old values with default defaultMaxAge", async () => {
                 const now = Date.now();
                 const clock = sinon.useFakeTimers(now);
 
@@ -774,7 +764,7 @@ describe(`sessionClaims/primitiveArrayClaim: ${printPath(
                 // advance clock by one week
                 clock.tick(6.048e8);
 
-                assert.equal(claim.validators.includesAll([notIncludedItem]).shouldRefetch(payload), true);
+                assert.equal(claim.validators.includesAll([notIncludedItem]).shouldRefetch(payload), false);
             });
 
             it("should not refetch if maxAge is overrides to infinite", async () => {
@@ -969,7 +959,7 @@ describe(`sessionClaims/primitiveArrayClaim: ${printPath(
                 });
             });
 
-            it("should not validate values older than default defaultMaxAge", async () => {
+            it("should validate old values with default defaultMaxAge", async () => {
                 const now = Date.now();
                 const clock = sinon.useFakeTimers(now);
 
@@ -978,14 +968,9 @@ describe(`sessionClaims/primitiveArrayClaim: ${printPath(
                 // advance clock by one week
                 clock.tick(6.048e8);
 
-                const res = await claim.validators.excludesAll([includedItem]).validate(payload, {});
+                const res = await claim.validators.excludesAll([notIncludedItem]).validate(payload, {});
                 assert.deepStrictEqual(res, {
-                    isValid: false,
-                    reason: {
-                        ageInSeconds: 604800,
-                        maxAgeInSeconds: 300,
-                        message: "expired",
-                    },
+                    isValid: true,
                 });
             });
 
diff --git a/test/session/claims/primitiveClaim.test.js b/test/session/claims/primitiveClaim.test.js
@@ -330,7 +330,7 @@ describe(`sessionClaims/primitiveClaim: ${printPath("[test/session/claims/primit
                     });
                 });
 
-                it("should not validate old values", async () => {
+                it("should validate old values", async () => {
                     const now = Date.now();
                     const clock = sinon.useFakeTimers(now);
 
@@ -341,12 +341,7 @@ describe(`sessionClaims/primitiveClaim: ${printPath("[test/session/claims/primit
 
                     const res = await claim.validators.hasValue(val).validate(payload, {});
                     assert.deepStrictEqual(res, {
-                        isValid: false,
-                        reason: {
-                            ageInSeconds: 604800,
-                            maxAgeInSeconds: 300,
-                            message: "expired",
-                        },
+                        isValid: true,
                     });
                 });
 
@@ -369,7 +364,7 @@ describe(`sessionClaims/primitiveClaim: ${printPath("[test/session/claims/primit
                     // advance clock by one week
                     clock.tick(6.048e8);
 
-                    assert.equal(claim.validators.hasValue(val2).shouldRefetch(payload), true);
+                    assert.equal(claim.validators.hasValue(val2).shouldRefetch(payload), false);
                 });
 
                 it("should not refetch with an overridden maxAgeInSeconds", async () => {

Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ class PrimitiveArrayClaim extends types_1.SessionClaim {`
`216`	`216`	`},`
`217`	`217`	`};`
`218`	`218`	`this.fetchValue = config.fetchValue;`
`219`		`- this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds === undefined ? 300 : config.defaultMaxAgeInSeconds;`
	`219`	`+ this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds;`
`220`	`220`	`}`
`221`	`221`	`addToPayload_internal(payload, value, _userContext) {`
`222`	`222`	`return Object.assign(Object.assign({}, payload), {`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ class PrimitiveClaim extends types_1.SessionClaim {`
`80`	`80`	`},`
`81`	`81`	`};`
`82`	`82`	`this.fetchValue = config.fetchValue;`
`83`		`- this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds === undefined ? 300 : config.defaultMaxAgeInSeconds;`
	`83`	`+ this.defaultMaxAgeInSeconds = config.defaultMaxAgeInSeconds;`
`84`	`84`	`}`
`85`	`85`	`addToPayload_internal(payload, value, _userContext) {`
`86`	`86`	`return Object.assign(Object.assign({}, payload), {`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,7 @@ class PermissionClaimClass extends primitiveArrayClaim_1.PrimitiveArrayClaim {`
`64`	`64`	`return Array.from(userPermissions);`
`65`	`65`	`});`
`66`	`66`	`},`
	`67`	`+ defaultMaxAgeInSeconds: 300,`
`67`	`68`	`});`
`68`	`69`	`}`
`69`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,7 @@ class UserRoleClaimClass extends primitiveArrayClaim_1.PrimitiveArrayClaim {`
`50`	`50`	`return res.roles;`
`51`	`51`	`});`
`52`	`52`	`},`
	`53`	`+ defaultMaxAgeInSeconds: 300,`
`53`	`54`	`});`
`54`	`55`	`}`
`55`	`56`	`}`