@vendure-platform/console-auth 1.0.0-major.202609091053.0.0

package/dist/credential-store.d.ts

@@ -0,0 +1,99 @@
+/**
+ * An account-level Console session.
+ *
+ * This is deliberately not the same thing as the per-project development
+ * credential `@vendure-platform/cli` keeps in `<projectRoot>/.vendure`. That one
+ * authenticates one environment of one project and belongs to the project. This
+ * one authenticates the person, is worth the same as their Console password
+ * across every project they own, and therefore never goes near a project
+ * directory that someone is about to `git init`.
+ */
+export interface StoredConsoleCredential {
+    schemaVersion: 2;
+    /**
+     * The Console the session was issued by. A credential minted against a local
+     * dev Console must not be replayed against production, so a mismatch reads
+     * as "no credential" rather than being offered to the wrong host.
+     */
+    origin: string;
+    /** The API origin that issued both tokens. Legacy caches have no known issuer. */
+    apiOrigin: string;
+    accessToken: string;
+    /** Absolute expiry, ISO-8601. */
+    expiresAt: string;
+    refreshToken?: string;
+}
+/** `~/.vendure`. No `XDG_CONFIG_HOME` handling: the repo has no precedent for it. */
+export declare function consoleConfigDir(home?: string): string;
+export declare function consoleCredentialPath(home?: string): string;
+/**
+ * The stored credential, or `undefined`.
+ *
+ * Every failure reads as "no credential": a missing file, an unreadable one,
+ * malformed JSON, and a credential for another Console. The caller's answer to
+ * all of those is the same, which is to log in again, and a corrupt cache file
+ * is not worth stopping a scaffold over.
+ *
+ * Expiry is deliberately not checked here. An expired credential may still
+ * carry a usable refresh token, so the decision belongs to the resolver.
+ */
+export declare function readConsoleCredential(options?: {
+    home?: string;
+    origin?: string;
+    apiOrigin?: string;
+}): Promise<StoredConsoleCredential | undefined>;
+/** What is on this machine, with no part of either token in it. */
+export interface ConsoleSessionStatus {
+    path: string;
+    stored: boolean;
+    /** Absolute expiry of the access token, ISO-8601. */
+    expiresAt?: string;
+    /** Whether an expired session renews without a browser. */
+    renewable: boolean;
+}
+/**
+ * Report the stored session without handing the caller either token.
+ *
+ * `vendure console status` needs to say whether a session is held, and a status
+ * line is the last place a token should be able to reach. Returning the
+ * credential and trusting every caller to print around it is one slip away from
+ * a token in a terminal scrollback or a CI log.
+ */
+export declare function readConsoleSessionStatus(options?: {
+    home?: string;
+    origin?: string;
+    apiOrigin?: string;
+}): Promise<ConsoleSessionStatus>;
+/** Whether the credential is past its expiry, counting the skew. */
+export declare function isExpired(credential: StoredConsoleCredential, now: Date): boolean;
+/**
+ * Write the credential at mode 0600 through a temporary file and a rename, so a
+ * reader never observes a half-written token and a crash cannot leave one
+ * behind. `wx` on the temporary file means two concurrent writers cannot land
+ * on the same path.
+ *
+ * Precondition: hold the Console session lock. The rename makes each write
+ * whole, and that is all it makes it. It does not stop this write landing on
+ * top of a pair another process obtained from the refresh token this one is
+ * about to present, which turns a live session into a dead one. Callers inside
+ * this package go through `loginAndStoreConsoleToken`, `refreshStoredConsoleToken`
+ * or `resolveStoredConsoleToken`, all of which take the lock. A caller outside
+ * it has to wrap this in `withConsoleSessionLock` itself. The README section
+ * "Sharing the credential across processes" says why.
+ */
+export declare function writeConsoleCredential(credential: StoredConsoleCredential, options?: {
+    home?: string;
+}): Promise<void>;
+/**
+ * Remove the stored credential. Not re-exported from `index.ts`: the one caller
+ * is the refusal path in `session.ts`.
+ *
+ * Precondition: hold the Console session lock, and re-read the credential under
+ * it first. A refusal observed without the lock proves nothing about the file.
+ * The token it was observed against may already have been replaced by a live
+ * pair another process wrote, and removing the file on that evidence throws
+ * away a working session.
+ */
+export declare function discardConsoleCredential(options?: {
+    home?: string;
+}): Promise<void>;

