@xylabs/object-model 4.13.14 → 4.13.16

package/README.md

@@ -1,69 +1,60 @@
-[![logo][]](https://xylabs.com)
+# @xylabs/object-model
 
-# @xylabs/object
+[![logo][]](https://xylabs.com)
 
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-> XY Labs generalized Javascript library 
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
-
-Common Javascript code that is used throughout XYO projects that use React.
-
-## Install
-
-Using npm:
+Version: 4.13.15
 
-```sh
-npm i --save @xylabs/object
-```
+Primary SDK for using XYO Protocol 2.0
 
-Using yarn:
+## Documentation
 
-```sh
-yarn add @xylabs/object
-```
+Coming Soon!
 
-## Documentation
-[Developer Reference](https://xylabs.github.io/sdk-js)
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
 -   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Joel Carter](https://github.com/JoelBCarter)
 -   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/object.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/object
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/object
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/object
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/object/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/object
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/object
-[socket-link]: https://socket.dev/npm/package/@xylabs/object
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/object-model.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/object-model
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
+
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/object-model
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/object-model
+
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/object-model/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/object-model
+
+[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/object-model
+[socket-link]: https://socket.dev/npm/package/@xylabs/object-model

package/dist/neutral/AnyObject.d.ts

@@ -0,0 +1,6 @@
+import type { TypedKey } from '@xylabs/typeof';
+/**
+ * Any object, which means that it does not enforce the set of fields that it has.  Extending from AnyObject
+ * will result in a type that includes the universal set of field names
+ */
+export type AnyObject = Record<TypedKey, unknown>;

package/dist/neutral/AsTypeFactory.d.ts

@@ -0,0 +1,7 @@
+import type { AnyNonPromise } from '@xylabs/promise';
+import type { AsTypeFunction } from './AsTypeFunction.ts';
+import type { TypeCheck } from './types.ts';
+export declare const AsTypeFactory: {
+    create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => AsTypeFunction<T>;
+    createOptional: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => (value: AnyNonPromise) => T | undefined;
+};

package/dist/neutral/AsTypeFunction.d.ts

@@ -0,0 +1,13 @@
+import type { AnyNonPromise } from '@xylabs/promise';
+import type { StringOrAlertFunction, TypeCheckConfig, TypeCheckOptionalConfig, TypeCheckRequiredConfig } from './types.ts';
+export type AsTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
+    <TType extends T>(value: AnyNonPromise): TType | undefined;
+    <TType extends T>(value: AnyNonPromise, config: TypeCheckRequiredConfig): TType;
+    <TType extends T>(value: AnyNonPromise, config: TypeCheckConfig | TypeCheckOptionalConfig): TType | undefined;
+    <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>): TType | undefined;
+    <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckRequiredConfig): TType;
+    <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckConfig | TypeCheckOptionalConfig): TType | undefined;
+};
+export type AsOptionalTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
+    <TType extends T>(value: AnyNonPromise): TType | undefined;
+};

package/dist/neutral/Compare.d.ts

@@ -0,0 +1 @@
+export type Compare<T> = (a: T, b: T) => number;

package/dist/neutral/index.d.ts

@@ -1,42 +1,4 @@
-import { TypedKey, TypedValue } from '@xylabs/typeof';
-import { AnyNonPromise } from '@xylabs/promise';
-import { AssertExMessageFunc } from '@xylabs/assert';
-import { Logger } from '@xylabs/logger';
-
-/**
- * Any object, which means that it does not enforce the set of fields that it has.  Extending from AnyObject
- * will result in a type that includes the universal set of field names
- */
-type AnyObject = Record<TypedKey, unknown>;
-
-interface TypeCheckConfig {
-    log?: boolean | Logger;
-}
-interface TypeCheckRequiredConfig extends TypeCheckConfig {
-    required: true;
-}
-interface TypeCheckOptionalConfig extends TypeCheckConfig {
-    required: false;
-}
-type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>;
-type TypeCheck<T extends TypedValue> = {
-    (obj: AnyNonPromise): obj is T;
-    (obj: AnyNonPromise, config: TypeCheckConfig): obj is T;
-    (obj: AnyNonPromise, config: TypeCheckConfig | number | undefined): obj is T;
-};
-
-type AsTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
-    <TType extends T>(value: AnyNonPromise): TType | undefined;
-    <TType extends T>(value: AnyNonPromise, config: TypeCheckRequiredConfig): TType;
-    <TType extends T>(value: AnyNonPromise, config: TypeCheckConfig | TypeCheckOptionalConfig): TType | undefined;
-    <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>): TType | undefined;
-    <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckRequiredConfig): TType;
-    <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckConfig | TypeCheckOptionalConfig): TType | undefined;
-};
-type AsOptionalTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
-    <TType extends T>(value: AnyNonPromise): TType | undefined;
-};
-
-type Compare<T> = (a: T, b: T) => number;
-
-export type { AnyObject, AsOptionalTypeFunction, AsTypeFunction, Compare, StringOrAlertFunction, TypeCheck, TypeCheckConfig, TypeCheckOptionalConfig, TypeCheckRequiredConfig };
+export * from './AnyObject.ts';
+export * from './AsTypeFunction.ts';
+export * from './Compare.ts';
+export * from './types.ts';

package/dist/neutral/types.d.ts

@@ -0,0 +1,19 @@
+import type { AssertExMessageFunc } from '@xylabs/assert';
+import type { Logger } from '@xylabs/logger';
+import type { AnyNonPromise } from '@xylabs/promise';
+import type { TypedValue } from '@xylabs/typeof';
+export interface TypeCheckConfig {
+    log?: boolean | Logger;
+}
+export interface TypeCheckRequiredConfig extends TypeCheckConfig {
+    required: true;
+}
+export interface TypeCheckOptionalConfig extends TypeCheckConfig {
+    required: false;
+}
+export type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>;
+export type TypeCheck<T extends TypedValue> = {
+    (obj: AnyNonPromise): obj is T;
+    (obj: AnyNonPromise, config: TypeCheckConfig): obj is T;
+    (obj: AnyNonPromise, config: TypeCheckConfig | number | undefined): obj is T;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/object-model",
-  "version": "4.13.14",
+  "version": "4.13.16",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,14 +29,14 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.13.14",
-    "@xylabs/logger": "^4.13.14",
-    "@xylabs/promise": "^4.13.14",
-    "@xylabs/typeof": "^4.13.14"
+    "@xylabs/assert": "^4.13.16",
+    "@xylabs/logger": "^4.13.16",
+    "@xylabs/promise": "^4.13.16",
+    "@xylabs/typeof": "^4.13.16"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.12",
-    "@xylabs/tsconfig": "^7.0.0-rc.12",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },