alge - npm Package Compare versions

Comparing version 0.4.3 to 0.5.0-next.1

dist/cjs/record/runtime.js

@@ -84,3 +84,9 @@ "use strict";
                 is$: (value) => (0, helpers_js_1.is)(value, symbol),
-                is: (value) => (0, helpers_js_1.is)(value, symbol),
+                is: (record) => (0, helpers_js_1.is)(record, symbol),
+                update: (record, changes) => {
+                    return controller.create({
+                        ...record,
+                        ...changes,
+                    });
+                },
                 from: {
@@ -87,0 +93,0 @@ json: (json) => {

dist/cjs/record/types/controller.d.ts

 import { SomeSchema, SomeSchemaDef } from '../../core/internal.js';
-import { Encoder, SomeName, StoredRecords } from '../../core/types.js';
+import { Encoder, OmitTag, SomeName, StoredRecords } from '../../core/types.js';
 import { OmitRequired, Rest } from '../../lib/utils.js';
@@ -24,4 +24,5 @@ import { z } from '../../lib/z/index.js';
     schema: SomeSchema;
-    is: (value: any) => boolean;
+    is: (record: any) => boolean;
     is$: (value: unknown) => boolean;
+    update: (record: any, changes: object) => object;
     create: (params?: any) => any;
@@ -66,2 +67,7 @@ from: {
     /**
+     *
+     * @throws If zod schema violated: bad types, failed validation, throw from a transformer.
+     */
+    update(record: StoredRecord.GetType<R>, changes: Partial<OmitTag<StoredRecord.GetType<R>>>): StoredRecord.GetType<R>;
+    /**
      * Decoders for this record. Decoders are used to transform other representations of your record back into a record instance.
@@ -75,3 +81,3 @@ */
          */
-        json: (value: string) => null | StoredRecord.GetType<R>;
+        json(value: string): null | StoredRecord.GetType<R>;
         /**
@@ -82,3 +88,3 @@ * Decode JSON into this record. Throws if it fails for any reason.
          */
-        jsonOrThrow: (value: string) => StoredRecord.GetType<R>;
+        jsonOrThrow(value: string): StoredRecord.GetType<R>;
     } & Decoders<R['codec'], R>;
@@ -94,3 +100,3 @@ /**
          */
-        json: (record: StoredRecord.GetType<R>) => string;
+        json(record: StoredRecord.GetType<R>): string;
     } & Encoders<R['codec'], R>;
@@ -97,0 +103,0 @@ /**

dist/esm/record/runtime.js

@@ -84,3 +84,9 @@ "use strict";
                 is$: (value) => (0, helpers_js_1.is)(value, symbol),
-                is: (value) => (0, helpers_js_1.is)(value, symbol),
+                is: (record) => (0, helpers_js_1.is)(record, symbol),
+                update: (record, changes) => {
+                    return controller.create({
+                        ...record,
+                        ...changes,
+                    });
+                },
                 from: {
@@ -87,0 +93,0 @@ json: (json) => {

dist/esm/record/types/controller.d.ts

 import { SomeSchema, SomeSchemaDef } from '../../core/internal.js';
-import { Encoder, SomeName, StoredRecords } from '../../core/types.js';
+import { Encoder, OmitTag, SomeName, StoredRecords } from '../../core/types.js';
 import { OmitRequired, Rest } from '../../lib/utils.js';
@@ -24,4 +24,5 @@ import { z } from '../../lib/z/index.js';
     schema: SomeSchema;
-    is: (value: any) => boolean;
+    is: (record: any) => boolean;
     is$: (value: unknown) => boolean;
+    update: (record: any, changes: object) => object;
     create: (params?: any) => any;
@@ -66,2 +67,7 @@ from: {
     /**
+     *
+     * @throws If zod schema violated: bad types, failed validation, throw from a transformer.
+     */
+    update(record: StoredRecord.GetType<R>, changes: Partial<OmitTag<StoredRecord.GetType<R>>>): StoredRecord.GetType<R>;
+    /**
      * Decoders for this record. Decoders are used to transform other representations of your record back into a record instance.
@@ -75,3 +81,3 @@ */
          */
-        json: (value: string) => null | StoredRecord.GetType<R>;
+        json(value: string): null | StoredRecord.GetType<R>;
         /**
@@ -82,3 +88,3 @@ * Decode JSON into this record. Throws if it fails for any reason.
          */
-        jsonOrThrow: (value: string) => StoredRecord.GetType<R>;
+        jsonOrThrow(value: string): StoredRecord.GetType<R>;
     } & Decoders<R['codec'], R>;
