@twin.org/rights-management-plugins 0.0.3-next.9 → 0.9.0

package/dist/types/dataAccessHandlers/examplePolicyRequester.d.ts

@@ -1,68 +0,0 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { EntityCondition } from "@twin.org/entity";
-import type { IDataAccessHandler } from "@twin.org/rights-management-models";
-import type { IExampleDataAccessHandlerConstructorOptions } from "../models/IExampleDataAccessHandlerConstructorOptions.js";
-/**
- * Example Data Access Handler.
- */
-export declare class ExampleDataAccessHandler implements IDataAccessHandler {
-    /**
-     * The class name of the Example Data Access Handler.
-     */
-    static readonly CLASS_NAME: string;
-    /**
-     * Create a new instance of ExampleDataAccessHandler.
-     * @param options The options for the example policy Requester.
-     */
-    constructor(options?: IExampleDataAccessHandlerConstructorOptions);
-    /**
-     * Returns the class name of the component.
-     * @returns The class name of the component.
-     */
-    className(): string;
-    /**
-     * The asset types supported by this handler.
-     * @returns The supported asset types.
-     */
-    supportedAssetTypes(): string[];
-    /**
-     * Create an item.
-     * @param assetType The type of the item to create.
-     * @param item The item to create.
-     * @returns The id of the item created, for some items this is supplied in the `item`.
-     */
-    create(assetType: string, item: IJsonLdNodeObject): Promise<string>;
-    /**
-     * Get an item.
-     * @param assetType The type of the item to retrieve.
-     * @param id The ID of the item to retrieve.
-     * @returns The item retrieved if the policies allow it.
-     */
-    get(assetType: string, id: string): Promise<IJsonLdNodeObject>;
-    /**
-     * Update an item.
-     * @param assetType The type of the item to update.
-     * @param item The item to update.
-     * @returns Nothing.
-     */
-    update(assetType: string, item: IJsonLdNodeObject): Promise<void>;
-    /**
-     * Remove an item.
-     * @param assetType The type of the item to remove.
-     * @param id The id of the item to remove.
-     * @returns Nothing.
-     */
-    remove(assetType: string, id: string): Promise<void>;
-    /**
-     * Query for items.
-     * @param assetType The type of the item to query.
-     * @param conditions The conditions to apply to the query.
-     * @param cursor The cursor for pagination.
-     * @param options Additional options which might be supported by the handler.
-     * @returns The items matching the query and cursor if there are more items.
-     */
-    query(assetType: string, conditions: EntityCondition<IJsonLdNodeObject> | undefined, cursor: string | undefined, options: unknown | undefined): Promise<{
-        items: IJsonLdNodeObject[];
-        cursor?: string;
-    }>;
-}

package/dist/types/models/IExampleDataAccessHandlerConstructorOptions.d.ts

@@ -1,10 +0,0 @@
-/**
- * Options for the Example Data Access Handler.
- */
-export interface IExampleDataAccessHandlerConstructorOptions {
-    /**
-     * The logging component for data access handler.
-     * @default logging
-     */
-    loggingComponentType?: string;
-}

package/dist/types/models/IExamplePolicyArbiterConstructorOptions.d.ts

@@ -1,10 +0,0 @@
-/**
- * Options for the Example Policy Arbiter.
- */
-export interface IExamplePolicyArbiterConstructorOptions {
-    /**
-     * The logging component for policy arbiter.
-     * @default logging
-     */
-    loggingComponentType?: string;
-}

package/dist/types/models/IExamplePolicyEnforcementProcessorConstructorOptions.d.ts

@@ -1,10 +0,0 @@
-/**
- * Options for the Example Policy Enforcement Processor.
- */
-export interface IExamplePolicyEnforcementProcessorConstructorOptions {
-    /**
-     * The logging component for policy enforcement processor.
-     * @default logging
-     */
-    loggingComponentType?: string;
-}

package/dist/types/models/IExamplePolicyNegotiatorConstructorOptions.d.ts

@@ -1,10 +0,0 @@
-/**
- * Options for the Example Policy Negotiator.
- */
-export interface IExamplePolicyNegotiatorConstructorOptions {
-    /**
-     * The logging component for policy negotiator.
-     * @default logging
-     */
-    loggingComponentType?: string;
-}

package/dist/types/models/IExamplePolicyRequesterConstructorOptions.d.ts

@@ -1,10 +0,0 @@
-/**
- * Options for the Example Policy Requester.
- */
-export interface IExamplePolicyRequesterConstructorOptions {
-    /**
-     * The logging component for policy requester.
-     * @default logging
-     */
-    loggingComponentType?: string;
-}

