npm - @genesislcap/foundation-utils - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-utils 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (305) hide show

package/docs/api/foundation-utils.databaseaccessresult.delete.md DELETED Viewed

@@ -1,71 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Delete](./foundation-utils.databaseaccessresult.delete.md)
-## DatabaseAccessResult.Delete interface
-**Signature:**
-```typescript
-export interface Delete
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[id](./foundation-utils.databaseaccessresult.delete.id.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[success](./foundation-utils.databaseaccessresult.delete.success.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.databaseaccessresult.delete.success.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Delete](./foundation-utils.databaseaccessresult.delete.md) &gt; [success](./foundation-utils.databaseaccessresult.delete.success.md)
-## DatabaseAccessResult.Delete.success property
-**Signature:**
-```typescript
-success: boolean;
-```

package/docs/api/foundation-utils.databaseaccessresult.md DELETED Viewed

@@ -1,74 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md)
-## DatabaseAccessResult namespace
-Namespace for database access result types.
-**Signature:**
-```typescript
-export declare namespace DatabaseAccessResult
-```
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[Access](./foundation-utils.databaseaccessresult.access.md)
-</td><td>
-</td></tr>
-<tr><td>
-[Create](./foundation-utils.databaseaccessresult.create.md)
-</td><td>
-</td></tr>
-<tr><td>
-[Delete](./foundation-utils.databaseaccessresult.delete.md)
-</td><td>
-</td></tr>
-<tr><td>
-[Read](./foundation-utils.databaseaccessresult.read.md)
-</td><td>
-</td></tr>
-<tr><td>
-[Update](./foundation-utils.databaseaccessresult.update.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.databaseaccessresult.read.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Read](./foundation-utils.databaseaccessresult.read.md)
-## DatabaseAccessResult.Read interface
-**Signature:**
-```typescript
-export interface Read<T> extends Access<T>
-```
-**Extends:** Access&lt;T&gt;

package/docs/api/foundation-utils.databaseaccessresult.update.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Update](./foundation-utils.databaseaccessresult.update.md)
-## DatabaseAccessResult.Update interface
-**Signature:**
-```typescript
-export interface Update<T> extends Access<T>
-```
-**Extends:** Access&lt;T&gt;

package/docs/api/foundation-utils.databaseevent.afterupdate.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [AfterUpdate](./foundation-utils.databaseevent.afterupdate.md)
-## DatabaseEvent.AfterUpdate interface
-**Signature:**
-```typescript
-export interface AfterUpdate<T> extends Update<T>
-```
-**Extends:** Update&lt;T&gt;

package/docs/api/foundation-utils.databaseevent.beforeupdate.md DELETED Viewed

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md)
-## DatabaseEvent.BeforeUpdate interface
-**Signature:**
-```typescript
-export interface BeforeUpdate<T> extends Update<T>
-```
-**Extends:** Update&lt;T&gt;
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[newValue](./foundation-utils.databaseevent.beforeupdate.newvalue.md)
-</td><td>
-</td><td>
-T
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.databaseevent.beforeupdate.newvalue.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md) &gt; [newValue](./foundation-utils.databaseevent.beforeupdate.newvalue.md)
-## DatabaseEvent.BeforeUpdate.newValue property
-**Signature:**
-```typescript
-newValue: T;
-```

package/docs/api/foundation-utils.databaseevent.md DELETED Viewed

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md)
-## DatabaseEvent namespace
-Namespace for database events.
-**Signature:**
-```typescript
-export declare namespace DatabaseEvent
-```
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AfterUpdate](./foundation-utils.databaseevent.afterupdate.md)
-</td><td>
-</td></tr>
-<tr><td>
-[BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md)
-</td><td>
-</td></tr>
-<tr><td>
-[Update](./foundation-utils.databaseevent.update.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.databaseevent.update.md DELETED Viewed

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [Update](./foundation-utils.databaseevent.update.md)
-## DatabaseEvent.Update interface
-**Signature:**
-```typescript
-interface Update<T>
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[value](./foundation-utils.databaseevent.update.value.md)
-</td><td>
-</td><td>
-T
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.databaseevent.update.value.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [Update](./foundation-utils.databaseevent.update.md) &gt; [value](./foundation-utils.databaseevent.update.value.md)
-## DatabaseEvent.Update.value property
-**Signature:**
-```typescript
-value: T;
-```

