@prismicio/manager 0.0.1

package/dist/managers/telemetry/TelemetryManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TelemetryManager.js","sources":["../../../../src/managers/telemetry/TelemetryManager.ts"],"sourcesContent":["import { randomUUID } from \"node:crypto\";\n\nimport {\n\tExperiment,\n\tRemoteEvaluationClient,\n\tVariant,\n} from \"@amplitude/experiment-node-server\";\nimport { Analytics, TrackParams } from \"@segment/analytics-node\";\n\nimport { PrismicUserProfile } from \"../../auth/PrismicAuthManager\";\nimport { API_TOKENS } from \"../../constants/API_TOKENS\";\nimport { readPrismicrc } from \"../../lib/prismicrc\";\nimport { BaseManager } from \"../BaseManager\";\n\nimport {\n\tHumanSegmentEventType,\n\tHumanSegmentEventTypes,\n\tSegmentEvents,\n} from \"./types\";\n\ntype TelemetryManagerInitTelemetryArgs = {\n\tappName: string;\n\tappVersion: string;\n};\n\ntype TelemetryManagerTrackArgs = SegmentEvents;\n\ntype TelemetryManagerContext = {\n\tapp: {\n\t\tname: string;\n\t\tversion: string;\n\t};\n};\n\nfunction assertTelemetryInitialized(\n\tsegmentClient: (() => Analytics) | undefined,\n): asserts segmentClient is NonNullable<typeof segmentClient> {\n\tif (segmentClient === undefined) {\n\t\tthrow new Error(\n\t\t\t\"Telemetry has not been initialized. Run `PrismicManager.telemetry.prototype.initTelemetry()` before re-calling this method.\",\n\t\t);\n\t}\n}\n\nexport class TelemetryManager extends BaseManager {\n\tprivate _segmentClient: (() => Analytics) | undefined = undefined;\n\tprivate _anonymousID: string | undefined = undefined;\n\tprivate _userID: string | undefined = undefined;\n\tprivate _context: TelemetryManagerContext | undefined = undefined;\n\tprivate _experiment: RemoteEvaluationClient | undefined = undefined;\n\n\tasync initTelemetry(args: TelemetryManagerInitTelemetryArgs): Promise<void> {\n\t\tconst isTelemetryEnabled = await this.checkIsTelemetryEnabled();\n\n\t\tthis._segmentClient = () => {\n\t\t\tconst analytics = new Analytics({\n\t\t\t\twriteKey: API_TOKENS.SegmentKey,\n\t\t\t\t// Since it's a local app, we do not benefit from event batching the way a server would normally do, all tracking event will be awaited.\n\t\t\t\tmaxEventsInBatch: 1,\n\t\t\t\tdisable: !isTelemetryEnabled,\n\t\t\t});\n\n\t\t\tanalytics.on(\"error\", (error) => {\n\t\t\t\t// noop - We don't care if the tracking event\n\t\t\t\t// failed. Some users or networks intentionally\n\t\t\t\t// block Segment, so we can't block the app if\n\t\t\t\t// a tracking event is unsuccessful.\n\t\t\t\tif (import.meta.env.DEV) {\n\t\t\t\t\tconsole.error(`An error occurred with Segment`, error);\n\t\t\t\t}\n\t\t\t});\n\n\t\t\treturn analytics;\n\t\t};\n\n\t\tif (isTelemetryEnabled) {\n\t\t\tthis.initExperiment();\n\t\t}\n\n\t\tthis._anonymousID = randomUUID();\n\t\tthis._context = { app: { name: args.appName, version: args.appVersion } };\n\t}\n\n\tasync track(args: TelemetryManagerTrackArgs): Promise<void> {\n\t\tconst { event, repository, ...properties } = args;\n\t\tlet repositoryName = repository;\n\n\t\tif (repositoryName === undefined) {\n\t\t\ttry {\n\t\t\t\trepositoryName = await this.project.getRepositoryName();\n\t\t\t} catch {\n\t\t\t\t// noop, happen only when the user is not in a project\n\t\t\t}\n\t\t}\n\n\t\tconst payload: {\n\t\t\tevent: HumanSegmentEventTypes;\n\t\t\tuserId?: string;\n\t\t\tanonymousId?: string;\n\t\t\tproperties?: Record<string, unknown>;\n\t\t\tcontext?: Partial<TelemetryManagerContext> & {\n\t\t\t\tgroupId?: {\n\t\t\t\t\tRepository?: string;\n\t\t\t\t};\n\t\t\t};\n\t\t} = {\n\t\t\tevent: HumanSegmentEventType[event],\n\t\t\tproperties: {\n\t\t\t\tnodeVersion: process.versions.node,\n\t\t\t\t...properties,\n\t\t\t},\n\t\t\tcontext: { ...this._context },\n\t\t};\n\n\t\t// Always keep an anonymous ID to keep track of the user before and after identification\n\t\tpayload.anonymousId = this._anonymousID;\n\n\t\tif (this._userID) {\n\t\t\tpayload.userId = this._userID;\n\t\t}\n\n\t\tif (repositoryName) {\n\t\t\tpayload.context ||= {};\n\t\t\tpayload.context.groupId ||= {};\n\t\t\tpayload.context.groupId.Repository = repositoryName;\n\t\t}\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\tthis._segmentClient().track(\n\t\t\t\tpayload as TrackParams,\n\t\t\t\t(maybeError?: unknown) => {\n\t\t\t\t\tif (maybeError && import.meta.env.DEV) {\n\t\t\t\t\t\tconsole.warn(\n\t\t\t\t\t\t\t`An error occurred during Segment tracking`,\n\t\t\t\t\t\t\tmaybeError,\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\n\t\t\t\t\tresolve();\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t}\n\n\tasync identify(userProfile: PrismicUserProfile): Promise<void> {\n\t\tconst payload = {\n\t\t\tuserId: userProfile.shortId,\n\t\t\tanonymousId: this._anonymousID,\n\t\t\tintegrations: {\n\t\t\t\tIntercom: {\n\t\t\t\t\tuser_hash: userProfile.intercomHash,\n\t\t\t\t},\n\t\t\t},\n\t\t\tcontext: { ...this._context },\n\t\t};\n\n\t\tthis._userID = userProfile.shortId;\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\tthis._segmentClient().identify(payload, (maybeError?: unknown) => {\n\t\t\t\tif (maybeError && import.meta.env.DEV) {\n\t\t\t\t\tconsole.warn(`An error occurred during Segment identify`, maybeError);\n\t\t\t\t}\n\n\t\t\t\tresolve();\n\t\t\t});\n\t\t});\n\t}\n\n\tasync checkIsTelemetryEnabled(): Promise<boolean> {\n\t\tlet root: string;\n\t\ttry {\n\t\t\troot = await this.project\n\t\t\t\t.getRoot()\n\t\t\t\t.catch(() => this.project.suggestRoot());\n\n\t\t\treturn readPrismicrc(root).telemetry !== false;\n\t\t} catch {\n\t\t\treturn true;\n\t\t}\n\t}\n\n\tprivate initExperiment(): void {\n\t\ttry {\n\t\t\tthis._experiment = Experiment.initializeRemote(API_TOKENS.AmplitudeKey);\n\t\t} catch (error) {\n\t\t\tif (import.meta.env.DEV) {\n\t\t\t\tconsole.error(\"Error initializing experiment\", error);\n\t\t\t}\n\t\t}\n\t}\n\n\tasync getExperimentVariant(variantKey: string): Promise<Variant | undefined> {\n\t\tif (this._experiment) {\n\t\t\ttry {\n\t\t\t\tconst repositoryName = await this.project.getRepositoryName();\n\t\t\t\tconst variants = await this._experiment.fetchV2({\n\t\t\t\t\tuser_id: this._userID,\n\t\t\t\t\tuser_properties: {\n\t\t\t\t\t\tRepository: repositoryName,\n\t\t\t\t\t},\n\t\t\t\t});\n\n\t\t\t\tconst variantValue = variants[variantKey].value;\n\t\t\t\tif (variantValue) {\n\t\t\t\t\tawait this.track({\n\t\t\t\t\t\tevent: \"experiment:exposure\",\n\t\t\t\t\t\tflag_key: variantKey,\n\t\t\t\t\t\tvariant: variantValue,\n\t\t\t\t\t});\n\t\t\t\t}\n\n\t\t\t\treturn variants[variantKey];\n\t\t\t} catch (error) {\n\t\t\t\tif (import.meta.env.DEV) {\n\t\t\t\t\tconsole.error(\"Error fetching experiment variant\", error);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn undefined;\n\t}\n}\n"],"names":["Experiment"],"mappings":";;;;;;;AAkCA,SAAS,2BACR,eAA4C;AAE5C,MAAI,kBAAkB,QAAW;AAChC,UAAM,IAAI,MACT,6HAA6H;AAAA,EAE/H;AACD;AAEM,MAAO,yBAAyB,YAAW;AAAA,EACxC,iBAAgD;AAAA,EAChD,eAAmC;AAAA,EACnC,UAA8B;AAAA,EAC9B,WAAgD;AAAA,EAChD,cAAkD;AAAA,EAE1D,MAAM,cAAc,MAAuC;AAC1D,UAAM,qBAAqB,MAAM,KAAK,wBAAA;AAEtC,SAAK,iBAAiB,MAAK;AAC1B,YAAM,YAAY,IAAI,UAAU;AAAA,QAC/B,UAAU,WAAW;AAAA;AAAA,QAErB,kBAAkB;AAAA,QAClB,SAAS,CAAC;AAAA,MAAA,CACV;AAED,gBAAU,GAAG,SAAS,CAAC,UAAS;AAAA,MAQhC,CAAC;AAED,aAAO;AAAA,IACR;AAEA,QAAI,oBAAoB;AACvB,WAAK,eAAA;AAAA,IACN;AAEA,SAAK,eAAe,WAAA;AACpB,SAAK,WAAW,EAAE,KAAK,EAAE,MAAM,KAAK,SAAS,SAAS,KAAK,aAAU;AAAA,EACtE;AAAA,EAEA,MAAM,MAAM,MAA+B;AAC1C,UAAM,EAAE,OAAO,YAAY,GAAG,eAAe;AAC7C,QAAI,iBAAiB;AAErB,QAAI,mBAAmB,QAAW;AACjC,UAAI;AACH,yBAAiB,MAAM,KAAK,QAAQ,kBAAA;AAAA,MACrC,QAAQ;AAAA,MAER;AAAA,IACD;AAEA,UAAM,UAUF;AAAA,MACH,OAAO,sBAAsB,KAAK;AAAA,MAClC,YAAY;AAAA,QACX,aAAa,QAAQ,SAAS;AAAA,QAC9B,GAAG;AAAA,MAAA;AAAA,MAEJ,SAAS,EAAE,GAAG,KAAK,SAAA;AAAA,IAAQ;AAI5B,YAAQ,cAAc,KAAK;AAE3B,QAAI,KAAK,SAAS;AACjB,cAAQ,SAAS,KAAK;AAAA,IACvB;AAEA,QAAI,gBAAgB;AACnB,cAAQ,YAAY,CAAA;AACpB,cAAQ,QAAQ,YAAY,CAAA;AAC5B,cAAQ,QAAQ,QAAQ,aAAa;AAAA,IACtC;AAEA,WAAO,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAE9C,WAAK,eAAA,EAAiB,MACrB,SACA,CAAC,eAAwB;AAQxB,gBAAA;AAAA,MACD,CAAC;AAAA,IAEH,CAAC;AAAA,EACF;AAAA,EAEA,MAAM,SAAS,aAA+B;AAC7C,UAAM,UAAU;AAAA,MACf,QAAQ,YAAY;AAAA,MACpB,aAAa,KAAK;AAAA,MAClB,cAAc;AAAA,QACb,UAAU;AAAA,UACT,WAAW,YAAY;AAAA,QAAA;AAAA,MACvB;AAAA,MAEF,SAAS,EAAE,GAAG,KAAK,SAAA;AAAA,IAAQ;AAG5B,SAAK,UAAU,YAAY;AAE3B,WAAO,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAE9C,WAAK,eAAA,EAAiB,SAAS,SAAS,CAAC,eAAwB;AAKhE,gBAAA;AAAA,MACD,CAAC;AAAA,IACF,CAAC;AAAA,EACF;AAAA,EAEA,MAAM,0BAAuB;AAC5B,QAAI;AACJ,QAAI;AACH,aAAO,MAAM,KAAK,QAChB,QAAA,EACA,MAAM,MAAM,KAAK,QAAQ,aAAa;AAExC,aAAO,cAAc,IAAI,EAAE,cAAc;AAAA,IAC1C,QAAQ;AACP,aAAO;AAAA,IACR;AAAA,EACD;AAAA,EAEQ,iBAAc;AACrB,QAAI;AACH,WAAK,cAAcA,WAAAA,WAAW,iBAAiB,WAAW,YAAY;AAAA,IACvE,SAAS,OAAO;AAAA,IAIhB;AAAA,EACD;AAAA,EAEA,MAAM,qBAAqB,YAAkB;AAC5C,QAAI,KAAK,aAAa;AACrB,UAAI;AACH,cAAM,iBAAiB,MAAM,KAAK,QAAQ,kBAAA;AAC1C,cAAM,WAAW,MAAM,KAAK,YAAY,QAAQ;AAAA,UAC/C,SAAS,KAAK;AAAA,UACd,iBAAiB;AAAA,YAChB,YAAY;AAAA,UAAA;AAAA,QACZ,CACD;AAED,cAAM,eAAe,SAAS,UAAU,EAAE;AAC1C,YAAI,cAAc;AACjB,gBAAM,KAAK,MAAM;AAAA,YAChB,OAAO;AAAA,YACP,UAAU;AAAA,YACV,SAAS;AAAA,UAAA,CACT;AAAA,QACF;AAEA,eAAO,SAAS,UAAU;AAAA,MAC3B,SAAS,OAAO;AAAA,MAIhB;AAAA,IACD;AAEA,WAAO;AAAA,EACR;AACA;"}

