@xyo-network/xml-plugin 3.1.2 → 3.2.0-rc.2

package/dist/neutral/Payload.d.ts

@@ -14,19 +14,19 @@ export type Xml = Payload<XmlFields, XmlSchema>;
 /**
  * Identity function for determine if an object is an Xml Payload
  */
-export declare const isXml: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & XmlFields & {
-    schema: "network.xyo.xml";
-};
-/**
- * Identity function for determine if an object is an Xml Payload with sources
- */
-export declare const isXmlWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & XmlFields & {
+export declare const isXml: (x?: unknown | null) => x is import("@xylabs/object").DeepRestrictToStringKeys<{
     schema: "network.xyo.xml";
+    xml: {
+        [x: string]: string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null;
+    };
 }>;
 /**
- * Identity function for determine if an object is an Xml Payload with meta
+ * Identity function for determine if an object is an Xml Payload with sources
  */
-export declare const isXmlWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & XmlFields & {
+export declare const isXmlWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xylabs/object").DeepRestrictToStringKeys<{
     schema: "network.xyo.xml";
-}>;
+    xml: {
+        [x: string]: string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | (string | number | boolean | /*elided*/ any | /*elided*/ any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null;
+    };
+}>>;
 //# sourceMappingURL=Payload.d.ts.map

package/dist/neutral/Payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,UAAU,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,KAAK;;CAAwC,CAAA;AAE1D;;GAEG;AACH,eAAO,MAAM,gBAAgB;;EAAmD,CAAA;AAEhF;;GAEG;AACH,eAAO,MAAM,aAAa;;EAAgD,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,UAAU,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,KAAK;;;;;EAAwC,CAAA;AAE1D;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;GAAmD,CAAA"}

package/dist/neutral/index.mjs

@@ -60,19 +60,13 @@ XmlParsingDiviner = __decorateClass([
 ], XmlParsingDiviner);
 
 // src/Payload.ts
-import {
-  isPayloadOfSchemaType,
-  isPayloadOfSchemaTypeWithMeta,
-  isPayloadOfSchemaTypeWithSources
-} from "@xyo-network/payload-model";
+import { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithSources } from "@xyo-network/payload-model";
 var isXml = isPayloadOfSchemaType(XmlSchema);
 var isXmlWithSources = isPayloadOfSchemaTypeWithSources(XmlSchema);
-var isXmlWithMeta = isPayloadOfSchemaTypeWithMeta(XmlSchema);
 export {
   XmlParsingDiviner,
   XmlSchema,
   isXml,
-  isXmlWithMeta,
   isXmlWithSources
 };
 //# sourceMappingURL=index.mjs.map

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 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","export const XmlSchema = 'network.xyo.xml'\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","export const XmlParsingDivinerConfigSchema = 'network.xyo.diviner.xml.config' as const\nexport type XmlParsingDivinerConfigSchema = typeof XmlParsingDivinerConfigSchema\n","import type { JsonObject } from '@xylabs/object'\nimport type { Payload } from '@xyo-network/payload-model'\nimport {\n  isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources,\n} 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\n/**\n * Identity function for determine if an object is an Xml Payload with meta\n */\nexport const isXmlWithMeta = isPayloadOfSchemaTypeWithMeta<Xml>(XmlSchema)\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA,SAAS,uBAAuB;AAEhC,SAAS,uBAAuB;;;ACFzB,IAAM,YAAY;;;ACelB,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;;;ACvBO,IAAM,gCAAgC;;;AJctC,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,mBAYK,gBAAe;AAZpB,oBAAN;AAAA,EADN,gBAAgB;AAAA,GACJ;;;AKZb;AAAA,EACE;AAAA,EAAuB;AAAA,EAA+B;AAAA,OACjD;AAmBA,IAAM,QAAQ,sBAA2B,SAAS;AAKlD,IAAM,mBAAmB,iCAAsC,SAAS;AAKxE,IAAM,gBAAgB,8BAAmC,SAAS;","names":[]}
+{"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 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","export const XmlSchema = 'network.xyo.xml'\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","export const XmlParsingDivinerConfigSchema = 'network.xyo.diviner.xml.config' as const\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;;;ACFzB,IAAM,YAAY;;;ACelB,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;;;ACvBO,IAAM,gCAAgC;;;AJctC,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,mBAYK,gBAAe;AAZpB,oBAAN;AAAA,EADN,gBAAgB;AAAA,GACJ;;;AKZb,SAAS,uBAAuB,wCAAwC;AAmBjE,IAAM,QAAQ,sBAA2B,SAAS;AAKlD,IAAM,mBAAmB,iCAAsC,SAAS;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/xml-plugin",
-  "version": "3.1.2",
+  "version": "3.2.0-rc.2",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,24 +29,25 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/object": "^4.4.9",
-    "@xyo-network/diviner-abstract": "^3.5.1",
-    "@xyo-network/diviner-model": "^3.5.1",
-    "@xyo-network/module-model": "^3.5.1",
-    "@xyo-network/payload-model": "^3.5.1",
+    "@xylabs/object": "^4.4.24",
+    "@xyo-network/diviner-abstract": "^3.6.0-rc.11",
+    "@xyo-network/diviner-model": "^3.6.0-rc.11",
+    "@xyo-network/module-model": "^3.6.0-rc.11",
+    "@xyo-network/payload-model": "^3.6.0-rc.11",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
     "@types/xml2js": "^0.4.14",
-    "@xylabs/assert": "^4.4.9",
-    "@xylabs/ts-scripts-yarn3": "^4.2.4",
-    "@xylabs/tsconfig": "^4.2.4",
-    "@xylabs/vitest-extended": "^4.4.9",
-    "@xyo-network/api-call-witness": "^3.1.2",
+    "@xylabs/assert": "^4.4.24",
+    "@xylabs/ts-scripts-yarn3": "^4.2.6",
+    "@xylabs/tsconfig": "^4.2.6",
+    "@xylabs/vitest-extended": "^4.4.24",
+    "@xyo-network/api-call-witness": "^3.2.0-rc.2",
     "typescript": "^5.7.2",
-    "vitest": "^2.1.6"
+    "vitest": "^2.1.8"
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "stableVersion": "3.1.2"
 }

package/src/Payload.ts

@@ -1,8 +1,6 @@
 import type { JsonObject } from '@xylabs/object'
 import type { Payload } from '@xyo-network/payload-model'
-import {
-  isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources,
-} from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'
 
 import { XmlSchema } from './Schema.ts'
 
@@ -27,8 +25,3 @@ 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)
-
-/**
- * Identity function for determine if an object is an Xml Payload with meta
- */
-export const isXmlWithMeta = isPayloadOfSchemaTypeWithMeta<Xml>(XmlSchema)

package/xy.config.ts

@@ -7,5 +7,4 @@ const config: XyTsupConfig = {
   },
 }
 
-// eslint-disable-next-line import-x/no-default-export
 export default config