@slicemachine/manager 0.16.1-dev-environments.1 → 0.16.1-dev-next-release.2

package/src/index.ts

@@ -13,8 +13,6 @@ export { createSliceMachineManager } from "./managers/createSliceMachineManager"
 export { createSliceMachineManagerMiddleware } from "./managers/createSliceMachineManagerMiddleware";
 export type { CreateSliceMachineManagerMiddlewareArgs } from "./managers/createSliceMachineManagerMiddleware";
 
-export type { Environment } from "./managers/prismicRepository/types";
-
 export type {
 	PrismicAuthManager,
 	PrismicUserProfile,
@@ -27,17 +25,6 @@ export type {
 	PrismicAuthCheckStatusResponse,
 } from "./auth/createPrismicAuthManagerMiddleware";
 
-export {
-	SliceMachineError,
-	UnauthorizedError,
-	UnauthenticatedError,
-	NotFoundError,
-	UnexpectedDataError,
-	InternalError,
-	PluginError,
-	PluginHookResultError,
-} from "./errors";
-
 export { DecodeError } from "./lib/DecodeError";
 
 export type { SliceMachineConfig, PackageManager } from "./types";

package/src/managers/customTypes/CustomTypesManager.ts

@@ -224,7 +224,7 @@ export class CustomTypesManager extends BaseManager {
 		assertPluginsInitialized(this.sliceMachinePluginRunner);
 
 		const authenticationToken = await this.user.getAuthenticationToken();
-		const repositoryName = await this.project.getResolvedRepositoryName();
+		const sliceMachineConfig = await this.project.getSliceMachineConfig();
 
 		// TODO: Handle errors
 		const { model } = await this.readCustomType({ id: args.id });
@@ -233,7 +233,7 @@ export class CustomTypesManager extends BaseManager {
 			// TODO: Create a single shared client.
 			const client = prismicCustomTypesClient.createClient({
 				endpoint: API_ENDPOINTS.PrismicModels,
-				repositoryName,
+				repositoryName: sliceMachineConfig.repositoryName,
 				token: authenticationToken,
 				userAgent: args.userAgent || SLICE_MACHINE_USER_AGENT,
 				fetch,
@@ -317,11 +317,11 @@ export class CustomTypesManager extends BaseManager {
 
 	async fetchRemoteCustomTypes(): Promise<CustomType[]> {
 		const authenticationToken = await this.user.getAuthenticationToken();
-		const repositoryName = await this.project.getResolvedRepositoryName();
+		const sliceMachineConfig = await this.project.getSliceMachineConfig();
 
 		const client = prismicCustomTypesClient.createClient({
 			endpoint: API_ENDPOINTS.PrismicModels,
-			repositoryName,
+			repositoryName: sliceMachineConfig.repositoryName,
 			token: authenticationToken,
 			userAgent: SLICE_MACHINE_USER_AGENT,
 			fetch,

package/src/managers/prismicRepository/PrismicRepositoryManager.ts

@@ -2,7 +2,6 @@ import * as t from "io-ts";
 import fetch, { Response } from "../../lib/fetch";
 import { fold } from "fp-ts/Either";
 
-import { assertPluginsInitialized } from "../../lib/assertPluginsInitialized";
 import { decode } from "../../lib/decode";
 import { serializeCookies } from "../../lib/serializeCookies";
 
@@ -10,12 +9,6 @@ import { SLICE_MACHINE_USER_AGENT } from "../../constants/SLICE_MACHINE_USER_AGE
 import { API_ENDPOINTS } from "../../constants/API_ENDPOINTS";
 import { REPOSITORY_NAME_VALIDATION } from "../../constants/REPOSITORY_NAME_VALIDATION";
 
-import {
-	UnauthenticatedError,
-	UnauthorizedError,
-	UnexpectedDataError,
-} from "../../errors";
-
 import { BaseManager } from "../BaseManager";
 
 import {
@@ -34,9 +27,9 @@ import {
 	TransactionalMergeReturnType,
 	FrameworkWroomTelemetryID,
 	StarterId,
-	Environment,
 } from "./types";
-import { sortEnvironments } from "./sortEnvironments";
+import { assertPluginsInitialized } from "../../lib/assertPluginsInitialized";
+import { UnauthenticatedError } from "../../errors";
 
 const DEFAULT_REPOSITORY_SETTINGS = {
 	plan: "personal",
@@ -390,14 +383,14 @@ export class PrismicRepositoryManager extends BaseManager {
 				changes: allChanges,
 			};
 
-			const repositoryName = await this.project.getResolvedRepositoryName();
+			const sliceMachineConfig = await this.project.getSliceMachineConfig();
 
 			// TODO: move to customtypes client
 			const response = await this._fetch({
 				url: new URL("./bulk", API_ENDPOINTS.PrismicModels),
 				method: "POST",
 				body: requestBody,
-				repository: repositoryName,
+				repository: sliceMachineConfig.repositoryName,
 			});
 
 			switch (response.status) {
@@ -433,50 +426,6 @@ export class PrismicRepositoryManager extends BaseManager {
 		}
 	}
 
-	async fetchEnvironments(): Promise<Environment[]> {
-		const repositoryName = await this.project.getRepositoryName();
-
-		const url = new URL(`./environments`, API_ENDPOINTS.SliceMachineV1);
-		url.searchParams.set("repository", repositoryName);
-		const res = await this._fetch({ url });
-
-		if (res.ok) {
-			const json = await res.json();
-
-			const { value, error } = decode(
-				t.union([
-					t.type({
-						results: t.array(Environment),
-					}),
-					t.type({
-						error: t.literal("invalid_token"),
-					}),
-				]),
-				json,
-			);
-
-			if (error) {
-				throw new UnexpectedDataError(
-					`Failed to decode environments: ${error.errors.join(", ")}`,
-				);
-			}
-
-			if ("results" in value) {
-				return sortEnvironments(value.results);
-			}
-		}
-
-		switch (res.status) {
-			case 400:
-			case 401:
-				throw new UnauthenticatedError();
-			case 403:
-				throw new UnauthorizedError();
-			default:
-				throw new Error("Failed to fetch environments.");
-		}
-	}
-
 	private _decodeLimitOrThrow(
 		potentialLimit: unknown,
 		statusCode: number,

package/src/managers/prismicRepository/types.ts

@@ -155,15 +155,3 @@ export type StarterId =
 	| "nuxt_multi_page"
 	| "nuxt_blog"
 	| "nuxt_multi_lang";
-
-export const Environment = t.type({
-	kind: t.union([t.literal("prod"), t.literal("stage"), t.literal("dev")]),
-	name: t.string,
-	domain: t.string,
-	users: t.array(
-		t.type({
-			id: t.string,
-		}),
-	),
-});
-export type Environment = t.TypeOf<typeof Environment>;

package/src/managers/project/ProjectManager.ts

@@ -4,28 +4,16 @@ import * as path from "node:path";
 import { createRequire } from "node:module";
 import { detect as niDetect } from "@antfu/ni";
 import { ExecaChildProcess } from "execa";
-import {
-	HookError,
-	CallHookReturnType,
-	ProjectEnvironmentUpdateHook,
-} from "@slicemachine/plugin-kit";
-import * as t from "io-ts";
-
-import { DecodeError } from "../../lib/DecodeError";
+
 import { assertPluginsInitialized } from "../../lib/assertPluginsInitialized";
-import { decodeHookResult } from "../../lib/decodeHookResult";
 import { decodeSliceMachineConfig } from "../../lib/decodeSliceMachineConfig";
 import { format } from "../../lib/format";
 import { installDependencies } from "../../lib/installDependencies";
 import { locateFileUpward } from "../../lib/locateFileUpward";
 
-import {
-	PackageManager,
-	SliceMachineConfig,
-	OnlyHookErrors,
-} from "../../types";
+import { PackageManager, SliceMachineConfig } from "../../types";
 
-import { SliceMachineError, InternalError, PluginError } from "../../errors";
+import { SliceMachineError, InternalError } from "../../errors";
 
 import { SLICE_MACHINE_CONFIG_FILENAME } from "../../constants/SLICE_MACHINE_CONFIG_FILENAME";
 import { TS_CONFIG_FILENAME } from "../../constants/TS_CONFIG_FILENAME";
@@ -69,15 +57,6 @@ type ProjectManagerInstallDependenciesReturnType = {
 	execaProcess: ExecaChildProcess;
 };
 
-type ProjectManagerReadEnvironmentReturnType = {
-	environment: string | undefined;
-	errors: (DecodeError | HookError)[];
-};
-
-type ProjectManagerUpdateEnvironmentArgs = {
-	environment: string | undefined;
-};
-
 export class ProjectManager extends BaseManager {
 	private _cachedRoot: string | undefined;
 	private _cachedSliceMachineConfigPath: string | undefined;
@@ -216,43 +195,12 @@ export class ProjectManager extends BaseManager {
 		return path.dirname(sliceMachinePackageJSONPath);
 	}
 
-	/**
-	 * Returns the project's repository name (i.e. the production environment). It
-	 * ignores the currently selected environment.
-	 *
-	 * Use this method to retrieve the production environment domain.
-	 *
-	 * @returns The project's repository name.
-	 */
 	async getRepositoryName(): Promise<string> {
 		const sliceMachineConfig = await this.getSliceMachineConfig();
 
 		return sliceMachineConfig.repositoryName;
 	}
 
-	/**
-	 * Returns the currently selected environment domain if set. If an environment
-	 * is not set, it returns the project's repository name (the production
-	 * environment).
-	 *
-	 * Use this method to retrieve the repository name to be sent with Prismic API
-	 * requests.
-	 *
-	 * @returns The resolved repository name.
-	 */
-	async getResolvedRepositoryName(): Promise<string> {
-		const repositoryName = await this.getRepositoryName();
-
-		const supportsEnvironments = this.project.checkSupportsEnvironments();
-		if (!supportsEnvironments) {
-			return repositoryName;
-		}
-
-		const { environment } = await this.project.readEnvironment();
-
-		return environment ?? repositoryName;
-	}
-
 	async getAdapterName(): Promise<string> {
 		const sliceMachineConfig = await this.getSliceMachineConfig();
 		const adapterName =
@@ -364,80 +312,4 @@ export class ProjectManager extends BaseManager {
 			throw error;
 		}
 	}
-
-	checkSupportsEnvironments(): boolean {
-		assertPluginsInitialized(this.sliceMachinePluginRunner);
-
-		return (
-			this.sliceMachinePluginRunner.hooksForType("project:environment:read")
-				.length > 0 &&
-			this.sliceMachinePluginRunner.hooksForType("project:environment:update")
-				.length > 0
-		);
-	}
-
-	async readEnvironment(): Promise<ProjectManagerReadEnvironmentReturnType> {
-		assertPluginsInitialized(this.sliceMachinePluginRunner);
-
-		await this._assertAdapterSupportsEnvironments();
-
-		const hookResult = await this.sliceMachinePluginRunner.callHook(
-			"project:environment:read",
-			undefined,
-		);
-		const { data, errors } = decodeHookResult(
-			t.type({
-				environment: t.union([t.undefined, t.string]),
-			}),
-			hookResult,
-		);
-
-		// An undefined value is equivalent to the production environment.
-		// We cast to undefined.
-		const repositoryName = await this.project.getRepositoryName();
-		const environmentDomain =
-			data[0]?.environment === repositoryName
-				? undefined
-				: data[0]?.environment;
-
-		return {
-			environment: environmentDomain,
-			errors,
-		};
-	}
-
-	async updateEnvironment(
-		args: ProjectManagerUpdateEnvironmentArgs,
-	): Promise<OnlyHookErrors<CallHookReturnType<ProjectEnvironmentUpdateHook>>> {
-		assertPluginsInitialized(this.sliceMachinePluginRunner);
-
-		await this._assertAdapterSupportsEnvironments();
-
-		const repositoryName = await this.project.getRepositoryName();
-		const environment =
-			args.environment === repositoryName ? undefined : args.environment;
-
-		const hookResult = await this.sliceMachinePluginRunner.callHook(
-			"project:environment:update",
-			{ environment },
-		);
-
-		return {
-			errors: hookResult.errors,
-		};
-	}
-
-	private async _assertAdapterSupportsEnvironments(): Promise<void> {
-		assertPluginsInitialized(this.sliceMachinePluginRunner);
-
-		const supportsEnvironments = this.checkSupportsEnvironments();
-
-		if (!supportsEnvironments) {
-			const adapterName = await this.project.getAdapterName();
-
-			throw new PluginError(
-				`${adapterName} does not support environments. Use an adapter that implements the \`project:environment:read\` and \`project:environment:update\` hooks to use environments.`,
-			);
-		}
-	}
 }

package/src/managers/screenshots/ScreenshotsManager.ts

@@ -183,13 +183,13 @@ export class ScreenshotsManager extends BaseManager {
 		body?: unknown;
 	}): Promise<Response> {
 		const authenticationToken = await this.user.getAuthenticationToken();
-		const repositoryName = await this.project.getRepositoryName();
+		const sliceMachineConfig = await this.project.getSliceMachineConfig();
 
 		return await fetch(args.url, {
 			body: args.body ? JSON.stringify(args.body) : undefined,
 			headers: {
 				Authorization: `Bearer ${authenticationToken}`,
-				Repository: repositoryName,
+				Repository: sliceMachineConfig.repositoryName,
 				"User-Agent": SLICE_MACHINE_USER_AGENT,
 				...(args.body ? { "Content-Type": "application/json" } : {}),
 			},

package/src/managers/slices/SlicesManager.ts

@@ -764,12 +764,12 @@ export class SlicesManager extends BaseManager {
 				});
 
 			const authenticationToken = await this.user.getAuthenticationToken();
-			const repositoryName = await this.project.getResolvedRepositoryName();
+			const sliceMachineConfig = await this.project.getSliceMachineConfig();
 
 			// TODO: Create a single shared client.
 			const client = prismicCustomTypesClient.createClient({
 				endpoint: API_ENDPOINTS.PrismicModels,
-				repositoryName,
+				repositoryName: sliceMachineConfig.repositoryName,
 				token: authenticationToken,
 				userAgent: args.userAgent || SLICE_MACHINE_USER_AGENT,
 				fetch,
@@ -981,11 +981,11 @@ export class SlicesManager extends BaseManager {
 
 	async fetchRemoteSlices(): Promise<SharedSlice[]> {
 		const authenticationToken = await this.user.getAuthenticationToken();
-		const repositoryName = await this.project.getResolvedRepositoryName();
+		const sliceMachineConfig = await this.project.getSliceMachineConfig();
 
 		const client = prismicCustomTypesClient.createClient({
 			endpoint: API_ENDPOINTS.PrismicModels,
-			repositoryName,
+			repositoryName: sliceMachineConfig.repositoryName,
 			token: authenticationToken,
 			userAgent: SLICE_MACHINE_USER_AGENT,
 			fetch,

package/dist/managers/prismicRepository/sortEnvironments.cjs

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-function sortEnvironments(environments) {
-  return [...environments].sort((a, b) => {
-    switch (a.kind) {
-      case "prod": {
-        return -1;
-      }
-      case "stage": {
-        switch (b.kind) {
-          case "prod": {
-            return 1;
-          }
-          case "stage": {
-            return a.name.localeCompare(b.name);
-          }
-          case "dev":
-          default: {
-            return -1;
-          }
-        }
-      }
-      case "dev": {
-        return 1;
-      }
-      default: {
-        if (b.kind === void 0) {
-          return a.name.localeCompare(b.name);
-        }
-        return 1;
-      }
-    }
-  });
-}
-exports.sortEnvironments = sortEnvironments;
-//# sourceMappingURL=sortEnvironments.cjs.map

package/dist/managers/prismicRepository/sortEnvironments.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"sortEnvironments.cjs","sources":["../../../../src/managers/prismicRepository/sortEnvironments.ts"],"sourcesContent":["import { Environment } from \"./types\";\n\n/**\n * Sorts a list of environments using the following criteria:\n *\n * - The production environment is always first.\n * - Staging environments are always after production, before development\n *   environments, and sorted alphabetically by name.\n * - The development environment is always last.\n *\n * It assumes the list of environments contains one production environment and\n * at most one dev environment.\n *\n * @param environments - The environments to sort.\n *\n * @returns The sorted environments.\n */\nexport function sortEnvironments(environments: Environment[]): Environment[] {\n\treturn [...environments].sort((a, b) => {\n\t\tswitch (a.kind) {\n\t\t\tcase \"prod\": {\n\t\t\t\treturn -1;\n\t\t\t}\n\n\t\t\tcase \"stage\": {\n\t\t\t\tswitch (b.kind) {\n\t\t\t\t\tcase \"prod\": {\n\t\t\t\t\t\treturn 1;\n\t\t\t\t\t}\n\n\t\t\t\t\tcase \"stage\": {\n\t\t\t\t\t\treturn a.name.localeCompare(b.name);\n\t\t\t\t\t}\n\n\t\t\t\t\tcase \"dev\":\n\t\t\t\t\tdefault: {\n\t\t\t\t\t\treturn -1;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tcase \"dev\": {\n\t\t\t\treturn 1;\n\t\t\t}\n\n\t\t\tdefault: {\n\t\t\t\tif (b.kind === undefined) {\n\t\t\t\t\treturn a.name.localeCompare(b.name);\n\t\t\t\t}\n\n\t\t\t\treturn 1;\n\t\t\t}\n\t\t}\n\t});\n}\n"],"names":[],"mappings":";;AAiBM,SAAU,iBAAiB,cAA2B;AAC3D,SAAO,CAAC,GAAG,YAAY,EAAE,KAAK,CAAC,GAAG,MAAK;AACtC,YAAQ,EAAE,MAAM;AAAA,MACf,KAAK,QAAQ;AACL,eAAA;AAAA,MACP;AAAA,MAED,KAAK,SAAS;AACb,gBAAQ,EAAE,MAAM;AAAA,UACf,KAAK,QAAQ;AACL,mBAAA;AAAA,UACP;AAAA,UAED,KAAK,SAAS;AACb,mBAAO,EAAE,KAAK,cAAc,EAAE,IAAI;AAAA,UAClC;AAAA,UAED,KAAK;AAAA,UACL,SAAS;AACD,mBAAA;AAAA,UACP;AAAA,QACD;AAAA,MACD;AAAA,MAED,KAAK,OAAO;AACJ,eAAA;AAAA,MACP;AAAA,MAED,SAAS;AACJ,YAAA,EAAE,SAAS,QAAW;AACzB,iBAAO,EAAE,KAAK,cAAc,EAAE,IAAI;AAAA,QAClC;AAEM,eAAA;AAAA,MACP;AAAA,IACD;AAAA,EAAA,CACD;AACF;;"}

package/dist/managers/prismicRepository/sortEnvironments.d.ts

@@ -1,17 +0,0 @@
-import { Environment } from "./types";
-/**
- * Sorts a list of environments using the following criteria:
- *
- * - The production environment is always first.
- * - Staging environments are always after production, before development
- *   environments, and sorted alphabetically by name.
- * - The development environment is always last.
- *
- * It assumes the list of environments contains one production environment and
- * at most one dev environment.
- *
- * @param environments - The environments to sort.
- *
- * @returns The sorted environments.
- */
-export declare function sortEnvironments(environments: Environment[]): Environment[];

package/dist/managers/prismicRepository/sortEnvironments.js

@@ -1,36 +0,0 @@
-function sortEnvironments(environments) {
-  return [...environments].sort((a, b) => {
-    switch (a.kind) {
-      case "prod": {
-        return -1;
-      }
-      case "stage": {
-        switch (b.kind) {
-          case "prod": {
-            return 1;
-          }
-          case "stage": {
-            return a.name.localeCompare(b.name);
-          }
-          case "dev":
-          default: {
-            return -1;
-          }
-        }
-      }
-      case "dev": {
-        return 1;
-      }
-      default: {
-        if (b.kind === void 0) {
-          return a.name.localeCompare(b.name);
-        }
-        return 1;
-      }
-    }
-  });
-}
-export {
-  sortEnvironments
-};
-//# sourceMappingURL=sortEnvironments.js.map

package/dist/managers/prismicRepository/sortEnvironments.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sortEnvironments.js","sources":["../../../../src/managers/prismicRepository/sortEnvironments.ts"],"sourcesContent":["import { Environment } from \"./types\";\n\n/**\n * Sorts a list of environments using the following criteria:\n *\n * - The production environment is always first.\n * - Staging environments are always after production, before development\n *   environments, and sorted alphabetically by name.\n * - The development environment is always last.\n *\n * It assumes the list of environments contains one production environment and\n * at most one dev environment.\n *\n * @param environments - The environments to sort.\n *\n * @returns The sorted environments.\n */\nexport function sortEnvironments(environments: Environment[]): Environment[] {\n\treturn [...environments].sort((a, b) => {\n\t\tswitch (a.kind) {\n\t\t\tcase \"prod\": {\n\t\t\t\treturn -1;\n\t\t\t}\n\n\t\t\tcase \"stage\": {\n\t\t\t\tswitch (b.kind) {\n\t\t\t\t\tcase \"prod\": {\n\t\t\t\t\t\treturn 1;\n\t\t\t\t\t}\n\n\t\t\t\t\tcase \"stage\": {\n\t\t\t\t\t\treturn a.name.localeCompare(b.name);\n\t\t\t\t\t}\n\n\t\t\t\t\tcase \"dev\":\n\t\t\t\t\tdefault: {\n\t\t\t\t\t\treturn -1;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tcase \"dev\": {\n\t\t\t\treturn 1;\n\t\t\t}\n\n\t\t\tdefault: {\n\t\t\t\tif (b.kind === undefined) {\n\t\t\t\t\treturn a.name.localeCompare(b.name);\n\t\t\t\t}\n\n\t\t\t\treturn 1;\n\t\t\t}\n\t\t}\n\t});\n}\n"],"names":[],"mappings":"AAiBM,SAAU,iBAAiB,cAA2B;AAC3D,SAAO,CAAC,GAAG,YAAY,EAAE,KAAK,CAAC,GAAG,MAAK;AACtC,YAAQ,EAAE,MAAM;AAAA,MACf,KAAK,QAAQ;AACL,eAAA;AAAA,MACP;AAAA,MAED,KAAK,SAAS;AACb,gBAAQ,EAAE,MAAM;AAAA,UACf,KAAK,QAAQ;AACL,mBAAA;AAAA,UACP;AAAA,UAED,KAAK,SAAS;AACb,mBAAO,EAAE,KAAK,cAAc,EAAE,IAAI;AAAA,UAClC;AAAA,UAED,KAAK;AAAA,UACL,SAAS;AACD,mBAAA;AAAA,UACP;AAAA,QACD;AAAA,MACD;AAAA,MAED,KAAK,OAAO;AACJ,eAAA;AAAA,MACP;AAAA,MAED,SAAS;AACJ,YAAA,EAAE,SAAS,QAAW;AACzB,iBAAO,EAAE,KAAK,cAAc,EAAE,IAAI;AAAA,QAClC;AAEM,eAAA;AAAA,MACP;AAAA,IACD;AAAA,EAAA,CACD;AACF;"}

package/src/managers/prismicRepository/sortEnvironments.ts

@@ -1,55 +0,0 @@
-import { Environment } from "./types";
-
-/**
- * Sorts a list of environments using the following criteria:
- *
- * - The production environment is always first.
- * - Staging environments are always after production, before development
- *   environments, and sorted alphabetically by name.
- * - The development environment is always last.
- *
- * It assumes the list of environments contains one production environment and
- * at most one dev environment.
- *
- * @param environments - The environments to sort.
- *
- * @returns The sorted environments.
- */
-export function sortEnvironments(environments: Environment[]): Environment[] {
-	return [...environments].sort((a, b) => {
-		switch (a.kind) {
-			case "prod": {
-				return -1;
-			}
-
-			case "stage": {
-				switch (b.kind) {
-					case "prod": {
-						return 1;
-					}
-
-					case "stage": {
-						return a.name.localeCompare(b.name);
-					}
-
-					case "dev":
-					default: {
-						return -1;
-					}
-				}
-			}
-
-			case "dev": {
-				return 1;
-			}
-
-			default: {
-				if (b.kind === undefined) {
-					return a.name.localeCompare(b.name);
-				}
-
-				return 1;
-			}
-		}
-	});
-}