package/dist/types/policyArbiters/examplePolicyArbiter.d.ts

@@ -1,36 +0,0 @@
-import type { IPolicyArbiter, IPolicyDecision, IPolicyInformation, IPolicyLocator } from "@twin.org/rights-management-models";
-import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
-import type { IExamplePolicyArbiterConstructorOptions } from "../models/IExamplePolicyArbiterConstructorOptions.js";
-/**
- * Example Policy Arbiter.
- */
-export declare class ExamplePolicyArbiter implements IPolicyArbiter {
-    /**
-     * The class name of the Example Policy Arbiter.
-     */
-    static readonly CLASS_NAME: string;
-    /**
-     * Create a new instance of ExamplePolicyArbiter.
-     * @param options The options for the example policy arbiter.
-     */
-    constructor(options?: IExamplePolicyArbiterConstructorOptions);
-    /**
-     * Returns the class name of the component.
-     * @returns The class name of the component.
-     */
-    className(): string;
-    /**
-     * The policies supported by this arbiter.
-     * @returns The supported policies, if empty can be used for all.
-     */
-    supportedPolicies(): IPolicyLocator[];
-    /**
-     * Makes decisions regarding policy access to data.
-     * @param locator The locator to find relevant policies.
-     * @param information Information provided by the requester to determine if a policy can be created.
-     * @param policies The policies that apply to the data.
-     * @param data The data to make a decision on.
-     * @returns The decisions about access to the data.
-     */
-    decide<D = unknown>(locator: IPolicyLocator, information?: IPolicyInformation, policies?: IOdrlPolicy[], data?: D): Promise<IPolicyDecision[]>;
-}

package/dist/types/policyEnforcementProcessor/examplePolicyEnforcementProcessor.d.ts

@@ -1,29 +0,0 @@
-import type { IPolicyDecision, IPolicyEnforcementProcessor, IPolicyLocator } from "@twin.org/rights-management-models";
-import type { IExamplePolicyEnforcementProcessorConstructorOptions } from "../models/IExamplePolicyEnforcementProcessorConstructorOptions.js";
-/**
- * Example Policy Enforcement Processor.
- */
-export declare class ExamplePolicyEnforcementProcessor implements IPolicyEnforcementProcessor {
-    /**
-     * The class name of the Example Policy Enforcement Processor.
-     */
-    static readonly CLASS_NAME: string;
-    /**
-     * Create a new instance of ExamplePolicyEnforcementProcessor.
-     * @param options The options for the example policy enforcement processor.
-     */
-    constructor(options?: IExamplePolicyEnforcementProcessorConstructorOptions);
-    /**
-     * Returns the class name of the component.
-     * @returns The class name of the component.
-     */
-    className(): string;
-    /**
-     * Process the response from the policy decision point.
-     * @param locator The locator to find relevant policies.
-     * @param decisions The decisions made by the policy decision point.
-     * @param data The data to process.
-     * @returns The data after processing.
-     */
-    process<D = unknown, R = D>(locator: IPolicyLocator, decisions: IPolicyDecision[], data?: D): Promise<R>;
-}

package/dist/types/policyNegotiators/examplePolicyNegotiator.d.ts

@@ -1,45 +0,0 @@
-import type { IPolicyInformation, IPolicyNegotiator } from "@twin.org/rights-management-models";
-import type { IOdrlAgreement, IOdrlOffer } from "@twin.org/standards-w3c-odrl";
-import type { IExamplePolicyNegotiatorConstructorOptions } from "../models/IExamplePolicyNegotiatorConstructorOptions.js";
-/**
- * Example Policy Negotiator.
- */
-export declare class ExamplePolicyNegotiator implements IPolicyNegotiator {
-    /**
-     * The class name of the Example Policy Negotiator.
-     */
-    static readonly CLASS_NAME: string;
-    /**
-     * Create a new instance of ExamplePolicyNegotiator.
-     * @param options The options for the example policy negotiator.
-     */
-    constructor(options?: IExamplePolicyNegotiatorConstructorOptions);
-    /**
-     * Returns the class name of the component.
-     * @returns The class name of the component.
-     */
-    className(): string;
-    /**
-     * Determines if the negotiator supports the given offer.
-     * @param offer The offer to check.
-     * @returns Sets the supports flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
-     */
-    supportsOffer(offer: IOdrlOffer): boolean;
-    /**
-     * Handle the offer.
-     * @param offer The offer to check.
-     * @param information Information provided by the requester to determine if a policy can be created.
-     * @returns Sets the accepted flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
-     */
-    handleOffer(offer: IOdrlOffer, information?: IPolicyInformation): Promise<{
-        accepted: boolean;
-        interventionRequired: boolean;
-    }>;
-    /**
-     * Create an agreement based on the offer.
-     * @param offer The offer to create the agreement from.
-     * @param information Information provided by the requester to aid in the creation of the agreement.
-     * @returns The agreement created from the offer or undefined if an agreement could not be created.
-     */
-    createAgreement(offer: IOdrlOffer, information?: IPolicyInformation): Promise<IOdrlAgreement | undefined>;
-}

