@xyo-network/payload-model 2.73.3 → 2.74.0

package/dist/isPayloadOfSchemaType.d.ts

@@ -0,0 +1,5 @@
+import { Payload } from './Payload';
+export declare const isPayloadOfSchemaType: <T extends {
+    schema: string;
+}>(schema: string) => (x: Payload) => x is T;
+//# sourceMappingURL=isPayloadOfSchemaType.d.ts.map

package/dist/isPayloadOfSchemaType.d.ts.map

@@ -0,0 +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,SAC1D,OAAO,WACnB,CAAA"}

package/package.json

@@ -9,11 +9,12 @@
     "email": "support@xyo.network",
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
+  "dependencies": {
+    "@xyo-network/object": "^2.74.0"
+  },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^2.19.5",
-    "@xylabs/tsconfig": "^2.19.5",
-    "publint": "^0.2.2",
-    "tsup": "^7.2.0",
+    "@xylabs/ts-scripts-yarn3": "^3.0.27",
+    "@xylabs/tsconfig": "^3.0.27",
     "typescript": "^5.2.2"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -54,11 +55,7 @@
     "type": "git",
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
-  "scripts": {
-    "package-compile": "tsup && publint",
-    "package-recompile": "tsup && publint"
-  },
   "sideEffects": false,
   "types": "dist/index.d.ts",
-  "version": "2.73.3"
+  "version": "2.74.0"
 }

package/src/Payload.ts

@@ -1,12 +1,14 @@
 import { EmptyPayload } from './EmptyPayload'
 
+export type Schema = string
+
 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: string
+  schema: Schema
 }
 
 export type WithSchema<T extends EmptyPayload | void = void> = T extends EmptyPayload ? SchemaFields & T : SchemaFields
@@ -17,7 +19,19 @@ export type PayloadFields = {
 
 export type WithPayload<T extends EmptyPayload | void = void> = WithSchema<T extends EmptyPayload ? PayloadFields & T : PayloadFields>
 
-export type Payload<
-  T extends void | EmptyPayload | WithSchema = void,
-  S extends string = T extends WithSchema ? T['schema'] : string,
-> = T extends EmptyPayload ? /* Type sent is an Object */ WithPayload<T & { schema: S }> : /* Type sent is void */ WithPayload<{ schema: S }>
+export type Payload<T extends void | object | WithSchema = void, S extends Schema | void = void> = T extends WithSchema
+  ? S extends Schema
+    ? /* T (w/Schema) & S provided */
+      WithPayload<Omit<T, 'schema'> & { schema: S }>
+    : /* Only T (w/Schema) provided */
+      WithPayload<T>
+  : T extends object
+  ? S extends Schema
+    ? /* T (w/o Schema) & S provided */
+      WithPayload<T & { schema: S }>
+    : /* Only T (w/o Schema) provided */
+      WithPayload<T & { schema: Schema }>
+  : /* Either just S or neither S or T provided */
+    {
+      schema: S extends Schema ? S : Schema
+    }

package/src/PayloadFindFilter.ts

@@ -7,7 +7,6 @@ export interface PayloadFindFilterHashOffset {
   offset?: string
 }
 
-// eslint-disable-next-line deprecation/deprecation
 export type PayloadFindFilterOffset = PayloadFindFilterTimeOffset | PayloadFindFilterHashOffset
 
 export type PayloadFindFilter = {

package/src/index.ts

@@ -1,6 +1,6 @@
 export * from './EmptyPayload'
 export * from './Error'
-export * from './identity'
+export * from './isPayload'
 export * from './isPayloadOfSchemaType'
 export * from './Payload'
 export * from './PayloadFindFilter'

package/src/isPayload.ts

@@ -0,0 +1,22 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+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'
+  }
+  return false
+}
+
+export const isPayload =
+  <T extends Payload>(schema: string[]) =>
+  (obj: any): obj is T => {
+    if (isAnyPayload(obj)) {
+      return schema.includes(obj.schema)
+    }
+    return false
+  }
+
+export const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((obj: any): obj is T => isPayload(schema)(obj))