Merge pull request #73 from skyflowapi/SK-172

SK-172/ Change context to "ctx" in CAA
skyflowapi · Nov 24, 2022 · c47be41 · c47be41
2 parents b110c99 + 217c26a
commit c47be41
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.7.1] - 2022-11-24
+
+### Changed
+- Rename context to 'ctx' in bearer token options.
+
 ## [1.7.0] - 2022-11-22
 
 ### Added

diff --git a/samples/service-account/SignedTokenGenerationExample.ts b/samples/service-account/SignedTokenGenerationExample.ts
@@ -9,6 +9,7 @@ function getSignedTokenFromFilePath() {
     return new Promise(async (resolve, reject) => {
         try {
             const options = {
+                 ctx:'ctx',
                  dataTokens: ['dataToken1','dataToken2'],
             };
 
@@ -34,6 +35,7 @@ function getSignedTokenFromCreds() {
     return new Promise(async (resolve, reject) => {
         try {
             const options = {
+                ctx:'ctx',
                 dataTokens: ['dataToken1','dataToken2'],
             };
             let response = await generateSignedDataTokensFromCreds(

diff --git a/samples/service-account/TokenGenerationWithContextExample.ts b/samples/service-account/TokenGenerationWithContextExample.ts
@@ -19,7 +19,7 @@ function getSkyflowBearerTokenWithContextFromFilePath() {
     return new Promise(async (resolve, reject) => {
         try {
             const options = {
-                context: "context_id",
+                ctx: "context_id",
             };
             if (!isExpired(bearerToken)) resolve(bearerToken);
             else {
@@ -37,7 +37,7 @@ function getSkyflowBearerTokenWithContextFromCreds() {
     return new Promise(async (resolve, reject) => {
         try {
             const options = {
-                context: "context_id",
+                ctx: "context_id",
             };
             if (!isExpired(bearerToken)) resolve(bearerToken);
             else {

diff --git a/src/service-account/util/Token.ts b/src/service-account/util/Token.ts
@@ -16,14 +16,14 @@ export type ResponseSignedDataTokens = { token: string, signedToken: string }
 
 
 export type BearerTokenOptions = {
-  context?: string,
+  ctx?: string,
   roleIDs?: string[],
 }
 
 export type SignedDataTokensOptions = {
   dataTokens: string[],
   timeToLive?: number,
-  context?: string,
+  ctx?: string,
 }
 
 function generateBearerToken(credentialsFilePath, options?: BearerTokenOptions): Promise<ResponseToken> {
@@ -92,7 +92,7 @@ function getToken(credentials, options?: BearerTokenOptions): Promise<ResponseTo
         aud: credentialsObj.tokenURI,
         exp: expiryTime,
         sub: credentialsObj.clientID,
-        ...(options && options.context ? { ctx: options.context } : {}),
+        ...(options && options.ctx ? { ctx: options.ctx } : {}),
       };
 
       if (claims.iss == null) {
@@ -313,7 +313,7 @@ function getSignedTokens(credentials, options: SignedDataTokensOptions): Promise
             exp: expiryTime,
             sub: credentialsObj.clientID,
             tok: token,
-            ...(options && options.context ? { ctx: options.context } : {}),
+            ...(options && options.ctx ? { ctx: options.ctx } : {}),
           };
 
           if (claims.key == null) {