@xyo-network/payload-model 2.82.0 → 2.83.1

package/dist/node/isPayloadOfSchemaType.d.cts

@@ -1,8 +1,7 @@
-import { Payload } from './Payload';
 export declare const isPayloadOfSchemaType: <T extends {
     schema: string;
-}>(schema: string) => (x?: Payload | null) => x is T;
+} & import("./Payload").PayloadFields>(schema: string) => (x?: unknown | null) => x is T;
 export declare const notPayloadOfSchemaType: <T extends {
     schema: string;
-}>(schema: string) => (x?: Payload | null) => x is T;
+} & import("./Payload").PayloadFields>(schema: string) => (x?: unknown | null) => x is T;
 //# sourceMappingURL=isPayloadOfSchemaType.d.ts.map

package/dist/node/isPayloadOfSchemaType.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,eAAO,MAAM,qBAAqB;;WAA+B,MAAM,UACzD,OAAO,GAAG,IAAI,WAC3B,CAAA;AAED,eAAO,MAAM,sBAAsB;;WAA+B,MAAM,UAC1D,OAAO,GAAG,IAAI,WAC3B,CAAA"}
+{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,qBAAqB;;+CAA+B,MAAM,UACzD,OAAO,GAAG,IAAI,WAC3B,CAAA;AAED,eAAO,MAAM,sBAAsB;;+CAA+B,MAAM,UAC1D,OAAO,GAAG,IAAI,WAC3B,CAAA"}

package/dist/node/isPayloadOfSchemaType.d.mts

@@ -1,8 +1,7 @@
-import { Payload } from './Payload';
 export declare const isPayloadOfSchemaType: <T extends {
     schema: string;
-}>(schema: string) => (x?: Payload | null) => x is T;
+} & import("./Payload").PayloadFields>(schema: string) => (x?: unknown | null) => x is T;
 export declare const notPayloadOfSchemaType: <T extends {
     schema: string;
-}>(schema: string) => (x?: Payload | null) => x is T;
+} & import("./Payload").PayloadFields>(schema: string) => (x?: unknown | null) => x is T;
 //# sourceMappingURL=isPayloadOfSchemaType.d.ts.map

package/dist/node/isPayloadOfSchemaType.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,eAAO,MAAM,qBAAqB;;WAA+B,MAAM,UACzD,OAAO,GAAG,IAAI,WAC3B,CAAA;AAED,eAAO,MAAM,sBAAsB;;WAA+B,MAAM,UAC1D,OAAO,GAAG,IAAI,WAC3B,CAAA"}
+{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,qBAAqB;;+CAA+B,MAAM,UACzD,OAAO,GAAG,IAAI,WAC3B,CAAA;AAED,eAAO,MAAM,sBAAsB;;+CAA+B,MAAM,UAC1D,OAAO,GAAG,IAAI,WAC3B,CAAA"}

package/dist/node/isPayloadOfSchemaType.d.ts

@@ -1,8 +1,7 @@
-import { Payload } from './Payload';
 export declare const isPayloadOfSchemaType: <T extends {
     schema: string;
-}>(schema: string) => (x?: Payload | null) => x is T;
+} & import("./Payload").PayloadFields>(schema: string) => (x?: unknown | null) => x is T;
 export declare const notPayloadOfSchemaType: <T extends {
     schema: string;
-}>(schema: string) => (x?: Payload | null) => x is T;
+} & import("./Payload").PayloadFields>(schema: string) => (x?: unknown | null) => x is T;
 //# sourceMappingURL=isPayloadOfSchemaType.d.ts.map

package/dist/node/isPayloadOfSchemaType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,eAAO,MAAM,qBAAqB;;WAA+B,MAAM,UACzD,OAAO,GAAG,IAAI,WAC3B,CAAA;AAED,eAAO,MAAM,sBAAsB;;WAA+B,MAAM,UAC1D,OAAO,GAAG,IAAI,WAC3B,CAAA"}
+{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,qBAAqB;;+CAA+B,MAAM,UACzD,OAAO,GAAG,IAAI,WAC3B,CAAA;AAED,eAAO,MAAM,sBAAsB;;+CAA+B,MAAM,UAC1D,OAAO,GAAG,IAAI,WAC3B,CAAA"}

package/package.json

@@ -10,7 +10,7 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/object": "~2.82.0"
+    "@xyo-network/object": "~2.83.1"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^3.2.10",
@@ -57,5 +57,5 @@
   },
   "sideEffects": false,
   "types": "dist/node/index.d.ts",
-  "version": "2.82.0"
+  "version": "2.83.1"
 }

package/src/Payload.ts

@@ -1,24 +1,15 @@
-import { EmptyPayload } from './EmptyPayload'
+import { EmptyObject, JsonObject } from '@xyo-network/object'
 
-export type Schema = string
+import { Schema, WithSchema } from './Schema'
 
