@workos/oagen 0.4.0 → 0.5.0

package/README.md

@@ -128,7 +128,6 @@ const myEmitter: Emitter = {
     /* ... */
   ],
   generateErrors: () => [],
-  generateConfig: () => [],
   generateTests: () => [],
   fileHeader: () => "// Auto-generated by oagen. Do not edit.",
 };

package/dist/cli/index.mjs

@@ -1662,7 +1662,9 @@ function extractParams(params, location, operationContext) {
 		description: p.description,
 		deprecated: p.deprecated || p.schema?.deprecated || void 0,
 		default: p.schema?.default,
-		example: p.example ?? p.schema?.example
+		example: p.example ?? p.schema?.example,
+		style: p.style,
+		explode: p.explode
 	}));
 }
 function extractRequestBody(body, op, inlineModels) {
@@ -3426,6 +3428,30 @@ function safeParse(parser, source) {
 * Supports any language with a tree-sitter grammar package.
 */
 const parserCache = /* @__PURE__ */ new Map();
+/**
+* When replacing an existing docstring with a generated one, carry over any
+* `@deprecated` lines from the existing doc that aren't present in the
+* generated doc.  This prevents hand-written deprecation notices from being
+* silently dropped during docstring refresh.
+*/
+function preserveDeprecatedTags(existingDoc, generatedDoc) {
+	if (!existingDoc.includes("@deprecated")) return generatedDoc;
+	if (generatedDoc.includes("@deprecated")) return generatedDoc;
+	const deprecatedParts = [];
+	for (const line of existingDoc.split("\n")) if (/@deprecated\b/.test(line)) {
+		const match = line.match(/@deprecated\b.*/);
+		if (match) {
+			const cleaned = match[0].replace(/\s*\*\/\s*$/, "");
+			deprecatedParts.push(`   * ${cleaned}`);
+		}
+	}
+	if (deprecatedParts.length === 0) return generatedDoc;
+	const closingIdx = generatedDoc.lastIndexOf("*/");
+	if (closingIdx === -1) return generatedDoc;
+	const before = generatedDoc.slice(0, closingIdx);
+	const after = generatedDoc.slice(closingIdx);
+	return before + deprecatedParts.join("\n") + "\n " + after;
+}
 function findIgnoredRegions(source) {
 	const regions = [];
 	const startTag = "@oagen-ignore-start";
@@ -3539,10 +3565,21 @@ async function mergeIntoExisting(existingContent, generatedContent, language, he
 	}
 	for (const anchor of existingStatements.importAnchors) lastImportEndIndex = existingContent.slice(0, existingContent.indexOf(anchor)).split("\n").length - 1 + anchor.split("\n").length - 1;
 	if (lastImportEndIndex === -1 && existingStatements.importInsertionAnchor) lastImportEndIndex = existingContent.slice(0, existingContent.indexOf(existingStatements.importInsertionAnchor)).split("\n").length - 1 + existingStatements.importInsertionAnchor.split("\n").length - 1;
+	const existingExportedNames = /* @__PURE__ */ new Set();
 	for (const stmt of existingStatements.statements) {
-		if (stmt.kind === "reexport") existingReexports.add(adapter.normalizeReexport ? adapter.normalizeReexport(stmt.text.trim()) : stmt.text.trim());
-		if (stmt.key) existingKeys.add(stmt.key);
-		else existingUnnamedTexts.add(stmt.text.trim());
+		if (stmt.kind === "reexport") {
+			existingReexports.add(adapter.normalizeReexport ? adapter.normalizeReexport(stmt.text.trim()) : stmt.text.trim());
+			const braceMatch = stmt.text.match(/\{([^}]+)\}/);
+			if (braceMatch) for (const part of braceMatch[1].split(",")) {
+				const segments = part.trim().split(/\s+as\s+/);
+				const exportedName = (segments[1] ?? segments[0]).trim();
+				if (exportedName) existingExportedNames.add(exportedName);
+			}
+		}
+		if (stmt.key) {
+			existingKeys.add(stmt.key);
+			existingExportedNames.add(stmt.key);
+		} else existingUnnamedTexts.add(stmt.text.trim());
 	}
 	const headerLine = header.trim();
 	const newImports = [];
@@ -3602,6 +3639,17 @@ async function mergeIntoExisting(existingContent, generatedContent, language, he
 				preserved++;
 				continue;
 			}
+			const braceMatch = stmt.text.match(/\{([^}]+)\}/);
+			if (braceMatch) {
+				const exportedNames = braceMatch[1].split(",").map((n) => {
+					const parts = n.trim().split(/\s+as\s+/);
+					return (parts[1] ?? parts[0]).trim();
+				}).filter(Boolean);
+				if (exportedNames.length > 0 && exportedNames.every((n) => existingExportedNames.has(n))) {
+					preserved++;
+					continue;
+				}
+			}
 		}
 		if (stmt.key && (existingKeys.has(stmt.key) || existingImportedNames.has(stmt.key))) {
 			preserved++;
@@ -3703,10 +3751,11 @@ async function mergeIntoExisting(existingContent, generatedContent, language, he
 			const genDoc = genInfo.docstring && genInfo.docstring.text.trim() !== headerLine ? genInfo.docstring : null;
 			if (genDoc) if (existInfo.docstring) {
 				if (!existInfo.docstring.text.includes("@oagen-ignore") && existInfo.docstring.text !== genDoc.text) {
+					const newText = preserveDeprecatedTags(existInfo.docstring.text, genDoc.text);
 					edits.push({
 						start: existInfo.docstring.startIndex,
 						end: existInfo.docstring.endIndex,
-						newText: genDoc.text
+						newText
 					});
 					docstringUpdates++;
 				}
@@ -3723,14 +3772,16 @@ async function mergeIntoExisting(existingContent, generatedContent, language, he
 			const matchedExistMembers = /* @__PURE__ */ new Set();
 			for (const [memberName, genMember] of genInfo.members) {
 				const existMember = existInfo.members.get(memberName);
-				if (!existMember || !genMember.docstring) continue;
+				if (!existMember) continue;
 				matchedExistMembers.add(memberName);
+				if (!genMember.docstring) continue;
 				if (existMember.docstring) {
 					if (!existMember.docstring.text.includes("@oagen-ignore") && existMember.docstring.text !== genMember.docstring.text) {
+						const newText = preserveDeprecatedTags(existMember.docstring.text, genMember.docstring.text);
 						edits.push({
 							start: existMember.docstring.startIndex,
 							end: existMember.docstring.endIndex,
-							newText: genMember.docstring.text
+							newText
 						});
 						docstringUpdates++;
 					}
@@ -3745,34 +3796,59 @@ async function mergeIntoExisting(existingContent, generatedContent, language, he
 					docstringUpdates++;
 				}
 			}
-			for (const [_genName, genMember] of genInfo.members) {
+			const unmatchedGenByFp = /* @__PURE__ */ new Map();
+			for (const [genName, genMember] of genInfo.members) {
+				if (matchedExistMembers.has(genName)) continue;
 				if (!genMember.docstring || !genMember.urlFingerprint) continue;
-				for (const [existName, existMember] of existInfo.members) {
-					if (matchedExistMembers.has(existName)) continue;
-					if (!existMember.urlFingerprint || existMember.urlFingerprint !== genMember.urlFingerprint) continue;
-					if (existMember.docstring) {
-						if (existMember.docstring.text.includes("@oagen-ignore")) continue;
-						if (existMember.docstring.text !== genMember.docstring.text) {
-							edits.push({
-								start: existMember.docstring.startIndex,
-								end: existMember.docstring.endIndex,
-								newText: genMember.docstring.text
-							});
-							docstringUpdates++;
-						}
-					} else {
-						const lineStart = existMember.declStartIndex - existMember.declColumn;
-						const indent = " ".repeat(existMember.declColumn);
+				if (existInfo.members.has(genName)) continue;
+				const bucket = unmatchedGenByFp.get(genMember.urlFingerprint) ?? [];
+				bucket.push({
+					name: genName,
+					member: genMember
+				});
+				unmatchedGenByFp.set(genMember.urlFingerprint, bucket);
+			}
+			const unmatchedExistByFp = /* @__PURE__ */ new Map();
+			for (const [existName, existMember] of existInfo.members) {
+				if (matchedExistMembers.has(existName)) continue;
+				if (!existMember.urlFingerprint) continue;
+				const bucket = unmatchedExistByFp.get(existMember.urlFingerprint) ?? [];
+				bucket.push({
+					name: existName,
+					member: existMember
+				});
+				unmatchedExistByFp.set(existMember.urlFingerprint, bucket);
+			}
+			for (const [fp, genBucket] of unmatchedGenByFp) {
+				if (genBucket.length !== 1) continue;
+				const existBucket = unmatchedExistByFp.get(fp);
+				if (!existBucket || existBucket.length !== 1) continue;
+				const genMember = genBucket[0].member;
+				const existEntry = existBucket[0];
+				const existMember = existEntry.member;
+				if (!genMember.docstring) continue;
+				if (existMember.docstring) {
+					if (existMember.docstring.text.includes("@oagen-ignore")) continue;
+					if (existMember.docstring.text !== genMember.docstring.text) {
+						const newText = preserveDeprecatedTags(existMember.docstring.text, genMember.docstring.text);
 						edits.push({
-							start: lineStart,
-							end: lineStart,
-							newText: indent + genMember.docstring.text + "\n"
+							start: existMember.docstring.startIndex,
+							end: existMember.docstring.endIndex,
+							newText
 						});
 						docstringUpdates++;
 					}
-					matchedExistMembers.add(existName);
-					break;
+				} else {
+					const lineStart = existMember.declStartIndex - existMember.declColumn;
+					const indent = " ".repeat(existMember.declColumn);
+					edits.push({
+						start: lineStart,
+						end: lineStart,
+						newText: indent + genMember.docstring.text + "\n"
+					});
+					docstringUpdates++;
 				}
+				matchedExistMembers.add(existEntry.name);
 			}
 		}
 		if (edits.length > 0) {
@@ -4059,12 +4135,16 @@ function spliceExtraImports(existingLines, resultLines) {
 	const extraSimple = [...existingSimple].filter((l) => !generatedSimple.has(l));
 	const existingFrom = collectFromImports(existingLines);
 	const generatedFrom = collectFromImports(resultLines);
+	const allGeneratedIds = /* @__PURE__ */ new Set();
+	for (const ids of generatedFrom.values()) for (const id of ids) allGeneratedIds.add(id);
 	const extraFromLines = [];
 	for (const [mod, existIds] of existingFrom) {
 		const genIds = generatedFrom.get(mod);
-		if (!genIds) extraFromLines.push(`from ${mod} import ${[...existIds].join(", ")}`);
-		else {
-			const extra = [...existIds].filter((id) => !genIds.has(id));
+		if (!genIds) {
+			const extra = [...existIds].filter((id) => !allGeneratedIds.has(id));
+			if (extra.length > 0) extraFromLines.push(`from ${mod} import ${extra.join(", ")}`);
+		} else {
+			const extra = [...existIds].filter((id) => !genIds.has(id) && !allGeneratedIds.has(id));
 			if (extra.length > 0) extraFromLines.push(`from ${mod} import ${extra.join(", ")}`);
 		}
 	}
@@ -4205,7 +4285,9 @@ function resolveOperations(spec, hints, mountRules) {
 			service,
 			methodName,
 			mountOn,
-			wrappers
+			wrappers,
+			defaults: hint?.defaults ?? {},
+			inferFromClient: hint?.inferFromClient ?? []
 		});
 	}
 	return resolved;
@@ -4297,7 +4379,6 @@ function generateAllFiles(spec, emitter, ctx) {
 		...emitter.generateResources(spec.services, ctx),
 		...emitter.generateClient(spec, ctx),
 		...emitter.generateErrors(ctx),
-		...emitter.generateConfig(ctx),
 		...emitter.generateTypeSignatures?.(reachableSpec, ctx) ?? [],
 		...emitter.generateTests(reachableSpec, ctx),
 		...emitter.generateManifest?.(spec, ctx) ?? []
@@ -6755,10 +6836,6 @@ export const ${`${toCamelCase(lang)}Emitter`}: Emitter = {
     return [];
   },
 
-  generateConfig(_ctx: EmitterContext): GeneratedFile[] {
-    return [];
-  },
-
   generateTypeSignatures(_spec: ApiSpec, _ctx: EmitterContext): GeneratedFile[] {
     return [];
   },