@xyo-network/payload-model 3.0.6 → 3.0.8

package/dist/node/index.d.ts

@@ -1,126 +1,13 @@
-import { Hash, Address } from '@xylabs/hex';
-import * as _xylabs_object from '@xylabs/object';
-import { EmptyObject, JsonObject, JsonValue } from '@xylabs/object';
-import * as _store__xylabs_promise_npm_4_0_2_e41c5d98a1_package from '.store/@xylabs-promise-npm-4.0.2-e41c5d98a1/package';
-
-type Schema = string;
-declare const PayloadSchema: "network.xyo.payload";
-type PayloadSchema = typeof PayloadSchema;
-declare const isSchema: (value: unknown) => value is Schema;
-declare const asSchema: {
-    <TType extends string>(value: _store__xylabs_promise_npm_4_0_2_e41c5d98a1_package.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
-    <TType extends string>(value: _store__xylabs_promise_npm_4_0_2_e41c5d98a1_package.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<string>, config?: _xylabs_object.TypeCheckConfig): TType;
-};
-interface SchemaFields extends EmptyObject {
-    schema: Schema;
-}
-type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields;
-
-interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
-    $hash: Hash;
-    $meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
-}
-interface PayloadFields extends EmptyObject {
-    schema: Schema;
-}
-type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>;
-type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema ? S extends Schema ? WithPayload<Omit<T, 'schema'> & {
-    schema: S;
-} & PayloadFields> : WithPayload<T> : T extends object ? S extends Schema ? WithPayload<T & {
-    schema: S;
-} & PayloadFields> : WithPayload<T & {
-    schema: Schema;
-} & PayloadFields> : {
-    schema: S extends Schema ? S : Schema;
-} & PayloadFields;
-type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
-    schema: string;
-};
-type WithSources<T extends EmptyObject> = T & {
-    sources?: Hash[];
-};
-type PayloadWithSources<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithSources<Payload<T, S>>;
-type WithAnySchema<T extends Payload> = Omit<T, 'schema'> & {
-    schema: string;
-};
-
-type ModuleErrorSchema = 'network.xyo.error.module';
-declare const ModuleErrorSchema: ModuleErrorSchema;
-type ModuleError = Payload<{
-    details?: JsonValue;
-    message?: string;
-    name?: string;
-    query?: Hash;
-    schema: ModuleErrorSchema;
-    sources?: Hash[];
-}>;
-declare const isModuleError: (x?: unknown | null) => x is SchemaFields & PayloadFields & {
-    details?: JsonValue;
-    message?: string;
-    name?: string;
-    query?: Hash;
-    schema: ModuleErrorSchema;
-    sources?: Hash[];
-};
-
-declare const isAnyPayload: (value: unknown) => value is Payload;
-declare const asAnyPayload: {
-    <TType extends {
-        schema: string;
-    } & PayloadFields>(value: _store__xylabs_promise_npm_4_0_2_e41c5d98a1_package.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
-    <TType extends {
-        schema: string;
-    } & PayloadFields>(value: _store__xylabs_promise_npm_4_0_2_e41c5d98a1_package.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<{
-        schema: string;
-    } & PayloadFields>, config?: _xylabs_object.TypeCheckConfig): TType;
-};
-declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
-declare const asPayload: <T extends Payload>(schema: string[]) => {
-    <TType extends T>(value: _store__xylabs_promise_npm_4_0_2_e41c5d98a1_package.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
-    <TType extends T>(value: _store__xylabs_promise_npm_4_0_2_e41c5d98a1_package.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<T>, config?: _xylabs_object.TypeCheckConfig): TType;
-};
-
-type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = PayloadMetaFields<M> & T;
-type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
-type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
-declare const unMeta: <T extends WithMeta<Payload>>(payload?: T) => T | undefined;
-
-declare const isPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
-declare const isPayloadOfSchemaTypeWithMeta: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithMeta<T>;
-declare const isPayloadOfSchemaTypeWithSources: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithSources<T>;
-declare const notPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
-
-declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
-declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
-
-interface PayloadFindFilter {
-    limit?: number;
-    offset?: Hash;
-    order?: 'desc' | 'asc';
-    schema?: string | string[];
-}
-
-type PayloadSetSchema = 'network.xyo.payload.set';
-declare const PayloadSetSchema: PayloadSetSchema;
-
-interface PayloadSet {
-    optional?: Record<string, number>;
-    required?: Record<string, number>;
-}
-type PayloadSetPayload = Payload<PayloadSet, PayloadSetSchema>;
-
-type PayloadValidationFunction<T extends Payload = Payload> = (payload: T) => boolean | Promise<boolean>;
-
-type PayloadProperty<T extends Payload = Payload> = keyof T;
-type PayloadValue<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
-type PayloadValueExpression<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>, TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
-
-interface QueryFields {
-    address?: Address | Address[];
-    budget?: number;
-    maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
-    minBid?: number;
-}
-type Query<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = Payload<T extends void ? QueryFields : T & QueryFields, S extends void ? T extends WithSchema ? T['schema'] : T extends void ? string : void : S>;
-
-export { type ModuleError, ModuleErrorSchema, type OverridablePayload, type Payload, type PayloadFields, type PayloadFindFilter, type PayloadMetaFields, type PayloadProperty, PayloadSchema, type PayloadSet, type PayloadSetPayload, PayloadSetSchema, type PayloadValidationFunction, type PayloadValue, type PayloadValueExpression, type PayloadWithMeta, type PayloadWithSources, type Query, type QueryFields, type Schema, type SchemaFields, type WithAnySchema, type WithMeta, type WithOptionalMeta, type WithPayload, type WithSchema, type WithSources, asAnyPayload, asPayload, asSchema, isAnyPayload, isModuleError, isPayload, isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources, isPayloadWithHash, isSchema, isWithHash, notPayloadOfSchemaType, unMeta };
+export * from './Error.ts';
+export * from './isPayload.ts';
+export * from './isPayloadOfSchemaType.ts';
+export * from './isPayloadWithHash.ts';
+export * from './Meta.ts';
+export * from './Payload.ts';
+export * from './PayloadFindFilter.ts';
+export * from './PayloadSet/index.ts';
+export * from './PayloadValidationFunction.ts';
+export * from './PayloadValueExpression.ts';
+export * from './Query.ts';
+export * from './Schema.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAC5B,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}

package/dist/node/index.mjs

@@ -44,7 +44,12 @@ var isPayloadWithHash = (value) => {
 // src/Meta.ts
 var unMeta = (payload) => {
   if (payload) {
-    const { $meta, $hash, ...result } = payload;
+    const {
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      $meta,
+      $hash,
+      ...result
+    } = payload;
     return result;
   }
 };

package/dist/node/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Meta.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["import { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport type { Payload } from './Payload.ts'\n\nexport const isAnyPayload = (value: unknown): value is Payload => {\n  if (isObject(value)) {\n    return typeof value.schema === 'string'\n  }\n  return false\n}\n\nexport const asAnyPayload = AsObjectFactory.create(isAnyPayload)\n\nexport const isPayload\n  = <T extends Payload>(schema: string[]) =>\n    (value: unknown): value is T => {\n      if (isAnyPayload(value)) {\n        return schema.includes(value.schema)\n      }\n      return false\n    }\n\nexport const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((value: unknown): value is T => isPayload(schema)(value))\n","import { isAnyPayload } from './isPayload.ts'\nimport type { WithMeta } from './Meta.ts'\nimport type { Payload, WithSources } from './Payload.ts'\n\nexport const isPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is T => isAnyPayload(x) && x?.schema === schema\n}\n\nexport const isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined\n}\n\nexport const isPayloadOfSchemaTypeWithSources = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is WithSources<T> =>\n    isPayloadOfSchemaType<WithSources<T>>(schema)(x) && x.sources !== undefined && Array.isArray(x.sources)\n}\n\nexport const notPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is T => !isAnyPayload(x) || x?.schema !== schema\n}\n\n// test types -- keep for future validation, but comment out\n\n/*\ntype TestSchema = 'network.xyo.test'\nconst TestSchema: TestSchema = 'network.xyo.test'\n\ntype Test = Payload<{ field: string }, TestSchema>\n\nconst testPayload: Test = { field: 'test', schema: TestSchema }\nconst testWithMeta: WithMeta<Test> = { $hash: '1234abcd', $meta: { timestamp: Date.now() }, field: 'test', schema: TestSchema }\n\nconst testPayloads: Payload[] = [testPayload]\nconst testMetaPayloads: WithMeta<Payload>[] = [testWithMeta]\n\nconst testType: Test = testWithMeta\n\nconst isTest: Test[] = testPayloads.filter(isPayloadOfSchemaType(TestSchema))\nconst isTestFromMeta: Payload[] = testMetaPayloads.filter(isPayloadOfSchemaType(TestSchema))\nconst isTestFromMetaWithMeta: PayloadWithMeta[] = testMetaPayloads.filter(isPayloadOfSchemaType(TestSchema))\n\nconst isTestFromMetaTyped = testMetaPayloads.filter(isPayloadOfSchemaType<Test>(TestSchema))\n\nconst isTestFromMetaTypedWithMeta: WithMeta<Test>[] = testMetaPayloads.filter(isPayloadOfSchemaType(TestSchema))\n\nconst isTestWithMeta: WithMeta<Test>[] = testPayloads.filter(isPayloadOfSchemaTypeWithMeta(TestSchema))\nconst isTestWithMetaFromMeta: WithMeta<Test>[] = testMetaPayloads.filter(isPayloadOfSchemaTypeWithMeta(TestSchema))\n*/\n","import type { Hash } from '@xylabs/hex'\nimport type { JsonValue } from '@xylabs/object'\n\nimport { isPayloadOfSchemaType } from './isPayloadOfSchemaType.ts'\nimport type { Payload } from './Payload.ts'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n  details?: JsonValue\n  message?: string\n  name?: string\n  query?: Hash\n  schema: ModuleErrorSchema\n  sources?: Hash[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload.ts'\nimport type { WithMeta } from './Meta.ts'\nimport type { Payload } from './Payload.ts'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n  return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n  return isAnyPayload(value) && isWithHash(value)\n}\n","import type { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport type { Payload, PayloadMetaFields } from './Payload.ts'\nimport type { Schema, WithSchema } from './Schema.ts'\n\nexport type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = PayloadMetaFields<M> & T\nexport type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> &\n  Omit<WithMeta<T, M>, '$hash'>\n\nexport type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>\n\nexport const unMeta = <T extends WithMeta<Payload>>(payload?: T): T | undefined => {\n  if (payload) {\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { $meta, $hash, ...result } = payload\n    return result as T\n  }\n}\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import type { EmptyObject } from '@xylabs/object'\nimport { AsTypeFactory } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload' as const\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n  return typeof value === 'string'\n}\n\nexport const asSchema = AsTypeFactory.create<Schema>(isSchema)\n\n/** Schema fields for a Payload */\nexport interface SchemaFields extends EmptyObject {\n  /**  Schema of the object */\n  schema: Schema\n}\n\n/** Add the Schema Fields to an object */\nexport type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields\n"],"mappings":";AAAA,SAAS,iBAAiB,gBAAgB;AAInC,IAAM,eAAe,CAAC,UAAqC;AAChE,MAAI,SAAS,KAAK,GAAG;AACnB,WAAO,OAAO,MAAM,WAAW;AAAA,EACjC;AACA,SAAO;AACT;AAEO,IAAM,eAAe,gBAAgB,OAAO,YAAY;AAExD,IAAM,YACT,CAAoB,WACpB,CAAC,UAA+B;AAC9B,MAAI,aAAa,KAAK,GAAG;AACvB,WAAO,OAAO,SAAS,MAAM,MAAM;AAAA,EACrC;AACA,SAAO;AACT;AAEG,IAAM,YAAY,CAAoB,WAAqB,gBAAgB,OAAO,CAAC,UAA+B,UAAU,MAAM,EAAE,KAAK,CAAC;;;AClB1I,IAAM,wBAAwB,CAAoB,WAAmB;AAC1E,SAAO,CAAC,MAA+B,aAAa,CAAC,KAAK,GAAG,WAAW;AAC1E;AAEO,IAAM,gCAAgC,CAAoB,WAAmB;AAClF,SAAO,CAAC,MAAyC,sBAAmC,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU;AAChH;AAEO,IAAM,mCAAmC,CAAoB,WAAmB;AACrF,SAAO,CAAC,MACN,sBAAsC,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,UAAa,MAAM,QAAQ,EAAE,OAAO;AAC1G;AAEO,IAAM,yBAAyB,CAAoB,WAAmB;AAC3E,SAAO,CAAC,MAA+B,CAAC,aAAa,CAAC,KAAK,GAAG,WAAW;AAC3E;;;ACZO,IAAM,oBAAuC;AAW7C,IAAM,gBAAgB,sBAAmC,iBAAiB;;;ACT1E,IAAM,aAAa,CAAoB,UAAmC;AAC/E,SAAO,OAAQ,OAAuB,UAAU;AAClD;AAOO,IAAM,oBAAoB,CAAoB,UAAyC;AAC5F,SAAO,aAAa,KAAK,KAAK,WAAW,KAAK;AAChD;;;ACTO,IAAM,SAAS,CAA8B,YAA+B;AACjF,MAAI,SAAS;AAEX,UAAM,EAAE,OAAO,OAAO,GAAG,OAAO,IAAI;AACpC,WAAO;AAAA,EACT;AACF;;;AChBO,IAAM,mBAAqC;;;ACAlD,SAAS,qBAAqB;AAKvB,IAAM,gBAAgB;AAGtB,IAAM,WAAW,CAAC,UAAoC;AAC3D,SAAO,OAAO,UAAU;AAC1B;AAEO,IAAM,WAAW,cAAc,OAAe,QAAQ;","names":[]}
+{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Meta.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["import { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport type { Payload } from './Payload.ts'\n\nexport const isAnyPayload = (value: unknown): value is Payload => {\n  if (isObject(value)) {\n    return typeof value.schema === 'string'\n  }\n  return false\n}\n\nexport const asAnyPayload = AsObjectFactory.create(isAnyPayload)\n\nexport const isPayload\n  = <T extends Payload>(schema: string[]) =>\n    (value: unknown): value is T => {\n      if (isAnyPayload(value)) {\n        return schema.includes(value.schema)\n      }\n      return false\n    }\n\nexport const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((value: unknown): value is T => isPayload(schema)(value))\n","import { isAnyPayload } from './isPayload.ts'\nimport type { WithMeta } from './Meta.ts'\nimport type { Payload, WithSources } from './Payload.ts'\n\nexport const isPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is T => isAnyPayload(x) && x?.schema === schema\n}\n\nexport const isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined\n}\n\nexport const isPayloadOfSchemaTypeWithSources = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is WithSources<T> =>\n    isPayloadOfSchemaType<WithSources<T>>(schema)(x) && x.sources !== undefined && Array.isArray(x.sources)\n}\n\nexport const notPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n  return (x?: unknown | null): x is T => !isAnyPayload(x) || x?.schema !== schema\n}\n\n// test types -- keep for future validation, but comment out\n\n/*\ntype TestSchema = 'network.xyo.test'\nconst TestSchema: TestSchema = 'network.xyo.test'\n\ntype Test = Payload<{ field: string }, TestSchema>\n\nconst testPayload: Test = { field: 'test', schema: TestSchema }\nconst testWithMeta: WithMeta<Test> = { $hash: '1234abcd', $meta: { timestamp: Date.now() }, field: 'test', schema: TestSchema }\n\nconst testPayloads: Payload[] = [testPayload]\nconst testMetaPayloads: WithMeta<Payload>[] = [testWithMeta]\n\nconst testType: Test = testWithMeta\n\nconst isTest: Test[] = testPayloads.filter(isPayloadOfSchemaType(TestSchema))\nconst isTestFromMeta: Payload[] = testMetaPayloads.filter(isPayloadOfSchemaType(TestSchema))\nconst isTestFromMetaWithMeta: PayloadWithMeta[] = testMetaPayloads.filter(isPayloadOfSchemaType(TestSchema))\n\nconst isTestFromMetaTyped = testMetaPayloads.filter(isPayloadOfSchemaType<Test>(TestSchema))\n\nconst isTestFromMetaTypedWithMeta: WithMeta<Test>[] = testMetaPayloads.filter(isPayloadOfSchemaType(TestSchema))\n\nconst isTestWithMeta: WithMeta<Test>[] = testPayloads.filter(isPayloadOfSchemaTypeWithMeta(TestSchema))\nconst isTestWithMetaFromMeta: WithMeta<Test>[] = testMetaPayloads.filter(isPayloadOfSchemaTypeWithMeta(TestSchema))\n*/\n","import type { Hash } from '@xylabs/hex'\nimport type { JsonValue } from '@xylabs/object'\n\nimport { isPayloadOfSchemaType } from './isPayloadOfSchemaType.ts'\nimport type { Payload } from './Payload.ts'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n  details?: JsonValue\n  message?: string\n  name?: string\n  query?: Hash\n  schema: ModuleErrorSchema\n  sources?: Hash[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload.ts'\nimport type { WithMeta } from './Meta.ts'\nimport type { Payload } from './Payload.ts'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n  return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n  return isAnyPayload(value) && isWithHash(value)\n}\n","import type { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport type { Payload, PayloadMetaFields } from './Payload.ts'\nimport type { Schema, WithSchema } from './Schema.ts'\n\nexport type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = PayloadMetaFields<M> & T\nexport type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> &\n  Omit<WithMeta<T, M>, '$hash'>\n\nexport type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>\n\nexport const unMeta = <T extends WithMeta<Payload>>(payload?: T): T | undefined => {\n  if (payload) {\n    const {\n      // eslint-disable-next-line @typescript-eslint/no-unused-vars\n      $meta, $hash, ...result\n    } = payload\n    return result as T\n  }\n}\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import type { EmptyObject } from '@xylabs/object'\nimport { AsTypeFactory } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload' as const\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n  return typeof value === 'string'\n}\n\nexport const asSchema = AsTypeFactory.create<Schema>(isSchema)\n\n/** Schema fields for a Payload */\nexport interface SchemaFields extends EmptyObject {\n  /**  Schema of the object */\n  schema: Schema\n}\n\n/** Add the Schema Fields to an object */\nexport type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields\n"],"mappings":";AAAA,SAAS,iBAAiB,gBAAgB;AAInC,IAAM,eAAe,CAAC,UAAqC;AAChE,MAAI,SAAS,KAAK,GAAG;AACnB,WAAO,OAAO,MAAM,WAAW;AAAA,EACjC;AACA,SAAO;AACT;AAEO,IAAM,eAAe,gBAAgB,OAAO,YAAY;AAExD,IAAM,YACT,CAAoB,WACpB,CAAC,UAA+B;AAC9B,MAAI,aAAa,KAAK,GAAG;AACvB,WAAO,OAAO,SAAS,MAAM,MAAM;AAAA,EACrC;AACA,SAAO;AACT;AAEG,IAAM,YAAY,CAAoB,WAAqB,gBAAgB,OAAO,CAAC,UAA+B,UAAU,MAAM,EAAE,KAAK,CAAC;;;AClB1I,IAAM,wBAAwB,CAAoB,WAAmB;AAC1E,SAAO,CAAC,MAA+B,aAAa,CAAC,KAAK,GAAG,WAAW;AAC1E;AAEO,IAAM,gCAAgC,CAAoB,WAAmB;AAClF,SAAO,CAAC,MAAyC,sBAAmC,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU;AAChH;AAEO,IAAM,mCAAmC,CAAoB,WAAmB;AACrF,SAAO,CAAC,MACN,sBAAsC,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,UAAa,MAAM,QAAQ,EAAE,OAAO;AAC1G;AAEO,IAAM,yBAAyB,CAAoB,WAAmB;AAC3E,SAAO,CAAC,MAA+B,CAAC,aAAa,CAAC,KAAK,GAAG,WAAW;AAC3E;;;ACZO,IAAM,oBAAuC;AAW7C,IAAM,gBAAgB,sBAAmC,iBAAiB;;;ACT1E,IAAM,aAAa,CAAoB,UAAmC;AAC/E,SAAO,OAAQ,OAAuB,UAAU;AAClD;AAOO,IAAM,oBAAoB,CAAoB,UAAyC;AAC5F,SAAO,aAAa,KAAK,KAAK,WAAW,KAAK;AAChD;;;ACTO,IAAM,SAAS,CAA8B,YAA+B;AACjF,MAAI,SAAS;AACX,UAAM;AAAA;AAAA,MAEJ;AAAA,MAAO;AAAA,MAAO,GAAG;AAAA,IACnB,IAAI;AACJ,WAAO;AAAA,EACT;AACF;;;AClBO,IAAM,mBAAqC;;;ACAlD,SAAS,qBAAqB;AAKvB,IAAM,gBAAgB;AAGtB,IAAM,WAAW,CAAC,UAAoC;AAC3D,SAAO,OAAO,UAAU;AAC1B;AAEO,IAAM,WAAW,cAAc,OAAe,QAAQ;","names":[]}

package/dist/node/isPayload.d.ts

@@ -0,0 +1,18 @@
+import type { Payload } from './Payload.ts';
+export declare const isAnyPayload: (value: unknown) => value is Payload;
+export declare const asAnyPayload: {
+    <TType extends {
+        schema: string;
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.0.3-1670033284/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    <TType extends {
+        schema: string;
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.0.3-1670033284/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
+        schema: string;
+    } & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
+};
+export declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
+export declare const asPayload: <T extends Payload>(schema: string[]) => {
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.0.3-1670033284/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.0.3-1670033284/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
+};
+//# sourceMappingURL=isPayload.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isPayload.d.ts","sourceRoot":"","sources":["../../src/isPayload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,KAAK,IAAI,OAKtD,CAAA;AAED,eAAO,MAAM,YAAY;;;;;;;;;CAAuC,CAAA;AAEhE,eAAO,MAAM,SAAS,GACjB,CAAC,SAAS,OAAO,UAAU,MAAM,EAAE,aAC5B,OAAO,KAAG,KAAK,IAAI,CAK1B,CAAA;AAEL,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,EAAE;;;CAAqF,CAAA"}

package/dist/node/isPayloadOfSchemaType.d.ts

@@ -0,0 +1,7 @@
+import type { WithMeta } from './Meta.ts';
+import type { Payload, WithSources } from './Payload.ts';
+export declare const isPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
+export declare const isPayloadOfSchemaTypeWithMeta: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithMeta<T>;
+export declare const isPayloadOfSchemaTypeWithSources: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithSources<T>;
+export declare const notPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
+//# sourceMappingURL=isPayloadOfSchemaType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAExD,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UACzD,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,CACnC,CAAA;AAED,eAAO,MAAM,6BAA6B,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UACjE,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAC7C,CAAA;AAED,eAAO,MAAM,gCAAgC,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UACpE,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAEhD,CAAA;AAED,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UAC1D,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,CACnC,CAAA"}

package/dist/node/isPayloadWithHash.d.ts

@@ -0,0 +1,5 @@
+import type { WithMeta } from './Meta.ts';
+import type { Payload } from './Payload.ts';
+export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
+export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
+//# sourceMappingURL=isPayloadWithHash.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAO3C,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAOD,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}

package/package.json

@@ -1,24 +1,24 @@
 {
   "name": "@xyo-network/payload-model",
-  "author": {
-    "email": "support@xyo.network",
-    "name": "XYO Development Team",
-    "url": "https://xyo.network"
-  },
+  "version": "3.0.8",
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "homepage": "https://xyo.network",
   "bugs": {
-    "email": "support@xyo.network",
-    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues",
+    "email": "support@xyo.network"
   },
-  "dependencies": {
-    "@xylabs/hex": "^4.0.2",
-    "@xylabs/object": "^4.0.2"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
-  "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.0.0-rc.30",
-    "@xylabs/tsconfig": "^4.0.0-rc.30",
-    "typescript": "^5.5.4"
+  "license": "LGPL-3.0-only",
+  "author": {
+    "name": "XYO Development Team",
+    "email": "support@xyo.network",
+    "url": "https://xyo.network"
   },
-  "description": "Primary SDK for using XYO Protocol 2.0",
+  "sideEffects": false,
+  "type": "module",
   "exports": {
     ".": {
       "browser": {
@@ -38,16 +38,16 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "types.node.d.ts",
-  "homepage": "https://xyo.network",
-  "license": "LGPL-3.0-only",
-  "publishConfig": {
-    "access": "public"
+  "dependencies": {
+    "@xylabs/hex": "^4.0.3",
+    "@xylabs/object": "^4.0.3"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^4.0.7",
+    "@xylabs/tsconfig": "^4.0.7",
+    "typescript": "^5.5.4"
   },
-  "sideEffects": false,
-  "version": "3.0.6",
-  "type": "module"
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/src/Meta.ts

@@ -11,8 +11,10 @@ export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S
 
 export const unMeta = <T extends WithMeta<Payload>>(payload?: T): T | undefined => {
   if (payload) {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const { $meta, $hash, ...result } = payload
+    const {
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      $meta, $hash, ...result
+    } = payload
     return result as T
   }
 }