@twin.org/rights-management-models 0.9.2-next.4 → 0.9.2-next.5

package/dist/es/models/api/pap/IPapQueryRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"IPapQueryRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapQueryRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The request structure for querying policies.\n */\nexport interface IPapQueryRequest {\n\t/**\n\t * The query parameters of the request.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The type of policy to filter by.\n\t\t */\n\t\ttype?: string;\n\n\t\t/**\n\t\t * The assigner to filter by.\n\t\t */\n\t\tassigner?: string;\n\n\t\t/**\n\t\t * The assignee to filter by.\n\t\t */\n\t\tassignee?: string;\n\n\t\t/**\n\t\t * The action to filter by.\n\t\t */\n\t\taction?: string;\n\n\t\t/**\n\t\t * The target to filter by.\n\t\t */\n\t\ttarget?: string;\n\n\t\t/**\n\t\t * The condition for the query.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get next chunk of data, returned in previous response.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}
+{"version":3,"file":"IPapQueryRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapQueryRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The request structure for querying policies.\n */\nexport interface IPapQueryRequest {\n\t/**\n\t * The query parameters of the request.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The type of policy to filter by.\n\t\t */\n\t\ttype?: string;\n\n\t\t/**\n\t\t * The assigner to filter by.\n\t\t */\n\t\tassigner?: string;\n\n\t\t/**\n\t\t * The assignee to filter by.\n\t\t */\n\t\tassignee?: string;\n\n\t\t/**\n\t\t * The action to filter by.\n\t\t */\n\t\taction?: string;\n\n\t\t/**\n\t\t * The target to filter by.\n\t\t */\n\t\ttarget?: string;\n\n\t\t/**\n\t\t * The condition for the query.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get next chunk of data, returned in previous response.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Comma-separated list of policy property names to include in the response.\n\t\t */\n\t\tproperties?: string;\n\t};\n}\n"]}

