@xyo-network/module-instance-plugin 4.1.1 → 5.0.0

package/dist/neutral/index.d.ts

@@ -1,28 +1,3 @@
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import * as _xyo_network_module_model from '@xyo-network/module-model';
-import { AnyConfigSchema, Module } from '@xyo-network/module-model';
-import { Promisable } from '@xylabs/promise';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { AbstractModuleInstancePayload } from '@xyo-network/module-instance-payload-plugin';
-import { Schema, Payload } from '@xyo-network/payload-model';
-import { WitnessParams, WitnessConfig } from '@xyo-network/witness-model';
-
-type AbstractModuleInstanceWitnessConfigSchema = 'network.xyo.module.instance.config';
-declare const AbstractModuleInstanceWitnessConfigSchema: AbstractModuleInstanceWitnessConfigSchema;
-type AbstractModuleInstanceWitnessConfig = WitnessConfig<{
-    schema: AbstractModuleInstanceWitnessConfigSchema;
-}>;
-interface AbstractModuleInstanceWitnessParams extends WitnessParams<AnyConfigSchema<AbstractModuleInstanceWitnessConfig>> {
-    mod?: Module;
-}
-declare class AbstractModuleInstanceWitness<TParams extends AbstractModuleInstanceWitnessParams = AbstractModuleInstanceWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected get mod(): Module<_xyo_network_module_model.ModuleParams<AnyConfigSchema<_xyo_network_module_model.ModuleConfig>>, _xyo_network_module_model.ModuleEventData<object>> | undefined;
-    protected observeHandler(_payloads?: Partial<Payload>[]): Promisable<AbstractModuleInstancePayload[]>;
-}
-
-declare const AbstractModuleInstancePlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<AbstractModuleInstanceWitness<AbstractModuleInstanceWitnessParams>>;
-
-export { AbstractModuleInstancePlugin, AbstractModuleInstanceWitness, AbstractModuleInstanceWitnessConfigSchema, AbstractModuleInstancePlugin as default };
-export type { AbstractModuleInstanceWitnessConfig, AbstractModuleInstanceWitnessParams };
+export { AbstractModuleInstancePlugin, AbstractModuleInstancePlugin as default } from './Plugin.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/module-instance-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Contains the information about a module instance",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,22 +28,25 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/promise": "^4.13.23",
-    "@xyo-network/abstract-witness": "^4.1.7",
-    "@xyo-network/module-instance-payload-plugin": "^4.1.1",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7",
-    "@xyo-network/payloadset-plugin": "^4.1.7",
-    "@xyo-network/witness-model": "^4.1.7"
+    "@xylabs/promise": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/module-instance-payload-plugin": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0",
+    "@xyo-network/witness-model": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "@xyo-network/archivist-memory": "^4.1.7",
-    "@xyo-network/payload-wrapper": "^4.1.7",
-    "knip": "^5.62.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/archivist-memory": "^5.0.0",
+    "@xyo-network/payload-wrapper": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/Plugin.dom.spec.ts

@@ -0,0 +1,19 @@
+import '@xylabs/vitest-extended'
+
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { AbstractModuleInstancePlugin } from '../Plugin.ts'
+import { AbstractModuleInstanceWitnessConfigSchema } from '../Witness.ts'
+
+describe('AbstractModuleInstancePlugin', () => {
+  test('Add to Resolver', async () => {
+    const plugin = AbstractModuleInstancePlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin, { config: { schema: AbstractModuleInstanceWitnessConfigSchema } })
+    expect(await resolver.resolve(plugin.set)).toBeObject()
+    expect(await resolver.witness(plugin.set)).toBeObject()
+  })
+})

package/src/spec/Witness.spec.ts

@@ -0,0 +1,29 @@
+import '@xylabs/vitest-extended'
+
+import { MemoryArchivist } from '@xyo-network/archivist-memory'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { AbstractModuleInstanceWitness, AbstractModuleInstanceWitnessConfigSchema } from '../Witness.ts'
+
+describe.skip('AbstractModuleInstanceWitness', () => {
+  test('Witnessing', async () => {
+    const mod = await MemoryArchivist.create({ account: 'random' })
+    const witness = await AbstractModuleInstanceWitness.create({
+      account: 'random',
+      config: { schema: AbstractModuleInstanceWitnessConfigSchema },
+      mod,
+    })
+    const [result] = await witness.observe()
+    expect(await PayloadWrapper.wrap(result).getValid()).toBe(true)
+  })
+
+  test('Witnessing [no config]', async () => {
+    const witness = await AbstractModuleInstanceWitness.create({ account: 'random' })
+    const [result] = await witness.observe()
+    expect(await PayloadWrapper.wrap(result).getValid()).toBe(true)
+  })
+})

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    node: {},
-    neutral: { src: true },
-  },
-}
-
-export default config