package/dist/credential-store.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.consoleConfigDir=s,exports.consoleCredentialPath=a,exports.readConsoleCredential=c,exports.readConsoleSessionStatus=p,exports.isExpired=l,exports.writeConsoleCredential=u,exports.discardConsoleCredential=d;const e=require("node:crypto"),r=require("node:fs/promises"),i=require("node:os"),n=require("node:path"),o=require("./origins"),t=6e4;function s(e=(0,i.homedir)()){return(0,n.join)(e,".vendure")}function a(e=(0,i.homedir)()){return(0,n.join)(s(e),"console-credentials.json")}async function c(e={}){const{appOrigin:i,apiOrigin:n}=(0,o.consoleOrigins)({appOrigin:e.origin,apiOrigin:e.apiOrigin});let t;try{t=JSON.parse(await(0,r.readFile)(a(e.home),"utf8"))}catch{return}if(g(t)){try{if((0,o.consoleAppOrigin)(t.origin)!==i||(0,o.consoleApiOrigin)(t.apiOrigin)!==n)return}catch{return}return{...t,origin:i,apiOrigin:n}}}async function p(e={}){const r=a(e.home),i=await c(e);return i?{path:r,stored:!0,expiresAt:i.expiresAt,renewable:Boolean(i.refreshToken)}:{path:r,stored:!1,renewable:!1}}function l(e,r){const i=Date.parse(e.expiresAt);return!!Number.isNaN(i)||i-t<=r.getTime()}async function u(i,t={}){if(!g(i))throw new Error("Refusing to store a malformed Vendure Console credential.");i={...i,origin:(0,o.consoleAppOrigin)(i.origin),apiOrigin:(0,o.consoleApiOrigin)(i.apiOrigin)};const c=s(t.home),p=a(t.home),l=(0,n.join)(c,`.console-credentials.${(0,e.randomUUID)()}.tmp`);let u;try{await(0,r.mkdir)(c,{recursive:!0,mode:448}),await(0,r.chmod)(c,448),u=await(0,r.open)(l,"wx",384),await u.writeFile(`${JSON.stringify(i,null,2)}\n`,"utf8"),await u.sync(),await u.close(),u=void 0,await(0,r.rename)(l,p)}catch{throw await(null==u?void 0:u.close().catch(()=>{})),await(0,r.unlink)(l).catch(()=>{}),new Error("Could not store the Vendure Console credential securely.")}}async function d(e={}){await(0,r.unlink)(a(e.home)).catch(()=>{})}function g(e){if(!e||"object"!=typeof e||Array.isArray(e))return!1;const r=e;return!(2!==r.schemaVersion||"string"!=typeof r.origin||!r.origin||"string"!=typeof r.apiOrigin||!r.apiOrigin||"string"!=typeof r.accessToken||!r.accessToken||"string"!=typeof r.expiresAt||Number.isNaN(Date.parse(r.expiresAt))||void 0!==r.refreshToken&&("string"!=typeof r.refreshToken||!r.refreshToken))}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export { ConsoleTokenGrantError, loginWithBrowser, refreshSession, type BrowserLoginOptions, type ConsoleAuthClient, type ConsoleSession, } from './browser-auth';
+export { ConsoleApi, ConsoleApiError, ConsoleApiTransportError, isConsoleConflict, isPermissionDenied, type ConsoleApiOptions, type ConsoleApiRequestOptions, } from './console-api';
+export { EVALUATION_OFFER_CODES, PROJECT_EDITIONS, createProject, createRegistryAccessToken, evaluationDenial, getProjectEvaluation, getRegistryAccess, linkProject, listProjectEditions, listRegistryAccessTokens, readViewerAccount, rotateRegistryAccessToken, startProjectEvaluation, type ConsoleProject, type ConsoleProjectEdition, type EvaluationOfferCode, type IssuedRegistryAccessToken, type ProjectEdition, type ProjectEditionSource, type ProjectEvaluationState, type RegistryAccessConfiguration, type RegistryAccessToken, type StartedEvaluation, } from './console-projects';
+export { consoleConfigDir, consoleCredentialPath, isExpired, readConsoleCredential, readConsoleSessionStatus, writeConsoleCredential, type ConsoleSessionStatus, type StoredConsoleCredential, } from './credential-store';
+export { ConsoleOnboardingCancelled, acquireRegistryAccess, establishProjectLink, projectCreateIdempotencyKey, registryAccessTokenName, selectConsoleProject, writeProjectLink, type ConsoleOnboardingInteraction, type EstablishProjectLinkOptions, type EstablishedProjectLink, type RegistryAccessInteraction, type RegistryAccessResult, type SelectedConsoleProject, } from './onboarding';
+export { DEFAULT_CONSOLE_API_ORIGIN, DEFAULT_CONSOLE_APP_ORIGIN, consoleApiOrigin, consoleAppOrigin, consoleOrigins, } from './origins';
+export { getProductAccessSummary, type ProductAccessEvaluation, type ProductAccessSubscription, type ProductAccessSummary, } from './product-access';
+export { PROJECT_LINK_IGNORE_RULE, PROJECT_LINK_KEEP_RULE, PROJECT_LINK_MANIFEST_RELATIVE_PATH, applyProjectLinkGitignoreRules, ensureProjectLinkGitignore, parseProjectLinkManifest, projectLinkManifestPath, readProjectLinkManifest, writeProjectLinkManifest, type ProjectLinkGitignoreResult, type ProjectLinkManifest, type ProjectLinkManifestRead, } from './project-link-manifest';
+export { DEFAULT_REGISTRY_URL, REGISTRY_SCOPE, registryAuthTokenKey, registryLoginUrl, registryUrl, } from './registry';
+export { loginAndStoreConsoleToken, refreshStoredConsoleToken, resolveStoredConsoleToken, type ConsoleSessionOptions, } from './session';
+export { withConsoleSessionLock, type ConsoleSessionLockOptions } from './session-lock';

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.DEFAULT_REGISTRY_URL=exports.writeProjectLinkManifest=exports.readProjectLinkManifest=exports.projectLinkManifestPath=exports.parseProjectLinkManifest=exports.ensureProjectLinkGitignore=exports.applyProjectLinkGitignoreRules=exports.PROJECT_LINK_MANIFEST_RELATIVE_PATH=exports.PROJECT_LINK_KEEP_RULE=exports.PROJECT_LINK_IGNORE_RULE=exports.getProductAccessSummary=exports.consoleOrigins=exports.consoleAppOrigin=exports.consoleApiOrigin=exports.DEFAULT_CONSOLE_APP_ORIGIN=exports.DEFAULT_CONSOLE_API_ORIGIN=exports.writeProjectLink=exports.selectConsoleProject=exports.registryAccessTokenName=exports.projectCreateIdempotencyKey=exports.establishProjectLink=exports.acquireRegistryAccess=exports.ConsoleOnboardingCancelled=exports.writeConsoleCredential=exports.readConsoleSessionStatus=exports.readConsoleCredential=exports.isExpired=exports.consoleCredentialPath=exports.consoleConfigDir=exports.startProjectEvaluation=exports.rotateRegistryAccessToken=exports.readViewerAccount=exports.listRegistryAccessTokens=exports.listProjectEditions=exports.linkProject=exports.getRegistryAccess=exports.getProjectEvaluation=exports.evaluationDenial=exports.createRegistryAccessToken=exports.createProject=exports.PROJECT_EDITIONS=exports.EVALUATION_OFFER_CODES=exports.isPermissionDenied=exports.isConsoleConflict=exports.ConsoleApiTransportError=exports.ConsoleApiError=exports.ConsoleApi=exports.refreshSession=exports.loginWithBrowser=exports.ConsoleTokenGrantError=void 0,exports.withConsoleSessionLock=exports.resolveStoredConsoleToken=exports.refreshStoredConsoleToken=exports.loginAndStoreConsoleToken=exports.registryUrl=exports.registryLoginUrl=exports.registryAuthTokenKey=exports.REGISTRY_SCOPE=void 0;var e=require("./browser-auth");Object.defineProperty(exports,"ConsoleTokenGrantError",{enumerable:!0,get:function(){return e.ConsoleTokenGrantError}}),Object.defineProperty(exports,"loginWithBrowser",{enumerable:!0,get:function(){return e.loginWithBrowser}}),Object.defineProperty(exports,"refreshSession",{enumerable:!0,get:function(){return e.refreshSession}});var r=require("./console-api");Object.defineProperty(exports,"ConsoleApi",{enumerable:!0,get:function(){return r.ConsoleApi}}),Object.defineProperty(exports,"ConsoleApiError",{enumerable:!0,get:function(){return r.ConsoleApiError}}),Object.defineProperty(exports,"ConsoleApiTransportError",{enumerable:!0,get:function(){return r.ConsoleApiTransportError}}),Object.defineProperty(exports,"isConsoleConflict",{enumerable:!0,get:function(){return r.isConsoleConflict}}),Object.defineProperty(exports,"isPermissionDenied",{enumerable:!0,get:function(){return r.isPermissionDenied}});var t=require("./console-projects");Object.defineProperty(exports,"EVALUATION_OFFER_CODES",{enumerable:!0,get:function(){return t.EVALUATION_OFFER_CODES}}),Object.defineProperty(exports,"PROJECT_EDITIONS",{enumerable:!0,get:function(){return t.PROJECT_EDITIONS}}),Object.defineProperty(exports,"createProject",{enumerable:!0,get:function(){return t.createProject}}),Object.defineProperty(exports,"createRegistryAccessToken",{enumerable:!0,get:function(){return t.createRegistryAccessToken}}),Object.defineProperty(exports,"evaluationDenial",{enumerable:!0,get:function(){return t.evaluationDenial}}),Object.defineProperty(exports,"getProjectEvaluation",{enumerable:!0,get:function(){return t.getProjectEvaluation}}),Object.defineProperty(exports,"getRegistryAccess",{enumerable:!0,get:function(){return t.getRegistryAccess}}),Object.defineProperty(exports,"linkProject",{enumerable:!0,get:function(){return t.linkProject}}),Object.defineProperty(exports,"listProjectEditions",{enumerable:!0,get:function(){return t.listProjectEditions}}),Object.defineProperty(exports,"listRegistryAccessTokens",{enumerable:!0,get:function(){return t.listRegistryAccessTokens}}),Object.defineProperty(exports,"readViewerAccount",{enumerable:!0,get:function(){return t.readViewerAccount}}),Object.defineProperty(exports,"rotateRegistryAccessToken",{enumerable:!0,get:function(){return t.rotateRegistryAccessToken}}),Object.defineProperty(exports,"startProjectEvaluation",{enumerable:!0,get:function(){return t.startProjectEvaluation}});var o=require("./credential-store");Object.defineProperty(exports,"consoleConfigDir",{enumerable:!0,get:function(){return o.consoleConfigDir}}),Object.defineProperty(exports,"consoleCredentialPath",{enumerable:!0,get:function(){return o.consoleCredentialPath}}),Object.defineProperty(exports,"isExpired",{enumerable:!0,get:function(){return o.isExpired}}),Object.defineProperty(exports,"readConsoleCredential",{enumerable:!0,get:function(){return o.readConsoleCredential}}),Object.defineProperty(exports,"readConsoleSessionStatus",{enumerable:!0,get:function(){return o.readConsoleSessionStatus}}),Object.defineProperty(exports,"writeConsoleCredential",{enumerable:!0,get:function(){return o.writeConsoleCredential}});var n=require("./onboarding");Object.defineProperty(exports,"ConsoleOnboardingCancelled",{enumerable:!0,get:function(){return n.ConsoleOnboardingCancelled}}),Object.defineProperty(exports,"acquireRegistryAccess",{enumerable:!0,get:function(){return n.acquireRegistryAccess}}),Object.defineProperty(exports,"establishProjectLink",{enumerable:!0,get:function(){return n.establishProjectLink}}),Object.defineProperty(exports,"projectCreateIdempotencyKey",{enumerable:!0,get:function(){return n.projectCreateIdempotencyKey}}),Object.defineProperty(exports,"registryAccessTokenName",{enumerable:!0,get:function(){return n.registryAccessTokenName}}),Object.defineProperty(exports,"selectConsoleProject",{enumerable:!0,get:function(){return n.selectConsoleProject}}),Object.defineProperty(exports,"writeProjectLink",{enumerable:!0,get:function(){return n.writeProjectLink}});var s=require("./origins");Object.defineProperty(exports,"DEFAULT_CONSOLE_API_ORIGIN",{enumerable:!0,get:function(){return s.DEFAULT_CONSOLE_API_ORIGIN}}),Object.defineProperty(exports,"DEFAULT_CONSOLE_APP_ORIGIN",{enumerable:!0,get:function(){return s.DEFAULT_CONSOLE_APP_ORIGIN}}),Object.defineProperty(exports,"consoleApiOrigin",{enumerable:!0,get:function(){return s.consoleApiOrigin}}),Object.defineProperty(exports,"consoleAppOrigin",{enumerable:!0,get:function(){return s.consoleAppOrigin}}),Object.defineProperty(exports,"consoleOrigins",{enumerable:!0,get:function(){return s.consoleOrigins}});var i=require("./product-access");Object.defineProperty(exports,"getProductAccessSummary",{enumerable:!0,get:function(){return i.getProductAccessSummary}});var c=require("./project-link-manifest");Object.defineProperty(exports,"PROJECT_LINK_IGNORE_RULE",{enumerable:!0,get:function(){return c.PROJECT_LINK_IGNORE_RULE}}),Object.defineProperty(exports,"PROJECT_LINK_KEEP_RULE",{enumerable:!0,get:function(){return c.PROJECT_LINK_KEEP_RULE}}),Object.defineProperty(exports,"PROJECT_LINK_MANIFEST_RELATIVE_PATH",{enumerable:!0,get:function(){return c.PROJECT_LINK_MANIFEST_RELATIVE_PATH}}),Object.defineProperty(exports,"applyProjectLinkGitignoreRules",{enumerable:!0,get:function(){return c.applyProjectLinkGitignoreRules}}),Object.defineProperty(exports,"ensureProjectLinkGitignore",{enumerable:!0,get:function(){return c.ensureProjectLinkGitignore}}),Object.defineProperty(exports,"parseProjectLinkManifest",{enumerable:!0,get:function(){return c.parseProjectLinkManifest}}),Object.defineProperty(exports,"projectLinkManifestPath",{enumerable:!0,get:function(){return c.projectLinkManifestPath}}),Object.defineProperty(exports,"readProjectLinkManifest",{enumerable:!0,get:function(){return c.readProjectLinkManifest}}),Object.defineProperty(exports,"writeProjectLinkManifest",{enumerable:!0,get:function(){return c.writeProjectLinkManifest}});var u=require("./registry");Object.defineProperty(exports,"DEFAULT_REGISTRY_URL",{enumerable:!0,get:function(){return u.DEFAULT_REGISTRY_URL}}),Object.defineProperty(exports,"REGISTRY_SCOPE",{enumerable:!0,get:function(){return u.REGISTRY_SCOPE}}),Object.defineProperty(exports,"registryAuthTokenKey",{enumerable:!0,get:function(){return u.registryAuthTokenKey}}),Object.defineProperty(exports,"registryLoginUrl",{enumerable:!0,get:function(){return u.registryLoginUrl}}),Object.defineProperty(exports,"registryUrl",{enumerable:!0,get:function(){return u.registryUrl}});var p=require("./session");Object.defineProperty(exports,"loginAndStoreConsoleToken",{enumerable:!0,get:function(){return p.loginAndStoreConsoleToken}}),Object.defineProperty(exports,"refreshStoredConsoleToken",{enumerable:!0,get:function(){return p.refreshStoredConsoleToken}}),Object.defineProperty(exports,"resolveStoredConsoleToken",{enumerable:!0,get:function(){return p.resolveStoredConsoleToken}});var l=require("./session-lock");Object.defineProperty(exports,"withConsoleSessionLock",{enumerable:!0,get:function(){return l.withConsoleSessionLock}});

