@uipath/aops-policy-sdk 1.203.0-preview.203
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/LICENSE.txt +3 -0
- package/README.md +60 -0
- package/dist/generated/src/apis/ApplicationSettingApi.d.ts +37 -0
- package/dist/generated/src/apis/ContentApi.d.ts +198 -0
- package/dist/generated/src/apis/DeploymentTypeApi.d.ts +26 -0
- package/dist/generated/src/apis/GroupApi.d.ts +74 -0
- package/dist/generated/src/apis/GwsPartitionMoveApi.d.ts +196 -0
- package/dist/generated/src/apis/HomeApi.d.ts +27 -0
- package/dist/generated/src/apis/InternalContentApi.d.ts +45 -0
- package/dist/generated/src/apis/LicenseTypeApi.d.ts +93 -0
- package/dist/generated/src/apis/MaintenanceApi.d.ts +26 -0
- package/dist/generated/src/apis/MessageBusApi.d.ts +40 -0
- package/dist/generated/src/apis/MigrationApi.d.ts +25 -0
- package/dist/generated/src/apis/ModuleFederationApi.d.ts +28 -0
- package/dist/generated/src/apis/NotificationApi.d.ts +37 -0
- package/dist/generated/src/apis/OrganizationApi.d.ts +55 -0
- package/dist/generated/src/apis/PolicyApi.d.ts +379 -0
- package/dist/generated/src/apis/ProductApi.d.ts +125 -0
- package/dist/generated/src/apis/RuleApi.d.ts +29 -0
- package/dist/generated/src/apis/RulesContractsApi.d.ts +29 -0
- package/dist/generated/src/apis/S2SContentApi.d.ts +114 -0
- package/dist/generated/src/apis/TenantApi.d.ts +69 -0
- package/dist/generated/src/apis/TranslationApi.d.ts +28 -0
- package/dist/generated/src/apis/UserApi.d.ts +74 -0
- package/dist/generated/src/apis/UserEntitlementsApi.d.ts +31 -0
- package/dist/generated/src/apis/UserPoliciesApi.d.ts +40 -0
- package/dist/generated/src/apis/index.d.ts +24 -0
- package/dist/generated/src/index.d.ts +3 -0
- package/dist/generated/src/models/AccountState.d.ts +28 -0
- package/dist/generated/src/models/AccountStateDto.d.ts +33 -0
- package/dist/generated/src/models/AddLicenseTypeRequest.d.ts +38 -0
- package/dist/generated/src/models/CloudEvent.d.ts +82 -0
- package/dist/generated/src/models/CompatibilityReportRequest.d.ts +44 -0
- package/dist/generated/src/models/CompatibilityReportResponse.d.ts +50 -0
- package/dist/generated/src/models/CreateGlobalPolicyWithFormDataRequest.d.ts +33 -0
- package/dist/generated/src/models/CreatePolicyRequest.d.ts +62 -0
- package/dist/generated/src/models/CreatePolicyWithFormDataRequest.d.ts +40 -0
- package/dist/generated/src/models/DataCollectionOptions.d.ts +40 -0
- package/dist/generated/src/models/DataMoveRequest.d.ts +64 -0
- package/dist/generated/src/models/DataMoveResponse.d.ts +50 -0
- package/dist/generated/src/models/DeletePartitionRequestDto.d.ts +50 -0
- package/dist/generated/src/models/DeletePartitionResponseDto.d.ts +50 -0
- package/dist/generated/src/models/DeleteRequest.d.ts +38 -0
- package/dist/generated/src/models/DeleteResponse.d.ts +44 -0
- package/dist/generated/src/models/DeployedPolicyDto.d.ts +50 -0
- package/dist/generated/src/models/DeployedPolicyWithoutUserDto.d.ts +44 -0
- package/dist/generated/src/models/DeploymentLevel.d.ts +26 -0
- package/dist/generated/src/models/DeploymentTypeOptions.d.ts +32 -0
- package/dist/generated/src/models/EvaluateRule.d.ts +45 -0
- package/dist/generated/src/models/FederatedPolicyDto.d.ts +84 -0
- package/dist/generated/src/models/FederatedPolicyDtoPagedResult.d.ts +39 -0
- package/dist/generated/src/models/FinalizeRequest.d.ts +32 -0
- package/dist/generated/src/models/FormDataDto.d.ts +38 -0
- package/dist/generated/src/models/FormTemplateDto.d.ts +70 -0
- package/dist/generated/src/models/GlobalPolicyDto.d.ts +57 -0
- package/dist/generated/src/models/GovernanceQueryOptions.d.ts +75 -0
- package/dist/generated/src/models/GroupDto.d.ts +63 -0
- package/dist/generated/src/models/GroupDtoPagedResult.d.ts +39 -0
- package/dist/generated/src/models/GroupPolicyDto.d.ts +50 -0
- package/dist/generated/src/models/GroupToAddDto.d.ts +45 -0
- package/dist/generated/src/models/ImportPolicyRequest.d.ts +50 -0
- package/dist/generated/src/models/InstanceState.d.ts +26 -0
- package/dist/generated/src/models/InstanceStateDto.d.ts +33 -0
- package/dist/generated/src/models/LicenseTypeDto.d.ts +51 -0
- package/dist/generated/src/models/LicenseTypeProductsDto.d.ts +33 -0
- package/dist/generated/src/models/MaintenanceModeRequest.d.ts +38 -0
- package/dist/generated/src/models/MaintenanceModeResponse.d.ts +44 -0
- package/dist/generated/src/models/NotificationDto.d.ts +40 -0
- package/dist/generated/src/models/NotificationType.d.ts +25 -0
- package/dist/generated/src/models/OrganizationType.d.ts +25 -0
- package/dist/generated/src/models/Partition.d.ts +57 -0
- package/dist/generated/src/models/PartitionProductDto.d.ts +51 -0
- package/dist/generated/src/models/PolicyDto.d.ts +70 -0
- package/dist/generated/src/models/PolicyDtoPagedResult.d.ts +39 -0
- package/dist/generated/src/models/PolicyExportResponse.d.ts +63 -0
- package/dist/generated/src/models/PolicyInfoDto.d.ts +44 -0
- package/dist/generated/src/models/PolicyUsageData.d.ts +44 -0
- package/dist/generated/src/models/Product.d.ts +45 -0
- package/dist/generated/src/models/ProductDto.d.ts +56 -0
- package/dist/generated/src/models/PropertiesResponse.d.ts +34 -0
- package/dist/generated/src/models/RestorePartitionRequestDto.d.ts +50 -0
- package/dist/generated/src/models/RestorePartitionResponseDto.d.ts +44 -0
- package/dist/generated/src/models/RollbackRequest.d.ts +38 -0
- package/dist/generated/src/models/RollbackResponse.d.ts +44 -0
- package/dist/generated/src/models/RulesContractEntity.d.ts +65 -0
- package/dist/generated/src/models/RulesContractualOptions.d.ts +33 -0
- package/dist/generated/src/models/SeedContentRequest.d.ts +47 -0
- package/dist/generated/src/models/SortOrder.d.ts +25 -0
- package/dist/generated/src/models/TenantDto.d.ts +57 -0
- package/dist/generated/src/models/TenantDtoPagedResult.d.ts +39 -0
- package/dist/generated/src/models/TenantPolicyDto.d.ts +56 -0
- package/dist/generated/src/models/UpdateFormTemplateRequest.d.ts +51 -0
- package/dist/generated/src/models/UpdateLicenseTypeRequest.d.ts +38 -0
- package/dist/generated/src/models/UpdatePolicyRequest.d.ts +68 -0
- package/dist/generated/src/models/UserDto.d.ts +69 -0
- package/dist/generated/src/models/UserDtoPagedResult.d.ts +39 -0
- package/dist/generated/src/models/UserPolicyDto.d.ts +50 -0
- package/dist/generated/src/models/UserToAddDto.d.ts +45 -0
- package/dist/generated/src/models/Version.d.ts +32 -0
- package/dist/generated/src/models/VersionDto.d.ts +44 -0
- package/dist/generated/src/models/index.d.ts +72 -0
- package/dist/generated/src/runtime.d.ts +184 -0
- package/dist/index.js +8516 -0
- package/dist/policy-resolver.js +1969 -0
- package/dist/src/client-factory.d.ts +7 -0
- package/dist/src/index.d.ts +4 -0
- package/dist/src/policy-resolver.d.ts +102 -0
- package/dist/src/user-agent.d.ts +1 -0
- package/package.json +46 -0
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Configuration } from "../generated/src/runtime.js";
|
|
2
|
+
export interface CreateApiClientOptions {
|
|
3
|
+
loginValidity?: number;
|
|
4
|
+
s2sToken?: string;
|
|
5
|
+
}
|
|
6
|
+
export declare function createGovernanceConfig(options?: CreateApiClientOptions): Promise<Configuration>;
|
|
7
|
+
export declare function createApiClient<T>(ApiClass: new (config: Configuration) => T, options?: CreateApiClientOptions): Promise<T>;
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Who the policy question is being asked about.
|
|
3
|
+
*
|
|
4
|
+
* Neither {@link PolicySubject.product} nor {@link PolicySubject.licenseType}
|
|
5
|
+
* has a default here on purpose. A default inside a shared library is how one
|
|
6
|
+
* caller came to ask for `StudioWeb` while another asked for `Development`, so
|
|
7
|
+
* the same tenant answered the two differently. The command layer may document
|
|
8
|
+
* a default; this layer may not have one.
|
|
9
|
+
*/
|
|
10
|
+
export interface PolicySubject {
|
|
11
|
+
organizationId: string;
|
|
12
|
+
tenantId: string;
|
|
13
|
+
/** AutomationOps product name, e.g. `StudioWeb`, `Development`, `Business`. */
|
|
14
|
+
product: string;
|
|
15
|
+
/** AutomationOps licence type name, e.g. `NoLicense`, `Development`. */
|
|
16
|
+
licenseType: string;
|
|
17
|
+
}
|
|
18
|
+
/** What was asked, of whom, and when — enough to reproduce or report the call. */
|
|
19
|
+
export interface PolicyAudit {
|
|
20
|
+
/**
|
|
21
|
+
* The URL the request was sent to. Redirects are followed by the
|
|
22
|
+
* underlying fetch, so the body may have come from somewhere else — that
|
|
23
|
+
* is exactly the case `notJson` exists to report.
|
|
24
|
+
*/
|
|
25
|
+
url: string;
|
|
26
|
+
httpStatus?: number;
|
|
27
|
+
/** Parsed from `Retry-After` when present. Advice for the caller; the resolver never retries. */
|
|
28
|
+
retryAfterSeconds?: number;
|
|
29
|
+
resolvedAt: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Why the resolver could not tell whether this subject is governed.
|
|
33
|
+
*
|
|
34
|
+
* Any status that is neither `200` nor `204`, and not a 401/403/404, lands on
|
|
35
|
+
* `serverError` — a 429 and an unexpected 2xx alike. The set is closed so
|
|
36
|
+
* callers can switch on it exhaustively; the exact status is always in
|
|
37
|
+
* {@link PolicyAudit.httpStatus}.
|
|
38
|
+
*/
|
|
39
|
+
export type UnknownReason = "unauthorized" | "notFound" | "notJson" | "serverError" | "timedOut" | "transport" | "cancelled";
|
|
40
|
+
/**
|
|
41
|
+
* The closed set of answers.
|
|
42
|
+
*
|
|
43
|
+
* `ungoverned` is a positive claim — nobody published a policy, or an
|
|
44
|
+
* administrator pinned "No policy" — and only a 204 produces it. Everything
|
|
45
|
+
* else that is not a policy document is `unknown`, which is not the same thing
|
|
46
|
+
* and must not be treated as if it were.
|
|
47
|
+
*/
|
|
48
|
+
export type PolicyResolution = {
|
|
49
|
+
outcome: "governed";
|
|
50
|
+
subject: PolicySubject;
|
|
51
|
+
audit: PolicyAudit;
|
|
52
|
+
/** The response body, byte for byte. Never reserialized. */
|
|
53
|
+
document: string;
|
|
54
|
+
} | {
|
|
55
|
+
outcome: "ungoverned";
|
|
56
|
+
subject: PolicySubject;
|
|
57
|
+
audit: PolicyAudit;
|
|
58
|
+
} | {
|
|
59
|
+
outcome: "unknown";
|
|
60
|
+
subject: PolicySubject;
|
|
61
|
+
audit: PolicyAudit;
|
|
62
|
+
reason: UnknownReason;
|
|
63
|
+
detail: string;
|
|
64
|
+
};
|
|
65
|
+
export interface ResolvePolicyOptions {
|
|
66
|
+
subject: PolicySubject;
|
|
67
|
+
/** Cloud origin, e.g. `https://cloud.uipath.com`. Trailing slashes are trimmed. */
|
|
68
|
+
baseUrl: string;
|
|
69
|
+
accessToken: string | (() => Promise<string>);
|
|
70
|
+
/** Required, non-empty. See {@link CLIENT_VERSION_HEADER}. */
|
|
71
|
+
clientVersion: string;
|
|
72
|
+
fetch?: typeof fetch;
|
|
73
|
+
/** Defaults to {@link DEFAULT_TIMEOUT_MS}. */
|
|
74
|
+
timeoutMs?: number;
|
|
75
|
+
signal?: AbortSignal;
|
|
76
|
+
now?: () => Date;
|
|
77
|
+
}
|
|
78
|
+
/** Matches the fetch budget the Studio host gives the same call. */
|
|
79
|
+
export declare const DEFAULT_TIMEOUT_MS = 10000;
|
|
80
|
+
/**
|
|
81
|
+
* Not a version — a capability declaration.
|
|
82
|
+
*
|
|
83
|
+
* The server only tests it for emptiness (`PolicyApplication.DeterminePolicyMerging`)
|
|
84
|
+
* and never parses it. What it gates is policy merging: for the `Development`
|
|
85
|
+
* and `Business` products the AI Trust Layer policy is merged into the product
|
|
86
|
+
* policy only when this header is present, and that merge overwrites the
|
|
87
|
+
* product policy's `enable-generative-ai` rule with the AI Trust Layer's
|
|
88
|
+
* `wingman` value. Omit the header and those rules are silently lost.
|
|
89
|
+
* `StudioWeb` merges either way, which is why the omission stayed invisible.
|
|
90
|
+
*/
|
|
91
|
+
export declare const CLIENT_VERSION_HEADER = "ClientVersion";
|
|
92
|
+
/**
|
|
93
|
+
* Ask AutomationOps whether this subject is governed, and say which of the
|
|
94
|
+
* three answers came back.
|
|
95
|
+
*
|
|
96
|
+
* Never throws for anything the server or the network can do — only for
|
|
97
|
+
* programmer error (a missing required input), so a caller can write an
|
|
98
|
+
* exhaustive `switch` over the outcome. Never retries: a `Retry-After` is
|
|
99
|
+
* reported in the audit and the decision is the caller's. Never parses the
|
|
100
|
+
* policy — the document is opaque here.
|
|
101
|
+
*/
|
|
102
|
+
export declare function resolvePolicyAsync(options: ResolvePolicyOptions): Promise<PolicyResolution>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const SDK_USER_AGENT: string;
|
package/package.json
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@uipath/aops-policy-sdk",
|
|
3
|
+
"author": "UiPath",
|
|
4
|
+
"license": "SEE LICENSE IN LICENSE.txt",
|
|
5
|
+
"version": "1.203.0-preview.203",
|
|
6
|
+
"description": "SDK for the UiPath AOps Governance API — policy management and deployment.",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/UiPath/cli.git",
|
|
10
|
+
"directory": "packages/gov/aops-policy-sdk"
|
|
11
|
+
},
|
|
12
|
+
"publishConfig": {
|
|
13
|
+
"registry": "https://registry.npmjs.org/"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"uipath",
|
|
17
|
+
"governance",
|
|
18
|
+
"policy",
|
|
19
|
+
"sdk"
|
|
20
|
+
],
|
|
21
|
+
"type": "module",
|
|
22
|
+
"main": "./dist/index.js",
|
|
23
|
+
"types": "./dist/src/index.d.ts",
|
|
24
|
+
"exports": {
|
|
25
|
+
".": {
|
|
26
|
+
"types": "./dist/src/index.d.ts",
|
|
27
|
+
"default": "./dist/index.js"
|
|
28
|
+
},
|
|
29
|
+
"./resolver": {
|
|
30
|
+
"types": "./dist/src/policy-resolver.d.ts",
|
|
31
|
+
"default": "./dist/policy-resolver.js"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"files": [
|
|
35
|
+
"dist"
|
|
36
|
+
],
|
|
37
|
+
"private": false,
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"@openapitools/openapi-generator-cli": "^2.31.1",
|
|
40
|
+
"@types/node": "^25.5.2",
|
|
41
|
+
"@uipath/auth": "1.203.0",
|
|
42
|
+
"@uipath/common": "1.203.0",
|
|
43
|
+
"typescript": "^7.0.2"
|
|
44
|
+
},
|
|
45
|
+
"gitHead": "a10661bf5ec19ddd6c628ed7bb1db55f721a6027"
|
|
46
|
+
}
|