@shopify/cli-kit 0.0.0-nightly-20230110194301

package/dist/public/node/ui.js

@@ -0,0 +1,203 @@
+import ConcurrentOutput from '../../private/node/ui/components/ConcurrentOutput.js';
+import { consoleError } from '../../output.js';
+import { render, renderOnce } from '../../private/node/ui.js';
+import { alert } from '../../private/node/ui/alert.js';
+import { FatalError } from '../../private/node/ui/components/FatalError.js';
+import { SelectPrompt } from '../../private/node/ui/components/SelectPrompt.js';
+import { Tasks } from '../../private/node/ui/components/Tasks.js';
+import { TextPrompt } from '../../private/node/ui/components/TextPrompt.js';
+import React from 'react';
+import { AbortController } from '@shopify/cli-kit/node/abort';
+/**
+ * Renders output from concurrent processes to the terminal with {@link ConcurrentOutput}.
+ */
+export async function renderConcurrent({ processes, abortController, showTimestamps = true, renderOptions = {}, }) {
+    return render(React.createElement(ConcurrentOutput, { processes: processes, abortController: abortController ?? new AbortController(), showTimestamps: showTimestamps }), renderOptions);
+}
+/**
+ * Renders an information banner to the console.
+ *
+ * Basic:
+ *
+ * ```
+ * ╭─ info ───────────────────────────────────────────────────╮
+ * │                                                          │
+ * │  Body                                                    │
+ * │                                                          │
+ * ╰──────────────────────────────────────────────────────────╯
+ * ```
+ *
+ * Complete:
+ * ```
+ * ╭─ info ───────────────────────────────────────────────────╮
+ * │                                                          │
+ * │  Title                                                   │
+ * │                                                          │
+ * │  Body                                                    │
+ * │                                                          │
+ * │  Next steps                                              │
+ * │    • Run `cd santorini-goods`                            │
+ * │    • To preview your project, run `npm app dev`          │
+ * │    • To add extensions, run `npm generate extension`     │
+ * │                                                          │
+ * │  Reference                                               │
+ * │    • Run `npm shopify help`                              │
+ * │    • Press 'return' to open the dev docs:                │
+ * │      https://shopify.dev                                 │
+ * │                                                          │
+ * │  Link: https://shopify.com                               │
+ * │                                                          │
+ * ╰──────────────────────────────────────────────────────────╯
+ * ```
+ */
+export function renderInfo(options) {
+    return alert({ ...options, type: 'info' });
+}
+/**
+ * Renders a success banner to the console.
+ *
+ * Basic:
+ *
+ * ```
+ * ╭─ success ────────────────────────────────────────────────╮
+ * │                                                          │
+ * │  Title                                                   │
+ * │                                                          │
+ * ╰──────────────────────────────────────────────────────────╯
+ * ```
+ *
+ * Complete:
+ * ```
+ * ╭─ success ────────────────────────────────────────────────╮
+ * │                                                          │
+ * │  Title                                                   │
+ * │                                                          │
+ * │  Body                                                    │
+ * │                                                          │
+ * │  Next steps                                              │
+ * │    • Run `cd santorini-goods`                              │
+ * │    • To preview your project, run `npm app dev`            │
+ * │    • To add extensions, run `npm generate extension`       │
+ * │                                                          │
+ * │  Reference                                               │
+ * │    • Run `npm shopify help`                                │
+ * │    • Press 'return' to open the dev docs:                │
+ * │      https://shopify.dev                                 │
+ * │                                                          │
+ * │  Link: https://shopify.com                               │
+ * │                                                          │
+ * ╰──────────────────────────────────────────────────────────╯
+ * ```
+ */
+export function renderSuccess(options) {
+    return alert({ ...options, type: 'success' });
+}
+/**
+ * Renders a warning banner to the console.
+ *
+ * Basic:
+ *
+ * ```
+ * ╭─ warning ────────────────────────────────────────────────╮
+ * │                                                          │
+ * │  Title                                                   │
+ * │                                                          │
+ * ╰──────────────────────────────────────────────────────────╯
+ * ```
+ *
+ * Complete:
+ * ```
+ * ╭─ warning ────────────────────────────────────────────────╮
+ * │                                                          │
+ * │  Title                                                   │
+ * │                                                          │
+ * │  Body                                                    │
+ * │                                                          │
+ * │  Next steps                                              │
+ * │    • Run `cd santorini-goods`                            │
+ * │    • To preview your project, run `npm app dev`          │
+ * │    • To add extensions, run `npm generate extension`     │
+ * │                                                          │
+ * │  Reference                                               │
+ * │    • Run `npm shopify help`                              │
+ * │    • Press 'return' to open the dev docs:                │
+ * │      https://shopify.dev                                 │
+ * │                                                          │
+ * │  Link: https://shopify.com                               │
+ * │                                                          │
+ * ╰──────────────────────────────────────────────────────────╯
+ * ```
+ */
+export function renderWarning(options) {
+    return alert({ ...options, type: 'warning' });
+}
+/**
+ * Renders a Fatal error to the console inside a banner.
+ *
+ * ```
+ * ╭─ error ──────────────────────────────────────────────────╮
+ * │                                                          │
+ * │  Couldn't connect to the Shopify Partner Dashboard.      │
+ * │                                                          │
+ * │  Check your internet connection and try again.           │
+ * │                                                          │
+ * ╰──────────────────────────────────────────────────────────╯
+ * ```
+ */
+export function renderFatalError(error) {
+    return renderOnce(React.createElement(FatalError, { error: error }), 'error', consoleError);
+}
+/**
+ * Renders a select prompt to the console.
+ *
+ * ?  Associate your project with the org Castile Ventures?
+ *
+ *      Add:     • new-ext
+ *
+ *      Remove:  • integrated-demand-ext
+ *               • order-discount
+
+ * \>  (f) first
+ *     (s) second
+ *     (3) third
+ *     (4) fourth
+ *     (5) seventh
+ *     (6) tenth
+
+ *     Automations
+ *     (7) fifth
+ *     (8) sixth
+
+ *     Merchant Admin
+ *     (9) eighth
+ *     (10) ninth
+
+ *     navigate with arrows, enter to select
+ */
+export function renderSelectPrompt(props) {
+    return new Promise((resolve, reject) => {
+        render(React.createElement(SelectPrompt, { ...props, onSubmit: (value) => resolve(value) }), {
+            exitOnCtrlC: false,
+        }).catch(reject);
+    });
+}
+/**
+ * Runs async tasks and displays their progress to the console.
+ */
+export function renderTasks(tasks) {
+    return render(React.createElement(Tasks, { tasks: tasks }));
+}
+/**
+ * Renders a text prompt to the console.
+ *
+ * ?  What is your name?
+ * \>  John
+ */
+export function renderTextPrompt(props) {
+    return new Promise((resolve, reject) => {
+        render(React.createElement(TextPrompt, { ...props, onSubmit: (value) => resolve(value) }), {
+            exitOnCtrlC: false,
+        }).catch(reject);
+    });
+}
+//# sourceMappingURL=ui.js.map

