@osaas/client-web 0.4.0 → 0.5.0

package/lib/cat.d.ts

@@ -6,6 +6,13 @@ interface CatOptions {
     signingKey: string;
     instanceName?: string;
 }
+/**
+ * Cat options
+ * @typedef CatOptions
+ * @type object
+ * @property {string} signingKey - The signing key to use
+ * @property {string} [instanceName] - The instance name to use (default: 'default')
+ */
 /**
  * Generate a Common Access Token (CTA-5007) using Andersnas Nodecat open webservice
  *
@@ -36,5 +43,34 @@ interface CatOptions {
  * // 2D3RhEOhAQWhBFBha2FtYWlfa2V5X2hzMjU2WB2kAWdleWV2aW5uAmVqb25hcwYaZ9TH9QUaZ9TH9Vgg40JB9G77k5RWOlayUSLDl7oFVnnyb4aHYc1qls148WY
  */
 export declare function generateCommonAccessToken(ctx: Context, claims: Claims, opts: CatOptions): Promise<string>;
+/**
+ * Validate a Common Access Token (CTA-5007) using Andersnas Nodecat open webservice
+ *
+ * @memberof module:@osaas/client-web
+ * @async
+ * @param {Context} ctx - Eyevinn OSC context
+ * @param {string} token - A Common Access Token
+ * @param {CatOptions} opts - Service options
+ * @returns - The status and payload of the token
+ *
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { validateCommonAccessToken } from '@osaas/client-web';
+ * const ctx = new Context();
+ * const result = await validateCommonAccessToken(
+ *   ctx,
+ *   '2D3RhEOhAQWhBFBha2FtYWlfa2V5X2hzMjU2WB2kAWdleWV2aW5uAmVqb25hcwYaZ9TH9QUaZ9TH9Vgg40JB9G77k5RWOlayUSLDl7oFVnnyb4aHYc1qls148WY',
+ *   {
+ *     signingKey:
+ *       '403697de87af64611c1d32a05dab0fe1fcb715a86ab435f1ec99192d79569388'
+ *   }
+ * );
+ * console.log(result.status);
+ * console.log(result.payload);
+ */
+export declare function validateCommonAccessToken(ctx: Context, token: string, opts: CatOptions): Promise<{
+    status: string;
+    payload: Claims;
+}>;
 export {};
 //# sourceMappingURL=cat.d.ts.map

