@xylabs/object 3.1.6 → 3.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/dist/browser/Base.d.cts +25 -0
  2. package/dist/browser/Base.d.cts.map +1 -1
  3. package/dist/browser/Base.d.mts +25 -0
  4. package/dist/browser/Base.d.mts.map +1 -1
  5. package/dist/browser/Base.d.ts +25 -0
  6. package/dist/browser/Base.d.ts.map +1 -1
  7. package/dist/browser/index.cjs +109 -0
  8. package/dist/browser/index.cjs.map +1 -1
  9. package/dist/browser/index.d.cts +1 -0
  10. package/dist/browser/index.d.cts.map +1 -1
  11. package/dist/browser/index.d.mts +1 -0
  12. package/dist/browser/index.d.mts.map +1 -1
  13. package/dist/browser/index.d.ts +1 -0
  14. package/dist/browser/index.d.ts.map +1 -1
  15. package/dist/browser/index.js +109 -0
  16. package/dist/browser/index.js.map +1 -1
  17. package/dist/browser/removeFields.d.cts +2 -0
  18. package/dist/browser/removeFields.d.cts.map +1 -0
  19. package/dist/browser/removeFields.d.mts +2 -0
  20. package/dist/browser/removeFields.d.mts.map +1 -0
  21. package/dist/browser/removeFields.d.ts +2 -0
  22. package/dist/browser/removeFields.d.ts.map +1 -0
  23. package/dist/node/Base.d.cts +25 -0
  24. package/dist/node/Base.d.cts.map +1 -1
  25. package/dist/node/Base.d.mts +25 -0
  26. package/dist/node/Base.d.mts.map +1 -1
  27. package/dist/node/Base.d.ts +25 -0
  28. package/dist/node/Base.d.ts.map +1 -1
  29. package/dist/node/index.cjs +113 -0
  30. package/dist/node/index.cjs.map +1 -1
  31. package/dist/node/index.d.cts +1 -0
  32. package/dist/node/index.d.cts.map +1 -1
  33. package/dist/node/index.d.mts +1 -0
  34. package/dist/node/index.d.mts.map +1 -1
  35. package/dist/node/index.d.ts +1 -0
  36. package/dist/node/index.d.ts.map +1 -1
  37. package/dist/node/index.js +112 -0
  38. package/dist/node/index.js.map +1 -1
  39. package/dist/node/removeFields.d.cts +2 -0
  40. package/dist/node/removeFields.d.cts.map +1 -0
  41. package/dist/node/removeFields.d.mts +2 -0
  42. package/dist/node/removeFields.d.mts.map +1 -0
  43. package/dist/node/removeFields.d.ts +2 -0
  44. package/dist/node/removeFields.d.ts.map +1 -0
  45. package/package.json +7 -7
  46. package/src/Base.ts +121 -1
  47. package/src/index.ts +1 -0
  48. package/src/removeFields.ts +9 -0