package/dist/public/node/ui.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.js","sourceRoot":"","sources":["../../../src/public/node/ui.tsx"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,sDAAsD,CAAA;AACnF,OAAO,EAAC,YAAY,EAAgB,MAAM,iBAAiB,CAAA;AAC3D,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,0BAA0B,CAAA;AAE3D,OAAO,EAAC,KAAK,EAAC,MAAM,gCAAgC,CAAA;AAEpD,OAAO,EAAC,UAAU,EAAC,MAAM,gDAAgD,CAAA;AACzE,OAAO,EAAC,YAAY,EAA6B,MAAM,kDAAkD,CAAA;AACzG,OAAO,EAAC,KAAK,EAAO,MAAM,2CAA2C,CAAA;AACrE,OAAO,EAAC,UAAU,EAA2B,MAAM,gDAAgD,CAAA;AACnG,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAA;AAS3D;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,EACrC,SAAS,EACT,eAAe,EACf,cAAc,GAAG,IAAI,EACrB,aAAa,GAAG,EAAE,GACM;IACxB,OAAO,MAAM,CACX,oBAAC,gBAAgB,IACf,SAAS,EAAE,SAAS,EACpB,eAAe,EAAE,eAAe,IAAI,IAAI,eAAe,EAAE,EACzD,cAAc,EAAE,cAAc,GAC9B,EACF,aAAa,CACd,CAAA;AACH,CAAC;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,UAAU,UAAU,CAAC,OAA2B;IACpD,OAAO,KAAK,CAAC,EAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAC,CAAC,CAAA;AAC1C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,UAAU,aAAa,CAAC,OAA2B;IACvD,OAAO,KAAK,CAAC,EAAC,GAAG,OAAO,EAAE,IAAI,EAAE,SAAS,EAAC,CAAC,CAAA;AAC7C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,UAAU,aAAa,CAAC,OAA2B;IACvD,OAAO,KAAK,CAAC,EAAC,GAAG,OAAO,EAAE,IAAI,EAAE,SAAS,EAAC,CAAC,CAAA;AAC7C,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAY;IAC3C,OAAO,UAAU,CAAC,oBAAC,UAAU,IAAC,KAAK,EAAE,KAAK,GAAI,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;AACxE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,kBAAkB,CAAI,KAA6C;IACjF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,oBAAC,YAAY,OAAK,KAAK,EAAE,QAAQ,EAAE,CAAC,KAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAI,EAAE;YAC1E,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAClB,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa;IACvC,OAAO,MAAM,CAAC,oBAAC,KAAK,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC,CAAA;AACxC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAwC;IACvE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,oBAAC,UAAU,OAAK,KAAK,EAAE,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAI,EAAE;YAC7E,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAClB,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import ConcurrentOutput from '../../private/node/ui/components/ConcurrentOutput.js'\nimport {consoleError, OutputProcess} from '../../output.js'\nimport {render, renderOnce} from '../../private/node/ui.js'\nimport {Fatal} from '../../error.js'\nimport {alert} from '../../private/node/ui/alert.js'\nimport {AlertProps} from '../../private/node/ui/components/Alert.js'\nimport {FatalError} from '../../private/node/ui/components/FatalError.js'\nimport {SelectPrompt, Props as SelectPromptProps} from '../../private/node/ui/components/SelectPrompt.js'\nimport {Tasks, Task} from '../../private/node/ui/components/Tasks.js'\nimport {TextPrompt, Props as TextPromptProps} from '../../private/node/ui/components/TextPrompt.js'\nimport React from 'react'\nimport {RenderOptions} from 'ink'\nimport {AbortController} from '@shopify/cli-kit/node/abort'\n\ninterface RenderConcurrentOptions {\n  processes: OutputProcess[]\n  abortController?: AbortController\n  showTimestamps?: boolean\n  renderOptions?: RenderOptions\n}\n\n/**\n * Renders output from concurrent processes to the terminal with {@link ConcurrentOutput}.\n */\nexport async function renderConcurrent({\n  processes,\n  abortController,\n  showTimestamps = true,\n  renderOptions = {},\n}: RenderConcurrentOptions) {\n  return render(\n    <ConcurrentOutput\n      processes={processes}\n      abortController={abortController ?? new AbortController()}\n      showTimestamps={showTimestamps}\n    />,\n    renderOptions,\n  )\n}\n\ntype RenderAlertOptions = Omit<AlertProps, 'type'>\n\n/**\n * Renders an information banner to the console.\n *\n * Basic:\n *\n * ```\n * ╭─ info ───────────────────────────────────────────────────╮\n * │                                                          │\n * │  Body                                                    │\n * │                                                          │\n * ╰──────────────────────────────────────────────────────────╯\n * ```\n *\n * Complete:\n * ```\n * ╭─ info ───────────────────────────────────────────────────╮\n * │                                                          │\n * │  Title                                                   │\n * │                                                          │\n * │  Body                                                    │\n * │                                                          │\n * │  Next steps                                              │\n * │    • Run `cd santorini-goods`                            │\n * │    • To preview your project, run `npm app dev`          │\n * │    • To add extensions, run `npm generate extension`     │\n * │                                                          │\n * │  Reference                                               │\n * │    • Run `npm shopify help`                              │\n * │    • Press 'return' to open the dev docs:                │\n * │      https://shopify.dev                                 │\n * │                                                          │\n * │  Link: https://shopify.com                               │\n * │                                                          │\n * ╰──────────────────────────────────────────────────────────╯\n * ```\n */\nexport function renderInfo(options: RenderAlertOptions) {\n  return alert({...options, type: 'info'})\n}\n\n/**\n * Renders a success banner to the console.\n *\n * Basic:\n *\n * ```\n * ╭─ success ────────────────────────────────────────────────╮\n * │                                                          │\n * │  Title                                                   │\n * │                                                          │\n * ╰──────────────────────────────────────────────────────────╯\n * ```\n *\n * Complete:\n * ```\n * ╭─ success ────────────────────────────────────────────────╮\n * │                                                          │\n * │  Title                                                   │\n * │                                                          │\n * │  Body                                                    │\n * │                                                          │\n * │  Next steps                                              │\n * │    • Run `cd santorini-goods`                              │\n * │    • To preview your project, run `npm app dev`            │\n * │    • To add extensions, run `npm generate extension`       │\n * │                                                          │\n * │  Reference                                               │\n * │    • Run `npm shopify help`                                │\n * │    • Press 'return' to open the dev docs:                │\n * │      https://shopify.dev                                 │\n * │                                                          │\n * │  Link: https://shopify.com                               │\n * │                                                          │\n * ╰──────────────────────────────────────────────────────────╯\n * ```\n */\nexport function renderSuccess(options: RenderAlertOptions) {\n  return alert({...options, type: 'success'})\n}\n\n/**\n * Renders a warning banner to the console.\n *\n * Basic:\n *\n * ```\n * ╭─ warning ────────────────────────────────────────────────╮\n * │                                                          │\n * │  Title                                                   │\n * │                                                          │\n * ╰──────────────────────────────────────────────────────────╯\n * ```\n *\n * Complete:\n * ```\n * ╭─ warning ────────────────────────────────────────────────╮\n * │                                                          │\n * │  Title                                                   │\n * │                                                          │\n * │  Body                                                    │\n * │                                                          │\n * │  Next steps                                              │\n * │    • Run `cd santorini-goods`                            │\n * │    • To preview your project, run `npm app dev`          │\n * │    • To add extensions, run `npm generate extension`     │\n * │                                                          │\n * │  Reference                                               │\n * │    • Run `npm shopify help`                              │\n * │    • Press 'return' to open the dev docs:                │\n * │      https://shopify.dev                                 │\n * │                                                          │\n * │  Link: https://shopify.com                               │\n * │                                                          │\n * ╰──────────────────────────────────────────────────────────╯\n * ```\n */\nexport function renderWarning(options: RenderAlertOptions) {\n  return alert({...options, type: 'warning'})\n}\n\n/**\n * Renders a Fatal error to the console inside a banner.\n *\n * ```\n * ╭─ error ──────────────────────────────────────────────────╮\n * │                                                          │\n * │  Couldn't connect to the Shopify Partner Dashboard.      │\n * │                                                          │\n * │  Check your internet connection and try again.           │\n * │                                                          │\n * ╰──────────────────────────────────────────────────────────╯\n * ```\n */\nexport function renderFatalError(error: Fatal) {\n  return renderOnce(<FatalError error={error} />, 'error', consoleError)\n}\n\n/**\n * Renders a select prompt to the console.\n *\n * ?  Associate your project with the org Castile Ventures?\n *\n *      Add:     • new-ext\n *\n *      Remove:  • integrated-demand-ext\n *               • order-discount\n\n * \\>  (f) first\n *     (s) second\n *     (3) third\n *     (4) fourth\n *     (5) seventh\n *     (6) tenth\n\n *     Automations\n *     (7) fifth\n *     (8) sixth\n\n *     Merchant Admin\n *     (9) eighth\n *     (10) ninth\n\n *     navigate with arrows, enter to select\n */\nexport function renderSelectPrompt<T>(props: Omit<SelectPromptProps<T>, 'onSubmit'>) {\n  return new Promise((resolve, reject) => {\n    render(<SelectPrompt {...props} onSubmit={(value: T) => resolve(value)} />, {\n      exitOnCtrlC: false,\n    }).catch(reject)\n  })\n}\n\n/**\n * Runs async tasks and displays their progress to the console.\n */\nexport function renderTasks(tasks: Task[]) {\n  return render(<Tasks tasks={tasks} />)\n}\n\n/**\n * Renders a text prompt to the console.\n *\n * ?  What is your name?\n * \\>  John\n */\nexport function renderTextPrompt(props: Omit<TextPromptProps, 'onSubmit'>) {\n  return new Promise((resolve, reject) => {\n    render(<TextPrompt {...props} onSubmit={(value: string) => resolve(value)} />, {\n      exitOnCtrlC: false,\n    }).catch(reject)\n  })\n}\n"]}

