@xyo-network/url-safety-plugin 4.2.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/url-safety-plugin",
-  "version": "4.2.0",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,19 +28,23 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/axios": "^4.15.1",
-    "@xyo-network/abstract-witness": "^4.3.0",
-    "@xyo-network/module-model": "^4.3.0",
-    "@xyo-network/payload-model": "^4.3.0",
-    "@xyo-network/payloadset-plugin": "^4.3.0",
-    "@xyo-network/url-payload-plugin": "^4.2.0",
-    "@xyo-network/url-safety-payload-plugin": "^4.2.0",
-    "@xyo-network/witness-model": "^4.3.0"
+    "@xylabs/axios": "^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/payloadset-plugin": "^5.0.0",
+    "@xyo-network/url-payload-plugin": "^5.0.0",
+    "@xyo-network/url-safety-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/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/Witness.spec.ts

@@ -0,0 +1,38 @@
+import type { ModuleError } from '@xyo-network/payload-model'
+import type { UrlPayload } from '@xyo-network/url-payload-plugin'
+import { UrlSchema } from '@xyo-network/url-payload-plugin'
+import type { UrlSafetyPayload } from '@xyo-network/url-safety-payload-plugin'
+import {
+  beforeAll, describe, expect, test,
+} from 'vitest'
+
+import { UrlSafetyWitness } from '../Witness/index.ts'
+
+describe.skipIf(!process.env.GOOGLE_SAFEBROWSING_KEY)('UrlSafetyWitness', () => {
+  let witness: UrlSafetyWitness
+  const schema = UrlSchema
+  beforeAll(async () => {
+    witness = await UrlSafetyWitness.create({
+      account: 'random',
+      google: { safeBrowsing: { key: process.env.GOOGLE_SAFEBROWSING_KEY } },
+    })
+  })
+  test('Safe', async () => {
+    const safePayload: UrlPayload = { schema, url: 'https://cnn.com' }
+    const result = (await witness.observe([safePayload])) as (UrlSafetyPayload | ModuleError)[]
+    const safety = result[0] as UrlSafetyPayload
+    expect(safety.threatTypes).toBeUndefined()
+  })
+  test('Unsafe [unknown]', async () => {
+    const safePayload: UrlPayload = { schema, url: 'https://ethercb.com/image.png' }
+    const result = (await witness.observe([safePayload])) as (UrlSafetyPayload | ModuleError)[]
+    const safety = result[0] as UrlSafetyPayload
+    expect(safety.threatTypes).toBeUndefined()
+  })
+  test('Unsafe [test vector]', async () => {
+    const safePayload: UrlPayload = { schema, url: 'https://testsafebrowsing.appspot.com/s/phishing.html' }
+    const result = (await witness.observe([safePayload])) as (UrlSafetyPayload | ModuleError)[]
+    const safety = result[0] as UrlSafetyPayload
+    expect(safety.threatTypes?.length).toBeGreaterThan(0)
+  })
+})

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