package/docs/api/foundation-utils.databaserecord.id.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseRecord](./foundation-utils.databaserecord.md) &gt; [id](./foundation-utils.databaserecord.id.md)
-## DatabaseRecord.id property
-**Signature:**
-```typescript
-id: string;
-```

package/docs/api/foundation-utils.databaserecord.md DELETED Viewed

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseRecord](./foundation-utils.databaserecord.md)
-## DatabaseRecord interface
-Represents a database record.
-**Signature:**
-```typescript
-export interface DatabaseRecord
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[id](./foundation-utils.databaserecord.id.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.decodefrombase64.md DELETED Viewed

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [decodeFromBase64](./foundation-utils.decodefrombase64.md)
-## decodeFromBase64() function
-Decodes a value from base64.
-**Signature:**
-```typescript
-decodeFromBase64: (base64Value: string) => string | ArrayBuffer
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-base64Value
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-string \| ArrayBuffer
-The decoded value.

package/docs/api/foundation-utils.decodefrombase64withprefix.md DELETED Viewed

@@ -1,60 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [decodeFromBase64WithPrefix](./foundation-utils.decodefrombase64withprefix.md)
-## decodeFromBase64WithPrefix() function
-Decodes a value from base64 with a prefix.
-**Signature:**
-```typescript
-decodeFromBase64WithPrefix: (value: string) => string | ArrayBuffer
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-value
-</td><td>
-string
-</td><td>
-The value to decode from base64.
-</td></tr>
-</tbody></table>
-**Returns:**
-string \| ArrayBuffer
-The decoded value.
-## Remarks
-Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.

package/docs/api/foundation-utils.deepmerge.md DELETED Viewed

@@ -1,82 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [deepMerge](./foundation-utils.deepmerge.md)
-## deepMerge() function
-Deep merges two objects, with source values taking precedence over target values. Arrays are replaced (not merged), and null/undefined values in source are preserved.
-**Signature:**
-```typescript
-deepMerge: <T extends Record<string, any>>(target: T, source: Partial<T>) => T
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-target
-</td><td>
-T
-</td><td>
-The target object to merge into (defaults/base values)
-</td></tr>
-<tr><td>
-source
-</td><td>
-Partial&lt;T&gt;
-</td><td>
-The source object to merge from (overrides)
-</td></tr>
-</tbody></table>
-**Returns:**
-T
-A new merged object with source values taking precedence
-## Example
-```ts
-const defaults = { a: 1, b: { c: 2, d: 3 } };
-const overrides = { b: { c: 4 } };
-const merged = deepMerge(defaults, overrides);
-// Result: { a: 1, b: { c: 4, d: 3 } }
-```

package/docs/api/foundation-utils.default_organisation.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DEFAULT\_ORGANISATION](./foundation-utils.default_organisation.md)
-## DEFAULT\_ORGANISATION variable
-The default Organisation value, used in auth/login flow \[`genesislcap-foundation-login`<!-- -->\](https://link-to-docs).
-**Signature:**
-```typescript
-_DEFAULT_ORGANISATION: string
-```
-## Remarks
-Optional.

package/docs/api/foundation-utils.default_password.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DEFAULT\_PASSWORD](./foundation-utils.default_password.md)
-## DEFAULT\_PASSWORD variable
-The default Password value, used in auth/login flow \[`genesislcap-foundation-login`<!-- -->\](https://link-to-docs).
-**Signature:**
-```typescript
-_DEFAULT_PASSWORD: string
-```
-## Remarks
-Optional.