package/dist/es/models/pap/IPolicyAdministrationPointComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"IPolicyAdministrationPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pap/IPolicyAdministrationPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { JsonLdObjectWithOptionalAtId } from \"@twin.org/data-json-ld\";\nimport type { EntityCondition } from \"@twin.org/entity\";\nimport type { IRightsManagementAgreement } from \"../IRightsManagementAgreement.js\";\nimport type { IRightsManagementOffer } from \"../IRightsManagementOffer.js\";\nimport type { IRightsManagementPolicy } from \"../IRightsManagementPolicy.js\";\nimport type { IRightsManagementSet } from \"../IRightsManagementSet.js\";\nimport type { IPolicyLocator } from \"./IPolicyLocator.js\";\n\n/**\n * Interface describing a Policy Administration Point (PAP) component that manages ODRL policies.\n */\nexport interface IPolicyAdministrationPointComponent extends IComponent {\n\t/**\n\t * Create a new policy with auto-generated UID.\n\t * @param policy The policy to create (uid will be auto-generated).\n\t * @returns The UID of the created policy.\n\t */\n\tcreate(policy: JsonLdObjectWithOptionalAtId<IRightsManagementPolicy>): Promise<string>;\n\n\t/**\n\t * Update an existing policy.\n\t * @param policy The policy to update (must include uid).\n\t * @returns A promise that resolves when the policy has been updated.\n\t */\n\tupdate(policy: IRightsManagementPolicy): Promise<void>;\n\n\t/**\n\t * Get a policy.\n\t * @param policyId The id of the policy to get.\n\t * @returns The policy.\n\t */\n\tget(policyId: string): Promise<IRightsManagementPolicy>;\n\n\t/**\n\t * Get an agreement.\n\t * @param agreementId The id of the agreement to get.\n\t * @returns The agreement.\n\t */\n\tgetAgreement(agreementId: string): Promise<IRightsManagementAgreement>;\n\n\t/**\n\t * Get a set.\n\t * @param setId The id of the set to get.\n\t * @returns The set.\n\t */\n\tgetSet(setId: string): Promise<IRightsManagementSet>;\n\n\t/**\n\t * Get an offer.\n\t * @param offerId The id of the offer to get.\n\t * @returns The offer.\n\t */\n\tgetOffer(offerId: string): Promise<IRightsManagementOffer>;\n\n\t/**\n\t * Remove a policy.\n\t * @param policyId The id of the policy to remove.\n\t * @returns A promise that resolves when the policy has been removed.\n\t */\n\tremove(policyId: string): Promise<void>;\n\n\t/**\n\t * Query the policies using the specified conditions.\n\t * @param locator Optional locator to filter by type, assigner, assignee, target, or action.\n\t * @param conditions The conditions to use for the query.\n\t * @param cursor The cursor to use for pagination.\n\t * @param limit The number of results to return per page.\n\t * @returns Cursor for next page of results and the policies matching the query.\n\t */\n\tquery(\n\t\tlocator?: IPolicyLocator,\n\t\tconditions?: EntityCondition<IRightsManagementPolicy>,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The cursor for the next page of results.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * The policies that match the query.\n\t\t */\n\t\tpolicies: IRightsManagementPolicy[];\n\t}>;\n}\n"]}
+{"version":3,"file":"IPolicyAdministrationPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pap/IPolicyAdministrationPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { JsonLdObjectWithOptionalAtId } from \"@twin.org/data-json-ld\";\nimport type { EntityCondition } from \"@twin.org/entity\";\nimport type { IRightsManagementAgreement } from \"../IRightsManagementAgreement.js\";\nimport type { IRightsManagementOffer } from \"../IRightsManagementOffer.js\";\nimport type { IRightsManagementPolicy } from \"../IRightsManagementPolicy.js\";\nimport type { IRightsManagementSet } from \"../IRightsManagementSet.js\";\nimport type { IPolicyLocator } from \"./IPolicyLocator.js\";\n\n/**\n * Interface describing a Policy Administration Point (PAP) component that manages ODRL policies.\n */\nexport interface IPolicyAdministrationPointComponent extends IComponent {\n\t/**\n\t * Create a new policy with auto-generated UID.\n\t * @param policy The policy to create (uid will be auto-generated).\n\t * @returns The UID of the created policy.\n\t */\n\tcreate(policy: JsonLdObjectWithOptionalAtId<IRightsManagementPolicy>): Promise<string>;\n\n\t/**\n\t * Update an existing policy.\n\t * @param policy The policy to update (must include uid).\n\t * @returns A promise that resolves when the policy has been updated.\n\t */\n\tupdate(policy: IRightsManagementPolicy): Promise<void>;\n\n\t/**\n\t * Get a policy.\n\t * @param policyId The id of the policy to get.\n\t * @returns The policy.\n\t */\n\tget(policyId: string): Promise<IRightsManagementPolicy>;\n\n\t/**\n\t * Get an agreement.\n\t * @param agreementId The id of the agreement to get.\n\t * @returns The agreement.\n\t */\n\tgetAgreement(agreementId: string): Promise<IRightsManagementAgreement>;\n\n\t/**\n\t * Get a set.\n\t * @param setId The id of the set to get.\n\t * @returns The set.\n\t */\n\tgetSet(setId: string): Promise<IRightsManagementSet>;\n\n\t/**\n\t * Get an offer.\n\t * @param offerId The id of the offer to get.\n\t * @returns The offer.\n\t */\n\tgetOffer(offerId: string): Promise<IRightsManagementOffer>;\n\n\t/**\n\t * Remove a policy.\n\t * @param policyId The id of the policy to remove.\n\t * @returns A promise that resolves when the policy has been removed.\n\t */\n\tremove(policyId: string): Promise<void>;\n\n\t/**\n\t * Query the policies using the specified conditions.\n\t * @param locator Optional locator to filter by type, assigner, assignee, target, or action.\n\t * @param conditions The conditions to use for the query.\n\t * @param cursor The cursor to use for pagination.\n\t * @param limit The number of results to return per page.\n\t * @param properties Optional list of policy property names to include in the response.\n\t * @returns Cursor for next page of results and the policies matching the query.\n\t */\n\tquery(\n\t\tlocator?: IPolicyLocator,\n\t\tconditions?: EntityCondition<IRightsManagementPolicy>,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\tproperties?: (keyof IRightsManagementPolicy)[]\n\t): Promise<{\n\t\t/**\n\t\t * The cursor for the next page of results.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * The policies that match the query.\n\t\t */\n\t\tpolicies: IRightsManagementPolicy[];\n\t}>;\n}\n"]}