-export type WithTimestamp<T extends EmptyPayload = EmptyPayload> = T & { timestamp: number }
-
-export type PayloadSchema = 'network.xyo.payload'
-export const PayloadSchema: PayloadSchema = 'network.xyo.payload'
-
-export type SchemaFields = {
-  schema: Schema
+/** Additional fields for a payload */
+export interface PayloadFields extends EmptyObject {
+  $meta?: JsonObject
 }
 
-export type WithSchema<T extends EmptyPayload | void = void> = T extends EmptyPayload ? SchemaFields & T : SchemaFields
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type PayloadFields = {}
-
-export type WithPayload<T extends EmptyPayload | void = void> = WithSchema<T extends EmptyPayload ? PayloadFields & T : PayloadFields>
+export type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>
 
-export type Payload<T extends void | object | WithSchema = void, S extends Schema | void = void> = T extends WithSchema
+export type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema
   ? S extends Schema
     ? /* T (w/Schema) & S provided */
       WithPayload<Omit<T, 'schema'> & { schema: S } & PayloadFields>

package/src/Schema.ts

@@ -0,0 +1,24 @@
+import { AsTypeFactory, EmptyObject } from '@xyo-network/object'
+
+/** Schema type in Javascript is a string */
+export type Schema = string
+
+export const PayloadSchema = 'network.xyo.payload'
+export type PayloadSchema = typeof PayloadSchema
+
+export const isSchema = (value: unknown): value is Schema => {
+  if (typeof value === 'string') {
+    return true
+  }
+  return false
+}
+
+export const asSchema = AsTypeFactory.create<Schema>(isSchema)
+
+/** Schema fields for a Payload */
+export interface SchemaFields extends EmptyObject {
+  schema: Schema
+}
+
+/** Add the Schema Fields to an object */
+export type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields

package/src/Timestamp.ts

@@ -0,0 +1,9 @@
+import { AnyObject } from '@xyo-network/object'
+
+/** Object with a timestamp */
+export interface Timestamp {
+  timestamp: number
+}
+
+/** Add a timestamp field to any object */
+export type WithTimestamp<T extends AnyObject = AnyObject> = T & Timestamp

package/src/index.ts

@@ -1,4 +1,3 @@
-export * from './EmptyPayload'
 export * from './Error'
 export * from './isPayload'
 export * from './isPayloadOfSchemaType'
@@ -6,3 +5,4 @@ export * from './Payload'
 export * from './PayloadFindFilter'
 export * from './PayloadSet'
 export * from './Query'
+export * from './Schema'

package/src/isPayload.ts

@@ -3,20 +3,22 @@ import { AsObjectFactory, isObject } from '@xyo-network/object'
 
 import { Payload } from './Payload'
 
-export const isAnyPayload = (obj: any): obj is Payload => {
-  if (isObject(obj)) {
-    return typeof obj.schema === 'string'
+export const isAnyPayload = (value: unknown): value is Payload => {
+  if (isObject(value)) {
+    return typeof value.schema === 'string'
   }
   return false
 }
 
+export const asAnyPayload = AsObjectFactory.create(isAnyPayload)
+
 export const isPayload =
   <T extends Payload>(schema: string[]) =>
-  (obj: any): obj is T => {
-    if (isAnyPayload(obj)) {
-      return schema.includes(obj.schema)
+  (value: unknown): value is T => {
+    if (isAnyPayload(value)) {
+      return schema.includes(value.schema)
     }
     return false
   }
 
-export const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((obj: any): obj is T => isPayload(schema)(obj))
+export const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((value: unknown): value is T => isPayload(schema)(value))

package/src/isPayloadOfSchemaType.ts

@@ -1,9 +1,10 @@
+import { isAnyPayload } from './isPayload'
 import { Payload } from './Payload'
 
 export const isPayloadOfSchemaType = <T extends Payload>(schema: string) => {
-  return (x?: Payload | null): x is T => x?.schema === schema
+  return (x?: unknown | null): x is T => isAnyPayload(x) && x?.schema === schema
 }
 
 export const notPayloadOfSchemaType = <T extends Payload>(schema: string) => {
-  return (x?: Payload | null): x is T => x?.schema !== schema
+  return (x?: unknown | null): x is T => !isAnyPayload(x) || x?.schema !== schema
 }

package/dist/browser/EmptyPayload.d.cts

@@ -1,2 +0,0 @@
-export type EmptyPayload = {};
-//# sourceMappingURL=EmptyPayload.d.ts.map

package/dist/browser/EmptyPayload.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EmptyPayload.d.ts","sourceRoot":"","sources":["../../src/EmptyPayload.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,YAAY,GAAG,EAAE,CAAA"}

package/dist/browser/EmptyPayload.d.mts

@@ -1,2 +0,0 @@
-export type EmptyPayload = {};
-//# sourceMappingURL=EmptyPayload.d.ts.map

package/dist/browser/EmptyPayload.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EmptyPayload.d.ts","sourceRoot":"","sources":["../../src/EmptyPayload.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,YAAY,GAAG,EAAE,CAAA"}

package/dist/browser/EmptyPayload.d.ts

@@ -1,2 +0,0 @@
-export type EmptyPayload = {};
-//# sourceMappingURL=EmptyPayload.d.ts.map

package/dist/browser/EmptyPayload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EmptyPayload.d.ts","sourceRoot":"","sources":["../../src/EmptyPayload.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,YAAY,GAAG,EAAE,CAAA"}

package/dist/node/EmptyPayload.d.cts

@@ -1,2 +0,0 @@
-export type EmptyPayload = {};
-//# sourceMappingURL=EmptyPayload.d.ts.map

package/dist/node/EmptyPayload.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EmptyPayload.d.ts","sourceRoot":"","sources":["../../src/EmptyPayload.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,YAAY,GAAG,EAAE,CAAA"}

package/dist/node/EmptyPayload.d.mts

@@ -1,2 +0,0 @@
-export type EmptyPayload = {};
-//# sourceMappingURL=EmptyPayload.d.ts.map

package/dist/node/EmptyPayload.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EmptyPayload.d.ts","sourceRoot":"","sources":["../../src/EmptyPayload.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,YAAY,GAAG,EAAE,CAAA"}

package/dist/node/EmptyPayload.d.ts

@@ -1,2 +0,0 @@
-export type EmptyPayload = {};
-//# sourceMappingURL=EmptyPayload.d.ts.map

package/dist/node/EmptyPayload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EmptyPayload.d.ts","sourceRoot":"","sources":["../../src/EmptyPayload.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,YAAY,GAAG,EAAE,CAAA"}

package/src/EmptyPayload.ts

@@ -1,2 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type EmptyPayload = {}