@xube/kit-schema 0.0.88 → 0.0.90

package/dist/base.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseDataSchema = void 0;
 const zod_1 = require("zod");
 exports.BaseDataSchema = zod_1.z.object({
-    s: zod_1.z.number(),
-    us: zod_1.z.number().optional(),
-    type: zod_1.z.string(),
+    s: zod_1.z.number(), //Seconds
+    us: zod_1.z.number().optional(), //Microseconds
+    type: zod_1.z.string(), //Type of item (ie. data, event, etc)
     id: zod_1.z.string(), //Id of item
 });

package/dist/generated/validators/baseData.d.ts

@@ -1,13 +1,9 @@
 export function validate(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
     instancePath?: string | undefined;
-    parentData: any;
-    parentDataProperty: any;
     rootData?: any;
 }): boolean;
 export default validate10;
 declare function validate10(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
     instancePath?: string | undefined;
-    parentData: any;
-    parentDataProperty: any;
     rootData?: any;
 }): boolean;

package/dist/time-series.js

@@ -35,9 +35,9 @@ exports.TimeSeriesEntrySchema = zod_1.z.object({
         trigger: exports.TriggerTypeSchema,
         source: exports.SourceTypeSchema,
     }),
-    t0: zod_1.z.string().datetime(),
-    dtt: exports.TimeUnitSchema.default("ms"),
-    dt: zod_1.z.number(),
+    t0: zod_1.z.string().datetime(), //in microseconds since epoch
+    dtt: exports.TimeUnitSchema.default("ms"), //delta type - time unit
+    dt: zod_1.z.number(), //in microseconds
     dataT: zod_1.z
         .array(zod_1.z
         .object({
@@ -51,18 +51,18 @@ exports.TimeSeriesEntrySchema = zod_1.z.object({
 exports.TimeSeriesSchema = zod_1.z.array(exports.TimeSeriesEntrySchema);
 exports.timeSeriesExample = [
     {
-        v: "1",
+        v: "1", //Version of the schema
         m: {
-            id: "DEVICE_1234567890",
-            trigger: "data",
+            id: "DEVICE_1234567890", //This is the device, or component id
+            trigger: "data", //Options are "data" or "event"
             source: "device", //Options are "device", "component", or "platform"
         },
-        t0: "2023-10-13T01:29:55.1024001Z",
-        dtt: "ms",
-        dt: 1,
+        t0: "2023-10-13T01:29:55.1024001Z", //microseconds since epoch
+        dtt: "ms", //Time unit for dt. Default is ms
+        dt: 1, //In milliseconds. This is 1 ms
         dataT: [
             {
-                i: 4,
+                i: 4, // index of the data reading in Y
                 dt: 3, //diff in time with dtt as the unit
             },
         ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xube/kit-schema",
-  "version": "0.0.88",
+  "version": "0.0.90",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -19,12 +19,12 @@
   "homepage": "https://github.com/XubeLtd/data-logger#readme",
   "dependencies": {
     "@anatine/zod-openapi": "^2.2.0",
-    "@xube/kit-constants": "^0.0.88",
-    "@xube/kit-generator": "^0.0.88",
-    "@xube/kit-log": "^0.0.88",
+    "@xube/kit-constants": "^0.0.90",
+    "@xube/kit-generator": "^0.0.90",
+    "@xube/kit-log": "^0.0.90",
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@xube/kit-build": "^0.0.88"
+    "@xube/kit-build": "^0.0.90"
   }
 }