@plurnk/plurnk-schemes 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -7,4 +7,6 @@ export type { EditResult as LineEditResult, JsonSliceResult, SliceResult } from
 export { resolveEntryMimetype } from "./path-mimetype.ts";
 export { matchAgainstContent } from "./matcher.ts";
 export type { MatchResult } from "./matcher.ts";
+export { isEntryResult, isErrorStatus, isPassthroughResult, isProposalResult, logCoordinate, schemeError, } from "./results.ts";
+export type { EntryResult, PassthroughResult, ProposalResult, SchemeResult, SchemeResultBase, TelemetryEvent, } from "./results.ts";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,SAAS,EACT,kBAAkB,EAClB,cAAc,EACd,UAAU,GACb,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EACH,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,GAC1B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACH,iBAAiB,EACjB,mBAAmB,EACnB,cAAc,EACd,UAAU,EACV,aAAa,GAChB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EAAE,UAAU,IAAI,cAAc,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEnG,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,SAAS,EACT,kBAAkB,EAClB,cAAc,EACd,UAAU,GACb,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EACH,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,GAC1B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACH,iBAAiB,EACjB,mBAAmB,EACnB,cAAc,EACd,UAAU,EACV,aAAa,GAChB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EAAE,UAAU,IAAI,cAAc,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEnG,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EACH,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,WAAW,GACd,MAAM,cAAc,CAAC;AACtB,YAAY,EACR,WAAW,EACX,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,cAAc,GACjB,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -4,4 +4,5 @@ export { isBinaryMimetype, isJsonMimetype, isLineNavigableMimetype, normalizeAut
 export { applyJsonItemEdit, applyLineMarkerEdit, sliceJsonItems, sliceLines, sliceLinesRaw, } from "./line-marker.js";
 export { resolveEntryMimetype } from "./path-mimetype.js";
 export { matchAgainstContent } from "./matcher.js";
+export { isEntryResult, isErrorStatus, isPassthroughResult, isProposalResult, logCoordinate, schemeError, } from "./results.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EACH,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,GAC1B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACH,iBAAiB,EACjB,mBAAmB,EACnB,cAAc,EACd,UAAU,EACV,aAAa,GAChB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EACH,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,GAC1B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACH,iBAAiB,EACjB,mBAAmB,EACnB,cAAc,EACd,UAAU,EACV,aAAa,GAChB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAGnD,OAAO,EACH,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,WAAW,GACd,MAAM,cAAc,CAAC"}

package/dist/results.d.ts

@@ -0,0 +1,42 @@
+import type { PlurnkParseError } from "@plurnk/plurnk-grammar";
+type TelemetryEvent = ReturnType<PlurnkParseError["toTelemetryEvent"]>;
+type LogCoordinate = Extract<NonNullable<TelemetryEvent["position"]>, {
+    type: "log-coordinate";
+}>;
+export type { TelemetryEvent };
+export interface SchemeResultBase {
+    readonly status: number;
+    readonly error?: TelemetryEvent;
+}
+export interface EntryResult extends SchemeResultBase {
+    readonly shape: "entry";
+    readonly entryId: number | null;
+    readonly channel: string | null;
+    readonly content?: string | null;
+    readonly mimetype?: string | null;
+    readonly startLine?: number | null;
+    readonly matches?: number | null;
+    readonly reason?: string;
+}
+export interface ProposalResult extends SchemeResultBase {
+    readonly shape: "proposal";
+    readonly body?: string;
+    readonly attrs?: object;
+    readonly diff?: string;
+}
+export interface PassthroughResult extends SchemeResultBase {
+    readonly shape: "passthrough";
+    readonly content?: string | null;
+    readonly mimetype?: string | null;
+    readonly startLine?: number | null;
+    readonly matches?: number | null;
+    readonly reason?: string;
+}
+export type SchemeResult = EntryResult | ProposalResult | PassthroughResult;
+export declare const isEntryResult: (result: SchemeResult) => result is EntryResult;
+export declare const isProposalResult: (result: SchemeResult) => result is ProposalResult;
+export declare const isPassthroughResult: (result: SchemeResult) => result is PassthroughResult;
+export declare const isErrorStatus: (status: number) => boolean;
+export declare const schemeError: (scheme: string, kind: string, message?: string | null, position?: TelemetryEvent["position"]) => TelemetryEvent;
+export declare const logCoordinate: (coordinate: string, op?: string) => LogCoordinate;
+//# sourceMappingURL=results.d.ts.map

package/dist/results.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"results.d.ts","sourceRoot":"","sources":["../src/results.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,KAAK,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAIvE,KAAK,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,EAAE;IAAE,IAAI,EAAE,gBAAgB,CAAA;CAAE,CAAC,CAAC;AAElG,YAAY,EAAE,cAAc,EAAE,CAAC;AAE/B,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;CACnC;AAED,MAAM,WAAW,WAAY,SAAQ,gBAAgB;IACjD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACpD,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACvD,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAE5E,eAAO,MAAM,aAAa,GAAI,QAAQ,YAAY,KAAG,MAAM,IAAI,WAAuC,CAAC;AACvG,eAAO,MAAM,gBAAgB,GAAI,QAAQ,YAAY,KAAG,MAAM,IAAI,cAA6C,CAAC;AAChH,eAAO,MAAM,mBAAmB,GAAI,QAAQ,YAAY,KAAG,MAAM,IAAI,iBAAmD,CAAC;AAIzH,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,KAAG,OAAwB,CAAC;AAMxE,eAAO,MAAM,WAAW,GACpB,QAAQ,MAAM,EACd,MAAM,MAAM,EACZ,UAAU,MAAM,GAAG,IAAI,EACvB,WAAW,cAAc,CAAC,UAAU,CAAC,KACtC,cAKD,CAAC;AAMH,eAAO,MAAM,aAAa,GAAI,YAAY,MAAM,EAAE,KAAK,MAAM,KAAG,aAI9D,CAAC"}