package/dist/onboarding.d.ts

@@ -0,0 +1,158 @@
+import { ConsoleApi } from './console-api';
+import { type ConsoleProjectEdition, type EvaluationOfferCode, type ProjectEdition, type ProjectEditionSource } from './console-projects';
+import { type ProjectLinkManifest } from './project-link-manifest';
+/**
+ * The person stopped the flow. Distinct from a failure: nothing is wrong, and
+ * neither `create` nor `vendure console link` should report an error or leave a
+ * half-written manifest behind.
+ */
+export declare class ConsoleOnboardingCancelled extends Error {
+    constructor(message?: string);
+}
+/**
+ * Everything the flow has to ask a person, as calls rather than prompts.
+ *
+ * The flow lives here so `create` and `vendure console link` establish the same
+ * link the same way. The prompting does not: `create` draws with
+ * `@clack/prompts` and the CLI plugin draws with the Vendure CLI reporter, and
+ * pulling either one in here would put a prompt library into both.
+ *
+ * Any method may throw `ConsoleOnboardingCancelled`.
+ */
+export interface ConsoleOnboardingInteraction {
+    /**
+     * Which Project this checkout is. Returning `undefined` means "none of
+     * these", which creates one.
+     */
+    chooseProject(projects: ConsoleProjectEdition[]): Promise<ConsoleProjectEdition | undefined>;
+    /** The name for a new Project. */
+    newProjectName(): Promise<string>;
+    /**
+     * Which edition to evaluate, from the Offers Console says this Project is
+     * eligible for. Returning `undefined` declines, which is an ordinary answer.
+     */
+    chooseEvaluation(offers: EvaluationOfferCode[]): Promise<EvaluationOfferCode | undefined>;
+    report(message: string): void;
+    warn(message: string): void;
+}
+export interface EstablishProjectLinkOptions {
+    projectRoot: string;
+    api: ConsoleApi;
+    interaction: ConsoleOnboardingInteraction;
+    /**
+     * Keep a Project Link Manifest that is already there and still names a
+     * Project the account owns, instead of creating a second link for the same
+     * checkout. This is what makes a repeated `vendure console link` a repair:
+     * the link identity survives and only the missing credential is replaced.
+     */
+    reuseExistingLink?: boolean;
+    /**
+     * Sent as `Idempotency-Key` when a Project is created. Defaults to a value
+     * derived from the checkout and the chosen name, which is what makes a
+     * repeat after a lost response return the first Project instead of making a
+     * second one. A random key per run would not: the run that lost the
+     * response is the run that has to be repeated.
+     */
+    idempotencyKey?: string;
+}
+export interface EstablishedProjectLink {
+    manifest: ProjectLinkManifest;
+    edition: ProjectEdition | null;
+    source: ProjectEditionSource;
+    /** The Project was created by this run. */
+    createdProject: boolean;
+    /** An existing Manifest was kept rather than a new link created. */
+    reusedLink: boolean;
+}
+export interface SelectedConsoleProject {
+    project: ConsoleProjectEdition;
+    edition: ProjectEdition | null;
+    source: ProjectEditionSource;
+    /** The Project was created by this run rather than chosen from the account. */
+    createdProject: boolean;
+}
+/**
+ * Decide which Console Project this is, creating one and giving it an edition
+ * when it needs them.
+ *
+ * Writes no local file, and is not a preflight: answering "create a new one"
+ * creates a Project in Console, and accepting an Offer starts an Evaluation.
+ * Both outlive the run that made them, so a caller that may not commit to a
+ * Project must not call this.
+ *
+ * Split from writing the link because `@vendure-platform/create` needs the
+ * answer before the directory it would write into exists: the edition decides
+ * which facade, options and services get scaffolded, and the manifest can only
+ * be written once there is somewhere to put it. `vendure console link` runs
+ * both halves back to back through `establishProjectLink`.
+ */
+export declare function selectConsoleProject(options: Pick<EstablishProjectLinkOptions, 'api' | 'interaction' | 'projectRoot' | 'idempotencyKey'>): Promise<SelectedConsoleProject>;
+/**
+ * Create an approved link for `projectId` and write its Manifest into
+ * `projectRoot`, with the `.gitignore` rules that keep the manifest committed
+ * and the credential files out.
+ */
+export declare function writeProjectLink(options: Pick<EstablishProjectLinkOptions, 'api' | 'interaction' | 'projectRoot'> & {
+    projectId: string;
+}): Promise<ProjectLinkManifest>;
+/**
+ * Establish the link between this checkout and a Console Project, and write the
+ * Project Link Manifest.
+ *
+ * Creates a Project and starts an Evaluation when the answers call for it, the
+ * same way `selectConsoleProject` does.
+ *
+ * Writes no credential of either kind. The caller decides which stores it owns:
+ * the account-level Console session is already written by the login that got
+ * the token this runs on, and the project-scoped Environment Credential belongs
+ * to `@vendure-platform/cli`, which is the only package that may write it.
+ */
+export declare function establishProjectLink(options: EstablishProjectLinkOptions): Promise<EstablishedProjectLink>;
+export interface RegistryAccessInteraction {
+    /**
+     * Whether to rotate the named Access Token. Asked only when a token of the
+     * expected name already exists and its secret is not held locally, because
+     * rotating invalidates whatever is installing with it today.
+     */
+    confirmRotate(tokenName: string): Promise<boolean>;
+    report(message: string): void;
+    warn(message: string): void;
+}
+export interface RegistryAccessResult {
+    registryUrl: string;
+    scope: string;
+    /** The plaintext token, when one was issued. Console returns it once. */
+    token?: string;
+    /** Set when no token could be issued and the person has to log in to the Registry. */
+    fallback?: 'npm-login';
+}
+/**
+ * The key a repeated create sends, derived from the checkout and the name.
+ *
+ * Console scopes the key by account, user and name, and answers a repeat that
+ * carries a different name with `project.idempotency_conflict`. Deriving the key
+ * from both means the same answer to the same question is safe to repeat, and a
+ * different answer is a different question.
+ */
+export declare function projectCreateIdempotencyKey(projectRoot: string, name: string): string;
+/** The Access Token name a machine claims, so a repeat finds its own token rather than making a second one. */
+export declare function registryAccessTokenName(host?: string): string;
+/**
+ * Get the Registry configuration and, when the session is allowed to, a scoped
+ * Access Token for this machine.
+ *
+ * The create route returns the plaintext once and never again, so a lost
+ * response leaves a token that exists in Console and nowhere else. Creating a
+ * second one under the same name is refused with
+ * `registry_access_token.name_taken`. The recovery is to find the token of that
+ * name in the list and rotate it, which is the only way back to a usable
+ * secret. Rotating invalidates the old one, so it is never done without asking.
+ */
+export declare function acquireRegistryAccess(options: {
+    api: ConsoleApi;
+    projectId: string;
+    tokenName?: string;
+    interaction: RegistryAccessInteraction;
+    defaultRegistryUrl: string;
+    defaultScope: string;
+}): Promise<RegistryAccessResult>;

