@xyo-network/schema-payload-plugin 3.1.8 → 3.1.10

package/dist/neutral/Payload.d.ts

@@ -1,5 +1,5 @@
-import type { Payload } from '@xyo-network/payload-model';
-import type { SchemaSchema } from './Schema.ts';
+import { type Payload } from '@xyo-network/payload-model';
+import { SchemaSchema } from './Schema.ts';
 export type SchemaPayload = Payload<{
     definition: {
         [key: string]: unknown;
@@ -9,4 +9,31 @@ export type SchemaPayload = Payload<{
     name?: string;
     schema: SchemaSchema;
 }>;
+export declare const isSchemaPayload: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+    definition: {
+        [key: string]: unknown;
+        $id?: string;
+    };
+    extends?: string;
+    name?: string;
+    schema: SchemaSchema;
+};
+export declare const isSchemaPayloadWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+    definition: {
+        [key: string]: unknown;
+        $id?: string;
+    };
+    extends?: string;
+    name?: string;
+    schema: SchemaSchema;
+}>;
+export declare const isSchemaPayloadWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+    definition: {
+        [key: string]: unknown;
+        $id?: string;
+    };
+    extends?: string;
+    name?: string;
+    schema: SchemaSchema;
+}>;
 //# 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,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC;IAClC,UAAU,EAAE;QACV,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;QACtB,GAAG,CAAC,EAAE,MAAM,CAAA;KACb,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,MAAM,EAAE,YAAY,CAAA;CACrB,CAAC,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EACmF,KAAK,OAAO,EACrG,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC;IAIlC,UAAU,EAAE;QACV,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;QACtB,GAAG,CAAC,EAAE,MAAM,CAAA;KACb,CAAA;IAID,OAAO,CAAC,EAAE,MAAM,CAAA;IAGhB,IAAI,CAAC,EAAE,MAAM,CAAA;IAKb,MAAM,EAAE,YAAY,CAAA;CACrB,CAAC,CAAA;AAKF,eAAO,MAAM,eAAe;gBArBd;QACV,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;QACtB,GAAG,CAAC,EAAE,MAAM,CAAA;KACb;cAIS,MAAM;WAGT,MAAM;YAKL,YAAY;CAM2D,CAAA;AAKjF,eAAO,MAAM,0BAA0B;gBA1BzB;QACV,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;QACtB,GAAG,CAAC,EAAE,MAAM,CAAA;KACb;cAIS,MAAM;WAGT,MAAM;YAKL,YAAY;EAWiF,CAAA;AAKvG,eAAO,MAAM,uBAAuB;gBA/BtB;QACV,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;QACtB,GAAG,CAAC,EAAE,MAAM,CAAA;KACb;cAIS,MAAM;WAGT,MAAM;YAKL,YAAY;EAgB2E,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAG1C,eAAO,MAAM,mBAAmB;;;WAFI,CAAC;;;;;EAMjC,CAAA"}
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAG1C,eAAO,MAAM,mBAAmB;;;WAG5B,CAAH;;;;;EACG,CAAA"}

package/dist/neutral/index.mjs

@@ -1,9 +1,21 @@
-// src/Plugin.ts
-import { createPayloadPlugin } from "@xyo-network/payload-plugin";
+// src/Payload.ts
+import {
+  isPayloadOfSchemaType,
+  isPayloadOfSchemaTypeWithMeta,
+  isPayloadOfSchemaTypeWithSources
+} from "@xyo-network/payload-model";
 
 // src/Schema.ts
 var SchemaSchema = "network.xyo.schema";
 
