@verdant-web/common 2.5.0 → 2.5.2

package/dist/esm/presence.d.ts

@@ -36,5 +36,7 @@ export type UserInfoUpdate<Profile = any, Presence = any> = Omit<UserInfo<Profil
 };
 export interface VerdantInternalPresence {
     viewId?: string;
+    lastFieldId?: string;
+    lastFieldTimestamp?: number;
 }
 export declare const initialInternalPresence: VerdantInternalPresence;

package/dist/esm/presence.js.map

@@ -1 +1 @@
-{"version":3,"file":"presence.js","sourceRoot":"","sources":["../../src/presence.ts"],"names":[],"mappings":"AAgDA,MAAM,CAAC,MAAM,uBAAuB,GAA4B,EAAE,CAAC"}
+{"version":3,"file":"presence.js","sourceRoot":"","sources":["../../src/presence.ts"],"names":[],"mappings":"AAkDA,MAAM,CAAC,MAAM,uBAAuB,GAA4B,EAAE,CAAC"}

package/dist/esm/schema/fieldHelpers.d.ts

@@ -4,32 +4,49 @@ export declare const fields: {
         properties: Props;
         nullable?: boolean;
         default?: ShapeFromFieldsWithDefaults<Props> | (() => ShapeFromFieldsWithDefaults<Props>);
+        /** Add some docs to your field which will annotate the generated typing */
+        documentation?: string;
     }) => StorageObjectFieldSchema<Props>;
     array: <T extends StorageFieldSchema>(args: {
         items: T;
         nullable?: boolean;
+        /** Add some docs to your field which will annotate the generated typing */
+        documentation?: string;
     }) => StorageArrayFieldSchema<T>;
     string: (args?: {
         nullable?: boolean;
         default?: string | (() => string);
         options?: string[];
+        /** Add some docs to your field which will annotate the generated typing */
+        documentation?: string;
     }) => StorageStringFieldSchema;
     number: (args?: {
         nullable?: boolean;
         default?: number | (() => number);
+        /** Add some docs to your field which will annotate the generated typing */
+        documentation?: string;
     }) => StorageNumberFieldSchema;
     boolean: (args?: {
         nullable?: boolean;
         default?: boolean | (() => boolean);
+        /** Add some docs to your field which will annotate the generated typing */
+        documentation?: string;
     }) => StorageBooleanFieldSchema;
     any: <TShape>(args?: {
         default?: TShape;
+        /** Add some docs to your field which will annotate the generated typing */
+        documentation?: string;
     }) => StorageAnyFieldSchema<TShape>;
     map: <T_1 extends StorageFieldSchema>(args: {
         values: T_1;
+        /** Add some docs to your field which will annotate the generated typing */
+        documentation?: string | undefined;
     }) => StorageMapFieldSchema<T_1>;
     file: (args?: {
         nullable?: boolean;
         downloadRemote?: boolean;
+        /** Add some docs to your field which will annotate the generated typing */
+        documentation?: string;
     }) => StorageFileFieldSchema;
+    id: () => StorageStringFieldSchema;
 };

package/dist/esm/schema/fieldHelpers.js

@@ -1,3 +1,4 @@
+import cuid from 'cuid';
 const objectField = (args) => {
     return Object.assign({ type: 'object' }, args);
 };