package/dist/managers/telemetry/types.d.ts

@@ -0,0 +1,35 @@
+export type { Variant } from "@amplitude/experiment-node-server";
+export declare const SegmentEventType: {
+    readonly experiment_exposure: "experiment:exposure";
+    readonly prismic_cli_start: "prismic-cli:start";
+    readonly prismic_cli_end: "prismic-cli:end";
+};
+type SegmentEventTypes = (typeof SegmentEventType)[keyof typeof SegmentEventType];
+export declare const HumanSegmentEventType: {
+    readonly "experiment:exposure": "$exposure";
+    readonly "prismic-cli:start": "Prismic CLI Start";
+    readonly "prismic-cli:end": "Prismic CLI End";
+};
+export type HumanSegmentEventTypes = (typeof HumanSegmentEventType)[keyof typeof HumanSegmentEventType];
+type SegmentEvent<TType extends SegmentEventTypes, TProperties extends Record<string, unknown> | void = void> = TProperties extends void ? {
+    event: TType;
+    repository?: string;
+} : {
+    event: TType;
+    repository?: string;
+} & TProperties;
+type ExperimentExposure = SegmentEvent<typeof SegmentEventType.experiment_exposure, {
+    flag_key: string;
+    variant: string;
+}>;
+type PrismicCLIStartSegmentEvent = SegmentEvent<typeof SegmentEventType.prismic_cli_start, {
+    commandType: "init" | "sync";
+    fullCommand: string;
+}>;
+type PrismicCLIEndSegmentEvent = SegmentEvent<typeof SegmentEventType.prismic_cli_end, {
+    commandType: "init" | "sync";
+    success: boolean;
+    error?: string;
+    fullCommand: string;
+}>;
+export type SegmentEvents = ExperimentExposure | PrismicCLIStartSegmentEvent | PrismicCLIEndSegmentEvent;