package/dist/types/policyRequesters/examplePolicyRequester.d.ts

@@ -1,53 +0,0 @@
-import type { IPolicyRequester } from "@twin.org/rights-management-models";
-import type { IOdrlAgreement, IOdrlOffer } from "@twin.org/standards-w3c-odrl";
-import type { IExamplePolicyRequesterConstructorOptions } from "../models/IExamplePolicyRequesterConstructorOptions.js";
-/**
- * Example Policy Requester.
- */
-export declare class ExamplePolicyRequester implements IPolicyRequester {
-    /**
-     * The class name of the Example Policy Requester.
-     */
-    static readonly CLASS_NAME: string;
-    /**
-     * Create a new instance of ExamplePolicyRequester.
-     * @param options The options for the example policy Requester.
-     */
-    constructor(options?: IExamplePolicyRequesterConstructorOptions);
-    /**
-     * Returns the class name of the component.
-     * @returns The class name of the component.
-     */
-    className(): string;
-    /**
-     * The unique id of the requester.
-     * @returns The requester id.
-     */
-    requesterId(): string;
-    /**
-     * A policy has been offered by a provider, let the requester know about it.
-     * @param negotiationId The id of the negotiation.
-     * @param offer The offer sent by the provider.
-     * @returns True if the offer was accepted, false otherwise.
-     */
-    offer(negotiationId: string, offer: IOdrlOffer): Promise<boolean>;
-    /**
-     * A policy agreement has been sent by a provider, let the requester know about it.
-     * @param negotiationId The id of the negotiation.
-     * @param agreement The agreement sent by the provider.
-     * @returns True if the agreement was accepted, false otherwise.
-     */
-    agreement(negotiationId: string, agreement: IOdrlAgreement): Promise<boolean>;
-    /**
-     * A policy finalisation has been sent by a provider, let the requester know about it.
-     * @param negotiationId The id of the negotiation.
-     * @returns Nothing.
-     */
-    finalised(negotiationId: string): Promise<void>;
-    /**
-     * A policy termination has been sent by a provider, let the requester know about it.
-     * @param negotiationId The id of the negotiation.
-     * @returns Nothing.
-     */
-    terminated(negotiationId: string): Promise<void>;
-}

package/docs/reference/classes/ExampleDataAccessHandler.md