package/dist/onboarding.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ConsoleOnboardingCancelled=void 0,exports.selectConsoleProject=a,exports.writeProjectLink=s,exports.establishProjectLink=c,exports.projectCreateIdempotencyKey=m,exports.registryAccessTokenName=w,exports.acquireRegistryAccess=g;const e=require("node:crypto"),t=require("node:os"),n=require("node:path"),i=require("./console-api"),o=require("./console-projects"),r=require("./project-link-manifest");class ConsoleOnboardingCancelled extends Error{constructor(e="Vendure Console setup was cancelled."){super(e),this.name="ConsoleOnboardingCancelled"}}async function a(e){const t=await(0,o.listProjectEditions)(e.api),n=t.length>0?await e.interaction.chooseProject(t):void 0,i=null!=n?n:await d(e);return{project:i,...await u(e,i),createdProject:void 0===n}}async function s(e){const t=await(0,o.linkProject)(e.api,e.projectId);return await(0,r.writeProjectLinkManifest)(e.projectRoot,t),await p(e.projectRoot,e.interaction),t}async function c(e){if(e.reuseExistingLink){const t=await l(e);if(t)return t}const t=await a(e);return{manifest:await s({...e,projectId:t.project.id}),edition:t.edition,source:t.source,createdProject:t.createdProject,reusedLink:!1}}async function l(e){const t=await(0,r.readProjectLinkManifest)(e.projectRoot);if("invalid"===t.status)return void e.interaction.warn(`${t.reason} Linking this project again.`);if("missing"===t.status)return;const n=(await(0,o.listProjectEditions)(e.api)).find(e=>e.id===t.manifest.project.id);if(n)return e.interaction.report(`Already linked to ${t.manifest.project.name} in ${t.manifest.account.name}.`),{manifest:t.manifest,edition:n.edition,source:n.source,createdProject:!1,reusedLink:!0};e.interaction.warn(`${t.manifest.project.name} is no longer an active Project on this account. Linking this project again.`)}async function d(e){var t;const n=(await e.interaction.newProjectName()).trim();if(!n)throw new ConsoleOnboardingCancelled("No Project name was given.");let r;try{r=await(0,o.createProject)(e.api,{name:n,idempotencyKey:null!==(t=e.idempotencyKey)&&void 0!==t?t:m(e.projectRoot,n)})}catch(e){if((0,i.isPermissionDenied)(e))throw new Error('This Console session cannot create Projects. Ask an administrator for the "console:project:create" Permission, or create the Project in Vendure Console and run this again.');if((0,i.isConsoleConflict)(e,"project.idempotency_conflict"))throw new Error("A Project was already created for this setup under a different name. Open Vendure Console, then run this again and select it.");throw e}if("active"!==r.state)throw new Error(`The Project "${r.name}" is archived. Restore it in Vendure Console, or run this again with a different name.`);return e.interaction.report(`Created the Project ${r.name}.`),{id:r.id,name:r.name,edition:null,source:"none"}}async function u(e,t){if(t.edition)return e.interaction.report(`${t.name} is on the ${t.edition} edition.`),{edition:t.edition,source:t.source};let n;try{n=await(0,o.getProjectEvaluation)(e.api,t.id)}catch(n){if(!(0,i.isPermissionDenied)(n))throw n;return e.interaction.warn(`${t.name} has no edition yet, and this Console session cannot read its Evaluation eligibility.`),{edition:null,source:t.source}}if("available"!==n.startState||0===n.offerCodes.length)return e.interaction.warn(`${t.name} has no edition yet and cannot start an Evaluation${n.nextEligibleAt?` before ${n.nextEligibleAt}`:""}. Choose a plan in Vendure Console.`),{edition:null,source:t.source};const r=await e.interaction.chooseEvaluation(n.offerCodes);if(!r)return{edition:null,source:t.source};try{return await f(e,t,r)?{edition:r,source:"evaluation"}:{edition:null,source:t.source}}catch(n){if(!(0,i.isPermissionDenied)(n))throw n;return e.interaction.warn('This Console session cannot start an Evaluation. Ask an administrator for the "console:evaluation:manage" Permission.'),{edition:null,source:t.source}}}async function f(e,t,n){try{const i=await(0,o.startProjectEvaluation)(e.api,t.id,n);return e.interaction.report("existing"===i.outcome?`${t.name} already has a ${i.offerCode} Evaluation, ending ${i.expiresAt}.`:`Started a ${i.offerCode} Evaluation on ${t.name}, ending ${i.expiresAt}.`),!0}catch(t){const n=(0,o.evaluationDenial)(t);if(!n)throw t;return e.interaction.warn(`${n.message}${n.nextEligibleAt?` Next eligible ${n.nextEligibleAt}.`:""}`),!1}}async function p(e,t){const n=await(0,r.ensureProjectLinkGitignore)(e);"failed"===n.kind&&t.warn(`Could not update ${n.path}: ${n.reason}. Ignore .vendure/* and commit .vendure/project.json by hand.`)}function m(t,i){return(0,e.createHash)("sha256").update(`${(0,n.resolve)(t)}\0${i}`).digest("hex").slice(0,32)}function w(e=(0,t.hostname)()){return`vendure-cli ${e}`.slice(0,120)}async function g(e){var t;const{api:n,projectId:r,interaction:a}=e,s=null!==(t=e.tokenName)&&void 0!==t?t:w();let c={registryUrl:e.defaultRegistryUrl,scope:e.defaultScope};try{c=await(0,o.getRegistryAccess)(n,r)}catch(e){if(!(0,i.isPermissionDenied)(e))throw e;return{...c,fallback:"npm-login"}}try{const e=await(0,o.createRegistryAccessToken)(n,r,s);return a.report(`Issued the Registry Access Token "${e.name}".`),{...c,token:e.token}}catch(e){if((0,i.isPermissionDenied)(e))return{...c,fallback:"npm-login"};if(!(0,i.isConsoleConflict)(e,"registry_access_token.name_taken"))throw e}const l=(await(0,o.listRegistryAccessTokens)(n,r)).find(e=>"active"===e.state&&e.name.toLowerCase()===s.toLowerCase());if(!l)return a.warn(`A Registry Access Token named "${s}" already exists but is not active. Rotate it in Vendure Console.`),{...c,fallback:"npm-login"};if(a.warn(`A Registry Access Token named "${s}" already exists. Its secret is shown once and cannot be read again, so getting a usable one means rotating it, which stops the existing one working.`),!await a.confirmRotate(l.name))return{...c,fallback:"npm-login"};const d=await(0,o.rotateRegistryAccessToken)(n,r,l.id);return a.report(`Rotated the Registry Access Token "${d.name}".`),{...c,token:d.token}}exports.ConsoleOnboardingCancelled=ConsoleOnboardingCancelled;