package/dist/schema.d.ts

@@ -0,0 +1 @@
+export { z as define } from 'zod';

package/dist/schema.js

@@ -0,0 +1,2 @@
+export { z as define } from 'zod';
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,IAAI,MAAM,EAAC,MAAM,KAAK,CAAA","sourcesContent":["export {z as define} from 'zod'\n"]}

package/dist/secure-store.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Fetches secured content from the system's keychain.
+ * @param identifier - Identifier to identify the content.
+ * @returns A promise that resolves with the content or null if it doesn't exist.
+ */
+export declare function fetch(identifier: string): Promise<string | null>;
+/**
+ * Securely stores the content under the given key.
+ * @param identifier - Identifier to identify the content.
+ * @param content - The content to be stored.
+ * @returns A promise that resolves when the storing completes.
+ */
+export declare function store(identifier: string, content: string): Promise<void>;
+/**
+ * Removes the content with the given identifier.
+ * @param identifier - Identifier to identify the content.
+ * @returns A promise that resolves with true if the content was deleted.
+ */
+export declare function remove(identifier: string): Promise<boolean>;

package/dist/secure-store.js

@@ -0,0 +1,63 @@
+import constants from './constants.js';
+import { content as outputContent, debug } from './output.js';
+import { Abort } from './error.js';
+/**
+ * Fetches secured content from the system's keychain.
+ * @param identifier - Identifier to identify the content.
+ * @returns A promise that resolves with the content or null if it doesn't exist.
+ */
+export async function fetch(identifier) {
+    debug(outputContent `Reading ${identifier} from the secure store...`);
+    try {
+        const keytar = await import('keytar');
+        const content = await keytar.getPassword(constants.keychain.service, identifier);
+        return content;
+    }
+    catch (error) {
+        throw createAbort(error, 'Unable to read from the secure store');
+    }
+}
+/**
+ * Securely stores the content under the given key.
+ * @param identifier - Identifier to identify the content.
+ * @param content - The content to be stored.
+ * @returns A promise that resolves when the storing completes.
+ */
+export async function store(identifier, content) {
+    debug(outputContent `Updating ${identifier} in the secure store with new content...`);
+    try {
+        const keytar = await import('keytar');
+        await keytar.default.setPassword(constants.keychain.service, identifier, content);
+    }
+    catch (error) {
+        throw createAbort(error, 'Unable to update the secure store');
+    }
+}
+/**
+ * Removes the content with the given identifier.
+ * @param identifier - Identifier to identify the content.
+ * @returns A promise that resolves with true if the content was deleted.
+ */
+export async function remove(identifier) {
+    debug(outputContent `Removing ${identifier} from the secure store...`);
+    try {
+        const keytar = await import('keytar');
+        const result = await keytar.default.deletePassword(constants.keychain.service, identifier);
+        return result;
+    }
+    catch (error) {
+        throw createAbort(error, 'Unable to remove from the secure store');
+    }
+}
+function createAbort(error, message) {
+    let newMessage = message;
+    let stack = '';
+    if (error instanceof Error) {
+        newMessage = message.concat(`: ${error.message}`);
+        stack = error.stack;
+    }
+    const abort = new Abort(newMessage);
+    abort.stack = stack;
+    return abort;
+}
+//# sourceMappingURL=secure-store.js.map

