@stryke/capnp 0.12.96 → 0.12.97

package/dist/{compile-SmxAaHxW.cjs → compile-Yq1zhccM.cjs}

@@ -1,10 +1,10 @@
-const require_helpers = require('./helpers-gxlsFdP8.cjs');
-const require_capnp_es_GpvEvMIK = require('./capnp-es.GpvEvMIK-BcYm5JyH.cjs');
-let __stryke_fs_exists = require("@stryke/fs/exists");
+const require_helpers = require('./helpers-Dn4nWOb7.cjs');
+const require_capnp_es_GpvEvMIK = require('./capnp-es.GpvEvMIK-CZ5ZimCD.cjs');
+let _stryke_fs_exists = require("@stryke/fs/exists");
 let typescript = require("typescript");
-typescript = require_helpers.__toESM(typescript);
+typescript = require_helpers.__toESM(typescript, 1);
 let defu = require("defu");
-defu = require_helpers.__toESM(defu);
+defu = require_helpers.__toESM(defu, 1);
 let node_buffer = require("node:buffer");
 let node_child_process = require("node:child_process");
 
@@ -495,10 +495,38 @@ var Node_Annotation = class extends require_capnp_es_GpvEvMIK.Struct {
 };
 const Node_Which = {
 	FILE: 0,
+	/**
+	* Name to present to humans to identify this Node.  You should not attempt to parse this.  Its
+	* format could change.  It is not guaranteed to be unique.
+	*
+	* (On Zooko's triangle, this is the node's nickname.)
+	*
+	*/
 	STRUCT: 1,
+	/**
+	* If you want a shorter version of `displayName` (just naming this node, without its surrounding
+	* scope), chop off this many characters from the beginning of `displayName`.
+	*
+	*/
 	ENUM: 2,
+	/**
+	* ID of the lexical parent node.  Typically, the scope node will have a NestedNode pointing back
+	* at this node, but robust code should avoid relying on this (and, in fact, group nodes are not
+	* listed in the outer struct's nestedNodes, since they are listed in the fields).  `scopeId` is
+	* zero if the node has no parent, which is normally only the case with files, but should be
+	* allowed for any kind of node (in order to make runtime type generation easier).
+	*
+	*/
 	INTERFACE: 3,
+	/**
+	* List of nodes nested within this node, along with the names under which they were declared.
+	*
+	*/
 	CONST: 4,
+	/**
+	* Annotations applied to this node.
+	*
+	*/
 	ANNOTATION: 5
 };
 var Node = class Node extends require_capnp_es_GpvEvMIK.Struct {
@@ -816,6 +844,13 @@ var Field_Group = class extends require_capnp_es_GpvEvMIK.Struct {
 };
 const Field_Ordinal_Which = {
 	IMPLICIT: 0,
+	/**
+	* The original ordinal number given to the field.  You probably should NOT use this; if you need
+	* a numeric identifier for a field, use its position within the field array for its scope.
+	* The ordinal is given here mainly just so that the original schema text can be reproduced given
+	* the compiled version -- i.e. so that `capnp compile -ocapnp` can do its job.
+	*
+	*/
 	EXPLICIT: 1
 };
 var Field_Ordinal = class extends require_capnp_es_GpvEvMIK.Struct {
@@ -859,6 +894,15 @@ var Field_Ordinal = class extends require_capnp_es_GpvEvMIK.Struct {
 };
 const Field_Which = {
 	SLOT: 0,
+	/**
+	* Indicates where this member appeared in the code, relative to other members.
+	* Code ordering may have semantic relevance -- programmers tend to place related fields
+	* together.  So, using code ordering makes sense in human-readable formats where ordering is
+	* otherwise irrelevant, like JSON.  The values of codeOrder are tightly-packed, so the maximum
+	* value is count(members) - 1.  Fields that are members of a union are only ordered relative to
+	* the other members of that union, so the maximum value there is count(union.members).
+	*
+	*/
 	GROUP: 1
 };
 var Field = class Field extends require_capnp_es_GpvEvMIK.Struct {
@@ -1322,9 +1366,25 @@ var Type_Interface = class extends require_capnp_es_GpvEvMIK.Struct {
 	}
 };
 const Type_AnyPointer_Unconstrained_Which = {
+	/**
+	* truly AnyPointer
+	*
+	*/
 	ANY_KIND: 0,
+	/**
+	* AnyStruct
+	*
+	*/
 	STRUCT: 1,
+	/**
+	* AnyList
+	*
+	*/
 	LIST: 2,
+	/**
+	* Capability
+	*
+	*/
 	CAPABILITY: 3
 };
 var Type_AnyPointer_Unconstrained = class extends require_capnp_es_GpvEvMIK.Struct {
@@ -1416,8 +1476,25 @@ var Type_AnyPointer_ImplicitMethodParameter = class extends require_capnp_es_Gpv
 	}
 };
 const Type_AnyPointer_Which = {
+	/**
+	* A regular AnyPointer.
+	*
+	* The name "unconstrained" means as opposed to constraining it to match a type parameter.
+	* In retrospect this name is probably a poor choice given that it may still be constrained
+	* to be a struct, list, or capability.
+	*
+	*/
 	UNCONSTRAINED: 0,
+	/**
+	* This is actually a reference to a type parameter defined within this scope.
+	*
+	*/
 	PARAMETER: 1,
+	/**
+	* This is actually a reference to an implicit (generic) parameter of a method. The only
+	* legal context for this type to appear is inside Method.paramBrand or Method.resultBrand.
+	*
+	*/
 	IMPLICIT_METHOD_PARAMETER: 2
 };
 var Type_AnyPointer = class extends require_capnp_es_GpvEvMIK.Struct {
@@ -1703,7 +1780,15 @@ var Type = class extends require_capnp_es_GpvEvMIK.Struct {
 	}
 };
 const Brand_Scope_Which = {
+	/**
+	* ID of the scope to which these params apply.
+	*
+	*/
 	BIND: 0,
+	/**
+	* List of parameter bindings.
+	*
+	*/
 	INHERIT: 1
 };
 var Brand_Scope = class Brand_Scope extends require_capnp_es_GpvEvMIK.Struct {
@@ -1872,6 +1957,11 @@ const Value_Which = {
 	LIST: 14,
 	ENUM: 15,
 	STRUCT: 16,
+	/**
+	* The only interface value that can be represented statically is "null", whose methods always
+	* throw exceptions.
+	*
+	*/
 	INTERFACE: 17,
 	ANY_POINTER: 18
 };
@@ -2213,6 +2303,10 @@ var Annotation = class extends require_capnp_es_GpvEvMIK.Struct {
 	}
 };
 const ElementSize = {
+	/**
+	* aka "void", but that's a keyword.
+	*
+	*/
 	EMPTY: 0,
 	BIT: 1,
 	BYTE: 2,
@@ -3048,16 +3142,16 @@ function generateStructFieldMethods(ctx, members, node, field, fieldIndex) {
 	const maybeDefaultArg = hadExplicitDefault ? `, ${fullClassName}._capnp.default${capitalizedName}` : "";
 	const union = discriminantValue !== Field.NO_DISCRIMINANT;
 	const offset = field._isSlot ? field.slot.offset : 0;
-	let adopt$1 = false;
-	let disown$1 = false;
+	let adopt = false;
+	let disown = false;
 	let has = false;
 	let init;
 	let get;
 	let set;
 	switch (whichType) {
 		case Type.ANY_POINTER:
-			adopt$1 = true;
-			disown$1 = true;
+			adopt = true;
+			disown = true;
 			has = true;
 			get = `$.utils.getPointer(${offset}, this${maybeDefaultArg})`;
 			set = `$.utils.copyFrom(value, ${get})`;
@@ -3082,8 +3176,8 @@ function generateStructFieldMethods(ctx, members, node, field, fieldIndex) {
 			break;
 		}
 		case Type.DATA:
-			adopt$1 = true;
-			disown$1 = true;
+			adopt = true;
+			disown = true;
 			has = true;
 			get = `$.utils.getData(${offset}, this${maybeDefaultArg})`;
 			set = `$.utils.copyFrom(value, $.utils.getPointer(${offset}, this))`;
@@ -3098,8 +3192,8 @@ function generateStructFieldMethods(ctx, members, node, field, fieldIndex) {
 			let listClass = ConcreteListType[elementType];
 			if (elementType === Type.LIST || elementType === Type.STRUCT) listClass = `${fullClassName}._${capitalizedName}`;
 			else if (listClass === void 0) throw new Error(require_capnp_es_GpvEvMIK.format(GEN_UNSUPPORTED_LIST_ELEMENT_TYPE, elementType));
-			adopt$1 = true;
-			disown$1 = true;
+			adopt = true;
+			disown = true;
 			has = true;
 			get = `$.utils.getList(${offset}, ${listClass}, this${maybeDefaultArg})`;
 			set = `$.utils.copyFrom(value, $.utils.getPointer(${offset}, this))`;
@@ -3111,8 +3205,8 @@ function generateStructFieldMethods(ctx, members, node, field, fieldIndex) {
 			break;
 		}
 		case Type.STRUCT:
-			adopt$1 = true;
-			disown$1 = true;
+			adopt = true;
+			disown = true;
 			has = true;
 			get = `$.utils.getStruct(${offset}, ${jsType}, this${maybeDefaultArg})`;
 			set = `$.utils.copyFrom(value, $.utils.getPointer(${offset}, this))`;
@@ -3129,13 +3223,13 @@ function generateStructFieldMethods(ctx, members, node, field, fieldIndex) {
 			init = get;
 			break;
 	}
-	if (adopt$1) members.push(`
+	if (adopt) members.push(`
       _adopt${capitalizedName}(value: $.Orphan<${jsType}>): void {
         ${union ? `$.utils.setUint16(${discriminantOffset * 2}, ${discriminantValue}, this);` : ""}
         $.utils.adopt(value, $.utils.getPointer(${offset}, this));
       }
     `);
-	if (disown$1) members.push(`
+	if (disown) members.push(`
       _disown${capitalizedName}(): $.Orphan<${jsType}> {
         return $.utils.disown(this.${name === "constructor" ? `$${name}` : name});
       }
@@ -3481,9 +3575,9 @@ async function capnpc(options) {
 	}
 	if (dataBuf.byteLength === 0) {
 		const opts = [];
-		if (output && (0, __stryke_fs_exists.existsSync)(output)) opts.push(`-o-:${output}`);
+		if (output && (0, _stryke_fs_exists.existsSync)(output)) opts.push(`-o-:${output}`);
 		else {
-			if (output && !(0, __stryke_fs_exists.existsSync)(output)) require_helpers.writeWarning(`Output directory "${output}" does not exist, will write to schema path...`);
+			if (output && !(0, _stryke_fs_exists.existsSync)(output)) require_helpers.writeWarning(`Output directory "${output}" does not exist, will write to schema path...`);
 			opts.push("-o-");
 		}
 		dataBuf = await new Promise((resolve) => {

package/dist/compile.cjs

@@ -1,5 +1,5 @@
-require('./helpers-gxlsFdP8.cjs');
-const require_compile = require('./compile-SmxAaHxW.cjs');
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_compile = require('./compile-Yq1zhccM.cjs');
 
 exports.capnpc = require_compile.capnpc;
 exports.compile = require_compile.compile;

package/dist/compile.d.cts

@@ -1,3 +1,38 @@
-import "./types-D52qMMoK.cjs";
-import { n as compile, t as capnpc } from "./compile-DccxA7WZ.cjs";
-export { capnpc, compile };
+import { c as CodeGeneratorRequest_RequestedFile, d as Node, i as CapnpcResult, l as CodeGeneratorRequest_RequestedFile_Import, n as CapnpcOptions, r as CapnpcResolvedOptions, s as CodeGeneratorRequest, u as Field } from "./types-BjCOVfgj.cjs";
+import { Buffer } from "node:buffer";
+
+//#region src/compile.d.ts
+/**
+ * Compiles Cap'n Proto schemas into TypeScript files.
+ *
+ * @param options - The options for the compilation process.
+ * @returns A promise that resolves to the compilation result.
+ */
+declare function capnpc(options: CapnpcResolvedOptions): Promise<CapnpcResult>;
+/**
+ * Compiles Cap'n Proto schemas into TypeScript files.
+ *
+ * @param dataBuf - The buffer containing the Cap'n Proto schema data.
+ * @param options - The options for the compilation process.
+ * @returns A promise that resolves to the compilation result.
+ */
+declare function compile(dataBuf: Buffer, options: CapnpcOptions): Promise<{
+  ctx: {
+    files: {
+      readonly req: CodeGeneratorRequest;
+      readonly file: CodeGeneratorRequest_RequestedFile;
+      readonly nodes: Node[];
+      readonly imports: CodeGeneratorRequest_RequestedFile_Import[];
+      concreteLists: Array<[string, Field]>;
+      generatedNodeIds: Set<string>;
+      generatedResultsPromiseIds: Set<bigint>;
+      tsPath: string;
+      codeParts: string[];
+      toString(): string;
+    }[];
+  };
+  files: Map<string, string>;
+} | undefined>;
+//#endregion
+export { capnpc, compile };
+//# sourceMappingURL=compile.d.cts.map

package/dist/compile.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compile.d.cts","names":[],"sources":["../../src/compile.ts"],"mappings":";;;;;;AAqCA;;;;iBAAsB,MAAA,CACpB,OAAA,EAAS,qBAAA,GACR,OAAA,CAAQ,YAAA;;;;;;;;iBA0EW,OAAA,CAAQ,OAAA,EAAS,MAAA,EAAQ,OAAA,EAAS,aAAA,GAAa,OAAA;;;oBAAA,oBAAA;MAAA"}

package/dist/compile.d.mts

@@ -1,3 +1,38 @@
-import "./types-D03SjfBL.mjs";
-import { n as compile, t as capnpc } from "./compile-UkKIpqrK.mjs";
-export { capnpc, compile };
+import { c as CodeGeneratorRequest_RequestedFile, d as Node, i as CapnpcResult, l as CodeGeneratorRequest_RequestedFile_Import, n as CapnpcOptions, r as CapnpcResolvedOptions, s as CodeGeneratorRequest, u as Field } from "./types-CVzMn-TI.mjs";
+import { Buffer } from "node:buffer";
+
+//#region src/compile.d.ts
+/**
+ * Compiles Cap'n Proto schemas into TypeScript files.
+ *
+ * @param options - The options for the compilation process.
+ * @returns A promise that resolves to the compilation result.
+ */
+declare function capnpc(options: CapnpcResolvedOptions): Promise<CapnpcResult>;
+/**
+ * Compiles Cap'n Proto schemas into TypeScript files.
+ *
+ * @param dataBuf - The buffer containing the Cap'n Proto schema data.
+ * @param options - The options for the compilation process.
+ * @returns A promise that resolves to the compilation result.
+ */
+declare function compile(dataBuf: Buffer, options: CapnpcOptions): Promise<{
+  ctx: {
+    files: {
+      readonly req: CodeGeneratorRequest;
+      readonly file: CodeGeneratorRequest_RequestedFile;
+      readonly nodes: Node[];
+      readonly imports: CodeGeneratorRequest_RequestedFile_Import[];
+      concreteLists: Array<[string, Field]>;
+      generatedNodeIds: Set<string>;
+      generatedResultsPromiseIds: Set<bigint>;
+      tsPath: string;
+      codeParts: string[];
+      toString(): string;
+    }[];
+  };
+  files: Map<string, string>;
+} | undefined>;
+//#endregion
+export { capnpc, compile };
+//# sourceMappingURL=compile.d.mts.map

package/dist/compile.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compile.d.mts","names":[],"sources":["../../src/compile.ts"],"mappings":";;;;;;AAqCA;;;;iBAAsB,MAAA,CACpB,OAAA,EAAS,qBAAA,GACR,OAAA,CAAQ,YAAA;;;;;;;;iBA0EW,OAAA,CAAQ,OAAA,EAAS,MAAA,EAAQ,OAAA,EAAS,aAAA,GAAa,OAAA;;;oBAAA,oBAAA;MAAA"}

package/dist/compile.mjs

@@ -1,4 +1,3 @@
-import "./helpers-BoYAadSB.mjs";
-import { n as compile, t as capnpc } from "./compile-Cx88xgqJ.mjs";
+import { n as compile, t as capnpc } from "./compile-D_BOc0dD.mjs";
 
 export { capnpc, compile };