@xyo-network/xml-plugin 3.1.1 → 3.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/neutral/Diviner/Schema.d.ts.map +1 -1
  2. package/dist/neutral/Diviner/lib/StringDataField.d.ts +11 -0
  3. package/dist/neutral/Diviner/lib/StringDataField.d.ts.map +1 -1
  4. package/dist/neutral/Diviner/lib/toXml.d.ts +5 -0
  5. package/dist/neutral/Diviner/lib/toXml.d.ts.map +1 -1
  6. package/dist/neutral/Payload.d.ts +15 -0
  7. package/dist/neutral/Payload.d.ts.map +1 -1
  8. package/package.json +13 -13
package/dist/neutral/Diviner/Schema.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/Diviner/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,kCAA4C,CAAA;AACtF,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAA"}
1
+ {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/Diviner/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,EAAG,gCAAyC,CAAA;AACtF,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAA"}
package/dist/neutral/Diviner/lib/StringDataField.d.ts CHANGED
@@ -1,5 +1,16 @@
1
+ /**
2
+ * Interface representing an object with a string data field
3
+ */
1
4
  export interface StringDataField {
5
+ /**
6
+ * The string data
7
+ */
2
8
  data: string;
3
9
  }
10
+ /**
11
+ * Identity for StringDataField
12
+ * @param obj The input object
13
+ * @returns True if the object is a StringDataField, false otherwise
14
+ */
4
15
  export declare const hasStringDataField: (obj?: unknown) => obj is StringDataField;
5
16
  //# sourceMappingURL=StringDataField.d.ts.map
package/dist/neutral/Diviner/lib/StringDataField.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"StringDataField.d.ts","sourceRoot":"","sources":["../../../../src/Diviner/lib/StringDataField.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,eAAe;IAI9B,IAAI,EAAE,MAAM,CAAA;CACb;AAOD,eAAO,MAAM,kBAAkB,SAAU,OAAO,KAAG,GAAG,IAAI,eAEzD,CAAA"}
1
+ {"version":3,"file":"StringDataField.d.ts","sourceRoot":"","sources":["../../../../src/Diviner/lib/StringDataField.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,SAAU,OAAO,KAAG,GAAG,IAAI,eAEzD,CAAA"}
package/dist/neutral/Diviner/lib/toXml.d.ts CHANGED
@@ -1,4 +1,9 @@
1
1
  import type { Xml } from '../../Payload.ts';
2
2
  import type { StringDataField } from './StringDataField.ts';
3
+ /**
4
+ * Takes a string data field containing xml and converts it to an XML object
5
+ * @param obj The input object which contains the stringified xml data
6
+ * @returns A promise that resolves to an XML payload
7
+ */
3
8
  export declare const toXml: (obj: StringDataField) => Promise<Xml>;
4
9
  //# sourceMappingURL=toXml.d.ts.map
package/dist/neutral/Diviner/lib/toXml.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"toXml.d.ts","sourceRoot":"","sources":["../../../../src/Diviner/lib/toXml.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAE3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAO3D,eAAO,MAAM,KAAK,QAAS,eAAe,KAAG,OAAO,CAAC,GAAG,CAYvD,CAAA"}
1
+ {"version":3,"file":"toXml.d.ts","sourceRoot":"","sources":["../../../../src/Diviner/lib/toXml.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAE3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D;;;;GAIG;AACH,eAAO,MAAM,KAAK,QAAS,eAAe,KAAG,OAAO,CAAC,GAAG,CAYvD,CAAA"}
package/dist/neutral/Payload.d.ts CHANGED
@@ -1,16 +1,31 @@
1
1
  import type { JsonObject } from '@xylabs/object';
2
2
  import type { Payload } from '@xyo-network/payload-model';
3
3
  import { XmlSchema } from './Schema.ts';
4
+ /**
5
+ * The fields of an Xml Payload
6
+ */
4
7
  export interface XmlFields {
5
8
  xml: JsonObject;
6
9
  }
10
+ /**
11
+ * An Xml Payload
12
+ */
7
13
  export type Xml = Payload<XmlFields, XmlSchema>;
14
+ /**
15
+ * Identity function for determine if an object is an Xml Payload
16
+ */
8
17
  export declare const isXml: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & XmlFields & {
9
18
  schema: "network.xyo.xml";
10
19
  };
20
+ /**
21
+ * Identity function for determine if an object is an Xml Payload with sources
22
+ */
11
23
  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 & {
12
24
  schema: "network.xyo.xml";
13
25
  }>;
26
+ /**
27
+ * Identity function for determine if an object is an Xml Payload with meta
28
+ */
14
29
  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 & {
15
30
  schema: "network.xyo.xml";
16
31
  }>;
package/dist/neutral/Payload.d.ts.map CHANGED
@@ -1 +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;AAKvC,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,UAAU,CAAA;CAChB;AAKD,MAAM,MAAM,GAAG,GAAG,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;AAK/C,eAAO,MAAM,KAAK;;CAAwC,CAAA;AAK1D,eAAO,MAAM,gBAAgB;;EAAmD,CAAA;AAKhF,eAAO,MAAM,aAAa;;EAAgD,CAAA"}
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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/xml-plugin",
3
- "version": "3.1.1",
3
+ "version": "3.1.2",
4
4
  "description": "Typescript/Javascript Plugins for XYO Platform",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,22 +29,22 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/object": "^4.1.0",
33
- "@xyo-network/diviner-abstract": "^3.2.0",
34
- "@xyo-network/diviner-model": "^3.2.0",
35
- "@xyo-network/module-model": "^3.2.0",
36
- "@xyo-network/payload-model": "^3.2.0",
32
+ "@xylabs/object": "^4.4.9",
33
+ "@xyo-network/diviner-abstract": "^3.5.1",
34
+ "@xyo-network/diviner-model": "^3.5.1",
35
+ "@xyo-network/module-model": "^3.5.1",
36
+ "@xyo-network/payload-model": "^3.5.1",
37
37
  "xml2js": "^0.6.2"
38
38
  },
39
39
  "devDependencies": {
40
40
  "@types/xml2js": "^0.4.14",
41
- "@xylabs/assert": "^4.1.0",
42
- "@xylabs/jest-helpers": "^4.1.0",
43
- "@xylabs/ts-scripts-yarn3": "^4.1.0",
44
- "@xylabs/tsconfig": "^4.1.0",
45
- "@xyo-network/api-call-witness": "^3.1.1",
46
- "jest": "^29.7.0",
47
- "typescript": "^5.6.3"
41
+ "@xylabs/assert": "^4.4.9",
42
+ "@xylabs/ts-scripts-yarn3": "^4.2.4",
43
+ "@xylabs/tsconfig": "^4.2.4",
44
+ "@xylabs/vitest-extended": "^4.4.9",
45
+ "@xyo-network/api-call-witness": "^3.1.2",
46
+ "typescript": "^5.7.2",
47
+ "vitest": "^2.1.6"
48
48
  },
49
49
  "publishConfig": {
50
50
  "access": "public"