@@ -1,243 +0,0 @@
-# Class: ExampleDataAccessHandler
-
-Example Data Access Handler.
-
-## Implements
-
-- `IDataAccessHandler`
-
-## Constructors
-
-### Constructor
-
-> **new ExampleDataAccessHandler**(`options?`): `ExampleDataAccessHandler`
-
-Create a new instance of ExampleDataAccessHandler.
-
-#### Parameters
-
-##### options?
-
-[`IExampleDataAccessHandlerConstructorOptions`](../interfaces/IExampleDataAccessHandlerConstructorOptions.md)
-
-The options for the example policy Requester.
-
-#### Returns
-
-`ExampleDataAccessHandler`
-
-## Properties
-
-### CLASS\_NAME
-
-> `readonly` `static` **CLASS\_NAME**: `string`
-
-The class name of the Example Data Access Handler.
-
-## Methods
-
-### className()
-
-> **className**(): `string`
-
-Returns the class name of the component.
-
-#### Returns
-
-`string`
-
-The class name of the component.
-
-#### Implementation of
-
-`IDataAccessHandler.className`
-
-***
-
-### supportedAssetTypes()
-
-> **supportedAssetTypes**(): `string`[]
-
-The asset types supported by this handler.
-
-#### Returns
-
-`string`[]
-
-The supported asset types.
-
-#### Implementation of
-
-`IDataAccessHandler.supportedAssetTypes`
-
-***
-
-### create()
-
-> **create**(`assetType`, `item`): `Promise`\<`string`\>
-
-Create an item.
-
-#### Parameters
-
-##### assetType
-
-`string`
-
-The type of the item to create.
-
-##### item
-
-`IJsonLdNodeObject`
-
-The item to create.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The id of the item created, for some items this is supplied in the `item`.
-
-#### Implementation of
-
-`IDataAccessHandler.create`
-
-***
-
-### get()
-
-> **get**(`assetType`, `id`): `Promise`\<`IJsonLdNodeObject`\>
-
-Get an item.
-
-#### Parameters
-
-##### assetType
-
-`string`
-
-The type of the item to retrieve.
-
-##### id
-
-`string`
-
-The ID of the item to retrieve.
-
-#### Returns
-
-`Promise`\<`IJsonLdNodeObject`\>
-
-The item retrieved if the policies allow it.
-
-#### Implementation of
-
-`IDataAccessHandler.get`
-
-***
-
-### update()
-
-> **update**(`assetType`, `item`): `Promise`\<`void`\>
-
-Update an item.
-
-#### Parameters
-
-##### assetType
-
-`string`
-
-The type of the item to update.
-
-##### item
-
-`IJsonLdNodeObject`
-
-The item to update.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Implementation of
-
-`IDataAccessHandler.update`
-
-***
-
-### remove()
-
-> **remove**(`assetType`, `id`): `Promise`\<`void`\>
-
-Remove an item.
-
-#### Parameters
-
-##### assetType
-
-`string`
-
-The type of the item to remove.
-
-##### id
-
-`string`
-
-The id of the item to remove.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Implementation of
-
-`IDataAccessHandler.remove`
-
-***
-
-### query()
-
-> **query**(`assetType`, `conditions`, `cursor`, `options`): `Promise`\<\{ `items`: `IJsonLdNodeObject`[]; `cursor?`: `string`; \}\>
-
-Query for items.
-
-#### Parameters
-
-##### assetType
-
-`string`
-
-The type of the item to query.
-
-##### conditions
-
-The conditions to apply to the query.
-
-`EntityCondition`\<`IJsonLdNodeObject`\> | `undefined`
-
-##### cursor
-
-The cursor for pagination.
-
-`string` | `undefined`
-
-##### options
-
-`unknown`
-
-Additional options which might be supported by the handler.
-
-#### Returns
-
-`Promise`\<\{ `items`: `IJsonLdNodeObject`[]; `cursor?`: `string`; \}\>
-
-The items matching the query and cursor if there are more items.
-
-#### Implementation of
-
-`IDataAccessHandler.query`

package/docs/reference/classes/ExamplePolicyArbiter.md

@@ -1,121 +0,0 @@
-# Class: ExamplePolicyArbiter
-
-Example Policy Arbiter.
-
-## Implements
-
-- `IPolicyArbiter`
-
-## Constructors
-
-### Constructor
-
-> **new ExamplePolicyArbiter**(`options?`): `ExamplePolicyArbiter`
-
-Create a new instance of ExamplePolicyArbiter.
-
-#### Parameters
-
-##### options?
-
-[`IExamplePolicyArbiterConstructorOptions`](../interfaces/IExamplePolicyArbiterConstructorOptions.md)
-
-The options for the example policy arbiter.
-
-#### Returns
-
-`ExamplePolicyArbiter`
-
-## Properties
-
-### CLASS\_NAME
-
-> `readonly` `static` **CLASS\_NAME**: `string`
-
-The class name of the Example Policy Arbiter.
-
-## Methods
-
-### className()
-
-> **className**(): `string`
-
-Returns the class name of the component.
-
-#### Returns
-
-`string`
-
-The class name of the component.
-
-#### Implementation of
-
-`IPolicyArbiter.className`
-
-***
-
-### supportedPolicies()
-
-> **supportedPolicies**(): `IPolicyLocator`[]
-
-The policies supported by this arbiter.
-
-#### Returns
-
-`IPolicyLocator`[]
-
-The supported policies, if empty can be used for all.
-
-#### Implementation of
-
-`IPolicyArbiter.supportedPolicies`
-
-***
-
-### decide()
-
-> **decide**\<`D`\>(`locator`, `information?`, `policies?`, `data?`): `Promise`\<`IPolicyDecision`[]\>
-
-Makes decisions regarding policy access to data.
-
-#### Type Parameters
-
-##### D
-
-`D` = `unknown`
-
-#### Parameters
-
-##### locator
-
-`IPolicyLocator`
-
-The locator to find relevant policies.
-
-##### information?
-
-`IPolicyInformation`
-
-Information provided by the requester to determine if a policy can be created.
-
-##### policies?
-
-`IOdrlPolicy`[]
-
-The policies that apply to the data.
-
-##### data?
-
-`D`
-
-The data to make a decision on.
-
-#### Returns
-
-`Promise`\<`IPolicyDecision`[]\>
-
-The decisions about access to the data.
-
-#### Implementation of
-
-`IPolicyArbiter.decide`