package/dist/managers/telemetry/types.js

@@ -0,0 +1,15 @@
+const SegmentEventType = {
+  experiment_exposure: "experiment:exposure",
+  prismic_cli_start: "prismic-cli:start",
+  prismic_cli_end: "prismic-cli:end"
+};
+const HumanSegmentEventType = {
+  [SegmentEventType.experiment_exposure]: "$exposure",
+  [SegmentEventType.prismic_cli_start]: "Prismic CLI Start",
+  [SegmentEventType.prismic_cli_end]: "Prismic CLI End"
+};
+export {
+  HumanSegmentEventType,
+  SegmentEventType
+};
+//# sourceMappingURL=types.js.map

package/dist/managers/telemetry/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":["../../../../src/managers/telemetry/types.ts"],"sourcesContent":["export type { Variant } from \"@amplitude/experiment-node-server\";\n\nexport const SegmentEventType = {\n\texperiment_exposure: \"experiment:exposure\",\n\tprismic_cli_start: \"prismic-cli:start\",\n\tprismic_cli_end: \"prismic-cli:end\",\n} as const;\ntype SegmentEventTypes =\n\t(typeof SegmentEventType)[keyof typeof SegmentEventType];\n\nexport const HumanSegmentEventType = {\n\t[SegmentEventType.experiment_exposure]: \"$exposure\",\n\t[SegmentEventType.prismic_cli_start]: \"Prismic CLI Start\",\n\t[SegmentEventType.prismic_cli_end]: \"Prismic CLI End\",\n} as const;\n\nexport type HumanSegmentEventTypes =\n\t(typeof HumanSegmentEventType)[keyof typeof HumanSegmentEventType];\n\ntype SegmentEvent<\n\tTType extends SegmentEventTypes,\n\tTProperties extends Record<string, unknown> | void = void,\n> = TProperties extends void\n\t? {\n\t\t\tevent: TType;\n\t\t\trepository?: string;\n\t\t}\n\t: {\n\t\t\tevent: TType;\n\t\t\trepository?: string;\n\t\t} & TProperties;\n\ntype ExperimentExposure = SegmentEvent<\n\ttypeof SegmentEventType.experiment_exposure,\n\t{\n\t\tflag_key: string;\n\t\tvariant: string;\n\t}\n>;\n\ntype PrismicCLIStartSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.prismic_cli_start,\n\t{\n\t\tcommandType: \"init\" | \"sync\";\n\t\tfullCommand: string;\n\t}\n>;\n\ntype PrismicCLIEndSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.prismic_cli_end,\n\t{\n\t\tcommandType: \"init\" | \"sync\";\n\t\tsuccess: boolean;\n\t\terror?: string;\n\t\tfullCommand: string;\n\t}\n>;\n\nexport type SegmentEvents =\n\t| ExperimentExposure\n\t| PrismicCLIStartSegmentEvent\n\t| PrismicCLIEndSegmentEvent;\n"],"names":[],"mappings":"AAEO,MAAM,mBAAmB;AAAA,EAC/B,qBAAqB;AAAA,EACrB,mBAAmB;AAAA,EACnB,iBAAiB;;AAKX,MAAM,wBAAwB;AAAA,EACpC,CAAC,iBAAiB,mBAAmB,GAAG;AAAA,EACxC,CAAC,iBAAiB,iBAAiB,GAAG;AAAA,EACtC,CAAC,iBAAiB,eAAe,GAAG;;"}

