@shopify/cli-kit 3.0.25 → 3.1.0

package/dist/session/redirect-listener.d.ts

@@ -0,0 +1,34 @@
+/**
+ * It represents the result of a redirect.
+ */
+declare type RedirectCallback = (error: Error | undefined, state: string | undefined, code: string | undefined) => void;
+/**
+ * Defines the interface of the options that
+ * are used to instantiate a redirect listener.
+ */
+interface RedirectListenerOptions {
+    host: string;
+    port: number;
+    callback: RedirectCallback;
+}
+/**
+ * When the authentication completes, Identity redirects
+ * the user to a URL. In the case of the CLI, the redirect
+ * is to localhost passing some parameters that are necessary
+ * to continue the authentication. Because of that, we need
+ * an HTTP server that runs and listens to the request.
+ */
+export declare class RedirectListener {
+    private static createServer;
+    port: number;
+    host: string;
+    server: ReturnType<typeof RedirectListener.createServer>;
+    constructor(options: RedirectListenerOptions);
+    start(): void;
+    stop(): Promise<void>;
+}
+export declare function listenRedirect(host: string, port: number, url: string): Promise<{
+    code: string;
+    state: string;
+}>;
+export {};

package/dist/session/redirect-listener.js

@@ -0,0 +1,97 @@
+import { getFavicon, getStylesheet, getEmptyUrlHTML, getAuthErrorHTML, getMissingCodeHTML, getMissingStateHTML, getSuccessHTML, EmptyUrlString, MissingCodeString, MissingStateString, } from './post-auth.js';
+import { Abort, Bug } from '../error.js';
+import { content, info, token } from '../output.js';
+import Fastify from 'fastify';
+import url from 'url';
+const ResponseTimeoutSeconds = 10;
+const ServerStopDelaySeconds = 0.5;
+/**
+ * When the authentication completes, Identity redirects
+ * the user to a URL. In the case of the CLI, the redirect
+ * is to localhost passing some parameters that are necessary
+ * to continue the authentication. Because of that, we need
+ * an HTTP server that runs and listens to the request.
+ */
+export class RedirectListener {
+    constructor(options) {
+        this.port = options.port;
+        this.host = options.host;
+        this.server = RedirectListener.createServer(options.callback);
+    }
+    static createServer(callback) {
+        const server = Fastify().get('*', async (request, reply) => {
+            const requestUrl = request.url;
+            if (requestUrl === '/favicon.svg') {
+                const faviconFile = await getFavicon();
+                reply.header('Content-Type', 'image/svg+xml').send(faviconFile);
+                return {};
+            }
+            else if (requestUrl === '/style.css') {
+                const stylesheetFile = await getStylesheet();
+                reply.header('Content-Type', 'text/css').send(stylesheetFile);
+                return {};
+            }
+            const respond = (contents, error, state, code) => {
+                reply.header('Content-Type', 'text/html').send(contents);
+                callback(error, state, code);
+                return {};
+            };
+            // If there was an empty/malformed URL sent back.
+            if (!requestUrl) {
+                const file = await getEmptyUrlHTML();
+                const err = new Bug(EmptyUrlString);
+                return respond(file, err, undefined, undefined);
+            }
+            // If an error was returned by the Identity server.
+            const queryObject = url.parse(requestUrl, true).query;
+            if (queryObject.error && queryObject.error_description) {
+                const file = await getAuthErrorHTML();
+                const err = new Abort(`${queryObject.error_description}`);
+                return respond(file, err, undefined, undefined);
+            }
+            // If the code isn't present in the URL.
+            if (!queryObject.code) {
+                const file = await getMissingCodeHTML();
+                const err = new Bug(MissingCodeString);
+                return respond(file, err, undefined, undefined);
+            }
+            // If the state isn't present in the URL.
+            if (!queryObject.state) {
+                const file = await getMissingStateHTML();
+                const err = new Bug(MissingStateString);
+                return respond(file, err, undefined, undefined);
+            }
+            const file = await getSuccessHTML();
+            return respond(file, undefined, `${queryObject.code}`, `${queryObject.state}`);
+        });
+        return server;
+    }
+    start() {
+        this.server.listen({ port: this.port, host: this.host }, () => { });
+    }
+    async stop() {
+        await this.server.close();
+    }
+}
+export async function listenRedirect(host, port, url) {
+    const result = await new Promise((resolve, reject) => {
+        const timeout = setTimeout(() => {
+            const message = '\nAuto-open timed out. Open the login page: ';
+            info(content `${message}${token.link('Log in to Shopify Partners', url)}\n`);
+        }, ResponseTimeoutSeconds * 1000);
+        const callback = async (error, code, state) => {
+            clearTimeout(timeout);
+            setTimeout(() => {
+                redirectListener.stop();
+                if (error)
+                    reject(error);
+                else
+                    resolve({ code: code, state: state });
+            }, ServerStopDelaySeconds * 1000);
+        };
+        const redirectListener = new RedirectListener({ host, port, callback });
+        redirectListener.start();
+    });
+    return result;
+}
+//# sourceMappingURL=redirect-listener.js.map