package/dist/types/models/api/pap/IPapQueryRequest.d.ts

@@ -38,5 +38,9 @@ export interface IPapQueryRequest {
          * The cursor to get next chunk of data, returned in previous response.
          */
         cursor?: string;
+        /**
+         * Comma-separated list of policy property names to include in the response.
+         */
+        properties?: string;
     };
 }

package/dist/types/models/pap/IPolicyAdministrationPointComponent.d.ts

@@ -58,9 +58,10 @@ export interface IPolicyAdministrationPointComponent extends IComponent {
      * @param conditions The conditions to use for the query.
      * @param cursor The cursor to use for pagination.
      * @param limit The number of results to return per page.
+     * @param properties Optional list of policy property names to include in the response.
      * @returns Cursor for next page of results and the policies matching the query.
      */
-    query(locator?: IPolicyLocator, conditions?: EntityCondition<IRightsManagementPolicy>, cursor?: string, limit?: number): Promise<{
+    query(locator?: IPolicyLocator, conditions?: EntityCondition<IRightsManagementPolicy>, cursor?: string, limit?: number, properties?: (keyof IRightsManagementPolicy)[]): Promise<{
         /**
          * The cursor for the next page of results.
          */

package/docs/changelog.md

@@ -6,6 +6,13 @@
 
 * remove EcosystemPolicy models/DTOs and standardize policy typing on `OdrlPolicyType` for v2.
 
+## [0.9.2-next.5](https://github.com/iotaledger/twin-rights-management/compare/rights-management-models-v0.9.2-next.4...rights-management-models-v0.9.2-next.5) (2026-08-12)
+
+
+### Features
+
+* query properties ([#289](https://github.com/iotaledger/twin-rights-management/issues/289)) ([e2481f2](https://github.com/iotaledger/twin-rights-management/commit/e2481f256e8b74c2bf56dca6d9df817919ab8a3a))
+
 ## [0.9.2-next.4](https://github.com/iotaledger/twin-rights-management/compare/rights-management-models-v0.9.2-next.3...rights-management-models-v0.9.2-next.4) (2026-08-10)
 
 

package/docs/reference/interfaces/IPapQueryRequest.md

@@ -57,3 +57,9 @@ Limit the number of entities to return.
 > `optional` **cursor?**: `string`
 
 The cursor to get next chunk of data, returned in previous response.
+
+#### properties?
+
+> `optional` **properties?**: `string`
+
+Comma-separated list of policy property names to include in the response.

package/docs/reference/interfaces/IPolicyAdministrationPointComponent.md

@@ -164,7 +164,7 @@ A promise that resolves when the policy has been removed.
 
 ### query() {#query}
 
-> **query**(`locator?`, `conditions?`, `cursor?`, `limit?`): `Promise`\<\{ `cursor?`: `string`; `policies`: [`IRightsManagementPolicy`](IRightsManagementPolicy.md)[]; \}\>
+> **query**(`locator?`, `conditions?`, `cursor?`, `limit?`, `properties?`): `Promise`\<\{ `cursor?`: `string`; `policies`: [`IRightsManagementPolicy`](IRightsManagementPolicy.md)[]; \}\>
 
 Query the policies using the specified conditions.
 
@@ -194,6 +194,12 @@ The cursor to use for pagination.
 
 The number of results to return per page.
 
+##### properties?
+
+keyof [`IRightsManagementPolicy`](IRightsManagementPolicy.md)[]
+
+Optional list of policy property names to include in the response.
+
 #### Returns
 
 `Promise`\<\{ `cursor?`: `string`; `policies`: [`IRightsManagementPolicy`](IRightsManagementPolicy.md)[]; \}\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/rights-management-models",
-	"version": "0.9.2-next.4",
+	"version": "0.9.2-next.5",
 	"description": "Data model definitions for rights management policies, negotiations, and service contracts.",
 	"repository": {
 		"type": "git",