@xylabs/object 3.1.5 → 3.1.7
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.
- package/dist/browser/index.cjs +10 -0
- package/dist/browser/index.cjs.map +1 -1
- package/dist/browser/index.d.cts +1 -0
- package/dist/browser/index.d.cts.map +1 -1
- package/dist/browser/index.d.mts +1 -0
- package/dist/browser/index.d.mts.map +1 -1
- package/dist/browser/index.d.ts +1 -0
- package/dist/browser/index.d.ts.map +1 -1
- package/dist/browser/index.js +10 -0
- package/dist/browser/index.js.map +1 -1
- package/dist/browser/removeFields.d.cts +2 -0
- package/dist/browser/removeFields.d.cts.map +1 -0
- package/dist/browser/removeFields.d.mts +2 -0
- package/dist/browser/removeFields.d.mts.map +1 -0
- package/dist/browser/removeFields.d.ts +2 -0
- package/dist/browser/removeFields.d.ts.map +1 -0
- package/dist/node/index.cjs +11 -0
- package/dist/node/index.cjs.map +1 -1
- package/dist/node/index.d.cts +1 -0
- package/dist/node/index.d.cts.map +1 -1
- package/dist/node/index.d.mts +1 -0
- package/dist/node/index.d.mts.map +1 -1
- package/dist/node/index.d.ts +1 -0
- package/dist/node/index.d.ts.map +1 -1
- package/dist/node/index.js +10 -0
- package/dist/node/index.js.map +1 -1
- package/dist/node/removeFields.d.cts +2 -0
- package/dist/node/removeFields.d.cts.map +1 -0
- package/dist/node/removeFields.d.mts +2 -0
- package/dist/node/removeFields.d.mts.map +1 -0
- package/dist/node/removeFields.d.ts +2 -0
- package/dist/node/removeFields.d.ts.map +1 -0
- package/package.json +4 -4
- package/src/index.ts +1 -0
- package/src/removeFields.ts +9 -0
package/dist/browser/index.cjs
CHANGED
|
@@ -34,6 +34,7 @@ __export(src_exports, {
|
|
|
34
34
|
isObject: () => isObject,
|
|
35
35
|
isType: () => isType,
|
|
36
36
|
isValidJsonFieldPair: () => isValidJsonFieldPair,
|
|
37
|
+
removeFields: () => removeFields,
|
|
37
38
|
toJson: () => toJson,
|
|
38
39
|
toJsonString: () => toJsonString
|
|
39
40
|
});
|
|
@@ -203,6 +204,15 @@ var ObjectWrapper = class {
|
|
|
203
204
|
}
|
|
204
205
|
};
|
|
205
206
|
|
|
207
|
+
// src/removeFields.ts
|
|
208
|
+
var removeFields = (obj, fields) => {
|
|
209
|
+
const clone = { ...obj };
|
|
210
|
+
for (const field of fields) {
|
|
211
|
+
delete clone[field];
|
|
212
|
+
}
|
|
213
|
+
return clone;
|
|
214
|
+
};
|
|
215
|
+
|
|
206
216
|
// src/toJson.ts
|
|
207
217
|
var toJsonArray = (value, cycleList, maxDepth = 3) => {
|
|
208
218
|
return value.map((item) => toJsonValue(item, cycleList, maxDepth));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts","../../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":["export * from './AnyObject'\nexport * from './asObject'\nexport * from './AsObjectFactory'\nexport * from './AsTypeFactory'\nexport * from './Base'\nexport * from './EmptyObject'\nexport * from './globallyUnique'\nexport * from './isObject'\nexport * from './IsObjectFactory'\nexport * from './isType'\nexport * from './JsonObject'\nexport * from './ObjectWrapper'\nexport * from './Override'\nexport * from './PartialRecord'\nexport * from './StringKeyObject'\nexport * from './toJson'\nexport * from './Validator'\nexport * from './WithAdditional'\n","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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAA8C;AAE9C,qBAAqD;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,cAAI,0BAAU,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,sCAAY,QAAQ,cAAc;AAAA,QACpC,OAAO;AACL,sCAAY,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;AAC3B,SAAK,UAAU;AACf,YAAQ,QAAQ,MAAM,qBAAqB,OAAO,IAAI,EAAE,IAAI,GAAG;AAAA,EACjE;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK,QAAQ,UAAU,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,SAEb,kBAAkB,OAAO,CAAC,MAAM,UAAU,QAAQ,MAAM,KAAK,EAAE,IAAI,CAAC,GAAG,IAAI,KAAK;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,WAAW,SAAS,KAAK,GAAG;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/index.ts","../../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/removeFields.ts","../../src/toJson.ts","../../src/Validator.ts"],"sourcesContent":["export * from './AnyObject'\nexport * from './asObject'\nexport * from './AsObjectFactory'\nexport * from './AsTypeFactory'\nexport * from './Base'\nexport * from './EmptyObject'\nexport * from './globallyUnique'\nexport * from './isObject'\nexport * from './IsObjectFactory'\nexport * from './isType'\nexport * from './JsonObject'\nexport * from './ObjectWrapper'\nexport * from './Override'\nexport * from './PartialRecord'\nexport * from './removeFields'\nexport * from './StringKeyObject'\nexport * from './toJson'\nexport * from './Validator'\nexport * from './WithAdditional'\n","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 { 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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAA8C;AAE9C,qBAAqD;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,cAAI,0BAAU,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,sCAAY,QAAQ,cAAc;AAAA,QACpC,OAAO;AACL,sCAAY,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;AAC3B,SAAK,UAAU;AACf,YAAQ,QAAQ,MAAM,qBAAqB,OAAO,IAAI,EAAE,IAAI,GAAG;AAAA,EACjE;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK,QAAQ,UAAU,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,SAEb,kBAAkB,OAAO,CAAC,MAAM,UAAU,QAAQ,MAAM,KAAK,EAAE,IAAI,CAAC,GAAG,IAAI,KAAK;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,WAAW,SAAS,KAAK,GAAG;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":[]}
|
package/dist/browser/index.d.cts
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';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
package/dist/browser/index.d.mts
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';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
package/dist/browser/index.d.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';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
package/dist/browser/index.js
CHANGED
|
@@ -162,6 +162,15 @@ var ObjectWrapper = class {
|
|
|
162
162
|
}
|
|
163
163
|
};
|
|
164
164
|
|
|
165
|
+
// src/removeFields.ts
|
|
166
|
+
var removeFields = (obj, fields) => {
|
|
167
|
+
const clone = { ...obj };
|
|
168
|
+
for (const field of fields) {
|
|
169
|
+
delete clone[field];
|
|
170
|
+
}
|
|
171
|
+
return clone;
|
|
172
|
+
};
|
|
173
|
+
|
|
165
174
|
// src/toJson.ts
|
|
166
175
|
var toJsonArray = (value, cycleList, maxDepth = 3) => {
|
|
167
176
|
return value.map((item) => toJsonValue(item, cycleList, maxDepth));
|
|
@@ -224,6 +233,7 @@ export {
|
|
|
224
233
|
isObject,
|
|
225
234
|
isType,
|
|
226
235
|
isValidJsonFieldPair,
|
|
236
|
+
removeFields,
|
|
227
237
|
toJson,
|
|
228
238
|
toJsonString
|
|
229
239
|
};
|
|
@@ -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;AAC3B,SAAK,UAAU;AACf,YAAQ,QAAQ,MAAM,qBAAqB,OAAO,IAAI,EAAE,IAAI,GAAG;AAAA,EACjE;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK,QAAQ,UAAU,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,SAEb,kBAAkB,OAAO,CAAC,MAAM,UAAU,QAAQ,MAAM,KAAK,EAAE,IAAI,CAAC,GAAG,IAAI,KAAK;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,WAAW,SAAS,KAAK,GAAG;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/globallyUnique.ts","../../src/Base.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","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 { 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;;;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;AAC3B,SAAK,UAAU;AACf,YAAQ,QAAQ,MAAM,qBAAqB,OAAO,IAAI,EAAE,IAAI,GAAG;AAAA,EACjE;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK,QAAQ,UAAU,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,SAEb,kBAAkB,OAAO,CAAC,MAAM,UAAU,QAAQ,MAAM,KAAK,EAAE,IAAI,CAAC,GAAG,IAAI,KAAK;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,WAAW,SAAS,KAAK,GAAG;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":[]}
|
|
@@ -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 @@
|
|
|
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 @@
|
|
|
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/dist/node/index.cjs
CHANGED
|
@@ -34,6 +34,7 @@ __export(src_exports, {
|
|
|
34
34
|
isObject: () => isObject,
|
|
35
35
|
isType: () => isType,
|
|
36
36
|
isValidJsonFieldPair: () => isValidJsonFieldPair,
|
|
37
|
+
removeFields: () => removeFields,
|
|
37
38
|
toJson: () => toJson,
|
|
38
39
|
toJsonString: () => toJsonString
|
|
39
40
|
});
|
|
@@ -205,6 +206,15 @@ var ObjectWrapper = class {
|
|
|
205
206
|
}
|
|
206
207
|
};
|
|
207
208
|
|
|
209
|
+
// src/removeFields.ts
|
|
210
|
+
var removeFields = (obj, fields) => {
|
|
211
|
+
const clone = { ...obj };
|
|
212
|
+
for (const field of fields) {
|
|
213
|
+
delete clone[field];
|
|
214
|
+
}
|
|
215
|
+
return clone;
|
|
216
|
+
};
|
|
217
|
+
|
|
208
218
|
// src/toJson.ts
|
|
209
219
|
var toJsonArray = (value, cycleList, maxDepth = 3) => {
|
|
210
220
|
return value.map((item) => toJsonValue(item, cycleList, maxDepth));
|
|
@@ -268,6 +278,7 @@ var ValidatorBase = class extends ObjectWrapper {
|
|
|
268
278
|
isObject,
|
|
269
279
|
isType,
|
|
270
280
|
isValidJsonFieldPair,
|
|
281
|
+
removeFields,
|
|
271
282
|
toJson,
|
|
272
283
|
toJsonString
|
|
273
284
|
});
|
package/dist/node/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts","../../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":["export * from './AnyObject'\nexport * from './asObject'\nexport * from './AsObjectFactory'\nexport * from './AsTypeFactory'\nexport * from './Base'\nexport * from './EmptyObject'\nexport * from './globallyUnique'\nexport * from './isObject'\nexport * from './IsObjectFactory'\nexport * from './isType'\nexport * from './JsonObject'\nexport * from './ObjectWrapper'\nexport * from './Override'\nexport * from './PartialRecord'\nexport * from './StringKeyObject'\nexport * from './toJson'\nexport * from './Validator'\nexport * from './WithAdditional'\n","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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAA8C;AAE9C,qBAAqD;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,cAAI,0BAAU,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,sCAAY,QAAQ,cAAc;AAAA,QACpC,OAAO;AACL,sCAAY,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/index.ts","../../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/removeFields.ts","../../src/toJson.ts","../../src/Validator.ts"],"sourcesContent":["export * from './AnyObject'\nexport * from './asObject'\nexport * from './AsObjectFactory'\nexport * from './AsTypeFactory'\nexport * from './Base'\nexport * from './EmptyObject'\nexport * from './globallyUnique'\nexport * from './isObject'\nexport * from './IsObjectFactory'\nexport * from './isType'\nexport * from './JsonObject'\nexport * from './ObjectWrapper'\nexport * from './Override'\nexport * from './PartialRecord'\nexport * from './removeFields'\nexport * from './StringKeyObject'\nexport * from './toJson'\nexport * from './Validator'\nexport * from './WithAdditional'\n","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 { 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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAA8C;AAE9C,qBAAqD;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,cAAI,0BAAU,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,sCAAY,QAAQ,cAAc;AAAA,QACpC,OAAO;AACL,sCAAY,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;;;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":[]}
|
package/dist/node/index.d.cts
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';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
package/dist/node/index.d.mts
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';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
package/dist/node/index.d.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';
|
package/dist/node/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}
|
package/dist/node/index.js
CHANGED
|
@@ -164,6 +164,15 @@ var ObjectWrapper = class {
|
|
|
164
164
|
}
|
|
165
165
|
};
|
|
166
166
|
|
|
167
|
+
// src/removeFields.ts
|
|
168
|
+
var removeFields = (obj, fields) => {
|
|
169
|
+
const clone = { ...obj };
|
|
170
|
+
for (const field of fields) {
|
|
171
|
+
delete clone[field];
|
|
172
|
+
}
|
|
173
|
+
return clone;
|
|
174
|
+
};
|
|
175
|
+
|
|
167
176
|
// src/toJson.ts
|
|
168
177
|
var toJsonArray = (value, cycleList, maxDepth = 3) => {
|
|
169
178
|
return value.map((item) => toJsonValue(item, cycleList, maxDepth));
|
|
@@ -226,6 +235,7 @@ export {
|
|
|
226
235
|
isObject,
|
|
227
236
|
isType,
|
|
228
237
|
isValidJsonFieldPair,
|
|
238
|
+
removeFields,
|
|
229
239
|
toJson,
|
|
230
240
|
toJsonString
|
|
231
241
|
};
|
package/dist/node/index.js.map
CHANGED
|
@@ -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/globallyUnique.ts","../../src/Base.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","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 { 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;;;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;;;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":[]}
|
|
@@ -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 @@
|
|
|
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 @@
|
|
|
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,9 +11,9 @@
|
|
|
11
11
|
},
|
|
12
12
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@xylabs/assert": "^3.1.
|
|
15
|
-
"@xylabs/logger": "^3.1.
|
|
16
|
-
"@xylabs/promise": "^3.1.
|
|
14
|
+
"@xylabs/assert": "^3.1.7",
|
|
15
|
+
"@xylabs/logger": "^3.1.7",
|
|
16
|
+
"@xylabs/promise": "^3.1.7"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
19
|
"@xylabs/ts-scripts-yarn3": "^3.9.0",
|
|
@@ -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.
|
|
61
|
+
"version": "3.1.7",
|
|
62
62
|
"type": "module"
|
|
63
63
|
}
|
package/src/index.ts
CHANGED