+// src/Payload.ts
+var isSchemaPayload = isPayloadOfSchemaType(SchemaSchema);
+var isSchemaPayloadWithSources = isPayloadOfSchemaTypeWithSources(SchemaSchema);
+var isSchemaPayloadWithMeta = isPayloadOfSchemaTypeWithMeta(SchemaSchema);
+
+// src/Plugin.ts
+import { createPayloadPlugin } from "@xyo-network/payload-plugin";
+
 // src/Template.ts
 var schemaPayloadTemplate = () => ({
   definition: {
@@ -22,6 +34,9 @@ export {
   SchemaPayloadPlugin,
   SchemaSchema,
   SchemaPayloadPlugin as default,
+  isSchemaPayload,
+  isSchemaPayloadWithMeta,
+  isSchemaPayloadWithSources,
   schemaPayloadTemplate
 };
 //# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Plugin.ts","../../src/Schema.ts","../../src/Template.ts"],"sourcesContent":["import { createPayloadPlugin } from '@xyo-network/payload-plugin'\n\nimport type { SchemaPayload } from './Payload.ts'\nimport { SchemaSchema } from './Schema.ts'\nimport { schemaPayloadTemplate } from './Template.ts'\n\nexport const SchemaPayloadPlugin = () =>\n  createPayloadPlugin<SchemaPayload>({\n    schema: SchemaSchema,\n    template: schemaPayloadTemplate,\n  })\n","export type SchemaSchema = 'network.xyo.schema'\nexport const SchemaSchema: SchemaSchema = 'network.xyo.schema'\n","import type { SchemaPayload } from './Payload.ts'\nimport { SchemaSchema } from './Schema.ts'\nexport const schemaPayloadTemplate = (): SchemaPayload => ({\n  definition: {\n    $id: '',\n    $schema: 'http://json-schema.org/draft-07/schema#',\n  },\n  schema: SchemaSchema,\n})\n"],"mappings":";AAAA,SAAS,2BAA2B;;;ACC7B,IAAM,eAA6B;;;ACCnC,IAAM,wBAAwB,OAAsB;AAAA,EACzD,YAAY;AAAA,IACV,KAAK;AAAA,IACL,SAAS;AAAA,EACX;AAAA,EACA,QAAQ;AACV;;;AFFO,IAAM,sBAAsB,MACjC,oBAAmC;AAAA,EACjC,QAAQ;AAAA,EACR,UAAU;AACZ,CAAC;","names":[]}
+{"version":3,"sources":["../../src/Payload.ts","../../src/Schema.ts","../../src/Plugin.ts","../../src/Template.ts"],"sourcesContent":["import {\n  isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources, type Payload,\n} from '@xyo-network/payload-model'\n\nimport { SchemaSchema } from './Schema.ts'\n\nexport type SchemaPayload = Payload<{\n  /**\n   * The schema definition\n   */\n  definition: {\n    [key: string]: unknown\n    $id?: string\n  }\n  /**\n   * The schema this schema extends (if any)\n   */\n  extends?: string\n\n  /** @deprecated use definition.$id instead */\n  name?: string\n\n  /**\n   * Identifies this payload as a Schema\n   */\n  schema: SchemaSchema\n}>\n\n/**\n * Identity function for determining if an object is an Schema\n */\nexport const isSchemaPayload = isPayloadOfSchemaType<SchemaPayload>(SchemaSchema)\n\n/**\n * Identity function for determining if an object is an Schema with sources\n */\nexport const isSchemaPayloadWithSources = isPayloadOfSchemaTypeWithSources<SchemaPayload>(SchemaSchema)\n\n/**\n * Identity function for determining if an object is an Schema with meta\n */\nexport const isSchemaPayloadWithMeta = isPayloadOfSchemaTypeWithMeta<SchemaPayload>(SchemaSchema)\n","export type SchemaSchema = 'network.xyo.schema'\nexport const SchemaSchema: SchemaSchema = 'network.xyo.schema'\n","import { createPayloadPlugin } from '@xyo-network/payload-plugin'\n\nimport type { SchemaPayload } from './Payload.ts'\nimport { SchemaSchema } from './Schema.ts'\nimport { schemaPayloadTemplate } from './Template.ts'\n\nexport const SchemaPayloadPlugin = () =>\n  createPayloadPlugin<SchemaPayload>({\n    schema: SchemaSchema,\n    template: schemaPayloadTemplate,\n  })\n","import type { SchemaPayload } from './Payload.ts'\nimport { SchemaSchema } from './Schema.ts'\nexport const schemaPayloadTemplate = (): SchemaPayload => ({\n  definition: {\n    $id: '',\n    $schema: 'http://json-schema.org/draft-07/schema#',\n  },\n  schema: SchemaSchema,\n})\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EAAuB;AAAA,EAA+B;AAAA,OACjD;;;ACDA,IAAM,eAA6B;;;AD8BnC,IAAM,kBAAkB,sBAAqC,YAAY;AAKzE,IAAM,6BAA6B,iCAAgD,YAAY;AAK/F,IAAM,0BAA0B,8BAA6C,YAAY;;;AEzChG,SAAS,2BAA2B;;;ACE7B,IAAM,wBAAwB,OAAsB;AAAA,EACzD,YAAY;AAAA,IACV,KAAK;AAAA,IACL,SAAS;AAAA,EACX;AAAA,EACA,QAAQ;AACV;;;ADFO,IAAM,sBAAsB,MACjC,oBAAmC;AAAA,EACjC,QAAQ;AAAA,EACR,UAAU;AACZ,CAAC;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/schema-payload-plugin",
-  "version": "3.1.8",
+  "version": "3.1.10",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,8 +29,8 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xyo-network/payload-model": "^3.1.8",
-    "@xyo-network/payload-plugin": "^3.1.8"
+    "@xyo-network/payload-model": "^3.1.10",
+    "@xyo-network/payload-plugin": "^3.1.10"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^4.0.7",

package/src/Payload.ts

@@ -1,15 +1,42 @@
-import type { Payload } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType, isPayloadOfSchemaTypeWithMeta, isPayloadOfSchemaTypeWithSources, type Payload,
+} from '@xyo-network/payload-model'
 
-import type { SchemaSchema } from './Schema.ts'
+import { SchemaSchema } from './Schema.ts'
 
 export type SchemaPayload = Payload<{
+  /**
+   * The schema definition
+   */
   definition: {
     [key: string]: unknown
     $id?: string
   }
+  /**
+   * The schema this schema extends (if any)
+   */
   extends?: string
+
   /** @deprecated use definition.$id instead */
   name?: string
 
+  /**
+   * Identifies this payload as a Schema
+   */
   schema: SchemaSchema
 }>
+
+/**
+ * Identity function for determining if an object is an Schema
+ */
+export const isSchemaPayload = isPayloadOfSchemaType<SchemaPayload>(SchemaSchema)
+
+/**
+ * Identity function for determining if an object is an Schema with sources
+ */
+export const isSchemaPayloadWithSources = isPayloadOfSchemaTypeWithSources<SchemaPayload>(SchemaSchema)
+
+/**
+ * Identity function for determining if an object is an Schema with meta
+ */
+export const isSchemaPayloadWithMeta = isPayloadOfSchemaTypeWithMeta<SchemaPayload>(SchemaSchema)