@@ -70,6 +70,9 @@ var isObject = (value) => {
70
70
  // src/asObject.ts
71
71
  var asAnyObject = (() => AsObjectFactory.create((obj) => isObject(obj)))();
72
72
 
73
+ // src/Base.ts
74
+ import { assertEx as assertEx2 } from "@xylabs/assert";
75
+
73
76
  // src/globallyUnique.ts
74
77
  var globallyUnique = (name, value, domain = "global") => {
75
78
  const uniqueName = [domain, name].join(":");
@@ -88,14 +91,50 @@ var globallyUnique = (name, value, domain = "global") => {
88
91
  };
89
92
 
90
93
  // src/Base.ts
94
+ var DEFAULT_HISTORY_INTERVAL = 1e3 * 5;
95
+ var DEFAULT_HISTORY_TIME = 60 * 60 * 1e3;
96
+ var MAX_GC_FREQUENCY = 1e3 * 60;
97
+ var MIN_GC_FREQUENCY = 1e3;
98
+ var MIN_HISTORY_INTERVAL = 1e3;
91
99
  var Base = class _Base {
92
100
  static defaultLogger;
101
+ static globalInstances = {};
102
+ static globalInstancesCountHistory = {};
93
103
  static uniqueName = globallyUnique(this.name, this, "xyo");
104
+ static _historyInterval = DEFAULT_HISTORY_INTERVAL;
105
+ static _historyTime = DEFAULT_HISTORY_TIME;
106
+ static _historyTimeout;
107
+ static _lastGC = 0;
108
+ static _maxGcFrequency = MAX_GC_FREQUENCY;
94
109
  _params;
95
110
  constructor(params) {
96
111
  var _a;
97
112
  this._params = params;
98
113
  (_a = params == null ? void 0 : params.logger) == null ? void 0 : _a.debug(`Base constructed [${Object(this).name}]`);
114
+ this.recordInstance();
115
+ }
116
+ static get historyInterval() {
117
+ return this._historyInterval;
118
+ }
119
+ static set historyInterval(value) {
120
+ assertEx2(value <= this.historyTime, () => `historyInterval [${value}] must be less than or equal to historyTime [${this.historyTime}]`);
121
+ this._historyInterval = Math.max(value, MIN_HISTORY_INTERVAL);
122
+ }
123
+ static get historyTime() {
124
+ return this._historyTime;
125
+ }
126
+ static set historyTime(value) {
127
+ assertEx2(value >= this.historyInterval, () => `historyTime [${value}] must be greater than or equal to historyInterval [${this.historyInterval}]`);
128
+ this._historyInterval = value;
129
+ }
130
+ static get maxGcFrequency() {
131
+ return this._maxGcFrequency;
132
+ }
133
+ static set maxGcFrequency(value) {
134
+ this._maxGcFrequency = Math.max(value, MIN_GC_FREQUENCY);
135
+ }
136
+ static get maxHistoryDepth() {
137
+ return Math.floor(this.historyTime / this.historyInterval);
99
138
  }
100
139
  get logger() {
101
140
  var _a;
@@ -104,6 +143,69 @@ var Base = class _Base {
104
143
  get params() {
105
144
  return this._params;
106
145
  }
146
+ static gc(classNameOrForce = false) {
147
+ if (typeof classNameOrForce === "string") {
148
+ this.gcClass(classNameOrForce);
149
+ } else {
150
+ if (classNameOrForce || Date.now() - this._lastGC > this._maxGcFrequency) {
151
+ this.gcAll();
152
+ }
153
+ }
154
+ }
155
+ static instanceCount(className) {
156
+ var _a;
157
+ return ((_a = this.globalInstances[className]) == null ? void 0 : _a.length) ?? 0;
158
+ }
159
+ static instanceCounts() {
160
+ this.gc();
161
+ const result = {};
162
+ Object.entries(this.globalInstances).map(([className, instances]) => result[className] = instances.length);
163
+ return result;
164
+ }
165
+ static startHistory() {
166
+ if (this._historyTimeout) {
167
+ this.stopHistory();
168
+ }
169
+ const timeoutHandler = () => {
170
+ if (this._historyTimeout) {
171
+ this.addToHistory();
172
+ this._historyTimeout = setTimeout(() => {
173
+ timeoutHandler;
174
+ }, this.historyInterval);
175
+ }
176
+ };
177
+ this._historyTimeout = setTimeout(() => {
178
+ timeoutHandler;
179
+ }, this.historyInterval);
180
+ }
181
+ static stopHistory() {
182
+ if (this._historyTimeout) {
183
+ clearTimeout(this._historyTimeout);
184
+ this._historyTimeout = void 0;
185
+ }
186
+ }
187
+ static addToHistory() {
188
+ var _a;
189
+ const counts = this.instanceCounts();
190
+ for (const className of Object.keys(this.globalInstances)) {
191
+ this.globalInstancesCountHistory[className] = ((_a = this.globalInstancesCountHistory[className]) == null ? void 0 : _a.slice(-this.maxHistoryDepth)) ?? [];
192
+ this.globalInstancesCountHistory[className].push(counts[className]);
193
+ }
194
+ }
195
+ static gcAll() {
196
+ for (const className of Object.keys(this.globalInstances)) {
197
+ this.gcClass(className);
198
+ }
199
+ }
200
+ static gcClass(className) {
201
+ var _a;
202
+ this.globalInstances[className] = ((_a = this.globalInstances[className]) == null ? void 0 : _a.filter((ref) => ref.deref() !== null)) ?? [];
203
+ }
204
+ recordInstance() {
205
+ const instanceArray = _Base.globalInstances[this.constructor.name] ?? [];
206
+ instanceArray.push(new WeakRef(this));
207
+ _Base.globalInstances[this.constructor.name] = instanceArray;
208
+ }
107
209
  };
108
210
 
109
211
  // src/IsObjectFactory.ts
@@ -164,6 +266,15 @@ var ObjectWrapper = class {
164
266
  }
165
267
  };
166
268
 
269
+ // src/removeFields.ts
270
+ var removeFields = (obj, fields) => {
271
+ const clone = { ...obj };
272
+ for (const field of fields) {
273
+ delete clone[field];
274
+ }
275
+ return clone;
276
+ };
277
+
167
278
  // src/toJson.ts
168
279
  var toJsonArray = (value, cycleList, maxDepth = 3) => {
169
280
  return value.map((item) => toJsonValue(item, cycleList, maxDepth));
@@ -226,6 +337,7 @@ export {
226
337
  isObject,
227
338
  isType,
228
339
  isValidJsonFieldPair,
340
+ removeFields,
229
341
  toJson,
230
342
  toJsonString
231
343
  };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/AsTypeFactory.ts","../../src/AsObjectFactory.ts","../../src/isType.ts","../../src/isObject.ts","../../src/asObject.ts","../../src/globallyUnique.ts","../../src/Base.ts","../../src/IsObjectFactory.ts","../../src/JsonObject.ts","../../src/ObjectWrapper.ts","../../src/toJson.ts","../../src/Validator.ts"],"sourcesContent":["import { assertEx, AssertExMessageFunc } from '@xylabs/assert'\nimport { Logger } from '@xylabs/logger'\nimport { AnyNonPromise, isPromise, TypedValue } from '@xylabs/promise'\n\nexport interface TypeCheckConfig {\n log?: boolean | Logger\n}\n\nexport type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>\n\nexport type TypeCheck<T extends TypedValue> = (obj: AnyNonPromise, config?: TypeCheckConfig) => obj is T\n\nexport const AsTypeFactory = {\n // eslint-disable-next-line @typescript-eslint/ban-types\n create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => {\n function func<TType extends T>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n value: AnyNonPromise,\n config?: TypeCheckConfig,\n ): TType | undefined\n function func<TType extends T>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n value: AnyNonPromise,\n assert: StringOrAlertFunction<T>,\n config?: TypeCheckConfig,\n ): TType\n function func<TType extends T>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n value: AnyNonPromise,\n assertOrConfig?: StringOrAlertFunction<T> | TypeCheckConfig,\n config?: TypeCheckConfig,\n ): TType | undefined {\n if (value === undefined) {\n return undefined\n }\n\n if (value === null) {\n return undefined\n }\n\n if (isPromise(value)) {\n throw new TypeError('un-awaited promises may not be sent to \"as\" functions')\n }\n\n const resolvedAssert = (typeof assertOrConfig === 'object' ? undefined : assertOrConfig) as StringOrAlertFunction<T> | undefined\n const resolvedConfig = typeof assertOrConfig === 'object' ? assertOrConfig : config\n const result = typeCheck(value, resolvedConfig) ? (value as TType) : undefined\n\n if (resolvedAssert) {\n if (typeof resolvedAssert === 'function') {\n assertEx<T>(result, resolvedAssert)\n } else {\n assertEx<T>(result, () => resolvedAssert)\n }\n }\n return result\n }\n return func\n },\n}\n","import { TypedObject } from '@xylabs/promise'\n\nimport { AsTypeFactory, TypeCheck } from './AsTypeFactory'\n\nexport const AsObjectFactory = {\n create: <T extends TypedObject>(typeCheck: TypeCheck<T>) => {\n return AsTypeFactory.create<T>(typeCheck)\n },\n}\n","/* eslint-disable @typescript-eslint/no-explicit-any */\n\nexport type FieldType = 'string' | 'number' | 'object' | 'symbol' | 'symbol' | 'undefined' | 'null' | 'array' | 'function'\n\nexport type ObjectTypeShape = Record<string | number | symbol, FieldType>\n\nexport const isType = (value: unknown, expectedType: FieldType) => {\n const typeofValue = typeof value\n switch (expectedType) {\n case 'array': {\n return Array.isArray(value)\n }\n case 'null': {\n return value === null\n }\n case 'undefined': {\n return value === undefined\n }\n case 'object': {\n //nulls resolve to objects, so exclude them\n if (value === null) {\n return false\n }\n //arrays resolve to objects, so exclude them\n return typeofValue === 'object' && !Array.isArray(value)\n }\n default: {\n return typeofValue === expectedType\n }\n }\n}\n","import { AnyObject } from './AnyObject'\nimport { isType } from './isType'\n\nexport const isObject = (value: unknown): value is AnyObject => {\n return isType(value, 'object')\n}\n","import { AnyObject } from './AnyObject'\nimport { AsObjectFactory } from './AsObjectFactory'\nimport { isObject } from './isObject'\n\nexport const asAnyObject = (() => AsObjectFactory.create<AnyObject>(<T extends AnyObject>(obj: unknown): obj is T => isObject(obj)))()\n","interface XylabsGlobalThis {\n xylabs: {\n unique: Record<string, unknown>\n }\n}\n\nexport const globallyUnique = (name: string, value: unknown, domain = 'global') => {\n const uniqueName = [domain, name].join(':')\n const xyo = ((globalThis as unknown as XylabsGlobalThis).xylabs = (globalThis as unknown as XylabsGlobalThis).xylabs ?? {})\n const unique = (xyo.unique = xyo.unique ?? {})\n if (unique[uniqueName] === undefined) {\n unique[uniqueName] = value\n } else {\n if (unique[uniqueName] !== value) {\n throw new Error(\n `Global unique item ${uniqueName} already defined. Make sure you are not importing two versions of the package that contains this item`,\n )\n }\n }\n return uniqueName\n}\n","import { Logger } from '@xylabs/logger'\n\nimport { EmptyObject } from './EmptyObject'\nimport { globallyUnique } from './globallyUnique'\n\nexport type BaseParamsFields = {\n logger?: Logger\n}\n\nexport type BaseParams<TAdditionalParams extends EmptyObject | void = void> =\n TAdditionalParams extends EmptyObject ? BaseParamsFields & TAdditionalParams : BaseParamsFields\n\nexport abstract class Base<TParams extends BaseParams | undefined = BaseParams> {\n static defaultLogger?: Logger\n static readonly uniqueName = globallyUnique(this.name, this, 'xyo')\n\n private _params: TParams\n\n constructor(params: TParams) {\n this._params = params\n params?.logger?.debug(`Base constructed [${Object(this).name}]`)\n }\n\n get logger() {\n return this.params?.logger ?? Base.defaultLogger\n }\n\n get params() {\n return this._params\n }\n}\n","import { TypedObject } from '@xylabs/promise'\n\nimport { TypeCheck, TypeCheckConfig } from './AsTypeFactory'\nimport { isType, ObjectTypeShape } from './isType'\n\nexport interface ObjectTypeConfig extends TypeCheckConfig {}\n\nexport class IsObjectFactory<T extends TypedObject> {\n create(shape?: ObjectTypeShape, additionalChecks?: TypeCheck<TypedObject>[]): TypeCheck<T> {\n return (obj, { log } = {}): obj is T => {\n if (!obj || typeof obj !== 'object') {\n return false\n }\n return (\n //do primary check\n Object.entries(shape ?? {}).filter(([key, type]) => {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const result = isType((obj as any)[key], type)\n if (!result && log) {\n const logger = typeof log === 'object' ? log : console\n logger.warn(`isType Failed: ${key}: ${type}`)\n }\n return !result\n }).length === 0 &&\n //perform additional checks\n (additionalChecks?.reduce((prev, check) => prev && check(obj, { log }), true) ?? true)\n )\n }\n }\n}\n","import { isObject } from './isObject'\n\nexport type JsonValue = string | number | boolean | null | JsonObject | JsonArray\nexport type JsonObject = { [key: string]: JsonValue }\nexport type JsonArray = JsonValue[]\n\nexport const isJsonValue = (value: unknown): value is JsonValue => {\n switch (typeof value) {\n case 'string':\n case 'number':\n case 'boolean': {\n return true\n }\n default: {\n return value === null || isJsonObject(value) || isJsonArray(value)\n }\n }\n}\n\nexport const isJsonArray = (value: unknown): value is JsonArray => {\n return Array.isArray(value) && !value.some((item) => !isJsonValue(item))\n}\n\nexport const isValidJsonFieldPair = ([key, value]: [key: unknown, value: unknown]) => {\n return typeof key === 'string' && isJsonValue(value)\n}\n\nexport const isJsonObject = (value: unknown): value is JsonObject => {\n return (\n isObject(value) &&\n //check if all keys are strings\n !Object.entries(value).some((item) => !isValidJsonFieldPair(item))\n )\n}\n","import { EmptyObject } from './EmptyObject'\nimport { StringKeyObject } from './StringKeyObject'\n\nexport abstract class ObjectWrapper<T extends EmptyObject = EmptyObject> {\n readonly obj: T\n constructor(obj: T) {\n this.obj = obj\n }\n protected get stringKeyObj() {\n return this.obj as StringKeyObject\n }\n}\n","import { JsonArray, JsonObject, JsonValue } from './JsonObject'\n\nconst toJsonArray = (value: unknown[], cycleList?: unknown[], maxDepth = 3): JsonArray => {\n return value.map((item) => toJsonValue(item, cycleList, maxDepth))\n}\n\nconst toJsonObject = (value: object, cycleList?: unknown[], maxDepth = 3): JsonObject => {\n const result: JsonObject = {}\n for (const [key, entry] of Object.entries(value)) {\n result[key] = value === undefined ? '[Undefined]' : toJsonValue(entry, cycleList, maxDepth)\n }\n return result\n}\n\nconst toJsonValue = (value: unknown, cycleList?: unknown[], maxDepth = 3): JsonValue => {\n if (maxDepth <= 0 && typeof value === 'object') {\n return '[MaxDepth]'\n }\n if (cycleList?.includes(value)) {\n return '[Circular]'\n }\n switch (typeof value) {\n case 'string':\n case 'boolean':\n case 'number': {\n return value\n }\n case 'object': {\n if (value === null) {\n return null\n }\n const newCycleList = cycleList ?? []\n newCycleList.push(value)\n return Array.isArray(value) ? toJsonArray(value, newCycleList, maxDepth - 1) : toJsonObject(value, newCycleList, maxDepth - 1)\n }\n default: {\n return `[${typeof value}]`\n }\n }\n}\n\nexport const toJsonString = (value: unknown, maxDepth = 3) => {\n return JSON.stringify(toJson(value, maxDepth), null, 2)\n}\n\nexport const toJson = (value: unknown, maxDepth = 3): JsonValue => {\n return toJsonValue(value, undefined, maxDepth)\n}\n","import { Promisable } from '@xylabs/promise'\n\nimport { AnyObject } from './AnyObject'\nimport { EmptyObject } from './EmptyObject'\nimport { ObjectWrapper } from './ObjectWrapper'\n\nexport interface Validator<T extends EmptyObject = AnyObject> {\n validate(payload: T): Promisable<Error[]>\n}\n\nexport abstract class ValidatorBase<T extends EmptyObject = AnyObject> extends ObjectWrapper<Partial<T>> implements Validator<T> {\n abstract validate(payload: T): Promisable<Error[]>\n}\n"],"mappings":";AAAA,SAAS,gBAAqC;AAE9C,SAAwB,iBAA6B;AAU9C,IAAM,gBAAgB;AAAA;AAAA,EAE3B,QAAQ,CAA0B,cAA4B;AAY5D,aAAS,KAEP,OACA,gBACA,QACmB;AACnB,UAAI,UAAU,QAAW;AACvB,eAAO;AAAA,MACT;AAEA,UAAI,UAAU,MAAM;AAClB,eAAO;AAAA,MACT;AAEA,UAAI,UAAU,KAAK,GAAG;AACpB,cAAM,IAAI,UAAU,uDAAuD;AAAA,MAC7E;AAEA,YAAM,iBAAkB,OAAO,mBAAmB,WAAW,SAAY;AACzE,YAAM,iBAAiB,OAAO,mBAAmB,WAAW,iBAAiB;AAC7E,YAAM,SAAS,UAAU,OAAO,cAAc,IAAK,QAAkB;AAErE,UAAI,gBAAgB;AAClB,YAAI,OAAO,mBAAmB,YAAY;AACxC,mBAAY,QAAQ,cAAc;AAAA,QACpC,OAAO;AACL,mBAAY,QAAQ,MAAM,cAAc;AAAA,QAC1C;AAAA,MACF;AACA,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;;;ACvDO,IAAM,kBAAkB;AAAA,EAC7B,QAAQ,CAAwB,cAA4B;AAC1D,WAAO,cAAc,OAAU,SAAS;AAAA,EAC1C;AACF;;;ACFO,IAAM,SAAS,CAAC,OAAgB,iBAA4B;AACjE,QAAM,cAAc,OAAO;AAC3B,UAAQ,cAAc;AAAA,IACpB,KAAK,SAAS;AACZ,aAAO,MAAM,QAAQ,KAAK;AAAA,IAC5B;AAAA,IACA,KAAK,QAAQ;AACX,aAAO,UAAU;AAAA,IACnB;AAAA,IACA,KAAK,aAAa;AAChB,aAAO,UAAU;AAAA,IACnB;AAAA,IACA,KAAK,UAAU;AAEb,UAAI,UAAU,MAAM;AAClB,eAAO;AAAA,MACT;AAEA,aAAO,gBAAgB,YAAY,CAAC,MAAM,QAAQ,KAAK;AAAA,IACzD;AAAA,IACA,SAAS;AACP,aAAO,gBAAgB;AAAA,IACzB;AAAA,EACF;AACF;;;AC3BO,IAAM,WAAW,CAAC,UAAuC;AAC9D,SAAO,OAAO,OAAO,QAAQ;AAC/B;;;ACDO,IAAM,eAAe,MAAM,gBAAgB,OAAkB,CAAsB,QAA2B,SAAS,GAAG,CAAC,GAAG;;;ACE9H,IAAM,iBAAiB,CAAC,MAAc,OAAgB,SAAS,aAAa;AACjF,QAAM,aAAa,CAAC,QAAQ,IAAI,EAAE,KAAK,GAAG;AAC1C,QAAM,MAAQ,WAA2C,SAAU,WAA2C,UAAU,CAAC;AACzH,QAAM,SAAU,IAAI,SAAS,IAAI,UAAU,CAAC;AAC5C,MAAI,OAAO,UAAU,MAAM,QAAW;AACpC,WAAO,UAAU,IAAI;AAAA,EACvB,OAAO;AACL,QAAI,OAAO,UAAU,MAAM,OAAO;AAChC,YAAM,IAAI;AAAA,QACR,sBAAsB,UAAU;AAAA,MAClC;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;;;ACRO,IAAe,OAAf,MAAe,MAA0D;AAAA,EAC9E,OAAO;AAAA,EACP,OAAgB,aAAa,eAAe,KAAK,MAAM,MAAM,KAAK;AAAA,EAE1D;AAAA,EAER,YAAY,QAAiB;AAlB/B;AAmBI,SAAK,UAAU;AACf,2CAAQ,WAAR,mBAAgB,MAAM,qBAAqB,OAAO,IAAI,EAAE,IAAI;AAAA,EAC9D;AAAA,EAEA,IAAI,SAAS;AAvBf;AAwBI,aAAO,UAAK,WAAL,mBAAa,WAAU,MAAK;AAAA,EACrC;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK;AAAA,EACd;AACF;;;ACvBO,IAAM,kBAAN,MAA6C;AAAA,EAClD,OAAO,OAAyB,kBAA2D;AACzF,WAAO,CAAC,KAAK,EAAE,IAAI,IAAI,CAAC,MAAgB;AACtC,UAAI,CAAC,OAAO,OAAO,QAAQ,UAAU;AACnC,eAAO;AAAA,MACT;AACA;AAAA;AAAA,QAEE,OAAO,QAAQ,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,KAAK,IAAI,MAAM;AAElD,gBAAM,SAAS,OAAQ,IAAY,GAAG,GAAG,IAAI;AAC7C,cAAI,CAAC,UAAU,KAAK;AAClB,kBAAM,SAAS,OAAO,QAAQ,WAAW,MAAM;AAC/C,mBAAO,KAAK,kBAAkB,GAAG,KAAK,IAAI,EAAE;AAAA,UAC9C;AACA,iBAAO,CAAC;AAAA,QACV,CAAC,EAAE,WAAW;AAAA,UAEb,qDAAkB,OAAO,CAAC,MAAM,UAAU,QAAQ,MAAM,KAAK,EAAE,IAAI,CAAC,GAAG,UAAS;AAAA;AAAA,IAErF;AAAA,EACF;AACF;;;ACvBO,IAAM,cAAc,CAAC,UAAuC;AACjE,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK,WAAW;AACd,aAAO;AAAA,IACT;AAAA,IACA,SAAS;AACP,aAAO,UAAU,QAAQ,aAAa,KAAK,KAAK,YAAY,KAAK;AAAA,IACnE;AAAA,EACF;AACF;AAEO,IAAM,cAAc,CAAC,UAAuC;AACjE,SAAO,MAAM,QAAQ,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,YAAY,IAAI,CAAC;AACzE;AAEO,IAAM,uBAAuB,CAAC,CAAC,KAAK,KAAK,MAAsC;AACpF,SAAO,OAAO,QAAQ,YAAY,YAAY,KAAK;AACrD;AAEO,IAAM,eAAe,CAAC,UAAwC;AACnE,SACE,SAAS,KAAK;AAAA,EAEd,CAAC,OAAO,QAAQ,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,qBAAqB,IAAI,CAAC;AAErE;;;AC9BO,IAAe,gBAAf,MAAkE;AAAA,EAC9D;AAAA,EACT,YAAY,KAAQ;AAClB,SAAK,MAAM;AAAA,EACb;AAAA,EACA,IAAc,eAAe;AAC3B,WAAO,KAAK;AAAA,EACd;AACF;;;ACTA,IAAM,cAAc,CAAC,OAAkB,WAAuB,WAAW,MAAiB;AACxF,SAAO,MAAM,IAAI,CAAC,SAAS,YAAY,MAAM,WAAW,QAAQ,CAAC;AACnE;AAEA,IAAM,eAAe,CAAC,OAAe,WAAuB,WAAW,MAAkB;AACvF,QAAM,SAAqB,CAAC;AAC5B,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,WAAO,GAAG,IAAI,UAAU,SAAY,gBAAgB,YAAY,OAAO,WAAW,QAAQ;AAAA,EAC5F;AACA,SAAO;AACT;AAEA,IAAM,cAAc,CAAC,OAAgB,WAAuB,WAAW,MAAiB;AACtF,MAAI,YAAY,KAAK,OAAO,UAAU,UAAU;AAC9C,WAAO;AAAA,EACT;AACA,MAAI,uCAAW,SAAS,QAAQ;AAC9B,WAAO;AAAA,EACT;AACA,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK,UAAU;AACb,aAAO;AAAA,IACT;AAAA,IACA,KAAK,UAAU;AACb,UAAI,UAAU,MAAM;AAClB,eAAO;AAAA,MACT;AACA,YAAM,eAAe,aAAa,CAAC;AACnC,mBAAa,KAAK,KAAK;AACvB,aAAO,MAAM,QAAQ,KAAK,IAAI,YAAY,OAAO,cAAc,WAAW,CAAC,IAAI,aAAa,OAAO,cAAc,WAAW,CAAC;AAAA,IAC/H;AAAA,IACA,SAAS;AACP,aAAO,IAAI,OAAO,KAAK;AAAA,IACzB;AAAA,EACF;AACF;AAEO,IAAM,eAAe,CAAC,OAAgB,WAAW,MAAM;AAC5D,SAAO,KAAK,UAAU,OAAO,OAAO,QAAQ,GAAG,MAAM,CAAC;AACxD;AAEO,IAAM,SAAS,CAAC,OAAgB,WAAW,MAAiB;AACjE,SAAO,YAAY,OAAO,QAAW,QAAQ;AAC/C;;;ACrCO,IAAe,gBAAf,cAAwE,cAAkD;AAEjI;","names":[]}
1
+ {"version":3,"sources":["../../src/AsTypeFactory.ts","../../src/AsObjectFactory.ts","../../src/isType.ts","../../src/isObject.ts","../../src/asObject.ts","../../src/Base.ts","../../src/globallyUnique.ts","../../src/IsObjectFactory.ts","../../src/JsonObject.ts","../../src/ObjectWrapper.ts","../../src/removeFields.ts","../../src/toJson.ts","../../src/Validator.ts"],"sourcesContent":["import { assertEx, AssertExMessageFunc } from '@xylabs/assert'\nimport { Logger } from '@xylabs/logger'\nimport { AnyNonPromise, isPromise, TypedValue } from '@xylabs/promise'\n\nexport interface TypeCheckConfig {\n log?: boolean | Logger\n}\n\nexport type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>\n\nexport type TypeCheck<T extends TypedValue> = (obj: AnyNonPromise, config?: TypeCheckConfig) => obj is T\n\nexport const AsTypeFactory = {\n // eslint-disable-next-line @typescript-eslint/ban-types\n create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => {\n function func<TType extends T>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n value: AnyNonPromise,\n config?: TypeCheckConfig,\n ): TType | undefined\n function func<TType extends T>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n value: AnyNonPromise,\n assert: StringOrAlertFunction<T>,\n config?: TypeCheckConfig,\n ): TType\n function func<TType extends T>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n value: AnyNonPromise,\n assertOrConfig?: StringOrAlertFunction<T> | TypeCheckConfig,\n config?: TypeCheckConfig,\n ): TType | undefined {\n if (value === undefined) {\n return undefined\n }\n\n if (value === null) {\n return undefined\n }\n\n if (isPromise(value)) {\n throw new TypeError('un-awaited promises may not be sent to \"as\" functions')\n }\n\n const resolvedAssert = (typeof assertOrConfig === 'object' ? undefined : assertOrConfig) as StringOrAlertFunction<T> | undefined\n const resolvedConfig = typeof assertOrConfig === 'object' ? assertOrConfig : config\n const result = typeCheck(value, resolvedConfig) ? (value as TType) : undefined\n\n if (resolvedAssert) {\n if (typeof resolvedAssert === 'function') {\n assertEx<T>(result, resolvedAssert)\n } else {\n assertEx<T>(result, () => resolvedAssert)\n }\n }\n return result\n }\n return func\n },\n}\n","import { TypedObject } from '@xylabs/promise'\n\nimport { AsTypeFactory, TypeCheck } from './AsTypeFactory'\n\nexport const AsObjectFactory = {\n create: <T extends TypedObject>(typeCheck: TypeCheck<T>) => {\n return AsTypeFactory.create<T>(typeCheck)\n },\n}\n","/* eslint-disable @typescript-eslint/no-explicit-any */\n\nexport type FieldType = 'string' | 'number' | 'object' | 'symbol' | 'symbol' | 'undefined' | 'null' | 'array' | 'function'\n\nexport type ObjectTypeShape = Record<string | number | symbol, FieldType>\n\nexport const isType = (value: unknown, expectedType: FieldType) => {\n const typeofValue = typeof value\n switch (expectedType) {\n case 'array': {\n return Array.isArray(value)\n }\n case 'null': {\n return value === null\n }\n case 'undefined': {\n return value === undefined\n }\n case 'object': {\n //nulls resolve to objects, so exclude them\n if (value === null) {\n return false\n }\n //arrays resolve to objects, so exclude them\n return typeofValue === 'object' && !Array.isArray(value)\n }\n default: {\n return typeofValue === expectedType\n }\n }\n}\n","import { AnyObject } from './AnyObject'\nimport { isType } from './isType'\n\nexport const isObject = (value: unknown): value is AnyObject => {\n return isType(value, 'object')\n}\n","import { AnyObject } from './AnyObject'\nimport { AsObjectFactory } from './AsObjectFactory'\nimport { isObject } from './isObject'\n\nexport const asAnyObject = (() => AsObjectFactory.create<AnyObject>(<T extends AnyObject>(obj: unknown): obj is T => isObject(obj)))()\n","import { assertEx } from '@xylabs/assert'\nimport { Logger } from '@xylabs/logger'\n\nimport { EmptyObject } from './EmptyObject'\nimport { globallyUnique } from './globallyUnique'\n\nconst DEFAULT_HISTORY_INTERVAL = 1000 * 5\nconst DEFAULT_HISTORY_TIME = 60 * 60 * 1000\nconst MAX_GC_FREQUENCY = 1000 * 60\nconst MIN_GC_FREQUENCY = 1000\nconst MIN_HISTORY_INTERVAL = 1000\n\nexport type BaseClassName = Exclude<string, 'base-class-name-reserved-32546239486'>\n\nexport type BaseParamsFields = {\n logger?: Logger\n}\n\nexport type BaseParams<TAdditionalParams extends EmptyObject | void = void> =\n TAdditionalParams extends EmptyObject ? BaseParamsFields & TAdditionalParams : BaseParamsFields\n\nexport abstract class Base<TParams extends BaseParams | undefined = BaseParams> {\n static defaultLogger?: Logger\n static readonly globalInstances: Record<BaseClassName, WeakRef<Base<BaseParams | undefined>>[]> = {}\n static readonly globalInstancesCountHistory: Record<BaseClassName, number[]> = {}\n static readonly uniqueName = globallyUnique(this.name, this, 'xyo')\n private static _historyInterval = DEFAULT_HISTORY_INTERVAL\n private static _historyTime = DEFAULT_HISTORY_TIME\n private static _historyTimeout?: ReturnType<typeof setTimeout>\n private static _lastGC = 0\n private static _maxGcFrequency = MAX_GC_FREQUENCY\n private _params: TParams\n\n constructor(params: TParams) {\n this._params = params\n params?.logger?.debug(`Base constructed [${Object(this).name}]`)\n this.recordInstance()\n }\n\n static get historyInterval() {\n return this._historyInterval\n }\n\n static set historyInterval(value: number) {\n assertEx(value <= this.historyTime, () => `historyInterval [${value}] must be less than or equal to historyTime [${this.historyTime}]`)\n this._historyInterval = Math.max(value, MIN_HISTORY_INTERVAL)\n }\n\n static get historyTime() {\n return this._historyTime\n }\n\n static set historyTime(value: number) {\n assertEx(value >= this.historyInterval, () => `historyTime [${value}] must be greater than or equal to historyInterval [${this.historyInterval}]`)\n this._historyInterval = value\n }\n\n static get maxGcFrequency() {\n return this._maxGcFrequency\n }\n\n static set maxGcFrequency(value: number) {\n this._maxGcFrequency = Math.max(value, MIN_GC_FREQUENCY)\n }\n\n static get maxHistoryDepth() {\n return Math.floor(this.historyTime / this.historyInterval)\n }\n\n get logger() {\n return this.params?.logger ?? Base.defaultLogger\n }\n\n get params() {\n return this._params\n }\n\n static gc(force?: boolean): void\n static gc(className: string): void\n static gc(classNameOrForce: string | boolean = false): void {\n if (typeof classNameOrForce === 'string') {\n this.gcClass(classNameOrForce)\n } else {\n if (classNameOrForce || Date.now() - this._lastGC > this._maxGcFrequency) {\n this.gcAll()\n }\n }\n }\n\n static instanceCount(className: string): number {\n return this.globalInstances[className]?.length ?? 0\n }\n\n static instanceCounts(): Record<BaseClassName, number> {\n this.gc()\n const result: Record<BaseClassName, number> = {}\n Object.entries(this.globalInstances).map(([className, instances]) => (result[className] = instances.length))\n return result\n }\n\n static startHistory(): void {\n if (this._historyTimeout) {\n this.stopHistory()\n }\n\n const timeoutHandler = () => {\n if (this._historyTimeout) {\n this.addToHistory()\n this._historyTimeout = setTimeout(() => {\n timeoutHandler\n }, this.historyInterval)\n }\n }\n\n this._historyTimeout = setTimeout(() => {\n timeoutHandler\n }, this.historyInterval)\n }\n\n static stopHistory(): void {\n if (this._historyTimeout) {\n clearTimeout(this._historyTimeout)\n this._historyTimeout = undefined\n }\n }\n\n private static addToHistory() {\n const counts = this.instanceCounts()\n for (const className of Object.keys(this.globalInstances)) {\n this.globalInstancesCountHistory[className] = this.globalInstancesCountHistory[className]?.slice(-this.maxHistoryDepth) ?? []\n this.globalInstancesCountHistory[className].push(counts[className])\n }\n }\n\n private static gcAll() {\n for (const className of Object.keys(this.globalInstances)) {\n this.gcClass(className)\n }\n }\n\n private static gcClass(className: BaseClassName) {\n //remove all the weak refs that are now empty\n this.globalInstances[className] = this.globalInstances[className]?.filter((ref) => ref.deref() !== null) ?? []\n }\n\n private recordInstance() {\n const instanceArray = Base.globalInstances[this.constructor.name] ?? []\n instanceArray.push(new WeakRef(this))\n Base.globalInstances[this.constructor.name] = instanceArray\n }\n}\n","interface XylabsGlobalThis {\n xylabs: {\n unique: Record<string, unknown>\n }\n}\n\nexport const globallyUnique = (name: string, value: unknown, domain = 'global') => {\n const uniqueName = [domain, name].join(':')\n const xyo = ((globalThis as unknown as XylabsGlobalThis).xylabs = (globalThis as unknown as XylabsGlobalThis).xylabs ?? {})\n const unique = (xyo.unique = xyo.unique ?? {})\n if (unique[uniqueName] === undefined) {\n unique[uniqueName] = value\n } else {\n if (unique[uniqueName] !== value) {\n throw new Error(\n `Global unique item ${uniqueName} already defined. Make sure you are not importing two versions of the package that contains this item`,\n )\n }\n }\n return uniqueName\n}\n","import { TypedObject } from '@xylabs/promise'\n\nimport { TypeCheck, TypeCheckConfig } from './AsTypeFactory'\nimport { isType, ObjectTypeShape } from './isType'\n\nexport interface ObjectTypeConfig extends TypeCheckConfig {}\n\nexport class IsObjectFactory<T extends TypedObject> {\n create(shape?: ObjectTypeShape, additionalChecks?: TypeCheck<TypedObject>[]): TypeCheck<T> {\n return (obj, { log } = {}): obj is T => {\n if (!obj || typeof obj !== 'object') {\n return false\n }\n return (\n //do primary check\n Object.entries(shape ?? {}).filter(([key, type]) => {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const result = isType((obj as any)[key], type)\n if (!result && log) {\n const logger = typeof log === 'object' ? log : console\n logger.warn(`isType Failed: ${key}: ${type}`)\n }\n return !result\n }).length === 0 &&\n //perform additional checks\n (additionalChecks?.reduce((prev, check) => prev && check(obj, { log }), true) ?? true)\n )\n }\n }\n}\n","import { isObject } from './isObject'\n\nexport type JsonValue = string | number | boolean | null | JsonObject | JsonArray\nexport type JsonObject = { [key: string]: JsonValue }\nexport type JsonArray = JsonValue[]\n\nexport const isJsonValue = (value: unknown): value is JsonValue => {\n switch (typeof value) {\n case 'string':\n case 'number':\n case 'boolean': {\n return true\n }\n default: {\n return value === null || isJsonObject(value) || isJsonArray(value)\n }\n }\n}\n\nexport const isJsonArray = (value: unknown): value is JsonArray => {\n return Array.isArray(value) && !value.some((item) => !isJsonValue(item))\n}\n\nexport const isValidJsonFieldPair = ([key, value]: [key: unknown, value: unknown]) => {\n return typeof key === 'string' && isJsonValue(value)\n}\n\nexport const isJsonObject = (value: unknown): value is JsonObject => {\n return (\n isObject(value) &&\n //check if all keys are strings\n !Object.entries(value).some((item) => !isValidJsonFieldPair(item))\n )\n}\n","import { EmptyObject } from './EmptyObject'\nimport { StringKeyObject } from './StringKeyObject'\n\nexport abstract class ObjectWrapper<T extends EmptyObject = EmptyObject> {\n readonly obj: T\n constructor(obj: T) {\n this.obj = obj\n }\n protected get stringKeyObj() {\n return this.obj as StringKeyObject\n }\n}\n","import { EmptyObject } from './EmptyObject'\n\nexport const removeFields = <T extends EmptyObject, K extends keyof T>(obj: T, fields: K[]): Omit<T, K> => {\n const clone = { ...obj }\n for (const field of fields) {\n delete clone[field]\n }\n return clone\n}\n","import { JsonArray, JsonObject, JsonValue } from './JsonObject'\n\nconst toJsonArray = (value: unknown[], cycleList?: unknown[], maxDepth = 3): JsonArray => {\n return value.map((item) => toJsonValue(item, cycleList, maxDepth))\n}\n\nconst toJsonObject = (value: object, cycleList?: unknown[], maxDepth = 3): JsonObject => {\n const result: JsonObject = {}\n for (const [key, entry] of Object.entries(value)) {\n result[key] = value === undefined ? '[Undefined]' : toJsonValue(entry, cycleList, maxDepth)\n }\n return result\n}\n\nconst toJsonValue = (value: unknown, cycleList?: unknown[], maxDepth = 3): JsonValue => {\n if (maxDepth <= 0 && typeof value === 'object') {\n return '[MaxDepth]'\n }\n if (cycleList?.includes(value)) {\n return '[Circular]'\n }\n switch (typeof value) {\n case 'string':\n case 'boolean':\n case 'number': {\n return value\n }\n case 'object': {\n if (value === null) {\n return null\n }\n const newCycleList = cycleList ?? []\n newCycleList.push(value)\n return Array.isArray(value) ? toJsonArray(value, newCycleList, maxDepth - 1) : toJsonObject(value, newCycleList, maxDepth - 1)\n }\n default: {\n return `[${typeof value}]`\n }\n }\n}\n\nexport const toJsonString = (value: unknown, maxDepth = 3) => {\n return JSON.stringify(toJson(value, maxDepth), null, 2)\n}\n\nexport const toJson = (value: unknown, maxDepth = 3): JsonValue => {\n return toJsonValue(value, undefined, maxDepth)\n}\n","import { Promisable } from '@xylabs/promise'\n\nimport { AnyObject } from './AnyObject'\nimport { EmptyObject } from './EmptyObject'\nimport { ObjectWrapper } from './ObjectWrapper'\n\nexport interface Validator<T extends EmptyObject = AnyObject> {\n validate(payload: T): Promisable<Error[]>\n}\n\nexport abstract class ValidatorBase<T extends EmptyObject = AnyObject> extends ObjectWrapper<Partial<T>> implements Validator<T> {\n abstract validate(payload: T): Promisable<Error[]>\n}\n"],"mappings":";AAAA,SAAS,gBAAqC;AAE9C,SAAwB,iBAA6B;AAU9C,IAAM,gBAAgB;AAAA;AAAA,EAE3B,QAAQ,CAA0B,cAA4B;AAY5D,aAAS,KAEP,OACA,gBACA,QACmB;AACnB,UAAI,UAAU,QAAW;AACvB,eAAO;AAAA,MACT;AAEA,UAAI,UAAU,MAAM;AAClB,eAAO;AAAA,MACT;AAEA,UAAI,UAAU,KAAK,GAAG;AACpB,cAAM,IAAI,UAAU,uDAAuD;AAAA,MAC7E;AAEA,YAAM,iBAAkB,OAAO,mBAAmB,WAAW,SAAY;AACzE,YAAM,iBAAiB,OAAO,mBAAmB,WAAW,iBAAiB;AAC7E,YAAM,SAAS,UAAU,OAAO,cAAc,IAAK,QAAkB;AAErE,UAAI,gBAAgB;AAClB,YAAI,OAAO,mBAAmB,YAAY;AACxC,mBAAY,QAAQ,cAAc;AAAA,QACpC,OAAO;AACL,mBAAY,QAAQ,MAAM,cAAc;AAAA,QAC1C;AAAA,MACF;AACA,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACF;;;ACvDO,IAAM,kBAAkB;AAAA,EAC7B,QAAQ,CAAwB,cAA4B;AAC1D,WAAO,cAAc,OAAU,SAAS;AAAA,EAC1C;AACF;;;ACFO,IAAM,SAAS,CAAC,OAAgB,iBAA4B;AACjE,QAAM,cAAc,OAAO;AAC3B,UAAQ,cAAc;AAAA,IACpB,KAAK,SAAS;AACZ,aAAO,MAAM,QAAQ,KAAK;AAAA,IAC5B;AAAA,IACA,KAAK,QAAQ;AACX,aAAO,UAAU;AAAA,IACnB;AAAA,IACA,KAAK,aAAa;AAChB,aAAO,UAAU;AAAA,IACnB;AAAA,IACA,KAAK,UAAU;AAEb,UAAI,UAAU,MAAM;AAClB,eAAO;AAAA,MACT;AAEA,aAAO,gBAAgB,YAAY,CAAC,MAAM,QAAQ,KAAK;AAAA,IACzD;AAAA,IACA,SAAS;AACP,aAAO,gBAAgB;AAAA,IACzB;AAAA,EACF;AACF;;;AC3BO,IAAM,WAAW,CAAC,UAAuC;AAC9D,SAAO,OAAO,OAAO,QAAQ;AAC/B;;;ACDO,IAAM,eAAe,MAAM,gBAAgB,OAAkB,CAAsB,QAA2B,SAAS,GAAG,CAAC,GAAG;;;ACJrI,SAAS,YAAAA,iBAAgB;;;ACMlB,IAAM,iBAAiB,CAAC,MAAc,OAAgB,SAAS,aAAa;AACjF,QAAM,aAAa,CAAC,QAAQ,IAAI,EAAE,KAAK,GAAG;AAC1C,QAAM,MAAQ,WAA2C,SAAU,WAA2C,UAAU,CAAC;AACzH,QAAM,SAAU,IAAI,SAAS,IAAI,UAAU,CAAC;AAC5C,MAAI,OAAO,UAAU,MAAM,QAAW;AACpC,WAAO,UAAU,IAAI;AAAA,EACvB,OAAO;AACL,QAAI,OAAO,UAAU,MAAM,OAAO;AAChC,YAAM,IAAI;AAAA,QACR,sBAAsB,UAAU;AAAA,MAClC;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;;;ADdA,IAAM,2BAA2B,MAAO;AACxC,IAAM,uBAAuB,KAAK,KAAK;AACvC,IAAM,mBAAmB,MAAO;AAChC,IAAM,mBAAmB;AACzB,IAAM,uBAAuB;AAWtB,IAAe,OAAf,MAAe,MAA0D;AAAA,EAC9E,OAAO;AAAA,EACP,OAAgB,kBAAkF,CAAC;AAAA,EACnG,OAAgB,8BAA+D,CAAC;AAAA,EAChF,OAAgB,aAAa,eAAe,KAAK,MAAM,MAAM,KAAK;AAAA,EAClE,OAAe,mBAAmB;AAAA,EAClC,OAAe,eAAe;AAAA,EAC9B,OAAe;AAAA,EACf,OAAe,UAAU;AAAA,EACzB,OAAe,kBAAkB;AAAA,EACzB;AAAA,EAER,YAAY,QAAiB;AAjC/B;AAkCI,SAAK,UAAU;AACf,2CAAQ,WAAR,mBAAgB,MAAM,qBAAqB,OAAO,IAAI,EAAE,IAAI;AAC5D,SAAK,eAAe;AAAA,EACtB;AAAA,EAEA,WAAW,kBAAkB;AAC3B,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,WAAW,gBAAgB,OAAe;AACxC,IAAAC,UAAS,SAAS,KAAK,aAAa,MAAM,oBAAoB,KAAK,gDAAgD,KAAK,WAAW,GAAG;AACtI,SAAK,mBAAmB,KAAK,IAAI,OAAO,oBAAoB;AAAA,EAC9D;AAAA,EAEA,WAAW,cAAc;AACvB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,WAAW,YAAY,OAAe;AACpC,IAAAA,UAAS,SAAS,KAAK,iBAAiB,MAAM,gBAAgB,KAAK,uDAAuD,KAAK,eAAe,GAAG;AACjJ,SAAK,mBAAmB;AAAA,EAC1B;AAAA,EAEA,WAAW,iBAAiB;AAC1B,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,WAAW,eAAe,OAAe;AACvC,SAAK,kBAAkB,KAAK,IAAI,OAAO,gBAAgB;AAAA,EACzD;AAAA,EAEA,WAAW,kBAAkB;AAC3B,WAAO,KAAK,MAAM,KAAK,cAAc,KAAK,eAAe;AAAA,EAC3D;AAAA,EAEA,IAAI,SAAS;AArEf;AAsEI,aAAO,UAAK,WAAL,mBAAa,WAAU,MAAK;AAAA,EACrC;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,OAAO,GAAG,mBAAqC,OAAa;AAC1D,QAAI,OAAO,qBAAqB,UAAU;AACxC,WAAK,QAAQ,gBAAgB;AAAA,IAC/B,OAAO;AACL,UAAI,oBAAoB,KAAK,IAAI,IAAI,KAAK,UAAU,KAAK,iBAAiB;AACxE,aAAK,MAAM;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EAEA,OAAO,cAAc,WAA2B;AAzFlD;AA0FI,aAAO,UAAK,gBAAgB,SAAS,MAA9B,mBAAiC,WAAU;AAAA,EACpD;AAAA,EAEA,OAAO,iBAAgD;AACrD,SAAK,GAAG;AACR,UAAM,SAAwC,CAAC;AAC/C,WAAO,QAAQ,KAAK,eAAe,EAAE,IAAI,CAAC,CAAC,WAAW,SAAS,MAAO,OAAO,SAAS,IAAI,UAAU,MAAO;AAC3G,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,eAAqB;AAC1B,QAAI,KAAK,iBAAiB;AACxB,WAAK,YAAY;AAAA,IACnB;AAEA,UAAM,iBAAiB,MAAM;AAC3B,UAAI,KAAK,iBAAiB;AACxB,aAAK,aAAa;AAClB,aAAK,kBAAkB,WAAW,MAAM;AACtC;AAAA,QACF,GAAG,KAAK,eAAe;AAAA,MACzB;AAAA,IACF;AAEA,SAAK,kBAAkB,WAAW,MAAM;AACtC;AAAA,IACF,GAAG,KAAK,eAAe;AAAA,EACzB;AAAA,EAEA,OAAO,cAAoB;AACzB,QAAI,KAAK,iBAAiB;AACxB,mBAAa,KAAK,eAAe;AACjC,WAAK,kBAAkB;AAAA,IACzB;AAAA,EACF;AAAA,EAEA,OAAe,eAAe;AA9HhC;AA+HI,UAAM,SAAS,KAAK,eAAe;AACnC,eAAW,aAAa,OAAO,KAAK,KAAK,eAAe,GAAG;AACzD,WAAK,4BAA4B,SAAS,MAAI,UAAK,4BAA4B,SAAS,MAA1C,mBAA6C,MAAM,CAAC,KAAK,qBAAoB,CAAC;AAC5H,WAAK,4BAA4B,SAAS,EAAE,KAAK,OAAO,SAAS,CAAC;AAAA,IACpE;AAAA,EACF;AAAA,EAEA,OAAe,QAAQ;AACrB,eAAW,aAAa,OAAO,KAAK,KAAK,eAAe,GAAG;AACzD,WAAK,QAAQ,SAAS;AAAA,IACxB;AAAA,EACF;AAAA,EAEA,OAAe,QAAQ,WAA0B;AA5InD;AA8II,SAAK,gBAAgB,SAAS,MAAI,UAAK,gBAAgB,SAAS,MAA9B,mBAAiC,OAAO,CAAC,QAAQ,IAAI,MAAM,MAAM,UAAS,CAAC;AAAA,EAC/G;AAAA,EAEQ,iBAAiB;AACvB,UAAM,gBAAgB,MAAK,gBAAgB,KAAK,YAAY,IAAI,KAAK,CAAC;AACtE,kBAAc,KAAK,IAAI,QAAQ,IAAI,CAAC;AACpC,UAAK,gBAAgB,KAAK,YAAY,IAAI,IAAI;AAAA,EAChD;AACF;;;AE/IO,IAAM,kBAAN,MAA6C;AAAA,EAClD,OAAO,OAAyB,kBAA2D;AACzF,WAAO,CAAC,KAAK,EAAE,IAAI,IAAI,CAAC,MAAgB;AACtC,UAAI,CAAC,OAAO,OAAO,QAAQ,UAAU;AACnC,eAAO;AAAA,MACT;AACA;AAAA;AAAA,QAEE,OAAO,QAAQ,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,KAAK,IAAI,MAAM;AAElD,gBAAM,SAAS,OAAQ,IAAY,GAAG,GAAG,IAAI;AAC7C,cAAI,CAAC,UAAU,KAAK;AAClB,kBAAM,SAAS,OAAO,QAAQ,WAAW,MAAM;AAC/C,mBAAO,KAAK,kBAAkB,GAAG,KAAK,IAAI,EAAE;AAAA,UAC9C;AACA,iBAAO,CAAC;AAAA,QACV,CAAC,EAAE,WAAW;AAAA,UAEb,qDAAkB,OAAO,CAAC,MAAM,UAAU,QAAQ,MAAM,KAAK,EAAE,IAAI,CAAC,GAAG,UAAS;AAAA;AAAA,IAErF;AAAA,EACF;AACF;;;ACvBO,IAAM,cAAc,CAAC,UAAuC;AACjE,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK,WAAW;AACd,aAAO;AAAA,IACT;AAAA,IACA,SAAS;AACP,aAAO,UAAU,QAAQ,aAAa,KAAK,KAAK,YAAY,KAAK;AAAA,IACnE;AAAA,EACF;AACF;AAEO,IAAM,cAAc,CAAC,UAAuC;AACjE,SAAO,MAAM,QAAQ,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,YAAY,IAAI,CAAC;AACzE;AAEO,IAAM,uBAAuB,CAAC,CAAC,KAAK,KAAK,MAAsC;AACpF,SAAO,OAAO,QAAQ,YAAY,YAAY,KAAK;AACrD;AAEO,IAAM,eAAe,CAAC,UAAwC;AACnE,SACE,SAAS,KAAK;AAAA,EAEd,CAAC,OAAO,QAAQ,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,qBAAqB,IAAI,CAAC;AAErE;;;AC9BO,IAAe,gBAAf,MAAkE;AAAA,EAC9D;AAAA,EACT,YAAY,KAAQ;AAClB,SAAK,MAAM;AAAA,EACb;AAAA,EACA,IAAc,eAAe;AAC3B,WAAO,KAAK;AAAA,EACd;AACF;;;ACTO,IAAM,eAAe,CAA2C,KAAQ,WAA4B;AACzG,QAAM,QAAQ,EAAE,GAAG,IAAI;AACvB,aAAW,SAAS,QAAQ;AAC1B,WAAO,MAAM,KAAK;AAAA,EACpB;AACA,SAAO;AACT;;;ACNA,IAAM,cAAc,CAAC,OAAkB,WAAuB,WAAW,MAAiB;AACxF,SAAO,MAAM,IAAI,CAAC,SAAS,YAAY,MAAM,WAAW,QAAQ,CAAC;AACnE;AAEA,IAAM,eAAe,CAAC,OAAe,WAAuB,WAAW,MAAkB;AACvF,QAAM,SAAqB,CAAC;AAC5B,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,WAAO,GAAG,IAAI,UAAU,SAAY,gBAAgB,YAAY,OAAO,WAAW,QAAQ;AAAA,EAC5F;AACA,SAAO;AACT;AAEA,IAAM,cAAc,CAAC,OAAgB,WAAuB,WAAW,MAAiB;AACtF,MAAI,YAAY,KAAK,OAAO,UAAU,UAAU;AAC9C,WAAO;AAAA,EACT;AACA,MAAI,uCAAW,SAAS,QAAQ;AAC9B,WAAO;AAAA,EACT;AACA,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK,UAAU;AACb,aAAO;AAAA,IACT;AAAA,IACA,KAAK,UAAU;AACb,UAAI,UAAU,MAAM;AAClB,eAAO;AAAA,MACT;AACA,YAAM,eAAe,aAAa,CAAC;AACnC,mBAAa,KAAK,KAAK;AACvB,aAAO,MAAM,QAAQ,KAAK,IAAI,YAAY,OAAO,cAAc,WAAW,CAAC,IAAI,aAAa,OAAO,cAAc,WAAW,CAAC;AAAA,IAC/H;AAAA,IACA,SAAS;AACP,aAAO,IAAI,OAAO,KAAK;AAAA,IACzB;AAAA,EACF;AACF;AAEO,IAAM,eAAe,CAAC,OAAgB,WAAW,MAAM;AAC5D,SAAO,KAAK,UAAU,OAAO,OAAO,QAAQ,GAAG,MAAM,CAAC;AACxD;AAEO,IAAM,SAAS,CAAC,OAAgB,WAAW,MAAiB;AACjE,SAAO,YAAY,OAAO,QAAW,QAAQ;AAC/C;;;ACrCO,IAAe,gBAAf,cAAwE,cAAkD;AAEjI;","names":["assertEx","assertEx"]}
@@ -0,0 +1,2 @@
1
+ export declare const removeFields: <T extends object, K extends keyof T>(obj: T, fields: K[]) => Omit<T, K>;
2
+ //# sourceMappingURL=removeFields.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"removeFields.d.ts","sourceRoot":"","sources":["../../src/removeFields.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,YAAY,6CAAmD,CAAC,UAAU,CAAC,EAAE,KAAG,KAAK,CAAC,EAAE,CAAC,CAMrG,CAAA"}
@@ -0,0 +1,2 @@
1
+ export declare const removeFields: <T extends object, K extends keyof T>(obj: T, fields: K[]) => Omit<T, K>;
2
+ //# sourceMappingURL=removeFields.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"removeFields.d.ts","sourceRoot":"","sources":["../../src/removeFields.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,YAAY,6CAAmD,CAAC,UAAU,CAAC,EAAE,KAAG,KAAK,CAAC,EAAE,CAAC,CAMrG,CAAA"}
@@ -0,0 +1,2 @@
1
+ export declare const removeFields: <T extends object, K extends keyof T>(obj: T, fields: K[]) => Omit<T, K>;
2
+ //# sourceMappingURL=removeFields.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"removeFields.d.ts","sourceRoot":"","sources":["../../src/removeFields.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,YAAY,6CAAmD,CAAC,UAAU,CAAC,EAAE,KAAG,KAAK,CAAC,EAAE,CAAC,CAMrG,CAAA"}
package/package.json CHANGED
@@ -11,14 +11,14 @@
11
11
  },
12
12
  "description": "Primary SDK for using XYO Protocol 2.0",
13
13
  "dependencies": {
14
- "@xylabs/assert": "^3.1.6",
15
- "@xylabs/logger": "^3.1.6",
16
- "@xylabs/promise": "^3.1.6"
14
+ "@xylabs/assert": "^3.1.8",
15
+ "@xylabs/logger": "^3.1.8",
16
+ "@xylabs/promise": "^3.1.8"
17
17
  },
18
18
  "devDependencies": {
19
- "@xylabs/ts-scripts-yarn3": "^3.9.0",
20
- "@xylabs/tsconfig": "^3.9.0",
21
- "typescript": "^5.4.4"
19
+ "@xylabs/ts-scripts-yarn3": "^3.9.1",
20
+ "@xylabs/tsconfig": "^3.9.1",
21
+ "typescript": "^5.4.5"
22
22
  },
23
23
  "exports": {
24
24
  ".": {
@@ -58,6 +58,6 @@
58
58
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
59
59
  },
60
60
  "sideEffects": false,
61
- "version": "3.1.6",
61
+ "version": "3.1.8",
62
62
  "type": "module"
63
63
  }
package/src/Base.ts CHANGED
@@ -1,8 +1,17 @@
1
+ import { assertEx } from '@xylabs/assert'
1
2
  import { Logger } from '@xylabs/logger'
2
3
 
3
4
  import { EmptyObject } from './EmptyObject'
4
5
  import { globallyUnique } from './globallyUnique'
5
6
 
7
+ const DEFAULT_HISTORY_INTERVAL = 1000 * 5
8
+ const DEFAULT_HISTORY_TIME = 60 * 60 * 1000
9
+ const MAX_GC_FREQUENCY = 1000 * 60
10
+ const MIN_GC_FREQUENCY = 1000
11
+ const MIN_HISTORY_INTERVAL = 1000
12
+
13
+ export type BaseClassName = Exclude<string, 'base-class-name-reserved-32546239486'>
14
+
6
15
  export type BaseParamsFields = {
7
16
  logger?: Logger
8
17
  }
@@ -12,13 +21,50 @@ export type BaseParams<TAdditionalParams extends EmptyObject | void = void> =
12
21
 
13
22
  export abstract class Base<TParams extends BaseParams | undefined = BaseParams> {
14
23
  static defaultLogger?: Logger
24
+ static readonly globalInstances: Record<BaseClassName, WeakRef<Base<BaseParams | undefined>>[]> = {}
25
+ static readonly globalInstancesCountHistory: Record<BaseClassName, number[]> = {}
15
26
  static readonly uniqueName = globallyUnique(this.name, this, 'xyo')
16
-
27
+ private static _historyInterval = DEFAULT_HISTORY_INTERVAL
28
+ private static _historyTime = DEFAULT_HISTORY_TIME
29
+ private static _historyTimeout?: ReturnType<typeof setTimeout>
30
+ private static _lastGC = 0
31
+ private static _maxGcFrequency = MAX_GC_FREQUENCY
17
32
  private _params: TParams
18
33
 
19
34
  constructor(params: TParams) {
20
35
  this._params = params
21
36
  params?.logger?.debug(`Base constructed [${Object(this).name}]`)
37
+ this.recordInstance()
38
+ }
39
+
40
+ static get historyInterval() {
41
+ return this._historyInterval
42
+ }
43
+
44
+ static set historyInterval(value: number) {
45
+ assertEx(value <= this.historyTime, () => `historyInterval [${value}] must be less than or equal to historyTime [${this.historyTime}]`)
46
+ this._historyInterval = Math.max(value, MIN_HISTORY_INTERVAL)
47
+ }
48
+
49
+ static get historyTime() {
50
+ return this._historyTime
51
+ }
52
+
53
+ static set historyTime(value: number) {
54
+ assertEx(value >= this.historyInterval, () => `historyTime [${value}] must be greater than or equal to historyInterval [${this.historyInterval}]`)
55
+ this._historyInterval = value
56
+ }
57
+
58
+ static get maxGcFrequency() {
59
+ return this._maxGcFrequency
60
+ }
61
+
62
+ static set maxGcFrequency(value: number) {
63
+ this._maxGcFrequency = Math.max(value, MIN_GC_FREQUENCY)
64
+ }
65
+
66
+ static get maxHistoryDepth() {
67
+ return Math.floor(this.historyTime / this.historyInterval)
22
68
  }
23
69
 
24
70
  get logger() {
@@ -28,4 +74,78 @@ export abstract class Base<TParams extends BaseParams | undefined = BaseParams>
28
74
  get params() {
29
75
  return this._params
30
76
  }
77
+
78
+ static gc(force?: boolean): void
79
+ static gc(className: string): void
80
+ static gc(classNameOrForce: string | boolean = false): void {
81
+ if (typeof classNameOrForce === 'string') {
82
+ this.gcClass(classNameOrForce)
83
+ } else {
84
+ if (classNameOrForce || Date.now() - this._lastGC > this._maxGcFrequency) {
85
+ this.gcAll()
86
+ }
87
+ }
88
+ }
89
+
90
+ static instanceCount(className: string): number {
91
+ return this.globalInstances[className]?.length ?? 0
92
+ }
93
+
94
+ static instanceCounts(): Record<BaseClassName, number> {
95
+ this.gc()
96
+ const result: Record<BaseClassName, number> = {}
97
+ Object.entries(this.globalInstances).map(([className, instances]) => (result[className] = instances.length))
98
+ return result
99
+ }
100
+
101
+ static startHistory(): void {
102
+ if (this._historyTimeout) {
103
+ this.stopHistory()
104
+ }
105
+
106
+ const timeoutHandler = () => {
107
+ if (this._historyTimeout) {
108
+ this.addToHistory()
109
+ this._historyTimeout = setTimeout(() => {
110
+ timeoutHandler
111
+ }, this.historyInterval)
112
+ }
113
+ }
114
+
115
+ this._historyTimeout = setTimeout(() => {
116
+ timeoutHandler
117
+ }, this.historyInterval)
118
+ }
119
+
120
+ static stopHistory(): void {
121
+ if (this._historyTimeout) {
122
+ clearTimeout(this._historyTimeout)
123
+ this._historyTimeout = undefined
124
+ }
125
+ }
126
+
127
+ private static addToHistory() {
128
+ const counts = this.instanceCounts()
129
+ for (const className of Object.keys(this.globalInstances)) {
130
+ this.globalInstancesCountHistory[className] = this.globalInstancesCountHistory[className]?.slice(-this.maxHistoryDepth) ?? []
131
+ this.globalInstancesCountHistory[className].push(counts[className])
132
+ }
133
+ }
134
+
135
+ private static gcAll() {
136
+ for (const className of Object.keys(this.globalInstances)) {
137
+ this.gcClass(className)
138
+ }
139
+ }
140
+
141
+ private static gcClass(className: BaseClassName) {
142
+ //remove all the weak refs that are now empty
143
+ this.globalInstances[className] = this.globalInstances[className]?.filter((ref) => ref.deref() !== null) ?? []
144
+ }
145
+
146
+ private recordInstance() {
147
+ const instanceArray = Base.globalInstances[this.constructor.name] ?? []
148
+ instanceArray.push(new WeakRef(this))
149
+ Base.globalInstances[this.constructor.name] = instanceArray
150
+ }
31
151
  }
package/src/index.ts CHANGED
@@ -12,6 +12,7 @@ export * from './JsonObject'
12
12
  export * from './ObjectWrapper'
13
13
  export * from './Override'
14
14
  export * from './PartialRecord'
15
+ export * from './removeFields'
15
16
  export * from './StringKeyObject'
16
17
  export * from './toJson'
17
18
  export * from './Validator'
@@ -0,0 +1,9 @@
1
+ import { EmptyObject } from './EmptyObject'
2
+
3
+ export const removeFields = <T extends EmptyObject, K extends keyof T>(obj: T, fields: K[]): Omit<T, K> => {
4
+ const clone = { ...obj }
5
+ for (const field of fields) {
6
+ delete clone[field]
7
+ }
8
+ return clone
9
+ }