@xyo-network/witness-environment 4.2.1 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/witness-environment",
-  "version": "4.2.1",
+  "version": "5.0.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,20 +28,24 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/object": "^4.14.1",
-    "@xyo-network/abstract-witness": "^4.2.1",
-    "@xyo-network/module-model": "^4.2.1",
-    "@xyo-network/payload-model": "^4.2.1",
-    "@xyo-network/value-payload-plugin": "^4.2.1",
-    "@xyo-network/witness-model": "^4.2.1"
+    "@xylabs/object": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/value-payload-plugin": "^5.0.0",
+    "@xyo-network/witness-model": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.14.1",
-    "@xyo-network/account": "^4.2.1",
-    "@xyo-network/payload-builder": "^4.2.1",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/account": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/Witness.spec.ts

@@ -0,0 +1,56 @@
+import '@xylabs/vitest-extended'
+
+import { Account } from '@xyo-network/account'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import { isValuePayload } from '@xyo-network/value-payload-plugin'
+import {
+  beforeAll,
+  describe, expect, it,
+} from 'vitest'
+
+import { EnvironmentWitnessConfigSchema } from '../Config.ts'
+import type { EnvironmentSubset } from '../Payload.ts'
+import { EnvironmentSubsetSchema } from '../Payload.ts'
+import { EnvironmentWitness } from '../Witness.ts'
+
+/**
+ * @group witness
+ * @group module
+ */
+
+describe('EnvironmentWitness', () => {
+  let sut: EnvironmentWitness
+  beforeAll(async () => {
+    const config = { schema: EnvironmentWitnessConfigSchema }
+    const account = await Account.random()
+    sut = await EnvironmentWitness.create({ account, config })
+  })
+  describe('witness', () => {
+    describe('without template payload', () => {
+      it('should return the environment', async () => {
+        const result = await sut.observe()
+        expect(result).toBeArrayOfSize(1)
+        const env = result.find(isValuePayload)
+        expect(env).toBeDefined()
+        expect(env?.value).toBeDefined()
+        // NOTE: Due to how we sanitize __ fields from payloads
+        // this test can fail on systems where __ fields are present
+        // in the environment so we'll sanitize those when comparing
+        const processEnv = process.env
+        expect(env?.value).toEqual(processEnv)
+      })
+    })
+    describe('with subset payload', () => {
+      it('should return only the environment subset', async () => {
+        type EnvironmentWithPath = { PATH: string }
+        const template: EnvironmentSubset = { schema: EnvironmentSubsetSchema, values: ['PATH'] }
+        const result = await sut.observe([template])
+        expect(result).toBeArrayOfSize(1)
+        const env = result.find(isValuePayload)
+        expect(env).toBeDefined()
+        expect(env?.value).toContainAllKeys(template.values)
+        expect((env?.value as EnvironmentWithPath)?.PATH).toEqual(process.env.PATH)
+      })
+    })
+  })
+})

package/xy.config.ts

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