package/dist/secure-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secure-store.js","sourceRoot":"","sources":["../src/secure-store.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAC,OAAO,IAAI,aAAa,EAAE,KAAK,EAAC,MAAM,aAAa,CAAA;AAC3D,OAAO,EAAC,KAAK,EAAC,MAAM,YAAY,CAAA;AAEhC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,UAAkB;IAC5C,KAAK,CAAC,aAAa,CAAA,WAAW,UAAU,2BAA2B,CAAC,CAAA;IACpE,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;QAChF,OAAO,OAAO,CAAA;KACf;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,WAAW,CAAC,KAAK,EAAE,sCAAsC,CAAC,CAAA;KACjE;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,UAAkB,EAAE,OAAe;IAC7D,KAAK,CAAC,aAAa,CAAA,YAAY,UAAU,0CAA0C,CAAC,CAAA;IACpF,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;KAClF;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,WAAW,CAAC,KAAK,EAAE,mCAAmC,CAAC,CAAA;KAC9D;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,UAAkB;IAC7C,KAAK,CAAC,aAAa,CAAA,YAAY,UAAU,2BAA2B,CAAC,CAAA;IACrE,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;QAC1F,OAAO,MAAM,CAAA;KACd;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,WAAW,CAAC,KAAK,EAAE,wCAAwC,CAAC,CAAA;KACnE;AACH,CAAC;AAED,SAAS,WAAW,CAAC,KAAc,EAAE,OAAe;IAClD,IAAI,UAAU,GAAG,OAAO,CAAA;IACxB,IAAI,KAAK,GAAuB,EAAE,CAAA;IAClC,IAAI,KAAK,YAAY,KAAK,EAAE;QAC1B,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;QACjD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;KACpB;IACD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,UAAU,CAAC,CAAA;IACnC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAA;IACnB,OAAO,KAAK,CAAA;AACd,CAAC","sourcesContent":["import constants from './constants.js'\nimport {content as outputContent, debug} from './output.js'\nimport {Abort} from './error.js'\n\n/**\n * Fetches secured content from the system's keychain.\n * @param identifier - Identifier to identify the content.\n * @returns A promise that resolves with the content or null if it doesn't exist.\n */\nexport async function fetch(identifier: string): Promise<string | null> {\n  debug(outputContent`Reading ${identifier} from the secure store...`)\n  try {\n    const keytar = await import('keytar')\n    const content = await keytar.getPassword(constants.keychain.service, identifier)\n    return content\n  } catch (error) {\n    throw createAbort(error, 'Unable to read from the secure store')\n  }\n}\n\n/**\n * Securely stores the content under the given key.\n * @param identifier - Identifier to identify the content.\n * @param content - The content to be stored.\n * @returns A promise that resolves when the storing completes.\n */\nexport async function store(identifier: string, content: string): Promise<void> {\n  debug(outputContent`Updating ${identifier} in the secure store with new content...`)\n  try {\n    const keytar = await import('keytar')\n    await keytar.default.setPassword(constants.keychain.service, identifier, content)\n  } catch (error) {\n    throw createAbort(error, 'Unable to update the secure store')\n  }\n}\n\n/**\n * Removes the content with the given identifier.\n * @param identifier - Identifier to identify the content.\n * @returns A promise that resolves with true if the content was deleted.\n */\nexport async function remove(identifier: string): Promise<boolean> {\n  debug(outputContent`Removing ${identifier} from the secure store...`)\n  try {\n    const keytar = await import('keytar')\n    const result = await keytar.default.deletePassword(constants.keychain.service, identifier)\n    return result\n  } catch (error) {\n    throw createAbort(error, 'Unable to remove from the secure store')\n  }\n}\n\nfunction createAbort(error: unknown, message: string) {\n  let newMessage = message\n  let stack: string | undefined = ''\n  if (error instanceof Error) {\n    newMessage = message.concat(`: ${error.message}`)\n    stack = error.stack\n  }\n  const abort = new Abort(newMessage)\n  abort.stack = stack\n  return abort\n}\n"]}

package/dist/session/authorize.d.ts

