@twin.org/federated-catalogue-models 0.0.3-next.2 → 0.0.3-next.21

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

@@ -1,13 +0,0 @@
-/**
- * The contexts of federated catalogue data.
- */
-export declare const FederatedCatalogueContexts: {
-    /**
-     * The context root for the federated catalogue types.
-     */
-    readonly ContextRoot: "https://schema.twindev.org/federated-catalogue/";
-};
-/**
- * The contexts of federated catalogue data.
- */
-export type FederatedCatalogueContexts = (typeof FederatedCatalogueContexts)[keyof typeof FederatedCatalogueContexts];

package/dist/types/models/filters/IBaseFilter.d.ts

@@ -1,34 +0,0 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-/**
- * Base filter interface with pagination support.
- * All filter objects in the federated catalogue extend this base.
- *
- * Per Eclipse Dataspace Protocol constraints, cursor and limit cannot be
- * top-level properties in CatalogRequestMessage. They must be embedded
- * within the filter object using a custom JSON-LD vocabulary.
- *
- * After JSON-LD compaction, properties use direct names (cursor, limit) rather
- * than prefixed names. Each filter implementation should extend this interface
- * to define its own filter-specific properties.
- */
-export interface IBaseFilter extends IJsonLdNodeObject {
-    /**
-     * Filter type discriminator.
-     * Used to route filter to appropriate filter implementation.
-     * Example: "FilterByExample", "FilterByPolicy", etc.
-     * Required for filter routing.
-     */
-    "@type": string;
-    /**
-     * Optional cursor for pagination.
-     * When provided, returns results starting after this cursor.
-     * Namespace: https://schema.twindev.org/federated-catalogue/cursor
-     */
-    cursor?: string;
-    /**
-     * Optional limit for number of results.
-     * Defaults to implementation-specific value if not provided.
-     * Namespace: https://schema.twindev.org/federated-catalogue/limit
-     */
-    limit?: number;
-}

package/docs/reference/interfaces/IBaseFilter.md

@@ -1,55 +0,0 @@
-# Interface: IBaseFilter
-
-Base filter interface with pagination support.
-All filter objects in the federated catalogue extend this base.
-
-Per Eclipse Dataspace Protocol constraints, cursor and limit cannot be
-top-level properties in CatalogRequestMessage. They must be embedded
-within the filter object using a custom JSON-LD vocabulary.
-
-After JSON-LD compaction, properties use direct names (cursor, limit) rather
-than prefixed names. Each filter implementation should extend this interface
-to define its own filter-specific properties.
-
-## Extends
-
-- `IJsonLdNodeObject`
-
-## Indexable
-
-\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `string`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
-
-## Properties
-
-### @type
-
-> **@type**: `string`
-
-Filter type discriminator.
-Used to route filter to appropriate filter implementation.
-Example: "FilterByExample", "FilterByPolicy", etc.
-Required for filter routing.
-
-#### Overrides
-
-`IJsonLdNodeObject.@type`
-
-***
-
-### cursor?
-
-> `optional` **cursor**: `string`
-
-Optional cursor for pagination.
-When provided, returns results starting after this cursor.
-Namespace: https://schema.twindev.org/federated-catalogue/cursor
-
-***
-
-### limit?
-
-> `optional` **limit**: `number`
-
-Optional limit for number of results.
-Defaults to implementation-specific value if not provided.
-Namespace: https://schema.twindev.org/federated-catalogue/limit

package/docs/reference/interfaces/IGetDatasetRequest.md

@@ -1,17 +0,0 @@
-# Interface: IGetDatasetRequest
-
-The request parameters for the get dataset method.
-
-## Properties
-
-### pathParams
-
-> **pathParams**: `object`
-
-The path parameters.
-
-#### datasetId
-
-> **datasetId**: `string`
-
-The unique identifier of the dataset.

package/docs/reference/interfaces/IGetDatasetResponse.md

@@ -1,11 +0,0 @@
-# Interface: IGetDatasetResponse
-
-The response payload for the get dataset method.
-
-## Properties
-
-### body
-
-> **body**: `IDataset`
-
-The response payload containing the dataset.

package/docs/reference/type-aliases/FederatedCatalogueContexts.md

@@ -1,5 +0,0 @@
-# Type Alias: FederatedCatalogueContexts
-
-> **FederatedCatalogueContexts** = *typeof* [`FederatedCatalogueContexts`](../variables/FederatedCatalogueContexts.md)\[keyof *typeof* [`FederatedCatalogueContexts`](../variables/FederatedCatalogueContexts.md)\]
-
-The contexts of federated catalogue data.

package/docs/reference/variables/FederatedCatalogueContexts.md

@@ -1,13 +0,0 @@
-# Variable: FederatedCatalogueContexts
-
-> `const` **FederatedCatalogueContexts**: `object`
-
-The contexts of federated catalogue data.
-
-## Type Declaration
-
-### ContextRoot
-
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/federated-catalogue/"` = `"https://schema.twindev.org/federated-catalogue/"`
-
-The context root for the federated catalogue types.