package/dist/managers/user/UserManager.d.ts

@@ -0,0 +1,22 @@
+import { BaseManager } from "../BaseManager.js";
+import { PrismicManager } from "../PrismicManager.js";
+export declare class UserManager extends BaseManager {
+    constructor(prismicManager: PrismicManager);
+    login: (args: {
+        email: string;
+        token: string;
+    }) => Promise<void>;
+    getLoginSessionInfo: () => Promise<{
+        port: number;
+        url: string;
+    }>;
+    nodeLoginSession: (args: {
+        port: number;
+        onListenCallback?: () => void;
+    }) => Promise<void>;
+    logout: () => Promise<void>;
+    checkIsLoggedIn: () => Promise<boolean>;
+    refreshAuthenticationToken: () => Promise<void>;
+    getAuthenticationToken: () => Promise<string>;
+    getProfile: () => Promise<import("../..").PrismicUserProfile>;
+}

package/dist/managers/user/UserManager.js

@@ -0,0 +1,22 @@
+import { PrismicError } from "../../errors.js";
+import { BaseManager } from "../BaseManager.js";
+class UserManager extends BaseManager {
+  constructor(prismicManager) {
+    super(prismicManager);
+    if (!prismicManager.getPrismicAuthManager()) {
+      throw new PrismicError("PrismicManager._prismicAuthManager must be set with a PrismicAuthManager instance before instantiating UserManager.");
+    }
+  }
+  login = this.prismicAuthManager.login.bind(this.prismicAuthManager);
+  getLoginSessionInfo = this.prismicAuthManager.getLoginSessionInfo.bind(this.prismicAuthManager);
+  nodeLoginSession = this.prismicAuthManager.nodeLoginSession.bind(this.prismicAuthManager);
+  logout = this.prismicAuthManager.logout.bind(this.prismicAuthManager);
+  checkIsLoggedIn = this.prismicAuthManager.checkIsLoggedIn.bind(this.prismicAuthManager);
+  refreshAuthenticationToken = this.prismicAuthManager.refreshAuthenticationToken.bind(this.prismicAuthManager);
+  getAuthenticationToken = this.prismicAuthManager.getAuthenticationToken.bind(this.prismicAuthManager);
+  getProfile = this.prismicAuthManager.getProfile.bind(this.prismicAuthManager);
+}
+export {
+  UserManager
+};
+//# sourceMappingURL=UserManager.js.map