@@ -0,0 +1,7 @@
+import { Abort } from '../error.js';
+export declare const MismatchStateError: Abort;
+export interface CodeAuthResult {
+    code: string;
+    codeVerifier: string;
+}
+export declare function authorize(scopes: string[], state?: string): Promise<CodeAuthResult>;

package/dist/session/authorize.js

@@ -0,0 +1,52 @@
+import { listenRedirect } from './redirect-listener.js';
+import { clientId } from './identity.js';
+import { generateRandomChallengePair, randomHex } from '../string.js';
+import { open } from '../system.js';
+import { Abort, CancelExecution } from '../error.js';
+import { identity as identityFqdn } from '../environment/fqdn.js';
+import * as output from '../output.js';
+import { keypress, terminateBlockingPortProcessPrompt } from '../ui.js';
+import { checkPort as isPortAvailable } from 'get-port-please';
+export const MismatchStateError = new Abort("The state received from the authentication doesn't match the one that initiated the authentication process.");
+export async function authorize(scopes, state = randomHex(30)) {
+    const port = 3456;
+    const host = '127.0.0.1';
+    const redirectUri = `http://${host}:${port}`;
+    const fqdn = await identityFqdn();
+    const identityClientId = await clientId();
+    await validateRedirectionPortAvailability(port);
+    let url = `http://${fqdn}/oauth/authorize`;
+    const { codeVerifier, codeChallenge } = generateRandomChallengePair();
+    const params = {
+        client_id: identityClientId,
+        scope: scopes.join(' '),
+        redirect_uri: redirectUri,
+        state,
+        response_type: 'code',
+        code_challenge_method: 'S256',
+        code_challenge: codeChallenge,
+    };
+    output.info('\nTo run this command, log in to Shopify Partners.');
+    output.info('👉 Press any key to open the login page on your browser');
+    await keypress();
+    url = `${url}?${new URLSearchParams(params).toString()}`;
+    await open(url);
+    const result = await listenRedirect(host, port, url);
+    if (result.state !== state) {
+        throw MismatchStateError;
+    }
+    return { code: result.code, codeVerifier };
+}
+async function validateRedirectionPortAvailability(port) {
+    const { killPortProcess } = await import('kill-port-process');
+    if (await isPortAvailable(port)) {
+        return;
+    }
+    if (await terminateBlockingPortProcessPrompt(port, 'Authentication')) {
+        await killPortProcess(port);
+    }
+    else {
+        throw new CancelExecution();
+    }
+}
+//# sourceMappingURL=authorize.js.map

package/dist/session/authorize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorize.js","sourceRoot":"","sources":["../../src/session/authorize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAC,MAAM,wBAAwB,CAAA;AACrD,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAA;AACtC,OAAO,EAAC,2BAA2B,EAAE,SAAS,EAAC,MAAM,cAAc,CAAA;AACnE,OAAO,EAAC,IAAI,EAAC,MAAM,cAAc,CAAA;AACjC,OAAO,EAAC,KAAK,EAAE,eAAe,EAAC,MAAM,aAAa,CAAA;AAClD,OAAO,EAAC,QAAQ,IAAI,YAAY,EAAC,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,EAAC,QAAQ,EAAE,kCAAkC,EAAC,MAAM,UAAU,CAAA;AACrE,OAAO,EAAC,SAAS,IAAI,eAAe,EAAC,MAAM,iBAAiB,CAAA;AAE5D,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,KAAK,CACzC,6GAA6G,CAC9G,CAAA;AAOD,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,MAAgB,EAAE,QAAgB,SAAS,CAAC,EAAE,CAAC;IAC7E,MAAM,IAAI,GAAG,IAAI,CAAA;IACjB,MAAM,IAAI,GAAG,WAAW,CAAA;IACxB,MAAM,WAAW,GAAG,UAAU,IAAI,IAAI,IAAI,EAAE,CAAA;IAC5C,MAAM,IAAI,GAAG,MAAM,YAAY,EAAE,CAAA;IACjC,MAAM,gBAAgB,GAAG,MAAM,QAAQ,EAAE,CAAA;IAEzC,MAAM,mCAAmC,CAAC,IAAI,CAAC,CAAA;IAE/C,IAAI,GAAG,GAAG,UAAU,IAAI,kBAAkB,CAAA;IAE1C,MAAM,EAAC,YAAY,EAAE,aAAa,EAAC,GAAG,2BAA2B,EAAE,CAAA;IAEnE,MAAM,MAAM,GAAG;QACb,SAAS,EAAE,gBAAgB;QAC3B,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QACvB,YAAY,EAAE,WAAW;QACzB,KAAK;QACL,aAAa,EAAE,MAAM;QACrB,qBAAqB,EAAE,MAAM;QAC7B,cAAc,EAAE,aAAa;KAC9B,CAAA;IAED,MAAM,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAA;IACjE,MAAM,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAA;IACtE,MAAM,QAAQ,EAAE,CAAA;IAEhB,GAAG,GAAG,GAAG,GAAG,IAAI,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAA;IACxD,MAAM,IAAI,CAAC,GAAG,CAAC,CAAA;IAEf,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;IAEpD,IAAI,MAAM,CAAC,KAAK,KAAK,KAAK,EAAE;QAC1B,MAAM,kBAAkB,CAAA;KACzB;IAED,OAAO,EAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,YAAY,EAAC,CAAA;AAC1C,CAAC;AAED,KAAK,UAAU,mCAAmC,CAAC,IAAY;IAC7D,MAAM,EAAC,eAAe,EAAC,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,CAAA;IAE3D,IAAI,MAAM,eAAe,CAAC,IAAI,CAAC,EAAE;QAC/B,OAAM;KACP;IAED,IAAI,MAAM,kCAAkC,CAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE;QACpE,MAAM,eAAe,CAAC,IAAI,CAAC,CAAA;KAC5B;SAAM;QACL,MAAM,IAAI,eAAe,EAAE,CAAA;KAC5B;AACH,CAAC","sourcesContent":["import {listenRedirect} from './redirect-listener.js'\nimport {clientId} from './identity.js'\nimport {generateRandomChallengePair, randomHex} from '../string.js'\nimport {open} from '../system.js'\nimport {Abort, CancelExecution} from '../error.js'\nimport {identity as identityFqdn} from '../environment/fqdn.js'\nimport * as output from '../output.js'\nimport {keypress, terminateBlockingPortProcessPrompt} from '../ui.js'\nimport {checkPort as isPortAvailable} from 'get-port-please'\n\nexport const MismatchStateError = new Abort(\n  \"The state received from the authentication doesn't match the one that initiated the authentication process.\",\n)\n\nexport interface CodeAuthResult {\n  code: string\n  codeVerifier: string\n}\n\nexport async function authorize(scopes: string[], state: string = randomHex(30)): Promise<CodeAuthResult> {\n  const port = 3456\n  const host = '127.0.0.1'\n  const redirectUri = `http://${host}:${port}`\n  const fqdn = await identityFqdn()\n  const identityClientId = await clientId()\n\n  await validateRedirectionPortAvailability(port)\n\n  let url = `http://${fqdn}/oauth/authorize`\n\n  const {codeVerifier, codeChallenge} = generateRandomChallengePair()\n\n  const params = {\n    client_id: identityClientId,\n    scope: scopes.join(' '),\n    redirect_uri: redirectUri,\n    state,\n    response_type: 'code',\n    code_challenge_method: 'S256',\n    code_challenge: codeChallenge,\n  }\n\n  output.info('\\nTo run this command, log in to Shopify Partners.')\n  output.info('👉 Press any key to open the login page on your browser')\n  await keypress()\n\n  url = `${url}?${new URLSearchParams(params).toString()}`\n  await open(url)\n\n  const result = await listenRedirect(host, port, url)\n\n  if (result.state !== state) {\n    throw MismatchStateError\n  }\n\n  return {code: result.code, codeVerifier}\n}\n\nasync function validateRedirectionPortAvailability(port: number) {\n  const {killPortProcess} = await import('kill-port-process')\n\n  if (await isPortAvailable(port)) {\n    return\n  }\n\n  if (await terminateBlockingPortProcessPrompt(port, 'Authentication')) {\n    await killPortProcess(port)\n  } else {\n    throw new CancelExecution()\n  }\n}\n"]}

