@3sixty/auditable-item-graph-models 0.0.0-stage → 0.20.0-next.0

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

@@ -0,0 +1,45 @@
+import type { IJsonLdContextDefinitionElement } from "@3sixty/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias.js";
+import type { IAuditableItemGraphEdge } from "./IAuditableItemGraphEdge.js";
+import type { IAuditableItemGraphListPatch } from "./IAuditableItemGraphListPatch.js";
+import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource.js";
+import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex.js";
+/**
+ * Partial vertex payload for updatePartial.
+ * Sub-lists use explicit `{ add, remove }` patches; bare arrays are not supported.
+ */
+export interface IAuditableItemGraphPartialVertex extends Omit<IAuditableItemGraphVertex, "type" | "aliases" | "edges" | "resources"> {
+    /**
+     * The id of the vertex to update.
+     */
+    id: string;
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof AuditableItemGraphContexts.Context,
+        typeof AuditableItemGraphContexts.ContextCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type?: typeof AuditableItemGraphTypes.Vertex;
+    /**
+     * Patch operations for aliases.
+     * @json-ld id
+     */
+    aliasPatches?: IAuditableItemGraphListPatch<IAuditableItemGraphAlias>;
+    /**
+     * Patch operations for resources.
+     * @json-ld id
+     */
+    resourcePatches?: IAuditableItemGraphListPatch<IAuditableItemGraphResource>;
+    /**
+     * Patch operations for edges.
+     * @json-ld id
+     */
+    edgePatches?: IAuditableItemGraphListPatch<IAuditableItemGraphEdge>;
+}

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

@@ -0,0 +1,36 @@
+import type { IJsonLdContextDefinitionElement } from "@3sixty/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+/**
+ * The patch operation for JSON diffs.
+ */
+export interface IAuditableItemGraphPatchOperation {
+    /**
+     * JSON-LD Context.
+     */
+    "@context"?: typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.PatchOperation;
+    /**
+     * The operation that was performed on the item.
+     * @json-ld type:sch:Text
+     */
+    patchOperation: "add" | "remove" | "replace" | "move" | "copy" | "test";
+    /**
+     * The path to the object that was changed.
+     * @json-ld type:sch:Text
+     */
+    patchPath: string;
+    /**
+     * The path the value was copied or moved from.
+     * @json-ld type:sch:Text
+     */
+    patchFrom?: string;
+    /**
+     * The value to add.
+     * @json-ld type:json
+     */
+    patchValue?: unknown;
+}

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

@@ -0,0 +1,22 @@
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@3sixty/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement.js";
+/**
+ * Interface describing an auditable item graph vertex resource.
+ */
+export interface IAuditableItemGraphResource extends IAuditableItemGraphAuditedElement {
+    /**
+     * JSON-LD Context.
+     */
+    "@context"?: typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Resource;
+    /**
+     * The JSON-LD object for the resource.
+     * @json-ld type:json
+     */
+    resourceObject?: IJsonLdNodeObject;
+}

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

@@ -0,0 +1,73 @@
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@3sixty/data-json-ld";
+import type { AuditableItemGraphAuditMode } from "./auditableItemGraphAuditMode.js";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias.js";
+import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement.js";
+import type { IAuditableItemGraphEdge } from "./IAuditableItemGraphEdge.js";
+import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource.js";
+/**
+ * Interface describing an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAuditedElement, "deleted"> {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof AuditableItemGraphContexts.Context,
+        typeof AuditableItemGraphContexts.ContextCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * The id of the element.
+     */
+    id: string;
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Vertex;
+    /**
+     * The identity of the organization which controls the vertex.
+     * @json-ld namespace:twin-common
+     */
+    organizationIdentity?: string;
+    /**
+     * How the mutations of the vertex are recorded, when absent the vertex behaves as audited.
+     * Once a vertex is set to bypass it can not be returned to audited.
+     * @json-ld type:sch:Text
+     */
+    auditMode?: AuditableItemGraphAuditMode;
+    /**
+     * The JSON-LD annotation object for the vertex.
+     * @json-ld namespace:twin-common
+     */
+    annotationObject?: IJsonLdNodeObject;
+    /**
+     * Alternative aliases that can be used to identify the vertex.
+     * @json-ld container:set
+     */
+    aliases?: IAuditableItemGraphAlias[];
+    /**
+     * The resources attached to the vertex.
+     * @json-ld container:set
+     */
+    resources?: IAuditableItemGraphResource[];
+    /**
+     * Edges connected to the vertex.
+     * @json-ld container:set
+     */
+    edges?: IAuditableItemGraphEdge[];
+    /**
+     * Is the vertex verified, will only be populated when verification is requested.
+     * Always undefined when the vertex is in bypass mode.
+     * @json-ld namespace:twin-common
+     */
+    verified?: boolean;
+    /**
+     * The version of the vertex, populated only when getting a specific version.
+     * Always undefined when the vertex is in bypass mode.
+     * Maps to https://schema.org/version.
+     * @json-ld namespace:sch
+     */
+    version?: number;
+}

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