package/dist/managers/user/UserManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserManager.js","sources":["../../../../src/managers/user/UserManager.ts"],"sourcesContent":["import { PrismicError } from \"../../errors\";\nimport { BaseManager } from \"../BaseManager\";\nimport { PrismicManager } from \"../PrismicManager\";\n\nexport class UserManager extends BaseManager {\n\tconstructor(prismicManager: PrismicManager) {\n\t\tsuper(prismicManager);\n\n\t\tif (!prismicManager.getPrismicAuthManager()) {\n\t\t\tthrow new PrismicError(\n\t\t\t\t\"PrismicManager._prismicAuthManager must be set with a PrismicAuthManager instance before instantiating UserManager.\",\n\t\t\t);\n\t\t}\n\t}\n\n\tlogin = this.prismicAuthManager.login.bind(this.prismicAuthManager);\n\tgetLoginSessionInfo = this.prismicAuthManager.getLoginSessionInfo.bind(\n\t\tthis.prismicAuthManager,\n\t);\n\tnodeLoginSession = this.prismicAuthManager.nodeLoginSession.bind(\n\t\tthis.prismicAuthManager,\n\t);\n\tlogout = this.prismicAuthManager.logout.bind(this.prismicAuthManager);\n\tcheckIsLoggedIn = this.prismicAuthManager.checkIsLoggedIn.bind(\n\t\tthis.prismicAuthManager,\n\t);\n\trefreshAuthenticationToken =\n\t\tthis.prismicAuthManager.refreshAuthenticationToken.bind(\n\t\t\tthis.prismicAuthManager,\n\t\t);\n\tgetAuthenticationToken = this.prismicAuthManager.getAuthenticationToken.bind(\n\t\tthis.prismicAuthManager,\n\t);\n\tgetProfile = this.prismicAuthManager.getProfile.bind(this.prismicAuthManager);\n}\n"],"names":[],"mappings":";;AAIM,MAAO,oBAAoB,YAAW;AAAA,EAC3C,YAAY,gBAA8B;AACzC,UAAM,cAAc;AAEpB,QAAI,CAAC,eAAe,yBAAyB;AAC5C,YAAM,IAAI,aACT,qHAAqH;AAAA,IAEvH;AAAA,EACD;AAAA,EAEA,QAAQ,KAAK,mBAAmB,MAAM,KAAK,KAAK,kBAAkB;AAAA,EAClE,sBAAsB,KAAK,mBAAmB,oBAAoB,KACjE,KAAK,kBAAkB;AAAA,EAExB,mBAAmB,KAAK,mBAAmB,iBAAiB,KAC3D,KAAK,kBAAkB;AAAA,EAExB,SAAS,KAAK,mBAAmB,OAAO,KAAK,KAAK,kBAAkB;AAAA,EACpE,kBAAkB,KAAK,mBAAmB,gBAAgB,KACzD,KAAK,kBAAkB;AAAA,EAExB,6BACC,KAAK,mBAAmB,2BAA2B,KAClD,KAAK,kBAAkB;AAAA,EAEzB,yBAAyB,KAAK,mBAAmB,uBAAuB,KACvE,KAAK,kBAAkB;AAAA,EAExB,aAAa,KAAK,mBAAmB,WAAW,KAAK,KAAK,kBAAkB;AAC5E;"}

package/dist/managers/versions/VersionsManager.d.ts

@@ -0,0 +1,21 @@
+import { BaseManager } from "../BaseManager.js";
+type CheckCLIVersionLatestArgs = {
+    currentVersion: string;
+};
+export declare class VersionsManager extends BaseManager {
+    /**
+     * Fetches the latest stable version of the Prismic CLI from npm.
+     *
+     * @returns The latest stable version string.
+     */
+    getLatestCLIVersion(): Promise<string>;
+    /**
+     * Checks if the current CLI version is the latest available version.
+     *
+     * @param args - Arguments object containing the current version.
+     *
+     * @returns `true` if the current version is the latest, `false` otherwise.
+     */
+    checkIsCLIVersionLatest(args: CheckCLIVersionLatestArgs): Promise<boolean>;
+}
+export {};

package/dist/managers/versions/VersionsManager.js

@@ -0,0 +1,39 @@
+import semver from "semver";
+import { PRISMIC_CLI_NPM_PACKAGE_NAME } from "../../constants/PRISMIC_CLI_NPM_PACKAGE_NAME.js";
+import { fetchNPMPackageVersions } from "../../lib/fetchNPMPackageVersions.js";
+import { BaseManager } from "../BaseManager.js";
+class VersionsManager extends BaseManager {
+  /**
+   * Fetches the latest stable version of the Prismic CLI from npm.
+   *
+   * @returns The latest stable version string.
+   */
+  async getLatestCLIVersion() {
+    const versions = await fetchNPMPackageVersions({
+      packageName: PRISMIC_CLI_NPM_PACKAGE_NAME
+    });
+    const stableVersions = versions.filter((version) => {
+      return semver.prerelease(version) === null;
+    });
+    if (stableVersions.length === 0) {
+      throw new Error("No stable versions found for the package on the npm registry.");
+    }
+    const sortedVersions = semver.rsort(stableVersions);
+    return sortedVersions[0];
+  }
+  /**
+   * Checks if the current CLI version is the latest available version.
+   *
+   * @param args - Arguments object containing the current version.
+   *
+   * @returns `true` if the current version is the latest, `false` otherwise.
+   */
+  async checkIsCLIVersionLatest(args) {
+    const latestVersion = await this.getLatestCLIVersion();
+    return semver.eq(args.currentVersion, latestVersion);
+  }
+}
+export {
+  VersionsManager
+};
+//# sourceMappingURL=VersionsManager.js.map