package/dist/session/device-authorization.d.ts

@@ -0,0 +1,32 @@
+import { IdentityToken } from './schema.js';
+export interface DeviceAuthorizationResponse {
+    deviceCode: string;
+    userCode: string;
+    verificationUri: string;
+    expiresIn: number;
+    verificationUriComplete?: string;
+    interval?: number;
+}
+/**
+ * Initiate a device authorization flow.
+ * This will return a DeviceAuthorizationResponse containing the URL where user
+ * should go to authorize the device without the need of a callback to the CLI.
+ *
+ * Also returns a `deviceCode` used for polling the token endpoint in the next step.
+ *
+ * @param scopes - The scopes to request
+ * @returns An object with the device authorization response.
+ */
+export declare function requestDeviceAuthorization(scopes: string[]): Promise<DeviceAuthorizationResponse>;
+/**
+ * Poll the Oauth token endpoint with the device code obtained from a DeviceAuthorizationResponse.
+ * The endpoint will return `authorization_pending` until the user completes the auth flow in the browser.
+ * Once the user completes the auth flow, the endpoint will return the identity token.
+ *
+ * Timeout for the polling is defined by the server and is around 600 seconds.
+ *
+ * @param code - The device code obtained after starting a device identity flow
+ * @param interval - The interval to poll the token endpoint
+ * @returns The identity token
+ */
+export declare function pollForDeviceAuthorization(code: string, interval?: number): Promise<IdentityToken>;

package/dist/session/device-authorization.js

@@ -0,0 +1,92 @@
+import { clientId } from './identity.js';
+import { exchangeDeviceCodeForAccessToken } from './exchange.js';
+import { identity as identityFqdn } from '../environment/fqdn.js';
+import { shopifyFetch } from '../http.js';
+import { content, debug, info, token } from '../output.js';
+import { Bug } from '../error.js';
+const DeviceAuthError = () => {
+    return new Bug('Failed to start authorization process');
+};
+/**
+ * Initiate a device authorization flow.
+ * This will return a DeviceAuthorizationResponse containing the URL where user
+ * should go to authorize the device without the need of a callback to the CLI.
+ *
+ * Also returns a `deviceCode` used for polling the token endpoint in the next step.
+ *
+ * @param scopes - The scopes to request
+ * @returns An object with the device authorization response.
+ */
+export async function requestDeviceAuthorization(scopes) {
+    const fqdn = await identityFqdn();
+    const identityClientId = await clientId();
+    const queryParams = { client_id: identityClientId, scope: scopes.join(' ') };
+    const url = `https://${fqdn}/oauth/device_authorization`;
+    const response = await shopifyFetch(url, {
+        method: 'POST',
+        headers: { 'Content-type': 'application/x-www-form-urlencoded' },
+        body: convertRequestToParams(queryParams),
+    });
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const jsonResult = await response.json();
+    debug(content `Received device authorization code: ${token.json(jsonResult)}`);
+    if (!jsonResult.device_code || !jsonResult.verification_uri_complete)
+        throw DeviceAuthError();
+    info('\nTo run this command, log in to Shopify Partners.');
+    info(content `User verification code: ${jsonResult.user_code}`);
+    info(content `👉 Open this link to start the auth process: ${token.green(jsonResult.verification_uri_complete)}`);
+    return {
+        deviceCode: jsonResult.device_code,
+        userCode: jsonResult.user_code,
+        verificationUri: jsonResult.verification_uri,
+        expiresIn: jsonResult.expires_in,
+        verificationUriComplete: jsonResult.verification_uri_complete,
+        interval: jsonResult.interval,
+    };
+}
+/**
+ * Poll the Oauth token endpoint with the device code obtained from a DeviceAuthorizationResponse.
+ * The endpoint will return `authorization_pending` until the user completes the auth flow in the browser.
+ * Once the user completes the auth flow, the endpoint will return the identity token.
+ *
+ * Timeout for the polling is defined by the server and is around 600 seconds.
+ *
+ * @param code - The device code obtained after starting a device identity flow
+ * @param interval - The interval to poll the token endpoint
+ * @returns The identity token
+ */
+export async function pollForDeviceAuthorization(code, interval = 5) {
+    let currentIntervalInSeconds = interval;
+    return new Promise((resolve, reject) => {
+        const onPoll = async () => {
+            const result = await exchangeDeviceCodeForAccessToken(code);
+            if (!result.isErr())
+                return resolve(result.value);
+            const error = result.error ?? 'unknown_failure';
+            debug(content `Polling for device authorization... status: ${error}`);
+            switch (error) {
+                case 'authorization_pending':
+                    return startPolling();
+                case 'slow_down':
+                    currentIntervalInSeconds += 5;
+                    return startPolling();
+                case 'access_denied':
+                case 'expired_token':
+                case 'unknown_failure':
+                    return reject(result);
+            }
+        };
+        const startPolling = () => {
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises
+            setTimeout(onPoll, currentIntervalInSeconds * 1000);
+        };
+        startPolling();
+    });
+}
+function convertRequestToParams(queryParams) {
+    return Object.entries(queryParams)
+        .map(([key, value]) => value && `${key}=${value}`)
+        .filter((hasValue) => Boolean(hasValue))
+        .join('&');
+}
+//# sourceMappingURL=device-authorization.js.map