@@ -22,6 +23,16 @@ const mapField = (args) => {
 const fileField = (args) => {
     return Object.assign({ type: 'file' }, args);
 };
+/**
+ * Meant for use on primary key fields. Do not use this to refer
+ * to another document as a 'foreign key'
+ */
+const idField = () => {
+    return {
+        type: 'string',
+        default: cuid,
+    };
+};
 export const fields = {
     object: objectField,
     array: arrayField,
@@ -31,5 +42,6 @@ export const fields = {
     any: anyField,
     map: mapField,
     file: fileField,
+    id: idField,
 };
 //# sourceMappingURL=fieldHelpers.js.map

package/dist/esm/schema/fieldHelpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"fieldHelpers.js","sourceRoot":"","sources":["../../../src/schema/fieldHelpers.ts"],"names":[],"mappings":"AAcA,MAAM,WAAW,GAAG,CAAoC,IAMvD,EAAmC,EAAE;IACrC,uBACC,IAAI,EAAE,QAAQ,IACX,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAA+B,IAGjD,EAA8B,EAAE;IAChC,uBACC,IAAI,EAAE,OAAO,IACV,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAIpB,EAA4B,EAAE;IAC9B,uBACC,IAAI,EAAE,QAAQ,IACX,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAGpB,EAA4B,EAAE;IAC9B,uBACC,IAAI,EAAE,QAAQ,IACX,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAGrB,EAA6B,EAAE;IAC/B,uBACC,IAAI,EAAE,SAAS,IACZ,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAS,IAEzB,EAAiC,EAAE;IACnC,uBACC,IAAI,EAAE,KAAK,IACR,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAA+B,IAE/C,EAA4B,EAAE;IAC9B,uBACC,IAAI,EAAE,KAAK,IACR,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,IAGlB,EAA0B,EAAE;IAC5B,uBACC,IAAI,EAAE,MAAM,IACT,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG;IACrB,MAAM,EAAE,WAAW;IACnB,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,WAAW;IACnB,OAAO,EAAE,YAAY;IACrB,GAAG,EAAE,QAAQ;IACb,GAAG,EAAE,QAAQ;IACb,IAAI,EAAE,SAAS;CACf,CAAC"}
+{"version":3,"file":"fieldHelpers.js","sourceRoot":"","sources":["../../../src/schema/fieldHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAexB,MAAM,WAAW,GAAG,CAAoC,IAQvD,EAAmC,EAAE;IACrC,uBACC,IAAI,EAAE,QAAQ,IACX,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAA+B,IAKjD,EAA8B,EAAE;IAChC,uBACC,IAAI,EAAE,OAAO,IACV,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAMpB,EAA4B,EAAE;IAC9B,uBACC,IAAI,EAAE,QAAQ,IACX,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAKpB,EAA4B,EAAE;IAC9B,uBACC,IAAI,EAAE,QAAQ,IACX,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAKrB,EAA6B,EAAE;IAC/B,uBACC,IAAI,EAAE,SAAS,IACZ,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAS,IAIzB,EAAiC,EAAE;IACnC,uBACC,IAAI,EAAE,KAAK,IACR,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAA+B,IAI/C,EAA4B,EAAE;IAC9B,uBACC,IAAI,EAAE,KAAK,IACR,IAAI,EACN;AACH,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,IAKlB,EAA0B,EAAE;IAC5B,uBACC,IAAI,EAAE,MAAM,IACT,IAAI,EACN;AACH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,GAAG,GAA6B,EAAE;IAC9C,OAAO;QACN,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;KACb,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG;IACrB,MAAM,EAAE,WAAW;IACnB,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,WAAW;IACnB,OAAO,EAAE,YAAY;IACrB,GAAG,EAAE,QAAQ;IACb,GAAG,EAAE,QAAQ;IACb,IAAI,EAAE,SAAS;IACf,EAAE,EAAE,OAAO;CACX,CAAC"}

package/dist/esm/schema/index.d.ts

@@ -10,34 +10,43 @@ export declare namespace schema {
             properties: Props;
             nullable?: boolean | undefined;
             default?: import("./types.js").ShapeFromFieldsWithDefaults<Props> | (() => import("./types.js").ShapeFromFieldsWithDefaults<Props>) | undefined;
+            documentation?: string | undefined;
         }) => import("./types.js").StorageObjectFieldSchema<Props>;
         array: <T extends import("./types.js").StorageFieldSchema>(args: {
             items: T;
             nullable?: boolean | undefined;
+            documentation?: string | undefined;
         }) => import("./types.js").StorageArrayFieldSchema<T>;
         string: (args?: {
             nullable?: boolean | undefined;
             default?: string | (() => string) | undefined;
             options?: string[] | undefined;
+            documentation?: string | undefined;
         } | undefined) => import("./types.js").StorageStringFieldSchema;
         number: (args?: {
             nullable?: boolean | undefined;
             default?: number | (() => number) | undefined;
+            documentation?: string | undefined;
         } | undefined) => import("./types.js").StorageNumberFieldSchema;
         boolean: (args?: {
             nullable?: boolean | undefined;
             default?: boolean | (() => boolean) | undefined;
+            documentation?: string | undefined;
         } | undefined) => import("./types.js").StorageBooleanFieldSchema;
         any: <TShape>(args?: {
             default?: TShape | undefined;
+            documentation?: string | undefined;
         } | undefined) => import("./types.js").StorageAnyFieldSchema<TShape>;
         map: <T_1 extends import("./types.js").StorageFieldSchema>(args: {
             values: T_1;
+            documentation?: string | undefined;
         }) => import("./types.js").StorageMapFieldSchema<T_1>;
         file: (args?: {
             nullable?: boolean | undefined;
             downloadRemote?: boolean | undefined;
+            documentation?: string | undefined;
         } | undefined) => import("./types.js").StorageFileFieldSchema;
+        id: () => import("./types.js").StorageStringFieldSchema;
     };
     var generated: {
         id: (() => string) & {

package/dist/esm/schema/types/fields.d.ts

@@ -4,35 +4,49 @@ export type StorageStringFieldSchema = {
     default?: string | (() => string);
     /** Limit the values to a certain set of options */
     options?: string[];
+    /** Add some docs to your field which will annotate the generated typing */
+    documentation?: string;
 };
 export type StorageNumberFieldSchema = {
     type: 'number';
     nullable?: boolean;
     default?: number | (() => number);
+    /** Add some docs to your field which will annotate the generated typing */
+    documentation?: string;
 };
 export type StorageBooleanFieldSchema = {
     type: 'boolean';
     nullable?: boolean;
     default?: boolean | (() => boolean);
+    /** Add some docs to your field which will annotate the generated typing */
+    documentation?: string;
 };
 export type StorageArrayFieldSchema<TItems extends StorageFieldSchema> = {
     type: 'array';
     items: TItems;
     nullable?: boolean;
+    /** Add some docs to your field which will annotate the generated typing */
+    documentation?: string;
 };
 export type StorageObjectFieldSchema<Props extends StorageFieldsSchema> = {
     type: 'object';
     properties: Props;
     nullable?: boolean;
     default?: Record<string, any> | (() => Record<string, any>);
+    /** Add some docs to your field which will annotate the generated typing */
+    documentation?: string;
 };
 export type StorageAnyFieldSchema<TShape = any> = {
     type: 'any';
     default?: TShape;
+    /** Add some docs to your field which will annotate the generated typing */
+    documentation?: string;
 };
 export type StorageMapFieldSchema<V extends StorageFieldSchema> = {
     type: 'map';
     values: V;
+    /** Add some docs to your field which will annotate the generated typing */
+    documentation?: string;
 };
 export type StorageFileFieldSchema = {
     type: 'file';
@@ -43,6 +57,8 @@ export type StorageFileFieldSchema = {
      * connection to use files created by other devices.
      */
     downloadRemote?: boolean;
+    /** Add some docs to your field which will annotate the generated typing */
+    documentation?: string;
 };
 export type StorageFieldSchema = StorageStringFieldSchema | StorageNumberFieldSchema | StorageBooleanFieldSchema | StorageArrayFieldSchema<any> | StorageObjectFieldSchema<any> | StorageAnyFieldSchema | StorageMapFieldSchema<any> | StorageFileFieldSchema;
 export type StorageFieldsSchema = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdant-web/common",
-  "version": "2.5.0",
+  "version": "2.5.2",
   "access": "public",
   "type": "module",
   "exports": {

package/src/presence.ts

@@ -44,6 +44,8 @@ export type UserInfoUpdate<Profile = any, Presence = any> = Omit<
 
 export interface VerdantInternalPresence {
 	viewId?: string;
+	lastFieldId?: string;
+	lastFieldTimestamp?: number;
 }
 
 export const initialInternalPresence: VerdantInternalPresence = {};

package/src/schema/fieldHelpers.ts

@@ -1,3 +1,4 @@
+import cuid from 'cuid';
 import {
 	ShapeFromFieldsWithDefaults,
 	StorageAnyFieldSchema,
@@ -18,6 +19,8 @@ const objectField = <Props extends StorageFieldsSchema>(args: {
 	default?:
 		| ShapeFromFieldsWithDefaults<Props>
 		| (() => ShapeFromFieldsWithDefaults<Props>);
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 }): StorageObjectFieldSchema<Props> => {
 	return {
 		type: 'object',
@@ -28,6 +31,8 @@ const objectField = <Props extends StorageFieldsSchema>(args: {
 const arrayField = <T extends StorageFieldSchema>(args: {
 	items: T;
 	nullable?: boolean;
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 }): StorageArrayFieldSchema<T> => {
 	return {
 		type: 'array',
@@ -39,6 +44,8 @@ const stringField = (args?: {
 	nullable?: boolean;
 	default?: string | (() => string);
 	options?: string[];
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 }): StorageStringFieldSchema => {
 	return {
 		type: 'string',
@@ -49,6 +56,8 @@ const stringField = (args?: {
 const numberField = (args?: {
 	nullable?: boolean;
 	default?: number | (() => number);
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 }): StorageNumberFieldSchema => {
 	return {
 		type: 'number',
@@ -59,6 +68,8 @@ const numberField = (args?: {
 const booleanField = (args?: {
 	nullable?: boolean;
 	default?: boolean | (() => boolean);
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 }): StorageBooleanFieldSchema => {
 	return {
 		type: 'boolean',
@@ -68,6 +79,8 @@ const booleanField = (args?: {
 
 const anyField = <TShape>(args?: {
 	default?: TShape;
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 }): StorageAnyFieldSchema<TShape> => {
 	return {
 		type: 'any',
@@ -77,6 +90,8 @@ const anyField = <TShape>(args?: {
 
 const mapField = <T extends StorageFieldSchema>(args: {
 	values: T;
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 }): StorageMapFieldSchema<T> => {
 	return {
 		type: 'map',
@@ -87,6 +102,8 @@ const mapField = <T extends StorageFieldSchema>(args: {
 const fileField = (args?: {
 	nullable?: boolean;
 	downloadRemote?: boolean;
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 }): StorageFileFieldSchema => {
 	return {
 		type: 'file',
@@ -94,6 +111,17 @@ const fileField = (args?: {
 	};
 };
 
+/**
+ * Meant for use on primary key fields. Do not use this to refer
+ * to another document as a 'foreign key'
+ */
+const idField = (): StorageStringFieldSchema => {
+	return {
+		type: 'string',
+		default: cuid,
+	};
+};
+
 export const fields = {
 	object: objectField,
 	array: arrayField,
@@ -103,4 +131,5 @@ export const fields = {
 	any: anyField,
 	map: mapField,
 	file: fileField,
+	id: idField,
 };

package/src/schema/types/fields.ts

@@ -4,35 +4,49 @@ export type StorageStringFieldSchema = {
 	default?: string | (() => string);
 	/** Limit the values to a certain set of options */
 	options?: string[];
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 };
 export type StorageNumberFieldSchema = {
 	type: 'number';
 	nullable?: boolean;
 	default?: number | (() => number);
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 };
 export type StorageBooleanFieldSchema = {
 	type: 'boolean';
 	nullable?: boolean;
 	default?: boolean | (() => boolean);
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 };
 export type StorageArrayFieldSchema<TItems extends StorageFieldSchema> = {
 	type: 'array';
 	items: TItems;
 	nullable?: boolean;
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 };
 export type StorageObjectFieldSchema<Props extends StorageFieldsSchema> = {
 	type: 'object';
 	properties: Props;
 	nullable?: boolean;
 	default?: Record<string, any> | (() => Record<string, any>);
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 };
 export type StorageAnyFieldSchema<TShape = any> = {
 	type: 'any';
 	default?: TShape;
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 };
 export type StorageMapFieldSchema<V extends StorageFieldSchema> = {
 	type: 'map';
 	values: V;
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 };
 export type StorageFileFieldSchema = {
 	type: 'file';
@@ -43,6 +57,8 @@ export type StorageFileFieldSchema = {
 	 * connection to use files created by other devices.
 	 */
 	downloadRemote?: boolean;
+	/** Add some docs to your field which will annotate the generated typing */
+	documentation?: string;
 };
 
 export type StorageFieldSchema =