package/dist/managers/versions/VersionsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VersionsManager.js","sources":["../../../../src/managers/versions/VersionsManager.ts"],"sourcesContent":["import semver from \"semver\";\n\nimport { PRISMIC_CLI_NPM_PACKAGE_NAME } from \"../../constants/PRISMIC_CLI_NPM_PACKAGE_NAME\";\nimport { fetchNPMPackageVersions } from \"../../lib/fetchNPMPackageVersions\";\nimport { BaseManager } from \"../BaseManager\";\n\ntype CheckCLIVersionLatestArgs = {\n\tcurrentVersion: string;\n};\n\nexport class VersionsManager extends BaseManager {\n\t/**\n\t * Fetches the latest stable version of the Prismic CLI from npm.\n\t *\n\t * @returns The latest stable version string.\n\t */\n\tasync getLatestCLIVersion(): Promise<string> {\n\t\tconst versions = await fetchNPMPackageVersions({\n\t\t\tpackageName: PRISMIC_CLI_NPM_PACKAGE_NAME,\n\t\t});\n\n\t\t// Filter out pre-release versions (alpha, beta, rc, etc.)\n\t\tconst stableVersions = versions.filter((version) => {\n\t\t\treturn semver.prerelease(version) === null;\n\t\t});\n\n\t\tif (stableVersions.length === 0) {\n\t\t\tthrow new Error(\n\t\t\t\t\"No stable versions found for the package on the npm registry.\",\n\t\t\t);\n\t\t}\n\n\t\t// Sort versions in descending order and return the latest\n\t\tconst sortedVersions = semver.rsort(stableVersions);\n\n\t\treturn sortedVersions[0];\n\t}\n\n\t/**\n\t * Checks if the current CLI version is the latest available version.\n\t *\n\t * @param args - Arguments object containing the current version.\n\t *\n\t * @returns `true` if the current version is the latest, `false` otherwise.\n\t */\n\tasync checkIsCLIVersionLatest(\n\t\targs: CheckCLIVersionLatestArgs,\n\t): Promise<boolean> {\n\t\tconst latestVersion = await this.getLatestCLIVersion();\n\n\t\treturn semver.eq(args.currentVersion, latestVersion);\n\t}\n}\n"],"names":[],"mappings":";;;;AAUM,MAAO,wBAAwB,YAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM/C,MAAM,sBAAmB;AACxB,UAAM,WAAW,MAAM,wBAAwB;AAAA,MAC9C,aAAa;AAAA,IAAA,CACb;AAGD,UAAM,iBAAiB,SAAS,OAAO,CAAC,YAAW;AAClD,aAAO,OAAO,WAAW,OAAO,MAAM;AAAA,IACvC,CAAC;AAED,QAAI,eAAe,WAAW,GAAG;AAChC,YAAM,IAAI,MACT,+DAA+D;AAAA,IAEjE;AAGA,UAAM,iBAAiB,OAAO,MAAM,cAAc;AAElD,WAAO,eAAe,CAAC;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,wBACL,MAA+B;AAE/B,UAAM,gBAAgB,MAAM,KAAK,oBAAA;AAEjC,WAAO,OAAO,GAAG,KAAK,gBAAgB,aAAa;AAAA,EACpD;AACA;"}

package/dist/types.d.ts

@@ -0,0 +1,32 @@
+import { detect as niDetect } from "@antfu/ni";
+import { HookError, PluginOptions } from "@prismicio/plugin-kit";
+export type PackageManager = NonNullable<Awaited<ReturnType<typeof niDetect>>>;
+export type { APIEndpoints } from "./constants/API_ENDPOINTS.js";
+/**
+ * A string, object, or instance representing a registered plugin.
+ *
+ * @typeParam TPluginOptions - User-provided options for the plugin.
+ */
+export type PrismicConfigPluginRegistration<TPluginOptions extends PluginOptions = PluginOptions> = string | {
+    resolve: string;
+    options?: TPluginOptions;
+};
+/**
+ * Prismic configuration from `prismic.config.js`.
+ */
+export type PrismicConfig = {
+    apiEndpoint?: string;
+    repositoryName: string;
+    libraries?: string[];
+    adapter: PrismicConfigPluginRegistration;
+};
+export type OnlyHookErrors<THookResult extends {
+    errors: HookError[];
+} | Promise<{
+    errors: HookError[];
+}>> = Pick<Awaited<THookResult>, "errors">;
+export type S3ACL = {
+    uploadEndpoint: string;
+    requiredFormDataFields: Record<string, string>;
+    imgixEndpoint: string;
+};

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@prismicio/manager",
+  "version": "0.0.1",
+  "description": "Manage all aspects of a Prismic project.",
+  "repository": {
+    "type": "git",
+    "url": "ssh://git@github.com/prismicio/devtools.git",
+    "directory": "packages/manager"
+  },
+  "license": "Apache-2.0",
+  "author": "Prismic <contact@prismic.io> (https://prismic.io)",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.js",
+      "import": "./dist/client.js"
+    },
+    "./test": {
+      "types": "./dist/test/index.d.js",
+      "import": "./dist/test.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/index.d.ts"
+      ],
+      "client": [
+        "dist/client/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch --mode development",
+    "types": "tsc --noEmit",
+    "format": "prettier --write .",
+    "lint": "eslint --max-warnings 0 .",
+    "prepack": "$npm_execpath run build",
+    "depcheck": "depcheck --config=.depcheckrc",
+    "audit": "yarn npm audit --environment production --severity high"
+  },
+  "dependencies": {
+    "@antfu/ni": "27.0.1",
+    "@prismicio/client": "7.21.0",
+    "@prismicio/custom-types-client": "2.1.0",
+    "@prismicio/plugin-kit": "0.0.1",
+    "@prismicio/types-internal": "3.16.1",
+    "@segment/analytics-node": "2.3.0",
+    "cookie": "1.1.1",
+    "cors": "2.8.5",
+    "execa": "9.6.0",
+    "fp-ts": "2.16.11",
+    "get-port": "7.1.0",
+    "h3": "1.15.4",
+    "io-ts": "2.2.22",
+    "io-ts-types": "0.5.19",
+    "node-fetch": "3.3.2",
+    "prettier": "3.7.1",
+    "rc9": "2.1.2",
+    "semver": "7.7.3",
+    "zod": "4.1.13"
+  },
+  "devDependencies": {
+    "@amplitude/experiment-node-server": "1.12.1",
+    "@eslint/js": "9.28.0",
+    "@trivago/prettier-plugin-sort-imports": "6.0.0",
+    "@types/cors": "2.8.19",
+    "@types/semver": "7.7.1",
+    "depcheck": "1.4.7",
+    "eslint": "9.39.1",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-tsdoc": "0.5.0",
+    "prettier": "3.7.1",
+    "prettier-plugin-jsdoc": "1.7.0",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.33.0",
+    "vite": "7.2.4",
+    "vite-plugin-sdk": "0.1.5"
+  }
+}

