@xyo-network/diviner-payload-pointer-model 4.0.2 → 4.1.0

package/dist/neutral/index.d.ts

@@ -0,0 +1,107 @@
+import { DivinerConfig, DivinerParams } from '@xyo-network/diviner-model';
+import { ModuleIdentifier, AnyConfigSchema } from '@xyo-network/module-model';
+import { BoundWitnessSchema } from '@xyo-network/boundwitness-model';
+import { Sequence, Schema, Payload, PayloadSchema } from '@xyo-network/payload-model';
+import { Order } from '@xyo-network/diviner-payload-model';
+import { Address } from '@xylabs/hex';
+
+/**
+ * The config schema for the Payload Pointer Diviner
+ */
+declare const PayloadPointerDivinerConfigSchema = "network.xyo.diviner.payload.pointer.config";
+/**
+ * The config schema type for the Payload Pointer Diviner
+ */
+type PayloadPointerDivinerConfigSchema = typeof PayloadPointerDivinerConfigSchema;
+/**
+ * The configuration for the Payload Pointer Diviner
+ */
+type PayloadPointerDivinerConfig = DivinerConfig<{
+    /**
+     * The module identifier of the bound witness diviner
+     */
+    boundWitnessDiviner: ModuleIdentifier;
+    /**
+     * The module identifier of the payload diviner
+     */
+    payloadDiviner: ModuleIdentifier;
+} & {
+    schema: PayloadPointerDivinerConfigSchema;
+}>;
+
+/**
+ * The params type of the Payload Pointer diviner
+ **/
+type PayloadPointerDivinerParams = DivinerParams<AnyConfigSchema<PayloadPointerDivinerConfig>>;
+
+interface PayloadAddressRule {
+    address: string;
+}
+
+interface PayloadSchemaRule {
+    schema: string;
+}
+
+interface PayloadSequenceOrderRule {
+    order?: Order;
+    sequence?: Sequence;
+}
+
+type PayloadRule = PayloadAddressRule | PayloadSequenceOrderRule | PayloadSchemaRule;
+
+interface PayloadSearchCriteria {
+    addresses: Address[];
+    cursor?: Sequence;
+    order: Order;
+    schemas: Schema[];
+}
+
+declare const isPayloadAddressRule: (rule: PayloadRule) => rule is PayloadAddressRule;
+
+declare const isPayloadSchemaRule: (rule: PayloadRule) => rule is PayloadSchemaRule;
+
+declare const isPayloadSequenceOrderRule: (rule: PayloadRule) => rule is PayloadSequenceOrderRule;
+
+type PointerPayload = Payload<{
+    reference: PayloadRule[][];
+}>;
+
+type BoundWitnessPointerSchema = `${BoundWitnessSchema}.pointer`;
+declare const BoundWitnessPointerSchema: BoundWitnessPointerSchema;
+type BoundWitnessPointerPayload = PointerPayload & {
+    schema: BoundWitnessPointerSchema;
+};
+/**
+ * Identity function for determining if an object is a BoundWitness Pointer
+ * @param x The object to check
+ */
+declare const isBoundWitnessPointer: (x?: Payload | null) => x is BoundWitnessPointerPayload;
+
+/**
+ * Identity function for determining if an object is a Pointer Payload (PayloadPointer or BoundWitnessPointer)
+ * @param x The object to check
+ */
+declare const isPointerPayload: (x?: Payload | null) => x is PointerPayload;
+
+type PayloadPointerSchema = `${PayloadSchema}.pointer`;
+declare const PayloadPointerSchema: PayloadPointerSchema;
+type PayloadPointerPayload = PointerPayload & {
+    schema: PayloadPointerSchema;
+};
+/**
+ * Identity function for determining if an object is a Payload Pointer
+ * @param x The object to check
+ */
+declare const isPayloadPointer: (x?: Payload | null) => x is PayloadPointerPayload;
+
+/**
+ * The schema used for the Payload Pointer Diviner.
+ */
+declare const PayloadPointerDivinerSchema = "network.xyo.diviner.payload.pointer";
+/**
+ * The schema type used for the Payload Pointer Diviner.
+ */
+type PayloadPointerDivinerSchema = typeof PayloadPointerDivinerSchema;
+
+export { BoundWitnessPointerSchema, PayloadPointerDivinerConfigSchema, PayloadPointerDivinerSchema, PayloadPointerSchema, isBoundWitnessPointer, isPayloadAddressRule, isPayloadPointer, isPayloadSchemaRule, isPayloadSequenceOrderRule, isPointerPayload };
+export type { BoundWitnessPointerPayload, PayloadAddressRule, PayloadPointerDivinerConfig, PayloadPointerDivinerParams, PayloadPointerPayload, PayloadRule, PayloadSchemaRule, PayloadSearchCriteria, PayloadSequenceOrderRule, PointerPayload };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-payload-pointer-model",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,25 +21,25 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/exists": "^4.12.33",
-    "@xylabs/hex": "^4.12.33",
-    "@xyo-network/boundwitness-model": "^4.0.2",
-    "@xyo-network/diviner-model": "^4.0.2",
-    "@xyo-network/diviner-payload-model": "^4.0.2",
-    "@xyo-network/module-model": "^4.0.2",
-    "@xyo-network/payload-model": "^4.0.2"
+    "@xylabs/exists": "^4.13.15",
+    "@xylabs/hex": "^4.13.15",
+    "@xyo-network/boundwitness-model": "^4.1.0",
+    "@xyo-network/diviner-model": "^4.1.0",
+    "@xyo-network/diviner-payload-model": "^4.1.0",
+    "@xyo-network/module-model": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
-    "@xylabs/tsconfig": "^6.5.12",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
     "typescript": "^5.8.3"
   },
   "publishConfig": {