@twin.org/auditable-item-graph-service 0.0.1-next.10

package/dist/types/auditableItemGraphRoutes.d.ts

@@ -0,0 +1,45 @@
+import type { ICreatedResponse, IHttpRequestContext, INoContentResponse, IRestRoute, ITag } from "@twin.org/api-models";
+import { type IAuditableItemGraphCreateRequest, type IAuditableItemGraphGetRequest, type IAuditableItemGraphGetResponse, type IAuditableItemGraphListRequest, type IAuditableItemGraphListResponse, type IAuditableItemGraphUpdateRequest } from "@twin.org/auditable-item-graph-models";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsAuditableItemGraph: ITag[];
+/**
+ * The REST routes for auditable item graph.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export declare function generateRestRoutesAuditableItemGraph(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * Create the graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphCreateRequest): Promise<ICreatedResponse>;
+/**
+ * Get the graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphGetRequest): Promise<IAuditableItemGraphGetResponse>;
+/**
+ * Update the graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphUpdateRequest): Promise<INoContentResponse>;
+/**
+ * Query the graph vertices.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphList(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphListRequest): Promise<IAuditableItemGraphListResponse>;

package/dist/types/auditableItemGraphService.d.ts

@@ -0,0 +1,123 @@
+import { VerifyDepth, type IAuditableItemGraphComponent, type IAuditableItemGraphVertex, type IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { SortDirection } from "@twin.org/entity";
+import type { IAuditableItemGraphServiceConfig } from "./models/IAuditableItemGraphServiceConfig";
+/**
+ * Class for performing auditable item graph operations.
+ */
+export declare class AuditableItemGraphService implements IAuditableItemGraphComponent {
+    /**
+     * The namespace for the service.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * The namespace for the service changeset.
+     */
+    static readonly NAMESPACE_CHANGESET: string;
+    /**
+     * The keys to pick when creating the proof for the stream.
+     */
+    private static readonly _PROOF_KEYS_CHANGESET;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of AuditableItemGraphService.
+     * @param options The dependencies for the auditable item graph connector.
+     * @param options.config The configuration for the connector.
+     * @param options.immutableProofComponentType The immutable proof component type, defaults to "immutable-proof".
+     * @param options.vertexEntityStorageType The entity storage for vertices, defaults to "auditable-item-graph-vertex".
+     * @param options.changesetEntityStorageType The entity storage for changesets, defaults to "auditable-item-graph-changeset".
+     */
+    constructor(options?: {
+        immutableProofComponentType?: string;
+        vertexEntityStorageType?: string;
+        changesetEntityStorageType?: string;
+        config?: IAuditableItemGraphServiceConfig;
+    });
+    /**
+     * Create a new graph vertex.
+     * @param vertexObject The object for the vertex as JSON-LD.
+     * @param aliases Alternative aliases that can be used to identify the vertex.
+     * @param resources The resources attached to the vertex.
+     * @param edges The edges connected to the vertex.
+     * @param userIdentity The identity to create the auditable item graph operation with.
+     * @param nodeIdentity The node identity to include in the auditable item graph.
+     * @returns The id of the new graph item.
+     */
+    create(vertexObject?: IJsonLdNodeObject, aliases?: {
+        id: string;
+        aliasFormat?: string;
+        aliasObject?: IJsonLdNodeObject;
+    }[], resources?: {
+        id: string;
+        resourceObject?: IJsonLdNodeObject;
+    }[], edges?: {
+        id: string;
+        edgeRelationship: string;
+        edgeObject?: IJsonLdNodeObject;
+    }[], userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    /**
+     * Get a graph vertex.
+     * @param id The id of the vertex to get.
+     * @returns The vertex if found.
+     * @param options Additional options for the get operation.
+     * @param options.includeDeleted Whether to include deleted/updated aliases, resource, edges, defaults to false.
+     * @param options.includeChangesets Whether to include the changesets of the vertex, defaults to false.
+     * @param options.verifySignatureDepth How many signatures to verify, defaults to "none".
+     * @throws NotFoundError if the vertex is not found.
+     */
+    get(id: string, options?: {
+        includeDeleted?: boolean;
+        includeChangesets?: boolean;
+        verifySignatureDepth?: VerifyDepth;
+    }): Promise<IAuditableItemGraphVertex>;
+    /**
+     * Update a graph vertex.
+     * @param id The id of the vertex to update.
+     * @param vertexObject The object for the vertex.
+     * @param aliases Alternative aliases that can be used to identify the vertex.
+     * @param resources The resources attached to the vertex.
+     * @param edges The edges connected to the vertex.
+     * @param userIdentity The identity to create the auditable item graph operation with.
+     * @param nodeIdentity The node identity to include in the auditable item graph.
+     * @returns Nothing.
+     */
+    update(id: string, vertexObject?: IJsonLdNodeObject, aliases?: {
+        id: string;
+        aliasFormat?: string;
+        aliasObject?: IJsonLdNodeObject;
+    }[], resources?: {
+        id: string;
+        resourceObject?: IJsonLdNodeObject;
+    }[], edges?: {
+        id: string;
+        edgeRelationship: string;
+        edgeObject?: IJsonLdNodeObject;
+    }[], userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    /**
+     * Remove the immutable storage for an item.
+     * @param id The id of the vertex to get.
+     * @param nodeIdentity The node identity to use for vault operations.
+     * @returns Nothing.
+     * @throws NotFoundError if the vertex is not found.
+     */
+    removeImmutable(id: string, nodeIdentity?: string): Promise<void>;
+    /**
+     * Query the graph for vertices.
+     * @param options The query options.
+     * @param options.id The optional id to look for.
+     * @param options.idMode Look in id, alias or both, defaults to both.
+     * @param orderBy The order for the results, defaults to created.
+     * @param orderByDirection The direction for the order, defaults to desc.
+     * @param properties The properties to return, if not provided defaults to id, created, aliases and object.
+     * @param cursor The cursor to request the next page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns The entities, which can be partial if a limited keys list was provided.
+     */
+    query(options?: {
+        id?: string;
+        idMode?: "id" | "alias" | "both";
+    }, orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
+}

package/dist/types/entities/auditableItemGraphAlias.d.ts

@@ -0,0 +1,30 @@
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Class describing the auditable item graph alias.
+ */
+export declare class AuditableItemGraphAlias {
+    /**
+     * The alternative alias for the vertex.
+     */
+    id: string;
+    /**
+     * The format of the alias for the vertex.
+     */
+    aliasFormat?: string;
+    /**
+     * The date/time of when the alias was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the alias was last modified.
+     */
+    dateModified?: string;
+    /**
+     * The timestamp of when the alias was deleted, as we never actually remove items.
+     */
+    dateDeleted?: string;
+    /**
+     * Object to associate with the alias as JSON-LD.
+     */
+    aliasObject?: IJsonLdNodeObject;
+}

package/dist/types/entities/auditableItemGraphChangeset.d.ts

@@ -0,0 +1,30 @@
+import type { AuditableItemGraphPatch } from "./auditableItemGraphPatch";
+/**
+ * Class describing a set of updates to the vertex.
+ */
+export declare class AuditableItemGraphChangeset {
+    /**
+     * The id of the changeset.
+     */
+    id: string;
+    /**
+     * The vertex the changeset belongs to.
+     */
+    vertexId: string;
+    /**
+     * The date/time of when the changeset was created.
+     */
+    dateCreated: string;
+    /**
+     * The identity of the user who made the changeset.
+     */
+    userIdentity: string;
+    /**
+     * The patches in the changeset.
+     */
+    patches: AuditableItemGraphPatch[];
+    /**
+     * The immutable proof id which contains the signature for this changeset.
+     */
+    proofId: string;
+}

package/dist/types/entities/auditableItemGraphEdge.d.ts

@@ -0,0 +1,30 @@
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Class describing the auditable item graph edge.
+ */
+export declare class AuditableItemGraphEdge {
+    /**
+     * The id of the edge.
+     */
+    id: string;
+    /**
+     * The date/time of when the edge was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the edge was last modified.
+     */
+    dateModified?: string;
+    /**
+     * The timestamp of when the edge was deleted, as we never actually remove items.
+     */
+    dateDeleted?: string;
+    /**
+     * The relationship between the two vertices.
+     */
+    edgeRelationship: string;
+    /**
+     * Object to associate with the edge as JSON-LD.
+     */
+    edgeObject?: IJsonLdNodeObject;
+}

package/dist/types/entities/auditableItemGraphPatch.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Class describing the auditable item graph patches.
+ */
+export declare class AuditableItemGraphPatch {
+    /**
+     * The operation for the patch.
+     */
+    op: "add" | "remove" | "replace" | "move" | "copy" | "test";
+    /**
+     * The path for the patch.
+     */
+    path: string;
+    /**
+     * The from for the patch.
+     */
+    from?: string;
+    /**
+     * The value for the patch.
+     */
+    value?: unknown;
+}

package/dist/types/entities/auditableItemGraphResource.d.ts

@@ -0,0 +1,26 @@
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Class describing the auditable item graph vertex resource.
+ */
+export declare class AuditableItemGraphResource {
+    /**
+     * The id of the resource.
+     */
+    id: string;
+    /**
+     * The date/time of when the resource was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the resource was last modified.
+     */
+    dateModified?: string;
+    /**
+     * The timestamp of when the resource was deleted, as we never actually remove items.
+     */
+    dateDeleted?: string;
+    /**
+     * Object to associate with the resource as JSON-LD.
+     */
+    resourceObject?: IJsonLdNodeObject;
+}

package/dist/types/entities/auditableItemGraphVertex.d.ts

@@ -0,0 +1,45 @@
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphAlias } from "./auditableItemGraphAlias";
+import type { AuditableItemGraphEdge } from "./auditableItemGraphEdge";
+import type { AuditableItemGraphResource } from "./auditableItemGraphResource";
+/**
+ * Class describing the auditable item graph vertex.
+ */
+export declare class AuditableItemGraphVertex {
+    /**
+     * The id of the vertex.
+     */
+    id: string;
+    /**
+     * The identity of the node which controls the vertex.
+     */
+    nodeIdentity?: string;
+    /**
+     * The date/time of when the vertex was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the vertex was last modified.
+     */
+    dateModified?: string;
+    /**
+     * Combined alias index for the vertex used for querying.
+     */
+    aliasIndex?: string;
+    /**
+     * Object to associate with the vertex as JSON-LD.
+     */
+    vertexObject?: IJsonLdNodeObject;
+    /**
+     * Alternative aliases that can be used to identify the vertex.
+     */
+    aliases?: AuditableItemGraphAlias[];
+    /**
+     * The resources attached to the vertex.
+     */
+    resources?: AuditableItemGraphResource[];
+    /**
+     * Edges connected to the vertex.
+     */
+    edges?: AuditableItemGraphEdge[];
+}

package/dist/types/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./auditableItemGraphRoutes";
+export * from "./auditableItemGraphService";
+export * from "./entities/auditableItemGraphAlias";
+export * from "./entities/auditableItemGraphChangeset";
+export * from "./entities/auditableItemGraphEdge";
+export * from "./entities/auditableItemGraphPatch";
+export * from "./entities/auditableItemGraphResource";
+export * from "./entities/auditableItemGraphVertex";
+export * from "./models/IAuditableItemGraphServiceConfig";
+export * from "./restEntryPoints";
+export * from "./schema";

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

@@ -0,0 +1,5 @@
+/**
+ * Configuration for the auditable item graph service.
+ */
+export interface IAuditableItemGraphServiceConfig {
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Context for the auditable item graph service.
+ */
+export interface IAuditableItemGraphServiceContext {
+    /**
+     * The current date/time.
+     */
+    now: string;
+    /**
+     * The identity of the user.
+     */
+    userIdentity: string;
+    /**
+     * The identity of the node.
+     */
+    nodeIdentity: string;
+}

package/dist/types/restEntryPoints.d.ts

@@ -0,0 +1,2 @@
+import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+export declare const restEntryPoints: IRestRouteEntryPoint[];

package/dist/types/schema.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Initialize the schema for the auditable item graph entity storage connector.
+ */
+export declare function initSchema(): void;

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/auditable-item-graph-service - Changelog
+
+## v0.0.1-next.10
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/auditable-item-graph-service - Examples