@augment-vir/common 12.1.1 → 12.2.0

package/dist/cjs/augments/json-compatible.d.ts

@@ -0,0 +1,23 @@
+import { Jsonify, Primitive } from 'type-fest';
+/**
+ * These are similar in purpose, name, and structure to type-fest's JsonValue types but these are
+ * permissive. The goal here is to allow any types that do not get serialized into just empty
+ * objects. (For example, JSON.stringify(new Map()) returns "{}", so we don't want to allow that
+ * type.)
+ */
+export type JsonCompatiblePrimitiveValue = Jsonify<Primitive> | undefined;
+export type JsonCompatibleObject = Partial<{
+    readonly [key: string | number]: JsonCompatibleValue | Readonly<JsonCompatibleValue>;
+}> | Partial<{
+    [key: string | number]: JsonCompatibleValue | Readonly<JsonCompatibleValue>;
+}>;
+export type JsonCompatibleArray = JsonCompatibleValue[]
+/**
+ * This weird readonly with object syntax for an array type is so that TypeScript doesn't
+ * complain about JsonCompatibleArray circularly referencing itself
+ */
+ | ({
+    readonly [P in number]: JsonCompatibleValue;
+} & ReadonlyArray<any>);
+export type JsonCompatibleValue = JsonCompatiblePrimitiveValue | JsonCompatibleObject | JsonCompatibleArray;
+//# sourceMappingURL=json-compatible.d.ts.map

package/dist/cjs/augments/json-compatible.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/index.d.ts

@@ -7,6 +7,7 @@ export * from './augments/date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
+export * from './augments/json-compatible';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/jsonify';

package/dist/cjs/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./augments/date"), exports);
 __exportStar(require("./augments/environment"), exports);
 __exportStar(require("./augments/error"), exports);
 __exportStar(require("./augments/function"), exports);
+__exportStar(require("./augments/json-compatible"), exports);
 __exportStar(require("./augments/object/enum"), exports);
 __exportStar(require("./augments/object/filter-object"), exports);
 __exportStar(require("./augments/object/jsonify"), exports);

package/dist/esm/augments/json-compatible.d.ts

@@ -0,0 +1,23 @@
+import { Jsonify, Primitive } from 'type-fest';
+/**
+ * These are similar in purpose, name, and structure to type-fest's JsonValue types but these are
+ * permissive. The goal here is to allow any types that do not get serialized into just empty
+ * objects. (For example, JSON.stringify(new Map()) returns "{}", so we don't want to allow that
+ * type.)
+ */
+export type JsonCompatiblePrimitiveValue = Jsonify<Primitive> | undefined;
+export type JsonCompatibleObject = Partial<{
+    readonly [key: string | number]: JsonCompatibleValue | Readonly<JsonCompatibleValue>;
+}> | Partial<{
+    [key: string | number]: JsonCompatibleValue | Readonly<JsonCompatibleValue>;
+}>;
+export type JsonCompatibleArray = JsonCompatibleValue[]
+/**
+ * This weird readonly with object syntax for an array type is so that TypeScript doesn't
+ * complain about JsonCompatibleArray circularly referencing itself
+ */
+ | ({
+    readonly [P in number]: JsonCompatibleValue;
+} & ReadonlyArray<any>);
+export type JsonCompatibleValue = JsonCompatiblePrimitiveValue | JsonCompatibleObject | JsonCompatibleArray;
+//# sourceMappingURL=json-compatible.d.ts.map

package/dist/esm/augments/json-compatible.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.d.ts

@@ -7,6 +7,7 @@ export * from './augments/date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
+export * from './augments/json-compatible';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/jsonify';

package/dist/esm/index.js

@@ -7,6 +7,7 @@ export * from './augments/date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
+export * from './augments/json-compatible';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/jsonify';

package/dist/types/augments/json-compatible.d.ts

@@ -0,0 +1,23 @@
+import { Jsonify, Primitive } from 'type-fest';
+/**
+ * These are similar in purpose, name, and structure to type-fest's JsonValue types but these are
+ * permissive. The goal here is to allow any types that do not get serialized into just empty
+ * objects. (For example, JSON.stringify(new Map()) returns "{}", so we don't want to allow that
+ * type.)
+ */
+export type JsonCompatiblePrimitiveValue = Jsonify<Primitive> | undefined;
+export type JsonCompatibleObject = Partial<{
+    readonly [key: string | number]: JsonCompatibleValue | Readonly<JsonCompatibleValue>;
+}> | Partial<{
+    [key: string | number]: JsonCompatibleValue | Readonly<JsonCompatibleValue>;
+}>;
+export type JsonCompatibleArray = JsonCompatibleValue[]
+/**
+ * This weird readonly with object syntax for an array type is so that TypeScript doesn't
+ * complain about JsonCompatibleArray circularly referencing itself
+ */
+ | ({
+    readonly [P in number]: JsonCompatibleValue;
+} & ReadonlyArray<any>);
+export type JsonCompatibleValue = JsonCompatiblePrimitiveValue | JsonCompatibleObject | JsonCompatibleArray;
+//# sourceMappingURL=json-compatible.d.ts.map

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ export * from './augments/date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
+export * from './augments/json-compatible';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/jsonify';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "12.1.1",
+    "version": "12.2.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"