@workos/oagen 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli/index.mjs +299 -14
- package/dist/cli/index.mjs.map +1 -1
- package/dist/compat/index.d.mts +3 -1
- package/dist/compat/index.d.mts.map +1 -1
- package/dist/compat/index.mjs +5 -2
- package/dist/compat/index.mjs.map +1 -1
- package/dist/{diff-CihuFSbJ.mjs → diff-C38px0NK.mjs} +2 -2
- package/dist/diff-C38px0NK.mjs.map +1 -0
- package/dist/{differ-BTx-rDgJ.d.mts → differ-fdF9qogA.d.mts} +8 -1
- package/dist/differ-fdF9qogA.d.mts.map +1 -0
- package/dist/index.d.mts +37 -1
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +2 -2
- package/dist/index.mjs.map +1 -1
- package/dist/{overlay-DTaApIqN.mjs → overlay-DGcHh1KN.mjs} +258 -1
- package/dist/overlay-DGcHh1KN.mjs.map +1 -0
- package/dist/scripts/smoke/baseline.mjs +1 -1
- package/dist/scripts/smoke/baseline.mjs.map +1 -1
- package/dist/smoke.d.mts +24 -0
- package/dist/smoke.d.mts.map +1 -1
- package/dist/smoke.mjs +1 -1
- package/dist/smoke.mjs.map +1 -1
- package/dist/verify/index.d.mts +1 -1
- package/dist/verify/index.mjs +2 -2
- package/docs/advanced/index.md +1 -0
- package/docs/advanced/transform-spec.md +124 -0
- package/docs/cli.md +13 -12
- package/docs/core/compatibility-policy.md +26 -0
- package/docs/core/compatibility.md +6 -0
- package/docs/index.md +1 -0
- package/package.json +1 -1
- package/dist/diff-CihuFSbJ.mjs.map +0 -1
- package/dist/differ-BTx-rDgJ.d.mts.map +0 -1
- package/dist/overlay-DTaApIqN.mjs.map +0 -1
package/dist/compat/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { $ as BreakingChangeCategory, At as CompatSourceKind, Bt as CompatPolicyHints, Ct as OverlayLookup, Dt as CompatParameter, Et as ViolationSeverity, Ft as CompatVisibility, Ht as mergePolicy, It as LanguageId, Lt as ParameterSensitivity, Mt as CompatSymbol, Nt as CompatSymbolKind, Ot as CompatPassingStyle, Pt as CompatTypeRef, Q as AdditiveChangeCategory, Rt as apiSurfaceToSnapshot, St as MethodOverlay, Tt as ViolationCategory, Vt as getDefaultPolicy, _t as ApiSurface, at as CompatProvenance, bt as Extractor, ct as severityMeetsThreshold, dt as ApiEnum, et as CompatApproval, ft as ApiField, gt as ApiProperty, ht as ApiParam, it as CompatFailLevel, jt as CompatStability, kt as CompatSnapshot, lt as Addition, mt as ApiMethod, nt as CompatChangeSeverity, ot as SoftRiskChangeCategory, pt as ApiInterface, rt as CompatConfig, st as defaultSeverityForCategory, t as ApiSpec, tt as CompatChangeCategory, ut as ApiClass, vt as ApiTypeAlias, wt as Violation, xt as LanguageHints, yt as DiffResult, zt as ALL_LANGUAGE_IDS } from "../types-BL762XqW.mjs";
|
|
2
|
-
import { a as specDerivedEnumValues, c as specDerivedMethodPaths, d as ClassifiedChange, f as classifyAddedSymbol, i as filterSurface, l as specDerivedNames, m as summarizeChanges, n as diffSnapshots, o as specDerivedFieldPaths, p as classifySymbolChanges, r as diffSurfaces, s as specDerivedHttpKeys, t as CompatDiffResult, u as ClassificationResult } from "../differ-
|
|
2
|
+
import { a as specDerivedEnumValues, c as specDerivedMethodPaths, d as ClassifiedChange, f as classifyAddedSymbol, i as filterSurface, l as specDerivedNames, m as summarizeChanges, n as diffSnapshots, o as specDerivedFieldPaths, p as classifySymbolChanges, r as diffSurfaces, s as specDerivedHttpKeys, t as CompatDiffResult, u as ClassificationResult } from "../differ-fdF9qogA.mjs";
|
|
3
3
|
|
|
4
4
|
//#region src/compat/schema.d.ts
|
|
5
5
|
/** Current schema version for compatibility snapshots. */
|
|
@@ -75,6 +75,8 @@ interface CompatReportChange {
|
|
|
75
75
|
old: Record<string, string>;
|
|
76
76
|
new: Record<string, string>;
|
|
77
77
|
message?: string;
|
|
78
|
+
/** Spec-level remediation hint when a recognized upstream pattern was detected. */
|
|
79
|
+
remediation?: string;
|
|
78
80
|
}
|
|
79
81
|
/** Generate a machine-readable compat report from a diff result. */
|
|
80
82
|
declare function generateReport(diff: CompatDiffResult, language?: string): CompatReport;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/compat/schema.ts","../../src/compat/concepts.ts","../../src/compat/report.ts","../../src/compat/approvals.ts","../../src/compat/extractor-registry.ts","../../src/compat/overlay.ts","../../src/compat/extractors/node.ts","../../src/compat/extractors/php.ts","../../src/compat/extractors/python.ts","../../src/compat/extractors/ruby.ts","../../src/compat/extractors/go.ts","../../src/compat/extractors/rust.ts","../../src/compat/extractors/kotlin.ts","../../src/compat/extractors/dotnet.ts","../../src/compat/extractors/elixir.ts","../../src/compat/language-hints.ts"],"mappings":";;;;;cAUa,qBAAA;AAGb;AAAA,iBAAgB,yBAAA,CAA0B,QAAA;EAAY,aAAA;AAAA;;iBAKtC,gBAAA,CAAiB,IAAA,YAAgB,IAAA,IAAQ,cAAA;;;;UCJxC,gBAAA;EDD6D;ECG5E,EAAA;EDE8B;ECA9B,MAAA;EDAqE;ECErE,QAAA,EAAU,oBAAA;EDFqC;ECI/C,MAAA,EAAQ,OAAA,CAAQ,MAAA,CAAO,UAAA,EAAY,oBAAA;EDJkC;ECMrE,OAAA;;EAEA,GAAA,EAAK,MAAA;;EAEL,GAAA,EAAK,MAAA;AAAA;;UAIU,gBAAA;EACf,iBAAA,EAAmB,gBAAA;AAAA;;;;;;;;iBAUL,qBAAA,CACd,kBAAA,EAAoB,KAAA;EAAQ,IAAA,EAAM,gBAAA;EAAkB,QAAA,EAAU,UAAA;AAAA,KAC7D,gBAAA;;iBA4Ba,eAAA,CAAgB,MAAA,EAAQ,gBAAA,GAAmB,oBAAA;;iBAQ3C,0BAAA,CAA2B,MAAA,EAAQ,gBAAA;EACjD,QAAA;EACA,QAAA;EACA,QAAA;AAAA;;;ADvEF;AAAA,UEIiB,YAAA;EACf,aAAA;EACA,QAAA;EACA,OAAA;IACE,QAAA;IACA,QAAA;IACA,QAAA;EAAA;EAEF,OAAA,EAAS,kBAAA;AAAA;;UAIM,kBAAA;EACf,QAAA,EAAU,oBAAA;EACV,QAAA,EAAU,oBAAA;EACV,MAAA;EACA,kBAAA;EACA,UAAA,EAAY,gBAAA;EACZ,GAAA,EAAK,MAAA;EACL,GAAA,EAAK,MAAA;EACL,OAAA;AAAA;;iBAIc,cAAA,CAAe,IAAA,EAAM,gBAAA,EAAkB,QAAA,YAAoB,YAAA;;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/compat/schema.ts","../../src/compat/concepts.ts","../../src/compat/report.ts","../../src/compat/approvals.ts","../../src/compat/extractor-registry.ts","../../src/compat/overlay.ts","../../src/compat/extractors/node.ts","../../src/compat/extractors/php.ts","../../src/compat/extractors/python.ts","../../src/compat/extractors/ruby.ts","../../src/compat/extractors/go.ts","../../src/compat/extractors/rust.ts","../../src/compat/extractors/kotlin.ts","../../src/compat/extractors/dotnet.ts","../../src/compat/extractors/elixir.ts","../../src/compat/language-hints.ts"],"mappings":";;;;;cAUa,qBAAA;AAGb;AAAA,iBAAgB,yBAAA,CAA0B,QAAA;EAAY,aAAA;AAAA;;iBAKtC,gBAAA,CAAiB,IAAA,YAAgB,IAAA,IAAQ,cAAA;;;;UCJxC,gBAAA;EDD6D;ECG5E,EAAA;EDE8B;ECA9B,MAAA;EDAqE;ECErE,QAAA,EAAU,oBAAA;EDFqC;ECI/C,MAAA,EAAQ,OAAA,CAAQ,MAAA,CAAO,UAAA,EAAY,oBAAA;EDJkC;ECMrE,OAAA;;EAEA,GAAA,EAAK,MAAA;;EAEL,GAAA,EAAK,MAAA;AAAA;;UAIU,gBAAA;EACf,iBAAA,EAAmB,gBAAA;AAAA;;;;;;;;iBAUL,qBAAA,CACd,kBAAA,EAAoB,KAAA;EAAQ,IAAA,EAAM,gBAAA;EAAkB,QAAA,EAAU,UAAA;AAAA,KAC7D,gBAAA;;iBA4Ba,eAAA,CAAgB,MAAA,EAAQ,gBAAA,GAAmB,oBAAA;;iBAQ3C,0BAAA,CAA2B,MAAA,EAAQ,gBAAA;EACjD,QAAA;EACA,QAAA;EACA,QAAA;AAAA;;;ADvEF;AAAA,UEIiB,YAAA;EACf,aAAA;EACA,QAAA;EACA,OAAA;IACE,QAAA;IACA,QAAA;IACA,QAAA;EAAA;EAEF,OAAA,EAAS,kBAAA;AAAA;;UAIM,kBAAA;EACf,QAAA,EAAU,oBAAA;EACV,QAAA,EAAU,oBAAA;EACV,MAAA;EACA,kBAAA;EACA,UAAA,EAAY,gBAAA;EACZ,GAAA,EAAK,MAAA;EACL,GAAA,EAAK,MAAA;EACL,OAAA;EDfuB;ECiBvB,WAAA;AAAA;;iBAIc,cAAA,CAAe,IAAA,EAAM,gBAAA,EAAkB,QAAA,YAAoB,YAAA;;iBAwB3D,kBAAA,CAAmB,IAAA,EAAM,gBAAA,EAAkB,IAAA;EAAS,OAAA;EAAmB,QAAA;AAAA;;UA2DtE,gBAAA;EACf,iBAAA;IACE,EAAA;IACA,MAAA;IACA,QAAA,EAAU,oBAAA;IACV,MAAA,EAAQ,OAAA,CAAQ,MAAA,CAAO,UAAA,EAAY,oBAAA;EAAA;AAAA;;iBAKvB,wBAAA,CACd,kBAAA,EAAoB,KAAA;EAAQ,IAAA,EAAM,gBAAA;EAAkB,QAAA,EAAU,UAAA;AAAA,KAC7D,gBAAA;AD1GH;AAAA,iBCuHgB,uBAAA,CACd,kBAAA,EAAoB,KAAA;EAAQ,IAAA,EAAM,gBAAA;EAAkB,QAAA,EAAU,UAAA;AAAA;;;;UCzI/C,aAAA;EHGD;EGDd,MAAA,EAAQ,gBAAA;;EAER,QAAA,EAAU,cAAA;EHDqB;EGG/B,QAAA;AAAA;;UAIe,kBAAA;EACf,KAAA;EACA,MAAA;AAAA;AFbF;AAAA,iBEqBgB,gBAAA,CAAiB,QAAA,EAAU,cAAA,GAAiB,kBAAA;;iBA2B5C,iBAAA,CAAkB,SAAA,EAAW,cAAA,KAAmB,GAAA;;;;;iBAmBhD,aAAA,CACd,MAAA,EAAQ,gBAAA,EACR,SAAA,EAAW,cAAA,IACX,QAAA,EAAU,UAAA,GACT,cAAA;;;;;iBAaa,cAAA,CACd,OAAA,EAAS,gBAAA,IACT,SAAA,EAAW,cAAA,IACX,QAAA,EAAU,UAAA,GACT,aAAA;;;;;iBAea,iBAAA,CACd,OAAA,EAAS,gBAAA,IACT,SAAA,EAAW,cAAA,IACX,QAAA,EAAU,UAAA,GACT,gBAAA;;;iBCpHa,iBAAA,CAAkB,SAAA,EAAW,SAAA;AAAA,iBAI7B,YAAA,CAAa,QAAA,WAAmB,SAAA;;;UCD/B,aAAA;EACf,WAAA;EACA,mBAAA;EACA,aAAA;EACA,UAAA;EACA,IAAA;EACA,UAAA;EACA,UAAA;EACA,WAAA;AAAA;AAAA,iBAoDc,kBAAA,CACd,OAAA,EAAS,UAAA,EACT,QAAA,GAAW,aAAA,IACX,IAAA,GAAO,OAAA,EACP,KAAA,GAAQ,aAAA,EACR,OAAA;EAAY,gBAAA;AAAA,IACX,aAAA;;iBA6aa,iBAAA,CAAkB,MAAA,EAAQ,gBAAA;;;;;;iBAS1B,YAAA,CAAa,OAAA,EAAS,aAAA,EAAe,OAAA,EAAS,gBAAA,IAAoB,QAAA,EAAU,UAAA,GAAa,aAAA;;;cC3e5F,aAAA,EAAe,SAAA;;;;cCqMf,YAAA,EAAc,SAAA;;;APxM3B;AAAA,cQgWa,eAAA,EAAiB,SAAA;;;cC7RjB,aAAA,EAAe,SAAA;;;cC2Df,WAAA,EAAa,SAAA;;;cCjEb,aAAA,EAAe,SAAA;;;cCJf,eAAA,EAAiB,SAAA;;;;cCsLjB,eAAA,EAAiB,SAAA;;;cCnKjB,eAAA,EAAiB,SAAA;;;;;;;cC/BjB,SAAA,EAAW,aAAA;;;;;iBAuJR,YAAA,CAAa,SAAA,EAAW,OAAA,CAAQ,aAAA,IAAiB,aAAA"}
|
package/dist/compat/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { t as safeParse$1, v as ExtractorError } from "../tree-sitter-DcUvm0KA.mjs";
|
|
2
|
-
import { A as getDefaultPolicy, C as defaultSeverityForCategory, D as isCompatibleSchemaVersion, E as COMPAT_SCHEMA_VERSION, O as validateSnapshot, S as summarizeChanges, T as apiSurfaceToSnapshot, _ as nodeHints, a as registerExtractor, b as classifyAddedSymbol, c as filterSurface, d as specDerivedHttpKeys, f as specDerivedMethodPaths, g as namedTypeWordsOverlap, h as defaultIsNullableOnlyDifference, i as getExtractor, j as mergePolicy, k as ALL_LANGUAGE_IDS, l as specDerivedEnumValues, m as NAMED_TYPE_RE, n as isPatchableChange, o as diffSnapshots, p as specDerivedNames, r as patchOverlay, s as diffSurfaces, t as buildOverlayLookup, u as specDerivedFieldPaths, v as resolveHints, w as severityMeetsThreshold, x as classifySymbolChanges, y as typeExistsInSurface } from "../overlay-
|
|
2
|
+
import { A as getDefaultPolicy, C as defaultSeverityForCategory, D as isCompatibleSchemaVersion, E as COMPAT_SCHEMA_VERSION, O as validateSnapshot, S as summarizeChanges, T as apiSurfaceToSnapshot, _ as nodeHints, a as registerExtractor, b as classifyAddedSymbol, c as filterSurface, d as specDerivedHttpKeys, f as specDerivedMethodPaths, g as namedTypeWordsOverlap, h as defaultIsNullableOnlyDifference, i as getExtractor, j as mergePolicy, k as ALL_LANGUAGE_IDS, l as specDerivedEnumValues, m as NAMED_TYPE_RE, n as isPatchableChange, o as diffSnapshots, p as specDerivedNames, r as patchOverlay, s as diffSurfaces, t as buildOverlayLookup, u as specDerivedFieldPaths, v as resolveHints, w as severityMeetsThreshold, x as classifySymbolChanges, y as typeExistsInSurface } from "../overlay-DGcHh1KN.mjs";
|
|
3
3
|
import path, { basename, dirname, join, relative, resolve } from "node:path";
|
|
4
4
|
import Parser from "tree-sitter";
|
|
5
5
|
import ts from "typescript";
|
|
@@ -74,7 +74,8 @@ function generateReport(diff, language) {
|
|
|
74
74
|
provenance: c.provenance,
|
|
75
75
|
old: c.old,
|
|
76
76
|
new: c.new,
|
|
77
|
-
...c.message ? { message: c.message } : {}
|
|
77
|
+
...c.message ? { message: c.message } : {},
|
|
78
|
+
...c.remediation ? { remediation: c.remediation } : {}
|
|
78
79
|
}))
|
|
79
80
|
};
|
|
80
81
|
}
|
|
@@ -95,6 +96,7 @@ function formatHumanSummary(diff, opts) {
|
|
|
95
96
|
lines.push(" Breaking:");
|
|
96
97
|
for (const c of breaking) {
|
|
97
98
|
lines.push(` [${c.category}] ${c.symbol} — ${c.message}`);
|
|
99
|
+
if (c.remediation) lines.push(` hint: ${c.remediation}`);
|
|
98
100
|
if (opts?.explain && c.provenance !== "unknown") lines.push(` provenance: ${c.provenance}`);
|
|
99
101
|
}
|
|
100
102
|
}
|
|
@@ -103,6 +105,7 @@ function formatHumanSummary(diff, opts) {
|
|
|
103
105
|
lines.push(" Soft-risk:");
|
|
104
106
|
for (const c of softRisk) {
|
|
105
107
|
lines.push(` [${c.category}] ${c.symbol} — ${c.message}`);
|
|
108
|
+
if (c.remediation) lines.push(` hint: ${c.remediation}`);
|
|
106
109
|
if (opts?.explain && c.provenance !== "unknown") lines.push(` provenance: ${c.provenance}`);
|
|
107
110
|
}
|
|
108
111
|
}
|