@@ -0,0 +1,27 @@
+import type { IJsonLdContextDefinitionElement } from "@3sixty/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@3sixty/standards-schema-org";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex.js";
+/**
+ * Interface describing an auditable item graph vertex list.
+ */
+export interface IAuditableItemGraphVertexList {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof SchemaOrgContexts.Context,
+        typeof AuditableItemGraphContexts.Context,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.VertexList];
+    /**
+     * The list of vertices.
+     * @json-ld namespace:sch
+     */
+    [SchemaOrgTypes.ItemListElement]: IAuditableItemGraphVertex[];
+}

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

@@ -0,0 +1,29 @@
+import type { IJsonLdContextDefinitionElement } from "@3sixty/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@3sixty/standards-schema-org";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+/**
+ * Interface describing a list of auditable item graph vertex version numbers.
+ */
+export interface IAuditableItemGraphVertexVersionList {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof SchemaOrgContexts.Context,
+        typeof AuditableItemGraphContexts.Context,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.VertexVersionList];
+    /**
+     * The list of versions.
+     * @json-ld namespace:sch
+     */
+    [SchemaOrgTypes.ItemListElement]: {
+        version: number;
+        dateCreated: string;
+    }[];
+}

package/dist/types/models/api/IAuditableItemGraphChangesetGetRequest.d.ts

@@ -0,0 +1,35 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { VerifyDepth } from "../verifyDepth.js";
+/**
+ * Get an auditable item graph vertex changeset.
+ */
+export interface IAuditableItemGraphChangesetGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex to get the changeset from.
+         */
+        id: string;
+        /**
+         * The id of the changeset to get.
+         */
+        changesetId: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * How many signatures to verify, none, current or all, defaults to "none".
+         */
+        verifySignatureDepth?: VerifyDepth;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphChangesetGetResponse.d.ts

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { IAuditableItemGraphChangeset } from "../IAuditableItemGraphChangeset.js";
+/**
+ * Response to getting an auditable item graph vertex changeset.
+ */
+export interface IAuditableItemGraphChangesetGetResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphChangeset;
+}

package/dist/types/models/api/IAuditableItemGraphChangesetListRequest.d.ts

@@ -0,0 +1,39 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { VerifyDepth } from "../verifyDepth.js";
+/**
+ * Get an auditable item graph changeset.
+ */
+export interface IAuditableItemGraphChangesetListRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the changeset to get.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * The optional cursor to get next chunk.
+         */
+        cursor?: string;
+        /**
+         * Limit the number of entities to return.
+         */
+        limit?: string;
+        /**
+         * How many signatures to verify, none, current or all, defaults to "none".
+         */
+        verifySignatureDepth?: VerifyDepth;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphChangesetListResponse.d.ts

@@ -0,0 +1,18 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { IAuditableItemGraphChangesetList } from "../IAuditableItemGraphChangesetList.js";
+/**
+ * Response to getting an auditable item graph changeset list.
+ */
+export interface IAuditableItemGraphChangesetListResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphChangesetList;
+}

package/dist/types/models/api/IAuditableItemGraphCreateRequest.d.ts

@@ -0,0 +1,10 @@
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
+/**
+ * Create an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphCreateRequest {
+    /**
+     * The data to be used in the vertex.
+     */
+    body: Omit<IAuditableItemGraphVertex, "id">;
+}

package/dist/types/models/api/IAuditableItemGraphGetRequest.d.ts