package/dist/results.js

@@ -0,0 +1,46 @@
+// Canonical op-result contract for `@plurnk/plurnk-schemes-*` siblings and
+// their consumer (plurnk-service). Replaces the per-op result types that
+// forked in-tree (plurnk-service `_entry-ops.ts` vs the local redefinitions
+// in `File.ts` / `Exec.ts` / `Log.ts`).
+//
+// The shape keys on SCHEME-SHAPE, not op. EDIT against `known://` and EDIT
+// against `file://` produce structurally different results because the
+// schemes are differently shaped, not because EDIT is. So a family is the
+// superset of fields its shape can return across every op (entry-shape READ
+// returns content; entry-shape EDIT returns entryId) — fields optional per
+// op, discriminated by `shape`.
+//
+// Three shapes cover the current set:
+//   entry       — entries + entry_channels backed (known/unknown/skill/plurnk)
+//   proposal    — propose-then-resolve with payload (file/exec)
+//   passthrough — read-only / coordinate-addressed / network (log, future http)
+//
+// Error surface: `error` is a grammar `TelemetryEvent` (not a bare string),
+// present iff `status >= 400`. The consumer mirrors it into
+// `packet.user.telemetry.errors[]` unchanged.
+export const isEntryResult = (result) => result.shape === "entry";
+export const isProposalResult = (result) => result.shape === "proposal";
+export const isPassthroughResult = (result) => result.shape === "passthrough";
+// A result is an error result iff its status is in the 4xx/5xx range. The
+// `error` envelope is expected on those and absent otherwise.
+export const isErrorStatus = (status) => status >= 400;
+// Build a scheme-sourced TelemetryEvent. `source` is `scheme:<name>` per
+// the envelope's producer-namespacing convention (grammar TelemetryEvent
+// schema). Absent message/position are omitted rather than set to undefined
+// so the emitted object matches the wire shape exactly.
+export const schemeError = (scheme, kind, message, position) => ({
+    source: `scheme:${scheme}`,
+    kind,
+    ...(message === undefined ? {} : { message }),
+    ...(position === undefined ? {} : { position }),
+});
+// Build a LogCoordinate position pointing at an action's log row. The engine
+// knows the coordinate at result-time, so schemes rarely construct this
+// directly — it's here for the consumer-side mirror and for schemes that
+// surface errors against a known prior coordinate.
+export const logCoordinate = (coordinate, op) => ({
+    type: "log-coordinate",
+    coordinate,
+    ...(op === undefined ? {} : { op }),
+});
+//# sourceMappingURL=results.js.map

package/dist/results.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"results.js","sourceRoot":"","sources":["../src/results.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,yEAAyE;AACzE,4EAA4E;AAC5E,wCAAwC;AACxC,EAAE;AACF,2EAA2E;AAC3E,uEAAuE;AACvE,0EAA0E;AAC1E,4EAA4E;AAC5E,2EAA2E;AAC3E,gCAAgC;AAChC,EAAE;AACF,sCAAsC;AACtC,+EAA+E;AAC/E,gEAAgE;AAChE,gFAAgF;AAChF,EAAE;AACF,4EAA4E;AAC5E,4DAA4D;AAC5D,8CAA8C;AAoD9C,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAoB,EAAyB,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,OAAO,CAAC;AACvG,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAoB,EAA4B,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,UAAU,CAAC;AAChH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAoB,EAA+B,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,aAAa,CAAC;AAEzH,0EAA0E;AAC1E,8DAA8D;AAC9D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAW,EAAE,CAAC,MAAM,IAAI,GAAG,CAAC;AAExE,yEAAyE;AACzE,yEAAyE;AACzE,4EAA4E;AAC5E,wDAAwD;AACxD,MAAM,CAAC,MAAM,WAAW,GAAG,CACvB,MAAc,EACd,IAAY,EACZ,OAAuB,EACvB,QAAqC,EACvB,EAAE,CAAC,CAAC;IAClB,MAAM,EAAE,UAAU,MAAM,EAAE;IAC1B,IAAI;IACJ,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;IAC7C,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;CAClD,CAAC,CAAC;AAEH,6EAA6E;AAC7E,wEAAwE;AACxE,yEAAyE;AACzE,mDAAmD;AACnD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,UAAkB,EAAE,EAAW,EAAiB,EAAE,CAAC,CAAC;IAC9E,IAAI,EAAE,gBAAgB;IACtB,UAAU;IACV,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC;CACtC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@plurnk/plurnk-schemes",
-    "version": "0.1.0",
+    "version": "0.1.2",
     "description": "Framework + contract for the @plurnk/plurnk-schemes-* URI handler family.",
     "keywords": ["plurnk", "scheme", "uri"],
     "homepage": "https://github.com/plurnk/plurnk-schemes#readme",
@@ -41,12 +41,12 @@
         "prepare": "npm run build"
     },
     "peerDependencies": {
-        "@plurnk/plurnk-grammar": "^0.15.0",
-        "@plurnk/plurnk-mimetypes": "^0.7.0"
+        "@plurnk/plurnk-grammar": "0.17.1",
+        "@plurnk/plurnk-mimetypes": "0.7.1"
     },
     "devDependencies": {
-        "@plurnk/plurnk-grammar": "^0.15.0",
-        "@plurnk/plurnk-mimetypes": "^0.7.0",
+        "@plurnk/plurnk-grammar": "0.17.1",
+        "@plurnk/plurnk-mimetypes": "0.7.1",
         "@types/node": "^25.8.0",
         "typescript": "^6.0.3"
     }