package/dist/session/redirect-listener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect-listener.js","sourceRoot":"","sources":["../../src/session/redirect-listener.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAC,KAAK,EAAE,GAAG,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AACjD,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,MAAM,sBAAsB,GAAG,EAAE,CAAA;AACjC,MAAM,sBAAsB,GAAG,GAAG,CAAA;AAgBlC;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IA4D3B,YAAY,OAAgC;QAC1C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QACxB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QACxB,IAAI,CAAC,MAAM,GAAG,gBAAgB,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC/D,CAAC;IA/DO,MAAM,CAAC,YAAY,CAAC,QAA0B;QACpD,MAAM,MAAM,GAAG,OAAO,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YACzD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAA;YAC9B,IAAI,UAAU,KAAK,cAAc,EAAE;gBACjC,MAAM,WAAW,GAAG,MAAM,UAAU,EAAE,CAAA;gBACtC,KAAK,CAAC,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC/D,OAAO,EAAE,CAAA;aACV;iBAAM,IAAI,UAAU,KAAK,YAAY,EAAE;gBACtC,MAAM,cAAc,GAAG,MAAM,aAAa,EAAE,CAAA;gBAC5C,KAAK,CAAC,MAAM,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;gBAC7D,OAAO,EAAE,CAAA;aACV;YAED,MAAM,OAAO,GAAG,CAAC,QAAgB,EAAE,KAAa,EAAE,KAAc,EAAE,IAAa,EAAE,EAAE;gBACjF,KAAK,CAAC,MAAM,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;gBACxD,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;gBAC5B,OAAO,EAAE,CAAA;YACX,CAAC,CAAA;YAED,iDAAiD;YACjD,IAAI,CAAC,UAAU,EAAE;gBACf,MAAM,IAAI,GAAG,MAAM,eAAe,EAAE,CAAA;gBACpC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAA;gBACnC,OAAO,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAA;aAChD;YAED,mDAAmD;YACnD,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,KAAK,CAAA;YACrD,IAAI,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,iBAAiB,EAAE;gBACtD,MAAM,IAAI,GAAG,MAAM,gBAAgB,EAAE,CAAA;gBACrC,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,GAAG,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAA;gBACzD,OAAO,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAA;aAChD;YAED,wCAAwC;YACxC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;gBACrB,MAAM,IAAI,GAAG,MAAM,kBAAkB,EAAE,CAAA;gBACvC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAA;gBACtC,OAAO,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAA;aAChD;YAED,yCAAyC;YACzC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE;gBACtB,MAAM,IAAI,GAAG,MAAM,mBAAmB,EAAE,CAAA;gBACxC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,CAAA;gBACvC,OAAO,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAA;aAChD;YAED,MAAM,IAAI,GAAG,MAAM,cAAc,EAAE,CAAA;YACnC,OAAO,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,EAAE,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC,CAAA;QAChF,CAAC,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACf,CAAC;IAYD,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAC,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;IAClE,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IAC3B,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAAY,EAAE,IAAY,EAAE,GAAW;IAC1E,MAAM,MAAM,GAAG,MAAM,IAAI,OAAO,CAAgC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAClF,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC9B,MAAM,OAAO,GAAG,8CAA8C,CAAA;YAC9D,IAAI,CAAC,OAAO,CAAA,GAAG,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,4BAA4B,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;QAC7E,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC,CAAA;QAEjC,MAAM,QAAQ,GAAqB,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;YAC9D,YAAY,CAAC,OAAO,CAAC,CAAA;YACrB,UAAU,CAAC,GAAG,EAAE;gBACd,gBAAgB,CAAC,IAAI,EAAE,CAAA;gBACvB,IAAI,KAAK;oBAAE,MAAM,CAAC,KAAK,CAAC,CAAA;;oBACnB,OAAO,CAAC,EAAC,IAAI,EAAE,IAAc,EAAE,KAAK,EAAE,KAAe,EAAC,CAAC,CAAA;YAC9D,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC,CAAA;QACnC,CAAC,CAAA;QAED,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,EAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAC,CAAC,CAAA;QACrE,gBAAgB,CAAC,KAAK,EAAE,CAAA;IAC1B,CAAC,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC","sourcesContent":["import {\n  getFavicon,\n  getStylesheet,\n  getEmptyUrlHTML,\n  getAuthErrorHTML,\n  getMissingCodeHTML,\n  getMissingStateHTML,\n  getSuccessHTML,\n  EmptyUrlString,\n  MissingCodeString,\n  MissingStateString,\n} from './post-auth.js'\nimport {Abort, Bug} from '../error.js'\nimport {content, info, token} from '../output.js'\nimport Fastify from 'fastify'\nimport url from 'url'\n\nconst ResponseTimeoutSeconds = 10\nconst ServerStopDelaySeconds = 0.5\n\n/**\n * It represents the result of a redirect.\n */\ntype RedirectCallback = (error: Error | undefined, state: string | undefined, code: string | undefined) => void\n\n/**\n * Defines the interface of the options that\n * are used to instantiate a redirect listener.\n */\ninterface RedirectListenerOptions {\n  host: string\n  port: number\n  callback: RedirectCallback\n}\n/**\n * When the authentication completes, Identity redirects\n * the user to a URL. In the case of the CLI, the redirect\n * is to localhost passing some parameters that are necessary\n * to continue the authentication. Because of that, we need\n * an HTTP server that runs and listens to the request.\n */\nexport class RedirectListener {\n  private static createServer(callback: RedirectCallback) {\n    const server = Fastify().get('*', async (request, reply) => {\n      const requestUrl = request.url\n      if (requestUrl === '/favicon.svg') {\n        const faviconFile = await getFavicon()\n        reply.header('Content-Type', 'image/svg+xml').send(faviconFile)\n        return {}\n      } else if (requestUrl === '/style.css') {\n        const stylesheetFile = await getStylesheet()\n        reply.header('Content-Type', 'text/css').send(stylesheetFile)\n        return {}\n      }\n\n      const respond = (contents: string, error?: Error, state?: string, code?: string) => {\n        reply.header('Content-Type', 'text/html').send(contents)\n        callback(error, state, code)\n        return {}\n      }\n\n      // If there was an empty/malformed URL sent back.\n      if (!requestUrl) {\n        const file = await getEmptyUrlHTML()\n        const err = new Bug(EmptyUrlString)\n        return respond(file, err, undefined, undefined)\n      }\n\n      // If an error was returned by the Identity server.\n      const queryObject = url.parse(requestUrl, true).query\n      if (queryObject.error && queryObject.error_description) {\n        const file = await getAuthErrorHTML()\n        const err = new Abort(`${queryObject.error_description}`)\n        return respond(file, err, undefined, undefined)\n      }\n\n      // If the code isn't present in the URL.\n      if (!queryObject.code) {\n        const file = await getMissingCodeHTML()\n        const err = new Bug(MissingCodeString)\n        return respond(file, err, undefined, undefined)\n      }\n\n      // If the state isn't present in the URL.\n      if (!queryObject.state) {\n        const file = await getMissingStateHTML()\n        const err = new Bug(MissingStateString)\n        return respond(file, err, undefined, undefined)\n      }\n\n      const file = await getSuccessHTML()\n      return respond(file, undefined, `${queryObject.code}`, `${queryObject.state}`)\n    })\n\n    return server\n  }\n\n  port: number\n  host: string\n  server: ReturnType<typeof RedirectListener.createServer>\n\n  constructor(options: RedirectListenerOptions) {\n    this.port = options.port\n    this.host = options.host\n    this.server = RedirectListener.createServer(options.callback)\n  }\n\n  start(): void {\n    this.server.listen({port: this.port, host: this.host}, () => {})\n  }\n\n  async stop(): Promise<void> {\n    await this.server.close()\n  }\n}\n\nexport async function listenRedirect(host: string, port: number, url: string): Promise<{code: string; state: string}> {\n  const result = await new Promise<{code: string; state: string}>((resolve, reject) => {\n    const timeout = setTimeout(() => {\n      const message = '\\nAuto-open timed out. Open the login page: '\n      info(content`${message}${token.link('Log in to Shopify Partners', url)}\\n`)\n    }, ResponseTimeoutSeconds * 1000)\n\n    const callback: RedirectCallback = async (error, code, state) => {\n      clearTimeout(timeout)\n      setTimeout(() => {\n        redirectListener.stop()\n        if (error) reject(error)\n        else resolve({code: code as string, state: state as string})\n      }, ServerStopDelaySeconds * 1000)\n    }\n\n    const redirectListener = new RedirectListener({host, port, callback})\n    redirectListener.start()\n  })\n  return result\n}\n"]}

package/dist/session/schema.d.ts

@@ -0,0 +1,174 @@
+import { define } from '../schema.js';
+/**
+ * The schema represents an Identity token.
+ */
+declare const IdentityTokenSchema: define.ZodObject<{
+    accessToken: define.ZodString;
+    refreshToken: define.ZodString;
+    expiresAt: define.ZodEffects<define.ZodDate, Date, Date>;
+    scopes: define.ZodArray<define.ZodString, "many">;
+}, "strip", define.ZodTypeAny, {
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: Date;
+    scopes: string[];
+}, {
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: Date;
+    scopes: string[];
+}>;
+/**
+ * The schema represents an application token.
+ */
+declare const ApplicationTokenSchema: define.ZodObject<{
+    accessToken: define.ZodString;
+    expiresAt: define.ZodEffects<define.ZodDate, Date, Date>;
+    scopes: define.ZodArray<define.ZodString, "many">;
+}, "strip", define.ZodTypeAny, {
+    accessToken: string;
+    expiresAt: Date;
+    scopes: string[];
+}, {
+    accessToken: string;
+    expiresAt: Date;
+    scopes: string[];
+}>;
+/**
+ * This schema represents the format of the session
+ * that we cache in the system to avoid unnecessary
+ * token exchanges.
+ *
+ * @example
+ * {
+ *    "accounts.shopify.com": {
+ *      "identity": {...} // IdentityTokenSchema
+ *      "applications": {
+ *        "${domain}-application-id": {  // Admin APIs includes domain in the key
+ *          "accessToken": "...",
+ *        },
+ *        "$application-id": { // ApplicationTokenSchema
+ *          "accessToken": "...",
+ *        },
+ *      }
+ *    },
+ *    "identity.spin.com": {...}
+ *}
+ *
+ */
+export declare const SessionSchema: define.ZodObject<{}, "strip", define.ZodObject<{
+    /**
+     * It contains the identity token. Before usint it, we exchange it
+     * to get a token that we can use with different applications. The exchanged
+     * tokens for the applications are stored under applications.
+     */
+    identity: define.ZodObject<{
+        accessToken: define.ZodString;
+        refreshToken: define.ZodString;
+        expiresAt: define.ZodEffects<define.ZodDate, Date, Date>;
+        scopes: define.ZodArray<define.ZodString, "many">;
+    }, "strip", define.ZodTypeAny, {
+        accessToken: string;
+        refreshToken: string;
+        expiresAt: Date;
+        scopes: string[];
+    }, {
+        accessToken: string;
+        refreshToken: string;
+        expiresAt: Date;
+        scopes: string[];
+    }>;
+    /**
+     * It contains exchanged tokens for the applications the CLI
+     * authenticates with. Tokens are scoped under the fqdn of the applications.
+     */
+    applications: define.ZodObject<{}, "strip", define.ZodObject<{
+        accessToken: define.ZodString;
+        expiresAt: define.ZodEffects<define.ZodDate, Date, Date>;
+        scopes: define.ZodArray<define.ZodString, "many">;
+    }, "strip", define.ZodTypeAny, {
+        accessToken: string;
+        expiresAt: Date;
+        scopes: string[];
+    }, {
+        accessToken: string;
+        expiresAt: Date;
+        scopes: string[];
+    }>, {
+        [x: string]: {
+            accessToken: string;
+            expiresAt: Date;
+            scopes: string[];
+        };
+    }, {
+        [x: string]: {
+            accessToken: string;
+            expiresAt: Date;
+            scopes: string[];
+        };
+    }>;
+}, "strip", define.ZodTypeAny, {
+    identity: {
+        accessToken: string;
+        refreshToken: string;
+        expiresAt: Date;
+        scopes: string[];
+    };
+    applications: {
+        [x: string]: {
+            accessToken: string;
+            expiresAt: Date;
+            scopes: string[];
+        };
+    };
+}, {
+    identity: {
+        accessToken: string;
+        refreshToken: string;
+        expiresAt: Date;
+        scopes: string[];
+    };
+    applications: {
+        [x: string]: {
+            accessToken: string;
+            expiresAt: Date;
+            scopes: string[];
+        };
+    };
+}>, {
+    [x: string]: {
+        identity: {
+            accessToken: string;
+            refreshToken: string;
+            expiresAt: Date;
+            scopes: string[];
+        };
+        applications: {
+            [x: string]: {
+                accessToken: string;
+                expiresAt: Date;
+                scopes: string[];
+            };
+        };
+    };
+}, {
+    [x: string]: {
+        identity: {
+            accessToken: string;
+            refreshToken: string;
+            expiresAt: Date;
+            scopes: string[];
+        };
+        applications: {
+            [x: string]: {
+                accessToken: string;
+                expiresAt: Date;
+                scopes: string[];
+            };
+        };
+    };
+}>;
+export declare type Session = define.infer<typeof SessionSchema>;
+export declare type IdentityToken = define.infer<typeof IdentityTokenSchema>;
+export declare type ApplicationToken = define.infer<typeof ApplicationTokenSchema>;
+export {};

package/dist/session/schema.js

@@ -0,0 +1,59 @@
+import { define } from '../schema.js';
+const DateSchema = define.preprocess((arg) => {
+    if (typeof arg === 'string' || arg instanceof Date)
+        return new Date(arg);
+    return null;
+}, define.date());
+/**
+ * The schema represents an Identity token.
+ */
+const IdentityTokenSchema = define.object({
+    accessToken: define.string(),
+    refreshToken: define.string(),
+    expiresAt: DateSchema,
+    scopes: define.array(define.string()),
+});
+/**
+ * The schema represents an application token.
+ */
+const ApplicationTokenSchema = define.object({
+    accessToken: define.string(),
+    expiresAt: DateSchema,
+    scopes: define.array(define.string()),
+});
+/**
+ * This schema represents the format of the session
+ * that we cache in the system to avoid unnecessary
+ * token exchanges.
+ *
+ * @example
+ * {
+ *    "accounts.shopify.com": {
+ *      "identity": {...} // IdentityTokenSchema
+ *      "applications": {
+ *        "${domain}-application-id": {  // Admin APIs includes domain in the key
+ *          "accessToken": "...",
+ *        },
+ *        "$application-id": { // ApplicationTokenSchema
+ *          "accessToken": "...",
+ *        },
+ *      }
+ *    },
+ *    "identity.spin.com": {...}
+ *}
+ *
+ */
+export const SessionSchema = define.object({}).catchall(define.object({
+    /**
+     * It contains the identity token. Before usint it, we exchange it
+     * to get a token that we can use with different applications. The exchanged
+     * tokens for the applications are stored under applications.
+     */
+    identity: IdentityTokenSchema,
+    /**
+     * It contains exchanged tokens for the applications the CLI
+     * authenticates with. Tokens are scoped under the fqdn of the applications.
+     */
+    applications: define.object({}).catchall(ApplicationTokenSchema),
+}));
+//# sourceMappingURL=schema.js.map

package/dist/session/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/session/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,cAAc,CAAA;AAEnC,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,EAAE,EAAE;IAC3C,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,YAAY,IAAI;QAAE,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,CAAA;IACxE,OAAO,IAAI,CAAA;AACb,CAAC,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAA;AAEjB;;GAEG;AACH,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE;IAC5B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE;IAC7B,SAAS,EAAE,UAAU;IACrB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;CACtC,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE;IAC5B,SAAS,EAAE,UAAU;IACrB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;CACtC,CAAC,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CACrD,MAAM,CAAC,MAAM,CAAC;IACZ;;;;OAIG;IACH,QAAQ,EAAE,mBAAmB;IAC7B;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC;CACjE,CAAC,CACH,CAAA","sourcesContent":["import {define} from '../schema.js'\n\nconst DateSchema = define.preprocess((arg) => {\n  if (typeof arg === 'string' || arg instanceof Date) return new Date(arg)\n  return null\n}, define.date())\n\n/**\n * The schema represents an Identity token.\n */\nconst IdentityTokenSchema = define.object({\n  accessToken: define.string(),\n  refreshToken: define.string(),\n  expiresAt: DateSchema,\n  scopes: define.array(define.string()),\n})\n\n/**\n * The schema represents an application token.\n */\nconst ApplicationTokenSchema = define.object({\n  accessToken: define.string(),\n  expiresAt: DateSchema,\n  scopes: define.array(define.string()),\n})\n\n/**\n * This schema represents the format of the session\n * that we cache in the system to avoid unnecessary\n * token exchanges.\n *\n * @example\n * {\n *    \"accounts.shopify.com\": {\n *      \"identity\": {...} // IdentityTokenSchema\n *      \"applications\": {\n *        \"${domain}-application-id\": {  // Admin APIs includes domain in the key\n *          \"accessToken\": \"...\",\n *        },\n *        \"$application-id\": { // ApplicationTokenSchema\n *          \"accessToken\": \"...\",\n *        },\n *      }\n *    },\n *    \"identity.spin.com\": {...}\n *}\n *\n */\nexport const SessionSchema = define.object({}).catchall(\n  define.object({\n    /**\n     * It contains the identity token. Before usint it, we exchange it\n     * to get a token that we can use with different applications. The exchanged\n     * tokens for the applications are stored under applications.\n     */\n    identity: IdentityTokenSchema,\n    /**\n     * It contains exchanged tokens for the applications the CLI\n     * authenticates with. Tokens are scoped under the fqdn of the applications.\n     */\n    applications: define.object({}).catchall(ApplicationTokenSchema),\n  }),\n)\n\nexport type Session = define.infer<typeof SessionSchema>\nexport type IdentityToken = define.infer<typeof IdentityTokenSchema>\nexport type ApplicationToken = define.infer<typeof ApplicationTokenSchema>\n"]}

package/dist/session/scopes.d.ts

@@ -0,0 +1,16 @@
+import { API } from '../network/api.js';
+/**
+ * Generate a flat array with all the default scopes for all the APIs plus
+ * any custom scope defined by the user.
+ * @param extraScopes custom user-defined scopes
+ * @returns Array of scopes
+ */
+export declare function allDefaultScopes(extraScopes?: string[]): string[];
+/**
+ * Generate a flat array with the default scopes for the given API plus
+ * any custom scope defined by the user
+ * @param api API to get the scopes for
+ * @param extraScopes custom user-defined scopes
+ * @returns Array of scopes
+ */
+export declare function apiScopes(api: API, extraScopes?: string[]): string[];

package/dist/session/scopes.js

@@ -0,0 +1,53 @@
+import { Bug } from '../error.js';
+import { allAPIs } from '../network/api.js';
+/**
+ * Generate a flat array with all the default scopes for all the APIs plus
+ * any custom scope defined by the user.
+ * @param extraScopes custom user-defined scopes
+ * @returns Array of scopes
+ */
+export function allDefaultScopes(extraScopes = []) {
+    let scopes = allAPIs.map(defaultApiScopes).flat();
+    scopes = ['openid', ...scopes, ...extraScopes].map(scopeTransform);
+    return Array.from(new Set(scopes));
+}
+/**
+ * Generate a flat array with the default scopes for the given API plus
+ * any custom scope defined by the user
+ * @param api API to get the scopes for
+ * @param extraScopes custom user-defined scopes
+ * @returns Array of scopes
+ */
+export function apiScopes(api, extraScopes = []) {
+    const scopes = ['openid', ...defaultApiScopes(api), ...extraScopes.map(scopeTransform)].map(scopeTransform);
+    return Array.from(new Set(scopes));
+}
+function defaultApiScopes(api) {
+    switch (api) {
+        case 'admin':
+            return ['graphql', 'themes', 'collaborator'];
+        case 'storefront-renderer':
+            return ['devtools'];
+        case 'partners':
+            return ['cli'];
+        default:
+            throw new Bug(`Unknown API: ${api}`);
+    }
+}
+function scopeTransform(scope) {
+    switch (scope) {
+        case 'graphql':
+            return 'https://api.shopify.com/auth/shop.admin.graphql';
+        case 'themes':
+            return 'https://api.shopify.com/auth/shop.admin.themes';
+        case 'collaborator':
+            return 'https://api.shopify.com/auth/partners.collaborator-relationships.readonly';
+        case 'cli':
+            return 'https://api.shopify.com/auth/partners.app.cli.access';
+        case 'devtools':
+            return 'https://api.shopify.com/auth/shop.storefront-renderer.devtools';
+        default:
+            return scope;
+    }
+}
+//# sourceMappingURL=scopes.js.map

package/dist/session/scopes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopes.js","sourceRoot":"","sources":["../../src/session/scopes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAC,MAAM,aAAa,CAAA;AAC/B,OAAO,EAAC,OAAO,EAAM,MAAM,mBAAmB,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,cAAwB,EAAE;IACzD,IAAI,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE,CAAA;IACjD,MAAM,GAAG,CAAC,QAAQ,EAAE,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;IAClE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;AACpC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,GAAQ,EAAE,cAAwB,EAAE;IAC5D,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,GAAG,gBAAgB,CAAC,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;IAC3G,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;AACpC,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAQ;IAChC,QAAQ,GAAG,EAAE;QACX,KAAK,OAAO;YACV,OAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAA;QAC9C,KAAK,qBAAqB;YACxB,OAAO,CAAC,UAAU,CAAC,CAAA;QACrB,KAAK,UAAU;YACb,OAAO,CAAC,KAAK,CAAC,CAAA;QAChB;YACE,MAAM,IAAI,GAAG,CAAC,gBAAgB,GAAG,EAAE,CAAC,CAAA;KACvC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,KAAa;IACnC,QAAQ,KAAK,EAAE;QACb,KAAK,SAAS;YACZ,OAAO,iDAAiD,CAAA;QAC1D,KAAK,QAAQ;YACX,OAAO,gDAAgD,CAAA;QACzD,KAAK,cAAc;YACjB,OAAO,2EAA2E,CAAA;QACpF,KAAK,KAAK;YACR,OAAO,sDAAsD,CAAA;QAC/D,KAAK,UAAU;YACb,OAAO,gEAAgE,CAAA;QACzE;YACE,OAAO,KAAK,CAAA;KACf;AACH,CAAC","sourcesContent":["import {Bug} from '../error.js'\nimport {allAPIs, API} from '../network/api.js'\n\n/**\n * Generate a flat array with all the default scopes for all the APIs plus\n * any custom scope defined by the user.\n * @param extraScopes custom user-defined scopes\n * @returns Array of scopes\n */\nexport function allDefaultScopes(extraScopes: string[] = []): string[] {\n  let scopes = allAPIs.map(defaultApiScopes).flat()\n  scopes = ['openid', ...scopes, ...extraScopes].map(scopeTransform)\n  return Array.from(new Set(scopes))\n}\n\n/**\n * Generate a flat array with the default scopes for the given API plus\n * any custom scope defined by the user\n * @param api API to get the scopes for\n * @param extraScopes custom user-defined scopes\n * @returns Array of scopes\n */\nexport function apiScopes(api: API, extraScopes: string[] = []): string[] {\n  const scopes = ['openid', ...defaultApiScopes(api), ...extraScopes.map(scopeTransform)].map(scopeTransform)\n  return Array.from(new Set(scopes))\n}\n\nfunction defaultApiScopes(api: API): string[] {\n  switch (api) {\n    case 'admin':\n      return ['graphql', 'themes', 'collaborator']\n    case 'storefront-renderer':\n      return ['devtools']\n    case 'partners':\n      return ['cli']\n    default:\n      throw new Bug(`Unknown API: ${api}`)\n  }\n}\n\nfunction scopeTransform(scope: string): string {\n  switch (scope) {\n    case 'graphql':\n      return 'https://api.shopify.com/auth/shop.admin.graphql'\n    case 'themes':\n      return 'https://api.shopify.com/auth/shop.admin.themes'\n    case 'collaborator':\n      return 'https://api.shopify.com/auth/partners.collaborator-relationships.readonly'\n    case 'cli':\n      return 'https://api.shopify.com/auth/partners.app.cli.access'\n    case 'devtools':\n      return 'https://api.shopify.com/auth/shop.storefront-renderer.devtools'\n    default:\n      return scope\n  }\n}\n"]}

package/dist/session/store.d.ts

@@ -0,0 +1,24 @@
+import type { Session } from './schema.js';
+/**
+ * The identifier of the session in the secure store.
+ */
+export declare const identifier = "session";
+/**
+ * Serializes the session as a JSON and stores it securely in the system.
+ * If the secure store is not available, the session is stored in the local config.
+ * @param session {Session} the session to store.
+ */
+export declare function store(session: Session): Promise<void>;
+/**
+ * Fetches the session from the secure store and returns it.
+ * If the secure store is not available, the session is fetched from the local config.
+ * If the format of the session is invalid, the method will discard it.
+ * In the future might add some logic for supporting migrating the schema
+ * of already-persisted sessions.
+ * @returns {Promise<Session\undefined>} Returns a promise that resolves with the session if it exists and is valid.
+ */
+export declare function fetch(): Promise<Session | undefined>;
+/**
+ * Removes a session from the system.
+ */
+export declare function remove(): Promise<void>;

package/dist/session/store.js

@@ -0,0 +1,88 @@
+import { SessionSchema } from './schema.js';
+import constants from '../constants.js';
+import { platformAndArch } from '../os.js';
+import { store as secureStore, fetch as secureFetch, remove as secureRemove } from '../secure-store.js';
+import { cliKitStore } from '../store.js';
+import { content, debug } from '../output.js';
+/**
+ * The identifier of the session in the secure store.
+ */
+export const identifier = 'session';
+/**
+ * Serializes the session as a JSON and stores it securely in the system.
+ * If the secure store is not available, the session is stored in the local config.
+ * @param session {Session} the session to store.
+ */
+export async function store(session) {
+    const jsonSession = JSON.stringify(session);
+    if (await secureStoreAvailable()) {
+        await secureStore(identifier, jsonSession);
+    }
+    else {
+        await cliKitStore().setSession(jsonSession);
+    }
+}
+/**
+ * Fetches the session from the secure store and returns it.
+ * If the secure store is not available, the session is fetched from the local config.
+ * If the format of the session is invalid, the method will discard it.
+ * In the future might add some logic for supporting migrating the schema
+ * of already-persisted sessions.
+ * @returns {Promise<Session\undefined>} Returns a promise that resolves with the session if it exists and is valid.
+ */
+export async function fetch() {
+    let content;
+    if (await secureStoreAvailable()) {
+        content = await secureFetch(identifier);
+    }
+    else {
+        content = cliKitStore().getSession();
+    }
+    if (!content) {
+        return undefined;
+    }
+    const contentJson = JSON.parse(content);
+    const parsedSession = await SessionSchema.safeParseAsync(contentJson);
+    if (parsedSession.success) {
+        return parsedSession.data;
+    }
+    else {
+        await remove();
+        return undefined;
+    }
+}
+/**
+ * Removes a session from the system.
+ */
+export async function remove() {
+    if (await secureStoreAvailable()) {
+        await secureRemove(identifier);
+    }
+    else {
+        cliKitStore().removeSession();
+    }
+}
+/**
+ * Returns true if the secure store is available on the system.
+ * Keytar it's not supported on some Linux environments or Windows.
+ * More details: https://github.com/Shopify/shopify-cli-planning/issues/261
+ * @returns a boolean indicating if the secure store is available.
+ */
+async function secureStoreAvailable() {
+    try {
+        if (platformAndArch().platform === 'windows') {
+            debug(content `Secure store not supported on Windows`);
+            return false;
+        }
+        const keytar = await import('keytar');
+        await keytar.default.findCredentials(constants.keychain.service);
+        debug(content `Secure store is available`);
+        return true;
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch (_error) {
+        debug(content `Failed to load secure store`);
+        return false;
+    }
+}
+//# sourceMappingURL=store.js.map

package/dist/session/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../../src/session/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAA;AACzC,OAAO,SAAS,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAC,eAAe,EAAC,MAAM,UAAU,CAAA;AACxC,OAAO,EAAC,KAAK,IAAI,WAAW,EAAE,KAAK,IAAI,WAAW,EAAE,MAAM,IAAI,YAAY,EAAC,MAAM,oBAAoB,CAAA;AACrG,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAA;AACvC,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AAG3C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,SAAS,CAAA;AAEnC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAAgB;IAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;IAC3C,IAAI,MAAM,oBAAoB,EAAE,EAAE;QAChC,MAAM,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;KAC3C;SAAM;QACL,MAAM,WAAW,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;KAC5C;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK;IACzB,IAAI,OAAO,CAAA;IACX,IAAI,MAAM,oBAAoB,EAAE,EAAE;QAChC,OAAO,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC,CAAA;KACxC;SAAM;QACL,OAAO,GAAG,WAAW,EAAE,CAAC,UAAU,EAAE,CAAA;KACrC;IAED,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,SAAS,CAAA;KACjB;IACD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IACvC,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,WAAW,CAAC,CAAA;IACrE,IAAI,aAAa,CAAC,OAAO,EAAE;QACzB,OAAO,aAAa,CAAC,IAAI,CAAA;KAC1B;SAAM;QACL,MAAM,MAAM,EAAE,CAAA;QACd,OAAO,SAAS,CAAA;KACjB;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,IAAI,MAAM,oBAAoB,EAAE,EAAE;QAChC,MAAM,YAAY,CAAC,UAAU,CAAC,CAAA;KAC/B;SAAM;QACL,WAAW,EAAE,CAAC,aAAa,EAAE,CAAA;KAC9B;AACH,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,oBAAoB;IACjC,IAAI;QACF,IAAI,eAAe,EAAE,CAAC,QAAQ,KAAK,SAAS,EAAE;YAC5C,KAAK,CAAC,OAAO,CAAA,uCAAuC,CAAC,CAAA;YACrD,OAAO,KAAK,CAAA;SACb;QACD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QAChE,KAAK,CAAC,OAAO,CAAA,2BAA2B,CAAC,CAAA;QACzC,OAAO,IAAI,CAAA;QACX,qDAAqD;KACtD;IAAC,OAAO,MAAM,EAAE;QACf,KAAK,CAAC,OAAO,CAAA,6BAA6B,CAAC,CAAA;QAC3C,OAAO,KAAK,CAAA;KACb;AACH,CAAC","sourcesContent":["import {SessionSchema} from './schema.js'\nimport constants from '../constants.js'\nimport {platformAndArch} from '../os.js'\nimport {store as secureStore, fetch as secureFetch, remove as secureRemove} from '../secure-store.js'\nimport {cliKitStore} from '../store.js'\nimport {content, debug} from '../output.js'\nimport type {Session} from './schema.js'\n\n/**\n * The identifier of the session in the secure store.\n */\nexport const identifier = 'session'\n\n/**\n * Serializes the session as a JSON and stores it securely in the system.\n * If the secure store is not available, the session is stored in the local config.\n * @param session {Session} the session to store.\n */\nexport async function store(session: Session) {\n  const jsonSession = JSON.stringify(session)\n  if (await secureStoreAvailable()) {\n    await secureStore(identifier, jsonSession)\n  } else {\n    await cliKitStore().setSession(jsonSession)\n  }\n}\n\n/**\n * Fetches the session from the secure store and returns it.\n * If the secure store is not available, the session is fetched from the local config.\n * If the format of the session is invalid, the method will discard it.\n * In the future might add some logic for supporting migrating the schema\n * of already-persisted sessions.\n * @returns {Promise<Session\\undefined>} Returns a promise that resolves with the session if it exists and is valid.\n */\nexport async function fetch(): Promise<Session | undefined> {\n  let content\n  if (await secureStoreAvailable()) {\n    content = await secureFetch(identifier)\n  } else {\n    content = cliKitStore().getSession()\n  }\n\n  if (!content) {\n    return undefined\n  }\n  const contentJson = JSON.parse(content)\n  const parsedSession = await SessionSchema.safeParseAsync(contentJson)\n  if (parsedSession.success) {\n    return parsedSession.data\n  } else {\n    await remove()\n    return undefined\n  }\n}\n\n/**\n * Removes a session from the system.\n */\nexport async function remove() {\n  if (await secureStoreAvailable()) {\n    await secureRemove(identifier)\n  } else {\n    cliKitStore().removeSession()\n  }\n}\n\n/**\n * Returns true if the secure store is available on the system.\n * Keytar it's not supported on some Linux environments or Windows.\n * More details: https://github.com/Shopify/shopify-cli-planning/issues/261\n * @returns a boolean indicating if the secure store is available.\n */\nasync function secureStoreAvailable(): Promise<boolean> {\n  try {\n    if (platformAndArch().platform === 'windows') {\n      debug(content`Secure store not supported on Windows`)\n      return false\n    }\n    const keytar = await import('keytar')\n    await keytar.default.findCredentials(constants.keychain.service)\n    debug(content`Secure store is available`)\n    return true\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (_error) {\n    debug(content`Failed to load secure store`)\n    return false\n  }\n}\n"]}

package/dist/session/token.d.ts

@@ -0,0 +1,40 @@
+/**
+ * It represents a temporary token that can be
+ * used to send authenticated HTTP requests.
+ */
+declare class Token {
+    /**
+     * A fully-qualified domain name of the service
+     * this token is for.
+     */
+    fqdn: string;
+    /**
+     * Access token
+     */
+    accessToken: string;
+    /**
+     * Token to refresh the access token if it has expired.
+     */
+    refreshToken?: string;
+    /**
+     * The expiration date of the session
+     */
+    expiresAt: Date;
+    /**
+     * The list of scopes the token has access to.
+     */
+    scopes: string[];
+    constructor(options: {
+        fqdn: string;
+        accessToken: string;
+        refreshToken?: string;
+        expiresAt: Date;
+        scopes: string[];
+    });
+    /**
+     * Returns true if the session is expired.
+     * @returns {boolean} True if the session is expired.
+     */
+    get isExpired(): boolean;
+}
+export default Token;

package/dist/session/token.js

@@ -0,0 +1,22 @@
+/**
+ * It represents a temporary token that can be
+ * used to send authenticated HTTP requests.
+ */
+class Token {
+    constructor(options) {
+        this.fqdn = options.fqdn;
+        this.accessToken = options.accessToken;
+        this.refreshToken = options.refreshToken;
+        this.expiresAt = options.expiresAt;
+        this.scopes = options.scopes;
+    }
+    /**
+     * Returns true if the session is expired.
+     * @returns {boolean} True if the session is expired.
+     */
+    get isExpired() {
+        return new Date() > this.expiresAt;
+    }
+}
+export default Token;
+//# sourceMappingURL=token.js.map

package/dist/session/token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.js","sourceRoot":"","sources":["../../src/session/token.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,KAAK;IA2BT,YAAY,OAAsG;QAChH,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QACxB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;QACtC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAA;QACxC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,IAAI,EAAE,GAAG,IAAI,CAAC,SAAS,CAAA;IACpC,CAAC;CACF;AAED,eAAe,KAAK,CAAA","sourcesContent":["/**\n * It represents a temporary token that can be\n * used to send authenticated HTTP requests.\n */\nclass Token {\n  /**\n   * A fully-qualified domain name of the service\n   * this token is for.\n   */\n  fqdn: string\n\n  /**\n   * Access token\n   */\n  accessToken: string\n\n  /**\n   * Token to refresh the access token if it has expired.\n   */\n  refreshToken?: string\n\n  /**\n   * The expiration date of the session\n   */\n  expiresAt: Date\n\n  /**\n   * The list of scopes the token has access to.\n   */\n  scopes: string[]\n\n  constructor(options: {fqdn: string; accessToken: string; refreshToken?: string; expiresAt: Date; scopes: string[]}) {\n    this.fqdn = options.fqdn\n    this.accessToken = options.accessToken\n    this.refreshToken = options.refreshToken\n    this.expiresAt = options.expiresAt\n    this.scopes = options.scopes\n  }\n\n  /**\n   * Returns true if the session is expired.\n   * @returns {boolean} True if the session is expired.\n   */\n  get isExpired(): boolean {\n    return new Date() > this.expiresAt\n  }\n}\n\nexport default Token\n"]}