@xyo-network/xml-plugin 5.3.1 → 5.3.3

package/dist/neutral/Payload.d.ts

@@ -1,4 +1,4 @@
-import type { JsonObject } from '@xylabs/object';
+import type { JsonObject } from '@xylabs/sdk-js';
 import type { Payload } from '@xyo-network/payload-model';
 import { XmlSchema } from './Schema.ts';
 /**

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Diviner/Diviner.ts","../../src/Schema.ts","../../src/Diviner/lib/StringDataField.ts","../../src/Diviner/lib/toXml.ts","../../src/Diviner/Schema.ts","../../src/Payload.ts"],"sourcesContent":["import { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { Xml } from '../Payload.ts'\nimport { XmlSchema } from '../Schema.ts'\nimport {\n  hasStringDataField, StringDataField, toXml,\n} from './lib/index.ts'\nimport { XmlParsingDivinerParams } from './Params.ts'\nimport { XmlParsingDivinerConfigSchema } from './Schema.ts'\n\n@creatableModule()\nexport class XmlParsingDiviner<\n  TParams extends XmlParsingDivinerParams = XmlParsingDivinerParams,\n  TIn extends Payload<StringDataField> = Payload<StringDataField>,\n  TOut extends Xml | Payload = Xml | Payload,\n  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n    DivinerInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, XmlParsingDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = XmlParsingDivinerConfigSchema\n  static override readonly targetSchema = XmlSchema\n\n  protected override async divineHandler(payloads: TIn[] = []): Promise<TOut[]> {\n    const results = await Promise.all(payloads.filter(hasStringDataField).map(toXml))\n    return results as TOut[]\n  }\n}\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport const XmlSchema = asSchema('network.xyo.xml', true)\nexport type XmlSchema = typeof XmlSchema\n","/**\n * Interface representing an object with a string data field\n */\nexport interface StringDataField {\n  /**\n   * The string data\n   */\n  data: string\n}\n\n/**\n * Identity for StringDataField\n * @param obj The input object\n * @returns True if the object is a StringDataField, false otherwise\n */\nexport const hasStringDataField = (obj?: unknown): obj is StringDataField => {\n  return typeof obj === 'object' && obj !== null && 'data' in obj && typeof (obj as StringDataField)?.data === 'string'\n}\n","import { Parser } from 'xml2js'\n\nimport type { Xml } from '../../Payload.ts'\nimport { XmlSchema } from '../../Schema.ts'\nimport type { StringDataField } from './StringDataField.ts'\n\n/**\n * Takes a string data field containing xml and converts it to an XML object\n * @param obj The input object which contains the stringified xml data\n * @returns A promise that resolves to an XML payload\n */\nexport const toXml = (obj: StringDataField): Promise<Xml> => {\n  const parser = new Parser()\n  return new Promise<Xml>((resolve, reject) => {\n    parser.parseString(obj.data, (err, result) => {\n      if (err) {\n        reject(err)\n      } else {\n        const xml = { schema: XmlSchema, xml: result } as const\n        resolve(xml)\n      }\n    })\n  })\n}\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport const XmlParsingDivinerConfigSchema = asSchema('network.xyo.diviner.xml.config', true)\nexport type XmlParsingDivinerConfigSchema = typeof XmlParsingDivinerConfigSchema\n","import type { JsonObject } from '@xylabs/object'\nimport type { Payload } from '@xyo-network/payload-model'\nimport { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'\n\nimport { XmlSchema } from './Schema.ts'\n\n/**\n * The fields of an Xml Payload\n */\nexport interface XmlFields {\n  xml: JsonObject\n}\n\n/**\n * An Xml Payload\n */\nexport type Xml = Payload<XmlFields, XmlSchema>\n\n/**\n * Identity function for determine if an object is an Xml Payload\n */\nexport const isXml = isPayloadOfSchemaType<Xml>(XmlSchema)\n\n/**\n * Identity function for determine if an object is an Xml Payload with sources\n */\nexport const isXmlWithSources = isPayloadOfSchemaTypeWithSources<Xml>(XmlSchema)\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA,SAAS,uBAAuB;AAEhC,SAAS,uBAAuB;;;ACFhC,SAAS,gBAAgB;AAElB,IAAM,YAAY,SAAS,mBAAmB,IAAI;;;ACalD,IAAM,qBAAqB,CAAC,QAA0C;AAC3E,SAAO,OAAO,QAAQ,YAAY,QAAQ,QAAQ,UAAU,OAAO,OAAQ,KAAyB,SAAS;AAC/G;;;ACjBA,SAAS,cAAc;AAWhB,IAAM,QAAQ,CAAC,QAAuC;AAC3D,QAAM,SAAS,IAAI,OAAO;AAC1B,SAAO,IAAI,QAAa,CAAC,SAAS,WAAW;AAC3C,WAAO,YAAY,IAAI,MAAM,CAAC,KAAK,WAAW;AAC5C,UAAI,KAAK;AACP,eAAO,GAAG;AAAA,MACZ,OAAO;AACL,cAAM,MAAM,EAAE,QAAQ,WAAW,KAAK,OAAO;AAC7C,gBAAQ,GAAG;AAAA,MACb;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACH;;;ACvBA,SAAS,YAAAA,iBAAgB;AAElB,IAAM,gCAAgCA,UAAS,kCAAkC,IAAI;;;AJYrF,IAAM,oBAAN,cASG,gBAAgD;AAAA,EAKxD,MAAyB,cAAc,WAAkB,CAAC,GAAoB;AAC5E,UAAM,UAAU,MAAM,QAAQ,IAAI,SAAS,OAAO,kBAAkB,EAAE,IAAI,KAAK,CAAC;AAChF,WAAO;AAAA,EACT;AACF;AARE,cAVW,mBAUc,iBAA0B,CAAC,GAAG,iDAAM,kBAAe,6BAA6B;AACzG,cAXW,mBAWc,uBAA8B;AACvD,cAZW,mBAYc,gBAAe;AAZ7B,oBAAN;AAAA,EADN,gBAAgB;AAAA,GACJ;;;AKZb,SAAS,uBAAuB,wCAAwC;AAmBjE,IAAM,QAAQ,sBAA2B,SAAS;AAKlD,IAAM,mBAAmB,iCAAsC,SAAS;","names":["asSchema"]}
+{"version":3,"sources":["../../src/Diviner/Diviner.ts","../../src/Schema.ts","../../src/Diviner/lib/StringDataField.ts","../../src/Diviner/lib/toXml.ts","../../src/Diviner/Schema.ts","../../src/Payload.ts"],"sourcesContent":["import { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { Xml } from '../Payload.ts'\nimport { XmlSchema } from '../Schema.ts'\nimport {\n  hasStringDataField, StringDataField, toXml,\n} from './lib/index.ts'\nimport { XmlParsingDivinerParams } from './Params.ts'\nimport { XmlParsingDivinerConfigSchema } from './Schema.ts'\n\n@creatableModule()\nexport class XmlParsingDiviner<\n  TParams extends XmlParsingDivinerParams = XmlParsingDivinerParams,\n  TIn extends Payload<StringDataField> = Payload<StringDataField>,\n  TOut extends Xml | Payload = Xml | Payload,\n  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n    DivinerInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, XmlParsingDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = XmlParsingDivinerConfigSchema\n  static override readonly targetSchema = XmlSchema\n\n  protected override async divineHandler(payloads: TIn[] = []): Promise<TOut[]> {\n    const results = await Promise.all(payloads.filter(hasStringDataField).map(toXml))\n    return results as TOut[]\n  }\n}\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport const XmlSchema = asSchema('network.xyo.xml', true)\nexport type XmlSchema = typeof XmlSchema\n","/**\n * Interface representing an object with a string data field\n */\nexport interface StringDataField {\n  /**\n   * The string data\n   */\n  data: string\n}\n\n/**\n * Identity for StringDataField\n * @param obj The input object\n * @returns True if the object is a StringDataField, false otherwise\n */\nexport const hasStringDataField = (obj?: unknown): obj is StringDataField => {\n  return typeof obj === 'object' && obj !== null && 'data' in obj && typeof (obj as StringDataField)?.data === 'string'\n}\n","import { Parser } from 'xml2js'\n\nimport type { Xml } from '../../Payload.ts'\nimport { XmlSchema } from '../../Schema.ts'\nimport type { StringDataField } from './StringDataField.ts'\n\n/**\n * Takes a string data field containing xml and converts it to an XML object\n * @param obj The input object which contains the stringified xml data\n * @returns A promise that resolves to an XML payload\n */\nexport const toXml = (obj: StringDataField): Promise<Xml> => {\n  const parser = new Parser()\n  return new Promise<Xml>((resolve, reject) => {\n    parser.parseString(obj.data, (err, result) => {\n      if (err) {\n        reject(err)\n      } else {\n        const xml = { schema: XmlSchema, xml: result } as const\n        resolve(xml)\n      }\n    })\n  })\n}\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport const XmlParsingDivinerConfigSchema = asSchema('network.xyo.diviner.xml.config', true)\nexport type XmlParsingDivinerConfigSchema = typeof XmlParsingDivinerConfigSchema\n","import type { JsonObject } from '@xylabs/sdk-js'\nimport type { Payload } from '@xyo-network/payload-model'\nimport { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'\n\nimport { XmlSchema } from './Schema.ts'\n\n/**\n * The fields of an Xml Payload\n */\nexport interface XmlFields {\n  xml: JsonObject\n}\n\n/**\n * An Xml Payload\n */\nexport type Xml = Payload<XmlFields, XmlSchema>\n\n/**\n * Identity function for determine if an object is an Xml Payload\n */\nexport const isXml = isPayloadOfSchemaType<Xml>(XmlSchema)\n\n/**\n * Identity function for determine if an object is an Xml Payload with sources\n */\nexport const isXmlWithSources = isPayloadOfSchemaTypeWithSources<Xml>(XmlSchema)\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA,SAAS,uBAAuB;AAEhC,SAAS,uBAAuB;;;ACFhC,SAAS,gBAAgB;AAElB,IAAM,YAAY,SAAS,mBAAmB,IAAI;;;ACalD,IAAM,qBAAqB,CAAC,QAA0C;AAC3E,SAAO,OAAO,QAAQ,YAAY,QAAQ,QAAQ,UAAU,OAAO,OAAQ,KAAyB,SAAS;AAC/G;;;ACjBA,SAAS,cAAc;AAWhB,IAAM,QAAQ,CAAC,QAAuC;AAC3D,QAAM,SAAS,IAAI,OAAO;AAC1B,SAAO,IAAI,QAAa,CAAC,SAAS,WAAW;AAC3C,WAAO,YAAY,IAAI,MAAM,CAAC,KAAK,WAAW;AAC5C,UAAI,KAAK;AACP,eAAO,GAAG;AAAA,MACZ,OAAO;AACL,cAAM,MAAM,EAAE,QAAQ,WAAW,KAAK,OAAO;AAC7C,gBAAQ,GAAG;AAAA,MACb;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACH;;;ACvBA,SAAS,YAAAA,iBAAgB;AAElB,IAAM,gCAAgCA,UAAS,kCAAkC,IAAI;;;AJYrF,IAAM,oBAAN,cASG,gBAAgD;AAAA,EAKxD,MAAyB,cAAc,WAAkB,CAAC,GAAoB;AAC5E,UAAM,UAAU,MAAM,QAAQ,IAAI,SAAS,OAAO,kBAAkB,EAAE,IAAI,KAAK,CAAC;AAChF,WAAO;AAAA,EACT;AACF;AARE,cAVW,mBAUc,iBAA0B,CAAC,GAAG,iDAAM,kBAAe,6BAA6B;AACzG,cAXW,mBAWc,uBAA8B;AACvD,cAZW,mBAYc,gBAAe;AAZ7B,oBAAN;AAAA,EADN,gBAAgB;AAAA,GACJ;;;AKZb,SAAS,uBAAuB,wCAAwC;AAmBjE,IAAM,QAAQ,sBAA2B,SAAS;AAKlD,IAAM,mBAAmB,iCAAsC,SAAS;","names":["asSchema"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/xml-plugin",
-  "version": "5.3.1",
+  "version": "5.3.3",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,29 +30,34 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
-    "!**/*.bench.*",
-    "!**/*.spec.*",
-    "!**/*.test.*"
+    "README.md"
   ],
-  "dependencies": {
-    "@xylabs/object": "~5.0.64",
-    "@xyo-network/diviner-abstract": "~5.3.2",
-    "@xyo-network/diviner-model": "~5.3.2",
-    "@xyo-network/module-model": "~5.3.2",
-    "@xyo-network/payload-model": "~5.3.2",
-    "xml2js": "~0.6.2"
-  },
   "devDependencies": {
     "@types/xml2js": "~0.4.14",
-    "@xylabs/assert": "~5.0.64",
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig": "~7.3.2",
-    "@xylabs/vitest-extended": "~5.0.64",
-    "@xylabs/vitest-matchers": "~5.0.64",
-    "@xyo-network/api-call-witness": "5.3.1",
+    "@xylabs/sdk-js": "^5.0.90",
+    "@xylabs/ts-scripts-common": "~7.5.10",
+    "@xylabs/ts-scripts-yarn3": "~7.5.10",
+    "@xylabs/tsconfig": "~7.5.10",
+    "@xylabs/vitest-extended": "~5.0.90",
+    "@xylabs/vitest-matchers": "~5.0.90",
+    "@xyo-network/api-call-witness": "5.3.3",
+    "@xyo-network/diviner-abstract": "~5.3.5",
+    "@xyo-network/diviner-model": "~5.3.5",
+    "@xyo-network/module-model": "~5.3.5",
+    "@xyo-network/payload-model": "~5.3.5",
     "typescript": "~5.9.3",
-    "vitest": "~4.0.18"
+    "vitest": "~4.1.2",
+    "xml2js": "~0.6.2",
+    "zod": "^4.3.6"
+  },
+  "peerDependencies": {
+    "@xylabs/sdk-js": "^5",
+    "@xyo-network/diviner-abstract": "^5",
+    "@xyo-network/diviner-model": "^5",
+    "@xyo-network/module-model": "^5",
+    "@xyo-network/payload-model": "^5",
+    "xml2js": "^0",
+    "zod": "^4"
   },
   "publishConfig": {
     "access": "public"

package/src/Diviner/Config.ts

@@ -1,10 +0,0 @@
-import type { DivinerConfig } from '@xyo-network/diviner-model'
-
-import type { XmlParsingDivinerConfigSchema } from './Schema.ts'
-
-export type XmlParsingDivinerConfig = DivinerConfig<
-  {
-    //
-  },
-  XmlParsingDivinerConfigSchema
->

package/src/Diviner/Diviner.ts

@@ -1,33 +0,0 @@
-import { AbstractDiviner } from '@xyo-network/diviner-abstract'
-import { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model'
-import { creatableModule } from '@xyo-network/module-model'
-import { Payload, Schema } from '@xyo-network/payload-model'
-
-import { Xml } from '../Payload.ts'
-import { XmlSchema } from '../Schema.ts'
-import {
-  hasStringDataField, StringDataField, toXml,
-} from './lib/index.ts'
-import { XmlParsingDivinerParams } from './Params.ts'
-import { XmlParsingDivinerConfigSchema } from './Schema.ts'
-
-@creatableModule()
-export class XmlParsingDiviner<
-  TParams extends XmlParsingDivinerParams = XmlParsingDivinerParams,
-  TIn extends Payload<StringDataField> = Payload<StringDataField>,
-  TOut extends Xml | Payload = Xml | Payload,
-  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<
-    DivinerInstance<TParams, TIn, TOut>,
-    TIn,
-    TOut
-  >,
-> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
-  static override readonly configSchemas: Schema[] = [...super.configSchemas, XmlParsingDivinerConfigSchema]
-  static override readonly defaultConfigSchema: Schema = XmlParsingDivinerConfigSchema
-  static override readonly targetSchema = XmlSchema
-
-  protected override async divineHandler(payloads: TIn[] = []): Promise<TOut[]> {
-    const results = await Promise.all(payloads.filter(hasStringDataField).map(toXml))
-    return results as TOut[]
-  }
-}

package/src/Diviner/Params.ts

@@ -1,7 +0,0 @@
-import type { DivinerParams } from '@xyo-network/diviner-model'
-import type { AnyConfigSchema } from '@xyo-network/module-model'
-
-import type { XmlParsingDivinerConfig } from './Config.ts'
-
-export type XmlParsingDivinerParams<TConfig extends AnyConfigSchema<XmlParsingDivinerConfig> = AnyConfigSchema<XmlParsingDivinerConfig>>
-  = DivinerParams<TConfig>

package/src/Diviner/Schema.ts

@@ -1,4 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-export const XmlParsingDivinerConfigSchema = asSchema('network.xyo.diviner.xml.config', true)
-export type XmlParsingDivinerConfigSchema = typeof XmlParsingDivinerConfigSchema

package/src/Diviner/index.ts

@@ -1,2 +0,0 @@
-export * from './Config.ts'
-export * from './Diviner.ts'

package/src/Diviner/lib/StringDataField.ts

@@ -1,18 +0,0 @@
-/**
- * Interface representing an object with a string data field
- */
-export interface StringDataField {
-  /**
-   * The string data
-   */
-  data: string
-}
-
-/**
- * Identity for StringDataField
- * @param obj The input object
- * @returns True if the object is a StringDataField, false otherwise
- */
-export const hasStringDataField = (obj?: unknown): obj is StringDataField => {
-  return typeof obj === 'object' && obj !== null && 'data' in obj && typeof (obj as StringDataField)?.data === 'string'
-}

package/src/Diviner/lib/index.ts

@@ -1,2 +0,0 @@
-export * from './StringDataField.ts'
-export * from './toXml.ts'

package/src/Diviner/lib/toXml.ts

@@ -1,24 +0,0 @@
-import { Parser } from 'xml2js'
-
-import type { Xml } from '../../Payload.ts'
-import { XmlSchema } from '../../Schema.ts'
-import type { StringDataField } from './StringDataField.ts'
-
-/**
- * Takes a string data field containing xml and converts it to an XML object
- * @param obj The input object which contains the stringified xml data
- * @returns A promise that resolves to an XML payload
- */
-export const toXml = (obj: StringDataField): Promise<Xml> => {
-  const parser = new Parser()
-  return new Promise<Xml>((resolve, reject) => {
-    parser.parseString(obj.data, (err, result) => {
-      if (err) {
-        reject(err)
-      } else {
-        const xml = { schema: XmlSchema, xml: result } as const
-        resolve(xml)
-      }
-    })
-  })
-}

package/src/Payload.ts

@@ -1,27 +0,0 @@
-import type { JsonObject } from '@xylabs/object'
-import type { Payload } from '@xyo-network/payload-model'
-import { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'
-
-import { XmlSchema } from './Schema.ts'
-
-/**
- * The fields of an Xml Payload
- */
-export interface XmlFields {
-  xml: JsonObject
-}
-
-/**
- * An Xml Payload
- */
-export type Xml = Payload<XmlFields, XmlSchema>
-
-/**
- * Identity function for determine if an object is an Xml Payload
- */
-export const isXml = isPayloadOfSchemaType<Xml>(XmlSchema)
-
-/**
- * Identity function for determine if an object is an Xml Payload with sources
- */
-export const isXmlWithSources = isPayloadOfSchemaTypeWithSources<Xml>(XmlSchema)

package/src/Schema.ts

@@ -1,4 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-export const XmlSchema = asSchema('network.xyo.xml', true)
-export type XmlSchema = typeof XmlSchema

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './Diviner/index.ts'
-export * from './Payload.ts'
-export * from './Schema.ts'