@xyo-network/payload-model 2.64.10 → 2.65.0

package/dist/cjs/Error.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModuleErrorSchema = void 0;
+exports.ModuleErrorSchema = 'network.xyo.error.module';
+//# sourceMappingURL=Error.js.map

package/dist/cjs/Error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":";;;AAGa,QAAA,iBAAiB,GAAsB,0BAA0B,CAAA"}

package/dist/cjs/Query.js

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

package/dist/cjs/Query.js.map

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

package/dist/cjs/index.js

@@ -2,8 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./EmptyPayload"), exports);
+tslib_1.__exportStar(require("./Error"), exports);
 tslib_1.__exportStar(require("./isPayloadOfSchemaType"), exports);
 tslib_1.__exportStar(require("./Payload"), exports);
 tslib_1.__exportStar(require("./PayloadFindFilter"), exports);
 tslib_1.__exportStar(require("./PayloadSet"), exports);
+tslib_1.__exportStar(require("./Query"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,yDAA8B;AAC9B,kEAAuC;AACvC,oDAAyB;AACzB,8DAAmC;AACnC,uDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,yDAA8B;AAC9B,kDAAuB;AACvB,kEAAuC;AACvC,oDAAyB;AACzB,8DAAmC;AACnC,uDAA4B;AAC5B,kDAAuB"}

package/dist/esm/Error.js

@@ -0,0 +1,2 @@
+export const ModuleErrorSchema = 'network.xyo.error.module';
+//# sourceMappingURL=Error.js.map

package/dist/esm/Error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,iBAAiB,GAAsB,0BAA0B,CAAA"}

package/dist/esm/Query.js

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

package/dist/esm/Query.js.map

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

package/dist/esm/index.js

@@ -1,6 +1,8 @@
 export * from './EmptyPayload';
+export * from './Error';
 export * from './isPayloadOfSchemaType';
 export * from './Payload';
 export * from './PayloadFindFilter';
 export * from './PayloadSet';
+export * from './Query';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,yBAAyB,CAAA;AACvC,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA;AACnC,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA;AACvB,cAAc,yBAAyB,CAAA;AACvC,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA;AACnC,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA"}

package/dist/types/Error.d.ts

@@ -0,0 +1,11 @@
+import { Payload } from './Payload';
+export type ModuleErrorSchema = 'network.xyo.error.module';
+export declare const ModuleErrorSchema: ModuleErrorSchema;
+export type ModuleError = Payload<{
+    message?: string;
+    name?: string;
+    query?: string;
+    schema: ModuleErrorSchema;
+    sources?: string[];
+}>;
+//# sourceMappingURL=Error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,MAAM,MAAM,iBAAiB,GAAG,0BAA0B,CAAA;AAC1D,eAAO,MAAM,iBAAiB,EAAE,iBAA8C,CAAA;AAE9E,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,iBAAiB,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB,CAAC,CAAA"}

package/dist/types/Query.d.ts

@@ -0,0 +1,13 @@
+import { Payload } from './Payload';
+export interface QueryFields {
+    /** @field The addresses of the intended handlers */
+    address?: string | [string];
+    /** @field The maximum XYO that can be spent executing the query */
+    budget?: number;
+    /** @field The frequency on which this query can be rerun */
+    maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
+    /** @field The starting point for the bidding on the query */
+    minBid?: number;
+}
+export type Query<T extends Payload | void = void> = T extends Payload ? Payload<T & QueryFields> : Payload<QueryFields>;
+//# sourceMappingURL=Query.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,MAAM,WAAW,WAAW;IAC1B,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,CAAC,CAAA;IAE3B,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAExF,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA"}

package/dist/types/index.d.ts

@@ -1,6 +1,8 @@
 export * from './EmptyPayload';
+export * from './Error';
 export * from './isPayloadOfSchemaType';
 export * from './Payload';
 export * from './PayloadFindFilter';
 export * from './PayloadSet';
+export * from './Query';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,yBAAyB,CAAA;AACvC,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA;AACnC,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA;AACvB,cAAc,yBAAyB,CAAA;AACvC,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA;AACnC,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA"}

package/package.json

@@ -10,8 +10,8 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^2.18.7",
-    "@xylabs/tsconfig": "^2.18.7",
+    "@xylabs/ts-scripts-yarn3": "^2.18.10",
+    "@xylabs/tsconfig": "^2.18.10",
     "typescript": "^5.1.6"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -47,5 +47,5 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.64.10"
+  "version": "2.65.0"
 }

package/src/Error.ts

@@ -0,0 +1,12 @@
+import { Payload } from './Payload'
+
+export type ModuleErrorSchema = 'network.xyo.error.module'
+export const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'
+
+export type ModuleError = Payload<{
+  message?: string
+  name?: string
+  query?: string
+  schema: ModuleErrorSchema
+  sources?: string[]
+}>

package/src/Query.ts

@@ -0,0 +1,17 @@
+import { Payload } from './Payload'
+
+export interface QueryFields {
+  /** @field The addresses of the intended handlers */
+  address?: string | [string]
+
+  /** @field The maximum XYO that can be spent executing the query */
+  budget?: number
+
+  /** @field The frequency on which this query can be rerun */
+  maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'
+
+  /** @field The starting point for the bidding on the query */
+  minBid?: number
+}
+
+export type Query<T extends Payload | void = void> = T extends Payload ? Payload<T & QueryFields> : Payload<QueryFields>

package/src/index.ts

@@ -1,5 +1,7 @@
 export * from './EmptyPayload'
+export * from './Error'
 export * from './isPayloadOfSchemaType'
 export * from './Payload'
 export * from './PayloadFindFilter'
 export * from './PayloadSet'
+export * from './Query'