@@ -94,3 +100,3 @@ /**
          */
-        json: (record: StoredRecord.GetType<R>) => string;
+        json(record: StoredRecord.GetType<R>): string;
     } & Encoders<R['codec'], R>;
@@ -97,0 +103,0 @@ /**

package.json

 {
   "name": "alge",
-  "version": "0.4.3",
+  "version": "0.5.0-next.1",
   "repository": "[e-mail]:jasonkuhrt/alge.git",
@@ -5,0 +5,0 @@ "author": "Jason Kuhrt",

README.md

@@ -114,2 +114,3 @@ # alge 🌱
     - [Input Validation](#input-validation)
+    - [Update](#update)
     - [Metadata](#metadata)
@@ -460,2 +461,10 @@ - [Chaining API](#chaining-api)
 
+### Update
+
+You can update records. Updating creates shallow copies of data. The validation, transformations, defaults etc. setup on the zod schema will re-run on the update function ensuring data integrity. Any errors there will be thrown.
+
+```ts
+const circleUpdated = circle.update(circle, { radius: 5 })
+```
+
 ### Metadata
@@ -462,0 +471,0 @@

src/record/runtime.ts

@@ -103,4 +103,10 @@ import { is } from '../core/helpers.js'
         //eslint-disable-next-line
-        is$: (value: unknown) => is(value, symbol),
-        is: (value: unknown) => is(value, symbol),
+        is$: (value) => is(value, symbol),
+        is: (record) => is(record, symbol),
+        update: (record, changes) => {
+          return controller.create({
+            ...record,
+            ...changes,
+          }) as object
+        },
         from: {
@@ -107,0 +113,0 @@ json: (json: string) => {

src/record/types/controller.ts

 import { SomeSchema, SomeSchemaDef } from '../../core/internal.js'
-import { Encoder, SomeName, StoredRecords } from '../../core/types.js'
+import { Encoder, OmitTag, SomeName, StoredRecords } from '../../core/types.js'
 import { OmitRequired, Rest } from '../../lib/utils.js'
@@ -27,6 +27,10 @@ import { z } from '../../lib/z/index.js'
   schema: SomeSchema
+  // !! HACK not-using any here results in test type errors that I don't understand yet.
   // eslint-disable-next-line
-  is: (value: any) => boolean
+  is: (record: any) => boolean
   is$: (value: unknown) => boolean
+  // !! HACK not-using any here results in test type errors that I don't understand yet.
   // eslint-disable-next-line
+  update: (record: any, changes: object) => object
+  // eslint-disable-next-line
   create: (params?: any) => any
@@ -97,2 +101,7 @@ from: {
   /**
+   * 
+   * @throws If zod schema violated: bad types, failed validation, throw from a transformer.
+   */
+  update(record: StoredRecord.GetType<R>, changes: Partial<OmitTag<StoredRecord.GetType<R>>>): StoredRecord.GetType<R>
+  /**
    * Decoders for this record. Decoders are used to transform other representations of your record back into a record instance.
@@ -106,3 +115,3 @@ */
      */
-    json: (value: string) => null | StoredRecord.GetType<R>
+    json(value: string): null | StoredRecord.GetType<R>
     /**
@@ -113,3 +122,3 @@ * Decode JSON into this record. Throws if it fails for any reason.
      */
-    jsonOrThrow: (value: string) => StoredRecord.GetType<R>
+    jsonOrThrow(value: string): StoredRecord.GetType<R>
   } & Decoders<R['codec'], R>
@@ -128,3 +137,3 @@ // & {
      */
-    json: (record: StoredRecord.GetType<R>) => string
+    json(record: StoredRecord.GetType<R>): string
   } & Encoders<R['codec'], R>
@@ -131,0 +140,0 @@ /**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

292679

increased by0.95%

Lines of code

3834

increased by1.03%

Number of lines in readme file

852

increased by1.07%

No dependency changes