package/dist/origins.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The Console web app. This is the only origin a login may open in a browser:
+ * the user signs in to Console, not to the API and not to an identity provider
+ * the CLI picked. Anchoring the visible entry point here means the address bar
+ * shows a host the user already trusts.
+ */
+export declare const DEFAULT_CONSOLE_APP_ORIGIN = "https://console.vendure.io";
+/** The Console API. Only the token exchange talks to it, never the browser. */
+export declare const DEFAULT_CONSOLE_API_ORIGIN = "https://api.vendure.io";
+/** Hosts `consoleApiOrigin` accepts, so a caller can name them without restating them. */
+export declare const TRUSTED_API_HOSTS: string[];
+/** The Console web app origin a login may open. Loopback is allowed for dev and tests. */
+export declare function consoleAppOrigin(value?: string): string;
+/** The Console API origin the token exchange may call. */
+export declare function consoleApiOrigin(value?: string): string;
+/** Select the matching remote Console app and API, while allowing explicit local development origins. */
+export declare function consoleOrigins(options: {
+    appOrigin?: string;
+    apiOrigin?: string;
+}): {
+    appOrigin: string;
+    apiOrigin: string;
+};

package/dist/origins.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TRUSTED_API_HOSTS=exports.DEFAULT_CONSOLE_API_ORIGIN=exports.DEFAULT_CONSOLE_APP_ORIGIN=void 0,exports.consoleAppOrigin=i,exports.consoleApiOrigin=s,exports.consoleOrigins=p,exports.DEFAULT_CONSOLE_APP_ORIGIN="https://console.vendure.io",exports.DEFAULT_CONSOLE_API_ORIGIN="https://api.vendure.io";const e="https://staging.console.vendure.io",o="https://staging.api.vendure.io",n=["console.vendure.io","staging.console.vendure.io"];function t(e){return["localhost","127.0.0.1","::1"].includes(e)||e.endsWith(".localhost")}function r(e,o,n){let r;try{r=new URL(e)}catch{throw new Error(`The ${n} URL is invalid.`)}const i=o.includes(r.hostname),s=t(r.hostname);if(!i&&!s||i&&"https:"!==r.protocol||s&&!["http:","https:"].includes(r.protocol)||r.username||r.password||"/"!==r.pathname||r.search||r.hash)throw new Error(`The ${n} URL is not trusted.`);return r.origin}function i(e=exports.DEFAULT_CONSOLE_APP_ORIGIN){return r(e,n,"Vendure Console")}function s(e=exports.DEFAULT_CONSOLE_API_ORIGIN){return r(e,exports.TRUSTED_API_HOSTS,"Vendure Console API")}function p(n){var t;const r=void 0===n.appOrigin?void 0:i(n.appOrigin),p=s(null!==(t=n.apiOrigin)&&void 0!==t?t:r===e?o:void 0),O=null!=r?r:p===o?e:exports.DEFAULT_CONSOLE_APP_ORIGIN;if(O===exports.DEFAULT_CONSOLE_APP_ORIGIN&&p===o||O===e&&p===exports.DEFAULT_CONSOLE_API_ORIGIN)throw new Error("The Vendure Console app and API origins must belong to the same environment.");return{appOrigin:O,apiOrigin:p}}exports.TRUSTED_API_HOSTS=["api.vendure.io","staging.api.vendure.io"];