package/dist/session/device-authorization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-authorization.js","sourceRoot":"","sources":["../../src/session/device-authorization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAA;AACtC,OAAO,EAAC,gCAAgC,EAAC,MAAM,eAAe,CAAA;AAE9D,OAAO,EAAC,QAAQ,IAAI,YAAY,EAAC,MAAM,wBAAwB,CAAA;AAC/D,OAAO,EAAC,YAAY,EAAC,MAAM,YAAY,CAAA;AACvC,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AACxD,OAAO,EAAC,GAAG,EAAC,MAAM,aAAa,CAAA;AAW/B,MAAM,eAAe,GAAG,GAAG,EAAE;IAC3B,OAAO,IAAI,GAAG,CAAC,uCAAuC,CAAC,CAAA;AACzD,CAAC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,MAAgB;IAC/D,MAAM,IAAI,GAAG,MAAM,YAAY,EAAE,CAAA;IACjC,MAAM,gBAAgB,GAAG,MAAM,QAAQ,EAAE,CAAA;IACzC,MAAM,WAAW,GAAG,EAAC,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAC,CAAA;IAC1E,MAAM,GAAG,GAAG,WAAW,IAAI,6BAA6B,CAAA;IAExD,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE;QACvC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAC,cAAc,EAAE,mCAAmC,EAAC;QAC9D,IAAI,EAAE,sBAAsB,CAAC,WAAW,CAAC;KAC1C,CAAC,CAAA;IAEF,8DAA8D;IAC9D,MAAM,UAAU,GAAQ,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IAE7C,KAAK,CAAC,OAAO,CAAA,uCAAuC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;IAC7E,IAAI,CAAC,UAAU,CAAC,WAAW,IAAI,CAAC,UAAU,CAAC,yBAAyB;QAAE,MAAM,eAAe,EAAE,CAAA;IAE7F,IAAI,CAAC,oDAAoD,CAAC,CAAA;IAC1D,IAAI,CAAC,OAAO,CAAA,2BAA2B,UAAU,CAAC,SAAS,EAAE,CAAC,CAAA;IAC9D,IAAI,CAAC,OAAO,CAAA,gDAAgD,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAA;IAEhH,OAAO;QACL,UAAU,EAAE,UAAU,CAAC,WAAW;QAClC,QAAQ,EAAE,UAAU,CAAC,SAAS;QAC9B,eAAe,EAAE,UAAU,CAAC,gBAAgB;QAC5C,SAAS,EAAE,UAAU,CAAC,UAAU;QAChC,uBAAuB,EAAE,UAAU,CAAC,yBAAyB;QAC7D,QAAQ,EAAE,UAAU,CAAC,QAAQ;KAC9B,CAAA;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,IAAY,EAAE,QAAQ,GAAG,CAAC;IACzE,IAAI,wBAAwB,GAAG,QAAQ,CAAA;IAEvC,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACpD,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE;YACxB,MAAM,MAAM,GAAG,MAAM,gCAAgC,CAAC,IAAI,CAAC,CAAA;YAC3D,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;gBAAE,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YAEjD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,iBAAiB,CAAA;YAE/C,KAAK,CAAC,OAAO,CAAA,+CAA+C,KAAK,EAAE,CAAC,CAAA;YACpE,QAAQ,KAAK,EAAE;gBACb,KAAK,uBAAuB;oBAC1B,OAAO,YAAY,EAAE,CAAA;gBACvB,KAAK,WAAW;oBACd,wBAAwB,IAAI,CAAC,CAAA;oBAC7B,OAAO,YAAY,EAAE,CAAA;gBACvB,KAAK,eAAe,CAAC;gBACrB,KAAK,eAAe,CAAC;gBACrB,KAAK,iBAAiB;oBACpB,OAAO,MAAM,CAAC,MAAM,CAAC,CAAA;aACxB;QACH,CAAC,CAAA;QAED,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,kEAAkE;YAClE,UAAU,CAAC,MAAM,EAAE,wBAAwB,GAAG,IAAI,CAAC,CAAA;QACrD,CAAC,CAAA;QAED,YAAY,EAAE,CAAA;IAChB,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,sBAAsB,CAAC,WAA+C;IAC7E,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;SAC/B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;SACjD,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SACvC,IAAI,CAAC,GAAG,CAAC,CAAA;AACd,CAAC","sourcesContent":["import {clientId} from './identity.js'\nimport {exchangeDeviceCodeForAccessToken} from './exchange.js'\nimport {IdentityToken} from './schema.js'\nimport {identity as identityFqdn} from '../environment/fqdn.js'\nimport {shopifyFetch} from '../http.js'\nimport {content, debug, info, token} from '../output.js'\nimport {Bug} from '../error.js'\n\nexport interface DeviceAuthorizationResponse {\n  deviceCode: string\n  userCode: string\n  verificationUri: string\n  expiresIn: number\n  verificationUriComplete?: string\n  interval?: number\n}\n\nconst DeviceAuthError = () => {\n  return new Bug('Failed to start authorization process')\n}\n\n/**\n * Initiate a device authorization flow.\n * This will return a DeviceAuthorizationResponse containing the URL where user\n * should go to authorize the device without the need of a callback to the CLI.\n *\n * Also returns a `deviceCode` used for polling the token endpoint in the next step.\n *\n * @param scopes - The scopes to request\n * @returns An object with the device authorization response.\n */\nexport async function requestDeviceAuthorization(scopes: string[]): Promise<DeviceAuthorizationResponse> {\n  const fqdn = await identityFqdn()\n  const identityClientId = await clientId()\n  const queryParams = {client_id: identityClientId, scope: scopes.join(' ')}\n  const url = `https://${fqdn}/oauth/device_authorization`\n\n  const response = await shopifyFetch(url, {\n    method: 'POST',\n    headers: {'Content-type': 'application/x-www-form-urlencoded'},\n    body: convertRequestToParams(queryParams),\n  })\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const jsonResult: any = await response.json()\n\n  debug(content`Received device authorization code: ${token.json(jsonResult)}`)\n  if (!jsonResult.device_code || !jsonResult.verification_uri_complete) throw DeviceAuthError()\n\n  info('\\nTo run this command, log in to Shopify Partners.')\n  info(content`User verification code: ${jsonResult.user_code}`)\n  info(content`👉 Open this link to start the auth process: ${token.green(jsonResult.verification_uri_complete)}`)\n\n  return {\n    deviceCode: jsonResult.device_code,\n    userCode: jsonResult.user_code,\n    verificationUri: jsonResult.verification_uri,\n    expiresIn: jsonResult.expires_in,\n    verificationUriComplete: jsonResult.verification_uri_complete,\n    interval: jsonResult.interval,\n  }\n}\n\n/**\n * Poll the Oauth token endpoint with the device code obtained from a DeviceAuthorizationResponse.\n * The endpoint will return `authorization_pending` until the user completes the auth flow in the browser.\n * Once the user completes the auth flow, the endpoint will return the identity token.\n *\n * Timeout for the polling is defined by the server and is around 600 seconds.\n *\n * @param code - The device code obtained after starting a device identity flow\n * @param interval - The interval to poll the token endpoint\n * @returns The identity token\n */\nexport async function pollForDeviceAuthorization(code: string, interval = 5): Promise<IdentityToken> {\n  let currentIntervalInSeconds = interval\n\n  return new Promise<IdentityToken>((resolve, reject) => {\n    const onPoll = async () => {\n      const result = await exchangeDeviceCodeForAccessToken(code)\n      if (!result.isErr()) return resolve(result.value)\n\n      const error = result.error ?? 'unknown_failure'\n\n      debug(content`Polling for device authorization... status: ${error}`)\n      switch (error) {\n        case 'authorization_pending':\n          return startPolling()\n        case 'slow_down':\n          currentIntervalInSeconds += 5\n          return startPolling()\n        case 'access_denied':\n        case 'expired_token':\n        case 'unknown_failure':\n          return reject(result)\n      }\n    }\n\n    const startPolling = () => {\n      // eslint-disable-next-line @typescript-eslint/no-misused-promises\n      setTimeout(onPoll, currentIntervalInSeconds * 1000)\n    }\n\n    startPolling()\n  })\n}\n\nfunction convertRequestToParams(queryParams: {client_id: string; scope: string}): string {\n  return Object.entries(queryParams)\n    .map(([key, value]) => value && `${key}=${value}`)\n    .filter((hasValue) => Boolean(hasValue))\n    .join('&')\n}\n"]}

package/dist/session/exchange.d.ts

@@ -0,0 +1,48 @@
+import { ApplicationToken, IdentityToken } from './schema.js';
+import { CodeAuthResult } from './authorize.js';
+import { Result } from '../public/node/result.js';
+import { ExtendableError } from '../error.js';
+export declare class InvalidGrantError extends ExtendableError {
+}
+export declare class InvalidRequestError extends ExtendableError {
+}
+export interface ExchangeScopes {
+    admin: string[];
+    partners: string[];
+    storefront: string[];
+}
+/**
+ * Given a valid authorization code, request an identity access token.
+ * This token can then be used to get API specific tokens.
+ * @param codeData - code and codeVerifier from the authorize endpoint
+ * @returns An instance with the identity access tokens.
+ */
+export declare function exchangeCodeForAccessToken(codeData: CodeAuthResult): Promise<IdentityToken>;
+/**
+ * Given an identity token, request an application token.
+ * @param identityToken - access token obtained in a previous step
+ * @param store - the store to use, only needed for admin API
+ * @returns An array with the application access tokens.
+ */
+export declare function exchangeAccessForApplicationTokens(identityToken: IdentityToken, scopes: ExchangeScopes, store?: string): Promise<{
+    [x: string]: ApplicationToken;
+}>;
+/**
+ * Given an expired access token, refresh it to get a new one.
+ */
+export declare function refreshAccessToken(currentToken: IdentityToken): Promise<IdentityToken>;
+/**
+ * Given a custom CLI token passed as ENV variable, request a valid partners API token
+ * This token does not accept extra scopes, just the cli one.
+ * @param token - The CLI token passed as ENV variable
+ * @returns An instance with the application access tokens.
+ */
+export declare function exchangeCustomPartnerToken(token: string): Promise<ApplicationToken>;
+export declare type IdentityDeviceError = 'authorization_pending' | 'access_denied' | 'expired_token' | 'slow_down' | 'unknown_failure';
+/**
+ * Given a deviceCode obtained after starting a device identity flow, request an identity token.
+ * @param deviceCode - The device code obtained after starting a device identity flow
+ * @param scopes - The scopes to request
+ * @returns An instance with the identity access tokens.
+ */
+export declare function exchangeDeviceCodeForAccessToken(deviceCode: string): Promise<Result<IdentityToken, IdentityDeviceError>>;