@permguard/permguard 0.0.9

package/dist/index.d.ts

@@ -0,0 +1,190 @@
+interface AZEndpoint {
+    endpoint: string;
+    port: number;
+}
+interface AZConfig {
+    pdpEndpoint?: AZEndpoint;
+}
+type AZOption = (config: AZConfig) => void;
+declare function withEndpoint(endpoint: string, port: number): AZOption;
+
+interface PolicyStore {
+    kind?: string;
+    id?: string;
+}
+interface Entities {
+    schema?: string;
+    items?: Record<string, any>[];
+}
+interface Evaluation {
+    request_id?: string;
+    subject?: Subject;
+    resource?: Resource;
+    action?: Action;
+    context?: Record<string, any>;
+}
+interface AZModel {
+    zone_id: number;
+    principal?: Principal;
+    policy_store?: PolicyStore;
+    entities: Entities;
+}
+interface AZRequest {
+    authorization_model: AZModel;
+    request_id?: string;
+    subject?: Subject;
+    resource?: Resource;
+    action?: Action;
+    context?: Record<string, any>;
+    evaluations?: Evaluation[];
+}
+interface Principal {
+    type?: string;
+    id?: string;
+    source?: string;
+}
+interface Subject {
+    type?: string;
+    id?: string;
+    source?: string;
+    properties?: Record<string, any>;
+}
+interface Resource {
+    type?: string;
+    id?: string;
+    properties?: Record<string, any>;
+}
+interface Action {
+    name?: string;
+    properties?: Record<string, any>;
+}
+interface ReasonResponse {
+    Code?: string;
+    Message?: string;
+}
+interface ContextResponse {
+    ID?: string;
+    ReasonAdmin?: ReasonResponse | null;
+    ReasonUser?: ReasonResponse | null;
+}
+interface EvaluationResponse {
+    RequestID?: string;
+    Decision?: boolean;
+    Context?: ContextResponse | null;
+}
+interface AZResponse {
+    RequestID?: string;
+    Decision: boolean;
+    Context?: ContextResponse | null;
+    Evaluations?: EvaluationResponse[];
+}
+declare enum ActorType {
+    UserType = "USER",
+    RoleActorType = "ROLE-ACTOR",
+    TwinActorType = "TWIN-ACTOR"
+}
+
+declare class AZClient {
+    private azConfig;
+    constructor(...opts: AZOption[]);
+    check(req: AZRequest): Promise<{
+        decision: boolean;
+        response: AZResponse | null;
+        error: Error | null;
+    }>;
+}
+
+declare class ActionBuilder {
+    private action;
+    constructor(name: string);
+    withProperty(key: string, value: any): this;
+    build(): Action;
+}
+
+declare class ContextBuilder {
+    private context;
+    constructor();
+    withProperty(key: string, value: any): ContextBuilder;
+    build(): Record<string, any>;
+}
+
+declare class EvaluationBuilder {
+    private azEvaluation;
+    constructor(subject: Subject, resource: Resource, action: Action);
+    withRequestID(requestID: string): EvaluationBuilder;
+    withContext(context: Record<string, any>): EvaluationBuilder;
+    build(): Evaluation;
+}
+
+declare class PrincipalBuilder {
+    private principal;
+    constructor(id: string);
+    withKind(kind: string): PrincipalBuilder;
+    withSource(source: string): PrincipalBuilder;
+    build(): Principal;
+}
+
+declare class AZAtomicRequestBuilder {
+    private requestID?;
+    private principal?;
+    private azSubjectBuilder;
+    private azResourceBuilder;
+    private azActionBuilder;
+    private azContextBuilder;
+    private azRequestBuilder;
+    constructor(zoneID: number, ledgerID: string, subjectID: string, resourceKind: string, actionName: string);
+    withEntitiesMap(schema: string, entities: Record<string, any>): AZAtomicRequestBuilder;
+    withEntitiesItems(schema: string, entities?: Record<string, any>[]): AZAtomicRequestBuilder;
+    withRequestID(requestID: string): AZAtomicRequestBuilder;
+    withPrincipal(principal: Principal): AZAtomicRequestBuilder;
+    withSubjectKind(kind: string): AZAtomicRequestBuilder;
+    withSubjectSource(source: string): AZAtomicRequestBuilder;
+    withSubjectProperty(key: string, value: any): AZAtomicRequestBuilder;
+    withResourceID(id: string): AZAtomicRequestBuilder;
+    withResourceProperty(key: string, value: any): AZAtomicRequestBuilder;
+    withActionProperty(key: string, value: any): AZAtomicRequestBuilder;
+    withContextProperty(key: string, value: any): AZAtomicRequestBuilder;
+    withSubjectUserType(): AZAtomicRequestBuilder;
+    withSubjectRoleActorType(): AZAtomicRequestBuilder;
+    withSubjectTwinActorType(): AZAtomicRequestBuilder;
+    withSubjectType(kind: string): AZAtomicRequestBuilder;
+    build(): AZRequest;
+}
+
+declare class AZRequestBuilder {
+    private azRequest;
+    constructor(zoneID: number, ledgerID: string);
+    withPrincipal(principal?: Principal): AZRequestBuilder;
+    withRequestID(requestID?: string): AZRequestBuilder;
+    withSubject(subject: Subject): AZRequestBuilder;
+    withResource(resource: Resource): AZRequestBuilder;
+    withAction(action: Action): AZRequestBuilder;
+    withContext(context: Record<string, any>): AZRequestBuilder;
+    withEntitiesMap(schema: string, entities: Record<string, any>): AZRequestBuilder;
+    withEntitiesItems(schema: string, entities?: Record<string, any>[]): AZRequestBuilder;
+    withEvaluation(evaluation: Evaluation): AZRequestBuilder;
+    build(): AZRequest;
+}
+
+declare class ResourceBuilder {
+    private resource;
+    constructor(kind: string);
+    withID(id: string): ResourceBuilder;
+    withProperty(key: string, value: any): ResourceBuilder;
+    build(): Resource;
+}
+
+declare class SubjectBuilder {
+    private subject;
+    constructor(id: string);
+    withKind(kind: string): SubjectBuilder;
+    withSource(source: string): SubjectBuilder;
+    withProperty(key: string, value: any): SubjectBuilder;
+    withUserType(): SubjectBuilder;
+    withRoleActorType(): SubjectBuilder;
+    withTwinActorType(): SubjectBuilder;
+    withType(subType: string): SubjectBuilder;
+    build(): Subject;
+}
+
+export { AZAtomicRequestBuilder, AZClient, type AZConfig, type AZEndpoint, type AZModel, type AZOption, type AZRequest, AZRequestBuilder, type AZResponse, type Action, ActionBuilder, ActorType, ContextBuilder, type ContextResponse, type Entities, type Evaluation, EvaluationBuilder, type EvaluationResponse, type PolicyStore, type Principal, PrincipalBuilder, type ReasonResponse, type Resource, ResourceBuilder, type Subject, SubjectBuilder, withEndpoint };