package/dist/product-access.d.ts

@@ -0,0 +1,48 @@
+import type { ConsoleApi } from './console-api';
+import type { ProjectEditionSource } from './console-projects';
+/**
+ * `GET /v1/projects/:id/product-access/summary`.
+ *
+ * The one answer to "what may this Project use, and why", at one instant.
+ * Console resolves the precedence between a support override, a subscription
+ * and an Evaluation before it answers, so a reader never repeats those rules.
+ *
+ * Read-only, and the only Console call an edition preflight needs to decide
+ * whether a target edition is already paid for. `listProjectEditions` answers a
+ * smaller question: it names the edition, not the Capability set behind it, nor
+ * the billing phase that is about to take the access away.
+ *
+ * Nothing here authorizes anything. The signed Entitlement Grant the running
+ * server verifies is the authorization source; this is what the operator is
+ * entitled to buy into and deploy.
+ */
+export interface ProductAccessSummary {
+    /** Where the access comes from. `none` means the Project has no access. */
+    source: ProjectEditionSource;
+    /** The Product Offer behind the access, or null when a bare override granted Capabilities. */
+    offerCode: string | null;
+    /** Every Capability key the Project may use. */
+    capabilities: readonly string[];
+    /** `non_production` access cannot carry a production deployment. */
+    environmentScope: 'all' | 'non_production';
+    /** Earliest moment this answer can change. Not a display date. */
+    validUntil: string | null;
+    evaluation: ProductAccessEvaluation | null;
+    subscription: ProductAccessSubscription | null;
+    /** Registry access ends here while a subscription is in its cure period. */
+    cureEndsAt: string | null;
+    /** Runtime access ends here while a subscription is in cure or grace. */
+    graceEndsAt: string | null;
+}
+export interface ProductAccessEvaluation {
+    offerCode: string;
+    status: 'active' | 'expired';
+    expiresAt: string;
+}
+export interface ProductAccessSubscription {
+    offerCode: string;
+    /** `paid` is the healthy phase. The rest are on the way to losing access. */
+    accessPhase: 'paid' | 'cure' | 'runtime_grace' | 'none';
+    endsAt: string | null;
+}
+export declare function getProductAccessSummary(api: ConsoleApi, projectId: string): Promise<ProductAccessSummary>;

package/dist/product-access.js

@@ -0,0 +1 @@
+"use strict";async function e(e,o){const c=r(await e.request(`/v1/projects/${encodeURIComponent(o)}/product-access/summary`),"the Product Access summary");if(!Array.isArray(c.capabilities))throw a("the granted Capability list");return{source:i(c.source,["override","subscription","evaluation","none"],"a Product Access source"),offerCode:s(c.offerCode,"a Product Offer code"),capabilities:c.capabilities.filter(e=>"string"==typeof e),environmentScope:i(c.environmentScope,["all","non_production"],"an environment scope"),validUntil:s(c.validUntil,"a Product Access expiry"),evaluation:null==c.evaluation?null:t(c.evaluation),subscription:null==c.subscription?null:n(c.subscription),cureEndsAt:s(c.cureEndsAt,"a cure deadline"),graceEndsAt:s(c.graceEndsAt,"a grace deadline")}}function t(e){const t=r(e,"the Evaluation state");return{offerCode:o(t.offerCode,"an Evaluation offer"),status:i(t.status,["active","expired"],"an Evaluation status"),expiresAt:o(t.expiresAt,"an Evaluation expiry")}}function n(e){const t=r(e,"the subscription state");return{offerCode:o(t.offerCode,"a subscription offer"),accessPhase:i(t.accessPhase,["paid","cure","runtime_grace","none"],"a subscription access phase"),endsAt:s(t.endsAt,"a subscription end")}}function r(e,t){if(!e||"object"!=typeof e||Array.isArray(e))throw a(t);return e}function o(e,t){if("string"!=typeof e||0===e.length)throw a(t);return e}function s(e,t){return null==e?null:o(e,t)}function i(e,t,n){if("string"!=typeof e||!t.includes(e))throw a(n);return e}function a(e){return new Error(`Vendure Console returned ${e} in an unexpected shape.`)}Object.defineProperty(exports,"__esModule",{value:!0}),exports.getProductAccessSummary=e;

package/dist/project-link-manifest.d.ts

@@ -0,0 +1,93 @@
+/**
+ * The Project Link Manifest, `<projectRoot>/.vendure/project.json`.
+ *
+ * Identity metadata and nothing else. It names the Project and the Customer
+ * Account a checkout belongs to, so it is meant to be committed, and it holds
+ * no secret of either kind: the account-level Console session lives under
+ * `~/.vendure` and the project-scoped Environment Credential lives beside this
+ * file in `.vendure/credentials.json`.
+ *
+ * The shape is Console's `ProjectLinkManifestDto` and is also what
+ * `vendure console link` writes in `@vendure/cli`, so a manifest written by
+ * either tool reads in both.
+ */
+export interface ProjectLinkManifest {
+    schemaVersion: 1;
+    project: {
+        id: string;
+        name: string;
+    };
+    account: {
+        id: string;
+        name: string;
+    };
+    link: {
+        id: string;
+        protocolVersion: 1;
+    };
+}
+export type ProjectLinkManifestRead = {
+    status: 'missing';
+    path: string;
+} | {
+    status: 'invalid';
+    path: string;
+    reason: string;
+} | {
+    status: 'valid';
+    path: string;
+    manifest: ProjectLinkManifest;
+};
+export declare const PROJECT_LINK_MANIFEST_RELATIVE_PATH: string;
+/**
+ * `.vendure/*` is ignored and the manifest is un-ignored, so a checkout commits
+ * the identity metadata and never the two credential files that sit next to it.
+ * Both lines match `@vendure/cli`'s own rules exactly, so the two tools do not
+ * fight over the same `.gitignore`.
+ */
+export declare const PROJECT_LINK_IGNORE_RULE: string;
+export declare const PROJECT_LINK_KEEP_RULE: string;
+export declare function projectLinkManifestPath(projectRoot: string): string;
+/**
+ * Read the manifest without throwing.
+ *
+ * The three outcomes are acted on differently, so they are reported
+ * separately: a missing manifest is an unlinked project, an invalid one is a
+ * file a person may have edited, and only the third can be trusted.
+ */
+export declare function readProjectLinkManifest(projectRoot: string): Promise<ProjectLinkManifestRead>;
+/** Validate a manifest Console returned, or throw. */
+export declare function parseProjectLinkManifest(value: unknown): ProjectLinkManifest;
+/**
+ * Write the manifest through a temporary file and a rename, so a reader never
+ * observes a half-written one. The temporary file is opened `wx` at 0600, which
+ * matches what `vendure console link` in `@vendure/cli` writes.
+ */
+export declare function writeProjectLinkManifest(projectRoot: string, manifest: ProjectLinkManifest): Promise<string>;
+export type ProjectLinkGitignoreResult = {
+    kind: 'unchanged';
+    path: string;
+} | {
+    kind: 'created';
+    path: string;
+} | {
+    kind: 'updated';
+    path: string;
+} | {
+    kind: 'failed';
+    path: string;
+    reason: string;
+};
+/**
+ * Make sure `.gitignore` ignores everything under `.vendure` except the
+ * manifest. Never throws: a checkout that is not a git repository, or one whose
+ * `.gitignore` cannot be written, is not a reason to fail a link that already
+ * succeeded.
+ */
+export declare function ensureProjectLinkGitignore(projectRoot: string): Promise<ProjectLinkGitignoreResult>;
+/**
+ * Add the two rules to `content`, replacing a blanket `.vendure` rule if one is
+ * already there. A scaffold that ignores the whole directory would otherwise
+ * keep the manifest out of the repository, which is the opposite of the intent.
+ */
+export declare function applyProjectLinkGitignoreRules(content: string): string;