package/lib/cat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cat.d.ts","sourceRoot":"","sources":["../src/cat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwB,MAAM,oBAAoB,CAAC;AAOnE,KAAK,MAAM,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEjD,UAAU,UAAU;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,yBAAyB,CAC7C,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,UAAU,mBA4BjB"}
+{"version":3,"file":"cat.d.ts","sourceRoot":"","sources":["../src/cat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwB,MAAM,oBAAoB,CAAC;AAOnE,KAAK,MAAM,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEjD,UAAU,UAAU;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,yBAAyB,CAC7C,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,UAAU,mBA4BjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,yBAAyB,CAC7C,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,UAAU,GACf,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CA0B9C"}

package/lib/cat.js

@@ -1,8 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateCommonAccessToken = void 0;
+exports.validateCommonAccessToken = exports.generateCommonAccessToken = void 0;
 const client_core_1 = require("@osaas/client-core");
 const client_services_1 = require("@osaas/client-services");
+/**
+ * Cat options
+ * @typedef CatOptions
+ * @type object
+ * @property {string} signingKey - The signing key to use
+ * @property {string} [instanceName] - The instance name to use (default: 'default')
+ */
 /**
  * Generate a Common Access Token (CTA-5007) using Andersnas Nodecat open webservice
  *
@@ -60,4 +67,57 @@ async function generateCommonAccessToken(ctx, claims, opts) {
     return token;
 }
 exports.generateCommonAccessToken = generateCommonAccessToken;
+/**
+ * Validate a Common Access Token (CTA-5007) using Andersnas Nodecat open webservice
+ *
+ * @memberof module:@osaas/client-web
+ * @async
+ * @param {Context} ctx - Eyevinn OSC context
+ * @param {string} token - A Common Access Token
+ * @param {CatOptions} opts - Service options
+ * @returns - The status and payload of the token
+ *
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { validateCommonAccessToken } from '@osaas/client-web';
+ * const ctx = new Context();
+ * const result = await validateCommonAccessToken(
+ *   ctx,
+ *   '2D3RhEOhAQWhBFBha2FtYWlfa2V5X2hzMjU2WB2kAWdleWV2aW5uAmVqb25hcwYaZ9TH9QUaZ9TH9Vgg40JB9G77k5RWOlayUSLDl7oFVnnyb4aHYc1qls148WY',
+ *   {
+ *     signingKey:
+ *       '403697de87af64611c1d32a05dab0fe1fcb715a86ab435f1ec99192d79569388'
+ *   }
+ * );
+ * console.log(result.status);
+ * console.log(result.payload);
+ */
+async function validateCommonAccessToken(ctx, token, opts) {
+    const instanceName = opts.instanceName || 'default';
+    let instance = await (0, client_services_1.getAndersnasNodecatInstance)(ctx, instanceName);
+    if (!instance) {
+        const config = {
+            name: instanceName,
+            SigningKey: opts.signingKey
+        };
+        instance = await (0, client_services_1.createAndersnasNodecatInstance)(ctx, config);
+        await (0, client_core_1.waitForInstanceReady)('andersnas-nodecat', instanceName, ctx);
+    }
+    const sat = await ctx.getServiceAccessToken('andersnas-nodecat');
+    const apiUrl = new URL('/validateToken', instance.url);
+    const response = await fetch(apiUrl, {
+        method: 'POST',
+        headers: {
+            Authorization: `Bearer ${sat}`,
+            'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({ token })
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to validate token: ${response.statusText}`);
+    }
+    const result = (await response.json());
+    return result;
+}
+exports.validateCommonAccessToken = validateCommonAccessToken;
 //# sourceMappingURL=cat.js.map

package/lib/cat.js.map

@@ -1 +1 @@
-{"version":3,"file":"cat.js","sourceRoot":"","sources":["../src/cat.ts"],"names":[],"mappings":";;;AAAA,oDAAmE;AACnE,4DAIgC;AAShC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,yBAAyB,CAC7C,GAAY,EACZ,MAAc,EACd,IAAgB;IAEhB,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,SAAS,CAAC;IACpD,IAAI,QAAQ,GAAG,MAAM,IAAA,6CAA2B,EAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IACpE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,MAAM,GAA2B;YACrC,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;QACF,QAAQ,GAAG,MAAM,IAAA,gDAA8B,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,IAAA,kCAAoB,EAAC,mBAAmB,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;KACpE;IAED,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,gBAAgB,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE;QACnC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,GAAG,EAAE;YAC9B,cAAc,EAAE,kBAAkB;SACnC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;KAC7B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;KACrE;IACD,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACpC,OAAO,KAAK,CAAC;AACf,CAAC;AA/BD,8DA+BC"}
+{"version":3,"file":"cat.js","sourceRoot":"","sources":["../src/cat.ts"],"names":[],"mappings":";;;AAAA,oDAAmE;AACnE,4DAIgC;AAShC;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,yBAAyB,CAC7C,GAAY,EACZ,MAAc,EACd,IAAgB;IAEhB,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,SAAS,CAAC;IACpD,IAAI,QAAQ,GAAG,MAAM,IAAA,6CAA2B,EAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IACpE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,MAAM,GAA2B;YACrC,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;QACF,QAAQ,GAAG,MAAM,IAAA,gDAA8B,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,IAAA,kCAAoB,EAAC,mBAAmB,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;KACpE;IAED,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,gBAAgB,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE;QACnC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,GAAG,EAAE;YAC9B,cAAc,EAAE,kBAAkB;SACnC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;KAC7B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;KACrE;IACD,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACpC,OAAO,KAAK,CAAC;AACf,CAAC;AA/BD,8DA+BC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,KAAK,UAAU,yBAAyB,CAC7C,GAAY,EACZ,KAAa,EACb,IAAgB;IAEhB,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,SAAS,CAAC;IACpD,IAAI,QAAQ,GAAG,MAAM,IAAA,6CAA2B,EAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IACpE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,MAAM,GAA2B;YACrC,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;QACF,QAAQ,GAAG,MAAM,IAAA,gDAA8B,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,IAAA,kCAAoB,EAAC,mBAAmB,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;KACpE;IACD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,gBAAgB,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE;QACnC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,GAAG,EAAE;YAC9B,cAAc,EAAE,kBAAkB;SACnC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC;KAChC,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;KACrE;IACD,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAwC,CAAC;IAC9E,OAAO,MAAM,CAAC;AAChB,CAAC;AA9BD,8DA8BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osaas/client-web",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Open Source Cloud Client SDK web library",
   "author": "Eyevinn Open Source Cloud <osc@eyevinn.se>",
   "homepage": "https://www.osaas.io",
@@ -35,5 +35,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e218804b34b175b86dcea1bb46f1d47e8e429120"
+  "gitHead": "825e15d07d86e9be1cff495c5c708add26ad372b"
 }