Stateful Diviner

packages/modules/packages/diviner/packages/indexing/packages/model/src/Config.ts

@@ -1,7 +1,6 @@
-import { DivinerConfig } from '@xyo-network/diviner-model'
+import { DivinerConfig, SearchableStorage } from '@xyo-network/diviner-model'
 
 import { IndexingDivinerSchema } from './Schema'
-import { SearchableStorage } from './SearchableStorage'
 import { IndexingDivinerStageConfig } from './Stage'
 
 export const IndexingDivinerConfigSchema = `${IndexingDivinerSchema}.config` as const

packages/modules/packages/diviner/packages/indexing/packages/model/src/index.ts

@@ -2,6 +2,5 @@ export * from './Config'
 export * from './Labels'
 export * from './Params'
 export * from './Schema'
-export * from './SearchableStorage'
 export * from './Stage'
 export * from './State'

packages/modules/packages/diviner/packages/indexing/packages/temporal/packages/model/src/Config.ts

@@ -1,5 +1,5 @@
-import { IndexingDivinerStage, IndexingDivinerStageConfig, SearchableStorage } from '@xyo-network/diviner-indexing-model'
-import { DivinerConfig } from '@xyo-network/diviner-model'
+import { IndexingDivinerStage, IndexingDivinerStageConfig } from '@xyo-network/diviner-indexing-model'
+import { DivinerConfig, SearchableStorage } from '@xyo-network/diviner-model'
 
 import { TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig } from './DivinerQueryToIndexQueryDiviner'
 import { TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig } from './IndexQueryResponseToDivinerQueryResponseDiviner'

packages/modules/packages/diviner/packages/indexing/packages/temporal/packages/model/src/StateToIndexCandidateDiviner/Config.ts

@@ -1,6 +1,5 @@
 import { BoundWitnessDivinerPredicate } from '@xyo-network/diviner-boundwitness-model'
-import { SearchableStorage } from '@xyo-network/diviner-indexing-model'
-import { DivinerConfig } from '@xyo-network/diviner-model'
+import { DivinerConfig, SearchableStorage } from '@xyo-network/diviner-model'
 
 import { TemporalIndexingDivinerStateToIndexCandidateDivinerSchema } from './Schema'
 

packages/modules/packages/diviner/packages/jsonpath/packages/aggregate/packages/memory/package.json

@@ -25,6 +25,7 @@
     "@xyo-network/boundwitness-builder": "workspace:~",
     "@xyo-network/boundwitness-model": "workspace:~",
     "@xyo-network/diviner-jsonpath-memory": "workspace:~",
+    "@xyo-network/diviner-jsonpath-model": "workspace:~",
     "@xyo-network/wallet-model": "workspace:~",
     "typescript": "^5.3.3"
   },

packages/modules/packages/diviner/packages/model/src/index.ts

@@ -6,4 +6,5 @@ export * from './Instance'
 export * from './Module'
 export * from './Params'
 export * from './Queries'
+export * from './SearchableStorage'
 export * from './typeChecks'

packages/modules/packages/diviner/packages/stateful/.npmignore

@@ -0,0 +1,21 @@
+.*
+.env
+.eslintcache
+.example.env
+tsconfig*
+jest.config.js
+rollup.config.ts
+yarn.lock
+**/*.spec.ts
+**/*.snap
+
+.github
+docs
+.pnp.*
+.vscode
+.yarn/*
+coverage
+cspell.json
+node_modules
+swagger.json
+packages

packages/modules/packages/diviner/packages/stateful/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

packages/modules/packages/diviner/packages/stateful/README.md

@@ -0,0 +1,13 @@
+[![logo][]](https://xyo.network)
+
+Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
+
+## License
+
+> See the [LICENSE](LICENSE) file for license details
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO](https://xyo.network)
+
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

packages/modules/packages/diviner/packages/stateful/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@xyo-network/diviner-stateful",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.13.20",
+    "@xyo-network/abstract-diviner": "workspace:~",
+    "@xyo-network/archivist": "workspace:~",
+    "@xyo-network/archivist-wrapper": "workspace:~",
+    "@xyo-network/boundwitness-builder": "workspace:~",
+    "@xyo-network/boundwitness-model": "workspace:~",
+    "@xyo-network/diviner-boundwitness-model": "workspace:~",
+    "@xyo-network/diviner-model": "workspace:~",
+    "@xyo-network/diviner-wrapper": "workspace:~",
+    "@xyo-network/module-model": "workspace:~",
+    "@xyo-network/payload-builder": "workspace:~",
+    "@xyo-network/payload-model": "workspace:~"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.2.10",
+    "@xylabs/tsconfig": "^3.2.10",
+    "@xyo-network/account": "workspace:~",
+    "@xyo-network/diviner-boundwitness-memory": "workspace:~",
+    "@xyo-network/diviner-payload-memory": "workspace:~",
+    "@xyo-network/manifest": "workspace:~",
+    "@xyo-network/memory-archivist": "workspace:~",
+    "@xyo-network/node-memory": "workspace:~",
+    "typescript": "^5.3.3"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "docs": "dist/docs.json",
+  "types": "dist/node/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.ts",
+          "default": "./dist/node/index.js"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.mjs"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.js",
+  "module": "dist/node/index.mjs",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.84.0"
+}

packages/modules/packages/diviner/packages/stateful/src/Config.ts

@@ -0,0 +1,24 @@
+import { DivinerConfig } from '@xyo-network/diviner-model'
+
+import { StatefulDivinerSchema } from './Schema'
+
+/**
+ * The schema for a Stateful Diviner config
+ */
+export const StatefulDivinerConfigSchema = `${StatefulDivinerSchema}.config` as const
+/**
+ * The schema for a Stateful Diviner config
+ */
+export type StatefulDivinerConfigSchema = typeof StatefulDivinerConfigSchema
+
+/**
+ * The config for a Stateful Diviner
+ */
+export type StatefulDivinerConfig = DivinerConfig<{
+  schema: StatefulDivinerConfigSchema
+  stateStore: {
+    archivist: string
+    boundWitnessDiviner: string
+    payloadDiviner: string
+  }
+}>