package/dist/project-link-manifest.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PROJECT_LINK_KEEP_RULE=exports.PROJECT_LINK_IGNORE_RULE=exports.PROJECT_LINK_MANIFEST_RELATIVE_PATH=void 0,exports.projectLinkManifestPath=s,exports.readProjectLinkManifest=a,exports.parseProjectLinkManifest=c,exports.writeProjectLinkManifest=E,exports.ensureProjectLinkGitignore=u,exports.applyProjectLinkGitignoreRules=p;const t=require("node:crypto"),e=require("node:fs/promises"),n=require("node:path");exports.PROJECT_LINK_MANIFEST_RELATIVE_PATH=(0,n.join)(".vendure","project.json");const r=exports.PROJECT_LINK_MANIFEST_RELATIVE_PATH.split(n.sep).join("/"),i=n.posix.dirname(r);exports.PROJECT_LINK_IGNORE_RULE=`${i}/*`,exports.PROJECT_LINK_KEEP_RULE=`!${r}`;const o=/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;function s(t){return(0,n.join)(t,exports.PROJECT_LINK_MANIFEST_RELATIVE_PATH)}async function a(t){const n=s(t);let r,i;try{r=await(0,e.readFile)(n,"utf8")}catch(t){return t instanceof Error&&"code"in t&&"ENOENT"===t.code?{status:"missing",path:n}:{status:"invalid",path:n,reason:"The Project Link Manifest could not be read."}}try{i=JSON.parse(r)}catch{return{status:"invalid",path:n,reason:"The Project Link Manifest is not valid JSON."}}return d(i)?{status:"valid",path:n,manifest:i}:{status:"invalid",path:n,reason:"The Project Link Manifest has an unsupported or malformed structure."}}function c(t){if(!d(t))throw new Error("Vendure Console returned a malformed Project Link Manifest.");return t}async function E(r,i){c(i);const o=s(r),a=(0,n.join)(r,".vendure"),E=(0,n.join)(a,`.project-${(0,t.randomUUID)()}.tmp`);let u;try{await(0,e.mkdir)(a,{recursive:!0}),u=await(0,e.open)(E,"wx",384),await u.writeFile(`${JSON.stringify(i,null,2)}\n`,"utf8"),await u.sync(),await u.close(),u=void 0,await(0,e.rename)(E,o)}catch{throw await(null==u?void 0:u.close().catch(()=>{})),await(0,e.unlink)(E).catch(()=>{}),new Error("Could not write the Project Link Manifest.")}return o}async function u(t){const r=(0,n.join)(t,".gitignore");try{let t;try{t=await(0,e.readFile)(r,"utf8")}catch(t){if(!(t instanceof Error&&"code"in t&&"ENOENT"===t.code))throw t;return await(0,e.writeFile)(r,`${exports.PROJECT_LINK_IGNORE_RULE}\n${exports.PROJECT_LINK_KEEP_RULE}\n`,"utf8"),{kind:"created",path:r}}const n=p(t);return n===t?{kind:"unchanged",path:r}:(await(0,e.writeFile)(r,n,"utf8"),{kind:"updated",path:r})}catch(t){return{kind:"failed",path:r,reason:t instanceof Error?t.message:String(t)}}}function p(t){const e=t.includes("\r\n")?"\r\n":"\n",n=t.split(/\r?\n/);if(n.includes(exports.PROJECT_LINK_IGNORE_RULE)&&n.includes(exports.PROJECT_LINK_KEEP_RULE))return t;const r=n.findIndex(t=>t===i||t===`${i}/`);if(-1!==r)return n.splice(r,1,exports.PROJECT_LINK_IGNORE_RULE,exports.PROJECT_LINK_KEEP_RULE),n.join(e);let o=t;return o.length>0&&!o.endsWith("\n")&&(o+=e),o.length>0&&!/(?:\r?\n){2}$/.test(o)&&(o+=e),`${o}${exports.PROJECT_LINK_IGNORE_RULE}${e}${exports.PROJECT_LINK_KEEP_RULE}${e}`}function d(t){return!!l(t,["schemaVersion","project","account","link"])&&1===t.schemaVersion&&_(t.project)&&_(t.account)&&l(t.link,["id","protocolVersion"])&&"string"==typeof t.link.id&&o.test(t.link.id)&&1===t.link.protocolVersion}function _(t){return l(t,["id","name"])&&"string"==typeof t.id&&o.test(t.id)&&"string"==typeof t.name&&t.name.trim().length>0}function l(t,e){if(!t||"object"!=typeof t||Array.isArray(t))return!1;const n=Object.keys(t);return n.length===e.length&&n.every(t=>e.includes(t))}

package/dist/registry.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The Vendure Platform registry, in one place.
+ *
+ * Both `@vendure-platform/create` and `vendure console link` write a project
+ * `.npmrc`, so both need this. It lives here rather than in either of them
+ * because a second copy is a second thing to change at the next rename.
+ *
+ * This is the fallback. A caller that reaches Console asks
+ * `GET /v1/projects/:id/registry-access` and uses the origin it answers with,
+ * because that is the origin the Access Token it issues is good for.
+ */
+export declare const DEFAULT_REGISTRY_URL = "https://registry.vendure.io/";
+/** The npm scope the registry distributes. */
+export declare const REGISTRY_SCOPE = "@vendure-platform";
+/**
+ * The registry to write, honouring `VENDURE_REGISTRY_URL`. That override points
+ * a scaffold or a link at a local Verdaccio without patching the result
+ * afterwards, which is how the create-flow harness runs.
+ */
+export declare function registryUrl(env?: NodeJS.ProcessEnv): string;
+/** `url` without its trailing slash, which is how npm commands read best. */
+export declare function registryLoginUrl(url?: string): string;
+/**
+ * The line prefix npm looks a registry credential up by.
+ *
+ * The port is part of the key, so a registry on one derives from `host` rather
+ * than `hostname`. Dropping it writes a line npm never reads, which is how a
+ * scaffold against a local registry installs unauthenticated.
+ */
+export declare function registryAuthTokenKey(url?: string): string;

package/dist/registry.js

@@ -0,0 +1 @@
+"use strict";function e(e=process.env){var r;return(null===(r=e.VENDURE_REGISTRY_URL)||void 0===r?void 0:r.trim())||exports.DEFAULT_REGISTRY_URL}function r(r=e()){return r.replace(/\/+$/,"")}function t(r=e()){return`//${new URL(r).host}/:_authToken=`}Object.defineProperty(exports,"__esModule",{value:!0}),exports.REGISTRY_SCOPE=exports.DEFAULT_REGISTRY_URL=void 0,exports.registryUrl=e,exports.registryLoginUrl=r,exports.registryAuthTokenKey=t,exports.DEFAULT_REGISTRY_URL="https://registry.vendure.io/",exports.REGISTRY_SCOPE="@vendure-platform";

package/dist/session-lock.d.ts