package/src/auth/PrismicAuthManager.ts

@@ -0,0 +1,346 @@
+import * as fs from "node:fs/promises";
+import * as http from "node:http";
+import * as os from "node:os";
+import * as path from "node:path";
+
+import cors from "cors";
+import getPort from "get-port";
+import * as h3 from "h3";
+import fetch from "node-fetch";
+import * as z from "zod";
+
+import { API_ENDPOINTS } from "../constants/API_ENDPOINTS";
+import { PRISMIC_CLI_USER_AGENT } from "../constants/PRISMIC_CLI_USER_AGENT";
+import {
+	InternalError,
+	UnauthenticatedError,
+	UnexpectedDataError,
+} from "../errors";
+import { decode } from "../lib/decode";
+
+import { createPrismicAuthManagerMiddleware } from "./createPrismicAuthManagerMiddleware";
+
+const PERSISTED_AUTH_STATE_FILE_NAME = ".prismic";
+const DEFAULT_PERSISTED_AUTH_STATE: PrismicAuthState = {
+	base: "https://prismic.io",
+};
+
+const PrismicAuthStateSchema = z.object({
+	base: z.string(),
+	token: z.string().optional(),
+});
+export type PrismicAuthState = z.infer<typeof PrismicAuthStateSchema>;
+
+const PrismicUserProfileSchema = z.object({
+	userId: z.string(),
+	shortId: z.string(),
+	intercomHash: z.string(),
+	email: z.string(),
+	firstName: z.string(),
+	lastName: z.string(),
+});
+export type PrismicUserProfile = z.infer<typeof PrismicUserProfileSchema>;
+
+type PrismicAuthManagerConstructorArgs = {
+	scopedDirectory?: string;
+};
+
+type PrismicAuthManagerLoginArgs = {
+	email: string;
+	token: string;
+};
+
+type PrismicAuthManagerGetLoginSessionInfoReturnType = {
+	port: number;
+	url: string;
+};
+
+type PrismicAuthManagerNodeLoginSessionArgs = {
+	port: number;
+	onListenCallback?: () => void;
+};
+
+type GetProfileForAuthenticationTokenArgs = {
+	authenticationToken: string;
+};
+
+const checkHasAuthenticationToken = (
+	authState: PrismicAuthState,
+): authState is PrismicAuthState & {
+	token: string;
+} => {
+	return Boolean(authState.token);
+};
+
+export class PrismicAuthManager {
+	scopedDirectory: string;
+
+	constructor({
+		scopedDirectory = os.homedir(),
+	}: PrismicAuthManagerConstructorArgs = {}) {
+		this.scopedDirectory = scopedDirectory;
+	}
+
+	async login(args: PrismicAuthManagerLoginArgs): Promise<void> {
+		const authState = await this._readPersistedAuthState();
+
+		// Set the auth's URL base to the current base at runtime.
+		authState.base = API_ENDPOINTS.PrismicWroom;
+		authState.token = args.token;
+
+		await this._writePersistedAuthState(authState);
+	}
+
+	async getLoginSessionInfo(): Promise<PrismicAuthManagerGetLoginSessionInfoReturnType> {
+		// Pick a random port, with a preference for historic `5555`
+		const port = await getPort({ port: 5555 });
+
+		const url = new URL(
+			`./dashboard/cli/login?source=prismic-cli&port=${port}`,
+			API_ENDPOINTS.PrismicWroom,
+		).toString();
+
+		return {
+			port,
+			url,
+		};
+	}
+
+	async nodeLoginSession(
+		args: PrismicAuthManagerNodeLoginSessionArgs,
+	): Promise<void> {
+		return new Promise<void>((resolve, reject) => {
+			// Timeout attempt after 3 minutes
+			const timeout = setTimeout(() => {
+				server.close();
+				reject(
+					new Error(
+						"Login timeout, server did not receive a response within a 3-minute delay",
+					),
+				);
+			}, 180_000);
+
+			const app = h3.createApp();
+			app.use(h3.fromNodeMiddleware(cors()));
+			app.use(
+				h3.fromNodeMiddleware(
+					createPrismicAuthManagerMiddleware({
+						prismicAuthManager: this,
+						onLoginCallback() {
+							// Cleanup process and resolve
+							clearTimeout(timeout);
+							server.close();
+							resolve();
+						},
+					}),
+				),
+			);
+
+			// Start server
+			const server = http.createServer(h3.toNodeListener(app));
+			server.once("listening", () => {
+				if (args.onListenCallback) {
+					args.onListenCallback();
+				}
+			});
+			server.listen(args.port, "127.0.0.1");
+		});
+	}
+
+	async logout(): Promise<void> {
+		const authState = await this._readPersistedAuthState();
+
+		authState.token = undefined;
+
+		await this._writePersistedAuthState(authState);
+	}
+
+	async checkIsLoggedIn(): Promise<boolean> {
+		const authState = await this._readPersistedAuthState();
+
+		if (checkHasAuthenticationToken(authState)) {
+			const url = new URL(
+				"./validate",
+				API_ENDPOINTS.PrismicLegacyAuthenticationApi,
+			);
+			url.searchParams.set("token", authState.token);
+
+			let res;
+			try {
+				res = await fetch(url.toString(), {
+					headers: {
+						"User-Agent": PRISMIC_CLI_USER_AGENT,
+					},
+				});
+			} catch {
+				// Noop, we return if `res` is not defined.
+			}
+
+			if (!res || !res.ok) {
+				await this.logout();
+
+				return false;
+			}
+
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	async getAuthenticationToken(): Promise<string> {
+		// If already logged in with a valid token, return it
+		let isLoggedIn = await this.checkIsLoggedIn();
+
+		if (isLoggedIn) {
+			const authState = await this._readPersistedAuthState();
+
+			if (authState.token) {
+				return authState.token;
+			}
+		}
+
+		// Not logged in - attempt silent token refresh
+		// Note: checkIsLoggedIn() logs out on invalid tokens, so refresh
+		// will only work if there was no token (edge case) or network failed
+		try {
+			await this.refreshAuthenticationToken();
+
+			// Verify the refreshed token is valid
+			isLoggedIn = await this.checkIsLoggedIn();
+			if (isLoggedIn) {
+				const authState = await this._readPersistedAuthState();
+				if (authState.token) {
+					return authState.token;
+				}
+			}
+		} catch {
+			// Refresh failed - fall through to throw UnauthenticatedError
+		}
+
+		throw new UnauthenticatedError();
+	}
+
+	async refreshAuthenticationToken(): Promise<void> {
+		const authState = await this._readPersistedAuthState();
+
+		if (checkHasAuthenticationToken(authState)) {
+			const url = new URL(
+				"./refreshtoken",
+				API_ENDPOINTS.PrismicLegacyAuthenticationApi,
+			);
+			url.searchParams.set("token", authState.token);
+
+			const res = await fetch(url.toString(), {
+				headers: {
+					"User-Agent": PRISMIC_CLI_USER_AGENT,
+				},
+			});
+			const text = await res.text();
+
+			if (res.ok) {
+				authState.token = text;
+
+				await this._writePersistedAuthState(authState);
+			} else {
+				throw new InternalError("Failed to refresh authentication token.", {
+					cause: text,
+				});
+			}
+		} else {
+			throw new UnauthenticatedError();
+		}
+	}
+
+	async getProfile(): Promise<PrismicUserProfile> {
+		const authenticationToken = await this.getAuthenticationToken();
+
+		return await this._getProfileForAuthenticationToken({
+			authenticationToken,
+		});
+	}
+
+	private async _getProfileForAuthenticationToken(
+		args: GetProfileForAuthenticationTokenArgs,
+	): Promise<PrismicUserProfile> {
+		const url = new URL("./profile", API_ENDPOINTS.PrismicLegacyUserApi);
+		const res = await fetch(url.toString(), {
+			headers: {
+				Authorization: `Bearer ${args.authenticationToken}`,
+				"User-Agent": PRISMIC_CLI_USER_AGENT,
+			},
+		});
+
+		if (res.ok) {
+			const json = await res.json();
+			const { value: profile, error } = decode(PrismicUserProfileSchema, json);
+
+			if (error) {
+				throw new UnexpectedDataError(
+					"Received invalid data from the Prismic user service.",
+				);
+			}
+
+			return profile;
+		} else {
+			const text = await res.text();
+			throw new InternalError(
+				"Failed to retrieve profile from the Prismic user service.",
+				{
+					cause: text,
+				},
+			);
+		}
+	}
+
+	private async _readPersistedAuthState(): Promise<PrismicAuthState> {
+		const authStateFilePath = this._getPersistedAuthStateFilePath();
+
+		let authStateFileContents: string = JSON.stringify({});
+		let rawAuthState: Record<string, unknown> = {};
+
+		try {
+			authStateFileContents = await fs.readFile(authStateFilePath, "utf8");
+			rawAuthState = JSON.parse(authStateFileContents);
+		} catch {
+			// Write a default persisted state if it doesn't already exist.
+			rawAuthState = DEFAULT_PERSISTED_AUTH_STATE;
+			authStateFileContents = JSON.stringify(rawAuthState, null, "\t");
+
+			await fs.mkdir(path.dirname(authStateFilePath), { recursive: true });
+			await fs.writeFile(authStateFilePath, authStateFileContents);
+		}
+
+		const { value: authState, error } = decode(
+			PrismicAuthStateSchema,
+			rawAuthState,
+		);
+
+		if (error) {
+			throw new UnexpectedDataError("Prismic authentication state is invalid.");
+		}
+
+		return authState;
+	}
+
+	private async _writePersistedAuthState(
+		authState: PrismicAuthState,
+	): Promise<void> {
+		const authStateFilePath = this._getPersistedAuthStateFilePath();
+
+		try {
+			await fs.writeFile(authStateFilePath, JSON.stringify(authState, null, 2));
+		} catch (error) {
+			throw new InternalError(
+				"Failed to write Prismic authentication state to the file system.",
+				{
+					cause: error,
+				},
+			);
+		}
+	}
+
+	private _getPersistedAuthStateFilePath(): string {
+		return path.resolve(this.scopedDirectory, PERSISTED_AUTH_STATE_FILE_NAME);
+	}
+}