@pipelex/sdk 0.25.1 → 0.27.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/README.md +26 -4
- package/dist/artifacts.js +1 -1
- package/dist/artifacts.js.map +1 -1
- package/dist/client.d.ts +50 -15
- package/dist/client.js +164 -51
- package/dist/client.js.map +1 -1
- package/dist/error-models.d.ts +198 -0
- package/dist/error-models.js +26 -0
- package/dist/error-models.js.map +1 -0
- package/dist/errors.d.ts +132 -26
- package/dist/errors.js +134 -23
- package/dist/errors.js.map +1 -1
- package/dist/index.d.ts +4 -3
- package/dist/index.js.map +1 -1
- package/dist/method-source.d.ts +3 -3
- package/dist/method-source.js +3 -3
- package/dist/models.d.ts +147 -18
- package/dist/prepare-inputs.d.ts +35 -34
- package/dist/prepare-inputs.js +110 -129
- package/dist/prepare-inputs.js.map +1 -1
- package/dist/product-models.d.ts +4 -15
- package/dist/runs.d.ts +22 -8
- package/dist/runs.js +4 -3
- package/dist/runs.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/docs/architecture.md +12 -11
- package/docs/artifact-download.md +1 -1
- package/docs/build-routes.md +1 -1
- package/docs/crate-routes.md +49 -12
- package/docs/errors.md +143 -0
- package/docs/input-preparation.md +16 -19
- package/docs/run-results.md +3 -1
- package/package.json +2 -2
package/dist/errors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAatD,OAAO,EAAE,oBAAoB,EAAE,CAAC;AAEhC,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAClD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;IAC1C,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,qBAAsB,SAAQ,oBAAoB;IAC7D,YAAY,OAAe,EAAE,OAA6B;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,sBAAuB,SAAQ,qBAAqB;IAC/C,QAAQ,CAAS;IAEjC,YAAY,QAAgB,EAAE,OAA6B;QACzD,KAAK,CAAC,WAAW,QAAQ,4BAA4B,EAAE,OAAO,CAAC,CAAC;QAChE,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,uBAAwB,SAAQ,qBAAqB;IAChD,MAAM,CAAS;IAE/B,YAAY,OAAe,EAAE,MAAc,EAAE,OAA6B;QACxE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAmBD;;;;;;GAMG;AACH,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAC3C,QAAQ,CAAS;IACjB,MAAM,CAAS;IACf,IAAI,CAAgC;IAEpD,YACE,OAAe,EACf,QAAgB,EAChB,MAAc,EACd,OAAuD;QAEvD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;IAC5B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,gCAAiC,SAAQ,qBAAqB;IACzE,YAAY,OAAe,EAAE,OAA6B;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,kCAAkC,CAAC;IACjD,CAAC;CACF;AAED,uEAAuE;AACvE,MAAM,OAAO,yBAA0B,SAAQ,qBAAqB;IAClD,MAAM,CAAS;IAE/B,YAAY,OAAe,EAAE,MAAc,EAAE,OAA6B;QACxE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAgCD;;;;;;;;;GASG;AACH,MAAM,OAAO,oBAAqB,SAAQ,qBAAqB;IAC7C,MAAM,CAAqB;IAC3B,IAAI,CAAkC;IAEtD,YACE,OAAe,EACf,OAA0E;QAE1E,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;IAC5B,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,sBAAuB,SAAQ,oBAAoB;IAC9D,YAAY,OAAe,EAAE,OAA6B;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACvC,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,sBAAsB;IAC/C,KAAK,CAAgB;IACrB,KAAK,CAAS;IAE9B,YAAY,KAAoB,EAAE,KAAa,EAAE,OAA6B;QAC5E,KAAK,CACH,QAAQ,KAAK,iBAAiB,KAAK,0CAA0C;YAC3E,6CAA6C,EAC/C,OAAO,CACR,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAO,kBAAmB,SAAQ,sBAAsB;IAC5C,GAAG,CAAS;IACZ,IAAI,CAAS;IACb,MAAM,CAAqB;IAE3C,YACE,OAAe,EACf,GAAW,EACX,IAAY,EACZ,MAAe,EACf,OAA6B;QAE7B,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,2BAA4B,SAAQ,sBAAsB;IACrD,MAAM,CAAS;IACf,OAAO,CAA0B;IAEjD,YACE,OAAe,EACf,MAAc,EACd,OAAgC,EAChC,OAA6B;QAE7B,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,mBAAoB,SAAQ,oBAAoB;IAC3C,MAAM,CAAS;IACf,IAAI,CAAqB;IAEzC,YACE,OAAe,EACf,MAAc,EACd,IAAwB,EACxB,OAA6B;QAE7B,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,2BAA4B,SAAQ,oBAAoB;IACnD,SAAS,CAAS;IAElC,YAAY,SAAiB,EAAE,OAA6B;QAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;QAC7C,KAAK,CACH,oFAAoF,OAAO,KAAK;YAC9F,kFAAkF;YAClF,uFAAuF,EACzF,OAAO,CACR,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,cAAe,SAAQ,oBAAoB;IACtC,KAAK,CAAS;IACd,MAAM,CAAY;IAClB,KAAK,CAAwB;IAE7C,YACE,OAAe,EACf,KAAa,EACb,MAAiB,EACjB,OAA4D;QAE5D,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACpF,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,IAAI,CAAC;IACtC,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,qBAAsB,SAAQ,oBAAoB;IAC7C,KAAK,CAAS;IAE9B,YAAY,OAAe,EAAE,KAAa;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,eAAgB,SAAQ,oBAAoB;IACvC,KAAK,CAAS;IACd,SAAS,CAAS;IAElC,YAAY,OAAe,EAAE,KAAa,EAAE,SAAiB;QAC3D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,oBAAqB,SAAQ,oBAAoB;IAC5C,KAAK,CAAS;IACd,iBAAiB,CAAgB;IACjC,QAAQ,CAAgB;IAExC,YACE,OAAe,EACf,KAAa,EACb,oBAAmC,IAAI,EACvC,WAA0B,IAAI,EAC9B,OAA6B;QAE7B,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,4BAA6B,SAAQ,oBAAoB;IACpD,MAAM,CAAS;IAE/B,YAAY,OAAe,EAAE,MAAc,EAAE,OAA6B;QACxE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAaD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,OAAO,gBAAiB,SAAQ,oBAAoB;IACxC,MAAM,CAAS;IACf,MAAM,CAAS;IACf,UAAU,CAAS;IACnB,YAAY,CAAS;IACrB,SAAS,CAAqB;IAC9B,aAAa,CAAqB;IAClD;;;;;OAKG;IACa,IAAI,CAAqB;IACzC;;;OAGG;IACa,IAAI,CAAqB;IACzC,kEAAkE;IAClD,KAAK,CAAqB;IAC1C,gFAAgF;IAChE,QAAQ,CAAqB;IAC7C;;;;OAIG;IACa,SAAS,CAAqB;IAC9C;;;;;;OAMG;IACa,WAAW,CAAqB;IAChD;;;OAGG;IACa,aAAa,CAAqB;IAClD;;;OAGG;IACa,SAAS,CAAsB;IAC/C,yFAAyF;IACzE,UAAU,CAAyB;IACnD,+DAA+D;IAC/C,KAAK,CAAqB;IAC1C,wEAAwE;IACxD,QAAQ,CAAqB;IAC7C,uFAAuF;IACvE,gBAAgB,CAAoC;IACpE,2FAA2F;IAC3E,SAAS,CAAkC;IAC3D,oFAAoF;IACpE,MAAM,CAA2B;IACjD;;;;OAIG;IACa,eAAe,CAAsC;IACrE;;;;;;;;;;;;OAYG;IACa,gBAAgB,CAAoC;IAEpE,YACE,OAAe,EACf,MAAc,EACd,MAAc,EACd,UAAkB,EAClB,YAAoB,EACpB,SAA6B,EAC7B,aAAiC,EACjC,gBAAmD,EACnD,IAAwB,EACxB,OAAiC;QAEjC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACpF,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,OAAO,EAAE,KAAK,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,SAAS,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,WAAW,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,OAAO,EAAE,aAAa,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,SAAS,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,OAAO,EAAE,UAAU,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,OAAO,EAAE,KAAK,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;QAClC,IAAI,CAAC,gBAAgB,GAAG,OAAO,EAAE,gBAAgB,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,SAAS,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;QAC9B,IAAI,CAAC,eAAe,GAAG,OAAO,EAAE,eAAe,CAAC;IAClD,CAAC;CACF"}
|
package/dist/index.d.ts
CHANGED
|
@@ -20,13 +20,14 @@ export type { GrantedUpload, UploadWithGrantOptions } from "./upload-grant.js";
|
|
|
20
20
|
export type { PrepareInputsBase, PrepareInputsClosure, PrepareInputsRequest, PreparedInputs, } from "./prepare-inputs.js";
|
|
21
21
|
export { locateArtifacts, collectArtifacts, artifactFilename, PIPELEX_STORAGE_SCHEME, BULK_RESOLVE_MAX_URIS, DEFAULT_ARTIFACT_MAX_BYTES, DEFAULT_ARTIFACT_TIMEOUT_MS, DEFAULT_DOWNLOAD_MAX_TOTAL_BYTES, DEFAULT_DOWNLOAD_CONCURRENCY, } from "./artifacts.js";
|
|
22
22
|
export type { ArtifactItemError, ArtifactLocation, ArtifactScope, BulkResolveStorageUrlsInput, BulkResolvedStorageUrls, DownloadArtifactsOptions, DownloadArtifactsRequest, DownloadArtifactsResult, DownloadedArtifact, FetchArtifactOptions, ResolvedArtifact, } from "./artifacts.js";
|
|
23
|
-
export type { DiagnosticKind, DiagnosticRange, Diagnostic, LintResponse, FormatResponse, DictStuff, DictWorkingMemory, DictPipeOutput, DictRunResultExecute, MethodProvenance, PipelexRunResultStart, PipelexHostedToolingExtensions, DryRunStatus, ValidatedPipeEntry, LiftablePipeEntry, PipelexValidationReport, PipelexInvalidReport, PipelexValidationResult, ValidationErrorCategory, ValidationErrorItem, FixSafety, FixOpKind, TomlScalar, TomlValue, SetKeyOp, EnsureTableOp, DeleteKeyOp, DeleteTableOp, RenameTableKeyOp, MoveKeyOp, RemapValueOp, FixOp, SuggestedFix, ConceptRepresentationFormat, InputsTemplateFormat, MthdsFileItem, CrateRequestBase, BuildRequestBase, BuildInputsRequest, BuildOutputRequest, BuildRunnerRequest, ConceptRequest, PipeSpecRequest, CrateInvalidReport, BuildInputsValidReport, BuildOutputValidReport, BuildRunnerValidReport, GeneratedArtifact, RunnerStructures, BuildInputsResponse, BuildOutputResponse, BuildRunnerResponse, ConceptResponse, PipeSpecResponse, ResolveRequest, ResolveValidReport, ResolveResponse, CodegenKind, CodegenTarget, CodegenRequest, CodegenValidReport, CodegenResponse, } from "./models.js";
|
|
23
|
+
export type { DiagnosticKind, DiagnosticRange, Diagnostic, LintResponse, FormatResponse, DictStuff, DictWorkingMemory, DictPipeOutput, DictRunResultExecute, MethodProvenance, PipelexRunResultStart, PipelexHostedToolingExtensions, DryRunStatus, ValidatedPipeEntry, LiftablePipeEntry, PipelexValidationReport, PipelexInvalidReport, PipelexValidationResult, ValidationErrorCategory, ValidationErrorItem, FixSafety, FixOpKind, TomlScalar, TomlValue, FixValue, SetKeyOp, EnsureTableOp, DeleteKeyOp, DeleteTableOp, RenameTableKeyOp, MoveKeyOp, RemapValueOp, FixOp, SuggestedFix, ConceptRepresentationFormat, InputsTemplateFormat, MthdsFileItem, CrateRequestBase, BuildRequestBase, BuildInputsRequest, BuildOutputRequest, BuildRunnerRequest, ConceptRequest, PipeSpecRequest, CrateInvalidReport, BuildInputsValidReport, BuildOutputValidReport, BuildRunnerValidReport, GeneratedArtifact, RunnerStructures, BuildInputsResponse, BuildOutputResponse, BuildRunnerResponse, ConceptResponse, PipeSpecResponse, ResolveRequest, ResolveValidReport, ResolveResponse, CodegenKind, CodegenTarget, CodegenRequest, CodegenValidReport, CodegenResponse, PipeIORequest, PipeIOValidReport, PipeIOResponse, } from "./models.js";
|
|
24
24
|
export { runCodegenCheck, isStampableArtifactPath, STAMPABLE_ARTIFACT_SUFFIXES, CodegenLockError, } from "./codegen-check.js";
|
|
25
25
|
export type { CodegenCheckInput, CodegenCheckReport, CodegenDrift, CodegenDriftCategory, CodegenTreeFile, } from "./codegen-check.js";
|
|
26
|
-
export type { UserProfile, ListMethodsQuery, MethodData, MethodDeletionAccepted, MethodDeletionState, MethodPage, MethodSummary, MethodWriteInput, Membership, MembershipsResponse, SubscriptionResponse, PlanView, InvoiceView, CheckoutResponse, ChangePlanResponse, BillingPortalResponse, PipelexApiKey, PipelexApiKeyCreated, PipelexApiKeyList, OnboardingRole, OnboardingCurrentTool, OnboardingInputType, OnboardingHeardFrom, OnboardingSubmission, ResolvedStorageUrl, UploadInput, UploadedFile, UploadGrantInput, UploadGrant, PipeStatus, ListRunsQuery, PipelineRun, RunDetail,
|
|
26
|
+
export type { UserProfile, ListMethodsQuery, MethodData, MethodDeletionAccepted, MethodDeletionState, MethodPage, MethodSummary, MethodWriteInput, Membership, MembershipsResponse, SubscriptionResponse, PlanView, InvoiceView, CheckoutResponse, ChangePlanResponse, BillingPortalResponse, PipelexApiKey, PipelexApiKeyCreated, PipelexApiKeyList, OnboardingRole, OnboardingCurrentTool, OnboardingInputType, OnboardingHeardFrom, OnboardingSubmission, ResolvedStorageUrl, UploadInput, UploadedFile, UploadGrantInput, UploadGrant, PipeStatus, ListRunsQuery, PipelineRun, RunDetail, RunPage, UpdateRunInput, } from "./product-models.js";
|
|
27
27
|
export { isTerminalRunStatus, isSuccessRunStatus } from "./runs.js";
|
|
28
28
|
export type { RunStatus, RunPublic, RunRead, RunResults, RunResultState, TokensUsageRecord, WaitForResultOptions, } from "./runs.js";
|
|
29
29
|
export { summarizeUsage } from "./usage.js";
|
|
30
30
|
export type { PipeUsageSummary, RunUsagePair, UsageSummary, UsageSummaryState, UsageTokenTotals, } from "./usage.js";
|
|
31
31
|
export { ApiResponseError, ApiUnreachableError, ClientAuthenticationError, MissingMainStuffError, PipelineExecuteTimeoutError, RunFailedError, RunTimeoutError, RunStillRunningError, RunLifecycleUnavailableError, InputPreparationError, EmptyMethodSourceError, InvalidLocalSourceError, RejectedAssetError, UnsupportedUploadCapabilityError, UploadAuthenticationError, UploadTransportError, ArtifactOperationError, ArtifactAuthenticationError, ArtifactFetchError, ScopeUnavailableError, } from "./errors.js";
|
|
32
|
-
export type { RejectedAssetCode, UploadTransportCode } from "./errors.js";
|
|
32
|
+
export type { ApiResponseErrorOptions, RejectedAssetCode, UploadTransportCode } from "./errors.js";
|
|
33
|
+
export type { FieldError, MigrationErrorBlock, ProblemDetails, ProviderErrorMetadata, RunErrorReport, UserAction, } from "./error-models.js";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,6FAA6F;AAC7F,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,oFAAoF;AACpF,kFAAkF;AAClF,mFAAmF;AACnF,wBAAwB;AACxB,cAAc,gBAAgB,CAAC;AAE/B,wEAAwE;AACxE,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAarE,+FAA+F;AAC/F,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,iGAAiG;AACjG,kFAAkF;AAClF,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAK/E,yFAAyF;AACzF,sEAAsE;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AASpD,uEAAuE;AACvE,wFAAwF;AACxF,0FAA0F;AAC1F,iFAAiF;AACjF,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,EAC1B,2BAA2B,EAC3B,gCAAgC,EAChC,4BAA4B,GAC7B,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,6FAA6F;AAC7F,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,oFAAoF;AACpF,kFAAkF;AAClF,mFAAmF;AACnF,wBAAwB;AACxB,cAAc,gBAAgB,CAAC;AAE/B,wEAAwE;AACxE,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAarE,+FAA+F;AAC/F,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,iGAAiG;AACjG,kFAAkF;AAClF,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAK/E,yFAAyF;AACzF,sEAAsE;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AASpD,uEAAuE;AACvE,wFAAwF;AACxF,0FAA0F;AAC1F,iFAAiF;AACjF,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,EAC1B,2BAA2B,EAC3B,gCAAgC,EAChC,4BAA4B,GAC7B,MAAM,gBAAgB,CAAC;AAqFxB,+EAA+E;AAC/E,4EAA4E;AAC5E,iFAAiF;AACjF,0EAA0E;AAC1E,OAAO,EACL,eAAe,EACf,uBAAuB,EACvB,2BAA2B,EAC3B,gBAAgB,GACjB,MAAM,oBAAoB,CAAC;AAgD5B,wEAAwE;AACxE,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAWpE,oFAAoF;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAS5C,+EAA+E;AAC/E,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,2BAA2B,EAC3B,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,4BAA4B,EAC5B,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,EAClB,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,EACtB,2BAA2B,EAC3B,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,aAAa,CAAC"}
|
package/dist/method-source.d.ts
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
* file contents. The string is either raw `.mthds` source or a JSON-serialized
|
|
4
4
|
* `[{ name, content }, …]` file array (the webapp editor format).
|
|
5
5
|
*
|
|
6
|
-
* Mirrors the platform's canonical implementation — `
|
|
7
|
-
* plus its caller's blank-source guard in `
|
|
8
|
-
*
|
|
6
|
+
* Mirrors the platform's canonical implementation — `method_source_to_contents`
|
|
7
|
+
* plus its caller's blank-source guard in `resolve_method_run_source`, both in
|
|
8
|
+
* the platform's `services/method_resolution.py` — keep the two in sync. A JSON
|
|
9
9
|
* `[]` is "no source", not a bundle; a JSON array of `{ name, content }`
|
|
10
10
|
* objects yields the non-blank contents; anything else (raw source, non-array
|
|
11
11
|
* JSON, unparseable) is one plain bundle string, itself dropped when blank.
|
package/dist/method-source.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
* file contents. The string is either raw `.mthds` source or a JSON-serialized
|
|
4
4
|
* `[{ name, content }, …]` file array (the webapp editor format).
|
|
5
5
|
*
|
|
6
|
-
* Mirrors the platform's canonical implementation — `
|
|
7
|
-
* plus its caller's blank-source guard in `
|
|
8
|
-
*
|
|
6
|
+
* Mirrors the platform's canonical implementation — `method_source_to_contents`
|
|
7
|
+
* plus its caller's blank-source guard in `resolve_method_run_source`, both in
|
|
8
|
+
* the platform's `services/method_resolution.py` — keep the two in sync. A JSON
|
|
9
9
|
* `[]` is "no source", not a bundle; a JSON array of `{ name, content }`
|
|
10
10
|
* objects yields the non-blank contents; anything else (raw source, non-array
|
|
11
11
|
* JSON, unparseable) is one plain bundle string, itself dropped when blank.
|
package/dist/models.d.ts
CHANGED
|
@@ -64,7 +64,7 @@ export interface PipelexRunResultStart extends RunResultStart {
|
|
|
64
64
|
}
|
|
65
65
|
/**
|
|
66
66
|
* The hosted tooling routes' own selector — the layer-3 extension the platform
|
|
67
|
-
* adds on `POST /v1/validate`, `/v1/resolve`, and `/v1/
|
|
67
|
+
* adds on `POST /v1/validate`, `/v1/resolve`, `/v1/codegen`, and `/v1/pipe-io`: a stored
|
|
68
68
|
* method's catalog id (`mt_…`), resolved server-side against the org's catalog
|
|
69
69
|
* and injected as inline source before the runner sees the request. A **pass-
|
|
70
70
|
* through to the hosted API**: nothing is expanded client-side, and it is
|
|
@@ -90,8 +90,9 @@ export interface PipelexHostedToolingExtensions {
|
|
|
90
90
|
* exactly one of inline contents / `method_ref` / `method_id` per request.
|
|
91
91
|
*
|
|
92
92
|
* Lives here, beside the other wire shapes, rather than on the client: it is
|
|
93
|
-
* the request's shape, and
|
|
94
|
-
* without importing the client back (which would close a module
|
|
93
|
+
* the request's shape, and a module that composes a `validate` call of its own
|
|
94
|
+
* can name it without importing the client back (which would close a module
|
|
95
|
+
* cycle).
|
|
95
96
|
*/
|
|
96
97
|
export type ValidateMethodSelector = {
|
|
97
98
|
method_ref: string;
|
|
@@ -207,7 +208,9 @@ export interface PipelexValidationReport extends ValidationReport {
|
|
|
207
208
|
* `null` is the server's verdict that there is none, and a consumer stops there
|
|
208
209
|
* rather than deriving one of its own; an ABSENT field means the server predates
|
|
209
210
|
* the field, and only then does a blueprint-derived default stand. That is the rule
|
|
210
|
-
* `
|
|
211
|
+
* `pipelex-mcp` states in its `SPEC.md`. It is NOT `/v1/pipe-io`'s field of the same
|
|
212
|
+
* name ({@link PipeIOValidReport.default_pipe_ref}), which refuses to choose among
|
|
213
|
+
* several declaring domains where this one names the first.
|
|
211
214
|
*/
|
|
212
215
|
default_pipe_ref?: string | null;
|
|
213
216
|
/** Best-effort execution graph of the main pipe; `null` with no `main_pipe` or on degrade. */
|
|
@@ -271,19 +274,35 @@ export type ValidationErrorCategory = "blueprint_validation" | "pipe_factory" |
|
|
|
271
274
|
* One structured bundle-validation error — mirror of pipelex's `ValidationErrorItem`.
|
|
272
275
|
* Carried by `PipelexInvalidReport.validation_errors[]` on the **200** invalid arm of
|
|
273
276
|
* `POST /v1/validate` (NOT a 422 — an invalid bundle is a produced verdict), by the
|
|
274
|
-
* VALID arm's advisory `warnings[]`,
|
|
275
|
-
* (`
|
|
277
|
+
* VALID arm's advisory `warnings[]`, by the build and crate routes' **200** invalid arm
|
|
278
|
+
* (`CrateInvalidReport.validation_errors[]`), by the 422 problem body a run route answers
|
|
279
|
+
* when the runner refuses the method for its validation errors
|
|
280
|
+
* (`ApiResponseError.validationErrors`), and by a failed run's stored report.
|
|
281
|
+
*
|
|
282
|
+
* **The shape is `mthds`'s.** The standard's client declares the same item, member for
|
|
283
|
+
* member under the same names, and a consumer reads one vocabulary whichever client
|
|
284
|
+
* handed it the item. It is restated here rather than imported because `mthds` exports it
|
|
285
|
+
* only from its package root, which this SDK does not import (it takes `mthds` through
|
|
286
|
+
* `mthds/protocol` alone, the rule `.dependency-cruiser.cjs` enforces); a type-level test
|
|
287
|
+
* (`tests/validation-items.test.ts`) pins this declaration and `SuggestedFix`'s to the
|
|
288
|
+
* standard's, so a member added on one side and not the other fails the typecheck.
|
|
276
289
|
*
|
|
277
290
|
* Only `category` and `message` are always present; the rest are populated per
|
|
278
|
-
* `category`. Every other member is `?: T | null`
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
*
|
|
291
|
+
* `category`. Every other member is `?: T | null` — the one way this declaration
|
|
292
|
+
* differs from `mthds`'s — because the two channels serialize an unset locator
|
|
293
|
+
* differently: the invalid arm and the crate routes drop the key (`exclude_none`
|
|
294
|
+
* server-side) while the valid arm — which carries `warnings[]` — does not, so the same
|
|
295
|
+
* item arrives with explicit `null`s there. A truthiness check reads both; an
|
|
296
|
+
* `=== undefined` check would be wrong on one of them.
|
|
283
297
|
*
|
|
284
298
|
* `source` is the declaring file path (CLI) or the per-content `mthds_sources` name
|
|
285
299
|
* the API threads onto the in-memory load path — the owning file for cross-file
|
|
286
300
|
* diagnostics.
|
|
301
|
+
*
|
|
302
|
+
* An `unknown_model` item (a model reference the runner's model deck does not know)
|
|
303
|
+
* carries the reference as written, the kind of model the field takes and the close
|
|
304
|
+
* matches, and, when there is exactly one close match, a `suggested_fix` that remaps
|
|
305
|
+
* the reference to it.
|
|
287
306
|
*/
|
|
288
307
|
export interface ValidationErrorItem {
|
|
289
308
|
category: ValidationErrorCategory;
|
|
@@ -297,8 +316,21 @@ export interface ValidationErrorItem {
|
|
|
297
316
|
field_name?: string | null;
|
|
298
317
|
variable_names?: string[] | null;
|
|
299
318
|
missing_concept_code?: string | null;
|
|
319
|
+
/** The pipe a reference names that the bundle does not declare. */
|
|
300
320
|
missing_pipe_code?: string | null;
|
|
301
321
|
declared_concepts?: string[] | null;
|
|
322
|
+
/**
|
|
323
|
+
* On an `unknown_model` item: the model reference exactly as the author wrote it
|
|
324
|
+
* (`gpt-5.1`, `@best-sonet`, `$writting-factual`).
|
|
325
|
+
*/
|
|
326
|
+
model_reference?: string | null;
|
|
327
|
+
/** On an `unknown_model` item: the kind of model the field takes (`llm`, `img_gen`, …). */
|
|
328
|
+
model_type?: string | null;
|
|
329
|
+
/**
|
|
330
|
+
* On an `unknown_model` item: the close matches of the same kind, each spelled as a
|
|
331
|
+
* reference the field accepts.
|
|
332
|
+
*/
|
|
333
|
+
suggestions?: string[] | null;
|
|
302
334
|
/** The server's deterministic repair proposal for this error, when it has one. */
|
|
303
335
|
suggested_fix?: SuggestedFix | null;
|
|
304
336
|
}
|
|
@@ -314,6 +346,8 @@ export type TomlScalar = string | number | boolean;
|
|
|
314
346
|
* the server does not emit it.
|
|
315
347
|
*/
|
|
316
348
|
export type TomlValue = TomlScalar | Record<string, TomlScalar>;
|
|
349
|
+
/** `TomlValue` under the name `mthds` gives it, so either client's vocabulary reads here. */
|
|
350
|
+
export type FixValue = TomlValue;
|
|
317
351
|
/**
|
|
318
352
|
* What every fix op carries: the table it acts in. `table_path` addresses the containing
|
|
319
353
|
* table (e.g. `["pipe", "my_seq"]`), aligned with the `field_path` conventions of
|
|
@@ -358,7 +392,11 @@ export interface MoveKeyOp extends FixOpBase {
|
|
|
358
392
|
new_table_path: string[];
|
|
359
393
|
new_key: string;
|
|
360
394
|
}
|
|
361
|
-
/**
|
|
395
|
+
/**
|
|
396
|
+
* Rewrite `key`'s value through `mapping`, leaving an unmapped value untouched. The
|
|
397
|
+
* unknown-model fix is one: it maps the reference as written to its one close match, so
|
|
398
|
+
* it changes nothing once the author has edited the field.
|
|
399
|
+
*/
|
|
362
400
|
export interface RemapValueOp extends FixOpBase {
|
|
363
401
|
kind: "remap_value";
|
|
364
402
|
key: string;
|
|
@@ -370,6 +408,10 @@ export type FixOp = SetKeyOp | EnsureTableOp | DeleteKeyOp | DeleteTableOp | Ren
|
|
|
370
408
|
* A deterministic fix for one validation error, ready for a style-preserving applier —
|
|
371
409
|
* mirror of pipelex's `SuggestedFix`. The ops are semantic patches over the `.mthds`
|
|
372
410
|
* document, not a text diff, so an applier keeps the author's formatting.
|
|
411
|
+
*
|
|
412
|
+
* The shape is `mthds`'s `SuggestedFix`, its op vocabulary included (this SDK's
|
|
413
|
+
* `TomlValue` is the standard's `FixValue`), restated and pinned for the reason
|
|
414
|
+
* `ValidationErrorItem` gives; `source` alone is widened to `| null`.
|
|
373
415
|
*/
|
|
374
416
|
export interface SuggestedFix {
|
|
375
417
|
/** The kebab-case rule id, e.g. `"match-sequence-output"`. */
|
|
@@ -440,7 +482,7 @@ export interface MthdsFileItem {
|
|
|
440
482
|
}
|
|
441
483
|
/**
|
|
442
484
|
* The closure selector every crate-family route shares — `/v1/resolve`, `/v1/codegen`,
|
|
443
|
-
* and `/v1/build/*` (mirror of the server's `MthdsFilesRequest`).
|
|
485
|
+
* `/v1/pipe-io`, and `/v1/build/*` (mirror of the server's `MthdsFilesRequest`).
|
|
444
486
|
*
|
|
445
487
|
* Supply the closure EITHER as inline `files` OR as a `method_ref` — never both, and
|
|
446
488
|
* never neither (both arms are a request-shape `422`). An **address-form** `method_ref`
|
|
@@ -471,7 +513,7 @@ export interface BuildRequestBase extends CrateRequestBase {
|
|
|
471
513
|
pipe_ref?: string;
|
|
472
514
|
/**
|
|
473
515
|
* The `/v1/build/*` projections take NO `method_id` — the hosted platform's
|
|
474
|
-
* tooling selector covers `validate`/`resolve`/`codegen` only, and the build
|
|
516
|
+
* tooling selector covers `validate`/`resolve`/`codegen`/`pipe-io` only, and the build
|
|
475
517
|
* routes are deliberately excluded (they are frozen, being replaced by the
|
|
476
518
|
* codegen surface). Pinned to `never` so a stored-method caller reaches for
|
|
477
519
|
* `getMethodClosure` instead of a field no server resolves.
|
|
@@ -505,15 +547,16 @@ export interface PipeSpecRequest {
|
|
|
505
547
|
}
|
|
506
548
|
/**
|
|
507
549
|
* The `is_valid: false` arm shared by every crate-family route — `/v1/build/*`,
|
|
508
|
-
* `/v1/resolve`, and `/v1/
|
|
550
|
+
* `/v1/resolve`, `/v1/codegen`, and `/v1/pipe-io` (mirror of the server's one
|
|
551
|
+
* `CrateInvalidReport`).
|
|
509
552
|
*
|
|
510
553
|
* They all follow `/validate`'s discipline: an unresolvable closure is the
|
|
511
554
|
* *successful product* of the call (the request was well-formed, the library was
|
|
512
555
|
* not), so it rides a **200** discriminated on `is_valid` — never a 4xx. Only a
|
|
513
556
|
* no-verdict condition throws `ApiResponseError`: a request the route cannot act on
|
|
514
|
-
* (an unknown `pipe_ref` on the build routes
|
|
515
|
-
* the reserved `method_ref`, auth, a server fault. Branch on `is_valid`,
|
|
516
|
-
* transport.
|
|
557
|
+
* (an unknown `pipe_ref` on the build routes and `pipe-io`, an unknown `kind`/`target`
|
|
558
|
+
* on codegen), the reserved `method_ref`, auth, a server fault. Branch on `is_valid`,
|
|
559
|
+
* never on the transport.
|
|
517
560
|
*/
|
|
518
561
|
export interface CrateInvalidReport {
|
|
519
562
|
is_valid: false;
|
|
@@ -696,4 +739,90 @@ export interface CodegenValidReport {
|
|
|
696
739
|
}
|
|
697
740
|
/** The `POST /v1/codegen` 200 response — pattern-match `is_valid` before reading the arm. */
|
|
698
741
|
export type CodegenResponse = CodegenValidReport | CrateInvalidReport;
|
|
742
|
+
/**
|
|
743
|
+
* `POST /v1/pipe-io` request — the crate envelope plus the hosted `method_id` selector
|
|
744
|
+
* (exactly one of `files` / `method_ref` / `method_id`; see
|
|
745
|
+
* {@link PipelexHostedToolingExtensions}), a pipe selector, and two opt-ins.
|
|
746
|
+
*
|
|
747
|
+
* There is no `views` field: the valid arm always carries all three artifacts.
|
|
748
|
+
*/
|
|
749
|
+
export interface PipeIORequest extends CrateRequestBase, PipelexHostedToolingExtensions {
|
|
750
|
+
/**
|
|
751
|
+
* The pipe to describe, as a QUALIFIED `domain.pipe_code` ref. Omit it and the
|
|
752
|
+
* server's selection chain decides: a fetched package's manifest `main_pipe`, else
|
|
753
|
+
* the closure's single `main_pipe` declaration. A selection the server refuses is a
|
|
754
|
+
* `422` typed by what went wrong, with `error_domain: "input"` and the candidates, where
|
|
755
|
+
* there are some, in its `detail`: `EntryPipeNotFoundError` for a ref that names no pipe
|
|
756
|
+
* or (without `all_pipes`) a method with no entry pipe, `EntryPipeAmbiguousError` for a
|
|
757
|
+
* code that matches pipes in several domains or (without `all_pipes`) several `main_pipe`
|
|
758
|
+
* declarations. A malformed request stays a `ValidationError` `422`.
|
|
759
|
+
*
|
|
760
|
+
* The server does not refuse a bare code yet: a bare ref that matches one pipe is
|
|
761
|
+
* resolved across domains, and the valid arm reports the qualified ref.
|
|
762
|
+
*/
|
|
763
|
+
pipe_ref?: string;
|
|
764
|
+
/**
|
|
765
|
+
* Describe every pipe the closure loads instead of the selected one. The artifact maps
|
|
766
|
+
* are then keyed by every pipe, and the route never refuses for want of an entry pipe:
|
|
767
|
+
* the valid arm's `pipe_ref` is the requested ref, else the method's own entry pipe,
|
|
768
|
+
* else `null`. Defaults to `false` server-side.
|
|
769
|
+
*/
|
|
770
|
+
all_pipes?: boolean;
|
|
771
|
+
/**
|
|
772
|
+
* Echo the resolved closure's `.mthds` files on the valid arm as `files`, in the
|
|
773
|
+
* request's own `files[]` shape. Defaults to `false` server-side, and the field is then
|
|
774
|
+
* absent from the answer.
|
|
775
|
+
*/
|
|
776
|
+
include_files?: boolean;
|
|
777
|
+
}
|
|
778
|
+
/**
|
|
779
|
+
* The `/v1/pipe-io` valid arm — a method's three I/O artifacts, with the selection and
|
|
780
|
+
* the runnability facts beside them.
|
|
781
|
+
*
|
|
782
|
+
* The three artifacts are the MTHDS standard's own types, imported from `mthds/protocol`
|
|
783
|
+
* and never restated here. The maps share one key set: the resolved `pipe_ref` alone by
|
|
784
|
+
* default, every pipe the closure loads under `all_pipes`. For a closure `/v1/validate`
|
|
785
|
+
* also accepts, each map equals validate's same-named field restricted to the same keys.
|
|
786
|
+
*
|
|
787
|
+
* `is_valid: true` means what it means on `/v1/resolve`: the closure parsed, loaded and
|
|
788
|
+
* passed static validation. No dry run ran; that verdict stays `validate`'s.
|
|
789
|
+
*/
|
|
790
|
+
export interface PipeIOValidReport {
|
|
791
|
+
is_valid: true;
|
|
792
|
+
/**
|
|
793
|
+
* The qualified ref the selection resolved, read off the resolved pipe and never echoed
|
|
794
|
+
* from the request. `null` only under `all_pipes` when no pipe was requested and the
|
|
795
|
+
* method declares no single entry pipe.
|
|
796
|
+
*/
|
|
797
|
+
pipe_ref: string | null;
|
|
798
|
+
/** The standard's pipe I/O contracts, keyed by qualified `pipe_ref`. */
|
|
799
|
+
pipe_io_contracts: PipeIOContracts;
|
|
800
|
+
/** The standard's input-form descriptors, keyed by qualified `pipe_ref`. */
|
|
801
|
+
input_form: InputForm;
|
|
802
|
+
/** The standard's output-form descriptors, keyed by qualified `pipe_ref`. */
|
|
803
|
+
output_form: OutputForm;
|
|
804
|
+
/**
|
|
805
|
+
* The method's own entry pipe: the selection chain without the request's `pipe_ref` —
|
|
806
|
+
* the fetched manifest's `main_pipe`, else the closure's single declaration. A request
|
|
807
|
+
* that omits `pipe_ref` always answers `pipe_ref === default_pipe_ref`. A stated `null`
|
|
808
|
+
* when the chain finds none or several.
|
|
809
|
+
*
|
|
810
|
+
* NOT `PipelexValidationReport.default_pipe_ref`, which is the run default and names
|
|
811
|
+
* the first of several declaring domains where this chain refuses to choose.
|
|
812
|
+
*/
|
|
813
|
+
default_pipe_ref: string | null;
|
|
814
|
+
/** Qualified refs of every pipe of the closure still declared as a signature, as on `validate`. */
|
|
815
|
+
pending_signatures: string[];
|
|
816
|
+
/** `pending_signatures` is empty, as on `validate`. No dry run backs it. */
|
|
817
|
+
is_runnable: boolean;
|
|
818
|
+
/**
|
|
819
|
+
* The resolved closure's `.mthds` files, in the request's `files[]` shape. Present only
|
|
820
|
+
* when the request passed `include_files: true`: the request's files for inline
|
|
821
|
+
* `files`, the fetched package's `.mthds` files under their package-relative paths for
|
|
822
|
+
* a `method_ref`, the stored files under their stored names for a hosted `method_id`.
|
|
823
|
+
*/
|
|
824
|
+
files?: MthdsFileItem[];
|
|
825
|
+
}
|
|
826
|
+
/** The `POST /v1/pipe-io` 200 response — pattern-match `is_valid` before reading the arm. */
|
|
827
|
+
export type PipeIOResponse = PipeIOValidReport | CrateInvalidReport;
|
|
699
828
|
export {};
|
package/dist/prepare-inputs.d.ts
CHANGED
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* `prepareInputs` — signature-driven input preparation.
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
2
|
+
* `prepareInputs` — signature-driven input preparation. Reads the target pipe's
|
|
3
|
+
* declared inputs from the **input-form descriptor** `POST /v1/pipe-io` returns,
|
|
4
|
+
* interprets the caller's inputs top-down against it, uploads the file-bearing
|
|
5
|
+
* values, and returns rewritten inputs (canonical content carrying
|
|
6
6
|
* `pipelex-storage://` in `url`) plus one upload record per prepared asset.
|
|
7
7
|
*
|
|
8
8
|
* The method is named the same three ways every other method-taking operation
|
|
9
9
|
* takes it — inline `files`, a `method_ref` address, or a stored `method_id` —
|
|
10
|
-
* exactly one per call. All three are pass-throughs to `POST /v1/
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* exactly one per call. All three are pass-throughs to `POST /v1/pipe-io`, which
|
|
11
|
+
* resolves an address on the runner and an id on the platform, so nothing is
|
|
12
|
+
* expanded client-side. The route also SELECTS the pipe: the caller's qualified
|
|
13
|
+
* `pipe_ref`, else the method's own entry pipe, and the ref it answers with is
|
|
14
|
+
* the one prepared. It runs no dry run, so preparing inputs costs one static load.
|
|
13
15
|
*
|
|
14
16
|
* Per input, the caller may submit EITHER the **compact** value (a bare source /
|
|
15
17
|
* canonical `{url}` content) OR the explicit `{ concept, content }` envelope —
|
|
@@ -19,26 +21,27 @@
|
|
|
19
21
|
* `input_normalizer.py`).
|
|
20
22
|
*
|
|
21
23
|
* **The descriptor is the classifier, never the value's shape.** `input_form`
|
|
22
|
-
* (the MTHDS standard's artifact
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
24
|
+
* (the MTHDS standard's artifact) states the kind at every depth — `document` /
|
|
25
|
+
* `image` mark a file position, `object` recurses through `fields`, `list`
|
|
26
|
+
* through `item`, everything else passes through. That is what makes an
|
|
27
|
+
* OPTIONAL nested file field prepare like a required one, and a `text` field
|
|
28
|
+
* merely *named* `url` stay untouched: both were misread while the signature
|
|
29
|
+
* came from the rendered inputs template, whose file signal was a `url`-bearing
|
|
30
|
+
* dict. See `docs/input-preparation.md`, which `pipelex-sdk-python` mirrors case
|
|
31
|
+
* for case.
|
|
30
32
|
*/
|
|
31
|
-
import type { MthdsFileItem,
|
|
33
|
+
import type { MthdsFileItem, PipeIORequest, PipeIOResponse } from "./models.js";
|
|
32
34
|
import type { UploadCapableClient, UploadRecord } from "./upload.js";
|
|
33
35
|
/** The shared half of the request: the target pipe and the caller's inputs. */
|
|
34
36
|
export interface PrepareInputsBase {
|
|
35
37
|
/**
|
|
36
38
|
* The pipe to prepare inputs for, as a QUALIFIED `domain.pipe_code` ref. Omit
|
|
37
|
-
* it
|
|
38
|
-
* `pipe_code` is refused
|
|
39
|
-
*
|
|
39
|
+
* it and the server picks the method's own entry pipe — see "Pipe selection" in
|
|
40
|
+
* `docs/input-preparation.md`. A bare `pipe_code` is refused before any request:
|
|
41
|
+
* a request names a pipe by its qualified ref, and search is a run-route
|
|
42
|
+
* affordance this helper deliberately does not grow. So is an
|
|
40
43
|
* `alias->domain.pipe_code` ref: the alias names a dependency package's pipe,
|
|
41
|
-
*
|
|
44
|
+
* and preparation covers the method's own pipes.
|
|
42
45
|
*/
|
|
43
46
|
pipe_ref?: string;
|
|
44
47
|
/** The caller's inputs (variable name → value), compact or explicit-envelope per input. */
|
|
@@ -47,7 +50,7 @@ export interface PrepareInputsBase {
|
|
|
47
50
|
/**
|
|
48
51
|
* How the method is named — exactly one of the three selectors, each pinning the
|
|
49
52
|
* other two to `never` so a second one is a compile error (the same XOR
|
|
50
|
-
* `ValidateMethodSelector` states for
|
|
53
|
+
* `ValidateMethodSelector` states for `validate`). All three reach the
|
|
51
54
|
* server as-is: `files` inline, `method_ref` resolved by the runner, `method_id`
|
|
52
55
|
* resolved by the platform.
|
|
53
56
|
*/
|
|
@@ -74,15 +77,12 @@ export interface PreparedInputs {
|
|
|
74
77
|
uploads: UploadRecord[];
|
|
75
78
|
}
|
|
76
79
|
/**
|
|
77
|
-
* The client surface `prepareInputs` needs: raw `upload`, and `
|
|
78
|
-
* signature source. Typed as the client's own `
|
|
80
|
+
* The client surface `prepareInputs` needs: raw `upload`, and `pipeIo` as the
|
|
81
|
+
* signature source. Typed as the client's own `pipeIo` signature so
|
|
79
82
|
* `PipelexApiClient` satisfies it structurally.
|
|
80
83
|
*/
|
|
81
84
|
export interface PrepareCapableClient extends UploadCapableClient {
|
|
82
|
-
|
|
83
|
-
timeoutMs?: number;
|
|
84
|
-
signal?: AbortSignal;
|
|
85
|
-
}): Promise<PipelexValidationResult>;
|
|
85
|
+
pipeIo(request: PipeIORequest): Promise<PipeIOResponse>;
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
88
|
* Prepare a pipe's inputs: upload local/byte/data-URL assets at the signature's
|
|
@@ -90,12 +90,13 @@ export interface PrepareCapableClient extends UploadCapableClient {
|
|
|
90
90
|
* records. HTTP(S) URLs and existing `pipelex-storage://` URIs pass through
|
|
91
91
|
* unchanged. All failures are raised before any run is created.
|
|
92
92
|
*
|
|
93
|
-
* The signature
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
* {@link InputPreparationError};
|
|
98
|
-
* malformed selector, an unknown or foreign-org
|
|
99
|
-
* auth, a server fault
|
|
93
|
+
* The pipe and its signature come from one `POST /v1/pipe-io`, whatever the
|
|
94
|
+
* selector — inline `files`, a `method_ref` the runner resolves, or a
|
|
95
|
+
* `method_id` the platform resolves. A bare or alias-qualified `pipe_ref`, a
|
|
96
|
+
* closure that does not load, and a selection the route refuses (an unknown
|
|
97
|
+
* `pipe_ref`, no entry pipe, several) throw {@link InputPreparationError}; any
|
|
98
|
+
* other failure from the route (a malformed selector, an unknown or foreign-org
|
|
99
|
+
* id, no package at the address, auth, a server fault, a deployment that does not
|
|
100
|
+
* serve the route) surfaces as `ApiResponseError`, unchanged.
|
|
100
101
|
*/
|
|
101
102
|
export declare function prepareInputs(client: PrepareCapableClient, request: PrepareInputsRequest): Promise<PreparedInputs>;
|