@@ -0,0 +1,35 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { VerifyDepth } from "../verifyDepth.js";
+/**
+ * Get an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex to get.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Whether to include deleted aliases, resource, edges, defaults to false.
+         */
+        includeDeleted?: string;
+        /**
+         * How many signatures to verify, none, current or all, defaults to "none".
+         */
+        verifySignatureDepth?: VerifyDepth;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphGetResponse.d.ts

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
+/**
+ * Response to getting an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphGetResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphVertex;
+}

package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts

@@ -0,0 +1,60 @@
+import type { SortDirection } from "@3sixty/entity";
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
+/**
+ * Get the a list of the vertices with matching ids or aliases.
+ */
+export interface IAuditableItemGraphListRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * The id or alias to try and find.
+         */
+        id?: string;
+        /**
+         * Which field to look in with the id, defaults to both.
+         */
+        idMode?: "id" | "alias" | "both";
+        /**
+         * Find only exact matches, default to false meaning partial matching.
+         */
+        idExact?: string;
+        /**
+         * Include vertices with specific resource types, comma separated.
+         */
+        resourceTypes?: string;
+        /**
+         * The conditions to filter the streams, JSON stringified `EntityCondition<IAuditableItemGraphVertex>`.
+         */
+        conditions?: string;
+        /**
+         * The order for the results, default to dateCreated.
+         */
+        orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">;
+        /**
+         * The direction for the order, defaults to desc.
+         */
+        orderByDirection?: SortDirection;
+        /**
+         * The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,annotationObject".
+         */
+        properties?: string;
+        /**
+         * The optional cursor to get next chunk.
+         */
+        cursor?: string;
+        /**
+         * The maximum number of entities to return, a page can contain fewer so follow the cursor
+         * until it is absent to read them all.
+         */
+        limit?: string;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphListResponse.d.ts

@@ -0,0 +1,18 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { IAuditableItemGraphVertexList } from "../IAuditableItemGraphVertexList.js";
+/**
+ * The response to getting the a list of the vertices with matching ids or aliases.
+ */
+export interface IAuditableItemGraphListResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
+    };
+    /**
+     * The response payload.
+     */
+    body: IAuditableItemGraphVertexList;
+}

package/dist/types/models/api/IAuditableItemGraphRemoveProofRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Remove the notarization proof from all changesets of a graph vertex.
+ */
+export interface IAuditableItemGraphRemoveProofRequest {
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex whose proof should be removed.
+         */
+        id: string;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphUpdatePartialRequest.d.ts

@@ -0,0 +1,20 @@
+import type { IAuditableItemGraphPartialVertex } from "../IAuditableItemGraphPartialVertex.js";
+/**
+ * Partially update an auditable item graph vertex (PATCH - explicit list patches).
+ */
+export interface IAuditableItemGraphUpdatePartialRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex to update.
+         */
+        id: string;
+    };
+    /**
+     * Partial vertex data; only defined properties are applied.
+     * Sub-lists use `{ add, remove }` patch objects.
+     */
+    body: Omit<IAuditableItemGraphPartialVertex, "id">;
+}

package/dist/types/models/api/IAuditableItemGraphUpdateRequest.d.ts

@@ -0,0 +1,19 @@
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
+/**
+ * Update an auditable item graph vertex (PUT - full replacement of vertex state).
+ */
+export interface IAuditableItemGraphUpdateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex to update.
+         */
+        id: string;
+    };
+    /**
+     * The full vertex payload. Replaces annotation and active sub-lists; omitted collections are cleared.
+     */
+    body: Omit<IAuditableItemGraphVertex, "id">;
+}

package/dist/types/models/api/IAuditableItemGraphVersionGetRequest.d.ts

@@ -0,0 +1,25 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+/**
+ * Get an auditable item graph vertex at a specific version.
+ */
+export interface IAuditableItemGraphVersionGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex.
+         */
+        id: string;
+        /**
+         * The version number to get.
+         */
+        version: string;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphVersionGetResponse.d.ts

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
+/**
+ * Response to getting an auditable item graph vertex at a specific version.
+ */
+export interface IAuditableItemGraphVersionGetResponse {
+    /**
+     * The headers.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphVertex;
+}

package/dist/types/models/api/IAuditableItemGraphVersionListRequest.d.ts

@@ -0,0 +1,34 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+/**
+ * Get all versions of an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphVersionListRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Only return versions created after this ISO 8601 timestamp (exclusive).
+         */
+        after?: string;
+        /**
+         * Only return versions created before this ISO 8601 timestamp (exclusive).
+         */
+        before?: string;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphVersionListResponse.d.ts

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { IAuditableItemGraphVertexVersionList } from "../IAuditableItemGraphVertexVersionList.js";
+/**
+ * Response to getting all versions of an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphVersionListResponse {
+    /**
+     * The headers.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphVertexVersionList;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * How the mutations of a vertex are recorded.
+ */
+export declare const AuditableItemGraphAuditMode: {
+    /**
+     * Every mutation appends a new version entry and maintains a full audit trail.
+     */
+    readonly Audited: "audited";
+    /**
+     * Mutations overwrite the stored state in place, with no version chain or audit entries.
+     */
+    readonly Bypass: "bypass";
+};
+/**
+ * How the mutations of a vertex are recorded.
+ */
+export type AuditableItemGraphAuditMode = (typeof AuditableItemGraphAuditMode)[keyof typeof AuditableItemGraphAuditMode];