kizlo 0.19.0 → 0.20.0

package/dist/cli/daemon/generate.js

@@ -14,16 +14,16 @@ import fs from "node:fs";
 
 //#region src/cli/daemon/generate.ts
 /**
-* The generated barrel is also written as a stub by `kizlo init`. It re-exports `endpoints` rather
-* than pre-wrapping it: a server entry passes `wordpress: { endpoints }` itself, so the rest of the
-* WordPress options stay visible at the call site instead of hiding inside a generated object.
+* The generated barrel is also written as a stub by `kizlo init`. It re-exports `introspection`
+* rather than pre-wrapping it: a server entry passes `createKizlo({ introspection })` itself, so the
+* rest of the options stay visible at the call site instead of hiding inside a generated object.
 */
 const CONTRACT_BARREL = [
 	`import type { procedures } from ".."`,
 	`import contractJson from "./contract.json"`,
 	``,
 	`export const contract = contractJson as unknown as typeof procedures`,
-	`export { endpoints, type WordPressClient } from "./introspection"`,
+	`export { introspection, type WordPressClient } from "./introspection"`,
 	``
 ].join("\n");
 var LegacyRouterExportError = class extends Error {
@@ -42,13 +42,13 @@ var LegacyRouterExportError = class extends Error {
 const INTROSPECTION_STUB = [
 	`import type { WP_Client } from "kizlo"`,
 	``,
-	`export const endpoints = {} as any`,
+	`export const introspection = {} as any`,
 	``,
-	`export type WordPressClient = WP_Client<typeof endpoints>`,
+	`export type WordPressClient = WP_Client<typeof introspection>`,
 	``,
 	`declare module "kizlo" {`,
 	`\tinterface WordPressClientRegistry {`,
-	`\t\tendpoints: typeof endpoints`,
+	`\t\tintrospection: typeof introspection`,
 	`\t}`,
 	`\tinterface WordPressEndpointRegistry {`,
 	`\t\t[path: string]: any`,
@@ -177,7 +177,7 @@ function reportPluginVersion(installed) {
 /** Fetch `/introspect`, reporting its diagnostics in the CLI's voice. Returns undefined on a 304. */
 async function fetchDocument(cwd, options, etag) {
 	loadEnvFiles(cwd);
-	const result = await fetchIntrospection(options.credentials ?? resolveWordPressConnection(void 0, integrationEnv([node()])).credentials, {
+	const result = await fetchIntrospection(options.credentials ?? resolveWordPressConnection(integrationEnv([node()])).credentials, {
 		etag: options.strict ? void 0 : etag,
 		fetch: options.fetch
 	});

package/dist/cli/daemon/watch.js

@@ -140,7 +140,7 @@ async function startWatcher(cwd, opts) {
 			return;
 		}
 		loadEnvFiles(cwd);
-		const { credentials } = resolveWordPressConnection(void 0, integrationEnv([node()]));
+		const { credentials } = resolveWordPressConnection(integrationEnv([node()]));
 		try {
 			const result = await generateOnce(cfg, { credentials });
 			if (result.contract === "built") log.success("Contract generated");

package/dist/context.d.ts

@@ -16,7 +16,7 @@ interface ContextConfig {
   siteSecret: string;
   adapters?: ServiceAdapters;
   credentials: WordPressCredentials;
-  wordpressEndpoints?: object;
+  introspection?: object;
   /** WordPress plugins the registered integrations need, checked against what each response reports. */
   integrationPlugins?: IntegrationPluginRequirement[];
 }

package/dist/context.js

@@ -55,7 +55,7 @@ var Context = class {
 		this.wordpress = createWordPressClient(new WordPressTransport({
 			credentials: config.credentials,
 			onResult: (result) => this.warnIfOutdated(result)
-		}), config.wordpressEndpoints ?? {});
+		}), config.introspection ?? {});
 		this.settings = new SettingsService(this.wordpress);
 		this.email = new EmailService(this.wordpress);
 		this.logger = this.createLogger();

package/dist/kizlo.d.ts

@@ -14,7 +14,7 @@ interface KizloConfig<TIntegrations extends readonly AnyIntegration[]> {
   integrations?: TIntegrations;
   logging?: false | LogLevel;
   credentials: WordPressCredentials;
-  wordpressEndpoints?: object;
+  introspection?: object;
 }
 type RootProcedures<TIntegrations extends readonly AnyIntegration[]> = InferIntegrationProcedures<TIntegrations> & CoreProcedures;
 type S2SClient<TIntegrations extends readonly AnyIntegration[]> = ResultClient<RootProcedures<TIntegrations>>;
@@ -41,21 +41,18 @@ interface CreateKizloOptions<TIntegrations extends readonly AnyIntegration[] = [
   /** Enable Kizlo's built-in console logger at this level. */
   logging?: false | LogLevel;
   /**
-   * The generated endpoints to run against WordPress, plus optional explicit credentials. Pass the
-   * `endpoints` export of your generated barrel. Missing credentials fall back to the `wordpressUrl`,
-   * `wordpressUsername`, and `wordpressPassword` values contributed by integrations.
+   * The generated WordPress introspection tree to run the typed client against. Pass the
+   * `introspection` export of your generated barrel. WordPress credentials resolve from the
+   * `wordpressUrl`, `wordpressUsername`, and `wordpressPassword` values contributed by integrations.
    */
-  wordpress?: {
-    endpoints?: object;
-    credentials?: Partial<WordPressCredentials>;
-  };
+  introspection?: object;
 }
 /**
  * Compose environment sources without letting `undefined` erase an earlier value, then resolve
  * Kizlo's active WordPress connection from the canonical `mode` value.
  */
 declare function integrationEnv(integrations: readonly AnyIntegration[]): EnvReader;
-declare function resolveWordPressConnection(options: Pick<CreateKizloOptions, "wordpress"> | undefined, env: EnvReader): {
+declare function resolveWordPressConnection(env: EnvReader): {
   credentials: WordPressCredentials;
 };
 /**

package/dist/kizlo.js

@@ -30,7 +30,7 @@ var Kizlo = class {
 			adapters: integrations.adapters,
 			siteSecret: config.siteSecret,
 			credentials: config.credentials,
-			wordpressEndpoints: config.wordpressEndpoints,
+			introspection: config.introspection,
 			integrationPlugins: integrations.plugins
 		});
 		this.procedures = Object.assign(Object.assign({}, {
@@ -105,7 +105,7 @@ var Kizlo = class {
 			if (reservedIds.has(integration.id)) throw new KizloError("INTEGRATION_ID_CONFLICT", { message: `The integration id "${integration.id}" is reserved by Kizlo. Choose a different integration id.` });
 			if (integrationIds.has(integration.id)) throw new KizloError("INTEGRATION_ID_CONFLICT", { message: `The integration id "${integration.id}" is registered more than once. Give every integration a unique id.` });
 			integrationIds.add(integration.id);
-			if (!generating) assertIntegrationEndpoints(integration, this.config.wordpressEndpoints ?? {});
+			if (!generating) assertIntegrationEndpoints(integration, this.config.introspection ?? {});
 			plugins.push(...integration.requires?.plugins ?? []);
 			if (integration.procedures && Object.keys(integration.procedures).length > 0) procedures[integration.id] = integration.procedures;
 			for (const handler of integration.events ?? []) events.push(handler);
@@ -161,12 +161,11 @@ function requireEnvValue(name, env) {
 	if (isContractGeneration()) return "";
 	throw new KizloError("MISSING_ENV_VALUE", { message: `Kizlo requires the "${name}" environment value. Provide it through an integration or an explicit createKizlo option.` });
 }
-function resolveWordPressConnection(options, env) {
-	const credentials = options?.wordpress?.credentials;
+function resolveWordPressConnection(env) {
 	return { credentials: {
-		url: credentials?.url ?? requireEnvValue("wordpressUrl", env),
-		username: credentials?.username ?? requireEnvValue("wordpressUsername", env),
-		password: credentials?.password ?? requireEnvValue("wordpressPassword", env)
+		url: requireEnvValue("wordpressUrl", env),
+		username: requireEnvValue("wordpressUsername", env),
+		password: requireEnvValue("wordpressPassword", env)
 	} };
 }
 /**
@@ -176,14 +175,14 @@ function resolveKizloConfig(options) {
 	const integrations = options?.integrations ?? [];
 	const env = integrationEnv(integrations);
 	if (!isContractGeneration()) for (const integration of integrations) assertIntegrationEnv(integration, env);
-	const { credentials } = resolveWordPressConnection(options, env);
+	const { credentials } = resolveWordPressConnection(env);
 	return {
 		baseUrl: options?.baseUrl ?? requireEnvValue("baseUrl", env),
 		siteSecret: options?.siteSecret ?? requireEnvValue("siteSecret", env),
 		integrations,
 		logging: options?.logging,
 		credentials,
-		wordpressEndpoints: options?.wordpress?.endpoints
+		introspection: options?.introspection
 	};
 }
 /**

package/dist/package.js

@@ -1,5 +1,5 @@
 //#region package.json
-var version = "0.19.0";
+var version = "0.20.0";
 
 //#endregion
 export { version };

package/dist/procedures.d.ts

@@ -44,7 +44,7 @@ declare const CORE_PROCEDURES: {
         include?: string | number | (string | number)[] | undefined;
         offset?: string | number | undefined;
         order?: "asc" | "desc" | undefined;
-        orderby?: "id" | "date" | "slug" | "parent" | "title" | "author" | "include" | "modified" | "relevance" | "include_slugs" | undefined;
+        orderby?: "date" | "id" | "slug" | "parent" | "title" | "author" | "include" | "modified" | "relevance" | "include_slugs" | undefined;
         searchColumns?: ("post_title" | "post_content" | "post_excerpt")[] | undefined;
         slug?: string | string[] | undefined;
         taxRelation?: "AND" | "OR" | undefined;
@@ -99,7 +99,7 @@ declare const CORE_PROCEDURES: {
         include?: string | number | (string | number)[] | undefined;
         offset?: string | number | undefined;
         order?: "asc" | "desc" | undefined;
-        orderby?: "id" | "date" | "slug" | "parent" | "title" | "author" | "include" | "modified" | "relevance" | "include_slugs" | "menu_order" | undefined;
+        orderby?: "date" | "id" | "slug" | "parent" | "title" | "author" | "include" | "modified" | "relevance" | "include_slugs" | "menu_order" | undefined;
         searchColumns?: ("post_title" | "post_content" | "post_excerpt")[] | undefined;
         slug?: string | string[] | undefined;
         parent?: string | number | (string | number)[] | undefined;
@@ -136,7 +136,7 @@ declare const CORE_PROCEDURES: {
         exclude?: string | number | (string | number)[] | undefined;
         include?: string | number | (string | number)[] | undefined;
         order?: "asc" | "desc" | undefined;
-        orderBy?: "id" | "count" | "slug" | "name" | "description" | "include" | "include_slugs" | "term_group" | undefined;
+        orderBy?: "count" | "id" | "slug" | "name" | "description" | "include" | "include_slugs" | "term_group" | undefined;
         hideEmpty?: string | boolean | undefined;
         parent?: string | number | undefined;
         post?: string | number | undefined;
@@ -172,7 +172,7 @@ declare const CORE_PROCEDURES: {
         exclude?: string | number | (string | number)[] | undefined;
         include?: string | number | (string | number)[] | undefined;
         order?: "asc" | "desc" | undefined;
-        orderBy?: "id" | "count" | "slug" | "name" | "description" | "include" | "include_slugs" | "term_group" | undefined;
+        orderBy?: "count" | "id" | "slug" | "name" | "description" | "include" | "include_slugs" | "term_group" | undefined;
         hideEmpty?: string | boolean | undefined;
         post?: string | number | undefined;
         slug?: string | string[] | undefined;
@@ -292,7 +292,7 @@ declare const CORE_PROCEDURES: {
           include?: string | number | (string | number)[] | undefined;
           offset?: string | number | undefined;
           order?: "asc" | "desc" | undefined;
-          orderby?: "id" | "date" | "slug" | "parent" | "title" | "author" | "include" | "relevance" | "include_slugs" | "menu_order" | undefined;
+          orderby?: "date" | "id" | "slug" | "parent" | "title" | "author" | "include" | "relevance" | "include_slugs" | "menu_order" | undefined;
           searchColumns?: ("post_title" | "post_content" | "post_excerpt")[] | undefined;
           slug?: string | string[] | undefined;
           taxRelation?: "AND" | "OR" | undefined;
@@ -371,7 +371,7 @@ declare const CORE_PROCEDURES: {
           include?: string | number | (string | number)[] | undefined;
           offset?: string | number | undefined;
           order?: "asc" | "desc" | undefined;
-          orderby?: "id" | "date" | "slug" | "parent" | "title" | "author" | "include" | "relevance" | "include_slugs" | "menu_order" | undefined;
+          orderby?: "date" | "id" | "slug" | "parent" | "title" | "author" | "include" | "relevance" | "include_slugs" | "menu_order" | undefined;
           searchColumns?: ("post_title" | "post_content" | "post_excerpt")[] | undefined;
           slug?: string | string[] | undefined;
           taxRelation?: "AND" | "OR" | undefined;
@@ -507,7 +507,7 @@ declare const CORE_PROCEDURES: {
         include?: string | number | (string | number)[] | undefined;
         offset?: string | number | undefined;
         order?: "asc" | "desc" | undefined;
-        orderby?: "id" | "date" | "parent" | "include" | "post" | undefined;
+        orderby?: "date" | "id" | "parent" | "include" | "post" | undefined;
         parent?: string | number | (string | number)[] | undefined;
         parentExclude?: string | number | (string | number)[] | undefined;
         post?: string | number | (string | number)[] | undefined;

package/dist/wordpress/generate.js

@@ -383,7 +383,7 @@ function renderRegistries(tree, document) {
 	return [
 		`declare module "kizlo" {`,
 		`\tinterface WordPressClientRegistry {`,
-		`\t\tendpoints: typeof endpoints`,
+		`\t\tintrospection: typeof introspection`,
 		`\t}`,
 		`\tinterface WordPressEndpointRegistry {`,
 		...endpoints,
@@ -431,8 +431,8 @@ function generateWordPressModule(document) {
 	const endpointBody = renderEndpointNode(tree, "	");
 	const moduleBody = [
 		body,
-		`export const endpoints = ${endpointBody}`,
-		`export type WordPressClient = WP_Client<typeof endpoints>`,
+		`export const introspection = ${endpointBody}`,
+		`export type WordPressClient = WP_Client<typeof introspection>`,
 		renderRegistries(tree, document)
 	].join(DECLARATION_SEPARATOR);
 	const imports = `import { ${kizloImports(moduleBody, endpointBody !== "{}")} } from "kizlo"`;

package/dist/wordpress/types.d.ts

@@ -48,7 +48,7 @@ interface WordPressCustomFieldsRegistry {}
  * so a freshly scaffolded project compiles against endpoints it has not described yet.
  */
 type ActiveWordPressClient = WordPressClientRegistry extends {
-  endpoints: infer TEndpoints extends object;
+  introspection: infer TEndpoints extends object;
 } ? WP_Client<TEndpoints> & WordPressTransport : WordPressTransport;
 /** Every raw WordPress operation path generated for the active project. */
 type WP_EndpointPath = keyof WordPressEndpointRegistry extends never ? string : Extract<keyof WordPressEndpointRegistry, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kizlo",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "type": "module",
   "description": "A headless WordPress framework for TypeScript.",
   "keywords": [