@xyo-network/module-model 2.68.0 → 2.69.0-rc.1

package/dist/cjs/ModuleQueryHandlerResult.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ModuleQueryHandlerResult.js.map

package/dist/cjs/ModuleQueryHandlerResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleQueryHandlerResult.js","sourceRoot":"","sources":["../../src/ModuleQueryHandlerResult.ts"],"names":[],"mappings":""}

package/dist/cjs/index.js

@@ -11,6 +11,7 @@ tslib_1.__exportStar(require("./module"), exports);
 tslib_1.__exportStar(require("./ModuleDescription"), exports);
 tslib_1.__exportStar(require("./ModuleFactory"), exports);
 tslib_1.__exportStar(require("./ModuleParams"), exports);
+tslib_1.__exportStar(require("./ModuleQueryHandlerResult"), exports);
 tslib_1.__exportStar(require("./ModuleQueryResult"), exports);
 tslib_1.__exportStar(require("./Queries"), exports);
 tslib_1.__exportStar(require("./withModule"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,mDAAwB;AACxB,4DAAiC;AACjC,sEAA2C;AAC3C,mDAAwB;AACxB,qDAA0B;AAC1B,gDAAqB;AACrB,mDAAwB;AACxB,8DAAmC;AACnC,0DAA+B;AAC/B,yDAA8B;AAC9B,8DAAmC;AACnC,oDAAyB;AACzB,uDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,mDAAwB;AACxB,4DAAiC;AACjC,sEAA2C;AAC3C,mDAAwB;AACxB,qDAA0B;AAC1B,gDAAqB;AACrB,mDAAwB;AACxB,8DAAmC;AACnC,0DAA+B;AAC/B,yDAA8B;AAC9B,qEAA0C;AAC1C,8DAAmC;AACnC,oDAAyB;AACzB,uDAA4B"}

package/dist/esm/ModuleQueryHandlerResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ModuleQueryHandlerResult.js.map

package/dist/esm/ModuleQueryHandlerResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleQueryHandlerResult.js","sourceRoot":"","sources":["../../src/ModuleQueryHandlerResult.ts"],"names":[],"mappings":""}

package/dist/esm/index.js

@@ -8,6 +8,7 @@ export * from './module';
 export * from './ModuleDescription';
 export * from './ModuleFactory';
 export * from './ModuleParams';
+export * from './ModuleQueryHandlerResult';
 export * from './ModuleQueryResult';
 export * from './Queries';
 export * from './withModule';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qBAAqB,CAAA;AACnC,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/dist/types/Config.d.ts

@@ -13,47 +13,28 @@ export interface IndividualArchivistConfig {
 }
 export type ArchivistModuleConfig = NameOrAddress | IndividualArchivistConfig;
 export type ModuleConfigBase<TConfig extends Payload | undefined = undefined> = Payload<WithAdditional<{
-    /**
-     * The name/address of the Archivist to use for this module
-     */
+    /** @field The name/address of the Archivist to use for this module */
     readonly archivist?: ArchivistModuleConfig;
-    /**
-     * Friendly name of module (not collision resistent). Can be used to resolve module
-     * when registered/attached to Node.
-     */
+    /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
     readonly name?: string;
-    /**
-     * paging settings for queries
-     */
+    /** @field paging settings for queries */
     readonly paging?: Record<string, {
         size?: number;
     }>;
-    /**
-     * The config schema for the module
-     */
+    /** @field The config schema for the module */
     readonly schema: TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema;
-    /**
-     * The query schemas and allowed/disallowed addresses which are allowed to issue them
-     * against the module. If both allowed and disallowed is specified, then disallowed
-     * takes priority
-     */
+    /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */
     readonly security?: {
-        /**
-         * Will the module process queries that have unsigned BoundWitness in query tuples
-         */
+        /** @field Will the module process queries that have unsigned BoundWitness in query tuples */
         readonly allowAnonymous?: boolean;
-        /**
-         * If schema in record, then only these address sets can access query
-         */
+        /** @field If schema in record, then only these address sets can access query */
         readonly allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>;
-        /**
-         * If schema in record, then anyone except these addresses can access query
-         */
+        /** @field If schema in record, then anyone except these addresses can access query */
         readonly disallowed?: Record<SchemaString, AddressString[]>;
     };
-    /**
-     * Store the queries made to the module in an archivist if possible
-     */
+    /** @field sign every  */
+    readonly sign?: boolean;
+    /** @field Store the queries made to the module in an archivist if possible */
     readonly storeQueries?: boolean;
 }, Omit<TConfig, 'schema'>>>;
 export type ModuleConfig<TConfig extends Payload | undefined = undefined> = ModuleConfigBase<TConfig>;

package/dist/types/Config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAA;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAElC,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAA;IAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAA;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;CAC/B;AAED,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG,yBAAyB,CAAA;AAE7E,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,IAAI,OAAO,CACrF,cAAc,CACZ;IACE;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAA;IAE1C;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAEnD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,SAAS,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAA;IAEjF;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAClB;;WAEG;QACH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;QAEjC;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,aAAa,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAA;QAEhF;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,CAAA;KAC5D,CAAA;IAED;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CAChC,EACD,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CACxB,CACF,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAA;AAErG,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,IAC/I,YAAY,CACV,cAAc,CACZ,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EACvB;IACE,MAAM,EAAE,MAAM,CAAA;CACf,CACF,CACF,CAAA;AAEH,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;IAC1I,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,YAAY,CAAC,CAAA"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAA;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAElC,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAA;IAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAA;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;CAC/B;AAED,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG,yBAAyB,CAAA;AAE7E,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,IAAI,OAAO,CACrF,cAAc,CACZ;IACE,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAA;IAE1C,gIAAgI;IAChI,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB,yCAAyC;IACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAEnD,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,OAAO,SAAS,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAA;IAEjF,iMAAiM;IACjM,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAClB,6FAA6F;QAC7F,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;QAEjC,gFAAgF;QAChF,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,aAAa,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAA;QAEhF,sFAAsF;QACtF,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,CAAA;KAC5D,CAAA;IAED,yBAAyB;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;IAEvB,8EAA8E;IAC9E,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CAChC,EACD,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CACxB,CACF,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAA;AAErG,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,IAC/I,YAAY,CACV,cAAc,CACZ,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EACvB;IACE,MAAM,EAAE,MAAM,CAAA;CACf,CACF,CACF,CAAA;AAEH,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;IAC1I,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,YAAY,CAAC,CAAA"}

package/dist/types/ModuleQueryHandlerResult.d.ts

@@ -0,0 +1,3 @@
+import { Payload } from '@xyo-network/payload-model';
+export type ModuleQueryHandlerResult = Payload[];
+//# sourceMappingURL=ModuleQueryHandlerResult.d.ts.map

package/dist/types/ModuleQueryHandlerResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleQueryHandlerResult.d.ts","sourceRoot":"","sources":["../../src/ModuleQueryHandlerResult.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,MAAM,wBAAwB,GAAG,OAAO,EAAE,CAAA"}

package/dist/types/ModuleQueryResult.d.ts

@@ -1,4 +1,4 @@
 import { BoundWitness } from '@xyo-network/boundwitness-model';
-import { Payload } from '@xyo-network/payload-model';
-export type ModuleQueryResult<E extends Payload[] = Payload[]> = [BoundWitness, Payload[], E];
+import { ModuleError, Payload } from '@xyo-network/payload-model';
+export type ModuleQueryResult = [BoundWitness, Payload[], ModuleError[]];
 //# sourceMappingURL=ModuleQueryResult.d.ts.map

package/dist/types/ModuleQueryResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModuleQueryResult.d.ts","sourceRoot":"","sources":["../../src/ModuleQueryResult.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA"}
+{"version":3,"file":"ModuleQueryResult.d.ts","sourceRoot":"","sources":["../../src/ModuleQueryResult.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEjE,MAAM,MAAM,iBAAiB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,CAAC,CAAA"}

package/dist/types/index.d.ts

@@ -8,6 +8,7 @@ export * from './module';
 export * from './ModuleDescription';
 export * from './ModuleFactory';
 export * from './ModuleParams';
+export * from './ModuleQueryHandlerResult';
 export * from './ModuleQueryResult';
 export * from './Queries';
 export * from './withModule';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qBAAqB,CAAA;AACnC,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA"}

package/package.json

@@ -10,18 +10,18 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/account-model": "~2.68.0",
-    "@xyo-network/address-payload-plugin": "~2.68.0",
-    "@xyo-network/boundwitness-builder": "~2.68.0",
-    "@xyo-network/boundwitness-model": "~2.68.0",
-    "@xyo-network/core": "~2.68.0",
-    "@xyo-network/logger": "~2.68.0",
-    "@xyo-network/manifest-model": "~2.68.0",
-    "@xyo-network/module-events": "~2.68.0",
-    "@xyo-network/object-identity": "~2.68.0",
-    "@xyo-network/payload-model": "~2.68.0",
-    "@xyo-network/promise": "~2.68.0",
-    "@xyo-network/wallet-model": "~2.68.0",
+    "@xyo-network/account-model": "~2.69.0-rc.1",
+    "@xyo-network/address-payload-plugin": "~2.69.0-rc.1",
+    "@xyo-network/boundwitness-builder": "~2.69.0-rc.1",
+    "@xyo-network/boundwitness-model": "~2.69.0-rc.1",
+    "@xyo-network/core": "~2.69.0-rc.1",
+    "@xyo-network/logger": "~2.69.0-rc.1",
+    "@xyo-network/manifest-model": "~2.69.0-rc.1",
+    "@xyo-network/module-events": "~2.69.0-rc.1",
+    "@xyo-network/object-identity": "~2.69.0-rc.1",
+    "@xyo-network/payload-model": "~2.69.0-rc.1",
+    "@xyo-network/promise": "~2.69.0-rc.1",
+    "@xyo-network/wallet-model": "~2.69.0-rc.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
@@ -62,5 +62,6 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.68.0"
+  "version": "2.69.0-rc.1",
+  "stableVersion": "2.68.0"
 }

package/src/Config.ts

@@ -21,52 +21,34 @@ export type ArchivistModuleConfig = NameOrAddress | IndividualArchivistConfig
 export type ModuleConfigBase<TConfig extends Payload | undefined = undefined> = Payload<
   WithAdditional<
     {
-      /**
-       * The name/address of the Archivist to use for this module
-       */
+      /** @field The name/address of the Archivist to use for this module */
       readonly archivist?: ArchivistModuleConfig
 
-      /**
-       * Friendly name of module (not collision resistent). Can be used to resolve module
-       * when registered/attached to Node.
-       */
+      /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
       readonly name?: string
 
-      /**
-       * paging settings for queries
-       */
+      /** @field paging settings for queries */
       readonly paging?: Record<string, { size?: number }>
 
-      /**
-       * The config schema for the module
-       */
+      /** @field The config schema for the module */
       readonly schema: TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema
 
-      /**
-       * The query schemas and allowed/disallowed addresses which are allowed to issue them
-       * against the module. If both allowed and disallowed is specified, then disallowed
-       * takes priority
-       */
+      /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */
       readonly security?: {
-        /**
-         * Will the module process queries that have unsigned BoundWitness in query tuples
-         */
+        /** @field Will the module process queries that have unsigned BoundWitness in query tuples */
         readonly allowAnonymous?: boolean
 
-        /**
-         * If schema in record, then only these address sets can access query
-         */
+        /** @field If schema in record, then only these address sets can access query */
         readonly allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>
 
-        /**
-         * If schema in record, then anyone except these addresses can access query
-         */
+        /** @field If schema in record, then anyone except these addresses can access query */
         readonly disallowed?: Record<SchemaString, AddressString[]>
       }
 
-      /**
-       * Store the queries made to the module in an archivist if possible
-       */
+      /** @field sign every  */
+      readonly sign?: boolean
+
+      /** @field Store the queries made to the module in an archivist if possible */
       readonly storeQueries?: boolean
     },
     Omit<TConfig, 'schema'>

package/src/ModuleQueryHandlerResult.ts

@@ -0,0 +1,3 @@
+import { Payload } from '@xyo-network/payload-model'
+
+export type ModuleQueryHandlerResult = Payload[]

package/src/ModuleQueryResult.ts

@@ -1,4 +1,4 @@
 import { BoundWitness } from '@xyo-network/boundwitness-model'
-import { Payload } from '@xyo-network/payload-model'
+import { ModuleError, Payload } from '@xyo-network/payload-model'
 
-export type ModuleQueryResult<E extends Payload[] = Payload[]> = [BoundWitness, Payload[], E]
+export type ModuleQueryResult = [BoundWitness, Payload[], ModuleError[]]

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './module'
 export * from './ModuleDescription'
 export * from './ModuleFactory'
 export * from './ModuleParams'
+export * from './ModuleQueryHandlerResult'
 export * from './ModuleQueryResult'
 export * from './Queries'
 export * from './withModule'