@opusdns/api 0.100.0 → 0.101.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.
- package/package.json +1 -1
- package/src/helpers/constants.ts +201 -1
- package/src/helpers/keys.ts +608 -0
- package/src/helpers/requests.d.ts +131 -0
- package/src/helpers/responses.d.ts +169 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +112 -0
- package/src/openapi.yaml +608 -1
- package/src/schema.d.ts +332 -0
package/src/helpers/keys.ts
CHANGED
|
@@ -115,6 +115,7 @@ import { LaunchPhaseBase } from './schemas';
|
|
|
115
115
|
import { LaunchPhasesBase } from './schemas';
|
|
116
116
|
import { LocalPresenceBase } from './schemas';
|
|
117
117
|
import { Nameserver } from './schemas';
|
|
118
|
+
import { ObjectLog } from './schemas';
|
|
118
119
|
import { Organization } from './schemas';
|
|
119
120
|
import { OrganizationAttribute } from './schemas';
|
|
120
121
|
import { OrganizationAttributeCreate } from './schemas';
|
|
@@ -136,6 +137,7 @@ import { PublicAuthRequestForm } from './schemas';
|
|
|
136
137
|
import { RdapBase } from './schemas';
|
|
137
138
|
import { RegistryLockBase } from './schemas';
|
|
138
139
|
import { RelationSet } from './schemas';
|
|
140
|
+
import { RequestHistory } from './schemas';
|
|
139
141
|
import { ReservedDomainsBase } from './schemas';
|
|
140
142
|
import { RgpOperations } from './schemas';
|
|
141
143
|
import { SldLength } from './schemas';
|
|
@@ -12849,6 +12851,268 @@ export const KEYS_NAMESERVER = [
|
|
|
12849
12851
|
KEY_NAMESERVER_IP_ADDRESSES,
|
|
12850
12852
|
] as const satisfies (keyof Nameserver)[];
|
|
12851
12853
|
|
|
12854
|
+
/**
|
|
12855
|
+
* action property
|
|
12856
|
+
*
|
|
12857
|
+
* Action performed
|
|
12858
|
+
*
|
|
12859
|
+
*
|
|
12860
|
+
*
|
|
12861
|
+
* @remarks
|
|
12862
|
+
* This key constant provides type-safe access to the `action` property of ObjectLog objects.
|
|
12863
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12864
|
+
*
|
|
12865
|
+
* @example
|
|
12866
|
+
* ```typescript
|
|
12867
|
+
* // Direct property access
|
|
12868
|
+
* const value = objectlog[KEY_OBJECT_LOG_ACTION];
|
|
12869
|
+
*
|
|
12870
|
+
* // Dynamic property access
|
|
12871
|
+
* const propertyName = KEY_OBJECT_LOG_ACTION;
|
|
12872
|
+
* const value = objectlog[propertyName];
|
|
12873
|
+
* ```
|
|
12874
|
+
*
|
|
12875
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
12876
|
+
* @see {@link KEYS_OBJECT_LOG} - Array of all keys for this type
|
|
12877
|
+
*/
|
|
12878
|
+
export const KEY_OBJECT_LOG_ACTION = 'action' as keyof ObjectLog;
|
|
12879
|
+
/**
|
|
12880
|
+
* Created On
|
|
12881
|
+
*
|
|
12882
|
+
* Timestamp when the log was created
|
|
12883
|
+
*
|
|
12884
|
+
* @type {string}
|
|
12885
|
+
*
|
|
12886
|
+
*
|
|
12887
|
+
* @remarks
|
|
12888
|
+
* This key constant provides type-safe access to the `created_on` property of ObjectLog objects.
|
|
12889
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12890
|
+
*
|
|
12891
|
+
* @example
|
|
12892
|
+
* ```typescript
|
|
12893
|
+
* // Direct property access
|
|
12894
|
+
* const value = objectlog[KEY_OBJECT_LOG_CREATED_ON];
|
|
12895
|
+
*
|
|
12896
|
+
* // Dynamic property access
|
|
12897
|
+
* const propertyName = KEY_OBJECT_LOG_CREATED_ON;
|
|
12898
|
+
* const value = objectlog[propertyName];
|
|
12899
|
+
* ```
|
|
12900
|
+
*
|
|
12901
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
12902
|
+
* @see {@link KEYS_OBJECT_LOG} - Array of all keys for this type
|
|
12903
|
+
*/
|
|
12904
|
+
export const KEY_OBJECT_LOG_CREATED_ON = 'created_on' as keyof ObjectLog;
|
|
12905
|
+
/**
|
|
12906
|
+
* Details
|
|
12907
|
+
*
|
|
12908
|
+
* Changes made to the object
|
|
12909
|
+
*
|
|
12910
|
+
*
|
|
12911
|
+
*
|
|
12912
|
+
* @remarks
|
|
12913
|
+
* This key constant provides type-safe access to the `details` property of ObjectLog objects.
|
|
12914
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12915
|
+
*
|
|
12916
|
+
* @example
|
|
12917
|
+
* ```typescript
|
|
12918
|
+
* // Direct property access
|
|
12919
|
+
* const value = objectlog[KEY_OBJECT_LOG_DETAILS];
|
|
12920
|
+
*
|
|
12921
|
+
* // Dynamic property access
|
|
12922
|
+
* const propertyName = KEY_OBJECT_LOG_DETAILS;
|
|
12923
|
+
* const value = objectlog[propertyName];
|
|
12924
|
+
* ```
|
|
12925
|
+
*
|
|
12926
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
12927
|
+
* @see {@link KEYS_OBJECT_LOG} - Array of all keys for this type
|
|
12928
|
+
*/
|
|
12929
|
+
export const KEY_OBJECT_LOG_DETAILS = 'details' as keyof ObjectLog;
|
|
12930
|
+
/**
|
|
12931
|
+
* Object Id
|
|
12932
|
+
*
|
|
12933
|
+
* ID of the object
|
|
12934
|
+
*
|
|
12935
|
+
* @type {string}
|
|
12936
|
+
*
|
|
12937
|
+
*
|
|
12938
|
+
* @remarks
|
|
12939
|
+
* This key constant provides type-safe access to the `object_id` property of ObjectLog objects.
|
|
12940
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12941
|
+
*
|
|
12942
|
+
* @example
|
|
12943
|
+
* ```typescript
|
|
12944
|
+
* // Direct property access
|
|
12945
|
+
* const value = objectlog[KEY_OBJECT_LOG_OBJECT_ID];
|
|
12946
|
+
*
|
|
12947
|
+
* // Dynamic property access
|
|
12948
|
+
* const propertyName = KEY_OBJECT_LOG_OBJECT_ID;
|
|
12949
|
+
* const value = objectlog[propertyName];
|
|
12950
|
+
* ```
|
|
12951
|
+
*
|
|
12952
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
12953
|
+
* @see {@link KEYS_OBJECT_LOG} - Array of all keys for this type
|
|
12954
|
+
*/
|
|
12955
|
+
export const KEY_OBJECT_LOG_OBJECT_ID = 'object_id' as keyof ObjectLog;
|
|
12956
|
+
/**
|
|
12957
|
+
* Object Log Id
|
|
12958
|
+
*
|
|
12959
|
+
* Unique ID of the log
|
|
12960
|
+
*
|
|
12961
|
+
* @type {string}
|
|
12962
|
+
*
|
|
12963
|
+
*
|
|
12964
|
+
* @remarks
|
|
12965
|
+
* This key constant provides type-safe access to the `object_log_id` property of ObjectLog objects.
|
|
12966
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12967
|
+
*
|
|
12968
|
+
* @example
|
|
12969
|
+
* ```typescript
|
|
12970
|
+
* // Direct property access
|
|
12971
|
+
* const value = objectlog[KEY_OBJECT_LOG_OBJECT_LOG_ID];
|
|
12972
|
+
*
|
|
12973
|
+
* // Dynamic property access
|
|
12974
|
+
* const propertyName = KEY_OBJECT_LOG_OBJECT_LOG_ID;
|
|
12975
|
+
* const value = objectlog[propertyName];
|
|
12976
|
+
* ```
|
|
12977
|
+
*
|
|
12978
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
12979
|
+
* @see {@link KEYS_OBJECT_LOG} - Array of all keys for this type
|
|
12980
|
+
*/
|
|
12981
|
+
export const KEY_OBJECT_LOG_OBJECT_LOG_ID = 'object_log_id' as keyof ObjectLog;
|
|
12982
|
+
/**
|
|
12983
|
+
* Object Type
|
|
12984
|
+
*
|
|
12985
|
+
* Type of the object
|
|
12986
|
+
*
|
|
12987
|
+
* @type {string}
|
|
12988
|
+
*
|
|
12989
|
+
*
|
|
12990
|
+
* @remarks
|
|
12991
|
+
* This key constant provides type-safe access to the `object_type` property of ObjectLog objects.
|
|
12992
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12993
|
+
*
|
|
12994
|
+
* @example
|
|
12995
|
+
* ```typescript
|
|
12996
|
+
* // Direct property access
|
|
12997
|
+
* const value = objectlog[KEY_OBJECT_LOG_OBJECT_TYPE];
|
|
12998
|
+
*
|
|
12999
|
+
* // Dynamic property access
|
|
13000
|
+
* const propertyName = KEY_OBJECT_LOG_OBJECT_TYPE;
|
|
13001
|
+
* const value = objectlog[propertyName];
|
|
13002
|
+
* ```
|
|
13003
|
+
*
|
|
13004
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
13005
|
+
* @see {@link KEYS_OBJECT_LOG} - Array of all keys for this type
|
|
13006
|
+
*/
|
|
13007
|
+
export const KEY_OBJECT_LOG_OBJECT_TYPE = 'object_type' as keyof ObjectLog;
|
|
13008
|
+
/**
|
|
13009
|
+
* Performed By Id
|
|
13010
|
+
*
|
|
13011
|
+
* ID of the actor who performed the action
|
|
13012
|
+
*
|
|
13013
|
+
*
|
|
13014
|
+
*
|
|
13015
|
+
* @remarks
|
|
13016
|
+
* This key constant provides type-safe access to the `performed_by_id` property of ObjectLog objects.
|
|
13017
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
13018
|
+
*
|
|
13019
|
+
* @example
|
|
13020
|
+
* ```typescript
|
|
13021
|
+
* // Direct property access
|
|
13022
|
+
* const value = objectlog[KEY_OBJECT_LOG_PERFORMED_BY_ID];
|
|
13023
|
+
*
|
|
13024
|
+
* // Dynamic property access
|
|
13025
|
+
* const propertyName = KEY_OBJECT_LOG_PERFORMED_BY_ID;
|
|
13026
|
+
* const value = objectlog[propertyName];
|
|
13027
|
+
* ```
|
|
13028
|
+
*
|
|
13029
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
13030
|
+
* @see {@link KEYS_OBJECT_LOG} - Array of all keys for this type
|
|
13031
|
+
*/
|
|
13032
|
+
export const KEY_OBJECT_LOG_PERFORMED_BY_ID = 'performed_by_id' as keyof ObjectLog;
|
|
13033
|
+
/**
|
|
13034
|
+
* Performed By Type
|
|
13035
|
+
*
|
|
13036
|
+
* Type of the actor who performed the action
|
|
13037
|
+
*
|
|
13038
|
+
*
|
|
13039
|
+
*
|
|
13040
|
+
* @remarks
|
|
13041
|
+
* This key constant provides type-safe access to the `performed_by_type` property of ObjectLog objects.
|
|
13042
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
13043
|
+
*
|
|
13044
|
+
* @example
|
|
13045
|
+
* ```typescript
|
|
13046
|
+
* // Direct property access
|
|
13047
|
+
* const value = objectlog[KEY_OBJECT_LOG_PERFORMED_BY_TYPE];
|
|
13048
|
+
*
|
|
13049
|
+
* // Dynamic property access
|
|
13050
|
+
* const propertyName = KEY_OBJECT_LOG_PERFORMED_BY_TYPE;
|
|
13051
|
+
* const value = objectlog[propertyName];
|
|
13052
|
+
* ```
|
|
13053
|
+
*
|
|
13054
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
13055
|
+
* @see {@link KEYS_OBJECT_LOG} - Array of all keys for this type
|
|
13056
|
+
*/
|
|
13057
|
+
export const KEY_OBJECT_LOG_PERFORMED_BY_TYPE = 'performed_by_type' as keyof ObjectLog;
|
|
13058
|
+
/**
|
|
13059
|
+
* Server Request Id
|
|
13060
|
+
*
|
|
13061
|
+
* Server request ID
|
|
13062
|
+
*
|
|
13063
|
+
*
|
|
13064
|
+
*
|
|
13065
|
+
* @remarks
|
|
13066
|
+
* This key constant provides type-safe access to the `server_request_id` property of ObjectLog objects.
|
|
13067
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
13068
|
+
*
|
|
13069
|
+
* @example
|
|
13070
|
+
* ```typescript
|
|
13071
|
+
* // Direct property access
|
|
13072
|
+
* const value = objectlog[KEY_OBJECT_LOG_SERVER_REQUEST_ID];
|
|
13073
|
+
*
|
|
13074
|
+
* // Dynamic property access
|
|
13075
|
+
* const propertyName = KEY_OBJECT_LOG_SERVER_REQUEST_ID;
|
|
13076
|
+
* const value = objectlog[propertyName];
|
|
13077
|
+
* ```
|
|
13078
|
+
*
|
|
13079
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
13080
|
+
* @see {@link KEYS_OBJECT_LOG} - Array of all keys for this type
|
|
13081
|
+
*/
|
|
13082
|
+
export const KEY_OBJECT_LOG_SERVER_REQUEST_ID = 'server_request_id' as keyof ObjectLog;
|
|
13083
|
+
|
|
13084
|
+
/**
|
|
13085
|
+
* Array of all ObjectLog property keys
|
|
13086
|
+
*
|
|
13087
|
+
* @remarks
|
|
13088
|
+
* This constant provides a readonly array containing all valid property keys for ObjectLog objects.
|
|
13089
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
13090
|
+
*
|
|
13091
|
+
* @example
|
|
13092
|
+
* ```typescript
|
|
13093
|
+
* // Iterating through all keys
|
|
13094
|
+
* for (const key of KEYS_OBJECT_LOG) {
|
|
13095
|
+
* console.log(`Property: ${key}, Value: ${objectlog[key]}`);
|
|
13096
|
+
* }
|
|
13097
|
+
*
|
|
13098
|
+
* // Validation
|
|
13099
|
+
* const isValidKey = KEYS_OBJECT_LOG.includes(someKey);
|
|
13100
|
+
* ```
|
|
13101
|
+
*
|
|
13102
|
+
* @see {@link ObjectLog} - The TypeScript type definition
|
|
13103
|
+
*/
|
|
13104
|
+
export const KEYS_OBJECT_LOG = [
|
|
13105
|
+
KEY_OBJECT_LOG_ACTION,
|
|
13106
|
+
KEY_OBJECT_LOG_CREATED_ON,
|
|
13107
|
+
KEY_OBJECT_LOG_DETAILS,
|
|
13108
|
+
KEY_OBJECT_LOG_OBJECT_ID,
|
|
13109
|
+
KEY_OBJECT_LOG_OBJECT_LOG_ID,
|
|
13110
|
+
KEY_OBJECT_LOG_OBJECT_TYPE,
|
|
13111
|
+
KEY_OBJECT_LOG_PERFORMED_BY_ID,
|
|
13112
|
+
KEY_OBJECT_LOG_PERFORMED_BY_TYPE,
|
|
13113
|
+
KEY_OBJECT_LOG_SERVER_REQUEST_ID,
|
|
13114
|
+
] as const satisfies (keyof ObjectLog)[];
|
|
13115
|
+
|
|
12852
13116
|
/**
|
|
12853
13117
|
* Address 1
|
|
12854
13118
|
*
|
|
@@ -16731,6 +16995,350 @@ export const KEYS_RELATION_SET = [
|
|
|
16731
16995
|
KEY_RELATION_SET_RELATIONS,
|
|
16732
16996
|
] as const satisfies (keyof RelationSet)[];
|
|
16733
16997
|
|
|
16998
|
+
/**
|
|
16999
|
+
* Client Ip
|
|
17000
|
+
*
|
|
17001
|
+
* Client IP address
|
|
17002
|
+
*
|
|
17003
|
+
* @type {string}
|
|
17004
|
+
*
|
|
17005
|
+
*
|
|
17006
|
+
* @remarks
|
|
17007
|
+
* This key constant provides type-safe access to the `client_ip` property of RequestHistory objects.
|
|
17008
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17009
|
+
*
|
|
17010
|
+
* @example
|
|
17011
|
+
* ```typescript
|
|
17012
|
+
* // Direct property access
|
|
17013
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_CLIENT_IP];
|
|
17014
|
+
*
|
|
17015
|
+
* // Dynamic property access
|
|
17016
|
+
* const propertyName = KEY_REQUEST_HISTORY_CLIENT_IP;
|
|
17017
|
+
* const value = requesthistory[propertyName];
|
|
17018
|
+
* ```
|
|
17019
|
+
*
|
|
17020
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17021
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17022
|
+
*/
|
|
17023
|
+
export const KEY_REQUEST_HISTORY_CLIENT_IP = 'client_ip' as keyof RequestHistory;
|
|
17024
|
+
/**
|
|
17025
|
+
* Duration
|
|
17026
|
+
*
|
|
17027
|
+
* Request duration in milliseconds
|
|
17028
|
+
*
|
|
17029
|
+
* @type {number}
|
|
17030
|
+
*
|
|
17031
|
+
*
|
|
17032
|
+
* @remarks
|
|
17033
|
+
* This key constant provides type-safe access to the `duration` property of RequestHistory objects.
|
|
17034
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17035
|
+
*
|
|
17036
|
+
* @example
|
|
17037
|
+
* ```typescript
|
|
17038
|
+
* // Direct property access
|
|
17039
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_DURATION];
|
|
17040
|
+
*
|
|
17041
|
+
* // Dynamic property access
|
|
17042
|
+
* const propertyName = KEY_REQUEST_HISTORY_DURATION;
|
|
17043
|
+
* const value = requesthistory[propertyName];
|
|
17044
|
+
* ```
|
|
17045
|
+
*
|
|
17046
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17047
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17048
|
+
*/
|
|
17049
|
+
export const KEY_REQUEST_HISTORY_DURATION = 'duration' as keyof RequestHistory;
|
|
17050
|
+
/**
|
|
17051
|
+
* Method
|
|
17052
|
+
*
|
|
17053
|
+
* HTTP method
|
|
17054
|
+
*
|
|
17055
|
+
* @type {string}
|
|
17056
|
+
*
|
|
17057
|
+
*
|
|
17058
|
+
* @remarks
|
|
17059
|
+
* This key constant provides type-safe access to the `method` property of RequestHistory objects.
|
|
17060
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17061
|
+
*
|
|
17062
|
+
* @example
|
|
17063
|
+
* ```typescript
|
|
17064
|
+
* // Direct property access
|
|
17065
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_METHOD];
|
|
17066
|
+
*
|
|
17067
|
+
* // Dynamic property access
|
|
17068
|
+
* const propertyName = KEY_REQUEST_HISTORY_METHOD;
|
|
17069
|
+
* const value = requesthistory[propertyName];
|
|
17070
|
+
* ```
|
|
17071
|
+
*
|
|
17072
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17073
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17074
|
+
*/
|
|
17075
|
+
export const KEY_REQUEST_HISTORY_METHOD = 'method' as keyof RequestHistory;
|
|
17076
|
+
/**
|
|
17077
|
+
* Path
|
|
17078
|
+
*
|
|
17079
|
+
* Request path
|
|
17080
|
+
*
|
|
17081
|
+
* @type {string}
|
|
17082
|
+
*
|
|
17083
|
+
*
|
|
17084
|
+
* @remarks
|
|
17085
|
+
* This key constant provides type-safe access to the `path` property of RequestHistory objects.
|
|
17086
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17087
|
+
*
|
|
17088
|
+
* @example
|
|
17089
|
+
* ```typescript
|
|
17090
|
+
* // Direct property access
|
|
17091
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_PATH];
|
|
17092
|
+
*
|
|
17093
|
+
* // Dynamic property access
|
|
17094
|
+
* const propertyName = KEY_REQUEST_HISTORY_PATH;
|
|
17095
|
+
* const value = requesthistory[propertyName];
|
|
17096
|
+
* ```
|
|
17097
|
+
*
|
|
17098
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17099
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17100
|
+
*/
|
|
17101
|
+
export const KEY_REQUEST_HISTORY_PATH = 'path' as keyof RequestHistory;
|
|
17102
|
+
/**
|
|
17103
|
+
* Performed By Id
|
|
17104
|
+
*
|
|
17105
|
+
* ID of the actor who performed the request
|
|
17106
|
+
*
|
|
17107
|
+
*
|
|
17108
|
+
*
|
|
17109
|
+
* @remarks
|
|
17110
|
+
* This key constant provides type-safe access to the `performed_by_id` property of RequestHistory objects.
|
|
17111
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17112
|
+
*
|
|
17113
|
+
* @example
|
|
17114
|
+
* ```typescript
|
|
17115
|
+
* // Direct property access
|
|
17116
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_PERFORMED_BY_ID];
|
|
17117
|
+
*
|
|
17118
|
+
* // Dynamic property access
|
|
17119
|
+
* const propertyName = KEY_REQUEST_HISTORY_PERFORMED_BY_ID;
|
|
17120
|
+
* const value = requesthistory[propertyName];
|
|
17121
|
+
* ```
|
|
17122
|
+
*
|
|
17123
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17124
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17125
|
+
*/
|
|
17126
|
+
export const KEY_REQUEST_HISTORY_PERFORMED_BY_ID = 'performed_by_id' as keyof RequestHistory;
|
|
17127
|
+
/**
|
|
17128
|
+
* Performed By Type
|
|
17129
|
+
*
|
|
17130
|
+
* Type of the actor who performed the request
|
|
17131
|
+
*
|
|
17132
|
+
*
|
|
17133
|
+
*
|
|
17134
|
+
* @remarks
|
|
17135
|
+
* This key constant provides type-safe access to the `performed_by_type` property of RequestHistory objects.
|
|
17136
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17137
|
+
*
|
|
17138
|
+
* @example
|
|
17139
|
+
* ```typescript
|
|
17140
|
+
* // Direct property access
|
|
17141
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_PERFORMED_BY_TYPE];
|
|
17142
|
+
*
|
|
17143
|
+
* // Dynamic property access
|
|
17144
|
+
* const propertyName = KEY_REQUEST_HISTORY_PERFORMED_BY_TYPE;
|
|
17145
|
+
* const value = requesthistory[propertyName];
|
|
17146
|
+
* ```
|
|
17147
|
+
*
|
|
17148
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17149
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17150
|
+
*/
|
|
17151
|
+
export const KEY_REQUEST_HISTORY_PERFORMED_BY_TYPE = 'performed_by_type' as keyof RequestHistory;
|
|
17152
|
+
/**
|
|
17153
|
+
* Request Body
|
|
17154
|
+
*
|
|
17155
|
+
* Request body
|
|
17156
|
+
*
|
|
17157
|
+
*
|
|
17158
|
+
*
|
|
17159
|
+
* @remarks
|
|
17160
|
+
* This key constant provides type-safe access to the `request_body` property of RequestHistory objects.
|
|
17161
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17162
|
+
*
|
|
17163
|
+
* @example
|
|
17164
|
+
* ```typescript
|
|
17165
|
+
* // Direct property access
|
|
17166
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_REQUEST_BODY];
|
|
17167
|
+
*
|
|
17168
|
+
* // Dynamic property access
|
|
17169
|
+
* const propertyName = KEY_REQUEST_HISTORY_REQUEST_BODY;
|
|
17170
|
+
* const value = requesthistory[propertyName];
|
|
17171
|
+
* ```
|
|
17172
|
+
*
|
|
17173
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17174
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17175
|
+
*/
|
|
17176
|
+
export const KEY_REQUEST_HISTORY_REQUEST_BODY = 'request_body' as keyof RequestHistory;
|
|
17177
|
+
/**
|
|
17178
|
+
* Request Completed At
|
|
17179
|
+
*
|
|
17180
|
+
* Timestamp when the request completed
|
|
17181
|
+
*
|
|
17182
|
+
* @type {string}
|
|
17183
|
+
*
|
|
17184
|
+
*
|
|
17185
|
+
* @remarks
|
|
17186
|
+
* This key constant provides type-safe access to the `request_completed_at` property of RequestHistory objects.
|
|
17187
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17188
|
+
*
|
|
17189
|
+
* @example
|
|
17190
|
+
* ```typescript
|
|
17191
|
+
* // Direct property access
|
|
17192
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_REQUEST_COMPLETED_AT];
|
|
17193
|
+
*
|
|
17194
|
+
* // Dynamic property access
|
|
17195
|
+
* const propertyName = KEY_REQUEST_HISTORY_REQUEST_COMPLETED_AT;
|
|
17196
|
+
* const value = requesthistory[propertyName];
|
|
17197
|
+
* ```
|
|
17198
|
+
*
|
|
17199
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17200
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17201
|
+
*/
|
|
17202
|
+
export const KEY_REQUEST_HISTORY_REQUEST_COMPLETED_AT = 'request_completed_at' as keyof RequestHistory;
|
|
17203
|
+
/**
|
|
17204
|
+
* Request Started At
|
|
17205
|
+
*
|
|
17206
|
+
* Timestamp when the request started
|
|
17207
|
+
*
|
|
17208
|
+
* @type {string}
|
|
17209
|
+
*
|
|
17210
|
+
*
|
|
17211
|
+
* @remarks
|
|
17212
|
+
* This key constant provides type-safe access to the `request_started_at` property of RequestHistory objects.
|
|
17213
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17214
|
+
*
|
|
17215
|
+
* @example
|
|
17216
|
+
* ```typescript
|
|
17217
|
+
* // Direct property access
|
|
17218
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_REQUEST_STARTED_AT];
|
|
17219
|
+
*
|
|
17220
|
+
* // Dynamic property access
|
|
17221
|
+
* const propertyName = KEY_REQUEST_HISTORY_REQUEST_STARTED_AT;
|
|
17222
|
+
* const value = requesthistory[propertyName];
|
|
17223
|
+
* ```
|
|
17224
|
+
*
|
|
17225
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17226
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17227
|
+
*/
|
|
17228
|
+
export const KEY_REQUEST_HISTORY_REQUEST_STARTED_AT = 'request_started_at' as keyof RequestHistory;
|
|
17229
|
+
/**
|
|
17230
|
+
* Response Body
|
|
17231
|
+
*
|
|
17232
|
+
* Response body
|
|
17233
|
+
*
|
|
17234
|
+
*
|
|
17235
|
+
*
|
|
17236
|
+
* @remarks
|
|
17237
|
+
* This key constant provides type-safe access to the `response_body` property of RequestHistory objects.
|
|
17238
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17239
|
+
*
|
|
17240
|
+
* @example
|
|
17241
|
+
* ```typescript
|
|
17242
|
+
* // Direct property access
|
|
17243
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_RESPONSE_BODY];
|
|
17244
|
+
*
|
|
17245
|
+
* // Dynamic property access
|
|
17246
|
+
* const propertyName = KEY_REQUEST_HISTORY_RESPONSE_BODY;
|
|
17247
|
+
* const value = requesthistory[propertyName];
|
|
17248
|
+
* ```
|
|
17249
|
+
*
|
|
17250
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17251
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17252
|
+
*/
|
|
17253
|
+
export const KEY_REQUEST_HISTORY_RESPONSE_BODY = 'response_body' as keyof RequestHistory;
|
|
17254
|
+
/**
|
|
17255
|
+
* Server Request Id
|
|
17256
|
+
*
|
|
17257
|
+
* Unique ID of the request
|
|
17258
|
+
*
|
|
17259
|
+
* @type {string}
|
|
17260
|
+
*
|
|
17261
|
+
*
|
|
17262
|
+
* @remarks
|
|
17263
|
+
* This key constant provides type-safe access to the `server_request_id` property of RequestHistory objects.
|
|
17264
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17265
|
+
*
|
|
17266
|
+
* @example
|
|
17267
|
+
* ```typescript
|
|
17268
|
+
* // Direct property access
|
|
17269
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_SERVER_REQUEST_ID];
|
|
17270
|
+
*
|
|
17271
|
+
* // Dynamic property access
|
|
17272
|
+
* const propertyName = KEY_REQUEST_HISTORY_SERVER_REQUEST_ID;
|
|
17273
|
+
* const value = requesthistory[propertyName];
|
|
17274
|
+
* ```
|
|
17275
|
+
*
|
|
17276
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17277
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17278
|
+
*/
|
|
17279
|
+
export const KEY_REQUEST_HISTORY_SERVER_REQUEST_ID = 'server_request_id' as keyof RequestHistory;
|
|
17280
|
+
/**
|
|
17281
|
+
* Status Code
|
|
17282
|
+
*
|
|
17283
|
+
* HTTP status code
|
|
17284
|
+
*
|
|
17285
|
+
* @type {integer}
|
|
17286
|
+
*
|
|
17287
|
+
*
|
|
17288
|
+
* @remarks
|
|
17289
|
+
* This key constant provides type-safe access to the `status_code` property of RequestHistory objects.
|
|
17290
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17291
|
+
*
|
|
17292
|
+
* @example
|
|
17293
|
+
* ```typescript
|
|
17294
|
+
* // Direct property access
|
|
17295
|
+
* const value = requesthistory[KEY_REQUEST_HISTORY_STATUS_CODE];
|
|
17296
|
+
*
|
|
17297
|
+
* // Dynamic property access
|
|
17298
|
+
* const propertyName = KEY_REQUEST_HISTORY_STATUS_CODE;
|
|
17299
|
+
* const value = requesthistory[propertyName];
|
|
17300
|
+
* ```
|
|
17301
|
+
*
|
|
17302
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17303
|
+
* @see {@link KEYS_REQUEST_HISTORY} - Array of all keys for this type
|
|
17304
|
+
*/
|
|
17305
|
+
export const KEY_REQUEST_HISTORY_STATUS_CODE = 'status_code' as keyof RequestHistory;
|
|
17306
|
+
|
|
17307
|
+
/**
|
|
17308
|
+
* Array of all RequestHistory property keys
|
|
17309
|
+
*
|
|
17310
|
+
* @remarks
|
|
17311
|
+
* This constant provides a readonly array containing all valid property keys for RequestHistory objects.
|
|
17312
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
17313
|
+
*
|
|
17314
|
+
* @example
|
|
17315
|
+
* ```typescript
|
|
17316
|
+
* // Iterating through all keys
|
|
17317
|
+
* for (const key of KEYS_REQUEST_HISTORY) {
|
|
17318
|
+
* console.log(`Property: ${key}, Value: ${requesthistory[key]}`);
|
|
17319
|
+
* }
|
|
17320
|
+
*
|
|
17321
|
+
* // Validation
|
|
17322
|
+
* const isValidKey = KEYS_REQUEST_HISTORY.includes(someKey);
|
|
17323
|
+
* ```
|
|
17324
|
+
*
|
|
17325
|
+
* @see {@link RequestHistory} - The TypeScript type definition
|
|
17326
|
+
*/
|
|
17327
|
+
export const KEYS_REQUEST_HISTORY = [
|
|
17328
|
+
KEY_REQUEST_HISTORY_CLIENT_IP,
|
|
17329
|
+
KEY_REQUEST_HISTORY_DURATION,
|
|
17330
|
+
KEY_REQUEST_HISTORY_METHOD,
|
|
17331
|
+
KEY_REQUEST_HISTORY_PATH,
|
|
17332
|
+
KEY_REQUEST_HISTORY_PERFORMED_BY_ID,
|
|
17333
|
+
KEY_REQUEST_HISTORY_PERFORMED_BY_TYPE,
|
|
17334
|
+
KEY_REQUEST_HISTORY_REQUEST_BODY,
|
|
17335
|
+
KEY_REQUEST_HISTORY_REQUEST_COMPLETED_AT,
|
|
17336
|
+
KEY_REQUEST_HISTORY_REQUEST_STARTED_AT,
|
|
17337
|
+
KEY_REQUEST_HISTORY_RESPONSE_BODY,
|
|
17338
|
+
KEY_REQUEST_HISTORY_SERVER_REQUEST_ID,
|
|
17339
|
+
KEY_REQUEST_HISTORY_STATUS_CODE,
|
|
17340
|
+
] as const satisfies (keyof RequestHistory)[];
|
|
17341
|
+
|
|
16734
17342
|
/**
|
|
16735
17343
|
* source property
|
|
16736
17344
|
*
|