fairspec-extension 0.1.1 → 0.2.0

package/index.ts

@@ -1,7 +1,11 @@
-import type * as standard from "@fairspec/metadata"
-import type * as extension from "./models/dataset.ts"
+import * as standard from "@fairspec/metadata"
+import { z } from "zod"
+import * as extension from "./models/dataset.ts"
 
-export type Resource = standard.Resource & extension.Resource
-export type Dataset = standard.Dataset & extension.Dataset
+export * from "./models/index.ts"
 
-export type * from "./models/index.ts"
+export const Dataset = z.intersection(standard.Dataset, extension.Dataset)
+export const Resource = z.intersection(standard.Resource, extension.Resource)
+
+export type Dataset = z.infer<typeof Dataset>
+export type Resource = z.infer<typeof Resource>

package/models/dataset.ts

@@ -1,26 +1,26 @@
 // biome-ignore-all format: DO NOT UPDATE this @generated file
+import { z } from "zod";
 
-export type FairspecExtensionProfile = Dataset
-export type Resource = Table1Resource | Table2Resource
+export const Table1Resource = z.object({
+    name: z.literal("table1"),
+    Table: z.literal("https://fairspec.github.io/schemas/0.2.0/table1.json")
+});
 
-export interface Dataset {
-  $schema: "https://fairspec.github.io/profiles/0.1.1/dataset.json"
-  /**
-   * @minItems 1
-   */
-  resources: [Resource, ...Resource[]]
-}
-/**
- * Data records have to conform to the Table1 schema
- */
-export interface Table1Resource {
-  name: "table1"
-  tableSchema: "https://fairspec.github.io/schemas/0.1.1/table1.json"
-}
-/**
- * Data items have to conform to the Table2 schema
- */
-export interface Table2Resource {
-  name: "table2"
-  tableSchema: "https://fairspec.github.io/schemas/0.1.1/table2.json"
-}
+export const Table2Resource = z.object({
+    name: z.literal("table2"),
+    Table: z.literal("https://fairspec.github.io/schemas/0.2.0/table2.json")
+});
+
+export const Resource = z.union([Table1Resource, Table2Resource]);
+
+export const Dataset = z.object({
+    $schema: z.literal("https://fairspec.github.io/profiles/0.2.0/dataset.json"),
+    resources: z.tuple([Resource]).rest(Resource)
+});
+
+export const FairspecExtensionProfile = Dataset;
+export type Table1Resource = z.infer<typeof Table1Resource>
+export type Table2Resource = z.infer<typeof Table2Resource>
+export type Resource = z.infer<typeof Resource>
+export type Dataset = z.infer<typeof Dataset>
+export type FairspecExtensionProfile = z.infer<typeof FairspecExtensionProfile>

package/models/table1.ts

@@ -1,39 +1,14 @@
 // biome-ignore-all format: DO NOT UPDATE this @generated file
+import { z } from "zod";
 
-/**
- * An exemplar schema demonstrating various field types and constraints
- */
-export interface Table1 {
-  /**
-   * Unique identifier for the record
-   */
-  id: string
-  /**
-   * Name of the entity
-   */
-  name: string
-  /**
-   * Current status of the entity
-   */
-  status: "active" | "inactive" | "pending"
-  /**
-   * Numeric value associated with the entity
-   */
-  value: number
-  /**
-   * Count of items
-   */
-  itemCount?: number
-  /**
-   * Whether the entity has been verified
-   */
-  isVerified: boolean
-  /**
-   * Date when the entity was created
-   */
-  createdDate: string
-  /**
-   * Optional description of the entity
-   */
-  description?: string
-}
+export const Table1 = z.object({
+    id: z.string(),
+    name: z.string(),
+    status: z.union([z.literal("active"), z.literal("inactive"), z.literal("pending")]),
+    value: z.number(),
+    itemCount: z.number().optional(),
+    isVerified: z.boolean(),
+    createdDate: z.string(),
+    description: z.string().optional()
+});
+export type Table1 = z.infer<typeof Table1>

package/models/table2.ts

@@ -1,39 +1,14 @@
 // biome-ignore-all format: DO NOT UPDATE this @generated file
+import { z } from "zod";
 
-/**
- * An exemplar schema demonstrating foreign key relationships and additional constraints
- */
-export interface Table2 {
-  /**
-   * Unique identifier for the record
-   */
-  id: string
-  /**
-   * Reference to the parent table1 record. If not provided, the record is independent
-   */
-  table1Id?: string
-  /**
-   * Title or name of the item
-   */
-  title: string
-  /**
-   * Monetary or numeric amount
-   */
-  amount: number
-  /**
-   * Priority level of the item
-   */
-  priority: "low" | "medium" | "high"
-  /**
-   * Percentage value between 0 and 100
-   */
-  percentage?: number
-  /**
-   * Additional notes or comments
-   */
-  notes?: string
-  /**
-   * Whether the item is currently active
-   */
-  isActive: boolean
-}
+export const Table2 = z.object({
+    id: z.string(),
+    table1Id: z.string().optional(),
+    title: z.string(),
+    amount: z.number(),
+    priority: z.union([z.literal("low"), z.literal("medium"), z.literal("high")]),
+    percentage: z.number().optional(),
+    notes: z.string().optional(),
+    isActive: z.boolean()
+});
+export type Table2 = z.infer<typeof Table2>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fairspec-extension",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "slug": "fairspec-extension",
   "title": "Fairspec Extension",
   "description": "Fairspec Extension is a Git repository template for rapid Fairspec extension development",
@@ -10,7 +10,8 @@
   "author": "Evgeny Karev",
   "license": "MIT",
   "dependencies": {
-    "@fairspec/metadata": "^0.2.2"
+    "@fairspec/metadata": "^0.2.2",
+    "zod": "^4.3.5"
   },
   "scripts": {
     "build": "tsc",