@@ -0,0 +1,49 @@
+/**
+ * How long a lock file may sit untouched before another participant may take it
+ * over.
+ *
+ * A holder touches its own lock while it works, so the budget measures a holder
+ * that has stopped rather than one that is slow. The README section "Sharing
+ * the credential across processes" carries the protocol these budgets belong
+ * to.
+ */
+export declare const CONSOLE_SESSION_LOCK_STALE_MS = 30000;
+/**
+ * How long a participant waits for a lock somebody else holds.
+ *
+ * Deliberately not shorter than the stale budget. If it were, a waiter could
+ * give up while the holder is dead but not yet stale, and "I gave up waiting"
+ * would stop meaning "the holder is gone".
+ */
+export declare const CONSOLE_SESSION_LOCK_WAIT_MS = 30000;
+/** The lock guarding `~/.vendure/console-credentials.json`, beside the file it guards. */
+export declare function consoleSessionLockPath(home?: string): string;
+export interface ConsoleSessionLockOptions {
+    /** Overrides `os.homedir()`. Tests point this at a temporary directory. */
+    home?: string;
+    /**
+     * The budgets are part of the protocol rather than a user setting. They are
+     * open here so tests can drive the stale and give-up paths without waiting
+     * half a minute for each one. `waitMs` is raised to `staleMs` when it is
+     * smaller, because the protocol does not allow the shorter of the two.
+     */
+    staleMs?: number;
+    waitMs?: number;
+    pollMs?: number;
+}
+/**
+ * Run `work` while holding the Console session lock.
+ *
+ * Every step that spends a refresh token or rewrites the credential file has to
+ * go through here, including the ones in other tools. Console rotates the
+ * refresh token on use, so a second process presenting the same token is
+ * refused and left with nothing, and guarding only some of the call sites
+ * leaves the double spend reachable through the rest. The protocol is written
+ * down in the README so a participant in another language can join in.
+ *
+ * The lock is not reentrant. The exported session functions take it themselves,
+ * so taking it around one of them waits out the whole wait budget and then
+ * fails: the outer lock is held by a process that is alive and beating, which
+ * is the one thing a waiter never breaks.
+ */
+export declare function withConsoleSessionLock<T>(options: ConsoleSessionLockOptions, work: () => Promise<T>): Promise<T>;

package/dist/session-lock.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.CONSOLE_SESSION_LOCK_WAIT_MS=exports.CONSOLE_SESSION_LOCK_STALE_MS=void 0,exports.consoleSessionLockPath=i,exports.withConsoleSessionLock=s;const t=require("node:crypto"),n=require("node:fs/promises"),e=require("node:path"),o=require("node:timers/promises"),r=require("./credential-store");exports.CONSOLE_SESSION_LOCK_STALE_MS=3e4,exports.CONSOLE_SESSION_LOCK_WAIT_MS=3e4;const a=50;function i(t){return(0,e.join)((0,r.consoleConfigDir)(t),"console-credentials.lock")}async function s(t,n){var e;const o=await u(t),r=c(o,null!==(e=t.staleMs)&&void 0!==e?e:exports.CONSOLE_SESSION_LOCK_STALE_MS);try{return await n()}finally{clearInterval(r),await w(o)}}function c(t,e){const o=setInterval(()=>{(async()=>{const e=await d(t.path);if((null==e?void 0:e.token)!==t.token)return;const o=new Date;await(0,n.utimes)(t.path,o,o)})().catch(()=>{})},Math.max(1,Math.round(e/3)));return o.unref(),o}async function u(e){var s,c,u;const w=i(e.home),d=null!==(s=e.staleMs)&&void 0!==s?s:exports.CONSOLE_SESSION_LOCK_STALE_MS,h=Math.max(null!==(c=e.waitMs)&&void 0!==c?c:exports.CONSOLE_SESSION_LOCK_WAIT_MS,d),O=null!==(u=e.pollMs)&&void 0!==u?u:a,f=(0,t.randomUUID)(),_=Date.now()+h;await(0,n.mkdir)((0,r.consoleConfigDir)(e.home),{recursive:!0,mode:448});const p=async()=>{if(await S(w,d))return await l(w,f)?{path:w,token:f}:void 0};for(;;){if(await l(w,f))return{path:w,token:f};const t=await p();if(t)return t;if(Date.now()>=_){const t=await p();if(t)return t;throw new Error("Another Vendure process is using the Console session. Try again.")}await(0,o.setTimeout)(O)}}async function l(t,e){let o;try{o=await(0,n.open)(t,"wx",384)}catch(t){const{code:n}=t;if("EEXIST"===n)return!1;throw new Error(`Could not lock the Vendure Console credential (${null!=n?n:"unknown error"}).`)}try{const t={token:e,pid:process.pid,acquiredAt:(new Date).toISOString()};return await o.writeFile(`${JSON.stringify(t)}\n`,"utf8"),!0}catch{throw await(0,n.unlink)(t).catch(()=>{}),new Error("Could not lock the Vendure Console credential.")}finally{await o.close().catch(()=>{})}}async function S(e,o){const r=await d(e);if(!r)return!0;if(Date.now()-Math.floor(r.mtimeMs)<o)return!1;const a=`${e}.${(0,t.randomUUID)()}`;try{await(0,n.rename)(e,a)}catch{return!0}const i=await d(a);return i&&i.token!==r.token&&await(0,n.link)(a,e).catch(()=>{}),await(0,n.unlink)(a).catch(()=>{}),!0}async function w(t){const e=await d(t.path);(null==e?void 0:e.token)===t.token&&await(0,n.unlink)(t.path).catch(()=>{})}async function d(t){try{const e=await(0,n.stat)(t);let o;try{const e=JSON.parse(await(0,n.readFile)(t,"utf8"));"string"==typeof(null==e?void 0:e.token)&&(o=e.token)}catch{}return{token:o,mtimeMs:e.mtimeMs}}catch{return}}

package/dist/session.d.ts

@@ -0,0 +1,38 @@
+import { type BrowserLoginOptions } from './browser-auth';
+export interface ConsoleSessionOptions {
+    /** Overrides `os.homedir()`. Tests point this at a temporary directory. */
+    home?: string;
+    appOrigin?: string;
+    apiOrigin?: string;
+    fetch?: typeof globalThis.fetch;
+    now?: () => Date;
+}
+/**
+ * A usable access token from the stored credential, or `undefined` when there is
+ * none and the caller has to log in.
+ *
+ * A credential that is still valid is returned as-is, without taking the lock:
+ * that read spends nothing and writes nothing, and every command would
+ * otherwise queue behind every other one. One that has expired but carries a
+ * refresh token is refreshed and written back under the lock, so a returning
+ * user is not sent to the browser every time their access token rolls over. A
+ * refresh that fails is treated as no credential rather than an error: the
+ * recovery is the same login the caller would offer anyway.
+ *
+ * Failing to take the lock is not that, and it throws. It says nothing about
+ * the session, and answering "no credential" would send a person to the browser
+ * to log in over a session that is fine and is being refreshed as they are
+ * asked.
+ */
+export declare function resolveStoredConsoleToken(options?: ConsoleSessionOptions): Promise<string | undefined>;
+/**
+ * Refresh the stored credential and write the new one back, returning the fresh
+ * access token.
+ *
+ * Split out from `resolveStoredConsoleToken` because a token can also expire
+ * mid-flow, between two calls of a command that is already running. There the
+ * caller wants the failure rather than a silent `undefined`, so this throws.
+ */
+export declare function refreshStoredConsoleToken(options?: ConsoleSessionOptions): Promise<string>;
+/** Run the browser login, persist the result, and return the access token. */
+export declare function loginAndStoreConsoleToken(options: ConsoleSessionOptions & Omit<BrowserLoginOptions, 'appOrigin' | 'apiOrigin' | 'fetch' | 'now'>): Promise<string>;